Fri Nov 12 12:10:23 2010

Asterisk developer's documentation

term.h File Reference

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

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

Go to the source code of this file.

Defines

#define AST_TERM_MAX_ESCAPE_CHARS   23
 Maximum number of characters needed for a color escape sequence, plus a null char.
#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

int ast_term_color_code (struct ast_str **str, int fgcolor, int bgcolor)
 Append a color sequence to an ast_str.
char * term_color (char *outbuf, const char *inbuf, int fgcolor, int bgcolor, int maxout)
char * term_color_code (char *outbuf, int fgcolor, int bgcolor, int maxout)
 Write a color sequence to a string.
char * term_end (void)
void term_filter_escapes (char *line)
char * term_prep (void)
char * term_prompt (char *outbuf, const char *inbuf, int maxout)
char * term_quit (void)
char * term_strip (char *outbuf, char *inbuf, int maxout)

Detailed Description

Handy terminal functions for vt* terms.

Definition in file term.h.

Define Documentation

#define AST_TERM_MAX_ESCAPE_CHARS   23

Maximum number of characters needed for a color escape sequence, plus a null char.

Definition at line 67 of file term.h.

Referenced by handle_cli_agi_show(), handle_show_function(), and print_app_docs().

#define ATTR_BLINK   5

Definition at line 39 of file term.h.

#define ATTR_BRIGHT   1

Definition at line 36 of file term.h.

Referenced by ast_term_init(), check_fgcolor(), term_color(), and term_prompt().

#define ATTR_DIM   2

Definition at line 37 of file term.h.

#define ATTR_HIDDEN   8

Definition at line 41 of file term.h.

#define ATTR_RESET   0

Definition at line 35 of file term.h.

Referenced by ast_term_init().

#define ATTR_REVER   7

Definition at line 40 of file term.h.

#define ATTR_UNDER   4

Definition at line 38 of file term.h.

#define COLOR_BLACK   30

Definition at line 47 of file term.h.

Referenced by __ast_register_translator(), ast_frame_dump(), ast_term_color_code(), ast_term_init(), ast_unregister_translator(), cli_prompt(), handle_dahdi_show_cadences(), main(), opposite(), start_resource(), term_color(), term_color_code(), and term_prompt().

#define COLOR_BLUE   34

Definition at line 55 of file term.h.

Referenced by opposite(), and term_prompt().

#define COLOR_BRBLUE   (34 | 128)

Definition at line 56 of file term.h.

#define COLOR_BRCYAN   (36 | 128)

Definition at line 60 of file term.h.

Referenced by __ast_custom_function_register(), ast_frame_dump(), ast_register_application2(), lua_pbx_exec(), pbx_extension_helper(), and realtime_exec().

#define COLOR_BRGREEN   (32 | 128)

Definition at line 52 of file term.h.

Referenced by ast_frame_dump().

#define COLOR_BRMAGENTA   (35 | 128)

Definition at line 58 of file term.h.

Referenced by ast_frame_dump(), lua_pbx_exec(), pbx_extension_helper(), and realtime_exec().

#define COLOR_BROWN   33

Definition at line 53 of file term.h.

Referenced by ast_term_init(), opposite(), and start_resource().

#define COLOR_BRRED   (31 | 128)

Definition at line 50 of file term.h.

Referenced by ast_frame_dump().

#define COLOR_BRWHITE   (37 | 128)

Definition at line 62 of file term.h.

Referenced by logger_print_normal(), main(), and show_config_description().

#define COLOR_CYAN   36

Definition at line 59 of file term.h.

Referenced by ast_xmldoc_printable(), handle_cli_agi_show(), handle_show_function(), opposite(), and print_app_docs().

#define COLOR_GRAY   (30 | 128)

Definition at line 48 of file term.h.

Referenced by fix_header().

#define COLOR_GREEN   32

Definition at line 51 of file term.h.

Referenced by handle_dahdi_show_cadences(), and opposite().

#define COLOR_MAGENTA   35

Definition at line 57 of file term.h.

