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