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