Mon Jun 27 16:51:21 2011

Asterisk developer's documentation


term.c File Reference

Terminal Routines. More...

#include "asterisk.h"
#include "asterisk/_private.h"
#include <sys/time.h>
#include <signal.h>
#include <sys/stat.h>
#include <fcntl.h>
#include "asterisk/term.h"
#include "asterisk/lock.h"
#include "asterisk/utils.h"

Go to the source code of this file.

Functions

int ast_term_color_code (struct ast_str **str, int fgcolor, int bgcolor)
 Append a color sequence to an ast_str.
int ast_term_init (void)
static void check_bgcolor (int *bgcolor)
static int check_colors_allowed (int fgcolor)
static void check_fgcolor (int *fgcolor, int *attr)
static short convshort (char *s)
static int opposite (int color)
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)

Variables

static char enddata [80] = ""
static char prepdata [80] = ""
static char quitdata [80] = ""
static const char *const termpath []
static int vt100compat


Detailed Description

Terminal Routines.

Author:
Mark Spencer <markster@digium.com>

Definition in file term.c.


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

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

int ast_term_init ( void   ) 

Provided by term.c

Definition at line 83 of file term.c.

References ast_opt_console, ast_opt_force_black_background, ast_opt_light_background, ast_opt_no_color, ATTR_BRIGHT, ATTR_RESET, COLOR_BLACK, COLOR_BROWN, COLOR_WHITE, convshort(), and ESC.

Referenced by main().

00084 {
00085    char *term = getenv("TERM");
00086    char termfile[256] = "";
00087    char buffer[512] = "";
00088    int termfd = -1, parseokay = 0, i;
00089 
00090    if (ast_opt_no_color) {
00091       return 0;
00092    }
00093 
00094    if (!ast_opt_console) {
00095       /* If any remote console is not compatible, we'll strip the color codes at that point */
00096       vt100compat = 1;
00097       goto end;
00098    }
00099 
00100    if (!term) {
00101       return 0;
00102    }
00103 
00104    for (i = 0;; i++) {
00105       if (termpath[i] == NULL) {
00106          break;
00107       }
00108       snprintf(termfile, sizeof(termfile), "%s/%c/%s", termpath[i], *term, term);
00109       termfd = open(termfile, O_RDONLY);
00110       if (termfd > -1) {
00111          break;
00112       }
00113    }
00114    if (termfd > -1) {
00115       int actsize = read(termfd, buffer, sizeof(buffer) - 1);
00116       short sz_names = convshort(buffer + 2);
00117       short sz_bools = convshort(buffer + 4);
00118       short n_nums   = convshort(buffer + 6);
00119 
00120       /* if ((sz_names + sz_bools) & 1)
00121          sz_bools++; */
00122 
00123       if (sz_names + sz_bools + n_nums < actsize) {
00124          /* Offset 13 is defined in /usr/include/term.h, though we do not
00125           * include it here, as it conflicts with include/asterisk/term.h */
00126          short max_colors = convshort(buffer + 12 + sz_names + sz_bools + 13 * 2);
00127          if (max_colors > 0) {
00128             vt100compat = 1;
00129          }
00130          parseokay = 1;
00131       }
00132       close(termfd);
00133    }
00134 
00135    if (!parseokay) {
00136       /* These comparisons should not be substrings nor case-insensitive, as
00137        * terminal types are very particular about how they treat suffixes and
00138        * capitalization.  For example, terminal type 'linux-m' does NOT
00139        * support color, while 'linux' does.  Not even all vt100* terminals
00140        * support color, either (e.g. 'vt100+fnkeys'). */
00141       if (!strcmp(term, "linux")) {
00142          vt100compat = 1;
00143       } else if (!strcmp(term, "xterm")) {
00144          vt100compat = 1;
00145       } else if (!strcmp(term, "xterm-color")) {
00146          vt100compat = 1;
00147       } else if (!strncmp(term, "Eterm", 5)) {
00148          /* Both entries which start with Eterm support color */
00149          vt100compat = 1;
00150       } else if (!strcmp(term, "vt100")) {
00151          vt100compat = 1;
00152       } else if (!strncmp(term, "crt", 3)) {
00153          /* Both crt terminals support color */
00154          vt100compat = 1;
00155       }
00156    }
00157 
00158 end:
00159    if (vt100compat) {
00160       /* Make commands show up in nice colors */
00161       if (ast_opt_light_background) {
00162          snprintf(prepdata, sizeof(prepdata), "%c[%dm", ESC, COLOR_BROWN);
00163          snprintf(enddata, sizeof(enddata), "%c[%dm", ESC, COLOR_BLACK);
00164          snprintf(quitdata, sizeof(quitdata), "%c[0m", ESC);
00165       } else if (ast_opt_force_black_background) {
00166          snprintf(prepdata, sizeof(prepdata), "%c[%d;%d;%dm", ESC, ATTR_BRIGHT, COLOR_BROWN, COLOR_BLACK + 10);
00167          snprintf(enddata, sizeof(enddata), "%c[%d;%d;%dm", ESC, ATTR_RESET, COLOR_WHITE, COLOR_BLACK + 10);
00168          snprintf(quitdata, sizeof(quitdata), "%c[0m", ESC);
00169       } else {
00170          snprintf(prepdata, sizeof(prepdata), "%c[%d;%dm", ESC, ATTR_BRIGHT, COLOR_BROWN);
00171          snprintf(enddata, sizeof(enddata), "%c[%d;%dm", ESC, ATTR_RESET, COLOR_WHITE);
00172          snprintf(quitdata, sizeof(quitdata), "%c[0m", ESC);
00173       }
00174    }
00175    return 0;
00176 }

