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