1 /* $OpenBSD: key-string.c,v 1.65 2021/04/07 15:46:12 nicm Exp $ */ 2 3 /* 4 * Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com> 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 <stdlib.h> 22 #include <string.h> 23 #include <wchar.h> 24 25 #include "tmux.h" 26 27 static key_code key_string_search_table(const char *); 28 static key_code key_string_get_modifiers(const char **); 29 30 static const struct { 31 const char *string; 32 key_code key; 33 } key_string_table[] = { 34 /* Function keys. */ 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 }, 48 { "Insert", KEYC_IC|KEYC_IMPLIED_META }, 49 { "DC", KEYC_DC|KEYC_IMPLIED_META }, 50 { "Delete", KEYC_DC|KEYC_IMPLIED_META }, 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 }, 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|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 }, 71 72 /* Numeric keypad. */ 73 { "KP/", KEYC_KP_SLASH|KEYC_KEYPAD }, 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 }, 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), 100 KEYC_MOUSE_STRING(MOUSEDRAGEND1, MouseDragEnd1), 101 KEYC_MOUSE_STRING(MOUSEDRAGEND2, MouseDragEnd2), 102 KEYC_MOUSE_STRING(MOUSEDRAGEND3, MouseDragEnd3), 103 KEYC_MOUSE_STRING(WHEELUP, WheelUp), 104 KEYC_MOUSE_STRING(WHEELDOWN, WheelDown), 105 KEYC_MOUSE_STRING(SECONDCLICK1, SecondClick1), 106 KEYC_MOUSE_STRING(SECONDCLICK2, SecondClick2), 107 KEYC_MOUSE_STRING(SECONDCLICK3, SecondClick3), 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), 114 }; 115 116 /* Find key string in table. */ 117 static key_code 118 key_string_search_table(const char *string) 119 { 120 u_int i, user; 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 } 126 127 if (sscanf(string, "User%u", &user) == 1 && user < KEYC_NUSER) 128 return (KEYC_USER + user); 129 130 return (KEYC_UNKNOWN); 131 } 132 133 /* Find modifiers. */ 134 static key_code 135 key_string_get_modifiers(const char **string) 136 { 137 key_code modifiers; 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': 148 modifiers |= KEYC_META; 149 break; 150 case 'S': 151 case 's': 152 modifiers |= KEYC_SHIFT; 153 break; 154 default: 155 *string = NULL; 156 return (0); 157 } 158 *string += 2; 159 } 160 return (modifiers); 161 } 162 163 /* Lookup a string and convert to a key value. */ 164 key_code 165 key_string_lookup_string(const char *string) 166 { 167 static const char *other = "!#()+,-.0123456789:;<=>'\r\t\177"; 168 key_code key, modifiers; 169 u_int u, i; 170 struct utf8_data ud, *udp; 171 enum utf8_state more; 172 utf8_char uc; 173 char m[MB_LEN_MAX + 1]; 174 int mlen; 175 176 /* Is this no key or any key? */ 177 if (strcasecmp(string, "None") == 0) 178 return (KEYC_NONE); 179 if (strcasecmp(string, "Any") == 0) 180 return (KEYC_ANY); 181 182 /* Is this a hexadecimal value? */ 183 if (string[0] == '0' && string[1] == 'x') { 184 if (sscanf(string + 2, "%x", &u) != 1) 185 return (KEYC_UNKNOWN); 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); 201 } 202 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); 210 if (string == NULL || string[0] == '\0') 211 return (KEYC_UNKNOWN); 212 213 /* Is this a standard ASCII key? */ 214 if (string[1] == '\0' && (u_char)string[0] <= 127) { 215 key = (u_char)string[0]; 216 if (key < 32) 217 return (KEYC_UNKNOWN); 218 } else { 219 /* Try as a UTF-8 key. */ 220 if ((more = utf8_open(&ud, (u_char)*string)) == UTF8_MORE) { 221 if (strlen(string) != ud.size) 222 return (KEYC_UNKNOWN); 223 for (i = 1; i < ud.size; i++) 224 more = utf8_append(&ud, (u_char)string[i]); 225 if (more != UTF8_DONE) 226 return (KEYC_UNKNOWN); 227 if (utf8_from_data(&ud, &uc) != UTF8_DONE) 228 return (KEYC_UNKNOWN); 229 return (uc|modifiers); 230 } 231 232 /* Otherwise look the key up in the table. */ 233 key = key_string_search_table(string); 234 if (key == KEYC_UNKNOWN) 235 return (KEYC_UNKNOWN); 236 if (~modifiers & KEYC_META) 237 key &= ~KEYC_IMPLIED_META; 238 } 239 240 /* Convert the standard control keys. */ 241 if (key < KEYC_BASE && (modifiers & KEYC_CTRL) && 242 strchr(other, key) == NULL) { 243 if (key >= 97 && key <= 122) 244 key -= 96; 245 else if (key >= 64 && key <= 95) 246 key -= 64; 247 else if (key == 32) 248 key = 0; 249 else if (key == 63) 250 key = 127; 251 else 252 return (KEYC_UNKNOWN); 253 modifiers &= ~KEYC_CTRL; 254 } 255 256 return (key|modifiers); 257 } 258 259 /* Convert a key code into string format, with prefix if necessary. */ 260 const char * 261 key_string_lookup_key(key_code key, int with_flags) 262 { 263 key_code saved = key; 264 static char out[64]; 265 char tmp[8]; 266 const char *s; 267 u_int i; 268 struct utf8_data ud; 269 size_t off; 270 271 *out = '\0'; 272 273 /* Literal keys are themselves. */ 274 if (key & KEYC_LITERAL) { 275 snprintf(out, sizeof out, "%c", (int)(key & 0xff)); 276 goto out; 277 } 278 279 /* Display C-@ as C-Space. */ 280 if ((key & (KEYC_MASK_KEY|KEYC_MASK_MODIFIERS)) == 0) 281 key = ' '|KEYC_CTRL; 282 283 /* Fill in the modifiers. */ 284 if (key & KEYC_CTRL) 285 strlcat(out, "C-", sizeof out); 286 if (key & KEYC_META) 287 strlcat(out, "M-", sizeof out); 288 if (key & KEYC_SHIFT) 289 strlcat(out, "S-", sizeof out); 290 key &= KEYC_MASK_KEY; 291 292 /* Handle no key. */ 293 if (key == KEYC_NONE) { 294 s = "None"; 295 goto append; 296 } 297 298 /* Handle special keys. */ 299 if (key == KEYC_UNKNOWN) { 300 s = "Unknown"; 301 goto append; 302 } 303 if (key == KEYC_ANY) { 304 s = "Any"; 305 goto append; 306 } 307 if (key == KEYC_FOCUS_IN) { 308 s = "FocusIn"; 309 goto append; 310 } 311 if (key == KEYC_FOCUS_OUT) { 312 s = "FocusOut"; 313 goto append; 314 } 315 if (key == KEYC_PASTE_START) { 316 s = "PasteStart"; 317 goto append; 318 } 319 if (key == KEYC_PASTE_END) { 320 s = "PasteEnd"; 321 goto append; 322 } 323 if (key == KEYC_MOUSE) { 324 s = "Mouse"; 325 goto append; 326 } 327 if (key == KEYC_DRAGGING) { 328 s = "Dragging"; 329 goto append; 330 } 331 if (key == KEYC_MOUSEMOVE_PANE) { 332 s = "MouseMovePane"; 333 goto append; 334 } 335 if (key == KEYC_MOUSEMOVE_STATUS) { 336 s = "MouseMoveStatus"; 337 goto append; 338 } 339 if (key == KEYC_MOUSEMOVE_STATUS_LEFT) { 340 s = "MouseMoveStatusLeft"; 341 goto append; 342 } 343 if (key == KEYC_MOUSEMOVE_STATUS_RIGHT) { 344 s = "MouseMoveStatusRight"; 345 goto append; 346 } 347 if (key == KEYC_MOUSEMOVE_BORDER) { 348 s = "MouseMoveBorder"; 349 goto append; 350 } 351 if (key >= KEYC_USER && key < KEYC_USER + KEYC_NUSER) { 352 snprintf(tmp, sizeof tmp, "User%u", (u_int)(key - KEYC_USER)); 353 strlcat(out, tmp, sizeof out); 354 goto out; 355 } 356 357 /* Try the key against the string table. */ 358 for (i = 0; i < nitems(key_string_table); i++) { 359 if (key == (key_string_table[i].key & KEYC_MASK_KEY)) 360 break; 361 } 362 if (i != nitems(key_string_table)) { 363 strlcat(out, key_string_table[i].string, sizeof out); 364 goto out; 365 } 366 367 /* Is this a UTF-8 key? */ 368 if (key > 127 && key < KEYC_BASE) { 369 utf8_to_data(key, &ud); 370 off = strlen(out); 371 memcpy(out + off, ud.data, ud.size); 372 out[off + ud.size] = '\0'; 373 goto out; 374 } 375 376 /* Invalid keys are errors. */ 377 if (key > 255) { 378 snprintf(out, sizeof out, "Invalid#%llx", saved); 379 goto out; 380 } 381 382 /* Check for standard or control key. */ 383 if (key <= 32) { 384 if (key == 0 || key > 26) 385 xsnprintf(tmp, sizeof tmp, "C-%c", (int)(64 + key)); 386 else 387 xsnprintf(tmp, sizeof tmp, "C-%c", (int)(96 + key)); 388 } else if (key >= 32 && key <= 126) { 389 tmp[0] = key; 390 tmp[1] = '\0'; 391 } else if (key == 127) 392 xsnprintf(tmp, sizeof tmp, "C-?"); 393 else if (key >= 128) 394 xsnprintf(tmp, sizeof tmp, "\\%llo", key); 395 396 strlcat(out, tmp, sizeof out); 397 goto out; 398 399 append: 400 strlcat(out, s, sizeof out); 401 402 out: 403 if (with_flags && (saved & KEYC_MASK_FLAGS) != 0) { 404 strlcat(out, "[", sizeof out); 405 if (saved & KEYC_LITERAL) 406 strlcat(out, "L", sizeof out); 407 if (saved & KEYC_KEYPAD) 408 strlcat(out, "K", sizeof out); 409 if (saved & KEYC_CURSOR) 410 strlcat(out, "C", sizeof out); 411 if (saved & KEYC_IMPLIED_META) 412 strlcat(out, "I", sizeof out); 413 if (saved & KEYC_BUILD_MODIFIERS) 414 strlcat(out, "B", sizeof out); 415 strlcat(out, "]", sizeof out); 416 } 417 return (out); 418 } 419