1 /****************************************************************************
2 * Copyright 2018-2020,2021 Thomas E. Dickey *
3 * Copyright 1998-2016,2017 Free Software Foundation, Inc. *
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: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
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. *
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 *
28 ****************************************************************************/
30 /****************************************************************************
31 * Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 *
32 * and: Eric S. Raymond <esr@snark.thyrsus.com> *
33 * and: Thomas E. Dickey 1996-on *
34 ****************************************************************************/
36 /* $Id: curses.h.in,v 1.271 2021/03/20 16:25:43 tom Exp $ */
44 /* These are defined only in curses.h, and are used for conditional compiles */
45 #define NCURSES_VERSION_MAJOR @NCURSES_MAJOR@
46 #define NCURSES_VERSION_MINOR @NCURSES_MINOR@
47 #define NCURSES_VERSION_PATCH @NCURSES_PATCH@
49 /* This is defined in more than one ncurses header, for identification */
50 #undef NCURSES_VERSION
51 #define NCURSES_VERSION "@NCURSES_MAJOR@.@NCURSES_MINOR@"
54 * Identify the mouse encoding version.
56 #define NCURSES_MOUSE_VERSION @NCURSES_MOUSE_VERSION@
59 * Definitions to facilitate DLL's.
61 #include <ncurses_dll.h>
72 #if @HAVE_STDNORETURN_H@
73 #include <stdnoreturn.h>
75 #define GCC_NORETURN _Noreturn
80 * User-definable tweak to disable the include of <stdbool.h>.
82 #ifndef NCURSES_ENABLE_STDBOOL_H
83 #define NCURSES_ENABLE_STDBOOL_H @cf_cv_header_stdbool_h@
87 * NCURSES_ATTR_T is used to quiet compiler warnings when building ncurses
88 * configured using --disable-macros.
90 #ifndef NCURSES_ATTR_T
91 #define NCURSES_ATTR_T int
95 * Expands to 'const' if ncurses is configured using --enable-const. Note that
96 * doing so makes it incompatible with other implementations of X/Open Curses.
99 #define NCURSES_CONST @NCURSES_CONST@
101 #undef NCURSES_INLINE
102 #define NCURSES_INLINE @NCURSES_INLINE@
105 * The standard type used for color values, and for color-pairs. The latter
106 * allows the curses library to enumerate the combinations of foreground and
107 * background colors used by an application, and is normally the product of the
108 * total foreground and background colors.
110 * X/Open uses "short" for both of these types, ultimately because they are
111 * numbers from the SVr4 terminal database, which uses 16-bit signed values.
113 #undef NCURSES_COLOR_T
114 #define NCURSES_COLOR_T short
116 #undef NCURSES_PAIRS_T
117 #define NCURSES_PAIRS_T short
120 * Definitions used to make WINDOW and similar structs opaque.
122 #ifndef NCURSES_INTERNALS
123 #define NCURSES_OPAQUE @NCURSES_OPAQUE@
124 #define NCURSES_OPAQUE_FORM @NCURSES_OPAQUE_FORM@
125 #define NCURSES_OPAQUE_MENU @NCURSES_OPAQUE_MENU@
126 #define NCURSES_OPAQUE_PANEL @NCURSES_OPAQUE_PANEL@
130 * Definition used to optionally suppress wattr* macros to help with the
131 * transition from ncurses5 to ncurses6 by allowing the header files to
132 * be shared across development packages for ncursesw in both ABIs.
134 #ifndef NCURSES_WATTR_MACROS
135 #define NCURSES_WATTR_MACROS @NCURSES_WATTR_MACROS@
139 * The reentrant code relies on the opaque setting, but adds features.
141 #ifndef NCURSES_REENTRANT
142 #define NCURSES_REENTRANT @cf_cv_enable_reentrant@
146 * In certain environments, we must work around linker problems for data
148 #undef NCURSES_BROKEN_LINKER
150 #define NCURSES_BROKEN_LINKER 1
154 * Control whether bindings for interop support are added.
156 #undef NCURSES_INTEROP_FUNCS
157 #define NCURSES_INTEROP_FUNCS @NCURSES_INTEROP_FUNCS@
160 * The internal type used for window dimensions.
162 #undef NCURSES_SIZE_T
163 #define NCURSES_SIZE_T @NCURSES_SIZE_T@
166 * Control whether tparm() supports varargs or fixed-parameter list.
168 #undef NCURSES_TPARM_VARARGS
169 #define NCURSES_TPARM_VARARGS @NCURSES_TPARM_VARARGS@
172 * Control type used for tparm's arguments. While X/Open equates long and
173 * char* values, this is not always workable for 64-bit platforms.
175 #undef NCURSES_TPARM_ARG
176 #define NCURSES_TPARM_ARG @NCURSES_TPARM_ARG@
179 * Control whether ncurses uses wcwidth() for checking width of line-drawing
182 #undef NCURSES_WCWIDTH_GRAPHICS
183 #define NCURSES_WCWIDTH_GRAPHICS @NCURSES_WCWIDTH_GRAPHICS@
186 * NCURSES_CH_T is used in building the library, but not used otherwise in
187 * this header file, since that would make the normal/wide-character versions
188 * of the header incompatible.
191 #define NCURSES_CH_T @NCURSES_CH_T@
193 #if @cf_cv_enable_lp64@ && defined(_LP64)
194 typedef unsigned chtype;
195 typedef unsigned mmask_t;
197 typedef @cf_cv_typeof_chtype@ chtype;
198 typedef @cf_cv_typeof_mmask_t@ mmask_t;
202 * We need FILE, etc. Include this before checking any feature symbols.
207 * With XPG4, you must define _XOPEN_SOURCE_EXTENDED, it is redundant (or
208 * conflicting) when _XOPEN_SOURCE is 500 or greater. If NCURSES_WIDECHAR is
209 * not already defined, e.g., if the platform relies upon nonstandard feature
210 * test macros, define it at this point if the standard feature test macros
211 * indicate that it should be defined.
213 #ifndef NCURSES_WIDECHAR
214 #if defined(_XOPEN_SOURCE_EXTENDED) || (defined(_XOPEN_SOURCE) && (_XOPEN_SOURCE - 0 >= 500))
215 #define NCURSES_WIDECHAR 1
217 #define NCURSES_WIDECHAR 0
219 #endif /* NCURSES_WIDECHAR */
221 #include <stdarg.h> /* we need va_list */
223 #include <stddef.h> /* we want wchar_t */
226 /* X/Open and SVr4 specify that curses implements 'bool'. However, C++ may also
227 * implement it. If so, we must use the C++ compiler's type to avoid conflict
228 * with other interfaces.
230 * A further complication is that <stdbool.h> may declare 'bool' to be a
231 * different type, such as an enum which is not necessarily compatible with
232 * C++. If we have <stdbool.h>, make 'bool' a macro, so users may #undef it.
233 * Otherwise, let it remain a typedef to avoid conflicts with other #define's.
234 * In either case, make a typedef for NCURSES_BOOL which can be used if needed
235 * from either C or C++.
244 typedef @cf_cv_type_of_bool@ NCURSES_BOOL;
246 #if @USE_CXX_BOOL@ /* __cplusplus, etc. */
248 /* use the C++ compiler's bool type */
249 #define NCURSES_BOOL bool
251 #else /* c89, c99, etc. */
253 #if NCURSES_ENABLE_STDBOOL_H
255 /* use whatever the C compiler decides bool really is */
256 #define NCURSES_BOOL bool
258 /* there is no predefined bool - use our own */
260 #define bool NCURSES_BOOL
263 #endif /* !__cplusplus, etc. */
267 #define NCURSES_CAST(type,value) static_cast<type>(value)
269 #define NCURSES_CAST(type,value) (type)(value)
272 #define NCURSES_OK_ADDR(p) (0 != NCURSES_CAST(const void *, (p)))
275 * X/Open attributes. In the ncurses implementation, they are identical to the
278 #define WA_ATTRIBUTES A_ATTRIBUTES
279 #define WA_NORMAL A_NORMAL
280 #define WA_STANDOUT A_STANDOUT
281 #define WA_UNDERLINE A_UNDERLINE
282 #define WA_REVERSE A_REVERSE
283 #define WA_BLINK A_BLINK
285 #define WA_BOLD A_BOLD
286 #define WA_ALTCHARSET A_ALTCHARSET
287 #define WA_INVIS A_INVIS
288 #define WA_PROTECT A_PROTECT
289 #define WA_HORIZONTAL A_HORIZONTAL
290 #define WA_LEFT A_LEFT
292 #define WA_RIGHT A_RIGHT
294 #define WA_VERTICAL A_VERTICAL
296 #if @NCURSES_EXT_FUNCS@
297 #define WA_ITALIC A_ITALIC /* ncurses extension */
301 #define COLOR_BLACK 0
303 #define COLOR_GREEN 2
304 #define COLOR_YELLOW 3
306 #define COLOR_MAGENTA 5
308 #define COLOR_WHITE 7
312 #if @BROKEN_LINKER@ || NCURSES_REENTRANT
313 NCURSES_WRAPPED_VAR(chtype*, acs_map);
314 #define acs_map NCURSES_PUBLIC_VAR(acs_map())
316 extern NCURSES_EXPORT_VAR(chtype) acs_map[];
319 #define NCURSES_ACS(c) (acs_map[NCURSES_CAST(unsigned char,(c))])
321 /* VT100 symbols begin here */
322 #define ACS_ULCORNER NCURSES_ACS('l') /* upper left corner */
323 #define ACS_LLCORNER NCURSES_ACS('m') /* lower left corner */
324 #define ACS_URCORNER NCURSES_ACS('k') /* upper right corner */
325 #define ACS_LRCORNER NCURSES_ACS('j') /* lower right corner */
326 #define ACS_LTEE NCURSES_ACS('t') /* tee pointing right */
327 #define ACS_RTEE NCURSES_ACS('u') /* tee pointing left */
328 #define ACS_BTEE NCURSES_ACS('v') /* tee pointing up */
329 #define ACS_TTEE NCURSES_ACS('w') /* tee pointing down */
330 #define ACS_HLINE NCURSES_ACS('q') /* horizontal line */
331 #define ACS_VLINE NCURSES_ACS('x') /* vertical line */
332 #define ACS_PLUS NCURSES_ACS('n') /* large plus or crossover */
333 #define ACS_S1 NCURSES_ACS('o') /* scan line 1 */
334 #define ACS_S9 NCURSES_ACS('s') /* scan line 9 */
335 #define ACS_DIAMOND NCURSES_ACS('`') /* diamond */
336 #define ACS_CKBOARD NCURSES_ACS('a') /* checker board (stipple) */
337 #define ACS_DEGREE NCURSES_ACS('f') /* degree symbol */
338 #define ACS_PLMINUS NCURSES_ACS('g') /* plus/minus */
339 #define ACS_BULLET NCURSES_ACS('~') /* bullet */
340 /* Teletype 5410v1 symbols begin here */
341 #define ACS_LARROW NCURSES_ACS(',') /* arrow pointing left */
342 #define ACS_RARROW NCURSES_ACS('+') /* arrow pointing right */
343 #define ACS_DARROW NCURSES_ACS('.') /* arrow pointing down */
344 #define ACS_UARROW NCURSES_ACS('-') /* arrow pointing up */
345 #define ACS_BOARD NCURSES_ACS('h') /* board of squares */
346 #define ACS_LANTERN NCURSES_ACS('i') /* lantern symbol */
347 #define ACS_BLOCK NCURSES_ACS('0') /* solid square block */
349 * These aren't documented, but a lot of System Vs have them anyway
350 * (you can spot pprryyzz{{||}} in a lot of AT&T terminfo strings).
351 * The ACS_names may not match AT&T's, our source didn't know them.
353 #define ACS_S3 NCURSES_ACS('p') /* scan line 3 */
354 #define ACS_S7 NCURSES_ACS('r') /* scan line 7 */
355 #define ACS_LEQUAL NCURSES_ACS('y') /* less/equal */
356 #define ACS_GEQUAL NCURSES_ACS('z') /* greater/equal */
357 #define ACS_PI NCURSES_ACS('{') /* Pi */
358 #define ACS_NEQUAL NCURSES_ACS('|') /* not equal */
359 #define ACS_STERLING NCURSES_ACS('}') /* UK pound sign */
362 * Line drawing ACS names are of the form ACS_trbl, where t is the top, r
363 * is the right, b is the bottom, and l is the left. t, r, b, and l might
364 * be B (blank), S (single), D (double), or T (thick). The subset defined
365 * here only uses B and S.
367 #define ACS_BSSB ACS_ULCORNER
368 #define ACS_SSBB ACS_LLCORNER
369 #define ACS_BBSS ACS_URCORNER
370 #define ACS_SBBS ACS_LRCORNER
371 #define ACS_SBSS ACS_RTEE
372 #define ACS_SSSB ACS_LTEE
373 #define ACS_SSBS ACS_BTEE
374 #define ACS_BSSS ACS_TTEE
375 #define ACS_BSBS ACS_HLINE
376 #define ACS_SBSB ACS_VLINE
377 #define ACS_SSSS ACS_PLUS
385 /* values for the _flags member */
386 #define _SUBWIN 0x01 /* is this a sub-window? */
387 #define _ENDLINE 0x02 /* is the window flush right? */
388 #define _FULLWIN 0x04 /* is the window full-screen? */
389 #define _SCROLLWIN 0x08 /* bottom edge is at screen bottom? */
390 #define _ISPAD 0x10 /* is this window a pad? */
391 #define _HASMOVED 0x20 /* has cursor moved since last refresh? */
392 #define _WRAPPED 0x40 /* cursor was just wrappped */
395 * this value is used in the firstchar and lastchar fields to mark
401 * this value is used in the oldindex field to mark lines created by insertions
406 typedef struct screen SCREEN;
407 typedef struct _win_st WINDOW;
409 typedef chtype attr_t; /* ...must be at least as wide as chtype */
413 #if @NCURSES_LIBUTF8@
414 #ifdef mblen /* libutf8.h defines it w/o undefining first */
421 #include <wchar.h> /* ...to get mbstate_t, etc. */
424 #if @NCURSES_WCHAR_T@
425 typedef unsigned short wchar_t@NCURSES_OK_WCHAR_T@;
429 typedef unsigned int wint_t@NCURSES_OK_WCHAR_T@;
433 * cchar_t stores an array of CCHARW_MAX wide characters. The first is
434 * normally a spacing character. The others are non-spacing. If those
435 * (spacing and nonspacing) do not fill the array, a null L'\0' follows.
436 * Otherwise, a null is assumed to follow when extracting via getcchar().
438 #define CCHARW_MAX @NCURSES_CCHARW_MAX@
442 wchar_t chars[CCHARW_MAX];
443 #if @NCURSES_EXT_COLORS@
444 #undef NCURSES_EXT_COLORS
445 #define NCURSES_EXT_COLORS @NCURSES_PATCH@
446 int ext_color; /* color pair, must be more than 16-bits */
451 #endif /* NCURSES_WIDECHAR */
458 NCURSES_SIZE_T _cury, _curx; /* current cursor position */
460 /* window location and size */
461 NCURSES_SIZE_T _maxy, _maxx; /* maximums of x and y, NOT window size */
462 NCURSES_SIZE_T _begy, _begx; /* screen coords of upper-left-hand corner */
464 short _flags; /* window state flags */
466 /* attribute tracking */
467 attr_t _attrs; /* current attribute for non-space character */
468 chtype _bkgd; /* current background char/attribute pair */
470 /* option values set by user */
471 bool _notimeout; /* no time out on function-key entry? */
472 bool _clear; /* consider all data in the window invalid? */
473 bool _leaveok; /* OK to not reset cursor on exit? */
474 bool _scroll; /* OK to scroll this window? */
475 bool _idlok; /* OK to use insert/delete line? */
476 bool _idcok; /* OK to use insert/delete char? */
477 bool _immed; /* window in immed mode? (not yet used) */
478 bool _sync; /* window in sync mode? */
479 bool _use_keypad; /* process function keys into KEY_ symbols? */
480 int _delay; /* 0 = nodelay, <0 = blocking, >0 = delay */
482 struct ldat *_line; /* the actual line data */
484 /* global screen state */
485 NCURSES_SIZE_T _regtop; /* top line of scrolling region */
486 NCURSES_SIZE_T _regbottom; /* bottom line of scrolling region */
488 /* these are used only if this is a sub-window */
489 int _parx; /* x coordinate of this window in parent */
490 int _pary; /* y coordinate of this window in parent */
491 WINDOW *_parent; /* pointer to parent if a sub-window */
493 /* these are used only if this is a pad */
496 NCURSES_SIZE_T _pad_y, _pad_x;
497 NCURSES_SIZE_T _pad_top, _pad_left;
498 NCURSES_SIZE_T _pad_bottom, _pad_right;
501 NCURSES_SIZE_T _yoffset; /* real begy is _begy + _yoffset */
504 cchar_t _bkgrnd; /* current background char/attribute pair */
505 #if @NCURSES_EXT_COLORS@
506 int _color; /* current color-pair for non-space character */
510 #endif /* NCURSES_OPAQUE */
513 * GCC (and some other compilers) define '__attribute__'; we're using this
514 * macro to alert the compiler to flag inconsistencies in printf/scanf-like
515 * function calls. Just in case '__attribute__' isn't defined, make a dummy.
516 * Old versions of G++ do not accept it anyway, at least not consistently with
519 #if !(defined(__GNUC__) || defined(__GNUG__) || defined(__attribute__))
520 #define __attribute__(p) /* nothing */
524 * We cannot define these in ncurses_cfg.h, since they require parameters to be
525 * passed (that is non-portable). If you happen to be using gcc with warnings
529 * to improve checking of calls to printw(), etc.
531 #ifndef GCC_PRINTFLIKE
532 #if defined(GCC_PRINTF) && !defined(printf)
533 #define GCC_PRINTFLIKE(fmt,var) __attribute__((format(printf,fmt,var)))
535 #define GCC_PRINTFLIKE(fmt,var) /*nothing*/
539 #ifndef GCC_SCANFLIKE
540 #if defined(GCC_SCANF) && !defined(scanf)
541 #define GCC_SCANFLIKE(fmt,var) __attribute__((format(scanf,fmt,var)))
543 #define GCC_SCANFLIKE(fmt,var) /*nothing*/
548 #define GCC_NORETURN /* nothing */
552 #define GCC_UNUSED /* nothing */
555 #undef GCC_DEPRECATED
556 #if (__GNUC__ - 0 > 3 || (__GNUC__ - 0 == 3 && __GNUC_MINOR__ - 0 >= 2)) && !defined(NCURSES_INTERNALS)
557 #define GCC_DEPRECATED(msg) __attribute__((deprecated))
559 #define GCC_DEPRECATED(msg) /* nothing */
563 * Curses uses a helper function. Define our type for this to simplify
564 * extending it for the sp-funcs feature.
566 typedef int (*NCURSES_OUTC)(int);
569 * Function prototypes. This is the complete X/Open Curses list of required
570 * functions. Those marked `generated' will have sources generated from the
571 * macro definitions later in this file, in order to satisfy XPG4.2
575 extern NCURSES_EXPORT(int) addch (const chtype); /* generated */
576 extern NCURSES_EXPORT(int) addchnstr (const chtype *, int); /* generated */
577 extern NCURSES_EXPORT(int) addchstr (const chtype *); /* generated */
578 extern NCURSES_EXPORT(int) addnstr (const char *, int); /* generated */
579 extern NCURSES_EXPORT(int) addstr (const char *); /* generated */
580 extern NCURSES_EXPORT(int) attroff (NCURSES_ATTR_T); /* generated */
581 extern NCURSES_EXPORT(int) attron (NCURSES_ATTR_T); /* generated */
582 extern NCURSES_EXPORT(int) attrset (NCURSES_ATTR_T); /* generated */
583 extern NCURSES_EXPORT(int) attr_get (attr_t *, NCURSES_PAIRS_T *, void *); /* generated */
584 extern NCURSES_EXPORT(int) attr_off (attr_t, void *); /* generated */
585 extern NCURSES_EXPORT(int) attr_on (attr_t, void *); /* generated */
586 extern NCURSES_EXPORT(int) attr_set (attr_t, NCURSES_PAIRS_T, void *); /* generated */
587 extern NCURSES_EXPORT(int) baudrate (void); /* implemented */
588 extern NCURSES_EXPORT(int) beep (void); /* implemented */
589 extern NCURSES_EXPORT(int) bkgd (chtype); /* generated */
590 extern NCURSES_EXPORT(void) bkgdset (chtype); /* generated */
591 extern NCURSES_EXPORT(int) border (chtype,chtype,chtype,chtype,chtype,chtype,chtype,chtype); /* generated */
592 extern NCURSES_EXPORT(int) box (WINDOW *, chtype, chtype); /* generated */
593 extern NCURSES_EXPORT(bool) can_change_color (void); /* implemented */
594 extern NCURSES_EXPORT(int) cbreak (void); /* implemented */
595 extern NCURSES_EXPORT(int) chgat (int, attr_t, NCURSES_PAIRS_T, const void *); /* generated */
596 extern NCURSES_EXPORT(int) clear (void); /* generated */
597 extern NCURSES_EXPORT(int) clearok (WINDOW *,bool); /* implemented */
598 extern NCURSES_EXPORT(int) clrtobot (void); /* generated */
599 extern NCURSES_EXPORT(int) clrtoeol (void); /* generated */
600 extern NCURSES_EXPORT(int) color_content (NCURSES_COLOR_T,NCURSES_COLOR_T*,NCURSES_COLOR_T*,NCURSES_COLOR_T*); /* implemented */
601 extern NCURSES_EXPORT(int) color_set (NCURSES_PAIRS_T,void*); /* generated */
602 extern NCURSES_EXPORT(int) COLOR_PAIR (int); /* generated */
603 extern NCURSES_EXPORT(int) copywin (const WINDOW*,WINDOW*,int,int,int,int,int,int,int); /* implemented */
604 extern NCURSES_EXPORT(int) curs_set (int); /* implemented */
605 extern NCURSES_EXPORT(int) def_prog_mode (void); /* implemented */
606 extern NCURSES_EXPORT(int) def_shell_mode (void); /* implemented */
607 extern NCURSES_EXPORT(int) delay_output (int); /* implemented */
608 extern NCURSES_EXPORT(int) delch (void); /* generated */
609 extern NCURSES_EXPORT(void) delscreen (SCREEN *); /* implemented */
610 extern NCURSES_EXPORT(int) delwin (WINDOW *); /* implemented */
611 extern NCURSES_EXPORT(int) deleteln (void); /* generated */
612 extern NCURSES_EXPORT(WINDOW *) derwin (WINDOW *,int,int,int,int); /* implemented */
613 extern NCURSES_EXPORT(int) doupdate (void); /* implemented */
614 extern NCURSES_EXPORT(WINDOW *) dupwin (WINDOW *); /* implemented */
615 extern NCURSES_EXPORT(int) echo (void); /* implemented */
616 extern NCURSES_EXPORT(int) echochar (const chtype); /* generated */
617 extern NCURSES_EXPORT(int) erase (void); /* generated */
618 extern NCURSES_EXPORT(int) endwin (void); /* implemented */
619 extern NCURSES_EXPORT(char) erasechar (void); /* implemented */
620 extern NCURSES_EXPORT(void) filter (void); /* implemented */
621 extern NCURSES_EXPORT(int) flash (void); /* implemented */
622 extern NCURSES_EXPORT(int) flushinp (void); /* implemented */
623 extern NCURSES_EXPORT(chtype) getbkgd (WINDOW *); /* generated */
624 extern NCURSES_EXPORT(int) getch (void); /* generated */
625 extern NCURSES_EXPORT(int) getnstr (char *, int); /* generated */
626 extern NCURSES_EXPORT(int) getstr (char *); /* generated */
627 extern NCURSES_EXPORT(WINDOW *) getwin (FILE *); /* implemented */
628 extern NCURSES_EXPORT(int) halfdelay (int); /* implemented */
629 extern NCURSES_EXPORT(bool) has_colors (void); /* implemented */
630 extern NCURSES_EXPORT(bool) has_ic (void); /* implemented */
631 extern NCURSES_EXPORT(bool) has_il (void); /* implemented */
632 extern NCURSES_EXPORT(int) hline (chtype, int); /* generated */
633 extern NCURSES_EXPORT(void) idcok (WINDOW *, bool); /* implemented */
634 extern NCURSES_EXPORT(int) idlok (WINDOW *, bool); /* implemented */
635 extern NCURSES_EXPORT(void) immedok (WINDOW *, bool); /* implemented */
636 extern NCURSES_EXPORT(chtype) inch (void); /* generated */
637 extern NCURSES_EXPORT(int) inchnstr (chtype *, int); /* generated */
638 extern NCURSES_EXPORT(int) inchstr (chtype *); /* generated */
639 extern NCURSES_EXPORT(WINDOW *) initscr (void); /* implemented */
640 extern NCURSES_EXPORT(int) init_color (NCURSES_COLOR_T,NCURSES_COLOR_T,NCURSES_COLOR_T,NCURSES_COLOR_T); /* implemented */
641 extern NCURSES_EXPORT(int) init_pair (NCURSES_PAIRS_T,NCURSES_COLOR_T,NCURSES_COLOR_T); /* implemented */
642 extern NCURSES_EXPORT(int) innstr (char *, int); /* generated */
643 extern NCURSES_EXPORT(int) insch (chtype); /* generated */
644 extern NCURSES_EXPORT(int) insdelln (int); /* generated */
645 extern NCURSES_EXPORT(int) insertln (void); /* generated */
646 extern NCURSES_EXPORT(int) insnstr (const char *, int); /* generated */
647 extern NCURSES_EXPORT(int) insstr (const char *); /* generated */
648 extern NCURSES_EXPORT(int) instr (char *); /* generated */
649 extern NCURSES_EXPORT(int) intrflush (WINDOW *,bool); /* implemented */
650 extern NCURSES_EXPORT(bool) isendwin (void); /* implemented */
651 extern NCURSES_EXPORT(bool) is_linetouched (WINDOW *,int); /* implemented */
652 extern NCURSES_EXPORT(bool) is_wintouched (WINDOW *); /* implemented */
653 extern NCURSES_EXPORT(NCURSES_CONST char *) keyname (int); /* implemented */
654 extern NCURSES_EXPORT(int) keypad (WINDOW *,bool); /* implemented */
655 extern NCURSES_EXPORT(char) killchar (void); /* implemented */
656 extern NCURSES_EXPORT(int) leaveok (WINDOW *,bool); /* implemented */
657 extern NCURSES_EXPORT(char *) longname (void); /* implemented */
658 extern NCURSES_EXPORT(int) meta (WINDOW *,bool); /* implemented */
659 extern NCURSES_EXPORT(int) move (int, int); /* generated */
660 extern NCURSES_EXPORT(int) mvaddch (int, int, const chtype); /* generated */
661 extern NCURSES_EXPORT(int) mvaddchnstr (int, int, const chtype *, int); /* generated */
662 extern NCURSES_EXPORT(int) mvaddchstr (int, int, const chtype *); /* generated */
663 extern NCURSES_EXPORT(int) mvaddnstr (int, int, const char *, int); /* generated */
664 extern NCURSES_EXPORT(int) mvaddstr (int, int, const char *); /* generated */
665 extern NCURSES_EXPORT(int) mvchgat (int, int, int, attr_t, NCURSES_PAIRS_T, const void *); /* generated */
666 extern NCURSES_EXPORT(int) mvcur (int,int,int,int); /* implemented */
667 extern NCURSES_EXPORT(int) mvdelch (int, int); /* generated */
668 extern NCURSES_EXPORT(int) mvderwin (WINDOW *, int, int); /* implemented */
669 extern NCURSES_EXPORT(int) mvgetch (int, int); /* generated */
670 extern NCURSES_EXPORT(int) mvgetnstr (int, int, char *, int); /* generated */
671 extern NCURSES_EXPORT(int) mvgetstr (int, int, char *); /* generated */
672 extern NCURSES_EXPORT(int) mvhline (int, int, chtype, int); /* generated */
673 extern NCURSES_EXPORT(chtype) mvinch (int, int); /* generated */
674 extern NCURSES_EXPORT(int) mvinchnstr (int, int, chtype *, int); /* generated */
675 extern NCURSES_EXPORT(int) mvinchstr (int, int, chtype *); /* generated */
676 extern NCURSES_EXPORT(int) mvinnstr (int, int, char *, int); /* generated */
677 extern NCURSES_EXPORT(int) mvinsch (int, int, chtype); /* generated */
678 extern NCURSES_EXPORT(int) mvinsnstr (int, int, const char *, int); /* generated */
679 extern NCURSES_EXPORT(int) mvinsstr (int, int, const char *); /* generated */
680 extern NCURSES_EXPORT(int) mvinstr (int, int, char *); /* generated */
681 extern NCURSES_EXPORT(int) mvprintw (int,int, const char *,...) /* implemented */
683 extern NCURSES_EXPORT(int) mvscanw (int,int, const char *,...) /* implemented */
685 extern NCURSES_EXPORT(int) mvvline (int, int, chtype, int); /* generated */
686 extern NCURSES_EXPORT(int) mvwaddch (WINDOW *, int, int, const chtype); /* generated */
687 extern NCURSES_EXPORT(int) mvwaddchnstr (WINDOW *, int, int, const chtype *, int);/* generated */
688 extern NCURSES_EXPORT(int) mvwaddchstr (WINDOW *, int, int, const chtype *); /* generated */
689 extern NCURSES_EXPORT(int) mvwaddnstr (WINDOW *, int, int, const char *, int); /* generated */
690 extern NCURSES_EXPORT(int) mvwaddstr (WINDOW *, int, int, const char *); /* generated */
691 extern NCURSES_EXPORT(int) mvwchgat (WINDOW *, int, int, int, attr_t, NCURSES_PAIRS_T, const void *);/* generated */
692 extern NCURSES_EXPORT(int) mvwdelch (WINDOW *, int, int); /* generated */
693 extern NCURSES_EXPORT(int) mvwgetch (WINDOW *, int, int); /* generated */
694 extern NCURSES_EXPORT(int) mvwgetnstr (WINDOW *, int, int, char *, int); /* generated */
695 extern NCURSES_EXPORT(int) mvwgetstr (WINDOW *, int, int, char *); /* generated */
696 extern NCURSES_EXPORT(int) mvwhline (WINDOW *, int, int, chtype, int); /* generated */
697 extern NCURSES_EXPORT(int) mvwin (WINDOW *,int,int); /* implemented */
698 extern NCURSES_EXPORT(chtype) mvwinch (WINDOW *, int, int); /* generated */
699 extern NCURSES_EXPORT(int) mvwinchnstr (WINDOW *, int, int, chtype *, int); /* generated */
700 extern NCURSES_EXPORT(int) mvwinchstr (WINDOW *, int, int, chtype *); /* generated */
701 extern NCURSES_EXPORT(int) mvwinnstr (WINDOW *, int, int, char *, int); /* generated */
702 extern NCURSES_EXPORT(int) mvwinsch (WINDOW *, int, int, chtype); /* generated */
703 extern NCURSES_EXPORT(int) mvwinsnstr (WINDOW *, int, int, const char *, int); /* generated */
704 extern NCURSES_EXPORT(int) mvwinsstr (WINDOW *, int, int, const char *); /* generated */
705 extern NCURSES_EXPORT(int) mvwinstr (WINDOW *, int, int, char *); /* generated */
706 extern NCURSES_EXPORT(int) mvwprintw (WINDOW*,int,int, const char *,...) /* implemented */
708 extern NCURSES_EXPORT(int) mvwscanw (WINDOW *,int,int, const char *,...) /* implemented */
710 extern NCURSES_EXPORT(int) mvwvline (WINDOW *,int, int, chtype, int); /* generated */
711 extern NCURSES_EXPORT(int) napms (int); /* implemented */
712 extern NCURSES_EXPORT(WINDOW *) newpad (int,int); /* implemented */
713 extern NCURSES_EXPORT(SCREEN *) newterm (const char *,FILE *,FILE *); /* implemented */
714 extern NCURSES_EXPORT(WINDOW *) newwin (int,int,int,int); /* implemented */
715 extern NCURSES_EXPORT(int) nl (void); /* implemented */
716 extern NCURSES_EXPORT(int) nocbreak (void); /* implemented */
717 extern NCURSES_EXPORT(int) nodelay (WINDOW *,bool); /* implemented */
718 extern NCURSES_EXPORT(int) noecho (void); /* implemented */
719 extern NCURSES_EXPORT(int) nonl (void); /* implemented */
720 extern NCURSES_EXPORT(void) noqiflush (void); /* implemented */
721 extern NCURSES_EXPORT(int) noraw (void); /* implemented */
722 extern NCURSES_EXPORT(int) notimeout (WINDOW *,bool); /* implemented */
723 extern NCURSES_EXPORT(int) overlay (const WINDOW*,WINDOW *); /* implemented */
724 extern NCURSES_EXPORT(int) overwrite (const WINDOW*,WINDOW *); /* implemented */
725 extern NCURSES_EXPORT(int) pair_content (NCURSES_PAIRS_T,NCURSES_COLOR_T*,NCURSES_COLOR_T*); /* implemented */
726 extern NCURSES_EXPORT(int) PAIR_NUMBER (int); /* generated */
727 extern NCURSES_EXPORT(int) pechochar (WINDOW *, const chtype); /* implemented */
728 extern NCURSES_EXPORT(int) pnoutrefresh (WINDOW*,int,int,int,int,int,int);/* implemented */
729 extern NCURSES_EXPORT(int) prefresh (WINDOW *,int,int,int,int,int,int); /* implemented */
730 extern NCURSES_EXPORT(int) printw (const char *,...) /* implemented */
732 extern NCURSES_EXPORT(int) putwin (WINDOW *, FILE *); /* implemented */
733 extern NCURSES_EXPORT(void) qiflush (void); /* implemented */
734 extern NCURSES_EXPORT(int) raw (void); /* implemented */
735 extern NCURSES_EXPORT(int) redrawwin (WINDOW *); /* generated */
736 extern NCURSES_EXPORT(int) refresh (void); /* generated */
737 extern NCURSES_EXPORT(int) resetty (void); /* implemented */
738 extern NCURSES_EXPORT(int) reset_prog_mode (void); /* implemented */
739 extern NCURSES_EXPORT(int) reset_shell_mode (void); /* implemented */
740 extern NCURSES_EXPORT(int) ripoffline (int, int (*)(WINDOW *, int)); /* implemented */
741 extern NCURSES_EXPORT(int) savetty (void); /* implemented */
742 extern NCURSES_EXPORT(int) scanw (const char *,...) /* implemented */
744 extern NCURSES_EXPORT(int) scr_dump (const char *); /* implemented */
745 extern NCURSES_EXPORT(int) scr_init (const char *); /* implemented */
746 extern NCURSES_EXPORT(int) scrl (int); /* generated */
747 extern NCURSES_EXPORT(int) scroll (WINDOW *); /* generated */
748 extern NCURSES_EXPORT(int) scrollok (WINDOW *,bool); /* implemented */
749 extern NCURSES_EXPORT(int) scr_restore (const char *); /* implemented */
750 extern NCURSES_EXPORT(int) scr_set (const char *); /* implemented */
751 extern NCURSES_EXPORT(int) setscrreg (int,int); /* generated */
752 extern NCURSES_EXPORT(SCREEN *) set_term (SCREEN *); /* implemented */
753 extern NCURSES_EXPORT(int) slk_attroff (const chtype); /* implemented */
754 extern NCURSES_EXPORT(int) slk_attr_off (const attr_t, void *); /* generated:WIDEC */
755 extern NCURSES_EXPORT(int) slk_attron (const chtype); /* implemented */
756 extern NCURSES_EXPORT(int) slk_attr_on (attr_t,void*); /* generated:WIDEC */
757 extern NCURSES_EXPORT(int) slk_attrset (const chtype); /* implemented */
758 extern NCURSES_EXPORT(attr_t) slk_attr (void); /* implemented */
759 extern NCURSES_EXPORT(int) slk_attr_set (const attr_t,NCURSES_PAIRS_T,void*); /* implemented */
760 extern NCURSES_EXPORT(int) slk_clear (void); /* implemented */
761 extern NCURSES_EXPORT(int) slk_color (NCURSES_PAIRS_T); /* implemented */
762 extern NCURSES_EXPORT(int) slk_init (int); /* implemented */
763 extern NCURSES_EXPORT(char *) slk_label (int); /* implemented */
764 extern NCURSES_EXPORT(int) slk_noutrefresh (void); /* implemented */
765 extern NCURSES_EXPORT(int) slk_refresh (void); /* implemented */
766 extern NCURSES_EXPORT(int) slk_restore (void); /* implemented */
767 extern NCURSES_EXPORT(int) slk_set (int,const char *,int); /* implemented */
768 extern NCURSES_EXPORT(int) slk_touch (void); /* implemented */
769 extern NCURSES_EXPORT(int) standout (void); /* generated */
770 extern NCURSES_EXPORT(int) standend (void); /* generated */
771 extern NCURSES_EXPORT(int) start_color (void); /* implemented */
772 extern NCURSES_EXPORT(WINDOW *) subpad (WINDOW *, int, int, int, int); /* implemented */
773 extern NCURSES_EXPORT(WINDOW *) subwin (WINDOW *, int, int, int, int); /* implemented */
774 extern NCURSES_EXPORT(int) syncok (WINDOW *, bool); /* implemented */
775 extern NCURSES_EXPORT(chtype) termattrs (void); /* implemented */
776 extern NCURSES_EXPORT(char *) termname (void); /* implemented */
777 extern NCURSES_EXPORT(void) timeout (int); /* generated */
778 extern NCURSES_EXPORT(int) touchline (WINDOW *, int, int); /* generated */
779 extern NCURSES_EXPORT(int) touchwin (WINDOW *); /* generated */
780 extern NCURSES_EXPORT(int) typeahead (int); /* implemented */
781 extern NCURSES_EXPORT(int) ungetch (int); /* implemented */
782 extern NCURSES_EXPORT(int) untouchwin (WINDOW *); /* generated */
783 extern NCURSES_EXPORT(void) use_env (bool); /* implemented */
784 extern NCURSES_EXPORT(void) use_tioctl (bool); /* implemented */
785 extern NCURSES_EXPORT(int) vidattr (chtype); /* implemented */
786 extern NCURSES_EXPORT(int) vidputs (chtype, NCURSES_OUTC); /* implemented */
787 extern NCURSES_EXPORT(int) vline (chtype, int); /* generated */
788 extern NCURSES_EXPORT(int) vwprintw (WINDOW *, const char *,va_list) GCC_DEPRECATED(use vw_printw); /* implemented */
789 extern NCURSES_EXPORT(int) vw_printw (WINDOW *, const char *,va_list); /* implemented */
790 extern NCURSES_EXPORT(int) vwscanw (WINDOW *, const char *,va_list) GCC_DEPRECATED(use vw_scanw); /* implemented */
791 extern NCURSES_EXPORT(int) vw_scanw (WINDOW *, const char *,va_list); /* implemented */
792 extern NCURSES_EXPORT(int) waddch (WINDOW *, const chtype); /* implemented */
793 extern NCURSES_EXPORT(int) waddchnstr (WINDOW *,const chtype *,int); /* implemented */
794 extern NCURSES_EXPORT(int) waddchstr (WINDOW *,const chtype *); /* generated */
795 extern NCURSES_EXPORT(int) waddnstr (WINDOW *,const char *,int); /* implemented */
796 extern NCURSES_EXPORT(int) waddstr (WINDOW *,const char *); /* generated */
797 extern NCURSES_EXPORT(int) wattron (WINDOW *, int); /* generated */
798 extern NCURSES_EXPORT(int) wattroff (WINDOW *, int); /* generated */
799 extern NCURSES_EXPORT(int) wattrset (WINDOW *, int); /* generated */
800 extern NCURSES_EXPORT(int) wattr_get (WINDOW *, attr_t *, NCURSES_PAIRS_T *, void *); /* generated */
801 extern NCURSES_EXPORT(int) wattr_on (WINDOW *, attr_t, void *); /* implemented */
802 extern NCURSES_EXPORT(int) wattr_off (WINDOW *, attr_t, void *); /* implemented */
803 extern NCURSES_EXPORT(int) wattr_set (WINDOW *, attr_t, NCURSES_PAIRS_T, void *); /* generated */
804 extern NCURSES_EXPORT(int) wbkgd (WINDOW *, chtype); /* implemented */
805 extern NCURSES_EXPORT(void) wbkgdset (WINDOW *,chtype); /* implemented */
806 extern NCURSES_EXPORT(int) wborder (WINDOW *,chtype,chtype,chtype,chtype,chtype,chtype,chtype,chtype); /* implemented */
807 extern NCURSES_EXPORT(int) wchgat (WINDOW *, int, attr_t, NCURSES_PAIRS_T, const void *);/* implemented */
808 extern NCURSES_EXPORT(int) wclear (WINDOW *); /* implemented */
809 extern NCURSES_EXPORT(int) wclrtobot (WINDOW *); /* implemented */
810 extern NCURSES_EXPORT(int) wclrtoeol (WINDOW *); /* implemented */
811 extern NCURSES_EXPORT(int) wcolor_set (WINDOW*,NCURSES_PAIRS_T,void*); /* implemented */
812 extern NCURSES_EXPORT(void) wcursyncup (WINDOW *); /* implemented */
813 extern NCURSES_EXPORT(int) wdelch (WINDOW *); /* implemented */
814 extern NCURSES_EXPORT(int) wdeleteln (WINDOW *); /* generated */
815 extern NCURSES_EXPORT(int) wechochar (WINDOW *, const chtype); /* implemented */
816 extern NCURSES_EXPORT(int) werase (WINDOW *); /* implemented */
817 extern NCURSES_EXPORT(int) wgetch (WINDOW *); /* implemented */
818 extern NCURSES_EXPORT(int) wgetnstr (WINDOW *,char *,int); /* implemented */
819 extern NCURSES_EXPORT(int) wgetstr (WINDOW *, char *); /* generated */
820 extern NCURSES_EXPORT(int) whline (WINDOW *, chtype, int); /* implemented */
821 extern NCURSES_EXPORT(chtype) winch (WINDOW *); /* implemented */
822 extern NCURSES_EXPORT(int) winchnstr (WINDOW *, chtype *, int); /* implemented */
823 extern NCURSES_EXPORT(int) winchstr (WINDOW *, chtype *); /* generated */
824 extern NCURSES_EXPORT(int) winnstr (WINDOW *, char *, int); /* implemented */
825 extern NCURSES_EXPORT(int) winsch (WINDOW *, chtype); /* implemented */
826 extern NCURSES_EXPORT(int) winsdelln (WINDOW *,int); /* implemented */
827 extern NCURSES_EXPORT(int) winsertln (WINDOW *); /* generated */
828 extern NCURSES_EXPORT(int) winsnstr (WINDOW *, const char *,int); /* implemented */
829 extern NCURSES_EXPORT(int) winsstr (WINDOW *, const char *); /* generated */
830 extern NCURSES_EXPORT(int) winstr (WINDOW *, char *); /* generated */
831 extern NCURSES_EXPORT(int) wmove (WINDOW *,int,int); /* implemented */
832 extern NCURSES_EXPORT(int) wnoutrefresh (WINDOW *); /* implemented */
833 extern NCURSES_EXPORT(int) wprintw (WINDOW *, const char *,...) /* implemented */
835 extern NCURSES_EXPORT(int) wredrawln (WINDOW *,int,int); /* implemented */
836 extern NCURSES_EXPORT(int) wrefresh (WINDOW *); /* implemented */
837 extern NCURSES_EXPORT(int) wscanw (WINDOW *, const char *,...) /* implemented */
839 extern NCURSES_EXPORT(int) wscrl (WINDOW *,int); /* implemented */
840 extern NCURSES_EXPORT(int) wsetscrreg (WINDOW *,int,int); /* implemented */
841 extern NCURSES_EXPORT(int) wstandout (WINDOW *); /* generated */
842 extern NCURSES_EXPORT(int) wstandend (WINDOW *); /* generated */
843 extern NCURSES_EXPORT(void) wsyncdown (WINDOW *); /* implemented */
844 extern NCURSES_EXPORT(void) wsyncup (WINDOW *); /* implemented */
845 extern NCURSES_EXPORT(void) wtimeout (WINDOW *,int); /* implemented */
846 extern NCURSES_EXPORT(int) wtouchln (WINDOW *,int,int,int); /* implemented */
847 extern NCURSES_EXPORT(int) wvline (WINDOW *,chtype,int); /* implemented */
850 * These are also declared in <term.h>:
852 extern NCURSES_EXPORT(int) tigetflag (const char *); /* implemented */
853 extern NCURSES_EXPORT(int) tigetnum (const char *); /* implemented */
854 extern NCURSES_EXPORT(char *) tigetstr (const char *); /* implemented */
855 extern NCURSES_EXPORT(int) putp (const char *); /* implemented */
857 #if NCURSES_TPARM_VARARGS
858 extern NCURSES_EXPORT(char *) tparm (const char *, ...); /* special */
860 extern NCURSES_EXPORT(char *) tparm (const char *, NCURSES_TPARM_ARG,NCURSES_TPARM_ARG,NCURSES_TPARM_ARG,NCURSES_TPARM_ARG,NCURSES_TPARM_ARG,NCURSES_TPARM_ARG,NCURSES_TPARM_ARG,NCURSES_TPARM_ARG,NCURSES_TPARM_ARG); /* special */
863 extern NCURSES_EXPORT(char *) tiparm (const char *, ...); /* special */
866 * These functions are not in X/Open, but we use them in macro definitions:
868 extern NCURSES_EXPORT(int) getattrs (const WINDOW *); /* generated */
869 extern NCURSES_EXPORT(int) getcurx (const WINDOW *); /* generated */
870 extern NCURSES_EXPORT(int) getcury (const WINDOW *); /* generated */
871 extern NCURSES_EXPORT(int) getbegx (const WINDOW *); /* generated */
872 extern NCURSES_EXPORT(int) getbegy (const WINDOW *); /* generated */
873 extern NCURSES_EXPORT(int) getmaxx (const WINDOW *); /* generated */
874 extern NCURSES_EXPORT(int) getmaxy (const WINDOW *); /* generated */
875 extern NCURSES_EXPORT(int) getparx (const WINDOW *); /* generated */
876 extern NCURSES_EXPORT(int) getpary (const WINDOW *); /* generated */
879 * vid_attr() was implemented originally based on a draft of X/Open curses.
881 #if !NCURSES_WIDECHAR
882 #define vid_attr(a,pair,opts) vidattr(a)
886 * These functions are extensions - not in X/Open Curses.
888 #if @NCURSES_EXT_FUNCS@
889 #undef NCURSES_EXT_FUNCS
890 #define NCURSES_EXT_FUNCS @NCURSES_PATCH@
891 typedef int (*NCURSES_WINDOW_CB)(WINDOW *, void *);
892 typedef int (*NCURSES_SCREEN_CB)(SCREEN *, void *);
893 extern NCURSES_EXPORT(bool) is_term_resized (int, int);
894 extern NCURSES_EXPORT(char *) keybound (int, int);
895 extern NCURSES_EXPORT(const char *) curses_version (void);
896 extern NCURSES_EXPORT(int) alloc_pair (int, int);
897 extern NCURSES_EXPORT(int) assume_default_colors (int, int);
898 extern NCURSES_EXPORT(int) define_key (const char *, int);
899 extern NCURSES_EXPORT(int) extended_color_content(int, int *, int *, int *);
900 extern NCURSES_EXPORT(int) extended_pair_content(int, int *, int *);
901 extern NCURSES_EXPORT(int) extended_slk_color(int);
902 extern NCURSES_EXPORT(int) find_pair (int, int);
903 extern NCURSES_EXPORT(int) free_pair (int);
904 extern NCURSES_EXPORT(int) get_escdelay (void);
905 extern NCURSES_EXPORT(int) init_extended_color(int, int, int, int);
906 extern NCURSES_EXPORT(int) init_extended_pair(int, int, int);
907 extern NCURSES_EXPORT(int) key_defined (const char *);
908 extern NCURSES_EXPORT(int) keyok (int, bool);
909 extern NCURSES_EXPORT(void) reset_color_pairs (void);
910 extern NCURSES_EXPORT(int) resize_term (int, int);
911 extern NCURSES_EXPORT(int) resizeterm (int, int);
912 extern NCURSES_EXPORT(int) set_escdelay (int);
913 extern NCURSES_EXPORT(int) set_tabsize (int);
914 extern NCURSES_EXPORT(int) use_default_colors (void);
915 extern NCURSES_EXPORT(int) use_extended_names (bool);
916 extern NCURSES_EXPORT(int) use_legacy_coding (int);
917 extern NCURSES_EXPORT(int) use_screen (SCREEN *, NCURSES_SCREEN_CB, void *);
918 extern NCURSES_EXPORT(int) use_window (WINDOW *, NCURSES_WINDOW_CB, void *);
919 extern NCURSES_EXPORT(int) wresize (WINDOW *, int, int);
920 extern NCURSES_EXPORT(void) nofilter(void);
923 * These extensions provide access to information stored in the WINDOW even
924 * when NCURSES_OPAQUE is set:
926 extern NCURSES_EXPORT(WINDOW *) wgetparent (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
927 extern NCURSES_EXPORT(bool) is_cleared (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
928 extern NCURSES_EXPORT(bool) is_idcok (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
929 extern NCURSES_EXPORT(bool) is_idlok (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
930 extern NCURSES_EXPORT(bool) is_immedok (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
931 extern NCURSES_EXPORT(bool) is_keypad (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
932 extern NCURSES_EXPORT(bool) is_leaveok (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
933 extern NCURSES_EXPORT(bool) is_nodelay (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
934 extern NCURSES_EXPORT(bool) is_notimeout (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
935 extern NCURSES_EXPORT(bool) is_pad (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
936 extern NCURSES_EXPORT(bool) is_scrollok (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
937 extern NCURSES_EXPORT(bool) is_subwin (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
938 extern NCURSES_EXPORT(bool) is_syncok (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
939 extern NCURSES_EXPORT(int) wgetdelay (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
940 extern NCURSES_EXPORT(int) wgetscrreg (const WINDOW *, int *, int *); /* @GENERATED_EXT_FUNCS@ */
943 #define curses_version() NCURSES_VERSION
947 * Extra extension-functions, which pass a SCREEN pointer rather than using
948 * a global variable SP.
950 #if @NCURSES_SP_FUNCS@
951 #undef NCURSES_SP_FUNCS
952 #define NCURSES_SP_FUNCS @NCURSES_PATCH@
953 #define NCURSES_SP_NAME(name) name##_sp
955 /* Define the sp-funcs helper function */
956 #define NCURSES_SP_OUTC NCURSES_SP_NAME(NCURSES_OUTC)
957 typedef int (*NCURSES_SP_OUTC)(SCREEN*, int);
959 extern NCURSES_EXPORT(SCREEN *) new_prescr (void); /* implemented:SP_FUNC */
961 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(baudrate) (SCREEN*); /* implemented:SP_FUNC */
962 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(beep) (SCREEN*); /* implemented:SP_FUNC */
963 extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(can_change_color) (SCREEN*); /* implemented:SP_FUNC */
964 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(cbreak) (SCREEN*); /* implemented:SP_FUNC */
965 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(curs_set) (SCREEN*, int); /* implemented:SP_FUNC */
966 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(color_content) (SCREEN*, NCURSES_PAIRS_T, NCURSES_COLOR_T*, NCURSES_COLOR_T*, NCURSES_COLOR_T*); /* implemented:SP_FUNC */
967 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(def_prog_mode) (SCREEN*); /* implemented:SP_FUNC */
968 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(def_shell_mode) (SCREEN*); /* implemented:SP_FUNC */
969 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(delay_output) (SCREEN*, int); /* implemented:SP_FUNC */
970 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(doupdate) (SCREEN*); /* implemented:SP_FUNC */
971 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(echo) (SCREEN*); /* implemented:SP_FUNC */
972 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(endwin) (SCREEN*); /* implemented:SP_FUNC */
973 extern NCURSES_EXPORT(char) NCURSES_SP_NAME(erasechar) (SCREEN*);/* implemented:SP_FUNC */
974 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(filter) (SCREEN*); /* implemented:SP_FUNC */
975 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(flash) (SCREEN*); /* implemented:SP_FUNC */
976 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(flushinp) (SCREEN*); /* implemented:SP_FUNC */
977 extern NCURSES_EXPORT(WINDOW *) NCURSES_SP_NAME(getwin) (SCREEN*, FILE *); /* implemented:SP_FUNC */
978 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(halfdelay) (SCREEN*, int); /* implemented:SP_FUNC */
979 extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(has_colors) (SCREEN*); /* implemented:SP_FUNC */
980 extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(has_ic) (SCREEN*); /* implemented:SP_FUNC */
981 extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(has_il) (SCREEN*); /* implemented:SP_FUNC */
982 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(init_color) (SCREEN*, NCURSES_COLOR_T, NCURSES_COLOR_T, NCURSES_COLOR_T, NCURSES_COLOR_T); /* implemented:SP_FUNC */
983 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(init_pair) (SCREEN*, NCURSES_PAIRS_T, NCURSES_COLOR_T, NCURSES_COLOR_T); /* implemented:SP_FUNC */
984 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(intrflush) (SCREEN*, WINDOW*, bool); /* implemented:SP_FUNC */
985 extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(isendwin) (SCREEN*); /* implemented:SP_FUNC */
986 extern NCURSES_EXPORT(NCURSES_CONST char *) NCURSES_SP_NAME(keyname) (SCREEN*, int); /* implemented:SP_FUNC */
987 extern NCURSES_EXPORT(char) NCURSES_SP_NAME(killchar) (SCREEN*); /* implemented:SP_FUNC */
988 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(longname) (SCREEN*); /* implemented:SP_FUNC */
989 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(mvcur) (SCREEN*, int, int, int, int); /* implemented:SP_FUNC */
990 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(napms) (SCREEN*, int); /* implemented:SP_FUNC */
991 extern NCURSES_EXPORT(WINDOW *) NCURSES_SP_NAME(newpad) (SCREEN*, int, int); /* implemented:SP_FUNC */
992 extern NCURSES_EXPORT(SCREEN *) NCURSES_SP_NAME(newterm) (SCREEN*, const char *, FILE *, FILE *); /* implemented:SP_FUNC */
993 extern NCURSES_EXPORT(WINDOW *) NCURSES_SP_NAME(newwin) (SCREEN*, int, int, int, int); /* implemented:SP_FUNC */
994 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(nl) (SCREEN*); /* implemented:SP_FUNC */
995 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(nocbreak) (SCREEN*); /* implemented:SP_FUNC */
996 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(noecho) (SCREEN*); /* implemented:SP_FUNC */
997 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(nonl) (SCREEN*); /* implemented:SP_FUNC */
998 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(noqiflush) (SCREEN*); /* implemented:SP_FUNC */
999 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(noraw) (SCREEN*); /* implemented:SP_FUNC */
1000 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(pair_content) (SCREEN*, NCURSES_PAIRS_T, NCURSES_COLOR_T*, NCURSES_COLOR_T*); /* implemented:SP_FUNC */
1001 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(qiflush) (SCREEN*); /* implemented:SP_FUNC */
1002 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(raw) (SCREEN*); /* implemented:SP_FUNC */
1003 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(reset_prog_mode) (SCREEN*); /* implemented:SP_FUNC */
1004 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(reset_shell_mode) (SCREEN*); /* implemented:SP_FUNC */
1005 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(resetty) (SCREEN*); /* implemented:SP_FUNC */
1006 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(ripoffline) (SCREEN*, int, int (*)(WINDOW *, int)); /* implemented:SP_FUNC */
1007 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(savetty) (SCREEN*); /* implemented:SP_FUNC */
1008 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(scr_init) (SCREEN*, const char *); /* implemented:SP_FUNC */
1009 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(scr_restore) (SCREEN*, const char *); /* implemented:SP_FUNC */
1010 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(scr_set) (SCREEN*, const char *); /* implemented:SP_FUNC */
1011 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_attroff) (SCREEN*, const chtype); /* implemented:SP_FUNC */
1012 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_attron) (SCREEN*, const chtype); /* implemented:SP_FUNC */
1013 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_attrset) (SCREEN*, const chtype); /* implemented:SP_FUNC */
1014 extern NCURSES_EXPORT(attr_t) NCURSES_SP_NAME(slk_attr) (SCREEN*); /* implemented:SP_FUNC */
1015 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_attr_set) (SCREEN*, const attr_t, NCURSES_PAIRS_T, void*); /* implemented:SP_FUNC */
1016 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_clear) (SCREEN*); /* implemented:SP_FUNC */
1017 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_color) (SCREEN*, NCURSES_PAIRS_T); /* implemented:SP_FUNC */
1018 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_init) (SCREEN*, int); /* implemented:SP_FUNC */
1019 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(slk_label) (SCREEN*, int); /* implemented:SP_FUNC */
1020 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_noutrefresh) (SCREEN*); /* implemented:SP_FUNC */
1021 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_refresh) (SCREEN*); /* implemented:SP_FUNC */
1022 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_restore) (SCREEN*); /* implemented:SP_FUNC */
1023 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_set) (SCREEN*, int, const char *, int); /* implemented:SP_FUNC */
1024 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_touch) (SCREEN*); /* implemented:SP_FUNC */
1025 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(start_color) (SCREEN*); /* implemented:SP_FUNC */
1026 extern NCURSES_EXPORT(chtype) NCURSES_SP_NAME(termattrs) (SCREEN*); /* implemented:SP_FUNC */
1027 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(termname) (SCREEN*); /* implemented:SP_FUNC */
1028 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(typeahead) (SCREEN*, int); /* implemented:SP_FUNC */
1029 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(ungetch) (SCREEN*, int); /* implemented:SP_FUNC */
1030 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(use_env) (SCREEN*, bool); /* implemented:SP_FUNC */
1031 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(use_tioctl) (SCREEN*, bool); /* implemented:SP_FUNC */
1032 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(vidattr) (SCREEN*, chtype); /* implemented:SP_FUNC */
1033 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(vidputs) (SCREEN*, chtype, NCURSES_SP_OUTC); /* implemented:SP_FUNC */
1034 #if @NCURSES_EXT_FUNCS@
1035 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(keybound) (SCREEN*, int, int); /* implemented:EXT_SP_FUNC */
1036 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(alloc_pair) (SCREEN*, int, int); /* implemented:EXT_SP_FUNC */
1037 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(assume_default_colors) (SCREEN*, int, int); /* implemented:EXT_SP_FUNC */
1038 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(define_key) (SCREEN*, const char *, int); /* implemented:EXT_SP_FUNC */
1039 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(extended_color_content) (SCREEN*, int, int *, int *, int *); /* implemented:EXT_SP_FUNC */
1040 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(extended_pair_content) (SCREEN*, int, int *, int *); /* implemented:EXT_SP_FUNC */
1041 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(extended_slk_color) (SCREEN*, int); /* implemented:EXT_SP_FUNC */
1042 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(get_escdelay) (SCREEN*); /* implemented:EXT_SP_FUNC */
1043 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(find_pair) (SCREEN*, int, int); /* implemented:EXT_SP_FUNC */
1044 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(free_pair) (SCREEN*, int); /* implemented:EXT_SP_FUNC */
1045 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(init_extended_color) (SCREEN*, int, int, int, int); /* implemented:EXT_SP_FUNC */
1046 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(init_extended_pair) (SCREEN*, int, int, int); /* implemented:EXT_SP_FUNC */
1047 extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(is_term_resized) (SCREEN*, int, int); /* implemented:EXT_SP_FUNC */
1048 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(key_defined) (SCREEN*, const char *); /* implemented:EXT_SP_FUNC */
1049 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(keyok) (SCREEN*, int, bool); /* implemented:EXT_SP_FUNC */
1050 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(nofilter) (SCREEN*); /* implemented */ /* implemented:EXT_SP_FUNC */
1051 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(reset_color_pairs) (SCREEN*); /* implemented:EXT_SP_FUNC */
1052 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(resize_term) (SCREEN*, int, int); /* implemented:EXT_SP_FUNC */
1053 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(resizeterm) (SCREEN*, int, int); /* implemented:EXT_SP_FUNC */
1054 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(set_escdelay) (SCREEN*, int); /* implemented:EXT_SP_FUNC */
1055 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(set_tabsize) (SCREEN*, int); /* implemented:EXT_SP_FUNC */
1056 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(use_default_colors) (SCREEN*); /* implemented:EXT_SP_FUNC */
1057 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(use_legacy_coding) (SCREEN*, int); /* implemented:EXT_SP_FUNC */
1060 #undef NCURSES_SP_FUNCS
1061 #define NCURSES_SP_FUNCS 0
1062 #define NCURSES_SP_NAME(name) name
1063 #define NCURSES_SP_OUTC NCURSES_OUTC
1068 #define NCURSES_ATTR_SHIFT 8
1069 #define NCURSES_BITS(mask,shift) (NCURSES_CAST(chtype,(mask)) << ((shift) + NCURSES_ATTR_SHIFT))
1071 #define A_NORMAL (@cf_cv_1UL@ - @cf_cv_1UL@)
1072 #define A_ATTRIBUTES NCURSES_BITS(~(@cf_cv_1UL@ - @cf_cv_1UL@),0)
1073 #define A_CHARTEXT (NCURSES_BITS(@cf_cv_1UL@,0) - @cf_cv_1UL@)
1074 #define A_COLOR NCURSES_BITS(((@cf_cv_1UL@) << 8) - @cf_cv_1UL@,0)
1075 #define A_STANDOUT NCURSES_BITS(@cf_cv_1UL@,8)
1076 #define A_UNDERLINE NCURSES_BITS(@cf_cv_1UL@,9)
1077 #define A_REVERSE NCURSES_BITS(@cf_cv_1UL@,10)
1078 #define A_BLINK NCURSES_BITS(@cf_cv_1UL@,11)
1079 #define A_DIM NCURSES_BITS(@cf_cv_1UL@,12)
1080 #define A_BOLD NCURSES_BITS(@cf_cv_1UL@,13)
1081 #define A_ALTCHARSET NCURSES_BITS(@cf_cv_1UL@,14)
1082 #define A_INVIS NCURSES_BITS(@cf_cv_1UL@,15)
1083 #define A_PROTECT NCURSES_BITS(@cf_cv_1UL@,16)
1084 #define A_HORIZONTAL NCURSES_BITS(@cf_cv_1UL@,17)
1085 #define A_LEFT NCURSES_BITS(@cf_cv_1UL@,18)
1086 #define A_LOW NCURSES_BITS(@cf_cv_1UL@,19)
1087 #define A_RIGHT NCURSES_BITS(@cf_cv_1UL@,20)
1088 #define A_TOP NCURSES_BITS(@cf_cv_1UL@,21)
1089 #define A_VERTICAL NCURSES_BITS(@cf_cv_1UL@,22)
1091 #if @NCURSES_EXT_FUNCS@
1092 #define A_ITALIC NCURSES_BITS(@cf_cv_1UL@,23) /* ncurses extension */
1096 * Most of the pseudo functions are macros that either provide compatibility
1097 * with older versions of curses, or provide inline functionality to improve
1102 * These pseudo functions are always implemented as macros:
1105 #define getyx(win,y,x) (y = getcury(win), x = getcurx(win))
1106 #define getbegyx(win,y,x) (y = getbegy(win), x = getbegx(win))
1107 #define getmaxyx(win,y,x) (y = getmaxy(win), x = getmaxx(win))
1108 #define getparyx(win,y,x) (y = getpary(win), x = getparx(win))
1110 #define getsyx(y,x) do { if (newscr) { \
1111 if (is_leaveok(newscr)) \
1114 getyx(newscr,(y), (x)); \
1118 #define setsyx(y,x) do { if (newscr) { \
1119 if ((y) == -1 && (x) == -1) \
1120 leaveok(newscr, TRUE); \
1122 leaveok(newscr, FALSE); \
1123 wmove(newscr, (y), (x)); \
1128 #ifndef NCURSES_NOMACROS
1131 * These miscellaneous pseudo functions are provided for compatibility:
1134 #define wgetstr(w, s) wgetnstr(w, s, -1)
1135 #define getnstr(s, n) wgetnstr(stdscr, s, (n))
1137 #define setterm(term) setupterm(term, 1, (int *)0)
1139 #define fixterm() reset_prog_mode()
1140 #define resetterm() reset_shell_mode()
1141 #define saveterm() def_prog_mode()
1142 #define crmode() cbreak()
1143 #define nocrmode() nocbreak()
1146 /* It seems older SYSV curses versions define these */
1148 #define getattrs(win) NCURSES_CAST(int, NCURSES_OK_ADDR(win) ? (win)->_attrs : A_NORMAL)
1149 #define getcurx(win) (NCURSES_OK_ADDR(win) ? (win)->_curx : ERR)
1150 #define getcury(win) (NCURSES_OK_ADDR(win) ? (win)->_cury : ERR)
1151 #define getbegx(win) (NCURSES_OK_ADDR(win) ? (win)->_begx : ERR)
1152 #define getbegy(win) (NCURSES_OK_ADDR(win) ? (win)->_begy : ERR)
1153 #define getmaxx(win) (NCURSES_OK_ADDR(win) ? ((win)->_maxx + 1) : ERR)
1154 #define getmaxy(win) (NCURSES_OK_ADDR(win) ? ((win)->_maxy + 1) : ERR)
1155 #define getparx(win) (NCURSES_OK_ADDR(win) ? (win)->_parx : ERR)
1156 #define getpary(win) (NCURSES_OK_ADDR(win) ? (win)->_pary : ERR)
1157 #endif /* NCURSES_OPAQUE */
1159 #define wstandout(win) (wattrset(win,A_STANDOUT))
1160 #define wstandend(win) (wattrset(win,A_NORMAL))
1162 #define wattron(win,at) wattr_on(win, NCURSES_CAST(attr_t, at), NULL)
1163 #define wattroff(win,at) wattr_off(win, NCURSES_CAST(attr_t, at), NULL)
1166 #if NCURSES_WATTR_MACROS
1167 #if NCURSES_WIDECHAR && @NCURSES_EXT_COLORS@
1168 #define wattrset(win,at) \
1169 (NCURSES_OK_ADDR(win) \
1170 ? ((win)->_color = NCURSES_CAST(int, PAIR_NUMBER(at)), \
1171 (win)->_attrs = NCURSES_CAST(attr_t, at), \
1175 #define wattrset(win,at) \
1176 (NCURSES_OK_ADDR(win) \
1177 ? ((win)->_attrs = NCURSES_CAST(attr_t, at), \
1181 #endif /* NCURSES_WATTR_MACROS */
1182 #endif /* NCURSES_OPAQUE */
1184 #define scroll(win) wscrl(win,1)
1186 #define touchwin(win) wtouchln((win), 0, getmaxy(win), 1)
1187 #define touchline(win, s, c) wtouchln((win), s, c, 1)
1188 #define untouchwin(win) wtouchln((win), 0, getmaxy(win), 0)
1190 #define box(win, v, h) wborder(win, v, v, h, h, 0, 0, 0, 0)
1191 #define border(ls, rs, ts, bs, tl, tr, bl, br) wborder(stdscr, ls, rs, ts, bs, tl, tr, bl, br)
1192 #define hline(ch, n) whline(stdscr, ch, (n))
1193 #define vline(ch, n) wvline(stdscr, ch, (n))
1195 #define winstr(w, s) winnstr(w, s, -1)
1196 #define winchstr(w, s) winchnstr(w, s, -1)
1197 #define winsstr(w, s) winsnstr(w, s, -1)
1200 #define redrawwin(win) wredrawln(win, 0, (NCURSES_OK_ADDR(win) ? (win)->_maxy+1 : -1))
1201 #endif /* NCURSES_OPAQUE */
1203 #define waddstr(win,str) waddnstr(win,str,-1)
1204 #define waddchstr(win,str) waddchnstr(win,str,-1)
1207 * These apply to the first 256 color pairs.
1209 #define COLOR_PAIR(n) (NCURSES_BITS((n), 0) & A_COLOR)
1210 #define PAIR_NUMBER(a) (NCURSES_CAST(int,((NCURSES_CAST(unsigned long,(a)) & A_COLOR) >> NCURSES_ATTR_SHIFT)))
1213 * pseudo functions for standard screen
1216 #define addch(ch) waddch(stdscr,(ch))
1217 #define addchnstr(str,n) waddchnstr(stdscr,(str),(n))
1218 #define addchstr(str) waddchstr(stdscr,(str))
1219 #define addnstr(str,n) waddnstr(stdscr,(str),(n))
1220 #define addstr(str) waddnstr(stdscr,(str),-1)
1221 #define attr_get(ap,cp,o) wattr_get(stdscr,(ap),(cp),(o))
1222 #define attr_off(a,o) wattr_off(stdscr,(a),(o))
1223 #define attr_on(a,o) wattr_on(stdscr,(a),(o))
1224 #define attr_set(a,c,o) wattr_set(stdscr,(a),(c),(o))
1225 #define attroff(at) wattroff(stdscr,(at))
1226 #define attron(at) wattron(stdscr,(at))
1227 #define attrset(at) wattrset(stdscr,(at))
1228 #define bkgd(ch) wbkgd(stdscr,(ch))
1229 #define bkgdset(ch) wbkgdset(stdscr,(ch))
1230 #define chgat(n,a,c,o) wchgat(stdscr,(n),(a),(c),(o))
1231 #define clear() wclear(stdscr)
1232 #define clrtobot() wclrtobot(stdscr)
1233 #define clrtoeol() wclrtoeol(stdscr)
1234 #define color_set(c,o) wcolor_set(stdscr,(c),(o))
1235 #define delch() wdelch(stdscr)
1236 #define deleteln() winsdelln(stdscr,-1)
1237 #define echochar(c) wechochar(stdscr,(c))
1238 #define erase() werase(stdscr)
1239 #define getch() wgetch(stdscr)
1240 #define getstr(str) wgetstr(stdscr,(str))
1241 #define inch() winch(stdscr)
1242 #define inchnstr(s,n) winchnstr(stdscr,(s),(n))
1243 #define inchstr(s) winchstr(stdscr,(s))
1244 #define innstr(s,n) winnstr(stdscr,(s),(n))
1245 #define insch(c) winsch(stdscr,(c))
1246 #define insdelln(n) winsdelln(stdscr,(n))
1247 #define insertln() winsdelln(stdscr,1)
1248 #define insnstr(s,n) winsnstr(stdscr,(s),(n))
1249 #define insstr(s) winsstr(stdscr,(s))
1250 #define instr(s) winstr(stdscr,(s))
1251 #define move(y,x) wmove(stdscr,(y),(x))
1252 #define refresh() wrefresh(stdscr)
1253 #define scrl(n) wscrl(stdscr,(n))
1254 #define setscrreg(t,b) wsetscrreg(stdscr,(t),(b))
1255 #define standend() wstandend(stdscr)
1256 #define standout() wstandout(stdscr)
1257 #define timeout(delay) wtimeout(stdscr,(delay))
1258 #define wdeleteln(win) winsdelln(win,-1)
1259 #define winsertln(win) winsdelln(win,1)
1265 #define mvwaddch(win,y,x,ch) (wmove((win),(y),(x)) == ERR ? ERR : waddch((win),(ch)))
1266 #define mvwaddchnstr(win,y,x,str,n) (wmove((win),(y),(x)) == ERR ? ERR : waddchnstr((win),(str),(n)))
1267 #define mvwaddchstr(win,y,x,str) (wmove((win),(y),(x)) == ERR ? ERR : waddchnstr((win),(str),-1))
1268 #define mvwaddnstr(win,y,x,str,n) (wmove((win),(y),(x)) == ERR ? ERR : waddnstr((win),(str),(n)))
1269 #define mvwaddstr(win,y,x,str) (wmove((win),(y),(x)) == ERR ? ERR : waddnstr((win),(str),-1))
1270 #define mvwchgat(win,y,x,n,a,c,o) (wmove((win),(y),(x)) == ERR ? ERR : wchgat((win),(n),(a),(c),(o)))
1271 #define mvwdelch(win,y,x) (wmove((win),(y),(x)) == ERR ? ERR : wdelch(win))
1272 #define mvwgetch(win,y,x) (wmove((win),(y),(x)) == ERR ? ERR : wgetch(win))
1273 #define mvwgetnstr(win,y,x,str,n) (wmove((win),(y),(x)) == ERR ? ERR : wgetnstr((win),(str),(n)))
1274 #define mvwgetstr(win,y,x,str) (wmove((win),(y),(x)) == ERR ? ERR : wgetstr((win),(str)))
1275 #define mvwhline(win,y,x,c,n) (wmove((win),(y),(x)) == ERR ? ERR : whline((win),(c),(n)))
1276 #define mvwinch(win,y,x) (wmove((win),(y),(x)) == ERR ? NCURSES_CAST(chtype, ERR) : winch(win))
1277 #define mvwinchnstr(win,y,x,s,n) (wmove((win),(y),(x)) == ERR ? ERR : winchnstr((win),(s),(n)))
1278 #define mvwinchstr(win,y,x,s) (wmove((win),(y),(x)) == ERR ? ERR : winchstr((win),(s)))
1279 #define mvwinnstr(win,y,x,s,n) (wmove((win),(y),(x)) == ERR ? ERR : winnstr((win),(s),(n)))
1280 #define mvwinsch(win,y,x,c) (wmove((win),(y),(x)) == ERR ? ERR : winsch((win),(c)))
1281 #define mvwinsnstr(win,y,x,s,n) (wmove((win),(y),(x)) == ERR ? ERR : winsnstr((win),(s),(n)))
1282 #define mvwinsstr(win,y,x,s) (wmove((win),(y),(x)) == ERR ? ERR : winsstr((win),(s)))
1283 #define mvwinstr(win,y,x,s) (wmove((win),(y),(x)) == ERR ? ERR : winstr((win),(s)))
1284 #define mvwvline(win,y,x,c,n) (wmove((win),(y),(x)) == ERR ? ERR : wvline((win),(c),(n)))
1286 #define mvaddch(y,x,ch) mvwaddch(stdscr,(y),(x),(ch))
1287 #define mvaddchnstr(y,x,str,n) mvwaddchnstr(stdscr,(y),(x),(str),(n))
1288 #define mvaddchstr(y,x,str) mvwaddchstr(stdscr,(y),(x),(str))
1289 #define mvaddnstr(y,x,str,n) mvwaddnstr(stdscr,(y),(x),(str),(n))
1290 #define mvaddstr(y,x,str) mvwaddstr(stdscr,(y),(x),(str))
1291 #define mvchgat(y,x,n,a,c,o) mvwchgat(stdscr,(y),(x),(n),(a),(c),(o))
1292 #define mvdelch(y,x) mvwdelch(stdscr,(y),(x))
1293 #define mvgetch(y,x) mvwgetch(stdscr,(y),(x))
1294 #define mvgetnstr(y,x,str,n) mvwgetnstr(stdscr,(y),(x),(str),(n))
1295 #define mvgetstr(y,x,str) mvwgetstr(stdscr,(y),(x),(str))
1296 #define mvhline(y,x,c,n) mvwhline(stdscr,(y),(x),(c),(n))
1297 #define mvinch(y,x) mvwinch(stdscr,(y),(x))
1298 #define mvinchnstr(y,x,s,n) mvwinchnstr(stdscr,(y),(x),(s),(n))
1299 #define mvinchstr(y,x,s) mvwinchstr(stdscr,(y),(x),(s))
1300 #define mvinnstr(y,x,s,n) mvwinnstr(stdscr,(y),(x),(s),(n))
1301 #define mvinsch(y,x,c) mvwinsch(stdscr,(y),(x),(c))
1302 #define mvinsnstr(y,x,s,n) mvwinsnstr(stdscr,(y),(x),(s),(n))
1303 #define mvinsstr(y,x,s) mvwinsstr(stdscr,(y),(x),(s))
1304 #define mvinstr(y,x,s) mvwinstr(stdscr,(y),(x),(s))
1305 #define mvvline(y,x,c,n) mvwvline(stdscr,(y),(x),(c),(n))
1308 * Some wide-character functions can be implemented without the extensions.
1311 #define getbkgd(win) (NCURSES_OK_ADDR(win) ? ((win)->_bkgd) : 0)
1312 #endif /* NCURSES_OPAQUE */
1314 #define slk_attr_off(a,v) ((v) ? ERR : slk_attroff(a))
1315 #define slk_attr_on(a,v) ((v) ? ERR : slk_attron(a))
1318 #if NCURSES_WATTR_MACROS
1319 #if NCURSES_WIDECHAR && @NCURSES_EXT_COLORS@
1320 #define wattr_set(win,a,p,opts) \
1321 (NCURSES_OK_ADDR(win) \
1322 ? ((void)((win)->_attrs = ((a) & ~A_COLOR), \
1323 (win)->_color = (opts) ? *(int *)(opts) : (p)), \
1326 #define wattr_get(win,a,p,opts) \
1327 (NCURSES_OK_ADDR(win) \
1328 ? ((void)(NCURSES_OK_ADDR(a) \
1329 ? (*(a) = (win)->_attrs) \
1331 (void)(NCURSES_OK_ADDR(p) \
1332 ? (*(p) = (NCURSES_PAIRS_T) (win)->_color) \
1334 (void)(NCURSES_OK_ADDR(opts) \
1335 ? (*(int *)(opts) = (win)->_color) \
1339 #else /* !(NCURSES_WIDECHAR && NCURSES_EXE_COLORS) */
1340 #define wattr_set(win,a,p,opts) \
1341 (NCURSES_OK_ADDR(win) \
1342 ? ((void)((win)->_attrs = (((a) & ~A_COLOR) | \
1343 (attr_t)COLOR_PAIR(p))), \
1346 #define wattr_get(win,a,p,opts) \
1347 (NCURSES_OK_ADDR(win) \
1348 ? ((void)(NCURSES_OK_ADDR(a) \
1349 ? (*(a) = (win)->_attrs) \
1351 (void)(NCURSES_OK_ADDR(p) \
1352 ? (*(p) = (NCURSES_PAIRS_T) PAIR_NUMBER((win)->_attrs)) \
1356 #endif /* (NCURSES_WIDECHAR && NCURSES_EXE_COLORS) */
1357 #endif /* NCURSES_WATTR_MACROS */
1358 #endif /* NCURSES_OPAQUE */
1361 * X/Open curses deprecates SVr4 vwprintw/vwscanw, which are supposed to use
1362 * varargs.h. It adds new calls vw_printw/vw_scanw, which are supposed to
1363 * use POSIX stdarg.h. The ncurses versions of vwprintw/vwscanw already
1364 * use stdarg.h, so...
1366 /* define vw_printw vwprintw */
1367 /* define vw_scanw vwscanw */
1370 * Export fallback function for use in C++ binding.
1373 #define vsscanf(a,b,c) _nc_vsscanf(a,b,c)
1374 NCURSES_EXPORT(int) vsscanf(const char *, const char *, va_list);
1378 * These macros are extensions - not in X/Open Curses.
1380 #if @NCURSES_EXT_FUNCS@
1382 #define is_cleared(win) (NCURSES_OK_ADDR(win) ? (win)->_clear : FALSE)
1383 #define is_idcok(win) (NCURSES_OK_ADDR(win) ? (win)->_idcok : FALSE)
1384 #define is_idlok(win) (NCURSES_OK_ADDR(win) ? (win)->_idlok : FALSE)
1385 #define is_immedok(win) (NCURSES_OK_ADDR(win) ? (win)->_immed : FALSE)
1386 #define is_keypad(win) (NCURSES_OK_ADDR(win) ? (win)->_use_keypad : FALSE)
1387 #define is_leaveok(win) (NCURSES_OK_ADDR(win) ? (win)->_leaveok : FALSE)
1388 #define is_nodelay(win) (NCURSES_OK_ADDR(win) ? ((win)->_delay == 0) : FALSE)
1389 #define is_notimeout(win) (NCURSES_OK_ADDR(win) ? (win)->_notimeout : FALSE)
1390 #define is_pad(win) (NCURSES_OK_ADDR(win) ? ((win)->_flags & _ISPAD) != 0 : FALSE)
1391 #define is_scrollok(win) (NCURSES_OK_ADDR(win) ? (win)->_scroll : FALSE)
1392 #define is_subwin(win) (NCURSES_OK_ADDR(win) ? ((win)->_flags & _SUBWIN) != 0 : FALSE)
1393 #define is_syncok(win) (NCURSES_OK_ADDR(win) ? (win)->_sync : FALSE)
1394 #define wgetdelay(win) (NCURSES_OK_ADDR(win) ? (win)->_delay : 0)
1395 #define wgetparent(win) (NCURSES_OK_ADDR(win) ? (win)->_parent : 0)
1396 #define wgetscrreg(win,t,b) (NCURSES_OK_ADDR(win) ? (*(t) = (win)->_regtop, *(b) = (win)->_regbottom, OK) : ERR)
1401 * X/Open says this returns a bool; SVr4 also checked for out-of-range line.
1402 * The macro provides compatibility:
1404 #define is_linetouched(w,l) ((!(w) || ((l) > getmaxy(w)) || ((l) < 0)) ? ERR : (is_linetouched)((w),(l)))
1406 #endif /* NCURSES_NOMACROS */
1412 * a. ESCDELAY was an undocumented feature under AIX curses.
1413 * It gives the ESC expire time in milliseconds.
1414 * b. ttytype is needed for backward compatibility
1416 #if NCURSES_REENTRANT
1418 NCURSES_WRAPPED_VAR(WINDOW *, curscr);
1419 NCURSES_WRAPPED_VAR(WINDOW *, newscr);
1420 NCURSES_WRAPPED_VAR(WINDOW *, stdscr);
1421 NCURSES_WRAPPED_VAR(char *, ttytype);
1422 NCURSES_WRAPPED_VAR(int, COLORS);
1423 NCURSES_WRAPPED_VAR(int, COLOR_PAIRS);
1424 NCURSES_WRAPPED_VAR(int, COLS);
1425 NCURSES_WRAPPED_VAR(int, ESCDELAY);
1426 NCURSES_WRAPPED_VAR(int, LINES);
1427 NCURSES_WRAPPED_VAR(int, TABSIZE);
1429 #define curscr NCURSES_PUBLIC_VAR(curscr())
1430 #define newscr NCURSES_PUBLIC_VAR(newscr())
1431 #define stdscr NCURSES_PUBLIC_VAR(stdscr())
1432 #define ttytype NCURSES_PUBLIC_VAR(ttytype())
1433 #define COLORS NCURSES_PUBLIC_VAR(COLORS())
1434 #define COLOR_PAIRS NCURSES_PUBLIC_VAR(COLOR_PAIRS())
1435 #define COLS NCURSES_PUBLIC_VAR(COLS())
1436 #define ESCDELAY NCURSES_PUBLIC_VAR(ESCDELAY())
1437 #define LINES NCURSES_PUBLIC_VAR(LINES())
1438 #define TABSIZE NCURSES_PUBLIC_VAR(TABSIZE())
1442 extern NCURSES_EXPORT_VAR(WINDOW *) curscr;
1443 extern NCURSES_EXPORT_VAR(WINDOW *) newscr;
1444 extern NCURSES_EXPORT_VAR(WINDOW *) stdscr;
1445 extern NCURSES_EXPORT_VAR(char) ttytype[];
1446 extern NCURSES_EXPORT_VAR(int) COLORS;
1447 extern NCURSES_EXPORT_VAR(int) COLOR_PAIRS;
1448 extern NCURSES_EXPORT_VAR(int) COLS;
1449 extern NCURSES_EXPORT_VAR(int) ESCDELAY;
1450 extern NCURSES_EXPORT_VAR(int) LINES;
1451 extern NCURSES_EXPORT_VAR(int) TABSIZE;
1456 * Pseudo-character tokens outside ASCII range. The curses wgetch() function
1457 * will return any given one of these only if the corresponding k- capability
1458 * is defined in your terminal's terminfo entry.
1460 * Some keys (KEY_A1, etc) are arranged like this:
1465 * A few key codes do not depend upon the terminfo entry.
1467 #define KEY_CODE_YES 0400 /* A wchar_t contains a key code */
1468 #define KEY_MIN 0401 /* Minimum curses key */
1469 #define KEY_BREAK 0401 /* Break key (unreliable) */
1470 #define KEY_SRESET 0530 /* Soft (partial) reset (unreliable) */
1471 #define KEY_RESET 0531 /* Reset or hard reset (unreliable) */