This is Civboot's VT100 terminal interface library. It implements (and also defines) the API that civboot terminal emulators must implement to be considered Civboot compliant.

It has the following core types and constants:

• Term object, see below
• AsciiColor which is a map from single ascii lowercase characters to the color name (i.e. w -> white). These can be used in Term.fg and Term.bg to set the relvant colors.
• FgColor and BgColor contains a map from the color name to the VT100 color code (for external libraries).
• Various key utility functions and maps for checking and working with the values sent by Term:input()

To be civboot compliant the Term type exported must have the following API:

• ds.Grid fields text, fg, bg for terminal text, foreground color and background color respectively
• l, c fields for setting the cursor location (which is drawn)
• h, w (height width) fields (see resize())
• :input(keysend) method which asyncronously (LAP) sends any user-inputed keys
• :draw() method which draws the text
• :resize() method that (if nothing is passed to it) retrieves the h, w fields and updates and clears child grids.
• :clear() method which clears all child grids.
• run boolean (default=true) which can be set to false to stop related coroutines (best effort)

Mod vt100

Civboot vt100 Terminal library that supports LAP protocol.

Module for interacting with the vt100 via keys and AsciiColors.

Types: ctrl Term

Functions

• fn key
• fn ctrlChar
• fn literal(key) -> literalstring?
  Convert any key to it's literal form
      literal'a'       -> 'a'
      literal'enter'   -> '\n'
      literal'esc'     -> nil
   
• fn keyError(key) -> errstring?
  Check that a key is valid. Return errstring if not.
• fn checkKey(key) -> key?, errstring?
• fn colorFB(f, fg, bg, fg0, bg0)
  Set the color, taking into account the previous color
• fn acwrite(f, colorFB, fg, bg, fgstr, bgstr, str, ...) -> fg,bg, ok,err?
  write to the terminal-like file f using colors fgstr and bgstr accounting for previous color codes fg, bg

  Additional strings (...) are written using plain color.

  Return: fg, bg, write(str, ...)

  Note: fg and bg are the updated color codes
• fn setrawmode()
• fn setsanemode()
• fn savemode() -> mode?, errmsg?
• fn restoremode('stty '..mode)
• fn start() -> savedmode
• fn stop(fd, savedmode)
• fn Fmt(t)
  create a Fmt with sensible defaults from the config
• fn main(args)
  Listens to keyboard inputs and echoes them.
• fn setup(args)
  The recommended setup function, enables color in the terminal in civstack libraries (and those that adhere to them).

Mod vt100.ctrl

Direct terminal control functions

Functions

• fn right(key) -> key?, errstring?
• fn getlc(key) -> key?, errstring?
• fn hide(key) -> key?, errstring?
• fn up(key) -> key?, errstring?
• fn restore(key) -> key?, errstring?
• fn clear(key) -> key?, errstring?
• fn save(key) -> key?, errstring?
• fn colorFB(key) -> key?, errstring?
• fn show(key) -> key?, errstring?
• fn down(key) -> key?, errstring?
• fn reset(key) -> key?, errstring?
• fn golc(key) -> key?, errstring?
• fn color(key) -> key?, errstring?
• fn left(key) -> key?, errstring?
• fn cleareol(key) -> key?, errstring?
• fn nextline(key) -> key?, errstring?
• fn size(f)
  causes terminal to send size as (escaped) cursor position

Record Term

VT100 Terminal Emulator

• Write the text to display
• Write the foreground/background colors to fg/bg
• Then call :draw() to draw to terminal.

Requires vt100.start() have been called to initiate raw mode.

Fields:

• fd file to write output to in draw()
• l =1 cursor line
• c =1 cursor column
• h =40 height
• w =80 width
• text the text to display
• fg foreground color (ASCII coded)
• bg background color (ASCII coded)
• run =true set to false to stop coroutines
• styler optional styler

Methods

• fn:clear()
• fn:resize()
  request size and clear children This can only be run with an active (LAP) input coroutine
• fn:draw()
  draw the text and color(fg/bg) grids to the screen
• fn:input(send) -> infinite loop (run in coroutine)
  function to run in a (LAP) coroutine. send() is called with each key recieved. Typically this is a lap.Send.

Record vt100.AcWriter

Fields:

• f
• fg ="z" current foreground ac letter
• bg ="z" current background ac letter

Methods

• fn:flush()
• fn:acwrite(fgstr, bgstr, ...) -> write(...)
  :acwrite(fgstr, bgstr, str, ...): writes str with style of fg/bg str
• fn:write(nil, nil, ...)
  write plain

Mod vt100.testing

helpers for testing/demoing vt100

Types: Fake

Functions

• fn startTmp() -> out, err
  start rawmode using tmpfiles
• fn run(fn)
  Run function in a LAP environment with terminal started and std in/out set correctly.

Record Fake

Fields:

• fd file to write output to in draw()
• l =1 cursor line
• c =1 cursor column
• h =40 height
• w =80 width
• text the text to display
• fg foreground color (ASCII coded)
• bg background color (ASCII coded)
• run =true set to false to stop coroutines
• styler optional styler

Methods

• fn:resize(l, c)
• fn draw()
  Function that indicates an API is not supported for a type. Throws error'not supported'.