xref: /openbsd-src/usr.bin/tmux/tty-keys.c (revision 5054e3e78af0749a9bb00ba9a024b3ee2d90290f)
1 /* $OpenBSD: tty-keys.c,v 1.21 2009/11/12 08:01:02 nicm Exp $ */
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>
23 #include <termios.h>
24 #include <unistd.h>
25 
26 #include "tmux.h"
27 
28 /*
29  * Handle keys input from the outside terminal. tty_keys[] is a base table of
30  * supported keys which are looked up in terminfo(5) and translated into a
31  * ternary tree (a binary tree of binary trees).
32  */
33 
34 void		tty_keys_add1(struct tty_key **, const char *, int);
35 void		tty_keys_add(struct tty *, const char *, int);
36 void		tty_keys_free1(struct tty_key *);
37 struct tty_key *tty_keys_find1(
38     		    struct tty_key *, const char *, size_t, size_t *);
39 struct tty_key *tty_keys_find(struct tty *, const char *, size_t, size_t *);
40 void		tty_keys_callback(int, short, void *);
41 int		tty_keys_mouse(
42 		    const char *, size_t, size_t *, struct mouse_event *);
43 
44 struct tty_key_ent {
45 	enum tty_code_code	code;
46 	const char	       *string;
47 
48 	int	 	 	key;
49 	int		 	flags;
50 #define TTYKEY_RAW 0x1
51 };
52 
53 /*
54  * Default key tables. Those flagged with TTYKEY_RAW are inserted directly,
55  * otherwise they are looked up in terminfo(5).
56  */
57 struct tty_key_ent tty_keys[] = {
58 	/* Function keys. */
59 	{ TTYC_KF1,	NULL,		KEYC_F1,		0 },
60 	{ TTYC_KF2,	NULL,		KEYC_F2,		0 },
61 	{ TTYC_KF3,	NULL,		KEYC_F3,		0 },
62 	{ TTYC_KF4,	NULL,		KEYC_F4,		0 },
63 	{ TTYC_KF5,	NULL,		KEYC_F5,		0 },
64 	{ TTYC_KF6,	NULL,		KEYC_F6,		0 },
65 	{ TTYC_KF7,	NULL,		KEYC_F7,		0 },
66 	{ TTYC_KF8,	NULL,		KEYC_F8,		0 },
67 	{ TTYC_KF9,	NULL,		KEYC_F9,		0 },
68 	{ TTYC_KF10,	NULL,		KEYC_F10,		0 },
69 	{ TTYC_KF11,	NULL,		KEYC_F11,		0 },
70 	{ TTYC_KF12,	NULL,		KEYC_F12,		0 },
71 	{ TTYC_KF13,	NULL,		KEYC_F13,		0 },
72 	{ TTYC_KF14,	NULL,		KEYC_F14,		0 },
73 	{ TTYC_KF15,	NULL,		KEYC_F15,		0 },
74 	{ TTYC_KF16,	NULL,		KEYC_F16,		0 },
75 	{ TTYC_KF17,	NULL,		KEYC_F17,		0 },
76 	{ TTYC_KF18,	NULL,		KEYC_F18,		0 },
77 	{ TTYC_KF19,	NULL,		KEYC_F19,		0 },
78 	{ TTYC_KF20,	NULL,		KEYC_F20,		0 },
79 	{ TTYC_KICH1,	NULL,		KEYC_IC,		0 },
80 	{ TTYC_KDCH1,	NULL,		KEYC_DC,		0 },
81 	{ TTYC_KHOME,	NULL,		KEYC_HOME,		0 },
82 	{ TTYC_KEND,	NULL,		KEYC_END,		0 },
83 	{ TTYC_KNP,	NULL,		KEYC_NPAGE,		0 },
84 	{ TTYC_KPP,	NULL,		KEYC_PPAGE,		0 },
85 	{ TTYC_KCBT,	NULL,		KEYC_BTAB,		0 },
86 
87 	/* Arrow keys. */
88 	{ 0,		"\033OA",	KEYC_UP,		TTYKEY_RAW },
89 	{ 0,		"\033OB",	KEYC_DOWN,		TTYKEY_RAW },
90 	{ 0,		"\033OC",	KEYC_RIGHT,		TTYKEY_RAW },
91 	{ 0,		"\033OD",	KEYC_LEFT,		TTYKEY_RAW },
92 
93 	{ 0,		"\033[A",	KEYC_UP,		TTYKEY_RAW },
94 	{ 0,		"\033[B",	KEYC_DOWN,		TTYKEY_RAW },
95 	{ 0,		"\033[C",	KEYC_RIGHT,		TTYKEY_RAW },
96 	{ 0,		"\033[D",	KEYC_LEFT,		TTYKEY_RAW },
97 
98 	{ TTYC_KCUU1,	NULL,		KEYC_UP,		0 },
99 	{ TTYC_KCUD1,	NULL,		KEYC_DOWN,		0 },
100 	{ TTYC_KCUB1,	NULL,		KEYC_LEFT,		0 },
101 	{ TTYC_KCUF1,	NULL,		KEYC_RIGHT,		0 },
102 
103 	/*
104 	 * Numeric keypad. Just use the vt100 escape sequences here and always
105 	 * put the terminal into keypad_xmit mode. Translation of numbers
106 	 * mode/applications mode is done in input-keys.c.
107 	 */
108 	{ 0,		"\033Oo",	KEYC_KP_SLASH,		TTYKEY_RAW },
109 	{ 0,		"\033Oj",	KEYC_KP_STAR,		TTYKEY_RAW },
110 	{ 0,		"\033Om",	KEYC_KP_MINUS,		TTYKEY_RAW },
111 	{ 0,		"\033Ow",	KEYC_KP_SEVEN,		TTYKEY_RAW },
112 	{ 0,		"\033Ox",	KEYC_KP_EIGHT,		TTYKEY_RAW },
113 	{ 0,		"\033Oy",	KEYC_KP_NINE,		TTYKEY_RAW },
114 	{ 0,		"\033Ok",	KEYC_KP_PLUS,		TTYKEY_RAW },
115 	{ 0,		"\033Ot",	KEYC_KP_FOUR,		TTYKEY_RAW },
116 	{ 0,		"\033Ou",	KEYC_KP_FIVE,		TTYKEY_RAW },
117 	{ 0,		"\033Ov",	KEYC_KP_SIX,		TTYKEY_RAW },
118 	{ 0,		"\033Oq",	KEYC_KP_ONE,		TTYKEY_RAW },
119 	{ 0,		"\033Or",	KEYC_KP_TWO,		TTYKEY_RAW },
120 	{ 0,		"\033Os",	KEYC_KP_THREE,		TTYKEY_RAW },
121 	{ 0,		"\033OM",	KEYC_KP_ENTER,		TTYKEY_RAW },
122 	{ 0,		"\033Op",	KEYC_KP_ZERO,		TTYKEY_RAW },
123 	{ 0,		"\033On",	KEYC_KP_PERIOD,		TTYKEY_RAW },
124 
125 	/* Key and modifier capabilities. */
126 	{ TTYC_KDC2,	NULL,		KEYC_DC|KEYC_SHIFT,	0 },
127 	{ TTYC_KDC3,	NULL,		KEYC_DC|KEYC_ESCAPE,	0 },
128 	{ TTYC_KDC4,	NULL,		KEYC_DC|KEYC_SHIFT|KEYC_ESCAPE, 0 },
129 	{ TTYC_KDC5,	NULL,		KEYC_DC|KEYC_CTRL,	0 },
130 	{ TTYC_KDC6,	NULL,		KEYC_DC|KEYC_SHIFT|KEYC_CTRL, 0 },
131 	{ TTYC_KDC7,	NULL,		KEYC_DC|KEYC_ESCAPE|KEYC_CTRL, 0 },
132 	{ TTYC_KDN2,	NULL,		KEYC_DOWN|KEYC_SHIFT,	0 },
133 	{ TTYC_KDN3,	NULL,		KEYC_DOWN|KEYC_ESCAPE,	0 },
134 	{ TTYC_KDN4,	NULL,		KEYC_DOWN|KEYC_SHIFT|KEYC_ESCAPE, 0 },
135 	{ TTYC_KDN5,	NULL,		KEYC_DOWN|KEYC_CTRL,	0 },
136 	{ TTYC_KDN6,	NULL,		KEYC_DOWN|KEYC_SHIFT|KEYC_CTRL, 0 },
137 	{ TTYC_KDN7,	NULL,		KEYC_DOWN|KEYC_ESCAPE|KEYC_CTRL, 0 },
138 	{ TTYC_KEND2,	NULL,		KEYC_END|KEYC_SHIFT,	0 },
139 	{ TTYC_KEND3,	NULL,		KEYC_END|KEYC_ESCAPE,	0 },
140 	{ TTYC_KEND4,	NULL,		KEYC_END|KEYC_SHIFT|KEYC_ESCAPE, 0 },
141 	{ TTYC_KEND5,	NULL,		KEYC_END|KEYC_CTRL,	0 },
142 	{ TTYC_KEND6,	NULL,		KEYC_END|KEYC_SHIFT|KEYC_CTRL, 0 },
143 	{ TTYC_KEND7,	NULL,		KEYC_END|KEYC_ESCAPE|KEYC_CTRL, 0 },
144 	{ TTYC_KHOM2,	NULL,		KEYC_HOME|KEYC_SHIFT,	0 },
145 	{ TTYC_KHOM3,	NULL,		KEYC_HOME|KEYC_ESCAPE,	0 },
146 	{ TTYC_KHOM4,	NULL,		KEYC_HOME|KEYC_SHIFT|KEYC_ESCAPE, 0 },
147 	{ TTYC_KHOM5,	NULL,		KEYC_HOME|KEYC_CTRL,	0 },
148 	{ TTYC_KHOM6,	NULL,		KEYC_HOME|KEYC_SHIFT|KEYC_CTRL, 0 },
149 	{ TTYC_KHOM7,	NULL,		KEYC_HOME|KEYC_ESCAPE|KEYC_CTRL, 0 },
150 	{ TTYC_KIC2,	NULL,		KEYC_IC|KEYC_SHIFT,	0 },
151 	{ TTYC_KIC3,	NULL,		KEYC_IC|KEYC_ESCAPE,	0 },
152 	{ TTYC_KIC4,	NULL,		KEYC_IC|KEYC_SHIFT|KEYC_ESCAPE,	0 },
153 	{ TTYC_KIC5,	NULL,		KEYC_IC|KEYC_CTRL,	0 },
154 	{ TTYC_KIC6,	NULL,		KEYC_IC|KEYC_SHIFT|KEYC_CTRL, 0 },
155 	{ TTYC_KIC7,	NULL,		KEYC_IC|KEYC_ESCAPE|KEYC_CTRL, 0 },
156 	{ TTYC_KLFT2,	NULL,		KEYC_LEFT|KEYC_SHIFT,	0 },
157 	{ TTYC_KLFT3,	NULL,		KEYC_LEFT|KEYC_ESCAPE,	0 },
158 	{ TTYC_KLFT4,	NULL,		KEYC_LEFT|KEYC_SHIFT|KEYC_ESCAPE, 0 },
159 	{ TTYC_KLFT5,	NULL,		KEYC_LEFT|KEYC_CTRL,	0 },
160 	{ TTYC_KLFT6,	NULL,		KEYC_LEFT|KEYC_SHIFT|KEYC_CTRL, 0 },
161 	{ TTYC_KLFT7,	NULL,		KEYC_LEFT|KEYC_ESCAPE|KEYC_CTRL, 0 },
162 	{ TTYC_KNXT2,	NULL,		KEYC_NPAGE|KEYC_SHIFT,	0 },
163 	{ TTYC_KNXT3,	NULL,		KEYC_NPAGE|KEYC_ESCAPE,	0 },
164 	{ TTYC_KNXT4,	NULL,		KEYC_NPAGE|KEYC_SHIFT|KEYC_ESCAPE, 0 },
165 	{ TTYC_KNXT5,	NULL,		KEYC_NPAGE|KEYC_CTRL,	0 },
166 	{ TTYC_KNXT6,	NULL,		KEYC_NPAGE|KEYC_SHIFT|KEYC_CTRL, 0 },
167 	{ TTYC_KNXT7,	NULL,		KEYC_NPAGE|KEYC_ESCAPE|KEYC_CTRL, 0 },
168 	{ TTYC_KPRV2,	NULL,		KEYC_PPAGE|KEYC_SHIFT,	0 },
169 	{ TTYC_KPRV3,	NULL,		KEYC_PPAGE|KEYC_ESCAPE,	0 },
170 	{ TTYC_KPRV4,	NULL,		KEYC_PPAGE|KEYC_SHIFT|KEYC_ESCAPE, 0 },
171 	{ TTYC_KPRV5,	NULL,		KEYC_PPAGE|KEYC_CTRL,	0 },
172 	{ TTYC_KPRV6,	NULL,		KEYC_PPAGE|KEYC_SHIFT|KEYC_CTRL, 0 },
173 	{ TTYC_KPRV7,	NULL,		KEYC_PPAGE|KEYC_ESCAPE|KEYC_CTRL, 0 },
174 	{ TTYC_KRIT2,	NULL,		KEYC_RIGHT|KEYC_SHIFT,	0 },
175 	{ TTYC_KRIT3,	NULL,		KEYC_RIGHT|KEYC_ESCAPE,	0 },
176 	{ TTYC_KRIT4,	NULL,		KEYC_RIGHT|KEYC_SHIFT|KEYC_ESCAPE, 0 },
177 	{ TTYC_KRIT5,	NULL,		KEYC_RIGHT|KEYC_CTRL,	0 },
178 	{ TTYC_KRIT6,	NULL,		KEYC_RIGHT|KEYC_SHIFT|KEYC_CTRL, 0 },
179 	{ TTYC_KRIT7,	NULL,		KEYC_RIGHT|KEYC_ESCAPE|KEYC_CTRL, 0 },
180 	{ TTYC_KUP2,	NULL,		KEYC_UP|KEYC_SHIFT,	0 },
181 	{ TTYC_KUP3,	NULL,		KEYC_UP|KEYC_ESCAPE,	0 },
182 	{ TTYC_KUP4,	NULL,		KEYC_UP|KEYC_SHIFT|KEYC_ESCAPE,	0 },
183 	{ TTYC_KUP5,	NULL,		KEYC_UP|KEYC_CTRL,	0 },
184 	{ TTYC_KUP6,	NULL,		KEYC_UP|KEYC_SHIFT|KEYC_CTRL, 0 },
185 	{ TTYC_KUP7,	NULL,		KEYC_UP|KEYC_ESCAPE|KEYC_CTRL, 0 },
186 
187 	/* rxvt-style arrow + modifier keys. */
188 	{ 0,	"\033Oa",	KEYC_UP|KEYC_CTRL,	TTYKEY_RAW },
189 	{ 0,	"\033Ob",	KEYC_DOWN|KEYC_CTRL,	TTYKEY_RAW },
190 	{ 0,	"\033Oc",	KEYC_RIGHT|KEYC_CTRL,	TTYKEY_RAW },
191 	{ 0,	"\033Od",	KEYC_LEFT|KEYC_CTRL,	TTYKEY_RAW },
192 
193 	{ 0,	"\033[a",	KEYC_UP|KEYC_SHIFT,	TTYKEY_RAW },
194 	{ 0,	"\033[b",	KEYC_DOWN|KEYC_SHIFT,	TTYKEY_RAW },
195 	{ 0,	"\033[c",	KEYC_RIGHT|KEYC_SHIFT,	TTYKEY_RAW },
196 	{ 0,	"\033[d",	KEYC_LEFT|KEYC_SHIFT,	TTYKEY_RAW },
197 
198 	/*
199 	 * rxvt-style function + modifier keys:
200 	 *		Ctrl = ^, Shift = $, Ctrl+Shift = @
201 	 */
202 	{ 0,	"\033[11^",	KEYC_F1|KEYC_CTRL,	TTYKEY_RAW },
203 	{ 0,	"\033[12^",	KEYC_F2|KEYC_CTRL,	TTYKEY_RAW },
204 	{ 0,	"\033[13^",	KEYC_F3|KEYC_CTRL,	TTYKEY_RAW },
205 	{ 0,	"\033[14^",	KEYC_F4|KEYC_CTRL,	TTYKEY_RAW },
206 	{ 0,	"\033[15^",	KEYC_F5|KEYC_CTRL,	TTYKEY_RAW },
207 	{ 0,	"\033[17^",	KEYC_F6|KEYC_CTRL,	TTYKEY_RAW },
208 	{ 0,	"\033[18^",	KEYC_F7|KEYC_CTRL,	TTYKEY_RAW },
209 	{ 0,	"\033[19^",	KEYC_F8|KEYC_CTRL,	TTYKEY_RAW },
210 	{ 0,	"\033[20^",	KEYC_F9|KEYC_CTRL,	TTYKEY_RAW },
211 	{ 0,	"\033[21^",	KEYC_F10|KEYC_CTRL,	TTYKEY_RAW },
212 	{ 0,	"\033[23^",	KEYC_F11|KEYC_CTRL,	TTYKEY_RAW },
213 	{ 0,	"\033[24^",	KEYC_F12|KEYC_CTRL,	TTYKEY_RAW },
214 	{ 0,	"\033[25^",	KEYC_F13|KEYC_CTRL,	TTYKEY_RAW },
215 	{ 0,	"\033[26^",	KEYC_F14|KEYC_CTRL,	TTYKEY_RAW },
216 	{ 0,	"\033[28^",	KEYC_F15|KEYC_CTRL,	TTYKEY_RAW },
217 	{ 0,	"\033[29^",	KEYC_F16|KEYC_CTRL,	TTYKEY_RAW },
218 	{ 0,	"\033[31^",	KEYC_F17|KEYC_CTRL,	TTYKEY_RAW },
219 	{ 0,	"\033[32^",	KEYC_F18|KEYC_CTRL,	TTYKEY_RAW },
220 	{ 0,	"\033[33^",	KEYC_F19|KEYC_CTRL,	TTYKEY_RAW },
221 	{ 0,	"\033[34^",	KEYC_F20|KEYC_CTRL,	TTYKEY_RAW },
222 	{ 0,	"\033[2^",	KEYC_IC|KEYC_CTRL,	TTYKEY_RAW },
223 	{ 0,	"\033[3^",	KEYC_DC|KEYC_CTRL,	TTYKEY_RAW },
224 	{ 0,	"\033[7^",	KEYC_HOME|KEYC_CTRL,	TTYKEY_RAW },
225 	{ 0,	"\033[8^",	KEYC_END|KEYC_CTRL,	TTYKEY_RAW },
226 	{ 0,	"\033[6^",	KEYC_NPAGE|KEYC_CTRL,	TTYKEY_RAW },
227 	{ 0,	"\033[5^",	KEYC_PPAGE|KEYC_CTRL,	TTYKEY_RAW },
228 
229 	{ 0,	"\033[11$",	KEYC_F1|KEYC_SHIFT,	TTYKEY_RAW },
230 	{ 0,	"\033[12$",	KEYC_F2|KEYC_SHIFT,	TTYKEY_RAW },
231 	{ 0,	"\033[13$",	KEYC_F3|KEYC_SHIFT,	TTYKEY_RAW },
232 	{ 0,	"\033[14$",	KEYC_F4|KEYC_SHIFT,	TTYKEY_RAW },
233 	{ 0,	"\033[15$",	KEYC_F5|KEYC_SHIFT,	TTYKEY_RAW },
234 	{ 0,	"\033[17$",	KEYC_F6|KEYC_SHIFT,	TTYKEY_RAW },
235 	{ 0,	"\033[18$",	KEYC_F7|KEYC_SHIFT,	TTYKEY_RAW },
236 	{ 0,	"\033[19$",	KEYC_F8|KEYC_SHIFT,	TTYKEY_RAW },
237 	{ 0,	"\033[20$",	KEYC_F9|KEYC_SHIFT,	TTYKEY_RAW },
238 	{ 0,	"\033[21$",	KEYC_F10|KEYC_SHIFT,	TTYKEY_RAW },
239 	{ 0,	"\033[23$",	KEYC_F11|KEYC_SHIFT,	TTYKEY_RAW },
240 	{ 0,	"\033[24$",	KEYC_F12|KEYC_SHIFT,	TTYKEY_RAW },
241 	{ 0,	"\033[25$",	KEYC_F13|KEYC_SHIFT,	TTYKEY_RAW },
242 	{ 0,	"\033[26$",	KEYC_F14|KEYC_SHIFT,	TTYKEY_RAW },
243 	{ 0,	"\033[28$",	KEYC_F15|KEYC_SHIFT,	TTYKEY_RAW },
244 	{ 0,	"\033[29$",	KEYC_F16|KEYC_SHIFT,	TTYKEY_RAW },
245 	{ 0,	"\033[31$",	KEYC_F17|KEYC_SHIFT,	TTYKEY_RAW },
246 	{ 0,	"\033[32$",	KEYC_F18|KEYC_SHIFT,	TTYKEY_RAW },
247 	{ 0,	"\033[33$",	KEYC_F19|KEYC_SHIFT,	TTYKEY_RAW },
248 	{ 0,	"\033[34$",	KEYC_F20|KEYC_SHIFT,	TTYKEY_RAW },
249 	{ 0,	"\033[2$",	KEYC_IC|KEYC_SHIFT,	TTYKEY_RAW },
250 	{ 0,	"\033[3$",	KEYC_DC|KEYC_SHIFT,	TTYKEY_RAW },
251 	{ 0,	"\033[7$",	KEYC_HOME|KEYC_SHIFT,	TTYKEY_RAW },
252 	{ 0,	"\033[8$",	KEYC_END|KEYC_SHIFT,	TTYKEY_RAW },
253 	{ 0,	"\033[6$",	KEYC_NPAGE|KEYC_SHIFT,	TTYKEY_RAW },
254 	{ 0,	"\033[5$",	KEYC_PPAGE|KEYC_SHIFT,	TTYKEY_RAW },
255 
256 	{ 0,	"\033[11@",	KEYC_F1|KEYC_CTRL|KEYC_SHIFT,	TTYKEY_RAW },
257 	{ 0,	"\033[12@",	KEYC_F2|KEYC_CTRL|KEYC_SHIFT,	TTYKEY_RAW },
258 	{ 0,	"\033[13@",	KEYC_F3|KEYC_CTRL|KEYC_SHIFT,	TTYKEY_RAW },
259 	{ 0,	"\033[14@",	KEYC_F4|KEYC_CTRL|KEYC_SHIFT,	TTYKEY_RAW },
260 	{ 0,	"\033[15@",	KEYC_F5|KEYC_CTRL|KEYC_SHIFT,	TTYKEY_RAW },
261 	{ 0,	"\033[17@",	KEYC_F6|KEYC_CTRL|KEYC_SHIFT,	TTYKEY_RAW },
262 	{ 0,	"\033[18@",	KEYC_F7|KEYC_CTRL|KEYC_SHIFT,	TTYKEY_RAW },
263 	{ 0,	"\033[19@",	KEYC_F8|KEYC_CTRL|KEYC_SHIFT,	TTYKEY_RAW },
264 	{ 0,	"\033[20@",	KEYC_F9|KEYC_CTRL|KEYC_SHIFT,	TTYKEY_RAW },
265 	{ 0,	"\033[21@",	KEYC_F10|KEYC_CTRL|KEYC_SHIFT,	TTYKEY_RAW },
266 	{ 0,	"\033[23@",	KEYC_F11|KEYC_CTRL|KEYC_SHIFT,	TTYKEY_RAW },
267 	{ 0,	"\033[24@",	KEYC_F12|KEYC_CTRL|KEYC_SHIFT,	TTYKEY_RAW },
268 	{ 0,	"\033[25@",	KEYC_F13|KEYC_CTRL|KEYC_SHIFT,	TTYKEY_RAW },
269 	{ 0,	"\033[26@",	KEYC_F14|KEYC_CTRL|KEYC_SHIFT,	TTYKEY_RAW },
270 	{ 0,	"\033[28@",	KEYC_F15|KEYC_CTRL|KEYC_SHIFT,	TTYKEY_RAW },
271 	{ 0,	"\033[29@",	KEYC_F16|KEYC_CTRL|KEYC_SHIFT,	TTYKEY_RAW },
272 	{ 0,	"\033[31@",	KEYC_F17|KEYC_CTRL|KEYC_SHIFT,	TTYKEY_RAW },
273 	{ 0,	"\033[32@",	KEYC_F18|KEYC_CTRL|KEYC_SHIFT,	TTYKEY_RAW },
274 	{ 0,	"\033[33@",	KEYC_F19|KEYC_CTRL|KEYC_SHIFT,	TTYKEY_RAW },
275 	{ 0,	"\033[34@",	KEYC_F20|KEYC_CTRL|KEYC_SHIFT,	TTYKEY_RAW },
276 	{ 0,	"\033[2@",	KEYC_IC|KEYC_CTRL|KEYC_SHIFT,	TTYKEY_RAW },
277 	{ 0,	"\033[3@",	KEYC_DC|KEYC_CTRL|KEYC_SHIFT,	TTYKEY_RAW },
278 	{ 0,	"\033[7@",	KEYC_HOME|KEYC_CTRL|KEYC_SHIFT,	TTYKEY_RAW },
279 	{ 0,	"\033[8@",	KEYC_END|KEYC_CTRL|KEYC_SHIFT,	TTYKEY_RAW },
280 	{ 0,	"\033[6@",	KEYC_NPAGE|KEYC_CTRL|KEYC_SHIFT,TTYKEY_RAW },
281 	{ 0,	"\033[5@",	KEYC_PPAGE|KEYC_CTRL|KEYC_SHIFT,TTYKEY_RAW },
282 };
283 
284 void
285 tty_keys_add(struct tty *tty, const char *s, int key)
286 {
287 	size_t	size;
288 
289 	if (tty_keys_find(tty, s, strlen(s), &size) == NULL) {
290 		log_debug("new key 0x%x: %s", key, s);
291 		tty_keys_add1(&tty->key_tree, s, key);
292 	}
293 }
294 
295 /* Add next node to the tree. */
296 void
297 tty_keys_add1(struct tty_key **tkp, const char *s, int key)
298 {
299 	struct tty_key	*tk;
300 
301 	/* Allocate a tree entry if there isn't one already. */
302 	tk = *tkp;
303 	if (tk == NULL) {
304 		tk = *tkp = xcalloc(1, sizeof *tk);
305 		tk->ch = *s;
306 		tk->key = KEYC_NONE;
307 	}
308 
309 	/* Find the next entry. */
310 	if (*s == tk->ch) {
311 		/* Move forward in string. */
312 		s++;
313 
314 		/* If this is the end of the string, no more is necessary. */
315 		if (*s == '\0') {
316 			tk->key = key;
317 			return;
318 		}
319 
320 		/* Use the child tree for the next character. */
321 		tkp = &tk->next;
322 	} else {
323 		if (*s < tk->ch)
324 			tkp = &tk->left;
325 		else if (*s > tk->ch)
326 			tkp = &tk->right;
327 	}
328 
329 	/* And recurse to add it. */
330 	tty_keys_add1(tkp, s, key);
331 }
332 
333 /* Initialise a key tree from the table. */
334 void
335 tty_keys_init(struct tty *tty)
336 {
337 	struct tty_key_ent	*tke;
338 	u_int		 	 i;
339 	const char		*s;
340 
341 	tty->key_tree = NULL;
342 	for (i = 0; i < nitems(tty_keys); i++) {
343 		tke = &tty_keys[i];
344 
345 		if (tke->flags & TTYKEY_RAW)
346 			s = tke->string;
347 		else {
348 			if (!tty_term_has(tty->term, tke->code))
349 				continue;
350 			s = tty_term_string(tty->term, tke->code);
351 		}
352 		if (s[0] != '\033' || s[1] == '\0')
353 			continue;
354 
355 		tty_keys_add(tty, s + 1, tke->key);
356 	}
357 }
358 
359 /* Free the entire key tree. */
360 void
361 tty_keys_free(struct tty *tty)
362 {
363 	tty_keys_free1(tty->key_tree);
364 }
365 
366 /* Free a single key. */
367 void
368 tty_keys_free1(struct tty_key *tk)
369 {
370 	if (tk->next != NULL)
371 		tty_keys_free1(tk->next);
372 	if (tk->left != NULL)
373 		tty_keys_free1(tk->left);
374 	if (tk->right != NULL)
375 		tty_keys_free1(tk->right);
376 	xfree(tk);
377 
378 }
379 
380 /* Lookup a key in the tree. */
381 struct tty_key *
382 tty_keys_find(struct tty *tty, const char *buf, size_t len, size_t *size)
383 {
384 	*size = 0;
385 	return (tty_keys_find1(tty->key_tree, buf, len, size));
386 }
387 
388 /* Find the next node. */
389 struct tty_key *
390 tty_keys_find1(struct tty_key *tk, const char *buf, size_t len, size_t *size)
391 {
392 	/* If the node is NULL, this is the end of the tree. No match. */
393 	if (tk == NULL)
394 		return (NULL);
395 
396 	/* Pick the next in the sequence. */
397 	if (tk->ch == *buf) {
398 		/* Move forward in the string. */
399 		buf++; len--;
400 		(*size)++;
401 
402 		/* At the end of the string, return the current node. */
403 		if (len == 0)
404 			return (tk);
405 
406 		/* Move into the next tree for the following character. */
407 		tk = tk->next;
408 	} else {
409 		if (*buf < tk->ch)
410 			tk = tk->left;
411 		else if (*buf > tk->ch)
412 			tk = tk->right;
413 	}
414 
415 	/* Move to the next in the tree. */
416 	return (tty_keys_find1(tk, buf, len, size));
417 }
418 
419 /*
420  * Process at least one key in the buffer and invoke tty->key_callback. Return
421  * 1 if there are no further keys, or 0 if there is more in the buffer.
422  */
423 int
424 tty_keys_next(struct tty *tty)
425 {
426 	struct tty_key		*tk;
427 	struct timeval		 tv;
428 	struct mouse_event	 mouse;
429 	const char		*buf;
430 	size_t			 len, size;
431 	cc_t			 bspace;
432 	int			 key;
433 
434 	buf = EVBUFFER_DATA(tty->event->input);
435 	len = EVBUFFER_LENGTH(tty->event->input);
436 	if (len == 0)
437 		return (0);
438 	log_debug("keys are %zu (%.*s)", len, (int) len, buf);
439 
440 	/* If a normal key, return it. */
441 	if (*buf != '\033') {
442 		key = (u_char) *buf;
443 		evbuffer_drain(tty->event->input, 1);
444 
445 		/*
446 		 * Check for backspace key using termios VERASE - the terminfo
447 		 * kbs entry is extremely unreliable, so cannot be safely
448 		 * used. termios should have a better idea.
449 		 */
450 		bspace = tty->tio.c_cc[VERASE];
451 		if (bspace != _POSIX_VDISABLE && key == bspace)
452 			key = KEYC_BSPACE;
453 		goto handle_key;
454 	}
455 
456 	/* Look for matching key string and return if found. */
457 	tk = tty_keys_find(tty, buf + 1, len - 1, &size);
458 	if (tk != NULL) {
459 		key = tk->key;
460 		goto found_key;
461 	}
462 
463 	/* Not found. Is this a mouse key press? */
464 	key = tty_keys_mouse(buf, len, &size, &mouse);
465 	if (key != KEYC_NONE) {
466 		evbuffer_drain(tty->event->input, size);
467 		goto handle_key;
468 	}
469 
470 	/* Not found. Try to parse a key with an xterm-style modifier. */
471 	key = xterm_keys_find(buf, len, &size);
472 	if (key != KEYC_NONE) {
473 		evbuffer_drain(tty->event->input, size);
474 		goto handle_key;
475 	}
476 
477 	/* Skip the escape. */
478 	buf++;
479 	len--;
480 
481 	/* Is there a normal key following? */
482 	if (len != 0 && *buf != '\033') {
483 		key = *buf | KEYC_ESCAPE;
484 		evbuffer_drain(tty->event->input, 2);
485 		goto handle_key;
486 	}
487 
488 	/* Or a key string? */
489 	if (len > 1) {
490 		tk = tty_keys_find(tty, buf + 1, len - 1, &size);
491 		if (tk != NULL) {
492 			key = tk->key | KEYC_ESCAPE;
493 			size++;	/* include escape */
494 			goto found_key;
495 		}
496 	}
497 
498 	/* Escape and then nothing useful - fall through. */
499 
500 partial_key:
501 	/*
502 	 * Escape but no key string. If have already seen an escape, then the
503 	 * timer must have expired, so give up waiting and send the escape.
504 	 */
505 	if (tty->flags & TTY_ESCAPE) {
506 		evbuffer_drain(tty->event->input, 1);
507 		key = '\033';
508 		goto handle_key;
509 	}
510 
511 	/* Fall through to start the timer. */
512 
513 start_timer:
514 	/* Start the timer and wait for expiry or more data. */
515 	tv.tv_sec = 0;
516 	tv.tv_usec = ESCAPE_PERIOD * 1000L;
517 
518 	evtimer_del(&tty->key_timer);
519 	evtimer_set(&tty->key_timer, tty_keys_callback, tty);
520 	evtimer_add(&tty->key_timer, &tv);
521 
522 	tty->flags |= TTY_ESCAPE;
523 	return (0);
524 
525 found_key:
526 	if (tk->next != NULL) {
527 		/* Partial key. Start the timer if not already expired. */
528 		if (!(tty->flags & TTY_ESCAPE))
529 			goto start_timer;
530 
531 		/* Otherwise, if no key, send the escape alone. */
532 		if (tk->key == KEYC_NONE)
533 			goto partial_key;
534 
535 		/* Or fall through to send the partial key found. */
536 	}
537 	evbuffer_drain(tty->event->input, size + 1);
538 
539 	goto handle_key;
540 
541 handle_key:
542  	evtimer_del(&tty->key_timer);
543 
544 	tty->key_callback(key, &mouse, tty->key_data);
545 
546 	tty->flags &= ~TTY_ESCAPE;
547 	return (1);
548 }
549 
550 /* Key timer callback. */
551 void
552 tty_keys_callback(unused int fd, unused short events, void *data)
553 {
554 	struct tty	*tty = data;
555 
556 	if (!(tty->flags & TTY_ESCAPE))
557 		return;
558 
559 	while (tty_keys_next(tty))
560 		;
561 }
562 
563 /* Handle mouse key input. */
564 int
565 tty_keys_mouse(const char *buf, size_t len, size_t *size, struct mouse_event *m)
566 {
567 	/*
568 	 * Mouse sequences are \033[M followed by three characters indicating
569 	 * buttons, X and Y, all based at 32 with 1,1 top-left.
570 	 */
571 
572 	if (len != 6 || memcmp(buf, "\033[M", 3) != 0)
573 		return (KEYC_NONE);
574 	*size = 6;
575 
576 	log_debug("mouse input is: %.*s", (int) len, buf);
577 
578 	m->b = buf[3];
579 	m->x = buf[4];
580 	m->y = buf[5];
581 	if (m->b < 32 || m->x < 33 || m->y < 33)
582 		return (KEYC_NONE);
583 	m->b -= 32;
584 	m->x -= 33;
585 	m->y -= 33;
586 	return (KEYC_MOUSE);
587 }
588