ketraterm-session/io.github.ketraterm.session

Package-level declarations

Types

TerminalClipboardReader

fun interface TerminalClipboardReader

Clipboard operation bound to the owning session and product lifecycle.

TerminalClipboardReadResult

sealed interface TerminalClipboardReadResult

A platform result; failures may also be thrown and are audited without details.

TerminalCommandEditContext

class TerminalCommandEditContext

Session-issued editing context captured with a selected producer's revision. Retain it from suggestion request through final admission; never recapture it merely to make an old edit pass. It is specific to its issuing session and becomes stale after input, output, resize or a producer update. No writer or frame lease is retained. Acceptance still does not confirm remote execution.

TerminalHyperlinkResolver

fun interface TerminalHyperlinkResolver

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

TerminalInputAdmission

enum TerminalInputAdmission : Enum<TerminalInputAdmission>

Result of synchronous session input admission, never a write receipt. An accepted operation can still be interrupted or discarded by closure or transport failure. Observe TerminalSession.state for termination and its original failure; response-dependent callers must stop waiting on closure.

TerminalSession

class TerminalSession : TerminalConnectorListener, TerminalInputEncoder, TerminalInputState, TerminalRenderFrameReader, AutoCloseable

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

TerminalSessionCloseEvent

data class TerminalSessionCloseEvent(val exitCode: Int?, val failure: Throwable?, val locallyRequested: Boolean)

Immutable lifecycle event published after TerminalSession cleanup finishes.

TerminalSessionState

sealed interface TerminalSessionState

Observable lifecycle state of a TerminalSession.

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.

TerminalShellCommandLineState

class TerminalShellCommandLineState @JvmOverloads constructor(initialValue: TerminalShellCommandLineSnapshot? = null)

Host-owned authoritative command-line projection for conditional editing. Every assignment advances a revision, including equal values and transitions through null. Publish null while the host cannot trust its editing state, including host-managed pending input. Publishing a snapshot does not acknowledge remote processing of session writes; that remains the host shell model's concern.

TerminalShellIntegration

interface TerminalShellIntegration

Selected producer of a terminal's shell metadata and active editing context.

TerminalShellIntegrationCommandBlockRange

object TerminalShellIntegrationCommandBlockRange

Primitive column layout for command-block range copies.

TerminalShellIntegrationCommandLifecycle

object TerminalShellIntegrationCommandLifecycle

Primitive lifecycle vocabulary for terminal-facing shell command records.

TerminalShellIntegrationCommandMetadata

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.

TerminalShellIntegrationCommandOutputRange

object TerminalShellIntegrationCommandOutputRange

Primitive column layout for command-output range copies.

TerminalShellIntegrationCommandRecord

object TerminalShellIntegrationCommandRecord

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

TerminalShellIntegrationContext

class TerminalShellIntegrationContext : TerminalRenderFrameReader

Session-scoped, read-only access for a shell producer that derives metadata from terminal output. Frames and published caches are borrowed only for the callback; never mutate or retain them. No callback may block on UI work or close the session.

TerminalShellIntegrationFactory

fun interface TerminalShellIntegrationFactory

Creates one shell producer before a session starts consuming output.

TerminalShellIntegrationState

class TerminalShellIntegrationState(capacity: Int = DEFAULT_CAPACITY, maxCommandTextLength: Int = 4096, epochMillis: () -> Long = System::currentTimeMillis) : TerminalShellIntegrationView

Bounded, protocol-neutral terminal projection of shell commands and prompts.

TerminalShellIntegrationView

interface TerminalShellIntegrationView

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

TerminalStartupCommand

data class TerminalStartupCommand(val text: String)

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

TerminalStartupCommandStatus

enum TerminalStartupCommandStatus : Enum<TerminalStartupCommandStatus>

Session-local outcome of an explicitly configured startup command.

TerminalViewportResizeResult

data class TerminalViewportResizeResult(val scrollbackOffset: Int, val historySize: Int, val discardedCount: Long)

Viewport anchor and history baseline captured atomically after terminal resize.