blob: 8cfa0b9ff8d6bd8e1830a1fc4c90c6b79473820f [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301/****************************************************************************
micky3879b9f5e72025-07-08 18:04:53 -04002 * Copyright 2018-2023,2024 Thomas E. Dickey *
3 * Copyright 1998-2016,2017 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05304 * *
5 * Permission is hereby granted, free of charge, to any person obtaining a *
6 * copy of this software and associated documentation files (the *
7 * "Software"), to deal in the Software without restriction, including *
8 * without limitation the rights to use, copy, modify, merge, publish, *
9 * distribute, distribute with modifications, sublicense, and/or sell *
10 * copies of the Software, and to permit persons to whom the Software is *
11 * furnished to do so, subject to the following conditions: *
12 * *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
15 * *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
23 * *
24 * Except as contained in this notice, the name(s) of the above copyright *
25 * holders shall not be used in advertising or otherwise to promote the *
26 * sale, use or other dealings in this Software without prior written *
27 * authorization. *
28 ****************************************************************************/
29
30/****************************************************************************
31 * Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 *
32 * and: Eric S. Raymond <esr@snark.thyrsus.com> *
33 * and: Thomas E. Dickey 1996-on *
34 ****************************************************************************/
35
micky3879b9f5e72025-07-08 18:04:53 -040036/* $Id: curses.h.in,v 1.282 2024/01/19 11:50:07 tom Exp $ */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053037
38#ifndef __NCURSES_H
39#define __NCURSES_H
40
micky3879b9f5e72025-07-08 18:04:53 -040041/*
42 The symbols beginning NCURSES_ or USE_ are configuration choices.
43 A few of the former can be overridden by applications at compile-time.
44 Most of the others correspond to configure-script options (or checks
45 by the configure-script for features of the system on which it is built).
46
47 These symbols can be overridden by applications at compile-time:
48 NCURSES_NOMACROS suppresses macro definitions in favor of functions
49 NCURSES_WATTR_MACROS suppresses wattr_* macro definitions
50 NCURSES_WIDECHAR is an alternative for declaring wide-character functions.
51
52 These symbols are used only when building ncurses:
53 NCURSES_ATTR_T
54 NCURSES_FIELD_INTERNALS
55 NCURSES_INTERNALS
56
57 These symbols are set by the configure script:
58 NCURSES_ENABLE_STDBOOL_H
59 NCURSES_EXPANDED
60 NCURSES_EXT_COLORS
61 NCURSES_EXT_FUNCS
62 NCURSES_EXT_PUTWIN
63 NCURSES_NO_PADDING
64 NCURSES_OSPEED_COMPAT
65 NCURSES_PATHSEP
66 NCURSES_REENTRANT
67 NCURSES_SIGWINCH
68 */
69
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053070#define CURSES 1
71#define CURSES_H 1
72
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053073/* These are defined only in curses.h, and are used for conditional compiles */
74#define NCURSES_VERSION_MAJOR @NCURSES_MAJOR@
75#define NCURSES_VERSION_MINOR @NCURSES_MINOR@
76#define NCURSES_VERSION_PATCH @NCURSES_PATCH@
77
78/* This is defined in more than one ncurses header, for identification */
79#undef NCURSES_VERSION
80#define NCURSES_VERSION "@NCURSES_MAJOR@.@NCURSES_MINOR@"
81
82/*
83 * Identify the mouse encoding version.
84 */
85#define NCURSES_MOUSE_VERSION @NCURSES_MOUSE_VERSION@
86
87/*
88 * Definitions to facilitate DLL's.
89 */
90#include <ncurses_dll.h>
91
micky3879b9f5e72025-07-08 18:04:53 -040092/*
93 * Extra headers.
94 */
Steve Kondikae271bc2015-11-15 02:50:53 +010095#if @HAVE_STDINT_H@
96#include <stdint.h>
97#endif
98
micky3879b9f5e72025-07-08 18:04:53 -040099#ifdef __cplusplus
100#else
101#if @HAVE_STDNORETURN_H@
102#include <stdnoreturn.h>
103#undef GCC_NORETURN
104#define GCC_NORETURN _Noreturn
105#endif
106#endif
107
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530108/*
109 * User-definable tweak to disable the include of <stdbool.h>.
110 */
111#ifndef NCURSES_ENABLE_STDBOOL_H
112#define NCURSES_ENABLE_STDBOOL_H @cf_cv_header_stdbool_h@
113#endif
114
115/*
116 * NCURSES_ATTR_T is used to quiet compiler warnings when building ncurses
117 * configured using --disable-macros.
118 */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530119#ifndef NCURSES_ATTR_T
120#define NCURSES_ATTR_T int
121#endif
122
123/*
124 * Expands to 'const' if ncurses is configured using --enable-const. Note that
125 * doing so makes it incompatible with other implementations of X/Open Curses.
126 */
127#undef NCURSES_CONST
128#define NCURSES_CONST @NCURSES_CONST@
129
130#undef NCURSES_INLINE
131#define NCURSES_INLINE @NCURSES_INLINE@
132
133/*
micky3879b9f5e72025-07-08 18:04:53 -0400134 * The standard type used for color values, and for color-pairs. The latter
Steve Kondikae271bc2015-11-15 02:50:53 +0100135 * allows the curses library to enumerate the combinations of foreground and
136 * background colors used by an application, and is normally the product of the
137 * total foreground and background colors.
138 *
139 * X/Open uses "short" for both of these types, ultimately because they are
micky3879b9f5e72025-07-08 18:04:53 -0400140 * numbers from the SVr4 terminal database, which uses 16-bit signed values.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530141 */
142#undef NCURSES_COLOR_T
143#define NCURSES_COLOR_T short
144
Steve Kondikae271bc2015-11-15 02:50:53 +0100145#undef NCURSES_PAIRS_T
146#define NCURSES_PAIRS_T short
147
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530148/*
micky3879b9f5e72025-07-08 18:04:53 -0400149 * Definitions used to make WINDOW and similar structs opaque.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530150 */
micky3879b9f5e72025-07-08 18:04:53 -0400151#ifndef NCURSES_INTERNALS
152#define NCURSES_OPAQUE @NCURSES_OPAQUE@
153#define NCURSES_OPAQUE_FORM @NCURSES_OPAQUE_FORM@
154#define NCURSES_OPAQUE_MENU @NCURSES_OPAQUE_MENU@
155#define NCURSES_OPAQUE_PANEL @NCURSES_OPAQUE_PANEL@
156#endif
157
158/*
159 * Definition used to optionally suppress wattr* macros to help with the
160 * transition from ncurses5 to ncurses6 by allowing the header files to
161 * be shared across development packages for ncursesw in both ABIs.
162 */
163#ifndef NCURSES_WATTR_MACROS
164#define NCURSES_WATTR_MACROS @NCURSES_WATTR_MACROS@
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530165#endif
166
167/*
Steve Kondikae271bc2015-11-15 02:50:53 +0100168 * The reentrant code relies on the opaque setting, but adds features.
169 */
170#ifndef NCURSES_REENTRANT
171#define NCURSES_REENTRANT @cf_cv_enable_reentrant@
172#endif
173
174/*
micky3879b9f5e72025-07-08 18:04:53 -0400175 * KEY_RESIZE is an extended feature that relies upon the SIGWINCH handler
176 * in ncurses.
177 */
178#if @NCURSES_EXT_FUNCS@
179#ifndef NCURSES_SIGWINCH
180#define NCURSES_SIGWINCH @cf_cv_enable_sigwinch@
181#endif
182#else
183#undef NCURSES_SIGWINCH
184#define NCURSES_SIGWINCH 0
185#endif
186
187/*
188 * In certain environments, we must work around linker problems for data
189 */
190#undef NCURSES_BROKEN_LINKER
191#if @BROKEN_LINKER@
192#define NCURSES_BROKEN_LINKER 1
193#endif
194
195/*
Steve Kondikae271bc2015-11-15 02:50:53 +0100196 * Control whether bindings for interop support are added.
197 */
198#undef NCURSES_INTEROP_FUNCS
199#define NCURSES_INTEROP_FUNCS @NCURSES_INTEROP_FUNCS@
200
201/*
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530202 * The internal type used for window dimensions.
203 */
204#undef NCURSES_SIZE_T
205#define NCURSES_SIZE_T @NCURSES_SIZE_T@
206
207/*
208 * Control whether tparm() supports varargs or fixed-parameter list.
209 */
210#undef NCURSES_TPARM_VARARGS
211#define NCURSES_TPARM_VARARGS @NCURSES_TPARM_VARARGS@
212
213/*
Steve Kondikae271bc2015-11-15 02:50:53 +0100214 * Control type used for tparm's arguments. While X/Open equates long and
215 * char* values, this is not always workable for 64-bit platforms.
216 */
217#undef NCURSES_TPARM_ARG
218#define NCURSES_TPARM_ARG @NCURSES_TPARM_ARG@
219
220/*
micky3879b9f5e72025-07-08 18:04:53 -0400221 * Control whether ncurses uses wcwidth() for checking width of line-drawing
222 * characters.
223 */
224#undef NCURSES_WCWIDTH_GRAPHICS
225#define NCURSES_WCWIDTH_GRAPHICS @NCURSES_WCWIDTH_GRAPHICS@
226
227/*
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530228 * NCURSES_CH_T is used in building the library, but not used otherwise in
229 * this header file, since that would make the normal/wide-character versions
230 * of the header incompatible.
231 */
232#undef NCURSES_CH_T
233#define NCURSES_CH_T @NCURSES_CH_T@
234
235#if @cf_cv_enable_lp64@ && defined(_LP64)
236typedef unsigned chtype;
237typedef unsigned mmask_t;
238#else
Steve Kondikae271bc2015-11-15 02:50:53 +0100239typedef @cf_cv_typeof_chtype@ chtype;
240typedef @cf_cv_typeof_mmask_t@ mmask_t;
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530241#endif
242
Steve Kondikae271bc2015-11-15 02:50:53 +0100243/*
244 * We need FILE, etc. Include this before checking any feature symbols.
245 */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530246#include <stdio.h>
Steve Kondikae271bc2015-11-15 02:50:53 +0100247
248/*
249 * With XPG4, you must define _XOPEN_SOURCE_EXTENDED, it is redundant (or
250 * conflicting) when _XOPEN_SOURCE is 500 or greater. If NCURSES_WIDECHAR is
251 * not already defined, e.g., if the platform relies upon nonstandard feature
252 * test macros, define it at this point if the standard feature test macros
253 * indicate that it should be defined.
254 */
255#ifndef NCURSES_WIDECHAR
256#if defined(_XOPEN_SOURCE_EXTENDED) || (defined(_XOPEN_SOURCE) && (_XOPEN_SOURCE - 0 >= 500))
257#define NCURSES_WIDECHAR 1
258#else
259#define NCURSES_WIDECHAR 0
260#endif
261#endif /* NCURSES_WIDECHAR */
262
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530263#include <stdarg.h> /* we need va_list */
Steve Kondikae271bc2015-11-15 02:50:53 +0100264#if NCURSES_WIDECHAR
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530265#include <stddef.h> /* we want wchar_t */
Steve Kondikae271bc2015-11-15 02:50:53 +0100266#endif
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530267
268/* X/Open and SVr4 specify that curses implements 'bool'. However, C++ may also
269 * implement it. If so, we must use the C++ compiler's type to avoid conflict
270 * with other interfaces.
271 *
272 * A further complication is that <stdbool.h> may declare 'bool' to be a
273 * different type, such as an enum which is not necessarily compatible with
274 * C++. If we have <stdbool.h>, make 'bool' a macro, so users may #undef it.
275 * Otherwise, let it remain a typedef to avoid conflicts with other #define's.
276 * In either case, make a typedef for NCURSES_BOOL which can be used if needed
277 * from either C or C++.
278 */
279
280#undef TRUE
281#define TRUE 1
282
283#undef FALSE
284#define FALSE 0
285
286typedef @cf_cv_type_of_bool@ NCURSES_BOOL;
287
288#if @USE_CXX_BOOL@ /* __cplusplus, etc. */
289
290/* use the C++ compiler's bool type */
291#define NCURSES_BOOL bool
292
293#else /* c89, c99, etc. */
294
295#if NCURSES_ENABLE_STDBOOL_H
296#include <stdbool.h>
297/* use whatever the C compiler decides bool really is */
298#define NCURSES_BOOL bool
299#else
300/* there is no predefined bool - use our own */
301#undef bool
302#define bool NCURSES_BOOL
303#endif
304
305#endif /* !__cplusplus, etc. */
306
307#ifdef __cplusplus
308extern "C" {
309#define NCURSES_CAST(type,value) static_cast<type>(value)
310#else
311#define NCURSES_CAST(type,value) (type)(value)
312#endif
313
micky3879b9f5e72025-07-08 18:04:53 -0400314#define NCURSES_OK_ADDR(p) (0 != NCURSES_CAST(const void *, (p)))
315
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530316/*
317 * X/Open attributes. In the ncurses implementation, they are identical to the
318 * A_ attributes.
319 */
320#define WA_ATTRIBUTES A_ATTRIBUTES
321#define WA_NORMAL A_NORMAL
322#define WA_STANDOUT A_STANDOUT
323#define WA_UNDERLINE A_UNDERLINE
324#define WA_REVERSE A_REVERSE
325#define WA_BLINK A_BLINK
326#define WA_DIM A_DIM
327#define WA_BOLD A_BOLD
328#define WA_ALTCHARSET A_ALTCHARSET
329#define WA_INVIS A_INVIS
330#define WA_PROTECT A_PROTECT
331#define WA_HORIZONTAL A_HORIZONTAL
332#define WA_LEFT A_LEFT
333#define WA_LOW A_LOW
334#define WA_RIGHT A_RIGHT
335#define WA_TOP A_TOP
336#define WA_VERTICAL A_VERTICAL
337
Steve Kondikae271bc2015-11-15 02:50:53 +0100338#if @NCURSES_EXT_FUNCS@
339#define WA_ITALIC A_ITALIC /* ncurses extension */
340#endif
341
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530342/* colors */
343#define COLOR_BLACK 0
344#define COLOR_RED 1
345#define COLOR_GREEN 2
346#define COLOR_YELLOW 3
347#define COLOR_BLUE 4
348#define COLOR_MAGENTA 5
349#define COLOR_CYAN 6
350#define COLOR_WHITE 7
351
352/* line graphics */
353
Steve Kondikae271bc2015-11-15 02:50:53 +0100354#if @BROKEN_LINKER@ || NCURSES_REENTRANT
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530355NCURSES_WRAPPED_VAR(chtype*, acs_map);
Steve Kondikae271bc2015-11-15 02:50:53 +0100356#define acs_map NCURSES_PUBLIC_VAR(acs_map())
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530357#else
358extern NCURSES_EXPORT_VAR(chtype) acs_map[];
359#endif
360
Steve Kondikae271bc2015-11-15 02:50:53 +0100361#define NCURSES_ACS(c) (acs_map[NCURSES_CAST(unsigned char,(c))])
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530362
363/* VT100 symbols begin here */
364#define ACS_ULCORNER NCURSES_ACS('l') /* upper left corner */
365#define ACS_LLCORNER NCURSES_ACS('m') /* lower left corner */
366#define ACS_URCORNER NCURSES_ACS('k') /* upper right corner */
367#define ACS_LRCORNER NCURSES_ACS('j') /* lower right corner */
368#define ACS_LTEE NCURSES_ACS('t') /* tee pointing right */
369#define ACS_RTEE NCURSES_ACS('u') /* tee pointing left */
370#define ACS_BTEE NCURSES_ACS('v') /* tee pointing up */
371#define ACS_TTEE NCURSES_ACS('w') /* tee pointing down */
372#define ACS_HLINE NCURSES_ACS('q') /* horizontal line */
373#define ACS_VLINE NCURSES_ACS('x') /* vertical line */
374#define ACS_PLUS NCURSES_ACS('n') /* large plus or crossover */
375#define ACS_S1 NCURSES_ACS('o') /* scan line 1 */
376#define ACS_S9 NCURSES_ACS('s') /* scan line 9 */
377#define ACS_DIAMOND NCURSES_ACS('`') /* diamond */
378#define ACS_CKBOARD NCURSES_ACS('a') /* checker board (stipple) */
379#define ACS_DEGREE NCURSES_ACS('f') /* degree symbol */
380#define ACS_PLMINUS NCURSES_ACS('g') /* plus/minus */
381#define ACS_BULLET NCURSES_ACS('~') /* bullet */
382/* Teletype 5410v1 symbols begin here */
383#define ACS_LARROW NCURSES_ACS(',') /* arrow pointing left */
384#define ACS_RARROW NCURSES_ACS('+') /* arrow pointing right */
385#define ACS_DARROW NCURSES_ACS('.') /* arrow pointing down */
386#define ACS_UARROW NCURSES_ACS('-') /* arrow pointing up */
387#define ACS_BOARD NCURSES_ACS('h') /* board of squares */
388#define ACS_LANTERN NCURSES_ACS('i') /* lantern symbol */
389#define ACS_BLOCK NCURSES_ACS('0') /* solid square block */
390/*
391 * These aren't documented, but a lot of System Vs have them anyway
392 * (you can spot pprryyzz{{||}} in a lot of AT&T terminfo strings).
393 * The ACS_names may not match AT&T's, our source didn't know them.
394 */
395#define ACS_S3 NCURSES_ACS('p') /* scan line 3 */
396#define ACS_S7 NCURSES_ACS('r') /* scan line 7 */
397#define ACS_LEQUAL NCURSES_ACS('y') /* less/equal */
398#define ACS_GEQUAL NCURSES_ACS('z') /* greater/equal */
399#define ACS_PI NCURSES_ACS('{') /* Pi */
400#define ACS_NEQUAL NCURSES_ACS('|') /* not equal */
401#define ACS_STERLING NCURSES_ACS('}') /* UK pound sign */
402
403/*
404 * Line drawing ACS names are of the form ACS_trbl, where t is the top, r
405 * is the right, b is the bottom, and l is the left. t, r, b, and l might
406 * be B (blank), S (single), D (double), or T (thick). The subset defined
407 * here only uses B and S.
408 */
409#define ACS_BSSB ACS_ULCORNER
410#define ACS_SSBB ACS_LLCORNER
411#define ACS_BBSS ACS_URCORNER
412#define ACS_SBBS ACS_LRCORNER
413#define ACS_SBSS ACS_RTEE
414#define ACS_SSSB ACS_LTEE
415#define ACS_SSBS ACS_BTEE
416#define ACS_BSSS ACS_TTEE
417#define ACS_BSBS ACS_HLINE
418#define ACS_SBSB ACS_VLINE
419#define ACS_SSSS ACS_PLUS
420
421#undef ERR
422#define ERR (-1)
423
424#undef OK
425#define OK (0)
426
427/* values for the _flags member */
428#define _SUBWIN 0x01 /* is this a sub-window? */
429#define _ENDLINE 0x02 /* is the window flush right? */
430#define _FULLWIN 0x04 /* is the window full-screen? */
431#define _SCROLLWIN 0x08 /* bottom edge is at screen bottom? */
432#define _ISPAD 0x10 /* is this window a pad? */
433#define _HASMOVED 0x20 /* has cursor moved since last refresh? */
434#define _WRAPPED 0x40 /* cursor was just wrappped */
435
436/*
437 * this value is used in the firstchar and lastchar fields to mark
438 * unchanged lines
439 */
440#define _NOCHANGE -1
441
442/*
443 * this value is used in the oldindex field to mark lines created by insertions
444 * and scrolls.
445 */
446#define _NEWINDEX -1
447
micky3879b9f5e72025-07-08 18:04:53 -0400448#ifdef NCURSES_INTERNALS
449#undef SCREEN
450#define SCREEN struct screen
451SCREEN;
452#else
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530453typedef struct screen SCREEN;
micky3879b9f5e72025-07-08 18:04:53 -0400454#endif
455
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530456typedef struct _win_st WINDOW;
457
458typedef chtype attr_t; /* ...must be at least as wide as chtype */
459
Steve Kondikae271bc2015-11-15 02:50:53 +0100460#if NCURSES_WIDECHAR
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530461
462#if @NCURSES_LIBUTF8@
463#ifdef mblen /* libutf8.h defines it w/o undefining first */
464#undef mblen
465#endif
466#include <libutf8.h>
467#endif
468
469#if @NEED_WCHAR_H@
470#include <wchar.h> /* ...to get mbstate_t, etc. */
471#endif
472
473#if @NCURSES_WCHAR_T@
474typedef unsigned short wchar_t@NCURSES_OK_WCHAR_T@;
475#endif
476
477#if @NCURSES_WINT_T@
478typedef unsigned int wint_t@NCURSES_OK_WCHAR_T@;
479#endif
480
Steve Kondikae271bc2015-11-15 02:50:53 +0100481/*
482 * cchar_t stores an array of CCHARW_MAX wide characters. The first is
483 * normally a spacing character. The others are non-spacing. If those
484 * (spacing and nonspacing) do not fill the array, a null L'\0' follows.
485 * Otherwise, a null is assumed to follow when extracting via getcchar().
486 */
487#define CCHARW_MAX @NCURSES_CCHARW_MAX@
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530488typedef struct
489{
490 attr_t attr;
491 wchar_t chars[CCHARW_MAX];
492#if @NCURSES_EXT_COLORS@
493#undef NCURSES_EXT_COLORS
494#define NCURSES_EXT_COLORS @NCURSES_PATCH@
495 int ext_color; /* color pair, must be more than 16-bits */
496#endif
497}
498cchar_t;
499
Steve Kondikae271bc2015-11-15 02:50:53 +0100500#endif /* NCURSES_WIDECHAR */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530501
502#if !NCURSES_OPAQUE
503struct ldat;
504
505struct _win_st
506{
507 NCURSES_SIZE_T _cury, _curx; /* current cursor position */
508
509 /* window location and size */
510 NCURSES_SIZE_T _maxy, _maxx; /* maximums of x and y, NOT window size */
511 NCURSES_SIZE_T _begy, _begx; /* screen coords of upper-left-hand corner */
512
513 short _flags; /* window state flags */
514
515 /* attribute tracking */
516 attr_t _attrs; /* current attribute for non-space character */
517 chtype _bkgd; /* current background char/attribute pair */
518
519 /* option values set by user */
520 bool _notimeout; /* no time out on function-key entry? */
521 bool _clear; /* consider all data in the window invalid? */
522 bool _leaveok; /* OK to not reset cursor on exit? */
523 bool _scroll; /* OK to scroll this window? */
524 bool _idlok; /* OK to use insert/delete line? */
525 bool _idcok; /* OK to use insert/delete char? */
526 bool _immed; /* window in immed mode? (not yet used) */
527 bool _sync; /* window in sync mode? */
528 bool _use_keypad; /* process function keys into KEY_ symbols? */
529 int _delay; /* 0 = nodelay, <0 = blocking, >0 = delay */
530
531 struct ldat *_line; /* the actual line data */
532
533 /* global screen state */
534 NCURSES_SIZE_T _regtop; /* top line of scrolling region */
535 NCURSES_SIZE_T _regbottom; /* bottom line of scrolling region */
536
537 /* these are used only if this is a sub-window */
538 int _parx; /* x coordinate of this window in parent */
539 int _pary; /* y coordinate of this window in parent */
540 WINDOW *_parent; /* pointer to parent if a sub-window */
541
542 /* these are used only if this is a pad */
543 struct pdat
544 {
545 NCURSES_SIZE_T _pad_y, _pad_x;
546 NCURSES_SIZE_T _pad_top, _pad_left;
547 NCURSES_SIZE_T _pad_bottom, _pad_right;
548 } _pad;
549
550 NCURSES_SIZE_T _yoffset; /* real begy is _begy + _yoffset */
551
Steve Kondikae271bc2015-11-15 02:50:53 +0100552#if NCURSES_WIDECHAR
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530553 cchar_t _bkgrnd; /* current background char/attribute pair */
554#if @NCURSES_EXT_COLORS@
555 int _color; /* current color-pair for non-space character */
556#endif
557#endif
558};
559#endif /* NCURSES_OPAQUE */
560
561/*
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530562 * GCC (and some other compilers) define '__attribute__'; we're using this
563 * macro to alert the compiler to flag inconsistencies in printf/scanf-like
564 * function calls. Just in case '__attribute__' isn't defined, make a dummy.
565 * Old versions of G++ do not accept it anyway, at least not consistently with
566 * GCC.
567 */
568#if !(defined(__GNUC__) || defined(__GNUG__) || defined(__attribute__))
569#define __attribute__(p) /* nothing */
570#endif
571
572/*
573 * We cannot define these in ncurses_cfg.h, since they require parameters to be
micky3879b9f5e72025-07-08 18:04:53 -0400574 * passed (that is non-portable).
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530575 */
576#ifndef GCC_PRINTFLIKE
micky3879b9f5e72025-07-08 18:04:53 -0400577#ifndef printf
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530578#define GCC_PRINTFLIKE(fmt,var) __attribute__((format(printf,fmt,var)))
579#else
580#define GCC_PRINTFLIKE(fmt,var) /*nothing*/
581#endif
582#endif
583
584#ifndef GCC_SCANFLIKE
micky3879b9f5e72025-07-08 18:04:53 -0400585#ifndef scanf
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530586#define GCC_SCANFLIKE(fmt,var) __attribute__((format(scanf,fmt,var)))
587#else
588#define GCC_SCANFLIKE(fmt,var) /*nothing*/
589#endif
590#endif
591
592#ifndef GCC_NORETURN
593#define GCC_NORETURN /* nothing */
594#endif
595
596#ifndef GCC_UNUSED
597#define GCC_UNUSED /* nothing */
598#endif
599
micky3879b9f5e72025-07-08 18:04:53 -0400600#undef GCC_DEPRECATED
601#if (__GNUC__ - 0 > 3 || (__GNUC__ - 0 == 3 && __GNUC_MINOR__ - 0 >= 2)) && !defined(NCURSES_INTERNALS)
602#define GCC_DEPRECATED(msg) __attribute__((deprecated))
603#else
604#define GCC_DEPRECATED(msg) /* nothing */
605#endif
606
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530607/*
Steve Kondikae271bc2015-11-15 02:50:53 +0100608 * Curses uses a helper function. Define our type for this to simplify
609 * extending it for the sp-funcs feature.
610 */
611typedef int (*NCURSES_OUTC)(int);
612
613/*
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530614 * Function prototypes. This is the complete X/Open Curses list of required
615 * functions. Those marked `generated' will have sources generated from the
616 * macro definitions later in this file, in order to satisfy XPG4.2
617 * requirements.
618 */
619
620extern NCURSES_EXPORT(int) addch (const chtype); /* generated */
621extern NCURSES_EXPORT(int) addchnstr (const chtype *, int); /* generated */
622extern NCURSES_EXPORT(int) addchstr (const chtype *); /* generated */
623extern NCURSES_EXPORT(int) addnstr (const char *, int); /* generated */
624extern NCURSES_EXPORT(int) addstr (const char *); /* generated */
625extern NCURSES_EXPORT(int) attroff (NCURSES_ATTR_T); /* generated */
626extern NCURSES_EXPORT(int) attron (NCURSES_ATTR_T); /* generated */
627extern NCURSES_EXPORT(int) attrset (NCURSES_ATTR_T); /* generated */
Steve Kondikae271bc2015-11-15 02:50:53 +0100628extern NCURSES_EXPORT(int) attr_get (attr_t *, NCURSES_PAIRS_T *, void *); /* generated */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530629extern NCURSES_EXPORT(int) attr_off (attr_t, void *); /* generated */
630extern NCURSES_EXPORT(int) attr_on (attr_t, void *); /* generated */
Steve Kondikae271bc2015-11-15 02:50:53 +0100631extern NCURSES_EXPORT(int) attr_set (attr_t, NCURSES_PAIRS_T, void *); /* generated */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530632extern NCURSES_EXPORT(int) baudrate (void); /* implemented */
633extern NCURSES_EXPORT(int) beep (void); /* implemented */
634extern NCURSES_EXPORT(int) bkgd (chtype); /* generated */
635extern NCURSES_EXPORT(void) bkgdset (chtype); /* generated */
636extern NCURSES_EXPORT(int) border (chtype,chtype,chtype,chtype,chtype,chtype,chtype,chtype); /* generated */
637extern NCURSES_EXPORT(int) box (WINDOW *, chtype, chtype); /* generated */
638extern NCURSES_EXPORT(bool) can_change_color (void); /* implemented */
639extern NCURSES_EXPORT(int) cbreak (void); /* implemented */
Steve Kondikae271bc2015-11-15 02:50:53 +0100640extern NCURSES_EXPORT(int) chgat (int, attr_t, NCURSES_PAIRS_T, const void *); /* generated */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530641extern NCURSES_EXPORT(int) clear (void); /* generated */
642extern NCURSES_EXPORT(int) clearok (WINDOW *,bool); /* implemented */
643extern NCURSES_EXPORT(int) clrtobot (void); /* generated */
644extern NCURSES_EXPORT(int) clrtoeol (void); /* generated */
Steve Kondikae271bc2015-11-15 02:50:53 +0100645extern NCURSES_EXPORT(int) color_content (NCURSES_COLOR_T,NCURSES_COLOR_T*,NCURSES_COLOR_T*,NCURSES_COLOR_T*); /* implemented */
646extern NCURSES_EXPORT(int) color_set (NCURSES_PAIRS_T,void*); /* generated */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530647extern NCURSES_EXPORT(int) COLOR_PAIR (int); /* generated */
648extern NCURSES_EXPORT(int) copywin (const WINDOW*,WINDOW*,int,int,int,int,int,int,int); /* implemented */
649extern NCURSES_EXPORT(int) curs_set (int); /* implemented */
650extern NCURSES_EXPORT(int) def_prog_mode (void); /* implemented */
651extern NCURSES_EXPORT(int) def_shell_mode (void); /* implemented */
652extern NCURSES_EXPORT(int) delay_output (int); /* implemented */
653extern NCURSES_EXPORT(int) delch (void); /* generated */
654extern NCURSES_EXPORT(void) delscreen (SCREEN *); /* implemented */
655extern NCURSES_EXPORT(int) delwin (WINDOW *); /* implemented */
656extern NCURSES_EXPORT(int) deleteln (void); /* generated */
657extern NCURSES_EXPORT(WINDOW *) derwin (WINDOW *,int,int,int,int); /* implemented */
658extern NCURSES_EXPORT(int) doupdate (void); /* implemented */
659extern NCURSES_EXPORT(WINDOW *) dupwin (WINDOW *); /* implemented */
660extern NCURSES_EXPORT(int) echo (void); /* implemented */
661extern NCURSES_EXPORT(int) echochar (const chtype); /* generated */
662extern NCURSES_EXPORT(int) erase (void); /* generated */
663extern NCURSES_EXPORT(int) endwin (void); /* implemented */
664extern NCURSES_EXPORT(char) erasechar (void); /* implemented */
665extern NCURSES_EXPORT(void) filter (void); /* implemented */
666extern NCURSES_EXPORT(int) flash (void); /* implemented */
667extern NCURSES_EXPORT(int) flushinp (void); /* implemented */
668extern NCURSES_EXPORT(chtype) getbkgd (WINDOW *); /* generated */
669extern NCURSES_EXPORT(int) getch (void); /* generated */
670extern NCURSES_EXPORT(int) getnstr (char *, int); /* generated */
671extern NCURSES_EXPORT(int) getstr (char *); /* generated */
672extern NCURSES_EXPORT(WINDOW *) getwin (FILE *); /* implemented */
673extern NCURSES_EXPORT(int) halfdelay (int); /* implemented */
674extern NCURSES_EXPORT(bool) has_colors (void); /* implemented */
675extern NCURSES_EXPORT(bool) has_ic (void); /* implemented */
676extern NCURSES_EXPORT(bool) has_il (void); /* implemented */
677extern NCURSES_EXPORT(int) hline (chtype, int); /* generated */
678extern NCURSES_EXPORT(void) idcok (WINDOW *, bool); /* implemented */
679extern NCURSES_EXPORT(int) idlok (WINDOW *, bool); /* implemented */
680extern NCURSES_EXPORT(void) immedok (WINDOW *, bool); /* implemented */
681extern NCURSES_EXPORT(chtype) inch (void); /* generated */
682extern NCURSES_EXPORT(int) inchnstr (chtype *, int); /* generated */
683extern NCURSES_EXPORT(int) inchstr (chtype *); /* generated */
684extern NCURSES_EXPORT(WINDOW *) initscr (void); /* implemented */
Steve Kondikae271bc2015-11-15 02:50:53 +0100685extern NCURSES_EXPORT(int) init_color (NCURSES_COLOR_T,NCURSES_COLOR_T,NCURSES_COLOR_T,NCURSES_COLOR_T); /* implemented */
686extern NCURSES_EXPORT(int) init_pair (NCURSES_PAIRS_T,NCURSES_COLOR_T,NCURSES_COLOR_T); /* implemented */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530687extern NCURSES_EXPORT(int) innstr (char *, int); /* generated */
688extern NCURSES_EXPORT(int) insch (chtype); /* generated */
689extern NCURSES_EXPORT(int) insdelln (int); /* generated */
690extern NCURSES_EXPORT(int) insertln (void); /* generated */
691extern NCURSES_EXPORT(int) insnstr (const char *, int); /* generated */
692extern NCURSES_EXPORT(int) insstr (const char *); /* generated */
693extern NCURSES_EXPORT(int) instr (char *); /* generated */
694extern NCURSES_EXPORT(int) intrflush (WINDOW *,bool); /* implemented */
695extern NCURSES_EXPORT(bool) isendwin (void); /* implemented */
696extern NCURSES_EXPORT(bool) is_linetouched (WINDOW *,int); /* implemented */
697extern NCURSES_EXPORT(bool) is_wintouched (WINDOW *); /* implemented */
698extern NCURSES_EXPORT(NCURSES_CONST char *) keyname (int); /* implemented */
699extern NCURSES_EXPORT(int) keypad (WINDOW *,bool); /* implemented */
700extern NCURSES_EXPORT(char) killchar (void); /* implemented */
701extern NCURSES_EXPORT(int) leaveok (WINDOW *,bool); /* implemented */
702extern NCURSES_EXPORT(char *) longname (void); /* implemented */
703extern NCURSES_EXPORT(int) meta (WINDOW *,bool); /* implemented */
704extern NCURSES_EXPORT(int) move (int, int); /* generated */
705extern NCURSES_EXPORT(int) mvaddch (int, int, const chtype); /* generated */
706extern NCURSES_EXPORT(int) mvaddchnstr (int, int, const chtype *, int); /* generated */
707extern NCURSES_EXPORT(int) mvaddchstr (int, int, const chtype *); /* generated */
708extern NCURSES_EXPORT(int) mvaddnstr (int, int, const char *, int); /* generated */
709extern NCURSES_EXPORT(int) mvaddstr (int, int, const char *); /* generated */
Steve Kondikae271bc2015-11-15 02:50:53 +0100710extern NCURSES_EXPORT(int) mvchgat (int, int, int, attr_t, NCURSES_PAIRS_T, const void *); /* generated */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530711extern NCURSES_EXPORT(int) mvcur (int,int,int,int); /* implemented */
712extern NCURSES_EXPORT(int) mvdelch (int, int); /* generated */
713extern NCURSES_EXPORT(int) mvderwin (WINDOW *, int, int); /* implemented */
714extern NCURSES_EXPORT(int) mvgetch (int, int); /* generated */
715extern NCURSES_EXPORT(int) mvgetnstr (int, int, char *, int); /* generated */
716extern NCURSES_EXPORT(int) mvgetstr (int, int, char *); /* generated */
717extern NCURSES_EXPORT(int) mvhline (int, int, chtype, int); /* generated */
718extern NCURSES_EXPORT(chtype) mvinch (int, int); /* generated */
719extern NCURSES_EXPORT(int) mvinchnstr (int, int, chtype *, int); /* generated */
720extern NCURSES_EXPORT(int) mvinchstr (int, int, chtype *); /* generated */
721extern NCURSES_EXPORT(int) mvinnstr (int, int, char *, int); /* generated */
722extern NCURSES_EXPORT(int) mvinsch (int, int, chtype); /* generated */
723extern NCURSES_EXPORT(int) mvinsnstr (int, int, const char *, int); /* generated */
724extern NCURSES_EXPORT(int) mvinsstr (int, int, const char *); /* generated */
725extern NCURSES_EXPORT(int) mvinstr (int, int, char *); /* generated */
726extern NCURSES_EXPORT(int) mvprintw (int,int, const char *,...) /* implemented */
727 GCC_PRINTFLIKE(3,4);
micky3879b9f5e72025-07-08 18:04:53 -0400728extern NCURSES_EXPORT(int) mvscanw (int,int, const char *,...) /* implemented */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530729 GCC_SCANFLIKE(3,4);
730extern NCURSES_EXPORT(int) mvvline (int, int, chtype, int); /* generated */
731extern NCURSES_EXPORT(int) mvwaddch (WINDOW *, int, int, const chtype); /* generated */
732extern NCURSES_EXPORT(int) mvwaddchnstr (WINDOW *, int, int, const chtype *, int);/* generated */
733extern NCURSES_EXPORT(int) mvwaddchstr (WINDOW *, int, int, const chtype *); /* generated */
734extern NCURSES_EXPORT(int) mvwaddnstr (WINDOW *, int, int, const char *, int); /* generated */
735extern NCURSES_EXPORT(int) mvwaddstr (WINDOW *, int, int, const char *); /* generated */
Steve Kondikae271bc2015-11-15 02:50:53 +0100736extern NCURSES_EXPORT(int) mvwchgat (WINDOW *, int, int, int, attr_t, NCURSES_PAIRS_T, const void *);/* generated */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530737extern NCURSES_EXPORT(int) mvwdelch (WINDOW *, int, int); /* generated */
738extern NCURSES_EXPORT(int) mvwgetch (WINDOW *, int, int); /* generated */
739extern NCURSES_EXPORT(int) mvwgetnstr (WINDOW *, int, int, char *, int); /* generated */
740extern NCURSES_EXPORT(int) mvwgetstr (WINDOW *, int, int, char *); /* generated */
741extern NCURSES_EXPORT(int) mvwhline (WINDOW *, int, int, chtype, int); /* generated */
742extern NCURSES_EXPORT(int) mvwin (WINDOW *,int,int); /* implemented */
743extern NCURSES_EXPORT(chtype) mvwinch (WINDOW *, int, int); /* generated */
744extern NCURSES_EXPORT(int) mvwinchnstr (WINDOW *, int, int, chtype *, int); /* generated */
745extern NCURSES_EXPORT(int) mvwinchstr (WINDOW *, int, int, chtype *); /* generated */
746extern NCURSES_EXPORT(int) mvwinnstr (WINDOW *, int, int, char *, int); /* generated */
747extern NCURSES_EXPORT(int) mvwinsch (WINDOW *, int, int, chtype); /* generated */
748extern NCURSES_EXPORT(int) mvwinsnstr (WINDOW *, int, int, const char *, int); /* generated */
Steve Kondikae271bc2015-11-15 02:50:53 +0100749extern NCURSES_EXPORT(int) mvwinsstr (WINDOW *, int, int, const char *); /* generated */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530750extern NCURSES_EXPORT(int) mvwinstr (WINDOW *, int, int, char *); /* generated */
751extern NCURSES_EXPORT(int) mvwprintw (WINDOW*,int,int, const char *,...) /* implemented */
752 GCC_PRINTFLIKE(4,5);
micky3879b9f5e72025-07-08 18:04:53 -0400753extern NCURSES_EXPORT(int) mvwscanw (WINDOW *,int,int, const char *,...) /* implemented */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530754 GCC_SCANFLIKE(4,5);
755extern NCURSES_EXPORT(int) mvwvline (WINDOW *,int, int, chtype, int); /* generated */
756extern NCURSES_EXPORT(int) napms (int); /* implemented */
micky3879b9f5e72025-07-08 18:04:53 -0400757extern NCURSES_EXPORT(WINDOW *) newpad (int,int); /* implemented */
758extern NCURSES_EXPORT(SCREEN *) newterm (const char *,FILE *,FILE *); /* implemented */
759extern NCURSES_EXPORT(WINDOW *) newwin (int,int,int,int); /* implemented */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530760extern NCURSES_EXPORT(int) nl (void); /* implemented */
761extern NCURSES_EXPORT(int) nocbreak (void); /* implemented */
762extern NCURSES_EXPORT(int) nodelay (WINDOW *,bool); /* implemented */
763extern NCURSES_EXPORT(int) noecho (void); /* implemented */
764extern NCURSES_EXPORT(int) nonl (void); /* implemented */
765extern NCURSES_EXPORT(void) noqiflush (void); /* implemented */
766extern NCURSES_EXPORT(int) noraw (void); /* implemented */
767extern NCURSES_EXPORT(int) notimeout (WINDOW *,bool); /* implemented */
768extern NCURSES_EXPORT(int) overlay (const WINDOW*,WINDOW *); /* implemented */
769extern NCURSES_EXPORT(int) overwrite (const WINDOW*,WINDOW *); /* implemented */
Steve Kondikae271bc2015-11-15 02:50:53 +0100770extern NCURSES_EXPORT(int) pair_content (NCURSES_PAIRS_T,NCURSES_COLOR_T*,NCURSES_COLOR_T*); /* implemented */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530771extern NCURSES_EXPORT(int) PAIR_NUMBER (int); /* generated */
772extern NCURSES_EXPORT(int) pechochar (WINDOW *, const chtype); /* implemented */
773extern NCURSES_EXPORT(int) pnoutrefresh (WINDOW*,int,int,int,int,int,int);/* implemented */
774extern NCURSES_EXPORT(int) prefresh (WINDOW *,int,int,int,int,int,int); /* implemented */
775extern NCURSES_EXPORT(int) printw (const char *,...) /* implemented */
776 GCC_PRINTFLIKE(1,2);
777extern NCURSES_EXPORT(int) putwin (WINDOW *, FILE *); /* implemented */
778extern NCURSES_EXPORT(void) qiflush (void); /* implemented */
779extern NCURSES_EXPORT(int) raw (void); /* implemented */
780extern NCURSES_EXPORT(int) redrawwin (WINDOW *); /* generated */
781extern NCURSES_EXPORT(int) refresh (void); /* generated */
782extern NCURSES_EXPORT(int) resetty (void); /* implemented */
783extern NCURSES_EXPORT(int) reset_prog_mode (void); /* implemented */
784extern NCURSES_EXPORT(int) reset_shell_mode (void); /* implemented */
785extern NCURSES_EXPORT(int) ripoffline (int, int (*)(WINDOW *, int)); /* implemented */
786extern NCURSES_EXPORT(int) savetty (void); /* implemented */
micky3879b9f5e72025-07-08 18:04:53 -0400787extern NCURSES_EXPORT(int) scanw (const char *,...) /* implemented */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530788 GCC_SCANFLIKE(1,2);
789extern NCURSES_EXPORT(int) scr_dump (const char *); /* implemented */
790extern NCURSES_EXPORT(int) scr_init (const char *); /* implemented */
791extern NCURSES_EXPORT(int) scrl (int); /* generated */
792extern NCURSES_EXPORT(int) scroll (WINDOW *); /* generated */
793extern NCURSES_EXPORT(int) scrollok (WINDOW *,bool); /* implemented */
794extern NCURSES_EXPORT(int) scr_restore (const char *); /* implemented */
795extern NCURSES_EXPORT(int) scr_set (const char *); /* implemented */
796extern NCURSES_EXPORT(int) setscrreg (int,int); /* generated */
797extern NCURSES_EXPORT(SCREEN *) set_term (SCREEN *); /* implemented */
798extern NCURSES_EXPORT(int) slk_attroff (const chtype); /* implemented */
799extern NCURSES_EXPORT(int) slk_attr_off (const attr_t, void *); /* generated:WIDEC */
800extern NCURSES_EXPORT(int) slk_attron (const chtype); /* implemented */
801extern NCURSES_EXPORT(int) slk_attr_on (attr_t,void*); /* generated:WIDEC */
802extern NCURSES_EXPORT(int) slk_attrset (const chtype); /* implemented */
803extern NCURSES_EXPORT(attr_t) slk_attr (void); /* implemented */
Steve Kondikae271bc2015-11-15 02:50:53 +0100804extern NCURSES_EXPORT(int) slk_attr_set (const attr_t,NCURSES_PAIRS_T,void*); /* implemented */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530805extern NCURSES_EXPORT(int) slk_clear (void); /* implemented */
Steve Kondikae271bc2015-11-15 02:50:53 +0100806extern NCURSES_EXPORT(int) slk_color (NCURSES_PAIRS_T); /* implemented */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530807extern NCURSES_EXPORT(int) slk_init (int); /* implemented */
808extern NCURSES_EXPORT(char *) slk_label (int); /* implemented */
809extern NCURSES_EXPORT(int) slk_noutrefresh (void); /* implemented */
810extern NCURSES_EXPORT(int) slk_refresh (void); /* implemented */
811extern NCURSES_EXPORT(int) slk_restore (void); /* implemented */
812extern NCURSES_EXPORT(int) slk_set (int,const char *,int); /* implemented */
micky3879b9f5e72025-07-08 18:04:53 -0400813extern NCURSES_EXPORT(int) slk_touch (void); /* implemented */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530814extern NCURSES_EXPORT(int) standout (void); /* generated */
815extern NCURSES_EXPORT(int) standend (void); /* generated */
816extern NCURSES_EXPORT(int) start_color (void); /* implemented */
817extern NCURSES_EXPORT(WINDOW *) subpad (WINDOW *, int, int, int, int); /* implemented */
818extern NCURSES_EXPORT(WINDOW *) subwin (WINDOW *, int, int, int, int); /* implemented */
819extern NCURSES_EXPORT(int) syncok (WINDOW *, bool); /* implemented */
820extern NCURSES_EXPORT(chtype) termattrs (void); /* implemented */
821extern NCURSES_EXPORT(char *) termname (void); /* implemented */
822extern NCURSES_EXPORT(void) timeout (int); /* generated */
823extern NCURSES_EXPORT(int) touchline (WINDOW *, int, int); /* generated */
824extern NCURSES_EXPORT(int) touchwin (WINDOW *); /* generated */
825extern NCURSES_EXPORT(int) typeahead (int); /* implemented */
826extern NCURSES_EXPORT(int) ungetch (int); /* implemented */
827extern NCURSES_EXPORT(int) untouchwin (WINDOW *); /* generated */
828extern NCURSES_EXPORT(void) use_env (bool); /* implemented */
Steve Kondikae271bc2015-11-15 02:50:53 +0100829extern NCURSES_EXPORT(void) use_tioctl (bool); /* implemented */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530830extern NCURSES_EXPORT(int) vidattr (chtype); /* implemented */
Steve Kondikae271bc2015-11-15 02:50:53 +0100831extern NCURSES_EXPORT(int) vidputs (chtype, NCURSES_OUTC); /* implemented */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530832extern NCURSES_EXPORT(int) vline (chtype, int); /* generated */
micky3879b9f5e72025-07-08 18:04:53 -0400833extern NCURSES_EXPORT(int) vwprintw (WINDOW *, const char *, va_list) GCC_DEPRECATED(use vw_printw) /* implemented */
834 GCC_PRINTFLIKE(2,0);
835extern NCURSES_EXPORT(int) vw_printw (WINDOW *, const char *, va_list) /* implemented */
836 GCC_PRINTFLIKE(2,0);
837extern NCURSES_EXPORT(int) vwscanw (WINDOW *, const char *, va_list) GCC_DEPRECATED(use vw_scanw) /* implemented */
838 GCC_SCANFLIKE(2,0);
839extern NCURSES_EXPORT(int) vw_scanw (WINDOW *, const char *, va_list) /* implemented */
840 GCC_SCANFLIKE(2,0);
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530841extern NCURSES_EXPORT(int) waddch (WINDOW *, const chtype); /* implemented */
842extern NCURSES_EXPORT(int) waddchnstr (WINDOW *,const chtype *,int); /* implemented */
843extern NCURSES_EXPORT(int) waddchstr (WINDOW *,const chtype *); /* generated */
844extern NCURSES_EXPORT(int) waddnstr (WINDOW *,const char *,int); /* implemented */
845extern NCURSES_EXPORT(int) waddstr (WINDOW *,const char *); /* generated */
846extern NCURSES_EXPORT(int) wattron (WINDOW *, int); /* generated */
847extern NCURSES_EXPORT(int) wattroff (WINDOW *, int); /* generated */
848extern NCURSES_EXPORT(int) wattrset (WINDOW *, int); /* generated */
Steve Kondikae271bc2015-11-15 02:50:53 +0100849extern NCURSES_EXPORT(int) wattr_get (WINDOW *, attr_t *, NCURSES_PAIRS_T *, void *); /* generated */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530850extern NCURSES_EXPORT(int) wattr_on (WINDOW *, attr_t, void *); /* implemented */
851extern NCURSES_EXPORT(int) wattr_off (WINDOW *, attr_t, void *); /* implemented */
Steve Kondikae271bc2015-11-15 02:50:53 +0100852extern NCURSES_EXPORT(int) wattr_set (WINDOW *, attr_t, NCURSES_PAIRS_T, void *); /* generated */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530853extern NCURSES_EXPORT(int) wbkgd (WINDOW *, chtype); /* implemented */
854extern NCURSES_EXPORT(void) wbkgdset (WINDOW *,chtype); /* implemented */
855extern NCURSES_EXPORT(int) wborder (WINDOW *,chtype,chtype,chtype,chtype,chtype,chtype,chtype,chtype); /* implemented */
Steve Kondikae271bc2015-11-15 02:50:53 +0100856extern NCURSES_EXPORT(int) wchgat (WINDOW *, int, attr_t, NCURSES_PAIRS_T, const void *);/* implemented */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530857extern NCURSES_EXPORT(int) wclear (WINDOW *); /* implemented */
858extern NCURSES_EXPORT(int) wclrtobot (WINDOW *); /* implemented */
859extern NCURSES_EXPORT(int) wclrtoeol (WINDOW *); /* implemented */
Steve Kondikae271bc2015-11-15 02:50:53 +0100860extern NCURSES_EXPORT(int) wcolor_set (WINDOW*,NCURSES_PAIRS_T,void*); /* implemented */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530861extern NCURSES_EXPORT(void) wcursyncup (WINDOW *); /* implemented */
862extern NCURSES_EXPORT(int) wdelch (WINDOW *); /* implemented */
863extern NCURSES_EXPORT(int) wdeleteln (WINDOW *); /* generated */
864extern NCURSES_EXPORT(int) wechochar (WINDOW *, const chtype); /* implemented */
865extern NCURSES_EXPORT(int) werase (WINDOW *); /* implemented */
866extern NCURSES_EXPORT(int) wgetch (WINDOW *); /* implemented */
867extern NCURSES_EXPORT(int) wgetnstr (WINDOW *,char *,int); /* implemented */
868extern NCURSES_EXPORT(int) wgetstr (WINDOW *, char *); /* generated */
869extern NCURSES_EXPORT(int) whline (WINDOW *, chtype, int); /* implemented */
870extern NCURSES_EXPORT(chtype) winch (WINDOW *); /* implemented */
871extern NCURSES_EXPORT(int) winchnstr (WINDOW *, chtype *, int); /* implemented */
872extern NCURSES_EXPORT(int) winchstr (WINDOW *, chtype *); /* generated */
873extern NCURSES_EXPORT(int) winnstr (WINDOW *, char *, int); /* implemented */
874extern NCURSES_EXPORT(int) winsch (WINDOW *, chtype); /* implemented */
875extern NCURSES_EXPORT(int) winsdelln (WINDOW *,int); /* implemented */
876extern NCURSES_EXPORT(int) winsertln (WINDOW *); /* generated */
877extern NCURSES_EXPORT(int) winsnstr (WINDOW *, const char *,int); /* implemented */
878extern NCURSES_EXPORT(int) winsstr (WINDOW *, const char *); /* generated */
879extern NCURSES_EXPORT(int) winstr (WINDOW *, char *); /* generated */
880extern NCURSES_EXPORT(int) wmove (WINDOW *,int,int); /* implemented */
881extern NCURSES_EXPORT(int) wnoutrefresh (WINDOW *); /* implemented */
882extern NCURSES_EXPORT(int) wprintw (WINDOW *, const char *,...) /* implemented */
883 GCC_PRINTFLIKE(2,3);
884extern NCURSES_EXPORT(int) wredrawln (WINDOW *,int,int); /* implemented */
885extern NCURSES_EXPORT(int) wrefresh (WINDOW *); /* implemented */
micky3879b9f5e72025-07-08 18:04:53 -0400886extern NCURSES_EXPORT(int) wscanw (WINDOW *, const char *,...) /* implemented */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530887 GCC_SCANFLIKE(2,3);
888extern NCURSES_EXPORT(int) wscrl (WINDOW *,int); /* implemented */
889extern NCURSES_EXPORT(int) wsetscrreg (WINDOW *,int,int); /* implemented */
890extern NCURSES_EXPORT(int) wstandout (WINDOW *); /* generated */
891extern NCURSES_EXPORT(int) wstandend (WINDOW *); /* generated */
892extern NCURSES_EXPORT(void) wsyncdown (WINDOW *); /* implemented */
893extern NCURSES_EXPORT(void) wsyncup (WINDOW *); /* implemented */
894extern NCURSES_EXPORT(void) wtimeout (WINDOW *,int); /* implemented */
895extern NCURSES_EXPORT(int) wtouchln (WINDOW *,int,int,int); /* implemented */
896extern NCURSES_EXPORT(int) wvline (WINDOW *,chtype,int); /* implemented */
897
898/*
899 * These are also declared in <term.h>:
900 */
micky3879b9f5e72025-07-08 18:04:53 -0400901extern NCURSES_EXPORT(int) tigetflag (const char *); /* implemented */
902extern NCURSES_EXPORT(int) tigetnum (const char *); /* implemented */
903extern NCURSES_EXPORT(char *) tigetstr (const char *); /* implemented */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530904extern NCURSES_EXPORT(int) putp (const char *); /* implemented */
905
906#if NCURSES_TPARM_VARARGS
micky3879b9f5e72025-07-08 18:04:53 -0400907extern NCURSES_EXPORT(char *) tparm (const char *, ...); /* special */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530908#else
micky3879b9f5e72025-07-08 18:04:53 -0400909extern NCURSES_EXPORT(char *) tparm (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 +0530910#endif
911
Steve Kondikae271bc2015-11-15 02:50:53 +0100912extern NCURSES_EXPORT(char *) tiparm (const char *, ...); /* special */
micky3879b9f5e72025-07-08 18:04:53 -0400913extern NCURSES_EXPORT(char *) tiparm_s (int, int, const char *, ...); /* special */
914extern NCURSES_EXPORT(int) tiscan_s (int *, int *, const char *); /* special */
Steve Kondikae271bc2015-11-15 02:50:53 +0100915
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530916/*
917 * These functions are not in X/Open, but we use them in macro definitions:
918 */
919extern NCURSES_EXPORT(int) getattrs (const WINDOW *); /* generated */
920extern NCURSES_EXPORT(int) getcurx (const WINDOW *); /* generated */
921extern NCURSES_EXPORT(int) getcury (const WINDOW *); /* generated */
922extern NCURSES_EXPORT(int) getbegx (const WINDOW *); /* generated */
923extern NCURSES_EXPORT(int) getbegy (const WINDOW *); /* generated */
924extern NCURSES_EXPORT(int) getmaxx (const WINDOW *); /* generated */
925extern NCURSES_EXPORT(int) getmaxy (const WINDOW *); /* generated */
926extern NCURSES_EXPORT(int) getparx (const WINDOW *); /* generated */
927extern NCURSES_EXPORT(int) getpary (const WINDOW *); /* generated */
928
929/*
930 * vid_attr() was implemented originally based on a draft of X/Open curses.
931 */
Steve Kondikae271bc2015-11-15 02:50:53 +0100932#if !NCURSES_WIDECHAR
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530933#define vid_attr(a,pair,opts) vidattr(a)
934#endif
935
936/*
937 * These functions are extensions - not in X/Open Curses.
938 */
939#if @NCURSES_EXT_FUNCS@
940#undef NCURSES_EXT_FUNCS
941#define NCURSES_EXT_FUNCS @NCURSES_PATCH@
942typedef int (*NCURSES_WINDOW_CB)(WINDOW *, void *);
943typedef int (*NCURSES_SCREEN_CB)(SCREEN *, void *);
micky3879b9f5e72025-07-08 18:04:53 -0400944extern NCURSES_EXPORT(int) alloc_pair (int, int);
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530945extern NCURSES_EXPORT(int) assume_default_colors (int, int);
micky3879b9f5e72025-07-08 18:04:53 -0400946extern NCURSES_EXPORT(const char *) curses_version (void);
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530947extern NCURSES_EXPORT(int) define_key (const char *, int);
micky3879b9f5e72025-07-08 18:04:53 -0400948extern NCURSES_EXPORT(int) extended_color_content(int, int *, int *, int *);
949extern NCURSES_EXPORT(int) extended_pair_content(int, int *, int *);
950extern NCURSES_EXPORT(int) extended_slk_color(int);
951extern NCURSES_EXPORT(int) find_pair (int, int);
952extern NCURSES_EXPORT(int) free_pair (int);
Steve Kondikae271bc2015-11-15 02:50:53 +0100953extern NCURSES_EXPORT(int) get_escdelay (void);
micky3879b9f5e72025-07-08 18:04:53 -0400954extern NCURSES_EXPORT(int) init_extended_color(int, int, int, int);
955extern NCURSES_EXPORT(int) init_extended_pair(int, int, int);
956extern NCURSES_EXPORT(int) is_cbreak(void);
957extern NCURSES_EXPORT(int) is_echo(void);
958extern NCURSES_EXPORT(int) is_nl(void);
959extern NCURSES_EXPORT(int) is_raw(void);
960extern NCURSES_EXPORT(bool) is_term_resized (int, int);
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530961extern NCURSES_EXPORT(int) key_defined (const char *);
micky3879b9f5e72025-07-08 18:04:53 -0400962extern NCURSES_EXPORT(char *) keybound (int, int);
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530963extern NCURSES_EXPORT(int) keyok (int, bool);
micky3879b9f5e72025-07-08 18:04:53 -0400964extern NCURSES_EXPORT(void) nofilter(void);
965extern NCURSES_EXPORT(void) reset_color_pairs (void);
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530966extern NCURSES_EXPORT(int) resize_term (int, int);
967extern NCURSES_EXPORT(int) resizeterm (int, int);
968extern NCURSES_EXPORT(int) set_escdelay (int);
969extern NCURSES_EXPORT(int) set_tabsize (int);
970extern NCURSES_EXPORT(int) use_default_colors (void);
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530971extern NCURSES_EXPORT(int) use_legacy_coding (int);
972extern NCURSES_EXPORT(int) use_screen (SCREEN *, NCURSES_SCREEN_CB, void *);
973extern NCURSES_EXPORT(int) use_window (WINDOW *, NCURSES_WINDOW_CB, void *);
974extern NCURSES_EXPORT(int) wresize (WINDOW *, int, int);
micky3879b9f5e72025-07-08 18:04:53 -0400975
976#if @NCURSES_XNAMES@
977#undef NCURSES_XNAMES
978#define NCURSES_XNAMES @NCURSES_XNAMES@
979extern NCURSES_EXPORT(int) use_extended_names (bool);
980#endif
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530981
982/*
983 * These extensions provide access to information stored in the WINDOW even
984 * when NCURSES_OPAQUE is set:
985 */
Steve Kondikae271bc2015-11-15 02:50:53 +0100986extern NCURSES_EXPORT(WINDOW *) wgetparent (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
987extern NCURSES_EXPORT(bool) is_cleared (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
988extern NCURSES_EXPORT(bool) is_idcok (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
989extern NCURSES_EXPORT(bool) is_idlok (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
990extern NCURSES_EXPORT(bool) is_immedok (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
991extern NCURSES_EXPORT(bool) is_keypad (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
992extern NCURSES_EXPORT(bool) is_leaveok (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
993extern NCURSES_EXPORT(bool) is_nodelay (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
994extern NCURSES_EXPORT(bool) is_notimeout (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
995extern NCURSES_EXPORT(bool) is_pad (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
996extern NCURSES_EXPORT(bool) is_scrollok (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
997extern NCURSES_EXPORT(bool) is_subwin (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
998extern NCURSES_EXPORT(bool) is_syncok (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
999extern NCURSES_EXPORT(int) wgetdelay (const WINDOW *); /* @GENERATED_EXT_FUNCS@ */
1000extern NCURSES_EXPORT(int) wgetscrreg (const WINDOW *, int *, int *); /* @GENERATED_EXT_FUNCS@ */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301001
1002#else
1003#define curses_version() NCURSES_VERSION
1004#endif
1005
Steve Kondikae271bc2015-11-15 02:50:53 +01001006/*
1007 * Extra extension-functions, which pass a SCREEN pointer rather than using
1008 * a global variable SP.
1009 */
1010#if @NCURSES_SP_FUNCS@
1011#undef NCURSES_SP_FUNCS
1012#define NCURSES_SP_FUNCS @NCURSES_PATCH@
1013#define NCURSES_SP_NAME(name) name##_sp
1014
1015/* Define the sp-funcs helper function */
1016#define NCURSES_SP_OUTC NCURSES_SP_NAME(NCURSES_OUTC)
1017typedef int (*NCURSES_SP_OUTC)(SCREEN*, int);
1018
1019extern NCURSES_EXPORT(SCREEN *) new_prescr (void); /* implemented:SP_FUNC */
1020
1021extern NCURSES_EXPORT(int) NCURSES_SP_NAME(baudrate) (SCREEN*); /* implemented:SP_FUNC */
1022extern NCURSES_EXPORT(int) NCURSES_SP_NAME(beep) (SCREEN*); /* implemented:SP_FUNC */
1023extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(can_change_color) (SCREEN*); /* implemented:SP_FUNC */
1024extern NCURSES_EXPORT(int) NCURSES_SP_NAME(cbreak) (SCREEN*); /* implemented:SP_FUNC */
1025extern NCURSES_EXPORT(int) NCURSES_SP_NAME(curs_set) (SCREEN*, int); /* implemented:SP_FUNC */
1026extern NCURSES_EXPORT(int) NCURSES_SP_NAME(color_content) (SCREEN*, NCURSES_PAIRS_T, NCURSES_COLOR_T*, NCURSES_COLOR_T*, NCURSES_COLOR_T*); /* implemented:SP_FUNC */
1027extern NCURSES_EXPORT(int) NCURSES_SP_NAME(def_prog_mode) (SCREEN*); /* implemented:SP_FUNC */
1028extern NCURSES_EXPORT(int) NCURSES_SP_NAME(def_shell_mode) (SCREEN*); /* implemented:SP_FUNC */
1029extern NCURSES_EXPORT(int) NCURSES_SP_NAME(delay_output) (SCREEN*, int); /* implemented:SP_FUNC */
1030extern NCURSES_EXPORT(int) NCURSES_SP_NAME(doupdate) (SCREEN*); /* implemented:SP_FUNC */
1031extern NCURSES_EXPORT(int) NCURSES_SP_NAME(echo) (SCREEN*); /* implemented:SP_FUNC */
1032extern NCURSES_EXPORT(int) NCURSES_SP_NAME(endwin) (SCREEN*); /* implemented:SP_FUNC */
1033extern NCURSES_EXPORT(char) NCURSES_SP_NAME(erasechar) (SCREEN*);/* implemented:SP_FUNC */
1034extern NCURSES_EXPORT(void) NCURSES_SP_NAME(filter) (SCREEN*); /* implemented:SP_FUNC */
1035extern NCURSES_EXPORT(int) NCURSES_SP_NAME(flash) (SCREEN*); /* implemented:SP_FUNC */
1036extern NCURSES_EXPORT(int) NCURSES_SP_NAME(flushinp) (SCREEN*); /* implemented:SP_FUNC */
1037extern NCURSES_EXPORT(WINDOW *) NCURSES_SP_NAME(getwin) (SCREEN*, FILE *); /* implemented:SP_FUNC */
1038extern NCURSES_EXPORT(int) NCURSES_SP_NAME(halfdelay) (SCREEN*, int); /* implemented:SP_FUNC */
1039extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(has_colors) (SCREEN*); /* implemented:SP_FUNC */
1040extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(has_ic) (SCREEN*); /* implemented:SP_FUNC */
1041extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(has_il) (SCREEN*); /* implemented:SP_FUNC */
1042extern NCURSES_EXPORT(int) NCURSES_SP_NAME(init_color) (SCREEN*, NCURSES_COLOR_T, NCURSES_COLOR_T, NCURSES_COLOR_T, NCURSES_COLOR_T); /* implemented:SP_FUNC */
1043extern NCURSES_EXPORT(int) NCURSES_SP_NAME(init_pair) (SCREEN*, NCURSES_PAIRS_T, NCURSES_COLOR_T, NCURSES_COLOR_T); /* implemented:SP_FUNC */
1044extern NCURSES_EXPORT(int) NCURSES_SP_NAME(intrflush) (SCREEN*, WINDOW*, bool); /* implemented:SP_FUNC */
1045extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(isendwin) (SCREEN*); /* implemented:SP_FUNC */
1046extern NCURSES_EXPORT(NCURSES_CONST char *) NCURSES_SP_NAME(keyname) (SCREEN*, int); /* implemented:SP_FUNC */
1047extern NCURSES_EXPORT(char) NCURSES_SP_NAME(killchar) (SCREEN*); /* implemented:SP_FUNC */
1048extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(longname) (SCREEN*); /* implemented:SP_FUNC */
1049extern NCURSES_EXPORT(int) NCURSES_SP_NAME(mvcur) (SCREEN*, int, int, int, int); /* implemented:SP_FUNC */
1050extern NCURSES_EXPORT(int) NCURSES_SP_NAME(napms) (SCREEN*, int); /* implemented:SP_FUNC */
1051extern NCURSES_EXPORT(WINDOW *) NCURSES_SP_NAME(newpad) (SCREEN*, int, int); /* implemented:SP_FUNC */
micky3879b9f5e72025-07-08 18:04:53 -04001052extern NCURSES_EXPORT(SCREEN *) NCURSES_SP_NAME(newterm) (SCREEN*, const char *, FILE *, FILE *); /* implemented:SP_FUNC */
Steve Kondikae271bc2015-11-15 02:50:53 +01001053extern NCURSES_EXPORT(WINDOW *) NCURSES_SP_NAME(newwin) (SCREEN*, int, int, int, int); /* implemented:SP_FUNC */
1054extern NCURSES_EXPORT(int) NCURSES_SP_NAME(nl) (SCREEN*); /* implemented:SP_FUNC */
1055extern NCURSES_EXPORT(int) NCURSES_SP_NAME(nocbreak) (SCREEN*); /* implemented:SP_FUNC */
1056extern NCURSES_EXPORT(int) NCURSES_SP_NAME(noecho) (SCREEN*); /* implemented:SP_FUNC */
1057extern NCURSES_EXPORT(int) NCURSES_SP_NAME(nonl) (SCREEN*); /* implemented:SP_FUNC */
1058extern NCURSES_EXPORT(void) NCURSES_SP_NAME(noqiflush) (SCREEN*); /* implemented:SP_FUNC */
1059extern NCURSES_EXPORT(int) NCURSES_SP_NAME(noraw) (SCREEN*); /* implemented:SP_FUNC */
1060extern NCURSES_EXPORT(int) NCURSES_SP_NAME(pair_content) (SCREEN*, NCURSES_PAIRS_T, NCURSES_COLOR_T*, NCURSES_COLOR_T*); /* implemented:SP_FUNC */
1061extern NCURSES_EXPORT(void) NCURSES_SP_NAME(qiflush) (SCREEN*); /* implemented:SP_FUNC */
1062extern NCURSES_EXPORT(int) NCURSES_SP_NAME(raw) (SCREEN*); /* implemented:SP_FUNC */
1063extern NCURSES_EXPORT(int) NCURSES_SP_NAME(reset_prog_mode) (SCREEN*); /* implemented:SP_FUNC */
1064extern NCURSES_EXPORT(int) NCURSES_SP_NAME(reset_shell_mode) (SCREEN*); /* implemented:SP_FUNC */
1065extern NCURSES_EXPORT(int) NCURSES_SP_NAME(resetty) (SCREEN*); /* implemented:SP_FUNC */
1066extern NCURSES_EXPORT(int) NCURSES_SP_NAME(ripoffline) (SCREEN*, int, int (*)(WINDOW *, int)); /* implemented:SP_FUNC */
1067extern NCURSES_EXPORT(int) NCURSES_SP_NAME(savetty) (SCREEN*); /* implemented:SP_FUNC */
1068extern NCURSES_EXPORT(int) NCURSES_SP_NAME(scr_init) (SCREEN*, const char *); /* implemented:SP_FUNC */
1069extern NCURSES_EXPORT(int) NCURSES_SP_NAME(scr_restore) (SCREEN*, const char *); /* implemented:SP_FUNC */
1070extern NCURSES_EXPORT(int) NCURSES_SP_NAME(scr_set) (SCREEN*, const char *); /* implemented:SP_FUNC */
1071extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_attroff) (SCREEN*, const chtype); /* implemented:SP_FUNC */
1072extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_attron) (SCREEN*, const chtype); /* implemented:SP_FUNC */
1073extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_attrset) (SCREEN*, const chtype); /* implemented:SP_FUNC */
1074extern NCURSES_EXPORT(attr_t) NCURSES_SP_NAME(slk_attr) (SCREEN*); /* implemented:SP_FUNC */
1075extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_attr_set) (SCREEN*, const attr_t, NCURSES_PAIRS_T, void*); /* implemented:SP_FUNC */
1076extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_clear) (SCREEN*); /* implemented:SP_FUNC */
1077extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_color) (SCREEN*, NCURSES_PAIRS_T); /* implemented:SP_FUNC */
1078extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_init) (SCREEN*, int); /* implemented:SP_FUNC */
1079extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(slk_label) (SCREEN*, int); /* implemented:SP_FUNC */
1080extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_noutrefresh) (SCREEN*); /* implemented:SP_FUNC */
1081extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_refresh) (SCREEN*); /* implemented:SP_FUNC */
1082extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_restore) (SCREEN*); /* implemented:SP_FUNC */
1083extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_set) (SCREEN*, int, const char *, int); /* implemented:SP_FUNC */
1084extern NCURSES_EXPORT(int) NCURSES_SP_NAME(slk_touch) (SCREEN*); /* implemented:SP_FUNC */
1085extern NCURSES_EXPORT(int) NCURSES_SP_NAME(start_color) (SCREEN*); /* implemented:SP_FUNC */
1086extern NCURSES_EXPORT(chtype) NCURSES_SP_NAME(termattrs) (SCREEN*); /* implemented:SP_FUNC */
1087extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(termname) (SCREEN*); /* implemented:SP_FUNC */
1088extern NCURSES_EXPORT(int) NCURSES_SP_NAME(typeahead) (SCREEN*, int); /* implemented:SP_FUNC */
1089extern NCURSES_EXPORT(int) NCURSES_SP_NAME(ungetch) (SCREEN*, int); /* implemented:SP_FUNC */
1090extern NCURSES_EXPORT(void) NCURSES_SP_NAME(use_env) (SCREEN*, bool); /* implemented:SP_FUNC */
1091extern NCURSES_EXPORT(void) NCURSES_SP_NAME(use_tioctl) (SCREEN*, bool); /* implemented:SP_FUNC */
1092extern NCURSES_EXPORT(int) NCURSES_SP_NAME(vidattr) (SCREEN*, chtype); /* implemented:SP_FUNC */
1093extern NCURSES_EXPORT(int) NCURSES_SP_NAME(vidputs) (SCREEN*, chtype, NCURSES_SP_OUTC); /* implemented:SP_FUNC */
1094#if @NCURSES_EXT_FUNCS@
micky3879b9f5e72025-07-08 18:04:53 -04001095extern NCURSES_EXPORT(int) NCURSES_SP_NAME(alloc_pair) (SCREEN*, int, int); /* implemented:EXT_SP_FUNC */
Steve Kondikae271bc2015-11-15 02:50:53 +01001096extern NCURSES_EXPORT(int) NCURSES_SP_NAME(assume_default_colors) (SCREEN*, int, int); /* implemented:EXT_SP_FUNC */
1097extern NCURSES_EXPORT(int) NCURSES_SP_NAME(define_key) (SCREEN*, const char *, int); /* implemented:EXT_SP_FUNC */
micky3879b9f5e72025-07-08 18:04:53 -04001098extern NCURSES_EXPORT(int) NCURSES_SP_NAME(extended_color_content) (SCREEN*, int, int *, int *, int *); /* implemented:EXT_SP_FUNC */
1099extern NCURSES_EXPORT(int) NCURSES_SP_NAME(extended_pair_content) (SCREEN*, int, int *, int *); /* implemented:EXT_SP_FUNC */
1100extern NCURSES_EXPORT(int) NCURSES_SP_NAME(extended_slk_color) (SCREEN*, int); /* implemented:EXT_SP_FUNC */
1101extern NCURSES_EXPORT(int) NCURSES_SP_NAME(find_pair) (SCREEN*, int, int); /* implemented:EXT_SP_FUNC */
1102extern NCURSES_EXPORT(int) NCURSES_SP_NAME(free_pair) (SCREEN*, int); /* implemented:EXT_SP_FUNC */
Steve Kondikae271bc2015-11-15 02:50:53 +01001103extern NCURSES_EXPORT(int) NCURSES_SP_NAME(get_escdelay) (SCREEN*); /* implemented:EXT_SP_FUNC */
micky3879b9f5e72025-07-08 18:04:53 -04001104extern NCURSES_EXPORT(int) NCURSES_SP_NAME(init_extended_color) (SCREEN*, int, int, int, int); /* implemented:EXT_SP_FUNC */
1105extern NCURSES_EXPORT(int) NCURSES_SP_NAME(init_extended_pair) (SCREEN*, int, int, int); /* implemented:EXT_SP_FUNC */
1106extern NCURSES_EXPORT(int) NCURSES_SP_NAME(is_cbreak) (SCREEN*); /* implemented:EXT_SP_FUNC */
1107extern NCURSES_EXPORT(int) NCURSES_SP_NAME(is_echo) (SCREEN*); /* implemented:EXT_SP_FUNC */
1108extern NCURSES_EXPORT(int) NCURSES_SP_NAME(is_nl) (SCREEN*); /* implemented:EXT_SP_FUNC */
1109extern NCURSES_EXPORT(int) NCURSES_SP_NAME(is_raw) (SCREEN*); /* implemented:EXT_SP_FUNC */
Steve Kondikae271bc2015-11-15 02:50:53 +01001110extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(is_term_resized) (SCREEN*, int, int); /* implemented:EXT_SP_FUNC */
1111extern NCURSES_EXPORT(int) NCURSES_SP_NAME(key_defined) (SCREEN*, const char *); /* implemented:EXT_SP_FUNC */
micky3879b9f5e72025-07-08 18:04:53 -04001112extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(keybound) (SCREEN*, int, int); /* implemented:EXT_SP_FUNC */
Steve Kondikae271bc2015-11-15 02:50:53 +01001113extern NCURSES_EXPORT(int) NCURSES_SP_NAME(keyok) (SCREEN*, int, bool); /* implemented:EXT_SP_FUNC */
1114extern NCURSES_EXPORT(void) NCURSES_SP_NAME(nofilter) (SCREEN*); /* implemented */ /* implemented:EXT_SP_FUNC */
micky3879b9f5e72025-07-08 18:04:53 -04001115extern NCURSES_EXPORT(void) NCURSES_SP_NAME(reset_color_pairs) (SCREEN*); /* implemented:EXT_SP_FUNC */
Steve Kondikae271bc2015-11-15 02:50:53 +01001116extern NCURSES_EXPORT(int) NCURSES_SP_NAME(resize_term) (SCREEN*, int, int); /* implemented:EXT_SP_FUNC */
1117extern NCURSES_EXPORT(int) NCURSES_SP_NAME(resizeterm) (SCREEN*, int, int); /* implemented:EXT_SP_FUNC */
1118extern NCURSES_EXPORT(int) NCURSES_SP_NAME(set_escdelay) (SCREEN*, int); /* implemented:EXT_SP_FUNC */
1119extern NCURSES_EXPORT(int) NCURSES_SP_NAME(set_tabsize) (SCREEN*, int); /* implemented:EXT_SP_FUNC */
1120extern NCURSES_EXPORT(int) NCURSES_SP_NAME(use_default_colors) (SCREEN*); /* implemented:EXT_SP_FUNC */
1121extern NCURSES_EXPORT(int) NCURSES_SP_NAME(use_legacy_coding) (SCREEN*, int); /* implemented:EXT_SP_FUNC */
1122#endif
1123#else
1124#undef NCURSES_SP_FUNCS
1125#define NCURSES_SP_FUNCS 0
1126#define NCURSES_SP_NAME(name) name
1127#define NCURSES_SP_OUTC NCURSES_OUTC
1128#endif
1129
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301130/* attributes */
1131
1132#define NCURSES_ATTR_SHIFT 8
Steve Kondikae271bc2015-11-15 02:50:53 +01001133#define NCURSES_BITS(mask,shift) (NCURSES_CAST(chtype,(mask)) << ((shift) + NCURSES_ATTR_SHIFT))
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301134
1135#define A_NORMAL (@cf_cv_1UL@ - @cf_cv_1UL@)
1136#define A_ATTRIBUTES NCURSES_BITS(~(@cf_cv_1UL@ - @cf_cv_1UL@),0)
1137#define A_CHARTEXT (NCURSES_BITS(@cf_cv_1UL@,0) - @cf_cv_1UL@)
1138#define A_COLOR NCURSES_BITS(((@cf_cv_1UL@) << 8) - @cf_cv_1UL@,0)
1139#define A_STANDOUT NCURSES_BITS(@cf_cv_1UL@,8)
1140#define A_UNDERLINE NCURSES_BITS(@cf_cv_1UL@,9)
1141#define A_REVERSE NCURSES_BITS(@cf_cv_1UL@,10)
1142#define A_BLINK NCURSES_BITS(@cf_cv_1UL@,11)
1143#define A_DIM NCURSES_BITS(@cf_cv_1UL@,12)
1144#define A_BOLD NCURSES_BITS(@cf_cv_1UL@,13)
1145#define A_ALTCHARSET NCURSES_BITS(@cf_cv_1UL@,14)
1146#define A_INVIS NCURSES_BITS(@cf_cv_1UL@,15)
1147#define A_PROTECT NCURSES_BITS(@cf_cv_1UL@,16)
1148#define A_HORIZONTAL NCURSES_BITS(@cf_cv_1UL@,17)
1149#define A_LEFT NCURSES_BITS(@cf_cv_1UL@,18)
1150#define A_LOW NCURSES_BITS(@cf_cv_1UL@,19)
1151#define A_RIGHT NCURSES_BITS(@cf_cv_1UL@,20)
1152#define A_TOP NCURSES_BITS(@cf_cv_1UL@,21)
1153#define A_VERTICAL NCURSES_BITS(@cf_cv_1UL@,22)
1154
Steve Kondikae271bc2015-11-15 02:50:53 +01001155#if @NCURSES_EXT_FUNCS@
1156#define A_ITALIC NCURSES_BITS(@cf_cv_1UL@,23) /* ncurses extension */
1157#endif
1158
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301159/*
1160 * Most of the pseudo functions are macros that either provide compatibility
1161 * with older versions of curses, or provide inline functionality to improve
1162 * performance.
1163 */
1164
1165/*
1166 * These pseudo functions are always implemented as macros:
1167 */
1168
micky3879b9f5e72025-07-08 18:04:53 -04001169#define getyx(win,y,x) (y = getcury(win), x = getcurx(win))
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301170#define getbegyx(win,y,x) (y = getbegy(win), x = getbegx(win))
1171#define getmaxyx(win,y,x) (y = getmaxy(win), x = getmaxx(win))
1172#define getparyx(win,y,x) (y = getpary(win), x = getparx(win))
1173
1174#define getsyx(y,x) do { if (newscr) { \
1175 if (is_leaveok(newscr)) \
1176 (y) = (x) = -1; \
1177 else \
1178 getyx(newscr,(y), (x)); \
1179 } \
1180 } while(0)
1181
1182#define setsyx(y,x) do { if (newscr) { \
1183 if ((y) == -1 && (x) == -1) \
1184 leaveok(newscr, TRUE); \
1185 else { \
1186 leaveok(newscr, FALSE); \
1187 wmove(newscr, (y), (x)); \
1188 } \
1189 } \
1190 } while(0)
1191
1192#ifndef NCURSES_NOMACROS
1193
1194/*
1195 * These miscellaneous pseudo functions are provided for compatibility:
1196 */
1197
1198#define wgetstr(w, s) wgetnstr(w, s, -1)
Steve Kondikae271bc2015-11-15 02:50:53 +01001199#define getnstr(s, n) wgetnstr(stdscr, s, (n))
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301200
1201#define setterm(term) setupterm(term, 1, (int *)0)
1202
1203#define fixterm() reset_prog_mode()
1204#define resetterm() reset_shell_mode()
1205#define saveterm() def_prog_mode()
1206#define crmode() cbreak()
1207#define nocrmode() nocbreak()
1208#define gettmode()
1209
1210/* It seems older SYSV curses versions define these */
1211#if !NCURSES_OPAQUE
micky3879b9f5e72025-07-08 18:04:53 -04001212#define getattrs(win) NCURSES_CAST(int, NCURSES_OK_ADDR(win) ? (win)->_attrs : A_NORMAL)
1213#define getcurx(win) (NCURSES_OK_ADDR(win) ? (win)->_curx : ERR)
1214#define getcury(win) (NCURSES_OK_ADDR(win) ? (win)->_cury : ERR)
1215#define getbegx(win) (NCURSES_OK_ADDR(win) ? (win)->_begx : ERR)
1216#define getbegy(win) (NCURSES_OK_ADDR(win) ? (win)->_begy : ERR)
1217#define getmaxx(win) (NCURSES_OK_ADDR(win) ? ((win)->_maxx + 1) : ERR)
1218#define getmaxy(win) (NCURSES_OK_ADDR(win) ? ((win)->_maxy + 1) : ERR)
1219#define getparx(win) (NCURSES_OK_ADDR(win) ? (win)->_parx : ERR)
1220#define getpary(win) (NCURSES_OK_ADDR(win) ? (win)->_pary : ERR)
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301221#endif /* NCURSES_OPAQUE */
1222
micky3879b9f5e72025-07-08 18:04:53 -04001223#define wstandout(win) (wattrset(win,A_STANDOUT))
1224#define wstandend(win) (wattrset(win,A_NORMAL))
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301225
1226#define wattron(win,at) wattr_on(win, NCURSES_CAST(attr_t, at), NULL)
1227#define wattroff(win,at) wattr_off(win, NCURSES_CAST(attr_t, at), NULL)
1228
1229#if !NCURSES_OPAQUE
micky3879b9f5e72025-07-08 18:04:53 -04001230#if NCURSES_WATTR_MACROS
Steve Kondikae271bc2015-11-15 02:50:53 +01001231#if NCURSES_WIDECHAR && @NCURSES_EXT_COLORS@
micky3879b9f5e72025-07-08 18:04:53 -04001232#define wattrset(win,at) \
1233 (NCURSES_OK_ADDR(win) \
1234 ? ((win)->_color = NCURSES_CAST(int, PAIR_NUMBER(at)), \
1235 (win)->_attrs = NCURSES_CAST(attr_t, at), \
1236 OK) \
1237 : ERR)
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301238#else
micky3879b9f5e72025-07-08 18:04:53 -04001239#define wattrset(win,at) \
1240 (NCURSES_OK_ADDR(win) \
1241 ? ((win)->_attrs = NCURSES_CAST(attr_t, at), \
1242 OK) \
1243 : ERR)
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301244#endif
micky3879b9f5e72025-07-08 18:04:53 -04001245#endif /* NCURSES_WATTR_MACROS */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301246#endif /* NCURSES_OPAQUE */
1247
1248#define scroll(win) wscrl(win,1)
1249
1250#define touchwin(win) wtouchln((win), 0, getmaxy(win), 1)
1251#define touchline(win, s, c) wtouchln((win), s, c, 1)
1252#define untouchwin(win) wtouchln((win), 0, getmaxy(win), 0)
1253
1254#define box(win, v, h) wborder(win, v, v, h, h, 0, 0, 0, 0)
1255#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 +01001256#define hline(ch, n) whline(stdscr, ch, (n))
1257#define vline(ch, n) wvline(stdscr, ch, (n))
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301258
1259#define winstr(w, s) winnstr(w, s, -1)
1260#define winchstr(w, s) winchnstr(w, s, -1)
1261#define winsstr(w, s) winsnstr(w, s, -1)
1262
1263#if !NCURSES_OPAQUE
micky3879b9f5e72025-07-08 18:04:53 -04001264#define redrawwin(win) wredrawln(win, 0, (NCURSES_OK_ADDR(win) ? (win)->_maxy+1 : -1))
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301265#endif /* NCURSES_OPAQUE */
1266
1267#define waddstr(win,str) waddnstr(win,str,-1)
1268#define waddchstr(win,str) waddchnstr(win,str,-1)
1269
1270/*
1271 * These apply to the first 256 color pairs.
1272 */
micky3879b9f5e72025-07-08 18:04:53 -04001273#define COLOR_PAIR(n) (NCURSES_BITS((n), 0) & A_COLOR)
Steve Kondikae271bc2015-11-15 02:50:53 +01001274#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 +05301275
1276/*
1277 * pseudo functions for standard screen
1278 */
1279
Steve Kondikae271bc2015-11-15 02:50:53 +01001280#define addch(ch) waddch(stdscr,(ch))
1281#define addchnstr(str,n) waddchnstr(stdscr,(str),(n))
1282#define addchstr(str) waddchstr(stdscr,(str))
1283#define addnstr(str,n) waddnstr(stdscr,(str),(n))
1284#define addstr(str) waddnstr(stdscr,(str),-1)
Steve Kondikae271bc2015-11-15 02:50:53 +01001285#define attr_get(ap,cp,o) wattr_get(stdscr,(ap),(cp),(o))
1286#define attr_off(a,o) wattr_off(stdscr,(a),(o))
1287#define attr_on(a,o) wattr_on(stdscr,(a),(o))
1288#define attr_set(a,c,o) wattr_set(stdscr,(a),(c),(o))
micky3879b9f5e72025-07-08 18:04:53 -04001289#define attroff(at) wattroff(stdscr,(at))
1290#define attron(at) wattron(stdscr,(at))
1291#define attrset(at) wattrset(stdscr,(at))
Steve Kondikae271bc2015-11-15 02:50:53 +01001292#define bkgd(ch) wbkgd(stdscr,(ch))
1293#define bkgdset(ch) wbkgdset(stdscr,(ch))
1294#define chgat(n,a,c,o) wchgat(stdscr,(n),(a),(c),(o))
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301295#define clear() wclear(stdscr)
1296#define clrtobot() wclrtobot(stdscr)
1297#define clrtoeol() wclrtoeol(stdscr)
Steve Kondikae271bc2015-11-15 02:50:53 +01001298#define color_set(c,o) wcolor_set(stdscr,(c),(o))
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301299#define delch() wdelch(stdscr)
1300#define deleteln() winsdelln(stdscr,-1)
Steve Kondikae271bc2015-11-15 02:50:53 +01001301#define echochar(c) wechochar(stdscr,(c))
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301302#define erase() werase(stdscr)
1303#define getch() wgetch(stdscr)
Steve Kondikae271bc2015-11-15 02:50:53 +01001304#define getstr(str) wgetstr(stdscr,(str))
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301305#define inch() winch(stdscr)
Steve Kondikae271bc2015-11-15 02:50:53 +01001306#define inchnstr(s,n) winchnstr(stdscr,(s),(n))
1307#define inchstr(s) winchstr(stdscr,(s))
1308#define innstr(s,n) winnstr(stdscr,(s),(n))
1309#define insch(c) winsch(stdscr,(c))
1310#define insdelln(n) winsdelln(stdscr,(n))
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301311#define insertln() winsdelln(stdscr,1)
Steve Kondikae271bc2015-11-15 02:50:53 +01001312#define insnstr(s,n) winsnstr(stdscr,(s),(n))
1313#define insstr(s) winsstr(stdscr,(s))
1314#define instr(s) winstr(stdscr,(s))
1315#define move(y,x) wmove(stdscr,(y),(x))
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301316#define refresh() wrefresh(stdscr)
Steve Kondikae271bc2015-11-15 02:50:53 +01001317#define scrl(n) wscrl(stdscr,(n))
1318#define setscrreg(t,b) wsetscrreg(stdscr,(t),(b))
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301319#define standend() wstandend(stdscr)
1320#define standout() wstandout(stdscr)
Steve Kondikae271bc2015-11-15 02:50:53 +01001321#define timeout(delay) wtimeout(stdscr,(delay))
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301322#define wdeleteln(win) winsdelln(win,-1)
1323#define winsertln(win) winsdelln(win,1)
1324
1325/*
1326 * mv functions
1327 */
1328
Steve Kondikae271bc2015-11-15 02:50:53 +01001329#define mvwaddch(win,y,x,ch) (wmove((win),(y),(x)) == ERR ? ERR : waddch((win),(ch)))
1330#define mvwaddchnstr(win,y,x,str,n) (wmove((win),(y),(x)) == ERR ? ERR : waddchnstr((win),(str),(n)))
1331#define mvwaddchstr(win,y,x,str) (wmove((win),(y),(x)) == ERR ? ERR : waddchnstr((win),(str),-1))
1332#define mvwaddnstr(win,y,x,str,n) (wmove((win),(y),(x)) == ERR ? ERR : waddnstr((win),(str),(n)))
1333#define mvwaddstr(win,y,x,str) (wmove((win),(y),(x)) == ERR ? ERR : waddnstr((win),(str),-1))
Steve Kondikae271bc2015-11-15 02:50:53 +01001334#define mvwchgat(win,y,x,n,a,c,o) (wmove((win),(y),(x)) == ERR ? ERR : wchgat((win),(n),(a),(c),(o)))
micky3879b9f5e72025-07-08 18:04:53 -04001335#define mvwdelch(win,y,x) (wmove((win),(y),(x)) == ERR ? ERR : wdelch(win))
Steve Kondikae271bc2015-11-15 02:50:53 +01001336#define mvwgetch(win,y,x) (wmove((win),(y),(x)) == ERR ? ERR : wgetch(win))
1337#define mvwgetnstr(win,y,x,str,n) (wmove((win),(y),(x)) == ERR ? ERR : wgetnstr((win),(str),(n)))
1338#define mvwgetstr(win,y,x,str) (wmove((win),(y),(x)) == ERR ? ERR : wgetstr((win),(str)))
1339#define mvwhline(win,y,x,c,n) (wmove((win),(y),(x)) == ERR ? ERR : whline((win),(c),(n)))
1340#define mvwinch(win,y,x) (wmove((win),(y),(x)) == ERR ? NCURSES_CAST(chtype, ERR) : winch(win))
1341#define mvwinchnstr(win,y,x,s,n) (wmove((win),(y),(x)) == ERR ? ERR : winchnstr((win),(s),(n)))
1342#define mvwinchstr(win,y,x,s) (wmove((win),(y),(x)) == ERR ? ERR : winchstr((win),(s)))
1343#define mvwinnstr(win,y,x,s,n) (wmove((win),(y),(x)) == ERR ? ERR : winnstr((win),(s),(n)))
1344#define mvwinsch(win,y,x,c) (wmove((win),(y),(x)) == ERR ? ERR : winsch((win),(c)))
1345#define mvwinsnstr(win,y,x,s,n) (wmove((win),(y),(x)) == ERR ? ERR : winsnstr((win),(s),(n)))
1346#define mvwinsstr(win,y,x,s) (wmove((win),(y),(x)) == ERR ? ERR : winsstr((win),(s)))
1347#define mvwinstr(win,y,x,s) (wmove((win),(y),(x)) == ERR ? ERR : winstr((win),(s)))
1348#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 +05301349
Steve Kondikae271bc2015-11-15 02:50:53 +01001350#define mvaddch(y,x,ch) mvwaddch(stdscr,(y),(x),(ch))
1351#define mvaddchnstr(y,x,str,n) mvwaddchnstr(stdscr,(y),(x),(str),(n))
1352#define mvaddchstr(y,x,str) mvwaddchstr(stdscr,(y),(x),(str))
1353#define mvaddnstr(y,x,str,n) mvwaddnstr(stdscr,(y),(x),(str),(n))
1354#define mvaddstr(y,x,str) mvwaddstr(stdscr,(y),(x),(str))
1355#define mvchgat(y,x,n,a,c,o) mvwchgat(stdscr,(y),(x),(n),(a),(c),(o))
1356#define mvdelch(y,x) mvwdelch(stdscr,(y),(x))
1357#define mvgetch(y,x) mvwgetch(stdscr,(y),(x))
1358#define mvgetnstr(y,x,str,n) mvwgetnstr(stdscr,(y),(x),(str),(n))
1359#define mvgetstr(y,x,str) mvwgetstr(stdscr,(y),(x),(str))
1360#define mvhline(y,x,c,n) mvwhline(stdscr,(y),(x),(c),(n))
1361#define mvinch(y,x) mvwinch(stdscr,(y),(x))
1362#define mvinchnstr(y,x,s,n) mvwinchnstr(stdscr,(y),(x),(s),(n))
1363#define mvinchstr(y,x,s) mvwinchstr(stdscr,(y),(x),(s))
1364#define mvinnstr(y,x,s,n) mvwinnstr(stdscr,(y),(x),(s),(n))
1365#define mvinsch(y,x,c) mvwinsch(stdscr,(y),(x),(c))
1366#define mvinsnstr(y,x,s,n) mvwinsnstr(stdscr,(y),(x),(s),(n))
1367#define mvinsstr(y,x,s) mvwinsstr(stdscr,(y),(x),(s))
1368#define mvinstr(y,x,s) mvwinstr(stdscr,(y),(x),(s))
1369#define mvvline(y,x,c,n) mvwvline(stdscr,(y),(x),(c),(n))
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301370
1371/*
1372 * Some wide-character functions can be implemented without the extensions.
1373 */
1374#if !NCURSES_OPAQUE
micky3879b9f5e72025-07-08 18:04:53 -04001375#define getbkgd(win) (NCURSES_OK_ADDR(win) ? ((win)->_bkgd) : 0)
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301376#endif /* NCURSES_OPAQUE */
1377
1378#define slk_attr_off(a,v) ((v) ? ERR : slk_attroff(a))
1379#define slk_attr_on(a,v) ((v) ? ERR : slk_attron(a))
1380
1381#if !NCURSES_OPAQUE
micky3879b9f5e72025-07-08 18:04:53 -04001382#if NCURSES_WATTR_MACROS
Steve Kondikae271bc2015-11-15 02:50:53 +01001383#if NCURSES_WIDECHAR && @NCURSES_EXT_COLORS@
micky3879b9f5e72025-07-08 18:04:53 -04001384#define wattr_set(win,a,p,opts) \
1385 (NCURSES_OK_ADDR(win) \
1386 ? ((void)((win)->_attrs = ((a) & ~A_COLOR), \
1387 (win)->_color = (opts) ? *(int *)(opts) : (p)), \
1388 OK) \
1389 : ERR)
1390#define wattr_get(win,a,p,opts) \
1391 (NCURSES_OK_ADDR(win) \
1392 ? ((void)(NCURSES_OK_ADDR(a) \
1393 ? (*(a) = (win)->_attrs) \
1394 : OK), \
1395 (void)(NCURSES_OK_ADDR(p) \
1396 ? (*(p) = (NCURSES_PAIRS_T) (win)->_color) \
1397 : OK), \
1398 (void)(NCURSES_OK_ADDR(opts) \
1399 ? (*(int *)(opts) = (win)->_color) \
1400 : OK), \
1401 OK) \
1402 : ERR)
1403#else /* !(NCURSES_WIDECHAR && NCURSES_EXE_COLORS) */
1404#define wattr_set(win,a,p,opts) \
1405 (NCURSES_OK_ADDR(win) \
1406 ? ((void)((win)->_attrs = (((a) & ~A_COLOR) | \
1407 (attr_t)COLOR_PAIR(p))), \
1408 OK) \
1409 : ERR)
1410#define wattr_get(win,a,p,opts) \
1411 (NCURSES_OK_ADDR(win) \
1412 ? ((void)(NCURSES_OK_ADDR(a) \
1413 ? (*(a) = (win)->_attrs) \
1414 : OK), \
1415 (void)(NCURSES_OK_ADDR(p) \
1416 ? (*(p) = (NCURSES_PAIRS_T) PAIR_NUMBER((win)->_attrs)) \
1417 : OK), \
1418 OK) \
1419 : ERR)
1420#endif /* (NCURSES_WIDECHAR && NCURSES_EXE_COLORS) */
1421#endif /* NCURSES_WATTR_MACROS */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301422#endif /* NCURSES_OPAQUE */
1423
1424/*
1425 * X/Open curses deprecates SVr4 vwprintw/vwscanw, which are supposed to use
1426 * varargs.h. It adds new calls vw_printw/vw_scanw, which are supposed to
1427 * use POSIX stdarg.h. The ncurses versions of vwprintw/vwscanw already
1428 * use stdarg.h, so...
1429 */
micky3879b9f5e72025-07-08 18:04:53 -04001430/* define vw_printw vwprintw */
1431/* define vw_scanw vwscanw */
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301432
1433/*
1434 * Export fallback function for use in C++ binding.
1435 */
1436#if !@HAVE_VSSCANF@
1437#define vsscanf(a,b,c) _nc_vsscanf(a,b,c)
1438NCURSES_EXPORT(int) vsscanf(const char *, const char *, va_list);
1439#endif
1440
1441/*
1442 * These macros are extensions - not in X/Open Curses.
1443 */
1444#if @NCURSES_EXT_FUNCS@
1445#if !NCURSES_OPAQUE
micky3879b9f5e72025-07-08 18:04:53 -04001446#define is_cleared(win) (NCURSES_OK_ADDR(win) ? (win)->_clear : FALSE)
1447#define is_idcok(win) (NCURSES_OK_ADDR(win) ? (win)->_idcok : FALSE)
1448#define is_idlok(win) (NCURSES_OK_ADDR(win) ? (win)->_idlok : FALSE)
1449#define is_immedok(win) (NCURSES_OK_ADDR(win) ? (win)->_immed : FALSE)
1450#define is_keypad(win) (NCURSES_OK_ADDR(win) ? (win)->_use_keypad : FALSE)
1451#define is_leaveok(win) (NCURSES_OK_ADDR(win) ? (win)->_leaveok : FALSE)
1452#define is_nodelay(win) (NCURSES_OK_ADDR(win) ? ((win)->_delay == 0) : FALSE)
1453#define is_notimeout(win) (NCURSES_OK_ADDR(win) ? (win)->_notimeout : FALSE)
1454#define is_pad(win) (NCURSES_OK_ADDR(win) ? ((win)->_flags & _ISPAD) != 0 : FALSE)
1455#define is_scrollok(win) (NCURSES_OK_ADDR(win) ? (win)->_scroll : FALSE)
1456#define is_subwin(win) (NCURSES_OK_ADDR(win) ? ((win)->_flags & _SUBWIN) != 0 : FALSE)
1457#define is_syncok(win) (NCURSES_OK_ADDR(win) ? (win)->_sync : FALSE)
1458#define wgetdelay(win) (NCURSES_OK_ADDR(win) ? (win)->_delay : 0)
1459#define wgetparent(win) (NCURSES_OK_ADDR(win) ? (win)->_parent : 0)
1460#define wgetscrreg(win,t,b) (NCURSES_OK_ADDR(win) ? (*(t) = (win)->_regtop, *(b) = (win)->_regbottom, OK) : ERR)
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301461#endif
1462#endif
1463
micky3879b9f5e72025-07-08 18:04:53 -04001464/*
1465 * X/Open says this returns a bool; SVr4 also checked for out-of-range line.
1466 * The macro provides compatibility:
1467 */
1468#define is_linetouched(w,l) ((!(w) || ((l) > getmaxy(w)) || ((l) < 0)) ? ERR : (is_linetouched)((w),(l)))
1469
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301470#endif /* NCURSES_NOMACROS */
1471
1472/*
1473 * Public variables.
1474 *
1475 * Notes:
1476 * a. ESCDELAY was an undocumented feature under AIX curses.
1477 * It gives the ESC expire time in milliseconds.
1478 * b. ttytype is needed for backward compatibility
1479 */
Steve Kondikae271bc2015-11-15 02:50:53 +01001480#if NCURSES_REENTRANT
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301481
1482NCURSES_WRAPPED_VAR(WINDOW *, curscr);
1483NCURSES_WRAPPED_VAR(WINDOW *, newscr);
1484NCURSES_WRAPPED_VAR(WINDOW *, stdscr);
1485NCURSES_WRAPPED_VAR(char *, ttytype);
1486NCURSES_WRAPPED_VAR(int, COLORS);
1487NCURSES_WRAPPED_VAR(int, COLOR_PAIRS);
1488NCURSES_WRAPPED_VAR(int, COLS);
1489NCURSES_WRAPPED_VAR(int, ESCDELAY);
1490NCURSES_WRAPPED_VAR(int, LINES);
1491NCURSES_WRAPPED_VAR(int, TABSIZE);
1492
1493#define curscr NCURSES_PUBLIC_VAR(curscr())
1494#define newscr NCURSES_PUBLIC_VAR(newscr())
1495#define stdscr NCURSES_PUBLIC_VAR(stdscr())
1496#define ttytype NCURSES_PUBLIC_VAR(ttytype())
1497#define COLORS NCURSES_PUBLIC_VAR(COLORS())
1498#define COLOR_PAIRS NCURSES_PUBLIC_VAR(COLOR_PAIRS())
1499#define COLS NCURSES_PUBLIC_VAR(COLS())
1500#define ESCDELAY NCURSES_PUBLIC_VAR(ESCDELAY())
1501#define LINES NCURSES_PUBLIC_VAR(LINES())
1502#define TABSIZE NCURSES_PUBLIC_VAR(TABSIZE())
1503
1504#else
1505
1506extern NCURSES_EXPORT_VAR(WINDOW *) curscr;
1507extern NCURSES_EXPORT_VAR(WINDOW *) newscr;
1508extern NCURSES_EXPORT_VAR(WINDOW *) stdscr;
1509extern NCURSES_EXPORT_VAR(char) ttytype[];
1510extern NCURSES_EXPORT_VAR(int) COLORS;
1511extern NCURSES_EXPORT_VAR(int) COLOR_PAIRS;
1512extern NCURSES_EXPORT_VAR(int) COLS;
1513extern NCURSES_EXPORT_VAR(int) ESCDELAY;
1514extern NCURSES_EXPORT_VAR(int) LINES;
1515extern NCURSES_EXPORT_VAR(int) TABSIZE;
1516
1517#endif
1518
1519/*
1520 * Pseudo-character tokens outside ASCII range. The curses wgetch() function
1521 * will return any given one of these only if the corresponding k- capability
1522 * is defined in your terminal's terminfo entry.
1523 *
1524 * Some keys (KEY_A1, etc) are arranged like this:
1525 * a1 up a3
1526 * left b2 right
1527 * c1 down c3
1528 *
1529 * A few key codes do not depend upon the terminfo entry.
1530 */
1531#define KEY_CODE_YES 0400 /* A wchar_t contains a key code */
1532#define KEY_MIN 0401 /* Minimum curses key */
1533#define KEY_BREAK 0401 /* Break key (unreliable) */
1534#define KEY_SRESET 0530 /* Soft (partial) reset (unreliable) */
1535#define KEY_RESET 0531 /* Reset or hard reset (unreliable) */