07424222ec00c8814d95b285421e11552bbd1c69
[ncurses.git] / ncurses / trace / lib_traceatr.c
1 /****************************************************************************
2  * Copyright (c) 1998-2011,2012 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
42 #ifndef CUR
43 #define CUR SP_TERMTYPE
44 #endif
45
46 MODULE_ID("$Id: lib_traceatr.c,v 1.79 2012/02/22 22:40:24 tom Exp $")
47
48 #define COLOR_OF(c) ((c < 0) ? "default" : (c > 7 ? color_of(c) : colors[c].name))
49
50 #define TRACE_BUF_SIZE(num) (_nc_globals.tracebuf_ptr[num].size)
51 #define COLOR_BUF_SIZE(num) (sizeof(my_buffer[num]))
52
53 #ifdef TRACE
54
55 static const char l_brace[] = StringOf(L_BRACE);
56 static const char r_brace[] = StringOf(R_BRACE);
57
58 #ifndef USE_TERMLIB
59
60 #define my_buffer _nc_globals.traceatr_color_buf
61 #define my_select _nc_globals.traceatr_color_sel
62 #define my_cached _nc_globals.traceatr_color_last
63
64 static char *
65 color_of(int c)
66 {
67     if (c != my_cached) {
68         my_cached = c;
69         my_select = !my_select;
70         if (c == COLOR_DEFAULT)
71             _nc_STRCPY(my_buffer[my_select], "default",
72                        COLOR_BUF_SIZE(my_select));
73         else
74             _nc_SPRINTF(my_buffer[my_select],
75                         _nc_SLIMIT(COLOR_BUF_SIZE(my_select))
76                         "color%d", c);
77     }
78     return my_buffer[my_select];
79 }
80
81 #undef my_buffer
82 #undef my_select
83 #endif /* !USE_TERMLIB */
84
85 NCURSES_EXPORT(char *)
86 _traceattr2(int bufnum, chtype newmode)
87 {
88     static const struct {
89         unsigned int val;
90         const char *name;
91     } names[] =
92     {
93         /* *INDENT-OFF* */
94         { A_STANDOUT,           "A_STANDOUT" },
95         { A_UNDERLINE,          "A_UNDERLINE" },
96         { A_REVERSE,            "A_REVERSE" },
97         { A_BLINK,              "A_BLINK" },
98         { A_DIM,                "A_DIM" },
99         { A_BOLD,               "A_BOLD" },
100         { A_ALTCHARSET,         "A_ALTCHARSET" },
101         { A_INVIS,              "A_INVIS" },
102         { A_PROTECT,            "A_PROTECT" },
103         { A_CHARTEXT,           "A_CHARTEXT" },
104         { A_NORMAL,             "A_NORMAL" },
105         { A_COLOR,              "A_COLOR" },
106         /* *INDENT-ON* */
107
108     }
109 #ifndef USE_TERMLIB
110     ,
111         colors[] =
112     {
113         /* *INDENT-OFF* */
114         { COLOR_BLACK,          "COLOR_BLACK" },
115         { COLOR_RED,            "COLOR_RED" },
116         { COLOR_GREEN,          "COLOR_GREEN" },
117         { COLOR_YELLOW,         "COLOR_YELLOW" },
118         { COLOR_BLUE,           "COLOR_BLUE" },
119         { COLOR_MAGENTA,        "COLOR_MAGENTA" },
120         { COLOR_CYAN,           "COLOR_CYAN" },
121         { COLOR_WHITE,          "COLOR_WHITE" },
122         /* *INDENT-ON* */
123
124     }
125 #endif /* !USE_TERMLIB */
126     ;
127     size_t n;
128     char temp[80];
129     char *result = _nc_trace_buf(bufnum, (size_t) BUFSIZ);
130
131     if (result != 0) {
132         unsigned save_nc_tracing = _nc_tracing;
133
134         _nc_tracing = 0;
135
136         _nc_STRCPY(result, l_brace, TRACE_BUF_SIZE(bufnum));
137
138         for (n = 0; n < SIZEOF(names); n++) {
139             if ((newmode & names[n].val) != 0) {
140                 if (result[1] != '\0')
141                     (void) _nc_trace_bufcat(bufnum, "|");
142                 result = _nc_trace_bufcat(bufnum, names[n].name);
143
144                 if (names[n].val == A_COLOR) {
145                     short pairnum = (short) PairNumber(newmode);
146 #ifdef USE_TERMLIB
147                     /* pair_content lives in libncurses */
148                     _nc_SPRINTF(temp, _nc_SLIMIT(sizeof(temp))
149                                 "{%d}", pairnum);
150 #else
151                     short fg, bg;
152
153                     if (pair_content(pairnum, &fg, &bg) == OK) {
154                         _nc_SPRINTF(temp, _nc_SLIMIT(sizeof(temp))
155                                     "{%d = {%s, %s}}",
156                                     pairnum,
157                                     COLOR_OF(fg),
158                                     COLOR_OF(bg));
159                     } else {
160                         _nc_SPRINTF(temp, _nc_SLIMIT(sizeof(temp))
161                                     "{%d}", pairnum);
162                     }
163 #endif
164                     result = _nc_trace_bufcat(bufnum, temp);
165                 }
166             }
167         }
168         if (ChAttrOf(newmode) == A_NORMAL) {
169             if (result != 0 && result[1] != '\0')
170                 (void) _nc_trace_bufcat(bufnum, "|");
171             (void) _nc_trace_bufcat(bufnum, "A_NORMAL");
172         }
173
174         _nc_tracing = save_nc_tracing;
175         result = _nc_trace_bufcat(bufnum, r_brace);
176     }
177     return result;
178 }
179
180 NCURSES_EXPORT(char *)
181 _traceattr(attr_t newmode)
182 {
183     return _traceattr2(0, newmode);
184 }
185
186 /* Trace 'int' return-values */
187 NCURSES_EXPORT(int)
188 _nc_retrace_int_attr_t(attr_t code)
189 {
190     T((T_RETURN("%s"), _traceattr(code)));
191     return (int) code;
192 }
193
194 /* Trace 'attr_t' return-values */
195 NCURSES_EXPORT(attr_t)
196 _nc_retrace_attr_t(attr_t code)
197 {
198     T((T_RETURN("%s"), _traceattr(code)));
199     return code;
200 }
201
202 const char *
203 _nc_altcharset_name(attr_t attr, chtype ch)
204 {
205     typedef struct {
206         unsigned int val;
207         const char *name;
208     } ALT_NAMES;
209 #if NCURSES_SP_FUNCS
210     SCREEN *sp = CURRENT_SCREEN;
211 #endif
212     static const ALT_NAMES names[] =
213     {
214         {'l', "ACS_ULCORNER"},  /* upper left corner */
215         {'m', "ACS_LLCORNER"},  /* lower left corner */
216         {'k', "ACS_URCORNER"},  /* upper right corner */
217         {'j', "ACS_LRCORNER"},  /* lower right corner */
218         {'t', "ACS_LTEE"},      /* tee pointing right */
219         {'u', "ACS_RTEE"},      /* tee pointing left */
220         {'v', "ACS_BTEE"},      /* tee pointing up */
221         {'w', "ACS_TTEE"},      /* tee pointing down */
222         {'q', "ACS_HLINE"},     /* horizontal line */
223         {'x', "ACS_VLINE"},     /* vertical line */
224         {'n', "ACS_PLUS"},      /* large plus or crossover */
225         {'o', "ACS_S1"},        /* scan line 1 */
226         {'s', "ACS_S9"},        /* scan line 9 */
227         {'`', "ACS_DIAMOND"},   /* diamond */
228         {'a', "ACS_CKBOARD"},   /* checker board (stipple) */
229         {'f', "ACS_DEGREE"},    /* degree symbol */
230         {'g', "ACS_PLMINUS"},   /* plus/minus */
231         {'~', "ACS_BULLET"},    /* bullet */
232         {',', "ACS_LARROW"},    /* arrow pointing left */
233         {'+', "ACS_RARROW"},    /* arrow pointing right */
234         {'.', "ACS_DARROW"},    /* arrow pointing down */
235         {'-', "ACS_UARROW"},    /* arrow pointing up */
236         {'h', "ACS_BOARD"},     /* board of squares */
237         {'i', "ACS_LANTERN"},   /* lantern symbol */
238         {'0', "ACS_BLOCK"},     /* solid square block */
239         {'p', "ACS_S3"},        /* scan line 3 */
240         {'r', "ACS_S7"},        /* scan line 7 */
241         {'y', "ACS_LEQUAL"},    /* less/equal */
242         {'z', "ACS_GEQUAL"},    /* greater/equal */
243         {'{', "ACS_PI"},        /* Pi */
244         {'|', "ACS_NEQUAL"},    /* not equal */
245         {'}', "ACS_STERLING"},  /* UK pound sign */
246         {'\0', (char *) 0}
247     };
248
249     const char *result = 0;
250
251 #if NCURSES_SP_FUNCS
252     (void) sp;
253 #endif
254     if (SP_PARM != 0 && (attr & A_ALTCHARSET) && (acs_chars != 0)) {
255         char *cp;
256         char *found = 0;
257         const ALT_NAMES *strp;
258
259         for (cp = acs_chars; cp[0] && cp[1]; cp += 2) {
260             if (ChCharOf(UChar(cp[1])) == ChCharOf(ch)) {
261                 found = cp;
262                 /* don't exit from loop - there may be redefinitions */
263             }
264         }
265
266         if (found != 0) {
267             ch = ChCharOf(UChar(*found));
268             for (strp = names; strp->val; strp++)
269                 if (strp->val == ch) {
270                     result = strp->name;
271                     break;
272                 }
273         }
274     }
275     return result;
276 }
277
278 NCURSES_EXPORT(char *)
279 _tracechtype2(int bufnum, chtype ch)
280 {
281     const char *found;
282     char *result = _nc_trace_buf(bufnum, (size_t) BUFSIZ);
283
284     if (result != 0) {
285         _nc_STRCPY(result, l_brace, TRACE_BUF_SIZE(bufnum));
286         if ((found = _nc_altcharset_name(ChAttrOf(ch), ch)) != 0) {
287             (void) _nc_trace_bufcat(bufnum, found);
288         } else
289             (void) _nc_trace_bufcat(bufnum,
290                                     _nc_tracechar(CURRENT_SCREEN,
291                                                   (int) ChCharOf(ch)));
292
293         if (ChAttrOf(ch) != A_NORMAL) {
294             (void) _nc_trace_bufcat(bufnum, " | ");
295             (void) _nc_trace_bufcat(bufnum,
296                                     _traceattr2(bufnum + 20, ChAttrOf(ch)));
297         }
298
299         result = _nc_trace_bufcat(bufnum, r_brace);
300     }
301     return result;
302 }
303
304 NCURSES_EXPORT(char *)
305 _tracechtype(chtype ch)
306 {
307     return _tracechtype2(0, ch);
308 }
309
310 /* Trace 'chtype' return-values */
311 NCURSES_EXPORT(chtype)
312 _nc_retrace_chtype(chtype code)
313 {
314     T((T_RETURN("%s"), _tracechtype(code)));
315     return code;
316 }
317
318 #if USE_WIDEC_SUPPORT
319 NCURSES_EXPORT(char *)
320 _tracecchar_t2(int bufnum, const cchar_t *ch)
321 {
322     char *result = _nc_trace_buf(bufnum, (size_t) BUFSIZ);
323     attr_t attr;
324     const char *found;
325
326     if (result != 0) {
327         _nc_STRCPY(result, l_brace, TRACE_BUF_SIZE(bufnum));
328         if (ch != 0) {
329             attr = AttrOfD(ch);
330             if ((found = _nc_altcharset_name(attr, (chtype) CharOfD(ch))) != 0) {
331                 (void) _nc_trace_bufcat(bufnum, found);
332                 attr &= ~A_ALTCHARSET;
333             } else if (isWidecExt(CHDEREF(ch))) {
334                 (void) _nc_trace_bufcat(bufnum, "{NAC}");
335                 attr &= ~A_CHARTEXT;
336             } else {
337                 PUTC_DATA;
338                 int n;
339
340                 PUTC_INIT;
341                 (void) _nc_trace_bufcat(bufnum, "{ ");
342                 for (PUTC_i = 0; PUTC_i < CCHARW_MAX; ++PUTC_i) {
343                     PUTC_ch = ch->chars[PUTC_i];
344                     if (PUTC_ch == L'\0') {
345                         if (PUTC_i == 0)
346                             (void) _nc_trace_bufcat(bufnum, "\\000");
347                         break;
348                     }
349                     PUTC_n = (int) wcrtomb(PUTC_buf, ch->chars[PUTC_i], &PUT_st);
350                     if (PUTC_n <= 0) {
351                         if (PUTC_ch != L'\0') {
352                             /* it could not be a multibyte sequence */
353                             (void) _nc_trace_bufcat(bufnum,
354                                                     _nc_tracechar(CURRENT_SCREEN,
355                                                                   UChar(ch->chars[PUTC_i])));
356                         }
357                         break;
358                     }
359                     for (n = 0; n < PUTC_n; n++) {
360                         if (n)
361                             (void) _nc_trace_bufcat(bufnum, ", ");
362                         (void) _nc_trace_bufcat(bufnum,
363                                                 _nc_tracechar(CURRENT_SCREEN,
364                                                               UChar(PUTC_buf[n])));
365                     }
366                 }
367                 (void) _nc_trace_bufcat(bufnum, " }");
368             }
369             if (attr != A_NORMAL) {
370                 (void) _nc_trace_bufcat(bufnum, " | ");
371                 (void) _nc_trace_bufcat(bufnum, _traceattr2(bufnum + 20, attr));
372             }
373         }
374
375         result = _nc_trace_bufcat(bufnum, r_brace);
376     }
377     return result;
378 }
379
380 NCURSES_EXPORT(char *)
381 _tracecchar_t(const cchar_t *ch)
382 {
383     return _tracecchar_t2(0, ch);
384 }
385 #endif
386
387 #else
388 EMPTY_MODULE(_nc_lib_traceatr)
389 #endif /* TRACE */