abstracttui 0.2.23

A reactive, compositor-grade terminal UI engine: fine-grained signals, layered rendering with damage tracking, images (kitty/iTerm2/sixel/mosaic), software-rasterized 3D (GLB), themes and animation.
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
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
//! List tests (split file for the size budget — same crate-private
//! module as `list.rs` via `#[path]`): selection/windowing behavior,
//! sticky keys, variable heights, and the 0250 activation contract
//! (movement never activates; Enter/Space/click-on-selected do;
//! callbacks may dispose the List's scope synchronously).

use super::*;
use crate::base::Size;
use crate::theme::default_theme;
use crate::widgets::itest_util::{key, mount_widget, mouse, render};

fn rows(canvas: &crate::ui::BufferCanvas, n: i32) -> Vec<String> {
    (0..n).map(|y| canvas.row_text(y)).collect()
}

#[test]
fn keyboard_selection_scrolls_window_and_fires_on_select() {
    let t = default_theme().tokens;
    let picked: Rc<RefCell<Vec<usize>>> = Rc::new(RefCell::new(Vec::new()));
    let p = picked.clone();
    let (_root, mut tree) = mount_widget(Size::new(12, 3), |cx| {
        Element::new()
            .style(
                LayoutStyle::default()
                    .width(Dimension::Percent(1.0))
                    .height(Dimension::Percent(1.0)),
            )
            .child(
                List::of((0..8).map(|i| format!("item {i}")))
                    .on_select(move |i| p.borrow_mut().push(i))
                    .element(cx, &t)
                    .build(),
            )
            .build()
    });
    key(&mut tree, Key::Tab);
    for _ in 0..4 {
        key(&mut tree, Key::Down);
    }
    crate::reactive::flush_effects();
    tree.layout();
    let canvas = render(&mut tree, Size::new(12, 3));
    // Selection 4 scrolled into view (rows 2..5 visible).
    assert!(
        rows(&canvas, 3).iter().any(|r| r.contains("item 4")),
        "{:?}",
        rows(&canvas, 3)
    );
    assert_eq!(*picked.borrow(), vec![1, 2, 3, 4]);
}

#[test]
fn click_selects_by_visible_row_and_wheel_scrolls() {
    let t = default_theme().tokens;
    let mut sel_probe = None;
    let (_root, mut tree) = mount_widget(Size::new(12, 4), |cx| {
        let sel = cx.signal(0usize);
        sel_probe = Some(sel);
        Element::new()
            .style(
                LayoutStyle::default()
                    .width(Dimension::Percent(1.0))
                    .height(Dimension::Percent(1.0)),
            )
            .child(
                List::of((0..20).map(|i| format!("row {i}")))
                    .selection(sel)
                    .element(cx, &t)
                    .build(),
            )
            .build()
    });
    let sel = sel_probe.unwrap();
    mouse(&mut tree, MouseKind::Down(MouseButton::Left), 2, 2);
    assert_eq!(sel.get_untracked(), 2);
    mouse(&mut tree, MouseKind::ScrollDown, 2, 2);
    crate::reactive::flush_effects();
    tree.layout();
    let canvas = render(&mut tree, Size::new(12, 4));
    assert!(
        canvas.row_text(0).contains("row 3"),
        "{:?}",
        canvas.row_text(0)
    );
}

