1 /****************************************************************************
2 * Copyright 2018-2021,2023 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.281 2023/08/12 14:20:15 tom Exp $ */
42 The symbols beginning NCURSES_ or USE_ are configuration choices.
43 A few of the former can be overridden by applications at compile-time.
44 Most of the others correspond to configure-script options (or checks
45 by the configure-script for features of the system on which it is built).
47 These symbols can be overridden by applications at compile-time:
48 NCURSES_NOMACROS suppresses macro definitions in favor of functions
49 NCURSES_WATTR_MACROS suppresses wattr_* macro definitions
50 NCURSES_WIDECHAR is an alternative for declaring wide-character functions.
52 These symbols are used only when building ncurses:
54 NCURSES_FIELD_INTERNALS
57 These symbols are set by the configure script:
58 NCURSES_ENABLE_STDBOOL_H
72 /* These are defined only in curses.h, and are used for conditional compiles */
73 #define NCURSES_VERSION_MAJOR @NCURSES_MAJOR@
74 #define NCURSES_VERSION_MINOR @NCURSES_MINOR@
75 #define NCURSES_VERSION_PATCH @NCURSES_PATCH@
77 /* This is defined in more than one ncurses header, for identification */
78 #undef NCURSES_VERSION
79 #define NCURSES_VERSION "@NCURSES_MAJOR@.@NCURSES_MINOR@"
82 * Identify the mouse encoding version.
84 #define NCURSES_MOUSE_VERSION @NCURSES_MOUSE_VERSION@
87 * Definitions to facilitate DLL's.
89 #include <ncurses_dll.h>
100 #if @HAVE_STDNORETURN_H@
101 #include <stdnoreturn.h>
103 #define GCC_NORETURN _Noreturn
108 * User-definable tweak to disable the include of <stdbool.h>.
110 #ifndef NCURSES_ENABLE_STDBOOL_H
111 #define NCURSES_ENABLE_STDBOOL_H @cf_cv_header_stdbool_h@
115 * NCURSES_ATTR_T is used to quiet compiler warnings when building ncurses
116 * configured using --disable-macros.
118 #ifndef NCURSES_ATTR_T
119 #define NCURSES_ATTR_T int
123 * Expands to 'const' if ncurses is configured using --enable-const. Note that
124 * doing so makes it incompatible with other implementations of X/Open Curses.
127 #define NCURSES_CONST @NCURSES_CONST@
129 #undef NCURSES_INLINE
130 #define NCURSES_INLINE @NCURSES_INLINE@
133 * The standard type used for color values, and for color-pairs. The latter
134 * allows the curses library to enumerate the combinations of foreground and
135 * background colors used by an application, and is normally the product of the
136 * total foreground and background colors.
138 * X/Open uses "short" for both of these types, ultimately because they are
139 * numbers from the SVr4 terminal database, which uses 16-bit signed values.
141 #undef NCURSES_COLOR_T
142 #define NCURSES_COLOR_T short
144 #undef NCURSES_PAIRS_T
145 #define NCURSES_PAIRS_T short
148 * Definitions used to make WINDOW and similar structs opaque.
150 #ifndef NCURSES_INTERNALS
151 #define NCURSES_OPAQUE @NCURSES_OPAQUE@
152 #define NCURSES_OPAQUE_FORM @NCURSES_OPAQUE_FORM@
153 #define NCURSES_OPAQUE_MENU @NCURSES_OPAQUE_MENU@
154 #define NCURSES_OPAQUE_PANEL @NCURSES_OPAQUE_PANEL@
158 * Definition used to optionally suppress wattr* macros to help with the
159 * transition from ncurses5 to ncurses6 by allowing the header files to
160 * be shared across development packages for ncursesw in both ABIs.
162 #ifndef NCURSES_WATTR_MACROS
163 #define NCURSES_WATTR_MACROS @NCURSES_WATTR_MACROS@
167 * The reentrant code relies on the opaque setting, but adds features.
169 #ifndef NCURSES_REENTRANT
170 #define NCURSES_REENTRANT @cf_cv_enable_reentrant@
174 * In certain environments, we must work around linker problems for data
176 #undef NCURSES_BROKEN_LINKER
178 #define NCURSES_BROKEN_LINKER 1
182 * Control whether bindings for interop support are added.
184 #undef NCURSES_INTEROP_FUNCS
185 #define NCURSES_INTEROP_FUNCS @NCURSES_INTEROP_FUNCS@
188 * The internal type used for window dimensions.
190 #undef NCURSES_SIZE_T
191 #define NCURSES_SIZE_T @NCURSES_SIZE_T@
194 * Control whether tparm() supports varargs or fixed-parameter list.
196 #undef NCURSES_TPARM_VARARGS
197 #define NCURSES_TPARM_VARARGS @NCURSES_TPARM_VARARGS@
200 * Control type used for tparm's arguments. While X/Open equates long and
201 * char* values, this is not always workable for 64-bit platforms.
203 #undef NCURSES_TPARM_ARG
204 #define NCURSES_TPARM_ARG @NCURSES_TPARM_ARG@
207 * Control whether ncurses uses wcwidth() for checking width of line-drawing
210 #undef NCURSES_WCWIDTH_GRAPHICS
211 #define NCURSES_WCWIDTH_GRAPHICS @NCURSES_WCWIDTH_GRAPHICS@
214 * NCURSES_CH_T is used in building the library, but not used otherwise in
215 * this header file, since that would make the normal/wide-character versions
216 * of the header incompatible.
219 #define NCURSES_CH_T @NCURSES_CH_T@
221 #if @cf_cv_enable_lp64@ && defined(_LP64)
222 typedef unsigned chtype;
223 typedef unsigned mmask_t;
225 typedef @cf_cv_typeof_chtype@ chtype;
226 typedef @cf_cv_typeof_mmask_t@ mmask_t;
230 * We need FILE, etc. Include this before checking any feature symbols.
235 * With XPG4, you must define _XOPEN_SOURCE_EXTENDED, it is redundant (or
236 * conflicting) when _XOPEN_SOURCE is 500 or greater. If NCURSES_WIDECHAR is
237 * not already defined, e.g., if the platform relies upon nonstandard feature
238 * test macros, define it at this point if the standard feature test macros
239 * indicate that it should be defined.
241 #ifndef NCURSES_WIDECHAR
242 #if defined(_XOPEN_SOURCE_EXTENDED) || (defined(_XOPEN_SOURCE) && (_XOPEN_SOURCE - 0 >= 500))
243 #define NCURSES_WIDECHAR 1
245 #define NCURSES_WIDECHAR 0
247 #endif /* NCURSES_WIDECHAR */
249 #include <stdarg.h> /* we need va_list */
251 #include <stddef.h> /* we want wchar_t */
254 /* X/Open and SVr4 specify that curses implements 'bool'. However, C++ may also
255 * implement it. If so, we must use the C++ compiler's type to avoid conflict
256 * with other interfaces.
258 * A further complication is that <stdbool.h> may declare 'bool' to be a
259 * different type, such as an enum which is not necessarily compatible with
260 * C++. If we have <stdbool.h>, make 'bool' a macro, so users may #undef it.
261 * Otherwise, let it remain a typedef to avoid conflicts with other #define's.
262 * In either case, make a typedef for NCURSES_BOOL which can be used if needed
263 * from either C or C++.
272 typedef @cf_cv_type_of_bool@ NCURSES_BOOL;
274 #if @USE_CXX_BOOL@ /* __cplusplus, etc. */
276 /* use the C++ compiler's bool type */
277 #define NCURSES_BOOL bool
279 #else /* c89, c99, etc. */
281 #if NCURSES_ENABLE_STDBOOL_H
283 /* use whatever the C compiler decides bool really is */
284 #define NCURSES_BOOL bool
286 /* there is no predefined bool - use our own */
288 #define bool NCURSES_BOOL
291 #endif /* !__cplusplus, etc. */
295 #define NCURSES_CAST(type,value) static_cast<type>(value)
297 #define NCURSES_CAST(type,value) (type)(value)
300 #define NCURSES_OK_ADDR(p) (0 != NCURSES_CAST(const void *, (p)))
303 * X/Open attributes. In the ncurses implementation, they are identical to the
306 #define WA_ATTRIBUTES A_ATTRIBUTES
307 #define WA_NORMAL A_NORMAL
308 #define WA_STANDOUT A_STANDOUT
309 #define WA_UNDERLINE A_UNDERLINE
310 #define WA_REVERSE A_REVERSE
311 #define WA_BLINK A_BLINK
313 #define WA_BOLD A_BOLD
314 #define WA_ALTCHARSET A_ALTCHARSET
315 #define WA_INVIS A_INVIS
316 #define WA_PROTECT A_PROTECT
317 #define WA_HORIZONTAL A_HORIZONTAL
318 #define WA_LEFT A_LEFT
320 #define WA_RIGHT A_RIGHT
322 #define WA_VERTICAL A_VERTICAL
324 #if @NCURSES_EXT_FUNCS@
325 #define WA_ITALIC A_ITALIC /* ncurses extension */
329 #define COLOR_BLACK 0
331 #define COLOR_GREEN 2
332 #define COLOR_YELLOW 3
334 #define COLOR_MAGENTA 5
336 #define COLOR_WHITE 7
340 #if @BROKEN_LINKER@ || NCURSES_REENTRANT
341 NCURSES_WRAPPED_VAR(chtype*, acs_map);
342 #define acs_map NCURSES_PUBLIC_VAR(acs_map())
344 extern NCURSES_EXPORT_VAR(chtype) acs_map[];
347 #define NCURSES_ACS(c) (acs_map[NCURSES_CAST(unsigned char,(c))])
349 /* VT100 symbols begin here */
350 #define ACS_ULCORNER NCURSES_ACS('l') /* upper left corner */
351 #define ACS_LLCORNER NCURSES_ACS('m') /* lower left corner */
352 #define ACS_URCORNER NCURSES_ACS('k') /* upper right corner */
353 #define ACS_LRCORNER NCURSES_ACS('j') /* lower right corner */
354 #define ACS_LTEE NCURSES_ACS('t') /* tee pointing right */
355 #define ACS_RTEE NCURSES_ACS('u') /* tee pointing left */
356 #define ACS_BTEE NCURSES_ACS('v') /* tee pointing up */
357 #define ACS_TTEE NCURSES_ACS('w') /* tee pointing down */
358 #define ACS_HLINE NCURSES_ACS('q') /* horizontal line */
359 #define ACS_VLINE NCURSES_ACS('x') /* vertical line */
360 #define ACS_PLUS NCURSES_ACS('n') /* large plus or crossover */
361 #define ACS_S1 NCURSES_ACS('o') /* scan line 1 */
362 #define ACS_S9 NCURSES_ACS('s') /* scan line 9 */
363 #define ACS_DIAMOND NCURSES_ACS('`') /* diamond */
364 #define ACS_CKBOARD NCURSES_ACS('a') /* checker board (stipple) */
365 #define ACS_DEGREE NCURSES_ACS('f') /* degree symbol */
366 #define ACS_PLMINUS NCURSES_ACS('g') /* plus/minus */
367 #define ACS_BULLET NCURSES_ACS('~') /* bullet */
368 /* Teletype 5410v1 symbols begin here */
369 #define ACS_LARROW NCURSES_ACS(',') /* arrow pointing left */
370 #define ACS_RARROW NCURSES_ACS('+') /* arrow pointing right */
371 #define ACS_DARROW NCURSES_ACS('.') /* arrow pointing down */
372 #define ACS_UARROW NCURSES_ACS('-') /* arrow pointing up */
373 #define ACS_BOARD NCURSES_ACS('h') /* board of squares */
374 #define ACS_LANTERN NCURSES_ACS('i') /* lantern symbol */
375 #define ACS_BLOCK NCURSES_ACS('0') /* solid square block */
377 * These aren't documented, but a lot of System Vs have them anyway
378 * (you can spot pprryyzz{{||}} in a lot of AT&T terminfo strings).
379 * The ACS_names may not match AT&T's, our source didn't know them.
381 #define ACS_S3 NCURSES_ACS('p') /* scan line 3 */
382 #define ACS_S7 NCURSES_ACS('r') /* scan line 7 */
383 #define ACS_LEQUAL NCURSES_ACS('y') /* less/equal */
384 #define ACS_GEQUAL NCURSES_ACS('z') /* greater/equal */
385 #define ACS_PI NCURSES_ACS('{') /* Pi */
386 #define ACS_NEQUAL NCURSES_ACS('|') /* not equal */
387 #define ACS_STERLING NCURSES_ACS('}') /* UK pound sign */
390 * Line drawing ACS names are of the form ACS_trbl, where t is the top, r
391 * is the right, b is the bottom, and l is the left. t, r, b, and l might
392 * be B (blank), S (single), D (double), or T (thick). The subset defined
393 * here only uses B and S.
395 #define ACS_BSSB ACS_ULCORNER
396 #define ACS_SSBB ACS_LLCORNER
397 #define ACS_BBSS ACS_URCORNER
398 #define ACS_SBBS ACS_LRCORNER
399 #define ACS_SBSS ACS_RTEE
400 #define ACS_SSSB ACS_LTEE
401 #define ACS_SSBS ACS_BTEE
402 #define ACS_BSSS ACS_TTEE
403 #define ACS_BSBS ACS_HLINE
404 #define ACS_SBSB ACS_VLINE
405 #define ACS_SSSS ACS_PLUS
413 /* values for the _flags member */
414 #define _SUBWIN 0x01 /* is this a sub-window? */
415 #define _ENDLINE 0x02 /* is the window flush right? */
416 #define _FULLWIN 0x04 /* is the window full-screen? */
417 #define _SCROLLWIN 0x08 /* bottom edge is at screen bottom? */
418 #define _ISPAD 0x10 /* is this window a pad? */
419 #define _HASMOVED 0x20 /* has cursor moved since last refresh? */
420 #define _WRAPPED 0x40 /* cursor was just wrappped */
423 * this value is used in the firstchar and lastchar fields to mark
429 * this value is used in the oldindex field to mark lines created by insertions
434 #ifdef NCURSES_INTERNALS
436 #define SCREEN struct screen
439 typedef struct screen SCREEN;
442 typedef struct _win_st WINDOW;
444 typedef chtype attr_t; /* ...must be at least as wide as chtype */
448 #if @NCURSES_LIBUTF8@
449 #ifdef mblen /* libutf8.h defines it w/o undefining first */
456 #include <wchar.h> /* ...to get mbstate_t, etc. */
459 #if @NCURSES_WCHAR_T@
460 typedef unsigned short wchar_t@NCURSES_OK_WCHAR_T@;
464 typedef unsigned int wint_t@NCURSES_OK_WCHAR_T@;
468 * cchar_t stores an array of CCHARW_MAX wide characters. The first is
469 * normally a spacing character. The others are non-spacing. If those
470 * (spacing and nonspacing) do not fill the array, a null L'\0' follows.
471 * Otherwise, a null is assumed to follow when extracting via getcchar().
473 #define CCHARW_MAX @NCURSES_CCHARW_MAX@
477 wchar_t chars[CCHARW_MAX];
478 #if @NCURSES_EXT_COLORS@
479 #undef NCURSES_EXT_COLORS
480 #define NCURSES_EXT_COLORS @NCURSES_PATCH@
481 int ext_color; /* color pair, must be more than 16-bits */
486 #endif /* NCURSES_WIDECHAR */
493 NCURSES_SIZE_T _cury, _curx; /* current cursor position */
495 /* window location and size */
496 NCURSES_SIZE_T _maxy, _maxx; /* maximums of x and y, NOT window size */
497 NCURSES_SIZE_T _begy, _begx; /* screen coords of upper-left-hand corner */
499 short _flags; /* window state flags */
501 /* attribute tracking */
502 attr_t _attrs; /* current attribute for non-space character */
503 chtype _bkgd; /* current background char/attribute pair */
505 /* option values set by user */
506 bool _notimeout; /* no time out on function-key entry? */
507 bool _clear; /* consider all data in the window invalid? */
508 bool _leaveok; /* OK to not reset cursor on exit? */
509 bool _scroll; /* OK to scroll this window? */
510 bool _idlok; /* OK to use insert/delete line? */
511 bool _idcok; /* OK to use insert/delete char? */
512 bool _immed; /* window in immed mode? (not yet used) */
513 bool _sync; /* window in sync mode? */
514 bool _use_keypad; /* process function keys into KEY_ symbols? */
515 int _delay; /* 0 = nodelay, <0 = blocking, >0 = delay */
517 struct ldat *_line; /* the actual line data */
519 /* global screen state */
520 NCURSES_SIZE_T _regtop; /* top line of scrolling region */
521 NCURSES_SIZE_T _regbottom; /* bottom line of scrolling region */
523 /* these are used only if this is a sub-window */
524 int _parx; /* x coordinate of this window in parent */
525 int _pary; /* y coordinate of this window in parent */
526 WINDOW *_parent; /* pointer to parent if a sub-window */
528 /* these are used only if this is a pad */
531 NCURSES_SIZE_T _pad_y, _pad_x;
532 NCURSES_SIZE_T _pad_top, _pad_left;
533 NCURSES_SIZE_T _pad_bottom, _pad_right;
536 NCURSES_SIZE_T _yoffset; /* real begy is _begy + _yoffset */
539 cchar_t _bkgrnd; /* current background char/attribute pair */
540 #if @NCURSES_EXT_COLORS@
541 int _color; /* current color-pair for non-space character */
545 #endif /* NCURSES_OPAQUE */
548 * GCC (and some other compilers) define '__attribute__'; we're using this
549 * macro to alert the compiler to flag inconsistencies in printf/scanf-like
550 * function calls. Just in case '__attribute__' isn't defined, make a dummy.
551 * Old versions of G++ do not accept it anyway, at least not consistently with
554 #if !(defined(__GNUC__) || defined(__GNUG__) || defined(__attribute__))
555 #define __attribute__(p) /* nothing */
559 * We cannot define these in ncurses_cfg.h, since they require parameters to be
560 * passed (that is non-portable).
562 #ifndef GCC_PRINTFLIKE
564 #define GCC_PRINTFLIKE(fmt,var) __attribute__((format(printf,fmt,var)))
566 #define GCC_PRINTFLIKE(fmt,var) /*nothing*/
570 #ifndef GCC_SCANFLIKE
572 #define GCC_SCANFLIKE(fmt,var) __attribute__((format(scanf,fmt,var)))
574 #define GCC_SCANFLIKE(fmt,var) /*nothing*/
579 #define GCC_NORETURN /* nothing */
583 #define GCC_UNUSED /* nothing */
586 #undef GCC_DEPRECATED
587 #if (__GNUC__ - 0 > 3 || (__GNUC__ - 0 == 3 && __GNUC_MINOR__ - 0 >= 2)) && !defined(NCURSES_INTERNALS)
588 #define GCC_DEPRECATED(msg) __attribute__((deprecated))
590 #define GCC_DEPRECATED(msg) /* nothing */
594 * Curses uses a helper function. Define our type for this to simplify
595 * extending it for the sp-funcs feature.
597 typedef int (*NCURSES_OUTC)(int);
600 * Function prototypes. This is the complete X/Open Curses list of required
601 * functions. Those marked `generated' will have sources generated from the
602 * macro definitions later in this file, in order to satisfy XPG4.2
606 extern NCURSES_EXPORT(int) addch (const chtype); /* generated */
607 extern NCURSES_EXPORT(int) addchnstr (const chtype *, int); /* generated */
608 extern NCURSES_EXPORT(int) addchstr (const chtype *); /* generated */
609 extern NCURSES_EXPORT(int) addnstr (const char *, int); /* generated */
610 extern NCURSES_EXPORT(int) addstr (const char *); /* generated */
611 extern NCURSES_EXPORT(int) attroff (NCURSES_ATTR_T); /* generated */
612 extern NCURSES_EXPORT(int) attron (NCURSES_ATTR_T); /* generated */
613 extern NCURSES_EXPORT(int) attrset (NCURSES_ATTR_T); /* generated */
614 extern NCURSES_EXPORT(int) attr_get (attr_t *, NCURSES_PAIRS_T *, void *); /* generated */
615 extern NCURSES_EXPORT(int) attr_off (attr_t, void *); /* generated */
616 extern NCURSES_EXPORT(int) attr_on (attr_t, void *); /* generated */
617 extern NCURSES_EXPORT(int) attr_set (attr_t, NCURSES_PAIRS_T, void *); /* generated */
618 extern NCURSES_EXPORT(int) baudrate (void); /* implemented */
619 extern NCURSES_EXPORT(int) beep (void); /* implemented */
620 extern NCURSES_EXPORT(int) bkgd (chtype); /* generated */
621 extern NCURSES_EXPORT(void) bkgdset (chtype); /* generated */
622 extern NCURSES_EXPORT(int) border (chtype,chtype,chtype,chtype,chtype,chtype,chtype,chtype); /* generated */
623 extern NCURSES_EXPORT(int) box (WINDOW *, chtype, chtype); /* generated */
624 extern NCURSES_EXPORT(bool) can_change_color (void); /* implemented */
625 extern NCURSES_EXPORT(int) cbreak (void); /* implemented */
626 extern NCURSES_EXPORT(int) chgat (int, attr_t, NCURSES_PAIRS_T, const void *); /* generated */
627 extern NCURSES_EXPORT(int) clear (void); /* generated */
628 extern NCURSES_EXPORT(int) clearok (WINDOW *,bool); /* implemented */
629 extern NCURSES_EXPORT(int) clrtobot (void); /* generated */
630 extern NCURSES_EXPORT(int) clrtoeol (void); /* generated */
631 extern NCURSES_EXPORT(int) color_content (NCURSES_COLOR_T,NCURSES_COLOR_T*,NCURSES_COLOR_T*,NCURSES_COLOR_T*); /* implemented */
632 extern NCURSES_EXPORT(int) color_set (NCURSES_PAIRS_T,void*); /* generated */
633 extern NCURSES_EXPORT(int) COLOR_PAIR (int); /* generated */
634 extern NCURSES_EXPORT(int) copywin (const WINDOW*,WINDOW*,int,int,int,int,int,int,int); /* implemented */
635 extern NCURSES_EXPORT(int) curs_set (int); /* implemented */
636 extern NCURSES_EXPORT(int) def_prog_mode (void); /* implemented */
637 extern NCURSES_EXPORT(int) def_shell_mode (void); /* implemented */
638 extern NCURSES_EXPORT(int) delay_output (int); /* implemented */
639 extern NCURSES_EXPORT(int) delch (void); /* generated */
640 extern NCURSES_EXPORT(void) delscreen (SCREEN *); /* implemented */
641 extern NCURSES_EXPORT(int) delwin (WINDOW *); /* implemented */
642 extern NCURSES_EXPORT(int) deleteln (void); /* generated */
643 extern NCURSES_EXPORT(WINDOW *) derwin (WINDOW *,int,int,int,int); /* implemented */
644 extern NCURSES_EXPORT(int) doupdate (void); /* implemented */
645 extern NCURSES_EXPORT(WINDOW *) dupwin (WINDOW *); /* implemented */
646 extern NCURSES_EXPORT(int) echo (void); /* implemented */
647 extern NCURSES_EXPORT(int) echochar (const chtype); /* generated */
648 extern NCURSES_EXPORT(int) erase (void); /* generated */
649 extern NCURSES_EXPORT(int) endwin (void); /* implemented */
650 extern NCURSES_EXPORT(char) erasechar (void); /* implemented */
651 extern NCURSES_EXPORT(void) filter (void); /* implemented */
652 extern NCURSES_EXPORT(int) flash (void); /* implemented */
653 extern NCURSES_EXPORT(int) flushinp (void); /* implemented */
654 extern NCURSES_EXPORT(chtype) getbkgd (WINDOW *); /* generated */
655 extern NCURSES_EXPORT(int) getch (void); /* generated */
656 extern NCURSES_EXPORT(int) getnstr (char *, int); /* generated */
657 extern NCURSES_EXPORT(int) getstr (char *); /* generated */
658 extern NCURSES_EXPORT(WINDOW *) getwin (FILE *); /* implemented */
659 extern NCURSES_EXPORT(int) halfdelay (int); /* implemented */
660 extern NCURSES_EXPORT(bool) has_colors (void); /* implemented */
661 extern NCURSES_EXPORT(bool) has_ic (void); /* implemented */
662 extern NCURSES_EXPORT(bool) has_il (void); /* implemented */
663 extern NCURSES_EXPORT(int) hline (chtype, int); /* generated */
664 extern NCURSES_EXPORT(void) idcok (WINDOW *, bool); /* implemented */
665 extern NCURSES_EXPORT(int) idlok (WINDOW *, bool); /* implemented */
666 extern NCURSES_EXPORT(void) immedok (WINDOW *, bool); /* implemented */
667 extern NCURSES_EXPORT(chtype) inch (void); /* generated */
668 extern NCURSES_EXPORT(int) inchnstr (chtype *, int); /* generated */
669 extern NCURSES_EXPORT(int) inchstr (chtype *); /* generated */
670 extern NCURSES_EXPORT(WINDOW *) initscr (void); /* implemented */
671 extern NCURSES_EXPORT(int) init_color (NCURSES_COLOR_T,NCURSES_COLOR_T,NCURSES_COLOR_T,NCURSES_COLOR_T); /* implemented */
672 extern NCURSES_EXPORT(int) init_pair (NCURSES_PAIRS_T,NCURSES_COLOR_T,NCURSES_COLOR_T); /* implemented */
673 extern NCURSES_EXPORT(int) innstr (char *, int); /* generated */
674 extern NCURSES_EXPORT(int) insch (chtype); /* generated */
675 extern NCURSES_EXPORT(int) insdelln (int); /* generated */
676 extern NCURSES_EXPORT(int) insertln (void); /* generated */
677 extern NCURSES_EXPORT(int) insnstr (const char *, int); /* generated */
678 extern NCURSES_EXPORT(int) insstr (const char *); /* generated */
679 extern NCURSES_EXPORT(int) instr (char *); /* generated */
680 extern NCURSES_EXPORT(int) intrflush (WINDOW *,bool); /* implemented */
681 extern NCURSES_EXPORT(bool) isendwin (void); /* implemented */
682 extern NCURSES_EXPORT(bool) is_linetouched (WINDOW *,int); /* implemented */
683 extern NCURSES_EXPORT(bool) is_wintouched (WINDOW *); /* implemented */
684 extern NCURSES_EXPORT(NCURSES_CONST char *) keyname (int); /* implemented */
685 extern NCURSES_EXPORT(int) keypad (WINDOW *,bool); /* implemented */
686 extern NCURSES_EXPORT(char) killchar (void); /* implemented */
687 extern NCURSES_EXPORT(int) leaveok (WINDOW *,bool); /* implemented */
688 extern NCURSES_EXPORT(char *) longname (void); /* implemented */
689 extern NCURSES_EXPORT(int) meta (WINDOW *,bool); /* implemented */
690 extern NCURSES_EXPORT(int) move (int, int); /* generated */
691 extern NCURSES_EXPORT(int) mvaddch (int, int, const chtype); /* generated */
692 extern NCURSES_EXPORT(int) mvaddchnstr (int, int, const chtype *, int); /* generated */
693 extern NCURSES_EXPORT(int) mvaddchstr (int, int, const chtype *); /* generated */
694 extern NCURSES_EXPORT(int) mvaddnstr (int, int, const char *, int); /* generated */
695 extern NCURSES_EXPORT(int) mvaddstr (int, int, const char *); /* generated */
696 extern NCURSES_EXPORT(int) mvchgat (int, int, int, attr_t, NCURSES_PAIRS_T, const void *); /* generated */
697 extern NCURSES_EXPORT(int) mvcur (int,int,int,int); /* implemented */
698 extern NCURSES_EXPORT(int) mvdelch (int, int); /* generated */
699 extern NCURSES_EXPORT(int) mvderwin (WINDOW *, int, int); /* implemented */
700 extern NCURSES_EXPORT(int) mvgetch (int, int); /* generated */
701 extern NCURSES_EXPORT(int) mvgetnstr (int, int, char *, int); /* generated */
702 extern NCURSES_EXPORT(int) mvgetstr (int, int, char *); /* generated */
703 extern NCURSES_EXPORT(int) mvhline (int, int, chtype, int); /* generated */
704 extern NCURSES_EXPORT(chtype) mvinch (int, int); /* generated */
705 extern NCURSES_EXPORT(int) mvinchnstr (int, int, chtype *, int); /* generated */
706 extern NCURSES_EXPORT(int) mvinchstr (int, int, chtype *); /* generated */
707 extern NCURSES_EXPORT(int) mvinnstr (int, int, char *, int); /* generated */
708 extern NCURSES_EXPORT(int) mvinsch (int, int, chtype); /* generated */
709 extern NCURSES_EXPORT(int) mvinsnstr (int, int, const char *, int); /* generated */
710 extern NCURSES_EXPORT(int) mvinsstr (int, int, const char *); /* generated */
711 extern NCURSES_EXPORT(int) mvinstr (int, int, char *); /* generated */
712 extern NCURSES_EXPORT(int) mvprintw (int,int, const char *,...) /* implemented */
714 extern NCURSES_EXPORT(int) mvscanw (int,int, const char *,...) /* implemented */
716 extern NCURSES_EXPORT(int) mvvline (int, int, chtype, int); /* generated */
717 extern NCURSES_EXPORT(int) mvwaddch (WINDOW *, int, int, const chtype); /* generated */
718 extern NCURSES_EXPORT(int) mvwaddchnstr (WINDOW *, int, int, const chtype *, int);/* generated */
719 extern NCURSES_EXPORT(int) mvwaddchstr (WINDOW *, int, int, const chtype *); /* generated */
720 extern NCURSES_EXPORT(int) mvwaddnstr (WINDOW *, int, int, const char *, int); /* generated */
721 extern NCURSES_EXPORT(int) mvwaddstr (WINDOW *, int, int, const char *); /* generated */
722 extern NCURSES_EXPORT(int) mvwchgat (WINDOW *, int, int, int, attr_t, NCURSES_PAIRS_T, const void *);/* generated */
723 extern NCURSES_EXPORT(int) mvwdelch (WINDOW *, int, int); /* generated */
724 extern NCURSES_EXPORT(int) mvwgetch (WINDOW *, int, int); /* generated */
725 extern NCURSES_EXPORT(int) mvwgetnstr (WINDOW *, int, int, char *, int); /* generated */
726 extern NCURSES_EXPORT(int) mvwgetstr (WINDOW *, int, int, char *); /* generated */
727 extern NCURSES_EXPORT(int) mvwhline (WINDOW *, int, int, chtype, int); /* generated */
728 extern NCURSES_EXPORT(int) mvwin (WINDOW *,int,int); /* implemented */
729 extern NCURSES_EXPORT(chtype) mvwinch (WINDOW *, int, int); /* generated */
730 extern NCURSES_EXPORT(int) mvwinchnstr (WINDOW *, int, int, chtype *, int); /* generated */
731 extern NCURSES_EXPORT(int) mvwinchstr (WINDOW *, int, int, chtype *); /* generated */
732 extern NCURSES_EXPORT(int) mvwinnstr (WINDOW *, int, int, char *, int); /* generated */
733 extern NCURSES_EXPORT(int) mvwinsch (WINDOW *, int, int, chtype); /* generated */
734 extern NCURSES_EXPORT(int) mvwinsnstr (WINDOW *, int, int, const char *, int); /* generated */
735 extern NCURSES_EXPORT(int) mvwinsstr (WINDOW *, int, int, const char *); /* generated */
736 extern NCURSES_EXPORT(int) mvwinstr (WINDOW *, int, int, char *); /* generated */
737 extern NCURSES_EXPORT(int) mvwprintw (WINDOW*,int,int, const char *,...) /* implemented */
739 extern NCURSES_EXPORT(int) mvwscanw (WINDOW *,int,int, const char *,...) /* implemented */
741 extern NCURSES_EXPORT(int) mvwvline (WINDOW *,int, int, chtype, int); /* generated */
742 extern NCURSES_EXPORT(int) napms (int); /* implemented */
743 extern NCURSES_EXPORT(WINDOW *) newpad (int,int); /* implemented */
744 extern NCURSES_EXPORT(SCREEN *) newterm (const char *,FILE *,FILE *); /* implemented */
745 extern NCURSES_EXPORT(WINDOW *) newwin (int,int,int,int); /* implemented */
746 extern NCURSES_EXPORT(int) nl (void); /* implemented */
747 extern NCURSES_EXPORT(int) nocbreak (void); /* implemented */
748 extern NCURSES_EXPORT(int) nodelay (WINDOW *,bool); /* implemented */
749 extern NCURSES_EXPORT(int) noecho (void); /* implemented */
750 extern NCURSES_EXPORT(int) nonl (void); /* implemented */
751 extern NCURSES_EXPORT(void) noqiflush (void); /* implemented */
752 extern NCURSES_EXPORT(int) noraw (void); /* implemented */
753 extern NCURSES_EXPORT(int) notimeout (WINDOW *,bool); /* implemented */
754 extern NCURSES_EXPORT(int) overlay (const WINDOW*,WINDOW *); /* implemented */
755 extern NCURSES_EXPORT(int) overwrite (const WINDOW*,WINDOW *); /* implemented */
756 extern NCURSES_EXPORT(int) pair_content (NCURSES_PAIRS_T,NCURSES_COLOR_T*,NCURSES_COLOR_T*); /* implemented */
757 extern NCURSES_EXPORT(int) PAIR_NUMBER (int); /* generated */
758 extern NCURSES_EXPORT(int) pechochar (WINDOW *, const chtype); /* implemented */
759 extern NCURSES_EXPORT(int) pnoutrefresh (WINDOW*,int,int,int,int,int,int);/* implemented */
760 extern NCURSES_EXPORT(int) prefresh (WINDOW *,int,int,int,int,int,int); /* implemented */
761 extern NCURSES_EXPORT(int) printw (const char *,...) /* implemented */
763 extern NCURSES_EXPORT(int) putwin (WINDOW *, FILE *); /* implemented */
764 extern NCURSES_EXPORT(void) qiflush (void); /* implemented */
765 extern NCURSES_EXPORT(int) raw (void); /* implemented */
766 extern NCURSES_EXPORT(int) redrawwin (WINDOW *); /* generated */
767 extern NCURSES_EXPORT(int) refresh (void); /* generated */
768 extern NCURSES_EXPORT(int) resetty (void); /* implemented */
769 extern NCURSES_EXPORT(int) reset_prog_mode (void); /* implemented */
770 extern NCURSES_EXPORT(int) reset_shell_mode (void); /* implemented */
771 extern NCURSES_EXPORT(int) ripoffline (int, int (*)(WINDOW *, int)); /* implemented */
772 extern NCURSES_EXPORT(int) savetty (void); /* implemented */
773 extern NCURSES_EXPORT(int) scanw (const char *,...) /* implemented */
775 extern NCURSES_EXPORT(int) scr_dump (const char *); /* implemented */
776 extern NCURSES_EXPORT(int) scr_init (const char *); /* implemented */
777 extern NCURSES_EXPORT(int) scrl (int); /* generated */
778 extern NCURSES_EXPORT(int) scroll (WINDOW *); /* generated */
779 extern NCURSES_EXPORT(int) scrollok (WINDOW *,bool); /* implemented */
780 extern NCURSES_EXPORT(int) scr_restore (const char *); /* implemented */
781 extern NCURSES_EXPORT(int) scr_set (const char *); /* implemented */
782 extern NCURSES_EXPORT(int) setscrreg (int,int); /* generated */
783 extern NCURSES_EXPORT(SCREEN *) set_term (SCREEN *); /* implemented */
784 extern NCURSES_EXPORT(int) slk_attroff (const chtype); /* implemented */
785 extern NCURSES_EXPORT(int) slk_attr_off (const attr_t, void *); /* generated:WIDEC */
786 extern NCURSES_EXPORT(int) slk_attron (const chtype); /* implemented */
787 extern NCURSES_EXPORT(int) slk_attr_on (attr_t,void*); /* generated:WIDEC */
788 extern NCURSES_EXPORT(int) slk_attrset (const chtype); /* implemented */
789 extern NCURSES_EXPORT(attr_t) slk_attr (void); /* implemented */
790 extern NCURSES_EXPORT(int) slk_attr_set (const attr_t,NCURSES_PAIRS_T,void*); /* implemented */
791 extern NCURSES_EXPORT(int) slk_clear (void); /* implemented */
792 extern NCURSES_EXPORT(int) slk_color (NCURSES_PAIRS_T); /* implemented */
793 extern NCURSES_EXPORT(int) slk_init (int); /* implemented */
794 extern NCURSES_EXPORT(char *) slk_label (int); /* implemented */
795 extern NCURSES_EXPORT(int) slk_noutrefresh (void); /* implemented */
796 extern NCURSES_EXPORT(int) slk_refresh (void); /* implemented */
797 extern NCURSES_EXPORT(int) slk_restore (void); /* implemented */
798 extern NCURSES_EXPORT(int) slk_set (int,const char *,int); /* implemented */
799 extern NCURSES_EXPORT(int) slk_touch (void); /* implemented */
800 extern NCURSES_EXPORT(int) standout (void); /* generated */
801 extern NCURSES_EXPORT(int) standend (void); /* generated */
802 extern NCURSES_EXPORT(int) start_color (void); /* implemented */
803 extern NCURSES_EXPORT(WINDOW *) subpad (WINDOW *, int, int, int, int); /* implemented */
804 extern NCURSES_EXPORT(WINDOW *) subwin (WINDOW *, int, int, int, int); /* implemented */
805 extern NCURSES_EXPORT(int) syncok (WINDOW *, bool); /* implemented */
806 extern NCURSES_EXPORT(chtype) termattrs (void); /* implemented */
807 extern NCURSES_EXPORT(char *) termname (void); /* implemented */
808 extern NCURSES_EXPORT(void) timeout (int); /* generated */
809 extern NCURSES_EXPORT(int) touchline (WINDOW *, int, int); /* generated */
810 extern NCURSES_EXPORT(int) touchwin (WINDOW *); /* generated */
811 extern NCURSES_EXPORT(int) typeahead (int); /* implemented */
812 extern NCURSES_EXPORT(int) ungetch (int); /* implemented */
813 extern NCURSES_EXPORT(int) untouchwin (WINDOW *); /* generated */
814 extern NCURSES_EXPORT(void) use_env (bool); /* implemented */
815 extern NCURSES_EXPORT(void) use_tioctl (bool); /* implemented */
816 extern NCURSES_EXPORT(int) vidattr (chtype); /* implemented */
817 extern NCURSES_EXPORT(int) vidputs (chtype, NCURSES_OUTC); /* implemented */
818 extern NCURSES_EXPORT(int) vline (chtype, int); /* generated */
819 extern NCURSES_EXPORT(int) vwprintw (WINDOW *, const char *, va_list) GCC_DEPRECATED(use vw_printw) /* implemented */
821 extern NCURSES_EXPORT(int) vw_printw (WINDOW *, const char *, va_list) /* implemented */
823 extern NCURSES_EXPORT(int) vwscanw (WINDOW *, const char *, va_list) GCC_DEPRECATED(use vw_scanw) /* implemented */
825 extern NCURSES_EXPORT(int) vw_scanw (WINDOW *, const char *, va_list) /* implemented */
827 extern NCURSES_EXPORT(int) waddch (WINDOW *, const chtype); /* implemented */
828 extern NCURSES_EXPORT(int) waddchnstr (WINDOW *,const chtype *,int); /* implemented */
829 extern NCURSES_EXPORT(int) waddchstr (WINDOW *,const chtype *); /* generated */
830 extern NCURSES_EXPORT(int) waddnstr (WINDOW *,const char *,int); /* implemented */
831 extern NCURSES_EXPORT(int) waddstr (WINDOW *,const char *); /* generated */
832 extern NCURSES_EXPORT(int) wattron (WINDOW *, int); /* generated */
833 extern NCURSES_EXPORT(int) wattroff (WINDOW *, int); /* generated */
834 extern NCURSES_EXPORT(int) wattrset (WINDOW *, int); /* generated */
835 extern NCURSES_EXPORT(int) wattr_get (WINDOW *, attr_t *, NCURSES_PAIRS_T *, void *); /* generated */
836 extern NCURSES_EXPORT(int) wattr_on (WINDOW *, attr_t, void *); /* implemented */
837 extern NCURSES_EXPORT(int) wattr_off (WINDOW *, attr_t, void *); /* implemented */
838 extern NCURSES_EXPORT(int) wattr_set (WINDOW *, attr_t, NCURSES_PAIRS_T, void *); /* generated */
839 extern NCURSES_EXPORT(int) wbkgd (WINDOW *, chtype); /* implemented */
840 extern NCURSES_EXPORT(void) wbkgdset (WINDOW *,chtype); /* implemented */
841 extern NCURSES_EXPORT(int) wborder (WINDOW *,chtype,chtype,chtype,chtype,chtype,chtype,chtype,chtype); /* implemented */
842 extern NCURSES_EXPORT(int) wchgat (WINDOW *, int, attr_t, NCURSES_PAIRS_T, const void *);/* implemented */
843 extern NCURSES_EXPORT(int) wclear (WINDOW *); /* implemented */
844 extern NCURSES_EXPORT(int) wclrtobot (WINDOW *); /* implemented */
845 extern NCURSES_EXPORT(int) wclrtoeol (WINDOW *); /* implemented */
846 extern NCURSES_EXPORT(int) wcolor_set (WINDOW*,NCURSES_PAIRS_T,void*); /* implemented */
847 extern NCURSES_EXPORT(void) wcursyncup (WINDOW *); /* implemented */
848 extern NCURSES_EXPORT(int) wdelch (WINDOW *); /* implemented */
849 extern NCURSES_EXPORT(int) wdeleteln (WINDOW *); /* generated */
850 extern NCURSES_EXPORT(int) wechochar (WINDOW *, const chtype); /* implemented */
851 extern NCURSES_EXPORT(int) werase (WINDOW *); /* implemented */
852 extern NCURSES_EXPORT(int) wgetch (WINDOW *); /* implemented */
853 extern NCURSES_EXPORT(int) wgetnstr (WINDOW *,char *,int); /* implemented */
854 extern NCURSES_EXPORT(int) wgetstr (WINDOW *, char *); /* generated */
855 extern NCURSES_EXPORT(int) whline (WINDOW *, chtype, int); /* implemented */
856 extern NCURSES_EXPORT(chtype) winch (WINDOW *); /* implemented */
857 extern NCURSES_EXPORT(int) winchnstr (WINDOW *, chtype *, int); /* implemented */
858 extern NCURSES_EXPORT(int) winchstr (WINDOW *, chtype *); /* generated */
859 extern NCURSES_EXPORT(int) winnstr (WINDOW *, char *, int); /* implemented */
860 extern NCURSES_EXPORT(int) winsch (WINDOW *, chtype); /* implemented */
861 extern NCURSES_EXPORT(int) winsdelln (WINDOW *,int); /* implemented */
862 extern NCURSES_EXPORT(int) winsertln (WINDOW *); /* generated */
863 extern NCURSES_EXPORT(int) winsnstr (WINDOW *, const char *,int); /* implemented */
864 extern NCURSES_EXPORT(int) winsstr (WINDOW *, const char *); /* generated */
865 extern NCURSES_EXPORT(int) winstr (WINDOW *, char *); /* generated */
866 extern NCURSES_EXPORT(int) wmove (WINDOW *,int,int); /* implemented */
867 extern NCURSES_EXPORT(int) wnoutrefresh (WINDOW *); /* implemented */
868 extern NCURSES_EXPORT(int) wprintw (WINDOW *, const char *,...) /* implemented */
870 extern NCURSES_EXPORT(int) wredrawln (WINDOW *,int,int); /* implemented */
871 extern NCURSES_EXPORT(int) wrefresh (WINDOW *); /* implemented */
872 extern NCURSES_EXPORT(int) wscanw (WINDOW *, const char *,...) /* implemented */
874 extern NCURSES_EXPORT(int) wscrl (WINDOW *,int); /* implemented */
875 extern NCURSES_EXPORT(int) wsetscrreg (WINDOW *,int,int); /* implemented */
876 extern NCURSES_EXPORT(int) wstandout (WINDOW *); /* generated */
877 extern NCURSES_EXPORT(int) wstandend (WINDOW *); /* generated */
878 extern NCURSES_EXPORT(void) wsyncdown (WINDOW *); /* implemented */
879 extern NCURSES_EXPORT(void) wsyncup (WINDOW *); /* implemented */
880 extern NCURSES_EXPORT(void) wtimeout (WINDOW *,int); /* implemented */
881 extern NCURSES_EXPORT(int) wtouchln (WINDOW *,int,int,int); /* implemented */
882 extern NCURSES_EXPORT(int) wvline (WINDOW *,chtype,int); /* implemented */
885 * These are also declared in <term.h>:
887 extern NCURSES_EXPORT(int) tigetflag (const char *); /* implemented */
888 extern NCURSES_EXPORT(int) tigetnum (const char *); /* implemented */
889 extern NCURSES_EXPORT(char *) tigetstr (const char *); /* implemented */
890 extern NCURSES_EXPORT(int) putp (const char *); /* implemented */
892 #if NCURSES_TPARM_VARARGS
893 extern NCURSES_EXPORT(char *) tparm (const char *, ...); /* special */
895 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 */
898 extern NCURSES_EXPORT(char *) tiparm (const char *, ...); /* special */
899 extern NCURSES_EXPORT(char *) tiparm_s (int, int, const char *, ...); /* special */
900 extern NCURSES_EXPORT(int) tiscan_s (int *, int *, const char *); /* special */
903 * These functions are not in X/Open, but we use them in macro definitions:
905 extern NCURSES_EXPORT(int) getattrs (const WINDOW *); /* generated */
906 extern NCURSES_EXPORT(int) getcurx (const WINDOW *); /* generated */
907 extern NCURSES_EXPORT(int) getcury (const WINDOW *); /* generated */
908 extern NCURSES_EXPORT(int) getbegx (const WINDOW *); /* generated */
909 extern NCURSES_EXPORT(int) getbegy (const WINDOW *); /* generated */
910 extern NCURSES_EXPORT(int) getmaxx (const WINDOW *); /* generated */
911 extern NCURSES_EXPORT(int) getmaxy (const WINDOW *); /* generated */
912 extern NCURSES_EXPORT(int) getparx (const WINDOW *); /* generated */
913 extern NCURSES_EXPORT(int) getpary (const WINDOW *); /* generated */
916 * vid_attr() was implemented originally based on a draft of X/Open curses.
918 #if !NCURSES_WIDECHAR
919 #define vid_attr(a,pair,opts) vidattr(a)
923 * These functions are extensions - not in X/Open Curses.
925 #if @NCURSES_EXT_FUNCS@
926 #undef NCURSES_EXT_FUNCS
927 #define NCURSES_EXT_FUNCS @NCURSES_PATCH@
928 typedef int (*NCURSES_WINDOW_CB)(WINDOW *, void *);
929 typedef int (*NCURSES_SCREEN_CB)(SCREEN *, void *);
930 extern NCURSES_EXPORT(int) alloc_pair (int, int);
931 extern NCURSES_EXPORT(int) assume_default_colors (int, int);
932 extern NCURSES_EXPORT(const char *) curses_version (void);
933 extern NCURSES_EXPORT(int) define_key (const char *, int);
934 extern NCURSES_EXPORT(int) extended_color_content(int, int *, int *, int *);
935 extern NCURSES_EXPORT(int) extended_pair_content(int, int *, int *);
936 extern NCURSES_EXPORT(int) extended_slk_color(int);
937 extern NCURSES_EXPORT(int) find_pair (int, int);
938 extern NCURSES_EXPORT(int) free_pair (int);
939 extern NCURSES_EXPORT(int) get_escdelay (void);
940 extern NCURSES_EXPORT(int) init_extended_color(int, int, int, int);
941 extern NCURSES_EXPORT(int) init_extended_pair(int, int, int);
942 extern NCURSES_EXPORT(int) is_cbreak(void);
943 extern NCURSES_EXPORT(int) is_echo(void);
944 extern NCURSES_EXPORT(int) is_nl(void);
945 extern NCURSES_EXPORT(int) is_raw(void);
946 extern NCURSES_EXPORT(bool) is_term_resized (int, int);
947 extern NCURSES_EXPORT(int) key_defined (const char *);
948 extern NCURSES_EXPORT(char *) keybound (int, int);
949 extern NCURSES_EXPORT(int) keyok (int, bool);
950 extern NCURSES_EXPORT(void) nofilter(void);
951 extern NCURSES_EXPORT(void) reset_color_pairs (void);
952 extern NCURSES_EXPORT(int) resize_term (int, int);
953 extern NCURSES_EXPORT(int) resizeterm (int, int);
954 extern NCURSES_EXPORT(int) set_escdelay (int);
955 extern NCURSES_EXPORT(int) set_tabsize (int);
956 extern NCURSES_EXPORT(int) use_default_colors (void);
957 extern NCURSES_EXPORT(int) use_legacy_coding (int);
958 extern NCURSES_EXPORT(int) use_screen (SCREEN *, NCURSES_SCREEN_CB, void *);
959 extern NCURSES_EXPORT(int) use_window (WINDOW *, NCURSES_WINDOW_CB, void *);
960 extern NCURSES_EXPORT(int) wresize (WINDOW *, int, int);
963 #undef NCURSES_XNAMES
964 #define NCURSES_XNAMES @NCURSES_XNAMES@
965 extern NCURSES_EXPORT(int) use_extended_names (bool);
969 * These extensions provide access to information stored in the WINDOW even
970 * when NCURSES_OPAQUE is set:
972 extern NCURSES_EXPORT(WINDOW *) wgetparent (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
973 extern NCURSES_EXPORT(bool) is_cleared (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
974 extern NCURSES_EXPORT(bool) is_idcok (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
975 extern NCURSES_EXPORT(bool) is_idlok (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
976 extern NCURSES_EXPORT(bool) is_immedok (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
977 extern NCURSES_EXPORT(bool) is_keypad (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
978 extern NCURSES_EXPORT(bool) is_leaveok (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
979 extern NCURSES_EXPORT(bool) is_nodelay (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
980 extern NCURSES_EXPORT(bool) is_notimeout (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
981 extern NCURSES_EXPORT(bool) is_pad (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
982 extern NCURSES_EXPORT(bool) is_scrollok (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
983 extern NCURSES_EXPORT(bool) is_subwin (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
984 extern NCURSES_EXPORT(bool) is_syncok (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
985 extern NCURSES_EXPORT(int) wgetdelay (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
986 extern NCURSES_EXPORT(int) wgetscrreg (const WINDOW *, int *, int *); /* @GENERATED_EXT_FUNCS@ */
989 #define curses_version() NCURSES_VERSION
993 * Extra extension-functions, which pass a SCREEN pointer rather than using
994 * a global variable SP.
996 #if @NCURSES_SP_FUNCS@
997 #undef NCURSES_SP_FUNCS
998 #define NCURSES_SP_FUNCS @NCURSES_PATCH@
999 #define NCURSES_SP_NAME(name) name##_sp
1001 /* Define the sp-funcs helper function */
1002 #define NCURSES_SP_OUTC NCURSES_SP_NAME(NCURSES_OUTC)
1003 typedef int (*NCURSES_SP_OUTC)(SCREEN*, int);
1005 extern NCURSES_EXPORT(SCREEN *) new_prescr (void); /* implemented:SP_FUNC */
1007 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(baudrate) (SCREEN*); /* implemented:SP_FUNC */
1008 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(beep) (SCREEN*); /* implemented:SP_FUNC */
1009 extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(can_change_color) (SCREEN*); /* implemented:SP_FUNC */
1010 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(cbreak) (SCREEN*); /* implemented:SP_FUNC */
1011 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(curs_set) (SCREEN*, int); /* implemented:SP_FUNC */
1012 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 */
1013 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(def_prog_mode) (SCREEN*); /* implemented:SP_FUNC */
1014 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(def_shell_mode) (SCREEN*); /* implemented:SP_FUNC */
1015 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(delay_output) (SCREEN*, int); /* implemented:SP_FUNC */
1016 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(doupdate) (SCREEN*); /* implemented:SP_FUNC */
1017 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(echo) (SCREEN*); /* implemented:SP_FUNC */
1018 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(endwin) (SCREEN*); /* implemented:SP_FUNC */
1019 extern NCURSES_EXPORT(char) NCURSES_SP_NAME(erasechar) (SCREEN*);/* implemented:SP_FUNC */
1020 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(filter) (SCREEN*); /* implemented:SP_FUNC */
1021 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(flash) (SCREEN*); /* implemented:SP_FUNC */
1022 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(flushinp) (SCREEN*); /* implemented:SP_FUNC */
1023 extern NCURSES_EXPORT(WINDOW *) NCURSES_SP_NAME(getwin) (SCREEN*, FILE *); /* implemented:SP_FUNC */
1024 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(halfdelay) (SCREEN*, int); /* implemented:SP_FUNC */
1025 extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(has_colors) (SCREEN*); /* implemented:SP_FUNC */
1026 extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(has_ic) (SCREEN*); /* implemented:SP_FUNC */
1027 extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(has_il) (SCREEN*); /* implemented:SP_FUNC */
1028 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 */
1029 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(init_pair) (SCREEN*, NCURSES_PAIRS_T, NCURSES_COLOR_T, NCURSES_COLOR_T); /* implemented:SP_FUNC */
1030 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(intrflush) (SCREEN*, WINDOW*, bool); /* implemented:SP_FUNC */
1031 extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(isendwin) (SCREEN*); /* implemented:SP_FUNC */
1032 extern NCURSES_EXPORT(NCURSES_CONST char *) NCURSES_SP_NAME(keyname) (SCREEN*, int); /* implemented:SP_FUNC */
1033 extern NCURSES_EXPORT(char) NCURSES_SP_NAME(killchar) (SCREEN*); /* implemented:SP_FUNC */
1034 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(longname) (SCREEN*); /* implemented:SP_FUNC */
1035 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(mvcur) (SCREEN*, int, int, int, int); /* implemented:SP_FUNC */
1036 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(napms) (SCREEN*, int); /* implemented:SP_FUNC */
1037 extern NCURSES_EXPORT(WINDOW *) NCURSES_SP_NAME(newpad) (SCREEN*, int, int); /* implemented:SP_FUNC */
1038 extern NCURSES_EXPORT(SCREEN *) NCURSES_SP_NAME(newterm) (SCREEN*, const char *, FILE *, FILE *); /* implemented:SP_FUNC */
1039 extern NCURSES_EXPORT(WINDOW *) NCURSES_SP_NAME(newwin) (SCREEN*, int, int, int, int); /* implemented:SP_FUNC */
1040 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(nl) (SCREEN*); /* implemented:SP_FUNC */
1041 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(nocbreak) (SCREEN*); /* implemented:SP_FUNC */
1042 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(noecho) (SCREEN*); /* implemented:SP_FUNC */
1043 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(nonl) (SCREEN*); /* implemented:SP_FUNC */
1044 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(noqiflush) (SCREEN*); /* implemented:SP_FUNC */
1045 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(noraw) (SCREEN*); /* implemented:SP_FUNC */
1046 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(pair_content) (SCREEN*, NCURSES_PAIRS_T, NCURSES_COLOR_T*, NCURSES_COLOR_T*); /* implemented:SP_FUNC */
1047 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(qiflush) (SCREEN*); /* implemented:SP_FUNC */
1048 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(raw) (SCREEN*); /* implemented:SP_FUNC */
1049 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(reset_prog_mode) (SCREEN*); /* implemented:SP_FUNC */
1050 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(reset_shell_mode) (SCREEN*); /* implemented:SP_FUNC */
1051 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(resetty) (SCREEN*); /* implemented:SP_FUNC */
1052 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(ripoffline) (SCREEN*, int, int (*)(WINDOW *, int)); /* implemented:SP_FUNC */
1053 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(savetty) (SCREEN*); /* implemented:SP_FUNC */
1054 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(scr_init) (SCREEN*, const char *); /* implemented:SP_FUNC */
1055 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(scr_restore) (SCREEN*, const char *); /* implemented:SP_FUNC */
1056 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(scr_set) (SCREEN*, const char *); /* implemented:SP_FUNC */
1057 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_attroff) (SCREEN*, const chtype); /* implemented:SP_FUNC */
1058 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_attron) (SCREEN*, const chtype); /* implemented:SP_FUNC */
1059 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_attrset) (SCREEN*, const chtype); /* implemented:SP_FUNC */
1060 extern NCURSES_EXPORT(attr_t) NCURSES_SP_NAME(slk_attr) (SCREEN*); /* implemented:SP_FUNC */
1061 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_attr_set) (SCREEN*, const attr_t, NCURSES_PAIRS_T, void*); /* implemented:SP_FUNC */
1062 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_clear) (SCREEN*); /* implemented:SP_FUNC */
1063 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_color) (SCREEN*, NCURSES_PAIRS_T); /* implemented:SP_FUNC */
1064 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_init) (SCREEN*, int); /* implemented:SP_FUNC */
1065 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(slk_label) (SCREEN*, int); /* implemented:SP_FUNC */
1066 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_noutrefresh) (SCREEN*); /* implemented:SP_FUNC */
1067 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_refresh) (SCREEN*); /* implemented:SP_FUNC */
1068 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_restore) (SCREEN*); /* implemented:SP_FUNC */
1069 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_set) (SCREEN*, int, const char *, int); /* implemented:SP_FUNC */
1070 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_touch) (SCREEN*); /* implemented:SP_FUNC */
1071 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(start_color) (SCREEN*); /* implemented:SP_FUNC */
1072 extern NCURSES_EXPORT(chtype) NCURSES_SP_NAME(termattrs) (SCREEN*); /* implemented:SP_FUNC */
1073 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(termname) (SCREEN*); /* implemented:SP_FUNC */
1074 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(typeahead) (SCREEN*, int); /* implemented:SP_FUNC */
1075 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(ungetch) (SCREEN*, int); /* implemented:SP_FUNC */
1076 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(use_env) (SCREEN*, bool); /* implemented:SP_FUNC */
1077 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(use_tioctl) (SCREEN*, bool); /* implemented:SP_FUNC */
1078 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(vidattr) (SCREEN*, chtype); /* implemented:SP_FUNC */
1079 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(vidputs) (SCREEN*, chtype, NCURSES_SP_OUTC); /* implemented:SP_FUNC */
1080 #if @NCURSES_EXT_FUNCS@
1081 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(alloc_pair) (SCREEN*, int, int); /* implemented:EXT_SP_FUNC */
1082 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(assume_default_colors) (SCREEN*, int, int); /* implemented:EXT_SP_FUNC */
1083 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(define_key) (SCREEN*, const char *, int); /* implemented:EXT_SP_FUNC */
1084 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(extended_color_content) (SCREEN*, int, int *, int *, int *); /* implemented:EXT_SP_FUNC */
1085 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(extended_pair_content) (SCREEN*, int, int *, int *); /* implemented:EXT_SP_FUNC */
1086 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(extended_slk_color) (SCREEN*, int); /* implemented:EXT_SP_FUNC */
1087 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(find_pair) (SCREEN*, int, int); /* implemented:EXT_SP_FUNC */
1088 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(free_pair) (SCREEN*, int); /* implemented:EXT_SP_FUNC */
1089 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(get_escdelay) (SCREEN*); /* implemented:EXT_SP_FUNC */
1090 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(init_extended_color) (SCREEN*, int, int, int, int); /* implemented:EXT_SP_FUNC */
1091 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(init_extended_pair) (SCREEN*, int, int, int); /* implemented:EXT_SP_FUNC */
1092 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(is_cbreak) (SCREEN*); /* implemented:EXT_SP_FUNC */
1093 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(is_echo) (SCREEN*); /* implemented:EXT_SP_FUNC */
1094 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(is_nl) (SCREEN*); /* implemented:EXT_SP_FUNC */
1095 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(is_raw) (SCREEN*); /* implemented:EXT_SP_FUNC */
1096 extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(is_term_resized) (SCREEN*, int, int); /* implemented:EXT_SP_FUNC */
1097 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(key_defined) (SCREEN*, const char *); /* implemented:EXT_SP_FUNC */
1098 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(keybound) (SCREEN*, int, int); /* implemented:EXT_SP_FUNC */
1099 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(keyok) (SCREEN*, int, bool); /* implemented:EXT_SP_FUNC */
1100 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(nofilter) (SCREEN*); /* implemented */ /* implemented:EXT_SP_FUNC */
1101 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(reset_color_pairs) (SCREEN*); /* implemented:EXT_SP_FUNC */
1102 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(resize_term) (SCREEN*, int, int); /* implemented:EXT_SP_FUNC */
1103 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(resizeterm) (SCREEN*, int, int); /* implemented:EXT_SP_FUNC */
1104 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(set_escdelay) (SCREEN*, int); /* implemented:EXT_SP_FUNC */
1105 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(set_tabsize) (SCREEN*, int); /* implemented:EXT_SP_FUNC */
1106 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(use_default_colors) (SCREEN*); /* implemented:EXT_SP_FUNC */
1107 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(use_legacy_coding) (SCREEN*, int); /* implemented:EXT_SP_FUNC */
1110 #undef NCURSES_SP_FUNCS
1111 #define NCURSES_SP_FUNCS 0
1112 #define NCURSES_SP_NAME(name) name
1113 #define NCURSES_SP_OUTC NCURSES_OUTC
1118 #define NCURSES_ATTR_SHIFT 8
1119 #define NCURSES_BITS(mask,shift) (NCURSES_CAST(chtype,(mask)) << ((shift) + NCURSES_ATTR_SHIFT))
1121 #define A_NORMAL (@cf_cv_1UL@ - @cf_cv_1UL@)
1122 #define A_ATTRIBUTES NCURSES_BITS(~(@cf_cv_1UL@ - @cf_cv_1UL@),0)
1123 #define A_CHARTEXT (NCURSES_BITS(@cf_cv_1UL@,0) - @cf_cv_1UL@)
1124 #define A_COLOR NCURSES_BITS(((@cf_cv_1UL@) << 8) - @cf_cv_1UL@,0)
1125 #define A_STANDOUT NCURSES_BITS(@cf_cv_1UL@,8)
1126 #define A_UNDERLINE NCURSES_BITS(@cf_cv_1UL@,9)
1127 #define A_REVERSE NCURSES_BITS(@cf_cv_1UL@,10)
1128 #define A_BLINK NCURSES_BITS(@cf_cv_1UL@,11)
1129 #define A_DIM NCURSES_BITS(@cf_cv_1UL@,12)
1130 #define A_BOLD NCURSES_BITS(@cf_cv_1UL@,13)
1131 #define A_ALTCHARSET NCURSES_BITS(@cf_cv_1UL@,14)
1132 #define A_INVIS NCURSES_BITS(@cf_cv_1UL@,15)
1133 #define A_PROTECT NCURSES_BITS(@cf_cv_1UL@,16)
1134 #define A_HORIZONTAL NCURSES_BITS(@cf_cv_1UL@,17)
1135 #define A_LEFT NCURSES_BITS(@cf_cv_1UL@,18)
1136 #define A_LOW NCURSES_BITS(@cf_cv_1UL@,19)
1137 #define A_RIGHT NCURSES_BITS(@cf_cv_1UL@,20)
1138 #define A_TOP NCURSES_BITS(@cf_cv_1UL@,21)
1139 #define A_VERTICAL NCURSES_BITS(@cf_cv_1UL@,22)
1141 #if @NCURSES_EXT_FUNCS@
1142 #define A_ITALIC NCURSES_BITS(@cf_cv_1UL@,23) /* ncurses extension */
1146 * Most of the pseudo functions are macros that either provide compatibility
1147 * with older versions of curses, or provide inline functionality to improve
1152 * These pseudo functions are always implemented as macros:
1155 #define getyx(win,y,x) (y = getcury(win), x = getcurx(win))
1156 #define getbegyx(win,y,x) (y = getbegy(win), x = getbegx(win))
1157 #define getmaxyx(win,y,x) (y = getmaxy(win), x = getmaxx(win))
1158 #define getparyx(win,y,x) (y = getpary(win), x = getparx(win))
1160 #define getsyx(y,x) do { if (newscr) { \
1161 if (is_leaveok(newscr)) \
1164 getyx(newscr,(y), (x)); \
1168 #define setsyx(y,x) do { if (newscr) { \
1169 if ((y) == -1 && (x) == -1) \
1170 leaveok(newscr, TRUE); \
1172 leaveok(newscr, FALSE); \
1173 wmove(newscr, (y), (x)); \
1178 #ifndef NCURSES_NOMACROS
1181 * These miscellaneous pseudo functions are provided for compatibility:
1184 #define wgetstr(w, s) wgetnstr(w, s, -1)
1185 #define getnstr(s, n) wgetnstr(stdscr, s, (n))
1187 #define setterm(term) setupterm(term, 1, (int *)0)
1189 #define fixterm() reset_prog_mode()
1190 #define resetterm() reset_shell_mode()
1191 #define saveterm() def_prog_mode()
1192 #define crmode() cbreak()
1193 #define nocrmode() nocbreak()
1196 /* It seems older SYSV curses versions define these */
1198 #define getattrs(win) NCURSES_CAST(int, NCURSES_OK_ADDR(win) ? (win)->_attrs : A_NORMAL)
1199 #define getcurx(win) (NCURSES_OK_ADDR(win) ? (win)->_curx : ERR)
1200 #define getcury(win) (NCURSES_OK_ADDR(win) ? (win)->_cury : ERR)
1201 #define getbegx(win) (NCURSES_OK_ADDR(win) ? (win)->_begx : ERR)
1202 #define getbegy(win) (NCURSES_OK_ADDR(win) ? (win)->_begy : ERR)
1203 #define getmaxx(win) (NCURSES_OK_ADDR(win) ? ((win)->_maxx + 1) : ERR)
1204 #define getmaxy(win) (NCURSES_OK_ADDR(win) ? ((win)->_maxy + 1) : ERR)
1205 #define getparx(win) (NCURSES_OK_ADDR(win) ? (win)->_parx : ERR)
1206 #define getpary(win) (NCURSES_OK_ADDR(win) ? (win)->_pary : ERR)
1207 #endif /* NCURSES_OPAQUE */
1209 #define wstandout(win) (wattrset(win,A_STANDOUT))
1210 #define wstandend(win) (wattrset(win,A_NORMAL))
1212 #define wattron(win,at) wattr_on(win, NCURSES_CAST(attr_t, at), NULL)
1213 #define wattroff(win,at) wattr_off(win, NCURSES_CAST(attr_t, at), NULL)
1216 #if NCURSES_WATTR_MACROS
1217 #if NCURSES_WIDECHAR && @NCURSES_EXT_COLORS@
1218 #define wattrset(win,at) \
1219 (NCURSES_OK_ADDR(win) \
1220 ? ((win)->_color = NCURSES_CAST(int, PAIR_NUMBER(at)), \
1221 (win)->_attrs = NCURSES_CAST(attr_t, at), \
1225 #define wattrset(win,at) \
1226 (NCURSES_OK_ADDR(win) \
1227 ? ((win)->_attrs = NCURSES_CAST(attr_t, at), \
1231 #endif /* NCURSES_WATTR_MACROS */
1232 #endif /* NCURSES_OPAQUE */
1234 #define scroll(win) wscrl(win,1)
1236 #define touchwin(win) wtouchln((win), 0, getmaxy(win), 1)
1237 #define touchline(win, s, c) wtouchln((win), s, c, 1)
1238 #define untouchwin(win) wtouchln((win), 0, getmaxy(win), 0)
1240 #define box(win, v, h) wborder(win, v, v, h, h, 0, 0, 0, 0)
1241 #define border(ls, rs, ts, bs, tl, tr, bl, br) wborder(stdscr, ls, rs, ts, bs, tl, tr, bl, br)
1242 #define hline(ch, n) whline(stdscr, ch, (n))
1243 #define vline(ch, n) wvline(stdscr, ch, (n))
1245 #define winstr(w, s) winnstr(w, s, -1)
1246 #define winchstr(w, s) winchnstr(w, s, -1)
1247 #define winsstr(w, s) winsnstr(w, s, -1)
1250 #define redrawwin(win) wredrawln(win, 0, (NCURSES_OK_ADDR(win) ? (win)->_maxy+1 : -1))
1251 #endif /* NCURSES_OPAQUE */
1253 #define waddstr(win,str) waddnstr(win,str,-1)
1254 #define waddchstr(win,str) waddchnstr(win,str,-1)
1257 * These apply to the first 256 color pairs.
1259 #define COLOR_PAIR(n) (NCURSES_BITS((n), 0) & A_COLOR)
1260 #define PAIR_NUMBER(a) (NCURSES_CAST(int,((NCURSES_CAST(unsigned long,(a)) & A_COLOR) >> NCURSES_ATTR_SHIFT)))
1263 * pseudo functions for standard screen
1266 #define addch(ch) waddch(stdscr,(ch))
1267 #define addchnstr(str,n) waddchnstr(stdscr,(str),(n))
1268 #define addchstr(str) waddchstr(stdscr,(str))
1269 #define addnstr(str,n) waddnstr(stdscr,(str),(n))
1270 #define addstr(str) waddnstr(stdscr,(str),-1)
1271 #define attr_get(ap,cp,o) wattr_get(stdscr,(ap),(cp),(o))
1272 #define attr_off(a,o) wattr_off(stdscr,(a),(o))
1273 #define attr_on(a,o) wattr_on(stdscr,(a),(o))
1274 #define attr_set(a,c,o) wattr_set(stdscr,(a),(c),(o))
1275 #define attroff(at) wattroff(stdscr,(at))
1276 #define attron(at) wattron(stdscr,(at))
1277 #define attrset(at) wattrset(stdscr,(at))
1278 #define bkgd(ch) wbkgd(stdscr,(ch))
1279 #define bkgdset(ch) wbkgdset(stdscr,(ch))
1280 #define chgat(n,a,c,o) wchgat(stdscr,(n),(a),(c),(o))
1281 #define clear() wclear(stdscr)
1282 #define clrtobot() wclrtobot(stdscr)
1283 #define clrtoeol() wclrtoeol(stdscr)
1284 #define color_set(c,o) wcolor_set(stdscr,(c),(o))
1285 #define delch() wdelch(stdscr)
1286 #define deleteln() winsdelln(stdscr,-1)
1287 #define echochar(c) wechochar(stdscr,(c))
1288 #define erase() werase(stdscr)
1289 #define getch() wgetch(stdscr)
1290 #define getstr(str) wgetstr(stdscr,(str))
1291 #define inch() winch(stdscr)
1292 #define inchnstr(s,n) winchnstr(stdscr,(s),(n))
1293 #define inchstr(s) winchstr(stdscr,(s))
1294 #define innstr(s,n) winnstr(stdscr,(s),(n))
1295 #define insch(c) winsch(stdscr,(c))
1296 #define insdelln(n) winsdelln(stdscr,(n))
1297 #define insertln() winsdelln(stdscr,1)
1298 #define insnstr(s,n) winsnstr(stdscr,(s),(n))
1299 #define insstr(s) winsstr(stdscr,(s))
1300 #define instr(s) winstr(stdscr,(s))
1301 #define move(y,x) wmove(stdscr,(y),(x))
1302 #define refresh() wrefresh(stdscr)
1303 #define scrl(n) wscrl(stdscr,(n))
1304 #define setscrreg(t,b) wsetscrreg(stdscr,(t),(b))
1305 #define standend() wstandend(stdscr)
1306 #define standout() wstandout(stdscr)
1307 #define timeout(delay) wtimeout(stdscr,(delay))
1308 #define wdeleteln(win) winsdelln(win,-1)
1309 #define winsertln(win) winsdelln(win,1)
1315 #define mvwaddch(win,y,x,ch) (wmove((win),(y),(x)) == ERR ? ERR : waddch((win),(ch)))
1316 #define mvwaddchnstr(win,y,x,str,n) (wmove((win),(y),(x)) == ERR ? ERR : waddchnstr((win),(str),(n)))
1317 #define mvwaddchstr(win,y,x,str) (wmove((win),(y),(x)) == ERR ? ERR : waddchnstr((win),(str),-1))
1318 #define mvwaddnstr(win,y,x,str,n) (wmove((win),(y),(x)) == ERR ? ERR : waddnstr((win),(str),(n)))
1319 #define mvwaddstr(win,y,x,str) (wmove((win),(y),(x)) == ERR ? ERR : waddnstr((win),(str),-1))
1320 #define mvwchgat(win,y,x,n,a,c,o) (wmove((win),(y),(x)) == ERR ? ERR : wchgat((win),(n),(a),(c),(o)))
1321 #define mvwdelch(win,y,x) (wmove((win),(y),(x)) == ERR ? ERR : wdelch(win))
1322 #define mvwgetch(win,y,x) (wmove((win),(y),(x)) == ERR ? ERR : wgetch(win))
1323 #define mvwgetnstr(win,y,x,str,n) (wmove((win),(y),(x)) == ERR ? ERR : wgetnstr((win),(str),(n)))
1324 #define mvwgetstr(win,y,x,str) (wmove((win),(y),(x)) == ERR ? ERR : wgetstr((win),(str)))
1325 #define mvwhline(win,y,x,c,n) (wmove((win),(y),(x)) == ERR ? ERR : whline((win),(c),(n)))
1326 #define mvwinch(win,y,x) (wmove((win),(y),(x)) == ERR ? NCURSES_CAST(chtype, ERR) : winch(win))
1327 #define mvwinchnstr(win,y,x,s,n) (wmove((win),(y),(x)) == ERR ? ERR : winchnstr((win),(s),(n)))
1328 #define mvwinchstr(win,y,x,s) (wmove((win),(y),(x)) == ERR ? ERR : winchstr((win),(s)))
1329 #define mvwinnstr(win,y,x,s,n) (wmove((win),(y),(x)) == ERR ? ERR : winnstr((win),(s),(n)))
1330 #define mvwinsch(win,y,x,c) (wmove((win),(y),(x)) == ERR ? ERR : winsch((win),(c)))
1331 #define mvwinsnstr(win,y,x,s,n) (wmove((win),(y),(x)) == ERR ? ERR : winsnstr((win),(s),(n)))
1332 #define mvwinsstr(win,y,x,s) (wmove((win),(y),(x)) == ERR ? ERR : winsstr((win),(s)))
1333 #define mvwinstr(win,y,x,s) (wmove((win),(y),(x)) == ERR ? ERR : winstr((win),(s)))
1334 #define mvwvline(win,y,x,c,n) (wmove((win),(y),(x)) == ERR ? ERR : wvline((win),(c),(n)))
1336 #define mvaddch(y,x,ch) mvwaddch(stdscr,(y),(x),(ch))
1337 #define mvaddchnstr(y,x,str,n) mvwaddchnstr(stdscr,(y),(x),(str),(n))
1338 #define mvaddchstr(y,x,str) mvwaddchstr(stdscr,(y),(x),(str))
1339 #define mvaddnstr(y,x,str,n) mvwaddnstr(stdscr,(y),(x),(str),(n))
1340 #define mvaddstr(y,x,str) mvwaddstr(stdscr,(y),(x),(str))
1341 #define mvchgat(y,x,n,a,c,o) mvwchgat(stdscr,(y),(x),(n),(a),(c),(o))
1342 #define mvdelch(y,x) mvwdelch(stdscr,(y),(x))
1343 #define mvgetch(y,x) mvwgetch(stdscr,(y),(x))
1344 #define mvgetnstr(y,x,str,n) mvwgetnstr(stdscr,(y),(x),(str),(n))
1345 #define mvgetstr(y,x,str) mvwgetstr(stdscr,(y),(x),(str))
1346 #define mvhline(y,x,c,n) mvwhline(stdscr,(y),(x),(c),(n))
1347 #define mvinch(y,x) mvwinch(stdscr,(y),(x))
1348 #define mvinchnstr(y,x,s,n) mvwinchnstr(stdscr,(y),(x),(s),(n))
1349 #define mvinchstr(y,x,s) mvwinchstr(stdscr,(y),(x),(s))
1350 #define mvinnstr(y,x,s,n) mvwinnstr(stdscr,(y),(x),(s),(n))
1351 #define mvinsch(y,x,c) mvwinsch(stdscr,(y),(x),(c))
1352 #define mvinsnstr(y,x,s,n) mvwinsnstr(stdscr,(y),(x),(s),(n))
1353 #define mvinsstr(y,x,s) mvwinsstr(stdscr,(y),(x),(s))
1354 #define mvinstr(y,x,s) mvwinstr(stdscr,(y),(x),(s))
1355 #define mvvline(y,x,c,n) mvwvline(stdscr,(y),(x),(c),(n))
1358 * Some wide-character functions can be implemented without the extensions.
1361 #define getbkgd(win) (NCURSES_OK_ADDR(win) ? ((win)->_bkgd) : 0)
1362 #endif /* NCURSES_OPAQUE */
1364 #define slk_attr_off(a,v) ((v) ? ERR : slk_attroff(a))
1365 #define slk_attr_on(a,v) ((v) ? ERR : slk_attron(a))
1368 #if NCURSES_WATTR_MACROS
1369 #if NCURSES_WIDECHAR && @NCURSES_EXT_COLORS@
1370 #define wattr_set(win,a,p,opts) \
1371 (NCURSES_OK_ADDR(win) \
1372 ? ((void)((win)->_attrs = ((a) & ~A_COLOR), \
1373 (win)->_color = (opts) ? *(int *)(opts) : (p)), \
1376 #define wattr_get(win,a,p,opts) \
1377 (NCURSES_OK_ADDR(win) \
1378 ? ((void)(NCURSES_OK_ADDR(a) \
1379 ? (*(a) = (win)->_attrs) \
1381 (void)(NCURSES_OK_ADDR(p) \
1382 ? (*(p) = (NCURSES_PAIRS_T) (win)->_color) \
1384 (void)(NCURSES_OK_ADDR(opts) \
1385 ? (*(int *)(opts) = (win)->_color) \
1389 #else /* !(NCURSES_WIDECHAR && NCURSES_EXE_COLORS) */
1390 #define wattr_set(win,a,p,opts) \
1391 (NCURSES_OK_ADDR(win) \
1392 ? ((void)((win)->_attrs = (((a) & ~A_COLOR) | \
1393 (attr_t)COLOR_PAIR(p))), \
1396 #define wattr_get(win,a,p,opts) \
1397 (NCURSES_OK_ADDR(win) \
1398 ? ((void)(NCURSES_OK_ADDR(a) \
1399 ? (*(a) = (win)->_attrs) \
1401 (void)(NCURSES_OK_ADDR(p) \
1402 ? (*(p) = (NCURSES_PAIRS_T) PAIR_NUMBER((win)->_attrs)) \
1406 #endif /* (NCURSES_WIDECHAR && NCURSES_EXE_COLORS) */
1407 #endif /* NCURSES_WATTR_MACROS */
1408 #endif /* NCURSES_OPAQUE */
1411 * X/Open curses deprecates SVr4 vwprintw/vwscanw, which are supposed to use
1412 * varargs.h. It adds new calls vw_printw/vw_scanw, which are supposed to
1413 * use POSIX stdarg.h. The ncurses versions of vwprintw/vwscanw already
1414 * use stdarg.h, so...
1416 /* define vw_printw vwprintw */
1417 /* define vw_scanw vwscanw */
1420 * Export fallback function for use in C++ binding.
1423 #define vsscanf(a,b,c) _nc_vsscanf(a,b,c)
1424 NCURSES_EXPORT(int) vsscanf(const char *, const char *, va_list);
1428 * These macros are extensions - not in X/Open Curses.
1430 #if @NCURSES_EXT_FUNCS@
1432 #define is_cleared(win) (NCURSES_OK_ADDR(win) ? (win)->_clear : FALSE)
1433 #define is_idcok(win) (NCURSES_OK_ADDR(win) ? (win)->_idcok : FALSE)
1434 #define is_idlok(win) (NCURSES_OK_ADDR(win) ? (win)->_idlok : FALSE)
1435 #define is_immedok(win) (NCURSES_OK_ADDR(win) ? (win)->_immed : FALSE)
1436 #define is_keypad(win) (NCURSES_OK_ADDR(win) ? (win)->_use_keypad : FALSE)
1437 #define is_leaveok(win) (NCURSES_OK_ADDR(win) ? (win)->_leaveok : FALSE)
1438 #define is_nodelay(win) (NCURSES_OK_ADDR(win) ? ((win)->_delay == 0) : FALSE)
1439 #define is_notimeout(win) (NCURSES_OK_ADDR(win) ? (win)->_notimeout : FALSE)
1440 #define is_pad(win) (NCURSES_OK_ADDR(win) ? ((win)->_flags & _ISPAD) != 0 : FALSE)
1441 #define is_scrollok(win) (NCURSES_OK_ADDR(win) ? (win)->_scroll : FALSE)
1442 #define is_subwin(win) (NCURSES_OK_ADDR(win) ? ((win)->_flags & _SUBWIN) != 0 : FALSE)
1443 #define is_syncok(win) (NCURSES_OK_ADDR(win) ? (win)->_sync : FALSE)
1444 #define wgetdelay(win) (NCURSES_OK_ADDR(win) ? (win)->_delay : 0)
1445 #define wgetparent(win) (NCURSES_OK_ADDR(win) ? (win)->_parent : 0)
1446 #define wgetscrreg(win,t,b) (NCURSES_OK_ADDR(win) ? (*(t) = (win)->_regtop, *(b) = (win)->_regbottom, OK) : ERR)
1451 * X/Open says this returns a bool; SVr4 also checked for out-of-range line.
1452 * The macro provides compatibility:
1454 #define is_linetouched(w,l) ((!(w) || ((l) > getmaxy(w)) || ((l) < 0)) ? ERR : (is_linetouched)((w),(l)))
1456 #endif /* NCURSES_NOMACROS */
1462 * a. ESCDELAY was an undocumented feature under AIX curses.
1463 * It gives the ESC expire time in milliseconds.
1464 * b. ttytype is needed for backward compatibility
1466 #if NCURSES_REENTRANT
1468 NCURSES_WRAPPED_VAR(WINDOW *, curscr);
1469 NCURSES_WRAPPED_VAR(WINDOW *, newscr);
1470 NCURSES_WRAPPED_VAR(WINDOW *, stdscr);
1471 NCURSES_WRAPPED_VAR(char *, ttytype);
1472 NCURSES_WRAPPED_VAR(int, COLORS);
1473 NCURSES_WRAPPED_VAR(int, COLOR_PAIRS);
1474 NCURSES_WRAPPED_VAR(int, COLS);
1475 NCURSES_WRAPPED_VAR(int, ESCDELAY);
1476 NCURSES_WRAPPED_VAR(int, LINES);
1477 NCURSES_WRAPPED_VAR(int, TABSIZE);
1479 #define curscr NCURSES_PUBLIC_VAR(curscr())
1480 #define newscr NCURSES_PUBLIC_VAR(newscr())
1481 #define stdscr NCURSES_PUBLIC_VAR(stdscr())
1482 #define ttytype NCURSES_PUBLIC_VAR(ttytype())
1483 #define COLORS NCURSES_PUBLIC_VAR(COLORS())
1484 #define COLOR_PAIRS NCURSES_PUBLIC_VAR(COLOR_PAIRS())
1485 #define COLS NCURSES_PUBLIC_VAR(COLS())
1486 #define ESCDELAY NCURSES_PUBLIC_VAR(ESCDELAY())
1487 #define LINES NCURSES_PUBLIC_VAR(LINES())
1488 #define TABSIZE NCURSES_PUBLIC_VAR(TABSIZE())
1492 extern NCURSES_EXPORT_VAR(WINDOW *) curscr;
1493 extern NCURSES_EXPORT_VAR(WINDOW *) newscr;
1494 extern NCURSES_EXPORT_VAR(WINDOW *) stdscr;
1495 extern NCURSES_EXPORT_VAR(char) ttytype[];
1496 extern NCURSES_EXPORT_VAR(int) COLORS;
1497 extern NCURSES_EXPORT_VAR(int) COLOR_PAIRS;
1498 extern NCURSES_EXPORT_VAR(int) COLS;
1499 extern NCURSES_EXPORT_VAR(int) ESCDELAY;
1500 extern NCURSES_EXPORT_VAR(int) LINES;
1501 extern NCURSES_EXPORT_VAR(int) TABSIZE;
1506 * Pseudo-character tokens outside ASCII range. The curses wgetch() function
1507 * will return any given one of these only if the corresponding k- capability
1508 * is defined in your terminal's terminfo entry.
1510 * Some keys (KEY_A1, etc) are arranged like this:
1515 * A few key codes do not depend upon the terminfo entry.
1517 #define KEY_CODE_YES 0400 /* A wchar_t contains a key code */
1518 #define KEY_MIN 0401 /* Minimum curses key */
1519 #define KEY_BREAK 0401 /* Break key (unreliable) */
1520 #define KEY_SRESET 0530 /* Soft (partial) reset (unreliable) */
1521 #define KEY_RESET 0531 /* Reset or hard reset (unreliable) */