bashers 0.8.8

Installable cli helpers
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

use anyhow::Result;
use crossterm::event::{self as crossterm_event, DisableMouseCapture, EnableMouseCapture, Event};
use crossterm::ExecutableCommand;
use ratatui::layout::Rect;
use ratatui::{DefaultTerminal, Frame};
use std::time::Duration;

pub trait TuiApp {
    fn update_layout(&mut self, term_size: Rect, available_height: u16);
    fn render(&self, frame: &mut Frame);
    fn poll_interval(&self) -> Duration;
    fn process_background(&mut self);
    fn handle_event(&mut self, event: Event) -> Result<bool>;
}

pub fn run<T: TuiApp>(mut app: T) -> Result<()> {
    let mut terminal = ratatui::init();
    std::io::stdout().execute(EnableMouseCapture)?;
    let result = run_loop(&mut terminal, &mut app);
    teardown();
    result
}

pub(crate) fn teardown() {
    let _ = std::io::stdout().execute(DisableMouseCapture);
    ratatui::restore();
}

fn run_loop<T: TuiApp>(terminal: &mut DefaultTerminal, app: &mut T) -> Result<()> {
    loop {
        app.process_background();
        let term_size = terminal.size()?;
        let available_height = term_size.height.saturating_sub(1);
        app.update_layout(term_size.into(), available_height);
        terminal.draw(|frame| app.render(frame))?;
        if crossterm_event::poll(app.poll_interval())?
            && app.handle_event(crossterm_event::read()?)?
        {
            break;
        }
    }
    Ok(())
}

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

    #[test]
    fn test_teardown_disables_mouse_capture() {
        teardown();
    }
}