ftui_core/

event.rs

#![forbid(unsafe_code)]

//! Canonical input/event types.
//!
//! This module defines the standard event types used throughout ftui for
//! input handling. All events derive `Clone`, `PartialEq`, and `Eq` for
//! use in tests and pattern matching.
//!
//! # Design Notes
//!
//! - Mouse coordinates are 0-indexed (terminal is 1-indexed internally)
//! - `KeyEventKind` defaults to `Press` when not available from the terminal
//! - `Modifiers` use bitflags for easy combination
//! - Clipboard events are optional and feature-gated in the future

use bitflags::bitflags;
#[cfg(all(not(target_arch = "wasm32"), feature = "crossterm"))]
use crossterm::event as cte;

/// Canonical input event.
///
/// This enum represents all possible input events that ftui can receive
/// from the terminal.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Event {
    /// A keyboard event.
    Key(KeyEvent),

    /// A mouse event.
    Mouse(MouseEvent),

    /// Terminal was resized.
    Resize {
        /// New terminal width in columns.
        width: u16,
        /// New terminal height in rows.
        height: u16,
    },

    /// Paste event (from bracketed paste mode).
    Paste(PasteEvent),

    /// Focus gained or lost.
    ///
    /// `true` = focus gained, `false` = focus lost.
    Focus(bool),

    /// Clipboard content received (optional, from OSC 52 response).
    Clipboard(ClipboardEvent),

    /// A tick event from the runtime.
    ///
    /// Fired when a scheduled tick interval elapses. Applications use this
    /// for periodic updates (animations, polling, timers). The model's `update`
    /// method receives the tick and can respond with state changes.
    Tick,
}

impl Event {
    /// Convert a Crossterm event into an ftui [`Event`].
    #[must_use]
    #[cfg(all(not(target_arch = "wasm32"), feature = "crossterm"))]
    pub fn from_crossterm(event: cte::Event) -> Option<Self> {
        map_crossterm_event_internal(event)
    }

    /// Return a static label for the event type (for metrics/tracing).
    #[must_use]
    pub const fn event_type_label(&self) -> &'static str {
        match self {
            Event::Key(_) => "key",
            Event::Mouse(_) => "mouse",
            Event::Resize { .. } => "resize",
            Event::Paste(_) => "paste",
            Event::Focus(_) => "focus",
            Event::Clipboard(_) => "clipboard",
            Event::Tick => "tick",
        }
    }
}

/// A keyboard event.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct KeyEvent {
    /// The key code that was pressed.
    pub code: KeyCode,

    /// Modifier keys held during the event.
    pub modifiers: Modifiers,

    /// The type of key event (press, repeat, or release).
    pub kind: KeyEventKind,
}

impl KeyEvent {
    /// Create a new key event with default modifiers and Press kind.
    #[must_use]
    pub const fn new(code: KeyCode) -> Self {
        Self {
            code,
            modifiers: Modifiers::NONE,
            kind: KeyEventKind::Press,
        }
    }

    /// Create a key event with modifiers.
    #[must_use]
    pub const fn with_modifiers(mut self, modifiers: Modifiers) -> Self {
        self.modifiers = modifiers;
        self
    }

    /// Create a key event with a specific kind.
    #[must_use]
    pub const fn with_kind(mut self, kind: KeyEventKind) -> Self {
        self.kind = kind;
        self
    }

    /// Check if this is a specific character key.
    #[must_use]
    pub fn is_char(&self, c: char) -> bool {
        matches!(self.code, KeyCode::Char(ch) if ch == c)
    }

    /// Check if Ctrl modifier is held.
    #[must_use]
    pub const fn ctrl(&self) -> bool {
        self.modifiers.contains(Modifiers::CTRL)
    }

    /// Check if Alt modifier is held.
    #[must_use]
    pub const fn alt(&self) -> bool {
        self.modifiers.contains(Modifiers::ALT)
    }

