1 /****************************************************************************
2 * Copyright (c) 1998-2006,2007 Free Software Foundation, Inc. *
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: *
12 * The above copyright notice and this permission notice shall be included *
13 * in all copies or substantial portions of the Software. *
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. *
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 *
27 ****************************************************************************/
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 ****************************************************************************/
35 /* $Id: curses.h.in,v 1.170 2007/03/10 18:15:33 tom Exp $ */
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
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@
54 /* This is defined in more than one ncurses header, for identification */
55 #undef NCURSES_VERSION
56 #define NCURSES_VERSION "@NCURSES_MAJOR@.@NCURSES_MINOR@"
59 * Identify the mouse encoding version.
61 #define NCURSES_MOUSE_VERSION @NCURSES_MOUSE_VERSION@
64 * Definitions to facilitate DLL's.
66 #include <ncurses_dll.h>
69 * User-definable tweak to disable the include of <stdbool.h>.
71 #ifndef NCURSES_ENABLE_STDBOOL_H
72 #define NCURSES_ENABLE_STDBOOL_H @cf_cv_header_stdbool_h@
76 * NCURSES_ATTR_T is used to quiet compiler warnings when building ncurses
77 * configured using --disable-macros.
79 #ifdef NCURSES_NOMACROS
80 #ifndef NCURSES_ATTR_T
81 #define NCURSES_ATTR_T attr_t
83 #endif /* NCURSES_NOMACROS */
85 #ifndef NCURSES_ATTR_T
86 #define NCURSES_ATTR_T int
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.
94 #define NCURSES_CONST @NCURSES_CONST@
97 #define NCURSES_INLINE @NCURSES_INLINE@
100 * The internal type used for color values
102 #undef NCURSES_COLOR_T
103 #define NCURSES_COLOR_T short
106 * Definition used to make WINDOW and similar structs opaque.
108 #ifndef @cf_cv_enable_opaque@
109 #define NCURSES_OPAQUE @NCURSES_OPAQUE@
113 * The internal type used for window dimensions.
115 #undef NCURSES_SIZE_T
116 #define NCURSES_SIZE_T @NCURSES_SIZE_T@
119 * Control whether tparm() supports varargs or fixed-parameter list.
121 #undef NCURSES_TPARM_VARARGS
122 #define NCURSES_TPARM_VARARGS @NCURSES_TPARM_VARARGS@
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.
130 #define NCURSES_CH_T @NCURSES_CH_T@
132 #if @cf_cv_enable_lp64@ && defined(_LP64)
133 typedef unsigned chtype;
134 typedef unsigned mmask_t;
136 typedef unsigned @cf_cv_typeof_chtype@ chtype;
137 typedef unsigned @cf_cv_typeof_mmask_t@ mmask_t;
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 */
147 /* XSI and SVr4 specify that curses implements 'bool'. However, C++ may also
148 * implement it. If so, we must use the C++ compiler's type to avoid conflict
149 * with other interfaces.
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++.
165 typedef @cf_cv_type_of_bool@ NCURSES_BOOL;
167 #if @USE_CXX_BOOL@ /* __cplusplus, etc. */
169 /* use the C++ compiler's bool type */
170 #define NCURSES_BOOL bool
172 #else /* c89, c99, etc. */
174 #if NCURSES_ENABLE_STDBOOL_H
176 /* use whatever the C compiler decides bool really is */
177 #define NCURSES_BOOL bool
179 /* there is no predefined bool - use our own */
181 #define bool NCURSES_BOOL
184 #endif /* !__cplusplus, etc. */
188 #define NCURSES_CAST(type,value) static_cast<type>(value)
190 #define NCURSES_CAST(type,value) (type)(value)
194 * XSI attributes. In the ncurses implementation, they are identical to the
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
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
211 #define WA_RIGHT A_RIGHT
213 #define WA_VERTICAL A_VERTICAL
216 #define COLOR_BLACK 0
218 #define COLOR_GREEN 2
219 #define COLOR_YELLOW 3
221 #define COLOR_MAGENTA 5
223 #define COLOR_WHITE 7
227 #if @BROKEN_LINKER@ || @cf_cv_enable_reentrant@
228 NCURSES_WRAPPED_VAR(chtype*, acs_map);
229 #define acs_map (_nc_acs_map())
231 extern NCURSES_EXPORT_VAR(chtype) acs_map[];
234 #define NCURSES_ACS(c) (acs_map[NCURSES_CAST(unsigned char,c)])
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 */
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.
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 */
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.
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
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 */
310 * this value is used in the firstchar and lastchar fields to mark
316 * this value is used in the oldindex field to mark lines created by insertions
321 typedef struct screen SCREEN;
322 typedef struct _win_st WINDOW;
324 typedef chtype attr_t; /* ...must be at least as wide as chtype */
326 #ifdef _XOPEN_SOURCE_EXTENDED
328 #if @NCURSES_LIBUTF8@
329 #ifdef mblen /* libutf8.h defines it w/o undefining first */
336 #include <wchar.h> /* ...to get mbstate_t, etc. */
339 #if @NCURSES_WCHAR_T@
340 typedef unsigned short wchar_t@NCURSES_OK_WCHAR_T@;
344 typedef unsigned int wint_t@NCURSES_OK_WCHAR_T@;
351 wchar_t chars[CCHARW_MAX];
352 #if @NCURSES_EXT_COLORS@
353 int ext_color; /* color pair, must be more than 16-bits */
358 #endif /* _XOPEN_SOURCE_EXTENDED */
365 NCURSES_SIZE_T _cury, _curx; /* current cursor position */
367 /* window location and size */
368 NCURSES_SIZE_T _maxy, _maxx; /* maximums of x and y, NOT window size */
369 NCURSES_SIZE_T _begy, _begx; /* screen coords of upper-left-hand corner */
371 short _flags; /* window state flags */
373 /* attribute tracking */
374 attr_t _attrs; /* current attribute for non-space character */
375 chtype _bkgd; /* current background char/attribute pair */
377 /* option values set by user */
378 bool _notimeout; /* no time out on function-key entry? */
379 bool _clear; /* consider all data in the window invalid? */
380 bool _leaveok; /* OK to not reset cursor on exit? */
381 bool _scroll; /* OK to scroll this window? */
382 bool _idlok; /* OK to use insert/delete line? */
383 bool _idcok; /* OK to use insert/delete char? */
384 bool _immed; /* window in immed mode? (not yet used) */
385 bool _sync; /* window in sync mode? */
386 bool _use_keypad; /* process function keys into KEY_ symbols? */
387 int _delay; /* 0 = nodelay, <0 = blocking, >0 = delay */
389 struct ldat *_line; /* the actual line data */
391 /* global screen state */
392 NCURSES_SIZE_T _regtop; /* top line of scrolling region */
393 NCURSES_SIZE_T _regbottom; /* bottom line of scrolling region */
395 /* these are used only if this is a sub-window */
396 int _parx; /* x coordinate of this window in parent */
397 int _pary; /* y coordinate of this window in parent */
398 WINDOW *_parent; /* pointer to parent if a sub-window */
400 /* these are used only if this is a pad */
403 NCURSES_SIZE_T _pad_y, _pad_x;
404 NCURSES_SIZE_T _pad_top, _pad_left;
405 NCURSES_SIZE_T _pad_bottom, _pad_right;
408 NCURSES_SIZE_T _yoffset; /* real begy is _begy + _yoffset */
410 #ifdef _XOPEN_SOURCE_EXTENDED
411 cchar_t _bkgrnd; /* current background char/attribute pair */
412 #if @NCURSES_EXT_COLORS@
413 int _color; /* current color-pair for non-space character */
417 #endif /* NCURSES_OPAQUE */
420 * These functions are extensions - not in XSI Curses.
422 #if @NCURSES_EXT_FUNCS@
423 extern NCURSES_EXPORT(bool) is_term_resized (int, int);
424 extern NCURSES_EXPORT(char *) keybound (int, int);
425 extern NCURSES_EXPORT(const char *) curses_version (void);
426 extern NCURSES_EXPORT(int) assume_default_colors (int, int);
427 extern NCURSES_EXPORT(int) define_key (const char *, int);
428 extern NCURSES_EXPORT(int) key_defined (const char *);
429 extern NCURSES_EXPORT(int) keyok (int, bool);
430 extern NCURSES_EXPORT(int) resize_term (int, int);
431 extern NCURSES_EXPORT(int) resizeterm (int, int);
432 extern NCURSES_EXPORT(int) use_default_colors (void);
433 extern NCURSES_EXPORT(int) use_extended_names (bool);
434 extern NCURSES_EXPORT(int) use_legacy_coding (int);
435 extern NCURSES_EXPORT(int) wresize (WINDOW *, int, int);
436 extern NCURSES_EXPORT(void) nofilter(void);
438 #define curses_version() NCURSES_VERSION
442 * This is an extension to support events...
444 #if @NCURSES_EXT_FUNCS@
445 #ifdef NCURSES_WGETCH_EVENTS
446 #if !defined(__BEOS__) /* Fix _nc_timed_wait() on BEOS... */
447 # define NCURSES_EVENT_VERSION 1
448 #endif /* !defined(__BEOS__) */
451 * Bits to set in _nc_event.data.flags
453 # define _NC_EVENT_TIMEOUT_MSEC 1
454 # define _NC_EVENT_FILE 2
455 # define _NC_EVENT_FILE_READABLE 2
456 # if 0 /* Not supported yet... */
457 # define _NC_EVENT_FILE_WRITABLE 4
458 # define _NC_EVENT_FILE_EXCEPTION 8
466 long timeout_msec; /* _NC_EVENT_TIMEOUT_MSEC */
472 } fev; /* _NC_EVENT_FILE */
479 int result_flags; /* _NC_EVENT_TIMEOUT_MSEC or _NC_EVENT_FILE_READABLE */
480 _nc_event *events[1];
483 extern NCURSES_EXPORT(int) wgetch_events(WINDOW *, _nc_eventlist *); /* experimental */
484 extern NCURSES_EXPORT(int) wgetnstr_events(WINDOW *,char *,int,_nc_eventlist *);/* experimental */
486 #endif /* NCURSES_WGETCH_EVENTS */
487 #endif /* NCURSES_EXT_FUNCS */
490 * GCC (and some other compilers) define '__attribute__'; we're using this
491 * macro to alert the compiler to flag inconsistencies in printf/scanf-like
492 * function calls. Just in case '__attribute__' isn't defined, make a dummy.
493 * Old versions of G++ do not accept it anyway, at least not consistently with
496 #if !(defined(__GNUC__) || defined(__GNUG__) || defined(__attribute__))
497 #define __attribute__(p) /* nothing */
501 * We cannot define these in ncurses_cfg.h, since they require parameters to be
502 * passed (that is non-portable). If you happen to be using gcc with warnings
506 * to improve checking of calls to printw(), etc.
508 #ifndef GCC_PRINTFLIKE
509 #if defined(GCC_PRINTF) && !defined(printf)
510 #define GCC_PRINTFLIKE(fmt,var) __attribute__((format(printf,fmt,var)))
512 #define GCC_PRINTFLIKE(fmt,var) /*nothing*/
516 #ifndef GCC_SCANFLIKE
517 #if defined(GCC_SCANF) && !defined(scanf)
518 #define GCC_SCANFLIKE(fmt,var) __attribute__((format(scanf,fmt,var)))
520 #define GCC_SCANFLIKE(fmt,var) /*nothing*/
525 #define GCC_NORETURN /* nothing */
529 #define GCC_UNUSED /* nothing */
533 * Function prototypes. This is the complete XSI Curses list of required
534 * functions. Those marked `generated' will have sources generated from the
535 * macro definitions later in this file, in order to satisfy XPG4.2
539 extern NCURSES_EXPORT(int) addch (const chtype); /* generated */
540 extern NCURSES_EXPORT(int) addchnstr (const chtype *, int); /* generated */
541 extern NCURSES_EXPORT(int) addchstr (const chtype *); /* generated */
542 extern NCURSES_EXPORT(int) addnstr (const char *, int); /* generated */
543 extern NCURSES_EXPORT(int) addstr (const char *); /* generated */
544 extern NCURSES_EXPORT(int) attroff (NCURSES_ATTR_T); /* generated */
545 extern NCURSES_EXPORT(int) attron (NCURSES_ATTR_T); /* generated */
546 extern NCURSES_EXPORT(int) attrset (NCURSES_ATTR_T); /* generated */
547 extern NCURSES_EXPORT(int) attr_get (attr_t *, short *, void *); /* generated */
548 extern NCURSES_EXPORT(int) attr_off (attr_t, void *); /* generated */
549 extern NCURSES_EXPORT(int) attr_on (attr_t, void *); /* generated */
550 extern NCURSES_EXPORT(int) attr_set (attr_t, short, void *); /* generated */
551 extern NCURSES_EXPORT(int) baudrate (void); /* implemented */
552 extern NCURSES_EXPORT(int) beep (void); /* implemented */
553 extern NCURSES_EXPORT(int) bkgd (chtype); /* generated */
554 extern NCURSES_EXPORT(void) bkgdset (chtype); /* generated */
555 extern NCURSES_EXPORT(int) border (chtype,chtype,chtype,chtype,chtype,chtype,chtype,chtype); /* generated */
556 extern NCURSES_EXPORT(int) box (WINDOW *, chtype, chtype); /* generated */
557 extern NCURSES_EXPORT(bool) can_change_color (void); /* implemented */
558 extern NCURSES_EXPORT(int) cbreak (void); /* implemented */
559 extern NCURSES_EXPORT(int) chgat (int, attr_t, short, const void *); /* generated */
560 extern NCURSES_EXPORT(int) clear (void); /* generated */
561 extern NCURSES_EXPORT(int) clearok (WINDOW *,bool); /* implemented */
562 extern NCURSES_EXPORT(int) clrtobot (void); /* generated */
563 extern NCURSES_EXPORT(int) clrtoeol (void); /* generated */
564 extern NCURSES_EXPORT(int) color_content (short,short*,short*,short*); /* implemented */
565 extern NCURSES_EXPORT(int) color_set (short,void*); /* generated */
566 extern NCURSES_EXPORT(int) COLOR_PAIR (int); /* generated */
567 extern NCURSES_EXPORT(int) copywin (const WINDOW*,WINDOW*,int,int,int,int,int,int,int); /* implemented */
568 extern NCURSES_EXPORT(int) curs_set (int); /* implemented */
569 extern NCURSES_EXPORT(int) def_prog_mode (void); /* implemented */
570 extern NCURSES_EXPORT(int) def_shell_mode (void); /* implemented */
571 extern NCURSES_EXPORT(int) delay_output (int); /* implemented */
572 extern NCURSES_EXPORT(int) delch (void); /* generated */
573 extern NCURSES_EXPORT(void) delscreen (SCREEN *); /* implemented */
574 extern NCURSES_EXPORT(int) delwin (WINDOW *); /* implemented */
575 extern NCURSES_EXPORT(int) deleteln (void); /* generated */
576 extern NCURSES_EXPORT(WINDOW *) derwin (WINDOW *,int,int,int,int); /* implemented */
577 extern NCURSES_EXPORT(int) doupdate (void); /* implemented */
578 extern NCURSES_EXPORT(WINDOW *) dupwin (WINDOW *); /* implemented */
579 extern NCURSES_EXPORT(int) echo (void); /* implemented */
580 extern NCURSES_EXPORT(int) echochar (const chtype); /* generated */
581 extern NCURSES_EXPORT(int) erase (void); /* generated */
582 extern NCURSES_EXPORT(int) endwin (void); /* implemented */
583 extern NCURSES_EXPORT(char) erasechar (void); /* implemented */
584 extern NCURSES_EXPORT(void) filter (void); /* implemented */
585 extern NCURSES_EXPORT(int) flash (void); /* implemented */
586 extern NCURSES_EXPORT(int) flushinp (void); /* implemented */
587 extern NCURSES_EXPORT(chtype) getbkgd (WINDOW *); /* generated */
588 extern NCURSES_EXPORT(int) getch (void); /* generated */
589 extern NCURSES_EXPORT(int) getnstr (char *, int); /* generated */
590 extern NCURSES_EXPORT(int) getstr (char *); /* generated */
591 extern NCURSES_EXPORT(WINDOW *) getwin (FILE *); /* implemented */
592 extern NCURSES_EXPORT(int) halfdelay (int); /* implemented */
593 extern NCURSES_EXPORT(bool) has_colors (void); /* implemented */
594 extern NCURSES_EXPORT(bool) has_ic (void); /* implemented */
595 extern NCURSES_EXPORT(bool) has_il (void); /* implemented */
596 extern NCURSES_EXPORT(int) hline (chtype, int); /* generated */
597 extern NCURSES_EXPORT(void) idcok (WINDOW *, bool); /* implemented */
598 extern NCURSES_EXPORT(int) idlok (WINDOW *, bool); /* implemented */
599 extern NCURSES_EXPORT(void) immedok (WINDOW *, bool); /* implemented */
600 extern NCURSES_EXPORT(chtype) inch (void); /* generated */
601 extern NCURSES_EXPORT(int) inchnstr (chtype *, int); /* generated */
602 extern NCURSES_EXPORT(int) inchstr (chtype *); /* generated */
603 extern NCURSES_EXPORT(WINDOW *) initscr (void); /* implemented */
604 extern NCURSES_EXPORT(int) init_color (short,short,short,short); /* implemented */
605 extern NCURSES_EXPORT(int) init_pair (short,short,short); /* implemented */
606 extern NCURSES_EXPORT(int) innstr (char *, int); /* generated */
607 extern NCURSES_EXPORT(int) insch (chtype); /* generated */
608 extern NCURSES_EXPORT(int) insdelln (int); /* generated */
609 extern NCURSES_EXPORT(int) insertln (void); /* generated */
610 extern NCURSES_EXPORT(int) insnstr (const char *, int); /* generated */
611 extern NCURSES_EXPORT(int) insstr (const char *); /* generated */
612 extern NCURSES_EXPORT(int) instr (char *); /* generated */
613 extern NCURSES_EXPORT(int) intrflush (WINDOW *,bool); /* implemented */
614 extern NCURSES_EXPORT(bool) isendwin (void); /* implemented */
615 extern NCURSES_EXPORT(bool) is_linetouched (WINDOW *,int); /* implemented */
616 extern NCURSES_EXPORT(bool) is_wintouched (WINDOW *); /* implemented */
617 extern NCURSES_EXPORT(NCURSES_CONST char *) keyname (int); /* implemented */
618 extern NCURSES_EXPORT(int) keypad (WINDOW *,bool); /* implemented */
619 extern NCURSES_EXPORT(char) killchar (void); /* implemented */
620 extern NCURSES_EXPORT(int) leaveok (WINDOW *,bool); /* implemented */
621 extern NCURSES_EXPORT(char *) longname (void); /* implemented */
622 extern NCURSES_EXPORT(int) meta (WINDOW *,bool); /* implemented */
623 extern NCURSES_EXPORT(int) move (int, int); /* generated */
624 extern NCURSES_EXPORT(int) mvaddch (int, int, const chtype); /* generated */
625 extern NCURSES_EXPORT(int) mvaddchnstr (int, int, const chtype *, int); /* generated */
626 extern NCURSES_EXPORT(int) mvaddchstr (int, int, const chtype *); /* generated */
627 extern NCURSES_EXPORT(int) mvaddnstr (int, int, const char *, int); /* generated */
628 extern NCURSES_EXPORT(int) mvaddstr (int, int, const char *); /* generated */
629 extern NCURSES_EXPORT(int) mvchgat (int, int, int, attr_t, short, const void *); /* generated */
630 extern NCURSES_EXPORT(int) mvcur (int,int,int,int); /* implemented */
631 extern NCURSES_EXPORT(int) mvdelch (int, int); /* generated */
632 extern NCURSES_EXPORT(int) mvderwin (WINDOW *, int, int); /* implemented */
633 extern NCURSES_EXPORT(int) mvgetch (int, int); /* generated */
634 extern NCURSES_EXPORT(int) mvgetnstr (int, int, char *, int); /* generated */
635 extern NCURSES_EXPORT(int) mvgetstr (int, int, char *); /* generated */
636 extern NCURSES_EXPORT(int) mvhline (int, int, chtype, int); /* generated */
637 extern NCURSES_EXPORT(chtype) mvinch (int, int); /* generated */
638 extern NCURSES_EXPORT(int) mvinchnstr (int, int, chtype *, int); /* generated */
639 extern NCURSES_EXPORT(int) mvinchstr (int, int, chtype *); /* generated */
640 extern NCURSES_EXPORT(int) mvinnstr (int, int, char *, int); /* generated */
641 extern NCURSES_EXPORT(int) mvinsch (int, int, chtype); /* generated */
642 extern NCURSES_EXPORT(int) mvinsnstr (int, int, const char *, int); /* generated */
643 extern NCURSES_EXPORT(int) mvinsstr (int, int, const char *); /* generated */
644 extern NCURSES_EXPORT(int) mvinstr (int, int, char *); /* generated */
645 extern NCURSES_EXPORT(int) mvprintw (int,int, const char *,...) /* implemented */
647 extern NCURSES_EXPORT(int) mvscanw (int,int, NCURSES_CONST char *,...) /* implemented */
649 extern NCURSES_EXPORT(int) mvvline (int, int, chtype, int); /* generated */
650 extern NCURSES_EXPORT(int) mvwaddch (WINDOW *, int, int, const chtype); /* generated */
651 extern NCURSES_EXPORT(int) mvwaddchnstr (WINDOW *, int, int, const chtype *, int);/* generated */
652 extern NCURSES_EXPORT(int) mvwaddchstr (WINDOW *, int, int, const chtype *); /* generated */
653 extern NCURSES_EXPORT(int) mvwaddnstr (WINDOW *, int, int, const char *, int); /* generated */
654 extern NCURSES_EXPORT(int) mvwaddstr (WINDOW *, int, int, const char *); /* generated */
655 extern NCURSES_EXPORT(int) mvwchgat (WINDOW *, int, int, int, attr_t, short, const void *);/* generated */
656 extern NCURSES_EXPORT(int) mvwdelch (WINDOW *, int, int); /* generated */
657 extern NCURSES_EXPORT(int) mvwgetch (WINDOW *, int, int); /* generated */
658 extern NCURSES_EXPORT(int) mvwgetnstr (WINDOW *, int, int, char *, int); /* generated */
659 extern NCURSES_EXPORT(int) mvwgetstr (WINDOW *, int, int, char *); /* generated */
660 extern NCURSES_EXPORT(int) mvwhline (WINDOW *, int, int, chtype, int); /* generated */
661 extern NCURSES_EXPORT(int) mvwin (WINDOW *,int,int); /* implemented */
662 extern NCURSES_EXPORT(chtype) mvwinch (WINDOW *, int, int); /* generated */
663 extern NCURSES_EXPORT(int) mvwinchnstr (WINDOW *, int, int, chtype *, int); /* generated */
664 extern NCURSES_EXPORT(int) mvwinchstr (WINDOW *, int, int, chtype *); /* generated */
665 extern NCURSES_EXPORT(int) mvwinnstr (WINDOW *, int, int, char *, int); /* generated */
666 extern NCURSES_EXPORT(int) mvwinsch (WINDOW *, int, int, chtype); /* generated */
667 extern NCURSES_EXPORT(int) mvwinsnstr (WINDOW *, int, int, const char *, int); /* generated */
668 extern NCURSES_EXPORT(int) mvwinsstr (WINDOW *, int, int, const char *); /* generated */
669 extern NCURSES_EXPORT(int) mvwinstr (WINDOW *, int, int, char *); /* generated */
670 extern NCURSES_EXPORT(int) mvwprintw (WINDOW*,int,int, const char *,...) /* implemented */
672 extern NCURSES_EXPORT(int) mvwscanw (WINDOW *,int,int, NCURSES_CONST char *,...) /* implemented */
674 extern NCURSES_EXPORT(int) mvwvline (WINDOW *,int, int, chtype, int); /* generated */
675 extern NCURSES_EXPORT(int) napms (int); /* implemented */
676 extern NCURSES_EXPORT(WINDOW *) newpad (int,int); /* implemented */
677 extern NCURSES_EXPORT(SCREEN *) newterm (NCURSES_CONST char *,FILE *,FILE *); /* implemented */
678 extern NCURSES_EXPORT(WINDOW *) newwin (int,int,int,int); /* implemented */
679 extern NCURSES_EXPORT(int) nl (void); /* implemented */
680 extern NCURSES_EXPORT(int) nocbreak (void); /* implemented */
681 extern NCURSES_EXPORT(int) nodelay (WINDOW *,bool); /* implemented */
682 extern NCURSES_EXPORT(int) noecho (void); /* implemented */
683 extern NCURSES_EXPORT(int) nonl (void); /* implemented */
684 extern NCURSES_EXPORT(void) noqiflush (void); /* implemented */
685 extern NCURSES_EXPORT(int) noraw (void); /* implemented */
686 extern NCURSES_EXPORT(int) notimeout (WINDOW *,bool); /* implemented */
687 extern NCURSES_EXPORT(int) overlay (const WINDOW*,WINDOW *); /* implemented */
688 extern NCURSES_EXPORT(int) overwrite (const WINDOW*,WINDOW *); /* implemented */
689 extern NCURSES_EXPORT(int) pair_content (short,short*,short*); /* implemented */
690 extern NCURSES_EXPORT(int) PAIR_NUMBER (int); /* generated */
691 extern NCURSES_EXPORT(int) pechochar (WINDOW *, const chtype); /* implemented */
692 extern NCURSES_EXPORT(int) pnoutrefresh (WINDOW*,int,int,int,int,int,int);/* implemented */
693 extern NCURSES_EXPORT(int) prefresh (WINDOW *,int,int,int,int,int,int); /* implemented */
694 extern NCURSES_EXPORT(int) printw (const char *,...) /* implemented */
696 extern NCURSES_EXPORT(int) putwin (WINDOW *, FILE *); /* implemented */
697 extern NCURSES_EXPORT(void) qiflush (void); /* implemented */
698 extern NCURSES_EXPORT(int) raw (void); /* implemented */
699 extern NCURSES_EXPORT(int) redrawwin (WINDOW *); /* generated */
700 extern NCURSES_EXPORT(int) refresh (void); /* generated */
701 extern NCURSES_EXPORT(int) resetty (void); /* implemented */
702 extern NCURSES_EXPORT(int) reset_prog_mode (void); /* implemented */
703 extern NCURSES_EXPORT(int) reset_shell_mode (void); /* implemented */
704 extern NCURSES_EXPORT(int) ripoffline (int, int (*)(WINDOW *, int)); /* implemented */
705 extern NCURSES_EXPORT(int) savetty (void); /* implemented */
706 extern NCURSES_EXPORT(int) scanw (NCURSES_CONST char *,...) /* implemented */
708 extern NCURSES_EXPORT(int) scr_dump (const char *); /* implemented */
709 extern NCURSES_EXPORT(int) scr_init (const char *); /* implemented */
710 extern NCURSES_EXPORT(int) scrl (int); /* generated */
711 extern NCURSES_EXPORT(int) scroll (WINDOW *); /* generated */
712 extern NCURSES_EXPORT(int) scrollok (WINDOW *,bool); /* implemented */
713 extern NCURSES_EXPORT(int) scr_restore (const char *); /* implemented */
714 extern NCURSES_EXPORT(int) scr_set (const char *); /* implemented */
715 extern NCURSES_EXPORT(int) setscrreg (int,int); /* generated */
716 extern NCURSES_EXPORT(SCREEN *) set_term (SCREEN *); /* implemented */
717 extern NCURSES_EXPORT(int) slk_attroff (const chtype); /* implemented */
718 extern NCURSES_EXPORT(int) slk_attr_off (const attr_t, void *); /* generated:WIDEC */
719 extern NCURSES_EXPORT(int) slk_attron (const chtype); /* implemented */
720 extern NCURSES_EXPORT(int) slk_attr_on (attr_t,void*); /* generated:WIDEC */
721 extern NCURSES_EXPORT(int) slk_attrset (const chtype); /* implemented */
722 extern NCURSES_EXPORT(attr_t) slk_attr (void); /* implemented */
723 extern NCURSES_EXPORT(int) slk_attr_set (const attr_t,short,void*); /* implemented */
724 extern NCURSES_EXPORT(int) slk_clear (void); /* implemented */
725 extern NCURSES_EXPORT(int) slk_color (short); /* implemented */
726 extern NCURSES_EXPORT(int) slk_init (int); /* implemented */
727 extern NCURSES_EXPORT(char *) slk_label (int); /* implemented */
728 extern NCURSES_EXPORT(int) slk_noutrefresh (void); /* implemented */
729 extern NCURSES_EXPORT(int) slk_refresh (void); /* implemented */
730 extern NCURSES_EXPORT(int) slk_restore (void); /* implemented */
731 extern NCURSES_EXPORT(int) slk_set (int,const char *,int); /* implemented */
732 extern NCURSES_EXPORT(int) slk_touch (void); /* implemented */
733 extern NCURSES_EXPORT(int) standout (void); /* generated */
734 extern NCURSES_EXPORT(int) standend (void); /* generated */
735 extern NCURSES_EXPORT(int) start_color (void); /* implemented */
736 extern NCURSES_EXPORT(WINDOW *) subpad (WINDOW *, int, int, int, int); /* implemented */
737 extern NCURSES_EXPORT(WINDOW *) subwin (WINDOW *,int,int,int,int); /* implemented */
738 extern NCURSES_EXPORT(int) syncok (WINDOW *, bool); /* implemented */
739 extern NCURSES_EXPORT(chtype) termattrs (void); /* implemented */
740 extern NCURSES_EXPORT(char *) termname (void); /* implemented */
741 extern NCURSES_EXPORT(void) timeout (int); /* generated */
742 extern NCURSES_EXPORT(int) touchline (WINDOW *, int, int); /* generated */
743 extern NCURSES_EXPORT(int) touchwin (WINDOW *); /* generated */
744 extern NCURSES_EXPORT(int) typeahead (int); /* implemented */
745 extern NCURSES_EXPORT(int) ungetch (int); /* implemented */
746 extern NCURSES_EXPORT(int) untouchwin (WINDOW *); /* generated */
747 extern NCURSES_EXPORT(void) use_env (bool); /* implemented */
748 extern NCURSES_EXPORT(int) vidattr (chtype); /* implemented */
749 extern NCURSES_EXPORT(int) vidputs (chtype, int (*)(int)); /* implemented */
750 extern NCURSES_EXPORT(int) vline (chtype, int); /* generated */
751 extern NCURSES_EXPORT(int) vwprintw (WINDOW *, const char *,va_list); /* implemented */
752 extern NCURSES_EXPORT(int) vw_printw (WINDOW *, const char *,va_list); /* generated */
753 extern NCURSES_EXPORT(int) vwscanw (WINDOW *, NCURSES_CONST char *,va_list); /* implemented */
754 extern NCURSES_EXPORT(int) vw_scanw (WINDOW *, NCURSES_CONST char *,va_list); /* generated */
755 extern NCURSES_EXPORT(int) waddch (WINDOW *, const chtype); /* implemented */
756 extern NCURSES_EXPORT(int) waddchnstr (WINDOW *,const chtype *,int); /* implemented */
757 extern NCURSES_EXPORT(int) waddchstr (WINDOW *,const chtype *); /* generated */
758 extern NCURSES_EXPORT(int) waddnstr (WINDOW *,const char *,int); /* implemented */
759 extern NCURSES_EXPORT(int) waddstr (WINDOW *,const char *); /* generated */
760 extern NCURSES_EXPORT(int) wattron (WINDOW *, int); /* generated */
761 extern NCURSES_EXPORT(int) wattroff (WINDOW *, int); /* generated */
762 extern NCURSES_EXPORT(int) wattrset (WINDOW *, int); /* generated */
763 extern NCURSES_EXPORT(int) wattr_get (WINDOW *, attr_t *, short *, void *); /* generated */
764 extern NCURSES_EXPORT(int) wattr_on (WINDOW *, attr_t, void *); /* implemented */
765 extern NCURSES_EXPORT(int) wattr_off (WINDOW *, attr_t, void *); /* implemented */
766 extern NCURSES_EXPORT(int) wattr_set (WINDOW *, attr_t, short, void *); /* generated */
767 extern NCURSES_EXPORT(int) wbkgd (WINDOW *, chtype); /* implemented */
768 extern NCURSES_EXPORT(void) wbkgdset (WINDOW *,chtype); /* implemented */
769 extern NCURSES_EXPORT(int) wborder (WINDOW *,chtype,chtype,chtype,chtype,chtype,chtype,chtype,chtype); /* implemented */
770 extern NCURSES_EXPORT(int) wchgat (WINDOW *, int, attr_t, short, const void *);/* implemented */
771 extern NCURSES_EXPORT(int) wclear (WINDOW *); /* implemented */
772 extern NCURSES_EXPORT(int) wclrtobot (WINDOW *); /* implemented */
773 extern NCURSES_EXPORT(int) wclrtoeol (WINDOW *); /* implemented */
774 extern NCURSES_EXPORT(int) wcolor_set (WINDOW*,short,void*); /* implemented */
775 extern NCURSES_EXPORT(void) wcursyncup (WINDOW *); /* implemented */
776 extern NCURSES_EXPORT(int) wdelch (WINDOW *); /* implemented */
777 extern NCURSES_EXPORT(int) wdeleteln (WINDOW *); /* generated */
778 extern NCURSES_EXPORT(int) wechochar (WINDOW *, const chtype); /* implemented */
779 extern NCURSES_EXPORT(int) werase (WINDOW *); /* implemented */
780 extern NCURSES_EXPORT(int) wgetch (WINDOW *); /* implemented */
781 extern NCURSES_EXPORT(int) wgetnstr (WINDOW *,char *,int); /* implemented */
782 extern NCURSES_EXPORT(int) wgetstr (WINDOW *, char *); /* generated */
783 extern NCURSES_EXPORT(int) whline (WINDOW *, chtype, int); /* implemented */
784 extern NCURSES_EXPORT(chtype) winch (WINDOW *); /* implemented */
785 extern NCURSES_EXPORT(int) winchnstr (WINDOW *, chtype *, int); /* implemented */
786 extern NCURSES_EXPORT(int) winchstr (WINDOW *, chtype *); /* generated */
787 extern NCURSES_EXPORT(int) winnstr (WINDOW *, char *, int); /* implemented */
788 extern NCURSES_EXPORT(int) winsch (WINDOW *, chtype); /* implemented */
789 extern NCURSES_EXPORT(int) winsdelln (WINDOW *,int); /* implemented */
790 extern NCURSES_EXPORT(int) winsertln (WINDOW *); /* generated */
791 extern NCURSES_EXPORT(int) winsnstr (WINDOW *, const char *,int); /* implemented */
792 extern NCURSES_EXPORT(int) winsstr (WINDOW *, const char *); /* generated */
793 extern NCURSES_EXPORT(int) winstr (WINDOW *, char *); /* generated */
794 extern NCURSES_EXPORT(int) wmove (WINDOW *,int,int); /* implemented */
795 extern NCURSES_EXPORT(int) wnoutrefresh (WINDOW *); /* implemented */
796 extern NCURSES_EXPORT(int) wprintw (WINDOW *, const char *,...) /* implemented */
798 extern NCURSES_EXPORT(int) wredrawln (WINDOW *,int,int); /* implemented */
799 extern NCURSES_EXPORT(int) wrefresh (WINDOW *); /* implemented */
800 extern NCURSES_EXPORT(int) wscanw (WINDOW *, NCURSES_CONST char *,...) /* implemented */
802 extern NCURSES_EXPORT(int) wscrl (WINDOW *,int); /* implemented */
803 extern NCURSES_EXPORT(int) wsetscrreg (WINDOW *,int,int); /* implemented */
804 extern NCURSES_EXPORT(int) wstandout (WINDOW *); /* generated */
805 extern NCURSES_EXPORT(int) wstandend (WINDOW *); /* generated */
806 extern NCURSES_EXPORT(void) wsyncdown (WINDOW *); /* implemented */
807 extern NCURSES_EXPORT(void) wsyncup (WINDOW *); /* implemented */
808 extern NCURSES_EXPORT(void) wtimeout (WINDOW *,int); /* implemented */
809 extern NCURSES_EXPORT(int) wtouchln (WINDOW *,int,int,int); /* implemented */
810 extern NCURSES_EXPORT(int) wvline (WINDOW *,chtype,int); /* implemented */
813 * These are also declared in <term.h>:
815 extern NCURSES_EXPORT(int) tigetflag (NCURSES_CONST char *); /* implemented */
816 extern NCURSES_EXPORT(int) tigetnum (NCURSES_CONST char *); /* implemented */
817 extern NCURSES_EXPORT(char *) tigetstr (NCURSES_CONST char *); /* implemented */
818 extern NCURSES_EXPORT(int) putp (const char *); /* implemented */
820 #if NCURSES_TPARM_VARARGS
821 extern NCURSES_EXPORT(char *) tparm (NCURSES_CONST char *, ...); /* implemented */
823 extern NCURSES_EXPORT(char *) tparm (NCURSES_CONST char *, long,long,long,long,long,long,long,long,long); /* implemented */
824 extern NCURSES_EXPORT(char *) tparm_varargs (NCURSES_CONST char *, ...); /* implemented */
828 * These functions are not in X/Open, but we use them in macro definitions:
830 extern NCURSES_EXPORT(int) getattrs (const WINDOW *); /* generated */
831 extern NCURSES_EXPORT(int) getcurx (const WINDOW *); /* generated */
832 extern NCURSES_EXPORT(int) getcury (const WINDOW *); /* generated */
833 extern NCURSES_EXPORT(int) getbegx (const WINDOW *); /* generated */
834 extern NCURSES_EXPORT(int) getbegy (const WINDOW *); /* generated */
835 extern NCURSES_EXPORT(int) getmaxx (const WINDOW *); /* generated */
836 extern NCURSES_EXPORT(int) getmaxy (const WINDOW *); /* generated */
837 extern NCURSES_EXPORT(int) getparx (const WINDOW *); /* generated */
838 extern NCURSES_EXPORT(int) getpary (const WINDOW *); /* generated */
841 * vid_attr() was implemented originally based on a draft of XSI curses.
843 #ifndef _XOPEN_SOURCE_EXTENDED
844 #define vid_attr(a,pair,opts) vidattr(a)
849 #define NCURSES_ATTR_SHIFT 8
850 #define NCURSES_BITS(mask,shift) ((mask) << ((shift) + NCURSES_ATTR_SHIFT))
852 #define A_NORMAL (@cf_cv_1UL@ - @cf_cv_1UL@)
853 #define A_ATTRIBUTES NCURSES_BITS(~(@cf_cv_1UL@ - @cf_cv_1UL@),0)
854 #define A_CHARTEXT (NCURSES_BITS(@cf_cv_1UL@,0) - @cf_cv_1UL@)
855 #define A_COLOR NCURSES_BITS(((@cf_cv_1UL@) << 8) - @cf_cv_1UL@,0)
856 #define A_STANDOUT NCURSES_BITS(@cf_cv_1UL@,8)
857 #define A_UNDERLINE NCURSES_BITS(@cf_cv_1UL@,9)
858 #define A_REVERSE NCURSES_BITS(@cf_cv_1UL@,10)
859 #define A_BLINK NCURSES_BITS(@cf_cv_1UL@,11)
860 #define A_DIM NCURSES_BITS(@cf_cv_1UL@,12)
861 #define A_BOLD NCURSES_BITS(@cf_cv_1UL@,13)
862 #define A_ALTCHARSET NCURSES_BITS(@cf_cv_1UL@,14)
863 #define A_INVIS NCURSES_BITS(@cf_cv_1UL@,15)
864 #define A_PROTECT NCURSES_BITS(@cf_cv_1UL@,16)
865 #define A_HORIZONTAL NCURSES_BITS(@cf_cv_1UL@,17)
866 #define A_LEFT NCURSES_BITS(@cf_cv_1UL@,18)
867 #define A_LOW NCURSES_BITS(@cf_cv_1UL@,19)
868 #define A_RIGHT NCURSES_BITS(@cf_cv_1UL@,20)
869 #define A_TOP NCURSES_BITS(@cf_cv_1UL@,21)
870 #define A_VERTICAL NCURSES_BITS(@cf_cv_1UL@,22)
873 * Most of the pseudo functions are macros that either provide compatibility
874 * with older versions of curses, or provide inline functionality to improve
879 * These pseudo functions are always implemented as macros:
882 #define getyx(win,y,x) (y = getcury(win), x = getcurx(win))
883 #define getbegyx(win,y,x) (y = getbegy(win), x = getbegx(win))
884 #define getmaxyx(win,y,x) (y = getmaxy(win), x = getmaxx(win))
885 #define getparyx(win,y,x) (y = getpary(win), x = getparx(win))
888 #define getsyx(y,x) do { if(newscr->_leaveok) (y)=(x)=-1; \
889 else getyx(newscr,(y),(x)); \
891 #define setsyx(y,x) do { if((y)==-1 && (x)==-1) newscr->_leaveok=TRUE; \
892 else {newscr->_leaveok=FALSE;wmove(newscr,(y),(x));} \
894 #endif /* NCURSES_OPAQUE */
896 #ifndef NCURSES_NOMACROS
899 * These miscellaneous pseudo functions are provided for compatibility:
902 #define wgetstr(w, s) wgetnstr(w, s, -1)
903 #define getnstr(s, n) wgetnstr(stdscr, s, n)
905 #define setterm(term) setupterm(term, 1, (int *)0)
907 #define fixterm() reset_prog_mode()
908 #define resetterm() reset_shell_mode()
909 #define saveterm() def_prog_mode()
910 #define crmode() cbreak()
911 #define nocrmode() nocbreak()
914 /* It seems older SYSV curses versions define these */
916 #define getattrs(win) ((win)?(win)->_attrs:A_NORMAL)
917 #define getcurx(win) ((win)?(win)->_curx:ERR)
918 #define getcury(win) ((win)?(win)->_cury:ERR)
919 #define getbegx(win) ((win)?(win)->_begx:ERR)
920 #define getbegy(win) ((win)?(win)->_begy:ERR)
921 #define getmaxx(win) ((win)?((win)->_maxx + 1):ERR)
922 #define getmaxy(win) ((win)?((win)->_maxy + 1):ERR)
923 #define getparx(win) ((win)?(win)->_parx:ERR)
924 #define getpary(win) ((win)?(win)->_pary:ERR)
925 #endif /* NCURSES_OPAQUE */
927 #define wstandout(win) (wattrset(win,A_STANDOUT))
928 #define wstandend(win) (wattrset(win,A_NORMAL))
930 #define wattron(win,at) wattr_on(win, NCURSES_CAST(attr_t, at), NULL)
931 #define wattroff(win,at) wattr_off(win, NCURSES_CAST(attr_t, at), NULL)
934 #if defined(_XOPEN_SOURCE_EXTENDED) && @NCURSES_EXT_COLORS@
935 #define wattrset(win,at) ((win)->_color = PAIR_NUMBER(at), \
936 (win)->_attrs = (at))
938 #define wattrset(win,at) ((win)->_attrs = (at))
940 #endif /* NCURSES_OPAQUE */
942 #define scroll(win) wscrl(win,1)
944 #define touchwin(win) wtouchln((win), 0, getmaxy(win), 1)
945 #define touchline(win, s, c) wtouchln((win), s, c, 1)
946 #define untouchwin(win) wtouchln((win), 0, getmaxy(win), 0)
948 #define box(win, v, h) wborder(win, v, v, h, h, 0, 0, 0, 0)
949 #define border(ls, rs, ts, bs, tl, tr, bl, br) wborder(stdscr, ls, rs, ts, bs, tl, tr, bl, br)
950 #define hline(ch, n) whline(stdscr, ch, n)
951 #define vline(ch, n) wvline(stdscr, ch, n)
953 #define winstr(w, s) winnstr(w, s, -1)
954 #define winchstr(w, s) winchnstr(w, s, -1)
955 #define winsstr(w, s) winsnstr(w, s, -1)
958 #define redrawwin(win) wredrawln(win, 0, (win)->_maxy+1)
959 #endif /* NCURSES_OPAQUE */
961 #define waddstr(win,str) waddnstr(win,str,-1)
962 #define waddchstr(win,str) waddchnstr(win,str,-1)
965 * These apply to the first 256 color pairs.
967 #define COLOR_PAIR(n) NCURSES_BITS(n, 0)
968 #define PAIR_NUMBER(a) (NCURSES_CAST(int,(((a) & A_COLOR) >> NCURSES_ATTR_SHIFT)))
971 * pseudo functions for standard screen
974 #define addch(ch) waddch(stdscr,ch)
975 #define addchnstr(str,n) waddchnstr(stdscr,str,n)
976 #define addchstr(str) waddchstr(stdscr,str)
977 #define addnstr(str,n) waddnstr(stdscr,str,n)
978 #define addstr(str) waddnstr(stdscr,str,-1)
979 #define attroff(at) wattroff(stdscr,at)
980 #define attron(at) wattron(stdscr,at)
981 #define attrset(at) wattrset(stdscr,at)
982 #define attr_get(ap,cp,o) wattr_get(stdscr,ap,cp,o)
983 #define attr_off(a,o) wattr_off(stdscr,a,o)
984 #define attr_on(a,o) wattr_on(stdscr,a,o)
985 #define attr_set(a,c,o) wattr_set(stdscr,a,c,o)
986 #define bkgd(ch) wbkgd(stdscr,ch)
987 #define bkgdset(ch) wbkgdset(stdscr,ch)
988 #define chgat(n,a,c,o) wchgat(stdscr,n,a,c,o)
989 #define clear() wclear(stdscr)
990 #define clrtobot() wclrtobot(stdscr)
991 #define clrtoeol() wclrtoeol(stdscr)
992 #define color_set(c,o) wcolor_set(stdscr,c,o)
993 #define delch() wdelch(stdscr)
994 #define deleteln() winsdelln(stdscr,-1)
995 #define echochar(c) wechochar(stdscr,c)
996 #define erase() werase(stdscr)
997 #define getch() wgetch(stdscr)
998 #define getstr(str) wgetstr(stdscr,str)
999 #define inch() winch(stdscr)
1000 #define inchnstr(s,n) winchnstr(stdscr,s,n)
1001 #define inchstr(s) winchstr(stdscr,s)
1002 #define innstr(s,n) winnstr(stdscr,s,n)
1003 #define insch(c) winsch(stdscr,c)
1004 #define insdelln(n) winsdelln(stdscr,n)
1005 #define insertln() winsdelln(stdscr,1)
1006 #define insnstr(s,n) winsnstr(stdscr,s,n)
1007 #define insstr(s) winsstr(stdscr,s)
1008 #define instr(s) winstr(stdscr,s)
1009 #define move(y,x) wmove(stdscr,y,x)
1010 #define refresh() wrefresh(stdscr)
1011 #define scrl(n) wscrl(stdscr,n)
1012 #define setscrreg(t,b) wsetscrreg(stdscr,t,b)
1013 #define standend() wstandend(stdscr)
1014 #define standout() wstandout(stdscr)
1015 #define timeout(delay) wtimeout(stdscr,delay)
1016 #define wdeleteln(win) winsdelln(win,-1)
1017 #define winsertln(win) winsdelln(win,1)
1023 #define mvwaddch(win,y,x,ch) (wmove(win,y,x) == ERR ? ERR : waddch(win,ch))
1024 #define mvwaddchnstr(win,y,x,str,n) (wmove(win,y,x) == ERR ? ERR : waddchnstr(win,str,n))
1025 #define mvwaddchstr(win,y,x,str) (wmove(win,y,x) == ERR ? ERR : waddchnstr(win,str,-1))
1026 #define mvwaddnstr(win,y,x,str,n) (wmove(win,y,x) == ERR ? ERR : waddnstr(win,str,n))
1027 #define mvwaddstr(win,y,x,str) (wmove(win,y,x) == ERR ? ERR : waddnstr(win,str,-1))
1028 #define mvwdelch(win,y,x) (wmove(win,y,x) == ERR ? ERR : wdelch(win))
1029 #define mvwchgat(win,y,x,n,a,c,o) (wmove(win,y,x) == ERR ? ERR : wchgat(win,n,a,c,o))
1030 #define mvwgetch(win,y,x) (wmove(win,y,x) == ERR ? ERR : wgetch(win))
1031 #define mvwgetnstr(win,y,x,str,n) (wmove(win,y,x) == ERR ? ERR : wgetnstr(win,str,n))
1032 #define mvwgetstr(win,y,x,str) (wmove(win,y,x) == ERR ? ERR : wgetstr(win,str))
1033 #define mvwhline(win,y,x,c,n) (wmove(win,y,x) == ERR ? ERR : whline(win,c,n))
1034 #define mvwinch(win,y,x) (wmove(win,y,x) == ERR ? NCURSES_CAST(chtype, ERR) : winch(win))
1035 #define mvwinchnstr(win,y,x,s,n) (wmove(win,y,x) == ERR ? ERR : winchnstr(win,s,n))
1036 #define mvwinchstr(win,y,x,s) (wmove(win,y,x) == ERR ? ERR : winchstr(win,s))
1037 #define mvwinnstr(win,y,x,s,n) (wmove(win,y,x) == ERR ? ERR : winnstr(win,s,n))
1038 #define mvwinsch(win,y,x,c) (wmove(win,y,x) == ERR ? ERR : winsch(win,c))
1039 #define mvwinsnstr(win,y,x,s,n) (wmove(win,y,x) == ERR ? ERR : winsnstr(win,s,n))
1040 #define mvwinsstr(win,y,x,s) (wmove(win,y,x) == ERR ? ERR : winsstr(win,s))
1041 #define mvwinstr(win,y,x,s) (wmove(win,y,x) == ERR ? ERR : winstr(win,s))
1042 #define mvwvline(win,y,x,c,n) (wmove(win,y,x) == ERR ? ERR : wvline(win,c,n))
1044 #define mvaddch(y,x,ch) mvwaddch(stdscr,y,x,ch)
1045 #define mvaddchnstr(y,x,str,n) mvwaddchnstr(stdscr,y,x,str,n)
1046 #define mvaddchstr(y,x,str) mvwaddchstr(stdscr,y,x,str)
1047 #define mvaddnstr(y,x,str,n) mvwaddnstr(stdscr,y,x,str,n)
1048 #define mvaddstr(y,x,str) mvwaddstr(stdscr,y,x,str)
1049 #define mvchgat(y,x,n,a,c,o) mvwchgat(stdscr,y,x,n,a,c,o)
1050 #define mvdelch(y,x) mvwdelch(stdscr,y,x)
1051 #define mvgetch(y,x) mvwgetch(stdscr,y,x)
1052 #define mvgetnstr(y,x,str,n) mvwgetnstr(stdscr,y,x,str,n)
1053 #define mvgetstr(y,x,str) mvwgetstr(stdscr,y,x,str)
1054 #define mvhline(y,x,c,n) mvwhline(stdscr,y,x,c,n)
1055 #define mvinch(y,x) mvwinch(stdscr,y,x)
1056 #define mvinchnstr(y,x,s,n) mvwinchnstr(stdscr,y,x,s,n)
1057 #define mvinchstr(y,x,s) mvwinchstr(stdscr,y,x,s)
1058 #define mvinnstr(y,x,s,n) mvwinnstr(stdscr,y,x,s,n)
1059 #define mvinsch(y,x,c) mvwinsch(stdscr,y,x,c)
1060 #define mvinsnstr(y,x,s,n) mvwinsnstr(stdscr,y,x,s,n)
1061 #define mvinsstr(y,x,s) mvwinsstr(stdscr,y,x,s)
1062 #define mvinstr(y,x,s) mvwinstr(stdscr,y,x,s)
1063 #define mvvline(y,x,c,n) mvwvline(stdscr,y,x,c,n)
1066 * Some wide-character functions can be implemented without the extensions.
1069 #define getbkgd(win) ((win)->_bkgd)
1070 #endif /* NCURSES_OPAQUE */
1072 #define slk_attr_off(a,v) ((v) ? ERR : slk_attroff(a))
1073 #define slk_attr_on(a,v) ((v) ? ERR : slk_attron(a))
1076 #if defined(_XOPEN_SOURCE_EXTENDED) && @NCURSES_EXT_COLORS@
1077 #define wattr_set(win,a,p,opts) ((win)->_attrs = ((a) & ~A_COLOR), \
1078 (win)->_color = (p), \
1080 #define wattr_get(win,a,p,opts) ((void)((a) != 0 && (*(a) = (win)->_attrs)), \
1081 (void)((p) != 0 && (*(p) = (win)->_color)), \
1084 #define wattr_set(win,a,p,opts) ((win)->_attrs = (((a) & ~A_COLOR) | COLOR_PAIR(p)), OK)
1085 #define wattr_get(win,a,p,opts) ((void)((a) != 0 && (*(a) = (win)->_attrs)), \
1086 (void)((p) != 0 && (*(p) = PAIR_NUMBER((win)->_attrs))), \
1089 #endif /* NCURSES_OPAQUE */
1092 * XSI curses deprecates SVr4 vwprintw/vwscanw, which are supposed to use
1093 * varargs.h. It adds new calls vw_printw/vw_scanw, which are supposed to
1094 * use POSIX stdarg.h. The ncurses versions of vwprintw/vwscanw already
1095 * use stdarg.h, so...
1097 #define vw_printw vwprintw
1098 #define vw_scanw vwscanw
1101 * Export fallback function for use in C++ binding.
1104 #define vsscanf(a,b,c) _nc_vsscanf(a,b,c)
1105 NCURSES_EXPORT(int) vsscanf(const char *, const char *, va_list);
1108 #endif /* NCURSES_NOMACROS */
1114 * a. ESCDELAY was an undocumented feature under AIX curses.
1115 * It gives the ESC expire time in milliseconds.
1116 * b. ttytype is needed for backward compatibility
1118 #if @cf_cv_enable_reentrant@
1120 NCURSES_WRAPPED_VAR(WINDOW *, curscr);
1121 NCURSES_WRAPPED_VAR(WINDOW *, newscr);
1122 NCURSES_WRAPPED_VAR(WINDOW *, stdscr);
1123 NCURSES_WRAPPED_VAR(char *, ttytype);
1124 NCURSES_WRAPPED_VAR(int, COLORS);
1125 NCURSES_WRAPPED_VAR(int, COLOR_PAIRS);
1126 NCURSES_WRAPPED_VAR(int, COLS);
1127 NCURSES_WRAPPED_VAR(int, ESCDELAY);
1128 NCURSES_WRAPPED_VAR(int, LINES);
1129 NCURSES_WRAPPED_VAR(int, TABSIZE);
1131 #define curscr NCURSES_PUBLIC_VAR(curscr())
1132 #define newscr NCURSES_PUBLIC_VAR(newscr())
1133 #define stdscr NCURSES_PUBLIC_VAR(stdscr())
1134 #define ttytype NCURSES_PUBLIC_VAR(ttytype())
1135 #define COLORS NCURSES_PUBLIC_VAR(COLORS())
1136 #define COLOR_PAIRS NCURSES_PUBLIC_VAR(COLOR_PAIRS())
1137 #define COLS NCURSES_PUBLIC_VAR(COLS())
1138 #define ESCDELAY NCURSES_PUBLIC_VAR(ESCDELAY())
1139 #define LINES NCURSES_PUBLIC_VAR(LINES())
1140 #define TABSIZE NCURSES_PUBLIC_VAR(TABSIZE())
1144 extern NCURSES_EXPORT_VAR(WINDOW *) curscr;
1145 extern NCURSES_EXPORT_VAR(WINDOW *) newscr;
1146 extern NCURSES_EXPORT_VAR(WINDOW *) stdscr;
1147 extern NCURSES_EXPORT_VAR(char) ttytype[];
1148 extern NCURSES_EXPORT_VAR(int) COLORS;
1149 extern NCURSES_EXPORT_VAR(int) COLOR_PAIRS;
1150 extern NCURSES_EXPORT_VAR(int) COLS;
1151 extern NCURSES_EXPORT_VAR(int) ESCDELAY;
1152 extern NCURSES_EXPORT_VAR(int) LINES;
1153 extern NCURSES_EXPORT_VAR(int) TABSIZE;
1158 * Pseudo-character tokens outside ASCII range. The curses wgetch() function
1159 * will return any given one of these only if the corresponding k- capability
1160 * is defined in your terminal's terminfo entry.
1162 * Some keys (KEY_A1, etc) are arranged like this:
1167 * A few key codes do not depend upon the terminfo entry.
1169 #define KEY_CODE_YES 0400 /* A wchar_t contains a key code */
1170 #define KEY_MIN 0401 /* Minimum curses key */
1171 #define KEY_BREAK 0401 /* Break key (unreliable) */
1172 #define KEY_SRESET 0530 /* Soft (partial) reset (unreliable) */
1173 #define KEY_RESET 0531 /* Reset or hard reset (unreliable) */