oxi-tui 0.3.1

Terminal UI framework with differential rendering, themes, and components
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
//! TUI - Main Terminal UI framework.
//!
//! This module provides the core TUI struct and event loop for building
//! terminal-based user interfaces with differential rendering.

use crate::{
    cell::Cell,
    component::Component,
    event::{
        KeyCode, KeyEvent, KeyModifiers, MouseButton, MouseEvent, MouseEventKind, ResizeEvent,
    },
    overlay::{OverlayBox, OverlayContent, OverlayHandle, OverlayOptions},
    renderer::Renderer,
    surface::Surface,
    terminal::{CrosstermTerminal, Size, Terminal},
};
use anyhow::Result;
use std::io::{self, stdout, Write};

/// Rendering strategy based on change type.
enum RenderStrategy {
    /// Full redraw needed (first render, width change, or large changes).
    Full,
    /// Incremental update (only dirty lines).
    Incremental,
}

/// Main TUI struct - the entry point for building terminal UIs.
pub struct TUI {
    /// The terminal backend.
    terminal: Box<dyn Terminal>,
    /// Child components in z-order (0 = bottom).
    children: Vec<Box<dyn Component>>,
    /// Currently focused component index.
    focus_index: usize,
    /// Overlay stack.
    overlay_stack: Vec<OverlayHandleWrapper>,
    /// Whether a render is needed.
    dirty: bool,
    /// Previous surface for diff comparison.
    prev_surface: Option<Surface>,
    /// Renderer instance.
    renderer: Renderer,
    /// Surface size tracking.
    last_width: u16,
    last_height: u16,
    /// Running state.
    running: bool,
    /// Event handle callback.
    event_handler: Option<Box<dyn FnMut(crate::Event) + Send>>,
}

struct OverlayHandleWrapper {
    handle: Box<dyn OverlayHandle>,
    content: Box<dyn Component>,
}

impl TUI {
    /// Create a new TUI instance with a default terminal.
    pub fn new(mut terminal: impl Terminal + 'static) -> Self {
        let size = terminal.size().unwrap_or(Size {
            width: 80,
            height: 24,
        });
        Self {
            terminal: Box::new(terminal),
            children: Vec::new(),
            focus_index: 0,
            overlay_stack: Vec::new(),
            dirty: true,
            prev_surface: None,
            renderer: Renderer::new(),
            last_width: size.width,
            last_height: size.height,
            running: false,
            event_handler: None,
        }
    }

    /// Create with crossterm backend (convenience constructor).
    pub fn with_crossterm() -> Result<Self> {
        let terminal = CrosstermTerminal::new()?;
        Ok(Self::new(terminal))
    }

    /// Add a child component.
    pub fn add_child(&mut self, component: impl Component + 'static) -> usize {
        let index = self.children.len();
        self.children.push(Box::new(component));
        self.request_render();
        index
    }

    /// Remove a child component by index.
    pub fn remove_child(&mut self, index: usize) {
        if index < self.children.len() {
            self.children.remove(index);
            if self.focus_index >= self.children.len() && !self.children.is_empty() {
                self.focus_index = self.children.len() - 1;
            }
            self.request_render();
        }
    }

    /// Set focus to a component by index.
    pub fn set_focus(&mut self, index: usize) {
        if index < self.children.len() {
            // Unfocus previous
            if self.focus_index < self.children.len() {
                if let Some(child) = self.children.get_mut(self.focus_index) {
                    child.unfocus();
                }
            }
            self.focus_index = index;
            // Focus new
            if let Some(child) = self.children.get_mut(index) {
                child.focus();
            }
            self.request_render();
        }
    }

    /// Get current focus index.
    pub fn focus_index(&self) -> usize {
        self.focus_index
    }

    /// Get number of children.
    pub fn children_count(&self) -> usize {
        self.children.len()
    }