    /// Check if Shift modifier is held.
    #[must_use]
    pub const fn shift(&self) -> bool {
        self.modifiers.contains(Modifiers::SHIFT)
    }

    /// Check if Super/Meta/Cmd modifier is held.
    #[must_use]
    pub const fn super_key(&self) -> bool {
        self.modifiers.contains(Modifiers::SUPER)
    }
}

/// Key codes for keyboard events.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum KeyCode {
    /// A regular character key.
    Char(char),

    /// Enter/Return key.
    Enter,

    /// Escape key.
    Escape,

    /// Backspace key.
    Backspace,

    /// Tab key.
    Tab,

    /// Shift+Tab (back-tab).
    BackTab,

    /// Delete key.
    Delete,

    /// Insert key.
    Insert,

    /// Home key.
    Home,

    /// End key.
    End,

    /// Page Up key.
    PageUp,

    /// Page Down key.
    PageDown,

    /// Up arrow key.
    Up,

    /// Down arrow key.
    Down,

    /// Left arrow key.
    Left,

    /// Right arrow key.
    Right,

    /// Function key (F1-F24).
    F(u8),

    /// Null character (Ctrl+Space or Ctrl+@).
    Null,

    /// Media key: Play/Pause.
    MediaPlayPause,

    /// Media key: Stop.
    MediaStop,

    /// Media key: Next track.
    MediaNextTrack,

    /// Media key: Previous track.
    MediaPrevTrack,
}

/// The type of key event.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
pub enum KeyEventKind {
    /// Key was pressed (default when not distinguishable).
    #[default]
    Press,

    /// Key is being held (repeat event).
    Repeat,

    /// Key was released.
    Release,
}

bitflags! {
    /// Modifier keys that can be held during a key event.
    #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
    pub struct Modifiers: u8 {
        /// No modifiers.
        const NONE  = 0b0000;
        /// Shift key.
        const SHIFT = 0b0001;
        /// Alt/Option key.
        const ALT   = 0b0010;
        /// Control key.
        const CTRL  = 0b0100;
        /// Super/Meta/Command key.
        const SUPER = 0b1000;
    }
}

impl Default for Modifiers {
    fn default() -> Self {
        Self::NONE
    }
}

/// A mouse event.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct MouseEvent {
    /// The type of mouse event.
    pub kind: MouseEventKind,

    /// X coordinate (0-indexed, leftmost column is 0).
    pub x: u16,

    /// Y coordinate (0-indexed, topmost row is 0).
    pub y: u16,

    /// Modifier keys held during the event.
    pub modifiers: Modifiers,
}

impl MouseEvent {
    /// Create a new mouse event.
    #[must_use]
    pub const fn new(kind: MouseEventKind, x: u16, y: u16) -> Self {
        Self {
            kind,
            x,
            y,
            modifiers: Modifiers::NONE,
        }
    }

    /// Create a mouse event with modifiers.
    #[must_use]
    pub const fn with_modifiers(mut self, modifiers: Modifiers) -> Self {
        self.modifiers = modifiers;
        self
    }

    /// Get the position as a tuple.
    #[must_use]
    pub const fn position(&self) -> (u16, u16) {
        (self.x, self.y)
    }
}

/// The type of mouse event.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum MouseEventKind {
    /// Mouse button pressed down.
    Down(MouseButton),

    /// Mouse button released.
    Up(MouseButton),

    /// Mouse dragged while button held.
    Drag(MouseButton),

    /// Mouse moved (no button pressed).
    Moved,

    /// Mouse wheel scrolled up.
    ScrollUp,

    /// Mouse wheel scrolled down.
    ScrollDown,

    /// Mouse wheel scrolled left (horizontal scroll).
    ScrollLeft,

    /// Mouse wheel scrolled right (horizontal scroll).
    ScrollRight,
}