static void check_bgcolor ( int *  bgcolor  )  [static]

Definition at line 224 of file term.c.

Referenced by ast_term_color_code(), and term_color_code().

00225 {
00226    if (*bgcolor) {
00227       *bgcolor &= ~128;
00228    }
00229 }

static int check_colors_allowed ( int  fgcolor  )  [static]

Definition at line 231 of file term.c.

Referenced by ast_term_color_code(), and term_color_code().

00232 {
00233    return (!vt100compat || !fgcolor) ? 0 : 1;
00234 }

static void check_fgcolor ( int *  fgcolor,
int *  attr 
) [static]

Definition at line 212 of file term.c.

References ast_opt_light_background, ATTR_BRIGHT, and opposite().

Referenced by ast_term_color_code(), and term_color_code().

00213 {
00214    if (*fgcolor & 128) {
00215       *attr = ast_opt_light_background ? 0 : ATTR_BRIGHT;
00216       *fgcolor &= ~128;
00217    }
00218    
00219    if (ast_opt_light_background) {
00220       *fgcolor = opposite(*fgcolor);
00221    }
00222 }

static short convshort ( char *  s  )  [static]

Definition at line 68 of file term.c.

Referenced by ast_term_init().

00069 {
00070    register int a, b;
00071 
00072    a = (int) s[0] & 0377;
00073    b = (int) s[1] & 0377;
00074 
00075    if (a == 0377 && b == 0377)
00076       return -1;
00077    if (a == 0376 && b == 0377)
00078       return -2;
00079 
00080    return a + b * 256;
00081 }

static int opposite ( int  color  )  [static]

Definition at line 53 of file term.c.

References COLOR_BLACK, COLOR_BLUE, COLOR_BROWN, COLOR_CYAN, COLOR_GREEN, COLOR_MAGENTA, and COLOR_RED.

Referenced by check_fgcolor(), and term_color().

00054 {
00055    int lookup[] = {
00056       /* BLACK */ COLOR_BLACK,
00057       /* RED */ COLOR_MAGENTA,
00058       /* GREEN */ COLOR_GREEN,
00059       /* BROWN */ COLOR_BROWN,
00060       /* BLUE */ COLOR_CYAN,
00061       /* MAGENTA */ COLOR_RED,
00062       /* CYAN */ COLOR_BLUE,
00063       /* WHITE */ COLOR_BLACK };
00064    return color ? lookup[color - 30] : 0;
00065 }

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

Definition at line 178 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().

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

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

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

char* term_end ( void   ) 

Definition at line 359 of file term.c.

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

00360 {
00361    return enddata;
00362 }

void term_filter_escapes ( char *  line  ) 

Definition at line 332 of file term.c.

References ESC, and len().

Referenced by ast_log().

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

char* term_prep ( void   ) 

Definition at line 354 of file term.c.

00355 {
00356    return prepdata;
00357 }

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

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

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

char* term_quit ( void   ) 

Definition at line 364 of file term.c.

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

00365 {
00366    return quitdata;
00367 }

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

Definition at line 281 of file term.c.

References ESC.

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

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


Variable Documentation

char enddata[80] = "" [static]

Definition at line 43 of file term.c.

char prepdata[80] = "" [static]

Definition at line 42 of file term.c.

char quitdata[80] = "" [static]

Definition at line 44 of file term.c.

const char* const termpath[] [static]

Definition at line 46 of file term.c.

int vt100compat [static]

Definition at line 40 of file term.c.


Generated on Mon Jun 27 16:51:21 2011 for Asterisk - The Open Source Telephony Project by  doxygen 1.4.7