10e3d5408SPeter Wemm /**************************************************************************** 2*73f0a83dSXin LI * Copyright (c) 1998-2012,2013 Free Software Foundation, Inc. * 30e3d5408SPeter Wemm * * 40e3d5408SPeter Wemm * Permission is hereby granted, free of charge, to any person obtaining a * 50e3d5408SPeter Wemm * copy of this software and associated documentation files (the * 60e3d5408SPeter Wemm * "Software"), to deal in the Software without restriction, including * 70e3d5408SPeter Wemm * without limitation the rights to use, copy, modify, merge, publish, * 80e3d5408SPeter Wemm * distribute, distribute with modifications, sublicense, and/or sell * 90e3d5408SPeter Wemm * copies of the Software, and to permit persons to whom the Software is * 100e3d5408SPeter Wemm * furnished to do so, subject to the following conditions: * 110e3d5408SPeter Wemm * * 120e3d5408SPeter Wemm * The above copyright notice and this permission notice shall be included * 130e3d5408SPeter Wemm * in all copies or substantial portions of the Software. * 140e3d5408SPeter Wemm * * 150e3d5408SPeter Wemm * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * 160e3d5408SPeter Wemm * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * 170e3d5408SPeter Wemm * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * 180e3d5408SPeter Wemm * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * 190e3d5408SPeter Wemm * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * 200e3d5408SPeter Wemm * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * 210e3d5408SPeter Wemm * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * 220e3d5408SPeter Wemm * * 230e3d5408SPeter Wemm * Except as contained in this notice, the name(s) of the above copyright * 240e3d5408SPeter Wemm * holders shall not be used in advertising or otherwise to promote the * 250e3d5408SPeter Wemm * sale, use or other dealings in this Software without prior written * 260e3d5408SPeter Wemm * authorization. * 270e3d5408SPeter Wemm ****************************************************************************/ 280e3d5408SPeter Wemm 290e3d5408SPeter Wemm /**************************************************************************** 300e3d5408SPeter Wemm * Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 * 310e3d5408SPeter Wemm * and: Eric S. Raymond <esr@snark.thyrsus.com> * 325d08fb1fSRong-En Fan * and: Thomas E. Dickey 1998-on * 330e3d5408SPeter Wemm ****************************************************************************/ 340e3d5408SPeter Wemm 35*73f0a83dSXin LI /* $Id: term_entry.h,v 1.44 2013/05/25 20:13:38 tom Exp $ */ 360e3d5408SPeter Wemm 370e3d5408SPeter Wemm /* 380e3d5408SPeter Wemm * term_entry.h -- interface to entry-manipulation code 390e3d5408SPeter Wemm */ 400e3d5408SPeter Wemm 417a69bbfbSPeter Wemm #ifndef NCURSES_TERM_ENTRY_H_incl 427a69bbfbSPeter Wemm #define NCURSES_TERM_ENTRY_H_incl 1 430e3d5408SPeter Wemm 440e3d5408SPeter Wemm #ifdef __cplusplus 450e3d5408SPeter Wemm extern "C" { 460e3d5408SPeter Wemm #endif 470e3d5408SPeter Wemm 480e3d5408SPeter Wemm #include <term.h> 490e3d5408SPeter Wemm 50*73f0a83dSXin LI /* 51*73f0a83dSXin LI * see db_iterator.c - this enumeration lists the places searched for a 52*73f0a83dSXin LI * terminal description and defines the order in which they are searched. 53*73f0a83dSXin LI */ 54*73f0a83dSXin LI typedef enum { 55*73f0a83dSXin LI dbdTIC = 0, /* special, used by tic when writing entry */ 56*73f0a83dSXin LI #if NCURSES_USE_DATABASE 57*73f0a83dSXin LI dbdEnvOnce, /* the $TERMINFO environment variable */ 58*73f0a83dSXin LI dbdHome, /* $HOME/.terminfo */ 59*73f0a83dSXin LI dbdEnvList, /* the $TERMINFO_DIRS environment variable */ 60*73f0a83dSXin LI dbdCfgList, /* the compiled-in TERMINFO_DIRS value */ 61*73f0a83dSXin LI dbdCfgOnce, /* the compiled-in TERMINFO value */ 62*73f0a83dSXin LI #endif 63*73f0a83dSXin LI #if NCURSES_USE_TERMCAP 64*73f0a83dSXin LI dbdEnvOnce2, /* the $TERMCAP environment variable */ 65*73f0a83dSXin LI dbdEnvList2, /* the $TERMPATH environment variable */ 66*73f0a83dSXin LI dbdCfgList2, /* the compiled-in TERMPATH */ 67*73f0a83dSXin LI #endif 68*73f0a83dSXin LI dbdLAST 69*73f0a83dSXin LI } DBDIRS; 70*73f0a83dSXin LI 710e3d5408SPeter Wemm #define MAX_USES 32 7215589c42SPeter Wemm #define MAX_CROSSLINKS 16 730e3d5408SPeter Wemm 740e3d5408SPeter Wemm typedef struct entry { 750e3d5408SPeter Wemm TERMTYPE tterm; 765d08fb1fSRong-En Fan unsigned nuses; 77*73f0a83dSXin LI struct { 7815589c42SPeter Wemm char *name; 7915589c42SPeter Wemm struct entry *link; 800e3d5408SPeter Wemm long line; 81*73f0a83dSXin LI } uses[MAX_USES]; 8215589c42SPeter Wemm int ncrosslinks; 8315589c42SPeter Wemm struct entry *crosslinks[MAX_CROSSLINKS]; 840e3d5408SPeter Wemm long cstart, cend; 850e3d5408SPeter Wemm long startline; 860e3d5408SPeter Wemm struct entry *next; 870e3d5408SPeter Wemm struct entry *last; 88*73f0a83dSXin LI } ENTRY; 89*73f0a83dSXin LI /* *INDENT-OFF* */ 900e3d5408SPeter Wemm #if NCURSES_XNAMES 910e3d5408SPeter Wemm #define NUM_BOOLEANS(tp) (tp)->num_Booleans 920e3d5408SPeter Wemm #define NUM_NUMBERS(tp) (tp)->num_Numbers 930e3d5408SPeter Wemm #define NUM_STRINGS(tp) (tp)->num_Strings 940e3d5408SPeter Wemm #define EXT_NAMES(tp,i,limit,index,table) (i >= limit) ? tp->ext_Names[index] : table[i] 950e3d5408SPeter Wemm #else 960e3d5408SPeter Wemm #define NUM_BOOLEANS(tp) BOOLCOUNT 970e3d5408SPeter Wemm #define NUM_NUMBERS(tp) NUMCOUNT 980e3d5408SPeter Wemm #define NUM_STRINGS(tp) STRCOUNT 990e3d5408SPeter Wemm #define EXT_NAMES(tp,i,limit,index,table) table[i] 1000e3d5408SPeter Wemm #endif 1010e3d5408SPeter Wemm 10206bfebdeSXin LI #define NUM_EXT_NAMES(tp) (unsigned) ((tp)->ext_Booleans + (tp)->ext_Numbers + (tp)->ext_Strings) 1030e3d5408SPeter Wemm 1040e3d5408SPeter Wemm #define for_each_boolean(n,tp) for(n = 0; n < NUM_BOOLEANS(tp); n++) 1050e3d5408SPeter Wemm #define for_each_number(n,tp) for(n = 0; n < NUM_NUMBERS(tp); n++) 1060e3d5408SPeter Wemm #define for_each_string(n,tp) for(n = 0; n < NUM_STRINGS(tp); n++) 1070e3d5408SPeter Wemm 10806bfebdeSXin LI #if NCURSES_XNAMES 10906bfebdeSXin LI #define for_each_ext_boolean(n,tp) for(n = BOOLCOUNT; n < NUM_BOOLEANS(tp); n++) 11006bfebdeSXin LI #define for_each_ext_number(n,tp) for(n = NUMCOUNT; n < NUM_NUMBERS(tp); n++) 11106bfebdeSXin LI #define for_each_ext_string(n,tp) for(n = STRCOUNT; n < NUM_STRINGS(tp); n++) 11206bfebdeSXin LI #endif 11306bfebdeSXin LI 1140e3d5408SPeter Wemm #define ExtBoolname(tp,i,names) EXT_NAMES(tp, i, BOOLCOUNT, (i - (tp->num_Booleans - tp->ext_Booleans)), names) 1150e3d5408SPeter Wemm #define ExtNumname(tp,i,names) EXT_NAMES(tp, i, NUMCOUNT, (i - (tp->num_Numbers - tp->ext_Numbers)) + tp->ext_Booleans, names) 1160e3d5408SPeter Wemm #define ExtStrname(tp,i,names) EXT_NAMES(tp, i, STRCOUNT, (i - (tp->num_Strings - tp->ext_Strings)) + (tp->ext_Numbers + tp->ext_Booleans), names) 1170e3d5408SPeter Wemm 1187a69bbfbSPeter Wemm extern NCURSES_EXPORT_VAR(ENTRY *) _nc_head; 1197a69bbfbSPeter Wemm extern NCURSES_EXPORT_VAR(ENTRY *) _nc_tail; 1200e3d5408SPeter Wemm #define for_entry_list(qp) for (qp = _nc_head; qp; qp = qp->next) 1210e3d5408SPeter Wemm 1220e3d5408SPeter Wemm #define MAX_LINE 132 1230e3d5408SPeter Wemm 1240e3d5408SPeter Wemm #define NULLHOOK (bool(*)(ENTRY *))0 1250e3d5408SPeter Wemm 1260e3d5408SPeter Wemm /* 1270e3d5408SPeter Wemm * Note that WANTED and PRESENT are not simple inverses! If a capability 1280e3d5408SPeter Wemm * has been explicitly cancelled, it's not considered WANTED. 1290e3d5408SPeter Wemm */ 1300e3d5408SPeter Wemm #define WANTED(s) ((s) == ABSENT_STRING) 1310e3d5408SPeter Wemm #define PRESENT(s) (((s) != ABSENT_STRING) && ((s) != CANCELLED_STRING)) 1320e3d5408SPeter Wemm 1330e3d5408SPeter Wemm #define ANDMISSING(p,q) \ 1340e3d5408SPeter Wemm {if (PRESENT(p) && !PRESENT(q)) _nc_warning(#p " but no " #q);} 1350e3d5408SPeter Wemm 1360e3d5408SPeter Wemm #define PAIRED(p,q) \ 1370e3d5408SPeter Wemm { \ 1380e3d5408SPeter Wemm if (PRESENT(q) && !PRESENT(p)) \ 1390e3d5408SPeter Wemm _nc_warning(#q " but no " #p); \ 1400e3d5408SPeter Wemm if (PRESENT(p) && !PRESENT(q)) \ 1410e3d5408SPeter Wemm _nc_warning(#p " but no " #q); \ 1420e3d5408SPeter Wemm } 1430e3d5408SPeter Wemm 1440e3d5408SPeter Wemm /* alloc_entry.c: elementary allocation code */ 1457a69bbfbSPeter Wemm extern NCURSES_EXPORT(ENTRY *) _nc_copy_entry (ENTRY *oldp); 1467a69bbfbSPeter Wemm extern NCURSES_EXPORT(char *) _nc_save_str (const char *const); 1477a69bbfbSPeter Wemm extern NCURSES_EXPORT(void) _nc_init_entry (TERMTYPE *const); 1487a69bbfbSPeter Wemm extern NCURSES_EXPORT(void) _nc_merge_entry (TERMTYPE *const, TERMTYPE *const); 1497a69bbfbSPeter Wemm extern NCURSES_EXPORT(void) _nc_wrap_entry (ENTRY *const, bool); 1500e3d5408SPeter Wemm 1510e3d5408SPeter Wemm /* alloc_ttype.c: elementary allocation code */ 1527a69bbfbSPeter Wemm extern NCURSES_EXPORT(void) _nc_align_termtype (TERMTYPE *, TERMTYPE *); 153*73f0a83dSXin LI extern NCURSES_EXPORT(void) _nc_copy_termtype (TERMTYPE *, const TERMTYPE *); 1540e3d5408SPeter Wemm 1550e3d5408SPeter Wemm /* free_ttype.c: elementary allocation code */ 1567a69bbfbSPeter Wemm extern NCURSES_EXPORT(void) _nc_free_termtype (TERMTYPE *); 1570e3d5408SPeter Wemm 1580e3d5408SPeter Wemm /* lib_acs.c */ 1597a69bbfbSPeter Wemm extern NCURSES_EXPORT(void) _nc_init_acs (void); /* corresponds to traditional 'init_acs()' */ 1600e3d5408SPeter Wemm 1614a1a9510SRong-En Fan /* lib_termcap.c: trim sgr0 string for termcap users */ 1624a1a9510SRong-En Fan extern NCURSES_EXPORT(char *) _nc_trim_sgr0 (TERMTYPE *); 1634a1a9510SRong-En Fan 1640e3d5408SPeter Wemm /* parse_entry.c: entry-parsing code */ 1650e3d5408SPeter Wemm #if NCURSES_XNAMES 1667a69bbfbSPeter Wemm extern NCURSES_EXPORT_VAR(bool) _nc_user_definable; 1677a69bbfbSPeter Wemm extern NCURSES_EXPORT_VAR(bool) _nc_disable_period; 1680e3d5408SPeter Wemm #endif 1697a69bbfbSPeter Wemm extern NCURSES_EXPORT(int) _nc_parse_entry (ENTRY *, int, bool); 1707a69bbfbSPeter Wemm extern NCURSES_EXPORT(int) _nc_capcmp (const char *, const char *); 1710e3d5408SPeter Wemm 1720e3d5408SPeter Wemm /* write_entry.c: writing an entry to the file system */ 1737a69bbfbSPeter Wemm extern NCURSES_EXPORT(void) _nc_set_writedir (char *); 1747a69bbfbSPeter Wemm extern NCURSES_EXPORT(void) _nc_write_entry (TERMTYPE *const); 1750e3d5408SPeter Wemm 1760e3d5408SPeter Wemm /* comp_parse.c: entry list handling */ 1777a69bbfbSPeter Wemm extern NCURSES_EXPORT(void) _nc_read_entry_source (FILE*, char*, int, bool, bool (*)(ENTRY*)); 1787a69bbfbSPeter Wemm extern NCURSES_EXPORT(bool) _nc_entry_match (char *, char *); 1794a1a9510SRong-En Fan extern NCURSES_EXPORT(int) _nc_resolve_uses (bool); /* obs 20040705 */ 1804a1a9510SRong-En Fan extern NCURSES_EXPORT(int) _nc_resolve_uses2 (bool, bool); 1817a69bbfbSPeter Wemm extern NCURSES_EXPORT(void) _nc_free_entries (ENTRY *); 1824a1a9510SRong-En Fan extern NCURSES_IMPEXP void NCURSES_API (*_nc_check_termtype)(TERMTYPE *); /* obs 20040705 */ 1834a1a9510SRong-En Fan extern NCURSES_IMPEXP void NCURSES_API (*_nc_check_termtype2)(TERMTYPE *, bool); 1840e3d5408SPeter Wemm 1850e3d5408SPeter Wemm /* trace_xnames.c */ 1867a69bbfbSPeter Wemm extern NCURSES_EXPORT(void) _nc_trace_xnames (TERMTYPE *); 187*73f0a83dSXin LI /* *INDENT-ON* */ 1880e3d5408SPeter Wemm 1890e3d5408SPeter Wemm #ifdef __cplusplus 1900e3d5408SPeter Wemm } 1910e3d5408SPeter Wemm #endif 1927a69bbfbSPeter Wemm #endif /* NCURSES_TERM_ENTRY_H_incl */ 193