/// Mouse button identifiers.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum MouseButton {
    /// Left mouse button.
    Left,

    /// Right mouse button.
    Right,

    /// Middle mouse button (scroll wheel click).
    Middle,
}

/// A paste event from bracketed paste mode.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct PasteEvent {
    /// The pasted text content.
    pub text: String,

    /// True if this came from bracketed paste mode.
    ///
    /// When true, the text was received atomically and should be
    /// treated as a single paste operation rather than individual
    /// key presses.
    pub bracketed: bool,
}

impl PasteEvent {
    /// Create a new paste event.
    #[must_use]
    pub fn new(text: impl Into<String>, bracketed: bool) -> Self {
        Self {
            text: text.into(),
            bracketed,
        }
    }

    /// Create a bracketed paste event (the common case).
    #[must_use]
    pub fn bracketed(text: impl Into<String>) -> Self {
        Self::new(text, true)
    }
}

/// A clipboard event from OSC 52 response.
///
/// This is optional and may not be supported by all terminals.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ClipboardEvent {
    /// The clipboard content (decoded from base64).
    pub content: String,

    /// The source of the clipboard content.
    pub source: ClipboardSource,
}

impl ClipboardEvent {
    /// Create a new clipboard event.
    #[must_use]
    pub fn new(content: impl Into<String>, source: ClipboardSource) -> Self {
        Self {
            content: content.into(),
            source,
        }
    }
}

/// The source of clipboard content.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
pub enum ClipboardSource {
    /// Clipboard content from OSC 52 protocol.
    Osc52,

    /// Unknown or unspecified source.
    #[default]
    Unknown,
}

#[cfg(all(not(target_arch = "wasm32"), feature = "crossterm"))]
fn map_crossterm_event_internal(event: cte::Event) -> Option<Event> {
    match event {
        cte::Event::Key(key) => map_key_event(key).map(Event::Key),
        cte::Event::Mouse(mouse) => Some(Event::Mouse(map_mouse_event(mouse))),
        cte::Event::Resize(width, height) => Some(Event::Resize { width, height }),
        cte::Event::Paste(text) => Some(Event::Paste(PasteEvent::bracketed(text))),
        cte::Event::FocusGained => Some(Event::Focus(true)),
        cte::Event::FocusLost => Some(Event::Focus(false)),
    }
}

#[cfg(all(not(target_arch = "wasm32"), feature = "crossterm"))]
fn map_key_event(event: cte::KeyEvent) -> Option<KeyEvent> {
    let code = map_key_code(event.code)?;
    let modifiers = map_modifiers(event.modifiers);
    let kind = map_key_kind(event.kind);
    Some(KeyEvent {
        code,
        modifiers,
        kind,
    })
}

#[cfg(all(not(target_arch = "wasm32"), feature = "crossterm"))]
fn map_key_kind(kind: cte::KeyEventKind) -> KeyEventKind {
    match kind {
        cte::KeyEventKind::Press => KeyEventKind::Press,
        cte::KeyEventKind::Repeat => KeyEventKind::Repeat,
        cte::KeyEventKind::Release => KeyEventKind::Release,
    }
}

#[cfg(all(not(target_arch = "wasm32"), feature = "crossterm"))]
pub(crate) fn map_key_code(code: cte::KeyCode) -> Option<KeyCode> {
    match code {
        cte::KeyCode::Backspace => Some(KeyCode::Backspace),
        cte::KeyCode::Enter => Some(KeyCode::Enter),
        cte::KeyCode::Left => Some(KeyCode::Left),
        cte::KeyCode::Right => Some(KeyCode::Right),
        cte::KeyCode::Up => Some(KeyCode::Up),
        cte::KeyCode::Down => Some(KeyCode::Down),
        cte::KeyCode::Home => Some(KeyCode::Home),
        cte::KeyCode::End => Some(KeyCode::End),
        cte::KeyCode::PageUp => Some(KeyCode::PageUp),
        cte::KeyCode::PageDown => Some(KeyCode::PageDown),
        cte::KeyCode::Tab => Some(KeyCode::Tab),
        cte::KeyCode::BackTab => Some(KeyCode::BackTab),
        cte::KeyCode::Delete => Some(KeyCode::Delete),
        cte::KeyCode::Insert => Some(KeyCode::Insert),
        cte::KeyCode::F(n) => Some(KeyCode::F(n)),
        cte::KeyCode::Char(c) => Some(KeyCode::Char(c)),
        cte::KeyCode::Null => Some(KeyCode::Null),
        cte::KeyCode::Esc => Some(KeyCode::Escape),
        cte::KeyCode::Media(media) => map_media_key(media),
        _ => None,
    }
}

