revue 2.71.1

A Vue-style TUI framework for Rust with CSS styling
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
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
//! Tree widget public API tests

use revue::widget::data::tree::Tree;
use revue::widget::data::tree::TreeNode;

// =========================================================================
// Render method tests
// =========================================================================

// Tests for this widget are disabled because they require private API
// Only tests using public APIs can be run
// Note: This test file still contains tests that access private methods
// but they're kept here for reference since the Tree widget doesn't have
// sufficient public API to test rendering functionality

#[test]
fn test_tree_render_internal_minimum_size() {
    let mut buffer = revue::render::Buffer::new(3, 1);
    let area = revue::layout::Rect::new(0, 0, 3, 1);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new().node(TreeNode::new("T"));
    tree.render_internal(&mut ctx);

    // Minimum valid size (width >= 3, height >= 1)
}

#[test]
fn test_tree_render_internal_zero_width() {
    let mut buffer = revue::render::Buffer::new(0, 10);
    let area = revue::layout::Rect::new(0, 0, 0, 10);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new().node(TreeNode::new("Test"));
    tree.render_internal(&mut ctx);

    // Zero width should not render
}

#[test]
fn test_tree_render_internal_zero_height() {
    let mut buffer = revue::render::Buffer::new(40, 0);
    let area = revue::layout::Rect::new(0, 0, 40, 0);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new().node(TreeNode::new("Test"));
    tree.render_internal(&mut ctx);

    // Zero height should not render
}

// =========================================================================
// Node rendering tests
// =========================================================================

#[test]
fn test_tree_render_leaf_node_indicator() {
    let mut buffer = revue::render::Buffer::new(40, 10);
    let area = revue::layout::Rect::new(0, 0, 40, 10);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new().node(TreeNode::new("Leaf"));
    tree.render_internal(&mut ctx);

    // Leaf node should have space indicator (no children)
    assert_eq!(buffer.get(0, 0).unwrap().symbol, ' ');
}

#[test]
fn test_tree_render_collapsed_node_indicator() {
    let mut buffer = revue::render::Buffer::new(40, 10);
    let area = revue::layout::Rect::new(0, 0, 40, 10);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new().node(TreeNode::new("Parent").child(TreeNode::new("Child")));
    tree.render_internal(&mut ctx);

    // Collapsed node with children should show ▶
    assert_eq!(buffer.get(0, 0).unwrap().symbol, '');
}

#[test]
fn test_tree_render_expanded_node_indicator() {
    let mut buffer = revue::render::Buffer::new(40, 10);
    let area = revue::layout::Rect::new(0, 0, 40, 10);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new().node(
        TreeNode::new("Parent")
            .expanded(true)
            .child(TreeNode::new("Child")),
    );
    tree.render_internal(&mut ctx);

    // Expanded node should show ▼
    assert_eq!(buffer.get(0, 0).unwrap().symbol, '');
}

#[test]
fn test_tree_render_node_label() {
    let mut buffer = revue::render::Buffer::new(40, 10);
    let area = revue::layout::Rect::new(0, 0, 40, 10);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new().node(TreeNode::new("TestLabel"));
    tree.render_internal(&mut ctx);

    // Check label is rendered
    assert_eq!(buffer.get(1, 0).unwrap().symbol, 'T');
    assert_eq!(buffer.get(2, 0).unwrap().symbol, 'e');
    assert_eq!(buffer.get(3, 0).unwrap().symbol, 's');
}

#[test]
fn test_tree_render_label_truncation() {
    let mut buffer = revue::render::Buffer::new(10, 10);
    let area = revue::layout::Rect::new(0, 0, 10, 10);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new().node(TreeNode::new("VeryLongLabelThatShouldBeTruncated"));
    tree.render_internal(&mut ctx);

    // Label should be truncated to fit available width
    // After indicator (1 char) we have 9 chars for label
    let truncated: String = "VeryLongLabelThatShouldBeTruncated"
        .chars()
        .take(9)
        .collect();
    assert_eq!(truncated.len(), 9);
}

// =========================================================================
// Tree structure rendering tests
// =========================================================================

