1 /****************************************************************************
2 * Copyright (c) 1998-2010,2011 Free Software Foundation, Inc. *
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: *
12 * The above copyright notice and this permission notice shall be included *
13 * in all copies or substantial portions of the Software. *
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. *
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 *
27 ****************************************************************************/
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 ****************************************************************************/
36 * tic.c --- Main program for terminfo compiler
42 #include <progs.priv.h>
45 #include <dump_entry.h>
46 #include <transform.h>
48 MODULE_ID("$Id: tic.c,v 1.157 2011/12/31 21:11:59 tom Exp $")
50 const char *_nc_progname = "tic";
54 static bool capdump = FALSE; /* running as infotocap? */
55 static bool infodump = FALSE; /* running as captoinfo? */
56 static bool showsummary = FALSE;
57 static const char *to_remove;
59 static void (*save_check_termtype) (TERMTYPE *, bool);
60 static void check_termtype(TERMTYPE *tt, bool);
62 static const char usage_string[] = "\
93 free_namelist(char **src)
97 for (n = 0; src[n] != 0; ++n)
105 cleanup(char **namelst GCC_UNUSED)
108 free_namelist(namelst);
112 if (to_remove != 0) {
122 failed(const char *msg)
125 cleanup((char **) 0);
126 ExitProgram(EXIT_FAILURE);
132 static const char *const tbl[] =
135 " -1 format translation output one capability per line",
137 " -a retain commented-out capabilities (sets -x also)",
139 " -K translate entries to termcap source form with BSD syntax",
140 " -C translate entries to termcap source form",
141 " -D print list of tic's database locations (first must be writable)",
142 " -c check only, validate input without compiling or translating",
143 " -e<names> translate/compile only entries named by comma-separated list",
144 " -f format complex strings for readability",
145 " -G format %{number} to %'char'",
146 " -g format %'char' to %{number}",
147 " -I translate entries to terminfo source form",
148 " -L translate entries to full terminfo source form",
149 " -N disable smart defaults for source translation",
150 " -o<dir> set output directory for compiled entry writes",
151 " -R<name> restrict translation to given terminfo/termcap version",
152 " -r force resolution of all use entries in source translation",
153 " -s print summary statistics",
154 " -T remove size-restrictions on compiled description",
156 " -t suppress commented-out capabilities",
158 " -U suppress post-processing of entries",
160 " -v[n] set verbosity level",
161 " -w[n] set format width for translation output",
163 " -x treat unknown capabilities as user-defined",
167 " <file> file to translate or compile"
171 fprintf(stderr, "Usage: %s %s\n", _nc_progname, usage_string);
172 for (j = 0; j < SIZEOF(tbl); j++) {
173 fputs(tbl[j], stderr);
176 ExitProgram(EXIT_FAILURE);
189 char result[MAX_ENTRY_SIZE];
192 * Look for strings that contain %{number}, convert them to %'char',
193 * which is shorter and runs a little faster.
195 for (n = 0; n < STRCOUNT; n++) {
196 s = ep->tterm.Strings[n];
198 && strchr(s, L_BRACE) != 0) {
201 while ((ch = *t++) != 0) {
205 } else if ((ch == '%')
206 && (*t == L_BRACE)) {
208 long value = strtol(t + 1, &v, 0);
212 && value != '\\' /* FIXME */
214 && isprint((int) value)) {
223 if (strlen(result) < strlen(s))
228 _nc_set_type(_nc_first_name(ep->tterm.term_names));
229 _nc_curr_line = (int) ep->startline;
230 _nc_write_entry(&ep->tterm);
234 immedhook(ENTRY * ep GCC_UNUSED)
235 /* write out entries with no use capabilities immediately to save storage */
239 * This is strictly a core-economy kluge. The really clean way to handle
240 * compilation is to slurp the whole file into core and then do all the
241 * name-collision checks and entry writes in one swell foop. But the
242 * terminfo master file is large enough that some core-poor systems swap
243 * like crazy when you compile it this way...there have been reports of
244 * this process taking *three hours*, rather than the twenty seconds or
245 * less typical on my development box.
247 * So. This hook *immediately* writes out the referenced entry if it
248 * has no use capabilities. The compiler main loop refrains from
249 * adding the entry to the in-core list when this hook fires. If some
250 * other entry later needs to reference an entry that got written
251 * immediately, that's OK; the resolution code will fetch it off disk
252 * when it can't find it in core.
254 * Name collisions will still be detected, just not as cleanly. The
255 * write_entry() code complains before overwriting an entry that
256 * postdates the time of tic's first call to write_entry(). Thus
257 * it will complain about overwriting entries newly made during the
258 * tic run, but not about overwriting ones that predate it.
260 * The reason this is a hook, and not in line with the rest of the
261 * compiler code, is that the support for termcap fallback cannot assume
262 * it has anywhere to spool out these entries!
264 * The _nc_set_type() call here requires a compensating one in
267 * If you define HAVE_BIG_CORE, you'll disable this kluge. This will
268 * make tic a bit faster (because the resolution code won't have to do
269 * disk I/O nearly as often).
271 if (ep->nuses == 0) {
272 int oldline = _nc_curr_line;
275 _nc_curr_line = oldline;
276 free(ep->tterm.str_table);
279 #endif /* HAVE_BIG_CORE */
285 /* emit a comment char, translating terminfo names to termcap names */
287 static bool in_name = FALSE;
288 static size_t have, used;
289 static char *namebuf, *suffix;
292 if (used + 1 >= have) {
294 namebuf = typeRealloc(char, have, namebuf);
295 suffix = typeRealloc(char, have, suffix);
297 if (c == '\n' || c == '@') {
298 namebuf[used++] = '\0';
300 (void) fputs(namebuf, stdout);
303 } else if (c != '>') {
304 namebuf[used++] = (char) c;
305 } else { /* ah! candidate name! */
307 NCURSES_CONST char *tp;
309 namebuf[used++] = '\0';
313 if ((up = strchr(namebuf, '#')) != 0
314 || (up = strchr(namebuf, '=')) != 0
315 || ((up = strchr(namebuf, '@')) != 0 && up[1] == '>')) {
316 (void) strcpy(suffix, up);
320 if ((tp = nametrans(namebuf)) != 0) {
322 (void) fputs(tp, stdout);
323 (void) fputs(suffix, stdout);
326 /* couldn't find a translation, just dump the name */
328 (void) fputs(namebuf, stdout);
329 (void) fputs(suffix, stdout);
343 /* Returns a string, stripped of leading/trailing whitespace */
349 while (isspace(UChar(*src)))
355 if ((dst = strdup(src)) == NULL) {
359 while (--len != 0 && isspace(UChar(dst[len])))
367 open_input(const char *filename)
369 FILE *fp = fopen(filename, "r");
373 fprintf(stderr, "%s: Can't open %s\n", _nc_progname, filename);
374 ExitProgram(EXIT_FAILURE);
376 if (fstat(fileno(fp), &sb) < 0
377 || (sb.st_mode & S_IFMT) != S_IFREG) {
378 fprintf(stderr, "%s: %s is not a file\n", _nc_progname, filename);
379 ExitProgram(EXIT_FAILURE);
384 /* Parse the "-e" option-value into a list of names */
386 make_namelist(char *src)
391 unsigned pass, n, nn;
396 } else if (strchr(src, '/') != 0) { /* a filename */
397 FILE *fp = open_input(src);
399 for (pass = 1; pass <= 2; pass++) {
401 while (fgets(buffer, sizeof(buffer), fp) != 0) {
402 if ((s = stripped(buffer)) != 0) {
411 dst = typeCalloc(char *, nn + 1);
416 } else { /* literal list of names */
417 for (pass = 1; pass <= 2; pass++) {
418 for (n = nn = 0, base = src;; n++) {
420 if (mark == ',' || mark == '\0') {
425 if ((s = stripped(base)) != 0)
434 dst = typeCalloc(char *, nn + 1);
437 if (showsummary && (dst != 0)) {
438 fprintf(log_fp, "Entries that will be compiled:\n");
439 for (n = 0; dst[n] != 0; n++)
440 fprintf(log_fp, "%u:%s\n", n + 1, dst[n]);
446 matches(char **needle, const char *haystack)
447 /* does entry in needle list match |-separated field in haystack? */
453 for (n = 0; needle[n] != 0; n++) {
454 if (_nc_name_match(haystack, needle[n], "|")) {
465 open_tempfile(char *name)
469 int fd = mkstemp(name);
471 result = fdopen(fd, "w");
473 if (tmpnam(name) != 0)
474 result = fopen(name, "w");
480 * Show the databases that tic knows about. The location to which it writes is
481 * always the first one. If that is not writable, then tic errors out before
482 * reaching this function.
491 _nc_first_db(&state, &offset);
492 while ((path = _nc_next_db(&state, &offset)) != 0) {
493 printf("%s\n", path);
499 main(int argc, char *argv[])
501 char my_tmpname[PATH_MAX];
503 unsigned debug_level;
504 int smart_defaults = TRUE;
508 int this_opt, last_opt = '?';
510 int outform = F_TERMINFO; /* output format */
511 int sortmode = S_TERMINFO; /* sort_mode */
515 bool formatted = FALSE; /* reformat complex strings? */
516 bool literal = FALSE; /* suppress post-processing? */
517 int numbers = 0; /* format "%'char'" to/from "%{number}" */
518 bool forceresolve = FALSE; /* force resolution */
520 char *tversion = (char *) NULL;
521 const char *source_file = "terminfo";
523 char *outdir = (char *) NULL;
524 bool check_only = FALSE;
525 bool suppress_untranslatable = FALSE;
529 _nc_progname = _nc_rootname(argv[0]);
531 if ((infodump = same_program(_nc_progname, PROG_CAPTOINFO)) != FALSE) {
532 outform = F_TERMINFO;
533 sortmode = S_TERMINFO;
535 if ((capdump = same_program(_nc_progname, PROG_INFOTOCAP)) != FALSE) {
537 sortmode = S_TERMCAP;
540 use_extended_names(FALSE);
545 * Processing arguments is a little complicated, since someone made a
546 * design decision to allow the numeric values for -w, -v options to
549 while ((this_opt = getopt(argc, argv,
550 "0123456789CDIKLNR:TUVace:fGgo:rstvwx")) != -1) {
551 if (isdigit(this_opt)) {
554 v_opt = (v_opt * 10) + (this_opt - '0');
557 width = (width * 10) + (this_opt - '0');
579 /* the initial version of -K in 20110730 fell-thru here, but the
580 * same flag is useful when reading sources -TD
586 sortmode = S_TERMCAP;
589 _nc_set_writedir(outdir);
591 ExitProgram(EXIT_SUCCESS);
595 outform = F_TERMINFO;
596 sortmode = S_TERMINFO;
600 outform = F_VARIABLE;
601 sortmode = S_VARIABLE;
604 smart_defaults = FALSE;
617 puts(curses_version());
619 ExitProgram(EXIT_SUCCESS);
624 namelst = make_namelist(optarg);
652 _nc_disable_period = FALSE;
653 suppress_untranslatable = TRUE;
656 _nc_disable_period = TRUE;
659 use_extended_names(TRUE);
668 debug_level = (unsigned) ((v_opt > 0) ? v_opt : (v_opt == 0));
669 set_trace_level(debug_level);
672 save_check_termtype = _nc_check_termtype2;
673 _nc_check_termtype2 = check_termtype;
677 * Aaargh! immedhook seriously hoses us!
679 * One problem with immedhook is it means we can't do -e. Problem
680 * is that we can't guarantee that for each terminal listed, all the
681 * terminals it depends on will have been kept in core for reference
682 * resolution -- in fact it's certain the primitive types at the end
683 * of reference chains *won't* be in core unless they were explicitly
684 * in the select list themselves.
686 if (namelst && (!infodump && !capdump)) {
687 (void) fprintf(stderr,
688 "Sorry, -e can't be used without -I or -C\n");
690 ExitProgram(EXIT_FAILURE);
692 #endif /* HAVE_BIG_CORE */
695 source_file = argv[optind++];
698 "%s: Too many file names. Usage:\n\t%s %s",
702 ExitProgram(EXIT_FAILURE);
705 if (infodump == TRUE) {
706 /* captoinfo's no-argument case */
707 source_file = "/etc/termcap";
708 if ((termcap = getenv("TERMCAP")) != 0
709 && (namelst = make_namelist(getenv("TERM"))) != 0) {
710 if (access(termcap, F_OK) == 0) {
712 source_file = termcap;
713 } else if ((tmp_fp = open_tempfile(strcpy(my_tmpname,
716 source_file = my_tmpname;
717 fprintf(tmp_fp, "%s\n", termcap);
719 tmp_fp = open_input(source_file);
720 to_remove = source_file;
728 "%s: File name needed. Usage:\n\t%s %s",
733 ExitProgram(EXIT_FAILURE);
738 tmp_fp = open_input(source_file);
745 sortmode, width, height, debug_level, formatted);
749 sortmode, width, height, debug_level, FALSE);
751 /* parse entries out of the source file */
752 _nc_set_source(source_file);
754 if (!(check_only || infodump || capdump))
755 _nc_set_writedir(outdir);
756 #endif /* HAVE_BIG_CORE */
757 _nc_read_entry_source(tmp_fp, (char *) NULL,
758 !smart_defaults || literal, FALSE,
759 ((check_only || infodump || capdump)
763 /* do use resolution */
764 if (check_only || (!infodump && !capdump) || forceresolve) {
765 if (!_nc_resolve_uses2(TRUE, literal) && !check_only) {
767 ExitProgram(EXIT_FAILURE);
772 if (check_only && (capdump || infodump)) {
774 if (matches(namelst, qp->tterm.term_names)) {
775 int len = fmt_entry(&qp->tterm, NULL, FALSE, TRUE, infodump, numbers);
777 if (len > (infodump ? MAX_TERMINFO_LENGTH : MAX_TERMCAP_LENGTH))
778 (void) fprintf(stderr,
779 "warning: resolved %s entry is %d bytes long\n",
780 _nc_first_name(qp->tterm.term_names),
786 /* write or dump all entries */
788 if (!infodump && !capdump) {
789 _nc_set_writedir(outdir);
791 if (matches(namelst, qp->tterm.term_names))
795 /* this is in case infotocap() generates warnings */
796 _nc_curr_col = _nc_curr_line = -1;
799 if (matches(namelst, qp->tterm.term_names)) {
800 long j = qp->cend - qp->cstart;
803 /* this is in case infotocap() generates warnings */
804 _nc_set_type(_nc_first_name(qp->tterm.term_names));
806 (void) fseek(tmp_fp, qp->cstart, SEEK_SET);
809 (void) putchar(fgetc(tmp_fp));
811 put_translate(fgetc(tmp_fp));
814 repair_acsc(&qp->tterm);
815 dump_entry(&qp->tterm, suppress_untranslatable,
816 limited, numbers, NULL);
817 for (j = 0; j < (long) qp->nuses; j++)
818 dump_uses(qp->uses[j].name, !capdump);
820 if (debug_level != 0 && !limited)
821 printf("# length=%d\n", len);
824 if (!namelst && _nc_tail) {
826 bool in_comment = FALSE;
827 bool trailing_comment = FALSE;
829 (void) fseek(tmp_fp, _nc_tail->cend, SEEK_SET);
830 while ((c = fgetc(tmp_fp)) != EOF) {
833 trailing_comment = TRUE;
840 && (in_comment || (oldc == '\n' && c == '\n')))
848 /* Show the directory into which entries were written, and the total
852 && (!(check_only || infodump || capdump))) {
853 int total = _nc_tic_written();
855 fprintf(log_fp, "%d entries written to %s\n",
857 _nc_tic_dir((char *) 0));
859 fprintf(log_fp, "No entries written\n");
862 ExitProgram(EXIT_SUCCESS);
866 * This bit of legerdemain turns all the terminfo variable names into
867 * references to locations in the arrays Booleans, Numbers, and Strings ---
868 * precisely what's needed (see comp_parse.c).
874 * Check if the alternate character-set capabilities are consistent.
877 check_acs(TERMTYPE *tp)
879 if (VALID_STRING(acs_chars)) {
880 const char *boxes = "lmkjtuvwqxn";
886 memset(mapped, 0, sizeof(mapped));
887 for (p = acs_chars; *p != '\0'; p += 2) {
889 _nc_warning("acsc has odd number of characters");
892 mapped[UChar(p[0])] = p[1];
895 if (mapped[UChar('I')] && !mapped[UChar('i')]) {
896 _nc_warning("acsc refers to 'I', which is probably an error");
899 for (p = boxes, q = missing; *p != '\0'; ++p) {
900 if (!mapped[UChar(p[0])]) {
906 assert(strlen(missing) <= strlen(boxes));
907 if (*missing != '\0' && strcmp(missing, boxes)) {
908 _nc_warning("acsc is missing some line-drawing mapping: %s", missing);
914 * Check if the color capabilities are consistent
917 check_colors(TERMTYPE *tp)
919 if ((max_colors > 0) != (max_pairs > 0)
920 || ((max_colors > max_pairs) && (initialize_pair == 0)))
921 _nc_warning("inconsistent values for max_colors (%d) and max_pairs (%d)",
922 max_colors, max_pairs);
924 PAIRED(set_foreground, set_background);
925 PAIRED(set_a_foreground, set_a_background);
926 PAIRED(set_color_pair, initialize_pair);
928 if (VALID_STRING(set_foreground)
929 && VALID_STRING(set_a_foreground)
930 && !_nc_capcmp(set_foreground, set_a_foreground))
931 _nc_warning("expected setf/setaf to be different");
933 if (VALID_STRING(set_background)
934 && VALID_STRING(set_a_background)
935 && !_nc_capcmp(set_background, set_a_background))
936 _nc_warning("expected setb/setab to be different");
938 /* see: has_colors() */
939 if (VALID_NUMERIC(max_colors) && VALID_NUMERIC(max_pairs)
940 && (((set_foreground != NULL)
941 && (set_background != NULL))
942 || ((set_a_foreground != NULL)
943 && (set_a_background != NULL))
944 || set_color_pair)) {
945 if (!VALID_STRING(orig_pair) && !VALID_STRING(orig_colors))
946 _nc_warning("expected either op/oc string for resetting colors");
951 keypad_final(const char *string)
955 if (VALID_STRING(string)
956 && *string++ == '\033'
958 && strlen(string) == 1) {
966 keypad_index(const char *string)
969 const char *list = "PQRSwxymtuvlqrsPpn"; /* app-keypad except "Enter" */
973 if ((ch = keypad_final(string)) != '\0') {
974 test = strchr(list, ch);
976 result = (long) (test - list);
982 * list[] is down, up, left, right
983 * "left" may be ^H rather than \E[D
984 * "down" may be ^J rather than \E[B
985 * But up/right are generally consistently escape sequences for ANSI terminals.
988 check_ansi_cursor(char *list[4])
995 bool repeated = FALSE;
997 for (j = 0; j < 4; ++j) {
999 for (k = 0; k < j; ++k) {
1001 && !strcmp(list[j], list[k])) {
1002 char *value = _nc_tic_expand(list[k], TRUE, 0);
1003 _nc_warning("repeated cursor control %s\n", value);
1011 if (UChar(up[0]) == '\033') {
1017 } else if (UChar(up[0]) == UChar('\233')) {
1022 while (up[suffix] && isdigit(UChar(up[suffix])))
1025 if (prefix && up[suffix] == 'A') {
1027 if (!strcmp(list[0], "\n"))
1029 if (!strcmp(list[2], "\b"))
1032 for (j = 0; j < 4; ++j) {
1033 if (skip[j] || strlen(list[j]) == 1)
1035 if (memcmp(list[j], up, prefix)) {
1036 char *value = _nc_tic_expand(list[j], TRUE, 0);
1037 _nc_warning("inconsistent prefix for %s\n", value);
1040 if (strlen(list[j]) < suffix) {
1041 char *value = _nc_tic_expand(list[j], TRUE, 0);
1042 _nc_warning("inconsistent length for %s, expected %d\n",
1043 value, (int) suffix + 1);
1047 if (list[j][suffix] != want) {
1048 char *value = _nc_tic_expand(list[j], TRUE, 0);
1049 _nc_warning("inconsistent suffix for %s, expected %c, have %c\n",
1050 value, want, list[j][suffix]);
1057 #define EXPECTED(name) if (!PRESENT(name)) _nc_warning("expected " #name)
1060 check_cursor(TERMTYPE *tp)
1065 /* if we have a parameterized form, then the non-parameterized is easy */
1066 ANDMISSING(parm_down_cursor, cursor_down);
1067 ANDMISSING(parm_up_cursor, cursor_up);
1068 ANDMISSING(parm_left_cursor, cursor_left);
1069 ANDMISSING(parm_right_cursor, cursor_right);
1071 /* Given any of a set of cursor movement, the whole set should be present.
1072 * Technically this is not true (we could use cursor_address to fill in
1073 * unsupported controls), but it is likely.
1076 if (PRESENT(parm_down_cursor)) {
1077 list[count++] = parm_down_cursor;
1079 if (PRESENT(parm_up_cursor)) {
1080 list[count++] = parm_up_cursor;
1082 if (PRESENT(parm_left_cursor)) {
1083 list[count++] = parm_left_cursor;
1085 if (PRESENT(parm_right_cursor)) {
1086 list[count++] = parm_right_cursor;
1089 check_ansi_cursor(list);
1090 } else if (count != 0) {
1091 EXPECTED(parm_down_cursor);
1092 EXPECTED(parm_up_cursor);
1093 EXPECTED(parm_left_cursor);
1094 EXPECTED(parm_right_cursor);
1098 if (PRESENT(cursor_down)) {
1099 list[count++] = cursor_down;
1101 if (PRESENT(cursor_up)) {
1102 list[count++] = cursor_up;
1104 if (PRESENT(cursor_left)) {
1105 list[count++] = cursor_left;
1107 if (PRESENT(cursor_right)) {
1108 list[count++] = cursor_right;
1111 check_ansi_cursor(list);
1112 } else if (count != 0) {
1114 if (PRESENT(cursor_down) && strcmp(cursor_down, "\n"))
1116 if (PRESENT(cursor_left) && strcmp(cursor_left, "\b"))
1118 if (PRESENT(cursor_up) && strlen(cursor_up) > 1)
1120 if (PRESENT(cursor_right) && strlen(cursor_right) > 1)
1123 EXPECTED(cursor_down);
1124 EXPECTED(cursor_up);
1125 EXPECTED(cursor_left);
1126 EXPECTED(cursor_right);
1133 * Do a quick sanity-check for vt100-style keypads to see if the 5-key keypad
1134 * is mapped inconsistently.
1137 check_keypad(TERMTYPE *tp)
1141 if (VALID_STRING(key_a1) &&
1142 VALID_STRING(key_a3) &&
1143 VALID_STRING(key_b2) &&
1144 VALID_STRING(key_c1) &&
1145 VALID_STRING(key_c3)) {
1146 char final[MAX_KP + 1];
1153 final[0] = keypad_final(key_a1);
1154 final[1] = keypad_final(key_a3);
1155 final[2] = keypad_final(key_b2);
1156 final[3] = keypad_final(key_c1);
1157 final[4] = keypad_final(key_c3);
1160 /* special case: legacy coding using 1,2,3,0,. on the bottom */
1161 assert(strlen(final) <= MAX_KP);
1162 if (!strcmp(final, "qsrpn"))
1165 list[0] = keypad_index(key_a1);
1166 list[1] = keypad_index(key_a3);
1167 list[2] = keypad_index(key_b2);
1168 list[3] = keypad_index(key_c1);
1169 list[4] = keypad_index(key_c3);
1171 /* check that they're all vt100 keys */
1172 for (j = 0; j < MAX_KP; ++j) {
1178 /* check if they're all in increasing order */
1179 for (j = 1; j < MAX_KP; ++j) {
1180 if (list[j] > list[j - 1]) {
1184 if (increase != (MAX_KP - 1)) {
1187 for (j = 0, last = -1; j < MAX_KP; ++j) {
1188 for (k = 0, kk = -1, test = 100; k < 5; ++k) {
1189 if (list[k] > last &&
1196 assert(strlen(show) < (MAX_KP * 4));
1199 strcat(show, " ka1");
1202 strcat(show, " ka3");
1205 strcat(show, " kb2");
1208 strcat(show, " kc1");
1211 strcat(show, " kc3");
1216 _nc_warning("vt100 keypad order inconsistent: %s", show);
1219 } else if (VALID_STRING(key_a1) ||
1220 VALID_STRING(key_a3) ||
1221 VALID_STRING(key_b2) ||
1222 VALID_STRING(key_c1) ||
1223 VALID_STRING(key_c3)) {
1225 if (keypad_index(key_a1) >= 0)
1226 strcat(show, " ka1");
1227 if (keypad_index(key_a3) >= 0)
1228 strcat(show, " ka3");
1229 if (keypad_index(key_b2) >= 0)
1230 strcat(show, " kb2");
1231 if (keypad_index(key_c1) >= 0)
1232 strcat(show, " kc1");
1233 if (keypad_index(key_c3) >= 0)
1234 strcat(show, " kc3");
1236 _nc_warning("vt100 keypad map incomplete:%s", show);
1241 check_printer(TERMTYPE *tp)
1243 PAIRED(enter_doublewide_mode, exit_doublewide_mode);
1244 PAIRED(enter_italics_mode, exit_italics_mode);
1245 PAIRED(enter_leftward_mode, exit_leftward_mode);
1246 PAIRED(enter_micro_mode, exit_micro_mode);
1247 PAIRED(enter_shadow_mode, exit_shadow_mode);
1248 PAIRED(enter_subscript_mode, exit_subscript_mode);
1249 PAIRED(enter_superscript_mode, exit_superscript_mode);
1250 PAIRED(enter_upward_mode, exit_upward_mode);
1252 ANDMISSING(start_char_set_def, stop_char_set_def);
1254 /* if we have a parameterized form, then the non-parameterized is easy */
1255 ANDMISSING(set_bottom_margin_parm, set_bottom_margin);
1256 ANDMISSING(set_left_margin_parm, set_left_margin);
1257 ANDMISSING(set_right_margin_parm, set_right_margin);
1258 ANDMISSING(set_top_margin_parm, set_top_margin);
1260 ANDMISSING(parm_down_micro, micro_down);
1261 ANDMISSING(parm_left_micro, micro_left);
1262 ANDMISSING(parm_right_micro, micro_right);
1263 ANDMISSING(parm_up_micro, micro_up);
1267 * Returns the expected number of parameters for the given capability.
1270 expected_params(const char *name)
1273 static const struct {
1277 { "S0", 1 }, /* 'screen' extension */
1330 { "smgbp", 1 }, /* 2 if smgtp is not given */
1345 int result = 0; /* function-keys, etc., use none */
1347 for (n = 0; n < SIZEOF(table); n++) {
1348 if (!strcmp(name, table[n].name)) {
1349 result = table[n].count;
1358 * Make a quick sanity check for the parameters which are used in the given
1359 * strings. If there are no "%p" tokens, then there should be no other "%"
1363 check_params(TERMTYPE *tp, const char *name, char *value)
1365 int expected = expected_params(name);
1371 #ifdef set_top_margin_parm
1372 if (!strcmp(name, "smgbp")
1373 && set_top_margin_parm == 0)
1377 for (n = 0; n < 10; n++)
1383 _nc_warning("expected character after %% in %s", name);
1385 } else if (*s == 'p') {
1386 if (*++s == '\0' || !isdigit((int) *s)) {
1387 _nc_warning("expected digit after %%p in %s", name);
1401 _nc_warning("%s refers to parameter 0 (%%p0), which is not allowed", name);
1403 if (value == set_attributes || expected < 0) {
1405 } else if (expected != actual) {
1406 _nc_warning("%s uses %d parameters, expected %d", name,
1408 for (n = 1; n < actual; n++) {
1410 _nc_warning("%s omits parameter %d", name, n);
1418 while (*s == '/' || isdigit(UChar(*s)))
1424 * Skip a delay altogether, e.g., when comparing a simple string to sgr,
1425 * the latter may have a worst-case delay on the end.
1428 ignore_delays(char *s)
1461 * An sgr string may contain several settings other than the one we're
1462 * interested in, essentially sgr0 + rmacs + whatever. As long as the
1463 * "whatever" is contained in the sgr string, that is close enough for our
1467 similar_sgr(int num, char *a, char *b)
1469 static const char *names[] =
1491 _nc_warning("Did not find delay %s", _nc_visbuf(b));
1493 _nc_warning("checking sgr(%s) %s\n\tcompare to %s\n\tunmatched %s",
1494 names[num], _nc_visbuf2(1, base_a),
1495 _nc_visbuf2(2, base_b),
1499 } else if (delaying) {
1502 } else if ((*b == '0' || (*b == ';')) && *a == 'm') {
1524 /* ignore delays on the end of the string */
1525 a = ignore_delays(a);
1526 return ((num != 0) || (*a == 0));
1530 check_sgr(TERMTYPE *tp, char *zero, int num, char *cap, const char *name)
1535 test = TPARM_9(set_attributes,
1547 if (!similar_sgr(num, test, cap)) {
1548 _nc_warning("%s differs from sgr(%d)\n\t%s=%s\n\tsgr(%d)=%s",
1550 name, _nc_visbuf2(1, cap),
1551 num, _nc_visbuf2(2, test));
1553 } else if (_nc_capcmp(test, zero)) {
1554 _nc_warning("sgr(%d) present, but not %s", num, name);
1556 } else if (PRESENT(cap)) {
1557 _nc_warning("sgr(%d) missing, but %s present", num, name);
1560 _nc_warning("stack error in sgr(%d) string", num);
1564 #define CHECK_SGR(num,name) check_sgr(tp, zero, num, name, #name)
1568 * If tic is compiled with TRACE, we'll be able to see the output from the
1569 * DEBUG() macro. But since it doesn't use traceon(), it always goes to
1570 * the standard error. Use this function to make it simpler to follow the
1571 * resulting debug traces.
1574 show_where(unsigned level)
1576 if (_nc_tracing >= DEBUG_LEVEL(level)) {
1578 _nc_get_type(my_name);
1579 _tracef("\"%s\", line %d, '%s'",
1581 _nc_curr_line, my_name);
1586 #define show_where(level) /* nothing */
1589 /* other sanity-checks (things that we don't want in the normal
1590 * logic that reads a terminfo entry)
1593 check_termtype(TERMTYPE *tp, bool literal)
1595 bool conflict = FALSE;
1597 char fkeys[STRCOUNT];
1600 * A terminal entry may contain more than one keycode assigned to
1601 * a given string (e.g., KEY_END and KEY_LL). But curses will only
1602 * return one (the last one assigned).
1604 if (!(_nc_syntax == SYN_TERMCAP && capdump)) {
1605 memset(fkeys, 0, sizeof(fkeys));
1606 for (j = 0; _nc_tinfo_fkeys[j].code; j++) {
1607 char *a = tp->Strings[_nc_tinfo_fkeys[j].offset];
1609 if (!VALID_STRING(a))
1611 for (k = j + 1; _nc_tinfo_fkeys[k].code; k++) {
1612 char *b = tp->Strings[_nc_tinfo_fkeys[k].offset];
1613 if (!VALID_STRING(b)
1616 if (!_nc_capcmp(a, b)) {
1621 _nc_warning("Conflicting key definitions (using the last)");
1624 fprintf(stderr, "... %s is the same as %s",
1625 keyname((int) _nc_tinfo_fkeys[j].code),
1626 keyname((int) _nc_tinfo_fkeys[k].code));
1629 fprintf(stderr, ", %s",
1630 keyname((int) _nc_tinfo_fkeys[k].code));
1635 fprintf(stderr, "\n");
1639 for (j = 0; j < NUM_STRINGS(tp); j++) {
1640 char *a = tp->Strings[j];
1641 if (VALID_STRING(a))
1642 check_params(tp, ExtStrname(tp, (int) j, strnames), a);
1652 * These may be mismatched because the terminal description relies on
1653 * restoring the cursor visibility by resetting it.
1655 ANDMISSING(cursor_invisible, cursor_normal);
1656 ANDMISSING(cursor_visible, cursor_normal);
1658 if (PRESENT(cursor_visible) && PRESENT(cursor_normal)
1659 && !_nc_capcmp(cursor_visible, cursor_normal))
1660 _nc_warning("cursor_visible is same as cursor_normal");
1663 * From XSI & O'Reilly, we gather that sc/rc are required if csr is
1664 * given, because the cursor position after the scrolling operation is
1665 * performed is undefined.
1667 ANDMISSING(change_scroll_region, save_cursor);
1668 ANDMISSING(change_scroll_region, restore_cursor);
1671 * If we can clear tabs, we should be able to initialize them.
1673 ANDMISSING(clear_all_tabs, set_tab);
1675 if (PRESENT(set_attributes)) {
1679 if (PRESENT(exit_attribute_mode)) {
1680 zero = strdup(CHECK_SGR(0, exit_attribute_mode));
1682 zero = strdup(TPARM_9(set_attributes, 0, 0, 0, 0, 0, 0, 0, 0, 0));
1685 _nc_warning("stack error in sgr(0) string");
1688 CHECK_SGR(1, enter_standout_mode);
1689 CHECK_SGR(2, enter_underline_mode);
1690 CHECK_SGR(3, enter_reverse_mode);
1691 CHECK_SGR(4, enter_blink_mode);
1692 CHECK_SGR(5, enter_dim_mode);
1693 CHECK_SGR(6, enter_bold_mode);
1694 CHECK_SGR(7, enter_secure_mode);
1695 CHECK_SGR(8, enter_protected_mode);
1696 CHECK_SGR(9, enter_alt_charset_mode);
1699 _nc_warning("sgr(0) did not return a value");
1701 } else if (PRESENT(exit_attribute_mode) &&
1702 set_attributes != CANCELLED_STRING) {
1703 if (_nc_syntax == SYN_TERMINFO)
1704 _nc_warning("missing sgr string");
1707 if (PRESENT(exit_attribute_mode)) {
1708 char *check_sgr0 = _nc_trim_sgr0(tp);
1710 if (check_sgr0 == 0 || *check_sgr0 == '\0') {
1711 _nc_warning("trimmed sgr0 is empty");
1714 if (check_sgr0 != exit_attribute_mode) {
1716 ("will trim sgr0\n\toriginal sgr0=%s\n\ttrimmed sgr0=%s",
1717 _nc_visbuf2(1, exit_attribute_mode),
1718 _nc_visbuf2(2, check_sgr0)));
1722 ("will not trim sgr0\n\toriginal sgr0=%s",
1723 _nc_visbuf(exit_attribute_mode)));
1729 if (!auto_right_margin) {
1731 ("can write to lower-right directly"));
1732 } else if (PRESENT(enter_am_mode) && PRESENT(exit_am_mode)) {
1734 ("can write to lower-right by suppressing automargin"));
1735 } else if ((PRESENT(enter_insert_mode) && PRESENT(exit_insert_mode))
1736 || PRESENT(insert_character) || PRESENT(parm_ich)) {
1738 ("can write to lower-right by using inserts"));
1741 ("cannot write to lower-right"));
1746 * Some standard applications (e.g., vi) and some non-curses
1747 * applications (e.g., jove) get confused if we have both ich1 and
1748 * smir/rmir. Let's be nice and warn about that, too, even though
1749 * ncurses handles it.
1751 if ((PRESENT(enter_insert_mode) || PRESENT(exit_insert_mode))
1752 && PRESENT(parm_ich)) {
1753 _nc_warning("non-curses applications may be confused by ich1 with smir/rmir");
1757 * Finally, do the non-verbose checks
1759 if (save_check_termtype != 0)
1760 save_check_termtype(tp, literal);