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