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