#[test]
fn selection_key_survives_data_mutation_rebuild() {
    // STICKY SELECTION (cycle 7): the key signal re-finds its item's
    // NEW index after items shift — a rebuild with an inserted row
    // keeps the same logical item selected.
    let t = default_theme().tokens;
    let mut probes = None;
    let (_root, mut tree) = mount_widget(Size::new(14, 5), |cx| {
        let data = cx.signal(vec!["alpha".to_string(), "beta".into(), "gamma".into()]);
        let sel_key = cx.signal(String::from("beta"));
        let sel_ix = cx.signal(0usize);
        probes = Some((data, sel_key, sel_ix));
        let tokens = t;
        Element::new()
            .style(
                LayoutStyle::default()
                    .width(Dimension::Percent(1.0))
                    .height(Dimension::Percent(1.0)),
            )
            .child(crate::ui::dyn_view_scoped(
                LayoutStyle::default()
                    .width(Dimension::Percent(1.0))
                    .height(Dimension::Percent(1.0)),
                move |gen_cx| {
                    List::new(data.get())
                        .key_fn(|_, s| s.to_string())
                        .selection_key(sel_key)
                        .selection(sel_ix)
                        .element(gen_cx, &tokens)
                        .build()
                },
            ))
            .build()
    });
    let (data, sel_key, sel_ix) = probes.unwrap();
    crate::reactive::flush_effects();
    assert_eq!(sel_ix.get_untracked(), 1, "key 'beta' resolved to index 1");
    // Mutate: insert two rows BEFORE beta -> its index becomes 3.
    data.update(|v| {
        v.insert(0, "zero".into());
        v.insert(1, "one".into());
    });
    crate::reactive::flush_effects();
    assert_eq!(
        sel_ix.get_untracked(),
        3,
        "sticky: beta re-found after mutation"
    );
    assert_eq!(sel_key.get_untracked(), "beta");
    // And selecting a different row updates the key.
    key(&mut tree, Key::Tab);
    key(&mut tree, Key::Down);
    crate::reactive::flush_effects();
    assert_eq!(sel_key.get_untracked(), "gamma");
}

#[test]
fn variable_heights_window_by_content_rows_and_click_maps_rows_to_items() {
    let t = default_theme().tokens;
    let mut sel_probe = None;
    let (_root, mut tree) = mount_widget(Size::new(14, 4), |cx| {
        let sel = cx.signal(0usize);
        sel_probe = Some(sel);
        Element::new()
            .style(
                LayoutStyle::default()
                    .width(Dimension::Percent(1.0))
                    .height(Dimension::Percent(1.0)),
            )
            .child(
                List::of((0..6).map(|i| format!("it {i}")))
                    .item_heights(|i, _| if i % 2 == 0 { 2 } else { 1 })
                    .selection(sel)
                    .element(cx, &t)
                    .build(),
            )
            .build()
    });
    let sel = sel_probe.unwrap();
    tree.layout();
    let canvas = render(&mut tree, Size::new(14, 4));
    // it0 occupies rows 0-1 (h=2), it1 row 2, it2 rows 3+.
    assert!(canvas.row_text(0).contains("it 0"));
    assert_eq!(
        canvas.row_text(1).trim(),
        "│",
        "spacer row of the 2-tall item (+bar)"
    );
    assert!(canvas.row_text(2).contains("it 1"));
    // Clicking the SECOND row of it0 still selects item 0.
    mouse(&mut tree, MouseKind::Down(MouseButton::Left), 2, 1);
    assert_eq!(sel.get_untracked(), 0);
    // Clicking row 2 selects item 1 (row->item binary search).
    mouse(&mut tree, MouseKind::Down(MouseButton::Left), 2, 2);
    assert_eq!(sel.get_untracked(), 1);
}

#[test]
fn movement_fires_on_select_never_on_activate() {
    // 0250 ruling clause 1: selection follows movement; activation
    // is never wired to it.
    let t = default_theme().tokens;
    let selects: Rc<RefCell<Vec<usize>>> = Rc::new(RefCell::new(Vec::new()));
    let activates: Rc<RefCell<Vec<usize>>> = Rc::new(RefCell::new(Vec::new()));
    let (s, a) = (selects.clone(), activates.clone());
    let (_root, mut tree) = mount_widget(Size::new(12, 4), |cx| {
        Element::new()
            .style(
                LayoutStyle::default()
                    .width(Dimension::Percent(1.0))
                    .height(Dimension::Percent(1.0)),
            )
            .child(
                List::of((0..8).map(|i| format!("item {i}")))
                    .on_select(move |i| s.borrow_mut().push(i))
                    .on_activate(move |i| a.borrow_mut().push(i))
                    .element(cx, &t)
                    .build(),
            )
            .build()
    });
    key(&mut tree, Key::Tab);
    key(&mut tree, Key::Down);
    key(&mut tree, Key::Down);
    key(&mut tree, Key::End);
    key(&mut tree, Key::Home);
    assert_eq!(*selects.borrow(), vec![1, 2, 7, 0]);
    assert!(
        activates.borrow().is_empty(),
        "movement must never activate: {:?}",
        activates.borrow()
    );
}

