CBuild wiki

Term.h

This file provides utilities to construct ANSII escape codes.

License: GPL-3.0-or-later.

This only provides strings for escape codes and some macro to build that strings

ANSII escape starter.

CBUILD_TERM_CSI

#define CBUILD_TERM_CSI

CSI - Control Sequence Introducer.

CBUILD_TERM_SGR

#define CBUILD_TERM_SGR(n)

SGR - Select Graphic Rendition, meta-function to generate proper code.

CBUILD_TERM_CURSOR_SET

#define CBUILD_TERM_CURSOR_SET(x, y)

Set cursor to specific coordinates.

CBUILD_TERM_CURSOR_SETH

#define CBUILD_TERM_CURSOR_SETH(x)

Set cursor to specific column in current line

CBUILD_TERM_CURSOR_MOVE

#define CBUILD_TERM_CURSOR_MOVE(direction, num_steps)

Move cursor in specific direction for specified number of steps.

  • direction direction One of CBUILD_TERM_[UP|DOWN|RIGHT|LEFT].
  • unsigned int num_steps Number of steps, should be either literal or define.

CBUILD_TERM_UP

#define CBUILD_TERM_UP

CBUILD_TERM_DOWN

#define CBUILD_TERM_DOWN

CBUILD_TERM_RIGHT

#define CBUILD_TERM_RIGHT

CBUILD_TERM_LEFT

#define CBUILD_TERM_LEFT

CBUILD_TERM_NEXT_LINE

#define CBUILD_TERM_NEXT_LINE

CBUILD_TERM_PREV_LINE

#define CBUILD_TERM_PREV_LINE

CBUILD_TERM_CURSOR_GET

#define CBUILD_TERM_CURSOR_GET

Get current position of a cursor.

CBUILD_TERM_ERASE_SCR

#define CBUILD_TERM_ERASE_SCR(mode)

Clean specific part of terminal

  • clear mode mode One of CBUILD_TERM_[CURSOR_TO_END|CURSOR_TO_BEGIN|FULL|FULL_SCROLLBACK].

CBUILD_TERM_ERASE_LINE

#define CBUILD_TERM_ERASE_LINE(mode)

Clean specific part of terminal

  • clear mode mode One of CBUILD_TERM_[CURSOR_TO_END|CURSOR_TO_BEGIN|FULL].

CBUILD_TERM_CURSOR_TO_END

#define CBUILD_TERM_CURSOR_TO_END

CBUILD_TERM_CURSOR_TO_BEGIN

#define CBUILD_TERM_CURSOR_TO_BEGIN

CBUILD_TERM_FULL

#define CBUILD_TERM_FULL

CBUILD_TERM_FULL_SCROLLBACK

#define CBUILD_TERM_FULL_SCROLLBACK

CBUILD_TERM_RESET

#define CBUILD_TERM_RESET

Reset all styling

CBUILD_TERM_BOLD

#define CBUILD_TERM_BOLD

CBUILD_TERM_FAINT

#define CBUILD_TERM_FAINT

CBUILD_TERM_ITALIC

#define CBUILD_TERM_ITALIC

CBUILD_TERM_NITALIC

#define CBUILD_TERM_NITALIC

Disable italic

CBUILD_TERM_UNDERLINE

#define CBUILD_TERM_UNDERLINE

CBUILD_TERM_NUNDERLINE

#define CBUILD_TERM_NUNDERLINE

Disable underline

CBUILD_TERM_REVERSE

#define CBUILD_TERM_REVERSE

Enable swapping of background and foreground color

CBUILD_TERM_NREVERSE

#define CBUILD_TERM_NREVERSE

Disable reverse mode

CBUILD_TERM_CROSS_OUT

#define CBUILD_TERM_CROSS_OUT

Enable crossed-out text rendering

CBUILD_TERM_NCROSS_OUT

#define CBUILD_TERM_NCROSS_OUT

Disable crossed-out rendering

CBUILD_TERM_DOUBLE_UNDERLINE

#define CBUILD_TERM_DOUBLE_UNDERLINE

CBUILD_TERM_OVERLINE

#define CBUILD_TERM_OVERLINE

CBUILD_TERM_NOVERLINE

#define CBUILD_TERM_NOVERLINE

Disable overline

CBUILD_TERM_FG

#define CBUILD_TERM_FG(color)

Set foreground color based on 16 color palette.

  • Color color One of CBUILD_TERM_ defines.

CBUILD_TERM_BG

#define CBUILD_TERM_BG(color)

Set background color based on 16 color palette.

  • Color color One of CBUILD_TERM_ defines.

CBUILD_TERM_FG8

#define CBUILD_TERM_FG8(color)

Set foreground color in terms of 8-bit palette

CBUILD_TERM_BG8

#define CBUILD_TERM_BG8(color)

Set background color in terms of 8-bit palette

CBUILD_TERM_UNDERLINE8

#define CBUILD_TERM_UNDERLINE8(color)

Set underline color in terms of 8-bit palette

CBUILD_TERM_FG24

#define CBUILD_TERM_FG24(r, g, b)

Set foreground color to to some RGB888 color

CBUILD_TERM_BG24

#define CBUILD_TERM_BG24(r, g, b)

Set background color to to some RGB888 color

CBUILD_TERM_UNDERLINE24

#define CBUILD_TERM_UNDERLINE24(r, g, b)

Set underline color to to some RGB888 color

Colors

CBUILD_TERM_RED

#define CBUILD_TERM_RED

CBUILD_TERM_GREEN

#define CBUILD_TERM_GREEN

CBUILD_TERM_YELLOW

#define CBUILD_TERM_YELLOW

CBUILD_TERM_BLUE

#define CBUILD_TERM_BLUE

CBUILD_TERM_MAGENTA

#define CBUILD_TERM_MAGENTA

CBUILD_TERM_CYAN

#define CBUILD_TERM_CYAN

CBUILD_TERM_WHITE

#define CBUILD_TERM_WHITE

CBUILD_TERM_BRBLACK

#define CBUILD_TERM_BRBLACK

CBUILD_TERM_BRRED

#define CBUILD_TERM_BRRED

CBUILD_TERM_BRGREEN

#define CBUILD_TERM_BRGREEN

CBUILD_TERM_BRYELLOW

#define CBUILD_TERM_BRYELLOW

CBUILD_TERM_BRBLUE

#define CBUILD_TERM_BRBLUE

CBUILD_TERM_BRMAGENTA

#define CBUILD_TERM_BRMAGENTA

CBUILD_TERM_BRCYAN

#define CBUILD_TERM_BRCYAN

CBUILD_TERM_BRWHITE

#define CBUILD_TERM_BRWHITE