1 /* $NetBSD: curses_private.h,v 1.44 2010/02/03 15:34:40 roy 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 /* Modified by Ruibiao Qiu <ruibiao@arl.wustl.edu,ruibiao@gmail.com> 33 * to add support for wide characters 34 * Changes: 35 * - Add a compiler variable HAVE_WCHAR for wide character only code 36 * - Add a pointer to liked list of non-spacing characters in __ldata 37 * and the macro to access the width field in the attribute field 38 * - Add a circular input character buffer in __screen to handle wide 39 * character input (used in get_wch()) 40 */ 41 42 #include <term.h> 43 #include <termios.h> 44 45 /* Private structure definitions for curses. */ 46 47 /* Termcap capabilities. */ 48 #ifdef HAVE_WCHAR 49 /* 50 * Add a list of non-spacing characters to each spacing 51 * character in a singly linked list 52 */ 53 typedef struct nschar_t { 54 wchar_t ch; /* Non-spacing character */ 55 struct nschar_t *next; /* Next non-spacing character */ 56 } nschar_t; 57 #endif /* HAVE_WCHAR */ 58 59 /* 60 * A window is an array of __LINE structures pointed to by the 'lines' pointer. 61 * A line is an array of __LDATA structures pointed to by the 'line' pointer. 62 * 63 * IMPORTANT: the __LDATA structure must NOT induce any padding, so if new 64 * fields are added -- padding fields with *constant values* should ensure 65 * that the compiler will not generate any padding when storing an array of 66 * __LDATA structures. This is to enable consistent use of memcmp, and memcpy 67 * for comparing and copying arrays. 68 */ 69 70 struct __ldata { 71 wchar_t ch; /* Character */ 72 attr_t attr; /* Attributes */ 73 #ifdef HAVE_WCHAR 74 nschar_t *nsp; /* Foreground non-spacing character pointer */ 75 #endif /* HAVE_WCHAR */ 76 }; 77 78 #ifdef HAVE_WCHAR 79 /* macros to extract the width of a wide character */ 80 #define __WCWIDTH 0xfc000000 81 #define WCW_SHIFT 26 82 #define WCOL(wc) ((((unsigned) (wc).attr) >> WCW_SHIFT ) > MB_LEN_MAX ? ((int)(((unsigned) (wc).attr ) >> WCW_SHIFT )) - 64 : ((int)(((unsigned) (wc).attr ) >> WCW_SHIFT))) 83 #define SET_WCOL(c, w) do { \ 84 ((c).attr) = ((((c).attr) & WA_ATTRIBUTES ) | ((w) << WCW_SHIFT )); \ 85 } while(/*CONSTCOND*/0) 86 #define BGWCOL(wc) ((((wc).battr) >> WCW_SHIFT ) > MB_LEN_MAX ? (((wc).battr ) >> WCW_SHIFT ) - 64 : (((wc).battr ) >> WCW_SHIFT )) 87 #define SET_BGWCOL(c, w) do { \ 88 ((c).battr) = ((((c).battr) & WA_ATTRIBUTES ) | ((w) << WCW_SHIFT )); \ 89 } while(/*CONSTCOND*/0) 90 #endif /* HAVE_WCHAR */ 91 92 #define __LDATASIZE (sizeof(__LDATA)) 93 94 struct __line { 95 #ifdef DEBUG 96 #define SENTINEL_VALUE 0xaac0ffee 97 98 unsigned int sentinel; /* try to catch line overflows */ 99 #endif 100 #define __ISDIRTY 0x01 /* Line is dirty. */ 101 #define __ISPASTEOL 0x02 /* Cursor is past end of line */ 102 unsigned int flags; 103 unsigned int hash; /* Hash value for the line. */ 104 int *firstchp, *lastchp; /* First and last chngd columns ptrs */ 105 int firstch, lastch; /* First and last changed columns. */ 106 __LDATA *line; /* Pointer to the line text. */ 107 }; 108 109 struct __window { /* Window structure. */ 110 struct __window *nextp, *orig; /* Subwindows list and parent. */ 111 int begy, begx; /* Window home. */ 112 int cury, curx; /* Current x, y coordinates. */ 113 int maxy, maxx; /* Maximum values for curx, cury. */ 114 int reqy, reqx; /* Size requested when created */ 115 int ch_off; /* x offset for firstch/lastch. */ 116 __LINE **alines; /* Array of pointers to the lines */ 117 __LINE *lspace; /* line space (for cleanup) */ 118 __LDATA *wspace; /* window space (for cleanup) */ 119 120 #define __ENDLINE 0x00000001 /* End of screen. */ 121 #define __FLUSH 0x00000002 /* Fflush(stdout) after refresh. */ 122 #define __FULLWIN 0x00000004 /* Window is a screen. */ 123 #define __IDLINE 0x00000008 /* Insert/delete sequences. */ 124 #define __SCROLLWIN 0x00000010 /* Last char will scroll window. */ 125 #define __SCROLLOK 0x00000020 /* Scrolling ok. */ 126 #define __CLEAROK 0x00000040 /* Clear on next refresh. */ 127 #define __LEAVEOK 0x00000100 /* If cursor left */ 128 #define __KEYPAD 0x00010000 /* If interpreting keypad codes */ 129 #define __NOTIMEOUT 0x00020000 /* Wait indefinitely for func keys */ 130 #define __IDCHAR 0x00040000 /* insert/delete char sequences */ 131 #define __ISPAD 0x00080000 /* "window" is a pad */ 132 unsigned int flags; 133 int delay; /* delay for getch() */ 134 attr_t wattr; /* Character attributes */ 135 wchar_t bch; /* Background character */ 136 attr_t battr; /* Background attributes */ 137 int scr_t, scr_b; /* Scrolling region top, bottom */ 138 SCREEN *screen; /* Screen for this window */ 139 int pbegy, pbegx, 140 sbegy, sbegx, 141 smaxy, smaxx; /* Saved prefresh() values */ 142 #ifdef HAVE_WCHAR 143 nschar_t *bnsp; /* Background non-spacing char list */ 144 #endif /* HAVE_WCHAR */ 145 }; 146 147 /* Set of attributes unset by 'me' - 'mb', 'md', 'mh', 'mk', 'mp' and 'mr'. */ 148 #ifndef HAVE_WCHAR 149 #define __TERMATTR \ 150 (__REVERSE | __BLINK | __DIM | __BOLD | __BLANK | __PROTECT) 151 #else 152 #define __TERMATTR \ 153 (__REVERSE | __BLINK | __DIM | __BOLD | __BLANK | __PROTECT \ 154 | WA_TOP | WA_LOW | WA_LEFT | WA_RIGHT | WA_HORIZONTAL | WA_VERTICAL) 155 #endif /* HAVE_WCHAR */ 156 157 struct __winlist { 158 struct __window *winp; /* The window. */ 159 struct __winlist *nextp; /* Next window. */ 160 }; 161 162 struct __color { 163 short num; 164 short red; 165 short green; 166 short blue; 167 int flags; 168 }; 169 170 /* List of colour pairs */ 171 struct __pair { 172 short fore; 173 short back; 174 int flags; 175 }; 176 177 /* Maximum colours */ 178 #define MAX_COLORS 64 179 /* Maximum colour pairs - determined by number of colour bits in attr_t */ 180 #define MAX_PAIRS PAIR_NUMBER(__COLOR) 181 182 typedef struct keymap keymap_t; 183 184 /* this is the encapsulation of the terminal definition, one for 185 * each terminal that curses talks to. 186 */ 187 struct __screen { 188 FILE *infd, *outfd; /* input and output file descriptors */ 189 WINDOW *curscr; /* Current screen. */ 190 WINDOW *stdscr; /* Standard screen. */ 191 WINDOW *__virtscr; /* Virtual screen (for doupdate()). */ 192 int curwin; /* current window for refresh */ 193 int lx, ly; /* loop parameters for refresh */ 194 int COLS; /* Columns on the screen. */ 195 int LINES; /* Lines on the screen. */ 196 int COLORS; /* Maximum colors on the screen */ 197 int COLOR_PAIRS; /* Maximum color pairs on the screen */ 198 int My_term; /* Use Def_term regardless. */ 199 char GT; /* Gtty indicates tabs. */ 200 char NONL; /* Term can't hack LF doing a CR. */ 201 char UPPERCASE; /* Terminal is uppercase only. */ 202 203 chtype acs_char[NUM_ACS]; 204 #ifdef HAVE_WCHAR 205 cchar_t wacs_char[ NUM_ACS ]; 206 #endif /* HAVE_WCHAR */ 207 struct __color colours[MAX_COLORS]; 208 struct __pair colour_pairs[MAX_PAIRS]; 209 attr_t nca; 210 211 /* Style of colour manipulation */ 212 #define COLOR_NONE 0 213 #define COLOR_ANSI 1 /* ANSI/DEC-style colour manipulation */ 214 #define COLOR_HP 2 /* HP-style colour manipulation */ 215 #define COLOR_TEK 3 /* Tektronix-style colour manipulation */ 216 #define COLOR_OTHER 4 /* None of the others but can set fore/back */ 217 int color_type; 218 219 attr_t mask_op; 220 attr_t mask_me; 221 attr_t mask_ue; 222 attr_t mask_se; 223 TERMINAL *term; 224 int old_mode; /* old cursor visibility state for terminal */ 225 keymap_t *base_keymap; 226 int echoit; 227 int pfast; 228 int rawmode; 229 int nl; 230 int noqch; 231 int clearok; 232 int useraw; 233 struct __winlist *winlistp; 234 struct termios cbreakt, rawt, *curt, save_termios; 235 struct termios orig_termios, baset, savedtty; 236 int ovmin; 237 int ovtime; 238 char *stdbuf; 239 unsigned int len; 240 int meta_state; 241 char padchar; 242 char ttytype[128]; 243 int endwin; 244 int notty; 245 int half_delay; 246 int resized; 247 wchar_t *unget_list; 248 int unget_len, unget_pos; 249 #ifdef HAVE_WCHAR 250 #define MB_LEN_MAX 8 251 #define MAX_CBUF_SIZE MB_LEN_MAX 252 int cbuf_head; /* header to cbuf */ 253 int cbuf_tail; /* tail to cbuf */ 254 int cbuf_cur; /* the current char in cbuf */ 255 mbstate_t sp; /* wide char processing state */ 256 char cbuf[ MAX_CBUF_SIZE ]; /* input character buffer */ 257 #endif /* HAVE_WCHAR */ 258 }; 259 260 261 extern char __GT; /* Gtty indicates tabs. */ 262 extern char __NONL; /* Term can't hack LF doing a CR. */ 263 extern char __UPPERCASE; /* Terminal is uppercase only. */ 264 extern int My_term; /* Use Def_term regardless. */ 265 extern const char *Def_term; /* Default terminal type. */ 266 extern SCREEN *_cursesi_screen; /* The current screen in use */ 267 268 /* Debugging options/functions. */ 269 #ifdef DEBUG 270 #define __CTRACE_TSTAMP 0x00000001 271 #define __CTRACE_MISC 0x00000002 272 #define __CTRACE_INIT 0x00000004 273 #define __CTRACE_SCREEN 0x00000008 274 #define __CTRACE_WINDOW 0x00000010 275 #define __CTRACE_REFRESH 0x00000020 276 #define __CTRACE_COLOR 0x00000040 277 #define __CTRACE_INPUT 0x00000080 278 #define __CTRACE_OUTPUT 0x00000100 279 #define __CTRACE_LINE 0x00000200 280 #define __CTRACE_ATTR 0x00000400 281 #define __CTRACE_ERASE 0x00000800 282 #define __CTRACE_FILEIO 0x00001000 283 #define __CTRACE_ALL 0x7fffffff 284 void __CTRACE_init(void); 285 void __CTRACE(int, const char *, ...) __attribute__((__format__(__printf__, 2, 3))); 286 #endif 287 288 /* Private functions. */ 289 int __cputchar_args(int, void *); 290 void _cursesi_free_keymap(keymap_t *); 291 int _cursesi_gettmode(SCREEN *); 292 void _cursesi_reset_acs(SCREEN *); 293 int _cursesi_addbyte(WINDOW *, __LINE **, int *, int *, int , attr_t); 294 int _cursesi_addwchar(WINDOW *, __LINE **, int *, int *, const cchar_t *); 295 #ifdef HAVE_WCHAR 296 void _cursesi_reset_wacs(SCREEN *); 297 #endif /* HAVE_WCHAR */ 298 void _cursesi_resetterm(SCREEN *); 299 int _cursesi_setterm(char *, SCREEN *); 300 int __delay(void); 301 u_int __hash_more(const void *, size_t, u_int); 302 #define __hash(s, len) __hash_more((s), (len), 0u) 303 void __id_subwins(WINDOW *); 304 void __init_getch(SCREEN *); 305 void __init_acs(SCREEN *); 306 #ifdef HAVE_WCHAR 307 void __init_get_wch(SCREEN *); 308 void __init_wacs(SCREEN *); 309 int __cputwchar_args( wchar_t, void * ); 310 int _cursesi_copy_nsp(nschar_t *, struct __ldata *); 311 void __cursesi_free_nsp(nschar_t *); 312 void __cursesi_win_free_nsp(WINDOW *); 313 void __cursesi_putnsp(nschar_t *, const int, const int); 314 #endif /* HAVE_WCHAR */ 315 int __unget(wint_t); 316 char *__longname(char *, char *); /* Original BSD version */ 317 int __mvcur(int, int, int, int, int); 318 WINDOW *__newwin(SCREEN *, int, int, int, int, int); 319 int __nodelay(void); 320 int __notimeout(void); 321 void __restartwin(void); 322 void __restore_colors(void); 323 void __restore_cursor_vis(void); 324 void __restore_meta_state(void); 325 void __restore_termios(void); 326 void __restore_stophandler(void); 327 void __restore_winchhandler(void); 328 void __save_termios(void); 329 void __set_color(WINDOW *win, attr_t attr); 330 void __set_stophandler(void); 331 void __set_winchhandler(void); 332 void __set_subwin(WINDOW *, WINDOW *); 333 void __startwin(SCREEN *); 334 void __stop_signal_handler(int); 335 int __stopwin(void); 336 void __swflags(WINDOW *); 337 int __timeout(int); 338 int __touchline(WINDOW *, int, int, int); 339 int __touchwin(WINDOW *); 340 void __unsetattr(int); 341 void __unset_color(WINDOW *win); 342 int __waddch(WINDOW *, __LDATA *); 343 int __wgetnstr(WINDOW *, char *, int); 344 void __winch_signal_handler(int); 345 346 /* Private #defines. */ 347 #define min(a,b) ((a) < (b) ? (a) : (b)) 348 #define max(a,b) ((a) > (b) ? (a ): (b)) 349 350 /* Private externs. */ 351 extern int __echoit; 352 extern int __endwin; 353 extern int __pfast; 354 extern int __rawmode; 355 extern int __noqch; 356 extern attr_t __mask_op, __mask_me, __mask_ue, __mask_se; 357 extern WINDOW *__virtscr; 358 extern int __using_color; 359 extern attr_t __default_color; 360