Handy terminal functions for vt* terms. More...

This graph shows which files directly or indirectly include this file:

Macros
#define	AST_TERM_MAX_ESCAPE_CHARS 23
	Maximum number of characters needed for a color escape sequence, and another one for a trailing reset, plus a null char.

#define	AST_TERM_MAX_ROTATING_BUFFERS 15

#define	COLORIZE(fg, bg, str) ast_term_color(fg,bg),str,ast_term_reset()

#define	COLORIZE_FMT "%s%s%s"
	Shortcut macros for coloring a set of text.

#define	ESC 0x1b

Terminal Attributes
#define	ATTR_BLINK 5

#define	ATTR_BRIGHT 1

#define	ATTR_DIM 2

#define	ATTR_HIDDEN 8

#define	ATTR_RESET 0

#define	ATTR_REVER 7

#define	ATTR_UNDER 4

Terminal Colors
#define	COLOR_BLACK 30

#define	COLOR_BLUE 34

#define	COLOR_BRBLUE (34 \| 128)

#define	COLOR_BRCYAN (36 \| 128)

#define	COLOR_BRGREEN (32 \| 128)

#define	COLOR_BRMAGENTA (35 \| 128)

#define	COLOR_BROWN 33

#define	COLOR_BRRED (31 \| 128)

#define	COLOR_BRWHITE (37 \| 128)

#define	COLOR_CYAN 36

#define	COLOR_GRAY (30 \| 128)

#define	COLOR_GREEN 32

#define	COLOR_MAGENTA 35

#define	COLOR_RED 31

#define	COLOR_WHITE 37

#define	COLOR_YELLOW (33 \| 128)

Functions
const char *	ast_term_color (int fgcolor, int bgcolor)
	Return a color sequence string.

int	ast_term_color_code (struct ast_str **str, int fgcolor, int bgcolor)
	Append a color sequence to an ast_str.

const char *	ast_term_reset (void)
	Returns the terminal reset code.

char *	term_color (char outbuf, const char inbuf, int fgcolor, int bgcolor, int maxout)
	Colorize a specified string by adding terminal color codes.

char *	term_color_code (char *outbuf, int fgcolor, int bgcolor, int maxout)
	Write a color sequence to a string.

const char *	term_end (void)

void	term_filter_escapes (char *line)

const char *	term_quit (void)

char *	term_strip (char outbuf, const char inbuf, int maxout)
	Remove colorings from a specified string.

Detailed Description

Handy terminal functions for vt* terms.

Definition in file term.h.

Macro Definition Documentation

◆ AST_TERM_MAX_ESCAPE_CHARS

#define AST_TERM_MAX_ESCAPE_CHARS 23

Maximum number of characters needed for a color escape sequence, and another one for a trailing reset, plus a null char.

Definition at line 75 of file term.h.

◆ AST_TERM_MAX_ROTATING_BUFFERS

#define AST_TERM_MAX_ROTATING_BUFFERS 15

Definition at line 76 of file term.h.

◆ ATTR_BLINK

#define ATTR_BLINK 5

Definition at line 40 of file term.h.

◆ ATTR_BRIGHT

#define ATTR_BRIGHT 1

Definition at line 37 of file term.h.

◆ ATTR_DIM

#define ATTR_DIM 2

Definition at line 38 of file term.h.

◆ ATTR_HIDDEN

#define ATTR_HIDDEN 8

Definition at line 42 of file term.h.

◆ ATTR_RESET

#define ATTR_RESET 0

Definition at line 36 of file term.h.

◆ ATTR_REVER

#define ATTR_REVER 7

Definition at line 41 of file term.h.

◆ ATTR_UNDER

#define ATTR_UNDER 4

Definition at line 39 of file term.h.

◆ COLOR_BLACK

#define COLOR_BLACK 30

Definition at line 50 of file term.h.

◆ COLOR_BLUE

#define COLOR_BLUE 34

Definition at line 58 of file term.h.

◆ COLOR_BRBLUE

