aether-tui 0.1.7

A lightweight terminal UI rendering library for building rich CLI applications
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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
#[cfg(feature = "syntax")]
use std::sync::Arc;

use std::fmt;

use crate::rendering::line::Line;
use crate::style::Style;
use crossterm::style::Color;
mod defaults;

#[derive(Debug, Clone)]
pub enum ThemeBuildError {
    MissingField(&'static str),
}

impl fmt::Display for ThemeBuildError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::MissingField(name) => write!(f, "ThemeBuilder requires {name}"),
        }
    }
}

impl std::error::Error for ThemeBuildError {}

#[cfg(feature = "syntax")]
mod syntax;

#[doc = include_str!("../docs/theme.md")]
#[derive(Clone, Debug)]
pub struct Theme {
    // Base colors
    fg: Color,
    bg: Color,
    accent: Color,
    highlight_bg: Color,
    highlight_fg: Color,

    // Text colors
    text_secondary: Color,
    code_fg: Color,
    code_bg: Color,

    // Markdown semantic colors
    heading: Color,
    link: Color,
    blockquote: Color,
    muted: Color,

    // Status colors
    success: Color,
    warning: Color,
    error: Color,
    info: Color,
    secondary: Color,

    // Layout colors
    sidebar_bg: Color,

    // Diff colors
    diff_added_fg: Color,
    diff_removed_fg: Color,
    diff_added_bg: Color,
    diff_removed_bg: Color,

    // Cached syntect theme for syntax highlighting (parsed once at construction)
    #[cfg(feature = "syntax")]
    #[allow(clippy::struct_field_names)]
    syntect_theme: Arc<syntect::highlighting::Theme>,
}

#[derive(Clone, Copy, Debug, Default)]
pub struct ThemeBuilder {
    fg: Option<Color>,
    bg: Option<Color>,
    accent: Option<Color>,
    highlight_bg: Option<Color>,
    highlight_fg: Option<Color>,
    text_secondary: Option<Color>,
    code_fg: Option<Color>,
    code_bg: Option<Color>,
    heading: Option<Color>,
    link: Option<Color>,
    blockquote: Option<Color>,
    muted: Option<Color>,
    success: Option<Color>,
    warning: Option<Color>,
    error: Option<Color>,
    info: Option<Color>,
    secondary: Option<Color>,
    sidebar_bg: Option<Color>,
    diff_added_fg: Option<Color>,
    diff_removed_fg: Option<Color>,
    diff_added_bg: Option<Color>,
    diff_removed_bg: Option<Color>,
}

impl ThemeBuilder {
    pub fn fg(mut self, color: Color) -> Self {
        self.fg = Some(color);
        self
    }

    pub fn bg(mut self, color: Color) -> Self {
        self.bg = Some(color);
        self
    }

    pub fn accent(mut self, color: Color) -> Self {
        self.accent = Some(color);
        self
    }

    pub fn highlight_bg(mut self, color: Color) -> Self {
        self.highlight_bg = Some(color);
        self
    }

    pub fn highlight_fg(mut self, color: Color) -> Self {
        self.highlight_fg = Some(color);
        self
    }

    pub fn text_secondary(mut self, color: Color) -> Self {
        self.text_secondary = Some(color);
        self
    }

    pub fn code_fg(mut self, color: Color) -> Self {
        self.code_fg = Some(color);
        self
    }

    pub fn code_bg(mut self, color: Color) -> Self {
        self.code_bg = Some(color);
        self
    }

    pub fn heading(mut self, color: Color) -> Self {
        self.heading = Some(color);
        self
    }

    pub fn link(mut self, color: Color) -> Self {
        self.link = Some(color);
        self
    }

    pub fn blockquote(mut self, color: Color) -> Self {
        self.blockquote = Some(color);
        self
    }

    pub fn muted(mut self, color: Color) -> Self {
        self.muted = Some(color);
        self
    }

    pub fn success(mut self, color: Color) -> Self {
        self.success = Some(color);
        self
    }

    pub fn warning(mut self, color: Color) -> Self {
        self.warning = Some(color);
        self
    }

    pub fn error(mut self, color: Color) -> Self {
        self.error = Some(color);
        self
    }

    pub fn info(mut self, color: Color) -> Self {
        self.info = Some(color);
        self
    }

    pub fn secondary(mut self, color: Color) -> Self {
        self.secondary = Some(color);
        self
    }

    pub fn sidebar_bg(mut self, color: Color) -> Self {
        self.sidebar_bg = Some(color);
        self
    }

    pub fn diff_added_fg(mut self, color: Color) -> Self {
        self.diff_added_fg = Some(color);
        self
    }

