rdom-tui 0.5.0

Terminal rendering layer for rdom-core — flexbox layout, TUI styles, key/mouse events. Use rdom-core directly for headless DOM manipulation.
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

//! Selection serialization follows the rendered text
//! (`P7-CLIPBOARD-WS-1`, HTML §3.2.7 "rendered text collection steps"):
//! whitespace per `white-space`, block and `<br>` line breaks, table cells
//! and rows, no generated content.

use rdom_core::{NodeId, Position, Range};

use crate::TuiDom;
use crate::layout::{Margin, MarginValue};
use crate::render::{LayoutExt, Rect};
use crate::runtime::selection::clipboard::serialize_selection;
use crate::style::{CascadeExt, Content, Stylesheet, TuiStyle};

/// Append `<tag>text</tag>` to `parent`; returns (element, text node).
fn el(dom: &mut TuiDom, parent: NodeId, tag: &str, text: &str) -> (NodeId, NodeId) {
    let e = dom.create_element(tag);
    let t = dom.create_text_node(text);
    dom.append_child(e, t).unwrap();
    dom.append_child(parent, e).unwrap();
    (e, t)
}

fn text(dom: &mut TuiDom, parent: NodeId, s: &str) -> NodeId {
    let t = dom.create_text_node(s);
    dom.append_child(parent, t).unwrap();
    t
}

fn copy(
    dom: &mut TuiDom,
    sheet: &Stylesheet,
    from: (NodeId, usize),
    to: (NodeId, usize),
) -> String {
    dom.cascade(sheet);
    dom.layout_dom(Rect::new(0, 0, 60, 20));
    let range = Range::ordered_unchecked(Position::new(from.0, from.1), Position::new(to.0, to.1));
    serialize_selection(dom, &range)
}

fn len(dom: &TuiDom, t: NodeId) -> usize {
    dom.node(t).node_value().unwrap().len()
}

#[test]
fn a_selection_across_two_paragraphs_has_one_line_break() {
    let mut dom = TuiDom::new();
    let root = dom.root();
    let (_, a) = el(&mut dom, root, "p", "a");
    let (_, b) = el(&mut dom, root, "p", "b");
    assert_eq!(copy(&mut dom, &Stylesheet::new(), (a, 0), (b, 1)), "a\nb");
}

#[test]
fn a_paragraph_with_a_vertical_margin_is_set_off_by_a_blank_line() {
    // innerText's two required line breaks around `<p>` stand for the
    // paragraph margin; rdom's UA `<p>` has none, so they apply when the
    // author gives it one.
    let mut dom = TuiDom::new();
    let root = dom.root();
    let (_, a) = el(&mut dom, root, "p", "a");
    let (_, b) = el(&mut dom, root, "p", "b");
    let sheet = Stylesheet::new().rule_unchecked(
        "p",
        TuiStyle::new().margin(Margin::new(
            MarginValue::Cells(0),
            MarginValue::Cells(0),
            MarginValue::Cells(1),
            MarginValue::Cells(0),
        )),
    );
    assert_eq!(copy(&mut dom, &sheet, (a, 0), (b, 1)), "a\n\nb");
}

#[test]
fn collapsible_whitespace_collapses_and_trims_at_line_edges() {
    let mut dom = TuiDom::new();
    let root = dom.root();
    let (p, t1) = el(&mut dom, root, "p", "  one   two \n\t three ");
    let (_, t2) = el(&mut dom, p, "span", "  four  ");
    let _ = t2;
    let (_, t3) = el(&mut dom, root, "p", "\n five\n");
    let end = len(&dom, t3);
    assert_eq!(
        copy(&mut dom, &Stylesheet::new(), (t1, 0), (t3, end)),
        "one two three four\nfive"
    );
}

#[test]
fn whitespace_collapses_across_inline_boundaries() {
    let mut dom = TuiDom::new();
    let root = dom.root();
    let (p, t1) = el(&mut dom, root, "p", "a ");
    el(&mut dom, p, "b", " b ");
    let t3 = text(&mut dom, p, " c");
    assert_eq!(
        copy(&mut dom, &Stylesheet::new(), (t1, 0), (t3, 2)),
        "a b c"
    );
}

