curses.h revision 1.10
1 /* 2 * Copyright (c) 1981, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. All advertising materials mentioning features or use of this software 14 * must display the following acknowledgement: 15 * This product includes software developed by the University of 16 * California, Berkeley and its contributors. 17 * 4. Neither the name of the University nor the names of its contributors 18 * may be used to endorse or promote products derived from this software 19 * without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * from: @(#)curses.h 8.2 (Berkeley) 11/29/93 34 * $Id: curses.h,v 1.10 1993/12/04 23:03:46 cgd Exp $ 35 */ 36 37 #ifndef _CURSES_H_ 38 #define _CURSES_H_ 39 40 #include <sys/types.h> 41 #include <sys/cdefs.h> 42 43 #include <stdio.h> 44 #ifdef notdef 45 #include <compat.h> 46 #endif /* notdef */ 47 48 /* 49 * The following #defines and #includes are present for backward 50 * compatibility only. They should not be used in future code. 51 * 52 * START BACKWARD COMPATIBILITY ONLY. 53 */ 54 #ifndef _CURSES_PRIVATE 55 #define bool char 56 #define reg register 57 58 #ifndef TRUE 59 #define TRUE (1) 60 #endif 61 #ifndef FALSE 62 #define FALSE (0) 63 #endif 64 65 #define _puts(s) tputs(s, 0, __cputchar) 66 #define _putchar(c) __cputchar(c) 67 68 /* Old-style terminal modes access. */ 69 #define baudrate() (cfgetospeed(&__baset)) 70 #define crmode() cbreak() 71 #define erasechar() (__baset.c_cc[VERASE]) 72 #define killchar() (__baset.c_cc[VKILL]) 73 #define nocrmode() nocbreak() 74 #define ospeed (cfgetospeed(&__baset)) 75 #endif /* _CURSES_PRIVATE */ 76 77 extern char GT; /* Gtty indicates tabs. */ 78 extern char NONL; /* Term can't hack LF doing a CR. */ 79 extern char UPPERCASE; /* Terminal is uppercase only. */ 80 81 extern int My_term; /* Use Def_term regardless. */ 82 extern char *Def_term; /* Default terminal type. */ 83 84 /* Termcap capabilities. */ 85 extern char AM, BS, CA, DA, EO, HC, IN, MI, MS, NC, NS, OS, 86 PC, UL, XB, XN, XT, XS, XX; 87 extern char *AL, *BC, *BT, *CD, *CE, *CL, *CM, *CR, *CS, *DC, *DL, 88 *DM, *DO, *ED, *EI, *K0, *K1, *K2, *K3, *K4, *K5, *K6, 89 *K7, *K8, *K9, *HO, *IC, *IM, *IP, *KD, *KE, *KH, *KL, 90 *KR, *KS, *KU, *LL, *MA, *ND, *NL, *RC, *SC, *SE, *SF, 91 *SO, *SR, *TA, *TE, *TI, *UC, *UE, *UP, *US, *VB, *VS, 92 *VE, *al, *dl, *sf, *sr, 93 *AL_PARM, *DL_PARM, *UP_PARM, *DOWN_PARM, *LEFT_PARM, 94 *RIGHT_PARM; 95 96 /* END BACKWARD COMPATIBILITY ONLY. */ 97 98 /* 8-bit ASCII characters. */ 99 #define unctrl(c) __unctrl[(c) & 0xff] 100 #define unctrllen(ch) __unctrllen[(ch) & 0xff] 101 102 extern char *__unctrl[256]; /* Control strings. */ 103 extern char __unctrllen[256]; /* Control strings length. */ 104 105 /* 106 * A window an array of __LINE structures pointed to by the 'lines' pointer. 107 * A line is an array of __LDATA structures pointed to by the 'line' pointer. 108 * 109 * IMPORTANT: the __LDATA structure must NOT induce any padding, so if new 110 * fields are added -- padding fields with *constant values* should ensure 111 * that the compiler will not generate any padding when storing an array of 112 * __LDATA structures. This is to enable consistent use of memcmp, and memcpy 113 * for comparing and copying arrays. 114 */ 115 typedef struct { 116 char ch; /* the actual character */ 117 118 #define __STANDOUT 0x01 /* Added characters are standout. */ 119 char attr; /* attributes of character */ 120 } __LDATA; 121 122 #define __LDATASIZE (sizeof(__LDATA)) 123 124 typedef struct { 125 #define __ISDIRTY 0x01 /* Line is dirty. */ 126 #define __ISPASTEOL 0x02 /* Cursor is past end of line */ 127 #define __FORCEPAINT 0x04 /* Force a repaint of the line */ 128 u_int flags; 129 u_int hash; /* Hash value for the line. */ 130 size_t *firstchp, *lastchp; /* First and last chngd columns ptrs */ 131 size_t firstch, lastch; /* First and last changed columns. */ 132 __LDATA *line; /* Pointer to the line text. */ 133 } __LINE; 134 135 typedef struct __window { /* Window structure. */ 136 struct __window *nextp, *orig; /* Subwindows list and parent. */ 137 size_t begy, begx; /* Window home. */ 138 size_t cury, curx; /* Current x, y coordinates. */ 139 size_t maxy, maxx; /* Maximum values for curx, cury. */ 140 short ch_off; /* x offset for firstch/lastch. */ 141 __LINE **lines; /* Array of pointers to the lines */ 142 __LINE *lspace; /* line space (for cleanup) */ 143 __LDATA *wspace; /* window space (for cleanup) */ 144 145 #define __ENDLINE 0x001 /* End of screen. */ 146 #define __FLUSH 0x002 /* Fflush(stdout) after refresh. */ 147 #define __FULLLINE 0x004 /* Line width = terminal width. */ 148 #define __FULLWIN 0x008 /* Window is a screen. */ 149 #define __IDLINE 0x010 /* Insert/delete sequences. */ 150 #define __SCROLLWIN 0x020 /* Last char will scroll window. */ 151 #define __SCROLLOK 0x040 /* Scrolling ok. */ 152 #define __CLEAROK 0x080 /* Clear on next refresh. */ 153 #define __WSTANDOUT 0x100 /* Standout window */ 154 #define __LEAVEOK 0x200 /* If curser left */ 155 u_int flags; 156 } WINDOW; 157 158 /* Curses external declarations. */ 159 extern WINDOW *curscr; /* Current screen. */ 160 extern WINDOW *stdscr; /* Standard screen. */ 161 162 extern struct termios __orig_termios; /* Terminal state before curses */ 163 extern struct termios __baset; /* Our base terminal state */ 164 extern int __tcaction; /* If terminal hardware set. */ 165 166 extern int COLS; /* Columns on the screen. */ 167 extern int LINES; /* Lines on the screen. */ 168 169 extern char *ttytype; /* Full name of current terminal. */ 170 171 #define ERR (0) /* Error return. */ 172 #define OK (1) /* Success return. */ 173 174 /* Standard screen pseudo functions. */ 175 #define addbytes(s, n) __waddbytes(stdscr, s, n, 0) 176 #define addch(ch) waddch(stdscr, ch) 177 #define addnstr(s, n) waddnstr(stdscr, s, n) 178 #define addstr(s) __waddbytes(stdscr, s, strlen(s), 0) 179 #define clear() wclear(stdscr) 180 #define clrtobot() wclrtobot(stdscr) 181 #define clrtoeol() wclrtoeol(stdscr) 182 #define delch() wdelch(stdscr) 183 #define deleteln() wdeleteln(stdscr) 184 #define erase() werase(stdscr) 185 #define getch() wgetch(stdscr) 186 #define getstr(s) wgetstr(stdscr, s) 187 #define inch() winch(stdscr) 188 #define insch(ch) winsch(stdscr, ch) 189 #define insertln() winsertln(stdscr) 190 #define move(y, x) wmove(stdscr, y, x) 191 #define refresh() wrefresh(stdscr) 192 #define standend() wstandend(stdscr) 193 #define standout() wstandout(stdscr) 194 #define waddbytes(w, s, n) __waddbytes(w, s, n, 0) 195 #define waddstr(w, s) __waddbytes(w, s, strlen(s), 0) 196 197 /* Standard screen plus movement pseudo functions. */ 198 #define mvaddbytes(y, x, s, n) mvwaddbytes(stdscr, y, x, s, n) 199 #define mvaddch(y, x, ch) mvwaddch(stdscr, y, x, ch) 200 #define mvaddnstr(y, x, s, n) mvwaddnstr(stdscr, y, x, s, n) 201 #define mvaddstr(y, x, s) mvwaddstr(stdscr, y, x, s) 202 #define mvdelch(y, x) mvwdelch(stdscr, y, x) 203 #define mvgetch(y, x) mvwgetch(stdscr, y, x) 204 #define mvgetstr(y, x, s) mvwgetstr(stdscr, y, x, s) 205 #define mvinch(y, x) mvwinch(stdscr, y, x) 206 #define mvinsch(y, x, c) mvwinsch(stdscr, y, x, c) 207 #define mvwaddbytes(w, y, x, s, n) \ 208 (wmove(w, y, x) == ERR ? ERR : __waddbytes(w, s, n, 0)) 209 #define mvwaddch(w, y, x, ch) \ 210 (wmove(w, y, x) == ERR ? ERR : waddch(w, ch)) 211 #define mvwaddnstr(w, y, x, s, n) \ 212 (wmove(w, y, x) == ERR ? ERR : waddnstr(w, s, n)) 213 #define mvwaddstr(w, y, x, s) \ 214 (wmove(w, y, x) == ERR ? ERR : __waddbytes(w, s, strlen(s), 0)) 215 #define mvwdelch(w, y, x) \ 216 (wmove(w, y, x) == ERR ? ERR : wdelch(w)) 217 #define mvwgetch(w, y, x) \ 218 (wmove(w, y, x) == ERR ? ERR : wgetch(w)) 219 #define mvwgetstr(w, y, x, s) \ 220 (wmove(w, y, x) == ERR ? ERR : wgetstr(w, s)) 221 #define mvwinch(w, y, x) \ 222 (wmove(w, y, x) == ERR ? ERR : winch(w)) 223 #define mvwinsch(w, y, x, c) \ 224 (wmove(w, y, x) == ERR ? ERR : winsch(w, c)) 225 226 /* Psuedo functions. */ 227 #define clearok(w, bf) \ 228 ((bf) ? ((w)->flags |= __CLEAROK) : ((w)->flags &= ~__CLEAROK)) 229 #define flushok(w, bf) \ 230 ((bf) ? ((w)->flags |= __FLUSH) : ((w)->flags &= ~__FLUSH)) 231 #define getyx(w, y, x) \ 232 (y) = (w)->cury, (x) = (w)->curx 233 #define leaveok(w, bf) \ 234 ((bf) ? ((w)->flags |= __LEAVEOK) : ((w)->flags &= ~__LEAVEOK)) 235 #define scrollok(w, bf) \ 236 ((bf) ? ((w)->flags |= __SCROLLOK) : ((w)->flags &= ~__SCROLLOK)) 237 #define winch(w) \ 238 ((w)->lines[(w)->cury]->line[(w)->curx].ch & 0177) 239 240 /* Public function prototypes. */ 241 int box __P((WINDOW *, int, int)); 242 int cbreak __P((void)); 243 int delwin __P((WINDOW *)); 244 int echo __P((void)); 245 int endwin __P((void)); 246 char *fullname __P((char *, char *)); 247 char *getcap __P((char *)); 248 int gettmode __P((void)); 249 void idlok __P((WINDOW *, int)); 250 WINDOW *initscr __P((void)); 251 char *longname __P((char *, char *)); 252 int mvcur __P((int, int, int, int)); 253 int mvprintw __P((int, int, const char *, ...)); 254 int mvscanw __P((int, int, const char *, ...)); 255 int mvwin __P((WINDOW *, int, int)); 256 int mvwprintw __P((WINDOW *, int, int, const char *, ...)); 257 int mvwscanw __P((WINDOW *, int, int, const char *, ...)); 258 WINDOW *newwin __P((int, int, int, int)); 259 int nl __P((void)); 260 int nocbreak __P((void)); 261 int noecho __P((void)); 262 int nonl __P((void)); 263 int noraw __P((void)); 264 int overlay __P((WINDOW *, WINDOW *)); 265 int overwrite __P((WINDOW *, WINDOW *)); 266 int printw __P((const char *, ...)); 267 int raw __P((void)); 268 int resetty __P((void)); 269 int savetty __P((void)); 270 int scanw __P((const char *, ...)); 271 int scroll __P((WINDOW *)); 272 int setterm __P((char *)); 273 int sscans __P((WINDOW *, const char *, ...)); 274 WINDOW *subwin __P((WINDOW *, int, int, int, int)); 275 int suspendwin __P((void)); 276 int touchline __P((WINDOW *, int, int, int)); 277 int touchoverlap __P((WINDOW *, WINDOW *)); 278 int touchwin __P((WINDOW *)); 279 int vwprintw __P((WINDOW *, const char *, _VA_LIST_)); 280 int vwscanw __P((WINDOW *, const char *, _VA_LIST_)); 281 int waddch __P((WINDOW *, int)); 282 int waddnstr __P((WINDOW *, const char *, int)); 283 int wclear __P((WINDOW *)); 284 int wclrtobot __P((WINDOW *)); 285 int wclrtoeol __P((WINDOW *)); 286 int wdelch __P((WINDOW *)); 287 int wdeleteln __P((WINDOW *)); 288 int werase __P((WINDOW *)); 289 int wgetch __P((WINDOW *)); 290 int wgetstr __P((WINDOW *, char *)); 291 int winsch __P((WINDOW *, int)); 292 int winsertln __P((WINDOW *)); 293 int wmove __P((WINDOW *, int, int)); 294 int wprintw __P((WINDOW *, const char *, ...)); 295 int wrefresh __P((WINDOW *)); 296 int wscanw __P((WINDOW *, const char *, ...)); 297 char *wstandend __P((WINDOW *)); 298 char *wstandout __P((WINDOW *)); 299 int vwprintw __P((WINDOW *, const char *, _VA_LIST_)); 300 301 /* Private functions that are needed for user programs prototypes. */ 302 void __cputchar __P((int)); 303 int __waddbytes __P((WINDOW *, const char *, int, int)); 304 305 /* Private functions. */ 306 #ifdef _CURSES_PRIVATE 307 void __CTRACE __P((const char *, ...)); 308 u_int __hash __P((char *, int)); 309 void __id_subwins __P((WINDOW *)); 310 int __mvcur __P((int, int, int, int, int)); 311 void __restore_stophandler __P((void)); 312 void __set_stophandler __P((void)); 313 void __set_subwin __P((WINDOW *, WINDOW *)); 314 void __startwin __P((void)); 315 void __stop_signal_handler __P((int)); 316 void __swflags __P((WINDOW *)); 317 int __touchline __P((WINDOW *, int, int, int, int)); 318 int __touchwin __P((WINDOW *)); 319 char *__tscroll __P((const char *, int)); 320 int __waddch __P((WINDOW *, __LDATA *)); 321 322 /* Private #defines. */ 323 #define min(a,b) (a < b ? a : b) 324 #define max(a,b) (a > b ? a : b) 325 326 /* Private externs. */ 327 extern int __echoit; 328 extern int __endwin; 329 extern int __pfast; 330 extern int __rawmode; 331 extern int __noqch; 332 #endif 333 334 /* Termcap functions. */ 335 int tgetent __P((char *, char *)); 336 int tgetnum __P((char *)); 337 int tgetflag __P((char *)); 338 char *tgetstr __P((char *, char **)); 339 char *tgoto __P((char *, int, int)); 340 int tputs __P((char *, int, void (*)(int))); 341 342 #endif /* !_CURSES_H_ */ 343
Indexes created Mon Sep 22 13:09:51 GMT 2025