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