Annotation of src/usr.bin/tmux/key-string.c, Revision 1.66
1.66 ! nicm 1: /* $OpenBSD: key-string.c,v 1.65 2021/04/07 15:46:12 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:
1.62 nicm 21: #include <stdlib.h>
1.1 nicm 22: #include <string.h>
1.62 nicm 23: #include <wchar.h>
1.1 nicm 24:
25: #include "tmux.h"
26:
1.33 nicm 27: static key_code key_string_search_table(const char *);
28: static key_code key_string_get_modifiers(const char **);
1.1 nicm 29:
1.39 nicm 30: static const struct {
1.14 nicm 31: const char *string;
1.28 nicm 32: key_code key;
1.1 nicm 33: } key_string_table[] = {
34: /* Function keys. */
1.63 nicm 35: { "F1", KEYC_F1|KEYC_IMPLIED_META },
36: { "F2", KEYC_F2|KEYC_IMPLIED_META },
37: { "F3", KEYC_F3|KEYC_IMPLIED_META },
38: { "F4", KEYC_F4|KEYC_IMPLIED_META },
39: { "F5", KEYC_F5|KEYC_IMPLIED_META },
40: { "F6", KEYC_F6|KEYC_IMPLIED_META },
41: { "F7", KEYC_F7|KEYC_IMPLIED_META },
42: { "F8", KEYC_F8|KEYC_IMPLIED_META },
43: { "F9", KEYC_F9|KEYC_IMPLIED_META },
44: { "F10", KEYC_F10|KEYC_IMPLIED_META },
45: { "F11", KEYC_F11|KEYC_IMPLIED_META },
46: { "F12", KEYC_F12|KEYC_IMPLIED_META },
47: { "IC", KEYC_IC|KEYC_IMPLIED_META },
1.64 nicm 48: { "Insert", KEYC_IC|KEYC_IMPLIED_META },
1.63 nicm 49: { "DC", KEYC_DC|KEYC_IMPLIED_META },
1.64 nicm 50: { "Delete", KEYC_DC|KEYC_IMPLIED_META },
1.63 nicm 51: { "Home", KEYC_HOME|KEYC_IMPLIED_META },
52: { "End", KEYC_END|KEYC_IMPLIED_META },
53: { "NPage", KEYC_NPAGE|KEYC_IMPLIED_META },
54: { "PageDown", KEYC_NPAGE|KEYC_IMPLIED_META },
55: { "PgDn", KEYC_NPAGE|KEYC_IMPLIED_META },
56: { "PPage", KEYC_PPAGE|KEYC_IMPLIED_META },
57: { "PageUp", KEYC_PPAGE|KEYC_IMPLIED_META },
58: { "PgUp", KEYC_PPAGE|KEYC_IMPLIED_META },
1.1 nicm 59: { "Tab", '\011' },
60: { "BTab", KEYC_BTAB },
1.7 nicm 61: { "Space", ' ' },
1.5 nicm 62: { "BSpace", KEYC_BSPACE },
1.6 nicm 63: { "Enter", '\r' },
64: { "Escape", '\033' },
1.1 nicm 65:
66: /* Arrow keys. */
1.63 nicm 67: { "Up", KEYC_UP|KEYC_CURSOR|KEYC_IMPLIED_META },
68: { "Down", KEYC_DOWN|KEYC_CURSOR|KEYC_IMPLIED_META },
69: { "Left", KEYC_LEFT|KEYC_CURSOR|KEYC_IMPLIED_META },
70: { "Right", KEYC_RIGHT|KEYC_CURSOR|KEYC_IMPLIED_META },
1.1 nicm 71:
72: /* Numeric keypad. */
1.64 nicm 73: { "KP/", KEYC_KP_SLASH|KEYC_KEYPAD },
1.59 nicm 74: { "KP*", KEYC_KP_STAR|KEYC_KEYPAD },
75: { "KP-", KEYC_KP_MINUS|KEYC_KEYPAD },
76: { "KP7", KEYC_KP_SEVEN|KEYC_KEYPAD },
77: { "KP8", KEYC_KP_EIGHT|KEYC_KEYPAD },
78: { "KP9", KEYC_KP_NINE|KEYC_KEYPAD },
79: { "KP+", KEYC_KP_PLUS|KEYC_KEYPAD },
80: { "KP4", KEYC_KP_FOUR|KEYC_KEYPAD },
81: { "KP5", KEYC_KP_FIVE|KEYC_KEYPAD },
82: { "KP6", KEYC_KP_SIX|KEYC_KEYPAD },
83: { "KP1", KEYC_KP_ONE|KEYC_KEYPAD },
84: { "KP2", KEYC_KP_TWO|KEYC_KEYPAD },
85: { "KP3", KEYC_KP_THREE|KEYC_KEYPAD },
86: { "KPEnter", KEYC_KP_ENTER|KEYC_KEYPAD },
87: { "KP0", KEYC_KP_ZERO|KEYC_KEYPAD },
88: { "KP.", KEYC_KP_PERIOD|KEYC_KEYPAD },
1.26 nicm 89:
90: /* Mouse keys. */
91: KEYC_MOUSE_STRING(MOUSEDOWN1, MouseDown1),
92: KEYC_MOUSE_STRING(MOUSEDOWN2, MouseDown2),
93: KEYC_MOUSE_STRING(MOUSEDOWN3, MouseDown3),
94: KEYC_MOUSE_STRING(MOUSEUP1, MouseUp1),
95: KEYC_MOUSE_STRING(MOUSEUP2, MouseUp2),
96: KEYC_MOUSE_STRING(MOUSEUP3, MouseUp3),
97: KEYC_MOUSE_STRING(MOUSEDRAG1, MouseDrag1),
98: KEYC_MOUSE_STRING(MOUSEDRAG2, MouseDrag2),
99: KEYC_MOUSE_STRING(MOUSEDRAG3, MouseDrag3),
1.36 nicm 100: KEYC_MOUSE_STRING(MOUSEDRAGEND1, MouseDragEnd1),
101: KEYC_MOUSE_STRING(MOUSEDRAGEND2, MouseDragEnd2),
102: KEYC_MOUSE_STRING(MOUSEDRAGEND3, MouseDragEnd3),
1.26 nicm 103: KEYC_MOUSE_STRING(WHEELUP, WheelUp),
104: KEYC_MOUSE_STRING(WHEELDOWN, WheelDown),
1.55 nicm 105: KEYC_MOUSE_STRING(SECONDCLICK1, SecondClick1),
106: KEYC_MOUSE_STRING(SECONDCLICK2, SecondClick2),
107: KEYC_MOUSE_STRING(SECONDCLICK3, SecondClick3),
1.40 nicm 108: KEYC_MOUSE_STRING(DOUBLECLICK1, DoubleClick1),
109: KEYC_MOUSE_STRING(DOUBLECLICK2, DoubleClick2),
110: KEYC_MOUSE_STRING(DOUBLECLICK3, DoubleClick3),
111: KEYC_MOUSE_STRING(TRIPLECLICK1, TripleClick1),
112: KEYC_MOUSE_STRING(TRIPLECLICK2, TripleClick2),
113: KEYC_MOUSE_STRING(TRIPLECLICK3, TripleClick3),
1.1 nicm 114: };
115:
1.10 nicm 116: /* Find key string in table. */
1.33 nicm 117: static key_code
1.1 nicm 118: key_string_search_table(const char *string)
119: {
1.47 nicm 120: u_int i, user;
1.1 nicm 121:
122: for (i = 0; i < nitems(key_string_table); i++) {
123: if (strcasecmp(string, key_string_table[i].string) == 0)
124: return (key_string_table[i].key);
125: }
1.47 nicm 126:
127: if (sscanf(string, "User%u", &user) == 1 && user < KEYC_NUSER)
128: return (KEYC_USER + user);
129:
1.33 nicm 130: return (KEYC_UNKNOWN);
1.1 nicm 131: }
132:
1.14 nicm 133: /* Find modifiers. */
1.33 nicm 134: static key_code
1.14 nicm 135: key_string_get_modifiers(const char **string)
136: {
1.28 nicm 137: key_code modifiers;
1.14 nicm 138:
139: modifiers = 0;
140: while (((*string)[0] != '\0') && (*string)[1] == '-') {
141: switch ((*string)[0]) {
142: case 'C':
143: case 'c':
144: modifiers |= KEYC_CTRL;
145: break;
146: case 'M':
147: case 'm':
1.57 nicm 148: modifiers |= KEYC_META;
1.14 nicm 149: break;
150: case 'S':
151: case 's':
152: modifiers |= KEYC_SHIFT;
153: break;
1.41 nicm 154: default:
155: *string = NULL;
1.42 nicm 156: return (0);
1.14 nicm 157: }
158: *string += 2;
159: }
160: return (modifiers);
161: }
162:
163: /* Lookup a string and convert to a key value. */
1.28 nicm 164: key_code
1.1 nicm 165: key_string_lookup_string(const char *string)
166: {
1.66 ! nicm 167: static const char *other = "!#()+,-.0123456789:;<=>'\r\t\177`/";
1.62 nicm 168: key_code key, modifiers;
169: u_int u, i;
170: struct utf8_data ud, *udp;
1.32 nicm 171: enum utf8_state more;
1.61 nicm 172: utf8_char uc;
1.62 nicm 173: char m[MB_LEN_MAX + 1];
174: int mlen;
1.23 nicm 175:
1.48 nicm 176: /* Is this no key or any key? */
1.33 nicm 177: if (strcasecmp(string, "None") == 0)
178: return (KEYC_NONE);
1.48 nicm 179: if (strcasecmp(string, "Any") == 0)
180: return (KEYC_ANY);
1.33 nicm 181:
1.23 nicm 182: /* Is this a hexadecimal value? */
183: if (string[0] == '0' && string[1] == 'x') {
1.64 nicm 184: if (sscanf(string + 2, "%x", &u) != 1)
185: return (KEYC_UNKNOWN);
1.62 nicm 186: mlen = wctomb(m, u);
187: if (mlen <= 0 || mlen > MB_LEN_MAX)
188: return (KEYC_UNKNOWN);
189: m[mlen] = '\0';
190:
191: udp = utf8_fromcstr(m);
192: if (udp == NULL ||
193: udp[0].size == 0 ||
194: udp[1].size != 0 ||
195: utf8_from_data(&udp[0], &uc) != UTF8_DONE) {
196: free(udp);
197: return (KEYC_UNKNOWN);
198: }
199: free(udp);
200: return (uc);
1.23 nicm 201: }
1.1 nicm 202:
1.14 nicm 203: /* Check for modifiers. */
204: modifiers = 0;
205: if (string[0] == '^' && string[1] != '\0') {
206: modifiers |= KEYC_CTRL;
207: string++;
208: }
209: modifiers |= key_string_get_modifiers(&string);
1.41 nicm 210: if (string == NULL || string[0] == '\0')
1.33 nicm 211: return (KEYC_UNKNOWN);
1.1 nicm 212:
1.14 nicm 213: /* Is this a standard ASCII key? */
1.28 nicm 214: if (string[1] == '\0' && (u_char)string[0] <= 127) {
215: key = (u_char)string[0];
1.52 nicm 216: if (key < 32)
1.33 nicm 217: return (KEYC_UNKNOWN);
1.17 nicm 218: } else {
1.28 nicm 219: /* Try as a UTF-8 key. */
1.32 nicm 220: if ((more = utf8_open(&ud, (u_char)*string)) == UTF8_MORE) {
1.29 nicm 221: if (strlen(string) != ud.size)
1.33 nicm 222: return (KEYC_UNKNOWN);
1.29 nicm 223: for (i = 1; i < ud.size; i++)
1.30 nicm 224: more = utf8_append(&ud, (u_char)string[i]);
1.32 nicm 225: if (more != UTF8_DONE)
1.33 nicm 226: return (KEYC_UNKNOWN);
1.61 nicm 227: if (utf8_from_data(&ud, &uc) != UTF8_DONE)
1.35 nicm 228: return (KEYC_UNKNOWN);
1.61 nicm 229: return (uc|modifiers);
1.28 nicm 230: }
231:
1.17 nicm 232: /* Otherwise look the key up in the table. */
233: key = key_string_search_table(string);
1.33 nicm 234: if (key == KEYC_UNKNOWN)
235: return (KEYC_UNKNOWN);
1.63 nicm 236: if (~modifiers & KEYC_META)
237: key &= ~KEYC_IMPLIED_META;
1.17 nicm 238: }
1.12 nicm 239:
1.17 nicm 240: /* Convert the standard control keys. */
1.66 ! nicm 241: if (key < KEYC_BASE &&
! 242: (modifiers & KEYC_CTRL) &&
! 243: strchr(other, key) == NULL &&
! 244: key != 9 &&
! 245: key != 13 &&
! 246: key != 27) {
1.17 nicm 247: if (key >= 97 && key <= 122)
248: key -= 96;
1.65 nicm 249: else if (key >= 64 && key <= 95)
250: key -= 64;
1.17 nicm 251: else if (key == 32)
252: key = 0;
1.56 nicm 253: else if (key == 63)
1.52 nicm 254: key = 127;
1.17 nicm 255: else
1.33 nicm 256: return (KEYC_UNKNOWN);
1.17 nicm 257: modifiers &= ~KEYC_CTRL;
1.13 nicm 258: }
259:
1.58 nicm 260: return (key|modifiers);
1.1 nicm 261: }
262:
1.10 nicm 263: /* Convert a key code into string format, with prefix if necessary. */
1.1 nicm 264: const char *
1.58 nicm 265: key_string_lookup_key(key_code key, int with_flags)
1.1 nicm 266: {
1.58 nicm 267: key_code saved = key;
268: static char out[64];
1.53 nicm 269: char tmp[8];
270: const char *s;
271: u_int i;
272: struct utf8_data ud;
273: size_t off;
1.14 nicm 274:
275: *out = '\0';
1.22 nicm 276:
1.53 nicm 277: /* Literal keys are themselves. */
278: if (key & KEYC_LITERAL) {
279: snprintf(out, sizeof out, "%c", (int)(key & 0xff));
1.58 nicm 280: goto out;
1.53 nicm 281: }
282:
1.54 nicm 283: /* Display C-@ as C-Space. */
1.58 nicm 284: if ((key & (KEYC_MASK_KEY|KEYC_MASK_MODIFIERS)) == 0)
285: key = ' '|KEYC_CTRL;
1.54 nicm 286:
1.53 nicm 287: /* Fill in the modifiers. */
288: if (key & KEYC_CTRL)
289: strlcat(out, "C-", sizeof out);
1.57 nicm 290: if (key & KEYC_META)
1.53 nicm 291: strlcat(out, "M-", sizeof out);
292: if (key & KEYC_SHIFT)
293: strlcat(out, "S-", sizeof out);
294: key &= KEYC_MASK_KEY;
295:
1.22 nicm 296: /* Handle no key. */
1.58 nicm 297: if (key == KEYC_NONE) {
298: s = "None";
299: goto append;
300: }
1.33 nicm 301:
302: /* Handle special keys. */
1.53 nicm 303: if (key == KEYC_UNKNOWN) {
304: s = "Unknown";
305: goto append;
306: }
307: if (key == KEYC_ANY) {
308: s = "Any";
309: goto append;
310: }
311: if (key == KEYC_FOCUS_IN) {
312: s = "FocusIn";
313: goto append;
314: }
315: if (key == KEYC_FOCUS_OUT) {
316: s = "FocusOut";
317: goto append;
318: }
319: if (key == KEYC_PASTE_START) {
320: s = "PasteStart";
321: goto append;
322: }
323: if (key == KEYC_PASTE_END) {
324: s = "PasteEnd";
325: goto append;
326: }
327: if (key == KEYC_MOUSE) {
328: s = "Mouse";
329: goto append;
330: }
331: if (key == KEYC_DRAGGING) {
332: s = "Dragging";
333: goto append;
334: }
335: if (key == KEYC_MOUSEMOVE_PANE) {
336: s = "MouseMovePane";
337: goto append;
338: }
339: if (key == KEYC_MOUSEMOVE_STATUS) {
340: s = "MouseMoveStatus";
341: goto append;
342: }
343: if (key == KEYC_MOUSEMOVE_STATUS_LEFT) {
344: s = "MouseMoveStatusLeft";
345: goto append;
346: }
347: if (key == KEYC_MOUSEMOVE_STATUS_RIGHT) {
348: s = "MouseMoveStatusRight";
349: goto append;
350: }
351: if (key == KEYC_MOUSEMOVE_BORDER) {
352: s = "MouseMoveBorder";
353: goto append;
354: }
1.47 nicm 355: if (key >= KEYC_USER && key < KEYC_USER + KEYC_NUSER) {
1.53 nicm 356: snprintf(tmp, sizeof tmp, "User%u", (u_int)(key - KEYC_USER));
357: strlcat(out, tmp, sizeof out);
1.58 nicm 358: goto out;
1.47 nicm 359: }
1.18 nicm 360:
1.14 nicm 361: /* Try the key against the string table. */
1.6 nicm 362: for (i = 0; i < nitems(key_string_table); i++) {
1.60 nicm 363: if (key == (key_string_table[i].key & KEYC_MASK_KEY))
1.14 nicm 364: break;
365: }
366: if (i != nitems(key_string_table)) {
367: strlcat(out, key_string_table[i].string, sizeof out);
1.58 nicm 368: goto out;
1.6 nicm 369: }
370:
1.28 nicm 371: /* Is this a UTF-8 key? */
372: if (key > 127 && key < KEYC_BASE) {
1.61 nicm 373: utf8_to_data(key, &ud);
374: off = strlen(out);
375: memcpy(out + off, ud.data, ud.size);
376: out[off + ud.size] = '\0';
377: goto out;
1.28 nicm 378: }
379:
1.14 nicm 380: /* Invalid keys are errors. */
1.52 nicm 381: if (key > 255) {
1.60 nicm 382: snprintf(out, sizeof out, "Invalid#%llx", saved);
1.58 nicm 383: goto out;
1.27 nicm 384: }
1.1 nicm 385:
1.14 nicm 386: /* Check for standard or control key. */
1.28 nicm 387: if (key <= 32) {
1.1 nicm 388: if (key == 0 || key > 26)
1.28 nicm 389: xsnprintf(tmp, sizeof tmp, "C-%c", (int)(64 + key));
1.1 nicm 390: else
1.28 nicm 391: xsnprintf(tmp, sizeof tmp, "C-%c", (int)(96 + key));
1.14 nicm 392: } else if (key >= 32 && key <= 126) {
393: tmp[0] = key;
394: tmp[1] = '\0';
1.52 nicm 395: } else if (key == 127)
396: xsnprintf(tmp, sizeof tmp, "C-?");
397: else if (key >= 128)
1.28 nicm 398: xsnprintf(tmp, sizeof tmp, "\\%llo", key);
1.20 nicm 399:
1.14 nicm 400: strlcat(out, tmp, sizeof out);
1.58 nicm 401: goto out;
1.53 nicm 402:
403: append:
404: strlcat(out, s, sizeof out);
1.58 nicm 405:
406: out:
407: if (with_flags && (saved & KEYC_MASK_FLAGS) != 0) {
408: strlcat(out, "[", sizeof out);
409: if (saved & KEYC_LITERAL)
410: strlcat(out, "L", sizeof out);
411: if (saved & KEYC_KEYPAD)
412: strlcat(out, "K", sizeof out);
413: if (saved & KEYC_CURSOR)
414: strlcat(out, "C", sizeof out);
415: if (saved & KEYC_IMPLIED_META)
416: strlcat(out, "I", sizeof out);
417: if (saved & KEYC_BUILD_MODIFIERS)
418: strlcat(out, "B", sizeof out);
419: strlcat(out, "]", sizeof out);
420: }
1.14 nicm 421: return (out);
1.1 nicm 422: }
![[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