Edit File by line

/****************************************************************************

[0] Fix | Delete

[1] Fix | Delete

* *

[2] Fix | Delete

* Permission is hereby granted, free of charge, to any person obtaining a *

[3] Fix | Delete

* copy of this software and associated documentation files (the *

[4] Fix | Delete

* "Software"), to deal in the Software without restriction, including *

[5] Fix | Delete

* without limitation the rights to use, copy, modify, merge, publish, *

[6] Fix | Delete

* distribute, distribute with modifications, sublicense, and/or sell *

[7] Fix | Delete

* copies of the Software, and to permit persons to whom the Software is *

[8] Fix | Delete

* furnished to do so, subject to the following conditions: *

[9] Fix | Delete

* *

[10] Fix | Delete

* The above copyright notice and this permission notice shall be included *

[11] Fix | Delete

* in all copies or substantial portions of the Software. *

[12] Fix | Delete

* *

[13] Fix | Delete

* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *

[14] Fix | Delete

* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *

[15] Fix | Delete

* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *

[16] Fix | Delete

* IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *

[17] Fix | Delete

* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *

[18] Fix | Delete

* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *

[19] Fix | Delete

* THE USE OR OTHER DEALINGS IN THE SOFTWARE. *

[20] Fix | Delete

* *

[21] Fix | Delete

* Except as contained in this notice, the name(s) of the above copyright *

[22] Fix | Delete

* holders shall not be used in advertising or otherwise to promote the *

[23] Fix | Delete

* sale, use or other dealings in this Software without prior written *

[24] Fix | Delete

* authorization. *

[25] Fix | Delete

****************************************************************************/

[26] Fix | Delete

[27] Fix | Delete

/****************************************************************************

[28] Fix | Delete

* Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 *

[29] Fix | Delete

* and: Eric S. Raymond <esr@snark.thyrsus.com> *

[30] Fix | Delete

* and: Thomas E. Dickey 1996 on *

[31] Fix | Delete

****************************************************************************/

[32] Fix | Delete

[33] Fix | Delete

[34] Fix | Delete

* $Id: tic.h,v 1.75 2017/07/29 23:21:06 tom Exp $

[35] Fix | Delete

* tic.h - Global variables and structures for the terminfo compiler.

[36] Fix | Delete

[37] Fix | Delete

[38] Fix | Delete

#ifndef __TIC_H

[39] Fix | Delete

#define __TIC_H

[40] Fix | Delete

/* *INDENT-OFF* */

[41] Fix | Delete

#ifdef __cplusplus

[42] Fix | Delete

