ncurses 6.2 - patch 20200725
[ncurses.git] / progs / progs.priv.h
1 /****************************************************************************
2  * Copyright 2019,2020 Thomas E. Dickey                                     *
3  * Copyright 1998-2015,2017 Free Software Foundation, Inc.                  *
4  *                                                                          *
5  * Permission is hereby granted, free of charge, to any person obtaining a  *
6  * copy of this software and associated documentation files (the            *
7  * "Software"), to deal in the Software without restriction, including      *
8  * without limitation the rights to use, copy, modify, merge, publish,      *
9  * distribute, distribute with modifications, sublicense, and/or sell       *
10  * copies of the Software, and to permit persons to whom the Software is    *
11  * furnished to do so, subject to the following conditions:                 *
12  *                                                                          *
13  * The above copyright notice and this permission notice shall be included  *
14  * in all copies or substantial portions of the Software.                   *
15  *                                                                          *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23  *                                                                          *
24  * Except as contained in this notice, the name(s) of the above copyright   *
25  * holders shall not be used in advertising or otherwise to promote the     *
26  * sale, use or other dealings in this Software without prior written       *
27  * authorization.                                                           *
28  ****************************************************************************/
29
30 /****************************************************************************
31  *  Author: Thomas E. Dickey                    1997-on                     *
32  ****************************************************************************/
33 /*
34  * $Id: progs.priv.h,v 1.50 2020/07/25 22:56:33 tom Exp $
35  *
36  *      progs.priv.h
37  *
38  *      Header file for curses utility programs
39  */
40
41 #ifndef PROGS_PRIV_H
42 #define PROGS_PRIV_H 1
43
44 #include <ncurses_cfg.h>
45
46 #if USE_RCS_IDS
47 #define MODULE_ID(id) static const char Ident[] = id;
48 #else
49 #define MODULE_ID(id)           /*nothing */
50 #endif
51
52 #include <stdlib.h>
53 #include <ctype.h>
54 #include <string.h>
55 #include <sys/types.h>
56
57 #if HAVE_UNISTD_H
58 #include <unistd.h>
59 #endif
60
61 #if HAVE_SYS_BSDTYPES_H
62 #include <sys/bsdtypes.h>       /* needed for ISC */
63 #endif
64
65 #if HAVE_LIMITS_H
66 # include <limits.h>
67 #elif HAVE_SYS_PARAM_H
68 # include <sys/param.h>
69 #endif
70
71 #if HAVE_DIRENT_H
72 # include <dirent.h>
73 # define NAMLEN(dirent) strlen((dirent)->d_name)
74 # if defined(_FILE_OFFSET_BITS) && defined(HAVE_STRUCT_DIRENT64)
75 #  if !defined(_LP64) && (_FILE_OFFSET_BITS == 64)
76 #   define      DIRENT  struct dirent64
77 #  else
78 #   define      DIRENT  struct dirent
79 #  endif
80 # else
81 #  define       DIRENT  struct dirent
82 # endif
83 #else
84 # define DIRENT struct direct
85 # define NAMLEN(dirent) (dirent)->d_namlen
86 # if HAVE_SYS_NDIR_H
87 #  include <sys/ndir.h>
88 # endif
89 # if HAVE_SYS_DIR_H
90 #  include <sys/dir.h>
91 # endif
92 # if HAVE_NDIR_H
93 #  include <ndir.h>
94 # endif
95 #endif
96
97 #if HAVE_INTTYPES_H
98 # include <inttypes.h>
99 #else
100 # if HAVE_STDINT_H
101 #  include <stdint.h>
102 # endif
103 #endif
104
105 #include <assert.h>
106 #include <errno.h>
107
108 #if DECL_ERRNO
109 extern int errno;
110 #endif
111
112 #if HAVE_GETOPT_H
113 #include <getopt.h>
114 #elif !defined(HAVE_GETOPT_HEADER)
115 /* 'getopt()' may be prototyped in <stdlib.h>, but declaring its
116  * variables doesn't hurt.
117  */
118 extern char *optarg;
119 extern int optind;
120 #endif /* HAVE_GETOPT_H */
121
122 #define NCURSES_INTERNALS 1
123 #define NCURSES_OPAQUE    0
124
125 #include <curses.h>
126
127 #if !(defined(NCURSES_WGETCH_EVENTS) && defined(NEED_KEY_EVENT))
128 #undef KEY_EVENT                /* reduce compiler-warnings with Visual C++ */
129 #endif
130
131 #include <term_entry.h>
132 #include <nc_termios.h>
133 #include <tic.h>
134 #include <nc_tparm.h>
135
136 #include <nc_string.h>
137 #include <nc_alloc.h>
138
139 #if HAVE_NC_FREEALL
140 #undef ExitProgram
141 #ifdef USE_LIBTINFO
142 #define ExitProgram(code) exit_terminfo(code)
143 #else
144 #define ExitProgram(code) _nc_free_tic(code)
145 #endif
146 #endif
147
148 #define VtoTrace(opt) (unsigned) ((opt > 0) ? opt : (opt == 0))
149
150 /* error-returns for tput */
151 #define ErrUsage        2
152 #define ErrTermType     3
153 #define ErrCapName      4
154 #define ErrSystem(n)    (4 + (n))
155
156 #if defined(__GNUC__) && defined(_FORTIFY_SOURCE)
157 #define IGNORE_RC(func) errno = (int) func
158 #else
159 #define IGNORE_RC(func) (void) func
160 #endif /* gcc workarounds */
161
162 /* usually in <unistd.h> */
163 #ifndef STDIN_FILENO
164 #define STDIN_FILENO 0
165 #endif
166
167 #ifndef STDOUT_FILENO
168 #define STDOUT_FILENO 1
169 #endif
170
171 #ifndef STDERR_FILENO
172 #define STDERR_FILENO 2
173 #endif
174
175 #ifndef EXIT_SUCCESS
176 #define EXIT_SUCCESS 0
177 #endif
178
179 #ifndef EXIT_FAILURE
180 #define EXIT_FAILURE 1
181 #endif
182
183 #ifndef R_OK
184 #define R_OK    4               /* Test for readable.  */
185 #endif
186
187 #ifndef W_OK
188 #define W_OK    2               /* Test for writable.  */
189 #endif
190
191 #ifndef X_OK
192 #define X_OK    1               /* Test for executable.  */
193 #endif
194
195 #ifndef F_OK
196 #define F_OK    0               /* Test for existence.  */
197 #endif
198
199 /* usually in <unistd.h> */
200 #ifndef STDOUT_FILENO
201 #define STDOUT_FILENO 1
202 #endif
203
204 #ifndef STDERR_FILENO
205 #define STDERR_FILENO 2
206 #endif
207
208 /* may be in limits.h, included from various places */
209 #ifndef PATH_MAX
210 # if defined(_POSIX_PATH_MAX)
211 #  define PATH_MAX _POSIX_PATH_MAX
212 # elif defined(MAXPATHLEN)
213 #  define PATH_MAX MAXPATHLEN
214 # else
215 #  define PATH_MAX 255          /* the Posix minimum pathsize */
216 # endif
217 #endif
218
219 /* We use isascii only to guard against use of 7-bit ctype tables in the
220  * isprint test in infocmp.
221  */
222 #if !HAVE_ISASCII
223 # undef isascii
224 # if ('z'-'a' == 25) && ('z' < 127) && ('Z'-'A' == 25) && ('Z' < 127) && ('9' < 127)
225 #  define isascii(c) (UChar(c) <= 127)
226 # else
227 #  define isascii(c) 1          /* not really ascii anyway */
228 # endif
229 #endif
230
231 #define UChar(c)    ((unsigned char)(c))
232
233 #define SIZEOF(v) (sizeof(v)/sizeof(v[0]))
234
235 #define NCURSES_EXT_NUMBERS (NCURSES_EXT_COLORS && HAVE_INIT_EXTENDED_COLOR)
236
237 #if NCURSES_EXT_NUMBERS
238 #else
239 #define _nc_free_termtype2(t) _nc_free_termtype(t)
240 #define _nc_read_entry2(n,f,t) _nc_read_entry(n,f,t)
241 #endif
242
243 #endif /* PROGS_PRIV_H */