1 /* $OpenBSD: tic.h,v 1.14 2010/01/12 23:21:59 nicm Exp $ */ 2 3 /**************************************************************************** 4 * Copyright (c) 1998-2006,2007 Free Software Foundation, Inc. * 5 * * 6 * Permission is hereby granted, free of charge, to any person obtaining a * 7 * copy of this software and associated documentation files (the * 8 * "Software"), to deal in the Software without restriction, including * 9 * without limitation the rights to use, copy, modify, merge, publish, * 10 * distribute, distribute with modifications, sublicense, and/or sell * 11 * copies of the Software, and to permit persons to whom the Software is * 12 * furnished to do so, subject to the following conditions: * 13 * * 14 * The above copyright notice and this permission notice shall be included * 15 * in all copies or substantial portions of the Software. * 16 * * 17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * 18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * 19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * 20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * 21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * 22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * 23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * 24 * * 25 * Except as contained in this notice, the name(s) of the above copyright * 26 * holders shall not be used in advertising or otherwise to promote the * 27 * sale, use or other dealings in this Software without prior written * 28 * authorization. * 29 ****************************************************************************/ 30 31 /**************************************************************************** 32 * Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 * 33 * and: Eric S. Raymond <esr@snark.thyrsus.com> * 34 * and: Thomas E. Dickey 1996 on * 35 ****************************************************************************/ 36 37 /* 38 * $Id: tic.h,v 1.14 2010/01/12 23:21:59 nicm Exp $ 39 * tic.h - Global variables and structures for the terminfo 40 * compiler. 41 */ 42 43 #ifndef __TIC_H 44 #define __TIC_H 45 46 #ifdef __cplusplus 47 extern "C" { 48 #endif 49 50 #include <curses.h> /* for the _tracef() prototype, ERR/OK, bool defs */ 51 52 /* 53 ** The format of 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 ** NOTE that all short integers in the file are stored using VAX/PDP-style 70 ** byte-order, i.e., least-significant byte first. 71 ** 72 ** There is no structure definition here because it would only confuse 73 ** matters. Terminfo format is a raw byte layout, not a structure 74 ** dump. If you happen to be on a little-endian machine with 16-bit 75 ** shorts that requires no padding between short members in a struct, 76 ** then there is a natural C structure that captures the header, but 77 ** not very helpfully. 78 */ 79 80 #define MAGIC 0432 /* first two bytes of a compiled entry */ 81 82 #undef BYTE 83 #define BYTE(p,n) (unsigned char)((p)[n]) 84 85 #define IS_NEG1(p) ((BYTE(p,0) == 0377) && (BYTE(p,1) == 0377)) 86 #define IS_NEG2(p) ((BYTE(p,0) == 0376) && (BYTE(p,1) == 0377)) 87 #define LOW_MSB(p) (BYTE(p,0) + 256*BYTE(p,1)) 88 89 #define IS_TIC_MAGIC(p) (LOW_MSB(p) == MAGIC) 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 /* 189 * The file comp_captab.c contains an array of these structures, one 190 * per possible capability. These are indexed by a hash table array of 191 * pointers to the same structures for use by the parser. 192 */ 193 194 struct name_table_entry 195 { 196 const char *nte_name; /* name to hash on */ 197 int nte_type; /* BOOLEAN, NUMBER or STRING */ 198 short nte_index; /* index of associated variable in its array */ 199 short nte_link; /* index in table of next hash, or -1 */ 200 }; 201 202 struct alias 203 { 204 const char *from; 205 const char *to; 206 const char *source; 207 }; 208 209 extern NCURSES_EXPORT(const struct name_table_entry *) _nc_get_table (bool); 210 extern NCURSES_EXPORT(const short *) _nc_get_hash_table (bool); 211 extern NCURSES_EXPORT(const struct alias *) _nc_get_alias_table (bool); 212 213 #define NOTFOUND ((struct name_table_entry *) 0) 214 215 /* out-of-band values for representing absent capabilities */ 216 #define ABSENT_BOOLEAN ((signed char)-1) /* 255 */ 217 #define ABSENT_NUMERIC (-1) 218 #define ABSENT_STRING (char *)0 219 220 /* out-of-band values for representing cancels */ 221 #define CANCELLED_BOOLEAN ((signed char)-2) /* 254 */ 222 #define CANCELLED_NUMERIC (-2) 223 #define CANCELLED_STRING (char *)(-1) 224 225 #define VALID_BOOLEAN(s) ((unsigned char)(s) <= 1) /* reject "-1" */ 226 #define VALID_NUMERIC(s) ((s) >= 0) 227 #define VALID_STRING(s) ((s) != CANCELLED_STRING && (s) != ABSENT_STRING) 228 229 /* termcap entries longer than this may break old binaries */ 230 #define MAX_TERMCAP_LENGTH 1023 231 232 /* this is a documented limitation of terminfo */ 233 #define MAX_TERMINFO_LENGTH 4096 234 235 #ifndef TERMINFO 236 #define TERMINFO "/usr/share/terminfo" 237 #endif 238 239 /* access.c */ 240 extern NCURSES_EXPORT(unsigned) _nc_pathlast (const char *); 241 extern NCURSES_EXPORT(bool) _nc_is_abs_path (const char *); 242 extern NCURSES_EXPORT(bool) _nc_is_dir_path (const char *); 243 extern NCURSES_EXPORT(bool) _nc_is_file_path (const char *); 244 extern NCURSES_EXPORT(char *) _nc_basename (char *); 245 extern NCURSES_EXPORT(char *) _nc_rootname (char *); 246 247 /* comp_hash.c: name lookup */ 248 extern NCURSES_EXPORT(struct name_table_entry const *) _nc_find_entry 249 (const char *, const short *); 250 extern NCURSES_EXPORT(struct name_table_entry const *) _nc_find_type_entry 251 (const char *, int, const struct name_table_entry *); 252 253 /* comp_scan.c: lexical analysis */ 254 extern NCURSES_EXPORT(int) _nc_get_token (bool); 255 extern NCURSES_EXPORT(void) _nc_panic_mode (char); 256 extern NCURSES_EXPORT(void) _nc_push_token (int); 257 extern NCURSES_EXPORT(void) _nc_reset_input (FILE *, char *); 258 extern NCURSES_EXPORT_VAR(int) _nc_curr_col; 259 extern NCURSES_EXPORT_VAR(int) _nc_curr_line; 260 extern NCURSES_EXPORT_VAR(int) _nc_syntax; 261 extern NCURSES_EXPORT_VAR(long) _nc_comment_end; 262 extern NCURSES_EXPORT_VAR(long) _nc_comment_start; 263 extern NCURSES_EXPORT_VAR(long) _nc_curr_file_pos; 264 extern NCURSES_EXPORT_VAR(long) _nc_start_line; 265 #define SYN_TERMINFO 0 266 #define SYN_TERMCAP 1 267 268 /* comp_error.c: warning & abort messages */ 269 extern NCURSES_EXPORT(const char *) _nc_get_source (void); 270 extern NCURSES_EXPORT(void) _nc_err_abort (const char *const,...) GCC_PRINTFLIKE(1,2) GCC_NORETURN; 271 extern NCURSES_EXPORT(void) _nc_get_type (char *name); 272 extern NCURSES_EXPORT(void) _nc_set_source (const char *const); 273 extern NCURSES_EXPORT(void) _nc_set_type (const char *const); 274 extern NCURSES_EXPORT(void) _nc_syserr_abort (const char *const,...) GCC_PRINTFLIKE(1,2) GCC_NORETURN; 275 extern NCURSES_EXPORT(void) _nc_warning (const char *const,...) GCC_PRINTFLIKE(1,2); 276 extern NCURSES_EXPORT_VAR(bool) _nc_suppress_warnings; 277 278 /* comp_expand.c: expand string into readable form */ 279 extern NCURSES_EXPORT(char *) _nc_tic_expand (const char *, bool, int); 280 281 /* comp_scan.c: decode string from readable form */ 282 extern NCURSES_EXPORT(int) _nc_trans_string (char *, char *); 283 284 /* captoinfo.c: capability conversion */ 285 extern NCURSES_EXPORT(char *) _nc_captoinfo (const char *, const char *, int const); 286 extern NCURSES_EXPORT(char *) _nc_infotocap (const char *, const char *, int const); 287 288 /* home_terminfo.c */ 289 extern NCURSES_EXPORT(char *) _nc_home_terminfo (void); 290 291 /* lib_tparm.c */ 292 #define NUM_PARM 9 293 294 extern NCURSES_EXPORT_VAR(int) _nc_tparm_err; 295 296 extern NCURSES_EXPORT(int) _nc_tparm_analyze(const char *, char **, int *); 297 298 /* lib_tputs.c */ 299 extern NCURSES_EXPORT_VAR(int) _nc_nulls_sent; /* Add one for every null sent */ 300 301 /* comp_main.c: compiler main */ 302 extern const char * _nc_progname; 303 304 /* db_iterator.c */ 305 typedef enum { 306 dbdTIC = 0, 307 #if USE_DATABASE 308 dbdEnvOnce, 309 dbdHome, 310 dbdEnvList, 311 dbdCfgList, 312 dbdCfgOnce, 313 #endif 314 #if USE_TERMCAP 315 dbdEnvOnce2, 316 dbdEnvList2, 317 dbdCfgList2, 318 #endif 319 dbdLAST 320 } DBDIRS; 321 322 extern NCURSES_EXPORT(const char *) _nc_next_db(DBDIRS *, int *); 323 extern NCURSES_EXPORT(const char *) _nc_tic_dir (const char *); 324 extern NCURSES_EXPORT(void) _nc_first_db(DBDIRS *, int *); 325 extern NCURSES_EXPORT(void) _nc_last_db(void); 326 327 /* write_entry.c */ 328 extern NCURSES_EXPORT(int) _nc_tic_written (void); 329 330 #ifdef __cplusplus 331 } 332 #endif 333 334 #endif /* __TIC_H */ 335