Annotation of src/usr.bin/tmux/tty-keys.c, Revision 1.155
1.155 ! nicm 1: /* $OpenBSD: tty-keys.c,v 1.154 2022/03/08 12:01:19 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.104 nicm 22: #include <netinet/in.h>
23:
1.133 nicm 24: #include <ctype.h>
1.35 nicm 25: #include <limits.h>
1.104 nicm 26: #include <resolv.h>
1.35 nicm 27: #include <stdlib.h>
1.1 nicm 28: #include <string.h>
1.3 nicm 29: #include <termios.h>
30: #include <unistd.h>
1.1 nicm 31:
32: #include "tmux.h"
33:
1.9 nicm 34: /*
1.50 nicm 35: * Handle keys input from the outside terminal. tty_default_*_keys[] are a base
36: * table of supported keys which are looked up in terminfo(5) and translated
37: * into a ternary tree.
1.9 nicm 38: */
39:
1.86 nicm 40: static void tty_keys_add1(struct tty_key **, const char *, key_code);
41: static void tty_keys_add(struct tty *, const char *, key_code);
42: static void tty_keys_free1(struct tty_key *);
43: static struct tty_key *tty_keys_find1(struct tty_key *, const char *, size_t,
1.76 nicm 44: size_t *);
1.86 nicm 45: static struct tty_key *tty_keys_find(struct tty *, const char *, size_t,
46: size_t *);
47: static int tty_keys_next1(struct tty *, const char *, size_t, key_code *,
1.87 nicm 48: size_t *, int);
1.86 nicm 49: static void tty_keys_callback(int, short, void *);
1.133 nicm 50: static int tty_keys_extended_key(struct tty *, const char *, size_t,
51: size_t *, key_code *);
1.111 nicm 52: static int tty_keys_mouse(struct tty *, const char *, size_t, size_t *,
53: struct mouse_event *);
1.104 nicm 54: static int tty_keys_clipboard(struct tty *, const char *, size_t,
55: size_t *);
1.91 nicm 56: static int tty_keys_device_attributes(struct tty *, const char *, size_t,
57: size_t *);
1.128 nicm 58: static int tty_keys_extended_device_attributes(struct tty *, const char *,
1.119 nicm 59: size_t, size_t *);
1.150 nicm 60:
61: /* A key tree entry. */
62: struct tty_key {
63: char ch;
64: key_code key;
65:
66: struct tty_key *left;
67: struct tty_key *right;
68:
69: struct tty_key *next;
70: };
1.1 nicm 71:
1.48 nicm 72: /* Default raw keys. */
73: struct tty_default_key_raw {
1.1 nicm 74: const char *string;
1.143 nicm 75: key_code key;
1.1 nicm 76: };
1.90 nicm 77: static const struct tty_default_key_raw tty_default_raw_keys[] = {
1.125 nicm 78: /* Application escape. */
79: { "\033O[", '\033' },
80:
1.1 nicm 81: /*
1.8 nicm 82: * Numeric keypad. Just use the vt100 escape sequences here and always
83: * put the terminal into keypad_xmit mode. Translation of numbers
84: * mode/applications mode is done in input-keys.c.
1.1 nicm 85: */
1.132 nicm 86: { "\033Oo", KEYC_KP_SLASH|KEYC_KEYPAD },
87: { "\033Oj", KEYC_KP_STAR|KEYC_KEYPAD },
88: { "\033Om", KEYC_KP_MINUS|KEYC_KEYPAD },
89: { "\033Ow", KEYC_KP_SEVEN|KEYC_KEYPAD },
90: { "\033Ox", KEYC_KP_EIGHT|KEYC_KEYPAD },
91: { "\033Oy", KEYC_KP_NINE|KEYC_KEYPAD },
92: { "\033Ok", KEYC_KP_PLUS|KEYC_KEYPAD },
93: { "\033Ot", KEYC_KP_FOUR|KEYC_KEYPAD },
94: { "\033Ou", KEYC_KP_FIVE|KEYC_KEYPAD },
95: { "\033Ov", KEYC_KP_SIX|KEYC_KEYPAD },
96: { "\033Oq", KEYC_KP_ONE|KEYC_KEYPAD },
97: { "\033Or", KEYC_KP_TWO|KEYC_KEYPAD },
98: { "\033Os", KEYC_KP_THREE|KEYC_KEYPAD },
99: { "\033OM", KEYC_KP_ENTER|KEYC_KEYPAD },
100: { "\033Op", KEYC_KP_ZERO|KEYC_KEYPAD },
101: { "\033On", KEYC_KP_PERIOD|KEYC_KEYPAD },
1.10 nicm 102:
1.29 nicm 103: /* Arrow keys. */
1.132 nicm 104: { "\033OA", KEYC_UP|KEYC_CURSOR },
105: { "\033OB", KEYC_DOWN|KEYC_CURSOR },
106: { "\033OC", KEYC_RIGHT|KEYC_CURSOR },
107: { "\033OD", KEYC_LEFT|KEYC_CURSOR },
108:
109: { "\033[A", KEYC_UP|KEYC_CURSOR },
110: { "\033[B", KEYC_DOWN|KEYC_CURSOR },
111: { "\033[C", KEYC_RIGHT|KEYC_CURSOR },
112: { "\033[D", KEYC_LEFT|KEYC_CURSOR },
1.57 nicm 113:
1.142 nicm 114: /*
115: * Meta arrow keys. These do not get the IMPLIED_META flag so they
116: * don't match the xterm-style meta keys in the output tree - Escape+Up
117: * should stay as Escape+Up and not become M-Up.
118: */
119: { "\033\033OA", KEYC_UP|KEYC_CURSOR|KEYC_META },
120: { "\033\033OB", KEYC_DOWN|KEYC_CURSOR|KEYC_META },
121: { "\033\033OC", KEYC_RIGHT|KEYC_CURSOR|KEYC_META },
122: { "\033\033OD", KEYC_LEFT|KEYC_CURSOR|KEYC_META },
123:
124: { "\033\033[A", KEYC_UP|KEYC_CURSOR|KEYC_META },
125: { "\033\033[B", KEYC_DOWN|KEYC_CURSOR|KEYC_META },
126: { "\033\033[C", KEYC_RIGHT|KEYC_CURSOR|KEYC_META },
127: { "\033\033[D", KEYC_LEFT|KEYC_CURSOR|KEYC_META },
1.140 nicm 128:
1.57 nicm 129: /* Other (xterm) "cursor" keys. */
130: { "\033OH", KEYC_HOME },
131: { "\033OF", KEYC_END },
132:
1.140 nicm 133: { "\033\033OH", KEYC_HOME|KEYC_META|KEYC_IMPLIED_META },
134: { "\033\033OF", KEYC_END|KEYC_META|KEYC_IMPLIED_META },
135:
1.57 nicm 136: { "\033[H", KEYC_HOME },
137: { "\033[F", KEYC_END },
1.140 nicm 138:
139: { "\033\033[H", KEYC_HOME|KEYC_META|KEYC_IMPLIED_META },
140: { "\033\033[F", KEYC_END|KEYC_META|KEYC_IMPLIED_META },
1.21 nicm 141:
142: /* rxvt-style arrow + modifier keys. */
1.48 nicm 143: { "\033Oa", KEYC_UP|KEYC_CTRL },
144: { "\033Ob", KEYC_DOWN|KEYC_CTRL },
145: { "\033Oc", KEYC_RIGHT|KEYC_CTRL },
146: { "\033Od", KEYC_LEFT|KEYC_CTRL },
147:
148: { "\033[a", KEYC_UP|KEYC_SHIFT },
149: { "\033[b", KEYC_DOWN|KEYC_SHIFT },
150: { "\033[c", KEYC_RIGHT|KEYC_SHIFT },
151: { "\033[d", KEYC_LEFT|KEYC_SHIFT },
152:
153: /* rxvt-style function + modifier keys (C = ^, S = $, C-S = @). */
154: { "\033[11^", KEYC_F1|KEYC_CTRL },
155: { "\033[12^", KEYC_F2|KEYC_CTRL },
156: { "\033[13^", KEYC_F3|KEYC_CTRL },
157: { "\033[14^", KEYC_F4|KEYC_CTRL },
158: { "\033[15^", KEYC_F5|KEYC_CTRL },
159: { "\033[17^", KEYC_F6|KEYC_CTRL },
160: { "\033[18^", KEYC_F7|KEYC_CTRL },
161: { "\033[19^", KEYC_F8|KEYC_CTRL },
162: { "\033[20^", KEYC_F9|KEYC_CTRL },
163: { "\033[21^", KEYC_F10|KEYC_CTRL },
164: { "\033[23^", KEYC_F11|KEYC_CTRL },
165: { "\033[24^", KEYC_F12|KEYC_CTRL },
166: { "\033[2^", KEYC_IC|KEYC_CTRL },
167: { "\033[3^", KEYC_DC|KEYC_CTRL },
168: { "\033[7^", KEYC_HOME|KEYC_CTRL },
169: { "\033[8^", KEYC_END|KEYC_CTRL },
170: { "\033[6^", KEYC_NPAGE|KEYC_CTRL },
171: { "\033[5^", KEYC_PPAGE|KEYC_CTRL },
172:
173: { "\033[11$", KEYC_F1|KEYC_SHIFT },
174: { "\033[12$", KEYC_F2|KEYC_SHIFT },
175: { "\033[13$", KEYC_F3|KEYC_SHIFT },
176: { "\033[14$", KEYC_F4|KEYC_SHIFT },
177: { "\033[15$", KEYC_F5|KEYC_SHIFT },
178: { "\033[17$", KEYC_F6|KEYC_SHIFT },
179: { "\033[18$", KEYC_F7|KEYC_SHIFT },
180: { "\033[19$", KEYC_F8|KEYC_SHIFT },
181: { "\033[20$", KEYC_F9|KEYC_SHIFT },
182: { "\033[21$", KEYC_F10|KEYC_SHIFT },
183: { "\033[23$", KEYC_F11|KEYC_SHIFT },
184: { "\033[24$", KEYC_F12|KEYC_SHIFT },
185: { "\033[2$", KEYC_IC|KEYC_SHIFT },
186: { "\033[3$", KEYC_DC|KEYC_SHIFT },
187: { "\033[7$", KEYC_HOME|KEYC_SHIFT },
188: { "\033[8$", KEYC_END|KEYC_SHIFT },
189: { "\033[6$", KEYC_NPAGE|KEYC_SHIFT },
190: { "\033[5$", KEYC_PPAGE|KEYC_SHIFT },
191:
192: { "\033[11@", KEYC_F1|KEYC_CTRL|KEYC_SHIFT },
193: { "\033[12@", KEYC_F2|KEYC_CTRL|KEYC_SHIFT },
194: { "\033[13@", KEYC_F3|KEYC_CTRL|KEYC_SHIFT },
195: { "\033[14@", KEYC_F4|KEYC_CTRL|KEYC_SHIFT },
196: { "\033[15@", KEYC_F5|KEYC_CTRL|KEYC_SHIFT },
197: { "\033[17@", KEYC_F6|KEYC_CTRL|KEYC_SHIFT },
198: { "\033[18@", KEYC_F7|KEYC_CTRL|KEYC_SHIFT },
199: { "\033[19@", KEYC_F8|KEYC_CTRL|KEYC_SHIFT },
200: { "\033[20@", KEYC_F9|KEYC_CTRL|KEYC_SHIFT },
201: { "\033[21@", KEYC_F10|KEYC_CTRL|KEYC_SHIFT },
202: { "\033[23@", KEYC_F11|KEYC_CTRL|KEYC_SHIFT },
203: { "\033[24@", KEYC_F12|KEYC_CTRL|KEYC_SHIFT },
204: { "\033[2@", KEYC_IC|KEYC_CTRL|KEYC_SHIFT },
205: { "\033[3@", KEYC_DC|KEYC_CTRL|KEYC_SHIFT },
206: { "\033[7@", KEYC_HOME|KEYC_CTRL|KEYC_SHIFT },
207: { "\033[8@", KEYC_END|KEYC_CTRL|KEYC_SHIFT },
208: { "\033[6@", KEYC_NPAGE|KEYC_CTRL|KEYC_SHIFT },
209: { "\033[5@", KEYC_PPAGE|KEYC_CTRL|KEYC_SHIFT },
1.56 nicm 210:
211: /* Focus tracking. */
212: { "\033[I", KEYC_FOCUS_IN },
213: { "\033[O", KEYC_FOCUS_OUT },
1.98 nicm 214:
215: /* Paste keys. */
216: { "\033[200~", KEYC_PASTE_START },
217: { "\033[201~", KEYC_PASTE_END },
1.48 nicm 218: };
1.29 nicm 219:
1.132 nicm 220: /* Default xterm keys. */
221: struct tty_default_key_xterm {
222: const char *template;
223: key_code key;
224: };
225: static const struct tty_default_key_xterm tty_default_xterm_keys[] = {
226: { "\033[1;_P", KEYC_F1 },
227: { "\033O1;_P", KEYC_F1 },
228: { "\033O_P", KEYC_F1 },
229: { "\033[1;_Q", KEYC_F2 },
230: { "\033O1;_Q", KEYC_F2 },
231: { "\033O_Q", KEYC_F2 },
232: { "\033[1;_R", KEYC_F3 },
233: { "\033O1;_R", KEYC_F3 },
234: { "\033O_R", KEYC_F3 },
235: { "\033[1;_S", KEYC_F4 },
236: { "\033O1;_S", KEYC_F4 },
237: { "\033O_S", KEYC_F4 },
238: { "\033[15;_~", KEYC_F5 },
239: { "\033[17;_~", KEYC_F6 },
240: { "\033[18;_~", KEYC_F7 },
241: { "\033[19;_~", KEYC_F8 },
242: { "\033[20;_~", KEYC_F9 },
243: { "\033[21;_~", KEYC_F10 },
244: { "\033[23;_~", KEYC_F11 },
245: { "\033[24;_~", KEYC_F12 },
246: { "\033[1;_A", KEYC_UP },
247: { "\033[1;_B", KEYC_DOWN },
248: { "\033[1;_C", KEYC_RIGHT },
249: { "\033[1;_D", KEYC_LEFT },
250: { "\033[1;_H", KEYC_HOME },
251: { "\033[1;_F", KEYC_END },
252: { "\033[5;_~", KEYC_PPAGE },
253: { "\033[6;_~", KEYC_NPAGE },
254: { "\033[2;_~", KEYC_IC },
255: { "\033[3;_~", KEYC_DC },
256: };
257: static const key_code tty_default_xterm_modifiers[] = {
258: 0,
259: 0,
1.135 nicm 260: KEYC_SHIFT,
261: KEYC_META|KEYC_IMPLIED_META,
262: KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META,
263: KEYC_CTRL,
264: KEYC_SHIFT|KEYC_CTRL,
265: KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL,
1.147 nicm 266: KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL,
267: KEYC_META|KEYC_IMPLIED_META
1.132 nicm 268: };
269:
1.103 nicm 270: /*
1.132 nicm 271: * Default terminfo(5) keys. Any keys that have builtin modifiers (that is,
272: * where the key itself contains the modifiers) has the KEYC_XTERM flag set so
273: * a leading escape is not treated as meta (and probably removed).
1.103 nicm 274: */
1.48 nicm 275: struct tty_default_key_code {
276: enum tty_code_code code;
1.143 nicm 277: key_code key;
1.48 nicm 278: };
1.90 nicm 279: static const struct tty_default_key_code tty_default_code_keys[] = {
1.29 nicm 280: /* Function keys. */
1.48 nicm 281: { TTYC_KF1, KEYC_F1 },
282: { TTYC_KF2, KEYC_F2 },
283: { TTYC_KF3, KEYC_F3 },
284: { TTYC_KF4, KEYC_F4 },
285: { TTYC_KF5, KEYC_F5 },
286: { TTYC_KF6, KEYC_F6 },
287: { TTYC_KF7, KEYC_F7 },
288: { TTYC_KF8, KEYC_F8 },
289: { TTYC_KF9, KEYC_F9 },
290: { TTYC_KF10, KEYC_F10 },
291: { TTYC_KF11, KEYC_F11 },
292: { TTYC_KF12, KEYC_F12 },
1.70 nicm 293:
1.135 nicm 294: { TTYC_KF13, KEYC_F1|KEYC_SHIFT },
295: { TTYC_KF14, KEYC_F2|KEYC_SHIFT },
296: { TTYC_KF15, KEYC_F3|KEYC_SHIFT },
297: { TTYC_KF16, KEYC_F4|KEYC_SHIFT },
298: { TTYC_KF17, KEYC_F5|KEYC_SHIFT },
299: { TTYC_KF18, KEYC_F6|KEYC_SHIFT },
300: { TTYC_KF19, KEYC_F7|KEYC_SHIFT },
301: { TTYC_KF20, KEYC_F8|KEYC_SHIFT },
302: { TTYC_KF21, KEYC_F9|KEYC_SHIFT },
303: { TTYC_KF22, KEYC_F10|KEYC_SHIFT },
304: { TTYC_KF23, KEYC_F11|KEYC_SHIFT },
305: { TTYC_KF24, KEYC_F12|KEYC_SHIFT },
306:
307: { TTYC_KF25, KEYC_F1|KEYC_CTRL },
308: { TTYC_KF26, KEYC_F2|KEYC_CTRL },
309: { TTYC_KF27, KEYC_F3|KEYC_CTRL },
310: { TTYC_KF28, KEYC_F4|KEYC_CTRL },
311: { TTYC_KF29, KEYC_F5|KEYC_CTRL },
312: { TTYC_KF30, KEYC_F6|KEYC_CTRL },
313: { TTYC_KF31, KEYC_F7|KEYC_CTRL },
314: { TTYC_KF32, KEYC_F8|KEYC_CTRL },
315: { TTYC_KF33, KEYC_F9|KEYC_CTRL },
316: { TTYC_KF34, KEYC_F10|KEYC_CTRL },
317: { TTYC_KF35, KEYC_F11|KEYC_CTRL },
318: { TTYC_KF36, KEYC_F12|KEYC_CTRL },
319:
320: { TTYC_KF37, KEYC_F1|KEYC_SHIFT|KEYC_CTRL },
321: { TTYC_KF38, KEYC_F2|KEYC_SHIFT|KEYC_CTRL },
322: { TTYC_KF39, KEYC_F3|KEYC_SHIFT|KEYC_CTRL },
323: { TTYC_KF40, KEYC_F4|KEYC_SHIFT|KEYC_CTRL },
324: { TTYC_KF41, KEYC_F5|KEYC_SHIFT|KEYC_CTRL },
325: { TTYC_KF42, KEYC_F6|KEYC_SHIFT|KEYC_CTRL },
326: { TTYC_KF43, KEYC_F7|KEYC_SHIFT|KEYC_CTRL },
327: { TTYC_KF44, KEYC_F8|KEYC_SHIFT|KEYC_CTRL },
328: { TTYC_KF45, KEYC_F9|KEYC_SHIFT|KEYC_CTRL },
329: { TTYC_KF46, KEYC_F10|KEYC_SHIFT|KEYC_CTRL },
330: { TTYC_KF47, KEYC_F11|KEYC_SHIFT|KEYC_CTRL },
331: { TTYC_KF48, KEYC_F12|KEYC_SHIFT|KEYC_CTRL },
332:
333: { TTYC_KF49, KEYC_F1|KEYC_META|KEYC_IMPLIED_META },
334: { TTYC_KF50, KEYC_F2|KEYC_META|KEYC_IMPLIED_META },
335: { TTYC_KF51, KEYC_F3|KEYC_META|KEYC_IMPLIED_META },
336: { TTYC_KF52, KEYC_F4|KEYC_META|KEYC_IMPLIED_META },
337: { TTYC_KF53, KEYC_F5|KEYC_META|KEYC_IMPLIED_META },
338: { TTYC_KF54, KEYC_F6|KEYC_META|KEYC_IMPLIED_META },
339: { TTYC_KF55, KEYC_F7|KEYC_META|KEYC_IMPLIED_META },
340: { TTYC_KF56, KEYC_F8|KEYC_META|KEYC_IMPLIED_META },
341: { TTYC_KF57, KEYC_F9|KEYC_META|KEYC_IMPLIED_META },
342: { TTYC_KF58, KEYC_F10|KEYC_META|KEYC_IMPLIED_META },
343: { TTYC_KF59, KEYC_F11|KEYC_META|KEYC_IMPLIED_META },
344: { TTYC_KF60, KEYC_F12|KEYC_META|KEYC_IMPLIED_META },
345:
346: { TTYC_KF61, KEYC_F1|KEYC_META|KEYC_IMPLIED_META|KEYC_SHIFT },
347: { TTYC_KF62, KEYC_F2|KEYC_META|KEYC_IMPLIED_META|KEYC_SHIFT },
348: { TTYC_KF63, KEYC_F3|KEYC_META|KEYC_IMPLIED_META|KEYC_SHIFT },
1.70 nicm 349:
1.48 nicm 350: { TTYC_KICH1, KEYC_IC },
351: { TTYC_KDCH1, KEYC_DC },
352: { TTYC_KHOME, KEYC_HOME },
353: { TTYC_KEND, KEYC_END },
354: { TTYC_KNP, KEYC_NPAGE },
355: { TTYC_KPP, KEYC_PPAGE },
356: { TTYC_KCBT, KEYC_BTAB },
1.29 nicm 357:
358: /* Arrow keys from terminfo. */
1.132 nicm 359: { TTYC_KCUU1, KEYC_UP|KEYC_CURSOR },
360: { TTYC_KCUD1, KEYC_DOWN|KEYC_CURSOR },
361: { TTYC_KCUB1, KEYC_LEFT|KEYC_CURSOR },
362: { TTYC_KCUF1, KEYC_RIGHT|KEYC_CURSOR },
1.29 nicm 363:
1.103 nicm 364: /* Key and modifier capabilities. */
1.135 nicm 365: { TTYC_KDC2, KEYC_DC|KEYC_SHIFT },
366: { TTYC_KDC3, KEYC_DC|KEYC_META|KEYC_IMPLIED_META },
367: { TTYC_KDC4, KEYC_DC|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
368: { TTYC_KDC5, KEYC_DC|KEYC_CTRL },
369: { TTYC_KDC6, KEYC_DC|KEYC_SHIFT|KEYC_CTRL },
370: { TTYC_KDC7, KEYC_DC|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
371: { TTYC_KIND, KEYC_DOWN|KEYC_SHIFT },
372: { TTYC_KDN2, KEYC_DOWN|KEYC_SHIFT },
373: { TTYC_KDN3, KEYC_DOWN|KEYC_META|KEYC_IMPLIED_META },
374: { TTYC_KDN4, KEYC_DOWN|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
375: { TTYC_KDN5, KEYC_DOWN|KEYC_CTRL },
376: { TTYC_KDN6, KEYC_DOWN|KEYC_SHIFT|KEYC_CTRL },
377: { TTYC_KDN7, KEYC_DOWN|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
378: { TTYC_KEND2, KEYC_END|KEYC_SHIFT },
379: { TTYC_KEND3, KEYC_END|KEYC_META|KEYC_IMPLIED_META },
380: { TTYC_KEND4, KEYC_END|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
381: { TTYC_KEND5, KEYC_END|KEYC_CTRL },
382: { TTYC_KEND6, KEYC_END|KEYC_SHIFT|KEYC_CTRL },
383: { TTYC_KEND7, KEYC_END|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
384: { TTYC_KHOM2, KEYC_HOME|KEYC_SHIFT },
385: { TTYC_KHOM3, KEYC_HOME|KEYC_META|KEYC_IMPLIED_META },
386: { TTYC_KHOM4, KEYC_HOME|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
387: { TTYC_KHOM5, KEYC_HOME|KEYC_CTRL },
388: { TTYC_KHOM6, KEYC_HOME|KEYC_SHIFT|KEYC_CTRL },
389: { TTYC_KHOM7, KEYC_HOME|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
390: { TTYC_KIC2, KEYC_IC|KEYC_SHIFT },
391: { TTYC_KIC3, KEYC_IC|KEYC_META|KEYC_IMPLIED_META },
392: { TTYC_KIC4, KEYC_IC|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
393: { TTYC_KIC5, KEYC_IC|KEYC_CTRL },
394: { TTYC_KIC6, KEYC_IC|KEYC_SHIFT|KEYC_CTRL },
395: { TTYC_KIC7, KEYC_IC|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
396: { TTYC_KLFT2, KEYC_LEFT|KEYC_SHIFT },
397: { TTYC_KLFT3, KEYC_LEFT|KEYC_META|KEYC_IMPLIED_META },
398: { TTYC_KLFT4, KEYC_LEFT|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
399: { TTYC_KLFT5, KEYC_LEFT|KEYC_CTRL },
400: { TTYC_KLFT6, KEYC_LEFT|KEYC_SHIFT|KEYC_CTRL },
401: { TTYC_KLFT7, KEYC_LEFT|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
402: { TTYC_KNXT2, KEYC_NPAGE|KEYC_SHIFT },
403: { TTYC_KNXT3, KEYC_NPAGE|KEYC_META|KEYC_IMPLIED_META },
404: { TTYC_KNXT4, KEYC_NPAGE|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
405: { TTYC_KNXT5, KEYC_NPAGE|KEYC_CTRL },
406: { TTYC_KNXT6, KEYC_NPAGE|KEYC_SHIFT|KEYC_CTRL },
407: { TTYC_KNXT7, KEYC_NPAGE|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
408: { TTYC_KPRV2, KEYC_PPAGE|KEYC_SHIFT },
409: { TTYC_KPRV3, KEYC_PPAGE|KEYC_META|KEYC_IMPLIED_META },
410: { TTYC_KPRV4, KEYC_PPAGE|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
411: { TTYC_KPRV5, KEYC_PPAGE|KEYC_CTRL },
412: { TTYC_KPRV6, KEYC_PPAGE|KEYC_SHIFT|KEYC_CTRL },
413: { TTYC_KPRV7, KEYC_PPAGE|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
414: { TTYC_KRIT2, KEYC_RIGHT|KEYC_SHIFT },
415: { TTYC_KRIT3, KEYC_RIGHT|KEYC_META|KEYC_IMPLIED_META },
416: { TTYC_KRIT4, KEYC_RIGHT|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
417: { TTYC_KRIT5, KEYC_RIGHT|KEYC_CTRL },
418: { TTYC_KRIT6, KEYC_RIGHT|KEYC_SHIFT|KEYC_CTRL },
419: { TTYC_KRIT7, KEYC_RIGHT|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
420: { TTYC_KRI, KEYC_UP|KEYC_SHIFT },
421: { TTYC_KUP2, KEYC_UP|KEYC_SHIFT },
422: { TTYC_KUP3, KEYC_UP|KEYC_META|KEYC_IMPLIED_META },
423: { TTYC_KUP4, KEYC_UP|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
424: { TTYC_KUP5, KEYC_UP|KEYC_CTRL },
425: { TTYC_KUP6, KEYC_UP|KEYC_SHIFT|KEYC_CTRL },
426: { TTYC_KUP7, KEYC_UP|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
1.1 nicm 427: };
428:
1.48 nicm 429: /* Add key to tree. */
1.86 nicm 430: static void
1.76 nicm 431: tty_keys_add(struct tty *tty, const char *s, key_code key)
1.16 nicm 432: {
1.29 nicm 433: struct tty_key *tk;
434: size_t size;
1.143 nicm 435: const char *keystr;
1.1 nicm 436:
1.135 nicm 437: keystr = key_string_lookup_key(key, 1);
1.29 nicm 438: if ((tk = tty_keys_find(tty, s, strlen(s), &size)) == NULL) {
1.76 nicm 439: log_debug("new key %s: 0x%llx (%s)", s, key, keystr);
1.16 nicm 440: tty_keys_add1(&tty->key_tree, s, key);
1.29 nicm 441: } else {
1.76 nicm 442: log_debug("replacing key %s: 0x%llx (%s)", s, key, keystr);
1.29 nicm 443: tk->key = key;
1.16 nicm 444: }
1.1 nicm 445: }
446:
1.16 nicm 447: /* Add next node to the tree. */
1.86 nicm 448: static void
1.76 nicm 449: tty_keys_add1(struct tty_key **tkp, const char *s, key_code key)
1.1 nicm 450: {
1.16 nicm 451: struct tty_key *tk;
1.1 nicm 452:
1.16 nicm 453: /* Allocate a tree entry if there isn't one already. */
454: tk = *tkp;
455: if (tk == NULL) {
456: tk = *tkp = xcalloc(1, sizeof *tk);
457: tk->ch = *s;
1.83 nicm 458: tk->key = KEYC_UNKNOWN;
1.16 nicm 459: }
460:
461: /* Find the next entry. */
462: if (*s == tk->ch) {
463: /* Move forward in string. */
464: s++;
465:
466: /* If this is the end of the string, no more is necessary. */
467: if (*s == '\0') {
468: tk->key = key;
469: return;
470: }
471:
472: /* Use the child tree for the next character. */
473: tkp = &tk->next;
1.27 nicm 474: } else {
1.16 nicm 475: if (*s < tk->ch)
476: tkp = &tk->left;
477: else if (*s > tk->ch)
478: tkp = &tk->right;
479: }
480:
481: /* And recurse to add it. */
482: tty_keys_add1(tkp, s, key);
1.1 nicm 483: }
484:
1.16 nicm 485: /* Initialise a key tree from the table. */
1.1 nicm 486: void
1.48 nicm 487: tty_keys_build(struct tty *tty)
1.1 nicm 488: {
1.48 nicm 489: const struct tty_default_key_raw *tdkr;
1.132 nicm 490: const struct tty_default_key_xterm *tdkx;
1.48 nicm 491: const struct tty_default_key_code *tdkc;
1.143 nicm 492: u_int i, j;
1.109 nicm 493: const char *s;
1.99 nicm 494: struct options_entry *o;
1.107 nicm 495: struct options_array_item *a;
1.109 nicm 496: union options_value *ov;
1.132 nicm 497: char copy[16];
498: key_code key;
1.1 nicm 499:
1.48 nicm 500: if (tty->key_tree != NULL)
1.71 nicm 501: tty_keys_free(tty);
1.16 nicm 502: tty->key_tree = NULL;
1.1 nicm 503:
1.132 nicm 504: for (i = 0; i < nitems(tty_default_xterm_keys); i++) {
505: tdkx = &tty_default_xterm_keys[i];
506: for (j = 2; j < nitems(tty_default_xterm_modifiers); j++) {
507: strlcpy(copy, tdkx->template, sizeof copy);
508: copy[strcspn(copy, "_")] = '0' + j;
509:
510: key = tdkx->key|tty_default_xterm_modifiers[j];
511: tty_keys_add(tty, copy, key);
512: }
513: }
1.48 nicm 514: for (i = 0; i < nitems(tty_default_raw_keys); i++) {
515: tdkr = &tty_default_raw_keys[i];
516:
517: s = tdkr->string;
1.51 nicm 518: if (*s != '\0')
519: tty_keys_add(tty, s, tdkr->key);
1.48 nicm 520: }
521: for (i = 0; i < nitems(tty_default_code_keys); i++) {
522: tdkc = &tty_default_code_keys[i];
523:
524: s = tty_term_string(tty->term, tdkc->code);
1.51 nicm 525: if (*s != '\0')
526: tty_keys_add(tty, s, tdkc->key);
1.1 nicm 527:
1.99 nicm 528: }
529:
530: o = options_get(global_options, "user-keys");
1.107 nicm 531: if (o != NULL) {
532: a = options_array_first(o);
533: while (a != NULL) {
1.112 nicm 534: i = options_array_item_index(a);
1.109 nicm 535: ov = options_array_item_value(a);
1.110 nicm 536: tty_keys_add(tty, ov->string, KEYC_USER + i);
1.107 nicm 537: a = options_array_next(a);
1.99 nicm 538: }
1.1 nicm 539: }
540: }
541:
1.16 nicm 542: /* Free the entire key tree. */
1.1 nicm 543: void
544: tty_keys_free(struct tty *tty)
545: {
1.16 nicm 546: tty_keys_free1(tty->key_tree);
547: }
1.1 nicm 548:
1.16 nicm 549: /* Free a single key. */
1.86 nicm 550: static void
1.16 nicm 551: tty_keys_free1(struct tty_key *tk)
552: {
553: if (tk->next != NULL)
554: tty_keys_free1(tk->next);
555: if (tk->left != NULL)
556: tty_keys_free1(tk->left);
557: if (tk->right != NULL)
558: tty_keys_free1(tk->right);
1.42 nicm 559: free(tk);
1.1 nicm 560: }
561:
1.16 nicm 562: /* Lookup a key in the tree. */
1.86 nicm 563: static struct tty_key *
1.16 nicm 564: tty_keys_find(struct tty *tty, const char *buf, size_t len, size_t *size)
1.1 nicm 565: {
1.16 nicm 566: *size = 0;
567: return (tty_keys_find1(tty->key_tree, buf, len, size));
568: }
1.1 nicm 569:
1.16 nicm 570: /* Find the next node. */
1.86 nicm 571: static struct tty_key *
1.16 nicm 572: tty_keys_find1(struct tty_key *tk, const char *buf, size_t len, size_t *size)
573: {
1.106 nicm 574: /* If no data, no match. */
575: if (len == 0)
576: return (NULL);
577:
1.16 nicm 578: /* If the node is NULL, this is the end of the tree. No match. */
579: if (tk == NULL)
1.1 nicm 580: return (NULL);
581:
1.16 nicm 582: /* Pick the next in the sequence. */
583: if (tk->ch == *buf) {
584: /* Move forward in the string. */
585: buf++; len--;
586: (*size)++;
1.1 nicm 587:
1.16 nicm 588: /* At the end of the string, return the current node. */
1.83 nicm 589: if (len == 0 || (tk->next == NULL && tk->key != KEYC_UNKNOWN))
1.16 nicm 590: return (tk);
1.1 nicm 591:
1.16 nicm 592: /* Move into the next tree for the following character. */
593: tk = tk->next;
594: } else {
595: if (*buf < tk->ch)
596: tk = tk->left;
597: else if (*buf > tk->ch)
598: tk = tk->right;
1.1 nicm 599: }
600:
1.16 nicm 601: /* Move to the next in the tree. */
602: return (tty_keys_find1(tk, buf, len, size));
1.1 nicm 603: }
604:
1.86 nicm 605: /* Look up part of the next key. */
606: static int
607: tty_keys_next1(struct tty *tty, const char *buf, size_t len, key_code *key,
1.87 nicm 608: size_t *size, int expired)
1.86 nicm 609: {
1.94 nicm 610: struct client *c = tty->client;
1.86 nicm 611: struct tty_key *tk, *tk1;
612: struct utf8_data ud;
613: enum utf8_state more;
1.138 nicm 614: utf8_char uc;
1.86 nicm 615: u_int i;
616:
1.94 nicm 617: log_debug("%s: next key is %zu (%.*s) (expired=%d)", c->name, len,
618: (int)len, buf, expired);
1.86 nicm 619:
620: /* Is this a known key? */
621: tk = tty_keys_find(tty, buf, len, size);
1.87 nicm 622: if (tk != NULL && tk->key != KEYC_UNKNOWN) {
1.86 nicm 623: tk1 = tk;
624: do
1.94 nicm 625: log_debug("%s: keys in list: %#llx", c->name, tk1->key);
1.86 nicm 626: while ((tk1 = tk1->next) != NULL);
1.87 nicm 627: if (tk->next != NULL && !expired)
628: return (1);
1.86 nicm 629: *key = tk->key;
1.87 nicm 630: return (0);
1.86 nicm 631: }
1.97 nicm 632:
1.86 nicm 633: /* Is this valid UTF-8? */
634: more = utf8_open(&ud, (u_char)*buf);
635: if (more == UTF8_MORE) {
636: *size = ud.size;
1.87 nicm 637: if (len < ud.size) {
638: if (!expired)
639: return (1);
640: return (-1);
641: }
1.86 nicm 642: for (i = 1; i < ud.size; i++)
643: more = utf8_append(&ud, (u_char)buf[i]);
644: if (more != UTF8_DONE)
1.87 nicm 645: return (-1);
1.86 nicm 646:
1.138 nicm 647: if (utf8_from_data(&ud, &uc) != UTF8_DONE)
1.87 nicm 648: return (-1);
1.138 nicm 649: *key = uc;
1.86 nicm 650:
1.94 nicm 651: log_debug("%s: UTF-8 key %.*s %#llx", c->name, (int)ud.size,
1.138 nicm 652: ud.data, *key);
1.86 nicm 653: return (0);
654: }
655:
656: return (-1);
657: }
658:
1.111 nicm 659: /* Process at least one key in the buffer. Return 0 if no keys present. */
660: int
1.14 nicm 661: tty_keys_next(struct tty *tty)
1.1 nicm 662: {
1.111 nicm 663: struct client *c = tty->client;
664: struct timeval tv;
665: const char *buf;
666: size_t len, size;
667: cc_t bspace;
668: int delay, expired = 0, n;
669: key_code key;
670: struct mouse_event m = { 0 };
671: struct key_event *event;
1.1 nicm 672:
1.51 nicm 673: /* Get key buffer. */
1.93 nicm 674: buf = EVBUFFER_DATA(tty->in);
675: len = EVBUFFER_LENGTH(tty->in);
1.1 nicm 676: if (len == 0)
1.14 nicm 677: return (0);
1.94 nicm 678: log_debug("%s: keys are %zu (%.*s)", c->name, len, (int)len, buf);
1.1 nicm 679:
1.104 nicm 680: /* Is this a clipboard response? */
681: switch (tty_keys_clipboard(tty, buf, len, &size)) {
682: case 0: /* yes */
683: key = KEYC_UNKNOWN;
684: goto complete_key;
685: case -1: /* no, or not valid */
686: break;
687: case 1: /* partial */
688: goto partial_key;
689: }
690:
1.91 nicm 691: /* Is this a device attributes response? */
692: switch (tty_keys_device_attributes(tty, buf, len, &size)) {
693: case 0: /* yes */
694: key = KEYC_UNKNOWN;
695: goto complete_key;
696: case -1: /* no, or not valid */
697: break;
698: case 1: /* partial */
699: goto partial_key;
700: }
701:
1.128 nicm 702: /* Is this an extended device attributes response? */
703: switch (tty_keys_extended_device_attributes(tty, buf, len, &size)) {
1.119 nicm 704: case 0: /* yes */
705: key = KEYC_UNKNOWN;
706: goto complete_key;
707: case -1: /* no, or not valid */
708: break;
709: case 1: /* partial */
710: goto partial_key;
711: }
712:
1.26 nicm 713: /* Is this a mouse key press? */
1.111 nicm 714: switch (tty_keys_mouse(tty, buf, len, &size, &m)) {
1.22 nicm 715: case 0: /* yes */
716: key = KEYC_MOUSE;
1.51 nicm 717: goto complete_key;
1.22 nicm 718: case -1: /* no, or not valid */
1.24 nicm 719: break;
1.67 nicm 720: case -2: /* yes, but we don't care. */
1.73 nicm 721: key = KEYC_MOUSE;
1.67 nicm 722: goto discard_key;
1.22 nicm 723: case 1: /* partial */
724: goto partial_key;
1.11 nicm 725: }
726:
1.133 nicm 727: /* Is this an extended key press? */
728: switch (tty_keys_extended_key(tty, buf, len, &size, &key)) {
729: case 0: /* yes */
730: goto complete_key;
731: case -1: /* no, or not valid */
732: break;
733: case 1: /* partial */
734: goto partial_key;
735: }
736:
1.86 nicm 737: first_key:
1.101 nicm 738: /* Try to lookup complete key. */
739: n = tty_keys_next1(tty, buf, len, &key, &size, expired);
740: if (n == 0) /* found */
741: goto complete_key;
742: if (n == 1)
743: goto partial_key;
744:
745: /*
746: * If not a complete key, look for key with an escape prefix (meta
747: * modifier).
748: */
1.105 nicm 749: if (*buf == '\033' && len > 1) {
1.87 nicm 750: /* Look for a key without the escape. */
751: n = tty_keys_next1(tty, buf + 1, len - 1, &key, &size, expired);
752: if (n == 0) { /* found */
1.135 nicm 753: if (key & KEYC_IMPLIED_META) {
1.97 nicm 754: /*
755: * We want the escape key as well as the xterm
756: * key, because the xterm sequence implicitly
757: * includes the escape (so if we see
758: * \033\033[1;3D we know it is an Escape
759: * followed by M-Left, not just M-Left).
760: */
761: key = '\033';
762: size = 1;
763: goto complete_key;
764: }
1.134 nicm 765: key |= KEYC_META;
1.87 nicm 766: size++;
767: goto complete_key;
768: }
769: if (n == 1) /* partial */
1.62 nicm 770: goto partial_key;
1.89 nicm 771: }
1.1 nicm 772:
1.89 nicm 773: /*
774: * At this point, we know the key is not partial (with or without
775: * escape). So pass it through even if the timer has not expired.
776: */
777: if (*buf == '\033' && len >= 2) {
1.134 nicm 778: key = (u_char)buf[1] | KEYC_META;
1.89 nicm 779: size = 2;
780: } else {
781: key = (u_char)buf[0];
782: size = 1;
1.76 nicm 783: }
1.51 nicm 784: goto complete_key;
785:
786: partial_key:
1.94 nicm 787: log_debug("%s: partial key %.*s", c->name, (int)len, buf);
1.14 nicm 788:
1.51 nicm 789: /* If timer is going, check for expiration. */
790: if (tty->flags & TTY_TIMER) {
791: if (evtimer_initialized(&tty->key_timer) &&
1.59 nicm 792: !evtimer_pending(&tty->key_timer, NULL)) {
793: expired = 1;
1.51 nicm 794: goto first_key;
1.59 nicm 795: }
1.39 nicm 796: return (0);
1.51 nicm 797: }
1.39 nicm 798:
1.51 nicm 799: /* Get the time period. */
1.75 nicm 800: delay = options_get_number(global_options, "escape-time");
1.28 nicm 801: tv.tv_sec = delay / 1000;
802: tv.tv_usec = (delay % 1000) * 1000L;
1.27 nicm 803:
1.51 nicm 804: /* Start the timer. */
1.36 nicm 805: if (event_initialized(&tty->key_timer))
806: evtimer_del(&tty->key_timer);
1.14 nicm 807: evtimer_set(&tty->key_timer, tty_keys_callback, tty);
808: evtimer_add(&tty->key_timer, &tv);
1.27 nicm 809:
1.51 nicm 810: tty->flags |= TTY_TIMER;
1.14 nicm 811: return (0);
1.1 nicm 812:
1.51 nicm 813: complete_key:
1.94 nicm 814: log_debug("%s: complete key %.*s %#llx", c->name, (int)size, buf, key);
1.88 nicm 815:
816: /*
817: * Check for backspace key using termios VERASE - the terminfo
818: * kbs entry is extremely unreliable, so cannot be safely
819: * used. termios should have a better idea.
820: */
821: bspace = tty->tio.c_cc[VERASE];
822: if (bspace != _POSIX_VDISABLE && (key & KEYC_MASK_KEY) == bspace)
1.135 nicm 823: key = (key & KEYC_MASK_MODIFIERS)|KEYC_BSPACE;
1.16 nicm 824:
1.51 nicm 825: /* Remove data from buffer. */
1.93 nicm 826: evbuffer_drain(tty->in, size);
1.16 nicm 827:
1.51 nicm 828: /* Remove key timer. */
1.36 nicm 829: if (event_initialized(&tty->key_timer))
830: evtimer_del(&tty->key_timer);
1.51 nicm 831: tty->flags &= ~TTY_TIMER;
1.56 nicm 832:
833: /* Check for focus events. */
1.148 nicm 834: if (key == KEYC_FOCUS_OUT) {
1.149 nicm 835: c->flags &= ~CLIENT_FOCUSED;
836: window_update_focus(c->session->curw->window);
1.148 nicm 837: notify_client("client-focus-out", c);
838: } else if (key == KEYC_FOCUS_IN) {
1.149 nicm 839: c->flags |= CLIENT_FOCUSED;
1.148 nicm 840: notify_client("client-focus-in", c);
1.149 nicm 841: window_update_focus(c->session->curw->window);
1.148 nicm 842: }
1.16 nicm 843:
1.51 nicm 844: /* Fire the key. */
1.111 nicm 845: if (key != KEYC_UNKNOWN) {
846: event = xmalloc(sizeof *event);
847: event->key = key;
848: memcpy(&event->m, &m, sizeof event->m);
1.113 nicm 849: if (!server_client_handle_key(c, event))
850: free(event);
1.111 nicm 851: }
1.16 nicm 852:
1.14 nicm 853: return (1);
1.67 nicm 854:
855: discard_key:
1.94 nicm 856: log_debug("%s: discard key %.*s %#llx", c->name, (int)size, buf, key);
1.67 nicm 857:
858: /* Remove data from buffer. */
1.93 nicm 859: evbuffer_drain(tty->in, size);
1.67 nicm 860:
861: return (1);
1.14 nicm 862: }
863:
1.16 nicm 864: /* Key timer callback. */
1.86 nicm 865: static void
1.81 nicm 866: tty_keys_callback(__unused int fd, __unused short events, void *data)
1.14 nicm 867: {
868: struct tty *tty = data;
869:
1.51 nicm 870: if (tty->flags & TTY_TIMER) {
871: while (tty_keys_next(tty))
872: ;
873: }
1.133 nicm 874: }
875:
876: /*
877: * Handle extended key input. This has two forms: \033[27;m;k~ and \033[k;mu,
878: * where k is key as a number and m is a modifier. Returns 0 for success, -1
879: * for failure, 1 for partial;
880: */
881: static int
882: tty_keys_extended_key(struct tty *tty, const char *buf, size_t len,
883: size_t *size, key_code *key)
884: {
885: struct client *c = tty->client;
886: size_t end;
887: u_int number, modifiers;
888: char tmp[64];
1.143 nicm 889: cc_t bspace;
890: key_code nkey;
1.144 nicm 891: key_code onlykey;
1.133 nicm 892:
893: *size = 0;
894:
895: /* First two bytes are always \033[. */
896: if (buf[0] != '\033')
897: return (-1);
898: if (len == 1)
899: return (1);
900: if (buf[1] != '[')
901: return (-1);
902: if (len == 2)
903: return (1);
904:
905: /*
906: * Look for a terminator. Stop at either '~' or anything that isn't a
907: * number or ';'.
908: */
909: for (end = 2; end < len && end != sizeof tmp; end++) {
910: if (buf[end] == '~')
911: break;
912: if (!isdigit((u_char)buf[end]) && buf[end] != ';')
913: break;
914: }
915: if (end == len)
916: return (1);
917: if (end == sizeof tmp || (buf[end] != '~' && buf[end] != 'u'))
918: return (-1);
919:
920: /* Copy to the buffer. */
921: memcpy(tmp, buf + 2, end);
922: tmp[end] = '\0';
923:
924: /* Try to parse either form of key. */
925: if (buf[end] == '~') {
926: if (sscanf(tmp, "27;%u;%u", &modifiers, &number) != 2)
927: return (-1);
928: } else {
929: if (sscanf(tmp ,"%u;%u", &number, &modifiers) != 2)
930: return (-1);
931: }
932: *size = end + 1;
933:
1.143 nicm 934: /* Store the key. */
935: bspace = tty->tio.c_cc[VERASE];
936: if (bspace != _POSIX_VDISABLE && number == bspace)
937: nkey = KEYC_BSPACE;
938: else
939: nkey = number;
940:
941: /* Update the modifiers. */
1.133 nicm 942: switch (modifiers) {
943: case 2:
1.143 nicm 944: nkey |= KEYC_SHIFT;
1.133 nicm 945: break;
946: case 3:
1.143 nicm 947: nkey |= (KEYC_META|KEYC_IMPLIED_META);
1.133 nicm 948: break;
949: case 4:
1.143 nicm 950: nkey |= (KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META);
1.133 nicm 951: break;
952: case 5:
1.143 nicm 953: nkey |= KEYC_CTRL;
1.133 nicm 954: break;
955: case 6:
1.143 nicm 956: nkey |= (KEYC_SHIFT|KEYC_CTRL);
1.133 nicm 957: break;
958: case 7:
1.143 nicm 959: nkey |= (KEYC_META|KEYC_CTRL);
1.133 nicm 960: break;
961: case 8:
1.143 nicm 962: nkey |= (KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL);
1.133 nicm 963: break;
1.147 nicm 964: case 9:
965: nkey |= (KEYC_META|KEYC_IMPLIED_META);
966: break;
1.133 nicm 967: default:
968: *key = KEYC_NONE;
969: break;
970: }
1.143 nicm 971:
1.144 nicm 972: /*
973: * Don't allow both KEYC_CTRL and as an implied modifier. Also convert
974: * C-X into C-x and so on.
975: */
1.145 nicm 976: if (nkey & KEYC_CTRL) {
1.144 nicm 977: onlykey = (nkey & KEYC_MASK_KEY);
1.147 nicm 978: if (onlykey < 32 &&
979: onlykey != 9 &&
980: onlykey != 13 &&
981: onlykey != 27)
1.146 nicm 982: /* nothing */;
983: else if (onlykey >= 97 && onlykey <= 122)
984: onlykey -= 96;
985: else if (onlykey >= 64 && onlykey <= 95)
986: onlykey -= 64;
987: else if (onlykey == 32)
988: onlykey = 0;
989: else if (onlykey == 63)
990: onlykey = 127;
991: else
992: onlykey |= KEYC_CTRL;
993: nkey = onlykey|((nkey & KEYC_MASK_MODIFIERS) & ~KEYC_CTRL);
1.143 nicm 994: }
995:
1.133 nicm 996: if (log_get_level() != 0) {
997: log_debug("%s: extended key %.*s is %llx (%s)", c->name,
1.143 nicm 998: (int)*size, buf, nkey, key_string_lookup_key(nkey, 1));
1.133 nicm 999: }
1.143 nicm 1000: *key = nkey;
1.133 nicm 1001: return (0);
1.1 nicm 1002: }
1003:
1.27 nicm 1004: /*
1.22 nicm 1005: * Handle mouse key input. Returns 0 for success, -1 for failure, 1 for partial
1006: * (probably a mouse sequence but need more data).
1007: */
1.86 nicm 1008: static int
1.111 nicm 1009: tty_keys_mouse(struct tty *tty, const char *buf, size_t len, size_t *size,
1010: struct mouse_event *m)
1.1 nicm 1011: {
1.111 nicm 1012: struct client *c = tty->client;
1013: u_int i, x, y, b, sgr_b;
1014: u_char sgr_type, ch;
1.33 nicm 1015:
1.1 nicm 1016: /*
1.33 nicm 1017: * Standard mouse sequences are \033[M followed by three characters
1.55 nicm 1018: * indicating button, X and Y, all based at 32 with 1,1 top-left.
1.33 nicm 1019: *
1020: * UTF-8 mouse sequences are similar but the three are expressed as
1021: * UTF-8 characters.
1.55 nicm 1022: *
1023: * SGR extended mouse sequences are \033[< followed by three numbers in
1024: * decimal and separated by semicolons indicating button, X and Y. A
1025: * trailing 'M' is click or scroll and trailing 'm' release. All are
1026: * based at 0 with 1,1 top-left.
1.1 nicm 1027: */
1028:
1.22 nicm 1029: *size = 0;
1.72 nicm 1030: x = y = b = sgr_b = 0;
1031: sgr_type = ' ';
1.22 nicm 1032:
1.55 nicm 1033: /* First two bytes are always \033[. */
1.22 nicm 1034: if (buf[0] != '\033')
1035: return (-1);
1036: if (len == 1)
1037: return (1);
1038: if (buf[1] != '[')
1039: return (-1);
1040: if (len == 2)
1041: return (1);
1042:
1.55 nicm 1043: /*
1.82 nicm 1044: * Third byte is M in old standard (and UTF-8 extension which we do not
1045: * support), < in SGR extension.
1.55 nicm 1046: */
1047: if (buf[2] == 'M') {
1048: /* Read the three inputs. */
1049: *size = 3;
1050: for (i = 0; i < 3; i++) {
1051: if (len <= *size)
1052: return (1);
1.94 nicm 1053: ch = (u_char)buf[(*size)++];
1.55 nicm 1054: if (i == 0)
1.94 nicm 1055: b = ch;
1.55 nicm 1056: else if (i == 1)
1.94 nicm 1057: x = ch;
1.55 nicm 1058: else
1.94 nicm 1059: y = ch;
1.33 nicm 1060: }
1.94 nicm 1061: log_debug("%s: mouse input: %.*s", c->name, (int)*size, buf);
1.16 nicm 1062:
1.55 nicm 1063: /* Check and return the mouse input. */
1.155 ! nicm 1064: if (b < MOUSE_PARAM_BTN_OFF ||
! 1065: x < MOUSE_PARAM_POS_OFF ||
! 1066: y < MOUSE_PARAM_POS_OFF)
1.55 nicm 1067: return (-1);
1.155 ! nicm 1068: b -= MOUSE_PARAM_BTN_OFF;
! 1069: x -= MOUSE_PARAM_POS_OFF;
! 1070: y -= MOUSE_PARAM_POS_OFF;
1.55 nicm 1071: } else if (buf[2] == '<') {
1072: /* Read the three inputs. */
1073: *size = 3;
1074: while (1) {
1075: if (len <= *size)
1076: return (1);
1.94 nicm 1077: ch = (u_char)buf[(*size)++];
1078: if (ch == ';')
1.55 nicm 1079: break;
1.94 nicm 1080: if (ch < '0' || ch > '9')
1.55 nicm 1081: return (-1);
1.94 nicm 1082: sgr_b = 10 * sgr_b + (ch - '0');
1.55 nicm 1083: }
1084: while (1) {
1085: if (len <= *size)
1086: return (1);
1.94 nicm 1087: ch = (u_char)buf[(*size)++];
1088: if (ch == ';')
1.55 nicm 1089: break;
1.94 nicm 1090: if (ch < '0' || ch > '9')
1.55 nicm 1091: return (-1);
1.94 nicm 1092: x = 10 * x + (ch - '0');
1.55 nicm 1093: }
1094: while (1) {
1095: if (len <= *size)
1096: return (1);
1.94 nicm 1097: ch = (u_char)buf[(*size)++];
1098: if (ch == 'M' || ch == 'm')
1.55 nicm 1099: break;
1.94 nicm 1100: if (ch < '0' || ch > '9')
1.55 nicm 1101: return (-1);
1.94 nicm 1102: y = 10 * y + (ch - '0');
1.55 nicm 1103: }
1.94 nicm 1104: log_debug("%s: mouse input (SGR): %.*s", c->name, (int)*size,
1105: buf);
1.1 nicm 1106:
1.55 nicm 1107: /* Check and return the mouse input. */
1108: if (x < 1 || y < 1)
1109: return (-1);
1110: x--;
1111: y--;
1.72 nicm 1112: b = sgr_b;
1113:
1114: /* Type is M for press, m for release. */
1.94 nicm 1115: sgr_type = ch;
1.72 nicm 1116: if (sgr_type == 'm')
1.153 nicm 1117: b = 3;
1.67 nicm 1118:
1119: /*
1120: * Some terminals (like PuTTY 0.63) mistakenly send
1121: * button-release events for scroll-wheel button-press event.
1122: * Discard it before it reaches any program running inside
1123: * tmux.
1124: */
1.153 nicm 1125: if (sgr_type == 'm' && MOUSE_WHEEL(sgr_b))
1.67 nicm 1126: return (-2);
1.55 nicm 1127: } else
1.22 nicm 1128: return (-1);
1.45 nicm 1129:
1.72 nicm 1130: /* Fill mouse event. */
1.111 nicm 1131: m->lx = tty->mouse_last_x;
1.61 nicm 1132: m->x = x;
1.111 nicm 1133: m->ly = tty->mouse_last_y;
1.61 nicm 1134: m->y = y;
1.114 nicm 1135: m->lb = tty->mouse_last_b;
1.72 nicm 1136: m->b = b;
1137: m->sgr_type = sgr_type;
1138: m->sgr_b = sgr_b;
1.111 nicm 1139:
1140: /* Update last mouse state. */
1141: tty->mouse_last_x = x;
1142: tty->mouse_last_y = y;
1.114 nicm 1143: tty->mouse_last_b = b;
1.104 nicm 1144:
1145: return (0);
1146: }
1147:
1148: /*
1149: * Handle OSC 52 clipboard input. Returns 0 for success, -1 for failure, 1 for
1150: * partial.
1151: */
1152: static int
1.154 nicm 1153: tty_keys_clipboard(struct tty *tty, const char *buf, size_t len, size_t *size)
1.104 nicm 1154: {
1.154 nicm 1155: struct client *c = tty->client;
1156: struct window_pane *wp;
1157: size_t end, terminator, needed;
1158: char *copy, *out;
1159: int outlen;
1160: u_int i;
1.104 nicm 1161:
1162: *size = 0;
1163:
1.128 nicm 1164: /* First five bytes are always \033]52;. */
1.104 nicm 1165: if (buf[0] != '\033')
1166: return (-1);
1167: if (len == 1)
1168: return (1);
1169: if (buf[1] != ']')
1170: return (-1);
1171: if (len == 2)
1172: return (1);
1173: if (buf[2] != '5')
1174: return (-1);
1175: if (len == 3)
1176: return (1);
1177: if (buf[3] != '2')
1178: return (-1);
1179: if (len == 4)
1180: return (1);
1181: if (buf[4] != ';')
1182: return (-1);
1183: if (len == 5)
1184: return (1);
1185:
1186: /* Find the terminator if any. */
1187: for (end = 5; end < len; end++) {
1188: if (buf[end] == '\007') {
1189: terminator = 1;
1190: break;
1191: }
1192: if (end > 5 && buf[end - 1] == '\033' && buf[end] == '\\') {
1193: terminator = 2;
1194: break;
1195: }
1196: }
1197: if (end == len)
1198: return (1);
1199: *size = end + terminator;
1200:
1201: /* Skip the initial part. */
1202: buf += 5;
1203: end -= 5;
1.151 nicm 1204:
1205: /* Adjust end so that it points to the start of the terminator. */
1206: end -= terminator - 1;
1.104 nicm 1207:
1208: /* Get the second argument. */
1209: while (end != 0 && *buf != ';') {
1210: buf++;
1211: end--;
1212: }
1213: if (end == 0 || end == 1)
1214: return (0);
1215: buf++;
1216: end--;
1.152 nicm 1217:
1218: /* If we did not request this, ignore it. */
1219: if (~tty->flags & TTY_OSC52QUERY)
1220: return (0);
1221: tty->flags &= ~TTY_OSC52QUERY;
1.154 nicm 1222: evtimer_del(&tty->clipboard_timer);
1.104 nicm 1223:
1224: /* It has to be a string so copy it. */
1225: copy = xmalloc(end + 1);
1226: memcpy(copy, buf, end);
1227: copy[end] = '\0';
1228:
1229: /* Convert from base64. */
1230: needed = (end / 4) * 3;
1231: out = xmalloc(needed);
1232: if ((outlen = b64_pton(copy, out, len)) == -1) {
1233: free(out);
1234: free(copy);
1235: return (0);
1236: }
1237: free(copy);
1238:
1.154 nicm 1239: /* Create a new paste buffer and forward to panes. */
1.104 nicm 1240: log_debug("%s: %.*s", __func__, outlen, out);
1.154 nicm 1241: if (c->flags & CLIENT_CLIPBOARDBUFFER) {
1242: paste_add(NULL, out, outlen);
1243: c->flags &= ~CLIENT_CLIPBOARDBUFFER;
1244: }
1245: for (i = 0; i < c->clipboard_npanes; i++) {
1246: wp = window_pane_find_by_id(c->clipboard_panes[i]);
1247: if (wp != NULL)
1248: input_reply_clipboard(wp->event, out, outlen, "\033\\");
1249: }
1250: free(c->clipboard_panes);
1251: c->clipboard_panes = NULL;
1252: c->clipboard_npanes = 0;
1.91 nicm 1253:
1254: return (0);
1255: }
1256:
1257: /*
1.124 nicm 1258: * Handle secondary device attributes input. Returns 0 for success, -1 for
1259: * failure, 1 for partial.
1.91 nicm 1260: */
1261: static int
1262: tty_keys_device_attributes(struct tty *tty, const char *buf, size_t len,
1263: size_t *size)
1264: {
1.118 nicm 1265: struct client *c = tty->client;
1266: u_int i, n = 0;
1267: char tmp[64], *endptr, p[32] = { 0 }, *cp, *next;
1.91 nicm 1268:
1269: *size = 0;
1.120 nicm 1270: if (tty->flags & TTY_HAVEDA)
1271: return (-1);
1.91 nicm 1272:
1.141 nicm 1273: /*
1274: * First three bytes are always \033[>. Some older Terminal.app
1275: * versions respond as for DA (\033[?) so accept and ignore that.
1276: */
1.91 nicm 1277: if (buf[0] != '\033')
1278: return (-1);
1279: if (len == 1)
1280: return (1);
1281: if (buf[1] != '[')
1282: return (-1);
1283: if (len == 2)
1284: return (1);
1.141 nicm 1285: if (buf[2] != '>' && buf[2] != '?')
1.91 nicm 1286: return (-1);
1287: if (len == 3)
1288: return (1);
1289:
1290: /* Copy the rest up to a 'c'. */
1.128 nicm 1291: for (i = 0; i < (sizeof tmp) - 1; i++) {
1.91 nicm 1292: if (3 + i == len)
1293: return (1);
1.128 nicm 1294: if (buf[3 + i] == 'c')
1295: break;
1.91 nicm 1296: tmp[i] = buf[3 + i];
1297: }
1298: if (i == (sizeof tmp) - 1)
1299: return (-1);
1300: tmp[i] = '\0';
1301: *size = 4 + i;
1.141 nicm 1302:
1303: /* Ignore DA response. */
1304: if (buf[2] == '?')
1305: return (0);
1.91 nicm 1306:
1.124 nicm 1307: /* Convert all arguments to numbers. */
1.116 nicm 1308: cp = tmp;
1309: while ((next = strsep(&cp, ";")) != NULL) {
1310: p[n] = strtoul(next, &endptr, 10);
1.117 nicm 1311: if (*endptr != '\0')
1.116 nicm 1312: p[n] = 0;
1313: n++;
1314: }
1.91 nicm 1315:
1.126 nicm 1316: /* Add terminal features. */
1.116 nicm 1317: switch (p[0]) {
1.124 nicm 1318: case 41: /* VT420 */
1.131 nicm 1319: tty_add_features(&c->term_features, "margins,rectfill", ",");
1.91 nicm 1320: break;
1.124 nicm 1321: case 'M': /* mintty */
1.130 nicm 1322: tty_default_features(&c->term_features, "mintty", 0);
1.124 nicm 1323: break;
1.126 nicm 1324: case 'T': /* tmux */
1.130 nicm 1325: tty_default_features(&c->term_features, "tmux", 0);
1.124 nicm 1326: break;
1327: case 'U': /* rxvt-unicode */
1.130 nicm 1328: tty_default_features(&c->term_features, "rxvt-unicode", 0);
1.124 nicm 1329: break;
1.91 nicm 1330: }
1.124 nicm 1331: log_debug("%s: received secondary DA %.*s", c->name, (int)*size, buf);
1.120 nicm 1332:
1.126 nicm 1333: tty_update_features(tty);
1.120 nicm 1334: tty->flags |= TTY_HAVEDA;
1335:
1.119 nicm 1336: return (0);
1337: }
1338:
1339: /*
1.128 nicm 1340: * Handle extended device attributes input. Returns 0 for success, -1 for
1341: * failure, 1 for partial.
1.119 nicm 1342: */
1343: static int
1.128 nicm 1344: tty_keys_extended_device_attributes(struct tty *tty, const char *buf,
1345: size_t len, size_t *size)
1.119 nicm 1346: {
1347: struct client *c = tty->client;
1348: u_int i;
1.130 nicm 1349: char tmp[128];
1.119 nicm 1350:
1351: *size = 0;
1.128 nicm 1352: if (tty->flags & TTY_HAVEXDA)
1.120 nicm 1353: return (-1);
1.119 nicm 1354:
1.128 nicm 1355: /* First four bytes are always \033P>|. */
1.119 nicm 1356: if (buf[0] != '\033')
1357: return (-1);
1358: if (len == 1)
1359: return (1);
1.128 nicm 1360: if (buf[1] != 'P')
1.119 nicm 1361: return (-1);
1362: if (len == 2)
1363: return (1);
1.128 nicm 1364: if (buf[2] != '>')
1.120 nicm 1365: return (-1);
1366: if (len == 3)
1367: return (1);
1.128 nicm 1368: if (buf[3] != '|')
1369: return (-1);
1370: if (len == 4)
1371: return (1);
1.119 nicm 1372:
1.128 nicm 1373: /* Copy the rest up to a '\033\\'. */
1374: for (i = 0; i < (sizeof tmp) - 1; i++) {
1375: if (4 + i == len)
1.119 nicm 1376: return (1);
1.128 nicm 1377: if (buf[4 + i - 1] == '\033' && buf[4 + i] == '\\')
1378: break;
1379: tmp[i] = buf[4 + i];
1.119 nicm 1380: }
1381: if (i == (sizeof tmp) - 1)
1382: return (-1);
1.128 nicm 1383: tmp[i - 1] = '\0';
1384: *size = 5 + i;
1.119 nicm 1385:
1.126 nicm 1386: /* Add terminal features. */
1.130 nicm 1387: if (strncmp(tmp, "iTerm2 ", 7) == 0)
1388: tty_default_features(&c->term_features, "iTerm2", 0);
1389: else if (strncmp(tmp, "tmux ", 5) == 0)
1390: tty_default_features(&c->term_features, "tmux", 0);
1391: else if (strncmp(tmp, "XTerm(", 6) == 0)
1.136 nicm 1392: tty_default_features(&c->term_features, "XTerm", 0);
1.130 nicm 1393: else if (strncmp(tmp, "mintty ", 7) == 0)
1394: tty_default_features(&c->term_features, "mintty", 0);
1.128 nicm 1395: log_debug("%s: received extended DA %.*s", c->name, (int)*size, buf);
1.130 nicm 1396:
1397: free(c->term_type);
1398: c->term_type = xstrdup(tmp);
1.120 nicm 1399:
1.126 nicm 1400: tty_update_features(tty);
1.128 nicm 1401: tty->flags |= TTY_HAVEXDA;
1.120 nicm 1402:
1.22 nicm 1403: return (0);
1.1 nicm 1404: }