xref: /csrg-svn/lib/libcurses/curses.h (revision 56596)
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.16 (Berkeley) 10/20/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 #define __ISPASTEOL	0x02		/* Cursor is past end of line */
62 	u_int flags;
63 	u_int hash;			/* Hash value for the line. */
64 	size_t firstch, lastch;		/* First and last changed columns. */
65 
66 #define	__STANDOUT	0x01  		/* Added characters are standout. */
67 	char *standout;			/* Standout character markers.
68 					 * This field is stored as an
69 					 * extension to the line, i.e.,
70 					 * lp->standout = lp->line + win->maxx
71 					 * is an invariant.
72 					 */
73 
74 	char *line;			/* Pointer to the line text. */
75 } LINE;
76 
77 typedef struct __window {		/* Window structure. */
78 	struct __window	*nextp, *orig;	/* Subwindows list and parent. */
79 	size_t begy, begx;		/* Window home. */
80 	size_t cury, curx;		/* Current x, y coordinates. */
81 	size_t maxy, maxx;		/* Maximum values for curx, cury. */
82 	short ch_off;			/* x offset for firstch/lastch. */
83 	LINE **lines;			/* Array of pointers to the lines */
84 	LINE *topline;			/* Pointer to first line in window */
85 	char *wspace;			/* window space (for cleanup) */
86 
87 #define	__ENDLINE	0x001		/* End of screen. */
88 #define	__FLUSH		0x002		/* Fflush(stdout) after refresh. */
89 #define	__FULLLINE	0x004		/* Line width = terminal width. */
90 #define	__FULLWIN	0x008		/* Window is a screen. */
91 #define	__IDLINE	0x010		/* Insert/delete sequences. */
92 #define	__SCROLLWIN	0x020		/* Last char will scroll window. */
93 #define	__SCROLLOK	0x040		/* Scrolling ok. */
94 #define	__CLEAROK	0x080		/* Clear on next refresh. */
95 #define __WSTANDOUT	0x100		/* Standout window */
96 #define __LEAVEOK	0x200		/* If curser left */
97 	u_int flags;
98 } WINDOW;
99 
100 /* Termcap capabilities. */
101 extern char	AM, BS, CA, DA, EO, HC, HZ, IN, MI, MS, NC, NS, OS,
102 		PC, UL, XB, XN, XT, XS, XX;
103 extern char	*AL, *BC, *BT, *CD, *CE, *CL, *CM, *CR, *CS, *DC, *DL,
104 		*DM, *DO, *ED, *EI, *K0, *K1, *K2, *K3, *K4, *K5, *K6,
105 		*K7, *K8, *K9, *HO, *IC, *IM, *IP, *KD, *KE, *KH, *KL,
106 		*KR, *KS, *KU, *LL, *MA, *ND, *NL, *RC, *SC, *SE, *SF,
107 		*SO, *SR, *TA, *TE, *TI, *UC, *UE, *UP, *US, *VB, *VS,
108 		*VE, *al, *dl, *sf, *sr,
109 		*AL_PARM, *DL_PARM, *UP_PARM, *DOWN_PARM, *LEFT_PARM,
110 		*RIGHT_PARM;
111 
112 /* Curses external declarations. */
113 extern WINDOW	*curscr;		/* Current screen. */
114 extern WINDOW	*stdscr;		/* Standard screen. */
115 
116 extern struct termios origtermio;	/* Original terminal modes. */
117 
118 extern int	 COLS;			/* Columns on the screen. */
119 extern int	 LINES;			/* Lines on the screen. */
120 
121 extern char	 GT;			/* Gtty indicates tabs. */
122 extern char	 NONL;			/* Term can't hack LF doing a CR. */
123 extern char	 UPPERCASE;		/* Terminal is uppercase only. */
124 extern char	*ttytype;		/* Full name of current terminal. */
125 extern char	*__unctrl[0x80];	/* Control strings. */
126 extern char	 __unctrllen[0x80];	/* Control strings length. */
127 
128 #define	ERR	(0)			/* Error return. */
129 #define	OK	(1)			/* Success return. */
130 
131 /* Standard screen pseudo functions. */
132 #define	addbytes(da, co)	waddbytes(stdscr, da, co)
133 #define	addch(ch)		waddch(stdscr, ch)
134 #define	addstr(str)		waddbytes(stdscr, str, strlen(str))
135 #define	clear()			wclear(stdscr)
136 #define	clrtobot()		wclrtobot(stdscr)
137 #define	clrtoeol()		wclrtoeol(stdscr)
138 #define	delch()			wdelch(stdscr)
139 #define	deleteln()		wdeleteln(stdscr)
140 #define	erase()			werase(stdscr)
141 #define	getch()			wgetch(stdscr)
142 #define	getstr(str)		wgetstr(stdscr, str)
143 #define	inch()			winch(stdscr)
144 #define	insch(ch))		winsch(stdscr, ch)
145 #define	insertln()		winsertln(stdscr)
146 #define	move(y, x)		wmove(stdscr, y, x)
147 #define	refresh()		wrefresh(stdscr)
148 #define	standend()		wstandend(stdscr)
149 #define	standout()		wstandout(stdscr)
150 
151 /* Standard screen plus movement pseudo functions. */
152 #define	mvaddbytes(y, x, da, co) \
153 				mvwaddbytes(stdscr, y, x, da, co)
154 #define	mvaddch(y, x, ch)	mvwaddch(stdscr, y, x, ch)
155 #define	mvaddstr(y, x, str)	mvwaddstr(stdscr, y, x, str)
156 #define	mvdelch(y, x)		mvwdelch(stdscr, y, x)
157 #define	mvgetch(y, x)		mvwgetch(stdscr, y, x)
158 #define	mvgetstr(y, x, str)	mvwgetstr(stdscr, y, x, str)
159 #define	mvinch(y, x)		mvwinch(stdscr, y, x)
160 #define	mvinsch(y, x, c)	mvwinsch(stdscr, y, x, c)
161 #define	mvwaddbytes(win, y, x, da, co) \
162 				(wmove(win, y, x) == ERR ? \
163 				    ERR : waddbytes(win, da, co))
164 #define	mvwaddch(win, y, x, ch)	(wmove(win, y, x) == ERR ? \
165 				    ERR : waddch(win, ch))
166 #define	mvwaddstr(win, y, x, str) \
167 				(wmove(win, y, x) == ERR ? \
168 				    ERR : waddbytes(win, str, strlen(str)))
169 #define	mvwdelch(win, y, x)	(wmove(win, y, x) == ERR ? ERR : wdelch(win))
170 #define	mvwgetch(win, y, x)	(wmove(win, y, x) == ERR ? ERR : wgetch(win))
171 #define	mvwgetstr(win, y, x, str) \
172 				(wmove(win, y, x) == ERR ? \
173 				    ERR : wgetstr(win, str))
174 #define	mvwinch(win, y, x)	(wmove(win, y, x) == ERR ? ERR : winch(win))
175 #define	mvwinsch(win, y, x, c)	(wmove(win, y, x) == ERR ? ERR : winsch(win, c))
176 
177 /* Random psuedo functions. */
178 #define	clearok(win, bf)  ((bf) ? (win->flags |= __CLEAROK) : \
179 				  (win->flags &= ~__CLEAROK))
180 #define	flushok(win, bf)  ((bf) ? (win->flags |= __FLUSH) : \
181 				  (win->flags &= ~__FLUSH))
182 #define	scrollok(win, bf) ((bf) ? (win->flags |= __SCROLLOK) : \
183 				  (win->flags &= ~__SCROLLOK))
184 #define	leaveok(win, bf)  ((bf) ? (win->flags |= __LEAVEOK) : \
185 				  (win->flags &= ~__LEAVEOK))
186 #define	getyx(win, y, x)	(y) = win->cury, (x) = win->curx
187 #define	winch(win)		(win->lines[win->cury]->line[win->curx] & 0177)
188 
189 /* Public function prototypes. */
190 void	 __cputchar __P((int));
191 int	 _sprintw __P((WINDOW *, const char *, _BSD_VA_LIST_));
192 int	 box __P((WINDOW *, int, int));
193 int	 cbreak __P((void));
194 int	 delwin __P((WINDOW *));
195 int	 echo __P((void));
196 int	 endwin __P((void));
197 char	*fullname __P((char *, char *));
198 char	*getcap __P((char *));
199 int	 gettmode __P((void));
200 void	 idlok __P((WINDOW *, int));
201 WINDOW	*initscr __P((void));
202 char	*longname __P((char *, char *));
203 int	 mvcur __P((int, int, int, int));
204 int	 mvprintw __P((int, int, const char *, ...));
205 int	 mvscanw __P((int, int, const char *, ...));
206 int	 mvwin __P((WINDOW *, int, int));
207 int	 mvwprintw __P((WINDOW *, int, int, const char *, ...));
208 int	 mvwscanw __P((WINDOW *, int, int, const char *, ...));
209 WINDOW	*newwin __P((int, int, int, int));
210 int	 nl __P((void));
211 int	 nocbreak __P((void));
212 int	 noecho __P((void));
213 int	 nonl __P((void));
214 int	 noraw __P((void));
215 int	 overlay __P((WINDOW *, WINDOW *));
216 int	 overwrite __P((WINDOW *, WINDOW *));
217 int	 printw __P((const char *, ...));
218 int	 raw __P((void));
219 int	 resetty __P((void));
220 int	 savetty __P((void));
221 int	 scanw __P((const char *, ...));
222 int	 scroll __P((WINDOW *));
223 int	 setterm __P((char *));
224 int	 sscans __P((WINDOW *, const char *, _BSD_VA_LIST_));
225 WINDOW	*subwin __P((WINDOW *, int, int, int, int));
226 int	 suspendwin __P((void));
227 int	 touchline __P((WINDOW *, int, int, int));
228 int	 touchoverlap __P((WINDOW *, WINDOW *));
229 int	 touchwin __P((WINDOW *));
230 void	 tstp __P((int));
231 int	 waddch __P((WINDOW *, int));
232 int	 waddstr __P((WINDOW *, char *));
233 int	 wclear __P((WINDOW *));
234 int	 wclrtobot __P((WINDOW *));
235 int	 wclrtoeol __P((WINDOW *));
236 int	 wdelch __P((WINDOW *));
237 int	 wdeleteln __P((WINDOW *));
238 int	 werase __P((WINDOW *));
239 int	 wgetch __P((WINDOW *));
240 int	 wgetstr __P((WINDOW *, char *));
241 int	 winsch __P((WINDOW *, int));
242 int	 winsertln __P((WINDOW *));
243 int	 wmove __P((WINDOW *, int, int));
244 int	 wprintw __P((WINDOW *, const char *, ...));
245 int	 wrefresh __P((WINDOW *));
246 int	 wscanw __P((WINDOW *, const char *, ...));
247 char	*wstandend __P((WINDOW *));
248 char	*wstandout __P((WINDOW *));
249 
250 #ifdef _CURSES_PRIVATE
251 /* Private function prototypes. */
252 void	 __id_subwins __P((WINDOW *));
253 void	 __set_subwin __P((WINDOW *, WINDOW *));
254 void	 __swflags __P((WINDOW *));
255 void	 __TRACE __P((const char *, ...));
256 int	 waddbytes __P((WINDOW *, char *, int));
257 char	*tscroll __P((const char *, int));
258 
259 /* Private #defines. */
260 #define	min(a,b)	(a < b ? a : b)
261 #define	max(a,b)	(a > b ? a : b)
262 
263 /* Private externs. */
264 extern int	 __echoit;
265 extern int	 __endwin;
266 extern int	 __pfast;
267 extern int	 __rawmode;
268 extern int	 __noqch;
269 #endif
270 
271 /* Termcap functions. */
272 int	 tgetent __P((char *, char *));
273 int	 tgetnum __P((char *));
274 int	 tgetflag __P((char *));
275 char	*tgetstr __P((char *, char **));
276 char	*tgoto __P((char *, int, int));
277 int	 tputs __P((char *, int, void (*)(int)));
278 
279 #endif /* !_CURSES_H_ */
280