[BACK]Return to tty-keys.c CVS log [TXT][DIR] Up to [local] / src / usr.bin / tmux

Annotation of src/usr.bin/tmux/tty-keys.c, Revision 1.140

1.140   ! nicm        1: /* $OpenBSD: tty-keys.c,v 1.139 2020/06/02 08:17:27 nicm Exp $ */
1.1       nicm        2:
                      3: /*
1.84      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: #include <sys/time.h>
                     21:
1.104     nicm       22: #include <netinet/in.h>
                     23:
1.133     nicm       24: #include <ctype.h>
1.35      nicm       25: #include <limits.h>
1.104     nicm       26: #include <resolv.h>
1.35      nicm       27: #include <stdlib.h>
1.1       nicm       28: #include <string.h>
1.3       nicm       29: #include <termios.h>
                     30: #include <unistd.h>
1.1       nicm       31:
                     32: #include "tmux.h"
                     33:
1.9       nicm       34: /*
1.50      nicm       35:  * Handle keys input from the outside terminal. tty_default_*_keys[] are a base
                     36:  * table of supported keys which are looked up in terminfo(5) and translated
                     37:  * into a ternary tree.
1.9       nicm       38:  */
                     39:
1.86      nicm       40: static void    tty_keys_add1(struct tty_key **, const char *, key_code);
                     41: static void    tty_keys_add(struct tty *, const char *, key_code);
                     42: static void    tty_keys_free1(struct tty_key *);
                     43: static struct tty_key *tty_keys_find1(struct tty_key *, const char *, size_t,
1.76      nicm       44:                    size_t *);
1.86      nicm       45: static struct tty_key *tty_keys_find(struct tty *, const char *, size_t,
                     46:                    size_t *);
                     47: static int     tty_keys_next1(struct tty *, const char *, size_t, key_code *,
1.87      nicm       48:                    size_t *, int);
1.86      nicm       49: static void    tty_keys_callback(int, short, void *);
1.133     nicm       50: static int     tty_keys_extended_key(struct tty *, const char *, size_t,
                     51:                    size_t *, key_code *);
1.111     nicm       52: static int     tty_keys_mouse(struct tty *, const char *, size_t, size_t *,
                     53:                    struct mouse_event *);
1.104     nicm       54: static int     tty_keys_clipboard(struct tty *, const char *, size_t,
                     55:                    size_t *);
1.91      nicm       56: static int     tty_keys_device_attributes(struct tty *, const char *, size_t,
                     57:                    size_t *);
