xref: /netbsd-src/lib/libcurses/setterm.c (revision 7f21db1c0118155e0dd40b75182e30c589d9f63e)
1 /*	$NetBSD: setterm.c,v 1.46 2010/02/03 15:34:40 roy Exp $	*/
2 
3 /*
4  * Copyright (c) 1981, 1993, 1994
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31 
32 #include <sys/cdefs.h>
33 #ifndef lint
34 #if 0
35 static char sccsid[] = "@(#)setterm.c	8.8 (Berkeley) 10/25/94";
36 #else
37 __RCSID("$NetBSD: setterm.c,v 1.46 2010/02/03 15:34:40 roy Exp $");
38 #endif
39 #endif /* not lint */
40 
41 #include <sys/ioctl.h>		/* TIOCGWINSZ on old systems. */
42 
43 #include <stdlib.h>
44 #include <string.h>
45 #include <termios.h>
46 #include <unistd.h>
47 
48 #include "curses.h"
49 #include "curses_private.h"
50 
51 static int does_esc_m(const char *cap);
52 static int does_ctrl_o(const char *cap);
53 
54 attr_t	 __mask_op, __mask_me, __mask_ue, __mask_se;
55 
56 int
57 setterm(char *type)
58 {
59 	return _cursesi_setterm(type, _cursesi_screen);
60 }
61 
62 int
63 _cursesi_setterm(char *type, SCREEN *screen)
64 {
65 	int unknown, r;
66 	struct winsize win;
67 	char *p;
68 
69 	if (type[0] == '\0')
70 		type = "xx";
71 	unknown = 0;
72 	(void)ti_setupterm(&screen->term, type, fileno(screen->outfd), &r);
73 	if (screen->term == NULL) {
74 		unknown++;
75 		(void)ti_setupterm(&screen->term, "dumb",
76 		    fileno(screen->outfd), &r);
77 		/* No dumb term? We can't continue */
78 		if (screen->term == NULL)
79 			return ERR;
80 	}
81 #ifdef DEBUG
82 	__CTRACE(__CTRACE_INIT, "setterm: tty = %s\n", type);
83 #endif
84 
85 	/* Try TIOCGWINSZ, and, if it fails, the termcap entry. */
86 	if (ioctl(fileno(screen->outfd), TIOCGWINSZ, &win) != -1 &&
87 	    win.ws_row != 0 && win.ws_col != 0) {
88 		screen->LINES = win.ws_row;
89 		screen->COLS = win.ws_col;
90 	}  else {
91 		if (unknown) {
92 			screen->LINES = -1;
93 			screen->COLS = -1;
94 		} else {
95 			screen->LINES = t_lines(screen->term);
96 			screen->COLS = t_columns(screen->term);
97 		}
98 
99 	}
100 
101 	/* POSIX 1003.2 requires that the environment override. */
102 	if ((p = getenv("LINES")) != NULL)
103 		screen->LINES = (int) strtol(p, NULL, 0);
104 	if ((p = getenv("COLUMNS")) != NULL)
105 		screen->COLS = (int) strtol(p, NULL, 0);
106 	if ((p = getenv("ESCDELAY")) != NULL)
107 		ESCDELAY = (int) strtol(p, NULL, 0);
108 
109 	/*
110 	 * Want cols > 4, otherwise things will fail.
111 	 */
112 	if (screen->COLS <= 4)
113 		return (ERR);
114 
115 	LINES = screen->LINES;
116 	COLS = screen->COLS;
117 
118 #ifdef DEBUG
119 	__CTRACE(__CTRACE_INIT, "setterm: LINES = %d, COLS = %d\n",
120 	    LINES, COLS);
121 #endif
122 
123 	/*
124 	 * set the pad char, only take the first char of the pc capability
125 	 * as this is all we can use.
126 	 */
127 	screen->padchar = t_pad_char(screen->term) ?
128 	    t_pad_char(screen->term)[0] : 0;
129 
130 	/* Get full name of terminal */
131 	if (unknown) {
132 		strcpy(screen->ttytype, "dumb");
133 		return ERR;
134 	}
135 	strlcpy(screen->ttytype, screen->term->desc,
136 		sizeof(screen->ttytype));
137 
138 	/* If no scrolling commands, no quick change. */
139 	screen->noqch =
140   	    (t_change_scroll_region(screen->term) == NULL ||
141 		t_cursor_home(screen->term) == NULL ||
142 		(t_parm_index(screen->term) == NULL &&
143 		    t_scroll_forward(screen->term) == NULL) ||
144 		(t_parm_rindex(screen->term) == NULL &&
145 		    t_scroll_reverse(screen->term) == NULL)) &&
146 	    ((t_parm_insert_line(screen->term) == NULL &&
147 		t_insert_line(screen->term) == NULL) ||
148 		(t_parm_delete_line(screen->term) == NULL &&
149 		    t_delete_line(screen->term) == NULL));
150 
151 	/*
152 	 * Precalculate conflict info for color/attribute end commands.
153 	 */
154 #ifndef HAVE_WCHAR
155 	screen->mask_op = __ATTRIBUTES & ~__COLOR;
156 #else
157 	screen->mask_op = WA_ATTRIBUTES & ~__COLOR;
158 #endif /* HAVE_WCHAR */
159 	if (t_orig_pair(screen->term) != NULL) {
160 		if (does_esc_m(t_orig_pair(screen->term)))
161 			screen->mask_op &=
162 			    ~(__STANDOUT | __UNDERSCORE | __TERMATTR);
163 		else {
164 			if (t_exit_standout_mode(screen->term) != NULL &&
165 			    !strcmp(t_orig_pair(screen->term),
166 				t_exit_standout_mode(screen->term)))
167 				screen->mask_op &= ~__STANDOUT;
168 			if (t_exit_underline_mode(screen->term) != NULL &&
169 			    !strcmp(t_orig_pair(screen->term),
170 				t_exit_underline_mode(screen->term)))
171 				screen->mask_op &= ~__UNDERSCORE;
172 			if (t_exit_attribute_mode(screen->term) != NULL &&
173 			    !strcmp(t_orig_pair(screen->term),
174 				t_exit_attribute_mode(screen->term)))
175 				screen->mask_op &= ~__TERMATTR;
176 		}
177 	}
178 	/*
179 	 * Assume that "me" turns off all attributes apart from ACS.
180 	 * It might turn off ACS, so check for that.
181 	 */
182 	if (t_exit_attribute_mode(screen->term) != NULL &&
183 	    does_ctrl_o(t_exit_attribute_mode(screen->term)))
184 		screen->mask_me = 0;
185 	else
186 		screen->mask_me = __ALTCHARSET;
187 
188 	/* Check what turning off the attributes also turns off */
189 #ifndef HAVE_WCHAR
190 	screen->mask_ue = __ATTRIBUTES & ~__UNDERSCORE;
191 #else
192 	screen->mask_ue = WA_ATTRIBUTES & ~__UNDERSCORE;
193 #endif /* HAVE_WCHAR */
194 	if (t_exit_underline_mode(screen->term) != NULL) {
195 		if (does_esc_m(t_exit_underline_mode(screen->term)))
196 			screen->mask_ue &=
197 			    ~(__STANDOUT | __TERMATTR | __COLOR);
198 		else {
199 			if (t_exit_standout_mode(screen->term) != NULL &&
200 			    !strcmp(t_exit_underline_mode(screen->term),
201 				t_exit_standout_mode(screen->term)))
202 				screen->mask_ue &= ~__STANDOUT;
203 			if (t_exit_attribute_mode(screen->term) != NULL &&
204 			    !strcmp(t_exit_underline_mode(screen->term),
205 				t_exit_attribute_mode(screen->term)))
206 				screen->mask_ue &= ~__TERMATTR;
207 			if (t_orig_pair(screen->term) != NULL &&
208 			    !strcmp(t_exit_underline_mode(screen->term),
209 				t_orig_pair(screen->term)))
210 				screen->mask_ue &= ~__COLOR;
211 		}
212 	}
213 #ifndef HAVE_WCHAR
214 	screen->mask_se = __ATTRIBUTES & ~__STANDOUT;
215 #else
216 	screen->mask_se = WA_ATTRIBUTES & ~__STANDOUT;
217 #endif /* HAVE_WCHAR */
218 	if (t_exit_standout_mode(screen->term) != NULL) {
219 		if (does_esc_m(t_exit_standout_mode(screen->term)))
220 			screen->mask_se &=
221 			    ~(__UNDERSCORE | __TERMATTR | __COLOR);
222 		else {
223 			if (t_exit_underline_mode(screen->term) != NULL &&
224 			    !strcmp(t_exit_standout_mode(screen->term),
225 				t_exit_underline_mode(screen->term)))
226 				screen->mask_se &= ~__UNDERSCORE;
227 			if (t_exit_attribute_mode(screen->term) != NULL &&
228 			    !strcmp(t_exit_standout_mode(screen->term),
229 				t_exit_attribute_mode(screen->term)))
230 				screen->mask_se &= ~__TERMATTR;
231 			if (t_orig_pair(screen->term) != NULL &&
232 			    !strcmp(t_exit_standout_mode(screen->term),
233 				t_orig_pair(screen->term)))
234 				screen->mask_se &= ~__COLOR;
235 		}
236 	}
237 
238 	return (unknown ? ERR : OK);
239 }
240 
241 /*
242  * _cursesi_resetterm --
243  *  Copy the terminal instance data for the given screen to the global
244  *  variables.
245  */
246 void
247 _cursesi_resetterm(SCREEN *screen)
248 {
249 
250 	LINES = screen->LINES;
251 	COLS = screen->COLS;
252 	__GT = screen->GT;
253 
254 	__noqch = screen->noqch;
255 	__mask_op = screen->mask_op;
256 	__mask_me = screen->mask_me;
257 	__mask_ue = screen->mask_ue;
258 	__mask_se = screen->mask_se;
259 
260 	set_curterm(screen->term);
261 }
262 
263 /*
264  * does_esc_m --
265  * A hack for xterm-like terminals where "\E[m" or "\E[0m" will turn off
266  * other attributes, so we check for this in the capability passed to us.
267  * Note that we can't just do simple string comparison, as the capability
268  * may contain multiple, ';' separated sequence parts.
269  */
270 static int
271 does_esc_m(const char *cap)
272 {
273 #define WAITING 0
274 #define PARSING 1
275 #define NUMBER 2
276 #define FOUND 4
277 	const char *capptr;
278 	int seq;
279 
280 #ifdef DEBUG
281 	__CTRACE(__CTRACE_INIT, "does_esc_m: Checking %s\n", cap);
282 #endif
283 	/* Is it just "\E[m" or "\E[0m"? */
284 	if (!strcmp(cap, "\x1b[m") || !strcmp(cap, "\x1b[0m"))
285 		return 1;
286 
287 	/* Does it contain a "\E[...m" sequence? */
288 	if (strlen(cap) < 4)
289 		return 0;
290 	capptr = cap;
291 	seq = WAITING;
292 	while (*capptr != 0) {
293 		switch (seq) {
294 		/* Start of sequence */
295 		case WAITING:
296 			if (!strncmp(capptr, "\x1b[", 2)) {
297 				capptr+=2;
298 				if (*capptr == 'm')
299 					return 1;
300 				else {
301 					seq=PARSING;
302 					continue;
303 				}
304 			}
305 			break;
306 		/* Looking for '0' */
307 		case PARSING:
308 			if (*capptr == '0')
309 				seq=FOUND;
310 			else if (*capptr > '0' && *capptr <= '9')
311 				seq=NUMBER;
312 			else if (*capptr != ';')
313 				seq=WAITING;
314 			break;
315 		/* Some other number */
316 		case NUMBER:
317 			if (*capptr == ';')
318 				seq=PARSING;
319 			else if (!(*capptr >= '0' && *capptr <= '9'))
320 				seq=WAITING;
321 			break;
322 		/* Found a '0' */
323 		case FOUND:
324 			if (*capptr == 'm')
325 				return 1;
326 			else if (!((*capptr >= '0' && *capptr <= '9') ||
327 			    *capptr == ';'))
328 				seq=WAITING;
329 			break;
330 		default:
331 			break;
332 		}
333 		capptr++;
334 	}
335 	return 0;
336 }
337 
338 /*
339  * does_ctrl_o --
340  * A hack for vt100/xterm-like terminals where the "me" capability also
341  * unsets acs (i.e. it contains the character '\017').
342  */
343 static int
344 does_ctrl_o(const char *cap)
345 {
346 	const char *capptr = cap;
347 
348 #ifdef DEBUG
349 	__CTRACE(__CTRACE_INIT, "does_ctrl_o: Looping on %s\n", capptr);
350 #endif
351 	while (*capptr != 0) {
352 		if (*capptr == '\x0f')
353 			return 1;
354 		capptr++;
355 	}
356 	return 0;
357 }
358