progs/tic.c

   1 /****************************************************************************
   2  * Copyright (c) 1998-2012,2013 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: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
  31  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
  32  *     and: Thomas E. Dickey                        1996 on                 *
  33  ****************************************************************************/
  34
  35 /*
  36  *      tic.c --- Main program for terminfo compiler
  37  *                      by Eric S. Raymond
  38  *                      and Thomas E Dickey
  39  *
  40  */
  41
  42 #include <progs.priv.h>
  43 #include <sys/stat.h>
  44
  45 #include <dump_entry.h>
  46 #include <hashed_db.h>
  47 #include <transform.h>
  48
  49 MODULE_ID("$Id: tic.c,v 1.185 2013/03/17 00:57:05 tom Exp $")
  50
  51 #define STDIN_NAME "<stdin>"
  52
  53 const char *_nc_progname = "tic";
  54
  55 static FILE *log_fp;
  56 static FILE *tmp_fp;
  57 static bool capdump = FALSE;    /* running as infotocap? */
  58 static bool infodump = FALSE;   /* running as captoinfo? */
  59 static bool showsummary = FALSE;
  60 static char **namelst = 0;
  61 static const char *to_remove;
  62
  63 static void (*save_check_termtype) (TERMTYPE *, bool);
  64 static void check_termtype(TERMTYPE *tt, bool);
  65
  66 static const char usage_string[] = "\
  67 [-e names] \
  68 [-o dir] \
  69 [-R name] \
  70 [-v[n]] \
  71 [-V] \
  72 [-w[n]] \
  73 [-\
  74 1\
  75 a\
  76 C\
  77 D\
  78 c\
  79 f\
  80 G\
  81 g\
  82 I\
  83 K\
  84 L\
  85 N\
  86 r\
  87 s\
  88 T\
  89 t\
  90 U\
  91 x\
  92 ] \
  93 source-file\n";
  94
  95 #if NO_LEAKS
  96 static void
  97 free_namelist(char **src)
  98 {
  99     if (src != 0) {
 100         int n;
 101         for (n = 0; src[n] != 0; ++n)
 102             free(src[n]);
 103         free(src);
 104     }
 105 }
 106 #endif
 107
 108 static void
 109 cleanup(void)
 110 {
 111     int rc;
 112
 113 #if NO_LEAKS
 114     free_namelist(namelst);
 115 #endif
 116     if (tmp_fp != 0)
 117         fclose(tmp_fp);
 118     if (to_remove != 0) {
 119 #if HAVE_REMOVE
 120         rc = remove(to_remove);
 121 #else
 122         rc = unlink(to_remove);
 123 #endif
 124         if (rc != 0)
 125             perror(to_remove);
 126     }
 127 }
 128
 129 static void
 130 failed(const char *msg)
 131 {
 132     perror(msg);
 133     ExitProgram(EXIT_FAILURE);
 134 }
 135
 136 static void
 137 usage(void)
 138 {
 139     static const char *const tbl[] =
 140     {
 141         "Options:",
 142         "  -1         format translation output one capability per line",
 143 #if NCURSES_XNAMES
 144         "  -a         retain commented-out capabilities (sets -x also)",
 145 #endif
 146         "  -K         translate entries to termcap source form with BSD syntax",
 147         "  -C         translate entries to termcap source form",
 148         "  -D         print list of tic's database locations (first must be writable)",
 149         "  -c         check only, validate input without compiling or translating",
 150         "  -e<names>  translate/compile only entries named by comma-separated list",
 151         "  -f         format complex strings for readability",
 152         "  -G         format %{number} to %'char'",
 153         "  -g         format %'char' to %{number}",
 154         "  -I         translate entries to terminfo source form",
 155         "  -L         translate entries to full terminfo source form",
 156         "  -N         disable smart defaults for source translation",
 157         "  -o<dir>    set output directory for compiled entry writes",
 158         "  -R<name>   restrict translation to given terminfo/termcap version",
 159         "  -r         force resolution of all use entries in source translation",
 160         "  -s         print summary statistics",
 161         "  -T         remove size-restrictions on compiled description",
 162 #if NCURSES_XNAMES
 163         "  -t         suppress commented-out capabilities",
 164 #endif
 165         "  -U         suppress post-processing of entries",
 166         "  -V         print version",
 167         "  -v[n]      set verbosity level",
 168         "  -w[n]      set format width for translation output",
 169 #if NCURSES_XNAMES
 170         "  -x         treat unknown capabilities as user-defined",
 171 #endif
 172         "",
 173         "Parameters:",
 174         "  <file>     file to translate or compile"
 175     };
 176     size_t j;
 177
 178     fprintf(stderr, "Usage: %s %s\n", _nc_progname, usage_string);
 179     for (j = 0; j < SIZEOF(tbl); j++) {
 180         fputs(tbl[j], stderr);
 181         putc('\n', stderr);
 182     }
 183     ExitProgram(EXIT_FAILURE);
 184 }
 185
 186 #define L_BRACE '{'
 187 #define R_BRACE '}'
 188 #define S_QUOTE '\''
 189
 190 static void
 191 write_it(ENTRY * ep)
 192 {
 193     unsigned n;
 194     int ch;
 195     char *s, *d, *t;
 196     char result[MAX_ENTRY_SIZE];
 197
 198     /*
 199      * Look for strings that contain %{number}, convert them to %'char',
 200      * which is shorter and runs a little faster.
 201      */
 202     for (n = 0; n < STRCOUNT; n++) {
 203         s = ep->tterm.Strings[n];
 204         if (VALID_STRING(s)
 205             && strchr(s, L_BRACE) != 0) {
 206             d = result;
 207             t = s;
 208             while ((ch = *t++) != 0) {
 209                 *d++ = (char) ch;
 210                 if (ch == '\\') {
 211                     *d++ = *t++;
 212                 } else if ((ch == '%')
 213                            && (*t == L_BRACE)) {
 214                     char *v = 0;
 215                     long value = strtol(t + 1, &v, 0);
 216                     if (v != 0
 217                         && *v == R_BRACE
 218                         && value > 0
 219                         && value != '\\'        /* FIXME */
 220                         && value < 127
 221                         && isprint((int) value)) {
 222                         *d++ = S_QUOTE;
 223                         *d++ = (char) value;
 224                         *d++ = S_QUOTE;
 225                         t = (v + 1);
 226                     }
 227                 }
 228             }
 229             *d = 0;
 230             if (strlen(result) < strlen(s))
 231                 _nc_STRCPY(s, result, strlen(s) + 1);
 232         }
 233     }
 234
 235     _nc_set_type(_nc_first_name(ep->tterm.term_names));
 236     _nc_curr_line = (int) ep->startline;
 237     _nc_write_entry(&ep->tterm);
 238 }
 239
 240 static bool
 241 immedhook(ENTRY * ep GCC_UNUSED)
 242 /* write out entries with no use capabilities immediately to save storage */
 243 {
 244 #if !HAVE_BIG_CORE
 245     /*
 246      * This is strictly a core-economy kluge.  The really clean way to handle
 247      * compilation is to slurp the whole file into core and then do all the
 248      * name-collision checks and entry writes in one swell foop.  But the
 249      * terminfo master file is large enough that some core-poor systems swap
 250      * like crazy when you compile it this way...there have been reports of
 251      * this process taking *three hours*, rather than the twenty seconds or
 252      * less typical on my development box.
 253      *
 254      * So.  This hook *immediately* writes out the referenced entry if it
 255      * has no use capabilities.  The compiler main loop refrains from
 256      * adding the entry to the in-core list when this hook fires.  If some
 257      * other entry later needs to reference an entry that got written
 258      * immediately, that's OK; the resolution code will fetch it off disk
 259      * when it can't find it in core.
 260      *
 261      * Name collisions will still be detected, just not as cleanly.  The
 262      * write_entry() code complains before overwriting an entry that
 263      * postdates the time of tic's first call to write_entry().  Thus
 264      * it will complain about overwriting entries newly made during the
 265      * tic run, but not about overwriting ones that predate it.
 266      *
 267      * The reason this is a hook, and not in line with the rest of the
 268      * compiler code, is that the support for termcap fallback cannot assume
 269      * it has anywhere to spool out these entries!
 270      *
 271      * The _nc_set_type() call here requires a compensating one in
 272      * _nc_parse_entry().
 273      *
 274      * If you define HAVE_BIG_CORE, you'll disable this kluge.  This will
 275      * make tic a bit faster (because the resolution code won't have to do
 276      * disk I/O nearly as often).
 277      */
 278     if (ep->nuses == 0) {
 279         int oldline = _nc_curr_line;
 280
 281         write_it(ep);
 282         _nc_curr_line = oldline;
 283         free(ep->tterm.str_table);
 284         return (TRUE);
 285     }
 286 #endif /* HAVE_BIG_CORE */
 287     return (FALSE);
 288 }
 289
 290 static void
 291 put_translate(int c)
 292 /* emit a comment char, translating terminfo names to termcap names */
 293 {
 294     static bool in_name = FALSE;
 295     static size_t have, used;
 296     static char *namebuf, *suffix;
 297
 298     if (in_name) {
 299         if (used + 1 >= have) {
 300             have += 132;
 301             if ((namebuf = typeRealloc(char, have, namebuf)) == 0)
 302                   failed("put_translate namebuf");
 303             if ((suffix = typeRealloc(char, have, suffix)) == 0)
 304                   failed("put_translate suffix");
 305         }
 306         if (c == '\n' || c == '@') {
 307             namebuf[used++] = '\0';
 308             (void) putchar('<');
 309             (void) fputs(namebuf, stdout);
 310             putchar(c);
 311             in_name = FALSE;
 312         } else if (c != '>') {
 313             namebuf[used++] = (char) c;
 314         } else {                /* ah! candidate name! */
 315             char *up;
 316             NCURSES_CONST char *tp;
 317
 318             namebuf[used++] = '\0';
 319             in_name = FALSE;
 320
 321             suffix[0] = '\0';
 322             if ((up = strchr(namebuf, '#')) != 0
 323                 || (up = strchr(namebuf, '=')) != 0
 324                 || ((up = strchr(namebuf, '@')) != 0 && up[1] == '>')) {
 325                 _nc_STRCPY(suffix, up, have);
 326                 *up = '\0';
 327             }
 328
 329             if ((tp = nametrans(namebuf)) != 0) {
 330                 (void) putchar(':');
 331                 (void) fputs(tp, stdout);
 332                 (void) fputs(suffix, stdout);
 333                 (void) putchar(':');
 334             } else {
 335                 /* couldn't find a translation, just dump the name */
 336                 (void) putchar('<');
 337                 (void) fputs(namebuf, stdout);
 338                 (void) fputs(suffix, stdout);
 339                 (void) putchar('>');
 340             }
 341         }
 342     } else {
 343         used = 0;
 344         if (c == '<') {
 345             in_name = TRUE;
 346         } else {
 347             putchar(c);
 348         }
 349     }
 350 }
 351
 352 /* Returns a string, stripped of leading/trailing whitespace */
 353 static char *
 354 stripped(char *src)
 355 {
 356     char *dst = 0;
 357
 358     while (isspace(UChar(*src)))
 359         src++;
 360
 361     if (*src != '\0') {
 362         size_t len;
 363
 364         if ((dst = strdup(src)) == NULL) {
 365             failed("strdup");
 366         } else {
 367             len = strlen(dst);
 368             while (--len != 0 && isspace(UChar(dst[len])))
 369                 dst[len] = '\0';
 370         }
 371     }
 372     return dst;
 373 }
 374
 375 static FILE *
 376 open_tempfile(char *filename)
 377 {
 378     FILE *result = 0;
 379
 380     _nc_STRCPY(filename, "/tmp/XXXXXX", PATH_MAX);
 381 #if HAVE_MKSTEMP
 382     {
 383         int oldmask = umask(077);
 384         int fd = mkstemp(filename);
 385         if (fd >= 0)
 386             result = fdopen(fd, "w");
 387         umask(oldmask);
 388     }
 389 #else
 390     if (tmpnam(filename) != 0)
 391         result = fopen(filename, "w");
 392 #endif
 393     return result;
 394 }
 395
 396 static FILE *
 397 copy_input(FILE *source, const char *filename, char *alt_file)
 398 {
 399     char my_altfile[PATH_MAX];
 400     FILE *result = 0;
 401     FILE *target = 0;
 402     int ch;
 403
 404     if (alt_file == 0)
 405         alt_file = my_altfile;
 406
 407     if (source == 0) {
 408         failed("copy_input (source)");
 409     } else if ((target = open_tempfile(alt_file)) == 0) {
 410         failed("copy_input (target)");
 411     } else {
 412         clearerr(source);
 413         for (;;) {
 414             ch = fgetc(source);
 415             if (feof(source)) {
 416                 break;
 417             } else if (ferror(source)) {
 418                 failed(filename);
 419             } else if (ch == 0) {
 420                 /* don't loop in case someone wants to convert /dev/zero */
 421                 fprintf(stderr, "%s: %s is not a text-file\n", _nc_progname, filename);
 422                 ExitProgram(EXIT_FAILURE);
 423             }
 424             fputc(ch, target);
 425         }
 426         fclose(source);
 427         /*
 428          * rewind() does not force the target file's data to disk (not does
 429          * fflush()...).  So open a second stream on the data and then close
 430          * the one that we were writing on before starting to read from the
 431          * second stream.
 432          */
 433         result = fopen(alt_file, "r+");
 434         fclose(target);
 435         to_remove = strdup(alt_file);
 436     }
 437     return result;
 438 }
 439
 440 static FILE *
 441 open_input(const char *filename, char *alt_file)
 442 {
 443     FILE *fp;
 444     struct stat sb;
 445     int mode;
 446
 447     if (!strcmp(filename, "-")) {
 448         fp = copy_input(stdin, STDIN_NAME, alt_file);
 449     } else if (stat(filename, &sb) < 0) {
 450         fprintf(stderr, "%s: %s %s\n", _nc_progname, filename, strerror(errno));
 451         ExitProgram(EXIT_FAILURE);
 452     } else if ((mode = (sb.st_mode & S_IFMT)) == S_IFDIR
 453                || (mode != S_IFREG && mode != S_IFCHR)) {
 454         fprintf(stderr, "%s: %s is not a file\n", _nc_progname, filename);
 455         ExitProgram(EXIT_FAILURE);
 456     } else {
 457         fp = fopen(filename, "r");
 458
 459         if (fp == 0) {
 460             fprintf(stderr, "%s: Can't open %s\n", _nc_progname, filename);
 461             ExitProgram(EXIT_FAILURE);
 462         }
 463         if (mode != S_IFREG) {
 464             if (alt_file != 0) {
 465                 FILE *fp2 = copy_input(fp, filename, alt_file);
 466                 fp = fp2;
 467             } else {
 468                 fprintf(stderr, "%s: %s is not a file\n", _nc_progname, filename);
 469                 ExitProgram(EXIT_FAILURE);
 470             }
 471         }
 472     }
 473     return fp;
 474 }
 475
 476 /* Parse the "-e" option-value into a list of names */
 477 static char **
 478 make_namelist(char *src)
 479 {
 480     char **dst = 0;
 481
 482     char *s, *base;
 483     unsigned pass, n, nn;
 484     char buffer[BUFSIZ];
 485
 486     if (src == 0) {
 487         /* EMPTY */ ;
 488     } else if (strchr(src, '/') != 0) {         /* a filename */
 489         FILE *fp = open_input(src, (char *) 0);
 490
 491         for (pass = 1; pass <= 2; pass++) {
 492             nn = 0;
 493             while (fgets(buffer, sizeof(buffer), fp) != 0) {
 494                 if ((s = stripped(buffer)) != 0) {
 495                     if (dst != 0)
 496                         dst[nn] = s;
 497                     else
 498                         free(s);
 499                     nn++;
 500                 }
 501             }
 502             if (pass == 1) {
 503                 if ((dst = typeCalloc(char *, nn + 1)) == 0)
 504                       failed("make_namelist");
 505                 rewind(fp);
 506             }
 507         }
 508         fclose(fp);
 509     } else {                    /* literal list of names */
 510         for (pass = 1; pass <= 2; pass++) {
 511             for (n = nn = 0, base = src;; n++) {
 512                 int mark = src[n];
 513                 if (mark == ',' || mark == '\0') {
 514                     if (pass == 1) {
 515                         nn++;
 516                     } else {
 517                         src[n] = '\0';
 518                         if ((s = stripped(base)) != 0)
 519                             dst[nn++] = s;
 520                         base = &src[n + 1];
 521                     }
 522                 }
 523                 if (mark == '\0')
 524                     break;
 525             }
 526             if (pass == 1) {
 527                 if ((dst = typeCalloc(char *, nn + 1)) == 0)
 528                       failed("make_namelist");
 529             }
 530         }
 531     }
 532     if (showsummary && (dst != 0)) {
 533         fprintf(log_fp, "Entries that will be compiled:\n");
 534         for (n = 0; dst[n] != 0; n++)
 535             fprintf(log_fp, "%u:%s\n", n + 1, dst[n]);
 536     }
 537     return dst;
 538 }
 539
 540 static bool
 541 matches(char **needle, const char *haystack)
 542 /* does entry in needle list match |-separated field in haystack? */
 543 {
 544     bool code = FALSE;
 545     size_t n;
 546
 547     if (needle != 0) {
 548         for (n = 0; needle[n] != 0; n++) {
 549             if (_nc_name_match(haystack, needle[n], "|")) {
 550                 code = TRUE;
 551                 break;
 552             }
 553         }
 554     } else
 555         code = TRUE;
 556     return (code);
 557 }
 558
 559 static char *
 560 valid_db_path(const char *nominal)
 561 {
 562     struct stat sb;
 563 #if USE_HASHED_DB
 564     char suffix[] = DBM_SUFFIX;
 565     size_t need = strlen(nominal) + sizeof(suffix);
 566     char *result = malloc(need);
 567
 568     if (result == 0)
 569         failed("valid_db_path");
 570     _nc_STRCPY(result, nominal, need);
 571     if (strcmp(result + need - sizeof(suffix), suffix)) {
 572         _nc_STRCAT(result, suffix, need);
 573     }
 574 #else
 575     char *result = strdup(nominal);
 576 #endif
 577
 578     DEBUG(1, ("** stat(%s)", result));
 579     if (stat(result, &sb) >= 0) {
 580 #if USE_HASHED_DB
 581         if (!S_ISREG(sb.st_mode)
 582             || access(result, R_OK | W_OK) != 0) {
 583             DEBUG(1, ("...not a writable file"));
 584             free(result);
 585             result = 0;
 586         }
 587 #else
 588         if (!S_ISDIR(sb.st_mode)
 589             || access(result, R_OK | W_OK | X_OK) != 0) {
 590             DEBUG(1, ("...not a writable directory"));
 591             free(result);
 592             result = 0;
 593         }
 594 #endif
 595     } else {
 596         /* check if parent is directory and is writable */
 597         unsigned leaf = _nc_pathlast(result);
 598
 599         DEBUG(1, ("...not found"));
 600         if (leaf) {
 601             char save = result[leaf];
 602             result[leaf] = 0;
 603             if (stat(result, &sb) >= 0
 604                 && S_ISDIR(sb.st_mode)
 605                 && access(result, R_OK | W_OK | X_OK) == 0) {
 606                 result[leaf] = save;
 607             } else {
 608                 DEBUG(1, ("...parent directory %s is not writable", result));
 609                 free(result);
 610                 result = 0;
 611             }
 612         } else {
 613             DEBUG(1, ("... no parent directory"));
 614             free(result);
 615             result = 0;
 616         }
 617     }
 618     return result;
 619 }
 620
 621 /*
 622  * Show the databases to which tic could write.  The location to which it
 623  * writes is always the first one.  If none are writable, print an error
 624  * message.
 625  */
 626 static void
 627 show_databases(const char *outdir)
 628 {
 629     bool specific = (outdir != 0) || getenv("TERMINFO") != 0;
 630     char *result;
 631     const char *tried = 0;
 632
 633     if (outdir == 0) {
 634         outdir = _nc_tic_dir(0);
 635     }
 636     if ((result = valid_db_path(outdir)) != 0) {
 637         printf("%s\n", result);
 638         free(result);
 639     } else {
 640         tried = outdir;
 641     }
 642
 643     if ((outdir = _nc_home_terminfo())) {
 644         if ((result = valid_db_path(outdir)) != 0) {
 645             printf("%s\n", result);
 646             free(result);
 647         } else if (!specific) {
 648             tried = outdir;
 649         }
 650     }
 651
 652     /*
 653      * If we can write in neither location, give an error message.
 654      */
 655     if (tried) {
 656         fflush(stdout);
 657         fprintf(stderr, "%s: %s (no permission)\n", _nc_progname, tried);
 658         ExitProgram(EXIT_FAILURE);
 659     }
 660 }
 661
 662 #define VtoTrace(opt) (unsigned) ((opt > 0) ? opt : (opt == 0))
 663
 664 int
 665 main(int argc, char *argv[])
 666 {
 667     char my_tmpname[PATH_MAX];
 668     char my_altfile[PATH_MAX];
 669     int v_opt = -1;
 670     unsigned debug_level;
 671     int smart_defaults = TRUE;
 672     char *termcap;
 673     ENTRY *qp;
 674
 675     int this_opt, last_opt = '?';
 676
 677     int outform = F_TERMINFO;   /* output format */
 678     int sortmode = S_TERMINFO;  /* sort_mode */
 679
 680     int width = 60;
 681     int height = 65535;
 682     bool formatted = FALSE;     /* reformat complex strings? */
 683     bool literal = FALSE;       /* suppress post-processing? */
 684     int numbers = 0;            /* format "%'char'" to/from "%{number}" */
 685     bool forceresolve = FALSE;  /* force resolution */
 686     bool limited = TRUE;
 687     char *tversion = (char *) NULL;
 688     const char *source_file = "terminfo";
 689     char *outdir = (char *) NULL;
 690     bool check_only = FALSE;
 691     bool suppress_untranslatable = FALSE;
 692
 693     log_fp = stderr;
 694
 695     _nc_progname = _nc_rootname(argv[0]);
 696     atexit(cleanup);
 697
 698     if ((infodump = same_program(_nc_progname, PROG_CAPTOINFO)) != FALSE) {
 699         outform = F_TERMINFO;
 700         sortmode = S_TERMINFO;
 701     }
 702     if ((capdump = same_program(_nc_progname, PROG_INFOTOCAP)) != FALSE) {
 703         outform = F_TERMCAP;
 704         sortmode = S_TERMCAP;
 705     }
 706 #if NCURSES_XNAMES
 707     use_extended_names(FALSE);
 708 #endif
 709     _nc_strict_bsd = 0;
 710
 711     /*
 712      * Processing arguments is a little complicated, since someone made a
 713      * design decision to allow the numeric values for -w, -v options to
 714      * be optional.
 715      */
 716     while ((this_opt = getopt(argc, argv,
 717                               "0123456789CDIKLNR:TUVace:fGgo:rstvwx")) != -1) {
 718         if (isdigit(this_opt)) {
 719             switch (last_opt) {
 720             case 'v':
 721                 v_opt = (v_opt * 10) + (this_opt - '0');
 722                 break;
 723             case 'w':
 724                 width = (width * 10) + (this_opt - '0');
 725                 break;
 726             default:
 727                 switch (this_opt) {
 728                 case '0':
 729                     last_opt = this_opt;
 730                     width = 65535;
 731                     height = 1;
 732                     break;
 733                 case '1':
 734                     last_opt = this_opt;
 735                     width = 0;
 736                     break;
 737                 default:
 738                     usage();
 739                 }
 740             }
 741             continue;
 742         }
 743         switch (this_opt) {
 744         case 'K':
 745             _nc_strict_bsd = 1;
 746             /* the initial version of -K in 20110730 fell-thru here, but the
 747              * same flag is useful when reading sources -TD
 748              */
 749             break;
 750         case 'C':
 751             capdump = TRUE;
 752             outform = F_TERMCAP;
 753             sortmode = S_TERMCAP;
 754             break;
 755         case 'D':
 756             debug_level = VtoTrace(v_opt);
 757             set_trace_level(debug_level);
 758             show_databases(outdir);
 759             ExitProgram(EXIT_SUCCESS);
 760             break;
 761         case 'I':
 762             infodump = TRUE;
 763             outform = F_TERMINFO;
 764             sortmode = S_TERMINFO;
 765             break;
 766         case 'L':
 767             infodump = TRUE;
 768             outform = F_VARIABLE;
 769             sortmode = S_VARIABLE;
 770             break;
 771         case 'N':
 772             smart_defaults = FALSE;
 773             literal = TRUE;
 774             break;
 775         case 'R':
 776             tversion = optarg;
 777             break;
 778         case 'T':
 779             limited = FALSE;
 780             break;
 781         case 'U':
 782             literal = TRUE;
 783             break;
 784         case 'V':
 785             puts(curses_version());
 786             ExitProgram(EXIT_SUCCESS);
 787         case 'c':
 788             check_only = TRUE;
 789             break;
 790         case 'e':
 791             namelst = make_namelist(optarg);
 792             break;
 793         case 'f':
 794             formatted = TRUE;
 795             break;
 796         case 'G':
 797             numbers = 1;
 798             break;
 799         case 'g':
 800             numbers = -1;
 801             break;
 802         case 'o':
 803             outdir = optarg;
 804             break;
 805         case 'r':
 806             forceresolve = TRUE;
 807             break;
 808         case 's':
 809             showsummary = TRUE;
 810             break;
 811         case 'v':
 812             v_opt = 0;
 813             break;
 814         case 'w':
 815             width = 0;
 816             break;
 817 #if NCURSES_XNAMES
 818         case 't':
 819             _nc_disable_period = FALSE;
 820             suppress_untranslatable = TRUE;
 821             break;
 822         case 'a':
 823             _nc_disable_period = TRUE;
 824             /* FALLTHRU */
 825         case 'x':
 826             use_extended_names(TRUE);
 827             break;
 828 #endif
 829         default:
 830             usage();
 831         }
 832         last_opt = this_opt;
 833     }
 834
 835     debug_level = VtoTrace(v_opt);
 836     set_trace_level(debug_level);
 837
 838     if (_nc_tracing) {
 839         save_check_termtype = _nc_check_termtype2;
 840         _nc_check_termtype2 = check_termtype;
 841     }
 842 #if !HAVE_BIG_CORE
 843     /*
 844      * Aaargh! immedhook seriously hoses us!
 845      *
 846      * One problem with immedhook is it means we can't do -e.  Problem
 847      * is that we can't guarantee that for each terminal listed, all the
 848      * terminals it depends on will have been kept in core for reference
 849      * resolution -- in fact it's certain the primitive types at the end
 850      * of reference chains *won't* be in core unless they were explicitly
 851      * in the select list themselves.
 852      */
 853     if (namelst && (!infodump && !capdump)) {
 854         (void) fprintf(stderr,
 855                        "%s: Sorry, -e can't be used without -I or -C\n",
 856                        _nc_progname);
 857         ExitProgram(EXIT_FAILURE);
 858     }
 859 #endif /* HAVE_BIG_CORE */
 860
 861     if (optind < argc) {
 862         source_file = argv[optind++];
 863         if (optind < argc) {
 864             fprintf(stderr,
 865                     "%s: Too many file names.  Usage:\n\t%s %s",
 866                     _nc_progname,
 867                     _nc_progname,
 868                     usage_string);
 869             ExitProgram(EXIT_FAILURE);
 870         }
 871     } else {
 872         if (infodump == TRUE) {
 873             /* captoinfo's no-argument case */
 874             source_file = "/etc/termcap";
 875             if ((termcap = getenv("TERMCAP")) != 0
 876                 && (namelst = make_namelist(getenv("TERM"))) != 0) {
 877                 if (access(termcap, F_OK) == 0) {
 878                     /* file exists */
 879                     source_file = termcap;
 880                 } else {
 881                     if ((tmp_fp = open_tempfile(my_tmpname)) != 0) {
 882                         source_file = my_tmpname;
 883                         fprintf(tmp_fp, "%s\n", termcap);
 884                         fclose(tmp_fp);
 885                         tmp_fp = open_input(source_file, (char *) 0);
 886                         to_remove = source_file;
 887                     } else {
 888                         failed("tmpnam");
 889                     }
 890                 }
 891             }
 892         } else {
 893             /* tic */
 894             fprintf(stderr,
 895                     "%s: File name needed.  Usage:\n\t%s %s",
 896                     _nc_progname,
 897                     _nc_progname,
 898                     usage_string);
 899             ExitProgram(EXIT_FAILURE);
 900         }
 901     }
 902
 903     if (tmp_fp == 0) {
 904         tmp_fp = open_input(source_file, my_altfile);
 905         if (!strcmp(source_file, "-")) {
 906             source_file = STDIN_NAME;
 907         }
 908     }
 909
 910     if (infodump) {
 911         dump_init(tversion,
 912                   smart_defaults
 913                   ? outform
 914                   : F_LITERAL,
 915                   sortmode, width, height, debug_level, formatted);
 916     } else if (capdump) {
 917         dump_init(tversion,
 918                   outform,
 919                   sortmode, width, height, debug_level, FALSE);
 920     }
 921
 922     /* parse entries out of the source file */
 923     _nc_set_source(source_file);
 924 #if !HAVE_BIG_CORE
 925     if (!(check_only || infodump || capdump))
 926         _nc_set_writedir(outdir);
 927 #endif /* HAVE_BIG_CORE */
 928     _nc_read_entry_source(tmp_fp, (char *) NULL,
 929                           !smart_defaults || literal, FALSE,
 930                           ((check_only || infodump || capdump)
 931                            ? NULLHOOK
 932                            : immedhook));
 933
 934     /* do use resolution */
 935     if (check_only || (!infodump && !capdump) || forceresolve) {
 936         if (!_nc_resolve_uses2(TRUE, literal) && !check_only) {
 937             ExitProgram(EXIT_FAILURE);
 938         }
 939     }
 940
 941     /* length check */
 942     if (check_only && (capdump || infodump)) {
 943         for_entry_list(qp) {
 944             if (matches(namelst, qp->tterm.term_names)) {
 945                 int len = fmt_entry(&qp->tterm, NULL, FALSE, TRUE, infodump, numbers);
 946
 947                 if (len > (infodump ? MAX_TERMINFO_LENGTH : MAX_TERMCAP_LENGTH))
 948                     (void) fprintf(stderr,
 949                                    "warning: resolved %s entry is %d bytes long\n",
 950                                    _nc_first_name(qp->tterm.term_names),
 951                                    len);
 952             }
 953         }
 954     }
 955
 956     /* write or dump all entries */
 957     if (!check_only) {
 958         if (!infodump && !capdump) {
 959             _nc_set_writedir(outdir);
 960             for_entry_list(qp) {
 961                 if (matches(namelst, qp->tterm.term_names))
 962                     write_it(qp);
 963             }
 964         } else {
 965             /* this is in case infotocap() generates warnings */
 966             _nc_curr_col = _nc_curr_line = -1;
 967
 968             for_entry_list(qp) {
 969                 if (matches(namelst, qp->tterm.term_names)) {
 970                     long j = qp->cend - qp->cstart;
 971                     int len = 0;
 972
 973                     /* this is in case infotocap() generates warnings */
 974                     _nc_set_type(_nc_first_name(qp->tterm.term_names));
 975
 976                     (void) fseek(tmp_fp, qp->cstart, SEEK_SET);
 977                     while (j-- > 0) {
 978                         if (infodump)
 979                             (void) putchar(fgetc(tmp_fp));
 980                         else
 981                             put_translate(fgetc(tmp_fp));
 982                     }
 983
 984                     repair_acsc(&qp->tterm);
 985                     dump_entry(&qp->tterm, suppress_untranslatable,
 986                                limited, numbers, NULL);
 987                     for (j = 0; j < (long) qp->nuses; j++)
 988                         dump_uses(qp->uses[j].name, !capdump);
 989                     len = show_entry();
 990                     if (debug_level != 0 && !limited)
 991                         printf("# length=%d\n", len);
 992                 }
 993             }
 994             if (!namelst && _nc_tail) {
 995                 int c, oldc = '\0';
 996                 bool in_comment = FALSE;
 997                 bool trailing_comment = FALSE;
 998
 999                 (void) fseek(tmp_fp, _nc_tail->cend, SEEK_SET);
1000                 while ((c = fgetc(tmp_fp)) != EOF) {
1001                     if (oldc == '\n') {
1002                         if (c == '#') {
1003                             trailing_comment = TRUE;
1004                             in_comment = TRUE;
1005                         } else {
1006                             in_comment = FALSE;
1007                         }
1008                     }
1009                     if (trailing_comment
1010                         && (in_comment || (oldc == '\n' && c == '\n')))
1011                         putchar(c);
1012                     oldc = c;
1013                 }
1014             }
1015         }
1016     }
1017
1018     /* Show the directory into which entries were written, and the total
1019      * number of entries
1020      */
1021     if (showsummary
1022         && (!(check_only || infodump || capdump))) {
1023         int total = _nc_tic_written();
1024         if (total != 0)
1025             fprintf(log_fp, "%d entries written to %s\n",
1026                     total,
1027                     _nc_tic_dir((char *) 0));
1028         else
1029             fprintf(log_fp, "No entries written\n");
1030     }
1031     ExitProgram(EXIT_SUCCESS);
1032 }
1033
1034 /*
1035  * This bit of legerdemain turns all the terminfo variable names into
1036  * references to locations in the arrays Booleans, Numbers, and Strings ---
1037  * precisely what's needed (see comp_parse.c).
1038  */
1039 #undef CUR
1040 #define CUR tp->
1041
1042 /*
1043  * Check if the alternate character-set capabilities are consistent.
1044  */
1045 static void
1046 check_acs(TERMTYPE *tp)
1047 {
1048     if (VALID_STRING(acs_chars)) {
1049         const char *boxes = "lmkjtuvwqxn";
1050         char mapped[256];
1051         char missing[256];
1052         const char *p;
1053         char *q;
1054
1055         memset(mapped, 0, sizeof(mapped));
1056         for (p = acs_chars; *p != '\0'; p += 2) {
1057             if (p[1] == '\0') {
1058                 _nc_warning("acsc has odd number of characters");
1059                 break;
1060             }
1061             mapped[UChar(p[0])] = p[1];
1062         }
1063
1064         if (mapped[UChar('I')] && !mapped[UChar('i')]) {
1065             _nc_warning("acsc refers to 'I', which is probably an error");
1066         }
1067
1068         for (p = boxes, q = missing; *p != '\0'; ++p) {
1069             if (!mapped[UChar(p[0])]) {
1070                 *q++ = p[0];
1071             }
1072         }
1073         *q = '\0';
1074
1075         assert(strlen(missing) <= strlen(boxes));
1076         if (*missing != '\0' && strcmp(missing, boxes)) {
1077             _nc_warning("acsc is missing some line-drawing mapping: %s", missing);
1078         }
1079     }
1080 }
1081
1082 /*
1083  * Check if the color capabilities are consistent
1084  */
1085 static void
1086 check_colors(TERMTYPE *tp)
1087 {
1088     if ((max_colors > 0) != (max_pairs > 0)
1089         || ((max_colors > max_pairs) && (initialize_pair == 0)))
1090         _nc_warning("inconsistent values for max_colors (%d) and max_pairs (%d)",
1091                     max_colors, max_pairs);
1092
1093     PAIRED(set_foreground, set_background);
1094     PAIRED(set_a_foreground, set_a_background);
1095     PAIRED(set_color_pair, initialize_pair);
1096
1097     if (VALID_STRING(set_foreground)
1098         && VALID_STRING(set_a_foreground)
1099         && !_nc_capcmp(set_foreground, set_a_foreground))
1100         _nc_warning("expected setf/setaf to be different");
1101
1102     if (VALID_STRING(set_background)
1103         && VALID_STRING(set_a_background)
1104         && !_nc_capcmp(set_background, set_a_background))
1105         _nc_warning("expected setb/setab to be different");
1106
1107     /* see: has_colors() */
1108     if (VALID_NUMERIC(max_colors) && VALID_NUMERIC(max_pairs)
1109         && (((set_foreground != NULL)
1110              && (set_background != NULL))
1111             || ((set_a_foreground != NULL)
1112                 && (set_a_background != NULL))
1113             || set_color_pair)) {
1114         if (!VALID_STRING(orig_pair) && !VALID_STRING(orig_colors))
1115             _nc_warning("expected either op/oc string for resetting colors");
1116     }
1117 }
1118
1119 static char
1120 keypad_final(const char *string)
1121 {
1122     char result = '\0';
1123
1124     if (VALID_STRING(string)
1125         && *string++ == '\033'
1126         && *string++ == 'O'
1127         && strlen(string) == 1) {
1128         result = *string;
1129     }
1130
1131     return result;
1132 }
1133
1134 static long
1135 keypad_index(const char *string)
1136 {
1137     char *test;
1138     const char *list = "PQRSwxymtuvlqrsPpn";    /* app-keypad except "Enter" */
1139     int ch;
1140     long result = -1;
1141
1142     if ((ch = keypad_final(string)) != '\0') {
1143         test = strchr(list, ch);
1144         if (test != 0)
1145             result = (long) (test - list);
1146     }
1147     return result;
1148 }
1149
1150 /*
1151  * list[] is down, up, left, right
1152  * "left" may be ^H rather than \E[D
1153  * "down" may be ^J rather than \E[B
1154  * But up/right are generally consistently escape sequences for ANSI terminals.
1155  */
1156 static void
1157 check_ansi_cursor(char *list[4])
1158 {
1159     int j, k;
1160     int want;
1161     size_t prefix = 0;
1162     size_t suffix;
1163     bool skip[4];
1164     bool repeated = FALSE;
1165
1166     for (j = 0; j < 4; ++j) {
1167         skip[j] = FALSE;
1168         for (k = 0; k < j; ++k) {
1169             if (j != k
1170                 && !strcmp(list[j], list[k])) {
1171                 char *value = _nc_tic_expand(list[k], TRUE, 0);
1172                 _nc_warning("repeated cursor control %s\n", value);
1173                 repeated = TRUE;
1174             }
1175         }
1176     }
1177     if (!repeated) {
1178         char *up = list[1];
1179
1180         if (UChar(up[0]) == '\033') {
1181             if (up[1] == '[') {
1182                 prefix = 2;
1183             } else {
1184                 prefix = 1;
1185             }
1186         } else if (UChar(up[0]) == UChar('\233')) {
1187             prefix = 1;
1188         }
1189         if (prefix) {
1190             suffix = prefix;
1191             while (up[suffix] && isdigit(UChar(up[suffix])))
1192                 ++suffix;
1193         }
1194         if (prefix && up[suffix] == 'A') {
1195             skip[1] = TRUE;
1196             if (!strcmp(list[0], "\n"))
1197                 skip[0] = TRUE;
1198             if (!strcmp(list[2], "\b"))
1199                 skip[2] = TRUE;
1200
1201             for (j = 0; j < 4; ++j) {
1202                 if (skip[j] || strlen(list[j]) == 1)
1203                     continue;
1204                 if (memcmp(list[j], up, prefix)) {
1205                     char *value = _nc_tic_expand(list[j], TRUE, 0);
1206                     _nc_warning("inconsistent prefix for %s\n", value);
1207                     continue;
1208                 }
1209                 if (strlen(list[j]) < suffix) {
1210                     char *value = _nc_tic_expand(list[j], TRUE, 0);
1211                     _nc_warning("inconsistent length for %s, expected %d\n",
1212                                 value, (int) suffix + 1);
1213                     continue;
1214                 }
1215                 want = "BADC"[j];
1216                 if (list[j][suffix] != want) {
1217                     char *value = _nc_tic_expand(list[j], TRUE, 0);
1218                     _nc_warning("inconsistent suffix for %s, expected %c, have %c\n",
1219                                 value, want, list[j][suffix]);
1220                 }
1221             }
1222         }
1223     }
1224 }
1225
1226 #define EXPECTED(name) if (!PRESENT(name)) _nc_warning("expected " #name)
1227
1228 static void
1229 check_cursor(TERMTYPE *tp)
1230 {
1231     int count;
1232     char *list[4];
1233
1234     /* it is rare to have an insert-line feature without a matching delete */
1235     ANDMISSING(parm_insert_line, insert_line);
1236     ANDMISSING(parm_delete_line, delete_line);
1237     ANDMISSING(parm_insert_line, parm_delete_line);
1238
1239     /* if we have a parameterized form, then the non-parameterized is easy */
1240     ANDMISSING(parm_down_cursor, cursor_down);
1241     ANDMISSING(parm_up_cursor, cursor_up);
1242     ANDMISSING(parm_left_cursor, cursor_left);
1243     ANDMISSING(parm_right_cursor, cursor_right);
1244
1245     /* Given any of a set of cursor movement, the whole set should be present.
1246      * Technically this is not true (we could use cursor_address to fill in
1247      * unsupported controls), but it is likely.
1248      */
1249     count = 0;
1250     if (PRESENT(parm_down_cursor)) {
1251         list[count++] = parm_down_cursor;
1252     }
1253     if (PRESENT(parm_up_cursor)) {
1254         list[count++] = parm_up_cursor;
1255     }
1256     if (PRESENT(parm_left_cursor)) {
1257         list[count++] = parm_left_cursor;
1258     }
1259     if (PRESENT(parm_right_cursor)) {
1260         list[count++] = parm_right_cursor;
1261     }
1262     if (count == 4) {
1263         check_ansi_cursor(list);
1264     } else if (count != 0) {
1265         EXPECTED(parm_down_cursor);
1266         EXPECTED(parm_up_cursor);
1267         EXPECTED(parm_left_cursor);
1268         EXPECTED(parm_right_cursor);
1269     }
1270
1271     count = 0;
1272     if (PRESENT(cursor_down)) {
1273         list[count++] = cursor_down;
1274     }
1275     if (PRESENT(cursor_up)) {
1276         list[count++] = cursor_up;
1277     }
1278     if (PRESENT(cursor_left)) {
1279         list[count++] = cursor_left;
1280     }
1281     if (PRESENT(cursor_right)) {
1282         list[count++] = cursor_right;
1283     }
1284     if (count == 4) {
1285         check_ansi_cursor(list);
1286     } else if (count != 0) {
1287         count = 0;
1288         if (PRESENT(cursor_down) && strcmp(cursor_down, "\n"))
1289             ++count;
1290         if (PRESENT(cursor_left) && strcmp(cursor_left, "\b"))
1291             ++count;
1292         if (PRESENT(cursor_up) && strlen(cursor_up) > 1)
1293             ++count;
1294         if (PRESENT(cursor_right) && strlen(cursor_right) > 1)
1295             ++count;
1296         if (count) {
1297             EXPECTED(cursor_down);
1298             EXPECTED(cursor_up);
1299             EXPECTED(cursor_left);
1300             EXPECTED(cursor_right);
1301         }
1302     }
1303 }
1304
1305 #define MAX_KP 5
1306 /*
1307  * Do a quick sanity-check for vt100-style keypads to see if the 5-key keypad
1308  * is mapped inconsistently.
1309  */
1310 static void
1311 check_keypad(TERMTYPE *tp)
1312 {
1313     char show[80];
1314
1315     if (VALID_STRING(key_a1) &&
1316         VALID_STRING(key_a3) &&
1317         VALID_STRING(key_b2) &&
1318         VALID_STRING(key_c1) &&
1319         VALID_STRING(key_c3)) {
1320         char final[MAX_KP + 1];
1321         long list[MAX_KP];
1322         int increase = 0;
1323         int j, k, kk;
1324         long last;
1325         long test;
1326
1327         final[0] = keypad_final(key_a1);
1328         final[1] = keypad_final(key_a3);
1329         final[2] = keypad_final(key_b2);
1330         final[3] = keypad_final(key_c1);
1331         final[4] = keypad_final(key_c3);
1332         final[5] = '\0';
1333
1334         /* special case: legacy coding using 1,2,3,0,. on the bottom */
1335         assert(strlen(final) <= MAX_KP);
1336         if (!strcmp(final, "qsrpn"))
1337             return;
1338
1339         list[0] = keypad_index(key_a1);
1340         list[1] = keypad_index(key_a3);
1341         list[2] = keypad_index(key_b2);
1342         list[3] = keypad_index(key_c1);
1343         list[4] = keypad_index(key_c3);
1344
1345         /* check that they're all vt100 keys */
1346         for (j = 0; j < MAX_KP; ++j) {
1347             if (list[j] < 0) {
1348                 return;
1349             }
1350         }
1351
1352         /* check if they're all in increasing order */
1353         for (j = 1; j < MAX_KP; ++j) {
1354             if (list[j] > list[j - 1]) {
1355                 ++increase;
1356             }
1357         }
1358         if (increase != (MAX_KP - 1)) {
1359             show[0] = '\0';
1360
1361             for (j = 0, last = -1; j < MAX_KP; ++j) {
1362                 for (k = 0, kk = -1, test = 100; k < 5; ++k) {
1363                     if (list[k] > last &&
1364                         list[k] < test) {
1365                         test = list[k];
1366                         kk = k;
1367                     }
1368                 }
1369                 last = test;
1370                 assert(strlen(show) < (MAX_KP * 4));
1371                 switch (kk) {
1372                 case 0:
1373                     _nc_STRCAT(show, " ka1", sizeof(show));
1374                     break;
1375                 case 1:
1376                     _nc_STRCAT(show, " ka3", sizeof(show));
1377                     break;
1378                 case 2:
1379                     _nc_STRCAT(show, " kb2", sizeof(show));
1380                     break;
1381                 case 3:
1382                     _nc_STRCAT(show, " kc1", sizeof(show));
1383                     break;
1384                 case 4:
1385                     _nc_STRCAT(show, " kc3", sizeof(show));
1386                     break;
1387                 }
1388             }
1389
1390             _nc_warning("vt100 keypad order inconsistent: %s", show);
1391         }
1392
1393     } else if (VALID_STRING(key_a1) ||
1394                VALID_STRING(key_a3) ||
1395                VALID_STRING(key_b2) ||
1396                VALID_STRING(key_c1) ||
1397                VALID_STRING(key_c3)) {
1398         show[0] = '\0';
1399         if (keypad_index(key_a1) >= 0)
1400             _nc_STRCAT(show, " ka1", sizeof(show));
1401         if (keypad_index(key_a3) >= 0)
1402             _nc_STRCAT(show, " ka3", sizeof(show));
1403         if (keypad_index(key_b2) >= 0)
1404             _nc_STRCAT(show, " kb2", sizeof(show));
1405         if (keypad_index(key_c1) >= 0)
1406             _nc_STRCAT(show, " kc1", sizeof(show));
1407         if (keypad_index(key_c3) >= 0)
1408             _nc_STRCAT(show, " kc3", sizeof(show));
1409         if (*show != '\0')
1410             _nc_warning("vt100 keypad map incomplete:%s", show);
1411     }
1412
1413     /*
1414      * These warnings are useful for consistency checks - it is possible that
1415      * there are real terminals with mismatches in these
1416      */
1417     ANDMISSING(key_ic, key_dc);
1418 }
1419
1420 static void
1421 check_printer(TERMTYPE *tp)
1422 {
1423     PAIRED(enter_doublewide_mode, exit_doublewide_mode);
1424     PAIRED(enter_italics_mode, exit_italics_mode);
1425     PAIRED(enter_leftward_mode, exit_leftward_mode);
1426     PAIRED(enter_micro_mode, exit_micro_mode);
1427     PAIRED(enter_shadow_mode, exit_shadow_mode);
1428     PAIRED(enter_subscript_mode, exit_subscript_mode);
1429     PAIRED(enter_superscript_mode, exit_superscript_mode);
1430     PAIRED(enter_upward_mode, exit_upward_mode);
1431
1432     ANDMISSING(start_char_set_def, stop_char_set_def);
1433
1434     /* if we have a parameterized form, then the non-parameterized is easy */
1435     ANDMISSING(set_bottom_margin_parm, set_bottom_margin);
1436     ANDMISSING(set_left_margin_parm, set_left_margin);
1437     ANDMISSING(set_right_margin_parm, set_right_margin);
1438     ANDMISSING(set_top_margin_parm, set_top_margin);
1439
1440     ANDMISSING(parm_down_micro, micro_down);
1441     ANDMISSING(parm_left_micro, micro_left);
1442     ANDMISSING(parm_right_micro, micro_right);
1443     ANDMISSING(parm_up_micro, micro_up);
1444 }
1445
1446 static bool
1447 uses_SGR_39_49(const char *value)
1448 {
1449     return (strstr(value, "39;49") != 0
1450             || strstr(value, "49;39") != 0);
1451 }
1452
1453 /*
1454  * Check consistency of termcap extensions related to "screen".
1455  */
1456 static void
1457 check_screen(TERMTYPE *tp)
1458 {
1459     if (_nc_user_definable) {
1460         int have_XT = tigetflag("XT");
1461         int have_XM = tigetflag("XM");
1462         int have_bce = back_color_erase;
1463         bool have_kmouse = FALSE;
1464         bool use_sgr_39_49 = FALSE;
1465         char *name = _nc_first_name(tp->term_names);
1466
1467         if (!VALID_BOOLEAN(have_bce)) {
1468             have_bce = FALSE;
1469         }
1470         if (!VALID_BOOLEAN(have_XM)) {
1471             have_XM = FALSE;
1472         }
1473         if (!VALID_BOOLEAN(have_XT)) {
1474             have_XT = FALSE;
1475         }
1476         if (VALID_STRING(key_mouse)) {
1477             have_kmouse = !strcmp("\033[M", key_mouse);
1478         }
1479         if (VALID_STRING(orig_colors)) {
1480             use_sgr_39_49 = uses_SGR_39_49(orig_colors);
1481         } else if (VALID_STRING(orig_pair)) {
1482             use_sgr_39_49 = uses_SGR_39_49(orig_pair);
1483         }
1484
1485         if (have_XM && have_XT) {
1486             _nc_warning("Screen's XT capability conflicts with XM");
1487         } else if (have_XT
1488                    && strstr(name, "screen") != 0
1489                    && strchr(name, '.') != 0) {
1490             _nc_warning("Screen's \"screen\" entries should not have XT set");
1491         } else if (have_XT) {
1492             if (!have_kmouse && have_bce) {
1493                 if (VALID_STRING(key_mouse)) {
1494                     _nc_warning("Value of kmous inconsistent with screen's usage");
1495                 } else {
1496                     _nc_warning("Expected kmous capability with XT");
1497                 }
1498             }
1499             if (!have_bce && max_colors > 0)
1500                 _nc_warning("Expected bce capability with XT");
1501             if (!use_sgr_39_49 && have_bce && max_colors > 0)
1502                 _nc_warning("Expected orig_colors capability with XT to have 39/49 parameters");
1503             if (VALID_STRING(to_status_line))
1504                 _nc_warning("\"tsl\" capability is redundant, given XT");
1505         } else {
1506             if (have_kmouse && !have_XM)
1507                 _nc_warning("Expected XT to be set, given kmous");
1508         }
1509     }
1510 }
1511
1512 /*
1513  * Returns the expected number of parameters for the given capability.
1514  */
1515 static int
1516 expected_params(const char *name)
1517 {
1518     /* *INDENT-OFF* */
1519     static const struct {
1520         const char *name;
1521         int count;
1522     } table[] = {
1523         { "S0",                 1 },    /* 'screen' extension */
1524         { "birep",              2 },
1525         { "chr",                1 },
1526         { "colornm",            1 },
1527         { "cpi",                1 },
1528         { "csnm",               1 },
1529         { "csr",                2 },
1530         { "cub",                1 },
1531         { "cud",                1 },
1532         { "cuf",                1 },
1533         { "cup",                2 },
1534         { "cuu",                1 },
1535         { "cvr",                1 },
1536         { "cwin",               5 },
1537         { "dch",                1 },
1538         { "defc",               3 },
1539         { "dial",               1 },
1540         { "dispc",              1 },
1541         { "dl",                 1 },
1542         { "ech",                1 },
1543         { "getm",               1 },
1544         { "hpa",                1 },
1545         { "ich",                1 },
1546         { "il",                 1 },
1547         { "indn",               1 },
1548         { "initc",              4 },
1549         { "initp",              7 },
1550         { "lpi",                1 },
1551         { "mc5p",               1 },
1552         { "mrcup",              2 },
1553         { "mvpa",               1 },
1554         { "pfkey",              2 },
1555         { "pfloc",              2 },
1556         { "pfx",                2 },
1557         { "pfxl",               3 },
1558         { "pln",                2 },
1559         { "qdial",              1 },
1560         { "rcsd",               1 },
1561         { "rep",                2 },
1562         { "rin",                1 },
1563         { "sclk",               3 },
1564         { "scp",                1 },
1565         { "scs",                1 },
1566         { "scsd",               2 },
1567         { "setab",              1 },
1568         { "setaf",              1 },
1569         { "setb",               1 },
1570         { "setcolor",           1 },
1571         { "setf",               1 },
1572         { "sgr",                9 },
1573         { "sgr1",               6 },
1574         { "slength",            1 },
1575         { "slines",             1 },
1576         { "smgbp",              1 },    /* 2 if smgtp is not given */
1577         { "smglp",              1 },
1578         { "smglr",              2 },
1579         { "smgrp",              1 },
1580         { "smgtb",              2 },
1581         { "smgtp",              1 },
1582         { "tsl",                1 },
1583         { "u6",                 -1 },
1584         { "vpa",                1 },
1585         { "wind",               4 },
1586         { "wingo",              1 },
1587     };
1588     /* *INDENT-ON* */
1589
1590     unsigned n;
1591     int result = 0;             /* function-keys, etc., use none */
1592
1593     for (n = 0; n < SIZEOF(table); n++) {
1594         if (!strcmp(name, table[n].name)) {
1595             result = table[n].count;
1596             break;
1597         }
1598     }
1599
1600     return result;
1601 }
1602
1603 /*
1604  * Make a quick sanity check for the parameters which are used in the given
1605  * strings.  If there are no "%p" tokens, then there should be no other "%"
1606  * markers.
1607  */
1608 static void
1609 check_params(TERMTYPE *tp, const char *name, char *value)
1610 {
1611     int expected = expected_params(name);
1612     int actual = 0;
1613     int n;
1614     bool params[10];
1615     char *s = value;
1616
1617 #ifdef set_top_margin_parm
1618     if (!strcmp(name, "smgbp")
1619         && set_top_margin_parm == 0)
1620         expected = 2;
1621 #endif
1622
1623     for (n = 0; n < 10; n++)
1624         params[n] = FALSE;
1625
1626     while (*s != 0) {
1627         if (*s == '%') {
1628             if (*++s == '\0') {
1629                 _nc_warning("expected character after %% in %s", name);
1630                 break;
1631             } else if (*s == 'p') {
1632                 if (*++s == '\0' || !isdigit((int) *s)) {
1633                     _nc_warning("expected digit after %%p in %s", name);
1634                     return;
1635                 } else {
1636                     n = (*s - '0');
1637                     if (n > actual)
1638                         actual = n;
1639                     params[n] = TRUE;
1640                 }
1641             }
1642         }
1643         s++;
1644     }
1645
1646     if (params[0]) {
1647         _nc_warning("%s refers to parameter 0 (%%p0), which is not allowed", name);
1648     }
1649     if (value == set_attributes || expected < 0) {
1650         ;
1651     } else if (expected != actual) {
1652         _nc_warning("%s uses %d parameters, expected %d", name,
1653                     actual, expected);
1654         for (n = 1; n < actual; n++) {
1655             if (!params[n])
1656                 _nc_warning("%s omits parameter %d", name, n);
1657         }
1658     }
1659 }
1660
1661 static char *
1662 skip_delay(char *s)
1663 {
1664     while (*s == '/' || isdigit(UChar(*s)))
1665         ++s;
1666     return s;
1667 }
1668
1669 /*
1670  * Skip a delay altogether, e.g., when comparing a simple string to sgr,
1671  * the latter may have a worst-case delay on the end.
1672  */
1673 static char *
1674 ignore_delays(char *s)
1675 {
1676     int delaying = 0;
1677
1678     do {
1679         switch (*s) {
1680         case '$':
1681             if (delaying == 0)
1682                 delaying = 1;
1683             break;
1684         case '<':
1685             if (delaying == 1)
1686                 delaying = 2;
1687             break;
1688         case '\0':
1689             delaying = 0;
1690             break;
1691         default:
1692             if (delaying) {
1693                 s = skip_delay(s);
1694                 if (*s == '>')
1695                     ++s;
1696                 delaying = 0;
1697             }
1698             break;
1699         }
1700         if (delaying)
1701             ++s;
1702     } while (delaying);
1703     return s;
1704 }
1705
1706 /*
1707  * An sgr string may contain several settings other than the one we're
1708  * interested in, essentially sgr0 + rmacs + whatever.  As long as the
1709  * "whatever" is contained in the sgr string, that is close enough for our
1710  * sanity check.
1711  */
1712 static bool
1713 similar_sgr(int num, char *a, char *b)
1714 {
1715     static const char *names[] =
1716     {
1717         "none"
1718         ,"standout"
1719         ,"underline"
1720         ,"reverse"
1721         ,"blink"
1722         ,"dim"
1723         ,"bold"
1724         ,"invis"
1725         ,"protect"
1726         ,"altcharset"
1727     };
1728     char *base_a = a;
1729     char *base_b = b;
1730     int delaying = 0;
1731
1732     while (*b != 0) {
1733         while (*a != *b) {
1734             if (*a == 0) {
1735                 if (b[0] == '$'
1736                     && b[1] == '<') {
1737                     _nc_warning("Did not find delay %s", _nc_visbuf(b));
1738                 } else {
1739                     _nc_warning("checking sgr(%s) %s\n\tcompare to %s\n\tunmatched %s",
1740                                 names[num], _nc_visbuf2(1, base_a),
1741                                 _nc_visbuf2(2, base_b),
1742                                 _nc_visbuf2(3, b));
1743                 }
1744                 return FALSE;
1745             } else if (delaying) {
1746                 a = skip_delay(a);
1747                 b = skip_delay(b);
1748             } else if ((*b == '0' || (*b == ';')) && *a == 'm') {
1749                 b++;
1750             } else {
1751                 a++;
1752             }
1753         }
1754         switch (*a) {
1755         case '$':
1756             if (delaying == 0)
1757                 delaying = 1;
1758             break;
1759         case '<':
1760             if (delaying == 1)
1761                 delaying = 2;
1762             break;
1763         default:
1764             delaying = 0;
1765             break;
1766         }
1767         a++;
1768         b++;
1769     }
1770     /* ignore delays on the end of the string */
1771     a = ignore_delays(a);
1772     return ((num != 0) || (*a == 0));
1773 }
1774
1775 static char *
1776 check_sgr(TERMTYPE *tp, char *zero, int num, char *cap, const char *name)
1777 {
1778     char *test;
1779
1780     _nc_tparm_err = 0;
1781     test = TPARM_9(set_attributes,
1782                    num == 1,
1783                    num == 2,
1784                    num == 3,
1785                    num == 4,
1786                    num == 5,
1787                    num == 6,
1788                    num == 7,
1789                    num == 8,
1790                    num == 9);
1791     if (test != 0) {
1792         if (PRESENT(cap)) {
1793             if (!similar_sgr(num, test, cap)) {
1794                 _nc_warning("%s differs from sgr(%d)\n\t%s=%s\n\tsgr(%d)=%s",
1795                             name, num,
1796                             name, _nc_visbuf2(1, cap),
1797                             num, _nc_visbuf2(2, test));
1798             }
1799         } else if (_nc_capcmp(test, zero)) {
1800             _nc_warning("sgr(%d) present, but not %s", num, name);
1801         }
1802     } else if (PRESENT(cap)) {
1803         _nc_warning("sgr(%d) missing, but %s present", num, name);
1804     }
1805     if (_nc_tparm_err)
1806         _nc_warning("stack error in sgr(%d) string", num);
1807     return test;
1808 }
1809
1810 #define CHECK_SGR(num,name) check_sgr(tp, zero, num, name, #name)
1811
1812 #ifdef TRACE
1813 /*
1814  * If tic is compiled with TRACE, we'll be able to see the output from the
1815  * DEBUG() macro.  But since it doesn't use traceon(), it always goes to
1816  * the standard error.  Use this function to make it simpler to follow the
1817  * resulting debug traces.
1818  */
1819 static void
1820 show_where(unsigned level)
1821 {
1822     if (_nc_tracing >= DEBUG_LEVEL(level)) {
1823         char my_name[MAX_NAME_SIZE];
1824         _nc_get_type(my_name);
1825         _tracef("\"%s\", line %d, '%s'",
1826                 _nc_get_source(),
1827                 _nc_curr_line, my_name);
1828     }
1829 }
1830
1831 #else
1832 #define show_where(level)       /* nothing */
1833 #endif
1834
1835 typedef struct {
1836     int keycode;
1837     const char *name;
1838     const char *value;
1839 } NAME_VALUE;
1840
1841 static NAME_VALUE *
1842 get_fkey_list(TERMTYPE *tp)
1843 {
1844     NAME_VALUE *result = typeMalloc(NAME_VALUE, NUM_STRINGS(tp) + 1);
1845     const struct tinfo_fkeys *all_fkeys = _nc_tinfo_fkeys;
1846     int used = 0;
1847     int j;
1848
1849     if (result == 0)
1850         failed("get_fkey_list");
1851
1852     for (j = 0; all_fkeys[j].code; j++) {
1853         char *a = tp->Strings[all_fkeys[j].offset];
1854         if (VALID_STRING(a)) {
1855             result[used].keycode = (int) all_fkeys[j].code;
1856             result[used].name = strnames[all_fkeys[j].offset];
1857             result[used].value = a;
1858             ++used;
1859         }
1860     }
1861 #if NCURSES_XNAMES
1862     for (j = STRCOUNT; j < NUM_STRINGS(tp); ++j) {
1863         const char *name = ExtStrname(tp, j, strnames);
1864         if (*name == 'k') {
1865             result[used].keycode = -1;
1866             result[used].name = name;
1867             result[used].value = tp->Strings[j];
1868             ++used;
1869         }
1870     }
1871 #endif
1872     result[used].keycode = 0;
1873     return result;
1874 }
1875
1876 static void
1877 show_fkey_name(NAME_VALUE * data)
1878 {
1879     if (data->keycode > 0) {
1880         fprintf(stderr, " %s", keyname(data->keycode));
1881         fprintf(stderr, " (capability \"%s\")", data->name);
1882     } else {
1883         fprintf(stderr, " capability \"%s\"", data->name);
1884     }
1885 }
1886
1887 /* other sanity-checks (things that we don't want in the normal
1888  * logic that reads a terminfo entry)
1889  */
1890 static void
1891 check_termtype(TERMTYPE *tp, bool literal)
1892 {
1893     bool conflict = FALSE;
1894     unsigned j, k;
1895
1896     /*
1897      * A terminal entry may contain more than one keycode assigned to
1898      * a given string (e.g., KEY_END and KEY_LL).  But curses will only
1899      * return one (the last one assigned).
1900      */
1901     if (!(_nc_syntax == SYN_TERMCAP && capdump)) {
1902         char *check = calloc((size_t) (NUM_STRINGS(tp) + 1), sizeof(char));
1903         NAME_VALUE *given = get_fkey_list(tp);
1904
1905         if (check == 0)
1906             failed("check_termtype");
1907
1908         for (j = 0; given[j].keycode; ++j) {
1909             const char *a = given[j].value;
1910             bool first = TRUE;
1911
1912             for (k = j + 1; given[k].keycode; k++) {
1913                 const char *b = given[k].value;
1914                 if (check[k])
1915                     continue;
1916                 if (!_nc_capcmp(a, b)) {
1917                     check[j] = 1;
1918                     check[k] = 1;
1919                     if (first) {
1920                         if (!conflict) {
1921                             _nc_warning("Conflicting key definitions (using the last)");
1922                             conflict = TRUE;
1923                         }
1924                         fprintf(stderr, "...");
1925                         show_fkey_name(given + j);
1926                         fprintf(stderr, " is the same as");
1927                         show_fkey_name(given + k);
1928                         first = FALSE;
1929                     } else {
1930                         fprintf(stderr, ", ");
1931                         show_fkey_name(given + k);
1932                     }
1933                 }
1934             }
1935             if (!first)
1936                 fprintf(stderr, "\n");
1937         }
1938         free(given);
1939         free(check);
1940     }
1941
1942     for_each_string(j, tp) {
1943         char *a = tp->Strings[j];
1944         if (VALID_STRING(a))
1945             check_params(tp, ExtStrname(tp, (int) j, strnames), a);
1946     }
1947
1948     check_acs(tp);
1949     check_colors(tp);
1950     check_cursor(tp);
1951     check_keypad(tp);
1952     check_printer(tp);
1953     check_screen(tp);
1954
1955     /*
1956      * These may be mismatched because the terminal description relies on
1957      * restoring the cursor visibility by resetting it.
1958      */
1959     ANDMISSING(cursor_invisible, cursor_normal);
1960     ANDMISSING(cursor_visible, cursor_normal);
1961
1962     if (PRESENT(cursor_visible) && PRESENT(cursor_normal)
1963         && !_nc_capcmp(cursor_visible, cursor_normal))
1964         _nc_warning("cursor_visible is same as cursor_normal");
1965
1966     /*
1967      * From XSI & O'Reilly, we gather that sc/rc are required if csr is
1968      * given, because the cursor position after the scrolling operation is
1969      * performed is undefined.
1970      */
1971     ANDMISSING(change_scroll_region, save_cursor);
1972     ANDMISSING(change_scroll_region, restore_cursor);
1973
1974     /*
1975      * If we can clear tabs, we should be able to initialize them.
1976      */
1977     ANDMISSING(clear_all_tabs, set_tab);
1978
1979     if (PRESENT(set_attributes)) {
1980         char *zero = 0;
1981
1982         _nc_tparm_err = 0;
1983         if (PRESENT(exit_attribute_mode)) {
1984             zero = strdup(CHECK_SGR(0, exit_attribute_mode));
1985         } else {
1986             zero = strdup(TPARM_9(set_attributes, 0, 0, 0, 0, 0, 0, 0, 0, 0));
1987         }
1988         if (_nc_tparm_err)
1989             _nc_warning("stack error in sgr(0) string");
1990
1991         if (zero != 0) {
1992             CHECK_SGR(1, enter_standout_mode);
1993             CHECK_SGR(2, enter_underline_mode);
1994             CHECK_SGR(3, enter_reverse_mode);
1995             CHECK_SGR(4, enter_blink_mode);
1996             CHECK_SGR(5, enter_dim_mode);
1997             CHECK_SGR(6, enter_bold_mode);
1998             CHECK_SGR(7, enter_secure_mode);
1999             CHECK_SGR(8, enter_protected_mode);
2000             CHECK_SGR(9, enter_alt_charset_mode);
2001             free(zero);
2002         } else {
2003             _nc_warning("sgr(0) did not return a value");
2004         }
2005     } else if (PRESENT(exit_attribute_mode) &&
2006                set_attributes != CANCELLED_STRING) {
2007         if (_nc_syntax == SYN_TERMINFO)
2008             _nc_warning("missing sgr string");
2009     }
2010
2011     if (PRESENT(exit_attribute_mode)) {
2012         char *check_sgr0 = _nc_trim_sgr0(tp);
2013
2014         if (check_sgr0 == 0 || *check_sgr0 == '\0') {
2015             _nc_warning("trimmed sgr0 is empty");
2016         } else {
2017             show_where(2);
2018             if (check_sgr0 != exit_attribute_mode) {
2019                 DEBUG(2,
2020                       ("will trim sgr0\n\toriginal sgr0=%s\n\ttrimmed  sgr0=%s",
2021                        _nc_visbuf2(1, exit_attribute_mode),
2022                        _nc_visbuf2(2, check_sgr0)));
2023                 free(check_sgr0);
2024             } else {
2025                 DEBUG(2,
2026                       ("will not trim sgr0\n\toriginal sgr0=%s",
2027                        _nc_visbuf(exit_attribute_mode)));
2028             }
2029         }
2030     }
2031 #ifdef TRACE
2032     show_where(2);
2033     if (!auto_right_margin) {
2034         DEBUG(2,
2035               ("can write to lower-right directly"));
2036     } else if (PRESENT(enter_am_mode) && PRESENT(exit_am_mode)) {
2037         DEBUG(2,
2038               ("can write to lower-right by suppressing automargin"));
2039     } else if ((PRESENT(enter_insert_mode) && PRESENT(exit_insert_mode))
2040                || PRESENT(insert_character) || PRESENT(parm_ich)) {
2041         DEBUG(2,
2042               ("can write to lower-right by using inserts"));
2043     } else {
2044         DEBUG(2,
2045               ("cannot write to lower-right"));
2046     }
2047 #endif
2048
2049     /*
2050      * Some standard applications (e.g., vi) and some non-curses
2051      * applications (e.g., jove) get confused if we have both ich1 and
2052      * smir/rmir.  Let's be nice and warn about that, too, even though
2053      * ncurses handles it.
2054      */
2055     if ((PRESENT(enter_insert_mode) || PRESENT(exit_insert_mode))
2056         && PRESENT(parm_ich)) {
2057         _nc_warning("non-curses applications may be confused by ich1 with smir/rmir");
2058     }
2059
2060     /*
2061      * Finally, do the non-verbose checks
2062      */
2063     if (save_check_termtype != 0)
2064         save_check_termtype(tp, literal);
2065 }