ketraterm-completion/io.github.ketraterm.completion.api

Package-level declarations

Types

enum TerminalCompletionActivePosition : Enum<TerminalCompletionActivePosition>

Semantic position of the active completion token.

data class TerminalCompletionCandidate @JvmOverloads constructor(val replacementText: String, val replacementStartOffset: Int, val replacementEndOffset: Int, val source: String, val kind: TerminalCompletionCandidateKind, val displayText: String = replacementText, val detail: String = "", val score: Int = 0, val valueDomain: TerminalCompletionValueDomain = TerminalCompletionValueDomain.NONE, val matchedRanges: TerminalCompletionMatchRanges = TerminalCompletionMatchRanges.EMPTY, val feedbackToken: Any? = null)

Immutable completion candidate returned by TerminalCompletionEngine.

TerminalCompletionCandidateKind

enum TerminalCompletionCandidateKind : Enum<TerminalCompletionCandidateKind>

Completion candidate category used by hosts for grouping, ranking display, and source-specific styling.

TerminalCompletionContext

class TerminalCompletionContext

One parsed, spec-resolved completion context shared by every source.

TerminalCompletionEngine

fun interface TerminalCompletionEngine

Pure completion engine contract.

TerminalCompletionEngines

object TerminalCompletionEngines

Factories for production completion engines.

TerminalCompletionLearningStore

class TerminalCompletionLearningStore @JvmOverloads constructor(replayFilter: Predicate<String>, capacity: Int = DEFAULT_CAPACITY)

Mutable, bounded in-memory store for exact command completion learning.

TerminalCompletionMatchRanges

class TerminalCompletionMatchRanges

Immutable ordered match ranges relative to one completion display string.

TerminalCompletionMessages

fun interface TerminalCompletionMessages

Host message lookup for descriptions generated by reusable completion sources.

TerminalCompletionReplayPolicy

object TerminalCompletionReplayPolicy

Best-effort conservative filter for retaining plaintext replay suggestions.

TerminalCompletionRequest

data class TerminalCompletionRequest @JvmOverloads constructor(val commandLine: String, val cursorOffset: Int, val workingDirectoryUri: String? = null, val profileId: String? = null, val shellCapabilities: TerminalShellCapabilities = PLAIN)

Immutable command-line context used to request completion candidates.

TerminalCompletionSource

fun interface TerminalCompletionSource

Suspending completion source contract for one provider such as static command specs, path completion, or IDE context.

TerminalCompletionSourceEntry

data class TerminalCompletionSourceEntry @JvmOverloads constructor(val source: TerminalCompletionSource, val priority: Int = 0)

Source registration consumed by merged completion engines.

TerminalCompletionSourceFailureHandler

fun interface TerminalCompletionSourceFailureHandler

Receives original non-cancellation failures from merged completion sources. Ordinary exceptions are isolated; unexpected errors are reported before they fail collection and cancel sibling sources.

TerminalCompletionSourcePrior

object TerminalCompletionSourcePrior

Reviewed cold-start priors for the built-in completion source families.

TerminalCompletionSources

object TerminalCompletionSources

Factories for dependency-free, host-composable completion sources.

TerminalDirectoryListingRequest

data class TerminalDirectoryListingRequest(val workingDirectoryUri: String, val directoryPrefix: String, val entryNamePrefix: String)

Host-resolved directory-listing request used by path completion.

TerminalFileEntry

data class TerminalFileEntry(val name: String, val isDirectory: Boolean)

Single file system entry description returned by TerminalFileSystemProvider.

TerminalFileSystemProvider

fun interface TerminalFileSystemProvider

Host-implemented file system provider for sandbox-aware path completion.

TerminalFuzzyPathEntry

data class TerminalFuzzyPathEntry(val path: String, val isDirectory: Boolean, val detail: String? = null)

One host-indexed path available to fuzzy path completion.

TerminalFuzzyPathProvider

fun interface TerminalFuzzyPathProvider

Supplies host-bounded fuzzy matches for one immutable completion request and its resolved terminal context.

TerminalGradleTask

data class TerminalGradleTask @JvmOverloads constructor(val path: String, val description: String = "", val projectDirectory: String? = null)

One imported Gradle task returned by a host completion loader.

TerminalShellCapabilities

data class TerminalShellCapabilities @JvmOverloads constructor(val syntax: TerminalShellSyntax = TerminalShellSyntax.PLAIN, val quoting: TerminalShellQuotingPolicy = TerminalShellQuotingPolicy.CONSERVATIVE)

Immutable shell capabilities resolved by the host from authoritative profile metadata before a completion request is created.

TerminalShellQuotingPolicy

enum TerminalShellQuotingPolicy : Enum<TerminalShellQuotingPolicy>

Shell-specific quoting policy for replacement text produced by completion sources.

TerminalShellSyntax

enum TerminalShellSyntax : Enum<TerminalShellSyntax>

Shell lexical policy used to identify command separators and escapes while resolving the command segment that contains the completion cursor.