bmux_cli 0.0.1-alpha.1

Command-line interface for bmux terminal multiplexer
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
use crossterm::event::{
    KeyCode, KeyEvent, KeyEventKind, KeyModifiers, MouseButton, MouseEvent, MouseEventKind,
};

/// Terminal input normalized for attach UI reducers.
///
/// Coordinates use the same 0-based row/column convention as crossterm and the
/// existing attach/status rendering code.
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum TerminalInputEvent {
    Key(TerminalKeyEvent),
    Mouse(TerminalMouseEvent),
    Resize { cols: u16, rows: u16 },
    Bytes(Vec<u8>),
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub struct TerminalKeyEvent {
    pub code: TerminalKeyCode,
    pub kind: TerminalKeyPhase,
    pub modifiers: TerminalModifiers,
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub enum TerminalKeyCode {
    Backspace,
    Enter,
    Left,
    Right,
    Up,
    Down,
    Home,
    End,
    PageUp,
    PageDown,
    Tab,
    BackTab,
    Delete,
    Insert,
    Function(u8),
    Char(char),
    Null,
    Esc,
    CapsLock,
    ScrollLock,
    NumLock,
    PrintScreen,
    Pause,
    Menu,
    KeypadBegin,
    Media(String),
    Modifier(String),
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum TerminalKeyPhase {
    Press,
    Repeat,
    Release,
}

// Keep modifiers as explicit booleans so simulation inputs are independent of
// crossterm's bitflag representation and easy for playbooks to construct.
#[allow(clippy::struct_excessive_bools)]
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
pub struct TerminalModifiers {
    pub shift: bool,
    pub control: bool,
    pub alt: bool,
    pub super_key: bool,
    pub hyper: bool,
    pub meta: bool,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct TerminalMouseEvent {
    pub phase: TerminalMousePhase,
    pub button: Option<TerminalMouseButton>,
    pub col: u16,
    pub row: u16,
    pub modifiers: TerminalModifiers,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum TerminalMousePhase {
    Down,
    Up,
    Drag,
    Move,
    ScrollUp,
    ScrollDown,
    ScrollLeft,
    ScrollRight,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum TerminalMouseButton {
    Left,
    Right,
    Middle,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct TerminalGeometry {
    pub cols: u16,
    pub rows: u16,
}

impl TerminalInputEvent {
    #[must_use]
    pub fn from_crossterm_event(event: crossterm::event::Event) -> Option<Self> {
        match event {
            crossterm::event::Event::Key(key) => Some(Self::Key(TerminalKeyEvent::from(key))),
            crossterm::event::Event::Mouse(mouse) => {
                Some(Self::Mouse(TerminalMouseEvent::from(mouse)))
            }
            crossterm::event::Event::Resize(cols, rows) => Some(Self::Resize { cols, rows }),
            crossterm::event::Event::Paste(text) => Some(Self::Bytes(text.into_bytes())),
            crossterm::event::Event::FocusGained | crossterm::event::Event::FocusLost => None,
        }
    }
}

impl TerminalKeyEvent {
    #[must_use]
    pub fn to_crossterm(&self) -> Option<KeyEvent> {
        let code = self.code.to_crossterm()?;
        Some(KeyEvent::new_with_kind(
            code,
            self.modifiers.to_crossterm(),
            self.kind.to_crossterm(),
        ))
    }
}

impl From<KeyEvent> for TerminalKeyEvent {
    fn from(event: KeyEvent) -> Self {
        Self {
            code: TerminalKeyCode::from(event.code),
            kind: TerminalKeyPhase::from(event.kind),
            modifiers: TerminalModifiers::from(event.modifiers),
        }
    }
}

impl TerminalKeyCode {
    #[must_use]
    pub const fn to_crossterm(&self) -> Option<KeyCode> {
        Some(match self {
            Self::Backspace => KeyCode::Backspace,
            Self::Enter => KeyCode::Enter,
            Self::Left => KeyCode::Left,
            Self::Right => KeyCode::Right,
            Self::Up => KeyCode::Up,
            Self::Down => KeyCode::Down,
            Self::Home => KeyCode::Home,
            Self::End => KeyCode::End,
            Self::PageUp => KeyCode::PageUp,
            Self::PageDown => KeyCode::PageDown,
            Self::Tab => KeyCode::Tab,
            Self::BackTab => KeyCode::BackTab,
            Self::Delete => KeyCode::Delete,
            Self::Insert => KeyCode::Insert,
            Self::Function(value) => KeyCode::F(*value),
            Self::Char(value) => KeyCode::Char(*value),
            Self::Null => KeyCode::Null,
            Self::Esc => KeyCode::Esc,
            Self::CapsLock => KeyCode::CapsLock,
            Self::ScrollLock => KeyCode::ScrollLock,
            Self::NumLock => KeyCode::NumLock,
            Self::PrintScreen => KeyCode::PrintScreen,
            Self::Pause => KeyCode::Pause,
            Self::Menu => KeyCode::Menu,
            Self::KeypadBegin => KeyCode::KeypadBegin,
            Self::Media(_) | Self::Modifier(_) => return None,
        })
    }
}

impl From<KeyCode> for TerminalKeyCode {
    fn from(code: KeyCode) -> Self {
        match code {
            KeyCode::Backspace => Self::Backspace,
            KeyCode::Enter => Self::Enter,
            KeyCode::Left => Self::Left,
            KeyCode::Right => Self::Right,
            KeyCode::Up => Self::Up,
            KeyCode::Down => Self::Down,
            KeyCode::Home => Self::Home,
            KeyCode::End => Self::End,
            KeyCode::PageUp => Self::PageUp,
            KeyCode::PageDown => Self::PageDown,
            KeyCode::Tab => Self::Tab,
            KeyCode::BackTab => Self::BackTab,
            KeyCode::Delete => Self::Delete,
            KeyCode::Insert => Self::Insert,
            KeyCode::F(index) => Self::Function(index),
            KeyCode::Char(value) => Self::Char(value),
            KeyCode::Null => Self::Null,
            KeyCode::Esc => Self::Esc,
            KeyCode::CapsLock => Self::CapsLock,
            KeyCode::ScrollLock => Self::ScrollLock,
            KeyCode::NumLock => Self::NumLock,
            KeyCode::PrintScreen => Self::PrintScreen,
            KeyCode::Pause => Self::Pause,
            KeyCode::Menu => Self::Menu,
            KeyCode::KeypadBegin => Self::KeypadBegin,
            KeyCode::Media(value) => Self::Media(format!("{value:?}")),
            KeyCode::Modifier(value) => Self::Modifier(format!("{value:?}")),
        }
    }
}

impl TerminalKeyPhase {
    #[must_use]
    pub const fn to_crossterm(self) -> KeyEventKind {
        match self {
            Self::Press => KeyEventKind::Press,
            Self::Repeat => KeyEventKind::Repeat,
            Self::Release => KeyEventKind::Release,
        }
    }
}

impl From<KeyEventKind> for TerminalKeyPhase {
    fn from(kind: KeyEventKind) -> Self {
        match kind {
            KeyEventKind::Press => Self::Press,
            KeyEventKind::Repeat => Self::Repeat,
            KeyEventKind::Release => Self::Release,
        }
    }
}

impl TerminalMouseEvent {
    #[must_use]
    pub fn to_crossterm(self) -> Option<MouseEvent> {
        let kind = match self.phase {
            TerminalMousePhase::Down => MouseEventKind::Down(self.button?.to_crossterm()),
            TerminalMousePhase::Up => MouseEventKind::Up(self.button?.to_crossterm()),
            TerminalMousePhase::Drag => MouseEventKind::Drag(self.button?.to_crossterm()),
            TerminalMousePhase::Move => MouseEventKind::Moved,
            TerminalMousePhase::ScrollUp => MouseEventKind::ScrollUp,
            TerminalMousePhase::ScrollDown => MouseEventKind::ScrollDown,
            TerminalMousePhase::ScrollLeft => MouseEventKind::ScrollLeft,
            TerminalMousePhase::ScrollRight => MouseEventKind::ScrollRight,
        };
        Some(MouseEvent {
            kind,
            column: self.col,
            row: self.row,
            modifiers: self.modifiers.to_crossterm(),
        })
    }
}

impl From<MouseEvent> for TerminalMouseEvent {
    fn from(event: MouseEvent) -> Self {
        let (phase, button) = match event.kind {
            MouseEventKind::Down(button) => (TerminalMousePhase::Down, Some(button.into())),
            MouseEventKind::Up(button) => (TerminalMousePhase::Up, Some(button.into())),
            MouseEventKind::Drag(button) => (TerminalMousePhase::Drag, Some(button.into())),
            MouseEventKind::Moved => (TerminalMousePhase::Move, None),
            MouseEventKind::ScrollUp => (TerminalMousePhase::ScrollUp, None),
            MouseEventKind::ScrollDown => (TerminalMousePhase::ScrollDown, None),
            MouseEventKind::ScrollLeft => (TerminalMousePhase::ScrollLeft, None),
            MouseEventKind::ScrollRight => (TerminalMousePhase::ScrollRight, None),
        };
        Self {
            phase,
            button,
            col: event.column,
            row: event.row,
            modifiers: TerminalModifiers::from(event.modifiers),
        }
    }
}

impl TerminalMouseButton {
    #[must_use]
    pub const fn to_crossterm(self) -> MouseButton {
        match self {
            Self::Left => MouseButton::Left,
            Self::Right => MouseButton::Right,
            Self::Middle => MouseButton::Middle,
        }
    }
}

impl From<MouseButton> for TerminalMouseButton {
    fn from(button: MouseButton) -> Self {
        match button {
            MouseButton::Left => Self::Left,
            MouseButton::Right => Self::Right,
            MouseButton::Middle => Self::Middle,
        }
    }
}

impl TerminalModifiers {
    #[must_use]
    pub fn to_crossterm(self) -> KeyModifiers {
        let mut modifiers = KeyModifiers::empty();
        if self.shift {
            modifiers.insert(KeyModifiers::SHIFT);
        }
        if self.control {
            modifiers.insert(KeyModifiers::CONTROL);
        }
        if self.alt {
            modifiers.insert(KeyModifiers::ALT);
        }
        if self.super_key {
            modifiers.insert(KeyModifiers::SUPER);
        }
        if self.hyper {
            modifiers.insert(KeyModifiers::HYPER);
        }
        if self.meta {
            modifiers.insert(KeyModifiers::META);
        }
        modifiers
    }
}

impl From<KeyModifiers> for TerminalModifiers {
    fn from(modifiers: KeyModifiers) -> Self {
        Self {
            shift: modifiers.contains(KeyModifiers::SHIFT),
            control: modifiers.contains(KeyModifiers::CONTROL),
            alt: modifiers.contains(KeyModifiers::ALT),
            super_key: modifiers.contains(KeyModifiers::SUPER),
            hyper: modifiers.contains(KeyModifiers::HYPER),
            meta: modifiers.contains(KeyModifiers::META),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::{
        TerminalInputEvent, TerminalModifiers, TerminalMouseButton, TerminalMouseEvent,
        TerminalMousePhase,
    };
    use crossterm::event::{Event, KeyModifiers, MouseButton, MouseEvent, MouseEventKind};

    #[test]
    fn maps_crossterm_mouse_down() {
        let event = TerminalMouseEvent::from(MouseEvent {
            kind: MouseEventKind::Down(MouseButton::Left),
            column: 4,
            row: 9,
            modifiers: KeyModifiers::SHIFT | KeyModifiers::CONTROL,
        });

        assert_eq!(
            event,
            TerminalMouseEvent {
                phase: TerminalMousePhase::Down,
                button: Some(TerminalMouseButton::Left),
                col: 4,
                row: 9,
                modifiers: TerminalModifiers {
                    shift: true,
                    control: true,
                    alt: false,
                    super_key: false,
                    hyper: false,
                    meta: false,
                },
            }
        );
    }

    #[test]
    fn maps_crossterm_mouse_up_and_drag() {
        let up = TerminalMouseEvent::from(MouseEvent {
            kind: MouseEventKind::Up(MouseButton::Right),
            column: 5,
            row: 7,
            modifiers: KeyModifiers::empty(),
        });
        assert_eq!(up.phase, TerminalMousePhase::Up);
        assert_eq!(up.button, Some(TerminalMouseButton::Right));

        let drag = TerminalMouseEvent::from(MouseEvent {
            kind: MouseEventKind::Drag(MouseButton::Middle),
            column: 9,
            row: 3,
            modifiers: KeyModifiers::empty(),
        });
        assert_eq!(drag.phase, TerminalMousePhase::Drag);
        assert_eq!(drag.button, Some(TerminalMouseButton::Middle));
    }

    #[test]
    fn maps_crossterm_mouse_motion_and_scroll() {
        let moved = TerminalMouseEvent::from(MouseEvent {
            kind: MouseEventKind::Moved,
            column: 8,
            row: 2,
            modifiers: KeyModifiers::empty(),
        });
        assert_eq!(moved.phase, TerminalMousePhase::Move);
        assert_eq!(moved.button, None);

        let scroll = TerminalMouseEvent::from(MouseEvent {
            kind: MouseEventKind::ScrollDown,
            column: 8,
            row: 2,
            modifiers: KeyModifiers::ALT,
        });
        assert_eq!(scroll.phase, TerminalMousePhase::ScrollDown);
        assert!(scroll.modifiers.alt);
    }

    #[test]
    fn maps_crossterm_event_resize() {
        assert_eq!(
            TerminalInputEvent::from_crossterm_event(Event::Resize(120, 30)),
            Some(TerminalInputEvent::Resize {
                cols: 120,
                rows: 30
            })
        );
    }
}