    /// Add an overlay.
    pub fn add_overlay<T: OverlayContent + 'static>(
        &mut self,
        content: T,
        options: OverlayOptions,
    ) -> usize {
        let id = self.overlay_stack.len();
        let mut boxed: Box<OverlayBox<T>> = Box::new(OverlayBox::new(content, options));
        boxed.set_id(id);

        // Get the content box to wrap - we need to keep the overlay box alive
        // while also using it as a Component
        let content_ptr = boxed.as_mut() as *mut OverlayBox<T> as *mut dyn Component;

        self.overlay_stack.push(OverlayHandleWrapper {
            handle: boxed,
            content: unsafe { Box::from_raw(content_ptr) },
        });
        self.request_render();
        id
    }

    /// Remove an overlay by index.
    pub fn remove_overlay(&mut self, id: usize) {
        if id < self.overlay_stack.len() {
            self.overlay_stack.remove(id);
            self.request_render();
        }
    }

    /// Remove all overlays.
    pub fn clear_overlays(&mut self) {
        self.overlay_stack.clear();
        self.request_render();
    }

    /// Mark the TUI as needing a render.
    pub fn request_render(&mut self) {
        self.dirty = true;
    }

    /// Set an event handler callback.
    pub fn on_event(&mut self, handler: impl FnMut(crate::Event) + Send + 'static) {
        self.event_handler = Some(Box::new(handler));
    }

    /// Start the TUI event loop.
    ///
    /// This enters alternate screen mode and runs until `stop()` is called.
    pub fn start(&mut self) -> Result<()> {
        if self.running {
            return Ok(());
        }
        self.running = true;

        // Enter alternate screen
        crossterm::execute!(stdout(), crossterm::terminal::EnterAlternateScreen)?;
        crossterm::execute!(stdout(), crossterm::cursor::Hide)?;

        // Enable mouse reporting
        crossterm::execute!(stdout(), crossterm::event::EnableMouseCapture)?;

        // Initial render
        self.render()?;

        // Main event loop
        while self.running {
            // Poll for events with a timeout
            if let Some(event) = self.poll_event(std::time::Duration::from_millis(16)) {
                self.handle_event(event);
            }

            // Render if dirty
            if self.dirty {
                self.render()?;
            }
        }

        // Cleanup
        self.cleanup()?;

        Ok(())
    }

    /// Stop the TUI event loop.
    pub fn stop(&mut self) {
        self.running = false;
    }

    /// Check if TUI is running.
    pub fn is_running(&self) -> bool {
        self.running
    }

    /// Poll for a single event (non-blocking with timeout).
    fn poll_event(&self, timeout: std::time::Duration) -> Option<crate::Event> {
        if crossterm::event::poll(timeout).ok()? {
            crossterm::event::read().ok().map(Self::convert_event)
        } else {
            None
        }
    }

    /// Convert crossterm events to our Event type.
    fn convert_event(event: crossterm::event::Event) -> crate::Event {
        match event {
            crossterm::event::Event::Key(key) => {
                let code = match key.code {
                    crossterm::event::KeyCode::Enter => KeyCode::Enter,
                    crossterm::event::KeyCode::Esc => KeyCode::Escape,
                    crossterm::event::KeyCode::Tab => KeyCode::Tab,
                    crossterm::event::KeyCode::Backspace => KeyCode::Backspace,
                    crossterm::event::KeyCode::Delete => KeyCode::Delete,
                    crossterm::event::KeyCode::Up => KeyCode::Up,
                    crossterm::event::KeyCode::Down => KeyCode::Down,
                    crossterm::event::KeyCode::Left => KeyCode::Left,
                    crossterm::event::KeyCode::Right => KeyCode::Right,
                    crossterm::event::KeyCode::Home => KeyCode::Home,
                    crossterm::event::KeyCode::End => KeyCode::End,
                    crossterm::event::KeyCode::PageUp => KeyCode::PageUp,
                    crossterm::event::KeyCode::PageDown => KeyCode::PageDown,
                    crossterm::event::KeyCode::Insert => KeyCode::Insert,
                    crossterm::event::KeyCode::F(n) => KeyCode::F(n),
                    crossterm::event::KeyCode::Char(c) => KeyCode::Char(c),
                    _ => KeyCode::Enter, // Handle unknown keys
                };

                let modifiers = KeyModifiers {
                    shift: key
                        .modifiers
                        .contains(crossterm::event::KeyModifiers::SHIFT),
                    ctrl: key
                        .modifiers
                        .contains(crossterm::event::KeyModifiers::CONTROL),
                    alt: key.modifiers.contains(crossterm::event::KeyModifiers::ALT),
                    meta: key.modifiers.contains(crossterm::event::KeyModifiers::META),
                };

                crate::Event::Key(KeyEvent::with_modifiers(code, modifiers))
            }
            crossterm::event::Event::Mouse(mouse) => {
                let kind = match mouse.kind {
                    crossterm::event::MouseEventKind::Moved => MouseEventKind::Drag,
                    crossterm::event::MouseEventKind::Drag(_) => MouseEventKind::Drag,
                    crossterm::event::MouseEventKind::ScrollDown => MouseEventKind::ScrollDown,
                    crossterm::event::MouseEventKind::ScrollUp => MouseEventKind::ScrollUp,
                    _ => MouseEventKind::Click,
                };

                let button = if mouse
                    .modifiers
                    .contains(crossterm::event::KeyModifiers::CONTROL)
                {
                    MouseButton::Right
                } else if mouse
                    .modifiers
                    .contains(crossterm::event::KeyModifiers::ALT)
                {
                    MouseButton::Middle
                } else {
                    MouseButton::Left
                };

                crate::Event::Mouse(MouseEvent {
                    kind,
                    button,
                    row: mouse.row,
                    col: mouse.column,
                })
            }
            crossterm::event::Event::Resize(cols, rows) => crate::Event::Resize(ResizeEvent {
                width: cols,
                height: rows,
            }),
            crossterm::event::Event::FocusGained => crate::Event::FocusGained,
            crossterm::event::Event::FocusLost => crate::Event::FocusLost,
            _ => crate::Event::None,
        }
    }

    /// Handle an input event.
    fn handle_event(&mut self, event: crate::Event) {
        // Handle overlay events first (for modals)
        if let Some(top) = self.overlay_stack.last_mut() {
            if top.handle.is_hidden() {
                return;
            }
            // Try overlay first
            if top.content.handle_event(&event) {
                self.request_render();
                return;
            }
        }

        // Check Escape for closing overlays
        if let crate::Event::Key(ref key) = event {
            if key.code == KeyCode::Escape && !self.overlay_stack.is_empty() {
                self.overlay_stack.pop();
                self.request_render();
                return;
            }
        }

        // Pass to focused component
        if self.focus_index < self.children.len() {
            if self.children[self.focus_index].handle_event(&event) {
                self.request_render();
                return;
            }
        }

        // Global key handling
        if let crate::Event::Key(key) = &event {
            match key.code {
                // Tab cycles focus
                KeyCode::Tab => {
                    if self.children.len() > 1 {
                        let next = if key.modifiers.shift {
                            self.focus_index.saturating_sub(1)
                        } else {
                            (self.focus_index + 1) % self.children.len()
                        };
                        self.set_focus(next);
                    }
                }
                // Ctrl+C exits
                KeyCode::Char('c') if key.modifiers.ctrl => {
                    self.stop();
                }
                _ => {}
            }
        }

        // Call event handler if set
        if let Some(ref mut handler) = self.event_handler {
            handler(event);
        }
    }

    /// Render the current state.
    fn render(&mut self) -> Result<()> {
        let size = self.terminal.size()?;

        // Determine render strategy
        let strategy = self.determine_render_strategy(size);

        // Create surface for this frame
        let mut surface = Surface::new(size.width, size.height);

        // Clear to spaces
        let empty_cell = Cell::new(' ');
        surface.fill(empty_cell);

        // Render children
        let area = surface.area();
        for child in &mut self.children {
            child.render(&mut surface, area);
        }

        // Render overlays (on top)
        for overlay in &mut self.overlay_stack {
            if !overlay.handle.is_hidden() {
                overlay.content.render(&mut surface, area);
            }
        }

        // Execute render based on strategy
        match strategy {
            RenderStrategy::Full => {
                self.renderer.begin_sync();
                self.renderer.clear_screen();
                for row in 0..size.height {
                    for col in 0..size.width {
                        if let Some(cell) = surface.get(row, col) {
                            self.renderer.render_cell(row, col, cell);
                        }
                    }
                }
                self.renderer.end_sync()?;
            }
            RenderStrategy::Incremental => {
                self.renderer.begin_sync();
                if let (Some(first), Some(last)) = (surface.first_dirty(), surface.last_dirty()) {
                    self.renderer.render_changed_lines(
                        &surface,
                        first,
                        last.min(size.height - 1),
                    )?;
                }
                self.renderer.end_sync()?;
            }
        }

        // Clear dirty state
        self.dirty = false;
        surface.clear_dirty();

        // Store for next diff
        self.prev_surface = Some(surface);

        // Hide cursor at end
        print!("\x1b[?25l");
        io::stdout().flush()?;

        Ok(())
    }

    /// Determine which rendering strategy to use.
    fn determine_render_strategy(&mut self, size: Size) -> RenderStrategy {
        // First render - full
        if self.prev_surface.is_none() {
            self.last_width = size.width;
            self.last_height = size.height;
            return RenderStrategy::Full;
        }

        // Width changed - full
        if size.width != self.last_width {
            self.last_width = size.width;
            self.last_height = size.height;
            return RenderStrategy::Full;
        }

        // Check if changes are above viewport (large scroll)
        // For now, always use incremental if there's a previous surface
        if let Some(ref prev) = self.prev_surface {
            if let (Some(_first), Some(last)) = (prev.first_dirty(), prev.last_dirty()) {
                // If change is in upper quarter of screen, full render
                if last > size.height / 4 * 3 {
                    return RenderStrategy::Full;
                }
            }
        }

        // Default to incremental
        RenderStrategy::Incremental
    }

    /// Cleanup on exit.
    fn cleanup(&mut self) -> Result<()> {
        // Show cursor
        crossterm::execute!(stdout(), crossterm::cursor::Show)?;

        // Disable mouse capture
        crossterm::execute!(stdout(), crossterm::event::DisableMouseCapture)?;

        // Leave alternate screen
        crossterm::execute!(stdout(), crossterm::terminal::LeaveAlternateScreen)?;

        // Flush output
        io::stdout().flush()?;

        Ok(())
    }

    /// Force a full redraw on next frame.
    pub fn force_redraw(&mut self) {
        if let Some(ref mut surf) = self.prev_surface {
            surf.mark_all_dirty();
        }
        self.dirty = true;
    }

    /// Get the current terminal size.
    pub fn size(&mut self) -> Result<Size> {
        self.terminal.size()
    }
}

impl Drop for TUI {
    fn drop(&mut self) {
        if self.running {
            // Ensure cleanup happens
            let _ = self.cleanup();
        }
    }
}