1 /****************************************************************************
2 * Copyright (c) 1998-2012,2013 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.90 2013/08/31 15:22:31 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;
79 force_bar(char *dst, char *src)
81 if (strchr(src, '|') == 0) {
82 size_t len = strlen(src);
83 if (len > MAX_NAME_SIZE)
85 (void) strncpy(dst, src, len);
86 _nc_STRCPY(dst + len, "|", MAX_NAME_SIZE);
91 #define ForceBar(dst, src) ((strchr(src, '|') == 0) ? force_bar(dst, src) : src)
93 #if NCURSES_USE_TERMCAP && NCURSES_XNAMES
95 skip_index(char *name)
97 char *bar = strchr(name, '|');
99 if (bar != 0 && (bar - name) == 2)
107 check_collisions(char *n1, char *n2, int counter)
109 char *pstart, *qstart, *pend, *qend;
110 char nc1[MAX_NAME_SIZE + 2];
111 char nc2[MAX_NAME_SIZE + 2];
113 n1 = ForceBar(nc1, n1);
114 n2 = ForceBar(nc2, n2);
116 #if NCURSES_USE_TERMCAP && NCURSES_XNAMES
117 if ((_nc_syntax == SYN_TERMCAP) && _nc_user_definable) {
123 for (pstart = n1; (pend = strchr(pstart, '|')); pstart = pend + 1) {
124 for (qstart = n2; (qend = strchr(qstart, '|')); qstart = qend + 1) {
125 if ((pend - pstart == qend - qstart)
126 && memcmp(pstart, qstart, (size_t) (pend - pstart)) == 0) {
128 (void) fprintf(stderr, "Name collision '%.*s' between\n",
129 (int) (pend - pstart), pstart);
139 next_name(char *name)
147 name_ending(char *name)
152 while (*name != '\0' && *name != '|')
159 * Essentially, find the conflict reported in check_collisions() and remove
160 * it from the second name, unless that happens to be the last alias.
163 remove_collision(char *n1, char *n2)
166 char *pstart, *qstart, *pend, *qend;
167 bool removed = FALSE;
169 #if NCURSES_USE_TERMCAP && NCURSES_XNAMES
170 if ((_nc_syntax == SYN_TERMCAP) && _nc_user_definable) {
172 p2 = n2 = skip_index(n2);
176 for (pstart = n1; (pend = name_ending(pstart)); pstart = next_name(pend)) {
177 for (qstart = n2; (qend = name_ending(qstart)); qstart = next_name(qend)) {
178 if ((pend - pstart == qend - qstart)
179 && memcmp(pstart, qstart, (size_t) (pend - pstart)) == 0) {
180 if (qstart != p2 || *qend == '|') {
183 while ((*qstart++ = *qend++) != '\0') ;
184 fprintf(stderr, "...now\t%s\n", p2);
186 fprintf(stderr, "Cannot remove alias '%.*s'\n",
187 (int) (qend - qstart), qstart);
198 /* do any of the aliases in a pair of terminal names match? */
200 _nc_entry_match(char *n1, char *n2)
202 return check_collisions(n1, n2, 0);
205 /****************************************************************************
207 * Entry compiler and resolution logic
209 ****************************************************************************/
212 _nc_read_entry_source(FILE *fp, char *buf,
213 int literal, bool silent,
214 bool(*hook) (ENTRY *))
215 /* slurp all entries in the given file into core */
218 bool oldsuppress = _nc_suppress_warnings;
222 _nc_suppress_warnings = TRUE; /* shut the lexer up, too */
224 _nc_reset_input(fp, buf);
226 memset(&thisentry, 0, sizeof(thisentry));
227 if (_nc_parse_entry(&thisentry, literal, silent) == ERR)
229 if (!isalnum(UChar(thisentry.tterm.term_names[0])))
230 _nc_err_abort("terminal names must start with letter or digit");
233 * This can be used for immediate compilation of entries with no "use="
234 * references to disk. That avoids consuming a lot of memory when the
235 * resolution code could fetch entries off disk.
237 if (hook != NULLHOOK && (*hook) (&thisentry)) {
242 * The enqueued entry is copied with _nc_copy_termtype(), so we can
243 * free some of the data from thisentry, i.e., the arrays.
245 FreeIfNeeded(thisentry.tterm.Booleans);
246 FreeIfNeeded(thisentry.tterm.Numbers);
247 FreeIfNeeded(thisentry.tterm.Strings);
249 FreeIfNeeded(thisentry.tterm.ext_Names);
255 /* set up the head pointer */
256 for (_nc_head = _nc_tail; _nc_head->last; _nc_head = _nc_head->last)
259 DEBUG(1, ("head = %s", _nc_head->tterm.term_names));
260 DEBUG(1, ("tail = %s", _nc_tail->tterm.term_names));
264 DEBUG(1, ("no entries parsed"));
267 _nc_suppress_warnings = oldsuppress;
271 _nc_resolve_uses2(bool fullresolve, bool literal)
272 /* try to resolve all use capabilities */
274 ENTRY *qp, *rp, *lastread = 0;
277 int unresolved, total_unresolved, multiples;
279 DEBUG(2, ("RESOLUTION BEGINNING"));
282 * Check for multiple occurrences of the same name.
290 && check_collisions(qp->tterm.term_names,
291 rp->tterm.term_names,
294 (void) fprintf(stderr, "\t%s\n", rp->tterm.term_names);
296 (void) fprintf(stderr, "and\t%s\n", qp->tterm.term_names);
297 if (!remove_collision(rp->tterm.term_names,
298 qp->tterm.term_names)) {
307 DEBUG(2, ("NO MULTIPLE NAME OCCURRENCES"));
310 * First resolution stage: compute link pointers corresponding to names.
312 total_unresolved = 0;
316 for (i = 0; i < qp->nuses; i++) {
318 char *child = _nc_first_name(qp->tterm.term_names);
319 char *lookfor = qp->uses[i].name;
320 long lookline = qp->uses[i].line;
326 /* first, try to resolve from in-core records */
329 && _nc_name_match(rp->tterm.term_names, lookfor, "|")) {
330 DEBUG(2, ("%s: resolving use=%s (in core)",
333 qp->uses[i].link = rp;
338 /* if that didn't work, try to merge in a compiled entry */
341 char filename[PATH_MAX];
343 memset(&thisterm, 0, sizeof(thisterm));
344 if (_nc_read_entry(lookfor, filename, &thisterm) == 1) {
345 DEBUG(2, ("%s: resolving use=%s (compiled)",
348 TYPE_MALLOC(ENTRY, 1, rp);
349 rp->tterm = thisterm;
354 qp->uses[i].link = rp;
359 /* no good, mark this one unresolvable and complain */
364 _nc_curr_line = (int) lookline;
365 _nc_warning("resolution of use=%s failed", lookfor);
366 qp->uses[i].link = 0;
370 if (total_unresolved) {
371 /* free entries read in off disk */
372 _nc_free_entries(lastread);
376 DEBUG(2, ("NAME RESOLUTION COMPLETED OK"));
379 * OK, at this point all (char *) references in `name' members
380 * have been successfully converted to (ENTRY *) pointers in
381 * `link' members. Time to do the actual merges.
391 DEBUG(2, ("%s: attempting merge",
392 _nc_first_name(qp->tterm.term_names)));
394 * If any of the use entries we're looking for is
395 * incomplete, punt. We'll catch this entry on a
398 for (i = 0; i < qp->nuses; i++)
399 if (qp->uses[i].link->nuses) {
400 DEBUG(2, ("%s: use entry %d unresolved",
401 _nc_first_name(qp->tterm.term_names), i));
406 * First, make sure there is no garbage in the
407 * merge block. As a side effect, copy into
408 * the merged entry the name field and string
411 _nc_copy_termtype(&merged, &(qp->tterm));
414 * Now merge in each use entry in the proper
417 for (; qp->nuses; qp->nuses--)
418 _nc_merge_entry(&merged,
419 &qp->uses[qp->nuses - 1].link->tterm);
422 * Now merge in the original entry.
424 _nc_merge_entry(&merged, &qp->tterm);
427 * Replace the original entry with the merged one.
429 FreeIfNeeded(qp->tterm.Booleans);
430 FreeIfNeeded(qp->tterm.Numbers);
431 FreeIfNeeded(qp->tterm.Strings);
433 FreeIfNeeded(qp->tterm.ext_Names);
436 _nc_wrap_entry(qp, TRUE);
439 * We know every entry is resolvable because name resolution
440 * didn't bomb. So go back for another pass.
450 DEBUG(2, ("MERGES COMPLETED OK"));
454 * We'd like to free entries read in off disk at this point, but can't.
455 * The merge_entry() code doesn't copy the strings in the use entries,
456 * it just aliases them. If this ever changes, do a
457 * free_entries(lastread) here.
460 DEBUG(2, ("RESOLUTION FINISHED"));
463 if (_nc_check_termtype != 0) {
466 _nc_curr_line = (int) qp->startline;
467 _nc_set_type(_nc_first_name(qp->tterm.term_names));
469 * tic overrides this function pointer to provide more verbose
472 if (_nc_check_termtype2 != sanity_check2) {
473 SCREEN *save_SP = SP;
476 TERMINAL *save_tm = cur_term;
479 * Setup so that tic can use ordinary terminfo interface
480 * to obtain capability information.
482 memset(&fake_sp, 0, sizeof(fake_sp));
483 memset(&fake_tm, 0, sizeof(fake_tm));
484 fake_sp._term = &fake_tm;
485 fake_tm.type = qp->tterm;
486 _nc_set_screen(&fake_sp);
487 set_curterm(&fake_tm);
489 _nc_check_termtype2(&qp->tterm, literal);
491 _nc_set_screen(save_SP);
492 set_curterm(save_tm);
494 fixup_acsc(&qp->tterm, literal);
497 DEBUG(2, ("SANITY CHECK FINISHED"));
503 /* obsolete: 20040705 */
505 _nc_resolve_uses(bool fullresolve)
507 return _nc_resolve_uses2(fullresolve, FALSE);
511 * This bit of legerdemain turns all the terminfo variable names into
512 * references to locations in the arrays Booleans, Numbers, and Strings ---
513 * precisely what's needed.
520 fixup_acsc(TERMTYPE *tp, int literal)
524 && enter_alt_charset_mode != 0
525 && exit_alt_charset_mode != 0)
526 acs_chars = strdup(VT_ACSC);
531 sanity_check2(TERMTYPE *tp, bool literal)
533 if (!PRESENT(exit_attribute_mode)) {
534 #ifdef __UNUSED__ /* this casts too wide a net */
535 bool terminal_entry = !strchr(tp->term_names, '+');
536 if (terminal_entry &&
537 (PRESENT(set_attributes)
538 || PRESENT(enter_standout_mode)
539 || PRESENT(enter_underline_mode)
540 || PRESENT(enter_blink_mode)
541 || PRESENT(enter_bold_mode)
542 || PRESENT(enter_dim_mode)
543 || PRESENT(enter_secure_mode)
544 || PRESENT(enter_protected_mode)
545 || PRESENT(enter_reverse_mode)))
546 _nc_warning("no exit_attribute_mode");
547 #endif /* __UNUSED__ */
548 PAIRED(enter_standout_mode, exit_standout_mode);
549 PAIRED(enter_underline_mode, exit_underline_mode);
550 PAIRED(enter_italics_mode, exit_italics_mode);
553 /* we do this check/fix in postprocess_termcap(), but some packagers
554 * prefer to bypass it...
557 fixup_acsc(tp, literal);
558 ANDMISSING(enter_alt_charset_mode, acs_chars);
559 ANDMISSING(exit_alt_charset_mode, acs_chars);
562 /* listed in structure-member order of first argument */
563 PAIRED(enter_alt_charset_mode, exit_alt_charset_mode);
564 ANDMISSING(enter_blink_mode, exit_attribute_mode);
565 ANDMISSING(enter_bold_mode, exit_attribute_mode);
566 PAIRED(exit_ca_mode, enter_ca_mode);
567 PAIRED(enter_delete_mode, exit_delete_mode);
568 ANDMISSING(enter_dim_mode, exit_attribute_mode);
569 PAIRED(enter_insert_mode, exit_insert_mode);
570 ANDMISSING(enter_secure_mode, exit_attribute_mode);
571 ANDMISSING(enter_protected_mode, exit_attribute_mode);
572 ANDMISSING(enter_reverse_mode, exit_attribute_mode);
573 PAIRED(from_status_line, to_status_line);
574 PAIRED(meta_off, meta_on);
576 PAIRED(prtr_on, prtr_off);
577 PAIRED(save_cursor, restore_cursor);
578 PAIRED(enter_xon_mode, exit_xon_mode);
579 PAIRED(enter_am_mode, exit_am_mode);
580 ANDMISSING(label_off, label_on);
582 PAIRED(display_clock, remove_clock);
584 ANDMISSING(set_color_pair, initialize_pair);
587 /* obsolete: 20040705 */
589 sanity_check(TERMTYPE *tp)
591 sanity_check2(tp, FALSE);
598 _nc_alloc_entry_leaks();
599 _nc_captoinfo_leaks();
600 _nc_comp_scan_leaks();
601 #if BROKEN_LINKER || USE_REENTRANT
605 _nc_tic_expand(0, FALSE, 0);
609 _nc_free_tic(int code)
612 _nc_free_tinfo(code);