GCC Code Coverage Report
Directory: ./ Exec Total Coverage
File: usr.bin/tmux/input-keys.c Lines: 0 71 0.0 %
Date: 2016-12-06 Branches: 0 68 0.0 %

Line Branch Exec Source
1
/* $OpenBSD: input-keys.c,v 1.55 2016/03/02 15:33:36 nicm Exp $ */
2
3
/*
4
 * Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com>
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
21
#include <stdint.h>
22
#include <stdlib.h>
23
#include <string.h>
24
25
#include "tmux.h"
26
27
/*
28
 * This file is rather misleadingly named, it contains the code which takes a
29
 * key code and translates it into something suitable to be sent to the
30
 * application running in a pane (similar to input.c does in the other
31
 * direction with output).
32
 */
33
34
void	 input_key_mouse(struct window_pane *, struct mouse_event *);
35
36
struct input_key_ent {
37
	key_code	 key;
38
	const char	*data;
39
40
	int		 flags;
41
#define INPUTKEY_KEYPAD 0x1	/* keypad key */
42
#define INPUTKEY_CURSOR 0x2	/* cursor key */
43
};
44
45
const struct input_key_ent input_keys[] = {
46
	/* Backspace key. */
47
	{ KEYC_BSPACE,		"\177",		0 },
48
49
	/* Function keys. */
50
	{ KEYC_F1,		"\033OP",	0 },
51
	{ KEYC_F2,		"\033OQ",	0 },
52
	{ KEYC_F3,		"\033OR",	0 },
53
	{ KEYC_F4,		"\033OS",	0 },
54
	{ KEYC_F5,		"\033[15~",	0 },
55
	{ KEYC_F6,		"\033[17~",	0 },
56
	{ KEYC_F7,		"\033[18~",	0 },
57
	{ KEYC_F8,		"\033[19~",	0 },
58
	{ KEYC_F9,		"\033[20~",	0 },
59
	{ KEYC_F10,		"\033[21~",	0 },
60
	{ KEYC_F11,		"\033[23~",	0 },
61
	{ KEYC_F12,		"\033[24~",	0 },
62
	{ KEYC_F1|KEYC_SHIFT,	"\033[25~",	0 },
63
	{ KEYC_F2|KEYC_SHIFT,	"\033[26~",	0 },
64
	{ KEYC_F3|KEYC_SHIFT,	"\033[28~",	0 },
65
	{ KEYC_F4|KEYC_SHIFT,	"\033[29~",	0 },
66
	{ KEYC_F5|KEYC_SHIFT,	"\033[31~",	0 },
67
	{ KEYC_F6|KEYC_SHIFT,	"\033[32~",	0 },
68
	{ KEYC_F7|KEYC_SHIFT,	"\033[33~",	0 },
69
	{ KEYC_F8|KEYC_SHIFT,	"\033[34~",	0 },
70
	{ KEYC_IC,		"\033[2~",	0 },
71
	{ KEYC_DC,		"\033[3~",	0 },
72
	{ KEYC_HOME,		"\033[1~",	0 },
73
	{ KEYC_END,		"\033[4~",	0 },
74
	{ KEYC_NPAGE,		"\033[6~",	0 },
75
	{ KEYC_PPAGE,		"\033[5~",	0 },
76
	{ KEYC_BTAB,		"\033[Z",	0 },
77
78
	/*
79
	 * Arrow keys. Cursor versions must come first. The codes are toggled
80
	 * between CSI and SS3 versions when ctrl is pressed.
81
	 */
82
	{ KEYC_UP|KEYC_CTRL,	"\033[A",	INPUTKEY_CURSOR },
83
	{ KEYC_DOWN|KEYC_CTRL,	"\033[B",	INPUTKEY_CURSOR },
84
	{ KEYC_RIGHT|KEYC_CTRL,	"\033[C",	INPUTKEY_CURSOR },
85
	{ KEYC_LEFT|KEYC_CTRL,	"\033[D",	INPUTKEY_CURSOR },
86
87
	{ KEYC_UP,		"\033OA",	INPUTKEY_CURSOR },
88
	{ KEYC_DOWN,		"\033OB",	INPUTKEY_CURSOR },
89
	{ KEYC_RIGHT,		"\033OC",	INPUTKEY_CURSOR },
90
	{ KEYC_LEFT,		"\033OD",	INPUTKEY_CURSOR },
91
92
	{ KEYC_UP|KEYC_CTRL,	"\033OA",	0 },
93
	{ KEYC_DOWN|KEYC_CTRL,	"\033OB",	0 },
94
	{ KEYC_RIGHT|KEYC_CTRL,	"\033OC",	0 },
95
	{ KEYC_LEFT|KEYC_CTRL,	"\033OD",	0 },
96
97
	{ KEYC_UP,		"\033[A",	0 },
98
	{ KEYC_DOWN,		"\033[B",	0 },
99
	{ KEYC_RIGHT,		"\033[C",	0 },
100
	{ KEYC_LEFT,		"\033[D",	0 },
101
102
	/* Keypad keys. Keypad versions must come first. */
103
	{ KEYC_KP_SLASH,	"\033Oo",	INPUTKEY_KEYPAD },
104
	{ KEYC_KP_STAR,		"\033Oj",	INPUTKEY_KEYPAD },
105
	{ KEYC_KP_MINUS,	"\033Om",	INPUTKEY_KEYPAD },
106
	{ KEYC_KP_SEVEN,	"\033Ow",	INPUTKEY_KEYPAD },
107
	{ KEYC_KP_EIGHT,	"\033Ox",	INPUTKEY_KEYPAD },
108
	{ KEYC_KP_NINE,		"\033Oy",	INPUTKEY_KEYPAD },
109
	{ KEYC_KP_PLUS,		"\033Ok",	INPUTKEY_KEYPAD },
110
	{ KEYC_KP_FOUR,		"\033Ot",	INPUTKEY_KEYPAD },
111
	{ KEYC_KP_FIVE,		"\033Ou",	INPUTKEY_KEYPAD },
112
	{ KEYC_KP_SIX,		"\033Ov",	INPUTKEY_KEYPAD },
113
	{ KEYC_KP_ONE,		"\033Oq",	INPUTKEY_KEYPAD },
114
	{ KEYC_KP_TWO,		"\033Or",	INPUTKEY_KEYPAD },
115
	{ KEYC_KP_THREE,	"\033Os",	INPUTKEY_KEYPAD },
116
	{ KEYC_KP_ENTER,	"\033OM",	INPUTKEY_KEYPAD },
117
	{ KEYC_KP_ZERO,		"\033Op",	INPUTKEY_KEYPAD },
118
	{ KEYC_KP_PERIOD,	"\033On",	INPUTKEY_KEYPAD },
119
120
	{ KEYC_KP_SLASH,	"/",		0 },
121
	{ KEYC_KP_STAR,		"*",		0 },
122
	{ KEYC_KP_MINUS,	"-",		0 },
123
	{ KEYC_KP_SEVEN,	"7",		0 },
124
	{ KEYC_KP_EIGHT,	"8",		0 },
125
	{ KEYC_KP_NINE,		"9",		0 },
126
	{ KEYC_KP_PLUS,		"+",		0 },
127
	{ KEYC_KP_FOUR,		"4",		0 },
128
	{ KEYC_KP_FIVE,		"5",		0 },
129
	{ KEYC_KP_SIX,		"6",		0 },
130
	{ KEYC_KP_ONE,		"1",		0 },
131
	{ KEYC_KP_TWO,		"2",		0 },
132
	{ KEYC_KP_THREE,	"3",		0 },
133
	{ KEYC_KP_ENTER,	"\n",		0 },
134
	{ KEYC_KP_ZERO,		"0",		0 },
135
	{ KEYC_KP_PERIOD,	".",		0 },
136
};
137
138
/* Split a character into two UTF-8 bytes. */
139
static size_t
140
input_split2(u_int c, u_char *dst)
141
{
142
	if (c > 0x7f) {
143
		dst[0] = (c >> 6) | 0xc0;
144
		dst[1] = (c & 0x3f) | 0x80;
145
		return (2);
146
	}
147
	dst[0] = c;
148
	return (1);
149
}
150
151
/* Translate a key code into an output key sequence. */
152
void
153
input_key(struct window_pane *wp, key_code key, struct mouse_event *m)
154
{
155
	const struct input_key_ent	*ike;
156
	u_int				 i;
157
	size_t				 dlen;
158
	char				*out;
159
	key_code			 justkey;
160
	struct utf8_data		 ud;
161
162
	log_debug("writing key 0x%llx (%s) to %%%u", key,
163
	    key_string_lookup_key(key), wp->id);
164
165
	/* If this is a mouse key, pass off to mouse function. */
166
	if (KEYC_IS_MOUSE(key)) {
167
		if (m != NULL && m->wp != -1 && (u_int)m->wp == wp->id)
168
			input_key_mouse(wp, m);
169
		return;
170
	}
171
172
	/*
173
	 * If this is a normal 7-bit key, just send it, with a leading escape
174
	 * if necessary. If it is a UTF-8 key, split it and send it.
175
	 */
176
	justkey = (key & ~KEYC_ESCAPE);
177
	if (justkey <= 0x7f) {
178
		if (key & KEYC_ESCAPE)
179
			bufferevent_write(wp->event, "\033", 1);
180
		ud.data[0] = justkey;
181
		bufferevent_write(wp->event, &ud.data[0], 1);
182
		return;
183
	}
184
	if (justkey > 0x7f && justkey < KEYC_BASE) {
185
		if (utf8_split(justkey, &ud) != UTF8_DONE)
186
			return;
187
		if (key & KEYC_ESCAPE)
188
			bufferevent_write(wp->event, "\033", 1);
189
		bufferevent_write(wp->event, ud.data, ud.size);
190
		return;
191
	}
192
193
	/*
194
	 * Then try to look this up as an xterm key, if the flag to output them
195
	 * is set.
196
	 */
197
	if (options_get_number(wp->window->options, "xterm-keys")) {
198
		if ((out = xterm_keys_lookup(key)) != NULL) {
199
			bufferevent_write(wp->event, out, strlen(out));
200
			free(out);
201
			return;
202
		}
203
	}
204
205
	/* Otherwise look the key up in the table. */
206
	for (i = 0; i < nitems(input_keys); i++) {
207
		ike = &input_keys[i];
208
209
		if ((ike->flags & INPUTKEY_KEYPAD) &&
210
		    !(wp->screen->mode & MODE_KKEYPAD))
211
			continue;
212
		if ((ike->flags & INPUTKEY_CURSOR) &&
213
		    !(wp->screen->mode & MODE_KCURSOR))
214
			continue;
215
216
		if ((key & KEYC_ESCAPE) && (ike->key | KEYC_ESCAPE) == key)
217
			break;
218
		if (ike->key == key)
219
			break;
220
	}
221
	if (i == nitems(input_keys)) {
222
		log_debug("key 0x%llx missing", key);
223
		return;
224
	}
225
	dlen = strlen(ike->data);
226
	log_debug("found key 0x%llx: \"%s\"", key, ike->data);
227
228
	/* Prefix a \033 for escape. */
229
	if (key & KEYC_ESCAPE)
230
		bufferevent_write(wp->event, "\033", 1);
231
	bufferevent_write(wp->event, ike->data, dlen);
232
}
233
234
/* Translate mouse and output. */
235
void
236
input_key_mouse(struct window_pane *wp, struct mouse_event *m)
237
{
238
	char	buf[40];
239
	size_t	len;
240
	u_int	x, y;
241
242
	if ((wp->screen->mode & ALL_MOUSE_MODES) == 0)
243
		return;
244
	if (!window_pane_visible(wp))
245
		return;
246
	if (cmd_mouse_at(wp, m, &x, &y, 0) != 0)
247
		return;
248
249
	/* If this pane is not in button mode, discard motion events. */
250
	if (!(wp->screen->mode & MODE_MOUSE_BUTTON) && (m->b & MOUSE_MASK_DRAG))
251
		return;
252
253
	/*
254
	 * Use the SGR (1006) extension only if the application requested it
255
	 * and the underlying terminal also sent the event in this format (this
256
	 * is because an old style mouse release event cannot be converted into
257
	 * the new SGR format, since the released button is unknown). Otherwise
258
	 * pretend that tmux doesn't speak this extension, and fall back to the
259
	 * UTF-8 (1005) extension if the application requested, or to the
260
	 * legacy format.
261
	 */
262
	if (m->sgr_type != ' ' && (wp->screen->mode & MODE_MOUSE_SGR)) {
263
		len = xsnprintf(buf, sizeof buf, "\033[<%u;%u;%u%c",
264
		    m->sgr_b, x + 1, y + 1, m->sgr_type);
265
	} else if (wp->screen->mode & MODE_MOUSE_UTF8) {
266
		if (m->b > 0x7ff - 32 || x > 0x7ff - 33 || y > 0x7ff - 33)
267
			return;
268
		len = xsnprintf(buf, sizeof buf, "\033[M");
269
		len += input_split2(m->b + 32, &buf[len]);
270
		len += input_split2(x + 33, &buf[len]);
271
		len += input_split2(y + 33, &buf[len]);
272
	} else {
273
		if (m->b > 223)
274
			return;
275
		len = xsnprintf(buf, sizeof buf, "\033[M");
276
		buf[len++] = m->b + 32;
277
		buf[len++] = x + 33;
278
		buf[len++] = y + 33;
279
	}
280
	log_debug("writing mouse %.*s to %%%u", (int)len, buf, wp->id);
281
	bufferevent_write(wp->event, buf, len);
282
}