ketraterm-session/io.github.ketraterm.session/TerminalShellIntegrationView

TerminalShellIntegrationView

Read-only, live projection of the selected shell producer.

All reads and registrations are thread-safe; separate calls need not observe the same revision. Primitive copies write only caller-owned destinations. Metadata snapshots allocate only when requested. The producer owns records and clearing; consumers own their listener registrations. This role conveys no publication or producer lifetime authority.

Inheritors

TerminalShellIntegrationState

Properties

revision

abstract val revision: StateFlow<Long>

Invalidation signal for prompt, command, and current-directory metadata.

Functions

addCommandFinishedListener

abstract fun addCommandFinishedListener(listener: (TerminalShellIntegrationCommandMetadata) -> Unit): AutoCloseable

Observes future explicit command completions without replay or conflation.

addCurrentWorkingDirectoryListener

abstract fun addCurrentWorkingDirectoryListener(listener: (String) -> Unit): AutoCloseable

Observes future changed directory URIs synchronously, without replay.

commandAnchorLineId

abstract fun commandAnchorLineId(recordId: Int): Long

Returns the preferred navigation anchor line for recordId.

commandMetadata

abstract fun commandMetadata(recordId: Int): TerminalShellIntegrationCommandMetadata?

Returns an immutable metadata snapshot for recordId.

commandRecordIdAtLine

abstract fun commandRecordIdAtLine(lineId: Long): Int

Returns the retained command record that owns lineId.

commandText

abstract fun commandText(recordId: Int): String?

Returns the retained command text for recordId.

commandWorkingDirectoryUri

abstract fun commandWorkingDirectoryUri(recordId: Int): String?

Returns the working-directory URI snapshotted when recordId began.

copyCommandBlockRange

abstract fun copyCommandBlockRange(recordId: Int, destination: LongArray, destinationOffset: Int = 0): Boolean

Copies the selectable prompt/input-and-output line range for recordId.

copyCommandOutputRange

abstract fun copyCommandOutputRange(recordId: Int, destination: LongArray, destinationOffset: Int = 0): Boolean

Copies the command-output line range for recordId.

copyRecords

abstract fun copyRecords(recordIds: IntArray, lifecycleStates: IntArray, promptStartLineIds: LongArray, promptEndLineIds: LongArray, commandStartLineIds: LongArray, commandEndLineIds: LongArray, exitCodes: IntArray, destinationOffset: Int, maxRecords: Int): Int

Copies retained shell command records into caller-owned primitive arrays.

copyViewport

abstract fun copyViewport(lineIds: LongArray, rowCount: Int, promptStarts: BooleanArray, commandStarts: BooleanArray, commandEnds: BooleanArray, commandRecordIds: IntArray, commandLifecycleStates: IntArray, failedCommandRails: BooleanArray? = null, destinationOffset: Int = 0)

Copies projected shell decorations for a visible viewport.

currentWorkingDirectoryUri

abstract fun currentWorkingDirectoryUri(): String?

Returns the latest recorded directory URI, or null before one is recorded.

hasRunningCommand

abstract fun hasRunningCommand(): Boolean

Returns true while shell integration reports a command between command-start and command-finished events.

latestCommandRecordId

abstract fun latestCommandRecordId(): Int

Returns the newest retained command record id, skipping prompt-only records.

nextCommandRecordId