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