#[cfg(all(not(target_arch = "wasm32"), feature = "crossterm"))]
fn map_media_key(code: cte::MediaKeyCode) -> Option<KeyCode> {
    match code {
        cte::MediaKeyCode::Play | cte::MediaKeyCode::Pause | cte::MediaKeyCode::PlayPause => {
            Some(KeyCode::MediaPlayPause)
        }
        cte::MediaKeyCode::Stop => Some(KeyCode::MediaStop),
        cte::MediaKeyCode::TrackNext => Some(KeyCode::MediaNextTrack),
        cte::MediaKeyCode::TrackPrevious => Some(KeyCode::MediaPrevTrack),
        _ => None,
    }
}

#[cfg(all(not(target_arch = "wasm32"), feature = "crossterm"))]
fn map_modifiers(modifiers: cte::KeyModifiers) -> Modifiers {
    let mut mapped = Modifiers::NONE;
    if modifiers.contains(cte::KeyModifiers::SHIFT) {
        mapped |= Modifiers::SHIFT;
    }
    if modifiers.contains(cte::KeyModifiers::ALT) {
        mapped |= Modifiers::ALT;
    }
    if modifiers.contains(cte::KeyModifiers::CONTROL) {
        mapped |= Modifiers::CTRL;
    }
    if modifiers.contains(cte::KeyModifiers::SUPER)
        || modifiers.contains(cte::KeyModifiers::HYPER)
        || modifiers.contains(cte::KeyModifiers::META)
    {
        mapped |= Modifiers::SUPER;
    }
    mapped
}

#[cfg(all(not(target_arch = "wasm32"), feature = "crossterm"))]
fn map_mouse_event(event: cte::MouseEvent) -> MouseEvent {
    let kind = match event.kind {
        cte::MouseEventKind::Down(button) => MouseEventKind::Down(map_mouse_button(button)),
        cte::MouseEventKind::Up(button) => MouseEventKind::Up(map_mouse_button(button)),
        cte::MouseEventKind::Drag(button) => MouseEventKind::Drag(map_mouse_button(button)),
        cte::MouseEventKind::Moved => MouseEventKind::Moved,
        cte::MouseEventKind::ScrollUp => MouseEventKind::ScrollUp,
        cte::MouseEventKind::ScrollDown => MouseEventKind::ScrollDown,
        cte::MouseEventKind::ScrollLeft => MouseEventKind::ScrollLeft,
        cte::MouseEventKind::ScrollRight => MouseEventKind::ScrollRight,
    };

    MouseEvent::new(kind, event.column, event.row).with_modifiers(map_modifiers(event.modifiers))
}

#[cfg(all(not(target_arch = "wasm32"), feature = "crossterm"))]
fn map_mouse_button(button: cte::MouseButton) -> MouseButton {
    match button {
        cte::MouseButton::Left => MouseButton::Left,
        cte::MouseButton::Right => MouseButton::Right,
        cte::MouseButton::Middle => MouseButton::Middle,
    }
}

#[cfg(all(test, not(target_arch = "wasm32"), feature = "crossterm"))]
mod tests {
    use super::*;
    use crossterm::event as ct_event;

