]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - progs/tic.c
ncurses 6.0 - patch 20160611
[ncurses.git] / progs / tic.c
index 2781bae760b13c3a219e99d43d0096655a09ef25..9f446f5c76233c1cd3b4ab49781e8828eeec30dc 100644 (file)
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright (c) 1998-2013,2014 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            *
@@ -48,7 +48,7 @@
 #include <parametrized.h>
 #include <transform.h>
 
-MODULE_ID("$Id: tic.c,v 1.204 2014/05/24 15:47:40 tom Exp $")
+MODULE_ID("$Id: tic.c,v 1.222 2016/06/11 23:20:55 tom Exp $")
 
 #define STDIN_NAME "<stdin>"
 
@@ -138,50 +138,51 @@ failed(const char *msg)
 static void
 usage(void)
 {
-    static const char *const tbl[] =
+#define DATA(s) s "\n"
+    static const char options_string[] =
     {
-       "Options:",
-       "  -1         format translation output one capability per line",
+       DATA("Options:")
+       DATA("  -0         format translation output all capabilities on one line")
+       DATA("  -1         format translation output one capability per line")
 #if NCURSES_XNAMES
-       "  -a         retain commented-out capabilities (sets -x also)",
+       DATA("  -a         retain commented-out capabilities (sets -x also)")
 #endif
-       "  -C         translate entries to termcap source form",
-       "  -D         print list of tic's database locations (first must be writable)",
-       "  -c         check only, validate input without compiling or translating",
-       "  -e<names>  translate/compile only entries named by comma-separated list",
-       "  -f         format complex strings for readability",
-       "  -G         format %{number} to %'char'",
-       "  -g         format %'char' to %{number}",
-       "  -I         translate entries to terminfo source form",
-       "  -K         translate entries to termcap source form with BSD syntax",
-       "  -L         translate entries to full terminfo source form",
-       "  -N         disable smart defaults for source translation",
-       "  -o<dir>    set output directory for compiled entry writes",
-       "  -R<name>   restrict translation to given terminfo/termcap version",
-       "  -r         force resolution of all use entries in source translation",
-       "  -s         print summary statistics",
-       "  -T         remove size-restrictions on compiled description",
+       DATA("  -C         translate entries to termcap source form")
+       DATA("  -D         print list of tic's database locations (first must be writable)")
+       DATA("  -c         check only, validate input without compiling or translating")
+       DATA("  -e<names>  translate/compile only entries named by comma-separated list")
+       DATA("  -f         format complex strings for readability")
+       DATA("  -G         format %{number} to %'char'")
+       DATA("  -g         format %'char' to %{number}")
+       DATA("  -I         translate entries to terminfo source form")
+       DATA("  -K         translate entries to termcap source form with BSD syntax")
+       DATA("  -L         translate entries to full terminfo source form")
+       DATA("  -N         disable smart defaults for source translation")
+       DATA("  -o<dir>    set output directory for compiled entry writes")
+       DATA("  -Q[n]      dump compiled description")
+       DATA("  -q    brief listing, removes headers")
+       DATA("  -R<name>   restrict translation to given terminfo/termcap version")
+       DATA("  -r         force resolution of all use entries in source translation")
+       DATA("  -s         print summary statistics")
+       DATA("  -T         remove size-restrictions on compiled description")
 #if NCURSES_XNAMES
-       "  -t         suppress commented-out capabilities",
+       DATA("  -t         suppress commented-out capabilities")
 #endif
-       "  -U         suppress post-processing of entries",
-       "  -V         print version",
-       "  -v[n]      set verbosity level",
-       "  -w[n]      set format width for translation output",
+       DATA("  -U         suppress post-processing of entries")
+       DATA("  -V         print version")
+       DATA("  -v[n]      set verbosity level")
+       DATA("  -w[n]      set format width for translation output")
 #if NCURSES_XNAMES
-       "  -x         treat unknown capabilities as user-defined",
+       DATA("  -x         treat unknown capabilities as user-defined")
 #endif
-       "",
-       "Parameters:",
-       "  <file>     file to translate or compile"
+       DATA("")
+       DATA("Parameters:")
+       DATA("  <file>     file to translate or compile")
     };
-    size_t j;
+#undef DATA
 
     fprintf(stderr, "Usage: %s %s\n", _nc_progname, usage_string);
-    for (j = 0; j < SIZEOF(tbl); j++) {
-       fputs(tbl[j], stderr);
-       putc('\n', stderr);
-    }
+    fputs(options_string, stderr);
     ExitProgram(EXIT_FAILURE);
 }
 