#[test]
fn enter_space_and_click_on_selected_row_activate() {
    // 0250 ruling clause 2: Enter always; Space (no toggle meaning
    // in a List); click on the ALREADY-selected row. A click on an
    // unselected row only selects.
    let t = default_theme().tokens;
    let activates: Rc<RefCell<Vec<usize>>> = Rc::new(RefCell::new(Vec::new()));
    let a = activates.clone();
    let (_root, mut tree) = mount_widget(Size::new(12, 4), |cx| {
        Element::new()
            .style(
                LayoutStyle::default()
                    .width(Dimension::Percent(1.0))
                    .height(Dimension::Percent(1.0)),
            )
            .child(
                List::of((0..8).map(|i| format!("item {i}")))
                    .on_activate(move |i| a.borrow_mut().push(i))
                    .element(cx, &t)
                    .build(),
            )
            .build()
    });
    key(&mut tree, Key::Tab);
    key(&mut tree, Key::Down); // selection -> 1, no activation
    assert!(activates.borrow().is_empty());
    assert!(key(&mut tree, Key::Enter), "Enter consumed when bound");
    assert_eq!(*activates.borrow(), vec![1]);
    assert!(key(&mut tree, Key::Char(' ')), "Space consumed when bound");
    assert_eq!(*activates.borrow(), vec![1, 1]);
    // Click row 3 (unselected): selects only.
    mouse(&mut tree, MouseKind::Down(MouseButton::Left), 2, 3);
    assert_eq!(*activates.borrow(), vec![1, 1]);
    // Click row 3 again (now selected): activates.
    mouse(&mut tree, MouseKind::Down(MouseButton::Left), 2, 3);
    assert_eq!(*activates.borrow(), vec![1, 1, 3]);
}

/// Double-click on a List row (app-kits 0535): SUBSUMED by the
/// click-on-selected rule — click 1 selects, click 2 lands on the
/// now-selected row and activates. With the click chain live (scripted
/// event time, as under the driver) the second press carries
/// `click_count() == 2` AND satisfies was-selected; the activation
/// must fire EXACTLY once — never once per rule.
#[test]
fn double_click_fires_on_activate_exactly_once() {
    let t = default_theme().tokens;
    let activates: Rc<RefCell<Vec<usize>>> = Rc::new(RefCell::new(Vec::new()));
    let a = activates.clone();
    let (_root, mut tree) = mount_widget(Size::new(12, 4), |cx| {
        Element::new()
            .style(
                LayoutStyle::default()
                    .width(Dimension::Percent(1.0))
                    .height(Dimension::Percent(1.0)),
            )
            .child(
                List::of((0..8).map(|i| format!("item {i}")))
                    .on_activate(move |i| a.borrow_mut().push(i))
                    .element(cx, &t)
                    .build(),
            )
            .build()
    });
    let t0 = std::time::Instant::now();
    crate::ui::set_event_time(Some(t0));
    mouse(&mut tree, MouseKind::Down(MouseButton::Left), 2, 2);
    assert!(activates.borrow().is_empty(), "click 1 selects only");
    crate::ui::set_event_time(Some(t0 + std::time::Duration::from_millis(100)));
    mouse(&mut tree, MouseKind::Down(MouseButton::Left), 2, 2);
    assert_eq!(
        *activates.borrow(),
        vec![2],
        "double-click activates exactly once"
    );
    crate::ui::set_event_time(None);
}

#[test]
fn enter_and_space_pass_through_without_on_activate() {
    // Compatibility pin: an unbound List must leave Enter/Space to
    // the app (the pre-0250 root-shortcut workaround keeps working).
    let t = default_theme().tokens;
    let (_root, mut tree) = mount_widget(Size::new(12, 4), |cx| {
        Element::new()
            .style(
                LayoutStyle::default()
                    .width(Dimension::Percent(1.0))
                    .height(Dimension::Percent(1.0)),
            )
            .child(
                List::of((0..4).map(|i| format!("item {i}")))
                    .element(cx, &t)
                    .build(),
            )
            .build()
    });
    key(&mut tree, Key::Tab);
    assert!(
        !key(&mut tree, Key::Enter),
        "Enter must not be consumed by an activation-less List"
    );
    assert!(
        !key(&mut tree, Key::Char(' ')),
        "Space must not be consumed by an activation-less List"
    );
}

