Moves the cursor to an absolute column position. Note that ANSI standards state that column is 1 based, so curHorizonal(1) returns the cursor to the start of the line. Passing in 0 or null does nothing.

ansi-sequence: ESC[${col}G

curLeft

Source

This curLeft(Int? cols := 1)

Moves the cursor left a number of rows. Passing in 0 or null does nothing.

ansi-sequence: ESC[${cols}D

curRestore

Source

This curRestore()

Restores the cursor position - both horizontal and vertical. Does nothing if a cursor position has not yet been saved.

ansi-sequence: ESC[u

curRight

Source

This curRight(Int? cols := 1)

Moves the cursor right a number of rows. Passing in 0 or null does nothing.

ansi-sequence: ESC[${cols}C

curSave

Source

This curSave()

Saves the cursor position - both horizontal and vertical.

ansi-sequence: ESC[s

curUp

Source

This curUp(Int? rows := 1)

Moves the cursor up a number of rows. Passing in 0 or null does nothing.

ansi-sequence: ESC[${rows}A

fg

Source

This fg(Color? col)

Sets the foreground colour to the given Color. Any alpha value is ignored. If null is passed, this method does nothing.

ansi-sequence: ESC[38;2;${r};${g};${b}m

fgIdx

Source

This fgIdx(Int? i)

Sets the foreground colour to the given palette colour. (0..255) If null is passed, this method does nothing.

ansi-sequence: ESC[38;5;${i}m

fgReset

Source

This fgReset()

Resets the foreground colour to default.

ansi-sequence: ESC[39m

fgRgb

Source

This fgRgb(Int? rgb)

Sets the foreground colour to the given RGB integer. If null is passed, this method does nothing.

bits 16-23 red
bits 8-15 green
bits 0-7 blue

For example orange would be 0xFF_A5_00.

ansi-sequence: ESC[38;2;${r};${g};${b}m

italic

Source

This italic(Bool onOff := true)

Turns italics on or off.

ansi-sequence: ESC[3m or ESC[23m

make

Source

new make(Str? str := null)

Creates an AnsiBuf instance , optionally with the given string / ANSI sequence.

newLine

Source

This newLine()

Convenience for printChar(\n).

print

Source

This print(Obj? x := "")

Adds x.toStr to the end of this buffer. If x is null then the string "null" is added.

printChar

Source

This printChar(Int ch)

Optimised implementation for print(ch.toChar).

printFandoc

Source

This printFandoc(Str fandoc, Int? maxWidth := null)

Prints the given fandoc string to the buffer, converting bold and italic formatting to their ANSI representation.

If maxWidth is given then all text is wrapped at that width.

Pass the terminal column width as maxWidth to ensure all text is visible on screen.

printLine

Source

This printLine(Obj? x := "")

Adds x.toStr + "\n" to the end of this buffer. If x is null then the string "null" is added.

removeEscapeCodes

Source

static Str removeEscapeCodes(Str str)

Removes all escape codes and non-printable characters from the given string.

reset

Source

This reset()

Resets text to:

default foreground colour
default background colour
non-bold
non-italics
no underline

ansi-sequence: ESC[m

size

Source

Int size()

Returns the number of chars in the buf.

toAnsi

Source

Str toAnsi()

Returns the contents of this ANSI buffer as a string.

toPlain

Source

Str toPlain()

Returns a copy of this ANSI string with all the escape codes and non-printable characters removed.

toStr

Source

virtual override Str toStr()

Returns toAnsi().

underline

Source

This underline(Bool onOff := true)

Turns underline on or off.

ansi-sequence: ESC[4m or ESC[24m

write

Source

This write(Obj? x)

Convenience for print().

writeChar

Source

This writeChar(Int ch)

Convenience for printChar().