API reference — events

All types live in core.term.event.

Event

public type Event is
    | Key(KeyEvent)
    | Mouse(MouseEvent)
    | Resize(ResizeEvent)
    | Paste(Text)
    | FocusGained
    | FocusLost;

implement Event {
    fn is_key(&self)    -> Bool;
    fn is_mouse(&self)  -> Bool;
    fn is_resize(&self) -> Bool;
    fn as_key(&self)    -> Maybe<KeyEvent>;
    fn as_mouse(&self)  -> Maybe<MouseEvent>;
}

KeyEvent

public type KeyEvent is {
    code: KeyCode,
    modifiers: Modifiers,
    kind: KeyEventKind,
};

public type KeyEventKind is Press | Release | Repeat;

implement KeyEvent {
    fn press(code: KeyCode) -> KeyEvent;
    fn with_mods(code: KeyCode, mods: Modifiers) -> KeyEvent;
    fn is_ctrl_c(&self) -> Bool;
    fn is_escape(&self) -> Bool;
    fn is_enter(&self)  -> Bool;
}

KeyCode

public type KeyCode is
    | Char(Char)
    | Fn(Int)               // F1..F35 — the variant is `Fn`, not `F`
    | Backspace | Enter  | Tab  | BackTab
    | Escape                // not `Esc`
    | Space | Delete | Insert
    | Left | Right | Up | Down
    | Home | End  | PageUp | PageDown
    | CapsLock | NumLock | ScrollLock
    | PrintScreen | Pause  | Menu
    | KeypadBegin           // keypad 5 with numlock off
    | Null;                 // Ctrl+Space or a NUL byte

There is no Media(MediaKey) and no Modifier(ModifierKey) — the media and modifier keys the Kitty protocol reports are not modelled here. KeypadBegin and Null are real and were missing.

Modifiers

public type Modifiers is { bits: UInt8 };

implement Modifiers {
    fn contains(&self, flag: Modifiers) -> Bool;
    fn union(self, other: Modifiers)      -> Modifiers;
    fn difference(self, other: Modifiers) -> Modifiers;
    fn is_empty(&self) -> Bool;           // `is_empty`, not `empty`
    fn to_text(&self) -> Text;
}

constant
Modifiers.NONE
Modifiers.SHIFT	Modifiers.CTRL
Modifiers.ALT	Modifiers.SUPER
Modifiers.HYPER	Modifiers.META

MouseEvent

public type MouseEvent is {
    kind: MouseEventKind,
    column: Int,
    row: Int,
    modifiers: Modifiers,
};

public type MouseEventKind is
    | Down(MouseButton) | Up(MouseButton) | Drag(MouseButton)
    | Moved
    | ScrollUp | ScrollDown | ScrollLeft | ScrollRight;

public type MouseButton is Left | Right | Middle;

EventStream

public type EventStream is { ... };

EventStream.new(fd: FileDesc) -> EventStream
EventStream.stdin() -> EventStream
    fn poll(&mut self, timeout: Duration) -> Maybe<Event>
    fn read(&mut self) -> IoResult<Event>
    fn try_read(&mut self) -> Maybe<Event>
    fn drain_pending(&mut self) -> List<Event>
    fn reset(&mut self)

AsyncEventStream

public type AsyncEventStream is { ... };

AsyncEventStream.new(fd: FileDesc) -> AsyncEventStream
AsyncEventStream.stdin() -> AsyncEventStream

implement AsyncIterator for AsyncEventStream {
    type Item = Event;
    async fn next(&mut self) -> Maybe<Event>
}

Usage:

let mut events = AsyncEventStream.stdin();
for await event in &mut events {
    match event { Event.Key(ke) => ..., _ => ... }
}

Mouse protocol helpers

mount core.term.event.mouse.*;

fn parse_sgr_mouse(params: &List<Int>, final_byte: Byte) -> Maybe<MouseEvent>;
fn mouse_enable_sequence()  -> Text;   // enable tracking (X10 + Any + SGR)
fn mouse_disable_sequence() -> Text;