ncurses 6.1 - patch 20180707
[ncurses.git] / ncurses / trace / lib_traceatr.c
index d9e007517f76b72cd7ecb8f10d72ade4c2b2a927..a4144ab5c4caa10cb815f8cc27d89e8834f3c4c8 100644 (file)
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright (c) 1998 Free Software Foundation, Inc.                        *
+ * Copyright (c) 1998-2017,2018 Free Software Foundation, Inc.              *
  *                                                                          *
  * Permission is hereby granted, free of charge, to any person obtaining a  *
  * copy of this software and associated documentation files (the            *
  ****************************************************************************/
 
 /****************************************************************************
- *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
+ *  Author: Thomas Dickey                           1996-on                 *
+ *     and: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
+ *     and: Juergen Pfeifer                                                 *
  ****************************************************************************/
 
-
-
 /*
  *     lib_traceatr.c - Tracing/Debugging routines (attributes)
  */
 
 #include <curses.priv.h>
-#include <term.h>      /* acs_chars */
 
-MODULE_ID("$Id: lib_traceatr.c,v 1.28 1998/03/21 18:39:36 tom Exp $")
+#ifndef CUR
+#define CUR SP_TERMTYPE
+#endif
+
+MODULE_ID("$Id: lib_traceatr.c,v 1.92 2018/05/05 17:49:17 tom Exp $")
+
+#define COLOR_OF(c) ((c < 0) ? "default" : (c > 7 ? color_of(c) : colors[c].name))
 
-#define COLOR_OF(c) (c < 0 || c > 7 ? "default" : colors[c].name)
+#define TRACE_BUF_SIZE(num) (_nc_globals.tracebuf_ptr[num].size)
+#define COLOR_BUF_SIZE(num) (sizeof(my_buffer[num]))
 
 #ifdef TRACE
-char *_traceattr2(int bufnum, attr_t newmode)
+
+static const char l_brace[] = StringOf(L_BRACE);
+static const char r_brace[] = StringOf(R_BRACE);
+
+#ifndef USE_TERMLIB
+
+#define my_buffer _nc_globals.traceatr_color_buf
+#define my_select _nc_globals.traceatr_color_sel
+#define my_cached _nc_globals.traceatr_color_last
+
+static char *
+color_of(int c)
 {
-char   *buf = _nc_trace_buf(bufnum, BUFSIZ);
-char   *tmp = buf;
-static const   struct {unsigned int val; const char *name;}
-names[] =
+    if (c != my_cached) {
+       my_cached = c;
+       my_select = !my_select;
+       if (isDefaultColor(c))
+           _nc_STRCPY(my_buffer[my_select], "default",
+                      COLOR_BUF_SIZE(my_select));
+       else
+           _nc_SPRINTF(my_buffer[my_select],
+                       _nc_SLIMIT(COLOR_BUF_SIZE(my_select))
+                       "color%d", c);
+    }
+    return my_buffer[my_select];
+}
+
+#undef my_buffer
+#undef my_select
+#endif /* !USE_TERMLIB */
+
+NCURSES_EXPORT(char *)
+_traceattr2(int bufnum, chtype newmode)
+{
+#define DATA(name) { name, { #name } }
+    static const struct {
+       unsigned int val;
+       const char name[14];
+    } names[] =
     {
-       { A_STANDOUT,           "A_STANDOUT" },
-       { A_UNDERLINE,          "A_UNDERLINE" },
-       { A_REVERSE,            "A_REVERSE" },
-       { A_BLINK,              "A_BLINK" },
-       { A_DIM,                "A_DIM" },
-       { A_BOLD,               "A_BOLD" },
-       { A_ALTCHARSET,         "A_ALTCHARSET" },
-       { A_INVIS,              "A_INVIS" },
-       { A_PROTECT,            "A_PROTECT" },
-       { A_CHARTEXT,           "A_CHARTEXT" },
-       { A_NORMAL,             "A_NORMAL" },
-       { A_COLOR,              "A_COLOR" },
-    },
-colors[] =
+       DATA(A_STANDOUT),
+           DATA(A_UNDERLINE),
+           DATA(A_REVERSE),
+           DATA(A_BLINK),
+           DATA(A_DIM),
+           DATA(A_BOLD),
+           DATA(A_ALTCHARSET),
+           DATA(A_INVIS),
+           DATA(A_PROTECT),
+           DATA(A_CHARTEXT),
+           DATA(A_NORMAL),
+           DATA(A_COLOR),
+#if USE_ITALIC
+           DATA(A_ITALIC),
+#endif
+    }
+#ifndef USE_TERMLIB
+    ,
+       colors[] =
     {
-       { COLOR_BLACK,          "COLOR_BLACK" },
-       { COLOR_RED,            "COLOR_RED" },
-       { COLOR_GREEN,          "COLOR_GREEN" },
-       { COLOR_YELLOW,         "COLOR_YELLOW" },
-       { COLOR_BLUE,           "COLOR_BLUE" },
-       { COLOR_MAGENTA,        "COLOR_MAGENTA" },
-       { COLOR_CYAN,           "COLOR_CYAN" },
-       { COLOR_WHITE,          "COLOR_WHITE" },
-    };
-size_t n;
-unsigned save_nc_tracing = _nc_tracing;
+       DATA(COLOR_BLACK),
+           DATA(COLOR_RED),
+           DATA(COLOR_GREEN),
+           DATA(COLOR_YELLOW),
+           DATA(COLOR_BLUE),
+           DATA(COLOR_MAGENTA),
+           DATA(COLOR_CYAN),
+           DATA(COLOR_WHITE),
+    }
+#endif /* !USE_TERMLIB */
+    ;
+#undef DATA
+    char *result = _nc_trace_buf(bufnum, (size_t) BUFSIZ);
+
+    if (result != 0) {
+       size_t n;
+       unsigned save_nc_tracing = _nc_tracing;
+
        _nc_tracing = 0;
 
-       strcpy(tmp++, "{");
+       _nc_STRCPY(result, l_brace, TRACE_BUF_SIZE(bufnum));
 
        for (n = 0; n < SIZEOF(names); n++) {
-               if ((newmode & names[n].val) != 0) {
-                       if (buf[1] != '\0')
-                               strcat(tmp, "|");
-                       strcat(tmp, names[n].name);
-                       tmp += strlen(tmp);
-
-                       if (names[n].val == A_COLOR)
-                       {
-                               short pairnum = PAIR_NUMBER(newmode);
-                               short fg, bg;
-       
-                               if (pair_content(pairnum, &fg, &bg) == OK)
-                                       (void) sprintf(tmp,
-                                               "{%d = {%s, %s}}",
-                                               pairnum,
-                                               COLOR_OF(fg),
-                                               COLOR_OF(bg)
-                                               );
-                               else
-                                       (void) sprintf(tmp, "{%d}", pairnum);
-                       }
+
+           if ((newmode & names[n].val) != 0) {
+               if (result[1] != '\0')
+                   (void) _nc_trace_bufcat(bufnum, "|");
+               result = _nc_trace_bufcat(bufnum, names[n].name);
+
+               if (names[n].val == A_COLOR) {
+                   char temp[80];
+                   short pairnum = (short) PairNumber(newmode);
+#ifdef USE_TERMLIB
+                   /* pair_content lives in libncurses */
+                   _nc_SPRINTF(temp, _nc_SLIMIT(sizeof(temp))
+                               "{%d}", pairnum);
+#else
+                   NCURSES_COLOR_T fg, bg;
+
+                   if (pair_content(pairnum, &fg, &bg) == OK) {
+                       _nc_SPRINTF(temp, _nc_SLIMIT(sizeof(temp))
+                                   "{%d = {%s, %s}}",
+                                   pairnum,
+                                   COLOR_OF(fg),
+                                   COLOR_OF(bg));
+                   } else {
+                       _nc_SPRINTF(temp, _nc_SLIMIT(sizeof(temp))
+                                   "{%d}", pairnum);
+                   }
+#endif
+                   result = _nc_trace_bufcat(bufnum, temp);
                }
+           }
        }
-       if (AttrOf(newmode) == A_NORMAL) {
-               if (buf[1] != '\0')
-                       strcat(tmp, "|");
-               strcat(tmp, "A_NORMAL");
+       if (ChAttrOf(newmode) == A_NORMAL) {
+           if (result != 0 && result[1] != '\0')
+               (void) _nc_trace_bufcat(bufnum, "|");
+           (void) _nc_trace_bufcat(bufnum, "A_NORMAL");
        }
 
        _nc_tracing = save_nc_tracing;
-       return (strcat(buf,"}"));
+       result = _nc_trace_bufcat(bufnum, r_brace);
+    }
+    return result;
 }
 
-char *_traceattr(attr_t newmode)
+NCURSES_EXPORT(char *)
+_traceattr(attr_t newmode)
 {
-       return _traceattr2(0, newmode);
+    return _traceattr2(0, newmode);
 }
 
 /* Trace 'int' return-values */
-attr_t _nc_retrace_attr_t(attr_t code)
+NCURSES_EXPORT(int)
+_nc_retrace_int_attr_t(attr_t code)
 {
-       T((T_RETURN("%s"), _traceattr(code)));
-       return code;
+    T((T_RETURN("%s"), _traceattr(code)));
+    return (int) code;
 }
 
-char *_tracechtype2(int bufnum, chtype ch)
+/* Trace 'attr_t' return-values */
+NCURSES_EXPORT(attr_t)
+_nc_retrace_attr_t(attr_t code)
 {
-char   *buf = _nc_trace_buf(bufnum, BUFSIZ);
-char   *found = 0;
+    T((T_RETURN("%s"), _traceattr(code)));
+    return code;
+}
 
-    strcpy(buf, "{");
-    if (ch & A_ALTCHARSET)
+const char *
+_nc_altcharset_name(attr_t attr, chtype ch)
+{
+#define DATA(code, name) { code, { #name } }
+    typedef struct {
+       unsigned int val;
+       const char name[13];
+    } ALT_NAMES;
+#if NCURSES_SP_FUNCS
+    SCREEN *sp = CURRENT_SCREEN;
+#endif
+    static const ALT_NAMES names[] =
     {
-       char    *cp;
-       static const    struct {unsigned int val; const char *name;}
-       names[] =
-       {
-           {'l', "ACS_ULCORNER"},      /* upper left corner */
-           {'m', "ACS_LLCORNER"},      /* lower left corner */
-           {'k', "ACS_URCORNER"},      /* upper right corner */
-           {'j', "ACS_LRCORNER"},      /* lower right corner */
-           {'t', "ACS_LTEE"},          /* tee pointing right */
-           {'u', "ACS_RTEE"},          /* tee pointing left */
-           {'v', "ACS_BTEE"},          /* tee pointing up */
-           {'w', "ACS_TTEE"},          /* tee pointing down */
-           {'q', "ACS_HLINE"},         /* horizontal line */
-           {'x', "ACS_VLINE"},         /* vertical line */
-           {'n', "ACS_PLUS"},          /* large plus or crossover */
-           {'o', "ACS_S1"},            /* scan line 1 */
-           {'s', "ACS_S9"},            /* scan line 9 */
-           {'`', "ACS_DIAMOND"},       /* diamond */
-           {'a', "ACS_CKBOARD"},       /* checker board (stipple) */
-           {'f', "ACS_DEGREE"},        /* degree symbol */
-           {'g', "ACS_PLMINUS"},       /* plus/minus */
-           {'~', "ACS_BULLET"},        /* bullet */
-           {',', "ACS_LARROW"},        /* arrow pointing left */
-           {'+', "ACS_RARROW"},        /* arrow pointing right */
-           {'.', "ACS_DARROW"},        /* arrow pointing down */
-           {'-', "ACS_UARROW"},        /* arrow pointing up */
-           {'h', "ACS_BOARD"},         /* board of squares */
-           {'i', "ACS_LANTERN"},       /* lantern symbol */
-           {'0', "ACS_BLOCK"},         /* solid square block */
-           {'p', "ACS_S3"},            /* scan line 3 */
-           {'r', "ACS_S7"},            /* scan line 7 */
-           {'y', "ACS_LEQUAL"},        /* less/equal */
-           {'z', "ACS_GEQUAL"},        /* greater/equal */
-           {'{', "ACS_PI"},            /* Pi */
-           {'|', "ACS_NEQUAL"},        /* not equal */
-           {'}', "ACS_STERLING"},      /* UK pound sign */
-           {'\0',(char *)0}
-       },
-       *sp;
-
-       for (cp = acs_chars; cp[0] && cp[1]; cp += 2)
-       {
-           if (TextOf(cp[1]) == TextOf(ch))
-           {
+       DATA('l', ACS_ULCORNER),        /* upper left corner */
+       DATA('m', ACS_LLCORNER),        /* lower left corner */
+       DATA('k', ACS_URCORNER),        /* upper right corner */
+       DATA('j', ACS_LRCORNER),        /* lower right corner */
+       DATA('t', ACS_LTEE),    /* tee pointing right */
+       DATA('u', ACS_RTEE),    /* tee pointing left */
+       DATA('v', ACS_BTEE),    /* tee pointing up */
+       DATA('w', ACS_TTEE),    /* tee pointing down */
+       DATA('q', ACS_HLINE),   /* horizontal line */
+       DATA('x', ACS_VLINE),   /* vertical line */
+       DATA('n', ACS_PLUS),    /* large plus or crossover */
+       DATA('o', ACS_S1),      /* scan line 1 */
+       DATA('s', ACS_S9),      /* scan line 9 */
+       DATA('`', ACS_DIAMOND), /* diamond */
+       DATA('a', ACS_CKBOARD), /* checker board (stipple) */
+       DATA('f', ACS_DEGREE),  /* degree symbol */
+       DATA('g', ACS_PLMINUS), /* plus/minus */
+       DATA('~', ACS_BULLET),  /* bullet */
+       DATA(',', ACS_LARROW),  /* arrow pointing left */
+       DATA('+', ACS_RARROW),  /* arrow pointing right */
+       DATA('.', ACS_DARROW),  /* arrow pointing down */
+       DATA('-', ACS_UARROW),  /* arrow pointing up */
+       DATA('h', ACS_BOARD),   /* board of squares */
+       DATA('i', ACS_LANTERN), /* lantern symbol */
+       DATA('0', ACS_BLOCK),   /* solid square block */
+       DATA('p', ACS_S3),      /* scan line 3 */
+       DATA('r', ACS_S7),      /* scan line 7 */
+       DATA('y', ACS_LEQUAL),  /* less/equal */
+       DATA('z', ACS_GEQUAL),  /* greater/equal */
+       DATA('{', ACS_PI),      /* Pi */
+       DATA('|', ACS_NEQUAL),  /* not equal */
+       DATA('}', ACS_STERLING),        /* UK pound sign */
+    };
+#undef DATA
+
+    const char *result = 0;
+
+#if NCURSES_SP_FUNCS
+    (void) sp;
+#endif
+    if (SP_PARM != 0 && (attr & A_ALTCHARSET) && (acs_chars != 0)) {
+       char *cp;
+       char *found = 0;
+
+       for (cp = acs_chars; cp[0] && cp[1]; cp += 2) {
+           if (ChCharOf(UChar(cp[1])) == ChCharOf(ch)) {
                found = cp;
                /* don't exit from loop - there may be redefinitions */
            }
        }
 
-       if (found != 0)
-       {
-           ch = TextOf(*found);
-           for (sp = names; sp->val; sp++)
-               if (sp->val == ch)
-               {
-                   (void) strcat(buf, sp->name);
-                   ch &= ~A_ALTCHARSET;
+       if (found != 0) {
+           size_t n;
+
+           ch = ChCharOf(UChar(*found));
+           for (n = 0; n < SIZEOF(names); ++n) {
+               if (names[n].val == ch) {
+                   result = names[n].name;
                    break;
                }
+           }
        }
     }
+    return result;
+}
+
+NCURSES_EXPORT(char *)
+_tracechtype2(int bufnum, chtype ch)
+{
+    char *result = _nc_trace_buf(bufnum, (size_t) BUFSIZ);
+
+    if (result != 0) {
+       const char *found;
+       attr_t attr = ChAttrOf(ch);
+
+       _nc_STRCPY(result, l_brace, TRACE_BUF_SIZE(bufnum));
+       if ((found = _nc_altcharset_name(attr, ch)) != 0) {
+           (void) _nc_trace_bufcat(bufnum, found);
+           attr &= ~A_ALTCHARSET;
+       } else
+           (void) _nc_trace_bufcat(bufnum,
+                                   _nc_tracechar(CURRENT_SCREEN,
+                                                 (int) ChCharOf(ch)));
+
+       if (attr != A_NORMAL) {
+           (void) _nc_trace_bufcat(bufnum, " | ");
+           (void) _nc_trace_bufcat(bufnum,
+                                   _traceattr2(bufnum + 20, attr));
+       }
+
+       result = _nc_trace_bufcat(bufnum, r_brace);
+    }
+    return result;
+}
+
+NCURSES_EXPORT(char *)
+_tracechtype(chtype ch)
+{
+    return _tracechtype2(0, ch);
+}
+
+/* Trace 'chtype' return-values */
+NCURSES_EXPORT(chtype)
+_nc_retrace_chtype(chtype code)
+{
+    T((T_RETURN("%s"), _tracechtype(code)));
+    return code;
+}
 
-    if (found == 0)
-       (void) strcat(buf, _tracechar(TextOf(ch)));
+#if USE_WIDEC_SUPPORT
+NCURSES_EXPORT(char *)
+_tracecchar_t2(int bufnum, const cchar_t *ch)
+{
+    char *result = _nc_trace_buf(bufnum, (size_t) BUFSIZ);
+
+    if (result != 0) {
+       _nc_STRCPY(result, l_brace, TRACE_BUF_SIZE(bufnum));
+       if (ch != 0) {
+           const char *found;
+           attr_t attr = AttrOfD(ch);
 
-    if (AttrOf(ch) != A_NORMAL)
-       (void) sprintf(buf + strlen(buf), " | %s", _traceattr2(bufnum+20,AttrOf(ch)));
+           if ((found = _nc_altcharset_name(attr, (chtype) CharOfD(ch))) != 0) {
+               (void) _nc_trace_bufcat(bufnum, found);
+               attr &= ~A_ALTCHARSET;
+           } else if (isWidecExt(CHDEREF(ch))) {
+               (void) _nc_trace_bufcat(bufnum, "{NAC}");
+               attr &= ~A_CHARTEXT;
+           } else {
+               PUTC_DATA;
+               int n;
 
-    strcat(buf, "}");
-    return(buf);
+               (void) _nc_trace_bufcat(bufnum, "{ ");
+               for (PUTC_i = 0; PUTC_i < CCHARW_MAX; ++PUTC_i) {
+                   PUTC_ch = ch->chars[PUTC_i];
+                   if (PUTC_ch == L'\0') {
+                       if (PUTC_i == 0)
+                           (void) _nc_trace_bufcat(bufnum, "\\000");
+                       break;
+                   }
+                   PUTC_INIT;
+                   PUTC_n = (int) wcrtomb(PUTC_buf, ch->chars[PUTC_i], &PUT_st);
+                   if (PUTC_n <= 0) {
+                       if (PUTC_ch != L'\0') {
+                           /* it could not be a multibyte sequence */
+                           (void) _nc_trace_bufcat(bufnum,
+                                                   _nc_tracechar(CURRENT_SCREEN,
+                                                                 UChar(ch->chars[PUTC_i])));
+                       }
+                       break;
+                   } else if (ch->chars[PUTC_i] > 255) {
+                       char temp[80];
+                       _nc_SPRINTF(temp, _nc_SLIMIT(sizeof(temp))
+                                   "{%d:\\u%lx}",
+                                   wcwidth(ch->chars[PUTC_i]),
+                                   (unsigned long) ch->chars[PUTC_i]);
+                       (void) _nc_trace_bufcat(bufnum, temp);
+                       break;
+                   }
+                   for (n = 0; n < PUTC_n; n++) {
+                       if (n)
+                           (void) _nc_trace_bufcat(bufnum, ", ");
+                       (void) _nc_trace_bufcat(bufnum,
+                                               _nc_tracechar(CURRENT_SCREEN,
+                                                             UChar(PUTC_buf[n])));
+                   }
+               }
+               (void) _nc_trace_bufcat(bufnum, " }");
+           }
+           if (attr != A_NORMAL) {
+               (void) _nc_trace_bufcat(bufnum, " | ");
+               (void) _nc_trace_bufcat(bufnum, _traceattr2(bufnum + 20, attr));
+           }
+#if NCURSES_EXT_COLORS
+           /*
+            * Just in case the extended color is different from the chtype
+            * value, trace both.
+            */
+           if (ch->ext_color != PairNumber(attr)) {
+               char temp[80];
+               _nc_SPRINTF(temp, _nc_SLIMIT(sizeof(temp))
+                           " X_COLOR{%d:%d}", ch->ext_color, PairNumber(attr));
+               (void) _nc_trace_bufcat(bufnum, temp);
+           }
+#endif
+       }
+
+       result = _nc_trace_bufcat(bufnum, r_brace);
+    }
+    return result;
 }
 
-char *_tracechtype(chtype ch)
+NCURSES_EXPORT(char *)
+_tracecchar_t(const cchar_t *ch)
 {
-       return _tracechtype2(0, ch);
+    return _tracecchar_t2(0, ch);
 }
+#endif
+
 #else
-extern void _nc_lib_traceatr(void);
-       void _nc_lib_traceatr(void) { }
+EMPTY_MODULE(_nc_lib_traceatr)
 #endif /* TRACE */