1 /* $OpenBSD: tty-keys.c,v 1.103 2018/08/16 14:04:03 nicm Exp $ */ 2 3 /* 4 * Copyright (c) 2007 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 #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 static void tty_keys_add1(struct tty_key **, const char *, key_code); 37 static void tty_keys_add(struct tty *, const char *, key_code); 38 static void tty_keys_free1(struct tty_key *); 39 static struct tty_key *tty_keys_find1(struct tty_key *, const char *, size_t, 40 size_t *); 41 static struct tty_key *tty_keys_find(struct tty *, const char *, size_t, 42 size_t *); 43 static int tty_keys_next1(struct tty *, const char *, size_t, key_code *, 44 size_t *, int); 45 static void tty_keys_callback(int, short, void *); 46 static int tty_keys_mouse(struct tty *, const char *, size_t, size_t *); 47 static int tty_keys_device_attributes(struct tty *, const char *, size_t, 48 size_t *); 49 50 /* Default raw keys. */ 51 struct tty_default_key_raw { 52 const char *string; 53 key_code key; 54 }; 55 static const struct tty_default_key_raw tty_default_raw_keys[] = { 56 /* 57 * Numeric keypad. Just use the vt100 escape sequences here and always 58 * put the terminal into keypad_xmit mode. Translation of numbers 59 * mode/applications mode is done in input-keys.c. 60 */ 61 { "\033Oo", KEYC_KP_SLASH }, 62 { "\033Oj", KEYC_KP_STAR }, 63 { "\033Om", KEYC_KP_MINUS }, 64 { "\033Ow", KEYC_KP_SEVEN }, 65 { "\033Ox", KEYC_KP_EIGHT }, 66 { "\033Oy", KEYC_KP_NINE }, 67 { "\033Ok", KEYC_KP_PLUS }, 68 { "\033Ot", KEYC_KP_FOUR }, 69 { "\033Ou", KEYC_KP_FIVE }, 70 { "\033Ov", KEYC_KP_SIX }, 71 { "\033Oq", KEYC_KP_ONE }, 72 { "\033Or", KEYC_KP_TWO }, 73 { "\033Os", KEYC_KP_THREE }, 74 { "\033OM", KEYC_KP_ENTER }, 75 { "\033Op", KEYC_KP_ZERO }, 76 { "\033On", KEYC_KP_PERIOD }, 77 78 /* Arrow keys. */ 79 { "\033OA", KEYC_UP }, 80 { "\033OB", KEYC_DOWN }, 81 { "\033OC", KEYC_RIGHT }, 82 { "\033OD", KEYC_LEFT }, 83 84 { "\033[A", KEYC_UP }, 85 { "\033[B", KEYC_DOWN }, 86 { "\033[C", KEYC_RIGHT }, 87 { "\033[D", KEYC_LEFT }, 88 89 /* Other (xterm) "cursor" keys. */ 90 { "\033OH", KEYC_HOME }, 91 { "\033OF", KEYC_END }, 92 93 { "\033[H", KEYC_HOME }, 94 { "\033[F", KEYC_END }, 95 96 /* rxvt-style arrow + modifier keys. */ 97 { "\033Oa", KEYC_UP|KEYC_CTRL }, 98 { "\033Ob", KEYC_DOWN|KEYC_CTRL }, 99 { "\033Oc", KEYC_RIGHT|KEYC_CTRL }, 100 { "\033Od", KEYC_LEFT|KEYC_CTRL }, 101 102 { "\033[a", KEYC_UP|KEYC_SHIFT }, 103 { "\033[b", KEYC_DOWN|KEYC_SHIFT }, 104 { "\033[c", KEYC_RIGHT|KEYC_SHIFT }, 105 { "\033[d", KEYC_LEFT|KEYC_SHIFT }, 106 107 /* rxvt-style function + modifier keys (C = ^, S = $, C-S = @). */ 108 { "\033[11^", KEYC_F1|KEYC_CTRL }, 109 { "\033[12^", KEYC_F2|KEYC_CTRL }, 110 { "\033[13^", KEYC_F3|KEYC_CTRL }, 111 { "\033[14^", KEYC_F4|KEYC_CTRL }, 112 { "\033[15^", KEYC_F5|KEYC_CTRL }, 113 { "\033[17^", KEYC_F6|KEYC_CTRL }, 114 { "\033[18^", KEYC_F7|KEYC_CTRL }, 115 { "\033[19^", KEYC_F8|KEYC_CTRL }, 116 { "\033[20^", KEYC_F9|KEYC_CTRL }, 117 { "\033[21^", KEYC_F10|KEYC_CTRL }, 118 { "\033[23^", KEYC_F11|KEYC_CTRL }, 119 { "\033[24^", KEYC_F12|KEYC_CTRL }, 120 { "\033[2^", KEYC_IC|KEYC_CTRL }, 121 { "\033[3^", KEYC_DC|KEYC_CTRL }, 122 { "\033[7^", KEYC_HOME|KEYC_CTRL }, 123 { "\033[8^", KEYC_END|KEYC_CTRL }, 124 { "\033[6^", KEYC_NPAGE|KEYC_CTRL }, 125 { "\033[5^", KEYC_PPAGE|KEYC_CTRL }, 126 127 { "\033[11$", KEYC_F1|KEYC_SHIFT }, 128 { "\033[12$", KEYC_F2|KEYC_SHIFT }, 129 { "\033[13$", KEYC_F3|KEYC_SHIFT }, 130 { "\033[14$", KEYC_F4|KEYC_SHIFT }, 131 { "\033[15$", KEYC_F5|KEYC_SHIFT }, 132 { "\033[17$", KEYC_F6|KEYC_SHIFT }, 133 { "\033[18$", KEYC_F7|KEYC_SHIFT }, 134 { "\033[19$", KEYC_F8|KEYC_SHIFT }, 135 { "\033[20$", KEYC_F9|KEYC_SHIFT }, 136 { "\033[21$", KEYC_F10|KEYC_SHIFT }, 137 { "\033[23$", KEYC_F11|KEYC_SHIFT }, 138 { "\033[24$", KEYC_F12|KEYC_SHIFT }, 139 { "\033[2$", KEYC_IC|KEYC_SHIFT }, 140 { "\033[3$", KEYC_DC|KEYC_SHIFT }, 141 { "\033[7$", KEYC_HOME|KEYC_SHIFT }, 142 { "\033[8$", KEYC_END|KEYC_SHIFT }, 143 { "\033[6$", KEYC_NPAGE|KEYC_SHIFT }, 144 { "\033[5$", KEYC_PPAGE|KEYC_SHIFT }, 145 146 { "\033[11@", KEYC_F1|KEYC_CTRL|KEYC_SHIFT }, 147 { "\033[12@", KEYC_F2|KEYC_CTRL|KEYC_SHIFT }, 148 { "\033[13@", KEYC_F3|KEYC_CTRL|KEYC_SHIFT }, 149 { "\033[14@", KEYC_F4|KEYC_CTRL|KEYC_SHIFT }, 150 { "\033[15@", KEYC_F5|KEYC_CTRL|KEYC_SHIFT }, 151 { "\033[17@", KEYC_F6|KEYC_CTRL|KEYC_SHIFT }, 152 { "\033[18@", KEYC_F7|KEYC_CTRL|KEYC_SHIFT }, 153 { "\033[19@", KEYC_F8|KEYC_CTRL|KEYC_SHIFT }, 154 { "\033[20@", KEYC_F9|KEYC_CTRL|KEYC_SHIFT }, 155 { "\033[21@", KEYC_F10|KEYC_CTRL|KEYC_SHIFT }, 156 { "\033[23@", KEYC_F11|KEYC_CTRL|KEYC_SHIFT }, 157 { "\033[24@", KEYC_F12|KEYC_CTRL|KEYC_SHIFT }, 158 { "\033[2@", KEYC_IC|KEYC_CTRL|KEYC_SHIFT }, 159 { "\033[3@", KEYC_DC|KEYC_CTRL|KEYC_SHIFT }, 160 { "\033[7@", KEYC_HOME|KEYC_CTRL|KEYC_SHIFT }, 161 { "\033[8@", KEYC_END|KEYC_CTRL|KEYC_SHIFT }, 162 { "\033[6@", KEYC_NPAGE|KEYC_CTRL|KEYC_SHIFT }, 163 { "\033[5@", KEYC_PPAGE|KEYC_CTRL|KEYC_SHIFT }, 164 165 /* Focus tracking. */ 166 { "\033[I", KEYC_FOCUS_IN }, 167 { "\033[O", KEYC_FOCUS_OUT }, 168 169 /* Paste keys. */ 170 { "\033[200~", KEYC_PASTE_START }, 171 { "\033[201~", KEYC_PASTE_END }, 172 }; 173 174 /* 175 * Default terminfo(5) keys. Any keys that have builtin modifiers 176 * (that is, where the key itself contains the modifiers) has the 177 * KEYC_XTERM flag set so a leading escape is not treated as meta (and 178 * probably removed). 179 */ 180 struct tty_default_key_code { 181 enum tty_code_code code; 182 key_code key; 183 }; 184 static const struct tty_default_key_code tty_default_code_keys[] = { 185 /* Function keys. */ 186 { TTYC_KF1, KEYC_F1 }, 187 { TTYC_KF2, KEYC_F2 }, 188 { TTYC_KF3, KEYC_F3 }, 189 { TTYC_KF4, KEYC_F4 }, 190 { TTYC_KF5, KEYC_F5 }, 191 { TTYC_KF6, KEYC_F6 }, 192 { TTYC_KF7, KEYC_F7 }, 193 { TTYC_KF8, KEYC_F8 }, 194 { TTYC_KF9, KEYC_F9 }, 195 { TTYC_KF10, KEYC_F10 }, 196 { TTYC_KF11, KEYC_F11 }, 197 { TTYC_KF12, KEYC_F12 }, 198 199 { TTYC_KF13, KEYC_F1|KEYC_SHIFT|KEYC_XTERM }, 200 { TTYC_KF14, KEYC_F2|KEYC_SHIFT|KEYC_XTERM }, 201 { TTYC_KF15, KEYC_F3|KEYC_SHIFT|KEYC_XTERM }, 202 { TTYC_KF16, KEYC_F4|KEYC_SHIFT|KEYC_XTERM }, 203 { TTYC_KF17, KEYC_F5|KEYC_SHIFT|KEYC_XTERM }, 204 { TTYC_KF18, KEYC_F6|KEYC_SHIFT|KEYC_XTERM }, 205 { TTYC_KF19, KEYC_F7|KEYC_SHIFT|KEYC_XTERM }, 206 { TTYC_KF20, KEYC_F8|KEYC_SHIFT|KEYC_XTERM }, 207 { TTYC_KF21, KEYC_F9|KEYC_SHIFT|KEYC_XTERM }, 208 { TTYC_KF22, KEYC_F10|KEYC_SHIFT|KEYC_XTERM }, 209 { TTYC_KF23, KEYC_F11|KEYC_SHIFT|KEYC_XTERM }, 210 { TTYC_KF24, KEYC_F12|KEYC_SHIFT|KEYC_XTERM }, 211 212 { TTYC_KF25, KEYC_F1|KEYC_CTRL|KEYC_XTERM }, 213 { TTYC_KF26, KEYC_F2|KEYC_CTRL|KEYC_XTERM }, 214 { TTYC_KF27, KEYC_F3|KEYC_CTRL|KEYC_XTERM }, 215 { TTYC_KF28, KEYC_F4|KEYC_CTRL|KEYC_XTERM }, 216 { TTYC_KF29, KEYC_F5|KEYC_CTRL|KEYC_XTERM }, 217 { TTYC_KF30, KEYC_F6|KEYC_CTRL|KEYC_XTERM }, 218 { TTYC_KF31, KEYC_F7|KEYC_CTRL|KEYC_XTERM }, 219 { TTYC_KF32, KEYC_F8|KEYC_CTRL|KEYC_XTERM }, 220 { TTYC_KF33, KEYC_F9|KEYC_CTRL|KEYC_XTERM }, 221 { TTYC_KF34, KEYC_F10|KEYC_CTRL|KEYC_XTERM }, 222 { TTYC_KF35, KEYC_F11|KEYC_CTRL|KEYC_XTERM }, 223 { TTYC_KF36, KEYC_F12|KEYC_CTRL|KEYC_XTERM }, 224 225 { TTYC_KF37, KEYC_F1|KEYC_SHIFT|KEYC_CTRL|KEYC_XTERM }, 226 { TTYC_KF38, KEYC_F2|KEYC_SHIFT|KEYC_CTRL|KEYC_XTERM }, 227 { TTYC_KF39, KEYC_F3|KEYC_SHIFT|KEYC_CTRL|KEYC_XTERM }, 228 { TTYC_KF40, KEYC_F4|KEYC_SHIFT|KEYC_CTRL|KEYC_XTERM }, 229 { TTYC_KF41, KEYC_F5|KEYC_SHIFT|KEYC_CTRL|KEYC_XTERM }, 230 { TTYC_KF42, KEYC_F6|KEYC_SHIFT|KEYC_CTRL|KEYC_XTERM }, 231 { TTYC_KF43, KEYC_F7|KEYC_SHIFT|KEYC_CTRL|KEYC_XTERM }, 232 { TTYC_KF44, KEYC_F8|KEYC_SHIFT|KEYC_CTRL|KEYC_XTERM }, 233 { TTYC_KF45, KEYC_F9|KEYC_SHIFT|KEYC_CTRL|KEYC_XTERM }, 234 { TTYC_KF46, KEYC_F10|KEYC_SHIFT|KEYC_CTRL|KEYC_XTERM }, 235 { TTYC_KF47, KEYC_F11|KEYC_SHIFT|KEYC_CTRL|KEYC_XTERM }, 236 { TTYC_KF48, KEYC_F12|KEYC_SHIFT|KEYC_CTRL|KEYC_XTERM }, 237 238 { TTYC_KF49, KEYC_F1|KEYC_ESCAPE|KEYC_XTERM }, 239 { TTYC_KF50, KEYC_F2|KEYC_ESCAPE|KEYC_XTERM }, 240 { TTYC_KF51, KEYC_F3|KEYC_ESCAPE|KEYC_XTERM }, 241 { TTYC_KF52, KEYC_F4|KEYC_ESCAPE|KEYC_XTERM }, 242 { TTYC_KF53, KEYC_F5|KEYC_ESCAPE|KEYC_XTERM }, 243 { TTYC_KF54, KEYC_F6|KEYC_ESCAPE|KEYC_XTERM }, 244 { TTYC_KF55, KEYC_F7|KEYC_ESCAPE|KEYC_XTERM }, 245 { TTYC_KF56, KEYC_F8|KEYC_ESCAPE|KEYC_XTERM }, 246 { TTYC_KF57, KEYC_F9|KEYC_ESCAPE|KEYC_XTERM }, 247 { TTYC_KF58, KEYC_F10|KEYC_ESCAPE|KEYC_XTERM }, 248 { TTYC_KF59, KEYC_F11|KEYC_ESCAPE|KEYC_XTERM }, 249 { TTYC_KF60, KEYC_F12|KEYC_ESCAPE|KEYC_XTERM }, 250 251 { TTYC_KF61, KEYC_F1|KEYC_ESCAPE|KEYC_SHIFT|KEYC_XTERM }, 252 { TTYC_KF62, KEYC_F2|KEYC_ESCAPE|KEYC_SHIFT|KEYC_XTERM }, 253 { TTYC_KF63, KEYC_F3|KEYC_ESCAPE|KEYC_SHIFT|KEYC_XTERM }, 254 255 { TTYC_KICH1, KEYC_IC }, 256 { TTYC_KDCH1, KEYC_DC }, 257 { TTYC_KHOME, KEYC_HOME }, 258 { TTYC_KEND, KEYC_END }, 259 { TTYC_KNP, KEYC_NPAGE }, 260 { TTYC_KPP, KEYC_PPAGE }, 261 { TTYC_KCBT, KEYC_BTAB }, 262 263 /* Arrow keys from terminfo. */ 264 { TTYC_KCUU1, KEYC_UP }, 265 { TTYC_KCUD1, KEYC_DOWN }, 266 { TTYC_KCUB1, KEYC_LEFT }, 267 { TTYC_KCUF1, KEYC_RIGHT }, 268 269 /* Key and modifier capabilities. */ 270 { TTYC_KDC2, KEYC_DC|KEYC_SHIFT|KEYC_XTERM }, 271 { TTYC_KDC3, KEYC_DC|KEYC_ESCAPE|KEYC_XTERM }, 272 { TTYC_KDC4, KEYC_DC|KEYC_SHIFT|KEYC_ESCAPE|KEYC_XTERM }, 273 { TTYC_KDC5, KEYC_DC|KEYC_CTRL|KEYC_XTERM }, 274 { TTYC_KDC6, KEYC_DC|KEYC_SHIFT|KEYC_CTRL|KEYC_XTERM }, 275 { TTYC_KDC7, KEYC_DC|KEYC_ESCAPE|KEYC_CTRL|KEYC_XTERM }, 276 { TTYC_KIND, KEYC_DOWN|KEYC_SHIFT|KEYC_XTERM }, 277 { TTYC_KDN2, KEYC_DOWN|KEYC_SHIFT|KEYC_XTERM }, 278 { TTYC_KDN3, KEYC_DOWN|KEYC_ESCAPE|KEYC_XTERM }, 279 { TTYC_KDN4, KEYC_DOWN|KEYC_SHIFT|KEYC_ESCAPE|KEYC_XTERM }, 280 { TTYC_KDN5, KEYC_DOWN|KEYC_CTRL|KEYC_XTERM }, 281 { TTYC_KDN6, KEYC_DOWN|KEYC_SHIFT|KEYC_CTRL|KEYC_XTERM }, 282 { TTYC_KDN7, KEYC_DOWN|KEYC_ESCAPE|KEYC_CTRL|KEYC_XTERM }, 283 { TTYC_KEND2, KEYC_END|KEYC_SHIFT|KEYC_XTERM }, 284 { TTYC_KEND3, KEYC_END|KEYC_ESCAPE|KEYC_XTERM }, 285 { TTYC_KEND4, KEYC_END|KEYC_SHIFT|KEYC_ESCAPE|KEYC_XTERM }, 286 { TTYC_KEND5, KEYC_END|KEYC_CTRL|KEYC_XTERM }, 287 { TTYC_KEND6, KEYC_END|KEYC_SHIFT|KEYC_CTRL|KEYC_XTERM }, 288 { TTYC_KEND7, KEYC_END|KEYC_ESCAPE|KEYC_CTRL|KEYC_XTERM }, 289 { TTYC_KHOM2, KEYC_HOME|KEYC_SHIFT|KEYC_XTERM }, 290 { TTYC_KHOM3, KEYC_HOME|KEYC_ESCAPE|KEYC_XTERM }, 291 { TTYC_KHOM4, KEYC_HOME|KEYC_SHIFT|KEYC_ESCAPE|KEYC_XTERM }, 292 { TTYC_KHOM5, KEYC_HOME|KEYC_CTRL|KEYC_XTERM }, 293 { TTYC_KHOM6, KEYC_HOME|KEYC_SHIFT|KEYC_CTRL|KEYC_XTERM }, 294 { TTYC_KHOM7, KEYC_HOME|KEYC_ESCAPE|KEYC_CTRL|KEYC_XTERM }, 295 { TTYC_KIC2, KEYC_IC|KEYC_SHIFT|KEYC_XTERM }, 296 { TTYC_KIC3, KEYC_IC|KEYC_ESCAPE|KEYC_XTERM }, 297 { TTYC_KIC4, KEYC_IC|KEYC_SHIFT|KEYC_ESCAPE|KEYC_XTERM }, 298 { TTYC_KIC5, KEYC_IC|KEYC_CTRL|KEYC_XTERM }, 299 { TTYC_KIC6, KEYC_IC|KEYC_SHIFT|KEYC_CTRL|KEYC_XTERM }, 300 { TTYC_KIC7, KEYC_IC|KEYC_ESCAPE|KEYC_CTRL|KEYC_XTERM }, 301 { TTYC_KLFT2, KEYC_LEFT|KEYC_SHIFT|KEYC_XTERM }, 302 { TTYC_KLFT3, KEYC_LEFT|KEYC_ESCAPE|KEYC_XTERM }, 303 { TTYC_KLFT4, KEYC_LEFT|KEYC_SHIFT|KEYC_ESCAPE|KEYC_XTERM }, 304 { TTYC_KLFT5, KEYC_LEFT|KEYC_CTRL|KEYC_XTERM }, 305 { TTYC_KLFT6, KEYC_LEFT|KEYC_SHIFT|KEYC_CTRL|KEYC_XTERM }, 306 { TTYC_KLFT7, KEYC_LEFT|KEYC_ESCAPE|KEYC_CTRL|KEYC_XTERM }, 307 { TTYC_KNXT2, KEYC_NPAGE|KEYC_SHIFT|KEYC_XTERM }, 308 { TTYC_KNXT3, KEYC_NPAGE|KEYC_ESCAPE|KEYC_XTERM }, 309 { TTYC_KNXT4, KEYC_NPAGE|KEYC_SHIFT|KEYC_ESCAPE|KEYC_XTERM }, 310 { TTYC_KNXT5, KEYC_NPAGE|KEYC_CTRL|KEYC_XTERM }, 311 { TTYC_KNXT6, KEYC_NPAGE|KEYC_SHIFT|KEYC_CTRL|KEYC_XTERM }, 312 { TTYC_KNXT7, KEYC_NPAGE|KEYC_ESCAPE|KEYC_CTRL|KEYC_XTERM }, 313 { TTYC_KPRV2, KEYC_PPAGE|KEYC_SHIFT|KEYC_XTERM }, 314 { TTYC_KPRV3, KEYC_PPAGE|KEYC_ESCAPE|KEYC_XTERM }, 315 { TTYC_KPRV4, KEYC_PPAGE|KEYC_SHIFT|KEYC_ESCAPE|KEYC_XTERM }, 316 { TTYC_KPRV5, KEYC_PPAGE|KEYC_CTRL|KEYC_XTERM }, 317 { TTYC_KPRV6, KEYC_PPAGE|KEYC_SHIFT|KEYC_CTRL|KEYC_XTERM }, 318 { TTYC_KPRV7, KEYC_PPAGE|KEYC_ESCAPE|KEYC_CTRL|KEYC_XTERM }, 319 { TTYC_KRIT2, KEYC_RIGHT|KEYC_SHIFT|KEYC_XTERM }, 320 { TTYC_KRIT3, KEYC_RIGHT|KEYC_ESCAPE|KEYC_XTERM }, 321 { TTYC_KRIT4, KEYC_RIGHT|KEYC_SHIFT|KEYC_ESCAPE|KEYC_XTERM }, 322 { TTYC_KRIT5, KEYC_RIGHT|KEYC_CTRL|KEYC_XTERM }, 323 { TTYC_KRIT6, KEYC_RIGHT|KEYC_SHIFT|KEYC_CTRL|KEYC_XTERM }, 324 { TTYC_KRIT7, KEYC_RIGHT|KEYC_ESCAPE|KEYC_CTRL|KEYC_XTERM }, 325 { TTYC_KRI, KEYC_UP|KEYC_SHIFT|KEYC_XTERM }, 326 { TTYC_KUP2, KEYC_UP|KEYC_SHIFT|KEYC_XTERM }, 327 { TTYC_KUP3, KEYC_UP|KEYC_ESCAPE|KEYC_XTERM }, 328 { TTYC_KUP4, KEYC_UP|KEYC_SHIFT|KEYC_ESCAPE|KEYC_XTERM }, 329 { TTYC_KUP5, KEYC_UP|KEYC_CTRL|KEYC_XTERM }, 330 { TTYC_KUP6, KEYC_UP|KEYC_SHIFT|KEYC_CTRL|KEYC_XTERM }, 331 { TTYC_KUP7, KEYC_UP|KEYC_ESCAPE|KEYC_CTRL|KEYC_XTERM }, 332 }; 333 334 /* Add key to tree. */ 335 static void 336 tty_keys_add(struct tty *tty, const char *s, key_code key) 337 { 338 struct tty_key *tk; 339 size_t size; 340 const char *keystr; 341 342 keystr = key_string_lookup_key(key); 343 if ((tk = tty_keys_find(tty, s, strlen(s), &size)) == NULL) { 344 log_debug("new key %s: 0x%llx (%s)", s, key, keystr); 345 tty_keys_add1(&tty->key_tree, s, key); 346 } else { 347 log_debug("replacing key %s: 0x%llx (%s)", s, key, keystr); 348 tk->key = key; 349 } 350 } 351 352 /* Add next node to the tree. */ 353 static void 354 tty_keys_add1(struct tty_key **tkp, const char *s, key_code key) 355 { 356 struct tty_key *tk; 357 358 /* Allocate a tree entry if there isn't one already. */ 359 tk = *tkp; 360 if (tk == NULL) { 361 tk = *tkp = xcalloc(1, sizeof *tk); 362 tk->ch = *s; 363 tk->key = KEYC_UNKNOWN; 364 } 365 366 /* Find the next entry. */ 367 if (*s == tk->ch) { 368 /* Move forward in string. */ 369 s++; 370 371 /* If this is the end of the string, no more is necessary. */ 372 if (*s == '\0') { 373 tk->key = key; 374 return; 375 } 376 377 /* Use the child tree for the next character. */ 378 tkp = &tk->next; 379 } else { 380 if (*s < tk->ch) 381 tkp = &tk->left; 382 else if (*s > tk->ch) 383 tkp = &tk->right; 384 } 385 386 /* And recurse to add it. */ 387 tty_keys_add1(tkp, s, key); 388 } 389 390 /* Initialise a key tree from the table. */ 391 void 392 tty_keys_build(struct tty *tty) 393 { 394 const struct tty_default_key_raw *tdkr; 395 const struct tty_default_key_code *tdkc; 396 u_int i, size; 397 const char *s, *value; 398 struct options_entry *o; 399 400 if (tty->key_tree != NULL) 401 tty_keys_free(tty); 402 tty->key_tree = NULL; 403 404 for (i = 0; i < nitems(tty_default_raw_keys); i++) { 405 tdkr = &tty_default_raw_keys[i]; 406 407 s = tdkr->string; 408 if (*s != '\0') 409 tty_keys_add(tty, s, tdkr->key); 410 } 411 for (i = 0; i < nitems(tty_default_code_keys); i++) { 412 tdkc = &tty_default_code_keys[i]; 413 414 s = tty_term_string(tty->term, tdkc->code); 415 if (*s != '\0') 416 tty_keys_add(tty, s, tdkc->key); 417 418 } 419 420 o = options_get(global_options, "user-keys"); 421 if (o != NULL && options_array_size(o, &size) != -1) { 422 for (i = 0; i < size; i++) { 423 value = options_array_get(o, i); 424 if (value != NULL) 425 tty_keys_add(tty, value, KEYC_USER + i); 426 } 427 } 428 } 429 430 /* Free the entire key tree. */ 431 void 432 tty_keys_free(struct tty *tty) 433 { 434 tty_keys_free1(tty->key_tree); 435 } 436 437 /* Free a single key. */ 438 static void 439 tty_keys_free1(struct tty_key *tk) 440 { 441 if (tk->next != NULL) 442 tty_keys_free1(tk->next); 443 if (tk->left != NULL) 444 tty_keys_free1(tk->left); 445 if (tk->right != NULL) 446 tty_keys_free1(tk->right); 447 free(tk); 448 } 449 450 /* Lookup a key in the tree. */ 451 static struct tty_key * 452 tty_keys_find(struct tty *tty, const char *buf, size_t len, size_t *size) 453 { 454 *size = 0; 455 return (tty_keys_find1(tty->key_tree, buf, len, size)); 456 } 457 458 /* Find the next node. */ 459 static struct tty_key * 460 tty_keys_find1(struct tty_key *tk, const char *buf, size_t len, size_t *size) 461 { 462 /* If the node is NULL, this is the end of the tree. No match. */ 463 if (tk == NULL) 464 return (NULL); 465 466 /* Pick the next in the sequence. */ 467 if (tk->ch == *buf) { 468 /* Move forward in the string. */ 469 buf++; len--; 470 (*size)++; 471 472 /* At the end of the string, return the current node. */ 473 if (len == 0 || (tk->next == NULL && tk->key != KEYC_UNKNOWN)) 474 return (tk); 475 476 /* Move into the next tree for the following character. */ 477 tk = tk->next; 478 } else { 479 if (*buf < tk->ch) 480 tk = tk->left; 481 else if (*buf > tk->ch) 482 tk = tk->right; 483 } 484 485 /* Move to the next in the tree. */ 486 return (tty_keys_find1(tk, buf, len, size)); 487 } 488 489 /* Look up part of the next key. */ 490 static int 491 tty_keys_next1(struct tty *tty, const char *buf, size_t len, key_code *key, 492 size_t *size, int expired) 493 { 494 struct client *c = tty->client; 495 struct tty_key *tk, *tk1; 496 struct utf8_data ud; 497 enum utf8_state more; 498 u_int i; 499 wchar_t wc; 500 int n; 501 502 log_debug("%s: next key is %zu (%.*s) (expired=%d)", c->name, len, 503 (int)len, buf, expired); 504 505 /* Is this a known key? */ 506 tk = tty_keys_find(tty, buf, len, size); 507 if (tk != NULL && tk->key != KEYC_UNKNOWN) { 508 tk1 = tk; 509 do 510 log_debug("%s: keys in list: %#llx", c->name, tk1->key); 511 while ((tk1 = tk1->next) != NULL); 512 if (tk->next != NULL && !expired) 513 return (1); 514 *key = tk->key; 515 return (0); 516 } 517 518 /* Is this an an xterm(1) key? */ 519 n = xterm_keys_find(buf, len, size, key); 520 if (n == 0) 521 return (0); 522 if (n == 1 && !expired) 523 return (1); 524 525 /* Is this valid UTF-8? */ 526 more = utf8_open(&ud, (u_char)*buf); 527 if (more == UTF8_MORE) { 528 *size = ud.size; 529 if (len < ud.size) { 530 if (!expired) 531 return (1); 532 return (-1); 533 } 534 for (i = 1; i < ud.size; i++) 535 more = utf8_append(&ud, (u_char)buf[i]); 536 if (more != UTF8_DONE) 537 return (-1); 538 539 if (utf8_combine(&ud, &wc) != UTF8_DONE) 540 return (-1); 541 *key = wc; 542 543 log_debug("%s: UTF-8 key %.*s %#llx", c->name, (int)ud.size, 544 buf, *key); 545 return (0); 546 } 547 548 return (-1); 549 } 550 551 /* 552 * Process at least one key in the buffer and invoke tty->key_callback. Return 553 * 0 if there are no further keys, or 1 if there could be more in the buffer. 554 */ 555 key_code 556 tty_keys_next(struct tty *tty) 557 { 558 struct client *c = tty->client; 559 struct timeval tv; 560 const char *buf; 561 size_t len, size; 562 cc_t bspace; 563 int delay, expired = 0, n; 564 key_code key; 565 566 /* Get key buffer. */ 567 buf = EVBUFFER_DATA(tty->in); 568 len = EVBUFFER_LENGTH(tty->in); 569 570 if (len == 0) 571 return (0); 572 log_debug("%s: keys are %zu (%.*s)", c->name, len, (int)len, buf); 573 574 /* Is this a device attributes response? */ 575 switch (tty_keys_device_attributes(tty, buf, len, &size)) { 576 case 0: /* yes */ 577 key = KEYC_UNKNOWN; 578 goto complete_key; 579 case -1: /* no, or not valid */ 580 break; 581 case 1: /* partial */ 582 goto partial_key; 583 } 584 585 /* Is this a mouse key press? */ 586 switch (tty_keys_mouse(tty, buf, len, &size)) { 587 case 0: /* yes */ 588 key = KEYC_MOUSE; 589 goto complete_key; 590 case -1: /* no, or not valid */ 591 break; 592 case -2: /* yes, but we don't care. */ 593 key = KEYC_MOUSE; 594 goto discard_key; 595 case 1: /* partial */ 596 goto partial_key; 597 } 598 599 first_key: 600 /* Try to lookup complete key. */ 601 n = tty_keys_next1(tty, buf, len, &key, &size, expired); 602 if (n == 0) /* found */ 603 goto complete_key; 604 if (n == 1) 605 goto partial_key; 606 607 /* 608 * If not a complete key, look for key with an escape prefix (meta 609 * modifier). 610 */ 611 if (*buf == '\033') { 612 /* Look for a key without the escape. */ 613 n = tty_keys_next1(tty, buf + 1, len - 1, &key, &size, expired); 614 if (n == 0) { /* found */ 615 if (key & KEYC_XTERM) { 616 /* 617 * We want the escape key as well as the xterm 618 * key, because the xterm sequence implicitly 619 * includes the escape (so if we see 620 * \033\033[1;3D we know it is an Escape 621 * followed by M-Left, not just M-Left). 622 */ 623 key = '\033'; 624 size = 1; 625 goto complete_key; 626 } 627 key |= KEYC_ESCAPE; 628 size++; 629 goto complete_key; 630 } 631 if (n == 1) /* partial */ 632 goto partial_key; 633 } 634 635 /* 636 * At this point, we know the key is not partial (with or without 637 * escape). So pass it through even if the timer has not expired. 638 */ 639 if (*buf == '\033' && len >= 2) { 640 key = (u_char)buf[1] | KEYC_ESCAPE; 641 size = 2; 642 } else { 643 key = (u_char)buf[0]; 644 size = 1; 645 } 646 goto complete_key; 647 648 partial_key: 649 log_debug("%s: partial key %.*s", c->name, (int)len, buf); 650 651 /* If timer is going, check for expiration. */ 652 if (tty->flags & TTY_TIMER) { 653 if (evtimer_initialized(&tty->key_timer) && 654 !evtimer_pending(&tty->key_timer, NULL)) { 655 expired = 1; 656 goto first_key; 657 } 658 return (0); 659 } 660 661 /* Get the time period. */ 662 delay = options_get_number(global_options, "escape-time"); 663 tv.tv_sec = delay / 1000; 664 tv.tv_usec = (delay % 1000) * 1000L; 665 666 /* Start the timer. */ 667 if (event_initialized(&tty->key_timer)) 668 evtimer_del(&tty->key_timer); 669 evtimer_set(&tty->key_timer, tty_keys_callback, tty); 670 evtimer_add(&tty->key_timer, &tv); 671 672 tty->flags |= TTY_TIMER; 673 return (0); 674 675 complete_key: 676 log_debug("%s: complete key %.*s %#llx", c->name, (int)size, buf, key); 677 678 /* 679 * Check for backspace key using termios VERASE - the terminfo 680 * kbs entry is extremely unreliable, so cannot be safely 681 * used. termios should have a better idea. 682 */ 683 bspace = tty->tio.c_cc[VERASE]; 684 if (bspace != _POSIX_VDISABLE && (key & KEYC_MASK_KEY) == bspace) 685 key = (key & KEYC_MASK_MOD) | KEYC_BSPACE; 686 687 /* Remove data from buffer. */ 688 evbuffer_drain(tty->in, size); 689 690 /* Remove key timer. */ 691 if (event_initialized(&tty->key_timer)) 692 evtimer_del(&tty->key_timer); 693 tty->flags &= ~TTY_TIMER; 694 695 /* Check for focus events. */ 696 if (key == KEYC_FOCUS_OUT) { 697 tty->client->flags &= ~CLIENT_FOCUSED; 698 return (1); 699 } else if (key == KEYC_FOCUS_IN) { 700 tty->client->flags |= CLIENT_FOCUSED; 701 return (1); 702 } 703 704 /* Fire the key. */ 705 if (key != KEYC_UNKNOWN) 706 server_client_handle_key(tty->client, key); 707 708 return (1); 709 710 discard_key: 711 log_debug("%s: discard key %.*s %#llx", c->name, (int)size, buf, key); 712 713 /* Remove data from buffer. */ 714 evbuffer_drain(tty->in, size); 715 716 return (1); 717 } 718 719 /* Key timer callback. */ 720 static void 721 tty_keys_callback(__unused int fd, __unused short events, void *data) 722 { 723 struct tty *tty = data; 724 725 if (tty->flags & TTY_TIMER) { 726 while (tty_keys_next(tty)) 727 ; 728 } 729 } 730 731 /* 732 * Handle mouse key input. Returns 0 for success, -1 for failure, 1 for partial 733 * (probably a mouse sequence but need more data). 734 */ 735 static int 736 tty_keys_mouse(struct tty *tty, const char *buf, size_t len, size_t *size) 737 { 738 struct client *c = tty->client; 739 struct mouse_event *m = &tty->mouse; 740 u_int i, x, y, b, sgr_b; 741 u_char sgr_type, ch; 742 743 /* 744 * Standard mouse sequences are \033[M followed by three characters 745 * indicating button, X and Y, all based at 32 with 1,1 top-left. 746 * 747 * UTF-8 mouse sequences are similar but the three are expressed as 748 * UTF-8 characters. 749 * 750 * SGR extended mouse sequences are \033[< followed by three numbers in 751 * decimal and separated by semicolons indicating button, X and Y. A 752 * trailing 'M' is click or scroll and trailing 'm' release. All are 753 * based at 0 with 1,1 top-left. 754 */ 755 756 *size = 0; 757 x = y = b = sgr_b = 0; 758 sgr_type = ' '; 759 760 /* First two bytes are always \033[. */ 761 if (buf[0] != '\033') 762 return (-1); 763 if (len == 1) 764 return (1); 765 if (buf[1] != '[') 766 return (-1); 767 if (len == 2) 768 return (1); 769 770 /* 771 * Third byte is M in old standard (and UTF-8 extension which we do not 772 * support), < in SGR extension. 773 */ 774 if (buf[2] == 'M') { 775 /* Read the three inputs. */ 776 *size = 3; 777 for (i = 0; i < 3; i++) { 778 if (len <= *size) 779 return (1); 780 ch = (u_char)buf[(*size)++]; 781 if (i == 0) 782 b = ch; 783 else if (i == 1) 784 x = ch; 785 else 786 y = ch; 787 } 788 log_debug("%s: mouse input: %.*s", c->name, (int)*size, buf); 789 790 /* Check and return the mouse input. */ 791 if (b < 32) 792 return (-1); 793 b -= 32; 794 if (x >= 33) 795 x -= 33; 796 else 797 x = 256 - x; 798 if (y >= 33) 799 y -= 33; 800 else 801 y = 256 - y; 802 } else if (buf[2] == '<') { 803 /* Read the three inputs. */ 804 *size = 3; 805 while (1) { 806 if (len <= *size) 807 return (1); 808 ch = (u_char)buf[(*size)++]; 809 if (ch == ';') 810 break; 811 if (ch < '0' || ch > '9') 812 return (-1); 813 sgr_b = 10 * sgr_b + (ch - '0'); 814 } 815 while (1) { 816 if (len <= *size) 817 return (1); 818 ch = (u_char)buf[(*size)++]; 819 if (ch == ';') 820 break; 821 if (ch < '0' || ch > '9') 822 return (-1); 823 x = 10 * x + (ch - '0'); 824 } 825 while (1) { 826 if (len <= *size) 827 return (1); 828 ch = (u_char)buf[(*size)++]; 829 if (ch == 'M' || ch == 'm') 830 break; 831 if (ch < '0' || ch > '9') 832 return (-1); 833 y = 10 * y + (ch - '0'); 834 } 835 log_debug("%s: mouse input (SGR): %.*s", c->name, (int)*size, 836 buf); 837 838 /* Check and return the mouse input. */ 839 if (x < 1 || y < 1) 840 return (-1); 841 x--; 842 y--; 843 b = sgr_b; 844 845 /* Type is M for press, m for release. */ 846 sgr_type = ch; 847 if (sgr_type == 'm') 848 b |= 3; 849 850 /* 851 * Some terminals (like PuTTY 0.63) mistakenly send 852 * button-release events for scroll-wheel button-press event. 853 * Discard it before it reaches any program running inside 854 * tmux. 855 */ 856 if (sgr_type == 'm' && (sgr_b & 64)) 857 return (-2); 858 } else 859 return (-1); 860 861 /* Fill mouse event. */ 862 m->lx = m->x; 863 m->x = x; 864 m->ly = m->y; 865 m->y = y; 866 m->lb = m->b; 867 m->b = b; 868 m->sgr_type = sgr_type; 869 m->sgr_b = sgr_b; 870 871 return (0); 872 } 873 874 /* 875 * Handle device attributes input. Returns 0 for success, -1 for failure, 1 for 876 * partial. 877 */ 878 static int 879 tty_keys_device_attributes(struct tty *tty, const char *buf, size_t len, 880 size_t *size) 881 { 882 struct client *c = tty->client; 883 u_int i, a, b; 884 char tmp[64], *endptr; 885 static const char *types[] = TTY_TYPES; 886 int type; 887 888 *size = 0; 889 890 /* First three bytes are always \033[?. */ 891 if (buf[0] != '\033') 892 return (-1); 893 if (len == 1) 894 return (1); 895 if (buf[1] != '[') 896 return (-1); 897 if (len == 2) 898 return (1); 899 if (buf[2] != '?') 900 return (-1); 901 if (len == 3) 902 return (1); 903 904 /* Copy the rest up to a 'c'. */ 905 for (i = 0; i < (sizeof tmp) - 1 && buf[3 + i] != 'c'; i++) { 906 if (3 + i == len) 907 return (1); 908 tmp[i] = buf[3 + i]; 909 } 910 if (i == (sizeof tmp) - 1) 911 return (-1); 912 tmp[i] = '\0'; 913 *size = 4 + i; 914 915 /* Convert version numbers. */ 916 a = strtoul(tmp, &endptr, 10); 917 if (*endptr == ';') { 918 b = strtoul(endptr + 1, &endptr, 10); 919 if (*endptr != '\0' && *endptr != ';') 920 b = 0; 921 } else 922 a = b = 0; 923 924 /* Store terminal type. */ 925 type = TTY_UNKNOWN; 926 switch (a) { 927 case 1: 928 if (b == 2) 929 type = TTY_VT100; 930 else if (b == 0) 931 type = TTY_VT101; 932 break; 933 case 6: 934 type = TTY_VT102; 935 break; 936 case 62: 937 type = TTY_VT220; 938 break; 939 case 63: 940 type = TTY_VT320; 941 break; 942 case 64: 943 type = TTY_VT420; 944 break; 945 } 946 tty_set_type(tty, type); 947 948 log_debug("%s: received DA %.*s (%s)", c->name, (int)*size, buf, 949 types[type]); 950 return (0); 951 } 952