Wed Jan 27 20:02:50 2016

Asterisk developer's documentation


term.h File Reference

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

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, 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
#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)
#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
#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
#define COLOR_RED   31

Definition at line 49 of file term.h.

Referenced by opposite().

#define COLOR_WHITE   37
#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

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

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

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

Definition at line 184 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(), realtime_exec(), show_config_description(), and start_resource().

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

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

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

char* term_end ( void   ) 

Definition at line 365 of file term.c.

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

00366 {
00367    return enddata;
00368 }

void term_filter_escapes ( char *  line  ) 

Definition at line 338 of file term.c.

References ESC, and len().

Referenced by ast_log().

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

char* term_prep ( void   ) 

Definition at line 360 of file term.c.

00361 {
00362    return prepdata;
00363 }

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

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

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

char* term_quit ( void   ) 

Definition at line 370 of file term.c.

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

00371 {
00372    return quitdata;
00373 }

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

Definition at line 287 of file term.c.

References ESC.

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

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


Generated on 27 Jan 2016 for Asterisk - The Open Source Telephony Project by  doxygen 1.6.1