ncurses 6.0 - patch 20170930
[ncurses.git] / include / tic.h
1 /****************************************************************************
2  * Copyright (c) 1998-2012,2017 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  *     and: Thomas E. Dickey 1996 on                                        *
33  ****************************************************************************/
34
35 /*
36  * $Id: tic.h,v 1.74 2017/07/22 16:25:10 tom Exp $
37  *      tic.h - Global variables and structures for the terminfo compiler.
38  */
39
40 #ifndef __TIC_H
41 #define __TIC_H
42 /* *INDENT-OFF* */
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46
47 #include <ncurses_cfg.h>
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 #undef  BYTE
82 #define BYTE(p,n)       (unsigned char)((p)[n])
83
84 #define IS_NEG1(p)      ((BYTE(p,0) == 0377) && (BYTE(p,1) == 0377))
85 #define IS_NEG2(p)      ((BYTE(p,0) == 0376) && (BYTE(p,1) == 0377))
86 #define LOW_MSB(p)      (BYTE(p,0) + 256*BYTE(p,1))
87
88 #define IS_TIC_MAGIC(p) (LOW_MSB(p) == MAGIC)
89
90 #define quick_prefix(s) (!strncmp((s), "b64:", 4) || !strncmp((s), "hex:", 4))
91
92 /*
93  * The "maximum" here is misleading; XSI guarantees minimum values, which a
94  * given implementation may exceed.
95  */
96 #define MAX_NAME_SIZE   512     /* maximum legal name field size (XSI:127) */
97 #define MAX_ENTRY_SIZE  4096    /* maximum legal entry size */
98
99 /*
100  * The maximum size of individual name or alias is guaranteed in XSI to be at
101  * least 14, since that corresponds to the older filename lengths.  Newer
102  * systems allow longer aliases, though not many terminal descriptions are
103  * written to use them.  The MAX_ALIAS symbol is used for warnings.
104  */
105 #if HAVE_LONG_FILE_NAMES
106 #define MAX_ALIAS       32      /* smaller than POSIX minimum for PATH_MAX */
107 #else
108 #define MAX_ALIAS       14      /* SVr3 filename length */
109 #endif
110
111 /* location of user's personal info directory */
112 #define PRIVATE_INFO    "%s/.terminfo"  /* plug getenv("HOME") into %s */
113
114 /*
115  * Some traces are designed to be used via tic's verbose option (and similar in
116  * infocmp and toe) rather than the 'trace()' function.  So we use the bits
117  * above the normal trace() parameter as a debug-level.
118  */
119
120 #define MAX_DEBUG_LEVEL 15
121 #define DEBUG_LEVEL(n)  ((n) << TRACE_SHIFT)
122
123 #define set_trace_level(n) \
124         _nc_tracing &= DEBUG_LEVEL(MAX_DEBUG_LEVEL), \
125         _nc_tracing |= DEBUG_LEVEL(n)
126
127 #ifdef TRACE
128 #define DEBUG(n, a)     if (_nc_tracing >= DEBUG_LEVEL(n)) _tracef a
129 #else
130 #define DEBUG(n, a)     /*nothing*/
131 #endif
132
133 /*
134  * These are the types of tokens returned by the scanner.  The first
135  * three are also used in the hash table of capability names.  The scanner
136  * returns one of these values after loading the specifics into the global
137  * structure curr_token.
138  */
139
140 #define BOOLEAN 0               /* Boolean capability */
141 #define NUMBER 1                /* Numeric capability */
142 #define STRING 2                /* String-valued capability */
143 #define CANCEL 3                /* Capability to be cancelled in following tc's */
144 #define NAMES  4                /* The names for a terminal type */
145 #define UNDEF  5                /* Undefined */
146
147 #define NO_PUSHBACK     -1      /* used in pushtype to indicate no pushback */
148
149 /*
150  * The global structure in which the specific parts of a
151  * scanned token are returned.
152  */
153
154 struct token
155 {
156         char    *tk_name;       /* name of capability */
157         int     tk_valnumber;   /* value of capability (if a number) */
158         char    *tk_valstring;  /* value of capability (if a string) */
159 };
160
161 /*
162  * Offsets to string capabilities, with the corresponding functionkey codes.
163  */
164 struct tinfo_fkeys {
165         unsigned offset;
166         chtype code;
167         };
168
169 typedef short HashValue;
170
171 /*
172  * The file comp_captab.c contains an array of these structures, one per
173  * possible capability.  These are indexed by a hash table array of pointers to
174  * the same structures for use by the parser.
175  */
176 struct name_table_entry
177 {
178         const char *nte_name;   /* name to hash on */
179         int     nte_type;       /* BOOLEAN, NUMBER or STRING */
180         HashValue nte_index;    /* index of associated variable in its array */
181         HashValue nte_link;     /* index in table of next hash, or -1 */
182 };
183
184 /*
185  * Use this structure to hide differences between terminfo and termcap tables.
186  */
187 typedef struct {
188         unsigned table_size;
189         const HashValue *table_data;
190         HashValue (*hash_of)(const char *);
191         int (*compare_names)(const char *, const char *);
192 } HashData;
193
194 struct alias
195 {
196         const char      *from;
197         const char      *to;
198         const char      *source;
199 };
200
201 #define NOTFOUND        ((struct name_table_entry *) 0)
202
203 /*
204  * The casts are required for correct sign-propagation with systems such as
205  * AIX, IRIX64, Solaris which default to unsigned characters.  The C standard
206  * leaves this detail unspecified.
207  */
208
209 /* out-of-band values for representing absent capabilities */
210 #define ABSENT_BOOLEAN          ((signed char)-1)       /* 255 */
211 #define ABSENT_NUMERIC          (-1)
212 #define ABSENT_STRING           (char *)0
213
214 /* out-of-band values for representing cancels */
215 #define CANCELLED_BOOLEAN       ((signed char)-2)       /* 254 */
216 #define CANCELLED_NUMERIC       (-2)
217 #define CANCELLED_STRING        (char *)(-1)
218
219 #define VALID_BOOLEAN(s) ((unsigned char)(s) <= 1) /* reject "-1" */
220 #define VALID_NUMERIC(s) ((s) >= 0)
221 #define VALID_STRING(s)  ((s) != CANCELLED_STRING && (s) != ABSENT_STRING)
222
223 /* termcap entries longer than this may break old binaries */
224 #define MAX_TERMCAP_LENGTH      1023
225
226 /* this is a documented limitation of terminfo */
227 #define MAX_TERMINFO_LENGTH     4096
228
229 #ifndef TERMINFO
230 #define TERMINFO "/usr/share/terminfo"
231 #endif
232
233 #ifdef NCURSES_TERM_ENTRY_H_incl
234
235 /*
236  * These entrypoints are used only by the ncurses utilities such as tic.
237  */
238 #ifdef NCURSES_INTERNALS
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_captab.c */
248 extern NCURSES_EXPORT(const struct name_table_entry *) _nc_get_table (bool);
249 extern NCURSES_EXPORT(const HashData *) _nc_get_hash_info (bool);
250 extern NCURSES_EXPORT(const struct alias *) _nc_get_alias_table (bool);
251
252 /* comp_hash.c: name lookup */
253 extern NCURSES_EXPORT(struct name_table_entry const *) _nc_find_type_entry
254         (const char *, int, bool);
255
256 /* comp_scan.c: lexical analysis */
257 extern NCURSES_EXPORT(int)  _nc_get_token (bool);
258 extern NCURSES_EXPORT(void) _nc_panic_mode (char);
259 extern NCURSES_EXPORT(void) _nc_push_token (int);
260 extern NCURSES_EXPORT_VAR(int) _nc_curr_col;
261 extern NCURSES_EXPORT_VAR(int) _nc_curr_line;
262 extern NCURSES_EXPORT_VAR(int) _nc_syntax;
263 extern NCURSES_EXPORT_VAR(int) _nc_strict_bsd;
264 extern NCURSES_EXPORT_VAR(long) _nc_comment_end;
265 extern NCURSES_EXPORT_VAR(long) _nc_comment_start;
266 extern NCURSES_EXPORT_VAR(long) _nc_curr_file_pos;
267 extern NCURSES_EXPORT_VAR(long) _nc_start_line;
268 #define SYN_TERMINFO    0
269 #define SYN_TERMCAP     1
270
271 /* comp_error.c: warning & abort messages */
272 extern NCURSES_EXPORT(const char *) _nc_get_source (void);
273 extern NCURSES_EXPORT(void) _nc_err_abort (const char *const,...) GCC_PRINTFLIKE(1,2) GCC_NORETURN;
274 extern NCURSES_EXPORT(void) _nc_get_type (char *name);
275 extern NCURSES_EXPORT(void) _nc_set_source (const char *const);
276 extern NCURSES_EXPORT(void) _nc_set_type (const char *const);
277 extern NCURSES_EXPORT(void) _nc_syserr_abort (const char *const,...) GCC_PRINTFLIKE(1,2) GCC_NORETURN;
278 extern NCURSES_EXPORT(void) _nc_warning (const char *const,...) GCC_PRINTFLIKE(1,2);
279 extern NCURSES_EXPORT_VAR(bool) _nc_suppress_warnings;
280
281 /* comp_scan.c */
282 extern NCURSES_EXPORT_VAR(struct token) _nc_curr_token;
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 /* init_keytry.c */
292 #if     BROKEN_LINKER
293 #define _nc_tinfo_fkeys _nc_tinfo_fkeysf()
294 extern NCURSES_EXPORT(const struct tinfo_fkeys *) _nc_tinfo_fkeysf (void);
295 #else
296 extern NCURSES_EXPORT_VAR(const struct tinfo_fkeys) _nc_tinfo_fkeys[];
297 #endif
298
299 /* lib_tparm.c */
300 #define NUM_PARM 9
301
302 extern NCURSES_EXPORT_VAR(int) _nc_tparm_err;
303
304 extern NCURSES_EXPORT(int) _nc_tparm_analyze(const char *, char **, int *);
305
306 /* lib_trace.c */
307 extern NCURSES_EXPORT_VAR(unsigned) _nc_tracing;
308 extern NCURSES_EXPORT(const char *) _nc_visbuf (const char *);
309 extern NCURSES_EXPORT(const char *) _nc_visbuf2 (int, const char *);
310
311 /* lib_tputs.c */
312 extern NCURSES_EXPORT_VAR(int) _nc_nulls_sent;  /* Add one for every null sent */
313
314 /* comp_main.c: compiler main */
315 extern const char * _nc_progname;
316
317 /* db_iterator.c */
318 extern NCURSES_EXPORT(const char *) _nc_next_db(DBDIRS *, int *);
319 extern NCURSES_EXPORT(const char *) _nc_tic_dir (const char *);
320 extern NCURSES_EXPORT(void) _nc_first_db(DBDIRS *, int *);
321 extern NCURSES_EXPORT(void) _nc_last_db(void);
322
323 /* write_entry.c */
324 extern NCURSES_EXPORT(int) _nc_tic_written (void);
325
326 #endif /* NCURSES_INTERNALS */
327
328 /*
329  * These entrypoints are used by tack.
330  */
331
332 /* comp_hash.c: name lookup */
333 extern NCURSES_EXPORT(struct name_table_entry const *) _nc_find_entry
334         (const char *, const HashValue *);
335 extern NCURSES_EXPORT(const HashValue *) _nc_get_hash_table (bool);
336
337 /* comp_scan.c: lexical analysis */
338 extern NCURSES_EXPORT(void) _nc_reset_input (FILE *, char *);
339
340 /* comp_expand.c: expand string into readable form */
341 extern NCURSES_EXPORT(char *) _nc_tic_expand (const char *, bool, int);
342
343 /* comp_scan.c: decode string from readable form */
344 extern NCURSES_EXPORT(int) _nc_trans_string (char *, char *);
345
346 #endif /* NCURSES_TERM_ENTRY_H_incl */
347
348 #ifdef __cplusplus
349 }
350 #endif
351
352 /* *INDENT-ON* */
353 #endif /* __TIC_H */