/// The 0250 field crash, pinned: an `on_select` that synchronously
/// disposes the List's scope (the modal-picker close) must not
/// panic — all widget bookkeeping (ensure-visible `offset.update`)
/// lands BEFORE the callback (ruling clause 4).
#[test]
fn on_select_may_dispose_the_lists_scope() {
    let t = default_theme().tokens;
    let mut tree = crate::ui::UiTree::new(Size::new(12, 4));
    let (root, ()) = crate::reactive::create_root(|cx| {
        let picker_cx = cx.child();
        let view = List::of((0..8).map(|i| format!("item {i}")))
            .on_select(move |_| picker_cx.dispose())
            .element(picker_cx, &t)
            .build();
        tree.mount(picker_cx, view);
    });
    tree.layout();
    key(&mut tree, Key::Tab);
    key(&mut tree, Key::Down); // fires on_select -> dispose, mid-dispatch
    assert_eq!(tree.instance_count(), 0, "subtree unmounted by dispose");
    root.dispose();
}

/// Ruling clause 4 for the activation event: Enter-activate and
/// click-activate callbacks may dispose the List's scope.
#[test]
fn on_activate_may_dispose_the_lists_scope() {
    let t = default_theme().tokens;
    // Enter path.
    let mut tree = crate::ui::UiTree::new(Size::new(12, 4));
    let (root, ()) = crate::reactive::create_root(|cx| {
        let picker_cx = cx.child();
        let view = List::of((0..8).map(|i| format!("item {i}")))
            .on_activate(move |_| picker_cx.dispose())
            .element(picker_cx, &t)
            .build();
        tree.mount(picker_cx, view);
    });
    tree.layout();
    key(&mut tree, Key::Tab);
    key(&mut tree, Key::Enter); // activate -> dispose, mid-dispatch
    assert_eq!(tree.instance_count(), 0);
    root.dispose();
    // Click-on-selected path (mouse post-dispatch bookkeeping must
    // tolerate the disposed target too).
    let mut tree = crate::ui::UiTree::new(Size::new(12, 4));
    let (root, ()) = crate::reactive::create_root(|cx| {
        let picker_cx = cx.child();
        let view = List::of((0..8).map(|i| format!("item {i}")))
            .on_activate(move |_| picker_cx.dispose())
            .element(picker_cx, &t)
            .build();
        tree.mount(picker_cx, view);
    });
    tree.layout();
    mouse(&mut tree, MouseKind::Down(MouseButton::Left), 2, 0); // row 0 = selected
    assert_eq!(tree.instance_count(), 0);
    // A follow-up event over the dead tree stays inert.
    mouse(&mut tree, MouseKind::Down(MouseButton::Left), 2, 0);
    root.dispose();
}

#[test]
fn empty_list_ignores_movement_and_activation_keys() {
    // Movement on an empty list used to index past the prefix sums;
    // activation has nothing to commit. Both must be inert.
    let t = default_theme().tokens;
    let activates: Rc<RefCell<Vec<usize>>> = Rc::new(RefCell::new(Vec::new()));
    let a = activates.clone();
    let (_root, mut tree) = mount_widget(Size::new(12, 3), |cx| {
        Element::new()
            .style(
                LayoutStyle::default()
                    .width(Dimension::Percent(1.0))
                    .height(Dimension::Percent(1.0)),
            )
            .child(
                List::new(Vec::new())
                    .on_activate(move |i| a.borrow_mut().push(i))
                    .element(cx, &t)
                    .build(),
            )
            .build()
    });
    key(&mut tree, Key::Tab);
    key(&mut tree, Key::Down);
    key(&mut tree, Key::End);
    key(&mut tree, Key::Enter);
    key(&mut tree, Key::Char(' '));
    assert!(activates.borrow().is_empty());
}