extern "C" {

[43] Fix | Delete

#endif

[44] Fix | Delete

[45] Fix | Delete

#include <ncurses_cfg.h>

[46] Fix | Delete

[47] Fix | Delete

#include <curses.h> /* for the _tracef() prototype, ERR/OK, bool defs */

[48] Fix | Delete

[49] Fix | Delete

[50] Fix | Delete

** The format of SVr2 compiled terminfo files is as follows:

[51] Fix | Delete

[52] Fix | Delete

** Header (12 bytes), containing information given below

[53] Fix | Delete

** Names Section, containing the names of the terminal

[54] Fix | Delete

** Boolean Section, containing the values of all of the

[55] Fix | Delete

** boolean capabilities

[56] Fix | Delete

** A null byte may be inserted here to make

[57] Fix | Delete

** sure that the Number Section begins on an

[58] Fix | Delete

** even word boundary.

[59] Fix | Delete

** Number Section, containing the values of all of the numeric

[60] Fix | Delete

** capabilities, each as a short integer

[61] Fix | Delete

** String Section, containing short integer offsets into the

[62] Fix | Delete

** String Table, one per string capability

[63] Fix | Delete

** String Table, containing the actual characters of the string

[64] Fix | Delete

** capabilities.

[65] Fix | Delete

[66] Fix | Delete

** In the SVr2 format, "short" means signed 16-bit numbers, which is sometimes

[67] Fix | Delete

** inconvenient. The numbers are signed, to provide for absent and canceled

[68] Fix | Delete

** values. ncurses6.1 introduced an extension to this compiled format, by

[69] Fix | Delete

** making the Number Section a list of signed 32-bit integers.

[70] Fix | Delete

[71] Fix | Delete

** NOTE that all short integers in the file are stored using VAX/PDP-style

[72] Fix | Delete

** byte-order, i.e., least-significant byte first.

[73] Fix | Delete

[74] Fix | Delete

** There is no structure definition here because it would only confuse

[75] Fix | Delete

** matters. Terminfo format is a raw byte layout, not a structure

[76] Fix | Delete

** dump. If you happen to be on a little-endian machine with 16-bit

[77] Fix | Delete

** shorts that requires no padding between short members in a struct,

[78] Fix | Delete

** then there is a natural C structure that captures the header, but

[79] Fix | Delete

** not very helpfully.

[80] Fix | Delete

[81] Fix | Delete

[82] Fix | Delete

#define MAGIC 0432 /* first two bytes of a compiled entry */

[83] Fix | Delete

#define MAGIC2 01036 /* first two bytes of a compiled 32-bit entry */

[84] Fix | Delete

[85] Fix | Delete

#undef BYTE

[86] Fix | Delete

#define BYTE(p,n) (unsigned char)((p)[n])

[87] Fix | Delete

[88] Fix | Delete

#define IS_NEG1(p) ((BYTE(p,0) == 0377) && (BYTE(p,1) == 0377))

[89] Fix | Delete

#define IS_NEG2(p) ((BYTE(p,0) == 0376) && (BYTE(p,1) == 0377))

[90] Fix | Delete

#define LOW_MSB(p) (BYTE(p,0) + 256*BYTE(p,1))

[91] Fix | Delete

[92] Fix | Delete

#define IS_TIC_MAGIC(p) (LOW_MSB(p) == MAGIC || LOW_MSB(p) == MAGIC2)

[93] Fix | Delete

[94] Fix | Delete

#define quick_prefix(s) (!strncmp((s), "b64:", 4) || !strncmp((s), "hex:", 4))

[95] Fix | Delete

[96] Fix | Delete

[97] Fix | Delete

* The "maximum" here is misleading; XSI guarantees minimum values, which a

[98] Fix | Delete

* given implementation may exceed.

[99] Fix | Delete

[100] Fix | Delete

#define MAX_NAME_SIZE 512 /* maximum legal name field size (XSI:127) */

[101] Fix | Delete

#define MAX_ENTRY_SIZE1 4096 /* maximum legal entry size (SVr2) */

[102] Fix | Delete

#define MAX_ENTRY_SIZE2 32768 /* maximum legal entry size (ncurses6.1) */

[103] Fix | Delete

[104] Fix | Delete

#if NCURSES_EXT_COLORS && HAVE_INIT_EXTENDED_COLOR

[105] Fix | Delete

#define MAX_ENTRY_SIZE MAX_ENTRY_SIZE2

[106] Fix | Delete

#else

[107] Fix | Delete

#define MAX_ENTRY_SIZE MAX_ENTRY_SIZE1

[108] Fix | Delete

#endif

[109] Fix | Delete

[110] Fix | Delete

[111] Fix | Delete

* The maximum size of individual name or alias is guaranteed in XSI to be at

[112] Fix | Delete

* least 14, since that corresponds to the older filename lengths. Newer

[113] Fix | Delete

* systems allow longer aliases, though not many terminal descriptions are

[114] Fix | Delete

* written to use them. The MAX_ALIAS symbol is used for warnings.

[115] Fix | Delete

[116] Fix | Delete

#if HAVE_LONG_FILE_NAMES

[117] Fix | Delete

#define MAX_ALIAS 32 /* smaller than POSIX minimum for PATH_MAX */

[118] Fix | Delete

#else

[119] Fix | Delete

#define MAX_ALIAS 14 /* SVr3 filename length */

[120] Fix | Delete

#endif

[121] Fix | Delete

[122] Fix | Delete

/* location of user's personal info directory */

[123] Fix | Delete

#define PRIVATE_INFO "%s/.terminfo" /* plug getenv("HOME") into %s */

[124] Fix | Delete

[125] Fix | Delete

[126] Fix | Delete

* Some traces are designed to be used via tic's verbose option (and similar in

[127] Fix | Delete

* infocmp and toe) rather than the 'trace()' function. So we use the bits

