ncurses 6.2 - patch 20200801
[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.51 2020/08/01 21:07:50 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_LIMITS_H
62 # include <limits.h>
63 #elif HAVE_SYS_PARAM_H
64 # include <sys/param.h>
65 #endif
66
67 #if HAVE_DIRENT_H
68 # include <dirent.h>
69 # define NAMLEN(dirent) strlen((dirent)->d_name)
70 # if defined(_FILE_OFFSET_BITS) && defined(HAVE_STRUCT_DIRENT64)
71 #  if !defined(_LP64) && (_FILE_OFFSET_BITS == 64)
72 #   define      DIRENT  struct dirent64
73 #  else
74 #   define      DIRENT  struct dirent
75 #  endif
76 # else
77 #  define       DIRENT  struct dirent
78 # endif
79 #else
80 # define DIRENT struct direct
81 # define NAMLEN(dirent) (dirent)->d_namlen
82 # if HAVE_SYS_NDIR_H
83 #  include <sys/ndir.h>
84 # endif
85 # if HAVE_SYS_DIR_H
86 #  include <sys/dir.h>
87 # endif
88 # if HAVE_NDIR_H
89 #  include <ndir.h>
90 # endif
91 #endif
92
93 #if HAVE_INTTYPES_H
94 # include <inttypes.h>
95 #else
96 # if HAVE_STDINT_H
97 #  include <stdint.h>
98 # endif
99 #endif
100
101 #include <assert.h>
102 #include <errno.h>
103
104 #if DECL_ERRNO
105 extern int errno;
106 #endif
107
108 #if HAVE_GETOPT_H
109 #include <getopt.h>
110 #elif !defined(HAVE_GETOPT_HEADER)
111 /* 'getopt()' may be prototyped in <stdlib.h>, but declaring its
112  * variables doesn't hurt.
113  */
114 extern char *optarg;
115 extern int optind;
116 #endif /* HAVE_GETOPT_H */
117
118 #define NCURSES_INTERNALS 1
119 #define NCURSES_OPAQUE    0
120
121 #include <curses.h>
122
123 #if !(defined(NCURSES_WGETCH_EVENTS) && defined(NEED_KEY_EVENT))
124 #undef KEY_EVENT                /* reduce compiler-warnings with Visual C++ */
125 #endif
126
127 #include <term_entry.h>
128 #include <nc_termios.h>
129 #include <tic.h>
130 #include <nc_tparm.h>
131
132 #include <nc_string.h>
133 #include <nc_alloc.h>
134
135 #if HAVE_NC_FREEALL
136 #undef ExitProgram
137 #ifdef USE_LIBTINFO
138 #define ExitProgram(code) exit_terminfo(code)
139 #else
140 #define ExitProgram(code) _nc_free_tic(code)
141 #endif
142 #endif
143
144 #define VtoTrace(opt) (unsigned) ((opt > 0) ? opt : (opt == 0))
145
146 /* error-returns for tput */
147 #define ErrUsage        2
148 #define ErrTermType     3
149 #define ErrCapName      4
150 #define ErrSystem(n)    (4 + (n))
151
152 #if defined(__GNUC__) && defined(_FORTIFY_SOURCE)
153 #define IGNORE_RC(func) errno = (int) func
154 #else
155 #define IGNORE_RC(func) (void) func
156 #endif /* gcc workarounds */
157
158 /* usually in <unistd.h> */
159 #ifndef STDIN_FILENO
160 #define STDIN_FILENO 0
161 #endif
162
163 #ifndef STDOUT_FILENO
164 #define STDOUT_FILENO 1
165 #endif
166
167 #ifndef STDERR_FILENO
168 #define STDERR_FILENO 2
169 #endif
170
171 #ifndef EXIT_SUCCESS
172 #define EXIT_SUCCESS 0
173 #endif
174
175 #ifndef EXIT_FAILURE
176 #define EXIT_FAILURE 1
177 #endif
178
179 #ifndef R_OK
180 #define R_OK    4               /* Test for readable.  */
181 #endif
182
183 #ifndef W_OK
184 #define W_OK    2               /* Test for writable.  */
185 #endif
186
187 #ifndef X_OK
188 #define X_OK    1               /* Test for executable.  */
189 #endif
190
191 #ifndef F_OK
192 #define F_OK    0               /* Test for existence.  */
193 #endif
194
195 /* usually in <unistd.h> */
196 #ifndef STDOUT_FILENO
197 #define STDOUT_FILENO 1
198 #endif
199
200 #ifndef STDERR_FILENO
201 #define STDERR_FILENO 2
202 #endif
203
204 /* may be in limits.h, included from various places */
205 #ifndef PATH_MAX
206 # if defined(_POSIX_PATH_MAX)
207 #  define PATH_MAX _POSIX_PATH_MAX
208 # elif defined(MAXPATHLEN)
209 #  define PATH_MAX MAXPATHLEN
210 # else
211 #  define PATH_MAX 255          /* the Posix minimum pathsize */
212 # endif
213 #endif
214
215 /* We use isascii only to guard against use of 7-bit ctype tables in the
216  * isprint test in infocmp.
217  */
218 #if !HAVE_ISASCII
219 # undef isascii
220 # if ('z'-'a' == 25) && ('z' < 127) && ('Z'-'A' == 25) && ('Z' < 127) && ('9' < 127)
221 #  define isascii(c) (UChar(c) <= 127)
222 # else
223 #  define isascii(c) 1          /* not really ascii anyway */
224 # endif
225 #endif
226
227 #define UChar(c)    ((unsigned char)(c))
228
229 #define SIZEOF(v) (sizeof(v)/sizeof(v[0]))
230
231 #define NCURSES_EXT_NUMBERS (NCURSES_EXT_COLORS && HAVE_INIT_EXTENDED_COLOR)
232
233 #if NCURSES_EXT_NUMBERS
234 #else
235 #define _nc_free_termtype2(t) _nc_free_termtype(t)
236 #define _nc_read_entry2(n,f,t) _nc_read_entry(n,f,t)
237 #endif
238
239 #endif /* PROGS_PRIV_H */