#define COLOR_BRBLUE (34 | 128)

Definition at line 59 of file term.h.

◆ COLOR_BRCYAN

#define COLOR_BRCYAN (36 | 128)

Definition at line 63 of file term.h.

◆ COLOR_BRGREEN

#define COLOR_BRGREEN (32 | 128)

Definition at line 55 of file term.h.

◆ COLOR_BRMAGENTA

#define COLOR_BRMAGENTA (35 | 128)

Definition at line 61 of file term.h.

◆ COLOR_BROWN

#define COLOR_BROWN 33

Definition at line 56 of file term.h.

◆ COLOR_BRRED

#define COLOR_BRRED (31 | 128)

Definition at line 53 of file term.h.

◆ COLOR_BRWHITE

#define COLOR_BRWHITE (37 | 128)

Definition at line 65 of file term.h.

◆ COLOR_CYAN

#define COLOR_CYAN 36

Definition at line 62 of file term.h.

◆ COLOR_GRAY

#define COLOR_GRAY (30 | 128)

Definition at line 51 of file term.h.

◆ COLOR_GREEN

#define COLOR_GREEN 32

Definition at line 54 of file term.h.

◆ COLOR_MAGENTA

#define COLOR_MAGENTA 35

Definition at line 60 of file term.h.

◆ COLOR_RED

#define COLOR_RED 31

Definition at line 52 of file term.h.

◆ COLOR_WHITE

#define COLOR_WHITE 37

Definition at line 64 of file term.h.

◆ COLOR_YELLOW

#define COLOR_YELLOW (33 | 128)

Definition at line 57 of file term.h.

◆ COLORIZE

#define COLORIZE	(	fg,
		bg,
		str
	)	ast_term_color(fg,bg),str,ast_term_reset()

Definition at line 72 of file term.h.

◆ COLORIZE_FMT

#define COLORIZE_FMT "%s%s%s"

Shortcut macros for coloring a set of text.

Definition at line 71 of file term.h.

◆ ESC

#define ESC 0x1b

Definition at line 30 of file term.h.

Function Documentation

◆ ast_term_color()

const char * ast_term_color	(	int	fgcolor,
		int	bgcolor
	)

Return a color sequence string.

Parameters

fgcolor	foreground color
bgcolor	background color

Note: This function may be called up to 15 times within the arguments to a single function without the danger of overwriting a common buffer.

Returns: A color sequence string, or the empty string, on error

Definition at line 341 of file term.c.

{
    struct commonbuf *cb = ast_threadstorage_get(&commonbuf, sizeof(*cb));
    char *buf;
 
    if (!cb) {
        return "";
    }
    buf = cb->buffer[cb->which++];
    if (cb->which == AST_TERM_MAX_ROTATING_BUFFERS) {
        cb->which = 0;
    }
 
    return term_color_code(buf, fgcolor, bgcolor, AST_TERM_MAX_ESCAPE_CHARS);
}

References AST_TERM_MAX_ESCAPE_CHARS, AST_TERM_MAX_ROTATING_BUFFERS, ast_threadstorage_get(), buf, commonbuf::buffer, term_color_code(), and commonbuf::which.

Referenced by cli_show_module_options(), cli_show_module_type(), handle_cli_agi_show(), handle_show_function(), handle_showmancmd(), print_app_docs(), print_event_instance(), print_queue(), and set_header().

◆ ast_term_color_code()

int ast_term_color_code	(	struct ast_str **	str,
		int	fgcolor,
		int	bgcolor
	)

Append a color sequence to an ast_str.

Parameters

str	The string to append to
fgcolor	foreground color
bgcolor	background color

Return values

0	success
-1	failure

Definition at line 296 of file term.c.

