1 /****************************************************************************
2 * Copyright (c) 1998-2013,2016 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 * comp_parse.c -- parser driver loop and use handling.
38 * Use this code by calling _nc_read_entry_source() on as many source
39 * files as you like (either terminfo or termcap syntax). If you
40 * want use-resolution, call _nc_resolve_uses2(). To free the list
41 * storage, do _nc_free_entries().
44 #include <curses.priv.h>
50 MODULE_ID("$Id: comp_parse.c,v 1.92 2016/09/10 20:08:32 tom Exp $")
52 static void sanity_check2(TERMTYPE *, bool);
53 NCURSES_IMPEXP void NCURSES_API(*_nc_check_termtype2) (TERMTYPE *, bool) = sanity_check2;
55 /* obsolete: 20040705 */
56 static void sanity_check(TERMTYPE *);
57 NCURSES_IMPEXP void NCURSES_API(*_nc_check_termtype) (TERMTYPE *) = sanity_check;
59 static void fixup_acsc(TERMTYPE *, int);
63 /* add an entry to the in-core list */
65 ENTRY *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, len);
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);
188 fprintf(stderr, "Cannot remove alias '%.*s'\n",
189 (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 _nc_suppress_warnings = TRUE; /* shut the lexer up, too */
226 _nc_reset_input(fp, buf);
228 memset(&thisentry, 0, sizeof(thisentry));
229 if (_nc_parse_entry(&thisentry, literal, silent) == ERR)
231 if (!isalnum(UChar(thisentry.tterm.term_names[0])))
232 _nc_err_abort("terminal names must start with letter or digit");
235 * This can be used for immediate compilation of entries with no "use="
236 * references to disk. That avoids consuming a lot of memory when the
237 * resolution code could fetch entries off disk.
239 if (hook != NULLHOOK && (*hook) (&thisentry)) {
244 * The enqueued entry is copied with _nc_copy_termtype(), so we can
245 * free some of the data from thisentry, i.e., the arrays.
247 FreeIfNeeded(thisentry.tterm.Booleans);
248 FreeIfNeeded(thisentry.tterm.Numbers);
249 FreeIfNeeded(thisentry.tterm.Strings);
251 FreeIfNeeded(thisentry.tterm.ext_Names);
257 /* set up the head pointer */
258 for (_nc_head = _nc_tail; _nc_head->last; _nc_head = _nc_head->last)
261 DEBUG(1, ("head = %s", _nc_head->tterm.term_names));
262 DEBUG(1, ("tail = %s", _nc_tail->tterm.term_names));
266 DEBUG(1, ("no entries parsed"));
269 _nc_suppress_warnings = oldsuppress;
273 _nc_resolve_uses2(bool fullresolve, bool literal)
274 /* try to resolve all use capabilities */
276 ENTRY *qp, *rp, *lastread = 0;
279 int unresolved, total_unresolved, multiples;
281 DEBUG(2, ("RESOLUTION BEGINNING"));
284 * Check for multiple occurrences of the same name.
292 && check_collisions(qp->tterm.term_names,
293 rp->tterm.term_names,
296 (void) fprintf(stderr, "\t%s\n", rp->tterm.term_names);
298 (void) fprintf(stderr, "and\t%s\n", qp->tterm.term_names);
299 if (!remove_collision(rp->tterm.term_names,
300 qp->tterm.term_names)) {
309 DEBUG(2, ("NO MULTIPLE NAME OCCURRENCES"));
312 * First resolution stage: compute link pointers corresponding to names.
314 total_unresolved = 0;
318 for (i = 0; i < qp->nuses; i++) {
320 char *child = _nc_first_name(qp->tterm.term_names);
321 char *lookfor = qp->uses[i].name;
322 long lookline = qp->uses[i].line;
328 /* first, try to resolve from in-core records */
331 && _nc_name_match(rp->tterm.term_names, lookfor, "|")) {
332 DEBUG(2, ("%s: resolving use=%s (in core)",
335 qp->uses[i].link = rp;
340 /* if that didn't work, try to merge in a compiled entry */
343 char filename[PATH_MAX];
345 memset(&thisterm, 0, sizeof(thisterm));
346 if (_nc_read_entry(lookfor, filename, &thisterm) == 1) {
347 DEBUG(2, ("%s: resolving use=%s (compiled)",
350 TYPE_MALLOC(ENTRY, 1, rp);
351 rp->tterm = thisterm;
356 qp->uses[i].link = rp;
361 /* no good, mark this one unresolvable and complain */
366 _nc_curr_line = (int) lookline;
367 _nc_warning("resolution of use=%s failed", lookfor);
368 qp->uses[i].link = 0;
372 if (total_unresolved) {
373 /* free entries read in off disk */
374 _nc_free_entries(lastread);
378 DEBUG(2, ("NAME RESOLUTION COMPLETED OK"));
381 * OK, at this point all (char *) references in `name' members
382 * have been successfully converted to (ENTRY *) pointers in
383 * `link' members. Time to do the actual merges.
393 DEBUG(2, ("%s: attempting merge",
394 _nc_first_name(qp->tterm.term_names)));
396 * If any of the use entries we're looking for is
397 * incomplete, punt. We'll catch this entry on a
400 for (i = 0; i < qp->nuses; i++)
401 if (qp->uses[i].link->nuses) {
402 DEBUG(2, ("%s: use entry %d unresolved",
403 _nc_first_name(qp->tterm.term_names), i));
408 * First, make sure there is no garbage in the
409 * merge block. As a side effect, copy into
410 * the merged entry the name field and string
413 _nc_copy_termtype(&merged, &(qp->tterm));
416 * Now merge in each use entry in the proper
419 for (; qp->nuses; qp->nuses--)
420 _nc_merge_entry(&merged,
421 &qp->uses[qp->nuses - 1].link->tterm);
424 * Now merge in the original entry.
426 _nc_merge_entry(&merged, &qp->tterm);
429 * Replace the original entry with the merged one.
431 FreeIfNeeded(qp->tterm.Booleans);
432 FreeIfNeeded(qp->tterm.Numbers);
433 FreeIfNeeded(qp->tterm.Strings);
435 FreeIfNeeded(qp->tterm.ext_Names);
438 _nc_wrap_entry(qp, TRUE);
441 * We know every entry is resolvable because name resolution
442 * didn't bomb. So go back for another pass.
452 DEBUG(2, ("MERGES COMPLETED OK"));
456 * We'd like to free entries read in off disk at this point, but can't.
457 * The merge_entry() code doesn't copy the strings in the use entries,
458 * it just aliases them. If this ever changes, do a
459 * free_entries(lastread) here.
462 DEBUG(2, ("RESOLUTION FINISHED"));
465 if (_nc_check_termtype != 0) {
468 _nc_curr_line = (int) qp->startline;
469 _nc_set_type(_nc_first_name(qp->tterm.term_names));
471 * tic overrides this function pointer to provide more verbose
474 if (_nc_check_termtype2 != sanity_check2) {
475 SCREEN *save_SP = SP;
478 TERMINAL *save_tm = cur_term;
481 * Setup so that tic can use ordinary terminfo interface
482 * to obtain capability information.
484 memset(&fake_sp, 0, sizeof(fake_sp));
485 memset(&fake_tm, 0, sizeof(fake_tm));
486 fake_sp._term = &fake_tm;
487 fake_tm.type = qp->tterm;
488 _nc_set_screen(&fake_sp);
489 set_curterm(&fake_tm);
491 _nc_check_termtype2(&qp->tterm, literal);
493 _nc_set_screen(save_SP);
494 set_curterm(save_tm);
496 fixup_acsc(&qp->tterm, literal);
499 DEBUG(2, ("SANITY CHECK FINISHED"));
505 /* obsolete: 20040705 */
507 _nc_resolve_uses(bool fullresolve)
509 return _nc_resolve_uses2(fullresolve, FALSE);
513 * This bit of legerdemain turns all the terminfo variable names into
514 * references to locations in the arrays Booleans, Numbers, and Strings ---
515 * precisely what's needed.
522 fixup_acsc(TERMTYPE *tp, int literal)
526 && enter_alt_charset_mode != 0
527 && exit_alt_charset_mode != 0)
528 acs_chars = strdup(VT_ACSC);
533 sanity_check2(TERMTYPE *tp, bool literal)
535 if (!PRESENT(exit_attribute_mode)) {
536 #ifdef __UNUSED__ /* this casts too wide a net */
537 bool terminal_entry = !strchr(tp->term_names, '+');
538 if (terminal_entry &&
539 (PRESENT(set_attributes)
540 || PRESENT(enter_standout_mode)
541 || PRESENT(enter_underline_mode)
542 || PRESENT(enter_blink_mode)
543 || PRESENT(enter_bold_mode)
544 || PRESENT(enter_dim_mode)
545 || PRESENT(enter_secure_mode)
546 || PRESENT(enter_protected_mode)
547 || PRESENT(enter_reverse_mode)))
548 _nc_warning("no exit_attribute_mode");
549 #endif /* __UNUSED__ */
550 PAIRED(enter_standout_mode, exit_standout_mode);
551 PAIRED(enter_underline_mode, exit_underline_mode);
552 PAIRED(enter_italics_mode, exit_italics_mode);
555 /* we do this check/fix in postprocess_termcap(), but some packagers
556 * prefer to bypass it...
559 fixup_acsc(tp, literal);
560 ANDMISSING(enter_alt_charset_mode, acs_chars);
561 ANDMISSING(exit_alt_charset_mode, acs_chars);
564 /* listed in structure-member order of first argument */
565 PAIRED(enter_alt_charset_mode, exit_alt_charset_mode);
566 ANDMISSING(enter_blink_mode, exit_attribute_mode);
567 ANDMISSING(enter_bold_mode, exit_attribute_mode);
568 PAIRED(exit_ca_mode, enter_ca_mode);
569 PAIRED(enter_delete_mode, exit_delete_mode);
570 ANDMISSING(enter_dim_mode, exit_attribute_mode);
571 PAIRED(enter_insert_mode, exit_insert_mode);
572 ANDMISSING(enter_secure_mode, exit_attribute_mode);
573 ANDMISSING(enter_protected_mode, exit_attribute_mode);
574 ANDMISSING(enter_reverse_mode, exit_attribute_mode);
575 PAIRED(from_status_line, to_status_line);
576 PAIRED(meta_off, meta_on);
578 PAIRED(prtr_on, prtr_off);
579 PAIRED(save_cursor, restore_cursor);
580 PAIRED(enter_xon_mode, exit_xon_mode);
581 PAIRED(enter_am_mode, exit_am_mode);
582 ANDMISSING(label_off, label_on);
584 PAIRED(display_clock, remove_clock);
586 ANDMISSING(set_color_pair, initialize_pair);
589 /* obsolete: 20040705 */
591 sanity_check(TERMTYPE *tp)
593 sanity_check2(tp, FALSE);
600 _nc_alloc_entry_leaks();
601 _nc_captoinfo_leaks();
602 _nc_comp_scan_leaks();
603 #if BROKEN_LINKER || USE_REENTRANT
607 _nc_tic_expand(0, FALSE, 0);
611 _nc_free_tic(int code)
614 _nc_free_tinfo(code);