Annotation of src/usr.bin/tmux/tty-keys.c, Revision 1.13
1.13 ! nicm 1: /* $OpenBSD: tty-keys.c,v 1.12 2009/10/26 17:59:46 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:
22: #include <string.h>
1.3 nicm 23: #include <termios.h>
24: #include <unistd.h>
1.1 nicm 25:
26: #include "tmux.h"
27:
1.9 nicm 28: /*
29: * Handle keys input from the outside terminal.
30: */
31:
1.1 nicm 32: void tty_keys_add(struct tty *, const char *, int, int);
1.6 nicm 33: int tty_keys_mouse(char *, size_t, size_t *, struct mouse_event *);
1.1 nicm 34:
35: struct tty_key_ent {
36: enum tty_code_code code;
37: const char *string;
38:
39: int key;
40: int flags;
41: };
42:
43: struct tty_key_ent tty_keys[] = {
44: /* Function keys. */
1.8 nicm 45: { TTYC_KF1, NULL, KEYC_F1, TTYKEY_CTRL },
46: { TTYC_KF1, NULL, KEYC_F1, TTYKEY_CTRL },
47: { TTYC_KF2, NULL, KEYC_F2, TTYKEY_CTRL },
48: { TTYC_KF3, NULL, KEYC_F3, TTYKEY_CTRL },
49: { TTYC_KF4, NULL, KEYC_F4, TTYKEY_CTRL },
50: { TTYC_KF5, NULL, KEYC_F5, TTYKEY_CTRL },
51: { TTYC_KF6, NULL, KEYC_F6, TTYKEY_CTRL },
52: { TTYC_KF7, NULL, KEYC_F7, TTYKEY_CTRL },
53: { TTYC_KF8, NULL, KEYC_F8, TTYKEY_CTRL },
54: { TTYC_KF9, NULL, KEYC_F9, TTYKEY_CTRL },
55: { TTYC_KF10, NULL, KEYC_F10, TTYKEY_CTRL },
56: { TTYC_KF11, NULL, KEYC_F11, TTYKEY_CTRL },
57: { TTYC_KF12, NULL, KEYC_F12, TTYKEY_CTRL },
58: { TTYC_KF13, NULL, KEYC_F13, TTYKEY_CTRL },
59: { TTYC_KF14, NULL, KEYC_F14, TTYKEY_CTRL },
60: { TTYC_KF15, NULL, KEYC_F15, TTYKEY_CTRL },
61: { TTYC_KF16, NULL, KEYC_F16, TTYKEY_CTRL },
62: { TTYC_KF17, NULL, KEYC_F17, TTYKEY_CTRL },
63: { TTYC_KF18, NULL, KEYC_F18, TTYKEY_CTRL },
64: { TTYC_KF19, NULL, KEYC_F19, TTYKEY_CTRL },
65: { TTYC_KF20, NULL, KEYC_F20, TTYKEY_CTRL },
66: { TTYC_KICH1, NULL, KEYC_IC, TTYKEY_CTRL },
67: { TTYC_KDCH1, NULL, KEYC_DC, TTYKEY_CTRL },
68: { TTYC_KHOME, NULL, KEYC_HOME, TTYKEY_CTRL },
69: { TTYC_KEND, NULL, KEYC_END, TTYKEY_CTRL },
70: { TTYC_KNP, NULL, KEYC_NPAGE, TTYKEY_CTRL },
71: { TTYC_KPP, NULL, KEYC_PPAGE, TTYKEY_CTRL },
72: { TTYC_KCBT, NULL, KEYC_BTAB, TTYKEY_CTRL },
1.1 nicm 73:
1.12 nicm 74: /* Arrow keys. */
1.8 nicm 75: { 0, "\033OA", KEYC_UP, TTYKEY_RAW },
76: { 0, "\033OB", KEYC_DOWN, TTYKEY_RAW },
77: { 0, "\033OC", KEYC_RIGHT, TTYKEY_RAW },
78: { 0, "\033OD", KEYC_LEFT, TTYKEY_RAW },
79:
1.12 nicm 80: { 0, "\033[A", KEYC_UP, TTYKEY_RAW },
81: { 0, "\033[B", KEYC_DOWN, TTYKEY_RAW },
82: { 0, "\033[C", KEYC_RIGHT, TTYKEY_RAW },
83: { 0, "\033[D", KEYC_LEFT, TTYKEY_RAW },
1.8 nicm 84:
1.12 nicm 85: { TTYC_KCUU1, NULL, KEYC_UP, TTYKEY_CTRL },
86: { TTYC_KCUD1, NULL, KEYC_DOWN, TTYKEY_CTRL },
87: { TTYC_KCUB1, NULL, KEYC_LEFT, TTYKEY_CTRL },
88: { TTYC_KCUF1, NULL, KEYC_RIGHT, TTYKEY_CTRL },
89:
90: /* Special-case arrow keys for rxvt until terminfo has kRIT5 etc. */
1.8 nicm 91: { 0, "\033Oa", KEYC_UP|KEYC_CTRL, TTYKEY_RAW },
92: { 0, "\033Ob", KEYC_DOWN|KEYC_CTRL, TTYKEY_RAW },
93: { 0, "\033Oc", KEYC_RIGHT|KEYC_CTRL, TTYKEY_RAW },
94: { 0, "\033Od", KEYC_LEFT|KEYC_CTRL, TTYKEY_RAW },
1.9 nicm 95:
1.8 nicm 96: { 0, "\033[a", KEYC_UP|KEYC_SHIFT, TTYKEY_RAW },
97: { 0, "\033[b", KEYC_DOWN|KEYC_SHIFT, TTYKEY_RAW },
98: { 0, "\033[c", KEYC_RIGHT|KEYC_SHIFT, TTYKEY_RAW },
99: { 0, "\033[d", KEYC_LEFT|KEYC_SHIFT, TTYKEY_RAW },
1.1 nicm 100:
101: /*
1.8 nicm 102: * Numeric keypad. Just use the vt100 escape sequences here and always
103: * put the terminal into keypad_xmit mode. Translation of numbers
104: * mode/applications mode is done in input-keys.c.
1.1 nicm 105: */
1.8 nicm 106: { 0, "\033Oo", KEYC_KP_SLASH, TTYKEY_RAW },
107: { 0, "\033Oj", KEYC_KP_STAR, TTYKEY_RAW },
108: { 0, "\033Om", KEYC_KP_MINUS, TTYKEY_RAW },
109: { 0, "\033Ow", KEYC_KP_SEVEN, TTYKEY_RAW },
110: { 0, "\033Ox", KEYC_KP_EIGHT, TTYKEY_RAW },
111: { 0, "\033Oy", KEYC_KP_NINE, TTYKEY_RAW },
112: { 0, "\033Ok", KEYC_KP_PLUS, TTYKEY_RAW },
113: { 0, "\033Ot", KEYC_KP_FOUR, TTYKEY_RAW },
114: { 0, "\033Ou", KEYC_KP_FIVE, TTYKEY_RAW },
115: { 0, "\033Ov", KEYC_KP_SIX, TTYKEY_RAW },
116: { 0, "\033Oq", KEYC_KP_ONE, TTYKEY_RAW },
117: { 0, "\033Or", KEYC_KP_TWO, TTYKEY_RAW },
118: { 0, "\033Os", KEYC_KP_THREE, TTYKEY_RAW },
119: { 0, "\033OM", KEYC_KP_ENTER, TTYKEY_RAW },
120: { 0, "\033Op", KEYC_KP_ZERO, TTYKEY_RAW },
121: { 0, "\033On", KEYC_KP_PERIOD, TTYKEY_RAW },
1.10 nicm 122:
123: /* Key and modifier capabilities. */
124: { TTYC_KDC2, NULL, KEYC_DC|KEYC_SHIFT, 0 },
125: { TTYC_KDC3, NULL, KEYC_DC|KEYC_ESCAPE, 0 },
126: { TTYC_KDC4, NULL, KEYC_DC|KEYC_SHIFT|KEYC_ESCAPE, 0 },
127: { TTYC_KDC5, NULL, KEYC_DC|KEYC_CTRL, 0 },
128: { TTYC_KDC6, NULL, KEYC_DC|KEYC_SHIFT|KEYC_CTRL, 0 },
129: { TTYC_KDC7, NULL, KEYC_DC|KEYC_ESCAPE|KEYC_CTRL, 0 },
130: { TTYC_KDN2, NULL, KEYC_DOWN|KEYC_SHIFT, 0 },
131: { TTYC_KDN3, NULL, KEYC_DOWN|KEYC_ESCAPE, 0 },
132: { TTYC_KDN4, NULL, KEYC_DOWN|KEYC_SHIFT|KEYC_ESCAPE, 0 },
133: { TTYC_KDN5, NULL, KEYC_DOWN|KEYC_CTRL, 0 },
134: { TTYC_KDN6, NULL, KEYC_DOWN|KEYC_SHIFT|KEYC_CTRL, 0 },
135: { TTYC_KDN7, NULL, KEYC_DOWN|KEYC_ESCAPE|KEYC_CTRL, 0 },
136: { TTYC_KEND2, NULL, KEYC_END|KEYC_SHIFT, 0 },
137: { TTYC_KEND3, NULL, KEYC_END|KEYC_ESCAPE, 0 },
138: { TTYC_KEND4, NULL, KEYC_END|KEYC_SHIFT|KEYC_ESCAPE, 0 },
139: { TTYC_KEND5, NULL, KEYC_END|KEYC_CTRL, 0 },
140: { TTYC_KEND6, NULL, KEYC_END|KEYC_SHIFT|KEYC_CTRL, 0 },
141: { TTYC_KEND7, NULL, KEYC_END|KEYC_ESCAPE|KEYC_CTRL, 0 },
142: { TTYC_KHOM2, NULL, KEYC_HOME|KEYC_SHIFT, 0 },
143: { TTYC_KHOM3, NULL, KEYC_HOME|KEYC_ESCAPE, 0 },
144: { TTYC_KHOM4, NULL, KEYC_HOME|KEYC_SHIFT|KEYC_ESCAPE, 0 },
145: { TTYC_KHOM5, NULL, KEYC_HOME|KEYC_CTRL, 0 },
146: { TTYC_KHOM6, NULL, KEYC_HOME|KEYC_SHIFT|KEYC_CTRL, 0 },
147: { TTYC_KHOM7, NULL, KEYC_HOME|KEYC_ESCAPE|KEYC_CTRL, 0 },
148: { TTYC_KIC2, NULL, KEYC_IC|KEYC_SHIFT, 0 },
149: { TTYC_KIC3, NULL, KEYC_IC|KEYC_ESCAPE, 0 },
150: { TTYC_KIC4, NULL, KEYC_IC|KEYC_SHIFT|KEYC_ESCAPE, 0 },
151: { TTYC_KIC5, NULL, KEYC_IC|KEYC_CTRL, 0 },
152: { TTYC_KIC6, NULL, KEYC_IC|KEYC_SHIFT|KEYC_CTRL, 0 },
153: { TTYC_KIC7, NULL, KEYC_IC|KEYC_ESCAPE|KEYC_CTRL, 0 },
154: { TTYC_KLFT2, NULL, KEYC_LEFT|KEYC_SHIFT, 0 },
155: { TTYC_KLFT3, NULL, KEYC_LEFT|KEYC_ESCAPE, 0 },
156: { TTYC_KLFT4, NULL, KEYC_LEFT|KEYC_SHIFT|KEYC_ESCAPE, 0 },
157: { TTYC_KLFT5, NULL, KEYC_LEFT|KEYC_CTRL, 0 },
158: { TTYC_KLFT6, NULL, KEYC_LEFT|KEYC_SHIFT|KEYC_CTRL, 0 },
159: { TTYC_KLFT7, NULL, KEYC_LEFT|KEYC_ESCAPE|KEYC_CTRL, 0 },
160: { TTYC_KNXT2, NULL, KEYC_NPAGE|KEYC_SHIFT, 0 },
161: { TTYC_KNXT3, NULL, KEYC_NPAGE|KEYC_ESCAPE, 0 },
162: { TTYC_KNXT4, NULL, KEYC_NPAGE|KEYC_SHIFT|KEYC_ESCAPE, 0 },
163: { TTYC_KNXT5, NULL, KEYC_NPAGE|KEYC_CTRL, 0 },
164: { TTYC_KNXT6, NULL, KEYC_NPAGE|KEYC_SHIFT|KEYC_CTRL, 0 },
165: { TTYC_KNXT7, NULL, KEYC_NPAGE|KEYC_ESCAPE|KEYC_CTRL, 0 },
166: { TTYC_KPRV2, NULL, KEYC_PPAGE|KEYC_SHIFT, 0 },
167: { TTYC_KPRV3, NULL, KEYC_PPAGE|KEYC_ESCAPE, 0 },
168: { TTYC_KPRV4, NULL, KEYC_PPAGE|KEYC_SHIFT|KEYC_ESCAPE, 0 },
169: { TTYC_KPRV5, NULL, KEYC_PPAGE|KEYC_CTRL, 0 },
170: { TTYC_KPRV6, NULL, KEYC_PPAGE|KEYC_SHIFT|KEYC_CTRL, 0 },
171: { TTYC_KPRV7, NULL, KEYC_PPAGE|KEYC_ESCAPE|KEYC_CTRL, 0 },
172: { TTYC_KRIT2, NULL, KEYC_RIGHT|KEYC_SHIFT, 0 },
173: { TTYC_KRIT3, NULL, KEYC_RIGHT|KEYC_ESCAPE, 0 },
174: { TTYC_KRIT4, NULL, KEYC_RIGHT|KEYC_SHIFT|KEYC_ESCAPE, 0 },
175: { TTYC_KRIT5, NULL, KEYC_RIGHT|KEYC_CTRL, 0 },
176: { TTYC_KRIT6, NULL, KEYC_RIGHT|KEYC_SHIFT|KEYC_CTRL, 0 },
177: { TTYC_KRIT7, NULL, KEYC_RIGHT|KEYC_ESCAPE|KEYC_CTRL, 0 },
178: { TTYC_KUP2, NULL, KEYC_UP|KEYC_SHIFT, 0 },
179: { TTYC_KUP3, NULL, KEYC_UP|KEYC_ESCAPE, 0 },
180: { TTYC_KUP4, NULL, KEYC_UP|KEYC_SHIFT|KEYC_ESCAPE, 0 },
181: { TTYC_KUP5, NULL, KEYC_UP|KEYC_CTRL, 0 },
182: { TTYC_KUP6, NULL, KEYC_UP|KEYC_SHIFT|KEYC_CTRL, 0 },
183: { TTYC_KUP7, NULL, KEYC_UP|KEYC_ESCAPE|KEYC_CTRL, 0 },
1.1 nicm 184: };
185:
186: RB_GENERATE(tty_keys, tty_key, entry, tty_keys_cmp);
187:
188: struct tty_key *tty_keys_find(struct tty *, char *, size_t, size_t *);
189:
190: int
191: tty_keys_cmp(struct tty_key *k1, struct tty_key *k2)
192: {
193: return (strcmp(k1->string, k2->string));
194: }
195:
196: void
197: tty_keys_add(struct tty *tty, const char *s, int key, int flags)
198: {
199: struct tty_key *tk, *tl;
200:
201: tk = xmalloc(sizeof *tk);
202: tk->string = xstrdup(s);
203: tk->key = key;
204: tk->flags = flags;
205:
206: if ((tl = RB_INSERT(tty_keys, &tty->ktree, tk)) != NULL) {
207: xfree(tk->string);
208: xfree(tk);
209: log_debug("key exists: %s (old %x, new %x)", s, tl->key, key);
210: return;
211: }
212:
213: if (strlen(tk->string) > tty->ksize)
214: tty->ksize = strlen(tk->string);
215: log_debug("new key %x: size now %zu (%s)", key, tty->ksize, tk->string);
216: }
217:
218: void
219: tty_keys_init(struct tty *tty)
220: {
221: struct tty_key_ent *tke;
222: u_int i;
223: const char *s;
224: char tmp[64];
225:
226: RB_INIT(&tty->ktree);
227:
228: tty->ksize = 0;
229: for (i = 0; i < nitems(tty_keys); i++) {
230: tke = &tty_keys[i];
231:
232: if (tke->flags & TTYKEY_RAW)
233: s = tke->string;
234: else {
235: if (!tty_term_has(tty->term, tke->code))
236: continue;
237: s = tty_term_string(tty->term, tke->code);
238: if (s[0] != '\033' || s[1] == '\0')
239: continue;
240: }
241:
242: tty_keys_add(tty, s + 1, tke->key, tke->flags);
243: if (tke->flags & TTYKEY_CTRL) {
244: if (strlcpy(tmp, s, sizeof tmp) >= sizeof tmp)
245: continue;
246: tmp[strlen(tmp) - 1] ^= 0x20;
1.2 nicm 247: tty_keys_add(tty, tmp + 1, tke->key | KEYC_CTRL, 0);
1.1 nicm 248: }
249: }
250: }
251:
252: void
253: tty_keys_free(struct tty *tty)
254: {
255: struct tty_key *tk;
256:
257: while (!RB_EMPTY(&tty->ktree)) {
258: tk = RB_ROOT(&tty->ktree);
259: RB_REMOVE(tty_keys, &tty->ktree, tk);
260: xfree(tk->string);
261: xfree(tk);
262: }
263: }
264:
265: struct tty_key *
266: tty_keys_find(struct tty *tty, char *buf, size_t len, size_t *size)
267: {
268: struct tty_key *tk, tl;
269: char *s;
270:
271: if (len == 0)
272: return (NULL);
273:
274: s = xmalloc(tty->ksize + 1);
275: for (*size = tty->ksize; (*size) > 0; (*size)--) {
276: if ((*size) > len)
277: continue;
278: memcpy(s, buf, *size);
279: s[*size] = '\0';
280:
281: log_debug2("looking for key: %s", s);
282:
283: tl.string = s;
284: tk = RB_FIND(tty_keys, &tty->ktree, &tl);
285: if (tk != NULL) {
286: log_debug2("got key: 0x%x", tk->key);
287: xfree(s);
288: return (tk);
289: }
290: }
291: xfree(s);
292:
293: return (NULL);
294: }
295:
296: int
1.5 nicm 297: tty_keys_next(struct tty *tty, int *key, struct mouse_event *mouse)
1.1 nicm 298: {
299: struct tty_key *tk;
300: struct timeval tv;
301: char *buf;
1.13 ! nicm 302: u_char ch;
1.1 nicm 303: size_t len, size;
1.3 nicm 304: cc_t bspace;
1.1 nicm 305:
1.13 ! nicm 306: buf = EVBUFFER_DATA(tty->event->input);
! 307: len = EVBUFFER_LENGTH(tty->event->input);
1.1 nicm 308: if (len == 0)
309: return (1);
310: log_debug("keys are %zu (%.*s)", len, (int) len, buf);
311:
312: /* If a normal key, return it. */
313: if (*buf != '\033') {
1.13 ! nicm 314: bufferevent_read(tty->event, &ch, 1);
! 315: *key = ch;
1.3 nicm 316:
317: /*
318: * Check for backspace key using termios VERASE - the terminfo
319: * kbs entry is extremely unreliable, so cannot be safely
320: * used. termios should have a better idea.
321: */
322: bspace = tty->tio.c_cc[VERASE];
323: if (bspace != _POSIX_VDISABLE && *key == bspace)
324: *key = KEYC_BSPACE;
1.1 nicm 325: goto found;
326: }
327:
328: /* Look for matching key string and return if found. */
329: tk = tty_keys_find(tty, buf + 1, len - 1, &size);
330: if (tk != NULL) {
1.13 ! nicm 331: evbuffer_drain(tty->event->input, size + 1);
1.1 nicm 332: *key = tk->key;
333: goto found;
334: }
335:
336: /* Not found. Is this a mouse key press? */
1.6 nicm 337: *key = tty_keys_mouse(buf, len, &size, mouse);
1.11 nicm 338: if (*key != KEYC_NONE) {
1.13 ! nicm 339: evbuffer_drain(tty->event->input, size);
1.11 nicm 340: goto found;
341: }
342:
343: /* Not found. Try to parse a key with an xterm-style modifier. */
344: *key = xterm_keys_find(buf, len, &size);
1.1 nicm 345: if (*key != KEYC_NONE) {
1.13 ! nicm 346: evbuffer_drain(tty->event->input, size);
1.1 nicm 347: goto found;
348: }
349:
350: /* Escape but no key string. If the timer isn't started, start it. */
351: if (!(tty->flags & TTY_ESCAPE)) {
352: tv.tv_sec = 0;
353: tv.tv_usec = ESCAPE_PERIOD * 1000L;
354: if (gettimeofday(&tty->key_timer, NULL) != 0)
1.4 nicm 355: fatal("gettimeofday failed");
1.1 nicm 356: timeradd(&tty->key_timer, &tv, &tty->key_timer);
357:
358: tty->flags |= TTY_ESCAPE;
359: return (1);
360: }
361:
362: /* Skip the escape. */
363: buf++;
364: len--;
365:
366: /* Is there a normal key following? */
367: if (len != 0 && *buf != '\033') {
1.13 ! nicm 368: evbuffer_drain(tty->event->input, 1);
! 369: bufferevent_read(tty->event, &ch, 1);
! 370: *key = ch | KEYC_ESCAPE;
1.1 nicm 371: goto found;
372: }
373:
374: /* Or a key string? */
375: if (len > 1) {
376: tk = tty_keys_find(tty, buf + 1, len - 1, &size);
377: if (tk != NULL) {
1.13 ! nicm 378: evbuffer_drain(tty->event->input, size + 2);
1.2 nicm 379: *key = tk->key | KEYC_ESCAPE;
1.1 nicm 380: goto found;
381: }
382: }
383:
384: /* If the timer hasn't expired, keep waiting. */
385: if (gettimeofday(&tv, NULL) != 0)
1.4 nicm 386: fatal("gettimeofday failed");
1.1 nicm 387: if (timercmp(&tty->key_timer, &tv, >))
388: return (1);
389:
390: /* Give up and return the escape. */
1.13 ! nicm 391: evbuffer_drain(tty->event->input, 1);
1.1 nicm 392: *key = '\033';
393:
394: found:
395: tty->flags &= ~TTY_ESCAPE;
396: return (0);
397: }
398:
399: int
1.6 nicm 400: tty_keys_mouse(char *buf, size_t len, size_t *size, struct mouse_event *m)
1.1 nicm 401: {
402: /*
403: * Mouse sequences are \033[M followed by three characters indicating
404: * buttons, X and Y, all based at 32 with 1,1 top-left.
405: */
406:
407: log_debug("mouse input is: %.*s", (int) len, buf);
408: if (len != 6 || memcmp(buf, "\033[M", 3) != 0)
409: return (KEYC_NONE);
410: *size = 6;
411:
1.5 nicm 412: m->b = buf[3];
413: m->x = buf[4];
414: m->y = buf[5];
415: if (m->b < 32 || m->x < 33 || m->y < 33)
1.1 nicm 416: return (KEYC_NONE);
1.5 nicm 417: m->b -= 32;
418: m->x -= 33;
419: m->y -= 33;
1.1 nicm 420: return (KEYC_MOUSE);
421: }
![[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