ncurses/trace/lib_traceatr.c

   1 /****************************************************************************
   2  * Copyright (c) 1998-2008,2009 Free Software Foundation, Inc.              *
   3  *                                                                          *
   4  * Permission is hereby granted, free of charge, to any person obtaining a  *
   5  * copy of this software and associated documentation files (the            *
   6  * "Software"), to deal in the Software without restriction, including      *
   7  * without limitation the rights to use, copy, modify, merge, publish,      *
   8  * distribute, distribute with modifications, sublicense, and/or sell       *
   9  * copies of the Software, and to permit persons to whom the Software is    *
  10  * furnished to do so, subject to the following conditions:                 *
  11  *                                                                          *
  12  * The above copyright notice and this permission notice shall be included  *
  13  * in all copies or substantial portions of the Software.                   *
  14  *                                                                          *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  16  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  18  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  21  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  22  *                                                                          *
  23  * Except as contained in this notice, the name(s) of the above copyright   *
  24  * holders shall not be used in advertising or otherwise to promote the     *
  25  * sale, use or other dealings in this Software without prior written       *
  26  * authorization.                                                           *
  27  ****************************************************************************/
  28
  29 /****************************************************************************
  30  *  Author: Thomas Dickey                           1996-on                 *
  31  *     and: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
  32  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
  33  *     and: Juergen Pfeifer                                                 *
  34  ****************************************************************************/
  35
  36 /*
  37  *      lib_traceatr.c - Tracing/Debugging routines (attributes)
  38  */
  39
  40 #include <curses.priv.h>
  41 #include <term.h>               /* acs_chars */
  42
  43 MODULE_ID("$Id: lib_traceatr.c,v 1.64 2009/02/28 21:10:20 tom Exp $")
  44
  45 #define COLOR_OF(c) ((c < 0) ? "default" : (c > 7 ? color_of(c) : colors[c].name))
  46
  47 #ifdef TRACE
  48
  49 static const char l_brace[] = StringOf(L_BRACE);
  50 static const char r_brace[] = StringOf(R_BRACE);
  51
  52 #ifndef USE_TERMLIB
  53
  54 #define my_buffer _nc_globals.traceatr_color_buf
  55 #define my_select _nc_globals.traceatr_color_sel
  56 #define my_cached _nc_globals.traceatr_color_last
  57
  58 static char *
  59 color_of(int c)
  60 {
  61     if (c != my_cached) {
  62         my_cached = c;
  63         my_select = !my_select;
  64         if (c == COLOR_DEFAULT)
  65             strcpy(my_buffer[my_select], "default");
  66         else
  67             sprintf(my_buffer[my_select], "color%d", c);
  68     }
  69     return my_buffer[my_select];
  70 }
  71
  72 #undef my_buffer
  73 #undef my_select
  74 #endif /* !USE_TERMLIB */
  75
  76 NCURSES_EXPORT(char *)
  77 _traceattr2(int bufnum, chtype newmode)
  78 {
  79     static const struct {
  80         unsigned int val;
  81         const char *name;
  82     } names[] =
  83     {
  84         /* *INDENT-OFF* */
  85         { A_STANDOUT,           "A_STANDOUT" },
  86         { A_UNDERLINE,          "A_UNDERLINE" },
  87         { A_REVERSE,            "A_REVERSE" },
  88         { A_BLINK,              "A_BLINK" },
  89         { A_DIM,                "A_DIM" },
  90         { A_BOLD,               "A_BOLD" },
  91         { A_ALTCHARSET,         "A_ALTCHARSET" },
  92         { A_INVIS,              "A_INVIS" },
  93         { A_PROTECT,            "A_PROTECT" },
  94         { A_CHARTEXT,           "A_CHARTEXT" },
  95         { A_NORMAL,             "A_NORMAL" },
  96         { A_COLOR,              "A_COLOR" },
  97         /* *INDENT-ON* */
  98
  99     }
 100 #ifndef USE_TERMLIB
 101     ,
 102         colors[] =
 103     {
 104         /* *INDENT-OFF* */
 105         { COLOR_BLACK,          "COLOR_BLACK" },
 106         { COLOR_RED,            "COLOR_RED" },
 107         { COLOR_GREEN,          "COLOR_GREEN" },
 108         { COLOR_YELLOW,         "COLOR_YELLOW" },
 109         { COLOR_BLUE,           "COLOR_BLUE" },
 110         { COLOR_MAGENTA,        "COLOR_MAGENTA" },
 111         { COLOR_CYAN,           "COLOR_CYAN" },
 112         { COLOR_WHITE,          "COLOR_WHITE" },
 113         /* *INDENT-ON* */
 114
 115     }
 116 #endif /* !USE_TERMLIB */
 117     ;
 118     size_t n;
 119     char temp[80];
 120     char *result = _nc_trace_buf(bufnum, BUFSIZ);
 121
 122     if (result != 0) {
 123         unsigned save_nc_tracing = _nc_tracing;
 124
 125         _nc_tracing = 0;
 126
 127         strcpy(result, l_brace);
 128
 129         for (n = 0; n < SIZEOF(names); n++) {
 130             if ((newmode & names[n].val) != 0) {
 131                 if (result[1] != '\0')
 132                     result = _nc_trace_bufcat(bufnum, "|");
 133                 result = _nc_trace_bufcat(bufnum, names[n].name);
 134
 135                 if (names[n].val == A_COLOR) {
 136                     short pairnum = PAIR_NUMBER(newmode);
 137 #ifdef USE_TERMLIB
 138                     /* pair_content lives in libncurses */
 139                     (void) sprintf(temp, "{%d}", pairnum);
 140 #else
 141                     short fg, bg;
 142
 143                     if (pair_content(pairnum, &fg, &bg) == OK) {
 144                         (void) sprintf(temp,
 145                                        "{%d = {%s, %s}}",
 146                                        pairnum,
 147                                        COLOR_OF(fg),
 148                                        COLOR_OF(bg));
 149                     } else {
 150                         (void) sprintf(temp, "{%d}", pairnum);
 151                     }
 152 #endif
 153                     result = _nc_trace_bufcat(bufnum, temp);
 154                 }
 155             }
 156         }
 157         if (ChAttrOf(newmode) == A_NORMAL) {
 158             if (result != 0 && result[1] != '\0')
 159                 (void) _nc_trace_bufcat(bufnum, "|");
 160             (void) _nc_trace_bufcat(bufnum, "A_NORMAL");
 161         }
 162
 163         _nc_tracing = save_nc_tracing;
 164         result = _nc_trace_bufcat(bufnum, r_brace);
 165     }
 166     return result;
 167 }
 168
 169 NCURSES_EXPORT(char *)
 170 _traceattr(attr_t newmode)
 171 {
 172     return _traceattr2(0, newmode);
 173 }
 174
 175 /* Trace 'int' return-values */
 176 NCURSES_EXPORT(attr_t)
 177 _nc_retrace_attr_t(attr_t code)
 178 {
 179     T((T_RETURN("%s"), _traceattr(code)));
 180     return code;
 181 }
 182
 183 const char *
 184 _nc_altcharset_name(attr_t attr, chtype ch)
 185 {
 186     typedef struct {
 187         unsigned int val;
 188         const char *name;
 189     } ALT_NAMES;
 190     static const ALT_NAMES names[] =
 191     {
 192         {'l', "ACS_ULCORNER"},  /* upper left corner */
 193         {'m', "ACS_LLCORNER"},  /* lower left corner */
 194         {'k', "ACS_URCORNER"},  /* upper right corner */
 195         {'j', "ACS_LRCORNER"},  /* lower right corner */
 196         {'t', "ACS_LTEE"},      /* tee pointing right */
 197         {'u', "ACS_RTEE"},      /* tee pointing left */
 198         {'v', "ACS_BTEE"},      /* tee pointing up */
 199         {'w', "ACS_TTEE"},      /* tee pointing down */
 200         {'q', "ACS_HLINE"},     /* horizontal line */
 201         {'x', "ACS_VLINE"},     /* vertical line */
 202         {'n', "ACS_PLUS"},      /* large plus or crossover */
 203         {'o', "ACS_S1"},        /* scan line 1 */
 204         {'s', "ACS_S9"},        /* scan line 9 */
 205         {'`', "ACS_DIAMOND"},   /* diamond */
 206         {'a', "ACS_CKBOARD"},   /* checker board (stipple) */
 207         {'f', "ACS_DEGREE"},    /* degree symbol */
 208         {'g', "ACS_PLMINUS"},   /* plus/minus */
 209         {'~', "ACS_BULLET"},    /* bullet */
 210         {',', "ACS_LARROW"},    /* arrow pointing left */
 211         {'+', "ACS_RARROW"},    /* arrow pointing right */
 212         {'.', "ACS_DARROW"},    /* arrow pointing down */
 213         {'-', "ACS_UARROW"},    /* arrow pointing up */
 214         {'h', "ACS_BOARD"},     /* board of squares */
 215         {'i', "ACS_LANTERN"},   /* lantern symbol */
 216         {'0', "ACS_BLOCK"},     /* solid square block */
 217         {'p', "ACS_S3"},        /* scan line 3 */
 218         {'r', "ACS_S7"},        /* scan line 7 */
 219         {'y', "ACS_LEQUAL"},    /* less/equal */
 220         {'z', "ACS_GEQUAL"},    /* greater/equal */
 221         {'{', "ACS_PI"},        /* Pi */
 222         {'|', "ACS_NEQUAL"},    /* not equal */
 223         {'}', "ACS_STERLING"},  /* UK pound sign */
 224         {'\0', (char *) 0}
 225     };
 226
 227     const char *result = 0;
 228
 229     if ((attr & A_ALTCHARSET) && (acs_chars != 0)) {
 230         char *cp;
 231         char *found = 0;
 232         const ALT_NAMES *strp;
 233
 234         for (cp = acs_chars; cp[0] && cp[1]; cp += 2) {
 235             if (ChCharOf(cp[1]) == ChCharOf(ch)) {
 236                 found = cp;
 237                 /* don't exit from loop - there may be redefinitions */
 238             }
 239         }
 240
 241         if (found != 0) {
 242             ch = ChCharOf(*found);
 243             for (strp = names; strp->val; strp++)
 244                 if (strp->val == ch) {
 245                     result = strp->name;
 246                     break;
 247                 }
 248         }
 249     }
 250     return result;
 251 }
 252
 253 NCURSES_EXPORT(char *)
 254 _tracechtype2(int bufnum, chtype ch)
 255 {
 256     const char *found;
 257     char *result = _nc_trace_buf(bufnum, BUFSIZ);
 258
 259     if (result != 0) {
 260         strcpy(result, l_brace);
 261         if ((found = _nc_altcharset_name(ChAttrOf(ch), ch)) != 0) {
 262             (void) _nc_trace_bufcat(bufnum, found);
 263         } else
 264             (void) _nc_trace_bufcat(bufnum, _nc_tracechar(CURRENT_SCREEN,
 265                                     (int) ChCharOf(ch)));
 266
 267         if (ChAttrOf(ch) != A_NORMAL) {
 268             (void) _nc_trace_bufcat(bufnum, " | ");
 269             (void) _nc_trace_bufcat(bufnum,
 270                                     _traceattr2(bufnum + 20, ChAttrOf(ch)));
 271         }
 272
 273         result = _nc_trace_bufcat(bufnum, r_brace);
 274     }
 275     return result;
 276 }
 277
 278 NCURSES_EXPORT(char *)
 279 _tracechtype(chtype ch)
 280 {
 281     return _tracechtype2(0, ch);
 282 }
 283
 284 /* Trace 'chtype' return-values */
 285 NCURSES_EXPORT(chtype)
 286 _nc_retrace_chtype(chtype code)
 287 {
 288     T((T_RETURN("%s"), _tracechtype(code)));
 289     return code;
 290 }
 291
 292 #if USE_WIDEC_SUPPORT
 293 NCURSES_EXPORT(char *)
 294 _tracecchar_t2(int bufnum, const cchar_t *ch)
 295 {
 296     char *result = _nc_trace_buf(bufnum, BUFSIZ);
 297     attr_t attr;
 298     const char *found;
 299
 300     if (result != 0) {
 301         strcpy(result, l_brace);
 302         if (ch != 0) {
 303             attr = AttrOfD(ch);
 304             if ((found = _nc_altcharset_name(attr, (chtype) CharOfD(ch))) != 0) {
 305                 (void) _nc_trace_bufcat(bufnum, found);
 306                 attr &= ~A_ALTCHARSET;
 307             } else if (isWidecExt(CHDEREF(ch))) {
 308                 (void) _nc_trace_bufcat(bufnum, "{NAC}");
 309                 attr &= ~A_CHARTEXT;
 310             } else {
 311                 PUTC_DATA;
 312                 int n;
 313
 314                 PUTC_INIT;
 315                 (void) _nc_trace_bufcat(bufnum, "{ ");
 316                 for (PUTC_i = 0; PUTC_i < CCHARW_MAX; ++PUTC_i) {
 317                     PUTC_ch = ch->chars[PUTC_i];
 318                     if (PUTC_ch == L'\0')
 319                         break;
 320                     PUTC_n = wcrtomb(PUTC_buf, ch->chars[PUTC_i], &PUT_st);
 321                     if (PUTC_n <= 0) {
 322                         if (PUTC_ch != L'\0') {
 323                             /* it could not be a multibyte sequence */
 324                             (void) _nc_trace_bufcat(bufnum,
 325                                                     _nc_tracechar(CURRENT_SCREEN,
 326                                                                   UChar(ch->chars[PUTC_i])));
 327                         }
 328                         break;
 329                     }
 330                     for (n = 0; n < PUTC_n; n++) {
 331                         if (n)
 332                             (void) _nc_trace_bufcat(bufnum, ", ");
 333                         (void) _nc_trace_bufcat(bufnum,
 334                                                 _nc_tracechar(CURRENT_SCREEN,
 335                                                               UChar(PUTC_buf[n])));
 336                     }
 337                 }
 338                 (void) _nc_trace_bufcat(bufnum, " }");
 339             }
 340             if (attr != A_NORMAL) {
 341                 (void) _nc_trace_bufcat(bufnum, " | ");
 342                 (void) _nc_trace_bufcat(bufnum, _traceattr2(bufnum + 20, attr));
 343             }
 344         }
 345
 346         result = _nc_trace_bufcat(bufnum, r_brace);
 347     }
 348     return result;
 349 }
 350
 351 NCURSES_EXPORT(char *)
 352 _tracecchar_t(const cchar_t *ch)
 353 {
 354     return _tracecchar_t2(0, ch);
 355 }
 356 #endif
 357
 358 #else
 359 EMPTY_MODULE(_nc_lib_traceatr)
 360 #endif /* TRACE */