@@ -661,6 +662,12 @@ show_databases(const char *outdir)
     }
 }
 
+static void
+add_digit(int *target, int source)
+{
+    *target = (*target * 10) + (source - '0');
+}
+
 #define VtoTrace(opt) (unsigned) ((opt > 0) ? opt : (opt == 0))
 
 int
@@ -691,6 +698,8 @@ main(int argc, char *argv[])
     char *outdir = (char *) NULL;
     bool check_only = FALSE;
     bool suppress_untranslatable = FALSE;
+    int quickdump = 0;
+    bool quiet = FALSE;
 
     log_fp = stderr;
 
@@ -716,14 +725,17 @@ main(int argc, char *argv[])
      * be optional.
      */
     while ((this_opt = getopt(argc, argv,
-                             "0123456789CDIKLNR:TUVace:fGgo:rstvwx")) != -1) {
+                             "0123456789CDIKLNQR:TUVace:fGgo:qrstvwx")) != -1) {
        if (isdigit(this_opt)) {
            switch (last_opt) {
+           case 'Q':
+               add_digit(&quickdump, this_opt);
+               break;
            case 'v':
-               v_opt = (v_opt * 10) + (this_opt - '0');
+               add_digit(&v_opt, this_opt);
                break;
            case 'w':
-               width = (width * 10) + (this_opt - '0');
+               add_digit(&width, this_opt);
                break;
            default:
                switch (this_opt) {
@@ -774,6 +786,9 @@ main(int argc, char *argv[])
            smart_defaults = FALSE;
            literal = TRUE;
            break;
+       case 'Q':
+           quickdump = 0;
+           break;
        case 'R':
            tversion = optarg;
            break;
@@ -804,6 +819,9 @@ main(int argc, char *argv[])
        case 'o':
            outdir = optarg;
            break;
+       case 'q':
+           quiet = TRUE;
+           break;
        case 'r':
            forceresolve = TRUE;
            break;
@@ -909,16 +927,17 @@ main(int argc, char *argv[])
        }
     }
 
-    if (infodump) {
+    if (infodump || check_only) {
        dump_init(tversion,
                  smart_defaults
                  ? outform
                  : F_LITERAL,
-                 sortmode, width, height, debug_level, formatted);
+                 sortmode, width, height, debug_level, formatted ||
+                 check_only, check_only, quickdump);
     } else if (capdump) {
        dump_init(tversion,
                  outform,
-                 sortmode, width, height, debug_level, FALSE);
+                 sortmode, width, height, debug_level, FALSE, FALSE, FALSE);
     }
 
     /* parse entries out of the source file */
@@ -956,7 +975,21 @@ main(int argc, char *argv[])
     }
 
     /* write or dump all entries */
