include/curses.h.in

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