    #[test]
    fn key_event_is_char() {
        let event = KeyEvent::new(KeyCode::Char('q'));
        assert!(event.is_char('q'));
        assert!(!event.is_char('x'));
    }

    #[test]
    fn key_event_modifiers() {
        let event = KeyEvent::new(KeyCode::Char('c')).with_modifiers(Modifiers::CTRL);
        assert!(event.ctrl());
        assert!(!event.alt());
        assert!(!event.shift());
        assert!(!event.super_key());
    }

    #[test]
    fn key_event_combined_modifiers() {
        let event =
            KeyEvent::new(KeyCode::Char('s')).with_modifiers(Modifiers::CTRL | Modifiers::SHIFT);
        assert!(event.ctrl());
        assert!(event.shift());
        assert!(!event.alt());
    }

    #[test]
    fn key_event_kind() {
        let press = KeyEvent::new(KeyCode::Enter);
        assert_eq!(press.kind, KeyEventKind::Press);

        let release = press.with_kind(KeyEventKind::Release);
        assert_eq!(release.kind, KeyEventKind::Release);
    }

    #[test]
    fn mouse_event_position() {
        let event = MouseEvent::new(MouseEventKind::Down(MouseButton::Left), 10, 20);
        assert_eq!(event.position(), (10, 20));
        assert_eq!(event.x, 10);
        assert_eq!(event.y, 20);
    }

    #[test]
    fn mouse_event_with_modifiers() {
        let event = MouseEvent::new(MouseEventKind::Moved, 0, 0).with_modifiers(Modifiers::ALT);
        assert_eq!(event.modifiers, Modifiers::ALT);
    }

    #[test]
    fn paste_event_creation() {
        let paste = PasteEvent::bracketed("hello world");
        assert_eq!(paste.text, "hello world");
        assert!(paste.bracketed);
    }

    #[test]
    fn clipboard_event_creation() {
        let clip = ClipboardEvent::new("copied text", ClipboardSource::Osc52);
        assert_eq!(clip.content, "copied text");
        assert_eq!(clip.source, ClipboardSource::Osc52);
    }

    #[test]
    fn event_variants() {
        // Test that all event variants can be created
        let _key = Event::Key(KeyEvent::new(KeyCode::Char('a')));
        let _mouse = Event::Mouse(MouseEvent::new(
            MouseEventKind::Down(MouseButton::Left),
            0,
            0,
        ));
        let _resize = Event::Resize {
            width: 80,
            height: 24,
        };
        let _paste = Event::Paste(PasteEvent::bracketed("test"));
        let _focus = Event::Focus(true);
        let _clipboard = Event::Clipboard(ClipboardEvent::new("test", ClipboardSource::Unknown));
        let _tick = Event::Tick;
    }

    #[test]
    fn modifiers_default() {
        assert_eq!(Modifiers::default(), Modifiers::NONE);
    }

    #[test]
    fn key_event_kind_default() {
        assert_eq!(KeyEventKind::default(), KeyEventKind::Press);
    }

    #[test]
    fn clipboard_source_default() {
        assert_eq!(ClipboardSource::default(), ClipboardSource::Unknown);
    }

    #[test]
    fn function_keys() {
        let f1 = KeyEvent::new(KeyCode::F(1));
        let f12 = KeyEvent::new(KeyCode::F(12));
        assert_eq!(f1.code, KeyCode::F(1));
        assert_eq!(f12.code, KeyCode::F(12));
    }

    #[test]
    fn event_is_clone_and_eq() {
        let event = Event::Key(KeyEvent::new(KeyCode::Char('x')));
        let cloned = event.clone();
        assert_eq!(event, cloned);
    }

    // -- Crossterm mapping tests --

    #[test]
    fn map_modifiers_ctrl() {
        let mapped = map_modifiers(ct_event::KeyModifiers::CONTROL);
        assert!(mapped.contains(Modifiers::CTRL));
        assert!(!mapped.contains(Modifiers::SHIFT));
    }