1.128     nicm       58: static int     tty_keys_extended_device_attributes(struct tty *, const char *,
1.119     nicm       59:                    size_t, size_t *);
1.1       nicm       60:
1.48      nicm       61: /* Default raw keys. */
                     62: struct tty_default_key_raw {
1.1       nicm       63:        const char             *string;
1.76      nicm       64:        key_code                key;
1.1       nicm       65: };
1.90      nicm       66: static const struct tty_default_key_raw tty_default_raw_keys[] = {
1.125     nicm       67:        /* Application escape. */
                     68:        { "\033O[", '\033' },
                     69:
1.1       nicm       70:        /*
1.8       nicm       71:         * Numeric keypad. Just use the vt100 escape sequences here and always
                     72:         * put the terminal into keypad_xmit mode. Translation of numbers
                     73:         * mode/applications mode is done in input-keys.c.
1.1       nicm       74:         */
1.132     nicm       75:        { "\033Oo", KEYC_KP_SLASH|KEYC_KEYPAD },
                     76:        { "\033Oj", KEYC_KP_STAR|KEYC_KEYPAD },
                     77:        { "\033Om", KEYC_KP_MINUS|KEYC_KEYPAD },
                     78:        { "\033Ow", KEYC_KP_SEVEN|KEYC_KEYPAD },
                     79:        { "\033Ox", KEYC_KP_EIGHT|KEYC_KEYPAD },
                     80:        { "\033Oy", KEYC_KP_NINE|KEYC_KEYPAD },
                     81:        { "\033Ok", KEYC_KP_PLUS|KEYC_KEYPAD },
                     82:        { "\033Ot", KEYC_KP_FOUR|KEYC_KEYPAD },
                     83:        { "\033Ou", KEYC_KP_FIVE|KEYC_KEYPAD },
                     84:        { "\033Ov", KEYC_KP_SIX|KEYC_KEYPAD },
                     85:        { "\033Oq", KEYC_KP_ONE|KEYC_KEYPAD },
                     86:        { "\033Or", KEYC_KP_TWO|KEYC_KEYPAD },
                     87:        { "\033Os", KEYC_KP_THREE|KEYC_KEYPAD },
                     88:        { "\033OM", KEYC_KP_ENTER|KEYC_KEYPAD },
                     89:        { "\033Op", KEYC_KP_ZERO|KEYC_KEYPAD },
                     90:        { "\033On", KEYC_KP_PERIOD|KEYC_KEYPAD },
1.10      nicm       91:
1.29      nicm       92:        /* Arrow keys. */
1.132     nicm       93:        { "\033OA", KEYC_UP|KEYC_CURSOR },
                     94:        { "\033OB", KEYC_DOWN|KEYC_CURSOR },
                     95:        { "\033OC", KEYC_RIGHT|KEYC_CURSOR },
                     96:        { "\033OD", KEYC_LEFT|KEYC_CURSOR },
                     97:
1.140   ! nicm       98:        { "\033\033OA", KEYC_UP|KEYC_CURSOR|KEYC_META|KEYC_IMPLIED_META },
        !            99:        { "\033\033OB", KEYC_DOWN|KEYC_CURSOR|KEYC_META|KEYC_IMPLIED_META },
        !           100:        { "\033\033OC", KEYC_RIGHT|KEYC_CURSOR|KEYC_META|KEYC_IMPLIED_META },
        !           101:        { "\033\033OD", KEYC_LEFT|KEYC_CURSOR|KEYC_META|KEYC_IMPLIED_META },
        !           102:
1.132     nicm      103:        { "\033[A", KEYC_UP|KEYC_CURSOR },
                    104:        { "\033[B", KEYC_DOWN|KEYC_CURSOR },
                    105:        { "\033[C", KEYC_RIGHT|KEYC_CURSOR },
                    106:        { "\033[D", KEYC_LEFT|KEYC_CURSOR },
1.57      nicm      107:
1.140   ! nicm      108:        { "\033\033[A", KEYC_UP|KEYC_CURSOR|KEYC_META|KEYC_IMPLIED_META },
        !           109:        { "\033\033[B", KEYC_DOWN|KEYC_CURSOR|KEYC_META|KEYC_IMPLIED_META },
        !           110:        { "\033\033[C", KEYC_RIGHT|KEYC_CURSOR|KEYC_META|KEYC_IMPLIED_META },
        !           111:        { "\033\033[D", KEYC_LEFT|KEYC_CURSOR|KEYC_META|KEYC_IMPLIED_META },
        !           112:
1.57      nicm      113:        /* Other (xterm) "cursor" keys. */
                    114:        { "\033OH", KEYC_HOME },
                    115:        { "\033OF", KEYC_END },
                    116:
1.140   ! nicm      117:        { "\033\033OH", KEYC_HOME|KEYC_META|KEYC_IMPLIED_META },
        !           118:        { "\033\033OF", KEYC_END|KEYC_META|KEYC_IMPLIED_META },
        !           119:
1.57      nicm      120:        { "\033[H", KEYC_HOME },
                    121:        { "\033[F", KEYC_END },
1.140   ! nicm      122:
        !           123:        { "\033\033[H", KEYC_HOME|KEYC_META|KEYC_IMPLIED_META },
        !           124:        { "\033\033[F", KEYC_END|KEYC_META|KEYC_IMPLIED_META },
1.21      nicm      125:
                    126:        /* rxvt-style arrow + modifier keys. */
1.48      nicm      127:        { "\033Oa", KEYC_UP|KEYC_CTRL },
                    128:        { "\033Ob", KEYC_DOWN|KEYC_CTRL },
                    129:        { "\033Oc", KEYC_RIGHT|KEYC_CTRL },
                    130:        { "\033Od", KEYC_LEFT|KEYC_CTRL },
                    131:
                    132:        { "\033[a", KEYC_UP|KEYC_SHIFT },
                    133:        { "\033[b", KEYC_DOWN|KEYC_SHIFT },
                    134:        { "\033[c", KEYC_RIGHT|KEYC_SHIFT },
                    135:        { "\033[d", KEYC_LEFT|KEYC_SHIFT },
                    136:
                    137:        /* rxvt-style function + modifier keys (C = ^, S = $, C-S = @). */
                    138:        { "\033[11^", KEYC_F1|KEYC_CTRL },
                    139:        { "\033[12^", KEYC_F2|KEYC_CTRL },
                    140:        { "\033[13^", KEYC_F3|KEYC_CTRL },
                    141:        { "\033[14^", KEYC_F4|KEYC_CTRL },
                    142:        { "\033[15^", KEYC_F5|KEYC_CTRL },
                    143:        { "\033[17^", KEYC_F6|KEYC_CTRL },
                    144:        { "\033[18^", KEYC_F7|KEYC_CTRL },
                    145:        { "\033[19^", KEYC_F8|KEYC_CTRL },
                    146:        { "\033[20^", KEYC_F9|KEYC_CTRL },
                    147:        { "\033[21^", KEYC_F10|KEYC_CTRL },
                    148:        { "\033[23^", KEYC_F11|KEYC_CTRL },
                    149:        { "\033[24^", KEYC_F12|KEYC_CTRL },
                    150:        { "\033[2^", KEYC_IC|KEYC_CTRL },
                    151:        { "\033[3^", KEYC_DC|KEYC_CTRL },
                    152:        { "\033[7^", KEYC_HOME|KEYC_CTRL },
                    153:        { "\033[8^", KEYC_END|KEYC_CTRL },
                    154:        { "\033[6^", KEYC_NPAGE|KEYC_CTRL },
                    155:        { "\033[5^", KEYC_PPAGE|KEYC_CTRL },
                    156:
                    157:        { "\033[11$", KEYC_F1|KEYC_SHIFT },
                    158:        { "\033[12$", KEYC_F2|KEYC_SHIFT },
                    159:        { "\033[13$", KEYC_F3|KEYC_SHIFT },
                    160:        { "\033[14$", KEYC_F4|KEYC_SHIFT },
                    161:        { "\033[15$", KEYC_F5|KEYC_SHIFT },
                    162:        { "\033[17$", KEYC_F6|KEYC_SHIFT },
                    163:        { "\033[18$", KEYC_F7|KEYC_SHIFT },
                    164:        { "\033[19$", KEYC_F8|KEYC_SHIFT },
                    165:        { "\033[20$", KEYC_F9|KEYC_SHIFT },
                    166:        { "\033[21$", KEYC_F10|KEYC_SHIFT },
                    167:        { "\033[23$", KEYC_F11|KEYC_SHIFT },
                    168:        { "\033[24$", KEYC_F12|KEYC_SHIFT },
                    169:        { "\033[2$", KEYC_IC|KEYC_SHIFT },
                    170:        { "\033[3$", KEYC_DC|KEYC_SHIFT },
                    171:        { "\033[7$", KEYC_HOME|KEYC_SHIFT },
                    172:        { "\033[8$", KEYC_END|KEYC_SHIFT },
                    173:        { "\033[6$", KEYC_NPAGE|KEYC_SHIFT },
                    174:        { "\033[5$", KEYC_PPAGE|KEYC_SHIFT },
                    175:
                    176:        { "\033[11@", KEYC_F1|KEYC_CTRL|KEYC_SHIFT },
                    177:        { "\033[12@", KEYC_F2|KEYC_CTRL|KEYC_SHIFT },
                    178:        { "\033[13@", KEYC_F3|KEYC_CTRL|KEYC_SHIFT },
                    179:        { "\033[14@", KEYC_F4|KEYC_CTRL|KEYC_SHIFT },
                    180:        { "\033[15@", KEYC_F5|KEYC_CTRL|KEYC_SHIFT },
                    181:        { "\033[17@", KEYC_F6|KEYC_CTRL|KEYC_SHIFT },
                    182:        { "\033[18@", KEYC_F7|KEYC_CTRL|KEYC_SHIFT },
                    183:        { "\033[19@", KEYC_F8|KEYC_CTRL|KEYC_SHIFT },
                    184:        { "\033[20@", KEYC_F9|KEYC_CTRL|KEYC_SHIFT },
                    185:        { "\033[21@", KEYC_F10|KEYC_CTRL|KEYC_SHIFT },
                    186:        { "\033[23@", KEYC_F11|KEYC_CTRL|KEYC_SHIFT },
                    187:        { "\033[24@", KEYC_F12|KEYC_CTRL|KEYC_SHIFT },
                    188:        { "\033[2@", KEYC_IC|KEYC_CTRL|KEYC_SHIFT },
                    189:        { "\033[3@", KEYC_DC|KEYC_CTRL|KEYC_SHIFT },
                    190:        { "\033[7@", KEYC_HOME|KEYC_CTRL|KEYC_SHIFT },
                    191:        { "\033[8@", KEYC_END|KEYC_CTRL|KEYC_SHIFT },
                    192:        { "\033[6@", KEYC_NPAGE|KEYC_CTRL|KEYC_SHIFT },
                    193:        { "\033[5@", KEYC_PPAGE|KEYC_CTRL|KEYC_SHIFT },
1.56      nicm      194:
                    195:        /* Focus tracking. */
                    196:        { "\033[I", KEYC_FOCUS_IN },
                    197:        { "\033[O", KEYC_FOCUS_OUT },
1.98      nicm      198:
                    199:        /* Paste keys. */
                    200:        { "\033[200~", KEYC_PASTE_START },
                    201:        { "\033[201~", KEYC_PASTE_END },
1.48      nicm      202: };
1.29      nicm      203:
1.132     nicm      204: /* Default xterm keys. */
                    205: struct tty_default_key_xterm {
                    206:        const char      *template;
                    207:        key_code         key;
                    208: };
                    209: static const struct tty_default_key_xterm tty_default_xterm_keys[] = {
                    210:        { "\033[1;_P", KEYC_F1 },
                    211:        { "\033O1;_P", KEYC_F1 },
                    212:        { "\033O_P", KEYC_F1 },
                    213:        { "\033[1;_Q", KEYC_F2 },
                    214:        { "\033O1;_Q", KEYC_F2 },
                    215:        { "\033O_Q", KEYC_F2 },
                    216:        { "\033[1;_R", KEYC_F3 },
                    217:        { "\033O1;_R", KEYC_F3 },
                    218:        { "\033O_R", KEYC_F3 },
                    219:        { "\033[1;_S", KEYC_F4 },
                    220:        { "\033O1;_S", KEYC_F4 },
                    221:        { "\033O_S", KEYC_F4 },
                    222:        { "\033[15;_~", KEYC_F5 },
                    223:        { "\033[17;_~", KEYC_F6 },
                    224:        { "\033[18;_~", KEYC_F7 },
                    225:        { "\033[19;_~", KEYC_F8 },
                    226:        { "\033[20;_~", KEYC_F9 },
                    227:        { "\033[21;_~", KEYC_F10 },
                    228:        { "\033[23;_~", KEYC_F11 },
                    229:        { "\033[24;_~", KEYC_F12 },
                    230:        { "\033[1;_A", KEYC_UP },
                    231:        { "\033[1;_B", KEYC_DOWN },
                    232:        { "\033[1;_C", KEYC_RIGHT },
                    233:        { "\033[1;_D", KEYC_LEFT },
                    234:        { "\033[1;_H", KEYC_HOME },
                    235:        { "\033[1;_F", KEYC_END },
                    236:        { "\033[5;_~", KEYC_PPAGE },
                    237:        { "\033[6;_~", KEYC_NPAGE },
                    238:        { "\033[2;_~", KEYC_IC },
                    239:        { "\033[3;_~", KEYC_DC },
                    240: };
                    241: static const key_code tty_default_xterm_modifiers[] = {
                    242:        0,
                    243:        0,
1.135     nicm      244:        KEYC_SHIFT,
                    245:        KEYC_META|KEYC_IMPLIED_META,
                    246:        KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META,
                    247:        KEYC_CTRL,
                    248:        KEYC_SHIFT|KEYC_CTRL,
                    249:        KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL,
                    250:        KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL
1.132     nicm      251: };
                    252:
