Chapter 20. Utility functions for using ansi control chars in logs
Utility functions for logging using ansi control characters. This lets you manipulate the cursor position and character color output and attributes of log messages.
Name
function::ansi_clear_screen — Move cursor to top left and clear screen.
Synopsis
function ansi_clear_screen()
General Syntax
ansi_clear_screen
Description
Sends ansi code for moving cursor to top left and then the ansi code for clearing the screen from the cursor position to the end.
Name
function::ansi_set_color — Set the ansi Select Graphic Rendition mode.
Synopsis
function ansi_set_color(fg:long)
Arguments
fg
Foreground color to set.
General Syntax
ansi_set_color(fh:long)
Description
Sends ansi code for Select Graphic Rendition mode for the given forground color. Black (30), Blue (34), Green (32), Cyan (36), Red (31), Purple (35), Brown (33), Light Gray (37).
Name
function::ansi_set_color2 — Set the ansi Select Graphic Rendition mode.
Synopsis
function ansi_set_color2(fg:long,bg:long)
Arguments
fg
Foreground color to set.
bg
Background color to set.
General Syntax
ansi_set_color2(fg:long, bg:long)
Description
Sends ansi code for Select Graphic Rendition mode for the given forground color, Black (30), Blue (34), Green (32), Cyan (36), Red (31), Purple (35), Brown (33), Light Gray (37) and the given background color, Black (40), Red (41), Green (42), Yellow (43), Blue (44), Magenta (45), Cyan (46), White (47).
Name
function::ansi_set_color3 — Set the ansi Select Graphic Rendition mode.
Synopsis
function ansi_set_color3(fg:long,bg:long,attr:long)
Arguments
fg
Foreground color to set.
bg
Background color to set.
attr
Color attribute to set.
General Syntax
ansi_set_color3(fg:long, bg:long, attr:long)
Description
Sends ansi code for Select Graphic Rendition mode for the given forground color, Black (30), Blue (34), Green (32), Cyan (36), Red (31), Purple (35), Brown (33), Light Gray (37), the given background color, Black (40), Red (41), Green (42), Yellow (43), Blue (44), Magenta (45), Cyan (46), White (47) and the color attribute All attributes off (0), Intensity Bold (1), Underline Single (4), Blink Slow (5), Blink Rapid (6), Image Negative (7).
Name
function::ansi_reset_color — Resets Select Graphic Rendition mode.
Synopsis
function ansi_reset_color()
General Syntax
ansi_reset_color
Description
Sends ansi code to reset foreground, background and color attribute to default values.
Name
function::ansi_new_line — Move cursor to new line.
Synopsis
function ansi_new_line()
General Syntax
ansi_new_line
Description
Sends ansi code new line.
Name
function::ansi_cursor_move — Move cursor to new coordinates.
Synopsis
function ansi_cursor_move(x:long,y:long)
Arguments
x
Row to move the cursor to.
y
Colomn to move the cursor to.
General Syntax
ansi_curos_move(x:long, y:long)
Description
Sends ansi code for positioning the cursor at row x and column y. Coordinates start at one, (1,1) is the top-left corner.
Name
function::ansi_cursor_hide — Hides the cursor.
Synopsis
function ansi_cursor_hide()
General Syntax
ansi_cusor_hide
Description
Sends ansi code for hiding the cursor.
Name
function::ansi_cursor_save — Saves the cursor position.
Synopsis
function ansi_cursor_save()
General Syntax
ansi_cursor_save
Description
Sends ansi code for saving the current cursor position.
Name
function::ansi_cursor_restore — Restores a previously saved cursor position.
Synopsis
function ansi_cursor_restore()
General Syntax
ansi_cursor_restore
Description
Sends ansi code for restoring the current cursor position previously saved with ansi_cursor_save.
Name
function::ansi_cursor_show — Shows the cursor.
Synopsis
function ansi_cursor_show()
General Syntax
ansi_cursor_show
Description
Sends ansi code for showing the cursor.