    #[test]
    fn map_modifiers_alt() {
        let mapped = map_modifiers(ct_event::KeyModifiers::ALT);
        assert!(mapped.contains(Modifiers::ALT));
    }

    #[test]
    fn map_modifiers_super_variants() {
        let super_mapped = map_modifiers(ct_event::KeyModifiers::SUPER);
        assert!(super_mapped.contains(Modifiers::SUPER));

        let hyper_mapped = map_modifiers(ct_event::KeyModifiers::HYPER);
        assert!(hyper_mapped.contains(Modifiers::SUPER));

        let meta_mapped = map_modifiers(ct_event::KeyModifiers::META);
        assert!(meta_mapped.contains(Modifiers::SUPER));
    }

    #[test]
    fn map_modifiers_combined() {
        let combined = ct_event::KeyModifiers::SHIFT | ct_event::KeyModifiers::CONTROL;
        let mapped = map_modifiers(combined);
        assert!(mapped.contains(Modifiers::SHIFT));
        assert!(mapped.contains(Modifiers::CTRL));
        assert!(!mapped.contains(Modifiers::ALT));
    }

    #[test]
    fn map_mouse_button_all() {
        assert_eq!(
            map_mouse_button(ct_event::MouseButton::Left),
            MouseButton::Left
        );
        assert_eq!(
            map_mouse_button(ct_event::MouseButton::Right),
            MouseButton::Right
        );
        assert_eq!(
            map_mouse_button(ct_event::MouseButton::Middle),
            MouseButton::Middle
        );
    }

    #[test]
    fn map_mouse_event_down() {
        let ct_event = ct_event::MouseEvent {
            kind: ct_event::MouseEventKind::Down(ct_event::MouseButton::Left),
            column: 10,
            row: 5,
            modifiers: ct_event::KeyModifiers::NONE,
        };
        let mapped = map_mouse_event(ct_event);
        assert!(matches!(
            mapped.kind,
            MouseEventKind::Down(MouseButton::Left)
        ));
        assert_eq!(mapped.x, 10);
        assert_eq!(mapped.y, 5);
    }

    #[test]
    fn map_mouse_event_up() {
        let ct_event = ct_event::MouseEvent {
            kind: ct_event::MouseEventKind::Up(ct_event::MouseButton::Right),
            column: 20,
            row: 15,
            modifiers: ct_event::KeyModifiers::NONE,
        };
        let mapped = map_mouse_event(ct_event);
        assert!(matches!(
            mapped.kind,
            MouseEventKind::Up(MouseButton::Right)
        ));
        assert_eq!(mapped.x, 20);
        assert_eq!(mapped.y, 15);
    }

    #[test]
    fn map_mouse_event_drag() {
        let ct_event = ct_event::MouseEvent {
            kind: ct_event::MouseEventKind::Drag(ct_event::MouseButton::Middle),
            column: 5,
            row: 10,
            modifiers: ct_event::KeyModifiers::NONE,
        };
        let mapped = map_mouse_event(ct_event);
        assert!(matches!(
            mapped.kind,
            MouseEventKind::Drag(MouseButton::Middle)
        ));
    }

    #[test]
    fn map_mouse_event_moved() {
        let ct_event = ct_event::MouseEvent {
            kind: ct_event::MouseEventKind::Moved,
            column: 0,
            row: 0,
            modifiers: ct_event::KeyModifiers::NONE,
        };
        let mapped = map_mouse_event(ct_event);
        assert!(matches!(mapped.kind, MouseEventKind::Moved));
    }

