ratkit 0.2.16

A comprehensive collection of reusable TUI components for ratatui including resizable splits, tree views, markdown rendering, toast notifications, dialogs, and terminal embedding
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169

use super::Cell;

#[derive(Clone, Debug)]
pub struct Row {
    pub cells: Vec<crate::primitives::termtui::vt100::cell::Cell>,
    size: u16,
    wrapped: bool,
}

impl Row {
    pub fn new(cols: u16) -> Self {
        Self {
            cells: vec![
                crate::primitives::termtui::vt100::cell::Cell::default();
                usize::from(cols)
            ],
            size: 0,
            wrapped: false,
        }
    }

    pub fn new_with_attrs(
        cols: u16,
        attrs: crate::primitives::termtui::vt100::attrs::Attrs,
    ) -> Self {
        let mut cell = crate::primitives::termtui::vt100::cell::Cell::default();
        cell.set_attrs(attrs);
        Self {
            cells: vec![cell; usize::from(cols)],
            size: 0,
            wrapped: false,
        }
    }

    pub fn cols(&self) -> u16 {
        self.cells
            .len()
            .try_into()
            // we limit the number of cols to a u16 (see Size)
            .unwrap()
    }

    pub fn clear(&mut self, attrs: crate::primitives::termtui::vt100::attrs::Attrs) {
        for cell in &mut self.cells {
            cell.clear(attrs);
        }
        self.size = 0;
        self.wrapped = false;
    }

    fn cells(&self) -> impl Iterator<Item = &crate::primitives::termtui::vt100::cell::Cell> {
        self.cells.iter()
    }

    pub fn get(&self, col: u16) -> Option<&crate::primitives::termtui::vt100::cell::Cell> {
        self.cells.get(usize::from(col))
    }

    pub fn get_mut(
        &mut self,
        col: u16,
    ) -> Option<&mut crate::primitives::termtui::vt100::cell::Cell> {
        self.size = self.size.max(col + 1);
        self.cells.get_mut(usize::from(col))
    }

    pub fn insert(&mut self, i: u16, cell: crate::primitives::termtui::vt100::cell::Cell) {
        self.cells.insert(usize::from(i), cell);
        self.wrapped = false;
    }

    pub fn remove(&mut self, i: u16) {
        self.clear_wide(i);
        self.cells.remove(usize::from(i));
        self.wrapped = false;
    }

    pub fn erase(&mut self, i: u16, attrs: crate::primitives::termtui::vt100::attrs::Attrs) {
        let wide = self.cells[usize::from(i)].is_wide();
        self.clear_wide(i);
        self.cells[usize::from(i)].clear(attrs);
        if i == self.cols() - if wide { 2 } else { 1 } {
            self.wrapped = false;
        }
    }

    pub fn truncate(&mut self, len: u16) {
        self.cells.truncate(usize::from(len));
        self.wrapped = false;
        let last_cell = &mut self.cells[usize::from(len) - 1];
        if last_cell.is_wide() {
            last_cell.clear(*last_cell.attrs());
        }
    }

    pub fn resize(&mut self, len: u16, cell: crate::primitives::termtui::vt100::cell::Cell) {
        self.cells.resize(usize::from(len), cell);
        self.wrapped = false;
    }

    pub fn wrap(&mut self, wrap: bool) {
        self.wrapped = wrap;
    }

    pub fn wrapped(&self) -> bool {
        self.wrapped
    }

    pub fn clear_wide(&mut self, col: u16) {
        let cell = &self.cells[usize::from(col)];
        let other = if cell.is_wide() {
            self.cells.get_mut(usize::from(col + 1))
        } else if self.is_wide_continuation(col) {
            self.cells.get_mut(usize::from(col - 1))
        } else {
            return;
        };
        if let Some(other) = other {
            other.clear(*other.attrs());
        }
    }

    pub fn take_cells(&self, vec: &mut Vec<Cell>) {
        vec.extend(self.cells.iter().take(self.size.into()).cloned());
    }

    pub fn write_contents(&self, contents: &mut String, start: u16, width: u16, wrapping: bool) {
        let mut prev_was_wide = false;

        let mut prev_col = start;
        for (col, cell) in self
            .cells()
            .enumerate()
            .skip(usize::from(start))
            .take(usize::from(width))
        {
            if prev_was_wide {
                prev_was_wide = false;
                continue;
            }
            prev_was_wide = cell.is_wide();

            // we limit the number of cols to a u16 (see Size)
            let col: u16 = col.try_into().unwrap();
            if cell.has_contents() {
                for _ in 0..(col - prev_col) {
                    contents.push(' ');
                }
                prev_col += col - prev_col;

                contents.push_str(cell.contents());
                prev_col += if cell.is_wide() { 2 } else { 1 };
            }
        }
        if prev_col == start && wrapping {
            contents.push('\n');
        }
    }

    pub(crate) fn is_wide_continuation(&self, col: u16) -> bool {
        if col == 0 {
            return false;
        }

        self.cells
            .get(Into::<usize>::into(col) - 1)
            .is_some_and(super::cell::Cell::is_wide)
    }
}