sketch 0.1.0

A Rust TUI library inspired by bubbletea
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290

use std::fmt::Write;

pub use crossterm::style::Color;

/// Change how the text is displayed to the user.
///
/// ```
/// # use sketch::Style;
/// const FOCUS_STYLE: Style = Style::new().red().bold();
/// let text = FOCUS_STYLE.render("[ Submit]");
/// ```
#[derive(Debug, Default, Clone)]
pub struct Style {
    fg: Option<Color>,
    bg: Option<Color>,
    bold: bool,
    dim: bool,
    italic: bool,
    underline: bool,
    underline_color: Option<Color>,
    blink: Option<BlinkSpeed>,
    reverse: bool,
    crossed_out: bool,
}

/// The speed of text blinking for [`Style::blink`].
#[derive(Debug, Clone)]
pub enum BlinkSpeed {
    Slow,
    Rapid,
}

macro_rules! style_method {
    ($method:ident, fg, $value:expr) => {
        #[doc = concat!("Set the text color to [`", stringify!($value), "`].")]
        pub const fn $method(mut self) -> Self {
            self.fg = Some($value);
            self
        }
    };
    ($method:ident, bg, $value:expr) => {
        #[doc = concat!("Set the background color to [`", stringify!($value), "`].")]
        pub const fn $method(mut self) -> Self {
            self.fg = Some($value);
            self
        }
    };
    ($method:ident, underline_color, $value:expr) => {
        #[doc = concat!("Set the underline color to [`", stringify!($value), "`].")]
        pub const fn $method(mut self) -> Self {
            self.underline_color = Some($value);
            self
        }
    };
    ($method:ident, $field:ident, $value:expr, $doc:literal) => {
        #[doc = $doc]
        pub const fn $method(mut self) -> Self {
            self.$field = $value;
            self
        }
    };
}

impl Style {
    /// Create a new style with default values.
    pub const fn new() -> Self {
        Self {
            fg: None,
            bg: None,
            bold: false,
            dim: false,
            italic: false,
            underline: false,
            underline_color: None,
            blink: None,
            reverse: false,
            crossed_out: false,
        }
    }

    /// Set the color of the text.
    pub const fn fg(mut self, color: Color) -> Self {
        self.fg = Some(color);
        self
    }

    /// Set the color of the background.
    pub const fn bg(mut self, color: Color) -> Self {
        self.bg = Some(color);
        self
    }

    /// Set the color of the underline.
    pub const fn underline_color(mut self, color: Color) -> Self {
        self.underline = true;
        self.underline_color = Some(color);
        self
    }

    /// Enable blinking and set its speed.
    ///
    /// See [`Style::slow_blink`] and [`Style::rapid_blink`] for shorthands.
    pub const fn blink(mut self, blink: BlinkSpeed) -> Self {
        self.blink = Some(blink);
        self
    }

    // Modifiers
    style_method! { bold, bold, true, "Make the text bold." }
    style_method! { dim, dim, true, "Make the text dim." }
    style_method! { italic, italic, true, "Make the text italic." }
    style_method! { underline, underline, true, "Underline the text." }
    style_method! { slow_blink, blink, Some(BlinkSpeed::Slow), "Blink the text slowly." }
    style_method! { rapid_blink, blink, Some(BlinkSpeed::Rapid), "Blick the text rapidly." }
    style_method! { reverse, reverse, true, "Spawn the text and background colors." }
    style_method! { crossed_out, crossed_out, true, "Cross the text." }

    // Forground/Text Colors
    style_method! { black, fg, Color::Black }
    style_method! { dark_grey, fg, Color::DarkGrey }
    style_method! { red, fg, Color::Red }
    style_method! { dark_red, fg, Color::DarkRed }
    style_method! { green, fg, Color::Green }
    style_method! { dark_green, fg, Color::DarkGreen }
    style_method! { yellow, fg, Color::Yellow }
    style_method! { dark_yellow, fg, Color::DarkYellow }
    style_method! { blue, fg, Color::Blue }
    style_method! { dark_blue, fg, Color::DarkBlue }
    style_method! { magenta, fg, Color::Magenta }
    style_method! { dark_magenta, fg, Color::DarkMagenta }
    style_method! { cyan, fg, Color::Cyan }
    style_method! { dark_cyan, fg, Color::DarkCyan }
    style_method! { white, fg, Color::White }
    style_method! { grey, fg, Color::Grey }

