dwfv 0.5.0

A simple digital waveform viewer with vi-like key bindings
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

// SPDX-License-Identifier: MIT
use super::app::App;
use crate::signaldb::AsyncSignalDB;
use std::error::Error;
use std::io;
use std::path::Path;
use termion::input::MouseTerminal;
use termion::raw::{IntoRawMode, RawTerminal};
use tui::Terminal;
use tui::backend::TermionBackend;

/// Digital Waveform Viewer Text User Interface
pub struct Tui {
    term: Terminal<TermionBackend<MouseTerminal<RawTerminal<io::Stdout>>>>,
    app: App,
}

impl Tui {
    /// Create a new `Tui`.
    ///
    /// # Example
    ///
    /// ```
    /// use dwfv::signaldb::AsyncSignalDB;
    /// use dwfv::tui::Tui;
    /// let tui = Tui::new(AsyncSignalDB::new());
    /// ```
    pub fn new(signaldb: AsyncSignalDB) -> Result<Tui, Box<dyn Error>> {
        let stdout = MouseTerminal::from(io::stdout().into_raw_mode()?);
        let backend = TermionBackend::new(stdout);
        let term = Terminal::new(backend)?;
        Ok(Tui {
            term,
            app: App::new(signaldb),
        })
    }

    fn render(&mut self) -> Result<(), Box<dyn Error>> {
        let term = &mut self.term;
        let app = &mut self.app;
        term.draw(|f| app.render(f))?;
        Ok(())
    }

    pub fn run(&mut self) -> Result<(), Box<dyn Error>> {
        self.term.clear()?;
        loop {
            self.term.hide_cursor()?;
            self.render()?;
            if self.app.update() {
                break;
            }
        }
        self.term.clear()?;
        Ok(())
    }

    pub fn update_layout<P: AsRef<Path>>(&mut self, path: P) -> Result<(), Box<dyn Error>> {
        self.app.update_layout(path)
    }
}