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