nimterm/platform_posix

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

POSIX terminal backend.

Types

PosixBackend

PosixBackend = ref object of TerminalBackend
  capabilities*: TerminalCapabilities
  fullscreen*: bool

View source

Procedures

detectTerminalCapabilities

proc detectTerminalCapabilities(): TerminalCapabilities {.raises: [],
    tags: [ReadEnvEffect], forbids: [].}

Returns: TerminalCapabilities.

View source

newPosixBackend

proc newPosixBackend(capabilities = detectTerminalCapabilities();
                     fullscreen = true): TerminalBackend {.raises: [], tags: [],
    forbids: [].}

Returns: TerminalBackend.

Arguments

Name	Type	Default
`capabilities`	`inferred`	`detectTerminalCapabilities()`
`fullscreen`	`inferred`	`true`

View source

newPlatformBackend

proc newPlatformBackend(capabilities = detectTerminalCapabilities();
                        fullscreen = true): TerminalBackend {.raises: [],
    tags: [], forbids: [].}

Returns: TerminalBackend.

Arguments

Name	Type	Default
`capabilities`	`inferred`	`detectTerminalCapabilities()`
`fullscreen`	`inferred`	`true`

View source

frameOutput

proc frameOutput(frame, previous: Canvas; force = false): string {.raises: [],
    tags: [], forbids: [].}

Returns: string.

Arguments

Name	Type	Default
`frame`	`Canvas`
`previous`	`Canvas`
`force`	`inferred`	`false`

View source

Methods

init

method init(backend: PosixBackend) {.raises: [OSError, Exception], tags: [
    ReadEnvEffect, WriteIOEffect, RootEffect], forbids: [].}

Arguments

Name	Type	Default
`backend`	`PosixBackend`

View source

shutdown

method shutdown(backend: PosixBackend) {.raises: [IOError],
    tags: [WriteIOEffect, ReadEnvEffect], forbids: [].}

Arguments

Name	Type	Default
`backend`	`PosixBackend`

View source

wake

method wake(backend: PosixBackend) {.raises: [], tags: [], forbids: [].}

Arguments

Name	Type	Default
`backend`	`PosixBackend`

View source

size

method size(backend: PosixBackend): Size {.raises: [], tags: [ReadEnvEffect],
    forbids: [].}

Returns: Size.

Arguments

Name	Type	Default
`backend`	`PosixBackend`

View source

readEvent

method readEvent(backend: PosixBackend; timeoutMs: int): UiEvent {.
    raises: [IOError, OSError, TermError, Exception, CatchableError],
    tags: [WriteIOEffect, ReadEnvEffect, RootEffect, TimeEffect], forbids: [].}

Returns: UiEvent.

Arguments

Name	Type	Default
`backend`	`PosixBackend`
`timeoutMs`	`int`

View source

present

method present(backend: PosixBackend; frame: Canvas) {.raises: [IOError],
    tags: [WriteIOEffect], forbids: [].}

Arguments

Name	Type	Default
`backend`	`PosixBackend`
`frame`	`Canvas`

View source

resetPresentation

method resetPresentation(backend: PosixBackend) {.raises: [], tags: [],
    forbids: [].}

Arguments

Name	Type	Default
`backend`	`PosixBackend`

View source