Sat Mar 10 01:55:49 2012

Asterisk developer's documentation


term.h File Reference

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

Go to the source code of this file.

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)

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

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, const 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 data_result_get_color(), 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(), and pbx_extension_helper().

#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(), and pbx_extension_helper().

#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(), handle_showmancmd(), 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(), data_result_print_cli(), data_result_print_cli_node(), 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 238 of file term.c.

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(), data_result_print_cli(), and data_result_print_cli_node().

00239 {
00240    int attr = 0;
00241 
00242    if (!check_colors_allowed(fgcolor)) {
00243       return -1;
00244    }
00245 
00246    check_fgcolor(&fgcolor, &attr);
00247    check_bgcolor(&bgcolor);
00248    
00249    if (ast_opt_force_black_background) {
00250       ast_str_append(str, 0, "%c[%d;%d;%dm", ESC, attr, fgcolor, COLOR_BLACK + 10);
00251    } else if (bgcolor) {
00252       ast_str_append(str, 0, "%c[%d;%d;%dm", ESC, attr, fgcolor, bgcolor + 10);
00253    } else {
00254       ast_str_append(str, 0, "%c[%d;%dm", ESC, attr, fgcolor);
00255    }
00256 
00257    return 0;
00258 }

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

Definition at line 180 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(), handle_showmancmd(), logger_print_normal(), lua_pbx_exec(), main(), pbx_extension_helper(), print_app_docs(), show_config_description(), and start_resource().

00181 {
00182    int attr = 0;
00183 
00184    if (!vt100compat) {
00185       ast_copy_string(outbuf, inbuf, maxout);
00186       return outbuf;
00187    }
00188    if (!fgcolor) {
00189       ast_copy_string(outbuf, inbuf, maxout);
00190       return outbuf;
00191    }
00192 
00193    if (fgcolor & 128) {
00194       attr = ast_opt_light_background ? 0 : ATTR_BRIGHT;
00195       fgcolor &= ~128;
00196    }
00197 
00198    if (bgcolor) {
00199       bgcolor &= ~128;
00200    }
00201 
00202    if (ast_opt_light_background) {
00203       fgcolor = opposite(fgcolor);
00204    }
00205 
00206    if (ast_opt_force_black_background) {
00207       snprintf(outbuf, maxout, "%c[%d;%d;%dm%s%c[%d;%dm", ESC, attr, fgcolor, bgcolor + 10, inbuf, ESC, COLOR_WHITE, COLOR_BLACK + 10);
00208    } else {
00209       snprintf(outbuf, maxout, "%c[%d;%dm%s%c[0m", ESC, attr, fgcolor, inbuf, ESC);
00210    }
00211    return outbuf;
00212 }

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 260 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().

00261 {
00262    int attr = 0;
00263 
00264    if (!check_colors_allowed(fgcolor)) {
00265       *outbuf = '\0';
00266       return outbuf;
00267    }
00268 
00269    check_fgcolor(&fgcolor, &attr);
00270    check_bgcolor(&bgcolor);
00271 
00272    if (ast_opt_force_black_background) {
00273       snprintf(outbuf, maxout, "%c[%d;%d;%dm", ESC, attr, fgcolor, COLOR_BLACK + 10);
00274    } else if (bgcolor) {
00275       snprintf(outbuf, maxout, "%c[%d;%d;%dm", ESC, attr, fgcolor, bgcolor + 10);
00276    } else {
00277       snprintf(outbuf, maxout, "%c[%d;%dm", ESC, attr, fgcolor);
00278    }
00279 
00280    return outbuf;
00281 }

char* term_end ( void   ) 

Definition at line 361 of file term.c.

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

00362 {
00363    return enddata;
00364 }

void term_filter_escapes ( char *  line  ) 

Definition at line 334 of file term.c.

References ESC, and len().

Referenced by ast_log().

00335 {
00336    int i;
00337    int len = strlen(line);
00338 
00339    for (i = 0; i < len; i++) {
00340       if (line[i] != ESC)
00341          continue;
00342       if ((i < (len - 2)) &&
00343           (line[i + 1] == 0x5B)) {
00344          switch (line[i + 2]) {
00345          case 0x30:
00346          case 0x31:
00347          case 0x33:
00348             continue;
00349          }
00350       }
00351       /* replace ESC with a space */
00352       line[i] = ' ';
00353    }
00354 }

char* term_prep ( void   ) 

Definition at line 356 of file term.c.

00357 {
00358    return prepdata;
00359 }

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

Definition at line 305 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.

00306 {
00307    if (!vt100compat) {
00308       ast_copy_string(outbuf, inbuf, maxout);
00309       return outbuf;
00310    }
00311    if (ast_opt_force_black_background) {
00312       snprintf(outbuf, maxout, "%c[%d;%dm%c%c[%d;%dm%s",
00313          ESC, COLOR_BLUE, COLOR_BLACK + 10,
00314          inbuf[0],
00315          ESC, COLOR_WHITE, COLOR_BLACK + 10,
00316          inbuf + 1);
00317    } else if (ast_opt_light_background) {
00318       snprintf(outbuf, maxout, "%c[%d;0m%c%c[%d;0m%s",
00319          ESC, COLOR_BLUE,
00320          inbuf[0],
00321          ESC, COLOR_BLACK,
00322          inbuf + 1);
00323    } else {
00324       snprintf(outbuf, maxout, "%c[%d;%d;0m%c%c[%d;%d;0m%s",
00325          ESC, ATTR_BRIGHT, COLOR_BLUE,
00326          inbuf[0],
00327          ESC, 0, COLOR_WHITE,
00328          inbuf + 1);
00329    }
00330    return outbuf;
00331 }

char* term_quit ( void   ) 

Definition at line 366 of file term.c.

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

00367 {
00368    return quitdata;
00369 }

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

Definition at line 283 of file term.c.

References ESC.

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

00284 {
00285    char *outbuf_ptr = outbuf;
00286    const char *inbuf_ptr = inbuf;
00287 
00288    while (outbuf_ptr < outbuf + maxout) {
00289       switch (*inbuf_ptr) {
00290          case ESC:
00291             while (*inbuf_ptr && (*inbuf_ptr != 'm'))
00292                inbuf_ptr++;
00293             break;
00294          default:
00295             *outbuf_ptr = *inbuf_ptr;
00296             outbuf_ptr++;
00297       }
00298       if (! *inbuf_ptr)
00299          break;
00300       inbuf_ptr++;
00301    }
00302    return outbuf;
00303 }


Generated on Sat Mar 10 01:55:49 2012 for Asterisk - The Open Source Telephony Project by  doxygen 1.4.7