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

TerminalModeReader

interface TerminalModeReader : TerminalInputState

Read-only public access to durable terminal mode state.

Intended for parser, input, and UI handoff. The returned snapshot is immutable and detached from internal storage, so callers cannot mutate core state accidentally. Factory-created buffers expose each mode snapshot atomically, including during mutation. An operation that also reads grid/cursor state still requires the terminal's external serialization to keep those separate reads coherent.

Inheritors

TerminalBuffer

Functions

getInputModeBits

open override fun getInputModeBits(): Long

Returns one atomic packed snapshot for input encoders.

getModeBitsSnapshot

abstract fun getModeBitsSnapshot(): Long

Returns one atomic snapshot of the published packed mode subset.

getModeSnapshot

abstract fun getModeSnapshot(): TerminalModeSnapshot

Returns an immutable snapshot of the published TerminalModeSnapshot fields.