xref: /netbsd-src/lib/libcurses/setterm.c (revision d909946ca08dceb44d7d0f22ec9488679695d976)
1 /*	$NetBSD: setterm.c,v 1.54 2016/01/09 19:05:13 jdc 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.54 2016/01/09 19:05:13 jdc 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 *exit_cap, const char *acs_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 	if (screen->term)
73 		del_curterm(screen->term);
74 	(void)ti_setupterm(&screen->term, type, fileno(screen->outfd), &r);
75 	if (screen->term == NULL) {
76 		unknown++;
77 		(void)ti_setupterm(&screen->term, "dumb",
78 		    fileno(screen->outfd), &r);
79 		/* No dumb term? We can't continue */
80 		if (screen->term == NULL)
81 			return ERR;
82 	}
83 #ifdef DEBUG
84 	__CTRACE(__CTRACE_INIT, "setterm: tty = %s\n", type);
85 #endif
86 
87 	/* Try TIOCGWINSZ, and, if it fails, the terminfo entry. */
88 	if (ioctl(fileno(screen->outfd), TIOCGWINSZ, &win) != -1 &&
89 	    win.ws_row != 0 && win.ws_col != 0) {
90 		screen->LINES = win.ws_row;
91 		screen->COLS = win.ws_col;
92 	}  else {
93 		if (unknown) {
94 			screen->LINES = -1;
95 			screen->COLS = -1;
96 		} else {
97 			screen->LINES = t_lines(screen->term);
98 			screen->COLS = t_columns(screen->term);
99 		}
100 	}
101 
102 	/* POSIX 1003.2 requires that the environment override. */
103 	if ((p = getenv("LINES")) != NULL)
104 		screen->LINES = (int) strtol(p, NULL, 0);
105 	if ((p = getenv("COLUMNS")) != NULL)
106 		screen->COLS = (int) strtol(p, NULL, 0);
107 	if ((p = getenv("ESCDELAY")) != NULL)
108 		ESCDELAY = (int) strtol(p, NULL, 0);
109 	if ((p = getenv("TABSIZE")) != NULL)
110 		screen->TABSIZE = (int) strtol(p, NULL, 0);
111 	else if (t_init_tabs(screen->term) >= 0)
112 		screen->TABSIZE = (int) t_init_tabs(screen->term);
113 	else
114 		screen->TABSIZE = 8;
115 	/*
116 	 * Want cols > 4, otherwise things will fail.
117 	 */
118 	if (screen->COLS <= 4)
119 		return (ERR);
120 
121 	LINES = screen->LINES;
122 	COLS = screen->COLS;
123 	TABSIZE = screen->TABSIZE;
124 
125 #ifdef DEBUG
126 	__CTRACE(__CTRACE_INIT,
127 	    "setterm: LINES = %d, COLS = %d, TABSIZE = %d\n",
128 	    LINES, COLS, TABSIZE);
129 #endif
130 
131 	/*
132 	 * set the pad char, only take the first char of the pc capability
133 	 * as this is all we can use.
134 	 */
135 	screen->padchar = t_pad_char(screen->term) ?
136 	    t_pad_char(screen->term)[0] : 0;
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 	    t_exit_alt_charset_mode(screen->term) != NULL &&
184 	    does_ctrl_o(t_exit_attribute_mode(screen->term),
185 	    t_exit_alt_charset_mode(screen->term)))
186 		screen->mask_me = 0;
187 	else
188 		screen->mask_me = __ALTCHARSET;
189 
190 	/* Check what turning off the attributes also turns off */
191 #ifndef HAVE_WCHAR
192 	screen->mask_ue = __ATTRIBUTES & ~__UNDERSCORE;
193 #else
194 	screen->mask_ue = WA_ATTRIBUTES & ~__UNDERSCORE;
195 #endif /* HAVE_WCHAR */
196 	if (t_exit_underline_mode(screen->term) != NULL) {
197 		if (does_esc_m(t_exit_underline_mode(screen->term)))
198 			screen->mask_ue &=
199 			    ~(__STANDOUT | __TERMATTR | __COLOR);
200 		else {
201 			if (t_exit_standout_mode(screen->term) != NULL &&
202 			    !strcmp(t_exit_underline_mode(screen->term),
203 				t_exit_standout_mode(screen->term)))
204 				screen->mask_ue &= ~__STANDOUT;
205 			if (t_exit_attribute_mode(screen->term) != NULL &&
206 			    !strcmp(t_exit_underline_mode(screen->term),
207 				t_exit_attribute_mode(screen->term)))
208 				screen->mask_ue &= ~__TERMATTR;
209 			if (t_orig_pair(screen->term) != NULL &&
210 			    !strcmp(t_exit_underline_mode(screen->term),
211 				t_orig_pair(screen->term)))
212 				screen->mask_ue &= ~__COLOR;
213 		}
214 	}
215 #ifndef HAVE_WCHAR
216 	screen->mask_se = __ATTRIBUTES & ~__STANDOUT;
217 #else
218 	screen->mask_se = WA_ATTRIBUTES & ~__STANDOUT;
219 #endif /* HAVE_WCHAR */
220 	if (t_exit_standout_mode(screen->term) != NULL) {
221 		if (does_esc_m(t_exit_standout_mode(screen->term)))
222 			screen->mask_se &=
223 			    ~(__UNDERSCORE | __TERMATTR | __COLOR);
224 		else {
225 			if (t_exit_underline_mode(screen->term) != NULL &&
226 			    !strcmp(t_exit_standout_mode(screen->term),
227 				t_exit_underline_mode(screen->term)))
228 				screen->mask_se &= ~__UNDERSCORE;
229 			if (t_exit_attribute_mode(screen->term) != NULL &&
230 			    !strcmp(t_exit_standout_mode(screen->term),
231 				t_exit_attribute_mode(screen->term)))
232 				screen->mask_se &= ~__TERMATTR;
233 			if (t_orig_pair(screen->term) != NULL &&
234 			    !strcmp(t_exit_standout_mode(screen->term),
235 				t_orig_pair(screen->term)))
236 				screen->mask_se &= ~__COLOR;
237 		}
238 	}
239 
240 	return (unknown ? ERR : OK);
241 }
242 
243 /*
244  * _cursesi_resetterm --
245  *  Copy the terminal instance data for the given screen to the global
246  *  variables.
247  */
248 void
249 _cursesi_resetterm(SCREEN *screen)
250 {
251 
252 	LINES = screen->LINES;
253 	COLS = screen->COLS;
254 	TABSIZE = screen->TABSIZE;
255 	__GT = screen->GT;
256 
257 	__noqch = screen->noqch;
258 	__mask_op = screen->mask_op;
259 	__mask_me = screen->mask_me;
260 	__mask_ue = screen->mask_ue;
261 	__mask_se = screen->mask_se;
262 
263 	set_curterm(screen->term);
264 }
265 
266 /*
267  * does_esc_m --
268  * A hack for xterm-like terminals where "\E[m" or "\E[0m" will turn off
269  * other attributes, so we check for this in the capability passed to us.
270  * Note that we can't just do simple string comparison, as the capability
271  * may contain multiple, ';' separated sequence parts.
272  */
273 static int
274 does_esc_m(const char *cap)
275 {
276 #define WAITING 0
277 #define PARSING 1
278 #define NUMBER 2
279 #define FOUND 4
280 	const char *capptr;
281 	int seq;
282 
283 #ifdef DEBUG
284 	__CTRACE(__CTRACE_INIT, "does_esc_m: Checking %s\n", cap);
285 #endif
286 	/* Is it just "\E[m" or "\E[0m"? */
287 	if (!strcmp(cap, "\x1b[m") || !strcmp(cap, "\x1b[0m"))
288 		return 1;
289 
290 	/* Does it contain a "\E[...m" sequence? */
291 	if (strlen(cap) < 4)
292 		return 0;
293 	capptr = cap;
294 	seq = WAITING;
295 	while (*capptr != 0) {
296 		switch (seq) {
297 		/* Start of sequence */
298 		case WAITING:
299 			if (!strncmp(capptr, "\x1b[", 2)) {
300 				capptr+=2;
301 				if (*capptr == 'm')
302 					return 1;
303 				else {
304 					seq=PARSING;
305 					continue;
306 				}
307 			}
308 			break;
309 		/* Looking for '0' */
310 		case PARSING:
311 			if (*capptr == '0')
312 				seq=FOUND;
313 			else if (*capptr > '0' && *capptr <= '9')
314 				seq=NUMBER;
315 			else if (*capptr != ';')
316 				seq=WAITING;
317 			break;
318 		/* Some other number */
319 		case NUMBER:
320 			if (*capptr == ';')
321 				seq=PARSING;
322 			else if (!(*capptr >= '0' && *capptr <= '9'))
323 				seq=WAITING;
324 			break;
325 		/* Found a '0' */
326 		case FOUND:
327 			if (*capptr == 'm')
328 				return 1;
329 			else if (!((*capptr >= '0' && *capptr <= '9') ||
330 			    *capptr == ';'))
331 				seq=WAITING;
332 			break;
333 		default:
334 			break;
335 		}
336 		capptr++;
337 	}
338 	return 0;
339 }
340 
341 /*
342  * does_ctrl_o --
343  * A hack for vt100/xterm-like terminals where the "me" capability also
344  * unsets acs.
345  */
346 static int
347 does_ctrl_o(const char *exit_cap, const char *acs_cap)
348 {
349 	const char *eptr = exit_cap, *aptr = acs_cap;
350 	int l;
351 
352 #ifdef DEBUG
353 	__CTRACE(__CTRACE_INIT, "does_ctrl_o: Testing %s for %s\n", eptr, aptr);
354 #endif
355 	l = strlen(acs_cap);
356 	while (*eptr != 0) {
357 		if (!strncmp(eptr, aptr, l))
358 			return 1;
359 		eptr++;
360 	}
361 	return 0;
362 }
363