]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - progs/tic.c
ncurses 6.1 - patch 20190720
[ncurses.git] / progs / tic.c
index 711ed11b9c40065c2de932da26d93b41a38b5ae0..32ea4541ebe973d0fd720dabdca8a0375df0f47a 100644 (file)
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright (c) 1998-2017,2018 Free Software Foundation, Inc.              *
+ * Copyright (c) 1998-2018,2019 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.256 2018/03/18 00:05:10 tom Exp $")
+MODULE_ID("$Id: tic.c,v 1.277 2019/06/29 23:23:22 tom Exp $")
 
 #define STDIN_NAME "<stdin>"
 
@@ -59,6 +59,7 @@ static FILE *tmp_fp;
 static bool capdump = FALSE;   /* running as infotocap? */
 static bool infodump = FALSE;  /* running as captoinfo? */
 static bool showsummary = FALSE;
+static unsigned debug_level;
 static char **namelst = 0;
 static const char *to_remove;
 
@@ -680,7 +681,6 @@ main(int argc, char *argv[])
     char my_tmpname[PATH_MAX];
     char my_altfile[PATH_MAX];
     int v_opt = -1;
-    unsigned debug_level;
     int smart_defaults = TRUE;
     char *termcap;
     ENTRY *qp;
@@ -1095,6 +1095,50 @@ main(int argc, char *argv[])
 static void
 check_acs(TERMTYPE2 *tp)
 {
+    int vt100_smacs = 0;
+    int vt100_rmacs = 0;
+    int vt100_enacs = 0;
+
+    /*
+     * ena_acs is not always necessary, but if it is present, the enter/exit
+     * capabilities should be.
+     */
+    ANDMISSING(ena_acs, enter_alt_charset_mode);
+    ANDMISSING(ena_acs, exit_alt_charset_mode);
+    PAIRED(exit_alt_charset_mode, exit_alt_charset_mode);
+
+    /*
+     * vt100-like is frequently used, but perhaps ena_acs is missing, etc.
+     */
+    if (VALID_STRING(enter_alt_charset_mode)) {
+       vt100_smacs = (!strcmp("\033(0", enter_alt_charset_mode)
+                      ? 2
+                      : (!strcmp("\016", enter_alt_charset_mode)
+                         ? 1
+                         : 0));
+    }
+    if (VALID_STRING(exit_alt_charset_mode)) {
+       vt100_rmacs = (!strcmp("\033(B", exit_alt_charset_mode)
+                      ? 2
+                      : (!strcmp("\017", exit_alt_charset_mode)
+                         ? 1
+                         : 0));
+    }
+    if (VALID_STRING(ena_acs)) {
+       vt100_enacs = (!strcmp("\033(B\033)0", ena_acs)
+                      ? 2
+                      : 0);
+    }
+    if (vt100_rmacs && vt100_smacs && (vt100_rmacs != vt100_smacs)) {
+       _nc_warning("rmacs/smacs are inconsistent");
+    }
+    if ((vt100_rmacs == 2) && (vt100_smacs == 2) && vt100_enacs) {
+       _nc_warning("rmacs/smacs make enacs redundant");
+    }
+    if ((vt100_rmacs == 1) && (vt100_smacs == 1) && !vt100_enacs) {
+       _nc_warning("VT100-style rmacs/smacs require enacs");
+    }
+
     if (VALID_STRING(acs_chars)) {
        const char *boxes = "lmkjtuvwqxn";
        char mapped[256];
@@ -1156,6 +1200,8 @@ same_color(NCURSES_CONST char *oldcap, NCURSES_CONST char *newcap, int limit)
 static void
 check_colors(TERMTYPE2 *tp)
 {
+    char *value;
+
     if ((max_colors > 0) != (max_pairs > 0)
        || ((max_colors > max_pairs) && (initialize_pair == 0)))
        _nc_warning("inconsistent values for max_colors (%d) and max_pairs (%d)",
@@ -1204,6 +1250,15 @@ check_colors(TERMTYPE2 *tp)
            _nc_warning("expected ccc because initc is given");
        }
     }
+    value = tigetstr("RGB");
+    if (VALID_STRING(value)) {
+       int r, g, b;
+       char bad;
+       int code = sscanf(value, "%d/%d/%d%c", &r, &g, &b, &bad);
+       if (code != 3 || r <= 0 || g <= 0 || b <= 0) {
+           _nc_warning("unexpected value for RGB capability: %s", value);
+       }
+    }
 }
 
 static int
@@ -1622,6 +1677,7 @@ check_printer(TERMTYPE2 *tp)
 #endif
 }
 
