jpayne@69: /**************************************************************************** jpayne@69: * Copyright 2018-2022,2023 Thomas E. Dickey * jpayne@69: * Copyright 1998-2015,2017 Free Software Foundation, Inc. * jpayne@69: * * jpayne@69: * Permission is hereby granted, free of charge, to any person obtaining a * jpayne@69: * copy of this software and associated documentation files (the * jpayne@69: * "Software"), to deal in the Software without restriction, including * jpayne@69: * without limitation the rights to use, copy, modify, merge, publish, * jpayne@69: * distribute, distribute with modifications, sublicense, and/or sell * jpayne@69: * copies of the Software, and to permit persons to whom the Software is * jpayne@69: * furnished to do so, subject to the following conditions: * jpayne@69: * * jpayne@69: * The above copyright notice and this permission notice shall be included * jpayne@69: * in all copies or substantial portions of the Software. * jpayne@69: * * jpayne@69: * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * jpayne@69: * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * jpayne@69: * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * jpayne@69: * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * jpayne@69: * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * jpayne@69: * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * jpayne@69: * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * jpayne@69: * * jpayne@69: * Except as contained in this notice, the name(s) of the above copyright * jpayne@69: * holders shall not be used in advertising or otherwise to promote the * jpayne@69: * sale, use or other dealings in this Software without prior written * jpayne@69: * authorization. * jpayne@69: ****************************************************************************/ jpayne@69: jpayne@69: /**************************************************************************** jpayne@69: * Author: Zeyd M. Ben-Halim 1992,1995 * jpayne@69: * and: Eric S. Raymond * jpayne@69: * and: Thomas E. Dickey 1998-on * jpayne@69: ****************************************************************************/ jpayne@69: jpayne@69: /* $Id: term_entry.h,v 1.64 2023/04/22 13:37:14 tom Exp $ */ jpayne@69: jpayne@69: /* jpayne@69: * term_entry.h -- interface to entry-manipulation code jpayne@69: */ jpayne@69: jpayne@69: #ifndef NCURSES_TERM_ENTRY_H_incl jpayne@69: #define NCURSES_TERM_ENTRY_H_incl 1 jpayne@69: /* *INDENT-OFF* */ jpayne@69: jpayne@69: #ifdef __cplusplus jpayne@69: extern "C" { jpayne@69: #endif jpayne@69: jpayne@69: #include jpayne@69: #include jpayne@69: jpayne@69: /* jpayne@69: * These macros may be used by programs that know about TERMTYPE: jpayne@69: */ jpayne@69: #if NCURSES_XNAMES jpayne@69: #define NUM_BOOLEANS(tp) (tp)->num_Booleans jpayne@69: #define NUM_NUMBERS(tp) (tp)->num_Numbers jpayne@69: #define NUM_STRINGS(tp) (tp)->num_Strings jpayne@69: #define EXT_NAMES(tp,i,limit,index,table) (i >= limit) ? tp->ext_Names[index] : table[i] jpayne@69: #else jpayne@69: #define NUM_BOOLEANS(tp) BOOLCOUNT jpayne@69: #define NUM_NUMBERS(tp) NUMCOUNT jpayne@69: #define NUM_STRINGS(tp) STRCOUNT jpayne@69: #define EXT_NAMES(tp,i,limit,index,table) table[i] jpayne@69: #endif jpayne@69: jpayne@69: #define NUM_EXT_NAMES(tp) (unsigned) ((tp)->ext_Booleans + (tp)->ext_Numbers + (tp)->ext_Strings) jpayne@69: jpayne@69: #define for_each_boolean(n,tp) for(n = 0; n < NUM_BOOLEANS(tp); n++) jpayne@69: #define for_each_number(n,tp) for(n = 0; n < NUM_NUMBERS(tp); n++) jpayne@69: #define for_each_string(n,tp) for(n = 0; n < NUM_STRINGS(tp); n++) jpayne@69: jpayne@69: #if NCURSES_XNAMES jpayne@69: #define for_each_ext_boolean(n,tp) for(n = BOOLCOUNT; (int) n < (int) NUM_BOOLEANS(tp); n++) jpayne@69: #define for_each_ext_number(n,tp) for(n = NUMCOUNT; (int) n < (int) NUM_NUMBERS(tp); n++) jpayne@69: #define for_each_ext_string(n,tp) for(n = STRCOUNT; (int) n < (int) NUM_STRINGS(tp); n++) jpayne@69: #endif jpayne@69: jpayne@69: #define ExtBoolname(tp,i,names) EXT_NAMES(tp, i, BOOLCOUNT, (i - (tp->num_Booleans - tp->ext_Booleans)), names) jpayne@69: #define ExtNumname(tp,i,names) EXT_NAMES(tp, i, NUMCOUNT, (i - (tp->num_Numbers - tp->ext_Numbers)) + tp->ext_Booleans, names) jpayne@69: #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: jpayne@69: /* jpayne@69: * The remaining type-definitions and macros are used only internally by the jpayne@69: * ncurses utilities. jpayne@69: */ jpayne@69: #ifdef NCURSES_INTERNALS jpayne@69: jpayne@69: /* jpayne@69: * see db_iterator.c - this enumeration lists the places searched for a jpayne@69: * terminal description and defines the order in which they are searched. jpayne@69: */ jpayne@69: typedef enum { jpayne@69: dbdTIC = 0, /* special, used by tic when writing entry */ jpayne@69: #if NCURSES_USE_DATABASE jpayne@69: dbdEnvOnce, /* the $TERMINFO environment variable */ jpayne@69: dbdHome, /* $HOME/.terminfo */ jpayne@69: dbdEnvList, /* the $TERMINFO_DIRS environment variable */ jpayne@69: dbdCfgList, /* the compiled-in TERMINFO_DIRS value */ jpayne@69: dbdCfgOnce, /* the compiled-in TERMINFO value */ jpayne@69: #endif jpayne@69: #if NCURSES_USE_TERMCAP jpayne@69: dbdEnvOnce2, /* the $TERMCAP environment variable */ jpayne@69: dbdEnvList2, /* the $TERMPATH environment variable */ jpayne@69: dbdCfgList2, /* the compiled-in TERMPATH */ jpayne@69: #endif jpayne@69: dbdLAST jpayne@69: } DBDIRS; jpayne@69: jpayne@69: #define MAX_USES 32 jpayne@69: #define MAX_CROSSLINKS 16 jpayne@69: jpayne@69: typedef struct entry ENTRY; jpayne@69: jpayne@69: typedef struct { jpayne@69: char *name; jpayne@69: ENTRY *link; jpayne@69: long line; jpayne@69: } ENTRY_USES; jpayne@69: jpayne@69: struct entry { jpayne@69: TERMTYPE2 tterm; jpayne@69: unsigned nuses; jpayne@69: ENTRY_USES uses[MAX_USES]; jpayne@69: int ncrosslinks; jpayne@69: ENTRY *crosslinks[MAX_CROSSLINKS]; jpayne@69: long cstart; jpayne@69: long cend; jpayne@69: long startline; jpayne@69: ENTRY *next; jpayne@69: ENTRY *last; jpayne@69: }; jpayne@69: jpayne@69: extern NCURSES_EXPORT_VAR(ENTRY *) _nc_head; jpayne@69: extern NCURSES_EXPORT_VAR(ENTRY *) _nc_tail; jpayne@69: #define for_entry_list(qp) for (qp = _nc_head; qp; qp = qp->next) jpayne@69: #define for_entry_list2(qp,q0) for (qp = q0; qp; qp = qp->next) jpayne@69: jpayne@69: #define MAX_LINE 132 jpayne@69: jpayne@69: #define NULLHOOK (bool(*)(ENTRY *))0 jpayne@69: jpayne@69: /* jpayne@69: * Note that WANTED and PRESENT are not simple inverses! If a capability jpayne@69: * has been explicitly cancelled, it is not considered WANTED. jpayne@69: */ jpayne@69: #define WANTED(s) ((s) == ABSENT_STRING) jpayne@69: #define PRESENT(s) (((s) != ABSENT_STRING) && ((s) != CANCELLED_STRING)) jpayne@69: jpayne@69: #define ANDMISSING(p,q) \ jpayne@69: { \ jpayne@69: if (PRESENT(p) && !PRESENT(q)) \ jpayne@69: _nc_warning(#p " but no " #q); \ jpayne@69: } jpayne@69: jpayne@69: #define PAIRED(p,q) \ jpayne@69: { \ jpayne@69: if (PRESENT(q) && !PRESENT(p)) \ jpayne@69: _nc_warning(#q " but no " #p); \ jpayne@69: if (PRESENT(p) && !PRESENT(q)) \ jpayne@69: _nc_warning(#p " but no " #q); \ jpayne@69: } jpayne@69: jpayne@69: /* jpayne@69: * These entrypoints are used only by the ncurses utilities such as tic. jpayne@69: */ jpayne@69: jpayne@69: /* alloc_entry.c: elementary allocation code */ jpayne@69: extern NCURSES_EXPORT(ENTRY *) _nc_copy_entry (ENTRY *oldp); jpayne@69: extern NCURSES_EXPORT(char *) _nc_save_str (const char *const); jpayne@69: extern NCURSES_EXPORT(void) _nc_init_entry (ENTRY *const); jpayne@69: extern NCURSES_EXPORT(void) _nc_merge_entry (ENTRY *const, ENTRY *const); jpayne@69: extern NCURSES_EXPORT(void) _nc_wrap_entry (ENTRY *const, bool); jpayne@69: jpayne@69: /* alloc_ttype.c: elementary allocation code */ jpayne@69: extern NCURSES_EXPORT(void) _nc_align_termtype (TERMTYPE2 *, TERMTYPE2 *); jpayne@69: jpayne@69: /* free_ttype.c: elementary allocation code */ jpayne@69: extern NCURSES_EXPORT(void) _nc_free_termtype (TERMTYPE *); jpayne@69: extern NCURSES_EXPORT(void) _nc_free_termtype1 (TERMTYPE *); jpayne@69: extern NCURSES_EXPORT(void) _nc_free_termtype2 (TERMTYPE2 *); jpayne@69: jpayne@69: /* lib_termcap.c: trim sgr0 string for termcap users */ jpayne@69: extern NCURSES_EXPORT(char *) _nc_trim_sgr0 (TERMTYPE2 *); jpayne@69: jpayne@69: /* parse_entry.c: entry-parsing code */ jpayne@69: #if NCURSES_XNAMES jpayne@69: extern NCURSES_EXPORT_VAR(bool) _nc_user_definable; jpayne@69: extern NCURSES_EXPORT_VAR(bool) _nc_disable_period; jpayne@69: #endif jpayne@69: extern NCURSES_EXPORT(int) _nc_parse_entry (ENTRY *, int, bool); jpayne@69: extern NCURSES_EXPORT(int) _nc_capcmp (const char *, const char *); jpayne@69: jpayne@69: /* write_entry.c: writing an entry to the file system */ jpayne@69: extern NCURSES_EXPORT(void) _nc_set_writedir (const char *); jpayne@69: extern NCURSES_EXPORT(void) _nc_write_entry (TERMTYPE2 *const); jpayne@69: extern NCURSES_EXPORT(int) _nc_write_object (TERMTYPE2 *, char *, unsigned *, unsigned); jpayne@69: jpayne@69: /* comp_parse.c: entry list handling */ jpayne@69: extern NCURSES_EXPORT(void) _nc_read_entry_source (FILE*, char*, int, bool, bool (*)(ENTRY*)); jpayne@69: extern NCURSES_EXPORT(bool) _nc_entry_match (char *, char *); jpayne@69: extern NCURSES_EXPORT(int) _nc_resolve_uses (bool); /* obs 20040705 */ jpayne@69: extern NCURSES_EXPORT(int) _nc_resolve_uses2 (bool, bool); jpayne@69: extern NCURSES_EXPORT(void) _nc_free_entries (ENTRY *); jpayne@69: extern NCURSES_IMPEXP void (NCURSES_API *_nc_check_termtype)(TERMTYPE *); /* obs 20040705 */ jpayne@69: extern NCURSES_IMPEXP void (NCURSES_API *_nc_check_termtype2)(TERMTYPE2 *, bool); jpayne@69: jpayne@69: /* trace_xnames.c */ jpayne@69: extern NCURSES_EXPORT(void) _nc_trace_xnames (TERMTYPE *); jpayne@69: jpayne@69: #endif /* NCURSES_INTERNALS */ jpayne@69: jpayne@69: #ifdef __cplusplus jpayne@69: } jpayne@69: #endif jpayne@69: jpayne@69: /* *INDENT-ON* */ jpayne@69: jpayne@69: #endif /* NCURSES_TERM_ENTRY_H_incl */