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