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