1 /* $OpenBSD$ */ 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 24 #include "tmux.h" 25 26 /* 27 * This file is rather misleadingly named, it contains the code which takes a 28 * key code and translates it into something suitable to be sent to the 29 * application running in a pane (similar to input.c does in the other 30 * direction with output). 31 */ 32 33 static void input_key_mouse(struct window_pane *, struct mouse_event *); 34 35 struct input_key_ent { 36 key_code key; 37 const char *data; 38 39 int flags; 40 #define INPUTKEY_KEYPAD 0x1 /* keypad key */ 41 #define INPUTKEY_CURSOR 0x2 /* cursor key */ 42 }; 43 44 static const struct input_key_ent input_keys[] = { 45 /* Backspace key. */ 46 { KEYC_BSPACE, "\177", 0 }, 47 48 /* Paste keys. */ 49 { KEYC_PASTE_START, "\033[200~", 0 }, 50 { KEYC_PASTE_END, "\033[201~", 0 }, 51 52 /* Function keys. */ 53 { KEYC_F1, "\033OP", 0 }, 54 { KEYC_F2, "\033OQ", 0 }, 55 { KEYC_F3, "\033OR", 0 }, 56 { KEYC_F4, "\033OS", 0 }, 57 { KEYC_F5, "\033[15~", 0 }, 58 { KEYC_F6, "\033[17~", 0 }, 59 { KEYC_F7, "\033[18~", 0 }, 60 { KEYC_F8, "\033[19~", 0 }, 61 { KEYC_F9, "\033[20~", 0 }, 62 { KEYC_F10, "\033[21~", 0 }, 63 { KEYC_F11, "\033[23~", 0 }, 64 { KEYC_F12, "\033[24~", 0 }, 65 { KEYC_F1|KEYC_SHIFT, "\033[25~", 0 }, 66 { KEYC_F2|KEYC_SHIFT, "\033[26~", 0 }, 67 { KEYC_F3|KEYC_SHIFT, "\033[28~", 0 }, 68 { KEYC_F4|KEYC_SHIFT, "\033[29~", 0 }, 69 { KEYC_F5|KEYC_SHIFT, "\033[31~", 0 }, 70 { KEYC_F6|KEYC_SHIFT, "\033[32~", 0 }, 71 { KEYC_F7|KEYC_SHIFT, "\033[33~", 0 }, 72 { KEYC_F8|KEYC_SHIFT, "\033[34~", 0 }, 73 { KEYC_IC, "\033[2~", 0 }, 74 { KEYC_DC, "\033[3~", 0 }, 75 { KEYC_HOME, "\033[1~", 0 }, 76 { KEYC_END, "\033[4~", 0 }, 77 { KEYC_NPAGE, "\033[6~", 0 }, 78 { KEYC_PPAGE, "\033[5~", 0 }, 79 { KEYC_BTAB, "\033[Z", 0 }, 80 81 /* 82 * Arrow keys. Cursor versions must come first. The codes are toggled 83 * between CSI and SS3 versions when ctrl is pressed. 84 */ 85 { KEYC_UP|KEYC_CTRL, "\033[A", INPUTKEY_CURSOR }, 86 { KEYC_DOWN|KEYC_CTRL, "\033[B", INPUTKEY_CURSOR }, 87 { KEYC_RIGHT|KEYC_CTRL, "\033[C", INPUTKEY_CURSOR }, 88 { KEYC_LEFT|KEYC_CTRL, "\033[D", INPUTKEY_CURSOR }, 89 90 { KEYC_UP, "\033OA", INPUTKEY_CURSOR }, 91 { KEYC_DOWN, "\033OB", INPUTKEY_CURSOR }, 92 { KEYC_RIGHT, "\033OC", INPUTKEY_CURSOR }, 93 { KEYC_LEFT, "\033OD", INPUTKEY_CURSOR }, 94 95 { KEYC_UP|KEYC_CTRL, "\033OA", 0 }, 96 { KEYC_DOWN|KEYC_CTRL, "\033OB", 0 }, 97 { KEYC_RIGHT|KEYC_CTRL, "\033OC", 0 }, 98 { KEYC_LEFT|KEYC_CTRL, "\033OD", 0 }, 99 100 { KEYC_UP, "\033[A", 0 }, 101 { KEYC_DOWN, "\033[B", 0 }, 102 { KEYC_RIGHT, "\033[C", 0 }, 103 { KEYC_LEFT, "\033[D", 0 }, 104 105 /* Keypad keys. Keypad versions must come first. */ 106 { KEYC_KP_SLASH, "\033Oo", INPUTKEY_KEYPAD }, 107 { KEYC_KP_STAR, "\033Oj", INPUTKEY_KEYPAD }, 108 { KEYC_KP_MINUS, "\033Om", INPUTKEY_KEYPAD }, 109 { KEYC_KP_SEVEN, "\033Ow", INPUTKEY_KEYPAD }, 110 { KEYC_KP_EIGHT, "\033Ox", INPUTKEY_KEYPAD }, 111 { KEYC_KP_NINE, "\033Oy", INPUTKEY_KEYPAD }, 112 { KEYC_KP_PLUS, "\033Ok", INPUTKEY_KEYPAD }, 113 { KEYC_KP_FOUR, "\033Ot", INPUTKEY_KEYPAD }, 114 { KEYC_KP_FIVE, "\033Ou", INPUTKEY_KEYPAD }, 115 { KEYC_KP_SIX, "\033Ov", INPUTKEY_KEYPAD }, 116 { KEYC_KP_ONE, "\033Oq", INPUTKEY_KEYPAD }, 117 { KEYC_KP_TWO, "\033Or", INPUTKEY_KEYPAD }, 118 { KEYC_KP_THREE, "\033Os", INPUTKEY_KEYPAD }, 119 { KEYC_KP_ENTER, "\033OM", INPUTKEY_KEYPAD }, 120 { KEYC_KP_ZERO, "\033Op", INPUTKEY_KEYPAD }, 121 { KEYC_KP_PERIOD, "\033On", INPUTKEY_KEYPAD }, 122 123 { KEYC_KP_SLASH, "/", 0 }, 124 { KEYC_KP_STAR, "*", 0 }, 125 { KEYC_KP_MINUS, "-", 0 }, 126 { KEYC_KP_SEVEN, "7", 0 }, 127 { KEYC_KP_EIGHT, "8", 0 }, 128 { KEYC_KP_NINE, "9", 0 }, 129 { KEYC_KP_PLUS, "+", 0 }, 130 { KEYC_KP_FOUR, "4", 0 }, 131 { KEYC_KP_FIVE, "5", 0 }, 132 { KEYC_KP_SIX, "6", 0 }, 133 { KEYC_KP_ONE, "1", 0 }, 134 { KEYC_KP_TWO, "2", 0 }, 135 { KEYC_KP_THREE, "3", 0 }, 136 { KEYC_KP_ENTER, "\n", 0 }, 137 { KEYC_KP_ZERO, "0", 0 }, 138 { KEYC_KP_PERIOD, ".", 0 }, 139 }; 140 141 /* Split a character into two UTF-8 bytes. */ 142 static size_t 143 input_split2(u_int c, u_char *dst) 144 { 145 if (c > 0x7f) { 146 dst[0] = (c >> 6) | 0xc0; 147 dst[1] = (c & 0x3f) | 0x80; 148 return (2); 149 } 150 dst[0] = c; 151 return (1); 152 } 153 154 /* Translate a key code into an output key sequence. */ 155 void 156 input_key(struct window_pane *wp, key_code key, struct mouse_event *m) 157 { 158 const struct input_key_ent *ike; 159 u_int i; 160 size_t dlen; 161 char *out; 162 key_code justkey; 163 struct utf8_data ud; 164 165 log_debug("writing key 0x%llx (%s) to %%%u", key, 166 key_string_lookup_key(key), wp->id); 167 168 /* If this is a mouse key, pass off to mouse function. */ 169 if (KEYC_IS_MOUSE(key)) { 170 if (m != NULL && m->wp != -1 && (u_int)m->wp == wp->id) 171 input_key_mouse(wp, m); 172 return; 173 } 174 175 /* Literal keys go as themselves (can't be more than eight bits). */ 176 if (key & KEYC_LITERAL) { 177 ud.data[0] = (u_char)key; 178 bufferevent_write(wp->event, &ud.data[0], 1); 179 return; 180 } 181 182 /* 183 * If this is a normal 7-bit key, just send it, with a leading escape 184 * if necessary. If it is a UTF-8 key, split it and send it. 185 */ 186 justkey = (key & ~(KEYC_XTERM|KEYC_ESCAPE)); 187 if (justkey <= 0x7f) { 188 if (key & KEYC_ESCAPE) 189 bufferevent_write(wp->event, "\033", 1); 190 ud.data[0] = justkey; 191 bufferevent_write(wp->event, &ud.data[0], 1); 192 return; 193 } 194 if (justkey > 0x7f && justkey < KEYC_BASE) { 195 if (utf8_split(justkey, &ud) != UTF8_DONE) 196 return; 197 if (key & KEYC_ESCAPE) 198 bufferevent_write(wp->event, "\033", 1); 199 bufferevent_write(wp->event, ud.data, ud.size); 200 return; 201 } 202 203 /* 204 * Then try to look this up as an xterm key, if the flag to output them 205 * is set. 206 */ 207 if (options_get_number(wp->window->options, "xterm-keys")) { 208 if ((out = xterm_keys_lookup(key)) != NULL) { 209 bufferevent_write(wp->event, out, strlen(out)); 210 free(out); 211 return; 212 } 213 } 214 key &= ~KEYC_XTERM; 215 216 /* Otherwise look the key up in the table. */ 217 for (i = 0; i < nitems(input_keys); i++) { 218 ike = &input_keys[i]; 219 220 if ((ike->flags & INPUTKEY_KEYPAD) && 221 !(wp->screen->mode & MODE_KKEYPAD)) 222 continue; 223 if ((ike->flags & INPUTKEY_CURSOR) && 224 !(wp->screen->mode & MODE_KCURSOR)) 225 continue; 226 227 if ((key & KEYC_ESCAPE) && (ike->key | KEYC_ESCAPE) == key) 228 break; 229 if (ike->key == key) 230 break; 231 } 232 if (i == nitems(input_keys)) { 233 log_debug("key 0x%llx missing", key); 234 return; 235 } 236 dlen = strlen(ike->data); 237 log_debug("found key 0x%llx: \"%s\"", key, ike->data); 238 239 /* Prefix a \033 for escape. */ 240 if (key & KEYC_ESCAPE) 241 bufferevent_write(wp->event, "\033", 1); 242 bufferevent_write(wp->event, ike->data, dlen); 243 } 244 245 /* Translate mouse and output. */ 246 static void 247 input_key_mouse(struct window_pane *wp, struct mouse_event *m) 248 { 249 struct screen *s = wp->screen; 250 int mode = s->mode; 251 char buf[40]; 252 size_t len; 253 u_int x, y; 254 255 if ((mode & ALL_MOUSE_MODES) == 0) 256 return; 257 if (cmd_mouse_at(wp, m, &x, &y, 0) != 0) 258 return; 259 if (!window_pane_visible(wp)) 260 return; 261 262 /* If this pane is not in button or all mode, discard motion events. */ 263 if (MOUSE_DRAG(m->b) && 264 (mode & (MODE_MOUSE_BUTTON|MODE_MOUSE_ALL)) == 0) 265 return; 266 267 /* 268 * If this event is a release event and not in all mode, discard it. 269 * In SGR mode we can tell absolutely because a release is normally 270 * shown by the last character. Without SGR, we check if the last 271 * buttons was also a release. 272 */ 273 if (m->sgr_type != ' ') { 274 if (MOUSE_DRAG(m->sgr_b) && 275 MOUSE_BUTTONS(m->sgr_b) == 3 && 276 (~mode & MODE_MOUSE_ALL)) 277 return; 278 } else { 279 if (MOUSE_DRAG(m->b) && 280 MOUSE_BUTTONS(m->b) == 3 && 281 MOUSE_BUTTONS(m->lb) == 3 && 282 (~mode & MODE_MOUSE_ALL)) 283 return; 284 } 285 286 /* 287 * Use the SGR (1006) extension only if the application requested it 288 * and the underlying terminal also sent the event in this format (this 289 * is because an old style mouse release event cannot be converted into 290 * the new SGR format, since the released button is unknown). Otherwise 291 * pretend that tmux doesn't speak this extension, and fall back to the 292 * UTF-8 (1005) extension if the application requested, or to the 293 * legacy format. 294 */ 295 if (m->sgr_type != ' ' && (s->mode & MODE_MOUSE_SGR)) { 296 len = xsnprintf(buf, sizeof buf, "\033[<%u;%u;%u%c", 297 m->sgr_b, x + 1, y + 1, m->sgr_type); 298 } else if (s->mode & MODE_MOUSE_UTF8) { 299 if (m->b > 0x7ff - 32 || x > 0x7ff - 33 || y > 0x7ff - 33) 300 return; 301 len = xsnprintf((char *)buf, sizeof buf, "\033[M"); 302 len += input_split2(m->b + 32, (u_char *)&buf[len]); 303 len += input_split2(x + 33, (u_char *)&buf[len]); 304 len += input_split2(y + 33, (u_char *)&buf[len]); 305 } else { 306 if (m->b > 223) 307 return; 308 len = xsnprintf((char *)buf, sizeof buf, "\033[M"); 309 buf[len++] = m->b + 32; 310 buf[len++] = x + 33; 311 buf[len++] = y + 33; 312 } 313 log_debug("writing mouse %.*s to %%%u", (int)len, buf, wp->id); 314 bufferevent_write(wp->event, buf, len); 315 } 316