docs: simplify tui-big-text examples

Author: joshka

tui-big-text/Cargo.toml

@@ -19,9 +19,10 @@ itertools.workspace = true
 ratatui.workspace = true
 
 [dev-dependencies]
-anyhow.workspace = true
+color-eyre.workspace = true
 crossterm = { workspace = true, features = ["event-stream"] }
 futures.workspace = true
 indoc.workspace = true
+ratatui = { workspace = true, features = ["crossterm"] }
 strum.workspace = true
 tokio = { workspace = true, features = ["full"] }

tui-big-text/examples/alignment.rs

@@ -1,28 +1,24 @@
-use std::{io::stdout, thread::sleep, time::Duration};
-
-use anyhow::Result;
-use crossterm::{
-    terminal::{disable_raw_mode, enable_raw_mode, EnterAlternateScreen, LeaveAlternateScreen},
-    ExecutableCommand,
+use color_eyre::Result;
+use ratatui::{
+    layout::Offset,
+    prelude::{Alignment, Frame, Stylize},
+    text::Line,
 };
-use ratatui::prelude::*;
 use tui_big_text::{BigText, PixelSize};
 
+mod common;
+
 fn main() -> Result<()> {
-    stdout().execute(EnterAlternateScreen)?;
-    enable_raw_mode()?;
-    let backend = CrosstermBackend::new(stdout());
-    let mut terminal = Terminal::new(backend)?;
-    terminal.clear()?;
-    terminal.draw(|frame| render(frame).expect("failed to render"))?;
-    sleep(Duration::from_secs(5));
-    terminal.clear()?;
-    stdout().execute(LeaveAlternateScreen)?;
-    disable_raw_mode()?;
+    color_eyre::install()?;
+    common::run(render)?;
     Ok(())
 }
 
 fn render(frame: &mut Frame) -> Result<()> {
+    let title = Line::from("tui-big-text alignment demo. Press 'q' to quit")
+        .cyan()
+        .centered();
+
     let left = BigText::builder()
         .pixel_size(PixelSize::Quadrant)
         .alignment(Alignment::Left)
@@ -41,12 +37,13 @@ fn render(frame: &mut Frame) -> Result<()> {
         .lines(vec!["Centered".red().into()])
         .build()?;
 
-    use Constraint::*;
-    let [top, middle, bottom] = Layout::vertical([Length(4); 3]).areas(frame.size());
+    let area = frame.size();
+    frame.render_widget(title, area);
 
-    frame.render_widget(left, top);
-    frame.render_widget(right, middle);
-    frame.render_widget(centered, bottom);
+    let area = area.offset(Offset { x: 0, y: 2 }).intersection(area);
+    frame.render_widget(left, area);
+    frame.render_widget(right, area);
+    frame.render_widget(centered, area);
 
     Ok(())
 }

tui-big-text/examples/alignment.tape

@@ -10,3 +10,5 @@ Sleep 2s
 Show
 Screenshot "target/alignment.png"
 Sleep 1s
+Hide
+Escape

tui-big-text/examples/big_text.rs

@@ -0,0 +1,35 @@
+use color_eyre::Result;
+use ratatui::{
+    layout::Offset,
+    prelude::{Frame, Style, Stylize},
+    text::Line,
+};
+use tui_big_text::BigText;
+
+mod common;
+
+fn main() -> Result<()> {
+    color_eyre::install()?;
+    common::run(render)?;
+    Ok(())
+}
+
+fn render(frame: &mut Frame) -> Result<()> {
+    let title = Line::from("tui-big-text Demo. Press 'q' to quit").cyan();
+
+    let big_text = BigText::builder()
+        .style(Style::new().blue())
+        .lines(vec![
+            "Tui-".red().into(),
+            "big-".white().into(),
+            "text".into(),
+        ])
+        .build()?;
+
+    let area = frame.size();
+    frame.render_widget(title, area);
+
+    let area = area.offset(Offset { x: 0, y: 2 }).intersection(area);
+    frame.render_widget(big_text, area);
+    Ok(())
+}

tui-big-text/examples/demo.tape tui-big-text/examples/big_text.tape

@@ -1,12 +1,14 @@
 # VHS Tape (see https://github.com/charmbracelet/vhs)
-Output "target/demo.gif"
+Output "target/big_text.gif"
 Set Theme "Aardvark Blue"
 Set Width 600
 Set Height 800
 Hide
-Type@0 "cargo run --example demo --quiet"
+Type@0 "cargo run --example big_text --quiet"
 Enter
 Sleep 2s
 Show
-Screenshot "target/demo.png"
+Screenshot "target/big_text.png"
 Sleep 1s
+Hide
+Escape

tui-big-text/examples/common/mod.rs

@@ -0,0 +1,74 @@
+//! common module for examples
+
+use std::io;
+
+use color_eyre::Result;
+use crossterm::{
+    terminal::{disable_raw_mode, enable_raw_mode, EnterAlternateScreen, LeaveAlternateScreen},
+    ExecutableCommand,
+};
+use ratatui::prelude::CrosstermBackend;
+
+/// A type alias for the terminal
+type Terminal = ratatui::Terminal<CrosstermBackend<io::Stdout>>;
+
+/// A generic main loop for a TUI example that just renders the given function and exits when the
+/// user presses 'q' or 'Esc'
+pub fn run<F>(render: F) -> Result<()>
+where
+    F: Fn(&mut ratatui::Frame) -> Result<()>,
+{
+    install_panic_handler();
+
+    with_terminal(|mut terminal| loop {
+        terminal.draw(|frame| render(frame).expect("failed to render"))?;
+        if let crossterm::event::Event::Key(event) = crossterm::event::read()? {
+            if matches!(
+                event.code,
+                crossterm::event::KeyCode::Char('q') | crossterm::event::KeyCode::Esc
+            ) {
+                break Ok(());
+            }
+        }
+    })
+}
+
+/// Install a panic handler that restores the terminal before panicking
+fn install_panic_handler() {
+    let hook = std::panic::take_hook();
+    std::panic::set_hook(Box::new(move |panic_info| {
+        if let Err(err) = restore() {
+            eprintln!("failed to restore terminal: {}", err);
+        }
+        hook(panic_info);
+    }));
+}
+
+/// Run a function with a terminal ensuring that the terminal is restored afterwards
+fn with_terminal<F>(f: F) -> color_eyre::Result<()>
+where
+    F: FnOnce(Terminal) -> color_eyre::Result<()>,
+{
+    let terminal = init()?;
+    let result = f(terminal);
+    restore()?;
+    result?;
+    Ok(())
+}
+
+/// Initialize a terminal
+fn init() -> io::Result<Terminal> {
+    io::stdout().execute(EnterAlternateScreen)?;
+    enable_raw_mode()?;
+    let backend = CrosstermBackend::new(io::stdout());
+    let mut terminal = Terminal::new(backend)?;
+    terminal.clear()?;
+    Ok(terminal)
+}
+
+/// Restore the terminal to its original state
+fn restore() -> io::Result<()> {
+    io::stdout().execute(LeaveAlternateScreen)?;
+    disable_raw_mode()?;
+    Ok(())
+}

tui-big-text/examples/demo.rs

@@ -1,28 +1,20 @@
-use std::{io::stdout, thread::sleep, time::Duration};
-
-use anyhow::Result;
-use crossterm::{
-    terminal::{disable_raw_mode, enable_raw_mode, EnterAlternateScreen, LeaveAlternateScreen},
-    ExecutableCommand,
-};
+use color_eyre::Result;
 use ratatui::prelude::*;
 use tui_big_text::{BigText, PixelSize};
 
+mod common;
+
 fn main() -> Result<()> {
-    stdout().execute(EnterAlternateScreen)?;
-    enable_raw_mode()?;
-    let backend = CrosstermBackend::new(stdout());
-    let mut terminal = Terminal::new(backend)?;
-    terminal.clear()?;
-    terminal.draw(|frame| render(frame).expect("failed to render"))?;
-    sleep(Duration::from_secs(5));
-    terminal.clear()?;
-    stdout().execute(LeaveAlternateScreen)?;
-    disable_raw_mode()?;
+    color_eyre::install()?;
+    common::run(render)?;
     Ok(())
 }
 
 fn render(frame: &mut Frame) -> Result<()> {
+    let title = Line::from("tui-big-text pixel size demo. Press 'q' to quit")
+        .centered()
+        .cyan();
+
     let full_size_text = BigText::builder()
         .pixel_size(PixelSize::Full)
         .lines(vec!["FullSize".white().into()])
@@ -53,13 +45,15 @@ fn render(frame: &mut Frame) -> Result<()> {
         .lines(vec!["Sextant".cyan().into(), " 1/2*1/3".cyan().into()])
         .build()?;
 
-    // Setup layout for 6 blocks
+    // Setup layout for the title and 6 blocks
     use Constraint::*;
-    let [full, half_height, middle, bottom] =
-        Layout::vertical([Length(8), Length(4), Length(8), Length(6)]).areas(frame.size());
+    let [top, full, half_height, middle, bottom] =
+        Layout::vertical([Length(2), Length(8), Length(4), Length(8), Length(6)])
+            .areas(frame.size());
     let [half_wide, quadrant] = Layout::horizontal([Length(32), Length(32)]).areas(middle);
     let [third_height, sextant] = Layout::horizontal([Length(32), Length(32)]).areas(bottom);
 
+    frame.render_widget(title, top);
     frame.render_widget(full_size_text, full);
     frame.render_widget(half_height_text, half_height);
     frame.render_widget(half_wide_text, half_wide);

tui-big-text/examples/pixel_size.rs

@@ -10,3 +10,5 @@ Sleep 2s
 Show
 Screenshot "target/pixel_size.png"
 Sleep 1s
+Hide
+Escape

tui-big-text/examples/pixel_size.tape

@@ -3,7 +3,10 @@ use std::{
     time::{Duration, Instant},
 };
 
-use anyhow::{bail, Context, Result};
+use color_eyre::{
+    eyre::{bail, Context},
+    Result,
+};
 use crossterm::{
     event::{self, KeyCode},
     execute,
@@ -308,17 +311,17 @@ struct Tui {
 impl Tui {
     fn init() -> Result<Tui> {
         let mut stdout = io::stdout();
-        execute!(stdout, EnterAlternateScreen).context("failed to enter alternate screen")?;
+        execute!(stdout, EnterAlternateScreen).wrap_err("failed to enter alternate screen")?;
         let backend = CrosstermBackend::new(stdout);
-        let mut terminal = Terminal::new(backend).context("failed to create terminal")?;
-        enable_raw_mode().context("failed to enable raw mode")?;
-        terminal.hide_cursor().context("failed to hide cursor")?;
-        terminal.clear().context("failed to clear console")?;
+        let mut terminal = Terminal::new(backend).wrap_err("failed to create terminal")?;
+        enable_raw_mode().wrap_err("failed to enable raw mode")?;
+        terminal.hide_cursor().wrap_err("failed to hide cursor")?;
+        terminal.clear().wrap_err("failed to clear console")?;
         Ok(Self { terminal })
     }
 
     fn draw(&mut self, frame: impl FnOnce(&mut Frame)) -> Result<()> {
-        self.terminal.draw(frame).context("failed to draw frame")?;
+        self.terminal.draw(frame).wrap_err("failed to draw frame")?;
         Ok(())
     }
 }