[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.19

1.19    ! nicm        1: /* $OpenBSD: tty-keys.c,v 1.18 2009/11/09 11:45:10 nicm Exp $ */
1.1       nicm        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: #include <sys/time.h>
                     21:
                     22: #include <string.h>
1.3       nicm       23: #include <termios.h>
                     24: #include <unistd.h>
1.1       nicm       25:
                     26: #include "tmux.h"
                     27:
1.9       nicm       28: /*
1.16      nicm       29:  * Handle keys input from the outside terminal. tty_keys[] is a base table of
                     30:  * supported keys which are looked up in terminfo(5) and translated into a
                     31:  * ternary tree (a binary tree of binary trees).
1.9       nicm       32:  */
                     33:
1.16      nicm       34: void           tty_keys_add1(struct tty_key **, const char *, int);
                     35: void           tty_keys_add(struct tty *, const char *, int);
                     36: void           tty_keys_free1(struct tty_key *);
                     37: struct tty_key *tty_keys_find1(
                     38:                    struct tty_key *, const char *, size_t, size_t *);
                     39: struct tty_key *tty_keys_find(struct tty *, const char *, size_t, size_t *);
                     40: void           tty_keys_callback(int, short, void *);
1.18      nicm       41: int            tty_keys_mouse(
                     42:                    const char *, size_t, size_t *, struct mouse_event *);
1.1       nicm       43:
                     44: struct tty_key_ent {
                     45:        enum tty_code_code      code;
                     46:        const char             *string;
                     47:
                     48:        int                     key;
                     49:        int                     flags;
1.15      nicm       50: #define TTYKEY_CTRL 0x1
                     51: #define TTYKEY_RAW 0x2
1.1       nicm       52: };
                     53:
1.16      nicm       54: /*
                     55:  * Default key tables. Those flagged with TTYKEY_RAW are inserted directly,
                     56:  * otherwise they are looked up in terminfo(5). Any keys marked TTYKEY_CTRL
                     57:  * have their last byte twiddled and are inserted as a Ctrl key as well.
                     58:  */
1.1       nicm       59: struct tty_key_ent tty_keys[] = {
                     60:        /* Function keys. */
1.8       nicm       61:        { TTYC_KF1,     NULL,           KEYC_F1,                TTYKEY_CTRL },
                     62:        { TTYC_KF1,     NULL,           KEYC_F1,                TTYKEY_CTRL },
                     63:        { TTYC_KF2,     NULL,           KEYC_F2,                TTYKEY_CTRL },
                     64:        { TTYC_KF3,     NULL,           KEYC_F3,                TTYKEY_CTRL },
                     65:        { TTYC_KF4,     NULL,           KEYC_F4,                TTYKEY_CTRL },
                     66:        { TTYC_KF5,     NULL,           KEYC_F5,                TTYKEY_CTRL },
                     67:        { TTYC_KF6,     NULL,           KEYC_F6,                TTYKEY_CTRL },
                     68:        { TTYC_KF7,     NULL,           KEYC_F7,                TTYKEY_CTRL },
                     69:        { TTYC_KF8,     NULL,           KEYC_F8,                TTYKEY_CTRL },
                     70:        { TTYC_KF9,     NULL,           KEYC_F9,                TTYKEY_CTRL },
                     71:        { TTYC_KF10,    NULL,           KEYC_F10,               TTYKEY_CTRL },
                     72:        { TTYC_KF11,    NULL,           KEYC_F11,               TTYKEY_CTRL },
                     73:        { TTYC_KF12,    NULL,           KEYC_F12,               TTYKEY_CTRL },
                     74:        { TTYC_KF13,    NULL,           KEYC_F13,               TTYKEY_CTRL },
                     75:        { TTYC_KF14,    NULL,           KEYC_F14,               TTYKEY_CTRL },
                     76:        { TTYC_KF15,    NULL,           KEYC_F15,               TTYKEY_CTRL },
                     77:        { TTYC_KF16,    NULL,           KEYC_F16,               TTYKEY_CTRL },
                     78:        { TTYC_KF17,    NULL,           KEYC_F17,               TTYKEY_CTRL },
                     79:        { TTYC_KF18,    NULL,           KEYC_F18,               TTYKEY_CTRL },
                     80:        { TTYC_KF19,    NULL,           KEYC_F19,               TTYKEY_CTRL },
                     81:        { TTYC_KF20,    NULL,           KEYC_F20,               TTYKEY_CTRL },
                     82:        { TTYC_KICH1,   NULL,           KEYC_IC,                TTYKEY_CTRL },
                     83:        { TTYC_KDCH1,   NULL,           KEYC_DC,                TTYKEY_CTRL },
                     84:        { TTYC_KHOME,   NULL,           KEYC_HOME,              TTYKEY_CTRL },
                     85:        { TTYC_KEND,    NULL,           KEYC_END,               TTYKEY_CTRL },
                     86:        { TTYC_KNP,     NULL,           KEYC_NPAGE,             TTYKEY_CTRL },
                     87:        { TTYC_KPP,     NULL,           KEYC_PPAGE,             TTYKEY_CTRL },
                     88:        { TTYC_KCBT,    NULL,           KEYC_BTAB,              TTYKEY_CTRL },
1.1       nicm       89:
1.12      nicm       90:        /* Arrow keys. */
1.8       nicm       91:        { 0,            "\033OA",       KEYC_UP,                TTYKEY_RAW },
                     92:        { 0,            "\033OB",       KEYC_DOWN,              TTYKEY_RAW },
                     93:        { 0,            "\033OC",       KEYC_RIGHT,             TTYKEY_RAW },
                     94:        { 0,            "\033OD",       KEYC_LEFT,              TTYKEY_RAW },
                     95:
1.12      nicm       96:        { 0,            "\033[A",       KEYC_UP,                TTYKEY_RAW },
                     97:        { 0,            "\033[B",       KEYC_DOWN,              TTYKEY_RAW },
                     98:        { 0,            "\033[C",       KEYC_RIGHT,             TTYKEY_RAW },
                     99:        { 0,            "\033[D",       KEYC_LEFT,              TTYKEY_RAW },
1.8       nicm      100:
1.12      nicm      101:        { TTYC_KCUU1,   NULL,           KEYC_UP,                TTYKEY_CTRL },
                    102:        { TTYC_KCUD1,   NULL,           KEYC_DOWN,              TTYKEY_CTRL },
                    103:        { TTYC_KCUB1,   NULL,           KEYC_LEFT,              TTYKEY_CTRL },
                    104:        { TTYC_KCUF1,   NULL,           KEYC_RIGHT,             TTYKEY_CTRL },
                    105:
                    106:        /* Special-case arrow keys for rxvt until terminfo has kRIT5 etc. */
1.8       nicm      107:        { 0,            "\033Oa",       KEYC_UP|KEYC_CTRL,      TTYKEY_RAW },
                    108:        { 0,            "\033Ob",       KEYC_DOWN|KEYC_CTRL,    TTYKEY_RAW },
                    109:        { 0,            "\033Oc",       KEYC_RIGHT|KEYC_CTRL,   TTYKEY_RAW },
                    110:        { 0,            "\033Od",       KEYC_LEFT|KEYC_CTRL,    TTYKEY_RAW },
1.9       nicm      111:
1.8       nicm      112:        { 0,            "\033[a",       KEYC_UP|KEYC_SHIFT,     TTYKEY_RAW },
                    113:        { 0,            "\033[b",       KEYC_DOWN|KEYC_SHIFT,   TTYKEY_RAW },
                    114:        { 0,            "\033[c",       KEYC_RIGHT|KEYC_SHIFT,  TTYKEY_RAW },
                    115:        { 0,            "\033[d",       KEYC_LEFT|KEYC_SHIFT,   TTYKEY_RAW },
1.1       nicm      116:
                    117:        /*
1.8       nicm      118:         * Numeric keypad. Just use the vt100 escape sequences here and always
                    119:         * put the terminal into keypad_xmit mode. Translation of numbers
                    120:         * mode/applications mode is done in input-keys.c.
1.1       nicm      121:         */
1.8       nicm      122:        { 0,            "\033Oo",       KEYC_KP_SLASH,          TTYKEY_RAW },
                    123:        { 0,            "\033Oj",       KEYC_KP_STAR,           TTYKEY_RAW },
                    124:        { 0,            "\033Om",       KEYC_KP_MINUS,          TTYKEY_RAW },
                    125:        { 0,            "\033Ow",       KEYC_KP_SEVEN,          TTYKEY_RAW },
                    126:        { 0,            "\033Ox",       KEYC_KP_EIGHT,          TTYKEY_RAW },
                    127:        { 0,            "\033Oy",       KEYC_KP_NINE,           TTYKEY_RAW },
                    128:        { 0,            "\033Ok",       KEYC_KP_PLUS,           TTYKEY_RAW },
                    129:        { 0,            "\033Ot",       KEYC_KP_FOUR,           TTYKEY_RAW },
                    130:        { 0,            "\033Ou",       KEYC_KP_FIVE,           TTYKEY_RAW },
                    131:        { 0,            "\033Ov",       KEYC_KP_SIX,            TTYKEY_RAW },
                    132:        { 0,            "\033Oq",       KEYC_KP_ONE,            TTYKEY_RAW },
                    133:        { 0,            "\033Or",       KEYC_KP_TWO,            TTYKEY_RAW },
                    134:        { 0,            "\033Os",       KEYC_KP_THREE,          TTYKEY_RAW },
                    135:        { 0,            "\033OM",       KEYC_KP_ENTER,          TTYKEY_RAW },
                    136:        { 0,            "\033Op",       KEYC_KP_ZERO,           TTYKEY_RAW },
                    137:        { 0,            "\033On",       KEYC_KP_PERIOD,         TTYKEY_RAW },
1.10      nicm      138:
                    139:        /* Key and modifier capabilities. */
                    140:        { TTYC_KDC2,    NULL,           KEYC_DC|KEYC_SHIFT,     0 },
                    141:        { TTYC_KDC3,    NULL,           KEYC_DC|KEYC_ESCAPE,    0 },
                    142:        { TTYC_KDC4,    NULL,           KEYC_DC|KEYC_SHIFT|KEYC_ESCAPE, 0 },
                    143:        { TTYC_KDC5,    NULL,           KEYC_DC|KEYC_CTRL,      0 },
                    144:        { TTYC_KDC6,    NULL,           KEYC_DC|KEYC_SHIFT|KEYC_CTRL, 0 },
                    145:        { TTYC_KDC7,    NULL,           KEYC_DC|KEYC_ESCAPE|KEYC_CTRL, 0 },
                    146:        { TTYC_KDN2,    NULL,           KEYC_DOWN|KEYC_SHIFT,   0 },
                    147:        { TTYC_KDN3,    NULL,           KEYC_DOWN|KEYC_ESCAPE,  0 },
                    148:        { TTYC_KDN4,    NULL,           KEYC_DOWN|KEYC_SHIFT|KEYC_ESCAPE, 0 },
                    149:        { TTYC_KDN5,    NULL,           KEYC_DOWN|KEYC_CTRL,    0 },
                    150:        { TTYC_KDN6,    NULL,           KEYC_DOWN|KEYC_SHIFT|KEYC_CTRL, 0 },
                    151:        { TTYC_KDN7,    NULL,           KEYC_DOWN|KEYC_ESCAPE|KEYC_CTRL, 0 },
                    152:        { TTYC_KEND2,   NULL,           KEYC_END|KEYC_SHIFT,    0 },
                    153:        { TTYC_KEND3,   NULL,           KEYC_END|KEYC_ESCAPE,   0 },
                    154:        { TTYC_KEND4,   NULL,           KEYC_END|KEYC_SHIFT|KEYC_ESCAPE, 0 },
                    155:        { TTYC_KEND5,   NULL,           KEYC_END|KEYC_CTRL,     0 },
                    156:        { TTYC_KEND6,   NULL,           KEYC_END|KEYC_SHIFT|KEYC_CTRL, 0 },
                    157:        { TTYC_KEND7,   NULL,           KEYC_END|KEYC_ESCAPE|KEYC_CTRL, 0 },
                    158:        { TTYC_KHOM2,   NULL,           KEYC_HOME|KEYC_SHIFT,   0 },
                    159:        { TTYC_KHOM3,   NULL,           KEYC_HOME|KEYC_ESCAPE,  0 },
                    160:        { TTYC_KHOM4,   NULL,           KEYC_HOME|KEYC_SHIFT|KEYC_ESCAPE, 0 },
                    161:        { TTYC_KHOM5,   NULL,           KEYC_HOME|KEYC_CTRL,    0 },
                    162:        { TTYC_KHOM6,   NULL,           KEYC_HOME|KEYC_SHIFT|KEYC_CTRL, 0 },
                    163:        { TTYC_KHOM7,   NULL,           KEYC_HOME|KEYC_ESCAPE|KEYC_CTRL, 0 },
                    164:        { TTYC_KIC2,    NULL,           KEYC_IC|KEYC_SHIFT,     0 },
                    165:        { TTYC_KIC3,    NULL,           KEYC_IC|KEYC_ESCAPE,    0 },
                    166:        { TTYC_KIC4,    NULL,           KEYC_IC|KEYC_SHIFT|KEYC_ESCAPE, 0 },
                    167:        { TTYC_KIC5,    NULL,           KEYC_IC|KEYC_CTRL,      0 },
                    168:        { TTYC_KIC6,    NULL,           KEYC_IC|KEYC_SHIFT|KEYC_CTRL, 0 },
                    169:        { TTYC_KIC7,    NULL,           KEYC_IC|KEYC_ESCAPE|KEYC_CTRL, 0 },
                    170:        { TTYC_KLFT2,   NULL,           KEYC_LEFT|KEYC_SHIFT,   0 },
                    171:        { TTYC_KLFT3,   NULL,           KEYC_LEFT|KEYC_ESCAPE,  0 },
                    172:        { TTYC_KLFT4,   NULL,           KEYC_LEFT|KEYC_SHIFT|KEYC_ESCAPE, 0 },
                    173:        { TTYC_KLFT5,   NULL,           KEYC_LEFT|KEYC_CTRL,    0 },
                    174:        { TTYC_KLFT6,   NULL,           KEYC_LEFT|KEYC_SHIFT|KEYC_CTRL, 0 },
                    175:        { TTYC_KLFT7,   NULL,           KEYC_LEFT|KEYC_ESCAPE|KEYC_CTRL, 0 },
                    176:        { TTYC_KNXT2,   NULL,           KEYC_NPAGE|KEYC_SHIFT,  0 },
                    177:        { TTYC_KNXT3,   NULL,           KEYC_NPAGE|KEYC_ESCAPE, 0 },
                    178:        { TTYC_KNXT4,   NULL,           KEYC_NPAGE|KEYC_SHIFT|KEYC_ESCAPE, 0 },
                    179:        { TTYC_KNXT5,   NULL,           KEYC_NPAGE|KEYC_CTRL,   0 },
                    180:        { TTYC_KNXT6,   NULL,           KEYC_NPAGE|KEYC_SHIFT|KEYC_CTRL, 0 },
                    181:        { TTYC_KNXT7,   NULL,           KEYC_NPAGE|KEYC_ESCAPE|KEYC_CTRL, 0 },
                    182:        { TTYC_KPRV2,   NULL,           KEYC_PPAGE|KEYC_SHIFT,  0 },
                    183:        { TTYC_KPRV3,   NULL,           KEYC_PPAGE|KEYC_ESCAPE, 0 },
                    184:        { TTYC_KPRV4,   NULL,           KEYC_PPAGE|KEYC_SHIFT|KEYC_ESCAPE, 0 },
                    185:        { TTYC_KPRV5,   NULL,           KEYC_PPAGE|KEYC_CTRL,   0 },
                    186:        { TTYC_KPRV6,   NULL,           KEYC_PPAGE|KEYC_SHIFT|KEYC_CTRL, 0 },
                    187:        { TTYC_KPRV7,   NULL,           KEYC_PPAGE|KEYC_ESCAPE|KEYC_CTRL, 0 },
                    188:        { TTYC_KRIT2,   NULL,           KEYC_RIGHT|KEYC_SHIFT,  0 },
                    189:        { TTYC_KRIT3,   NULL,           KEYC_RIGHT|KEYC_ESCAPE, 0 },
                    190:        { TTYC_KRIT4,   NULL,           KEYC_RIGHT|KEYC_SHIFT|KEYC_ESCAPE, 0 },
                    191:        { TTYC_KRIT5,   NULL,           KEYC_RIGHT|KEYC_CTRL,   0 },
                    192:        { TTYC_KRIT6,   NULL,           KEYC_RIGHT|KEYC_SHIFT|KEYC_CTRL, 0 },
                    193:        { TTYC_KRIT7,   NULL,           KEYC_RIGHT|KEYC_ESCAPE|KEYC_CTRL, 0 },
                    194:        { TTYC_KUP2,    NULL,           KEYC_UP|KEYC_SHIFT,     0 },
                    195:        { TTYC_KUP3,    NULL,           KEYC_UP|KEYC_ESCAPE,    0 },
                    196:        { TTYC_KUP4,    NULL,           KEYC_UP|KEYC_SHIFT|KEYC_ESCAPE, 0 },
                    197:        { TTYC_KUP5,    NULL,           KEYC_UP|KEYC_CTRL,      0 },
                    198:        { TTYC_KUP6,    NULL,           KEYC_UP|KEYC_SHIFT|KEYC_CTRL, 0 },
                    199:        { TTYC_KUP7,    NULL,           KEYC_UP|KEYC_ESCAPE|KEYC_CTRL, 0 },
1.1       nicm      200: };
                    201:
1.16      nicm      202: void
                    203: tty_keys_add(struct tty *tty, const char *s, int key)
                    204: {
                    205:        size_t  size;
1.1       nicm      206:
1.16      nicm      207:        if (tty_keys_find(tty, s, strlen(s), &size) == NULL) {
                    208:                log_debug("new key 0x%x: %s", key, s);
                    209:                tty_keys_add1(&tty->key_tree, s, key);
                    210:        }
1.1       nicm      211: }
                    212:
1.16      nicm      213: /* Add next node to the tree. */
1.1       nicm      214: void
1.16      nicm      215: tty_keys_add1(struct tty_key **tkp, const char *s, int key)
1.1       nicm      216: {
1.16      nicm      217:        struct tty_key  *tk;
1.1       nicm      218:
1.16      nicm      219:        /* Allocate a tree entry if there isn't one already. */
                    220:        tk = *tkp;
                    221:        if (tk == NULL) {
                    222:                tk = *tkp = xcalloc(1, sizeof *tk);
                    223:                tk->ch = *s;
                    224:                tk->key = KEYC_NONE;
                    225:        }
                    226:
                    227:        /* Find the next entry. */
                    228:        if (*s == tk->ch) {
                    229:                /* Move forward in string. */
                    230:                s++;
                    231:
                    232:                /* If this is the end of the string, no more is necessary. */
                    233:                if (*s == '\0') {
                    234:                        tk->key = key;
                    235:                        return;
                    236:                }
                    237:
                    238:                /* Use the child tree for the next character. */
                    239:                tkp = &tk->next;
                    240:        } else {
                    241:                if (*s < tk->ch)
                    242:                        tkp = &tk->left;
                    243:                else if (*s > tk->ch)
                    244:                        tkp = &tk->right;
                    245:        }
                    246:
                    247:        /* And recurse to add it. */
                    248:        tty_keys_add1(tkp, s, key);
1.1       nicm      249: }
                    250:
1.16      nicm      251: /* Initialise a key tree from the table. */
1.1       nicm      252: void
                    253: tty_keys_init(struct tty *tty)
                    254: {
                    255:        struct tty_key_ent      *tke;
                    256:        u_int                    i;
                    257:        const char              *s;
                    258:        char                     tmp[64];
                    259:
1.16      nicm      260:        tty->key_tree = NULL;
1.1       nicm      261:        for (i = 0; i < nitems(tty_keys); i++) {
                    262:                tke = &tty_keys[i];
                    263:
                    264:                if (tke->flags & TTYKEY_RAW)
                    265:                        s = tke->string;
                    266:                else {
                    267:                        if (!tty_term_has(tty->term, tke->code))
                    268:                                continue;
                    269:                        s = tty_term_string(tty->term, tke->code);
                    270:                }
1.16      nicm      271:                if (s[0] != '\033' || s[1] == '\0')
                    272:                        continue;
1.1       nicm      273:
1.15      nicm      274:                tty_keys_add(tty, s + 1, tke->key);
1.16      nicm      275:                if (!(tke->flags & TTYKEY_CTRL)) {
1.1       nicm      276:                        if (strlcpy(tmp, s, sizeof tmp) >= sizeof tmp)
                    277:                                continue;
                    278:                        tmp[strlen(tmp) - 1] ^= 0x20;
1.15      nicm      279:                        tty_keys_add(tty, tmp + 1, tke->key | KEYC_CTRL);
1.1       nicm      280:                }
                    281:        }
                    282: }
                    283:
1.16      nicm      284: /* Free the entire key tree. */
1.1       nicm      285: void
                    286: tty_keys_free(struct tty *tty)
                    287: {
1.16      nicm      288:        tty_keys_free1(tty->key_tree);
                    289: }
1.1       nicm      290:
1.16      nicm      291: /* Free a single key. */
                    292: void
                    293: tty_keys_free1(struct tty_key *tk)
                    294: {
                    295:        if (tk->next != NULL)
                    296:                tty_keys_free1(tk->next);
                    297:        if (tk->left != NULL)
                    298:                tty_keys_free1(tk->left);
                    299:        if (tk->right != NULL)
                    300:                tty_keys_free1(tk->right);
                    301:        xfree(tk);
                    302:
1.1       nicm      303: }
                    304:
1.16      nicm      305: /* Lookup a key in the tree. */
1.1       nicm      306: struct tty_key *
1.16      nicm      307: tty_keys_find(struct tty *tty, const char *buf, size_t len, size_t *size)
1.1       nicm      308: {
1.16      nicm      309:        *size = 0;
                    310:        return (tty_keys_find1(tty->key_tree, buf, len, size));
                    311: }
1.1       nicm      312:
1.16      nicm      313: /* Find the next node. */
                    314: struct tty_key *
                    315: tty_keys_find1(struct tty_key *tk, const char *buf, size_t len, size_t *size)
                    316: {
                    317:        /* If the node is NULL, this is the end of the tree. No match. */
                    318:        if (tk == NULL)
1.1       nicm      319:                return (NULL);
                    320:
1.16      nicm      321:        /* Pick the next in the sequence. */
                    322:        if (tk->ch == *buf) {
                    323:                /* Move forward in the string. */
                    324:                buf++; len--;
                    325:                (*size)++;
1.1       nicm      326:
1.16      nicm      327:                /* At the end of the string, return the current node. */
                    328:                if (len == 0)
                    329:                        return (tk);
1.1       nicm      330:
1.16      nicm      331:                /* Move into the next tree for the following character. */
                    332:                tk = tk->next;
                    333:        } else {
                    334:                if (*buf < tk->ch)
                    335:                        tk = tk->left;
                    336:                else if (*buf > tk->ch)
                    337:                        tk = tk->right;
1.1       nicm      338:        }
                    339:
1.16      nicm      340:        /* Move to the next in the tree. */
                    341:        return (tty_keys_find1(tk, buf, len, size));
1.1       nicm      342: }
                    343:
1.16      nicm      344: /*
                    345:  * Process at least one key in the buffer and invoke tty->key_callback. Return
                    346:  * 1 if there are no further keys, or 0 if there is more in the buffer.
                    347:  */
1.1       nicm      348: int
1.14      nicm      349: tty_keys_next(struct tty *tty)
1.1       nicm      350: {
1.14      nicm      351:        struct tty_key          *tk;
                    352:        struct timeval           tv;
                    353:        struct mouse_event       mouse;
1.18      nicm      354:        const char              *buf;
1.14      nicm      355:        size_t                   len, size;
                    356:        cc_t                     bspace;
                    357:        int                      key;
1.1       nicm      358:
1.13      nicm      359:        buf = EVBUFFER_DATA(tty->event->input);
                    360:        len = EVBUFFER_LENGTH(tty->event->input);
1.1       nicm      361:        if (len == 0)
1.14      nicm      362:                return (0);
1.1       nicm      363:        log_debug("keys are %zu (%.*s)", len, (int) len, buf);
                    364:
                    365:        /* If a normal key, return it. */
                    366:        if (*buf != '\033') {
1.19    ! nicm      367:                key = (u_char) *buf;
1.16      nicm      368:                evbuffer_drain(tty->event->input, 1);
1.3       nicm      369:
                    370:                /*
                    371:                 * Check for backspace key using termios VERASE - the terminfo
                    372:                 * kbs entry is extremely unreliable, so cannot be safely
                    373:                 * used. termios should have a better idea.
                    374:                 */
                    375:                bspace = tty->tio.c_cc[VERASE];
1.14      nicm      376:                if (bspace != _POSIX_VDISABLE && key == bspace)
                    377:                        key = KEYC_BSPACE;
1.16      nicm      378:                goto handle_key;
1.1       nicm      379:        }
                    380:
                    381:        /* Look for matching key string and return if found. */
                    382:        tk = tty_keys_find(tty, buf + 1, len - 1, &size);
                    383:        if (tk != NULL) {
1.14      nicm      384:                key = tk->key;
1.16      nicm      385:                goto found_key;
1.1       nicm      386:        }
                    387:
                    388:        /* Not found. Is this a mouse key press? */
1.14      nicm      389:        key = tty_keys_mouse(buf, len, &size, &mouse);
                    390:        if (key != KEYC_NONE) {
1.13      nicm      391:                evbuffer_drain(tty->event->input, size);
1.16      nicm      392:                goto handle_key;
1.11      nicm      393:        }
                    394:
                    395:        /* Not found. Try to parse a key with an xterm-style modifier. */
1.14      nicm      396:        key = xterm_keys_find(buf, len, &size);
                    397:        if (key != KEYC_NONE) {
1.13      nicm      398:                evbuffer_drain(tty->event->input, size);
1.16      nicm      399:                goto handle_key;
1.1       nicm      400:        }
                    401:
                    402:        /* Skip the escape. */
                    403:        buf++;
                    404:        len--;
                    405:
                    406:        /* Is there a normal key following? */
                    407:        if (len != 0 && *buf != '\033') {
1.16      nicm      408:                key = *buf | KEYC_ESCAPE;
                    409:                evbuffer_drain(tty->event->input, 2);
                    410:                goto handle_key;
1.1       nicm      411:        }
                    412:
                    413:        /* Or a key string? */
                    414:        if (len > 1) {
                    415:                tk = tty_keys_find(tty, buf + 1, len - 1, &size);
                    416:                if (tk != NULL) {
1.14      nicm      417:                        key = tk->key | KEYC_ESCAPE;
1.16      nicm      418:                        size++; /* include escape */
                    419:                        goto found_key;
1.1       nicm      420:                }
                    421:        }
                    422:
1.16      nicm      423:        /* Escape and then nothing useful - fall through. */
                    424:
                    425: partial_key:
1.14      nicm      426:        /*
1.16      nicm      427:         * Escape but no key string. If have already seen an escape, then the
1.14      nicm      428:         * timer must have expired, so give up waiting and send the escape.
                    429:         */
                    430:        if (tty->flags & TTY_ESCAPE) {
                    431:                evbuffer_drain(tty->event->input, 1);
                    432:                key = '\033';
1.16      nicm      433:                goto handle_key;
1.14      nicm      434:        }
                    435:
1.16      nicm      436:        /* Fall through to start the timer. */
                    437:
                    438: start_timer:
1.14      nicm      439:        /* Start the timer and wait for expiry or more data. */
                    440:        tv.tv_sec = 0;
                    441:        tv.tv_usec = ESCAPE_PERIOD * 1000L;
                    442:
                    443:        evtimer_del(&tty->key_timer);
                    444:        evtimer_set(&tty->key_timer, tty_keys_callback, tty);
                    445:        evtimer_add(&tty->key_timer, &tv);
                    446:
                    447:        tty->flags |= TTY_ESCAPE;
                    448:        return (0);
1.1       nicm      449:
1.16      nicm      450: found_key:
                    451:        if (tk->next != NULL) {
                    452:                /* Partial key. Start the timer if not already expired. */
                    453:                if (!(tty->flags & TTY_ESCAPE))
                    454:                        goto start_timer;
                    455:
                    456:                /* Otherwise, if no key, send the escape alone. */
                    457:                if (tk->key == KEYC_NONE)
                    458:                        goto partial_key;
                    459:
                    460:                /* Or fall through to send the partial key found. */
                    461:        }
                    462:        evbuffer_drain(tty->event->input, size + 1);
                    463:
                    464:        goto handle_key;
                    465:
                    466: handle_key:
                    467:        evtimer_del(&tty->key_timer);
                    468:
1.14      nicm      469:        tty->key_callback(key, &mouse, tty->key_data);
1.16      nicm      470:
1.1       nicm      471:        tty->flags &= ~TTY_ESCAPE;
1.14      nicm      472:        return (1);
                    473: }
                    474:
1.16      nicm      475: /* Key timer callback. */
1.14      nicm      476: void
                    477: tty_keys_callback(unused int fd, unused short events, void *data)
                    478: {
                    479:        struct tty      *tty = data;
                    480:
1.16      nicm      481:        if (!(tty->flags & TTY_ESCAPE))
                    482:                return;
                    483:
                    484:        while (tty_keys_next(tty))
                    485:                ;
1.1       nicm      486: }
                    487:
1.16      nicm      488: /* Handle mouse key input. */
1.1       nicm      489: int
1.18      nicm      490: tty_keys_mouse(const char *buf, size_t len, size_t *size, struct mouse_event *m)
1.1       nicm      491: {
                    492:        /*
                    493:         * Mouse sequences are \033[M followed by three characters indicating
                    494:         * buttons, X and Y, all based at 32 with 1,1 top-left.
                    495:         */
                    496:
                    497:        if (len != 6 || memcmp(buf, "\033[M", 3) != 0)
                    498:                return (KEYC_NONE);
                    499:        *size = 6;
1.16      nicm      500:
                    501:        log_debug("mouse input is: %.*s", (int) len, buf);
1.1       nicm      502:
1.5       nicm      503:        m->b = buf[3];
                    504:        m->x = buf[4];
                    505:        m->y = buf[5];
                    506:        if (m->b < 32 || m->x < 33 || m->y < 33)
1.1       nicm      507:                return (KEYC_NONE);
1.5       nicm      508:        m->b -= 32;
                    509:        m->x -= 33;
                    510:        m->y -= 33;
1.1       nicm      511:        return (KEYC_MOUSE);
                    512: }