key-string.c revision 1.40 
1/* $OpenBSD: key-string.c,v 1.40 2016/10/11 09:30: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 <string.h>
22
23#include "tmux.h"
24
25static key_code	key_string_search_table(const char *);
26static key_code	key_string_get_modifiers(const char **);
27
28static const struct {
29	const char     *string;
30	key_code	key;
31} key_string_table[] = {
32	/* Function keys. */
33	{ "F1",		KEYC_F1 },
34	{ "F2",		KEYC_F2 },
35	{ "F3",		KEYC_F3 },
36	{ "F4",		KEYC_F4 },
37	{ "F5",		KEYC_F5 },
38	{ "F6",		KEYC_F6 },
39	{ "F7",		KEYC_F7 },
40	{ "F8",		KEYC_F8 },
41	{ "F9",		KEYC_F9 },
42	{ "F10",	KEYC_F10 },
43	{ "F11",	KEYC_F11 },
44	{ "F12",	KEYC_F12 },
45	{ "IC",		KEYC_IC },
46	{ "DC",		KEYC_DC },
47	{ "Home",	KEYC_HOME },
48	{ "End",	KEYC_END },
49	{ "NPage",	KEYC_NPAGE },
50	{ "PageDown",	KEYC_NPAGE },
51	{ "PgDn",	KEYC_NPAGE },
52	{ "PPage",	KEYC_PPAGE },
53	{ "PageUp",	KEYC_PPAGE },
54	{ "PgUp",	KEYC_PPAGE },
55	{ "Tab",	'\011' },
56	{ "BTab",	KEYC_BTAB },
57	{ "Space",	' ' },
58	{ "BSpace",	KEYC_BSPACE },
59	{ "Enter",	'\r' },
60	{ "Escape",	'\033' },
61
62	/* Arrow keys. */
63	{ "Up",		KEYC_UP },
64	{ "Down",	KEYC_DOWN },
65	{ "Left",	KEYC_LEFT },
66	{ "Right",	KEYC_RIGHT },
67
68	/* Numeric keypad. */
69	{ "KP/", 	KEYC_KP_SLASH },
70	{ "KP*",	KEYC_KP_STAR },
71	{ "KP-",	KEYC_KP_MINUS },
72	{ "KP7",	KEYC_KP_SEVEN },
73	{ "KP8",	KEYC_KP_EIGHT },
74	{ "KP9",	KEYC_KP_NINE },
75	{ "KP+",	KEYC_KP_PLUS },
76	{ "KP4",	KEYC_KP_FOUR },
77	{ "KP5",	KEYC_KP_FIVE },
78	{ "KP6",	KEYC_KP_SIX },
79	{ "KP1",	KEYC_KP_ONE },
80	{ "KP2",	KEYC_KP_TWO },
81	{ "KP3",	KEYC_KP_THREE },
82	{ "KPEnter",	KEYC_KP_ENTER },
83	{ "KP0",	KEYC_KP_ZERO },
84	{ "KP.",	KEYC_KP_PERIOD },
85
86	/* Mouse keys. */
87	KEYC_MOUSE_STRING(MOUSEDOWN1, MouseDown1),
88	KEYC_MOUSE_STRING(MOUSEDOWN2, MouseDown2),
89	KEYC_MOUSE_STRING(MOUSEDOWN3, MouseDown3),
90	KEYC_MOUSE_STRING(MOUSEUP1, MouseUp1),
91	KEYC_MOUSE_STRING(MOUSEUP2, MouseUp2),
92	KEYC_MOUSE_STRING(MOUSEUP3, MouseUp3),
93	KEYC_MOUSE_STRING(MOUSEDRAG1, MouseDrag1),
94	KEYC_MOUSE_STRING(MOUSEDRAG2, MouseDrag2),
95	KEYC_MOUSE_STRING(MOUSEDRAG3, MouseDrag3),
96	KEYC_MOUSE_STRING(MOUSEDRAGEND1, MouseDragEnd1),
97	KEYC_MOUSE_STRING(MOUSEDRAGEND2, MouseDragEnd2),
98	KEYC_MOUSE_STRING(MOUSEDRAGEND3, MouseDragEnd3),
99	KEYC_MOUSE_STRING(WHEELUP, WheelUp),
100	KEYC_MOUSE_STRING(WHEELDOWN, WheelDown),
101	KEYC_MOUSE_STRING(DOUBLECLICK1, DoubleClick1),
102	KEYC_MOUSE_STRING(DOUBLECLICK2, DoubleClick2),
103	KEYC_MOUSE_STRING(DOUBLECLICK3, DoubleClick3),
104	KEYC_MOUSE_STRING(TRIPLECLICK1, TripleClick1),
105	KEYC_MOUSE_STRING(TRIPLECLICK2, TripleClick2),
106	KEYC_MOUSE_STRING(TRIPLECLICK3, TripleClick3),
107};
108
109/* Find key string in table. */
110static key_code
111key_string_search_table(const char *string)
112{
113	u_int	i;
114
115	for (i = 0; i < nitems(key_string_table); i++) {
116		if (strcasecmp(string, key_string_table[i].string) == 0)
117			return (key_string_table[i].key);
118	}
119	return (KEYC_UNKNOWN);
120}
121
122/* Find modifiers. */
123static key_code
124key_string_get_modifiers(const char **string)
125{
126	key_code	modifiers;
127
128	modifiers = 0;
129	while (((*string)[0] != '\0') && (*string)[1] == '-') {
130		switch ((*string)[0]) {
131		case 'C':
132		case 'c':
133			modifiers |= KEYC_CTRL;
134			break;
135		case 'M':
136		case 'm':
137			modifiers |= KEYC_ESCAPE;
138			break;
139		case 'S':
140		case 's':
141			modifiers |= KEYC_SHIFT;
142			break;
143		}
144		*string += 2;
145	}
146	return (modifiers);
147}
148
149/* Lookup a string and convert to a key value. */
150key_code
151key_string_lookup_string(const char *string)
152{
153	static const char	*other = "!#()+,-.0123456789:;<=>?'\r\t";
154	key_code		 key;
155	u_int			 u;
156	key_code		 modifiers;
157	struct utf8_data	 ud;
158	u_int			 i;
159	enum utf8_state		 more;
160	wchar_t			 wc;
161
162	/* Is this no key? */
163	if (strcasecmp(string, "None") == 0)
164		return (KEYC_NONE);
165
166	/* Is this a hexadecimal value? */
167	if (string[0] == '0' && string[1] == 'x') {
168	        if (sscanf(string + 2, "%x", &u) != 1)
169	                return (KEYC_UNKNOWN);
170		if (u > 0x1fffff)
171	                return (KEYC_UNKNOWN);
172	        return (u);
173	}
174
175	/* Check for modifiers. */
176	modifiers = 0;
177	if (string[0] == '^' && string[1] != '\0') {
178		modifiers |= KEYC_CTRL;
179		string++;
180	}
181	modifiers |= key_string_get_modifiers(&string);
182	if (string[0] == '\0')
183		return (KEYC_UNKNOWN);
184
185	/* Is this a standard ASCII key? */
186	if (string[1] == '\0' && (u_char)string[0] <= 127) {
187		key = (u_char)string[0];
188		if (key < 32 || key == 127)
189			return (KEYC_UNKNOWN);
190	} else {
191		/* Try as a UTF-8 key. */
192		if ((more = utf8_open(&ud, (u_char)*string)) == UTF8_MORE) {
193			if (strlen(string) != ud.size)
194				return (KEYC_UNKNOWN);
195			for (i = 1; i < ud.size; i++)
196				more = utf8_append(&ud, (u_char)string[i]);
197			if (more != UTF8_DONE)
198				return (KEYC_UNKNOWN);
199			if (utf8_combine(&ud, &wc) != UTF8_DONE)
200				return (KEYC_UNKNOWN);
201			return (wc | modifiers);
202		}
203
204		/* Otherwise look the key up in the table. */
205		key = key_string_search_table(string);
206		if (key == KEYC_UNKNOWN)
207			return (KEYC_UNKNOWN);
208	}
209
210	/* Convert the standard control keys. */
211	if (key < KEYC_BASE && (modifiers & KEYC_CTRL) && !strchr(other, key)) {
212		if (key >= 97 && key <= 122)
213			key -= 96;
214		else if (key >= 64 && key <= 95)
215			key -= 64;
216		else if (key == 32)
217			key = 0;
218		else if (key == 63)
219			key = KEYC_BSPACE;
220		else
221			return (KEYC_UNKNOWN);
222		modifiers &= ~KEYC_CTRL;
223	}
224
225	return (key | modifiers);
226}
227
228/* Convert a key code into string format, with prefix if necessary. */
229const char *
230key_string_lookup_key(key_code key)
231{
232	static char		out[24];
233	char			tmp[8];
234	u_int			i;
235	struct utf8_data	ud;
236	size_t			off;
237
238	*out = '\0';
239
240	/* Handle no key. */
241	if (key == KEYC_NONE)
242		return ("None");
243
244	/* Handle special keys. */
245	if (key == KEYC_UNKNOWN)
246		return ("Unknown");
247	if (key == KEYC_MOUSE)
248		return ("Mouse");
249
250	/*
251	 * Special case: display C-@ as C-Space. Could do this below in
252	 * the (key >= 0 && key <= 32), but this way we let it be found
253	 * in key_string_table, for the unlikely chance that we might
254	 * change its name.
255	 */
256	if ((key & KEYC_MASK_KEY) == 0)
257	    key = ' ' | KEYC_CTRL | (key & KEYC_MASK_MOD);
258
259	/* Fill in the modifiers. */
260	if (key & KEYC_CTRL)
261		strlcat(out, "C-", sizeof out);
262	if (key & KEYC_ESCAPE)
263		strlcat(out, "M-", sizeof out);
264	if (key & KEYC_SHIFT)
265		strlcat(out, "S-", sizeof out);
266	key &= KEYC_MASK_KEY;
267
268	/* Try the key against the string table. */
269	for (i = 0; i < nitems(key_string_table); i++) {
270		if (key == key_string_table[i].key)
271			break;
272	}
273	if (i != nitems(key_string_table)) {
274		strlcat(out, key_string_table[i].string, sizeof out);
275		return (out);
276	}
277
278	/* Is this a UTF-8 key? */
279	if (key > 127 && key < KEYC_BASE) {
280		if (utf8_split(key, &ud) == UTF8_DONE) {
281			off = strlen(out);
282			memcpy(out + off, ud.data, ud.size);
283			out[off + ud.size] = '\0';
284			return (out);
285		}
286	}
287
288	/* Invalid keys are errors. */
289	if (key == 127 || key > 255) {
290		snprintf(out, sizeof out, "Invalid#%llx", key);
291		return (out);
292	}
293
294	/* Check for standard or control key. */
295	if (key <= 32) {
296		if (key == 0 || key > 26)
297			xsnprintf(tmp, sizeof tmp, "C-%c", (int)(64 + key));
298		else
299			xsnprintf(tmp, sizeof tmp, "C-%c", (int)(96 + key));
300	} else if (key >= 32 && key <= 126) {
301		tmp[0] = key;
302		tmp[1] = '\0';
303	} else if (key >= 128)
304		xsnprintf(tmp, sizeof tmp, "\\%llo", key);
305
306	strlcat(out, tmp, sizeof out);
307	return (out);
308}
309