1 /**************************************************************************** 2 * Copyright 2018-2022,2023 Thomas E. Dickey * 3 * Copyright 1998-2015,2017 Free Software Foundation, Inc. * 4 * * 5 * Permission is hereby granted, free of charge, to any person obtaining a * 6 * copy of this software and associated documentation files (the * 7 * "Software"), to deal in the Software without restriction, including * 8 * without limitation the rights to use, copy, modify, merge, publish, * 9 * distribute, distribute with modifications, sublicense, and/or sell * 10 * copies of the Software, and to permit persons to whom the Software is * 11 * furnished to do so, subject to the following conditions: * 12 * * 13 * The above copyright notice and this permission notice shall be included * 14 * in all copies or substantial portions of the Software. * 15 * * 16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * 17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * 18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * 19 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * 20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * 21 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * 22 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * 23 * * 24 * Except as contained in this notice, the name(s) of the above copyright * 25 * holders shall not be used in advertising or otherwise to promote the * 26 * sale, use or other dealings in this Software without prior written * 27 * authorization. * 28 ****************************************************************************/ 29 30 /**************************************************************************** 31 * Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 * 32 * and: Eric S. Raymond <esr@snark.thyrsus.com> * 33 * and: Thomas E. Dickey 1998-on * 34 ****************************************************************************/ 35 36 /* $Id: term_entry.h,v 1.64 2023/04/22 13:37:14 tom Exp $ */ 37 38 /* 39 * term_entry.h -- interface to entry-manipulation code 40 */ 41 42 #ifndef NCURSES_TERM_ENTRY_H_incl 43 #define NCURSES_TERM_ENTRY_H_incl 1 44 /* *INDENT-OFF* */ 45 46 #ifdef __cplusplus 47 extern "C" { 48 #endif 49 50 #include <curses.h> 51 #include <term.h> 52 53 /* 54 * These macros may be used by programs that know about TERMTYPE: 55 */ 56 #if NCURSES_XNAMES 57 #define NUM_BOOLEANS(tp) (tp)->num_Booleans 58 #define NUM_NUMBERS(tp) (tp)->num_Numbers 59 #define NUM_STRINGS(tp) (tp)->num_Strings 60 #define EXT_NAMES(tp,i,limit,index,table) (i >= limit) ? tp->ext_Names[index] : table[i] 61 #else 62 #define NUM_BOOLEANS(tp) BOOLCOUNT 63 #define NUM_NUMBERS(tp) NUMCOUNT 64 #define NUM_STRINGS(tp) STRCOUNT 65 #define EXT_NAMES(tp,i,limit,index,table) table[i] 66 #endif 67 68 #define NUM_EXT_NAMES(tp) (unsigned) ((tp)->ext_Booleans + (tp)->ext_Numbers + (tp)->ext_Strings) 69 70 #define for_each_boolean(n,tp) for(n = 0; n < NUM_BOOLEANS(tp); n++) 71 #define for_each_number(n,tp) for(n = 0; n < NUM_NUMBERS(tp); n++) 72 #define for_each_string(n,tp) for(n = 0; n < NUM_STRINGS(tp); n++) 73 74 #if NCURSES_XNAMES 75 #define for_each_ext_boolean(n,tp) for(n = BOOLCOUNT; (int) n < (int) NUM_BOOLEANS(tp); n++) 76 #define for_each_ext_number(n,tp) for(n = NUMCOUNT; (int) n < (int) NUM_NUMBERS(tp); n++) 77 #define for_each_ext_string(n,tp) for(n = STRCOUNT; (int) n < (int) NUM_STRINGS(tp); n++) 78 #endif 79 80 #define ExtBoolname(tp,i,names) EXT_NAMES(tp, i, BOOLCOUNT, (i - (tp->num_Booleans - tp->ext_Booleans)), names) 81 #define ExtNumname(tp,i,names) EXT_NAMES(tp, i, NUMCOUNT, (i - (tp->num_Numbers - tp->ext_Numbers)) + tp->ext_Booleans, names) 82 #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 84 /* 85 * The remaining type-definitions and macros are used only internally by the 86 * ncurses utilities. 87 */ 88 #ifdef NCURSES_INTERNALS 89 90 /* 91 * see db_iterator.c - this enumeration lists the places searched for a 92 * terminal description and defines the order in which they are searched. 93 */ 94 typedef enum { 95 dbdTIC = 0, /* special, used by tic when writing entry */ 96 #if NCURSES_USE_DATABASE 97 dbdEnvOnce, /* the $TERMINFO environment variable */ 98 dbdHome, /* $HOME/.terminfo */ 99 dbdEnvList, /* the $TERMINFO_DIRS environment variable */ 100 dbdCfgList, /* the compiled-in TERMINFO_DIRS value */ 101 dbdCfgOnce, /* the compiled-in TERMINFO value */ 102 #endif 103 #if NCURSES_USE_TERMCAP 104 dbdEnvOnce2, /* the $TERMCAP environment variable */ 105 dbdEnvList2, /* the $TERMPATH environment variable */ 106 dbdCfgList2, /* the compiled-in TERMPATH */ 107 #endif 108 dbdLAST 109 } DBDIRS; 110 111 #define MAX_USES 32 112 #define MAX_CROSSLINKS 16 113 114 typedef struct entry ENTRY; 115 116 typedef struct { 117 char *name; 118 ENTRY *link; 119 long line; 120 } ENTRY_USES; 121 122 struct entry { 123 TERMTYPE2 tterm; 124 unsigned nuses; 125 ENTRY_USES uses[MAX_USES]; 126 int ncrosslinks; 127 ENTRY *crosslinks[MAX_CROSSLINKS]; 128 long cstart; 129 long cend; 130 long startline; 131 ENTRY *next; 132 ENTRY *last; 133 }; 134 135 extern NCURSES_EXPORT_VAR(ENTRY *) _nc_head; 136 extern NCURSES_EXPORT_VAR(ENTRY *) _nc_tail; 137 #define for_entry_list(qp) for (qp = _nc_head; qp; qp = qp->next) 138 #define for_entry_list2(qp,q0) for (qp = q0; qp; qp = qp->next) 139 140 #define MAX_LINE 132 141 142 #define NULLHOOK (bool(*)(ENTRY *))0 143 144 /* 145 * Note that WANTED and PRESENT are not simple inverses! If a capability 146 * has been explicitly cancelled, it is not considered WANTED. 147 */ 148 #define WANTED(s) ((s) == ABSENT_STRING) 149 #define PRESENT(s) (((s) != ABSENT_STRING) && ((s) != CANCELLED_STRING)) 150 151 #define ANDMISSING(p,q) \ 152 { \ 153 if (PRESENT(p) && !PRESENT(q)) \ 154 _nc_warning(#p " but no " #q); \ 155 } 156 157 #define PAIRED(p,q) \ 158 { \ 159 if (PRESENT(q) && !PRESENT(p)) \ 160 _nc_warning(#q " but no " #p); \ 161 if (PRESENT(p) && !PRESENT(q)) \ 162 _nc_warning(#p " but no " #q); \ 163 } 164 165 /* 166 * These entrypoints are used only by the ncurses utilities such as tic. 167 */ 168 169 /* alloc_entry.c: elementary allocation code */ 170 extern NCURSES_EXPORT(ENTRY *) _nc_copy_entry (ENTRY *oldp); 171 extern NCURSES_EXPORT(char *) _nc_save_str (const char *const); 172 extern NCURSES_EXPORT(void) _nc_init_entry (ENTRY *const); 173 extern NCURSES_EXPORT(void) _nc_merge_entry (ENTRY *const, ENTRY *const); 174 extern NCURSES_EXPORT(void) _nc_wrap_entry (ENTRY *const, bool); 175 176 /* alloc_ttype.c: elementary allocation code */ 177 extern NCURSES_EXPORT(void) _nc_align_termtype (TERMTYPE2 *, TERMTYPE2 *); 178 179 /* free_ttype.c: elementary allocation code */ 180 extern NCURSES_EXPORT(void) _nc_free_termtype (TERMTYPE *); 181 extern NCURSES_EXPORT(void) _nc_free_termtype1 (TERMTYPE *); 182 extern NCURSES_EXPORT(void) _nc_free_termtype2 (TERMTYPE2 *); 183 184 /* lib_termcap.c: trim sgr0 string for termcap users */ 185 extern NCURSES_EXPORT(char *) _nc_trim_sgr0 (TERMTYPE2 *); 186 187 /* parse_entry.c: entry-parsing code */ 188 #if NCURSES_XNAMES 189 extern NCURSES_EXPORT_VAR(bool) _nc_user_definable; 190 extern NCURSES_EXPORT_VAR(bool) _nc_disable_period; 191 #endif 192 extern NCURSES_EXPORT(int) _nc_parse_entry (ENTRY *, int, bool); 193 extern NCURSES_EXPORT(int) _nc_capcmp (const char *, const char *); 194 195 /* write_entry.c: writing an entry to the file system */ 196 extern NCURSES_EXPORT(void) _nc_set_writedir (const char *); 197 extern NCURSES_EXPORT(void) _nc_write_entry (TERMTYPE2 *const); 198 extern NCURSES_EXPORT(int) _nc_write_object (TERMTYPE2 *, char *, unsigned *, unsigned); 199 200 /* comp_parse.c: entry list handling */ 201 extern NCURSES_EXPORT(void) _nc_read_entry_source (FILE*, char*, int, bool, bool (*)(ENTRY*)); 202 extern NCURSES_EXPORT(bool) _nc_entry_match (char *, char *); 203 extern NCURSES_EXPORT(int) _nc_resolve_uses (bool); /* obs 20040705 */ 204 extern NCURSES_EXPORT(int) _nc_resolve_uses2 (bool, bool); 205 extern NCURSES_EXPORT(void) _nc_free_entries (ENTRY *); 206 extern NCURSES_IMPEXP void (NCURSES_API *_nc_check_termtype)(TERMTYPE *); /* obs 20040705 */ 207 extern NCURSES_IMPEXP void (NCURSES_API *_nc_check_termtype2)(TERMTYPE2 *, bool); 208 209 /* trace_xnames.c */ 210 extern NCURSES_EXPORT(void) _nc_trace_xnames (TERMTYPE *); 211 212 #endif /* NCURSES_INTERNALS */ 213 214 #ifdef __cplusplus 215 } 216 #endif 217 218 /* *INDENT-ON* */ 219 220 #endif /* NCURSES_TERM_ENTRY_H_incl */ 221