Index

Modules: tuicrown, tuicrown/tuiconsole, tuicrown/tuicontrol, tuicrown/tuisegment, tuicrown/tuistyles, tuicrown/tuivariables, tuicrown/utils.

API symbols

`$`:

• tuiconsole: proc `$`(self: TuiConsoleDimension): string
• tuiconsole: proc `$`(self: TuiConsoleOptions): string
• tuicontrol: proc `$`(self: TuiControl): string
• tuisegment: proc `$`(self: TuiSegment): auto
• tuistyles: proc `$`(self: TuiStyles): string

`+=`:

• tuistyles: proc `+=`(self: var TuiStyles; o: TuiStyles)

`-=`:

• tuistyles: proc `-=`(self: var TuiStyles; o: TuiStyles)

`==`:

• tuisegment: proc `==`(self: TuiSegment; o: TuiSegment): bool
• tuistyles: proc `==`(self: TuiBGType; o: TuiBGType): auto
• tuistyles: proc `==`(self: TuiFGType; o: TuiFGType): auto
• tuistyles: proc `==`(self: TuiStyles; o: TuiStyles): bool

`[]`:

• tuivariables: proc `[]`(self: MatchSeq; idx: int): MatchResult

addStyle:

• tuisegment: proc addStyle(self: var TuiSegment; arg: seq[Style])
• tuisegment: proc addStyle(self: var TuiSegment; color: TuiFGType | ForegroundColor | Color = TuiFGType TuiFGNone.init; bgColor: TuiBGType | BackgroundColor | Color = TuiBGType TuiBGNone.init; styles: seq[Style] = newSeq[Style]())
• tuisegment: proc addStyle(self: var TuiSegment; style: TuiStyles)

addUniq:

• utils: proc addUniq[T](a: var seq[T]; b: seq[T])
• utils: proc addUniq[T](a: var seq[T]; b: T)

argsWithDefault:

• utils: proc argsWithDefault[T](args: seq[T]; index: int; default: T): T

assign:

• tuivariables: proc assign(self: var MatchSeq; idx: int; id: int)

BELL:

• tuicontrol: ControlType.BELL

bgColor:

• tuistyles: proc bgColor(x: TuiBGType | BackgroundColor | Color = bgNone()): TuiBGType
• tuistyles: proc bgColor(self: TuiStyles): auto

bgColor+:

• tuistyles: proc bgColor+(self: TuiStyles; o: seq[TuiBGType]): auto

bgColor=:

• tuistyles: proc bgColor=(self: TuiStyles; o: TuiBGType)

bgNone:

• tuistyles: proc bgNone(): TuiBGType

CARRIAGE_RETURN:

• tuicontrol: ControlType.CARRIAGE_RETURN

check_buffer:

• tuiconsole: proc check_buffer(self: TuiConsole)

clear:

• tuiconsole: proc clear(self: TuiConsole; home = true)

CLEAR:

• tuicontrol: ControlType.CLEAR

colorize:

• tuisegment: proc colorize(self: TuiSegment): seq[TuiSegment]

ColorSystem:

• tuiconsole: enum ColorSystem

conslock:

• tuiconsole: macro conslock(c: TuiConsole; body: untyped): untyped

control:

• tuiconsole: proc control(self: TuiConsole; controls: varargs[ControlType])
• tuiconsole: proc control(self: TuiConsole; controls: varargs[TuiControl])

ControlType:

• tuicontrol: enum ControlType

copy:

• tuisegment: proc copy(refObj: TuiSegment; copyControls = false): auto
• tuistyles: proc copy(refObj: TuiStyles): auto

CURSOR_BACKWARD:

• tuicontrol: ControlType.CURSOR_BACKWARD

CURSOR_DOWN:

• tuicontrol: ControlType.CURSOR_DOWN

CURSOR_FORWARD:

• tuicontrol: ControlType.CURSOR_FORWARD

CURSOR_MOVE_TO:

• tuicontrol: ControlType.CURSOR_MOVE_TO

CURSOR_MOVE_TO_COLUMN:

• tuicontrol: ControlType.CURSOR_MOVE_TO_COLUMN

CURSOR_UP:

• tuicontrol: ControlType.CURSOR_UP

deepCopy:

• tuisegment: proc deepCopy(refObj: TuiSegment; copyControls = false): auto
• tuistyles: proc deepCopy(refObj: TuiStyles): auto

deleteIf:

• utils: proc deleteIf[T](a: var seq[T]; i: int)

delStyle:

• tuisegment: proc delStyle(self: var TuiSegment; arg: seq[Style])
• tuisegment: proc delStyle(self: var TuiSegment; color: TuiFGType | ForegroundColor | Color = TuiFGType TuiFGNone.init; bgColor: TuiBGType | BackgroundColor | Color = TuiBGType TuiBGNone.init; styles: seq[Style] = newSeq[Style]())
• tuisegment: proc delStyle(self: var TuiSegment; style: TuiStyles)

