class Termisu::Input::Parser

• Termisu::Input::Parser
• Reference
• Object

Overview

Input parser for terminal escape sequences.

Parses raw terminal input into structured Event objects. Supports CSI sequences (arrows, function keys, nav), SS3 sequences, Alt+key combinations, Ctrl+key combinations, and mouse events.

Example:

parser = Termisu::Input::Parser.new(reader)
if event = parser.poll_event(1000)
  puts "Got event: #{event}"
end

Defined in:

termisu/input/parser.cr

Constant Summary

CSI_KEYS = {'A' => Key::Up, 'B' => Key::Down, 'C' => Key::Right, 'D' => Key::Left, 'H' => Key::Home, 'F' => Key::End, 'Z' => Key::BackTab, 'P' => Key::F1, 'Q' => Key::F2, 'R' => Key::F3, 'S' => Key::F4}

CSI final character to Key mapping.

ESCAPE_TIMEOUT_MS = 50

Timeout in milliseconds to distinguish ESC key from escape sequences. 50ms matches termbox/tcell behavior.

KITTY_CODEPOINTS = {27 => Key::Escape, 13 => Key::Enter, 9 => Key::Tab, 127 => Key::Backspace, 8 => Key::Backspace, 57358 => Key::CapsLock, 57359 => Key::ScrollLock, 57360 => Key::NumLock, 57361 => Key::PrintScreen, 57362 => Key::Pause, 57376 => Key::F13, 57377 => Key::F14, 57378 => Key::F15, 57379 => Key::F16, 57380 => Key::F17, 57381 => Key::F18, 57382 => Key::F19, 57383 => Key::F20, 57384 => Key::F21, 57385 => Key::F22, 57386 => Key::F23, 57387 => Key::F24}

Kitty protocol codepoint to Key mapping for special keys. These codepoints are specific to the Kitty keyboard protocol.

LINUX_CONSOLE_KEYS = {"[[A" => Key::F1, "[[B" => Key::F2, "[[C" => Key::F3, "[[D" => Key::F4, "[[E" => Key::F5}

Linux console function keys use \e[[A through \e[[E.

Log = Termisu::Logs::Input

MAX_SEQUENCE_LENGTH = 32

Maximum escape sequence length before giving up.

MOUSE_MOTION_BIT = 32

Mouse protocol bit mask for motion events (bit 5). When set, indicates mouse moved while button was held.

SS3_KEYS = {'P' => Key::F1, 'Q' => Key::F2, 'R' => Key::F3, 'S' => Key::F4, 'A' => Key::Up, 'B' => Key::Down, 'C' => Key::Right, 'D' => Key::Left, 'H' => Key::Home, 'F' => Key::End}

SS3 final character to Key mapping (\eO...).

TILDE_KEYS = {1 => Key::Home, 2 => Key::Insert, 3 => Key::Delete, 4 => Key::End, 5 => Key::PageUp, 6 => Key::PageDown, 7 => Key::Home, 8 => Key::End, 11 => Key::F1, 12 => Key::F2, 13 => Key::F3, 14 => Key::F4, 15 => Key::F5, 17 => Key::F6, 18 => Key::F7, 19 => Key::F8, 20 => Key::F9, 21 => Key::F10, 23 => Key::F11, 24 => Key::F12, 25 => Key::F13, 26 => Key::F14, 28 => Key::F15, 29 => Key::F16, 31 => Key::F17, 32 => Key::F18, 33 => Key::F19, 34 => Key::F20}

Tilde sequence code to Key mapping (\e[N~ format).

Maps numeric codes from CSI tilde sequences to keys. Codes 1-8 are navigation keys, 11-24 are function keys F1-F12. Codes 25-34 are extended function keys F13-F20 (rarely used).

Note: Some codes are skipped (9-10, 16, 22, 27, 30) for historical terminal compatibility reasons. Codes 1/7 and 4/8 are duplicates (Home/End) because different terminals use different codes.

Reference: XTerm ctlseqs, VT220 sequences.

Constructors

• .new(reader : Reader)

Instance Method Summary

• #poll_event(timeout_ms : Int32 = -1) : Event::Any | Nil

  Polls for an input event with optional timeout.

Constructor Detail

Instance Method Detail