ncurses 6.2 - patch 20200711
[ncurses.git] / include / tic.h
1 /****************************************************************************
2  * Copyright 2018-2019,2020 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.81 2020/02/02 23:34:34 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 <curses.h>     /* for the _tracef() prototype, ERR/OK, bool defs */
51
52 /*
53 ** The format of SVr2 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 ** In the SVr2 format, "short" means signed 16-bit numbers, which is sometimes
70 ** inconvenient.  The numbers are signed, to provide for absent and canceled
71 ** values.  ncurses6.1 introduced an extension to this compiled format, by
72 ** making the Number Section a list of signed 32-bit integers.
73 **
74 **      NOTE that all short integers in the file are stored using VAX/PDP-style
75 **      byte-order, i.e., least-significant byte first.
76 **
77 **      There is no structure definition here because it would only confuse
78 **      matters.  Terminfo format is a raw byte layout, not a structure
79 **      dump.  If you happen to be on a little-endian machine with 16-bit
80 **      shorts that requires no padding between short members in a struct,
81 **      then there is a natural C structure that captures the header, but
82 **      not very helpfully.
83 */
84
85 #define MAGIC           0432    /* first two bytes of a compiled entry */
86 #define MAGIC2          01036   /* first two bytes of a compiled 32-bit entry */
87
88 #undef  BYTE
89 #define BYTE(p,n)       (unsigned char)((p)[n])
90
91 #define IS_NEG1(p)      ((BYTE(p,0) == 0377) && (BYTE(p,1) == 0377))
92 #define IS_NEG2(p)      ((BYTE(p,0) == 0376) && (BYTE(p,1) == 0377))
93 #define LOW_MSB(p)      (BYTE(p,0) + 256*BYTE(p,1))
94
95 #define IS_TIC_MAGIC(p) (LOW_MSB(p) == MAGIC || LOW_MSB(p) == MAGIC2)
96
97 #define quick_prefix(s) (!strncmp((s), "b64:", (size_t)4) || !strncmp((s), "hex:", (size_t)4))
98
99 /*
100  * The "maximum" here is misleading; XSI guarantees minimum values, which a
101  * given implementation may exceed.
102  */
103 #define MAX_NAME_SIZE   512     /* maximum legal name field size (XSI:127) */
104 #define MAX_ENTRY_SIZE1 4096    /* maximum legal entry size (SVr2) */
105 #define MAX_ENTRY_SIZE2 32768   /* maximum legal entry size (ncurses6.1) */
106
107 #if NCURSES_EXT_COLORS && HAVE_INIT_EXTENDED_COLOR
108 #define MAX_ENTRY_SIZE MAX_ENTRY_SIZE2
109 #else
110 #define MAX_ENTRY_SIZE MAX_ENTRY_SIZE1
111 #endif
112
113 /*
114  * The maximum size of individual name or alias is guaranteed in XSI to be at
115  * least 14, since that corresponds to the older filename lengths.  Newer
116  * systems allow longer aliases, though not many terminal descriptions are
117  * written to use them.  The MAX_ALIAS symbol is used for warnings.
118  */
119 #if HAVE_LONG_FILE_NAMES
120 #define MAX_ALIAS       32      /* smaller than POSIX minimum for PATH_MAX */
121 #else
122 #define MAX_ALIAS       14      /* SVr3 filename length */
123 #endif
124
125 /* location of user's personal info directory */
126 #define PRIVATE_INFO    "%s/.terminfo"  /* plug getenv("HOME") into %s */
127
128 /*
129  * Some traces are designed to be used via tic's verbose option (and similar in
130  * infocmp and toe) rather than the 'trace()' function.  So we use the bits
131  * above the normal trace() parameter as a debug-level.
132  */
133
134 #define MAX_DEBUG_LEVEL 15
135 #define DEBUG_LEVEL(n)  ((n) << TRACE_SHIFT)
136
137 #define set_trace_level(n) \
138         _nc_tracing &= DEBUG_LEVEL(MAX_DEBUG_LEVEL) \
139                      + DEBUG_LEVEL(MAX_DEBUG_LEVEL) - 1, \
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(char *) _nc_basename (char *);
275 extern NCURSES_EXPORT(char *) _nc_rootname (char *);
276
277 /* comp_captab.c */
278 extern NCURSES_EXPORT(const struct name_table_entry *) _nc_get_table (bool);
279 extern NCURSES_EXPORT(const HashData *) _nc_get_hash_info (bool);
280 extern NCURSES_EXPORT(const struct alias *) _nc_get_alias_table (bool);
281
282 /* comp_hash.c: name lookup */
283 extern NCURSES_EXPORT(struct name_table_entry const *) _nc_find_type_entry
284         (const char *, int, bool);
285 extern NCURSES_EXPORT(struct user_table_entry const *) _nc_find_user_entry
286         (const char *);
287
288 /* comp_scan.c: lexical analysis */
289 extern NCURSES_EXPORT(int)  _nc_get_token (bool);
290 extern NCURSES_EXPORT(void) _nc_panic_mode (char);
291 extern NCURSES_EXPORT(void) _nc_push_token (int);
292 extern NCURSES_EXPORT_VAR(int) _nc_curr_col;
293 extern NCURSES_EXPORT_VAR(int) _nc_curr_line;
294 extern NCURSES_EXPORT_VAR(int) _nc_syntax;
295 extern NCURSES_EXPORT_VAR(int) _nc_strict_bsd;
296 extern NCURSES_EXPORT_VAR(long) _nc_comment_end;
297 extern NCURSES_EXPORT_VAR(long) _nc_comment_start;
298 extern NCURSES_EXPORT_VAR(long) _nc_curr_file_pos;
299 extern NCURSES_EXPORT_VAR(long) _nc_start_line;
300 #define SYN_TERMINFO    0
301 #define SYN_TERMCAP     1
302
303 /* comp_error.c: warning & abort messages */
304 extern NCURSES_EXPORT(const char *) _nc_get_source (void);
305 extern NCURSES_EXPORT(void) _nc_err_abort (const char *const,...) GCC_PRINTFLIKE(1,2) GCC_NORETURN;
306 extern NCURSES_EXPORT(void) _nc_get_type (char *name);
307 extern NCURSES_EXPORT(void) _nc_set_source (const char *const);
308 extern NCURSES_EXPORT(void) _nc_set_type (const char *const);
309 extern NCURSES_EXPORT(void) _nc_syserr_abort (const char *const,...) GCC_PRINTFLIKE(1,2) GCC_NORETURN;
310 extern NCURSES_EXPORT(void) _nc_warning (const char *const,...) GCC_PRINTFLIKE(1,2);
311 extern NCURSES_EXPORT_VAR(bool) _nc_suppress_warnings;
312
313 /* comp_scan.c */
314 extern NCURSES_EXPORT_VAR(struct token) _nc_curr_token;
315
316 /* comp_userdefs.c */
317 NCURSES_EXPORT(const struct user_table_entry *) _nc_get_userdefs_table (void);
318 NCURSES_EXPORT(const HashData *) _nc_get_hash_user (void);
319
320 /* captoinfo.c: capability conversion */
321 extern NCURSES_EXPORT(char *) _nc_captoinfo (const char *, const char *, int const);
322 extern NCURSES_EXPORT(char *) _nc_infotocap (const char *, const char *, int const);
323
324 /* home_terminfo.c */
325 extern NCURSES_EXPORT(char *) _nc_home_terminfo (void);
326
327 /* init_keytry.c */
328 #if     BROKEN_LINKER
329 #define _nc_tinfo_fkeys _nc_tinfo_fkeysf()
330 extern NCURSES_EXPORT(const struct tinfo_fkeys *) _nc_tinfo_fkeysf (void);
331 #else
332 extern NCURSES_EXPORT_VAR(const struct tinfo_fkeys) _nc_tinfo_fkeys[];
333 #endif
334
335 /* lib_tparm.c */
336 #define NUM_PARM 9
337
338 extern NCURSES_EXPORT_VAR(int) _nc_tparm_err;
339
340 extern NCURSES_EXPORT(int) _nc_tparm_analyze(const char *, char **, int *);
341
342 /* lib_trace.c */
343 extern NCURSES_EXPORT_VAR(unsigned) _nc_tracing;
344 extern NCURSES_EXPORT(const char *) _nc_visbuf (const char *);
345 extern NCURSES_EXPORT(const char *) _nc_visbuf2 (int, const char *);
346
347 /* lib_tputs.c */
348 extern NCURSES_EXPORT_VAR(int) _nc_nulls_sent;  /* Add one for every null sent */
349
350 /* comp_main.c: compiler main */
351 extern const char * _nc_progname;
352
353 /* db_iterator.c */
354 extern NCURSES_EXPORT(const char *) _nc_next_db(DBDIRS *, int *);
355 extern NCURSES_EXPORT(const char *) _nc_tic_dir (const char *);
356 extern NCURSES_EXPORT(void) _nc_first_db(DBDIRS *, int *);
357 extern NCURSES_EXPORT(void) _nc_last_db(void);
358
359 /* write_entry.c */
360 extern NCURSES_EXPORT(int) _nc_tic_written (void);
361
362 #endif /* NCURSES_INTERNALS */
363
364 /*
365  * These entrypoints were used by tack before 1.08.
366  */
367
368 #undef  NCURSES_TACK_1_08
369 #ifdef  NCURSES_INTERNALS
370 #define NCURSES_TACK_1_08 /* nothing */
371 #else
372 #define NCURSES_TACK_1_08 GCC_DEPRECATED("upgrade to tack 1.08")
373 #endif
374
375 /* comp_hash.c: name lookup */
376 extern NCURSES_EXPORT(struct name_table_entry const *) _nc_find_entry
377         (const char *, const HashValue *) NCURSES_TACK_1_08;
378 extern NCURSES_EXPORT(const HashValue *) _nc_get_hash_table (bool) NCURSES_TACK_1_08;
379
380 /* comp_scan.c: lexical analysis */
381 extern NCURSES_EXPORT(void) _nc_reset_input (FILE *, char *) NCURSES_TACK_1_08;
382
383 /* comp_expand.c: expand string into readable form */
384 extern NCURSES_EXPORT(char *) _nc_tic_expand (const char *, bool, int) NCURSES_TACK_1_08;
385
386 /* comp_scan.c: decode string from readable form */
387 extern NCURSES_EXPORT(int) _nc_trans_string (char *, char *) NCURSES_TACK_1_08;
388
389 #endif /* NCURSES_TERM_ENTRY_H_incl */
390
391 #ifdef __cplusplus
392 }
393 #endif
394
395 /* *INDENT-ON* */
396 #endif /* __TIC_H */