Referenced by __ast_register_translator(), ast_unregister_translator(), handle_cli_agi_show(), handle_dahdi_show_cadences(), handle_show_function(), opposite(), and print_app_docs().

#define COLOR_RED   31

Definition at line 49 of file term.h.

Referenced by opposite().

#define COLOR_WHITE   37

Definition at line 61 of file term.h.

Referenced by ast_term_init(), cli_prompt(), term_color(), and term_prompt().

#define COLOR_YELLOW   (33 | 128)

Definition at line 54 of file term.h.

Referenced by ast_frame_dump(), and show_config_description().

#define ESC   0x1b

Definition at line 30 of file term.h.

Referenced by ast_term_color_code(), ast_term_init(), term_color(), term_color_code(), term_filter_escapes(), term_prompt(), term_strip(), xmldoc_string_wrap(), and xmldoc_wait_nextspace().

Function Documentation

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 226 of file term.c.

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

Referenced by ast_xmldoc_printable().

00227 {
00228    int attr = 0;
00229 
00230    if (!check_colors_allowed(fgcolor)) {
00231       return -1;
00232    }
00233 
00234    check_fgcolor(&fgcolor, &attr);
00235    check_bgcolor(&bgcolor);
00236    
00237    if (ast_opt_force_black_background) {
00238       ast_str_append(str, 0, "%c[%d;%d;%dm", ESC, attr, fgcolor, COLOR_BLACK + 10);
00239    } else if (bgcolor) {
00240       ast_str_append(str, 0, "%c[%d;%d;%dm", ESC, attr, fgcolor, bgcolor + 10);
00241    } else {
00242       ast_str_append(str, 0, "%c[%d;%dm", ESC, attr, fgcolor);
00243    }
00244 
00245    return 0;
00246 }

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

Definition at line 168 of file term.c.

References ast_copy_string(), ast_opt_force_black_background, ast_opt_light_background, ATTR_BRIGHT, COLOR_BLACK, COLOR_WHITE, ESC, and opposite().

Referenced by __ast_custom_function_register(), __ast_register_translator(), ast_frame_dump(), ast_register_application2(), ast_unregister_translator(), fix_header(), handle_cli_agi_show(), handle_dahdi_show_cadences(), handle_show_function(), logger_print_normal(), lua_pbx_exec(), main(), pbx_extension_helper(), print_app_docs(), realtime_exec(), show_config_description(), and start_resource().

00169 {
00170    int attr = 0;
00171 
00172    if (!vt100compat) {
00173       ast_copy_string(outbuf, inbuf, maxout);
00174       return outbuf;
00175    }
00176    if (!fgcolor) {
00177       ast_copy_string(outbuf, inbuf, maxout);
00178       return outbuf;
00179    }
00180 
00181    if (fgcolor & 128) {
00182       attr = ast_opt_light_background ? 0 : ATTR_BRIGHT;
00183       fgcolor &= ~128;
00184    }
00185 
00186    if (bgcolor) {
00187       bgcolor &= ~128;
00188    }
00189 
00190    if (ast_opt_light_background) {
00191       fgcolor = opposite(fgcolor);
00192    }
00193 
00194    if (ast_opt_force_black_background) {
00195       snprintf(outbuf, maxout, "%c[%d;%d;%dm%s%c[%d;%dm", ESC, attr, fgcolor, bgcolor + 10, inbuf, ESC, COLOR_WHITE, COLOR_BLACK + 10);
00196    } else {
00197       snprintf(outbuf, maxout, "%c[%d;%dm%s%c[0m", ESC, attr, fgcolor, inbuf, ESC);
00198    }
00199    return outbuf;
00200 }

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
Returns:
outbuf

Definition at line 248 of file term.c.

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

Referenced by cli_prompt().

