curses.h revision 1.87.6.1 1 /* $NetBSD: curses.h,v 1.87.6.1 2007/01/21 11:38:59 blymn Exp $ */
2
3 /*
4 * Copyright (c) 1981, 1993, 1994
5 * The Regents of the University of California. All rights reserved.
6 *
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.
18 *
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.
30 *
31 * @(#)curses.h 8.5 (Berkeley) 4/29/95
32 *
33 * Modified by Ruibiao Qiu <ruibiao (at) arl.wustl.edu,ruibiao (at) 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
38 */
39
40 #ifndef _CURSES_H_
41 #define _CURSES_H_
42
43 #include <sys/types.h>
44 #include <sys/cdefs.h>
45 #include <wchar.h>
46
47 #include <stdio.h>
48 #include <termcap.h>
49
50 /*
51 * attr_t must be the same size as wchar_t (see <wchar.h>) to avoid padding
52 * in __LDATA.
53 */
54 typedef wchar_t chtype;
55 typedef wchar_t attr_t;
56
57 #ifdef HAVE_WCHAR
58 /*
59 * The complex character structure required by the X/Open reference to be used in
60 * functions such as in_wchstr(). It includes a string of up to 8 wide characters
61 * and its length, an attribute, and a color-pair.
62 */
63 #define CURSES_CCHAR_MAX 8
64 #define CCHARW_MAX 5
65 typedef struct {
66 attr_t attributes; /* character attributes */
67 unsigned elements; /* number of wide char in vals[] */
68 wchar_t vals[CURSES_CCHAR_MAX]; /* wide chars including non-spacing */
69 } cchar_t;
70 #else
71 typedef chtype cchar_t;
72 #endif /* HAVE_WCHAR */
73
74 /* C++ already defines bool. */
75 #ifndef __cplusplus
76 typedef char bool;
77 #endif
78
79 #ifndef TRUE
80 #define TRUE (/*CONSTCOND*/1)
81 #endif
82 #ifndef FALSE
83 #define FALSE (/*CONSTCOND*/0)
84 #endif
85
86 #ifndef _CURSES_PRIVATE
87
88 #define _puts(s) tputs(s, 0, __cputchar)
89 #define _putchar(c) __cputchar(c)
90
91 /* Old-style terminal modes access. */
92 #define crmode() cbreak()
93 #define nocrmode() nocbreak()
94 #define ospeed baudrate()
95 #endif /* _CURSES_PRIVATE */
96
97
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 */
107
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))
112
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 */
133
134 /*
135 * "Keypad" keys arranged like this:
136 *
137 * A1 up A3
138 * left B2 right
139 * C1 down C3
140 *
141 */
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 */
147
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 */
208
209 #include <unctrl.h>
210
211 /*
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.
214 */
215
216 /*
217 * Definitions for characters and attributes in __LDATA
218 */
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 video. */
224 #define __BLINK 0x00000800 /* Added characters are blinking. */
225 #define __DIM 0x00001000 /* Added characters are dim. */
226 #define __BOLD 0x00002000 /* Added characters are bold. */
227 #define __BLANK 0x00004000 /* Added characters are blanked. */
228 #define __PROTECT 0x00008000 /* Added characters are protected. */
229 #define __ALTCHARSET 0x00010000 /* Added characters are ACS */
230 #define __COLOR 0x03fe0000 /* Color bits */
231 #define __ATTRIBUTES 0x03ffff00 /* All 8-bit attribute bits */
232
233 typedef struct __ldata __LDATA;
234 typedef struct __line __LINE;
235 typedef struct __window WINDOW;
236 typedef struct __screen SCREEN;
237
238 /*
239 * Attribute definitions
240 */
241 #define A_NORMAL __NORMAL
242 #define A_STANDOUT __STANDOUT
243 #define A_UNDERLINE __UNDERSCORE
244 #define A_REVERSE __REVERSE
245 #define A_BLINK __BLINK
246 #define A_DIM __DIM
247 #define A_BOLD __BOLD
248 #define A_BLANK __BLANK
249 #define A_PROTECT __PROTECT
250 #define A_ALTCHARSET __ALTCHARSET
251 #define A_ATTRIBUTES __ATTRIBUTES
252 #define A_CHARTEXT __CHARTEXT
253 #define A_COLOR __COLOR
254
255 #ifdef HAVE_WCHAR
256 #define WA_ATTRIBUTES 0x03ffffff /* Wide character attributes mask */
257 #define WA_ALTCHARSET __ALTCHARSET /* Alternate character set */
258 #define WA_BLINK __BLINK /* Blinking */
259 #define WA_BOLD __BOLD /* Extra bright or bold */
260 #define WA_DIM __DIM /* Half bright */
261 #define WA_PROTECT __PROTECT /* Protected */
262 #define WA_REVERSE __REVERSE /* Reverse video */
263 #define WA_STANDOUT __STANDOUT /* Best highlighting mode */
264 #define WA_UNDERLINE __UNDERSCORE /* Underlining */
265 #define WA_INVIS 0x00000001 /* Invisible */
266 #define WA_LOW 0x00000002 /* Low highlight */
267 #define WA_TOP 0x00000004 /* Top highlight */
268 #define WA_HORIZONTAL 0x00000008 /* Horizontal highlight */
269 #define WA_VERTICAL 0x00000010 /* Vertical highlight */
270 #define WA_LEFT 0x00000020 /* Left highlight */
271 #define WA_RIGHT 0x00000040 /* Right highlight */
272 #endif /* HAVE_WCHAR */
273
274 /*
275 * Alternate character set definitions
276 */
277
278 #define NUM_ACS 128
279
280 extern chtype _acs_char[NUM_ACS];
281 #ifdef __cplusplus
282 #define __UC_CAST(a) static_cast<unsigned char>(a)
283 #else
284 #define __UC_CAST(a) (unsigned char)(a)
285 #endif
286 #define ACS_RARROW _acs_char[__UC_CAST('+')]
287 #define ACS_LARROW _acs_char[__UC_CAST(',')]
288 #define ACS_UARROW _acs_char[__UC_CAST('-')]
289 #define ACS_DARROW _acs_char[__UC_CAST('.')]
290 #define ACS_BLOCK _acs_char[__UC_CAST('0')]
291 #define ACS_DIAMOND _acs_char[__UC_CAST('`')]
292 #define ACS_CKBOARD _acs_char[__UC_CAST('a')]
293 #define ACS_DEGREE _acs_char[__UC_CAST('f')]
294 #define ACS_PLMINUS _acs_char[__UC_CAST('g')]
295 #define ACS_BOARD _acs_char[__UC_CAST('h')]
296 #define ACS_LANTERN _acs_char[__UC_CAST('i')]
297 #define ACS_LRCORNER _acs_char[__UC_CAST('j')]
298 #define ACS_URCORNER _acs_char[__UC_CAST('k')]
299 #define ACS_ULCORNER _acs_char[__UC_CAST('l')]
300 #define ACS_LLCORNER _acs_char[__UC_CAST('m')]
301 #define ACS_PLUS _acs_char[__UC_CAST('n')]
302 #define ACS_HLINE _acs_char[__UC_CAST('q')]
303 #define ACS_S1 _acs_char[__UC_CAST('o')]
304 #define ACS_S9 _acs_char[__UC_CAST('s')]
305 #define ACS_LTEE _acs_char[__UC_CAST('t')]
306 #define ACS_RTEE _acs_char[__UC_CAST('u')]
307 #define ACS_BTEE _acs_char[__UC_CAST('v')]
308 #define ACS_TTEE _acs_char[__UC_CAST('w')]
309 #define ACS_VLINE _acs_char[__UC_CAST('x')]
310 #define ACS_BULLET _acs_char[__UC_CAST('~')]
311
312 #ifdef HAVE_WCHAR
313 extern cchar_t _wacs_char[NUM_ACS];
314
315 #define WACS_RARROW _wacs_char[(unsigned char)'+'].vals[0]
316 #define WACS_LARROW _wacs_char[(unsigned char)','].vals[0]
317 #define WACS_UARROW _wacs_char[(unsigned char)'-'].vals[0]
318 #define WACS_DARROW _wacs_char[(unsigned char)'.'].vals[0]
319 #define WACS_BLOCK _wacs_char[(unsigned char)'0'].vals[0]
320 #define WACS_DIAMOND _wacs_char[(unsigned char)'`'].vals[0]
321 #define WACS_CKBOARD _wacs_char[(unsigned char)'a'].vals[0]
322 #define WACS_DEGREE _wacs_char[(unsigned char)'f'].vals[0]
323 #define WACS_PLMINUS _wacs_char[(unsigned char)'g'].vals[0]
324 #define WACS_BOARD _wacs_char[(unsigned char)'h'].vals[0]
325 #define WACS_LANTERN _wacs_char[(unsigned char)'i'].vals[0]
326 #define WACS_LRCORNER _wacs_char[(unsigned char)'j'].vals[0]
327 #define WACS_URCORNER _wacs_char[(unsigned char)'k'].vals[0]
328 #define WACS_ULCORNER _wacs_char[(unsigned char)'l'].vals[0]
329 #define WACS_LLCORNER _wacs_char[(unsigned char)'m'].vals[0]
330 #define WACS_PLUS _wacs_char[(unsigned char)'n'].vals[0]
331 #define WACS_HLINE _wacs_char[(unsigned char)'q'].vals[0]
332 #define WACS_S1 _wacs_char[(unsigned char)'o'].vals[0]
333 #define WACS_S9 _wacs_char[(unsigned char)'s'].vals[0]
334 #define WACS_LTEE _wacs_char[(unsigned char)'t'].vals[0]
335 #define WACS_RTEE _wacs_char[(unsigned char)'u'].vals[0]
336 #define WACS_BTEE _wacs_char[(unsigned char)'v'].vals[0]
337 #define WACS_TTEE _wacs_char[(unsigned char)'w'].vals[0]
338 #define WACS_VLINE _wacs_char[(unsigned char)'x'].vals[0]
339 #define WACS_BULLET _wacs_char[(unsigned char)'~'].vals[0]
340 #endif /* HAVE_WCHAR */
341
342 /* System V compatibility */
343 #define ACS_SBBS ACS_LRCORNER
344 #define ACS_BBSS ACS_URCORNER
345 #define ACS_BSSB ACS_ULCORNER
346 #define ACS_SSBB ACS_LLCORNER
347 #define ACS_SSSS ACS_PLUS
348 #define ACS_BSBS ACS_HLINE
349 #define ACS_SSSB ACS_LTEE
350 #define ACS_SBSS ACS_RTEE
351 #define ACS_SSBS ACS_BTEE
352 #define ACS_BSSS ACS_TTEE
353 #define ACS_SBSB ACS_VLINE
354 #define _acs_map _acs_char
355
356 /*
357 * Color definitions (ANSI color numbers)
358 */
359
360 #define COLOR_BLACK 0x00
361 #define COLOR_RED 0x01
362 #define COLOR_GREEN 0x02
363 #define COLOR_YELLOW 0x03
364 #define COLOR_BLUE 0x04
365 #define COLOR_MAGENTA 0x05
366 #define COLOR_CYAN 0x06
367 #define COLOR_WHITE 0x07
368
369 #ifdef __cplusplus
370 #define __UINT32_CAST(a) static_cast<u_int32_t>(a)
371 #else
372 #define __UINT32_CAST(a) (u_int32_t)(a)
373 #endif
374 #define COLOR_PAIR(n) (((__UINT32_CAST(n)) << 17) & A_COLOR)
375 #define PAIR_NUMBER(n) (((__UINT32_CAST(n)) & A_COLOR) >> 17)
376
377 /* Curses external declarations. */
378 extern WINDOW *curscr; /* Current screen. */
379 extern WINDOW *stdscr; /* Standard screen. */
380
381 extern int __tcaction; /* If terminal hardware set. */
382
383 extern int COLS; /* Columns on the screen. */
384 extern int LINES; /* Lines on the screen. */
385 extern int COLORS; /* Max colors on the screen. */
386 extern int COLOR_PAIRS; /* Max color pairs on the screen. */
387
388 extern int ESCDELAY; /* Delay between keys in esc seq's. */
389
390 #define ERR (-1) /* Error return. */
391 #define OK (0) /* Success return. */
392
393 /*
394 * The following have, traditionally, been macros but X/Open say they
395 * need to be functions. Keep the old macros for debugging.
396 */
397 #ifdef _CURSES_USE_MACROS
398 /* Standard screen pseudo functions. */
399 #define addbytes(s, n) __waddbytes(stdscr, s, n, 0)
400 #define addch(ch) waddch(stdscr, ch)
401 #define addchnstr(s) waddchnstr(stdscr, s, n)
402 #define addchstr(s) waddchnstr(stdscr, s, -1)
403 #define addnstr(s, n) waddnstr(stdscr, s, n)
404 #define addstr(s) waddnstr(stdscr, s, -1)
405 #define attr_get(a, p, o) wattr_get(stdscr, a, p, o)
406 #define attr_off(a, o) wattr_off(stdscr, a, o)
407 #define attr_on(a, o) wattr_on(stdscr, a, o)
408 #define attr_set(a, p, o) wattr_set(stdscr, a, p, o)
409 #define attroff(attr) wattroff(stdscr, attr)
410 #define attron(attr) wattron(stdscr, attr)
411 #define attrset(attr) wattrset(stdscr, attr)
412 #define bkgd(ch) wbkgd(stdscr, ch)
413 #define bkgdset(ch) wbkgdset(stdscr, ch)
414 #define border(l, r, t, b, tl, tr, bl, br) \
415 wborder(stdscr, l, r, t, b, tl, tr, bl, br)
416 #define clear() wclear(stdscr)
417 #define clrtobot() wclrtobot(stdscr)
418 #define clrtoeol() wclrtoeol(stdscr)
419 #define color_set(c, o) wcolor_set(stdscr, c, o)
420 #define delch() wdelch(stdscr)
421 #define deleteln() wdeleteln(stdscr)
422 #define echochar(c) wechochar(stdscr, c)
423 #define erase() werase(stdscr)
424 #define getch() wgetch(stdscr)
425 #define getnstr(s, n) wgetnstr(stdscr, s, n)
426 #define getstr(s) wgetstr(stdscr, s)
427 #define inch() winch(stdscr)
428 #define inchnstr(c) winchnstr(stdscr, c)
429 #define inchstr(c) winchstr(stdscr, c)
430 #define innstr(s, n) winnstr(stdscr, s, n)
431 #define insch(ch) winsch(stdscr, ch)
432 #define insdelln(n) winsdelln(stdscr, n)
433 #define insertln() winsertln(stdscr)
434 #define instr(s) winstr(stdscr, s)
435 #define move(y, x) wmove(stdscr, y, x)
436 #define refresh() wrefresh(stdscr)
437 #define scrl(n) wscrl(stdscr, n)
438 #define setscrreg(t, b) wsetscrreg(stdscr, t, b)
439 #define standend() wstandend(stdscr)
440 #define standout() wstandout(stdscr)
441 #define timeout(delay) wtimeout(stdscr, delay)
442 #define underscore() wunderscore(stdscr)
443 #define underend() wunderend(stdscr)
444 #define waddbytes(w, s, n) __waddbytes(w, s, n, 0)
445 #define waddstr(w, s) waddnstr(w, s, -1)
446
447 /* Standard screen plus movement pseudo functions. */
448 #define mvaddbytes(y, x, s, n) mvwaddbytes(stdscr, y, x, s, n)
449 #define mvaddch(y, x, ch) mvwaddch(stdscr, y, x, ch)
450 #define mvaddchnstr(y, x, s, n) mvwaddchnstr(stdscr, y, x, s, n)
451 #define mvaddchstr(y, x, s) mvwaddchstr(stdscr, y, x, s)
452 #define mvaddnstr(y, x, s, n) mvwaddnstr(stdscr, y, x, s, n)
453 #define mvaddstr(y, x, s) mvwaddstr(stdscr, y, x, s)
454 #define mvdelch(y, x) mvwdelch(stdscr, y, x)
455 #define mvgetch(y, x) mvwgetch(stdscr, y, x)
456 #define mvgetnstr(y, x, s) mvwgetnstr(stdscr, y, x, s, n)
457 #define mvgetstr(y, x, s) mvwgetstr(stdscr, y, x, s)
458 #define mvinch(y, x) mvwinch(stdscr, y, x)
459 #define mvinchnstr(y, x, c, n) mvwinchnstr(stdscr, y, x, c, n)
460 #define mvinchstr(y, x, c) mvwinchstr(stdscr, y, x, c)
461 #define mvinnstr(y, x, s, n) mvwinnstr(stdscr, y, x, s, n)
462 #define mvinsch(y, x, c) mvwinsch(stdscr, y, x, c)
463 #define mvinstr(y, x, s) mvwinstr(stdscr, y, x, s)
464 #define mvwaddbytes(w, y, x, s, n) \
465 (wmove(w, y, x) == ERR ? ERR : __waddbytes(w, s, n, 0))
466 #define mvwaddch(w, y, x, ch) \
467 (wmove(w, y, x) == ERR ? ERR : waddch(w, ch))
468 #define mvwaddchnstr(w, y, x, s, n) \
469 (wmove(w, y, x) == ERR ? ERR : waddchnstr(w, s, n))
470 #define mvwaddchstr(w, y, x, s) \
471 (wmove(w, y, x) == ERR ? ERR : waddchnstr(w, s, -1))
472 #define mvwaddnstr(w, y, x, s, n) \
473 (wmove(w, y, x) == ERR ? ERR : waddnstr(w, s, n))
474 #define mvwaddstr(w, y, x, s) \
475 (wmove(w, y, x) == ERR ? ERR : waddnstr(w, s, -1))
476 #define mvwdelch(w, y, x) \
477 (wmove(w, y, x) == ERR ? ERR : wdelch(w))
478 #define mvwgetch(w, y, x) \
479 (wmove(w, y, x) == ERR ? ERR : wgetch(w))
480 #define mvwgetnstr(w, y, x, s, n) \
481 (wmove(w, y, x) == ERR ? ERR : wgetnstr(w, s, n))
482 #define mvwgetstr(w, y, x, s) \
483 (wmove(w, y, x) == ERR ? ERR : wgetstr(w, s))
484 #define mvwinch(w, y, x) \
485 (wmove(w, y, x) == ERR ? ERR : winch(w))
486 #define mvwinchnstr(w, y, x, c, n) \
487 (wmove(w, y, x) == ERR ? ERR : winchnstr(w, c, n))
488 #define mvwinchstr(w, y, x, s) \
489 (wmove(w, y, x) == ERR ? ERR : winchstr(w, c))
490 #define mvwinnstr(w, y, x, s, n) \
491 (wmove(w, y, x) == ERR ? ERR : winnstr(w, s, n))
492 #define mvwinsch(w, y, x, c) \
493 (wmove(w, y, x) == ERR ? ERR : winsch(w, c))
494 #define mvwinstr(w, y, x, s) \
495 (wmove(w, y, x) == ERR ? ERR : winstr(w, s))
496
497 /* Miscellaneous. */
498 #define noqiflush() intrflush(stdscr, FALSE)
499 #define qiflush() intrflush(stdscr, TRUE)
500
501 #else
502 /* Use functions not macros... */
503 __BEGIN_DECLS
504 int addbytes(const char *, int);
505 int addch(chtype);
506 int addchnstr(const chtype *, int);
507 int addchstr(const chtype *);
508 int addnstr(const char *, int);
509 int addstr(const char *);
510 int attr_get(attr_t *, short *, void *);
511 int attr_off(attr_t, void *);
512 int attr_on(attr_t, void *);
513 int attr_set(attr_t, short, void *);
514 int attroff(int);
515 int attron(int);
516 int attrset(int);
517 int bkgd(chtype);
518 void bkgdset(chtype);
519 int border(chtype, chtype, chtype, chtype,
520 chtype, chtype, chtype, chtype);
521 int clear(void);
522 int clrtobot(void);
523 int clrtoeol(void);
524 int color_set(short, void *);
525 int delch(void);
526 int deleteln(void);
527 int echochar(const chtype);
528 int erase(void);
529 int getch(void);
530 int getnstr(char *, int);
531 int getstr(char *);
532 chtype inch(void);
533 int inchnstr(chtype *, int);
534 int inchstr(chtype *);
535 int innstr(char *, int);
536 int insch(chtype);
537 int insdelln(int);
538 int insertln(void);
539 int instr(char *);
540 int move(int, int);
541 int refresh(void);
542 int scrl(int);
543 int setscrreg(int, int);
544 int standend(void);
545 int standout(void);
546 void timeout(int);
547 int underscore(void);
548 int underend(void);
549 int waddbytes(WINDOW *, const char *, int);
550 int waddstr(WINDOW *, const char *);
551
552 /* Standard screen plus movement functions. */
553 int mvaddbytes(int, int, const char *, int);
554 int mvaddch(int, int, chtype);
555 int mvaddchnstr(int, int, const chtype *, int);
556 int mvaddchstr(int, int, const chtype *);
557 int mvaddnstr(int, int, const char *, int);
558 int mvaddstr(int, int, const char *);
559 int mvdelch(int, int);
560 int mvgetch(int, int);
561 int mvgetnstr(int, int, char *, int);
562 int mvgetstr(int, int, char *);
563 chtype mvinch(int, int);
564 int mvinchnstr(int, int, chtype *, int);
565 int mvinchstr(int, int, chtype *);
566 int mvinnstr(int, int, char *, int);
567 int mvinsch(int, int, chtype);
568 int mvinstr(int, int, char *);
569
570 int mvwaddbytes(WINDOW *, int, int, const char *, int);
571 int mvwaddch(WINDOW *, int, int, chtype);
572 int mvwaddchnstr(WINDOW *, int, int, const chtype *, int);
573 int mvwaddchstr(WINDOW *, int, int, const chtype *);
574 int mvwaddnstr(WINDOW *, int, int, const char *, int);
575 int mvwaddstr(WINDOW *, int, int, const char *);
576 int mvwdelch(WINDOW *, int, int);
577 int mvwgetch(WINDOW *, int, int);
578 int mvwgetnstr(WINDOW *, int, int, char *, int);
579 int mvwgetstr(WINDOW *, int, int, char *);
580 chtype mvwinch(WINDOW *, int, int);
581 int mvwinsch(WINDOW *, int, int, chtype);
582 __END_DECLS
583 #endif /* _CURSES_USE_MACROS */
584
585 #define getyx(w, y, x) (y) = getcury(w), (x) = getcurx(w)
586 #define getbegyx(w, y, x) (y) = getbegy(w), (x) = getbegx(w)
587 #define getmaxyx(w, y, x) (y) = getmaxy(w), (x) = getmaxx(w)
588 #define getparyx(w, y, x) (y) = getpary(w), (x) = getparx(w)
589
590 /* Public function prototypes. */
591 __BEGIN_DECLS
592 int assume_default_colors(short, short);
593 int baudrate(void);
594 int beep(void);
595 int box(WINDOW *, chtype, chtype);
596 bool can_change_color(void);
597 int cbreak(void);
598 int clearok(WINDOW *, bool);
599 int color_content(short, short *, short *, short *);
600 int copywin(const WINDOW *, WINDOW *, int, int, int, int, int, int, int);
601 int curs_set(int);
602 int def_prog_mode(void);
603 int def_shell_mode(void);
604 int define_key(char *, int);
605 int delay_output(int);
606 void delscreen(SCREEN *);
607 int delwin(WINDOW *);
608 WINDOW *derwin(WINDOW *, int, int, int, int);
609 WINDOW *dupwin(WINDOW *);
610 int doupdate(void);
611 int echo(void);
612 int endwin(void);
613 char erasechar(void);
614 int flash(void);
615 int flushinp(void);
616 int flushok(WINDOW *, bool);
617 char *fullname(const char *, char *);
618 chtype getattrs(WINDOW *);
619 chtype getbkgd(WINDOW *);
620 char *getcap(char *);
621 int getcury(WINDOW *);
622 int getcurx(WINDOW *);
623 int getbegy(WINDOW *);
624 int getbegx(WINDOW *);
625 int getmaxy(WINDOW *);
626 int getmaxx(WINDOW *);
627 int getpary(WINDOW *);
628 int getparx(WINDOW *);
629 int gettmode(void);
630 int halfdelay(int);
631 bool has_colors(void);
632 bool has_ic(void);
633 bool has_il(void);
634 int hline(chtype, int);
635 int idcok(WINDOW *, bool);
636 int idlok(WINDOW *, bool);
637 int init_color(short, short, short, short);
638 int init_pair(short, short, short);
639 WINDOW *initscr(void);
640 int intrflush(WINDOW *, bool);
641 bool isendwin(void);
642 bool is_linetouched(WINDOW *, int);
643 bool is_wintouched(WINDOW *);
644 int keyok(int, bool);
645 void keypad(WINDOW *, bool);
646 char *keyname(int);
647 char killchar(void);
648 int leaveok(WINDOW *, bool);
649 char *longname(void);
650 int meta(WINDOW *, bool);
651 int mvcur(int, int, int, int);
652 int mvderwin(WINDOW *, int, int);
653 int mvhline(int, int, chtype, int);
654 int mvprintw(int, int, const char *, ...)
655 __attribute__((__format__(__printf__, 3, 4)));
656 int mvscanw(int, int, const char *, ...)
657 __attribute__((__format__(__scanf__, 3, 4)));
658 int mvvline(int, int, chtype, int);
659 int mvwhline(WINDOW *, int, int, chtype, int);
660 int mvwvline(WINDOW *, int, int, chtype, int);
661 int mvwin(WINDOW *, int, int);
662 int mvwinchnstr(WINDOW *, int, int, chtype *, int);
663 int mvwinchstr(WINDOW *, int, int, chtype *);
664 int mvwinnstr(WINDOW *, int, int, char *, int);
665 int mvwinstr(WINDOW *, int, int, char *);
666 int mvwprintw(WINDOW *, int, int, const char *, ...)
667 __attribute__((__format__(__printf__, 4, 5)));
668 int mvwscanw(WINDOW *, int, int, const char *, ...)
669 __attribute__((__format__(__scanf__, 4, 5)));
670 int napms(int);
671 WINDOW *newpad(int, int);
672 SCREEN *newterm(char *, FILE *, FILE *);
673 WINDOW *newwin(int, int, int, int);
674 int nl(void);
675 attr_t no_color_video(void);
676 int nocbreak(void);
677 int nodelay(WINDOW *, bool);
678 int noecho(void);
679 int nonl(void);
680 void noqiflush(void);
681 int noraw(void);
682 int notimeout(WINDOW *, bool);
683 int overlay(const WINDOW *, WINDOW *);
684 int overwrite(const WINDOW *, WINDOW *);
685 int pair_content(short, short *, short *);
686 int pechochar(WINDOW *, const chtype);
687 int pnoutrefresh(WINDOW *, int, int, int, int, int, int);
688 int prefresh(WINDOW *, int, int, int, int, int, int);
689 int printw(const char *, ...)
690 __attribute__((__format__(__printf__, 1, 2)));
691 void qiflush(void);
692 int raw(void);
693 int redrawwin(WINDOW *);
694 int reset_prog_mode(void);
695 int reset_shell_mode(void);
696 int resetty(void);
697 int resizeterm(int, int);
698 int savetty(void);
699 int scanw(const char *, ...)
700 __attribute__((__format__(__scanf__, 1, 2)));
701 int scroll(WINDOW *);
702 int scrollok(WINDOW *, bool);
703 int setterm(char *);
704 SCREEN *set_term(SCREEN *);
705 int start_color(void);
706 WINDOW *subpad(WINDOW *, int, int, int, int);
707 WINDOW *subwin(WINDOW *, int, int, int, int);
708 int touchline(WINDOW *, int, int);
709 int touchoverlap(WINDOW *, WINDOW *);
710 int touchwin(WINDOW *);
711 int ungetch(int);
712 int untouchwin(WINDOW *);
713 int use_default_colors(void);
714 int vline(chtype, int);
715 int vwprintw(WINDOW *, const char *, _BSD_VA_LIST_)
716 __attribute__((__format__(__printf__, 2, 0)));
717 int vwscanw(WINDOW *, const char *, _BSD_VA_LIST_)
718 __attribute__((__format__(__scanf__, 2, 0)));
719 int waddch(WINDOW *, chtype);
720 int waddchnstr(WINDOW *, const chtype *, int);
721 int waddchstr(WINDOW *, const chtype *);
722 int waddnstr(WINDOW *, const char *, int);
723 int wattr_get(WINDOW *, attr_t *, short *, void *);
724 int wattr_off(WINDOW *, attr_t, void *);
725 int wattr_on(WINDOW *, attr_t, void *);
726 int wattr_set(WINDOW *, attr_t, short, void *);
727 int wattroff(WINDOW *, int);
728 int wattron(WINDOW *, int);
729 int wattrset(WINDOW *, int);
730 int wbkgd(WINDOW *, chtype);
731 void wbkgdset(WINDOW *, chtype);
732 int wborder(WINDOW *, chtype, chtype, chtype, chtype, chtype, chtype,
733 chtype, chtype);
734 int wclear(WINDOW *);
735 int wclrtobot(WINDOW *);
736 int wclrtoeol(WINDOW *);
737 int wcolor_set(WINDOW *, short, void *);
738 int wdelch(WINDOW *);
739 int wdeleteln(WINDOW *);
740 int wechochar(WINDOW *, const chtype);
741 int werase(WINDOW *);
742 int wgetch(WINDOW *);
743 int wgetnstr(WINDOW *, char *, int);
744 int wgetstr(WINDOW *, char *);
745 int whline(WINDOW *, chtype, int);
746 chtype winch(WINDOW *);
747 int winchnstr(WINDOW *, chtype *, int);
748 int winchstr(WINDOW *, chtype *);
749 int winnstr(WINDOW *, char *, int);
750 int winsch(WINDOW *, chtype);
751 int winsdelln(WINDOW *, int);
752 int winsertln(WINDOW *);
753 int winstr(WINDOW *, char *);
754 int wmove(WINDOW *, int, int);
755 int wnoutrefresh(WINDOW *);
756 int wprintw(WINDOW *, const char *, ...)
757 __attribute__((__format__(__printf__, 2, 3)));
758 int wredrawln(WINDOW *, int, int);
759 int wrefresh(WINDOW *);
760 int wresize(WINDOW *, int, int);
761 int wscanw(WINDOW *, const char *, ...)
762 __attribute__((__format__(__scanf__, 2, 3)));
763 int wscrl(WINDOW *, int);
764 int wsetscrreg(WINDOW *, int, int);
765 int wstandend(WINDOW *);
766 int wstandout(WINDOW *);
767 void wtimeout(WINDOW *, int);
768 int wtouchln(WINDOW *, int, int, int);
769 int wunderend(WINDOW *);
770 int wunderscore(WINDOW *);
771 int wvline(WINDOW *, chtype, int);
772
773 int insnstr(const char *, int);
774 int insstr(const char *);
775 int mvinsnstr(int, int, const char *, int);
776 int mvinsstr(int, int, const char *);
777 int mvwinsnstr(WINDOW *, int, int, const char *, int);
778 int mvwinsstr(WINDOW *, int, int, const char *);
779 int winsnstr(WINDOW *, const char *, int);
780 int winsstr(WINDOW *, const char *);
781
782 /* wide character support routines */
783 /* return ERR when HAVE_WCHAR is not defined */
784 /* add */
785 int add_wch(const cchar_t *);
786 int wadd_wch(WINDOW *, const cchar_t *);
787 int mvadd_wch(int, int, const cchar_t *);
788 int mvwadd_wch(WINDOW *, int, int, const cchar_t *);
789
790 int add_wchnstr(const cchar_t *, int);
791 int add_wchstr(const cchar_t *);
792 int wadd_wchnstr(WINDOW *, const cchar_t *, int);
793 int wadd_wchstr(WINDOW *, const cchar_t *);
794 int mvadd_wchnstr(int, int, const cchar_t *, int);
795 int mvadd_wchstr(int, int, const cchar_t *);
796 int mvwadd_wchnstr(WINDOW *, int, int, const cchar_t *, int);
797 int mvwadd_wchstr(WINDOW *, int, int, const cchar_t *);
798
799 int addnwstr(const wchar_t *, int);
800 int addwstr(const wchar_t *);
801 int mvaddnwstr(int, int x, const wchar_t *, int);
802 int mvaddwstr(int, int x, const wchar_t *);
803 int mvwaddnwstr(WINDOW *, int, int, const wchar_t *, int);
804 int mvwaddwstr(WINDOW *, int, int, const wchar_t *);
805 int waddnwstr(WINDOW *, const wchar_t *, int);
806 int waddwstr(WINDOW *, const wchar_t *);
807
808 int echo_wchar(const cchar_t *);
809 int wecho_wchar(WINDOW *, const cchar_t *);
810 int pecho_wchar(WINDOW *, const cchar_t *);
811
812 /* insert */
813 int ins_wch(const cchar_t *);
814 int wins_wch(WINDOW *, const cchar_t *);
815 int mvins_wch(int, int, const cchar_t *);
816 int mvwins_wch(WINDOW *, int, int, const cchar_t *);
817
818 int ins_nwstr(const wchar_t *, int);
819 int ins_wstr(const wchar_t *);
820 int mvins_nwstr(int, int, const wchar_t *, int);
821 int mvins_wstr(int, int, const wchar_t *);
822 int mvwins_nwstr(WINDOW *, int, int, const wchar_t *, int);
823 int mvwins_wstr(WINDOW *, int, int, const wchar_t *);
824 int wins_nwstr(WINDOW *, const wchar_t *, int);
825 int wins_wstr(WINDOW *, const wchar_t *);
826
827 /* input */
828 int get_wch(wint_t *);
829 int unget_wch(const wchar_t);
830 int mvget_wch(int, int, wint_t *);
831 int mvwget_wch(WINDOW *, int, int, wint_t *);
832 int wget_wch(WINDOW *, wint_t *);
833
834 int getn_wstr(wchar_t *, int);
835 int get_wstr(wchar_t *);
836 int mvgetn_wstr(int, int, wchar_t *, int);
837 int mvget_wstr(int, int, wchar_t *);
838 int mvwgetn_wstr(WINDOW *, int, int, wchar_t *, int);
839 int mvwget_wstr(WINDOW *, int, int, wchar_t *);
840 int wgetn_wstr(WINDOW *, wchar_t *, int);
841 int wget_wstr(WINDOW *, wchar_t *);
842
843 int in_wch(cchar_t *);
844 int mvin_wch(int, int, cchar_t *);
845 int mvwin_wch(WINDOW *, int, int, cchar_t *);
846 int win_wch(WINDOW *, cchar_t *);
847
848 int in_wchnstr(cchar_t *, int);
849 int in_wchstr(cchar_t *);
850 int mvin_wchnstr(int, int, cchar_t *, int);
851 int mvin_wchstr(int, int, cchar_t *);
852 int mvwin_wchnstr(WINDOW *, int, int, cchar_t *, int);
853 int mvwin_wchstr(WINDOW *, int, int, cchar_t *);
854 int win_wchnstr(WINDOW *, cchar_t *, int);
855 int win_wchstr(WINDOW *, cchar_t *);
856
857 int innwstr(wchar_t *, int);
858 int inwstr(wchar_t *);
859 int mvinnwstr(int, int, wchar_t *, int);
860 int mvinwstr(int, int, wchar_t *);
861 int mvwinnwstr(WINDOW *, int, int, wchar_t *, int);
862 int mvwinwstr(WINDOW *, int, int, wchar_t *);
863 int winnwstr(WINDOW *, wchar_t *, int);
864 int winwstr(WINDOW *, wchar_t *);
865
866 /* cchar handlgin */
867 int setcchar(cchar_t *, const wchar_t *, const attr_t, short, const void *);
868 int getcchar(const cchar_t *, wchar_t *, attr_t *, short *, void *);
869
870 /* misc */
871 char *key_name( wchar_t );
872 int border_set(const cchar_t *, const cchar_t *, const cchar_t *,
873 const cchar_t *, const cchar_t *, const cchar_t *,
874 const cchar_t *, const cchar_t *);
875 int wborder_set(WINDOW *, const cchar_t *, const cchar_t *,
876 const cchar_t *, const cchar_t *, const cchar_t *,
877 const cchar_t *, const cchar_t *, const cchar_t *);
878 int box_set(WINDOW *, const cchar_t *, const cchar_t *);
879 int erasewchar(wchar_t *);
880 int killwchar(wchar_t *);
881 int hline_set(const cchar_t *, int);
882 int mvhline_set(int, int, const cchar_t *, int);
883 int mvvline_set(int, int, const cchar_t *, int);
884 int mvwhline_set(WINDOW *, int, int, const cchar_t *, int);
885 int mvwvline_set(WINDOW *, int, int, const cchar_t *, int);
886 int vline_set(const cchar_t *, int);
887 int whline_set(WINDOW *, const cchar_t *, int);
888 int wvline_set(WINDOW *, const cchar_t *, int);
889 int bkgrnd(const cchar_t *);
890 void bkgrndset(const cchar_t *);
891 int getbkgrnd(cchar_t *);
892 int wbkgrnd(WINDOW *, const cchar_t *);
893 void wbkgrndset(WINDOW *, const cchar_t *);
894 int wgetbkgrnd(WINDOW *, cchar_t *);
895
896 /* Private functions that are needed for user programs prototypes. */
897 int __cputchar(int);
898 int __waddbytes(WINDOW *, const char *, int, attr_t);
899 #ifdef HAVE_WCHAR
900 int __cputwchar( wchar_t );
901 #endif /* HAVE_WCHAR */
902 __END_DECLS
903
904 #endif /* !_CURSES_H_ */
905