detectColorSystem:

• tuiconsole: proc detectColorSystem(): ColorSystem

DISABLE_ALT_SCREEN:

• tuicontrol: ControlType.DISABLE_ALT_SCREEN

EIGHT_BIT:

• tuiconsole: ColorSystem.EIGHT_BIT

einfo:

• tuicrown: proc einfo(args: varargs[string, `$`])

ENABLE_ALT_SCREEN:

• tuicontrol: ControlType.ENABLE_ALT_SCREEN

eprint:

• tuicrown: proc eprint(args: varargs[string, `$`])

equals:

• tuistyles: proc equals(self: TuiBGType; o: TuiBGType; bothNoneReturnsTrue = false): auto
• tuistyles: proc equals(self: TuiFGType; o: TuiFGType; bothNoneReturnsTrue = false): auto

ERASE_IN_LINE:

• tuicontrol: ControlType.ERASE_IN_LINE

error:

• tuicrown: proc error(args: varargs[string, `$`])

escape:

• tuicontrol: proc escape(self: TuiControl): string

ewarn:

• tuicrown: proc ewarn(args: varargs[string, `$`])

fgColor:

• tuistyles: proc fgColor(x: TuiFGType | ForegroundColor | Color = fgNone()): TuiFGType
• tuistyles: proc fgColor(self: TuiStyles): auto

fgColor+:

• tuistyles: proc fgColor+(self: TuiStyles; o: seq[TuiFGType]): auto

fgColor=:

• tuistyles: proc fgColor=(self: TuiStyles; o: TuiFGType)

fgNone:

• tuistyles: proc fgNone(): TuiFGType

findIf:

• utils: proc findIf[T](s: seq[T]; pred: (T {.noSideEffect.} -> bool)): Option[T]

findSubstr:

• utils: proc findSubstr(s: string; t: string; strFroms: seq[int]): bool

flush:

• tuicrown: proc flush(args: varargs[string, `$`])
• tuiconsole: proc flush(self: TuiConsole)

fromString:

• tuisegment: proc fromString(text: string): seq[TuiSegment]

gConsoleErr:

• tuicrown: let gConsoleErr

gConsoleOut:

• tuicrown: let gConsoleOut

get:

• tuistyles: proc get(self: TuiBGType; otherwise: TuiBGType = bgNone()): TuiBGType
• tuistyles: proc get(self: TuiFGType; otherwise: TuiFGType = fgNone()): TuiFGType
• tuistyles: proc get[T: enum](E: typedesc[T]; idx: string; default: Option[T] = none(T); strFroms: seq[int] = newSeq[int]()): Option[T]

HIDE_CURSOR:

• tuicontrol: ControlType.HIDE_CURSOR

HOME:

• tuicontrol: ControlType.HOME

info:

• tuicrown: proc info(args: varargs[string, `$`])

init:

• tuistyles: proc init(__2617245833: typedesc[TuiFGNone]): TuiFGNone
• tuistyles: proc init(__2617246118: typedesc[TuiBackgroundColor]; param: BackgroundColor): TuiBackgroundColor
• tuistyles: proc init(__2617246157: typedesc[TuiBGColor]; param: Color): TuiBGColor
• tuistyles: proc init(__2617245983: typedesc[TuiFGColor]; param: Color): TuiFGColor
• tuistyles: proc init(__2617245931: typedesc[TuiForegroundColor]; param: ForegroundColor): TuiForegroundColor
• tuistyles: proc init(__2617246020: typedesc[TuiBGNone]): TuiBGNone

input:

• tuicrown: proc input(args: varargs[string, `$`]): string

isAbstract:

• utils: template isAbstract(): untyped

isDigit:

• tuiconsole: proc isDigit(s: string): bool

is_dumb_terminal:

• tuiconsole: proc is_dumb_terminal(self: TuiConsole): bool

isNone:

• tuistyles: proc isNone(self: TuiBGType): auto
• tuistyles: proc isNone(self: TuiFGType): auto

isSome:

• tuistyles: proc isSome(self: TuiBGType): auto
• tuistyles: proc isSome(self: TuiFGType): auto

is_terminal:

• tuiconsole: proc is_terminal(self: TuiConsole): bool

len:

• tuisegment: proc len(self: TuiSegment): int
• tuivariables: proc len(self: MatchSeq): int

lookup:

• tuivariables: proc lookup(self: MatchSeq; idx: int): MatchResult

mainExamples:

• utils: macro mainExamples(body: untyped): untyped

match:

• tuivariables: proc match(self: TuiHighlighter; text: string): MatchSeq

