deckhand 0.3.0

Present markdown slide decks as a TUI — live embedded terminals, a 2-D slide grid, presenter notes, and a wasm presenter for the browser
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
//! Native TUI front end.
//!
//! All presentation logic lives in [`crate::presenter`]; this module
//! supplies what only a real terminal can: crossterm events in, a
//! terminal screen out, real PTYs via [`PtyProvider`], and the
//! presenter-notes broadcast over the unix socket.

use std::collections::{HashMap, HashSet};
use std::path::PathBuf;
use std::time::{Duration, SystemTime, UNIX_EPOCH};

use anyhow::{Context, Result};
use ratatui::buffer::Buffer;
use ratatui::crossterm::event::{
    self, DisableMouseCapture, EnableMouseCapture, Event, KeyCode, KeyEvent, KeyEventKind,
    KeyModifiers, MouseButton, MouseEventKind,
};
use ratatui::crossterm::execute;
use ratatui::layout::Rect;
use ratatui::style::{Color, Modifier, Style};
use ratatui::text::{Line, Span};
use ratatui::widgets::{Paragraph, Widget};
use tui_term::widget::PseudoTerminal;

use crate::deck::TermBlock;
use crate::presenter::{Key, KeyPress, Mouse, MouseAction, Presenter, TermState, TerminalProvider};
use crate::proto::NotesState;
use crate::server::NotesServer;
use crate::source;
use crate::term::TermSession;
use crate::theme::{self, ThemeConfig};

/// Real PTYs: each terminal block shows its command until the presenter
/// approves it in-deck (`t`, then `y`); `--eager` spawns on first view
/// instead. The reference [`TerminalProvider`] implementation.
pub struct PtyProvider {
    deck_dir: PathBuf,
    sessions: HashMap<usize, TermSession>,
    failed: HashMap<usize, String>,
    /// Spawn on first view without per-block approval.
    eager: bool,
    /// Blocks approved in-deck with `y`.
    approved: HashSet<usize>,
    /// Blocks stopped with `s`; overrides `eager` so they stay down.
    stopped: HashSet<usize>,
}

impl PtyProvider {
    fn shutdown(&mut self) {
        for (_, mut s) in self.sessions.drain() {
            s.kill();
        }
    }

    /// May this block execute right now?
    fn allowed(&self, id: usize) -> bool {
        !self.stopped.contains(&id) && (self.eager || self.approved.contains(&id))
    }

    /// Reap children whose commands have finished — including on slides
    /// not currently shown — so they don't accumulate as zombies.
    fn reap_exited(&mut self) {
        for s in self.sessions.values_mut() {
            s.reap();
        }
    }
}

impl TerminalProvider for PtyProvider {
    fn prepare(&mut self, block: &TermBlock, cols: u16, rows: u16) {
        if !self.allowed(block.id) {
            return;
        }
        let cols = cols.max(4);
        let rows = rows.max(2);
        if self.failed.contains_key(&block.id) {
            return;
        }
        match self.sessions.get_mut(&block.id) {
            Some(s) => s.resize(rows, cols),
            None => {
                match TermSession::spawn(block.command.as_deref(), rows, cols, &self.deck_dir) {
                    Ok(s) => {
                        self.sessions.insert(block.id, s);
                    }
                    Err(e) => {
                        self.failed.insert(block.id, e.to_string());
                    }
                }
            }
        }
    }

    fn state(&self, block: &TermBlock) -> TermState {
        if !self.allowed(block.id) {
            return TermState::Disabled;
        }
        if let Some(msg) = self.failed.get(&block.id) {
            return TermState::Failed(msg.clone());
        }
        match self.sessions.get(&block.id) {
            Some(s) if s.exited() => TermState::Exited,
            Some(s) => {
                let (scroll_offset, scroll_total) = s.scroll_info();
                TermState::Running {
                    scroll_offset,
                    scroll_total,
                }
            }
            // Not spawned yet; `prepare` will start it this frame.
            None => TermState::Running {
                scroll_offset: 0,
                scroll_total: 0,
            },
        }
    }

    fn draw(&mut self, block: &TermBlock, inner: Rect, buf: &mut Buffer) {
        if !self.allowed(block.id) {
            // Show exactly what approval would run.
            let muted = Style::default().fg(Color::Indexed(244));
            let mut lines = vec![Line::default()];
            match block.command.as_deref() {
                Some(command) => {
                    for (i, part) in command.lines().enumerate() {
                        let prefix = if i == 0 { "  $ " } else { "    " };
                        lines.push(Line::from(Span::styled(format!("{prefix}{part}"), muted)));
                    }
                }
                None => lines.push(Line::from(Span::styled(
                    "  $SHELL (interactive shell)",
                    muted,
                ))),
            }
            lines.push(Line::default());
            lines.push(Line::from(Span::styled(
                "  not running — press t, then y to run",
                muted.add_modifier(Modifier::ITALIC),
            )));
            Paragraph::new(lines).render(inner, buf);
            return;
        }
        if let Some(session) = self.sessions.get(&block.id) {
            let parser = session.parser_lock();
            PseudoTerminal::new(parser.screen()).render(inner, buf);
        }
    }

