rpi-tui 0.3.24

Terminal User Interface for pi-rust
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
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
//! Overlay system for modal dialogs and selectors.
//!
//! Provides overlay components that can be shown on top of the main content.

use std::any::Any;
use std::sync::{Arc, Mutex};

use super::component::Component;
use super::tui::{OverlayAnchor, OverlayOptions, SizeValue};
use crate::ansi::{bold, dim, visible_width};

pub(crate) struct RenderedOverlay {
    pub lines: Vec<String>,
    pub width: usize,
    pub x: usize,
    pub y: usize,
}

/// Resolve geometry before rendering so wrapping uses the actual overlay
/// width. Clamp offsets and height to keep the entire overlay on screen.
pub(crate) fn render_overlay(
    component: &dyn Component,
    options: &OverlayOptions,
    width: usize,
    height: usize,
) -> Option<RenderedOverlay> {
    if width == 0
        || height == 0
        || options
            .visible
            .is_some_and(|visible| !visible(width, height))
    {
        return None;
    }
    let margin = options.margin.unwrap_or_default();
    let available_width = width.saturating_sub(margin.left.saturating_add(margin.right));
    let available_height = height.saturating_sub(margin.top.saturating_add(margin.bottom));
    if available_width == 0 || available_height == 0 {
        return None;
    }
    let size = |value: SizeValue, total: usize| match value {
        SizeValue::Absolute(value) => value,
        SizeValue::Percent(value) => (total as f64 * value).round() as usize,
    };
    let requested_width = options
        .width
        .map(|value| size(value, width))
        .unwrap_or(available_width)
        .max(options.min_width.unwrap_or(0))
        .clamp(1, available_width);
    let mut lines = component.render(requested_width);
    let overlay_width = if options.width.is_some() {
        requested_width
    } else {
        lines
            .iter()
            .map(|row| visible_width(row))
            .max()
            .unwrap_or(1)
            .max(options.min_width.unwrap_or(0))
            .clamp(1, available_width)
    };
    let max_height = options
        .max_height
        .map(|value| size(value, height))
        .unwrap_or(available_height);
    lines.truncate(max_height.min(available_height));
    if lines.is_empty() {
        return None;
    }
    let free_x = available_width - overlay_width;
    let free_y = available_height - lines.len();
    let x = margin.left
        + match options.anchor {
            OverlayAnchor::TopLeft | OverlayAnchor::LeftCenter | OverlayAnchor::BottomLeft => 0,
            OverlayAnchor::TopRight | OverlayAnchor::RightCenter | OverlayAnchor::BottomRight => {
                free_x
            }
            _ => free_x / 2,
        };
    let y = margin.top
        + match options.anchor {
            OverlayAnchor::TopLeft | OverlayAnchor::TopCenter | OverlayAnchor::TopRight => 0,
            OverlayAnchor::BottomLeft
            | OverlayAnchor::BottomCenter
            | OverlayAnchor::BottomRight => free_y,
            _ => free_y / 2,
        };
    Some(RenderedOverlay {
        lines,
        width: overlay_width,
        x: x.saturating_add_signed(options.offset_x as isize)
            .clamp(margin.left, margin.left + free_x),
        y: y.saturating_add_signed(options.offset_y as isize)
            .clamp(margin.top, margin.top + free_y),
    })
}

/// Overlay manager for managing multiple overlays.
pub struct OverlayManager {
    overlays: Arc<Mutex<Vec<OverlayEntry>>>,
    next_id: Arc<Mutex<usize>>,
}

struct OverlayEntry {
    component: Arc<dyn Component>,
    options: OverlayOptions,
    visible: bool,
    z_index: usize,
}

// Clone implementation for OverlayEntry (partial - we don't clone the component)
impl Clone for OverlayEntry {
    fn clone(&self) -> Self {
        Self {
            component: self.component.clone(),
            options: self.options.clone(),
            visible: self.visible,
            z_index: self.z_index,
        }
    }
}

impl OverlayManager {
    /// Create a new overlay manager.
    pub fn new() -> Self {
        Self {
            overlays: Arc::new(Mutex::new(Vec::new())),
            next_id: Arc::new(Mutex::new(0)),
        }
    }

