ncurses 5.7 - patch 20100116
[ncurses.git] / test / test.priv.h
1 /****************************************************************************
2  * Copyright (c) 1998-2008,2009 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.93 2009/10/24 21:30:13 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 #define HAVE_LIBFORM 1
46 #endif
47
48 #ifdef  HAVE_LIBMENUW
49 #define HAVE_LIBMENUW 1
50 #define HAVE_LIBMENU 1
51 #endif
52
53 #ifdef  HAVE_LIBPANELW
54 #define HAVE_LIBPANELW 1
55 #define HAVE_LIBPANEL 1
56 #endif
57
58 /*
59  * Fallback definitions to accommodate broken compilers.
60  */
61 #ifndef HAVE_CURSES_VERSION
62 #define HAVE_CURSES_VERSION 0
63 #endif
64
65 #ifndef HAVE_CHGAT
66 #define HAVE_CHGAT 0
67 #endif
68
69 #ifndef HAVE_COLOR_SET
70 #define HAVE_COLOR_SET 0
71 #endif
72
73 #ifndef HAVE_FILTER
74 #define HAVE_FILTER 0
75 #endif
76
77 #ifndef HAVE_FORM_H
78 #define HAVE_FORM_H 0
79 #endif
80
81 #ifndef HAVE_GETBEGX
82 #define HAVE_GETBEGX 0
83 #endif
84
85 #ifndef HAVE_GETCURX
86 #define HAVE_GETCURX 0
87 #endif
88
89 #ifndef HAVE_GETMAXX
90 #define HAVE_GETMAXX 0
91 #endif
92
93 #ifndef HAVE_GETOPT_H
94 #define HAVE_GETOPT_H 0
95 #endif
96
97 #ifndef HAVE_GETPARX
98 #define HAVE_GETPARX 0
99 #endif
100
101 #ifndef HAVE_GETWIN
102 #define HAVE_GETWIN 0
103 #endif
104
105 #ifndef HAVE_LIBFORM
106 #define HAVE_LIBFORM 0
107 #endif
108
109 #ifndef HAVE_LIBMENU
110 #define HAVE_LIBMENU 0
111 #endif
112
113 #ifndef HAVE_LIBPANEL
114 #define HAVE_LIBPANEL 0
115 #endif
116
117 #ifndef HAVE_LOCALE_H
118 #define HAVE_LOCALE_H 0
119 #endif
120
121 #ifndef HAVE_MENU_H
122 #define HAVE_MENU_H 0
123 #endif
124
125 #ifndef HAVE_MVVLINE
126 #define HAVE_MVVLINE 0
127 #endif
128
129 #ifndef HAVE_MVWVLINE
130 #define HAVE_MVWVLINE 0
131 #endif
132
133 #ifndef HAVE_NAPMS
134 #define HAVE_NAPMS 1
135 #endif
136
137 #ifndef HAVE_NC_ALLOC_H
138 #define HAVE_NC_ALLOC_H 0
139 #endif
140
141 #ifndef HAVE_PANEL_H
142 #define HAVE_PANEL_H 0
143 #endif
144
145 #ifndef HAVE_PUTWIN
146 #define HAVE_PUTWIN 0
147 #endif
148
149 #ifndef HAVE_RESIZE_TERM
150 #define HAVE_RESIZE_TERM 0
151 #endif
152
153 #ifndef HAVE_RIPOFFLINE
154 #define HAVE_RIPOFFLINE 0
155 #endif
156
157 #ifndef HAVE_SETUPTERM
158 #define HAVE_SETUPTERM 0
159 #endif
160
161 #ifndef HAVE_SLK_COLOR
162 #define HAVE_SLK_COLOR 0
163 #endif
164
165 #ifndef HAVE_SLK_INIT
166 #define HAVE_SLK_INIT 0
167 #endif
168
169 #ifndef HAVE_TERMATTRS
170 #define HAVE_TERMATTRS 0
171 #endif
172
173 #ifndef HAVE_TERMNAME
174 #define HAVE_TERMNAME 0
175 #endif
176
177 #ifndef HAVE_TGETENT
178 #define HAVE_TGETENT 0
179 #endif
180
181 #ifndef HAVE_TIGETNUM
182 #define HAVE_TIGETNUM 0
183 #endif
184
185 #ifndef HAVE_TYPEAHEAD
186 #define HAVE_TYPEAHEAD 0
187 #endif
188
189 #ifndef HAVE_TIGETSTR
190 #define HAVE_TIGETSTR 0
191 #endif
192
193 #ifndef HAVE_WINSSTR
194 #define HAVE_WINSSTR 0
195 #endif
196
197 #ifndef HAVE_USE_DEFAULT_COLORS
198 #define HAVE_USE_DEFAULT_COLORS 0
199 #endif
200
201 #ifndef HAVE_WRESIZE
202 #define HAVE_WRESIZE 0
203 #endif
204
205 #ifndef NCURSES_EXT_FUNCS
206 #define NCURSES_EXT_FUNCS 0
207 #endif
208
209 #ifndef NEED_PTEM_H
210 #define NEED_PTEM_H 0
211 #endif
212
213 #ifndef NEED_WCHAR_H
214 #define NEED_WCHAR_H 0
215 #endif
216
217 #ifndef NO_LEAKS
218 #define NO_LEAKS 0
219 #endif
220
221 #include <stdlib.h>
222 #include <stdarg.h>
223 #include <string.h>
224 #include <sys/types.h>
225 #include <errno.h>
226
227 #if HAVE_UNISTD_H
228 #include <unistd.h>
229 #endif
230
231 #include <signal.h>     /* include before curses.h to work around glibc bug */
232
233 #if NEED_WCHAR_H
234 #include <wchar.h>
235 #ifdef HAVE_LIBUTF8_H
236 #include <libutf8.h>
237 #endif
238 #endif
239
240 #if defined(HAVE_XCURSES)
241 #include <xcurses.h>
242 #elif defined(HAVE_NCURSESW_NCURSES_H)
243 #include <ncursesw/curses.h>
244 #elif defined(HAVE_NCURSES_NCURSES_H)
245 #include <ncurses/curses.h>
246 #else
247 #include <curses.h>
248 #endif
249
250 #if defined(HAVE_XCURSES)
251 /* no other headers */
252 #undef  HAVE_SETUPTERM          /* nonfunctional */
253 #define HAVE_SETUPTERM 0
254 #undef  HAVE_TGETENT            /* nonfunctional */
255 #define HAVE_TGETENT 0
256 #undef  HAVE_TIGETSTR           /* nonfunctional */
257 #define HAVE_TIGETSTR 0
258 #elif defined(HAVE_NCURSESW_TERM_H)
259 #include <ncursesw/term.h>
260 #elif defined(HAVE_NCURSES_TERM_H)
261 #include <ncurses/term.h>
262 #elif defined(HAVE_TERM_H)
263 #include <term.h>
264 #endif
265
266 /*
267  * Not all curses.h implementations include unctrl.h,
268  * Solaris 10 xpg4 for example.
269  */
270 #if defined(NCURSES_VERSION) || defined(_XOPEN_CURSES)
271 #if defined(HAVE_NCURSESW_NCURSES_H)
272 #include <ncursesw/unctrl.h>
273 #elif defined(HAVE_NCURSES_NCURSES_H)
274 #include <ncurses/unctrl.h>
275 #else
276 #include <unctrl.h>
277 #endif
278 #endif
279
280 #if HAVE_GETOPT_H
281 #include <getopt.h>
282 #else
283 /* 'getopt()' may be prototyped in <stdlib.h>, but declaring its variables
284  * doesn't hurt.
285  */
286 extern char *optarg;
287 extern int optind;
288 #endif /* HAVE_GETOPT_H */
289
290 #if HAVE_LOCALE_H
291 #include <locale.h>
292 #else
293 #define setlocale(name,string) /* nothing */
294 #endif
295
296 #include <assert.h>
297 #include <ctype.h>
298
299 #ifndef GCC_NORETURN
300 #define GCC_NORETURN /* nothing */
301 #endif
302 #ifndef GCC_PRINTFLIKE
303 #define GCC_PRINTFLIKE(a,b) /* nothing */
304 #endif
305 #ifndef GCC_UNUSED
306 #define GCC_UNUSED /* nothing */
307 #endif
308
309 #ifndef HAVE_GETNSTR
310 #define getnstr(s,n) getstr(s)
311 #endif
312
313 #ifndef USE_SOFTKEYS
314 #if HAVE_SLK_INIT
315 #define USE_SOFTKEYS 1
316 #else
317 #define USE_SOFTKEYS 0
318 #endif
319 #endif
320
321 #ifndef USE_WIDEC_SUPPORT
322 #if defined(_XOPEN_SOURCE_EXTENDED) && defined(WACS_ULCORNER)
323 #define USE_WIDEC_SUPPORT 1
324 #else
325 #define USE_WIDEC_SUPPORT 0
326 #endif
327 #endif
328
329 #if HAVE_PANEL_H && HAVE_LIBPANEL
330 #define USE_LIBPANEL 1
331 #else
332 #define USE_LIBPANEL 0
333 #endif
334
335 #if HAVE_MENU_H && HAVE_LIBMENU
336 #define USE_LIBMENU 1
337 #else
338 #define USE_LIBMENU 0
339 #endif
340
341 #if HAVE_FORM_H && HAVE_LIBFORM
342 #define USE_LIBFORM 1
343 #else
344 #define USE_LIBFORM 0
345 #endif
346
347 #ifndef HAVE_TYPE_ATTR_T
348 #if !USE_WIDEC_SUPPORT && !defined(attr_t)
349 #define attr_t chtype
350 #endif
351 #endif
352
353 #undef NCURSES_CH_T
354 #if !USE_WIDEC_SUPPORT
355 #define NCURSES_CH_T chtype
356 #else
357 #define NCURSES_CH_T cchar_t
358 #endif
359
360 #ifndef NCURSES_OPAQUE
361 #define NCURSES_OPAQUE 0
362 #endif
363
364 #ifndef CCHARW_MAX
365 #define CCHARW_MAX 5
366 #endif
367
368 #undef CTRL
369 #define CTRL(x) ((x) & 0x1f)
370
371 #define QUIT            CTRL('Q')
372 #define ESCAPE          CTRL('[')
373
374 #ifndef KEY_MIN
375 #define KEY_MIN 256     /* not defined in Solaris 8 */
376 #endif
377
378 #ifdef DECL_CURSES_DATA_BOOLNAMES
379 extern char     *boolnames[], *boolcodes[], *boolfnames[],
380                 *numnames[], *numcodes[], *numfnames[],
381                 *strnames[], *strcodes[], *strfnames[];
382 #endif
383
384 #define colored_chtype(ch, attr, pair) \
385         ((ch) | (attr) | COLOR_PAIR(pair))
386
387 /*
388  * Workaround for HPUX
389  */
390 #if defined(__hpux) && !defined(NCURSES_VERSION)
391 #define getbegx(w) __getbegx(w)
392 #define getbegy(w) __getbegy(w)
393 #define getcurx(w) __getcurx(w)
394 #define getcury(w) __getcury(w)
395 #define getmaxx(w) __getmaxx(w)
396 #define getmaxy(w) __getmaxy(w)
397 #define getparx(w) __getparx(w)
398 #define getpary(w) __getpary(w)
399 #endif
400
401 /*
402  * Workaround in case getcchar() returns a positive value when the source
403  * string produces only a L'\0'.
404  */
405 #define TEST_CCHAR(s, count, then_stmt, else_stmt) \
406         if ((count = getcchar(s, NULL, NULL, NULL, NULL)) > 0) { \
407             wchar_t test_wch[CCHARW_MAX + 2]; \
408             attr_t test_attrs; \
409             short test_pair; \
410             \
411             if (getcchar( s, test_wch, &test_attrs, &test_pair, NULL) == OK \
412                 && test_wch[0] != L'\0') { \
413                 then_stmt \
414             } else { \
415                 else_stmt \
416             } \
417         } else { \
418             else_stmt \
419         }
420 /*
421  * These usually are implemented as macros, but may be functions.
422  */
423 #if !defined(getcurx) && !HAVE_GETCURX
424 #define getcurx(win)            ((win)?(win)->_curx:ERR)
425 #define getcury(win)            ((win)?(win)->_cury:ERR)
426 #endif
427
428 #if !defined(getbegx) && !HAVE_GETBEGX
429 #define getbegx(win)            ((win)?(win)->_begx:ERR)
430 #define getbegy(win)            ((win)?(win)->_begy:ERR)
431 #endif
432
433 #if !defined(getmaxx) && !HAVE_GETMAXX
434 #define getmaxx(win)            ((win)?((win)->_maxx + 1):ERR)
435 #define getmaxy(win)            ((win)?((win)->_maxy + 1):ERR)
436 #endif
437
438 /*
439  * Solaris 10 xpg4:
440 #define __m_getparx(w)          ((w)->_parent == (WINDOW *) 0 ? -1 \
441                                 : (w)->_begx - (w)->_parent->_begx)
442  */
443 #if !defined(getparx) && !HAVE_GETPARX
444 #ifdef __m_getparx
445 #define getparx(win)            __m_getparx(win)
446 #define getpary(win)            __m_getpary(win)
447 #else
448 #define getparx(win)            ((win)?((win)->_parx + 1):ERR)
449 #define getpary(win)            ((win)?((win)->_pary + 1):ERR)
450 #endif
451 #endif
452
453 #if !defined(mvwvline) && !HAVE_MVWVLINE
454 #define mvwvline(w,y,x,ch,n)    (move(y,x) == ERR ? ERR : wvline(w,ch,n))
455 #define mvwhline(w,y,x,ch,n)    (move(y,x) == ERR ? ERR : whline(w,ch,n))
456 #endif
457
458 #if !defined(mvvline) && !HAVE_MVVLINE
459 #define mvvline(y,x,ch,n)       (move(y,x) == ERR ? ERR : vline(ch,n))
460 #define mvhline(y,x,ch,n)       (move(y,x) == ERR ? ERR : hline(ch,n))
461 #endif
462
463 /*
464  * Try to accommodate curses implementations that have no terminfo support.
465  */
466 #if HAVE_TIGETNUM
467 #define TIGETNUM(ti,tc) tigetnum(ti)
468 #else
469 #define TIGETNUM(ti,tc) tgetnum(tc)
470 #endif
471
472 #if HAVE_TIGETSTR
473 #define TIGETSTR(ti,tc) tigetstr(ti)
474 #else
475 #define TIGETSTR(ti,tc) tgetstr(tc,&area_pointer)
476 #endif
477
478 /* ncurses implements tparm() with varargs, X/Open with a fixed-parameter list
479  * (which is incompatible with legacy usage, doesn't solve any problems).
480  */
481 #define tparm3(a,b,c) tparm(a,b,c,0,0,0,0,0,0,0)
482 #define tparm2(a,b)   tparm(a,b,0,0,0,0,0,0,0,0)
483
484 #define UChar(c)    ((unsigned char)(c))
485
486 #define SIZEOF(table)   (sizeof(table)/sizeof(table[0]))
487
488 #if defined(NCURSES_VERSION) && HAVE_NC_ALLOC_H
489 #include <nc_alloc.h>
490 #if HAVE_NC_FREEALL && defined(USE_TINFO)
491 #undef ExitProgram
492 #define ExitProgram(code) _nc_free_tinfo(code)
493 #endif
494 #else
495 #define typeMalloc(type,n) (type *) malloc((n) * sizeof(type))
496 #define typeCalloc(type,elts) (type *) calloc((elts), sizeof(type))
497 #define typeRealloc(type,n,p) (type *) realloc(p, (n) * sizeof(type))
498 #endif
499
500 #ifndef ExitProgram
501 #define ExitProgram(code) exit(code)
502 #endif
503
504 #ifndef EXIT_SUCCESS
505 #define EXIT_SUCCESS 0
506 #endif
507 #ifndef EXIT_FAILURE
508 #define EXIT_FAILURE 1
509 #endif
510
511 #ifdef __MINGW32__
512 #include <nc_mingw.h>
513 /* conflicts in test/firstlast.c */
514 #undef large
515 #undef small
516
517 #endif
518
519 /* Use this to quiet gcc's -Wwrite-strings warnings, but accommodate SVr4
520  * curses which doesn't have const parameters declared (so far) in the places
521  * that XSI shows.
522  */
523 #ifndef NCURSES_CONST
524 #define NCURSES_CONST /* nothing */
525 #endif
526
527 /* out-of-band values for representing absent capabilities */
528 #define ABSENT_BOOLEAN          ((signed char)-1)       /* 255 */
529 #define ABSENT_NUMERIC          (-1)
530 #define ABSENT_STRING           (char *)0
531
532 /* out-of-band values for representing cancels */
533 #define CANCELLED_BOOLEAN       ((signed char)-2)       /* 254 */
534 #define CANCELLED_NUMERIC       (-2)
535 #define CANCELLED_STRING        (char *)(-1)
536
537 #define VALID_BOOLEAN(s) ((unsigned char)(s) <= 1) /* reject "-1" */
538 #define VALID_NUMERIC(s) ((s) >= 0)
539 #define VALID_STRING(s)  ((s) != CANCELLED_STRING && (s) != ABSENT_STRING)
540
541 #define VT_ACSC "``aaffggiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz{{||}}~~"
542
543 #define CATCHALL(handler) { \
544                 int nsig; \
545                 for (nsig = SIGHUP; nsig < SIGTERM; ++nsig) \
546                     if (nsig != SIGKILL) \
547                         signal(nsig, handler); \
548             }
549
550 /*
551  * Workaround for clean(er) compile with Solaris's legacy curses.
552  * The same would be needed for HPUX 10.20
553  */
554 #ifndef TPUTS_ARG
555 #if defined(sun) && !defined(_XOPEN_CURSES) && !defined(NCURSES_VERSION_PATCH)
556 #define TPUTS_ARG char
557 extern char *tgoto(char *, int, int);   /* available, but not prototyped */
558 #else
559 #define TPUTS_ARG int
560 #endif
561 #endif
562
563 /*
564  * Workarounds for Solaris's X/Open curses
565  */
566 #if defined(sun) && defined(_XOPEN_CURSES) && !defined(NCURSES_VERSION_PATCH)
567 #if !defined(KEY_MIN) && defined(__KEY_MIN)
568 #define KEY_MIN __KEY_MIN
569 #endif
570 #if !defined(KEY_MAX) && defined(__KEY_MIN)
571 #define KEY_MAX __KEY_MAX
572 #endif
573 #endif
574
575 /*
576  * Workaround to build with Sun's default SVr4 curses.
577  */
578 #ifdef NCURSES_VERSION
579 #ifndef HAVE_VW_PRINTW
580 #define HAVE_VW_PRINTW 1
581 #endif
582 #endif
583
584 /*
585  * ncurses provides arrays of capability names; X/Open discarded these SVr4
586  * features.  Some implementations continue to provide them (see the test
587  * configure script).
588  */
589 #ifdef NCURSES_VERSION
590 #ifndef HAVE_CURSES_DATA_BOOLNAMES
591 #define HAVE_CURSES_DATA_BOOLNAMES 1
592 #endif
593 #endif
594
595 /*
596  * ncurses uses const in some places where X/Open does (or did) not allow.
597  */
598 #ifdef NCURSES_VERSION
599 #define CONST_MENUS const
600 #else
601 #define CONST_MENUS /* nothing */
602 #endif
603
604 #ifndef HAVE_USE_WINDOW
605 #if !defined(NCURSES_VERSION_PATCH) || (NCURSES_VERSION_PATCH < 20070915) || !NCURSES_EXT_FUNCS
606 #define HAVE_USE_WINDOW 0
607 #else
608 #define HAVE_USE_WINDOW 1
609 #endif
610 #endif
611
612 /*
613  * Simplify setting up demo of threading with these macros.
614  */
615
616 #if !HAVE_USE_WINDOW
617 typedef int (*NCURSES_WINDOW_CB)(WINDOW *, void *);
618 typedef int (*NCURSES_SCREEN_CB)(SCREEN *, void *);
619 #endif
620
621 #if HAVE_USE_WINDOW
622 #define USING_WINDOW(w,func) use_window(w, (NCURSES_WINDOW_CB) func, w)
623 #define USING_WINDOW2(w,func,data) use_window(w, (NCURSES_WINDOW_CB) func, data)
624 #define WANT_USE_WINDOW() extern void _nc_want_use_window(void)
625 #else
626 #define USING_WINDOW(w,func) func(w)
627 #define USING_WINDOW2(w,func,data) func(w,data)
628 #define WANT_USE_WINDOW() extern void _nc_want_use_window(void)
629 #endif
630
631 #if HAVE_USE_WINDOW
632 #define USING_SCREEN(s,func,data) use_screen(s, (NCURSES_SCREEN_CB) func, data)
633 #define WANT_USE_SCREEN() extern void _nc_want_use_screen(void)
634 #else
635 #define USING_SCREEN(s,func,data) func(data)
636 #define WANT_USE_SCREEN() extern void _nc_want_use_screen(void)
637 #endif
638
639 #ifdef TRACE
640 #define Trace(p) _tracef p
641 #define USE_TRACE 1
642 #else
643 #define Trace(p)                /* nothing */
644 #define USE_TRACE 0
645 #endif
646
647 /*
648  * Workaround for defective implementation of gcc attribute warn_unused_result
649  */
650 #if defined(__GNUC__) && defined(_FORTIFY_SOURCE)
651 #define IGNORE_RC(func) errno = func
652 #else
653 #define IGNORE_RC(func) (void) func
654 #endif /* gcc workarounds */
655
656 #define init_mb(state)  memset(&state, 0, sizeof(state))
657
658 #endif /* __TEST_PRIV_H */