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