1 /* $OpenBSD: key-string.c,v 1.72 2024/08/21 04:17:09 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 { "BTab", KEYC_BTAB }, 60 { "Space", ' ' }, 61 { "BSpace", KEYC_BSPACE }, 62 63 /* 64 * C0 control characters, with the exception of Tab, Enter, 65 * and Esc, should never appear as keys. We still render them, 66 * so to be able to spot them in logs in case of an abnormality. 67 */ 68 { "[NUL]", C0_NUL }, 69 { "[SOH]", C0_SOH }, 70 { "[STX]", C0_STX }, 71 { "[ETX]", C0_ETX }, 72 { "[EOT]", C0_EOT }, 73 { "[ENQ]", C0_ENQ }, 74 { "[ASC]", C0_ASC }, 75 { "[BEL]", C0_BEL }, 76 { "[BS]", C0_BS }, 77 { "Tab", C0_HT }, 78 { "[LF]", C0_LF }, 79 { "[VT]", C0_VT }, 80 { "[FF]", C0_FF }, 81 { "Enter", C0_CR }, 82 { "[SO]", C0_SO }, 83 { "[SI]", C0_SI }, 84 { "[DLE]", C0_DLE }, 85 { "[DC1]", C0_DC1 }, 86 { "[DC2]", C0_DC2 }, 87 { "[DC3]", C0_DC3 }, 88 { "[DC4]", C0_DC4 }, 89 { "[NAK]", C0_NAK }, 90 { "[SYN]", C0_SYN }, 91 { "[ETB]", C0_ETB }, 92 { "[CAN]", C0_CAN }, 93 { "[EM]", C0_EM }, 94 { "[SUB]", C0_SUB }, 95 { "Escape", C0_ESC }, 96 { "[FS]", C0_FS }, 97 { "[GS]", C0_GS }, 98 { "[RS]", C0_RS }, 99 { "[US]", C0_US }, 100 101 /* Arrow keys. */ 102 { "Up", KEYC_UP|KEYC_CURSOR|KEYC_IMPLIED_META }, 103 { "Down", KEYC_DOWN|KEYC_CURSOR|KEYC_IMPLIED_META }, 104 { "Left", KEYC_LEFT|KEYC_CURSOR|KEYC_IMPLIED_META }, 105 { "Right", KEYC_RIGHT|KEYC_CURSOR|KEYC_IMPLIED_META }, 106 107 /* Numeric keypad. */ 108 { "KP/", KEYC_KP_SLASH|KEYC_KEYPAD }, 109 { "KP*", KEYC_KP_STAR|KEYC_KEYPAD }, 110 { "KP-", KEYC_KP_MINUS|KEYC_KEYPAD }, 111 { "KP7", KEYC_KP_SEVEN|KEYC_KEYPAD }, 112 { "KP8", KEYC_KP_EIGHT|KEYC_KEYPAD }, 113 { "KP9", KEYC_KP_NINE|KEYC_KEYPAD }, 114 { "KP+", KEYC_KP_PLUS|KEYC_KEYPAD }, 115 { "KP4", KEYC_KP_FOUR|KEYC_KEYPAD }, 116 { "KP5", KEYC_KP_FIVE|KEYC_KEYPAD }, 117 { "KP6", KEYC_KP_SIX|KEYC_KEYPAD }, 118 { "KP1", KEYC_KP_ONE|KEYC_KEYPAD }, 119 { "KP2", KEYC_KP_TWO|KEYC_KEYPAD }, 120 { "KP3", KEYC_KP_THREE|KEYC_KEYPAD }, 121 { "KPEnter", KEYC_KP_ENTER|KEYC_KEYPAD }, 122 { "KP0", KEYC_KP_ZERO|KEYC_KEYPAD }, 123 { "KP.", KEYC_KP_PERIOD|KEYC_KEYPAD }, 124 125 /* Mouse keys. */ 126 KEYC_MOUSE_STRING(MOUSEDOWN1, MouseDown1), 127 KEYC_MOUSE_STRING(MOUSEDOWN2, MouseDown2), 128 KEYC_MOUSE_STRING(MOUSEDOWN3, MouseDown3), 129 KEYC_MOUSE_STRING(MOUSEDOWN6, MouseDown6), 130 KEYC_MOUSE_STRING(MOUSEDOWN7, MouseDown7), 131 KEYC_MOUSE_STRING(MOUSEDOWN8, MouseDown8), 132 KEYC_MOUSE_STRING(MOUSEDOWN9, MouseDown9), 133 KEYC_MOUSE_STRING(MOUSEDOWN10, MouseDown10), 134 KEYC_MOUSE_STRING(MOUSEDOWN11, MouseDown11), 135 KEYC_MOUSE_STRING(MOUSEUP1, MouseUp1), 136 KEYC_MOUSE_STRING(MOUSEUP2, MouseUp2), 137 KEYC_MOUSE_STRING(MOUSEUP3, MouseUp3), 138 KEYC_MOUSE_STRING(MOUSEUP6, MouseUp6), 139 KEYC_MOUSE_STRING(MOUSEUP7, MouseUp7), 140 KEYC_MOUSE_STRING(MOUSEUP8, MouseUp8), 141 KEYC_MOUSE_STRING(MOUSEUP9, MouseUp9), 142 KEYC_MOUSE_STRING(MOUSEUP10, MouseUp10), 143 KEYC_MOUSE_STRING(MOUSEUP11, MouseUp11), 144 KEYC_MOUSE_STRING(MOUSEDRAG1, MouseDrag1), 145 KEYC_MOUSE_STRING(MOUSEDRAG2, MouseDrag2), 146 KEYC_MOUSE_STRING(MOUSEDRAG3, MouseDrag3), 147 KEYC_MOUSE_STRING(MOUSEDRAG6, MouseDrag6), 148 KEYC_MOUSE_STRING(MOUSEDRAG7, MouseDrag7), 149 KEYC_MOUSE_STRING(MOUSEDRAG8, MouseDrag8), 150 KEYC_MOUSE_STRING(MOUSEDRAG9, MouseDrag9), 151 KEYC_MOUSE_STRING(MOUSEDRAG10, MouseDrag10), 152 KEYC_MOUSE_STRING(MOUSEDRAG11, MouseDrag11), 153 KEYC_MOUSE_STRING(MOUSEDRAGEND1, MouseDragEnd1), 154 KEYC_MOUSE_STRING(MOUSEDRAGEND2, MouseDragEnd2), 155 KEYC_MOUSE_STRING(MOUSEDRAGEND3, MouseDragEnd3), 156 KEYC_MOUSE_STRING(MOUSEDRAGEND6, MouseDragEnd6), 157 KEYC_MOUSE_STRING(MOUSEDRAGEND7, MouseDragEnd7), 158 KEYC_MOUSE_STRING(MOUSEDRAGEND8, MouseDragEnd8), 159 KEYC_MOUSE_STRING(MOUSEDRAGEND9, MouseDragEnd9), 160 KEYC_MOUSE_STRING(MOUSEDRAGEND10, MouseDragEnd10), 161 KEYC_MOUSE_STRING(MOUSEDRAGEND11, MouseDragEnd11), 162 KEYC_MOUSE_STRING(WHEELUP, WheelUp), 163 KEYC_MOUSE_STRING(WHEELDOWN, WheelDown), 164 KEYC_MOUSE_STRING(SECONDCLICK1, SecondClick1), 165 KEYC_MOUSE_STRING(SECONDCLICK2, SecondClick2), 166 KEYC_MOUSE_STRING(SECONDCLICK3, SecondClick3), 167 KEYC_MOUSE_STRING(SECONDCLICK6, SecondClick6), 168 KEYC_MOUSE_STRING(SECONDCLICK7, SecondClick7), 169 KEYC_MOUSE_STRING(SECONDCLICK8, SecondClick8), 170 KEYC_MOUSE_STRING(SECONDCLICK9, SecondClick9), 171 KEYC_MOUSE_STRING(SECONDCLICK10, SecondClick10), 172 KEYC_MOUSE_STRING(SECONDCLICK11, SecondClick11), 173 KEYC_MOUSE_STRING(DOUBLECLICK1, DoubleClick1), 174 KEYC_MOUSE_STRING(DOUBLECLICK2, DoubleClick2), 175 KEYC_MOUSE_STRING(DOUBLECLICK3, DoubleClick3), 176 KEYC_MOUSE_STRING(DOUBLECLICK6, DoubleClick6), 177 KEYC_MOUSE_STRING(DOUBLECLICK7, DoubleClick7), 178 KEYC_MOUSE_STRING(DOUBLECLICK8, DoubleClick8), 179 KEYC_MOUSE_STRING(DOUBLECLICK9, DoubleClick9), 180 KEYC_MOUSE_STRING(DOUBLECLICK10, DoubleClick10), 181 KEYC_MOUSE_STRING(DOUBLECLICK11, DoubleClick11), 182 KEYC_MOUSE_STRING(TRIPLECLICK1, TripleClick1), 183 KEYC_MOUSE_STRING(TRIPLECLICK2, TripleClick2), 184 KEYC_MOUSE_STRING(TRIPLECLICK3, TripleClick3), 185 KEYC_MOUSE_STRING(TRIPLECLICK6, TripleClick6), 186 KEYC_MOUSE_STRING(TRIPLECLICK7, TripleClick7), 187 KEYC_MOUSE_STRING(TRIPLECLICK8, TripleClick8), 188 KEYC_MOUSE_STRING(TRIPLECLICK9, TripleClick9), 189 KEYC_MOUSE_STRING(TRIPLECLICK10, TripleClick10), 190 KEYC_MOUSE_STRING(TRIPLECLICK11, TripleClick11) 191 }; 192 193 /* Find key string in table. */ 194 static key_code 195 key_string_search_table(const char *string) 196 { 197 u_int i, user; 198 199 for (i = 0; i < nitems(key_string_table); i++) { 200 if (strcasecmp(string, key_string_table[i].string) == 0) 201 return (key_string_table[i].key); 202 } 203 204 if (sscanf(string, "User%u", &user) == 1 && user < KEYC_NUSER) 205 return (KEYC_USER + user); 206 207 return (KEYC_UNKNOWN); 208 } 209 210 /* Find modifiers. */ 211 static key_code 212 key_string_get_modifiers(const char **string) 213 { 214 key_code modifiers; 215 216 modifiers = 0; 217 while (((*string)[0] != '\0') && (*string)[1] == '-') { 218 switch ((*string)[0]) { 219 case 'C': 220 case 'c': 221 modifiers |= KEYC_CTRL; 222 break; 223 case 'M': 224 case 'm': 225 modifiers |= KEYC_META; 226 break; 227 case 'S': 228 case 's': 229 modifiers |= KEYC_SHIFT; 230 break; 231 default: 232 *string = NULL; 233 return (0); 234 } 235 *string += 2; 236 } 237 return (modifiers); 238 } 239 240 /* Lookup a string and convert to a key value. */ 241 key_code 242 key_string_lookup_string(const char *string) 243 { 244 key_code key, modifiers; 245 u_int u, i; 246 struct utf8_data ud, *udp; 247 enum utf8_state more; 248 utf8_char uc; 249 char m[MB_LEN_MAX + 1]; 250 int mlen; 251 252 /* Is this no key or any key? */ 253 if (strcasecmp(string, "None") == 0) 254 return (KEYC_NONE); 255 if (strcasecmp(string, "Any") == 0) 256 return (KEYC_ANY); 257 258 /* Is this a hexadecimal value? */ 259 if (string[0] == '0' && string[1] == 'x') { 260 if (sscanf(string + 2, "%x", &u) != 1) 261 return (KEYC_UNKNOWN); 262 if (u < 32) 263 return (u); 264 mlen = wctomb(m, u); 265 if (mlen <= 0 || mlen > MB_LEN_MAX) 266 return (KEYC_UNKNOWN); 267 m[mlen] = '\0'; 268 269 udp = utf8_fromcstr(m); 270 if (udp == NULL || 271 udp[0].size == 0 || 272 udp[1].size != 0 || 273 utf8_from_data(&udp[0], &uc) != UTF8_DONE) { 274 free(udp); 275 return (KEYC_UNKNOWN); 276 } 277 free(udp); 278 return (uc); 279 } 280 281 /* Check for modifiers. */ 282 modifiers = 0; 283 if (string[0] == '^' && string[1] != '\0') { 284 modifiers |= KEYC_CTRL; 285 string++; 286 } 287 modifiers |= key_string_get_modifiers(&string); 288 if (string == NULL || string[0] == '\0') 289 return (KEYC_UNKNOWN); 290 291 /* Is this a standard ASCII key? */ 292 if (string[1] == '\0' && (u_char)string[0] <= 127) { 293 key = (u_char)string[0]; 294 if (key < 32) 295 return (KEYC_UNKNOWN); 296 } else { 297 /* Try as a UTF-8 key. */ 298 if ((more = utf8_open(&ud, (u_char)*string)) == UTF8_MORE) { 299 if (strlen(string) != ud.size) 300 return (KEYC_UNKNOWN); 301 for (i = 1; i < ud.size; i++) 302 more = utf8_append(&ud, (u_char)string[i]); 303 if (more != UTF8_DONE) 304 return (KEYC_UNKNOWN); 305 if (utf8_from_data(&ud, &uc) != UTF8_DONE) 306 return (KEYC_UNKNOWN); 307 return (uc|modifiers); 308 } 309 310 /* Otherwise look the key up in the table. */ 311 key = key_string_search_table(string); 312 if (key == KEYC_UNKNOWN) 313 return (KEYC_UNKNOWN); 314 if (~modifiers & KEYC_META) 315 key &= ~KEYC_IMPLIED_META; 316 } 317 318 return (key|modifiers); 319 } 320 321 /* Convert a key code into string format, with prefix if necessary. */ 322 const char * 323 key_string_lookup_key(key_code key, int with_flags) 324 { 325 key_code saved = key; 326 static char out[64]; 327 char tmp[8]; 328 const char *s; 329 u_int i; 330 struct utf8_data ud; 331 size_t off; 332 333 *out = '\0'; 334 335 /* Literal keys are themselves. */ 336 if (key & KEYC_LITERAL) { 337 snprintf(out, sizeof out, "%c", (int)(key & 0xff)); 338 goto out; 339 } 340 341 /* Fill in the modifiers. */ 342 if (key & KEYC_CTRL) 343 strlcat(out, "C-", sizeof out); 344 if (key & KEYC_META) 345 strlcat(out, "M-", sizeof out); 346 if (key & KEYC_SHIFT) 347 strlcat(out, "S-", sizeof out); 348 key &= KEYC_MASK_KEY; 349 350 /* Handle no key. */ 351 if (key == KEYC_NONE) { 352 s = "None"; 353 goto append; 354 } 355 356 /* Handle special keys. */ 357 if (key == KEYC_UNKNOWN) { 358 s = "Unknown"; 359 goto append; 360 } 361 if (key == KEYC_ANY) { 362 s = "Any"; 363 goto append; 364 } 365 if (key == KEYC_FOCUS_IN) { 366 s = "FocusIn"; 367 goto append; 368 } 369 if (key == KEYC_FOCUS_OUT) { 370 s = "FocusOut"; 371 goto append; 372 } 373 if (key == KEYC_PASTE_START) { 374 s = "PasteStart"; 375 goto append; 376 } 377 if (key == KEYC_PASTE_END) { 378 s = "PasteEnd"; 379 goto append; 380 } 381 if (key == KEYC_MOUSE) { 382 s = "Mouse"; 383 goto append; 384 } 385 if (key == KEYC_DRAGGING) { 386 s = "Dragging"; 387 goto append; 388 } 389 if (key == KEYC_MOUSEMOVE_PANE) { 390 s = "MouseMovePane"; 391 goto append; 392 } 393 if (key == KEYC_MOUSEMOVE_STATUS) { 394 s = "MouseMoveStatus"; 395 goto append; 396 } 397 if (key == KEYC_MOUSEMOVE_STATUS_LEFT) { 398 s = "MouseMoveStatusLeft"; 399 goto append; 400 } 401 if (key == KEYC_MOUSEMOVE_STATUS_RIGHT) { 402 s = "MouseMoveStatusRight"; 403 goto append; 404 } 405 if (key == KEYC_MOUSEMOVE_BORDER) { 406 s = "MouseMoveBorder"; 407 goto append; 408 } 409 if (key >= KEYC_USER && key < KEYC_USER + KEYC_NUSER) { 410 snprintf(tmp, sizeof tmp, "User%u", (u_int)(key - KEYC_USER)); 411 strlcat(out, tmp, sizeof out); 412 goto out; 413 } 414 415 /* Try the key against the string table. */ 416 for (i = 0; i < nitems(key_string_table); i++) { 417 if (key == (key_string_table[i].key & KEYC_MASK_KEY)) 418 break; 419 } 420 if (i != nitems(key_string_table)) { 421 strlcat(out, key_string_table[i].string, sizeof out); 422 goto out; 423 } 424 425 /* Is this a Unicode key? */ 426 if (KEYC_IS_UNICODE(key)) { 427 utf8_to_data(key, &ud); 428 off = strlen(out); 429 memcpy(out + off, ud.data, ud.size); 430 out[off + ud.size] = '\0'; 431 goto out; 432 } 433 434 /* Invalid keys are errors. */ 435 if (key > 255) { 436 snprintf(out, sizeof out, "Invalid#%llx", saved); 437 goto out; 438 } 439 440 /* Printable ASCII keys. */ 441 if (key > 32 && key <= 126) { 442 tmp[0] = key; 443 tmp[1] = '\0'; 444 } else if (key == 127) 445 xsnprintf(tmp, sizeof tmp, "C-?"); 446 else if (key >= 128) 447 xsnprintf(tmp, sizeof tmp, "\\%llo", key); 448 449 strlcat(out, tmp, sizeof out); 450 goto out; 451 452 append: 453 strlcat(out, s, sizeof out); 454 455 out: 456 if (with_flags && (saved & KEYC_MASK_FLAGS) != 0) { 457 strlcat(out, "[", sizeof out); 458 if (saved & KEYC_LITERAL) 459 strlcat(out, "L", sizeof out); 460 if (saved & KEYC_KEYPAD) 461 strlcat(out, "K", sizeof out); 462 if (saved & KEYC_CURSOR) 463 strlcat(out, "C", sizeof out); 464 if (saved & KEYC_IMPLIED_META) 465 strlcat(out, "I", sizeof out); 466 if (saved & KEYC_BUILD_MODIFIERS) 467 strlcat(out, "B", sizeof out); 468 if (saved & KEYC_SENT) 469 strlcat(out, "S", sizeof out); 470 strlcat(out, "]", sizeof out); 471 } 472 return (out); 473 } 474