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