altar 0.1.0

A TUI library in the style of SwiftUI
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

pub mod cell;
pub mod color;
pub mod size;

pub use cell::*;
pub use color::*;
pub use size::*;
use unicode_segmentation::UnicodeSegmentation;

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Buffer {
    pub size: Size,
    pub cells: Vec<Cell>,
}

impl Buffer {
    pub fn new(width: u16, height: u16) -> Self {
        Self {
            size: Size { width, height },
            cells: vec![Cell::default(); (height * width) as usize],
        }
    }

    pub fn get_mut(&mut self, x: u16, y: u16) -> &mut Cell {
        let index = self.point_to_index(x, y, self.size.width);
        &mut self.cells[index as usize]
    }

    pub fn set_char_at(
        &mut self,
        x: u16,
        y: u16,
        ch: char,
        fg: Color,
        bg: Option<Color>,
        modifier: Modifier,
    ) {
        let cell = self
            .get_mut(x, y)
            .set_symbol(ch.to_string().as_ref())
            .set_fg(fg)
            .set_modifier(modifier);

        bg.map(|bg| cell.set_bg(bg));
    }

    pub fn set_string_at(
        &mut self,
        x: u16,
        y: u16,
        max_width: u16,
        s: &str,
        fg: Color,
        bg: Option<Color>,
        modifier: Modifier,
    ) {
        let width = self.size.width;
        let mut index = self.point_to_index(x, y, width) as usize;
        let end_index = index + max_width as usize;

        for grapheme in s.graphemes(true) {
            if index >= end_index {
                break;
            }
            let cell = &mut self.cells[index];
            cell.set_symbol(grapheme).set_fg(fg).set_modifier(modifier);
            if let Some(bg_color) = bg {
                cell.set_bg(bg_color);
            }
            index += 1;
        }
    }

    /// Returns a string with escape sequences and ANSI color codes.
    pub fn as_str(&self) -> String {
        self.cells
            .chunks(self.size.width as usize)
            .map(|row| row.iter().map(|cell| cell.to_string()).collect::<String>())
            .collect::<Vec<String>>()
            .join("\n")
    }

    /// Returns a string with no escape sequences or ANSI color codes.
    pub fn as_plain_str(&self) -> String {
        self.cells
            .chunks(self.size.width as usize)
            .map(|row| {
                row.iter()
                    .map(|cell| cell.symbol.clone())
                    .collect::<String>()
            })
            .collect::<Vec<String>>()
            .join("\n")
    }

    pub fn iter_cells(&self) -> impl Iterator<Item = (u16, u16, &Cell)> {
        let width = self.size.width;
        let mut index = 0;
        self.cells.iter().map(move |cell| {
            let x = (index % width as usize) as u16;
            let y = (index / width as usize) as u16;
            index += 1;
            (x, y, cell)
        })
    }

    #[inline]
    fn index_to_point(&self, index: u16, width: u16) -> (u16, u16) {
        (index % width, index / width)
    }

    #[inline]
    fn point_to_index(&self, x: u16, y: u16, width: u16) -> u16 {
        y * width + x
    }

    pub fn clear(&mut self) {
        self.cells.iter_mut().for_each(|cell| cell.reset());
    }

    pub fn clear_line(&mut self, y: u16) {
        for x in 0..self.size.width {
            self.set_char_at(
                x,
                y,
                '¬',
                Color::Reset,
                Some(Color::Reset),
                Modifier::empty(),
            );
        }
    }

    pub fn diff(&self, previous: &Self) -> Vec<(u16, u16, &Cell)> {
        let mut updates = Vec::with_capacity(32);

        for (i, (current, previous)) in self.cells.iter().zip(&previous.cells).enumerate() {
            if current != previous {
                let (x, y) = self.index_to_point(i as u16, self.size.width);
                updates.push((x, y, current));
            }
        }

        updates
    }
}