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

Package-level declarations

Types

interface TerminalBuffer : TerminalGraphics, TerminalWriter, TerminalCursor, TerminalModeController, TerminalModeReader, TerminalResponseChannel, TerminalReader, TerminalInspector

Full public contract for the terminal buffer.

TerminalCursor

interface TerminalCursor

Cursor-movement contract for the terminal buffer.

TerminalGraphics

interface TerminalGraphics

Caller-serialized image admission and placement on the active terminal screen. Images live outside text cells and appear through the render-frame image API. Mutation, response draining and frame reads require the buffer's usual external serialization; session hosts use their session boundary.

TerminalHostResponseReader

interface TerminalHostResponseReader

Narrow reader for terminal-to-host response bytes.

TerminalInputState

interface TerminalInputState

Primitive, read-only access to the published packed mode subset used by input encoders. Factory-created buffers read this word atomically without constructing a snapshot object. Implementations must return one coherent word per call; capture it once when decoding multiple fields for one decision. This does not synchronize separate grid or cursor reads.

TerminalInspector

interface TerminalInspector

Allocating inspection contract for the terminal buffer.

TerminalLine

interface TerminalLine

Read-only borrowed view of one physical terminal line.

TerminalModeBits

object TerminalModeBits

Public contract for the packed terminal mode bit layout.

TerminalModeController

interface TerminalModeController

Mode-control contract for the terminal buffer.

TerminalModeReader

interface TerminalModeReader : TerminalInputState

Read-only public access to durable terminal mode state.

TerminalModeSnapshot

data class TerminalModeSnapshot(val isInsertMode: Boolean, val isAutoWrap: Boolean, val isApplicationCursorKeys: Boolean, val isApplicationKeypad: Boolean, val isBackarrowKeyModeExplicit: Boolean, val isBackarrowKeySendsBackspace: Boolean, val isOriginMode: Boolean, val isNewLineMode: Boolean, val isLeftRightMarginMode: Boolean, val isReverseVideo: Boolean, val isCursorVisible: Boolean, val isCursorBlinking: Boolean, val isBracketedPasteEnabled: Boolean, val isFocusReportingEnabled: Boolean, val treatAmbiguousAsWide: Boolean, val mouseTrackingMode: MouseTrackingMode, val mouseEncodingMode: MouseEncodingMode, val modifyOtherKeysMode: Int, val formatOtherKeysMode: Int, val kittyKeyboardFlags: Int, val isSynchronizedOutput: Boolean, val isBellIsUrgent: Boolean, val isPopOnBell: Boolean)

Immutable snapshot of the published typed mode subset listed by this constructor.

TerminalReader

interface TerminalReader

Zero-allocation read contract for the terminal buffer.

TerminalRenderBuffer

interface TerminalRenderBuffer : TerminalBuffer, TerminalRenderFrameReader

Core state with a render-frame projection of that same state.

TerminalResponseChannel

interface TerminalResponseChannel : TerminalHostResponseReader

Terminal-to-host response channel.

TerminalWriter

interface TerminalWriter

Write-side contract for the terminal buffer.