terminal

This module contains a few procedures to control the terminal (also called console). On UNIX, the implementation simply uses ANSI escape sequences and does not depend on any other module, on Windows it uses the Windows API. Changing the style is permanent even after program termination! Use the code system.addQuitProc(resetAttributes) to restore the defaults. Similarly, if you hide the cursor, make sure to unhide it with showCursor before quitting.

Imports

macros, strformat, strutils, colors, termios, posix, os, parseutils, termios

Types

Style = enum styleBright = 1, ## bright text styleDim, ## dim text styleItalic, ## italic (or reverse on terminals not supporting) styleUnderscore, ## underscored text styleBlink, ## blinking/bold text styleBlinkRapid, ## rapid blinking/bold text (not widely supported) styleReverse, ## reverse styleHidden, ## hidden text styleStrikethrough ## strikethrough: different styles for text output Source Edit
ForegroundColor = enum fgBlack = 30, ## black fgRed, ## red fgGreen, ## green fgYellow, ## yellow fgBlue, ## blue fgMagenta, ## magenta fgCyan, ## cyan fgWhite, ## white fg8Bit, ## 256-color (not supported, see ``enableTrueColors`` instead.) fgDefault ## default terminal foreground color: terminal's foreground colors Source Edit
BackgroundColor = enum bgBlack = 40, ## black bgRed, ## red bgGreen, ## green bgYellow, ## yellow bgBlue, ## blue bgMagenta, ## magenta bgCyan, ## cyan bgWhite, ## white bg8Bit, ## 256-color (not supported, see ``enableTrueColors`` instead.) bgDefault ## default terminal background color: terminal's background colors Source Edit
TerminalCmd = enum resetStyle, ## reset attributes fgColor, ## set foreground's true color bgColor ## set background's true color: commands that can be expressed as arguments Source Edit

Consts

ansiResetCode = "\e[0m": Source Edit

Procs

