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

TerminalModeSnapshot

data class TerminalModeSnapshot(val isInsertMode: Boolean, val isAutoWrap: Boolean, val isApplicationCursorKeys: Boolean, val isApplicationKeypad: 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 terminal's durable mode state.

This is the handoff contract for parser, input, and UI layers that need to read mode flags without mutating the core's internal TerminalModes instance.

Constructors

TerminalModeSnapshot

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

Properties

formatOtherKeysMode

val formatOtherKeysMode: Int

The active format-other-keys wire format.

isApplicationCursorKeys

val isApplicationCursorKeys: Boolean

true when application cursor keys mode (DECCKM) is active.

isApplicationKeypad

val isApplicationKeypad: Boolean

true when application keypad mode (DECNKM) is active.

val isAutoWrap: Boolean

true when DECAWM auto-wrap mode is active.

val isBellIsUrgent: Boolean

true when urgent bell mode (?1042) is active.

isBracketedPasteEnabled

val isBracketedPasteEnabled: Boolean

true when bracketed paste mode (?2004) is enabled.

isCursorBlinking

val isCursorBlinking: Boolean

true when the cursor blink presentation is active.

isCursorVisible

val isCursorVisible: Boolean

true when the cursor presentation is visible (DECTCEM).

isFocusReportingEnabled

val isFocusReportingEnabled: Boolean

true when focus in/out reporting (?1004) is enabled.

val isInsertMode: Boolean

true when insert mode (IRM) is active, false for replace mode.

isLeftRightMarginMode

val isLeftRightMarginMode: Boolean

true when left/right margins (DECLRMM) are active.

val isNewLineMode: Boolean

true when new-line mode (LNM) is active.

val isOriginMode: Boolean

true when origin mode (DECOM) is active.

val isPopOnBell: Boolean

true when pop on bell mode (?1043) is active.

val isReverseVideo: Boolean

true when reverse-video presentation (DECSCNM) is active.

isSynchronizedOutput

val isSynchronizedOutput: Boolean

true when synchronized output mode (?2026) is active.

kittyKeyboardFlags

val kittyKeyboardFlags: Int

Active Kitty keyboard progressive-enhancement flags.

modifyOtherKeysMode

val modifyOtherKeysMode: Int

The active modify-other-keys reporting level.

mouseEncodingMode

val mouseEncodingMode: MouseEncodingMode

The active mouse report encoding mode.

mouseTrackingMode

val mouseTrackingMode: MouseTrackingMode

The active mouse tracking mode.

treatAmbiguousAsWide

val treatAmbiguousAsWide: Boolean

true when East Asian Ambiguous characters are measured as wide (2 cells).