    #[test]
    fn map_mouse_event_scroll() {
        let scroll_up = ct_event::MouseEvent {
            kind: ct_event::MouseEventKind::ScrollUp,
            column: 0,
            row: 0,
            modifiers: ct_event::KeyModifiers::NONE,
        };
        let scroll_down = ct_event::MouseEvent {
            kind: ct_event::MouseEventKind::ScrollDown,
            column: 0,
            row: 0,
            modifiers: ct_event::KeyModifiers::NONE,
        };
        let scroll_left = ct_event::MouseEvent {
            kind: ct_event::MouseEventKind::ScrollLeft,
            column: 0,
            row: 0,
            modifiers: ct_event::KeyModifiers::NONE,
        };
        let scroll_right = ct_event::MouseEvent {
            kind: ct_event::MouseEventKind::ScrollRight,
            column: 0,
            row: 0,
            modifiers: ct_event::KeyModifiers::NONE,
        };

        assert!(matches!(
            map_mouse_event(scroll_up).kind,
            MouseEventKind::ScrollUp
        ));
        assert!(matches!(
            map_mouse_event(scroll_down).kind,
            MouseEventKind::ScrollDown
        ));
        assert!(matches!(
            map_mouse_event(scroll_left).kind,
            MouseEventKind::ScrollLeft
        ));
        assert!(matches!(
            map_mouse_event(scroll_right).kind,
            MouseEventKind::ScrollRight
        ));
    }

    #[test]
    fn map_mouse_event_modifiers() {
        let ct_event = ct_event::MouseEvent {
            kind: ct_event::MouseEventKind::Down(ct_event::MouseButton::Left),
            column: 0,
            row: 0,
            modifiers: ct_event::KeyModifiers::SHIFT | ct_event::KeyModifiers::ALT,
        };
        let mapped = map_mouse_event(ct_event);
        assert!(mapped.modifiers.contains(Modifiers::SHIFT));
        assert!(mapped.modifiers.contains(Modifiers::ALT));
    }

    #[test]
    fn map_key_event_char() {
        let ct_event = ct_event::KeyEvent {
            code: ct_event::KeyCode::Char('x'),
            modifiers: ct_event::KeyModifiers::CONTROL,
            kind: ct_event::KeyEventKind::Press,
            state: ct_event::KeyEventState::NONE,
        };
        let mapped = map_key_event(ct_event).expect("should map");
        assert_eq!(mapped.code, KeyCode::Char('x'));
        assert!(mapped.modifiers.contains(Modifiers::CTRL));
        assert_eq!(mapped.kind, KeyEventKind::Press);
    }

    #[test]
    fn map_key_event_function_key() {
        let ct_event = ct_event::KeyEvent {
            code: ct_event::KeyCode::F(5),
            modifiers: ct_event::KeyModifiers::NONE,
            kind: ct_event::KeyEventKind::Press,
            state: ct_event::KeyEventState::NONE,
        };
        let mapped = map_key_event(ct_event).expect("should map");
        assert_eq!(mapped.code, KeyCode::F(5));
    }

    #[test]
    fn map_crossterm_event_key() {
        let ct_event = ct_event::Event::Key(ct_event::KeyEvent {
            code: ct_event::KeyCode::Enter,
            modifiers: ct_event::KeyModifiers::NONE,
            kind: ct_event::KeyEventKind::Press,
            state: ct_event::KeyEventState::NONE,
        });
        let mapped = map_crossterm_event_internal(ct_event).expect("should map");
        assert!(matches!(mapped, Event::Key(_)));
    }

    #[test]
    fn map_crossterm_event_mouse() {
        let ct_event = ct_event::Event::Mouse(ct_event::MouseEvent {
            kind: ct_event::MouseEventKind::Down(ct_event::MouseButton::Left),
            column: 10,
            row: 5,
            modifiers: ct_event::KeyModifiers::NONE,
        });
        let mapped = map_crossterm_event_internal(ct_event).expect("should map");
        assert!(matches!(mapped, Event::Mouse(_)));
    }

    #[test]
    fn map_crossterm_event_resize() {
        let ct_event = ct_event::Event::Resize(80, 24);
        let mapped = map_crossterm_event_internal(ct_event).expect("should map");
        assert!(matches!(
            mapped,
            Event::Resize {
                width: 80,
                height: 24
            }
        ));
    }

