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