{
    int attr = 0;
 
    if (!check_colors_allowed()) {
        return -1;
    }
 
    check_fgcolor(&fgcolor, &attr);
    check_bgcolor(&bgcolor);
 
    if (ast_opt_force_black_background) {
        ast_str_append(str, 0, "%c[%d;%d;%dm", ESC, attr, fgcolor, COLOR_BLACK + 10);
    } else if (bgcolor) {
        ast_str_append(str, 0, "%c[%d;%d;%dm", ESC, attr, fgcolor, bgcolor + 10);
    } else {
        ast_str_append(str, 0, "%c[%d;%dm", ESC, attr, fgcolor);
    }
 
    return 0;
}

References ast_opt_force_black_background, ast_str_append(), check_bgcolor(), check_colors_allowed(), check_fgcolor(), COLOR_BLACK, ESC, and str.

Referenced by ast_xmldoc_printable(), and cli_prompt().

◆ ast_term_reset()

const char * ast_term_reset ( void )

Returns the terminal reset code.

Returns: String which, when sent to the screen, resets the terminal colors

Definition at line 357 of file term.c.

{
    return term_end();
}

References term_end().

Referenced by ast_xmldoc_printable(), cli_show_module_options(), cli_show_module_type(), handle_cli_agi_show(), handle_show_function(), handle_showmancmd(), print_app_docs(), print_event_instance(), print_queue(), and set_header().

◆ term_color()

char * term_color	(	char *	outbuf,
		const char *	inbuf,
		int	fgcolor,
		int	bgcolor,
		int	maxout
	)

Colorize a specified string by adding terminal color codes.

Parameters

outbuf	Result buffer
inbuf	Starting string
fgcolor	Foreground color, specified as one of the constants in include/asterisk/term.h. Use '0' if the want the normal terminal foreground color.
bgcolor	Background color, specified as one of the constants in include/asterisk/term.h. Use '0' if you want the normal terminal background color.
maxout	Maximum size of outbuf

Returns: outbuf

Deprecated:: Due to the necessity of pre-sizing a result buffer, new code should avoid using this function in preference to ast_term_color_code() or ast_term_color().

Definition at line 235 of file term.c.

{
    int attr = 0;
 
    if (!vt100compat) {
        ast_copy_string(outbuf, inbuf, maxout);
        return outbuf;
    }
    if (!fgcolor) {
        ast_copy_string(outbuf, inbuf, maxout);
        return outbuf;
    }
 
    if (fgcolor & 128) {
        attr = ast_opt_light_background ? 0 : ATTR_BRIGHT;
        fgcolor &= ~128;
    }
 
    if (bgcolor) {
        bgcolor &= ~128;
    }
 
    if (ast_opt_light_background) {
        fgcolor = opposite(fgcolor);
    }
 
    if (ast_opt_force_black_background) {
        if (!bgcolor) {
            bgcolor = COLOR_BLACK;
        }
        snprintf(outbuf, maxout, "%c[%d;%d;%dm%s%s", ESC, attr, fgcolor, bgcolor + 10, inbuf, term_end());
    } else {
        snprintf(outbuf, maxout, "%c[%d;%dm%s%s", ESC, attr, fgcolor, inbuf, term_end());
    }
    return outbuf;
}

References ast_copy_string(), ast_opt_force_black_background, ast_opt_light_background, ATTR_BRIGHT, COLOR_BLACK, ESC, inbuf(), opposite(), term_end(), and vt100compat.

Referenced by __ast_register_translator(), ast_frame_dump(), ast_unregister_translator(), handle_dahdi_show_cadences(), lua_pbx_exec(), realtime_exec(), and start_resource().

◆ term_color_code()

char * term_color_code	(	char *	outbuf,
		int	fgcolor,
		int	bgcolor,
		int	maxout
	)

Write a color sequence to a string.

Parameters

outbuf	the location to write to
fgcolor	foreground color
bgcolor	background color
maxout	maximum number of characters to write

Deprecated:: You should use ast_term_color_code or ast_term_color, instead.

Returns: outbuf

Definition at line 318 of file term.c.