#[test]
fn pre_keeps_its_whitespace() {
    let mut dom = TuiDom::new();
    let root = dom.root();
    let (_, t) = el(&mut dom, root, "pre", "  a   b\n\n  c  ");
    let end = len(&dom, t);
    assert_eq!(
        copy(&mut dom, &Stylesheet::new(), (t, 0), (t, end)),
        "  a   b\n\n  c  "
    );
}

#[test]
fn pre_wrap_keeps_its_whitespace() {
    let mut dom = TuiDom::new();
    let root = dom.root();
    let (_, t) = el(&mut dom, root, "div", " x  y ");
    let sheet = Stylesheet::new().rule_unchecked(
        "div",
        TuiStyle::new().white_space(crate::layout::WhiteSpace::PreWrap),
    );
    assert_eq!(copy(&mut dom, &sheet, (t, 0), (t, 6)), " x  y ");
}

#[test]
fn br_is_a_line_break() {
    let mut dom = TuiDom::new();
    let root = dom.root();
    let p = dom.create_element("p");
    dom.append_child(root, p).unwrap();
    let a = text(&mut dom, p, "a");
    let br = dom.create_element("br");
    dom.append_child(p, br).unwrap();
    let b = text(&mut dom, p, "b");
    let _ = a;
    assert_eq!(copy(&mut dom, &Stylesheet::new(), (a, 0), (b, 1)), "a\nb");
}

#[test]
fn table_cells_are_tab_separated_and_rows_newline_separated() {
    let mut dom = TuiDom::new();
    let root = dom.root();
    let table = dom.create_element("table");
    dom.append_child(root, table).unwrap();
    let tr1 = dom.create_element("tr");
    dom.append_child(table, tr1).unwrap();
    let (_, a) = el(&mut dom, tr1, "td", "a");
    el(&mut dom, tr1, "td", "b");
    let tr2 = dom.create_element("tr");
    dom.append_child(table, tr2).unwrap();
    el(&mut dom, tr2, "td", "c");
    let (_, d) = el(&mut dom, tr2, "th", "d");
    assert_eq!(
        copy(&mut dom, &Stylesheet::new(), (a, 0), (d, 1)),
        "a\tb\nc\td"
    );
}

#[test]
fn generated_content_is_not_copied() {
    let mut dom = TuiDom::new();
    let root = dom.root();
    let (_, a) = el(&mut dom, root, "p", "a");
    let (_, b) = el(&mut dom, root, "p", "b");
    let sheet = Stylesheet::new().rule_unchecked(
        "p::before",
        TuiStyle::new().content(Content::Str("> ".into())),
    );
    assert_eq!(copy(&mut dom, &sheet, (a, 0), (b, 1)), "a\nb");
}

#[test]
fn list_markers_are_not_copied() {
    let mut dom = TuiDom::new();
    let root = dom.root();
    let ul = dom.create_element("ul");
    dom.append_child(root, ul).unwrap();
    let (_, a) = el(&mut dom, ul, "li", "one");
    let (_, b) = el(&mut dom, ul, "li", "two");
    assert_eq!(
        copy(&mut dom, &Stylesheet::new(), (a, 0), (b, 3)),
        "one\ntwo"
    );
}

#[test]
fn display_none_content_is_not_copied() {
    let mut dom = TuiDom::new();
    let root = dom.root();
    let (p, a) = el(&mut dom, root, "p", "a");
    el(&mut dom, p, "span", "HIDDEN");
    let c = text(&mut dom, p, "c");
    let sheet = Stylesheet::new().rule_unchecked(
        "span",
        TuiStyle::new().display(crate::layout::Display::None),
    );
    assert_eq!(copy(&mut dom, &sheet, (a, 0), (c, 1)), "ac");
}

#[test]
fn a_partial_selection_inside_one_text_node_collapses_too() {
    let mut dom = TuiDom::new();
    let root = dom.root();
    let (_, t) = el(&mut dom, root, "p", "a   b   c");
    // "   b   " — the run collapses; the edges are mid-line, so a
    // collapsed space at either end stays.
    assert_eq!(copy(&mut dom, &Stylesheet::new(), (t, 1), (t, 8)), " b ");
}