Thu Apr 28 2011 16:57:19

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_RESET   0
#define ATTR_BRIGHT   1
#define ATTR_DIM   2
#define ATTR_UNDER   4
#define ATTR_BLINK   5
#define ATTR_REVER   7
#define ATTR_HIDDEN   8
Terminal Colors
#define COLOR_BLACK   30
#define COLOR_GRAY   (30 | 128)
#define COLOR_RED   31
#define COLOR_BRRED   (31 | 128)
#define COLOR_GREEN   32
#define COLOR_BRGREEN   (32 | 128)
#define COLOR_BROWN   33
#define COLOR_YELLOW   (33 | 128)
#define COLOR_BLUE   34
#define COLOR_BRBLUE   (34 | 128)
#define COLOR_MAGENTA   35
#define COLOR_BRMAGENTA   (35 | 128)
#define COLOR_CYAN   36
#define COLOR_BRCYAN   (36 | 128)
#define COLOR_WHITE   37
#define COLOR_BRWHITE   (37 | 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_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)
#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 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_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

Function Documentation

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

Append a color sequence to an ast_str.

Parameters:
strThe string to append to
fgcolorforeground color
bgcolorbackground color
Return values:
0success
-1failure

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, and ESC.

{
   int attr = 0;

   if (!check_colors_allowed(fgcolor)) {
      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;
}
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(), logger_print_normal(), lua_pbx_exec(), main(), pbx_extension_helper(), print_app_docs(), realtime_exec(), show_config_description(), and start_resource().

{
   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) {
      snprintf(outbuf, maxout, "%c[%d;%d;%dm%s%c[%d;%dm", ESC, attr, fgcolor, bgcolor + 10, inbuf, ESC, COLOR_WHITE, COLOR_BLACK + 10);
   } else {
      snprintf(outbuf, maxout, "%c[%d;%dm%s%c[0m", ESC, attr, fgcolor, inbuf, ESC);
   }
   return outbuf;
}
char* term_color_code ( char *  outbuf,
int  fgcolor,
int  bgcolor,
int  maxout 
)

Write a color sequence to a string.

Parameters:
outbufthe location to write to
fgcolorforeground color
bgcolorbackground color
maxoutmaximum 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().

{
   int attr = 0;

   if (!check_colors_allowed(fgcolor)) {
      *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;
}
char* term_end ( void  )

Definition at line 358 of file term.c.

References enddata.

Referenced by consolehandler(), and main().

{
   return enddata;
}
void term_filter_escapes ( char *  line)

Definition at line 331 of file term.c.

References ESC, and len().

Referenced by ast_log().

{
   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] = ' ';
   }
}
char* term_prep ( void  )

Definition at line 353 of file term.c.

References prepdata.

{
   return prepdata;
}
char* term_prompt ( char *  outbuf,
const char *  inbuf,
int  maxout 
)

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

{
   if (!vt100compat) {
      ast_copy_string(outbuf, inbuf, maxout);
      return outbuf;
   }
   if (ast_opt_force_black_background) {
      snprintf(outbuf, maxout, "%c[%d;%dm%c%c[%d;%dm%s",
         ESC, COLOR_BLUE, COLOR_BLACK + 10,
         inbuf[0],
         ESC, COLOR_WHITE, COLOR_BLACK + 10,
         inbuf + 1);
   } else if (ast_opt_light_background) {
      snprintf(outbuf, maxout, "%c[%d;0m%c%c[%d;0m%s",
         ESC, COLOR_BLUE,
         inbuf[0],
         ESC, COLOR_BLACK,
         inbuf + 1);
   } else {
      snprintf(outbuf, maxout, "%c[%d;%d;0m%c%c[%d;%d;0m%s",
         ESC, ATTR_BRIGHT, COLOR_BLUE,
         inbuf[0],
         ESC, 0, COLOR_WHITE,
         inbuf + 1);
   }
   return outbuf;
}
char* term_quit ( void  )

Definition at line 363 of file term.c.

References quitdata.

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

{
   return quitdata;
}
char* term_strip ( char *  outbuf,
char *  inbuf,
int  maxout 
)

Definition at line 281 of file term.c.

References ESC, and inbuf().

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

{
   char *outbuf_ptr = outbuf, *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;
}