{
    int attr = 0;
 
    if (!check_colors_allowed()) {
        *outbuf = '\0';
        return outbuf;
    }
 
    check_fgcolor(&fgcolor, &attr);
    check_bgcolor(&bgcolor);
 
    if (ast_opt_force_black_background) {
        snprintf(outbuf, maxout, "%c[%d;%d;%dm", ESC, attr, fgcolor, COLOR_BLACK + 10);
    } else if (bgcolor) {
        snprintf(outbuf, maxout, "%c[%d;%d;%dm", ESC, attr, fgcolor, bgcolor + 10);
    } else {
        snprintf(outbuf, maxout, "%c[%d;%dm", ESC, attr, fgcolor);
    }
 
    return outbuf;
}

References ast_opt_force_black_background, check_bgcolor(), check_colors_allowed(), check_fgcolor(), COLOR_BLACK, and ESC.

Referenced by ast_term_color().

◆ term_end()

const char * term_end ( void )

Definition at line 407 of file term.c.

{
    return enddata;
}

References enddata.

Referenced by ast_remotecontrol(), ast_term_reset(), asterisk_daemon(), consolehandler(), main(), and term_color().

◆ term_filter_escapes()

void term_filter_escapes ( char * line )

Definition at line 385 of file term.c.

{
    int i;
    int len = strlen(line);
 
    for (i = 0; i < len; i++) {
        if (line[i] != ESC)
            continue;
        if ((i < (len - 2)) &&
            (line[i + 1] == 0x5B)) {
            switch (line[i + 2]) {
            case 0x30:
            case 0x31:
            case 0x33:
                continue;
            }
        }
        /* replace ESC with a space */
        line[i] = ' ';
    }
}

References ESC, and len().

◆ term_quit()

const char * term_quit ( void )

Definition at line 412 of file term.c.

{
    return quitdata;
}

References quitdata.

Referenced by ast_el_read_char(), check_init(), main(), and really_quit().

◆ term_strip()

char * term_strip	(	char *	outbuf,
		const char *	inbuf,
		int	maxout
	)

Remove colorings from a specified string.

Parameters

outbuf	the location to write to
inbuf	the original string
maxout	the available size of outbuf

Returns: outbuf

Definition at line 362 of file term.c.

{
    char *outbuf_ptr = outbuf;
    const char *inbuf_ptr = inbuf;
 
    while (outbuf_ptr < outbuf + maxout) {
        switch (*inbuf_ptr) {
            case ESC:
                while (*inbuf_ptr && (*inbuf_ptr != 'm'))
                    inbuf_ptr++;
                break;
            default:
                *outbuf_ptr = *inbuf_ptr;
                outbuf_ptr++;
        }
        if (! *inbuf_ptr)
            break;
        inbuf_ptr++;
    }
    return outbuf;
}

References ESC, and inbuf().

Referenced by action_command(), format_log_default(), format_log_json(), and format_log_plain().

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ AST_TERM_MAX_ESCAPE_CHARS

◆ AST_TERM_MAX_ROTATING_BUFFERS

◆ ATTR_BLINK

◆ ATTR_BRIGHT

◆ ATTR_DIM

◆ ATTR_HIDDEN

◆ ATTR_RESET

◆ ATTR_REVER

◆ ATTR_UNDER

◆ COLOR_BLACK

◆ COLOR_BLUE

◆ COLOR_BRBLUE

◆ COLOR_BRCYAN

◆ COLOR_BRGREEN

◆ COLOR_BRMAGENTA

◆ COLOR_BROWN

◆ COLOR_BRRED

◆ COLOR_BRWHITE

◆ COLOR_CYAN

◆ COLOR_GRAY

◆ COLOR_GREEN

◆ COLOR_MAGENTA

◆ COLOR_RED

◆ COLOR_WHITE

◆ COLOR_YELLOW

◆ COLORIZE

◆ COLORIZE_FMT

◆ ESC

Function Documentation

◆ ast_term_color()

◆ ast_term_color_code()

◆ ast_term_reset()

◆ term_color()

◆ term_color_code()

◆ term_end()

◆ term_filter_escapes()

◆ term_quit()

◆ term_strip()