mordant/com.github.ajalt.mordant.terminal/TerminalInfo

TerminalInfo

data class TerminalInfo(var width: Int, var height: Int, var ansiLevel: AnsiLevel, var ansiHyperLinks: Boolean, val outputInteractive: Boolean, val inputInteractive: Boolean, val crClearsLine: Boolean)

Information about the current terminal

width and height don't automatically change if the terminal is resized. Call updateTerminalSize to get the latest values.

Constructors

constructor(width: Int, height: Int, ansiLevel: AnsiLevel, ansiHyperLinks: Boolean, outputInteractive: Boolean, inputInteractive: Boolean, crClearsLine: Boolean)

Properties

var ansiHyperLinks: Boolean

If true, ANSI hyperlink codes can be used

var ansiLevel: AnsiLevel

The level of ANSI codes to use when printing to the terminal

val crClearsLine: Boolean

If true, \r will clear the entire line it's printed on in the current terminal, if false, \r will only move the cursor

var height: Int

The terminal height, in cells

inputInteractive

val inputInteractive: Boolean

If false the intput stream is not an interactive terminal, such as when it's redirected from a file

val interactive: Boolean

Return true if both input and output are interactive

outputInteractive

val outputInteractive: Boolean

If false the output stream is not an interactive terminal, such as when it's redirected to a file.

The terminal width, in cells

Functions

updateTerminalSize

fun updateTerminalSize(): Boolean

Query the terminal for its current size, updating width and height if successful.