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