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