    /// Add an overlay.
    pub fn add(&self, component: Arc<dyn Component>, options: OverlayOptions) -> OverlayHandle {
        let id = self
            .next_id
            .lock()
            .map(|mut next| {
                let id = *next;
                *next += 1;
                id
            })
            .unwrap_or(0);
        let entry = OverlayEntry {
            component,
            options,
            visible: true,
            z_index: id,
        };

        let handle = OverlayHandle {
            id: entry.z_index,
            manager: Arc::new(self.clone_manager()),
        };

        if let Ok(mut overlays) = self.overlays.lock() {
            overlays.push(entry);
        }

        handle
    }

    /// Remove an overlay by ID.
    pub fn remove(&self, id: usize) {
        if let Ok(mut overlays) = self.overlays.lock() {
            overlays.retain(|e| e.z_index != id);
        }
    }

    /// Set overlay visibility.
    pub fn set_visible(&self, id: usize, visible: bool) {
        if let Ok(mut overlays) = self.overlays.lock() {
            if let Some(entry) = overlays.iter_mut().find(|e| e.z_index == id) {
                entry.visible = visible;
            }
        }
    }

    /// Get visible overlays sorted by z-index.
    pub fn get_visible(&self) -> Vec<(Arc<dyn Component>, OverlayOptions)> {
        self.overlays
            .lock()
            .map(|overlays| {
                overlays
                    .iter()
                    .filter(|e| e.visible)
                    .map(|e| (e.component.clone(), e.options.clone()))
                    .collect()
            })
            .unwrap_or_default()
    }

    /// Passive panels share screen space without covering one another. Keep
    /// modal overlays in their requested position and preserve insertion order.
    pub(crate) fn render_visible(&self, width: usize, height: usize) -> Vec<RenderedOverlay> {
        let mut passive = Vec::<(usize, usize, usize, usize)>::new();
        let mut rendered = Vec::new();
        for (component, options) in self.get_visible() {
            let Some(mut overlay) = render_overlay(component.as_ref(), &options, width, height)
            else {
                continue;
            };
            if options.non_capturing {
                let margin = options.margin.unwrap_or_default();
                let first = margin.top;
                let last = height - margin.bottom - overlay.lines.len();
                let y = (first..=last)
                    .filter(|&y| {
                        passive.iter().all(|&(x, top, w, h)| {
                            overlay.x >= x + w
                                || x >= overlay.x + overlay.width
                                || y >= top + h + 1
                                || top >= y + overlay.lines.len() + 1
                        })
                    })
                    .min_by_key(|&y| y.abs_diff(overlay.y));
                let Some(y) = y else {
                    continue;
                };
                overlay.y = y;
                passive.push((overlay.x, overlay.y, overlay.width, overlay.lines.len()));
            }
            rendered.push(overlay);
        }
        rendered
    }

    /// Remove the highest z-index overlay and return whether one existed.
    pub fn remove_topmost(&self) -> bool {
        let Ok(mut overlays) = self.overlays.lock() else {
            return false;
        };
        let Some(id) = overlays.iter().map(|entry| entry.z_index).max() else {
            return false;
        };
        overlays.retain(|entry| entry.z_index != id);
        true
    }

    fn clone_manager(&self) -> Self {
        Self {
            overlays: Arc::clone(&self.overlays),
            next_id: Arc::clone(&self.next_id),
        }
    }
}

impl Clone for OverlayManager {
    fn clone(&self) -> Self {
        self.clone_manager()
    }
}

impl Default for OverlayManager {
    fn default() -> Self {
        Self::new()
    }
}

/// Handle to control an overlay.
pub struct OverlayHandle {
    id: usize,
    manager: Arc<OverlayManager>,
}

impl OverlayHandle {
    /// Hide the overlay.
    pub fn hide(&self) {
        self.manager.remove(self.id);
    }

    /// Set visibility.
    pub fn set_visible(&self, visible: bool) {
        self.manager.set_visible(self.id, visible);
    }

