5447fa6eae2562ea5824978d392a347661b05348
[ncurses.git] / test / test.priv.h
1 /****************************************************************************
2  * Copyright (c) 1998-2007,2008 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                    1996-on                     *
31  ****************************************************************************/
32 /* $Id: test.priv.h,v 1.69 2008/01/26 22:05:48 tom Exp $ */
33
34 #ifndef __TEST_PRIV_H
35 #define __TEST_PRIV_H 1
36
37 #include <ncurses_cfg.h>
38
39 /*
40  * Fix ifdef's that look for the form/menu/panel libraries, if we are building
41  * with wide-character ncurses.
42  */
43 #ifdef  HAVE_LIBFORMW
44 #define HAVE_LIBFORMW 1
45 #endif
46
47 #ifdef  HAVE_LIBMENUW
48 #define HAVE_LIBMENUW 1
49 #endif
50
51 #ifdef  HAVE_LIBPANELW
52 #define HAVE_LIBPANELW 1
53 #endif
54
55 /*
56  * Fallback definitions to accommodate broken compilers.
57  */
58 #ifndef HAVE_CURSES_VERSION
59 #define HAVE_CURSES_VERSION 0
60 #endif
61
62 #ifndef HAVE_FILTER
63 #define HAVE_FILTER 0
64 #endif
65
66 #ifndef HAVE_FORM_H
67 #define HAVE_FORM_H 0
68 #endif
69
70 #ifndef HAVE_GETBEGX
71 #define HAVE_GETBEGX 0
72 #endif
73
74 #ifndef HAVE_GETCURX
75 #define HAVE_GETCURX 0
76 #endif
77
78 #ifndef HAVE_GETMAXX
79 #define HAVE_GETMAXX 0
80 #endif
81
82 #ifndef HAVE_GETOPT_H
83 #define HAVE_GETOPT_H 0
84 #endif
85
86 #ifndef HAVE_GETWIN
87 #define HAVE_GETWIN 0
88 #endif
89
90 #ifndef HAVE_LIBFORM
91 #define HAVE_LIBFORM 0
92 #endif
93
94 #ifndef HAVE_LIBMENU
95 #define HAVE_LIBMENU 0
96 #endif
97
98 #ifndef HAVE_LIBPANEL
99 #define HAVE_LIBPANEL 0
100 #endif
101
102 #ifndef HAVE_LOCALE_H
103 #define HAVE_LOCALE_H 0
104 #endif
105
106 #ifndef HAVE_MENU_H
107 #define HAVE_MENU_H 0
108 #endif
109
110 #ifndef HAVE_MVVLINE
111 #define HAVE_MVVLINE 0
112 #endif
113
114 #ifndef HAVE_MVWVLINE
115 #define HAVE_MVWVLINE 0
116 #endif
117
118 #ifndef HAVE_NAPMS
119 #define HAVE_NAPMS 1
120 #endif
121
122 #ifndef HAVE_NC_ALLOC_H
123 #define HAVE_NC_ALLOC_H 0
124 #endif
125
126 #ifndef HAVE_PANEL_H
127 #define HAVE_PANEL_H 0
128 #endif
129
130 #ifndef HAVE_PUTWIN
131 #define HAVE_PUTWIN 0
132 #endif
133
134 #ifndef HAVE_RESIZE_TERM
135 #define HAVE_RESIZE_TERM 0
136 #endif
137
138 #ifndef HAVE_RIPOFFLINE
139 #define HAVE_RIPOFFLINE 0
140 #endif
141
142 #ifndef HAVE_SETUPTERM
143 #define HAVE_SETUPTERM 0
144 #endif
145
146 #ifndef HAVE_SLK_COLOR
147 #define HAVE_SLK_COLOR 0
148 #endif
149
150 #ifndef HAVE_SLK_INIT
151 #define HAVE_SLK_INIT 0
152 #endif
153
154 #ifndef HAVE_TERMATTRS
155 #define HAVE_TERMATTRS 0
156 #endif
157
158 #ifndef HAVE_TERMNAME
159 #define HAVE_TERMNAME 0
160 #endif
161
162 #ifndef HAVE_TGETENT
163 #define HAVE_TGETENT 0
164 #endif
165
166 #ifndef HAVE_TIGETNUM
167 #define HAVE_TIGETNUM 0
168 #endif
169
170 #ifndef HAVE_TYPEAHEAD
171 #define HAVE_TYPEAHEAD 0
172 #endif
173
174 #ifndef HAVE_TIGETSTR
175 #define HAVE_TIGETSTR 0
176 #endif
177
178 #ifndef HAVE_WINSSTR
179 #define HAVE_WINSSTR 0
180 #endif
181
182 #ifndef HAVE_USE_DEFAULT_COLORS
183 #define HAVE_USE_DEFAULT_COLORS 0
184 #endif
185
186 #ifndef HAVE_WRESIZE
187 #define HAVE_WRESIZE 0
188 #endif
189
190 #ifndef NCURSES_EXT_FUNCS
191 #define NCURSES_EXT_FUNCS 0
192 #endif
193
194 #ifndef NEED_PTEM_H
195 #define NEED_PTEM_H 0
196 #endif
197
198 #ifndef NO_LEAKS
199 #define NO_LEAKS 0
200 #endif
201
202 #include <stdlib.h>
203 #include <string.h>
204 #include <sys/types.h>
205
206 #if HAVE_UNISTD_H
207 #include <unistd.h>
208 #endif
209
210 #include <signal.h>     /* include before curses.h to work around glibc bug */
211
212 #if defined(HAVE_XCURSES)
213 #include <xcurses.h>
214 #elif defined(HAVE_NCURSESW_NCURSES_H)
215 #include <ncursesw/curses.h>
216 #elif defined(HAVE_NCURSES_NCURSES_H)
217 #include <ncurses/curses.h>
218 #else
219 #include <curses.h>
220 #endif
221
222 #if defined(HAVE_XCURSES)
223 /* no other headers */
224 #undef  HAVE_SETUPTERM          /* nonfunctional */
225 #define HAVE_SETUPTERM 0
226 #undef  HAVE_TGETENT            /* nonfunctional */
227 #define HAVE_TGETENT 0
228 #undef  HAVE_TIGETSTR           /* nonfunctional */
229 #define HAVE_TIGETSTR 0
230 #elif defined(HAVE_NCURSESW_TERM_H)
231 #include <ncursesw/term.h>
232 #elif defined(HAVE_NCURSES_TERM_H)
233 #include <ncurses/term.h>
234 #elif defined(HAVE_TERM_H)
235 #include <term.h>
236 #endif
237
238 #ifdef NCURSES_VERSION
239 #define HAVE_COLOR_SET 1
240 #define HAVE_CHGAT 1
241 #endif
242
243 #if HAVE_GETOPT_H
244 #include <getopt.h>
245 #else
246 /* 'getopt()' may be prototyped in <stdlib.h>, but declaring its variables
247  * doesn't hurt.
248  */
249 extern char *optarg;
250 extern int optind;
251 #endif /* HAVE_GETOPT_H */
252
253 #if HAVE_LOCALE_H
254 #include <locale.h>
255 #else
256 #define setlocale(name,string) /* nothing */
257 #endif
258
259 #include <assert.h>
260 #include <ctype.h>
261
262 #ifndef GCC_NORETURN
263 #define GCC_NORETURN /* nothing */
264 #endif
265 #ifndef GCC_PRINTFLIKE
266 #define GCC_PRINTFLIKE(a,b) /* nothing */
267 #endif
268 #ifndef GCC_UNUSED
269 #define GCC_UNUSED /* nothing */
270 #endif
271
272 #ifndef HAVE_GETNSTR
273 #define getnstr(s,n) getstr(s)
274 #endif
275
276 #ifndef USE_SOFTKEYS
277 #if HAVE_SLK_INIT
278 #define USE_SOFTKEYS 1
279 #else
280 #define USE_SOFTKEYS 0
281 #endif
282 #endif
283
284 #ifndef USE_WIDEC_SUPPORT
285 #if defined(_XOPEN_SOURCE_EXTENDED) && defined(WACS_ULCORNER)
286 #define USE_WIDEC_SUPPORT 1
287 #else
288 #define USE_WIDEC_SUPPORT 0
289 #endif
290 #endif
291
292 #if HAVE_PANEL_H && HAVE_LIBPANEL
293 #define USE_LIBPANEL 1
294 #else
295 #define USE_LIBPANEL 0
296 #endif
297
298 #if HAVE_MENU_H && HAVE_LIBMENU
299 #define USE_LIBMENU 1
300 #else
301 #define USE_LIBMENU 0
302 #endif
303
304 #if HAVE_FORM_H && HAVE_LIBFORM
305 #define USE_LIBFORM 1
306 #else
307 #define USE_LIBFORM 0
308 #endif
309
310 #ifndef HAVE_TYPE_ATTR_T
311 #if !USE_WIDEC_SUPPORT
312 #define attr_t chtype
313 #endif
314 #endif
315
316 #undef NCURSES_CH_T
317 #if !USE_WIDEC_SUPPORT
318 #define NCURSES_CH_T chtype
319 #else
320 #define NCURSES_CH_T cchar_t
321 #endif
322
323 #ifndef NCURSES_OPAQUE
324 #define NCURSES_OPAQUE 0
325 #endif
326
327 #ifndef CCHARW_MAX
328 #define CCHARW_MAX 5
329 #endif
330
331 #ifndef CTRL
332 #define CTRL(x)         ((x) & 0x1f)
333 #endif
334
335 #define QUIT            CTRL('Q')
336 #define ESCAPE          CTRL('[')
337
338 #ifndef KEY_MIN
339 #define KEY_MIN 256     /* not defined in Solaris 8 */
340 #endif
341
342 /*
343  * Workaround for HPUX
344  */
345 #if defined(__hpux) && !defined(NCURSES_VERSION)
346 #define getbegx(w) __getbegx(w)
347 #define getbegy(w) __getbegy(w)
348 #define getcurx(w) __getcurx(w)
349 #define getcury(w) __getcury(w)
350 #define getmaxx(w) __getmaxx(w)
351 #define getmaxy(w) __getmaxy(w)
352 #define getparx(w) __getparx(w)
353 #define getpary(w) __getpary(w)
354 #endif
355
356 /*
357  * These usually are implemented as macros, but may be functions.
358  */
359 #if !defined(getcurx) && !HAVE_GETCURX
360 #define getcurx(win)            ((win)?(win)->_curx:ERR)
361 #define getcury(win)            ((win)?(win)->_cury:ERR)
362 #endif
363
364 #if !defined(getbegx) && !HAVE_GETBEGX
365 #define getbegx(win)            ((win)?(win)->_begx:ERR)
366 #define getbegy(win)            ((win)?(win)->_begy:ERR)
367 #endif
368
369 #if !defined(getmaxx) && !HAVE_GETMAXX
370 #define getmaxx(win)            ((win)?((win)->_maxx + 1):ERR)
371 #define getmaxy(win)            ((win)?((win)->_maxy + 1):ERR)
372 #endif
373
374 #if !defined(mvwvline) && !HAVE_MVWVLINE
375 #define mvwvline(w,y,x,ch,n)    (move(y,x) == ERR ? ERR : wvline(w,ch,n))
376 #define mvwhline(w,y,x,ch,n)    (move(y,x) == ERR ? ERR : whline(w,ch,n))
377 #endif
378
379 #if !defined(mvvline) && !HAVE_MVVLINE
380 #define mvvline(y,x,ch,n)       (move(y,x) == ERR ? ERR : vline(ch,n))
381 #define mvhline(y,x,ch,n)       (move(y,x) == ERR ? ERR : hline(ch,n))
382 #endif
383
384 /*
385  * Try to accommodate curses implementations that have no terminfo support.
386  */
387 #if HAVE_TIGETNUM
388 #define TIGETNUM(ti,tc) tigetnum(ti)
389 #else
390 #define TIGETNUM(ti,tc) tgetnum(tc)
391 #endif
392
393 #if HAVE_TIGETSTR
394 #define TIGETSTR(ti,tc) tigetstr(ti)
395 #else
396 #define TIGETSTR(ti,tc) tgetstr(tc,&area_pointer)
397 #endif
398
399 /* ncurses implements tparm() with varargs, X/Open with a fixed-parameter list
400  * (which is incompatible with legacy usage, doesn't solve any problems).
401  */
402 #define tparm3(a,b,c) tparm(a,b,c,0,0,0,0,0,0,0)
403 #define tparm2(a,b)   tparm(a,b,0,0,0,0,0,0,0,0)
404
405 #define UChar(c)    ((unsigned char)(c))
406
407 #define SIZEOF(table)   (sizeof(table)/sizeof(table[0]))
408
409 #if defined(NCURSES_VERSION) && HAVE_NC_ALLOC_H
410 #include <nc_alloc.h>
411 #if HAVE_NC_FREEALL && defined(USE_TINFO)
412 #undef ExitProgram
413 #define ExitProgram(code) _nc_free_tinfo(code)
414 #endif
415 #else
416 #define typeMalloc(type,n) (type *) malloc((n) * sizeof(type))
417 #define typeRealloc(type,n,p) (type *) realloc(p, (n) * sizeof(type))
418 #endif
419
420 #ifndef ExitProgram
421 #define ExitProgram(code) exit(code)
422 #endif
423
424 #ifndef EXIT_SUCCESS
425 #define EXIT_SUCCESS 0
426 #endif
427 #ifndef EXIT_FAILURE
428 #define EXIT_FAILURE 1
429 #endif
430
431 /* Use this to quiet gcc's -Wwrite-strings warnings, but accommodate SVr4
432  * curses which doesn't have const parameters declared (so far) in the places
433  * that XSI shows.
434  */
435 #ifndef NCURSES_CONST
436 #define NCURSES_CONST /* nothing */
437 #endif
438
439 /* out-of-band values for representing absent capabilities */
440 #define ABSENT_BOOLEAN          ((signed char)-1)       /* 255 */
441 #define ABSENT_NUMERIC          (-1)
442 #define ABSENT_STRING           (char *)0
443
444 /* out-of-band values for representing cancels */
445 #define CANCELLED_BOOLEAN       ((signed char)-2)       /* 254 */
446 #define CANCELLED_NUMERIC       (-2)
447 #define CANCELLED_STRING        (char *)(-1)
448
449 #define VALID_BOOLEAN(s) ((unsigned char)(s) <= 1) /* reject "-1" */
450 #define VALID_NUMERIC(s) ((s) >= 0)
451 #define VALID_STRING(s)  ((s) != CANCELLED_STRING && (s) != ABSENT_STRING)
452
453 #define VT_ACSC "``aaffggiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz{{||}}~~"
454
455 #define CATCHALL(handler) { \
456                 int nsig; \
457                 for (nsig = SIGHUP; nsig < SIGTERM; ++nsig) \
458                     if (nsig != SIGKILL) \
459                         signal(nsig, handler); \
460             }
461
462 /*
463  * Simplify setting up demo of threading with these macros.
464  */
465 #if !defined(NCURSES_VERSION_PATCH) || (NCURSES_VERSION_PATCH < 20070915) || !NCURSES_EXT_FUNCS
466 #define WANT_USE_WINDOW() \
467 static int \
468 use_window(WINDOW *win, int (*func) (WINDOW *, void *), void *data) \
469 { \
470     return func(win, data); \
471 }
472 #define USING_WINDOW(w,func) use_window(w, (NCURSES_CALLBACK) func, w)
473 #else
474 #define WANT_USE_WINDOW() /* nothing */
475 #define USING_WINDOW(w,func) func(w)
476 #endif
477
478
479 #endif /* __TEST_PRIV_H */