ftui-widgets 0.11.0

Widget library built on FrankenTUI render and layout.
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
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
//! Border styling primitives.

/// Border characters for drawing.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct BorderSet {
    /// Vertical border character.
    pub vertical: char,
    /// Horizontal border character.
    pub horizontal: char,
    /// Top-left corner character.
    pub top_left: char,
    /// Top-right corner character.
    pub top_right: char,
    /// Bottom-left corner character.
    pub bottom_left: char,
    /// Bottom-right corner character.
    pub bottom_right: char,
    /// Upward tee junction character.
    pub tee_up: char,
    /// Downward tee junction character.
    pub tee_down: char,
    /// Leftward tee junction character.
    pub tee_left: char,
    /// Rightward tee junction character.
    pub tee_right: char,
    /// Cross junction character.
    pub cross: char,
}

impl BorderSet {
    /// ASCII fallback border (+, -, |).
    pub const ASCII: Self = Self {
        vertical: '|',
        horizontal: '-',
        top_left: '+',
        top_right: '+',
        bottom_left: '+',
        bottom_right: '+',
        tee_up: '+',
        tee_down: '+',
        tee_left: '+',
        tee_right: '+',
        cross: '+',
    };

    /// Rounded corners (╭, ╮, ╯, ╰).
    pub const ROUNDED: Self = Self {
        vertical: '│',
        horizontal: '─',
        top_left: '╭',
        top_right: '╮',
        bottom_left: '╰',
        bottom_right: '╯',
        tee_up: '┴',
        tee_down: '┬',
        tee_left: '┤',
        tee_right: '├',
        cross: '┼',
    };

    /// Square single-line border.
    pub const SQUARE: Self = Self {
        vertical: '│',
        horizontal: '─',
        top_left: '┌',
        top_right: '┐',
        bottom_left: '└',
        bottom_right: '┘',
        tee_up: '┴',
        tee_down: '┬',
        tee_left: '┤',
        tee_right: '├',
        cross: '┼',
    };

    /// Double lines (║, ═).
    pub const DOUBLE: Self = Self {
        vertical: '║',
        horizontal: '═',
        top_left: '╔',
        top_right: '╗',
        bottom_left: '╚',
        bottom_right: '╝',
        tee_up: '╩',
        tee_down: '╦',
        tee_left: '╣',
        tee_right: '╠',
        cross: '╬',
    };

    /// Heavy lines (┃, ━).
    pub const HEAVY: Self = Self {
        vertical: '┃',
        horizontal: '━',
        top_left: '┏',
        top_right: '┓',
        bottom_left: '┗',
        bottom_right: '┛',
        tee_up: '┻',
        tee_down: '┳',
        tee_left: '┫',
        tee_right: '┣',
        cross: '╋',
    };

    /// Single line with dashed edges (┄, ┆); square corners and junctions.
    pub const DASHED: Self = Self {
        vertical: '┆',
        horizontal: '┄',
        top_left: '┌',
        top_right: '┐',
        bottom_left: '└',
        bottom_right: '┘',
        tee_up: '┴',
        tee_down: '┬',
        tee_left: '┤',
        tee_right: '├',
        cross: '┼',
    };

    /// Heavy line with dashed edges (┅, ┇); heavy corners and junctions.
    pub const HEAVY_DASHED: Self = Self {
        vertical: '┇',
        horizontal: '┅',
        top_left: '┏',
        top_right: '┓',
        bottom_left: '┗',
        bottom_right: '┛',
        tee_up: '┻',
        tee_down: '┳',
        tee_left: '┫',
        tee_right: '┣',
        cross: '╋',
    };
}

