include/term_entry.h

   1 /****************************************************************************
   2  * Copyright (c) 1998-2017,2018 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.57 2018/05/26 13:50:53 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 <curses.h>
  50 #include <term.h>
  51
  52 /*
  53  * These macros may be used by programs that know about TERMTYPE:
  54  */
  55 #if NCURSES_XNAMES
  56 #define NUM_BOOLEANS(tp) (tp)->num_Booleans
  57 #define NUM_NUMBERS(tp)  (tp)->num_Numbers
  58 #define NUM_STRINGS(tp)  (tp)->num_Strings
  59 #define EXT_NAMES(tp,i,limit,index,table) (i >= limit) ? tp->ext_Names[index] : table[i]
  60 #else
  61 #define NUM_BOOLEANS(tp) BOOLCOUNT
  62 #define NUM_NUMBERS(tp)  NUMCOUNT
  63 #define NUM_STRINGS(tp)  STRCOUNT
  64 #define EXT_NAMES(tp,i,limit,index,table) table[i]
  65 #endif
  66
  67 #define NUM_EXT_NAMES(tp) (unsigned) ((tp)->ext_Booleans + (tp)->ext_Numbers + (tp)->ext_Strings)
  68
  69 #define for_each_boolean(n,tp) for(n = 0; n < NUM_BOOLEANS(tp); n++)
  70 #define for_each_number(n,tp)  for(n = 0; n < NUM_NUMBERS(tp);  n++)
  71 #define for_each_string(n,tp)  for(n = 0; n < NUM_STRINGS(tp);  n++)
  72
  73 #if NCURSES_XNAMES
  74 #define for_each_ext_boolean(n,tp) for(n = BOOLCOUNT; (int) n < (int) NUM_BOOLEANS(tp); n++)
  75 #define for_each_ext_number(n,tp)  for(n = NUMCOUNT; (int) n < (int) NUM_NUMBERS(tp);  n++)
  76 #define for_each_ext_string(n,tp)  for(n = STRCOUNT; (int) n < (int) NUM_STRINGS(tp);  n++)
  77 #endif
  78
  79 #define ExtBoolname(tp,i,names) EXT_NAMES(tp, i, BOOLCOUNT, (i - (tp->num_Booleans - tp->ext_Booleans)), names)
  80 #define ExtNumname(tp,i,names)  EXT_NAMES(tp, i, NUMCOUNT, (i - (tp->num_Numbers - tp->ext_Numbers)) + tp->ext_Booleans, names)
  81 #define ExtStrname(tp,i,names)  EXT_NAMES(tp, i, STRCOUNT, (i - (tp->num_Strings - tp->ext_Strings)) + (tp->ext_Numbers + tp->ext_Booleans), names)
  82
  83 /*
  84  * The remaining type-definitions and macros are used only internally by the
  85  * ncurses utilities.
  86  */
  87 #ifdef NCURSES_INTERNALS
  88
  89 /*
  90  * see db_iterator.c - this enumeration lists the places searched for a
  91  * terminal description and defines the order in which they are searched.
  92  */
  93 typedef enum {
  94         dbdTIC = 0,             /* special, used by tic when writing entry */
  95 #if NCURSES_USE_DATABASE
  96         dbdEnvOnce,             /* the $TERMINFO environment variable */
  97         dbdHome,                /* $HOME/.terminfo */
  98         dbdEnvList,             /* the $TERMINFO_DIRS environment variable */
  99         dbdCfgList,             /* the compiled-in TERMINFO_DIRS value */
 100         dbdCfgOnce,             /* the compiled-in TERMINFO value */
 101 #endif
 102 #if NCURSES_USE_TERMCAP
 103         dbdEnvOnce2,            /* the $TERMCAP environment variable */
 104         dbdEnvList2,            /* the $TERMPATH environment variable */
 105         dbdCfgList2,            /* the compiled-in TERMPATH */
 106 #endif
 107         dbdLAST
 108 } DBDIRS;
 109
 110 #define MAX_USES        32
 111 #define MAX_CROSSLINKS  16
 112
 113 typedef struct entry ENTRY;
 114
 115 typedef struct {
 116         char *name;
 117         ENTRY *link;
 118         long line;
 119 } ENTRY_USES;
 120
 121 struct entry {
 122         TERMTYPE2 tterm;
 123         unsigned nuses;
 124         ENTRY_USES uses[MAX_USES];
 125         int ncrosslinks;
 126         ENTRY *crosslinks[MAX_CROSSLINKS];
 127         long cstart;
 128         long cend;
 129         long startline;
 130         ENTRY *next;
 131         ENTRY *last;
 132 };
 133
 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)
 137
 138 #define MAX_LINE        132
 139
 140 #define NULLHOOK        (bool(*)(ENTRY *))0
 141
 142 /*
 143  * Note that WANTED and PRESENT are not simple inverses!  If a capability
 144  * has been explicitly cancelled, it's not considered WANTED.
 145  */
 146 #define WANTED(s)       ((s) == ABSENT_STRING)
 147 #define PRESENT(s)      (((s) != ABSENT_STRING) && ((s) != CANCELLED_STRING))
 148
 149 #define ANDMISSING(p,q) \
 150                 { \
 151                 if (PRESENT(p) && !PRESENT(q)) \
 152                         _nc_warning(#p " but no " #q); \
 153                 }
 154
 155 #define PAIRED(p,q) \
 156                 { \
 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); \
 161                 }
 162
 163 /*
 164  * These entrypoints are used only by the ncurses utilities such as tic.
 165  */
 166
 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 (ENTRY *const);
 171 extern NCURSES_EXPORT(void) _nc_merge_entry (ENTRY *const, ENTRY *const);
 172 extern NCURSES_EXPORT(void) _nc_wrap_entry (ENTRY *const, bool);
 173
 174 /* alloc_ttype.c: elementary allocation code */
 175 extern NCURSES_EXPORT(void) _nc_align_termtype (TERMTYPE2 *, TERMTYPE2 *);
 176
 177 /* free_ttype.c: elementary allocation code */
 178 extern NCURSES_EXPORT(void) _nc_free_termtype2 (TERMTYPE2 *);
 179
 180 /* lib_termcap.c: trim sgr0 string for termcap users */
 181 extern NCURSES_EXPORT(char *) _nc_trim_sgr0 (TERMTYPE2 *);
 182
 183 /* parse_entry.c: entry-parsing code */
 184 #if NCURSES_XNAMES
 185 extern NCURSES_EXPORT_VAR(bool) _nc_user_definable;
 186 extern NCURSES_EXPORT_VAR(bool) _nc_disable_period;
 187 #endif
 188 extern NCURSES_EXPORT(int) _nc_parse_entry (ENTRY *, int, bool);
 189 extern NCURSES_EXPORT(int) _nc_capcmp (const char *, const char *);
 190
 191 /* write_entry.c: writing an entry to the file system */
 192 extern NCURSES_EXPORT(void) _nc_set_writedir (const char *);
 193 extern NCURSES_EXPORT(void) _nc_write_entry (TERMTYPE2 *const);
 194 extern NCURSES_EXPORT(int) _nc_write_object (TERMTYPE2 *, char *, unsigned *, unsigned);
 195
 196 /* comp_parse.c: entry list handling */
 197 extern NCURSES_EXPORT(void) _nc_read_entry_source (FILE*, char*, int, bool, bool (*)(ENTRY*));
 198 extern NCURSES_EXPORT(bool) _nc_entry_match (char *, char *);
 199 extern NCURSES_EXPORT(int) _nc_resolve_uses (bool); /* obs 20040705 */
 200 extern NCURSES_EXPORT(int) _nc_resolve_uses2 (bool, bool);
 201 extern NCURSES_EXPORT(void) _nc_free_entries (ENTRY *);
 202 extern NCURSES_IMPEXP void NCURSES_API (*_nc_check_termtype)(TERMTYPE *); /* obs 20040705 */
 203 extern NCURSES_IMPEXP void NCURSES_API (*_nc_check_termtype2)(TERMTYPE2 *, bool);
 204
 205 /* trace_xnames.c */
 206 extern NCURSES_EXPORT(void) _nc_trace_xnames (TERMTYPE *);
 207
 208 #endif /* NCURSES_INTERNALS */
 209
 210 /*
 211  * These entrypoints are used by tack.
 212  */
 213
 214 #undef  NCURSES_TACK_1_08
 215 #ifdef  NCURSES_INTERNALS
 216 #define NCURSES_TACK_1_08 /* nothing */
 217 #else
 218 #define NCURSES_TACK_1_08 GCC_DEPRECATED("upgrade to tack 1.08")
 219 #endif
 220
 221 /* alloc_ttype.c: elementary allocation code */
 222 extern NCURSES_EXPORT(void) _nc_copy_termtype (TERMTYPE *, const TERMTYPE *) NCURSES_TACK_1_08;
 223
 224 /* lib_acs.c */
 225 extern NCURSES_EXPORT(void) _nc_init_acs (void) NCURSES_TACK_1_08;      /* corresponds to traditional 'init_acs()' */
 226
 227 /* free_ttype.c: elementary allocation code */
 228 extern NCURSES_EXPORT(void) _nc_free_termtype (TERMTYPE *) NCURSES_TACK_1_08;
 229
 230 #ifdef __cplusplus
 231 }
 232 #endif
 233
 234 /* *INDENT-ON* */
 235
 236 #endif /* NCURSES_TERM_ENTRY_H_incl */