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 metadata callback sink for BEL and title changes.

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.

var iconTitle: String

The current icon title reported by the shell or application.

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)

open override fun backspace()

open override fun bell()

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()

open override fun clearTabStop()

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.

open override fun cursorBackward(n: Int)

cursorBackwardTabs

open override fun cursorBackwardTabs(n: Int)

open override fun cursorDown(n: Int)

open override fun cursorForward(n: Int)

cursorForwardTabs

open override fun cursorForwardTabs(n: Int)

open override fun cursorNextLine(n: Int)

cursorPreviousLine

open override fun cursorPreviousLine(n: Int)

open override fun cursorUp(n: Int)

open override fun decaln()

deleteCharacters

open override fun deleteCharacters(n: Int)

open override fun deleteColumns(count: Int)

open override fun deleteLines(n: Int)

deminimizeWindow

open override fun deminimizeWindow()

disableKeyModifierOption

open override fun disableKeyModifierOption(resource: Int)

open override fun endHyperlink()

eraseCharacters

open override fun eraseCharacters(n: Int)

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

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

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

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

fun hyperlinkUri(hyperlinkId: Int): String?

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

insertCharacters

open override fun insertCharacters(n: Int)

open override fun insertColumns(count: Int)

open override fun insertLines(n: Int)

open override fun lineFeed()

open override fun lowerWindow()

open override fun minimizeWindow()

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

open override fun nextLine()

popKittyKeyboardFlags

open override fun popKittyKeyboardFlags(count: Int)

open override fun popTitleStack(scope: Int)

pushKittyKeyboardFlags

open override fun pushKittyKeyboardFlags(flags: Int)

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)

open override fun queryTerminfo(rawPayload: String)

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()

open override fun resetTerminal()

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

open override fun restoreCursor()

open override fun reverseIndex()

reverseRectangleAttributes

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

open override fun saveCursor()

open override fun scrollDown(n: Int)

open override fun scrollUp(n: Int)

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)

open override fun setBlink(enabled: Boolean)

open override fun setBold(enabled: Boolean)

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)

open override fun setCursorRow(row: Int)

open override fun setCursorStyle(style: Int)

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

setDynamicColor

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

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)

fun setHostPolicy(policy: HostPolicy)

Updates the active host security policy dynamically.

setIconAndWindowTitle

open override fun setIconAndWindowTitle(title: String)

open override fun setIconTitle(title: String)

open override fun setInverse(enabled: Boolean)

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)

open override fun setMaximized(maximize: Boolean)

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)

open override fun setTabStop()

setUnderlineColorDefault

open override fun setUnderlineColorDefault()

setUnderlineColorIndexed

open override fun setUnderlineColorIndexed(index: Int)

setUnderlineColorRgb

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

setUnderlineStyle

open override fun setUnderlineStyle(style: Int)

open override fun setWindowTitle(title: String)

shellIntegrationMarker

open override fun shellIntegrationMarker(event: ShellIntegrationEvent)

showNotification

open override fun showNotification(title: String, body: String, level: NotificationLevel)

open override fun softReset()

open override fun startHyperlink(uri: String, id: String?)

open override fun tab()

open override fun writeCluster(codepoints: IntArray, length: Int)

open override fun writeCodepoint(codepoint: Int)