?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Add window-status-separator option, from Thomas Adam.
[tmux-openbsd.git] / tty-keys.c
blobddd113e2b4681363b2211d77e0a4f569c45bbdd5
1 /* $OpenBSD$ */
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 <limits.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <termios.h>
26 #include <unistd.h>
27
28 #include "tmux.h"
29
30 /*
31 * Handle keys input from the outside terminal. tty_keys[] is a base table of
32 * supported keys which are looked up in terminfo(5) and translated into a
33 * ternary tree (a binary tree of binary trees).
34 */
35
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(
40 struct tty_key *, const char *, size_t, size_t *);
41 struct tty_key *tty_keys_find(struct tty *, const char *, size_t, size_t *);
42 void tty_keys_callback(int, short, void *);
43 int tty_keys_mouse(struct tty *,
44 const char *, size_t, size_t *, struct mouse_event *);
45 int tty_keys_device(struct tty *, const char *, size_t, size_t *);
46
47 struct tty_key_ent {
48 enum tty_code_code code;
49 const char *string;
50
51 int key;
52 int flags;
53 #define TTYKEY_RAW 0x1
54 };
55
56 /*
57 * Default key tables. Those flagged with TTYKEY_RAW are inserted directly,
58 * otherwise they are looked up in terminfo(5).
59 */
60 const struct tty_key_ent tty_keys[] = {
61 /*
62 * Numeric keypad. Just use the vt100 escape sequences here and always
63 * put the terminal into keypad_xmit mode. Translation of numbers
64 * mode/applications mode is done in input-keys.c.
65 */
66 { 0, "\033Oo", KEYC_KP_SLASH, TTYKEY_RAW },
67 { 0, "\033Oj", KEYC_KP_STAR, TTYKEY_RAW },
68 { 0, "\033Om", KEYC_KP_MINUS, TTYKEY_RAW },
69 { 0, "\033Ow", KEYC_KP_SEVEN, TTYKEY_RAW },
70 { 0, "\033Ox", KEYC_KP_EIGHT, TTYKEY_RAW },
71 { 0, "\033Oy", KEYC_KP_NINE, TTYKEY_RAW },
72 { 0, "\033Ok", KEYC_KP_PLUS, TTYKEY_RAW },
73 { 0, "\033Ot", KEYC_KP_FOUR, TTYKEY_RAW },
74 { 0, "\033Ou", KEYC_KP_FIVE, TTYKEY_RAW },
75 { 0, "\033Ov", KEYC_KP_SIX, TTYKEY_RAW },
76 { 0, "\033Oq", KEYC_KP_ONE, TTYKEY_RAW },
77 { 0, "\033Or", KEYC_KP_TWO, TTYKEY_RAW },
78 { 0, "\033Os", KEYC_KP_THREE, TTYKEY_RAW },
79 { 0, "\033OM", KEYC_KP_ENTER, TTYKEY_RAW },
80 { 0, "\033Op", KEYC_KP_ZERO, TTYKEY_RAW },
81 { 0, "\033On", KEYC_KP_PERIOD, TTYKEY_RAW },
82
83 /* Arrow keys. */
84 { 0, "\033OA", KEYC_UP, TTYKEY_RAW },
85 { 0, "\033OB", KEYC_DOWN, TTYKEY_RAW },
86 { 0, "\033OC", KEYC_RIGHT, TTYKEY_RAW },
87 { 0, "\033OD", KEYC_LEFT, TTYKEY_RAW },
88
89 { 0, "\033[A", KEYC_UP, TTYKEY_RAW },
90 { 0, "\033[B", KEYC_DOWN, TTYKEY_RAW },
91 { 0, "\033[C", KEYC_RIGHT, TTYKEY_RAW },
92 { 0, "\033[D", KEYC_LEFT, TTYKEY_RAW },
93
94 /* rxvt-style arrow + modifier keys. */
95 { 0, "\033Oa", KEYC_UP|KEYC_CTRL, TTYKEY_RAW },
96 { 0, "\033Ob", KEYC_DOWN|KEYC_CTRL, TTYKEY_RAW },
97 { 0, "\033Oc", KEYC_RIGHT|KEYC_CTRL, TTYKEY_RAW },
98 { 0, "\033Od", KEYC_LEFT|KEYC_CTRL, TTYKEY_RAW },
99
100 { 0, "\033[a", KEYC_UP|KEYC_SHIFT, TTYKEY_RAW },
101 { 0, "\033[b", KEYC_DOWN|KEYC_SHIFT, TTYKEY_RAW },
102 { 0, "\033[c", KEYC_RIGHT|KEYC_SHIFT, TTYKEY_RAW },
103 { 0, "\033[d", KEYC_LEFT|KEYC_SHIFT, TTYKEY_RAW },
104
105 /*
106 * rxvt-style function + modifier keys:
107 * Ctrl = ^, Shift = $, Ctrl+Shift = @
108 */
109 { 0, "\033[11^", KEYC_F1|KEYC_CTRL, TTYKEY_RAW },
110 { 0, "\033[12^", KEYC_F2|KEYC_CTRL, TTYKEY_RAW },
111 { 0, "\033[13^", KEYC_F3|KEYC_CTRL, TTYKEY_RAW },
112 { 0, "\033[14^", KEYC_F4|KEYC_CTRL, TTYKEY_RAW },
113 { 0, "\033[15^", KEYC_F5|KEYC_CTRL, TTYKEY_RAW },
114 { 0, "\033[17^", KEYC_F6|KEYC_CTRL, TTYKEY_RAW },
115 { 0, "\033[18^", KEYC_F7|KEYC_CTRL, TTYKEY_RAW },
116 { 0, "\033[19^", KEYC_F8|KEYC_CTRL, TTYKEY_RAW },
117 { 0, "\033[20^", KEYC_F9|KEYC_CTRL, TTYKEY_RAW },
118 { 0, "\033[21^", KEYC_F10|KEYC_CTRL, TTYKEY_RAW },
119 { 0, "\033[23^", KEYC_F11|KEYC_CTRL, TTYKEY_RAW },
120 { 0, "\033[24^", KEYC_F12|KEYC_CTRL, TTYKEY_RAW },
121 { 0, "\033[25^", KEYC_F13|KEYC_CTRL, TTYKEY_RAW },
122 { 0, "\033[26^", KEYC_F14|KEYC_CTRL, TTYKEY_RAW },
123 { 0, "\033[28^", KEYC_F15|KEYC_CTRL, TTYKEY_RAW },
124 { 0, "\033[29^", KEYC_F16|KEYC_CTRL, TTYKEY_RAW },
125 { 0, "\033[31^", KEYC_F17|KEYC_CTRL, TTYKEY_RAW },
126 { 0, "\033[32^", KEYC_F18|KEYC_CTRL, TTYKEY_RAW },
127 { 0, "\033[33^", KEYC_F19|KEYC_CTRL, TTYKEY_RAW },
128 { 0, "\033[34^", KEYC_F20|KEYC_CTRL, TTYKEY_RAW },
129 { 0, "\033[2^", KEYC_IC|KEYC_CTRL, TTYKEY_RAW },
130 { 0, "\033[3^", KEYC_DC|KEYC_CTRL, TTYKEY_RAW },
131 { 0, "\033[7^", KEYC_HOME|KEYC_CTRL, TTYKEY_RAW },
132 { 0, "\033[8^", KEYC_END|KEYC_CTRL, TTYKEY_RAW },
133 { 0, "\033[6^", KEYC_NPAGE|KEYC_CTRL, TTYKEY_RAW },
134 { 0, "\033[5^", KEYC_PPAGE|KEYC_CTRL, TTYKEY_RAW },
135
136 { 0, "\033[11$", KEYC_F1|KEYC_SHIFT, TTYKEY_RAW },
137 { 0, "\033[12$", KEYC_F2|KEYC_SHIFT, TTYKEY_RAW },
138 { 0, "\033[13$", KEYC_F3|KEYC_SHIFT, TTYKEY_RAW },
139 { 0, "\033[14$", KEYC_F4|KEYC_SHIFT, TTYKEY_RAW },
140 { 0, "\033[15$", KEYC_F5|KEYC_SHIFT, TTYKEY_RAW },
141 { 0, "\033[17$", KEYC_F6|KEYC_SHIFT, TTYKEY_RAW },
142 { 0, "\033[18$", KEYC_F7|KEYC_SHIFT, TTYKEY_RAW },
143 { 0, "\033[19$", KEYC_F8|KEYC_SHIFT, TTYKEY_RAW },
144 { 0, "\033[20$", KEYC_F9|KEYC_SHIFT, TTYKEY_RAW },
145 { 0, "\033[21$", KEYC_F10|KEYC_SHIFT, TTYKEY_RAW },
146 { 0, "\033[23$", KEYC_F11|KEYC_SHIFT, TTYKEY_RAW },
147 { 0, "\033[24$", KEYC_F12|KEYC_SHIFT, TTYKEY_RAW },
148 { 0, "\033[25$", KEYC_F13|KEYC_SHIFT, TTYKEY_RAW },
149 { 0, "\033[26$", KEYC_F14|KEYC_SHIFT, TTYKEY_RAW },
150 { 0, "\033[28$", KEYC_F15|KEYC_SHIFT, TTYKEY_RAW },
151 { 0, "\033[29$", KEYC_F16|KEYC_SHIFT, TTYKEY_RAW },
152 { 0, "\033[31$", KEYC_F17|KEYC_SHIFT, TTYKEY_RAW },
153 { 0, "\033[32$", KEYC_F18|KEYC_SHIFT, TTYKEY_RAW },
154 { 0, "\033[33$", KEYC_F19|KEYC_SHIFT, TTYKEY_RAW },
155 { 0, "\033[34$", KEYC_F20|KEYC_SHIFT, TTYKEY_RAW },
156 { 0, "\033[2$", KEYC_IC|KEYC_SHIFT, TTYKEY_RAW },
157 { 0, "\033[3$", KEYC_DC|KEYC_SHIFT, TTYKEY_RAW },
158 { 0, "\033[7$", KEYC_HOME|KEYC_SHIFT, TTYKEY_RAW },
159 { 0, "\033[8$", KEYC_END|KEYC_SHIFT, TTYKEY_RAW },
160 { 0, "\033[6$", KEYC_NPAGE|KEYC_SHIFT, TTYKEY_RAW },
161 { 0, "\033[5$", KEYC_PPAGE|KEYC_SHIFT, TTYKEY_RAW },
162
163 { 0, "\033[11@", KEYC_F1|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW },
164 { 0, "\033[12@", KEYC_F2|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW },
165 { 0, "\033[13@", KEYC_F3|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW },
166 { 0, "\033[14@", KEYC_F4|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW },
167 { 0, "\033[15@", KEYC_F5|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW },
168 { 0, "\033[17@", KEYC_F6|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW },
169 { 0, "\033[18@", KEYC_F7|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW },
170 { 0, "\033[19@", KEYC_F8|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW },
171 { 0, "\033[20@", KEYC_F9|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW },
172 { 0, "\033[21@", KEYC_F10|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW },
173 { 0, "\033[23@", KEYC_F11|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW },
174 { 0, "\033[24@", KEYC_F12|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW },
175 { 0, "\033[25@", KEYC_F13|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW },
176 { 0, "\033[26@", KEYC_F14|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW },
177 { 0, "\033[28@", KEYC_F15|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW },
178 { 0, "\033[29@", KEYC_F16|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW },
179 { 0, "\033[31@", KEYC_F17|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW },
180 { 0, "\033[32@", KEYC_F18|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW },
181 { 0, "\033[33@", KEYC_F19|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW },
182 { 0, "\033[34@", KEYC_F20|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW },
183 { 0, "\033[2@", KEYC_IC|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW },
184 { 0, "\033[3@", KEYC_DC|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW },
185 { 0, "\033[7@", KEYC_HOME|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW },
186 { 0, "\033[8@", KEYC_END|KEYC_CTRL|KEYC_SHIFT, TTYKEY_RAW },
187 { 0, "\033[6@", KEYC_NPAGE|KEYC_CTRL|KEYC_SHIFT,TTYKEY_RAW },
188 { 0, "\033[5@", KEYC_PPAGE|KEYC_CTRL|KEYC_SHIFT,TTYKEY_RAW },
189
190 /* terminfo lookups below this line so they can override raw keys. */
191
192 /* Function keys. */
193 { TTYC_KF1, NULL, KEYC_F1, 0 },
194 { TTYC_KF2, NULL, KEYC_F2, 0 },
195 { TTYC_KF3, NULL, KEYC_F3, 0 },
196 { TTYC_KF4, NULL, KEYC_F4, 0 },
197 { TTYC_KF5, NULL, KEYC_F5, 0 },
198 { TTYC_KF6, NULL, KEYC_F6, 0 },
199 { TTYC_KF7, NULL, KEYC_F7, 0 },
200 { TTYC_KF8, NULL, KEYC_F8, 0 },
201 { TTYC_KF9, NULL, KEYC_F9, 0 },
202 { TTYC_KF10, NULL, KEYC_F10, 0 },
203 { TTYC_KF11, NULL, KEYC_F11, 0 },
204 { TTYC_KF12, NULL, KEYC_F12, 0 },
205 { TTYC_KF13, NULL, KEYC_F13, 0 },
206 { TTYC_KF14, NULL, KEYC_F14, 0 },
207 { TTYC_KF15, NULL, KEYC_F15, 0 },
208 { TTYC_KF16, NULL, KEYC_F16, 0 },
209 { TTYC_KF17, NULL, KEYC_F17, 0 },
210 { TTYC_KF18, NULL, KEYC_F18, 0 },
211 { TTYC_KF19, NULL, KEYC_F19, 0 },
212 { TTYC_KF20, NULL, KEYC_F20, 0 },
213 { TTYC_KICH1, NULL, KEYC_IC, 0 },
214 { TTYC_KDCH1, NULL, KEYC_DC, 0 },
215 { TTYC_KHOME, NULL, KEYC_HOME, 0 },
216 { TTYC_KEND, NULL, KEYC_END, 0 },
217 { TTYC_KNP, NULL, KEYC_NPAGE, 0 },
218 { TTYC_KPP, NULL, KEYC_PPAGE, 0 },
219 { TTYC_KCBT, NULL, KEYC_BTAB, 0 },
220
221 /* Arrow keys from terminfo. */
222 { TTYC_KCUU1, NULL, KEYC_UP, 0 },
223 { TTYC_KCUD1, NULL, KEYC_DOWN, 0 },
224 { TTYC_KCUB1, NULL, KEYC_LEFT, 0 },
225 { TTYC_KCUF1, NULL, KEYC_RIGHT, 0 },
226
227 /* Key and modifier capabilities. */
228 { TTYC_KDC2, NULL, KEYC_DC|KEYC_SHIFT, 0 },
229 { TTYC_KDC3, NULL, KEYC_DC|KEYC_ESCAPE, 0 },
230 { TTYC_KDC4, NULL, KEYC_DC|KEYC_SHIFT|KEYC_ESCAPE, 0 },
231 { TTYC_KDC5, NULL, KEYC_DC|KEYC_CTRL, 0 },
232 { TTYC_KDC6, NULL, KEYC_DC|KEYC_SHIFT|KEYC_CTRL, 0 },
233 { TTYC_KDC7, NULL, KEYC_DC|KEYC_ESCAPE|KEYC_CTRL, 0 },
234 { TTYC_KDN2, NULL, KEYC_DOWN|KEYC_SHIFT, 0 },
235 { TTYC_KDN3, NULL, KEYC_DOWN|KEYC_ESCAPE, 0 },
236 { TTYC_KDN4, NULL, KEYC_DOWN|KEYC_SHIFT|KEYC_ESCAPE, 0 },
237 { TTYC_KDN5, NULL, KEYC_DOWN|KEYC_CTRL, 0 },
238 { TTYC_KDN6, NULL, KEYC_DOWN|KEYC_SHIFT|KEYC_CTRL, 0 },
239 { TTYC_KDN7, NULL, KEYC_DOWN|KEYC_ESCAPE|KEYC_CTRL, 0 },
240 { TTYC_KEND2, NULL, KEYC_END|KEYC_SHIFT, 0 },
241 { TTYC_KEND3, NULL, KEYC_END|KEYC_ESCAPE, 0 },
242 { TTYC_KEND4, NULL, KEYC_END|KEYC_SHIFT|KEYC_ESCAPE, 0 },
243 { TTYC_KEND5, NULL, KEYC_END|KEYC_CTRL, 0 },
244 { TTYC_KEND6, NULL, KEYC_END|KEYC_SHIFT|KEYC_CTRL, 0 },
245 { TTYC_KEND7, NULL, KEYC_END|KEYC_ESCAPE|KEYC_CTRL, 0 },
246 { TTYC_KHOM2, NULL, KEYC_HOME|KEYC_SHIFT, 0 },
247 { TTYC_KHOM3, NULL, KEYC_HOME|KEYC_ESCAPE, 0 },
248 { TTYC_KHOM4, NULL, KEYC_HOME|KEYC_SHIFT|KEYC_ESCAPE, 0 },
249 { TTYC_KHOM5, NULL, KEYC_HOME|KEYC_CTRL, 0 },
250 { TTYC_KHOM6, NULL, KEYC_HOME|KEYC_SHIFT|KEYC_CTRL, 0 },
251 { TTYC_KHOM7, NULL, KEYC_HOME|KEYC_ESCAPE|KEYC_CTRL, 0 },
252 { TTYC_KIC2, NULL, KEYC_IC|KEYC_SHIFT, 0 },
253 { TTYC_KIC3, NULL, KEYC_IC|KEYC_ESCAPE, 0 },
254 { TTYC_KIC4, NULL, KEYC_IC|KEYC_SHIFT|KEYC_ESCAPE, 0 },
255 { TTYC_KIC5, NULL, KEYC_IC|KEYC_CTRL, 0 },
256 { TTYC_KIC6, NULL, KEYC_IC|KEYC_SHIFT|KEYC_CTRL, 0 },
257 { TTYC_KIC7, NULL, KEYC_IC|KEYC_ESCAPE|KEYC_CTRL, 0 },
258 { TTYC_KLFT2, NULL, KEYC_LEFT|KEYC_SHIFT, 0 },
259 { TTYC_KLFT3, NULL, KEYC_LEFT|KEYC_ESCAPE, 0 },
260 { TTYC_KLFT4, NULL, KEYC_LEFT|KEYC_SHIFT|KEYC_ESCAPE, 0 },
261 { TTYC_KLFT5, NULL, KEYC_LEFT|KEYC_CTRL, 0 },
262 { TTYC_KLFT6, NULL, KEYC_LEFT|KEYC_SHIFT|KEYC_CTRL, 0 },
263 { TTYC_KLFT7, NULL, KEYC_LEFT|KEYC_ESCAPE|KEYC_CTRL, 0 },
264 { TTYC_KNXT2, NULL, KEYC_NPAGE|KEYC_SHIFT, 0 },
265 { TTYC_KNXT3, NULL, KEYC_NPAGE|KEYC_ESCAPE, 0 },
266 { TTYC_KNXT4, NULL, KEYC_NPAGE|KEYC_SHIFT|KEYC_ESCAPE, 0 },
267 { TTYC_KNXT5, NULL, KEYC_NPAGE|KEYC_CTRL, 0 },
268 { TTYC_KNXT6, NULL, KEYC_NPAGE|KEYC_SHIFT|KEYC_CTRL, 0 },
269 { TTYC_KNXT7, NULL, KEYC_NPAGE|KEYC_ESCAPE|KEYC_CTRL, 0 },
270 { TTYC_KPRV2, NULL, KEYC_PPAGE|KEYC_SHIFT, 0 },
271 { TTYC_KPRV3, NULL, KEYC_PPAGE|KEYC_ESCAPE, 0 },
272 { TTYC_KPRV4, NULL, KEYC_PPAGE|KEYC_SHIFT|KEYC_ESCAPE, 0 },
273 { TTYC_KPRV5, NULL, KEYC_PPAGE|KEYC_CTRL, 0 },
274 { TTYC_KPRV6, NULL, KEYC_PPAGE|KEYC_SHIFT|KEYC_CTRL, 0 },
275 { TTYC_KPRV7, NULL, KEYC_PPAGE|KEYC_ESCAPE|KEYC_CTRL, 0 },
276 { TTYC_KRIT2, NULL, KEYC_RIGHT|KEYC_SHIFT, 0 },
277 { TTYC_KRIT3, NULL, KEYC_RIGHT|KEYC_ESCAPE, 0 },
278 { TTYC_KRIT4, NULL, KEYC_RIGHT|KEYC_SHIFT|KEYC_ESCAPE, 0 },
279 { TTYC_KRIT5, NULL, KEYC_RIGHT|KEYC_CTRL, 0 },
280 { TTYC_KRIT6, NULL, KEYC_RIGHT|KEYC_SHIFT|KEYC_CTRL, 0 },
281 { TTYC_KRIT7, NULL, KEYC_RIGHT|KEYC_ESCAPE|KEYC_CTRL, 0 },
282 { TTYC_KUP2, NULL, KEYC_UP|KEYC_SHIFT, 0 },
283 { TTYC_KUP3, NULL, KEYC_UP|KEYC_ESCAPE, 0 },
284 { TTYC_KUP4, NULL, KEYC_UP|KEYC_SHIFT|KEYC_ESCAPE, 0 },
285 { TTYC_KUP5, NULL, KEYC_UP|KEYC_CTRL, 0 },
286 { TTYC_KUP6, NULL, KEYC_UP|KEYC_SHIFT|KEYC_CTRL, 0 },
287 { TTYC_KUP7, NULL, KEYC_UP|KEYC_ESCAPE|KEYC_CTRL, 0 },
288 };
289
290 void
291 tty_keys_add(struct tty *tty, const char *s, int key)
292 {
293 struct tty_key *tk;
294 size_t size;
295 const char *keystr;
296
297 keystr = key_string_lookup_key(key);
298 if ((tk = tty_keys_find(tty, s, strlen(s), &size)) == NULL) {
299 log_debug("new key %s: 0x%x (%s)", s, key, keystr);
300 tty_keys_add1(&tty->key_tree, s, key);
301 } else {
302 log_debug("replacing key %s: 0x%x (%s)", s, key, keystr);
303 tk->key = key;
304 }
305 }
306
307 /* Add next node to the tree. */
308 void
309 tty_keys_add1(struct tty_key **tkp, const char *s, int key)
310 {
311 struct tty_key *tk;
312
313 /* Allocate a tree entry if there isn't one already. */
314 tk = *tkp;
315 if (tk == NULL) {
316 tk = *tkp = xcalloc(1, sizeof *tk);
317 tk->ch = *s;
318 tk->key = KEYC_NONE;
319 }
320
321 /* Find the next entry. */
322 if (*s == tk->ch) {
323 /* Move forward in string. */
324 s++;
325
326 /* If this is the end of the string, no more is necessary. */
327 if (*s == '\0') {
328 tk->key = key;
329 return;
330 }
331
332 /* Use the child tree for the next character. */
333 tkp = &tk->next;
334 } else {
335 if (*s < tk->ch)
336 tkp = &tk->left;
337 else if (*s > tk->ch)
338 tkp = &tk->right;
339 }
340
341 /* And recurse to add it. */
342 tty_keys_add1(tkp, s, key);
343 }
344
345 /* Initialise a key tree from the table. */
346 void
347 tty_keys_init(struct tty *tty)
348 {
349 const struct tty_key_ent *tke;
350 u_int i;
351 const char *s;
352
353 tty->key_tree = NULL;
354 for (i = 0; i < nitems(tty_keys); i++) {
355 tke = &tty_keys[i];
356
357 if (tke->flags & TTYKEY_RAW)
358 s = tke->string;
359 else {
360 if (!tty_term_has(tty->term, tke->code))
361 continue;
362 s = tty_term_string(tty->term, tke->code);
363 }
364 if (s[0] != '\033' || s[1] == '\0')
365 continue;
366
367 tty_keys_add(tty, s + 1, tke->key);
368 }
369 }
370
371 /* Free the entire key tree. */
372 void
373 tty_keys_free(struct tty *tty)
374 {
375 tty_keys_free1(tty->key_tree);
376 }
377
378 /* Free a single key. */
379 void
380 tty_keys_free1(struct tty_key *tk)
381 {
382 if (tk->next != NULL)
383 tty_keys_free1(tk->next);
384 if (tk->left != NULL)
385 tty_keys_free1(tk->left);
386 if (tk->right != NULL)
387 tty_keys_free1(tk->right);
388 xfree(tk);
389 }
390
391 /* Lookup a key in the tree. */
392 struct tty_key *
393 tty_keys_find(struct tty *tty, const char *buf, size_t len, size_t *size)
394 {
395 *size = 0;
396 return (tty_keys_find1(tty->key_tree, buf, len, size));
397 }
398
399 /* Find the next node. */
400 struct tty_key *
401 tty_keys_find1(struct tty_key *tk, const char *buf, size_t len, size_t *size)
402 {
403 /* If the node is NULL, this is the end of the tree. No match. */
404 if (tk == NULL)
405 return (NULL);
406
407 /* Pick the next in the sequence. */
408 if (tk->ch == *buf) {
409 /* Move forward in the string. */
410 buf++; len--;
411 (*size)++;
412
413 /* At the end of the string, return the current node. */
414 if (len == 0 || (tk->next == NULL && tk->key != KEYC_NONE))
415 return (tk);
416
417 /* Move into the next tree for the following character. */
418 tk = tk->next;
419 } else {
420 if (*buf < tk->ch)
421 tk = tk->left;
422 else if (*buf > tk->ch)
423 tk = tk->right;
424 }
425
426 /* Move to the next in the tree. */
427 return (tty_keys_find1(tk, buf, len, size));
428 }
429
430 /*
431 * Process at least one key in the buffer and invoke tty->key_callback. Return
432 * 0 if there are no further keys, or 1 if there could be more in the buffer.
433 */
434 int
435 tty_keys_next(struct tty *tty)
436 {
437 struct tty_key *tk;
438 struct timeval tv;
439 struct mouse_event mouse;
440 const char *buf;
441 size_t len, size;
442 cc_t bspace;
443 int key, delay;
444
445 buf = EVBUFFER_DATA(tty->event->input);
446 len = EVBUFFER_LENGTH(tty->event->input);
447 if (len == 0)
448 return (0);
449 log_debug("keys are %zu (%.*s)", len, (int) len, buf);
450
451 /* If a normal key, return it. */
452 if (*buf != '\033') {
453 key = (u_char) *buf;
454 evbuffer_drain(tty->event->input, 1);
455
456 /*
457 * Check for backspace key using termios VERASE - the terminfo
458 * kbs entry is extremely unreliable, so cannot be safely
459 * used. termios should have a better idea.
460 */
461 bspace = tty->tio.c_cc[VERASE];
462 if (bspace != _POSIX_VDISABLE && key == bspace)
463 key = KEYC_BSPACE;
464 goto handle_key;
465 }
466
467 /* Is this device attributes response? */
468 switch (tty_keys_device(tty, buf, len, &size)) {
469 case 0: /* yes */
470 evbuffer_drain(tty->event->input, size);
471 key = KEYC_NONE;
472 goto handle_key;
473 case -1: /* no, or not valid */
474 break;
475 case 1: /* partial */
476 goto partial_key;
477 }
478
479 /* Is this a mouse key press? */
480 switch (tty_keys_mouse(tty, buf, len, &size, &mouse)) {
481 case 0: /* yes */
482 evbuffer_drain(tty->event->input, size);
483 key = KEYC_MOUSE;
484 goto handle_key;
485 case -1: /* no, or not valid */
486 break;
487 case 1: /* partial */
488 goto partial_key;
489 }
490
491 /* Try to parse a key with an xterm-style modifier. */
492 switch (xterm_keys_find(buf, len, &size, &key)) {
493 case 0: /* found */
494 evbuffer_drain(tty->event->input, size);
495 goto handle_key;
496 case -1: /* not found */
497 break;
498 case 1:
499 goto partial_key;
500 }
501
502 /* Look for matching key string and return if found. */
503 tk = tty_keys_find(tty, buf + 1, len - 1, &size);
504 if (tk != NULL) {
505 key = tk->key;
506 goto found_key;
507 }
508
509 /* Skip the escape. */
510 buf++;
511 len--;
512
513 /* Is there a normal key following? */
514 if (len != 0 && *buf != '\033') {
515 key = *buf | KEYC_ESCAPE;
516 evbuffer_drain(tty->event->input, 2);
517 goto handle_key;
518 }
519
520 /* Or a key string? */
521 if (len > 1) {
522 tk = tty_keys_find(tty, buf + 1, len - 1, &size);
523 if (tk != NULL) {
524 key = tk->key | KEYC_ESCAPE;
525 size++; /* include escape */
526 goto found_key;
527 }
528 }
529
530 /* Escape and then nothing useful - fall through. */
531
532 partial_key:
533 /*
534 * Escape but no key string. If have already seen an escape and the
535 * timer has expired, give up waiting and send the escape.
536 */
537 if ((tty->flags & TTY_ESCAPE) &&
538 !evtimer_pending(&tty->key_timer, NULL)) {
539 evbuffer_drain(tty->event->input, 1);
540 key = '\033';
541 goto handle_key;
542 }
543
544 /* Fall through to start the timer. */
545
546 start_timer:
547 /* If already waiting for timer, do nothing. */
548 if (evtimer_pending(&tty->key_timer, NULL))
549 return (0);
550
551 /* Start the timer and wait for expiry or more data. */
552 delay = options_get_number(&global_options, "escape-time");
553 tv.tv_sec = delay / 1000;
554 tv.tv_usec = (delay % 1000) * 1000L;
555
556 if (event_initialized(&tty->key_timer))
557 evtimer_del(&tty->key_timer);
558 evtimer_set(&tty->key_timer, tty_keys_callback, tty);
559 evtimer_add(&tty->key_timer, &tv);
560
561 tty->flags |= TTY_ESCAPE;
562 return (0);
563
564 found_key:
565 if (tk->next != NULL) {
566 /* Partial key. Start the timer if not already expired. */
567 if (!(tty->flags & TTY_ESCAPE))
568 goto start_timer;
569
570 /* Otherwise, if no key, send the escape alone. */
571 if (tk->key == KEYC_NONE)
572 goto partial_key;
573
574 /* Or fall through to send the partial key found. */
575 }
576 evbuffer_drain(tty->event->input, size + 1);
577
578 goto handle_key;
579
580 handle_key:
581 if (event_initialized(&tty->key_timer))
582 evtimer_del(&tty->key_timer);
583
584 if (key != KEYC_NONE)
585 tty->key_callback(key, &mouse, tty->key_data);
586
587 tty->flags &= ~TTY_ESCAPE;
588 return (1);
589 }
590
591 /* Key timer callback. */
592 /* ARGSUSED */
593 void
594 tty_keys_callback(unused int fd, unused short events, void *data)
595 {
596 struct tty *tty = data;
597
598 if (!(tty->flags & TTY_ESCAPE))
599 return;
600
601 while (tty_keys_next(tty))
602 ;
603 }
604
605 /*
606 * Handle mouse key input. Returns 0 for success, -1 for failure, 1 for partial
607 * (probably a mouse sequence but need more data).
608 */
609 int
610 tty_keys_mouse(struct tty *tty,
611 const char *buf, size_t len, size_t *size, struct mouse_event *m)
612 {
613 struct utf8_data utf8data;
614 u_int i, value;
615
616 /*
617 * Standard mouse sequences are \033[M followed by three characters
618 * indicating buttons, X and Y, all based at 32 with 1,1 top-left.
619 *
620 * UTF-8 mouse sequences are similar but the three are expressed as
621 * UTF-8 characters.
622 */
623
624 *size = 0;
625
626 /* First three bytes are always \033[M. */
627 if (buf[0] != '\033')
628 return (-1);
629 if (len == 1)
630 return (1);
631 if (buf[1] != '[')
632 return (-1);
633 if (len == 2)
634 return (1);
635 if (buf[2] != 'M')
636 return (-1);
637 if (len == 3)
638 return (1);
639
640 /* Read the three inputs. */
641 *size = 3;
642 for (i = 0; i < 3; i++) {
643 if (len < *size)
644 return (1);
645
646 if (tty->mode & MODE_MOUSE_UTF8) {
647 if (utf8_open(&utf8data, buf[*size])) {
648 if (utf8data.size != 2)
649 return (-1);
650 (*size)++;
651 if (len < *size)
652 return (1);
653 utf8_append(&utf8data, buf[*size]);
654 value = utf8_combine(&utf8data);
655 } else
656 value = (unsigned char)buf[*size];
657 (*size)++;
658 } else {
659 value = (unsigned char)buf[*size];
660 (*size)++;
661 }
662
663 if (i == 0)
664 m->b = value;
665 else if (i == 1)
666 m->x = value;
667 else
668 m->y = value;
669 }
670 log_debug("mouse input: %.*s", (int) *size, buf);
671
672 /* Check and return the mouse input. */
673 if (m->b < 32 || m->x < 33 || m->y < 33)
674 return (-1);
675 m->b -= 32;
676 m->x -= 33;
677 m->y -= 33;
678 log_debug("mouse position: x=%u y=%u b=%u", m->x, m->y, m->b);
679 return (0);
680 }
681
682 /*
683 * Handle device attributes input. Returns 0 for success, -1 for failure, 1 for
684 * partial.
685 */
686 int
687 tty_keys_device(struct tty *tty, const char *buf, size_t len, size_t *size)
688 {
689 u_int i, a, b;
690 char tmp[64], *endptr;
691
692 /*
693 * Primary device attributes are \033[?a;b and secondary are
694 * \033[>a;b;c. We only request attributes on xterm, so we only care
695 * about the middle values which is the xterm version.
696 */
697
698 *size = 0;
699
700 /* First three bytes are always \033[>. */
701 if (buf[0] != '\033')
702 return (-1);
703 if (len == 1)
704 return (1);
705 if (buf[1] != '[')
706 return (-1);
707 if (len == 2)
708 return (1);
709 if (buf[2] != '>' && buf[2] != '?')
710 return (-1);
711 if (len == 3)
712 return (1);
713
714 /* Copy the rest up to a 'c'. */
715 for (i = 0; i < (sizeof tmp) - 1 && buf[3 + i] != 'c'; i++) {
716 if (3 + i == len)
717 return (1);
718 tmp[i] = buf[3 + i];
719 }
720 if (i == (sizeof tmp) - 1)
721 return (-1);
722 tmp[i] = '\0';
723 *size = 4 + i;
724
725 /* Only secondary is of interest. */
726 if (buf[2] != '>')
727 return (0);
728
729 /* Convert version numbers. */
730 a = strtoul(tmp, &endptr, 10);
731 if (*endptr == ';') {
732 b = strtoul(endptr + 1, &endptr, 10);
733 if (*endptr != '\0' && *endptr != ';')
734 b = 0;
735 } else
736 a = b = 0;
737
738 log_debug("received xterm version %u", b);
739 tty_set_version(tty, b);
740
741 return (0);
742 }