Annotation of src/usr.bin/tmux/key-string.c, Revision 1.37
1.37 ! nicm 1: /* $OpenBSD: key-string.c,v 1.36 2016/03/18 07:28:27 nicm Exp $ */
1.1 nicm 2:
3: /*
1.34 nicm 4: * Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com>
1.1 nicm 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:
1.33 nicm 25: static key_code key_string_search_table(const char *);
26: static key_code key_string_get_modifiers(const char **);
1.1 nicm 27:
1.19 nicm 28: const struct {
1.14 nicm 29: const char *string;
1.28 nicm 30: key_code key;
1.1 nicm 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 },
1.21 nicm 50: { "PageDown", KEYC_NPAGE },
51: { "PgDn", KEYC_NPAGE },
1.1 nicm 52: { "PPage", KEYC_PPAGE },
1.21 nicm 53: { "PageUp", KEYC_PPAGE },
54: { "PgUp", KEYC_PPAGE },
1.1 nicm 55: { "Tab", '\011' },
56: { "BTab", KEYC_BTAB },
1.7 nicm 57: { "Space", ' ' },
1.5 nicm 58: { "BSpace", KEYC_BSPACE },
1.6 nicm 59: { "Enter", '\r' },
60: { "Escape", '\033' },
1.1 nicm 61:
62: /* Arrow keys. */
63: { "Up", KEYC_UP },
64: { "Down", KEYC_DOWN },
65: { "Left", KEYC_LEFT },
66: { "Right", KEYC_RIGHT },
67:
68: /* Numeric keypad. */
1.9 nicm 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 },
1.26 nicm 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),
1.36 nicm 96: KEYC_MOUSE_STRING(MOUSEDRAGEND1, MouseDragEnd1),
97: KEYC_MOUSE_STRING(MOUSEDRAGEND2, MouseDragEnd2),
98: KEYC_MOUSE_STRING(MOUSEDRAGEND3, MouseDragEnd3),
1.26 nicm 99: KEYC_MOUSE_STRING(WHEELUP, WheelUp),
100: KEYC_MOUSE_STRING(WHEELDOWN, WheelDown),
1.1 nicm 101: };
102:
1.10 nicm 103: /* Find key string in table. */
1.33 nicm 104: static key_code
1.1 nicm 105: key_string_search_table(const char *string)
106: {
107: u_int i;
108:
109: for (i = 0; i < nitems(key_string_table); i++) {
110: if (strcasecmp(string, key_string_table[i].string) == 0)
111: return (key_string_table[i].key);
112: }
1.33 nicm 113: return (KEYC_UNKNOWN);
1.1 nicm 114: }
115:
1.14 nicm 116: /* Find modifiers. */
1.33 nicm 117: static key_code
1.14 nicm 118: key_string_get_modifiers(const char **string)
119: {
1.28 nicm 120: key_code modifiers;
1.14 nicm 121:
122: modifiers = 0;
123: while (((*string)[0] != '\0') && (*string)[1] == '-') {
124: switch ((*string)[0]) {
125: case 'C':
126: case 'c':
127: modifiers |= KEYC_CTRL;
128: break;
129: case 'M':
130: case 'm':
131: modifiers |= KEYC_ESCAPE;
132: break;
133: case 'S':
134: case 's':
135: modifiers |= KEYC_SHIFT;
136: break;
137: }
138: *string += 2;
139: }
140: return (modifiers);
141: }
142:
143: /* Lookup a string and convert to a key value. */
1.28 nicm 144: key_code
1.1 nicm 145: key_string_lookup_string(const char *string)
146: {
1.24 nicm 147: static const char *other = "!#()+,-.0123456789:;<=>?'\r\t";
1.28 nicm 148: key_code key;
1.24 nicm 149: u_short u;
1.32 nicm 150: int size;
1.28 nicm 151: key_code modifiers;
1.29 nicm 152: struct utf8_data ud;
1.28 nicm 153: u_int i;
1.32 nicm 154: enum utf8_state more;
1.35 nicm 155: wchar_t wc;
1.23 nicm 156:
1.33 nicm 157: /* Is this no key? */
158: if (strcasecmp(string, "None") == 0)
159: return (KEYC_NONE);
160:
1.23 nicm 161: /* Is this a hexadecimal value? */
162: if (string[0] == '0' && string[1] == 'x') {
163: if (sscanf(string + 2, "%hx%n", &u, &size) != 1 || size > 4)
1.33 nicm 164: return (KEYC_UNKNOWN);
1.23 nicm 165: return (u);
166: }
1.1 nicm 167:
1.14 nicm 168: /* Check for modifiers. */
169: modifiers = 0;
170: if (string[0] == '^' && string[1] != '\0') {
171: modifiers |= KEYC_CTRL;
172: string++;
173: }
174: modifiers |= key_string_get_modifiers(&string);
1.1 nicm 175: if (string[0] == '\0')
1.33 nicm 176: return (KEYC_UNKNOWN);
1.1 nicm 177:
1.14 nicm 178: /* Is this a standard ASCII key? */
1.28 nicm 179: if (string[1] == '\0' && (u_char)string[0] <= 127) {
180: key = (u_char)string[0];
181: if (key < 32 || key == 127)
1.33 nicm 182: return (KEYC_UNKNOWN);
1.17 nicm 183: } else {
1.28 nicm 184: /* Try as a UTF-8 key. */
1.32 nicm 185: if ((more = utf8_open(&ud, (u_char)*string)) == UTF8_MORE) {
1.29 nicm 186: if (strlen(string) != ud.size)
1.33 nicm 187: return (KEYC_UNKNOWN);
1.29 nicm 188: for (i = 1; i < ud.size; i++)
1.30 nicm 189: more = utf8_append(&ud, (u_char)string[i]);
1.32 nicm 190: if (more != UTF8_DONE)
1.33 nicm 191: return (KEYC_UNKNOWN);
1.35 nicm 192: if (utf8_combine(&ud, &wc) != UTF8_DONE)
193: return (KEYC_UNKNOWN);
194: return (wc | modifiers);
1.28 nicm 195: }
196:
1.17 nicm 197: /* Otherwise look the key up in the table. */
198: key = key_string_search_table(string);
1.33 nicm 199: if (key == KEYC_UNKNOWN)
200: return (KEYC_UNKNOWN);
1.17 nicm 201: }
1.12 nicm 202:
1.17 nicm 203: /* Convert the standard control keys. */
1.24 nicm 204: if (key < KEYC_BASE && (modifiers & KEYC_CTRL) && !strchr(other, key)) {
1.17 nicm 205: if (key >= 97 && key <= 122)
206: key -= 96;
207: else if (key >= 64 && key <= 95)
208: key -= 64;
209: else if (key == 32)
210: key = 0;
211: else if (key == 63)
212: key = KEYC_BSPACE;
213: else
1.33 nicm 214: return (KEYC_UNKNOWN);
1.17 nicm 215: modifiers &= ~KEYC_CTRL;
1.13 nicm 216: }
217:
1.14 nicm 218: return (key | modifiers);
1.1 nicm 219: }
220:
1.10 nicm 221: /* Convert a key code into string format, with prefix if necessary. */
1.1 nicm 222: const char *
1.28 nicm 223: key_string_lookup_key(key_code key)
1.1 nicm 224: {
1.28 nicm 225: static char out[24];
226: char tmp[8];
227: u_int i;
1.29 nicm 228: struct utf8_data ud;
1.37 ! nicm 229: size_t off;
1.14 nicm 230:
231: *out = '\0';
1.22 nicm 232:
233: /* Handle no key. */
234: if (key == KEYC_NONE)
1.33 nicm 235: return ("None");
236:
237: /* Handle special keys. */
238: if (key == KEYC_UNKNOWN)
239: return ("Unknown");
1.26 nicm 240: if (key == KEYC_MOUSE)
1.33 nicm 241: return ("Mouse");
1.14 nicm 242:
1.18 nicm 243: /*
244: * Special case: display C-@ as C-Space. Could do this below in
245: * the (key >= 0 && key <= 32), but this way we let it be found
246: * in key_string_table, for the unlikely chance that we might
247: * change its name.
248: */
249: if ((key & KEYC_MASK_KEY) == 0)
250: key = ' ' | KEYC_CTRL | (key & KEYC_MASK_MOD);
251:
1.14 nicm 252: /* Fill in the modifiers. */
253: if (key & KEYC_CTRL)
254: strlcat(out, "C-", sizeof out);
255: if (key & KEYC_ESCAPE)
256: strlcat(out, "M-", sizeof out);
257: if (key & KEYC_SHIFT)
258: strlcat(out, "S-", sizeof out);
1.18 nicm 259: key &= KEYC_MASK_KEY;
1.1 nicm 260:
1.14 nicm 261: /* Try the key against the string table. */
1.6 nicm 262: for (i = 0; i < nitems(key_string_table); i++) {
263: if (key == key_string_table[i].key)
1.14 nicm 264: break;
265: }
266: if (i != nitems(key_string_table)) {
267: strlcat(out, key_string_table[i].string, sizeof out);
268: return (out);
1.6 nicm 269: }
270:
1.28 nicm 271: /* Is this a UTF-8 key? */
272: if (key > 127 && key < KEYC_BASE) {
1.32 nicm 273: if (utf8_split(key, &ud) == UTF8_DONE) {
1.37 ! nicm 274: off = strlen(out);
! 275: memcpy(out + off, ud.data, ud.size);
! 276: out[off + ud.size] = '\0';
1.28 nicm 277: return (out);
278: }
279: }
280:
1.14 nicm 281: /* Invalid keys are errors. */
1.27 nicm 282: if (key == 127 || key > 255) {
1.33 nicm 283: snprintf(out, sizeof out, "Invalid#%llx", key);
1.27 nicm 284: return (out);
285: }
1.1 nicm 286:
1.14 nicm 287: /* Check for standard or control key. */
1.28 nicm 288: if (key <= 32) {
1.1 nicm 289: if (key == 0 || key > 26)
1.28 nicm 290: xsnprintf(tmp, sizeof tmp, "C-%c", (int)(64 + key));
1.1 nicm 291: else
1.28 nicm 292: xsnprintf(tmp, sizeof tmp, "C-%c", (int)(96 + key));
1.14 nicm 293: } else if (key >= 32 && key <= 126) {
294: tmp[0] = key;
295: tmp[1] = '\0';
1.20 nicm 296: } else if (key >= 128)
1.28 nicm 297: xsnprintf(tmp, sizeof tmp, "\\%llo", key);
1.20 nicm 298:
1.14 nicm 299: strlcat(out, tmp, sizeof out);
300: return (out);
1.1 nicm 301: }
![[BACK]](/icons/back.gif){kind=icon}
Return to key-string.c CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / tmux