[128] Fix | Delete

* above the normal trace() parameter as a debug-level.

[129] Fix | Delete

[130] Fix | Delete

[131] Fix | Delete

#define MAX_DEBUG_LEVEL 15

[132] Fix | Delete

#define DEBUG_LEVEL(n) ((n) << TRACE_SHIFT)

[133] Fix | Delete

[134] Fix | Delete

#define set_trace_level(n) \

[135] Fix | Delete

_nc_tracing &= DEBUG_LEVEL(MAX_DEBUG_LEVEL) \

[136] Fix | Delete

+ DEBUG_LEVEL(MAX_DEBUG_LEVEL) - 1, \

[137] Fix | Delete

_nc_tracing |= DEBUG_LEVEL(n)

[138] Fix | Delete

[139] Fix | Delete

#ifdef TRACE

[140] Fix | Delete

#define DEBUG(n, a) if (_nc_tracing >= DEBUG_LEVEL(n)) _tracef a

[141] Fix | Delete

#else

[142] Fix | Delete

#define DEBUG(n, a) /*nothing*/

[143] Fix | Delete

#endif

[144] Fix | Delete

[145] Fix | Delete

[146] Fix | Delete

* These are the types of tokens returned by the scanner. The first

[147] Fix | Delete

* three are also used in the hash table of capability names. The scanner

[148] Fix | Delete

* returns one of these values after loading the specifics into the global

[149] Fix | Delete

* structure curr_token.

[150] Fix | Delete

[151] Fix | Delete

[152] Fix | Delete

#define BOOLEAN 0 /* Boolean capability */

[153] Fix | Delete

#define NUMBER 1 /* Numeric capability */

[154] Fix | Delete

#define STRING 2 /* String-valued capability */

[155] Fix | Delete

#define CANCEL 3 /* Capability to be cancelled in following tc's */

[156] Fix | Delete

#define NAMES 4 /* The names for a terminal type */

[157] Fix | Delete

#define UNDEF 5 /* Undefined */

[158] Fix | Delete

[159] Fix | Delete

#define NO_PUSHBACK -1 /* used in pushtype to indicate no pushback */

[160] Fix | Delete

[161] Fix | Delete

[162] Fix | Delete

* The global structure in which the specific parts of a

[163] Fix | Delete

* scanned token are returned.

[164] Fix | Delete

[165] Fix | Delete

[166] Fix | Delete

struct token

[167] Fix | Delete

{

[168] Fix | Delete

char *tk_name; /* name of capability */

[169] Fix | Delete

int tk_valnumber; /* value of capability (if a number) */

[170] Fix | Delete

char *tk_valstring; /* value of capability (if a string) */

[171] Fix | Delete

};

[172] Fix | Delete

[173] Fix | Delete

[174] Fix | Delete

* Offsets to string capabilities, with the corresponding functionkey codes.

[175] Fix | Delete

[176] Fix | Delete

struct tinfo_fkeys {

[177] Fix | Delete

unsigned offset;

[178] Fix | Delete

chtype code;

[179] Fix | Delete

};

[180] Fix | Delete

[181] Fix | Delete

typedef short HashValue;

[182] Fix | Delete

[183] Fix | Delete

[184] Fix | Delete

* The file comp_captab.c contains an array of these structures, one per

[185] Fix | Delete

* possible capability. These are indexed by a hash table array of pointers to

[186] Fix | Delete

* the same structures for use by the parser.

[187] Fix | Delete

[188] Fix | Delete

struct name_table_entry

[189] Fix | Delete

{

[190] Fix | Delete

const char *nte_name; /* name to hash on */

[191] Fix | Delete

int nte_type; /* BOOLEAN, NUMBER or STRING */

[192] Fix | Delete

HashValue nte_index; /* index of associated variable in its array */

[193] Fix | Delete

HashValue nte_link; /* index in table of next hash, or -1 */

[194] Fix | Delete

};

