ketraterm-host/io.github.ketraterm.host/HostCommandAdapter

HostCommandAdapter

class HostCommandAdapter(terminal: TerminalBuffer, hostEvents: HostEventSink = HostEventSink.NONE, hostPolicy: HostPolicy = HostPolicy(), kittyKeyboardSupportedFlags: Int = KittyKeyboardProgressiveFlag.DEFAULT_HOST_SUPPORTED_MASK) : TerminalCommandSink

Production bridge from parser semantic commands to the terminal core.

The parser owns byte/protocol decoding. The core owns grid mutation, mode state, cursor physics, and width policy. This adapter is the narrow place where ANSI/DEC mode ids become concrete core API calls.

Parameters

terminal

public core buffer API mutated by parser semantic commands.

hostEvents

optional sink for accepted host metadata and requests.

hostPolicy

safety limits for host-owned metadata.

kittyKeyboardSupportedFlags

progressive Kitty keyboard flags the active input host can provide truthfully. The value must be a subset of the input encoder's implemented protocol mask.

Constructors

HostCommandAdapter

constructor(terminal: TerminalBuffer, hostEvents: HostEventSink = HostEventSink.NONE, hostPolicy: HostPolicy = HostPolicy(), kittyKeyboardSupportedFlags: Int = KittyKeyboardProgressiveFlag.DEFAULT_HOST_SUPPORTED_MASK)

Properties

activeHyperlinkId

var activeHyperlinkId: String?

The client-provided ID of the currently active hyperlink (OSC 8), or null if none.

activeHyperlinkUri

var activeHyperlinkUri: String?

The URI of the currently active hyperlink (OSC 8), or null if none.

iconTitle

var iconTitle: String

The current icon title reported by the shell or application.

windowTitle

var windowTitle: String

The current window title reported by the shell or application.

Functions

appendToPreviousCluster

open override fun appendToPreviousCluster(codepoint: Int)

applyKittyKeyboardFlags

open override fun applyKittyKeyboardFlags(flags: Int, applicationMode: Int)

backspace

open override fun backspace()

bell

open override fun bell()

carriageReturn

open override fun carriageReturn()

changeRectangleAttributes

open override fun changeRectangleAttributes(top: Int, left: Int, bottom: Int, right: Int, setMask: Int, clearMask: Int)

clearAllTabStops

open override fun clearAllTabStops()

clearTabStop

open override fun clearTabStop()

clipboardWriteLimitBytes

fun clipboardWriteLimitBytes(): Int

Current decoded-byte budget for collecting larger OSC 52 writes. Denied writes return zero, retaining the parser's ordinary envelope bound and small-request auditing. This does not authorize execution: requestClipboard rechecks the current policy.

copyRectangle

open override fun copyRectangle(sourceTop: Int, sourceLeft: Int, sourceBottom: Int, sourceRight: Int, sourcePage: Int, destinationTop: Int, destinationLeft: Int, destinationPage: Int)

currentWorkingDirectoryUri

fun currentWorkingDirectoryUri(): String?

Returns the latest valid OSC 7 current-working-directory URI.

cursorBackward

open override fun cursorBackward(n: Int)

cursorBackwardTabs

open override fun cursorBackwardTabs(n: Int)

cursorDown

open override fun cursorDown(n: Int)

cursorForward

open override fun cursorForward(n: Int)

cursorForwardTabs

open override fun cursorForwardTabs(n: Int)

cursorNextLine

open override fun cursorNextLine(n: Int)

cursorPreviousLine

open override fun cursorPreviousLine(n: Int)

cursorUp

open override fun cursorUp(n: Int)

decaln

open override fun decaln()

deleteCharacters

open override fun deleteCharacters(n: Int)

deleteColumns

open override fun deleteColumns(count: Int)

deleteLines

open override fun deleteLines(n: Int)

deminimizeWindow

open override fun deminimizeWindow()

disableKeyModifierOption

open override fun disableKeyModifierOption(resource: Int)

endHyperlink

open override fun endHyperlink()

eraseCharacters

open override fun eraseCharacters(n: Int)

eraseInDisplay

open override fun eraseInDisplay(mode: Int, selective: Boolean)

eraseInLine

open override fun eraseInLine(mode: Int, selective: Boolean)

eraseRectangle

open override fun eraseRectangle(top: Int, left: Int, bottom: Int, right: Int, selective: Boolean)

fillRectangle

open override fun fillRectangle(codepoint: Int, top: Int, left: Int, bottom: Int, right: Int)

hyperlinkUri

fun hyperlinkUri(hyperlinkId: Int): String?

Returns the OSC 8 URI associated with hyperlinkId, or null.

insertCharacters

open override fun insertCharacters(n: Int)

insertColumns

open override fun insertColumns(count: Int)

insertLines

open override fun insertLines(n: Int)

lineFeed

open override fun lineFeed()

lowerWindow

open override fun lowerWindow()

minimizeWindow

open override fun minimizeWindow()

moveWindow

open override fun moveWindow(x: Int, y: Int)

nextLine

open override fun nextLine()

popKittyKeyboardFlags

open override fun popKittyKeyboardFlags(count: Int)