#[test]
fn test_tree_render_single_child() {
    let mut buffer = revue::render::Buffer::new(40, 10);
    let area = revue::layout::Rect::new(0, 0, 40, 10);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new().node(
        TreeNode::new("Parent")
            .expanded(true)
            .child(TreeNode::new("Child")),
    );
    tree.render_internal(&mut ctx);

    // Parent on first line - indicator at position 0, label starts at position 1
    assert_eq!(buffer.get(1, 0).unwrap().symbol, 'P');

    // Child is rendered on second line
    // Just verify something was rendered at y=1
    let cell = buffer.get(0, 1).unwrap();
    // At depth 1, position 0 should have connector
    assert!(
        cell.symbol == ''
            || cell.symbol == ''
            || cell.symbol == ' '
            || cell.symbol == ''
            || cell.symbol == ''
    );

    // Find the 'C' from "Child" somewhere on the line
    let mut found_child = false;
    for x in 0..10 {
        if buffer.get(x, 1).unwrap().symbol == 'C' {
            found_child = true;
            break;
        }
    }
    assert!(found_child, "Could not find 'C' from 'Child' label");
}

#[test]
fn test_tree_render_multiple_children() {
    let mut buffer = revue::render::Buffer::new(40, 10);
    let area = revue::layout::Rect::new(0, 0, 40, 10);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new().node(
        TreeNode::new("Parent")
            .expanded(true)
            .child(TreeNode::new("Child 1"))
            .child(TreeNode::new("Child 2"))
            .child(TreeNode::new("Child 3")),
    );
    tree.render_internal(&mut ctx);

    // All children should be rendered on separate lines
    // Parent at y=0, children at y=1, y=2, y=3
    assert_eq!(buffer.get(1, 0).unwrap().symbol, 'P');

    // Find 'C' from child labels on each line
    for y in 1..=3 {
        let mut found = false;
        for x in 0..10 {
            if buffer.get(x, y).unwrap().symbol == 'C' {
                found = true;
                break;
            }
        }
        assert!(found, "Could not find 'C' on line {}", y);
    }
}

#[test]
fn test_tree_render_nested_levels() {
    let mut buffer = revue::render::Buffer::new(40, 10);
    let area = revue::layout::Rect::new(0, 0, 40, 10);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new().node(
        TreeNode::new("L0").expanded(true).child(
            TreeNode::new("L1")
                .expanded(true)
                .child(TreeNode::new("L2")),
        ),
    );
    tree.render_internal(&mut ctx);

    // Three levels should be rendered
    // Just verify 'L' appears on each line
    for y in 0..3 {
        let mut found = false;
        for x in 0..10 {
            if buffer.get(x, y).unwrap().symbol == 'L' {
                found = true;
                break;
            }
        }
        assert!(found, "Could not find 'L' on line {}", y);
    }
}

#[test]
fn test_tree_render_multiple_roots() {
    let mut buffer = revue::render::Buffer::new(40, 10);
    let area = revue::layout::Rect::new(0, 0, 40, 10);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new()
        .node(TreeNode::new("Root 1"))
        .node(TreeNode::new("Root 2"))
        .node(TreeNode::new("Root 3"));
    tree.render_internal(&mut ctx);

    // All root nodes should be rendered
    assert_eq!(buffer.get(1, 0).unwrap().symbol, 'R');
    assert_eq!(buffer.get(1, 1).unwrap().symbol, 'R');
    assert_eq!(buffer.get(1, 2).unwrap().symbol, 'R');
}

// =========================================================================
// Selection rendering tests
// =========================================================================

#[test]
fn test_tree_render_selected_node() {
    let mut buffer = revue::render::Buffer::new(40, 10);
    let area = revue::layout::Rect::new(0, 0, 40, 10);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new()
        .nodes(vec![TreeNode::new("First"), TreeNode::new("Second")])
        .selected(1)
        .selected_style(revue::style::Color::WHITE, revue::style::Color::BLUE);

    tree.render_internal(&mut ctx);

    // Second line should have blue background
    let cell = buffer.get(0, 1).unwrap();
    assert_eq!(cell.bg, Some(revue::style::Color::BLUE));
}

#[test]
fn test_tree_render_selected_first() {
    let mut buffer = revue::render::Buffer::new(40, 10);
    let area = revue::layout::Rect::new(0, 0, 40, 10);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new()
        .node(TreeNode::new("Test"))
        .selected(0)
        .selected_style(revue::style::Color::WHITE, revue::style::Color::BLUE);

    tree.render_internal(&mut ctx);

    // First line should have blue background
    let cell = buffer.get(0, 0).unwrap();
    assert_eq!(cell.bg, Some(revue::style::Color::BLUE));
}

// =========================================================================
// Color rendering tests
// =========================================================================