[195] Fix | Delete

[196] Fix | Delete

[197] Fix | Delete

* Use this structure to hide differences between terminfo and termcap tables.

[198] Fix | Delete

[199] Fix | Delete

typedef struct {

[200] Fix | Delete

unsigned table_size;

[201] Fix | Delete

const HashValue *table_data;

[202] Fix | Delete

HashValue (*hash_of)(const char *);

[203] Fix | Delete

int (*compare_names)(const char *, const char *);

[204] Fix | Delete

} HashData;

[205] Fix | Delete

[206] Fix | Delete

struct alias

[207] Fix | Delete

{

[208] Fix | Delete

const char *from;

[209] Fix | Delete

const char *to;

[210] Fix | Delete

const char *source;

[211] Fix | Delete

};

[212] Fix | Delete

[213] Fix | Delete

#define NOTFOUND ((struct name_table_entry *) 0)

[214] Fix | Delete

[215] Fix | Delete

[216] Fix | Delete

* The casts are required for correct sign-propagation with systems such as

[217] Fix | Delete

* AIX, IRIX64, Solaris which default to unsigned characters. The C standard

[218] Fix | Delete

* leaves this detail unspecified.

[219] Fix | Delete

[220] Fix | Delete

[221] Fix | Delete

/* out-of-band values for representing absent capabilities */

[222] Fix | Delete

#define ABSENT_BOOLEAN ((signed char)-1) /* 255 */

[223] Fix | Delete

#define ABSENT_NUMERIC (-1)

[224] Fix | Delete

#define ABSENT_STRING (char *)0

[225] Fix | Delete

[226] Fix | Delete

/* out-of-band values for representing cancels */

[227] Fix | Delete

#define CANCELLED_BOOLEAN ((signed char)-2) /* 254 */

[228] Fix | Delete

#define CANCELLED_NUMERIC (-2)

[229] Fix | Delete

#define CANCELLED_STRING (char *)(-1)

[230] Fix | Delete

[231] Fix | Delete

#define VALID_BOOLEAN(s) ((unsigned char)(s) <= 1) /* reject "-1" */

[232] Fix | Delete

#define VALID_NUMERIC(s) ((s) >= 0)

[233] Fix | Delete

#define VALID_STRING(s) ((s) != CANCELLED_STRING && (s) != ABSENT_STRING)

[234] Fix | Delete

[235] Fix | Delete

/* termcap entries longer than this may break old binaries */

[236] Fix | Delete

#define MAX_TERMCAP_LENGTH 1023

[237] Fix | Delete

[238] Fix | Delete

/* this is a documented limitation of terminfo */

[239] Fix | Delete

#define MAX_TERMINFO_LENGTH 4096

[240] Fix | Delete

[241] Fix | Delete

#ifndef TERMINFO

[242] Fix | Delete

#define TERMINFO "/usr/share/terminfo"

[243] Fix | Delete

#endif

[244] Fix | Delete

[245] Fix | Delete

#ifdef NCURSES_TERM_ENTRY_H_incl

[246] Fix | Delete

[247] Fix | Delete

[248] Fix | Delete

* These entrypoints are used only by the ncurses utilities such as tic.

[249] Fix | Delete

[250] Fix | Delete

#ifdef NCURSES_INTERNALS

[251] Fix | Delete

/* access.c */

[252] Fix | Delete

extern NCURSES_EXPORT(unsigned) _nc_pathlast (const char *);

[253] Fix | Delete

extern NCURSES_EXPORT(bool) _nc_is_abs_path (const char *);

[254] Fix | Delete

extern NCURSES_EXPORT(bool) _nc_is_dir_path (const char *);

[255] Fix | Delete

extern NCURSES_EXPORT(bool) _nc_is_file_path (const char *);

[256] Fix | Delete

extern NCURSES_EXPORT(char *) _nc_basename (char *);

[257] Fix | Delete

extern NCURSES_EXPORT(char *) _nc_rootname (char *);

[258] Fix | Delete

[259] Fix | Delete

/* comp_captab.c */

