]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - progs/dump_entry.c
ncurses 6.0 - patch 20161008
[ncurses.git] / progs / dump_entry.c
index 56610e9db2b0decc4488f96c4d4b3ce027cdbe97..87e3ce332fa0c9d51fefa56a4032e45f2c705560 100644 (file)
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright (c) 1998-2011,2012 Free Software Foundation, Inc.              *
+ * Copyright (c) 1998-2015,2016 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            *
 #include "termsort.c"          /* this C file is generated */
 #include <parametrized.h>      /* so is this */
 
-MODULE_ID("$Id: dump_entry.c,v 1.102 2012/12/15 18:25:56 tom Exp $")
+MODULE_ID("$Id: dump_entry.c,v 1.143 2016/10/09 01:30:14 tom Exp $")
 
-#define INDENT                 8
 #define DISCARD(string) string = ABSENT_STRING
 #define PRINTF (void) printf
 
 #define OkIndex(index,array) ((int)(index) >= 0 && (int)(index) < (int) SIZEOF(array))
+#define TcOutput() (outform == F_TERMCAP || outform == F_TCONVERR)
 
 typedef struct {
     char *text;
@@ -61,6 +61,9 @@ static int height = 65535;    /* max number of lines for listings */
 static int column;             /* current column, limited by 'width' */
 static int oldcol;             /* last value of column before wrap */
 static bool pretty;            /* true if we format if-then-else strings */
+static bool wrapped;           /* true if we wrap too-long strings */
+static bool checking;          /* true if we are checking for tic */
+static int quickdump;          /* true if we are dumping compiled data */
 
 static char *save_sgr;
 
@@ -73,7 +76,8 @@ static NCURSES_CONST char *const *bool_names;
 static NCURSES_CONST char *const *num_names;
 static NCURSES_CONST char *const *str_names;
 
-static const char *separator, *trailer;
+static const char *separator = "", *trailer = "";
+static int indent = 8;
 
 /* cover various ports and variants of terminfo */
 #define V_ALLCAPS      0       /* all capabilities (SVr4, XSI, ncurses) */
@@ -119,7 +123,7 @@ strncpy_DYN(DYNBUF * dst, const char *src, size_t need)
        if (dst->text == 0)
            failed("strncpy_DYN");
     }
-    (void) strncpy(dst->text + dst->used, src, need);
+    _nc_STRNCPY(dst->text + dst->used, src, need + 1);
     dst->used += need;
     dst->text[dst->used] = 0;
 }
@@ -155,17 +159,17 @@ _nc_leaks_dump_entry(void)
 #endif
 
 #define NameTrans(check,result) \
