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