appcui 0.4.8

A feature-rich and cross-platform TUI/CUI framework for Rust, enabling modern terminal-based applications on Windows, Linux, and macOS. Includes built-in UI components like buttons, menus, list views, tree views, checkboxes, and more. Perfect for building fast and interactive CLI tools and text-based interfaces.
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

use super::super::Size;

/// A glyph is a 2D grid of character, that can be used to draw text or images on the screen with a specific foreground and background color.
pub struct Glyph {
    size: Size,
    pub(in super::super) chars: Vec<char>,
}

impl Glyph {
    const TRANSPARENT_CHAR: char = 0 as char;
    /// Creates a new glyph with the specified width and height.
    /// The glyph is initialized with the transparent character.
    /// if the size of the glyph is bigger than 1024x1024, it will be clamped to 1024x1024.
    pub fn new(width: u32, height: u32) -> Self {
        let sz = Glyph::compute_size(width, height);

        if sz.width == 0 {
            Self { size: sz, chars: Vec::new() }
        } else {
            let new_len = sz.width as usize * sz.height as usize;
            let mut v = Vec::with_capacity(new_len);
            v.resize(new_len, Glyph::TRANSPARENT_CHAR);
            Self { size: sz, chars: v }
        }
    }
    /// Creates a new glyph with the specified width and height and initializes it with the specified text.
    /// The text is written from the top left corner of the glyph.
    pub fn with_str(width: u32, height: u32, text: &str) -> Self {
        let mut g = Glyph::new(width, height);
        g.write_str(0, 0, text);
        g
    }

    /// Returns the character at the specified position or None if the position is outside the glyph.
    #[inline(always)]
    pub fn char(&self, x: u32, y: u32) -> Option<char> {
        if (x < self.size.width) && (y < self.size.height) {
            let pos = (y * self.size.width + x) as usize;
            Some(self.chars[pos])
        } else {
            None
        }
    }
    #[inline(always)]
    /// Returns the size of the glyph.
    pub fn size(&self) -> Size {
        self.size
    }

    /// Sets the character at the specified position. If the position is outside the glyph, the character will not be set.
    #[inline(always)]
    pub fn set_char(&mut self, x: u32, y: u32, ch: char) {
        if (x < self.size.width) && (y < self.size.height) {
            let pos = (y * self.size.width + x) as usize;
            self.chars[pos] = ch;
        }
    }
    #[inline(always)]
    /// Clears the character at the specified position.
    pub fn clear_char(&mut self, x: u32, y: u32) {
        self.set_char(x, y, Glyph::TRANSPARENT_CHAR);
    }
    #[inline(always)]
    /// Clears the entire glyph.
    pub fn clear(&mut self) {
        self.chars.fill(Glyph::TRANSPARENT_CHAR);
    }
    #[inline(always)]
    /// Fills the entire glyph with the specified character.
    pub fn fill(&mut self, ch: char) {
        self.chars.fill(ch);
    }
    #[inline(always)]
    /// Resizes the glyph to the specified width and height.
    /// The glyph is cleared with the transparent character.
    pub fn resize(&mut self, width: u32, height: u32) {
        self.resize_with(width, height, Glyph::TRANSPARENT_CHAR);
    }

    /// Resizes the glyph to the specified width and height and fills it with the specified character.
    pub fn resize_with(&mut self, width: u32, height: u32, ch: char) {
        let sz = Glyph::compute_size(width, height);
        let new_len = (sz.width * sz.height) as usize;
        self.chars.resize(new_len, ch);
        self.fill(ch);
        self.size = sz;
    }
    /// Writes the specified text to the glyph starting from the specified position.
    /// The text is written from the top left corner of the glyph.
    /// If the text is outside the glyph, it will not be written.
    /// The text can contain multiple line.
    ///
    /// # Example
    ///
    /// ```rust
    /// use appcui::prelude::*;
    ///
    /// let mut glyph = image::Glyph::new(10, 10);
    /// glyph.write_str(0, 0, "Hello, world!");
    /// ```
    /// 
    pub fn write_str(&mut self, x: u32, y: u32, text: &str) {
        if (x >= self.size.width) || (y >= self.size.height) {
            return;
        }
        let mut start_offset = (y * self.size.width + x) as usize;
        let mut ofs = start_offset;
        let mut x_coord = x;
        let mut y_coord = y;
        for ch in text.chars() {
            if ch == '\n' {
                y_coord += 1;
                if y_coord >= self.size.height {
                    break;
                }
                start_offset += self.size.width as usize;
                ofs = start_offset;
                x_coord = x;
                continue;
            }
            if x_coord < self.size.width {
                self.chars[ofs] = ch;
                x_coord += 1;
                ofs += 1;
            }
        }
    }
    #[inline(always)]
    fn compute_size(width: u32, height: u32) -> Size {
        if width * height == 0 {
            Size::new(0, 0)
        } else {
            Size::new(width.min(1024), height.min(1024))
        }
    }
}