ketraterm-input/io.github.ketraterm.input.policy/TerminalInputPolicy

TerminalInputPolicy

data class TerminalInputPolicy(val backspacePolicy: BackspacePolicy = BackspacePolicy.DELETE, val metaKeyPolicy: MetaKeyPolicy = MetaKeyPolicy.ESC_PREFIX, val unsupportedModifiedKeyPolicy: UnsupportedModifiedKeyPolicy = UnsupportedModifiedKeyPolicy.SUPPRESS, val altSendsEscapePrefix: Boolean = true, val enterNewLineModePolicy: EnterNewLineModePolicy = EnterNewLineModePolicy.SEND_CR_LF, val mouseCoordinateLimitPolicy: MouseCoordinateLimitPolicy = MouseCoordinateLimitPolicy.SUPPRESS_OUT_OF_RANGE, val pasteControlPolicy: PasteControlPolicy = PasteControlPolicy.PRESERVE, val pasteLineEndingPolicy: PasteLineEndingPolicy = PasteLineEndingPolicy.PRESERVE)

Runtime choices for keyboard, mouse, and paste encoding.

The production encoder suppresses unsupported combinations by default rather than throwing, because UI toolkits may report platform-specific key states.

Constructors

TerminalInputPolicy

constructor(backspacePolicy: BackspacePolicy = BackspacePolicy.DELETE, metaKeyPolicy: MetaKeyPolicy = MetaKeyPolicy.ESC_PREFIX, unsupportedModifiedKeyPolicy: UnsupportedModifiedKeyPolicy = UnsupportedModifiedKeyPolicy.SUPPRESS, altSendsEscapePrefix: Boolean = true, enterNewLineModePolicy: EnterNewLineModePolicy = EnterNewLineModePolicy.SEND_CR_LF, mouseCoordinateLimitPolicy: MouseCoordinateLimitPolicy = MouseCoordinateLimitPolicy.SUPPRESS_OUT_OF_RANGE, pasteControlPolicy: PasteControlPolicy = PasteControlPolicy.PRESERVE, pasteLineEndingPolicy: PasteLineEndingPolicy = PasteLineEndingPolicy.PRESERVE)

Properties

altSendsEscapePrefix

val altSendsEscapePrefix: Boolean

when true, Alt prefixes applicable legacy encodings with ESC.

backspacePolicy

val backspacePolicy: BackspacePolicy

initial Backspace byte before an explicit DECBKM set/reset overrides it for the current terminal reset epoch.

enterNewLineModePolicy

val enterNewLineModePolicy: EnterNewLineModePolicy

handling for unmodified Return/Enter when ANSI Line Feed/New Line mode is active.

metaKeyPolicy

val metaKeyPolicy: MetaKeyPolicy

handling for Meta-only printable and legacy key encodings.

mouseCoordinateLimitPolicy

val mouseCoordinateLimitPolicy: MouseCoordinateLimitPolicy

handling for legacy mouse coordinates outside the bounded ESC [ M byte range.

pasteControlPolicy

val pasteControlPolicy: PasteControlPolicy

optional C0 filtering for pasted text. Bracketed-paste protection applies independently of this choice.

pasteLineEndingPolicy

val pasteLineEndingPolicy: PasteLineEndingPolicy

newline canonicalization for unbracketed pasted text. Bracketed paste always preserves original line endings.

unsupportedModifiedKeyPolicy

val unsupportedModifiedKeyPolicy: UnsupportedModifiedKeyPolicy

handling for valid key events whose modifier combination has no supported encoding in the active protocol set.