curses.h revision 1.133 1 /* $NetBSD: curses.h,v 1.133 2024/12/05 04:08:12 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 <stdbool.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 #if !defined(HAVE_WCHAR) && !defined(DISABLE_WCHAR)
58 #define HAVE_WCHAR 1
59 #endif
60
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.
66 */
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 chars 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 */
79
80 #ifndef TRUE
81 #define TRUE (/*CONSTCOND*/1)
82 #endif
83 #ifndef FALSE
84 #define FALSE (/*CONSTCOND*/0)
85 #endif
86
87 #ifndef _CURSES_PRIVATE
88
89 #define _puts(s) tputs(s, 0, __cputchar)
90 #define _putchar(c) __cputchar(c)
91
92 /* Old-style terminal modes access. */
93 #define crmode() cbreak()
94 #define nocrmode() nocbreak()
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 are 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 was pressed */
208
209 #include <unctrl.h>
210
211 /*
212 * A window is 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 #ifdef HAVE_WCHAR
234 #define __ACS_IS_WACS 0x04000000 /* internal: use wacs table for ACS char */
235 #endif
236
237 typedef struct __ldata __LDATA;
238 typedef struct __line __LINE;
239 typedef struct __window WINDOW;
240 typedef struct __screen SCREEN;
241
242 /*
243 * Attribute definitions
244 */
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
259
260 #ifdef HAVE_WCHAR
261 #define WA_ATTRIBUTES 0x03ffffff /* Wide character attributes mask */
262 #define WA_NORMAL __NORMAL
263 #define WA_STANDOUT __STANDOUT /* Best highlighting mode */
264 #define WA_UNDERLINE __UNDERSCORE /* Underlining */
265 #define WA_REVERSE __REVERSE /* Reverse video */
266 #define WA_BLINK __BLINK /* Blinking */
267 #define WA_DIM __DIM /* Half bright */
268 #define WA_BOLD __BOLD /* Extra bright or bold */
269 #define WA_INVIS __BLANK /* Invisible */
270 #define WA_PROTECT __PROTECT /* Protected */
271 #define WA_ALTCHARSET __ALTCHARSET /* Alternate character set */
272 #define WA_LOW 0x00000002 /* Low highlight */
273 #define WA_TOP 0x00000004 /* Top highlight */
274 #define WA_HORIZONTAL 0x00000008 /* Horizontal highlight */
275 #define WA_VERTICAL 0x00000010 /* Vertical highlight */
276 #define WA_LEFT 0x00000020 /* Left highlight */
277 #define WA_RIGHT 0x00000040 /* Right highlight */
278 #endif /* HAVE_WCHAR */
279
280 /*
281 * Alternate character set definitions
282 */
283
284 #define NUM_ACS 128
285
286 __BEGIN_DECLS
287 extern chtype _acs_char[NUM_ACS];
288 __END_DECLS
289 #ifdef __cplusplus
290 #define __UC_CAST(a) static_cast<unsigned char>(a)
291 #else
292 #define __UC_CAST(a) (unsigned char)(a)
293 #endif
294
295 /* Standard definitions */
296 #define ACS_RARROW _acs_char[__UC_CAST('+')]
297 #define ACS_LARROW _acs_char[__UC_CAST(',')]
298 #define ACS_UARROW _acs_char[__UC_CAST('-')]
299 #define ACS_DARROW _acs_char[__UC_CAST('.')]
300 #define ACS_BLOCK _acs_char[__UC_CAST('0')]
301 #define ACS_DIAMOND _acs_char[__UC_CAST('`')]
302 #define ACS_CKBOARD _acs_char[__UC_CAST('a')]
303 #define ACS_DEGREE _acs_char[__UC_CAST('f')]
304 #define ACS_PLMINUS _acs_char[__UC_CAST('g')]
305 #define ACS_BOARD _acs_char[__UC_CAST('h')]
306 #define ACS_LANTERN _acs_char[__UC_CAST('i')]
307 #define ACS_LRCORNER _acs_char[__UC_CAST('j')]
308 #define ACS_URCORNER _acs_char[__UC_CAST('k')]
309 #define ACS_ULCORNER _acs_char[__UC_CAST('l')]
310 #define ACS_LLCORNER _acs_char[__UC_CAST('m')]
311 #define ACS_PLUS _acs_char[__UC_CAST('n')]
312 #define ACS_HLINE _acs_char[__UC_CAST('q')]
313 #define ACS_S1 _acs_char[__UC_CAST('o')]
314 #define ACS_S9 _acs_char[__UC_CAST('s')]
315 #define ACS_LTEE _acs_char[__UC_CAST('t')]
316 #define ACS_RTEE _acs_char[__UC_CAST('u')]
317 #define ACS_BTEE _acs_char[__UC_CAST('v')]
318 #define ACS_TTEE _acs_char[__UC_CAST('w')]
319 #define ACS_VLINE _acs_char[__UC_CAST('x')]
320 #define ACS_BULLET _acs_char[__UC_CAST('~')]
321
322 /* Extensions */
323 #define ACS_S3 _acs_char[__UC_CAST('p')]
324 #define ACS_S7 _acs_char[__UC_CAST('r')]
325 #define ACS_LEQUAL _acs_char[__UC_CAST('y')]
326 #define ACS_GEQUAL _acs_char[__UC_CAST('z')]
327 #define ACS_PI _acs_char[__UC_CAST('{')]
328 #define ACS_NEQUAL _acs_char[__UC_CAST('|')]
329 #define ACS_STERLING _acs_char[__UC_CAST('}')]
330
331 #ifdef HAVE_WCHAR
332 __BEGIN_DECLS
333 extern cchar_t _wacs_char[NUM_ACS];
334 __END_DECLS
335
336 #define WACS_RARROW (&_wacs_char[(unsigned char)'+'])
337 #define WACS_LARROW (&_wacs_char[(unsigned char)','])
338 #define WACS_UARROW (&_wacs_char[(unsigned char)'-'])
339 #define WACS_DARROW (&_wacs_char[(unsigned char)'.'])
340 #define WACS_BLOCK (&_wacs_char[(unsigned char)'0'])
341 #define WACS_DIAMOND (&_wacs_char[(unsigned char)'`'])
342 #define WACS_CKBOARD (&_wacs_char[(unsigned char)'a'])
343 #define WACS_DEGREE (&_wacs_char[(unsigned char)'f'])
344 #define WACS_PLMINUS (&_wacs_char[(unsigned char)'g'])
345 #define WACS_BOARD (&_wacs_char[(unsigned char)'h'])
346 #define WACS_LANTERN (&_wacs_char[(unsigned char)'i'])
347 #define WACS_LRCORNER (&_wacs_char[(unsigned char)'j'])
348 #define WACS_URCORNER (&_wacs_char[(unsigned char)'k'])
349 #define WACS_ULCORNER (&_wacs_char[(unsigned char)'l'])
350 #define WACS_LLCORNER (&_wacs_char[(unsigned char)'m'])
351 #define WACS_PLUS (&_wacs_char[(unsigned char)'n'])
352 #define WACS_HLINE (&_wacs_char[(unsigned char)'q'])
353 #define WACS_S1 (&_wacs_char[(unsigned char)'o'])
354 #define WACS_S9 (&_wacs_char[(unsigned char)'s'])
355 #define WACS_LTEE (&_wacs_char[(unsigned char)'t'])
356 #define WACS_RTEE (&_wacs_char[(unsigned char)'u'])
357 #define WACS_BTEE (&_wacs_char[(unsigned char)'v'])
358 #define WACS_TTEE (&_wacs_char[(unsigned char)'w'])
359 #define WACS_VLINE (&_wacs_char[(unsigned char)'x'])
360 #define WACS_BULLET (&_wacs_char[(unsigned char)'~'])
361 #define WACS_S3 (&_wacs_char[(unsigned char)'p'])
362 #define WACS_S7 (&_wacs_char[(unsigned char)'r'])
363 #define WACS_LEQUAL (&_wacs_char[(unsigned char)'y'])
364 #define WACS_GEQUAL (&_wacs_char[(unsigned char)'z'])
365 #define WACS_PI (&_wacs_char[(unsigned char)'{'])
366 #define WACS_NEQUAL (&_wacs_char[(unsigned char)'|'])
367 #define WACS_STERLING (&_wacs_char[(unsigned char)'}'])
368 #endif /* HAVE_WCHAR */
369
370 /* System V compatibility */
371 #define ACS_SBBS ACS_LRCORNER
372 #define ACS_BBSS ACS_URCORNER
373 #define ACS_BSSB ACS_ULCORNER
374 #define ACS_SSBB ACS_LLCORNER
375 #define ACS_SSSS ACS_PLUS
376 #define ACS_BSBS ACS_HLINE
377 #define ACS_SSSB ACS_LTEE
378 #define ACS_SBSS ACS_RTEE
379 #define ACS_SSBS ACS_BTEE
380 #define ACS_BSSS ACS_TTEE
381 #define ACS_SBSB ACS_VLINE
382 #define _acs_map _acs_char
383
384 /*
385 * Color definitions (ANSI color numbers)
386 */
387
388 #define COLOR_BLACK 0x00
389 #define COLOR_RED 0x01
390 #define COLOR_GREEN 0x02
391 #define COLOR_YELLOW 0x03
392 #define COLOR_BLUE 0x04
393 #define COLOR_MAGENTA 0x05
394 #define COLOR_CYAN 0x06
395 #define COLOR_WHITE 0x07
396
397 #ifdef __cplusplus
398 #define __UINT32_CAST(a) static_cast<uint32_t>(a)
399 #else
400 #define __UINT32_CAST(a) (uint32_t)(a)
401 #endif
402 #define COLOR_PAIR(n) (((__UINT32_CAST(n)) << 17) & A_COLOR)
403 #define PAIR_NUMBER(n) (((__UINT32_CAST(n)) & A_COLOR) >> 17)
404
405 /* Curses external declarations. */
406 __BEGIN_DECLS
407 extern WINDOW *curscr; /* Current screen. */
408 extern WINDOW *stdscr; /* Standard screen. */
409
410 extern int __tcaction; /* If terminal hardware set. */
411
412 extern int COLS; /* Columns on the screen. */
413 extern int LINES; /* Lines on the screen. */
414 extern int COLORS; /* Max colors on the screen. */
415 extern int COLOR_PAIRS; /* Max color pairs on the screen. */
416
417 extern int ESCDELAY; /* Delay between keys in esc seq's. */
418 extern int TABSIZE; /* Size of a tab. */
419 __END_DECLS
420
421 #ifndef OK
422 #define ERR (-1) /* Error return. */
423 #define OK (0) /* Success return. */
424 #endif
425
426 /*
427 * The following have, traditionally, been macros but X/Open say they
428 * need to be functions. Keep the old macros for debugging.
429 */
430 #ifdef _CURSES_USE_MACROS
431 /* Standard screen pseudo functions. */
432 #define addbytes(s, n) __waddbytes(stdscr, s, n, 0)
433 #define addch(ch) waddch(stdscr, ch)
434 #define addchnstr(s, n) waddchnstr(stdscr, s, n)
435 #define addchstr(s) waddchnstr(stdscr, s, -1)
436 #define addnstr(s, n) waddnstr(stdscr, s, n)
437 #define addstr(s) waddnstr(stdscr, s, -1)
438 #define attr_get(a, p, o) wattr_get(stdscr, a, p, o)
439 #define attr_off(a, o) wattr_off(stdscr, a, o)
440 #define attr_on(a, o) wattr_on(stdscr, a, o)
441 #define attr_set(a, p, o) wattr_set(stdscr, a, p, o)
442 #define attroff(attr) wattroff(stdscr, attr)
443 #define attron(attr) wattron(stdscr, attr)
444 #define attrset(attr) wattrset(stdscr, attr)
445 #define bkgd(ch) wbkgd(stdscr, ch)
446 #define bkgdset(ch) wbkgdset(stdscr, ch)
447 #define border(l, r, t, b, tl, tr, bl, br) \
448 wborder(stdscr, l, r, t, b, tl, tr, bl, br)
449 #define clear() wclear(stdscr)
450 #define clrtobot() wclrtobot(stdscr)
451 #define clrtoeol() wclrtoeol(stdscr)
452 #define color_set(c, o) wcolor_set(stdscr, c, o)
453 #define delch() wdelch(stdscr)
454 #define deleteln() wdeleteln(stdscr)
455 #define echochar(c) wechochar(stdscr, c)
456 #define erase() werase(stdscr)
457 #define getch() wgetch(stdscr)
458 #define getnstr(s, n) wgetnstr(stdscr, s, n)
459 #define getstr(s) wgetstr(stdscr, s)
460 #define inch() winch(stdscr)
461 #define inchnstr(c) winchnstr(stdscr, c)
462 #define inchstr(c) winchstr(stdscr, c)
463 #define innstr(s, n) winnstr(stdscr, s, n)
464 #define insch(ch) winsch(stdscr, ch)
465 #define insdelln(n) winsdelln(stdscr, n)
466 #define insertln() winsertln(stdscr)
467 #define instr(s) winstr(stdscr, s)
468 #define move(y, x) wmove(stdscr, y, x)
469 #define refresh() wrefresh(stdscr)
470 #define scrl(n) wscrl(stdscr, n)
471 #define setscrreg(t, b) wsetscrreg(stdscr, t, b)
472 #define standend() wstandend(stdscr)
473 #define standout() wstandout(stdscr)
474 #define timeout(delay) wtimeout(stdscr, delay)
475 #define underscore() wunderscore(stdscr)
476 #define underend() wunderend(stdscr)
477 #define waddbytes(w, s, n) __waddbytes(w, s, n, 0)
478 #define waddstr(w, s) waddnstr(w, s, -1)
479
480 /* Standard screen plus movement pseudo functions. */
481 #define mvaddbytes(y, x, s, n) mvwaddbytes(stdscr, y, x, s, n)
482 #define mvaddch(y, x, ch) mvwaddch(stdscr, y, x, ch)
483 #define mvaddchnstr(y, x, s, n) mvwaddchnstr(stdscr, y, x, s, n)
484 #define mvaddchstr(y, x, s) mvwaddchstr(stdscr, y, x, s)
485 #define mvaddnstr(y, x, s, n) mvwaddnstr(stdscr, y, x, s, n)
486 #define mvaddstr(y, x, s) mvwaddstr(stdscr, y, x, s)
487 #define mvdelch(y, x) mvwdelch(stdscr, y, x)
488 #define mvgetch(y, x) mvwgetch(stdscr, y, x)
489 #define mvgetnstr(y, x, s, n) mvwgetnstr(stdscr, y, x, s, n)
490 #define mvgetstr(y, x, s) mvwgetstr(stdscr, y, x, s)
491 #define mvinch(y, x) mvwinch(stdscr, y, x)
492 #define mvinchnstr(y, x, c, n) mvwinchnstr(stdscr, y, x, c, n)
493 #define mvinchstr(y, x, c) mvwinchstr(stdscr, y, x, c)
494 #define mvinnstr(y, x, s, n) mvwinnstr(stdscr, y, x, s, n)
495 #define mvinsch(y, x, c) mvwinsch(stdscr, y, x, c)
496 #define mvinstr(y, x, s) mvwinstr(stdscr, y, x, s)
497 #define mvwaddbytes(w, y, x, s, n) \
498 (wmove(w, y, x) == ERR ? ERR : __waddbytes(w, s, n, 0))
499 #define mvwaddch(w, y, x, ch) \
500 (wmove(w, y, x) == ERR ? ERR : waddch(w, ch))
501 #define mvwaddchnstr(w, y, x, s, n) \
502 (wmove(w, y, x) == ERR ? ERR : waddchnstr(w, s, n))
503 #define mvwaddchstr(w, y, x, s) \
504 (wmove(w, y, x) == ERR ? ERR : waddchnstr(w, s, -1))
505 #define mvwaddnstr(w, y, x, s, n) \
506 (wmove(w, y, x) == ERR ? ERR : waddnstr(w, s, n))
507 #define mvwaddstr(w, y, x, s) \
508 (wmove(w, y, x) == ERR ? ERR : waddnstr(w, s, -1))
509 #define mvwdelch(w, y, x) \
510 (wmove(w, y, x) == ERR ? ERR : wdelch(w))
511 #define mvwgetch(w, y, x) \
512 (wmove(w, y, x) == ERR ? ERR : wgetch(w))
513 #define mvwgetnstr(w, y, x, s, n) \
514 (wmove(w, y, x) == ERR ? ERR : wgetnstr(w, s, n))
515 #define mvwgetstr(w, y, x, s) \
516 (wmove(w, y, x) == ERR ? ERR : wgetstr(w, s))
517 #define mvwinch(w, y, x) \
518 (wmove(w, y, x) == ERR ? ERR : winch(w))
519 #define mvwinchnstr(w, y, x, c, n) \
520 (wmove(w, y, x) == ERR ? ERR : winchnstr(w, c, n))
521 #define mvwinchstr(w, y, x, s) \
522 (wmove(w, y, x) == ERR ? ERR : winchstr(w, c))
523 #define mvwinnstr(w, y, x, s, n) \
524 (wmove(w, y, x) == ERR ? ERR : winnstr(w, s, n))
525 #define mvwinsch(w, y, x, c) \
526 (wmove(w, y, x) == ERR ? ERR : winsch(w, c))
527 #define mvwinstr(w, y, x, s) \
528 (wmove(w, y, x) == ERR ? ERR : winstr(w, s))
529
530 /* Miscellaneous. */
531 #define noqiflush() intrflush(stdscr, FALSE)
532 #define qiflush() intrflush(stdscr, TRUE)
533
534 #else
535 /* Use functions not macros... */
536 __BEGIN_DECLS
537 int addbytes(const char *, int);
538 int addch(chtype);
539 int addchnstr(const chtype *, int);
540 int addchstr(const chtype *);
541 int addnstr(const char *, int);
542 int addstr(const char *);
543 int attr_get(attr_t *, short *, void *);
544 int attr_off(attr_t, void *);
545 int attr_on(attr_t, void *);
546 int attr_set(attr_t, short, void *);
547 int attroff(int);
548 int attron(int);
549 int attrset(int);
550 int bkgd(chtype);
551 void bkgdset(chtype);
552 int border(chtype, chtype, chtype, chtype,
553 chtype, chtype, chtype, chtype);
554 int clear(void);
555 int clrtobot(void);
556 int clrtoeol(void);
557 int color_set(short, void *);
558 int delch(void);
559 int deleteln(void);
560 int echochar(const chtype);
561 int erase(void);
562 int getch(void);
563 int getnstr(char *, int);
564 int getscrreg(int *, int *);
565 int getstr(char *);
566 chtype inch(void);
567 int inchnstr(chtype *, int);
568 int inchstr(chtype *);
569 int innstr(char *, int);
570 int insch(chtype);
571 int insdelln(int);
572 int insertln(void);
573 int instr(char *);
574 int move(int, int);
575 int refresh(void);
576 int scrl(int);
577 int setscrreg(int, int);
578 int standend(void);
579 int standout(void);
580 void timeout(int);
581 int underscore(void);
582 int underend(void);
583 int waddbytes(WINDOW *, const char *, int);
584 int waddstr(WINDOW *, const char *);
585
586 /* Standard screen plus movement functions. */
587 int mvaddbytes(int, int, const char *, int);
588 int mvaddch(int, int, chtype);
589 int mvaddchnstr(int, int, const chtype *, int);
590 int mvaddchstr(int, int, const chtype *);
591 int mvaddnstr(int, int, const char *, int);
592 int mvaddstr(int, int, const char *);
593 int mvdelch(int, int);
594 int mvgetch(int, int);
595 int mvgetnstr(int, int, char *, int);
596 int mvgetstr(int, int, char *);
597 chtype mvinch(int, int);
598 int mvinchnstr(int, int, chtype *, int);
599 int mvinchstr(int, int, chtype *);
600 int mvinnstr(int, int, char *, int);
601 int mvinsch(int, int, chtype);
602 int mvinstr(int, int, char *);
603
604 int mvwaddbytes(WINDOW *, int, int, const char *, int);
605 int mvwaddch(WINDOW *, int, int, chtype);
606 int mvwaddchnstr(WINDOW *, int, int, const chtype *, int);
607 int mvwaddchstr(WINDOW *, int, int, const chtype *);
608 int mvwaddnstr(WINDOW *, int, int, const char *, int);
609 int mvwaddstr(WINDOW *, int, int, const char *);
610 int mvwdelch(WINDOW *, int, int);
611 int mvwgetch(WINDOW *, int, int);
612 int mvwgetnstr(WINDOW *, int, int, char *, int);
613 int mvwgetstr(WINDOW *, int, int, char *);
614 chtype mvwinch(WINDOW *, int, int);
615 int mvwinsch(WINDOW *, int, int, chtype);
616 __END_DECLS
617 #endif /* _CURSES_USE_MACROS */
618
619 #define getyx(w, y, x) (y) = getcury(w), (x) = getcurx(w)
620 #define getbegyx(w, y, x) (y) = getbegy(w), (x) = getbegx(w)
621 #define getmaxyx(w, y, x) (y) = getmaxy(w), (x) = getmaxx(w)
622 #define getparyx(w, y, x) (y) = getpary(w), (x) = getparx(w)
623
624 #define getsyx(y, x) \
625 do { \
626 if (is_leaveok(curscr)) \
627 (y) = (x) = -1; \
628 else \
629 getyx(curscr,(y), (x)); \
630 } while(0 /* CONSTCOND */)
631 #define setsyx(y, x) \
632 do { \
633 if ((y) == -1 && (x) == -1) \
634 leaveok(curscr, TRUE); \
635 else { \
636 leaveok(curscr, FALSE); \
637 wmove(curscr, (y), (x)); \
638 } \
639 } while(0 /* CONSTCOND */)
640
641
642 /* Public functions. */
643 __BEGIN_DECLS
644 int assume_default_colors(short, short);
645 int baudrate(void);
646 int beep(void);
647 int box(WINDOW *, chtype, chtype);
648 bool can_change_color(void);
649 int cbreak(void);
650 int clearok(WINDOW *, bool);
651 int color_content(short, short *, short *, short *);
652 int copywin(const WINDOW *, WINDOW *, int, int, int, int, int, int, int);
653 int curs_set(int);
654 int def_prog_mode(void);
655 int def_shell_mode(void);
656 int define_key(const char *, int);
657 int delay_output(int);
658 void delscreen(SCREEN *);
659 int delwin(WINDOW *);
660 WINDOW *derwin(WINDOW *, int, int, int, int);
661 WINDOW *dupwin(WINDOW *);
662 int doupdate(void);
663 int echo(void);
664 int endwin(void);
665 char erasechar(void);
666 void filter(void);
667 int flash(void);
668 int flushinp(void);
669 int flushok(WINDOW *, bool);
670 char *fullname(const char *, char *);
671 chtype getattrs(WINDOW *);
672 chtype getbkgd(WINDOW *);
673 int getcury(WINDOW *);
674 int getcurx(WINDOW *);
675 int getbegy(WINDOW *);
676 int getbegx(WINDOW *);
677 int getmaxy(WINDOW *);
678 int getmaxx(WINDOW *);
679 int getpary(WINDOW *);
680 int getparx(WINDOW *);
681 int gettmode(void);
682 WINDOW *getwin(FILE *);
683 int halfdelay(int);
684 bool has_colors(void);
685 bool has_ic(void);
686 bool has_il(void);
687 int has_key(int);
688 int hline(chtype, int);
689 int idcok(WINDOW *, bool);
690 int idlok(WINDOW *, bool);
691 int immedok(WINDOW *, bool);
692 int init_color(short, short, short, short);
693 int init_pair(short, short, short);
694 WINDOW *initscr(void);
695 int intrflush(WINDOW *, bool);
696 bool isendwin(void);
697 bool is_linetouched(WINDOW *, int);
698 bool is_wintouched(WINDOW *);
699 bool is_term_resized(int, int);
700 int keyok(int, bool);
701 int keypad(WINDOW *, bool);
702 char *keyname(int);
703 char killchar(void);
704 int leaveok(WINDOW *, bool);
705 int meta(WINDOW *, bool);
706 int mvcur(int, int, int, int);
707 int mvderwin(WINDOW *, int, int);
708 int mvhline(int, int, chtype, int);
709 int mvprintw(int, int, const char *, ...) __printflike(3, 4);
710 int mvscanw(int, int, const char *, ...) __scanflike(3, 4);
711 int mvvline(int, int, chtype, int);
712 int mvwhline(WINDOW *, int, int, chtype, int);
713 int mvwvline(WINDOW *, int, int, chtype, int);
714 int mvwin(WINDOW *, int, int);
715 int mvwinchnstr(WINDOW *, int, int, chtype *, int);
716 int mvwinchstr(WINDOW *, int, int, chtype *);
717 int mvwinnstr(WINDOW *, int, int, char *, int);
718 int mvwinstr(WINDOW *, int, int, char *);
719 int mvwprintw(WINDOW *, int, int, const char *, ...) __printflike(4, 5);
720 int mvwscanw(WINDOW *, int, int, const char *, ...) __scanflike(4, 5);
721 int napms(int);
722 WINDOW *newpad(int, int);
723 SCREEN *newterm(const char *, FILE *, FILE *);
724 WINDOW *newwin(int, int, int, int);
725 int nl(void);
726 attr_t no_color_attributes(void);
727 int nocbreak(void);
728 int nodelay(WINDOW *, bool);
729 int noecho(void);
730 int nonl(void);
731 void noqiflush(void);
732 int noraw(void);
733 int notimeout(WINDOW *, bool);
734 int overlay(const WINDOW *, WINDOW *);
735 int overwrite(const WINDOW *, WINDOW *);
736 int pair_content(short, short *, short *);
737 int pechochar(WINDOW *, const chtype);
738 int pnoutrefresh(WINDOW *, int, int, int, int, int, int);
739 int prefresh(WINDOW *, int, int, int, int, int, int);
740 int printw(const char *, ...) __printflike(1, 2);
741 int putwin(WINDOW *, FILE *);
742 void qiflush(void);
743 int raw(void);
744 int redrawwin(WINDOW *);
745 int reset_prog_mode(void);
746 int reset_shell_mode(void);
747 int resetty(void);
748 int resizeterm(int, int);
749 int resize_term(int, int);
750 int ripoffline(int, int (*)(WINDOW *, int));
751 int savetty(void);
752 int scanw(const char *, ...) __scanflike(1, 2);
753 int scroll(WINDOW *);
754 int scrollok(WINDOW *, bool);
755 int setterm(const char *);
756 int set_escdelay(int);
757 int set_tabsize(int);
758 SCREEN *set_term(SCREEN *);
759 int start_color(void);
760 WINDOW *subpad(WINDOW *, int, int, int, int);
761 WINDOW *subwin(WINDOW *, int, int, int, int);
762 int syncok(WINDOW *, bool);
763 chtype termattrs(void);
764 attr_t term_attrs(void);
765 int touchline(WINDOW *, int, int);
766 int touchoverlap(WINDOW *, WINDOW *);
767 int touchwin(WINDOW *);
768 int typeahead(int);
769 int ungetch(int);
770 int untouchwin(WINDOW *);
771 int use_default_colors(void);
772 void use_env(bool);
773 int vline(chtype, int);
774 int vw_printw(WINDOW *, const char *, __va_list) __printflike(2, 0);
775 int vw_scanw(WINDOW *, const char *, __va_list) __scanflike(2, 0);
776 int vwprintw(WINDOW *, const char *, __va_list) __printflike(2, 0);
777 int vwscanw(WINDOW *, const char *, __va_list) __scanflike(2, 0);
778 int waddch(WINDOW *, chtype);
779 int waddchnstr(WINDOW *, const chtype *, int);
780 int waddchstr(WINDOW *, const chtype *);
781 int waddnstr(WINDOW *, const char *, int);
782 int wattr_get(WINDOW *, attr_t *, short *, void *);
783 int wattr_off(WINDOW *, attr_t, void *);
784 int wattr_on(WINDOW *, attr_t, void *);
785 int wattr_set(WINDOW *, attr_t, short, void *);
786 int wattroff(WINDOW *, int);
787 int wattron(WINDOW *, int);
788 int wattrset(WINDOW *, int);
789 int wbkgd(WINDOW *, chtype);
790 void wbkgdset(WINDOW *, chtype);
791 int wborder(WINDOW *, chtype, chtype, chtype, chtype, chtype, chtype,
792 chtype, chtype);
793 int wclear(WINDOW *);
794 int wclrtobot(WINDOW *);
795 int wclrtoeol(WINDOW *);
796 int wcolor_set(WINDOW *, short, void *);
797 void wcursyncup(WINDOW *);
798 int wdelch(WINDOW *);
799 int wdeleteln(WINDOW *);
800 int wechochar(WINDOW *, const chtype);
801 int werase(WINDOW *);
802 int wgetch(WINDOW *);
803 int wgetnstr(WINDOW *, char *, int);
804 int wgetscrreg(WINDOW *, int *, int *);
805 int wgetstr(WINDOW *, char *);
806 int whline(WINDOW *, chtype, int);
807 chtype winch(WINDOW *);
808 int winchnstr(WINDOW *, chtype *, int);
809 int winchstr(WINDOW *, chtype *);
810 int winnstr(WINDOW *, char *, int);
811 int winsch(WINDOW *, chtype);
812 int winsdelln(WINDOW *, int);
813 int winsertln(WINDOW *);
814 int winstr(WINDOW *, char *);
815 int wmove(WINDOW *, int, int);
816 int wnoutrefresh(WINDOW *);
817 int wprintw(WINDOW *, const char *, ...) __printflike(2, 3);
818 int wredrawln(WINDOW *, int, int);
819 int wrefresh(WINDOW *);
820 int wresize(WINDOW *, int, int);
821 int wscanw(WINDOW *, const char *, ...) __scanflike(2, 3);
822 int wscrl(WINDOW *, int);
823 int wsetscrreg(WINDOW *, int, int);
824 int wstandend(WINDOW *);
825 int wstandout(WINDOW *);
826 void wsyncdown(WINDOW *);
827 void wsyncup(WINDOW *);
828 void wtimeout(WINDOW *, int);
829 int wtouchln(WINDOW *, int, int, int);
830 int wunderend(WINDOW *);
831 int wunderscore(WINDOW *);
832 int wvline(WINDOW *, chtype, int);
833
834 int insnstr(const char *, int);
835 int insstr(const char *);
836 int mvinsnstr(int, int, const char *, int);
837 int mvinsstr(int, int, const char *);
838 int mvwinsnstr(WINDOW *, int, int, const char *, int);
839 int mvwinsstr(WINDOW *, int, int, const char *);
840 int winsnstr(WINDOW *, const char *, int);
841 int winsstr(WINDOW *, const char *);
842
843 int chgat(int, attr_t, short, const void *);
844 int wchgat(WINDOW *, int, attr_t, short, const void *);
845 int mvchgat(int, int, int, attr_t, short, const void *);
846 int mvwchgat(WINDOW *, int, int, int, attr_t, short, const void *);
847
848 /* Soft Label Keys. */
849 int slk_attroff(const chtype);
850 int slk_attr_off(const attr_t, void *);
851 int slk_attron(const chtype);
852 int slk_attr_on(const attr_t, void *);
853 int slk_attrset(const chtype);
854 int slk_attr_set(const attr_t, short, void *);
855 int slk_clear(void);
856 int slk_color(short);
857 int slk_init(int);
858 char *slk_label(int);
859 int slk_noutrefresh(void);
860 int slk_refresh(void);
861 int slk_restore(void);
862 int slk_set(int, const char *, int);
863 int slk_touch(void);
864 int slk_wset(int, const wchar_t *, int);
865
866 /* wide-character support routines */
867 /* return ERR when HAVE_WCHAR is not defined */
868 /* add */
869 int add_wch(const cchar_t *);
870 int wadd_wch(WINDOW *, const cchar_t *);
871 int mvadd_wch(int, int, const cchar_t *);
872 int mvwadd_wch(WINDOW *, int, int, const cchar_t *);
873
874 int add_wchnstr(const cchar_t *, int);
875 int add_wchstr(const cchar_t *);
876 int wadd_wchnstr(WINDOW *, const cchar_t *, int);
877 int wadd_wchstr(WINDOW *, const cchar_t *);
878 int mvadd_wchnstr(int, int, const cchar_t *, int);
879 int mvadd_wchstr(int, int, const cchar_t *);
880 int mvwadd_wchnstr(WINDOW *, int, int, const cchar_t *, int);
881 int mvwadd_wchstr(WINDOW *, int, int, const cchar_t *);
882
883 int addnwstr(const wchar_t *, int);
884 int addwstr(const wchar_t *);
885 int mvaddnwstr(int, int x, const wchar_t *, int);
886 int mvaddwstr(int, int x, const wchar_t *);
887 int mvwaddnwstr(WINDOW *, int, int, const wchar_t *, int);
888 int mvwaddwstr(WINDOW *, int, int, const wchar_t *);
889 int waddnwstr(WINDOW *, const wchar_t *, int);
890 int waddwstr(WINDOW *, const wchar_t *);
891
892 int echo_wchar(const cchar_t *);
893 int wecho_wchar(WINDOW *, const cchar_t *);
894 int pecho_wchar(WINDOW *, const cchar_t *);
895
896 /* insert */
897 int ins_wch(const cchar_t *);
898 int wins_wch(WINDOW *, const cchar_t *);
899 int mvins_wch(int, int, const cchar_t *);
900 int mvwins_wch(WINDOW *, int, int, const cchar_t *);
901
902 int ins_nwstr(const wchar_t *, int);
903 int ins_wstr(const wchar_t *);
904 int mvins_nwstr(int, int, const wchar_t *, int);
905 int mvins_wstr(int, int, const wchar_t *);
906 int mvwins_nwstr(WINDOW *, int, int, const wchar_t *, int);
907 int mvwins_wstr(WINDOW *, int, int, const wchar_t *);
908 int wins_nwstr(WINDOW *, const wchar_t *, int);
909 int wins_wstr(WINDOW *, const wchar_t *);
910
911 /* input */
912 int get_wch(wint_t *);
913 int unget_wch(const wchar_t);
914 int mvget_wch(int, int, wint_t *);
915 int mvwget_wch(WINDOW *, int, int, wint_t *);
916 int wget_wch(WINDOW *, wint_t *);
917
918 int getn_wstr(wchar_t *, int);
919 int get_wstr(wchar_t *);
920 int mvgetn_wstr(int, int, wchar_t *, int);
921 int mvget_wstr(int, int, wchar_t *);
922 int mvwgetn_wstr(WINDOW *, int, int, wchar_t *, int);
923 int mvwget_wstr(WINDOW *, int, int, wchar_t *);
924 int wgetn_wstr(WINDOW *, wchar_t *, int);
925 int wget_wstr(WINDOW *, wchar_t *);
926
927 int in_wch(cchar_t *);
928 int mvin_wch(int, int, cchar_t *);
929 int mvwin_wch(WINDOW *, int, int, cchar_t *);
930 int win_wch(WINDOW *, cchar_t *);
931
932 int in_wchnstr(cchar_t *, int);
933 int in_wchstr(cchar_t *);
934 int mvin_wchnstr(int, int, cchar_t *, int);
935 int mvin_wchstr(int, int, cchar_t *);
936 int mvwin_wchnstr(WINDOW *, int, int, cchar_t *, int);
937 int mvwin_wchstr(WINDOW *, int, int, cchar_t *);
938 int win_wchnstr(WINDOW *, cchar_t *, int);
939 int win_wchstr(WINDOW *, cchar_t *);
940
941 int innwstr(wchar_t *, int);
942 int inwstr(wchar_t *);
943 int mvinnwstr(int, int, wchar_t *, int);
944 int mvinwstr(int, int, wchar_t *);
945 int mvwinnwstr(WINDOW *, int, int, wchar_t *, int);
946 int mvwinwstr(WINDOW *, int, int, wchar_t *);
947 int winnwstr(WINDOW *, wchar_t *, int);
948 int winwstr(WINDOW *, wchar_t *);
949
950 /* cchar handling */
951 int setcchar(cchar_t *, const wchar_t *, const attr_t, short, const void *);
952 int getcchar(const cchar_t *, wchar_t *, attr_t *, short *, void *);
953
954 /* misc */
955 char *key_name( wchar_t );
956 int border_set(const cchar_t *, const cchar_t *, const cchar_t *,
957 const cchar_t *, const cchar_t *, const cchar_t *,
958 const cchar_t *, const cchar_t *);
959 int wborder_set(WINDOW *, const cchar_t *, const cchar_t *,
960 const cchar_t *, const cchar_t *, const cchar_t *,
961 const cchar_t *, const cchar_t *, const cchar_t *);
962 int box_set(WINDOW *, const cchar_t *, const cchar_t *);
963 int erasewchar(wchar_t *);
964 int killwchar(wchar_t *);
965 int hline_set(const cchar_t *, int);
966 int mvhline_set(int, int, const cchar_t *, int);
967 int mvvline_set(int, int, const cchar_t *, int);
968 int mvwhline_set(WINDOW *, int, int, const cchar_t *, int);
969 int mvwvline_set(WINDOW *, int, int, const cchar_t *, int);
970 int vline_set(const cchar_t *, int);
971 int whline_set(WINDOW *, const cchar_t *, int);
972 int wvline_set(WINDOW *, const cchar_t *, int);
973 int bkgrnd(const cchar_t *);
974 void bkgrndset(const cchar_t *);
975 int getbkgrnd(cchar_t *);
976 int wbkgrnd(WINDOW *, const cchar_t *);
977 void wbkgrndset(WINDOW *, const cchar_t *);
978 int wgetbkgrnd(WINDOW *, cchar_t *);
979
980 /* ncurses window tests */
981 bool is_keypad(const WINDOW *);
982 bool is_leaveok(const WINDOW *);
983 bool is_pad(const WINDOW *);
984
985 /* ncurses mouse support */
986 #define NB_MOUSE_MASK(b, m) ((m) << (((b) - 1) * 5))
987 #define NB_BUTTON_RELEASED 001L
988 #define NB_BUTTON_PRESSED 002L
989 #define NB_BUTTON_CLICKED 004L
990 #define NB_DOUBLE_CLICKED 010L
991 #define NB_TRIPLE_CLICKED 020L
992 #define NB_RESERVED_EVENT 040L
993
994 #define BUTTON1_RELEASED NB_MOUSE_MASK(1, NB_BUTTON_RELEASED)
995 #define BUTTON1_PRESSED NB_MOUSE_MASK(1, NB_BUTTON_PRESSED)
996 #define BUTTON1_CLICKED NB_MOUSE_MASK(1, NB_BUTTON_CLICKED)
997 #define BUTTON1_DOUBLE_CLICKED NB_MOUSE_MASK(1, NB_DOUBLE_CLICKED)
998 #define BUTTON1_TRIPLE_CLICKED NB_MOUSE_MASK(1, NB_TRIPLE_CLICKED)
999
1000 #define BUTTON2_RELEASED NB_MOUSE_MASK(2, NB_BUTTON_RELEASED)
1001 #define BUTTON2_PRESSED NB_MOUSE_MASK(2, NB_BUTTON_PRESSED)
1002 #define BUTTON2_CLICKED NB_MOUSE_MASK(2, NB_BUTTON_CLICKED)
1003 #define BUTTON2_DOUBLE_CLICKED NB_MOUSE_MASK(2, NB_DOUBLE_CLICKED)
1004 #define BUTTON2_TRIPLE_CLICKED NB_MOUSE_MASK(2, NB_TRIPLE_CLICKED)
1005
1006 #define BUTTON3_RELEASED NB_MOUSE_MASK(3, NB_BUTTON_RELEASED)
1007 #define BUTTON3_PRESSED NB_MOUSE_MASK(3, NB_BUTTON_PRESSED)
1008 #define BUTTON3_CLICKED NB_MOUSE_MASK(3, NB_BUTTON_CLICKED)
1009 #define BUTTON3_DOUBLE_CLICKED NB_MOUSE_MASK(3, NB_DOUBLE_CLICKED)
1010 #define BUTTON3_TRIPLE_CLICKED NB_MOUSE_MASK(3, NB_TRIPLE_CLICKED)
1011
1012 #define BUTTON4_RELEASED NB_MOUSE_MASK(4, NB_BUTTON_RELEASED)
1013 #define BUTTON4_PRESSED NB_MOUSE_MASK(4, NB_BUTTON_PRESSED)
1014 #define BUTTON4_CLICKED NB_MOUSE_MASK(4, NB_BUTTON_CLICKED)
1015 #define BUTTON4_DOUBLE_CLICKED NB_MOUSE_MASK(4, NB_DOUBLE_CLICKED)
1016 #define BUTTON4_TRIPLE_CLICKED NB_MOUSE_MASK(4, NB_TRIPLE_CLICKED)
1017
1018 #define BUTTON5_RELEASED NB_MOUSE_MASK(5, NB_BUTTON_RELEASED)
1019 #define BUTTON5_PRESSED NB_MOUSE_MASK(5, NB_BUTTON_PRESSED)
1020 #define BUTTON5_CLICKED NB_MOUSE_MASK(5, NB_BUTTON_CLICKED)
1021 #define BUTTON5_DOUBLE_CLICKED NB_MOUSE_MASK(5, NB_DOUBLE_CLICKED)
1022 #define BUTTON5_TRIPLE_CLICKED NB_MOUSE_MASK(5, NB_TRIPLE_CLICKED)
1023
1024 #define BUTTON_CTRL NB_MOUSE_MASK(6, 0001L)
1025 #define BUTTON_SHIFT NB_MOUSE_MASK(6, 0002L)
1026 #define BUTTON_ALT NB_MOUSE_MASK(6, 0004L)
1027 #define REPORT_MOUSE_POSITION NB_MOUSE_MASK(6, 0010L)
1028 #define ALL_MOUSE_EVENTS (REPORT_MOUSE_POSITION - 1)
1029
1030 #define BUTTON_RELEASE(e, x) ((e) & NB_MOUSE_MASK(x, 001))
1031 #define BUTTON_PRESS(e, x) ((e) & NB_MOUSE_MASK(x, 002))
1032 #define BUTTON_CLICK(e, x) ((e) & NB_MOUSE_MASK(x, 004))
1033 #define BUTTON_DOUBLE_CLICK(e, x) ((e) & NB_MOUSE_MASK(x, 010))
1034 #define BUTTON_TRIPLE_CLICK(e, x) ((e) & NB_MOUSE_MASK(x, 020))
1035 #define BUTTON_RESERVED_EVENT(e, x) ((e) & NB_MOUSE_MASK(x, 040))
1036
1037 typedef unsigned long mmask_t;
1038 typedef struct {
1039 short id; /* ID to distinguish multiple devices */
1040 int x, y, z; /* event coordinates */
1041 mmask_t bstate; /* button state bits */
1042 } MEVENT;
1043
1044 bool has_mouse(void);
1045 int getmouse(MEVENT *);
1046 int ungetmouse(MEVENT *);
1047 mmask_t mousemask(mmask_t, mmask_t *);
1048 bool wenclose(const WINDOW *, int, int);
1049 bool mouse_trafo(int *, int *, bool);
1050 bool wmouse_trafo(const WINDOW *, int *, int *, bool);
1051 int mouseinterval(int);
1052
1053 /* ncurses version for compat */
1054 const char *curses_version(void);
1055
1056 /* Private functions that are needed for user programs prototypes. */
1057 int __cputchar(int);
1058 int __waddbytes(WINDOW *, const char *, int, attr_t);
1059 #ifdef HAVE_WCHAR
1060 int __cputwchar(wchar_t);
1061 #endif /* HAVE_WCHAR */
1062 __END_DECLS
1063
1064 #endif /* !_CURSES_H_ */
1065