kewt-terminal/dev.kewt.terminal/AnsiTerminal

AnsiTerminal

class AnsiTerminal(val colorMode: ColorMode = ColorMode.detect()) : Terminal(source)

An implementation of Terminal that uses ANSI escape sequences.

This implementation handles raw mode management, cursor control, screen clearing, and input parsing for standard terminal emulators.

Constructors

AnsiTerminal

constructor(colorMode: ColorMode = ColorMode.detect())

Properties

colorMode

val colorMode: ColorMode

The ColorMode to use for rendering.

Functions

clear

open override fun clear()

Clears the entire terminal screen.

clearLine

open override fun clearLine()

Clears the current line.

enterRawMode

open override fun enterRawMode()

Enters terminal raw mode and initializes state.

exitRawMode

open override fun exitRawMode()

Exits raw mode and restores the terminal state.

flush

open override fun flush()

Flushes any pending output to the terminal.

hideCursor

open override fun hideCursor()

Hides the terminal cursor.

moveCursor

open override fun moveCursor(x: Int, y: Int)

Moves the cursor to the specified coordinates (0-indexed).

poll

open override fun poll(timeoutMs: Int): Boolean

Waits for input to become available.

read

open override fun read(): Event?

Attempts to read the next input Event.

setTitle

open override fun setTitle(title: String)

Sets the terminal window title.

showCursor

open override fun showCursor()

Shows the terminal cursor.

size

open override fun size(): Size

Returns the current physical size of the terminal.

useRawMode

inline fun <T> Terminal.useRawMode(block: (Terminal) -> T): T

Safely enters raw mode, executes the block, and ensures raw mode is exited even if an exception occurs.

write

open override fun write(text: String)

Writes raw text to the terminal.