xref: /netbsd-src/lib/libcurses/setterm.c (revision a536ee5124e62c9a0051a252f7833dc8f50f44c9)
1 /*	$NetBSD: setterm.c,v 1.49 2012/04/21 12:27:28 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.49 2012/04/21 12:27:28 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 terminfo 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 	/* If no scrolling commands, no quick change. */
131 	screen->noqch =
132   	    (t_change_scroll_region(screen->term) == NULL ||
133 		t_cursor_home(screen->term) == NULL ||
134 		(t_parm_index(screen->term) == NULL &&
135 		    t_scroll_forward(screen->term) == NULL) ||
136 		(t_parm_rindex(screen->term) == NULL &&
137 		    t_scroll_reverse(screen->term) == NULL)) &&
138 	    ((t_parm_insert_line(screen->term) == NULL &&
139 		t_insert_line(screen->term) == NULL) ||
140 		(t_parm_delete_line(screen->term) == NULL &&
141 		    t_delete_line(screen->term) == NULL));
142 
143 	/*
144 	 * Precalculate conflict info for color/attribute end commands.
145 	 */
146 #ifndef HAVE_WCHAR
147 	screen->mask_op = __ATTRIBUTES & ~__COLOR;
148 #else
149 	screen->mask_op = WA_ATTRIBUTES & ~__COLOR;
150 #endif /* HAVE_WCHAR */
151 	if (t_orig_pair(screen->term) != NULL) {
152 		if (does_esc_m(t_orig_pair(screen->term)))
153 			screen->mask_op &=
154 			    ~(__STANDOUT | __UNDERSCORE | __TERMATTR);
155 		else {
156 			if (t_exit_standout_mode(screen->term) != NULL &&
157 			    !strcmp(t_orig_pair(screen->term),
158 				t_exit_standout_mode(screen->term)))
159 				screen->mask_op &= ~__STANDOUT;
160 			if (t_exit_underline_mode(screen->term) != NULL &&
161 			    !strcmp(t_orig_pair(screen->term),
162 				t_exit_underline_mode(screen->term)))
163 				screen->mask_op &= ~__UNDERSCORE;
164 			if (t_exit_attribute_mode(screen->term) != NULL &&
165 			    !strcmp(t_orig_pair(screen->term),
166 				t_exit_attribute_mode(screen->term)))
167 				screen->mask_op &= ~__TERMATTR;
168 		}
169 	}
170 	/*
171 	 * Assume that "me" turns off all attributes apart from ACS.
172 	 * It might turn off ACS, so check for that.
173 	 */
174 	if (t_exit_attribute_mode(screen->term) != NULL &&
175 	    does_ctrl_o(t_exit_attribute_mode(screen->term)))
176 		screen->mask_me = 0;
177 	else
178 		screen->mask_me = __ALTCHARSET;
179 
180 	/* Check what turning off the attributes also turns off */
181 #ifndef HAVE_WCHAR
182 	screen->mask_ue = __ATTRIBUTES & ~__UNDERSCORE;
183 #else
184 	screen->mask_ue = WA_ATTRIBUTES & ~__UNDERSCORE;
185 #endif /* HAVE_WCHAR */
186 	if (t_exit_underline_mode(screen->term) != NULL) {
187 		if (does_esc_m(t_exit_underline_mode(screen->term)))
188 			screen->mask_ue &=
189 			    ~(__STANDOUT | __TERMATTR | __COLOR);
190 		else {
191 			if (t_exit_standout_mode(screen->term) != NULL &&
192 			    !strcmp(t_exit_underline_mode(screen->term),
193 				t_exit_standout_mode(screen->term)))
194 				screen->mask_ue &= ~__STANDOUT;
195 			if (t_exit_attribute_mode(screen->term) != NULL &&
196 			    !strcmp(t_exit_underline_mode(screen->term),
197 				t_exit_attribute_mode(screen->term)))
198 				screen->mask_ue &= ~__TERMATTR;
199 			if (t_orig_pair(screen->term) != NULL &&
200 			    !strcmp(t_exit_underline_mode(screen->term),
201 				t_orig_pair(screen->term)))
202 				screen->mask_ue &= ~__COLOR;
203 		}
204 	}
205 #ifndef HAVE_WCHAR
206 	screen->mask_se = __ATTRIBUTES & ~__STANDOUT;
207 #else
208 	screen->mask_se = WA_ATTRIBUTES & ~__STANDOUT;
209 #endif /* HAVE_WCHAR */
210 	if (t_exit_standout_mode(screen->term) != NULL) {
211 		if (does_esc_m(t_exit_standout_mode(screen->term)))
212 			screen->mask_se &=
213 			    ~(__UNDERSCORE | __TERMATTR | __COLOR);
214 		else {
215 			if (t_exit_underline_mode(screen->term) != NULL &&
216 			    !strcmp(t_exit_standout_mode(screen->term),
217 				t_exit_underline_mode(screen->term)))
218 				screen->mask_se &= ~__UNDERSCORE;
219 			if (t_exit_attribute_mode(screen->term) != NULL &&
220 			    !strcmp(t_exit_standout_mode(screen->term),
221 				t_exit_attribute_mode(screen->term)))
222 				screen->mask_se &= ~__TERMATTR;
223 			if (t_orig_pair(screen->term) != NULL &&
224 			    !strcmp(t_exit_standout_mode(screen->term),
225 				t_orig_pair(screen->term)))
226 				screen->mask_se &= ~__COLOR;
227 		}
228 	}
229 
230 	return (unknown ? ERR : OK);
231 }
232 
233 /*
234  * _cursesi_resetterm --
235  *  Copy the terminal instance data for the given screen to the global
236  *  variables.
237  */
238 void
239 _cursesi_resetterm(SCREEN *screen)
240 {
241 
242 	LINES = screen->LINES;
243 	COLS = screen->COLS;
244 	__GT = screen->GT;
245 
246 	__noqch = screen->noqch;
247 	__mask_op = screen->mask_op;
248 	__mask_me = screen->mask_me;
249 	__mask_ue = screen->mask_ue;
250 	__mask_se = screen->mask_se;
251 
252 	set_curterm(screen->term);
253 }
254 
255 /*
256  * does_esc_m --
257  * A hack for xterm-like terminals where "\E[m" or "\E[0m" will turn off
258  * other attributes, so we check for this in the capability passed to us.
259  * Note that we can't just do simple string comparison, as the capability
260  * may contain multiple, ';' separated sequence parts.
261  */
262 static int
263 does_esc_m(const char *cap)
264 {
265 #define WAITING 0
266 #define PARSING 1
267 #define NUMBER 2
268 #define FOUND 4
269 	const char *capptr;
270 	int seq;
271 
272 #ifdef DEBUG
273 	__CTRACE(__CTRACE_INIT, "does_esc_m: Checking %s\n", cap);
274 #endif
275 	/* Is it just "\E[m" or "\E[0m"? */
276 	if (!strcmp(cap, "\x1b[m") || !strcmp(cap, "\x1b[0m"))
277 		return 1;
278 
279 	/* Does it contain a "\E[...m" sequence? */
280 	if (strlen(cap) < 4)
281 		return 0;
282 	capptr = cap;
283 	seq = WAITING;
284 	while (*capptr != 0) {
285 		switch (seq) {
286 		/* Start of sequence */
287 		case WAITING:
288 			if (!strncmp(capptr, "\x1b[", 2)) {
289 				capptr+=2;
290 				if (*capptr == 'm')
291 					return 1;
292 				else {
293 					seq=PARSING;
294 					continue;
295 				}
296 			}
297 			break;
298 		/* Looking for '0' */
299 		case PARSING:
300 			if (*capptr == '0')
301 				seq=FOUND;
302 			else if (*capptr > '0' && *capptr <= '9')
303 				seq=NUMBER;
304 			else if (*capptr != ';')
305 				seq=WAITING;
306 			break;
307 		/* Some other number */
308 		case NUMBER:
309 			if (*capptr == ';')
310 				seq=PARSING;
311 			else if (!(*capptr >= '0' && *capptr <= '9'))
312 				seq=WAITING;
313 			break;
314 		/* Found a '0' */
315 		case FOUND:
316 			if (*capptr == 'm')
317 				return 1;
318 			else if (!((*capptr >= '0' && *capptr <= '9') ||
319 			    *capptr == ';'))
320 				seq=WAITING;
321 			break;
322 		default:
323 			break;
324 		}
325 		capptr++;
326 	}
327 	return 0;
328 }
329 
330 /*
331  * does_ctrl_o --
332  * A hack for vt100/xterm-like terminals where the "me" capability also
333  * unsets acs (i.e. it contains the character '\017').
334  */
335 static int
336 does_ctrl_o(const char *cap)
337 {
338 	const char *capptr = cap;
339 
340 #ifdef DEBUG
341 	__CTRACE(__CTRACE_INIT, "does_ctrl_o: Looping on %s\n", capptr);
342 #endif
343 	while (*capptr != 0) {
344 		if (*capptr == '\x0f')
345 			return 1;
346 		capptr++;
347 	}
348 	return 0;
349 }
350