include/tic.h

   1 /****************************************************************************
   2  * Copyright 2018-2022,2023 Thomas E. Dickey                                *
   3  * Copyright 1998-2012,2017 Free Software Foundation, Inc.                  *
   4  *                                                                          *
   5  * Permission is hereby granted, free of charge, to any person obtaining a  *
   6  * copy of this software and associated documentation files (the            *
   7  * "Software"), to deal in the Software without restriction, including      *
   8  * without limitation the rights to use, copy, modify, merge, publish,      *
   9  * distribute, distribute with modifications, sublicense, and/or sell       *
  10  * copies of the Software, and to permit persons to whom the Software is    *
  11  * furnished to do so, subject to the following conditions:                 *
  12  *                                                                          *
  13  * The above copyright notice and this permission notice shall be included  *
  14  * in all copies or substantial portions of the Software.                   *
  15  *                                                                          *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23  *                                                                          *
  24  * Except as contained in this notice, the name(s) of the above copyright   *
  25  * holders shall not be used in advertising or otherwise to promote the     *
  26  * sale, use or other dealings in this Software without prior written       *
  27  * authorization.                                                           *
  28  ****************************************************************************/
  29
  30 /****************************************************************************
  31  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
  32  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
  33  *     and: Thomas E. Dickey 1996 on                                        *
  34  ****************************************************************************/
  35
  36 /*
  37  * $Id: tic.h,v 1.87 2023/04/22 13:37:21 tom Exp $
  38  *      tic.h - Global variables and structures for the terminfo compiler.
  39  */
  40
  41 #ifndef __TIC_H
  42 #define __TIC_H
  43 /* *INDENT-OFF* */
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 #include <ncurses_cfg.h>
  49
  50 #include <curses.h>     /* for the _tracef() prototype, ERR/OK, bool defs */
  51
  52 /*
  53 ** The format of SVr2 compiled terminfo files is as follows:
  54 **
  55 **              Header (12 bytes), containing information given below
  56 **              Names Section, containing the names of the terminal
  57 **              Boolean Section, containing the values of all of the
  58 **                              boolean capabilities
  59 **                              A null byte may be inserted here to make
  60 **                              sure that the Number Section begins on an
  61 **                              even word boundary.
  62 **              Number Section, containing the values of all of the numeric
  63 **                              capabilities, each as a short integer
  64 **              String Section, containing short integer offsets into the
  65 **                              String Table, one per string capability
  66 **              String Table, containing the actual characters of the string
  67 **                              capabilities.
  68 **
  69 ** In the SVr2 format, "short" means signed 16-bit numbers, which is sometimes
  70 ** inconvenient.  The numbers are signed, to provide for absent and canceled
  71 ** values.  ncurses6.1 introduced an extension to this compiled format, by
  72 ** making the Number Section a list of signed 32-bit integers.
  73 **
  74 **      NOTE that all short integers in the file are stored using VAX/PDP-style
  75 **      byte-order, i.e., least-significant byte first.
  76 **
  77 **      There is no structure definition here because it would only confuse
  78 **      matters.  Terminfo format is a raw byte layout, not a structure
  79 **      dump.  If you happen to be on a little-endian machine with 16-bit
  80 **      shorts that requires no padding between short members in a struct,
  81 **      then there is a natural C structure that captures the header, but
  82 **      not very helpfully.
  83 */
  84
  85 #define MAGIC           0432    /* first two bytes of a compiled entry */
  86 #define MAGIC2          01036   /* first two bytes of a compiled 32-bit entry */
  87
  88 #undef  BYTE
  89 #define BYTE(p,n)       (unsigned char)((p)[n])
  90
  91 #define IS_NEG1(p)      ((BYTE(p,0) == 0377) && (BYTE(p,1) == 0377))
  92 #define IS_NEG2(p)      ((BYTE(p,0) == 0376) && (BYTE(p,1) == 0377))
  93 #define LOW_MSB(p)      (BYTE(p,0) + 256*BYTE(p,1))
  94
  95 #define IS_TIC_MAGIC(p) (LOW_MSB(p) == MAGIC || LOW_MSB(p) == MAGIC2)
  96
  97 #define quick_prefix(s) (!strncmp((s), "b64:", (size_t)4) || !strncmp((s), "hex:", (size_t)4))
  98
  99 /*
 100  * The "maximum" here is misleading; XSI guarantees minimum values, which a
 101  * given implementation may exceed.
 102  */
 103 #define MAX_NAME_SIZE   512     /* maximum legal name field size (XSI:127) */
 104 #define MAX_ENTRY_SIZE1 4096    /* maximum legal entry size (SVr2) */
 105 #define MAX_ENTRY_SIZE2 32768   /* maximum legal entry size (ncurses6.1) */
 106
 107 #if NCURSES_EXT_COLORS && HAVE_INIT_EXTENDED_COLOR
 108 #define MAX_ENTRY_SIZE MAX_ENTRY_SIZE2
 109 #else
 110 #define MAX_ENTRY_SIZE MAX_ENTRY_SIZE1
 111 #endif
 112
 113 /*
 114  * The maximum size of individual name or alias is guaranteed in XSI to be at
 115  * least 14, since that corresponds to the older filename lengths.  Newer
 116  * systems allow longer aliases, though not many terminal descriptions are
 117  * written to use them.  The MAX_ALIAS symbol is used for warnings.
 118  */
 119 #if HAVE_LONG_FILE_NAMES
 120 #define MAX_ALIAS       32      /* smaller than POSIX minimum for PATH_MAX */
 121 #else
 122 #define MAX_ALIAS       14      /* SVr3 filename length */
 123 #endif
 124
 125 /* location of user's personal info directory */
 126 #define PRIVATE_INFO    "%s/.terminfo"  /* plug getenv("HOME") into %s */
 127
 128 /*
 129  * Some traces are designed to be used via tic's verbose option (and similar in
 130  * infocmp and toe) rather than the 'trace()' function.  So we use the bits
 131  * above the normal trace() parameter as a debug-level.
 132  */
 133
 134 #define MAX_DEBUG_LEVEL 15
 135 #define DEBUG_LEVEL(n)  ((n) << TRACE_SHIFT)
 136
 137 #define set_trace_level(n) \
 138         _nc_tracing &= TRACE_MAXIMUM, \
 139         _nc_tracing |= DEBUG_LEVEL(n)
 140
 141 #ifdef TRACE
 142 #define DEBUG(n, a)     if (_nc_tracing >= DEBUG_LEVEL(n)) _tracef a
 143 #else
 144 #define DEBUG(n, a)     /*nothing*/
 145 #endif
 146
 147 /*
 148  * These are the types of tokens returned by the scanner.  The first
 149  * three are also used in the hash table of capability names.  The scanner
 150  * returns one of these values after loading the specifics into the global
 151  * structure curr_token.
 152  */
 153
 154 #define BOOLEAN 0               /* Boolean capability */
 155 #define NUMBER 1                /* Numeric capability */
 156 #define STRING 2                /* String-valued capability */
 157 #define CANCEL 3                /* Capability to be cancelled in following tc's */
 158 #define NAMES  4                /* The names for a terminal type */
 159 #define UNDEF  5                /* Undefined */
 160
 161 #define NO_PUSHBACK     -1      /* used in pushtype to indicate no pushback */
 162
 163 /*
 164  * The global structure in which the specific parts of a
 165  * scanned token are returned.
 166  */
 167
 168 struct token
 169 {
 170         char    *tk_name;       /* name of capability */
 171         int     tk_valnumber;   /* value of capability (if a number) */
 172         char    *tk_valstring;  /* value of capability (if a string) */
 173 };
 174
 175 /*
 176  * Offsets to string capabilities, with the corresponding functionkey codes.
 177  */
 178 struct tinfo_fkeys {
 179         unsigned offset;
 180         chtype code;
 181         };
 182
 183 typedef short HashValue;
 184
 185 /*
 186  * The file comp_captab.c contains an array of these structures, one per
 187  * possible capability.  These are indexed by a hash table array of pointers to
 188  * the same structures for use by the parser.
 189  */
 190 struct name_table_entry
 191 {
 192         const char *nte_name;   /* name to hash on */
 193         int     nte_type;       /* BOOLEAN, NUMBER or STRING */
 194         HashValue nte_index;    /* index of associated variable in its array */
 195         HashValue nte_link;     /* index in table of next hash, or -1 */
 196 };
 197
 198 /*
 199  * Use this structure to hide differences between terminfo and termcap tables.
 200  */
 201 typedef struct {
 202         unsigned table_size;
 203         const HashValue *table_data;
 204         HashValue (*hash_of)(const char *);
 205         int (*compare_names)(const char *, const char *);
 206 } HashData;
 207
 208 struct alias
 209 {
 210         const char      *from;
 211         const char      *to;
 212         const char      *source;
 213 };
 214
 215 #define NOTFOUND        ((struct name_table_entry *) 0)
 216
 217 /*
 218  * The file comp_userdefs.c contains an array of these structures, one per
 219  * possible capability.  These are indexed by a hash table array of pointers to
 220  * the same structures for use by the parser.
 221  */
 222 struct user_table_entry
 223 {
 224         const char *ute_name;   /* name to hash on */
 225         int     ute_type;       /* mask (BOOLEAN, NUMBER, STRING) */
 226         unsigned ute_argc;      /* number of parameters */
 227         unsigned ute_args;      /* bit-mask for string parameters */
 228         HashValue ute_index;    /* index of associated variable in its array */
 229         HashValue ute_link;     /* index in table of next hash, or -1 */
 230 };
 231
 232 /*
 233  * The casts are required for correct sign-propagation with systems such as
 234  * AIX, IRIX64, Solaris which default to unsigned characters.  The C standard
 235  * leaves this detail unspecified.
 236  */
 237
 238 /* out-of-band values for representing absent capabilities */
 239 #define ABSENT_BOOLEAN          ((signed char)-1)       /* 255 */
 240 #define ABSENT_NUMERIC          (-1)
 241 #define ABSENT_STRING           (char *)0
 242
 243 /* out-of-band values for representing cancels */
 244 #define CANCELLED_BOOLEAN       ((signed char)-2)       /* 254 */
 245 #define CANCELLED_NUMERIC       (-2)
 246 #define CANCELLED_STRING        (char *)(-1)
 247
 248 #define VALID_BOOLEAN(s) ((unsigned char)(s) <= 1) /* reject "-1" */
 249 #define VALID_NUMERIC(s) ((s) >= 0)
 250 #define VALID_STRING(s)  ((s) != CANCELLED_STRING && (s) != ABSENT_STRING)
 251
 252 /* termcap entries longer than this may break old binaries */
 253 #define MAX_TERMCAP_LENGTH      1023
 254
 255 /* this is a documented limitation of terminfo */
 256 #define MAX_TERMINFO_LENGTH     4096
 257
 258 #ifndef TERMINFO
 259 #define TERMINFO "/usr/share/terminfo"
 260 #endif
 261
 262 #ifdef NCURSES_TERM_ENTRY_H_incl
 263
 264 /*
 265  * These entrypoints are used only by the ncurses utilities such as tic.
 266  */
 267 #ifdef NCURSES_INTERNALS
 268 /* access.c */
 269 extern NCURSES_EXPORT(unsigned) _nc_pathlast (const char *);
 270 extern NCURSES_EXPORT(bool) _nc_is_abs_path (const char *);
 271 extern NCURSES_EXPORT(bool) _nc_is_dir_path (const char *);
 272 extern NCURSES_EXPORT(bool) _nc_is_file_path (const char *);
 273 extern NCURSES_EXPORT(char *) _nc_basename (char *);
 274 extern NCURSES_EXPORT(char *) _nc_rootname (char *);
 275
 276 /* comp_captab.c */
 277 extern NCURSES_EXPORT(const struct name_table_entry *) _nc_get_table (bool);
 278 extern NCURSES_EXPORT(const HashData *) _nc_get_hash_info (bool);
 279 extern NCURSES_EXPORT(const struct alias *) _nc_get_alias_table (bool);
 280
 281 /* comp_hash.c: name lookup */
 282 extern NCURSES_EXPORT(struct name_table_entry const *) _nc_find_type_entry
 283         (const char *, int, bool);
 284 extern NCURSES_EXPORT(struct user_table_entry const *) _nc_find_user_entry
 285         (const char *);
 286
 287 /* comp_scan.c: lexical analysis */
 288 extern NCURSES_EXPORT(int)  _nc_get_token (bool);
 289 extern NCURSES_EXPORT(void) _nc_panic_mode (char);
 290 extern NCURSES_EXPORT(void) _nc_push_token (int);
 291 extern NCURSES_EXPORT_VAR(int) _nc_curr_col;
 292 extern NCURSES_EXPORT_VAR(int) _nc_curr_line;
 293 extern NCURSES_EXPORT_VAR(int) _nc_syntax;
 294 extern NCURSES_EXPORT_VAR(int) _nc_strict_bsd;
 295 extern NCURSES_EXPORT_VAR(long) _nc_comment_end;
 296 extern NCURSES_EXPORT_VAR(long) _nc_comment_start;
 297 extern NCURSES_EXPORT_VAR(long) _nc_curr_file_pos;
 298 extern NCURSES_EXPORT_VAR(long) _nc_start_line;
 299 #define SYN_TERMINFO    0
 300 #define SYN_TERMCAP     1
 301
 302 /* comp_error.c: warning & abort messages */
 303 extern NCURSES_EXPORT(const char *) _nc_get_source (void);
 304 extern GCC_NORETURN NCURSES_EXPORT(void) _nc_err_abort (const char *const,...) GCC_PRINTFLIKE(1,2);
 305 extern NCURSES_EXPORT(void) _nc_get_type (char *name);
 306 extern NCURSES_EXPORT(void) _nc_set_source (const char *const);
 307 extern NCURSES_EXPORT(void) _nc_set_type (const char *const);
 308 extern GCC_NORETURN NCURSES_EXPORT(void) _nc_syserr_abort (const char *const,...) GCC_PRINTFLIKE(1,2);
 309 extern NCURSES_EXPORT(void) _nc_warning (const char *const,...) GCC_PRINTFLIKE(1,2);
 310 extern NCURSES_EXPORT_VAR(bool) _nc_suppress_warnings;
 311
 312 /* comp_scan.c */
 313 extern NCURSES_EXPORT_VAR(struct token) _nc_curr_token;
 314
 315 /* comp_userdefs.c */
 316 NCURSES_EXPORT(const struct user_table_entry *) _nc_get_userdefs_table (void);
 317 NCURSES_EXPORT(const HashData *) _nc_get_hash_user (void);
 318
 319 /* captoinfo.c: capability conversion */
 320 extern NCURSES_EXPORT(char *) _nc_captoinfo (const char *, const char *, int const);
 321 extern NCURSES_EXPORT(char *) _nc_infotocap (const char *, const char *, int const);
 322
 323 /* home_terminfo.c */
 324 extern NCURSES_EXPORT(char *) _nc_home_terminfo (void);
 325
 326 /* init_keytry.c */
 327 #if     BROKEN_LINKER
 328 #define _nc_tinfo_fkeys _nc_tinfo_fkeysf()
 329 extern NCURSES_EXPORT(const struct tinfo_fkeys *) _nc_tinfo_fkeysf (void);
 330 #else
 331 extern NCURSES_EXPORT_VAR(const struct tinfo_fkeys) _nc_tinfo_fkeys[];
 332 #endif
 333
 334 /* lib_tparm.c */
 335 #define NUM_PARM 9
 336
 337 extern NCURSES_EXPORT_VAR(int) _nc_tparm_err;
 338
 339 extern NCURSES_EXPORT(int) _nc_tparm_analyze(TERMINAL *, const char *, char **, int *);
 340 extern NCURSES_EXPORT(void) _nc_reset_tparm(TERMINAL *);
 341
 342 /* lib_trace.c */
 343 extern NCURSES_EXPORT_VAR(unsigned) _nc_tracing;
 344 extern NCURSES_EXPORT(const char *) _nc_visbuf (const char *);
 345 extern NCURSES_EXPORT(const char *) _nc_visbuf2 (int, const char *);
 346
 347 /* lib_tputs.c */
 348 extern NCURSES_EXPORT_VAR(int) _nc_nulls_sent;  /* Add one for every null sent */
 349
 350 /* comp_expand.c: expand string into readable form */
 351 extern NCURSES_EXPORT(char *) _nc_tic_expand (const char *, bool, int);
 352
 353 /* comp_hash.c: name lookup */
 354 extern NCURSES_EXPORT(struct name_table_entry const *) _nc_find_entry
 355         (const char *, const HashValue *);
 356 extern NCURSES_EXPORT(const HashValue *) _nc_get_hash_table (bool);
 357
 358 /* comp_main.c: compiler main */
 359 extern const char * _nc_progname;
 360
 361 /* db_iterator.c */
 362 extern NCURSES_EXPORT(const char *) _nc_next_db(DBDIRS *, int *);
 363 extern NCURSES_EXPORT(const char *) _nc_tic_dir (const char *);
 364 extern NCURSES_EXPORT(void) _nc_first_db(DBDIRS *, int *);
 365 extern NCURSES_EXPORT(void) _nc_last_db(void);
 366
 367 /* write_entry.c */
 368 extern NCURSES_EXPORT(int) _nc_tic_written (void);
 369
 370 #endif /* NCURSES_INTERNALS */
 371
 372 #endif /* NCURSES_TERM_ENTRY_H_incl */
 373
 374 #ifdef __cplusplus
 375 }
 376 #endif
 377
 378 /* *INDENT-ON* */
 379 #endif /* __TIC_H */