| /**************************************************************************** |
| * Copyright (c) 1998-2011,2012 Free Software Foundation, Inc. * |
| * * |
| * Permission is hereby granted, free of charge, to any person obtaining a * |
| * copy of this software and associated documentation files (the * |
| * "Software"), to deal in the Software without restriction, including * |
| * without limitation the rights to use, copy, modify, merge, publish, * |
| * distribute, distribute with modifications, sublicense, and/or sell * |
| * copies of the Software, and to permit persons to whom the Software is * |
| * furnished to do so, subject to the following conditions: * |
| * * |
| * The above copyright notice and this permission notice shall be included * |
| * in all copies or substantial portions of the Software. * |
| * * |
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * |
| * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * |
| * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * |
| * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * |
| * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * |
| * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * |
| * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * |
| * * |
| * Except as contained in this notice, the name(s) of the above copyright * |
| * holders shall not be used in advertising or otherwise to promote the * |
| * sale, use or other dealings in this Software without prior written * |
| * authorization. * |
| ****************************************************************************/ |
| |
| /**************************************************************************** |
| * Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 * |
| * and: Eric S. Raymond <esr@snark.thyrsus.com> * |
| * and: Thomas E. Dickey 1996 on * |
| ****************************************************************************/ |
| |
| /* |
| * $Id: tic.h,v 1.69 2012/03/17 18:22:10 tom Exp $ |
| * tic.h - Global variables and structures for the terminfo |
| * compiler. |
| */ |
| |
| #ifndef __TIC_H |
| #define __TIC_H |
| /* *INDENT-OFF* */ |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| #include <curses.h> /* for the _tracef() prototype, ERR/OK, bool defs */ |
| |
| /* |
| ** The format of compiled terminfo files is as follows: |
| ** |
| ** Header (12 bytes), containing information given below |
| ** Names Section, containing the names of the terminal |
| ** Boolean Section, containing the values of all of the |
| ** boolean capabilities |
| ** A null byte may be inserted here to make |
| ** sure that the Number Section begins on an |
| ** even word boundary. |
| ** Number Section, containing the values of all of the numeric |
| ** capabilities, each as a short integer |
| ** String Section, containing short integer offsets into the |
| ** String Table, one per string capability |
| ** String Table, containing the actual characters of the string |
| ** capabilities. |
| ** |
| ** NOTE that all short integers in the file are stored using VAX/PDP-style |
| ** byte-order, i.e., least-significant byte first. |
| ** |
| ** There is no structure definition here because it would only confuse |
| ** matters. Terminfo format is a raw byte layout, not a structure |
| ** dump. If you happen to be on a little-endian machine with 16-bit |
| ** shorts that requires no padding between short members in a struct, |
| ** then there is a natural C structure that captures the header, but |
| ** not very helpfully. |
| */ |
| |
| #define MAGIC 0432 /* first two bytes of a compiled entry */ |
| |
| #undef BYTE |
| #define BYTE(p,n) (unsigned char)((p)[n]) |
| |
| #define IS_NEG1(p) ((BYTE(p,0) == 0377) && (BYTE(p,1) == 0377)) |
| #define IS_NEG2(p) ((BYTE(p,0) == 0376) && (BYTE(p,1) == 0377)) |
| #define LOW_MSB(p) (BYTE(p,0) + 256*BYTE(p,1)) |
| |
| #define IS_TIC_MAGIC(p) (LOW_MSB(p) == MAGIC) |
| |
| /* |
| * The "maximum" here is misleading; XSI guarantees minimum values, which a |
| * given implementation may exceed. |
| */ |
| #define MAX_NAME_SIZE 512 /* maximum legal name field size (XSI:127) */ |
| #define MAX_ENTRY_SIZE 4096 /* maximum legal entry size */ |
| |
| /* |
| * The maximum size of individual name or alias is guaranteed in XSI to be at |
| * least 14, since that corresponds to the older filename lengths. Newer |
| * systems allow longer aliases, though not many terminal descriptions are |
| * written to use them. The MAX_ALIAS symbol is used for warnings. |
| */ |
| #if HAVE_LONG_FILE_NAMES |
| #define MAX_ALIAS 32 /* smaller than POSIX minimum for PATH_MAX */ |
| #else |
| #define MAX_ALIAS 14 /* SVr3 filename length */ |
| #endif |
| |
| /* location of user's personal info directory */ |
| #define PRIVATE_INFO "%s/.terminfo" /* plug getenv("HOME") into %s */ |
| |
| /* |
| * Some traces are designed to be used via tic's verbose option (and similar in |
| * infocmp and toe) rather than the 'trace()' function. So we use the bits |
| * above the normal trace() parameter as a debug-level. |
| */ |
| |
| #define MAX_DEBUG_LEVEL 15 |
| #define DEBUG_LEVEL(n) ((n) << TRACE_SHIFT) |
| |
| #define set_trace_level(n) \ |
| _nc_tracing &= DEBUG_LEVEL(MAX_DEBUG_LEVEL), \ |
| _nc_tracing |= DEBUG_LEVEL(n) |
| |
| #ifdef TRACE |
| #define DEBUG(n, a) if (_nc_tracing >= DEBUG_LEVEL(n)) _tracef a |
| #else |
| #define DEBUG(n, a) /*nothing*/ |
| #endif |
| |
| extern NCURSES_EXPORT_VAR(unsigned) _nc_tracing; |
| extern NCURSES_EXPORT(void) _nc_tracef (char *, ...) GCC_PRINTFLIKE(1,2); |
| extern NCURSES_EXPORT(const char *) _nc_visbuf (const char *); |
| extern NCURSES_EXPORT(const char *) _nc_visbuf2 (int, const char *); |
| |
| /* |
| * These are the types of tokens returned by the scanner. The first |
| * three are also used in the hash table of capability names. The scanner |
| * returns one of these values after loading the specifics into the global |
| * structure curr_token. |
| */ |
| |
| #define BOOLEAN 0 /* Boolean capability */ |
| #define NUMBER 1 /* Numeric capability */ |
| #define STRING 2 /* String-valued capability */ |
| #define CANCEL 3 /* Capability to be cancelled in following tc's */ |
| #define NAMES 4 /* The names for a terminal type */ |
| #define UNDEF 5 /* Undefined */ |
| |
| #define NO_PUSHBACK -1 /* used in pushtype to indicate no pushback */ |
| |
| /* |
| * The global structure in which the specific parts of a |
| * scanned token are returned. |
| * |
| */ |
| |
| struct token |
| { |
| char *tk_name; /* name of capability */ |
| int tk_valnumber; /* value of capability (if a number) */ |
| char *tk_valstring; /* value of capability (if a string) */ |
| }; |
| |
| extern NCURSES_EXPORT_VAR(struct token) _nc_curr_token; |
| |
| /* |
| * Offsets to string capabilities, with the corresponding functionkey |
| * codes. |
| */ |
| struct tinfo_fkeys { |
| unsigned offset; |
| chtype code; |
| }; |
| |
| #if BROKEN_LINKER |
| |
| #define _nc_tinfo_fkeys _nc_tinfo_fkeysf() |
| extern NCURSES_EXPORT(const struct tinfo_fkeys *) _nc_tinfo_fkeysf (void); |
| |
| #else |
| |
| extern NCURSES_EXPORT_VAR(const struct tinfo_fkeys) _nc_tinfo_fkeys[]; |
| |
| #endif |
| |
| typedef short HashValue; |
| |
| /* |
| * The file comp_captab.c contains an array of these structures, one |
| * per possible capability. These are indexed by a hash table array of |
| * pointers to the same structures for use by the parser. |
| */ |
| |
| struct name_table_entry |
| { |
| const char *nte_name; /* name to hash on */ |
| int nte_type; /* BOOLEAN, NUMBER or STRING */ |
| HashValue nte_index; /* index of associated variable in its array */ |
| HashValue nte_link; /* index in table of next hash, or -1 */ |
| }; |
| |
| /* |
| * Use this structure to hide differences between terminfo and termcap |
| * tables. |
| */ |
| typedef struct { |
| unsigned table_size; |
| const HashValue *table_data; |
| HashValue (*hash_of)(const char *); |
| int (*compare_names)(const char *, const char *); |
| } HashData; |
| |
| struct alias |
| { |
| const char *from; |
| const char *to; |
| const char *source; |
| }; |
| |
| extern NCURSES_EXPORT(const struct name_table_entry *) _nc_get_table (bool); |
| extern NCURSES_EXPORT(const HashData *) _nc_get_hash_info (bool); |
| extern NCURSES_EXPORT(const HashValue *) _nc_get_hash_table (bool); |
| extern NCURSES_EXPORT(const struct alias *) _nc_get_alias_table (bool); |
| |
| #define NOTFOUND ((struct name_table_entry *) 0) |
| |
| /* |
| * The casts are required for correct sign-propagation with systems such as |
| * AIX, IRIX64, Solaris which default to unsigned characters. The C standard |
| * leaves this detail unspecified. |
| */ |
| |
| /* out-of-band values for representing absent capabilities */ |
| #define ABSENT_BOOLEAN ((signed char)-1) /* 255 */ |
| #define ABSENT_NUMERIC (-1) |
| #define ABSENT_STRING (char *)0 |
| |
| /* out-of-band values for representing cancels */ |
| #define CANCELLED_BOOLEAN ((signed char)-2) /* 254 */ |
| #define CANCELLED_NUMERIC (-2) |
| #define CANCELLED_STRING (char *)(-1) |
| |
| #define VALID_BOOLEAN(s) ((unsigned char)(s) <= 1) /* reject "-1" */ |
| #define VALID_NUMERIC(s) ((s) >= 0) |
| #define VALID_STRING(s) ((s) != CANCELLED_STRING && (s) != ABSENT_STRING) |
| |
| /* termcap entries longer than this may break old binaries */ |
| #define MAX_TERMCAP_LENGTH 1023 |
| |
| /* this is a documented limitation of terminfo */ |
| #define MAX_TERMINFO_LENGTH 4096 |
| |
| #ifndef TERMINFO |
| #define TERMINFO "/usr/share/terminfo" |
| #endif |
| |
| #ifdef NCURSES_TERM_ENTRY_H_incl |
| |
| /* access.c */ |
| extern NCURSES_EXPORT(unsigned) _nc_pathlast (const char *); |
| extern NCURSES_EXPORT(bool) _nc_is_abs_path (const char *); |
| extern NCURSES_EXPORT(bool) _nc_is_dir_path (const char *); |
| extern NCURSES_EXPORT(bool) _nc_is_file_path (const char *); |
| extern NCURSES_EXPORT(char *) _nc_basename (char *); |
| extern NCURSES_EXPORT(char *) _nc_rootname (char *); |
| |
| /* comp_hash.c: name lookup */ |
| extern NCURSES_EXPORT(struct name_table_entry const *) _nc_find_entry |
| (const char *, const HashValue *); |
| extern NCURSES_EXPORT(struct name_table_entry const *) _nc_find_type_entry |
| (const char *, int, bool); |
| |
| /* comp_scan.c: lexical analysis */ |
| extern NCURSES_EXPORT(int) _nc_get_token (bool); |
| extern NCURSES_EXPORT(void) _nc_panic_mode (char); |
| extern NCURSES_EXPORT(void) _nc_push_token (int); |
| extern NCURSES_EXPORT(void) _nc_reset_input (FILE *, char *); |
| extern NCURSES_EXPORT_VAR(int) _nc_curr_col; |
| extern NCURSES_EXPORT_VAR(int) _nc_curr_line; |
| extern NCURSES_EXPORT_VAR(int) _nc_syntax; |
| extern NCURSES_EXPORT_VAR(int) _nc_strict_bsd; |
| extern NCURSES_EXPORT_VAR(long) _nc_comment_end; |
| extern NCURSES_EXPORT_VAR(long) _nc_comment_start; |
| extern NCURSES_EXPORT_VAR(long) _nc_curr_file_pos; |
| extern NCURSES_EXPORT_VAR(long) _nc_start_line; |
| #define SYN_TERMINFO 0 |
| #define SYN_TERMCAP 1 |
| |
| /* comp_error.c: warning & abort messages */ |
| extern NCURSES_EXPORT(const char *) _nc_get_source (void); |
| extern NCURSES_EXPORT(void) _nc_err_abort (const char *const,...) GCC_PRINTFLIKE(1,2) GCC_NORETURN; |
| extern NCURSES_EXPORT(void) _nc_get_type (char *name); |
| extern NCURSES_EXPORT(void) _nc_set_source (const char *const); |
| extern NCURSES_EXPORT(void) _nc_set_type (const char *const); |
| extern NCURSES_EXPORT(void) _nc_syserr_abort (const char *const,...) GCC_PRINTFLIKE(1,2) GCC_NORETURN; |
| extern NCURSES_EXPORT(void) _nc_warning (const char *const,...) GCC_PRINTFLIKE(1,2); |
| extern NCURSES_EXPORT_VAR(bool) _nc_suppress_warnings; |
| |
| /* comp_expand.c: expand string into readable form */ |
| extern NCURSES_EXPORT(char *) _nc_tic_expand (const char *, bool, int); |
| |
| /* comp_scan.c: decode string from readable form */ |
| extern NCURSES_EXPORT(int) _nc_trans_string (char *, char *); |
| |
| /* captoinfo.c: capability conversion */ |
| extern NCURSES_EXPORT(char *) _nc_captoinfo (const char *, const char *, int const); |
| extern NCURSES_EXPORT(char *) _nc_infotocap (const char *, const char *, int const); |
| |
| /* home_terminfo.c */ |
| extern NCURSES_EXPORT(char *) _nc_home_terminfo (void); |
| |
| /* lib_tparm.c */ |
| #define NUM_PARM 9 |
| |
| extern NCURSES_EXPORT_VAR(int) _nc_tparm_err; |
| |
| extern NCURSES_EXPORT(int) _nc_tparm_analyze(const char *, char **, int *); |
| |
| /* lib_tputs.c */ |
| extern NCURSES_EXPORT_VAR(int) _nc_nulls_sent; /* Add one for every null sent */ |
| |
| /* comp_main.c: compiler main */ |
| extern const char * _nc_progname; |
| |
| /* db_iterator.c */ |
| extern NCURSES_EXPORT(const char *) _nc_next_db(DBDIRS *, int *); |
| extern NCURSES_EXPORT(const char *) _nc_tic_dir (const char *); |
| extern NCURSES_EXPORT(void) _nc_first_db(DBDIRS *, int *); |
| extern NCURSES_EXPORT(void) _nc_last_db(void); |
| |
| /* write_entry.c */ |
| extern NCURSES_EXPORT(int) _nc_tic_written (void); |
| |
| #endif /* NCURSES_TERM_ENTRY_H_incl */ |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| /* *INDENT-ON* */ |
| #endif /* __TIC_H */ |