Mercurial > repos > rliterman > csp2

annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/include/term_entry.h @ 69:33d812a61356

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