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