1 /****************************************************************************
2 * Copyright (c) 1998-2018,2019 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 <tparm_type.h>
47 #include <hashed_db.h>
48 #include <parametrized.h>
49 #include <transform.h>
51 MODULE_ID("$Id: tic.c,v 1.278 2019/07/27 22:44:21 tom Exp $")
53 #define STDIN_NAME "<stdin>"
55 const char *_nc_progname = "tic";
59 static bool capdump = FALSE; /* running as infotocap? */
60 static bool infodump = FALSE; /* running as captoinfo? */
61 static bool showsummary = FALSE;
62 static unsigned debug_level;
63 static char **namelst = 0;
64 static const char *to_remove;
67 static bool using_extensions = FALSE;
70 static void (*save_check_termtype) (TERMTYPE2 *, bool);
71 static void check_termtype(TERMTYPE2 *tt, bool);
73 static const char usage_string[] = "\
104 free_namelist(char **src)
108 for (n = 0; src[n] != 0; ++n)
121 free_namelist(namelst);
122 _nc_leaks_dump_entry();
126 if (to_remove != 0) {
128 rc = remove(to_remove);
130 rc = unlink(to_remove);
138 failed(const char *msg)
141 ExitProgram(EXIT_FAILURE);
147 #define DATA(s) s "\n"
148 static const char options_string[] =
151 DATA(" -0 format translation output all capabilities on one line")
152 DATA(" -1 format translation output one capability per line")
154 DATA(" -a retain commented-out capabilities (sets -x also)")
156 DATA(" -C translate entries to termcap source form")
157 DATA(" -D print list of tic's database locations (first must be writable)")
158 DATA(" -c check only, validate input without compiling or translating")
159 DATA(" -e<names> translate/compile only entries named by comma-separated list")
160 DATA(" -f format complex strings for readability")
161 DATA(" -G format %{number} to %'char'")
162 DATA(" -g format %'char' to %{number}")
163 DATA(" -I translate entries to terminfo source form")
164 DATA(" -K translate entries to termcap source form with BSD syntax")
165 DATA(" -L translate entries to full terminfo source form")
166 DATA(" -N disable smart defaults for source translation")
167 DATA(" -o<dir> set output directory for compiled entry writes")
168 DATA(" -Q[n] dump compiled description")
169 DATA(" -q brief listing, removes headers")
170 DATA(" -R<name> restrict translation to given terminfo/termcap version")
171 DATA(" -r force resolution of all use entries in source translation")
172 DATA(" -s print summary statistics")
173 DATA(" -T remove size-restrictions on compiled description")
175 DATA(" -t suppress commented-out capabilities")
177 DATA(" -U suppress post-processing of entries")
178 DATA(" -V print version")
179 DATA(" -W wrap long strings according to -w[n] option")
180 DATA(" -v[n] set verbosity level")
181 DATA(" -w[n] set format width for translation output")
183 DATA(" -x treat unknown capabilities as user-defined")
187 DATA(" <file> file to translate or compile")
191 fprintf(stderr, "Usage: %s %s\n", _nc_progname, usage_string);
192 fputs(options_string, stderr);
193 ExitProgram(EXIT_FAILURE);
206 char result[MAX_ENTRY_SIZE];
209 * Look for strings that contain %{number}, convert them to %'char',
210 * which is shorter and runs a little faster.
212 for (n = 0; n < STRCOUNT; n++) {
213 s = ep->tterm.Strings[n];
215 && strchr(s, L_BRACE) != 0) {
218 while ((ch = *t++) != 0) {
222 } else if ((ch == '%')
223 && (*t == L_BRACE)) {
225 long value = strtol(t + 1, &v, 0);
229 && value != '\\' /* FIXME */
231 && isprint((int) value)) {
240 if (strlen(result) < strlen(s))
241 _nc_STRCPY(s, result, strlen(s) + 1);
245 _nc_set_type(_nc_first_name(ep->tterm.term_names));
246 _nc_curr_line = (int) ep->startline;
247 _nc_write_entry(&ep->tterm);
251 immedhook(ENTRY * ep GCC_UNUSED)
252 /* write out entries with no use capabilities immediately to save storage */
256 * This is strictly a core-economy kluge. The really clean way to handle
257 * compilation is to slurp the whole file into core and then do all the
258 * name-collision checks and entry writes in one swell foop. But the
259 * terminfo master file is large enough that some core-poor systems swap
260 * like crazy when you compile it this way...there have been reports of
261 * this process taking *three hours*, rather than the twenty seconds or
262 * less typical on my development box.
264 * So. This hook *immediately* writes out the referenced entry if it
265 * has no use capabilities. The compiler main loop refrains from
266 * adding the entry to the in-core list when this hook fires. If some
267 * other entry later needs to reference an entry that got written
268 * immediately, that's OK; the resolution code will fetch it off disk
269 * when it can't find it in core.
271 * Name collisions will still be detected, just not as cleanly. The
272 * write_entry() code complains before overwriting an entry that
273 * postdates the time of tic's first call to write_entry(). Thus
274 * it will complain about overwriting entries newly made during the
275 * tic run, but not about overwriting ones that predate it.
277 * The reason this is a hook, and not in line with the rest of the
278 * compiler code, is that the support for termcap fallback cannot assume
279 * it has anywhere to spool out these entries!
281 * The _nc_set_type() call here requires a compensating one in
284 * If you define HAVE_BIG_CORE, you'll disable this kluge. This will
285 * make tic a bit faster (because the resolution code won't have to do
286 * disk I/O nearly as often).
288 if (ep->nuses == 0) {
289 int oldline = _nc_curr_line;
292 _nc_curr_line = oldline;
293 free(ep->tterm.str_table);
296 #endif /* HAVE_BIG_CORE */
302 /* emit a comment char, translating terminfo names to termcap names */
304 static bool in_name = FALSE;
305 static size_t have, used;
306 static char *namebuf, *suffix;
309 if (used + 1 >= have) {
311 if ((namebuf = typeRealloc(char, have, namebuf)) == 0)
312 failed("put_translate namebuf");
313 if ((suffix = typeRealloc(char, have, suffix)) == 0)
314 failed("put_translate suffix");
316 if (c == '\n' || c == '@') {
317 namebuf[used++] = '\0';
319 (void) fputs(namebuf, stdout);
322 } else if (c != '>') {
323 namebuf[used++] = (char) c;
324 } else { /* ah! candidate name! */
326 NCURSES_CONST char *tp;
328 namebuf[used++] = '\0';
332 if ((up = strchr(namebuf, '#')) != 0
333 || (up = strchr(namebuf, '=')) != 0
334 || ((up = strchr(namebuf, '@')) != 0 && up[1] == '>')) {
335 _nc_STRCPY(suffix, up, have);
339 if ((tp = nametrans(namebuf)) != 0) {
341 (void) fputs(tp, stdout);
342 (void) fputs(suffix, stdout);
345 /* couldn't find a translation, just dump the name */
347 (void) fputs(namebuf, stdout);
348 (void) fputs(suffix, stdout);
362 /* Returns a string, stripped of leading/trailing whitespace */
368 while (isspace(UChar(*src)))
374 if ((dst = strdup(src)) == NULL) {
378 while (--len != 0 && isspace(UChar(dst[len])))
386 open_tempfile(char *filename)
390 _nc_STRCPY(filename, "/tmp/XXXXXX", PATH_MAX);
393 int oldmask = (int) umask(077);
394 int fd = mkstemp(filename);
396 result = fdopen(fd, "w");
397 umask((mode_t) oldmask);
400 if (tmpnam(filename) != 0)
401 result = fopen(filename, "w");
407 copy_input(FILE *source, const char *filename, char *alt_file)
409 char my_altfile[PATH_MAX];
415 alt_file = my_altfile;
418 failed("copy_input (source)");
419 } else if ((target = open_tempfile(alt_file)) == 0) {
420 failed("copy_input (target)");
427 } else if (ferror(source)) {
429 } else if (ch == 0) {
430 /* don't loop in case someone wants to convert /dev/zero */
431 fprintf(stderr, "%s: %s is not a text-file\n", _nc_progname, filename);
432 ExitProgram(EXIT_FAILURE);
438 * rewind() does not force the target file's data to disk (not does
439 * fflush()...). So open a second stream on the data and then close
440 * the one that we were writing on before starting to read from the
443 result = fopen(alt_file, "r+");
445 to_remove = strdup(alt_file);
451 open_input(const char *filename, char *alt_file)
457 if (!strcmp(filename, "-")) {
458 fp = copy_input(stdin, STDIN_NAME, alt_file);
459 } else if (stat(filename, &sb) < 0) {
460 fprintf(stderr, "%s: %s %s\n", _nc_progname, filename, strerror(errno));
461 ExitProgram(EXIT_FAILURE);
462 } else if ((mode = (sb.st_mode & S_IFMT)) == S_IFDIR
463 || (mode != S_IFREG && mode != S_IFCHR && mode != S_IFIFO)) {
464 fprintf(stderr, "%s: %s is not a file\n", _nc_progname, filename);
465 ExitProgram(EXIT_FAILURE);
467 fp = fopen(filename, "r");
470 fprintf(stderr, "%s: Can't open %s\n", _nc_progname, filename);
471 ExitProgram(EXIT_FAILURE);
473 if (mode != S_IFREG) {
475 FILE *fp2 = copy_input(fp, filename, alt_file);
478 fprintf(stderr, "%s: %s is not a file\n", _nc_progname, filename);
479 ExitProgram(EXIT_FAILURE);
486 /* Parse the "-e" option-value into a list of names */
488 make_namelist(char *src)
493 unsigned pass, n, nn;
498 } else if (strchr(src, '/') != 0) { /* a filename */
499 FILE *fp = open_input(src, (char *) 0);
501 for (pass = 1; pass <= 2; pass++) {
503 while (fgets(buffer, sizeof(buffer), fp) != 0) {
504 if ((s = stripped(buffer)) != 0) {
513 if ((dst = typeCalloc(char *, nn + 1)) == 0)
514 failed("make_namelist");
519 } else { /* literal list of names */
520 for (pass = 1; pass <= 2; pass++) {
521 for (n = nn = 0, base = src;; n++) {
523 if (mark == ',' || mark == '\0') {
528 if ((s = stripped(base)) != 0)
537 if ((dst = typeCalloc(char *, nn + 1)) == 0)
538 failed("make_namelist");
542 if (showsummary && (dst != 0)) {
543 fprintf(log_fp, "Entries that will be compiled:\n");
544 for (n = 0; dst[n] != 0; n++)
545 fprintf(log_fp, "%u:%s\n", n + 1, dst[n]);
551 matches(char **needle, const char *haystack)
552 /* does entry in needle list match |-separated field in haystack? */
558 for (n = 0; needle[n] != 0; n++) {
559 if (_nc_name_match(haystack, needle[n], "|")) {
570 valid_db_path(const char *nominal)
574 char suffix[] = DBM_SUFFIX;
575 size_t need = strlen(nominal) + sizeof(suffix);
576 char *result = malloc(need);
579 failed("valid_db_path");
580 _nc_STRCPY(result, nominal, need);
581 if (strcmp(result + need - sizeof(suffix), suffix)) {
582 _nc_STRCAT(result, suffix, need);
585 char *result = strdup(nominal);
588 DEBUG(1, ("** stat(%s)", result));
589 if (stat(result, &sb) >= 0) {
591 if (!S_ISREG(sb.st_mode)
592 || access(result, R_OK | W_OK) != 0) {
593 DEBUG(1, ("...not a writable file"));
598 if (!S_ISDIR(sb.st_mode)
599 || access(result, R_OK | W_OK | X_OK) != 0) {
600 DEBUG(1, ("...not a writable directory"));
606 /* check if parent is directory and is writable */
607 unsigned leaf = _nc_pathlast(result);
609 DEBUG(1, ("...not found"));
611 char save = result[leaf];
613 if (stat(result, &sb) >= 0
614 && S_ISDIR(sb.st_mode)
615 && access(result, R_OK | W_OK | X_OK) == 0) {
618 DEBUG(1, ("...parent directory %s is not writable", result));
623 DEBUG(1, ("... no parent directory"));
632 * Show the databases to which tic could write. The location to which it
633 * writes is always the first one. If none are writable, print an error
637 show_databases(const char *outdir)
639 bool specific = (outdir != 0) || getenv("TERMINFO") != 0;
641 const char *tried = 0;
644 outdir = _nc_tic_dir(0);
646 if ((result = valid_db_path(outdir)) != 0) {
647 printf("%s\n", result);
653 if ((outdir = _nc_home_terminfo())) {
654 if ((result = valid_db_path(outdir)) != 0) {
655 printf("%s\n", result);
657 } else if (!specific) {
663 * If we can write in neither location, give an error message.
667 fprintf(stderr, "%s: %s (no permission)\n", _nc_progname, tried);
668 ExitProgram(EXIT_FAILURE);
673 add_digit(int *target, int source)
675 *target = (*target * 10) + (source - '0');
679 main(int argc, char *argv[])
681 char my_tmpname[PATH_MAX];
682 char my_altfile[PATH_MAX];
684 int smart_defaults = TRUE;
688 int this_opt, last_opt = '?';
690 int outform = F_TERMINFO; /* output format */
691 int sortmode = S_TERMINFO; /* sort_mode */
695 bool formatted = FALSE; /* reformat complex strings? */
696 bool literal = FALSE; /* suppress post-processing? */
697 int numbers = 0; /* format "%'char'" to/from "%{number}" */
698 bool forceresolve = FALSE; /* force resolution */
700 char *tversion = (char *) NULL;
701 const char *source_file = "terminfo";
702 char *outdir = (char *) NULL;
703 bool check_only = FALSE;
704 bool suppress_untranslatable = FALSE;
707 bool wrap_strings = FALSE;
711 _nc_progname = _nc_rootname(argv[0]);
714 if ((infodump = same_program(_nc_progname, PROG_CAPTOINFO)) != FALSE) {
715 outform = F_TERMINFO;
716 sortmode = S_TERMINFO;
718 if ((capdump = same_program(_nc_progname, PROG_INFOTOCAP)) != FALSE) {
720 sortmode = S_TERMCAP;
723 use_extended_names(FALSE);
728 * Processing arguments is a little complicated, since someone made a
729 * design decision to allow the numeric values for -w, -v options to
732 while ((this_opt = getopt(argc, argv,
733 "0123456789CDIKLNQR:TUVWace:fGgo:qrstvwx")) != -1) {
734 if (isdigit(this_opt)) {
737 add_digit(&quickdump, this_opt);
740 add_digit(&v_opt, this_opt);
743 add_digit(&width, this_opt);
765 /* the initial version of -K in 20110730 fell-thru here, but the
766 * same flag is useful when reading sources -TD
772 sortmode = S_TERMCAP;
775 debug_level = VtoTrace(v_opt);
776 set_trace_level(debug_level);
777 show_databases(outdir);
778 ExitProgram(EXIT_SUCCESS);
782 outform = F_TERMINFO;
783 sortmode = S_TERMINFO;
787 outform = F_VARIABLE;
788 sortmode = S_VARIABLE;
791 smart_defaults = FALSE;
807 puts(curses_version());
808 ExitProgram(EXIT_SUCCESS);
816 namelst = make_namelist(optarg);
847 _nc_disable_period = FALSE;
848 suppress_untranslatable = TRUE;
851 _nc_disable_period = TRUE;
854 use_extended_names(TRUE);
855 using_extensions = TRUE;
864 debug_level = VtoTrace(v_opt);
865 set_trace_level(debug_level);
868 save_check_termtype = _nc_check_termtype2;
869 _nc_check_termtype2 = check_termtype;
873 * Aaargh! immedhook seriously hoses us!
875 * One problem with immedhook is it means we can't do -e. Problem
876 * is that we can't guarantee that for each terminal listed, all the
877 * terminals it depends on will have been kept in core for reference
878 * resolution -- in fact it's certain the primitive types at the end
879 * of reference chains *won't* be in core unless they were explicitly
880 * in the select list themselves.
882 if (namelst && (!infodump && !capdump)) {
883 (void) fprintf(stderr,
884 "%s: Sorry, -e can't be used without -I or -C\n",
886 ExitProgram(EXIT_FAILURE);
888 #endif /* HAVE_BIG_CORE */
891 source_file = argv[optind++];
894 "%s: Too many file names. Usage:\n\t%s %s",
898 ExitProgram(EXIT_FAILURE);
901 if (infodump == TRUE) {
902 /* captoinfo's no-argument case */
903 source_file = "/etc/termcap";
904 if ((termcap = getenv("TERMCAP")) != 0
905 && (namelst = make_namelist(getenv("TERM"))) != 0) {
906 if (access(termcap, F_OK) == 0) {
908 source_file = termcap;
910 if ((tmp_fp = open_tempfile(my_tmpname)) != 0) {
911 source_file = my_tmpname;
912 fprintf(tmp_fp, "%s\n", termcap);
914 tmp_fp = open_input(source_file, (char *) 0);
915 to_remove = source_file;
924 "%s: File name needed. Usage:\n\t%s %s",
928 ExitProgram(EXIT_FAILURE);
933 tmp_fp = open_input(source_file, my_altfile);
934 if (!strcmp(source_file, "-")) {
935 source_file = STDIN_NAME;
939 if (infodump || check_only) {
945 wrap_strings, width, height,
946 debug_level, formatted || check_only, check_only, quickdump);
947 } else if (capdump) {
951 wrap_strings, width, height,
952 debug_level, FALSE, FALSE, FALSE);
955 /* parse entries out of the source file */
956 _nc_set_source(source_file);
958 if (!(check_only || infodump || capdump))
959 _nc_set_writedir(outdir);
960 #endif /* HAVE_BIG_CORE */
961 _nc_read_entry_source(tmp_fp, (char *) NULL,
962 !smart_defaults || literal, FALSE,
963 ((check_only || infodump || capdump)
967 /* do use resolution */
968 if (check_only || (!infodump && !capdump) || forceresolve) {
969 if (!_nc_resolve_uses2(TRUE, literal) && !check_only) {
970 ExitProgram(EXIT_FAILURE);
975 if (check_only && limited && (capdump || infodump)) {
977 if (matches(namelst, qp->tterm.term_names)) {
978 int len = fmt_entry(&qp->tterm, NULL, FALSE, TRUE, infodump, numbers);
980 if (len > (infodump ? MAX_TERMINFO_LENGTH : MAX_TERMCAP_LENGTH))
981 (void) fprintf(stderr,
982 "%s: resolved %s entry is %d bytes long\n",
984 _nc_first_name(qp->tterm.term_names),
990 /* write or dump all entries */
992 /* this is in case infotocap() generates warnings */
993 _nc_curr_col = _nc_curr_line = -1;
996 if (matches(namelst, qp->tterm.term_names)) {
997 /* this is in case infotocap() generates warnings */
998 _nc_set_type(_nc_first_name(qp->tterm.term_names));
999 _nc_curr_line = (int) qp->startline;
1000 repair_acsc(&qp->tterm);
1001 dump_entry(&qp->tterm, suppress_untranslatable,
1002 limited, numbers, NULL);
1006 if (!infodump && !capdump) {
1007 _nc_set_writedir(outdir);
1008 for_entry_list(qp) {
1009 if (matches(namelst, qp->tterm.term_names))
1013 /* this is in case infotocap() generates warnings */
1014 _nc_curr_col = _nc_curr_line = -1;
1016 for_entry_list(qp) {
1017 if (matches(namelst, qp->tterm.term_names)) {
1018 long j = qp->cend - qp->cstart;
1021 /* this is in case infotocap() generates warnings */
1022 _nc_set_type(_nc_first_name(qp->tterm.term_names));
1025 (void) fseek(tmp_fp, qp->cstart, SEEK_SET);
1027 int ch = fgetc(tmp_fp);
1028 if (ch == EOF || ferror(tmp_fp)) {
1030 } else if (infodump) {
1038 repair_acsc(&qp->tterm);
1039 dump_entry(&qp->tterm, suppress_untranslatable,
1040 limited, numbers, NULL);
1041 for (j = 0; j < (long) qp->nuses; j++)
1042 dump_uses(qp->uses[j].name, !capdump);
1044 if (debug_level != 0 && !limited)
1045 printf("# length=%d\n", len);
1048 if (!namelst && _nc_tail && !quiet) {
1050 bool in_comment = FALSE;
1051 bool trailing_comment = FALSE;
1053 (void) fseek(tmp_fp, _nc_tail->cend, SEEK_SET);
1054 while ((c = fgetc(tmp_fp)) != EOF) {
1057 trailing_comment = TRUE;
1063 if (trailing_comment
1064 && (in_comment || (oldc == '\n' && c == '\n')))
1072 /* Show the directory into which entries were written, and the total
1076 && (!(check_only || infodump || capdump))) {
1077 int total = _nc_tic_written();
1079 fprintf(log_fp, "%d entries written to %s\n",
1081 _nc_tic_dir((char *) 0));
1083 fprintf(log_fp, "No entries written\n");
1085 ExitProgram(EXIT_SUCCESS);
1089 * This bit of legerdemain turns all the terminfo variable names into
1090 * references to locations in the arrays Booleans, Numbers, and Strings ---
1091 * precisely what's needed (see comp_parse.c).
1097 * Check if the alternate character-set capabilities are consistent.
1100 check_acs(TERMTYPE2 *tp)
1102 int vt100_smacs = 0;
1103 int vt100_rmacs = 0;
1104 int vt100_enacs = 0;
1107 * ena_acs is not always necessary, but if it is present, the enter/exit
1108 * capabilities should be.
1110 ANDMISSING(ena_acs, enter_alt_charset_mode);
1111 ANDMISSING(ena_acs, exit_alt_charset_mode);
1112 PAIRED(exit_alt_charset_mode, exit_alt_charset_mode);
1115 * vt100-like is frequently used, but perhaps ena_acs is missing, etc.
1117 if (VALID_STRING(enter_alt_charset_mode)) {
1118 vt100_smacs = (!strcmp("\033(0", enter_alt_charset_mode)
1120 : (!strcmp("\016", enter_alt_charset_mode)
1124 if (VALID_STRING(exit_alt_charset_mode)) {
1125 vt100_rmacs = (!strcmp("\033(B", exit_alt_charset_mode)
1127 : (!strcmp("\017", exit_alt_charset_mode)
1131 if (VALID_STRING(ena_acs)) {
1132 vt100_enacs = (!strcmp("\033(B\033)0", ena_acs)
1136 if (vt100_rmacs && vt100_smacs && (vt100_rmacs != vt100_smacs)) {
1137 _nc_warning("rmacs/smacs are inconsistent");
1139 if ((vt100_rmacs == 2) && (vt100_smacs == 2) && vt100_enacs) {
1140 _nc_warning("rmacs/smacs make enacs redundant");
1142 if ((vt100_rmacs == 1) && (vt100_smacs == 1) && !vt100_enacs) {
1143 _nc_warning("VT100-style rmacs/smacs require enacs");
1146 if (VALID_STRING(acs_chars)) {
1147 const char *boxes = "lmkjtuvwqxn";
1153 memset(mapped, 0, sizeof(mapped));
1154 for (p = acs_chars; *p != '\0'; p += 2) {
1156 _nc_warning("acsc has odd number of characters");
1159 mapped[UChar(p[0])] = p[1];
1162 if (mapped[UChar('I')] && !mapped[UChar('i')]) {
1163 _nc_warning("acsc refers to 'I', which is probably an error");
1166 for (p = boxes, q = missing; *p != '\0'; ++p) {
1167 if (!mapped[UChar(p[0])]) {
1173 assert(strlen(missing) <= strlen(boxes));
1174 if (*missing != '\0' && strcmp(missing, boxes)) {
1175 _nc_warning("acsc is missing some line-drawing mapping: %s", missing);
1181 same_color(NCURSES_CONST char *oldcap, NCURSES_CONST char *newcap, int limit)
1183 bool result = FALSE;
1189 for (n = same = 0; n < limit; ++n) {
1190 char *oldvalue = strdup(TPARM_1(oldcap, n));
1191 char *newvalue = strdup(TPARM_1(newcap, n));
1192 same += !strcmp(oldvalue, newvalue);
1196 result = (same == limit);
1202 * Check if the color capabilities are consistent
1205 check_colors(TERMTYPE2 *tp)
1209 if ((max_colors > 0) != (max_pairs > 0)
1210 || ((max_colors > max_pairs) && (initialize_pair == 0)))
1211 _nc_warning("inconsistent values for max_colors (%d) and max_pairs (%d)",
1212 max_colors, max_pairs);
1214 PAIRED(set_foreground, set_background);
1215 PAIRED(set_a_foreground, set_a_background);
1216 PAIRED(set_color_pair, initialize_pair);
1218 if (VALID_STRING(set_foreground)
1219 && VALID_STRING(set_a_foreground)) {
1220 if (!_nc_capcmp(set_foreground, set_a_foreground)) {
1221 _nc_warning("expected setf/setaf to be different");
1222 } else if (same_color(set_foreground, set_a_foreground, max_colors)) {
1223 _nc_warning("setf/setaf are equivalent");
1227 if (VALID_STRING(set_background)
1228 && VALID_STRING(set_a_background)) {
1229 if (!_nc_capcmp(set_background, set_a_background)) {
1230 _nc_warning("expected setb/setab to be different");
1231 } else if (same_color(set_background, set_a_background, max_colors)) {
1232 _nc_warning("setb/setab are equivalent");
1236 /* see: has_colors() */
1237 if (VALID_NUMERIC(max_colors) && VALID_NUMERIC(max_pairs)
1238 && ((VALID_STRING(set_foreground)
1239 && VALID_STRING(set_background))
1240 || (VALID_STRING(set_a_foreground)
1241 && VALID_STRING(set_a_background))
1242 || set_color_pair)) {
1243 if (!VALID_STRING(orig_pair) && !VALID_STRING(orig_colors))
1244 _nc_warning("expected either op/oc string for resetting colors");
1247 if (!VALID_STRING(initialize_pair) &&
1248 !VALID_STRING(initialize_color)) {
1249 _nc_warning("expected initc or initp because ccc is given");
1252 if (VALID_STRING(initialize_pair) ||
1253 VALID_STRING(initialize_color)) {
1254 _nc_warning("expected ccc because initc is given");
1257 value = tigetstr("RGB");
1258 if (VALID_STRING(value)) {
1261 int code = sscanf(value, "%d/%d/%d%c", &r, &g, &b, &bad);
1262 if (code != 3 || r <= 0 || g <= 0 || b <= 0) {
1263 _nc_warning("unexpected value for RGB capability: %s", value);
1269 csi_length(const char *value)
1273 if (value[0] == '\033' && value[1] == '[') {
1275 } else if (UChar(value[0]) == 0x9a) {
1282 keypad_final(const char *string)
1286 if (VALID_STRING(string)
1287 && *string++ == '\033'
1289 && strlen(string) == 1) {
1297 keypad_index(const char *string)
1300 const char *list = "PQRSwxymtuvlqrsPpn"; /* app-keypad except "Enter" */
1304 if ((ch = keypad_final(string)) != '\0') {
1305 test = (strchr) (list, ch);
1307 result = (long) (test - list);
1313 * list[] is down, up, left, right
1314 * "left" may be ^H rather than \E[D
1315 * "down" may be ^J rather than \E[B
1316 * But up/right are generally consistently escape sequences for ANSI terminals.
1319 check_ansi_cursor(char *list[4])
1325 bool repeated = FALSE;
1327 for (j = 0; j < 4; ++j) {
1329 for (k = 0; k < j; ++k) {
1331 && !strcmp(list[j], list[k])) {
1332 char *value = _nc_tic_expand(list[k], TRUE, 0);
1333 _nc_warning("repeated cursor control %s\n", value);
1340 size_t prefix = (size_t) csi_length(up);
1344 while (up[suffix] && isdigit(UChar(up[suffix])))
1347 if (prefix && up[suffix] == 'A') {
1349 if (!strcmp(list[0], "\n"))
1351 if (!strcmp(list[2], "\b"))
1354 for (j = 0; j < 4; ++j) {
1355 if (skip[j] || strlen(list[j]) == 1)
1357 if (memcmp(list[j], up, prefix)) {
1358 char *value = _nc_tic_expand(list[j], TRUE, 0);
1359 _nc_warning("inconsistent prefix for %s\n", value);
1362 if (strlen(list[j]) < suffix) {
1363 char *value = _nc_tic_expand(list[j], TRUE, 0);
1364 _nc_warning("inconsistent length for %s, expected %d\n",
1365 value, (int) suffix + 1);
1369 if (list[j][suffix] != want) {
1370 char *value = _nc_tic_expand(list[j], TRUE, 0);
1371 _nc_warning("inconsistent suffix for %s, expected %c, have %c\n",
1372 value, want, list[j][suffix]);
1379 #define EXPECTED(name) if (!PRESENT(name)) _nc_warning("expected " #name)
1380 #define UNEXPECTED(name) if (PRESENT(name)) _nc_warning("unexpected " #name ", for %s", why)
1383 check_noaddress(TERMTYPE2 *tp, const char *why)
1385 UNEXPECTED(column_address);
1386 UNEXPECTED(cursor_address);
1387 UNEXPECTED(cursor_home);
1388 UNEXPECTED(cursor_mem_address);
1389 UNEXPECTED(cursor_to_ll);
1390 UNEXPECTED(row_address);
1391 UNEXPECTED(row_address);
1395 check_cursor(TERMTYPE2 *tp)
1401 check_noaddress(tp, "hard_copy");
1402 } else if (generic_type) {
1403 check_noaddress(tp, "generic_type");
1404 } else if (strchr(tp->term_names, '+') == 0) {
1407 if (PRESENT(column_address))
1409 if (PRESENT(cursor_address))
1411 if (PRESENT(cursor_home))
1413 if (PRESENT(cursor_mem_address))
1415 if (PRESENT(cursor_to_ll))
1417 if (PRESENT(row_address))
1419 if (PRESENT(cursor_down))
1421 if (PRESENT(cursor_up))
1423 if (PRESENT(cursor_left))
1425 if (PRESENT(cursor_right))
1427 if (x < 2 && y < 2) {
1428 _nc_warning("terminal lacks cursor addressing");
1431 _nc_warning("terminal lacks cursor column-addressing");
1433 _nc_warning("terminal lacks cursor row-addressing");
1437 /* it is rare to have an insert-line feature without a matching delete */
1438 ANDMISSING(parm_insert_line, insert_line);
1439 ANDMISSING(parm_delete_line, delete_line);
1440 ANDMISSING(parm_insert_line, parm_delete_line);
1442 /* if we have a parameterized form, then the non-parameterized is easy */
1443 ANDMISSING(parm_down_cursor, cursor_down);
1444 ANDMISSING(parm_up_cursor, cursor_up);
1445 ANDMISSING(parm_left_cursor, cursor_left);
1446 ANDMISSING(parm_right_cursor, cursor_right);
1448 /* Given any of a set of cursor movement, the whole set should be present.
1449 * Technically this is not true (we could use cursor_address to fill in
1450 * unsupported controls), but it is likely.
1453 if (PRESENT(parm_down_cursor)) {
1454 list[count++] = parm_down_cursor;
1456 if (PRESENT(parm_up_cursor)) {
1457 list[count++] = parm_up_cursor;
1459 if (PRESENT(parm_left_cursor)) {
1460 list[count++] = parm_left_cursor;
1462 if (PRESENT(parm_right_cursor)) {
1463 list[count++] = parm_right_cursor;
1466 check_ansi_cursor(list);
1467 } else if (count != 0) {
1468 EXPECTED(parm_down_cursor);
1469 EXPECTED(parm_up_cursor);
1470 EXPECTED(parm_left_cursor);
1471 EXPECTED(parm_right_cursor);
1475 if (PRESENT(cursor_down)) {
1476 list[count++] = cursor_down;
1478 if (PRESENT(cursor_up)) {
1479 list[count++] = cursor_up;
1481 if (PRESENT(cursor_left)) {
1482 list[count++] = cursor_left;
1484 if (PRESENT(cursor_right)) {
1485 list[count++] = cursor_right;
1488 check_ansi_cursor(list);
1489 } else if (count != 0) {
1491 if (PRESENT(cursor_down) && strcmp(cursor_down, "\n"))
1493 if (PRESENT(cursor_left) && strcmp(cursor_left, "\b"))
1495 if (PRESENT(cursor_up) && strlen(cursor_up) > 1)
1497 if (PRESENT(cursor_right) && strlen(cursor_right) > 1)
1500 EXPECTED(cursor_down);
1501 EXPECTED(cursor_up);
1502 EXPECTED(cursor_left);
1503 EXPECTED(cursor_right);
1510 * Do a quick sanity-check for vt100-style keypads to see if the 5-key keypad
1511 * is mapped inconsistently.
1514 check_keypad(TERMTYPE2 *tp)
1518 if (VALID_STRING(key_a1) &&
1519 VALID_STRING(key_a3) &&
1520 VALID_STRING(key_b2) &&
1521 VALID_STRING(key_c1) &&
1522 VALID_STRING(key_c3)) {
1523 char final[MAX_KP + 1];
1530 final[0] = keypad_final(key_a1);
1531 final[1] = keypad_final(key_a3);
1532 final[2] = keypad_final(key_b2);
1533 final[3] = keypad_final(key_c1);
1534 final[4] = keypad_final(key_c3);
1537 /* special case: legacy coding using 1,2,3,0,. on the bottom */
1538 assert(strlen(final) <= MAX_KP);
1539 if (!strcmp(final, "qsrpn"))
1542 list[0] = keypad_index(key_a1);
1543 list[1] = keypad_index(key_a3);
1544 list[2] = keypad_index(key_b2);
1545 list[3] = keypad_index(key_c1);
1546 list[4] = keypad_index(key_c3);
1548 /* check that they're all vt100 keys */
1549 for (j = 0; j < MAX_KP; ++j) {
1555 /* check if they're all in increasing order */
1556 for (j = 1; j < MAX_KP; ++j) {
1557 if (list[j] > list[j - 1]) {
1561 if (increase != (MAX_KP - 1)) {
1564 for (j = 0, last = -1; j < MAX_KP; ++j) {
1565 for (k = 0, kk = -1, test = 100; k < 5; ++k) {
1566 if (list[k] > last &&
1573 assert(strlen(show) < (MAX_KP * 4));
1576 _nc_STRCAT(show, " ka1", sizeof(show));
1579 _nc_STRCAT(show, " ka3", sizeof(show));
1582 _nc_STRCAT(show, " kb2", sizeof(show));
1585 _nc_STRCAT(show, " kc1", sizeof(show));
1588 _nc_STRCAT(show, " kc3", sizeof(show));
1593 _nc_warning("vt100 keypad order inconsistent: %s", show);
1596 } else if (VALID_STRING(key_a1) ||
1597 VALID_STRING(key_a3) ||
1598 VALID_STRING(key_b2) ||
1599 VALID_STRING(key_c1) ||
1600 VALID_STRING(key_c3)) {
1602 if (keypad_index(key_a1) >= 0)
1603 _nc_STRCAT(show, " ka1", sizeof(show));
1604 if (keypad_index(key_a3) >= 0)
1605 _nc_STRCAT(show, " ka3", sizeof(show));
1606 if (keypad_index(key_b2) >= 0)
1607 _nc_STRCAT(show, " kb2", sizeof(show));
1608 if (keypad_index(key_c1) >= 0)
1609 _nc_STRCAT(show, " kc1", sizeof(show));
1610 if (keypad_index(key_c3) >= 0)
1611 _nc_STRCAT(show, " kc3", sizeof(show));
1613 _nc_warning("vt100 keypad map incomplete:%s", show);
1617 * These warnings are useful for consistency checks - it is possible that
1618 * there are real terminals with mismatches in these
1620 ANDMISSING(key_ic, key_dc);
1624 check_printer(TERMTYPE2 *tp)
1627 #if defined(enter_doublewide_mode) && defined(exit_doublewide_mode)
1628 PAIRED(enter_doublewide_mode, exit_doublewide_mode);
1630 #if defined(enter_italics_mode) && defined(exit_italics_mode)
1631 PAIRED(enter_italics_mode, exit_italics_mode);
1633 #if defined(enter_leftward_mode) && defined(exit_leftward_mode)
1634 PAIRED(enter_leftward_mode, exit_leftward_mode);
1636 #if defined(enter_micro_mode) && defined(exit_micro_mode)
1637 PAIRED(enter_micro_mode, exit_micro_mode);
1639 #if defined(enter_shadow_mode) && defined(exit_shadow_mode)
1640 PAIRED(enter_shadow_mode, exit_shadow_mode);
1642 #if defined(enter_subscript_mode) && defined(exit_subscript_mode)
1643 PAIRED(enter_subscript_mode, exit_subscript_mode);
1645 #if defined(enter_superscript_mode) && defined(exit_superscript_mode)
1646 PAIRED(enter_superscript_mode, exit_superscript_mode);
1648 #if defined(enter_upward_mode) && defined(exit_upward_mode)
1649 PAIRED(enter_upward_mode, exit_upward_mode);
1652 #if defined(start_char_set_def) && defined(stop_char_set_def)
1653 ANDMISSING(start_char_set_def, stop_char_set_def);
1656 /* if we have a parameterized form, then the non-parameterized is easy */
1657 #if defined(set_bottom_margin_parm) && defined(set_bottom_margin)
1658 ANDMISSING(set_bottom_margin_parm, set_bottom_margin);
1660 #if defined(set_left_margin_parm) && defined(set_left_margin)
1661 ANDMISSING(set_left_margin_parm, set_left_margin);
1663 #if defined(set_right_margin_parm) && defined(set_right_margin)
1664 ANDMISSING(set_right_margin_parm, set_right_margin);
1666 #if defined(set_top_margin_parm) && defined(set_top_margin)
1667 ANDMISSING(set_top_margin_parm, set_top_margin);
1670 #if defined(parm_down_micro) && defined(micro_down)
1671 ANDMISSING(parm_down_micro, micro_down);
1673 #if defined(parm_left_micro) && defined(micro_left)
1674 ANDMISSING(parm_left_micro, micro_left);
1676 #if defined(parm_right_micro) && defined(micro_right)
1677 ANDMISSING(parm_right_micro, micro_right);
1679 #if defined(parm_up_micro) && defined(micro_up)
1680 ANDMISSING(parm_up_micro, micro_up);
1686 uses_SGR_39_49(const char *value)
1688 return (strstr(value, "39;49") != 0
1689 || strstr(value, "49;39") != 0);
1693 * Check consistency of termcap extensions related to "screen".
1696 check_screen(TERMTYPE2 *tp)
1698 if (_nc_user_definable) {
1699 int have_XT = tigetflag("XT");
1700 int have_XM = tigetflag("XM");
1701 int have_bce = back_color_erase;
1702 bool have_kmouse = FALSE;
1703 bool use_sgr_39_49 = FALSE;
1704 char *name = _nc_first_name(tp->term_names);
1705 bool is_screen = !strncmp(name, "screen", 6);
1706 bool screen_base = (is_screen
1707 && strchr(name, '.') == 0);
1709 if (!VALID_BOOLEAN(have_bce)) {
1712 if (!VALID_BOOLEAN(have_XM)) {
1715 if (!VALID_BOOLEAN(have_XT)) {
1718 if (VALID_STRING(key_mouse)) {
1719 have_kmouse = !strcmp("\033[M", key_mouse);
1721 if (VALID_STRING(orig_colors)) {
1722 use_sgr_39_49 = uses_SGR_39_49(orig_colors);
1723 } else if (VALID_STRING(orig_pair)) {
1724 use_sgr_39_49 = uses_SGR_39_49(orig_pair);
1727 if (have_XM && have_XT) {
1728 _nc_warning("screen's XT capability conflicts with XM");
1729 } else if (have_XT && screen_base) {
1730 _nc_warning("screen's \"screen\" entries should not have XT set");
1731 } else if (have_XT) {
1732 if (!have_kmouse && is_screen) {
1733 if (VALID_STRING(key_mouse)) {
1734 _nc_warning("value of kmous inconsistent with screen's usage");
1736 _nc_warning("expected kmous capability with XT");
1739 if (!have_bce && max_colors > 0)
1740 _nc_warning("expected bce capability with XT");
1741 if (!use_sgr_39_49 && have_bce && max_colors > 0)
1742 _nc_warning("expected orig_colors capability with XT to have 39/49 parameters");
1743 if (VALID_STRING(to_status_line))
1744 _nc_warning("\"tsl\" capability is redundant, given XT");
1748 && !screen_base && strchr(name, '+') == 0) {
1749 _nc_warning("expected XT to be set, given kmous");
1755 #define check_screen(tp) /* nothing */
1759 * Returns the expected number of parameters for the given capability.
1762 expected_params(const char *name)
1764 #define DATA(name,count) { { name }, count }
1766 static const struct {
1770 DATA( "S0", 1 ), /* 'screen' extension */
1773 DATA( "colornm", 1 ),
1817 DATA( "setcolor", 1 ),
1821 DATA( "slength", 1 ),
1822 DATA( "slines", 1 ),
1823 DATA( "smgbp", 1 ), /* 2 if smgtp is not given */
1840 int result = 0; /* function-keys, etc., use none */
1842 for (n = 0; n < SIZEOF(table); n++) {
1843 if (!strcmp(name, table[n].name)) {
1844 result = table[n].count;
1853 * Check for user-capabilities that happen to be used in ncurses' terminal
1857 static struct user_table_entry const *
1858 lookup_user_capability(const char *name)
1860 struct user_table_entry const *result = 0;
1862 result = _nc_find_user_entry(name);
1869 * If a given name is likely to be a user-capability, return the number of
1870 * parameters it would be used with. If not, return -1.
1872 * ncurses assumes that u6 could be used for getting the cursor-position, but
1873 * that is not implemented. Make a special case for that, to quiet needless
1876 * The other string-capability extensions (see terminfo.src) which could have
1877 * parameters such as "Ss", "%u", are not used by ncurses. But we check those
1878 * anyway, to validate the terminfo database.
1881 is_user_capability(const char *name)
1884 if (name[0] == 'u' &&
1885 (name[1] >= '0' && name[1] <= '9') &&
1887 result = (name[1] == '6') ? 2 : 0;
1890 else if (using_extensions) {
1891 struct user_table_entry const *p = lookup_user_capability(name);
1893 result = (int) p->ute_argc;
1901 * Make a quick sanity check for the parameters which are used in the given
1902 * strings. If there are no "%p" tokens, then there should be no other "%"
1906 check_params(TERMTYPE2 *tp, const char *name, char *value, int extended)
1908 int expected = expected_params(name);
1911 bool params[NUM_PARM];
1914 #ifdef set_top_margin_parm
1915 if (!strcmp(name, "smgbp")
1916 && set_top_margin_parm == 0)
1920 for (n = 0; n < NUM_PARM; n++)
1926 _nc_warning("expected character after %% in %s", name);
1928 } else if (*s == 'p') {
1929 if (*++s == '\0' || !isdigit((int) *s)) {
1930 _nc_warning("expected digit after %%p in %s", name);
1945 int check = is_user_capability(name);
1946 if (check != actual && (check >= 0 && actual >= 0)) {
1947 _nc_warning("extended %s capability has %d parameters, expected %d",
1948 name, actual, check);
1949 } else if (debug_level > 1) {
1950 _nc_warning("extended %s capability has %d parameters, as expected",
1960 _nc_warning("%s refers to parameter 0 (%%p0), which is not allowed", name);
1962 if (value == set_attributes || expected < 0) {
1964 } else if (expected != actual) {
1965 _nc_warning("%s uses %d parameters, expected %d", name,
1967 for (n = 1; n < actual; n++) {
1969 _nc_warning("%s omits parameter %d", name, n);
1974 * Counting "%p" markers does not account for termcap expressions which
1975 * may not have been fully translated. Also, tparm does its own analysis.
1976 * Report differences here.
1979 char *p_is_s[NUM_PARM];
1981 int analyzed = _nc_tparm_analyze(value, p_is_s, &popcount);
1982 if (analyzed < popcount) {
1983 analyzed = popcount;
1985 if (actual != analyzed && expected != analyzed) {
1987 int user_cap = is_user_capability(name);
1988 if ((user_cap == analyzed) && using_extensions) {
1990 } else if (user_cap >= 0) {
1991 _nc_warning("tparm will use %d parameters for %s, expected %d",
1992 analyzed, name, user_cap);
1996 _nc_warning("tparm analyzed %d parameters for %s, expected %d",
1997 analyzed, name, actual);
2004 line_capability(const char *name)
2006 bool result = FALSE;
2007 static const char *table[] =
2009 "csr", /* change_scroll_region */
2010 "clear", /* clear_screen */
2012 "cwin", /* create_window */
2013 "cup", /* cursor_address */
2014 "cud1", /* cursor_down */
2015 "home", /* cursor_home */
2016 "mrcup", /* cursor_mem_address */
2017 "ll", /* cursor_to_ll */
2018 "cuu1", /* cursor_up */
2019 "dl1", /* delete_line */
2020 "hd", /* down_half_line */
2021 "flash", /* flash_screen */
2022 "ff", /* form_feed */
2023 "il1", /* insert_line */
2024 "nel", /* newline */
2025 "dl", /* parm_delete_line */
2026 "cud", /* parm_down_cursor */
2027 "indn", /* parm_index */
2028 "il", /* parm_insert_line */
2029 "rin", /* parm_rindex */
2030 "cuu", /* parm_up_cursor */
2031 "mc0", /* print_screen */
2032 "vpa", /* row_address */
2033 "ind", /* scroll_forward */
2034 "ri", /* scroll_reverse */
2035 "hu", /* up_half_line */
2038 for (n = 0; n < SIZEOF(table); ++n) {
2039 if (!strcmp(name, table[n])) {
2048 * Check for DEC VT100 private mode for reverse video.
2051 skip_DECSCNM(const char *value, int *flag)
2055 int skip = csi_length(value);
2057 value[skip++] == '?' &&
2058 value[skip++] == '5') {
2059 if (value[skip] == 'h') {
2061 } else if (value[skip] == 'l') {
2071 check_delays(TERMTYPE2 *tp, const char *name, const char *value)
2074 const char *first = 0;
2075 const char *last = 0;
2077 for (p = value; *p != '\0'; ++p) {
2078 if (p[0] == '$' && p[1] == '<') {
2079 const char *base = p + 2;
2080 const char *mark = 0;
2083 int proportional = 0;
2088 for (q = base; *q != '\0'; ++q) {
2093 } else if (*q == '*' || *q == '/') {
2100 } else if (!(isalnum(UChar(*q)) || strchr("+-.", *q) != 0)) {
2103 } else if (proportional || mandatory) {
2107 last = *q ? (q + 1) : q;
2109 maybe = FALSE; /* just an isolated "$<" */
2113 int rc = sscanf(base, "%f%c", &check_f, &check_c);
2114 if ((rc != 2) || (check_c != *mark) || mixed) {
2115 _nc_warning("syntax error in %s delay '%.*s'", name,
2116 (int) (q - base), base);
2117 } else if (*name == 'k') {
2118 _nc_warning("function-key %s has delay", name);
2119 } else if (proportional && !line_capability(name)) {
2120 _nc_warning("non-line capability using proportional delay: %s", name);
2121 } else if (!xon_xoff &&
2123 strchr(_nc_first_name(tp->term_names), '+') == 0) {
2124 _nc_warning("%s in %s is used since no xon/xoff",
2126 ? "proportional delay"
2131 p = q - 1; /* restart scan */
2136 if (!strcmp(name, "flash") ||
2137 !strcmp(name, "beep")) {
2140 if (first == value || *last == 0) {
2142 * Delay is on one end or the other.
2144 _nc_warning("expected delay embedded within %s", name);
2150 * Check for missing delay when using VT100 reverse-video.
2151 * A real VT100 might not need this, but terminal emulators do.
2153 if ((p = skip_DECSCNM(value, &flag)) != 0 &&
2155 (q = skip_DECSCNM(p, &flag)) != 0 &&
2157 _nc_warning("expected a delay in %s", name);
2164 check_1_infotocap(const char *name, NCURSES_CONST char *value, int count)
2168 long numbers[1 + NUM_PARM];
2169 char *strings[1 + NUM_PARM];
2170 char *p_is_s[NUM_PARM];
2172 char blob[NUM_PARM * 10];
2176 for (k = 1; k <= NUM_PARM; k++) {
2179 _nc_SLIMIT(sizeof(blob) - (size_t) (next - blob))
2182 next += strlen(next) + 1;
2185 switch (tparm_type(name)) {
2187 result = TPARM_2(value, numbers[1], strings[2]);
2190 result = TPARM_3(value, numbers[1], strings[2], strings[3]);
2194 (void) _nc_tparm_analyze(value, p_is_s, &ignored);
2195 #define myParam(n) (p_is_s[n - 1] != 0 ? ((TPARM_ARG) strings[n]) : numbers[n])
2196 result = TPARM_9(value,
2208 return strdup(result);
2211 #define IsDelay(ch) ((ch) == '.' || isdigit(UChar(ch)))
2214 parse_delay_value(const char *src, double *delays, int *always)
2222 while (isdigit(UChar(*src))) {
2223 (*delays) = (*delays) * 10 + (*src++ - '0');
2229 while (isdigit(UChar(*src))) {
2231 (*delays) += (*src++ - '0') / gotdot;
2234 while (*src == '*' || *src == '/') {
2235 if (always == 0 && *src == '/')
2237 if (*src++ == '*') {
2244 *delays = -(*delays);
2249 parse_ti_delay(const char *ti, double *delays)
2252 while (*ti != '\0') {
2258 && IsDelay(UChar(ti[2]))) {
2260 const char *last = parse_delay_value(ti + 2, delays, &ignored);
2272 parse_tc_delay(const char *tc, double *delays)
2274 return parse_delay_value(tc, delays, (int *) 0);
2278 * Compare terminfo- and termcap-strings, factoring out delays.
2281 same_ti_tc(const char *ti, const char *tc, bool * embedded)
2284 double ti_delay = 0.0;
2285 double tc_delay = 0.0;
2286 const char *ti_last;
2289 ti_last = parse_ti_delay(ti, &ti_delay);
2290 tc = parse_tc_delay(tc, &tc_delay);
2292 while ((ti < ti_last) && *tc) {
2293 if (*ti == '\\' && ispunct(UChar(ti[1]))) {
2295 if ((*ti == '^') && !strncmp(tc, "\\136", 4)) {
2300 } else if (ti[0] == '$' && ti[1] == '<') {
2302 const char *ss = parse_ti_delay(ti, &no_delay);
2309 if (*tc == '\\' && ispunct(UChar(tc[1]))) {
2312 if (*ti++ != *tc++) {
2322 *embedded = FALSE; /* report only one problem */
2330 * Check terminfo to termcap translation.
2333 check_infotocap(TERMTYPE2 *tp, int i, const char *value)
2335 const char *name = ExtStrname(tp, i, strnames);
2336 int params = ((i < (int) SIZEOF(parametrized))
2340 : has_params(value)));
2346 assert(SIZEOF(parametrized) == STRCOUNT);
2347 if ((ti_value = _nc_tic_expand(value, TRUE, to_char)) == ABSENT_STRING) {
2348 _nc_warning("tic-expansion of %s failed", name);
2349 } else if ((tc_value = _nc_infotocap(name, ti_value, params)) == ABSENT_STRING) {
2350 _nc_warning("tic-conversion of %s failed", name);
2351 } else if (params > 0) {
2356 if (!strcmp(name, "setf")
2357 || !strcmp(name, "setb")
2358 || !strcmp(name, "setaf")
2359 || !strcmp(name, "setab")) {
2360 if ((limit = max_colors) > 16)
2363 for (count = 0; count < limit; ++count) {
2364 char *ti_check = check_1_infotocap(name, ti_value, count);
2365 char *tc_check = check_1_infotocap(name, tc_value, count);
2367 if (strcmp(ti_check, tc_check)) {
2369 fprintf(stderr, "check_infotocap(%s)\n", name);
2370 fprintf(stderr, "...ti '%s'\n", ti_value);
2371 fprintf(stderr, "...tc '%s'\n", tc_value);
2374 _nc_warning("tparm-conversion of %s(%d) differs between\n\tterminfo %s\n\ttermcap %s",
2375 name, count, ti_check, tc_check);
2380 } else if (params == 0 && !same_ti_tc(ti_value, tc_value, &embedded)) {
2382 _nc_warning("termcap equivalent of %s cannot use embedded delay", name);
2384 _nc_warning("tic-conversion of %s changed value\n\tfrom %s\n\tto %s",
2385 name, ti_value, tc_value);
2393 while (*s == '/' || isdigit(UChar(*s)))
2399 * Skip a delay altogether, e.g., when comparing a simple string to sgr,
2400 * the latter may have a worst-case delay on the end.
2403 ignore_delays(char *s)
2435 #define DATA(name) { #name }
2436 static const char sgr_names[][11] =
2453 * An sgr string may contain several settings other than the one we're
2454 * interested in, essentially sgr0 + rmacs + whatever. As long as the
2455 * "whatever" is contained in the sgr string, that is close enough for our
2459 similar_sgr(int num, char *a, char *b)
2470 } else if (b[0] == '$'
2472 _nc_warning("did not find delay %s", _nc_visbuf(b));
2474 _nc_warning("checking sgr(%s) %s\n\tcompare to %s\n\tunmatched %s",
2475 sgr_names[num], _nc_visbuf2(1, base_a),
2476 _nc_visbuf2(2, base_b),
2480 } else if (delaying) {
2483 } else if ((*b == '0' || (*b == ';')) && *a == 'm') {
2505 /* ignore delays on the end of the string */
2506 a = ignore_delays(a);
2507 return ((num != 0) || (*a == 0));
2511 check_sgr(TERMTYPE2 *tp, char *zero, int num, char *cap, const char *name)
2516 test = TPARM_9(set_attributes,
2528 if (!similar_sgr(num, test, cap)) {
2529 _nc_warning("%s differs from sgr(%d)\n\t%s=%s\n\tsgr(%d)=%s",
2531 name, _nc_visbuf2(1, cap),
2532 num, _nc_visbuf2(2, test));
2534 } else if (_nc_capcmp(test, zero)) {
2535 _nc_warning("sgr(%d) present, but not %s", num, name);
2537 } else if (PRESENT(cap)) {
2538 _nc_warning("sgr(%d) missing, but %s present", num, name);
2541 _nc_warning("stack error in sgr(%d) string", num);
2545 #define CHECK_SGR(num,name) check_sgr(tp, zero, num, name, #name)
2549 * If tic is compiled with TRACE, we'll be able to see the output from the
2550 * DEBUG() macro. But since it doesn't use traceon(), it always goes to
2551 * the standard error. Use this function to make it simpler to follow the
2552 * resulting debug traces.
2555 show_where(unsigned level)
2557 if (_nc_tracing >= DEBUG_LEVEL(level)) {
2558 char my_name[MAX_NAME_SIZE];
2559 _nc_get_type(my_name);
2560 _tracef("\"%s\", line %d, '%s'",
2562 _nc_curr_line, my_name);
2567 #define show_where(level) /* nothing */
2577 get_fkey_list(TERMTYPE2 *tp)
2579 NAME_VALUE *result = typeMalloc(NAME_VALUE, NUM_STRINGS(tp) + 1);
2580 const struct tinfo_fkeys *all_fkeys = _nc_tinfo_fkeys;
2585 failed("get_fkey_list");
2587 for (j = 0; all_fkeys[j].code; j++) {
2588 char *a = tp->Strings[all_fkeys[j].offset];
2589 if (VALID_STRING(a)) {
2590 result[used].keycode = (int) all_fkeys[j].code;
2591 result[used].name = strnames[all_fkeys[j].offset];
2592 result[used].value = a;
2597 for (j = STRCOUNT; j < NUM_STRINGS(tp); ++j) {
2598 const char *name = ExtStrname(tp, (int) j, strnames);
2600 result[used].keycode = -1;
2601 result[used].name = name;
2602 result[used].value = tp->Strings[j];
2607 result[used].keycode = 0;
2612 show_fkey_name(NAME_VALUE * data)
2614 if (data->keycode > 0) {
2615 fprintf(stderr, " %s", keyname(data->keycode));
2616 fprintf(stderr, " (capability \"%s\")", data->name);
2618 fprintf(stderr, " capability \"%s\"", data->name);
2623 * A terminal entry may contain more than one keycode assigned to a given
2624 * string (e.g., KEY_END and KEY_LL). But curses will only return one (the
2625 * last one assigned).
2628 check_conflict(TERMTYPE2 *tp)
2630 bool conflict = FALSE;
2633 if (!(_nc_syntax == SYN_TERMCAP && capdump)) {
2634 char *check = calloc((size_t) (NUM_STRINGS(tp) + 1), sizeof(char));
2635 NAME_VALUE *given = get_fkey_list(tp);
2638 failed("check_conflict");
2640 for (j = 0; given[j].keycode; ++j) {
2641 const char *a = given[j].value;
2644 if (!VALID_STRING(a))
2647 for (k = j + 1; given[k].keycode; k++) {
2648 const char *b = given[k].value;
2650 if (!VALID_STRING(b))
2655 if (!_nc_capcmp(a, b)) {
2660 _nc_warning("conflicting key definitions (using the last)");
2663 fprintf(stderr, "...");
2664 show_fkey_name(given + j);
2665 fprintf(stderr, " is the same as");
2666 show_fkey_name(given + k);
2669 fprintf(stderr, ", ");
2670 show_fkey_name(given + k);
2675 fprintf(stderr, "\n");
2678 if (using_extensions) {
2681 const char *xcurses;
2682 const char *shifted;
2698 * SVr4 curses defines the "xcurses" names listed above except for
2699 * the special cases in the "shifted" column. When using these
2700 * names for xterm's extensions, that was confusing, and resulted
2701 * in adding extended capabilities with "2" (shift) suffix. This
2702 * check warns about unnecessary use of extensions for this quirk.
2704 for (j = 0; given[j].keycode; ++j) {
2705 const char *find = given[j].name;
2709 if (!VALID_STRING(given[j].value))
2712 for (k = 0; table[k].xcurses; ++k) {
2713 const char *test = table[k].xcurses;
2714 size_t size = strlen(test);
2716 if (!strncmp(find, test, size) && strcmp(find, test)) {
2717 switch (sscanf(find + size, "%d%c", &value, &ch)) {
2720 _nc_warning("expected '%s' rather than '%s'",
2724 } else if (value < 2 || value > 15) {
2725 _nc_warning("expected numeric 2..15 '%s'", find);
2729 _nc_warning("expected numeric suffix for '%s'", find);
2744 * Exiting a video mode should not duplicate sgr0
2747 check_exit_attribute(const char *name, char *test, char *trimmed, char *untrimmed)
2749 if (VALID_STRING(test) && (trimmed != 0)) {
2750 if (similar_sgr(-1, trimmed, test) ||
2751 similar_sgr(-1, untrimmed, test)) {
2752 _nc_warning("%s matches exit_attribute_mode", name);
2758 * Returns true if the string looks like a standard SGR string.
2761 is_sgr_string(char *value)
2763 bool result = FALSE;
2765 if (VALID_STRING(value)) {
2766 int skip = csi_length(value);
2773 while ((ch = UChar(*value++)) != '\0') {
2774 if (isdigit(ch) || ch == ';') {
2776 } else if (ch == 'm' && *value == '\0') {
2789 * Check if the given capability contains a given SGR attribute.
2792 check_sgr_param(TERMTYPE2 *tp, int code, const char *name, char *value)
2794 if (VALID_STRING(value)) {
2795 int ncv = ((code != 0) ? (1 << (code - 1)) : 0);
2796 char *test = tgoto(value, 0, 0);
2797 if (is_sgr_string(test)) {
2801 int color = (value == set_a_foreground ||
2802 value == set_a_background ||
2803 value == set_foreground ||
2804 value == set_background);
2805 while (*test != 0) {
2806 if (isdigit(UChar(*test))) {
2807 param = 10 * param + (*test - '0');
2812 * Avoid unnecessary warning for xterm 256color codes.
2814 if (color && (param == 38 || param == 48))
2816 if ((skips-- <= 0) && (param == code))
2824 if (count != 0 && param == code) {
2826 no_color_video < 0 ||
2827 !(no_color_video & ncv)) {
2828 _nc_warning("\"%s\" SGR-attribute used in %s",
2839 standard_type(const char *name)
2842 const struct name_table_entry *np;
2844 if ((np = _nc_find_entry(name, _nc_get_hash_table(0))) != 0) {
2845 result = np->nte_type;
2851 name_of_type(int type)
2853 const char *result = "unknown";
2869 check_user_capability_type(const char *name, int actual)
2871 if (lookup_user_capability(name) == 0) {
2872 int expected = standard_type(name);
2873 if (expected >= 0) {
2874 _nc_warning("expected %s to be %s, but actually %s",
2876 name_of_type(actual),
2877 name_of_type(expected)
2879 } else if (*name != 'k') {
2880 _nc_warning("undocumented %s capability %s",
2881 name_of_type(actual),
2888 /* other sanity-checks (things that we don't want in the normal
2889 * logic that reads a terminfo entry)
2892 check_termtype(TERMTYPE2 *tp, bool literal)
2898 for_each_string(j, tp) {
2899 char *a = tp->Strings[j];
2900 if (VALID_STRING(a)) {
2901 const char *name = ExtStrname(tp, (int) j, strnames);
2903 * If we expect parameters, or if there might be parameters,
2904 * check for consistent number of parameters.
2906 if (j >= SIZEOF(parametrized) ||
2907 is_user_capability(name) >= 0 ||
2908 parametrized[j] > 0) {
2909 check_params(tp, name, a, (j >= STRCOUNT));
2911 check_delays(tp, ExtStrname(tp, (int) j, strnames), a);
2913 check_infotocap(tp, (int) j, a);
2918 /* in extended mode, verify that each extension is expected type */
2919 for_each_ext_boolean(j, tp) {
2920 check_user_capability_type(ExtBoolname(tp, (int) j, strnames), BOOLEAN);
2922 for_each_ext_number(j, tp) {
2923 check_user_capability_type(ExtNumname(tp, (int) j, strnames), NUMBER);
2925 for_each_ext_string(j, tp) {
2926 check_user_capability_type(ExtStrname(tp, (int) j, strnames), STRING);
2928 #endif /* NCURSES_XNAMES */
2938 * These are probably both or none.
2940 PAIRED(parm_index, parm_rindex);
2943 * These may be mismatched because the terminal description relies on
2944 * restoring the cursor visibility by resetting it.
2946 ANDMISSING(cursor_invisible, cursor_normal);
2947 ANDMISSING(cursor_visible, cursor_normal);
2949 if (PRESENT(cursor_visible) && PRESENT(cursor_normal)
2950 && !_nc_capcmp(cursor_visible, cursor_normal))
2951 _nc_warning("cursor_visible is same as cursor_normal");
2954 * From XSI & O'Reilly, we gather that sc/rc are required if csr is
2955 * given, because the cursor position after the scrolling operation is
2956 * performed is undefined.
2958 ANDMISSING(change_scroll_region, save_cursor);
2959 ANDMISSING(change_scroll_region, restore_cursor);
2962 * If we can clear tabs, we should be able to initialize them.
2964 ANDMISSING(clear_all_tabs, set_tab);
2966 if (PRESENT(set_attributes)) {
2970 if (PRESENT(exit_attribute_mode)) {
2971 zero = strdup(CHECK_SGR(0, exit_attribute_mode));
2973 zero = strdup(TPARM_9(set_attributes, 0, 0, 0, 0, 0, 0, 0, 0, 0));
2976 _nc_warning("stack error in sgr(0) string");
2979 CHECK_SGR(1, enter_standout_mode);
2980 CHECK_SGR(2, enter_underline_mode);
2981 CHECK_SGR(3, enter_reverse_mode);
2982 CHECK_SGR(4, enter_blink_mode);
2983 CHECK_SGR(5, enter_dim_mode);
2984 CHECK_SGR(6, enter_bold_mode);
2985 CHECK_SGR(7, enter_secure_mode);
2986 CHECK_SGR(8, enter_protected_mode);
2987 CHECK_SGR(9, enter_alt_charset_mode);
2990 _nc_warning("sgr(0) did not return a value");
2992 } else if (PRESENT(exit_attribute_mode) &&
2993 set_attributes != CANCELLED_STRING) {
2994 if (_nc_syntax == SYN_TERMINFO)
2995 _nc_warning("missing sgr string");
2997 #define CHECK_SGR0(name) check_exit_attribute(#name, name, check_sgr0, exit_attribute_mode)
2998 if (PRESENT(exit_attribute_mode)) {
2999 char *check_sgr0 = _nc_trim_sgr0(tp);
3001 if (check_sgr0 == 0 || *check_sgr0 == '\0') {
3002 _nc_warning("trimmed sgr0 is empty");
3005 if (check_sgr0 != exit_attribute_mode) {
3007 ("will trim sgr0\n\toriginal sgr0=%s\n\ttrimmed sgr0=%s",
3008 _nc_visbuf2(1, exit_attribute_mode),
3009 _nc_visbuf2(2, check_sgr0)));
3012 ("will not trim sgr0\n\toriginal sgr0=%s",
3013 _nc_visbuf(exit_attribute_mode)));
3016 #if defined(exit_italics_mode)
3017 CHECK_SGR0(exit_italics_mode);
3019 CHECK_SGR0(exit_standout_mode);
3020 CHECK_SGR0(exit_underline_mode);
3021 if (check_sgr0 != exit_attribute_mode) {
3025 #define CHECK_SGR_PARAM(code, name) check_sgr_param(tp, (int)code, #name, name)
3026 for (j = 0; *sgr_names[j] != '\0'; ++j) {
3027 CHECK_SGR_PARAM(j, set_a_foreground);
3028 CHECK_SGR_PARAM(j, set_a_background);
3029 CHECK_SGR_PARAM(j, set_foreground);
3030 CHECK_SGR_PARAM(j, set_background);
3034 if (!auto_right_margin) {
3036 ("can write to lower-right directly"));
3037 } else if (PRESENT(enter_am_mode) && PRESENT(exit_am_mode)) {
3039 ("can write to lower-right by suppressing automargin"));
3040 } else if ((PRESENT(enter_insert_mode) && PRESENT(exit_insert_mode))
3041 || PRESENT(insert_character) || PRESENT(parm_ich)) {
3043 ("can write to lower-right by using inserts"));
3046 ("cannot write to lower-right"));
3051 * Some standard applications (e.g., vi) and some non-curses
3052 * applications (e.g., jove) get confused if we have both ich1 and
3053 * smir/rmir. Let's be nice and warn about that, too, even though
3054 * ncurses handles it.
3056 if ((PRESENT(enter_insert_mode) || PRESENT(exit_insert_mode))
3057 && PRESENT(parm_ich)) {
3058 _nc_warning("non-curses applications may be confused by ich1 with smir/rmir");
3062 * Finally, do the non-verbose checks
3064 if (save_check_termtype != 0)
3065 save_check_termtype(tp, literal);