1.103     nicm      253: /*
1.132     nicm      254:  * Default terminfo(5) keys. Any keys that have builtin modifiers (that is,
                    255:  * where the key itself contains the modifiers) has the KEYC_XTERM flag set so
                    256:  * a leading escape is not treated as meta (and probably removed).
1.103     nicm      257:  */
1.48      nicm      258: struct tty_default_key_code {
                    259:        enum tty_code_code      code;
1.76      nicm      260:        key_code                key;
1.48      nicm      261: };
1.90      nicm      262: static const struct tty_default_key_code tty_default_code_keys[] = {
1.29      nicm      263:        /* Function keys. */
1.48      nicm      264:        { TTYC_KF1, KEYC_F1 },
                    265:        { TTYC_KF2, KEYC_F2 },
                    266:        { TTYC_KF3, KEYC_F3 },
                    267:        { TTYC_KF4, KEYC_F4 },
                    268:        { TTYC_KF5, KEYC_F5 },
                    269:        { TTYC_KF6, KEYC_F6 },
                    270:        { TTYC_KF7, KEYC_F7 },
                    271:        { TTYC_KF8, KEYC_F8 },
                    272:        { TTYC_KF9, KEYC_F9 },
                    273:        { TTYC_KF10, KEYC_F10 },
                    274:        { TTYC_KF11, KEYC_F11 },
                    275:        { TTYC_KF12, KEYC_F12 },
1.70      nicm      276:
1.135     nicm      277:        { TTYC_KF13, KEYC_F1|KEYC_SHIFT },
                    278:        { TTYC_KF14, KEYC_F2|KEYC_SHIFT },
                    279:        { TTYC_KF15, KEYC_F3|KEYC_SHIFT },
                    280:        { TTYC_KF16, KEYC_F4|KEYC_SHIFT },
                    281:        { TTYC_KF17, KEYC_F5|KEYC_SHIFT },
                    282:        { TTYC_KF18, KEYC_F6|KEYC_SHIFT },
                    283:        { TTYC_KF19, KEYC_F7|KEYC_SHIFT },
                    284:        { TTYC_KF20, KEYC_F8|KEYC_SHIFT },
                    285:        { TTYC_KF21, KEYC_F9|KEYC_SHIFT },
                    286:        { TTYC_KF22, KEYC_F10|KEYC_SHIFT },
                    287:        { TTYC_KF23, KEYC_F11|KEYC_SHIFT },
                    288:        { TTYC_KF24, KEYC_F12|KEYC_SHIFT },
                    289:
                    290:        { TTYC_KF25, KEYC_F1|KEYC_CTRL },
                    291:        { TTYC_KF26, KEYC_F2|KEYC_CTRL },
                    292:        { TTYC_KF27, KEYC_F3|KEYC_CTRL },
                    293:        { TTYC_KF28, KEYC_F4|KEYC_CTRL },
                    294:        { TTYC_KF29, KEYC_F5|KEYC_CTRL },
                    295:        { TTYC_KF30, KEYC_F6|KEYC_CTRL },
                    296:        { TTYC_KF31, KEYC_F7|KEYC_CTRL },
                    297:        { TTYC_KF32, KEYC_F8|KEYC_CTRL },
                    298:        { TTYC_KF33, KEYC_F9|KEYC_CTRL },
                    299:        { TTYC_KF34, KEYC_F10|KEYC_CTRL },
                    300:        { TTYC_KF35, KEYC_F11|KEYC_CTRL },
                    301:        { TTYC_KF36, KEYC_F12|KEYC_CTRL },
                    302:
                    303:        { TTYC_KF37, KEYC_F1|KEYC_SHIFT|KEYC_CTRL },
                    304:        { TTYC_KF38, KEYC_F2|KEYC_SHIFT|KEYC_CTRL },
                    305:        { TTYC_KF39, KEYC_F3|KEYC_SHIFT|KEYC_CTRL },
                    306:        { TTYC_KF40, KEYC_F4|KEYC_SHIFT|KEYC_CTRL },
                    307:        { TTYC_KF41, KEYC_F5|KEYC_SHIFT|KEYC_CTRL },
                    308:        { TTYC_KF42, KEYC_F6|KEYC_SHIFT|KEYC_CTRL },
                    309:        { TTYC_KF43, KEYC_F7|KEYC_SHIFT|KEYC_CTRL },
                    310:        { TTYC_KF44, KEYC_F8|KEYC_SHIFT|KEYC_CTRL },
                    311:        { TTYC_KF45, KEYC_F9|KEYC_SHIFT|KEYC_CTRL },
                    312:        { TTYC_KF46, KEYC_F10|KEYC_SHIFT|KEYC_CTRL },
                    313:        { TTYC_KF47, KEYC_F11|KEYC_SHIFT|KEYC_CTRL },
                    314:        { TTYC_KF48, KEYC_F12|KEYC_SHIFT|KEYC_CTRL },
                    315:
                    316:        { TTYC_KF49, KEYC_F1|KEYC_META|KEYC_IMPLIED_META },
                    317:        { TTYC_KF50, KEYC_F2|KEYC_META|KEYC_IMPLIED_META },
                    318:        { TTYC_KF51, KEYC_F3|KEYC_META|KEYC_IMPLIED_META },
                    319:        { TTYC_KF52, KEYC_F4|KEYC_META|KEYC_IMPLIED_META },
                    320:        { TTYC_KF53, KEYC_F5|KEYC_META|KEYC_IMPLIED_META },
                    321:        { TTYC_KF54, KEYC_F6|KEYC_META|KEYC_IMPLIED_META },
                    322:        { TTYC_KF55, KEYC_F7|KEYC_META|KEYC_IMPLIED_META },
                    323:        { TTYC_KF56, KEYC_F8|KEYC_META|KEYC_IMPLIED_META },
                    324:        { TTYC_KF57, KEYC_F9|KEYC_META|KEYC_IMPLIED_META },
                    325:        { TTYC_KF58, KEYC_F10|KEYC_META|KEYC_IMPLIED_META },
                    326:        { TTYC_KF59, KEYC_F11|KEYC_META|KEYC_IMPLIED_META },
                    327:        { TTYC_KF60, KEYC_F12|KEYC_META|KEYC_IMPLIED_META },
                    328:
                    329:        { TTYC_KF61, KEYC_F1|KEYC_META|KEYC_IMPLIED_META|KEYC_SHIFT },
                    330:        { TTYC_KF62, KEYC_F2|KEYC_META|KEYC_IMPLIED_META|KEYC_SHIFT },
                    331:        { TTYC_KF63, KEYC_F3|KEYC_META|KEYC_IMPLIED_META|KEYC_SHIFT },
1.70      nicm      332:
1.48      nicm      333:        { TTYC_KICH1, KEYC_IC },
                    334:        { TTYC_KDCH1, KEYC_DC },
                    335:        { TTYC_KHOME, KEYC_HOME },
                    336:        { TTYC_KEND, KEYC_END },
                    337:        { TTYC_KNP, KEYC_NPAGE },
                    338:        { TTYC_KPP, KEYC_PPAGE },
                    339:        { TTYC_KCBT, KEYC_BTAB },
1.29      nicm      340:
                    341:        /* Arrow keys from terminfo. */
1.132     nicm      342:        { TTYC_KCUU1, KEYC_UP|KEYC_CURSOR },
                    343:        { TTYC_KCUD1, KEYC_DOWN|KEYC_CURSOR },
                    344:        { TTYC_KCUB1, KEYC_LEFT|KEYC_CURSOR },
                    345:        { TTYC_KCUF1, KEYC_RIGHT|KEYC_CURSOR },
1.29      nicm      346:
1.103     nicm      347:        /* Key and modifier capabilities. */
1.135     nicm      348:        { TTYC_KDC2, KEYC_DC|KEYC_SHIFT },
                    349:        { TTYC_KDC3, KEYC_DC|KEYC_META|KEYC_IMPLIED_META },
                    350:        { TTYC_KDC4, KEYC_DC|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
                    351:        { TTYC_KDC5, KEYC_DC|KEYC_CTRL },
                    352:        { TTYC_KDC6, KEYC_DC|KEYC_SHIFT|KEYC_CTRL },
                    353:        { TTYC_KDC7, KEYC_DC|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
                    354:        { TTYC_KIND, KEYC_DOWN|KEYC_SHIFT },
                    355:        { TTYC_KDN2, KEYC_DOWN|KEYC_SHIFT },
                    356:        { TTYC_KDN3, KEYC_DOWN|KEYC_META|KEYC_IMPLIED_META },
                    357:        { TTYC_KDN4, KEYC_DOWN|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
                    358:        { TTYC_KDN5, KEYC_DOWN|KEYC_CTRL },
                    359:        { TTYC_KDN6, KEYC_DOWN|KEYC_SHIFT|KEYC_CTRL },
                    360:        { TTYC_KDN7, KEYC_DOWN|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
                    361:        { TTYC_KEND2, KEYC_END|KEYC_SHIFT },
                    362:        { TTYC_KEND3, KEYC_END|KEYC_META|KEYC_IMPLIED_META },
                    363:        { TTYC_KEND4, KEYC_END|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
                    364:        { TTYC_KEND5, KEYC_END|KEYC_CTRL },
                    365:        { TTYC_KEND6, KEYC_END|KEYC_SHIFT|KEYC_CTRL },
                    366:        { TTYC_KEND7, KEYC_END|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
                    367:        { TTYC_KHOM2, KEYC_HOME|KEYC_SHIFT },
                    368:        { TTYC_KHOM3, KEYC_HOME|KEYC_META|KEYC_IMPLIED_META },
                    369:        { TTYC_KHOM4, KEYC_HOME|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
                    370:        { TTYC_KHOM5, KEYC_HOME|KEYC_CTRL },
                    371:        { TTYC_KHOM6, KEYC_HOME|KEYC_SHIFT|KEYC_CTRL },
                    372:        { TTYC_KHOM7, KEYC_HOME|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
                    373:        { TTYC_KIC2, KEYC_IC|KEYC_SHIFT },
                    374:        { TTYC_KIC3, KEYC_IC|KEYC_META|KEYC_IMPLIED_META },
                    375:        { TTYC_KIC4, KEYC_IC|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
                    376:        { TTYC_KIC5, KEYC_IC|KEYC_CTRL },
                    377:        { TTYC_KIC6, KEYC_IC|KEYC_SHIFT|KEYC_CTRL },
                    378:        { TTYC_KIC7, KEYC_IC|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
                    379:        { TTYC_KLFT2, KEYC_LEFT|KEYC_SHIFT },
                    380:        { TTYC_KLFT3, KEYC_LEFT|KEYC_META|KEYC_IMPLIED_META },
                    381:        { TTYC_KLFT4, KEYC_LEFT|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
                    382:        { TTYC_KLFT5, KEYC_LEFT|KEYC_CTRL },
                    383:        { TTYC_KLFT6, KEYC_LEFT|KEYC_SHIFT|KEYC_CTRL },
                    384:        { TTYC_KLFT7, KEYC_LEFT|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
                    385:        { TTYC_KNXT2, KEYC_NPAGE|KEYC_SHIFT },
                    386:        { TTYC_KNXT3, KEYC_NPAGE|KEYC_META|KEYC_IMPLIED_META },
                    387:        { TTYC_KNXT4, KEYC_NPAGE|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
                    388:        { TTYC_KNXT5, KEYC_NPAGE|KEYC_CTRL },
                    389:        { TTYC_KNXT6, KEYC_NPAGE|KEYC_SHIFT|KEYC_CTRL },
                    390:        { TTYC_KNXT7, KEYC_NPAGE|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
                    391:        { TTYC_KPRV2, KEYC_PPAGE|KEYC_SHIFT },
                    392:        { TTYC_KPRV3, KEYC_PPAGE|KEYC_META|KEYC_IMPLIED_META },
                    393:        { TTYC_KPRV4, KEYC_PPAGE|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
                    394:        { TTYC_KPRV5, KEYC_PPAGE|KEYC_CTRL },
                    395:        { TTYC_KPRV6, KEYC_PPAGE|KEYC_SHIFT|KEYC_CTRL },
                    396:        { TTYC_KPRV7, KEYC_PPAGE|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
                    397:        { TTYC_KRIT2, KEYC_RIGHT|KEYC_SHIFT },
                    398:        { TTYC_KRIT3, KEYC_RIGHT|KEYC_META|KEYC_IMPLIED_META },
                    399:        { TTYC_KRIT4, KEYC_RIGHT|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
                    400:        { TTYC_KRIT5, KEYC_RIGHT|KEYC_CTRL },
                    401:        { TTYC_KRIT6, KEYC_RIGHT|KEYC_SHIFT|KEYC_CTRL },
                    402:        { TTYC_KRIT7, KEYC_RIGHT|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
                    403:        { TTYC_KRI, KEYC_UP|KEYC_SHIFT },
                    404:        { TTYC_KUP2, KEYC_UP|KEYC_SHIFT },
                    405:        { TTYC_KUP3, KEYC_UP|KEYC_META|KEYC_IMPLIED_META },
                    406:        { TTYC_KUP4, KEYC_UP|KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META },
                    407:        { TTYC_KUP5, KEYC_UP|KEYC_CTRL },
                    408:        { TTYC_KUP6, KEYC_UP|KEYC_SHIFT|KEYC_CTRL },
                    409:        { TTYC_KUP7, KEYC_UP|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL },
1.1       nicm      410: };
                    411:
1.48      nicm      412: /* Add key to tree. */
1.86      nicm      413: static void
1.76      nicm      414: tty_keys_add(struct tty *tty, const char *s, key_code key)
1.16      nicm      415: {
1.29      nicm      416:        struct tty_key  *tk;
                    417:        size_t           size;
                    418:        const char      *keystr;
1.1       nicm      419:
1.135     nicm      420:        keystr = key_string_lookup_key(key, 1);
1.29      nicm      421:        if ((tk = tty_keys_find(tty, s, strlen(s), &size)) == NULL) {
1.76      nicm      422:                log_debug("new key %s: 0x%llx (%s)", s, key, keystr);
1.16      nicm      423:                tty_keys_add1(&tty->key_tree, s, key);
1.29      nicm      424:        } else {
1.76      nicm      425:                log_debug("replacing key %s: 0x%llx (%s)", s, key, keystr);
1.29      nicm      426:                tk->key = key;
1.16      nicm      427:        }
1.1       nicm      428: }
                    429:
1.16      nicm      430: /* Add next node to the tree. */
1.86      nicm      431: static void
1.76      nicm      432: tty_keys_add1(struct tty_key **tkp, const char *s, key_code key)
1.1       nicm      433: {
1.16      nicm      434:        struct tty_key  *tk;
1.1       nicm      435:
1.16      nicm      436:        /* Allocate a tree entry if there isn't one already. */
                    437:        tk = *tkp;
                    438:        if (tk == NULL) {
                    439:                tk = *tkp = xcalloc(1, sizeof *tk);
                    440:                tk->ch = *s;
1.83      nicm      441:                tk->key = KEYC_UNKNOWN;
1.16      nicm      442:        }
                    443:
                    444:        /* Find the next entry. */
                    445:        if (*s == tk->ch) {
                    446:                /* Move forward in string. */
                    447:                s++;
                    448:
                    449:                /* If this is the end of the string, no more is necessary. */
                    450:                if (*s == '\0') {
                    451:                        tk->key = key;
                    452:                        return;
                    453:                }
                    454:
                    455:                /* Use the child tree for the next character. */
                    456:                tkp = &tk->next;
1.27      nicm      457:        } else {
1.16      nicm      458:                if (*s < tk->ch)
                    459:                        tkp = &tk->left;
                    460:                else if (*s > tk->ch)
                    461:                        tkp = &tk->right;
                    462:        }
                    463:
                    464:        /* And recurse to add it. */
                    465:        tty_keys_add1(tkp, s, key);
1.1       nicm      466: }
                    467:
1.16      nicm      468: /* Initialise a key tree from the table. */
1.1       nicm      469: void
1.48      nicm      470: tty_keys_build(struct tty *tty)
1.1       nicm      471: {
1.48      nicm      472:        const struct tty_default_key_raw        *tdkr;
1.132     nicm      473:        const struct tty_default_key_xterm      *tdkx;
1.48      nicm      474:        const struct tty_default_key_code       *tdkc;
1.132     nicm      475:        u_int                                    i, j;
1.109     nicm      476:        const char                              *s;
1.99      nicm      477:        struct options_entry                    *o;
1.107     nicm      478:        struct options_array_item               *a;
1.109     nicm      479:        union options_value                     *ov;
1.132     nicm      480:        char                                     copy[16];
                    481:        key_code                                 key;
1.1       nicm      482:
1.48      nicm      483:        if (tty->key_tree != NULL)
1.71      nicm      484:                tty_keys_free(tty);
1.16      nicm      485:        tty->key_tree = NULL;
1.1       nicm      486:
1.132     nicm      487:        for (i = 0; i < nitems(tty_default_xterm_keys); i++) {
                    488:                tdkx = &tty_default_xterm_keys[i];
                    489:                for (j = 2; j < nitems(tty_default_xterm_modifiers); j++) {
                    490:                        strlcpy(copy, tdkx->template, sizeof copy);
                    491:                        copy[strcspn(copy, "_")] = '0' + j;
                    492:
                    493:                        key = tdkx->key|tty_default_xterm_modifiers[j];
                    494:                        tty_keys_add(tty, copy, key);
                    495:                }
                    496:        }
1.48      nicm      497:        for (i = 0; i < nitems(tty_default_raw_keys); i++) {
                    498:                tdkr = &tty_default_raw_keys[i];
                    499:
                    500:                s = tdkr->string;
1.51      nicm      501:                if (*s != '\0')
                    502:                        tty_keys_add(tty, s, tdkr->key);
1.48      nicm      503:        }
                    504:        for (i = 0; i < nitems(tty_default_code_keys); i++) {
                    505:                tdkc = &tty_default_code_keys[i];
                    506:
                    507:                s = tty_term_string(tty->term, tdkc->code);
1.51      nicm      508:                if (*s != '\0')
                    509:                        tty_keys_add(tty, s, tdkc->key);
1.1       nicm      510:
1.99      nicm      511:        }
                    512:
                    513:        o = options_get(global_options, "user-keys");
1.107     nicm      514:        if (o != NULL) {
                    515:                a = options_array_first(o);
                    516:                while (a != NULL) {
1.112     nicm      517:                        i = options_array_item_index(a);
1.109     nicm      518:                        ov = options_array_item_value(a);
1.110     nicm      519:                        tty_keys_add(tty, ov->string, KEYC_USER + i);
1.107     nicm      520:                        a = options_array_next(a);
1.99      nicm      521:                }
1.1       nicm      522:        }
                    523: }
                    524:
1.16      nicm      525: /* Free the entire key tree. */
1.1       nicm      526: void
                    527: tty_keys_free(struct tty *tty)
                    528: {
1.16      nicm      529:        tty_keys_free1(tty->key_tree);
                    530: }
1.1       nicm      531:
1.16      nicm      532: /* Free a single key. */
1.86      nicm      533: static void
1.16      nicm      534: tty_keys_free1(struct tty_key *tk)
                    535: {
                    536:        if (tk->next != NULL)
                    537:                tty_keys_free1(tk->next);
                    538:        if (tk->left != NULL)
                    539:                tty_keys_free1(tk->left);
                    540:        if (tk->right != NULL)
                    541:                tty_keys_free1(tk->right);
1.42      nicm      542:        free(tk);
1.1       nicm      543: }
                    544:
1.16      nicm      545: /* Lookup a key in the tree. */
1.86      nicm      546: static struct tty_key *
1.16      nicm      547: tty_keys_find(struct tty *tty, const char *buf, size_t len, size_t *size)
1.1       nicm      548: {
1.16      nicm      549:        *size = 0;
                    550:        return (tty_keys_find1(tty->key_tree, buf, len, size));
                    551: }
1.1       nicm      552:
1.16      nicm      553: /* Find the next node. */
1.86      nicm      554: static struct tty_key *
1.16      nicm      555: tty_keys_find1(struct tty_key *tk, const char *buf, size_t len, size_t *size)
                    556: {
1.106     nicm      557:        /* If no data, no match. */
                    558:        if (len == 0)
                    559:                return (NULL);
                    560:
1.16      nicm      561:        /* If the node is NULL, this is the end of the tree. No match. */
                    562:        if (tk == NULL)
1.1       nicm      563:                return (NULL);
                    564:
1.16      nicm      565:        /* Pick the next in the sequence. */
                    566:        if (tk->ch == *buf) {
                    567:                /* Move forward in the string. */
                    568:                buf++; len--;
                    569:                (*size)++;
1.1       nicm      570:
1.16      nicm      571:                /* At the end of the string, return the current node. */
1.83      nicm      572:                if (len == 0 || (tk->next == NULL && tk->key != KEYC_UNKNOWN))
1.16      nicm      573:                        return (tk);
1.1       nicm      574:
1.16      nicm      575:                /* Move into the next tree for the following character. */
                    576:                tk = tk->next;
                    577:        } else {
                    578:                if (*buf < tk->ch)
                    579:                        tk = tk->left;
                    580:                else if (*buf > tk->ch)
                    581:                        tk = tk->right;
1.1       nicm      582:        }
                    583:
1.16      nicm      584:        /* Move to the next in the tree. */
                    585:        return (tty_keys_find1(tk, buf, len, size));
1.1       nicm      586: }
                    587:
1.86      nicm      588: /* Look up part of the next key. */
                    589: static int
                    590: tty_keys_next1(struct tty *tty, const char *buf, size_t len, key_code *key,
1.87      nicm      591:     size_t *size, int expired)
1.86      nicm      592: {
1.94      nicm      593:        struct client           *c = tty->client;
1.86      nicm      594:        struct tty_key          *tk, *tk1;
                    595:        struct utf8_data         ud;
                    596:        enum utf8_state          more;
1.138     nicm      597:        utf8_char                uc;
1.86      nicm      598:        u_int                    i;
                    599:
1.94      nicm      600:        log_debug("%s: next key is %zu (%.*s) (expired=%d)", c->name, len,
                    601:            (int)len, buf, expired);
1.86      nicm      602:
                    603:        /* Is this a known key? */
                    604:        tk = tty_keys_find(tty, buf, len, size);
1.87      nicm      605:        if (tk != NULL && tk->key != KEYC_UNKNOWN) {
1.86      nicm      606:                tk1 = tk;
                    607:                do
1.94      nicm      608:                        log_debug("%s: keys in list: %#llx", c->name, tk1->key);
1.86      nicm      609:                while ((tk1 = tk1->next) != NULL);
1.87      nicm      610:                if (tk->next != NULL && !expired)
                    611:                        return (1);
1.86      nicm      612:                *key = tk->key;
1.87      nicm      613:                return (0);
1.86      nicm      614:        }
1.97      nicm      615:
1.86      nicm      616:        /* Is this valid UTF-8? */
                    617:        more = utf8_open(&ud, (u_char)*buf);
                    618:        if (more == UTF8_MORE) {
                    619:                *size = ud.size;
1.87      nicm      620:                if (len < ud.size) {
                    621:                        if (!expired)
                    622:                                return (1);
                    623:                        return (-1);
                    624:                }
1.86      nicm      625:                for (i = 1; i < ud.size; i++)
                    626:                        more = utf8_append(&ud, (u_char)buf[i]);
                    627:                if (more != UTF8_DONE)
1.87      nicm      628:                        return (-1);
1.86      nicm      629:
1.138     nicm      630:                if (utf8_from_data(&ud, &uc) != UTF8_DONE)
1.87      nicm      631:                        return (-1);
1.138     nicm      632:                *key = uc;
1.86      nicm      633:
1.94      nicm      634:                log_debug("%s: UTF-8 key %.*s %#llx", c->name, (int)ud.size,
1.138     nicm      635:                    ud.data, *key);
1.86      nicm      636:                return (0);
                    637:        }
                    638:
                    639:        return (-1);
                    640: }
                    641:
1.111     nicm      642: /* Process at least one key in the buffer. Return 0 if no keys present. */
                    643: int
1.14      nicm      644: tty_keys_next(struct tty *tty)
1.1       nicm      645: {
1.111     nicm      646:        struct client           *c = tty->client;
                    647:        struct timeval           tv;
                    648:        const char              *buf;
                    649:        size_t                   len, size;
                    650:        cc_t                     bspace;
                    651:        int                      delay, expired = 0, n;
                    652:        key_code                 key;
                    653:        struct mouse_event       m = { 0 };
                    654:        struct key_event        *event;
1.1       nicm      655:
1.51      nicm      656:        /* Get key buffer. */
1.93      nicm      657:        buf = EVBUFFER_DATA(tty->in);
                    658:        len = EVBUFFER_LENGTH(tty->in);
1.1       nicm      659:        if (len == 0)
1.14      nicm      660:                return (0);
1.94      nicm      661:        log_debug("%s: keys are %zu (%.*s)", c->name, len, (int)len, buf);
1.1       nicm      662:
1.104     nicm      663:        /* Is this a clipboard response? */
                    664:        switch (tty_keys_clipboard(tty, buf, len, &size)) {
                    665:        case 0:         /* yes */
                    666:                key = KEYC_UNKNOWN;
                    667:                goto complete_key;
                    668:        case -1:        /* no, or not valid */
                    669:                break;
                    670:        case 1:         /* partial */
                    671:                goto partial_key;
                    672:        }
                    673:
1.91      nicm      674:        /* Is this a device attributes response? */
                    675:        switch (tty_keys_device_attributes(tty, buf, len, &size)) {
                    676:        case 0:         /* yes */
                    677:                key = KEYC_UNKNOWN;
                    678:                goto complete_key;
                    679:        case -1:        /* no, or not valid */
                    680:                break;
                    681:        case 1:         /* partial */
                    682:                goto partial_key;
                    683:        }
                    684:
1.128     nicm      685:        /* Is this an extended device attributes response? */
                    686:        switch (tty_keys_extended_device_attributes(tty, buf, len, &size)) {
1.119     nicm      687:        case 0:         /* yes */
                    688:                key = KEYC_UNKNOWN;
                    689:                goto complete_key;
                    690:        case -1:        /* no, or not valid */
                    691:                break;
                    692:        case 1:         /* partial */
                    693:                goto partial_key;
                    694:        }
                    695:
1.26      nicm      696:        /* Is this a mouse key press? */
1.111     nicm      697:        switch (tty_keys_mouse(tty, buf, len, &size, &m)) {
1.22      nicm      698:        case 0:         /* yes */
                    699:                key = KEYC_MOUSE;
1.51      nicm      700:                goto complete_key;
1.22      nicm      701:        case -1:        /* no, or not valid */
1.24      nicm      702:                break;
1.67      nicm      703:        case -2:        /* yes, but we don't care. */
1.73      nicm      704:                key = KEYC_MOUSE;
1.67      nicm      705:                goto discard_key;
1.22      nicm      706:        case 1:         /* partial */
                    707:                goto partial_key;
1.11      nicm      708:        }
                    709:
1.133     nicm      710:        /* Is this an extended key press? */
                    711:        switch (tty_keys_extended_key(tty, buf, len, &size, &key)) {
                    712:        case 0:         /* yes */
                    713:                goto complete_key;
                    714:        case -1:        /* no, or not valid */
                    715:                break;
                    716:        case 1:         /* partial */
                    717:                goto partial_key;
                    718:        }
                    719:
1.86      nicm      720: first_key:
1.101     nicm      721:        /* Try to lookup complete key. */
                    722:        n = tty_keys_next1(tty, buf, len, &key, &size, expired);
                    723:        if (n == 0)     /* found */
                    724:                goto complete_key;
                    725:        if (n == 1)
                    726:                goto partial_key;
                    727:
                    728:        /*
                    729:         * If not a complete key, look for key with an escape prefix (meta
                    730:         * modifier).
                    731:         */
1.105     nicm      732:        if (*buf == '\033' && len > 1) {
1.87      nicm      733:                /* Look for a key without the escape. */
                    734:                n = tty_keys_next1(tty, buf + 1, len - 1, &key, &size, expired);
                    735:                if (n == 0) {   /* found */
1.135     nicm      736:                        if (key & KEYC_IMPLIED_META) {
1.97      nicm      737:                                /*
                    738:                                 * We want the escape key as well as the xterm
                    739:                                 * key, because the xterm sequence implicitly
                    740:                                 * includes the escape (so if we see
                    741:                                 * \033\033[1;3D we know it is an Escape
                    742:                                 * followed by M-Left, not just M-Left).
                    743:                                 */
                    744:                                key = '\033';
                    745:                                size = 1;
                    746:                                goto complete_key;
                    747:                        }
1.134     nicm      748:                        key |= KEYC_META;
1.87      nicm      749:                        size++;
                    750:                        goto complete_key;
                    751:                }
                    752:                if (n == 1)     /* partial */
1.62      nicm      753:                        goto partial_key;
1.89      nicm      754:        }
1.1       nicm      755:
1.89      nicm      756:        /*
                    757:         * At this point, we know the key is not partial (with or without
                    758:         * escape). So pass it through even if the timer has not expired.
                    759:         */
                    760:        if (*buf == '\033' && len >= 2) {
1.134     nicm      761:                key = (u_char)buf[1] | KEYC_META;
1.89      nicm      762:                size = 2;
                    763:        } else {
                    764:                key = (u_char)buf[0];
                    765:                size = 1;
1.76      nicm      766:        }
1.51      nicm      767:        goto complete_key;
                    768:
                    769: partial_key:
1.94      nicm      770:        log_debug("%s: partial key %.*s", c->name, (int)len, buf);
1.14      nicm      771:
1.51      nicm      772:        /* If timer is going, check for expiration. */
                    773:        if (tty->flags & TTY_TIMER) {
                    774:                if (evtimer_initialized(&tty->key_timer) &&
1.59      nicm      775:                    !evtimer_pending(&tty->key_timer, NULL)) {
                    776:                        expired = 1;
1.51      nicm      777:                        goto first_key;
1.59      nicm      778:                }
1.39      nicm      779:                return (0);
1.51      nicm      780:        }
1.39      nicm      781:
1.51      nicm      782:        /* Get the time period. */
1.75      nicm      783:        delay = options_get_number(global_options, "escape-time");
1.28      nicm      784:        tv.tv_sec = delay / 1000;
                    785:        tv.tv_usec = (delay % 1000) * 1000L;
1.27      nicm      786:
1.51      nicm      787:        /* Start the timer. */
1.36      nicm      788:        if (event_initialized(&tty->key_timer))
                    789:                evtimer_del(&tty->key_timer);
1.14      nicm      790:        evtimer_set(&tty->key_timer, tty_keys_callback, tty);
                    791:        evtimer_add(&tty->key_timer, &tv);
1.27      nicm      792:
1.51      nicm      793:        tty->flags |= TTY_TIMER;
1.14      nicm      794:        return (0);
1.1       nicm      795:
1.51      nicm      796: complete_key:
1.94      nicm      797:        log_debug("%s: complete key %.*s %#llx", c->name, (int)size, buf, key);
1.88      nicm      798:
                    799:        /*
                    800:         * Check for backspace key using termios VERASE - the terminfo
                    801:         * kbs entry is extremely unreliable, so cannot be safely
                    802:         * used. termios should have a better idea.
                    803:         */
                    804:        bspace = tty->tio.c_cc[VERASE];
                    805:        if (bspace != _POSIX_VDISABLE && (key & KEYC_MASK_KEY) == bspace)
1.135     nicm      806:                key = (key & KEYC_MASK_MODIFIERS)|KEYC_BSPACE;
1.16      nicm      807:
1.51      nicm      808:        /* Remove data from buffer. */
1.93      nicm      809:        evbuffer_drain(tty->in, size);
1.16      nicm      810:
1.51      nicm      811:        /* Remove key timer. */
1.36      nicm      812:        if (event_initialized(&tty->key_timer))
                    813:                evtimer_del(&tty->key_timer);
1.51      nicm      814:        tty->flags &= ~TTY_TIMER;
1.56      nicm      815:
                    816:        /* Check for focus events. */
1.137     nicm      817:        if (key == KEYC_FOCUS_OUT)
1.56      nicm      818:                tty->client->flags &= ~CLIENT_FOCUSED;
1.137     nicm      819:        else if (key == KEYC_FOCUS_IN)
1.56      nicm      820:                tty->client->flags |= CLIENT_FOCUSED;
1.16      nicm      821:
1.51      nicm      822:        /* Fire the key. */
1.111     nicm      823:        if (key != KEYC_UNKNOWN) {
                    824:                event = xmalloc(sizeof *event);
                    825:                event->key = key;
                    826:                memcpy(&event->m, &m, sizeof event->m);
1.113     nicm      827:                if (!server_client_handle_key(c, event))
                    828:                        free(event);
1.111     nicm      829:        }
1.16      nicm      830:
1.14      nicm      831:        return (1);
1.67      nicm      832:
                    833: discard_key:
1.94      nicm      834:        log_debug("%s: discard key %.*s %#llx", c->name, (int)size, buf, key);
1.67      nicm      835:
                    836:        /* Remove data from buffer. */
1.93      nicm      837:        evbuffer_drain(tty->in, size);
1.67      nicm      838:
                    839:        return (1);
1.14      nicm      840: }
                    841:
1.16      nicm      842: /* Key timer callback. */
1.86      nicm      843: static void
1.81      nicm      844: tty_keys_callback(__unused int fd, __unused short events, void *data)
1.14      nicm      845: {
                    846:        struct tty      *tty = data;
                    847:
1.51      nicm      848:        if (tty->flags & TTY_TIMER) {
                    849:                while (tty_keys_next(tty))
                    850:                        ;
                    851:        }
1.133     nicm      852: }
                    853:
                    854: /*
                    855:  * Handle extended key input. This has two forms: \033[27;m;k~ and \033[k;mu,
                    856:  * where k is key as a number and m is a modifier. Returns 0 for success, -1
                    857:  * for failure, 1 for partial;
                    858:  */
                    859: static int
                    860: tty_keys_extended_key(struct tty *tty, const char *buf, size_t len,
                    861:     size_t *size, key_code *key)
                    862: {
                    863:        struct client   *c = tty->client;
                    864:        size_t           end;
                    865:        u_int            number, modifiers;
                    866:        char             tmp[64];
                    867:
                    868:        *size = 0;
                    869:
                    870:        /* First two bytes are always \033[. */
                    871:        if (buf[0] != '\033')
                    872:                return (-1);
                    873:        if (len == 1)
                    874:                return (1);
                    875:        if (buf[1] != '[')
                    876:                return (-1);
                    877:        if (len == 2)
                    878:                return (1);
                    879:
                    880:        /*
                    881:         * Look for a terminator. Stop at either '~' or anything that isn't a
                    882:         * number or ';'.
                    883:         */
                    884:        for (end = 2; end < len && end != sizeof tmp; end++) {
                    885:                if (buf[end] == '~')
                    886:                        break;
                    887:                if (!isdigit((u_char)buf[end]) && buf[end] != ';')
                    888:                        break;
                    889:        }
                    890:        if (end == len)
                    891:                return (1);
                    892:        if (end == sizeof tmp || (buf[end] != '~' && buf[end] != 'u'))
                    893:                return (-1);
                    894:
                    895:        /* Copy to the buffer. */
                    896:        memcpy(tmp, buf + 2, end);
                    897:        tmp[end] = '\0';
                    898:
                    899:        /* Try to parse either form of key. */
                    900:        if (buf[end] == '~') {
                    901:                if (sscanf(tmp, "27;%u;%u", &modifiers, &number) != 2)
                    902:                        return (-1);
                    903:        } else {
                    904:                if (sscanf(tmp ,"%u;%u", &number, &modifiers) != 2)
                    905:                        return (-1);
                    906:        }
                    907:        *size = end + 1;
                    908:
                    909:        /* Store the key and modifiers. */
1.135     nicm      910:        *key = number;
1.133     nicm      911:        switch (modifiers) {
                    912:        case 2:
                    913:                (*key) |= KEYC_SHIFT;
                    914:                break;
                    915:        case 3:
1.135     nicm      916:                (*key) |= (KEYC_META|KEYC_IMPLIED_META);
1.133     nicm      917:                break;
                    918:        case 4:
1.135     nicm      919:                (*key) |= (KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META);
1.133     nicm      920:                break;
                    921:        case 5:
                    922:                (*key) |= KEYC_CTRL;
                    923:                break;
                    924:        case 6:
                    925:                (*key) |= (KEYC_SHIFT|KEYC_CTRL);
                    926:                break;
                    927:        case 7:
1.134     nicm      928:                (*key) |= (KEYC_META|KEYC_CTRL);
1.133     nicm      929:                break;
                    930:        case 8:
1.135     nicm      931:                (*key) |= (KEYC_SHIFT|KEYC_META|KEYC_IMPLIED_META|KEYC_CTRL);
1.133     nicm      932:                break;
                    933:        default:
                    934:                *key = KEYC_NONE;
                    935:                break;
                    936:        }
                    937:        if (log_get_level() != 0) {
                    938:                log_debug("%s: extended key %.*s is %llx (%s)", c->name,
1.135     nicm      939:                    (int)*size, buf, *key, key_string_lookup_key(*key, 1));
1.133     nicm      940:        }
                    941:        return (0);
1.1       nicm      942: }
                    943:
1.27      nicm      944: /*
1.22      nicm      945:  * Handle mouse key input. Returns 0 for success, -1 for failure, 1 for partial
                    946:  * (probably a mouse sequence but need more data).
                    947:  */
1.86      nicm      948: static int
1.111     nicm      949: tty_keys_mouse(struct tty *tty, const char *buf, size_t len, size_t *size,
                    950:     struct mouse_event *m)
1.1       nicm      951: {
1.111     nicm      952:        struct client   *c = tty->client;
                    953:        u_int            i, x, y, b, sgr_b;
                    954:        u_char           sgr_type, ch;
1.33      nicm      955:
1.1       nicm      956:        /*
1.33      nicm      957:         * Standard mouse sequences are \033[M followed by three characters
1.55      nicm      958:         * indicating button, X and Y, all based at 32 with 1,1 top-left.
1.33      nicm      959:         *
                    960:         * UTF-8 mouse sequences are similar but the three are expressed as
                    961:         * UTF-8 characters.
1.55      nicm      962:         *
                    963:         * SGR extended mouse sequences are \033[< followed by three numbers in
                    964:         * decimal and separated by semicolons indicating button, X and Y. A
                    965:         * trailing 'M' is click or scroll and trailing 'm' release. All are
                    966:         * based at 0 with 1,1 top-left.
1.1       nicm      967:         */
                    968:
1.22      nicm      969:        *size = 0;
1.72      nicm      970:        x = y = b = sgr_b = 0;
                    971:        sgr_type = ' ';
1.22      nicm      972:
1.55      nicm      973:        /* First two bytes are always \033[. */
1.22      nicm      974:        if (buf[0] != '\033')
                    975:                return (-1);
                    976:        if (len == 1)
                    977:                return (1);
                    978:        if (buf[1] != '[')
                    979:                return (-1);
                    980:        if (len == 2)
                    981:                return (1);
                    982:
1.55      nicm      983:        /*
1.82      nicm      984:         * Third byte is M in old standard (and UTF-8 extension which we do not
                    985:         * support), < in SGR extension.
1.55      nicm      986:         */
                    987:        if (buf[2] == 'M') {
                    988:                /* Read the three inputs. */
                    989:                *size = 3;
                    990:                for (i = 0; i < 3; i++) {
                    991:                        if (len <= *size)
                    992:                                return (1);
1.94      nicm      993:                        ch = (u_char)buf[(*size)++];
1.55      nicm      994:                        if (i == 0)
1.94      nicm      995:                                b = ch;
1.55      nicm      996:                        else if (i == 1)
1.94      nicm      997:                                x = ch;
1.55      nicm      998:                        else
1.94      nicm      999:                                y = ch;
1.33      nicm     1000:                }
1.94      nicm     1001:                log_debug("%s: mouse input: %.*s", c->name, (int)*size, buf);
1.16      nicm     1002:
1.55      nicm     1003:                /* Check and return the mouse input. */
1.60      nicm     1004:                if (b < 32)
1.55      nicm     1005:                        return (-1);
                   1006:                b -= 32;
1.60      nicm     1007:                if (x >= 33)
                   1008:                        x -= 33;
                   1009:                else
                   1010:                        x = 256 - x;
                   1011:                if (y >= 33)
                   1012:                        y -= 33;
                   1013:                else
                   1014:                        y = 256 - y;
1.55      nicm     1015:        } else if (buf[2] == '<') {
                   1016:                /* Read the three inputs. */
                   1017:                *size = 3;
                   1018:                while (1) {
                   1019:                        if (len <= *size)
                   1020:                                return (1);
1.94      nicm     1021:                        ch = (u_char)buf[(*size)++];
                   1022:                        if (ch == ';')
1.55      nicm     1023:                                break;
1.94      nicm     1024:                        if (ch < '0' || ch > '9')
1.55      nicm     1025:                                return (-1);
1.94      nicm     1026:                        sgr_b = 10 * sgr_b + (ch - '0');
1.55      nicm     1027:                }
                   1028:                while (1) {
                   1029:                        if (len <= *size)
                   1030:                                return (1);
1.94      nicm     1031:                        ch = (u_char)buf[(*size)++];
                   1032:                        if (ch == ';')
1.55      nicm     1033:                                break;
1.94      nicm     1034:                        if (ch < '0' || ch > '9')
1.55      nicm     1035:                                return (-1);
1.94      nicm     1036:                        x = 10 * x + (ch - '0');
1.55      nicm     1037:                }
                   1038:                while (1) {
                   1039:                        if (len <= *size)
                   1040:                                return (1);
1.94      nicm     1041:                        ch = (u_char)buf[(*size)++];
                   1042:                        if (ch == 'M' || ch == 'm')
1.55      nicm     1043:                                break;
1.94      nicm     1044:                        if (ch < '0' || ch > '9')
1.55      nicm     1045:                                return (-1);
1.94      nicm     1046:                        y = 10 * y + (ch - '0');
1.55      nicm     1047:                }
1.94      nicm     1048:                log_debug("%s: mouse input (SGR): %.*s", c->name, (int)*size,
                   1049:                    buf);
1.1       nicm     1050:
1.55      nicm     1051:                /* Check and return the mouse input. */
                   1052:                if (x < 1 || y < 1)
                   1053:                        return (-1);
                   1054:                x--;
                   1055:                y--;
1.72      nicm     1056:                b = sgr_b;
                   1057:
                   1058:                /* Type is M for press, m for release. */
1.94      nicm     1059:                sgr_type = ch;
1.72      nicm     1060:                if (sgr_type == 'm')
                   1061:                        b |= 3;
1.67      nicm     1062:
                   1063:                /*
                   1064:                 * Some terminals (like PuTTY 0.63) mistakenly send
                   1065:                 * button-release events for scroll-wheel button-press event.
                   1066:                 * Discard it before it reaches any program running inside
                   1067:                 * tmux.
                   1068:                 */
1.72      nicm     1069:                if (sgr_type == 'm' && (sgr_b & 64))
1.67      nicm     1070:                    return (-2);
1.55      nicm     1071:        } else
1.22      nicm     1072:                return (-1);
1.45      nicm     1073:
1.72      nicm     1074:        /* Fill mouse event. */
1.111     nicm     1075:        m->lx = tty->mouse_last_x;
1.61      nicm     1076:        m->x = x;
1.111     nicm     1077:        m->ly = tty->mouse_last_y;
1.61      nicm     1078:        m->y = y;
1.114     nicm     1079:        m->lb = tty->mouse_last_b;
1.72      nicm     1080:        m->b = b;
                   1081:        m->sgr_type = sgr_type;
                   1082:        m->sgr_b = sgr_b;
1.111     nicm     1083:
                   1084:        /* Update last mouse state. */
                   1085:        tty->mouse_last_x = x;
                   1086:        tty->mouse_last_y = y;
1.114     nicm     1087:        tty->mouse_last_b = b;
1.104     nicm     1088:
                   1089:        return (0);
                   1090: }
                   1091:
                   1092: /*
                   1093:  * Handle OSC 52 clipboard input. Returns 0 for success, -1 for failure, 1 for
                   1094:  * partial.
                   1095:  */
                   1096: static int
                   1097: tty_keys_clipboard(__unused struct tty *tty, const char *buf, size_t len,
                   1098:     size_t *size)
                   1099: {
                   1100:        size_t   end, terminator, needed;
                   1101:        char    *copy, *out;
                   1102:        int      outlen;
                   1103:
                   1104:        *size = 0;
                   1105:
1.128     nicm     1106:        /* First five bytes are always \033]52;. */
1.104     nicm     1107:        if (buf[0] != '\033')
                   1108:                return (-1);
                   1109:        if (len == 1)
                   1110:                return (1);
                   1111:        if (buf[1] != ']')
                   1112:                return (-1);
                   1113:        if (len == 2)
                   1114:                return (1);
                   1115:        if (buf[2] != '5')
                   1116:                return (-1);
                   1117:        if (len == 3)
                   1118:                return (1);
                   1119:        if (buf[3] != '2')
                   1120:                return (-1);
                   1121:        if (len == 4)
                   1122:                return (1);
                   1123:        if (buf[4] != ';')
                   1124:                return (-1);
                   1125:        if (len == 5)
                   1126:                return (1);
                   1127:
                   1128:        /* Find the terminator if any. */
                   1129:        for (end = 5; end < len; end++) {
                   1130:                if (buf[end] == '\007') {
                   1131:                        terminator = 1;
                   1132:                        break;
                   1133:                }
                   1134:                if (end > 5 && buf[end - 1] == '\033' && buf[end] == '\\') {
                   1135:                        terminator = 2;
                   1136:                        break;
                   1137:                }
                   1138:        }
                   1139:        if (end == len)
                   1140:                return (1);
                   1141:        *size = end + terminator;
                   1142:
                   1143:        /* Skip the initial part. */
                   1144:        buf += 5;
                   1145:        end -= 5;
                   1146:
                   1147:        /* Get the second argument. */
                   1148:        while (end != 0 && *buf != ';') {
                   1149:                buf++;
                   1150:                end--;
                   1151:        }
                   1152:        if (end == 0 || end == 1)
                   1153:                return (0);
                   1154:        buf++;
                   1155:        end--;
                   1156:
                   1157:        /* It has to be a string so copy it. */
                   1158:        copy = xmalloc(end + 1);
                   1159:        memcpy(copy, buf, end);
                   1160:        copy[end] = '\0';
                   1161:
                   1162:        /* Convert from base64. */
                   1163:        needed = (end / 4) * 3;
                   1164:        out = xmalloc(needed);
                   1165:        if ((outlen = b64_pton(copy, out, len)) == -1) {
                   1166:                free(out);
                   1167:                free(copy);
                   1168:                return (0);
                   1169:        }
                   1170:        free(copy);
                   1171:
                   1172:        /* Create a new paste buffer. */
                   1173:        log_debug("%s: %.*s", __func__, outlen, out);
1.108     nicm     1174:        paste_add(NULL, out, outlen);
1.91      nicm     1175:
                   1176:        return (0);
                   1177: }
                   1178:
                   1179: /*
1.124     nicm     1180:  * Handle secondary device attributes input. Returns 0 for success, -1 for
                   1181:  * failure, 1 for partial.
1.91      nicm     1182:  */
                   1183: static int
                   1184: tty_keys_device_attributes(struct tty *tty, const char *buf, size_t len,
                   1185:     size_t *size)
                   1186: {
1.118     nicm     1187:        struct client   *c = tty->client;
                   1188:        u_int            i, n = 0;
                   1189:        char             tmp[64], *endptr, p[32] = { 0 }, *cp, *next;
1.91      nicm     1190:
                   1191:        *size = 0;
1.120     nicm     1192:        if (tty->flags & TTY_HAVEDA)
                   1193:                return (-1);
1.91      nicm     1194:
                   1195:        /* First three bytes are always \033[?. */
                   1196:        if (buf[0] != '\033')
                   1197:                return (-1);
                   1198:        if (len == 1)
                   1199:                return (1);
                   1200:        if (buf[1] != '[')
                   1201:                return (-1);
                   1202:        if (len == 2)
                   1203:                return (1);
1.124     nicm     1204:        if (buf[2] != '>')
1.91      nicm     1205:                return (-1);
                   1206:        if (len == 3)
                   1207:                return (1);
                   1208:
                   1209:        /* Copy the rest up to a 'c'. */
1.128     nicm     1210:        for (i = 0; i < (sizeof tmp) - 1; i++) {
1.91      nicm     1211:                if (3 + i == len)
                   1212:                        return (1);
1.128     nicm     1213:                if (buf[3 + i] == 'c')
                   1214:                        break;
1.91      nicm     1215:                tmp[i] = buf[3 + i];
                   1216:        }
                   1217:        if (i == (sizeof tmp) - 1)
                   1218:                return (-1);
                   1219:        tmp[i] = '\0';
                   1220:        *size = 4 + i;
                   1221:
1.124     nicm     1222:        /* Convert all arguments to numbers. */
1.116     nicm     1223:        cp = tmp;
                   1224:        while ((next = strsep(&cp, ";")) != NULL) {
                   1225:                p[n] = strtoul(next, &endptr, 10);
1.117     nicm     1226:                if (*endptr != '\0')
1.116     nicm     1227:                        p[n] = 0;
                   1228:                n++;
                   1229:        }
1.91      nicm     1230:
1.126     nicm     1231:        /* Add terminal features. */
1.116     nicm     1232:        switch (p[0]) {
1.124     nicm     1233:        case 41: /* VT420 */
1.131     nicm     1234:                tty_add_features(&c->term_features, "margins,rectfill", ",");
1.91      nicm     1235:                break;
1.124     nicm     1236:        case 'M': /* mintty */
1.130     nicm     1237:                tty_default_features(&c->term_features, "mintty", 0);
1.124     nicm     1238:                break;
1.126     nicm     1239:        case 'T': /* tmux */
1.130     nicm     1240:                tty_default_features(&c->term_features, "tmux", 0);
1.124     nicm     1241:                break;
                   1242:        case 'U': /* rxvt-unicode */
1.130     nicm     1243:                tty_default_features(&c->term_features, "rxvt-unicode", 0);
1.124     nicm     1244:                break;
1.91      nicm     1245:        }
1.124     nicm     1246:        log_debug("%s: received secondary DA %.*s", c->name, (int)*size, buf);
1.120     nicm     1247:
1.126     nicm     1248:        tty_update_features(tty);
1.120     nicm     1249:        tty->flags |= TTY_HAVEDA;
                   1250:
1.119     nicm     1251:        return (0);
                   1252: }
                   1253:
                   1254: /*
1.128     nicm     1255:  * Handle extended device attributes input. Returns 0 for success, -1 for
                   1256:  * failure, 1 for partial.
1.119     nicm     1257:  */
                   1258: static int
1.128     nicm     1259: tty_keys_extended_device_attributes(struct tty *tty, const char *buf,
                   1260:     size_t len, size_t *size)
1.119     nicm     1261: {
                   1262:        struct client   *c = tty->client;
                   1263:        u_int            i;
1.130     nicm     1264:        char             tmp[128];
1.119     nicm     1265:
                   1266:        *size = 0;
1.128     nicm     1267:        if (tty->flags & TTY_HAVEXDA)
1.120     nicm     1268:                return (-1);
1.119     nicm     1269:
1.128     nicm     1270:        /* First four bytes are always \033P>|. */
1.119     nicm     1271:        if (buf[0] != '\033')
                   1272:                return (-1);
                   1273:        if (len == 1)
                   1274:                return (1);
1.128     nicm     1275:        if (buf[1] != 'P')
1.119     nicm     1276:                return (-1);
                   1277:        if (len == 2)
                   1278:                return (1);
1.128     nicm     1279:        if (buf[2] != '>')
1.120     nicm     1280:                return (-1);
                   1281:        if (len == 3)
                   1282:                return (1);
1.128     nicm     1283:        if (buf[3] != '|')
                   1284:                return (-1);
                   1285:        if (len == 4)
                   1286:                return (1);
1.119     nicm     1287:
1.128     nicm     1288:        /* Copy the rest up to a '\033\\'. */
                   1289:        for (i = 0; i < (sizeof tmp) - 1; i++) {
                   1290:                if (4 + i == len)
1.119     nicm     1291:                        return (1);
1.128     nicm     1292:                if (buf[4 + i - 1] == '\033' && buf[4 + i] == '\\')
                   1293:                        break;
                   1294:                tmp[i] = buf[4 + i];
1.119     nicm     1295:        }
                   1296:        if (i == (sizeof tmp) - 1)
                   1297:                return (-1);
1.128     nicm     1298:        tmp[i - 1] = '\0';
                   1299:        *size = 5 + i;
1.119     nicm     1300:
1.126     nicm     1301:        /* Add terminal features. */
1.130     nicm     1302:        if (strncmp(tmp, "iTerm2 ", 7) == 0)
                   1303:                tty_default_features(&c->term_features, "iTerm2", 0);
                   1304:        else if (strncmp(tmp, "tmux ", 5) == 0)
                   1305:                tty_default_features(&c->term_features, "tmux", 0);
                   1306:        else if (strncmp(tmp, "XTerm(", 6) == 0)
1.136     nicm     1307:                tty_default_features(&c->term_features, "XTerm", 0);
1.130     nicm     1308:        else if (strncmp(tmp, "mintty ", 7) == 0)
                   1309:                tty_default_features(&c->term_features, "mintty", 0);
1.128     nicm     1310:        log_debug("%s: received extended DA %.*s", c->name, (int)*size, buf);
1.130     nicm     1311:
                   1312:        free(c->term_type);
                   1313:        c->term_type = xstrdup(tmp);
1.120     nicm     1314:
1.126     nicm     1315:        tty_update_features(tty);
1.128     nicm     1316:        tty->flags |= TTY_HAVEXDA;
1.120     nicm     1317:
1.22      nicm     1318:        return (0);
1.1       nicm     1319: }