popTitleStack

open override fun popTitleStack(scope: Int)

pushKittyKeyboardFlags

open override fun pushKittyKeyboardFlags(flags: Int)

pushTitleStack

open override fun pushTitleStack(scope: Int)

queryDynamicColor

open override fun queryDynamicColor(target: Int)

queryPaletteColor

open override fun queryPaletteColor(index: Int)

queryStatusString

open override fun queryStatusString(query: String)

queryTerminfo

open override fun queryTerminfo(rawPayload: String)

raiseWindow

open override fun raiseWindow()

requestClipboard

open override fun requestClipboard(selection: String, encodedData: String)

requestDeviceAttributes

open override fun requestDeviceAttributes(kind: Int, parameter: Int)

requestDeviceStatusReport

open override fun requestDeviceStatusReport(mode: Int, decPrivate: Boolean)

requestKeyModifierOption

open override fun requestKeyModifierOption(resource: Int)

requestKittyKeyboardFlags

open override fun requestKittyKeyboardFlags()

requestRectangleChecksum

open override fun requestRectangleChecksum(requestId: Int, page: Int, top: Int, left: Int, bottom: Int, right: Int)

requestWindowReport

open override fun requestWindowReport(mode: Int)

resetAttributes

open override fun resetAttributes()

resetKeyFormatOption

open override fun resetKeyFormatOption(resource: Int)

resetKeyFormatOptions

open override fun resetKeyFormatOptions()

resetKeyModifierOption

open override fun resetKeyModifierOption(resource: Int)

resetKeyModifierOptions

open override fun resetKeyModifierOptions()

resetTerminal

open override fun resetTerminal()

resizeWindow

open override fun resizeWindow(rows: Int, columns: Int)

restoreCursor

open override fun restoreCursor()

reverseIndex

open override fun reverseIndex()

reverseRectangleAttributes

open override fun reverseRectangleAttributes(top: Int, left: Int, bottom: Int, right: Int, reverseMask: Int)

saveCursor

open override fun saveCursor()

saveCursorOrResetMargins

open override fun saveCursorOrResetMargins(): Boolean

scrollDown

open override fun scrollDown(n: Int)

scrollUp

open override fun scrollUp(n: Int)

setAnsiMode

open override fun setAnsiMode(mode: Int, enable: Boolean)

setAttributeChangeExtent

open override fun setAttributeChangeExtent(extent: Int)

setBackgroundDefault

open override fun setBackgroundDefault()

setBackgroundIndexed

open override fun setBackgroundIndexed(index: Int)

setBackgroundRgb

open override fun setBackgroundRgb(red: Int, green: Int, blue: Int)

setBlink

open override fun setBlink(enabled: Boolean)

setBold

open override fun setBold(enabled: Boolean)

setConceal

open override fun setConceal(enabled: Boolean)

setCurrentWorkingDirectoryUri

open override fun setCurrentWorkingDirectoryUri(uri: String)

setCursorAbsolute

open override fun setCursorAbsolute(row: Int, col: Int)

setCursorColumn

open override fun setCursorColumn(col: Int)

setCursorRow

open override fun setCursorRow(row: Int)

setCursorStyle

open override fun setCursorStyle(style: Int)

setDecMode

open override fun setDecMode(mode: Int, enable: Boolean)

setDynamicColor

open override fun setDynamicColor(target: Int, color: Int)

setFaint

open override fun setFaint(enabled: Boolean)

setForegroundDefault

open override fun setForegroundDefault()

setForegroundIndexed

open override fun setForegroundIndexed(index: Int)

setForegroundRgb

open override fun setForegroundRgb(red: Int, green: Int, blue: Int)

setHostPolicy

fun setHostPolicy(policy: HostPolicy)

Updates the active host security policy dynamically.

setIconAndWindowTitle

open override fun setIconAndWindowTitle(title: String)

setIconTitle

open override fun setIconTitle(title: String)

setInverse

open override fun setInverse(enabled: Boolean)

setItalic

open override fun setItalic(enabled: Boolean)

setKeyFormatOption

open override fun setKeyFormatOption(resource: Int, value: Int)

setKeyModifierOption

open override fun setKeyModifierOption(resource: Int, value: Int)

setLeftRightMargins

open override fun setLeftRightMargins(left: Int, right: Int)

setMaximized

open override fun setMaximized(maximize: Boolean)

setOverline

open override fun setOverline(enabled: Boolean)

setPaletteColor

open override fun setPaletteColor(index: Int, color: Int)

setScrollRegion

open override fun setScrollRegion(top: Int, bottom: Int)

setSelectiveEraseProtection

open override fun setSelectiveEraseProtection(enabled: Boolean)

setStrikethrough

open override fun setStrikethrough(enabled: Boolean)

setTabStop

open override fun setTabStop()

setThemePalette

fun setThemePalette(palette: TerminalColorPalette)

Applies a host-selected theme and publishes an effective palette change. Unlike application OSC controls, this operation is not gated by host policy. The caller must serialize it with parser/core mutations.

setUnderlineColorDefault

open override fun setUnderlineColorDefault()

setUnderlineColorIndexed