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