fader_master/tui/src/lib.rs

191 lines
5.5 KiB
Rust

//! Terminal user interface for fader_master.
use std::io;
use ratatui::{
DefaultTerminal, Frame,
buffer::Buffer,
crossterm::event::{self, Event, KeyCode, KeyEvent, KeyEventKind},
layout::{Alignment, Constraint, Direction, Layout, Rect},
style::{Color, Modifier, Style, Stylize},
symbols::border,
text::Line,
widgets::{Block, Gauge, Paragraph, Widget},
};
const VOLUME_STEP: u8 = 5;
/// Runs the interactive terminal UI and restores the terminal before returning.
pub fn run() -> io::Result<()> {
let mut terminal = ratatui::init();
let result = Tui::default().run(&mut terminal);
ratatui::restore();
result
}
/// State for the initial interactive mixer shell.
#[derive(Debug)]
pub struct Tui {
volume: u8,
exit: bool,
}
impl Default for Tui {
fn default() -> Self {
Self {
volume: 65,
exit: false,
}
}
}
impl Tui {
/// Runs the application's main loop until the user quits.
pub fn run(&mut self, terminal: &mut DefaultTerminal) -> io::Result<()> {
while !self.exit {
terminal.draw(|frame| self.draw(frame))?;
self.handle_events()?;
}
Ok(())
}
fn draw(&self, frame: &mut Frame) {
frame.render_widget(self, frame.area());
}
fn handle_events(&mut self) -> io::Result<()> {
if let Event::Key(key_event) = event::read()?
&& key_event.kind == KeyEventKind::Press
{
self.handle_key_event(key_event);
}
Ok(())
}
fn handle_key_event(&mut self, key_event: KeyEvent) {
match key_event.code {
KeyCode::Left | KeyCode::Down => {
self.volume = self.volume.saturating_sub(VOLUME_STEP);
}
KeyCode::Right | KeyCode::Up => {
self.volume = self.volume.saturating_add(VOLUME_STEP).min(100);
}
KeyCode::Home => self.volume = 0,
KeyCode::End => self.volume = 100,
KeyCode::Esc | KeyCode::Char('q') => self.exit = true,
_ => {}
}
}
}
impl Widget for &Tui {
fn render(self, area: Rect, buf: &mut Buffer) {
let [header, body, footer] = Layout::default()
.direction(Direction::Vertical)
.constraints([
Constraint::Length(3),
Constraint::Min(5),
Constraint::Length(3),
])
.areas(area);
Paragraph::new(Line::from(vec![
" FADER ".fg(Color::Black).bg(Color::Cyan).bold(),
" MASTER ".bold(),
]))
.alignment(Alignment::Center)
.block(Block::bordered().border_set(border::ROUNDED))
.render(header, buf);
let mixer = Block::bordered()
.title(" Mixer ".bold())
.title_bottom(" demo state · live server connection follows in M7 ".dark_gray())
.border_set(border::THICK);
let inner = mixer.inner(body);
mixer.render(body, buf);
let [label, meter, state] = Layout::default()
.direction(Direction::Vertical)
.constraints([
Constraint::Length(2),
Constraint::Length(3),
Constraint::Min(1),
])
.margin(1)
.areas(inner);
Paragraph::new("Desktop audio")
.style(Style::default().add_modifier(Modifier::BOLD))
.render(label, buf);
Gauge::default()
.block(Block::bordered())
.gauge_style(Style::default().fg(Color::Cyan).bg(Color::DarkGray))
.percent(u16::from(self.volume))
.label(format!("{}%", self.volume))
.render(meter, buf);
Paragraph::new("● Adapter: demo ● MIDI: waiting ○ Mute: off")
.style(Style::default().fg(Color::Gray))
.render(state, buf);
Paragraph::new(Line::from(vec![
" ←/↓ ".into(),
"volume down".cyan(),
" →/↑ ".into(),
"volume up".cyan(),
" Home/End ".into(),
"min/max".cyan(),
" Q/Esc ".into(),
"quit".cyan(),
]))
.alignment(Alignment::Center)
.block(Block::bordered().border_set(border::ROUNDED))
.render(footer, buf);
}
}
#[cfg(test)]
mod tests {
use super::*;
fn press(code: KeyCode) -> KeyEvent {
KeyEvent::new(code, ratatui::crossterm::event::KeyModifiers::NONE)
}
#[test]
fn volume_keys_move_and_clamp_the_demo_fader() {
let mut app = Tui::default();
app.handle_key_event(press(KeyCode::End));
app.handle_key_event(press(KeyCode::Right));
assert_eq!(app.volume, 100);
app.handle_key_event(press(KeyCode::Home));
app.handle_key_event(press(KeyCode::Left));
assert_eq!(app.volume, 0);
}
#[test]
fn quit_keys_request_exit() {
let mut app = Tui::default();
app.handle_key_event(press(KeyCode::Char('q')));
assert!(app.exit);
}
#[test]
fn mixer_shell_renders_at_a_typical_terminal_size() {
let area = Rect::new(0, 0, 100, 20);
let mut buffer = Buffer::empty(area);
(&Tui::default()).render(area, &mut buffer);
let rendered = buffer
.content
.iter()
.map(|cell| cell.symbol())
.collect::<String>();
assert!(rendered.contains("FADER"));
assert!(rendered.contains("Desktop audio"));
assert!(rendered.contains("65%"));
assert!(rendered.contains("Q/Esc"));
}
}