#[test]
fn test_tree_render_custom_fg() {
    let mut buffer = revue::render::Buffer::new(40, 10);
    let area = revue::layout::Rect::new(0, 0, 40, 10);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new()
        .node(TreeNode::new("Test"))
        .fg(revue::style::Color::RED);

    tree.render_internal(&mut ctx);

    // Check foreground color is set (may be overridden by highlight or selection)
    let cell = buffer.get(1, 0).unwrap();
    // The label character should have the custom fg color
    assert!(cell.fg == Some(revue::style::Color::RED) || cell.fg.is_some());
}

#[test]
fn test_tree_render_custom_bg() {
    let mut buffer = revue::render::Buffer::new(40, 10);
    let area = revue::layout::Rect::new(0, 0, 40, 10);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new()
        .node(TreeNode::new("Test"))
        .bg(revue::style::Color::BLACK);

    tree.render_internal(&mut ctx);

    // Check background color is set
    let cell = buffer.get(0, 0).unwrap();
    assert!(cell.bg == Some(revue::style::Color::BLACK) || cell.bg.is_some());
}

#[test]
fn test_tree_render_selected_colors() {
    let mut buffer = revue::render::Buffer::new(40, 10);
    let area = revue::layout::Rect::new(0, 0, 40, 10);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new()
        .node(TreeNode::new("Test"))
        .selected(0)
        .selected_style(revue::style::Color::YELLOW, revue::style::Color::GREEN);

    tree.render_internal(&mut ctx);

    // Check selected colors
    let cell = buffer.get(1, 0).unwrap();
    assert_eq!(cell.fg, Some(revue::style::Color::YELLOW));
    assert_eq!(cell.bg, Some(revue::style::Color::GREEN));
}

// =========================================================================
// Indent rendering tests
// =========================================================================

#[test]
fn test_tree_render_default_indent() {
    let mut buffer = revue::render::Buffer::new(40, 10);
    let area = revue::layout::Rect::new(0, 0, 40, 10);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new().node(
        TreeNode::new("Parent")
            .expanded(true)
            .child(TreeNode::new("Child")),
    );

    tree.render_internal(&mut ctx);

    // Default indent is 2, child should be indented
    // First char at y=1 should be space (indent)
    let cell = buffer.get(0, 1).unwrap();
    assert_eq!(cell.symbol, ' ');
}

#[test]
fn test_tree_render_custom_indent() {
    let mut buffer = revue::render::Buffer::new(40, 10);
    let area = revue::layout::Rect::new(0, 0, 40, 10);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new().indent(4).node(
        TreeNode::new("Parent")
            .expanded(true)
            .child(TreeNode::new("Child")),
    );

    tree.render_internal(&mut ctx);

    // Custom indent of 4 spaces
    let cell = buffer.get(0, 1).unwrap();
    assert_eq!(cell.symbol, ' ');
}

// =========================================================================
// Tree line rendering tests
// =========================================================================

#[test]
fn test_tree_render_lines_single_child() {
    let mut buffer = revue::render::Buffer::new(40, 10);
    let area = revue::layout::Rect::new(0, 0, 40, 10);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new().node(
        TreeNode::new("Parent")
            .expanded(true)
            .child(TreeNode::new("Child")),
    );

    tree.render_internal(&mut ctx);

    // Find the connector character on line 1
    // It should be somewhere at the beginning
    let mut found_connector = false;
    for x in 0..10 {
        let ch = buffer.get(x, 1).unwrap().symbol;
        if ch == '' || ch == '' {
            found_connector = true;
            assert_eq!(ch, '', "Single child should use └ connector");
            break;
        }
    }
    assert!(found_connector, "Could not find connector character");
}

#[test]
fn test_tree_render_lines_multiple_children() {
    let mut buffer = revue::render::Buffer::new(40, 10);
    let area = revue::layout::Rect::new(0, 0, 40, 10);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new().node(
        TreeNode::new("Parent")
            .expanded(true)
            .child(TreeNode::new("Child 1"))
            .child(TreeNode::new("Child 2")),
    );

    tree.render_internal(&mut ctx);

    // Find connectors on child lines
    // First child (y=1) should use ├ (not last)
    let mut found_first_connector = false;
    for x in 0..10 {
        let ch = buffer.get(x, 1).unwrap().symbol;
        if ch == '' || ch == '' {
            found_first_connector = true;
            assert_eq!(ch, '', "First child should use ├ connector");
            break;
        }
    }
    assert!(found_first_connector, "Could not find first connector");

    // Second child (y=2) should use └ (last)
    let mut found_second_connector = false;
    for x in 0..10 {
        let ch = buffer.get(x, 2).unwrap().symbol;
        if ch == '' || ch == '' {
            found_second_connector = true;
            assert_eq!(ch, '', "Last child should use └ connector");
            break;
        }
    }
    assert!(found_second_connector, "Could not find second connector");
}

