mordant/com.github.ajalt.mordant.terminal/TerminalRecorder

TerminalRecorder

class TerminalRecorder : TerminalInterface

A TerminalInterface that records all output and allows you to provide input.

Exmaple

val recorder = TerminalRecorder()
val t = Terminal(terminalInterface = recorder)
t.println("Hello, world!")
assertEquals(recorder.output(), "Hello, world!\n")

Constructors

TerminalRecorder

constructor(ansiLevel: AnsiLevel = AnsiLevel.TRUECOLOR, width: Int = 79, height: Int = 24, hyperlinks: Boolean = ansiLevel != AnsiLevel.NONE, outputInteractive: Boolean = ansiLevel != AnsiLevel.NONE, inputInteractive: Boolean = ansiLevel != AnsiLevel.NONE, supportsAnsiCursor: Boolean = false)

Properties

inputEvents

var inputEvents: MutableList<InputEvent>

Input events to return when reading in raw mode

inputLines

var inputLines: MutableList<String>

Lines of input to return from readLineOrNull.

Functions

clearOutput

fun clearOutput()

Clear stdout, stderr, and output

completePrintRequest

open override fun completePrintRequest(request: PrintRequest)

Display a PrintRequest on this terminal.

enterRawMode

open override fun enterRawMode(mouseTracking: MouseTracking): AutoCloseable

Enter raw mode on the terminal, disabling line buffering and echoing to enable reading individual character.

getTerminalSize

open override fun getTerminalSize(): Size

Return the current size, in cells, of the terminal, or null if the size is unknown.

info

open override fun info(ansiLevel: AnsiLevel?, hyperlinks: Boolean?, outputInteractive: Boolean?, inputInteractive: Boolean?): TerminalInfo

Get information about the current terminal.

output

fun output(): String

The combined content of stdout and stderr

outputAsHtml

fun TerminalRecorder.outputAsHtml(includeBodyTag: Boolean = true, includeCodeTag: Boolean = true, backgroundColor: Color? = SRGB("#0c0c0c")): String

Render the contents of this TerminalRecorder as an HTML document.

readInputEvent

open override fun readInputEvent(timeout: TimeMark, mouseTracking: MouseTracking): InputEvent?

Read a single input event from the terminal, or null if no event is available but this call should be retried immediately.

readLineOrNull

open override fun readLineOrNull(hideInput: Boolean): String?

Read a single line of input from stdin, returning null if no input is available

shouldAutoUpdateSize

open fun shouldAutoUpdateSize(): Boolean

Return true if the getTerminalSize method should be called frequently to update the size.

stderr

fun stderr(): String

The content written to stderr

stdout

fun stdout(): String

The content written to stdout