progs/dump_entry.c

   1 /****************************************************************************
   2  * Copyright (c) 1998-2018,2019 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.172 2019/04/20 18:54:48 tom Exp $")
  43
  44 #define DISCARD(string) string = ABSENT_STRING
  45 #define PRINTF (void) printf
  46 #define WRAPPED 32
  47
  48 #define OkIndex(index,array) ((int)(index) >= 0 && (int)(index) < (int) SIZEOF(array))
  49 #define TcOutput() (outform == F_TERMCAP || outform == F_TCONVERR)
  50
  51 typedef struct {
  52     char *text;
  53     size_t used;
  54     size_t size;
  55 } DYNBUF;
  56
  57 static int tversion;            /* terminfo version */
  58 static int outform;             /* output format to use */
  59 static int sortmode;            /* sort mode to use */
  60 static int width = 60;          /* max line width for listings */
  61 static int height = 65535;      /* max number of lines for listings */
  62 static int column;              /* current column, limited by 'width' */
  63 static int oldcol;              /* last value of column before wrap */
  64 static bool pretty;             /* true if we format if-then-else strings */
  65 static bool wrapped;            /* true if we wrap too-long strings */
  66 static bool did_wrap;           /* true if last wrap_concat did wrapping */
  67 static bool checking;           /* true if we are checking for tic */
  68 static int quickdump;           /* true if we are dumping compiled data */
  69
  70 static char *save_sgr;
  71
  72 static DYNBUF outbuf;
  73 static DYNBUF tmpbuf;
  74
  75 /* indirection pointers for implementing sort and display modes */
  76 static const PredIdx *bool_indirect, *num_indirect, *str_indirect;
  77 static NCURSES_CONST char *const *bool_names;
  78 static NCURSES_CONST char *const *num_names;
  79 static NCURSES_CONST char *const *str_names;
  80
  81 static const char *separator = "", *trailer = "";
  82 static int indent = 8;
  83
  84 /* cover various ports and variants of terminfo */
  85 #define V_ALLCAPS       0       /* all capabilities (SVr4, XSI, ncurses) */
  86 #define V_SVR1          1       /* SVR1, Ultrix */
  87 #define V_HPUX          2       /* HP/UX */
  88 #define V_AIX           3       /* AIX */
  89 #define V_BSD           4       /* BSD */
  90
  91 #if NCURSES_XNAMES
  92 #define OBSOLETE(n) (!_nc_user_definable && (n[0] == 'O' && n[1] == 'T'))
  93 #else
  94 #define OBSOLETE(n) (n[0] == 'O' && n[1] == 'T')
  95 #endif
  96
  97 #define isObsolete(f,n) ((f == F_TERMINFO || f == F_VARIABLE) && (sortmode != S_VARIABLE) && OBSOLETE(n))
  98
  99 #if NCURSES_XNAMES
 100 #define BoolIndirect(j) ((j >= BOOLCOUNT) ? (j) : ((sortmode == S_NOSORT) ? j : bool_indirect[j]))
 101 #define NumIndirect(j)  ((j >= NUMCOUNT)  ? (j) : ((sortmode == S_NOSORT) ? j : num_indirect[j]))
 102 #define StrIndirect(j)  ((j >= STRCOUNT)  ? (j) : ((sortmode == S_NOSORT) ? j : str_indirect[j]))
 103 #else
 104 #define BoolIndirect(j) ((sortmode == S_NOSORT) ? (j) : bool_indirect[j])
 105 #define NumIndirect(j)  ((sortmode == S_NOSORT) ? (j) : num_indirect[j])
 106 #define StrIndirect(j)  ((sortmode == S_NOSORT) ? (j) : str_indirect[j])
 107 #endif
 108
 109 static void failed(const char *) GCC_NORETURN;
 110
 111 static void
 112 failed(const char *s)
 113 {
 114     perror(s);
 115     ExitProgram(EXIT_FAILURE);
 116 }
 117
 118 static void
 119 strncpy_DYN(DYNBUF * dst, const char *src, size_t need)
 120 {
 121     size_t want = need + dst->used + 1;
 122     if (want > dst->size) {
 123         dst->size += (want + 1024);     /* be generous */
 124         dst->text = typeRealloc(char, dst->size, dst->text);
 125         if (dst->text == 0)
 126             failed("strncpy_DYN");
 127     }
 128     _nc_STRNCPY(dst->text + dst->used, src, need + 1);
 129     dst->used += need;
 130     dst->text[dst->used] = 0;
 131 }
 132
 133 static void
 134 strcpy_DYN(DYNBUF * dst, const char *src)
 135 {
 136     if (src == 0) {
 137         dst->used = 0;
 138         strcpy_DYN(dst, "");
 139     } else {
 140         strncpy_DYN(dst, src, strlen(src));
 141     }
 142 }
 143
 144 #if NO_LEAKS
 145 static void
 146 free_DYN(DYNBUF * p)
 147 {
 148     if (p->text != 0)
 149         free(p->text);
 150     p->text = 0;
 151     p->size = 0;
 152     p->used = 0;
 153 }
 154
 155 void
 156 _nc_leaks_dump_entry(void)
 157 {
 158     free_DYN(&outbuf);
 159     free_DYN(&tmpbuf);
 160 }
 161 #endif
 162
 163 #define NameTrans(check,result) \
 164             if ((np->nte_index <= OK_ ## check) \
 165                 && check[np->nte_index]) \
 166                 return (result[np->nte_index])
 167
 168 NCURSES_CONST char *
 169 nametrans(const char *name)
 170 /* translate a capability name to termcap from terminfo */
 171 {
 172     const struct name_table_entry *np;
 173
 174     if ((np = _nc_find_entry(name, _nc_get_hash_table(0))) != 0) {
 175         switch (np->nte_type) {
 176         case BOOLEAN:
 177             NameTrans(bool_from_termcap, boolcodes);
 178             break;
 179
 180         case NUMBER:
 181             NameTrans(num_from_termcap, numcodes);
 182             break;
 183
 184         case STRING:
 185             NameTrans(str_from_termcap, strcodes);
 186             break;
 187         }
 188     }
 189
 190     return (0);
 191 }
 192
 193 void
 194 dump_init(const char *version,
 195           int mode,
 196           int sort,
 197           bool wrap_strings,
 198           int twidth,
 199           int theight,
 200           unsigned traceval,
 201           bool formatted,
 202           bool check,
 203           int quick)
 204 /* set up for entry display */
 205 {
 206     width = twidth;
 207     height = theight;
 208     pretty = formatted;
 209     wrapped = wrap_strings;
 210     checking = check;
 211     quickdump = (quick & 3);
 212
 213     did_wrap = (width <= 0);
 214
 215     /* versions */
 216     if (version == 0)
 217         tversion = V_ALLCAPS;
 218     else if (!strcmp(version, "SVr1") || !strcmp(version, "SVR1")
 219              || !strcmp(version, "Ultrix"))
 220         tversion = V_SVR1;
 221     else if (!strcmp(version, "HP"))
 222         tversion = V_HPUX;
 223     else if (!strcmp(version, "AIX"))
 224         tversion = V_AIX;
 225     else if (!strcmp(version, "BSD"))
 226         tversion = V_BSD;
 227     else
 228         tversion = V_ALLCAPS;
 229
 230     /* implement display modes */
 231     switch (outform = mode) {
 232     case F_LITERAL:
 233     case F_TERMINFO:
 234         bool_names = boolnames;
 235         num_names = numnames;
 236         str_names = strnames;
 237         separator = (twidth > 0 && theight > 1) ? ", " : ",";
 238         trailer = "\n\t";
 239         break;
 240
 241     case F_VARIABLE:
 242         bool_names = boolfnames;
 243         num_names = numfnames;
 244         str_names = strfnames;
 245         separator = (twidth > 0 && theight > 1) ? ", " : ",";
 246         trailer = "\n\t";
 247         break;
 248
 249     case F_TERMCAP:
 250     case F_TCONVERR:
 251         bool_names = boolcodes;
 252         num_names = numcodes;
 253         str_names = strcodes;
 254         separator = ":";
 255         trailer = "\\\n\t:";
 256         break;
 257     }
 258     indent = 8;
 259
 260     /* implement sort modes */
 261     switch (sortmode = sort) {
 262     case S_NOSORT:
 263         if (traceval)
 264             (void) fprintf(stderr,
 265                            "%s: sorting by term structure order\n", _nc_progname);
 266         break;
 267
 268     case S_TERMINFO:
 269         if (traceval)
 270             (void) fprintf(stderr,
 271                            "%s: sorting by terminfo name order\n", _nc_progname);
 272         bool_indirect = bool_terminfo_sort;
 273         num_indirect = num_terminfo_sort;
 274         str_indirect = str_terminfo_sort;
 275         break;
 276
 277     case S_VARIABLE:
 278         if (traceval)
 279             (void) fprintf(stderr,
 280                            "%s: sorting by C variable order\n", _nc_progname);
 281         bool_indirect = bool_variable_sort;
 282         num_indirect = num_variable_sort;
 283         str_indirect = str_variable_sort;
 284         break;
 285
 286     case S_TERMCAP:
 287         if (traceval)
 288             (void) fprintf(stderr,
 289                            "%s: sorting by termcap name order\n", _nc_progname);
 290         bool_indirect = bool_termcap_sort;
 291         num_indirect = num_termcap_sort;
 292         str_indirect = str_termcap_sort;
 293         break;
 294     }
 295
 296     if (traceval)
 297         (void) fprintf(stderr,
 298                        "%s: width = %d, tversion = %d, outform = %d\n",
 299                        _nc_progname, width, tversion, outform);
 300 }
 301
 302 static TERMTYPE2 *cur_type;
 303
 304 static int
 305 dump_predicate(PredType type, PredIdx idx)
 306 /* predicate function to use for ordinary decompilation */
 307 {
 308     switch (type) {
 309     case BOOLEAN:
 310         return (cur_type->Booleans[idx] == FALSE)
 311             ? FAIL : cur_type->Booleans[idx];
 312
 313     case NUMBER:
 314         return (cur_type->Numbers[idx] == ABSENT_NUMERIC)
 315             ? FAIL : cur_type->Numbers[idx];
 316
 317     case STRING:
 318         return (cur_type->Strings[idx] != ABSENT_STRING)
 319             ? (int) TRUE : FAIL;
 320     }
 321
 322     return (FALSE);             /* pacify compiler */
 323 }
 324
 325 static void set_obsolete_termcaps(TERMTYPE2 *tp);
 326
 327 /* is this the index of a function key string? */
 328 #define FNKEY(i) \
 329     (((i) >= STR_IDX(key_f0) && \
 330       (i) <= STR_IDX(key_f9)) || \
 331      ((i) >= STR_IDX(key_f11) && \
 332       (i) <= STR_IDX(key_f63)))
 333
 334 /*
 335  * If we configure with a different Caps file, the offsets into the arrays
 336  * will change.  So we use an address expression.
 337  */
 338 #define BOOL_IDX(name) (PredType) (&(name) - &(CUR Booleans[0]))
 339 #define NUM_IDX(name)  (PredType) (&(name) - &(CUR Numbers[0]))
 340 #define STR_IDX(name)  (PredType) (&(name) - &(CUR Strings[0]))
 341
 342 static bool
 343 version_filter(PredType type, PredIdx idx)
 344 /* filter out capabilities we may want to suppress */
 345 {
 346     switch (tversion) {
 347     case V_ALLCAPS:             /* SVr4, XSI Curses */
 348         return (TRUE);
 349
 350     case V_SVR1:                /* System V Release 1, Ultrix */
 351         switch (type) {
 352         case BOOLEAN:
 353             return ((idx <= BOOL_IDX(xon_xoff)) ? TRUE : FALSE);
 354         case NUMBER:
 355             return ((idx <= NUM_IDX(width_status_line)) ? TRUE : FALSE);
 356         case STRING:
 357             return ((idx <= STR_IDX(prtr_non)) ? TRUE : FALSE);
 358         }
 359         break;
 360
 361     case V_HPUX:                /* Hewlett-Packard */
 362         switch (type) {
 363         case BOOLEAN:
 364             return ((idx <= BOOL_IDX(xon_xoff)) ? TRUE : FALSE);
 365         case NUMBER:
 366             return ((idx <= NUM_IDX(label_width)) ? 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 if (idx == STR_IDX(plab_norm)
 373                      || idx == STR_IDX(label_on)
 374                      || idx == STR_IDX(label_off))
 375                 return (TRUE);
 376             else
 377                 return (FALSE);
 378         }
 379         break;
 380
 381     case V_AIX:         /* AIX */
 382         switch (type) {
 383         case BOOLEAN:
 384             return ((idx <= BOOL_IDX(xon_xoff)) ? TRUE : FALSE);
 385         case NUMBER:
 386             return ((idx <= NUM_IDX(width_status_line)) ? TRUE : FALSE);
 387         case STRING:
 388             if (idx <= STR_IDX(prtr_non))
 389                 return (TRUE);
 390             else if (FNKEY(idx))        /* function keys */
 391                 return (TRUE);
 392             else
 393                 return (FALSE);
 394         }
 395         break;
 396
 397 #define is_termcap(type) (OkIndex(idx, type##_from_termcap) && \
 398                           type##_from_termcap[idx])
 399
 400     case V_BSD:         /* BSD */
 401         switch (type) {
 402         case BOOLEAN:
 403             return is_termcap(bool);
 404         case NUMBER:
 405             return is_termcap(num);
 406         case STRING:
 407             return is_termcap(str);
 408         }
 409         break;
 410     }
 411
 412     return (FALSE);             /* pacify the compiler */
 413 }
 414
 415 static void
 416 trim_trailing(void)
 417 {
 418     while (outbuf.used > 0 && outbuf.text[outbuf.used - 1] == ' ')
 419         outbuf.text[--outbuf.used] = '\0';
 420 }
 421
 422 static void
 423 force_wrap(void)
 424 {
 425     oldcol = column;
 426     trim_trailing();
 427     strcpy_DYN(&outbuf, trailer);
 428     column = indent;
 429 }
 430
 431 static int
 432 op_length(const char *src, int offset)
 433 {
 434     int result = 0;
 435     int ch;
 436     if (offset > 0 && src[offset - 1] == '\\') {
 437         result = 0;
 438     } else {
 439         result++;               /* for '%' mark */
 440         ch = src[offset + result];
 441         if (TcOutput()) {
 442             if (ch == '>') {
 443                 result += 3;
 444             } else if (ch == '+') {
 445                 result += 2;
 446             } else {
 447                 result++;
 448             }
 449         } else if (ch == '\'') {
 450             result += 3;
 451         } else if (ch == L_CURL[0]) {
 452             int n = result;
 453             while ((ch = src[offset + n]) != '\0') {
 454                 if (ch == R_CURL[0]) {
 455                     result = ++n;
 456                     break;
 457                 }
 458                 n++;
 459             }
 460         } else if (strchr("pPg", ch) != 0) {
 461             result += 2;
 462         } else {
 463             result++;           /* ordinary operator */
 464         }
 465     }
 466     return result;
 467 }
 468
 469 /*
 470  * When wrapping too-long strings, avoid splitting a backslash sequence, or
 471  * a terminfo '%' operator.  That will leave things a little ragged, but avoids
 472  * a stray backslash at the end of the line, as well as making the result a
 473  * little more readable.
 474  */
 475 static int
 476 find_split(const char *src, int step, int size)
 477 {
 478     int result = size;
 479     int n;
 480     if (size > 0) {
 481         /* check if that would split a backslash-sequence */
 482         int mark = size;
 483         for (n = size - 1; n > 0; --n) {
 484             int ch = UChar(src[step + n]);
 485             if (ch == '\\') {
 486                 if (n > 0 && src[step + n - 1] == ch)
 487                     --n;
 488                 mark = n;
 489                 break;
 490             } else if (!isalnum(ch)) {
 491                 break;
 492             }
 493         }
 494         if (mark < size) {
 495             result = mark;
 496         } else {
 497             /* check if that would split a backslash-sequence */
 498             for (n = size - 1; n > 0; --n) {
 499                 int ch = UChar(src[step + n]);
 500                 if (ch == '%') {
 501                     int need = op_length(src, step + n);
 502                     if ((n + need) > size) {
 503                         mark = n;
 504                     }
 505                     break;
 506                 }
 507             }
 508             if (mark < size) {
 509                 result = mark;
 510             }
 511         }
 512     }
 513     return result;
 514 }
 515
 516 /*
 517  * If we are going to wrap lines, we cannot leave literal spaces because that
 518  * would be ambiguous if we split on that space.
 519  */
 520 static char *
 521 fill_spaces(const char *src)
 522 {
 523     const char *fill = "\\s";
 524     size_t need = strlen(src);
 525     size_t size = strlen(fill);
 526     char *result = 0;
 527     int pass;
 528     int s, d;
 529     for (pass = 0; pass < 2; ++pass) {
 530         for (s = d = 0; src[s] != '\0'; ++s) {
 531             if (src[s] == ' ') {
 532                 if (pass) {
 533                     _nc_STRCPY(&result[d], fill, need + 1 - d);
 534                     d += (int) size;
 535                 } else {
 536                     need += size;
 537                 }
 538             } else {
 539                 if (pass) {
 540                     result[d++] = src[s];
 541                 } else {
 542                     ++d;
 543                 }
 544             }
 545         }
 546         if (pass) {
 547             result[d] = '\0';
 548         } else {
 549             result = malloc(need + 1);
 550             if (result == 0)
 551                 failed("fill_spaces");
 552         }
 553     }
 554     return result;
 555 }
 556
 557 typedef enum {
 558     wOFF = 0
 559     ,w1ST = 1
 560     ,w2ND = 2
 561     ,wEND = 4
 562     ,wERR = 8
 563 } WRAPMODE;
 564
 565 #define wrap_1ST(mode) ((mode)&w1ST)
 566 #define wrap_END(mode) ((mode)&wEND)
 567 #define wrap_ERR(mode) ((mode)&wERR)
 568
 569 static void
 570 wrap_concat(const char *src, int need, unsigned mode)
 571 {
 572     int gaps = (int) strlen(separator);
 573     int want = gaps + need;
 574
 575     did_wrap = (width <= 0);
 576     if (wrap_1ST(mode)
 577         && column > indent
 578         && column + want > width) {
 579         force_wrap();
 580     }
 581     if ((wrap_END(mode) && !wrap_ERR(mode)) &&
 582         wrapped &&
 583         (width >= 0) &&
 584         (column + want) > width) {
 585         int step = 0;
 586         int used = width > WRAPPED ? width : WRAPPED;
 587         int size;
 588         int base = 0;
 589         char *p, align[9];
 590         const char *my_t = trailer;
 591         char *fill = fill_spaces(src);
 592         int last = (int) strlen(fill);
 593
 594         need = last;
 595
 596         if (TcOutput())
 597             trailer = "\\\n\t ";
 598
 599         if (!TcOutput() && (p = strchr(fill, '=')) != 0) {
 600             base = (int) (p + 1 - fill);
 601             if (base > 8)
 602                 base = 8;
 603             _nc_SPRINTF(align, _nc_SLIMIT(align) "%*s", base, " ");
 604         } else if (column > 8) {
 605             base = column - 8;
 606             if (base > 8)
 607                 base = 8;
 608             _nc_SPRINTF(align, _nc_SLIMIT(align) "%*s", base, " ");
 609         } else {
 610             align[base] = '\0';
 611         }
 612         /* "pretty" overrides wrapping if it already split the line */
 613         if (!pretty || strchr(fill, '\n') == 0) {
 614             int tag = 0;
 615
 616             if (TcOutput() && outbuf.used && !wrap_1ST(mode)) {
 617                 tag = 3;
 618             }
 619
 620             while ((column + (need + gaps)) > used) {
 621                 size = used - tag;
 622                 if (step) {
 623                     strcpy_DYN(&outbuf, align);
 624                     size -= base;
 625                 }
 626                 if (size > (last - step)) {
 627                     size = (last - step);
 628                 }
 629                 size = find_split(fill, step, size);
 630                 strncpy_DYN(&outbuf, fill + step, (size_t) size);
 631                 step += size;
 632                 need -= size;
 633                 if (need > 0) {
 634                     force_wrap();
 635                     did_wrap = TRUE;
 636                     tag = 0;
 637                 }
 638             }
 639         }
 640         if (need > 0) {
 641             if (step)
 642                 strcpy_DYN(&outbuf, align);
 643             strcpy_DYN(&outbuf, fill + step);
 644         }
 645         if (wrap_END(mode))
 646             strcpy_DYN(&outbuf, separator);
 647         trailer = my_t;
 648         force_wrap();
 649
 650         free(fill);
 651     } else {
 652         strcpy_DYN(&outbuf, src);
 653         if (wrap_END(mode))
 654             strcpy_DYN(&outbuf, separator);
 655         column += (int) strlen(src);
 656     }
 657 }
 658
 659 static void
 660 wrap_concat1(const char *src)
 661 {
 662     int need = (int) strlen(src);
 663     wrap_concat(src, need, w1ST | wEND);
 664 }
 665
 666 static void
 667 wrap_concat3(const char *name, const char *eqls, const char *value)
 668 {
 669     int nlen = (int) strlen(name);
 670     int elen = (int) strlen(eqls);
 671     int vlen = (int) strlen(value);
 672
 673     wrap_concat(name, nlen + elen + vlen, w1ST);
 674     wrap_concat(eqls, elen + vlen, w2ND);
 675     wrap_concat(value, vlen, wEND);
 676 }
 677
 678 #define IGNORE_SEP_TRAIL(first,last,sep_trail) \
 679         if ((size_t)(last - first) > sizeof(sep_trail)-1 \
 680          && !strncmp(first, sep_trail, sizeof(sep_trail)-1)) \
 681                 first += sizeof(sep_trail)-2
 682
 683 /* Returns the nominal length of the buffer assuming it is termcap format,
 684  * i.e., the continuation sequence is treated as a single character ":".
 685  *
 686  * There are several implementations of termcap which read the text into a
 687  * fixed-size buffer.  Generally they strip the newlines from the text, but may
 688  * not do it until after the buffer is read.  Also, "tc=" resolution may be
 689  * expanded in the same buffer.  This function is useful for measuring the size
 690  * of the best fixed-buffer implementation; the worst case may be much worse.
 691  */
 692 #ifdef TEST_TERMCAP_LENGTH
 693 static int
 694 termcap_length(const char *src)
 695 {
 696     static const char pattern[] = ":\\\n\t:";
 697
 698     int len = 0;
 699     const char *const t = src + strlen(src);
 700
 701     while (*src != '\0') {
 702         IGNORE_SEP_TRAIL(src, t, pattern);
 703         src++;
 704         len++;
 705     }
 706     return len;
 707 }
 708 #else
 709 #define termcap_length(src) strlen(src)
 710 #endif
 711
 712 static void
 713 indent_DYN(DYNBUF * buffer, int level)
 714 {
 715     int n;
 716
 717     for (n = 0; n < level; n++)
 718         strncpy_DYN(buffer, "\t", (size_t) 1);
 719 }
 720
 721 bool
 722 has_params(const char *src)
 723 {
 724     bool result = FALSE;
 725     int len = (int) strlen(src);
 726     int n;
 727     bool ifthen = FALSE;
 728     bool params = FALSE;
 729
 730     for (n = 0; n < len - 1; ++n) {
 731         if (!strncmp(src + n, "%p", (size_t) 2)) {
 732             params = TRUE;
 733         } else if (!strncmp(src + n, "%;", (size_t) 2)) {
 734             ifthen = TRUE;
 735             result = params;
 736             break;
 737         }
 738     }
 739     if (!ifthen) {
 740         result = ((len > 50) && params);
 741     }
 742     return result;
 743 }
 744
 745 static char *
 746 fmt_complex(TERMTYPE2 *tterm, const char *capability, char *src, int level)
 747 {
 748     bool percent = FALSE;
 749     bool params = has_params(src);
 750
 751     while (*src != '\0') {
 752         switch (*src) {
 753         case '^':
 754             percent = FALSE;
 755             strncpy_DYN(&tmpbuf, src++, (size_t) 1);
 756             break;
 757         case '\\':
 758             percent = FALSE;
 759             strncpy_DYN(&tmpbuf, src++, (size_t) 1);
 760             break;
 761         case '%':
 762             percent = TRUE;
 763             break;
 764         case '?':               /* "if" */
 765         case 't':               /* "then" */
 766         case 'e':               /* "else" */
 767             if (percent) {
 768                 percent = FALSE;
 769                 tmpbuf.text[tmpbuf.used - 1] = '\n';
 770                 /* treat a "%e" as else-if, on the same level */
 771                 if (*src == 'e') {
 772                     indent_DYN(&tmpbuf, level);
 773                     strncpy_DYN(&tmpbuf, "%", (size_t) 1);
 774                     strncpy_DYN(&tmpbuf, src, (size_t) 1);
 775                     src++;
 776                     params = has_params(src);
 777                     if (!params && *src != '\0' && *src != '%') {
 778                         strncpy_DYN(&tmpbuf, "\n", (size_t) 1);
 779                         indent_DYN(&tmpbuf, level + 1);
 780                     }
 781                 } else {
 782                     indent_DYN(&tmpbuf, level + 1);
 783                     strncpy_DYN(&tmpbuf, "%", (size_t) 1);
 784                     strncpy_DYN(&tmpbuf, src, (size_t) 1);
 785                     if (*src++ == '?') {
 786                         src = fmt_complex(tterm, capability, src, level + 1);
 787                         if (*src != '\0' && *src != '%') {
 788                             strncpy_DYN(&tmpbuf, "\n", (size_t) 1);
 789                             indent_DYN(&tmpbuf, level + 1);
 790                         }
 791                     } else if (level == 1) {
 792                         if (checking)
 793                             _nc_warning("%s: %%%c without %%? in %s",
 794                                         _nc_first_name(tterm->term_names),
 795                                         *src, capability);
 796                     }
 797                 }
 798                 continue;
 799             }
 800             break;
 801         case ';':               /* "endif" */
 802             if (percent) {
 803                 percent = FALSE;
 804                 if (level > 1) {
 805                     tmpbuf.text[tmpbuf.used - 1] = '\n';
 806                     indent_DYN(&tmpbuf, level);
 807                     strncpy_DYN(&tmpbuf, "%", (size_t) 1);
 808                     strncpy_DYN(&tmpbuf, src++, (size_t) 1);
 809                     if (src[0] == '%'
 810                         && src[1] != '\0'
 811                         && (strchr("?e;", src[1])) == 0) {
 812                         tmpbuf.text[tmpbuf.used++] = '\n';
 813                         indent_DYN(&tmpbuf, level);
 814                     }
 815                     return src;
 816                 }
 817                 if (checking)
 818                     _nc_warning("%s: %%; without %%? in %s",
 819                                 _nc_first_name(tterm->term_names),
 820                                 capability);
 821             }
 822             break;
 823         case 'p':
 824             if (percent && params) {
 825                 tmpbuf.text[tmpbuf.used - 1] = '\n';
 826                 indent_DYN(&tmpbuf, level + 1);
 827                 strncpy_DYN(&tmpbuf, "%", (size_t) 1);
 828             }
 829             params = FALSE;
 830             percent = FALSE;
 831             break;
 832         case ' ':
 833             strncpy_DYN(&tmpbuf, "\\s", (size_t) 2);
 834             ++src;
 835             continue;
 836         default:
 837             percent = FALSE;
 838             break;
 839         }
 840         strncpy_DYN(&tmpbuf, src++, (size_t) 1);
 841     }
 842     return src;
 843 }
 844
 845 /*
 846  * Make "large" numbers a little easier to read by showing them in hexadecimal
 847  * if they are "close" to a power of two.
 848  */
 849 static const char *
 850 number_format(int value)
 851 {
 852     const char *result = "%d";
 853     if ((outform != F_TERMCAP) && (value > 255)) {
 854         unsigned long lv = (unsigned long) value;
 855         unsigned long mm;
 856         int bits = sizeof(unsigned long) * 8;
 857         int nn;
 858         for (nn = 8; nn < bits; ++nn) {
 859             mm = 1UL << nn;
 860             if ((mm - 16) <= lv && (mm + 16) > lv) {
 861                 result = "%#x";
 862                 break;
 863             }
 864         }
 865     }
 866     return result;
 867 }
 868
 869 #define SAME_CAP(n,cap) (&tterm->Strings[n] == &cap)
 870 #define EXTRA_CAP 20
 871
 872 int
 873 fmt_entry(TERMTYPE2 *tterm,
 874           PredFunc pred,
 875           int content_only,
 876           int suppress_untranslatable,
 877           int infodump,
 878           int numbers)
 879 {
 880     PredIdx i, j;
 881     char buffer[MAX_TERMINFO_LENGTH + EXTRA_CAP];
 882     char *capability;
 883     NCURSES_CONST char *name;
 884     int predval, len;
 885     PredIdx num_bools = 0;
 886     PredIdx num_values = 0;
 887     PredIdx num_strings = 0;
 888     bool outcount = 0;
 889
 890 #define WRAP_CONCAT1(s)         wrap_concat1(s); outcount = TRUE
 891 #define WRAP_CONCAT             WRAP_CONCAT1(buffer)
 892
 893     len = 12;                   /* terminfo file-header */
 894
 895     if (pred == 0) {
 896         cur_type = tterm;
 897         pred = dump_predicate;
 898     }
 899
 900     strcpy_DYN(&outbuf, 0);
 901     if (content_only) {
 902         column = indent;        /* FIXME: workaround to prevent empty lines */
 903     } else {
 904         strcpy_DYN(&outbuf, tterm->term_names);
 905
 906         /*
 907          * Colon is legal in terminfo descriptions, but not in termcap.
 908          */
 909         if (!infodump) {
 910             char *p = outbuf.text;
 911             while (*p) {
 912                 if (*p == ':') {
 913                     *p = '=';
 914                 }
 915                 ++p;
 916             }
 917         }
 918         strcpy_DYN(&outbuf, separator);
 919         column = (int) outbuf.used;
 920         if (height > 1)
 921             force_wrap();
 922     }
 923
 924     for_each_boolean(j, tterm) {
 925         i = BoolIndirect(j);
 926         name = ExtBoolname(tterm, (int) i, bool_names);
 927         assert(strlen(name) < sizeof(buffer) - EXTRA_CAP);
 928
 929         if (!version_filter(BOOLEAN, i))
 930             continue;
 931         else if (isObsolete(outform, name))
 932             continue;
 933
 934         predval = pred(BOOLEAN, i);
 935         if (predval != FAIL) {
 936             _nc_STRCPY(buffer, name, sizeof(buffer));
 937             if (predval <= 0)
 938                 _nc_STRCAT(buffer, "@", sizeof(buffer));
 939             else if (i + 1 > num_bools)
 940                 num_bools = i + 1;
 941             WRAP_CONCAT;
 942         }
 943     }
 944
 945     if (column != indent && height > 1)
 946         force_wrap();
 947
 948     for_each_number(j, tterm) {
 949         i = NumIndirect(j);
 950         name = ExtNumname(tterm, (int) i, num_names);
 951         assert(strlen(name) < sizeof(buffer) - EXTRA_CAP);
 952
 953         if (!version_filter(NUMBER, i))
 954             continue;
 955         else if (isObsolete(outform, name))
 956             continue;
 957
 958         predval = pred(NUMBER, i);
 959         if (predval != FAIL) {
 960             if (tterm->Numbers[i] < 0) {
 961                 _nc_SPRINTF(buffer, _nc_SLIMIT(sizeof(buffer))
 962                             "%s@", name);
 963             } else {
 964                 size_t nn;
 965                 _nc_SPRINTF(buffer, _nc_SLIMIT(sizeof(buffer))
 966                             "%s#", name);
 967                 nn = strlen(buffer);
 968                 _nc_SPRINTF(buffer + nn, _nc_SLIMIT(sizeof(buffer) - nn)
 969                             number_format(tterm->Numbers[i]),
 970                             tterm->Numbers[i]);
 971                 if (i + 1 > num_values)
 972                     num_values = i + 1;
 973             }
 974             WRAP_CONCAT;
 975         }
 976     }
 977
 978     if (column != indent && height > 1)
 979         force_wrap();
 980
 981     len += (int) (num_bools
 982                   + num_values * 2
 983                   + strlen(tterm->term_names) + 1);
 984     if (len & 1)
 985         len++;
 986
 987 #undef CUR
 988 #define CUR tterm->
 989     if (outform == F_TERMCAP) {
 990         if (VALID_STRING(termcap_reset)) {
 991             if (VALID_STRING(init_3string)
 992                 && !strcmp(init_3string, termcap_reset))
 993                 DISCARD(init_3string);
 994
 995             if (VALID_STRING(reset_2string)
 996                 && !strcmp(reset_2string, termcap_reset))
 997                 DISCARD(reset_2string);
 998         }
 999     }
1000
1001     for_each_string(j, tterm) {
1002         i = StrIndirect(j);
1003         name = ExtStrname(tterm, (int) i, str_names);
1004         assert(strlen(name) < sizeof(buffer) - EXTRA_CAP);
1005
1006         capability = tterm->Strings[i];
1007
1008         if (!version_filter(STRING, i))
1009             continue;
1010         else if (isObsolete(outform, name))
1011             continue;
1012
1013 #if NCURSES_XNAMES
1014         /*
1015          * Extended names can be longer than 2 characters, but termcap programs
1016          * cannot read those (filter them out).
1017          */
1018         if (outform == F_TERMCAP && (strlen(name) > 2))
1019             continue;
1020 #endif
1021
1022         if (outform == F_TERMCAP) {
1023             /*
1024              * Some older versions of vi want rmir/smir to be defined
1025              * for ich/ich1 to work.  If they're not defined, force
1026              * them to be output as defined and empty.
1027              */
1028             if (PRESENT(insert_character) || PRESENT(parm_ich)) {
1029                 if (SAME_CAP(i, enter_insert_mode)
1030                     && enter_insert_mode == ABSENT_STRING) {
1031                     _nc_STRCPY(buffer, "im=", sizeof(buffer));
1032                     WRAP_CONCAT;
1033                     continue;
1034                 }
1035
1036                 if (SAME_CAP(i, exit_insert_mode)
1037                     && exit_insert_mode == ABSENT_STRING) {
1038                     _nc_STRCPY(buffer, "ei=", sizeof(buffer));
1039                     WRAP_CONCAT;
1040                     continue;
1041                 }
1042             }
1043             /*
1044              * termcap applications such as screen will be confused if sgr0
1045              * is translated to a string containing rmacs.  Filter that out.
1046              */
1047             if (PRESENT(exit_attribute_mode)) {
1048                 if (SAME_CAP(i, exit_attribute_mode)) {
1049                     char *trimmed_sgr0;
1050                     char *my_sgr = set_attributes;
1051
1052                     set_attributes = save_sgr;
1053
1054                     trimmed_sgr0 = _nc_trim_sgr0(tterm);
1055                     if (strcmp(capability, trimmed_sgr0)) {
1056                         capability = trimmed_sgr0;
1057                     } else {
1058                         if (trimmed_sgr0 != exit_attribute_mode)
1059                             free(trimmed_sgr0);
1060                     }
1061
1062                     set_attributes = my_sgr;
1063                 }
1064             }
1065         }
1066
1067         predval = pred(STRING, i);
1068         buffer[0] = '\0';
1069
1070         if (predval != FAIL) {
1071             if (VALID_STRING(capability)
1072                 && i + 1 > num_strings)
1073                 num_strings = i + 1;
1074
1075             if (!VALID_STRING(capability)) {
1076                 _nc_SPRINTF(buffer, _nc_SLIMIT(sizeof(buffer))
1077                             "%s@", name);
1078                 WRAP_CONCAT;
1079             } else if (TcOutput()) {
1080                 char *srccap = _nc_tic_expand(capability, TRUE, numbers);
1081                 int params = ((i < (int) SIZEOF(parametrized))
1082                               ? parametrized[i]
1083                               : ((*srccap == 'k')
1084                                  ? 0
1085                                  : has_params(srccap)));
1086                 char *cv = _nc_infotocap(name, srccap, params);
1087
1088                 if (cv == 0) {
1089                     if (outform == F_TCONVERR) {
1090                         _nc_SPRINTF(buffer, _nc_SLIMIT(sizeof(buffer))
1091                                     "%s=!!! %s WILL NOT CONVERT !!!",
1092                                     name, srccap);
1093                         WRAP_CONCAT;
1094                     } else if (suppress_untranslatable) {
1095                         continue;
1096                     } else {
1097                         char *s = srccap, *d = buffer;
1098                         int need = 3 + (int) strlen(name);
1099                         while ((*d = *s++) != 0) {
1100                             if ((d - buffer + 1) >= (int) sizeof(buffer)) {
1101                                 fprintf(stderr,
1102                                         "%s: value for %s is too long\n",
1103                                         _nc_progname,
1104                                         name);
1105                                 *d = '\0';
1106                                 break;
1107                             }
1108                             if (*d == ':') {
1109                                 *d++ = '\\';
1110                                 *d = ':';
1111                             } else if (*d == '\\') {
1112                                 *++d = *s++;
1113                             }
1114                             d++;
1115                             *d = '\0';
1116                         }
1117                         need += (int) (d - buffer);
1118                         wrap_concat("..", need, w1ST | wERR);
1119                         need -= 2;
1120                         wrap_concat(name, need, wOFF | wERR);
1121                         need -= (int) strlen(name);
1122                         wrap_concat("=", need, w2ND | wERR);
1123                         need -= 1;
1124                         wrap_concat(buffer, need, wEND | wERR);
1125                         outcount = TRUE;
1126                     }
1127                 } else {
1128                     wrap_concat3(name, "=", cv);
1129                 }
1130                 len += (int) strlen(capability) + 1;
1131             } else {
1132                 char *src = _nc_tic_expand(capability,
1133                                            outform == F_TERMINFO, numbers);
1134
1135                 strcpy_DYN(&tmpbuf, 0);
1136                 strcpy_DYN(&tmpbuf, name);
1137                 strcpy_DYN(&tmpbuf, "=");
1138                 if (pretty
1139                     && (outform == F_TERMINFO
1140                         || outform == F_VARIABLE)) {
1141                     fmt_complex(tterm, name, src, 1);
1142                 } else {
1143                     strcpy_DYN(&tmpbuf, src);
1144                 }
1145                 len += (int) strlen(capability) + 1;
1146                 WRAP_CONCAT1(tmpbuf.text);
1147             }
1148         }
1149         /* e.g., trimmed_sgr0 */
1150         if (VALID_STRING(capability) &&
1151             capability != tterm->Strings[i])
1152             free(capability);
1153     }
1154     len += (int) (num_strings * 2);
1155
1156     /*
1157      * This piece of code should be an effective inverse of the functions
1158      * postprocess_terminfo() and postprocess_terminfo() in parse_entry.c.
1159      * Much more work should be done on this to support dumping termcaps.
1160      */
1161     if (tversion == V_HPUX) {
1162         if (VALID_STRING(memory_lock)) {
1163             _nc_SPRINTF(buffer, _nc_SLIMIT(sizeof(buffer))
1164                         "meml=%s", memory_lock);
1165             WRAP_CONCAT;
1166         }
1167         if (VALID_STRING(memory_unlock)) {
1168             _nc_SPRINTF(buffer, _nc_SLIMIT(sizeof(buffer))
1169                         "memu=%s", memory_unlock);
1170             WRAP_CONCAT;
1171         }
1172     } else if (tversion == V_AIX) {
1173         if (VALID_STRING(acs_chars)) {
1174             bool box_ok = TRUE;
1175             const char *acstrans = "lqkxjmwuvtn";
1176             const char *cp;
1177             char *tp, *sp, boxchars[11];
1178
1179             tp = boxchars;
1180             for (cp = acstrans; *cp; cp++) {
1181                 sp = (strchr) (acs_chars, *cp);
1182                 if (sp)
1183                     *tp++ = sp[1];
1184                 else {
1185                     box_ok = FALSE;
1186                     break;
1187                 }
1188             }
1189             tp[0] = '\0';
1190
1191             if (box_ok) {
1192                 char *tmp = _nc_tic_expand(boxchars,
1193                                            (outform == F_TERMINFO),
1194                                            numbers);
1195                 _nc_STRCPY(buffer, "box1=", sizeof(buffer));
1196                 while (*tmp != '\0') {
1197                     size_t have = strlen(buffer);
1198                     size_t next = strlen(tmp);
1199                     size_t want = have + next + 1;
1200                     size_t last = next;
1201                     char save = '\0';
1202
1203                     /*
1204                      * If the expanded string is too long for the buffer,
1205                      * chop it off and save the location where we chopped it.
1206                      */
1207                     if (want >= sizeof(buffer)) {
1208                         save = tmp[last];
1209                         tmp[last] = '\0';
1210                     }
1211                     _nc_STRCAT(buffer, tmp, sizeof(buffer));
1212
1213                     /*
1214                      * If we chopped the buffer, replace the missing piece and
1215                      * shift everything to append the remainder.
1216                      */
1217                     if (save != '\0') {
1218                         next = 0;
1219                         tmp[last] = save;
1220                         while ((tmp[next] = tmp[last + next]) != '\0') {
1221                             ++next;
1222                         }
1223                     } else {
1224                         break;
1225                     }
1226                 }
1227                 WRAP_CONCAT;
1228             }
1229         }
1230     }
1231
1232     /*
1233      * kludge: trim off trailer to avoid an extra blank line
1234      * in infocmp -u output when there are no string differences
1235      */
1236     if (outcount) {
1237         bool trimmed = FALSE;
1238         j = (PredIdx) outbuf.used;
1239         if (wrapped && did_wrap) {
1240             /* EMPTY */ ;
1241         } else if (j >= 2
1242                    && outbuf.text[j - 1] == '\t'
1243                    && outbuf.text[j - 2] == '\n') {
1244             outbuf.used -= 2;
1245             trimmed = TRUE;
1246         } else if (j >= 4
1247                    && outbuf.text[j - 1] == ':'
1248                    && outbuf.text[j - 2] == '\t'
1249                    && outbuf.text[j - 3] == '\n'
1250                    && outbuf.text[j - 4] == '\\') {
1251             outbuf.used -= 4;
1252             trimmed = TRUE;
1253         }
1254         if (trimmed) {
1255             outbuf.text[outbuf.used] = '\0';
1256             column = oldcol;
1257             strcpy_DYN(&outbuf, " ");
1258         }
1259     }
1260 #if 0
1261     fprintf(stderr, "num_bools = %d\n", num_bools);
1262     fprintf(stderr, "num_values = %d\n", num_values);
1263     fprintf(stderr, "num_strings = %d\n", num_strings);
1264     fprintf(stderr, "term_names=%s, len=%d, strlen(outbuf)=%d, outbuf=%s\n",
1265             tterm->term_names, len, outbuf.used, outbuf.text);
1266 #endif
1267     /*
1268      * Here's where we use infodump to trigger a more stringent length check
1269      * for termcap-translation purposes.
1270      * Return the length of the raw entry, without tc= expansions,
1271      * It gives an idea of which entries are deadly to even *scan past*,
1272      * as opposed to *use*.
1273      */
1274     return (infodump ? len : (int) termcap_length(outbuf.text));
1275 }
1276
1277 static bool
1278 kill_string(TERMTYPE2 *tterm, char *cap)
1279 {
1280     unsigned n;
1281     for (n = 0; n < NUM_STRINGS(tterm); ++n) {
1282         if (cap == tterm->Strings[n]) {
1283             tterm->Strings[n] = ABSENT_STRING;
1284             return TRUE;
1285         }
1286     }
1287     return FALSE;
1288 }
1289
1290 static char *
1291 find_string(TERMTYPE2 *tterm, char *name)
1292 {
1293     PredIdx n;
1294     for (n = 0; n < NUM_STRINGS(tterm); ++n) {
1295         if (version_filter(STRING, n)
1296             && !strcmp(name, strnames[n])) {
1297             char *cap = tterm->Strings[n];
1298             if (VALID_STRING(cap)) {
1299                 return cap;
1300             }
1301             break;
1302         }
1303     }
1304     return ABSENT_STRING;
1305 }
1306
1307 /*
1308  * This is used to remove function-key labels from a termcap entry to
1309  * make it smaller.
1310  */
1311 static int
1312 kill_labels(TERMTYPE2 *tterm, int target)
1313 {
1314     int n;
1315     int result = 0;
1316     char *cap;
1317     char name[10];
1318
1319     for (n = 0; n <= 10; ++n) {
1320         _nc_SPRINTF(name, _nc_SLIMIT(sizeof(name)) "lf%d", n);
1321         cap = find_string(tterm, name);
1322         if (VALID_STRING(cap)
1323             && kill_string(tterm, cap)) {
1324             target -= (int) (strlen(cap) + 5);
1325             ++result;
1326             if (target < 0)
1327                 break;
1328         }
1329     }
1330     return result;
1331 }
1332
1333 /*
1334  * This is used to remove function-key definitions from a termcap entry to
1335  * make it smaller.
1336  */
1337 static int
1338 kill_fkeys(TERMTYPE2 *tterm, int target)
1339 {
1340     int n;
1341     int result = 0;
1342     char *cap;
1343     char name[10];
1344
1345     for (n = 60; n >= 0; --n) {
1346         _nc_SPRINTF(name, _nc_SLIMIT(sizeof(name)) "kf%d", n);
1347         cap = find_string(tterm, name);
1348         if (VALID_STRING(cap)
1349             && kill_string(tterm, cap)) {
1350             target -= (int) (strlen(cap) + 5);
1351             ++result;
1352             if (target < 0)
1353                 break;
1354         }
1355     }
1356     return result;
1357 }
1358
1359 /*
1360  * Check if the given acsc string is a 1-1 mapping, i.e., just-like-vt100.
1361  * Also, since this is for termcap, we only care about the line-drawing map.
1362  */
1363 #define isLine(c) (strchr("lmkjtuvwqxn", c) != 0)
1364
1365 static bool
1366 one_one_mapping(const char *mapping)
1367 {
1368     bool result = TRUE;
1369
1370     if (VALID_STRING(mapping)) {
1371         int n = 0;
1372         while (mapping[n] != '\0') {
1373             if (isLine(mapping[n]) &&
1374                 mapping[n] != mapping[n + 1]) {
1375                 result = FALSE;
1376                 break;
1377             }
1378             n += 2;
1379         }
1380     }
1381     return result;
1382 }
1383
1384 #define FMT_ENTRY() \
1385                 fmt_entry(tterm, pred, \
1386                         0, \
1387                         suppress_untranslatable, \
1388                         infodump, numbers)
1389
1390 #define SHOW_WHY PRINTF
1391
1392 static bool
1393 purged_acs(TERMTYPE2 *tterm)
1394 {
1395     bool result = FALSE;
1396
1397     if (VALID_STRING(acs_chars)) {
1398         if (!one_one_mapping(acs_chars)) {
1399             enter_alt_charset_mode = ABSENT_STRING;
1400             exit_alt_charset_mode = ABSENT_STRING;
1401             SHOW_WHY("# (rmacs/smacs removed for consistency)\n");
1402         }
1403         result = TRUE;
1404     }
1405     return result;
1406 }
1407
1408 static void
1409 encode_b64(char *target, char *source, unsigned state, int *saved)
1410 {
1411     /* RFC-4648 */
1412     static const char data[] =
1413     "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
1414     "abcdefghijklmnopqrstuvwxyz"
1415     "0123456789" "-_";
1416     int ch = UChar(source[state]);
1417
1418     switch (state % 3) {
1419     case 0:
1420         *target++ = data[(ch >> 2) & 077];
1421         *saved = (ch << 4);
1422         break;
1423     case 1:
1424         *target++ = data[((ch >> 4) | *saved) & 077];
1425         *saved = (ch << 2);
1426         break;
1427     case 2:
1428         *target++ = data[((ch >> 6) | *saved) & 077];
1429         *target++ = data[ch & 077];
1430         *saved = 0;
1431         break;
1432     }
1433     *target = '\0';
1434 }
1435
1436 /*
1437  * Dump a single entry.
1438  */
1439 void
1440 dump_entry(TERMTYPE2 *tterm,
1441            int suppress_untranslatable,
1442            int limited,
1443            int numbers,
1444            PredFunc pred)
1445 {
1446     TERMTYPE2 save_tterm;
1447     int len, critlen;
1448     const char *legend;
1449     bool infodump;
1450
1451     if (quickdump) {
1452         char bigbuf[65536];
1453         unsigned n;
1454         unsigned offset = 0;
1455         separator = "";
1456         trailer = "\n";
1457         indent = 0;
1458         if (_nc_write_object(tterm, bigbuf, &offset, sizeof(bigbuf)) == OK) {
1459             char numbuf[80];
1460             if (quickdump & 1) {
1461                 if (outbuf.used)
1462                     wrap_concat1("\n");
1463                 wrap_concat1("hex:");
1464                 for (n = 0; n < offset; ++n) {
1465                     _nc_SPRINTF(numbuf, _nc_SLIMIT(sizeof(numbuf))
1466                                 "%02X", UChar(bigbuf[n]));
1467                     wrap_concat1(numbuf);
1468                 }
1469             }
1470             if (quickdump & 2) {
1471                 static char padding[] =
1472                 {0, 0};
1473                 int value = 0;
1474                 if (outbuf.used)
1475                     wrap_concat1("\n");
1476                 wrap_concat1("b64:");
1477                 for (n = 0; n < offset; ++n) {
1478                     encode_b64(numbuf, bigbuf, n, &value);
1479                     wrap_concat1(numbuf);
1480                 }
1481                 switch (n % 3) {
1482                 case 0:
1483                     break;
1484                 case 1:
1485                     encode_b64(numbuf, padding, 1, &value);
1486                     wrap_concat1(numbuf);
1487                     wrap_concat1("==");
1488                     break;
1489                 case 2:
1490                     encode_b64(numbuf, padding, 1, &value);
1491                     wrap_concat1(numbuf);
1492                     wrap_concat1("=");
1493                     break;
1494                 }
1495             }
1496         }
1497         return;
1498     }
1499
1500     if (TcOutput()) {
1501         critlen = MAX_TERMCAP_LENGTH;
1502         legend = "older termcap";
1503         infodump = FALSE;
1504         set_obsolete_termcaps(tterm);
1505     } else {
1506         critlen = MAX_TERMINFO_LENGTH;
1507         legend = "terminfo";
1508         infodump = TRUE;
1509     }
1510
1511     save_sgr = set_attributes;
1512
1513     if ((FMT_ENTRY() > critlen)
1514         && limited) {
1515
1516         save_tterm = *tterm;
1517         if (!suppress_untranslatable) {
1518             SHOW_WHY("# (untranslatable capabilities removed to fit entry within %d bytes)\n",
1519                      critlen);
1520             suppress_untranslatable = TRUE;
1521         }
1522         if (FMT_ENTRY() > critlen) {
1523             /*
1524              * We pick on sgr because it's a nice long string capability that
1525              * is really just an optimization hack.  Another good candidate is
1526              * acsc since it is both long and unused by BSD termcap.
1527              */
1528             bool changed = FALSE;
1529
1530 #if NCURSES_XNAMES
1531             /*
1532              * Extended names are most likely function-key definitions.  Drop
1533              * those first.
1534              */
1535             unsigned n;
1536             for (n = STRCOUNT; n < NUM_STRINGS(tterm); n++) {
1537                 const char *name = ExtStrname(tterm, (int) n, strnames);
1538
1539                 if (VALID_STRING(tterm->Strings[n])) {
1540                     set_attributes = ABSENT_STRING;
1541                     /* we remove long names anyway - only report the short */
1542                     if (strlen(name) <= 2) {
1543                         SHOW_WHY("# (%s removed to fit entry within %d bytes)\n",
1544                                  name,
1545                                  critlen);
1546                     }
1547                     changed = TRUE;
1548                     if (FMT_ENTRY() <= critlen)
1549                         break;
1550                 }
1551             }
1552 #endif
1553             if (VALID_STRING(set_attributes)) {
1554                 set_attributes = ABSENT_STRING;
1555                 SHOW_WHY("# (sgr removed to fit entry within %d bytes)\n",
1556                          critlen);
1557                 changed = TRUE;
1558             }
1559             if (!changed || (FMT_ENTRY() > critlen)) {
1560                 if (purged_acs(tterm)) {
1561                     acs_chars = ABSENT_STRING;
1562                     SHOW_WHY("# (acsc removed to fit entry within %d bytes)\n",
1563                              critlen);
1564                     changed = TRUE;
1565                 }
1566             }
1567             if (!changed || (FMT_ENTRY() > critlen)) {
1568                 int oldversion = tversion;
1569
1570                 tversion = V_BSD;
1571                 SHOW_WHY("# (terminfo-only capabilities suppressed to fit entry within %d bytes)\n",
1572                          critlen);
1573
1574                 len = FMT_ENTRY();
1575                 if (len > critlen
1576                     && kill_labels(tterm, len - critlen)) {
1577                     SHOW_WHY("# (some labels capabilities suppressed to fit entry within %d bytes)\n",
1578                              critlen);
1579                     len = FMT_ENTRY();
1580                 }
1581                 if (len > critlen
1582                     && kill_fkeys(tterm, len - critlen)) {
1583                     SHOW_WHY("# (some function-key capabilities suppressed to fit entry within %d bytes)\n",
1584                              critlen);
1585                     len = FMT_ENTRY();
1586                 }
1587                 if (len > critlen) {
1588                     (void) fprintf(stderr,
1589                                    "%s: %s entry is %d bytes long\n",
1590                                    _nc_progname,
1591                                    _nc_first_name(tterm->term_names),
1592                                    len);
1593                     SHOW_WHY("# WARNING: this entry, %d bytes long, may core-dump %s libraries!\n",
1594                              len, legend);
1595                 }
1596                 tversion = oldversion;
1597             }
1598             set_attributes = save_sgr;
1599             *tterm = save_tterm;
1600         }
1601     } else if (!version_filter(STRING, STR_IDX(acs_chars))) {
1602         save_tterm = *tterm;
1603         if (purged_acs(tterm)) {
1604             (void) FMT_ENTRY();
1605         }
1606         *tterm = save_tterm;
1607     }
1608 }
1609
1610 void
1611 dump_uses(const char *name, bool infodump)
1612 /* dump "use=" clauses in the appropriate format */
1613 {
1614     char buffer[MAX_TERMINFO_LENGTH];
1615
1616     if (TcOutput())
1617         trim_trailing();
1618     _nc_SPRINTF(buffer, _nc_SLIMIT(sizeof(buffer))
1619                 "%s%s", infodump ? "use=" : "tc=", name);
1620     wrap_concat1(buffer);
1621 }
1622
1623 int
1624 show_entry(void)
1625 {
1626     /*
1627      * Trim any remaining whitespace.
1628      */
1629     if (outbuf.used != 0) {
1630         bool infodump = !TcOutput();
1631         char delim = (char) (infodump ? ',' : ':');
1632         int j;
1633
1634         for (j = (int) outbuf.used - 1; j > 0; --j) {
1635             char ch = outbuf.text[j];
1636             if (ch == '\n') {
1637                 ;
1638             } else if (isspace(UChar(ch))) {
1639                 outbuf.used = (size_t) j;
1640             } else if (!infodump && ch == '\\') {
1641                 outbuf.used = (size_t) j;
1642             } else if (ch == delim && (j == 0 || outbuf.text[j - 1] != '\\')) {
1643                 outbuf.used = (size_t) (j + 1);
1644             } else {
1645                 break;
1646             }
1647         }
1648         outbuf.text[outbuf.used] = '\0';
1649     }
1650     if (outbuf.text != 0) {
1651         (void) fputs(outbuf.text, stdout);
1652         putchar('\n');
1653     }
1654     return (int) outbuf.used;
1655 }
1656
1657 void
1658 compare_entry(PredHook hook,
1659               TERMTYPE2 *tp GCC_UNUSED,
1660               bool quiet)
1661 /* compare two entries */
1662 {
1663     PredIdx i, j;
1664     NCURSES_CONST char *name;
1665
1666     if (!quiet)
1667         fputs("    comparing booleans.\n", stdout);
1668     for_each_boolean(j, tp) {
1669         i = BoolIndirect(j);
1670         name = ExtBoolname(tp, (int) i, bool_names);
1671
1672         if (isObsolete(outform, name))
1673             continue;
1674
1675         (*hook) (CMP_BOOLEAN, i, name);
1676     }
1677
1678     if (!quiet)
1679         fputs("    comparing numbers.\n", stdout);
1680     for_each_number(j, tp) {
1681         i = NumIndirect(j);
1682         name = ExtNumname(tp, (int) i, num_names);
1683
1684         if (isObsolete(outform, name))
1685             continue;
1686
1687         (*hook) (CMP_NUMBER, i, name);
1688     }
1689
1690     if (!quiet)
1691         fputs("    comparing strings.\n", stdout);
1692     for_each_string(j, tp) {
1693         i = StrIndirect(j);
1694         name = ExtStrname(tp, (int) i, str_names);
1695
1696         if (isObsolete(outform, name))
1697             continue;
1698
1699         (*hook) (CMP_STRING, i, name);
1700     }
1701
1702     /* (void) fputs("    comparing use entries.\n", stdout); */
1703     (*hook) (CMP_USE, 0, "use");
1704
1705 }
1706
1707 #define NOTSET(s)       ((s) == 0)
1708
1709 /*
1710  * This bit of legerdemain turns all the terminfo variable names into
1711  * references to locations in the arrays Booleans, Numbers, and Strings ---
1712  * precisely what's needed.
1713  */
1714 #undef CUR
1715 #define CUR tp->
1716
1717 static void
1718 set_obsolete_termcaps(TERMTYPE2 *tp)
1719 {
1720 #include "capdefaults.c"
1721 }
1722
1723 /*
1724  * Convert an alternate-character-set string to canonical form: sorted and
1725  * unique.
1726  */
1727 void
1728 repair_acsc(TERMTYPE2 *tp)
1729 {
1730     if (VALID_STRING(acs_chars)) {
1731         size_t n, m;
1732         char mapped[256];
1733         char extra = 0;
1734         unsigned source;
1735         unsigned target;
1736         bool fix_needed = FALSE;
1737
1738         for (n = 0, source = 0; acs_chars[n] != 0; n++) {
1739             target = UChar(acs_chars[n]);
1740             if (source >= target) {
1741                 fix_needed = TRUE;
1742                 break;
1743             }
1744             source = target;
1745             if (acs_chars[n + 1])
1746                 n++;
1747         }
1748         if (fix_needed) {
1749             memset(mapped, 0, sizeof(mapped));
1750             for (n = 0; acs_chars[n] != 0; n++) {
1751                 source = UChar(acs_chars[n]);
1752                 if ((target = (unsigned char) acs_chars[n + 1]) != 0) {
1753                     mapped[source] = (char) target;
1754                     n++;
1755                 } else {
1756                     extra = (char) source;
1757                 }
1758             }
1759             for (n = m = 0; n < sizeof(mapped); n++) {
1760                 if (mapped[n]) {
1761                     acs_chars[m++] = (char) n;
1762                     acs_chars[m++] = mapped[n];
1763                 }
1764             }
1765             if (extra)
1766                 acs_chars[m++] = extra;         /* garbage in, garbage out */
1767             acs_chars[m] = 0;
1768         }
1769     }
1770 }