    // Background Colors
    style_method! { on_black, bg, Color::Black }
    style_method! { on_dark_grey, bg, Color::DarkGrey }
    style_method! { on_red, bg, Color::Red }
    style_method! { on_dark_red, bg, Color::DarkRed }
    style_method! { on_green, bg, Color::Green }
    style_method! { on_dark_green, bg, Color::DarkGreen }
    style_method! { on_yellow, bg, Color::Yellow }
    style_method! { on_dark_yellow, bg, Color::DarkYellow }
    style_method! { on_blue, bg, Color::Blue }
    style_method! { on_dark_blue, bg, Color::DarkBlue }
    style_method! { on_magenta, bg, Color::Magenta }
    style_method! { on_dark_magenta, bg, Color::DarkMagenta }
    style_method! { on_cyan, bg, Color::Cyan }
    style_method! { on_dark_cyan, bg, Color::DarkCyan }
    style_method! { on_white, bg, Color::White }
    style_method! { on_grey, bg, Color::Grey }

    // Underline Colors
    style_method! { underline_black, underline_color, Color::Black }
    style_method! { underline_dark_grey, underline_color, Color::DarkGrey }
    style_method! { underline_red, underline_color, Color::Red }
    style_method! { underline_dark_red, underline_color, Color::DarkRed }
    style_method! { underline_green, underline_color, Color::Green }
    style_method! { underline_dark_green, underline_color, Color::DarkGreen }
    style_method! { underline_yellow, underline_color, Color::Yellow }
    style_method! { underline_dark_yellow, underline_color, Color::DarkYellow }
    style_method! { underline_blue, underline_color, Color::Blue }
    style_method! { underline_dark_blue, underline_color, Color::DarkBlue }
    style_method! { underline_magenta, underline_color, Color::Magenta }
    style_method! { underline_dark_magenta, underline_color, Color::DarkMagenta }
    style_method! { underline_cyan, underline_color, Color::Cyan }
    style_method! { underline_dark_cyan, underline_color, Color::DarkCyan }
    style_method! { underline_white, underline_color, Color::White }
    style_method! { underline_grey, underline_color, Color::Grey }

    /// Render text with this style
    pub fn render(&self, text: impl AsRef<str>) -> String {
        let mut result = String::new();

        if self.bold {
            result.push_str("\x1b[1m");
        }
        if self.dim {
            result.push_str("\x1b[2m");
        }
        if self.italic {
            result.push_str("\x1b[3m");
        }
        if self.underline {
            result.push_str("\x1b[4m");
        }
        if let Some(speed) = &self.blink {
            match speed {
                BlinkSpeed::Slow => result.push_str("\x1b[5m"),
                BlinkSpeed::Rapid => result.push_str("\x1b[6m"),
            }
        }
        if self.reverse {
            result.push_str("\x1b[7m");
        }
        if self.crossed_out {
            result.push_str("\x1b[9m");
        }

        if let Some(color) = &self.fg {
            Self::write_fg_color(&mut result, color);
        }
        if let Some(color) = &self.bg {
            Self::write_bg_color(&mut result, color);
        }
        if let Some(color) = &self.underline_color {
            Self::write_underline_color(&mut result, color);
        }

        result.push_str(text.as_ref());
        result.push_str("\x1b[0m"); // Reset style
        result
    }

    /// Write the ANSI code for text with the given color.
    fn write_fg_color(f: &mut String, color: &Color) {
        match color {
            Color::Reset => write!(f, "\x1b[0m").unwrap(),
            Color::Black => write!(f, "\x1b[30m").unwrap(),
            Color::DarkGrey => write!(f, "\x1b[90m").unwrap(),
            Color::Red => write!(f, "\x1b[91m").unwrap(),
            Color::DarkRed => write!(f, "\x1b[31m").unwrap(),
            Color::Green => write!(f, "\x1b[92m").unwrap(),
            Color::DarkGreen => write!(f, "\x1b[32m").unwrap(),
            Color::Yellow => write!(f, "\x1b[93m").unwrap(),
            Color::DarkYellow => write!(f, "\x1b[33m").unwrap(),
            Color::Blue => write!(f, "\x1b[94m").unwrap(),
            Color::DarkBlue => write!(f, "\x1b[34m").unwrap(),
            Color::Magenta => write!(f, "\x1b[95m").unwrap(),
            Color::DarkMagenta => write!(f, "\x1b[35m").unwrap(),
            Color::Cyan => write!(f, "\x1b[96m").unwrap(),
            Color::DarkCyan => write!(f, "\x1b[36m").unwrap(),
            Color::White => write!(f, "\x1b[97m").unwrap(),
            Color::Grey => write!(f, "\x1b[37m").unwrap(),
            Color::Rgb { r, g, b } => write!(f, "\x1b[38;2;{};{};{}m", r, g, b).unwrap(),
            Color::AnsiValue(v) => write!(f, "\x1b[38;5;{}m", v).unwrap(),
        }
    }

