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