ncurses 6.0 - patch 20171111
[ncurses.git] / include / term_entry.h
1 /****************************************************************************
2  * Copyright (c) 1998-2015,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                        1998-on                 *
33  ****************************************************************************/
34
35 /* $Id: term_entry.h,v 1.55 2017/04/06 22:45:34 tom Exp $ */
36
37 /*
38  *      term_entry.h -- interface to entry-manipulation code
39  */
40
41 #ifndef NCURSES_TERM_ENTRY_H_incl
42 #define NCURSES_TERM_ENTRY_H_incl 1
43 /* *INDENT-OFF* */
44
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48
49 #include <term.h>
50
51 /*
52  * These macros may be used by programs that know about TERMTYPE:
53  */
54 #if NCURSES_XNAMES
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]
59 #else
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]
64 #endif
65
66 #define NUM_EXT_NAMES(tp) (unsigned) ((tp)->ext_Booleans + (tp)->ext_Numbers + (tp)->ext_Strings)
67
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++)
71
72 #if NCURSES_XNAMES
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++)
76 #endif
77
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)
81
82 /*
83  * The remaining type-definitions and macros are used only internally by the
84  * ncurses utilities.
85  */
86 #ifdef NCURSES_INTERNALS
87
88 /*
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.
91  */
92 typedef enum {
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 */
100 #endif
101 #if NCURSES_USE_TERMCAP
102         dbdEnvOnce2,            /* the $TERMCAP environment variable */
103         dbdEnvList2,            /* the $TERMPATH environment variable */
104         dbdCfgList2,            /* the compiled-in TERMPATH */
105 #endif
106         dbdLAST
107 } DBDIRS;
108
109 #define MAX_USES        32
110 #define MAX_CROSSLINKS  16
111
112 typedef struct entry ENTRY;
113
114 typedef struct {
115         char *name;
116         ENTRY *link;
117         long line;
118 } ENTRY_USES;
119
120 struct entry {
121         TERMTYPE2 tterm;
122         unsigned nuses;
123         ENTRY_USES uses[MAX_USES];
124         int ncrosslinks;
125         ENTRY *crosslinks[MAX_CROSSLINKS];
126         long cstart;
127         long cend;
128         long startline;
129         ENTRY *next;
130         ENTRY *last;
131 };
132
133 extern NCURSES_EXPORT_VAR(ENTRY *) _nc_head;
134 extern NCURSES_EXPORT_VAR(ENTRY *) _nc_tail;
135 #define for_entry_list(qp)      for (qp = _nc_head; qp; qp = qp->next)
136
137 #define MAX_LINE        132
138
139 #define NULLHOOK        (bool(*)(ENTRY *))0
140
141 /*
142  * Note that WANTED and PRESENT are not simple inverses!  If a capability
143  * has been explicitly cancelled, it's not considered WANTED.
144  */
145 #define WANTED(s)       ((s) == ABSENT_STRING)
146 #define PRESENT(s)      (((s) != ABSENT_STRING) && ((s) != CANCELLED_STRING))
147
148 #define ANDMISSING(p,q) \
149                 { \
150                 if (PRESENT(p) && !PRESENT(q)) \
151                         _nc_warning(#p " but no " #q); \
152                 }
153
154 #define PAIRED(p,q) \
155                 { \
156                 if (PRESENT(q) && !PRESENT(p)) \
157                         _nc_warning(#q " but no " #p); \
158                 if (PRESENT(p) && !PRESENT(q)) \
159                         _nc_warning(#p " but no " #q); \
160                 }
161
162 /*
163  * These entrypoints are used only by the ncurses utilities such as tic.
164  */
165
166 /* alloc_entry.c: elementary allocation code */
167 extern NCURSES_EXPORT(ENTRY *) _nc_copy_entry (ENTRY *oldp);
168 extern NCURSES_EXPORT(char *) _nc_save_str (const char *const);
169 extern NCURSES_EXPORT(void) _nc_init_entry (ENTRY *const);
170 extern NCURSES_EXPORT(void) _nc_merge_entry (ENTRY *const, ENTRY *const);
171 extern NCURSES_EXPORT(void) _nc_wrap_entry (ENTRY *const, bool);
172
173 /* alloc_ttype.c: elementary allocation code */
174 extern NCURSES_EXPORT(void) _nc_align_termtype (TERMTYPE2 *, TERMTYPE2 *);
175
176 /* free_ttype.c: elementary allocation code */
177 extern NCURSES_EXPORT(void) _nc_free_termtype2 (TERMTYPE2 *);
178
179 /* lib_termcap.c: trim sgr0 string for termcap users */
180 extern NCURSES_EXPORT(char *) _nc_trim_sgr0 (TERMTYPE2 *);
181
182 /* parse_entry.c: entry-parsing code */
183 #if NCURSES_XNAMES
184 extern NCURSES_EXPORT_VAR(bool) _nc_user_definable;
185 extern NCURSES_EXPORT_VAR(bool) _nc_disable_period;
186 #endif
187 extern NCURSES_EXPORT(int) _nc_parse_entry (ENTRY *, int, bool);
188 extern NCURSES_EXPORT(int) _nc_capcmp (const char *, const char *);
189
190 /* write_entry.c: writing an entry to the file system */
191 extern NCURSES_EXPORT(void) _nc_set_writedir (const char *);
192 extern NCURSES_EXPORT(void) _nc_write_entry (TERMTYPE2 *const);
193 extern NCURSES_EXPORT(int) _nc_write_object (TERMTYPE2 *, char *, unsigned *, unsigned);
194
195 /* comp_parse.c: entry list handling */
196 extern NCURSES_EXPORT(void) _nc_read_entry_source (FILE*, char*, int, bool, bool (*)(ENTRY*));
197 extern NCURSES_EXPORT(bool) _nc_entry_match (char *, char *);
198 extern NCURSES_EXPORT(int) _nc_resolve_uses (bool); /* obs 20040705 */
199 extern NCURSES_EXPORT(int) _nc_resolve_uses2 (bool, bool);
200 extern NCURSES_EXPORT(void) _nc_free_entries (ENTRY *);
201 extern NCURSES_IMPEXP void NCURSES_API (*_nc_check_termtype)(TERMTYPE *); /* obs 20040705 */
202 extern NCURSES_IMPEXP void NCURSES_API (*_nc_check_termtype2)(TERMTYPE2 *, bool);
203
204 /* trace_xnames.c */
205 extern NCURSES_EXPORT(void) _nc_trace_xnames (TERMTYPE *);
206
207 #endif /* NCURSES_INTERNALS */
208
209 /*
210  * These entrypoints are used by tack.
211  */
212
213 /* alloc_ttype.c: elementary allocation code */
214 extern NCURSES_EXPORT(void) _nc_copy_termtype (TERMTYPE *, const TERMTYPE *);
215
216 /* lib_acs.c */
217 extern NCURSES_EXPORT(void) _nc_init_acs (void);        /* corresponds to traditional 'init_acs()' */
218
219 /* free_ttype.c: elementary allocation code */
220 extern NCURSES_EXPORT(void) _nc_free_termtype (TERMTYPE *);
221
222 #ifdef __cplusplus
223 }
224 #endif
225
226 /* *INDENT-ON* */
227
228 #endif /* NCURSES_TERM_ENTRY_H_incl */