Use the tsl and fsl terminfo(5) capabilities to update terminal title
[tmux-openbsd.git] / tty-term.c
blobf1e6d8780bd9604078c2de1e40129a17154c16d5
1 /* $OpenBSD$ */
3 /*
4 * Copyright (c) 2008 Nicholas Marriott <nicm@users.sourceforge.net>
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.
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.
19 #include <sys/types.h>
21 #include <curses.h>
22 #include <fnmatch.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <term.h>
26 #include <vis.h>
28 #include "tmux.h"
30 void tty_term_override(struct tty_term *, const char *);
31 char *tty_term_strip(const char *);
33 struct tty_terms tty_terms = LIST_HEAD_INITIALIZER(tty_terms);
35 const struct tty_term_code_entry tty_term_codes[NTTYCODE] = {
36 { TTYC_ACSC, TTYCODE_STRING, "acsc" },
37 { TTYC_AX, TTYCODE_FLAG, "AX" },
38 { TTYC_BEL, TTYCODE_STRING, "bel" },
39 { TTYC_BLINK, TTYCODE_STRING, "blink" },
40 { TTYC_BOLD, TTYCODE_STRING, "bold" },
41 { TTYC_CIVIS, TTYCODE_STRING, "civis" },
42 { TTYC_CLEAR, TTYCODE_STRING, "clear" },
43 { TTYC_CNORM, TTYCODE_STRING, "cnorm" },
44 { TTYC_COLORS, TTYCODE_NUMBER, "colors" },
45 { TTYC_CSR, TTYCODE_STRING, "csr" },
46 { TTYC_CUB, TTYCODE_STRING, "cub" },
47 { TTYC_CUB1, TTYCODE_STRING, "cub1" },
48 { TTYC_CUD, TTYCODE_STRING, "cud" },
49 { TTYC_CUD1, TTYCODE_STRING, "cud1" },
50 { TTYC_CUF, TTYCODE_STRING, "cuf" },
51 { TTYC_CUF1, TTYCODE_STRING, "cuf1" },
52 { TTYC_CUP, TTYCODE_STRING, "cup" },
53 { TTYC_CUU, TTYCODE_STRING, "cuu" },
54 { TTYC_CUU1, TTYCODE_STRING, "cuu1" },
55 { TTYC_DCH, TTYCODE_STRING, "dch" },
56 { TTYC_DCH1, TTYCODE_STRING, "dch1" },
57 { TTYC_DIM, TTYCODE_STRING, "dim" },
58 { TTYC_DL, TTYCODE_STRING, "dl" },
59 { TTYC_DL1, TTYCODE_STRING, "dl1" },
60 { TTYC_EL, TTYCODE_STRING, "el" },
61 { TTYC_EL1, TTYCODE_STRING, "el1" },
62 { TTYC_ENACS, TTYCODE_STRING, "enacs" },
63 { TTYC_FSL, TTYCODE_STRING, "fsl" },
64 { TTYC_HOME, TTYCODE_STRING, "home" },
65 { TTYC_HPA, TTYCODE_STRING, "hpa" },
66 { TTYC_ICH, TTYCODE_STRING, "ich" },
67 { TTYC_ICH1, TTYCODE_STRING, "ich1" },
68 { TTYC_IL, TTYCODE_STRING, "il" },
69 { TTYC_IL1, TTYCODE_STRING, "il1" },
70 { TTYC_INVIS, TTYCODE_STRING, "invis" },
71 { TTYC_IS1, TTYCODE_STRING, "is1" },
72 { TTYC_IS2, TTYCODE_STRING, "is2" },
73 { TTYC_IS3, TTYCODE_STRING, "is3" },
74 { TTYC_KCBT, TTYCODE_STRING, "kcbt" },
75 { TTYC_KCUB1, TTYCODE_STRING, "kcub1" },
76 { TTYC_KCUD1, TTYCODE_STRING, "kcud1" },
77 { TTYC_KCUF1, TTYCODE_STRING, "kcuf1" },
78 { TTYC_KCUU1, TTYCODE_STRING, "kcuu1" },
79 { TTYC_KDC2, TTYCODE_STRING, "kDC" },
80 { TTYC_KDC3, TTYCODE_STRING, "kDC3" },
81 { TTYC_KDC4, TTYCODE_STRING, "kDC4" },
82 { TTYC_KDC5, TTYCODE_STRING, "kDC5" },
83 { TTYC_KDC6, TTYCODE_STRING, "kDC6" },
84 { TTYC_KDC7, TTYCODE_STRING, "kDC7" },
85 { TTYC_KDCH1, TTYCODE_STRING, "kdch1" },
86 { TTYC_KDN2, TTYCODE_STRING, "kDN" },
87 { TTYC_KDN3, TTYCODE_STRING, "kDN3" },
88 { TTYC_KDN4, TTYCODE_STRING, "kDN4" },
89 { TTYC_KDN5, TTYCODE_STRING, "kDN5" },
90 { TTYC_KDN6, TTYCODE_STRING, "kDN6" },
91 { TTYC_KDN7, TTYCODE_STRING, "kDN7" },
92 { TTYC_KEND, TTYCODE_STRING, "kend" },
93 { TTYC_KEND2, TTYCODE_STRING, "kEND" },
94 { TTYC_KEND3, TTYCODE_STRING, "kEND3" },
95 { TTYC_KEND4, TTYCODE_STRING, "kEND4" },
96 { TTYC_KEND5, TTYCODE_STRING, "kEND5" },
97 { TTYC_KEND6, TTYCODE_STRING, "kEND6" },
98 { TTYC_KEND7, TTYCODE_STRING, "kEND7" },
99 { TTYC_KF1, TTYCODE_STRING, "kf1" },
100 { TTYC_KF10, TTYCODE_STRING, "kf10" },
101 { TTYC_KF11, TTYCODE_STRING, "kf11" },
102 { TTYC_KF12, TTYCODE_STRING, "kf12" },
103 { TTYC_KF13, TTYCODE_STRING, "kf13" },
104 { TTYC_KF14, TTYCODE_STRING, "kf14" },
105 { TTYC_KF15, TTYCODE_STRING, "kf15" },
106 { TTYC_KF16, TTYCODE_STRING, "kf16" },
107 { TTYC_KF17, TTYCODE_STRING, "kf17" },
108 { TTYC_KF18, TTYCODE_STRING, "kf18" },
109 { TTYC_KF19, TTYCODE_STRING, "kf19" },
110 { TTYC_KF2, TTYCODE_STRING, "kf2" },
111 { TTYC_KF20, TTYCODE_STRING, "kf20" },
112 { TTYC_KF3, TTYCODE_STRING, "kf3" },
113 { TTYC_KF4, TTYCODE_STRING, "kf4" },
114 { TTYC_KF5, TTYCODE_STRING, "kf5" },
115 { TTYC_KF6, TTYCODE_STRING, "kf6" },
116 { TTYC_KF7, TTYCODE_STRING, "kf7" },
117 { TTYC_KF8, TTYCODE_STRING, "kf8" },
118 { TTYC_KF9, TTYCODE_STRING, "kf9" },
119 { TTYC_KHOM2, TTYCODE_STRING, "kHOM" },
120 { TTYC_KHOM3, TTYCODE_STRING, "kHOM3" },
121 { TTYC_KHOM4, TTYCODE_STRING, "kHOM4" },
122 { TTYC_KHOM5, TTYCODE_STRING, "kHOM5" },
123 { TTYC_KHOM6, TTYCODE_STRING, "kHOM6" },
124 { TTYC_KHOM7, TTYCODE_STRING, "kHOM7" },
125 { TTYC_KHOME, TTYCODE_STRING, "khome" },
126 { TTYC_KIC2, TTYCODE_STRING, "kIC" },
127 { TTYC_KIC3, TTYCODE_STRING, "kIC3" },
128 { TTYC_KIC4, TTYCODE_STRING, "kIC4" },
129 { TTYC_KIC5, TTYCODE_STRING, "kIC5" },
130 { TTYC_KIC6, TTYCODE_STRING, "kIC6" },
131 { TTYC_KIC7, TTYCODE_STRING, "kIC7" },
132 { TTYC_KICH1, TTYCODE_STRING, "kich1" },
133 { TTYC_KLFT2, TTYCODE_STRING, "kLFT" },
134 { TTYC_KLFT3, TTYCODE_STRING, "kLFT3" },
135 { TTYC_KLFT4, TTYCODE_STRING, "kLFT4" },
136 { TTYC_KLFT5, TTYCODE_STRING, "kLFT5" },
137 { TTYC_KLFT6, TTYCODE_STRING, "kLFT6" },
138 { TTYC_KLFT7, TTYCODE_STRING, "kLFT7" },
139 { TTYC_KMOUS, TTYCODE_STRING, "kmous" },
140 { TTYC_KNP, TTYCODE_STRING, "knp" },
141 { TTYC_KNXT2, TTYCODE_STRING, "kNXT" },
142 { TTYC_KNXT3, TTYCODE_STRING, "kNXT3" },
143 { TTYC_KNXT4, TTYCODE_STRING, "kNXT4" },
144 { TTYC_KNXT5, TTYCODE_STRING, "kNXT5" },
145 { TTYC_KNXT6, TTYCODE_STRING, "kNXT6" },
146 { TTYC_KNXT7, TTYCODE_STRING, "kNXT7" },
147 { TTYC_KPP, TTYCODE_STRING, "kpp" },
148 { TTYC_KPRV2, TTYCODE_STRING, "kPRV" },
149 { TTYC_KPRV3, TTYCODE_STRING, "kPRV3" },
150 { TTYC_KPRV4, TTYCODE_STRING, "kPRV4" },
151 { TTYC_KPRV5, TTYCODE_STRING, "kPRV5" },
152 { TTYC_KPRV6, TTYCODE_STRING, "kPRV6" },
153 { TTYC_KPRV7, TTYCODE_STRING, "kPRV7" },
154 { TTYC_KRIT2, TTYCODE_STRING, "kRIT" },
155 { TTYC_KRIT3, TTYCODE_STRING, "kRIT3" },
156 { TTYC_KRIT4, TTYCODE_STRING, "kRIT4" },
157 { TTYC_KRIT5, TTYCODE_STRING, "kRIT5" },
158 { TTYC_KRIT6, TTYCODE_STRING, "kRIT6" },
159 { TTYC_KRIT7, TTYCODE_STRING, "kRIT7" },
160 { TTYC_KUP2, TTYCODE_STRING, "kUP" },
161 { TTYC_KUP3, TTYCODE_STRING, "kUP3" },
162 { TTYC_KUP4, TTYCODE_STRING, "kUP4" },
163 { TTYC_KUP5, TTYCODE_STRING, "kUP5" },
164 { TTYC_KUP6, TTYCODE_STRING, "kUP6" },
165 { TTYC_KUP7, TTYCODE_STRING, "kUP7" },
166 { TTYC_OP, TTYCODE_STRING, "op" },
167 { TTYC_REV, TTYCODE_STRING, "rev" },
168 { TTYC_RI, TTYCODE_STRING, "ri" },
169 { TTYC_RMACS, TTYCODE_STRING, "rmacs" },
170 { TTYC_RMCUP, TTYCODE_STRING, "rmcup" },
171 { TTYC_RMIR, TTYCODE_STRING, "rmir" },
172 { TTYC_RMKX, TTYCODE_STRING, "rmkx" },
173 { TTYC_SETAB, TTYCODE_STRING, "setab" },
174 { TTYC_SETAF, TTYCODE_STRING, "setaf" },
175 { TTYC_SGR0, TTYCODE_STRING, "sgr0" },
176 { TTYC_SITM, TTYCODE_STRING, "sitm" },
177 { TTYC_SMACS, TTYCODE_STRING, "smacs" },
178 { TTYC_SMCUP, TTYCODE_STRING, "smcup" },
179 { TTYC_SMIR, TTYCODE_STRING, "smir" },
180 { TTYC_SMKX, TTYCODE_STRING, "smkx" },
181 { TTYC_SMSO, TTYCODE_STRING, "smso" },
182 { TTYC_SMUL, TTYCODE_STRING, "smul" },
183 { TTYC_TSL, TTYCODE_STRING, "tsl" },
184 { TTYC_VPA, TTYCODE_STRING, "vpa" },
185 { TTYC_XENL, TTYCODE_FLAG, "xenl" },
186 { TTYC_XT, TTYCODE_FLAG, "XT" },
189 char *
190 tty_term_strip(const char *s)
192 const char *ptr;
193 static char buf[BUFSIZ];
194 size_t len;
196 /* Ignore strings with no padding. */
197 if (strchr(s, '$') == NULL)
198 return (xstrdup(s));
200 len = 0;
201 for (ptr = s; *ptr != '\0'; ptr++) {
202 if (*ptr == '$' && *(ptr + 1) == '<') {
203 while (*ptr != '\0' && *ptr != '>')
204 ptr++;
205 if (*ptr == '>')
206 ptr++;
209 buf[len++] = *ptr;
210 if (len == (sizeof buf) - 1)
211 break;
213 buf[len] = '\0';
215 return (xstrdup(buf));
218 void
219 tty_term_override(struct tty_term *term, const char *overrides)
221 const struct tty_term_code_entry *ent;
222 struct tty_code *code;
223 char *termnext, *termstr;
224 char *entnext, *entstr;
225 char *s, *ptr, *val;
226 const char *errstr;
227 u_int i;
228 int n, removeflag;
230 s = xstrdup(overrides);
232 termnext = s;
233 while ((termstr = strsep(&termnext, ",")) != NULL) {
234 entnext = termstr;
236 entstr = strsep(&entnext, ":");
237 if (entstr == NULL || entnext == NULL)
238 continue;
239 if (fnmatch(entstr, term->name, 0) != 0)
240 continue;
241 while ((entstr = strsep(&entnext, ":")) != NULL) {
242 if (*entstr == '\0')
243 continue;
245 val = NULL;
246 removeflag = 0;
247 if ((ptr = strchr(entstr, '=')) != NULL) {
248 *ptr++ = '\0';
249 val = xstrdup(ptr);
250 if (strunvis(val, ptr) == -1) {
251 xfree(val);
252 val = xstrdup(ptr);
254 } else if (entstr[strlen(entstr) - 1] == '@') {
255 entstr[strlen(entstr) - 1] = '\0';
256 removeflag = 1;
257 } else
258 val = xstrdup("");
260 for (i = 0; i < NTTYCODE; i++) {
261 ent = &tty_term_codes[i];
262 if (strcmp(entstr, ent->name) != 0)
263 continue;
264 code = &term->codes[ent->code];
266 if (removeflag) {
267 code->type = TTYCODE_NONE;
268 continue;
270 switch (ent->type) {
271 case TTYCODE_NONE:
272 break;
273 case TTYCODE_STRING:
274 if (code->type == TTYCODE_STRING)
275 xfree(code->value.string);
276 code->value.string = xstrdup(val);
277 code->type = ent->type;
278 break;
279 case TTYCODE_NUMBER:
280 n = strtonum(val, 0, INT_MAX, &errstr);
281 if (errstr != NULL)
282 break;
283 code->value.number = n;
284 code->type = ent->type;
285 break;
286 case TTYCODE_FLAG:
287 code->value.flag = 1;
288 code->type = ent->type;
289 break;
293 if (val != NULL)
294 xfree(val);
298 xfree(s);
301 struct tty_term *
302 tty_term_find(char *name, int fd, const char *overrides, char **cause)
304 struct tty_term *term;
305 const struct tty_term_code_entry *ent;
306 struct tty_code *code;
307 u_int i;
308 int n, error;
309 char *s;
310 const char *acs;
312 LIST_FOREACH(term, &tty_terms, entry) {
313 if (strcmp(term->name, name) == 0) {
314 term->references++;
315 return (term);
319 log_debug("new term: %s", name);
320 term = xmalloc(sizeof *term);
321 term->name = xstrdup(name);
322 term->references = 1;
323 term->flags = 0;
324 memset(term->codes, 0, sizeof term->codes);
325 LIST_INSERT_HEAD(&tty_terms, term, entry);
327 /* Set up curses terminal. */
328 if (setupterm(name, fd, &error) != OK) {
329 switch (error) {
330 case 1:
331 xasprintf(
332 cause, "can't use hardcopy terminal: %s", name);
333 break;
334 case 0:
335 xasprintf(
336 cause, "missing or unsuitable terminal: %s", name);
337 break;
338 case -1:
339 xasprintf(cause, "can't find terminfo database");
340 break;
341 default:
342 xasprintf(cause, "unknown error");
343 break;
345 goto error;
348 /* Fill in codes. */
349 for (i = 0; i < NTTYCODE; i++) {
350 ent = &tty_term_codes[i];
352 code = &term->codes[ent->code];
353 code->type = TTYCODE_NONE;
354 switch (ent->type) {
355 case TTYCODE_NONE:
356 break;
357 case TTYCODE_STRING:
358 s = tigetstr((char *) ent->name);
359 if (s == NULL || s == (char *) -1)
360 break;
361 code->type = TTYCODE_STRING;
362 code->value.string = tty_term_strip(s);
363 break;
364 case TTYCODE_NUMBER:
365 n = tigetnum((char *) ent->name);
366 if (n == -1 || n == -2)
367 break;
368 code->type = TTYCODE_NUMBER;
369 code->value.number = n;
370 break;
371 case TTYCODE_FLAG:
372 n = tigetflag((char *) ent->name);
373 if (n == -1)
374 break;
375 code->type = TTYCODE_FLAG;
376 code->value.number = n;
377 break;
380 tty_term_override(term, overrides);
382 /* Delete curses data. */
383 del_curterm(cur_term);
385 /* These are always required. */
386 if (!tty_term_has(term, TTYC_CLEAR)) {
387 xasprintf(cause, "terminal does not support clear");
388 goto error;
390 if (!tty_term_has(term, TTYC_CUP)) {
391 xasprintf(cause, "terminal does not support cup");
392 goto error;
395 /* These can be emulated so one of the two is required. */
396 if (!tty_term_has(term, TTYC_CUD1) && !tty_term_has(term, TTYC_CUD)) {
397 xasprintf(cause, "terminal does not support cud1 or cud");
398 goto error;
401 /* Figure out if we have 256 or 88 colours. */
402 if (tty_term_number(term, TTYC_COLORS) == 256)
403 term->flags |= TERM_256COLOURS;
404 if (tty_term_number(term, TTYC_COLORS) == 88)
405 term->flags |= TERM_88COLOURS;
408 * Terminals without xenl (eat newline glitch) wrap at at $COLUMNS - 1
409 * rather than $COLUMNS (the cursor can never be beyond $COLUMNS - 1).
411 * This is irritating, most notably because it is impossible to write
412 * to the very bottom-right of the screen without scrolling.
414 * Flag the terminal here and apply some workarounds in other places to
415 * do the best possible.
417 if (!tty_term_flag(term, TTYC_XENL))
418 term->flags |= TERM_EARLYWRAP;
420 /* Generate ACS table. If none is present, use nearest ASCII. */
421 memset(term->acs, 0, sizeof term->acs);
422 if (tty_term_has(term, TTYC_ACSC))
423 acs = tty_term_string(term, TTYC_ACSC);
424 else
425 acs = "a#j+k+l+m+n+o-p-q-r-s-t+u+v+w+x|y<z>~.";
426 for (; acs[0] != '\0' && acs[1] != '\0'; acs += 2)
427 term->acs[(u_char) acs[0]][0] = acs[1];
429 /* On terminals with xterm titles (XT), fill in tsl and fsl. */
430 if (tty_term_flag(term, TTYC_XT) &&
431 !tty_term_has(term, TTYC_TSL) &&
432 !tty_term_has(term, TTYC_FSL)) {
433 code = &term->codes[TTYC_TSL];
434 code->value.string = xstrdup("\033]0;");
435 code->type = TTYCODE_STRING;
436 code = &term->codes[TTYC_FSL];
437 code->value.string = xstrdup("\007");
438 code->type = TTYCODE_STRING;
441 return (term);
443 error:
444 tty_term_free(term);
445 return (NULL);
448 void
449 tty_term_free(struct tty_term *term)
451 u_int i;
453 if (--term->references != 0)
454 return;
456 LIST_REMOVE(term, entry);
458 for (i = 0; i < NTTYCODE; i++) {
459 if (term->codes[i].type == TTYCODE_STRING)
460 xfree(term->codes[i].value.string);
462 xfree(term->name);
463 xfree(term);
467 tty_term_has(struct tty_term *term, enum tty_code_code code)
469 return (term->codes[code].type != TTYCODE_NONE);
472 const char *
473 tty_term_string(struct tty_term *term, enum tty_code_code code)
475 if (!tty_term_has(term, code))
476 return ("");
477 if (term->codes[code].type != TTYCODE_STRING)
478 log_fatalx("not a string: %d", code);
479 return (term->codes[code].value.string);
482 /* No vtparm. Fucking curses. */
483 const char *
484 tty_term_string1(struct tty_term *term, enum tty_code_code code, int a)
486 return (tparm((char *) tty_term_string(term, code), a));
489 const char *
490 tty_term_string2(struct tty_term *term, enum tty_code_code code, int a, int b)
492 return (tparm((char *) tty_term_string(term, code), a, b));
496 tty_term_number(struct tty_term *term, enum tty_code_code code)
498 if (!tty_term_has(term, code))
499 return (0);
500 if (term->codes[code].type != TTYCODE_NUMBER)
501 log_fatalx("not a number: %d", code);
502 return (term->codes[code].value.number);
506 tty_term_flag(struct tty_term *term, enum tty_code_code code)
508 if (!tty_term_has(term, code))
509 return (0);
510 if (term->codes[code].type != TTYCODE_FLAG)
511 log_fatalx("not a flag: %d", code);
512 return (term->codes[code].value.flag);