    /// Check if visible.
    pub fn is_visible(&self) -> bool {
        self.manager
            .overlays
            .lock()
            .map(|o| o.iter().any(|e| e.z_index == self.id && e.visible))
            .unwrap_or(false)
    }
}

/// Selector item.
#[derive(Debug, Clone)]
pub struct SelectorItem {
    pub label: String,
    pub value: String,
    pub description: Option<String>,
}

/// Selector - A component for selecting from a list of items.
pub struct Selector {
    items: Mutex<Vec<SelectorItem>>,
    selected: Mutex<usize>,
    query: Mutex<String>,
    padding_x: usize,
    max_visible: usize,
    on_select: Mutex<Option<Arc<dyn Fn(&SelectorItem) + Send + Sync>>>,
}

impl Selector {
    /// Create a new selector.
    pub fn new(items: Vec<SelectorItem>, max_visible: usize) -> Self {
        Self {
            items: Mutex::new(items),
            selected: Mutex::new(0),
            query: Mutex::new(String::new()),
            padding_x: 1,
            max_visible,
            on_select: Mutex::new(None),
        }
    }

    /// Set items.
    pub fn set_items(&self, items: Vec<SelectorItem>) {
        if let Ok(mut i) = self.items.lock() {
            *i = items;
        }
    }

    /// Get selected index.
    pub fn selected(&self) -> usize {
        self.selected.lock().map(|s| *s).unwrap_or(0)
    }

    /// Get selected item.
    pub fn selected_item(&self) -> Option<SelectorItem> {
        let items = self.items.lock().ok()?;
        let selected = self.selected.lock().ok()?;
        items.get(*selected).cloned()
    }

    /// Move selection up.
    pub fn select_up(&self) {
        if let Ok(mut selected) = self.selected.lock() {
            if *selected > 0 {
                *selected -= 1;
            }
        }
    }

    /// Move selection down.
    pub fn select_down(&self) {
        if let Ok(mut selected) = self.selected.lock() {
            let items = self.items.lock();
            if let Ok(items) = items {
                if *selected < items.len().saturating_sub(1) {
                    *selected += 1;
                }
            }
        }
    }

    /// Set filter query.
    pub fn set_query(&self, query: &str) {
        if let Ok(mut q) = self.query.lock() {
            *q = query.to_string();
        }
        // Reset selection
        if let Ok(mut selected) = self.selected.lock() {
            *selected = 0;
        }
    }

    /// Set callback for when an item is selected.
    pub fn on_select(&self, callback: Arc<dyn Fn(&SelectorItem) + Send + Sync>) {
        if let Ok(mut cb) = self.on_select.lock() {
            *cb = Some(callback);
        }
    }

    /// Confirm selection.
    pub fn confirm(&self) {
        if let Some(item) = self.selected_item() {
            if let Ok(cb) = self.on_select.lock() {
                if let Some(callback) = cb.as_ref() {
                    callback(&item);
                }
            }
        }
    }

    /// Get filtered items based on query.
    fn filtered_items(&self) -> Vec<(usize, SelectorItem)> {
        let items = self.items.lock().map(|i| i.clone()).unwrap_or_default();
        let query = self
            .query
            .lock()
            .map(|q| q.to_lowercase())
            .unwrap_or_default();

        if query.is_empty() {
            return items.into_iter().enumerate().collect();
        }

        items
            .into_iter()
            .enumerate()
            .filter(|(_, item)| {
                item.label.to_lowercase().contains(&query)
                    || item.value.to_lowercase().contains(&query)
                    || item
                        .description
                        .as_ref()
                        .map(|d| d.to_lowercase().contains(&query))
                        .unwrap_or(false)
            })
            .collect()
    }
}