#[test]
fn scroll_to_command_scrolls_and_consumes() {
    let t = default_theme().tokens;
    let mut probe = None;
    let (_root, mut tree) = mount_widget(Size::new(12, 3), |cx| {
        let req = cx.signal(None::<usize>);
        probe = Some(req);
        Element::new()
            .style(
                LayoutStyle::default()
                    .width(Dimension::Percent(1.0))
                    .height(Dimension::Percent(1.0)),
            )
            .child(
                List::of((0..30).map(|i| format!("row {i}")))
                    .scroll_to(req)
                    .element(cx, &t)
                    .build(),
            )
            .build()
    });
    let req = probe.unwrap();
    req.set(Some(20));
    crate::reactive::flush_effects();
    tree.layout();
    let canvas = render(&mut tree, Size::new(12, 3));
    assert!(
        canvas.row_text(0).contains("row 20"),
        "{:?}",
        canvas.row_text(0)
    );
    assert_eq!(req.get_untracked(), None, "request consumed");
}

/// Wave-12 reentrancy pin (the SharedCallback held-borrow contract in
/// widgets/mod.rs): an `on_select` that WRITES THE CONTROLLED
/// SELECTION SIGNAL and then forces a synchronous `flush_effects()`
/// mid-callback. The hosting `dyn_view_scoped` region rebuilds —
/// disposing this very List's generation — while the widget's
/// `on_select` borrow is held and its handler frame is live. Safe
/// because dispatch's Rc clones keep the executing closures and the
/// slot alive through the disposal, and the rebuilt generation owns
/// the next interaction. If effects ever flush eagerly inside
/// dispatch (breaking fact 2 of the contract), this is the tripwire.
#[test]
fn callback_reentrancy_pin_controlled_write_and_flush_mid_callback() {
    use crate::ui::dyn_view_scoped;
    let t = default_theme().tokens;
    let sel_holder: Rc<RefCell<Option<crate::reactive::Signal<usize>>>> = Default::default();
    let sh = sel_holder.clone();
    let picks: Rc<RefCell<Vec<usize>>> = Default::default();
    let pk = picks.clone();
    let (_root, mut tree) = mount_widget(Size::new(14, 4), move |cx| {
        let sel = cx.signal(0usize);
        *sh.borrow_mut() = Some(sel);
        Element::new()
            .style(
                LayoutStyle::default()
                    .width(Dimension::Percent(1.0))
                    .height(Dimension::Percent(1.0)),
            )
            .child(dyn_view_scoped(
                LayoutStyle::default()
                    .width(Dimension::Percent(1.0))
                    .height(Dimension::Percent(1.0)),
                move |gen_cx| {
                    let _generation_key = sel.get(); // rebuild per selection write
                    let pk = pk.clone();
                    Element::new()
                        .child(
                            List::of((0..9).map(|i| format!("item {i}")))
                                .selection(sel)
                                .on_select(move |i| {
                                    pk.borrow_mut().push(i);
                                    if i != 7 {
                                        sel.set(7); // write the CONTROLLED signal…
                                        crate::reactive::flush_effects(); // …and rebuild NOW
                                    }
                                })
                                .element(gen_cx, &t)
                                .build(),
                        )
                        .build()
                },
            ))
            .build()
    });
    let sel = sel_holder.borrow().unwrap();
    key(&mut tree, Key::Tab); // focus the list
    key(&mut tree, Key::Down); // select 1 -> callback forces 7 + rebuild
    assert_eq!(*picks.borrow(), vec![1], "first pick delivered");
    assert_eq!(sel.get_untracked(), 7, "mid-callback write landed");
    // The rebuilt generation is live and interactive.
    key(&mut tree, Key::Tab);
    key(&mut tree, Key::Down); // 7 -> 8 -> callback forces 7 again
    assert_eq!(*picks.borrow(), vec![1, 8], "rebuilt list still fires");
    assert_eq!(sel.get_untracked(), 7);
    crate::reactive::flush_effects();
    tree.layout();
    let canvas = render(&mut tree, Size::new(14, 4));
    assert!(
        (0..4).any(|y| canvas.row_text(y).contains("item")),
        "rebuilt list renders"
    );
}