nimterm/input

This page is generated from the module’s exported API and ## documentation comments.

Shared terminal input decoder.

Reads bytes from term (posix raw stdin) and turns them into keys / mouse events.

Types

ByteReader

ByteReader = proc (timeoutMs: int): int {.closure.}

View source

InputDecoder

InputDecoder = object

View source

MouseKind

MouseKind = enum
  mouseNone, mousePress,    ## left button down
  mouseRelease,             ## left button up
  mouseDrag                  ## motion while left button held

View source

FocusKind

FocusKind = enum
  focusNone, focusIn, focusOut

View source

InputEvent

InputEvent = object
  key*: Key
  ch*: char                  ## ASCII keyChar; prefer `text` for insert
  text*: string              ## UTF-8 rune or a whole paste
  scrollDelta*: int          ## +N scroll up (older), -N scroll down (newer)
  resized*: bool
  mouse*: MouseKind
  button*: UiMouseButton
  shift*: bool
  alt*: bool
  ctrl*: bool
  mouseX*: int               ## 0-based column
  mouseY*: int               ## 0-based row
  focus*: FocusKind

View source

Procedures

normalizePasteText

CR LF / CR → LF so a paste never submits.

proc normalizePasteText(s: string): string {.raises: [], tags: [], forbids: [].}

Returns: string.

Arguments

Name	Type	Default
s	string

View source

isModifiedPaste

Ctrl/Cmd+V as xterm modifyOtherKeys (27;5;118~) or CSI-u (118;5u).

proc isModifiedPaste(seq: string): bool {.raises: [], tags: [], forbids: [].}

Returns: bool.

Arguments

Name	Type	Default
seq	string

View source

decodeInput

proc decodeInput(b: int; readNext: ByteReader): InputEvent {.
    raises: [Exception], tags: [RootEffect], forbids: [].}

Returns: InputEvent.

Arguments

Name	Type	Default
b	int
readNext	ByteReader

View source

feed

proc feed(decoder: var InputDecoder; bytes: string) {.raises: [], tags: [],
    forbids: [].}

Arguments

Name	Type	Default
decoder	var InputDecoder
bytes	string

View source

pending

proc pending(decoder: InputDecoder): bool {.raises: [], tags: [], forbids: [].}

Returns: bool.

Arguments

Name	Type	Default
decoder	InputDecoder

View source

escapeWaitMs

proc escapeWaitMs(decoder: InputDecoder; nowMs: int64; timeoutMs = 15): int {.
    raises: [], tags: [], forbids: [].}

Returns: int.

Arguments

Name	Type	Default
decoder	InputDecoder
nowMs	int64
timeoutMs	inferred	15

View source

nextEvent

proc nextEvent(decoder: var InputDecoder; nowMs: int64; escapeTimeoutMs = 15): InputEvent {.
    raises: [Exception], tags: [RootEffect], forbids: [].}

Returns: InputEvent.

Arguments

Name	Type	Default
decoder	var InputDecoder
nowMs	int64
escapeTimeoutMs	inferred	15

View source

toUiEvent

proc toUiEvent(input: InputEvent; width = 0; height = 0): UiEvent {.raises: [],
    tags: [], forbids: [].}

Returns: UiEvent.

Arguments

Name	Type	Default
input	InputEvent
width	inferred	0
height	inferred	0

View source