If there are no buffers, reset mode as soon as any key pressed. Fixes
[tmux-openbsd.git] / tty-keys.c
blobcb8efd49ee7e47bc0375084879f6e050ccf7abe2
1 /* $OpenBSD$ */
3 /*
4 * Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com>
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.
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.
19 #include <sys/types.h>
20 #include <sys/time.h>
22 #include <netinet/in.h>
24 #include <ctype.h>
25 #include <limits.h>
26 #include <resolv.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <termios.h>
30 #include <unistd.h>
32 #include "tmux.h"
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.
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,
44 size_t *);
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 *,
48 size_t *, int);
49 static void tty_keys_callback(int, short, void *);
50 static int tty_keys_extended_key(struct tty *, const char *, size_t,
51 size_t *, key_code *);
52 static int tty_keys_mouse(struct tty *, const char *, size_t, size_t *,
53 struct mouse_event *);
54 static int tty_keys_clipboard(struct tty *, const char *, size_t,
55 size_t *);
56 static int tty_keys_device_attributes(struct tty *, const char *, size_t,
57 size_t *);
58 static int tty_keys_extended_device_attributes(struct tty *, const char *,
59 size_t, size_t *);
61 /* A key tree entry. */
62 struct tty_key {
63 char ch;
64 key_code key;
66 struct tty_key *left;
67 struct tty_key *right;
69 struct tty_key *next;
72 /* Default raw keys. */
73 struct tty_default_key_raw {
74 const char *string;
75 key_code key;
77 static const struct tty_default_key_raw tty_default_raw_keys[] = {
78 /* Application escape. */
79 { "\033O[", '\033' },
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.
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 },
103 /* Arrow keys. */
104 { "\033OA", KEYC_UP|KEYC_CURSOR },
105 { "\033OB", KEYC_DOWN|KEYC_CURSOR },
106 { "\033OC", KEYC_RIGHT|KEYC_CURSOR },
107 { "\033OD", KEYC_LEFT|KEYC_CURSOR },
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 },
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.
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 },
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 },
129 /* Other xterm keys. */
130 { "\033OH", KEYC_HOME },
131 { "\033OF", KEYC_END },
133 { "\033\033OH", KEYC_HOME|KEYC_META|KEYC_IMPLIED_META },
134 { "\033\033OF", KEYC_END|KEYC_META|KEYC_IMPLIED_META },
136 { "\033[H", KEYC_HOME },
137 { "\033[F", KEYC_END },
139 { "\033\033[H", KEYC_HOME|KEYC_META|KEYC_IMPLIED_META },
140 { "\033\033[F", KEYC_END|KEYC_META|KEYC_IMPLIED_META },
142 /* rxvt arrow keys. */
143 { "\033Oa", KEYC_UP|KEYC_CTRL },
144 { "\033Ob", KEYC_DOWN|KEYC_CTRL },
145 { "\033Oc", KEYC_RIGHT|KEYC_CTRL },
146 { "\033Od", KEYC_LEFT|KEYC_CTRL },
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 },
153 /* rxvt function keys. */
154 { "\033[11~", KEYC_F1 },
155 { "\033[12~", KEYC_F2 },
156 { "\033[13~", KEYC_F3 },
157 { "\033[14~", KEYC_F4 },
158 { "\033[15~", KEYC_F5 },
159 { "\033[17~", KEYC_F6 },
160 { "\033[18~", KEYC_F7 },
161 { "\033[19~", KEYC_F8 },
162 { "\033[20~", KEYC_F9 },
163 { "\033[21~", KEYC_F10 },
165 { "\033[23~", KEYC_F1|KEYC_SHIFT },
166 { "\033[24~", KEYC_F2|KEYC_SHIFT },
167 { "\033[25~", KEYC_F3|KEYC_SHIFT },
168 { "\033[26~", KEYC_F4|KEYC_SHIFT },
169 { "\033[28~", KEYC_F5|KEYC_SHIFT },
170 { "\033[29~", KEYC_F6|KEYC_SHIFT },
171 { "\033[31~", KEYC_F7|KEYC_SHIFT },
172 { "\033[32~", KEYC_F8|KEYC_SHIFT },
173 { "\033[33~", KEYC_F9|KEYC_SHIFT },
174 { "\033[34~", KEYC_F10|KEYC_SHIFT },
175 { "\033[23$", KEYC_F11|KEYC_SHIFT },
176 { "\033[24$", KEYC_F12|KEYC_SHIFT },
178 { "\033[11^", KEYC_F1|KEYC_CTRL },
179 { "\033[12^", KEYC_F2|KEYC_CTRL },
180 { "\033[13^", KEYC_F3|KEYC_CTRL },
181 { "\033[14^", KEYC_F4|KEYC_CTRL },
182 { "\033[15^", KEYC_F5|KEYC_CTRL },
183 { "\033[17^", KEYC_F6|KEYC_CTRL },
184 { "\033[18^", KEYC_F7|KEYC_CTRL },
185 { "\033[19^", KEYC_F8|KEYC_CTRL },
186 { "\033[20^", KEYC_F9|KEYC_CTRL },
187 { "\033[21^", KEYC_F10|KEYC_CTRL },
188 { "\033[23^", KEYC_F11|KEYC_CTRL },
189 { "\033[24^", KEYC_F12|KEYC_CTRL },
191 { "\033[11@", KEYC_F1|KEYC_CTRL|KEYC_SHIFT },
192 { "\033[12@", KEYC_F2|KEYC_CTRL|KEYC_SHIFT },
193 { "\033[13@", KEYC_F3|KEYC_CTRL|KEYC_SHIFT },
194 { "\033[14@", KEYC_F4|KEYC_CTRL|KEYC_SHIFT },
195 { "\033[15@", KEYC_F5|KEYC_CTRL|KEYC_SHIFT },
196 { "\033[17@", KEYC_F6|KEYC_CTRL|KEYC_SHIFT },
197 { "\033[18@", KEYC_F7|KEYC_CTRL|KEYC_SHIFT },
198 { "\033[19@", KEYC_F8|KEYC_CTRL|KEYC_SHIFT },
199 { "\033[20@", KEYC_F9|KEYC_CTRL|KEYC_SHIFT },
200 { "\033[21@", KEYC_F10|KEYC_CTRL|KEYC_SHIFT },
201 { "\033[23@", KEYC_F11|KEYC_CTRL|KEYC_SHIFT },
202 { "\033[24@", KEYC_F12|KEYC_CTRL|KEYC_SHIFT },
204 /* Focus tracking. */
205 { "\033[I", KEYC_FOCUS_IN },
206 { "\033[O", KEYC_FOCUS_OUT },
208 /* Paste keys. */
209 { "\033[200~", KEYC_PASTE_START },
210 { "\033[201~", KEYC_PASTE_END },
212 /* Extended keys. */
213 { "\033[1;5Z", '\011'|KEYC_CTRL|KEYC_SHIFT },
216 /* Default xterm keys. */
217 struct tty_default_key_xterm {
218 const char *template;
219 key_code key;
221 static const struct tty_default_key_xterm tty_default_xterm_keys[] = {
222 { "\033[1;_P", KEYC_F1 },
223 { "\033O1;_P", KEYC_F1 },
224 { "\033O_P", KEYC_F1 },
225 { "\033[1;_Q", KEYC_F2 },
226 { "\033O1;_Q", KEYC_F2 },
227 { "\033O_Q", KEYC_F2 },
228 { "\033[1;_R", KEYC_F3 },
229 { "\033O1;_R", KEYC_F3 },
230 { "\033O_R", KEYC_F3 },
231 { "\033[1;_S", KEYC_F4 },
232 { "\033O1;_S", KEYC_F4 },
233 { "\033O_S", KEYC_F4 },
234 { "\033[15;_~", KEYC_F5 },
235 { "\033[17;_~", KEYC_F6 },
236 { "\033[18;_~", KEYC_F7 },
237 { "\033[19;_~", KEYC_F8 },
238 { "\033[20;_~", KEYC_F9 },
239 { "\033[21;_~", KEYC_F10 },
240 { "\033[23;_~", KEYC_F11 },
241 { "\033[24;_~", KEYC_F12 },
242 { "\033[1;_A", KEYC_UP },
243 { "\033[1;_B", KEYC_DOWN },
244 { "\033[1;_C", KEYC_RIGHT },
245 { "\033[1;_D", KEYC_LEFT },
246 { "\033[1;_H", KEYC_HOME },
247 { "\033[1;_F", KEYC_END },
248 { "\033[5;_~", KEYC_PPAGE },
249 { "\033[6;_~", KEYC_NPAGE },
250 { "\033[2;_~", KEYC_IC },
251 { "\033[3;_~", KEYC_DC },
253 static const key_code tty_default_xterm_modifiers[] = {
256 KEYC_SHIFT,
257 KEYC_META|KEYC_IMPLIED_META,
258 KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META,
259 KEYC_CTRL,
260 KEYC_SHIFT|KEYC_CTRL,
261 KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL,
262 KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL,
263 KEYC_META|KEYC_IMPLIED_META
267 * Default terminfo(5) keys. Any keys that have builtin modifiers (that is,
268 * where the key itself contains the modifiers) has the KEYC_XTERM flag set so
269 * a leading escape is not treated as meta (and probably removed).
271 struct tty_default_key_code {
272 enum tty_code_code code;
273 key_code key;
275 static const struct tty_default_key_code tty_default_code_keys[] = {
276 /* Function keys. */
277 { TTYC_KF1, KEYC_F1 },
278 { TTYC_KF2, KEYC_F2 },
279 { TTYC_KF3, KEYC_F3 },
280 { TTYC_KF4, KEYC_F4 },
281 { TTYC_KF5, KEYC_F5 },
282 { TTYC_KF6, KEYC_F6 },
283 { TTYC_KF7, KEYC_F7 },
284 { TTYC_KF8, KEYC_F8 },
285 { TTYC_KF9, KEYC_F9 },
286 { TTYC_KF10, KEYC_F10 },
287 { TTYC_KF11, KEYC_F11 },
288 { TTYC_KF12, KEYC_F12 },
290 { TTYC_KF13, KEYC_F1|KEYC_SHIFT },
291 { TTYC_KF14, KEYC_F2|KEYC_SHIFT },
292 { TTYC_KF15, KEYC_F3|KEYC_SHIFT },
293 { TTYC_KF16, KEYC_F4|KEYC_SHIFT },
294 { TTYC_KF17, KEYC_F5|KEYC_SHIFT },
295 { TTYC_KF18, KEYC_F6|KEYC_SHIFT },
296 { TTYC_KF19, KEYC_F7|KEYC_SHIFT },
297 { TTYC_KF20, KEYC_F8|KEYC_SHIFT },
298 { TTYC_KF21, KEYC_F9|KEYC_SHIFT },
299 { TTYC_KF22, KEYC_F10|KEYC_SHIFT },
300 { TTYC_KF23, KEYC_F11|KEYC_SHIFT },
301 { TTYC_KF24, KEYC_F12|KEYC_SHIFT },
303 { TTYC_KF25, KEYC_F1|KEYC_CTRL },
304 { TTYC_KF26, KEYC_F2|KEYC_CTRL },
305 { TTYC_KF27, KEYC_F3|KEYC_CTRL },
306 { TTYC_KF28, KEYC_F4|KEYC_CTRL },
307 { TTYC_KF29, KEYC_F5|KEYC_CTRL },
308 { TTYC_KF30, KEYC_F6|KEYC_CTRL },
309 { TTYC_KF31, KEYC_F7|KEYC_CTRL },
310 { TTYC_KF32, KEYC_F8|KEYC_CTRL },
311 { TTYC_KF33, KEYC_F9|KEYC_CTRL },
312 { TTYC_KF34, KEYC_F10|KEYC_CTRL },
313 { TTYC_KF35, KEYC_F11|KEYC_CTRL },
314 { TTYC_KF36, KEYC_F12|KEYC_CTRL },
316 { TTYC_KF37, KEYC_F1|KEYC_SHIFT|KEYC_CTRL },
317 { TTYC_KF38, KEYC_F2|KEYC_SHIFT|KEYC_CTRL },
318 { TTYC_KF39, KEYC_F3|KEYC_SHIFT|KEYC_CTRL },
319 { TTYC_KF40, KEYC_F4|KEYC_SHIFT|KEYC_CTRL },
320 { TTYC_KF41, KEYC_F5|KEYC_SHIFT|KEYC_CTRL },
321 { TTYC_KF42, KEYC_F6|KEYC_SHIFT|KEYC_CTRL },
322 { TTYC_KF43, KEYC_F7|KEYC_SHIFT|KEYC_CTRL },
323 { TTYC_KF44, KEYC_F8|KEYC_SHIFT|KEYC_CTRL },
324 { TTYC_KF45, KEYC_F9|KEYC_SHIFT|KEYC_CTRL },
325 { TTYC_KF46, KEYC_F10|KEYC_SHIFT|KEYC_CTRL },
326 { TTYC_KF47, KEYC_F11|KEYC_SHIFT|KEYC_CTRL },
327 { TTYC_KF48, KEYC_F12|KEYC_SHIFT|KEYC_CTRL },
329 { TTYC_KF49, KEYC_F1|KEYC_META|KEYC_IMPLIED_META },
330 { TTYC_KF50, KEYC_F2|KEYC_META|KEYC_IMPLIED_META },
331 { TTYC_KF51, KEYC_F3|KEYC_META|KEYC_IMPLIED_META },
332 { TTYC_KF52, KEYC_F4|KEYC_META|KEYC_IMPLIED_META },
333 { TTYC_KF53, KEYC_F5|KEYC_META|KEYC_IMPLIED_META },
334 { TTYC_KF54, KEYC_F6|KEYC_META|KEYC_IMPLIED_META },
335 { TTYC_KF55, KEYC_F7|KEYC_META|KEYC_IMPLIED_META },
336 { TTYC_KF56, KEYC_F8|KEYC_META|KEYC_IMPLIED_META },
337 { TTYC_KF57, KEYC_F9|KEYC_META|KEYC_IMPLIED_META },
338 { TTYC_KF58, KEYC_F10|KEYC_META|KEYC_IMPLIED_META },
339 { TTYC_KF59, KEYC_F11|KEYC_META|KEYC_IMPLIED_META },
340 { TTYC_KF60, KEYC_F12|KEYC_META|KEYC_IMPLIED_META },
342 { TTYC_KF61, KEYC_F1|KEYC_META|KEYC_IMPLIED_META|KEYC_SHIFT },
343 { TTYC_KF62, KEYC_F2|KEYC_META|KEYC_IMPLIED_META|KEYC_SHIFT },
344 { TTYC_KF63, KEYC_F3|KEYC_META|KEYC_IMPLIED_META|KEYC_SHIFT },
346 { TTYC_KICH1, KEYC_IC },
347 { TTYC_KDCH1, KEYC_DC },
348 { TTYC_KHOME, KEYC_HOME },
349 { TTYC_KEND, KEYC_END },
350 { TTYC_KNP, KEYC_NPAGE },
351 { TTYC_KPP, KEYC_PPAGE },
352 { TTYC_KCBT, KEYC_BTAB },
354 /* Arrow keys from terminfo. */
355 { TTYC_KCUU1, KEYC_UP|KEYC_CURSOR },
356 { TTYC_KCUD1, KEYC_DOWN|KEYC_CURSOR },
357 { TTYC_KCUB1, KEYC_LEFT|KEYC_CURSOR },
358 { TTYC_KCUF1, KEYC_RIGHT|KEYC_CURSOR },
360 /* Key and modifier capabilities. */
361 { TTYC_KDC2, KEYC_DC|KEYC_SHIFT },
362 { TTYC_KDC3, KEYC_DC|KEYC_META|KEYC_IMPLIED_META },
363 { TTYC_KDC4, KEYC_DC|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
364 { TTYC_KDC5, KEYC_DC|KEYC_CTRL },
365 { TTYC_KDC6, KEYC_DC|KEYC_SHIFT|KEYC_CTRL },
366 { TTYC_KDC7, KEYC_DC|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
367 { TTYC_KIND, KEYC_DOWN|KEYC_SHIFT },
368 { TTYC_KDN2, KEYC_DOWN|KEYC_SHIFT },
369 { TTYC_KDN3, KEYC_DOWN|KEYC_META|KEYC_IMPLIED_META },
370 { TTYC_KDN4, KEYC_DOWN|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
371 { TTYC_KDN5, KEYC_DOWN|KEYC_CTRL },
372 { TTYC_KDN6, KEYC_DOWN|KEYC_SHIFT|KEYC_CTRL },
373 { TTYC_KDN7, KEYC_DOWN|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
374 { TTYC_KEND2, KEYC_END|KEYC_SHIFT },
375 { TTYC_KEND3, KEYC_END|KEYC_META|KEYC_IMPLIED_META },
376 { TTYC_KEND4, KEYC_END|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
377 { TTYC_KEND5, KEYC_END|KEYC_CTRL },
378 { TTYC_KEND6, KEYC_END|KEYC_SHIFT|KEYC_CTRL },
379 { TTYC_KEND7, KEYC_END|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
380 { TTYC_KHOM2, KEYC_HOME|KEYC_SHIFT },
381 { TTYC_KHOM3, KEYC_HOME|KEYC_META|KEYC_IMPLIED_META },
382 { TTYC_KHOM4, KEYC_HOME|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
383 { TTYC_KHOM5, KEYC_HOME|KEYC_CTRL },
384 { TTYC_KHOM6, KEYC_HOME|KEYC_SHIFT|KEYC_CTRL },
385 { TTYC_KHOM7, KEYC_HOME|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
386 { TTYC_KIC2, KEYC_IC|KEYC_SHIFT },
387 { TTYC_KIC3, KEYC_IC|KEYC_META|KEYC_IMPLIED_META },
388 { TTYC_KIC4, KEYC_IC|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
389 { TTYC_KIC5, KEYC_IC|KEYC_CTRL },
390 { TTYC_KIC6, KEYC_IC|KEYC_SHIFT|KEYC_CTRL },
391 { TTYC_KIC7, KEYC_IC|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
392 { TTYC_KLFT2, KEYC_LEFT|KEYC_SHIFT },
393 { TTYC_KLFT3, KEYC_LEFT|KEYC_META|KEYC_IMPLIED_META },
394 { TTYC_KLFT4, KEYC_LEFT|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
395 { TTYC_KLFT5, KEYC_LEFT|KEYC_CTRL },
396 { TTYC_KLFT6, KEYC_LEFT|KEYC_SHIFT|KEYC_CTRL },
397 { TTYC_KLFT7, KEYC_LEFT|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
398 { TTYC_KNXT2, KEYC_NPAGE|KEYC_SHIFT },
399 { TTYC_KNXT3, KEYC_NPAGE|KEYC_META|KEYC_IMPLIED_META },
400 { TTYC_KNXT4, KEYC_NPAGE|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
401 { TTYC_KNXT5, KEYC_NPAGE|KEYC_CTRL },
402 { TTYC_KNXT6, KEYC_NPAGE|KEYC_SHIFT|KEYC_CTRL },
403 { TTYC_KNXT7, KEYC_NPAGE|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
404 { TTYC_KPRV2, KEYC_PPAGE|KEYC_SHIFT },
405 { TTYC_KPRV3, KEYC_PPAGE|KEYC_META|KEYC_IMPLIED_META },
406 { TTYC_KPRV4, KEYC_PPAGE|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
407 { TTYC_KPRV5, KEYC_PPAGE|KEYC_CTRL },
408 { TTYC_KPRV6, KEYC_PPAGE|KEYC_SHIFT|KEYC_CTRL },
409 { TTYC_KPRV7, KEYC_PPAGE|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
410 { TTYC_KRIT2, KEYC_RIGHT|KEYC_SHIFT },
411 { TTYC_KRIT3, KEYC_RIGHT|KEYC_META|KEYC_IMPLIED_META },
412 { TTYC_KRIT4, KEYC_RIGHT|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
413 { TTYC_KRIT5, KEYC_RIGHT|KEYC_CTRL },
414 { TTYC_KRIT6, KEYC_RIGHT|KEYC_SHIFT|KEYC_CTRL },
415 { TTYC_KRIT7, KEYC_RIGHT|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
416 { TTYC_KRI, KEYC_UP|KEYC_SHIFT },
417 { TTYC_KUP2, KEYC_UP|KEYC_SHIFT },
418 { TTYC_KUP3, KEYC_UP|KEYC_META|KEYC_IMPLIED_META },
419 { TTYC_KUP4, KEYC_UP|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
420 { TTYC_KUP5, KEYC_UP|KEYC_CTRL },
421 { TTYC_KUP6, KEYC_UP|KEYC_SHIFT|KEYC_CTRL },
422 { TTYC_KUP7, KEYC_UP|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
425 /* Add key to tree. */
426 static void
427 tty_keys_add(struct tty *tty, const char *s, key_code key)
429 struct tty_key *tk;
430 size_t size;
431 const char *keystr;
433 keystr = key_string_lookup_key(key, 1);
434 if ((tk = tty_keys_find(tty, s, strlen(s), &size)) == NULL) {
435 log_debug("new key %s: 0x%llx (%s)", s, key, keystr);
436 tty_keys_add1(&tty->key_tree, s, key);
437 } else {
438 log_debug("replacing key %s: 0x%llx (%s)", s, key, keystr);
439 tk->key = key;
443 /* Add next node to the tree. */
444 static void
445 tty_keys_add1(struct tty_key **tkp, const char *s, key_code key)
447 struct tty_key *tk;
449 /* Allocate a tree entry if there isn't one already. */
450 tk = *tkp;
451 if (tk == NULL) {
452 tk = *tkp = xcalloc(1, sizeof *tk);
453 tk->ch = *s;
454 tk->key = KEYC_UNKNOWN;
457 /* Find the next entry. */
458 if (*s == tk->ch) {
459 /* Move forward in string. */
460 s++;
462 /* If this is the end of the string, no more is necessary. */
463 if (*s == '\0') {
464 tk->key = key;
465 return;
468 /* Use the child tree for the next character. */
469 tkp = &tk->next;
470 } else {
471 if (*s < tk->ch)
472 tkp = &tk->left;
473 else if (*s > tk->ch)
474 tkp = &tk->right;
477 /* And recurse to add it. */
478 tty_keys_add1(tkp, s, key);
481 /* Initialise a key tree from the table. */
482 void
483 tty_keys_build(struct tty *tty)
485 const struct tty_default_key_raw *tdkr;
486 const struct tty_default_key_xterm *tdkx;
487 const struct tty_default_key_code *tdkc;
488 u_int i, j;
489 const char *s;
490 struct options_entry *o;
491 struct options_array_item *a;
492 union options_value *ov;
493 char copy[16];
494 key_code key;
496 if (tty->key_tree != NULL)
497 tty_keys_free(tty);
498 tty->key_tree = NULL;
500 for (i = 0; i < nitems(tty_default_xterm_keys); i++) {
501 tdkx = &tty_default_xterm_keys[i];
502 for (j = 2; j < nitems(tty_default_xterm_modifiers); j++) {
503 strlcpy(copy, tdkx->template, sizeof copy);
504 copy[strcspn(copy, "_")] = '0' + j;
506 key = tdkx->key|tty_default_xterm_modifiers[j];
507 tty_keys_add(tty, copy, key);
510 for (i = 0; i < nitems(tty_default_raw_keys); i++) {
511 tdkr = &tty_default_raw_keys[i];
513 s = tdkr->string;
514 if (*s != '\0')
515 tty_keys_add(tty, s, tdkr->key);
517 for (i = 0; i < nitems(tty_default_code_keys); i++) {
518 tdkc = &tty_default_code_keys[i];
520 s = tty_term_string(tty->term, tdkc->code);
521 if (*s != '\0')
522 tty_keys_add(tty, s, tdkc->key);
526 o = options_get(global_options, "user-keys");
527 if (o != NULL) {
528 a = options_array_first(o);
529 while (a != NULL) {
530 i = options_array_item_index(a);
531 ov = options_array_item_value(a);
532 tty_keys_add(tty, ov->string, KEYC_USER + i);
533 a = options_array_next(a);
538 /* Free the entire key tree. */
539 void
540 tty_keys_free(struct tty *tty)
542 tty_keys_free1(tty->key_tree);
545 /* Free a single key. */
546 static void
547 tty_keys_free1(struct tty_key *tk)
549 if (tk->next != NULL)
550 tty_keys_free1(tk->next);
551 if (tk->left != NULL)
552 tty_keys_free1(tk->left);
553 if (tk->right != NULL)
554 tty_keys_free1(tk->right);
555 free(tk);
558 /* Lookup a key in the tree. */
559 static struct tty_key *
560 tty_keys_find(struct tty *tty, const char *buf, size_t len, size_t *size)
562 *size = 0;
563 return (tty_keys_find1(tty->key_tree, buf, len, size));
566 /* Find the next node. */
567 static struct tty_key *
568 tty_keys_find1(struct tty_key *tk, const char *buf, size_t len, size_t *size)
570 /* If no data, no match. */
571 if (len == 0)
572 return (NULL);
574 /* If the node is NULL, this is the end of the tree. No match. */
575 if (tk == NULL)
576 return (NULL);
578 /* Pick the next in the sequence. */
579 if (tk->ch == *buf) {
580 /* Move forward in the string. */
581 buf++; len--;
582 (*size)++;
584 /* At the end of the string, return the current node. */
585 if (len == 0 || (tk->next == NULL && tk->key != KEYC_UNKNOWN))
586 return (tk);
588 /* Move into the next tree for the following character. */
589 tk = tk->next;
590 } else {
591 if (*buf < tk->ch)
592 tk = tk->left;
593 else if (*buf > tk->ch)
594 tk = tk->right;
597 /* Move to the next in the tree. */
598 return (tty_keys_find1(tk, buf, len, size));
601 /* Look up part of the next key. */
602 static int
603 tty_keys_next1(struct tty *tty, const char *buf, size_t len, key_code *key,
604 size_t *size, int expired)
606 struct client *c = tty->client;
607 struct tty_key *tk, *tk1;
608 struct utf8_data ud;
609 enum utf8_state more;
610 utf8_char uc;
611 u_int i;
613 log_debug("%s: next key is %zu (%.*s) (expired=%d)", c->name, len,
614 (int)len, buf, expired);
616 /* Is this a known key? */
617 tk = tty_keys_find(tty, buf, len, size);
618 if (tk != NULL && tk->key != KEYC_UNKNOWN) {
619 tk1 = tk;
621 log_debug("%s: keys in list: %#llx", c->name, tk1->key);
622 while ((tk1 = tk1->next) != NULL);
623 if (tk->next != NULL && !expired)
624 return (1);
625 *key = tk->key;
626 return (0);
629 /* Is this valid UTF-8? */
630 more = utf8_open(&ud, (u_char)*buf);
631 if (more == UTF8_MORE) {
632 *size = ud.size;
633 if (len < ud.size) {
634 if (!expired)
635 return (1);
636 return (-1);
638 for (i = 1; i < ud.size; i++)
639 more = utf8_append(&ud, (u_char)buf[i]);
640 if (more != UTF8_DONE)
641 return (-1);
643 if (utf8_from_data(&ud, &uc) != UTF8_DONE)
644 return (-1);
645 *key = uc;
647 log_debug("%s: UTF-8 key %.*s %#llx", c->name, (int)ud.size,
648 ud.data, *key);
649 return (0);
652 return (-1);
655 /* Process at least one key in the buffer. Return 0 if no keys present. */
657 tty_keys_next(struct tty *tty)
659 struct client *c = tty->client;
660 struct timeval tv;
661 const char *buf;
662 size_t len, size;
663 cc_t bspace;
664 int delay, expired = 0, n;
665 key_code key;
666 struct mouse_event m = { 0 };
667 struct key_event *event;
669 /* Get key buffer. */
670 buf = EVBUFFER_DATA(tty->in);
671 len = EVBUFFER_LENGTH(tty->in);
672 if (len == 0)
673 return (0);
674 log_debug("%s: keys are %zu (%.*s)", c->name, len, (int)len, buf);
676 /* Is this a clipboard response? */
677 switch (tty_keys_clipboard(tty, buf, len, &size)) {
678 case 0: /* yes */
679 key = KEYC_UNKNOWN;
680 goto complete_key;
681 case -1: /* no, or not valid */
682 break;
683 case 1: /* partial */
684 goto partial_key;
687 /* Is this a device attributes response? */
688 switch (tty_keys_device_attributes(tty, buf, len, &size)) {
689 case 0: /* yes */
690 key = KEYC_UNKNOWN;
691 goto complete_key;
692 case -1: /* no, or not valid */
693 break;
694 case 1: /* partial */
695 goto partial_key;
698 /* Is this an extended device attributes response? */
699 switch (tty_keys_extended_device_attributes(tty, buf, len, &size)) {
700 case 0: /* yes */
701 key = KEYC_UNKNOWN;
702 goto complete_key;
703 case -1: /* no, or not valid */
704 break;
705 case 1: /* partial */
706 goto partial_key;
709 /* Is this a mouse key press? */
710 switch (tty_keys_mouse(tty, buf, len, &size, &m)) {
711 case 0: /* yes */
712 key = KEYC_MOUSE;
713 goto complete_key;
714 case -1: /* no, or not valid */
715 break;
716 case -2: /* yes, but we don't care. */
717 key = KEYC_MOUSE;
718 goto discard_key;
719 case 1: /* partial */
720 goto partial_key;
723 /* Is this an extended key press? */
724 switch (tty_keys_extended_key(tty, buf, len, &size, &key)) {
725 case 0: /* yes */
726 goto complete_key;
727 case -1: /* no, or not valid */
728 break;
729 case 1: /* partial */
730 goto partial_key;
733 first_key:
734 /* Try to lookup complete key. */
735 n = tty_keys_next1(tty, buf, len, &key, &size, expired);
736 if (n == 0) /* found */
737 goto complete_key;
738 if (n == 1)
739 goto partial_key;
742 * If not a complete key, look for key with an escape prefix (meta
743 * modifier).
745 if (*buf == '\033' && len > 1) {
746 /* Look for a key without the escape. */
747 n = tty_keys_next1(tty, buf + 1, len - 1, &key, &size, expired);
748 if (n == 0) { /* found */
749 if (key & KEYC_IMPLIED_META) {
751 * We want the escape key as well as the xterm
752 * key, because the xterm sequence implicitly
753 * includes the escape (so if we see
754 * \033\033[1;3D we know it is an Escape
755 * followed by M-Left, not just M-Left).
757 key = '\033';
758 size = 1;
759 goto complete_key;
761 key |= KEYC_META;
762 size++;
763 goto complete_key;
765 if (n == 1) /* partial */
766 goto partial_key;
770 * At this point, we know the key is not partial (with or without
771 * escape). So pass it through even if the timer has not expired.
773 if (*buf == '\033' && len >= 2) {
774 key = (u_char)buf[1] | KEYC_META;
775 size = 2;
776 } else {
777 key = (u_char)buf[0];
778 size = 1;
780 goto complete_key;
782 partial_key:
783 log_debug("%s: partial key %.*s", c->name, (int)len, buf);
785 /* If timer is going, check for expiration. */
786 if (tty->flags & TTY_TIMER) {
787 if (evtimer_initialized(&tty->key_timer) &&
788 !evtimer_pending(&tty->key_timer, NULL)) {
789 expired = 1;
790 goto first_key;
792 return (0);
795 /* Get the time period. */
796 delay = options_get_number(global_options, "escape-time");
797 if (delay == 0)
798 delay = 1;
799 tv.tv_sec = delay / 1000;
800 tv.tv_usec = (delay % 1000) * 1000L;
802 /* Start the timer. */
803 if (event_initialized(&tty->key_timer))
804 evtimer_del(&tty->key_timer);
805 evtimer_set(&tty->key_timer, tty_keys_callback, tty);
806 evtimer_add(&tty->key_timer, &tv);
808 tty->flags |= TTY_TIMER;
809 return (0);
811 complete_key:
812 log_debug("%s: complete key %.*s %#llx", c->name, (int)size, buf, key);
815 * Check for backspace key using termios VERASE - the terminfo
816 * kbs entry is extremely unreliable, so cannot be safely
817 * used. termios should have a better idea.
819 bspace = tty->tio.c_cc[VERASE];
820 if (bspace != _POSIX_VDISABLE && (key & KEYC_MASK_KEY) == bspace)
821 key = (key & KEYC_MASK_MODIFIERS)|KEYC_BSPACE;
823 /* Remove data from buffer. */
824 evbuffer_drain(tty->in, size);
826 /* Remove key timer. */
827 if (event_initialized(&tty->key_timer))
828 evtimer_del(&tty->key_timer);
829 tty->flags &= ~TTY_TIMER;
831 /* Check for focus events. */
832 if (key == KEYC_FOCUS_OUT) {
833 c->flags &= ~CLIENT_FOCUSED;
834 window_update_focus(c->session->curw->window);
835 notify_client("client-focus-out", c);
836 } else if (key == KEYC_FOCUS_IN) {
837 c->flags |= CLIENT_FOCUSED;
838 notify_client("client-focus-in", c);
839 window_update_focus(c->session->curw->window);
842 /* Fire the key. */
843 if (key != KEYC_UNKNOWN) {
844 event = xmalloc(sizeof *event);
845 event->key = key;
846 memcpy(&event->m, &m, sizeof event->m);
847 if (!server_client_handle_key(c, event))
848 free(event);
851 return (1);
853 discard_key:
854 log_debug("%s: discard key %.*s %#llx", c->name, (int)size, buf, key);
856 /* Remove data from buffer. */
857 evbuffer_drain(tty->in, size);
859 return (1);
862 /* Key timer callback. */
863 static void
864 tty_keys_callback(__unused int fd, __unused short events, void *data)
866 struct tty *tty = data;
868 if (tty->flags & TTY_TIMER) {
869 while (tty_keys_next(tty))
875 * Handle extended key input. This has two forms: \033[27;m;k~ and \033[k;mu,
876 * where k is key as a number and m is a modifier. Returns 0 for success, -1
877 * for failure, 1 for partial;
879 static int
880 tty_keys_extended_key(struct tty *tty, const char *buf, size_t len,
881 size_t *size, key_code *key)
883 struct client *c = tty->client;
884 size_t end;
885 u_int number, modifiers;
886 char tmp[64];
887 cc_t bspace;
888 key_code nkey;
889 key_code onlykey;
891 *size = 0;
893 /* First two bytes are always \033[. */
894 if (buf[0] != '\033')
895 return (-1);
896 if (len == 1)
897 return (1);
898 if (buf[1] != '[')
899 return (-1);
900 if (len == 2)
901 return (1);
904 * Look for a terminator. Stop at either '~' or anything that isn't a
905 * number or ';'.
907 for (end = 2; end < len && end != sizeof tmp; end++) {
908 if (buf[end] == '~')
909 break;
910 if (!isdigit((u_char)buf[end]) && buf[end] != ';')
911 break;
913 if (end == len)
914 return (1);
915 if (end == sizeof tmp || (buf[end] != '~' && buf[end] != 'u'))
916 return (-1);
918 /* Copy to the buffer. */
919 memcpy(tmp, buf + 2, end);
920 tmp[end] = '\0';
922 /* Try to parse either form of key. */
923 if (buf[end] == '~') {
924 if (sscanf(tmp, "27;%u;%u", &modifiers, &number) != 2)
925 return (-1);
926 } else {
927 if (sscanf(tmp ,"%u;%u", &number, &modifiers) != 2)
928 return (-1);
930 *size = end + 1;
932 /* Store the key. */
933 bspace = tty->tio.c_cc[VERASE];
934 if (bspace != _POSIX_VDISABLE && number == bspace)
935 nkey = KEYC_BSPACE;
936 else
937 nkey = number;
939 /* Update the modifiers. */
940 if (modifiers > 0) {
941 modifiers--;
942 if (modifiers & 1)
943 nkey |= KEYC_SHIFT;
944 if (modifiers & 2)
945 nkey |= (KEYC_META|KEYC_IMPLIED_META); /* Alt */
946 if (modifiers & 4)
947 nkey |= KEYC_CTRL;
948 if (modifiers & 8)
949 nkey |= (KEYC_META|KEYC_IMPLIED_META); /* Meta */
953 * Don't allow both KEYC_CTRL and as an implied modifier. Also convert
954 * C-X into C-x and so on.
956 if (nkey & KEYC_CTRL) {
957 onlykey = (nkey & KEYC_MASK_KEY);
958 if (onlykey < 32 &&
959 onlykey != 9 &&
960 onlykey != 13 &&
961 onlykey != 27)
962 /* nothing */;
963 else if (onlykey >= 97 && onlykey <= 122)
964 onlykey -= 96;
965 else if (onlykey >= 64 && onlykey <= 95)
966 onlykey -= 64;
967 else if (onlykey == 32)
968 onlykey = 0;
969 else if (onlykey == 63)
970 onlykey = 127;
971 else
972 onlykey |= KEYC_CTRL;
973 nkey = onlykey|((nkey & KEYC_MASK_MODIFIERS) & ~KEYC_CTRL);
976 if (log_get_level() != 0) {
977 log_debug("%s: extended key %.*s is %llx (%s)", c->name,
978 (int)*size, buf, nkey, key_string_lookup_key(nkey, 1));
980 *key = nkey;
981 return (0);
985 * Handle mouse key input. Returns 0 for success, -1 for failure, 1 for partial
986 * (probably a mouse sequence but need more data).
988 static int
989 tty_keys_mouse(struct tty *tty, const char *buf, size_t len, size_t *size,
990 struct mouse_event *m)
992 struct client *c = tty->client;
993 u_int i, x, y, b, sgr_b;
994 u_char sgr_type, ch;
997 * Standard mouse sequences are \033[M followed by three characters
998 * indicating button, X and Y, all based at 32 with 1,1 top-left.
1000 * UTF-8 mouse sequences are similar but the three are expressed as
1001 * UTF-8 characters.
1003 * SGR extended mouse sequences are \033[< followed by three numbers in
1004 * decimal and separated by semicolons indicating button, X and Y. A
1005 * trailing 'M' is click or scroll and trailing 'm' release. All are
1006 * based at 0 with 1,1 top-left.
1009 *size = 0;
1010 x = y = b = sgr_b = 0;
1011 sgr_type = ' ';
1013 /* First two bytes are always \033[. */
1014 if (buf[0] != '\033')
1015 return (-1);
1016 if (len == 1)
1017 return (1);
1018 if (buf[1] != '[')
1019 return (-1);
1020 if (len == 2)
1021 return (1);
1024 * Third byte is M in old standard (and UTF-8 extension which we do not
1025 * support), < in SGR extension.
1027 if (buf[2] == 'M') {
1028 /* Read the three inputs. */
1029 *size = 3;
1030 for (i = 0; i < 3; i++) {
1031 if (len <= *size)
1032 return (1);
1033 ch = (u_char)buf[(*size)++];
1034 if (i == 0)
1035 b = ch;
1036 else if (i == 1)
1037 x = ch;
1038 else
1039 y = ch;
1041 log_debug("%s: mouse input: %.*s", c->name, (int)*size, buf);
1043 /* Check and return the mouse input. */
1044 if (b < MOUSE_PARAM_BTN_OFF ||
1045 x < MOUSE_PARAM_POS_OFF ||
1046 y < MOUSE_PARAM_POS_OFF)
1047 return (-1);
1048 b -= MOUSE_PARAM_BTN_OFF;
1049 x -= MOUSE_PARAM_POS_OFF;
1050 y -= MOUSE_PARAM_POS_OFF;
1051 } else if (buf[2] == '<') {
1052 /* Read the three inputs. */
1053 *size = 3;
1054 while (1) {
1055 if (len <= *size)
1056 return (1);
1057 ch = (u_char)buf[(*size)++];
1058 if (ch == ';')
1059 break;
1060 if (ch < '0' || ch > '9')
1061 return (-1);
1062 sgr_b = 10 * sgr_b + (ch - '0');
1064 while (1) {
1065 if (len <= *size)
1066 return (1);
1067 ch = (u_char)buf[(*size)++];
1068 if (ch == ';')
1069 break;
1070 if (ch < '0' || ch > '9')
1071 return (-1);
1072 x = 10 * x + (ch - '0');
1074 while (1) {
1075 if (len <= *size)
1076 return (1);
1077 ch = (u_char)buf[(*size)++];
1078 if (ch == 'M' || ch == 'm')
1079 break;
1080 if (ch < '0' || ch > '9')
1081 return (-1);
1082 y = 10 * y + (ch - '0');
1084 log_debug("%s: mouse input (SGR): %.*s", c->name, (int)*size,
1085 buf);
1087 /* Check and return the mouse input. */
1088 if (x < 1 || y < 1)
1089 return (-1);
1090 x--;
1091 y--;
1092 b = sgr_b;
1094 /* Type is M for press, m for release. */
1095 sgr_type = ch;
1096 if (sgr_type == 'm')
1097 b = 3;
1100 * Some terminals (like PuTTY 0.63) mistakenly send
1101 * button-release events for scroll-wheel button-press event.
1102 * Discard it before it reaches any program running inside
1103 * tmux.
1105 if (sgr_type == 'm' && MOUSE_WHEEL(sgr_b))
1106 return (-2);
1107 } else
1108 return (-1);
1110 /* Fill mouse event. */
1111 m->lx = tty->mouse_last_x;
1112 m->x = x;
1113 m->ly = tty->mouse_last_y;
1114 m->y = y;
1115 m->lb = tty->mouse_last_b;
1116 m->b = b;
1117 m->sgr_type = sgr_type;
1118 m->sgr_b = sgr_b;
1120 /* Update last mouse state. */
1121 tty->mouse_last_x = x;
1122 tty->mouse_last_y = y;
1123 tty->mouse_last_b = b;
1125 return (0);
1129 * Handle OSC 52 clipboard input. Returns 0 for success, -1 for failure, 1 for
1130 * partial.
1132 static int
1133 tty_keys_clipboard(struct tty *tty, const char *buf, size_t len, size_t *size)
1135 struct client *c = tty->client;
1136 struct window_pane *wp;
1137 size_t end, terminator, needed;
1138 char *copy, *out;
1139 int outlen;
1140 u_int i;
1142 *size = 0;
1144 /* First five bytes are always \033]52;. */
1145 if (buf[0] != '\033')
1146 return (-1);
1147 if (len == 1)
1148 return (1);
1149 if (buf[1] != ']')
1150 return (-1);
1151 if (len == 2)
1152 return (1);
1153 if (buf[2] != '5')
1154 return (-1);
1155 if (len == 3)
1156 return (1);
1157 if (buf[3] != '2')
1158 return (-1);
1159 if (len == 4)
1160 return (1);
1161 if (buf[4] != ';')
1162 return (-1);
1163 if (len == 5)
1164 return (1);
1166 /* Find the terminator if any. */
1167 for (end = 5; end < len; end++) {
1168 if (buf[end] == '\007') {
1169 terminator = 1;
1170 break;
1172 if (end > 5 && buf[end - 1] == '\033' && buf[end] == '\\') {
1173 terminator = 2;
1174 break;
1177 if (end == len)
1178 return (1);
1179 *size = end + terminator;
1181 /* Skip the initial part. */
1182 buf += 5;
1183 end -= 5;
1185 /* Adjust end so that it points to the start of the terminator. */
1186 end -= terminator - 1;
1188 /* Get the second argument. */
1189 while (end != 0 && *buf != ';') {
1190 buf++;
1191 end--;
1193 if (end == 0 || end == 1)
1194 return (0);
1195 buf++;
1196 end--;
1198 /* If we did not request this, ignore it. */
1199 if (~tty->flags & TTY_OSC52QUERY)
1200 return (0);
1201 tty->flags &= ~TTY_OSC52QUERY;
1202 evtimer_del(&tty->clipboard_timer);
1204 /* It has to be a string so copy it. */
1205 copy = xmalloc(end + 1);
1206 memcpy(copy, buf, end);
1207 copy[end] = '\0';
1209 /* Convert from base64. */
1210 needed = (end / 4) * 3;
1211 out = xmalloc(needed);
1212 if ((outlen = b64_pton(copy, out, len)) == -1) {
1213 free(out);
1214 free(copy);
1215 return (0);
1217 free(copy);
1219 /* Create a new paste buffer and forward to panes. */
1220 log_debug("%s: %.*s", __func__, outlen, out);
1221 if (c->flags & CLIENT_CLIPBOARDBUFFER) {
1222 paste_add(NULL, out, outlen);
1223 c->flags &= ~CLIENT_CLIPBOARDBUFFER;
1225 for (i = 0; i < c->clipboard_npanes; i++) {
1226 wp = window_pane_find_by_id(c->clipboard_panes[i]);
1227 if (wp != NULL)
1228 input_reply_clipboard(wp->event, out, outlen, "\033\\");
1230 free(c->clipboard_panes);
1231 c->clipboard_panes = NULL;
1232 c->clipboard_npanes = 0;
1234 return (0);
1238 * Handle secondary device attributes input. Returns 0 for success, -1 for
1239 * failure, 1 for partial.
1241 static int
1242 tty_keys_device_attributes(struct tty *tty, const char *buf, size_t len,
1243 size_t *size)
1245 struct client *c = tty->client;
1246 u_int i, n = 0;
1247 char tmp[64], *endptr, p[32] = { 0 }, *cp, *next;
1249 *size = 0;
1250 if (tty->flags & TTY_HAVEDA)
1251 return (-1);
1254 * First three bytes are always \033[>. Some older Terminal.app
1255 * versions respond as for DA (\033[?) so accept and ignore that.
1257 if (buf[0] != '\033')
1258 return (-1);
1259 if (len == 1)
1260 return (1);
1261 if (buf[1] != '[')
1262 return (-1);
1263 if (len == 2)
1264 return (1);
1265 if (buf[2] != '>' && buf[2] != '?')
1266 return (-1);
1267 if (len == 3)
1268 return (1);
1270 /* Copy the rest up to a 'c'. */
1271 for (i = 0; i < (sizeof tmp) - 1; i++) {
1272 if (3 + i == len)
1273 return (1);
1274 if (buf[3 + i] == 'c')
1275 break;
1276 tmp[i] = buf[3 + i];
1278 if (i == (sizeof tmp) - 1)
1279 return (-1);
1280 tmp[i] = '\0';
1281 *size = 4 + i;
1283 /* Ignore DA response. */
1284 if (buf[2] == '?')
1285 return (0);
1287 /* Convert all arguments to numbers. */
1288 cp = tmp;
1289 while ((next = strsep(&cp, ";")) != NULL) {
1290 p[n] = strtoul(next, &endptr, 10);
1291 if (*endptr != '\0')
1292 p[n] = 0;
1293 n++;
1296 /* Add terminal features. */
1297 switch (p[0]) {
1298 case 41: /* VT420 */
1299 tty_add_features(&c->term_features, "margins,rectfill", ",");
1300 break;
1301 case 'M': /* mintty */
1302 tty_default_features(&c->term_features, "mintty", 0);
1303 break;
1304 case 'T': /* tmux */
1305 tty_default_features(&c->term_features, "tmux", 0);
1306 break;
1307 case 'U': /* rxvt-unicode */
1308 tty_default_features(&c->term_features, "rxvt-unicode", 0);
1309 break;
1311 log_debug("%s: received secondary DA %.*s", c->name, (int)*size, buf);
1313 tty_update_features(tty);
1314 tty->flags |= TTY_HAVEDA;
1316 return (0);
1320 * Handle extended device attributes input. Returns 0 for success, -1 for
1321 * failure, 1 for partial.
1323 static int
1324 tty_keys_extended_device_attributes(struct tty *tty, const char *buf,
1325 size_t len, size_t *size)
1327 struct client *c = tty->client;
1328 u_int i;
1329 char tmp[128];
1331 *size = 0;
1332 if (tty->flags & TTY_HAVEXDA)
1333 return (-1);
1335 /* First four bytes are always \033P>|. */
1336 if (buf[0] != '\033')
1337 return (-1);
1338 if (len == 1)
1339 return (1);
1340 if (buf[1] != 'P')
1341 return (-1);
1342 if (len == 2)
1343 return (1);
1344 if (buf[2] != '>')
1345 return (-1);
1346 if (len == 3)
1347 return (1);
1348 if (buf[3] != '|')
1349 return (-1);
1350 if (len == 4)
1351 return (1);
1353 /* Copy the rest up to a '\033\\'. */
1354 for (i = 0; i < (sizeof tmp) - 1; i++) {
1355 if (4 + i == len)
1356 return (1);
1357 if (buf[4 + i - 1] == '\033' && buf[4 + i] == '\\')
1358 break;
1359 tmp[i] = buf[4 + i];
1361 if (i == (sizeof tmp) - 1)
1362 return (-1);
1363 tmp[i - 1] = '\0';
1364 *size = 5 + i;
1366 /* Add terminal features. */
1367 if (strncmp(tmp, "iTerm2 ", 7) == 0)
1368 tty_default_features(&c->term_features, "iTerm2", 0);
1369 else if (strncmp(tmp, "tmux ", 5) == 0)
1370 tty_default_features(&c->term_features, "tmux", 0);
1371 else if (strncmp(tmp, "XTerm(", 6) == 0)
1372 tty_default_features(&c->term_features, "XTerm", 0);
1373 else if (strncmp(tmp, "mintty ", 7) == 0)
1374 tty_default_features(&c->term_features, "mintty", 0);
1375 log_debug("%s: received extended DA %.*s", c->name, (int)*size, buf);
1377 free(c->term_type);
1378 c->term_type = xstrdup(tmp);
1380 tty_update_features(tty);
1381 tty->flags |= TTY_HAVEXDA;
1383 return (0);