include/tic.h

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