/// Border style presets.
///
/// Eight variants: seven named glyph sets — `Square` (default), `Ascii`,
/// `Rounded`, `Double`, `Heavy`, `Dashed`, `HeavyDashed` — plus `Custom`, which
/// accepts any [`BorderSet`], so arbitrary corner/edge/junction glyphs are
/// supported without a new variant. This doc comment is the source of truth for
/// the "border styles" count cited in the README.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum BorderType {
    /// No border (but space reserved if Borders::ALL is set).
    #[default]
    Square,
    /// ASCII fallback border.
    Ascii,
    /// Single line border with rounded corners.
    Rounded,
    /// Double line border.
    Double,
    /// Heavy line border.
    Heavy,
    /// Single line border with dashed edges (┄, ┆).
    Dashed,
    /// Heavy line border with dashed edges (┅, ┇).
    HeavyDashed,
    /// Custom border character set.
    Custom(BorderSet),
}

/// Total number of border style variants (7 named presets + 1 [`Custom`](BorderType::Custom)).
/// Cited by the README and claims ledger.
pub const BORDER_STYLE_COUNT: usize = 8;

impl BorderType {
    /// The number of built-in named border styles (every variant except the
    /// open-ended [`Custom`](BorderType::Custom)). Cited by the README and the
    /// `border_type_variant_count_matches_readme` test.
    pub const NAMED_STYLE_COUNT: usize = 7;

    /// The total number of border style variants including [`Custom`](BorderType::Custom).
    pub const BORDER_STYLE_COUNT: usize = 8;

