threecode/toolstream

Bash tool-output viewport model and transcript formatting.

The live viewport is semantic state: command banner, streamed lines, cutoff policy, and final exit code. Terminal placement belongs to engine.

Types

StreamingView = object
  maxLines*: int
  idx*: int
  total*: int
  banner*: string
  exitCode*: int
  symbol*: string
  buf*: seq[string]

Procs

proc addLine(v: var StreamingView; line: string) {....raises: [], tags: [],
    forbids: [].}
proc finalTranscriptRows(banner: string; code: int; lines: openArray[string];
                         idx: int; maxLines = StreamMaxLines): seq[string] {.
    ...raises: [], tags: [ReadEnvEffect], forbids: [].}
proc initStreamingView(maxLines = StreamMaxLines; idx = 0; banner = ""): StreamingView {.
    ...raises: [], tags: [], forbids: [].}
proc printBashScroll(res: string; idx: int; maxLines = StreamMaxLines) {.
    ...raises: [IOError], tags: [ReadEnvEffect, WriteIOEffect], forbids: [].}
proc printLine(l: string) {....raises: [IOError],
                            tags: [ReadEnvEffect, WriteIOEffect], forbids: [].}
Print one wrapped tool-output line as an append-only transcript write. This is exported for display formatting; live viewport operations below take the terminal lock themselves.
proc setExitCode(v: var StreamingView; code: int) {....raises: [], tags: [],
    forbids: [].}
proc setSymbol(v: var StreamingView; symbol: string) {....raises: [], tags: [],
    forbids: [].}
proc subtleWriteLn(outFile: File; body: string) {....raises: [IOError],
    tags: [WriteIOEffect], forbids: [].}
proc viewportRows(v: StreamingView): seq[string] {....raises: [],
    tags: [ReadEnvEffect], forbids: [].}