0.17.0-SNAPSHOT

mosaic-terminal/com.jakewharton.mosaic.terminal/TerminalReader

TerminalReader

class TerminalReader : AutoCloseable

Properties

val events: ReceiveChannel<Event>

Events read as a result of calls to tryReadEvents.

kittyDisambiguateEscapeCodes

var kittyDisambiguateEscapeCodes: Boolean

Indicate whether Kitty's escape code disambiguation progressive-enhancement is enabled.

xtermExtendedUtf8Mouse

var xtermExtendedUtf8Mouse: Boolean

Indicate whether XTerm's UTF-8 extended mouse is enabled (mode 1005).

Functions

open override fun close()

Free the resources associated with this reader.

fun currentSize(): ResizeEvent

Synchronously query for the current terminal size.

fun enableRawMode()

Save the current terminal settings and enter "raw" mode.

enableWindowResizeEvents

fun enableWindowResizeEvents()

Write ResizeEvents into events using platform-specific window monitoring.

fun interrupt()

fun runParseLoop()

Perform a blocking read from stdin to try and parse events. Calls to this function are not guaranteed to read an event, nor are they guaranteed to read only one event. Events which are read will be placed into events.