key-string.c revision 1.15 
1/* $OpenBSD: key-string.c,v 1.15 2010/04/23 14:27:04 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 <string.h>
22
23#include "tmux.h"
24
25int	key_string_search_table(const char *);
26int	key_string_get_modifiers(const char **);
27
28struct {
29	const char     *string;
30	int	 	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	{ "F13",	KEYC_F13 },
46	{ "F14",	KEYC_F14 },
47	{ "F15",	KEYC_F15 },
48	{ "F16",	KEYC_F16 },
49	{ "F17",	KEYC_F17 },
50	{ "F18",	KEYC_F18 },
51	{ "F19",	KEYC_F19 },
52	{ "F20",	KEYC_F20 },
53	{ "IC",		KEYC_IC },
54	{ "DC",		KEYC_DC },
55	{ "Home",	KEYC_HOME },
56	{ "End",	KEYC_END },
57	{ "NPage",	KEYC_NPAGE },
58	{ "PPage",	KEYC_PPAGE },
59	{ "Tab",	'\011' },
60	{ "BTab",	KEYC_BTAB },
61	{ "Space",	' ' },
62	{ "BSpace",	KEYC_BSPACE },
63	{ "Enter",	'\r' },
64	{ "Escape",	'\033' },
65
66	/* Arrow keys. */
67	{ "Up",		KEYC_UP },
68	{ "Down",	KEYC_DOWN },
69	{ "Left",	KEYC_LEFT },
70	{ "Right",	KEYC_RIGHT },
71
72	/* Numeric keypad. */
73	{ "KP/", 	KEYC_KP_SLASH },
74	{ "KP*",	KEYC_KP_STAR },
75	{ "KP-",	KEYC_KP_MINUS },
76	{ "KP7",	KEYC_KP_SEVEN },
77	{ "KP8",	KEYC_KP_EIGHT },
78	{ "KP9",	KEYC_KP_NINE },
79	{ "KP+",	KEYC_KP_PLUS },
80	{ "KP4",	KEYC_KP_FOUR },
81	{ "KP5",	KEYC_KP_FIVE },
82	{ "KP6",	KEYC_KP_SIX },
83	{ "KP1",	KEYC_KP_ONE },
84	{ "KP2",	KEYC_KP_TWO },
85	{ "KP3",	KEYC_KP_THREE },
86	{ "KPEnter",	KEYC_KP_ENTER },
87	{ "KP0",	KEYC_KP_ZERO },
88	{ "KP.",	KEYC_KP_PERIOD },
89};
90
91/* Find key string in table. */
92int
93key_string_search_table(const char *string)
94{
95	u_int	i;
96
97	for (i = 0; i < nitems(key_string_table); i++) {
98		if (strcasecmp(string, key_string_table[i].string) == 0)
99			return (key_string_table[i].key);
100	}
101	return (KEYC_NONE);
102}
103
104/* Find modifiers. */
105int
106key_string_get_modifiers(const char **string)
107{
108	int	modifiers;
109
110	modifiers = 0;
111	while (((*string)[0] != '\0') && (*string)[1] == '-') {
112		switch ((*string)[0]) {
113		case 'C':
114		case 'c':
115			modifiers |= KEYC_CTRL;
116			break;
117		case 'M':
118		case 'm':
119			modifiers |= KEYC_ESCAPE;
120			break;
121		case 'S':
122		case 's':
123			modifiers |= KEYC_SHIFT;
124			break;
125		}
126		*string += 2;
127	}
128	return (modifiers);
129}
130
131/* Lookup a string and convert to a key value. */
132int
133key_string_lookup_string(const char *string)
134{
135	int	key, modifiers;
136
137	/* Check for modifiers. */
138	modifiers = 0;
139	if (string[0] == '^' && string[1] != '\0') {
140		modifiers |= KEYC_CTRL;
141		string++;
142	}
143	modifiers |= key_string_get_modifiers(&string);
144	if (string[0] == '\0')
145		return (KEYC_NONE);
146
147	/* Is this a standard ASCII key? */
148	if (string[1] == '\0') {
149		key = (u_char) string[0];
150		if (key < 32 || key > 126)
151			return (KEYC_NONE);
152
153		/* Convert the standard control keys. */
154		if (modifiers & KEYC_CTRL) {
155			if (key >= 97 && key <= 122)
156				key -= 96;
157			else if (key >= 65 && key <= 90)
158				key -= 64;
159			else if (key == 32)
160				key = 0;
161			else if (key == 63)
162				key = KEYC_BSPACE;
163			else
164				return (KEYC_NONE);
165			modifiers &= ~KEYC_CTRL;
166		}
167
168		return (key | modifiers);
169	}
170
171	/* Otherwise look the key up in the table. */
172	key = key_string_search_table(string);
173	if (key == KEYC_NONE)
174		return (KEYC_NONE);
175	return (key | modifiers);
176}
177
178/* Convert a key code into string format, with prefix if necessary. */
179const char *
180key_string_lookup_key(int key)
181{
182	static char	out[24];
183	char		tmp[8];
184	u_int	   	i;
185
186	*out = '\0';
187
188	/* Fill in the modifiers. */
189	if (key & KEYC_CTRL)
190		strlcat(out, "C-", sizeof out);
191	if (key & KEYC_ESCAPE)
192		strlcat(out, "M-", sizeof out);
193	if (key & KEYC_SHIFT)
194		strlcat(out, "S-", sizeof out);
195	key &= ~(KEYC_CTRL|KEYC_ESCAPE|KEYC_SHIFT);
196
197	/* Try the key against the string table. */
198	for (i = 0; i < nitems(key_string_table); i++) {
199		if (key == key_string_table[i].key)
200			break;
201	}
202	if (i != nitems(key_string_table)) {
203		strlcat(out, key_string_table[i].string, sizeof out);
204		return (out);
205	}
206
207	/* Invalid keys are errors. */
208	if (key >= 127)
209		return (NULL);
210
211	/* Check for standard or control key. */
212	if (key >= 0 && key <= 32) {
213		if (key == 0 || key > 26)
214			xsnprintf(tmp, sizeof tmp, "C-%c", 64 + key);
215		else
216			xsnprintf(tmp, sizeof tmp, "C-%c", 96 + key);
217	} else if (key >= 32 && key <= 126) {
218		tmp[0] = key;
219		tmp[1] = '\0';
220	}
221	strlcat(out, tmp, sizeof out);
222	return (out);
223}
224