1 /* $OpenBSD: tty-keys.c,v 1.72 2015/04/19 21:34:21 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[2^", KEYC_IC|KEYC_CTRL }, 117 { "\033[3^", KEYC_DC|KEYC_CTRL }, 118 { "\033[7^", KEYC_HOME|KEYC_CTRL }, 119 { "\033[8^", KEYC_END|KEYC_CTRL }, 120 { "\033[6^", KEYC_NPAGE|KEYC_CTRL }, 121 { "\033[5^", KEYC_PPAGE|KEYC_CTRL }, 122 123 { "\033[11$", KEYC_F1|KEYC_SHIFT }, 124 { "\033[12$", KEYC_F2|KEYC_SHIFT }, 125 { "\033[13$", KEYC_F3|KEYC_SHIFT }, 126 { "\033[14$", KEYC_F4|KEYC_SHIFT }, 127 { "\033[15$", KEYC_F5|KEYC_SHIFT }, 128 { "\033[17$", KEYC_F6|KEYC_SHIFT }, 129 { "\033[18$", KEYC_F7|KEYC_SHIFT }, 130 { "\033[19$", KEYC_F8|KEYC_SHIFT }, 131 { "\033[20$", KEYC_F9|KEYC_SHIFT }, 132 { "\033[21$", KEYC_F10|KEYC_SHIFT }, 133 { "\033[23$", KEYC_F11|KEYC_SHIFT }, 134 { "\033[24$", KEYC_F12|KEYC_SHIFT }, 135 { "\033[2$", KEYC_IC|KEYC_SHIFT }, 136 { "\033[3$", KEYC_DC|KEYC_SHIFT }, 137 { "\033[7$", KEYC_HOME|KEYC_SHIFT }, 138 { "\033[8$", KEYC_END|KEYC_SHIFT }, 139 { "\033[6$", KEYC_NPAGE|KEYC_SHIFT }, 140 { "\033[5$", KEYC_PPAGE|KEYC_SHIFT }, 141 142 { "\033[11@", KEYC_F1|KEYC_CTRL|KEYC_SHIFT }, 143 { "\033[12@", KEYC_F2|KEYC_CTRL|KEYC_SHIFT }, 144 { "\033[13@", KEYC_F3|KEYC_CTRL|KEYC_SHIFT }, 145 { "\033[14@", KEYC_F4|KEYC_CTRL|KEYC_SHIFT }, 146 { "\033[15@", KEYC_F5|KEYC_CTRL|KEYC_SHIFT }, 147 { "\033[17@", KEYC_F6|KEYC_CTRL|KEYC_SHIFT }, 148 { "\033[18@", KEYC_F7|KEYC_CTRL|KEYC_SHIFT }, 149 { "\033[19@", KEYC_F8|KEYC_CTRL|KEYC_SHIFT }, 150 { "\033[20@", KEYC_F9|KEYC_CTRL|KEYC_SHIFT }, 151 { "\033[21@", KEYC_F10|KEYC_CTRL|KEYC_SHIFT }, 152 { "\033[23@", KEYC_F11|KEYC_CTRL|KEYC_SHIFT }, 153 { "\033[24@", KEYC_F12|KEYC_CTRL|KEYC_SHIFT }, 154 { "\033[2@", KEYC_IC|KEYC_CTRL|KEYC_SHIFT }, 155 { "\033[3@", KEYC_DC|KEYC_CTRL|KEYC_SHIFT }, 156 { "\033[7@", KEYC_HOME|KEYC_CTRL|KEYC_SHIFT }, 157 { "\033[8@", KEYC_END|KEYC_CTRL|KEYC_SHIFT }, 158 { "\033[6@", KEYC_NPAGE|KEYC_CTRL|KEYC_SHIFT }, 159 { "\033[5@", KEYC_PPAGE|KEYC_CTRL|KEYC_SHIFT }, 160 161 /* Focus tracking. */ 162 { "\033[I", KEYC_FOCUS_IN }, 163 { "\033[O", KEYC_FOCUS_OUT }, 164 }; 165 166 /* Default terminfo(5) keys. */ 167 struct tty_default_key_code { 168 enum tty_code_code code; 169 int key; 170 }; 171 const struct tty_default_key_code tty_default_code_keys[] = { 172 /* Function keys. */ 173 { TTYC_KF1, KEYC_F1 }, 174 { TTYC_KF2, KEYC_F2 }, 175 { TTYC_KF3, KEYC_F3 }, 176 { TTYC_KF4, KEYC_F4 }, 177 { TTYC_KF5, KEYC_F5 }, 178 { TTYC_KF6, KEYC_F6 }, 179 { TTYC_KF7, KEYC_F7 }, 180 { TTYC_KF8, KEYC_F8 }, 181 { TTYC_KF9, KEYC_F9 }, 182 { TTYC_KF10, KEYC_F10 }, 183 { TTYC_KF11, KEYC_F11 }, 184 { TTYC_KF12, KEYC_F12 }, 185 186 { TTYC_KF13, KEYC_F1|KEYC_SHIFT }, 187 { TTYC_KF14, KEYC_F2|KEYC_SHIFT }, 188 { TTYC_KF15, KEYC_F3|KEYC_SHIFT }, 189 { TTYC_KF16, KEYC_F4|KEYC_SHIFT }, 190 { TTYC_KF17, KEYC_F5|KEYC_SHIFT }, 191 { TTYC_KF18, KEYC_F6|KEYC_SHIFT }, 192 { TTYC_KF19, KEYC_F7|KEYC_SHIFT }, 193 { TTYC_KF20, KEYC_F8|KEYC_SHIFT }, 194 { TTYC_KF21, KEYC_F9|KEYC_SHIFT }, 195 { TTYC_KF22, KEYC_F10|KEYC_SHIFT }, 196 { TTYC_KF23, KEYC_F11|KEYC_SHIFT }, 197 { TTYC_KF24, KEYC_F12|KEYC_SHIFT }, 198 199 { TTYC_KF25, KEYC_F1|KEYC_CTRL }, 200 { TTYC_KF26, KEYC_F2|KEYC_CTRL }, 201 { TTYC_KF27, KEYC_F3|KEYC_CTRL }, 202 { TTYC_KF28, KEYC_F4|KEYC_CTRL }, 203 { TTYC_KF29, KEYC_F5|KEYC_CTRL }, 204 { TTYC_KF30, KEYC_F6|KEYC_CTRL }, 205 { TTYC_KF31, KEYC_F7|KEYC_CTRL }, 206 { TTYC_KF32, KEYC_F8|KEYC_CTRL }, 207 { TTYC_KF33, KEYC_F9|KEYC_CTRL }, 208 { TTYC_KF34, KEYC_F10|KEYC_CTRL }, 209 { TTYC_KF35, KEYC_F11|KEYC_CTRL }, 210 { TTYC_KF36, KEYC_F12|KEYC_CTRL }, 211 212 { TTYC_KF37, KEYC_F1|KEYC_SHIFT|KEYC_CTRL }, 213 { TTYC_KF38, KEYC_F2|KEYC_SHIFT|KEYC_CTRL }, 214 { TTYC_KF39, KEYC_F3|KEYC_SHIFT|KEYC_CTRL }, 215 { TTYC_KF40, KEYC_F4|KEYC_SHIFT|KEYC_CTRL }, 216 { TTYC_KF41, KEYC_F5|KEYC_SHIFT|KEYC_CTRL }, 217 { TTYC_KF42, KEYC_F6|KEYC_SHIFT|KEYC_CTRL }, 218 { TTYC_KF43, KEYC_F7|KEYC_SHIFT|KEYC_CTRL }, 219 { TTYC_KF44, KEYC_F8|KEYC_SHIFT|KEYC_CTRL }, 220 { TTYC_KF45, KEYC_F9|KEYC_SHIFT|KEYC_CTRL }, 221 { TTYC_KF46, KEYC_F10|KEYC_SHIFT|KEYC_CTRL }, 222 { TTYC_KF47, KEYC_F11|KEYC_SHIFT|KEYC_CTRL }, 223 { TTYC_KF48, KEYC_F12|KEYC_SHIFT|KEYC_CTRL }, 224 225 { TTYC_KF49, KEYC_F1|KEYC_ESCAPE }, 226 { TTYC_KF50, KEYC_F2|KEYC_ESCAPE }, 227 { TTYC_KF51, KEYC_F3|KEYC_ESCAPE }, 228 { TTYC_KF52, KEYC_F4|KEYC_ESCAPE }, 229 { TTYC_KF53, KEYC_F5|KEYC_ESCAPE }, 230 { TTYC_KF54, KEYC_F6|KEYC_ESCAPE }, 231 { TTYC_KF55, KEYC_F7|KEYC_ESCAPE }, 232 { TTYC_KF56, KEYC_F8|KEYC_ESCAPE }, 233 { TTYC_KF57, KEYC_F9|KEYC_ESCAPE }, 234 { TTYC_KF58, KEYC_F10|KEYC_ESCAPE }, 235 { TTYC_KF59, KEYC_F11|KEYC_ESCAPE }, 236 { TTYC_KF60, KEYC_F12|KEYC_ESCAPE }, 237 238 { TTYC_KF61, KEYC_F1|KEYC_ESCAPE|KEYC_SHIFT }, 239 { TTYC_KF62, KEYC_F2|KEYC_ESCAPE|KEYC_SHIFT }, 240 { TTYC_KF63, KEYC_F3|KEYC_ESCAPE|KEYC_SHIFT }, 241 242 { TTYC_KICH1, KEYC_IC }, 243 { TTYC_KDCH1, KEYC_DC }, 244 { TTYC_KHOME, KEYC_HOME }, 245 { TTYC_KEND, KEYC_END }, 246 { TTYC_KNP, KEYC_NPAGE }, 247 { TTYC_KPP, KEYC_PPAGE }, 248 { TTYC_KCBT, KEYC_BTAB }, 249 250 /* Arrow keys from terminfo. */ 251 { TTYC_KCUU1, KEYC_UP }, 252 { TTYC_KCUD1, KEYC_DOWN }, 253 { TTYC_KCUB1, KEYC_LEFT }, 254 { TTYC_KCUF1, KEYC_RIGHT }, 255 256 /* Key and modifier capabilities. */ 257 { TTYC_KDC2, KEYC_DC|KEYC_SHIFT }, 258 { TTYC_KDC3, KEYC_DC|KEYC_ESCAPE }, 259 { TTYC_KDC4, KEYC_DC|KEYC_SHIFT|KEYC_ESCAPE }, 260 { TTYC_KDC5, KEYC_DC|KEYC_CTRL }, 261 { TTYC_KDC6, KEYC_DC|KEYC_SHIFT|KEYC_CTRL }, 262 { TTYC_KDC7, KEYC_DC|KEYC_ESCAPE|KEYC_CTRL }, 263 { TTYC_KDN2, KEYC_DOWN|KEYC_SHIFT }, 264 { TTYC_KDN3, KEYC_DOWN|KEYC_ESCAPE }, 265 { TTYC_KDN4, KEYC_DOWN|KEYC_SHIFT|KEYC_ESCAPE }, 266 { TTYC_KDN5, KEYC_DOWN|KEYC_CTRL }, 267 { TTYC_KDN6, KEYC_DOWN|KEYC_SHIFT|KEYC_CTRL }, 268 { TTYC_KDN7, KEYC_DOWN|KEYC_ESCAPE|KEYC_CTRL }, 269 { TTYC_KEND2, KEYC_END|KEYC_SHIFT }, 270 { TTYC_KEND3, KEYC_END|KEYC_ESCAPE }, 271 { TTYC_KEND4, KEYC_END|KEYC_SHIFT|KEYC_ESCAPE }, 272 { TTYC_KEND5, KEYC_END|KEYC_CTRL }, 273 { TTYC_KEND6, KEYC_END|KEYC_SHIFT|KEYC_CTRL }, 274 { TTYC_KEND7, KEYC_END|KEYC_ESCAPE|KEYC_CTRL }, 275 { TTYC_KHOM2, KEYC_HOME|KEYC_SHIFT }, 276 { TTYC_KHOM3, KEYC_HOME|KEYC_ESCAPE }, 277 { TTYC_KHOM4, KEYC_HOME|KEYC_SHIFT|KEYC_ESCAPE }, 278 { TTYC_KHOM5, KEYC_HOME|KEYC_CTRL }, 279 { TTYC_KHOM6, KEYC_HOME|KEYC_SHIFT|KEYC_CTRL }, 280 { TTYC_KHOM7, KEYC_HOME|KEYC_ESCAPE|KEYC_CTRL }, 281 { TTYC_KIC2, KEYC_IC|KEYC_SHIFT }, 282 { TTYC_KIC3, KEYC_IC|KEYC_ESCAPE }, 283 { TTYC_KIC4, KEYC_IC|KEYC_SHIFT|KEYC_ESCAPE }, 284 { TTYC_KIC5, KEYC_IC|KEYC_CTRL }, 285 { TTYC_KIC6, KEYC_IC|KEYC_SHIFT|KEYC_CTRL }, 286 { TTYC_KIC7, KEYC_IC|KEYC_ESCAPE|KEYC_CTRL }, 287 { TTYC_KLFT2, KEYC_LEFT|KEYC_SHIFT }, 288 { TTYC_KLFT3, KEYC_LEFT|KEYC_ESCAPE }, 289 { TTYC_KLFT4, KEYC_LEFT|KEYC_SHIFT|KEYC_ESCAPE }, 290 { TTYC_KLFT5, KEYC_LEFT|KEYC_CTRL }, 291 { TTYC_KLFT6, KEYC_LEFT|KEYC_SHIFT|KEYC_CTRL }, 292 { TTYC_KLFT7, KEYC_LEFT|KEYC_ESCAPE|KEYC_CTRL }, 293 { TTYC_KNXT2, KEYC_NPAGE|KEYC_SHIFT }, 294 { TTYC_KNXT3, KEYC_NPAGE|KEYC_ESCAPE }, 295 { TTYC_KNXT4, KEYC_NPAGE|KEYC_SHIFT|KEYC_ESCAPE }, 296 { TTYC_KNXT5, KEYC_NPAGE|KEYC_CTRL }, 297 { TTYC_KNXT6, KEYC_NPAGE|KEYC_SHIFT|KEYC_CTRL }, 298 { TTYC_KNXT7, KEYC_NPAGE|KEYC_ESCAPE|KEYC_CTRL }, 299 { TTYC_KPRV2, KEYC_PPAGE|KEYC_SHIFT }, 300 { TTYC_KPRV3, KEYC_PPAGE|KEYC_ESCAPE }, 301 { TTYC_KPRV4, KEYC_PPAGE|KEYC_SHIFT|KEYC_ESCAPE }, 302 { TTYC_KPRV5, KEYC_PPAGE|KEYC_CTRL }, 303 { TTYC_KPRV6, KEYC_PPAGE|KEYC_SHIFT|KEYC_CTRL }, 304 { TTYC_KPRV7, KEYC_PPAGE|KEYC_ESCAPE|KEYC_CTRL }, 305 { TTYC_KRIT2, KEYC_RIGHT|KEYC_SHIFT }, 306 { TTYC_KRIT3, KEYC_RIGHT|KEYC_ESCAPE }, 307 { TTYC_KRIT4, KEYC_RIGHT|KEYC_SHIFT|KEYC_ESCAPE }, 308 { TTYC_KRIT5, KEYC_RIGHT|KEYC_CTRL }, 309 { TTYC_KRIT6, KEYC_RIGHT|KEYC_SHIFT|KEYC_CTRL }, 310 { TTYC_KRIT7, KEYC_RIGHT|KEYC_ESCAPE|KEYC_CTRL }, 311 { TTYC_KUP2, KEYC_UP|KEYC_SHIFT }, 312 { TTYC_KUP3, KEYC_UP|KEYC_ESCAPE }, 313 { TTYC_KUP4, KEYC_UP|KEYC_SHIFT|KEYC_ESCAPE }, 314 { TTYC_KUP5, KEYC_UP|KEYC_CTRL }, 315 { TTYC_KUP6, KEYC_UP|KEYC_SHIFT|KEYC_CTRL }, 316 { TTYC_KUP7, KEYC_UP|KEYC_ESCAPE|KEYC_CTRL }, 317 }; 318 319 /* Add key to tree. */ 320 void 321 tty_keys_add(struct tty *tty, const char *s, int key) 322 { 323 struct tty_key *tk; 324 size_t size; 325 const char *keystr; 326 327 keystr = key_string_lookup_key(key); 328 if ((tk = tty_keys_find(tty, s, strlen(s), &size)) == NULL) { 329 log_debug("new key %s: 0x%x (%s)", s, key, keystr); 330 tty_keys_add1(&tty->key_tree, s, key); 331 } else { 332 log_debug("replacing key %s: 0x%x (%s)", s, key, keystr); 333 tk->key = key; 334 } 335 } 336 337 /* Add next node to the tree. */ 338 void 339 tty_keys_add1(struct tty_key **tkp, const char *s, int key) 340 { 341 struct tty_key *tk; 342 343 /* Allocate a tree entry if there isn't one already. */ 344 tk = *tkp; 345 if (tk == NULL) { 346 tk = *tkp = xcalloc(1, sizeof *tk); 347 tk->ch = *s; 348 tk->key = KEYC_NONE; 349 } 350 351 /* Find the next entry. */ 352 if (*s == tk->ch) { 353 /* Move forward in string. */ 354 s++; 355 356 /* If this is the end of the string, no more is necessary. */ 357 if (*s == '\0') { 358 tk->key = key; 359 return; 360 } 361 362 /* Use the child tree for the next character. */ 363 tkp = &tk->next; 364 } else { 365 if (*s < tk->ch) 366 tkp = &tk->left; 367 else if (*s > tk->ch) 368 tkp = &tk->right; 369 } 370 371 /* And recurse to add it. */ 372 tty_keys_add1(tkp, s, key); 373 } 374 375 /* Initialise a key tree from the table. */ 376 void 377 tty_keys_build(struct tty *tty) 378 { 379 const struct tty_default_key_raw *tdkr; 380 const struct tty_default_key_code *tdkc; 381 u_int i; 382 const char *s; 383 384 if (tty->key_tree != NULL) 385 tty_keys_free(tty); 386 tty->key_tree = NULL; 387 388 for (i = 0; i < nitems(tty_default_raw_keys); i++) { 389 tdkr = &tty_default_raw_keys[i]; 390 391 s = tdkr->string; 392 if (*s != '\0') 393 tty_keys_add(tty, s, tdkr->key); 394 } 395 for (i = 0; i < nitems(tty_default_code_keys); i++) { 396 tdkc = &tty_default_code_keys[i]; 397 398 s = tty_term_string(tty->term, tdkc->code); 399 if (*s != '\0') 400 tty_keys_add(tty, s, tdkc->key); 401 402 } 403 } 404 405 /* Free the entire key tree. */ 406 void 407 tty_keys_free(struct tty *tty) 408 { 409 tty_keys_free1(tty->key_tree); 410 } 411 412 /* Free a single key. */ 413 void 414 tty_keys_free1(struct tty_key *tk) 415 { 416 if (tk->next != NULL) 417 tty_keys_free1(tk->next); 418 if (tk->left != NULL) 419 tty_keys_free1(tk->left); 420 if (tk->right != NULL) 421 tty_keys_free1(tk->right); 422 free(tk); 423 } 424 425 /* Lookup a key in the tree. */ 426 struct tty_key * 427 tty_keys_find(struct tty *tty, const char *buf, size_t len, size_t *size) 428 { 429 *size = 0; 430 return (tty_keys_find1(tty->key_tree, buf, len, size)); 431 } 432 433 /* Find the next node. */ 434 struct tty_key * 435 tty_keys_find1(struct tty_key *tk, const char *buf, size_t len, size_t *size) 436 { 437 /* If the node is NULL, this is the end of the tree. No match. */ 438 if (tk == NULL) 439 return (NULL); 440 441 /* Pick the next in the sequence. */ 442 if (tk->ch == *buf) { 443 /* Move forward in the string. */ 444 buf++; len--; 445 (*size)++; 446 447 /* At the end of the string, return the current node. */ 448 if (len == 0 || (tk->next == NULL && tk->key != KEYC_NONE)) 449 return (tk); 450 451 /* Move into the next tree for the following character. */ 452 tk = tk->next; 453 } else { 454 if (*buf < tk->ch) 455 tk = tk->left; 456 else if (*buf > tk->ch) 457 tk = tk->right; 458 } 459 460 /* Move to the next in the tree. */ 461 return (tty_keys_find1(tk, buf, len, size)); 462 } 463 464 /* 465 * Process at least one key in the buffer and invoke tty->key_callback. Return 466 * 0 if there are no further keys, or 1 if there could be more in the buffer. 467 */ 468 int 469 tty_keys_next(struct tty *tty) 470 { 471 struct tty_key *tk; 472 struct timeval tv; 473 const char *buf; 474 size_t len, size; 475 cc_t bspace; 476 int key, delay, expired = 0; 477 478 /* Get key buffer. */ 479 buf = EVBUFFER_DATA(tty->event->input); 480 len = EVBUFFER_LENGTH(tty->event->input); 481 if (len == 0) 482 return (0); 483 log_debug("keys are %zu (%.*s)", len, (int) len, buf); 484 485 /* Is this device attributes response? */ 486 switch (tty_keys_device(tty, buf, len, &size)) { 487 case 0: /* yes */ 488 key = KEYC_NONE; 489 goto complete_key; 490 case -1: /* no, or not valid */ 491 break; 492 case 1: /* partial */ 493 goto partial_key; 494 } 495 496 /* Is this a mouse key press? */ 497 switch (tty_keys_mouse(tty, buf, len, &size)) { 498 case 0: /* yes */ 499 key = KEYC_MOUSE; 500 goto complete_key; 501 case -1: /* no, or not valid */ 502 break; 503 case -2: /* yes, but we don't care. */ 504 goto discard_key; 505 case 1: /* partial */ 506 goto partial_key; 507 } 508 509 /* Look for matching key string and return if found. */ 510 tk = tty_keys_find(tty, buf, len, &size); 511 if (tk != NULL) { 512 if (tk->next != NULL) 513 goto partial_key; 514 key = tk->key; 515 goto complete_key; 516 } 517 518 /* Try to parse a key with an xterm-style modifier. */ 519 switch (xterm_keys_find(buf, len, &size, &key)) { 520 case 0: /* found */ 521 goto complete_key; 522 case -1: /* not found */ 523 break; 524 case 1: 525 goto partial_key; 526 } 527 528 first_key: 529 /* Is this a meta key? */ 530 if (len >= 2 && buf[0] == '\033') { 531 if (buf[1] != '\033') { 532 key = buf[1] | KEYC_ESCAPE; 533 size = 2; 534 goto complete_key; 535 } 536 537 tk = tty_keys_find(tty, buf + 1, len - 1, &size); 538 if (tk != NULL && (!expired || tk->next == NULL)) { 539 size++; /* include escape */ 540 if (tk->next != NULL) 541 goto partial_key; 542 key = tk->key; 543 if (key != KEYC_NONE) 544 key |= KEYC_ESCAPE; 545 goto complete_key; 546 } 547 } 548 549 /* No key found, take first. */ 550 key = (u_char) *buf; 551 size = 1; 552 553 /* 554 * Check for backspace key using termios VERASE - the terminfo 555 * kbs entry is extremely unreliable, so cannot be safely 556 * used. termios should have a better idea. 557 */ 558 bspace = tty->tio.c_cc[VERASE]; 559 if (bspace != _POSIX_VDISABLE && key == bspace) 560 key = KEYC_BSPACE; 561 562 goto complete_key; 563 564 partial_key: 565 log_debug("partial key %.*s", (int) len, buf); 566 567 /* If timer is going, check for expiration. */ 568 if (tty->flags & TTY_TIMER) { 569 if (evtimer_initialized(&tty->key_timer) && 570 !evtimer_pending(&tty->key_timer, NULL)) { 571 expired = 1; 572 goto first_key; 573 } 574 return (0); 575 } 576 577 /* Get the time period. */ 578 delay = options_get_number(&global_options, "escape-time"); 579 tv.tv_sec = delay / 1000; 580 tv.tv_usec = (delay % 1000) * 1000L; 581 582 /* Start the timer. */ 583 if (event_initialized(&tty->key_timer)) 584 evtimer_del(&tty->key_timer); 585 evtimer_set(&tty->key_timer, tty_keys_callback, tty); 586 evtimer_add(&tty->key_timer, &tv); 587 588 tty->flags |= TTY_TIMER; 589 return (0); 590 591 complete_key: 592 log_debug("complete key %.*s %#x", (int) size, buf, key); 593 594 /* Remove data from buffer. */ 595 evbuffer_drain(tty->event->input, size); 596 597 /* Remove key timer. */ 598 if (event_initialized(&tty->key_timer)) 599 evtimer_del(&tty->key_timer); 600 tty->flags &= ~TTY_TIMER; 601 602 /* Check for focus events. */ 603 if (key == KEYC_FOCUS_OUT) { 604 tty->client->flags &= ~CLIENT_FOCUSED; 605 return (1); 606 } else if (key == KEYC_FOCUS_IN) { 607 tty->client->flags |= CLIENT_FOCUSED; 608 return (1); 609 } 610 611 /* Fire the key. */ 612 if (key != KEYC_NONE) 613 server_client_handle_key(tty->client, key); 614 615 return (1); 616 617 discard_key: 618 log_debug("discard key %.*s %#x", (int) size, buf, key); 619 620 /* Remove data from buffer. */ 621 evbuffer_drain(tty->event->input, size); 622 623 return (1); 624 } 625 626 /* Key timer callback. */ 627 void 628 tty_keys_callback(unused int fd, unused short events, void *data) 629 { 630 struct tty *tty = data; 631 632 if (tty->flags & TTY_TIMER) { 633 while (tty_keys_next(tty)) 634 ; 635 } 636 } 637 638 /* 639 * Handle mouse key input. Returns 0 for success, -1 for failure, 1 for partial 640 * (probably a mouse sequence but need more data). 641 */ 642 int 643 tty_keys_mouse(struct tty *tty, const char *buf, size_t len, size_t *size) 644 { 645 struct mouse_event *m = &tty->mouse; 646 struct utf8_data utf8data; 647 u_int i, value, x, y, b, sgr_b; 648 u_char sgr_type, c; 649 650 /* 651 * Standard mouse sequences are \033[M followed by three characters 652 * indicating button, X and Y, all based at 32 with 1,1 top-left. 653 * 654 * UTF-8 mouse sequences are similar but the three are expressed as 655 * UTF-8 characters. 656 * 657 * SGR extended mouse sequences are \033[< followed by three numbers in 658 * decimal and separated by semicolons indicating button, X and Y. A 659 * trailing 'M' is click or scroll and trailing 'm' release. All are 660 * based at 0 with 1,1 top-left. 661 */ 662 663 *size = 0; 664 x = y = b = sgr_b = 0; 665 sgr_type = ' '; 666 667 /* First two bytes are always \033[. */ 668 if (buf[0] != '\033') 669 return (-1); 670 if (len == 1) 671 return (1); 672 if (buf[1] != '[') 673 return (-1); 674 if (len == 2) 675 return (1); 676 677 /* 678 * Third byte is M in old standard and UTF-8 extension, < in SGR 679 * extension. 680 */ 681 if (buf[2] == 'M') { 682 /* Read the three inputs. */ 683 *size = 3; 684 for (i = 0; i < 3; i++) { 685 if (len <= *size) 686 return (1); 687 688 if (tty->mode & MODE_MOUSE_UTF8) { 689 if (utf8_open(&utf8data, buf[*size])) { 690 if (utf8data.size != 2) 691 return (-1); 692 (*size)++; 693 if (len <= *size) 694 return (1); 695 utf8_append(&utf8data, buf[*size]); 696 value = utf8_combine(&utf8data); 697 } else 698 value = (u_char) buf[*size]; 699 (*size)++; 700 } else { 701 value = (u_char) buf[*size]; 702 (*size)++; 703 } 704 705 if (i == 0) 706 b = value; 707 else if (i == 1) 708 x = value; 709 else 710 y = value; 711 } 712 log_debug("mouse input: %.*s", (int)*size, buf); 713 714 /* Check and return the mouse input. */ 715 if (b < 32) 716 return (-1); 717 b -= 32; 718 if (x >= 33) 719 x -= 33; 720 else 721 x = 256 - x; 722 if (y >= 33) 723 y -= 33; 724 else 725 y = 256 - y; 726 } else if (buf[2] == '<') { 727 /* Read the three inputs. */ 728 *size = 3; 729 while (1) { 730 if (len <= *size) 731 return (1); 732 c = (u_char)buf[(*size)++]; 733 if (c == ';') 734 break; 735 if (c < '0' || c > '9') 736 return (-1); 737 sgr_b = 10 * sgr_b + (c - '0'); 738 } 739 while (1) { 740 if (len <= *size) 741 return (1); 742 c = (u_char)buf[(*size)++]; 743 if (c == ';') 744 break; 745 if (c < '0' || c > '9') 746 return (-1); 747 x = 10 * x + (c - '0'); 748 } 749 while (1) { 750 if (len <= *size) 751 return (1); 752 c = (u_char)buf[(*size)++]; 753 if (c == 'M' || c == 'm') 754 break; 755 if (c < '0' || c > '9') 756 return (-1); 757 y = 10 * y + (c - '0'); 758 } 759 log_debug("mouse input (SGR): %.*s", (int)*size, buf); 760 761 /* Check and return the mouse input. */ 762 if (x < 1 || y < 1) 763 return (-1); 764 x--; 765 y--; 766 b = sgr_b; 767 768 /* Type is M for press, m for release. */ 769 sgr_type = c; 770 if (sgr_type == 'm') 771 b |= 3; 772 773 /* 774 * Some terminals (like PuTTY 0.63) mistakenly send 775 * button-release events for scroll-wheel button-press event. 776 * Discard it before it reaches any program running inside 777 * tmux. 778 */ 779 if (sgr_type == 'm' && (sgr_b & 64)) 780 return (-2); 781 } else 782 return (-1); 783 784 /* Fill mouse event. */ 785 m->lx = m->x; 786 m->x = x; 787 m->ly = m->y; 788 m->y = y; 789 m->lb = m->b; 790 m->b = b; 791 m->sgr_type = sgr_type; 792 m->sgr_b = sgr_b; 793 794 return (0); 795 } 796 797 /* 798 * Handle device attributes input. Returns 0 for success, -1 for failure, 1 for 799 * partial. 800 */ 801 int 802 tty_keys_device(struct tty *tty, const char *buf, size_t len, size_t *size) 803 { 804 u_int i, class; 805 char tmp[64], *endptr; 806 807 /* 808 * Primary device attributes are \033[?a;b and secondary are 809 * \033[>a;b;c. 810 */ 811 812 *size = 0; 813 814 /* First three bytes are always \033[?. */ 815 if (buf[0] != '\033') 816 return (-1); 817 if (len == 1) 818 return (1); 819 if (buf[1] != '[') 820 return (-1); 821 if (len == 2) 822 return (1); 823 if (buf[2] != '>' && buf[2] != '?') 824 return (-1); 825 if (len == 3) 826 return (1); 827 828 /* Copy the rest up to a 'c'. */ 829 for (i = 0; i < (sizeof tmp) - 1 && buf[3 + i] != 'c'; i++) { 830 if (3 + i == len) 831 return (1); 832 tmp[i] = buf[3 + i]; 833 } 834 if (i == (sizeof tmp) - 1) 835 return (-1); 836 tmp[i] = '\0'; 837 *size = 4 + i; 838 839 /* Only primary is of interest. */ 840 if (buf[2] != '?') 841 return (0); 842 843 /* Convert service class. */ 844 class = strtoul(tmp, &endptr, 10); 845 if (*endptr != ';') 846 class = 0; 847 848 log_debug("received service class %u", class); 849 tty_set_class(tty, class); 850 851 return (0); 852 } 853