impl Component for Selector {
    fn render(&self, width: usize) -> Vec<String> {
        let filtered = self.filtered_items();
        let mut lines = Vec::new();

        let selected = self.selected.lock().map(|s| *s).unwrap_or(0);
        let query = self.query.lock().map(|q| q.clone()).unwrap_or_default();

        // Search box
        let mut search_line = " ".repeat(self.padding_x);
        search_line.push_str(&bold("Search: "));
        search_line.push_str(&query);
        lines.push(search_line);
        lines.push(String::new());

        // Items
        let visible_count = self.max_visible.min(filtered.len());
        let scroll_offset = selected.saturating_sub(self.max_visible / 2);

        for (i, (_original_idx, item)) in filtered
            .iter()
            .skip(scroll_offset)
            .take(visible_count)
            .enumerate()
        {
            let is_selected = scroll_offset + i == selected;
            let mut line = " ".repeat(self.padding_x);

            if is_selected {
                line.push_str(&format!("\x1b[7m> {}\x1b[0m", item.label));
                if let Some(desc) = &item.description {
                    line.push_str(&format!(" - {}", desc));
                }
            } else {
                line.push_str(&format!("  {}", item.label));
                if let Some(desc) = &item.description {
                    line.push_str(&dim(&format!(" - {}", desc)));
                }
            }

            // Truncate to width
            if line.len() > width {
                line = line[..width].to_string();
            }

            lines.push(line);
        }

        if filtered.is_empty() {
            let mut line = " ".repeat(self.padding_x);
            line.push_str(&dim("No results found"));
            lines.push(line);
        }

        // Footer
        lines.push(String::new());
        let mut footer = " ".repeat(self.padding_x);
        footer.push_str(&dim(&format!("{} items", filtered.len())));
        footer.push_str(&dim(" | Enter: Select | Esc: Cancel"));
        lines.push(footer);

        lines
    }

    fn invalidate(&self) {
        // No cache
    }

    fn as_any(&self) -> &dyn Any {
        self
    }
}

/// Dialog - A simple message dialog.
pub struct Dialog {
    title: Mutex<String>,
    message: Mutex<String>,
    buttons: Mutex<Vec<String>>,
    selected: Mutex<usize>,
}

impl Dialog {
    /// Create a new dialog.
    pub fn new(title: impl Into<String>, message: impl Into<String>, buttons: Vec<String>) -> Self {
        Self {
            title: Mutex::new(title.into()),
            message: Mutex::new(message.into()),
            buttons: Mutex::new(buttons),
            selected: Mutex::new(0),
        }
    }

    /// Create an info dialog.
    pub fn info(message: impl Into<String>) -> Self {
        Self::new("Info", message, vec!["OK".to_string()])
    }

    /// Create a confirm dialog.
    pub fn confirm(message: impl Into<String>) -> Self {
        Self::new(
            "Confirm",
            message,
            vec!["Yes".to_string(), "No".to_string()],
        )
    }

    /// Get selected button index.
    pub fn selected(&self) -> usize {
        self.selected.lock().map(|s| *s).unwrap_or(0)
    }

    /// Move selection left.
    pub fn select_left(&self) {
        if let Ok(mut selected) = self.selected.lock() {
            if *selected > 0 {
                *selected -= 1;
            }
        }
    }

    /// Move selection right.
    pub fn select_right(&self) {
        if let Ok(mut selected) = self.selected.lock() {
            let buttons = self.buttons.lock();
            if let Ok(buttons) = buttons {
                if *selected < buttons.len().saturating_sub(1) {
                    *selected += 1;
                }
            }
        }
    }
}

impl Component for Dialog {
    fn render(&self, width: usize) -> Vec<String> {
        let title = self.title.lock().map(|t| t.clone()).unwrap_or_default();
        let message = self.message.lock().map(|m| m.clone()).unwrap_or_default();
        let buttons = self.buttons.lock().map(|b| b.clone()).unwrap_or_default();
        let selected = self.selected.lock().map(|s| *s).unwrap_or(0);

        let mut lines = Vec::new();

        // Border top
        let border_width = width.min(60);
        lines.push(format!("┌{}┐", "─".repeat(border_width.saturating_sub(2))));

        // Title
        lines.push(format!(
            "│ {} {}│",
            bold(&title),
            " ".repeat(border_width.saturating_sub(4) - title.len())
        ));

        // Separator
        lines.push(format!("├{}┤", "─".repeat(border_width.saturating_sub(2))));

        // Message
        for line in message.lines() {
            let padded = format!(
                "│ {}{}",
                line,
                " ".repeat(border_width.saturating_sub(3) - visible_width(line))
            );
            lines.push(padded);
        }

        // Separator
        lines.push(format!("├{}┤", "─".repeat(border_width.saturating_sub(2))));

        // Buttons
        let mut button_line = "│ ".to_string();
        for (i, button) in buttons.iter().enumerate() {
            if i == selected {
                button_line.push_str(&format!("[{}] ", bold(button)));
            } else {
                button_line.push_str(&format!("[{}] ", button));
            }
        }
        button_line
            .push_str(&" ".repeat(border_width.saturating_sub(3) - visible_width(&button_line)));
        button_line.push('│');
        lines.push(button_line);

        // Border bottom
        lines.push(format!("└{}┘", "─".repeat(border_width.saturating_sub(2))));

        lines
    }

