include/term_entry.h

   1 /****************************************************************************
   2  * Copyright 2018-2020,2021 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.61 2021/09/04 10:52:55 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
 139 #define MAX_LINE        132
 140
 141 #define NULLHOOK        (bool(*)(ENTRY *))0
 142
 143 /*
 144  * Note that WANTED and PRESENT are not simple inverses!  If a capability
 145  * has been explicitly cancelled, it is not considered WANTED.
 146  */
 147 #define WANTED(s)       ((s) == ABSENT_STRING)
 148 #define PRESENT(s)      (((s) != ABSENT_STRING) && ((s) != CANCELLED_STRING))
 149
 150 #define ANDMISSING(p,q) \
 151                 { \
 152                 if (PRESENT(p) && !PRESENT(q)) \
 153                         _nc_warning(#p " but no " #q); \
 154                 }
 155
 156 #define PAIRED(p,q) \
 157                 { \
 158                 if (PRESENT(q) && !PRESENT(p)) \
 159                         _nc_warning(#q " but no " #p); \
 160                 if (PRESENT(p) && !PRESENT(q)) \
 161                         _nc_warning(#p " but no " #q); \
 162                 }
 163
 164 /*
 165  * These entrypoints are used only by the ncurses utilities such as tic.
 166  */
 167
 168 /* alloc_entry.c: elementary allocation code */
 169 extern NCURSES_EXPORT(ENTRY *) _nc_copy_entry (ENTRY *oldp);
 170 extern NCURSES_EXPORT(char *) _nc_save_str (const char *const);
 171 extern NCURSES_EXPORT(void) _nc_init_entry (ENTRY *const);
 172 extern NCURSES_EXPORT(void) _nc_merge_entry (ENTRY *const, ENTRY *const);
 173 extern NCURSES_EXPORT(void) _nc_wrap_entry (ENTRY *const, bool);
 174
 175 /* alloc_ttype.c: elementary allocation code */
 176 extern NCURSES_EXPORT(void) _nc_align_termtype (TERMTYPE2 *, TERMTYPE2 *);
 177
 178 /* free_ttype.c: elementary allocation code */
 179 extern NCURSES_EXPORT(void) _nc_free_termtype2 (TERMTYPE2 *);
 180
 181 /* lib_termcap.c: trim sgr0 string for termcap users */
 182 extern NCURSES_EXPORT(char *) _nc_trim_sgr0 (TERMTYPE2 *);
 183
 184 /* parse_entry.c: entry-parsing code */
 185 #if NCURSES_XNAMES
 186 extern NCURSES_EXPORT_VAR(bool) _nc_user_definable;
 187 extern NCURSES_EXPORT_VAR(bool) _nc_disable_period;
 188 #endif
 189 extern NCURSES_EXPORT(int) _nc_parse_entry (ENTRY *, int, bool);
 190 extern NCURSES_EXPORT(int) _nc_capcmp (const char *, const char *);
 191
 192 /* write_entry.c: writing an entry to the file system */
 193 extern NCURSES_EXPORT(void) _nc_set_writedir (const char *);
 194 extern NCURSES_EXPORT(void) _nc_write_entry (TERMTYPE2 *const);
 195 extern NCURSES_EXPORT(int) _nc_write_object (TERMTYPE2 *, char *, unsigned *, unsigned);
 196
 197 /* comp_parse.c: entry list handling */
 198 extern NCURSES_EXPORT(void) _nc_read_entry_source (FILE*, char*, int, bool, bool (*)(ENTRY*));
 199 extern NCURSES_EXPORT(bool) _nc_entry_match (char *, char *);
 200 extern NCURSES_EXPORT(int) _nc_resolve_uses (bool); /* obs 20040705 */
 201 extern NCURSES_EXPORT(int) _nc_resolve_uses2 (bool, bool);
 202 extern NCURSES_EXPORT(void) _nc_free_entries (ENTRY *);
 203 extern NCURSES_IMPEXP void (NCURSES_API *_nc_check_termtype)(TERMTYPE *); /* obs 20040705 */
 204 extern NCURSES_IMPEXP void (NCURSES_API *_nc_check_termtype2)(TERMTYPE2 *, bool);
 205
 206 /* trace_xnames.c */
 207 extern NCURSES_EXPORT(void) _nc_trace_xnames (TERMTYPE *);
 208
 209 #endif /* NCURSES_INTERNALS */
 210
 211 /*
 212  * These entrypoints were used by tack before 1.08.
 213  */
 214
 215 #undef  NCURSES_TACK_1_08
 216 #ifdef  NCURSES_INTERNALS
 217 #define NCURSES_TACK_1_08 /* nothing */
 218 #else
 219 #define NCURSES_TACK_1_08 GCC_DEPRECATED("upgrade to tack 1.08")
 220 #endif
 221
 222 /* alloc_ttype.c: elementary allocation code */
 223 extern NCURSES_EXPORT(void) _nc_copy_termtype (TERMTYPE *, const TERMTYPE *) NCURSES_TACK_1_08;
 224
 225 /* lib_acs.c */
 226 extern NCURSES_EXPORT(void) _nc_init_acs (void) NCURSES_TACK_1_08;      /* corresponds to traditional 'init_acs()' */
 227
 228 /* free_ttype.c: elementary allocation code */
 229 extern NCURSES_EXPORT(void) _nc_free_termtype (TERMTYPE *) NCURSES_TACK_1_08;
 230
 231 #ifdef __cplusplus
 232 }
 233 #endif
 234
 235 /* *INDENT-ON* */
 236
 237 #endif /* NCURSES_TERM_ENTRY_H_incl */