4b1b53811328494f858a4931ea096a8da06b861d
[ncurses.git] / progs / progs.priv.h
1 /****************************************************************************
2  * Copyright (c) 1998-2015,2017 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: Thomas E. Dickey                    1997-on                     *
31  ****************************************************************************/
32 /*
33  * $Id: progs.priv.h,v 1.45 2017/10/07 20:42:10 tom Exp $
34  *
35  *      progs.priv.h
36  *
37  *      Header file for curses utility programs
38  */
39
40 #ifndef PROGS_PRIV_H
41 #define PROGS_PRIV_H 1
42
43 #include <ncurses_cfg.h>
44
45 #if USE_RCS_IDS
46 #define MODULE_ID(id) static const char Ident[] = id;
47 #else
48 #define MODULE_ID(id)           /*nothing */
49 #endif
50
51 #include <stdlib.h>
52 #include <ctype.h>
53 #include <string.h>
54 #include <sys/types.h>
55
56 #if HAVE_UNISTD_H
57 #include <unistd.h>
58 #endif
59
60 #if HAVE_SYS_BSDTYPES_H
61 #include <sys/bsdtypes.h>       /* needed for ISC */
62 #endif
63
64 #if HAVE_LIMITS_H
65 # include <limits.h>
66 #elif HAVE_SYS_PARAM_H
67 # include <sys/param.h>
68 #endif
69
70 #if HAVE_DIRENT_H
71 # include <dirent.h>
72 # define NAMLEN(dirent) strlen((dirent)->d_name)
73 # if defined(_FILE_OFFSET_BITS) && defined(HAVE_STRUCT_DIRENT64)
74 #  if !defined(_LP64) && (_FILE_OFFSET_BITS == 64)
75 #   define      DIRENT  struct dirent64
76 #  else
77 #   define      DIRENT  struct dirent
78 #  endif
79 # else
80 #  define       DIRENT  struct dirent
81 # endif
82 #else
83 # define DIRENT struct direct
84 # define NAMLEN(dirent) (dirent)->d_namlen
85 # if HAVE_SYS_NDIR_H
86 #  include <sys/ndir.h>
87 # endif
88 # if HAVE_SYS_DIR_H
89 #  include <sys/dir.h>
90 # endif
91 # if HAVE_NDIR_H
92 #  include <ndir.h>
93 # endif
94 #endif
95
96 #if HAVE_INTTYPES_H
97 # include <inttypes.h>
98 #else
99 # if HAVE_STDINT_H
100 #  include <stdint.h>
101 # endif
102 #endif
103
104 #include <assert.h>
105 #include <errno.h>
106
107 #if DECL_ERRNO
108 extern int errno;
109 #endif
110
111 #if HAVE_GETOPT_H
112 #include <getopt.h>
113 #elif !defined(HAVE_GETOPT_HEADER)
114 /* 'getopt()' may be prototyped in <stdlib.h>, but declaring its
115  * variables doesn't hurt.
116  */
117 extern char *optarg;
118 extern int optind;
119 #endif /* HAVE_GETOPT_H */
120
121 #define NCURSES_INTERNALS 1
122 #define NCURSES_OPAQUE    0
123
124 #include <curses.h>
125 #include <term_entry.h>
126 #include <nc_termios.h>
127 #include <tic.h>
128 #include <nc_tparm.h>
129
130 #include <nc_string.h>
131 #include <nc_alloc.h>
132 #if HAVE_NC_FREEALL
133 #undef ExitProgram
134 #ifdef USE_LIBTINFO
135 #define ExitProgram(code) _nc_free_tinfo(code)
136 #else
137 #define ExitProgram(code) _nc_free_tic(code)
138 #endif
139 #endif
140
141 /* error-returns for tput */
142 #define ErrUsage        2
143 #define ErrTermType     3
144 #define ErrCapName      4
145 #define ErrSystem(n)    (4 + (n))
146
147 #if defined(__GNUC__) && defined(_FORTIFY_SOURCE)
148 #define IGNORE_RC(func) errno = (int) func
149 #else
150 #define IGNORE_RC(func) (void) func
151 #endif /* gcc workarounds */
152
153 /* usually in <unistd.h> */
154 #ifndef STDOUT_FILENO
155 #define STDOUT_FILENO 1
156 #endif
157
158 #ifndef STDERR_FILENO
159 #define STDERR_FILENO 2
160 #endif
161
162 #ifndef EXIT_SUCCESS
163 #define EXIT_SUCCESS 0
164 #endif
165
166 #ifndef EXIT_FAILURE
167 #define EXIT_FAILURE 1
168 #endif
169
170 #ifndef R_OK
171 #define R_OK    4               /* Test for readable.  */
172 #endif
173
174 #ifndef W_OK
175 #define W_OK    2               /* Test for writable.  */
176 #endif
177
178 #ifndef X_OK
179 #define X_OK    1               /* Test for executable.  */
180 #endif
181
182 #ifndef F_OK
183 #define F_OK    0               /* Test for existence.  */
184 #endif
185
186 /* usually in <unistd.h> */
187 #ifndef STDOUT_FILENO
188 #define STDOUT_FILENO 1
189 #endif
190
191 #ifndef STDERR_FILENO
192 #define STDERR_FILENO 2
193 #endif
194
195 /* may be in limits.h, included from various places */
196 #ifndef PATH_MAX
197 # if defined(_POSIX_PATH_MAX)
198 #  define PATH_MAX _POSIX_PATH_MAX
199 # elif defined(MAXPATHLEN)
200 #  define PATH_MAX MAXPATHLEN
201 # else
202 #  define PATH_MAX 255          /* the Posix minimum pathsize */
203 # endif
204 #endif
205
206 /* We use isascii only to guard against use of 7-bit ctype tables in the
207  * isprint test in infocmp.
208  */
209 #if !HAVE_ISASCII
210 # undef isascii
211 # if ('z'-'a' == 25) && ('z' < 127) && ('Z'-'A' == 25) && ('Z' < 127) && ('9' < 127)
212 #  define isascii(c) (UChar(c) <= 127)
213 # else
214 #  define isascii(c) 1          /* not really ascii anyway */
215 # endif
216 #endif
217
218 #define UChar(c)    ((unsigned char)(c))
219
220 #define SIZEOF(v) (sizeof(v)/sizeof(v[0]))
221
222 #define NCURSES_EXT_NUMBERS (NCURSES_EXT_COLORS && HAVE_INIT_EXTENDED_COLOR)
223
224 #if NCURSES_EXT_NUMBERS
225 #else
226 #define _nc_free_termtype2(t) _nc_free_termtype(t)
227 #define _nc_read_entry2(n,f,t) _nc_read_entry(n,f,t)
228 #endif
229
230 #endif /* PROGS_PRIV_H */