    fn input(&mut self, id: usize, bytes: &[u8]) {
        if let Some(s) = self.sessions.get_mut(&id) {
            s.write_input(bytes);
        }
    }

    fn scroll(&mut self, id: usize, delta: isize) {
        if let Some(s) = self.sessions.get_mut(&id) {
            s.scroll_lines(delta);
        }
    }

    fn wheel(&mut self, id: usize, up: bool, col: u16, row: u16) {
        if let Some(s) = self.sessions.get_mut(&id) {
            s.wheel(up, col, row);
        }
    }

    fn click(&mut self, id: usize, col: u16, row: u16) -> bool {
        self.sessions
            .get_mut(&id)
            .is_some_and(|s| s.click(col, row))
    }

    fn restart(&mut self, ids: &[usize]) {
        for id in ids {
            if let Some(mut s) = self.sessions.remove(id) {
                s.kill();
            }
            self.failed.remove(id);
        }
    }

    fn reset(&mut self) {
        self.shutdown();
        self.failed.clear();
        // Terminal blocks changed identity; approvals no longer apply.
        self.approved.clear();
        self.stopped.clear();
    }

    fn enable(&mut self, id: usize) {
        self.approved.insert(id);
        self.stopped.remove(&id);
    }

    fn stop(&mut self, id: usize) {
        if let Some(mut s) = self.sessions.remove(&id) {
            s.kill();
        }
        self.failed.remove(&id);
        self.approved.remove(&id);
        self.stopped.insert(id);
    }
}

/// Present a deck (a local path, URL, or gist) full-screen in the
/// current terminal, broadcasting presenter notes on `socket`. With
/// `watch`, local deck files are polled and the deck hot-reloads when
/// they change.
///
/// Terminal blocks don't execute anything by default — each shows its
/// command until approved in-deck (`t`, then `y`). With `eager`, blocks
/// spawn as soon as their slide is shown. Returns when the presenter
/// quits.
pub fn run(input: &str, socket: PathBuf, watch: bool, eager: bool) -> Result<()> {
    let source::Loaded {
        deck,
        theme: deck_theme,
        base_dir,
    } = source::load(input)?;
    let cfgs: Vec<ThemeConfig> = [theme::user_config()?, deck_theme]
        .into_iter()
        .flatten()
        .collect();

    let provider = PtyProvider {
        deck_dir: base_dir,
        sessions: HashMap::new(),
        failed: HashMap::new(),
        eager,
        approved: HashSet::new(),
        stopped: HashSet::new(),
    };
    let mut presenter = Presenter::new(deck, cfgs, provider)?;
    presenter.help_footer = Some(format!(
        "notes: deckhand notes --socket {}",
        socket.display()
    ));

    let server = NotesServer::start(socket).context("starting presenter-notes server")?;
    let started_at = SystemTime::now()
        .duration_since(UNIX_EPOCH)
        .map(|d| d.as_secs())
        .unwrap_or(0);
    broadcast(&server, &presenter, started_at);

    let mut terminal = ratatui::init();
    let _ = execute!(std::io::stdout(), EnableMouseCapture);
    let result = event_loop(
        &mut terminal,
        &mut presenter,
        &server,
        started_at,
        input,
        watch,
    );
    let _ = execute!(std::io::stdout(), DisableMouseCapture);
    ratatui::restore();
    presenter.provider.shutdown();
    result
}

/// How often the live-reload watcher polls file mtimes.
const WATCH_INTERVAL: Duration = Duration::from_millis(300);

fn event_loop(
    terminal: &mut ratatui::DefaultTerminal,
    presenter: &mut Presenter<PtyProvider>,
    server: &NotesServer,
    started_at: u64,
    input: &str,
    watch: bool,
) -> Result<()> {
    let mut watcher = watch.then(|| Watcher::new(input));
    let mut last_watch = std::time::Instant::now();

    // A static slide doesn't change between events — skip its redraws
    // (and poll less often) so an idle deckhand costs ~nothing. Slides
    // showing terminals keep the ~30 fps cadence: PTY output arrives
    // whenever it likes.
    let mut dirty = true;
    while !presenter.should_quit() {
        if dirty || presenter.has_visible_terminals() {
            terminal.draw(|f| {
                let area = f.area();
                presenter.draw(area, f.buffer_mut());
            })?;
            dirty = false;
        }
        presenter.provider.reap_exited();
        let timeout = if presenter.has_visible_terminals() {
            Duration::from_millis(33)
        } else {
            Duration::from_millis(100)
        };
        if event::poll(timeout)? {
            dirty = true;
            let before = presenter.position();
            // Drain everything pending before redrawing — a paste into a
            // focused terminal arrives as many events, and a full frame
            // per character would lag far behind the keyboard.
            loop {
                match event::read()? {
                    Event::Key(k)
                        if matches!(k.kind, KeyEventKind::Press | KeyEventKind::Repeat) =>
                    {
                        if let Some(kp) = translate_key(&k) {
                            presenter.on_key(kp);
                        }
                    }
                    Event::Mouse(m) => {
                        if let Some(mm) = translate_mouse(&m) {
                            presenter.on_mouse(mm);
                        }
                    }
                    _ => {}
                }
                if presenter.should_quit() || !event::poll(Duration::ZERO)? {
                    break;
                }
            }
            if presenter.position() != before {
                broadcast(server, presenter, started_at);
            }
        }

        if let Some(w) = watcher.as_mut()
            && last_watch.elapsed() >= WATCH_INTERVAL
        {
            last_watch = std::time::Instant::now();
            if w.changed() {
                reload(presenter, input, w);
                broadcast(server, presenter, started_at);
                dirty = true;
            }
        }
    }
    Ok(())
}