+#if NCURSES_XNAMES
 static bool
 uses_SGR_39_49(const char *value)
 {
@@ -1635,7 +1691,6 @@ uses_SGR_39_49(const char *value)
 static void
 check_screen(TERMTYPE2 *tp)
 {
-#if NCURSES_XNAMES
     if (_nc_user_definable) {
        int have_XT = tigetflag("XT");
        int have_XM = tigetflag("XM");
@@ -1666,33 +1721,35 @@ check_screen(TERMTYPE2 *tp)
        }
 
        if (have_XM && have_XT) {
-           _nc_warning("Screen's XT capability conflicts with XM");
+           _nc_warning("screen's XT capability conflicts with XM");
        } else if (have_XT && screen_base) {
-           _nc_warning("Screen's \"screen\" entries should not have XT set");
+           _nc_warning("screen's \"screen\" entries should not have XT set");
        } else if (have_XT) {
            if (!have_kmouse && is_screen) {
                if (VALID_STRING(key_mouse)) {
-                   _nc_warning("Value of kmous inconsistent with screen's usage");
+                   _nc_warning("value of kmous inconsistent with screen's usage");
                } else {
-                   _nc_warning("Expected kmous capability with XT");
+                   _nc_warning("expected kmous capability with XT");
                }
            }
            if (!have_bce && max_colors > 0)
-               _nc_warning("Expected bce capability with XT");
+               _nc_warning("expected bce capability with XT");
            if (!use_sgr_39_49 && have_bce && max_colors > 0)
-               _nc_warning("Expected orig_colors capability with XT to have 39/49 parameters");
+               _nc_warning("expected orig_colors capability with XT to have 39/49 parameters");
            if (VALID_STRING(to_status_line))
                _nc_warning("\"tsl\" capability is redundant, given XT");
        } else {
            if (have_kmouse
                && !have_XM
                && !screen_base && strchr(name, '+') == 0) {
-               _nc_warning("Expected XT to be set, given kmous");
+               _nc_warning("expected XT to be set, given kmous");
            }
        }
     }
-#endif
 }
+#else
+#define check_screen(tp)       /* nothing */
+#endif
 
 /*
  * Returns the expected number of parameters for the given capability.
@@ -1789,12 +1846,32 @@ expected_params(const char *name)
 }
 
 /*
+ * Check for user-capabilities that happen to be used in ncurses' terminal
+ * database.
+ */
+#if NCURSES_XNAMES
+static struct user_table_entry const *
+lookup_user_capability(const char *name)
+{
+    struct user_table_entry const *result = 0;
+    if (*name != 'k') {
+       result = _nc_find_user_entry(name);
+    }
+    return result;
+}
+#endif
+
+/*
+ * If a given name is likely to be a user-capability, return the number of
+ * parameters it would be used with.  If not, return -1.
+ *
  * ncurses assumes that u6 could be used for getting the cursor-position, but
  * that is not implemented.  Make a special case for that, to quiet needless
  * warnings.
  *
- * There are other string-capability extensions (see terminfo.src) which could
- * have parameters such as "Ss", "%u", but are not used by ncurses.
+ * The other string-capability extensions (see terminfo.src) which could have
+ * parameters such as "Ss", "%u", are not used by ncurses.  But we check those
+ * anyway, to validate the terminfo database.
  */
 static int
 is_user_capability(const char *name)
@@ -1802,8 +1879,17 @@ is_user_capability(const char *name)
     int result = -1;
     if (name[0] == 'u' &&
        (name[1] >= '0' && name[1] <= '9') &&
-       name[2] == '\0')
+       name[2] == '\0') {
        result = (name[1] == '6') ? 2 : 0;
+    }
+#if NCURSES_XNAMES
+    else if (using_extensions) {
+       struct user_table_entry const *p = lookup_user_capability(name);
+       if (p != 0) {
+           result = (int) p->ute_argc;
+       }
+    }
+#endif
     return result;
 }
 
@@ -1850,13 +1936,21 @@ check_params(TERMTYPE2 *tp, const char *name, char *value, int extended)
        s++;
     }
 
