xref: /openbsd-src/usr.bin/tmux/input-keys.c (revision 4f6960c5c019fb21438350fe34ebd372d62dadda)
1 /* $OpenBSD: input-keys.c,v 1.7 2009/10/26 13:22:30 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 };
36 
37 struct input_key_ent input_keys[] = {
38 	/* Backspace key. */
39 	{ KEYC_BSPACE,		"\177",		0 },
40 
41 	/* Function keys. */
42 	{ KEYC_F1,		"\033OP",	INPUTKEY_CTRL },
43 	{ KEYC_F2,		"\033OQ",	INPUTKEY_CTRL },
44 	{ KEYC_F3,		"\033OR",	INPUTKEY_CTRL },
45 	{ KEYC_F4,		"\033OS",	INPUTKEY_CTRL },
46 	{ KEYC_F5,		"\033[15~",	INPUTKEY_CTRL },
47 	{ KEYC_F6,		"\033[17~",	INPUTKEY_CTRL },
48 	{ KEYC_F7,		"\033[18~",	INPUTKEY_CTRL },
49 	{ KEYC_F8,		"\033[19~",	INPUTKEY_CTRL },
50 	{ KEYC_F9,		"\033[20~",	INPUTKEY_CTRL },
51 	{ KEYC_F10,		"\033[21~",	INPUTKEY_CTRL },
52 	{ KEYC_F11,		"\033[23~",	INPUTKEY_CTRL },
53 	{ KEYC_F12,		"\033[24~",	INPUTKEY_CTRL },
54 	{ KEYC_F13,		"\033[25~",	INPUTKEY_CTRL },
55 	{ KEYC_F14,		"\033[26~",	INPUTKEY_CTRL },
56 	{ KEYC_F15,		"\033[28~",	INPUTKEY_CTRL },
57 	{ KEYC_F16,		"\033[29~",	INPUTKEY_CTRL },
58 	{ KEYC_F17,		"\033[31~",	INPUTKEY_CTRL },
59 	{ KEYC_F18,		"\033[32~",	INPUTKEY_CTRL },
60 	{ KEYC_F19,		"\033[33~",	INPUTKEY_CTRL },
61 	{ KEYC_F20,		"\033[34~",	INPUTKEY_CTRL },
62 	{ KEYC_IC,		"\033[2~",	INPUTKEY_CTRL },
63 	{ KEYC_DC,		"\033[3~",	INPUTKEY_CTRL },
64 	{ KEYC_HOME,		"\033[1~",	INPUTKEY_CTRL },
65 	{ KEYC_END,		"\033[4~",	INPUTKEY_CTRL },
66 	{ KEYC_NPAGE,		"\033[6~",	INPUTKEY_CTRL },
67 	{ KEYC_PPAGE,		"\033[5~",	INPUTKEY_CTRL },
68 	{ KEYC_BTAB,		"\033[Z",	INPUTKEY_CTRL },
69 
70 	/* Arrow keys. Cursor versions must come first .*/
71 	{ KEYC_UP|KEYC_CTRL,	"\033Oa",	0 },
72 	{ KEYC_DOWN|KEYC_CTRL,	"\033Ob",	0 },
73 	{ KEYC_RIGHT|KEYC_CTRL,	"\033Oc",	0 },
74 	{ KEYC_LEFT|KEYC_CTRL,	"\033Od",	0 },
75 
76 	{ KEYC_UP|KEYC_SHIFT,	"\033[a",	0 },
77 	{ KEYC_DOWN|KEYC_SHIFT,	"\033[b",	0 },
78 	{ KEYC_RIGHT|KEYC_SHIFT,"\033[c",	0 },
79 	{ KEYC_LEFT|KEYC_SHIFT,	"\033[d",	0 },
80 
81 	{ KEYC_UP,		"\033OA",	INPUTKEY_CURSOR },
82 	{ KEYC_DOWN,		"\033OB",	INPUTKEY_CURSOR },
83 	{ KEYC_RIGHT,		"\033OC",	INPUTKEY_CURSOR },
84 	{ KEYC_LEFT,		"\033OD",	INPUTKEY_CURSOR },
85 
86 	{ KEYC_UP,		"\033[A",	0 },
87 	{ KEYC_DOWN,		"\033[B",	0 },
88 	{ KEYC_RIGHT,		"\033[C",	0 },
89 	{ KEYC_LEFT,		"\033[D",	0 },
90 
91 	/* Keypad keys. Keypad versions must come first.*/
92 	{ KEYC_KP_SLASH,	"/",		INPUTKEY_KEYPAD },
93 	{ KEYC_KP_STAR,		"*",		INPUTKEY_KEYPAD },
94 	{ KEYC_KP_MINUS,	"-",		INPUTKEY_KEYPAD },
95 	{ KEYC_KP_SEVEN,	"7",		INPUTKEY_KEYPAD },
96 	{ KEYC_KP_EIGHT,	"8",		INPUTKEY_KEYPAD },
97 	{ KEYC_KP_NINE,		"9",		INPUTKEY_KEYPAD },
98 	{ KEYC_KP_PLUS,		"+",		INPUTKEY_KEYPAD },
99 	{ KEYC_KP_FOUR,		"4",		INPUTKEY_KEYPAD },
100 	{ KEYC_KP_FIVE,		"5",		INPUTKEY_KEYPAD },
101 	{ KEYC_KP_SIX,		"6",		INPUTKEY_KEYPAD },
102 	{ KEYC_KP_ONE,		"1",		INPUTKEY_KEYPAD },
103 	{ KEYC_KP_TWO,		"2",		INPUTKEY_KEYPAD },
104 	{ KEYC_KP_THREE,	"3",		INPUTKEY_KEYPAD },
105 	{ KEYC_KP_ENTER,	"\n",		INPUTKEY_KEYPAD },
106 	{ KEYC_KP_ZERO,		"0",		INPUTKEY_KEYPAD },
107 	{ KEYC_KP_PERIOD,	".",		INPUTKEY_KEYPAD },
108 
109 	{ KEYC_KP_SLASH,	"\033Oo",	0 },
110 	{ KEYC_KP_STAR,		"\033Oj",	0 },
111 	{ KEYC_KP_MINUS,	"\033Om",	0 },
112 	{ KEYC_KP_SEVEN,	"\033Ow",	0 },
113 	{ KEYC_KP_EIGHT,	"\033Ox",	0 },
114 	{ KEYC_KP_NINE,		"\033Oy",	0 },
115 	{ KEYC_KP_PLUS,		"\033Ok",	0 },
116 	{ KEYC_KP_FOUR,		"\033Ot",	0 },
117 	{ KEYC_KP_FIVE,		"\033Ou",	0 },
118 	{ KEYC_KP_SIX,		"\033Ov",	0 },
119 	{ KEYC_KP_ONE,		"\033Oq",	0 },
120 	{ KEYC_KP_TWO,		"\033Or",	0 },
121 	{ KEYC_KP_THREE,	"\033Os",	0 },
122 	{ KEYC_KP_ENTER,	"\033OM",	0 },
123 	{ KEYC_KP_ZERO,		"\033Op",	0 },
124 	{ KEYC_KP_PERIOD,	"\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 	 * Not in xterm mode. Prefix a \033 for escape, and set bit 5 of the
177 	 * last byte for ctrl.
178 	 */
179 	if (key & KEYC_ESCAPE)
180 		buffer_write8(wp->out, '\033');
181 	if (key & KEYC_CTRL && ike->flags & INPUTKEY_CTRL) {
182 		buffer_write(wp->out, ike->data, dlen - 1);
183 		buffer_write8(wp->out, ike->data[dlen - 1] ^ 0x20);
184 		return;
185 	}
186 	buffer_write(wp->out, ike->data, dlen);
187 }
188 
189 /* Handle input mouse. */
190 void
191 input_mouse(struct window_pane *wp, struct mouse_event *m)
192 {
193 	if (wp->screen->mode & MODE_MOUSE) {
194 		buffer_write(wp->out, "\033[M", 3);
195 		buffer_write8(wp->out, m->b + 32);
196 		buffer_write8(wp->out, m->x + 33);
197 		buffer_write8(wp->out, m->y + 33);
198 	}
199 }
200