ncurses 5.1
[ncurses.git] / include / tic.h
1 /****************************************************************************
2  * Copyright (c) 1998-2000 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 /*
101  * Some traces are designed to be used via tic's verbose option (and similar in
102  * infocmp and toe) rather than the 'trace()' function.  So we use the bits
103  * above the normal trace() parameter as a debug-level.
104  */
105
106 #define MAX_DEBUG_LEVEL 15
107 #define DEBUG_LEVEL(n)  ((n) << 12)     /* see TRACE_MAXIMUM */
108
109 #define set_trace_level(n) \
110         _nc_tracing &= DEBUG_LEVEL(MAX_DEBUG_LEVEL), \
111         _nc_tracing |= DEBUG_LEVEL(n)
112
113 #ifdef TRACE
114 #define DEBUG(n, a)     if (_nc_tracing >= DEBUG_LEVEL(n)) _tracef a
115 #else
116 #define DEBUG(n, a)     /*nothing*/
117 #endif
118
119 extern unsigned _nc_tracing;
120 extern void _nc_tracef(char *, ...) GCC_PRINTFLIKE(1,2);
121 extern const char *_nc_visbuf(const char *);
122
123 /*
124  * These are the types of tokens returned by the scanner.  The first
125  * three are also used in the hash table of capability names.  The scanner
126  * returns one of these values after loading the specifics into the global
127  * structure curr_token.
128  */
129
130 #define BOOLEAN 0               /* Boolean capability */
131 #define NUMBER 1                /* Numeric capability */
132 #define STRING 2                /* String-valued capability */
133 #define CANCEL 3                /* Capability to be cancelled in following tc's */
134 #define NAMES  4                /* The names for a terminal type */
135 #define UNDEF  5                /* Undefined */
136
137 #define NO_PUSHBACK     -1      /* used in pushtype to indicate no pushback */
138
139         /*
140          *      The global structure in which the specific parts of a
141          *      scanned token are returned.
142          *
143          */
144
145 struct token
146 {
147         char    *tk_name;               /* name of capability */
148         int     tk_valnumber;   /* value of capability (if a number) */
149         char    *tk_valstring;  /* value of capability (if a string) */
150 };
151
152 extern  struct token    _nc_curr_token;
153
154         /*
155          * List of keynames with their corresponding code.
156          */
157 struct kn {
158         const char *name;
159         int code;
160 };
161
162 extern const struct kn _nc_key_names[];
163
164         /*
165          * Offsets to string capabilities, with the corresponding functionkey
166          * codes.
167          */
168 struct tinfo_fkeys {
169         unsigned offset;
170         chtype code;
171         };
172
173 #if     BROKEN_LINKER
174
175 #define _nc_tinfo_fkeys _nc_tinfo_fkeysf()
176 extern struct tinfo_fkeys *_nc_tinfo_fkeysf(void);
177
178 #else
179
180 extern struct tinfo_fkeys _nc_tinfo_fkeys[];
181
182 #endif
183
184         /*
185          * The file comp_captab.c contains an array of these structures, one
186          * per possible capability.  These are indexed by a hash table array of
187          * pointers to the same structures for use by the parser.
188          */
189
190 struct name_table_entry
191 {
192         const char *nte_name;   /* name to hash on */
193         int     nte_type;       /* BOOLEAN, NUMBER or STRING */
194         short   nte_index;      /* index of associated variable in its array */
195         short   nte_link;       /* index in table of next hash, or -1 */
196 };
197
198 struct alias
199 {
200         const char      *from;
201         const char      *to;
202         const char      *source;
203 };
204
205 extern const struct name_table_entry * const _nc_info_hash_table[];
206 extern const struct name_table_entry * const _nc_cap_hash_table[];
207
208 extern const struct alias _nc_capalias_table[];
209 extern const struct alias _nc_infoalias_table[];
210
211 extern const struct name_table_entry    *_nc_get_table(bool);
212 extern const struct name_table_entry    * const *_nc_get_hash_table(bool);
213
214 #define NOTFOUND        ((struct name_table_entry *) 0)
215
216 /* out-of-band values for representing absent capabilities */
217 #define ABSENT_BOOLEAN          -1
218 #define ABSENT_NUMERIC          -1
219 #define ABSENT_STRING           (char *)0
220
221 /* out-of-band values for representing cancels */
222 #define CANCELLED_BOOLEAN       (char)(-2)
223 #define CANCELLED_NUMERIC       -2
224 #define CANCELLED_STRING        (char *)-1
225
226 #define VALID_BOOLEAN(s) ((s) >= 0)
227 #define VALID_NUMERIC(s) ((s) >= 0)
228 #define VALID_STRING(s) ((s) != CANCELLED_STRING && (s) != ABSENT_STRING)
229
230 /* termcap entries longer than this may break old binaries */
231 #define MAX_TERMCAP_LENGTH      1023
232
233 /* this is a documented limitation of terminfo */
234 #define MAX_TERMINFO_LENGTH     4096
235
236 #ifndef TERMINFO
237 #define TERMINFO "/usr/share/terminfo"
238 #endif
239
240 /* comp_hash.c: name lookup */
241 struct name_table_entry const *_nc_find_entry(const char *,
242                                     const struct name_table_entry *const *);
243 struct name_table_entry const *_nc_find_type_entry(const char *,
244                                          int,
245                                          const struct name_table_entry *);
246
247 /* comp_scan.c: lexical analysis */
248 extern int  _nc_get_token(void);
249 extern void _nc_push_token(int);
250 extern void _nc_reset_input(FILE *, char *);
251 extern void _nc_panic_mode(char);
252 extern int _nc_curr_line;
253 extern int _nc_curr_col;
254 extern long _nc_curr_file_pos;
255 extern long _nc_comment_start, _nc_comment_end;
256 extern int _nc_syntax;
257 extern long _nc_start_line;
258 #define SYN_TERMINFO    0
259 #define SYN_TERMCAP     1
260
261 /* comp_error.c: warning & abort messages */
262 extern void _nc_set_source(const char *const name);
263 extern void _nc_get_type(char *name);
264 extern void _nc_set_type(const char *const name);
265 extern void _nc_syserr_abort(const char *const,...) GCC_PRINTFLIKE(1,2) GCC_NORETURN;
266 extern void _nc_err_abort(const char *const,...) GCC_PRINTFLIKE(1,2) GCC_NORETURN;
267 extern void _nc_warning(const char *const,...) GCC_PRINTFLIKE(1,2);
268 extern bool _nc_suppress_warnings;
269
270 /* comp_expand.c: expand string into readable form */
271 extern char *_nc_tic_expand(const char *, bool, int);
272
273 /* comp_scan.c: decode string from readable form */
274 extern char _nc_trans_string(char *, char *);
275
276 /* captoinfo.c: capability conversion */
277 extern char *_nc_captoinfo(const char *, const char *, int const);
278 extern char *_nc_infotocap(const char *, const char *, int const);
279
280 /* lib_tputs.c */
281 extern int _nc_nulls_sent;              /* Add one for every null sent */
282
283 /* comp_main.c: compiler main */
284 extern const char *_nc_progname;
285
286 /* read_entry.c */
287 extern const char *_nc_tic_dir(const char *);
288
289 /* write_entry.c */
290 extern int _nc_tic_written(void);
291
292 #ifdef __cplusplus
293 }
294 #endif
295
296 #endif /* __TIC_H */