Skip to content
nimterm

nimterm/term_posix

This page is generated from the module’s exported API and ## documentation comments.

POSIX terminal control for nimterm.

Types

Section titled “Types”

TermError

Section titled “TermError”
TermError = object of CatchableError

View source

Procedures

Section titled “Procedures”

termWidth

Section titled “termWidth”
proc termWidth(): int {.raises: [], tags: [ReadEnvEffect], forbids: [].}

Returns: int.

View source

termHeight

Section titled “termHeight”
proc termHeight(): int {.raises: [], tags: [ReadEnvEffect], forbids: [].}

Returns: int.

View source

copyToClipboard

Section titled “copyToClipboard”
proc copyToClipboard(text: string) {.raises: [IOError], tags: [WriteIOEffect],
                                     forbids: [].}

Arguments

Section titled “Arguments”
Name Type Default
text string

View source

enableProtocols

Section titled “enableProtocols”
proc enableProtocols(caps: TerminalCapabilities): string {.raises: [], tags: [],
    forbids: [].}

Returns: string.

Arguments

Section titled “Arguments”
Name Type Default
caps TerminalCapabilities

View source

disableProtocols

Section titled “disableProtocols”
proc disableProtocols(caps: TerminalCapabilities): string {.raises: [],
    tags: [], forbids: [].}

Returns: string.

Arguments

Section titled “Arguments”
Name Type Default
caps TerminalCapabilities

View source

termShutdown

Section titled “termShutdown”
proc termShutdown() {.raises: [IOError], tags: [WriteIOEffect, ReadEnvEffect],
                      forbids: [].}

View source

termInit

Section titled “termInit”

Raw-ish: no echo/canonical/extended processing; disable ISIG so Ctrl-C arrives as byte 3 and Ctrl-O is not consumed by VDISCARD.

proc termInit(capabilities = defaultCapabilities(); fullscreen = true) {.
    raises: [TermError, Exception, CatchableError],
    tags: [ReadEnvEffect, WriteIOEffect, RootEffect], forbids: [].}

Arguments

Section titled “Arguments”
Name Type Default
capabilities inferred defaultCapabilities()
fullscreen inferred true

View source

terminalActive

Section titled “terminalActive”
proc terminalActive(): bool {.raises: [], tags: [], forbids: [].}

Returns: bool.

View source

suspendTerminal

Section titled “suspendTerminal”
proc suspendTerminal() {.raises: [IOError],
                         tags: [WriteIOEffect, ReadEnvEffect], forbids: [].}

View source

resumeTerminal

Section titled “resumeTerminal”
proc resumeTerminal() {.raises: [TermError, Exception, CatchableError],
                        tags: [ReadEnvEffect, WriteIOEffect, RootEffect],
                        forbids: [].}

View source

inputPending

Section titled “inputPending”
proc inputPending(timeoutMs: int): bool {.raises: [], tags: [], forbids: [].}

Returns: bool.

Arguments

Section titled “Arguments”
Name Type Default
timeoutMs int

View source

readByte

Section titled “readByte”
proc readByte(): int {.raises: [], tags: [], forbids: [].}

Returns: int.

View source

readAvailable

Section titled “readAvailable”
proc readAvailable(): string {.raises: [], tags: [], forbids: [].}

Returns: string.

View source

consumeResize

Section titled “consumeResize”
proc consumeResize(): bool {.raises: [], tags: [ReadEnvEffect], forbids: [].}

Returns: bool.

View source

terminalInputIsInteractive

Section titled “terminalInputIsInteractive”
proc terminalInputIsInteractive(): bool {.raises: [], tags: [], forbids: [].}

Returns: bool.

View source

terminalOutputIsInteractive

Section titled “terminalOutputIsInteractive”
proc terminalOutputIsInteractive(): bool {.raises: [], tags: [], forbids: [].}

Returns: bool.

View source

terminalIsInteractive

Section titled “terminalIsInteractive”
proc terminalIsInteractive(): bool {.raises: [], tags: [], forbids: [].}

Returns: bool.

View source