#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct Size {
pub rows: u16,
pub cols: u16,
}
impl Size {
pub const fn new(rows: u16, cols: u16) -> Self {
Self { rows, cols }
}
}
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum Key {
Character,
Enter,
Escape,
Backspace,
Tab,
Insert,
Delete,
Home,
End,
PageUp,
PageDown,
ArrowUp,
ArrowDown,
ArrowLeft,
ArrowRight,
Function(u8),
Unknown(String),
}
impl Key {
pub fn is_character(&self) -> bool {
*self == Key::Character
}
}
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct KeyEvent {
pub key: Key,
pub character: Option<char>,
pub ctrl: bool,
pub alt: bool,
pub shift: bool,
}
impl KeyEvent {
pub fn character(ch: char) -> Self {
Self {
key: Key::Character,
character: Some(ch),
ctrl: false,
alt: false,
shift: false,
}
}
pub fn special(key: Key) -> Self {
Self {
key,
character: None,
ctrl: false,
alt: false,
shift: false,
}
}
pub fn ctrl(ch: char) -> Self {
Self {
key: Key::Character,
character: Some(ch),
ctrl: true,
alt: false,
shift: false,
}
}
pub fn is_ctrl_c(&self) -> bool {
self.ctrl && self.character == Some('c')
}
pub fn is_ctrl_z(&self) -> bool {
self.ctrl && self.character == Some('z')
}
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
pub enum InputMode {
#[default]
Canonical,
Raw,
}
pub trait Terminal: Send + Sync {
fn size(&self) -> Size;
fn next_key(&mut self) -> Option<KeyEvent>;
fn push_keys(&mut self, keys: &[KeyEvent]);
fn write(&mut self, bytes: &[u8]);
fn enter_alternate_screen(&mut self);
fn leave_alternate_screen(&mut self);
fn input_mode(&self) -> InputMode;
fn set_input_mode(&mut self, mode: InputMode);
fn flush(&mut self);
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn character_events_carry_the_character() {
let event = KeyEvent::character('a');
assert_eq!(event.key, Key::Character);
assert_eq!(event.character, Some('a'));
assert!(event.key.is_character());
}
#[test]
fn ctrl_shortcuts_are_detectable() {
assert!(KeyEvent::ctrl('c').is_ctrl_c());
assert!(!KeyEvent::ctrl('z').is_ctrl_c());
assert!(KeyEvent::ctrl('z').is_ctrl_z());
}
#[test]
fn special_keys_are_created_without_modifiers() {
let event = KeyEvent::special(Key::ArrowUp);
assert!(!event.ctrl && !event.alt && !event.shift);
assert!(!event.key.is_character());
}
#[test]
fn size_holds_rows_and_columns() {
assert_eq!(Size::new(24, 80), Size { rows: 24, cols: 80 });
}
}