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