1 /* $OpenBSD: tty-keys.c,v 1.185 2025/01/02 10:34:45 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_device_attributes2(struct tty *, const char *, size_t, 59 size_t *); 60 static int tty_keys_extended_device_attributes(struct tty *, const char *, 61 size_t, size_t *); 62 63 /* A key tree entry. */ 64 struct tty_key { 65 char ch; 66 key_code key; 67 68 struct tty_key *left; 69 struct tty_key *right; 70 71 struct tty_key *next; 72 }; 73 74 /* Default raw keys. */ 75 struct tty_default_key_raw { 76 const char *string; 77 key_code key; 78 }; 79 static const struct tty_default_key_raw tty_default_raw_keys[] = { 80 /* Application escape. */ 81 { "\033O[", '\033' }, 82 83 /* 84 * Numeric keypad. Just use the vt100 escape sequences here and always 85 * put the terminal into keypad_xmit mode. Translation of numbers 86 * mode/applications mode is done in input-keys.c. 87 */ 88 { "\033Oo", KEYC_KP_SLASH|KEYC_KEYPAD }, 89 { "\033Oj", KEYC_KP_STAR|KEYC_KEYPAD }, 90 { "\033Om", KEYC_KP_MINUS|KEYC_KEYPAD }, 91 { "\033Ow", KEYC_KP_SEVEN|KEYC_KEYPAD }, 92 { "\033Ox", KEYC_KP_EIGHT|KEYC_KEYPAD }, 93 { "\033Oy", KEYC_KP_NINE|KEYC_KEYPAD }, 94 { "\033Ok", KEYC_KP_PLUS|KEYC_KEYPAD }, 95 { "\033Ot", KEYC_KP_FOUR|KEYC_KEYPAD }, 96 { "\033Ou", KEYC_KP_FIVE|KEYC_KEYPAD }, 97 { "\033Ov", KEYC_KP_SIX|KEYC_KEYPAD }, 98 { "\033Oq", KEYC_KP_ONE|KEYC_KEYPAD }, 99 { "\033Or", KEYC_KP_TWO|KEYC_KEYPAD }, 100 { "\033Os", KEYC_KP_THREE|KEYC_KEYPAD }, 101 { "\033OM", KEYC_KP_ENTER|KEYC_KEYPAD }, 102 { "\033Op", KEYC_KP_ZERO|KEYC_KEYPAD }, 103 { "\033On", KEYC_KP_PERIOD|KEYC_KEYPAD }, 104 105 /* Arrow keys. */ 106 { "\033OA", KEYC_UP|KEYC_CURSOR }, 107 { "\033OB", KEYC_DOWN|KEYC_CURSOR }, 108 { "\033OC", KEYC_RIGHT|KEYC_CURSOR }, 109 { "\033OD", KEYC_LEFT|KEYC_CURSOR }, 110 111 { "\033[A", KEYC_UP|KEYC_CURSOR }, 112 { "\033[B", KEYC_DOWN|KEYC_CURSOR }, 113 { "\033[C", KEYC_RIGHT|KEYC_CURSOR }, 114 { "\033[D", KEYC_LEFT|KEYC_CURSOR }, 115 116 /* 117 * Meta arrow keys. These do not get the IMPLIED_META flag so they 118 * don't match the xterm-style meta keys in the output tree - Escape+Up 119 * should stay as Escape+Up and not become M-Up. 120 */ 121 { "\033\033OA", KEYC_UP|KEYC_CURSOR|KEYC_META }, 122 { "\033\033OB", KEYC_DOWN|KEYC_CURSOR|KEYC_META }, 123 { "\033\033OC", KEYC_RIGHT|KEYC_CURSOR|KEYC_META }, 124 { "\033\033OD", KEYC_LEFT|KEYC_CURSOR|KEYC_META }, 125 126 { "\033\033[A", KEYC_UP|KEYC_CURSOR|KEYC_META }, 127 { "\033\033[B", KEYC_DOWN|KEYC_CURSOR|KEYC_META }, 128 { "\033\033[C", KEYC_RIGHT|KEYC_CURSOR|KEYC_META }, 129 { "\033\033[D", KEYC_LEFT|KEYC_CURSOR|KEYC_META }, 130 131 /* Other xterm keys. */ 132 { "\033OH", KEYC_HOME }, 133 { "\033OF", KEYC_END }, 134 135 { "\033\033OH", KEYC_HOME|KEYC_META|KEYC_IMPLIED_META }, 136 { "\033\033OF", KEYC_END|KEYC_META|KEYC_IMPLIED_META }, 137 138 { "\033[H", KEYC_HOME }, 139 { "\033[F", KEYC_END }, 140 141 { "\033\033[H", KEYC_HOME|KEYC_META|KEYC_IMPLIED_META }, 142 { "\033\033[F", KEYC_END|KEYC_META|KEYC_IMPLIED_META }, 143 144 /* rxvt arrow keys. */ 145 { "\033Oa", KEYC_UP|KEYC_CTRL }, 146 { "\033Ob", KEYC_DOWN|KEYC_CTRL }, 147 { "\033Oc", KEYC_RIGHT|KEYC_CTRL }, 148 { "\033Od", KEYC_LEFT|KEYC_CTRL }, 149 150 { "\033[a", KEYC_UP|KEYC_SHIFT }, 151 { "\033[b", KEYC_DOWN|KEYC_SHIFT }, 152 { "\033[c", KEYC_RIGHT|KEYC_SHIFT }, 153 { "\033[d", KEYC_LEFT|KEYC_SHIFT }, 154 155 /* rxvt function keys. */ 156 { "\033[11~", KEYC_F1 }, 157 { "\033[12~", KEYC_F2 }, 158 { "\033[13~", KEYC_F3 }, 159 { "\033[14~", KEYC_F4 }, 160 { "\033[15~", KEYC_F5 }, 161 { "\033[17~", KEYC_F6 }, 162 { "\033[18~", KEYC_F7 }, 163 { "\033[19~", KEYC_F8 }, 164 { "\033[20~", KEYC_F9 }, 165 { "\033[21~", KEYC_F10 }, 166 167 { "\033[23~", KEYC_F1|KEYC_SHIFT }, 168 { "\033[24~", KEYC_F2|KEYC_SHIFT }, 169 { "\033[25~", KEYC_F3|KEYC_SHIFT }, 170 { "\033[26~", KEYC_F4|KEYC_SHIFT }, 171 { "\033[28~", KEYC_F5|KEYC_SHIFT }, 172 { "\033[29~", KEYC_F6|KEYC_SHIFT }, 173 { "\033[31~", KEYC_F7|KEYC_SHIFT }, 174 { "\033[32~", KEYC_F8|KEYC_SHIFT }, 175 { "\033[33~", KEYC_F9|KEYC_SHIFT }, 176 { "\033[34~", KEYC_F10|KEYC_SHIFT }, 177 { "\033[23$", KEYC_F11|KEYC_SHIFT }, 178 { "\033[24$", KEYC_F12|KEYC_SHIFT }, 179 180 { "\033[11^", KEYC_F1|KEYC_CTRL }, 181 { "\033[12^", KEYC_F2|KEYC_CTRL }, 182 { "\033[13^", KEYC_F3|KEYC_CTRL }, 183 { "\033[14^", KEYC_F4|KEYC_CTRL }, 184 { "\033[15^", KEYC_F5|KEYC_CTRL }, 185 { "\033[17^", KEYC_F6|KEYC_CTRL }, 186 { "\033[18^", KEYC_F7|KEYC_CTRL }, 187 { "\033[19^", KEYC_F8|KEYC_CTRL }, 188 { "\033[20^", KEYC_F9|KEYC_CTRL }, 189 { "\033[21^", KEYC_F10|KEYC_CTRL }, 190 { "\033[23^", KEYC_F11|KEYC_CTRL }, 191 { "\033[24^", KEYC_F12|KEYC_CTRL }, 192 193 { "\033[11@", KEYC_F1|KEYC_CTRL|KEYC_SHIFT }, 194 { "\033[12@", KEYC_F2|KEYC_CTRL|KEYC_SHIFT }, 195 { "\033[13@", KEYC_F3|KEYC_CTRL|KEYC_SHIFT }, 196 { "\033[14@", KEYC_F4|KEYC_CTRL|KEYC_SHIFT }, 197 { "\033[15@", KEYC_F5|KEYC_CTRL|KEYC_SHIFT }, 198 { "\033[17@", KEYC_F6|KEYC_CTRL|KEYC_SHIFT }, 199 { "\033[18@", KEYC_F7|KEYC_CTRL|KEYC_SHIFT }, 200 { "\033[19@", KEYC_F8|KEYC_CTRL|KEYC_SHIFT }, 201 { "\033[20@", KEYC_F9|KEYC_CTRL|KEYC_SHIFT }, 202 { "\033[21@", KEYC_F10|KEYC_CTRL|KEYC_SHIFT }, 203 { "\033[23@", KEYC_F11|KEYC_CTRL|KEYC_SHIFT }, 204 { "\033[24@", KEYC_F12|KEYC_CTRL|KEYC_SHIFT }, 205 206 /* Focus tracking. */ 207 { "\033[I", KEYC_FOCUS_IN }, 208 { "\033[O", KEYC_FOCUS_OUT }, 209 210 /* Paste keys. */ 211 { "\033[200~", KEYC_PASTE_START }, 212 { "\033[201~", KEYC_PASTE_END }, 213 214 /* Extended keys. */ 215 { "\033[1;5Z", '\011'|KEYC_CTRL|KEYC_SHIFT }, 216 }; 217 218 /* Default xterm keys. */ 219 struct tty_default_key_xterm { 220 const char *template; 221 key_code key; 222 }; 223 static const struct tty_default_key_xterm tty_default_xterm_keys[] = { 224 { "\033[1;_P", KEYC_F1 }, 225 { "\033O1;_P", KEYC_F1 }, 226 { "\033O_P", KEYC_F1 }, 227 { "\033[1;_Q", KEYC_F2 }, 228 { "\033O1;_Q", KEYC_F2 }, 229 { "\033O_Q", KEYC_F2 }, 230 { "\033[1;_R", KEYC_F3 }, 231 { "\033O1;_R", KEYC_F3 }, 232 { "\033O_R", KEYC_F3 }, 233 { "\033[1;_S", KEYC_F4 }, 234 { "\033O1;_S", KEYC_F4 }, 235 { "\033O_S", KEYC_F4 }, 236 { "\033[15;_~", KEYC_F5 }, 237 { "\033[17;_~", KEYC_F6 }, 238 { "\033[18;_~", KEYC_F7 }, 239 { "\033[19;_~", KEYC_F8 }, 240 { "\033[20;_~", KEYC_F9 }, 241 { "\033[21;_~", KEYC_F10 }, 242 { "\033[23;_~", KEYC_F11 }, 243 { "\033[24;_~", KEYC_F12 }, 244 { "\033[1;_A", KEYC_UP }, 245 { "\033[1;_B", KEYC_DOWN }, 246 { "\033[1;_C", KEYC_RIGHT }, 247 { "\033[1;_D", KEYC_LEFT }, 248 { "\033[1;_H", KEYC_HOME }, 249 { "\033[1;_F", KEYC_END }, 250 { "\033[5;_~", KEYC_PPAGE }, 251 { "\033[6;_~", KEYC_NPAGE }, 252 { "\033[2;_~", KEYC_IC }, 253 { "\033[3;_~", KEYC_DC }, 254 }; 255 static const key_code tty_default_xterm_modifiers[] = { 256 0, 257 0, 258 KEYC_SHIFT, 259 KEYC_META|KEYC_IMPLIED_META, 260 KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META, 261 KEYC_CTRL, 262 KEYC_SHIFT|KEYC_CTRL, 263 KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL, 264 KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL, 265 KEYC_META|KEYC_IMPLIED_META 266 }; 267 268 /* 269 * Default terminfo(5) keys. Any keys that have builtin modifiers (that is, 270 * where the key itself contains the modifiers) has the KEYC_XTERM flag set so 271 * a leading escape is not treated as meta (and probably removed). 272 */ 273 struct tty_default_key_code { 274 enum tty_code_code code; 275 key_code key; 276 }; 277 static const struct tty_default_key_code tty_default_code_keys[] = { 278 /* Function keys. */ 279 { TTYC_KF1, KEYC_F1 }, 280 { TTYC_KF2, KEYC_F2 }, 281 { TTYC_KF3, KEYC_F3 }, 282 { TTYC_KF4, KEYC_F4 }, 283 { TTYC_KF5, KEYC_F5 }, 284 { TTYC_KF6, KEYC_F6 }, 285 { TTYC_KF7, KEYC_F7 }, 286 { TTYC_KF8, KEYC_F8 }, 287 { TTYC_KF9, KEYC_F9 }, 288 { TTYC_KF10, KEYC_F10 }, 289 { TTYC_KF11, KEYC_F11 }, 290 { TTYC_KF12, KEYC_F12 }, 291 292 { TTYC_KF13, KEYC_F1|KEYC_SHIFT }, 293 { TTYC_KF14, KEYC_F2|KEYC_SHIFT }, 294 { TTYC_KF15, KEYC_F3|KEYC_SHIFT }, 295 { TTYC_KF16, KEYC_F4|KEYC_SHIFT }, 296 { TTYC_KF17, KEYC_F5|KEYC_SHIFT }, 297 { TTYC_KF18, KEYC_F6|KEYC_SHIFT }, 298 { TTYC_KF19, KEYC_F7|KEYC_SHIFT }, 299 { TTYC_KF20, KEYC_F8|KEYC_SHIFT }, 300 { TTYC_KF21, KEYC_F9|KEYC_SHIFT }, 301 { TTYC_KF22, KEYC_F10|KEYC_SHIFT }, 302 { TTYC_KF23, KEYC_F11|KEYC_SHIFT }, 303 { TTYC_KF24, KEYC_F12|KEYC_SHIFT }, 304 305 { TTYC_KF25, KEYC_F1|KEYC_CTRL }, 306 { TTYC_KF26, KEYC_F2|KEYC_CTRL }, 307 { TTYC_KF27, KEYC_F3|KEYC_CTRL }, 308 { TTYC_KF28, KEYC_F4|KEYC_CTRL }, 309 { TTYC_KF29, KEYC_F5|KEYC_CTRL }, 310 { TTYC_KF30, KEYC_F6|KEYC_CTRL }, 311 { TTYC_KF31, KEYC_F7|KEYC_CTRL }, 312 { TTYC_KF32, KEYC_F8|KEYC_CTRL }, 313 { TTYC_KF33, KEYC_F9|KEYC_CTRL }, 314 { TTYC_KF34, KEYC_F10|KEYC_CTRL }, 315 { TTYC_KF35, KEYC_F11|KEYC_CTRL }, 316 { TTYC_KF36, KEYC_F12|KEYC_CTRL }, 317 318 { TTYC_KF37, KEYC_F1|KEYC_SHIFT|KEYC_CTRL }, 319 { TTYC_KF38, KEYC_F2|KEYC_SHIFT|KEYC_CTRL }, 320 { TTYC_KF39, KEYC_F3|KEYC_SHIFT|KEYC_CTRL }, 321 { TTYC_KF40, KEYC_F4|KEYC_SHIFT|KEYC_CTRL }, 322 { TTYC_KF41, KEYC_F5|KEYC_SHIFT|KEYC_CTRL }, 323 { TTYC_KF42, KEYC_F6|KEYC_SHIFT|KEYC_CTRL }, 324 { TTYC_KF43, KEYC_F7|KEYC_SHIFT|KEYC_CTRL }, 325 { TTYC_KF44, KEYC_F8|KEYC_SHIFT|KEYC_CTRL }, 326 { TTYC_KF45, KEYC_F9|KEYC_SHIFT|KEYC_CTRL }, 327 { TTYC_KF46, KEYC_F10|KEYC_SHIFT|KEYC_CTRL }, 328 { TTYC_KF47, KEYC_F11|KEYC_SHIFT|KEYC_CTRL }, 329 { TTYC_KF48, KEYC_F12|KEYC_SHIFT|KEYC_CTRL }, 330 331 { TTYC_KF49, KEYC_F1|KEYC_META|KEYC_IMPLIED_META }, 332 { TTYC_KF50, KEYC_F2|KEYC_META|KEYC_IMPLIED_META }, 333 { TTYC_KF51, KEYC_F3|KEYC_META|KEYC_IMPLIED_META }, 334 { TTYC_KF52, KEYC_F4|KEYC_META|KEYC_IMPLIED_META }, 335 { TTYC_KF53, KEYC_F5|KEYC_META|KEYC_IMPLIED_META }, 336 { TTYC_KF54, KEYC_F6|KEYC_META|KEYC_IMPLIED_META }, 337 { TTYC_KF55, KEYC_F7|KEYC_META|KEYC_IMPLIED_META }, 338 { TTYC_KF56, KEYC_F8|KEYC_META|KEYC_IMPLIED_META }, 339 { TTYC_KF57, KEYC_F9|KEYC_META|KEYC_IMPLIED_META }, 340 { TTYC_KF58, KEYC_F10|KEYC_META|KEYC_IMPLIED_META }, 341 { TTYC_KF59, KEYC_F11|KEYC_META|KEYC_IMPLIED_META }, 342 { TTYC_KF60, KEYC_F12|KEYC_META|KEYC_IMPLIED_META }, 343 344 { TTYC_KF61, KEYC_F1|KEYC_META|KEYC_IMPLIED_META|KEYC_SHIFT }, 345 { TTYC_KF62, KEYC_F2|KEYC_META|KEYC_IMPLIED_META|KEYC_SHIFT }, 346 { TTYC_KF63, KEYC_F3|KEYC_META|KEYC_IMPLIED_META|KEYC_SHIFT }, 347 348 { TTYC_KICH1, KEYC_IC }, 349 { TTYC_KDCH1, KEYC_DC }, 350 { TTYC_KHOME, KEYC_HOME }, 351 { TTYC_KEND, KEYC_END }, 352 { TTYC_KNP, KEYC_NPAGE }, 353 { TTYC_KPP, KEYC_PPAGE }, 354 { TTYC_KCBT, KEYC_BTAB }, 355 356 /* Arrow keys from terminfo. */ 357 { TTYC_KCUU1, KEYC_UP|KEYC_CURSOR }, 358 { TTYC_KCUD1, KEYC_DOWN|KEYC_CURSOR }, 359 { TTYC_KCUB1, KEYC_LEFT|KEYC_CURSOR }, 360 { TTYC_KCUF1, KEYC_RIGHT|KEYC_CURSOR }, 361 362 /* Key and modifier capabilities. */ 363 { TTYC_KDC2, KEYC_DC|KEYC_SHIFT }, 364 { TTYC_KDC3, KEYC_DC|KEYC_META|KEYC_IMPLIED_META }, 365 { TTYC_KDC4, KEYC_DC|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META }, 366 { TTYC_KDC5, KEYC_DC|KEYC_CTRL }, 367 { TTYC_KDC6, KEYC_DC|KEYC_SHIFT|KEYC_CTRL }, 368 { TTYC_KDC7, KEYC_DC|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL }, 369 { TTYC_KIND, KEYC_DOWN|KEYC_SHIFT }, 370 { TTYC_KDN2, KEYC_DOWN|KEYC_SHIFT }, 371 { TTYC_KDN3, KEYC_DOWN|KEYC_META|KEYC_IMPLIED_META }, 372 { TTYC_KDN4, KEYC_DOWN|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META }, 373 { TTYC_KDN5, KEYC_DOWN|KEYC_CTRL }, 374 { TTYC_KDN6, KEYC_DOWN|KEYC_SHIFT|KEYC_CTRL }, 375 { TTYC_KDN7, KEYC_DOWN|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL }, 376 { TTYC_KEND2, KEYC_END|KEYC_SHIFT }, 377 { TTYC_KEND3, KEYC_END|KEYC_META|KEYC_IMPLIED_META }, 378 { TTYC_KEND4, KEYC_END|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META }, 379 { TTYC_KEND5, KEYC_END|KEYC_CTRL }, 380 { TTYC_KEND6, KEYC_END|KEYC_SHIFT|KEYC_CTRL }, 381 { TTYC_KEND7, KEYC_END|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL }, 382 { TTYC_KHOM2, KEYC_HOME|KEYC_SHIFT }, 383 { TTYC_KHOM3, KEYC_HOME|KEYC_META|KEYC_IMPLIED_META }, 384 { TTYC_KHOM4, KEYC_HOME|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META }, 385 { TTYC_KHOM5, KEYC_HOME|KEYC_CTRL }, 386 { TTYC_KHOM6, KEYC_HOME|KEYC_SHIFT|KEYC_CTRL }, 387 { TTYC_KHOM7, KEYC_HOME|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL }, 388 { TTYC_KIC2, KEYC_IC|KEYC_SHIFT }, 389 { TTYC_KIC3, KEYC_IC|KEYC_META|KEYC_IMPLIED_META }, 390 { TTYC_KIC4, KEYC_IC|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META }, 391 { TTYC_KIC5, KEYC_IC|KEYC_CTRL }, 392 { TTYC_KIC6, KEYC_IC|KEYC_SHIFT|KEYC_CTRL }, 393 { TTYC_KIC7, KEYC_IC|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL }, 394 { TTYC_KLFT2, KEYC_LEFT|KEYC_SHIFT }, 395 { TTYC_KLFT3, KEYC_LEFT|KEYC_META|KEYC_IMPLIED_META }, 396 { TTYC_KLFT4, KEYC_LEFT|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META }, 397 { TTYC_KLFT5, KEYC_LEFT|KEYC_CTRL }, 398 { TTYC_KLFT6, KEYC_LEFT|KEYC_SHIFT|KEYC_CTRL }, 399 { TTYC_KLFT7, KEYC_LEFT|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL }, 400 { TTYC_KNXT2, KEYC_NPAGE|KEYC_SHIFT }, 401 { TTYC_KNXT3, KEYC_NPAGE|KEYC_META|KEYC_IMPLIED_META }, 402 { TTYC_KNXT4, KEYC_NPAGE|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META }, 403 { TTYC_KNXT5, KEYC_NPAGE|KEYC_CTRL }, 404 { TTYC_KNXT6, KEYC_NPAGE|KEYC_SHIFT|KEYC_CTRL }, 405 { TTYC_KNXT7, KEYC_NPAGE|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL }, 406 { TTYC_KPRV2, KEYC_PPAGE|KEYC_SHIFT }, 407 { TTYC_KPRV3, KEYC_PPAGE|KEYC_META|KEYC_IMPLIED_META }, 408 { TTYC_KPRV4, KEYC_PPAGE|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META }, 409 { TTYC_KPRV5, KEYC_PPAGE|KEYC_CTRL }, 410 { TTYC_KPRV6, KEYC_PPAGE|KEYC_SHIFT|KEYC_CTRL }, 411 { TTYC_KPRV7, KEYC_PPAGE|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL }, 412 { TTYC_KRIT2, KEYC_RIGHT|KEYC_SHIFT }, 413 { TTYC_KRIT3, KEYC_RIGHT|KEYC_META|KEYC_IMPLIED_META }, 414 { TTYC_KRIT4, KEYC_RIGHT|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META }, 415 { TTYC_KRIT5, KEYC_RIGHT|KEYC_CTRL }, 416 { TTYC_KRIT6, KEYC_RIGHT|KEYC_SHIFT|KEYC_CTRL }, 417 { TTYC_KRIT7, KEYC_RIGHT|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL }, 418 { TTYC_KRI, KEYC_UP|KEYC_SHIFT }, 419 { TTYC_KUP2, KEYC_UP|KEYC_SHIFT }, 420 { TTYC_KUP3, KEYC_UP|KEYC_META|KEYC_IMPLIED_META }, 421 { TTYC_KUP4, KEYC_UP|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META }, 422 { TTYC_KUP5, KEYC_UP|KEYC_CTRL }, 423 { TTYC_KUP6, KEYC_UP|KEYC_SHIFT|KEYC_CTRL }, 424 { TTYC_KUP7, KEYC_UP|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL }, 425 }; 426 427 /* Add key to tree. */ 428 static void 429 tty_keys_add(struct tty *tty, const char *s, key_code key) 430 { 431 struct tty_key *tk; 432 size_t size; 433 const char *keystr; 434 435 keystr = key_string_lookup_key(key, 1); 436 if ((tk = tty_keys_find(tty, s, strlen(s), &size)) == NULL) { 437 log_debug("new key %s: 0x%llx (%s)", s, key, keystr); 438 tty_keys_add1(&tty->key_tree, s, key); 439 } else { 440 log_debug("replacing key %s: 0x%llx (%s)", s, key, keystr); 441 tk->key = key; 442 } 443 } 444 445 /* Add next node to the tree. */ 446 static void 447 tty_keys_add1(struct tty_key **tkp, const char *s, key_code key) 448 { 449 struct tty_key *tk; 450 451 /* Allocate a tree entry if there isn't one already. */ 452 tk = *tkp; 453 if (tk == NULL) { 454 tk = *tkp = xcalloc(1, sizeof *tk); 455 tk->ch = *s; 456 tk->key = KEYC_UNKNOWN; 457 } 458 459 /* Find the next entry. */ 460 if (*s == tk->ch) { 461 /* Move forward in string. */ 462 s++; 463 464 /* If this is the end of the string, no more is necessary. */ 465 if (*s == '\0') { 466 tk->key = key; 467 return; 468 } 469 470 /* Use the child tree for the next character. */ 471 tkp = &tk->next; 472 } else { 473 if (*s < tk->ch) 474 tkp = &tk->left; 475 else if (*s > tk->ch) 476 tkp = &tk->right; 477 } 478 479 /* And recurse to add it. */ 480 tty_keys_add1(tkp, s, key); 481 } 482 483 /* Initialise a key tree from the table. */ 484 void 485 tty_keys_build(struct tty *tty) 486 { 487 const struct tty_default_key_raw *tdkr; 488 const struct tty_default_key_xterm *tdkx; 489 const struct tty_default_key_code *tdkc; 490 u_int i, j; 491 const char *s; 492 struct options_entry *o; 493 struct options_array_item *a; 494 union options_value *ov; 495 char copy[16]; 496 key_code key; 497 498 if (tty->key_tree != NULL) 499 tty_keys_free(tty); 500 tty->key_tree = NULL; 501 502 for (i = 0; i < nitems(tty_default_xterm_keys); i++) { 503 tdkx = &tty_default_xterm_keys[i]; 504 for (j = 2; j < nitems(tty_default_xterm_modifiers); j++) { 505 strlcpy(copy, tdkx->template, sizeof copy); 506 copy[strcspn(copy, "_")] = '0' + j; 507 508 key = tdkx->key|tty_default_xterm_modifiers[j]; 509 tty_keys_add(tty, copy, key); 510 } 511 } 512 for (i = 0; i < nitems(tty_default_raw_keys); i++) { 513 tdkr = &tty_default_raw_keys[i]; 514 515 s = tdkr->string; 516 if (*s != '\0') 517 tty_keys_add(tty, s, tdkr->key); 518 } 519 for (i = 0; i < nitems(tty_default_code_keys); i++) { 520 tdkc = &tty_default_code_keys[i]; 521 522 s = tty_term_string(tty->term, tdkc->code); 523 if (*s != '\0') 524 tty_keys_add(tty, s, tdkc->key); 525 526 } 527 528 o = options_get(global_options, "user-keys"); 529 if (o != NULL) { 530 a = options_array_first(o); 531 while (a != NULL) { 532 i = options_array_item_index(a); 533 ov = options_array_item_value(a); 534 tty_keys_add(tty, ov->string, KEYC_USER + i); 535 a = options_array_next(a); 536 } 537 } 538 } 539 540 /* Free the entire key tree. */ 541 void 542 tty_keys_free(struct tty *tty) 543 { 544 tty_keys_free1(tty->key_tree); 545 } 546 547 /* Free a single key. */ 548 static void 549 tty_keys_free1(struct tty_key *tk) 550 { 551 if (tk->next != NULL) 552 tty_keys_free1(tk->next); 553 if (tk->left != NULL) 554 tty_keys_free1(tk->left); 555 if (tk->right != NULL) 556 tty_keys_free1(tk->right); 557 free(tk); 558 } 559 560 /* Lookup a key in the tree. */ 561 static struct tty_key * 562 tty_keys_find(struct tty *tty, const char *buf, size_t len, size_t *size) 563 { 564 *size = 0; 565 return (tty_keys_find1(tty->key_tree, buf, len, size)); 566 } 567 568 /* Find the next node. */ 569 static struct tty_key * 570 tty_keys_find1(struct tty_key *tk, const char *buf, size_t len, size_t *size) 571 { 572 /* If no data, no match. */ 573 if (len == 0) 574 return (NULL); 575 576 /* If the node is NULL, this is the end of the tree. No match. */ 577 if (tk == NULL) 578 return (NULL); 579 580 /* Pick the next in the sequence. */ 581 if (tk->ch == *buf) { 582 /* Move forward in the string. */ 583 buf++; len--; 584 (*size)++; 585 586 /* At the end of the string, return the current node. */ 587 if (len == 0 || (tk->next == NULL && tk->key != KEYC_UNKNOWN)) 588 return (tk); 589 590 /* Move into the next tree for the following character. */ 591 tk = tk->next; 592 } else { 593 if (*buf < tk->ch) 594 tk = tk->left; 595 else if (*buf > tk->ch) 596 tk = tk->right; 597 } 598 599 /* Move to the next in the tree. */ 600 return (tty_keys_find1(tk, buf, len, size)); 601 } 602 603 /* Look up part of the next key. */ 604 static int 605 tty_keys_next1(struct tty *tty, const char *buf, size_t len, key_code *key, 606 size_t *size, int expired) 607 { 608 struct client *c = tty->client; 609 struct tty_key *tk, *tk1; 610 struct utf8_data ud; 611 enum utf8_state more; 612 utf8_char uc; 613 u_int i; 614 615 log_debug("%s: next key is %zu (%.*s) (expired=%d)", c->name, len, 616 (int)len, buf, expired); 617 618 /* Is this a known key? */ 619 tk = tty_keys_find(tty, buf, len, size); 620 if (tk != NULL && tk->key != KEYC_UNKNOWN) { 621 tk1 = tk; 622 do 623 log_debug("%s: keys in list: %#llx", c->name, tk1->key); 624 while ((tk1 = tk1->next) != NULL); 625 if (tk->next != NULL && !expired) 626 return (1); 627 *key = tk->key; 628 return (0); 629 } 630 631 /* Is this valid UTF-8? */ 632 more = utf8_open(&ud, (u_char)*buf); 633 if (more == UTF8_MORE) { 634 *size = ud.size; 635 if (len < ud.size) { 636 if (!expired) 637 return (1); 638 return (-1); 639 } 640 for (i = 1; i < ud.size; i++) 641 more = utf8_append(&ud, (u_char)buf[i]); 642 if (more != UTF8_DONE) 643 return (-1); 644 645 if (utf8_from_data(&ud, &uc) != UTF8_DONE) 646 return (-1); 647 *key = uc; 648 649 log_debug("%s: UTF-8 key %.*s %#llx", c->name, (int)ud.size, 650 ud.data, *key); 651 return (0); 652 } 653 654 return (-1); 655 } 656 657 /* Process window size change escape sequences. */ 658 static int 659 tty_keys_winsz(struct tty *tty, const char *buf, size_t len, size_t *size) 660 { 661 struct client *c = tty->client; 662 size_t end; 663 char tmp[64]; 664 u_int sx, sy, xpixel, ypixel, char_x, char_y; 665 666 *size = 0; 667 668 /* If we did not request this, ignore it. */ 669 if (!(tty->flags & TTY_WINSIZEQUERY)) 670 return (-1); 671 672 /* First two bytes are always \033[. */ 673 if (buf[0] != '\033') 674 return (-1); 675 if (len == 1) 676 return (1); 677 if (buf[1] != '[') 678 return (-1); 679 if (len == 2) 680 return (1); 681 682 /* 683 * Stop at either 't' or anything that isn't a 684 * number or ';'. 685 */ 686 for (end = 2; end < len && end != sizeof tmp; end++) { 687 if (buf[end] == 't') 688 break; 689 if (!isdigit((u_char)buf[end]) && buf[end] != ';') 690 break; 691 } 692 if (end == len) 693 return (1); 694 if (end == sizeof tmp || buf[end] != 't') 695 return (-1); 696 697 /* Copy to the buffer. */ 698 memcpy(tmp, buf + 2, end - 2); 699 tmp[end - 2] = '\0'; 700 701 /* Try to parse the window size sequence. */ 702 if (sscanf(tmp, "8;%u;%u", &sy, &sx) == 2) { 703 /* Window size in characters. */ 704 tty_set_size(tty, sx, sy, tty->xpixel, tty->ypixel); 705 706 *size = end + 1; 707 return (0); 708 } else if (sscanf(tmp, "4;%u;%u", &ypixel, &xpixel) == 2) { 709 /* Window size in pixels. */ 710 char_x = (xpixel && tty->sx) ? xpixel / tty->sx : 0; 711 char_y = (ypixel && tty->sy) ? ypixel / tty->sy : 0; 712 tty_set_size(tty, tty->sx, tty->sy, char_x, char_y); 713 tty_invalidate(tty); 714 715 tty->flags &= ~TTY_WINSIZEQUERY; 716 *size = end + 1; 717 return (0); 718 } 719 720 log_debug("%s: unrecognized window size sequence: %s", c->name, tmp); 721 return (-1); 722 } 723 724 725 /* Process at least one key in the buffer. Return 0 if no keys present. */ 726 int 727 tty_keys_next(struct tty *tty) 728 { 729 struct client *c = tty->client; 730 struct timeval tv; 731 const char *buf; 732 size_t len, size; 733 cc_t bspace; 734 int delay, expired = 0, n; 735 key_code key, onlykey; 736 struct mouse_event m = { 0 }; 737 struct key_event *event; 738 739 /* Get key buffer. */ 740 buf = EVBUFFER_DATA(tty->in); 741 len = EVBUFFER_LENGTH(tty->in); 742 if (len == 0) 743 return (0); 744 log_debug("%s: keys are %zu (%.*s)", c->name, len, (int)len, buf); 745 746 /* Is this a clipboard response? */ 747 switch (tty_keys_clipboard(tty, buf, len, &size)) { 748 case 0: /* yes */ 749 key = KEYC_UNKNOWN; 750 goto complete_key; 751 case -1: /* no, or not valid */ 752 break; 753 case 1: /* partial */ 754 goto partial_key; 755 } 756 757 /* Is this a primary device attributes response? */ 758 switch (tty_keys_device_attributes(tty, buf, len, &size)) { 759 case 0: /* yes */ 760 key = KEYC_UNKNOWN; 761 goto complete_key; 762 case -1: /* no, or not valid */ 763 break; 764 case 1: /* partial */ 765 goto partial_key; 766 } 767 768 /* Is this a secondary device attributes response? */ 769 switch (tty_keys_device_attributes2(tty, buf, len, &size)) { 770 case 0: /* yes */ 771 key = KEYC_UNKNOWN; 772 goto complete_key; 773 case -1: /* no, or not valid */ 774 break; 775 case 1: /* partial */ 776 goto partial_key; 777 } 778 779 /* Is this an extended device attributes response? */ 780 switch (tty_keys_extended_device_attributes(tty, buf, len, &size)) { 781 case 0: /* yes */ 782 key = KEYC_UNKNOWN; 783 goto complete_key; 784 case -1: /* no, or not valid */ 785 break; 786 case 1: /* partial */ 787 goto partial_key; 788 } 789 790 /* Is this a colours response? */ 791 switch (tty_keys_colours(tty, buf, len, &size, &tty->fg, &tty->bg)) { 792 case 0: /* yes */ 793 key = KEYC_UNKNOWN; 794 goto complete_key; 795 case -1: /* no, or not valid */ 796 break; 797 case 1: /* partial */ 798 goto partial_key; 799 } 800 801 /* Is this a mouse key press? */ 802 switch (tty_keys_mouse(tty, buf, len, &size, &m)) { 803 case 0: /* yes */ 804 key = KEYC_MOUSE; 805 goto complete_key; 806 case -1: /* no, or not valid */ 807 break; 808 case -2: /* yes, but we don't care. */ 809 key = KEYC_MOUSE; 810 goto discard_key; 811 case 1: /* partial */ 812 goto partial_key; 813 } 814 815 /* Is this an extended key press? */ 816 switch (tty_keys_extended_key(tty, buf, len, &size, &key)) { 817 case 0: /* yes */ 818 goto complete_key; 819 case -1: /* no, or not valid */ 820 break; 821 case 1: /* partial */ 822 goto partial_key; 823 } 824 825 /* Check for window size query */ 826 switch (tty_keys_winsz(tty, buf, len, &size)) { 827 case 0: /* yes */ 828 key = KEYC_UNKNOWN; 829 goto complete_key; 830 case -1: /* no, or not valid */ 831 break; 832 case 1: /* partial */ 833 goto partial_key; 834 } 835 836 first_key: 837 /* Try to lookup complete key. */ 838 n = tty_keys_next1(tty, buf, len, &key, &size, expired); 839 if (n == 0) /* found */ 840 goto complete_key; 841 if (n == 1) 842 goto partial_key; 843 844 /* 845 * If not a complete key, look for key with an escape prefix (meta 846 * modifier). 847 */ 848 if (*buf == '\033' && len > 1) { 849 /* Look for a key without the escape. */ 850 n = tty_keys_next1(tty, buf + 1, len - 1, &key, &size, expired); 851 if (n == 0) { /* found */ 852 if (key & KEYC_IMPLIED_META) { 853 /* 854 * We want the escape key as well as the xterm 855 * key, because the xterm sequence implicitly 856 * includes the escape (so if we see 857 * \033\033[1;3D we know it is an Escape 858 * followed by M-Left, not just M-Left). 859 */ 860 key = '\033'; 861 size = 1; 862 goto complete_key; 863 } 864 key |= KEYC_META; 865 size++; 866 goto complete_key; 867 } 868 if (n == 1) /* partial */ 869 goto partial_key; 870 } 871 872 /* 873 * At this point, we know the key is not partial (with or without 874 * escape). So pass it through even if the timer has not expired. 875 */ 876 if (*buf == '\033' && len >= 2) { 877 key = (u_char)buf[1] | KEYC_META; 878 size = 2; 879 } else { 880 key = (u_char)buf[0]; 881 size = 1; 882 } 883 884 /* C-Space is special. */ 885 if ((key & KEYC_MASK_KEY) == C0_NUL) 886 key = ' ' | KEYC_CTRL | (key & KEYC_META); 887 888 /* 889 * Check for backspace key using termios VERASE - the terminfo 890 * kbs entry is extremely unreliable, so cannot be safely 891 * used. termios should have a better idea. 892 */ 893 bspace = tty->tio.c_cc[VERASE]; 894 if (bspace != _POSIX_VDISABLE && key == bspace) { 895 log_debug("%s: key %#llx is backspace", c->name, key); 896 key = KEYC_BSPACE; 897 } 898 899 /* 900 * Fix up all C0 control codes that don't have a dedicated key into 901 * corresponding Ctrl keys. Convert characters in the A-Z range into 902 * lowercase, so ^A becomes a|CTRL. 903 */ 904 onlykey = key & KEYC_MASK_KEY; 905 if (onlykey < 0x20 && 906 onlykey != C0_HT && 907 onlykey != C0_CR && 908 onlykey != C0_ESC) { 909 onlykey |= 0x40; 910 if (onlykey >= 'A' && onlykey <= 'Z') 911 onlykey |= 0x20; 912 key = onlykey | KEYC_CTRL | (key & KEYC_META); 913 } 914 915 goto complete_key; 916 917 partial_key: 918 log_debug("%s: partial key %.*s", c->name, (int)len, buf); 919 920 /* If timer is going, check for expiration. */ 921 if (tty->flags & TTY_TIMER) { 922 if (evtimer_initialized(&tty->key_timer) && 923 !evtimer_pending(&tty->key_timer, NULL)) { 924 expired = 1; 925 goto first_key; 926 } 927 return (0); 928 } 929 930 /* Get the time period. */ 931 delay = options_get_number(global_options, "escape-time"); 932 if (delay == 0) 933 delay = 1; 934 tv.tv_sec = delay / 1000; 935 tv.tv_usec = (delay % 1000) * 1000L; 936 937 /* Start the timer. */ 938 if (event_initialized(&tty->key_timer)) 939 evtimer_del(&tty->key_timer); 940 evtimer_set(&tty->key_timer, tty_keys_callback, tty); 941 evtimer_add(&tty->key_timer, &tv); 942 943 tty->flags |= TTY_TIMER; 944 return (0); 945 946 complete_key: 947 log_debug("%s: complete key %.*s %#llx", c->name, (int)size, buf, key); 948 949 /* Remove key timer. */ 950 if (event_initialized(&tty->key_timer)) 951 evtimer_del(&tty->key_timer); 952 tty->flags &= ~TTY_TIMER; 953 954 /* Check for focus events. */ 955 if (key == KEYC_FOCUS_OUT) { 956 c->flags &= ~CLIENT_FOCUSED; 957 window_update_focus(c->session->curw->window); 958 notify_client("client-focus-out", c); 959 } else if (key == KEYC_FOCUS_IN) { 960 c->flags |= CLIENT_FOCUSED; 961 notify_client("client-focus-in", c); 962 window_update_focus(c->session->curw->window); 963 } 964 965 /* Fire the key. */ 966 if (key != KEYC_UNKNOWN) { 967 event = xcalloc(1, sizeof *event); 968 event->key = key; 969 memcpy(&event->m, &m, sizeof event->m); 970 971 event->buf = xmalloc(size); 972 event->len = size; 973 memcpy (event->buf, buf, event->len); 974 975 if (!server_client_handle_key(c, event)) { 976 free(event->buf); 977 free(event); 978 } 979 } 980 981 /* Remove data from buffer. */ 982 evbuffer_drain(tty->in, size); 983 984 return (1); 985 986 discard_key: 987 log_debug("%s: discard key %.*s %#llx", c->name, (int)size, buf, key); 988 989 /* Remove data from buffer. */ 990 evbuffer_drain(tty->in, size); 991 992 return (1); 993 } 994 995 /* Key timer callback. */ 996 static void 997 tty_keys_callback(__unused int fd, __unused short events, void *data) 998 { 999 struct tty *tty = data; 1000 1001 if (tty->flags & TTY_TIMER) { 1002 while (tty_keys_next(tty)) 1003 ; 1004 } 1005 } 1006 1007 /* 1008 * Handle extended key input. This has two forms: \033[27;m;k~ and \033[k;mu, 1009 * where k is key as a number and m is a modifier. Returns 0 for success, -1 1010 * for failure, 1 for partial; 1011 */ 1012 static int 1013 tty_keys_extended_key(struct tty *tty, const char *buf, size_t len, 1014 size_t *size, key_code *key) 1015 { 1016 struct client *c = tty->client; 1017 size_t end; 1018 u_int number, modifiers; 1019 char tmp[64]; 1020 cc_t bspace; 1021 key_code nkey, onlykey; 1022 struct utf8_data ud; 1023 utf8_char uc; 1024 1025 *size = 0; 1026 1027 /* First two bytes are always \033[. */ 1028 if (buf[0] != '\033') 1029 return (-1); 1030 if (len == 1) 1031 return (1); 1032 if (buf[1] != '[') 1033 return (-1); 1034 if (len == 2) 1035 return (1); 1036 1037 /* 1038 * Look for a terminator. Stop at either '~' or anything that isn't a 1039 * number or ';'. 1040 */ 1041 for (end = 2; end < len && end != sizeof tmp; end++) { 1042 if (buf[end] == '~') 1043 break; 1044 if (!isdigit((u_char)buf[end]) && buf[end] != ';') 1045 break; 1046 } 1047 if (end == len) 1048 return (1); 1049 if (end == sizeof tmp || (buf[end] != '~' && buf[end] != 'u')) 1050 return (-1); 1051 1052 /* Copy to the buffer. */ 1053 memcpy(tmp, buf + 2, end); 1054 tmp[end] = '\0'; 1055 1056 /* Try to parse either form of key. */ 1057 if (buf[end] == '~') { 1058 if (sscanf(tmp, "27;%u;%u", &modifiers, &number) != 2) 1059 return (-1); 1060 } else { 1061 if (sscanf(tmp ,"%u;%u", &number, &modifiers) != 2) 1062 return (-1); 1063 } 1064 *size = end + 1; 1065 1066 /* Store the key. */ 1067 bspace = tty->tio.c_cc[VERASE]; 1068 if (bspace != _POSIX_VDISABLE && number == bspace) 1069 nkey = KEYC_BSPACE; 1070 else 1071 nkey = number; 1072 1073 /* Convert UTF-32 codepoint into internal representation. */ 1074 if (nkey != KEYC_BSPACE && nkey & ~0x7f) { 1075 if (utf8_fromwc(nkey, &ud) == UTF8_DONE && 1076 utf8_from_data(&ud, &uc) == UTF8_DONE) 1077 nkey = uc; 1078 else 1079 return (-1); 1080 } 1081 1082 /* Update the modifiers. */ 1083 if (modifiers > 0) { 1084 modifiers--; 1085 if (modifiers & 1) 1086 nkey |= KEYC_SHIFT; 1087 if (modifiers & 2) 1088 nkey |= (KEYC_META|KEYC_IMPLIED_META); /* Alt */ 1089 if (modifiers & 4) 1090 nkey |= KEYC_CTRL; 1091 if (modifiers & 8) 1092 nkey |= (KEYC_META|KEYC_IMPLIED_META); /* Meta */ 1093 } 1094 1095 /* Convert S-Tab into Backtab. */ 1096 if ((nkey & KEYC_MASK_KEY) == '\011' && (nkey & KEYC_SHIFT)) 1097 nkey = KEYC_BTAB | (nkey & ~KEYC_MASK_KEY & ~KEYC_SHIFT); 1098 1099 /* 1100 * Deal with the Shift modifier when present alone. The problem is that 1101 * in mode 2 some terminals would report shifted keys, like S-a, as 1102 * just A, and some as S-A. 1103 * 1104 * Because we need an unambiguous internal representation, and because 1105 * restoring the Shift modifier when it's missing would require knowing 1106 * the keyboard layout, and because S-A would cause a lot of issues 1107 * downstream, we choose to lose the Shift for all printable 1108 * characters. 1109 * 1110 * That still leaves some ambiguity, such as C-S-A vs. C-A, but that's 1111 * OK, and applications can handle that. 1112 */ 1113 onlykey = nkey & KEYC_MASK_KEY; 1114 if (((onlykey > 0x20 && onlykey < 0x7f) || 1115 KEYC_IS_UNICODE(nkey)) && 1116 (nkey & KEYC_MASK_MODIFIERS) == KEYC_SHIFT) 1117 nkey &= ~KEYC_SHIFT; 1118 1119 if (log_get_level() != 0) { 1120 log_debug("%s: extended key %.*s is %llx (%s)", c->name, 1121 (int)*size, buf, nkey, key_string_lookup_key(nkey, 1)); 1122 } 1123 1124 *key = nkey; 1125 return (0); 1126 } 1127 1128 /* 1129 * Handle mouse key input. Returns 0 for success, -1 for failure, 1 for partial 1130 * (probably a mouse sequence but need more data), -2 if an invalid mouse 1131 * sequence. 1132 */ 1133 static int 1134 tty_keys_mouse(struct tty *tty, const char *buf, size_t len, size_t *size, 1135 struct mouse_event *m) 1136 { 1137 struct client *c = tty->client; 1138 u_int i, x, y, b, sgr_b; 1139 u_char sgr_type, ch; 1140 1141 /* 1142 * Standard mouse sequences are \033[M followed by three characters 1143 * indicating button, X and Y, all based at 32 with 1,1 top-left. 1144 * 1145 * UTF-8 mouse sequences are similar but the three are expressed as 1146 * UTF-8 characters. 1147 * 1148 * SGR extended mouse sequences are \033[< followed by three numbers in 1149 * decimal and separated by semicolons indicating button, X and Y. A 1150 * trailing 'M' is click or scroll and trailing 'm' release. All are 1151 * based at 0 with 1,1 top-left. 1152 */ 1153 1154 *size = 0; 1155 x = y = b = sgr_b = 0; 1156 sgr_type = ' '; 1157 1158 /* First two bytes are always \033[. */ 1159 if (buf[0] != '\033') 1160 return (-1); 1161 if (len == 1) 1162 return (1); 1163 if (buf[1] != '[') 1164 return (-1); 1165 if (len == 2) 1166 return (1); 1167 1168 /* 1169 * Third byte is M in old standard (and UTF-8 extension which we do not 1170 * support), < in SGR extension. 1171 */ 1172 if (buf[2] == 'M') { 1173 /* Read the three inputs. */ 1174 *size = 3; 1175 for (i = 0; i < 3; i++) { 1176 if (len <= *size) 1177 return (1); 1178 ch = (u_char)buf[(*size)++]; 1179 if (i == 0) 1180 b = ch; 1181 else if (i == 1) 1182 x = ch; 1183 else 1184 y = ch; 1185 } 1186 log_debug("%s: mouse input: %.*s", c->name, (int)*size, buf); 1187 1188 /* Check and return the mouse input. */ 1189 if (b < MOUSE_PARAM_BTN_OFF || 1190 x < MOUSE_PARAM_POS_OFF || 1191 y < MOUSE_PARAM_POS_OFF) 1192 return (-2); 1193 b -= MOUSE_PARAM_BTN_OFF; 1194 x -= MOUSE_PARAM_POS_OFF; 1195 y -= MOUSE_PARAM_POS_OFF; 1196 } else if (buf[2] == '<') { 1197 /* Read the three inputs. */ 1198 *size = 3; 1199 while (1) { 1200 if (len <= *size) 1201 return (1); 1202 ch = (u_char)buf[(*size)++]; 1203 if (ch == ';') 1204 break; 1205 if (ch < '0' || ch > '9') 1206 return (-1); 1207 sgr_b = 10 * sgr_b + (ch - '0'); 1208 } 1209 while (1) { 1210 if (len <= *size) 1211 return (1); 1212 ch = (u_char)buf[(*size)++]; 1213 if (ch == ';') 1214 break; 1215 if (ch < '0' || ch > '9') 1216 return (-1); 1217 x = 10 * x + (ch - '0'); 1218 } 1219 while (1) { 1220 if (len <= *size) 1221 return (1); 1222 ch = (u_char)buf[(*size)++]; 1223 if (ch == 'M' || ch == 'm') 1224 break; 1225 if (ch < '0' || ch > '9') 1226 return (-1); 1227 y = 10 * y + (ch - '0'); 1228 } 1229 log_debug("%s: mouse input (SGR): %.*s", c->name, (int)*size, 1230 buf); 1231 1232 /* Check and return the mouse input. */ 1233 if (x < 1 || y < 1) 1234 return (-2); 1235 x--; 1236 y--; 1237 b = sgr_b; 1238 1239 /* Type is M for press, m for release. */ 1240 sgr_type = ch; 1241 if (sgr_type == 'm') 1242 b = 3; 1243 1244 /* 1245 * Some terminals (like PuTTY 0.63) mistakenly send 1246 * button-release events for scroll-wheel button-press event. 1247 * Discard it before it reaches any program running inside 1248 * tmux. 1249 */ 1250 if (sgr_type == 'm' && MOUSE_WHEEL(sgr_b)) 1251 return (-2); 1252 } else 1253 return (-1); 1254 1255 /* Fill mouse event. */ 1256 m->lx = tty->mouse_last_x; 1257 m->x = x; 1258 m->ly = tty->mouse_last_y; 1259 m->y = y; 1260 m->lb = tty->mouse_last_b; 1261 m->b = b; 1262 m->sgr_type = sgr_type; 1263 m->sgr_b = sgr_b; 1264 1265 /* Update last mouse state. */ 1266 tty->mouse_last_x = x; 1267 tty->mouse_last_y = y; 1268 tty->mouse_last_b = b; 1269 1270 return (0); 1271 } 1272 1273 /* 1274 * Handle OSC 52 clipboard input. Returns 0 for success, -1 for failure, 1 for 1275 * partial. 1276 */ 1277 static int 1278 tty_keys_clipboard(struct tty *tty, const char *buf, size_t len, size_t *size) 1279 { 1280 struct client *c = tty->client; 1281 struct window_pane *wp; 1282 size_t end, terminator = 0, needed; 1283 char *copy, *out; 1284 int outlen; 1285 u_int i; 1286 1287 *size = 0; 1288 1289 /* First five bytes are always \033]52;. */ 1290 if (buf[0] != '\033') 1291 return (-1); 1292 if (len == 1) 1293 return (1); 1294 if (buf[1] != ']') 1295 return (-1); 1296 if (len == 2) 1297 return (1); 1298 if (buf[2] != '5') 1299 return (-1); 1300 if (len == 3) 1301 return (1); 1302 if (buf[3] != '2') 1303 return (-1); 1304 if (len == 4) 1305 return (1); 1306 if (buf[4] != ';') 1307 return (-1); 1308 if (len == 5) 1309 return (1); 1310 1311 /* Find the terminator if any. */ 1312 for (end = 5; end < len; end++) { 1313 if (buf[end] == '\007') { 1314 terminator = 1; 1315 break; 1316 } 1317 if (end > 5 && buf[end - 1] == '\033' && buf[end] == '\\') { 1318 terminator = 2; 1319 break; 1320 } 1321 } 1322 if (end == len) 1323 return (1); 1324 *size = end + 1; 1325 1326 /* Skip the initial part. */ 1327 buf += 5; 1328 end -= 5; 1329 1330 /* Adjust end so that it points to the start of the terminator. */ 1331 end -= terminator - 1; 1332 1333 /* Get the second argument. */ 1334 while (end != 0 && *buf != ';') { 1335 buf++; 1336 end--; 1337 } 1338 if (end == 0 || end == 1) 1339 return (0); 1340 buf++; 1341 end--; 1342 1343 /* If we did not request this, ignore it. */ 1344 if (~tty->flags & TTY_OSC52QUERY) 1345 return (0); 1346 tty->flags &= ~TTY_OSC52QUERY; 1347 evtimer_del(&tty->clipboard_timer); 1348 1349 /* It has to be a string so copy it. */ 1350 copy = xmalloc(end + 1); 1351 memcpy(copy, buf, end); 1352 copy[end] = '\0'; 1353 1354 /* Convert from base64. */ 1355 needed = (end / 4) * 3; 1356 out = xmalloc(needed); 1357 if ((outlen = b64_pton(copy, out, len)) == -1) { 1358 free(out); 1359 free(copy); 1360 return (0); 1361 } 1362 free(copy); 1363 1364 /* Create a new paste buffer and forward to panes. */ 1365 log_debug("%s: %.*s", __func__, outlen, out); 1366 if (c->flags & CLIENT_CLIPBOARDBUFFER) { 1367 paste_add(NULL, out, outlen); 1368 c->flags &= ~CLIENT_CLIPBOARDBUFFER; 1369 } 1370 for (i = 0; i < c->clipboard_npanes; i++) { 1371 wp = window_pane_find_by_id(c->clipboard_panes[i]); 1372 if (wp != NULL) 1373 input_reply_clipboard(wp->event, out, outlen, "\033\\"); 1374 } 1375 free(c->clipboard_panes); 1376 c->clipboard_panes = NULL; 1377 c->clipboard_npanes = 0; 1378 1379 return (0); 1380 } 1381 1382 /* 1383 * Handle primary device attributes input. Returns 0 for success, -1 for 1384 * failure, 1 for partial. 1385 */ 1386 static int 1387 tty_keys_device_attributes(struct tty *tty, const char *buf, size_t len, 1388 size_t *size) 1389 { 1390 struct client *c = tty->client; 1391 int *features = &c->term_features; 1392 u_int i, n = 0; 1393 char tmp[128], *endptr, p[32] = { 0 }, *cp, *next; 1394 1395 *size = 0; 1396 if (tty->flags & TTY_HAVEDA) 1397 return (-1); 1398 1399 /* First three bytes are always \033[?. */ 1400 if (buf[0] != '\033') 1401 return (-1); 1402 if (len == 1) 1403 return (1); 1404 if (buf[1] != '[') 1405 return (-1); 1406 if (len == 2) 1407 return (1); 1408 if (buf[2] != '?') 1409 return (-1); 1410 if (len == 3) 1411 return (1); 1412 1413 /* Copy the rest up to a c. */ 1414 for (i = 0; i < (sizeof tmp); i++) { 1415 if (3 + i == len) 1416 return (1); 1417 if (buf[3 + i] == 'c') 1418 break; 1419 tmp[i] = buf[3 + i]; 1420 } 1421 if (i == (sizeof tmp)) 1422 return (-1); 1423 tmp[i] = '\0'; 1424 *size = 4 + i; 1425 1426 /* Convert all arguments to numbers. */ 1427 cp = tmp; 1428 while ((next = strsep(&cp, ";")) != NULL) { 1429 p[n] = strtoul(next, &endptr, 10); 1430 if (*endptr != '\0') 1431 p[n] = 0; 1432 if (++n == nitems(p)) 1433 break; 1434 } 1435 1436 /* Add terminal features. */ 1437 switch (p[0]) { 1438 case 61: /* level 1 */ 1439 case 62: /* level 2 */ 1440 case 63: /* level 3 */ 1441 case 64: /* level 4 */ 1442 case 65: /* level 5 */ 1443 for (i = 1; i < n; i++) { 1444 log_debug("%s: DA feature: %d", c->name, p[i]); 1445 if (p[i] == 4) 1446 tty_add_features(features, "sixel", ","); 1447 if (p[i] == 21) 1448 tty_add_features(features, "margins", ","); 1449 if (p[i] == 28) 1450 tty_add_features(features, "rectfill", ","); 1451 } 1452 break; 1453 } 1454 log_debug("%s: received primary DA %.*s", c->name, (int)*size, buf); 1455 1456 tty_update_features(tty); 1457 tty->flags |= TTY_HAVEDA; 1458 1459 return (0); 1460 } 1461 1462 /* 1463 * Handle secondary device attributes input. Returns 0 for success, -1 for 1464 * failure, 1 for partial. 1465 */ 1466 static int 1467 tty_keys_device_attributes2(struct tty *tty, const char *buf, size_t len, 1468 size_t *size) 1469 { 1470 struct client *c = tty->client; 1471 int *features = &c->term_features; 1472 u_int i, n = 0; 1473 char tmp[128], *endptr, p[32] = { 0 }, *cp, *next; 1474 1475 *size = 0; 1476 if (tty->flags & TTY_HAVEDA2) 1477 return (-1); 1478 1479 /* First three bytes are always \033[>. */ 1480 if (buf[0] != '\033') 1481 return (-1); 1482 if (len == 1) 1483 return (1); 1484 if (buf[1] != '[') 1485 return (-1); 1486 if (len == 2) 1487 return (1); 1488 if (buf[2] != '>') 1489 return (-1); 1490 if (len == 3) 1491 return (1); 1492 1493 /* Copy the rest up to a c. */ 1494 for (i = 0; i < (sizeof tmp); i++) { 1495 if (3 + i == len) 1496 return (1); 1497 if (buf[3 + i] == 'c') 1498 break; 1499 tmp[i] = buf[3 + i]; 1500 } 1501 if (i == (sizeof tmp)) 1502 return (-1); 1503 tmp[i] = '\0'; 1504 *size = 4 + i; 1505 1506 /* Convert all arguments to numbers. */ 1507 cp = tmp; 1508 while ((next = strsep(&cp, ";")) != NULL) { 1509 p[n] = strtoul(next, &endptr, 10); 1510 if (*endptr != '\0') 1511 p[n] = 0; 1512 if (++n == nitems(p)) 1513 break; 1514 } 1515 1516 /* 1517 * Add terminal features. We add DECSLRM and DECFRA for some 1518 * identification codes here, notably 64 will catch VT520, even though 1519 * we can't use level 5 from DA because of VTE. 1520 */ 1521 switch (p[0]) { 1522 case 'M': /* mintty */ 1523 tty_default_features(features, "mintty", 0); 1524 break; 1525 case 'T': /* tmux */ 1526 tty_default_features(features, "tmux", 0); 1527 break; 1528 case 'U': /* rxvt-unicode */ 1529 tty_default_features(features, "rxvt-unicode", 0); 1530 break; 1531 } 1532 log_debug("%s: received secondary DA %.*s", c->name, (int)*size, buf); 1533 1534 tty_update_features(tty); 1535 tty->flags |= TTY_HAVEDA2; 1536 1537 return (0); 1538 } 1539 1540 /* 1541 * Handle extended device attributes input. Returns 0 for success, -1 for 1542 * failure, 1 for partial. 1543 */ 1544 static int 1545 tty_keys_extended_device_attributes(struct tty *tty, const char *buf, 1546 size_t len, size_t *size) 1547 { 1548 struct client *c = tty->client; 1549 int *features = &c->term_features; 1550 u_int i; 1551 char tmp[128]; 1552 1553 *size = 0; 1554 if (tty->flags & TTY_HAVEXDA) 1555 return (-1); 1556 1557 /* First four bytes are always \033P>|. */ 1558 if (buf[0] != '\033') 1559 return (-1); 1560 if (len == 1) 1561 return (1); 1562 if (buf[1] != 'P') 1563 return (-1); 1564 if (len == 2) 1565 return (1); 1566 if (buf[2] != '>') 1567 return (-1); 1568 if (len == 3) 1569 return (1); 1570 if (buf[3] != '|') 1571 return (-1); 1572 if (len == 4) 1573 return (1); 1574 1575 /* Copy the rest up to \033\. */ 1576 for (i = 0; i < (sizeof tmp) - 1; i++) { 1577 if (4 + i == len) 1578 return (1); 1579 if (buf[4 + i - 1] == '\033' && buf[4 + i] == '\\') 1580 break; 1581 tmp[i] = buf[4 + i]; 1582 } 1583 if (i == (sizeof tmp) - 1) 1584 return (-1); 1585 tmp[i - 1] = '\0'; 1586 *size = 5 + i; 1587 1588 /* Add terminal features. */ 1589 if (strncmp(tmp, "iTerm2 ", 7) == 0) 1590 tty_default_features(features, "iTerm2", 0); 1591 else if (strncmp(tmp, "tmux ", 5) == 0) 1592 tty_default_features(features, "tmux", 0); 1593 else if (strncmp(tmp, "XTerm(", 6) == 0) 1594 tty_default_features(features, "XTerm", 0); 1595 else if (strncmp(tmp, "mintty ", 7) == 0) 1596 tty_default_features(features, "mintty", 0); 1597 else if (strncmp(tmp, "foot(", 5) == 0) 1598 tty_default_features(features, "foot", 0); 1599 log_debug("%s: received extended DA %.*s", c->name, (int)*size, buf); 1600 1601 free(c->term_type); 1602 c->term_type = xstrdup(tmp); 1603 1604 tty_update_features(tty); 1605 tty->flags |= TTY_HAVEXDA; 1606 1607 return (0); 1608 } 1609 1610 /* 1611 * Handle foreground or background input. Returns 0 for success, -1 for 1612 * failure, 1 for partial. 1613 */ 1614 int 1615 tty_keys_colours(struct tty *tty, const char *buf, size_t len, size_t *size, 1616 int *fg, int *bg) 1617 { 1618 struct client *c = tty->client; 1619 u_int i; 1620 char tmp[128]; 1621 int n; 1622 1623 *size = 0; 1624 1625 /* First four bytes are always \033]1 and 0 or 1 and ;. */ 1626 if (buf[0] != '\033') 1627 return (-1); 1628 if (len == 1) 1629 return (1); 1630 if (buf[1] != ']') 1631 return (-1); 1632 if (len == 2) 1633 return (1); 1634 if (buf[2] != '1') 1635 return (-1); 1636 if (len == 3) 1637 return (1); 1638 if (buf[3] != '0' && buf[3] != '1') 1639 return (-1); 1640 if (len == 4) 1641 return (1); 1642 if (buf[4] != ';') 1643 return (-1); 1644 if (len == 5) 1645 return (1); 1646 1647 /* Copy the rest up to \033\ or \007. */ 1648 for (i = 0; i < (sizeof tmp) - 1; i++) { 1649 if (5 + i == len) 1650 return (1); 1651 if (buf[5 + i - 1] == '\033' && buf[5 + i] == '\\') 1652 break; 1653 if (buf[5 + i] == '\007') 1654 break; 1655 tmp[i] = buf[5 + i]; 1656 } 1657 if (i == (sizeof tmp) - 1) 1658 return (-1); 1659 if (tmp[i - 1] == '\033') 1660 tmp[i - 1] = '\0'; 1661 else 1662 tmp[i] = '\0'; 1663 *size = 6 + i; 1664 1665 n = colour_parseX11(tmp); 1666 if (n != -1 && buf[3] == '0') { 1667 if (c != NULL) 1668 log_debug("%s fg is %s", c->name, colour_tostring(n)); 1669 else 1670 log_debug("fg is %s", colour_tostring(n)); 1671 *fg = n; 1672 } else if (n != -1) { 1673 if (c != NULL) 1674 log_debug("%s bg is %s", c->name, colour_tostring(n)); 1675 else 1676 log_debug("bg is %s", colour_tostring(n)); 1677 *bg = n; 1678 } 1679 1680 return (0); 1681 } 1682