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