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