1 /****************************************************************************
2 * Copyright (c) 1998,1999,2000 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 ****************************************************************************/
35 * comp_parse.c -- parser driver loop and use handling.
37 * _nc_read_entry_source(FILE *, literal, bool, bool (*hook)())
38 * _nc_resolve_uses(void)
39 * _nc_free_entries(void)
41 * Use this code by calling _nc_read_entry_source() on as many source
42 * files as you like (either terminfo or termcap syntax). If you
43 * want use-resolution, call _nc_resolve_uses(). To free the list
44 * storage, do _nc_free_entries().
48 #include <curses.priv.h>
53 #include <term_entry.h>
55 MODULE_ID("$Id: comp_parse.c,v 1.42 2000/10/14 17:50:45 Bernhard.Rosenkraenzer Exp $")
57 static void sanity_check(TERMTYPE *);
58 void (*_nc_check_termtype) (TERMTYPE *) = sanity_check;
60 /****************************************************************************
62 * Entry queue handling
64 ****************************************************************************/
66 * The entry list is a doubly linked list with NULLs terminating the lists:
68 * --------- --------- ---------
70 * |-------| |-------| |-------|
71 * | ----+-->| ----+-->| NULL | next
72 * |-------| |-------| |-------|
73 * | NULL |<--+---- |<--+---- | last
74 * --------- --------- ---------
81 ENTRY *_nc_head = 0, *_nc_tail = 0;
85 /* add an entry to the in-core list */
87 ENTRY *newp = _nc_copy_entry(ep);
90 _nc_err_abort("Out of memory");
92 newp->last = _nc_tail;
97 newp->last->next = newp;
101 _nc_free_entries(ENTRY * headp)
102 /* free the allocated storage consumed by list entries */
106 for (ep = headp; ep; ep = next) {
108 * This conditional lets us disconnect storage from the list.
109 * To do this, copy an entry out of the list, then null out
110 * the string-table member in the original and any use entries
113 FreeIfNeeded(ep->tterm.str_table);
126 force_bar(char *dst, char *src)
128 if (strchr(src, '|') == 0) {
129 size_t len = strlen(src);
130 if (len > MAX_NAME_SIZE)
132 (void) strncpy(dst, src, len);
133 (void) strcpy(dst + len, "|");
140 _nc_entry_match(char *n1, char *n2)
141 /* do any of the aliases in a pair of terminal names match? */
143 char *pstart, *qstart, *pend, *qend;
144 char nc1[MAX_NAME_SIZE + 2], nc2[MAX_NAME_SIZE + 2];
146 n1 = force_bar(nc1, n1);
147 n2 = force_bar(nc2, n2);
149 for (pstart = n1; (pend = strchr(pstart, '|')); pstart = pend + 1)
150 for (qstart = n2; (qend = strchr(qstart, '|')); qstart = qend + 1)
151 if ((pend - pstart == qend - qstart)
152 && memcmp(pstart, qstart, (size_t) (pend - pstart)) == 0)
158 /****************************************************************************
160 * Entry compiler and resolution logic
162 ****************************************************************************/
165 _nc_read_entry_source(FILE * fp, char *buf,
166 int literal, bool silent,
167 bool(*hook) (ENTRY *))
168 /* slurp all entries in the given file into core */
171 bool oldsuppress = _nc_suppress_warnings;
175 _nc_suppress_warnings = TRUE; /* shut the lexer up, too */
177 _nc_reset_input(fp, buf);
179 memset(&thisentry, 0, sizeof(thisentry));
180 if (_nc_parse_entry(&thisentry, literal, silent) == ERR)
182 if (!isalnum(thisentry.tterm.term_names[0]))
183 _nc_err_abort("terminal names must start with letter or digit");
186 * This can be used for immediate compilation of entries with no
187 * use references to disk, so as to avoid chewing up a lot of
188 * core when the resolution code could fetch entries off disk.
190 if (hook != NULLHOOK && (*hook) (&thisentry))
197 /* set up the head pointer */
198 for (_nc_head = _nc_tail; _nc_head->last; _nc_head = _nc_head->last)
201 DEBUG(1, ("head = %s", _nc_head->tterm.term_names));
202 DEBUG(1, ("tail = %s", _nc_tail->tterm.term_names));
206 DEBUG(1, ("no entries parsed"));
209 _nc_suppress_warnings = oldsuppress;
213 _nc_resolve_uses(bool fullresolve)
214 /* try to resolve all use capabilities */
216 ENTRY *qp, *rp, *lastread = 0;
218 int i, j, unresolved, total_unresolved, multiples;
220 DEBUG(2, ("RESOLUTION BEGINNING"));
223 * Check for multiple occurrences of the same name.
231 && _nc_entry_match(qp->tterm.term_names, rp->tterm.term_names)) {
233 if (matchcount == 1) {
234 (void) fprintf(stderr, "Name collision between %s",
235 _nc_first_name(qp->tterm.term_names));
239 (void) fprintf(stderr, " %s", _nc_first_name(rp->tterm.term_names));
242 (void) putc('\n', stderr);
247 DEBUG(2, ("NO MULTIPLE NAME OCCURRENCES"));
250 * First resolution stage: compute link pointers corresponding to names.
252 total_unresolved = 0;
256 for (i = 0; i < qp->nuses; i++) {
258 char *child = _nc_first_name(qp->tterm.term_names);
259 char *lookfor = qp->uses[i].name;
260 long lookline = qp->uses[i].line;
266 /* first, try to resolve from in-core records */
269 && _nc_name_match(rp->tterm.term_names, lookfor, "|")) {
270 DEBUG(2, ("%s: resolving use=%s (in core)",
273 qp->uses[i].link = rp;
277 /* if that didn't work, try to merge in a compiled entry */
280 char filename[PATH_MAX];
282 memset(&thisterm, 0, sizeof(thisterm));
283 if (_nc_read_entry(lookfor, filename, &thisterm) == 1) {
284 DEBUG(2, ("%s: resolving use=%s (compiled)",
287 rp = typeMalloc(ENTRY, 1);
289 _nc_err_abort("Out of memory");
290 rp->tterm = thisterm;
295 qp->uses[i].link = rp;
300 /* no good, mark this one unresolvable and complain */
305 _nc_curr_line = lookline;
306 _nc_warning("resolution of use=%s failed", lookfor);
307 qp->uses[i].link = 0;
311 if (total_unresolved) {
312 /* free entries read in off disk */
313 _nc_free_entries(lastread);
317 DEBUG(2, ("NAME RESOLUTION COMPLETED OK"));
320 * OK, at this point all (char *) references in `name' mwmbers
321 * have been successfully converred to (ENTRY *) pointers in
322 * `link' members. Time to do the actual merges.
332 DEBUG(2, ("%s: attempting merge",
333 _nc_first_name(qp->tterm.term_names)));
335 * If any of the use entries we're looking for is
336 * incomplete, punt. We'll catch this entry on a
339 for (i = 0; i < qp->nuses; i++)
340 if (qp->uses[i].link->nuses) {
341 DEBUG(2, ("%s: use entry %d unresolved",
342 _nc_first_name(qp->tterm.term_names), i));
347 * First, make sure there's no garbage in the
348 * merge block. as a side effect, copy into
349 * the merged entry the name field and string
352 _nc_copy_termtype(&merged, &(qp->tterm));
355 * Now merge in each use entry in the proper
358 for (; qp->nuses; qp->nuses--)
359 _nc_merge_entry(&merged,
360 &qp->uses[qp->nuses - 1].link->tterm);
363 * Now merge in the original entry.
365 _nc_merge_entry(&merged, &qp->tterm);
368 * Replace the original entry with the merged one.
370 FreeIfNeeded(qp->tterm.Booleans);
371 FreeIfNeeded(qp->tterm.Numbers);
372 FreeIfNeeded(qp->tterm.Strings);
376 * We know every entry is resolvable because name resolution
377 * didn't bomb. So go back for another pass.
387 DEBUG(2, ("MERGES COMPLETED OK"));
390 * The exit condition of the loop above is such that all entries
391 * must now be resolved. Now handle cancellations. In a resolved
392 * entry there should be no cancellation markers.
395 for_each_boolean(j, &(qp->tterm))
396 if (qp->tterm.Booleans[j] == CANCELLED_BOOLEAN)
397 qp->tterm.Booleans[j] = ABSENT_BOOLEAN;
398 for_each_number(j, &(qp->tterm))
399 if (qp->tterm.Numbers[j] == CANCELLED_NUMERIC)
400 qp->tterm.Numbers[j] = ABSENT_NUMERIC;
401 for_each_string(j, &(qp->tterm))
402 if (qp->tterm.Strings[j] == CANCELLED_STRING)
403 qp->tterm.Strings[j] = ABSENT_STRING;
408 * We'd like to free entries read in off disk at this point, but can't.
409 * The merge_entry() code doesn't copy the strings in the use entries,
410 * it just aliases them. If this ever changes, do a
411 * free_entries(lastread) here.
414 DEBUG(2, ("RESOLUTION FINISHED"));
417 if (_nc_check_termtype != 0) {
420 _nc_curr_line = qp->startline;
421 _nc_set_type(_nc_first_name(qp->tterm.term_names));
422 _nc_check_termtype(&qp->tterm);
424 DEBUG(2, ("SANITY CHECK FINISHED"));
431 * This bit of legerdemain turns all the terminfo variable names into
432 * references to locations in the arrays Booleans, Numbers, and Strings ---
433 * precisely what's needed.
440 sanity_check(TERMTYPE * tp)
442 if (!PRESENT(exit_attribute_mode)) {
443 #ifdef __UNUSED__ /* this casts too wide a net */
444 bool terminal_entry = !strchr(tp->term_names, '+');
445 if (terminal_entry &&
446 (PRESENT(set_attributes)
447 || PRESENT(enter_standout_mode)
448 || PRESENT(enter_underline_mode)
449 || PRESENT(enter_blink_mode)
450 || PRESENT(enter_bold_mode)
451 || PRESENT(enter_dim_mode)
452 || PRESENT(enter_secure_mode)
453 || PRESENT(enter_protected_mode)
454 || PRESENT(enter_reverse_mode)))
455 _nc_warning("no exit_attribute_mode");
456 #endif /* __UNUSED__ */
457 PAIRED(enter_standout_mode, exit_standout_mode)
458 PAIRED(enter_underline_mode, exit_underline_mode)
461 /* listed in structure-member order of first argument */
462 PAIRED(enter_alt_charset_mode, exit_alt_charset_mode);
463 ANDMISSING(enter_alt_charset_mode, acs_chars);
464 ANDMISSING(exit_alt_charset_mode, acs_chars);
465 ANDMISSING(enter_blink_mode, exit_attribute_mode);
466 ANDMISSING(enter_bold_mode, exit_attribute_mode);
467 PAIRED(exit_ca_mode, enter_ca_mode);
468 PAIRED(enter_delete_mode, exit_delete_mode);
469 ANDMISSING(enter_dim_mode, exit_attribute_mode);
470 PAIRED(enter_insert_mode, exit_insert_mode);
471 ANDMISSING(enter_secure_mode, exit_attribute_mode);
472 ANDMISSING(enter_protected_mode, exit_attribute_mode);
473 ANDMISSING(enter_reverse_mode, exit_attribute_mode);
474 PAIRED(from_status_line, to_status_line);
475 PAIRED(meta_off, meta_on);
477 PAIRED(prtr_on, prtr_off);
478 PAIRED(save_cursor, restore_cursor);
479 PAIRED(enter_xon_mode, exit_xon_mode);
480 PAIRED(enter_am_mode, exit_am_mode);
481 ANDMISSING(label_off, label_on);
482 PAIRED(display_clock, remove_clock);
483 ANDMISSING(set_color_pair, initialize_pair);