include/curses.h.in

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