mosaic-terminal/org.unitedsoftware.mosaic.terminal/Terminal

Terminal

interface Terminal : AutoCloseable

Types

Capabilities

interface Capabilities

Size

class Size(val columns: Int, val rows: Int, val width: Int = 0, val height: Int = 0)

State

interface State

Theme

enum Theme : Enum<Terminal.Theme>

Properties

canSuspendProcess

open val canSuspendProcess: Boolean

Whether suspendProcess is supported. It needs job control, which Windows does not have, and only applies to the terminal the process was started in, not, for example, a remote one.

capabilities

abstract val capabilities: Terminal.Capabilities

events

abstract val events: ReceiveChannel<Event>

interactive

abstract val interactive: Boolean

name

abstract val name: String?

state

abstract val state: Terminal.State

Functions

expect abstract fun close()

released

open suspend fun <T> released(block: suspend () -> T): T

Restores the terminal to how it was before this took it over while block runs, so that other programs can use it, like an editor or an interactive command, and takes it over again afterwards. No events are read meanwhile, so they go to those programs instead.

suspendProcess

open suspend fun suspendProcess(): Boolean

Stops the process like Ctrl+Z normally does in a shell, with the terminal released, and returns once the shell continues it, like with fg. Returns false right away when canSuspendProcess is false.