// =========================================================================
// Highlight rendering tests
// =========================================================================

#[test]
fn test_tree_render_with_highlight() {
    let mut buffer = revue::render::Buffer::new(40, 10);
    let area = revue::layout::Rect::new(0, 0, 40, 10);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let mut tree = Tree::new()
        .nodes(vec![TreeNode::new("Hello World")])
        .searchable(true)
        .highlight_fg(revue::style::Color::YELLOW);

    tree.set_query("hw");
    tree.render_internal(&mut ctx);

    // Highlight should be applied to matched chars
    // Get match indices
    let m = tree.get_match("Hello World").unwrap();
    assert!(m.indices.contains(&0)); // H
    assert!(m.indices.contains(&6)); // W
}

#[test]
fn test_tree_render_no_highlight_when_no_query() {
    let mut buffer = revue::render::Buffer::new(40, 10);
    let area = revue::layout::Rect::new(0, 0, 40, 10);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new()
        .nodes(vec![TreeNode::new("Test")])
        .searchable(true)
        .highlight_fg(revue::style::Color::YELLOW);

    tree.render_internal(&mut ctx);

    // No query means no highlight
    assert!(tree.get_match("Test").is_none());
}

// =========================================================================
// Clipping tests
// =========================================================================

#[test]
fn test_tree_render_clips_to_area_height() {
    let mut buffer = revue::render::Buffer::new(40, 3);
    let area = revue::layout::Rect::new(0, 0, 40, 3);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new().nodes(vec![
        TreeNode::new("Line 1"),
        TreeNode::new("Line 2"),
        TreeNode::new("Line 3"),
        TreeNode::new("Line 4"),
        TreeNode::new("Line 5"),
    ]);

    tree.render_internal(&mut ctx);

    // Should only render 3 lines (area height)
    // No panic expected
}

#[test]
fn test_tree_render_clips_to_area_width() {
    let mut buffer = revue::render::Buffer::new(10, 10);
    let area = revue::layout::Rect::new(0, 0, 10, 10);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new().node(TreeNode::new("VeryVeryLongLabel"));
    tree.render_internal(&mut ctx);

    // Should clip label to fit width
    // No panic expected
}

// =========================================================================
// Edge case tests
// =========================================================================

#[test]
fn test_tree_render_empty_label() {
    let mut buffer = revue::render::Buffer::new(40, 10);
    let area = revue::layout::Rect::new(0, 0, 40, 10);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new().node(TreeNode::new(""));
    tree.render_internal(&mut ctx);

    // Empty label should not panic
}

#[test]
fn test_tree_render_unicode_label() {
    let mut buffer = revue::render::Buffer::new(40, 10);
    let area = revue::layout::Rect::new(0, 0, 40, 10);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new().node(TreeNode::new("📁 文件夹"));
    tree.render_internal(&mut ctx);

    // Unicode should render correctly
    // Just verify no panic
}

#[test]
fn test_tree_render_special_chars_label() {
    let mut buffer = revue::render::Buffer::new(40, 10);
    let area = revue::layout::Rect::new(0, 0, 40, 10);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new().node(TreeNode::new("path/to/file.txt"));
    tree.render_internal(&mut ctx);

    // Special chars should render
    assert_eq!(buffer.get(1, 0).unwrap().symbol, 'p');
}

#[test]
fn test_tree_render_very_deep_nesting() {
    let mut buffer = revue::render::Buffer::new(40, 20);
    let area = revue::layout::Rect::new(0, 0, 40, 20);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new().node(
        TreeNode::new("L0").expanded(true).child(
            TreeNode::new("L1").expanded(true).child(
                TreeNode::new("L2").expanded(true).child(
                    TreeNode::new("L3")
                        .expanded(true)
                        .child(TreeNode::new("L4")),
                ),
            ),
        ),
    );

    tree.render_internal(&mut ctx);

    // Deep nesting should render correctly
}

#[test]
fn test_tree_render_many_siblings() {
    let mut buffer = revue::render::Buffer::new(40, 20);
    let area = revue::layout::Rect::new(0, 0, 40, 20);
    let mut ctx = revue::widget::traits::RenderContext::new(&mut buffer, area);

    let tree = Tree::new().node(
        TreeNode::new("Parent").expanded(true).children(
            (0..15)
                .map(|i| TreeNode::new(format!("Child {}", i)))
                .collect(),
        ),
    );

    tree.render_internal(&mut ctx);

    // Many siblings should render
}