curses_private.h revision 1.56 1 /* $NetBSD: curses_private.h,v 1.56 2017/01/05 20:31:37 roy Exp $ */
2
3 /*-
4 * Copyright (c) 1998-2000 Brett Lymn
5 * (blymn (at) baea.com.au, brett_lymn (at) 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 (at) arl.wustl.edu,ruibiao (at) 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 #define __IMMEDOK 0x00200000 /* refreshed when changed */
135 #define __SYNCOK 0x00400000 /* sync when changed */
136 unsigned int flags;
137 int delay; /* delay for getch() */
138 attr_t wattr; /* Character attributes */
139 wchar_t bch; /* Background character */
140 attr_t battr; /* Background attributes */
141 int scr_t, scr_b; /* Scrolling region top, bottom */
142 SCREEN *screen; /* Screen for this window */
143 int pbegy, pbegx,
144 sbegy, sbegx,
145 smaxy, smaxx; /* Saved prefresh() values */
146 int dery, derx; /* derived window coordinates
147 - top left corner of source
148 relative to parent win */
149 #ifdef HAVE_WCHAR
150 nschar_t *bnsp; /* Background non-spacing char list */
151 #endif /* HAVE_WCHAR */
152 FILE *fp; /* for window formatted printf */
153 };
154
155 /* Set of attributes unset by 'me' - 'mb', 'md', 'mh', 'mk', 'mp' and 'mr'. */
156 #ifndef HAVE_WCHAR
157 #define __TERMATTR \
158 (__REVERSE | __BLINK | __DIM | __BOLD | __BLANK | __PROTECT)
159 #else
160 #define __TERMATTR \
161 (__REVERSE | __BLINK | __DIM | __BOLD | __BLANK | __PROTECT \
162 | WA_TOP | WA_LOW | WA_LEFT | WA_RIGHT | WA_HORIZONTAL | WA_VERTICAL)
163 #endif /* HAVE_WCHAR */
164
165 struct __winlist {
166 struct __window *winp; /* The window. */
167 struct __winlist *nextp; /* Next window. */
168 };
169
170 struct __color {
171 short num;
172 short red;
173 short green;
174 short blue;
175 int flags;
176 };
177
178 /* List of colour pairs */
179 struct __pair {
180 short fore;
181 short back;
182 int flags;
183 };
184
185 /* Maximum colours */
186 #define MAX_COLORS 256
187 /* Maximum colour pairs - determined by number of colour bits in attr_t */
188 #define MAX_PAIRS PAIR_NUMBER(__COLOR)
189
190 typedef struct keymap keymap_t;
191
192 /* this is the encapsulation of the terminal definition, one for
193 * each terminal that curses talks to.
194 */
195 struct __screen {
196 FILE *infd, *outfd; /* input and output file descriptors */
197 WINDOW *curscr; /* Current screen. */
198 WINDOW *stdscr; /* Standard screen. */
199 WINDOW *__virtscr; /* Virtual screen (for doupdate()). */
200 int curwin; /* current window for refresh */
201 int lx, ly; /* loop parameters for refresh */
202 int COLS; /* Columns on the screen. */
203 int LINES; /* Lines on the screen. */
204 int ESCDELAY; /* Delay between keys in esc seq's. */
205 #define ESCDELAY_DEFAULT 300 /* milliseconds. */
206 int TABSIZE; /* Size of a tab. */
207 #define TABSIZE_DEFAULT 8 /* spaces. */
208 int COLORS; /* Maximum colors on the screen */
209 int COLOR_PAIRS; /* Maximum color pairs on the screen */
210 int My_term; /* Use Def_term regardless. */
211 char GT; /* Gtty indicates tabs. */
212 char NONL; /* Term can't hack LF doing a CR. */
213 char UPPERCASE; /* Terminal is uppercase only. */
214
215 chtype acs_char[NUM_ACS];
216 #ifdef HAVE_WCHAR
217 cchar_t wacs_char[ NUM_ACS ];
218 #endif /* HAVE_WCHAR */
219 struct __color colours[MAX_COLORS];
220 struct __pair colour_pairs[MAX_PAIRS];
221 attr_t nca;
222
223 /* Style of colour manipulation */
224 #define COLOR_NONE 0
225 #define COLOR_ANSI 1 /* ANSI/DEC-style colour manipulation */
226 #define COLOR_HP 2 /* HP-style colour manipulation */
227 #define COLOR_TEK 3 /* Tektronix-style colour manipulation */
228 #define COLOR_OTHER 4 /* None of the others but can set fore/back */
229 int color_type;
230
231 attr_t mask_op;
232 attr_t mask_me;
233 attr_t mask_ue;
234 attr_t mask_se;
235 TERMINAL *term;
236 int old_mode; /* old cursor visibility state for terminal */
237 keymap_t *base_keymap;
238 int echoit;
239 int pfast;
240 int rawmode;
241 int nl;
242 int noqch;
243 int clearok;
244 int useraw;
245 struct __winlist *winlistp;
246 struct termios cbreakt, rawt, *curt, save_termios;
247 struct termios orig_termios, baset, savedtty;
248 int ovmin;
249 int ovtime;
250 char *stdbuf;
251 unsigned int len;
252 int meta_state;
253 char padchar;
254 int endwin;
255 int notty;
256 int half_delay;
257 int resized;
258 wchar_t *unget_list;
259 int unget_len, unget_pos;
260 int filtered;
261 int checkfd;
262 #ifdef HAVE_WCHAR
263 #define MB_LEN_MAX 8
264 #define MAX_CBUF_SIZE MB_LEN_MAX
265 int cbuf_head; /* header to cbuf */
266 int cbuf_tail; /* tail to cbuf */
267 int cbuf_cur; /* the current char in cbuf */
268 mbstate_t sp; /* wide char processing state */
269 char cbuf[ MAX_CBUF_SIZE ]; /* input character buffer */
270 #endif /* HAVE_WCHAR */
271 };
272
273
274 extern char __GT; /* Gtty indicates tabs. */
275 extern char __NONL; /* Term can't hack LF doing a CR. */
276 extern char __UPPERCASE; /* Terminal is uppercase only. */
277 extern int My_term; /* Use Def_term regardless. */
278 extern const char *Def_term; /* Default terminal type. */
279 extern SCREEN *_cursesi_screen; /* The current screen in use */
280
281 /* Debugging options/functions. */
282 #ifdef DEBUG
283 #define __CTRACE_TSTAMP 0x00000001
284 #define __CTRACE_MISC 0x00000002
285 #define __CTRACE_INIT 0x00000004
286 #define __CTRACE_SCREEN 0x00000008
287 #define __CTRACE_WINDOW 0x00000010
288 #define __CTRACE_REFRESH 0x00000020
289 #define __CTRACE_COLOR 0x00000040
290 #define __CTRACE_INPUT 0x00000080
291 #define __CTRACE_OUTPUT 0x00000100
292 #define __CTRACE_LINE 0x00000200
293 #define __CTRACE_ATTR 0x00000400
294 #define __CTRACE_ERASE 0x00000800
295 #define __CTRACE_FILEIO 0x00001000
296 #define __CTRACE_ALL 0x7fffffff
297 void __CTRACE_init(void);
298 void __CTRACE(int, const char *, ...) __attribute__((__format__(__printf__, 2, 3)));
299 #endif
300
301 /* Private functions. */
302 int __cputchar_args(int, void *);
303 void _cursesi_free_keymap(keymap_t *);
304 int _cursesi_gettmode(SCREEN *);
305 void _cursesi_reset_acs(SCREEN *);
306 int _cursesi_addbyte(WINDOW *, __LINE **, int *, int *, int , attr_t, int);
307 int _cursesi_addwchar(WINDOW *, __LINE **, int *, int *, const cchar_t *,
308 int);
309 int _cursesi_waddbytes(WINDOW *, const char *, int, attr_t, int);
310 #ifdef HAVE_WCHAR
311 void _cursesi_reset_wacs(SCREEN *);
312 #endif /* HAVE_WCHAR */
313 void _cursesi_resetterm(SCREEN *);
314 int _cursesi_setterm(char *, SCREEN *);
315 int __delay(void);
316 u_int __hash_more(const void *, size_t, u_int);
317 #define __hash(s, len) __hash_more((s), (len), 0u)
318 void __id_subwins(WINDOW *);
319 void __init_getch(SCREEN *);
320 void __init_acs(SCREEN *);
321 #ifdef HAVE_WCHAR
322 void __init_get_wch(SCREEN *);
323 void __init_wacs(SCREEN *);
324 int __cputwchar_args( wchar_t, void * );
325 int _cursesi_copy_nsp(nschar_t *, struct __ldata *);
326 void __cursesi_free_nsp(nschar_t *);
327 void __cursesi_win_free_nsp(WINDOW *);
328 void __cursesi_putnsp(nschar_t *, const int, const int);
329 void __cursesi_chtype_to_cchar(chtype, cchar_t *);
330 #endif /* HAVE_WCHAR */
331 int __unget(wint_t);
332 int __mvcur(int, int, int, int, int);
333 WINDOW *__newwin(SCREEN *, int, int, int, int, int);
334 int __nodelay(void);
335 int __notimeout(void);
336 void __restartwin(void);
337 void __restore_colors(void);
338 void __restore_cursor_vis(void);
339 void __restore_meta_state(void);
340 void __restore_termios(void);
341 void __restore_stophandler(void);
342 void __restore_winchhandler(void);
343 void __save_termios(void);
344 void __set_color(WINDOW *win, attr_t attr);
345 void __set_stophandler(void);
346 void __set_winchhandler(void);
347 void __set_subwin(WINDOW *, WINDOW *);
348 void __startwin(SCREEN *);
349 void __stop_signal_handler(int);
350 int __stopwin(void);
351 void __swflags(WINDOW *);
352 void __sync(WINDOW *);
353 int __timeout(int);
354 int __touchline(WINDOW *, int, int, int);
355 int __touchwin(WINDOW *);
356 void __unsetattr(int);
357 void __unset_color(WINDOW *win);
358 int __waddch(WINDOW *, __LDATA *);
359 int __wgetnstr(WINDOW *, char *, int);
360 void __winch_signal_handler(int);
361
362 /* Private #defines. */
363 #define min(a,b) ((a) < (b) ? (a) : (b))
364 #define max(a,b) ((a) > (b) ? (a ): (b))
365
366 /* Private externs. */
367 extern int __echoit;
368 extern int __endwin;
369 extern int __pfast;
370 extern int __rawmode;
371 extern int __noqch;
372 extern attr_t __mask_op, __mask_me, __mask_ue, __mask_se;
373 extern WINDOW *__virtscr;
374 extern int __using_color;
375 extern attr_t __default_color;
376