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