    fn invalidate(&self) {
        // No cache
    }

    fn as_any(&self) -> &dyn Any {
        self
    }
}

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

    #[test]
    fn overlay_wraps_at_allocated_width_and_stays_inside_margins_after_resize() {
        let content = crate::Markdown::new("one two three four five six", 0, 0);
        let options = OverlayOptions {
            width: Some(SizeValue::Percent(0.5)),
            anchor: OverlayAnchor::BottomRight,
            offset_x: 1000,
            offset_y: 1000,
            margin: Some(super::super::tui::OverlayMargin {
                bottom: 3,
                ..Default::default()
            }),
            ..Default::default()
        };
        for width in [12, 20, 60] {
            let overlay = render_overlay(&content, &options, width, 10).unwrap();
            assert_eq!(overlay.width, width / 2);
            assert!(overlay
                .lines
                .iter()
                .all(|row| visible_width(row) <= overlay.width));
            assert!(overlay.x + overlay.width <= width);
            assert!(overlay.y + overlay.lines.len() <= 7);
            if width == 20 {
                assert!(
                    overlay.lines.len() > 1,
                    "wrap instead of clipping a full-width line"
                );
            }
        }
        let options = OverlayOptions {
            offset_x: -1000,
            offset_y: -1000,
            ..options
        };
        let overlay = render_overlay(&content, &options, 20, 10).unwrap();
        assert_eq!((overlay.x, overlay.y), (0, 0));
        assert!(render_overlay(&content, &options, 20, 3).is_none());
    }

    #[test]
    fn passive_panels_avoid_each_other_and_reappear_when_space_returns() {
        let manager = OverlayManager::new();
        let options = OverlayOptions {
            anchor: OverlayAnchor::BottomRight,
            width: Some(SizeValue::Absolute(12)),
            non_capturing: true,
            ..Default::default()
        };
        let _a = manager.add(
            Arc::new(crate::Text::new("first\nsecond", 0, 0)),
            options.clone(),
        );
        let _b = manager.add(
            Arc::new(crate::Text::new("other\nlast", 0, 0)),
            options.clone(),
        );
        let rendered = manager.render_visible(40, 8);
        assert_eq!(rendered.len(), 2);
        assert_eq!(rendered[0].y, 6);
        assert_eq!(rendered[1].y, 3);
        assert_eq!(manager.render_visible(40, 4).len(), 1);
        assert_eq!(manager.render_visible(40, 8).len(), 2);
        // Capturing modal overlays intentionally paint above the passive panels.
        let _modal = manager.add(
            Arc::new(crate::Text::new("dialog", 0, 0)),
            OverlayOptions {
                non_capturing: false,
                ..options
            },
        );
        assert_eq!(manager.render_visible(40, 8).last().unwrap().y, 7);
    }

    #[test]
    fn test_selector() {
        let items = vec![
            SelectorItem {
                label: "Item 1".into(),
                value: "1".into(),
                description: None,
            },
            SelectorItem {
                label: "Item 2".into(),
                value: "2".into(),
                description: None,
            },
        ];
        let selector = Selector::new(items, 5);
        assert_eq!(selector.selected(), 0);
        selector.select_down();
        assert_eq!(selector.selected(), 1);
    }

    #[test]
    fn test_dialog() {
        let dialog = Dialog::info("Hello, World!");
        let lines = dialog.render(40);
        assert!(!lines.is_empty());
    }
}