1 /* $OpenBSD: tty-keys.c,v 1.69 2014/06/23 09:52:56 nicm Exp $ */ 2 3 /* 4 * Copyright (c) 2007 Nicholas Marriott <nicm@users.sourceforge.net> 5 * 6 * Permission to use, copy, modify, and distribute this software for any 7 * purpose with or without fee is hereby granted, provided that the above 8 * copyright notice and this permission notice appear in all copies. 9 * 10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 14 * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER 15 * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING 16 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 17 */ 18 19 #include <sys/types.h> 20 #include <sys/time.h> 21 22 #include <limits.h> 23 #include <stdlib.h> 24 #include <string.h> 25 #include <termios.h> 26 #include <unistd.h> 27 28 #include "tmux.h" 29 30 /* 31 * Handle keys input from the outside terminal. tty_default_*_keys[] are a base 32 * table of supported keys which are looked up in terminfo(5) and translated 33 * into a ternary tree. 34 */ 35 36 void tty_keys_add1(struct tty_key **, const char *, int); 37 void tty_keys_add(struct tty *, const char *, int); 38 void tty_keys_free1(struct tty_key *); 39 struct tty_key *tty_keys_find1( 40 struct tty_key *, const char *, size_t, size_t *); 41 struct tty_key *tty_keys_find(struct tty *, const char *, size_t, size_t *); 42 void tty_keys_callback(int, short, void *); 43 int tty_keys_mouse(struct tty *, const char *, size_t, size_t *); 44 int tty_keys_device(struct tty *, const char *, size_t, size_t *); 45 46 /* Default raw keys. */ 47 struct tty_default_key_raw { 48 const char *string; 49 int key; 50 }; 51 const struct tty_default_key_raw tty_default_raw_keys[] = { 52 /* 53 * Numeric keypad. Just use the vt100 escape sequences here and always 54 * put the terminal into keypad_xmit mode. Translation of numbers 55 * mode/applications mode is done in input-keys.c. 56 */ 57 { "\033Oo", KEYC_KP_SLASH }, 58 { "\033Oj", KEYC_KP_STAR }, 59 { "\033Om", KEYC_KP_MINUS }, 60 { "\033Ow", KEYC_KP_SEVEN }, 61 { "\033Ox", KEYC_KP_EIGHT }, 62 { "\033Oy", KEYC_KP_NINE }, 63 { "\033Ok", KEYC_KP_PLUS }, 64 { "\033Ot", KEYC_KP_FOUR }, 65 { "\033Ou", KEYC_KP_FIVE }, 66 { "\033Ov", KEYC_KP_SIX }, 67 { "\033Oq", KEYC_KP_ONE }, 68 { "\033Or", KEYC_KP_TWO }, 69 { "\033Os", KEYC_KP_THREE }, 70 { "\033OM", KEYC_KP_ENTER }, 71 { "\033Op", KEYC_KP_ZERO }, 72 { "\033On", KEYC_KP_PERIOD }, 73 74 /* Arrow keys. */ 75 { "\033OA", KEYC_UP }, 76 { "\033OB", KEYC_DOWN }, 77 { "\033OC", KEYC_RIGHT }, 78 { "\033OD", KEYC_LEFT }, 79 80 { "\033[A", KEYC_UP }, 81 { "\033[B", KEYC_DOWN }, 82 { "\033[C", KEYC_RIGHT }, 83 { "\033[D", KEYC_LEFT }, 84 85 /* Other (xterm) "cursor" keys. */ 86 { "\033OH", KEYC_HOME }, 87 { "\033OF", KEYC_END }, 88 89 { "\033[H", KEYC_HOME }, 90 { "\033[F", KEYC_END }, 91 92 /* rxvt-style arrow + modifier keys. */ 93 { "\033Oa", KEYC_UP|KEYC_CTRL }, 94 { "\033Ob", KEYC_DOWN|KEYC_CTRL }, 95 { "\033Oc", KEYC_RIGHT|KEYC_CTRL }, 96 { "\033Od", KEYC_LEFT|KEYC_CTRL }, 97 98 { "\033[a", KEYC_UP|KEYC_SHIFT }, 99 { "\033[b", KEYC_DOWN|KEYC_SHIFT }, 100 { "\033[c", KEYC_RIGHT|KEYC_SHIFT }, 101 { "\033[d", KEYC_LEFT|KEYC_SHIFT }, 102 103 /* rxvt-style function + modifier keys (C = ^, S = $, C-S = @). */ 104 { "\033[11^", KEYC_F1|KEYC_CTRL }, 105 { "\033[12^", KEYC_F2|KEYC_CTRL }, 106 { "\033[13^", KEYC_F3|KEYC_CTRL }, 107 { "\033[14^", KEYC_F4|KEYC_CTRL }, 108 { "\033[15^", KEYC_F5|KEYC_CTRL }, 109 { "\033[17^", KEYC_F6|KEYC_CTRL }, 110 { "\033[18^", KEYC_F7|KEYC_CTRL }, 111 { "\033[19^", KEYC_F8|KEYC_CTRL }, 112 { "\033[20^", KEYC_F9|KEYC_CTRL }, 113 { "\033[21^", KEYC_F10|KEYC_CTRL }, 114 { "\033[23^", KEYC_F11|KEYC_CTRL }, 115 { "\033[24^", KEYC_F12|KEYC_CTRL }, 116 { "\033[25^", KEYC_F13|KEYC_CTRL }, 117 { "\033[26^", KEYC_F14|KEYC_CTRL }, 118 { "\033[28^", KEYC_F15|KEYC_CTRL }, 119 { "\033[29^", KEYC_F16|KEYC_CTRL }, 120 { "\033[31^", KEYC_F17|KEYC_CTRL }, 121 { "\033[32^", KEYC_F18|KEYC_CTRL }, 122 { "\033[33^", KEYC_F19|KEYC_CTRL }, 123 { "\033[34^", KEYC_F20|KEYC_CTRL }, 124 { "\033[2^", KEYC_IC|KEYC_CTRL }, 125 { "\033[3^", KEYC_DC|KEYC_CTRL }, 126 { "\033[7^", KEYC_HOME|KEYC_CTRL }, 127 { "\033[8^", KEYC_END|KEYC_CTRL }, 128 { "\033[6^", KEYC_NPAGE|KEYC_CTRL }, 129 { "\033[5^", KEYC_PPAGE|KEYC_CTRL }, 130 131 { "\033[11$", KEYC_F1|KEYC_SHIFT }, 132 { "\033[12$", KEYC_F2|KEYC_SHIFT }, 133 { "\033[13$", KEYC_F3|KEYC_SHIFT }, 134 { "\033[14$", KEYC_F4|KEYC_SHIFT }, 135 { "\033[15$", KEYC_F5|KEYC_SHIFT }, 136 { "\033[17$", KEYC_F6|KEYC_SHIFT }, 137 { "\033[18$", KEYC_F7|KEYC_SHIFT }, 138 { "\033[19$", KEYC_F8|KEYC_SHIFT }, 139 { "\033[20$", KEYC_F9|KEYC_SHIFT }, 140 { "\033[21$", KEYC_F10|KEYC_SHIFT }, 141 { "\033[23$", KEYC_F11|KEYC_SHIFT }, 142 { "\033[24$", KEYC_F12|KEYC_SHIFT }, 143 { "\033[25$", KEYC_F13|KEYC_SHIFT }, 144 { "\033[26$", KEYC_F14|KEYC_SHIFT }, 145 { "\033[28$", KEYC_F15|KEYC_SHIFT }, 146 { "\033[29$", KEYC_F16|KEYC_SHIFT }, 147 { "\033[31$", KEYC_F17|KEYC_SHIFT }, 148 { "\033[32$", KEYC_F18|KEYC_SHIFT }, 149 { "\033[33$", KEYC_F19|KEYC_SHIFT }, 150 { "\033[34$", KEYC_F20|KEYC_SHIFT }, 151 { "\033[2$", KEYC_IC|KEYC_SHIFT }, 152 { "\033[3$", KEYC_DC|KEYC_SHIFT }, 153 { "\033[7$", KEYC_HOME|KEYC_SHIFT }, 154 { "\033[8$", KEYC_END|KEYC_SHIFT }, 155 { "\033[6$", KEYC_NPAGE|KEYC_SHIFT }, 156 { "\033[5$", KEYC_PPAGE|KEYC_SHIFT }, 157 158 { "\033[11@", KEYC_F1|KEYC_CTRL|KEYC_SHIFT }, 159 { "\033[12@", KEYC_F2|KEYC_CTRL|KEYC_SHIFT }, 160 { "\033[13@", KEYC_F3|KEYC_CTRL|KEYC_SHIFT }, 161 { "\033[14@", KEYC_F4|KEYC_CTRL|KEYC_SHIFT }, 162 { "\033[15@", KEYC_F5|KEYC_CTRL|KEYC_SHIFT }, 163 { "\033[17@", KEYC_F6|KEYC_CTRL|KEYC_SHIFT }, 164 { "\033[18@", KEYC_F7|KEYC_CTRL|KEYC_SHIFT }, 165 { "\033[19@", KEYC_F8|KEYC_CTRL|KEYC_SHIFT }, 166 { "\033[20@", KEYC_F9|KEYC_CTRL|KEYC_SHIFT }, 167 { "\033[21@", KEYC_F10|KEYC_CTRL|KEYC_SHIFT }, 168 { "\033[23@", KEYC_F11|KEYC_CTRL|KEYC_SHIFT }, 169 { "\033[24@", KEYC_F12|KEYC_CTRL|KEYC_SHIFT }, 170 { "\033[25@", KEYC_F13|KEYC_CTRL|KEYC_SHIFT }, 171 { "\033[26@", KEYC_F14|KEYC_CTRL|KEYC_SHIFT }, 172 { "\033[28@", KEYC_F15|KEYC_CTRL|KEYC_SHIFT }, 173 { "\033[29@", KEYC_F16|KEYC_CTRL|KEYC_SHIFT }, 174 { "\033[31@", KEYC_F17|KEYC_CTRL|KEYC_SHIFT }, 175 { "\033[32@", KEYC_F18|KEYC_CTRL|KEYC_SHIFT }, 176 { "\033[33@", KEYC_F19|KEYC_CTRL|KEYC_SHIFT }, 177 { "\033[34@", KEYC_F20|KEYC_CTRL|KEYC_SHIFT }, 178 { "\033[2@", KEYC_IC|KEYC_CTRL|KEYC_SHIFT }, 179 { "\033[3@", KEYC_DC|KEYC_CTRL|KEYC_SHIFT }, 180 { "\033[7@", KEYC_HOME|KEYC_CTRL|KEYC_SHIFT }, 181 { "\033[8@", KEYC_END|KEYC_CTRL|KEYC_SHIFT }, 182 { "\033[6@", KEYC_NPAGE|KEYC_CTRL|KEYC_SHIFT }, 183 { "\033[5@", KEYC_PPAGE|KEYC_CTRL|KEYC_SHIFT }, 184 185 /* Focus tracking. */ 186 { "\033[I", KEYC_FOCUS_IN }, 187 { "\033[O", KEYC_FOCUS_OUT }, 188 }; 189 190 /* Default terminfo(5) keys. */ 191 struct tty_default_key_code { 192 enum tty_code_code code; 193 int key; 194 }; 195 const struct tty_default_key_code tty_default_code_keys[] = { 196 /* Function keys. */ 197 { TTYC_KF1, KEYC_F1 }, 198 { TTYC_KF2, KEYC_F2 }, 199 { TTYC_KF3, KEYC_F3 }, 200 { TTYC_KF4, KEYC_F4 }, 201 { TTYC_KF5, KEYC_F5 }, 202 { TTYC_KF6, KEYC_F6 }, 203 { TTYC_KF7, KEYC_F7 }, 204 { TTYC_KF8, KEYC_F8 }, 205 { TTYC_KF9, KEYC_F9 }, 206 { TTYC_KF10, KEYC_F10 }, 207 { TTYC_KF11, KEYC_F11 }, 208 { TTYC_KF12, KEYC_F12 }, 209 { TTYC_KF13, KEYC_F13 }, 210 { TTYC_KF14, KEYC_F14 }, 211 { TTYC_KF15, KEYC_F15 }, 212 { TTYC_KF16, KEYC_F16 }, 213 { TTYC_KF17, KEYC_F17 }, 214 { TTYC_KF18, KEYC_F18 }, 215 { TTYC_KF19, KEYC_F19 }, 216 { TTYC_KF20, KEYC_F20 }, 217 { TTYC_KICH1, KEYC_IC }, 218 { TTYC_KDCH1, KEYC_DC }, 219 { TTYC_KHOME, KEYC_HOME }, 220 { TTYC_KEND, KEYC_END }, 221 { TTYC_KNP, KEYC_NPAGE }, 222 { TTYC_KPP, KEYC_PPAGE }, 223 { TTYC_KCBT, KEYC_BTAB }, 224 225 /* Arrow keys from terminfo. */ 226 { TTYC_KCUU1, KEYC_UP }, 227 { TTYC_KCUD1, KEYC_DOWN }, 228 { TTYC_KCUB1, KEYC_LEFT }, 229 { TTYC_KCUF1, KEYC_RIGHT }, 230 231 /* Key and modifier capabilities. */ 232 { TTYC_KDC2, KEYC_DC|KEYC_SHIFT }, 233 { TTYC_KDC3, KEYC_DC|KEYC_ESCAPE }, 234 { TTYC_KDC4, KEYC_DC|KEYC_SHIFT|KEYC_ESCAPE }, 235 { TTYC_KDC5, KEYC_DC|KEYC_CTRL }, 236 { TTYC_KDC6, KEYC_DC|KEYC_SHIFT|KEYC_CTRL }, 237 { TTYC_KDC7, KEYC_DC|KEYC_ESCAPE|KEYC_CTRL }, 238 { TTYC_KDN2, KEYC_DOWN|KEYC_SHIFT }, 239 { TTYC_KDN3, KEYC_DOWN|KEYC_ESCAPE }, 240 { TTYC_KDN4, KEYC_DOWN|KEYC_SHIFT|KEYC_ESCAPE }, 241 { TTYC_KDN5, KEYC_DOWN|KEYC_CTRL }, 242 { TTYC_KDN6, KEYC_DOWN|KEYC_SHIFT|KEYC_CTRL }, 243 { TTYC_KDN7, KEYC_DOWN|KEYC_ESCAPE|KEYC_CTRL }, 244 { TTYC_KEND2, KEYC_END|KEYC_SHIFT }, 245 { TTYC_KEND3, KEYC_END|KEYC_ESCAPE }, 246 { TTYC_KEND4, KEYC_END|KEYC_SHIFT|KEYC_ESCAPE }, 247 { TTYC_KEND5, KEYC_END|KEYC_CTRL }, 248 { TTYC_KEND6, KEYC_END|KEYC_SHIFT|KEYC_CTRL }, 249 { TTYC_KEND7, KEYC_END|KEYC_ESCAPE|KEYC_CTRL }, 250 { TTYC_KHOM2, KEYC_HOME|KEYC_SHIFT }, 251 { TTYC_KHOM3, KEYC_HOME|KEYC_ESCAPE }, 252 { TTYC_KHOM4, KEYC_HOME|KEYC_SHIFT|KEYC_ESCAPE }, 253 { TTYC_KHOM5, KEYC_HOME|KEYC_CTRL }, 254 { TTYC_KHOM6, KEYC_HOME|KEYC_SHIFT|KEYC_CTRL }, 255 { TTYC_KHOM7, KEYC_HOME|KEYC_ESCAPE|KEYC_CTRL }, 256 { TTYC_KIC2, KEYC_IC|KEYC_SHIFT }, 257 { TTYC_KIC3, KEYC_IC|KEYC_ESCAPE }, 258 { TTYC_KIC4, KEYC_IC|KEYC_SHIFT|KEYC_ESCAPE }, 259 { TTYC_KIC5, KEYC_IC|KEYC_CTRL }, 260 { TTYC_KIC6, KEYC_IC|KEYC_SHIFT|KEYC_CTRL }, 261 { TTYC_KIC7, KEYC_IC|KEYC_ESCAPE|KEYC_CTRL }, 262 { TTYC_KLFT2, KEYC_LEFT|KEYC_SHIFT }, 263 { TTYC_KLFT3, KEYC_LEFT|KEYC_ESCAPE }, 264 { TTYC_KLFT4, KEYC_LEFT|KEYC_SHIFT|KEYC_ESCAPE }, 265 { TTYC_KLFT5, KEYC_LEFT|KEYC_CTRL }, 266 { TTYC_KLFT6, KEYC_LEFT|KEYC_SHIFT|KEYC_CTRL }, 267 { TTYC_KLFT7, KEYC_LEFT|KEYC_ESCAPE|KEYC_CTRL }, 268 { TTYC_KNXT2, KEYC_NPAGE|KEYC_SHIFT }, 269 { TTYC_KNXT3, KEYC_NPAGE|KEYC_ESCAPE }, 270 { TTYC_KNXT4, KEYC_NPAGE|KEYC_SHIFT|KEYC_ESCAPE }, 271 { TTYC_KNXT5, KEYC_NPAGE|KEYC_CTRL }, 272 { TTYC_KNXT6, KEYC_NPAGE|KEYC_SHIFT|KEYC_CTRL }, 273 { TTYC_KNXT7, KEYC_NPAGE|KEYC_ESCAPE|KEYC_CTRL }, 274 { TTYC_KPRV2, KEYC_PPAGE|KEYC_SHIFT }, 275 { TTYC_KPRV3, KEYC_PPAGE|KEYC_ESCAPE }, 276 { TTYC_KPRV4, KEYC_PPAGE|KEYC_SHIFT|KEYC_ESCAPE }, 277 { TTYC_KPRV5, KEYC_PPAGE|KEYC_CTRL }, 278 { TTYC_KPRV6, KEYC_PPAGE|KEYC_SHIFT|KEYC_CTRL }, 279 { TTYC_KPRV7, KEYC_PPAGE|KEYC_ESCAPE|KEYC_CTRL }, 280 { TTYC_KRIT2, KEYC_RIGHT|KEYC_SHIFT }, 281 { TTYC_KRIT3, KEYC_RIGHT|KEYC_ESCAPE }, 282 { TTYC_KRIT4, KEYC_RIGHT|KEYC_SHIFT|KEYC_ESCAPE }, 283 { TTYC_KRIT5, KEYC_RIGHT|KEYC_CTRL }, 284 { TTYC_KRIT6, KEYC_RIGHT|KEYC_SHIFT|KEYC_CTRL }, 285 { TTYC_KRIT7, KEYC_RIGHT|KEYC_ESCAPE|KEYC_CTRL }, 286 { TTYC_KUP2, KEYC_UP|KEYC_SHIFT }, 287 { TTYC_KUP3, KEYC_UP|KEYC_ESCAPE }, 288 { TTYC_KUP4, KEYC_UP|KEYC_SHIFT|KEYC_ESCAPE }, 289 { TTYC_KUP5, KEYC_UP|KEYC_CTRL }, 290 { TTYC_KUP6, KEYC_UP|KEYC_SHIFT|KEYC_CTRL }, 291 { TTYC_KUP7, KEYC_UP|KEYC_ESCAPE|KEYC_CTRL }, 292 }; 293 294 /* Add key to tree. */ 295 void 296 tty_keys_add(struct tty *tty, const char *s, int key) 297 { 298 struct tty_key *tk; 299 size_t size; 300 const char *keystr; 301 302 keystr = key_string_lookup_key(key); 303 if ((tk = tty_keys_find(tty, s, strlen(s), &size)) == NULL) { 304 log_debug("new key %s: 0x%x (%s)", s, key, keystr); 305 tty_keys_add1(&tty->key_tree, s, key); 306 } else { 307 log_debug("replacing key %s: 0x%x (%s)", s, key, keystr); 308 tk->key = key; 309 } 310 } 311 312 /* Add next node to the tree. */ 313 void 314 tty_keys_add1(struct tty_key **tkp, const char *s, int key) 315 { 316 struct tty_key *tk; 317 318 /* Allocate a tree entry if there isn't one already. */ 319 tk = *tkp; 320 if (tk == NULL) { 321 tk = *tkp = xcalloc(1, sizeof *tk); 322 tk->ch = *s; 323 tk->key = KEYC_NONE; 324 } 325 326 /* Find the next entry. */ 327 if (*s == tk->ch) { 328 /* Move forward in string. */ 329 s++; 330 331 /* If this is the end of the string, no more is necessary. */ 332 if (*s == '\0') { 333 tk->key = key; 334 return; 335 } 336 337 /* Use the child tree for the next character. */ 338 tkp = &tk->next; 339 } else { 340 if (*s < tk->ch) 341 tkp = &tk->left; 342 else if (*s > tk->ch) 343 tkp = &tk->right; 344 } 345 346 /* And recurse to add it. */ 347 tty_keys_add1(tkp, s, key); 348 } 349 350 /* Initialise a key tree from the table. */ 351 void 352 tty_keys_build(struct tty *tty) 353 { 354 const struct tty_default_key_raw *tdkr; 355 const struct tty_default_key_code *tdkc; 356 u_int i; 357 const char *s; 358 359 if (tty->key_tree != NULL) 360 tty_keys_free (tty); 361 tty->key_tree = NULL; 362 363 for (i = 0; i < nitems(tty_default_raw_keys); i++) { 364 tdkr = &tty_default_raw_keys[i]; 365 366 s = tdkr->string; 367 if (*s != '\0') 368 tty_keys_add(tty, s, tdkr->key); 369 } 370 for (i = 0; i < nitems(tty_default_code_keys); i++) { 371 tdkc = &tty_default_code_keys[i]; 372 373 s = tty_term_string(tty->term, tdkc->code); 374 if (*s != '\0') 375 tty_keys_add(tty, s, tdkc->key); 376 377 } 378 } 379 380 /* Free the entire key tree. */ 381 void 382 tty_keys_free(struct tty *tty) 383 { 384 tty_keys_free1(tty->key_tree); 385 } 386 387 /* Free a single key. */ 388 void 389 tty_keys_free1(struct tty_key *tk) 390 { 391 if (tk->next != NULL) 392 tty_keys_free1(tk->next); 393 if (tk->left != NULL) 394 tty_keys_free1(tk->left); 395 if (tk->right != NULL) 396 tty_keys_free1(tk->right); 397 free(tk); 398 } 399 400 /* Lookup a key in the tree. */ 401 struct tty_key * 402 tty_keys_find(struct tty *tty, const char *buf, size_t len, size_t *size) 403 { 404 *size = 0; 405 return (tty_keys_find1(tty->key_tree, buf, len, size)); 406 } 407 408 /* Find the next node. */ 409 struct tty_key * 410 tty_keys_find1(struct tty_key *tk, const char *buf, size_t len, size_t *size) 411 { 412 /* If the node is NULL, this is the end of the tree. No match. */ 413 if (tk == NULL) 414 return (NULL); 415 416 /* Pick the next in the sequence. */ 417 if (tk->ch == *buf) { 418 /* Move forward in the string. */ 419 buf++; len--; 420 (*size)++; 421 422 /* At the end of the string, return the current node. */ 423 if (len == 0 || (tk->next == NULL && tk->key != KEYC_NONE)) 424 return (tk); 425 426 /* Move into the next tree for the following character. */ 427 tk = tk->next; 428 } else { 429 if (*buf < tk->ch) 430 tk = tk->left; 431 else if (*buf > tk->ch) 432 tk = tk->right; 433 } 434 435 /* Move to the next in the tree. */ 436 return (tty_keys_find1(tk, buf, len, size)); 437 } 438 439 /* 440 * Process at least one key in the buffer and invoke tty->key_callback. Return 441 * 0 if there are no further keys, or 1 if there could be more in the buffer. 442 */ 443 int 444 tty_keys_next(struct tty *tty) 445 { 446 struct tty_key *tk; 447 struct timeval tv; 448 const char *buf; 449 size_t len, size; 450 cc_t bspace; 451 int key, delay, expired = 0; 452 453 /* Get key buffer. */ 454 buf = EVBUFFER_DATA(tty->event->input); 455 len = EVBUFFER_LENGTH(tty->event->input); 456 if (len == 0) 457 return (0); 458 log_debug("keys are %zu (%.*s)", len, (int) len, buf); 459 460 /* Is this device attributes response? */ 461 switch (tty_keys_device(tty, buf, len, &size)) { 462 case 0: /* yes */ 463 key = KEYC_NONE; 464 goto complete_key; 465 case -1: /* no, or not valid */ 466 break; 467 case 1: /* partial */ 468 goto partial_key; 469 } 470 471 /* Is this a mouse key press? */ 472 switch (tty_keys_mouse(tty, buf, len, &size)) { 473 case 0: /* yes */ 474 key = KEYC_MOUSE; 475 goto complete_key; 476 case -1: /* no, or not valid */ 477 break; 478 case -2: /* yes, but we don't care. */ 479 goto discard_key; 480 case 1: /* partial */ 481 goto partial_key; 482 } 483 484 /* Look for matching key string and return if found. */ 485 tk = tty_keys_find(tty, buf, len, &size); 486 if (tk != NULL) { 487 if (tk->next != NULL) 488 goto partial_key; 489 key = tk->key; 490 goto complete_key; 491 } 492 493 /* Try to parse a key with an xterm-style modifier. */ 494 switch (xterm_keys_find(buf, len, &size, &key)) { 495 case 0: /* found */ 496 goto complete_key; 497 case -1: /* not found */ 498 break; 499 case 1: 500 goto partial_key; 501 } 502 503 first_key: 504 /* Is this a meta key? */ 505 if (len >= 2 && buf[0] == '\033') { 506 if (buf[1] != '\033') { 507 key = buf[1] | KEYC_ESCAPE; 508 size = 2; 509 goto complete_key; 510 } 511 512 tk = tty_keys_find(tty, buf + 1, len - 1, &size); 513 if (tk != NULL && (!expired || tk->next == NULL)) { 514 size++; /* include escape */ 515 if (tk->next != NULL) 516 goto partial_key; 517 key = tk->key; 518 if (key != KEYC_NONE) 519 key |= KEYC_ESCAPE; 520 goto complete_key; 521 } 522 } 523 524 /* No key found, take first. */ 525 key = (u_char) *buf; 526 size = 1; 527 528 /* 529 * Check for backspace key using termios VERASE - the terminfo 530 * kbs entry is extremely unreliable, so cannot be safely 531 * used. termios should have a better idea. 532 */ 533 bspace = tty->tio.c_cc[VERASE]; 534 if (bspace != _POSIX_VDISABLE && key == bspace) 535 key = KEYC_BSPACE; 536 537 goto complete_key; 538 539 partial_key: 540 log_debug("partial key %.*s", (int) len, buf); 541 542 /* If timer is going, check for expiration. */ 543 if (tty->flags & TTY_TIMER) { 544 if (evtimer_initialized(&tty->key_timer) && 545 !evtimer_pending(&tty->key_timer, NULL)) { 546 expired = 1; 547 goto first_key; 548 } 549 return (0); 550 } 551 552 /* Get the time period. */ 553 delay = options_get_number(&global_options, "escape-time"); 554 tv.tv_sec = delay / 1000; 555 tv.tv_usec = (delay % 1000) * 1000L; 556 557 /* Start the timer. */ 558 if (event_initialized(&tty->key_timer)) 559 evtimer_del(&tty->key_timer); 560 evtimer_set(&tty->key_timer, tty_keys_callback, tty); 561 evtimer_add(&tty->key_timer, &tv); 562 563 tty->flags |= TTY_TIMER; 564 return (0); 565 566 complete_key: 567 log_debug("complete key %.*s %#x", (int) size, buf, key); 568 569 /* Remove data from buffer. */ 570 evbuffer_drain(tty->event->input, size); 571 572 /* Remove key timer. */ 573 if (event_initialized(&tty->key_timer)) 574 evtimer_del(&tty->key_timer); 575 tty->flags &= ~TTY_TIMER; 576 577 /* Check for focus events. */ 578 if (key == KEYC_FOCUS_OUT) { 579 tty->client->flags &= ~CLIENT_FOCUSED; 580 return (1); 581 } else if (key == KEYC_FOCUS_IN) { 582 tty->client->flags |= CLIENT_FOCUSED; 583 return (1); 584 } 585 586 /* Fire the key. */ 587 if (key != KEYC_NONE) 588 server_client_handle_key(tty->client, key); 589 590 return (1); 591 592 discard_key: 593 log_debug("discard key %.*s %#x", (int) size, buf, key); 594 595 /* Remove data from buffer. */ 596 evbuffer_drain(tty->event->input, size); 597 598 return (1); 599 } 600 601 /* Key timer callback. */ 602 void 603 tty_keys_callback(unused int fd, unused short events, void *data) 604 { 605 struct tty *tty = data; 606 607 if (tty->flags & TTY_TIMER) { 608 while (tty_keys_next(tty)) 609 ; 610 } 611 } 612 613 /* 614 * Handle mouse key input. Returns 0 for success, -1 for failure, 1 for partial 615 * (probably a mouse sequence but need more data). 616 */ 617 int 618 tty_keys_mouse(struct tty *tty, const char *buf, size_t len, size_t *size) 619 { 620 struct mouse_event *m = &tty->mouse; 621 struct utf8_data utf8data; 622 u_int i, value, x, y, b, sgr, sgr_b, sgr_rel; 623 unsigned char c; 624 625 /* 626 * Standard mouse sequences are \033[M followed by three characters 627 * indicating button, X and Y, all based at 32 with 1,1 top-left. 628 * 629 * UTF-8 mouse sequences are similar but the three are expressed as 630 * UTF-8 characters. 631 * 632 * SGR extended mouse sequences are \033[< followed by three numbers in 633 * decimal and separated by semicolons indicating button, X and Y. A 634 * trailing 'M' is click or scroll and trailing 'm' release. All are 635 * based at 0 with 1,1 top-left. 636 */ 637 638 *size = 0; 639 x = y = b = sgr = sgr_b = sgr_rel = 0; 640 641 /* First two bytes are always \033[. */ 642 if (buf[0] != '\033') 643 return (-1); 644 if (len == 1) 645 return (1); 646 if (buf[1] != '[') 647 return (-1); 648 if (len == 2) 649 return (1); 650 651 /* 652 * Third byte is M in old standard and UTF-8 extension, < in SGR 653 * extension. 654 */ 655 if (buf[2] == 'M') { 656 /* Read the three inputs. */ 657 *size = 3; 658 for (i = 0; i < 3; i++) { 659 if (len <= *size) 660 return (1); 661 662 if (tty->mode & MODE_MOUSE_UTF8) { 663 if (utf8_open(&utf8data, buf[*size])) { 664 if (utf8data.size != 2) 665 return (-1); 666 (*size)++; 667 if (len <= *size) 668 return (1); 669 utf8_append(&utf8data, buf[*size]); 670 value = utf8_combine(&utf8data); 671 } else 672 value = (u_char) buf[*size]; 673 (*size)++; 674 } else { 675 value = (u_char) buf[*size]; 676 (*size)++; 677 } 678 679 if (i == 0) 680 b = value; 681 else if (i == 1) 682 x = value; 683 else 684 y = value; 685 } 686 log_debug("mouse input: %.*s", (int) *size, buf); 687 688 /* Check and return the mouse input. */ 689 if (b < 32) 690 return (-1); 691 b -= 32; 692 if (x >= 33) 693 x -= 33; 694 else 695 x = 256 - x; 696 if (y >= 33) 697 y -= 33; 698 else 699 y = 256 - y; 700 } else if (buf[2] == '<') { 701 /* Read the three inputs. */ 702 *size = 3; 703 while (1) { 704 if (len <= *size) 705 return (1); 706 c = (u_char)buf[(*size)++]; 707 if (c == ';') 708 break; 709 if (c < '0' || c > '9') 710 return (-1); 711 sgr_b = 10 * sgr_b + (c - '0'); 712 } 713 while (1) { 714 if (len <= *size) 715 return (1); 716 c = (u_char)buf[(*size)++]; 717 if (c == ';') 718 break; 719 if (c < '0' || c > '9') 720 return (-1); 721 x = 10 * x + (c - '0'); 722 } 723 while (1) { 724 if (len <= *size) 725 return (1); 726 c = (u_char) buf[(*size)++]; 727 if (c == 'M' || c == 'm') 728 break; 729 if (c < '0' || c > '9') 730 return (-1); 731 y = 10 * y + (c - '0'); 732 } 733 log_debug("mouse input (sgr): %.*s", (int) *size, buf); 734 735 /* Check and return the mouse input. */ 736 if (x < 1 || y < 1) 737 return (-1); 738 x--; 739 y--; 740 sgr = 1; 741 sgr_rel = (c == 'm'); 742 743 /* 744 * Some terminals (like PuTTY 0.63) mistakenly send 745 * button-release events for scroll-wheel button-press event. 746 * Discard it before it reaches any program running inside 747 * tmux. 748 */ 749 if (sgr_rel && (sgr_b & 64)) 750 return (-2); 751 752 /* Figure out what b would be in old format. */ 753 b = sgr_b; 754 if (sgr_rel) 755 b |= 3; 756 } else 757 return (-1); 758 759 /* Fill in mouse structure. */ 760 if (~m->event & MOUSE_EVENT_WHEEL) { 761 m->lx = m->x; 762 m->ly = m->y; 763 } 764 m->xb = b; 765 m->sgr = sgr; 766 m->sgr_xb = sgr_b; 767 m->sgr_rel = sgr_rel; 768 m->x = x; 769 m->y = y; 770 if (b & MOUSE_MASK_WHEEL) { 771 if (b & MOUSE_MASK_SHIFT) 772 m->scroll = 1; 773 else 774 m->scroll = MOUSE_WHEEL_SCALE; 775 if (b & MOUSE_MASK_META) 776 m->scroll *= MOUSE_WHEEL_SCALE; 777 if (b & MOUSE_MASK_CTRL) 778 m->scroll *= MOUSE_WHEEL_SCALE; 779 780 b &= MOUSE_MASK_BUTTONS; 781 if (b == 0) 782 m->wheel = MOUSE_WHEEL_UP; 783 else if (b == 1) 784 m->wheel = MOUSE_WHEEL_DOWN; 785 m->event = MOUSE_EVENT_WHEEL; 786 787 m->button = 3; 788 } else if ((b & MOUSE_MASK_BUTTONS) == 3) { 789 if (~m->event & MOUSE_EVENT_DRAG && x == m->sx && y == m->sy) { 790 m->event = MOUSE_EVENT_CLICK; 791 m->clicks = (m->clicks + 1) % 3; 792 } else 793 m->event = MOUSE_EVENT_DRAG; 794 m->event |= MOUSE_EVENT_UP; 795 } else { 796 if (b & MOUSE_MASK_DRAG) 797 m->event = MOUSE_EVENT_DRAG; 798 else { 799 m->event = MOUSE_EVENT_DOWN; 800 if (x != m->sx || y != m->sy) 801 m->clicks = 0; 802 } 803 m->button = (b & MOUSE_MASK_BUTTONS); 804 } 805 m->sx = x; 806 m->sy = y; 807 808 return (0); 809 } 810 811 /* 812 * Handle device attributes input. Returns 0 for success, -1 for failure, 1 for 813 * partial. 814 */ 815 int 816 tty_keys_device(struct tty *tty, const char *buf, size_t len, size_t *size) 817 { 818 u_int i, class; 819 char tmp[64], *endptr; 820 821 /* 822 * Primary device attributes are \033[?a;b and secondary are 823 * \033[>a;b;c. 824 */ 825 826 *size = 0; 827 828 /* First three bytes are always \033[?. */ 829 if (buf[0] != '\033') 830 return (-1); 831 if (len == 1) 832 return (1); 833 if (buf[1] != '[') 834 return (-1); 835 if (len == 2) 836 return (1); 837 if (buf[2] != '>' && buf[2] != '?') 838 return (-1); 839 if (len == 3) 840 return (1); 841 842 /* Copy the rest up to a 'c'. */ 843 for (i = 0; i < (sizeof tmp) - 1 && buf[3 + i] != 'c'; i++) { 844 if (3 + i == len) 845 return (1); 846 tmp[i] = buf[3 + i]; 847 } 848 if (i == (sizeof tmp) - 1) 849 return (-1); 850 tmp[i] = '\0'; 851 *size = 4 + i; 852 853 /* Only primary is of interest. */ 854 if (buf[2] != '?') 855 return (0); 856 857 /* Convert service class. */ 858 class = strtoul(tmp, &endptr, 10); 859 if (*endptr != ';') 860 class = 0; 861 862 log_debug("received service class %u", class); 863 tty_set_class(tty, class); 864 865 return (0); 866 } 867