1 /* $OpenBSD: tty-keys.c,v 1.42 2012/07/10 11:53:01 nicm Exp $ */ 2 3 /* 4 * Copyright (c) 2007 Nicholas Marriott <nicm@users.sourceforge.net> 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 <limits.h> 23 #include <stdlib.h> 24 #include <string.h> 25 #include <termios.h> 26 #include <unistd.h> 27 28 #include "tmux.h" 29 30 /* 31 * Handle keys input from the outside terminal. tty_keys[] is a base table of 32 * supported keys which are looked up in terminfo(5) and translated into a 33 * ternary tree (a binary tree of binary trees). 34 */ 35 36 void tty_keys_add1(struct tty_key **, const char *, int); 37 void tty_keys_add(struct tty *, const char *, int); 38 void tty_keys_free1(struct tty_key *); 39 struct tty_key *tty_keys_find1( 40 struct tty_key *, const char *, size_t, size_t *); 41 struct tty_key *tty_keys_find(struct tty *, const char *, size_t, size_t *); 42 void tty_keys_callback(int, short, void *); 43 int tty_keys_mouse(struct tty *, const char *, size_t, size_t *); 44 int tty_keys_device(struct tty *, const char *, size_t, size_t *); 45 46 struct tty_key_ent { 47 enum tty_code_code code; 48 const char *string; 49 50 int key; 51 int flags; 52 #define TTYKEY_RAW 0x1 53 }; 54 55 /* 56 * Default key tables. Those flagged with TTYKEY_RAW are inserted directly, 57 * otherwise they are looked up in terminfo(5). 58 */ 59 const struct tty_key_ent tty_keys[] = { 60 /* 61 * Numeric keypad. Just use the vt100 escape sequences here and always 62 * put the terminal into keypad_xmit mode. Translation of numbers 63 * mode/applications mode is done in input-keys.c. 64 */ 65 { 0, "\033Oo", KEYC_KP_SLASH, TTYKEY_RAW }, 66 { 0, "\033Oj", KEYC_KP_STAR, TTYKEY_RAW }, 67 { 0, "\033Om", KEYC_KP_MINUS, TTYKEY_RAW }, 68 { 0, "\033Ow", KEYC_KP_SEVEN, TTYKEY_RAW }, 69 { 0, "\033Ox", KEYC_KP_EIGHT, TTYKEY_RAW }, 70 { 0, "\033Oy", KEYC_KP_NINE, TTYKEY_RAW }, 71 { 0, "\033Ok", KEYC_KP_PLUS, TTYKEY_RAW }, 72 { 0, "\033Ot", KEYC_KP_FOUR, TTYKEY_RAW }, 73 { 0, "\033Ou", KEYC_KP_FIVE, TTYKEY_RAW }, 74 { 0, "\033Ov", KEYC_KP_SIX, TTYKEY_RAW }, 75 { 0, "\033Oq", KEYC_KP_ONE, TTYKEY_RAW }, 76 { 0, "\033Or", KEYC_KP_TWO, TTYKEY_RAW }, 77 { 0, "\033Os", KEYC_KP_THREE, TTYKEY_RAW }, 78 { 0, "\033OM", KEYC_KP_ENTER, TTYKEY_RAW }, 79 { 0, "\033Op", KEYC_KP_ZERO, TTYKEY_RAW }, 80 { 0, "\033On", KEYC_KP_PERIOD, TTYKEY_RAW }, 81 82 /* Arrow keys. */ 83 { 0, "\033OA", KEYC_UP, TTYKEY_RAW }, 84 { 0, "\033OB", KEYC_DOWN, TTYKEY_RAW }, 85 { 0, "\033OC", KEYC_RIGHT, TTYKEY_RAW }, 86 { 0, "\033OD", KEYC_LEFT, TTYKEY_RAW }, 87 88 { 0, "\033[A", KEYC_UP, TTYKEY_RAW }, 89 { 0, "\033[B", KEYC_DOWN, TTYKEY_RAW }, 90 { 0, "\033[C", KEYC_RIGHT, TTYKEY_RAW }, 91 { 0, "\033[D", KEYC_LEFT, TTYKEY_RAW }, 92 93 /* rxvt-style arrow + modifier keys. */ 94 { 0, "\033Oa", KEYC_UP|KEYC_CTRL, TTYKEY_RAW }, 95 { 0, "\033Ob", KEYC_DOWN|KEYC_CTRL, TTYKEY_RAW }, 96 { 0, "\033Oc", KEYC_RIGHT|KEYC_CTRL, TTYKEY_RAW }, 97 { 0, "\033Od", KEYC_LEFT|KEYC_CTRL, TTYKEY_RAW }, 98 99 { 0, "\033[a", KEYC_UP|KEYC_SHIFT, TTYKEY_RAW }, 100 { 0, "\033[b", KEYC_DOWN|KEYC_SHIFT, TTYKEY_RAW }, 101 { 0, "\033[c", KEYC_RIGHT|KEYC_SHIFT, TTYKEY_RAW }, 102 { 0, "\033[d", KEYC_LEFT|KEYC_SHIFT, TTYKEY_RAW }, 103 104 /* 105 * rxvt-style function + modifier keys: 106 * Ctrl = ^, Shift = $, Ctrl+Shift = @ 107 */ 108 { 0, "\033[11^", KEYC_F1|KEYC_CTRL, TTYKEY_RAW }, 109 { 0, "\033[12^", KEYC_F2|KEYC_CTRL, TTYKEY_RAW }, 110 { 0, "\033[13^", KEYC_F3|KEYC_CTRL, TTYKEY_RAW }, 111 { 0, "\033[14^", KEYC_F4|KEYC_CTRL, TTYKEY_RAW }, 112 { 0, "\033[15^", KEYC_F5|KEYC_CTRL, TTYKEY_RAW }, 113 { 0, "\033[17^", KEYC_F6|KEYC_CTRL, TTYKEY_RAW }, 114 { 0, "\033[18^", KEYC_F7|KEYC_CTRL, TTYKEY_RAW }, 115 { 0, "\033[19^", KEYC_F8|KEYC_CTRL, TTYKEY_RAW }, 116 { 0, "\033[20^", KEYC_F9|KEYC_CTRL, TTYKEY_RAW }, 117 { 0, "\033[21^", KEYC_F10|KEYC_CTRL, TTYKEY_RAW }, 118 { 0, "\033[23^", KEYC_F11|KEYC_CTRL, TTYKEY_RAW }, 119 { 0, "\033[24^", KEYC_F12|KEYC_CTRL, TTYKEY_RAW }, 120 { 0, "\033[25^", KEYC_F13|KEYC_CTRL, TTYKEY_RAW }, 121 { 0, "\033[26^", KEYC_F14|KEYC_CTRL, TTYKEY_RAW }, 122 { 0, "\033[28^", KEYC_F15|KEYC_CTRL, TTYKEY_RAW }, 123 { 0, "\033[29^", KEYC_F16|KEYC_CTRL, TTYKEY_RAW }, 124 { 0, "\033[31^", KEYC_F17|KEYC_CTRL, TTYKEY_RAW }, 125 { 0, "\033[32^", KEYC_F18|KEYC_CTRL, TTYKEY_RAW }, 126 { 0, "\033[33^", KEYC_F19|KEYC_CTRL, TTYKEY_RAW }, 127 { 0, "\033[34^", KEYC_F20|KEYC_CTRL, TTYKEY_RAW }, 128 { 0, "\033[2^", KEYC_IC|KEYC_CTRL, TTYKEY_RAW }, 129 { 0, "\033[3^", KEYC_DC|KEYC_CTRL, TTYKEY_RAW }, 130 { 0, "\033[7^", KEYC_HOME|KEYC_CTRL, TTYKEY_RAW }, 131 { 0, "\033[8^", KEYC_END|KEYC_CTRL, TTYKEY_RAW }, 132 { 0, "\033[6^", KEYC_NPAGE|KEYC_CTRL, TTYKEY_RAW }, 133 { 0, "\033[5^", KEYC_PPAGE|KEYC_CTRL, TTYKEY_RAW }, 134 135 { 0, "\033[11$", KEYC_F1|KEYC_SHIFT, TTYKEY_RAW }, 136 { 0, "\033[12$", KEYC_F2|KEYC_SHIFT, TTYKEY_RAW }, 137 { 0, "\033[13$", KEYC_F3|KEYC_SHIFT, TTYKEY_RAW }, 138 { 0, "\033[14$", KEYC_F4|KEYC_SHIFT, TTYKEY_RAW }, 139 { 0, "\033[15$", KEYC_F5|KEYC_SHIFT, TTYKEY_RAW }, 140 { 0, "\033[17$", KEYC_F6|KEYC_SHIFT, TTYKEY_RAW }, 141 { 0, "\033[18$", KEYC_F7|KEYC_SHIFT, TTYKEY_RAW }, 142 { 0, "\033[19$", KEYC_F8|KEYC_SHIFT, TTYKEY_RAW }, 143 { 0, "\033[20$", KEYC_F9|KEYC_SHIFT, TTYKEY_RAW }, 144 { 0, "\033[21$", KEYC_F10|KEYC_SHIFT, TTYKEY_RAW }, 145 { 0, "\033[23$", KEYC_F11|KEYC_SHIFT, TTYKEY_RAW }, 146 { 0, "\033[24$", KEYC_F12|KEYC_SHIFT, TTYKEY_RAW }, 147 { 0, "\033[25$", KEYC_F13|KEYC_SHIFT, TTYKEY_RAW }, 148 { 0, "\033[26$", KEYC_F14|KEYC_SHIFT, TTYKEY_RAW }, 149 { 0, "\033[28$", KEYC_F15|KEYC_SHIFT, TTYKEY_RAW }, 150 { 0, "\033[29$", KEYC_F16|KEYC_SHIFT, TTYKEY_RAW }, 151 { 0, "\033[31$", KEYC_F17|KEYC_SHIFT, TTYKEY_RAW }, 152 { 0, "\033[32$", KEYC_F18|KEYC_SHIFT, TTYKEY_RAW }, 153 { 0, "\033[33$", KEYC_F19|KEYC_SHIFT, TTYKEY_RAW }, 154 { 0, "\033[34$", KEYC_F20|KEYC_SHIFT, TTYKEY_RAW }, 155 { 0, "\033[2$", KEYC_IC|KEYC_SHIFT, TTYKEY_RAW }, 156 { 0, "\033[3$", KEYC_DC|KEYC_SHIFT, TTYKEY_RAW }, 157 { 0, "\033[7$", KEYC_HOME|KEYC_SHIFT, TTYKEY_RAW }, 158 { 0, "\033[8$", KEYC_END|KEYC_SHIFT, TTYKEY_RAW }, 159 { 0, "\033[6$", KEYC_NPAGE|KEYC_SHIFT, TTYKEY_RAW }, 160 { 0, "\033[5$", KEYC_PPAGE|KEYC_SHIFT, TTYKEY_RAW }, 161 162 { 0, "\033[11@", KEYC_F1|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW }, 163 { 0, "\033[12@", KEYC_F2|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW }, 164 { 0, "\033[13@", KEYC_F3|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW }, 165 { 0, "\033[14@", KEYC_F4|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW }, 166 { 0, "\033[15@", KEYC_F5|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW }, 167 { 0, "\033[17@", KEYC_F6|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW }, 168 { 0, "\033[18@", KEYC_F7|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW }, 169 { 0, "\033[19@", KEYC_F8|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW }, 170 { 0, "\033[20@", KEYC_F9|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW }, 171 { 0, "\033[21@", KEYC_F10|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW }, 172 { 0, "\033[23@", KEYC_F11|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW }, 173 { 0, "\033[24@", KEYC_F12|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW }, 174 { 0, "\033[25@", KEYC_F13|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW }, 175 { 0, "\033[26@", KEYC_F14|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW }, 176 { 0, "\033[28@", KEYC_F15|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW }, 177 { 0, "\033[29@", KEYC_F16|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW }, 178 { 0, "\033[31@", KEYC_F17|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW }, 179 { 0, "\033[32@", KEYC_F18|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW }, 180 { 0, "\033[33@", KEYC_F19|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW }, 181 { 0, "\033[34@", KEYC_F20|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW }, 182 { 0, "\033[2@", KEYC_IC|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW }, 183 { 0, "\033[3@", KEYC_DC|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW }, 184 { 0, "\033[7@", KEYC_HOME|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW }, 185 { 0, "\033[8@", KEYC_END|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW }, 186 { 0, "\033[6@", KEYC_NPAGE|KEYC_CTRL|KEYC_SHIFT,TTYKEY_RAW }, 187 { 0, "\033[5@", KEYC_PPAGE|KEYC_CTRL|KEYC_SHIFT,TTYKEY_RAW }, 188 189 /* terminfo lookups below this line so they can override raw keys. */ 190 191 /* Function keys. */ 192 { TTYC_KF1, NULL, KEYC_F1, 0 }, 193 { TTYC_KF2, NULL, KEYC_F2, 0 }, 194 { TTYC_KF3, NULL, KEYC_F3, 0 }, 195 { TTYC_KF4, NULL, KEYC_F4, 0 }, 196 { TTYC_KF5, NULL, KEYC_F5, 0 }, 197 { TTYC_KF6, NULL, KEYC_F6, 0 }, 198 { TTYC_KF7, NULL, KEYC_F7, 0 }, 199 { TTYC_KF8, NULL, KEYC_F8, 0 }, 200 { TTYC_KF9, NULL, KEYC_F9, 0 }, 201 { TTYC_KF10, NULL, KEYC_F10, 0 }, 202 { TTYC_KF11, NULL, KEYC_F11, 0 }, 203 { TTYC_KF12, NULL, KEYC_F12, 0 }, 204 { TTYC_KF13, NULL, KEYC_F13, 0 }, 205 { TTYC_KF14, NULL, KEYC_F14, 0 }, 206 { TTYC_KF15, NULL, KEYC_F15, 0 }, 207 { TTYC_KF16, NULL, KEYC_F16, 0 }, 208 { TTYC_KF17, NULL, KEYC_F17, 0 }, 209 { TTYC_KF18, NULL, KEYC_F18, 0 }, 210 { TTYC_KF19, NULL, KEYC_F19, 0 }, 211 { TTYC_KF20, NULL, KEYC_F20, 0 }, 212 { TTYC_KICH1, NULL, KEYC_IC, 0 }, 213 { TTYC_KDCH1, NULL, KEYC_DC, 0 }, 214 { TTYC_KHOME, NULL, KEYC_HOME, 0 }, 215 { TTYC_KEND, NULL, KEYC_END, 0 }, 216 { TTYC_KNP, NULL, KEYC_NPAGE, 0 }, 217 { TTYC_KPP, NULL, KEYC_PPAGE, 0 }, 218 { TTYC_KCBT, NULL, KEYC_BTAB, 0 }, 219 220 /* Arrow keys from terminfo. */ 221 { TTYC_KCUU1, NULL, KEYC_UP, 0 }, 222 { TTYC_KCUD1, NULL, KEYC_DOWN, 0 }, 223 { TTYC_KCUB1, NULL, KEYC_LEFT, 0 }, 224 { TTYC_KCUF1, NULL, KEYC_RIGHT, 0 }, 225 226 /* Key and modifier capabilities. */ 227 { TTYC_KDC2, NULL, KEYC_DC|KEYC_SHIFT, 0 }, 228 { TTYC_KDC3, NULL, KEYC_DC|KEYC_ESCAPE, 0 }, 229 { TTYC_KDC4, NULL, KEYC_DC|KEYC_SHIFT|KEYC_ESCAPE, 0 }, 230 { TTYC_KDC5, NULL, KEYC_DC|KEYC_CTRL, 0 }, 231 { TTYC_KDC6, NULL, KEYC_DC|KEYC_SHIFT|KEYC_CTRL, 0 }, 232 { TTYC_KDC7, NULL, KEYC_DC|KEYC_ESCAPE|KEYC_CTRL, 0 }, 233 { TTYC_KDN2, NULL, KEYC_DOWN|KEYC_SHIFT, 0 }, 234 { TTYC_KDN3, NULL, KEYC_DOWN|KEYC_ESCAPE, 0 }, 235 { TTYC_KDN4, NULL, KEYC_DOWN|KEYC_SHIFT|KEYC_ESCAPE, 0 }, 236 { TTYC_KDN5, NULL, KEYC_DOWN|KEYC_CTRL, 0 }, 237 { TTYC_KDN6, NULL, KEYC_DOWN|KEYC_SHIFT|KEYC_CTRL, 0 }, 238 { TTYC_KDN7, NULL, KEYC_DOWN|KEYC_ESCAPE|KEYC_CTRL, 0 }, 239 { TTYC_KEND2, NULL, KEYC_END|KEYC_SHIFT, 0 }, 240 { TTYC_KEND3, NULL, KEYC_END|KEYC_ESCAPE, 0 }, 241 { TTYC_KEND4, NULL, KEYC_END|KEYC_SHIFT|KEYC_ESCAPE, 0 }, 242 { TTYC_KEND5, NULL, KEYC_END|KEYC_CTRL, 0 }, 243 { TTYC_KEND6, NULL, KEYC_END|KEYC_SHIFT|KEYC_CTRL, 0 }, 244 { TTYC_KEND7, NULL, KEYC_END|KEYC_ESCAPE|KEYC_CTRL, 0 }, 245 { TTYC_KHOM2, NULL, KEYC_HOME|KEYC_SHIFT, 0 }, 246 { TTYC_KHOM3, NULL, KEYC_HOME|KEYC_ESCAPE, 0 }, 247 { TTYC_KHOM4, NULL, KEYC_HOME|KEYC_SHIFT|KEYC_ESCAPE, 0 }, 248 { TTYC_KHOM5, NULL, KEYC_HOME|KEYC_CTRL, 0 }, 249 { TTYC_KHOM6, NULL, KEYC_HOME|KEYC_SHIFT|KEYC_CTRL, 0 }, 250 { TTYC_KHOM7, NULL, KEYC_HOME|KEYC_ESCAPE|KEYC_CTRL, 0 }, 251 { TTYC_KIC2, NULL, KEYC_IC|KEYC_SHIFT, 0 }, 252 { TTYC_KIC3, NULL, KEYC_IC|KEYC_ESCAPE, 0 }, 253 { TTYC_KIC4, NULL, KEYC_IC|KEYC_SHIFT|KEYC_ESCAPE, 0 }, 254 { TTYC_KIC5, NULL, KEYC_IC|KEYC_CTRL, 0 }, 255 { TTYC_KIC6, NULL, KEYC_IC|KEYC_SHIFT|KEYC_CTRL, 0 }, 256 { TTYC_KIC7, NULL, KEYC_IC|KEYC_ESCAPE|KEYC_CTRL, 0 }, 257 { TTYC_KLFT2, NULL, KEYC_LEFT|KEYC_SHIFT, 0 }, 258 { TTYC_KLFT3, NULL, KEYC_LEFT|KEYC_ESCAPE, 0 }, 259 { TTYC_KLFT4, NULL, KEYC_LEFT|KEYC_SHIFT|KEYC_ESCAPE, 0 }, 260 { TTYC_KLFT5, NULL, KEYC_LEFT|KEYC_CTRL, 0 }, 261 { TTYC_KLFT6, NULL, KEYC_LEFT|KEYC_SHIFT|KEYC_CTRL, 0 }, 262 { TTYC_KLFT7, NULL, KEYC_LEFT|KEYC_ESCAPE|KEYC_CTRL, 0 }, 263 { TTYC_KNXT2, NULL, KEYC_NPAGE|KEYC_SHIFT, 0 }, 264 { TTYC_KNXT3, NULL, KEYC_NPAGE|KEYC_ESCAPE, 0 }, 265 { TTYC_KNXT4, NULL, KEYC_NPAGE|KEYC_SHIFT|KEYC_ESCAPE, 0 }, 266 { TTYC_KNXT5, NULL, KEYC_NPAGE|KEYC_CTRL, 0 }, 267 { TTYC_KNXT6, NULL, KEYC_NPAGE|KEYC_SHIFT|KEYC_CTRL, 0 }, 268 { TTYC_KNXT7, NULL, KEYC_NPAGE|KEYC_ESCAPE|KEYC_CTRL, 0 }, 269 { TTYC_KPRV2, NULL, KEYC_PPAGE|KEYC_SHIFT, 0 }, 270 { TTYC_KPRV3, NULL, KEYC_PPAGE|KEYC_ESCAPE, 0 }, 271 { TTYC_KPRV4, NULL, KEYC_PPAGE|KEYC_SHIFT|KEYC_ESCAPE, 0 }, 272 { TTYC_KPRV5, NULL, KEYC_PPAGE|KEYC_CTRL, 0 }, 273 { TTYC_KPRV6, NULL, KEYC_PPAGE|KEYC_SHIFT|KEYC_CTRL, 0 }, 274 { TTYC_KPRV7, NULL, KEYC_PPAGE|KEYC_ESCAPE|KEYC_CTRL, 0 }, 275 { TTYC_KRIT2, NULL, KEYC_RIGHT|KEYC_SHIFT, 0 }, 276 { TTYC_KRIT3, NULL, KEYC_RIGHT|KEYC_ESCAPE, 0 }, 277 { TTYC_KRIT4, NULL, KEYC_RIGHT|KEYC_SHIFT|KEYC_ESCAPE, 0 }, 278 { TTYC_KRIT5, NULL, KEYC_RIGHT|KEYC_CTRL, 0 }, 279 { TTYC_KRIT6, NULL, KEYC_RIGHT|KEYC_SHIFT|KEYC_CTRL, 0 }, 280 { TTYC_KRIT7, NULL, KEYC_RIGHT|KEYC_ESCAPE|KEYC_CTRL, 0 }, 281 { TTYC_KUP2, NULL, KEYC_UP|KEYC_SHIFT, 0 }, 282 { TTYC_KUP3, NULL, KEYC_UP|KEYC_ESCAPE, 0 }, 283 { TTYC_KUP4, NULL, KEYC_UP|KEYC_SHIFT|KEYC_ESCAPE, 0 }, 284 { TTYC_KUP5, NULL, KEYC_UP|KEYC_CTRL, 0 }, 285 { TTYC_KUP6, NULL, KEYC_UP|KEYC_SHIFT|KEYC_CTRL, 0 }, 286 { TTYC_KUP7, NULL, KEYC_UP|KEYC_ESCAPE|KEYC_CTRL, 0 }, 287 }; 288 289 void 290 tty_keys_add(struct tty *tty, const char *s, int key) 291 { 292 struct tty_key *tk; 293 size_t size; 294 const char *keystr; 295 296 keystr = key_string_lookup_key(key); 297 if ((tk = tty_keys_find(tty, s, strlen(s), &size)) == NULL) { 298 log_debug("new key %s: 0x%x (%s)", s, key, keystr); 299 tty_keys_add1(&tty->key_tree, s, key); 300 } else { 301 log_debug("replacing key %s: 0x%x (%s)", s, key, keystr); 302 tk->key = key; 303 } 304 } 305 306 /* Add next node to the tree. */ 307 void 308 tty_keys_add1(struct tty_key **tkp, const char *s, int key) 309 { 310 struct tty_key *tk; 311 312 /* Allocate a tree entry if there isn't one already. */ 313 tk = *tkp; 314 if (tk == NULL) { 315 tk = *tkp = xcalloc(1, sizeof *tk); 316 tk->ch = *s; 317 tk->key = KEYC_NONE; 318 } 319 320 /* Find the next entry. */ 321 if (*s == tk->ch) { 322 /* Move forward in string. */ 323 s++; 324 325 /* If this is the end of the string, no more is necessary. */ 326 if (*s == '\0') { 327 tk->key = key; 328 return; 329 } 330 331 /* Use the child tree for the next character. */ 332 tkp = &tk->next; 333 } else { 334 if (*s < tk->ch) 335 tkp = &tk->left; 336 else if (*s > tk->ch) 337 tkp = &tk->right; 338 } 339 340 /* And recurse to add it. */ 341 tty_keys_add1(tkp, s, key); 342 } 343 344 /* Initialise a key tree from the table. */ 345 void 346 tty_keys_init(struct tty *tty) 347 { 348 const struct tty_key_ent *tke; 349 u_int i; 350 const char *s; 351 352 tty->key_tree = NULL; 353 for (i = 0; i < nitems(tty_keys); i++) { 354 tke = &tty_keys[i]; 355 356 if (tke->flags & TTYKEY_RAW) 357 s = tke->string; 358 else { 359 if (!tty_term_has(tty->term, tke->code)) 360 continue; 361 s = tty_term_string(tty->term, tke->code); 362 } 363 if (s[0] != '\033' || s[1] == '\0') 364 continue; 365 366 tty_keys_add(tty, s + 1, tke->key); 367 } 368 } 369 370 /* Free the entire key tree. */ 371 void 372 tty_keys_free(struct tty *tty) 373 { 374 tty_keys_free1(tty->key_tree); 375 } 376 377 /* Free a single key. */ 378 void 379 tty_keys_free1(struct tty_key *tk) 380 { 381 if (tk->next != NULL) 382 tty_keys_free1(tk->next); 383 if (tk->left != NULL) 384 tty_keys_free1(tk->left); 385 if (tk->right != NULL) 386 tty_keys_free1(tk->right); 387 free(tk); 388 } 389 390 /* Lookup a key in the tree. */ 391 struct tty_key * 392 tty_keys_find(struct tty *tty, const char *buf, size_t len, size_t *size) 393 { 394 *size = 0; 395 return (tty_keys_find1(tty->key_tree, buf, len, size)); 396 } 397 398 /* Find the next node. */ 399 struct tty_key * 400 tty_keys_find1(struct tty_key *tk, const char *buf, size_t len, size_t *size) 401 { 402 /* If the node is NULL, this is the end of the tree. No match. */ 403 if (tk == NULL) 404 return (NULL); 405 406 /* Pick the next in the sequence. */ 407 if (tk->ch == *buf) { 408 /* Move forward in the string. */ 409 buf++; len--; 410 (*size)++; 411 412 /* At the end of the string, return the current node. */ 413 if (len == 0 || (tk->next == NULL && tk->key != KEYC_NONE)) 414 return (tk); 415 416 /* Move into the next tree for the following character. */ 417 tk = tk->next; 418 } else { 419 if (*buf < tk->ch) 420 tk = tk->left; 421 else if (*buf > tk->ch) 422 tk = tk->right; 423 } 424 425 /* Move to the next in the tree. */ 426 return (tty_keys_find1(tk, buf, len, size)); 427 } 428 429 /* 430 * Process at least one key in the buffer and invoke tty->key_callback. Return 431 * 0 if there are no further keys, or 1 if there could be more in the buffer. 432 */ 433 int 434 tty_keys_next(struct tty *tty) 435 { 436 struct tty_key *tk; 437 struct timeval tv; 438 const char *buf; 439 size_t len, size; 440 cc_t bspace; 441 int key, delay; 442 443 buf = EVBUFFER_DATA(tty->event->input); 444 len = EVBUFFER_LENGTH(tty->event->input); 445 if (len == 0) 446 return (0); 447 log_debug("keys are %zu (%.*s)", len, (int) len, buf); 448 449 /* If a normal key, return it. */ 450 if (*buf != '\033') { 451 key = (u_char) *buf; 452 evbuffer_drain(tty->event->input, 1); 453 454 /* 455 * Check for backspace key using termios VERASE - the terminfo 456 * kbs entry is extremely unreliable, so cannot be safely 457 * used. termios should have a better idea. 458 */ 459 bspace = tty->tio.c_cc[VERASE]; 460 if (bspace != _POSIX_VDISABLE && key == bspace) 461 key = KEYC_BSPACE; 462 goto handle_key; 463 } 464 465 /* Is this device attributes response? */ 466 switch (tty_keys_device(tty, buf, len, &size)) { 467 case 0: /* yes */ 468 evbuffer_drain(tty->event->input, size); 469 key = KEYC_NONE; 470 goto handle_key; 471 case -1: /* no, or not valid */ 472 break; 473 case 1: /* partial */ 474 goto partial_key; 475 } 476 477 /* Is this a mouse key press? */ 478 switch (tty_keys_mouse(tty, buf, len, &size)) { 479 case 0: /* yes */ 480 evbuffer_drain(tty->event->input, size); 481 key = KEYC_MOUSE; 482 goto handle_key; 483 case -1: /* no, or not valid */ 484 break; 485 case 1: /* partial */ 486 goto partial_key; 487 } 488 489 /* Try to parse a key with an xterm-style modifier. */ 490 switch (xterm_keys_find(buf, len, &size, &key)) { 491 case 0: /* found */ 492 evbuffer_drain(tty->event->input, size); 493 goto handle_key; 494 case -1: /* not found */ 495 break; 496 case 1: 497 goto partial_key; 498 } 499 500 /* Look for matching key string and return if found. */ 501 tk = tty_keys_find(tty, buf + 1, len - 1, &size); 502 if (tk != NULL) { 503 key = tk->key; 504 goto found_key; 505 } 506 507 /* Skip the escape. */ 508 buf++; 509 len--; 510 511 /* Is there a normal key following? */ 512 if (len != 0 && *buf != '\033') { 513 key = *buf | KEYC_ESCAPE; 514 evbuffer_drain(tty->event->input, 2); 515 goto handle_key; 516 } 517 518 /* Or a key string? */ 519 if (len > 1) { 520 tk = tty_keys_find(tty, buf + 1, len - 1, &size); 521 if (tk != NULL) { 522 key = tk->key | KEYC_ESCAPE; 523 size++; /* include escape */ 524 goto found_key; 525 } 526 } 527 528 /* Escape and then nothing useful - fall through. */ 529 530 partial_key: 531 /* 532 * Escape but no key string. If have already seen an escape and the 533 * timer has expired, give up waiting and send the escape. 534 */ 535 if ((tty->flags & TTY_ESCAPE) && 536 !evtimer_pending(&tty->key_timer, NULL)) { 537 evbuffer_drain(tty->event->input, 1); 538 key = '\033'; 539 goto handle_key; 540 } 541 542 /* Fall through to start the timer. */ 543 544 start_timer: 545 /* If already waiting for timer, do nothing. */ 546 if (evtimer_pending(&tty->key_timer, NULL)) 547 return (0); 548 549 /* Start the timer and wait for expiry or more data. */ 550 delay = options_get_number(&global_options, "escape-time"); 551 tv.tv_sec = delay / 1000; 552 tv.tv_usec = (delay % 1000) * 1000L; 553 554 if (event_initialized(&tty->key_timer)) 555 evtimer_del(&tty->key_timer); 556 evtimer_set(&tty->key_timer, tty_keys_callback, tty); 557 evtimer_add(&tty->key_timer, &tv); 558 559 tty->flags |= TTY_ESCAPE; 560 return (0); 561 562 found_key: 563 if (tk->next != NULL) { 564 /* Partial key. Start the timer if not already expired. */ 565 if (!(tty->flags & TTY_ESCAPE)) 566 goto start_timer; 567 568 /* Otherwise, if no key, send the escape alone. */ 569 if (tk->key == KEYC_NONE) 570 goto partial_key; 571 572 /* Or fall through to send the partial key found. */ 573 } 574 evbuffer_drain(tty->event->input, size + 1); 575 576 goto handle_key; 577 578 handle_key: 579 if (event_initialized(&tty->key_timer)) 580 evtimer_del(&tty->key_timer); 581 582 if (key != KEYC_NONE) 583 server_client_handle_key(tty->client, key); 584 585 tty->flags &= ~TTY_ESCAPE; 586 return (1); 587 } 588 589 /* Key timer callback. */ 590 /* ARGSUSED */ 591 void 592 tty_keys_callback(unused int fd, unused short events, void *data) 593 { 594 struct tty *tty = data; 595 596 if (!(tty->flags & TTY_ESCAPE)) 597 return; 598 599 while (tty_keys_next(tty)) 600 ; 601 } 602 603 /* 604 * Handle mouse key input. Returns 0 for success, -1 for failure, 1 for partial 605 * (probably a mouse sequence but need more data). 606 */ 607 int 608 tty_keys_mouse(struct tty *tty, const char *buf, size_t len, size_t *size) 609 { 610 struct mouse_event *m = &tty->mouse; 611 struct utf8_data utf8data; 612 u_int i, value; 613 614 /* 615 * Standard mouse sequences are \033[M followed by three characters 616 * indicating buttons, X and Y, all based at 32 with 1,1 top-left. 617 * 618 * UTF-8 mouse sequences are similar but the three are expressed as 619 * UTF-8 characters. 620 */ 621 622 *size = 0; 623 624 /* First three bytes are always \033[M. */ 625 if (buf[0] != '\033') 626 return (-1); 627 if (len == 1) 628 return (1); 629 if (buf[1] != '[') 630 return (-1); 631 if (len == 2) 632 return (1); 633 if (buf[2] != 'M') 634 return (-1); 635 if (len == 3) 636 return (1); 637 638 /* Read the three inputs. */ 639 *size = 3; 640 for (i = 0; i < 3; i++) { 641 if (len < *size) 642 return (1); 643 644 if (tty->mode & MODE_MOUSE_UTF8) { 645 if (utf8_open(&utf8data, buf[*size])) { 646 if (utf8data.size != 2) 647 return (-1); 648 (*size)++; 649 if (len < *size) 650 return (1); 651 utf8_append(&utf8data, buf[*size]); 652 value = utf8_combine(&utf8data); 653 } else 654 value = (unsigned char)buf[*size]; 655 (*size)++; 656 } else { 657 value = (unsigned char)buf[*size]; 658 (*size)++; 659 } 660 661 if (i == 0) 662 m->b = value; 663 else if (i == 1) 664 m->x = value; 665 else 666 m->y = value; 667 } 668 log_debug("mouse input: %.*s", (int) *size, buf); 669 670 /* Check and return the mouse input. */ 671 if (m->b < 32 || m->x < 33 || m->y < 33) 672 return (-1); 673 m->b -= 32; 674 m->x -= 33; 675 m->y -= 33; 676 log_debug("mouse position: x=%u y=%u b=%u", m->x, m->y, m->b); 677 return (0); 678 } 679 680 /* 681 * Handle device attributes input. Returns 0 for success, -1 for failure, 1 for 682 * partial. 683 */ 684 int 685 tty_keys_device(struct tty *tty, const char *buf, size_t len, size_t *size) 686 { 687 u_int i, a, b; 688 char tmp[64], *endptr; 689 690 /* 691 * Primary device attributes are \033[?a;b and secondary are 692 * \033[>a;b;c. We only request attributes on xterm, so we only care 693 * about the middle values which is the xterm version. 694 */ 695 696 *size = 0; 697 698 /* First three bytes are always \033[>. */ 699 if (buf[0] != '\033') 700 return (-1); 701 if (len == 1) 702 return (1); 703 if (buf[1] != '[') 704 return (-1); 705 if (len == 2) 706 return (1); 707 if (buf[2] != '>' && buf[2] != '?') 708 return (-1); 709 if (len == 3) 710 return (1); 711 712 /* Copy the rest up to a 'c'. */ 713 for (i = 0; i < (sizeof tmp) - 1 && buf[3 + i] != 'c'; i++) { 714 if (3 + i == len) 715 return (1); 716 tmp[i] = buf[3 + i]; 717 } 718 if (i == (sizeof tmp) - 1) 719 return (-1); 720 tmp[i] = '\0'; 721 *size = 4 + i; 722 723 /* Only secondary is of interest. */ 724 if (buf[2] != '>') 725 return (0); 726 727 /* Convert version numbers. */ 728 a = strtoul(tmp, &endptr, 10); 729 if (*endptr == ';') { 730 b = strtoul(endptr + 1, &endptr, 10); 731 if (*endptr != '\0' && *endptr != ';') 732 b = 0; 733 } else 734 a = b = 0; 735 736 log_debug("received xterm version %u", b); 737 tty_set_version(tty, b); 738 739 return (0); 740 } 741