KetraTerm
API · DevelopmentAll versions

PtyOptions

Configuration for starting a local PTY-backed terminal session.

Use create and copy for named construction and immutable updates. Command and environment collections are defensively copied when built. Callbacks, policies, and shell producers retain their documented host ownership.

Constructors

Link copied to clipboard
constructor()

Creates a validated snapshot with default values.

Types

Link copied to clipboard
class Builder

Mutable construction draft. Not thread-safe; build never retains this draft.

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

initial terminal width in cells.

Link copied to clipboard

command and arguments passed to the PTY child process.

Link copied to clipboard

environment variables for the child process. TERM and COLORTERM default to the shared terminal capability identity when the caller does not provide them.

Link copied to clipboard

host callbacks for parser-discovered PTY metadata events such as BEL and title changes.

Link copied to clipboard

safety policy for terminal-triggered host actions.

Link copied to clipboard

host-bound input encoding policy. Local PTY sessions default Return/Enter to CR even when LNM is active, because contemporary PTY line disciplines can otherwise turn DEC CR LF into an extra newline. Unbracketed paste line endings are likewise canonicalized to CR so every pasted boundary has the same input semantics as Enter.

Link copied to clipboard

maximum scrollback lines retained by the core buffer.

Link copied to clipboard

implemented host actions from TerminalHostModeCapability.

Link copied to clipboard

buffer size used by the PTY stdout reader thread.

Link copied to clipboard

name for the daemon PTY stdout reader thread.

Link copied to clipboard
val rows: Int

initial terminal height in rows.

Link copied to clipboard

selected producer of shell metadata, editing context and prompt readiness. Null installs no shell integration. PTY assembly does not select a protocol implementation or own the producer's lifetime.

Link copied to clipboard

command to submit once shellIntegration reports a ready prompt. The caller is responsible for installing its shell hooks before launch.

Link copied to clipboard

whether East Asian Ambiguous codepoints occupy two cells in the core width policy for future writes.

Link copied to clipboard

name for the daemon process exit watcher thread.

Link copied to clipboard

initial process working directory, or null to let PTY4J use its platform default.

Functions

Link copied to clipboard

Configures a fresh draft synchronously and returns a validated immutable snapshot. Exceptions propagate without changing this snapshot. Supplied services remain host-owned.

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard

Returns a detached mutable draft. Builders are caller-confined and never retained by snapshots.