ncurses 5.9 - patch 20121215
[ncurses.git] / progs / dump_entry.c
1 /****************************************************************************
2  * Copyright (c) 1998-2011,2012 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 #define __INTERNAL_CAPS_VISIBLE
36 #include <progs.priv.h>
37
38 #include "dump_entry.h"
39 #include "termsort.c"           /* this C file is generated */
40 #include <parametrized.h>       /* so is this */
41
42 MODULE_ID("$Id: dump_entry.c,v 1.102 2012/12/15 18:25:56 tom Exp $")
43
44 #define INDENT                  8
45 #define DISCARD(string) string = ABSENT_STRING
46 #define PRINTF (void) printf
47
48 #define OkIndex(index,array) ((int)(index) >= 0 && (int)(index) < (int) SIZEOF(array))
49
50 typedef struct {
51     char *text;
52     size_t used;
53     size_t size;
54 } DYNBUF;
55
56 static int tversion;            /* terminfo version */
57 static int outform;             /* output format to use */
58 static int sortmode;            /* sort mode to use */
59 static int width = 60;          /* max line width for listings */
60 static int height = 65535;      /* max number of lines for listings */
61 static int column;              /* current column, limited by 'width' */
62 static int oldcol;              /* last value of column before wrap */
63 static bool pretty;             /* true if we format if-then-else strings */
64
65 static char *save_sgr;
66
67 static DYNBUF outbuf;
68 static DYNBUF tmpbuf;
69
70 /* indirection pointers for implementing sort and display modes */
71 static const PredIdx *bool_indirect, *num_indirect, *str_indirect;
72 static NCURSES_CONST char *const *bool_names;
73 static NCURSES_CONST char *const *num_names;
74 static NCURSES_CONST char *const *str_names;
75
76 static const char *separator, *trailer;
77
78 /* cover various ports and variants of terminfo */
79 #define V_ALLCAPS       0       /* all capabilities (SVr4, XSI, ncurses) */
80 #define V_SVR1          1       /* SVR1, Ultrix */
81 #define V_HPUX          2       /* HP/UX */
82 #define V_AIX           3       /* AIX */
83 #define V_BSD           4       /* BSD */
84
85 #if NCURSES_XNAMES
86 #define OBSOLETE(n) (!_nc_user_definable && (n[0] == 'O' && n[1] == 'T'))
87 #else
88 #define OBSOLETE(n) (n[0] == 'O' && n[1] == 'T')
89 #endif
90
91 #define isObsolete(f,n) ((f == F_TERMINFO || f == F_VARIABLE) && OBSOLETE(n))
92
93 #if NCURSES_XNAMES
94 #define BoolIndirect(j) ((j >= BOOLCOUNT) ? (j) : ((sortmode == S_NOSORT) ? j : bool_indirect[j]))
95 #define NumIndirect(j)  ((j >= NUMCOUNT)  ? (j) : ((sortmode == S_NOSORT) ? j : num_indirect[j]))
96 #define StrIndirect(j)  ((j >= STRCOUNT)  ? (j) : ((sortmode == S_NOSORT) ? j : str_indirect[j]))
97 #else
98 #define BoolIndirect(j) ((sortmode == S_NOSORT) ? (j) : bool_indirect[j])
99 #define NumIndirect(j)  ((sortmode == S_NOSORT) ? (j) : num_indirect[j])
100 #define StrIndirect(j)  ((sortmode == S_NOSORT) ? (j) : str_indirect[j])
101 #endif
102
103 static void failed(const char *) GCC_NORETURN;
104
105 static void
106 failed(const char *s)
107 {
108     perror(s);
109     ExitProgram(EXIT_FAILURE);
110 }
111
112 static void
113 strncpy_DYN(DYNBUF * dst, const char *src, size_t need)
114 {
115     size_t want = need + dst->used + 1;
116     if (want > dst->size) {
117         dst->size += (want + 1024);     /* be generous */
118         dst->text = typeRealloc(char, dst->size, dst->text);
119         if (dst->text == 0)
120             failed("strncpy_DYN");
121     }
122     (void) strncpy(dst->text + dst->used, src, need);
123     dst->used += need;
124     dst->text[dst->used] = 0;
125 }
126
127 static void
128 strcpy_DYN(DYNBUF * dst, const char *src)
129 {
130     if (src == 0) {
131         dst->used = 0;
132         strcpy_DYN(dst, "");
133     } else {
134         strncpy_DYN(dst, src, strlen(src));
135     }
136 }
137
138 #if NO_LEAKS
139 static void
140 free_DYN(DYNBUF * p)
141 {
142     if (p->text != 0)
143         free(p->text);
144     p->text = 0;
145     p->size = 0;
146     p->used = 0;
147 }
148
149 void
150 _nc_leaks_dump_entry(void)
151 {
152     free_DYN(&outbuf);
153     free_DYN(&tmpbuf);
154 }
155 #endif
156
157 #define NameTrans(check,result) \
158             if (OkIndex(np->nte_index, check) \
159                 && check[np->nte_index]) \
160                 return (result[np->nte_index])
161
162 NCURSES_CONST char *
163 nametrans(const char *name)
164 /* translate a capability name from termcap to terminfo */
165 {
166     const struct name_table_entry *np;
167
168     if ((np = _nc_find_entry(name, _nc_get_hash_table(0))) != 0)
169         switch (np->nte_type) {
170         case BOOLEAN:
171             NameTrans(bool_from_termcap, boolcodes);
172             break;
173
174         case NUMBER:
175             NameTrans(num_from_termcap, numcodes);
176             break;
177
178         case STRING:
179             NameTrans(str_from_termcap, strcodes);
180             break;
181         }
182
183     return (0);
184 }
185
186 void
187 dump_init(const char *version,
188           int mode,
189           int sort,
190           int twidth,
191           int theight,
192           unsigned traceval,
193           bool formatted)
194 /* set up for entry display */
195 {
196     width = twidth;
197     height = theight;
198     pretty = formatted;
199
200     /* versions */
201     if (version == 0)
202         tversion = V_ALLCAPS;
203     else if (!strcmp(version, "SVr1") || !strcmp(version, "SVR1")
204              || !strcmp(version, "Ultrix"))
205         tversion = V_SVR1;
206     else if (!strcmp(version, "HP"))
207         tversion = V_HPUX;
208     else if (!strcmp(version, "AIX"))
209         tversion = V_AIX;
210     else if (!strcmp(version, "BSD"))
211         tversion = V_BSD;
212     else
213         tversion = V_ALLCAPS;
214
215     /* implement display modes */
216     switch (outform = mode) {
217     case F_LITERAL:
218     case F_TERMINFO:
219         bool_names = boolnames;
220         num_names = numnames;
221         str_names = strnames;
222         separator = (twidth > 0 && theight > 1) ? ", " : ",";
223         trailer = "\n\t";
224         break;
225
226     case F_VARIABLE:
227         bool_names = boolfnames;
228         num_names = numfnames;
229         str_names = strfnames;
230         separator = (twidth > 0 && theight > 1) ? ", " : ",";
231         trailer = "\n\t";
232         break;
233
234     case F_TERMCAP:
235     case F_TCONVERR:
236         bool_names = boolcodes;
237         num_names = numcodes;
238         str_names = strcodes;
239         separator = ":";
240         trailer = "\\\n\t:";
241         break;
242     }
243
244     /* implement sort modes */
245     switch (sortmode = sort) {
246     case S_NOSORT:
247         if (traceval)
248             (void) fprintf(stderr,
249                            "%s: sorting by term structure order\n", _nc_progname);
250         break;
251
252     case S_TERMINFO:
253         if (traceval)
254             (void) fprintf(stderr,
255                            "%s: sorting by terminfo name order\n", _nc_progname);
256         bool_indirect = bool_terminfo_sort;
257         num_indirect = num_terminfo_sort;
258         str_indirect = str_terminfo_sort;
259         break;
260
261     case S_VARIABLE:
262         if (traceval)
263             (void) fprintf(stderr,
264                            "%s: sorting by C variable order\n", _nc_progname);
265         bool_indirect = bool_variable_sort;
266         num_indirect = num_variable_sort;
267         str_indirect = str_variable_sort;
268         break;
269
270     case S_TERMCAP:
271         if (traceval)
272             (void) fprintf(stderr,
273                            "%s: sorting by termcap name order\n", _nc_progname);
274         bool_indirect = bool_termcap_sort;
275         num_indirect = num_termcap_sort;
276         str_indirect = str_termcap_sort;
277         break;
278     }
279
280     if (traceval)
281         (void) fprintf(stderr,
282                        "%s: width = %d, tversion = %d, outform = %d\n",
283                        _nc_progname, width, tversion, outform);
284 }
285
286 static TERMTYPE *cur_type;
287
288 static int
289 dump_predicate(PredType type, PredIdx idx)
290 /* predicate function to use for ordinary decompilation */
291 {
292     switch (type) {
293     case BOOLEAN:
294         return (cur_type->Booleans[idx] == FALSE)
295             ? FAIL : cur_type->Booleans[idx];
296
297     case NUMBER:
298         return (cur_type->Numbers[idx] == ABSENT_NUMERIC)
299             ? FAIL : cur_type->Numbers[idx];
300
301     case STRING:
302         return (cur_type->Strings[idx] != ABSENT_STRING)
303             ? (int) TRUE : FAIL;
304     }
305
306     return (FALSE);             /* pacify compiler */
307 }
308
309 static void set_obsolete_termcaps(TERMTYPE *tp);
310
311 /* is this the index of a function key string? */
312 #define FNKEY(i)        (((i)<= 65 && (i)>= 75) || ((i)<= 216 && (i)>= 268))
313
314 /*
315  * If we configure with a different Caps file, the offsets into the arrays
316  * will change.  So we use an address expression.
317  */
318 #define BOOL_IDX(name) (PredType) (&(name) - &(CUR Booleans[0]))
319 #define NUM_IDX(name)  (PredType) (&(name) - &(CUR Numbers[0]))
320 #define STR_IDX(name)  (PredType) (&(name) - &(CUR Strings[0]))
321
322 static bool
323 version_filter(PredType type, PredIdx idx)
324 /* filter out capabilities we may want to suppress */
325 {
326     switch (tversion) {
327     case V_ALLCAPS:             /* SVr4, XSI Curses */
328         return (TRUE);
329
330     case V_SVR1:                /* System V Release 1, Ultrix */
331         switch (type) {
332         case BOOLEAN:
333             return ((idx <= BOOL_IDX(xon_xoff)) ? TRUE : FALSE);
334         case NUMBER:
335             return ((idx <= NUM_IDX(width_status_line)) ? TRUE : FALSE);
336         case STRING:
337             return ((idx <= STR_IDX(prtr_non)) ? TRUE : FALSE);
338         }
339         break;
340
341     case V_HPUX:                /* Hewlett-Packard */
342         switch (type) {
343         case BOOLEAN:
344             return ((idx <= BOOL_IDX(xon_xoff)) ? TRUE : FALSE);
345         case NUMBER:
346             return ((idx <= NUM_IDX(label_width)) ? TRUE : FALSE);
347         case STRING:
348             if (idx <= STR_IDX(prtr_non))
349                 return (TRUE);
350             else if (FNKEY(idx))        /* function keys */
351                 return (TRUE);
352             else if (idx == STR_IDX(plab_norm)
353                      || idx == STR_IDX(label_on)
354                      || idx == STR_IDX(label_off))
355                 return (TRUE);
356             else
357                 return (FALSE);
358         }
359         break;
360
361     case V_AIX:         /* AIX */
362         switch (type) {
363         case BOOLEAN:
364             return ((idx <= BOOL_IDX(xon_xoff)) ? TRUE : FALSE);
365         case NUMBER:
366             return ((idx <= NUM_IDX(width_status_line)) ? TRUE : FALSE);
367         case STRING:
368             if (idx <= STR_IDX(prtr_non))
369                 return (TRUE);
370             else if (FNKEY(idx))        /* function keys */
371                 return (TRUE);
372             else
373                 return (FALSE);
374         }
375         break;
376
377 #define is_termcap(type) (OkIndex(idx, type##_from_termcap) && \
378                           type##_from_termcap[idx])
379
380     case V_BSD:         /* BSD */
381         switch (type) {
382         case BOOLEAN:
383             return is_termcap(bool);
384         case NUMBER:
385             return is_termcap(num);
386         case STRING:
387             return is_termcap(str);
388         }
389         break;
390     }
391
392     return (FALSE);             /* pacify the compiler */
393 }
394
395 static void
396 trim_trailing(void)
397 {
398     while (outbuf.used > 0 && outbuf.text[outbuf.used - 1] == ' ')
399         outbuf.text[--outbuf.used] = '\0';
400 }
401
402 static void
403 force_wrap(void)
404 {
405     oldcol = column;
406     trim_trailing();
407     strcpy_DYN(&outbuf, trailer);
408     column = INDENT;
409 }
410
411 static void
412 wrap_concat(const char *src)
413 {
414     size_t need = strlen(src);
415     size_t want = strlen(separator) + need;
416
417     if (column > INDENT
418         && column + (int) want > width) {
419         force_wrap();
420     }
421     strcpy_DYN(&outbuf, src);
422     strcpy_DYN(&outbuf, separator);
423     column += (int) need;
424 }
425
426 #define IGNORE_SEP_TRAIL(first,last,sep_trail) \
427         if ((size_t)(last - first) > sizeof(sep_trail)-1 \
428          && !strncmp(first, sep_trail, sizeof(sep_trail)-1)) \
429                 first += sizeof(sep_trail)-2
430
431 /* Returns the nominal length of the buffer assuming it is termcap format,
432  * i.e., the continuation sequence is treated as a single character ":".
433  *
434  * There are several implementations of termcap which read the text into a
435  * fixed-size buffer.  Generally they strip the newlines from the text, but may
436  * not do it until after the buffer is read.  Also, "tc=" resolution may be
437  * expanded in the same buffer.  This function is useful for measuring the size
438  * of the best fixed-buffer implementation; the worst case may be much worse.
439  */
440 #ifdef TEST_TERMCAP_LENGTH
441 static int
442 termcap_length(const char *src)
443 {
444     static const char pattern[] = ":\\\n\t:";
445
446     int len = 0;
447     const char *const t = src + strlen(src);
448
449     while (*src != '\0') {
450         IGNORE_SEP_TRAIL(src, t, pattern);
451         src++;
452         len++;
453     }
454     return len;
455 }
456 #else
457 #define termcap_length(src) strlen(src)
458 #endif
459
460 static void
461 indent_DYN(DYNBUF * buffer, int level)
462 {
463     int n;
464
465     for (n = 0; n < level; n++)
466         strncpy_DYN(buffer, "\t", 1);
467 }
468
469 static bool
470 has_params(const char *src)
471 {
472     bool result = FALSE;
473     int len = (int) strlen(src);
474     int n;
475     bool ifthen = FALSE;
476     bool params = FALSE;
477
478     for (n = 0; n < len - 1; ++n) {
479         if (!strncmp(src + n, "%p", 2)) {
480             params = TRUE;
481         } else if (!strncmp(src + n, "%;", 2)) {
482             ifthen = TRUE;
483             result = params;
484             break;
485         }
486     }
487     if (!ifthen) {
488         result = ((len > 50) && params);
489     }
490     return result;
491 }
492
493 static char *
494 fmt_complex(char *src, int level)
495 {
496     bool percent = FALSE;
497     bool params = has_params(src);
498
499     while (*src != '\0') {
500         switch (*src) {
501         case '\\':
502             percent = FALSE;
503             strncpy_DYN(&tmpbuf, src++, 1);
504             break;
505         case '%':
506             percent = TRUE;
507             break;
508         case '?':               /* "if" */
509         case 't':               /* "then" */
510         case 'e':               /* "else" */
511             if (percent) {
512                 percent = FALSE;
513                 tmpbuf.text[tmpbuf.used - 1] = '\n';
514                 /* treat a "%e" as else-if, on the same level */
515                 if (*src == 'e') {
516                     indent_DYN(&tmpbuf, level);
517                     strncpy_DYN(&tmpbuf, "%", 1);
518                     strncpy_DYN(&tmpbuf, src, 1);
519                     src++;
520                     params = has_params(src);
521                     if (!params && *src != '\0' && *src != '%') {
522                         strncpy_DYN(&tmpbuf, "\n", 1);
523                         indent_DYN(&tmpbuf, level + 1);
524                     }
525                 } else {
526                     indent_DYN(&tmpbuf, level + 1);
527                     strncpy_DYN(&tmpbuf, "%", 1);
528                     strncpy_DYN(&tmpbuf, src, 1);
529                     if (*src++ == '?') {
530                         src = fmt_complex(src, level + 1);
531                         if (*src != '\0' && *src != '%') {
532                             strncpy_DYN(&tmpbuf, "\n", 1);
533                             indent_DYN(&tmpbuf, level + 1);
534                         }
535                     } else if (level == 1) {
536                         _nc_warning("%%%c without %%?", *src);
537                     }
538                 }
539                 continue;
540             }
541             break;
542         case ';':               /* "endif" */
543             if (percent) {
544                 percent = FALSE;
545                 if (level > 1) {
546                     tmpbuf.text[tmpbuf.used - 1] = '\n';
547                     indent_DYN(&tmpbuf, level);
548                     strncpy_DYN(&tmpbuf, "%", 1);
549                     strncpy_DYN(&tmpbuf, src++, 1);
550                     return src;
551                 }
552                 _nc_warning("%%; without %%?");
553             }
554             break;
555         case 'p':
556             if (percent && params) {
557                 tmpbuf.text[tmpbuf.used - 1] = '\n';
558                 indent_DYN(&tmpbuf, level + 1);
559                 strncpy_DYN(&tmpbuf, "%", 1);
560             }
561             params = FALSE;
562             percent = FALSE;
563             break;
564         case ' ':
565             strncpy_DYN(&tmpbuf, "\\s", 2);
566             ++src;
567             continue;
568         default:
569             percent = FALSE;
570             break;
571         }
572         strncpy_DYN(&tmpbuf, src++, 1);
573     }
574     return src;
575 }
576
577 #define SAME_CAP(n,cap) (&tterm->Strings[n] == &cap)
578 #define EXTRA_CAP 20
579
580 int
581 fmt_entry(TERMTYPE *tterm,
582           PredFunc pred,
583           bool content_only,
584           bool suppress_untranslatable,
585           bool infodump,
586           int numbers)
587 {
588     PredIdx i, j;
589     char buffer[MAX_TERMINFO_LENGTH + EXTRA_CAP];
590     char *capability;
591     NCURSES_CONST char *name;
592     int predval, len;
593     PredIdx num_bools = 0;
594     PredIdx num_values = 0;
595     PredIdx num_strings = 0;
596     bool outcount = 0;
597
598 #define WRAP_CONCAT     \
599         wrap_concat(buffer); \
600         outcount = TRUE
601
602     len = 12;                   /* terminfo file-header */
603
604     if (pred == 0) {
605         cur_type = tterm;
606         pred = dump_predicate;
607     }
608
609     strcpy_DYN(&outbuf, 0);
610     if (content_only) {
611         column = INDENT;        /* FIXME: workaround to prevent empty lines */
612     } else {
613         strcpy_DYN(&outbuf, tterm->term_names);
614
615         /*
616          * Colon is legal in terminfo descriptions, but not in termcap.
617          */
618         if (!infodump) {
619             char *p = outbuf.text;
620             while (*p) {
621                 if (*p == ':') {
622                     *p = '=';
623                 }
624                 ++p;
625             }
626         }
627         strcpy_DYN(&outbuf, separator);
628         column = (int) outbuf.used;
629         if (height > 1)
630             force_wrap();
631     }
632
633     for_each_boolean(j, tterm) {
634         i = BoolIndirect(j);
635         name = ExtBoolname(tterm, (int) i, bool_names);
636         assert(strlen(name) < sizeof(buffer) - EXTRA_CAP);
637
638         if (!version_filter(BOOLEAN, i))
639             continue;
640         else if (isObsolete(outform, name))
641             continue;
642
643         predval = pred(BOOLEAN, i);
644         if (predval != FAIL) {
645             _nc_STRCPY(buffer, name, sizeof(buffer));
646             if (predval <= 0)
647                 _nc_STRCAT(buffer, "@", sizeof(buffer));
648             else if (i + 1 > num_bools)
649                 num_bools = i + 1;
650             WRAP_CONCAT;
651         }
652     }
653
654     if (column != INDENT && height > 1)
655         force_wrap();
656
657     for_each_number(j, tterm) {
658         i = NumIndirect(j);
659         name = ExtNumname(tterm, (int) i, num_names);
660         assert(strlen(name) < sizeof(buffer) - EXTRA_CAP);
661
662         if (!version_filter(NUMBER, i))
663             continue;
664         else if (isObsolete(outform, name))
665             continue;
666
667         predval = pred(NUMBER, i);
668         if (predval != FAIL) {
669             if (tterm->Numbers[i] < 0) {
670                 _nc_SPRINTF(buffer, _nc_SLIMIT(sizeof(buffer))
671                             "%s@", name);
672             } else {
673                 _nc_SPRINTF(buffer, _nc_SLIMIT(sizeof(buffer))
674                             "%s#%d", name, tterm->Numbers[i]);
675                 if (i + 1 > num_values)
676                     num_values = i + 1;
677             }
678             WRAP_CONCAT;
679         }
680     }
681
682     if (column != INDENT && height > 1)
683         force_wrap();
684
685     len += (int) (num_bools
686                   + num_values * 2
687                   + strlen(tterm->term_names) + 1);
688     if (len & 1)
689         len++;
690
691 #undef CUR
692 #define CUR tterm->
693     if (outform == F_TERMCAP) {
694         if (termcap_reset != ABSENT_STRING) {
695             if (init_3string != ABSENT_STRING
696                 && !strcmp(init_3string, termcap_reset))
697                 DISCARD(init_3string);
698
699             if (reset_2string != ABSENT_STRING
700                 && !strcmp(reset_2string, termcap_reset))
701                 DISCARD(reset_2string);
702         }
703     }
704
705     for_each_string(j, tterm) {
706         i = StrIndirect(j);
707         name = ExtStrname(tterm, (int) i, str_names);
708         assert(strlen(name) < sizeof(buffer) - EXTRA_CAP);
709
710         capability = tterm->Strings[i];
711
712         if (!version_filter(STRING, i))
713             continue;
714         else if (isObsolete(outform, name))
715             continue;
716
717 #if NCURSES_XNAMES
718         /*
719          * Extended names can be longer than 2 characters, but termcap programs
720          * cannot read those (filter them out).
721          */
722         if (outform == F_TERMCAP && (strlen(name) > 2))
723             continue;
724 #endif
725
726         if (outform == F_TERMCAP) {
727             /*
728              * Some older versions of vi want rmir/smir to be defined
729              * for ich/ich1 to work.  If they're not defined, force
730              * them to be output as defined and empty.
731              */
732             if (PRESENT(insert_character) || PRESENT(parm_ich)) {
733                 if (SAME_CAP(i, enter_insert_mode)
734                     && enter_insert_mode == ABSENT_STRING) {
735                     _nc_STRCPY(buffer, "im=", sizeof(buffer));
736                     WRAP_CONCAT;
737                     continue;
738                 }
739
740                 if (SAME_CAP(i, exit_insert_mode)
741                     && exit_insert_mode == ABSENT_STRING) {
742                     _nc_STRCPY(buffer, "ei=", sizeof(buffer));
743                     WRAP_CONCAT;
744                     continue;
745                 }
746             }
747             /*
748              * termcap applications such as screen will be confused if sgr0
749              * is translated to a string containing rmacs.  Filter that out.
750              */
751             if (PRESENT(exit_attribute_mode)) {
752                 if (SAME_CAP(i, exit_attribute_mode)) {
753                     char *trimmed_sgr0;
754                     char *my_sgr = set_attributes;
755
756                     set_attributes = save_sgr;
757
758                     trimmed_sgr0 = _nc_trim_sgr0(tterm);
759                     if (strcmp(capability, trimmed_sgr0))
760                         capability = trimmed_sgr0;
761
762                     set_attributes = my_sgr;
763                 }
764             }
765         }
766
767         predval = pred(STRING, i);
768         buffer[0] = '\0';
769
770         if (predval != FAIL) {
771             if (capability != ABSENT_STRING
772                 && i + 1 > num_strings)
773                 num_strings = i + 1;
774
775             if (!VALID_STRING(capability)) {
776                 _nc_SPRINTF(buffer, _nc_SLIMIT(sizeof(buffer))
777                             "%s@", name);
778                 WRAP_CONCAT;
779             } else if (outform == F_TERMCAP || outform == F_TCONVERR) {
780                 int params = ((i < (int) SIZEOF(parametrized))
781                               ? parametrized[i]
782                               : 0);
783                 char *srccap = _nc_tic_expand(capability, TRUE, numbers);
784                 char *cv = _nc_infotocap(name, srccap, params);
785
786                 if (cv == 0) {
787                     if (outform == F_TCONVERR) {
788                         _nc_SPRINTF(buffer, _nc_SLIMIT(sizeof(buffer))
789                                     "%s=!!! %s WILL NOT CONVERT !!!",
790                                     name, srccap);
791                     } else if (suppress_untranslatable) {
792                         continue;
793                     } else {
794                         char *s = srccap, *d = buffer;
795                         _nc_SPRINTF(d, _nc_SLIMIT(sizeof(buffer)) "..%s=", name);
796                         d += strlen(d);
797                         while ((*d = *s++) != 0) {
798                             if (*d == ':') {
799                                 *d++ = '\\';
800                                 *d = ':';
801                             } else if (*d == '\\') {
802                                 *++d = *s++;
803                             }
804                             d++;
805                         }
806                     }
807                 } else {
808                     _nc_SPRINTF(buffer, _nc_SLIMIT(sizeof(buffer))
809                                 "%s=%s", name, cv);
810                 }
811                 len += (int) strlen(capability) + 1;
812                 WRAP_CONCAT;
813             } else {
814                 char *src = _nc_tic_expand(capability,
815                                            outform == F_TERMINFO, numbers);
816
817                 strcpy_DYN(&tmpbuf, 0);
818                 strcpy_DYN(&tmpbuf, name);
819                 strcpy_DYN(&tmpbuf, "=");
820                 if (pretty
821                     && (outform == F_TERMINFO
822                         || outform == F_VARIABLE)) {
823                     fmt_complex(src, 1);
824                 } else {
825                     strcpy_DYN(&tmpbuf, src);
826                 }
827                 len += (int) strlen(capability) + 1;
828                 wrap_concat(tmpbuf.text);
829                 outcount = TRUE;
830             }
831         }
832         /* e.g., trimmed_sgr0 */
833         if (capability != ABSENT_STRING &&
834             capability != CANCELLED_STRING &&
835             capability != tterm->Strings[i])
836             free(capability);
837     }
838     len += (int) (num_strings * 2);
839
840     /*
841      * This piece of code should be an effective inverse of the functions
842      * postprocess_terminfo() and postprocess_terminfo() in parse_entry.c.
843      * Much more work should be done on this to support dumping termcaps.
844      */
845     if (tversion == V_HPUX) {
846         if (VALID_STRING(memory_lock)) {
847             _nc_SPRINTF(buffer, _nc_SLIMIT(sizeof(buffer))
848                         "meml=%s", memory_lock);
849             WRAP_CONCAT;
850         }
851         if (VALID_STRING(memory_unlock)) {
852             _nc_SPRINTF(buffer, _nc_SLIMIT(sizeof(buffer))
853                         "memu=%s", memory_unlock);
854             WRAP_CONCAT;
855         }
856     } else if (tversion == V_AIX) {
857         if (VALID_STRING(acs_chars)) {
858             bool box_ok = TRUE;
859             const char *acstrans = "lqkxjmwuvtn";
860             const char *cp;
861             char *tp, *sp, boxchars[11];
862
863             tp = boxchars;
864             for (cp = acstrans; *cp; cp++) {
865                 sp = strchr(acs_chars, *cp);
866                 if (sp)
867                     *tp++ = sp[1];
868                 else {
869                     box_ok = FALSE;
870                     break;
871                 }
872             }
873             tp[0] = '\0';
874
875             if (box_ok) {
876                 _nc_STRCPY(buffer, "box1=", sizeof(buffer));
877                 _nc_STRCAT(buffer,
878                            _nc_tic_expand(boxchars,
879                                           outform == F_TERMINFO, numbers),
880                            sizeof(buffer));
881                 WRAP_CONCAT;
882             }
883         }
884     }
885
886     /*
887      * kludge: trim off trailer to avoid an extra blank line
888      * in infocmp -u output when there are no string differences
889      */
890     if (outcount) {
891         bool trimmed = FALSE;
892         j = (PredIdx) outbuf.used;
893         if (j >= 2
894             && outbuf.text[j - 1] == '\t'
895             && outbuf.text[j - 2] == '\n') {
896             outbuf.used -= 2;
897             trimmed = TRUE;
898         } else if (j >= 4
899                    && outbuf.text[j - 1] == ':'
900                    && outbuf.text[j - 2] == '\t'
901                    && outbuf.text[j - 3] == '\n'
902                    && outbuf.text[j - 4] == '\\') {
903             outbuf.used -= 4;
904             trimmed = TRUE;
905         }
906         if (trimmed) {
907             outbuf.text[outbuf.used] = '\0';
908             column = oldcol;
909             strcpy_DYN(&outbuf, " ");
910         }
911     }
912 #if 0
913     fprintf(stderr, "num_bools = %d\n", num_bools);
914     fprintf(stderr, "num_values = %d\n", num_values);
915     fprintf(stderr, "num_strings = %d\n", num_strings);
916     fprintf(stderr, "term_names=%s, len=%d, strlen(outbuf)=%d, outbuf=%s\n",
917             tterm->term_names, len, outbuf.used, outbuf.text);
918 #endif
919     /*
920      * Here's where we use infodump to trigger a more stringent length check
921      * for termcap-translation purposes.
922      * Return the length of the raw entry, without tc= expansions,
923      * It gives an idea of which entries are deadly to even *scan past*,
924      * as opposed to *use*.
925      */
926     return (infodump ? len : (int) termcap_length(outbuf.text));
927 }
928
929 static bool
930 kill_string(TERMTYPE *tterm, char *cap)
931 {
932     unsigned n;
933     for (n = 0; n < NUM_STRINGS(tterm); ++n) {
934         if (cap == tterm->Strings[n]) {
935             tterm->Strings[n] = ABSENT_STRING;
936             return TRUE;
937         }
938     }
939     return FALSE;
940 }
941
942 static char *
943 find_string(TERMTYPE *tterm, char *name)
944 {
945     PredIdx n;
946     for (n = 0; n < NUM_STRINGS(tterm); ++n) {
947         if (version_filter(STRING, n)
948             && !strcmp(name, strnames[n])) {
949             char *cap = tterm->Strings[n];
950             if (VALID_STRING(cap)) {
951                 return cap;
952             }
953             break;
954         }
955     }
956     return ABSENT_STRING;
957 }
958
959 /*
960  * This is used to remove function-key labels from a termcap entry to
961  * make it smaller.
962  */
963 static int
964 kill_labels(TERMTYPE *tterm, int target)
965 {
966     int n;
967     int result = 0;
968     char *cap;
969     char name[10];
970
971     for (n = 0; n <= 10; ++n) {
972         _nc_SPRINTF(name, _nc_SLIMIT(sizeof(name)) "lf%d", n);
973         if ((cap = find_string(tterm, name)) != ABSENT_STRING
974             && kill_string(tterm, cap)) {
975             target -= (int) (strlen(cap) + 5);
976             ++result;
977             if (target < 0)
978                 break;
979         }
980     }
981     return result;
982 }
983
984 /*
985  * This is used to remove function-key definitions from a termcap entry to
986  * make it smaller.
987  */
988 static int
989 kill_fkeys(TERMTYPE *tterm, int target)
990 {
991     int n;
992     int result = 0;
993     char *cap;
994     char name[10];
995
996     for (n = 60; n >= 0; --n) {
997         _nc_SPRINTF(name, _nc_SLIMIT(sizeof(name)) "kf%d", n);
998         if ((cap = find_string(tterm, name)) != ABSENT_STRING
999             && kill_string(tterm, cap)) {
1000             target -= (int) (strlen(cap) + 5);
1001             ++result;
1002             if (target < 0)
1003                 break;
1004         }
1005     }
1006     return result;
1007 }
1008
1009 /*
1010  * Check if the given acsc string is a 1-1 mapping, i.e., just-like-vt100.
1011  * Also, since this is for termcap, we only care about the line-drawing map.
1012  */
1013 #define isLine(c) (strchr("lmkjtuvwqxn", c) != 0)
1014
1015 static bool
1016 one_one_mapping(const char *mapping)
1017 {
1018     bool result = TRUE;
1019
1020     if (mapping != ABSENT_STRING) {
1021         int n = 0;
1022         while (mapping[n] != '\0') {
1023             if (isLine(mapping[n]) &&
1024                 mapping[n] != mapping[n + 1]) {
1025                 result = FALSE;
1026                 break;
1027             }
1028             n += 2;
1029         }
1030     }
1031     return result;
1032 }
1033
1034 #define FMT_ENTRY() \
1035                 fmt_entry(tterm, pred, \
1036                         0, \
1037                         suppress_untranslatable, \
1038                         infodump, numbers)
1039
1040 #define SHOW_WHY PRINTF
1041
1042 static bool
1043 purged_acs(TERMTYPE *tterm)
1044 {
1045     bool result = FALSE;
1046
1047     if (VALID_STRING(acs_chars)) {
1048         if (!one_one_mapping(acs_chars)) {
1049             enter_alt_charset_mode = ABSENT_STRING;
1050             exit_alt_charset_mode = ABSENT_STRING;
1051             SHOW_WHY("# (rmacs/smacs removed for consistency)\n");
1052         }
1053         result = TRUE;
1054     }
1055     return result;
1056 }
1057
1058 /*
1059  * Dump a single entry.
1060  */
1061 void
1062 dump_entry(TERMTYPE *tterm,
1063            bool suppress_untranslatable,
1064            bool limited,
1065            int numbers,
1066            PredFunc pred)
1067 {
1068     TERMTYPE save_tterm;
1069     int len, critlen;
1070     const char *legend;
1071     bool infodump;
1072
1073     if (outform == F_TERMCAP || outform == F_TCONVERR) {
1074         critlen = MAX_TERMCAP_LENGTH;
1075         legend = "older termcap";
1076         infodump = FALSE;
1077         set_obsolete_termcaps(tterm);
1078     } else {
1079         critlen = MAX_TERMINFO_LENGTH;
1080         legend = "terminfo";
1081         infodump = TRUE;
1082     }
1083
1084     save_sgr = set_attributes;
1085
1086     if ((FMT_ENTRY() > critlen)
1087         && limited) {
1088
1089         save_tterm = *tterm;
1090         if (!suppress_untranslatable) {
1091             SHOW_WHY("# (untranslatable capabilities removed to fit entry within %d bytes)\n",
1092                      critlen);
1093             suppress_untranslatable = TRUE;
1094         }
1095         if (FMT_ENTRY() > critlen) {
1096             /*
1097              * We pick on sgr because it's a nice long string capability that
1098              * is really just an optimization hack.  Another good candidate is
1099              * acsc since it is both long and unused by BSD termcap.
1100              */
1101             bool changed = FALSE;
1102
1103 #if NCURSES_XNAMES
1104             /*
1105              * Extended names are most likely function-key definitions.  Drop
1106              * those first.
1107              */
1108             unsigned n;
1109             for (n = STRCOUNT; n < NUM_STRINGS(tterm); n++) {
1110                 const char *name = ExtStrname(tterm, (int) n, strnames);
1111
1112                 if (VALID_STRING(tterm->Strings[n])) {
1113                     set_attributes = ABSENT_STRING;
1114                     /* we remove long names anyway - only report the short */
1115                     if (strlen(name) <= 2) {
1116                         SHOW_WHY("# (%s removed to fit entry within %d bytes)\n",
1117                                  name,
1118                                  critlen);
1119                     }
1120                     changed = TRUE;
1121                     if (FMT_ENTRY() <= critlen)
1122                         break;
1123                 }
1124             }
1125 #endif
1126             if (VALID_STRING(set_attributes)) {
1127                 set_attributes = ABSENT_STRING;
1128                 SHOW_WHY("# (sgr removed to fit entry within %d bytes)\n",
1129                          critlen);
1130                 changed = TRUE;
1131             }
1132             if (!changed || (FMT_ENTRY() > critlen)) {
1133                 if (purged_acs(tterm)) {
1134                     acs_chars = ABSENT_STRING;
1135                     SHOW_WHY("# (acsc removed to fit entry within %d bytes)\n",
1136                              critlen);
1137                     changed = TRUE;
1138                 }
1139             }
1140             if (!changed || (FMT_ENTRY() > critlen)) {
1141                 int oldversion = tversion;
1142
1143                 tversion = V_BSD;
1144                 SHOW_WHY("# (terminfo-only capabilities suppressed to fit entry within %d bytes)\n",
1145                          critlen);
1146
1147                 len = FMT_ENTRY();
1148                 if (len > critlen
1149                     && kill_labels(tterm, len - critlen)) {
1150                     SHOW_WHY("# (some labels capabilities suppressed to fit entry within %d bytes)\n",
1151                              critlen);
1152                     len = FMT_ENTRY();
1153                 }
1154                 if (len > critlen
1155                     && kill_fkeys(tterm, len - critlen)) {
1156                     SHOW_WHY("# (some function-key capabilities suppressed to fit entry within %d bytes)\n",
1157                              critlen);
1158                     len = FMT_ENTRY();
1159                 }
1160                 if (len > critlen) {
1161                     (void) fprintf(stderr,
1162                                    "warning: %s entry is %d bytes long\n",
1163                                    _nc_first_name(tterm->term_names),
1164                                    len);
1165                     SHOW_WHY("# WARNING: this entry, %d bytes long, may core-dump %s libraries!\n",
1166                              len, legend);
1167                 }
1168                 tversion = oldversion;
1169             }
1170             set_attributes = save_sgr;
1171             *tterm = save_tterm;
1172         }
1173     } else if (!version_filter(STRING, STR_IDX(acs_chars))) {
1174         save_tterm = *tterm;
1175         if (purged_acs(tterm)) {
1176             (void) FMT_ENTRY();
1177         }
1178         *tterm = save_tterm;
1179     }
1180 }
1181
1182 void
1183 dump_uses(const char *name, bool infodump)
1184 /* dump "use=" clauses in the appropriate format */
1185 {
1186     char buffer[MAX_TERMINFO_LENGTH];
1187
1188     if (outform == F_TERMCAP || outform == F_TCONVERR)
1189         trim_trailing();
1190     _nc_SPRINTF(buffer, _nc_SLIMIT(sizeof(buffer))
1191                 "%s%s", infodump ? "use=" : "tc=", name);
1192     wrap_concat(buffer);
1193 }
1194
1195 int
1196 show_entry(void)
1197 {
1198     /*
1199      * Trim any remaining whitespace.
1200      */
1201     if (outbuf.used != 0) {
1202         bool infodump = (outform != F_TERMCAP && outform != F_TCONVERR);
1203         char delim = (char) (infodump ? ',' : ':');
1204         int j;
1205
1206         for (j = (int) outbuf.used - 1; j > 0; --j) {
1207             char ch = outbuf.text[j];
1208             if (ch == '\n') {
1209                 ;
1210             } else if (isspace(UChar(ch))) {
1211                 outbuf.used = (size_t) j;
1212             } else if (!infodump && ch == '\\') {
1213                 outbuf.used = (size_t) j;
1214             } else if (ch == delim && (j == 0 || outbuf.text[j - 1] != '\\')) {
1215                 outbuf.used = (size_t) (j + 1);
1216             } else {
1217                 break;
1218             }
1219         }
1220         outbuf.text[outbuf.used] = '\0';
1221     }
1222     (void) fputs(outbuf.text, stdout);
1223     putchar('\n');
1224     return (int) outbuf.used;
1225 }
1226
1227 void
1228 compare_entry(PredHook hook,
1229               TERMTYPE *tp GCC_UNUSED,
1230               bool quiet)
1231 /* compare two entries */
1232 {
1233     PredIdx i, j;
1234     NCURSES_CONST char *name;
1235
1236     if (!quiet)
1237         fputs("    comparing booleans.\n", stdout);
1238     for_each_boolean(j, tp) {
1239         i = BoolIndirect(j);
1240         name = ExtBoolname(tp, (int) i, bool_names);
1241
1242         if (isObsolete(outform, name))
1243             continue;
1244
1245         (*hook) (CMP_BOOLEAN, i, name);
1246     }
1247
1248     if (!quiet)
1249         fputs("    comparing numbers.\n", stdout);
1250     for_each_number(j, tp) {
1251         i = NumIndirect(j);
1252         name = ExtNumname(tp, (int) i, num_names);
1253
1254         if (isObsolete(outform, name))
1255             continue;
1256
1257         (*hook) (CMP_NUMBER, i, name);
1258     }
1259
1260     if (!quiet)
1261         fputs("    comparing strings.\n", stdout);
1262     for_each_string(j, tp) {
1263         i = StrIndirect(j);
1264         name = ExtStrname(tp, (int) i, str_names);
1265
1266         if (isObsolete(outform, name))
1267             continue;
1268
1269         (*hook) (CMP_STRING, i, name);
1270     }
1271
1272     /* (void) fputs("    comparing use entries.\n", stdout); */
1273     (*hook) (CMP_USE, 0, "use");
1274
1275 }
1276
1277 #define NOTSET(s)       ((s) == 0)
1278
1279 /*
1280  * This bit of legerdemain turns all the terminfo variable names into
1281  * references to locations in the arrays Booleans, Numbers, and Strings ---
1282  * precisely what's needed.
1283  */
1284 #undef CUR
1285 #define CUR tp->
1286
1287 static void
1288 set_obsolete_termcaps(TERMTYPE *tp)
1289 {
1290 #include "capdefaults.c"
1291 }
1292
1293 /*
1294  * Convert an alternate-character-set string to canonical form: sorted and
1295  * unique.
1296  */
1297 void
1298 repair_acsc(TERMTYPE *tp)
1299 {
1300     if (VALID_STRING(acs_chars)) {
1301         size_t n, m;
1302         char mapped[256];
1303         char extra = 0;
1304         unsigned source;
1305         unsigned target;
1306         bool fix_needed = FALSE;
1307
1308         for (n = 0, source = 0; acs_chars[n] != 0; n++) {
1309             target = UChar(acs_chars[n]);
1310             if (source >= target) {
1311                 fix_needed = TRUE;
1312                 break;
1313             }
1314             source = target;
1315             if (acs_chars[n + 1])
1316                 n++;
1317         }
1318         if (fix_needed) {
1319             memset(mapped, 0, sizeof(mapped));
1320             for (n = 0; acs_chars[n] != 0; n++) {
1321                 source = UChar(acs_chars[n]);
1322                 if ((target = (unsigned char) acs_chars[n + 1]) != 0) {
1323                     mapped[source] = (char) target;
1324                     n++;
1325                 } else {
1326                     extra = (char) source;
1327                 }
1328             }
1329             for (n = m = 0; n < sizeof(mapped); n++) {
1330                 if (mapped[n]) {
1331                     acs_chars[m++] = (char) n;
1332                     acs_chars[m++] = mapped[n];
1333                 }
1334             }
1335             if (extra)
1336                 acs_chars[m++] = extra;         /* garbage in, garbage out */
1337             acs_chars[m] = 0;
1338         }
1339     }
1340 }