1 /* $OpenBSD$ */ 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 25 int key_string_search_table(const char *); 26 int key_string_get_modifiers(const char **); 27 28 const struct { 29 const char *string; 30 int key; 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 }, 50 { "PageDown", KEYC_NPAGE }, 51 { "PgDn", KEYC_NPAGE }, 52 { "PPage", KEYC_PPAGE }, 53 { "PageUp", KEYC_PPAGE }, 54 { "PgUp", KEYC_PPAGE }, 55 { "Tab", '\011' }, 56 { "BTab", KEYC_BTAB }, 57 { "Space", ' ' }, 58 { "BSpace", KEYC_BSPACE }, 59 { "Enter", '\r' }, 60 { "Escape", '\033' }, 61 62 /* Arrow keys. */ 63 { "Up", KEYC_UP }, 64 { "Down", KEYC_DOWN }, 65 { "Left", KEYC_LEFT }, 66 { "Right", KEYC_RIGHT }, 67 68 /* Numeric keypad. */ 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 }, 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), 98 }; 99 100 /* Find key string in table. */ 101 int 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 113 /* Find modifiers. */ 114 int 115 key_string_get_modifiers(const char **string) 116 { 117 int modifiers; 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. */ 141 int 142 key_string_lookup_string(const char *string) 143 { 144 static const char *other = "!#()+,-.0123456789:;<=>?'\r\t"; 145 int key, modifiers; 146 u_short u; 147 int size; 148 149 /* Is this a hexadecimal value? */ 150 if (string[0] == '0' && string[1] == 'x') { 151 if (sscanf(string + 2, "%hx%n", &u, &size) != 1 || size > 4) 152 return (KEYC_NONE); 153 return (u); 154 } 155 156 /* Check for modifiers. */ 157 modifiers = 0; 158 if (string[0] == '^' && string[1] != '\0') { 159 modifiers |= KEYC_CTRL; 160 string++; 161 } 162 modifiers |= key_string_get_modifiers(&string); 163 if (string[0] == '\0') 164 return (KEYC_NONE); 165 166 /* Is this a standard ASCII key? */ 167 if (string[1] == '\0') { 168 key = (u_char) string[0]; 169 if (key < 32 || key == 127 || key > 255) 170 return (KEYC_NONE); 171 } else { 172 /* Otherwise look the key up in the table. */ 173 key = key_string_search_table(string); 174 if (key == KEYC_NONE) 175 return (KEYC_NONE); 176 } 177 178 /* Convert the standard control keys. */ 179 if (key < KEYC_BASE && (modifiers & KEYC_CTRL) && !strchr(other, key)) { 180 if (key >= 97 && key <= 122) 181 key -= 96; 182 else if (key >= 64 && key <= 95) 183 key -= 64; 184 else if (key == 32) 185 key = 0; 186 else if (key == 63) 187 key = KEYC_BSPACE; 188 else 189 return (KEYC_NONE); 190 modifiers &= ~KEYC_CTRL; 191 } 192 193 return (key | modifiers); 194 } 195 196 /* Convert a key code into string format, with prefix if necessary. */ 197 const char * 198 key_string_lookup_key(int key) 199 { 200 static char out[24]; 201 char tmp[8]; 202 u_int i; 203 204 *out = '\0'; 205 206 /* Handle no key. */ 207 if (key == KEYC_NONE) 208 return ("<NONE>"); 209 if (key == KEYC_MOUSE) 210 return ("<MOUSE>"); 211 212 /* 213 * Special case: display C-@ as C-Space. Could do this below in 214 * the (key >= 0 && key <= 32), but this way we let it be found 215 * in key_string_table, for the unlikely chance that we might 216 * change its name. 217 */ 218 if ((key & KEYC_MASK_KEY) == 0) 219 key = ' ' | KEYC_CTRL | (key & KEYC_MASK_MOD); 220 221 /* Fill in the modifiers. */ 222 if (key & KEYC_CTRL) 223 strlcat(out, "C-", sizeof out); 224 if (key & KEYC_ESCAPE) 225 strlcat(out, "M-", sizeof out); 226 if (key & KEYC_SHIFT) 227 strlcat(out, "S-", sizeof out); 228 key &= KEYC_MASK_KEY; 229 230 /* Try the key against the string table. */ 231 for (i = 0; i < nitems(key_string_table); i++) { 232 if (key == key_string_table[i].key) 233 break; 234 } 235 if (i != nitems(key_string_table)) { 236 strlcat(out, key_string_table[i].string, sizeof out); 237 return (out); 238 } 239 240 /* Invalid keys are errors. */ 241 if (key == 127 || key > 255) 242 return (NULL); 243 244 /* Check for standard or control key. */ 245 if (key >= 0 && key <= 32) { 246 if (key == 0 || key > 26) 247 xsnprintf(tmp, sizeof tmp, "C-%c", 64 + key); 248 else 249 xsnprintf(tmp, sizeof tmp, "C-%c", 96 + key); 250 } else if (key >= 32 && key <= 126) { 251 tmp[0] = key; 252 tmp[1] = '\0'; 253 } else if (key >= 128) 254 xsnprintf(tmp, sizeof tmp, "\\%o", key); 255 256 strlcat(out, tmp, sizeof out); 257 return (out); 258 } 259