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