MatchResult:

• tuivariables: type MatchResult

MatchSeq:

• tuivariables: object MatchSeq

newMatchSeq:

• tuivariables: proc newMatchSeq(text_len: int): MatchSeq

newTuiConsole:

• tuiconsole: proc newTuiConsole(o: TuiConsoleOptions; color_system: string = "auto"; file: File = nil; width: int = -1; height: int = -1): TuiConsole

newTuiConsoleBufferLocal:

• tuiconsole: proc newTuiConsoleBufferLocal(): TuiConsoleBufferLocal

newTuiConsoleDimension:

• tuiconsole: proc newTuiConsoleDimension(width: int = -1; height: int = -1): TuiConsoleDimension

newTuiConsoleOptions:

• tuiconsole: proc newTuiConsoleOptions(auto_colorize = true; tab_size = 2; record = false; markup = false; emoji = true; highlight = true; soft_wrap = false; force_terminal = false; is_interactive = false): TuiConsoleOptions

newTuiControl:

• tuicontrol: proc newTuiControl(t: ControlType; args: seq[int]): TuiControl
• tuicontrol: proc newTuiControl(t: ControlType; args: seq[string]): TuiControl
• tuicontrol: proc newTuiControl(t: ControlType; title: string): TuiControl
• tuicontrol: proc newTuiControl(t: ControlType; args: varargs[int]): auto

newTuiHighlighter:

• tuivariables: proc newTuiHighlighter(prefix = ""; highlights = newSeq()): TuiHighlighter

newTuiSegment:

• tuisegment: proc newTuiSegment(text: string = ""; style: TuiStyles = newTuiStyles(); controls: seq[TuiControl] = newSeq(); is_colorized: bool = false): auto

newTuiStyles:

• tuistyles: proc newTuiStyles(color: TuiFGType | ForegroundColor | Color = TuiFGType TuiFGNone.init; bgColor: TuiBGType | BackgroundColor | Color = TuiBGType TuiBGNone.init; styles: seq[Style] = newSeq[Style]()): TuiStyles
• tuistyles: proc newTuiStyles(arg: seq[Style]): TuiStyles
• tuistyles: proc newTuiStyles(old: TuiStyles; texts: string): TuiStyles

parseStr:

• tuistyles: proc parseStr(str: string; isBackground: bool): Option[TuiStyles]

print:

• tuicrown: proc print(args: varargs[string, `$`])
• tuiconsole: proc print(self: TuiConsole; args: seq[string])
• tuiconsole: proc print(self: TuiConsole; args: varargs[string, `$`])
• tuicontrol: proc print(f: File; self: TuiControl)
• tuisegment: proc print(f: File; segseq: seq[TuiSegment])
• tuisegment: proc print(f: File; self: TuiSegment)
• tuistyles: proc print(f: File; self: TuiStyles)
• tuistyles: proc print(self: TuiStyles): string

printToUnix:

• tuicontrol: proc printToUnix(self: TuiControl): string

printWithOpt:

• tuiconsole: proc printWithOpt(self: TuiConsole; sep: string = " "; endl: string = " "; args: seq[string])
• tuiconsole: proc printWithOpt(self: TuiConsole; sep: string = " "; endl: string = " "; args: varargs[string, `$`])

reprHighlighter:

• tuivariables: let reprHighlighter

rror:

• tuicrown: proc rror(args: varargs[string, `$`])

searchColor:

• tuistyles: proc searchColor(token: string): Option[Color]

searchFGBG:

• tuistyles: proc searchFGBG[T: enum](E: typedesc[T]; token: string): Option[T]

searchStyle:

• tuistyles: proc searchStyle(token: string): Option[Style]

SET_WINDOW_TITLE:

• tuicontrol: ControlType.SET_WINDOW_TITLE

SHOW_CURSOR:

• tuicontrol: ControlType.SHOW_CURSOR

STANDARD:

• tuiconsole: ColorSystem.STANDARD

to:

• tuistyles: proc to(val`gensym18: TuiBGType; __2617246016: typedesc[TuiBGNone]): lent TuiBGNone
• tuistyles: proc to(val`gensym19: TuiBGType; __2617246077: typedesc[TuiBackgroundColor]): lent TuiBackgroundColor
• tuistyles: proc to(val`gensym19: var TuiBGType; __2617246082: typedesc[TuiBackgroundColor]): var TuiBackgroundColor
• tuistyles: proc to(val`gensym23: TuiBGType; __2617246142: typedesc[TuiBGColor]): lent TuiBGColor
• tuistyles: proc to(val`gensym23: var TuiBGType; __2617246147: typedesc[TuiBGColor]): var TuiBGColor
• tuistyles: proc to(val`gensym0: TuiFGType; __2617245829: typedesc[TuiFGNone]): lent TuiFGNone
• tuistyles: proc to(val`gensym1: TuiFGType; __2617245890: typedesc[TuiForegroundColor]): lent TuiForegroundColor
• tuistyles: proc to(val`gensym1: var TuiFGType; __2617245895: typedesc[TuiForegroundColor]): var TuiForegroundColor
• tuistyles: proc to(val`gensym5: TuiFGType; __2617245955: typedesc[TuiFGColor]): lent TuiFGColor
• tuistyles: proc to(val`gensym5: var TuiFGType; __2617245960: typedesc[TuiFGColor]): var TuiFGColor

