xref: /freebsd/contrib/ncurses/progs/dump_entry.h (revision 4928135658a9d0eaee37003df6137ab363fcb0b4)
1 /****************************************************************************
2  * Copyright (c) 1998-2011,2013 Free Software Foundation, Inc.              *
3  *                                                                          *
4  * Permission is hereby granted, free of charge, to any person obtaining a  *
5  * copy of this software and associated documentation files (the            *
6  * "Software"), to deal in the Software without restriction, including      *
7  * without limitation the rights to use, copy, modify, merge, publish,      *
8  * distribute, distribute with modifications, sublicense, and/or sell       *
9  * copies of the Software, and to permit persons to whom the Software is    *
10  * furnished to do so, subject to the following conditions:                 *
11  *                                                                          *
12  * The above copyright notice and this permission notice shall be included  *
13  * in all copies or substantial portions of the Software.                   *
14  *                                                                          *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22  *                                                                          *
23  * Except as contained in this notice, the name(s) of the above copyright   *
24  * holders shall not be used in advertising or otherwise to promote the     *
25  * sale, use or other dealings in this Software without prior written       *
26  * authorization.                                                           *
27  ****************************************************************************/
28 
29 /****************************************************************************
30  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
31  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
32  *     and: Thomas E. Dickey                        1996-on                 *
33  ****************************************************************************/
34 
35 /*
36  * $Id: dump_entry.h,v 1.33 2013/12/15 01:08:03 tom Exp $
37  *
38  * Dump control definitions and variables
39  */
40 
41 #ifndef DUMP_ENTRY_H
42 #define DUMP_ENTRY_H 1
43 
44 /* capability output formats */
45 #define F_TERMINFO	0	/* use terminfo names */
46 #define F_VARIABLE	1	/* use C variable names */
47 #define F_TERMCAP	2	/* termcap names with capability conversion */
48 #define F_TCONVERR	3	/* as T_TERMCAP, no skip of untranslatables */
49 #define F_LITERAL	4	/* like F_TERMINFO, but no smart defaults */
50 
51 /* capability sort modes */
52 #define S_DEFAULT	0	/* sort by terminfo name (implicit) */
53 #define S_NOSORT	1	/* don't sort */
54 #define S_TERMINFO	2	/* sort by terminfo names (explicit) */
55 #define S_VARIABLE	3	/* sort by C variable names */
56 #define S_TERMCAP	4	/* sort by termcap names */
57 
58 /* capability types for the comparison hook */
59 #define CMP_BOOLEAN	0	/* comparison on booleans */
60 #define CMP_NUMBER	1	/* comparison on numerics */
61 #define CMP_STRING	2	/* comparison on strings */
62 #define CMP_USE		3	/* comparison on use capabilities */
63 
64 typedef unsigned PredType;
65 typedef unsigned PredIdx;
66 typedef int (*PredFunc) (PredType, PredIdx);
67 typedef void (*PredHook) (PredType, PredIdx, const char *);
68 
69 extern NCURSES_CONST char *nametrans(const char *);
70 extern int fmt_entry(TERMTYPE *, PredFunc, int, int, int, int);
71 extern int show_entry(void);
72 extern void compare_entry(PredHook, TERMTYPE *, bool);
73 extern void dump_entry(TERMTYPE *, int, int, int, PredFunc);
74 extern void dump_init(const char *, int, int, int, int, unsigned, bool);
75 extern void dump_uses(const char *, bool);
76 extern void repair_acsc(TERMTYPE *tp);
77 
78 #define FAIL	-1
79 
80 #endif /* DUMP_ENTRY_H */
81