1 /**************************************************************************** 2 * Copyright (c) 1998 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 ****************************************************************************/ 33 34 /* 35 * tic.h - Global variables and structures for the terminfo 36 * compiler. 37 * 38 */ 39 40 #ifndef __TIC_H 41 #define __TIC_H 42 43 #ifdef __cplusplus 44 extern "C" { 45 #endif 46 47 #include <curses.h> /* for the _tracef() prototype, ERR/OK, bool defs */ 48 49 /* 50 ** The format of compiled terminfo files is as follows: 51 ** 52 ** Header (12 bytes), containing information given below 53 ** Names Section, containing the names of the terminal 54 ** Boolean Section, containing the values of all of the 55 ** boolean capabilities 56 ** A null byte may be inserted here to make 57 ** sure that the Number Section begins on an 58 ** even word boundary. 59 ** Number Section, containing the values of all of the numeric 60 ** capabilities, each as a short integer 61 ** String Section, containing short integer offsets into the 62 ** String Table, one per string capability 63 ** String Table, containing the actual characters of the string 64 ** capabilities. 65 ** 66 ** NOTE that all short integers in the file are stored using VAX/PDP-style 67 ** byte-order, i.e., least-significant byte first. 68 ** 69 ** There is no structure definition here because it would only confuse 70 ** matters. Terminfo format is a raw byte layout, not a structure 71 ** dump. If you happen to be on a little-endian machine with 16-bit 72 ** shorts that requires no padding between short members in a struct, 73 ** then there is a natural C structure that captures the header, but 74 ** not very helpfully. 75 */ 76 77 #define MAGIC 0432 /* first two bytes of a compiled entry */ 78 79 /* 80 * The "maximum" here is misleading; XSI guarantees minimum values, which a 81 * given implementation may exceed. 82 */ 83 #define MAX_NAME_SIZE 512 /* maximum legal name field size (XSI:127) */ 84 #define MAX_ENTRY_SIZE 4096 /* maximum legal entry size */ 85 86 /* The maximum size of individual name or alias is guaranteed in XSI to 87 * be 14, since that corresponds to the older filename lengths. Newer 88 * systems allow longer aliases, though not many terminal descriptions 89 * are written to use them. 90 */ 91 #if HAVE_LONG_FILE_NAMES 92 #define MAX_ALIAS 32 /* POSIX minimum for PATH_MAX */ 93 #else 94 #define MAX_ALIAS 14 /* SVr3 filename length */ 95 #endif 96 97 /* location of user's personal info directory */ 98 #define PRIVATE_INFO "%s/.terminfo" /* plug getenv("HOME") into %s */ 99 100 #ifdef TRACE 101 #define DEBUG(n, a) if (_nc_tracing & (1 << (n - 1))) _tracef a 102 #else 103 #define DEBUG(n, a) /*nothing*/ 104 #endif 105 106 extern unsigned _nc_tracing; 107 extern void _nc_tracef(char *, ...) GCC_PRINTFLIKE(1,2); 108 extern const char *_nc_visbuf(const char *); 109 110 /* 111 * These are the types of tokens returned by the scanner. The first 112 * three are also used in the hash table of capability names. The scanner 113 * returns one of these values after loading the specifics into the global 114 * structure curr_token. 115 */ 116 117 #define BOOLEAN 0 /* Boolean capability */ 118 #define NUMBER 1 /* Numeric capability */ 119 #define STRING 2 /* String-valued capability */ 120 #define CANCEL 3 /* Capability to be cancelled in following tc's */ 121 #define NAMES 4 /* The names for a terminal type */ 122 #define UNDEF 5 /* Undefined */ 123 124 #define NO_PUSHBACK -1 /* used in pushtype to indicate no pushback */ 125 126 /* 127 * The global structure in which the specific parts of a 128 * scanned token are returned. 129 * 130 */ 131 132 struct token 133 { 134 char *tk_name; /* name of capability */ 135 int tk_valnumber; /* value of capability (if a number) */ 136 char *tk_valstring; /* value of capability (if a string) */ 137 }; 138 139 extern struct token _nc_curr_token; 140 141 /* 142 * List of keynames with their corresponding code. 143 */ 144 struct kn { 145 const char *name; 146 int code; 147 }; 148 149 extern const struct kn _nc_key_names[]; 150 151 /* 152 * Offsets to string capabilities, with the corresponding functionkey 153 * codes. 154 */ 155 struct tinfo_fkeys { 156 unsigned offset; 157 chtype code; 158 }; 159 160 extern struct tinfo_fkeys _nc_tinfo_fkeys[]; 161 162 /* 163 * The file comp_captab.c contains an array of these structures, one 164 * per possible capability. These are indexed by a hash table array of 165 * pointers to the same structures for use by the parser. 166 */ 167 168 struct name_table_entry 169 { 170 const char *nte_name; /* name to hash on */ 171 int nte_type; /* BOOLEAN, NUMBER or STRING */ 172 short nte_index; /* index of associated variable in its array */ 173 short nte_link; /* index in table of next hash, or -1 */ 174 }; 175 176 struct alias 177 { 178 const char *from; 179 const char *to; 180 const char *source; 181 }; 182 183 extern const struct name_table_entry * const _nc_info_hash_table[]; 184 extern const struct name_table_entry * const _nc_cap_hash_table[]; 185 186 extern const struct alias _nc_capalias_table[]; 187 extern const struct alias _nc_infoalias_table[]; 188 189 extern const struct name_table_entry *_nc_get_table(bool); 190 extern const struct name_table_entry * const *_nc_get_hash_table(bool); 191 192 #define NOTFOUND ((struct name_table_entry *) 0) 193 194 /* out-of-band values for representing absent capabilities */ 195 #define ABSENT_BOOLEAN -1 196 #define ABSENT_NUMERIC -1 197 #define ABSENT_STRING (char *)0 198 199 /* out-of-band values for representing cancels */ 200 #define CANCELLED_BOOLEAN (char)(-2) 201 #define CANCELLED_NUMERIC -2 202 #define CANCELLED_STRING (char *)-1 203 204 #define VALID_BOOLEAN(s) ((s) >= 0) 205 #define VALID_NUMERIC(s) ((s) >= 0) 206 #define VALID_STRING(s) ((s) != CANCELLED_STRING && (s) != ABSENT_STRING) 207 208 /* termcap entries longer than this may break old binaries */ 209 #define MAX_TERMCAP_LENGTH 1023 210 211 /* this is a documented limitation of terminfo */ 212 #define MAX_TERMINFO_LENGTH 4096 213 214 #ifndef TERMINFO 215 #define TERMINFO "/usr/share/terminfo" 216 #endif 217 218 /* comp_hash.c: name lookup */ 219 struct name_table_entry const *_nc_find_entry(const char *, 220 const struct name_table_entry *const *); 221 struct name_table_entry const *_nc_find_type_entry(const char *, 222 int, 223 const struct name_table_entry *); 224 225 /* comp_scan.c: lexical analysis */ 226 extern int _nc_get_token(void); 227 extern void _nc_push_token(int); 228 extern void _nc_reset_input(FILE *, char *); 229 extern void _nc_panic_mode(char); 230 extern int _nc_curr_line; 231 extern int _nc_curr_col; 232 extern long _nc_curr_file_pos; 233 extern long _nc_comment_start, _nc_comment_end; 234 extern int _nc_syntax; 235 extern long _nc_start_line; 236 #define SYN_TERMINFO 0 237 #define SYN_TERMCAP 1 238 239 /* comp_error.c: warning & abort messages */ 240 extern void _nc_set_source(const char *const name); 241 extern void _nc_get_type(char *name); 242 extern void _nc_set_type(const char *const name); 243 extern void _nc_syserr_abort(const char *const,...) GCC_PRINTFLIKE(1,2) GCC_NORETURN; 244 extern void _nc_err_abort(const char *const,...) GCC_PRINTFLIKE(1,2) GCC_NORETURN; 245 extern void _nc_warning(const char *const,...) GCC_PRINTFLIKE(1,2); 246 extern bool _nc_suppress_warnings; 247 248 /* comp_expand.c: expand string into readable form */ 249 extern char *_nc_tic_expand(const char *, bool, int); 250 251 /* comp_scan.c: decode string from readable form */ 252 extern char _nc_trans_string(char *); 253 254 /* captoinfo.c: capability conversion */ 255 extern char *_nc_captoinfo(const char *, const char *, int const); 256 extern char *_nc_infotocap(const char *, const char *, int const); 257 258 /* lib_tputs.c */ 259 extern int _nc_nulls_sent; /* Add one for every null sent */ 260 261 /* comp_main.c: compiler main */ 262 extern const char *_nc_progname; 263 264 /* read_entry.c */ 265 extern const char *_nc_tic_dir(const char *); 266 267 /* write_entry.c */ 268 extern int _nc_tic_written(void); 269 270 #ifdef __cplusplus 271 } 272 #endif 273 274 #endif /* __TIC_H */ 275