+#if NCURSES_XNAMES
     if (extended) {
-       if (actual > 0) {
-           _nc_warning("extended %s capability has %d parameters",
+       int check = is_user_capability(name);
+       if (check != actual && (check >= 0 && actual >= 0)) {
+           _nc_warning("extended %s capability has %d parameters, expected %d",
+                       name, actual, check);
+       } else if (debug_level > 1) {
+           _nc_warning("extended %s capability has %d parameters, as expected",
                        name, actual);
-           expected = actual;
        }
+       expected = actual;
     }
+#else
+    (void) extended;
+#endif
 
     if (params[0]) {
        _nc_warning("%s refers to parameter 0 (%%p0), which is not allowed", name);
@@ -1885,13 +1979,16 @@ check_params(TERMTYPE2 *tp, const char *name, char *value, int extended)
            analyzed = popcount;
        }
        if (actual != analyzed && expected != analyzed) {
+#if NCURSES_XNAMES
            int user_cap = is_user_capability(name);
            if ((user_cap == analyzed) && using_extensions) {
                ;               /* ignore */
            } else if (user_cap >= 0) {
-               _nc_warning("tparm will use %d parameters for %s",
-                           analyzed, name);
-           } else {
+               _nc_warning("tparm will use %d parameters for %s, expected %d",
+                           analyzed, name, user_cap);
+           } else
+#endif
+           {
                _nc_warning("tparm analyzed %d parameters for %s, expected %d",
                            analyzed, name, actual);
            }
@@ -2232,8 +2329,7 @@ static void
 check_infotocap(TERMTYPE2 *tp, int i, const char *value)
 {
     const char *name = ExtStrname(tp, i, strnames);
-    int params = (((i < (int) SIZEOF(parametrized)) &&
-                  (i < STRCOUNT))
+    int params = ((i < (int) SIZEOF(parametrized))
                  ? parametrized[i]
                  : ((*value == 'k')
                     ? 0
@@ -2243,6 +2339,7 @@ check_infotocap(TERMTYPE2 *tp, int i, const char *value)
     char *tc_value;
     bool embedded;
 
+    assert(SIZEOF(parametrized) == STRCOUNT);
     if ((ti_value = _nc_tic_expand(value, TRUE, to_char)) == ABSENT_STRING) {
        _nc_warning("tic-expansion of %s failed", name);
     } else if ((tc_value = _nc_infotocap(name, ti_value, params)) == ABSENT_STRING) {
@@ -2368,7 +2465,7 @@ similar_sgr(int num, char *a, char *b)
                    ;
                } else if (b[0] == '$'
                           && b[1] == '<') {
-                   _nc_warning("Did not find delay %s", _nc_visbuf(b));
+                   _nc_warning("did not find delay %s", _nc_visbuf(b));
                } else {
                    _nc_warning("checking sgr(%s) %s\n\tcompare to %s\n\tunmatched %s",
                                sgr_names[num], _nc_visbuf2(1, base_a),
@@ -2556,7 +2653,7 @@ check_conflict(TERMTYPE2 *tp)
                    check[k] = 1;
                    if (first) {
                        if (!conflict) {
-                           _nc_warning("Conflicting key definitions (using the last)");
+                           _nc_warning("conflicting key definitions (using the last)");
                            conflict = TRUE;
                        }
                        fprintf(stderr, "...");
@@ -2733,6 +2830,57 @@ check_sgr_param(TERMTYPE2 *tp, int code, const char *name, char *value)
     }
 }
 
+#if NCURSES_XNAMES
+static int
+standard_type(const char *name)
+{
+    int result = -1;
+    const struct name_table_entry *np;
+
+    if ((np = _nc_find_entry(name, _nc_get_hash_table(0))) != 0) {
+       result = np->nte_type;
+    }
+    return result;
+}
+
+static const char *
+name_of_type(int type)
+{
+    const char *result = "unknown";
+    switch (type) {
+    case BOOLEAN:
+       result = "boolean";
+       break;
+    case NUMBER:
+       result = "number";
+       break;
+    case STRING:
+       result = "string";
+       break;
+    }
+    return result;
+}
+
+static void
+check_user_capability_type(const char *name, int actual)
+{
+    if (lookup_user_capability(name) == 0) {
+       int expected = standard_type(name);
+       if (expected >= 0) {
+           _nc_warning("expected %s to be %s, but actually %s",
+                       name,
+                       name_of_type(actual),
+                       name_of_type(expected)
+               );
+       } else if (*name != 'k') {
+           _nc_warning("undocumented %s capability %s",
+                       name_of_type(actual),
+                       name);
+       }
+    }
+}
+#endif
+
 /* other sanity-checks (things that we don't want in the normal
  * logic that reads a terminfo entry)
  */
@@ -2752,7 +2900,7 @@ check_termtype(TERMTYPE2 *tp, bool literal)
             * check for consistent number of parameters.
             */
            if (j >= SIZEOF(parametrized) ||
-               is_user_capability(name) > 0 ||
+               is_user_capability(name) >= 0 ||
                parametrized[j] > 0) {
                check_params(tp, name, a, (j >= STRCOUNT));
            }
@@ -2762,6 +2910,18 @@ check_termtype(TERMTYPE2 *tp, bool literal)
            }
        }
     }
+#if NCURSES_XNAMES
+    /* in extended mode, verify that each extension is expected type */
+    for_each_ext_boolean(j, tp) {
+       check_user_capability_type(ExtBoolname(tp, (int) j, strnames), BOOLEAN);
+    }
+    for_each_ext_number(j, tp) {
+       check_user_capability_type(ExtNumname(tp, (int) j, strnames), NUMBER);
+    }
+    for_each_ext_string(j, tp) {
+       check_user_capability_type(ExtStrname(tp, (int) j, strnames), STRING);
+    }
+#endif /* NCURSES_XNAMES */
 
     check_acs(tp);
     check_colors(tp);
@@ -2770,6 +2930,11 @@ check_termtype(TERMTYPE2 *tp, bool literal)
     check_printer(tp);
     check_screen(tp);
 
+    /*
+     * These are probably both or none.
+     */
+    PAIRED(parm_index, parm_rindex);
+
     /*
      * These may be mismatched because the terminal description relies on
      * restoring the cursor visibility by resetting it.