kewt-terminal/dev.kewt.terminal/Terminal

Terminal

interface Terminal(source)

The high-level interface for terminal interaction.

Provides methods for controlling the terminal state, managing the cursor, and handling input/output.

Inheritors

AnsiTerminal

Functions

clear

abstract fun clear()

Clears the entire terminal screen.

clearLine

abstract fun clearLine()

Clears the current line.

enterRawMode

abstract fun enterRawMode()

Enters terminal raw mode and initializes state.

exitRawMode

abstract fun exitRawMode()

Exits raw mode and restores the terminal state.

flush

abstract fun flush()

Flushes any pending output to the terminal.

hideCursor

abstract fun hideCursor()

Hides the terminal cursor.

moveCursor

abstract fun moveCursor(x: Int, y: Int)

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

poll

abstract fun poll(timeoutMs: Int): Boolean

Waits for input to become available.

read

abstract fun read(): Event?

Attempts to read the next input Event.

setTitle

abstract fun setTitle(title: String)

Sets the terminal window title.

showCursor

abstract fun showCursor()

Shows the terminal cursor.

size

abstract 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

abstract fun write(text: String)

Writes raw text to the terminal.