proc terminalWidthIoctl(fds: openArray[int]): int {...}{.raises: [], tags: [].}: Returns terminal width from first fd that supports the ioctl. Source Edit
proc terminalHeightIoctl(fds: openArray[int]): int {...}{.raises: [], tags: [].}: Returns terminal height from first fd that supports the ioctl. Source Edit
proc terminalWidth(): int {...}{.raises: [ValueError], tags: [ReadEnvEffect].}: Returns some reasonable terminal width from either standard file descriptors, controlling terminal, environment variables or tradition. Source Edit
proc terminalHeight(): int {...}{.raises: [ValueError], tags: [ReadEnvEffect].}: Returns some reasonable terminal height from either standard file descriptors, controlling terminal, environment variables or tradition. Zero is returned if the height could not be determined. Source Edit
proc terminalSize(): tuple[w, h: int] {...}{.raises: [ValueError], tags: [ReadEnvEffect].}: Returns the terminal width and height as a tuple. Internally calls terminalWidth and terminalHeight, so the same assumptions apply. Source Edit
proc hideCursor(f: File) {...}{.raises: [IOError], tags: [WriteIOEffect].}: Hides the cursor. Source Edit
proc showCursor(f: File) {...}{.raises: [IOError], tags: [WriteIOEffect].}: Shows the cursor. Source Edit
proc setCursorPos(f: File; x, y: int) {...}{.raises: [IOError, ValueError], tags: [WriteIOEffect].}: Sets the terminal's cursor to the (x,y) position. (0,0) is the upper left of the screen. Source Edit
proc setCursorXPos(f: File; x: int) {...}{.raises: [IOError, ValueError], tags: [WriteIOEffect].}: Sets the terminal's cursor to the x position. The y position is not changed. Source Edit
proc cursorUp(f: File; count = 1) {...}{.raises: [IOError], tags: [WriteIOEffect].}: Moves the cursor up by count rows. Source Edit
proc cursorDown(f: File; count = 1) {...}{.raises: [IOError, ValueError], tags: [WriteIOEffect].}: Moves the cursor down by count rows. Source Edit
proc cursorForward(f: File; count = 1) {...}{.raises: [IOError, ValueError], tags: [WriteIOEffect].}: Moves the cursor forward by count columns. Source Edit
proc cursorBackward(f: File; count = 1) {...}{.raises: [IOError, ValueError], tags: [WriteIOEffect].}: Moves the cursor backward by count columns. Source Edit
proc eraseLine(f: File) {...}{.raises: [IOError, ValueError], tags: [WriteIOEffect].}: Erases the entire current line. Source Edit
proc eraseScreen(f: File) {...}{.raises: [IOError], tags: [WriteIOEffect].}: Erases the screen with the background colour and moves the cursor to home. Source Edit
proc resetAttributes(f: File) {...}{.raises: [IOError], tags: [WriteIOEffect].}: Resets all attributes. Source Edit
proc ansiStyleCode(style: int): string {...}{.raises: [ValueError], tags: [].}: Source Edit
proc setStyle(f: File; style: set[Style]) {...}{.raises: [IOError, ValueError], tags: [WriteIOEffect].}: Sets the terminal style. Source Edit
proc writeStyled(txt: string; style: set[Style] = {styleBright}) {...}{. raises: [IOError, ValueError], tags: [WriteIOEffect].}: Writes the text txt in a given style to stdout. Source Edit
proc setForegroundColor(f: File; fg: ForegroundColor; bright = false) {...}{. raises: [IOError, ValueError], tags: [WriteIOEffect].}: Sets the terminal's foreground color. Source Edit
proc setBackgroundColor(f: File; bg: BackgroundColor; bright = false) {...}{. raises: [IOError, ValueError], tags: [WriteIOEffect].}: Sets the terminal's background color. Source Edit
proc ansiForegroundColorCode(fg: ForegroundColor; bright = false): string {...}{. raises: [ValueError], tags: [].}: Source Edit
proc ansiForegroundColorCode(color: Color): string {...}{.raises: [ValueError], tags: [].}: Source Edit
proc ansiBackgroundColorCode(color: Color): string {...}{.raises: [ValueError], tags: [].}: Source Edit
proc setForegroundColor(f: File; color: Color) {...}{.raises: [IOError, ValueError], tags: [RootEffect, WriteIOEffect].}: Sets the terminal's foreground true color. Source Edit
proc setBackgroundColor(f: File; color: Color) {...}{.raises: [IOError, ValueError], tags: [RootEffect, WriteIOEffect].}: Sets the terminal's background true color. Source Edit
proc isatty(f: File): bool {...}{.raises: [], tags: [].}: Returns true if f is associated with a terminal device. Source Edit
proc getch(): char {...}{.raises: [IOError, EOFError], tags: [ReadIOEffect].}: Read a single character from the terminal, blocking until it is entered. The character is not printed to the terminal. Source Edit
proc readPasswordFromStdin(prompt: string; password: var TaintedString): bool {...}{. tags: [ReadIOEffect, WriteIOEffect], raises: [IOError].}: Source Edit
proc readPasswordFromStdin(prompt = "password: "): TaintedString {...}{. raises: [IOError], tags: [ReadIOEffect, WriteIOEffect].}: Reads a password from stdin without printing it. Source Edit
proc resetAttributes() {...}{.noconv, raises: [IOError], tags: [WriteIOEffect].}: Resets all attributes on stdout. It is advisable to register this as a quit proc with system.addQuitProc(resetAttributes). Source Edit
proc isTrueColorSupported(): bool {...}{.raises: [], tags: [RootEffect].}: Returns true if a terminal supports true color. Source Edit
proc enableTrueColors() {...}{.raises: [], tags: [RootEffect, ReadEnvEffect].}: Enable true color. Source Edit
proc disableTrueColors() {...}{.raises: [], tags: [RootEffect].}: Disable true color. Source Edit

Macros

macro styledWrite(f: File; m: varargs[typed]): untyped

Similar to write, but treating terminal style arguments specially. When some argument is Style, set[Style], ForegroundColor, BackgroundColor or TerminalCmd then it is not sent directly to f, but instead corresponding terminal style proc is called.

Example:

stdout.styledWrite(fgRed, "red text ")
stdout.styledWrite(fgGreen, "green text")