mosaic-tty/com.jakewharton.mosaic.tty/TestTerminal

TestTerminal

expect class TestTerminal : AutoCloseable

actual class TestTerminal : AutoCloseable

Types

Companion

expect object Companion

actual object Companion

Properties

streams

expect val streams: StandardStreams

The client standard input, output, and error streams.

actual val streams: StandardStreams

tty

expect val tty: Tty

The client Tty whose output can be read here by readTty and for which input can be sent with writeTty. Size changes can be sent with resize, along with the Windows-specific sendFocusEvent, sendKeyEvent, and sendMouseEvent.

actual val tty: Tty

Functions

expect open override fun close()

actual open override fun close()

interruptStandardErrorRead

expect fun interruptStandardErrorRead()

Signal blocking calls to readStandardError or readStandardErrorWithTimeout to wake up and return 0.

actual fun interruptStandardErrorRead()

interruptStandardOutputRead

expect fun interruptStandardOutputRead()

Signal blocking calls to readStandardOutput or readStandardOutputWithTimeout to wake up and return 0.

actual fun interruptStandardOutputRead()

interruptTtyRead

expect fun interruptTtyRead()

Signal blocking calls to readTty or readTtyWithTimeout to wake up and return 0.

actual fun interruptTtyRead()

readStandardError

expect fun readStandardError(buffer: ByteArray, offset: Int, count: Int): Int

Read up to count bytes into buffer at offset from the standard error stream. The number of bytes read will be returned. 0 will be returned if interruptStandardErrorRead is called while waiting for data.

actual fun readStandardError(buffer: ByteArray, offset: Int, count: Int): Int

readStandardErrorWithTimeout

expect fun readStandardErrorWithTimeout(buffer: ByteArray, offset: Int, count: Int, timeoutMillis: Int): Int

actual fun readStandardErrorWithTimeout(buffer: ByteArray, offset: Int, count: Int, timeoutMillis: Int): Int

readStandardOutput

expect fun readStandardOutput(buffer: ByteArray, offset: Int, count: Int): Int

Read up to count bytes into buffer at offset from the standard output stream. The number of bytes read will be returned. 0 will be returned if interruptStandardOutputRead is called while waiting for data.

actual fun readStandardOutput(buffer: ByteArray, offset: Int, count: Int): Int

readStandardOutputWithTimeout

expect fun readStandardOutputWithTimeout(buffer: ByteArray, offset: Int, count: Int, timeoutMillis: Int): Int

actual fun readStandardOutputWithTimeout(buffer: ByteArray, offset: Int, count: Int, timeoutMillis: Int): Int

readTty

expect fun readTty(buffer: ByteArray, offset: Int, count: Int): Int

Read up to count bytes into buffer at offset from the PTY. The number of bytes read will be returned. 0 will be returned if interruptTtyRead is called while waiting for data.

actual fun readTty(buffer: ByteArray, offset: Int, count: Int): Int

readTtyWithTimeout

expect fun readTtyWithTimeout(buffer: ByteArray, offset: Int, count: Int, timeoutMillis: Int): Int

Read up to count bytes into buffer at offset from the PTY. The number of bytes read will be returned. 0 will be returned if interruptTtyRead is called while waiting for data, or if at least timeoutMillis have passed without data.

actual fun readTtyWithTimeout(buffer: ByteArray, offset: Int, count: Int, timeoutMillis: Int): Int

resize

expect fun resize(columns: Int, rows: Int, width: Int, height: Int)

Resize the TTY.

actual fun resize(columns: Int, rows: Int, width: Int, height: Int)

sendFocusEvent

expect fun sendFocusEvent(focused: Boolean)

Send a focus event to tty's callback.

actual fun sendFocusEvent(focused: Boolean)

sendKeyEvent

expect fun sendKeyEvent()

Send a key event to tty's callback.

actual fun sendKeyEvent()

sendMouseEvent

expect fun sendMouseEvent()

Send a mouse event to tty's callback.

actual fun sendMouseEvent()

writeStandardInput

expect fun writeStandardInput(buffer: ByteArray, offset: Int, count: Int): Int

Write up to count bytes into buffer at offset to the standard input stream. If the standard input stream is set to the TTY, this is equivalent to writeTty. The number of bytes written will be returned.

actual fun writeStandardInput(buffer: ByteArray, offset: Int, count: Int): Int

writeTty

expect fun writeTty(buffer: ByteArray, offset: Int, count: Int): Int

Write up to count bytes into buffer at offset to the PTY. The number of bytes written will be returned.

actual fun writeTty(buffer: ByteArray, offset: Int, count: Int): Int