1*0a6a1f1dSLionel Sambuc /* Id */
2eda6f593SDavid van Moolenbroek
3eda6f593SDavid van Moolenbroek /*
4eda6f593SDavid van Moolenbroek * Copyright (c) 2007 Nicholas Marriott <nicm@users.sourceforge.net>
5eda6f593SDavid van Moolenbroek *
6eda6f593SDavid van Moolenbroek * Permission to use, copy, modify, and distribute this software for any
7eda6f593SDavid van Moolenbroek * purpose with or without fee is hereby granted, provided that the above
8eda6f593SDavid van Moolenbroek * copyright notice and this permission notice appear in all copies.
9eda6f593SDavid van Moolenbroek *
10eda6f593SDavid van Moolenbroek * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11eda6f593SDavid van Moolenbroek * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12eda6f593SDavid van Moolenbroek * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13eda6f593SDavid van Moolenbroek * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14eda6f593SDavid van Moolenbroek * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
15eda6f593SDavid van Moolenbroek * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
16eda6f593SDavid van Moolenbroek * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17eda6f593SDavid van Moolenbroek */
18eda6f593SDavid van Moolenbroek
19eda6f593SDavid van Moolenbroek #include <sys/types.h>
20eda6f593SDavid van Moolenbroek
21eda6f593SDavid van Moolenbroek #include <string.h>
22eda6f593SDavid van Moolenbroek
23eda6f593SDavid van Moolenbroek #include "tmux.h"
24eda6f593SDavid van Moolenbroek
25eda6f593SDavid van Moolenbroek int key_string_search_table(const char *);
26eda6f593SDavid van Moolenbroek int key_string_get_modifiers(const char **);
27eda6f593SDavid van Moolenbroek
28eda6f593SDavid van Moolenbroek const struct {
29eda6f593SDavid van Moolenbroek const char *string;
30eda6f593SDavid van Moolenbroek int key;
31eda6f593SDavid van Moolenbroek } key_string_table[] = {
32eda6f593SDavid van Moolenbroek /* Function keys. */
33eda6f593SDavid van Moolenbroek { "F1", KEYC_F1 },
34eda6f593SDavid van Moolenbroek { "F2", KEYC_F2 },
35eda6f593SDavid van Moolenbroek { "F3", KEYC_F3 },
36eda6f593SDavid van Moolenbroek { "F4", KEYC_F4 },
37eda6f593SDavid van Moolenbroek { "F5", KEYC_F5 },
38eda6f593SDavid van Moolenbroek { "F6", KEYC_F6 },
39eda6f593SDavid van Moolenbroek { "F7", KEYC_F7 },
40eda6f593SDavid van Moolenbroek { "F8", KEYC_F8 },
41eda6f593SDavid van Moolenbroek { "F9", KEYC_F9 },
42eda6f593SDavid van Moolenbroek { "F10", KEYC_F10 },
43eda6f593SDavid van Moolenbroek { "F11", KEYC_F11 },
44eda6f593SDavid van Moolenbroek { "F12", KEYC_F12 },
45eda6f593SDavid van Moolenbroek { "F13", KEYC_F13 },
46eda6f593SDavid van Moolenbroek { "F14", KEYC_F14 },
47eda6f593SDavid van Moolenbroek { "F15", KEYC_F15 },
48eda6f593SDavid van Moolenbroek { "F16", KEYC_F16 },
49eda6f593SDavid van Moolenbroek { "F17", KEYC_F17 },
50eda6f593SDavid van Moolenbroek { "F18", KEYC_F18 },
51eda6f593SDavid van Moolenbroek { "F19", KEYC_F19 },
52eda6f593SDavid van Moolenbroek { "F20", KEYC_F20 },
53eda6f593SDavid van Moolenbroek { "IC", KEYC_IC },
54eda6f593SDavid van Moolenbroek { "DC", KEYC_DC },
55eda6f593SDavid van Moolenbroek { "Home", KEYC_HOME },
56eda6f593SDavid van Moolenbroek { "End", KEYC_END },
57eda6f593SDavid van Moolenbroek { "NPage", KEYC_NPAGE },
58*0a6a1f1dSLionel Sambuc { "PageDown", KEYC_NPAGE },
59*0a6a1f1dSLionel Sambuc { "PgDn", KEYC_NPAGE },
60eda6f593SDavid van Moolenbroek { "PPage", KEYC_PPAGE },
61*0a6a1f1dSLionel Sambuc { "PageUp", KEYC_PPAGE },
62*0a6a1f1dSLionel Sambuc { "PgUp", KEYC_PPAGE },
63eda6f593SDavid van Moolenbroek { "Tab", '\011' },
64eda6f593SDavid van Moolenbroek { "BTab", KEYC_BTAB },
65eda6f593SDavid van Moolenbroek { "Space", ' ' },
66eda6f593SDavid van Moolenbroek { "BSpace", KEYC_BSPACE },
67eda6f593SDavid van Moolenbroek { "Enter", '\r' },
68eda6f593SDavid van Moolenbroek { "Escape", '\033' },
69eda6f593SDavid van Moolenbroek
70eda6f593SDavid van Moolenbroek /* Arrow keys. */
71eda6f593SDavid van Moolenbroek { "Up", KEYC_UP },
72eda6f593SDavid van Moolenbroek { "Down", KEYC_DOWN },
73eda6f593SDavid van Moolenbroek { "Left", KEYC_LEFT },
74eda6f593SDavid van Moolenbroek { "Right", KEYC_RIGHT },
75eda6f593SDavid van Moolenbroek
76eda6f593SDavid van Moolenbroek /* Numeric keypad. */
77eda6f593SDavid van Moolenbroek { "KP/", KEYC_KP_SLASH },
78eda6f593SDavid van Moolenbroek { "KP*", KEYC_KP_STAR },
79eda6f593SDavid van Moolenbroek { "KP-", KEYC_KP_MINUS },
80eda6f593SDavid van Moolenbroek { "KP7", KEYC_KP_SEVEN },
81eda6f593SDavid van Moolenbroek { "KP8", KEYC_KP_EIGHT },
82eda6f593SDavid van Moolenbroek { "KP9", KEYC_KP_NINE },
83eda6f593SDavid van Moolenbroek { "KP+", KEYC_KP_PLUS },
84eda6f593SDavid van Moolenbroek { "KP4", KEYC_KP_FOUR },
85eda6f593SDavid van Moolenbroek { "KP5", KEYC_KP_FIVE },
86eda6f593SDavid van Moolenbroek { "KP6", KEYC_KP_SIX },
87eda6f593SDavid van Moolenbroek { "KP1", KEYC_KP_ONE },
88eda6f593SDavid van Moolenbroek { "KP2", KEYC_KP_TWO },
89eda6f593SDavid van Moolenbroek { "KP3", KEYC_KP_THREE },
90eda6f593SDavid van Moolenbroek { "KPEnter", KEYC_KP_ENTER },
91eda6f593SDavid van Moolenbroek { "KP0", KEYC_KP_ZERO },
92eda6f593SDavid van Moolenbroek { "KP.", KEYC_KP_PERIOD },
93eda6f593SDavid van Moolenbroek };
94eda6f593SDavid van Moolenbroek
95eda6f593SDavid van Moolenbroek /* Find key string in table. */
96eda6f593SDavid van Moolenbroek int
key_string_search_table(const char * string)97eda6f593SDavid van Moolenbroek key_string_search_table(const char *string)
98eda6f593SDavid van Moolenbroek {
99eda6f593SDavid van Moolenbroek u_int i;
100eda6f593SDavid van Moolenbroek
101eda6f593SDavid van Moolenbroek for (i = 0; i < nitems(key_string_table); i++) {
102eda6f593SDavid van Moolenbroek if (strcasecmp(string, key_string_table[i].string) == 0)
103eda6f593SDavid van Moolenbroek return (key_string_table[i].key);
104eda6f593SDavid van Moolenbroek }
105eda6f593SDavid van Moolenbroek return (KEYC_NONE);
106eda6f593SDavid van Moolenbroek }
107eda6f593SDavid van Moolenbroek
108eda6f593SDavid van Moolenbroek /* Find modifiers. */
109eda6f593SDavid van Moolenbroek int
key_string_get_modifiers(const char ** string)110eda6f593SDavid van Moolenbroek key_string_get_modifiers(const char **string)
111eda6f593SDavid van Moolenbroek {
112eda6f593SDavid van Moolenbroek int modifiers;
113eda6f593SDavid van Moolenbroek
114eda6f593SDavid van Moolenbroek modifiers = 0;
115eda6f593SDavid van Moolenbroek while (((*string)[0] != '\0') && (*string)[1] == '-') {
116eda6f593SDavid van Moolenbroek switch ((*string)[0]) {
117eda6f593SDavid van Moolenbroek case 'C':
118eda6f593SDavid van Moolenbroek case 'c':
119eda6f593SDavid van Moolenbroek modifiers |= KEYC_CTRL;
120eda6f593SDavid van Moolenbroek break;
121eda6f593SDavid van Moolenbroek case 'M':
122eda6f593SDavid van Moolenbroek case 'm':
123eda6f593SDavid van Moolenbroek modifiers |= KEYC_ESCAPE;
124eda6f593SDavid van Moolenbroek break;
125eda6f593SDavid van Moolenbroek case 'S':
126eda6f593SDavid van Moolenbroek case 's':
127eda6f593SDavid van Moolenbroek modifiers |= KEYC_SHIFT;
128eda6f593SDavid van Moolenbroek break;
129eda6f593SDavid van Moolenbroek }
130eda6f593SDavid van Moolenbroek *string += 2;
131eda6f593SDavid van Moolenbroek }
132eda6f593SDavid van Moolenbroek return (modifiers);
133eda6f593SDavid van Moolenbroek }
134eda6f593SDavid van Moolenbroek
135eda6f593SDavid van Moolenbroek /* Lookup a string and convert to a key value. */
136eda6f593SDavid van Moolenbroek int
key_string_lookup_string(const char * string)137eda6f593SDavid van Moolenbroek key_string_lookup_string(const char *string)
138eda6f593SDavid van Moolenbroek {
139*0a6a1f1dSLionel Sambuc static const char *other = "!#()+,-.0123456789:;<=>?'\r\t";
140eda6f593SDavid van Moolenbroek int key, modifiers;
141*0a6a1f1dSLionel Sambuc u_short u;
142*0a6a1f1dSLionel Sambuc int size;
143*0a6a1f1dSLionel Sambuc
144*0a6a1f1dSLionel Sambuc /* Is this a hexadecimal value? */
145*0a6a1f1dSLionel Sambuc if (string[0] == '0' && string[1] == 'x') {
146*0a6a1f1dSLionel Sambuc if (sscanf(string + 2, "%hx%n", &u, &size) != 1 || size > 4)
147*0a6a1f1dSLionel Sambuc return (KEYC_NONE);
148*0a6a1f1dSLionel Sambuc return (u);
149*0a6a1f1dSLionel Sambuc }
150eda6f593SDavid van Moolenbroek
151eda6f593SDavid van Moolenbroek /* Check for modifiers. */
152eda6f593SDavid van Moolenbroek modifiers = 0;
153eda6f593SDavid van Moolenbroek if (string[0] == '^' && string[1] != '\0') {
154eda6f593SDavid van Moolenbroek modifiers |= KEYC_CTRL;
155eda6f593SDavid van Moolenbroek string++;
156eda6f593SDavid van Moolenbroek }
157eda6f593SDavid van Moolenbroek modifiers |= key_string_get_modifiers(&string);
158eda6f593SDavid van Moolenbroek if (string[0] == '\0')
159eda6f593SDavid van Moolenbroek return (KEYC_NONE);
160eda6f593SDavid van Moolenbroek
161eda6f593SDavid van Moolenbroek /* Is this a standard ASCII key? */
162eda6f593SDavid van Moolenbroek if (string[1] == '\0') {
163eda6f593SDavid van Moolenbroek key = (u_char) string[0];
164eda6f593SDavid van Moolenbroek if (key < 32 || key == 127 || key > 255)
165eda6f593SDavid van Moolenbroek return (KEYC_NONE);
166eda6f593SDavid van Moolenbroek } else {
167eda6f593SDavid van Moolenbroek /* Otherwise look the key up in the table. */
168eda6f593SDavid van Moolenbroek key = key_string_search_table(string);
169eda6f593SDavid van Moolenbroek if (key == KEYC_NONE)
170eda6f593SDavid van Moolenbroek return (KEYC_NONE);
171eda6f593SDavid van Moolenbroek }
172eda6f593SDavid van Moolenbroek
173eda6f593SDavid van Moolenbroek /* Convert the standard control keys. */
174*0a6a1f1dSLionel Sambuc if (key < KEYC_BASE && (modifiers & KEYC_CTRL) && !strchr(other, key)) {
175eda6f593SDavid van Moolenbroek if (key >= 97 && key <= 122)
176eda6f593SDavid van Moolenbroek key -= 96;
177eda6f593SDavid van Moolenbroek else if (key >= 64 && key <= 95)
178eda6f593SDavid van Moolenbroek key -= 64;
179eda6f593SDavid van Moolenbroek else if (key == 32)
180eda6f593SDavid van Moolenbroek key = 0;
181eda6f593SDavid van Moolenbroek else if (key == 63)
182eda6f593SDavid van Moolenbroek key = KEYC_BSPACE;
183eda6f593SDavid van Moolenbroek else
184eda6f593SDavid van Moolenbroek return (KEYC_NONE);
185eda6f593SDavid van Moolenbroek modifiers &= ~KEYC_CTRL;
186eda6f593SDavid van Moolenbroek }
187eda6f593SDavid van Moolenbroek
188eda6f593SDavid van Moolenbroek return (key | modifiers);
189eda6f593SDavid van Moolenbroek }
190eda6f593SDavid van Moolenbroek
191eda6f593SDavid van Moolenbroek /* Convert a key code into string format, with prefix if necessary. */
192eda6f593SDavid van Moolenbroek const char *
key_string_lookup_key(int key)193eda6f593SDavid van Moolenbroek key_string_lookup_key(int key)
194eda6f593SDavid van Moolenbroek {
195eda6f593SDavid van Moolenbroek static char out[24];
196eda6f593SDavid van Moolenbroek char tmp[8];
197eda6f593SDavid van Moolenbroek u_int i;
198eda6f593SDavid van Moolenbroek
199eda6f593SDavid van Moolenbroek *out = '\0';
200eda6f593SDavid van Moolenbroek
201*0a6a1f1dSLionel Sambuc /* Handle no key. */
202*0a6a1f1dSLionel Sambuc if (key == KEYC_NONE)
203*0a6a1f1dSLionel Sambuc return ("none");
204*0a6a1f1dSLionel Sambuc
205eda6f593SDavid van Moolenbroek /*
206eda6f593SDavid van Moolenbroek * Special case: display C-@ as C-Space. Could do this below in
207eda6f593SDavid van Moolenbroek * the (key >= 0 && key <= 32), but this way we let it be found
208eda6f593SDavid van Moolenbroek * in key_string_table, for the unlikely chance that we might
209eda6f593SDavid van Moolenbroek * change its name.
210eda6f593SDavid van Moolenbroek */
211eda6f593SDavid van Moolenbroek if ((key & KEYC_MASK_KEY) == 0)
212eda6f593SDavid van Moolenbroek key = ' ' | KEYC_CTRL | (key & KEYC_MASK_MOD);
213eda6f593SDavid van Moolenbroek
214eda6f593SDavid van Moolenbroek /* Fill in the modifiers. */
215eda6f593SDavid van Moolenbroek if (key & KEYC_CTRL)
216eda6f593SDavid van Moolenbroek strlcat(out, "C-", sizeof out);
217eda6f593SDavid van Moolenbroek if (key & KEYC_ESCAPE)
218eda6f593SDavid van Moolenbroek strlcat(out, "M-", sizeof out);
219eda6f593SDavid van Moolenbroek if (key & KEYC_SHIFT)
220eda6f593SDavid van Moolenbroek strlcat(out, "S-", sizeof out);
221eda6f593SDavid van Moolenbroek key &= KEYC_MASK_KEY;
222eda6f593SDavid van Moolenbroek
223eda6f593SDavid van Moolenbroek /* Try the key against the string table. */
224eda6f593SDavid van Moolenbroek for (i = 0; i < nitems(key_string_table); i++) {
225eda6f593SDavid van Moolenbroek if (key == key_string_table[i].key)
226eda6f593SDavid van Moolenbroek break;
227eda6f593SDavid van Moolenbroek }
228eda6f593SDavid van Moolenbroek if (i != nitems(key_string_table)) {
229eda6f593SDavid van Moolenbroek strlcat(out, key_string_table[i].string, sizeof out);
230eda6f593SDavid van Moolenbroek return (out);
231eda6f593SDavid van Moolenbroek }
232eda6f593SDavid van Moolenbroek
233eda6f593SDavid van Moolenbroek /* Invalid keys are errors. */
234eda6f593SDavid van Moolenbroek if (key == 127 || key > 255)
235eda6f593SDavid van Moolenbroek return (NULL);
236eda6f593SDavid van Moolenbroek
237eda6f593SDavid van Moolenbroek /* Check for standard or control key. */
238eda6f593SDavid van Moolenbroek if (key >= 0 && key <= 32) {
239eda6f593SDavid van Moolenbroek if (key == 0 || key > 26)
240eda6f593SDavid van Moolenbroek xsnprintf(tmp, sizeof tmp, "C-%c", 64 + key);
241eda6f593SDavid van Moolenbroek else
242eda6f593SDavid van Moolenbroek xsnprintf(tmp, sizeof tmp, "C-%c", 96 + key);
243eda6f593SDavid van Moolenbroek } else if (key >= 32 && key <= 126) {
244eda6f593SDavid van Moolenbroek tmp[0] = key;
245eda6f593SDavid van Moolenbroek tmp[1] = '\0';
246eda6f593SDavid van Moolenbroek } else if (key >= 128)
247eda6f593SDavid van Moolenbroek xsnprintf(tmp, sizeof tmp, "\\%o", key);
248eda6f593SDavid van Moolenbroek
249eda6f593SDavid van Moolenbroek strlcat(out, tmp, sizeof out);
250eda6f593SDavid van Moolenbroek return (out);
251eda6f593SDavid van Moolenbroek }
252