From 89ad69e46c11f4c1b76a5183bb15cf99a9fe3c93 Mon Sep 17 00:00:00 2001 From: Erik Kundt Date: Mon, 4 Jul 2022 12:44:06 +0200 Subject: [PATCH] tui: Add basic framework Signed-off-by: Erik Kundt --- radicle-tui/Cargo.toml | 21 ++++ radicle-tui/src/lib.rs | 88 ++++++++++++++++ radicle-tui/src/main.rs | 58 +++++++++++ radicle-tui/src/ui.rs | 46 +++++++++ radicle-tui/src/ui/components.rs | 166 +++++++++++++++++++++++++++++++ radicle-tui/src/ui/layout.rs | 49 +++++++++ radicle-tui/src/ui/theme.rs | 49 +++++++++ radicle-tui/src/ui/widget.rs | 80 +++++++++++++++ 8 files changed, 557 insertions(+) create mode 100644 radicle-tui/Cargo.toml create mode 100644 radicle-tui/src/lib.rs create mode 100644 radicle-tui/src/main.rs create mode 100644 radicle-tui/src/ui.rs create mode 100644 radicle-tui/src/ui/components.rs create mode 100644 radicle-tui/src/ui/layout.rs create mode 100644 radicle-tui/src/ui/theme.rs create mode 100644 radicle-tui/src/ui/widget.rs diff --git a/radicle-tui/Cargo.toml b/radicle-tui/Cargo.toml new file mode 100644 index 00000000..194fca3b --- /dev/null +++ b/radicle-tui/Cargo.toml @@ -0,0 +1,21 @@ +[package] +name = "radicle-tui" +license = "MIT OR Apache-2.0" +version = "0.1.0" +authors = ["Erik Kundt "] +edition = "2021" +build = "../build.rs" + +[[bin]] +name = "radicle-tui" +path = "src/main.rs" + +[dependencies] +anyhow = { version = "1" } +lexopt = { version = "0.2" } +tuirealm = { version = "1.8.0", default-features = false, features = [ "with-termion" ] } +tui-realm-stdlib = { version = "1.2.0", default-features = false, features = [ "with-termion" ] } + +[dependencies.radicle-term] +version = "0" +path = "../radicle-term" diff --git a/radicle-tui/src/lib.rs b/radicle-tui/src/lib.rs new file mode 100644 index 00000000..36ea0ff0 --- /dev/null +++ b/radicle-tui/src/lib.rs @@ -0,0 +1,88 @@ +use std::hash::Hash; +use std::time::Duration; + +use anyhow::Result; + +use tuirealm::terminal::TerminalBridge; +use tuirealm::Frame; +use tuirealm::{Application, EventListenerCfg, NoUserEvent}; + +mod ui; + +/// Trait that must be implemented by client applications in order to be run +/// as tui-application using tui-realm. Implementors act as models to the +/// tui-realm application that can be polled for new messages, updated +/// accordingly and rendered with new state. +/// +/// Please see `examples/` for further information on how to use it. +pub trait Tui +where + Id: Eq + PartialEq + Clone + Hash, + Message: Eq, +{ + /// Should initialize an application by mounting and activating components. + fn init(&mut self, app: &mut Application) -> Result<()>; + + /// Should update the current state by handling a message from the view. + fn update(&mut self, app: &mut Application, interval: u64); + + /// Should draw the application to a frame. + fn view(&mut self, app: &mut Application, frame: &mut Frame); + + /// Should return true if the application is requested to quit. + fn quit(&self) -> bool; +} + +/// A tui-window using the cross-platform Terminal helper provided +/// by tui-realm. +pub struct Window { + /// Helper around `Terminal` to quickly setup and perform on terminal. + pub terminal: TerminalBridge, +} + +impl Default for Window { + fn default() -> Self { + Self::new() + } +} + +/// Provides a way to create and run a new tui-application. +impl Window { + /// Creates a tui-window using the default cross-platform Terminal + /// helper and panics if its creation fails. + pub fn new() -> Self { + Self { + terminal: TerminalBridge::new().expect("Cannot create terminal bridge"), + } + } + + /// Runs this tui-window with the tui-application given and performs the + /// following steps: + /// 1. Enter alternative terminal screen + /// 2. Run main loop until application should quit and with each iteration + /// - poll new events (tick or user event) + /// - update application state + /// - redraw view + /// 3. Leave alternative terminal screen + pub fn run(&mut self, tui: &mut T, interval: u64) -> Result<()> + where + T: Tui, + Id: Eq + PartialEq + Clone + Hash, + Message: Eq, + { + let mut app = Application::init( + EventListenerCfg::default().default_input_listener(Duration::from_millis(interval)), + ); + tui.init(&mut app)?; + + while !tui.quit() { + tui.update(&mut app, interval); + + self.terminal.raw_mut().draw(|frame| { + tui.view(&mut app, frame); + })?; + } + + Ok(()) + } +} diff --git a/radicle-tui/src/main.rs b/radicle-tui/src/main.rs new file mode 100644 index 00000000..4e548250 --- /dev/null +++ b/radicle-tui/src/main.rs @@ -0,0 +1,58 @@ +use std::process; + +use radicle_term as term; + +pub const NAME: &str = "radicle-tui"; +pub const VERSION: &str = env!("CARGO_PKG_VERSION"); +pub const GIT_HEAD: &str = env!("GIT_HEAD"); +pub const FPS: u64 = 60; + +pub const HELP: &str = r#" +Usage + + radicle-tui [