-    if (!check_only) {
+    if (check_only) {
+       /* this is in case infotocap() generates warnings */
+       _nc_curr_col = _nc_curr_line = -1;
+
+       for_entry_list(qp) {
+           if (matches(namelst, qp->tterm.term_names)) {
+               /* this is in case infotocap() generates warnings */
+               _nc_set_type(_nc_first_name(qp->tterm.term_names));
+               _nc_curr_line = (int) qp->startline;
+               repair_acsc(&qp->tterm);
+               dump_entry(&qp->tterm, suppress_untranslatable,
+                          limited, numbers, NULL);
+           }
+       }
+    } else {
        if (!infodump && !capdump) {
            _nc_set_writedir(outdir);
            for_entry_list(qp) {
@@ -975,12 +1008,14 @@ main(int argc, char *argv[])
                    /* this is in case infotocap() generates warnings */
                    _nc_set_type(_nc_first_name(qp->tterm.term_names));
 
-                   (void) fseek(tmp_fp, qp->cstart, SEEK_SET);
-                   while (j-- > 0) {
-                       if (infodump)
-                           (void) putchar(fgetc(tmp_fp));
-                       else
-                           put_translate(fgetc(tmp_fp));
+                   if (!quiet) {
+                       (void) fseek(tmp_fp, qp->cstart, SEEK_SET);
+                       while (j-- > 0) {
+                           if (infodump)
+                               (void) putchar(fgetc(tmp_fp));
+                           else
+                               put_translate(fgetc(tmp_fp));
+                       }
                    }
 
                    repair_acsc(&qp->tterm);
@@ -993,7 +1028,7 @@ main(int argc, char *argv[])
                        printf("# length=%d\n", len);
                }
            }
-           if (!namelst && _nc_tail) {
+           if (!namelst && _nc_tail && !quiet) {
                int c, oldc = '\0';
                bool in_comment = FALSE;
                bool trailing_comment = FALSE;
@@ -1580,78 +1615,81 @@ check_screen(TERMTYPE *tp)
 static int
 expected_params(const char *name)
 {
+#define DATA(name,count) { { name }, count }
     /* *INDENT-OFF* */
     static const struct {
-       const char *name;
+       const char name[9];
        int count;
     } table[] = {
-       { "S0",                 1 },    /* 'screen' extension */
-       { "birep",              2 },
-       { "chr",                1 },
-       { "colornm",            1 },
-       { "cpi",                1 },
-       { "csnm",               1 },
-       { "csr",                2 },
-       { "cub",                1 },
-       { "cud",                1 },
-       { "cuf",                1 },
-       { "cup",                2 },
-       { "cuu",                1 },
-       { "cvr",                1 },
-       { "cwin",               5 },
-       { "dch",                1 },
-       { "defc",               3 },
-       { "dial",               1 },
-       { "dispc",              1 },
-       { "dl",                 1 },
-       { "ech",                1 },
-       { "getm",               1 },
-       { "hpa",                1 },
-       { "ich",                1 },
-       { "il",                 1 },
-       { "indn",               1 },
-       { "initc",              4 },
-       { "initp",              7 },
-       { "lpi",                1 },
-       { "mc5p",               1 },
-       { "mrcup",              2 },
-       { "mvpa",               1 },
-       { "pfkey",              2 },
-       { "pfloc",              2 },
-       { "pfx",                2 },
-       { "pfxl",               3 },
-       { "pln",                2 },
-       { "qdial",              1 },
-       { "rcsd",               1 },
-       { "rep",                2 },
-       { "rin",                1 },
-       { "sclk",               3 },
-       { "scp",                1 },
-       { "scs",                1 },
-       { "scsd",               2 },
-       { "setab",              1 },
-       { "setaf",              1 },
-       { "setb",               1 },
-       { "setcolor",           1 },
-       { "setf",               1 },
-       { "sgr",                9 },
-       { "sgr1",               6 },
-       { "slength",            1 },
-       { "slines",             1 },
-       { "smgbp",              1 },    /* 2 if smgtp is not given */
-       { "smglp",              1 },
-       { "smglr",              2 },
-       { "smgrp",              1 },
-       { "smgtb",              2 },
-       { "smgtp",              1 },
-       { "tsl",                1 },
-       { "u6",                 -1 },
-       { "vpa",                1 },
-       { "wind",               4 },
-       { "wingo",              1 },
+       DATA( "S0",             1 ),    /* 'screen' extension */
+       DATA( "birep",          2 ),
+       DATA( "chr",            1 ),
+       DATA( "colornm",        1 ),
+       DATA( "cpi",            1 ),
+       DATA( "csnm",           1 ),
+       DATA( "csr",            2 ),
+       DATA( "cub",            1 ),
+       DATA( "cud",            1 ),
+       DATA( "cuf",            1 ),
+       DATA( "cup",            2 ),
+       DATA( "cuu",            1 ),
+       DATA( "cvr",            1 ),
+       DATA( "cwin",           5 ),
+       DATA( "dch",            1 ),
+       DATA( "defc",           3 ),
+       DATA( "dial",           1 ),
+       DATA( "dispc",          1 ),
+       DATA( "dl",             1 ),
+       DATA( "ech",            1 ),
+       DATA( "getm",           1 ),
+       DATA( "hpa",            1 ),
+       DATA( "ich",            1 ),
+       DATA( "il",             1 ),
+       DATA( "indn",           1 ),
+       DATA( "initc",          4 ),
+       DATA( "initp",          7 ),
+       DATA( "lpi",            1 ),
+       DATA( "mc5p",           1 ),
+       DATA( "mrcup",          2 ),
+       DATA( "mvpa",           1 ),
+       DATA( "pfkey",          2 ),
+       DATA( "pfloc",          2 ),
+       DATA( "pfx",            2 ),
+       DATA( "pfxl",           3 ),
+       DATA( "pln",            2 ),
+       DATA( "qdial",          1 ),
+       DATA( "rcsd",           1 ),
+       DATA( "rep",            2 ),
+       DATA( "rin",            1 ),
+       DATA( "sclk",           3 ),
+       DATA( "scp",            1 ),
+       DATA( "scs",            1 ),
+       DATA( "scsd",           2 ),
+       DATA( "setab",          1 ),
+       DATA( "setaf",          1 ),
+       DATA( "setb",           1 ),
+       DATA( "setcolor",       1 ),
+       DATA( "setf",           1 ),
+       DATA( "sgr",            9 ),
+       DATA( "sgr1",           6 ),
+       DATA( "slength",        1 ),
+       DATA( "slines",         1 ),
+       DATA( "smgbp",          1 ),    /* 2 if smgtp is not given */
+       DATA( "smglp",          1 ),
+       DATA( "smglr",          2 ),
+       DATA( "smgrp",          1 ),
+       DATA( "smgtb",          2 ),
+       DATA( "smgtp",          1 ),
+       DATA( "tsl",            1 ),
+       DATA( "u6",             -1 ),
+       DATA( "vpa",            1 ),
+       DATA( "wind",           4 ),
+       DATA( "wingo",          1 ),
     };
     /* *INDENT-ON* */
 
+#undef DATA
+
     unsigned n;
     int result = 0;            /* function-keys, etc., use none */
 
@@ -1809,8 +1847,6 @@ parse_delay_value(const char *src, double *delays, int *always)
 static const char *
 parse_ti_delay(const char *ti, double *delays)
 {
-    int star = 0;
-
     *delays = 0.0;
     while (*ti != '\0') {
        if (*ti == '\\') {
@@ -1827,8 +1863,6 @@ parse_ti_delay(const char *ti, double *delays)
        } else {
            ++ti;
        }
-       if (star)
-           *delays = -(*delays);
     }
     return ti;
 }
@@ -1895,20 +1929,23 @@ same_ti_tc(const char *ti, const char *tc, bool * embedded)
  * Check terminfo to termcap translation.
  */
 static void
-check_infotocap(TERMTYPE *tp, int i, char *value)
+check_infotocap(TERMTYPE *tp, int i, const char *value)
 {
     const char *name = ExtStrname(tp, i, strnames);
-    int params = ((i < (int) SIZEOF(parametrized))
+    int params = (((i < (int) SIZEOF(parametrized)) &&
+                  (i < STRCOUNT))
                  ? parametrized[i]
-                 : 0);
+                 : ((*value == 'k')
+                    ? 0
+                    : has_params(value)));
     int to_char = 0;
-    char *ti_value = _nc_tic_expand(value, TRUE, to_char);
-    char *tc_value = _nc_infotocap(name, ti_value, params);
+    char *ti_value;
+    char *tc_value;
     bool embedded;
 
-    if (ti_value == ABSENT_STRING) {
+    if ((ti_value = _nc_tic_expand(value, TRUE, to_char)) == ABSENT_STRING) {
        _nc_warning("tic-expansion of %s failed", name);
-    } else if (tc_value == ABSENT_STRING) {
+    } else if ((tc_value = _nc_infotocap(name, ti_value, params)) == ABSENT_STRING) {
        _nc_warning("tic-conversion of %s failed", name);
     } else if (params > 0) {
        int limit = 5;
@@ -1991,6 +2028,23 @@ ignore_delays(char *s)
     return s;
 }
 
+#define DATA(name) { #name }
+static const char sgr_names[][11] =
+{
+    DATA(none),
+    DATA(standout),
+    DATA(underline),
+    DATA(reverse),
+    DATA(blink),
+    DATA(dim),
+    DATA(bold),
+    DATA(invis),
+    DATA(protect),
+    DATA(altcharset),
+    ""
+};
+#undef DATA
+
 /*
  * An sgr string may contain several settings other than the one we're
  * interested in, essentially sgr0 + rmacs + whatever.  As long as the
@@ -2000,19 +2054,6 @@ ignore_delays(char *s)
 static bool
 similar_sgr(int num, char *a, char *b)
 {
-    static const char *names[] =
-    {
-       "none"
-       ,"standout"
-       ,"underline"
-       ,"reverse"
-       ,"blink"
-       ,"dim"
-       ,"bold"
-       ,"invis"
-       ,"protect"
-       ,"altcharset"
-    };
     char *base_a = a;
     char *base_b = b;
     int delaying = 0;
@@ -2020,12 +2061,14 @@ similar_sgr(int num, char *a, char *b)
     while (*b != 0) {
        while (*a != *b) {
            if (*a == 0) {
-               if (b[0] == '$'
-                   && b[1] == '<') {
+               if (num < 0) {
+                   ;
+               } else if (b[0] == '$'
+                          && b[1] == '<') {
                    _nc_warning("Did not find delay %s", _nc_visbuf(b));
                } else {
                    _nc_warning("checking sgr(%s) %s\n\tcompare to %s\n\tunmatched %s",
-                               names[num], _nc_visbuf2(1, base_a),
+                               sgr_names[num], _nc_visbuf2(1, base_a),
                                _nc_visbuf2(2, base_b),
                                _nc_visbuf2(3, b));
                }
@@ -2132,7 +2175,7 @@ get_fkey_list(TERMTYPE *tp)
     NAME_VALUE *result = typeMalloc(NAME_VALUE, NUM_STRINGS(tp) + 1);
     const struct tinfo_fkeys *all_fkeys = _nc_tinfo_fkeys;
     int used = 0;
-    int j;
+    unsigned j;
 
     if (result == 0)
        failed("get_fkey_list");
@@ -2148,7 +2191,7 @@ get_fkey_list(TERMTYPE *tp)
     }
 #if NCURSES_XNAMES
     for (j = STRCOUNT; j < NUM_STRINGS(tp); ++j) {
-       const char *name = ExtStrname(tp, j, strnames);
+       const char *name = ExtStrname(tp, (int) j, strnames);
        if (*name == 'k') {
            result[used].keycode = -1;
            result[used].name = name;
@@ -2225,6 +2268,102 @@ check_conflict(TERMTYPE *tp)
     }
 }
 
+/*
+ * Exiting a video mode should not duplicate sgr0
+ */
+static void
+check_exit_attribute(const char *name, char *test, char *trimmed, char *untrimmed)
+{
+    if (VALID_STRING(test) && (trimmed != 0)) {
+       if (similar_sgr(-1, trimmed, test) ||
+           similar_sgr(-1, untrimmed, test)) {
+           _nc_warning("%s matches exit_attribute_mode", name);
+       }
+    }
+}
+
+/*
+ * Returns true if the string looks like a standard SGR string.
+ */
+static bool
+is_sgr_string(char *value)
+{
+    bool result = FALSE;
+
+    if (VALID_STRING(value)) {
+       if (value[0] == '\033' && value[1] == '[') {
+           result = TRUE;
+           value += 2;
+       } else if (UChar(value[0]) == 0x9a) {
+           result = TRUE;
+           value += 1;
+       }
+       if (result) {
+           int ch;
+           while ((ch = UChar(*value++)) != '\0') {
+               if (isdigit(ch) || ch == ';') {
+                   ;
+               } else if (ch == 'm' && *value == '\0') {
+                   ;
+               } else {
+                   result = FALSE;
+                   break;
+               }
+           }
+       }
+    }
+    return result;
+}
+
+/*
+ * Check if the given capability contains a given SGR attribute.
+ */
+static void
+check_sgr_param(TERMTYPE *tp, int code, const char *name, char *value)
+{
+    if (VALID_STRING(value)) {
+       int ncv = ((code != 0) ? (1 << (code - 1)) : 0);
+       char *test = tgoto(value, 0, 0);
+       if (is_sgr_string(test)) {
+           int param = 0;
+           int count = 0;
+           int skips = 0;
+           int color = (value == set_a_foreground ||
+                        value == set_a_background ||
+                        value == set_foreground ||
+                        value == set_background);
+           while (*test != 0) {
+               if (isdigit(UChar(*test))) {
+                   param = 10 * param + (*test - '0');
+                   ++count;
+               } else {
+                   if (count) {
+                       /*
+                        * Avoid unnecessary warning for xterm 256color codes.
+                        */
+                       if (color && (param == 38 || param == 48))
+                           skips = 3;
+                       if ((skips-- <= 0) && (param == code))
+                           break;
+                   }
+                   count = 0;
+                   param = 0;
+               }
+               ++test;
+           }
+           if (count != 0 && param == code) {
+               if (code == 0 ||
+                   no_color_video < 0 ||
+                   !(no_color_video & ncv)) {
+                   _nc_warning("\"%s\" SGR-attribute used in %s",
+                               sgr_names[code],
+                               name);
+               }
+           }
+       }
+    }
+}
+
 /* other sanity-checks (things that we don't want in the normal
  * logic that reads a terminfo entry)
  */
@@ -2307,7 +2446,7 @@ check_termtype(TERMTYPE *tp, bool literal)
        if (_nc_syntax == SYN_TERMINFO)
            _nc_warning("missing sgr string");
     }
-
+#define CHECK_SGR0(name) check_exit_attribute(#name, name, check_sgr0, exit_attribute_mode)
     if (PRESENT(exit_attribute_mode)) {
        char *check_sgr0 = _nc_trim_sgr0(tp);
 
@@ -2320,13 +2459,25 @@ check_termtype(TERMTYPE *tp, bool literal)
                      ("will trim sgr0\n\toriginal sgr0=%s\n\ttrimmed  sgr0=%s",
                       _nc_visbuf2(1, exit_attribute_mode),
                       _nc_visbuf2(2, check_sgr0)));
-               free(check_sgr0);
            } else {
                DEBUG(2,
                      ("will not trim sgr0\n\toriginal sgr0=%s",
                       _nc_visbuf(exit_attribute_mode)));
            }
        }
+       CHECK_SGR0(exit_italics_mode);
+       CHECK_SGR0(exit_standout_mode);
+       CHECK_SGR0(exit_underline_mode);
+       if (check_sgr0 != exit_attribute_mode) {
+           free(check_sgr0);
+       }
+    }
+#define CHECK_SGR_PARAM(code, name) check_sgr_param(tp, (int)code, #name, name)
+    for (j = 0; *sgr_names[j] != '\0'; ++j) {
+       CHECK_SGR_PARAM(j, set_a_foreground);
+       CHECK_SGR_PARAM(j, set_a_background);
+       CHECK_SGR_PARAM(j, set_foreground);
+       CHECK_SGR_PARAM(j, set_background);
     }
 #ifdef TRACE
     show_where(2);