ketraterm-session/io.github.ketraterm.session/TerminalShellCommandLineSnapshot

TerminalShellCommandLineSnapshot

data class TerminalShellCommandLineSnapshot(val commandText: String, val cursorOffset: Int, val cursorColumn: Int, val cursorRow: Int)

Immutable snapshot of the shell command line currently known to the session.

The optional OSC integration extracts bounded text from prompt markers and synchronized render frames, only when the cursor is at the visible end. A host-owned shell editor can instead supply its complete logical command text and an offset anywhere in that text through TerminalShellIntegrationFactory.host. Hosts own their source's text limits and publish updates when text, cursor, anchor, or availability changes. Snapshots are consumed outside paint loops.

Constructors

constructor(commandText: String, cursorOffset: Int, cursorColumn: Int, cursorRow: Int)

Properties

commandText

val commandText: String

complete known command-line text, without the prompt.

cursorColumn

val cursorColumn: Int

zero-based live terminal-grid cursor column to use as a popup anchor.

cursorOffset

val cursorOffset: Int

UTF-16 cursor offset within commandText.

cursorRow

val cursorRow: Int

zero-based live terminal-grid cursor row to use as a popup anchor.