    /// Convert this border type to its corresponding border character set.
    pub fn to_border_set(&self) -> BorderSet {
        match self {
            BorderType::Square => BorderSet::SQUARE,
            BorderType::Ascii => BorderSet::ASCII,
            BorderType::Rounded => BorderSet::ROUNDED,
            BorderType::Double => BorderSet::DOUBLE,
            BorderType::Heavy => BorderSet::HEAVY,
            BorderType::Dashed => BorderSet::DASHED,
            BorderType::HeavyDashed => BorderSet::HEAVY_DASHED,
            BorderType::Custom(set) => *set,
        }
    }
}

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

    #[test]
    fn ascii_is_ascii_only() {
        let set = BorderSet::ASCII;
        let chars = [
            set.vertical,
            set.horizontal,
            set.top_left,
            set.top_right,
            set.bottom_left,
            set.bottom_right,
            set.tee_up,
            set.tee_down,
            set.tee_left,
            set.tee_right,
            set.cross,
        ];
        assert!(chars.iter().all(|c| c.is_ascii()));
    }

    #[test]
    fn square_has_box_drawing() {
        let set = BorderSet::SQUARE;
        assert_eq!(set.horizontal, '─');
        assert_eq!(set.vertical, '│');
        assert_eq!(set.cross, '┼');
    }

    #[test]
    fn rounded_has_round_corners() {
        let set = BorderSet::ROUNDED;
        assert_eq!(set.top_left, '╭');
        assert_eq!(set.top_right, '╮');
        assert_eq!(set.bottom_left, '╰');
        assert_eq!(set.bottom_right, '╯');
        assert_eq!(set.horizontal, '─');
        assert_eq!(set.vertical, '│');
    }

    #[test]
    fn double_has_double_lines() {
        let set = BorderSet::DOUBLE;
        assert_eq!(set.horizontal, '═');
        assert_eq!(set.vertical, '║');
        assert_eq!(set.top_left, '╔');
        assert_eq!(set.top_right, '╗');
        assert_eq!(set.bottom_left, '╚');
        assert_eq!(set.bottom_right, '╝');
        assert_eq!(set.cross, '╬');
    }

    #[test]
    fn heavy_has_heavy_lines() {
        let set = BorderSet::HEAVY;
        assert_eq!(set.horizontal, '━');
        assert_eq!(set.vertical, '┃');
        assert_eq!(set.top_left, '┏');
        assert_eq!(set.top_right, '┓');
        assert_eq!(set.bottom_left, '┗');
        assert_eq!(set.bottom_right, '┛');
        assert_eq!(set.cross, '╋');
    }

    #[test]
    fn all_border_sets_have_11_fields() {
        for set in [
            BorderSet::ASCII,
            BorderSet::ROUNDED,
            BorderSet::SQUARE,
            BorderSet::DOUBLE,
            BorderSet::HEAVY,
        ] {
            let chars = [
                set.vertical,
                set.horizontal,
                set.top_left,
                set.top_right,
                set.bottom_left,
                set.bottom_right,
                set.tee_up,
                set.tee_down,
                set.tee_left,
                set.tee_right,
                set.cross,
            ];
            assert_eq!(chars.len(), 11);
            // horizontal and vertical are distinct in all sets
            assert_ne!(set.horizontal, set.vertical);
        }
    }

    #[test]
    fn box_drawing_sets_have_distinct_corners() {
        // Non-ASCII sets use unique box drawing chars for each corner
        for set in [
            BorderSet::ROUNDED,
            BorderSet::SQUARE,
            BorderSet::DOUBLE,
            BorderSet::HEAVY,
        ] {
            let corners = [
                set.top_left,
                set.top_right,
                set.bottom_left,
                set.bottom_right,
            ];
            for (i, a) in corners.iter().enumerate() {
                for (j, b) in corners.iter().enumerate() {
                    if i != j {
                        assert_ne!(a, b, "corners {i} and {j} should differ");
                    }
                }
            }
        }
    }

    #[test]
    fn ascii_set_reuses_plus_for_junctions() {
        let set = BorderSet::ASCII;
        // ASCII uses '+' for all corners, tees, and cross
        assert_eq!(set.top_left, '+');
        assert_eq!(set.top_right, '+');
        assert_eq!(set.bottom_left, '+');
        assert_eq!(set.bottom_right, '+');
        assert_eq!(set.tee_up, '+');
        assert_eq!(set.tee_down, '+');
        assert_eq!(set.tee_left, '+');
        assert_eq!(set.tee_right, '+');
        assert_eq!(set.cross, '+');
    }

    #[test]
    fn border_type_to_border_set_roundtrip() {
        assert_eq!(BorderType::Square.to_border_set(), BorderSet::SQUARE);
        assert_eq!(BorderType::Ascii.to_border_set(), BorderSet::ASCII);
        assert_eq!(BorderType::Rounded.to_border_set(), BorderSet::ROUNDED);
        assert_eq!(BorderType::Double.to_border_set(), BorderSet::DOUBLE);
        assert_eq!(BorderType::Heavy.to_border_set(), BorderSet::HEAVY);
        assert_eq!(BorderType::Dashed.to_border_set(), BorderSet::DASHED);
        assert_eq!(
            BorderType::HeavyDashed.to_border_set(),
            BorderSet::HEAVY_DASHED
        );
    }

    #[test]
    fn dashed_to_border_set_matches_const() {
        let set = BorderType::Dashed.to_border_set();
        assert_eq!(set, BorderSet::DASHED);
        // Dashed edges with plain square corners and junctions.
        assert_eq!(BorderSet::DASHED.horizontal, '┄');
        assert_eq!(BorderSet::DASHED.vertical, '┆');
        assert_eq!(set.horizontal, '┄');
        assert_eq!(set.vertical, '┆');
        assert_eq!(set.top_left, BorderSet::SQUARE.top_left);
        assert_eq!(set.top_right, BorderSet::SQUARE.top_right);
        assert_eq!(set.bottom_left, BorderSet::SQUARE.bottom_left);
        assert_eq!(set.bottom_right, BorderSet::SQUARE.bottom_right);
        assert_eq!(set.cross, BorderSet::SQUARE.cross);
    }

    #[test]
    fn heavy_dashed_matches_const() {
        let set = BorderType::HeavyDashed.to_border_set();
        assert_eq!(set, BorderSet::HEAVY_DASHED);
        assert_eq!(set.horizontal, '┅');
        assert_eq!(set.vertical, '┇');
        assert_eq!(set.top_left, '┏');
        assert_eq!(set.cross, '╋');
    }

    #[test]
    fn border_type_variant_count_matches_readme() {
        // Seven named styles plus the open-ended `Custom`.
        const ALL: &[BorderType] = &[
            BorderType::Square,
            BorderType::Ascii,
            BorderType::Rounded,
            BorderType::Double,
            BorderType::Heavy,
            BorderType::Dashed,
            BorderType::HeavyDashed,
            BorderType::Custom(BorderSet::SQUARE),
        ];
        assert_eq!(ALL.len(), BORDER_STYLE_COUNT);
        assert_eq!(ALL.len(), BorderType::BORDER_STYLE_COUNT);

        // Exhaustive match over ALL to guarantee every variant is represented:
        for b in ALL {
            match b {
                BorderType::Square
                | BorderType::Ascii
                | BorderType::Rounded
                | BorderType::Double
                | BorderType::Heavy
                | BorderType::Dashed
                | BorderType::HeavyDashed
                | BorderType::Custom(_) => {}
            }
        }

        let named = [
            BorderType::Square,
            BorderType::Ascii,
            BorderType::Rounded,
            BorderType::Double,
            BorderType::Heavy,
            BorderType::Dashed,
            BorderType::HeavyDashed,
        ];
        assert_eq!(named.len(), BorderType::NAMED_STYLE_COUNT);
        assert_eq!(BorderType::NAMED_STYLE_COUNT, 7);
        // Every named style resolves to a border set, and they are all distinct.
        let sets: Vec<BorderSet> = named.iter().map(BorderType::to_border_set).collect();
        for (i, a) in sets.iter().enumerate() {
            for b in &sets[i + 1..] {
                assert_ne!(a, b, "named border sets must be distinct");
            }
        }
    }

    #[test]
    fn border_type_default_is_square() {
        assert_eq!(BorderType::default(), BorderType::Square);
    }

    #[test]
    fn custom_border_set_round_trips() {
        let set = BorderSet {
            top_left: '#',
            horizontal: '+',
            top_right: '-',
            vertical: '|',
            bottom_left: '=',
            bottom_right: 'T',
            tee_up: '^',
            tee_down: '<',
            tee_left: '>',
            tee_right: '*',
            cross: '~',
        };
        assert_eq!(BorderType::Custom(set).to_border_set(), set);
    }

    #[test]
    fn border_type_custom_uses_provided_set() {
        let custom = BorderSet {
            vertical: '!',
            horizontal: '-',
            top_left: '/',
            top_right: '\\',
            bottom_left: '\\',
            bottom_right: '/',
            tee_up: '+',
            tee_down: '+',
            tee_left: '+',
            tee_right: '+',
            cross: '*',
        };

        assert_eq!(BorderType::Custom(custom).to_border_set(), custom);
    }

    #[test]
    fn borders_none_is_zero() {
        assert!(Borders::NONE.is_empty());
        assert_eq!(Borders::NONE.bits(), 0);
    }

    #[test]
    fn borders_all_contains_all_sides() {
        assert!(Borders::ALL.contains(Borders::TOP));
        assert!(Borders::ALL.contains(Borders::RIGHT));
        assert!(Borders::ALL.contains(Borders::BOTTOM));
        assert!(Borders::ALL.contains(Borders::LEFT));
    }

    #[test]
    fn borders_individual_bits_are_distinct() {
        let sides = [Borders::TOP, Borders::RIGHT, Borders::BOTTOM, Borders::LEFT];
        for (i, a) in sides.iter().enumerate() {
            for (j, b) in sides.iter().enumerate() {
                if i != j {
                    assert!(!a.contains(*b), "side {i} should not contain side {j}");
                }
            }
        }
    }

    #[test]
    fn borders_union_and_intersection() {
        let top_left = Borders::TOP | Borders::LEFT;
        assert!(top_left.contains(Borders::TOP));
        assert!(top_left.contains(Borders::LEFT));
        assert!(!top_left.contains(Borders::RIGHT));

        let top_right = Borders::TOP | Borders::RIGHT;
        let intersection = top_left & top_right;
        assert!(intersection.contains(Borders::TOP));
        assert!(!intersection.contains(Borders::LEFT));
        assert!(!intersection.contains(Borders::RIGHT));
    }

    #[test]
    fn borders_default_is_none() {
        assert_eq!(Borders::default(), Borders::NONE);
    }

    #[test]
    fn non_ascii_sets_have_no_ascii_chars() {
        for set in [
            BorderSet::ROUNDED,
            BorderSet::SQUARE,
            BorderSet::DOUBLE,
            BorderSet::HEAVY,
        ] {
            let chars = [
                set.vertical,
                set.horizontal,
                set.top_left,
                set.top_right,
                set.bottom_left,
                set.bottom_right,
                set.tee_up,
                set.tee_down,
                set.tee_left,
                set.tee_right,
                set.cross,
            ];
            assert!(
                chars.iter().all(|c| !c.is_ascii()),
                "non-ASCII border set should have no ASCII chars"
            );
        }
    }

    #[test]
    fn border_set_tees_are_consistent() {
        for set in [
            BorderSet::ASCII,
            BorderSet::SQUARE,
            BorderSet::ROUNDED,
            BorderSet::DOUBLE,
            BorderSet::HEAVY,
            BorderSet::DASHED,
            BorderSet::HEAVY_DASHED,
        ] {
            let tees = [set.tee_up, set.tee_down, set.tee_left, set.tee_right];
            for tee in tees {
                assert_eq!(
                    ftui_core::text_width::grapheme_width(&tee.to_string()),
                    1,
                    "tee glyph {tee} must have display width 1"
                );
            }
            if set != BorderSet::ASCII {
                for (i, a) in tees.iter().enumerate() {
                    for (j, b) in tees.iter().enumerate() {
                        if i != j {
                            assert_ne!(a, b, "tees {i} and {j} should differ");
                        }
                    }
                }
            }
            let copied = set;
            assert_eq!(copied, set);
        }
    }

    fn arb_border_type() -> impl Strategy<Value = BorderType> {
        let ascii_char = (0x20u8..=0x7Eu8).prop_map(|b| b as char);
        let arb_custom = (
            ascii_char.clone(),
            ascii_char.clone(),
            ascii_char.clone(),
            ascii_char.clone(),
            ascii_char.clone(),
            ascii_char.clone(),
            ascii_char.clone(),
            ascii_char.clone(),
            ascii_char.clone(),
            ascii_char.clone(),
            ascii_char,
        )
            .prop_map(|(v, h, tl, tr, bl, br, tu, td, tlft, trgt, cr)| {
                BorderType::Custom(BorderSet {
                    vertical: v,
                    horizontal: h,
                    top_left: tl,
                    top_right: tr,
                    bottom_left: bl,
                    bottom_right: br,
                    tee_up: tu,
                    tee_down: td,
                    tee_left: tlft,
                    tee_right: trgt,
                    cross: cr,
                })
            });

        prop_oneof![
            Just(BorderType::Square),
            Just(BorderType::Ascii),
            Just(BorderType::Rounded),
            Just(BorderType::Double),
            Just(BorderType::Heavy),
            Just(BorderType::Dashed),
            Just(BorderType::HeavyDashed),
            arb_custom,
        ]
    }

    proptest! {
        #![proptest_config(ProptestConfig::with_cases(256))]

        #[test]
        fn prop_any_border_type_has_width_one_glyphs(bt in arb_border_type()) {
            let set = bt.to_border_set();
            let glyphs = [
                set.vertical,
                set.horizontal,
                set.top_left,
                set.top_right,
                set.bottom_left,
                set.bottom_right,
                set.tee_up,
                set.tee_down,
                set.tee_left,
                set.tee_right,
                set.cross,
            ];
            for g in glyphs {
                prop_assert_eq!(
                    ftui_core::text_width::grapheme_width(&g.to_string()),
                    1,
                    "glyph {} has display width != 1", g
                );
            }
        }
    }
}

bitflags::bitflags! {
    /// Bitflags for which borders to render.
    #[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
    pub struct Borders: u8 {
        /// No borders.
        const NONE   = 0b0000;
        /// Top border.
        const TOP    = 0b0001;
        /// Right border.
        const RIGHT  = 0b0010;
        /// Bottom border.
        const BOTTOM = 0b0100;
        /// Left border.
        const LEFT   = 0b1000;
        /// All four borders.
        const ALL    = Self::TOP.bits() | Self::RIGHT.bits() | Self::BOTTOM.bits() | Self::LEFT.bits();
    }
}