1 /****************************************************************************
2 * Copyright 2018-2021,2022 Thomas E. Dickey *
3 * Copyright 1998-2016,2017 Free Software Foundation, Inc. *
5 * Permission is hereby granted, free of charge, to any person obtaining a *
6 * copy of this software and associated documentation files (the *
7 * "Software"), to deal in the Software without restriction, including *
8 * without limitation the rights to use, copy, modify, merge, publish, *
9 * distribute, distribute with modifications, sublicense, and/or sell *
10 * copies of the Software, and to permit persons to whom the Software is *
11 * furnished to do so, subject to the following conditions: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 * Except as contained in this notice, the name(s) of the above copyright *
25 * holders shall not be used in advertising or otherwise to promote the *
26 * sale, use or other dealings in this Software without prior written *
28 ****************************************************************************/
30 /****************************************************************************
31 * Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 *
32 * and: Eric S. Raymond <esr@snark.thyrsus.com> *
33 * and: Thomas E. Dickey 1996-on *
34 ****************************************************************************/
37 * comp_parse.c -- parser driver loop and use handling.
39 * Use this code by calling _nc_read_entry_source() on as many source
40 * files as you like (either terminfo or termcap syntax). If you
41 * want use-resolution, call _nc_resolve_uses2(). To free the list
42 * storage, do _nc_free_entries().
45 #include <curses.priv.h>
51 MODULE_ID("$Id: comp_parse.c,v 1.117 2022/04/30 15:57:27 tom Exp $")
53 static void sanity_check2(TERMTYPE2 *, bool);
54 NCURSES_IMPEXP void (NCURSES_API *_nc_check_termtype2) (TERMTYPE2 *, bool) = sanity_check2;
56 static void fixup_acsc(TERMTYPE2 *, int);
60 /* add an entry to the in-core list */
64 DEBUG(1, (T_CALLED("enqueue(ep=%p)"), ep));
66 newp = _nc_copy_entry(ep);
68 _nc_err_abort(MSG_NO_MEMORY);
70 newp->last = _nc_tail;
75 newp->last->next = newp;
78 #define NAMEBUFFER_SIZE (MAX_NAME_SIZE + 2)
81 force_bar(char *dst, char *src)
83 if (strchr(src, '|') == 0) {
84 size_t len = strlen(src);
85 if (len > MAX_NAME_SIZE)
87 _nc_STRNCPY(dst, src, MAX_NAME_SIZE);
88 _nc_STRCPY(dst + len, "|", NAMEBUFFER_SIZE - len);
93 #define ForceBar(dst, src) ((strchr(src, '|') == 0) ? force_bar(dst, src) : src)
95 #if NCURSES_USE_TERMCAP && NCURSES_XNAMES
97 skip_index(char *name)
99 char *bar = strchr(name, '|');
101 if (bar != 0 && (bar - name) == 2)
109 check_collisions(char *n1, char *n2, int counter)
111 char *pstart, *qstart, *pend, *qend;
112 char nc1[NAMEBUFFER_SIZE];
113 char nc2[NAMEBUFFER_SIZE];
115 n1 = ForceBar(nc1, n1);
116 n2 = ForceBar(nc2, n2);
118 #if NCURSES_USE_TERMCAP && NCURSES_XNAMES
119 if ((_nc_syntax == SYN_TERMCAP) && _nc_user_definable) {
125 for (pstart = n1; (pend = strchr(pstart, '|')); pstart = pend + 1) {
126 for (qstart = n2; (qend = strchr(qstart, '|')); qstart = qend + 1) {
127 if ((pend - pstart == qend - qstart)
128 && memcmp(pstart, qstart, (size_t) (pend - pstart)) == 0) {
130 (void) fprintf(stderr, "Name collision '%.*s' between\n",
131 (int) (pend - pstart), pstart);
141 next_name(char *name)
149 name_ending(char *name)
154 while (*name != '\0' && *name != '|')
161 * Essentially, find the conflict reported in check_collisions() and remove
162 * it from the second name, unless that happens to be the last alias.
165 remove_collision(char *n1, char *n2)
168 char *pstart, *qstart, *pend, *qend;
169 bool removed = FALSE;
171 #if NCURSES_USE_TERMCAP && NCURSES_XNAMES
172 if ((_nc_syntax == SYN_TERMCAP) && _nc_user_definable) {
174 p2 = n2 = skip_index(n2);
178 for (pstart = n1; (pend = name_ending(pstart)); pstart = next_name(pend)) {
179 for (qstart = n2; (qend = name_ending(qstart)); qstart = next_name(qend)) {
180 if ((pend - pstart == qend - qstart)
181 && memcmp(pstart, qstart, (size_t) (pend - pstart)) == 0) {
182 if (qstart != p2 || *qend == '|') {
185 while ((*qstart++ = *qend++) != '\0') ;
186 fprintf(stderr, "...now\t%s\n", p2);
189 fprintf(stderr, "Cannot remove alias '%.*s'\n",
190 (int) (qend - qstart), qstart);
200 /* do any of the aliases in a pair of terminal names match? */
202 _nc_entry_match(char *n1, char *n2)
204 return check_collisions(n1, n2, 0);
207 /****************************************************************************
209 * Entry compiler and resolution logic
211 ****************************************************************************/
214 _nc_read_entry_source(FILE *fp, char *buf,
215 int literal, bool silent,
216 bool(*hook) (ENTRY *))
217 /* slurp all entries in the given file into core */
220 bool oldsuppress = _nc_suppress_warnings;
224 (T_CALLED("_nc_read_entry_source(file=%p, buf=%p, literal=%d, silent=%d, hook=%p)"),
225 fp, buf, literal, silent, hook));
228 _nc_suppress_warnings = TRUE; /* shut the lexer up, too */
230 _nc_reset_input(fp, buf);
232 memset(&thisentry, 0, sizeof(thisentry));
233 if (_nc_parse_entry(&thisentry, literal, silent) == ERR)
235 if (!isalnum(UChar(thisentry.tterm.term_names[0])))
236 _nc_err_abort("terminal names must start with letter or digit");
239 * This can be used for immediate compilation of entries with no "use="
240 * references to disk. That avoids consuming a lot of memory when the
241 * resolution code could fetch entries off disk.
243 if (hook != NULLHOOK && (*hook) (&thisentry)) {
248 * The enqueued entry is copied with _nc_copy_termtype(), so we can
249 * free some of the data from thisentry, i.e., the arrays.
251 FreeIfNeeded(thisentry.tterm.Booleans);
252 FreeIfNeeded(thisentry.tterm.Numbers);
253 FreeIfNeeded(thisentry.tterm.Strings);
255 FreeIfNeeded(thisentry.tterm.ext_Names);
261 /* set up the head pointer */
262 for (_nc_head = _nc_tail; _nc_head->last; _nc_head = _nc_head->last)
265 DEBUG(2, ("head = %s", _nc_head->tterm.term_names));
266 DEBUG(2, ("tail = %s", _nc_tail->tterm.term_names));
270 DEBUG(2, ("no entries parsed"));
273 _nc_suppress_warnings = oldsuppress;
276 #if 0 && NCURSES_XNAMES
278 find_capname(TERMTYPE2 *p, const char *name)
280 unsigned num_names = NUM_EXT_NAMES(p);
283 for (n = 0; n < num_names; ++n) {
284 if (!strcmp(p->ext_Names[n], name))
294 extended_captype(TERMTYPE2 *p, unsigned which)
298 limit += p->ext_Booleans;
299 if (limit != 0 && which < limit) {
302 limit += p->ext_Numbers;
303 if (limit != 0 && which < limit) {
306 limit += p->ext_Strings;
307 if (limit != 0 && which < limit) {
308 result = ((p->Strings[STRCOUNT + which] != CANCELLED_STRING)
311 } else if (which >= limit) {
320 name_of_captype(int which)
322 const char *result = "?";
337 #define valid_TERMTYPE2(p) \
339 (p)->term_names != 0 && \
343 * Disallow changing the type of an extended capability when doing a "use"
344 * if one or the other is a string.
347 invalid_merge(TERMTYPE2 *to, TERMTYPE2 *from)
350 if (valid_TERMTYPE2(to)
351 && valid_TERMTYPE2(from)) {
352 char *to_name = _nc_first_name(to->term_names);
353 char *from_name = strdup(_nc_first_name(from->term_names));
354 unsigned num_names = NUM_EXT_NAMES(from);
357 for (n = 0; n < num_names; ++n) {
358 const char *capname = from->ext_Names[n];
359 int tt = extended_captype(to, find_capname(to, capname));
360 int tf = extended_captype(from, n);
364 && (tt == STRING) != (tf == STRING)) {
365 if (from_name != 0 && strcmp(to_name, from_name)) {
366 _nc_warning("merge of %s to %s changes type of %s from %s to %s",
371 name_of_captype(tt));
373 _nc_warning("merge of %s changes type of %s from %s to %s",
377 name_of_captype(tt));
386 #define validate_merge(p, q) \
387 if (invalid_merge(&((p)->tterm), &((q)->tterm))) \
390 #define validate_merge(p, q) /* nothing */
394 _nc_resolve_uses2(bool fullresolve, bool literal)
395 /* try to resolve all use capabilities */
397 ENTRY *qp, *rp, *lastread = 0;
400 int unresolved, total_unresolved, multiples;
402 DEBUG(2, (T_CALLED("_nc_resolve_uses2")));
405 * Check for multiple occurrences of the same name.
413 && check_collisions(qp->tterm.term_names,
414 rp->tterm.term_names,
417 (void) fprintf(stderr, "\t%s\n", rp->tterm.term_names);
419 (void) fprintf(stderr, "and\t%s\n", qp->tterm.term_names);
420 if (!remove_collision(rp->tterm.term_names,
421 qp->tterm.term_names)) {
428 DEBUG(2, (T_RETURN("false")));
432 DEBUG(2, ("NO MULTIPLE NAME OCCURRENCES"));
435 * First resolution stage: compute link pointers corresponding to names.
437 total_unresolved = 0;
441 for (i = 0; i < qp->nuses; i++) {
443 char *child = _nc_first_name(qp->tterm.term_names);
444 char *lookfor = qp->uses[i].name;
445 long lookline = qp->uses[i].line;
454 /* first, try to resolve from in-core records */
457 && _nc_name_match(rp->tterm.term_names, lookfor, "|")) {
458 DEBUG(2, ("%s: resolving use=%s (in core)",
461 qp->uses[i].link = rp;
464 /* verify that there are no earlier uses */
465 for (j = 0; j < i; ++j) {
466 if (qp->uses[j].link != NULL
467 && !strcmp(qp->uses[j].link->tterm.term_names,
468 rp->tterm.term_names)) {
469 _nc_warning("duplicate use=%s", lookfor);
476 /* if that didn't work, try to merge in a compiled entry */
479 char filename[PATH_MAX];
481 memset(&thisterm, 0, sizeof(thisterm));
482 if (_nc_read_entry2(lookfor, filename, &thisterm) == 1) {
483 DEBUG(2, ("%s: resolving use=%s (compiled)",
486 TYPE_MALLOC(ENTRY, 1, rp);
487 rp->tterm = thisterm;
492 qp->uses[i].link = rp;
495 /* verify that there are no earlier uses */
496 for (j = 0; j < i; ++j) {
497 if (qp->uses[j].link != NULL
498 && !strcmp(qp->uses[j].link->tterm.term_names,
499 rp->tterm.term_names)) {
500 _nc_warning("duplicate use=%s", lookfor);
507 /* no good, mark this one unresolvable and complain */
512 _nc_curr_line = (int) lookline;
513 _nc_warning("resolution of use=%s failed", lookfor);
514 qp->uses[i].link = 0;
518 if (total_unresolved) {
519 /* free entries read in off disk */
520 _nc_free_entries(lastread);
521 DEBUG(2, (T_RETURN("false")));
525 DEBUG(2, ("NAME RESOLUTION COMPLETED OK"));
528 * OK, at this point all (char *) references in `name' members
529 * have been successfully converted to (ENTRY *) pointers in
530 * `link' members. Time to do the actual merges.
540 DEBUG(2, ("%s: attempting merge",
541 _nc_first_name(qp->tterm.term_names)));
543 * If any of the use entries we're looking for is
544 * incomplete, punt. We'll catch this entry on a
547 for (i = 0; i < qp->nuses; i++)
549 && qp->uses[i].link->nuses) {
550 DEBUG(2, ("%s: use entry %d unresolved",
551 _nc_first_name(qp->tterm.term_names), i));
556 * First, make sure there is no garbage in the
557 * merge block. As a side effect, copy into
558 * the merged entry the name field and string
561 _nc_copy_termtype2(&(merged.tterm), &(qp->tterm));
564 * Now merge in each use entry in the proper
567 for (; qp->nuses; qp->nuses--) {
568 validate_merge(&merged,
569 qp->uses[qp->nuses - 1].link);
570 _nc_merge_entry(&merged,
571 qp->uses[qp->nuses - 1].link);
575 * Now merge in the original entry.
577 validate_merge(&merged, qp);
578 _nc_merge_entry(&merged, qp);
581 * Replace the original entry with the merged one.
583 FreeIfNeeded(qp->tterm.Booleans);
584 FreeIfNeeded(qp->tterm.Numbers);
585 FreeIfNeeded(qp->tterm.Strings);
587 FreeIfNeeded(qp->tterm.ext_Names);
589 qp->tterm = merged.tterm;
590 _nc_wrap_entry(qp, TRUE);
593 * We know every entry is resolvable because name resolution
594 * didn't bomb. So go back for another pass.
604 DEBUG(2, ("MERGES COMPLETED OK"));
608 * We'd like to free entries read in off disk at this point, but can't.
609 * The merge_entry() code doesn't copy the strings in the use entries,
610 * it just aliases them. If this ever changes, do a
611 * free_entries(lastread) here.
614 DEBUG(2, ("RESOLUTION FINISHED"));
619 _nc_curr_line = (int) qp->startline;
620 _nc_set_type(_nc_first_name(qp->tterm.term_names));
622 * tic overrides this function pointer to provide more verbose
625 if (_nc_check_termtype2 != sanity_check2) {
626 SCREEN *save_SP = SP;
629 TERMINAL *save_tm = cur_term;
632 * Setup so that tic can use ordinary terminfo interface to
633 * obtain capability information.
635 memset(&fake_sp, 0, sizeof(fake_sp));
636 memset(&fake_tm, 0, sizeof(fake_tm));
637 fake_sp._term = &fake_tm;
638 TerminalType(&fake_tm) = qp->tterm;
639 _nc_set_screen(&fake_sp);
640 set_curterm(&fake_tm);
642 _nc_check_termtype2(&qp->tterm, literal);
645 * Checking calls tparm, which can allocate memory. Fix leaks.
647 #define TPS(name) fake_tm.tparm_state.name
648 FreeAndNull(TPS(out_buff));
649 FreeAndNull(TPS(fmt_buff));
652 _nc_set_screen(save_SP);
653 set_curterm(save_tm);
655 fixup_acsc(&qp->tterm, literal);
658 DEBUG(2, ("SANITY CHECK FINISHED"));
661 DEBUG(2, (T_RETURN("true")));
666 * This bit of legerdemain turns all the terminfo variable names into
667 * references to locations in the arrays Booleans, Numbers, and Strings ---
668 * precisely what's needed.
675 fixup_acsc(TERMTYPE2 *tp, int literal)
678 if (acs_chars == ABSENT_STRING
679 && PRESENT(enter_alt_charset_mode)
680 && PRESENT(exit_alt_charset_mode))
681 acs_chars = strdup(VT_ACSC);
686 sanity_check2(TERMTYPE2 *tp, bool literal)
688 if (!PRESENT(exit_attribute_mode)) {
689 #ifdef __UNUSED__ /* this casts too wide a net */
690 bool terminal_entry = !strchr(tp->term_names, '+');
691 if (terminal_entry &&
692 (PRESENT(set_attributes)
693 || PRESENT(enter_standout_mode)
694 || PRESENT(enter_underline_mode)
695 || PRESENT(enter_blink_mode)
696 || PRESENT(enter_bold_mode)
697 || PRESENT(enter_dim_mode)
698 || PRESENT(enter_secure_mode)
699 || PRESENT(enter_protected_mode)
700 || PRESENT(enter_reverse_mode)))
701 _nc_warning("no exit_attribute_mode");
702 #endif /* __UNUSED__ */
703 PAIRED(enter_standout_mode, exit_standout_mode);
704 PAIRED(enter_underline_mode, exit_underline_mode);
705 #if defined(enter_italics_mode) && defined(exit_italics_mode)
706 PAIRED(enter_italics_mode, exit_italics_mode);
710 /* we do this check/fix in postprocess_termcap(), but some packagers
711 * prefer to bypass it...
714 fixup_acsc(tp, literal);
715 ANDMISSING(enter_alt_charset_mode, acs_chars);
716 ANDMISSING(exit_alt_charset_mode, acs_chars);
719 /* listed in structure-member order of first argument */
720 PAIRED(enter_alt_charset_mode, exit_alt_charset_mode);
721 ANDMISSING(enter_blink_mode, exit_attribute_mode);
722 ANDMISSING(enter_bold_mode, exit_attribute_mode);
723 PAIRED(exit_ca_mode, enter_ca_mode);
724 PAIRED(enter_delete_mode, exit_delete_mode);
725 ANDMISSING(enter_dim_mode, exit_attribute_mode);
726 PAIRED(enter_insert_mode, exit_insert_mode);
727 ANDMISSING(enter_secure_mode, exit_attribute_mode);
728 ANDMISSING(enter_protected_mode, exit_attribute_mode);
729 ANDMISSING(enter_reverse_mode, exit_attribute_mode);
730 PAIRED(from_status_line, to_status_line);
731 PAIRED(meta_off, meta_on);
733 PAIRED(prtr_on, prtr_off);
734 PAIRED(save_cursor, restore_cursor);
735 PAIRED(enter_xon_mode, exit_xon_mode);
736 PAIRED(enter_am_mode, exit_am_mode);
737 ANDMISSING(label_off, label_on);
738 #if defined(display_clock) && defined(remove_clock)
739 PAIRED(display_clock, remove_clock);
741 ANDMISSING(set_color_pair, initialize_pair);
748 T((T_CALLED("_nc_free_tic()")));
749 _nc_globals.leak_checking = TRUE;
750 _nc_alloc_entry_leaks();
751 _nc_captoinfo_leaks();
752 _nc_comp_scan_leaks();
753 #if BROKEN_LINKER || USE_REENTRANT
757 _nc_tic_expand(0, FALSE, 0);
761 _nc_free_tic(int code)