/// Polls mtimes of the deck's files; local decks only.
struct Watcher {
    paths: Vec<PathBuf>,
    stamps: Vec<Option<std::time::SystemTime>>,
}

impl Watcher {
    fn new(input: &str) -> Self {
        let paths = source::watch_paths(input);
        let stamps = Self::mtimes(&paths);
        Watcher { paths, stamps }
    }

    fn mtimes(paths: &[PathBuf]) -> Vec<Option<std::time::SystemTime>> {
        paths
            .iter()
            .map(|p| std::fs::metadata(p).and_then(|m| m.modified()).ok())
            .collect()
    }

    /// True when any watched file's mtime moved; updates the baseline.
    fn changed(&mut self) -> bool {
        let current = Self::mtimes(&self.paths);
        if current == self.stamps {
            return false;
        }
        self.stamps = current;
        true
    }

    /// Re-derive the watch list (a manifest edit can change it).
    fn refresh(&mut self, input: &str) {
        self.paths = source::watch_paths(input);
        self.stamps = Self::mtimes(&self.paths);
    }
}

/// Reload the deck from disk into the running presenter. A mid-edit
/// parse failure keeps the current deck and reports on the status bar.
fn reload(presenter: &mut Presenter<PtyProvider>, input: &str, watcher: &mut Watcher) {
    let attempt = (|| -> Result<()> {
        let source::Loaded {
            deck,
            theme: deck_theme,
            ..
        } = source::load(input)?;
        let cfgs: Vec<ThemeConfig> = [theme::user_config()?, deck_theme]
            .into_iter()
            .flatten()
            .collect();
        presenter.replace_deck(deck, cfgs)
    })();
    match attempt {
        Ok(()) => {
            watcher.refresh(input);
            presenter.set_status("deck reloaded");
        }
        Err(e) => {
            let first = format!("{e:#}")
                .lines()
                .next()
                .unwrap_or_default()
                .to_string();
            presenter.set_status(format!("reload failed: {first}"));
        }
    }
}

fn translate_key(k: &KeyEvent) -> Option<KeyPress> {
    let key = match k.code {
        KeyCode::Char(c) => Key::Char(c),
        KeyCode::Enter => Key::Enter,
        KeyCode::Esc => Key::Esc,
        KeyCode::Backspace => Key::Backspace,
        KeyCode::Tab => Key::Tab,
        KeyCode::BackTab => Key::BackTab,
        KeyCode::Up => Key::Up,
        KeyCode::Down => Key::Down,
        KeyCode::Left => Key::Left,
        KeyCode::Right => Key::Right,
        KeyCode::Home => Key::Home,
        KeyCode::End => Key::End,
        KeyCode::PageUp => Key::PageUp,
        KeyCode::PageDown => Key::PageDown,
        KeyCode::Insert => Key::Insert,
        KeyCode::Delete => Key::Delete,
        KeyCode::F(n) => Key::F(n),
        _ => return None,
    };
    Some(KeyPress {
        key,
        ctrl: k.modifiers.contains(KeyModifiers::CONTROL),
        alt: k.modifiers.contains(KeyModifiers::ALT),
        shift: k.modifiers.contains(KeyModifiers::SHIFT),
    })
}

fn translate_mouse(m: &event::MouseEvent) -> Option<Mouse> {
    let action = match m.kind {
        MouseEventKind::Down(MouseButton::Left) => MouseAction::LeftClick,
        MouseEventKind::ScrollUp => MouseAction::ScrollUp,
        MouseEventKind::ScrollDown => MouseAction::ScrollDown,
        _ => return None,
    };
    Some(Mouse {
        x: m.column,
        y: m.row,
        action,
    })
}

fn broadcast(server: &NotesServer, presenter: &Presenter<PtyProvider>, started_at: u64) {
    let deck = presenter.deck();
    let (col, row) = presenter.position();
    let flat = deck.flat();
    let idx = flat.iter().position(|&p| p == (col, row)).unwrap_or(0);
    let next_title = flat
        .get(idx + 1)
        .map(|&(c, r)| deck.slide(c, r).title.clone());
    let slide = deck.slide(col, row);
    server.broadcast(&NotesState {
        deck_title: deck.title.clone(),
        col,
        row,
        total_cols: deck.columns.len(),
        col_depth: deck.columns[col].slides.len(),
        slide_no: idx + 1,
        total_slides: flat.len(),
        title: slide.title.clone(),
        notes: slide.notes.clone(),
        next_title,
        started_at,
    });
}