1 /****************************************************************************
2 * Copyright (c) 1998-2011,2012 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 <hashed_db.h>
47 #include <transform.h>
49 MODULE_ID("$Id: tic.c,v 1.162 2012/02/22 23:59:45 tom Exp $")
51 const char *_nc_progname = "tic";
55 static bool capdump = FALSE; /* running as infotocap? */
56 static bool infodump = FALSE; /* running as captoinfo? */
57 static bool showsummary = FALSE;
58 static const char *to_remove;
60 static void (*save_check_termtype) (TERMTYPE *, bool);
61 static void check_termtype(TERMTYPE *tt, bool);
63 static const char usage_string[] = "\
94 free_namelist(char **src)
98 for (n = 0; src[n] != 0; ++n)
106 cleanup(char **namelst GCC_UNUSED)
109 free_namelist(namelst);
113 if (to_remove != 0) {
123 failed(const char *msg)
126 cleanup((char **) 0);
127 ExitProgram(EXIT_FAILURE);
133 static const char *const tbl[] =
136 " -1 format translation output one capability per line",
138 " -a retain commented-out capabilities (sets -x also)",
140 " -K translate entries to termcap source form with BSD syntax",
141 " -C translate entries to termcap source form",
142 " -D print list of tic's database locations (first must be writable)",
143 " -c check only, validate input without compiling or translating",
144 " -e<names> translate/compile only entries named by comma-separated list",
145 " -f format complex strings for readability",
146 " -G format %{number} to %'char'",
147 " -g format %'char' to %{number}",
148 " -I translate entries to terminfo source form",
149 " -L translate entries to full terminfo source form",
150 " -N disable smart defaults for source translation",
151 " -o<dir> set output directory for compiled entry writes",
152 " -R<name> restrict translation to given terminfo/termcap version",
153 " -r force resolution of all use entries in source translation",
154 " -s print summary statistics",
155 " -T remove size-restrictions on compiled description",
157 " -t suppress commented-out capabilities",
159 " -U suppress post-processing of entries",
161 " -v[n] set verbosity level",
162 " -w[n] set format width for translation output",
164 " -x treat unknown capabilities as user-defined",
168 " <file> file to translate or compile"
172 fprintf(stderr, "Usage: %s %s\n", _nc_progname, usage_string);
173 for (j = 0; j < SIZEOF(tbl); j++) {
174 fputs(tbl[j], stderr);
177 ExitProgram(EXIT_FAILURE);
190 char result[MAX_ENTRY_SIZE];
193 * Look for strings that contain %{number}, convert them to %'char',
194 * which is shorter and runs a little faster.
196 for (n = 0; n < STRCOUNT; n++) {
197 s = ep->tterm.Strings[n];
199 && strchr(s, L_BRACE) != 0) {
202 while ((ch = *t++) != 0) {
206 } else if ((ch == '%')
207 && (*t == L_BRACE)) {
209 long value = strtol(t + 1, &v, 0);
213 && value != '\\' /* FIXME */
215 && isprint((int) value)) {
224 if (strlen(result) < strlen(s))
225 _nc_STRCPY(s, result, strlen(s) + 1);
229 _nc_set_type(_nc_first_name(ep->tterm.term_names));
230 _nc_curr_line = (int) ep->startline;
231 _nc_write_entry(&ep->tterm);
235 immedhook(ENTRY * ep GCC_UNUSED)
236 /* write out entries with no use capabilities immediately to save storage */
240 * This is strictly a core-economy kluge. The really clean way to handle
241 * compilation is to slurp the whole file into core and then do all the
242 * name-collision checks and entry writes in one swell foop. But the
243 * terminfo master file is large enough that some core-poor systems swap
244 * like crazy when you compile it this way...there have been reports of
245 * this process taking *three hours*, rather than the twenty seconds or
246 * less typical on my development box.
248 * So. This hook *immediately* writes out the referenced entry if it
249 * has no use capabilities. The compiler main loop refrains from
250 * adding the entry to the in-core list when this hook fires. If some
251 * other entry later needs to reference an entry that got written
252 * immediately, that's OK; the resolution code will fetch it off disk
253 * when it can't find it in core.
255 * Name collisions will still be detected, just not as cleanly. The
256 * write_entry() code complains before overwriting an entry that
257 * postdates the time of tic's first call to write_entry(). Thus
258 * it will complain about overwriting entries newly made during the
259 * tic run, but not about overwriting ones that predate it.
261 * The reason this is a hook, and not in line with the rest of the
262 * compiler code, is that the support for termcap fallback cannot assume
263 * it has anywhere to spool out these entries!
265 * The _nc_set_type() call here requires a compensating one in
268 * If you define HAVE_BIG_CORE, you'll disable this kluge. This will
269 * make tic a bit faster (because the resolution code won't have to do
270 * disk I/O nearly as often).
272 if (ep->nuses == 0) {
273 int oldline = _nc_curr_line;
276 _nc_curr_line = oldline;
277 free(ep->tterm.str_table);
280 #endif /* HAVE_BIG_CORE */
286 /* emit a comment char, translating terminfo names to termcap names */
288 static bool in_name = FALSE;
289 static size_t have, used;
290 static char *namebuf, *suffix;
293 if (used + 1 >= have) {
295 namebuf = typeRealloc(char, have, namebuf);
296 suffix = typeRealloc(char, have, suffix);
298 if (c == '\n' || c == '@') {
299 namebuf[used++] = '\0';
301 (void) fputs(namebuf, stdout);
304 } else if (c != '>') {
305 namebuf[used++] = (char) c;
306 } else { /* ah! candidate name! */
308 NCURSES_CONST char *tp;
310 namebuf[used++] = '\0';
314 if ((up = strchr(namebuf, '#')) != 0
315 || (up = strchr(namebuf, '=')) != 0
316 || ((up = strchr(namebuf, '@')) != 0 && up[1] == '>')) {
317 _nc_STRCPY(suffix, up, have);
321 if ((tp = nametrans(namebuf)) != 0) {
323 (void) fputs(tp, stdout);
324 (void) fputs(suffix, stdout);
327 /* couldn't find a translation, just dump the name */
329 (void) fputs(namebuf, stdout);
330 (void) fputs(suffix, stdout);
344 /* Returns a string, stripped of leading/trailing whitespace */
350 while (isspace(UChar(*src)))
356 if ((dst = strdup(src)) == NULL) {
360 while (--len != 0 && isspace(UChar(dst[len])))
368 open_input(const char *filename)
370 FILE *fp = fopen(filename, "r");
374 fprintf(stderr, "%s: Can't open %s\n", _nc_progname, filename);
375 ExitProgram(EXIT_FAILURE);
377 if (fstat(fileno(fp), &sb) < 0
378 || (sb.st_mode & S_IFMT) != S_IFREG) {
379 fprintf(stderr, "%s: %s is not a file\n", _nc_progname, filename);
380 ExitProgram(EXIT_FAILURE);
385 /* Parse the "-e" option-value into a list of names */
387 make_namelist(char *src)
392 unsigned pass, n, nn;
397 } else if (strchr(src, '/') != 0) { /* a filename */
398 FILE *fp = open_input(src);
400 for (pass = 1; pass <= 2; pass++) {
402 while (fgets(buffer, sizeof(buffer), fp) != 0) {
403 if ((s = stripped(buffer)) != 0) {
412 dst = typeCalloc(char *, nn + 1);
417 } else { /* literal list of names */
418 for (pass = 1; pass <= 2; pass++) {
419 for (n = nn = 0, base = src;; n++) {
421 if (mark == ',' || mark == '\0') {
426 if ((s = stripped(base)) != 0)
435 dst = typeCalloc(char *, nn + 1);
438 if (showsummary && (dst != 0)) {
439 fprintf(log_fp, "Entries that will be compiled:\n");
440 for (n = 0; dst[n] != 0; n++)
441 fprintf(log_fp, "%u:%s\n", n + 1, dst[n]);
447 matches(char **needle, const char *haystack)
448 /* does entry in needle list match |-separated field in haystack? */
454 for (n = 0; needle[n] != 0; n++) {
455 if (_nc_name_match(haystack, needle[n], "|")) {
466 open_tempfile(char *name)
470 int fd = mkstemp(name);
472 result = fdopen(fd, "w");
474 if (tmpnam(name) != 0)
475 result = fopen(name, "w");
481 valid_db_path(const char *nominal)
485 char suffix[] = DBM_SUFFIX;
486 size_t need = strlen(nominal) + sizeof(suffix);
487 char *result = malloc(need);
489 _nc_STRCPY(result, nominal, need);
490 if (strcmp(result + need - sizeof(suffix), suffix)) {
491 _nc_STRCAT(result, suffix, need);
494 char *result = strdup(nominal);
497 DEBUG(1, ("** stat(%s)", result));
498 if (stat(result, &sb) >= 0) {
500 if (!S_ISREG(sb.st_mode)
501 || access(result, R_OK | W_OK) != 0) {
502 DEBUG(1, ("...not a writable file"));
507 if (!S_ISDIR(sb.st_mode)
508 || access(result, R_OK | W_OK | X_OK) != 0) {
509 DEBUG(1, ("...not a writable directory"));
515 /* check if parent is directory and is writable */
516 unsigned leaf = _nc_pathlast(result);
518 DEBUG(1, ("...not found"));
520 char save = result[leaf];
522 if (stat(result, &sb) >= 0
523 && S_ISDIR(sb.st_mode)
524 && access(result, R_OK | W_OK | X_OK) == 0) {
527 DEBUG(1, ("...parent directory %s is not writable", result));
532 DEBUG(1, ("... no parent directory"));
541 * Show the databases to which tic could write. The location to which it
542 * writes is always the first one. If none are writable, print an error
546 show_databases(const char *outdir)
548 bool specific = (outdir != 0) || getenv("TERMINFO") != 0;
550 const char *tried = 0;
553 outdir = _nc_tic_dir(0);
555 if ((result = valid_db_path(outdir)) != 0) {
556 printf("%s\n", result);
561 if ((outdir = _nc_home_terminfo())) {
562 if ((result = valid_db_path(outdir)) != 0) {
563 printf("%s\n", result);
564 } else if (!specific) {
570 * If we can write in neither location, give an error message.
574 fprintf(stderr, "%s: %s (no permission)\n", _nc_progname, tried);
575 ExitProgram(EXIT_FAILURE);
579 #define VtoTrace(opt) (unsigned) ((opt > 0) ? opt : (opt == 0))
582 main(int argc, char *argv[])
584 char my_tmpname[PATH_MAX];
586 unsigned debug_level;
587 int smart_defaults = TRUE;
591 int this_opt, last_opt = '?';
593 int outform = F_TERMINFO; /* output format */
594 int sortmode = S_TERMINFO; /* sort_mode */
598 bool formatted = FALSE; /* reformat complex strings? */
599 bool literal = FALSE; /* suppress post-processing? */
600 int numbers = 0; /* format "%'char'" to/from "%{number}" */
601 bool forceresolve = FALSE; /* force resolution */
603 char *tversion = (char *) NULL;
604 const char *source_file = "terminfo";
606 char *outdir = (char *) NULL;
607 bool check_only = FALSE;
608 bool suppress_untranslatable = FALSE;
612 _nc_progname = _nc_rootname(argv[0]);
614 if ((infodump = same_program(_nc_progname, PROG_CAPTOINFO)) != FALSE) {
615 outform = F_TERMINFO;
616 sortmode = S_TERMINFO;
618 if ((capdump = same_program(_nc_progname, PROG_INFOTOCAP)) != FALSE) {
620 sortmode = S_TERMCAP;
623 use_extended_names(FALSE);
628 * Processing arguments is a little complicated, since someone made a
629 * design decision to allow the numeric values for -w, -v options to
632 while ((this_opt = getopt(argc, argv,
633 "0123456789CDIKLNR:TUVace:fGgo:rstvwx")) != -1) {
634 if (isdigit(this_opt)) {
637 v_opt = (v_opt * 10) + (this_opt - '0');
640 width = (width * 10) + (this_opt - '0');
662 /* the initial version of -K in 20110730 fell-thru here, but the
663 * same flag is useful when reading sources -TD
669 sortmode = S_TERMCAP;
672 debug_level = VtoTrace(v_opt);
673 set_trace_level(debug_level);
674 show_databases(outdir);
675 ExitProgram(EXIT_SUCCESS);
679 outform = F_TERMINFO;
680 sortmode = S_TERMINFO;
684 outform = F_VARIABLE;
685 sortmode = S_VARIABLE;
688 smart_defaults = FALSE;
701 puts(curses_version());
703 ExitProgram(EXIT_SUCCESS);
708 namelst = make_namelist(optarg);
736 _nc_disable_period = FALSE;
737 suppress_untranslatable = TRUE;
740 _nc_disable_period = TRUE;
743 use_extended_names(TRUE);
752 debug_level = VtoTrace(v_opt);
753 set_trace_level(debug_level);
756 save_check_termtype = _nc_check_termtype2;
757 _nc_check_termtype2 = check_termtype;
761 * Aaargh! immedhook seriously hoses us!
763 * One problem with immedhook is it means we can't do -e. Problem
764 * is that we can't guarantee that for each terminal listed, all the
765 * terminals it depends on will have been kept in core for reference
766 * resolution -- in fact it's certain the primitive types at the end
767 * of reference chains *won't* be in core unless they were explicitly
768 * in the select list themselves.
770 if (namelst && (!infodump && !capdump)) {
771 (void) fprintf(stderr,
772 "%s: Sorry, -e can't be used without -I or -C\n",
775 ExitProgram(EXIT_FAILURE);
777 #endif /* HAVE_BIG_CORE */
780 source_file = argv[optind++];
783 "%s: Too many file names. Usage:\n\t%s %s",
787 ExitProgram(EXIT_FAILURE);
790 if (infodump == TRUE) {
791 /* captoinfo's no-argument case */
792 source_file = "/etc/termcap";
793 if ((termcap = getenv("TERMCAP")) != 0
794 && (namelst = make_namelist(getenv("TERM"))) != 0) {
795 if (access(termcap, F_OK) == 0) {
797 source_file = termcap;
799 _nc_STRCPY(my_tmpname,
802 if ((tmp_fp = open_tempfile(my_tmpname)) != 0) {
803 source_file = my_tmpname;
804 fprintf(tmp_fp, "%s\n", termcap);
806 tmp_fp = open_input(source_file);
807 to_remove = source_file;
816 "%s: File name needed. Usage:\n\t%s %s",
821 ExitProgram(EXIT_FAILURE);
826 tmp_fp = open_input(source_file);
833 sortmode, width, height, debug_level, formatted);
837 sortmode, width, height, debug_level, FALSE);
839 /* parse entries out of the source file */
840 _nc_set_source(source_file);
842 if (!(check_only || infodump || capdump))
843 _nc_set_writedir(outdir);
844 #endif /* HAVE_BIG_CORE */
845 _nc_read_entry_source(tmp_fp, (char *) NULL,
846 !smart_defaults || literal, FALSE,
847 ((check_only || infodump || capdump)
851 /* do use resolution */
852 if (check_only || (!infodump && !capdump) || forceresolve) {
853 if (!_nc_resolve_uses2(TRUE, literal) && !check_only) {
855 ExitProgram(EXIT_FAILURE);
860 if (check_only && (capdump || infodump)) {
862 if (matches(namelst, qp->tterm.term_names)) {
863 int len = fmt_entry(&qp->tterm, NULL, FALSE, TRUE, infodump, numbers);
865 if (len > (infodump ? MAX_TERMINFO_LENGTH : MAX_TERMCAP_LENGTH))
866 (void) fprintf(stderr,
867 "warning: resolved %s entry is %d bytes long\n",
868 _nc_first_name(qp->tterm.term_names),
874 /* write or dump all entries */
876 if (!infodump && !capdump) {
877 _nc_set_writedir(outdir);
879 if (matches(namelst, qp->tterm.term_names))
883 /* this is in case infotocap() generates warnings */
884 _nc_curr_col = _nc_curr_line = -1;
887 if (matches(namelst, qp->tterm.term_names)) {
888 long j = qp->cend - qp->cstart;
891 /* this is in case infotocap() generates warnings */
892 _nc_set_type(_nc_first_name(qp->tterm.term_names));
894 (void) fseek(tmp_fp, qp->cstart, SEEK_SET);
897 (void) putchar(fgetc(tmp_fp));
899 put_translate(fgetc(tmp_fp));
902 repair_acsc(&qp->tterm);
903 dump_entry(&qp->tterm, suppress_untranslatable,
904 limited, numbers, NULL);
905 for (j = 0; j < (long) qp->nuses; j++)
906 dump_uses(qp->uses[j].name, !capdump);
908 if (debug_level != 0 && !limited)
909 printf("# length=%d\n", len);
912 if (!namelst && _nc_tail) {
914 bool in_comment = FALSE;
915 bool trailing_comment = FALSE;
917 (void) fseek(tmp_fp, _nc_tail->cend, SEEK_SET);
918 while ((c = fgetc(tmp_fp)) != EOF) {
921 trailing_comment = TRUE;
928 && (in_comment || (oldc == '\n' && c == '\n')))
936 /* Show the directory into which entries were written, and the total
940 && (!(check_only || infodump || capdump))) {
941 int total = _nc_tic_written();
943 fprintf(log_fp, "%d entries written to %s\n",
945 _nc_tic_dir((char *) 0));
947 fprintf(log_fp, "No entries written\n");
950 ExitProgram(EXIT_SUCCESS);
954 * This bit of legerdemain turns all the terminfo variable names into
955 * references to locations in the arrays Booleans, Numbers, and Strings ---
956 * precisely what's needed (see comp_parse.c).
962 * Check if the alternate character-set capabilities are consistent.
965 check_acs(TERMTYPE *tp)
967 if (VALID_STRING(acs_chars)) {
968 const char *boxes = "lmkjtuvwqxn";
974 memset(mapped, 0, sizeof(mapped));
975 for (p = acs_chars; *p != '\0'; p += 2) {
977 _nc_warning("acsc has odd number of characters");
980 mapped[UChar(p[0])] = p[1];
983 if (mapped[UChar('I')] && !mapped[UChar('i')]) {
984 _nc_warning("acsc refers to 'I', which is probably an error");
987 for (p = boxes, q = missing; *p != '\0'; ++p) {
988 if (!mapped[UChar(p[0])]) {
994 assert(strlen(missing) <= strlen(boxes));
995 if (*missing != '\0' && strcmp(missing, boxes)) {
996 _nc_warning("acsc is missing some line-drawing mapping: %s", missing);
1002 * Check if the color capabilities are consistent
1005 check_colors(TERMTYPE *tp)
1007 if ((max_colors > 0) != (max_pairs > 0)
1008 || ((max_colors > max_pairs) && (initialize_pair == 0)))
1009 _nc_warning("inconsistent values for max_colors (%d) and max_pairs (%d)",
1010 max_colors, max_pairs);
1012 PAIRED(set_foreground, set_background);
1013 PAIRED(set_a_foreground, set_a_background);
1014 PAIRED(set_color_pair, initialize_pair);
1016 if (VALID_STRING(set_foreground)
1017 && VALID_STRING(set_a_foreground)
1018 && !_nc_capcmp(set_foreground, set_a_foreground))
1019 _nc_warning("expected setf/setaf to be different");
1021 if (VALID_STRING(set_background)
1022 && VALID_STRING(set_a_background)
1023 && !_nc_capcmp(set_background, set_a_background))
1024 _nc_warning("expected setb/setab to be different");
1026 /* see: has_colors() */
1027 if (VALID_NUMERIC(max_colors) && VALID_NUMERIC(max_pairs)
1028 && (((set_foreground != NULL)
1029 && (set_background != NULL))
1030 || ((set_a_foreground != NULL)
1031 && (set_a_background != NULL))
1032 || set_color_pair)) {
1033 if (!VALID_STRING(orig_pair) && !VALID_STRING(orig_colors))
1034 _nc_warning("expected either op/oc string for resetting colors");
1039 keypad_final(const char *string)
1043 if (VALID_STRING(string)
1044 && *string++ == '\033'
1046 && strlen(string) == 1) {
1054 keypad_index(const char *string)
1057 const char *list = "PQRSwxymtuvlqrsPpn"; /* app-keypad except "Enter" */
1061 if ((ch = keypad_final(string)) != '\0') {
1062 test = strchr(list, ch);
1064 result = (long) (test - list);
1070 * list[] is down, up, left, right
1071 * "left" may be ^H rather than \E[D
1072 * "down" may be ^J rather than \E[B
1073 * But up/right are generally consistently escape sequences for ANSI terminals.
1076 check_ansi_cursor(char *list[4])
1083 bool repeated = FALSE;
1085 for (j = 0; j < 4; ++j) {
1087 for (k = 0; k < j; ++k) {
1089 && !strcmp(list[j], list[k])) {
1090 char *value = _nc_tic_expand(list[k], TRUE, 0);
1091 _nc_warning("repeated cursor control %s\n", value);
1099 if (UChar(up[0]) == '\033') {
1105 } else if (UChar(up[0]) == UChar('\233')) {
1110 while (up[suffix] && isdigit(UChar(up[suffix])))
1113 if (prefix && up[suffix] == 'A') {
1115 if (!strcmp(list[0], "\n"))
1117 if (!strcmp(list[2], "\b"))
1120 for (j = 0; j < 4; ++j) {
1121 if (skip[j] || strlen(list[j]) == 1)
1123 if (memcmp(list[j], up, prefix)) {
1124 char *value = _nc_tic_expand(list[j], TRUE, 0);
1125 _nc_warning("inconsistent prefix for %s\n", value);
1128 if (strlen(list[j]) < suffix) {
1129 char *value = _nc_tic_expand(list[j], TRUE, 0);
1130 _nc_warning("inconsistent length for %s, expected %d\n",
1131 value, (int) suffix + 1);
1135 if (list[j][suffix] != want) {
1136 char *value = _nc_tic_expand(list[j], TRUE, 0);
1137 _nc_warning("inconsistent suffix for %s, expected %c, have %c\n",
1138 value, want, list[j][suffix]);
1145 #define EXPECTED(name) if (!PRESENT(name)) _nc_warning("expected " #name)
1148 check_cursor(TERMTYPE *tp)
1153 /* if we have a parameterized form, then the non-parameterized is easy */
1154 ANDMISSING(parm_down_cursor, cursor_down);
1155 ANDMISSING(parm_up_cursor, cursor_up);
1156 ANDMISSING(parm_left_cursor, cursor_left);
1157 ANDMISSING(parm_right_cursor, cursor_right);
1159 /* Given any of a set of cursor movement, the whole set should be present.
1160 * Technically this is not true (we could use cursor_address to fill in
1161 * unsupported controls), but it is likely.
1164 if (PRESENT(parm_down_cursor)) {
1165 list[count++] = parm_down_cursor;
1167 if (PRESENT(parm_up_cursor)) {
1168 list[count++] = parm_up_cursor;
1170 if (PRESENT(parm_left_cursor)) {
1171 list[count++] = parm_left_cursor;
1173 if (PRESENT(parm_right_cursor)) {
1174 list[count++] = parm_right_cursor;
1177 check_ansi_cursor(list);
1178 } else if (count != 0) {
1179 EXPECTED(parm_down_cursor);
1180 EXPECTED(parm_up_cursor);
1181 EXPECTED(parm_left_cursor);
1182 EXPECTED(parm_right_cursor);
1186 if (PRESENT(cursor_down)) {
1187 list[count++] = cursor_down;
1189 if (PRESENT(cursor_up)) {
1190 list[count++] = cursor_up;
1192 if (PRESENT(cursor_left)) {
1193 list[count++] = cursor_left;
1195 if (PRESENT(cursor_right)) {
1196 list[count++] = cursor_right;
1199 check_ansi_cursor(list);
1200 } else if (count != 0) {
1202 if (PRESENT(cursor_down) && strcmp(cursor_down, "\n"))
1204 if (PRESENT(cursor_left) && strcmp(cursor_left, "\b"))
1206 if (PRESENT(cursor_up) && strlen(cursor_up) > 1)
1208 if (PRESENT(cursor_right) && strlen(cursor_right) > 1)
1211 EXPECTED(cursor_down);
1212 EXPECTED(cursor_up);
1213 EXPECTED(cursor_left);
1214 EXPECTED(cursor_right);
1221 * Do a quick sanity-check for vt100-style keypads to see if the 5-key keypad
1222 * is mapped inconsistently.
1225 check_keypad(TERMTYPE *tp)
1229 if (VALID_STRING(key_a1) &&
1230 VALID_STRING(key_a3) &&
1231 VALID_STRING(key_b2) &&
1232 VALID_STRING(key_c1) &&
1233 VALID_STRING(key_c3)) {
1234 char final[MAX_KP + 1];
1241 final[0] = keypad_final(key_a1);
1242 final[1] = keypad_final(key_a3);
1243 final[2] = keypad_final(key_b2);
1244 final[3] = keypad_final(key_c1);
1245 final[4] = keypad_final(key_c3);
1248 /* special case: legacy coding using 1,2,3,0,. on the bottom */
1249 assert(strlen(final) <= MAX_KP);
1250 if (!strcmp(final, "qsrpn"))
1253 list[0] = keypad_index(key_a1);
1254 list[1] = keypad_index(key_a3);
1255 list[2] = keypad_index(key_b2);
1256 list[3] = keypad_index(key_c1);
1257 list[4] = keypad_index(key_c3);
1259 /* check that they're all vt100 keys */
1260 for (j = 0; j < MAX_KP; ++j) {
1266 /* check if they're all in increasing order */
1267 for (j = 1; j < MAX_KP; ++j) {
1268 if (list[j] > list[j - 1]) {
1272 if (increase != (MAX_KP - 1)) {
1275 for (j = 0, last = -1; j < MAX_KP; ++j) {
1276 for (k = 0, kk = -1, test = 100; k < 5; ++k) {
1277 if (list[k] > last &&
1284 assert(strlen(show) < (MAX_KP * 4));
1287 _nc_STRCAT(show, " ka1", sizeof(show));
1290 _nc_STRCAT(show, " ka3", sizeof(show));
1293 _nc_STRCAT(show, " kb2", sizeof(show));
1296 _nc_STRCAT(show, " kc1", sizeof(show));
1299 _nc_STRCAT(show, " kc3", sizeof(show));
1304 _nc_warning("vt100 keypad order inconsistent: %s", show);
1307 } else if (VALID_STRING(key_a1) ||
1308 VALID_STRING(key_a3) ||
1309 VALID_STRING(key_b2) ||
1310 VALID_STRING(key_c1) ||
1311 VALID_STRING(key_c3)) {
1313 if (keypad_index(key_a1) >= 0)
1314 _nc_STRCAT(show, " ka1", sizeof(show));
1315 if (keypad_index(key_a3) >= 0)
1316 _nc_STRCAT(show, " ka3", sizeof(show));
1317 if (keypad_index(key_b2) >= 0)
1318 _nc_STRCAT(show, " kb2", sizeof(show));
1319 if (keypad_index(key_c1) >= 0)
1320 _nc_STRCAT(show, " kc1", sizeof(show));
1321 if (keypad_index(key_c3) >= 0)
1322 _nc_STRCAT(show, " kc3", sizeof(show));
1324 _nc_warning("vt100 keypad map incomplete:%s", show);
1329 check_printer(TERMTYPE *tp)
1331 PAIRED(enter_doublewide_mode, exit_doublewide_mode);
1332 PAIRED(enter_italics_mode, exit_italics_mode);
1333 PAIRED(enter_leftward_mode, exit_leftward_mode);
1334 PAIRED(enter_micro_mode, exit_micro_mode);
1335 PAIRED(enter_shadow_mode, exit_shadow_mode);
1336 PAIRED(enter_subscript_mode, exit_subscript_mode);
1337 PAIRED(enter_superscript_mode, exit_superscript_mode);
1338 PAIRED(enter_upward_mode, exit_upward_mode);
1340 ANDMISSING(start_char_set_def, stop_char_set_def);
1342 /* if we have a parameterized form, then the non-parameterized is easy */
1343 ANDMISSING(set_bottom_margin_parm, set_bottom_margin);
1344 ANDMISSING(set_left_margin_parm, set_left_margin);
1345 ANDMISSING(set_right_margin_parm, set_right_margin);
1346 ANDMISSING(set_top_margin_parm, set_top_margin);
1348 ANDMISSING(parm_down_micro, micro_down);
1349 ANDMISSING(parm_left_micro, micro_left);
1350 ANDMISSING(parm_right_micro, micro_right);
1351 ANDMISSING(parm_up_micro, micro_up);
1355 * Returns the expected number of parameters for the given capability.
1358 expected_params(const char *name)
1361 static const struct {
1365 { "S0", 1 }, /* 'screen' extension */
1418 { "smgbp", 1 }, /* 2 if smgtp is not given */
1433 int result = 0; /* function-keys, etc., use none */
1435 for (n = 0; n < SIZEOF(table); n++) {
1436 if (!strcmp(name, table[n].name)) {
1437 result = table[n].count;
1446 * Make a quick sanity check for the parameters which are used in the given
1447 * strings. If there are no "%p" tokens, then there should be no other "%"
1451 check_params(TERMTYPE *tp, const char *name, char *value)
1453 int expected = expected_params(name);
1459 #ifdef set_top_margin_parm
1460 if (!strcmp(name, "smgbp")
1461 && set_top_margin_parm == 0)
1465 for (n = 0; n < 10; n++)
1471 _nc_warning("expected character after %% in %s", name);
1473 } else if (*s == 'p') {
1474 if (*++s == '\0' || !isdigit((int) *s)) {
1475 _nc_warning("expected digit after %%p in %s", name);
1489 _nc_warning("%s refers to parameter 0 (%%p0), which is not allowed", name);
1491 if (value == set_attributes || expected < 0) {
1493 } else if (expected != actual) {
1494 _nc_warning("%s uses %d parameters, expected %d", name,
1496 for (n = 1; n < actual; n++) {
1498 _nc_warning("%s omits parameter %d", name, n);
1506 while (*s == '/' || isdigit(UChar(*s)))
1512 * Skip a delay altogether, e.g., when comparing a simple string to sgr,
1513 * the latter may have a worst-case delay on the end.
1516 ignore_delays(char *s)
1549 * An sgr string may contain several settings other than the one we're
1550 * interested in, essentially sgr0 + rmacs + whatever. As long as the
1551 * "whatever" is contained in the sgr string, that is close enough for our
1555 similar_sgr(int num, char *a, char *b)
1557 static const char *names[] =
1579 _nc_warning("Did not find delay %s", _nc_visbuf(b));
1581 _nc_warning("checking sgr(%s) %s\n\tcompare to %s\n\tunmatched %s",
1582 names[num], _nc_visbuf2(1, base_a),
1583 _nc_visbuf2(2, base_b),
1587 } else if (delaying) {
1590 } else if ((*b == '0' || (*b == ';')) && *a == 'm') {
1612 /* ignore delays on the end of the string */
1613 a = ignore_delays(a);
1614 return ((num != 0) || (*a == 0));
1618 check_sgr(TERMTYPE *tp, char *zero, int num, char *cap, const char *name)
1623 test = TPARM_9(set_attributes,
1635 if (!similar_sgr(num, test, cap)) {
1636 _nc_warning("%s differs from sgr(%d)\n\t%s=%s\n\tsgr(%d)=%s",
1638 name, _nc_visbuf2(1, cap),
1639 num, _nc_visbuf2(2, test));
1641 } else if (_nc_capcmp(test, zero)) {
1642 _nc_warning("sgr(%d) present, but not %s", num, name);
1644 } else if (PRESENT(cap)) {
1645 _nc_warning("sgr(%d) missing, but %s present", num, name);
1648 _nc_warning("stack error in sgr(%d) string", num);
1652 #define CHECK_SGR(num,name) check_sgr(tp, zero, num, name, #name)
1656 * If tic is compiled with TRACE, we'll be able to see the output from the
1657 * DEBUG() macro. But since it doesn't use traceon(), it always goes to
1658 * the standard error. Use this function to make it simpler to follow the
1659 * resulting debug traces.
1662 show_where(unsigned level)
1664 if (_nc_tracing >= DEBUG_LEVEL(level)) {
1666 _nc_get_type(my_name);
1667 _tracef("\"%s\", line %d, '%s'",
1669 _nc_curr_line, my_name);
1674 #define show_where(level) /* nothing */
1677 /* other sanity-checks (things that we don't want in the normal
1678 * logic that reads a terminfo entry)
1681 check_termtype(TERMTYPE *tp, bool literal)
1683 bool conflict = FALSE;
1685 char fkeys[STRCOUNT];
1688 * A terminal entry may contain more than one keycode assigned to
1689 * a given string (e.g., KEY_END and KEY_LL). But curses will only
1690 * return one (the last one assigned).
1692 if (!(_nc_syntax == SYN_TERMCAP && capdump)) {
1693 memset(fkeys, 0, sizeof(fkeys));
1694 for (j = 0; _nc_tinfo_fkeys[j].code; j++) {
1695 char *a = tp->Strings[_nc_tinfo_fkeys[j].offset];
1697 if (!VALID_STRING(a))
1699 for (k = j + 1; _nc_tinfo_fkeys[k].code; k++) {
1700 char *b = tp->Strings[_nc_tinfo_fkeys[k].offset];
1701 if (!VALID_STRING(b)
1704 if (!_nc_capcmp(a, b)) {
1709 _nc_warning("Conflicting key definitions (using the last)");
1712 fprintf(stderr, "... %s is the same as %s",
1713 keyname((int) _nc_tinfo_fkeys[j].code),
1714 keyname((int) _nc_tinfo_fkeys[k].code));
1717 fprintf(stderr, ", %s",
1718 keyname((int) _nc_tinfo_fkeys[k].code));
1723 fprintf(stderr, "\n");
1727 for (j = 0; j < NUM_STRINGS(tp); j++) {
1728 char *a = tp->Strings[j];
1729 if (VALID_STRING(a))
1730 check_params(tp, ExtStrname(tp, (int) j, strnames), a);
1740 * These may be mismatched because the terminal description relies on
1741 * restoring the cursor visibility by resetting it.
1743 ANDMISSING(cursor_invisible, cursor_normal);
1744 ANDMISSING(cursor_visible, cursor_normal);
1746 if (PRESENT(cursor_visible) && PRESENT(cursor_normal)
1747 && !_nc_capcmp(cursor_visible, cursor_normal))
1748 _nc_warning("cursor_visible is same as cursor_normal");
1751 * From XSI & O'Reilly, we gather that sc/rc are required if csr is
1752 * given, because the cursor position after the scrolling operation is
1753 * performed is undefined.
1755 ANDMISSING(change_scroll_region, save_cursor);
1756 ANDMISSING(change_scroll_region, restore_cursor);
1759 * If we can clear tabs, we should be able to initialize them.
1761 ANDMISSING(clear_all_tabs, set_tab);
1763 if (PRESENT(set_attributes)) {
1767 if (PRESENT(exit_attribute_mode)) {
1768 zero = strdup(CHECK_SGR(0, exit_attribute_mode));
1770 zero = strdup(TPARM_9(set_attributes, 0, 0, 0, 0, 0, 0, 0, 0, 0));
1773 _nc_warning("stack error in sgr(0) string");
1776 CHECK_SGR(1, enter_standout_mode);
1777 CHECK_SGR(2, enter_underline_mode);
1778 CHECK_SGR(3, enter_reverse_mode);
1779 CHECK_SGR(4, enter_blink_mode);
1780 CHECK_SGR(5, enter_dim_mode);
1781 CHECK_SGR(6, enter_bold_mode);
1782 CHECK_SGR(7, enter_secure_mode);
1783 CHECK_SGR(8, enter_protected_mode);
1784 CHECK_SGR(9, enter_alt_charset_mode);
1787 _nc_warning("sgr(0) did not return a value");
1789 } else if (PRESENT(exit_attribute_mode) &&
1790 set_attributes != CANCELLED_STRING) {
1791 if (_nc_syntax == SYN_TERMINFO)
1792 _nc_warning("missing sgr string");
1795 if (PRESENT(exit_attribute_mode)) {
1796 char *check_sgr0 = _nc_trim_sgr0(tp);
1798 if (check_sgr0 == 0 || *check_sgr0 == '\0') {
1799 _nc_warning("trimmed sgr0 is empty");
1802 if (check_sgr0 != exit_attribute_mode) {
1804 ("will trim sgr0\n\toriginal sgr0=%s\n\ttrimmed sgr0=%s",
1805 _nc_visbuf2(1, exit_attribute_mode),
1806 _nc_visbuf2(2, check_sgr0)));
1810 ("will not trim sgr0\n\toriginal sgr0=%s",
1811 _nc_visbuf(exit_attribute_mode)));
1817 if (!auto_right_margin) {
1819 ("can write to lower-right directly"));
1820 } else if (PRESENT(enter_am_mode) && PRESENT(exit_am_mode)) {
1822 ("can write to lower-right by suppressing automargin"));
1823 } else if ((PRESENT(enter_insert_mode) && PRESENT(exit_insert_mode))
1824 || PRESENT(insert_character) || PRESENT(parm_ich)) {
1826 ("can write to lower-right by using inserts"));
1829 ("cannot write to lower-right"));
1834 * Some standard applications (e.g., vi) and some non-curses
1835 * applications (e.g., jove) get confused if we have both ich1 and
1836 * smir/rmir. Let's be nice and warn about that, too, even though
1837 * ncurses handles it.
1839 if ((PRESENT(enter_insert_mode) || PRESENT(exit_insert_mode))
1840 && PRESENT(parm_ich)) {
1841 _nc_warning("non-curses applications may be confused by ich1 with smir/rmir");
1845 * Finally, do the non-verbose checks
1847 if (save_check_termtype != 0)
1848 save_check_termtype(tp, literal);