include/curses.h.in

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