Argos/onl.ycode.argos.terminal/Terminal

Terminal

Interface for terminal output with pluggable styling support.

This interface allows the argument parser to output formatted text to different terminal types, including ANSI color terminals, plain text, and custom formats like Markdown.

Implementations can provide different styling capabilities:

ANSITerminal - Colored output using ANSI escape codes
PlainTerminal - Plain text output without formatting
MarkdownTerminal - Markdown-formatted output

The terminal handles help text generation, error messages, and usage information with appropriate styling for the target output format.

Inheritors

PlainTerminal

StateTerminal

StringTerminal

Properties

infoColumn

open val infoColumn: Int

Column position for aligning help text descriptions.

width

open val width: Int

The terminal width in characters for text wrapping. Defaults to system terminal width.

Functions

emitError

open fun emitError(text: String)

Emits text formatted as an error message.

emitNewLine

open fun emitNewLine()

Emits a platform-appropriate newline sequence.

emitParam

open fun emitParam(text: String)

Emits text formatted as a parameter (e.g., option names, values).

emitPlain

abstract fun emitPlain(text: String)

Emits plain text without any formatting.

emitStrong

open fun emitStrong(text: String)

Emits text with strong/bold formatting. Default implementation outputs as plain text.

endEmit

open fun endEmit()

Called after completing a sequence of text emissions. Override for cleanup operations.

startEmit

open fun startEmit()

Called before starting a sequence of text emissions. Override for setup operations.