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