?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Merge branch 'obsd-master'
[tmux.git] / tty-term.c
blobe2242269684db578fdcdcf1e5b9483e2bf74ceeb
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
33 static char *tty_term_strip(const char *);
34
35 struct tty_terms tty_terms = LIST_HEAD_INITIALIZER(tty_terms);
36
37 enum tty_code_type {
38 TTYCODE_NONE = 0,
39 TTYCODE_STRING,
40 TTYCODE_NUMBER,
41 TTYCODE_FLAG,
42 };
43
44 struct tty_code {
45 enum tty_code_type type;
46 union {
47 char *string;
48 int number;
49 int flag;
50 } value;
51 };
52
53 struct tty_term_code_entry {
54 enum tty_code_type type;
55 const char *name;
56 };
57
58 static const struct tty_term_code_entry tty_term_codes[] = {
59 [TTYC_ACSC] = { TTYCODE_STRING, "acsc" },
60 [TTYC_AM] = { TTYCODE_FLAG, "am" },
61 [TTYC_AX] = { TTYCODE_FLAG, "AX" },
62 [TTYC_BCE] = { TTYCODE_FLAG, "bce" },
63 [TTYC_BEL] = { TTYCODE_STRING, "bel" },
64 [TTYC_BIDI] = { TTYCODE_STRING, "Bidi" },
65 [TTYC_BLINK] = { TTYCODE_STRING, "blink" },
66 [TTYC_BOLD] = { TTYCODE_STRING, "bold" },
67 [TTYC_CIVIS] = { TTYCODE_STRING, "civis" },
68 [TTYC_CLEAR] = { TTYCODE_STRING, "clear" },
69 [TTYC_CLMG] = { TTYCODE_STRING, "Clmg" },
70 [TTYC_CMG] = { TTYCODE_STRING, "Cmg" },
71 [TTYC_CNORM] = { TTYCODE_STRING, "cnorm" },
72 [TTYC_COLORS] = { TTYCODE_NUMBER, "colors" },
73 [TTYC_CR] = { TTYCODE_STRING, "Cr" },
74 [TTYC_CSR] = { TTYCODE_STRING, "csr" },
75 [TTYC_CS] = { TTYCODE_STRING, "Cs" },
76 [TTYC_CUB1] = { TTYCODE_STRING, "cub1" },
77 [TTYC_CUB] = { TTYCODE_STRING, "cub" },
78 [TTYC_CUD1] = { TTYCODE_STRING, "cud1" },
79 [TTYC_CUD] = { TTYCODE_STRING, "cud" },
80 [TTYC_CUF1] = { TTYCODE_STRING, "cuf1" },
81 [TTYC_CUF] = { TTYCODE_STRING, "cuf" },
82 [TTYC_CUP] = { TTYCODE_STRING, "cup" },
83 [TTYC_CUU1] = { TTYCODE_STRING, "cuu1" },
84 [TTYC_CUU] = { TTYCODE_STRING, "cuu" },
85 [TTYC_CVVIS] = { TTYCODE_STRING, "cvvis" },
86 [TTYC_DCH1] = { TTYCODE_STRING, "dch1" },
87 [TTYC_DCH] = { TTYCODE_STRING, "dch" },
88 [TTYC_DIM] = { TTYCODE_STRING, "dim" },
89 [TTYC_DL1] = { TTYCODE_STRING, "dl1" },
90 [TTYC_DL] = { TTYCODE_STRING, "dl" },
91 [TTYC_DSEKS] = { TTYCODE_STRING, "Dseks" },
92 [TTYC_DSFCS] = { TTYCODE_STRING, "Dsfcs" },
93 [TTYC_DSBP] = { TTYCODE_STRING, "Dsbp" },
94 [TTYC_DSMG] = { TTYCODE_STRING, "Dsmg" },
95 [TTYC_E3] = { TTYCODE_STRING, "E3" },
96 [TTYC_ECH] = { TTYCODE_STRING, "ech" },
97 [TTYC_ED] = { TTYCODE_STRING, "ed" },
98 [TTYC_EL1] = { TTYCODE_STRING, "el1" },
99 [TTYC_EL] = { TTYCODE_STRING, "el" },
100 [TTYC_ENACS] = { TTYCODE_STRING, "enacs" },
101 [TTYC_ENBP] = { TTYCODE_STRING, "Enbp" },
102 [TTYC_ENEKS] = { TTYCODE_STRING, "Eneks" },
103 [TTYC_ENFCS] = { TTYCODE_STRING, "Enfcs" },
104 [TTYC_ENMG] = { TTYCODE_STRING, "Enmg" },
105 [TTYC_FSL] = { TTYCODE_STRING, "fsl" },
106 [TTYC_HLS] = { TTYCODE_STRING, "Hls" },
107 [TTYC_HOME] = { TTYCODE_STRING, "home" },
108 [TTYC_HPA] = { TTYCODE_STRING, "hpa" },
109 [TTYC_ICH1] = { TTYCODE_STRING, "ich1" },
110 [TTYC_ICH] = { TTYCODE_STRING, "ich" },
111 [TTYC_IL1] = { TTYCODE_STRING, "il1" },
112 [TTYC_IL] = { TTYCODE_STRING, "il" },
113 [TTYC_INDN] = { TTYCODE_STRING, "indn" },
114 [TTYC_INVIS] = { TTYCODE_STRING, "invis" },
115 [TTYC_KCBT] = { TTYCODE_STRING, "kcbt" },
116 [TTYC_KCUB1] = { TTYCODE_STRING, "kcub1" },
117 [TTYC_KCUD1] = { TTYCODE_STRING, "kcud1" },
118 [TTYC_KCUF1] = { TTYCODE_STRING, "kcuf1" },
119 [TTYC_KCUU1] = { TTYCODE_STRING, "kcuu1" },
120 [TTYC_KDC2] = { TTYCODE_STRING, "kDC" },
121 [TTYC_KDC3] = { TTYCODE_STRING, "kDC3" },
122 [TTYC_KDC4] = { TTYCODE_STRING, "kDC4" },
123 [TTYC_KDC5] = { TTYCODE_STRING, "kDC5" },
124 [TTYC_KDC6] = { TTYCODE_STRING, "kDC6" },
125 [TTYC_KDC7] = { TTYCODE_STRING, "kDC7" },
126 [TTYC_KDCH1] = { TTYCODE_STRING, "kdch1" },
127 [TTYC_KDN2] = { TTYCODE_STRING, "kDN" }, /* not kDN2 */
128 [TTYC_KDN3] = { TTYCODE_STRING, "kDN3" },
129 [TTYC_KDN4] = { TTYCODE_STRING, "kDN4" },
130 [TTYC_KDN5] = { TTYCODE_STRING, "kDN5" },
131 [TTYC_KDN6] = { TTYCODE_STRING, "kDN6" },
132 [TTYC_KDN7] = { TTYCODE_STRING, "kDN7" },
133 [TTYC_KEND2] = { TTYCODE_STRING, "kEND" },
134 [TTYC_KEND3] = { TTYCODE_STRING, "kEND3" },
135 [TTYC_KEND4] = { TTYCODE_STRING, "kEND4" },
136 [TTYC_KEND5] = { TTYCODE_STRING, "kEND5" },
137 [TTYC_KEND6] = { TTYCODE_STRING, "kEND6" },
138 [TTYC_KEND7] = { TTYCODE_STRING, "kEND7" },
139 [TTYC_KEND] = { TTYCODE_STRING, "kend" },
140 [TTYC_KF10] = { TTYCODE_STRING, "kf10" },
141 [TTYC_KF11] = { TTYCODE_STRING, "kf11" },
142 [TTYC_KF12] = { TTYCODE_STRING, "kf12" },
143 [TTYC_KF13] = { TTYCODE_STRING, "kf13" },
144 [TTYC_KF14] = { TTYCODE_STRING, "kf14" },
145 [TTYC_KF15] = { TTYCODE_STRING, "kf15" },
146 [TTYC_KF16] = { TTYCODE_STRING, "kf16" },
147 [TTYC_KF17] = { TTYCODE_STRING, "kf17" },
148 [TTYC_KF18] = { TTYCODE_STRING, "kf18" },
149 [TTYC_KF19] = { TTYCODE_STRING, "kf19" },
150 [TTYC_KF1] = { TTYCODE_STRING, "kf1" },
151 [TTYC_KF20] = { TTYCODE_STRING, "kf20" },
152 [TTYC_KF21] = { TTYCODE_STRING, "kf21" },
153 [TTYC_KF22] = { TTYCODE_STRING, "kf22" },
154 [TTYC_KF23] = { TTYCODE_STRING, "kf23" },
155 [TTYC_KF24] = { TTYCODE_STRING, "kf24" },
156 [TTYC_KF25] = { TTYCODE_STRING, "kf25" },
157 [TTYC_KF26] = { TTYCODE_STRING, "kf26" },
158 [TTYC_KF27] = { TTYCODE_STRING, "kf27" },
159 [TTYC_KF28] = { TTYCODE_STRING, "kf28" },
160 [TTYC_KF29] = { TTYCODE_STRING, "kf29" },
161 [TTYC_KF2] = { TTYCODE_STRING, "kf2" },
162 [TTYC_KF30] = { TTYCODE_STRING, "kf30" },
163 [TTYC_KF31] = { TTYCODE_STRING, "kf31" },
164 [TTYC_KF32] = { TTYCODE_STRING, "kf32" },
165 [TTYC_KF33] = { TTYCODE_STRING, "kf33" },
166 [TTYC_KF34] = { TTYCODE_STRING, "kf34" },
167 [TTYC_KF35] = { TTYCODE_STRING, "kf35" },
168 [TTYC_KF36] = { TTYCODE_STRING, "kf36" },
169 [TTYC_KF37] = { TTYCODE_STRING, "kf37" },
170 [TTYC_KF38] = { TTYCODE_STRING, "kf38" },
171 [TTYC_KF39] = { TTYCODE_STRING, "kf39" },
172 [TTYC_KF3] = { TTYCODE_STRING, "kf3" },
173 [TTYC_KF40] = { TTYCODE_STRING, "kf40" },
174 [TTYC_KF41] = { TTYCODE_STRING, "kf41" },
175 [TTYC_KF42] = { TTYCODE_STRING, "kf42" },
176 [TTYC_KF43] = { TTYCODE_STRING, "kf43" },
177 [TTYC_KF44] = { TTYCODE_STRING, "kf44" },
178 [TTYC_KF45] = { TTYCODE_STRING, "kf45" },
179 [TTYC_KF46] = { TTYCODE_STRING, "kf46" },
180 [TTYC_KF47] = { TTYCODE_STRING, "kf47" },
181 [TTYC_KF48] = { TTYCODE_STRING, "kf48" },
182 [TTYC_KF49] = { TTYCODE_STRING, "kf49" },
183 [TTYC_KF4] = { TTYCODE_STRING, "kf4" },
184 [TTYC_KF50] = { TTYCODE_STRING, "kf50" },
185 [TTYC_KF51] = { TTYCODE_STRING, "kf51" },
186 [TTYC_KF52] = { TTYCODE_STRING, "kf52" },
187 [TTYC_KF53] = { TTYCODE_STRING, "kf53" },
188 [TTYC_KF54] = { TTYCODE_STRING, "kf54" },
189 [TTYC_KF55] = { TTYCODE_STRING, "kf55" },
190 [TTYC_KF56] = { TTYCODE_STRING, "kf56" },
191 [TTYC_KF57] = { TTYCODE_STRING, "kf57" },
192 [TTYC_KF58] = { TTYCODE_STRING, "kf58" },
193 [TTYC_KF59] = { TTYCODE_STRING, "kf59" },
194 [TTYC_KF5] = { TTYCODE_STRING, "kf5" },
195 [TTYC_KF60] = { TTYCODE_STRING, "kf60" },
196 [TTYC_KF61] = { TTYCODE_STRING, "kf61" },
197 [TTYC_KF62] = { TTYCODE_STRING, "kf62" },
198 [TTYC_KF63] = { TTYCODE_STRING, "kf63" },
199 [TTYC_KF6] = { TTYCODE_STRING, "kf6" },
200 [TTYC_KF7] = { TTYCODE_STRING, "kf7" },
201 [TTYC_KF8] = { TTYCODE_STRING, "kf8" },
202 [TTYC_KF9] = { TTYCODE_STRING, "kf9" },
203 [TTYC_KHOM2] = { TTYCODE_STRING, "kHOM" },
204 [TTYC_KHOM3] = { TTYCODE_STRING, "kHOM3" },
205 [TTYC_KHOM4] = { TTYCODE_STRING, "kHOM4" },
206 [TTYC_KHOM5] = { TTYCODE_STRING, "kHOM5" },
207 [TTYC_KHOM6] = { TTYCODE_STRING, "kHOM6" },
208 [TTYC_KHOM7] = { TTYCODE_STRING, "kHOM7" },
209 [TTYC_KHOME] = { TTYCODE_STRING, "khome" },
210 [TTYC_KIC2] = { TTYCODE_STRING, "kIC" },
211 [TTYC_KIC3] = { TTYCODE_STRING, "kIC3" },
212 [TTYC_KIC4] = { TTYCODE_STRING, "kIC4" },
213 [TTYC_KIC5] = { TTYCODE_STRING, "kIC5" },
214 [TTYC_KIC6] = { TTYCODE_STRING, "kIC6" },
215 [TTYC_KIC7] = { TTYCODE_STRING, "kIC7" },
216 [TTYC_KICH1] = { TTYCODE_STRING, "kich1" },
217 [TTYC_KIND] = { TTYCODE_STRING, "kind" },
218 [TTYC_KLFT2] = { TTYCODE_STRING, "kLFT" },
219 [TTYC_KLFT3] = { TTYCODE_STRING, "kLFT3" },
220 [TTYC_KLFT4] = { TTYCODE_STRING, "kLFT4" },
221 [TTYC_KLFT5] = { TTYCODE_STRING, "kLFT5" },
222 [TTYC_KLFT6] = { TTYCODE_STRING, "kLFT6" },
223 [TTYC_KLFT7] = { TTYCODE_STRING, "kLFT7" },
224 [TTYC_KMOUS] = { TTYCODE_STRING, "kmous" },
225 [TTYC_KNP] = { TTYCODE_STRING, "knp" },
226 [TTYC_KNXT2] = { TTYCODE_STRING, "kNXT" },
227 [TTYC_KNXT3] = { TTYCODE_STRING, "kNXT3" },
228 [TTYC_KNXT4] = { TTYCODE_STRING, "kNXT4" },
229 [TTYC_KNXT5] = { TTYCODE_STRING, "kNXT5" },
230 [TTYC_KNXT6] = { TTYCODE_STRING, "kNXT6" },
231 [TTYC_KNXT7] = { TTYCODE_STRING, "kNXT7" },
232 [TTYC_KPP] = { TTYCODE_STRING, "kpp" },
233 [TTYC_KPRV2] = { TTYCODE_STRING, "kPRV" },
234 [TTYC_KPRV3] = { TTYCODE_STRING, "kPRV3" },
235 [TTYC_KPRV4] = { TTYCODE_STRING, "kPRV4" },
236 [TTYC_KPRV5] = { TTYCODE_STRING, "kPRV5" },
237 [TTYC_KPRV6] = { TTYCODE_STRING, "kPRV6" },
238 [TTYC_KPRV7] = { TTYCODE_STRING, "kPRV7" },
239 [TTYC_KRIT2] = { TTYCODE_STRING, "kRIT" },
240 [TTYC_KRIT3] = { TTYCODE_STRING, "kRIT3" },
241 [TTYC_KRIT4] = { TTYCODE_STRING, "kRIT4" },
242 [TTYC_KRIT5] = { TTYCODE_STRING, "kRIT5" },
243 [TTYC_KRIT6] = { TTYCODE_STRING, "kRIT6" },
244 [TTYC_KRIT7] = { TTYCODE_STRING, "kRIT7" },
245 [TTYC_KRI] = { TTYCODE_STRING, "kri" },
246 [TTYC_KUP2] = { TTYCODE_STRING, "kUP" }, /* not kUP2 */
247 [TTYC_KUP3] = { TTYCODE_STRING, "kUP3" },
248 [TTYC_KUP4] = { TTYCODE_STRING, "kUP4" },
249 [TTYC_KUP5] = { TTYCODE_STRING, "kUP5" },
250 [TTYC_KUP6] = { TTYCODE_STRING, "kUP6" },
251 [TTYC_KUP7] = { TTYCODE_STRING, "kUP7" },
252 [TTYC_MS] = { TTYCODE_STRING, "Ms" },
253 [TTYC_NOBR] = { TTYCODE_STRING, "Nobr" },
254 [TTYC_OL] = { TTYCODE_STRING, "ol" },
255 [TTYC_OP] = { TTYCODE_STRING, "op" },
256 [TTYC_RECT] = { TTYCODE_STRING, "Rect" },
257 [TTYC_REV] = { TTYCODE_STRING, "rev" },
258 [TTYC_RGB] = { TTYCODE_FLAG, "RGB" },
259 [TTYC_RIN] = { TTYCODE_STRING, "rin" },
260 [TTYC_RI] = { TTYCODE_STRING, "ri" },
261 [TTYC_RMACS] = { TTYCODE_STRING, "rmacs" },
262 [TTYC_RMCUP] = { TTYCODE_STRING, "rmcup" },
263 [TTYC_RMKX] = { TTYCODE_STRING, "rmkx" },
264 [TTYC_SETAB] = { TTYCODE_STRING, "setab" },
265 [TTYC_SETAF] = { TTYCODE_STRING, "setaf" },
266 [TTYC_SETAL] = { TTYCODE_STRING, "setal" },
267 [TTYC_SETRGBB] = { TTYCODE_STRING, "setrgbb" },
268 [TTYC_SETRGBF] = { TTYCODE_STRING, "setrgbf" },
269 [TTYC_SETULC] = { TTYCODE_STRING, "Setulc" },
270 [TTYC_SE] = { TTYCODE_STRING, "Se" },
271 [TTYC_SXL] = { TTYCODE_FLAG, "Sxl" },
272 [TTYC_SGR0] = { TTYCODE_STRING, "sgr0" },
273 [TTYC_SITM] = { TTYCODE_STRING, "sitm" },
274 [TTYC_SMACS] = { TTYCODE_STRING, "smacs" },
275 [TTYC_SMCUP] = { TTYCODE_STRING, "smcup" },
276 [TTYC_SMKX] = { TTYCODE_STRING, "smkx" },
277 [TTYC_SMOL] = { TTYCODE_STRING, "Smol" },
278 [TTYC_SMSO] = { TTYCODE_STRING, "smso" },
279 [TTYC_SMULX] = { TTYCODE_STRING, "Smulx" },
280 [TTYC_SMUL] = { TTYCODE_STRING, "smul" },
281 [TTYC_SMXX] = { TTYCODE_STRING, "smxx" },
282 [TTYC_SS] = { TTYCODE_STRING, "Ss" },
283 [TTYC_SWD] = { TTYCODE_STRING, "Swd" },
284 [TTYC_SYNC] = { TTYCODE_STRING, "Sync" },
285 [TTYC_TC] = { TTYCODE_FLAG, "Tc" },
286 [TTYC_TSL] = { TTYCODE_STRING, "tsl" },
287 [TTYC_U8] = { TTYCODE_NUMBER, "U8" },
288 [TTYC_VPA] = { TTYCODE_STRING, "vpa" },
289 [TTYC_XT] = { TTYCODE_FLAG, "XT" }
290 };
291
292 u_int
293 tty_term_ncodes(void)
294 {
295 return (nitems(tty_term_codes));
296 }
297
298 static char *
299 tty_term_strip(const char *s)
300 {
301 const char *ptr;
302 static char buf[8192];
303 size_t len;
304
305 /* Ignore strings with no padding. */
306 if (strchr(s, '$') == NULL)
307 return (xstrdup(s));
308
309 len = 0;
310 for (ptr = s; *ptr != '\0'; ptr++) {
311 if (*ptr == '$' && *(ptr + 1) == '<') {
312 while (*ptr != '\0' && *ptr != '>')
313 ptr++;
314 if (*ptr == '>')
315 ptr++;
316 if (*ptr == '\0')
317 break;
318 }
319
320 buf[len++] = *ptr;
321 if (len == (sizeof buf) - 1)
322 break;
323 }
324 buf[len] = '\0';
325
326 return (xstrdup(buf));
327 }
328
329 static char *
330 tty_term_override_next(const char *s, size_t *offset)
331 {
332 static char value[8192];
333 size_t n = 0, at = *offset;
334
335 if (s[at] == '\0')
336 return (NULL);
337
338 while (s[at] != '\0') {
339 if (s[at] == ':') {
340 if (s[at + 1] == ':') {
341 value[n++] = ':';
342 at += 2;
343 } else
344 break;
345 } else {
346 value[n++] = s[at];
347 at++;
348 }
349 if (n == (sizeof value) - 1)
350 return (NULL);
351 }
352 if (s[at] != '\0')
353 *offset = at + 1;
354 else
355 *offset = at;
356 value[n] = '\0';
357 return (value);
358 }
359
360 void
361 tty_term_apply(struct tty_term *term, const char *capabilities, int quiet)
362 {
363 const struct tty_term_code_entry *ent;
364 struct tty_code *code;
365 size_t offset = 0;
366 char *cp, *value, *s;
367 const char *errstr, *name = term->name;
368 u_int i;
369 int n, remove;
370
371 while ((s = tty_term_override_next(capabilities, &offset)) != NULL) {
372 if (*s == '\0')
373 continue;
374 value = NULL;
375
376 remove = 0;
377 if ((cp = strchr(s, '=')) != NULL) {
378 *cp++ = '\0';
379 value = xstrdup(cp);
380 if (strunvis(value, cp) == -1) {
381 free(value);
382 value = xstrdup(cp);
383 }
384 } else if (s[strlen(s) - 1] == '@') {
385 s[strlen(s) - 1] = '\0';
386 remove = 1;
387 } else
388 value = xstrdup("");
389
390 if (!quiet) {
391 if (remove)
392 log_debug("%s override: %s@", name, s);
393 else if (*value == '\0')
394 log_debug("%s override: %s", name, s);
395 else
396 log_debug("%s override: %s=%s", name, s, value);
397 }
398
399 for (i = 0; i < tty_term_ncodes(); i++) {
400 ent = &tty_term_codes[i];
401 if (strcmp(s, ent->name) != 0)
402 continue;
403 code = &term->codes[i];
404
405 if (remove) {
406 code->type = TTYCODE_NONE;
407 continue;
408 }
409 switch (ent->type) {
410 case TTYCODE_NONE:
411 break;
412 case TTYCODE_STRING:
413 if (code->type == TTYCODE_STRING)
414 free(code->value.string);
415 code->value.string = xstrdup(value);
416 code->type = ent->type;
417 break;
418 case TTYCODE_NUMBER:
419 n = strtonum(value, 0, INT_MAX, &errstr);
420 if (errstr != NULL)
421 break;
422 code->value.number = n;
423 code->type = ent->type;
424 break;
425 case TTYCODE_FLAG:
426 code->value.flag = 1;
427 code->type = ent->type;
428 break;
429 }
430 }
431
432 free(value);
433 }
434 }
435
436 void
437 tty_term_apply_overrides(struct tty_term *term)
438 {
439 struct options_entry *o;
440 struct options_array_item *a;
441 union options_value *ov;
442 const char *s, *acs;
443 size_t offset;
444 char *first;
445
446 /* Update capabilities from the option. */
447 o = options_get_only(global_options, "terminal-overrides");
448 a = options_array_first(o);
449 while (a != NULL) {
450 ov = options_array_item_value(a);
451 s = ov->string;
452
453 offset = 0;
454 first = tty_term_override_next(s, &offset);
455 if (first != NULL && fnmatch(first, term->name, 0) == 0)
456 tty_term_apply(term, s + offset, 0);
457 a = options_array_next(a);
458 }
459
460 /* Log the SIXEL flag. */
461 log_debug("SIXEL flag is %d", !!(term->flags & TERM_SIXEL));
462
463 /* Update the RGB flag if the terminal has RGB colours. */
464 if (tty_term_has(term, TTYC_SETRGBF) &&
465 tty_term_has(term, TTYC_SETRGBB))
466 term->flags |= TERM_RGBCOLOURS;
467 else
468 term->flags &= ~TERM_RGBCOLOURS;
469 log_debug("RGBCOLOURS flag is %d", !!(term->flags & TERM_RGBCOLOURS));
470
471 /*
472 * Set or clear the DECSLRM flag if the terminal has the margin
473 * capabilities.
474 */
475 if (tty_term_has(term, TTYC_CMG) && tty_term_has(term, TTYC_CLMG))
476 term->flags |= TERM_DECSLRM;
477 else
478 term->flags &= ~TERM_DECSLRM;
479 log_debug("DECSLRM flag is %d", !!(term->flags & TERM_DECSLRM));
480
481 /*
482 * Set or clear the DECFRA flag if the terminal has the rectangle
483 * capability.
484 */
485 if (tty_term_has(term, TTYC_RECT))
486 term->flags |= TERM_DECFRA;
487 else
488 term->flags &= ~TERM_DECFRA;
489 log_debug("DECFRA flag is %d", !!(term->flags & TERM_DECFRA));
490
491 /*
492 * Terminals without am (auto right margin) wrap at at $COLUMNS - 1
493 * rather than $COLUMNS (the cursor can never be beyond $COLUMNS - 1).
494 *
495 * Terminals without xenl (eat newline glitch) ignore a newline beyond
496 * the right edge of the terminal, but tmux doesn't care about this -
497 * it always uses absolute only moves the cursor with a newline when
498 * also sending a linefeed.
499 *
500 * This is irritating, most notably because it is painful to write to
501 * the very bottom-right of the screen without scrolling.
502 *
503 * Flag the terminal here and apply some workarounds in other places to
504 * do the best possible.
505 */
506 if (!tty_term_flag(term, TTYC_AM))
507 term->flags |= TERM_NOAM;
508 else
509 term->flags &= ~TERM_NOAM;
510 log_debug("NOAM flag is %d", !!(term->flags & TERM_NOAM));
511
512 /* Generate ACS table. If none is present, use nearest ASCII. */
513 memset(term->acs, 0, sizeof term->acs);
514 if (tty_term_has(term, TTYC_ACSC))
515 acs = tty_term_string(term, TTYC_ACSC);
516 else
517 acs = "a#j+k+l+m+n+o-p-q-r-s-t+u+v+w+x|y<z>~.";
518 for (; acs[0] != '\0' && acs[1] != '\0'; acs += 2)
519 term->acs[(u_char) acs[0]][0] = acs[1];
520 }
521
522 struct tty_term *
523 tty_term_create(struct tty *tty, char *name, char **caps, u_int ncaps,
524 int *feat, char **cause)
525 {
526 struct tty_term *term;
527 const struct tty_term_code_entry *ent;
528 struct tty_code *code;
529 struct options_entry *o;
530 struct options_array_item *a;
531 union options_value *ov;
532 u_int i, j;
533 const char *s, *value;
534 size_t offset, namelen;
535 char *first;
536
537 log_debug("adding term %s", name);
538
539 term = xcalloc(1, sizeof *term);
540 term->tty = tty;
541 term->name = xstrdup(name);
542 term->codes = xcalloc(tty_term_ncodes(), sizeof *term->codes);
543 LIST_INSERT_HEAD(&tty_terms, term, entry);
544
545 /* Fill in codes. */
546 for (i = 0; i < ncaps; i++) {
547 namelen = strcspn(caps[i], "=");
548 if (namelen == 0)
549 continue;
550 value = caps[i] + namelen + 1;
551
552 for (j = 0; j < tty_term_ncodes(); j++) {
553 ent = &tty_term_codes[j];
554 if (strncmp(ent->name, caps[i], namelen) != 0)
555 continue;
556 if (ent->name[namelen] != '\0')
557 continue;
558
559 code = &term->codes[j];
560 code->type = TTYCODE_NONE;
561 switch (ent->type) {
562 case TTYCODE_NONE:
563 break;
564 case TTYCODE_STRING:
565 code->type = TTYCODE_STRING;
566 code->value.string = tty_term_strip(value);
567 break;
568 case TTYCODE_NUMBER:
569 code->type = TTYCODE_NUMBER;
570 code->value.number = atoi(value);
571 break;
572 case TTYCODE_FLAG:
573 code->type = TTYCODE_FLAG;
574 code->value.flag = (*value == '1');
575 break;
576 }
577 }
578 }
579
580 /* Apply terminal features. */
581 o = options_get_only(global_options, "terminal-features");
582 a = options_array_first(o);
583 while (a != NULL) {
584 ov = options_array_item_value(a);
585 s = ov->string;
586
587 offset = 0;
588 first = tty_term_override_next(s, &offset);
589 if (first != NULL && fnmatch(first, term->name, 0) == 0)
590 tty_add_features(feat, s + offset, ":");
591 a = options_array_next(a);
592 }
593
594 /* Delete curses data. */
595 #if !defined(NCURSES_VERSION_MAJOR) || NCURSES_VERSION_MAJOR > 5 || \
596 (NCURSES_VERSION_MAJOR == 5 && NCURSES_VERSION_MINOR > 6)
597 del_curterm(cur_term);
598 #endif
599
600 /* Apply overrides so any capabilities used for features are changed. */
601 tty_term_apply_overrides(term);
602
603 /* These are always required. */
604 if (!tty_term_has(term, TTYC_CLEAR)) {
605 xasprintf(cause, "terminal does not support clear");
606 goto error;
607 }
608 if (!tty_term_has(term, TTYC_CUP)) {
609 xasprintf(cause, "terminal does not support cup");
610 goto error;
611 }
612
613 /*
614 * If TERM has XT or clear starts with CSI then it is safe to assume
615 * the terminal is derived from the VT100. This controls whether device
616 * attributes requests are sent to get more information.
617 *
618 * This is a bit of a hack but there aren't that many alternatives.
619 * Worst case tmux will just fall back to using whatever terminfo(5)
620 * says without trying to correct anything that is missing.
621 *
622 * Also add few features that VT100-like terminals should either
623 * support or safely ignore.
624 */
625 s = tty_term_string(term, TTYC_CLEAR);
626 if (tty_term_flag(term, TTYC_XT) || strncmp(s, "\033[", 2) == 0) {
627 term->flags |= TERM_VT100LIKE;
628 tty_add_features(feat, "bpaste,focus,title", ",");
629 }
630
631 /* Add RGB feature if terminal has RGB colours. */
632 if ((tty_term_flag(term, TTYC_TC) || tty_term_has(term, TTYC_RGB)) &&
633 (!tty_term_has(term, TTYC_SETRGBF) ||
634 !tty_term_has(term, TTYC_SETRGBB)))
635 tty_add_features(feat, "RGB", ",");
636
637 /* Apply the features and overrides again. */
638 if (tty_apply_features(term, *feat))
639 tty_term_apply_overrides(term);
640
641 /* Log the capabilities. */
642 for (i = 0; i < tty_term_ncodes(); i++)
643 log_debug("%s%s", name, tty_term_describe(term, i));
644
645 return (term);
646
647 error:
648 tty_term_free(term);
649 return (NULL);
650 }
651
652 void
653 tty_term_free(struct tty_term *term)
654 {
655 u_int i;
656
657 log_debug("removing term %s", term->name);
658
659 for (i = 0; i < tty_term_ncodes(); i++) {
660 if (term->codes[i].type == TTYCODE_STRING)
661 free(term->codes[i].value.string);
662 }
663 free(term->codes);
664
665 LIST_REMOVE(term, entry);
666 free(term->name);
667 free(term);
668 }
669
670 int
671 tty_term_read_list(const char *name, int fd, char ***caps, u_int *ncaps,
672 char **cause)
673 {
674 const struct tty_term_code_entry *ent;
675 int error, n;
676 u_int i;
677 const char *s;
678 char tmp[11];
679
680 if (setupterm((char *)name, fd, &error) != OK) {
681 switch (error) {
682 case 1:
683 xasprintf(cause, "can't use hardcopy terminal: %s",
684 name);
685 break;
686 case 0:
687 xasprintf(cause, "missing or unsuitable terminal: %s",
688 name);
689 break;
690 case -1:
691 xasprintf(cause, "can't find terminfo database");
692 break;
693 default:
694 xasprintf(cause, "unknown error");
695 break;
696 }
697 return (-1);
698 }
699
700 *ncaps = 0;
701 *caps = NULL;
702
703 for (i = 0; i < tty_term_ncodes(); i++) {
704 ent = &tty_term_codes[i];
705 switch (ent->type) {
706 case TTYCODE_NONE:
707 continue;
708 case TTYCODE_STRING:
709 s = tigetstr((char *)ent->name);
710 if (s == NULL || s == (char *)-1)
711 continue;
712 break;
713 case TTYCODE_NUMBER:
714 n = tigetnum((char *)ent->name);
715 if (n == -1 || n == -2)
716 continue;
717 xsnprintf(tmp, sizeof tmp, "%d", n);
718 s = tmp;
719 break;
720 case TTYCODE_FLAG:
721 n = tigetflag((char *)ent->name);
722 if (n == -1)
723 continue;
724 if (n)
725 s = "1";
726 else
727 s = "0";
728 break;
729 default:
730 fatalx("unknown capability type");
731 }
732 *caps = xreallocarray(*caps, (*ncaps) + 1, sizeof **caps);
733 xasprintf(&(*caps)[*ncaps], "%s=%s", ent->name, s);
734 (*ncaps)++;
735 }
736
737 #if !defined(NCURSES_VERSION_MAJOR) || NCURSES_VERSION_MAJOR > 5 || \
738 (NCURSES_VERSION_MAJOR == 5 && NCURSES_VERSION_MINOR > 6)
739 del_curterm(cur_term);
740 #endif
741 return (0);
742 }
743
744 void
745 tty_term_free_list(char **caps, u_int ncaps)
746 {
747 u_int i;
748
749 for (i = 0; i < ncaps; i++)
750 free(caps[i]);
751 free(caps);
752 }
753
754 int
755 tty_term_has(struct tty_term *term, enum tty_code_code code)
756 {
757 return (term->codes[code].type != TTYCODE_NONE);
758 }
759
760 const char *
761 tty_term_string(struct tty_term *term, enum tty_code_code code)
762 {
763 if (!tty_term_has(term, code))
764 return ("");
765 if (term->codes[code].type != TTYCODE_STRING)
766 fatalx("not a string: %d", code);
767 return (term->codes[code].value.string);
768 }
769
770 const char *
771 tty_term_string_i(struct tty_term *term, enum tty_code_code code, int a)
772 {
773 const char *x = tty_term_string(term, code), *s;
774
775 #if defined(HAVE_TIPARM_S)
776 s = tiparm_s(1, 0, x, a);
777 #elif defined(HAVE_TIPARM)
778 s = tiparm(x, a);
779 #else
780 s = tparm((char *)x, a, 0, 0, 0, 0, 0, 0, 0, 0);
781 #endif
782 if (s == NULL) {
783 log_debug("could not expand %s", tty_term_codes[code].name);
784 return ("");
785 }
786 return (s);
787 }
788
789 const char *
790 tty_term_string_ii(struct tty_term *term, enum tty_code_code code, int a, int b)
791 {
792 const char *x = tty_term_string(term, code), *s;
793
794 #if defined(HAVE_TIPARM_S)
795 s = tiparm_s(2, 0, x, a, b);
796 #elif defined(HAVE_TIPARM)
797 s = tiparm(x, a, b);
798 #else
799 s = tparm((char *)x, a, b, 0, 0, 0, 0, 0, 0, 0);
800 #endif
801 if (s == NULL) {
802 log_debug("could not expand %s", tty_term_codes[code].name);
803 return ("");
804 }
805 return (s);
806 }
807
808 const char *
809 tty_term_string_iii(struct tty_term *term, enum tty_code_code code, int a,
810 int b, int c)
811 {
812 const char *x = tty_term_string(term, code), *s;
813
814 #if defined(HAVE_TIPARM_S)
815 s = tiparm_s(3, 0, x, a, b, c);
816 #elif defined(HAVE_TIPARM)
817 s = tiparm(x, a, b, c);
818 #else
819 s = tparm((char *)x, a, b, c, 0, 0, 0, 0, 0, 0);
820 #endif
821 if (s == NULL) {
822 log_debug("could not expand %s", tty_term_codes[code].name);
823 return ("");
824 }
825 return (s);
826 }
827
828 const char *
829 tty_term_string_s(struct tty_term *term, enum tty_code_code code, const char *a)
830 {
831 const char *x = tty_term_string(term, code), *s;
832
833 #if defined(HAVE_TIPARM_S)
834 s = tiparm_s(1, 1, x, a);
835 #elif defined(HAVE_TIPARM)
836 s = tiparm(x, a);
837 #else
838 s = tparm((char *)x, (long)a, 0, 0, 0, 0, 0, 0, 0, 0);
839 #endif
840 if (s == NULL) {
841 log_debug("could not expand %s", tty_term_codes[code].name);
842 return ("");
843 }
844 return (s);
845 }
846
847 const char *
848 tty_term_string_ss(struct tty_term *term, enum tty_code_code code,
849 const char *a, const char *b)
850 {
851 const char *x = tty_term_string(term, code), *s;
852
853 #if defined(HAVE_TIPARM_S)
854 s = tiparm_s(2, 3, x, a, b);
855 #elif defined(HAVE_TIPARM)
856 s = tiparm(x, a, b);
857 #else
858 s = tparm((char *)x, (long)a, (long)b, 0, 0, 0, 0, 0, 0, 0);
859 #endif
860 if (s == NULL) {
861 log_debug("could not expand %s", tty_term_codes[code].name);
862 return ("");
863 }
864 return (s);
865 }
866
867 int
868 tty_term_number(struct tty_term *term, enum tty_code_code code)
869 {
870 if (!tty_term_has(term, code))
871 return (0);
872 if (term->codes[code].type != TTYCODE_NUMBER)
873 fatalx("not a number: %d", code);
874 return (term->codes[code].value.number);
875 }
876
877 int
878 tty_term_flag(struct tty_term *term, enum tty_code_code code)
879 {
880 if (!tty_term_has(term, code))
881 return (0);
882 if (term->codes[code].type != TTYCODE_FLAG)
883 fatalx("not a flag: %d", code);
884 return (term->codes[code].value.flag);
885 }
886
887 const char *
888 tty_term_describe(struct tty_term *term, enum tty_code_code code)
889 {
890 static char s[256];
891 char out[128];
892
893 switch (term->codes[code].type) {
894 case TTYCODE_NONE:
895 xsnprintf(s, sizeof s, "%4u: %s: [missing]",
896 code, tty_term_codes[code].name);
897 break;
898 case TTYCODE_STRING:
899 strnvis(out, term->codes[code].value.string, sizeof out,
900 VIS_OCTAL|VIS_CSTYLE|VIS_TAB|VIS_NL);
901 xsnprintf(s, sizeof s, "%4u: %s: (string) %s",
902 code, tty_term_codes[code].name,
903 out);
904 break;
905 case TTYCODE_NUMBER:
906 xsnprintf(s, sizeof s, "%4u: %s: (number) %d",
907 code, tty_term_codes[code].name,
908 term->codes[code].value.number);
909 break;
910 case TTYCODE_FLAG:
911 xsnprintf(s, sizeof s, "%4u: %s: (flag) %s",
912 code, tty_term_codes[code].name,
913 term->codes[code].value.flag ? "true" : "false");
914 break;
915 }
916 return (s);
917 }
tmux -- terminal multiplexer similar to GNU Screen