00249 {
00250    int attr = 0;
00251 
00252    if (!check_colors_allowed(fgcolor)) {
00253       *outbuf = '\0';
00254       return outbuf;
00255    }
00256 
00257    check_fgcolor(&fgcolor, &attr);
00258    check_bgcolor(&bgcolor);
00259 
00260    if (ast_opt_force_black_background) {
00261       snprintf(outbuf, maxout, "%c[%d;%d;%dm", ESC, attr, fgcolor, COLOR_BLACK + 10);
00262    } else if (bgcolor) {
00263       snprintf(outbuf, maxout, "%c[%d;%d;%dm", ESC, attr, fgcolor, bgcolor + 10);
00264    } else {
00265       snprintf(outbuf, maxout, "%c[%d;%dm", ESC, attr, fgcolor);
00266    }
00267 
00268    return outbuf;
00269 }

char* term_end ( void   ) 

Definition at line 348 of file term.c.

Referenced by ast_xmldoc_printable(), consolehandler(), and main().

00349 {
00350    return enddata;
00351 }

void term_filter_escapes ( char *  line  ) 

Definition at line 321 of file term.c.

References ESC, and len().

Referenced by ast_log().

00322 {
00323    int i;
00324    int len = strlen(line);
00325 
00326    for (i = 0; i < len; i++) {
00327       if (line[i] != ESC)
00328          continue;
00329       if ((i < (len - 2)) &&
00330           (line[i + 1] == 0x5B)) {
00331          switch (line[i + 2]) {
00332          case 0x30:
00333          case 0x31:
00334          case 0x33:
00335             continue;
00336          }
00337       }
00338       /* replace ESC with a space */
00339       line[i] = ' ';
00340    }
00341 }

char* term_prep ( void   ) 

Definition at line 343 of file term.c.

00344 {
00345    return prepdata;
00346 }

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

Definition at line 292 of file term.c.

References ast_copy_string(), ast_opt_force_black_background, ast_opt_light_background, ATTR_BRIGHT, COLOR_BLACK, COLOR_BLUE, COLOR_WHITE, and ESC.

00293 {
00294    if (!vt100compat) {
00295       ast_copy_string(outbuf, inbuf, maxout);
00296       return outbuf;
00297    }
00298    if (ast_opt_force_black_background) {
00299       snprintf(outbuf, maxout, "%c[%d;%dm%c%c[%d;%dm%s",
00300          ESC, COLOR_BLUE, COLOR_BLACK + 10,
00301          inbuf[0],
00302          ESC, COLOR_WHITE, COLOR_BLACK + 10,
00303          inbuf + 1);
00304    } else if (ast_opt_light_background) {
00305       snprintf(outbuf, maxout, "%c[%d;0m%c%c[%d;0m%s",
00306          ESC, COLOR_BLUE,
00307          inbuf[0],
00308          ESC, COLOR_BLACK,
00309          inbuf + 1);
00310    } else {
00311       snprintf(outbuf, maxout, "%c[%d;%d;0m%c%c[%d;%d;0m%s",
00312          ESC, ATTR_BRIGHT, COLOR_BLUE,
00313          inbuf[0],
00314          ESC, 0, COLOR_WHITE,
00315          inbuf + 1);
00316    }
00317    return outbuf;
00318 }

char* term_quit ( void   ) 

Definition at line 353 of file term.c.

Referenced by ast_el_read_char(), main(), and quit_handler().

00354 {
00355    return quitdata;
00356 }

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

Definition at line 271 of file term.c.

References ESC.

Referenced by __verboser(), action_command(), ast_log_vsyslog(), and logger_print_normal().

00272 {
00273    char *outbuf_ptr = outbuf, *inbuf_ptr = inbuf;
00274 
00275    while (outbuf_ptr < outbuf + maxout) {
00276       switch (*inbuf_ptr) {
00277          case ESC:
00278             while (*inbuf_ptr && (*inbuf_ptr != 'm'))
00279                inbuf_ptr++;
00280             break;
00281          default:
00282             *outbuf_ptr = *inbuf_ptr;
00283             outbuf_ptr++;
00284       }
00285       if (! *inbuf_ptr)
00286          break;
00287       inbuf_ptr++;
00288    }
00289    return outbuf;
00290 }

Generated by  doxygen 1.6.2