xref: /freebsd/contrib/ncurses/progs/dump_entry.h (revision abaad9d77deb42e9e5d04c6ecc2d98cf92e0ff2d)
1 /****************************************************************************
2  * Copyright (c) 1998-2017,2018 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.41 2018/05/26 15:22:30 tom Exp $
37  *
38  * Dump control definitions and variables
39  */
40 
41 #ifndef DUMP_ENTRY_H
42 #define DUMP_ENTRY_H 1
43 
44 #define NCURSES_OPAQUE    0
45 #define NCURSES_INTERNALS 1
46 #include <curses.h>
47 #include <term.h>
48 
49 /* capability output formats */
50 #define F_TERMINFO	0	/* use terminfo names */
51 #define F_VARIABLE	1	/* use C variable names */
52 #define F_TERMCAP	2	/* termcap names with capability conversion */
53 #define F_TCONVERR	3	/* as T_TERMCAP, no skip of untranslatables */
54 #define F_LITERAL	4	/* like F_TERMINFO, but no smart defaults */
55 
56 /* capability sort modes */
57 #define S_DEFAULT	0	/* sort by terminfo name (implicit) */
58 #define S_NOSORT	1	/* don't sort */
59 #define S_TERMINFO	2	/* sort by terminfo names (explicit) */
60 #define S_VARIABLE	3	/* sort by C variable names */
61 #define S_TERMCAP	4	/* sort by termcap names */
62 
63 /* capability types for the comparison hook */
64 #define CMP_BOOLEAN	0	/* comparison on booleans */
65 #define CMP_NUMBER	1	/* comparison on numerics */
66 #define CMP_STRING	2	/* comparison on strings */
67 #define CMP_USE		3	/* comparison on use capabilities */
68 
69 typedef unsigned PredType;
70 typedef unsigned PredIdx;
71 typedef int (*PredFunc) (PredType, PredIdx);
72 typedef void (*PredHook) (PredType, PredIdx, const char *);
73 
74 extern NCURSES_CONST char *nametrans(const char *);
75 extern bool has_params(const char *src);
76 extern int fmt_entry(TERMTYPE2 *, PredFunc, int, int, int, int);
77 extern int show_entry(void);
78 extern void compare_entry(PredHook, TERMTYPE2 *, bool);
79 extern void dump_entry(TERMTYPE2 *, int, int, int, PredFunc);
80 extern void dump_init(const char *, int, int, bool, int, int, unsigned, bool,
81 		      bool, int);
82 extern void dump_uses(const char *, bool);
83 extern void repair_acsc(TERMTYPE2 *tp);
84 
85 #define L_CURL "{"
86 #define R_CURL "}"
87 
88 #define FAIL	-1
89 
90 #endif /* DUMP_ENTRY_H */
91