-           if (OkIndex(np->nte_index, check) \
+           if ((np->nte_index <= OK_ ## check) \
                && check[np->nte_index]) \
                return (result[np->nte_index])
 
 NCURSES_CONST char *
 nametrans(const char *name)
-/* translate a capability name from termcap to terminfo */
+/* translate a capability name to termcap from terminfo */
 {
     const struct name_table_entry *np;
 
-    if ((np = _nc_find_entry(name, _nc_get_hash_table(0))) != 0)
+    if ((np = _nc_find_entry(name, _nc_get_hash_table(0))) != 0) {
        switch (np->nte_type) {
        case BOOLEAN:
            NameTrans(bool_from_termcap, boolcodes);
@@ -179,6 +183,7 @@ nametrans(const char *name)
            NameTrans(str_from_termcap, strcodes);
            break;
        }
+    }
 
     return (0);
 }
@@ -187,15 +192,21 @@ void
 dump_init(const char *version,
          int mode,
          int sort,
+         bool wrap_strings,
          int twidth,
          int theight,
          unsigned traceval,
-         bool formatted)
+         bool formatted,
+         bool check,
+         int quick)
 /* set up for entry display */
 {
     width = twidth;
     height = theight;
     pretty = formatted;
+    wrapped = wrap_strings;
+    checking = check;
+    quickdump = (quick & 3);
 
     /* versions */
     if (version == 0)
@@ -240,6 +251,7 @@ dump_init(const char *version,
        trailer = "\\\n\t:";
        break;
     }
+    indent = 8;
 
     /* implement sort modes */
     switch (sortmode = sort) {
@@ -309,7 +321,11 @@ dump_predicate(PredType type, PredIdx idx)
 static void set_obsolete_termcaps(TERMTYPE *tp);
 
 /* is this the index of a function key string? */
-#define FNKEY(i)       (((i)<= 65 && (i)>= 75) || ((i)<= 216 && (i)>= 268))
+#define FNKEY(i) \
+    (((i) >= STR_IDX(key_f0) && \
+      (i) <= STR_IDX(key_f9)) || \
+     ((i) >= STR_IDX(key_f11) && \
+      (i) <= STR_IDX(key_f63)))
 
 /*
  * If we configure with a different Caps file, the offsets into the arrays
@@ -405,22 +421,201 @@ force_wrap(void)
     oldcol = column;
     trim_trailing();
     strcpy_DYN(&outbuf, trailer);
-    column = INDENT;
+    column = indent;
+}
+
+static int
+op_length(const char *src, int offset)
+{
+    int result = 0;
+    int ch;
+    if (offset > 0 && src[offset - 1] == '\\') {
+       result = 0;
+    } else {
+       result++;               /* for '%' mark */
+       ch = src[offset + result];
+       if (TcOutput()) {
+           if (ch == '>') {
+               result += 3;
+           } else if (ch == '+') {
+               result += 2;
+           } else {
+               result++;
+           }
+       } else if (ch == '\'') {
+           result += 3;
+       } else if (ch == L_CURL[0]) {
+           int n = result;
+           while ((ch = src[offset + n]) != '\0') {
+               if (ch == R_CURL[0]) {
+                   result = ++n;
+                   break;
+               }
+               n++;
+           }
+       } else if (strchr("pPg", ch) != 0) {
+           result += 2;
+       } else {
+           result++;           /* ordinary operator */
+       }
+    }
+    return result;
+}
+
+/*
+ * When wrapping too-long strings, avoid splitting a backslash sequence, or
+ * a terminfo '%' operator.  That will leave things a little ragged, but avoids
+ * a stray backslash at the end of the line, as well as making the result a
+ * little more readable.
+ */
+static int
+find_split(const char *src, int step, int size)
+{
+    int result = size;
+    int n;
+    if (size > 0) {
+       /* check if that would split a backslash-sequence */
+       int mark = size;
+       for (n = size - 1; n > 0; --n) {
+           int ch = UChar(src[step + n]);
+           if (ch == '\\') {
+               if (n > 0 && src[step + n - 1] == ch)
+                   --n;
+               mark = n;
+               break;
+           } else if (!isalnum(ch)) {
+               break;
+           }
+       }
+       if (mark < size) {
+           result = mark;
+       } else {
+           /* check if that would split a backslash-sequence */
+           for (n = size - 1; n > 0; --n) {
+               int ch = UChar(src[step + n]);
+               if (ch == '%') {
+                   int need = op_length(src, step + n);
+                   if ((n + need) > size)
+                       mark = n;
+                   break;
+               }
+           }
+           if (mark < size) {
+               result = mark;
+           }
+       }
+    }
+    return result;
+}
+
+/*
+ * If we are going to wrap lines, we cannot leave literal spaces because that
+ * would be ambiguous if we split on that space.
+ */
+static char *
+fill_spaces(const char *src)
+{
+    const char *fill = "\\s";
+    size_t need = strlen(src);
+    size_t size = strlen(fill);
+    char *result = 0;
+    int pass;
+    int s, d;
+    for (pass = 0; pass < 2; ++pass) {
+       for (s = d = 0; src[s] != '\0'; ++s) {
+           if (src[s] == ' ') {
+               if (pass) {
+                   strcpy(&result[d], fill);
+                   d += (int) size;
+               } else {
+                   need += size;
+               }
+           } else {
+               if (pass) {
+                   result[d++] = src[s];
+               } else {
+                   ++d;
+               }
+           }
+       }
+       if (pass) {
+           result[d] = '\0';
+       } else {
+           result = malloc(need + 1);
+           if (result == 0)
+               failed("fill_spaces");
+       }
+    }
+    return result;
 }
 
 static void
 wrap_concat(const char *src)
 {
-    size_t need = strlen(src);
-    size_t want = strlen(separator) + need;
+    int need = (int) strlen(src);
+    int gaps = (int) strlen(separator);
+    int want = gaps + need;
 
-    if (column > INDENT
-       && column + (int) want > width) {
+    if (column > indent
+       && column + want > width) {
+       force_wrap();
+    }
+    if (wrapped &&
+       (width >= 0) &&
+       (column + want) > width &&
+       (!TcOutput() || strncmp(src, "..", 2))) {
+       int step = 0;
+       int used = width > 32 ? width : 32;
+       int size = used;
+       int base = 0;
+       char *p, align[9];
+       const char *my_t = trailer;
+       char *fill = fill_spaces(src);
+
+       need = (int) strlen(fill);
+
+       if (TcOutput())
+           trailer = "\\\n\t ";
+
+       if ((p = strchr(fill, '=')) != 0) {
+           base = (int) (p + 1 - fill);
+           if (base > 8)
+               base = 8;
+           _nc_SPRINTF(align, _nc_SLIMIT(align) "%*s", base, " ");
+       } else {
+           align[base] = '\0';
+       }
+       while ((column + (need + gaps)) > used) {
+           size = used;
+           if (size > ((int) strlen(fill) - step)) {
+               size = ((int) strlen(fill) - step);
+           }
+           if (step) {
+               strcpy_DYN(&outbuf, align);
+               size -= base;
+           }
+           size = find_split(fill, step, size);
+           strncpy_DYN(&outbuf, fill + step, (size_t) size);
+           step += size;
+           need -= size;
+           if (need > 0)
+               force_wrap();
+       }
+       if (need > 0) {
+           if (step)
+               strcpy_DYN(&outbuf, align);
+           strcpy_DYN(&outbuf, fill + step);
+       }
+       strcpy_DYN(&outbuf, separator);
+       trailer = my_t;
        force_wrap();
+
+       free(fill);
+    } else {
+       strcpy_DYN(&outbuf, src);
+       strcpy_DYN(&outbuf, separator);
+       column += need;
     }
-    strcpy_DYN(&outbuf, src);
-    strcpy_DYN(&outbuf, separator);
-    column += (int) need;
 }
 
 #define IGNORE_SEP_TRAIL(first,last,sep_trail) \
@@ -463,10 +658,10 @@ indent_DYN(DYNBUF * buffer, int level)
     int n;
 
     for (n = 0; n < level; n++)
-       strncpy_DYN(buffer, "\t", 1);
+       strncpy_DYN(buffer, "\t", (size_t) 1);
 }
 
-static bool
+bool
 has_params(const char *src)
 {
     bool result = FALSE;
@@ -476,9 +671,9 @@ has_params(const char *src)
     bool params = FALSE;
 
     for (n = 0; n < len - 1; ++n) {
-       if (!strncmp(src + n, "%p", 2)) {
+       if (!strncmp(src + n, "%p", (size_t) 2)) {
            params = TRUE;
-       } else if (!strncmp(src + n, "%;", 2)) {
+       } else if (!strncmp(src + n, "%;", (size_t) 2)) {
            ifthen = TRUE;
            result = params;
            break;
@@ -491,16 +686,20 @@ has_params(const char *src)
 }
 
 static char *
-fmt_complex(char *src, int level)
+fmt_complex(TERMTYPE *tterm, const char *capability, char *src, int level)
 {
     bool percent = FALSE;
     bool params = has_params(src);
 
     while (*src != '\0') {
        switch (*src) {
+       case '^':
+           percent = FALSE;
+           strncpy_DYN(&tmpbuf, src++, (size_t) 1);
+           break;
        case '\\':
            percent = FALSE;
-           strncpy_DYN(&tmpbuf, src++, 1);
+           strncpy_DYN(&tmpbuf, src++, (size_t) 1);
            break;
        case '%':
            percent = TRUE;
@@ -514,26 +713,29 @@ fmt_complex(char *src, int level)
                /* treat a "%e" as else-if, on the same level */
                if (*src == 'e') {
                    indent_DYN(&tmpbuf, level);
-                   strncpy_DYN(&tmpbuf, "%", 1);
-                   strncpy_DYN(&tmpbuf, src, 1);
+                   strncpy_DYN(&tmpbuf, "%", (size_t) 1);
+                   strncpy_DYN(&tmpbuf, src, (size_t) 1);
                    src++;
                    params = has_params(src);
                    if (!params && *src != '\0' && *src != '%') {
-                       strncpy_DYN(&tmpbuf, "\n", 1);
+                       strncpy_DYN(&tmpbuf, "\n", (size_t) 1);
                        indent_DYN(&tmpbuf, level + 1);
                    }
                } else {
                    indent_DYN(&tmpbuf, level + 1);
-                   strncpy_DYN(&tmpbuf, "%", 1);
-                   strncpy_DYN(&tmpbuf, src, 1);
+                   strncpy_DYN(&tmpbuf, "%", (size_t) 1);
+                   strncpy_DYN(&tmpbuf, src, (size_t) 1);
                    if (*src++ == '?') {
-                       src = fmt_complex(src, level + 1);
+                       src = fmt_complex(tterm, capability, src, level + 1);
                        if (*src != '\0' && *src != '%') {
-                           strncpy_DYN(&tmpbuf, "\n", 1);
+                           strncpy_DYN(&tmpbuf, "\n", (size_t) 1);
                            indent_DYN(&tmpbuf, level + 1);
                        }
                    } else if (level == 1) {
-                       _nc_warning("%%%c without %%?", *src);
+                       if (checking)
+                           _nc_warning("%s: %%%c without %%? in %s",
+                                       _nc_first_name(tterm->term_names),
+                                       *src, capability);
                    }
                }
                continue;
@@ -545,31 +747,40 @@ fmt_complex(char *src, int level)
                if (level > 1) {
                    tmpbuf.text[tmpbuf.used - 1] = '\n';
                    indent_DYN(&tmpbuf, level);
-                   strncpy_DYN(&tmpbuf, "%", 1);
-                   strncpy_DYN(&tmpbuf, src++, 1);
+                   strncpy_DYN(&tmpbuf, "%", (size_t) 1);
+                   strncpy_DYN(&tmpbuf, src++, (size_t) 1);
+                   if (src[0] == '%'
+                       && src[1] != '\0'
+                       && (strchr("?e;", src[1])) == 0) {
+                       tmpbuf.text[tmpbuf.used++] = '\n';
+                       indent_DYN(&tmpbuf, level);
+                   }
                    return src;
                }
-               _nc_warning("%%; without %%?");
+               if (checking)
+                   _nc_warning("%s: %%; without %%? in %s",
+                               _nc_first_name(tterm->term_names),
+                               capability);
            }
            break;
        case 'p':
            if (percent && params) {
                tmpbuf.text[tmpbuf.used - 1] = '\n';
                indent_DYN(&tmpbuf, level + 1);
-               strncpy_DYN(&tmpbuf, "%", 1);
+               strncpy_DYN(&tmpbuf, "%", (size_t) 1);
            }
            params = FALSE;
            percent = FALSE;
            break;
        case ' ':
-           strncpy_DYN(&tmpbuf, "\\s", 2);
+           strncpy_DYN(&tmpbuf, "\\s", (size_t) 2);
            ++src;
            continue;
        default:
            percent = FALSE;
            break;
        }
-       strncpy_DYN(&tmpbuf, src++, 1);
+       strncpy_DYN(&tmpbuf, src++, (size_t) 1);
     }
     return src;
 }
@@ -580,9 +791,9 @@ fmt_complex(char *src, int level)
 int
 fmt_entry(TERMTYPE *tterm,
          PredFunc pred,
-         bool content_only,
-         bool suppress_untranslatable,
-         bool infodump,
+         int content_only,
+         int suppress_untranslatable,
+         int infodump,
          int numbers)
 {
     PredIdx i, j;
@@ -608,7 +819,7 @@ fmt_entry(TERMTYPE *tterm,
 
     strcpy_DYN(&outbuf, 0);
     if (content_only) {
-       column = INDENT;        /* FIXME: workaround to prevent empty lines */
+       column = indent;        /* FIXME: workaround to prevent empty lines */
     } else {
        strcpy_DYN(&outbuf, tterm->term_names);
 
@@ -651,7 +862,7 @@ fmt_entry(TERMTYPE *tterm,
        }
     }
 
-    if (column != INDENT && height > 1)
+    if (column != indent && height > 1)
        force_wrap();
 
     for_each_number(j, tterm) {
@@ -679,7 +890,7 @@ fmt_entry(TERMTYPE *tterm,
        }
     }
 
-    if (column != INDENT && height > 1)
+    if (column != indent && height > 1)
        force_wrap();
 
     len += (int) (num_bools
@@ -758,6 +969,10 @@ fmt_entry(TERMTYPE *tterm,
                    trimmed_sgr0 = _nc_trim_sgr0(tterm);
                    if (strcmp(capability, trimmed_sgr0))
                        capability = trimmed_sgr0;
+                   else {
+                       if (trimmed_sgr0 != exit_attribute_mode)
+                           free(trimmed_sgr0);
+                   }
 
                    set_attributes = my_sgr;
                }
@@ -776,11 +991,14 @@ fmt_entry(TERMTYPE *tterm,
                _nc_SPRINTF(buffer, _nc_SLIMIT(sizeof(buffer))
                            "%s@", name);
                WRAP_CONCAT;
-           } else if (outform == F_TERMCAP || outform == F_TCONVERR) {
-               int params = ((i < (int) SIZEOF(parametrized))
-                             ? parametrized[i]
-                             : 0);
+           } else if (TcOutput()) {
                char *srccap = _nc_tic_expand(capability, TRUE, numbers);
+               int params = (((i < (int) SIZEOF(parametrized)) &&
+                              (i < STRCOUNT))
+                             ? parametrized[i]
+                             : ((*srccap == 'k')
+                                ? 0
+                                : has_params(srccap)));
                char *cv = _nc_infotocap(name, srccap, params);
 
                if (cv == 0) {
@@ -820,7 +1038,7 @@ fmt_entry(TERMTYPE *tterm,
                if (pretty
                    && (outform == F_TERMINFO
                        || outform == F_VARIABLE)) {
-                   fmt_complex(src, 1);
+                   fmt_complex(tterm, name, src, 1);
                } else {
                    strcpy_DYN(&tmpbuf, src);
                }
@@ -862,7 +1080,7 @@ fmt_entry(TERMTYPE *tterm,
 
            tp = boxchars;
            for (cp = acstrans; *cp; cp++) {
-               sp = strchr(acs_chars, *cp);
+               sp = (strchr) (acs_chars, *cp);
                if (sp)
                    *tp++ = sp[1];
                else {
@@ -873,11 +1091,41 @@ fmt_entry(TERMTYPE *tterm,
            tp[0] = '\0';
 
            if (box_ok) {
+               char *tmp = _nc_tic_expand(boxchars,
+                                          (outform == F_TERMINFO),
+                                          numbers);
                _nc_STRCPY(buffer, "box1=", sizeof(buffer));
-               _nc_STRCAT(buffer,
-                          _nc_tic_expand(boxchars,
-                                         outform == F_TERMINFO, numbers),
-                          sizeof(buffer));
+               while (*tmp != '\0') {
+                   size_t have = strlen(buffer);
+                   size_t next = strlen(tmp);
+                   size_t want = have + next + 1;
+                   size_t last = next;
+                   char save = '\0';
+
+                   /*
+                    * If the expanded string is too long for the buffer,
+                    * chop it off and save the location where we chopped it.
+                    */
+                   if (want >= sizeof(buffer)) {
+                       save = tmp[last];
+                       tmp[last] = '\0';
+                   }
+                   _nc_STRCAT(buffer, tmp, sizeof(buffer));
+
+                   /*
+                    * If we chopped the buffer, replace the missing piece and
+                    * shift everything to append the remainder.
+                    */
+                   if (save != '\0') {
+                       next = 0;
+                       tmp[last] = save;
+                       while ((tmp[next] = tmp[last + next]) != '\0') {
+                           ++next;
+                       }
+                   } else {
+                       break;
+                   }
+               }
                WRAP_CONCAT;
            }
        }
@@ -1055,13 +1303,41 @@ purged_acs(TERMTYPE *tterm)
     return result;
 }
 
+static void
+encode_b64(char *target, char *source, unsigned state, int *saved)
+{
+    /* RFC-4648 */
+    static const char data[] =
+    "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
+    "abcdefghijklmnopqrstuvwxyz"
+    "0123456789" "-_";
+    int ch = UChar(source[state]);
+
+    switch (state % 3) {
+    case 0:
+       *target++ = data[ch & 077];
+       *saved = (ch >> 6) & 3;
+       break;
+    case 1:
+       *target++ = data[((ch << 2) | *saved) & 077];
+       *saved = (ch >> 4) & 017;
+       break;
+    case 2:
+       *target++ = data[((ch << 4) | *saved) & 077];
+       *target++ = data[(ch >> 2) & 077];
+       *saved = 0;
+       break;
+    }
+    *target = '\0';
+}
+
 /*
  * Dump a single entry.
  */
 void
 dump_entry(TERMTYPE *tterm,
-          bool suppress_untranslatable,
-          bool limited,
+          int suppress_untranslatable,
+          int limited,
           int numbers,
           PredFunc pred)
 {
@@ -1070,7 +1346,50 @@ dump_entry(TERMTYPE *tterm,
     const char *legend;
     bool infodump;
 
-    if (outform == F_TERMCAP || outform == F_TCONVERR) {
+    if (quickdump) {
+       char bigbuf[65536];
+       unsigned n;
+       unsigned offset = 0;
+       separator = "";
+       trailer = "\n";
+       indent = 0;
+       if (_nc_write_object(tterm, bigbuf, &offset, sizeof(bigbuf)) == OK) {
+           char numbuf[80];
+           if (quickdump & 1) {
+               if (outbuf.used)
+                   wrap_concat("\n");
+               wrap_concat("hex:");
+               for (n = 0; n < offset; ++n) {
+                   _nc_SPRINTF(numbuf, _nc_SLIMIT(sizeof(numbuf))
+                               "%02X", UChar(bigbuf[n]));
+                   wrap_concat(numbuf);
+               }
+           }
+           if (quickdump & 2) {
+               int value = 0;
+               if (outbuf.used)
+                   wrap_concat("\n");
+               wrap_concat("b64:");
+               for (n = 0; n < offset; ++n) {
+                   encode_b64(numbuf, bigbuf, n, &value);
+                   wrap_concat(numbuf);
+               }
+               switch (n % 3) {
+               case 0:
+                   break;
+               case 1:
+                   wrap_concat("===");
+                   break;
+               case 2:
+                   wrap_concat("==");
+                   break;
+               }
+           }
+       }
+       return;
+    }
+
+    if (TcOutput()) {
        critlen = MAX_TERMCAP_LENGTH;
        legend = "older termcap";
        infodump = FALSE;
@@ -1185,7 +1504,7 @@ dump_uses(const char *name, bool infodump)
 {
     char buffer[MAX_TERMINFO_LENGTH];
 
-    if (outform == F_TERMCAP || outform == F_TCONVERR)
+    if (TcOutput())
        trim_trailing();
     _nc_SPRINTF(buffer, _nc_SLIMIT(sizeof(buffer))
                "%s%s", infodump ? "use=" : "tc=", name);
@@ -1199,7 +1518,7 @@ show_entry(void)
      * Trim any remaining whitespace.
      */
     if (outbuf.used != 0) {
-       bool infodump = (outform != F_TERMCAP && outform != F_TCONVERR);
+       bool infodump = !TcOutput();
        char delim = (char) (infodump ? ',' : ':');
        int j;
 
@@ -1219,8 +1538,10 @@ show_entry(void)
        }
        outbuf.text[outbuf.used] = '\0';
     }
-    (void) fputs(outbuf.text, stdout);
-    putchar('\n');
+    if (outbuf.text != 0) {
+       (void) fputs(outbuf.text, stdout);
+       putchar('\n');
+    }
     return (int) outbuf.used;
 }