ketraterm-core/io.github.ketraterm.core.api/TerminalReader

TerminalReader

Zero-allocation read contract for the terminal buffer.

Exposes viewport-relative state plus random-access helpers for the currently active screen buffer. Out-of-bounds probes never throw; they return stable sentinel values so renderers can remain branch-light.

Inheritors

TerminalBuffer

Properties

cursorCol

abstract val cursorCol: Int

Active cursor column in zero-based viewport coordinates.

cursorRow

abstract val cursorRow: Int

Active cursor row in zero-based viewport coordinates.

height

abstract val height: Int

Current viewport height in rows.

historySize

abstract val historySize: Int

Number of retained off-screen history lines in the active buffer.

iconTitle

abstract val iconTitle: String

Active xterm icon title.

palette

abstract val palette: TerminalColorPalette

Current immutable effective palette, including application color overrides. Reading retains the existing object without allocating or reading a render frame. Synchronize with terminal mutations before reading; a retained palette remains safe to use after releasing that synchronization.

width

abstract val width: Int

Current viewport width in cells.

windowTitle

abstract val windowTitle: String

Active xterm window title.