todo:

• utils: template todo(): untyped

toInternal:

• tuistyles: converter toInternal(val`gensym22: TuiBackgroundColor): BackgroundColor
• tuistyles: converter toInternal(val`gensym22: var TuiBackgroundColor): var BackgroundColor
• tuistyles: converter toInternal(val`gensym26: TuiBGColor): Color
• tuistyles: converter toInternal(val`gensym26: var TuiBGColor): var Color
• tuistyles: converter toInternal(val`gensym8: TuiFGColor): Color
• tuistyles: converter toInternal(val`gensym8: var TuiFGColor): var Color
• tuistyles: converter toInternal(val`gensym4: TuiForegroundColor): ForegroundColor
• tuistyles: converter toInternal(val`gensym4: var TuiForegroundColor): var ForegroundColor

toSeq:

• utils: proc toSeq[T](s: Slice[T]): seq[T]

toTuiBGType:

• tuistyles: converter toTuiBGType(arg`gensym19: TuiBackgroundColor): TuiBGType
• tuistyles: converter toTuiBGType(arg`gensym19: var TuiBackgroundColor): var TuiBGType
• tuistyles: converter toTuiBGType(arg`gensym23: TuiBGColor): TuiBGType
• tuistyles: converter toTuiBGType(arg`gensym23: var TuiBGColor): var TuiBGType

toTuiFGType:

• tuistyles: converter toTuiFGType(arg`gensym5: TuiFGColor): TuiFGType
• tuistyles: converter toTuiFGType(arg`gensym5: var TuiFGColor): var TuiFGType
• tuistyles: converter toTuiFGType(arg`gensym1: TuiForegroundColor): TuiFGType
• tuistyles: converter toTuiFGType(arg`gensym1: var TuiForegroundColor): var TuiFGType

TRUECOLOR:

• tuiconsole: ColorSystem.TRUECOLOR

TuiBackgroundColor:

• tuistyles: type TuiBackgroundColor

TuiBackgroundColorKind:

• tuistyles: TuiBGTypeKind.TuiBackgroundColorKind

TuiBGColor:

• tuistyles: type TuiBGColor

TuiBGColorKind:

• tuistyles: TuiBGTypeKind.TuiBGColorKind

TuiBGNone:

• tuistyles: type TuiBGNone

TuiBGNoneKind:

• tuistyles: TuiBGTypeKind.TuiBGNoneKind

TuiBGType:

• tuistyles: object TuiBGType

TuiBGTypeKind:

• tuistyles: enum TuiBGTypeKind

TuiConsole:

• tuiconsole: type TuiConsole

TuiConsoleBufferLocal:

• tuiconsole: type TuiConsoleBufferLocal

TuiConsoleDimension:

• tuiconsole: type TuiConsoleDimension

TuiConsoleOptions:

• tuiconsole: type TuiConsoleOptions

TuiControl:

• tuicontrol: type TuiControl

TuiFGColor:

• tuistyles: type TuiFGColor

TuiFGColorKind:

• tuistyles: TuiFGTypeKind.TuiFGColorKind

TuiFGNone:

• tuistyles: type TuiFGNone

TuiFGNoneKind:

• tuistyles: TuiFGTypeKind.TuiFGNoneKind

TuiFGType:

• tuistyles: object TuiFGType

TuiFGTypeKind:

• tuistyles: enum TuiFGTypeKind

TuiForegroundColor:

• tuistyles: type TuiForegroundColor

TuiForegroundColorKind:

• tuistyles: TuiFGTypeKind.TuiForegroundColorKind

TuiHighlighter:

• tuivariables: type TuiHighlighter

TuiOptions:

• tuiconsole: type TuiOptions

TuiSegment:

• tuisegment: type TuiSegment

TuiStyles:

• tuistyles: type TuiStyles

updateLookup:

• tuivariables: proc updateLookup(self: TuiHighlighter; k: string; v: TuiStyles)
• tuivariables: proc updateLookup(self: TuiHighlighter; t: TableRef[string, TuiStyles])

warn:

• tuicrown: proc warn(args: varargs[string, `$`])