1 /* $NetBSD: curses_private.h,v 1.50 2014/02/20 09:42:42 blymn 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 39 * wide-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 #define __ISFORCED 0x04 /* Force update, no optimisation */ 103 unsigned int flags; 104 unsigned int hash; /* Hash value for the line. */ 105 int *firstchp, *lastchp; /* First and last chngd columns ptrs */ 106 int firstch, lastch; /* First and last changed columns. */ 107 __LDATA *line; /* Pointer to the line text. */ 108 }; 109 110 struct __window { /* Window structure. */ 111 struct __window *nextp, *orig; /* Subwindows list and parent. */ 112 int begy, begx; /* Window home. */ 113 int cury, curx; /* Current x, y coordinates. */ 114 int maxy, maxx; /* Maximum values for curx, cury. */ 115 int reqy, reqx; /* Size requested when created */ 116 int ch_off; /* x offset for firstch/lastch. */ 117 __LINE **alines; /* Array of pointers to the lines */ 118 __LINE *lspace; /* line space (for cleanup) */ 119 __LDATA *wspace; /* window space (for cleanup) */ 120 121 #define __ENDLINE 0x00000001 /* End of screen. */ 122 #define __FLUSH 0x00000002 /* Fflush(stdout) after refresh. */ 123 #define __FULLWIN 0x00000004 /* Window is a screen. */ 124 #define __IDLINE 0x00000008 /* Insert/delete sequences. */ 125 #define __SCROLLWIN 0x00000010 /* Last char will scroll window. */ 126 #define __SCROLLOK 0x00000020 /* Scrolling ok. */ 127 #define __CLEAROK 0x00000040 /* Clear on next refresh. */ 128 #define __LEAVEOK 0x00000100 /* If cursor left */ 129 #define __KEYPAD 0x00010000 /* If interpreting keypad codes */ 130 #define __NOTIMEOUT 0x00020000 /* Wait indefinitely for func keys */ 131 #define __IDCHAR 0x00040000 /* insert/delete char sequences */ 132 #define __ISPAD 0x00080000 /* "window" is a pad */ 133 #define __ISDERWIN 0x00100000 /* "window" is derived from parent */ 134 unsigned int flags; 135 int delay; /* delay for getch() */ 136 attr_t wattr; /* Character attributes */ 137 wchar_t bch; /* Background character */ 138 attr_t battr; /* Background attributes */ 139 int scr_t, scr_b; /* Scrolling region top, bottom */ 140 SCREEN *screen; /* Screen for this window */ 141 int pbegy, pbegx, 142 sbegy, sbegx, 143 smaxy, smaxx; /* Saved prefresh() values */ 144 int dery, derx; /* derived window coordinates 145 - top left corner of source 146 relative to parent win */ 147 #ifdef HAVE_WCHAR 148 nschar_t *bnsp; /* Background non-spacing char list */ 149 #endif /* HAVE_WCHAR */ 150 }; 151 152 /* Set of attributes unset by 'me' - 'mb', 'md', 'mh', 'mk', 'mp' and 'mr'. */ 153 #ifndef HAVE_WCHAR 154 #define __TERMATTR \ 155 (__REVERSE | __BLINK | __DIM | __BOLD | __BLANK | __PROTECT) 156 #else 157 #define __TERMATTR \ 158 (__REVERSE | __BLINK | __DIM | __BOLD | __BLANK | __PROTECT \ 159 | WA_TOP | WA_LOW | WA_LEFT | WA_RIGHT | WA_HORIZONTAL | WA_VERTICAL) 160 #endif /* HAVE_WCHAR */ 161 162 struct __winlist { 163 struct __window *winp; /* The window. */ 164 struct __winlist *nextp; /* Next window. */ 165 }; 166 167 struct __color { 168 short num; 169 short red; 170 short green; 171 short blue; 172 int flags; 173 }; 174 175 /* List of colour pairs */ 176 struct __pair { 177 short fore; 178 short back; 179 int flags; 180 }; 181 182 /* Maximum colours */ 183 #define MAX_COLORS 64 184 /* Maximum colour pairs - determined by number of colour bits in attr_t */ 185 #define MAX_PAIRS PAIR_NUMBER(__COLOR) 186 187 typedef struct keymap keymap_t; 188 189 /* this is the encapsulation of the terminal definition, one for 190 * each terminal that curses talks to. 191 */ 192 struct __screen { 193 FILE *infd, *outfd; /* input and output file descriptors */ 194 WINDOW *curscr; /* Current screen. */ 195 WINDOW *stdscr; /* Standard screen. */ 196 WINDOW *__virtscr; /* Virtual screen (for doupdate()). */ 197 int curwin; /* current window for refresh */ 198 int lx, ly; /* loop parameters for refresh */ 199 int COLS; /* Columns on the screen. */ 200 int LINES; /* Lines on the screen. */ 201 int TABSIZE; /* Size of a tab. */ 202 int COLORS; /* Maximum colors on the screen */ 203 int COLOR_PAIRS; /* Maximum color pairs on the screen */ 204 int My_term; /* Use Def_term regardless. */ 205 char GT; /* Gtty indicates tabs. */ 206 char NONL; /* Term can't hack LF doing a CR. */ 207 char UPPERCASE; /* Terminal is uppercase only. */ 208 209 chtype acs_char[NUM_ACS]; 210 #ifdef HAVE_WCHAR 211 cchar_t wacs_char[ NUM_ACS ]; 212 #endif /* HAVE_WCHAR */ 213 struct __color colours[MAX_COLORS]; 214 struct __pair colour_pairs[MAX_PAIRS]; 215 attr_t nca; 216 217 /* Style of colour manipulation */ 218 #define COLOR_NONE 0 219 #define COLOR_ANSI 1 /* ANSI/DEC-style colour manipulation */ 220 #define COLOR_HP 2 /* HP-style colour manipulation */ 221 #define COLOR_TEK 3 /* Tektronix-style colour manipulation */ 222 #define COLOR_OTHER 4 /* None of the others but can set fore/back */ 223 int color_type; 224 225 attr_t mask_op; 226 attr_t mask_me; 227 attr_t mask_ue; 228 attr_t mask_se; 229 TERMINAL *term; 230 int old_mode; /* old cursor visibility state for terminal */ 231 keymap_t *base_keymap; 232 int echoit; 233 int pfast; 234 int rawmode; 235 int nl; 236 int noqch; 237 int clearok; 238 int useraw; 239 struct __winlist *winlistp; 240 struct termios cbreakt, rawt, *curt, save_termios; 241 struct termios orig_termios, baset, savedtty; 242 int ovmin; 243 int ovtime; 244 char *stdbuf; 245 unsigned int len; 246 int meta_state; 247 char padchar; 248 int endwin; 249 int notty; 250 int half_delay; 251 int resized; 252 wchar_t *unget_list; 253 int unget_len, unget_pos; 254 #ifdef HAVE_WCHAR 255 #define MB_LEN_MAX 8 256 #define MAX_CBUF_SIZE MB_LEN_MAX 257 int cbuf_head; /* header to cbuf */ 258 int cbuf_tail; /* tail to cbuf */ 259 int cbuf_cur; /* the current char in cbuf */ 260 mbstate_t sp; /* wide char processing state */ 261 char cbuf[ MAX_CBUF_SIZE ]; /* input character buffer */ 262 #endif /* HAVE_WCHAR */ 263 }; 264 265 266 extern char __GT; /* Gtty indicates tabs. */ 267 extern char __NONL; /* Term can't hack LF doing a CR. */ 268 extern char __UPPERCASE; /* Terminal is uppercase only. */ 269 extern int My_term; /* Use Def_term regardless. */ 270 extern const char *Def_term; /* Default terminal type. */ 271 extern SCREEN *_cursesi_screen; /* The current screen in use */ 272 273 /* Debugging options/functions. */ 274 #ifdef DEBUG 275 #define __CTRACE_TSTAMP 0x00000001 276 #define __CTRACE_MISC 0x00000002 277 #define __CTRACE_INIT 0x00000004 278 #define __CTRACE_SCREEN 0x00000008 279 #define __CTRACE_WINDOW 0x00000010 280 #define __CTRACE_REFRESH 0x00000020 281 #define __CTRACE_COLOR 0x00000040 282 #define __CTRACE_INPUT 0x00000080 283 #define __CTRACE_OUTPUT 0x00000100 284 #define __CTRACE_LINE 0x00000200 285 #define __CTRACE_ATTR 0x00000400 286 #define __CTRACE_ERASE 0x00000800 287 #define __CTRACE_FILEIO 0x00001000 288 #define __CTRACE_ALL 0x7fffffff 289 void __CTRACE_init(void); 290 void __CTRACE(int, const char *, ...) __attribute__((__format__(__printf__, 2, 3))); 291 #endif 292 293 /* Private functions. */ 294 int __cputchar_args(int, void *); 295 void _cursesi_free_keymap(keymap_t *); 296 int _cursesi_gettmode(SCREEN *); 297 void _cursesi_reset_acs(SCREEN *); 298 int _cursesi_addbyte(WINDOW *, __LINE **, int *, int *, int , attr_t, int); 299 int _cursesi_addwchar(WINDOW *, __LINE **, int *, int *, const cchar_t *, 300 int); 301 int _cursesi_waddbytes(WINDOW *, const char *, int, attr_t, int); 302 #ifdef HAVE_WCHAR 303 void _cursesi_reset_wacs(SCREEN *); 304 #endif /* HAVE_WCHAR */ 305 void _cursesi_resetterm(SCREEN *); 306 int _cursesi_setterm(char *, SCREEN *); 307 int __delay(void); 308 u_int __hash_more(const void *, size_t, u_int); 309 #define __hash(s, len) __hash_more((s), (len), 0u) 310 void __id_subwins(WINDOW *); 311 void __init_getch(SCREEN *); 312 void __init_acs(SCREEN *); 313 #ifdef HAVE_WCHAR 314 void __init_get_wch(SCREEN *); 315 void __init_wacs(SCREEN *); 316 int __cputwchar_args( wchar_t, void * ); 317 int _cursesi_copy_nsp(nschar_t *, struct __ldata *); 318 void __cursesi_free_nsp(nschar_t *); 319 void __cursesi_win_free_nsp(WINDOW *); 320 void __cursesi_putnsp(nschar_t *, const int, const int); 321 void __cursesi_chtype_to_cchar(chtype, cchar_t *); 322 #endif /* HAVE_WCHAR */ 323 int __unget(wint_t); 324 int __mvcur(int, int, int, int, int); 325 WINDOW *__newwin(SCREEN *, int, int, int, int, int); 326 int __nodelay(void); 327 int __notimeout(void); 328 void __restartwin(void); 329 void __restore_colors(void); 330 void __restore_cursor_vis(void); 331 void __restore_meta_state(void); 332 void __restore_termios(void); 333 void __restore_stophandler(void); 334 void __restore_winchhandler(void); 335 void __save_termios(void); 336 void __set_color(WINDOW *win, attr_t attr); 337 void __set_stophandler(void); 338 void __set_winchhandler(void); 339 void __set_subwin(WINDOW *, WINDOW *); 340 void __startwin(SCREEN *); 341 void __stop_signal_handler(int); 342 int __stopwin(void); 343 void __swflags(WINDOW *); 344 int __timeout(int); 345 int __touchline(WINDOW *, int, int, int); 346 int __touchwin(WINDOW *); 347 void __unsetattr(int); 348 void __unset_color(WINDOW *win); 349 int __waddch(WINDOW *, __LDATA *); 350 int __wgetnstr(WINDOW *, char *, int); 351 void __winch_signal_handler(int); 352 353 /* Private #defines. */ 354 #define min(a,b) ((a) < (b) ? (a) : (b)) 355 #define max(a,b) ((a) > (b) ? (a ): (b)) 356 357 /* Private externs. */ 358 extern int __echoit; 359 extern int __endwin; 360 extern int __pfast; 361 extern int __rawmode; 362 extern int __noqch; 363 extern attr_t __mask_op, __mask_me, __mask_ue, __mask_se; 364 extern WINDOW *__virtscr; 365 extern int __using_color; 366 extern attr_t __default_color; 367