KetraTerm
API · v0.3.0All versions

Package-level declarations

Types

Link copied to clipboard

Resolves primitive render-frame hyperlink ids to their OSC 8 target URI.

Link copied to clipboard
class TerminalSession(val terminal: TerminalBuffer, val renderPublisher: TerminalRenderPublisher, renderReader: TerminalRenderFrameReader, responseReader: TerminalHostResponseReader, connector: TerminalConnector, parser: TerminalOutputParser, inputEncoder: TerminalInputEncoder, hyperlinkResolver: TerminalHyperlinkResolver = TerminalHyperlinkResolver.NONE, outboundWriteLock: Any = Any(), val shellIntegrationState: TerminalShellIntegrationState = TerminalShellIntegrationState(), hostCommandAdapter: HostCommandAdapter? = null, inputPolicy: TerminalInputPolicy = TerminalInputPolicy(), workerDispatcher: CoroutineDispatcher = Dispatchers.Default, ioDispatcher: CoroutineDispatcher = Dispatchers.IO) : TerminalConnectorListener, TerminalInputEncoder, TerminalRenderFrameReader, AutoCloseable

Runtime terminal session that binds core, parser, input encoding, and a transport connector.

Link copied to clipboard
data class TerminalSessionCloseEvent(val exitCode: Int?, val failure: Throwable?, val locallyRequested: Boolean)

Immutable lifecycle event emitted when a TerminalSession stops accepting host input.

Link copied to clipboard
sealed interface TerminalSessionState

Observable lifecycle state of a TerminalSession.

Link copied to clipboard
data class TerminalShellCommandLineSnapshot(val commandText: String, val cursorOffset: Int, val cursorColumn: Int, val cursorRow: Int)

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

Primitive column layout for command-block range copies.

Link copied to clipboard

Primitive lifecycle vocabulary for session-owned shell command records.

Link copied to clipboard
data class TerminalShellIntegrationCommandMetadata(val recordId: Int, val lifecycle: Int, val commandText: String?, val workingDirectoryUri: String?, val exitCode: Int?, val startedAtEpochMillis: Long, val finishedAtEpochMillis: Long?)

Immutable metadata snapshot for one retained shell command.

Primitive column layout for command-output range copies.

Link copied to clipboard

Primitive command-record id vocabulary used by shell-integration viewport projections.

Link copied to clipboard
class TerminalShellIntegrationState(capacity: Int = DEFAULT_CAPACITY, maxCommandTextLength: Int = DEFAULT_SHELL_INTEGRATION_COMMAND_TEXT_LENGTH, epochMillis: () -> Long = System::currentTimeMillis)

Session-owned OSC 133 shell command timeline.

Link copied to clipboard
data class TerminalStartupCommand(val text: String)

One shell command line to submit after the first complete interactive prompt.

Link copied to clipboard

Session-local outcome of an explicitly configured startup command.

Link copied to clipboard
data class TerminalViewportResizeResult(val scrollbackOffset: Int, val historySize: Int, val discardedCount: Long)

Viewport anchor and history baseline captured atomically after terminal resize.