    #[test]
    fn map_crossterm_event_paste() {
        let ct_event = ct_event::Event::Paste("hello world".to_string());
        let mapped = map_crossterm_event_internal(ct_event).expect("should map");
        match mapped {
            Event::Paste(paste) => assert_eq!(paste.text, "hello world"),
            _ => panic!("expected Paste event"),
        }
    }

    #[test]
    fn map_crossterm_event_focus() {
        let gained = ct_event::Event::FocusGained;
        let lost = ct_event::Event::FocusLost;

        assert!(matches!(
            map_crossterm_event_internal(gained),
            Some(Event::Focus(true))
        ));
        assert!(matches!(
            map_crossterm_event_internal(lost),
            Some(Event::Focus(false))
        ));
    }

    #[test]
    fn map_key_kind_repeat_and_release() {
        assert_eq!(
            map_key_kind(ct_event::KeyEventKind::Repeat),
            KeyEventKind::Repeat
        );
        assert_eq!(
            map_key_kind(ct_event::KeyEventKind::Release),
            KeyEventKind::Release
        );
    }

    #[test]
    fn map_key_code_escape() {
        assert_eq!(map_key_code(ct_event::KeyCode::Esc), Some(KeyCode::Escape));
    }

    #[test]
    fn map_key_code_unmapped_returns_none() {
        // These variants exist in crossterm but are intentionally not mapped into ftui.
        assert_eq!(map_key_code(ct_event::KeyCode::CapsLock), None);
        assert_eq!(map_key_code(ct_event::KeyCode::ScrollLock), None);
        assert_eq!(map_key_code(ct_event::KeyCode::NumLock), None);
        assert_eq!(map_key_code(ct_event::KeyCode::PrintScreen), None);
        assert_eq!(map_key_code(ct_event::KeyCode::Pause), None);
        assert_eq!(map_key_code(ct_event::KeyCode::Menu), None);
        assert_eq!(map_key_code(ct_event::KeyCode::KeypadBegin), None);
        assert_eq!(
            map_key_code(ct_event::KeyCode::Modifier(
                ct_event::ModifierKeyCode::LeftShift
            )),
            None
        );
    }

    #[test]
    fn map_media_key_known_and_unknown_variants() {
        // Known mapped variants.
        assert_eq!(
            map_media_key(ct_event::MediaKeyCode::Play),
            Some(KeyCode::MediaPlayPause)
        );
        assert_eq!(
            map_media_key(ct_event::MediaKeyCode::Pause),
            Some(KeyCode::MediaPlayPause)
        );
        assert_eq!(
            map_media_key(ct_event::MediaKeyCode::PlayPause),
            Some(KeyCode::MediaPlayPause)
        );
        assert_eq!(
            map_media_key(ct_event::MediaKeyCode::TrackNext),
            Some(KeyCode::MediaNextTrack)
        );
        assert_eq!(
            map_media_key(ct_event::MediaKeyCode::TrackPrevious),
            Some(KeyCode::MediaPrevTrack)
        );
        assert_eq!(
            map_media_key(ct_event::MediaKeyCode::Stop),
            Some(KeyCode::MediaStop)
        );

        // A representative unmapped variant.
        assert_eq!(map_media_key(ct_event::MediaKeyCode::Reverse), None);
    }

    #[test]
    fn from_crossterm_returns_none_for_unmapped_keys() {
        let ct_event = ct_event::Event::Key(ct_event::KeyEvent {
            code: ct_event::KeyCode::CapsLock,
            modifiers: ct_event::KeyModifiers::NONE,
            kind: ct_event::KeyEventKind::Press,
            state: ct_event::KeyEventState::NONE,
        });

        assert_eq!(Event::from_crossterm(ct_event), None);
    }
}