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