include/curses.h.in

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