include/curses.h.in

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