include/curses.h.in

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