xref: /csrg-svn/lib/libcurses/curses.h (revision 56238)
1 /*
2  * Copyright (c) 1981 Regents of the University of California.
3  * All rights reserved.
4  *
5  * %sccs.include.redist.c%
6  *
7  *	@(#)curses.h	5.13 (Berkeley) 09/14/92
8  */
9 
10 #ifndef _CURSES_H_
11 #define	_CURSES_H_
12 
13 #include <stdio.h>
14 
15 /*
16  * The following #defines and #includes are present for backward
17  * compatibility only.  They should not be used in future code.
18  *
19  * START BACKWARD COMPATIBILITY ONLY.
20  */
21 #ifndef _CURSES_PRIVATE
22 #define	bool	char
23 #define	reg	register
24 
25 #ifndef TRUE
26 #define	TRUE	(1)
27 #endif
28 #ifndef FALSE
29 #define	FALSE	(0)
30 #endif
31 
32 #define	_puts(s)	tputs(s, 0, __cputchar)
33 #define	_putchar(c)	__cputchar(c)
34 
35 /* Old-style terminal modes access. */
36 #define	baudrate()	(cfgetospeed(&origtermio))
37 #define	crmode()	cbreak()
38 #define	erasechar()	(origtermio.c_cc[VERASE])
39 #define	killchar()	(origtermio.c_cc[VKILL])
40 #define	nocrmode()	nocbreak()
41 #define	ospeed		(cfgetospeed(&origtermio))
42 #endif /* _CURSES_PRIVATE */
43 
44 extern int	 My_term;		/* Use Def_term regardless. */
45 extern char	*Def_term;		/* Default terminal type. */
46 
47 /* END BACKWARD COMPATIBILITY ONLY. */
48 
49 /* 7-bit ASCII characters. */
50 #define	unctrl(c)		__unctrl[(c) & 0x7f]
51 #define	unctrllen(ch)		__unctrllen[(ch) & 0x7f]
52 
53 /*
54  * A window is a circular doubly linked list of LINEs who's first line is
55  * given by the topline pointer in the WINDOW structure.
56  */
57 
58 typedef struct __line {
59 	struct __line *next, *prev;	/* Next line, previous line. */
60 #define	__ISDIRTY	0x01		/* Line is dirty. */
61 	u_int flags;
62 	u_int hash;			/* Hash value for the line. */
63 	size_t firstch, lastch;		/* First and last changed columns. */
64 /*
65  * XXX
66  * _STANDOUT is the 8th bit, characters themselves are encoded.
67  */
68 #define	__STANDOUT	0x080		/* Added characters are standout. */
69 	char *line;			/* Pointer to line itself. */
70 } LINE;
71 
72 typedef struct __window {		/* Window structure. */
73 	struct __window	*nextp, *orig;	/* Subwindows list and parent. */
74 	size_t begy, begx;		/* Window home. */
75 	size_t cury, curx;		/* Current x, y coordinates. */
76 	size_t maxy, maxx;		/* Maximum values for curx, cury. */
77 	short ch_off;			/* x offset for firstch/lastch. */
78 	LINE **lines;			/* Array of pointers to the lines */
79 	LINE *topline;			/* Pointer to first line in window */
80 	char *wspace;			/* window space (for cleanup) */
81 
82 #define	__ENDLINE	0x001		/* End of screen. */
83 #define	__FLUSH		0x002		/* Fflush(stdout) after refresh. */
84 #define	__FULLLINE	0x004		/* Line width = terminal width. */
85 #define	__FULLWIN	0x008		/* Window is a screen. */
86 #define	__IDLINE	0x010		/* Insert/delete sequences. */
87 #define	__SCROLLWIN	0x020		/* Last char will scroll window. */
88 #define	__SCROLLOK	0x040		/* Scrolling ok. */
89 #define	__CLEAROK	0x080		/* Clear on next refresh. */
90 #define __WSTANDOUT	0x100		/* Standout window */
91 #define __LEAVEOK	0x200		/* If curser left */
92 	u_int flags;
93 } WINDOW;
94 
95 /* Termcap capabilities. */
96 extern char	AM, BS, CA, DA, EO, HC, HZ, IN, MI, MS, NC, NS, OS,
97 		PC, UL, XB, XN, XT, XS, XX;
98 extern char	*AL, *BC, *BT, *CD, *CE, *CL, *CM, *CR, *CS, *DC, *DL,
99 		*DM, *DO, *ED, *EI, *K0, *K1, *K2, *K3, *K4, *K5, *K6,
100 		*K7, *K8, *K9, *HO, *IC, *IM, *IP, *KD, *KE, *KH, *KL,
101 		*KR, *KS, *KU, *LL, *MA, *ND, *NL, *RC, *SC, *SE, *SF,
102 		*SO, *SR, *TA, *TE, *TI, *UC, *UE, *UP, *US, *VB, *VS,
103 		*VE,
104 		*AL_PARM, *DL_PARM, *UP_PARM, *DOWN_PARM, *LEFT_PARM,
105 		*RIGHT_PARM;
106 
107 /* Curses external declarations. */
108 extern WINDOW	*curscr;		/* Current screen. */
109 extern WINDOW	*stdscr;		/* Standard screen. */
110 
111 extern struct termios origtermio;	/* Original terminal modes. */
112 
113 extern int	 COLS;			/* Columns on the screen. */
114 extern int	 LINES;			/* Lines on the screen. */
115 
116 extern char	 GT;			/* Gtty indicates tabs. */
117 extern char	 NONL;			/* Term can't hack LF doing a CR. */
118 extern char	 UPPERCASE;		/* Terminal is uppercase only. */
119 extern char	*ttytype;		/* Full name of current terminal. */
120 extern char	*__unctrl[0x80];	/* Control strings. */
121 extern char	 __unctrllen[0x80];	/* Control strings length. */
122 
123 #define	ERR	(0)			/* Error return. */
124 #define	OK	(1)			/* Success return. */
125 
126 /* Standard screen pseudo functions. */
127 #define	addbytes(da, co)	waddbytes(stdscr, da, co)
128 #define	addch(ch)		waddch(stdscr, ch)
129 #define	addstr(str)		waddbytes(stdscr, str, strlen(str))
130 #define	clear()			wclear(stdscr)
131 #define	clrtobot()		wclrtobot(stdscr)
132 #define	clrtoeol()		wclrtoeol(stdscr)
133 #define	delch()			wdelch(stdscr)
134 #define	deleteln()		wdeleteln(stdscr)
135 #define	erase()			werase(stdscr)
136 #define	getch()			wgetch(stdscr)
137 #define	getstr(str)		wgetstr(stdscr, str)
138 #define	inch()			winch(stdscr)
139 #define	insch(ch))		winsch(stdscr, ch)
140 #define	insertln()		winsertln(stdscr)
141 #define	move(y, x)		wmove(stdscr, y, x)
142 #define	refresh()		wrefresh(stdscr)
143 #define	standend()		wstandend(stdscr)
144 #define	standout()		wstandout(stdscr)
145 
146 /* Standard screen plus movement pseudo functions. */
147 #define	mvaddbytes(y, x, da, co) \
148 				mvwaddbytes(stdscr, y, x, da, co)
149 #define	mvaddch(y, x, ch)	mvwaddch(stdscr, y, x, ch)
150 #define	mvaddstr(y, x, str)	mvwaddstr(stdscr, y, x, str)
151 #define	mvdelch(y, x)		mvwdelch(stdscr, y, x)
152 #define	mvgetch(y, x)		mvwgetch(stdscr, y, x)
153 #define	mvgetstr(y, x, str)	mvwgetstr(stdscr, y, x, str)
154 #define	mvinch(y, x)		mvwinch(stdscr, y, x)
155 #define	mvinsch(y, x, c)	mvwinsch(stdscr, y, x, c)
156 #define	mvwaddbytes(win, y, x, da, co) \
157 				(wmove(win, y, x) == ERR ? \
158 				    ERR : waddbytes(win, da, co))
159 #define	mvwaddch(win, y, x, ch)	(wmove(win, y, x) == ERR ? \
160 				    ERR : waddch(win, ch))
161 #define	mvwaddstr(win, y, x, str) \
162 				(wmove(win, y, x) == ERR ? \
163 				    ERR : waddbytes(win, str, strlen(str)))
164 #define	mvwdelch(win, y, x)	(wmove(win, y, x) == ERR ? ERR : wdelch(win))
165 #define	mvwgetch(win, y, x)	(wmove(win, y, x) == ERR ? ERR : wgetch(win))
166 #define	mvwgetstr(win, y, x, str) \
167 				(wmove(win, y, x) == ERR ? \
168 				    ERR : wgetstr(win, str))
169 #define	mvwinch(win, y, x)	(wmove(win, y, x) == ERR ? ERR : winch(win))
170 #define	mvwinsch(win, y, x, c)	(wmove(win, y, x) == ERR ? ERR : winsch(win, c))
171 
172 /* Random psuedo functions. */
173 #define	clearok(win, bf)  ((bf) ? (win->flags |= __CLEAROK) : \
174 				  (win->flags &= ~__CLEAROK))
175 #define	flushok(win, bf)  ((bf) ? (win->flags |= __FLUSH) : \
176 				  (win->flags &= ~__FLUSH))
177 #define	scrollok(win, bf) ((bf) ? (win->flags |= __SCROLLOK) : \
178 				  (win->flags &= ~__SCROLLOK))
179 #define	leaveok(win, bf)  ((bf) ? (win->flags |= __LEAVEOK) : \
180 				  (win->flags &= ~__LEAVEOK))
181 #define	getyx(win, y, x)	(y) = win->cury, (x) = win->curx
182 #define	winch(win)		(win->lines[win->cury]->line[win->curx] & 0177)
183 
184 /* Public function prototypes. */
185 void	 __cputchar __P((int));
186 int	 _sprintw __P((WINDOW *, const char *, _BSD_VA_LIST_));
187 int	 box __P((WINDOW *, int, int));
188 int	 cbreak __P((void));
189 int	 delwin __P((WINDOW *));
190 int	 echo __P((void));
191 int	 endwin __P((void));
192 char	*fullname __P((char *, char *));
193 char	*getcap __P((char *));
194 int	 gettmode __P((void));
195 void	 idlok __P((WINDOW *, int));
196 WINDOW	*initscr __P((void));
197 char	*longname __P((char *, char *));
198 int	 mvcur __P((int, int, int, int));
199 int	 mvprintw __P((int, int, const char *, ...));
200 int	 mvscanw __P((int, int, const char *, ...));
201 int	 mvwin __P((WINDOW *, int, int));
202 int	 mvwprintw __P((WINDOW *, int, int, const char *, ...));
203 int	 mvwscanw __P((WINDOW *, int, int, const char *, ...));
204 WINDOW	*newwin __P((int, int, int, int));
205 int	 nl __P((void));
206 int	 nocbreak __P((void));
207 int	 noecho __P((void));
208 int	 nonl __P((void));
209 int	 noraw __P((void));
210 int	 overlay __P((WINDOW *, WINDOW *));
211 int	 overwrite __P((WINDOW *, WINDOW *));
212 int	 printw __P((const char *, ...));
213 int	 raw __P((void));
214 int	 resetty __P((void));
215 int	 savetty __P((void));
216 int	 scanw __P((const char *, ...));
217 int	 scroll __P((WINDOW *));
218 int	 setterm __P((char *));
219 int	 sscans __P((WINDOW *, const char *, _BSD_VA_LIST_));
220 WINDOW	*subwin __P((WINDOW *, int, int, int, int));
221 int	 suspendwin __P((void));
222 int	 touchline __P((WINDOW *, int, int, int));
223 int	 touchoverlap __P((WINDOW *, WINDOW *));
224 int	 touchwin __P((WINDOW *));
225 void	 tstp __P((int));
226 int	 waddch __P((WINDOW *, int));
227 int	 waddstr __P((WINDOW *, char *));
228 int	 wclear __P((WINDOW *));
229 int	 wclrtobot __P((WINDOW *));
230 int	 wclrtoeol __P((WINDOW *));
231 int	 wdelch __P((WINDOW *));
232 int	 wdeleteln __P((WINDOW *));
233 int	 werase __P((WINDOW *));
234 int	 wgetch __P((WINDOW *));
235 int	 wgetstr __P((WINDOW *, char *));
236 int	 winsch __P((WINDOW *, int));
237 int	 winsertln __P((WINDOW *));
238 int	 wmove __P((WINDOW *, int, int));
239 int	 wprintw __P((WINDOW *, const char *, ...));
240 int	 wrefresh __P((WINDOW *));
241 int	 wscanw __P((WINDOW *, const char *, ...));
242 char	*wstandend __P((WINDOW *));
243 char	*wstandout __P((WINDOW *));
244 
245 #ifdef _CURSES_PRIVATE
246 /* Private function prototypes. */
247 void	 __id_subwins __P((WINDOW *));
248 void	 __set_subwin __P((WINDOW *, WINDOW *));
249 void	 __swflags __P((WINDOW *));
250 void	 __TRACE __P((const char *, ...));
251 int	 waddbytes __P((WINDOW *, char *, int));
252 
253 /* Private #defines. */
254 #define	min(a,b)	(a < b ? a : b)
255 #define	max(a,b)	(a > b ? a : b)
256 
257 /* Private externs. */
258 extern int	 __echoit;
259 extern int	 __endwin;
260 extern int	 __pfast;
261 extern int	 __rawmode;
262 #endif
263 
264 /* Termcap functions. */
265 int	 tgetent __P((char *, char *));
266 int	 tgetnum __P((char *));
267 int	 tgetflag __P((char *));
268 char	*tgetstr __P((char *, char **));
269 char	*tgoto __P((char *, int, int));
270 int	 tputs __P((char *, int, void (*)(int)));
271 
272 #endif /* !_CURSES_H_ */
273