xref: /openbsd-src/usr.bin/tmux/tty-term.c (revision d59bb9942320b767f2a19aaa7690c8c6e30b724c)
1 /* $OpenBSD: tty-term.c,v 1.52 2017/02/21 14:18:12 nicm Exp $ */
2 
3 /*
4  * Copyright (c) 2008 Nicholas Marriott <nicholas.marriott@gmail.com>
5  *
6  * Permission to use, copy, modify, and distribute this software for any
7  * purpose with or without fee is hereby granted, provided that the above
8  * copyright notice and this permission notice appear in all copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
15  * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
16  * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17  */
18 
19 #include <sys/types.h>
20 
21 #include <curses.h>
22 #include <fnmatch.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <term.h>
26 #include <vis.h>
27 
28 #include "tmux.h"
29 
30 static void	 tty_term_override(struct tty_term *, const char *);
31 static char	*tty_term_strip(const char *);
32 
33 struct tty_terms tty_terms = LIST_HEAD_INITIALIZER(tty_terms);
34 
35 enum tty_code_type {
36 	TTYCODE_NONE = 0,
37 	TTYCODE_STRING,
38 	TTYCODE_NUMBER,
39 	TTYCODE_FLAG,
40 };
41 
42 struct tty_code {
43 	enum tty_code_type	type;
44 	union {
45 		char	       *string;
46 		int		number;
47 		int		flag;
48 	} value;
49 };
50 
51 struct tty_term_code_entry {
52 	enum tty_code_type	type;
53 	const char	       *name;
54 };
55 
56 static const struct tty_term_code_entry tty_term_codes[] = {
57 	[TTYC_ACSC] = { TTYCODE_STRING, "acsc" },
58 	[TTYC_AX] = { TTYCODE_FLAG, "AX" },
59 	[TTYC_BCE] = { TTYCODE_FLAG, "bce" },
60 	[TTYC_BEL] = { TTYCODE_STRING, "bel" },
61 	[TTYC_BLINK] = { TTYCODE_STRING, "blink" },
62 	[TTYC_BOLD] = { TTYCODE_STRING, "bold" },
63 	[TTYC_CIVIS] = { TTYCODE_STRING, "civis" },
64 	[TTYC_CLEAR] = { TTYCODE_STRING, "clear" },
65 	[TTYC_CNORM] = { TTYCODE_STRING, "cnorm" },
66 	[TTYC_COLORS] = { TTYCODE_NUMBER, "colors" },
67 	[TTYC_CR] = { TTYCODE_STRING, "Cr" },
68 	[TTYC_CS] = { TTYCODE_STRING, "Cs" },
69 	[TTYC_CSR] = { TTYCODE_STRING, "csr" },
70 	[TTYC_CUB] = { TTYCODE_STRING, "cub" },
71 	[TTYC_CUB1] = { TTYCODE_STRING, "cub1" },
72 	[TTYC_CUD] = { TTYCODE_STRING, "cud" },
73 	[TTYC_CUD1] = { TTYCODE_STRING, "cud1" },
74 	[TTYC_CUF] = { TTYCODE_STRING, "cuf" },
75 	[TTYC_CUF1] = { TTYCODE_STRING, "cuf1" },
76 	[TTYC_CUP] = { TTYCODE_STRING, "cup" },
77 	[TTYC_CUU] = { TTYCODE_STRING, "cuu" },
78 	[TTYC_CUU1] = { TTYCODE_STRING, "cuu1" },
79 	[TTYC_CVVIS] = { TTYCODE_STRING, "cvvis" },
80 	[TTYC_DCH] = { TTYCODE_STRING, "dch" },
81 	[TTYC_DCH1] = { TTYCODE_STRING, "dch1" },
82 	[TTYC_DIM] = { TTYCODE_STRING, "dim" },
83 	[TTYC_DL] = { TTYCODE_STRING, "dl" },
84 	[TTYC_DL1] = { TTYCODE_STRING, "dl1" },
85 	[TTYC_E3] = { TTYCODE_STRING, "E3" },
86 	[TTYC_ECH] = { TTYCODE_STRING, "ech" },
87 	[TTYC_ED] = { TTYCODE_STRING, "ed" },
88 	[TTYC_EL] = { TTYCODE_STRING, "el" },
89 	[TTYC_EL1] = { TTYCODE_STRING, "el1" },
90 	[TTYC_ENACS] = { TTYCODE_STRING, "enacs" },
91 	[TTYC_FSL] = { TTYCODE_STRING, "fsl" },
92 	[TTYC_HOME] = { TTYCODE_STRING, "home" },
93 	[TTYC_HPA] = { TTYCODE_STRING, "hpa" },
94 	[TTYC_ICH] = { TTYCODE_STRING, "ich" },
95 	[TTYC_ICH1] = { TTYCODE_STRING, "ich1" },
96 	[TTYC_IL] = { TTYCODE_STRING, "il" },
97 	[TTYC_IL1] = { TTYCODE_STRING, "il1" },
98 	[TTYC_INDN] = { TTYCODE_STRING, "indn" },
99 	[TTYC_INVIS] = { TTYCODE_STRING, "invis" },
100 	[TTYC_KCBT] = { TTYCODE_STRING, "kcbt" },
101 	[TTYC_KCUB1] = { TTYCODE_STRING, "kcub1" },
102 	[TTYC_KCUD1] = { TTYCODE_STRING, "kcud1" },
103 	[TTYC_KCUF1] = { TTYCODE_STRING, "kcuf1" },
104 	[TTYC_KCUU1] = { TTYCODE_STRING, "kcuu1" },
105 	[TTYC_KDC2] = { TTYCODE_STRING, "kDC" },
106 	[TTYC_KDC3] = { TTYCODE_STRING, "kDC3" },
107 	[TTYC_KDC4] = { TTYCODE_STRING, "kDC4" },
108 	[TTYC_KDC5] = { TTYCODE_STRING, "kDC5" },
109 	[TTYC_KDC6] = { TTYCODE_STRING, "kDC6" },
110 	[TTYC_KDC7] = { TTYCODE_STRING, "kDC7" },
111 	[TTYC_KDCH1] = { TTYCODE_STRING, "kdch1" },
112 	[TTYC_KDN2] = { TTYCODE_STRING, "kDN" },
113 	[TTYC_KDN3] = { TTYCODE_STRING, "kDN3" },
114 	[TTYC_KDN4] = { TTYCODE_STRING, "kDN4" },
115 	[TTYC_KDN5] = { TTYCODE_STRING, "kDN5" },
116 	[TTYC_KDN6] = { TTYCODE_STRING, "kDN6" },
117 	[TTYC_KDN7] = { TTYCODE_STRING, "kDN7" },
118 	[TTYC_KEND] = { TTYCODE_STRING, "kend" },
119 	[TTYC_KEND2] = { TTYCODE_STRING, "kEND" },
120 	[TTYC_KEND3] = { TTYCODE_STRING, "kEND3" },
121 	[TTYC_KEND4] = { TTYCODE_STRING, "kEND4" },
122 	[TTYC_KEND5] = { TTYCODE_STRING, "kEND5" },
123 	[TTYC_KEND6] = { TTYCODE_STRING, "kEND6" },
124 	[TTYC_KEND7] = { TTYCODE_STRING, "kEND7" },
125 	[TTYC_KF1] = { TTYCODE_STRING, "kf1" },
126 	[TTYC_KF10] = { TTYCODE_STRING, "kf10" },
127 	[TTYC_KF11] = { TTYCODE_STRING, "kf11" },
128 	[TTYC_KF12] = { TTYCODE_STRING, "kf12" },
129 	[TTYC_KF13] = { TTYCODE_STRING, "kf13" },
130 	[TTYC_KF14] = { TTYCODE_STRING, "kf14" },
131 	[TTYC_KF15] = { TTYCODE_STRING, "kf15" },
132 	[TTYC_KF16] = { TTYCODE_STRING, "kf16" },
133 	[TTYC_KF17] = { TTYCODE_STRING, "kf17" },
134 	[TTYC_KF18] = { TTYCODE_STRING, "kf18" },
135 	[TTYC_KF19] = { TTYCODE_STRING, "kf19" },
136 	[TTYC_KF2] = { TTYCODE_STRING, "kf2" },
137 	[TTYC_KF20] = { TTYCODE_STRING, "kf20" },
138 	[TTYC_KF21] = { TTYCODE_STRING, "kf21" },
139 	[TTYC_KF22] = { TTYCODE_STRING, "kf22" },
140 	[TTYC_KF23] = { TTYCODE_STRING, "kf23" },
141 	[TTYC_KF24] = { TTYCODE_STRING, "kf24" },
142 	[TTYC_KF25] = { TTYCODE_STRING, "kf25" },
143 	[TTYC_KF26] = { TTYCODE_STRING, "kf26" },
144 	[TTYC_KF27] = { TTYCODE_STRING, "kf27" },
145 	[TTYC_KF28] = { TTYCODE_STRING, "kf28" },
146 	[TTYC_KF29] = { TTYCODE_STRING, "kf29" },
147 	[TTYC_KF3] = { TTYCODE_STRING, "kf3" },
148 	[TTYC_KF30] = { TTYCODE_STRING, "kf30" },
149 	[TTYC_KF31] = { TTYCODE_STRING, "kf31" },
150 	[TTYC_KF32] = { TTYCODE_STRING, "kf32" },
151 	[TTYC_KF33] = { TTYCODE_STRING, "kf33" },
152 	[TTYC_KF34] = { TTYCODE_STRING, "kf34" },
153 	[TTYC_KF35] = { TTYCODE_STRING, "kf35" },
154 	[TTYC_KF36] = { TTYCODE_STRING, "kf36" },
155 	[TTYC_KF37] = { TTYCODE_STRING, "kf37" },
156 	[TTYC_KF38] = { TTYCODE_STRING, "kf38" },
157 	[TTYC_KF39] = { TTYCODE_STRING, "kf39" },
158 	[TTYC_KF4] = { TTYCODE_STRING, "kf4" },
159 	[TTYC_KF40] = { TTYCODE_STRING, "kf40" },
160 	[TTYC_KF41] = { TTYCODE_STRING, "kf41" },
161 	[TTYC_KF42] = { TTYCODE_STRING, "kf42" },
162 	[TTYC_KF43] = { TTYCODE_STRING, "kf43" },
163 	[TTYC_KF44] = { TTYCODE_STRING, "kf44" },
164 	[TTYC_KF45] = { TTYCODE_STRING, "kf45" },
165 	[TTYC_KF46] = { TTYCODE_STRING, "kf46" },
166 	[TTYC_KF47] = { TTYCODE_STRING, "kf47" },
167 	[TTYC_KF48] = { TTYCODE_STRING, "kf48" },
168 	[TTYC_KF49] = { TTYCODE_STRING, "kf49" },
169 	[TTYC_KF5] = { TTYCODE_STRING, "kf5" },
170 	[TTYC_KF50] = { TTYCODE_STRING, "kf50" },
171 	[TTYC_KF51] = { TTYCODE_STRING, "kf51" },
172 	[TTYC_KF52] = { TTYCODE_STRING, "kf52" },
173 	[TTYC_KF53] = { TTYCODE_STRING, "kf53" },
174 	[TTYC_KF54] = { TTYCODE_STRING, "kf54" },
175 	[TTYC_KF55] = { TTYCODE_STRING, "kf55" },
176 	[TTYC_KF56] = { TTYCODE_STRING, "kf56" },
177 	[TTYC_KF57] = { TTYCODE_STRING, "kf57" },
178 	[TTYC_KF58] = { TTYCODE_STRING, "kf58" },
179 	[TTYC_KF59] = { TTYCODE_STRING, "kf59" },
180 	[TTYC_KF6] = { TTYCODE_STRING, "kf6" },
181 	[TTYC_KF60] = { TTYCODE_STRING, "kf60" },
182 	[TTYC_KF61] = { TTYCODE_STRING, "kf61" },
183 	[TTYC_KF62] = { TTYCODE_STRING, "kf62" },
184 	[TTYC_KF63] = { TTYCODE_STRING, "kf63" },
185 	[TTYC_KF7] = { TTYCODE_STRING, "kf7" },
186 	[TTYC_KF8] = { TTYCODE_STRING, "kf8" },
187 	[TTYC_KF9] = { TTYCODE_STRING, "kf9" },
188 	[TTYC_KHOM2] = { TTYCODE_STRING, "kHOM" },
189 	[TTYC_KHOM3] = { TTYCODE_STRING, "kHOM3" },
190 	[TTYC_KHOM4] = { TTYCODE_STRING, "kHOM4" },
191 	[TTYC_KHOM5] = { TTYCODE_STRING, "kHOM5" },
192 	[TTYC_KHOM6] = { TTYCODE_STRING, "kHOM6" },
193 	[TTYC_KHOM7] = { TTYCODE_STRING, "kHOM7" },
194 	[TTYC_KHOME] = { TTYCODE_STRING, "khome" },
195 	[TTYC_KIC2] = { TTYCODE_STRING, "kIC" },
196 	[TTYC_KIC3] = { TTYCODE_STRING, "kIC3" },
197 	[TTYC_KIC4] = { TTYCODE_STRING, "kIC4" },
198 	[TTYC_KIC5] = { TTYCODE_STRING, "kIC5" },
199 	[TTYC_KIC6] = { TTYCODE_STRING, "kIC6" },
200 	[TTYC_KIC7] = { TTYCODE_STRING, "kIC7" },
201 	[TTYC_KICH1] = { TTYCODE_STRING, "kich1" },
202 	[TTYC_KLFT2] = { TTYCODE_STRING, "kLFT" },
203 	[TTYC_KLFT3] = { TTYCODE_STRING, "kLFT3" },
204 	[TTYC_KLFT4] = { TTYCODE_STRING, "kLFT4" },
205 	[TTYC_KLFT5] = { TTYCODE_STRING, "kLFT5" },
206 	[TTYC_KLFT6] = { TTYCODE_STRING, "kLFT6" },
207 	[TTYC_KLFT7] = { TTYCODE_STRING, "kLFT7" },
208 	[TTYC_KMOUS] = { TTYCODE_STRING, "kmous" },
209 	[TTYC_KNP] = { TTYCODE_STRING, "knp" },
210 	[TTYC_KNXT2] = { TTYCODE_STRING, "kNXT" },
211 	[TTYC_KNXT3] = { TTYCODE_STRING, "kNXT3" },
212 	[TTYC_KNXT4] = { TTYCODE_STRING, "kNXT4" },
213 	[TTYC_KNXT5] = { TTYCODE_STRING, "kNXT5" },
214 	[TTYC_KNXT6] = { TTYCODE_STRING, "kNXT6" },
215 	[TTYC_KNXT7] = { TTYCODE_STRING, "kNXT7" },
216 	[TTYC_KPP] = { TTYCODE_STRING, "kpp" },
217 	[TTYC_KPRV2] = { TTYCODE_STRING, "kPRV" },
218 	[TTYC_KPRV3] = { TTYCODE_STRING, "kPRV3" },
219 	[TTYC_KPRV4] = { TTYCODE_STRING, "kPRV4" },
220 	[TTYC_KPRV5] = { TTYCODE_STRING, "kPRV5" },
221 	[TTYC_KPRV6] = { TTYCODE_STRING, "kPRV6" },
222 	[TTYC_KPRV7] = { TTYCODE_STRING, "kPRV7" },
223 	[TTYC_KRIT2] = { TTYCODE_STRING, "kRIT" },
224 	[TTYC_KRIT3] = { TTYCODE_STRING, "kRIT3" },
225 	[TTYC_KRIT4] = { TTYCODE_STRING, "kRIT4" },
226 	[TTYC_KRIT5] = { TTYCODE_STRING, "kRIT5" },
227 	[TTYC_KRIT6] = { TTYCODE_STRING, "kRIT6" },
228 	[TTYC_KRIT7] = { TTYCODE_STRING, "kRIT7" },
229 	[TTYC_KUP2] = { TTYCODE_STRING, "kUP" },
230 	[TTYC_KUP3] = { TTYCODE_STRING, "kUP3" },
231 	[TTYC_KUP4] = { TTYCODE_STRING, "kUP4" },
232 	[TTYC_KUP5] = { TTYCODE_STRING, "kUP5" },
233 	[TTYC_KUP6] = { TTYCODE_STRING, "kUP6" },
234 	[TTYC_KUP7] = { TTYCODE_STRING, "kUP7" },
235 	[TTYC_MS] = { TTYCODE_STRING, "Ms" },
236 	[TTYC_OP] = { TTYCODE_STRING, "op" },
237 	[TTYC_REV] = { TTYCODE_STRING, "rev" },
238 	[TTYC_RI] = { TTYCODE_STRING, "ri" },
239 	[TTYC_RMACS] = { TTYCODE_STRING, "rmacs" },
240 	[TTYC_RMCUP] = { TTYCODE_STRING, "rmcup" },
241 	[TTYC_RMKX] = { TTYCODE_STRING, "rmkx" },
242 	[TTYC_SE] = { TTYCODE_STRING, "Se" },
243 	[TTYC_SETAB] = { TTYCODE_STRING, "setab" },
244 	[TTYC_SETAF] = { TTYCODE_STRING, "setaf" },
245 	[TTYC_SGR0] = { TTYCODE_STRING, "sgr0" },
246 	[TTYC_SITM] = { TTYCODE_STRING, "sitm" },
247 	[TTYC_SMACS] = { TTYCODE_STRING, "smacs" },
248 	[TTYC_SMCUP] = { TTYCODE_STRING, "smcup" },
249 	[TTYC_SMKX] = { TTYCODE_STRING, "smkx" },
250 	[TTYC_SMSO] = { TTYCODE_STRING, "smso" },
251 	[TTYC_SMUL] = { TTYCODE_STRING, "smul" },
252 	[TTYC_SS] = { TTYCODE_STRING, "Ss" },
253 	[TTYC_TC] = { TTYCODE_FLAG, "Tc" },
254 	[TTYC_TSL] = { TTYCODE_STRING, "tsl" },
255 	[TTYC_VPA] = { TTYCODE_STRING, "vpa" },
256 	[TTYC_XENL] = { TTYCODE_FLAG, "xenl" },
257 	[TTYC_XT] = { TTYCODE_FLAG, "XT" },
258 };
259 
260 u_int
261 tty_term_ncodes(void)
262 {
263 	return (nitems(tty_term_codes));
264 }
265 
266 static char *
267 tty_term_strip(const char *s)
268 {
269 	const char     *ptr;
270 	static char	buf[BUFSIZ];
271 	size_t		len;
272 
273 	/* Ignore strings with no padding. */
274 	if (strchr(s, '$') == NULL)
275 		return (xstrdup(s));
276 
277 	len = 0;
278 	for (ptr = s; *ptr != '\0'; ptr++) {
279 		if (*ptr == '$' && *(ptr + 1) == '<') {
280 			while (*ptr != '\0' && *ptr != '>')
281 				ptr++;
282 			if (*ptr == '>')
283 				ptr++;
284 		}
285 
286 		buf[len++] = *ptr;
287 		if (len == (sizeof buf) - 1)
288 			break;
289 	}
290 	buf[len] = '\0';
291 
292 	return (xstrdup(buf));
293 }
294 
295 static void
296 tty_term_override(struct tty_term *term, const char *override)
297 {
298 	const struct tty_term_code_entry	*ent;
299 	struct tty_code				*code;
300 	char					*next, *s, *copy, *cp, *value;
301 	const char				*errstr;
302 	u_int					 i;
303 	int					 n, remove;
304 
305 	copy = next = xstrdup(override);
306 
307 	s = strsep(&next, ":");
308 	if (s == NULL || next == NULL || fnmatch(s, term->name, 0) != 0) {
309 		free(copy);
310 		return;
311 	}
312 
313 	while ((s = strsep(&next, ":")) != NULL) {
314 		if (*s == '\0')
315 			continue;
316 		value = NULL;
317 
318 		remove = 0;
319 		if ((cp = strchr(s, '=')) != NULL) {
320 			*cp++ = '\0';
321 			value = xstrdup(cp);
322 			if (strunvis(value, cp) == -1) {
323 				free(value);
324 				value = xstrdup(cp);
325 			}
326 		} else if (s[strlen(s) - 1] == '@') {
327 			s[strlen(s) - 1] = '\0';
328 			remove = 1;
329 		} else
330 			value = xstrdup("");
331 
332 		if (remove)
333 			log_debug("%s override: %s@", term->name, s);
334 		else
335 			log_debug("%s override: %s=%s", term->name, s, value);
336 
337 		for (i = 0; i < tty_term_ncodes(); i++) {
338 			ent = &tty_term_codes[i];
339 			if (strcmp(s, ent->name) != 0)
340 				continue;
341 			code = &term->codes[i];
342 
343 			if (remove) {
344 				code->type = TTYCODE_NONE;
345 				continue;
346 			}
347 			switch (ent->type) {
348 			case TTYCODE_NONE:
349 				break;
350 			case TTYCODE_STRING:
351 				if (code->type == TTYCODE_STRING)
352 					free(code->value.string);
353 				code->value.string = xstrdup(value);
354 				code->type = ent->type;
355 				break;
356 			case TTYCODE_NUMBER:
357 				n = strtonum(value, 0, INT_MAX, &errstr);
358 				if (errstr != NULL)
359 					break;
360 				code->value.number = n;
361 				code->type = ent->type;
362 				break;
363 			case TTYCODE_FLAG:
364 				code->value.flag = 1;
365 				code->type = ent->type;
366 				break;
367 			}
368 		}
369 
370 		free(value);
371 	}
372 	free(s);
373 }
374 
375 struct tty_term *
376 tty_term_find(char *name, int fd, char **cause)
377 {
378 	struct tty_term				*term;
379 	const struct tty_term_code_entry	*ent;
380 	struct tty_code				*code;
381 	struct options_entry			*o;
382 	u_int					 size, i;
383 	int		 			 n, error;
384 	const char				*s, *acs;
385 
386 	LIST_FOREACH(term, &tty_terms, entry) {
387 		if (strcmp(term->name, name) == 0) {
388 			term->references++;
389 			return (term);
390 		}
391 	}
392 
393 	log_debug("new term: %s", name);
394 	term = xmalloc(sizeof *term);
395 	term->name = xstrdup(name);
396 	term->references = 1;
397 	term->flags = 0;
398 	term->codes = xcalloc(tty_term_ncodes(), sizeof *term->codes);
399 	LIST_INSERT_HEAD(&tty_terms, term, entry);
400 
401 	/* Set up curses terminal. */
402 	if (setupterm(name, fd, &error) != OK) {
403 		switch (error) {
404 		case 1:
405 			xasprintf(cause, "can't use hardcopy terminal: %s",
406 			    name);
407 			break;
408 		case 0:
409 			xasprintf(cause, "missing or unsuitable terminal: %s",
410 			    name);
411 			break;
412 		case -1:
413 			xasprintf(cause, "can't find terminfo database");
414 			break;
415 		default:
416 			xasprintf(cause, "unknown error");
417 			break;
418 		}
419 		goto error;
420 	}
421 
422 	/* Fill in codes. */
423 	for (i = 0; i < tty_term_ncodes(); i++) {
424 		ent = &tty_term_codes[i];
425 
426 		code = &term->codes[i];
427 		code->type = TTYCODE_NONE;
428 		switch (ent->type) {
429 		case TTYCODE_NONE:
430 			break;
431 		case TTYCODE_STRING:
432 			s = tigetstr((char *) ent->name);
433 			if (s == NULL || s == (char *) -1)
434 				break;
435 			code->type = TTYCODE_STRING;
436 			code->value.string = tty_term_strip(s);
437 			break;
438 		case TTYCODE_NUMBER:
439 			n = tigetnum((char *) ent->name);
440 			if (n == -1 || n == -2)
441 				break;
442 			code->type = TTYCODE_NUMBER;
443 			code->value.number = n;
444 			break;
445 		case TTYCODE_FLAG:
446 			n = tigetflag((char *) ent->name);
447 			if (n == -1)
448 				break;
449 			code->type = TTYCODE_FLAG;
450 			code->value.flag = n;
451 			break;
452 		}
453 	}
454 
455 	/* Apply terminal overrides. */
456 	o = options_get_only(global_options, "terminal-overrides");
457 	if (options_array_size(o, &size) != -1) {
458 		for (i = 0; i < size; i++) {
459 			s = options_array_get(o, i);
460 			if (s != NULL)
461 				tty_term_override(term, s);
462 		}
463 	}
464 
465 	/* Delete curses data. */
466 	del_curterm(cur_term);
467 
468 	/* These are always required. */
469 	if (!tty_term_has(term, TTYC_CLEAR)) {
470 		xasprintf(cause, "terminal does not support clear");
471 		goto error;
472 	}
473 	if (!tty_term_has(term, TTYC_CUP)) {
474 		xasprintf(cause, "terminal does not support cup");
475 		goto error;
476 	}
477 
478 	/* These can be emulated so one of the two is required. */
479 	if (!tty_term_has(term, TTYC_CUD1) && !tty_term_has(term, TTYC_CUD)) {
480 		xasprintf(cause, "terminal does not support cud1 or cud");
481 		goto error;
482 	}
483 
484 	/* Figure out if we have 256. */
485 	if (tty_term_number(term, TTYC_COLORS) == 256)
486 		term->flags |= TERM_256COLOURS;
487 
488 	/*
489 	 * Terminals without xenl (eat newline glitch) wrap at at $COLUMNS - 1
490 	 * rather than $COLUMNS (the cursor can never be beyond $COLUMNS - 1).
491 	 *
492 	 * This is irritating, most notably because it is impossible to write
493 	 * to the very bottom-right of the screen without scrolling.
494 	 *
495 	 * Flag the terminal here and apply some workarounds in other places to
496 	 * do the best possible.
497 	 */
498 	if (!tty_term_flag(term, TTYC_XENL))
499 		term->flags |= TERM_EARLYWRAP;
500 
501 	/* Generate ACS table. If none is present, use nearest ASCII. */
502 	memset(term->acs, 0, sizeof term->acs);
503 	if (tty_term_has(term, TTYC_ACSC))
504 		acs = tty_term_string(term, TTYC_ACSC);
505 	else
506 		acs = "a#j+k+l+m+n+o-p-q-r-s-t+u+v+w+x|y<z>~.";
507 	for (; acs[0] != '\0' && acs[1] != '\0'; acs += 2)
508 		term->acs[(u_char) acs[0]][0] = acs[1];
509 
510 	/* On terminals with xterm titles (XT), fill in tsl and fsl. */
511 	if (tty_term_flag(term, TTYC_XT) &&
512 	    !tty_term_has(term, TTYC_TSL) &&
513 	    !tty_term_has(term, TTYC_FSL)) {
514 		code = &term->codes[TTYC_TSL];
515 		code->value.string = xstrdup("\033]0;");
516 		code->type = TTYCODE_STRING;
517 		code = &term->codes[TTYC_FSL];
518 		code->value.string = xstrdup("\007");
519 		code->type = TTYCODE_STRING;
520 	}
521 
522 	return (term);
523 
524 error:
525 	tty_term_free(term);
526 	return (NULL);
527 }
528 
529 void
530 tty_term_free(struct tty_term *term)
531 {
532 	u_int	i;
533 
534 	if (--term->references != 0)
535 		return;
536 
537 	LIST_REMOVE(term, entry);
538 
539 	for (i = 0; i < tty_term_ncodes(); i++) {
540 		if (term->codes[i].type == TTYCODE_STRING)
541 			free(term->codes[i].value.string);
542 	}
543 	free(term->codes);
544 
545 	free(term->name);
546 	free(term);
547 }
548 
549 int
550 tty_term_has(struct tty_term *term, enum tty_code_code code)
551 {
552 	return (term->codes[code].type != TTYCODE_NONE);
553 }
554 
555 const char *
556 tty_term_string(struct tty_term *term, enum tty_code_code code)
557 {
558 	if (!tty_term_has(term, code))
559 		return ("");
560 	if (term->codes[code].type != TTYCODE_STRING)
561 		fatalx("not a string: %d", code);
562 	return (term->codes[code].value.string);
563 }
564 
565 const char *
566 tty_term_string1(struct tty_term *term, enum tty_code_code code, int a)
567 {
568 	return (tparm((char *) tty_term_string(term, code), a));
569 }
570 
571 const char *
572 tty_term_string2(struct tty_term *term, enum tty_code_code code, int a, int b)
573 {
574 	return (tparm((char *) tty_term_string(term, code), a, b));
575 }
576 
577 const char *
578 tty_term_ptr1(struct tty_term *term, enum tty_code_code code, const void *a)
579 {
580 	return (tparm((char *) tty_term_string(term, code), a));
581 }
582 
583 const char *
584 tty_term_ptr2(struct tty_term *term, enum tty_code_code code, const void *a,
585     const void *b)
586 {
587 	return (tparm((char *) tty_term_string(term, code), a, b));
588 }
589 
590 int
591 tty_term_number(struct tty_term *term, enum tty_code_code code)
592 {
593 	if (!tty_term_has(term, code))
594 		return (0);
595 	if (term->codes[code].type != TTYCODE_NUMBER)
596 		fatalx("not a number: %d", code);
597 	return (term->codes[code].value.number);
598 }
599 
600 int
601 tty_term_flag(struct tty_term *term, enum tty_code_code code)
602 {
603 	if (!tty_term_has(term, code))
604 		return (0);
605 	if (term->codes[code].type != TTYCODE_FLAG)
606 		fatalx("not a flag: %d", code);
607 	return (term->codes[code].value.flag);
608 }
609 
610 const char *
611 tty_term_describe(struct tty_term *term, enum tty_code_code code)
612 {
613 	static char	 s[256];
614 	char		 out[128];
615 
616 	switch (term->codes[code].type) {
617 	case TTYCODE_NONE:
618 		xsnprintf(s, sizeof s, "%4u: %s: [missing]",
619 		    code, tty_term_codes[code].name);
620 		break;
621 	case TTYCODE_STRING:
622 		strnvis(out, term->codes[code].value.string, sizeof out,
623 		    VIS_OCTAL|VIS_TAB|VIS_NL);
624 		xsnprintf(s, sizeof s, "%4u: %s: (string) %s",
625 		    code, tty_term_codes[code].name,
626 		    out);
627 		break;
628 	case TTYCODE_NUMBER:
629 		xsnprintf(s, sizeof s, "%4u: %s: (number) %d",
630 		    code, tty_term_codes[code].name,
631 		    term->codes[code].value.number);
632 		break;
633 	case TTYCODE_FLAG:
634 		xsnprintf(s, sizeof s, "%4u: %s: (flag) %s",
635 		    code, tty_term_codes[code].name,
636 		    term->codes[code].value.flag ? "true" : "false");
637 		break;
638 	}
639 	return (s);
640 }
641