ncurses 6.0 - patch 20170812
[ncurses.git] / ncurses / tinfo / comp_parse.c
1 /****************************************************************************
2  * Copyright (c) 1998-2016,2017 Free Software Foundation, Inc.              *
3  *                                                                          *
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:                 *
11  *                                                                          *
12  * The above copyright notice and this permission notice shall be included  *
13  * in all copies or substantial portions of the Software.                   *
14  *                                                                          *
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.                               *
22  *                                                                          *
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       *
26  * authorization.                                                           *
27  ****************************************************************************/
28
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  ****************************************************************************/
34
35 /*
36  *      comp_parse.c -- parser driver loop and use handling.
37  *
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().
42  */
43
44 #include <curses.priv.h>
45
46 #include <ctype.h>
47
48 #include <tic.h>
49
50 MODULE_ID("$Id: comp_parse.c,v 1.97 2017/08/04 09:02:21 tom Exp $")
51
52 static void sanity_check2(TERMTYPE2 *, bool);
53 NCURSES_IMPEXP void NCURSES_API(*_nc_check_termtype2) (TERMTYPE2 *, bool) = sanity_check2;
54
55 static void fixup_acsc(TERMTYPE2 *, int);
56
57 static void
58 enqueue(ENTRY * ep)
59 /* add an entry to the in-core list */
60 {
61     ENTRY *newp = _nc_copy_entry(ep);
62
63     if (newp == 0)
64         _nc_err_abort(MSG_NO_MEMORY);
65
66     newp->last = _nc_tail;
67     _nc_tail = newp;
68
69     newp->next = 0;
70     if (newp->last)
71         newp->last->next = newp;
72 }
73
74 #define NAMEBUFFER_SIZE (MAX_NAME_SIZE + 2)
75
76 static char *
77 force_bar(char *dst, char *src)
78 {
79     if (strchr(src, '|') == 0) {
80         size_t len = strlen(src);
81         if (len > MAX_NAME_SIZE)
82             len = MAX_NAME_SIZE;
83         _nc_STRNCPY(dst, src, len);
84         _nc_STRCPY(dst + len, "|", NAMEBUFFER_SIZE - len);
85         src = dst;
86     }
87     return src;
88 }
89 #define ForceBar(dst, src) ((strchr(src, '|') == 0) ? force_bar(dst, src) : src)
90
91 #if NCURSES_USE_TERMCAP && NCURSES_XNAMES
92 static char *
93 skip_index(char *name)
94 {
95     char *bar = strchr(name, '|');
96
97     if (bar != 0 && (bar - name) == 2)
98         name = bar + 1;
99
100     return name;
101 }
102 #endif
103
104 static bool
105 check_collisions(char *n1, char *n2, int counter)
106 {
107     char *pstart, *qstart, *pend, *qend;
108     char nc1[NAMEBUFFER_SIZE];
109     char nc2[NAMEBUFFER_SIZE];
110
111     n1 = ForceBar(nc1, n1);
112     n2 = ForceBar(nc2, n2);
113
114 #if NCURSES_USE_TERMCAP && NCURSES_XNAMES
115     if ((_nc_syntax == SYN_TERMCAP) && _nc_user_definable) {
116         n1 = skip_index(n1);
117         n2 = skip_index(n2);
118     }
119 #endif
120
121     for (pstart = n1; (pend = strchr(pstart, '|')); pstart = pend + 1) {
122         for (qstart = n2; (qend = strchr(qstart, '|')); qstart = qend + 1) {
123             if ((pend - pstart == qend - qstart)
124                 && memcmp(pstart, qstart, (size_t) (pend - pstart)) == 0) {
125                 if (counter > 0)
126                     (void) fprintf(stderr, "Name collision '%.*s' between\n",
127                                    (int) (pend - pstart), pstart);
128                 return (TRUE);
129             }
130         }
131     }
132
133     return (FALSE);
134 }
135
136 static char *
137 next_name(char *name)
138 {
139     if (*name != '\0')
140         ++name;
141     return name;
142 }
143
144 static char *
145 name_ending(char *name)
146 {
147     if (*name == '\0') {
148         name = 0;
149     } else {
150         while (*name != '\0' && *name != '|')
151             ++name;
152     }
153     return name;
154 }
155
156 /*
157  * Essentially, find the conflict reported in check_collisions() and remove
158  * it from the second name, unless that happens to be the last alias.
159  */
160 static bool
161 remove_collision(char *n1, char *n2)
162 {
163     char *p2 = n2;
164     char *pstart, *qstart, *pend, *qend;
165     bool removed = FALSE;
166
167 #if NCURSES_USE_TERMCAP && NCURSES_XNAMES
168     if ((_nc_syntax == SYN_TERMCAP) && _nc_user_definable) {
169         n1 = skip_index(n1);
170         p2 = n2 = skip_index(n2);
171     }
172 #endif
173
174     for (pstart = n1; (pend = name_ending(pstart)); pstart = next_name(pend)) {
175         for (qstart = n2; (qend = name_ending(qstart)); qstart = next_name(qend)) {
176             if ((pend - pstart == qend - qstart)
177                 && memcmp(pstart, qstart, (size_t) (pend - pstart)) == 0) {
178                 if (qstart != p2 || *qend == '|') {
179                     if (*qend == '|')
180                         ++qend;
181                     while ((*qstart++ = *qend++) != '\0') ;
182                     fprintf(stderr, "...now\t%s\n", p2);
183                 } else {
184                     fprintf(stderr, "Cannot remove alias '%.*s'\n",
185                             (int) (qend - qstart), qstart);
186                 }
187                 removed = TRUE;
188                 break;
189             }
190         }
191     }
192
193     return removed;
194 }
195
196 /* do any of the aliases in a pair of terminal names match? */
197 NCURSES_EXPORT(bool)
198 _nc_entry_match(char *n1, char *n2)
199 {
200     return check_collisions(n1, n2, 0);
201 }
202
203 /****************************************************************************
204  *
205  * Entry compiler and resolution logic
206  *
207  ****************************************************************************/
208
209 NCURSES_EXPORT(void)
210 _nc_read_entry_source(FILE *fp, char *buf,
211                       int literal, bool silent,
212                       bool(*hook) (ENTRY *))
213 /* slurp all entries in the given file into core */
214 {
215     ENTRY thisentry;
216     bool oldsuppress = _nc_suppress_warnings;
217     int immediate = 0;
218
219     if (silent)
220         _nc_suppress_warnings = TRUE;   /* shut the lexer up, too */
221
222     _nc_reset_input(fp, buf);
223     for (;;) {
224         memset(&thisentry, 0, sizeof(thisentry));
225         if (_nc_parse_entry(&thisentry, literal, silent) == ERR)
226             break;
227         if (!isalnum(UChar(thisentry.tterm.term_names[0])))
228             _nc_err_abort("terminal names must start with letter or digit");
229
230         /*
231          * This can be used for immediate compilation of entries with no "use="
232          * references to disk.  That avoids consuming a lot of memory when the
233          * resolution code could fetch entries off disk.
234          */
235         if (hook != NULLHOOK && (*hook) (&thisentry)) {
236             immediate++;
237         } else {
238             enqueue(&thisentry);
239             /*
240              * The enqueued entry is copied with _nc_copy_termtype(), so we can
241              * free some of the data from thisentry, i.e., the arrays.
242              */
243             FreeIfNeeded(thisentry.tterm.Booleans);
244             FreeIfNeeded(thisentry.tterm.Numbers);
245             FreeIfNeeded(thisentry.tterm.Strings);
246 #if NCURSES_XNAMES
247             FreeIfNeeded(thisentry.tterm.ext_Names);
248 #endif
249         }
250     }
251
252     if (_nc_tail) {
253         /* set up the head pointer */
254         for (_nc_head = _nc_tail; _nc_head->last; _nc_head = _nc_head->last)
255             continue;
256
257         DEBUG(1, ("head = %s", _nc_head->tterm.term_names));
258         DEBUG(1, ("tail = %s", _nc_tail->tterm.term_names));
259     }
260 #ifdef TRACE
261     else if (!immediate)
262         DEBUG(1, ("no entries parsed"));
263 #endif
264
265     _nc_suppress_warnings = oldsuppress;
266 }
267
268 NCURSES_EXPORT(int)
269 _nc_resolve_uses2(bool fullresolve, bool literal)
270 /* try to resolve all use capabilities */
271 {
272     ENTRY *qp, *rp, *lastread = 0;
273     bool keepgoing;
274     unsigned i;
275     int unresolved, total_unresolved, multiples;
276
277     DEBUG(2, ("RESOLUTION BEGINNING"));
278
279     /*
280      * Check for multiple occurrences of the same name.
281      */
282     multiples = 0;
283     for_entry_list(qp) {
284         int matchcount = 0;
285
286         for_entry_list(rp) {
287             if (qp > rp
288                 && check_collisions(qp->tterm.term_names,
289                                     rp->tterm.term_names,
290                                     matchcount + 1)) {
291                 if (!matchcount++) {
292                     (void) fprintf(stderr, "\t%s\n", rp->tterm.term_names);
293                 }
294                 (void) fprintf(stderr, "and\t%s\n", qp->tterm.term_names);
295                 if (!remove_collision(rp->tterm.term_names,
296                                       qp->tterm.term_names)) {
297                     ++multiples;
298                 }
299             }
300         }
301     }
302     if (multiples > 0)
303         return (FALSE);
304
305     DEBUG(2, ("NO MULTIPLE NAME OCCURRENCES"));
306
307     /*
308      * First resolution stage: compute link pointers corresponding to names.
309      */
310     total_unresolved = 0;
311     _nc_curr_col = -1;
312     for_entry_list(qp) {
313         unresolved = 0;
314         for (i = 0; i < qp->nuses; i++) {
315             bool foundit;
316             char *child = _nc_first_name(qp->tterm.term_names);
317             char *lookfor = qp->uses[i].name;
318             long lookline = qp->uses[i].line;
319
320             foundit = FALSE;
321
322             _nc_set_type(child);
323
324             /* first, try to resolve from in-core records */
325             for_entry_list(rp) {
326                 if (rp != qp
327                     && _nc_name_match(rp->tterm.term_names, lookfor, "|")) {
328                     DEBUG(2, ("%s: resolving use=%s (in core)",
329                               child, lookfor));
330
331                     qp->uses[i].link = rp;
332                     foundit = TRUE;
333                 }
334             }
335
336             /* if that didn't work, try to merge in a compiled entry */
337             if (!foundit) {
338                 TERMTYPE2 thisterm;
339                 char filename[PATH_MAX];
340
341                 memset(&thisterm, 0, sizeof(thisterm));
342                 if (_nc_read_entry2(lookfor, filename, &thisterm) == 1) {
343                     DEBUG(2, ("%s: resolving use=%s (compiled)",
344                               child, lookfor));
345
346                     TYPE_MALLOC(ENTRY, 1, rp);
347                     rp->tterm = thisterm;
348                     rp->nuses = 0;
349                     rp->next = lastread;
350                     lastread = rp;
351
352                     qp->uses[i].link = rp;
353                     foundit = TRUE;
354                 }
355             }
356
357             /* no good, mark this one unresolvable and complain */
358             if (!foundit) {
359                 unresolved++;
360                 total_unresolved++;
361
362                 _nc_curr_line = (int) lookline;
363                 _nc_warning("resolution of use=%s failed", lookfor);
364                 qp->uses[i].link = 0;
365             }
366         }
367     }
368     if (total_unresolved) {
369         /* free entries read in off disk */
370         _nc_free_entries(lastread);
371         return (FALSE);
372     }
373
374     DEBUG(2, ("NAME RESOLUTION COMPLETED OK"));
375
376     /*
377      * OK, at this point all (char *) references in `name' members
378      * have been successfully converted to (ENTRY *) pointers in
379      * `link' members.  Time to do the actual merges.
380      */
381     if (fullresolve) {
382         do {
383             ENTRY merged;
384
385             keepgoing = FALSE;
386
387             for_entry_list(qp) {
388                 if (qp->nuses > 0) {
389                     DEBUG(2, ("%s: attempting merge",
390                               _nc_first_name(qp->tterm.term_names)));
391                     /*
392                      * If any of the use entries we're looking for is
393                      * incomplete, punt.  We'll catch this entry on a
394                      * subsequent pass.
395                      */
396                     for (i = 0; i < qp->nuses; i++)
397                         if (qp->uses[i].link->nuses) {
398                             DEBUG(2, ("%s: use entry %d unresolved",
399                                       _nc_first_name(qp->tterm.term_names), i));
400                             goto incomplete;
401                         }
402
403                     /*
404                      * First, make sure there is no garbage in the
405                      * merge block.  As a side effect, copy into
406                      * the merged entry the name field and string
407                      * table pointer.
408                      */
409                     _nc_copy_termtype2(&(merged.tterm), &(qp->tterm));
410
411                     /*
412                      * Now merge in each use entry in the proper
413                      * (reverse) order.
414                      */
415                     for (; qp->nuses; qp->nuses--)
416                         _nc_merge_entry(&merged,
417                                         qp->uses[qp->nuses - 1].link);
418
419                     /*
420                      * Now merge in the original entry.
421                      */
422                     _nc_merge_entry(&merged, qp);
423
424                     /*
425                      * Replace the original entry with the merged one.
426                      */
427                     FreeIfNeeded(qp->tterm.Booleans);
428                     FreeIfNeeded(qp->tterm.Numbers);
429                     FreeIfNeeded(qp->tterm.Strings);
430 #if NCURSES_XNAMES
431                     FreeIfNeeded(qp->tterm.ext_Names);
432 #endif
433                     qp->tterm = merged.tterm;
434                     _nc_wrap_entry(qp, TRUE);
435
436                     /*
437                      * We know every entry is resolvable because name resolution
438                      * didn't bomb.  So go back for another pass.
439                      */
440                     /* FALLTHRU */
441                   incomplete:
442                     keepgoing = TRUE;
443                 }
444             }
445         } while
446             (keepgoing);
447
448         DEBUG(2, ("MERGES COMPLETED OK"));
449     }
450
451     /*
452      * We'd like to free entries read in off disk at this point, but can't.
453      * The merge_entry() code doesn't copy the strings in the use entries,
454      * it just aliases them.  If this ever changes, do a
455      * free_entries(lastread) here.
456      */
457
458     DEBUG(2, ("RESOLUTION FINISHED"));
459
460     if (fullresolve) {
461         _nc_curr_col = -1;
462         for_entry_list(qp) {
463             _nc_curr_line = (int) qp->startline;
464             _nc_set_type(_nc_first_name(qp->tterm.term_names));
465             /*
466              * tic overrides this function pointer to provide more verbose
467              * checking.
468              */
469             if (_nc_check_termtype2 != sanity_check2) {
470                 SCREEN *save_SP = SP;
471                 SCREEN fake_sp;
472                 TERMINAL fake_tm;
473                 TERMINAL *save_tm = cur_term;
474
475                 /*
476                  * Setup so that tic can use ordinary terminfo interface to
477                  * obtain capability information.
478                  */
479                 memset(&fake_sp, 0, sizeof(fake_sp));
480                 memset(&fake_tm, 0, sizeof(fake_tm));
481                 fake_sp._term = &fake_tm;
482                 TerminalType(&fake_tm) = qp->tterm;
483                 _nc_set_screen(&fake_sp);
484                 set_curterm(&fake_tm);
485
486                 _nc_check_termtype2(&qp->tterm, literal);
487
488                 _nc_set_screen(save_SP);
489                 set_curterm(save_tm);
490             } else {
491                 fixup_acsc(&qp->tterm, literal);
492             }
493         }
494         DEBUG(2, ("SANITY CHECK FINISHED"));
495     }
496
497     return (TRUE);
498 }
499
500 /*
501  * This bit of legerdemain turns all the terminfo variable names into
502  * references to locations in the arrays Booleans, Numbers, and Strings ---
503  * precisely what's needed.
504  */
505
506 #undef CUR
507 #define CUR tp->
508
509 static void
510 fixup_acsc(TERMTYPE2 *tp, int literal)
511 {
512     if (!literal) {
513         if (acs_chars == 0
514             && enter_alt_charset_mode != 0
515             && exit_alt_charset_mode != 0)
516             acs_chars = strdup(VT_ACSC);
517     }
518 }
519
520 static void
521 sanity_check2(TERMTYPE2 *tp, bool literal)
522 {
523     if (!PRESENT(exit_attribute_mode)) {
524 #ifdef __UNUSED__               /* this casts too wide a net */
525         bool terminal_entry = !strchr(tp->term_names, '+');
526         if (terminal_entry &&
527             (PRESENT(set_attributes)
528              || PRESENT(enter_standout_mode)
529              || PRESENT(enter_underline_mode)
530              || PRESENT(enter_blink_mode)
531              || PRESENT(enter_bold_mode)
532              || PRESENT(enter_dim_mode)
533              || PRESENT(enter_secure_mode)
534              || PRESENT(enter_protected_mode)
535              || PRESENT(enter_reverse_mode)))
536             _nc_warning("no exit_attribute_mode");
537 #endif /* __UNUSED__ */
538         PAIRED(enter_standout_mode, exit_standout_mode);
539         PAIRED(enter_underline_mode, exit_underline_mode);
540         PAIRED(enter_italics_mode, exit_italics_mode);
541     }
542
543     /* we do this check/fix in postprocess_termcap(), but some packagers
544      * prefer to bypass it...
545      */
546     if (!literal) {
547         fixup_acsc(tp, literal);
548         ANDMISSING(enter_alt_charset_mode, acs_chars);
549         ANDMISSING(exit_alt_charset_mode, acs_chars);
550     }
551
552     /* listed in structure-member order of first argument */
553     PAIRED(enter_alt_charset_mode, exit_alt_charset_mode);
554     ANDMISSING(enter_blink_mode, exit_attribute_mode);
555     ANDMISSING(enter_bold_mode, exit_attribute_mode);
556     PAIRED(exit_ca_mode, enter_ca_mode);
557     PAIRED(enter_delete_mode, exit_delete_mode);
558     ANDMISSING(enter_dim_mode, exit_attribute_mode);
559     PAIRED(enter_insert_mode, exit_insert_mode);
560     ANDMISSING(enter_secure_mode, exit_attribute_mode);
561     ANDMISSING(enter_protected_mode, exit_attribute_mode);
562     ANDMISSING(enter_reverse_mode, exit_attribute_mode);
563     PAIRED(from_status_line, to_status_line);
564     PAIRED(meta_off, meta_on);
565
566     PAIRED(prtr_on, prtr_off);
567     PAIRED(save_cursor, restore_cursor);
568     PAIRED(enter_xon_mode, exit_xon_mode);
569     PAIRED(enter_am_mode, exit_am_mode);
570     ANDMISSING(label_off, label_on);
571 #ifdef remove_clock
572     PAIRED(display_clock, remove_clock);
573 #endif
574     ANDMISSING(set_color_pair, initialize_pair);
575 }
576
577 #if NO_LEAKS
578 NCURSES_EXPORT(void)
579 _nc_leaks_tic(void)
580 {
581     T((T_CALLED("_nc_free_tic()")));
582     _nc_globals.leak_checking = TRUE;
583     _nc_alloc_entry_leaks();
584     _nc_captoinfo_leaks();
585     _nc_comp_scan_leaks();
586 #if BROKEN_LINKER || USE_REENTRANT
587     _nc_names_leaks();
588     _nc_codes_leaks();
589 #endif
590     _nc_tic_expand(0, FALSE, 0);
591 }
592
593 NCURSES_EXPORT(void)
594 _nc_free_tic(int code)
595 {
596     _nc_leaks_tic();
597     _nc_free_tinfo(code);
598 }
599 #endif