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