Annotation of src/usr.bin/tmux/key-string.c, Revision 1.28
1.28 ! nicm 1: /* $OpenBSD: key-string.c,v 1.27 2015/10/26 22:03:04 nicm Exp $ */
1.1 nicm 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:
1.28 ! nicm 25: key_code key_string_search_table(const char *);
! 26: 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),
96: KEYC_MOUSE_STRING(WHEELUP, WheelUp),
97: KEYC_MOUSE_STRING(WHEELDOWN, WheelDown),
1.1 nicm 98: };
99:
1.10 nicm 100: /* Find key string in table. */
1.28 ! nicm 101: key_code
1.1 nicm 102: key_string_search_table(const char *string)
103: {
104: u_int i;
105:
106: for (i = 0; i < nitems(key_string_table); i++) {
107: if (strcasecmp(string, key_string_table[i].string) == 0)
108: return (key_string_table[i].key);
109: }
110: return (KEYC_NONE);
111: }
112:
1.14 nicm 113: /* Find modifiers. */
1.28 ! nicm 114: key_code
1.14 nicm 115: key_string_get_modifiers(const char **string)
116: {
1.28 ! nicm 117: key_code modifiers;
1.14 nicm 118:
119: modifiers = 0;
120: while (((*string)[0] != '\0') && (*string)[1] == '-') {
121: switch ((*string)[0]) {
122: case 'C':
123: case 'c':
124: modifiers |= KEYC_CTRL;
125: break;
126: case 'M':
127: case 'm':
128: modifiers |= KEYC_ESCAPE;
129: break;
130: case 'S':
131: case 's':
132: modifiers |= KEYC_SHIFT;
133: break;
134: }
135: *string += 2;
136: }
137: return (modifiers);
138: }
139:
140: /* Lookup a string and convert to a key value. */
1.28 ! nicm 141: key_code
1.1 nicm 142: key_string_lookup_string(const char *string)
143: {
1.24 nicm 144: static const char *other = "!#()+,-.0123456789:;<=>?'\r\t";
1.28 ! nicm 145: key_code key;
1.24 nicm 146: u_short u;
147: int size;
1.28 ! nicm 148: key_code modifiers;
! 149: struct utf8_data utf8data;
! 150: u_int i;
1.23 nicm 151:
152: /* Is this a hexadecimal value? */
153: if (string[0] == '0' && string[1] == 'x') {
154: if (sscanf(string + 2, "%hx%n", &u, &size) != 1 || size > 4)
155: return (KEYC_NONE);
156: return (u);
157: }
1.1 nicm 158:
1.14 nicm 159: /* Check for modifiers. */
160: modifiers = 0;
161: if (string[0] == '^' && string[1] != '\0') {
162: modifiers |= KEYC_CTRL;
163: string++;
164: }
165: modifiers |= key_string_get_modifiers(&string);
1.1 nicm 166: if (string[0] == '\0')
167: return (KEYC_NONE);
168:
1.14 nicm 169: /* Is this a standard ASCII key? */
1.28 ! nicm 170: if (string[1] == '\0' && (u_char)string[0] <= 127) {
! 171: key = (u_char)string[0];
! 172: if (key < 32 || key == 127)
1.1 nicm 173: return (KEYC_NONE);
1.17 nicm 174: } else {
1.28 ! nicm 175: /* Try as a UTF-8 key. */
! 176: if (utf8_open(&utf8data, (u_char)*string)) {
! 177: if (strlen(string) != utf8data.size)
! 178: return (KEYC_NONE);
! 179: for (i = 1; i < utf8data.size; i++)
! 180: utf8_append(&utf8data, (u_char)string[i]);
! 181: key = utf8_combine(&utf8data);
! 182: return (key | modifiers);
! 183: }
! 184:
1.17 nicm 185: /* Otherwise look the key up in the table. */
186: key = key_string_search_table(string);
187: if (key == KEYC_NONE)
188: return (KEYC_NONE);
189: }
1.12 nicm 190:
1.17 nicm 191: /* Convert the standard control keys. */
1.24 nicm 192: if (key < KEYC_BASE && (modifiers & KEYC_CTRL) && !strchr(other, key)) {
1.17 nicm 193: if (key >= 97 && key <= 122)
194: key -= 96;
195: else if (key >= 64 && key <= 95)
196: key -= 64;
197: else if (key == 32)
198: key = 0;
199: else if (key == 63)
200: key = KEYC_BSPACE;
201: else
202: return (KEYC_NONE);
203: modifiers &= ~KEYC_CTRL;
1.13 nicm 204: }
205:
1.14 nicm 206: return (key | modifiers);
1.1 nicm 207: }
208:
1.10 nicm 209: /* Convert a key code into string format, with prefix if necessary. */
1.1 nicm 210: const char *
1.28 ! nicm 211: key_string_lookup_key(key_code key)
1.1 nicm 212: {
1.28 ! nicm 213: static char out[24];
! 214: char tmp[8];
! 215: u_int i;
! 216: struct utf8_data utf8data;
1.14 nicm 217:
218: *out = '\0';
1.22 nicm 219:
220: /* Handle no key. */
221: if (key == KEYC_NONE)
1.26 nicm 222: return ("<NONE>");
223: if (key == KEYC_MOUSE)
224: return ("<MOUSE>");
1.14 nicm 225:
1.18 nicm 226: /*
227: * Special case: display C-@ as C-Space. Could do this below in
228: * the (key >= 0 && key <= 32), but this way we let it be found
229: * in key_string_table, for the unlikely chance that we might
230: * change its name.
231: */
232: if ((key & KEYC_MASK_KEY) == 0)
233: key = ' ' | KEYC_CTRL | (key & KEYC_MASK_MOD);
234:
1.14 nicm 235: /* Fill in the modifiers. */
236: if (key & KEYC_CTRL)
237: strlcat(out, "C-", sizeof out);
238: if (key & KEYC_ESCAPE)
239: strlcat(out, "M-", sizeof out);
240: if (key & KEYC_SHIFT)
241: strlcat(out, "S-", sizeof out);
1.18 nicm 242: key &= KEYC_MASK_KEY;
1.1 nicm 243:
1.14 nicm 244: /* Try the key against the string table. */
1.6 nicm 245: for (i = 0; i < nitems(key_string_table); i++) {
246: if (key == key_string_table[i].key)
1.14 nicm 247: break;
248: }
249: if (i != nitems(key_string_table)) {
250: strlcat(out, key_string_table[i].string, sizeof out);
251: return (out);
1.6 nicm 252: }
253:
1.28 ! nicm 254: /* Is this a UTF-8 key? */
! 255: if (key > 127 && key < KEYC_BASE) {
! 256: if (utf8_split(key, &utf8data) == 0) {
! 257: memcpy(out, utf8data.data, utf8data.size);
! 258: out[utf8data.size] = '\0';
! 259: return (out);
! 260: }
! 261: }
! 262:
1.14 nicm 263: /* Invalid keys are errors. */
1.27 nicm 264: if (key == 127 || key > 255) {
1.28 ! nicm 265: snprintf(out, sizeof out, "<INVALID#%llx>", key);
1.27 nicm 266: return (out);
267: }
1.1 nicm 268:
1.14 nicm 269: /* Check for standard or control key. */
1.28 ! nicm 270: if (key <= 32) {
1.1 nicm 271: if (key == 0 || key > 26)
1.28 ! nicm 272: xsnprintf(tmp, sizeof tmp, "C-%c", (int)(64 + key));
1.1 nicm 273: else
1.28 ! nicm 274: xsnprintf(tmp, sizeof tmp, "C-%c", (int)(96 + key));
1.14 nicm 275: } else if (key >= 32 && key <= 126) {
276: tmp[0] = key;
277: tmp[1] = '\0';
1.20 nicm 278: } else if (key >= 128)
1.28 ! nicm 279: xsnprintf(tmp, sizeof tmp, "\\%llo", key);
1.20 nicm 280:
1.14 nicm 281: strlcat(out, tmp, sizeof out);
282: return (out);
1.1 nicm 283: }
![[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