[260] Fix | Delete

extern NCURSES_EXPORT(const struct name_table_entry *) _nc_get_table (bool);

[261] Fix | Delete

extern NCURSES_EXPORT(const HashData *) _nc_get_hash_info (bool);

[262] Fix | Delete

extern NCURSES_EXPORT(const struct alias *) _nc_get_alias_table (bool);

[263] Fix | Delete

[264] Fix | Delete

/* comp_hash.c: name lookup */

[265] Fix | Delete

extern NCURSES_EXPORT(struct name_table_entry const *) _nc_find_type_entry

[266] Fix | Delete

(const char *, int, bool);

[267] Fix | Delete

[268] Fix | Delete

/* comp_scan.c: lexical analysis */

[269] Fix | Delete

extern NCURSES_EXPORT(int) _nc_get_token (bool);

[270] Fix | Delete

extern NCURSES_EXPORT(void) _nc_panic_mode (char);

[271] Fix | Delete

extern NCURSES_EXPORT(void) _nc_push_token (int);

[272] Fix | Delete

extern NCURSES_EXPORT_VAR(int) _nc_curr_col;

[273] Fix | Delete

extern NCURSES_EXPORT_VAR(int) _nc_curr_line;

[274] Fix | Delete

extern NCURSES_EXPORT_VAR(int) _nc_syntax;

[275] Fix | Delete

extern NCURSES_EXPORT_VAR(int) _nc_strict_bsd;

[276] Fix | Delete

extern NCURSES_EXPORT_VAR(long) _nc_comment_end;

[277] Fix | Delete

extern NCURSES_EXPORT_VAR(long) _nc_comment_start;

[278] Fix | Delete

extern NCURSES_EXPORT_VAR(long) _nc_curr_file_pos;

[279] Fix | Delete

extern NCURSES_EXPORT_VAR(long) _nc_start_line;

[280] Fix | Delete

#define SYN_TERMINFO 0

[281] Fix | Delete

#define SYN_TERMCAP 1

[282] Fix | Delete

[283] Fix | Delete

/* comp_error.c: warning & abort messages */

[284] Fix | Delete

extern NCURSES_EXPORT(const char *) _nc_get_source (void);

[285] Fix | Delete

extern NCURSES_EXPORT(void) _nc_err_abort (const char *const,...) GCC_PRINTFLIKE(1,2) GCC_NORETURN;

[286] Fix | Delete

extern NCURSES_EXPORT(void) _nc_get_type (char *name);

[287] Fix | Delete

extern NCURSES_EXPORT(void) _nc_set_source (const char *const);

[288] Fix | Delete

extern NCURSES_EXPORT(void) _nc_set_type (const char *const);

[289] Fix | Delete

extern NCURSES_EXPORT(void) _nc_syserr_abort (const char *const,...) GCC_PRINTFLIKE(1,2) GCC_NORETURN;

[290] Fix | Delete

extern NCURSES_EXPORT(void) _nc_warning (const char *const,...) GCC_PRINTFLIKE(1,2);

[291] Fix | Delete

extern NCURSES_EXPORT_VAR(bool) _nc_suppress_warnings;

[292] Fix | Delete

[293] Fix | Delete

/* comp_scan.c */

[294] Fix | Delete

extern NCURSES_EXPORT_VAR(struct token) _nc_curr_token;

[295] Fix | Delete

[296] Fix | Delete

/* captoinfo.c: capability conversion */

[297] Fix | Delete

extern NCURSES_EXPORT(char *) _nc_captoinfo (const char *, const char *, int const);

[298] Fix | Delete

extern NCURSES_EXPORT(char *) _nc_infotocap (const char *, const char *, int const);

[299] Fix | Delete

[300] Fix | Delete

/* home_terminfo.c */

[301] Fix | Delete

extern NCURSES_EXPORT(char *) _nc_home_terminfo (void);

[302] Fix | Delete

[303] Fix | Delete

/* init_keytry.c */

[304] Fix | Delete

#if BROKEN_LINKER

[305] Fix | Delete

#define _nc_tinfo_fkeys _nc_tinfo_fkeysf()

