1 /****************************************************************************
2 * Copyright (c) 1998-2012,2013 Free Software Foundation, Inc. *
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: *
12 * The above copyright notice and this permission notice shall be included *
13 * in all copies or substantial portions of the Software. *
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. *
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 *
27 ****************************************************************************/
29 /****************************************************************************
30 * Author: Thomas E. Dickey 1996-on *
31 ****************************************************************************/
32 /* $Id: test.priv.h,v 1.121 2013/09/28 22:43:22 tom Exp $ */
35 #define __TEST_PRIV_H 1
37 #include <ncurses_cfg.h>
40 * Fix ifdef's that look for the form/menu/panel libraries, if we are building
41 * with wide-character ncurses.
44 #define HAVE_LIBFORMW 1
45 #define HAVE_LIBFORM 1
49 #define HAVE_LIBMENUW 1
50 #define HAVE_LIBMENU 1
54 #define HAVE_LIBPANELW 1
55 #define HAVE_LIBPANEL 1
59 * Fallback definitions to accommodate broken compilers.
61 #ifndef HAVE_ASSUME_DEFAULT_COLORS
62 #define HAVE_ASSUME_DEFAULT_COLORS 0
65 #ifndef HAVE_CURSES_VERSION
66 #define HAVE_CURSES_VERSION 0
73 #ifndef HAVE_COLOR_SET
74 #define HAVE_COLOR_SET 0
86 #define HAVE_GETBEGX 0
90 #define HAVE_GETCURX 0
94 #define HAVE_GETMAXX 0
98 #define HAVE_GETOPT_H 0
102 #define HAVE_GETPARX 0
106 #define HAVE_GETWIN 0
110 #define HAVE_LIBFORM 0
114 #define HAVE_LIBMENU 0
117 #ifndef HAVE_LIBPANEL
118 #define HAVE_LIBPANEL 0
121 #ifndef HAVE_LOCALE_H
122 #define HAVE_LOCALE_H 0
126 #define HAVE_MATH_H 0
130 #define HAVE_MENU_H 0
134 #define HAVE_MVVLINE 0
137 #ifndef HAVE_MVWVLINE
138 #define HAVE_MVWVLINE 0
145 #ifndef HAVE_NC_ALLOC_H
146 #define HAVE_NC_ALLOC_H 0
150 #define HAVE_PANEL_H 0
154 #define HAVE_PUTWIN 0
157 #ifndef HAVE_RESIZE_TERM
158 #define HAVE_RESIZE_TERM 0
161 #ifndef HAVE_RIPOFFLINE
162 #define HAVE_RIPOFFLINE 0
165 #ifndef HAVE_SCR_DUMP
166 #define HAVE_SCR_DUMP 0
169 #ifndef HAVE_SETUPTERM
170 #define HAVE_SETUPTERM 0
173 #ifndef HAVE_SLK_COLOR
174 #define HAVE_SLK_COLOR 0
177 #ifndef HAVE_SLK_INIT
178 #define HAVE_SLK_INIT 0
181 #ifndef HAVE_SYS_IOCTL_H
182 #define HAVE_SYS_IOCTL_H 0
185 #ifndef HAVE_SYS_SELECT_H
186 #define HAVE_SYS_SELECT_H 0
189 #ifndef HAVE_TERMATTRS
190 #define HAVE_TERMATTRS 0
193 #ifndef HAVE_TERMIOS_H
194 #define HAVE_TERMIOS_H 0
197 #ifndef HAVE_TERMNAME
198 #define HAVE_TERMNAME 0
201 #ifndef HAVE_TERM_ENTRY_H
202 #define HAVE_TERM_ENTRY_H 0
206 #define HAVE_TGETENT 0
209 #ifndef HAVE_TIGETNUM
210 #define HAVE_TIGETNUM 0
213 #ifndef HAVE_TIGETSTR
214 #define HAVE_TIGETSTR 0
217 #ifndef HAVE_TYPEAHEAD
218 #define HAVE_TYPEAHEAD 0
222 #define HAVE_WINSSTR 0
225 #ifndef HAVE_USE_DEFAULT_COLORS
226 #define HAVE_USE_DEFAULT_COLORS 0
229 #ifndef HAVE_USE_SCREEN
230 #define HAVE_USE_SCREEN 0
233 #ifndef HAVE_USE_WINDOW
234 #define HAVE_USE_WINDOW 0
238 #define HAVE_WRESIZE 0
241 #ifndef NCURSES_EXT_FUNCS
242 #define NCURSES_EXT_FUNCS 0
246 #define NEED_PTEM_H 0
250 #define NEED_WCHAR_H 0
258 * Workaround for HPUX
260 #if defined(__hpux) && !defined(NCURSES_VERSION)
261 #define _ACS_COMPAT_CODE /* needed for acs_map vs __acs_map */
267 #include <sys/types.h>
274 #include <signal.h> /* include before curses.h to work around glibc bug */
278 #ifdef HAVE_LIBUTF8_H
283 #if defined(HAVE_XCURSES)
285 #elif defined(HAVE_NCURSESW_NCURSES_H)
286 #include <ncursesw/curses.h>
287 #elif defined(HAVE_NCURSES_NCURSES_H)
288 #include <ncurses/curses.h>
293 #if defined(HAVE_XCURSES) || defined(PDCURSES)
294 /* no other headers */
295 #undef HAVE_SETUPTERM /* nonfunctional */
296 #define HAVE_SETUPTERM 0
297 #undef HAVE_TGETENT /* nonfunctional */
298 #define HAVE_TGETENT 0
299 #undef HAVE_TIGETSTR /* nonfunctional */
300 #define HAVE_TIGETSTR 0
301 #elif defined(HAVE_NCURSESW_TERM_H)
302 #include <ncursesw/term.h>
303 #elif defined(HAVE_NCURSES_TERM_H)
304 #include <ncurses/term.h>
305 #elif defined(HAVE_TERM_H)
310 * Not all curses.h implementations include unctrl.h,
312 #if defined(HAVE_NCURSESW_UNCTRL_H)
313 #include <ncursesw/unctrl.h>
314 #elif defined(HAVE_NCURSES_UNCTRL_H)
315 #include <ncurses/unctrl.h>
316 #elif defined(HAVE_UNCTRL_H)
322 #elif !defined(HAVE_GETOPT_HEADER)
323 /* 'getopt()' may be prototyped in <stdlib.h>, but declaring its variables
328 #endif /* HAVE_GETOPT_H */
333 #define setlocale(name,string) /* nothing */
340 #define GCC_NORETURN /* nothing */
342 #ifndef GCC_PRINTFLIKE
343 #define GCC_PRINTFLIKE(a,b) /* nothing */
346 #define GCC_UNUSED /* nothing */
350 #define getnstr(s,n) getstr(s)
355 #define USE_SOFTKEYS 1
357 #define USE_SOFTKEYS 0
362 #define slk_init() /* nothing */
363 #define slk_restore() /* nothing */
364 #define slk_clear() /* nothing */
367 #ifndef HAVE_WSYNCDOWN
368 #define wsyncdown(win) /* nothing */
371 #ifndef USE_WIDEC_SUPPORT
372 #if (defined(_XOPEN_SOURCE_EXTENDED) \
373 || (defined(_XOPEN_SOURCE) && (_XOPEN_SOURCE - 0 >= 500)) \
374 || (defined(NCURSES_WIDECHAR) && (NCURSES_WIDECHAR - 0 < 1))) \
375 && defined(WACS_ULCORNER)
376 #define USE_WIDEC_SUPPORT 1
378 #define USE_WIDEC_SUPPORT 0
382 #if HAVE_PANEL_H && HAVE_LIBPANEL
383 #define USE_LIBPANEL 1
385 #define USE_LIBPANEL 0
388 #if HAVE_MENU_H && HAVE_LIBMENU
389 #define USE_LIBMENU 1
391 #define USE_LIBMENU 0
394 #if HAVE_FORM_H && HAVE_LIBFORM
395 #define USE_LIBFORM 1
397 #define USE_LIBFORM 0
400 /* workaround, to build against NetBSD's variant of the form library */
401 #ifdef HAVE_NETBSD_FORM_H
402 #define form_getyx(form, y, x) y = current_field(form)->cursor_ypos, x = current_field(form)->cursor_xpos
404 #define form_getyx(form, y, x) y = (form)->currow, x = (form)->curcol
407 /* workaround, to build against NetBSD's variant of the form library */
408 #ifdef HAVE_NETBSD_MENU_H
409 #define menu_itemwidth(menu) (menu)->max_item_width
411 #define menu_itemwidth(menu) (menu)->itemlen
414 #ifndef HAVE_TYPE_ATTR_T
415 #if !USE_WIDEC_SUPPORT && !defined(attr_t)
416 #define attr_t chtype
421 #if !USE_WIDEC_SUPPORT
422 #define NCURSES_CH_T chtype
424 #define NCURSES_CH_T cchar_t
427 #ifndef NCURSES_OPAQUE
428 #define NCURSES_OPAQUE 0
435 #if defined(NCURSES_VERSION) && defined(CURSES_WACS_ARRAY) && !defined(CURSES_WACS_SYMBOLS)
436 #define CURSES_WACS_SYMBOLS
439 #if defined(CURSES_WACS_ARRAY) && !defined(CURSES_WACS_SYMBOLS)
440 /* NetBSD 5.1 defines these incorrectly */
474 #define WACS_RARROW &(CURSES_WACS_ARRAY['+'])
475 #define WACS_LARROW &(CURSES_WACS_ARRAY[','])
476 #define WACS_UARROW &(CURSES_WACS_ARRAY['-'])
477 #define WACS_DARROW &(CURSES_WACS_ARRAY['.'])
478 #define WACS_BLOCK &(CURSES_WACS_ARRAY['0'])
479 #define WACS_DIAMOND &(CURSES_WACS_ARRAY['`'])
480 #define WACS_CKBOARD &(CURSES_WACS_ARRAY['a'])
481 #define WACS_DEGREE &(CURSES_WACS_ARRAY['f'])
482 #define WACS_PLMINUS &(CURSES_WACS_ARRAY['g'])
483 #define WACS_BOARD &(CURSES_WACS_ARRAY['h'])
484 #define WACS_LANTERN &(CURSES_WACS_ARRAY['i'])
485 #define WACS_LRCORNER &(CURSES_WACS_ARRAY['j'])
486 #define WACS_URCORNER &(CURSES_WACS_ARRAY['k'])
487 #define WACS_ULCORNER &(CURSES_WACS_ARRAY['l'])
488 #define WACS_LLCORNER &(CURSES_WACS_ARRAY['m'])
489 #define WACS_PLUS &(CURSES_WACS_ARRAY['n'])
490 #define WACS_HLINE &(CURSES_WACS_ARRAY['q'])
491 #define WACS_S1 &(CURSES_WACS_ARRAY['o'])
492 #define WACS_S9 &(CURSES_WACS_ARRAY['s'])
493 #define WACS_LTEE &(CURSES_WACS_ARRAY['t'])
494 #define WACS_RTEE &(CURSES_WACS_ARRAY['u'])
495 #define WACS_BTEE &(CURSES_WACS_ARRAY['v'])
496 #define WACS_TTEE &(CURSES_WACS_ARRAY['w'])
497 #define WACS_VLINE &(CURSES_WACS_ARRAY['x'])
498 #define WACS_BULLET &(CURSES_WACS_ARRAY['~'])
499 #define WACS_S3 &(CURSES_WACS_ARRAY['p'])
500 #define WACS_S7 &(CURSES_WACS_ARRAY['r'])
501 #define WACS_LEQUAL &(CURSES_WACS_ARRAY['y'])
502 #define WACS_GEQUAL &(CURSES_WACS_ARRAY['z'])
503 #define WACS_PI &(CURSES_WACS_ARRAY['{'])
504 #define WACS_NEQUAL &(CURSES_WACS_ARRAY['|'])
505 #define WACS_STERLING &(CURSES_WACS_ARRAY['}'])
509 #define CTRL(x) ((x) & 0x1f)
511 #define QUIT CTRL('Q')
512 #define ESCAPE CTRL('[')
515 #define KEY_MIN 256 /* not defined in Solaris 8 */
518 #ifdef DECL_CURSES_DATA_BOOLNAMES
519 extern char *boolnames[], *boolcodes[], *boolfnames[];
520 extern char *numnames[], *numcodes[], *numfnames[];
521 extern char *strnames[], *strcodes[], *strfnames[];
524 #define colored_chtype(ch, attr, pair) \
525 ((chtype) (ch) | (chtype) (attr) | (chtype) COLOR_PAIR(pair))
528 * Workaround for HPUX
530 #if defined(__hpux) && !defined(NCURSES_VERSION)
531 #define getbegx(w) __getbegx(w)
532 #define getbegy(w) __getbegy(w)
533 #define getcurx(w) __getcurx(w)
534 #define getcury(w) __getcury(w)
535 #define getmaxx(w) __getmaxx(w)
536 #define getmaxy(w) __getmaxy(w)
537 #define getparx(w) __getparx(w)
538 #define getpary(w) __getpary(w)
542 * Workaround in case getcchar() returns a positive value when the source
543 * string produces only a L'\0'.
545 #define TEST_CCHAR(s, count, then_stmt, else_stmt) \
546 if ((count = getcchar(s, NULL, NULL, NULL, NULL)) > 0) { \
547 wchar_t test_wch[CCHARW_MAX + 2]; \
551 if (getcchar( s, test_wch, &test_attrs, &test_pair, NULL) == OK \
552 && test_wch[0] != L'\0') { \
561 * These usually are implemented as macros, but may be functions.
563 #if !defined(getcurx) && !HAVE_GETCURX
564 #define getcurx(win) ((win)?(win)->_curx:ERR)
565 #define getcury(win) ((win)?(win)->_cury:ERR)
568 #if !defined(getbegx) && !HAVE_GETBEGX
569 #define getbegx(win) ((win)?(win)->_begx:ERR)
570 #define getbegy(win) ((win)?(win)->_begy:ERR)
573 #if !defined(getmaxx) && !HAVE_GETMAXX
574 #define getmaxx(win) ((win)?((win)->_maxx + 1):ERR)
575 #define getmaxy(win) ((win)?((win)->_maxy + 1):ERR)
580 #define __m_getparx(w) ((w)->_parent == (WINDOW *) 0 ? -1 \
581 : (w)->_begx - (w)->_parent->_begx)
583 #if !defined(getparx) && !HAVE_GETPARX
585 #define getparx(win) __m_getparx(win)
586 #define getpary(win) __m_getpary(win)
588 #define getparx(win) ((win)?((win)->_parx + 1):ERR)
589 #define getpary(win) ((win)?((win)->_pary + 1):ERR)
593 #if !defined(mvwvline) && !HAVE_MVWVLINE
594 #define mvwvline(w,y,x,ch,n) (move(y,x) == ERR ? ERR : wvline(w,ch,n))
595 #define mvwhline(w,y,x,ch,n) (move(y,x) == ERR ? ERR : whline(w,ch,n))
598 #if !defined(mvvline) && !HAVE_MVVLINE
599 #define mvvline(y,x,ch,n) (move(y,x) == ERR ? ERR : vline(ch,n))
600 #define mvhline(y,x,ch,n) (move(y,x) == ERR ? ERR : hline(ch,n))
604 * Try to accommodate curses implementations that have no terminfo support.
607 #define TIGETNUM(ti,tc) tigetnum(ti)
609 #define TIGETNUM(ti,tc) tgetnum(tc)
613 #define TIGETSTR(ti,tc) tigetstr(ti)
615 #define TIGETSTR(ti,tc) tgetstr(tc,&area_pointer)
619 * So far (2013 - more than ten years), only ncurses implements
620 * use_extended_names().
622 #if defined(NCURSES_XNAMES)
623 #elif defined(NCURSES_VERSION) && defined(HAVE_TERM_ENTRY_H) && HAVE_TERM_ENTRY_H
624 #define NCURSES_XNAMES 1
626 #define NCURSES_XNAMES 0
629 /* ncurses implements tparm() with varargs, X/Open with a fixed-parameter list
630 * (which is incompatible with legacy usage, doesn't solve any problems).
632 #define tparm3(a,b,c) tparm(a,b,c,0,0,0,0,0,0,0)
633 #define tparm2(a,b) tparm(a,b,0,0,0,0,0,0,0,0)
635 #define UChar(c) ((unsigned char)(c))
637 #define SIZEOF(table) (sizeof(table)/sizeof(table[0]))
639 #if defined(NCURSES_VERSION) && HAVE_NC_ALLOC_H
640 #include <nc_alloc.h>
641 #if HAVE_NC_FREEALL && defined(USE_TINFO)
643 #define ExitProgram(code) _nc_free_tinfo(code)
646 #define typeMalloc(type,n) (type *) malloc((n) * sizeof(type))
647 #define typeCalloc(type,elts) (type *) calloc((elts), sizeof(type))
648 #define typeRealloc(type,n,p) (type *) realloc(p, (n) * sizeof(type))
652 #define ExitProgram(code) exit(code)
656 #define EXIT_SUCCESS 0
659 #define EXIT_FAILURE 1
662 #if defined(__MINGW32__)
664 #if defined(PDCURSES)
667 # error WINVER must at least be 0x0501
670 # define WINVER 0x0501
673 #include <sys/time.h> /* for struct timeval */
675 #define sleep(n) Sleep((n) * 1000)
678 #define getlogin() "username"
681 #include <nc_mingw.h>
684 /* conflicts in test/firstlast.c */
690 /* Use this to quiet gcc's -Wwrite-strings warnings, but accommodate SVr4
691 * curses which doesn't have const parameters declared (so far) in the places
694 #ifndef NCURSES_CONST
695 #define NCURSES_CONST /* nothing */
698 /* out-of-band values for representing absent capabilities */
699 #define ABSENT_BOOLEAN ((signed char)-1) /* 255 */
700 #define ABSENT_NUMERIC (-1)
701 #define ABSENT_STRING (char *)0
703 /* out-of-band values for representing cancels */
704 #define CANCELLED_BOOLEAN ((signed char)-2) /* 254 */
705 #define CANCELLED_NUMERIC (-2)
706 #define CANCELLED_STRING (char *)(-1)
708 #define VALID_BOOLEAN(s) ((unsigned char)(s) <= 1) /* reject "-1" */
709 #define VALID_NUMERIC(s) ((s) >= 0)
710 #define VALID_STRING(s) ((s) != CANCELLED_STRING && (s) != ABSENT_STRING)
712 #define VT_ACSC "``aaffggiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz{{||}}~~"
714 #define CATCHALL(handler) { \
716 for (nsig = SIGHUP; nsig < SIGTERM; ++nsig) \
717 if (nsig != SIGKILL) \
718 signal(nsig, handler); \
722 * Workaround for clean(er) compile with Solaris's legacy curses.
723 * The same would be needed for HPUX 10.20
726 #define TPUTS_ARG int
729 #if defined(sun) && !defined(_XOPEN_CURSES) && !defined(NCURSES_VERSION_PATCH)
731 #define TPUTS_ARG char
732 extern char *tgoto(char *, int, int); /* available, but not prototyped */
736 #define TPUTS_PROTO(func,value) int func(TPUTS_ARG value)
740 #define TPUTS_RETURN(value) return value
744 * Workarounds for Solaris's X/Open curses
746 #if !defined(KEY_MIN) && defined(__KEY_MIN)
747 #define KEY_MIN __KEY_MIN
749 #if !defined(KEY_MAX) && defined(__KEY_MIN)
750 #define KEY_MAX __KEY_MAX
754 * Workaround to build with Sun's default SVr4 curses.
756 #ifdef NCURSES_VERSION
757 #ifndef HAVE_VW_PRINTW
758 #define HAVE_VW_PRINTW 1
763 * ncurses provides arrays of capability names; X/Open discarded these SVr4
764 * features. Some implementations continue to provide them (see the test
767 #ifdef NCURSES_VERSION
768 #ifndef HAVE_CURSES_DATA_BOOLNAMES
769 #define HAVE_CURSES_DATA_BOOLNAMES 1
774 * ncurses uses const in some places where X/Open does (or did) not allow.
776 #ifdef NCURSES_VERSION
777 #define CONST_MENUS const
779 #define CONST_MENUS /* nothing */
783 * Simplify setting up demo of threading with these macros.
787 #define USING_WINDOW(w,func) use_window(w, (NCURSES_WINDOW_CB) func, w)
788 #define USING_WINDOW2(w,func,data) use_window(w, (NCURSES_WINDOW_CB) func, data)
789 #define WANT_USE_WINDOW() extern void _nc_want_use_window(void)
791 #define USING_WINDOW(w,func) func(w)
792 #define USING_WINDOW2(w,func,data) func(w,data)
793 #define WANT_USE_WINDOW() extern void _nc_want_use_window(void)
797 #define USING_SCREEN(s,func,data) use_screen(s, (NCURSES_SCREEN_CB) func, data)
798 #define WANT_USE_SCREEN() extern void _nc_want_use_screen(void)
800 #define USING_SCREEN(s,func,data) func(data)
801 #define WANT_USE_SCREEN() extern void _nc_want_use_screen(void)
805 #define Trace(p) _tracef p
808 #define Trace(p) /* nothing */
812 #define Trace2(p) /* nothing */
814 #define MvAddCh (void) mvaddch
815 #define MvWAddCh (void) mvwaddch
816 #define MvAddStr (void) mvaddstr
817 #define MvWAddStr (void) mvwaddstr
818 #define MvWAddChStr (void) mvwaddchstr
819 #define MvPrintw (void) mvprintw
820 #define MvWPrintw (void) mvwprintw
821 #define MvHLine (void) mvhline
822 #define MvWHLine (void) mvwhline
823 #define MvVLine (void) mvvline
824 #define MvWVLine (void) mvwvline
827 * Workaround for defective implementation of gcc attribute warn_unused_result
829 #if defined(__GNUC__) && defined(_FORTIFY_SOURCE)
830 #define IGNORE_RC(func) errno = func
832 #define IGNORE_RC(func) (void) func
833 #endif /* gcc workarounds */
835 #define init_mb(state) memset(&state, 0, sizeof(state))
837 #endif /* __TEST_PRIV_H */