source: trunk/ncurses/include/tic.h@ 2996

Last change on this file since 2996 was 2621, checked in by bird, 20 years ago

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