    pub fn diff_removed_fg(mut self, color: Color) -> Self {
        self.diff_removed_fg = Some(color);
        self
    }

    pub fn diff_added_bg(mut self, color: Color) -> Self {
        self.diff_added_bg = Some(color);
        self
    }

    pub fn diff_removed_bg(mut self, color: Color) -> Self {
        self.diff_removed_bg = Some(color);
        self
    }

    pub fn build(self) -> Result<Theme, ThemeBuildError> {
        Theme::from_builder(self)
    }
}

#[allow(dead_code, clippy::unused_self)]
impl Theme {
    pub fn builder() -> ThemeBuilder {
        ThemeBuilder::default()
    }

    fn from_builder(b: ThemeBuilder) -> Result<Self, ThemeBuildError> {
        Ok(Self {
            fg: b.fg.ok_or(ThemeBuildError::MissingField("fg"))?,
            bg: b.bg.ok_or(ThemeBuildError::MissingField("bg"))?,
            accent: b.accent.ok_or(ThemeBuildError::MissingField("accent"))?,
            highlight_bg: b.highlight_bg.ok_or(ThemeBuildError::MissingField("highlight_bg"))?,
            highlight_fg: b.highlight_fg.ok_or(ThemeBuildError::MissingField("highlight_fg"))?,
            text_secondary: b.text_secondary.ok_or(ThemeBuildError::MissingField("text_secondary"))?,
            code_fg: b.code_fg.ok_or(ThemeBuildError::MissingField("code_fg"))?,
            code_bg: b.code_bg.ok_or(ThemeBuildError::MissingField("code_bg"))?,
            heading: b.heading.ok_or(ThemeBuildError::MissingField("heading"))?,
            link: b.link.ok_or(ThemeBuildError::MissingField("link"))?,
            blockquote: b.blockquote.ok_or(ThemeBuildError::MissingField("blockquote"))?,
            muted: b.muted.ok_or(ThemeBuildError::MissingField("muted"))?,
            success: b.success.ok_or(ThemeBuildError::MissingField("success"))?,
            warning: b.warning.ok_or(ThemeBuildError::MissingField("warning"))?,
            error: b.error.ok_or(ThemeBuildError::MissingField("error"))?,
            info: b.info.ok_or(ThemeBuildError::MissingField("info"))?,
            secondary: b.secondary.ok_or(ThemeBuildError::MissingField("secondary"))?,
            sidebar_bg: b.sidebar_bg.ok_or(ThemeBuildError::MissingField("sidebar_bg"))?,
            diff_added_fg: b.diff_added_fg.ok_or(ThemeBuildError::MissingField("diff_added_fg"))?,
            diff_removed_fg: b.diff_removed_fg.ok_or(ThemeBuildError::MissingField("diff_removed_fg"))?,
            diff_added_bg: b.diff_added_bg.ok_or(ThemeBuildError::MissingField("diff_added_bg"))?,
            diff_removed_bg: b.diff_removed_bg.ok_or(ThemeBuildError::MissingField("diff_removed_bg"))?,
            #[cfg(feature = "syntax")]
            syntect_theme: Arc::new(syntax::parse_default_syntect_theme()),
        })
    }

    pub fn primary(&self) -> Color {
        self.fg
    }

    pub fn text_primary(&self) -> Color {
        self.fg
    }

    pub fn background(&self) -> Color {
        self.bg
    }

    pub fn code_fg(&self) -> Color {
        self.code_fg
    }

    pub fn code_bg(&self) -> Color {
        self.code_bg
    }

    pub fn sidebar_bg(&self) -> Color {
        self.sidebar_bg
    }

    pub fn accent(&self) -> Color {
        self.accent
    }

    pub fn highlight_bg(&self) -> Color {
        self.highlight_bg
    }

    pub fn highlight_fg(&self) -> Color {
        self.highlight_fg
    }

    pub fn selected_row_style(&self) -> Style {
        self.selected_row_style_with_fg(self.highlight_fg())
    }

    pub fn selected_row_style_with_fg(&self, fg: Color) -> Style {
        Style::fg(fg).bg_color(self.highlight_bg())
    }

    /// Build a "selected row" line: styled foreground/background plus a row
    /// fill so the highlight extends through trailing whitespace.
    pub fn selected_row_line(&self, text: impl Into<String>) -> Line {
        Line::with_style(text, self.selected_row_style()).with_fill(self.highlight_bg())
    }

    pub fn secondary(&self) -> Color {
        self.secondary
    }

    pub fn text_secondary(&self) -> Color {
        self.text_secondary
    }

    pub fn success(&self) -> Color {
        self.success
    }

    pub fn warning(&self) -> Color {
        self.warning
    }

