7339f11a0d78bcb32684f0e47cc77f86cf965580
[ncurses.git] / progs / tic.c
1 /****************************************************************************
2  * Copyright (c) 1998-2015,2016 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 <tparm_type.h>
47 #include <hashed_db.h>
48 #include <parametrized.h>
49 #include <transform.h>
50
51 MODULE_ID("$Id: tic.c,v 1.229 2016/12/04 02:12:38 tom Exp $")
52
53 #define STDIN_NAME "<stdin>"
54
55 const char *_nc_progname = "tic";
56
57 static FILE *log_fp;
58 static FILE *tmp_fp;
59 static bool capdump = FALSE;    /* running as infotocap? */
60 static bool infodump = FALSE;   /* running as captoinfo? */
61 static bool showsummary = FALSE;
62 static char **namelst = 0;
63 static const char *to_remove;
64
65 static void (*save_check_termtype) (TERMTYPE *, bool);
66 static void check_termtype(TERMTYPE *tt, bool);
67
68 static const char usage_string[] = "\
69 [-e names] \
70 [-o dir] \
71 [-R name] \
72 [-v[n]] \
73 [-V] \
74 [-w[n]] \
75 [-\
76 1\
77 a\
78 C\
79 D\
80 c\
81 f\
82 G\
83 g\
84 I\
85 K\
86 L\
87 N\
88 r\
89 s\
90 T\
91 t\
92 U\
93 x\
94 ] \
95 source-file\n";
96
97 #if NO_LEAKS
98 static void
99 free_namelist(char **src)
100 {
101     if (src != 0) {
102         int n;
103         for (n = 0; src[n] != 0; ++n)
104             free(src[n]);
105         free(src);
106     }
107 }
108 #endif
109
110 static void
111 cleanup(void)
112 {
113     int rc;
114
115 #if NO_LEAKS
116     free_namelist(namelst);
117 #endif
118     if (tmp_fp != 0)
119         fclose(tmp_fp);
120     if (to_remove != 0) {
121 #if HAVE_REMOVE
122         rc = remove(to_remove);
123 #else
124         rc = unlink(to_remove);
125 #endif
126         if (rc != 0)
127             perror(to_remove);
128     }
129 }
130
131 static void
132 failed(const char *msg)
133 {
134     perror(msg);
135     ExitProgram(EXIT_FAILURE);
136 }
137
138 static void
139 usage(void)
140 {
141 #define DATA(s) s "\n"
142     static const char options_string[] =
143     {
144         DATA("Options:")
145         DATA("  -0         format translation output all capabilities on one line")
146         DATA("  -1         format translation output one capability per line")
147 #if NCURSES_XNAMES
148         DATA("  -a         retain commented-out capabilities (sets -x also)")
149 #endif
150         DATA("  -C         translate entries to termcap source form")
151         DATA("  -D         print list of tic's database locations (first must be writable)")
152         DATA("  -c         check only, validate input without compiling or translating")
153         DATA("  -e<names>  translate/compile only entries named by comma-separated list")
154         DATA("  -f         format complex strings for readability")
155         DATA("  -G         format %{number} to %'char'")
156         DATA("  -g         format %'char' to %{number}")
157         DATA("  -I         translate entries to terminfo source form")
158         DATA("  -K         translate entries to termcap source form with BSD syntax")
159         DATA("  -L         translate entries to full terminfo source form")
160         DATA("  -N         disable smart defaults for source translation")
161         DATA("  -o<dir>    set output directory for compiled entry writes")
162         DATA("  -Q[n]      dump compiled description")
163         DATA("  -q    brief listing, removes headers")
164         DATA("  -R<name>   restrict translation to given terminfo/termcap version")
165         DATA("  -r         force resolution of all use entries in source translation")
166         DATA("  -s         print summary statistics")
167         DATA("  -T         remove size-restrictions on compiled description")
168 #if NCURSES_XNAMES
169         DATA("  -t         suppress commented-out capabilities")
170 #endif
171         DATA("  -U         suppress post-processing of entries")
172         DATA("  -V         print version")
173         DATA("  -W         wrap long strings according to -w[n] option")
174         DATA("  -v[n]      set verbosity level")
175         DATA("  -w[n]      set format width for translation output")
176 #if NCURSES_XNAMES
177         DATA("  -x         treat unknown capabilities as user-defined")
178 #endif
179         DATA("")
180         DATA("Parameters:")
181         DATA("  <file>     file to translate or compile")
182     };
183 #undef DATA
184
185     fprintf(stderr, "Usage: %s %s\n", _nc_progname, usage_string);
186     fputs(options_string, stderr);
187     ExitProgram(EXIT_FAILURE);
188 }
189
190 #define L_BRACE '{'
191 #define R_BRACE '}'
192 #define S_QUOTE '\''
193
194 static void
195 write_it(ENTRY * ep)
196 {
197     unsigned n;
198     int ch;
199     char *s, *d, *t;
200     char result[MAX_ENTRY_SIZE];
201
202     /*
203      * Look for strings that contain %{number}, convert them to %'char',
204      * which is shorter and runs a little faster.
205      */
206     for (n = 0; n < STRCOUNT; n++) {
207         s = ep->tterm.Strings[n];
208         if (VALID_STRING(s)
209             && strchr(s, L_BRACE) != 0) {
210             d = result;
211             t = s;
212             while ((ch = *t++) != 0) {
213                 *d++ = (char) ch;
214                 if (ch == '\\') {
215                     *d++ = *t++;
216                 } else if ((ch == '%')
217                            && (*t == L_BRACE)) {
218                     char *v = 0;
219                     long value = strtol(t + 1, &v, 0);
220                     if (v != 0
221                         && *v == R_BRACE
222                         && value > 0
223                         && value != '\\'        /* FIXME */
224                         && value < 127
225                         && isprint((int) value)) {
226                         *d++ = S_QUOTE;
227                         *d++ = (char) value;
228                         *d++ = S_QUOTE;
229                         t = (v + 1);
230                     }
231                 }
232             }
233             *d = 0;
234             if (strlen(result) < strlen(s))
235                 _nc_STRCPY(s, result, strlen(s) + 1);
236         }
237     }
238
239     _nc_set_type(_nc_first_name(ep->tterm.term_names));
240     _nc_curr_line = (int) ep->startline;
241     _nc_write_entry(&ep->tterm);
242 }
243
244 static bool
245 immedhook(ENTRY * ep GCC_UNUSED)
246 /* write out entries with no use capabilities immediately to save storage */
247 {
248 #if !HAVE_BIG_CORE
249     /*
250      * This is strictly a core-economy kluge.  The really clean way to handle
251      * compilation is to slurp the whole file into core and then do all the
252      * name-collision checks and entry writes in one swell foop.  But the
253      * terminfo master file is large enough that some core-poor systems swap
254      * like crazy when you compile it this way...there have been reports of
255      * this process taking *three hours*, rather than the twenty seconds or
256      * less typical on my development box.
257      *
258      * So.  This hook *immediately* writes out the referenced entry if it
259      * has no use capabilities.  The compiler main loop refrains from
260      * adding the entry to the in-core list when this hook fires.  If some
261      * other entry later needs to reference an entry that got written
262      * immediately, that's OK; the resolution code will fetch it off disk
263      * when it can't find it in core.
264      *
265      * Name collisions will still be detected, just not as cleanly.  The
266      * write_entry() code complains before overwriting an entry that
267      * postdates the time of tic's first call to write_entry().  Thus
268      * it will complain about overwriting entries newly made during the
269      * tic run, but not about overwriting ones that predate it.
270      *
271      * The reason this is a hook, and not in line with the rest of the
272      * compiler code, is that the support for termcap fallback cannot assume
273      * it has anywhere to spool out these entries!
274      *
275      * The _nc_set_type() call here requires a compensating one in
276      * _nc_parse_entry().
277      *
278      * If you define HAVE_BIG_CORE, you'll disable this kluge.  This will
279      * make tic a bit faster (because the resolution code won't have to do
280      * disk I/O nearly as often).
281      */
282     if (ep->nuses == 0) {
283         int oldline = _nc_curr_line;
284
285         write_it(ep);
286         _nc_curr_line = oldline;
287         free(ep->tterm.str_table);
288         return (TRUE);
289     }
290 #endif /* HAVE_BIG_CORE */
291     return (FALSE);
292 }
293
294 static void
295 put_translate(int c)
296 /* emit a comment char, translating terminfo names to termcap names */
297 {
298     static bool in_name = FALSE;
299     static size_t have, used;
300     static char *namebuf, *suffix;
301
302     if (in_name) {
303         if (used + 1 >= have) {
304             have += 132;
305             if ((namebuf = typeRealloc(char, have, namebuf)) == 0)
306                   failed("put_translate namebuf");
307             if ((suffix = typeRealloc(char, have, suffix)) == 0)
308                   failed("put_translate suffix");
309         }
310         if (c == '\n' || c == '@') {
311             namebuf[used++] = '\0';
312             (void) putchar('<');
313             (void) fputs(namebuf, stdout);
314             putchar(c);
315             in_name = FALSE;
316         } else if (c != '>') {
317             namebuf[used++] = (char) c;
318         } else {                /* ah! candidate name! */
319             char *up;
320             NCURSES_CONST char *tp;
321
322             namebuf[used++] = '\0';
323             in_name = FALSE;
324
325             suffix[0] = '\0';
326             if ((up = strchr(namebuf, '#')) != 0
327                 || (up = strchr(namebuf, '=')) != 0
328                 || ((up = strchr(namebuf, '@')) != 0 && up[1] == '>')) {
329                 _nc_STRCPY(suffix, up, have);
330                 *up = '\0';
331             }
332
333             if ((tp = nametrans(namebuf)) != 0) {
334                 (void) putchar(':');
335                 (void) fputs(tp, stdout);
336                 (void) fputs(suffix, stdout);
337                 (void) putchar(':');
338             } else {
339                 /* couldn't find a translation, just dump the name */
340                 (void) putchar('<');
341                 (void) fputs(namebuf, stdout);
342                 (void) fputs(suffix, stdout);
343                 (void) putchar('>');
344             }
345         }
346     } else {
347         used = 0;
348         if (c == '<') {
349             in_name = TRUE;
350         } else {
351             putchar(c);
352         }
353     }
354 }
355
356 /* Returns a string, stripped of leading/trailing whitespace */
357 static char *
358 stripped(char *src)
359 {
360     char *dst = 0;
361
362     while (isspace(UChar(*src)))
363         src++;
364
365     if (*src != '\0') {
366         size_t len;
367
368         if ((dst = strdup(src)) == NULL) {
369             failed("strdup");
370         } else {
371             len = strlen(dst);
372             while (--len != 0 && isspace(UChar(dst[len])))
373                 dst[len] = '\0';
374         }
375     }
376     return dst;
377 }
378
379 static FILE *
380 open_tempfile(char *filename)
381 {
382     FILE *result = 0;
383
384     _nc_STRCPY(filename, "/tmp/XXXXXX", PATH_MAX);
385 #if HAVE_MKSTEMP
386     {
387         int oldmask = (int) umask(077);
388         int fd = mkstemp(filename);
389         if (fd >= 0)
390             result = fdopen(fd, "w");
391         umask((mode_t) oldmask);
392     }
393 #else
394     if (tmpnam(filename) != 0)
395         result = fopen(filename, "w");
396 #endif
397     return result;
398 }
399
400 static FILE *
401 copy_input(FILE *source, const char *filename, char *alt_file)
402 {
403     char my_altfile[PATH_MAX];
404     FILE *result = 0;
405     FILE *target = 0;
406     int ch;
407
408     if (alt_file == 0)
409         alt_file = my_altfile;
410
411     if (source == 0) {
412         failed("copy_input (source)");
413     } else if ((target = open_tempfile(alt_file)) == 0) {
414         failed("copy_input (target)");
415     } else {
416         clearerr(source);
417         for (;;) {
418             ch = fgetc(source);
419             if (feof(source)) {
420                 break;
421             } else if (ferror(source)) {
422                 failed(filename);
423             } else if (ch == 0) {
424                 /* don't loop in case someone wants to convert /dev/zero */
425                 fprintf(stderr, "%s: %s is not a text-file\n", _nc_progname, filename);
426                 ExitProgram(EXIT_FAILURE);
427             }
428             fputc(ch, target);
429         }
430         fclose(source);
431         /*
432          * rewind() does not force the target file's data to disk (not does
433          * fflush()...).  So open a second stream on the data and then close
434          * the one that we were writing on before starting to read from the
435          * second stream.
436          */
437         result = fopen(alt_file, "r+");
438         fclose(target);
439         to_remove = strdup(alt_file);
440     }
441     return result;
442 }
443
444 static FILE *
445 open_input(const char *filename, char *alt_file)
446 {
447     FILE *fp;
448     struct stat sb;
449     int mode;
450
451     if (!strcmp(filename, "-")) {
452         fp = copy_input(stdin, STDIN_NAME, alt_file);
453     } else if (stat(filename, &sb) < 0) {
454         fprintf(stderr, "%s: %s %s\n", _nc_progname, filename, strerror(errno));
455         ExitProgram(EXIT_FAILURE);
456     } else if ((mode = (sb.st_mode & S_IFMT)) == S_IFDIR
457                || (mode != S_IFREG && mode != S_IFCHR && mode != S_IFIFO)) {
458         fprintf(stderr, "%s: %s is not a file\n", _nc_progname, filename);
459         ExitProgram(EXIT_FAILURE);
460     } else {
461         fp = fopen(filename, "r");
462
463         if (fp == 0) {
464             fprintf(stderr, "%s: Can't open %s\n", _nc_progname, filename);
465             ExitProgram(EXIT_FAILURE);
466         }
467         if (mode != S_IFREG) {
468             if (alt_file != 0) {
469                 FILE *fp2 = copy_input(fp, filename, alt_file);
470                 fp = fp2;
471             } else {
472                 fprintf(stderr, "%s: %s is not a file\n", _nc_progname, filename);
473                 ExitProgram(EXIT_FAILURE);
474             }
475         }
476     }
477     return fp;
478 }
479
480 /* Parse the "-e" option-value into a list of names */
481 static char **
482 make_namelist(char *src)
483 {
484     char **dst = 0;
485
486     char *s, *base;
487     unsigned pass, n, nn;
488     char buffer[BUFSIZ];
489
490     if (src == 0) {
491         /* EMPTY */ ;
492     } else if (strchr(src, '/') != 0) {         /* a filename */
493         FILE *fp = open_input(src, (char *) 0);
494
495         for (pass = 1; pass <= 2; pass++) {
496             nn = 0;
497             while (fgets(buffer, sizeof(buffer), fp) != 0) {
498                 if ((s = stripped(buffer)) != 0) {
499                     if (dst != 0)
500                         dst[nn] = s;
501                     else
502                         free(s);
503                     nn++;
504                 }
505             }
506             if (pass == 1) {
507                 if ((dst = typeCalloc(char *, nn + 1)) == 0)
508                       failed("make_namelist");
509                 rewind(fp);
510             }
511         }
512         fclose(fp);
513     } else {                    /* literal list of names */
514         for (pass = 1; pass <= 2; pass++) {
515             for (n = nn = 0, base = src;; n++) {
516                 int mark = src[n];
517                 if (mark == ',' || mark == '\0') {
518                     if (pass == 1) {
519                         nn++;
520                     } else {
521                         src[n] = '\0';
522                         if ((s = stripped(base)) != 0)
523                             dst[nn++] = s;
524                         base = &src[n + 1];
525                     }
526                 }
527                 if (mark == '\0')
528                     break;
529             }
530             if (pass == 1) {
531                 if ((dst = typeCalloc(char *, nn + 1)) == 0)
532                       failed("make_namelist");
533             }
534         }
535     }
536     if (showsummary && (dst != 0)) {
537         fprintf(log_fp, "Entries that will be compiled:\n");
538         for (n = 0; dst[n] != 0; n++)
539             fprintf(log_fp, "%u:%s\n", n + 1, dst[n]);
540     }
541     return dst;
542 }
543
544 static bool
545 matches(char **needle, const char *haystack)
546 /* does entry in needle list match |-separated field in haystack? */
547 {
548     bool code = FALSE;
549     size_t n;
550
551     if (needle != 0) {
552         for (n = 0; needle[n] != 0; n++) {
553             if (_nc_name_match(haystack, needle[n], "|")) {
554                 code = TRUE;
555                 break;
556             }
557         }
558     } else
559         code = TRUE;
560     return (code);
561 }
562
563 static char *
564 valid_db_path(const char *nominal)
565 {
566     struct stat sb;
567 #if USE_HASHED_DB
568     char suffix[] = DBM_SUFFIX;
569     size_t need = strlen(nominal) + sizeof(suffix);
570     char *result = malloc(need);
571
572     if (result == 0)
573         failed("valid_db_path");
574     _nc_STRCPY(result, nominal, need);
575     if (strcmp(result + need - sizeof(suffix), suffix)) {
576         _nc_STRCAT(result, suffix, need);
577     }
578 #else
579     char *result = strdup(nominal);
580 #endif
581
582     DEBUG(1, ("** stat(%s)", result));
583     if (stat(result, &sb) >= 0) {
584 #if USE_HASHED_DB
585         if (!S_ISREG(sb.st_mode)
586             || access(result, R_OK | W_OK) != 0) {
587             DEBUG(1, ("...not a writable file"));
588             free(result);
589             result = 0;
590         }
591 #else
592         if (!S_ISDIR(sb.st_mode)
593             || access(result, R_OK | W_OK | X_OK) != 0) {
594             DEBUG(1, ("...not a writable directory"));
595             free(result);
596             result = 0;
597         }
598 #endif
599     } else {
600         /* check if parent is directory and is writable */
601         unsigned leaf = _nc_pathlast(result);
602
603         DEBUG(1, ("...not found"));
604         if (leaf) {
605             char save = result[leaf];
606             result[leaf] = 0;
607             if (stat(result, &sb) >= 0
608                 && S_ISDIR(sb.st_mode)
609                 && access(result, R_OK | W_OK | X_OK) == 0) {
610                 result[leaf] = save;
611             } else {
612                 DEBUG(1, ("...parent directory %s is not writable", result));
613                 free(result);
614                 result = 0;
615             }
616         } else {
617             DEBUG(1, ("... no parent directory"));
618             free(result);
619             result = 0;
620         }
621     }
622     return result;
623 }
624
625 /*
626  * Show the databases to which tic could write.  The location to which it
627  * writes is always the first one.  If none are writable, print an error
628  * message.
629  */
630 static void
631 show_databases(const char *outdir)
632 {
633     bool specific = (outdir != 0) || getenv("TERMINFO") != 0;
634     char *result;
635     const char *tried = 0;
636
637     if (outdir == 0) {
638         outdir = _nc_tic_dir(0);
639     }
640     if ((result = valid_db_path(outdir)) != 0) {
641         printf("%s\n", result);
642         free(result);
643     } else {
644         tried = outdir;
645     }
646
647     if ((outdir = _nc_home_terminfo())) {
648         if ((result = valid_db_path(outdir)) != 0) {
649             printf("%s\n", result);
650             free(result);
651         } else if (!specific) {
652             tried = outdir;
653         }
654     }
655
656     /*
657      * If we can write in neither location, give an error message.
658      */
659     if (tried) {
660         fflush(stdout);
661         fprintf(stderr, "%s: %s (no permission)\n", _nc_progname, tried);
662         ExitProgram(EXIT_FAILURE);
663     }
664 }
665
666 static void
667 add_digit(int *target, int source)
668 {
669     *target = (*target * 10) + (source - '0');
670 }
671
672 #define VtoTrace(opt) (unsigned) ((opt > 0) ? opt : (opt == 0))
673
674 int
675 main(int argc, char *argv[])
676 {
677     char my_tmpname[PATH_MAX];
678     char my_altfile[PATH_MAX];
679     int v_opt = -1;
680     unsigned debug_level;
681     int smart_defaults = TRUE;
682     char *termcap;
683     ENTRY *qp;
684
685     int this_opt, last_opt = '?';
686
687     int outform = F_TERMINFO;   /* output format */
688     int sortmode = S_TERMINFO;  /* sort_mode */
689
690     int width = 60;
691     int height = 65535;
692     bool formatted = FALSE;     /* reformat complex strings? */
693     bool literal = FALSE;       /* suppress post-processing? */
694     int numbers = 0;            /* format "%'char'" to/from "%{number}" */
695     bool forceresolve = FALSE;  /* force resolution */
696     bool limited = TRUE;
697     char *tversion = (char *) NULL;
698     const char *source_file = "terminfo";
699     char *outdir = (char *) NULL;
700     bool check_only = FALSE;
701     bool suppress_untranslatable = FALSE;
702     int quickdump = 0;
703     bool quiet = FALSE;
704     bool wrap_strings = FALSE;
705
706     log_fp = stderr;
707
708     _nc_progname = _nc_rootname(argv[0]);
709     atexit(cleanup);
710
711     if ((infodump = same_program(_nc_progname, PROG_CAPTOINFO)) != FALSE) {
712         outform = F_TERMINFO;
713         sortmode = S_TERMINFO;
714     }
715     if ((capdump = same_program(_nc_progname, PROG_INFOTOCAP)) != FALSE) {
716         outform = F_TERMCAP;
717         sortmode = S_TERMCAP;
718     }
719 #if NCURSES_XNAMES
720     use_extended_names(FALSE);
721 #endif
722     _nc_strict_bsd = 0;
723
724     /*
725      * Processing arguments is a little complicated, since someone made a
726      * design decision to allow the numeric values for -w, -v options to
727      * be optional.
728      */
729     while ((this_opt = getopt(argc, argv,
730                               "0123456789CDIKLNQR:TUVWace:fGgo:qrstvwx")) != -1) {
731         if (isdigit(this_opt)) {
732             switch (last_opt) {
733             case 'Q':
734                 add_digit(&quickdump, this_opt);
735                 break;
736             case 'v':
737                 add_digit(&v_opt, this_opt);
738                 break;
739             case 'w':
740                 add_digit(&width, this_opt);
741                 break;
742             default:
743                 switch (this_opt) {
744                 case '0':
745                     last_opt = this_opt;
746                     width = 65535;
747                     height = 1;
748                     break;
749                 case '1':
750                     last_opt = this_opt;
751                     width = 0;
752                     break;
753                 default:
754                     usage();
755                 }
756             }
757             continue;
758         }
759         switch (this_opt) {
760         case 'K':
761             _nc_strict_bsd = 1;
762             /* the initial version of -K in 20110730 fell-thru here, but the
763              * same flag is useful when reading sources -TD
764              */
765             break;
766         case 'C':
767             capdump = TRUE;
768             outform = F_TERMCAP;
769             sortmode = S_TERMCAP;
770             break;
771         case 'D':
772             debug_level = VtoTrace(v_opt);
773             set_trace_level(debug_level);
774             show_databases(outdir);
775             ExitProgram(EXIT_SUCCESS);
776             break;
777         case 'I':
778             infodump = TRUE;
779             outform = F_TERMINFO;
780             sortmode = S_TERMINFO;
781             break;
782         case 'L':
783             infodump = TRUE;
784             outform = F_VARIABLE;
785             sortmode = S_VARIABLE;
786             break;
787         case 'N':
788             smart_defaults = FALSE;
789             literal = TRUE;
790             break;
791         case 'Q':
792             quickdump = 0;
793             break;
794         case 'R':
795             tversion = optarg;
796             break;
797         case 'T':
798             limited = FALSE;
799             break;
800         case 'U':
801             literal = TRUE;
802             break;
803         case 'V':
804             puts(curses_version());
805             ExitProgram(EXIT_SUCCESS);
806         case 'W':
807             wrap_strings = TRUE;
808             break;
809         case 'c':
810             check_only = TRUE;
811             break;
812         case 'e':
813             namelst = make_namelist(optarg);
814             break;
815         case 'f':
816             formatted = TRUE;
817             break;
818         case 'G':
819             numbers = 1;
820             break;
821         case 'g':
822             numbers = -1;
823             break;
824         case 'o':
825             outdir = optarg;
826             break;
827         case 'q':
828             quiet = TRUE;
829             break;
830         case 'r':
831             forceresolve = TRUE;
832             break;
833         case 's':
834             showsummary = TRUE;
835             break;
836         case 'v':
837             v_opt = 0;
838             break;
839         case 'w':
840             width = 0;
841             break;
842 #if NCURSES_XNAMES
843         case 't':
844             _nc_disable_period = FALSE;
845             suppress_untranslatable = TRUE;
846             break;
847         case 'a':
848             _nc_disable_period = TRUE;
849             /* FALLTHRU */
850         case 'x':
851             use_extended_names(TRUE);
852             break;
853 #endif
854         default:
855             usage();
856         }
857         last_opt = this_opt;
858     }
859
860     debug_level = VtoTrace(v_opt);
861     set_trace_level(debug_level);
862
863     if (_nc_tracing) {
864         save_check_termtype = _nc_check_termtype2;
865         _nc_check_termtype2 = check_termtype;
866     }
867 #if !HAVE_BIG_CORE
868     /*
869      * Aaargh! immedhook seriously hoses us!
870      *
871      * One problem with immedhook is it means we can't do -e.  Problem
872      * is that we can't guarantee that for each terminal listed, all the
873      * terminals it depends on will have been kept in core for reference
874      * resolution -- in fact it's certain the primitive types at the end
875      * of reference chains *won't* be in core unless they were explicitly
876      * in the select list themselves.
877      */
878     if (namelst && (!infodump && !capdump)) {
879         (void) fprintf(stderr,
880                        "%s: Sorry, -e can't be used without -I or -C\n",
881                        _nc_progname);
882         ExitProgram(EXIT_FAILURE);
883     }
884 #endif /* HAVE_BIG_CORE */
885
886     if (optind < argc) {
887         source_file = argv[optind++];
888         if (optind < argc) {
889             fprintf(stderr,
890                     "%s: Too many file names.  Usage:\n\t%s %s",
891                     _nc_progname,
892                     _nc_progname,
893                     usage_string);
894             ExitProgram(EXIT_FAILURE);
895         }
896     } else {
897         if (infodump == TRUE) {
898             /* captoinfo's no-argument case */
899             source_file = "/etc/termcap";
900             if ((termcap = getenv("TERMCAP")) != 0
901                 && (namelst = make_namelist(getenv("TERM"))) != 0) {
902                 if (access(termcap, F_OK) == 0) {
903                     /* file exists */
904                     source_file = termcap;
905                 } else {
906                     if ((tmp_fp = open_tempfile(my_tmpname)) != 0) {
907                         source_file = my_tmpname;
908                         fprintf(tmp_fp, "%s\n", termcap);
909                         fclose(tmp_fp);
910                         tmp_fp = open_input(source_file, (char *) 0);
911                         to_remove = source_file;
912                     } else {
913                         failed("tmpnam");
914                     }
915                 }
916             }
917         } else {
918             /* tic */
919             fprintf(stderr,
920                     "%s: File name needed.  Usage:\n\t%s %s",
921                     _nc_progname,
922                     _nc_progname,
923                     usage_string);
924             ExitProgram(EXIT_FAILURE);
925         }
926     }
927
928     if (tmp_fp == 0) {
929         tmp_fp = open_input(source_file, my_altfile);
930         if (!strcmp(source_file, "-")) {
931             source_file = STDIN_NAME;
932         }
933     }
934
935     if (infodump || check_only) {
936         dump_init(tversion,
937                   (smart_defaults
938                    ? outform
939                    : F_LITERAL),
940                   sortmode,
941                   wrap_strings, width, height,
942                   debug_level, formatted || check_only, check_only, quickdump);
943     } else if (capdump) {
944         dump_init(tversion,
945                   outform,
946                   sortmode,
947                   wrap_strings, width, height,
948                   debug_level, FALSE, FALSE, FALSE);
949     }
950
951     /* parse entries out of the source file */
952     _nc_set_source(source_file);
953 #if !HAVE_BIG_CORE
954     if (!(check_only || infodump || capdump))
955         _nc_set_writedir(outdir);
956 #endif /* HAVE_BIG_CORE */
957     _nc_read_entry_source(tmp_fp, (char *) NULL,
958                           !smart_defaults || literal, FALSE,
959                           ((check_only || infodump || capdump)
960                            ? NULLHOOK
961                            : immedhook));
962
963     /* do use resolution */
964     if (check_only || (!infodump && !capdump) || forceresolve) {
965         if (!_nc_resolve_uses2(TRUE, literal) && !check_only) {
966             ExitProgram(EXIT_FAILURE);
967         }
968     }
969
970     /* length check */
971     if (check_only && limited && (capdump || infodump)) {
972         for_entry_list(qp) {
973             if (matches(namelst, qp->tterm.term_names)) {
974                 int len = fmt_entry(&qp->tterm, NULL, FALSE, TRUE, infodump, numbers);
975
976                 if (len > (infodump ? MAX_TERMINFO_LENGTH : MAX_TERMCAP_LENGTH))
977                     (void) fprintf(stderr,
978                                    "warning: resolved %s entry is %d bytes long\n",
979                                    _nc_first_name(qp->tterm.term_names),
980                                    len);
981             }
982         }
983     }
984
985     /* write or dump all entries */
986     if (check_only) {
987         /* this is in case infotocap() generates warnings */
988         _nc_curr_col = _nc_curr_line = -1;
989
990         for_entry_list(qp) {
991             if (matches(namelst, qp->tterm.term_names)) {
992                 /* this is in case infotocap() generates warnings */
993                 _nc_set_type(_nc_first_name(qp->tterm.term_names));
994                 _nc_curr_line = (int) qp->startline;
995                 repair_acsc(&qp->tterm);
996                 dump_entry(&qp->tterm, suppress_untranslatable,
997                            limited, numbers, NULL);
998             }
999         }
1000     } else {
1001         if (!infodump && !capdump) {
1002             _nc_set_writedir(outdir);
1003             for_entry_list(qp) {
1004                 if (matches(namelst, qp->tterm.term_names))
1005                     write_it(qp);
1006             }
1007         } else {
1008             /* this is in case infotocap() generates warnings */
1009             _nc_curr_col = _nc_curr_line = -1;
1010
1011             for_entry_list(qp) {
1012                 if (matches(namelst, qp->tterm.term_names)) {
1013                     long j = qp->cend - qp->cstart;
1014                     int len = 0;
1015
1016                     /* this is in case infotocap() generates warnings */
1017                     _nc_set_type(_nc_first_name(qp->tterm.term_names));
1018
1019                     if (!quiet) {
1020                         (void) fseek(tmp_fp, qp->cstart, SEEK_SET);
1021                         while (j-- > 0) {
1022                             if (infodump)
1023                                 (void) putchar(fgetc(tmp_fp));
1024                             else
1025                                 put_translate(fgetc(tmp_fp));
1026                         }
1027                     }
1028
1029                     repair_acsc(&qp->tterm);
1030                     dump_entry(&qp->tterm, suppress_untranslatable,
1031                                limited, numbers, NULL);
1032                     for (j = 0; j < (long) qp->nuses; j++)
1033                         dump_uses(qp->uses[j].name, !capdump);
1034                     len = show_entry();
1035                     if (debug_level != 0 && !limited)
1036                         printf("# length=%d\n", len);
1037                 }
1038             }
1039             if (!namelst && _nc_tail && !quiet) {
1040                 int c, oldc = '\0';
1041                 bool in_comment = FALSE;
1042                 bool trailing_comment = FALSE;
1043
1044                 (void) fseek(tmp_fp, _nc_tail->cend, SEEK_SET);
1045                 while ((c = fgetc(tmp_fp)) != EOF) {
1046                     if (oldc == '\n') {
1047                         if (c == '#') {
1048                             trailing_comment = TRUE;
1049                             in_comment = TRUE;
1050                         } else {
1051                             in_comment = FALSE;
1052                         }
1053                     }
1054                     if (trailing_comment
1055                         && (in_comment || (oldc == '\n' && c == '\n')))
1056                         putchar(c);
1057                     oldc = c;
1058                 }
1059             }
1060         }
1061     }
1062
1063     /* Show the directory into which entries were written, and the total
1064      * number of entries
1065      */
1066     if (showsummary
1067         && (!(check_only || infodump || capdump))) {
1068         int total = _nc_tic_written();
1069         if (total != 0)
1070             fprintf(log_fp, "%d entries written to %s\n",
1071                     total,
1072                     _nc_tic_dir((char *) 0));
1073         else
1074             fprintf(log_fp, "No entries written\n");
1075     }
1076     ExitProgram(EXIT_SUCCESS);
1077 }
1078
1079 /*
1080  * This bit of legerdemain turns all the terminfo variable names into
1081  * references to locations in the arrays Booleans, Numbers, and Strings ---
1082  * precisely what's needed (see comp_parse.c).
1083  */
1084 #undef CUR
1085 #define CUR tp->
1086
1087 /*
1088  * Check if the alternate character-set capabilities are consistent.
1089  */
1090 static void
1091 check_acs(TERMTYPE *tp)
1092 {
1093     if (VALID_STRING(acs_chars)) {
1094         const char *boxes = "lmkjtuvwqxn";
1095         char mapped[256];
1096         char missing[256];
1097         const char *p;
1098         char *q;
1099
1100         memset(mapped, 0, sizeof(mapped));
1101         for (p = acs_chars; *p != '\0'; p += 2) {
1102             if (p[1] == '\0') {
1103                 _nc_warning("acsc has odd number of characters");
1104                 break;
1105             }
1106             mapped[UChar(p[0])] = p[1];
1107         }
1108
1109         if (mapped[UChar('I')] && !mapped[UChar('i')]) {
1110             _nc_warning("acsc refers to 'I', which is probably an error");
1111         }
1112
1113         for (p = boxes, q = missing; *p != '\0'; ++p) {
1114             if (!mapped[UChar(p[0])]) {
1115                 *q++ = p[0];
1116             }
1117         }
1118         *q = '\0';
1119
1120         assert(strlen(missing) <= strlen(boxes));
1121         if (*missing != '\0' && strcmp(missing, boxes)) {
1122             _nc_warning("acsc is missing some line-drawing mapping: %s", missing);
1123         }
1124     }
1125 }
1126
1127 /*
1128  * Check if the color capabilities are consistent
1129  */
1130 static void
1131 check_colors(TERMTYPE *tp)
1132 {
1133     if ((max_colors > 0) != (max_pairs > 0)
1134         || ((max_colors > max_pairs) && (initialize_pair == 0)))
1135         _nc_warning("inconsistent values for max_colors (%d) and max_pairs (%d)",
1136                     max_colors, max_pairs);
1137
1138     PAIRED(set_foreground, set_background);
1139     PAIRED(set_a_foreground, set_a_background);
1140     PAIRED(set_color_pair, initialize_pair);
1141
1142     if (VALID_STRING(set_foreground)
1143         && VALID_STRING(set_a_foreground)
1144         && !_nc_capcmp(set_foreground, set_a_foreground))
1145         _nc_warning("expected setf/setaf to be different");
1146
1147     if (VALID_STRING(set_background)
1148         && VALID_STRING(set_a_background)
1149         && !_nc_capcmp(set_background, set_a_background))
1150         _nc_warning("expected setb/setab to be different");
1151
1152     /* see: has_colors() */
1153     if (VALID_NUMERIC(max_colors) && VALID_NUMERIC(max_pairs)
1154         && (((set_foreground != NULL)
1155              && (set_background != NULL))
1156             || ((set_a_foreground != NULL)
1157                 && (set_a_background != NULL))
1158             || set_color_pair)) {
1159         if (!VALID_STRING(orig_pair) && !VALID_STRING(orig_colors))
1160             _nc_warning("expected either op/oc string for resetting colors");
1161     }
1162     if (can_change) {
1163         if (!VALID_STRING(initialize_pair) &&
1164             !VALID_STRING(initialize_color)) {
1165             _nc_warning("expected initc or initp because ccc is given");
1166         }
1167     } else {
1168         if (VALID_STRING(initialize_pair) ||
1169             VALID_STRING(initialize_color)) {
1170             _nc_warning("expected ccc because initc is given");
1171         }
1172     }
1173 }
1174
1175 static int
1176 csi_length(const char *value)
1177 {
1178     int result = 0;
1179
1180     if (value[0] == '\033' && value[1] == '[') {
1181         result = 2;
1182     } else if (UChar(value[0]) == 0x9a) {
1183         result = 1;
1184     }
1185     return result;
1186 }
1187
1188 static char
1189 keypad_final(const char *string)
1190 {
1191     char result = '\0';
1192
1193     if (VALID_STRING(string)
1194         && *string++ == '\033'
1195         && *string++ == 'O'
1196         && strlen(string) == 1) {
1197         result = *string;
1198     }
1199
1200     return result;
1201 }
1202
1203 static long
1204 keypad_index(const char *string)
1205 {
1206     char *test;
1207     const char *list = "PQRSwxymtuvlqrsPpn";    /* app-keypad except "Enter" */
1208     int ch;
1209     long result = -1;
1210
1211     if ((ch = keypad_final(string)) != '\0') {
1212         test = (strchr) (list, ch);
1213         if (test != 0)
1214             result = (long) (test - list);
1215     }
1216     return result;
1217 }
1218
1219 /*
1220  * list[] is down, up, left, right
1221  * "left" may be ^H rather than \E[D
1222  * "down" may be ^J rather than \E[B
1223  * But up/right are generally consistently escape sequences for ANSI terminals.
1224  */
1225 static void
1226 check_ansi_cursor(char *list[4])
1227 {
1228     int j, k;
1229     int want;
1230     size_t suffix;
1231     bool skip[4];
1232     bool repeated = FALSE;
1233
1234     for (j = 0; j < 4; ++j) {
1235         skip[j] = FALSE;
1236         for (k = 0; k < j; ++k) {
1237             if (j != k
1238                 && !strcmp(list[j], list[k])) {
1239                 char *value = _nc_tic_expand(list[k], TRUE, 0);
1240                 _nc_warning("repeated cursor control %s\n", value);
1241                 repeated = TRUE;
1242             }
1243         }
1244     }
1245     if (!repeated) {
1246         char *up = list[1];
1247         size_t prefix = (size_t) csi_length(up);
1248
1249         if (prefix) {
1250             suffix = prefix;
1251             while (up[suffix] && isdigit(UChar(up[suffix])))
1252                 ++suffix;
1253         }
1254         if (prefix && up[suffix] == 'A') {
1255             skip[1] = TRUE;
1256             if (!strcmp(list[0], "\n"))
1257                 skip[0] = TRUE;
1258             if (!strcmp(list[2], "\b"))
1259                 skip[2] = TRUE;
1260
1261             for (j = 0; j < 4; ++j) {
1262                 if (skip[j] || strlen(list[j]) == 1)
1263                     continue;
1264                 if (memcmp(list[j], up, prefix)) {
1265                     char *value = _nc_tic_expand(list[j], TRUE, 0);
1266                     _nc_warning("inconsistent prefix for %s\n", value);
1267                     continue;
1268                 }
1269                 if (strlen(list[j]) < suffix) {
1270                     char *value = _nc_tic_expand(list[j], TRUE, 0);
1271                     _nc_warning("inconsistent length for %s, expected %d\n",
1272                                 value, (int) suffix + 1);
1273                     continue;
1274                 }
1275                 want = "BADC"[j];
1276                 if (list[j][suffix] != want) {
1277                     char *value = _nc_tic_expand(list[j], TRUE, 0);
1278                     _nc_warning("inconsistent suffix for %s, expected %c, have %c\n",
1279                                 value, want, list[j][suffix]);
1280                 }
1281             }
1282         }
1283     }
1284 }
1285
1286 #define EXPECTED(name) if (!PRESENT(name)) _nc_warning("expected " #name)
1287 #define UNEXPECTED(name) if (PRESENT(name)) _nc_warning("unexpected " #name ", for %s", why)
1288
1289 static void
1290 check_noaddress(TERMTYPE *tp, const char *why)
1291 {
1292     UNEXPECTED(column_address);
1293     UNEXPECTED(cursor_address);
1294     UNEXPECTED(cursor_home);
1295     UNEXPECTED(cursor_mem_address);
1296     UNEXPECTED(cursor_to_ll);
1297     UNEXPECTED(row_address);
1298     UNEXPECTED(row_address);
1299 }
1300
1301 static void
1302 check_cursor(TERMTYPE *tp)
1303 {
1304     int count;
1305     char *list[4];
1306
1307     if (hard_copy) {
1308         check_noaddress(tp, "hard_copy");
1309     } else if (generic_type) {
1310         check_noaddress(tp, "generic_type");
1311     } else if (strchr(tp->term_names, '+') == 0) {
1312         int y = 0;
1313         int x = 0;
1314         if (PRESENT(column_address))
1315             ++y;
1316         if (PRESENT(cursor_address))
1317             y = x = 10;
1318         if (PRESENT(cursor_home))
1319             ++y, ++x;
1320         if (PRESENT(cursor_mem_address))
1321             y = x = 10;
1322         if (PRESENT(cursor_to_ll))
1323             ++y, ++x;
1324         if (PRESENT(row_address))
1325             ++x;
1326         if (PRESENT(cursor_down))
1327             ++y;
1328         if (PRESENT(cursor_up))
1329             ++y;
1330         if (PRESENT(cursor_left))
1331             ++x;
1332         if (PRESENT(cursor_right))
1333             ++x;
1334         if (x < 2 && y < 2) {
1335             _nc_warning("terminal lacks cursor addressing");
1336         } else {
1337             if (x < 2)
1338                 _nc_warning("terminal lacks cursor column-addressing");
1339             if (y < 2)
1340                 _nc_warning("terminal lacks cursor row-addressing");
1341         }
1342     }
1343
1344     /* it is rare to have an insert-line feature without a matching delete */
1345     ANDMISSING(parm_insert_line, insert_line);
1346     ANDMISSING(parm_delete_line, delete_line);
1347     ANDMISSING(parm_insert_line, parm_delete_line);
1348
1349     /* if we have a parameterized form, then the non-parameterized is easy */
1350     ANDMISSING(parm_down_cursor, cursor_down);
1351     ANDMISSING(parm_up_cursor, cursor_up);
1352     ANDMISSING(parm_left_cursor, cursor_left);
1353     ANDMISSING(parm_right_cursor, cursor_right);
1354
1355     /* Given any of a set of cursor movement, the whole set should be present.
1356      * Technically this is not true (we could use cursor_address to fill in
1357      * unsupported controls), but it is likely.
1358      */
1359     count = 0;
1360     if (PRESENT(parm_down_cursor)) {
1361         list[count++] = parm_down_cursor;
1362     }
1363     if (PRESENT(parm_up_cursor)) {
1364         list[count++] = parm_up_cursor;
1365     }
1366     if (PRESENT(parm_left_cursor)) {
1367         list[count++] = parm_left_cursor;
1368     }
1369     if (PRESENT(parm_right_cursor)) {
1370         list[count++] = parm_right_cursor;
1371     }
1372     if (count == 4) {
1373         check_ansi_cursor(list);
1374     } else if (count != 0) {
1375         EXPECTED(parm_down_cursor);
1376         EXPECTED(parm_up_cursor);
1377         EXPECTED(parm_left_cursor);
1378         EXPECTED(parm_right_cursor);
1379     }
1380
1381     count = 0;
1382     if (PRESENT(cursor_down)) {
1383         list[count++] = cursor_down;
1384     }
1385     if (PRESENT(cursor_up)) {
1386         list[count++] = cursor_up;
1387     }
1388     if (PRESENT(cursor_left)) {
1389         list[count++] = cursor_left;
1390     }
1391     if (PRESENT(cursor_right)) {
1392         list[count++] = cursor_right;
1393     }
1394     if (count == 4) {
1395         check_ansi_cursor(list);
1396     } else if (count != 0) {
1397         count = 0;
1398         if (PRESENT(cursor_down) && strcmp(cursor_down, "\n"))
1399             ++count;
1400         if (PRESENT(cursor_left) && strcmp(cursor_left, "\b"))
1401             ++count;
1402         if (PRESENT(cursor_up) && strlen(cursor_up) > 1)
1403             ++count;
1404         if (PRESENT(cursor_right) && strlen(cursor_right) > 1)
1405             ++count;
1406         if (count) {
1407             EXPECTED(cursor_down);
1408             EXPECTED(cursor_up);
1409             EXPECTED(cursor_left);
1410             EXPECTED(cursor_right);
1411         }
1412     }
1413 }
1414
1415 #define MAX_KP 5
1416 /*
1417  * Do a quick sanity-check for vt100-style keypads to see if the 5-key keypad
1418  * is mapped inconsistently.
1419  */
1420 static void
1421 check_keypad(TERMTYPE *tp)
1422 {
1423     char show[80];
1424
1425     if (VALID_STRING(key_a1) &&
1426         VALID_STRING(key_a3) &&
1427         VALID_STRING(key_b2) &&
1428         VALID_STRING(key_c1) &&
1429         VALID_STRING(key_c3)) {
1430         char final[MAX_KP + 1];
1431         long list[MAX_KP];
1432         int increase = 0;
1433         int j, k, kk;
1434         long last;
1435         long test;
1436
1437         final[0] = keypad_final(key_a1);
1438         final[1] = keypad_final(key_a3);
1439         final[2] = keypad_final(key_b2);
1440         final[3] = keypad_final(key_c1);
1441         final[4] = keypad_final(key_c3);
1442         final[5] = '\0';
1443
1444         /* special case: legacy coding using 1,2,3,0,. on the bottom */
1445         assert(strlen(final) <= MAX_KP);
1446         if (!strcmp(final, "qsrpn"))
1447             return;
1448
1449         list[0] = keypad_index(key_a1);
1450         list[1] = keypad_index(key_a3);
1451         list[2] = keypad_index(key_b2);
1452         list[3] = keypad_index(key_c1);
1453         list[4] = keypad_index(key_c3);
1454
1455         /* check that they're all vt100 keys */
1456         for (j = 0; j < MAX_KP; ++j) {
1457             if (list[j] < 0) {
1458                 return;
1459             }
1460         }
1461
1462         /* check if they're all in increasing order */
1463         for (j = 1; j < MAX_KP; ++j) {
1464             if (list[j] > list[j - 1]) {
1465                 ++increase;
1466             }
1467         }
1468         if (increase != (MAX_KP - 1)) {
1469             show[0] = '\0';
1470
1471             for (j = 0, last = -1; j < MAX_KP; ++j) {
1472                 for (k = 0, kk = -1, test = 100; k < 5; ++k) {
1473                     if (list[k] > last &&
1474                         list[k] < test) {
1475                         test = list[k];
1476                         kk = k;
1477                     }
1478                 }
1479                 last = test;
1480                 assert(strlen(show) < (MAX_KP * 4));
1481                 switch (kk) {
1482                 case 0:
1483                     _nc_STRCAT(show, " ka1", sizeof(show));
1484                     break;
1485                 case 1:
1486                     _nc_STRCAT(show, " ka3", sizeof(show));
1487                     break;
1488                 case 2:
1489                     _nc_STRCAT(show, " kb2", sizeof(show));
1490                     break;
1491                 case 3:
1492                     _nc_STRCAT(show, " kc1", sizeof(show));
1493                     break;
1494                 case 4:
1495                     _nc_STRCAT(show, " kc3", sizeof(show));
1496                     break;
1497                 }
1498             }
1499
1500             _nc_warning("vt100 keypad order inconsistent: %s", show);
1501         }
1502
1503     } else if (VALID_STRING(key_a1) ||
1504                VALID_STRING(key_a3) ||
1505                VALID_STRING(key_b2) ||
1506                VALID_STRING(key_c1) ||
1507                VALID_STRING(key_c3)) {
1508         show[0] = '\0';
1509         if (keypad_index(key_a1) >= 0)
1510             _nc_STRCAT(show, " ka1", sizeof(show));
1511         if (keypad_index(key_a3) >= 0)
1512             _nc_STRCAT(show, " ka3", sizeof(show));
1513         if (keypad_index(key_b2) >= 0)
1514             _nc_STRCAT(show, " kb2", sizeof(show));
1515         if (keypad_index(key_c1) >= 0)
1516             _nc_STRCAT(show, " kc1", sizeof(show));
1517         if (keypad_index(key_c3) >= 0)
1518             _nc_STRCAT(show, " kc3", sizeof(show));
1519         if (*show != '\0')
1520             _nc_warning("vt100 keypad map incomplete:%s", show);
1521     }
1522
1523     /*
1524      * These warnings are useful for consistency checks - it is possible that
1525      * there are real terminals with mismatches in these
1526      */
1527     ANDMISSING(key_ic, key_dc);
1528 }
1529
1530 static void
1531 check_printer(TERMTYPE *tp)
1532 {
1533     PAIRED(enter_doublewide_mode, exit_doublewide_mode);
1534     PAIRED(enter_italics_mode, exit_italics_mode);
1535     PAIRED(enter_leftward_mode, exit_leftward_mode);
1536     PAIRED(enter_micro_mode, exit_micro_mode);
1537     PAIRED(enter_shadow_mode, exit_shadow_mode);
1538     PAIRED(enter_subscript_mode, exit_subscript_mode);
1539     PAIRED(enter_superscript_mode, exit_superscript_mode);
1540     PAIRED(enter_upward_mode, exit_upward_mode);
1541
1542     ANDMISSING(start_char_set_def, stop_char_set_def);
1543
1544     /* if we have a parameterized form, then the non-parameterized is easy */
1545     ANDMISSING(set_bottom_margin_parm, set_bottom_margin);
1546     ANDMISSING(set_left_margin_parm, set_left_margin);
1547     ANDMISSING(set_right_margin_parm, set_right_margin);
1548     ANDMISSING(set_top_margin_parm, set_top_margin);
1549
1550     ANDMISSING(parm_down_micro, micro_down);
1551     ANDMISSING(parm_left_micro, micro_left);
1552     ANDMISSING(parm_right_micro, micro_right);
1553     ANDMISSING(parm_up_micro, micro_up);
1554 }
1555
1556 static bool
1557 uses_SGR_39_49(const char *value)
1558 {
1559     return (strstr(value, "39;49") != 0
1560             || strstr(value, "49;39") != 0);
1561 }
1562
1563 /*
1564  * Check consistency of termcap extensions related to "screen".
1565  */
1566 static void
1567 check_screen(TERMTYPE *tp)
1568 {
1569 #if NCURSES_XNAMES
1570     if (_nc_user_definable) {
1571         int have_XT = tigetflag("XT");
1572         int have_XM = tigetflag("XM");
1573         int have_bce = back_color_erase;
1574         bool have_kmouse = FALSE;
1575         bool use_sgr_39_49 = FALSE;
1576         char *name = _nc_first_name(tp->term_names);
1577
1578         if (!VALID_BOOLEAN(have_bce)) {
1579             have_bce = FALSE;
1580         }
1581         if (!VALID_BOOLEAN(have_XM)) {
1582             have_XM = FALSE;
1583         }
1584         if (!VALID_BOOLEAN(have_XT)) {
1585             have_XT = FALSE;
1586         }
1587         if (VALID_STRING(key_mouse)) {
1588             have_kmouse = !strcmp("\033[M", key_mouse);
1589         }
1590         if (VALID_STRING(orig_colors)) {
1591             use_sgr_39_49 = uses_SGR_39_49(orig_colors);
1592         } else if (VALID_STRING(orig_pair)) {
1593             use_sgr_39_49 = uses_SGR_39_49(orig_pair);
1594         }
1595
1596         if (have_XM && have_XT) {
1597             _nc_warning("Screen's XT capability conflicts with XM");
1598         } else if (have_XT
1599                    && strstr(name, "screen") != 0
1600                    && strchr(name, '.') != 0) {
1601             _nc_warning("Screen's \"screen\" entries should not have XT set");
1602         } else if (have_XT) {
1603             if (!have_kmouse && have_bce) {
1604                 if (VALID_STRING(key_mouse)) {
1605                     _nc_warning("Value of kmous inconsistent with screen's usage");
1606                 } else {
1607                     _nc_warning("Expected kmous capability with XT");
1608                 }
1609             }
1610             if (!have_bce && max_colors > 0)
1611                 _nc_warning("Expected bce capability with XT");
1612             if (!use_sgr_39_49 && have_bce && max_colors > 0)
1613                 _nc_warning("Expected orig_colors capability with XT to have 39/49 parameters");
1614             if (VALID_STRING(to_status_line))
1615                 _nc_warning("\"tsl\" capability is redundant, given XT");
1616         } else {
1617             if (have_kmouse && !have_XM)
1618                 _nc_warning("Expected XT to be set, given kmous");
1619         }
1620     }
1621 #endif
1622 }
1623
1624 /*
1625  * Returns the expected number of parameters for the given capability.
1626  */
1627 static int
1628 expected_params(const char *name)
1629 {
1630 #define DATA(name,count) { { name }, count }
1631     /* *INDENT-OFF* */
1632     static const struct {
1633         const char name[9];
1634         int count;
1635     } table[] = {
1636         DATA( "S0",             1 ),    /* 'screen' extension */
1637         DATA( "birep",          2 ),
1638         DATA( "chr",            1 ),
1639         DATA( "colornm",        1 ),
1640         DATA( "cpi",            1 ),
1641         DATA( "csnm",           1 ),
1642         DATA( "csr",            2 ),
1643         DATA( "cub",            1 ),
1644         DATA( "cud",            1 ),
1645         DATA( "cuf",            1 ),
1646         DATA( "cup",            2 ),
1647         DATA( "cuu",            1 ),
1648         DATA( "cvr",            1 ),
1649         DATA( "cwin",           5 ),
1650         DATA( "dch",            1 ),
1651         DATA( "defc",           3 ),
1652         DATA( "dial",           1 ),
1653         DATA( "dispc",          1 ),
1654         DATA( "dl",             1 ),
1655         DATA( "ech",            1 ),
1656         DATA( "getm",           1 ),
1657         DATA( "hpa",            1 ),
1658         DATA( "ich",            1 ),
1659         DATA( "il",             1 ),
1660         DATA( "indn",           1 ),
1661         DATA( "initc",          4 ),
1662         DATA( "initp",          7 ),
1663         DATA( "lpi",            1 ),
1664         DATA( "mc5p",           1 ),
1665         DATA( "mrcup",          2 ),
1666         DATA( "mvpa",           1 ),
1667         DATA( "pfkey",          2 ),
1668         DATA( "pfloc",          2 ),
1669         DATA( "pfx",            2 ),
1670         DATA( "pfxl",           3 ),
1671         DATA( "pln",            2 ),
1672         DATA( "qdial",          1 ),
1673         DATA( "rcsd",           1 ),
1674         DATA( "rep",            2 ),
1675         DATA( "rin",            1 ),
1676         DATA( "sclk",           3 ),
1677         DATA( "scp",            1 ),
1678         DATA( "scs",            1 ),
1679         DATA( "scsd",           2 ),
1680         DATA( "setab",          1 ),
1681         DATA( "setaf",          1 ),
1682         DATA( "setb",           1 ),
1683         DATA( "setcolor",       1 ),
1684         DATA( "setf",           1 ),
1685         DATA( "sgr",            9 ),
1686         DATA( "sgr1",           6 ),
1687         DATA( "slength",        1 ),
1688         DATA( "slines",         1 ),
1689         DATA( "smgbp",          1 ),    /* 2 if smgtp is not given */
1690         DATA( "smglp",          1 ),
1691         DATA( "smglr",          2 ),
1692         DATA( "smgrp",          1 ),
1693         DATA( "smgtb",          2 ),
1694         DATA( "smgtp",          1 ),
1695         DATA( "tsl",            1 ),
1696         DATA( "u6",             -1 ),
1697         DATA( "vpa",            1 ),
1698         DATA( "wind",           4 ),
1699         DATA( "wingo",          1 ),
1700     };
1701     /* *INDENT-ON* */
1702
1703 #undef DATA
1704
1705     unsigned n;
1706     int result = 0;             /* function-keys, etc., use none */
1707
1708     for (n = 0; n < SIZEOF(table); n++) {
1709         if (!strcmp(name, table[n].name)) {
1710             result = table[n].count;
1711             break;
1712         }
1713     }
1714
1715     return result;
1716 }
1717
1718 /*
1719  * Make a quick sanity check for the parameters which are used in the given
1720  * strings.  If there are no "%p" tokens, then there should be no other "%"
1721  * markers.
1722  */
1723 static void
1724 check_params(TERMTYPE *tp, const char *name, char *value)
1725 {
1726     int expected = expected_params(name);
1727     int actual = 0;
1728     int n;
1729     bool params[NUM_PARM];
1730     char *s = value;
1731
1732 #ifdef set_top_margin_parm
1733     if (!strcmp(name, "smgbp")
1734         && set_top_margin_parm == 0)
1735         expected = 2;
1736 #endif
1737
1738     for (n = 0; n < NUM_PARM; n++)
1739         params[n] = FALSE;
1740
1741     while (*s != 0) {
1742         if (*s == '%') {
1743             if (*++s == '\0') {
1744                 _nc_warning("expected character after %% in %s", name);
1745                 break;
1746             } else if (*s == 'p') {
1747                 if (*++s == '\0' || !isdigit((int) *s)) {
1748                     _nc_warning("expected digit after %%p in %s", name);
1749                     return;
1750                 } else {
1751                     n = (*s - '0');
1752                     if (n > actual)
1753                         actual = n;
1754                     params[n] = TRUE;
1755                 }
1756             }
1757         }
1758         s++;
1759     }
1760
1761     if (params[0]) {
1762         _nc_warning("%s refers to parameter 0 (%%p0), which is not allowed", name);
1763     }
1764     if (value == set_attributes || expected < 0) {
1765         ;
1766     } else if (expected != actual) {
1767         _nc_warning("%s uses %d parameters, expected %d", name,
1768                     actual, expected);
1769         for (n = 1; n < actual; n++) {
1770             if (!params[n])
1771                 _nc_warning("%s omits parameter %d", name, n);
1772         }
1773     }
1774 }
1775
1776 static bool
1777 line_capability(const char *name)
1778 {
1779     bool result = FALSE;
1780     static const char *table[] =
1781     {
1782         "csr",                  /* change_scroll_region          */
1783         "clear",                /* clear_screen                  */
1784         "ed",                   /* clr_eos                       */
1785         "cwin",                 /* create_window                 */
1786         "cup",                  /* cursor_address                */
1787         "cud1",                 /* cursor_down                   */
1788         "home",                 /* cursor_home                   */
1789         "mrcup",                /* cursor_mem_address            */
1790         "ll",                   /* cursor_to_ll                  */
1791         "cuu1",                 /* cursor_up                     */
1792         "dl1",                  /* delete_line                   */
1793         "hd",                   /* down_half_line                */
1794         "flash",                /* flash_screen                  */
1795         "ff",                   /* form_feed                     */
1796         "il1",                  /* insert_line                   */
1797         "nel",                  /* newline                       */
1798         "dl",                   /* parm_delete_line              */
1799         "cud",                  /* parm_down_cursor              */
1800         "indn",                 /* parm_index                    */
1801         "il",                   /* parm_insert_line              */
1802         "rin",                  /* parm_rindex                   */
1803         "cuu",                  /* parm_up_cursor                */
1804         "mc0",                  /* print_screen                  */
1805         "vpa",                  /* row_address                   */
1806         "ind",                  /* scroll_forward                */
1807         "ri",                   /* scroll_reverse                */
1808         "hu",                   /* up_half_line                  */
1809     };
1810     size_t n;
1811     for (n = 0; n < SIZEOF(table); ++n) {
1812         if (!strcmp(name, table[n])) {
1813             result = TRUE;
1814             break;
1815         }
1816     }
1817     return result;
1818 }
1819
1820 /*
1821  * Check for DEC VT100 private mode for reverse video.
1822  */
1823 static const char *
1824 skip_DECSCNM(const char *value, int *flag)
1825 {
1826     *flag = -1;
1827     if (value != 0) {
1828         int skip = csi_length(value);
1829         fprintf(stderr, "test %d:%s\n", skip, value);
1830         if (skip > 0 &&
1831             value[skip++] == '?' &&
1832             value[skip++] == '5') {
1833             if (value[skip] == 'h') {
1834                 *flag = 1;
1835             } else if (value[skip] == 'l') {
1836                 *flag = 0;
1837             }
1838             value += skip + 1;
1839         }
1840     }
1841     return value;
1842 }
1843
1844 static void
1845 check_delays(const char *name, const char *value)
1846 {
1847     const char *p, *q;
1848     const char *first = 0;
1849     const char *last = 0;
1850
1851     for (p = value; *p != '\0'; ++p) {
1852         if (p[0] == '$' && p[1] == '<') {
1853             const char *base = p + 2;
1854             const char *mark = 0;
1855             bool maybe = TRUE;
1856             bool mixed = FALSE;
1857             int proportional = 0;
1858             int mandatory = 0;
1859
1860             first = p;
1861
1862             for (q = base; *q != '\0'; ++q) {
1863                 if (*q == '>') {
1864                     if (mark == 0)
1865                         mark = q;
1866                     break;
1867                 } else if (*q == '*' || *q == '/') {
1868                     if (*q == '*')
1869                         ++proportional;
1870                     if (*q == '/')
1871                         ++mandatory;
1872                     if (mark == 0)
1873                         mark = q;
1874                 } else if (!(isalnum(UChar(*q)) || strchr("+-.", *q) != 0)) {
1875                     maybe = FALSE;
1876                     break;
1877                 } else if (proportional || mandatory) {
1878                     mixed = TRUE;
1879                 }
1880             }
1881             last = *q ? (q + 1) : q;
1882             if (*q == '\0') {
1883                 maybe = FALSE;  /* just an isolated "$<" */
1884             } else if (maybe) {
1885                 float check_f;
1886                 char check_c;
1887                 int rc = sscanf(base, "%f%c", &check_f, &check_c);
1888                 if ((rc != 2) || (check_c != *mark) || mixed) {
1889                     _nc_warning("syntax error in %s delay '%.*s'", name,
1890                                 (int) (q - base), base);
1891                 } else if (*name == 'k') {
1892                     _nc_warning("function-key %s has delay", name);
1893                 } else if (proportional && !line_capability(name)) {
1894                     _nc_warning("non-line capability using proportional delay: %s", name);
1895                 }
1896             } else {
1897                 p = q - 1;      /* restart scan */
1898             }
1899         }
1900     }
1901
1902     if (!strcmp(name, "flash") ||
1903         !strcmp(name, "beep")) {
1904
1905         if (first != 0) {
1906             if (first == value || *last == 0) {
1907                 /*
1908                  * Delay is on one end or the other.
1909                  */
1910                 _nc_warning("expected delay embedded within %s", name);
1911             }
1912         } else {
1913             int flag;
1914
1915             /*
1916              * Check for missing delay when using VT100 reverse-video.
1917              * A real VT100 might not need this, but terminal emulators do.
1918              */
1919             if ((p = skip_DECSCNM(value, &flag)) != 0 &&
1920                 flag > 0 &&
1921                 (q = skip_DECSCNM(p, &flag)) != 0 &&
1922                 flag == 0) {
1923                 _nc_warning("expected a delay in %s", name);
1924             }
1925         }
1926     }
1927 }
1928
1929 static char *
1930 check_1_infotocap(const char *name, NCURSES_CONST char *value, int count)
1931 {
1932     int k;
1933     int ignored;
1934     long numbers[1 + NUM_PARM];
1935     char *strings[1 + NUM_PARM];
1936     char *p_is_s[NUM_PARM];
1937     char *result;
1938     char blob[NUM_PARM * 10];
1939     char *next = blob;
1940
1941     *next++ = '\0';
1942     for (k = 1; k <= NUM_PARM; k++) {
1943         numbers[k] = count;
1944         _nc_SPRINTF(next,
1945                     _nc_SLIMIT(sizeof(blob) - (next - blob))
1946                     "XYZ%d", count);
1947         strings[k] = next;
1948         next += strlen(next) + 1;
1949     }
1950
1951     switch (tparm_type(name)) {
1952     case Num_Str:
1953         result = TPARM_2(value, numbers[1], strings[2]);
1954         break;
1955     case Num_Str_Str:
1956         result = TPARM_3(value, numbers[1], strings[2], strings[3]);
1957         break;
1958     case Numbers:
1959     default:
1960         (void) _nc_tparm_analyze(value, p_is_s, &ignored);
1961 #define myParam(n) (p_is_s[n - 1] != 0 ? ((TPARM_ARG) strings[n]) : numbers[n])
1962         result = TPARM_9(value,
1963                          myParam(1),
1964                          myParam(2),
1965                          myParam(3),
1966                          myParam(4),
1967                          myParam(5),
1968                          myParam(6),
1969                          myParam(7),
1970                          myParam(8),
1971                          myParam(9));
1972         break;
1973     }
1974     return result;
1975 }
1976
1977 #define IsDelay(ch) ((ch) == '.' || isdigit(UChar(ch)))
1978
1979 static const char *
1980 parse_delay_value(const char *src, double *delays, int *always)
1981 {
1982     int star = 0;
1983
1984     *delays = 0.0;
1985     if (always)
1986         *always = 0;
1987
1988     while (isdigit(UChar(*src))) {
1989         (*delays) = (*delays) * 10 + (*src++ - '0');
1990     }
1991     if (*src == '.') {
1992         int gotdot = 1;
1993
1994         ++src;
1995         while (isdigit(UChar(*src))) {
1996             gotdot *= 10;
1997             (*delays) += (*src++ - '0') / gotdot;
1998         }
1999     }
2000     while (*src == '*' || *src == '/') {
2001         if (always == 0 && *src == '/')
2002             break;
2003         if (*src++ == '*') {
2004             star = 1;
2005         } else {
2006             *always = 1;
2007         }
2008     }
2009     if (star)
2010         *delays = -(*delays);
2011     return src;
2012 }
2013
2014 static const char *
2015 parse_ti_delay(const char *ti, double *delays)
2016 {
2017     *delays = 0.0;
2018     while (*ti != '\0') {
2019         if (*ti == '\\') {
2020             ++ti;
2021         }
2022         if (ti[0] == '$'
2023             && ti[1] == '<'
2024             && IsDelay(UChar(ti[2]))) {
2025             int ignored;
2026             const char *last = parse_delay_value(ti + 2, delays, &ignored);
2027             if (*last == '>') {
2028                 ti = last;
2029             }
2030         } else {
2031             ++ti;
2032         }
2033     }
2034     return ti;
2035 }
2036
2037 static const char *
2038 parse_tc_delay(const char *tc, double *delays)
2039 {
2040     return parse_delay_value(tc, delays, (int *) 0);
2041 }
2042
2043 /*
2044  * Compare terminfo- and termcap-strings, factoring out delays.
2045  */
2046 static bool
2047 same_ti_tc(const char *ti, const char *tc, bool * embedded)
2048 {
2049     bool same = TRUE;
2050     double ti_delay = 0.0;
2051     double tc_delay = 0.0;
2052     const char *ti_last;
2053
2054     *embedded = FALSE;
2055     ti_last = parse_ti_delay(ti, &ti_delay);
2056     tc = parse_tc_delay(tc, &tc_delay);
2057
2058     while ((ti < ti_last) && *tc) {
2059         if (*ti == '\\' && ispunct(UChar(ti[1]))) {
2060             ++ti;
2061             if ((*ti == '^') && !strncmp(tc, "\\136", 4)) {
2062                 ti += 1;
2063                 tc += 4;
2064                 continue;
2065             }
2066         } else if (ti[0] == '$' && ti[1] == '<') {
2067             double no_delay;
2068             const char *ss = parse_ti_delay(ti, &no_delay);
2069             if (ss != ti) {
2070                 *embedded = TRUE;
2071                 ti = ss;
2072                 continue;
2073             }
2074         }
2075         if (*tc == '\\' && ispunct(UChar(tc[1]))) {
2076             ++tc;
2077         }
2078         if (*ti++ != *tc++) {
2079             same = FALSE;
2080             break;
2081         }
2082     }
2083
2084     if (*embedded) {
2085         if (same) {
2086             same = FALSE;
2087         } else {
2088             *embedded = FALSE;  /* report only one problem */
2089         }
2090     }
2091
2092     return same;
2093 }
2094
2095 /*
2096  * Check terminfo to termcap translation.
2097  */
2098 static void
2099 check_infotocap(TERMTYPE *tp, int i, const char *value)
2100 {
2101     const char *name = ExtStrname(tp, i, strnames);
2102     int params = (((i < (int) SIZEOF(parametrized)) &&
2103                    (i < STRCOUNT))
2104                   ? parametrized[i]
2105                   : ((*value == 'k')
2106                      ? 0
2107                      : has_params(value)));
2108     int to_char = 0;
2109     char *ti_value;
2110     char *tc_value;
2111     bool embedded;
2112
2113     if ((ti_value = _nc_tic_expand(value, TRUE, to_char)) == ABSENT_STRING) {
2114         _nc_warning("tic-expansion of %s failed", name);
2115     } else if ((tc_value = _nc_infotocap(name, ti_value, params)) == ABSENT_STRING) {
2116         _nc_warning("tic-conversion of %s failed", name);
2117     } else if (params > 0) {
2118         int limit = 5;
2119         int count;
2120         bool first = TRUE;
2121
2122         if (!strcmp(name, "setf")
2123             || !strcmp(name, "setb")
2124             || !strcmp(name, "setaf")
2125             || !strcmp(name, "setab")) {
2126             limit = max_colors;
2127         }
2128         for (count = 0; count < limit; ++count) {
2129             char *ti_check = check_1_infotocap(name, ti_value, count);
2130             char *tc_check = check_1_infotocap(name, tc_value, count);
2131
2132             if (strcmp(ti_check, tc_check)) {
2133                 if (first) {
2134                     fprintf(stderr, "check_infotocap(%s)\n", name);
2135                     fprintf(stderr, "...ti '%s'\n", ti_value);
2136                     fprintf(stderr, "...tc '%s'\n", tc_value);
2137                     first = FALSE;
2138                 }
2139                 _nc_warning("tparm-conversion of %s(%d) differs between\n\tterminfo %s\n\ttermcap  %s",
2140                             name, count, ti_check, tc_check);
2141             }
2142         }
2143     } else if (params == 0 && !same_ti_tc(ti_value, tc_value, &embedded)) {
2144         if (embedded) {
2145             _nc_warning("termcap equivalent of %s cannot use embedded delay", name);
2146         } else {
2147             _nc_warning("tic-conversion of %s changed value\n\tfrom %s\n\tto   %s",
2148                         name, ti_value, tc_value);
2149         }
2150     }
2151 }
2152
2153 static char *
2154 skip_delay(char *s)
2155 {
2156     while (*s == '/' || isdigit(UChar(*s)))
2157         ++s;
2158     return s;
2159 }
2160
2161 /*
2162  * Skip a delay altogether, e.g., when comparing a simple string to sgr,
2163  * the latter may have a worst-case delay on the end.
2164  */
2165 static char *
2166 ignore_delays(char *s)
2167 {
2168     int delaying = 0;
2169
2170     do {
2171         switch (*s) {
2172         case '$':
2173             if (delaying == 0)
2174                 delaying = 1;
2175             break;
2176         case '<':
2177             if (delaying == 1)
2178                 delaying = 2;
2179             break;
2180         case '\0':
2181             delaying = 0;
2182             break;
2183         default:
2184             if (delaying) {
2185                 s = skip_delay(s);
2186                 if (*s == '>')
2187                     ++s;
2188                 delaying = 0;
2189             }
2190             break;
2191         }
2192         if (delaying)
2193             ++s;
2194     } while (delaying);
2195     return s;
2196 }
2197
2198 #define DATA(name) { #name }
2199 static const char sgr_names[][11] =
2200 {
2201     DATA(none),
2202     DATA(standout),
2203     DATA(underline),
2204     DATA(reverse),
2205     DATA(blink),
2206     DATA(dim),
2207     DATA(bold),
2208     DATA(invis),
2209     DATA(protect),
2210     DATA(altcharset),
2211     ""
2212 };
2213 #undef DATA
2214
2215 /*
2216  * An sgr string may contain several settings other than the one we're
2217  * interested in, essentially sgr0 + rmacs + whatever.  As long as the
2218  * "whatever" is contained in the sgr string, that is close enough for our
2219  * sanity check.
2220  */
2221 static bool
2222 similar_sgr(int num, char *a, char *b)
2223 {
2224     char *base_a = a;
2225     char *base_b = b;
2226     int delaying = 0;
2227
2228     while (*b != 0) {
2229         while (*a != *b) {
2230             if (*a == 0) {
2231                 if (num < 0) {
2232                     ;
2233                 } else if (b[0] == '$'
2234                            && b[1] == '<') {
2235                     _nc_warning("Did not find delay %s", _nc_visbuf(b));
2236                 } else {
2237                     _nc_warning("checking sgr(%s) %s\n\tcompare to %s\n\tunmatched %s",
2238                                 sgr_names[num], _nc_visbuf2(1, base_a),
2239                                 _nc_visbuf2(2, base_b),
2240                                 _nc_visbuf2(3, b));
2241                 }
2242                 return FALSE;
2243             } else if (delaying) {
2244                 a = skip_delay(a);
2245                 b = skip_delay(b);
2246             } else if ((*b == '0' || (*b == ';')) && *a == 'm') {
2247                 b++;
2248             } else {
2249                 a++;
2250             }
2251         }
2252         switch (*a) {
2253         case '$':
2254             if (delaying == 0)
2255                 delaying = 1;
2256             break;
2257         case '<':
2258             if (delaying == 1)
2259                 delaying = 2;
2260             break;
2261         default:
2262             delaying = 0;
2263             break;
2264         }
2265         a++;
2266         b++;
2267     }
2268     /* ignore delays on the end of the string */
2269     a = ignore_delays(a);
2270     return ((num != 0) || (*a == 0));
2271 }
2272
2273 static char *
2274 check_sgr(TERMTYPE *tp, char *zero, int num, char *cap, const char *name)
2275 {
2276     char *test;
2277
2278     _nc_tparm_err = 0;
2279     test = TPARM_9(set_attributes,
2280                    num == 1,
2281                    num == 2,
2282                    num == 3,
2283                    num == 4,
2284                    num == 5,
2285                    num == 6,
2286                    num == 7,
2287                    num == 8,
2288                    num == 9);
2289     if (test != 0) {
2290         if (PRESENT(cap)) {
2291             if (!similar_sgr(num, test, cap)) {
2292                 _nc_warning("%s differs from sgr(%d)\n\t%s=%s\n\tsgr(%d)=%s",
2293                             name, num,
2294                             name, _nc_visbuf2(1, cap),
2295                             num, _nc_visbuf2(2, test));
2296             }
2297         } else if (_nc_capcmp(test, zero)) {
2298             _nc_warning("sgr(%d) present, but not %s", num, name);
2299         }
2300     } else if (PRESENT(cap)) {
2301         _nc_warning("sgr(%d) missing, but %s present", num, name);
2302     }
2303     if (_nc_tparm_err)
2304         _nc_warning("stack error in sgr(%d) string", num);
2305     return test;
2306 }
2307
2308 #define CHECK_SGR(num,name) check_sgr(tp, zero, num, name, #name)
2309
2310 #ifdef TRACE
2311 /*
2312  * If tic is compiled with TRACE, we'll be able to see the output from the
2313  * DEBUG() macro.  But since it doesn't use traceon(), it always goes to
2314  * the standard error.  Use this function to make it simpler to follow the
2315  * resulting debug traces.
2316  */
2317 static void
2318 show_where(unsigned level)
2319 {
2320     if (_nc_tracing >= DEBUG_LEVEL(level)) {
2321         char my_name[MAX_NAME_SIZE];
2322         _nc_get_type(my_name);
2323         _tracef("\"%s\", line %d, '%s'",
2324                 _nc_get_source(),
2325                 _nc_curr_line, my_name);
2326     }
2327 }
2328
2329 #else
2330 #define show_where(level)       /* nothing */
2331 #endif
2332
2333 typedef struct {
2334     int keycode;
2335     const char *name;
2336     const char *value;
2337 } NAME_VALUE;
2338
2339 static NAME_VALUE *
2340 get_fkey_list(TERMTYPE *tp)
2341 {
2342     NAME_VALUE *result = typeMalloc(NAME_VALUE, NUM_STRINGS(tp) + 1);
2343     const struct tinfo_fkeys *all_fkeys = _nc_tinfo_fkeys;
2344     int used = 0;
2345     unsigned j;
2346
2347     if (result == 0)
2348         failed("get_fkey_list");
2349
2350     for (j = 0; all_fkeys[j].code; j++) {
2351         char *a = tp->Strings[all_fkeys[j].offset];
2352         if (VALID_STRING(a)) {
2353             result[used].keycode = (int) all_fkeys[j].code;
2354             result[used].name = strnames[all_fkeys[j].offset];
2355             result[used].value = a;
2356             ++used;
2357         }
2358     }
2359 #if NCURSES_XNAMES
2360     for (j = STRCOUNT; j < NUM_STRINGS(tp); ++j) {
2361         const char *name = ExtStrname(tp, (int) j, strnames);
2362         if (*name == 'k') {
2363             result[used].keycode = -1;
2364             result[used].name = name;
2365             result[used].value = tp->Strings[j];
2366             ++used;
2367         }
2368     }
2369 #endif
2370     result[used].keycode = 0;
2371     return result;
2372 }
2373
2374 static void
2375 show_fkey_name(NAME_VALUE * data)
2376 {
2377     if (data->keycode > 0) {
2378         fprintf(stderr, " %s", keyname(data->keycode));
2379         fprintf(stderr, " (capability \"%s\")", data->name);
2380     } else {
2381         fprintf(stderr, " capability \"%s\"", data->name);
2382     }
2383 }
2384
2385 /*
2386  * A terminal entry may contain more than one keycode assigned to a given
2387  * string (e.g., KEY_END and KEY_LL).  But curses will only return one (the
2388  * last one assigned).
2389  */
2390 static void
2391 check_conflict(TERMTYPE *tp)
2392 {
2393     bool conflict = FALSE;
2394     unsigned j, k;
2395
2396     if (!(_nc_syntax == SYN_TERMCAP && capdump)) {
2397         char *check = calloc((size_t) (NUM_STRINGS(tp) + 1), sizeof(char));
2398         NAME_VALUE *given = get_fkey_list(tp);
2399
2400         if (check == 0)
2401             failed("check_termtype");
2402
2403         for (j = 0; given[j].keycode; ++j) {
2404             const char *a = given[j].value;
2405             bool first = TRUE;
2406
2407             for (k = j + 1; given[k].keycode; k++) {
2408                 const char *b = given[k].value;
2409                 if (check[k])
2410                     continue;
2411                 if (!_nc_capcmp(a, b)) {
2412                     check[j] = 1;
2413                     check[k] = 1;
2414                     if (first) {
2415                         if (!conflict) {
2416                             _nc_warning("Conflicting key definitions (using the last)");
2417                             conflict = TRUE;
2418                         }
2419                         fprintf(stderr, "...");
2420                         show_fkey_name(given + j);
2421                         fprintf(stderr, " is the same as");
2422                         show_fkey_name(given + k);
2423                         first = FALSE;
2424                     } else {
2425                         fprintf(stderr, ", ");
2426                         show_fkey_name(given + k);
2427                     }
2428                 }
2429             }
2430             if (!first)
2431                 fprintf(stderr, "\n");
2432         }
2433         free(given);
2434         free(check);
2435     }
2436 }
2437
2438 /*
2439  * Exiting a video mode should not duplicate sgr0
2440  */
2441 static void
2442 check_exit_attribute(const char *name, char *test, char *trimmed, char *untrimmed)
2443 {
2444     if (VALID_STRING(test) && (trimmed != 0)) {
2445         if (similar_sgr(-1, trimmed, test) ||
2446             similar_sgr(-1, untrimmed, test)) {
2447             _nc_warning("%s matches exit_attribute_mode", name);
2448         }
2449     }
2450 }
2451
2452 /*
2453  * Returns true if the string looks like a standard SGR string.
2454  */
2455 static bool
2456 is_sgr_string(char *value)
2457 {
2458     bool result = FALSE;
2459
2460     if (VALID_STRING(value)) {
2461         int skip = csi_length(value);
2462
2463         if (skip) {
2464             int ch;
2465
2466             result = TRUE;
2467             value += skip;
2468             while ((ch = UChar(*value++)) != '\0') {
2469                 if (isdigit(ch) || ch == ';') {
2470                     ;
2471                 } else if (ch == 'm' && *value == '\0') {
2472                     ;
2473                 } else {
2474                     result = FALSE;
2475                     break;
2476                 }
2477             }
2478         }
2479     }
2480     return result;
2481 }
2482
2483 /*
2484  * Check if the given capability contains a given SGR attribute.
2485  */
2486 static void
2487 check_sgr_param(TERMTYPE *tp, int code, const char *name, char *value)
2488 {
2489     if (VALID_STRING(value)) {
2490         int ncv = ((code != 0) ? (1 << (code - 1)) : 0);
2491         char *test = tgoto(value, 0, 0);
2492         if (is_sgr_string(test)) {
2493             int param = 0;
2494             int count = 0;
2495             int skips = 0;
2496             int color = (value == set_a_foreground ||
2497                          value == set_a_background ||
2498                          value == set_foreground ||
2499                          value == set_background);
2500             while (*test != 0) {
2501                 if (isdigit(UChar(*test))) {
2502                     param = 10 * param + (*test - '0');
2503                     ++count;
2504                 } else {
2505                     if (count) {
2506                         /*
2507                          * Avoid unnecessary warning for xterm 256color codes.
2508                          */
2509                         if (color && (param == 38 || param == 48))
2510                             skips = 3;
2511                         if ((skips-- <= 0) && (param == code))
2512                             break;
2513                     }
2514                     count = 0;
2515                     param = 0;
2516                 }
2517                 ++test;
2518             }
2519             if (count != 0 && param == code) {
2520                 if (code == 0 ||
2521                     no_color_video < 0 ||
2522                     !(no_color_video & ncv)) {
2523                     _nc_warning("\"%s\" SGR-attribute used in %s",
2524                                 sgr_names[code],
2525                                 name);
2526                 }
2527             }
2528         }
2529     }
2530 }
2531
2532 /* other sanity-checks (things that we don't want in the normal
2533  * logic that reads a terminfo entry)
2534  */
2535 static void
2536 check_termtype(TERMTYPE *tp, bool literal)
2537 {
2538     unsigned j;
2539
2540     check_conflict(tp);
2541
2542     for_each_string(j, tp) {
2543         char *a = tp->Strings[j];
2544         if (VALID_STRING(a)) {
2545             check_params(tp, ExtStrname(tp, (int) j, strnames), a);
2546             check_delays(ExtStrname(tp, (int) j, strnames), a);
2547             if (capdump) {
2548                 check_infotocap(tp, (int) j, a);
2549             }
2550         }
2551     }
2552
2553     check_acs(tp);
2554     check_colors(tp);
2555     check_cursor(tp);
2556     check_keypad(tp);
2557     check_printer(tp);
2558     check_screen(tp);
2559
2560     /*
2561      * These may be mismatched because the terminal description relies on
2562      * restoring the cursor visibility by resetting it.
2563      */
2564     ANDMISSING(cursor_invisible, cursor_normal);
2565     ANDMISSING(cursor_visible, cursor_normal);
2566
2567     if (PRESENT(cursor_visible) && PRESENT(cursor_normal)
2568         && !_nc_capcmp(cursor_visible, cursor_normal))
2569         _nc_warning("cursor_visible is same as cursor_normal");
2570
2571     /*
2572      * From XSI & O'Reilly, we gather that sc/rc are required if csr is
2573      * given, because the cursor position after the scrolling operation is
2574      * performed is undefined.
2575      */
2576     ANDMISSING(change_scroll_region, save_cursor);
2577     ANDMISSING(change_scroll_region, restore_cursor);
2578
2579     /*
2580      * If we can clear tabs, we should be able to initialize them.
2581      */
2582     ANDMISSING(clear_all_tabs, set_tab);
2583
2584     if (PRESENT(set_attributes)) {
2585         char *zero = 0;
2586
2587         _nc_tparm_err = 0;
2588         if (PRESENT(exit_attribute_mode)) {
2589             zero = strdup(CHECK_SGR(0, exit_attribute_mode));
2590         } else {
2591             zero = strdup(TPARM_9(set_attributes, 0, 0, 0, 0, 0, 0, 0, 0, 0));
2592         }
2593         if (_nc_tparm_err)
2594             _nc_warning("stack error in sgr(0) string");
2595
2596         if (zero != 0) {
2597             CHECK_SGR(1, enter_standout_mode);
2598             CHECK_SGR(2, enter_underline_mode);
2599             CHECK_SGR(3, enter_reverse_mode);
2600             CHECK_SGR(4, enter_blink_mode);
2601             CHECK_SGR(5, enter_dim_mode);
2602             CHECK_SGR(6, enter_bold_mode);
2603             CHECK_SGR(7, enter_secure_mode);
2604             CHECK_SGR(8, enter_protected_mode);
2605             CHECK_SGR(9, enter_alt_charset_mode);
2606             free(zero);
2607         } else {
2608             _nc_warning("sgr(0) did not return a value");
2609         }
2610     } else if (PRESENT(exit_attribute_mode) &&
2611                set_attributes != CANCELLED_STRING) {
2612         if (_nc_syntax == SYN_TERMINFO)
2613             _nc_warning("missing sgr string");
2614     }
2615 #define CHECK_SGR0(name) check_exit_attribute(#name, name, check_sgr0, exit_attribute_mode)
2616     if (PRESENT(exit_attribute_mode)) {
2617         char *check_sgr0 = _nc_trim_sgr0(tp);
2618
2619         if (check_sgr0 == 0 || *check_sgr0 == '\0') {
2620             _nc_warning("trimmed sgr0 is empty");
2621         } else {
2622             show_where(2);
2623             if (check_sgr0 != exit_attribute_mode) {
2624                 DEBUG(2,
2625                       ("will trim sgr0\n\toriginal sgr0=%s\n\ttrimmed  sgr0=%s",
2626                        _nc_visbuf2(1, exit_attribute_mode),
2627                        _nc_visbuf2(2, check_sgr0)));
2628             } else {
2629                 DEBUG(2,
2630                       ("will not trim sgr0\n\toriginal sgr0=%s",
2631                        _nc_visbuf(exit_attribute_mode)));
2632             }
2633         }
2634         CHECK_SGR0(exit_italics_mode);
2635         CHECK_SGR0(exit_standout_mode);
2636         CHECK_SGR0(exit_underline_mode);
2637         if (check_sgr0 != exit_attribute_mode) {
2638             free(check_sgr0);
2639         }
2640     }
2641 #define CHECK_SGR_PARAM(code, name) check_sgr_param(tp, (int)code, #name, name)
2642     for (j = 0; *sgr_names[j] != '\0'; ++j) {
2643         CHECK_SGR_PARAM(j, set_a_foreground);
2644         CHECK_SGR_PARAM(j, set_a_background);
2645         CHECK_SGR_PARAM(j, set_foreground);
2646         CHECK_SGR_PARAM(j, set_background);
2647     }
2648 #ifdef TRACE
2649     show_where(2);
2650     if (!auto_right_margin) {
2651         DEBUG(2,
2652               ("can write to lower-right directly"));
2653     } else if (PRESENT(enter_am_mode) && PRESENT(exit_am_mode)) {
2654         DEBUG(2,
2655               ("can write to lower-right by suppressing automargin"));
2656     } else if ((PRESENT(enter_insert_mode) && PRESENT(exit_insert_mode))
2657                || PRESENT(insert_character) || PRESENT(parm_ich)) {
2658         DEBUG(2,
2659               ("can write to lower-right by using inserts"));
2660     } else {
2661         DEBUG(2,
2662               ("cannot write to lower-right"));
2663     }
2664 #endif
2665
2666     /*
2667      * Some standard applications (e.g., vi) and some non-curses
2668      * applications (e.g., jove) get confused if we have both ich1 and
2669      * smir/rmir.  Let's be nice and warn about that, too, even though
2670      * ncurses handles it.
2671      */
2672     if ((PRESENT(enter_insert_mode) || PRESENT(exit_insert_mode))
2673         && PRESENT(parm_ich)) {
2674         _nc_warning("non-curses applications may be confused by ich1 with smir/rmir");
2675     }
2676
2677     /*
2678      * Finally, do the non-verbose checks
2679      */
2680     if (save_check_termtype != 0)
2681         save_check_termtype(tp, literal);
2682 }