ketraterm-host/io.github.ketraterm.host

Package-level declarations

Types

class HostCommandAdapter @JvmOverloads constructor(terminal: TerminalBuffer, hostEvents: HostEventSink = HostEventSink.NONE, hostPolicy: HostPolicy = HostPolicy(), kittyKeyboardSupportedFlags: Int = KittyKeyboardProgressiveFlag.DEFAULT_HOST_SUPPORTED_MASK, modeReportCapabilities: Int = 0, defaultBackarrowSendsBackspace: Boolean = false) : TerminalAsciiCommandSink

Production bridge from parser semantic commands to the terminal core.

HostControlPolicy

enum HostControlPolicy : Enum<HostControlPolicy>

Binary decision for host-affecting terminal controls.

HostEventSink

interface HostEventSink

Host-facing events emitted while parser commands are mapped to core state.

HostPolicy

data class HostPolicy(val titlePolicy: TerminalTitlePolicy = TerminalTitlePolicy(), val hyperlinkPolicy: HostControlPolicy = HostControlPolicy.ALLOW, val currentWorkingDirectoryPolicy: HostControlPolicy = HostControlPolicy.ALLOW, val notificationPolicy: HostControlPolicy = HostControlPolicy.ALLOW, val windowManipulationPolicy: HostControlPolicy = HostControlPolicy.ALLOW, val palettePolicy: HostControlPolicy = HostControlPolicy.ALLOW, val terminalResponsePolicy: HostControlPolicy = HostControlPolicy.ALLOW, val clipboardPolicy: TerminalClipboardPolicy = TerminalClipboardPolicy(), val maxHyperlinkEntries: Int = 4096, val maxHyperlinkUriLength: Int = 4096, val maxHyperlinkIdLength: Int = 256, val maxNotificationTitleLength: Int = 256, val maxNotificationBodyLength: Int = 1024, val maxCurrentWorkingDirectoryUriLength: Int = 4096)

Host-facing security policy for terminal controls that can affect host state, retain host metadata, or write terminal-generated bytes back to the remote process.

TerminalClipboardAuditEvent

data class TerminalClipboardAuditEvent(val operation: TerminalClipboardOperation, val selection: String, val encodedLength: Int, val decodedBytes: Int, val maxDecodedBytes: Int, val decision: TerminalClipboardDecision)

Host-facing audit event for an OSC 52 terminal clipboard request.

TerminalClipboardDecision

enum TerminalClipboardDecision : Enum<TerminalClipboardDecision>

Adapter decision for a terminal clipboard request.

TerminalClipboardOperation

enum TerminalClipboardOperation : Enum<TerminalClipboardOperation>

OSC 52 operation class.

TerminalClipboardPermission

enum TerminalClipboardPermission : Enum<TerminalClipboardPermission>

Permission decision mode for a terminal clipboard operation family.

TerminalClipboardPolicy

data class TerminalClipboardPolicy(val writePermission: TerminalClipboardPermission = TerminalClipboardPermission.DENY, val readPermission: TerminalClipboardPermission = TerminalClipboardPermission.DENY, val maxDecodedBytes: Int = DEFAULT_MAX_DECODED_BYTES)

Permission policy for terminal-originated clipboard protocols such as OSC 52.

TerminalClipboardPromptEvent

data class TerminalClipboardPromptEvent(val selection: String, val text: String, val audit: TerminalClipboardAuditEvent)

Host-facing decoded OSC 52 clipboard write prompt request.

TerminalClipboardReadAuditEvent

data class TerminalClipboardReadAuditEvent(val selection: TerminalClipboardSelection, val outcome: TerminalClipboardReadOutcome)

Contains no clipboard data or provider exception details.

TerminalClipboardReadOutcome

enum TerminalClipboardReadOutcome : Enum<TerminalClipboardReadOutcome>

Content-free execution result, distinct from the adapter's admission audit.

TerminalClipboardReadRequest

data class TerminalClipboardReadRequest(val selection: TerminalClipboardSelection, val permission: TerminalClipboardPermission, val maxDecodedBytes: Int)

A validated read query admitted by the host adapter. permission and maxDecodedBytes describe admission, not a permanent grant. Session execution rechecks policy before access and before committing output.

TerminalClipboardWriteEvent

data class TerminalClipboardWriteEvent(val selection: String, val text: String, val audit: TerminalClipboardAuditEvent)

Host-facing decoded OSC 52 clipboard write request.

TerminalTitleOverflowPolicy

enum TerminalTitleOverflowPolicy : Enum<TerminalTitleOverflowPolicy>

Handling for terminal titles that exceed the configured maximum length.

TerminalTitlePermission

enum TerminalTitlePermission : Enum<TerminalTitlePermission>

Permission for terminal-triggered title metadata updates.

TerminalTitlePolicy

data class TerminalTitlePolicy(val permission: TerminalTitlePermission = TerminalTitlePermission.ALLOW, val overflowPolicy: TerminalTitleOverflowPolicy = TerminalTitleOverflowPolicy.CLAMP, val maxLength: Int = DEFAULT_MAX_LENGTH)

Host policy for terminal-triggered icon and window title metadata updates.