[306] Fix | Delete

extern NCURSES_EXPORT(const struct tinfo_fkeys *) _nc_tinfo_fkeysf (void);

[307] Fix | Delete

#else

[308] Fix | Delete

extern NCURSES_EXPORT_VAR(const struct tinfo_fkeys) _nc_tinfo_fkeys[];

[309] Fix | Delete

#endif

[310] Fix | Delete

[311] Fix | Delete

/* lib_tparm.c */

[312] Fix | Delete

#define NUM_PARM 9

[313] Fix | Delete

[314] Fix | Delete

extern NCURSES_EXPORT_VAR(int) _nc_tparm_err;

[315] Fix | Delete

[316] Fix | Delete

extern NCURSES_EXPORT(int) _nc_tparm_analyze(const char *, char **, int *);

[317] Fix | Delete

[318] Fix | Delete

/* lib_trace.c */

[319] Fix | Delete

extern NCURSES_EXPORT_VAR(unsigned) _nc_tracing;

[320] Fix | Delete

extern NCURSES_EXPORT(const char *) _nc_visbuf (const char *);

[321] Fix | Delete

extern NCURSES_EXPORT(const char *) _nc_visbuf2 (int, const char *);

[322] Fix | Delete

[323] Fix | Delete

/* lib_tputs.c */

[324] Fix | Delete

extern NCURSES_EXPORT_VAR(int) _nc_nulls_sent; /* Add one for every null sent */

[325] Fix | Delete

[326] Fix | Delete

/* comp_main.c: compiler main */

[327] Fix | Delete

extern const char * _nc_progname;

[328] Fix | Delete

[329] Fix | Delete

/* db_iterator.c */

[330] Fix | Delete

extern NCURSES_EXPORT(const char *) _nc_next_db(DBDIRS *, int *);

[331] Fix | Delete

extern NCURSES_EXPORT(const char *) _nc_tic_dir (const char *);

[332] Fix | Delete

extern NCURSES_EXPORT(void) _nc_first_db(DBDIRS *, int *);

[333] Fix | Delete

extern NCURSES_EXPORT(void) _nc_last_db(void);

[334] Fix | Delete

[335] Fix | Delete

/* write_entry.c */

[336] Fix | Delete

extern NCURSES_EXPORT(int) _nc_tic_written (void);

[337] Fix | Delete

[338] Fix | Delete

#endif /* NCURSES_INTERNALS */

[339] Fix | Delete

[340] Fix | Delete

[341] Fix | Delete

* These entrypoints are used by tack.

[342] Fix | Delete

[343] Fix | Delete

[344] Fix | Delete

/* comp_hash.c: name lookup */

[345] Fix | Delete

extern NCURSES_EXPORT(struct name_table_entry const *) _nc_find_entry

[346] Fix | Delete

(const char *, const HashValue *);

[347] Fix | Delete

extern NCURSES_EXPORT(const HashValue *) _nc_get_hash_table (bool);

[348] Fix | Delete

[349] Fix | Delete

/* comp_scan.c: lexical analysis */

[350] Fix | Delete

extern NCURSES_EXPORT(void) _nc_reset_input (FILE *, char *);

[351] Fix | Delete

[352] Fix | Delete

/* comp_expand.c: expand string into readable form */

[353] Fix | Delete

extern NCURSES_EXPORT(char *) _nc_tic_expand (const char *, bool, int);

[354] Fix | Delete

[355] Fix | Delete

/* comp_scan.c: decode string from readable form */

[356] Fix | Delete

extern NCURSES_EXPORT(int) _nc_trans_string (char *, char *);

[357] Fix | Delete

[358] Fix | Delete

#endif /* NCURSES_TERM_ENTRY_H_incl */

[359] Fix | Delete

[360] Fix | Delete

#ifdef __cplusplus

[361] Fix | Delete

}

[362] Fix | Delete

#endif

[363] Fix | Delete

[364] Fix | Delete

/* *INDENT-ON* */

[365] Fix | Delete

#endif /* __TIC_H */

[366] Fix | Delete

[367] Fix | Delete