150276Speter/**************************************************************************** 2184989Srafan * Copyright (c) 1998-2005,2008 Free Software Foundation, Inc. * 350276Speter * * 450276Speter * Permission is hereby granted, free of charge, to any person obtaining a * 550276Speter * copy of this software and associated documentation files (the * 650276Speter * "Software"), to deal in the Software without restriction, including * 750276Speter * without limitation the rights to use, copy, modify, merge, publish, * 850276Speter * distribute, distribute with modifications, sublicense, and/or sell * 950276Speter * copies of the Software, and to permit persons to whom the Software is * 1050276Speter * furnished to do so, subject to the following conditions: * 1150276Speter * * 1250276Speter * The above copyright notice and this permission notice shall be included * 1350276Speter * in all copies or substantial portions of the Software. * 1450276Speter * * 1550276Speter * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * 1650276Speter * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * 1750276Speter * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * 1850276Speter * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * 1950276Speter * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * 2050276Speter * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * 2150276Speter * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * 2250276Speter * * 2350276Speter * Except as contained in this notice, the name(s) of the above copyright * 2450276Speter * holders shall not be used in advertising or otherwise to promote the * 2550276Speter * sale, use or other dealings in this Software without prior written * 2650276Speter * authorization. * 2750276Speter ****************************************************************************/ 2850276Speter 2950276Speter/**************************************************************************** 3050276Speter * Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 * 3150276Speter * and: Eric S. Raymond <esr@snark.thyrsus.com> * 32184989Srafan * and: Thomas E. Dickey 1998-on * 3350276Speter ****************************************************************************/ 3450276Speter 35184989Srafan/* $Id: term_entry.h,v 1.35 2008/08/16 16:16:03 tom Exp $ */ 3650276Speter 3750276Speter/* 3850276Speter * term_entry.h -- interface to entry-manipulation code 3950276Speter */ 4050276Speter 4176726Speter#ifndef NCURSES_TERM_ENTRY_H_incl 4276726Speter#define NCURSES_TERM_ENTRY_H_incl 1 4350276Speter 4450276Speter#ifdef __cplusplus 4550276Speterextern "C" { 4650276Speter#endif 4750276Speter 4850276Speter#include <term.h> 4950276Speter 5050276Speter#define MAX_USES 32 5162449Speter#define MAX_CROSSLINKS 16 5250276Speter 5350276Spetertypedef struct entry { 5450276Speter TERMTYPE tterm; 55184989Srafan unsigned nuses; 5650276Speter struct 5750276Speter { 5862449Speter char *name; 5962449Speter struct entry *link; 60166124Srafan long line; 6150276Speter } 6250276Speter uses[MAX_USES]; 6362449Speter int ncrosslinks; 6462449Speter struct entry *crosslinks[MAX_CROSSLINKS]; 6550276Speter long cstart, cend; 6650276Speter long startline; 6750276Speter struct entry *next; 6850276Speter struct entry *last; 6950276Speter} 7050276SpeterENTRY; 7150276Speter 7250276Speter#if NCURSES_XNAMES 7350276Speter#define NUM_BOOLEANS(tp) (tp)->num_Booleans 7450276Speter#define NUM_NUMBERS(tp) (tp)->num_Numbers 7550276Speter#define NUM_STRINGS(tp) (tp)->num_Strings 7650276Speter#define EXT_NAMES(tp,i,limit,index,table) (i >= limit) ? tp->ext_Names[index] : table[i] 7750276Speter#else 7850276Speter#define NUM_BOOLEANS(tp) BOOLCOUNT 7950276Speter#define NUM_NUMBERS(tp) NUMCOUNT 8050276Speter#define NUM_STRINGS(tp) STRCOUNT 8150276Speter#define EXT_NAMES(tp,i,limit,index,table) table[i] 8250276Speter#endif 8350276Speter 8450276Speter#define NUM_EXT_NAMES(tp) ((tp)->ext_Booleans + (tp)->ext_Numbers + (tp)->ext_Strings) 8550276Speter 8650276Speter#define for_each_boolean(n,tp) for(n = 0; n < NUM_BOOLEANS(tp); n++) 8750276Speter#define for_each_number(n,tp) for(n = 0; n < NUM_NUMBERS(tp); n++) 8850276Speter#define for_each_string(n,tp) for(n = 0; n < NUM_STRINGS(tp); n++) 8950276Speter 9050276Speter#define ExtBoolname(tp,i,names) EXT_NAMES(tp, i, BOOLCOUNT, (i - (tp->num_Booleans - tp->ext_Booleans)), names) 9150276Speter#define ExtNumname(tp,i,names) EXT_NAMES(tp, i, NUMCOUNT, (i - (tp->num_Numbers - tp->ext_Numbers)) + tp->ext_Booleans, names) 9250276Speter#define ExtStrname(tp,i,names) EXT_NAMES(tp, i, STRCOUNT, (i - (tp->num_Strings - tp->ext_Strings)) + (tp->ext_Numbers + tp->ext_Booleans), names) 9350276Speter 9476726Speterextern NCURSES_EXPORT_VAR(ENTRY *) _nc_head; 9576726Speterextern NCURSES_EXPORT_VAR(ENTRY *) _nc_tail; 9650276Speter#define for_entry_list(qp) for (qp = _nc_head; qp; qp = qp->next) 9750276Speter 9850276Speter#define MAX_LINE 132 9950276Speter 10050276Speter#define NULLHOOK (bool(*)(ENTRY *))0 10150276Speter 10250276Speter/* 10350276Speter * Note that WANTED and PRESENT are not simple inverses! If a capability 10450276Speter * has been explicitly cancelled, it's not considered WANTED. 10550276Speter */ 10650276Speter#define WANTED(s) ((s) == ABSENT_STRING) 10750276Speter#define PRESENT(s) (((s) != ABSENT_STRING) && ((s) != CANCELLED_STRING)) 10850276Speter 10950276Speter#define ANDMISSING(p,q) \ 11050276Speter {if (PRESENT(p) && !PRESENT(q)) _nc_warning(#p " but no " #q);} 11150276Speter 11250276Speter#define PAIRED(p,q) \ 11350276Speter { \ 11450276Speter if (PRESENT(q) && !PRESENT(p)) \ 11550276Speter _nc_warning(#q " but no " #p); \ 11650276Speter if (PRESENT(p) && !PRESENT(q)) \ 11750276Speter _nc_warning(#p " but no " #q); \ 11850276Speter } 11950276Speter 12050276Speter/* alloc_entry.c: elementary allocation code */ 12176726Speterextern NCURSES_EXPORT(ENTRY *) _nc_copy_entry (ENTRY *oldp); 12276726Speterextern NCURSES_EXPORT(char *) _nc_save_str (const char *const); 12376726Speterextern NCURSES_EXPORT(void) _nc_init_entry (TERMTYPE *const); 12476726Speterextern NCURSES_EXPORT(void) _nc_merge_entry (TERMTYPE *const, TERMTYPE *const); 12576726Speterextern NCURSES_EXPORT(void) _nc_wrap_entry (ENTRY *const, bool); 12650276Speter 12750276Speter/* alloc_ttype.c: elementary allocation code */ 12876726Speterextern NCURSES_EXPORT(void) _nc_align_termtype (TERMTYPE *, TERMTYPE *); 12976726Speterextern NCURSES_EXPORT(void) _nc_copy_termtype (TERMTYPE *, TERMTYPE *); 13050276Speter 13150276Speter/* free_ttype.c: elementary allocation code */ 13276726Speterextern NCURSES_EXPORT(void) _nc_free_termtype (TERMTYPE *); 13350276Speter 13450276Speter/* lib_acs.c */ 13576726Speterextern NCURSES_EXPORT(void) _nc_init_acs (void); /* corresponds to traditional 'init_acs()' */ 13650276Speter 137166124Srafan/* lib_termcap.c: trim sgr0 string for termcap users */ 138166124Srafanextern NCURSES_EXPORT(char *) _nc_trim_sgr0 (TERMTYPE *); 139166124Srafan 14050276Speter/* parse_entry.c: entry-parsing code */ 14150276Speter#if NCURSES_XNAMES 14276726Speterextern NCURSES_EXPORT_VAR(bool) _nc_user_definable; 14376726Speterextern NCURSES_EXPORT_VAR(bool) _nc_disable_period; 14450276Speter#endif 14576726Speterextern NCURSES_EXPORT(int) _nc_parse_entry (ENTRY *, int, bool); 14676726Speterextern NCURSES_EXPORT(int) _nc_capcmp (const char *, const char *); 14750276Speter 14850276Speter/* write_entry.c: writing an entry to the file system */ 14976726Speterextern NCURSES_EXPORT(void) _nc_set_writedir (char *); 15076726Speterextern NCURSES_EXPORT(void) _nc_write_entry (TERMTYPE *const); 15150276Speter 15250276Speter/* comp_parse.c: entry list handling */ 15376726Speterextern NCURSES_EXPORT(void) _nc_read_entry_source (FILE*, char*, int, bool, bool (*)(ENTRY*)); 15476726Speterextern NCURSES_EXPORT(bool) _nc_entry_match (char *, char *); 155166124Srafanextern NCURSES_EXPORT(int) _nc_resolve_uses (bool); /* obs 20040705 */ 156166124Srafanextern NCURSES_EXPORT(int) _nc_resolve_uses2 (bool, bool); 15776726Speterextern NCURSES_EXPORT(void) _nc_free_entries (ENTRY *); 158166124Srafanextern NCURSES_IMPEXP void NCURSES_API (*_nc_check_termtype)(TERMTYPE *); /* obs 20040705 */ 159166124Srafanextern NCURSES_IMPEXP void NCURSES_API (*_nc_check_termtype2)(TERMTYPE *, bool); 16050276Speter 16150276Speter/* trace_xnames.c */ 16276726Speterextern NCURSES_EXPORT(void) _nc_trace_xnames (TERMTYPE *); 16350276Speter 16450276Speter#ifdef __cplusplus 16550276Speter} 16650276Speter#endif 16750276Speter 16876726Speter#endif /* NCURSES_TERM_ENTRY_H_incl */ 169