    pub fn error(&self) -> Color {
        self.error
    }

    pub fn info(&self) -> Color {
        self.info
    }

    pub fn muted(&self) -> Color {
        self.muted
    }

    pub fn heading(&self) -> Color {
        self.heading
    }

    pub fn link(&self) -> Color {
        self.link
    }

    pub fn blockquote(&self) -> Color {
        self.blockquote
    }

    pub fn diff_added_bg(&self) -> Color {
        self.diff_added_bg
    }

    pub fn diff_removed_bg(&self) -> Color {
        self.diff_removed_bg
    }

    pub fn diff_added_fg(&self) -> Color {
        self.diff_added_fg
    }

    pub fn diff_removed_fg(&self) -> Color {
        self.diff_removed_fg
    }
}

#[cfg(feature = "syntax")]
impl Default for Theme {
    fn default() -> Self {
        Self::from(&syntax::parse_default_syntect_theme())
    }
}

/// Darken a color to ~30% brightness for use as a subtle background.
#[allow(clippy::cast_possible_truncation)]
fn darken_color(color: Color) -> Color {
    match color {
        Color::Rgb { r, g, b } => Color::Rgb {
            r: (u16::from(r) * 30 / 100) as u8,
            g: (u16::from(g) * 30 / 100) as u8,
            b: (u16::from(b) * 30 / 100) as u8,
        },
        other => other,
    }
}

/// Lighten a color to ~10% brightness for use as a subtle background.
#[allow(clippy::cast_possible_truncation)]
#[allow(dead_code)]
fn lighten_color(color: Color) -> Color {
    match color {
        Color::Rgb { r, g, b } => Color::Rgb {
            r: (u16::from(r) * 10 / 100 + 230) as u8,
            g: (u16::from(g) * 10 / 100 + 230) as u8,
            b: (u16::from(b) * 10 / 100 + 230) as u8,
        },
        other => other,
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn selected_row_style_uses_highlight_fg_and_highlight_bg() {
        let theme = Theme::default();
        let style = theme.selected_row_style();
        assert_eq!(style.fg, Some(theme.highlight_fg()));
        assert_eq!(style.bg, Some(theme.highlight_bg()));
    }

    #[test]
    fn selected_row_style_with_fg_preserves_custom_foreground() {
        let theme = Theme::default();
        let style = theme.selected_row_style_with_fg(theme.warning());
        assert_eq!(style.fg, Some(theme.warning()));
        assert_eq!(style.bg, Some(theme.highlight_bg()));
    }

    #[test]
    fn code_fg_differs_from_text_primary() {
        let theme = Theme::default();
        assert_ne!(theme.code_fg(), theme.text_primary(), "code_fg should be visually distinct from body text");
    }

    #[test]
    fn darken_color_reduces_brightness() {
        let bright = Color::Rgb { r: 200, g: 100, b: 50 };
        let dark = darken_color(bright);
        assert_eq!(dark, Color::Rgb { r: 60, g: 30, b: 15 });
    }

    #[test]
    fn custom_theme_builder() {
        let theme = Theme::builder()
            .fg(Color::Black)
            .bg(Color::White)
            .accent(Color::Red)
            .highlight_bg(Color::Green)
            .highlight_fg(Color::Black)
            .text_secondary(Color::Yellow)
            .code_fg(Color::Blue)
            .code_bg(Color::Magenta)
            .heading(Color::Cyan)
            .link(Color::DarkGrey)
            .blockquote(Color::DarkRed)
            .muted(Color::DarkGreen)
            .success(Color::DarkBlue)
            .warning(Color::DarkCyan)
            .error(Color::DarkMagenta)
            .info(Color::Grey)
            .secondary(Color::Rgb { r: 128, g: 0, b: 128 })
            .sidebar_bg(Color::Rgb { r: 30, g: 30, b: 30 })
            .diff_added_fg(Color::Rgb { r: 0, g: 255, b: 0 })
            .diff_removed_fg(Color::Rgb { r: 255, g: 0, b: 0 })
            .diff_added_bg(Color::Rgb { r: 0, g: 20, b: 0 })
            .diff_removed_bg(Color::Rgb { r: 20, g: 0, b: 0 })
            .build()
            .unwrap();
        assert_eq!(theme.primary(), Color::Black);
        assert_eq!(theme.background(), Color::White);
        assert_eq!(theme.accent(), Color::Red);
    }

    #[test]
    fn build_without_required_field_returns_error() {
        let result = Theme::builder().fg(Color::Black).build();
        assert!(result.is_err());
        let err = result.unwrap_err();
        assert!(matches!(err, ThemeBuildError::MissingField(_)), "expected MissingField, got: {err}");
    }
}