1 /* $NetBSD: curses_private.h,v 1.25 2002/08/04 16:43:08 jdc Exp $ */ 2 3 /*- 4 * Copyright (c) 1998-2000 Brett Lymn 5 * (blymn@baea.com.au, brett_lymn@yahoo.com.au) 6 * All rights reserved. 7 * 8 * This code has been donated to The NetBSD Foundation by the Author. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. The name of the author may not be used to endorse or promote products 16 * derived from this software without specific prior written permission 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28 * 29 * 30 */ 31 32 #include <termios.h> 33 34 /* Private structure definitions for curses. */ 35 36 /* Termcap capabilities. */ 37 extern char __tc_am, __tc_bs, __tc_cc, __tc_da, __tc_eo, 38 __tc_hc, __tc_hl, __tc_in, __tc_mi, __tc_ms, 39 __tc_nc, __tc_ns, __tc_os, __tc_ul, __tc_ut, 40 __tc_xb, __tc_xn, __tc_xt, __tc_xs, __tc_xx; 41 extern char __CA; 42 extern int __tc_pa, __tc_Co, __tc_NC; 43 extern char *__tc_ac, *__tc_AB, *__tc_ae, *__tc_AF, *__tc_AL, 44 *__tc_al, *__tc_as, *__tc_bc, *__tc_bl, *__tc_bt, 45 *__tc_cd, *__tc_ce, *__tc_cl, *__tc_cm, *__tc_cr, 46 *__tc_cs, *__tc_dc, *__tc_DL, *__tc_dl, *__tc_dm, 47 *__tc_DO, *__tc_do, *__tc_eA, *__tc_ed, *__tc_ei, 48 *__tc_ho, *__tc_Ic, *__tc_ic, *__tc_im, *__tc_Ip, 49 *__tc_ip, *__tc_k0, *__tc_k1, *__tc_k2, *__tc_k3, 50 *__tc_k4, *__tc_k5, *__tc_k6, *__tc_k7, *__tc_k8, 51 *__tc_k9, *__tc_kd, *__tc_ke, *__tc_kh, *__tc_kl, 52 *__tc_kr, *__tc_ks, *__tc_ku, *__tc_LE, *__tc_ll, 53 *__tc_ma, *__tc_mb, *__tc_md, *__tc_me, *__tc_mh, 54 *__tc_mk, *__tc_mm, *__tc_mo, *__tc_mp, *__tc_mr, 55 *__tc_nd, *__tc_nl, *__tc_oc, *__tc_op, 56 *__tc_rc, *__tc_RI, *__tc_Sb, *__tc_sc, *__tc_se, 57 *__tc_SF, *__tc_Sf, *__tc_sf, *__tc_so, *__tc_sp, 58 *__tc_SR, *__tc_sr, *__tc_ta, *__tc_te, *__tc_ti, 59 *__tc_uc, *__tc_ue, *__tc_UP, *__tc_up, *__tc_us, 60 *__tc_vb, *__tc_ve, *__tc_vi, *__tc_vs; 61 62 /* 63 * A window an array of __LINE structures pointed to by the 'lines' pointer. 64 * A line is an array of __LDATA structures pointed to by the 'line' pointer. 65 * 66 * IMPORTANT: the __LDATA structure must NOT induce any padding, so if new 67 * fields are added -- padding fields with *constant values* should ensure 68 * that the compiler will not generate any padding when storing an array of 69 * __LDATA structures. This is to enable consistent use of memcmp, and memcpy 70 * for comparing and copying arrays. 71 */ 72 73 struct __ldata { 74 wchar_t ch; /* Character */ 75 attr_t attr; /* Attributes */ 76 wchar_t bch; /* Background character */ 77 attr_t battr; /* Background attributes */ 78 }; 79 80 #define __LDATASIZE (sizeof(__LDATA)) 81 82 struct __line { 83 #ifdef DEBUG 84 #define SENTINEL_VALUE 0xaac0ffee 85 86 unsigned int sentinel; /* try to catch line overflows */ 87 #endif 88 #define __ISDIRTY 0x01 /* Line is dirty. */ 89 #define __ISPASTEOL 0x02 /* Cursor is past end of line */ 90 unsigned int flags; 91 unsigned int hash; /* Hash value for the line. */ 92 int *firstchp, *lastchp; /* First and last chngd columns ptrs */ 93 int firstch, lastch; /* First and last changed columns. */ 94 __LDATA *line; /* Pointer to the line text. */ 95 }; 96 97 struct __window { /* Window structure. */ 98 struct __window *nextp, *orig; /* Subwindows list and parent. */ 99 int begy, begx; /* Window home. */ 100 int cury, curx; /* Current x, y coordinates. */ 101 int maxy, maxx; /* Maximum values for curx, cury. */ 102 short ch_off; /* x offset for firstch/lastch. */ 103 __LINE **lines; /* Array of pointers to the lines */ 104 __LINE *lspace; /* line space (for cleanup) */ 105 __LDATA *wspace; /* window space (for cleanup) */ 106 107 #define __ENDLINE 0x00000001 /* End of screen. */ 108 #define __FLUSH 0x00000002 /* Fflush(stdout) after refresh. */ 109 #define __FULLWIN 0x00000004 /* Window is a screen. */ 110 #define __IDLINE 0x00000008 /* Insert/delete sequences. */ 111 #define __SCROLLWIN 0x00000010 /* Last char will scroll window. */ 112 #define __SCROLLOK 0x00000020 /* Scrolling ok. */ 113 #define __CLEAROK 0x00000040 /* Clear on next refresh. */ 114 #define __LEAVEOK 0x00000100 /* If cursor left */ 115 #define __KEYPAD 0x00010000 /* If interpreting keypad codes */ 116 #define __NOTIMEOUT 0x00020000 /* Wait indefinitely for func keys */ 117 #define __IDCHAR 0x00040000 /* insert/delete char sequences */ 118 unsigned int flags; 119 int delay; /* delay for getch() */ 120 attr_t wattr; /* Character attributes */ 121 wchar_t bch; /* Background character */ 122 attr_t battr; /* Background attributes */ 123 int scr_t, scr_b; /* Scrolling region top, bottom */ 124 }; 125 126 /* Set of attributes unset by 'me' - 'mb', 'md', 'mh', 'mk', 'mp' and 'mr'. */ 127 #define __TERMATTR \ 128 (__REVERSE | __BLINK | __DIM | __BOLD | __BLANK | __PROTECT) 129 130 struct __winlist { 131 struct __window *winp; /* The window. */ 132 struct __winlist *nextp; /* Next window. */ 133 }; 134 135 struct __color { 136 short num; 137 short red; 138 short green; 139 short blue; 140 int flags; 141 }; 142 143 /* List of colour pairs */ 144 struct __pair { 145 short fore; 146 short back; 147 int flags; 148 }; 149 150 /* Maximum colours */ 151 #define MAX_COLORS 64 152 /* Maximum colour pairs - determined by number of colour bits in attr_t */ 153 #define MAX_PAIRS PAIR_NUMBER(__COLOR) 154 155 typedef struct keymap keymap_t; 156 157 /* this is the encapsulation of the terminal definition, one for 158 * each terminal that curses talks to. 159 */ 160 struct __screen { 161 FILE *infd, *outfd; /* input and output file descriptors */ 162 WINDOW *curscr; /* Current screen. */ 163 WINDOW *stdscr; /* Standard screen. */ 164 WINDOW *__virtscr; /* Virtual screen (for doupdate()). */ 165 int curwin; /* current window for refresh */ 166 short lx, ly; /* loop parameters for refresh */ 167 int COLS; /* Columns on the screen. */ 168 int LINES; /* Lines on the screen. */ 169 int COLORS; /* Maximum colors on the screen */ 170 int COLOR_PAIRS; /* Maximum color pairs on the screen */ 171 int My_term; /* Use Def_term regardless. */ 172 char GT; /* Gtty indicates tabs. */ 173 char NONL; /* Term can't hack LF doing a CR. */ 174 char UPPERCASE; /* Terminal is uppercase only. */ 175 176 /* BEWARE!!! The order of the following terminal capabilities */ 177 /* (tc_foo) is important - do not update without fixing the zap */ 178 /* function in setterm.c */ 179 char tc_am, tc_bs, tc_cc, tc_da, tc_eo, tc_hc, tc_hl, tc_in, tc_mi, 180 tc_ms, tc_nc, tc_ns, tc_os, tc_ul, tc_ut, tc_xb, tc_xn, tc_xt, 181 tc_xs, tc_xx; 182 int flag_count; 183 int tc_pa, tc_Co, tc_NC; 184 int int_count; 185 char *tc_AB, *tc_ac, *tc_ae, *tc_AF, *tc_AL, 186 *tc_al, *tc_as, *tc_bc, *tc_bl, *tc_bt, 187 *tc_cd, *tc_ce, *tc_cl, *tc_cm, *tc_cr, 188 *tc_cs, *tc_dc, *tc_DL, *tc_dl, *tc_dm, 189 *tc_DO, *tc_do, *tc_eA, *tc_ed, *tc_ei, 190 *tc_ho, *tc_Ic, *tc_ic, *tc_im, *tc_Ip, 191 *tc_ip, *tc_k0, *tc_k1, *tc_k2, *tc_k3, 192 *tc_k4, *tc_k5, *tc_k6, *tc_k7, *tc_k8, 193 *tc_k9, *tc_kd, *tc_ke, *tc_kh, *tc_kl, 194 *tc_kr, *tc_ks, *tc_ku, *tc_LE, *tc_ll, 195 *tc_ma, *tc_mb, *tc_md, *tc_me, *tc_mh, 196 *tc_mk, *tc_mm, *tc_mo, *tc_mp, *tc_mr, 197 *tc_nd, *tc_nl, *tc_oc, *tc_op, *tc_pc, 198 *tc_rc, *tc_RI, *tc_Sb, *tc_sc, *tc_se, 199 *tc_SF, *tc_Sf, *tc_sf, *tc_so, *tc_sp, 200 *tc_SR, *tc_sr, *tc_ta, *tc_te, *tc_ti, 201 *tc_uc, *tc_ue, *tc_UP, *tc_up, *tc_us, 202 *tc_vb, *tc_ve, *tc_vi, *tc_vs; 203 char CA; 204 int str_count; 205 chtype acs_char[NUM_ACS]; 206 struct __color colours[MAX_COLORS]; 207 struct __pair colour_pairs[MAX_PAIRS]; 208 attr_t nca; 209 210 /* Style of colour manipulation */ 211 #define COLOR_NONE 0 212 #define COLOR_ANSI 1 /* ANSI/DEC-style colour manipulation */ 213 #define COLOR_HP 2 /* HP-style colour manipulation */ 214 #define COLOR_TEK 3 /* Tektronix-style colour manipulation */ 215 #define COLOR_OTHER 4 /* None of the others but can set fore/back */ 216 int color_type; 217 218 attr_t mask_op; 219 attr_t mask_me; 220 attr_t mask_ue; 221 attr_t mask_se; 222 struct tinfo *cursesi_genbuf; 223 int old_mode; /* old cursor visibility state for terminal */ 224 keymap_t *base_keymap; 225 int echoit; 226 int pfast; 227 int rawmode; 228 int noqch; 229 int clearok; 230 int useraw; 231 struct __winlist *winlistp; 232 struct termios cbreakt, rawt, *curt, save_termios; 233 struct termios orig_termios, baset, savedtty; 234 int ovmin; 235 int ovtime; 236 char *stdbuf; 237 unsigned int len; 238 int meta_state; 239 char pad_char; 240 char ttytype[128]; 241 int endwin; 242 int notty; 243 }; 244 245 246 extern char __GT; /* Gtty indicates tabs. */ 247 extern char __NONL; /* Term can't hack LF doing a CR. */ 248 extern char __UPPERCASE; /* Terminal is uppercase only. */ 249 extern int My_term; /* Use Def_term regardless. */ 250 extern const char *Def_term; /* Default terminal type. */ 251 extern SCREEN *_cursesi_screen; /* The current screen in use */ 252 253 /* Private functions. */ 254 #ifdef DEBUG 255 void __CTRACE(const char *, ...); 256 #endif 257 void __cputchar_args(char, void *); 258 void _cursesi_free_keymap(keymap_t *); 259 int _cursesi_gettmode(SCREEN *); 260 void _cursesi_reset_acs(SCREEN *); 261 void _cursesi_resetterm(SCREEN *); 262 int _cursesi_setterm(char *, SCREEN *); 263 int _cursesi_wnoutrefresh(SCREEN *, WINDOW *); 264 int __delay(void); 265 u_int __hash_more(char *, size_t, u_int); 266 #define __hash(s, len) __hash_more((s), (len), 0u) 267 void __id_subwins(WINDOW *); 268 void __init_getch(SCREEN *); 269 void __init_acs(SCREEN *); 270 char *__longname(char *, char *); /* Original BSD version */ 271 int __mvcur(int, int, int, int, int); 272 WINDOW *__newwin(SCREEN *, int, int, int, int); 273 int __nodelay(void); 274 int __notimeout(void); 275 char *__parse_cap(const char *, ...); 276 void __restartwin(void); 277 void __restore_colors(void); 278 void __restore_cursor_vis(void); 279 void __restore_meta_state(void); 280 void __restore_termios(void); 281 void __restore_stophandler(void); 282 void __save_termios(void); 283 void __set_color(WINDOW *win, attr_t attr); 284 void __set_stophandler(void); 285 void __set_subwin(WINDOW *, WINDOW *); 286 void __startwin(SCREEN *); 287 void __stop_signal_handler(int); 288 int __stopwin(void); 289 void __swflags(WINDOW *); 290 int __timeout(int); 291 int __touchline(WINDOW *, int, int, int); 292 int __touchwin(WINDOW *); 293 char *__tscroll(const char *, int, int); 294 void __unsetattr(int); 295 void __unset_color(WINDOW *win); 296 int __waddch(WINDOW *, __LDATA *); 297 int __wgetnstr(WINDOW *, char *, int); 298 299 /* Private #defines. */ 300 #define min(a,b) ((a) < (b) ? (a) : (b)) 301 #define max(a,b) ((a) > (b) ? (a ): (b)) 302 303 /* Private externs. */ 304 extern int __echoit; 305 extern int __endwin; 306 extern int __pfast; 307 extern int __rawmode; 308 extern int __noqch; 309 extern attr_t __nca; 310 extern attr_t __mask_op, __mask_me, __mask_ue, __mask_se; 311 extern struct __winlist *__winlistp; 312 extern WINDOW *__virtscr; 313 extern int __using_color; 314 extern attr_t __default_color; 315