htui 0.2.0

A terminal HTML/CSS renderer with an embedded JavaScript engine — build interactive TUIs from HTML, CSS and JS
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

//! `<q>` / `<abbr>` tests — inline text-level elements.
//!
//! - `<q>` wraps its content in generated quote marks (UA `::before` /
//!   `::after`); the pair alternates with nesting depth like the CSS
//!   `quotes` property (double → single).
//! - `<abbr>` is plain inline text; when it carries a `title` attribute the
//!   browser UA dotted underline is approximated with a solid underline,
//!   and an explicit `text-decoration` wins.

use crossterm::style::Color;
use htui::html::{css_parse, html_parse};
use htui::layout::layout::TermMap;
use htui::tdom::node::{NodeArena, NodeId, NodeType};
use htui::tui::graph_api::{FontStyle, TermLayout};

fn init() {
    let _ = env_logger::builder().is_test(true).try_init();
}

fn setup(html: &str, css: &str) -> (NodeId, NodeArena) {
    let mut html_parser = html_parse::Parser::new(html);
    let (root_id, mut arena, embedded) = html_parser.parse();
    let combined = if css.is_empty() {
        embedded
    } else if embedded.is_empty() {
        css.to_string()
    } else {
        format!("{embedded}\n{css}")
    };
    if !combined.trim().is_empty() {
        let mut css_parser = css_parse::Parser::new(&combined);
        let rules = css_parser.parse();
        css_parse::css_into_node(&mut arena, root_id, &rules);
    }
    (root_id, arena)
}

const COLS: u16 = 80;
const ROWS: u16 = 24;

fn mock_term_map() -> TermMap {
    TermMap {
        columns: COLS,
        rows: ROWS,
    }
}

/// Render the document onto the terminal canvas.
fn draw(html: &str, css: &str) -> (TermMap, TermLayout) {
    let term_map = mock_term_map();
    let (root_id, arena) = setup(html, css);
    let mut tl = TermLayout::new(&term_map, 1.0);
    tl.draw(&arena, root_id, &term_map);
    (term_map, tl)
}

/// Index of the first canvas cell carrying `word`.
fn first_cell_with(tl: &TermLayout, word: &str) -> Option<usize> {
    tl.layout.iter().position(|b| b.word == word)
}

#[test]
fn test_parse_tag_map_q_abbr() {
    init();
    assert_eq!(html_parse::tag_name_to_node_type("q"), Some(NodeType::Q));
    assert_eq!(
        html_parse::tag_name_to_node_type("abbr"),
        Some(NodeType::Abbr)
    );
}

#[test]
fn test_q_wraps_content_in_quotes() {
    init();
    // `<q>` synthesises the UA `::before`/`::after` quote marks: the content
    // sits between `“` and `”` on the same line.
    let (term_map, tl) = draw("<p>He said <q>hi</q>.</p>", "");
    let cols = term_map.columns as usize;
    let open = first_cell_with(&tl, "\u{201C}").expect("open quote should render");
    let close = first_cell_with(&tl, "\u{201D}").expect("close quote should render");
    let hi = first_cell_with(&tl, "h").expect("q content should render");
    assert_eq!(
        open / cols,
        1,
        "quote sits on the paragraph's text row (UA margin-top=1)"
    );
    assert_eq!(open % cols, 8, "quote opens after `He said `");
    assert_eq!(hi, open + 1, "content follows the open quote");
    assert_eq!(close, hi + 2, "close quote follows the content");
    assert_eq!(close % cols, 11);
    assert_eq!(
        first_cell_with(&tl, ".").expect("period should render"),
        close + 1,
        "sentence continues after the close quote"
    );
}

#[test]
fn test_q_nested_alternates_quote_pairs() {
    init();
    // Nesting depth switches the pair to single quotes (CSS `quotes`
    // alternation): `“outer ‘inner’”`.
    let (_, tl) = draw("<p><q>outer <q>inner</q></q></p>", "");
    let double_open = first_cell_with(&tl, "\u{201C}").expect("outer open quote");
    let double_close = first_cell_with(&tl, "\u{201D}").expect("outer close quote");
    let single_open = first_cell_with(&tl, "\u{2018}").expect("inner open quote");
    let single_close = first_cell_with(&tl, "\u{2019}").expect("inner close quote");
    assert!(
        double_open < single_open && single_open < single_close && single_close < double_close,
        "outer double quotes must wrap the inner single-quoted span \
         (got {double_open} < {single_open} < {single_close} < {double_close})"
    );
}

#[test]
fn test_q_author_color_applies_to_quote_marks() {
    init();
    // The generated quote runs carry the `<q>` element's own style, so the
    // author colour reaches the quote marks too.
    let (_, tl) = draw("<p><q>red</q></p>", "q { color: red; }");
    let open = first_cell_with(&tl, "\u{201C}").expect("open quote should render");
    assert_eq!(
        tl.layout[open].fcolor,
        Some(Color::Rgb { r: 255, g: 0, b: 0 }),
        "quote marks must inherit the q element's colour"
    );
}

#[test]
fn test_q_stays_inline_flow() {
    init();
    // `<q>` is inline: the whole sentence (quotes included) stays on the
    // paragraph's single line rather than starting its own block.
    let (term_map, tl) = draw("<p>Before <q>mid</q> after</p>", "");
    let cols = term_map.columns as usize;
    let before = first_cell_with(&tl, "B").expect("pre-q text should render");
    let after = first_cell_with(&tl, "a").expect("post-q text should render");
    assert_eq!(before / cols, after / cols, "all text shares one row");
}

#[test]
fn test_abbr_plain_without_title_not_underlined() {
    init();
    let (_, tl) = draw("<p><abbr>HTML</abbr></p>", "");
    let idx = first_cell_with(&tl, "H").expect("abbr text should render");
    assert!(
        !tl.layout[idx].style.contains(FontStyle::UNDERLINED),
        "plain <abbr> (no title) must not be underlined"
    );
}

#[test]
fn test_abbr_with_title_underlined() {
    init();
    // Browser UA `abbr[title] { text-decoration: underline dotted }` — the
    // terminal approximation is a solid underline.
    let (_, tl) = draw(
        "<p><abbr title=\"HyperText Markup Language\">HTML</abbr></p>",
        "",
    );
    let idx = first_cell_with(&tl, "H").expect("abbr text should render");
    assert!(
        tl.layout[idx].style.contains(FontStyle::UNDERLINED),
        "abbr[title] must render underlined (got {:?})",
        tl.layout[idx].style
    );
}

#[test]
fn test_abbr_title_underline_yields_to_author_decoration() {
    init();
    let (_, tl) = draw(
        "<p><abbr title=\"HyperText Markup Language\">HTML</abbr></p>",
        "abbr { text-decoration: none; }",
    );
    let idx = first_cell_with(&tl, "H").expect("abbr text should render");
    assert!(
        !tl.layout[idx].style.contains(FontStyle::UNDERLINED),
        "author text-decoration must suppress the UA underline"
    );
}

#[test]
fn test_abbr_type_selector_color_with_underline() {
    init();
    let (_, tl) = draw(
        "<p><abbr title=\"HyperText Markup Language\">HTML</abbr></p>",
        "abbr { color: blue; }",
    );
    let idx = first_cell_with(&tl, "H").expect("abbr text should render");
    let cell = &tl.layout[idx];
    assert_eq!(cell.fcolor, Some(Color::Rgb { r: 0, g: 0, b: 255 }));
    assert!(
        cell.style.contains(FontStyle::UNDERLINED),
        "colour override must not affect the title underline default"
    );
}