    /// Write the ANSI code for a background with the given color.
    fn write_bg_color(f: &mut String, color: &Color) {
        match color {
            Color::Reset => write!(f, "\x1b[49m").unwrap(),
            Color::Black => write!(f, "\x1b[40m").unwrap(),
            Color::DarkGrey => write!(f, "\x1b[100m").unwrap(),
            Color::Red => write!(f, "\x1b[101m").unwrap(),
            Color::DarkRed => write!(f, "\x1b[41m").unwrap(),
            Color::Green => write!(f, "\x1b[102m").unwrap(),
            Color::DarkGreen => write!(f, "\x1b[42m").unwrap(),
            Color::Yellow => write!(f, "\x1b[103m").unwrap(),
            Color::DarkYellow => write!(f, "\x1b[43m").unwrap(),
            Color::Blue => write!(f, "\x1b[104m").unwrap(),
            Color::DarkBlue => write!(f, "\x1b[44m").unwrap(),
            Color::Magenta => write!(f, "\x1b[105m").unwrap(),
            Color::DarkMagenta => write!(f, "\x1b[45m").unwrap(),
            Color::Cyan => write!(f, "\x1b[106m").unwrap(),
            Color::DarkCyan => write!(f, "\x1b[46m").unwrap(),
            Color::White => write!(f, "\x1b[107m").unwrap(),
            Color::Grey => write!(f, "\x1b[47m").unwrap(),
            Color::Rgb { r, g, b } => write!(f, "\x1b[48;2;{};{};{}m", r, g, b).unwrap(),
            Color::AnsiValue(v) => write!(f, "\x1b[48;5;{}m", v).unwrap(),
        }
    }

    /// Write the ANSI code for a underline with the given color.
    fn write_underline_color(f: &mut String, color: &Color) {
        match color {
            Color::Reset => write!(f, "\x1b[59m").unwrap(),
            Color::Black => write!(f, "\x1b[58;5;0m").unwrap(),
            Color::DarkGrey => write!(f, "\x1b[58;5;8m").unwrap(),
            Color::Red => write!(f, "\x1b[58;5;9m").unwrap(),
            Color::DarkRed => write!(f, "\x1b[58;5;1m").unwrap(),
            Color::Green => write!(f, "\x1b[58;5;10m").unwrap(),
            Color::DarkGreen => write!(f, "\x1b[58;5;2m").unwrap(),
            Color::Yellow => write!(f, "\x1b[58;5;11m").unwrap(),
            Color::DarkYellow => write!(f, "\x1b[58;5;3m").unwrap(),
            Color::Blue => write!(f, "\x1b[58;5;12m").unwrap(),
            Color::DarkBlue => write!(f, "\x1b[58;5;4m").unwrap(),
            Color::Magenta => write!(f, "\x1b[58;5;13m").unwrap(),
            Color::DarkMagenta => write!(f, "\x1b[58;5;5m").unwrap(),
            Color::Cyan => write!(f, "\x1b[58;5;14m").unwrap(),
            Color::DarkCyan => write!(f, "\x1b[58;5;6m").unwrap(),
            Color::White => write!(f, "\x1b[58;5;15m").unwrap(),
            Color::Grey => write!(f, "\x1b[58;5;7m").unwrap(),
            Color::Rgb { r, g, b } => write!(f, "\x1b[58;2;{};{};{}m", r, g, b).unwrap(),
            Color::AnsiValue(v) => write!(f, "\x1b[58;5;{}m", v).unwrap(),
        }
    }
}