include/term_entry.h

   1 /****************************************************************************
   2  * Copyright (c) 1998 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  ****************************************************************************/
  33
  34
  35 /*
  36  *      term_entry.h -- interface to entry-manipulation code
  37  */
  38
  39 #ifndef _TERM_ENTRY_H
  40 #define _TERM_ENTRY_H
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 #include <term.h>
  47
  48 #define MAX_USES        32
  49
  50 typedef struct entry {
  51         TERMTYPE        tterm;
  52         int             nuses;
  53         struct
  54         {
  55             void        *parent;        /* (char *) or (ENTRY *) */
  56             long        line;
  57         }
  58         uses[MAX_USES];
  59         long            cstart, cend;
  60         long            startline;
  61         struct entry    *next;
  62         struct entry    *last;
  63 }
  64 ENTRY;
  65
  66 #if NCURSES_XNAMES
  67 #define NUM_BOOLEANS(tp) (tp)->num_Booleans
  68 #define NUM_NUMBERS(tp)  (tp)->num_Numbers
  69 #define NUM_STRINGS(tp)  (tp)->num_Strings
  70 #define EXT_NAMES(tp,i,limit,index,table) (i >= limit) ? tp->ext_Names[index] : table[i]
  71 #else
  72 #define NUM_BOOLEANS(tp) BOOLCOUNT
  73 #define NUM_NUMBERS(tp)  NUMCOUNT
  74 #define NUM_STRINGS(tp)  STRCOUNT
  75 #define EXT_NAMES(tp,i,limit,index,table) table[i]
  76 #endif
  77
  78 #define NUM_EXT_NAMES(tp) ((tp)->ext_Booleans + (tp)->ext_Numbers + (tp)->ext_Strings)
  79
  80 #define for_each_boolean(n,tp) for(n = 0; n < NUM_BOOLEANS(tp); n++)
  81 #define for_each_number(n,tp)  for(n = 0; n < NUM_NUMBERS(tp);  n++)
  82 #define for_each_string(n,tp)  for(n = 0; n < NUM_STRINGS(tp);  n++)
  83
  84 #define ExtBoolname(tp,i,names) EXT_NAMES(tp, i, BOOLCOUNT, (i - (tp->num_Booleans - tp->ext_Booleans)), names)
  85 #define ExtNumname(tp,i,names)  EXT_NAMES(tp, i, NUMCOUNT, (i - (tp->num_Numbers - tp->ext_Numbers)) + tp->ext_Booleans, names)
  86 #define ExtStrname(tp,i,names)  EXT_NAMES(tp, i, STRCOUNT, (i - (tp->num_Strings - tp->ext_Strings)) + (tp->ext_Numbers + tp->ext_Booleans), names)
  87
  88 extern ENTRY    *_nc_head, *_nc_tail;
  89 #define for_entry_list(qp)      for (qp = _nc_head; qp; qp = qp->next)
  90
  91 #define MAX_LINE        132
  92
  93 #define NULLHOOK        (bool(*)(ENTRY *))0
  94
  95 /*
  96  * Note that WANTED and PRESENT are not simple inverses!  If a capability
  97  * has been explicitly cancelled, it's not considered WANTED.
  98  */
  99 #define WANTED(s)       ((s) == ABSENT_STRING)
 100 #define PRESENT(s)      (((s) != ABSENT_STRING) && ((s) != CANCELLED_STRING))
 101
 102 #define ANDMISSING(p,q) \
 103                 {if (PRESENT(p) && !PRESENT(q)) _nc_warning(#p " but no " #q);}
 104
 105 #define PAIRED(p,q) \
 106                 { \
 107                 if (PRESENT(q) && !PRESENT(p)) \
 108                         _nc_warning(#q " but no " #p); \
 109                 if (PRESENT(p) && !PRESENT(q)) \
 110                         _nc_warning(#p " but no " #q); \
 111                 }
 112
 113 /* alloc_entry.c: elementary allocation code */
 114 extern ENTRY *_nc_copy_entry(ENTRY *oldp);
 115 extern char *_nc_save_str(const char *const);
 116 extern void _nc_init_entry(TERMTYPE *const);
 117 extern void _nc_merge_entry(TERMTYPE *const, TERMTYPE *const);
 118 extern void _nc_wrap_entry(ENTRY *const);
 119
 120 /* alloc_ttype.c: elementary allocation code */
 121 extern void _nc_align_termtype(TERMTYPE *, TERMTYPE *);
 122 extern void _nc_copy_termtype(TERMTYPE *, TERMTYPE *);
 123
 124 /* free_ttype.c: elementary allocation code */
 125 extern void _nc_free_termtype(TERMTYPE *);
 126
 127 /* lib_acs.c */
 128 extern void _nc_init_acs(void); /* corresponds to traditional 'init_acs()' */
 129
 130 /* parse_entry.c: entry-parsing code */
 131 #if NCURSES_XNAMES
 132 extern bool _nc_user_definable;
 133 #endif
 134 extern int _nc_parse_entry(ENTRY *, int, bool);
 135 extern int _nc_capcmp(const char *, const char *);
 136
 137 /* write_entry.c: writing an entry to the file system */
 138 extern void _nc_set_writedir(char *);
 139 extern void _nc_write_entry(TERMTYPE *const);
 140
 141 /* comp_parse.c: entry list handling */
 142 extern void _nc_read_entry_source(FILE*, char*, int, bool, bool (*)(ENTRY*));
 143 extern bool _nc_entry_match(char *, char *);
 144 extern int _nc_resolve_uses(void);
 145 extern void _nc_free_entries(ENTRY *);
 146 extern void (*_nc_check_termtype)(TERMTYPE *);
 147
 148 /* trace_xnames.c */
 149 extern void _nc_trace_xnames(TERMTYPE *);
 150
 151 #ifdef __cplusplus
 152 }
 153 #endif
 154
 155 #endif /* _TERM_ENTRY_H */