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