xref: /netbsd-src/lib/libcurses/curses_private.h (revision 3b01aba77a7a698587faaae455bbfe740923c1f5)
1 /*	$NetBSD: curses_private.h,v 1.16 2001/06/13 10:45:57 wiz 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 /* Private structure definitions for curses. */
33 /*
34  * A window an array of __LINE structures pointed to by the 'lines' pointer.
35  * A line is an array of __LDATA structures pointed to by the 'line' pointer.
36  *
37  * IMPORTANT: the __LDATA structure must NOT induce any padding, so if new
38  * fields are added -- padding fields with *constant values* should ensure
39  * that the compiler will not generate any padding when storing an array of
40  *  __LDATA structures.  This is to enable consistent use of memcmp, and memcpy
41  * for comparing and copying arrays.
42  */
43 
44 struct __ldata {
45 	wchar_t	ch;			/* Character */
46 	attr_t	attr;			/* Attributes */
47 	wchar_t	bch;			/* Background character */
48 	attr_t	battr;			/* Background attributes */
49 };
50 
51 #define __LDATASIZE	(sizeof(__LDATA))
52 
53 struct __line {
54 #define	__ISDIRTY	0x01		/* Line is dirty. */
55 #define __ISPASTEOL	0x02		/* Cursor is past end of line */
56 	unsigned int flags;
57 	unsigned int hash;		/* Hash value for the line. */
58 	int *firstchp, *lastchp;	/* First and last chngd columns ptrs */
59 	int firstch, lastch;		/* First and last changed columns. */
60 	__LDATA *line;			/* Pointer to the line text. */
61 };
62 
63 struct __window {		/* Window structure. */
64 	struct __window	*nextp, *orig;	/* Subwindows list and parent. */
65 	int begy, begx;			/* Window home. */
66 	int cury, curx;			/* Current x, y coordinates. */
67 	int maxy, maxx;			/* Maximum values for curx, cury. */
68 	short ch_off;			/* x offset for firstch/lastch. */
69 	__LINE **lines;			/* Array of pointers to the lines */
70 	__LINE  *lspace;		/* line space (for cleanup) */
71 	__LDATA *wspace;		/* window space (for cleanup) */
72 
73 #define	__ENDLINE	0x00000001	/* End of screen. */
74 #define	__FLUSH		0x00000002	/* Fflush(stdout) after refresh. */
75 #define	__FULLWIN	0x00000004	/* Window is a screen. */
76 #define	__IDLINE	0x00000008	/* Insert/delete sequences. */
77 #define	__SCROLLWIN	0x00000010	/* Last char will scroll window. */
78 #define	__SCROLLOK	0x00000020	/* Scrolling ok. */
79 #define	__CLEAROK	0x00000040	/* Clear on next refresh. */
80 #define	__LEAVEOK	0x00000100	/* If cursor left */
81 #define	__KEYPAD	0x00010000	/* If interpreting keypad codes */
82 #define	__NOTIMEOUT	0x00020000	/* Wait indefinitely for func keys */
83 	unsigned int flags;
84 	int	delay;			/* delay for getch() */
85 	attr_t	wattr;			/* Character attributes */
86 	wchar_t	bch;			/* Background character */
87 	attr_t	battr;			/* Background attributes */
88 	int	scr_t, scr_b;		/* Scrolling region top, bottom */
89 };
90 
91 /* Set of attributes unset by 'me' - 'mb', 'md', 'mh', 'mk', 'mp' and 'mr'. */
92 #define	__TERMATTR \
93 	(__REVERSE | __BLINK | __DIM | __BOLD | __BLANK | __PROTECT)
94 
95 struct __winlist {
96 	struct __window		*winp;	/* The window. */
97 	struct __winlist	*nextp;	/* Next window. */
98 };
99 
100 /* Private variables. */
101 extern char	 __GT;			/* Gtty indicates tabs. */
102 extern char	 __NONL;		/* Term can't hack LF doing a CR. */
103 extern char	 __UPPERCASE;		/* Terminal is uppercase only. */
104 
105 extern int	 My_term;		/* Use Def_term regardless. */
106 extern const char	*Def_term;	/* Default terminal type. */
107 
108 /* Private functions. */
109 #ifdef DEBUG
110 void	 __CTRACE(const char *fmt, ...);
111 #endif
112 int	 __delay(void);
113 unsigned int __hash(char *s, int len);
114 void	 __id_subwins(WINDOW *orig);
115 void	 __init_getch(void);
116 void	 __init_acs(void);
117 char	*__longname(char *bp, char *def);	/* Original BSD version */
118 int	 __mvcur(int ly, int lx, int y, int x, int in_refresh);
119 int	 __nodelay(void);
120 int	 __notimeout(void);
121 char	*__parse_cap(const char *, ...);
122 void	 __restartwin(void);
123 void	 __restore_colors(void);
124 void     __restore_cursor_vis(void);
125 void     __restore_meta_state(void);
126 void	 __restore_termios(void);
127 void	 __restore_stophandler(void);
128 void	 __save_termios(void);
129 void	 __set_color(attr_t attr);
130 void	 __set_stophandler(void);
131 void	 __set_subwin(WINDOW *orig, WINDOW *win);
132 void	 __startwin(void);
133 void	 __stop_signal_handler(int signo);
134 int	 __stopwin(void);
135 void	 __swflags(WINDOW *win);
136 int	 __timeout(int delay);
137 int	 __touchline(WINDOW *win, int y, int sx, int ex);
138 int	 __touchwin(WINDOW *win);
139 char	*__tscroll(const char *cap, int n1, int n2);
140 void	 __unsetattr(int);
141 int	 __waddch(WINDOW *win, __LDATA *dp);
142 int	 __wgetnstr(WINDOW *, char *, int);
143 
144 /* Private #defines. */
145 #define	min(a,b)	(a < b ? a : b)
146 #define	max(a,b)	(a > b ? a : b)
147 
148 /* Private externs. */
149 extern int		 __echoit;
150 extern int		 __endwin;
151 extern int		 __pfast;
152 extern int		 __rawmode;
153 extern int		 __noqch;
154 extern attr_t		 __nca;
155 extern attr_t		 __mask_op, __mask_me, __mask_ue, __mask_se;
156 extern struct __winlist	*__winlistp;
157 extern WINDOW		*__virtscr;
158