vm: fix a null dereference on out-of-memory
[minix.git] / lib / libcurses / curses.h
blobb7b607c0d1bc1e62a35a25f0f230bd2b2e1dea7a
1 /* $NetBSD: curses.h,v 1.101 2010/12/16 17:42:28 wiz Exp $ */
3 /*
4 * Copyright (c) 1981, 1993, 1994
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
31 * @(#)curses.h 8.5 (Berkeley) 4/29/95
33 * Modified by Ruibiao Qiu <ruibiao@arl.wustl.edu,ruibiao@gmail.com> 2005
34 * to add wide-character support
35 * - Add complex character structure (cchar_t)
36 * - Add definitions of wide-character routines
37 * - Add KEY_CODE_YES
40 #ifndef _CURSES_H_
41 #define _CURSES_H_
43 #include <sys/types.h>
44 #include <sys/cdefs.h>
45 #include <wchar.h>
47 #include <stdio.h>
48 #include <stdbool.h>
51 * attr_t must be the same size as wchar_t (see <wchar.h>) to avoid padding
52 * in __LDATA.
54 typedef wchar_t chtype;
55 typedef wchar_t attr_t;
57 #if !defined(HAVE_WCHAR) && !defined(DISABLE_WCHAR)
58 #define HAVE_WCHAR 1
59 #endif
61 #ifdef HAVE_WCHAR
62 /*
63 * The complex character structure required by the X/Open reference and used
64 * in * functions such as in_wchstr(). It includes a string of up to 8 wide
65 * characters and its length, an attribute, and a color-pair.
67 #define CURSES_CCHAR_MAX 8
68 #define CCHARW_MAX 5
69 typedef struct {
70 attr_t attributes; /* character attributes */
71 unsigned elements; /* number of wide char in
72 vals[] */
73 wchar_t vals[CURSES_CCHAR_MAX]; /* wide chars including
74 non-spacing */
75 } cchar_t;
76 #else
77 typedef chtype cchar_t;
78 #endif /* HAVE_WCHAR */
80 #ifndef TRUE
81 #define TRUE (/*CONSTCOND*/1)
82 #endif
83 #ifndef FALSE
84 #define FALSE (/*CONSTCOND*/0)
85 #endif
87 #ifndef _CURSES_PRIVATE
89 #define _puts(s) tputs(s, 0, __cputchar)
90 #define _putchar(c) __cputchar(c)
92 /* Old-style terminal modes access. */
93 #define crmode() cbreak()
94 #define nocrmode() nocbreak()
95 #endif /* _CURSES_PRIVATE */
98 /* symbols for values returned by getch in keypad mode */
99 #define KEY_MIN 0x101 /* minimum extended key value */
100 #define KEY_BREAK 0x101 /* break key */
101 #define KEY_DOWN 0x102 /* down arrow */
102 #define KEY_UP 0x103 /* up arrow */
103 #define KEY_LEFT 0x104 /* left arrow */
104 #define KEY_RIGHT 0x105 /* right arrow*/
105 #define KEY_HOME 0x106 /* home key */
106 #define KEY_BACKSPACE 0x107 /* Backspace */
108 /* First function key (block of 64 follow) */
109 #define KEY_F0 0x108
110 /* Function defining other function key values*/
111 #define KEY_F(n) (KEY_F0+(n))
113 #define KEY_DL 0x148 /* Delete Line */
114 #define KEY_IL 0x149 /* Insert Line*/
115 #define KEY_DC 0x14A /* Delete Character */
116 #define KEY_IC 0x14B /* Insert Character */
117 #define KEY_EIC 0x14C /* Exit Insert Char mode */
118 #define KEY_CLEAR 0x14D /* Clear screen */
119 #define KEY_EOS 0x14E /* Clear to end of screen */
120 #define KEY_EOL 0x14F /* Clear to end of line */
121 #define KEY_SF 0x150 /* Scroll one line forward */
122 #define KEY_SR 0x151 /* Scroll one line back */
123 #define KEY_NPAGE 0x152 /* Next Page */
124 #define KEY_PPAGE 0x153 /* Prev Page */
125 #define KEY_STAB 0x154 /* Set Tab */
126 #define KEY_CTAB 0x155 /* Clear Tab */
127 #define KEY_CATAB 0x156 /* Clear All Tabs */
128 #define KEY_ENTER 0x157 /* Enter or Send */
129 #define KEY_SRESET 0x158 /* Soft Reset */
130 #define KEY_RESET 0x159 /* Hard Reset */
131 #define KEY_PRINT 0x15A /* Print */
132 #define KEY_LL 0x15B /* Home Down */
135 * "Keypad" keys arranged like this:
137 * A1 up A3
138 * left B2 right
139 * C1 down C3
142 #define KEY_A1 0x15C /* Keypad upper left */
143 #define KEY_A3 0x15D /* Keypad upper right */
144 #define KEY_B2 0x15E /* Keypad centre key */
145 #define KEY_C1 0x15F /* Keypad lower left */
146 #define KEY_C3 0x160 /* Keypad lower right */
148 #define KEY_BTAB 0x161 /* Back Tab */
149 #define KEY_BEG 0x162 /* Begin key */
150 #define KEY_CANCEL 0x163 /* Cancel key */
151 #define KEY_CLOSE 0x164 /* Close Key */
152 #define KEY_COMMAND 0x165 /* Command Key */
153 #define KEY_COPY 0x166 /* Copy key */
154 #define KEY_CREATE 0x167 /* Create key */
155 #define KEY_END 0x168 /* End key */
156 #define KEY_EXIT 0x169 /* Exit key */
157 #define KEY_FIND 0x16A /* Find key */
158 #define KEY_HELP 0x16B /* Help key */
159 #define KEY_MARK 0x16C /* Mark key */
160 #define KEY_MESSAGE 0x16D /* Message key */
161 #define KEY_MOVE 0x16E /* Move key */
162 #define KEY_NEXT 0x16F /* Next Object key */
163 #define KEY_OPEN 0x170 /* Open key */
164 #define KEY_OPTIONS 0x171 /* Options key */
165 #define KEY_PREVIOUS 0x172 /* Previous Object key */
166 #define KEY_REDO 0x173 /* Redo key */
167 #define KEY_REFERENCE 0x174 /* Ref Key */
168 #define KEY_REFRESH 0x175 /* Refresh key */
169 #define KEY_REPLACE 0x176 /* Replace key */
170 #define KEY_RESTART 0x177 /* Restart key */
171 #define KEY_RESUME 0x178 /* Resume key */
172 #define KEY_SAVE 0x179 /* Save key */
173 #define KEY_SBEG 0x17A /* Shift begin key */
174 #define KEY_SCANCEL 0x17B /* Shift Cancel key */
175 #define KEY_SCOMMAND 0x17C /* Shift Command key */
176 #define KEY_SCOPY 0x17D /* Shift Copy key */
177 #define KEY_SCREATE 0x17E /* Shift Create key */
178 #define KEY_SDC 0x17F /* Shift Delete Character */
179 #define KEY_SDL 0x180 /* Shift Delete Line */
180 #define KEY_SELECT 0x181 /* Select key */
181 #define KEY_SEND 0x182 /* Send key */
182 #define KEY_SEOL 0x183 /* Shift Clear Line key */
183 #define KEY_SEXIT 0x184 /* Shift Exit key */
184 #define KEY_SFIND 0x185 /* Shift Find key */
185 #define KEY_SHELP 0x186 /* Shift Help key */
186 #define KEY_SHOME 0x187 /* Shift Home key */
187 #define KEY_SIC 0x188 /* Shift Input key */
188 #define KEY_SLEFT 0x189 /* Shift Left Arrow key */
189 #define KEY_SMESSAGE 0x18A /* Shift Message key */
190 #define KEY_SMOVE 0x18B /* Shift Move key */
191 #define KEY_SNEXT 0x18C /* Shift Next key */
192 #define KEY_SOPTIONS 0x18D /* Shift Options key */
193 #define KEY_SPREVIOUS 0x18E /* Shift Previous key */
194 #define KEY_SPRINT 0x18F /* Shift Print key */
195 #define KEY_SREDO 0x190 /* Shift Redo key */
196 #define KEY_SREPLACE 0x191 /* Shift Replace key */
197 #define KEY_SRIGHT 0x192 /* Shift Right Arrow key */
198 #define KEY_SRSUME 0x193 /* Shift Resume key */
199 #define KEY_SSAVE 0x194 /* Shift Save key */
200 #define KEY_SSUSPEND 0x195 /* Shift Suspend key */
201 #define KEY_SUNDO 0x196 /* Shift Undo key */
202 #define KEY_SUSPEND 0x197 /* Suspend key */
203 #define KEY_UNDO 0x198 /* Undo key */
204 #define KEY_MOUSE 0x199 /* Mouse event has occurred */
205 #define KEY_RESIZE 0x200 /* Resize event has occurred */
206 #define KEY_MAX 0x240 /* maximum extended key value */
207 #define KEY_CODE_YES 0x241 /* A function key pressed */
209 #include <unctrl.h>
212 * A window an array of __LINE structures pointed to by the 'lines' pointer.
213 * A line is an array of __LDATA structures pointed to by the 'line' pointer.
217 * Definitions for characters and attributes in __LDATA
219 #define __CHARTEXT 0x000000ff /* bits for 8-bit characters */
220 #define __NORMAL 0x00000000 /* Added characters are normal. */
221 #define __STANDOUT 0x00000100 /* Added characters are standout. */
222 #define __UNDERSCORE 0x00000200 /* Added characters are underscored. */
223 #define __REVERSE 0x00000400 /* Added characters are reverse
224 video. */
225 #define __BLINK 0x00000800 /* Added characters are blinking. */
226 #define __DIM 0x00001000 /* Added characters are dim. */
227 #define __BOLD 0x00002000 /* Added characters are bold. */
228 #define __BLANK 0x00004000 /* Added characters are blanked. */
229 #define __PROTECT 0x00008000 /* Added characters are protected. */
230 #define __ALTCHARSET 0x00010000 /* Added characters are ACS */
231 #define __COLOR 0x03fe0000 /* Color bits */
232 #define __ATTRIBUTES 0x03ffff00 /* All 8-bit attribute bits */
233 #ifdef HAVE_WCHAR
234 #define __ACS_IS_WACS 0x04000000 /* internal: use wacs table for ACS char */
235 #endif
237 typedef struct __ldata __LDATA;
238 typedef struct __line __LINE;
239 typedef struct __window WINDOW;
240 typedef struct __screen SCREEN;
243 * Attribute definitions
245 #define A_NORMAL __NORMAL
246 #define A_STANDOUT __STANDOUT
247 #define A_UNDERLINE __UNDERSCORE
248 #define A_REVERSE __REVERSE
249 #define A_BLINK __BLINK
250 #define A_DIM __DIM
251 #define A_BOLD __BOLD
252 #define A_BLANK __BLANK
253 #define A_INVIS __BLANK
254 #define A_PROTECT __PROTECT
255 #define A_ALTCHARSET __ALTCHARSET
256 #define A_ATTRIBUTES __ATTRIBUTES
257 #define A_CHARTEXT __CHARTEXT
258 #define A_COLOR __COLOR
260 #ifdef HAVE_WCHAR
261 #define WA_ATTRIBUTES 0x03ffffff /* Wide character attributes mask */
262 #define WA_STANDOUT __STANDOUT /* Best highlighting mode */
263 #define WA_UNDERLINE __UNDERSCORE /* Underlining */
264 #define WA_REVERSE __REVERSE /* Reverse video */
265 #define WA_BLINK __BLINK /* Blinking */
266 #define WA_DIM __DIM /* Half bright */
267 #define WA_BOLD __BOLD /* Extra bright or bold */
268 #define WA_INVIS __BLANK /* Invisible */
269 #define WA_PROTECT __PROTECT /* Protected */
270 #define WA_ALTCHARSET __ALTCHARSET /* Alternate character set */
271 #define WA_LOW 0x00000002 /* Low highlight */
272 #define WA_TOP 0x00000004 /* Top highlight */
273 #define WA_HORIZONTAL 0x00000008 /* Horizontal highlight */
274 #define WA_VERTICAL 0x00000010 /* Vertical highlight */
275 #define WA_LEFT 0x00000020 /* Left highlight */
276 #define WA_RIGHT 0x00000040 /* Right highlight */
277 #endif /* HAVE_WCHAR */
280 * Alternate character set definitions
283 #define NUM_ACS 128
285 extern chtype _acs_char[NUM_ACS];
286 #ifdef __cplusplus
287 #define __UC_CAST(a) static_cast<unsigned char>(a)
288 #else
289 #define __UC_CAST(a) (unsigned char)(a)
290 #endif
292 /* Standard definitions */
293 #define ACS_RARROW _acs_char[__UC_CAST('+')]
294 #define ACS_LARROW _acs_char[__UC_CAST(',')]
295 #define ACS_UARROW _acs_char[__UC_CAST('-')]
296 #define ACS_DARROW _acs_char[__UC_CAST('.')]
297 #define ACS_BLOCK _acs_char[__UC_CAST('0')]
298 #define ACS_DIAMOND _acs_char[__UC_CAST('`')]
299 #define ACS_CKBOARD _acs_char[__UC_CAST('a')]
300 #define ACS_DEGREE _acs_char[__UC_CAST('f')]
301 #define ACS_PLMINUS _acs_char[__UC_CAST('g')]
302 #define ACS_BOARD _acs_char[__UC_CAST('h')]
303 #define ACS_LANTERN _acs_char[__UC_CAST('i')]
304 #define ACS_LRCORNER _acs_char[__UC_CAST('j')]
305 #define ACS_URCORNER _acs_char[__UC_CAST('k')]
306 #define ACS_ULCORNER _acs_char[__UC_CAST('l')]
307 #define ACS_LLCORNER _acs_char[__UC_CAST('m')]
308 #define ACS_PLUS _acs_char[__UC_CAST('n')]
309 #define ACS_HLINE _acs_char[__UC_CAST('q')]
310 #define ACS_S1 _acs_char[__UC_CAST('o')]
311 #define ACS_S9 _acs_char[__UC_CAST('s')]
312 #define ACS_LTEE _acs_char[__UC_CAST('t')]
313 #define ACS_RTEE _acs_char[__UC_CAST('u')]
314 #define ACS_BTEE _acs_char[__UC_CAST('v')]
315 #define ACS_TTEE _acs_char[__UC_CAST('w')]
316 #define ACS_VLINE _acs_char[__UC_CAST('x')]
317 #define ACS_BULLET _acs_char[__UC_CAST('~')]
319 /* Extensions */
320 #define ACS_S3 _acs_char[__UC_CAST('p')]
321 #define ACS_S7 _acs_char[__UC_CAST('r')]
322 #define ACS_LEQUAL _acs_char[__UC_CAST('y')]
323 #define ACS_GEQUAL _acs_char[__UC_CAST('z')]
324 #define ACS_PI _acs_char[__UC_CAST('{')]
325 #define ACS_NEQUAL _acs_char[__UC_CAST('|')]
326 #define ACS_STERLING _acs_char[__UC_CAST('}')]
328 #ifdef HAVE_WCHAR
329 extern cchar_t _wacs_char[NUM_ACS];
331 #define WACS_RARROW (&_wacs_char[(unsigned char)'+'])
332 #define WACS_LARROW (&_wacs_char[(unsigned char)','])
333 #define WACS_UARROW (&_wacs_char[(unsigned char)'-'])
334 #define WACS_DARROW (&_wacs_char[(unsigned char)'.'])
335 #define WACS_BLOCK (&_wacs_char[(unsigned char)'0'])
336 #define WACS_DIAMOND (&_wacs_char[(unsigned char)'`'])
337 #define WACS_CKBOARD (&_wacs_char[(unsigned char)'a'])
338 #define WACS_DEGREE (&_wacs_char[(unsigned char)'f'])
339 #define WACS_PLMINUS (&_wacs_char[(unsigned char)'g'])
340 #define WACS_BOARD (&_wacs_char[(unsigned char)'h'])
341 #define WACS_LANTERN (&_wacs_char[(unsigned char)'i'])
342 #define WACS_LRCORNER (&_wacs_char[(unsigned char)'j'])
343 #define WACS_URCORNER (&_wacs_char[(unsigned char)'k'])
344 #define WACS_ULCORNER (&_wacs_char[(unsigned char)'l'])
345 #define WACS_LLCORNER (&_wacs_char[(unsigned char)'m'])
346 #define WACS_PLUS (&_wacs_char[(unsigned char)'n'])
347 #define WACS_HLINE (&_wacs_char[(unsigned char)'q'])
348 #define WACS_S1 (&_wacs_char[(unsigned char)'o'])
349 #define WACS_S9 (&_wacs_char[(unsigned char)'s'])
350 #define WACS_LTEE (&_wacs_char[(unsigned char)'t'])
351 #define WACS_RTEE (&_wacs_char[(unsigned char)'u'])
352 #define WACS_BTEE (&_wacs_char[(unsigned char)'v'])
353 #define WACS_TTEE (&_wacs_char[(unsigned char)'w'])
354 #define WACS_VLINE (&_wacs_char[(unsigned char)'x'])
355 #define WACS_BULLET (&_wacs_char[(unsigned char)'~'])
356 #define WACS_S3 (&_wacs_char[(unsigned char)'p'])
357 #define WACS_S7 (&_wacs_char[(unsigned char)'r'])
358 #define WACS_LEQUAL (&_wacs_char[(unsigned char)'y'])
359 #define WACS_GEQUAL (&_wacs_char[(unsigned char)'z'])
360 #define WACS_PI (&_wacs_char[(unsigned char)'{'])
361 #define WACS_NEQUAL (&_wacs_char[(unsigned char)'|'])
362 #define WACS_STERLING (&_wacs_char[(unsigned char)'}'])
363 #endif /* HAVE_WCHAR */
365 /* System V compatibility */
366 #define ACS_SBBS ACS_LRCORNER
367 #define ACS_BBSS ACS_URCORNER
368 #define ACS_BSSB ACS_ULCORNER
369 #define ACS_SSBB ACS_LLCORNER
370 #define ACS_SSSS ACS_PLUS
371 #define ACS_BSBS ACS_HLINE
372 #define ACS_SSSB ACS_LTEE
373 #define ACS_SBSS ACS_RTEE
374 #define ACS_SSBS ACS_BTEE
375 #define ACS_BSSS ACS_TTEE
376 #define ACS_SBSB ACS_VLINE
377 #define _acs_map _acs_char
380 * Color definitions (ANSI color numbers)
383 #define COLOR_BLACK 0x00
384 #define COLOR_RED 0x01
385 #define COLOR_GREEN 0x02
386 #define COLOR_YELLOW 0x03
387 #define COLOR_BLUE 0x04
388 #define COLOR_MAGENTA 0x05
389 #define COLOR_CYAN 0x06
390 #define COLOR_WHITE 0x07
392 #ifdef __cplusplus
393 #define __UINT32_CAST(a) static_cast<u_int32_t>(a)
394 #else
395 #define __UINT32_CAST(a) (u_int32_t)(a)
396 #endif
397 #define COLOR_PAIR(n) (((__UINT32_CAST(n)) << 17) & A_COLOR)
398 #define PAIR_NUMBER(n) (((__UINT32_CAST(n)) & A_COLOR) >> 17)
400 /* Curses external declarations. */
401 extern WINDOW *curscr; /* Current screen. */
402 extern WINDOW *stdscr; /* Standard screen. */
404 extern int __tcaction; /* If terminal hardware set. */
406 extern int COLS; /* Columns on the screen. */
407 extern int LINES; /* Lines on the screen. */
408 extern int COLORS; /* Max colors on the screen. */
409 extern int COLOR_PAIRS; /* Max color pairs on the screen. */
411 extern int ESCDELAY; /* Delay between keys in esc seq's. */
413 #ifndef OK
414 #define ERR (-1) /* Error return. */
415 #define OK (0) /* Success return. */
416 #endif
419 * The following have, traditionally, been macros but X/Open say they
420 * need to be functions. Keep the old macros for debugging.
422 #ifdef _CURSES_USE_MACROS
423 /* Standard screen pseudo functions. */
424 #define addbytes(s, n) __waddbytes(stdscr, s, n, 0)
425 #define addch(ch) waddch(stdscr, ch)
426 #define addchnstr(s) waddchnstr(stdscr, s, n)
427 #define addchstr(s) waddchnstr(stdscr, s, -1)
428 #define addnstr(s, n) waddnstr(stdscr, s, n)
429 #define addstr(s) waddnstr(stdscr, s, -1)
430 #define attr_get(a, p, o) wattr_get(stdscr, a, p, o)
431 #define attr_off(a, o) wattr_off(stdscr, a, o)
432 #define attr_on(a, o) wattr_on(stdscr, a, o)
433 #define attr_set(a, p, o) wattr_set(stdscr, a, p, o)
434 #define attroff(attr) wattroff(stdscr, attr)
435 #define attron(attr) wattron(stdscr, attr)
436 #define attrset(attr) wattrset(stdscr, attr)
437 #define bkgd(ch) wbkgd(stdscr, ch)
438 #define bkgdset(ch) wbkgdset(stdscr, ch)
439 #define border(l, r, t, b, tl, tr, bl, br) \
440 wborder(stdscr, l, r, t, b, tl, tr, bl, br)
441 #define clear() wclear(stdscr)
442 #define clrtobot() wclrtobot(stdscr)
443 #define clrtoeol() wclrtoeol(stdscr)
444 #define color_set(c, o) wcolor_set(stdscr, c, o)
445 #define delch() wdelch(stdscr)
446 #define deleteln() wdeleteln(stdscr)
447 #define echochar(c) wechochar(stdscr, c)
448 #define erase() werase(stdscr)
449 #define getch() wgetch(stdscr)
450 #define getnstr(s, n) wgetnstr(stdscr, s, n)
451 #define getstr(s) wgetstr(stdscr, s)
452 #define inch() winch(stdscr)
453 #define inchnstr(c) winchnstr(stdscr, c)
454 #define inchstr(c) winchstr(stdscr, c)
455 #define innstr(s, n) winnstr(stdscr, s, n)
456 #define insch(ch) winsch(stdscr, ch)
457 #define insdelln(n) winsdelln(stdscr, n)
458 #define insertln() winsertln(stdscr)
459 #define instr(s) winstr(stdscr, s)
460 #define move(y, x) wmove(stdscr, y, x)
461 #define refresh() wrefresh(stdscr)
462 #define scrl(n) wscrl(stdscr, n)
463 #define setscrreg(t, b) wsetscrreg(stdscr, t, b)
464 #define standend() wstandend(stdscr)
465 #define standout() wstandout(stdscr)
466 #define timeout(delay) wtimeout(stdscr, delay)
467 #define underscore() wunderscore(stdscr)
468 #define underend() wunderend(stdscr)
469 #define waddbytes(w, s, n) __waddbytes(w, s, n, 0)
470 #define waddstr(w, s) waddnstr(w, s, -1)
472 /* Standard screen plus movement pseudo functions. */
473 #define mvaddbytes(y, x, s, n) mvwaddbytes(stdscr, y, x, s, n)
474 #define mvaddch(y, x, ch) mvwaddch(stdscr, y, x, ch)
475 #define mvaddchnstr(y, x, s, n) mvwaddchnstr(stdscr, y, x, s, n)
476 #define mvaddchstr(y, x, s) mvwaddchstr(stdscr, y, x, s)
477 #define mvaddnstr(y, x, s, n) mvwaddnstr(stdscr, y, x, s, n)
478 #define mvaddstr(y, x, s) mvwaddstr(stdscr, y, x, s)
479 #define mvdelch(y, x) mvwdelch(stdscr, y, x)
480 #define mvgetch(y, x) mvwgetch(stdscr, y, x)
481 #define mvgetnstr(y, x, s) mvwgetnstr(stdscr, y, x, s, n)
482 #define mvgetstr(y, x, s) mvwgetstr(stdscr, y, x, s)
483 #define mvinch(y, x) mvwinch(stdscr, y, x)
484 #define mvinchnstr(y, x, c, n) mvwinchnstr(stdscr, y, x, c, n)
485 #define mvinchstr(y, x, c) mvwinchstr(stdscr, y, x, c)
486 #define mvinnstr(y, x, s, n) mvwinnstr(stdscr, y, x, s, n)
487 #define mvinsch(y, x, c) mvwinsch(stdscr, y, x, c)
488 #define mvinstr(y, x, s) mvwinstr(stdscr, y, x, s)
489 #define mvwaddbytes(w, y, x, s, n) \
490 (wmove(w, y, x) == ERR ? ERR : __waddbytes(w, s, n, 0))
491 #define mvwaddch(w, y, x, ch) \
492 (wmove(w, y, x) == ERR ? ERR : waddch(w, ch))
493 #define mvwaddchnstr(w, y, x, s, n) \
494 (wmove(w, y, x) == ERR ? ERR : waddchnstr(w, s, n))
495 #define mvwaddchstr(w, y, x, s) \
496 (wmove(w, y, x) == ERR ? ERR : waddchnstr(w, s, -1))
497 #define mvwaddnstr(w, y, x, s, n) \
498 (wmove(w, y, x) == ERR ? ERR : waddnstr(w, s, n))
499 #define mvwaddstr(w, y, x, s) \
500 (wmove(w, y, x) == ERR ? ERR : waddnstr(w, s, -1))
501 #define mvwdelch(w, y, x) \
502 (wmove(w, y, x) == ERR ? ERR : wdelch(w))
503 #define mvwgetch(w, y, x) \
504 (wmove(w, y, x) == ERR ? ERR : wgetch(w))
505 #define mvwgetnstr(w, y, x, s, n) \
506 (wmove(w, y, x) == ERR ? ERR : wgetnstr(w, s, n))
507 #define mvwgetstr(w, y, x, s) \
508 (wmove(w, y, x) == ERR ? ERR : wgetstr(w, s))
509 #define mvwinch(w, y, x) \
510 (wmove(w, y, x) == ERR ? ERR : winch(w))
511 #define mvwinchnstr(w, y, x, c, n) \
512 (wmove(w, y, x) == ERR ? ERR : winchnstr(w, c, n))
513 #define mvwinchstr(w, y, x, s) \
514 (wmove(w, y, x) == ERR ? ERR : winchstr(w, c))
515 #define mvwinnstr(w, y, x, s, n) \
516 (wmove(w, y, x) == ERR ? ERR : winnstr(w, s, n))
517 #define mvwinsch(w, y, x, c) \
518 (wmove(w, y, x) == ERR ? ERR : winsch(w, c))
519 #define mvwinstr(w, y, x, s) \
520 (wmove(w, y, x) == ERR ? ERR : winstr(w, s))
522 /* Miscellaneous. */
523 #define noqiflush() intrflush(stdscr, FALSE)
524 #define qiflush() intrflush(stdscr, TRUE)
526 #else
527 /* Use functions not macros... */
528 __BEGIN_DECLS
529 int addbytes(const char *, int);
530 int addch(chtype);
531 int addchnstr(const chtype *, int);
532 int addchstr(const chtype *);
533 int addnstr(const char *, int);
534 int addstr(const char *);
535 int attr_get(attr_t *, short *, void *);
536 int attr_off(attr_t, void *);
537 int attr_on(attr_t, void *);
538 int attr_set(attr_t, short, void *);
539 int attroff(int);
540 int attron(int);
541 int attrset(int);
542 int bkgd(chtype);
543 void bkgdset(chtype);
544 int border(chtype, chtype, chtype, chtype,
545 chtype, chtype, chtype, chtype);
546 int clear(void);
547 int clrtobot(void);
548 int clrtoeol(void);
549 int color_set(short, void *);
550 int delch(void);
551 int deleteln(void);
552 int echochar(const chtype);
553 int erase(void);
554 int getch(void);
555 int getnstr(char *, int);
556 int getstr(char *);
557 chtype inch(void);
558 int inchnstr(chtype *, int);
559 int inchstr(chtype *);
560 int innstr(char *, int);
561 int insch(chtype);
562 int insdelln(int);
563 int insertln(void);
564 int instr(char *);
565 int move(int, int);
566 int refresh(void);
567 int scrl(int);
568 int setscrreg(int, int);
569 int standend(void);
570 int standout(void);
571 void timeout(int);
572 int underscore(void);
573 int underend(void);
574 int waddbytes(WINDOW *, const char *, int);
575 int waddstr(WINDOW *, const char *);
577 /* Standard screen plus movement functions. */
578 int mvaddbytes(int, int, const char *, int);
579 int mvaddch(int, int, chtype);
580 int mvaddchnstr(int, int, const chtype *, int);
581 int mvaddchstr(int, int, const chtype *);
582 int mvaddnstr(int, int, const char *, int);
583 int mvaddstr(int, int, const char *);
584 int mvdelch(int, int);
585 int mvgetch(int, int);
586 int mvgetnstr(int, int, char *, int);
587 int mvgetstr(int, int, char *);
588 chtype mvinch(int, int);
589 int mvinchnstr(int, int, chtype *, int);
590 int mvinchstr(int, int, chtype *);
591 int mvinnstr(int, int, char *, int);
592 int mvinsch(int, int, chtype);
593 int mvinstr(int, int, char *);
595 int mvwaddbytes(WINDOW *, int, int, const char *, int);
596 int mvwaddch(WINDOW *, int, int, chtype);
597 int mvwaddchnstr(WINDOW *, int, int, const chtype *, int);
598 int mvwaddchstr(WINDOW *, int, int, const chtype *);
599 int mvwaddnstr(WINDOW *, int, int, const char *, int);
600 int mvwaddstr(WINDOW *, int, int, const char *);
601 int mvwdelch(WINDOW *, int, int);
602 int mvwgetch(WINDOW *, int, int);
603 int mvwgetnstr(WINDOW *, int, int, char *, int);
604 int mvwgetstr(WINDOW *, int, int, char *);
605 chtype mvwinch(WINDOW *, int, int);
606 int mvwinsch(WINDOW *, int, int, chtype);
607 __END_DECLS
608 #endif /* _CURSES_USE_MACROS */
610 #define getyx(w, y, x) (y) = getcury(w), (x) = getcurx(w)
611 #define getbegyx(w, y, x) (y) = getbegy(w), (x) = getbegx(w)
612 #define getmaxyx(w, y, x) (y) = getmaxy(w), (x) = getmaxx(w)
613 #define getparyx(w, y, x) (y) = getpary(w), (x) = getparx(w)
615 /* Public function prototypes. */
616 __BEGIN_DECLS
617 int assume_default_colors(short, short);
618 int baudrate(void);
619 int beep(void);
620 int box(WINDOW *, chtype, chtype);
621 bool can_change_color(void);
622 int cbreak(void);
623 int clearok(WINDOW *, bool);
624 int color_content(short, short *, short *, short *);
625 int copywin(const WINDOW *, WINDOW *, int, int, int, int, int, int, int);
626 int curs_set(int);
627 int def_prog_mode(void);
628 int def_shell_mode(void);
629 int define_key(char *, int);
630 int delay_output(int);
631 void delscreen(SCREEN *);
632 int delwin(WINDOW *);
633 WINDOW *derwin(WINDOW *, int, int, int, int);
634 WINDOW *dupwin(WINDOW *);
635 int doupdate(void);
636 int echo(void);
637 int endwin(void);
638 char erasechar(void);
639 int flash(void);
640 int flushinp(void);
641 int flushok(WINDOW *, bool);
642 char *fullname(const char *, char *);
643 chtype getattrs(WINDOW *);
644 chtype getbkgd(WINDOW *);
645 char *getcap(char *);
646 int getcury(WINDOW *);
647 int getcurx(WINDOW *);
648 int getbegy(WINDOW *);
649 int getbegx(WINDOW *);
650 int getmaxy(WINDOW *);
651 int getmaxx(WINDOW *);
652 int getpary(WINDOW *);
653 int getparx(WINDOW *);
654 int gettmode(void);
655 WINDOW *getwin(FILE *);
656 int halfdelay(int);
657 bool has_colors(void);
658 bool has_ic(void);
659 bool has_il(void);
660 int hline(chtype, int);
661 int idcok(WINDOW *, bool);
662 int idlok(WINDOW *, bool);
663 int init_color(short, short, short, short);
664 int init_pair(short, short, short);
665 WINDOW *initscr(void);
666 int intrflush(WINDOW *, bool);
667 bool isendwin(void);
668 bool is_linetouched(WINDOW *, int);
669 bool is_wintouched(WINDOW *);
670 int keyok(int, bool);
671 int keypad(WINDOW *, bool);
672 char *keyname(int);
673 char killchar(void);
674 int leaveok(WINDOW *, bool);
675 char *longname(void);
676 int meta(WINDOW *, bool);
677 int mvcur(int, int, int, int);
678 int mvderwin(WINDOW *, int, int);
679 int mvhline(int, int, chtype, int);
680 int mvprintw(int, int, const char *, ...) __printflike(3, 4);
681 int mvscanw(int, int, const char *, ...) __scanflike(3, 4);
682 int mvvline(int, int, chtype, int);
683 int mvwhline(WINDOW *, int, int, chtype, int);
684 int mvwvline(WINDOW *, int, int, chtype, int);
685 int mvwin(WINDOW *, int, int);
686 int mvwinchnstr(WINDOW *, int, int, chtype *, int);
687 int mvwinchstr(WINDOW *, int, int, chtype *);
688 int mvwinnstr(WINDOW *, int, int, char *, int);
689 int mvwinstr(WINDOW *, int, int, char *);
690 int mvwprintw(WINDOW *, int, int, const char *, ...) __printflike(4, 5);
691 int mvwscanw(WINDOW *, int, int, const char *, ...) __scanflike(4, 5);
692 int napms(int);
693 WINDOW *newpad(int, int);
694 SCREEN *newterm(char *, FILE *, FILE *);
695 WINDOW *newwin(int, int, int, int);
696 int nl(void);
697 attr_t no_color_attributes(void);
698 int nocbreak(void);
699 int nodelay(WINDOW *, bool);
700 int noecho(void);
701 int nonl(void);
702 void noqiflush(void);
703 int noraw(void);
704 int notimeout(WINDOW *, bool);
705 int overlay(const WINDOW *, WINDOW *);
706 int overwrite(const WINDOW *, WINDOW *);
707 int pair_content(short, short *, short *);
708 int pechochar(WINDOW *, const chtype);
709 int pnoutrefresh(WINDOW *, int, int, int, int, int, int);
710 int prefresh(WINDOW *, int, int, int, int, int, int);
711 int printw(const char *, ...) __printflike(1, 2);
712 int putwin(WINDOW *, FILE *);
713 void qiflush(void);
714 int raw(void);
715 int redrawwin(WINDOW *);
716 int reset_prog_mode(void);
717 int reset_shell_mode(void);
718 int resetty(void);
719 int resizeterm(int, int);
720 int savetty(void);
721 int scanw(const char *, ...) __scanflike(1, 2);
722 int scroll(WINDOW *);
723 int scrollok(WINDOW *, bool);
724 int setterm(char *);
725 SCREEN *set_term(SCREEN *);
726 int start_color(void);
727 WINDOW *subpad(WINDOW *, int, int, int, int);
728 WINDOW *subwin(WINDOW *, int, int, int, int);
729 chtype termattrs(void);
730 attr_t term_attrs(void);
731 int touchline(WINDOW *, int, int);
732 int touchoverlap(WINDOW *, WINDOW *);
733 int touchwin(WINDOW *);
734 int ungetch(int);
735 int untouchwin(WINDOW *);
736 int use_default_colors(void);
737 int vline(chtype, int);
738 int vw_printw(WINDOW *, const char *, _BSD_VA_LIST_) __printflike(2, 0);
739 int vw_scanw(WINDOW *, const char *, _BSD_VA_LIST_) __scanflike(2, 0);
740 int vwprintw(WINDOW *, const char *, _BSD_VA_LIST_) __printflike(2, 0);
741 int vwscanw(WINDOW *, const char *, _BSD_VA_LIST_) __scanflike(2, 0);
742 int waddch(WINDOW *, chtype);
743 int waddchnstr(WINDOW *, const chtype *, int);
744 int waddchstr(WINDOW *, const chtype *);
745 int waddnstr(WINDOW *, const char *, int);
746 int wattr_get(WINDOW *, attr_t *, short *, void *);
747 int wattr_off(WINDOW *, attr_t, void *);
748 int wattr_on(WINDOW *, attr_t, void *);
749 int wattr_set(WINDOW *, attr_t, short, void *);
750 int wattroff(WINDOW *, int);
751 int wattron(WINDOW *, int);
752 int wattrset(WINDOW *, int);
753 int wbkgd(WINDOW *, chtype);
754 void wbkgdset(WINDOW *, chtype);
755 int wborder(WINDOW *, chtype, chtype, chtype, chtype, chtype, chtype,
756 chtype, chtype);
757 int wclear(WINDOW *);
758 int wclrtobot(WINDOW *);
759 int wclrtoeol(WINDOW *);
760 int wcolor_set(WINDOW *, short, void *);
761 void wcursyncup(WINDOW *);
762 int wdelch(WINDOW *);
763 int wdeleteln(WINDOW *);
764 int wechochar(WINDOW *, const chtype);
765 int werase(WINDOW *);
766 int wgetch(WINDOW *);
767 int wgetnstr(WINDOW *, char *, int);
768 int wgetstr(WINDOW *, char *);
769 int whline(WINDOW *, chtype, int);
770 chtype winch(WINDOW *);
771 int winchnstr(WINDOW *, chtype *, int);
772 int winchstr(WINDOW *, chtype *);
773 int winnstr(WINDOW *, char *, int);
774 int winsch(WINDOW *, chtype);
775 int winsdelln(WINDOW *, int);
776 int winsertln(WINDOW *);
777 int winstr(WINDOW *, char *);
778 int wmove(WINDOW *, int, int);
779 int wnoutrefresh(WINDOW *);
780 int wprintw(WINDOW *, const char *, ...) __printflike(2, 3);
781 int wredrawln(WINDOW *, int, int);
782 int wrefresh(WINDOW *);
783 int wresize(WINDOW *, int, int);
784 int wscanw(WINDOW *, const char *, ...) __scanflike(2, 3);
785 int wscrl(WINDOW *, int);
786 int wsetscrreg(WINDOW *, int, int);
787 int wstandend(WINDOW *);
788 int wstandout(WINDOW *);
789 void wsyncdown(WINDOW *);
790 void wsyncup(WINDOW *);
791 void wtimeout(WINDOW *, int);
792 int wtouchln(WINDOW *, int, int, int);
793 int wunderend(WINDOW *);
794 int wunderscore(WINDOW *);
795 int wvline(WINDOW *, chtype, int);
797 int insnstr(const char *, int);
798 int insstr(const char *);
799 int mvinsnstr(int, int, const char *, int);
800 int mvinsstr(int, int, const char *);
801 int mvwinsnstr(WINDOW *, int, int, const char *, int);
802 int mvwinsstr(WINDOW *, int, int, const char *);
803 int winsnstr(WINDOW *, const char *, int);
804 int winsstr(WINDOW *, const char *);
806 int chgat(int, attr_t, short, const void *);
807 int wchgat(WINDOW *, int, attr_t, short, const void *);
808 int mvchgat(int, int, int, attr_t, short, const void *);
809 int mvwchgat(WINDOW *, int, int, int, attr_t, short, const void *);
811 /* wide-character support routines */
812 /* return ERR when HAVE_WCHAR is not defined */
813 /* add */
814 int add_wch(const cchar_t *);
815 int wadd_wch(WINDOW *, const cchar_t *);
816 int mvadd_wch(int, int, const cchar_t *);
817 int mvwadd_wch(WINDOW *, int, int, const cchar_t *);
819 int add_wchnstr(const cchar_t *, int);
820 int add_wchstr(const cchar_t *);
821 int wadd_wchnstr(WINDOW *, const cchar_t *, int);
822 int wadd_wchstr(WINDOW *, const cchar_t *);
823 int mvadd_wchnstr(int, int, const cchar_t *, int);
824 int mvadd_wchstr(int, int, const cchar_t *);
825 int mvwadd_wchnstr(WINDOW *, int, int, const cchar_t *, int);
826 int mvwadd_wchstr(WINDOW *, int, int, const cchar_t *);
828 int addnwstr(const wchar_t *, int);
829 int addwstr(const wchar_t *);
830 int mvaddnwstr(int, int x, const wchar_t *, int);
831 int mvaddwstr(int, int x, const wchar_t *);
832 int mvwaddnwstr(WINDOW *, int, int, const wchar_t *, int);
833 int mvwaddwstr(WINDOW *, int, int, const wchar_t *);
834 int waddnwstr(WINDOW *, const wchar_t *, int);
835 int waddwstr(WINDOW *, const wchar_t *);
837 int echo_wchar(const cchar_t *);
838 int wecho_wchar(WINDOW *, const cchar_t *);
839 int pecho_wchar(WINDOW *, const cchar_t *);
841 /* insert */
842 int ins_wch(const cchar_t *);
843 int wins_wch(WINDOW *, const cchar_t *);
844 int mvins_wch(int, int, const cchar_t *);
845 int mvwins_wch(WINDOW *, int, int, const cchar_t *);
847 int ins_nwstr(const wchar_t *, int);
848 int ins_wstr(const wchar_t *);
849 int mvins_nwstr(int, int, const wchar_t *, int);
850 int mvins_wstr(int, int, const wchar_t *);
851 int mvwins_nwstr(WINDOW *, int, int, const wchar_t *, int);
852 int mvwins_wstr(WINDOW *, int, int, const wchar_t *);
853 int wins_nwstr(WINDOW *, const wchar_t *, int);
854 int wins_wstr(WINDOW *, const wchar_t *);
856 /* input */
857 int get_wch(wint_t *);
858 int unget_wch(const wchar_t);
859 int mvget_wch(int, int, wint_t *);
860 int mvwget_wch(WINDOW *, int, int, wint_t *);
861 int wget_wch(WINDOW *, wint_t *);
863 int getn_wstr(wchar_t *, int);
864 int get_wstr(wchar_t *);
865 int mvgetn_wstr(int, int, wchar_t *, int);
866 int mvget_wstr(int, int, wchar_t *);
867 int mvwgetn_wstr(WINDOW *, int, int, wchar_t *, int);
868 int mvwget_wstr(WINDOW *, int, int, wchar_t *);
869 int wgetn_wstr(WINDOW *, wchar_t *, int);
870 int wget_wstr(WINDOW *, wchar_t *);
872 int in_wch(cchar_t *);
873 int mvin_wch(int, int, cchar_t *);
874 int mvwin_wch(WINDOW *, int, int, cchar_t *);
875 int win_wch(WINDOW *, cchar_t *);
877 int in_wchnstr(cchar_t *, int);
878 int in_wchstr(cchar_t *);
879 int mvin_wchnstr(int, int, cchar_t *, int);
880 int mvin_wchstr(int, int, cchar_t *);
881 int mvwin_wchnstr(WINDOW *, int, int, cchar_t *, int);
882 int mvwin_wchstr(WINDOW *, int, int, cchar_t *);
883 int win_wchnstr(WINDOW *, cchar_t *, int);
884 int win_wchstr(WINDOW *, cchar_t *);
886 int innwstr(wchar_t *, int);
887 int inwstr(wchar_t *);
888 int mvinnwstr(int, int, wchar_t *, int);
889 int mvinwstr(int, int, wchar_t *);
890 int mvwinnwstr(WINDOW *, int, int, wchar_t *, int);
891 int mvwinwstr(WINDOW *, int, int, wchar_t *);
892 int winnwstr(WINDOW *, wchar_t *, int);
893 int winwstr(WINDOW *, wchar_t *);
895 /* cchar handlgin */
896 int setcchar(cchar_t *, const wchar_t *, const attr_t, short, const void *);
897 int getcchar(const cchar_t *, wchar_t *, attr_t *, short *, void *);
899 /* misc */
900 char *key_name( wchar_t );
901 int border_set(const cchar_t *, const cchar_t *, const cchar_t *,
902 const cchar_t *, const cchar_t *, const cchar_t *,
903 const cchar_t *, const cchar_t *);
904 int wborder_set(WINDOW *, const cchar_t *, const cchar_t *,
905 const cchar_t *, const cchar_t *, const cchar_t *,
906 const cchar_t *, const cchar_t *, const cchar_t *);
907 int box_set(WINDOW *, const cchar_t *, const cchar_t *);
908 int erasewchar(wchar_t *);
909 int killwchar(wchar_t *);
910 int hline_set(const cchar_t *, int);
911 int mvhline_set(int, int, const cchar_t *, int);
912 int mvvline_set(int, int, const cchar_t *, int);
913 int mvwhline_set(WINDOW *, int, int, const cchar_t *, int);
914 int mvwvline_set(WINDOW *, int, int, const cchar_t *, int);
915 int vline_set(const cchar_t *, int);
916 int whline_set(WINDOW *, const cchar_t *, int);
917 int wvline_set(WINDOW *, const cchar_t *, int);
918 int bkgrnd(const cchar_t *);
919 void bkgrndset(const cchar_t *);
920 int getbkgrnd(cchar_t *);
921 int wbkgrnd(WINDOW *, const cchar_t *);
922 void wbkgrndset(WINDOW *, const cchar_t *);
923 int wgetbkgrnd(WINDOW *, cchar_t *);
925 /* Private functions that are needed for user programs prototypes. */
926 int __cputchar(int);
927 int __waddbytes(WINDOW *, const char *, int, attr_t);
928 #ifdef HAVE_WCHAR
929 int __cputwchar( wchar_t );
930 #endif /* HAVE_WCHAR */
931 __END_DECLS
933 #endif /* !_CURSES_H_ */