]> ncurses.scripts.mit.edu Git - ncurses.git/blob - include/curses.h.in
ncurses 6.0 - patch 20151219
[ncurses.git] / include / curses.h.in
1 /****************************************************************************
2  * Copyright (c) 1998-2014,2015 Free Software Foundation, Inc.              *
3  *                                                                          *
4  * Permission is hereby granted, free of charge, to any person obtaining a  *
5  * copy of this software and associated documentation files (the            *
6  * "Software"), to deal in the Software without restriction, including      *
7  * without limitation the rights to use, copy, modify, merge, publish,      *
8  * distribute, distribute with modifications, sublicense, and/or sell       *
9  * copies of the Software, and to permit persons to whom the Software is    *
10  * furnished to do so, subject to the following conditions:                 *
11  *                                                                          *
12  * The above copyright notice and this permission notice shall be included  *
13  * in all copies or substantial portions of the Software.                   *
14  *                                                                          *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22  *                                                                          *
23  * Except as contained in this notice, the name(s) of the above copyright   *
24  * holders shall not be used in advertising or otherwise to promote the     *
25  * sale, use or other dealings in this Software without prior written       *
26  * authorization.                                                           *
27  ****************************************************************************/
28
29 /****************************************************************************
30  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
31  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
32  *     and: Thomas E. Dickey                        1996-on                 *
33  ****************************************************************************/
34
35 /* $Id: curses.h.in,v 1.242 2015/12/19 23:08:31 tom Exp $ */
36
37 #ifndef __NCURSES_H
38 #define __NCURSES_H
39
40 #define CURSES 1
41 #define CURSES_H 1
42
43 /* These are defined only in curses.h, and are used for conditional compiles */
44 #define NCURSES_VERSION_MAJOR @NCURSES_MAJOR@
45 #define NCURSES_VERSION_MINOR @NCURSES_MINOR@
46 #define NCURSES_VERSION_PATCH @NCURSES_PATCH@
47
48 /* This is defined in more than one ncurses header, for identification */
49 #undef  NCURSES_VERSION
50 #define NCURSES_VERSION "@NCURSES_MAJOR@.@NCURSES_MINOR@"
51
52 /*
53  * Identify the mouse encoding version.
54  */
55 #define NCURSES_MOUSE_VERSION @NCURSES_MOUSE_VERSION@
56
57 /*
58  * Definitions to facilitate DLL's.
59  */
60 #include <ncurses_dll.h>
61
62 #if @HAVE_STDINT_H@
63 #include <stdint.h>
64 #endif
65
66 /*
67  * User-definable tweak to disable the include of <stdbool.h>.
68  */
69 #ifndef NCURSES_ENABLE_STDBOOL_H
70 #define NCURSES_ENABLE_STDBOOL_H @cf_cv_header_stdbool_h@
71 #endif
72
73 /*
74  * NCURSES_ATTR_T is used to quiet compiler warnings when building ncurses
75  * configured using --disable-macros.
76  */
77 #ifndef NCURSES_ATTR_T
78 #define NCURSES_ATTR_T int
79 #endif
80
81 /*
82  * Expands to 'const' if ncurses is configured using --enable-const.  Note that
83  * doing so makes it incompatible with other implementations of X/Open Curses.
84  */
85 #undef  NCURSES_CONST
86 #define NCURSES_CONST @NCURSES_CONST@
87
88 #undef NCURSES_INLINE
89 #define NCURSES_INLINE @NCURSES_INLINE@
90
91 /*
92  * The internal type used for color values, and for color-pairs.  The latter
93  * allows the curses library to enumerate the combinations of foreground and
94  * background colors used by an application, and is normally the product of the
95  * total foreground and background colors.
96  *
97  * X/Open uses "short" for both of these types, ultimately because they are
98  * numbers from the terminal database, which uses 16-bit signed values.
99  */
100 #undef  NCURSES_COLOR_T
101 #define NCURSES_COLOR_T short
102
103 #undef  NCURSES_PAIRS_T
104 #define NCURSES_PAIRS_T short
105
106 /*
107  * Definition used to make WINDOW and similar structs opaque.
108  */
109 #ifndef @cf_cv_enable_opaque@
110 #define NCURSES_OPAQUE @NCURSES_OPAQUE@
111 #endif
112
113 /*
114  * The reentrant code relies on the opaque setting, but adds features.
115  */
116 #ifndef NCURSES_REENTRANT
117 #define NCURSES_REENTRANT @cf_cv_enable_reentrant@
118 #endif
119
120 /*
121  * Control whether bindings for interop support are added.
122  */
123 #undef  NCURSES_INTEROP_FUNCS
124 #define NCURSES_INTEROP_FUNCS @NCURSES_INTEROP_FUNCS@
125
126 /*
127  * The internal type used for window dimensions.
128  */
129 #undef  NCURSES_SIZE_T
130 #define NCURSES_SIZE_T @NCURSES_SIZE_T@
131
132 /*
133  * Control whether tparm() supports varargs or fixed-parameter list.
134  */
135 #undef NCURSES_TPARM_VARARGS
136 #define NCURSES_TPARM_VARARGS @NCURSES_TPARM_VARARGS@
137
138 /*
139  * Control type used for tparm's arguments.  While X/Open equates long and
140  * char* values, this is not always workable for 64-bit platforms.
141  */
142 #undef NCURSES_TPARM_ARG
143 #define NCURSES_TPARM_ARG @NCURSES_TPARM_ARG@
144
145 /*
146  * Control whether ncurses uses wcwidth() for checking width of line-drawing
147  * characters.
148  */
149 #undef NCURSES_WCWIDTH_GRAPHICS
150 #define NCURSES_WCWIDTH_GRAPHICS @NCURSES_WCWIDTH_GRAPHICS@
151
152 /*
153  * NCURSES_CH_T is used in building the library, but not used otherwise in
154  * this header file, since that would make the normal/wide-character versions
155  * of the header incompatible.
156  */
157 #undef  NCURSES_CH_T
158 #define NCURSES_CH_T @NCURSES_CH_T@
159
160 #if @cf_cv_enable_lp64@ && defined(_LP64)
161 typedef unsigned chtype;
162 typedef unsigned mmask_t;
163 #else
164 typedef @cf_cv_typeof_chtype@ chtype;
165 typedef @cf_cv_typeof_mmask_t@ mmask_t;
166 #endif
167
168 /*
169  * We need FILE, etc.  Include this before checking any feature symbols.
170  */
171 #include <stdio.h>
172
173 /*
174  * With XPG4, you must define _XOPEN_SOURCE_EXTENDED, it is redundant (or
175  * conflicting) when _XOPEN_SOURCE is 500 or greater.  If NCURSES_WIDECHAR is
176  * not already defined, e.g., if the platform relies upon nonstandard feature
177  * test macros, define it at this point if the standard feature test macros
178  * indicate that it should be defined.
179  */
180 #ifndef NCURSES_WIDECHAR
181 #if defined(_XOPEN_SOURCE_EXTENDED) || (defined(_XOPEN_SOURCE) && (_XOPEN_SOURCE - 0 >= 500))
182 #define NCURSES_WIDECHAR 1
183 #else
184 #define NCURSES_WIDECHAR 0
185 #endif
186 #endif /* NCURSES_WIDECHAR */
187
188 #include <stdarg.h>     /* we need va_list */
189 #if NCURSES_WIDECHAR
190 #include <stddef.h>     /* we want wchar_t */
191 #endif
192
193 /* X/Open and SVr4 specify that curses implements 'bool'.  However, C++ may also
194  * implement it.  If so, we must use the C++ compiler's type to avoid conflict
195  * with other interfaces.
196  *
197  * A further complication is that <stdbool.h> may declare 'bool' to be a
198  * different type, such as an enum which is not necessarily compatible with
199  * C++.  If we have <stdbool.h>, make 'bool' a macro, so users may #undef it.
200  * Otherwise, let it remain a typedef to avoid conflicts with other #define's.
201  * In either case, make a typedef for NCURSES_BOOL which can be used if needed
202  * from either C or C++.
203  */
204
205 #undef TRUE
206 #define TRUE    1
207
208 #undef FALSE
209 #define FALSE   0
210
211 typedef @cf_cv_type_of_bool@ NCURSES_BOOL;
212
213 #if @USE_CXX_BOOL@      /* __cplusplus, etc. */
214
215 /* use the C++ compiler's bool type */
216 #define NCURSES_BOOL bool
217
218 #else                   /* c89, c99, etc. */
219
220 #if NCURSES_ENABLE_STDBOOL_H
221 #include <stdbool.h>
222 /* use whatever the C compiler decides bool really is */
223 #define NCURSES_BOOL bool
224 #else
225 /* there is no predefined bool - use our own */
226 #undef bool
227 #define bool NCURSES_BOOL
228 #endif
229
230 #endif /* !__cplusplus, etc. */
231
232 #ifdef __cplusplus
233 extern "C" {
234 #define NCURSES_CAST(type,value) static_cast<type>(value)
235 #else
236 #define NCURSES_CAST(type,value) (type)(value)
237 #endif
238
239 /*
240  * X/Open attributes.  In the ncurses implementation, they are identical to the
241  * A_ attributes.
242  */
243 #define WA_ATTRIBUTES   A_ATTRIBUTES
244 #define WA_NORMAL       A_NORMAL
245 #define WA_STANDOUT     A_STANDOUT
246 #define WA_UNDERLINE    A_UNDERLINE
247 #define WA_REVERSE      A_REVERSE
248 #define WA_BLINK        A_BLINK
249 #define WA_DIM          A_DIM
250 #define WA_BOLD         A_BOLD
251 #define WA_ALTCHARSET   A_ALTCHARSET
252 #define WA_INVIS        A_INVIS
253 #define WA_PROTECT      A_PROTECT
254 #define WA_HORIZONTAL   A_HORIZONTAL
255 #define WA_LEFT         A_LEFT
256 #define WA_LOW          A_LOW
257 #define WA_RIGHT        A_RIGHT
258 #define WA_TOP          A_TOP
259 #define WA_VERTICAL     A_VERTICAL
260
261 #if @NCURSES_EXT_FUNCS@
262 #define WA_ITALIC       A_ITALIC        /* ncurses extension */
263 #endif
264
265 /* colors */
266 #define COLOR_BLACK     0
267 #define COLOR_RED       1
268 #define COLOR_GREEN     2
269 #define COLOR_YELLOW    3
270 #define COLOR_BLUE      4
271 #define COLOR_MAGENTA   5
272 #define COLOR_CYAN      6
273 #define COLOR_WHITE     7
274
275 /* line graphics */
276
277 #if @BROKEN_LINKER@ || NCURSES_REENTRANT
278 NCURSES_WRAPPED_VAR(chtype*, acs_map);
279 #define acs_map NCURSES_PUBLIC_VAR(acs_map())
280 #else
281 extern NCURSES_EXPORT_VAR(chtype) acs_map[];
282 #endif
283
284 #define NCURSES_ACS(c)  (acs_map[NCURSES_CAST(unsigned char,(c))])
285
286 /* VT100 symbols begin here */
287 #define ACS_ULCORNER    NCURSES_ACS('l') /* upper left corner */
288 #define ACS_LLCORNER    NCURSES_ACS('m') /* lower left corner */
289 #define ACS_URCORNER    NCURSES_ACS('k') /* upper right corner */
290 #define ACS_LRCORNER    NCURSES_ACS('j') /* lower right corner */
291 #define ACS_LTEE        NCURSES_ACS('t') /* tee pointing right */
292 #define ACS_RTEE        NCURSES_ACS('u') /* tee pointing left */
293 #define ACS_BTEE        NCURSES_ACS('v') /* tee pointing up */
294 #define ACS_TTEE        NCURSES_ACS('w') /* tee pointing down */
295 #define ACS_HLINE       NCURSES_ACS('q') /* horizontal line */
296 #define ACS_VLINE       NCURSES_ACS('x') /* vertical line */
297 #define ACS_PLUS        NCURSES_ACS('n') /* large plus or crossover */
298 #define ACS_S1          NCURSES_ACS('o') /* scan line 1 */
299 #define ACS_S9          NCURSES_ACS('s') /* scan line 9 */
300 #define ACS_DIAMOND     NCURSES_ACS('`') /* diamond */
301 #define ACS_CKBOARD     NCURSES_ACS('a') /* checker board (stipple) */
302 #define ACS_DEGREE      NCURSES_ACS('f') /* degree symbol */
303 #define ACS_PLMINUS     NCURSES_ACS('g') /* plus/minus */
304 #define ACS_BULLET      NCURSES_ACS('~') /* bullet */
305 /* Teletype 5410v1 symbols begin here */
306 #define ACS_LARROW      NCURSES_ACS(',') /* arrow pointing left */
307 #define ACS_RARROW      NCURSES_ACS('+') /* arrow pointing right */
308 #define ACS_DARROW      NCURSES_ACS('.') /* arrow pointing down */
309 #define ACS_UARROW      NCURSES_ACS('-') /* arrow pointing up */
310 #define ACS_BOARD       NCURSES_ACS('h') /* board of squares */
311 #define ACS_LANTERN     NCURSES_ACS('i') /* lantern symbol */
312 #define ACS_BLOCK       NCURSES_ACS('0') /* solid square block */
313 /*
314  * These aren't documented, but a lot of System Vs have them anyway
315  * (you can spot pprryyzz{{||}} in a lot of AT&T terminfo strings).
316  * The ACS_names may not match AT&T's, our source didn't know them.
317  */
318 #define ACS_S3          NCURSES_ACS('p') /* scan line 3 */
319 #define ACS_S7          NCURSES_ACS('r') /* scan line 7 */
320 #define ACS_LEQUAL      NCURSES_ACS('y') /* less/equal */
321 #define ACS_GEQUAL      NCURSES_ACS('z') /* greater/equal */
322 #define ACS_PI          NCURSES_ACS('{') /* Pi */
323 #define ACS_NEQUAL      NCURSES_ACS('|') /* not equal */
324 #define ACS_STERLING    NCURSES_ACS('}') /* UK pound sign */
325
326 /*
327  * Line drawing ACS names are of the form ACS_trbl, where t is the top, r
328  * is the right, b is the bottom, and l is the left.  t, r, b, and l might
329  * be B (blank), S (single), D (double), or T (thick).  The subset defined
330  * here only uses B and S.
331  */
332 #define ACS_BSSB        ACS_ULCORNER
333 #define ACS_SSBB        ACS_LLCORNER
334 #define ACS_BBSS        ACS_URCORNER
335 #define ACS_SBBS        ACS_LRCORNER
336 #define ACS_SBSS        ACS_RTEE
337 #define ACS_SSSB        ACS_LTEE
338 #define ACS_SSBS        ACS_BTEE
339 #define ACS_BSSS        ACS_TTEE
340 #define ACS_BSBS        ACS_HLINE
341 #define ACS_SBSB        ACS_VLINE
342 #define ACS_SSSS        ACS_PLUS
343
344 #undef  ERR
345 #define ERR     (-1)
346
347 #undef  OK
348 #define OK      (0)
349
350 /* values for the _flags member */
351 #define _SUBWIN         0x01    /* is this a sub-window? */
352 #define _ENDLINE        0x02    /* is the window flush right? */
353 #define _FULLWIN        0x04    /* is the window full-screen? */
354 #define _SCROLLWIN      0x08    /* bottom edge is at screen bottom? */
355 #define _ISPAD          0x10    /* is this window a pad? */
356 #define _HASMOVED       0x20    /* has cursor moved since last refresh? */
357 #define _WRAPPED        0x40    /* cursor was just wrappped */
358
359 /*
360  * this value is used in the firstchar and lastchar fields to mark
361  * unchanged lines
362  */
363 #define _NOCHANGE       -1
364
365 /*
366  * this value is used in the oldindex field to mark lines created by insertions
367  * and scrolls.
368  */
369 #define _NEWINDEX       -1
370
371 typedef struct screen  SCREEN;
372 typedef struct _win_st WINDOW;
373
374 typedef chtype  attr_t;         /* ...must be at least as wide as chtype */
375
376 #if NCURSES_WIDECHAR
377
378 #if @NCURSES_LIBUTF8@
379 #ifdef mblen                    /* libutf8.h defines it w/o undefining first */
380 #undef mblen
381 #endif
382 #include <libutf8.h>
383 #endif
384
385 #if @NEED_WCHAR_H@
386 #include <wchar.h>              /* ...to get mbstate_t, etc. */
387 #endif
388
389 #if @NCURSES_WCHAR_T@
390 typedef unsigned short wchar_t@NCURSES_OK_WCHAR_T@;
391 #endif
392
393 #if @NCURSES_WINT_T@
394 typedef unsigned int wint_t@NCURSES_OK_WCHAR_T@;
395 #endif
396
397 /*
398  * cchar_t stores an array of CCHARW_MAX wide characters.  The first is
399  * normally a spacing character.  The others are non-spacing.  If those
400  * (spacing and nonspacing) do not fill the array, a null L'\0' follows.
401  * Otherwise, a null is assumed to follow when extracting via getcchar().
402  */
403 #define CCHARW_MAX      @NCURSES_CCHARW_MAX@
404 typedef struct
405 {
406     attr_t      attr;
407     wchar_t     chars[CCHARW_MAX];
408 #if @NCURSES_EXT_COLORS@
409 #undef NCURSES_EXT_COLORS
410 #define NCURSES_EXT_COLORS @NCURSES_PATCH@
411     int         ext_color;      /* color pair, must be more than 16-bits */
412 #endif
413 }
414 cchar_t;
415
416 #endif /* NCURSES_WIDECHAR */
417
418 #if !NCURSES_OPAQUE
419 struct ldat;
420
421 struct _win_st
422 {
423         NCURSES_SIZE_T _cury, _curx; /* current cursor position */
424
425         /* window location and size */
426         NCURSES_SIZE_T _maxy, _maxx; /* maximums of x and y, NOT window size */
427         NCURSES_SIZE_T _begy, _begx; /* screen coords of upper-left-hand corner */
428
429         short   _flags;         /* window state flags */
430
431         /* attribute tracking */
432         attr_t  _attrs;         /* current attribute for non-space character */
433         chtype  _bkgd;          /* current background char/attribute pair */
434
435         /* option values set by user */
436         bool    _notimeout;     /* no time out on function-key entry? */
437         bool    _clear;         /* consider all data in the window invalid? */
438         bool    _leaveok;       /* OK to not reset cursor on exit? */
439         bool    _scroll;        /* OK to scroll this window? */
440         bool    _idlok;         /* OK to use insert/delete line? */
441         bool    _idcok;         /* OK to use insert/delete char? */
442         bool    _immed;         /* window in immed mode? (not yet used) */
443         bool    _sync;          /* window in sync mode? */
444         bool    _use_keypad;    /* process function keys into KEY_ symbols? */
445         int     _delay;         /* 0 = nodelay, <0 = blocking, >0 = delay */
446
447         struct ldat *_line;     /* the actual line data */
448
449         /* global screen state */
450         NCURSES_SIZE_T _regtop; /* top line of scrolling region */
451         NCURSES_SIZE_T _regbottom; /* bottom line of scrolling region */
452
453         /* these are used only if this is a sub-window */
454         int     _parx;          /* x coordinate of this window in parent */
455         int     _pary;          /* y coordinate of this window in parent */
456         WINDOW  *_parent;       /* pointer to parent if a sub-window */
457
458         /* these are used only if this is a pad */
459         struct pdat
460         {
461             NCURSES_SIZE_T _pad_y,      _pad_x;
462             NCURSES_SIZE_T _pad_top,    _pad_left;
463             NCURSES_SIZE_T _pad_bottom, _pad_right;
464         } _pad;
465
466         NCURSES_SIZE_T _yoffset; /* real begy is _begy + _yoffset */
467
468 #if NCURSES_WIDECHAR
469         cchar_t  _bkgrnd;       /* current background char/attribute pair */
470 #if @NCURSES_EXT_COLORS@
471         int     _color;         /* current color-pair for non-space character */
472 #endif
473 #endif
474 };
475 #endif /* NCURSES_OPAQUE */
476
477 /*
478  * This is an extension to support events...
479  */
480 #if @NCURSES_EXT_FUNCS@
481 #ifdef NCURSES_WGETCH_EVENTS
482 #if !defined(__BEOS__) || defined(__HAIKU__)
483    /* Fix _nc_timed_wait() on BEOS... */
484 #  define NCURSES_EVENT_VERSION 1
485 #endif  /* !defined(__BEOS__) */
486
487 /*
488  * Bits to set in _nc_event.data.flags
489  */
490 #  define _NC_EVENT_TIMEOUT_MSEC        1
491 #  define _NC_EVENT_FILE                2
492 #  define _NC_EVENT_FILE_READABLE       2
493 #  if 0                                 /* Not supported yet... */
494 #    define _NC_EVENT_FILE_WRITABLE     4
495 #    define _NC_EVENT_FILE_EXCEPTION    8
496 #  endif
497
498 typedef struct
499 {
500     int type;
501     union
502     {
503         long timeout_msec;      /* _NC_EVENT_TIMEOUT_MSEC */
504         struct
505         {
506             unsigned int flags;
507             int fd;
508             unsigned int result;
509         } fev;                          /* _NC_EVENT_FILE */
510     } data;
511 } _nc_event;
512
513 typedef struct
514 {
515     int count;
516     int result_flags;   /* _NC_EVENT_TIMEOUT_MSEC or _NC_EVENT_FILE_READABLE */
517     _nc_event *events[1];
518 } _nc_eventlist;
519
520 extern NCURSES_EXPORT(int) wgetch_events (WINDOW *, _nc_eventlist *);   /* experimental */
521 extern NCURSES_EXPORT(int) wgetnstr_events (WINDOW *,char *,int,_nc_eventlist *);/* experimental */
522
523 #endif /* NCURSES_WGETCH_EVENTS */
524 #endif /* NCURSES_EXT_FUNCS */
525
526 /*
527  * GCC (and some other compilers) define '__attribute__'; we're using this
528  * macro to alert the compiler to flag inconsistencies in printf/scanf-like
529  * function calls.  Just in case '__attribute__' isn't defined, make a dummy.
530  * Old versions of G++ do not accept it anyway, at least not consistently with
531  * GCC.
532  */
533 #if !(defined(__GNUC__) || defined(__GNUG__) || defined(__attribute__))
534 #define __attribute__(p) /* nothing */
535 #endif
536
537 /*
538  * We cannot define these in ncurses_cfg.h, since they require parameters to be
539  * passed (that is non-portable).  If you happen to be using gcc with warnings
540  * enabled, define
541  *      GCC_PRINTF
542  *      GCC_SCANF
543  * to improve checking of calls to printw(), etc.
544  */
545 #ifndef GCC_PRINTFLIKE
546 #if defined(GCC_PRINTF) && !defined(printf)
547 #define GCC_PRINTFLIKE(fmt,var) __attribute__((format(printf,fmt,var)))
548 #else
549 #define GCC_PRINTFLIKE(fmt,var) /*nothing*/
550 #endif
551 #endif
552
553 #ifndef GCC_SCANFLIKE
554 #if defined(GCC_SCANF) && !defined(scanf)
555 #define GCC_SCANFLIKE(fmt,var)  __attribute__((format(scanf,fmt,var)))
556 #else
557 #define GCC_SCANFLIKE(fmt,var)  /*nothing*/
558 #endif
559 #endif
560
561 #ifndef GCC_NORETURN
562 #define GCC_NORETURN /* nothing */
563 #endif
564
565 #ifndef GCC_UNUSED
566 #define GCC_UNUSED /* nothing */
567 #endif
568
569 /*
570  * Curses uses a helper function.  Define our type for this to simplify
571  * extending it for the sp-funcs feature.
572  */
573 typedef int (*NCURSES_OUTC)(int);
574
575 /*
576  * Function prototypes.  This is the complete X/Open Curses list of required
577  * functions.  Those marked `generated' will have sources generated from the
578  * macro definitions later in this file, in order to satisfy XPG4.2
579  * requirements.
580  */
581
582 extern NCURSES_EXPORT(int) addch (const chtype);                        /* generated */
583 extern NCURSES_EXPORT(int) addchnstr (const chtype *, int);             /* generated */
584 extern NCURSES_EXPORT(int) addchstr (const chtype *);                   /* generated */
585 extern NCURSES_EXPORT(int) addnstr (const char *, int);                 /* generated */
586 extern NCURSES_EXPORT(int) addstr (const char *);                       /* generated */
587 extern NCURSES_EXPORT(int) attroff (NCURSES_ATTR_T);                    /* generated */
588 extern NCURSES_EXPORT(int) attron (NCURSES_ATTR_T);                     /* generated */
589 extern NCURSES_EXPORT(int) attrset (NCURSES_ATTR_T);                    /* generated */
590 extern NCURSES_EXPORT(int) attr_get (attr_t *, NCURSES_PAIRS_T *, void *);      /* generated */
591 extern NCURSES_EXPORT(int) attr_off (attr_t, void *);                   /* generated */
592 extern NCURSES_EXPORT(int) attr_on (attr_t, void *);                    /* generated */
593 extern NCURSES_EXPORT(int) attr_set (attr_t, NCURSES_PAIRS_T, void *);          /* generated */
594 extern NCURSES_EXPORT(int) baudrate (void);                             /* implemented */
595 extern NCURSES_EXPORT(int) beep  (void);                                /* implemented */
596 extern NCURSES_EXPORT(int) bkgd (chtype);                               /* generated */
597 extern NCURSES_EXPORT(void) bkgdset (chtype);                           /* generated */
598 extern NCURSES_EXPORT(int) border (chtype,chtype,chtype,chtype,chtype,chtype,chtype,chtype);    /* generated */
599 extern NCURSES_EXPORT(int) box (WINDOW *, chtype, chtype);              /* generated */
600 extern NCURSES_EXPORT(bool) can_change_color (void);                    /* implemented */
601 extern NCURSES_EXPORT(int) cbreak (void);                               /* implemented */
602 extern NCURSES_EXPORT(int) chgat (int, attr_t, NCURSES_PAIRS_T, const void *);  /* generated */
603 extern NCURSES_EXPORT(int) clear (void);                                /* generated */
604 extern NCURSES_EXPORT(int) clearok (WINDOW *,bool);                     /* implemented */
605 extern NCURSES_EXPORT(int) clrtobot (void);                             /* generated */
606 extern NCURSES_EXPORT(int) clrtoeol (void);                             /* generated */
607 extern NCURSES_EXPORT(int) color_content (NCURSES_COLOR_T,NCURSES_COLOR_T*,NCURSES_COLOR_T*,NCURSES_COLOR_T*);  /* implemented */
608 extern NCURSES_EXPORT(int) color_set (NCURSES_PAIRS_T,void*);                   /* generated */
609 extern NCURSES_EXPORT(int) COLOR_PAIR (int);                            /* generated */
610 extern NCURSES_EXPORT(int) copywin (const WINDOW*,WINDOW*,int,int,int,int,int,int,int); /* implemented */
611 extern NCURSES_EXPORT(int) curs_set (int);                              /* implemented */
612 extern NCURSES_EXPORT(int) def_prog_mode (void);                        /* implemented */
613 extern NCURSES_EXPORT(int) def_shell_mode (void);                       /* implemented */
614 extern NCURSES_EXPORT(int) delay_output (int);                          /* implemented */
615 extern NCURSES_EXPORT(int) delch (void);                                /* generated */
616 extern NCURSES_EXPORT(void) delscreen (SCREEN *);                       /* implemented */
617 extern NCURSES_EXPORT(int) delwin (WINDOW *);                           /* implemented */
618 extern NCURSES_EXPORT(int) deleteln (void);                             /* generated */
619 extern NCURSES_EXPORT(WINDOW *) derwin (WINDOW *,int,int,int,int);      /* implemented */
620 extern NCURSES_EXPORT(int) doupdate (void);                             /* implemented */
621 extern NCURSES_EXPORT(WINDOW *) dupwin (WINDOW *);                      /* implemented */
622 extern NCURSES_EXPORT(int) echo (void);                                 /* implemented */
623 extern NCURSES_EXPORT(int) echochar (const chtype);                     /* generated */
624 extern NCURSES_EXPORT(int) erase (void);                                /* generated */
625 extern NCURSES_EXPORT(int) endwin (void);                               /* implemented */
626 extern NCURSES_EXPORT(char) erasechar (void);                           /* implemented */
627 extern NCURSES_EXPORT(void) filter (void);                              /* implemented */
628 extern NCURSES_EXPORT(int) flash (void);                                /* implemented */
629 extern NCURSES_EXPORT(int) flushinp (void);                             /* implemented */
630 extern NCURSES_EXPORT(chtype) getbkgd (WINDOW *);                       /* generated */
631 extern NCURSES_EXPORT(int) getch (void);                                /* generated */
632 extern NCURSES_EXPORT(int) getnstr (char *, int);                       /* generated */
633 extern NCURSES_EXPORT(int) getstr (char *);                             /* generated */
634 extern NCURSES_EXPORT(WINDOW *) getwin (FILE *);                        /* implemented */
635 extern NCURSES_EXPORT(int) halfdelay (int);                             /* implemented */
636 extern NCURSES_EXPORT(bool) has_colors (void);                          /* implemented */
637 extern NCURSES_EXPORT(bool) has_ic (void);                              /* implemented */
638 extern NCURSES_EXPORT(bool) has_il (void);                              /* implemented */
639 extern NCURSES_EXPORT(int) hline (chtype, int);                         /* generated */
640 extern NCURSES_EXPORT(void) idcok (WINDOW *, bool);                     /* implemented */
641 extern NCURSES_EXPORT(int) idlok (WINDOW *, bool);                      /* implemented */
642 extern NCURSES_EXPORT(void) immedok (WINDOW *, bool);                   /* implemented */
643 extern NCURSES_EXPORT(chtype) inch (void);                              /* generated */
644 extern NCURSES_EXPORT(int) inchnstr (chtype *, int);                    /* generated */
645 extern NCURSES_EXPORT(int) inchstr (chtype *);                          /* generated */
646 extern NCURSES_EXPORT(WINDOW *) initscr (void);                         /* implemented */
647 extern NCURSES_EXPORT(int) init_color (NCURSES_COLOR_T,NCURSES_COLOR_T,NCURSES_COLOR_T,NCURSES_COLOR_T);        /* implemented */
648 extern NCURSES_EXPORT(int) init_pair (NCURSES_PAIRS_T,NCURSES_COLOR_T,NCURSES_COLOR_T);         /* implemented */
649 extern NCURSES_EXPORT(int) innstr (char *, int);                        /* generated */
650 extern NCURSES_EXPORT(int) insch (chtype);                              /* generated */
651 extern NCURSES_EXPORT(int) insdelln (int);                              /* generated */
652 extern NCURSES_EXPORT(int) insertln (void);                             /* generated */
653 extern NCURSES_EXPORT(int) insnstr (const char *, int);                 /* generated */
654 extern NCURSES_EXPORT(int) insstr (const char *);                       /* generated */
655 extern NCURSES_EXPORT(int) instr (char *);                              /* generated */
656 extern NCURSES_EXPORT(int) intrflush (WINDOW *,bool);                   /* implemented */
657 extern NCURSES_EXPORT(bool) isendwin (void);                            /* implemented */
658 extern NCURSES_EXPORT(bool) is_linetouched (WINDOW *,int);              /* implemented */
659 extern NCURSES_EXPORT(bool) is_wintouched (WINDOW *);                   /* implemented */
660 extern NCURSES_EXPORT(NCURSES_CONST char *) keyname (int);              /* implemented */
661 extern NCURSES_EXPORT(int) keypad (WINDOW *,bool);                      /* implemented */
662 extern NCURSES_EXPORT(char) killchar (void);                            /* implemented */
663 extern NCURSES_EXPORT(int) leaveok (WINDOW *,bool);                     /* implemented */
664 extern NCURSES_EXPORT(char *) longname (void);                          /* implemented */
665 extern NCURSES_EXPORT(int) meta (WINDOW *,bool);                        /* implemented */
666 extern NCURSES_EXPORT(int) move (int, int);                             /* generated */
667 extern NCURSES_EXPORT(int) mvaddch (int, int, const chtype);            /* generated */
668 extern NCURSES_EXPORT(int) mvaddchnstr (int, int, const chtype *, int); /* generated */
669 extern NCURSES_EXPORT(int) mvaddchstr (int, int, const chtype *);       /* generated */
670 extern NCURSES_EXPORT(int) mvaddnstr (int, int, const char *, int);     /* generated */
671 extern NCURSES_EXPORT(int) mvaddstr (int, int, const char *);           /* generated */
672 extern NCURSES_EXPORT(int) mvchgat (int, int, int, attr_t, NCURSES_PAIRS_T, const void *);      /* generated */
673 extern NCURSES_EXPORT(int) mvcur (int,int,int,int);                     /* implemented */
674 extern NCURSES_EXPORT(int) mvdelch (int, int);                          /* generated */
675 extern NCURSES_EXPORT(int) mvderwin (WINDOW *, int, int);               /* implemented */
676 extern NCURSES_EXPORT(int) mvgetch (int, int);                          /* generated */
677 extern NCURSES_EXPORT(int) mvgetnstr (int, int, char *, int);           /* generated */
678 extern NCURSES_EXPORT(int) mvgetstr (int, int, char *);                 /* generated */
679 extern NCURSES_EXPORT(int) mvhline (int, int, chtype, int);             /* generated */
680 extern NCURSES_EXPORT(chtype) mvinch (int, int);                        /* generated */
681 extern NCURSES_EXPORT(int) mvinchnstr (int, int, chtype *, int);        /* generated */
682 extern NCURSES_EXPORT(int) mvinchstr (int, int, chtype *);              /* generated */
683 extern NCURSES_EXPORT(int) mvinnstr (int, int, char *, int);            /* generated */
684 extern NCURSES_EXPORT(int) mvinsch (int, int, chtype);                  /* generated */
685 extern NCURSES_EXPORT(int) mvinsnstr (int, int, const char *, int);     /* generated */
686 extern NCURSES_EXPORT(int) mvinsstr (int, int, const char *);           /* generated */
687 extern NCURSES_EXPORT(int) mvinstr (int, int, char *);                  /* generated */
688 extern NCURSES_EXPORT(int) mvprintw (int,int, const char *,...)         /* implemented */
689                 GCC_PRINTFLIKE(3,4);
690 extern NCURSES_EXPORT(int) mvscanw (int,int, NCURSES_CONST char *,...)  /* implemented */
691                 GCC_SCANFLIKE(3,4);
692 extern NCURSES_EXPORT(int) mvvline (int, int, chtype, int);             /* generated */
693 extern NCURSES_EXPORT(int) mvwaddch (WINDOW *, int, int, const chtype); /* generated */
694 extern NCURSES_EXPORT(int) mvwaddchnstr (WINDOW *, int, int, const chtype *, int);/* generated */
695 extern NCURSES_EXPORT(int) mvwaddchstr (WINDOW *, int, int, const chtype *);    /* generated */
696 extern NCURSES_EXPORT(int) mvwaddnstr (WINDOW *, int, int, const char *, int);  /* generated */
697 extern NCURSES_EXPORT(int) mvwaddstr (WINDOW *, int, int, const char *);        /* generated */
698 extern NCURSES_EXPORT(int) mvwchgat (WINDOW *, int, int, int, attr_t, NCURSES_PAIRS_T, const void *);/* generated */
699 extern NCURSES_EXPORT(int) mvwdelch (WINDOW *, int, int);               /* generated */
700 extern NCURSES_EXPORT(int) mvwgetch (WINDOW *, int, int);               /* generated */
701 extern NCURSES_EXPORT(int) mvwgetnstr (WINDOW *, int, int, char *, int);        /* generated */
702 extern NCURSES_EXPORT(int) mvwgetstr (WINDOW *, int, int, char *);      /* generated */
703 extern NCURSES_EXPORT(int) mvwhline (WINDOW *, int, int, chtype, int);  /* generated */
704 extern NCURSES_EXPORT(int) mvwin (WINDOW *,int,int);                    /* implemented */
705 extern NCURSES_EXPORT(chtype) mvwinch (WINDOW *, int, int);                     /* generated */
706 extern NCURSES_EXPORT(int) mvwinchnstr (WINDOW *, int, int, chtype *, int);     /* generated */
707 extern NCURSES_EXPORT(int) mvwinchstr (WINDOW *, int, int, chtype *);           /* generated */
708 extern NCURSES_EXPORT(int) mvwinnstr (WINDOW *, int, int, char *, int);         /* generated */
709 extern NCURSES_EXPORT(int) mvwinsch (WINDOW *, int, int, chtype);               /* generated */
710 extern NCURSES_EXPORT(int) mvwinsnstr (WINDOW *, int, int, const char *, int);  /* generated */
711 extern NCURSES_EXPORT(int) mvwinsstr (WINDOW *, int, int, const char *);        /* generated */
712 extern NCURSES_EXPORT(int) mvwinstr (WINDOW *, int, int, char *);               /* generated */
713 extern NCURSES_EXPORT(int) mvwprintw (WINDOW*,int,int, const char *,...)        /* implemented */
714                 GCC_PRINTFLIKE(4,5);
715 extern NCURSES_EXPORT(int) mvwscanw (WINDOW *,int,int, NCURSES_CONST char *,...)        /* implemented */
716                 GCC_SCANFLIKE(4,5);
717 extern NCURSES_EXPORT(int) mvwvline (WINDOW *,int, int, chtype, int);   /* generated */
718 extern NCURSES_EXPORT(int) napms (int);                                 /* implemented */
719 extern NCURSES_EXPORT(WINDOW *) newpad (int,int);                       /* implemented */
720 extern NCURSES_EXPORT(SCREEN *) newterm (NCURSES_CONST char *,FILE *,FILE *);   /* implemented */
721 extern NCURSES_EXPORT(WINDOW *) newwin (int,int,int,int);               /* implemented */
722 extern NCURSES_EXPORT(int) nl (void);                                   /* implemented */
723 extern NCURSES_EXPORT(int) nocbreak (void);                             /* implemented */
724 extern NCURSES_EXPORT(int) nodelay (WINDOW *,bool);                     /* implemented */
725 extern NCURSES_EXPORT(int) noecho (void);                               /* implemented */
726 extern NCURSES_EXPORT(int) nonl (void);                                 /* implemented */
727 extern NCURSES_EXPORT(void) noqiflush (void);                           /* implemented */
728 extern NCURSES_EXPORT(int) noraw (void);                                /* implemented */
729 extern NCURSES_EXPORT(int) notimeout (WINDOW *,bool);                   /* implemented */
730 extern NCURSES_EXPORT(int) overlay (const WINDOW*,WINDOW *);            /* implemented */
731 extern NCURSES_EXPORT(int) overwrite (const WINDOW*,WINDOW *);          /* implemented */
732 extern NCURSES_EXPORT(int) pair_content (NCURSES_PAIRS_T,NCURSES_COLOR_T*,NCURSES_COLOR_T*);            /* implemented */
733 extern NCURSES_EXPORT(int) PAIR_NUMBER (int);                           /* generated */
734 extern NCURSES_EXPORT(int) pechochar (WINDOW *, const chtype);          /* implemented */
735 extern NCURSES_EXPORT(int) pnoutrefresh (WINDOW*,int,int,int,int,int,int);/* implemented */
736 extern NCURSES_EXPORT(int) prefresh (WINDOW *,int,int,int,int,int,int); /* implemented */
737 extern NCURSES_EXPORT(int) printw (const char *,...)                    /* implemented */
738                 GCC_PRINTFLIKE(1,2);
739 extern NCURSES_EXPORT(int) putwin (WINDOW *, FILE *);                   /* implemented */
740 extern NCURSES_EXPORT(void) qiflush (void);                             /* implemented */
741 extern NCURSES_EXPORT(int) raw (void);                                  /* implemented */
742 extern NCURSES_EXPORT(int) redrawwin (WINDOW *);                        /* generated */
743 extern NCURSES_EXPORT(int) refresh (void);                              /* generated */
744 extern NCURSES_EXPORT(int) resetty (void);                              /* implemented */
745 extern NCURSES_EXPORT(int) reset_prog_mode (void);                      /* implemented */
746 extern NCURSES_EXPORT(int) reset_shell_mode (void);                     /* implemented */
747 extern NCURSES_EXPORT(int) ripoffline (int, int (*)(WINDOW *, int));    /* implemented */
748 extern NCURSES_EXPORT(int) savetty (void);                              /* implemented */
749 extern NCURSES_EXPORT(int) scanw (NCURSES_CONST char *,...)             /* implemented */
750                 GCC_SCANFLIKE(1,2);
751 extern NCURSES_EXPORT(int) scr_dump (const char *);                     /* implemented */
752 extern NCURSES_EXPORT(int) scr_init (const char *);                     /* implemented */
753 extern NCURSES_EXPORT(int) scrl (int);                                  /* generated */
754 extern NCURSES_EXPORT(int) scroll (WINDOW *);                           /* generated */
755 extern NCURSES_EXPORT(int) scrollok (WINDOW *,bool);                    /* implemented */
756 extern NCURSES_EXPORT(int) scr_restore (const char *);                  /* implemented */
757 extern NCURSES_EXPORT(int) scr_set (const char *);                      /* implemented */
758 extern NCURSES_EXPORT(int) setscrreg (int,int);                         /* generated */
759 extern NCURSES_EXPORT(SCREEN *) set_term (SCREEN *);                    /* implemented */
760 extern NCURSES_EXPORT(int) slk_attroff (const chtype);                  /* implemented */
761 extern NCURSES_EXPORT(int) slk_attr_off (const attr_t, void *);         /* generated:WIDEC */
762 extern NCURSES_EXPORT(int) slk_attron (const chtype);                   /* implemented */
763 extern NCURSES_EXPORT(int) slk_attr_on (attr_t,void*);                  /* generated:WIDEC */
764 extern NCURSES_EXPORT(int) slk_attrset (const chtype);                  /* implemented */
765 extern NCURSES_EXPORT(attr_t) slk_attr (void);                          /* implemented */
766 extern NCURSES_EXPORT(int) slk_attr_set (const attr_t,NCURSES_PAIRS_T,void*);   /* implemented */
767 extern NCURSES_EXPORT(int) slk_clear (void);                            /* implemented */
768 extern NCURSES_EXPORT(int) slk_color (NCURSES_PAIRS_T);                         /* implemented */
769 extern NCURSES_EXPORT(int) slk_init (int);                              /* implemented */
770 extern NCURSES_EXPORT(char *) slk_label (int);                          /* implemented */
771 extern NCURSES_EXPORT(int) slk_noutrefresh (void);                      /* implemented */
772 extern NCURSES_EXPORT(int) slk_refresh (void);                          /* implemented */
773 extern NCURSES_EXPORT(int) slk_restore (void);                          /* implemented */
774 extern NCURSES_EXPORT(int) slk_set (int,const char *,int);              /* implemented */
775 extern NCURSES_EXPORT(int) slk_touch (void);                            /* implemented */
776 extern NCURSES_EXPORT(int) standout (void);                             /* generated */
777 extern NCURSES_EXPORT(int) standend (void);                             /* generated */
778 extern NCURSES_EXPORT(int) start_color (void);                          /* implemented */
779 extern NCURSES_EXPORT(WINDOW *) subpad (WINDOW *, int, int, int, int);  /* implemented */
780 extern NCURSES_EXPORT(WINDOW *) subwin (WINDOW *, int, int, int, int);  /* implemented */
781 extern NCURSES_EXPORT(int) syncok (WINDOW *, bool);                     /* implemented */
782 extern NCURSES_EXPORT(chtype) termattrs (void);                         /* implemented */
783 extern NCURSES_EXPORT(char *) termname (void);                          /* implemented */
784 extern NCURSES_EXPORT(void) timeout (int);                              /* generated */
785 extern NCURSES_EXPORT(int) touchline (WINDOW *, int, int);              /* generated */
786 extern NCURSES_EXPORT(int) touchwin (WINDOW *);                         /* generated */
787 extern NCURSES_EXPORT(int) typeahead (int);                             /* implemented */
788 extern NCURSES_EXPORT(int) ungetch (int);                               /* implemented */
789 extern NCURSES_EXPORT(int) untouchwin (WINDOW *);                       /* generated */
790 extern NCURSES_EXPORT(void) use_env (bool);                             /* implemented */
791 extern NCURSES_EXPORT(void) use_tioctl (bool);                          /* implemented */
792 extern NCURSES_EXPORT(int) vidattr (chtype);                            /* implemented */
793 extern NCURSES_EXPORT(int) vidputs (chtype, NCURSES_OUTC);              /* implemented */
794 extern NCURSES_EXPORT(int) vline (chtype, int);                         /* generated */
795 extern NCURSES_EXPORT(int) vwprintw (WINDOW *, const char *,va_list);   /* implemented */
796 extern NCURSES_EXPORT(int) vw_printw (WINDOW *, const char *,va_list);  /* generated */
797 extern NCURSES_EXPORT(int) vwscanw (WINDOW *, NCURSES_CONST char *,va_list);    /* implemented */
798 extern NCURSES_EXPORT(int) vw_scanw (WINDOW *, NCURSES_CONST char *,va_list);   /* generated */
799 extern NCURSES_EXPORT(int) waddch (WINDOW *, const chtype);             /* implemented */
800 extern NCURSES_EXPORT(int) waddchnstr (WINDOW *,const chtype *,int);    /* implemented */
801 extern NCURSES_EXPORT(int) waddchstr (WINDOW *,const chtype *);         /* generated */
802 extern NCURSES_EXPORT(int) waddnstr (WINDOW *,const char *,int);        /* implemented */
803 extern NCURSES_EXPORT(int) waddstr (WINDOW *,const char *);             /* generated */
804 extern NCURSES_EXPORT(int) wattron (WINDOW *, int);                     /* generated */
805 extern NCURSES_EXPORT(int) wattroff (WINDOW *, int);                    /* generated */
806 extern NCURSES_EXPORT(int) wattrset (WINDOW *, int);                    /* generated */
807 extern NCURSES_EXPORT(int) wattr_get (WINDOW *, attr_t *, NCURSES_PAIRS_T *, void *);   /* generated */
808 extern NCURSES_EXPORT(int) wattr_on (WINDOW *, attr_t, void *);         /* implemented */
809 extern NCURSES_EXPORT(int) wattr_off (WINDOW *, attr_t, void *);        /* implemented */
810 extern NCURSES_EXPORT(int) wattr_set (WINDOW *, attr_t, NCURSES_PAIRS_T, void *);       /* generated */
811 extern NCURSES_EXPORT(int) wbkgd (WINDOW *, chtype);                    /* implemented */
812 extern NCURSES_EXPORT(void) wbkgdset (WINDOW *,chtype);                 /* implemented */
813 extern NCURSES_EXPORT(int) wborder (WINDOW *,chtype,chtype,chtype,chtype,chtype,chtype,chtype,chtype);  /* implemented */
814 extern NCURSES_EXPORT(int) wchgat (WINDOW *, int, attr_t, NCURSES_PAIRS_T, const void *);/* implemented */
815 extern NCURSES_EXPORT(int) wclear (WINDOW *);                           /* implemented */
816 extern NCURSES_EXPORT(int) wclrtobot (WINDOW *);                        /* implemented */
817 extern NCURSES_EXPORT(int) wclrtoeol (WINDOW *);                        /* implemented */
818 extern NCURSES_EXPORT(int) wcolor_set (WINDOW*,NCURSES_PAIRS_T,void*);          /* implemented */
819 extern NCURSES_EXPORT(void) wcursyncup (WINDOW *);                      /* implemented */
820 extern NCURSES_EXPORT(int) wdelch (WINDOW *);                           /* implemented */
821 extern NCURSES_EXPORT(int) wdeleteln (WINDOW *);                        /* generated */
822 extern NCURSES_EXPORT(int) wechochar (WINDOW *, const chtype);          /* implemented */
823 extern NCURSES_EXPORT(int) werase (WINDOW *);                           /* implemented */
824 extern NCURSES_EXPORT(int) wgetch (WINDOW *);                           /* implemented */
825 extern NCURSES_EXPORT(int) wgetnstr (WINDOW *,char *,int);              /* implemented */
826 extern NCURSES_EXPORT(int) wgetstr (WINDOW *, char *);                  /* generated */
827 extern NCURSES_EXPORT(int) whline (WINDOW *, chtype, int);              /* implemented */
828 extern NCURSES_EXPORT(chtype) winch (WINDOW *);                         /* implemented */
829 extern NCURSES_EXPORT(int) winchnstr (WINDOW *, chtype *, int);         /* implemented */
830 extern NCURSES_EXPORT(int) winchstr (WINDOW *, chtype *);               /* generated */
831 extern NCURSES_EXPORT(int) winnstr (WINDOW *, char *, int);             /* implemented */
832 extern NCURSES_EXPORT(int) winsch (WINDOW *, chtype);                   /* implemented */
833 extern NCURSES_EXPORT(int) winsdelln (WINDOW *,int);                    /* implemented */
834 extern NCURSES_EXPORT(int) winsertln (WINDOW *);                        /* generated */
835 extern NCURSES_EXPORT(int) winsnstr (WINDOW *, const char *,int);       /* implemented */
836 extern NCURSES_EXPORT(int) winsstr (WINDOW *, const char *);            /* generated */
837 extern NCURSES_EXPORT(int) winstr (WINDOW *, char *);                   /* generated */
838 extern NCURSES_EXPORT(int) wmove (WINDOW *,int,int);                    /* implemented */
839 extern NCURSES_EXPORT(int) wnoutrefresh (WINDOW *);                     /* implemented */
840 extern NCURSES_EXPORT(int) wprintw (WINDOW *, const char *,...)         /* implemented */
841                 GCC_PRINTFLIKE(2,3);
842 extern NCURSES_EXPORT(int) wredrawln (WINDOW *,int,int);                /* implemented */
843 extern NCURSES_EXPORT(int) wrefresh (WINDOW *);                         /* implemented */
844 extern NCURSES_EXPORT(int) wscanw (WINDOW *, NCURSES_CONST char *,...)  /* implemented */
845                 GCC_SCANFLIKE(2,3);
846 extern NCURSES_EXPORT(int) wscrl (WINDOW *,int);                        /* implemented */
847 extern NCURSES_EXPORT(int) wsetscrreg (WINDOW *,int,int);               /* implemented */
848 extern NCURSES_EXPORT(int) wstandout (WINDOW *);                        /* generated */
849 extern NCURSES_EXPORT(int) wstandend (WINDOW *);                        /* generated */
850 extern NCURSES_EXPORT(void) wsyncdown (WINDOW *);                       /* implemented */
851 extern NCURSES_EXPORT(void) wsyncup (WINDOW *);                         /* implemented */
852 extern NCURSES_EXPORT(void) wtimeout (WINDOW *,int);                    /* implemented */
853 extern NCURSES_EXPORT(int) wtouchln (WINDOW *,int,int,int);             /* implemented */
854 extern NCURSES_EXPORT(int) wvline (WINDOW *,chtype,int);                /* implemented */
855
856 /*
857  * These are also declared in <term.h>:
858  */
859 extern NCURSES_EXPORT(int) tigetflag (NCURSES_CONST char *);            /* implemented */
860 extern NCURSES_EXPORT(int) tigetnum (NCURSES_CONST char *);             /* implemented */
861 extern NCURSES_EXPORT(char *) tigetstr (NCURSES_CONST char *);          /* implemented */
862 extern NCURSES_EXPORT(int) putp (const char *);                         /* implemented */
863
864 #if NCURSES_TPARM_VARARGS
865 extern NCURSES_EXPORT(char *) tparm (NCURSES_CONST char *, ...);        /* special */
866 #else
867 extern NCURSES_EXPORT(char *) tparm (NCURSES_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 */
868 extern NCURSES_EXPORT(char *) tparm_varargs (NCURSES_CONST char *, ...);        /* special */
869 #endif
870
871 extern NCURSES_EXPORT(char *) tiparm (const char *, ...);               /* special */
872
873 /*
874  * These functions are not in X/Open, but we use them in macro definitions:
875  */
876 extern NCURSES_EXPORT(int) getattrs (const WINDOW *);                   /* generated */
877 extern NCURSES_EXPORT(int) getcurx (const WINDOW *);                    /* generated */
878 extern NCURSES_EXPORT(int) getcury (const WINDOW *);                    /* generated */
879 extern NCURSES_EXPORT(int) getbegx (const WINDOW *);                    /* generated */
880 extern NCURSES_EXPORT(int) getbegy (const WINDOW *);                    /* generated */
881 extern NCURSES_EXPORT(int) getmaxx (const WINDOW *);                    /* generated */
882 extern NCURSES_EXPORT(int) getmaxy (const WINDOW *);                    /* generated */
883 extern NCURSES_EXPORT(int) getparx (const WINDOW *);                    /* generated */
884 extern NCURSES_EXPORT(int) getpary (const WINDOW *);                    /* generated */
885
886 /*
887  * vid_attr() was implemented originally based on a draft of X/Open curses.
888  */
889 #if !NCURSES_WIDECHAR
890 #define vid_attr(a,pair,opts) vidattr(a)
891 #endif
892
893 /*
894  * These functions are extensions - not in X/Open Curses.
895  */
896 #if @NCURSES_EXT_FUNCS@
897 #undef  NCURSES_EXT_FUNCS
898 #define NCURSES_EXT_FUNCS @NCURSES_PATCH@
899 typedef int (*NCURSES_WINDOW_CB)(WINDOW *, void *);
900 typedef int (*NCURSES_SCREEN_CB)(SCREEN *, void *);
901 extern NCURSES_EXPORT(bool) is_term_resized (int, int);
902 extern NCURSES_EXPORT(char *) keybound (int, int);
903 extern NCURSES_EXPORT(const char *) curses_version (void);
904 extern NCURSES_EXPORT(int) assume_default_colors (int, int);
905 extern NCURSES_EXPORT(int) define_key (const char *, int);
906 extern NCURSES_EXPORT(int) get_escdelay (void);
907 extern NCURSES_EXPORT(int) key_defined (const char *);
908 extern NCURSES_EXPORT(int) keyok (int, bool);
909 extern NCURSES_EXPORT(int) resize_term (int, int);
910 extern NCURSES_EXPORT(int) resizeterm (int, int);
911 extern NCURSES_EXPORT(int) set_escdelay (int);
912 extern NCURSES_EXPORT(int) set_tabsize (int);
913 extern NCURSES_EXPORT(int) use_default_colors (void);
914 extern NCURSES_EXPORT(int) use_extended_names (bool);
915 extern NCURSES_EXPORT(int) use_legacy_coding (int);
916 extern NCURSES_EXPORT(int) use_screen (SCREEN *, NCURSES_SCREEN_CB, void *);
917 extern NCURSES_EXPORT(int) use_window (WINDOW *, NCURSES_WINDOW_CB, void *);
918 extern NCURSES_EXPORT(int) wresize (WINDOW *, int, int);
919 extern NCURSES_EXPORT(void) nofilter(void);
920
921 /*
922  * These extensions provide access to information stored in the WINDOW even
923  * when NCURSES_OPAQUE is set:
924  */
925 extern NCURSES_EXPORT(WINDOW *) wgetparent (const WINDOW *);    /* @GENERATED_EXT_FUNCS@ */
926 extern NCURSES_EXPORT(bool) is_cleared (const WINDOW *);        /* @GENERATED_EXT_FUNCS@ */
927 extern NCURSES_EXPORT(bool) is_idcok (const WINDOW *);          /* @GENERATED_EXT_FUNCS@ */
928 extern NCURSES_EXPORT(bool) is_idlok (const WINDOW *);          /* @GENERATED_EXT_FUNCS@ */
929 extern NCURSES_EXPORT(bool) is_immedok (const WINDOW *);        /* @GENERATED_EXT_FUNCS@ */
930 extern NCURSES_EXPORT(bool) is_keypad (const WINDOW *);         /* @GENERATED_EXT_FUNCS@ */
931 extern NCURSES_EXPORT(bool) is_leaveok (const WINDOW *);        /* @GENERATED_EXT_FUNCS@ */
932 extern NCURSES_EXPORT(bool) is_nodelay (const WINDOW *);        /* @GENERATED_EXT_FUNCS@ */
933 extern NCURSES_EXPORT(bool) is_notimeout (const WINDOW *);      /* @GENERATED_EXT_FUNCS@ */
934 extern NCURSES_EXPORT(bool) is_pad (const WINDOW *);            /* @GENERATED_EXT_FUNCS@ */
935 extern NCURSES_EXPORT(bool) is_scrollok (const WINDOW *);       /* @GENERATED_EXT_FUNCS@ */
936 extern NCURSES_EXPORT(bool) is_subwin (const WINDOW *);         /* @GENERATED_EXT_FUNCS@ */
937 extern NCURSES_EXPORT(bool) is_syncok (const WINDOW *);         /* @GENERATED_EXT_FUNCS@ */
938 extern NCURSES_EXPORT(int) wgetdelay (const WINDOW *);          /* @GENERATED_EXT_FUNCS@ */
939 extern NCURSES_EXPORT(int) wgetscrreg (const WINDOW *, int *, int *); /* @GENERATED_EXT_FUNCS@ */
940
941 #else
942 #define curses_version() NCURSES_VERSION
943 #endif
944
945 /*
946  * Extra extension-functions, which pass a SCREEN pointer rather than using
947  * a global variable SP.
948  */
949 #if @NCURSES_SP_FUNCS@
950 #undef  NCURSES_SP_FUNCS
951 #define NCURSES_SP_FUNCS @NCURSES_PATCH@
952 #define NCURSES_SP_NAME(name) name##_sp
953
954 /* Define the sp-funcs helper function */
955 #define NCURSES_SP_OUTC NCURSES_SP_NAME(NCURSES_OUTC)
956 typedef int (*NCURSES_SP_OUTC)(SCREEN*, int);
957
958 extern NCURSES_EXPORT(SCREEN *) new_prescr (void); /* implemented:SP_FUNC */
959
960 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(baudrate) (SCREEN*); /* implemented:SP_FUNC */
961 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(beep) (SCREEN*); /* implemented:SP_FUNC */
962 extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(can_change_color) (SCREEN*); /* implemented:SP_FUNC */
963 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(cbreak) (SCREEN*); /* implemented:SP_FUNC */
964 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(curs_set) (SCREEN*, int); /* implemented:SP_FUNC */
965 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 */
966 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(def_prog_mode) (SCREEN*); /* implemented:SP_FUNC */
967 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(def_shell_mode) (SCREEN*); /* implemented:SP_FUNC */
968 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(delay_output) (SCREEN*, int); /* implemented:SP_FUNC */
969 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(doupdate) (SCREEN*); /* implemented:SP_FUNC */
970 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(echo) (SCREEN*); /* implemented:SP_FUNC */
971 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(endwin) (SCREEN*); /* implemented:SP_FUNC */
972 extern NCURSES_EXPORT(char) NCURSES_SP_NAME(erasechar) (SCREEN*);/* implemented:SP_FUNC */
973 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(filter) (SCREEN*); /* implemented:SP_FUNC */
974 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(flash) (SCREEN*); /* implemented:SP_FUNC */
975 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(flushinp) (SCREEN*); /* implemented:SP_FUNC */
976 extern NCURSES_EXPORT(WINDOW *) NCURSES_SP_NAME(getwin) (SCREEN*, FILE *);                      /* implemented:SP_FUNC */
977 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(halfdelay) (SCREEN*, int); /* implemented:SP_FUNC */
978 extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(has_colors) (SCREEN*); /* implemented:SP_FUNC */
979 extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(has_ic) (SCREEN*); /* implemented:SP_FUNC */
980 extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(has_il) (SCREEN*); /* implemented:SP_FUNC */
981 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 */
982 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(init_pair) (SCREEN*, NCURSES_PAIRS_T, NCURSES_COLOR_T, NCURSES_COLOR_T); /* implemented:SP_FUNC */
983 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(intrflush) (SCREEN*, WINDOW*, bool); /* implemented:SP_FUNC */
984 extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(isendwin) (SCREEN*); /* implemented:SP_FUNC */
985 extern NCURSES_EXPORT(NCURSES_CONST char *) NCURSES_SP_NAME(keyname) (SCREEN*, int); /* implemented:SP_FUNC */
986 extern NCURSES_EXPORT(char) NCURSES_SP_NAME(killchar) (SCREEN*); /* implemented:SP_FUNC */
987 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(longname) (SCREEN*); /* implemented:SP_FUNC */
988 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(mvcur) (SCREEN*, int, int, int, int); /* implemented:SP_FUNC */
989 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(napms) (SCREEN*, int); /* implemented:SP_FUNC */
990 extern NCURSES_EXPORT(WINDOW *) NCURSES_SP_NAME(newpad) (SCREEN*, int, int); /* implemented:SP_FUNC */
991 extern NCURSES_EXPORT(SCREEN *) NCURSES_SP_NAME(newterm) (SCREEN*, NCURSES_CONST char *, FILE *, FILE *); /* implemented:SP_FUNC */
992 extern NCURSES_EXPORT(WINDOW *) NCURSES_SP_NAME(newwin) (SCREEN*, int, int, int, int); /* implemented:SP_FUNC */
993 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(nl) (SCREEN*); /* implemented:SP_FUNC */
994 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(nocbreak) (SCREEN*); /* implemented:SP_FUNC */
995 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(noecho) (SCREEN*); /* implemented:SP_FUNC */
996 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(nonl) (SCREEN*); /* implemented:SP_FUNC */
997 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(noqiflush) (SCREEN*); /* implemented:SP_FUNC */
998 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(noraw) (SCREEN*); /* implemented:SP_FUNC */
999 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(pair_content) (SCREEN*, NCURSES_PAIRS_T, NCURSES_COLOR_T*, NCURSES_COLOR_T*); /* implemented:SP_FUNC */
1000 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(qiflush) (SCREEN*); /* implemented:SP_FUNC */
1001 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(raw) (SCREEN*); /* implemented:SP_FUNC */
1002 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(reset_prog_mode) (SCREEN*); /* implemented:SP_FUNC */
1003 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(reset_shell_mode) (SCREEN*); /* implemented:SP_FUNC */
1004 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(resetty) (SCREEN*); /* implemented:SP_FUNC */
1005 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(ripoffline) (SCREEN*, int, int (*)(WINDOW *, int));  /* implemented:SP_FUNC */
1006 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(savetty) (SCREEN*); /* implemented:SP_FUNC */
1007 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(scr_init) (SCREEN*, const char *); /* implemented:SP_FUNC */
1008 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(scr_restore) (SCREEN*, const char *); /* implemented:SP_FUNC */
1009 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(scr_set) (SCREEN*, const char *); /* implemented:SP_FUNC */
1010 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_attroff) (SCREEN*, const chtype); /* implemented:SP_FUNC */
1011 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_attron) (SCREEN*, const chtype); /* implemented:SP_FUNC */
1012 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_attrset) (SCREEN*, const chtype); /* implemented:SP_FUNC */
1013 extern NCURSES_EXPORT(attr_t) NCURSES_SP_NAME(slk_attr) (SCREEN*); /* implemented:SP_FUNC */
1014 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_attr_set) (SCREEN*, const attr_t, NCURSES_PAIRS_T, void*); /* implemented:SP_FUNC */
1015 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_clear) (SCREEN*); /* implemented:SP_FUNC */
1016 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_color) (SCREEN*, NCURSES_PAIRS_T); /* implemented:SP_FUNC */
1017 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_init) (SCREEN*, int); /* implemented:SP_FUNC */
1018 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(slk_label) (SCREEN*, int); /* implemented:SP_FUNC */
1019 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_noutrefresh) (SCREEN*); /* implemented:SP_FUNC */
1020 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_refresh) (SCREEN*); /* implemented:SP_FUNC */
1021 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_restore) (SCREEN*); /* implemented:SP_FUNC */
1022 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_set) (SCREEN*, int, const char *, int); /* implemented:SP_FUNC */
1023 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_touch) (SCREEN*); /* implemented:SP_FUNC */
1024 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(start_color) (SCREEN*); /* implemented:SP_FUNC */
1025 extern NCURSES_EXPORT(chtype) NCURSES_SP_NAME(termattrs) (SCREEN*); /* implemented:SP_FUNC */
1026 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(termname) (SCREEN*); /* implemented:SP_FUNC */
1027 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(typeahead) (SCREEN*, int); /* implemented:SP_FUNC */
1028 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(ungetch) (SCREEN*, int); /* implemented:SP_FUNC */
1029 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(use_env) (SCREEN*, bool); /* implemented:SP_FUNC */
1030 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(use_tioctl) (SCREEN*, bool); /* implemented:SP_FUNC */
1031 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(vidattr) (SCREEN*, chtype);  /* implemented:SP_FUNC */
1032 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(vidputs) (SCREEN*, chtype, NCURSES_SP_OUTC); /* implemented:SP_FUNC */
1033 #if @NCURSES_EXT_FUNCS@
1034 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(keybound) (SCREEN*, int, int);    /* implemented:EXT_SP_FUNC */
1035 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(assume_default_colors) (SCREEN*, int, int);  /* implemented:EXT_SP_FUNC */
1036 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(define_key) (SCREEN*, const char *, int);    /* implemented:EXT_SP_FUNC */
1037 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(get_escdelay) (SCREEN*);     /* implemented:EXT_SP_FUNC */
1038 extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(is_term_resized) (SCREEN*, int, int);       /* implemented:EXT_SP_FUNC */
1039 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(key_defined) (SCREEN*, const char *);        /* implemented:EXT_SP_FUNC */
1040 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(keyok) (SCREEN*, int, bool); /* implemented:EXT_SP_FUNC */
1041 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(nofilter) (SCREEN*); /* implemented */      /* implemented:EXT_SP_FUNC */
1042 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(resize_term) (SCREEN*, int, int);    /* implemented:EXT_SP_FUNC */
1043 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(resizeterm) (SCREEN*, int, int);     /* implemented:EXT_SP_FUNC */
1044 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(set_escdelay) (SCREEN*, int);        /* implemented:EXT_SP_FUNC */
1045 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(set_tabsize) (SCREEN*, int); /* implemented:EXT_SP_FUNC */
1046 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(use_default_colors) (SCREEN*);       /* implemented:EXT_SP_FUNC */
1047 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(use_legacy_coding) (SCREEN*, int);   /* implemented:EXT_SP_FUNC */
1048 #endif
1049 #else
1050 #undef  NCURSES_SP_FUNCS
1051 #define NCURSES_SP_FUNCS 0
1052 #define NCURSES_SP_NAME(name) name
1053 #define NCURSES_SP_OUTC NCURSES_OUTC
1054 #endif
1055
1056 /* attributes */
1057
1058 #define NCURSES_ATTR_SHIFT       8
1059 #define NCURSES_BITS(mask,shift) (NCURSES_CAST(chtype,(mask)) << ((shift) + NCURSES_ATTR_SHIFT))
1060
1061 #define A_NORMAL        (@cf_cv_1UL@ - @cf_cv_1UL@)
1062 #define A_ATTRIBUTES    NCURSES_BITS(~(@cf_cv_1UL@ - @cf_cv_1UL@),0)
1063 #define A_CHARTEXT      (NCURSES_BITS(@cf_cv_1UL@,0) - @cf_cv_1UL@)
1064 #define A_COLOR         NCURSES_BITS(((@cf_cv_1UL@) << 8) - @cf_cv_1UL@,0)
1065 #define A_STANDOUT      NCURSES_BITS(@cf_cv_1UL@,8)
1066 #define A_UNDERLINE     NCURSES_BITS(@cf_cv_1UL@,9)
1067 #define A_REVERSE       NCURSES_BITS(@cf_cv_1UL@,10)
1068 #define A_BLINK         NCURSES_BITS(@cf_cv_1UL@,11)
1069 #define A_DIM           NCURSES_BITS(@cf_cv_1UL@,12)
1070 #define A_BOLD          NCURSES_BITS(@cf_cv_1UL@,13)
1071 #define A_ALTCHARSET    NCURSES_BITS(@cf_cv_1UL@,14)
1072 #define A_INVIS         NCURSES_BITS(@cf_cv_1UL@,15)
1073 #define A_PROTECT       NCURSES_BITS(@cf_cv_1UL@,16)
1074 #define A_HORIZONTAL    NCURSES_BITS(@cf_cv_1UL@,17)
1075 #define A_LEFT          NCURSES_BITS(@cf_cv_1UL@,18)
1076 #define A_LOW           NCURSES_BITS(@cf_cv_1UL@,19)
1077 #define A_RIGHT         NCURSES_BITS(@cf_cv_1UL@,20)
1078 #define A_TOP           NCURSES_BITS(@cf_cv_1UL@,21)
1079 #define A_VERTICAL      NCURSES_BITS(@cf_cv_1UL@,22)
1080
1081 #if @NCURSES_EXT_FUNCS@
1082 #define A_ITALIC        NCURSES_BITS(@cf_cv_1UL@,23)    /* ncurses extension */
1083 #endif
1084
1085 /*
1086  * Most of the pseudo functions are macros that either provide compatibility
1087  * with older versions of curses, or provide inline functionality to improve
1088  * performance.
1089  */
1090
1091 /*
1092  * These pseudo functions are always implemented as macros:
1093  */
1094
1095 #define getyx(win,y,x)          (y = getcury(win), x = getcurx(win))
1096 #define getbegyx(win,y,x)       (y = getbegy(win), x = getbegx(win))
1097 #define getmaxyx(win,y,x)       (y = getmaxy(win), x = getmaxx(win))
1098 #define getparyx(win,y,x)       (y = getpary(win), x = getparx(win))
1099
1100 #define getsyx(y,x) do { if (newscr) { \
1101                              if (is_leaveok(newscr)) \
1102                                 (y) = (x) = -1; \
1103                              else \
1104                                  getyx(newscr,(y), (x)); \
1105                         } \
1106                     } while(0)
1107
1108 #define setsyx(y,x) do { if (newscr) { \
1109                             if ((y) == -1 && (x) == -1) \
1110                                 leaveok(newscr, TRUE); \
1111                             else { \
1112                                 leaveok(newscr, FALSE); \
1113                                 wmove(newscr, (y), (x)); \
1114                             } \
1115                         } \
1116                     } while(0)
1117
1118 #ifndef NCURSES_NOMACROS
1119
1120 /*
1121  * These miscellaneous pseudo functions are provided for compatibility:
1122  */
1123
1124 #define wgetstr(w, s)           wgetnstr(w, s, -1)
1125 #define getnstr(s, n)           wgetnstr(stdscr, s, (n))
1126
1127 #define setterm(term)           setupterm(term, 1, (int *)0)
1128
1129 #define fixterm()               reset_prog_mode()
1130 #define resetterm()             reset_shell_mode()
1131 #define saveterm()              def_prog_mode()
1132 #define crmode()                cbreak()
1133 #define nocrmode()              nocbreak()
1134 #define gettmode()
1135
1136 /* It seems older SYSV curses versions define these */
1137 #if !NCURSES_OPAQUE
1138 #define getattrs(win)           NCURSES_CAST(int, (win) ? (win)->_attrs : A_NORMAL)
1139 #define getcurx(win)            ((win) ? (win)->_curx : ERR)
1140 #define getcury(win)            ((win) ? (win)->_cury : ERR)
1141 #define getbegx(win)            ((win) ? (win)->_begx : ERR)
1142 #define getbegy(win)            ((win) ? (win)->_begy : ERR)
1143 #define getmaxx(win)            ((win) ? ((win)->_maxx + 1) : ERR)
1144 #define getmaxy(win)            ((win) ? ((win)->_maxy + 1) : ERR)
1145 #define getparx(win)            ((win) ? (win)->_parx : ERR)
1146 #define getpary(win)            ((win) ? (win)->_pary : ERR)
1147 #endif /* NCURSES_OPAQUE */
1148
1149 #define wstandout(win)          (wattrset(win,A_STANDOUT))
1150 #define wstandend(win)          (wattrset(win,A_NORMAL))
1151
1152 #define wattron(win,at)         wattr_on(win, NCURSES_CAST(attr_t, at), NULL)
1153 #define wattroff(win,at)        wattr_off(win, NCURSES_CAST(attr_t, at), NULL)
1154
1155 #if !NCURSES_OPAQUE
1156 #if NCURSES_WIDECHAR && @NCURSES_EXT_COLORS@
1157 #define wattrset(win,at)        ((win) \
1158                                   ? ((win)->_color = NCURSES_CAST(int, PAIR_NUMBER(at)), \
1159                                      (win)->_attrs = NCURSES_CAST(attr_t, at), \
1160                                      OK) \
1161                                   : ERR)
1162 #else
1163 #define wattrset(win,at)        ((win) \
1164                                   ? ((win)->_attrs = NCURSES_CAST(attr_t, at), \
1165                                      OK) \
1166                                   : ERR)
1167 #endif
1168 #endif /* NCURSES_OPAQUE */
1169
1170 #define scroll(win)             wscrl(win,1)
1171
1172 #define touchwin(win)           wtouchln((win), 0, getmaxy(win), 1)
1173 #define touchline(win, s, c)    wtouchln((win), s, c, 1)
1174 #define untouchwin(win)         wtouchln((win), 0, getmaxy(win), 0)
1175
1176 #define box(win, v, h)          wborder(win, v, v, h, h, 0, 0, 0, 0)
1177 #define border(ls, rs, ts, bs, tl, tr, bl, br)  wborder(stdscr, ls, rs, ts, bs, tl, tr, bl, br)
1178 #define hline(ch, n)            whline(stdscr, ch, (n))
1179 #define vline(ch, n)            wvline(stdscr, ch, (n))
1180
1181 #define winstr(w, s)            winnstr(w, s, -1)
1182 #define winchstr(w, s)          winchnstr(w, s, -1)
1183 #define winsstr(w, s)           winsnstr(w, s, -1)
1184
1185 #if !NCURSES_OPAQUE
1186 #define redrawwin(win)          wredrawln(win, 0, ((win) ? (win)->_maxy+1 : -1))
1187 #endif /* NCURSES_OPAQUE */
1188
1189 #define waddstr(win,str)        waddnstr(win,str,-1)
1190 #define waddchstr(win,str)      waddchnstr(win,str,-1)
1191
1192 /*
1193  * These apply to the first 256 color pairs.
1194  */
1195 #define COLOR_PAIR(n)   NCURSES_BITS((n), 0)
1196 #define PAIR_NUMBER(a)  (NCURSES_CAST(int,((NCURSES_CAST(unsigned long,(a)) & A_COLOR) >> NCURSES_ATTR_SHIFT)))
1197
1198 /*
1199  * pseudo functions for standard screen
1200  */
1201
1202 #define addch(ch)               waddch(stdscr,(ch))
1203 #define addchnstr(str,n)        waddchnstr(stdscr,(str),(n))
1204 #define addchstr(str)           waddchstr(stdscr,(str))
1205 #define addnstr(str,n)          waddnstr(stdscr,(str),(n))
1206 #define addstr(str)             waddnstr(stdscr,(str),-1)
1207 #define attroff(at)             wattroff(stdscr,(at))
1208 #define attron(at)              wattron(stdscr,(at))
1209 #define attrset(at)             wattrset(stdscr,(at))
1210 #define attr_get(ap,cp,o)       wattr_get(stdscr,(ap),(cp),(o))
1211 #define attr_off(a,o)           wattr_off(stdscr,(a),(o))
1212 #define attr_on(a,o)            wattr_on(stdscr,(a),(o))
1213 #define attr_set(a,c,o)         wattr_set(stdscr,(a),(c),(o))
1214 #define bkgd(ch)                wbkgd(stdscr,(ch))
1215 #define bkgdset(ch)             wbkgdset(stdscr,(ch))
1216 #define chgat(n,a,c,o)          wchgat(stdscr,(n),(a),(c),(o))
1217 #define clear()                 wclear(stdscr)
1218 #define clrtobot()              wclrtobot(stdscr)
1219 #define clrtoeol()              wclrtoeol(stdscr)
1220 #define color_set(c,o)          wcolor_set(stdscr,(c),(o))
1221 #define delch()                 wdelch(stdscr)
1222 #define deleteln()              winsdelln(stdscr,-1)
1223 #define echochar(c)             wechochar(stdscr,(c))
1224 #define erase()                 werase(stdscr)
1225 #define getch()                 wgetch(stdscr)
1226 #define getstr(str)             wgetstr(stdscr,(str))
1227 #define inch()                  winch(stdscr)
1228 #define inchnstr(s,n)           winchnstr(stdscr,(s),(n))
1229 #define inchstr(s)              winchstr(stdscr,(s))
1230 #define innstr(s,n)             winnstr(stdscr,(s),(n))
1231 #define insch(c)                winsch(stdscr,(c))
1232 #define insdelln(n)             winsdelln(stdscr,(n))
1233 #define insertln()              winsdelln(stdscr,1)
1234 #define insnstr(s,n)            winsnstr(stdscr,(s),(n))
1235 #define insstr(s)               winsstr(stdscr,(s))
1236 #define instr(s)                winstr(stdscr,(s))
1237 #define move(y,x)               wmove(stdscr,(y),(x))
1238 #define refresh()               wrefresh(stdscr)
1239 #define scrl(n)                 wscrl(stdscr,(n))
1240 #define setscrreg(t,b)          wsetscrreg(stdscr,(t),(b))
1241 #define standend()              wstandend(stdscr)
1242 #define standout()              wstandout(stdscr)
1243 #define timeout(delay)          wtimeout(stdscr,(delay))
1244 #define wdeleteln(win)          winsdelln(win,-1)
1245 #define winsertln(win)          winsdelln(win,1)
1246
1247 /*
1248  * mv functions
1249  */
1250
1251 #define mvwaddch(win,y,x,ch)            (wmove((win),(y),(x)) == ERR ? ERR : waddch((win),(ch)))
1252 #define mvwaddchnstr(win,y,x,str,n)     (wmove((win),(y),(x)) == ERR ? ERR : waddchnstr((win),(str),(n)))
1253 #define mvwaddchstr(win,y,x,str)        (wmove((win),(y),(x)) == ERR ? ERR : waddchnstr((win),(str),-1))
1254 #define mvwaddnstr(win,y,x,str,n)       (wmove((win),(y),(x)) == ERR ? ERR : waddnstr((win),(str),(n)))
1255 #define mvwaddstr(win,y,x,str)          (wmove((win),(y),(x)) == ERR ? ERR : waddnstr((win),(str),-1))
1256 #define mvwdelch(win,y,x)               (wmove((win),(y),(x)) == ERR ? ERR : wdelch(win))
1257 #define mvwchgat(win,y,x,n,a,c,o)       (wmove((win),(y),(x)) == ERR ? ERR : wchgat((win),(n),(a),(c),(o)))
1258 #define mvwgetch(win,y,x)               (wmove((win),(y),(x)) == ERR ? ERR : wgetch(win))
1259 #define mvwgetnstr(win,y,x,str,n)       (wmove((win),(y),(x)) == ERR ? ERR : wgetnstr((win),(str),(n)))
1260 #define mvwgetstr(win,y,x,str)          (wmove((win),(y),(x)) == ERR ? ERR : wgetstr((win),(str)))
1261 #define mvwhline(win,y,x,c,n)           (wmove((win),(y),(x)) == ERR ? ERR : whline((win),(c),(n)))
1262 #define mvwinch(win,y,x)                (wmove((win),(y),(x)) == ERR ? NCURSES_CAST(chtype, ERR) : winch(win))
1263 #define mvwinchnstr(win,y,x,s,n)        (wmove((win),(y),(x)) == ERR ? ERR : winchnstr((win),(s),(n)))
1264 #define mvwinchstr(win,y,x,s)           (wmove((win),(y),(x)) == ERR ? ERR : winchstr((win),(s)))
1265 #define mvwinnstr(win,y,x,s,n)          (wmove((win),(y),(x)) == ERR ? ERR : winnstr((win),(s),(n)))
1266 #define mvwinsch(win,y,x,c)             (wmove((win),(y),(x)) == ERR ? ERR : winsch((win),(c)))
1267 #define mvwinsnstr(win,y,x,s,n)         (wmove((win),(y),(x)) == ERR ? ERR : winsnstr((win),(s),(n)))
1268 #define mvwinsstr(win,y,x,s)            (wmove((win),(y),(x)) == ERR ? ERR : winsstr((win),(s)))
1269 #define mvwinstr(win,y,x,s)             (wmove((win),(y),(x)) == ERR ? ERR : winstr((win),(s)))
1270 #define mvwvline(win,y,x,c,n)           (wmove((win),(y),(x)) == ERR ? ERR : wvline((win),(c),(n)))
1271
1272 #define mvaddch(y,x,ch)                 mvwaddch(stdscr,(y),(x),(ch))
1273 #define mvaddchnstr(y,x,str,n)          mvwaddchnstr(stdscr,(y),(x),(str),(n))
1274 #define mvaddchstr(y,x,str)             mvwaddchstr(stdscr,(y),(x),(str))
1275 #define mvaddnstr(y,x,str,n)            mvwaddnstr(stdscr,(y),(x),(str),(n))
1276 #define mvaddstr(y,x,str)               mvwaddstr(stdscr,(y),(x),(str))
1277 #define mvchgat(y,x,n,a,c,o)            mvwchgat(stdscr,(y),(x),(n),(a),(c),(o))
1278 #define mvdelch(y,x)                    mvwdelch(stdscr,(y),(x))
1279 #define mvgetch(y,x)                    mvwgetch(stdscr,(y),(x))
1280 #define mvgetnstr(y,x,str,n)            mvwgetnstr(stdscr,(y),(x),(str),(n))
1281 #define mvgetstr(y,x,str)               mvwgetstr(stdscr,(y),(x),(str))
1282 #define mvhline(y,x,c,n)                mvwhline(stdscr,(y),(x),(c),(n))
1283 #define mvinch(y,x)                     mvwinch(stdscr,(y),(x))
1284 #define mvinchnstr(y,x,s,n)             mvwinchnstr(stdscr,(y),(x),(s),(n))
1285 #define mvinchstr(y,x,s)                mvwinchstr(stdscr,(y),(x),(s))
1286 #define mvinnstr(y,x,s,n)               mvwinnstr(stdscr,(y),(x),(s),(n))
1287 #define mvinsch(y,x,c)                  mvwinsch(stdscr,(y),(x),(c))
1288 #define mvinsnstr(y,x,s,n)              mvwinsnstr(stdscr,(y),(x),(s),(n))
1289 #define mvinsstr(y,x,s)                 mvwinsstr(stdscr,(y),(x),(s))
1290 #define mvinstr(y,x,s)                  mvwinstr(stdscr,(y),(x),(s))
1291 #define mvvline(y,x,c,n)                mvwvline(stdscr,(y),(x),(c),(n))
1292
1293 /*
1294  * Some wide-character functions can be implemented without the extensions.
1295  */
1296 #if !NCURSES_OPAQUE
1297 #define getbkgd(win)                    ((win) ? ((win)->_bkgd) : 0)
1298 #endif /* NCURSES_OPAQUE */
1299
1300 #define slk_attr_off(a,v)               ((v) ? ERR : slk_attroff(a))
1301 #define slk_attr_on(a,v)                ((v) ? ERR : slk_attron(a))
1302
1303 #if !NCURSES_OPAQUE
1304 #if NCURSES_WIDECHAR && @NCURSES_EXT_COLORS@
1305 #define wattr_set(win,a,p,opts)         (((win) \
1306                                           ? ((win)->_attrs = ((a) & ~A_COLOR), \
1307                                              (win)->_color = (p)) \
1308                                           : OK), \
1309                                          OK)
1310 #define wattr_get(win,a,p,opts)         ((void)(((a) != (void *)0) ? (*(a) = (win) ? (win)->_attrs : 0) : OK), \
1311                                          (void)(((p) != (void *)0) ? (*(p) = (NCURSES_PAIRS_T) ((win) ? (win)->_color : 0)) : OK), \
1312                                          OK)
1313 #else
1314 #define wattr_set(win,a,p,opts)         (((win) \
1315                                           ? ((win)->_attrs = (((a) & ~A_COLOR) | (attr_t)COLOR_PAIR(p))) \
1316                                           : OK), \
1317                                          OK)
1318 #define wattr_get(win,a,p,opts)         ((void)(((a) != (void *)0) ? (*(a) = (win) ? (win)->_attrs : 0) : OK), \
1319                                          (void)(((p) != (void *)0) ? (*(p) = (NCURSES_PAIRS_T) ((win) ? PAIR_NUMBER((win)->_attrs) : 0)) : OK), \
1320                                          OK)
1321 #endif
1322 #endif /* NCURSES_OPAQUE */
1323
1324 /*
1325  * X/Open curses deprecates SVr4 vwprintw/vwscanw, which are supposed to use
1326  * varargs.h.  It adds new calls vw_printw/vw_scanw, which are supposed to
1327  * use POSIX stdarg.h.  The ncurses versions of vwprintw/vwscanw already
1328  * use stdarg.h, so...
1329  */
1330 #define vw_printw               vwprintw
1331 #define vw_scanw                vwscanw
1332
1333 /*
1334  * Export fallback function for use in C++ binding.
1335  */
1336 #if !@HAVE_VSSCANF@
1337 #define vsscanf(a,b,c) _nc_vsscanf(a,b,c)
1338 NCURSES_EXPORT(int) vsscanf(const char *, const char *, va_list);
1339 #endif
1340
1341 /*
1342  * These macros are extensions - not in X/Open Curses.
1343  */
1344 #if @NCURSES_EXT_FUNCS@
1345 #if !NCURSES_OPAQUE
1346 #define is_cleared(win)         ((win) ? (win)->_clear : FALSE)
1347 #define is_idcok(win)           ((win) ? (win)->_idcok : FALSE)
1348 #define is_idlok(win)           ((win) ? (win)->_idlok : FALSE)
1349 #define is_immedok(win)         ((win) ? (win)->_immed : FALSE)
1350 #define is_keypad(win)          ((win) ? (win)->_use_keypad : FALSE)
1351 #define is_leaveok(win)         ((win) ? (win)->_leaveok : FALSE)
1352 #define is_nodelay(win)         ((win) ? ((win)->_delay == 0) : FALSE)
1353 #define is_notimeout(win)       ((win) ? (win)->_notimeout : FALSE)
1354 #define is_pad(win)             ((win) ? ((win)->_flags & _ISPAD) != 0 : FALSE)
1355 #define is_scrollok(win)        ((win) ? (win)->_scroll : FALSE)
1356 #define is_subwin(win)          ((win) ? ((win)->_flags & _SUBWIN) != 0 : FALSE)
1357 #define is_syncok(win)          ((win) ? (win)->_sync : FALSE)
1358 #define wgetdelay(win)          ((win) ? (win)->_delay : 0)
1359 #define wgetparent(win)         ((win) ? (win)->_parent : 0)
1360 #define wgetscrreg(win,t,b)     ((win) ? (*(t) = (win)->_regtop, *(b) = (win)->_regbottom, OK) : ERR)
1361 #endif
1362 #endif
1363
1364 #endif /* NCURSES_NOMACROS */
1365
1366 /*
1367  * Public variables.
1368  *
1369  * Notes:
1370  *      a. ESCDELAY was an undocumented feature under AIX curses.
1371  *         It gives the ESC expire time in milliseconds.
1372  *      b. ttytype is needed for backward compatibility
1373  */
1374 #if NCURSES_REENTRANT
1375
1376 NCURSES_WRAPPED_VAR(WINDOW *, curscr);
1377 NCURSES_WRAPPED_VAR(WINDOW *, newscr);
1378 NCURSES_WRAPPED_VAR(WINDOW *, stdscr);
1379 NCURSES_WRAPPED_VAR(char *, ttytype);
1380 NCURSES_WRAPPED_VAR(int, COLORS);
1381 NCURSES_WRAPPED_VAR(int, COLOR_PAIRS);
1382 NCURSES_WRAPPED_VAR(int, COLS);
1383 NCURSES_WRAPPED_VAR(int, ESCDELAY);
1384 NCURSES_WRAPPED_VAR(int, LINES);
1385 NCURSES_WRAPPED_VAR(int, TABSIZE);
1386
1387 #define curscr      NCURSES_PUBLIC_VAR(curscr())
1388 #define newscr      NCURSES_PUBLIC_VAR(newscr())
1389 #define stdscr      NCURSES_PUBLIC_VAR(stdscr())
1390 #define ttytype     NCURSES_PUBLIC_VAR(ttytype())
1391 #define COLORS      NCURSES_PUBLIC_VAR(COLORS())
1392 #define COLOR_PAIRS NCURSES_PUBLIC_VAR(COLOR_PAIRS())
1393 #define COLS        NCURSES_PUBLIC_VAR(COLS())
1394 #define ESCDELAY    NCURSES_PUBLIC_VAR(ESCDELAY())
1395 #define LINES       NCURSES_PUBLIC_VAR(LINES())
1396 #define TABSIZE     NCURSES_PUBLIC_VAR(TABSIZE())
1397
1398 #else
1399
1400 extern NCURSES_EXPORT_VAR(WINDOW *) curscr;
1401 extern NCURSES_EXPORT_VAR(WINDOW *) newscr;
1402 extern NCURSES_EXPORT_VAR(WINDOW *) stdscr;
1403 extern NCURSES_EXPORT_VAR(char) ttytype[];
1404 extern NCURSES_EXPORT_VAR(int) COLORS;
1405 extern NCURSES_EXPORT_VAR(int) COLOR_PAIRS;
1406 extern NCURSES_EXPORT_VAR(int) COLS;
1407 extern NCURSES_EXPORT_VAR(int) ESCDELAY;
1408 extern NCURSES_EXPORT_VAR(int) LINES;
1409 extern NCURSES_EXPORT_VAR(int) TABSIZE;
1410
1411 #endif
1412
1413 /*
1414  * Pseudo-character tokens outside ASCII range.  The curses wgetch() function
1415  * will return any given one of these only if the corresponding k- capability
1416  * is defined in your terminal's terminfo entry.
1417  *
1418  * Some keys (KEY_A1, etc) are arranged like this:
1419  *      a1     up    a3
1420  *      left   b2    right
1421  *      c1     down  c3
1422  *
1423  * A few key codes do not depend upon the terminfo entry.
1424  */
1425 #define KEY_CODE_YES    0400            /* A wchar_t contains a key code */
1426 #define KEY_MIN         0401            /* Minimum curses key */
1427 #define KEY_BREAK       0401            /* Break key (unreliable) */
1428 #define KEY_SRESET      0530            /* Soft (partial) reset (unreliable) */
1429 #define KEY_RESET       0531            /* Reset or hard reset (unreliable) */