1 /****************************************************************************
2 * Copyright (c) 1998-2015,2017 Free Software Foundation, Inc. *
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: *
12 * The above copyright notice and this permission notice shall be included *
13 * in all copies or substantial portions of the Software. *
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. *
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 *
27 ****************************************************************************/
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 1998-on *
33 ****************************************************************************/
35 /* $Id: term_entry.h,v 1.54 2017/04/03 21:36:00 tom Exp $ */
38 * term_entry.h -- interface to entry-manipulation code
41 #ifndef NCURSES_TERM_ENTRY_H_incl
42 #define NCURSES_TERM_ENTRY_H_incl 1
52 * These macros may be used by programs that know about TERMTYPE:
55 #define NUM_BOOLEANS(tp) (tp)->num_Booleans
56 #define NUM_NUMBERS(tp) (tp)->num_Numbers
57 #define NUM_STRINGS(tp) (tp)->num_Strings
58 #define EXT_NAMES(tp,i,limit,index,table) (i >= limit) ? tp->ext_Names[index] : table[i]
60 #define NUM_BOOLEANS(tp) BOOLCOUNT
61 #define NUM_NUMBERS(tp) NUMCOUNT
62 #define NUM_STRINGS(tp) STRCOUNT
63 #define EXT_NAMES(tp,i,limit,index,table) table[i]
66 #define NUM_EXT_NAMES(tp) (unsigned) ((tp)->ext_Booleans + (tp)->ext_Numbers + (tp)->ext_Strings)
68 #define for_each_boolean(n,tp) for(n = 0; n < NUM_BOOLEANS(tp); n++)
69 #define for_each_number(n,tp) for(n = 0; n < NUM_NUMBERS(tp); n++)
70 #define for_each_string(n,tp) for(n = 0; n < NUM_STRINGS(tp); n++)
73 #define for_each_ext_boolean(n,tp) for(n = BOOLCOUNT; (int) n < (int) NUM_BOOLEANS(tp); n++)
74 #define for_each_ext_number(n,tp) for(n = NUMCOUNT; (int) n < (int) NUM_NUMBERS(tp); n++)
75 #define for_each_ext_string(n,tp) for(n = STRCOUNT; (int) n < (int) NUM_STRINGS(tp); n++)
78 #define ExtBoolname(tp,i,names) EXT_NAMES(tp, i, BOOLCOUNT, (i - (tp->num_Booleans - tp->ext_Booleans)), names)
79 #define ExtNumname(tp,i,names) EXT_NAMES(tp, i, NUMCOUNT, (i - (tp->num_Numbers - tp->ext_Numbers)) + tp->ext_Booleans, names)
80 #define ExtStrname(tp,i,names) EXT_NAMES(tp, i, STRCOUNT, (i - (tp->num_Strings - tp->ext_Strings)) + (tp->ext_Numbers + tp->ext_Booleans), names)
83 * The remaining type-definitions and macros are used only internally by the
86 #ifdef NCURSES_INTERNALS
89 * see db_iterator.c - this enumeration lists the places searched for a
90 * terminal description and defines the order in which they are searched.
93 dbdTIC = 0, /* special, used by tic when writing entry */
94 #if NCURSES_USE_DATABASE
95 dbdEnvOnce, /* the $TERMINFO environment variable */
96 dbdHome, /* $HOME/.terminfo */
97 dbdEnvList, /* the $TERMINFO_DIRS environment variable */
98 dbdCfgList, /* the compiled-in TERMINFO_DIRS value */
99 dbdCfgOnce, /* the compiled-in TERMINFO value */
101 #if NCURSES_USE_TERMCAP
102 dbdEnvOnce2, /* the $TERMCAP environment variable */
103 dbdEnvList2, /* the $TERMPATH environment variable */
104 dbdCfgList2, /* the compiled-in TERMPATH */
110 #define MAX_CROSSLINKS 16
112 typedef struct entry ENTRY;
122 int *XNumbers; /* array of integer values */
124 ENTRY_USES uses[MAX_USES];
126 ENTRY *crosslinks[MAX_CROSSLINKS];
134 extern NCURSES_EXPORT_VAR(ENTRY *) _nc_head;
135 extern NCURSES_EXPORT_VAR(ENTRY *) _nc_tail;
136 #define for_entry_list(qp) for (qp = _nc_head; qp; qp = qp->next)
140 #define NULLHOOK (bool(*)(ENTRY *))0
143 * Note that WANTED and PRESENT are not simple inverses! If a capability
144 * has been explicitly cancelled, it's not considered WANTED.
146 #define WANTED(s) ((s) == ABSENT_STRING)
147 #define PRESENT(s) (((s) != ABSENT_STRING) && ((s) != CANCELLED_STRING))
149 #define ANDMISSING(p,q) \
151 if (PRESENT(p) && !PRESENT(q)) \
152 _nc_warning(#p " but no " #q); \
155 #define PAIRED(p,q) \
157 if (PRESENT(q) && !PRESENT(p)) \
158 _nc_warning(#q " but no " #p); \
159 if (PRESENT(p) && !PRESENT(q)) \
160 _nc_warning(#p " but no " #q); \
164 * These entrypoints are used only by the ncurses utilities such as tic.
167 /* alloc_entry.c: elementary allocation code */
168 extern NCURSES_EXPORT(ENTRY *) _nc_copy_entry (ENTRY *oldp);
169 extern NCURSES_EXPORT(char *) _nc_save_str (const char *const);
170 extern NCURSES_EXPORT(void) _nc_init_entry (TERMTYPE *const);
171 extern NCURSES_EXPORT(void) _nc_merge_entry (TERMTYPE *const, TERMTYPE *const);
172 extern NCURSES_EXPORT(void) _nc_wrap_entry (ENTRY *const, bool);
174 /* alloc_ttype.c: elementary allocation code */
175 extern NCURSES_EXPORT(void) _nc_align_termtype (TERMTYPE *, TERMTYPE *);
177 /* lib_termcap.c: trim sgr0 string for termcap users */
178 extern NCURSES_EXPORT(char *) _nc_trim_sgr0 (TERMTYPE *);
180 /* parse_entry.c: entry-parsing code */
182 extern NCURSES_EXPORT_VAR(bool) _nc_user_definable;
183 extern NCURSES_EXPORT_VAR(bool) _nc_disable_period;
185 extern NCURSES_EXPORT(int) _nc_parse_entry (ENTRY *, int, bool);
186 extern NCURSES_EXPORT(int) _nc_capcmp (const char *, const char *);
188 /* write_entry.c: writing an entry to the file system */
189 extern NCURSES_EXPORT(void) _nc_set_writedir (const char *);
190 extern NCURSES_EXPORT(void) _nc_write_entry (TERMTYPE *const);
191 extern NCURSES_EXPORT(int) _nc_write_object(TERMTYPE *, char *, unsigned *, unsigned);
193 /* comp_parse.c: entry list handling */
194 extern NCURSES_EXPORT(void) _nc_read_entry_source (FILE*, char*, int, bool, bool (*)(ENTRY*));
195 extern NCURSES_EXPORT(bool) _nc_entry_match (char *, char *);
196 extern NCURSES_EXPORT(int) _nc_resolve_uses (bool); /* obs 20040705 */
197 extern NCURSES_EXPORT(int) _nc_resolve_uses2 (bool, bool);
198 extern NCURSES_EXPORT(void) _nc_free_entries (ENTRY *);
199 extern NCURSES_IMPEXP void NCURSES_API (*_nc_check_termtype)(TERMTYPE *); /* obs 20040705 */
200 extern NCURSES_IMPEXP void NCURSES_API (*_nc_check_termtype2)(TERMTYPE *, bool);
203 extern NCURSES_EXPORT(void) _nc_trace_xnames (TERMTYPE *);
205 #endif /* NCURSES_INTERNALS */
208 * These entrypoints are used by tack.
211 /* alloc_ttype.c: elementary allocation code */
212 extern NCURSES_EXPORT(void) _nc_copy_termtype (TERMTYPE *, const TERMTYPE *);
215 extern NCURSES_EXPORT(void) _nc_init_acs (void); /* corresponds to traditional 'init_acs()' */
217 /* free_ttype.c: elementary allocation code */
218 extern NCURSES_EXPORT(void) _nc_free_termtype (TERMTYPE *);
226 #endif /* NCURSES_TERM_ENTRY_H_incl */