Argos/onl.ycode.argos.terminal/ANSITerminal

ANSITerminal

class ANSITerminal(useStdErr: Boolean = false) : StateTerminal(source)

Terminal implementation that uses ANSI escape codes for colored output.

This terminal provides colored formatting using ANSI escape sequences:

Strong text: Orange color (ANSI 208)
Parameters: Cyan color (ANSI 36)
Errors: Red color (ANSI 31)
Plain text: Reset to default color

Parameters

useStdErr

Whether to output to standard error instead of standard output

Constructors

ANSITerminal

constructor(useStdErr: Boolean = false)

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

closingError

open fun closingError()

Called when closing error text formatting.

closingParam

open fun closingParam()

Called when closing parameter/code text formatting.

closingPlain

open fun closingPlain()

Called when closing plain text formatting.

closingStrong

open fun closingStrong()

Called when closing strong/bold text formatting.

emitError

open override fun emitError(text: String)

Emits text formatted as an error message.

emitNewLine

open fun emitNewLine()

Emits a platform-appropriate newline sequence.

emitParam

open override fun emitParam(text: String)

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

emitPlain

open override fun emitPlain(text: String)

Emits plain text without any formatting.

emitStrong

open override fun emitStrong(text: String)

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

endEmit

open override fun endEmit()

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

openingError

open override fun openingError(previous: ContentStyle)

Outputs ANSI escape sequence for error text (red color).

openingParam

open override fun openingParam(previous: ContentStyle)

Outputs ANSI escape sequence for parameter text (cyan color).

openingPlain

open override fun openingPlain(previous: ContentStyle)

Outputs ANSI reset sequence to return to plain text formatting.

openingStrong

open override fun openingStrong(previous: ContentStyle)

Outputs ANSI escape sequence for strong/bold text (orange color).

sendText

open override fun sendText(text: String)

Sends raw text to the output stream.

startEmit

open override fun startEmit()

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