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