xref: /openbsd-src/usr.bin/tmux/input-keys.c (revision d0e419ec6e21287eef292ef3bfd58b43325f80d4)
1 /* $OpenBSD: input-keys.c,v 1.4 2009/10/11 07:01:10 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 
21 #include <stdint.h>
22 #include <stdlib.h>
23 #include <string.h>
24 
25 #include "tmux.h"
26 
27 struct input_key_ent {
28 	int		 key;
29 	const char	*data;
30 
31 	int		 flags;
32 #define INPUTKEY_KEYPAD 0x1	/* keypad key */
33 #define INPUTKEY_CURSOR 0x2	/* cursor key */
34 #define INPUTKEY_CTRL 0x4	/* may be modified with ctrl */
35 #define INPUTKEY_XTERM 0x4	/* may have xterm argument appended */
36 };
37 
38 struct input_key_ent input_keys[] = {
39 	/* Backspace key. */
40 	{ KEYC_BSPACE, "\177",	   0 },
41 
42 	/* Function keys. */
43 	{ KEYC_F1,     "\033OP",   INPUTKEY_CTRL|INPUTKEY_XTERM },
44 	{ KEYC_F2,     "\033OQ",   INPUTKEY_CTRL|INPUTKEY_XTERM },
45 	{ KEYC_F3,     "\033OR",   INPUTKEY_CTRL|INPUTKEY_XTERM },
46 	{ KEYC_F4,     "\033OS",   INPUTKEY_CTRL|INPUTKEY_XTERM },
47 	{ KEYC_F5,     "\033[15~", INPUTKEY_CTRL|INPUTKEY_XTERM },
48 	{ KEYC_F6,     "\033[17~", INPUTKEY_CTRL|INPUTKEY_XTERM },
49 	{ KEYC_F7,     "\033[18~", INPUTKEY_CTRL|INPUTKEY_XTERM },
50 	{ KEYC_F8,     "\033[19~", INPUTKEY_CTRL|INPUTKEY_XTERM },
51 	{ KEYC_F9,     "\033[20~", INPUTKEY_CTRL|INPUTKEY_XTERM },
52 	{ KEYC_F10,    "\033[21~", INPUTKEY_CTRL|INPUTKEY_XTERM },
53 	{ KEYC_F11,    "\033[23~", INPUTKEY_CTRL|INPUTKEY_XTERM },
54 	{ KEYC_F12,    "\033[24~", INPUTKEY_CTRL|INPUTKEY_XTERM },
55 	{ KEYC_F13,    "\033[25~", INPUTKEY_CTRL|INPUTKEY_XTERM },
56 	{ KEYC_F14,    "\033[26~", INPUTKEY_CTRL|INPUTKEY_XTERM },
57 	{ KEYC_F15,    "\033[28~", INPUTKEY_CTRL|INPUTKEY_XTERM },
58 	{ KEYC_F16,    "\033[29~", INPUTKEY_CTRL|INPUTKEY_XTERM },
59 	{ KEYC_F17,    "\033[31~", INPUTKEY_CTRL|INPUTKEY_XTERM },
60 	{ KEYC_F18,    "\033[32~", INPUTKEY_CTRL|INPUTKEY_XTERM },
61 	{ KEYC_F19,    "\033[33~", INPUTKEY_CTRL|INPUTKEY_XTERM },
62 	{ KEYC_F20,    "\033[34~", INPUTKEY_CTRL|INPUTKEY_XTERM },
63 	{ KEYC_IC,     "\033[2~",  INPUTKEY_CTRL|INPUTKEY_XTERM },
64 	{ KEYC_DC,     "\033[3~",  INPUTKEY_CTRL|INPUTKEY_XTERM },
65 	{ KEYC_HOME,   "\033[1~",  INPUTKEY_CTRL|INPUTKEY_XTERM },
66 	{ KEYC_END,    "\033[4~",  INPUTKEY_CTRL|INPUTKEY_XTERM },
67 	{ KEYC_NPAGE,  "\033[6~",  INPUTKEY_CTRL|INPUTKEY_XTERM },
68 	{ KEYC_PPAGE,  "\033[5~",  INPUTKEY_CTRL|INPUTKEY_XTERM },
69 	{ KEYC_BTAB,   "\033[Z",   INPUTKEY_CTRL },
70 
71 	/* Arrow keys. Cursor versions must come first. */
72 	{ KEYC_UP | KEYC_CTRL,     "\033Oa", 0 },
73 	{ KEYC_DOWN | KEYC_CTRL,   "\033Ob", 0 },
74 	{ KEYC_RIGHT | KEYC_CTRL,  "\033Oc", 0 },
75 	{ KEYC_LEFT | KEYC_CTRL,   "\033Od", 0 },
76 
77 	{ KEYC_UP | KEYC_SHIFT,    "\033[a", 0 },
78 	{ KEYC_DOWN | KEYC_SHIFT,  "\033[b", 0 },
79 	{ KEYC_RIGHT | KEYC_SHIFT, "\033[c", 0 },
80 	{ KEYC_LEFT | KEYC_SHIFT,  "\033[d", 0 },
81 
82 	{ KEYC_UP,     "\033OA",   INPUTKEY_CURSOR },
83 	{ KEYC_DOWN,   "\033OB",   INPUTKEY_CURSOR },
84 	{ KEYC_RIGHT,  "\033OC",   INPUTKEY_CURSOR },
85 	{ KEYC_LEFT,   "\033OD",   INPUTKEY_CURSOR },
86 
87 	{ KEYC_UP,     "\033[A",   0 },
88 	{ KEYC_DOWN,   "\033[B",   0 },
89 	{ KEYC_RIGHT,  "\033[C",   0 },
90 	{ KEYC_LEFT,   "\033[D",   0 },
91 
92 	/* Keypad keys. Keypad versions must come first. */
93 	{ KEYC_KP0_1,  "/", INPUTKEY_KEYPAD },
94 	{ KEYC_KP0_2,  "*", INPUTKEY_KEYPAD },
95 	{ KEYC_KP0_3,  "-", INPUTKEY_KEYPAD },
96 	{ KEYC_KP1_0,  "7", INPUTKEY_KEYPAD },
97 	{ KEYC_KP1_1,  "8", INPUTKEY_KEYPAD },
98 	{ KEYC_KP1_2,  "9", INPUTKEY_KEYPAD },
99 	{ KEYC_KP1_3,  "+", INPUTKEY_KEYPAD },
100 	{ KEYC_KP2_0,  "4", INPUTKEY_KEYPAD },
101 	{ KEYC_KP2_1,  "5", INPUTKEY_KEYPAD },
102 	{ KEYC_KP2_2,  "6", INPUTKEY_KEYPAD },
103 	{ KEYC_KP3_0,  "1", INPUTKEY_KEYPAD },
104 	{ KEYC_KP3_1,  "2", INPUTKEY_KEYPAD },
105 	{ KEYC_KP3_2,  "3", INPUTKEY_KEYPAD },
106 	{ KEYC_KP3_3,  "\n", INPUTKEY_KEYPAD }, /* this can be CRLF too? */
107 	{ KEYC_KP4_0,  "0", INPUTKEY_KEYPAD },
108 	{ KEYC_KP4_2,  ".", INPUTKEY_KEYPAD },
109 	{ KEYC_KP0_1,  "\033Oo", 0 },
110 	{ KEYC_KP0_2,  "\033Oj", 0 },
111 	{ KEYC_KP0_3,  "\033Om", 0 },
112 	{ KEYC_KP1_0,  "\033Ow", 0 },
113 	{ KEYC_KP1_1,  "\033Ox", 0 },
114 	{ KEYC_KP1_2,  "\033Oy", 0 },
115 	{ KEYC_KP1_3,  "\033Ok", 0 },
116 	{ KEYC_KP2_0,  "\033Ot", 0 },
117 	{ KEYC_KP2_1,  "\033Ou", 0 },
118 	{ KEYC_KP2_2,  "\033Ov", 0 },
119 	{ KEYC_KP3_0,  "\033Oq", 0 },
120 	{ KEYC_KP3_1,  "\033Or", 0 },
121 	{ KEYC_KP3_2,  "\033Os", 0 },
122 	{ KEYC_KP3_3,  "\033OM", 0 },
123 	{ KEYC_KP4_0,  "\033Op", 0 },
124 	{ KEYC_KP4_2,  "\033On", 0 },
125 };
126 
127 /* Translate a key code from client into an output key sequence. */
128 void
129 input_key(struct window_pane *wp, int key)
130 {
131 	struct input_key_ent   *ike;
132 	u_int			i;
133 	char			ch;
134 	size_t			dlen;
135 	int			xterm_keys;
136 
137 	log_debug2("writing key 0x%x", key);
138 
139 	if (key != KEYC_NONE && (key & ~KEYC_ESCAPE) < 0x100) {
140 		if (key & KEYC_ESCAPE)
141 			buffer_write8(wp->out, '\033');
142 		buffer_write8(wp->out, (uint8_t) (key & ~KEYC_ESCAPE));
143 		return;
144 	}
145 
146 	for (i = 0; i < nitems(input_keys); i++) {
147 		ike = &input_keys[i];
148 
149 		if ((ike->flags & INPUTKEY_KEYPAD) &&
150 		    !(wp->screen->mode & MODE_KKEYPAD))
151 			continue;
152 		if ((ike->flags & INPUTKEY_CURSOR) &&
153 		    !(wp->screen->mode & MODE_KCURSOR))
154 			continue;
155 
156 		if ((key & KEYC_ESCAPE) && (ike->key | KEYC_ESCAPE) == key)
157 			break;
158 		if ((key & KEYC_SHIFT) && (ike->key | KEYC_SHIFT) == key)
159 			break;
160 		if ((key & KEYC_CTRL) && (ike->key | KEYC_CTRL) == key) {
161 			if (ike->flags & INPUTKEY_CTRL)
162 				break;
163 		}
164 		if (ike->key == key)
165 			break;
166 	}
167 	if (i == nitems(input_keys)) {
168 		log_debug2("key 0x%x missing", key);
169 		return;
170 	}
171 	dlen = strlen(ike->data);
172 
173 	log_debug2("found key 0x%x: \"%s\"", key, ike->data);
174 
175 	/*
176 	 * If in xterm keys mode, work out and append the modifier as an
177 	 * argument.
178 	 */
179 	xterm_keys = options_get_number(&wp->window->options, "xterm-keys");
180 	if (xterm_keys && ike->flags & INPUTKEY_XTERM) {
181 		ch = '\0';
182 		if (key & (KEYC_SHIFT|KEYC_ESCAPE|KEYC_CTRL))
183 			ch = '8';
184 		else if (key & (KEYC_ESCAPE|KEYC_CTRL))
185 			ch = '7';
186 		else if (key & (KEYC_SHIFT|KEYC_CTRL))
187 			ch = '6';
188 		else if (key & KEYC_CTRL)
189 			ch = '5';
190 		else if (key & (KEYC_SHIFT|KEYC_ESCAPE))
191 			ch = '4';
192 		else if (key & KEYC_ESCAPE)
193 			ch = '3';
194 		else if (key & KEYC_SHIFT)
195 			ch = '2';
196 		if (ch != '\0') {
197 			buffer_write(wp->out, ike->data, dlen - 1);
198 			buffer_write8(wp->out, ';');
199 			buffer_write8(wp->out, ch);
200 			buffer_write8(wp->out, ike->data[dlen - 1]);
201 		} else
202 			buffer_write(wp->out, ike->data, dlen);
203 		return;
204 	}
205 
206 	/*
207 	 * Not in xterm mode. Prefix a \033 for escape, and set bit 5 of the
208 	 * last byte for ctrl.
209 	 */
210 	if (key & KEYC_ESCAPE)
211 		buffer_write8(wp->out, '\033');
212 	if (key & KEYC_CTRL && ike->flags & INPUTKEY_CTRL) {
213 		buffer_write(wp->out, ike->data, dlen - 1);
214 		buffer_write8(wp->out, ike->data[dlen - 1] ^ 0x20);
215 		return;
216 	}
217 	buffer_write(wp->out, ike->data, dlen);
218 }
219 
220 /* Handle input mouse. */
221 void
222 input_mouse(struct window_pane *wp, struct mouse_event *m)
223 {
224 	if (wp->screen->mode & MODE_MOUSE) {
225 		buffer_write(wp->out, "\033[M", 3);
226 		buffer_write8(wp->out, m->b + 32);
227 		buffer_write8(wp->out, m->x + 33);
228 		buffer_write8(wp->out, m->y + 33);
229 	}
230 }
231