diff options
Diffstat (limited to 'src/nvim/keycodes.h')
| -rw-r--r-- | src/nvim/keycodes.h | 526 |
1 files changed, 526 insertions, 0 deletions
diff --git a/src/nvim/keycodes.h b/src/nvim/keycodes.h new file mode 100644 index 0000000000..67ec092f60 --- /dev/null +++ b/src/nvim/keycodes.h @@ -0,0 +1,526 @@ +#ifndef NVIM_KEYCODES_H +#define NVIM_KEYCODES_H + +#include "nvim/strings.h" + +// Keycode definitions for special keys. +// +// Any special key code sequences are replaced by these codes. + +// +// For MS-DOS some keys produce codes larger than 0xff. They are split into two +// chars, the first one is K_NUL. +// +#define K_NUL (0xce) // for MS-DOS: special key follows + +/// K_SPECIAL is the first byte of a special key code and is always followed by +/// two bytes. +/// The second byte can have any value. ASCII is used for normal termcap +/// entries, 0x80 and higher for special keys, see below. +/// The third byte is guaranteed to be between 0x02 and 0x7f. +#define K_SPECIAL (0x80) + +/// Positive characters are "normal" characters. +/// Negative characters are special key codes. Only characters below -0x200 +/// are used to so that the absolute value can't be mistaken for a single-byte +/// character. +#define IS_SPECIAL(c) ((c) < 0) + +/// Characters 0x0100 - 0x01ff have a special meaning for abbreviations. +/// Multi-byte characters also have ABBR_OFF added, thus are above 0x0200. +#define ABBR_OFF 0x100 + +/// NUL cannot be in the input string, therefore it is replaced by +/// K_SPECIAL KS_ZERO KE_FILLER +#define KS_ZERO 255 + +/// K_SPECIAL cannot be in the input string, therefore it is replaced by +/// K_SPECIAL KS_SPECIAL KE_FILLER +#define KS_SPECIAL 254 + +/// KS_EXTRA is used for keys that have no termcap name +/// K_SPECIAL KS_EXTRA KE_xxx +#define KS_EXTRA 253 + +/// KS_MODIFIER is used when a modifier is given for a (special) key +/// K_SPECIAL KS_MODIFIER bitmask +#define KS_MODIFIER 252 + +// These are used for the GUI +// K_SPECIAL KS_xxx KE_FILLER + +#define KS_MOUSE 251 +#define KS_MENU 250 +#define KS_VER_SCROLLBAR 249 +#define KS_HOR_SCROLLBAR 248 + +// Used for switching Select mode back on after a mapping or menu. + +#define KS_SELECT 245 +#define K_SELECT_STRING (char_u *)"\200\365X" + +// Used a termcap entry that produces a normal character. +#define KS_KEY 242 + +// Used for click in a tab pages label. +#define KS_TABLINE 240 + +// Used for menu in a tab pages line. +#define KS_TABMENU 239 + +/// Filler used after KS_SPECIAL and others +#define KE_FILLER ('X') + +// translation of three byte code "K_SPECIAL a b" into int "K_xxx" and back + +#define TERMCAP2KEY(a, b) (-((a) + ((int)(b) << 8))) +#define KEY2TERMCAP0(x) ((-(x)) & 0xff) +#define KEY2TERMCAP1(x) (((unsigned)(-(x)) >> 8) & 0xff) + +// get second or third byte when translating special key code into three bytes + +#define K_SECOND(c) ((c) == K_SPECIAL ? KS_SPECIAL : (c) == \ + NUL ? KS_ZERO : KEY2TERMCAP0(c)) + +#define K_THIRD(c) (((c) == K_SPECIAL || (c) == \ + NUL) ? KE_FILLER : KEY2TERMCAP1(c)) + +/// get single int code from second byte after K_SPECIAL +#define TO_SPECIAL(a, b) ((a) == KS_SPECIAL ? K_SPECIAL : (a) == \ + KS_ZERO ? K_ZERO : TERMCAP2KEY(a, b)) + +// Codes for keys that do not have a termcap name. +// The numbers are fixed to make sure that recorded key sequences remain valid. +// Add new entries at the end, not halfway. +// +// K_SPECIAL KS_EXTRA KE_xxx +// +// Entries must be in the range 0x02-0x7f (see comment at K_SPECIAL). +enum key_extra { + KE_S_UP = 4, // shift-up + KE_S_DOWN = 5, // shift-down + + KE_S_F1 = 6, // shifted function keys + KE_S_F2 = 7, + KE_S_F3 = 8, + KE_S_F4 = 9, + KE_S_F5 = 10, + KE_S_F6 = 11, + KE_S_F7 = 12, + KE_S_F8 = 13, + KE_S_F9 = 14, + KE_S_F10 = 15, + + KE_S_F11 = 16, + KE_S_F12 = 17, + KE_S_F13 = 18, + KE_S_F14 = 19, + KE_S_F15 = 20, + KE_S_F16 = 21, + KE_S_F17 = 22, + KE_S_F18 = 23, + KE_S_F19 = 24, + KE_S_F20 = 25, + + KE_S_F21 = 26, + KE_S_F22 = 27, + KE_S_F23 = 28, + KE_S_F24 = 29, + KE_S_F25 = 30, + KE_S_F26 = 31, + KE_S_F27 = 32, + KE_S_F28 = 33, + KE_S_F29 = 34, + KE_S_F30 = 35, + + KE_S_F31 = 36, + KE_S_F32 = 37, + KE_S_F33 = 38, + KE_S_F34 = 39, + KE_S_F35 = 40, + KE_S_F36 = 41, + KE_S_F37 = 42, + + KE_MOUSE = 43, // mouse event start + + // Symbols for pseudo keys which are translated from the real key symbols + // above. + KE_LEFTMOUSE = 44, // Left mouse button click + KE_LEFTDRAG = 45, // Drag with left mouse button down + KE_LEFTRELEASE = 46, // Left mouse button release + KE_MIDDLEMOUSE = 47, // Middle mouse button click + KE_MIDDLEDRAG = 48, // Drag with middle mouse button down + KE_MIDDLERELEASE = 49, // Middle mouse button release + KE_RIGHTMOUSE = 50, // Right mouse button click + KE_RIGHTDRAG = 51, // Drag with right mouse button down + KE_RIGHTRELEASE = 52, // Right mouse button release + + KE_IGNORE = 53, // Ignored mouse drag/release + + KE_TAB = 54, // unshifted TAB key + KE_S_TAB_OLD = 55, // shifted TAB key (no longer used) + + // , KE_SNIFF_UNUSED = 56 // obsolete + KE_XF1 = 57, // extra vt100 function keys for xterm + KE_XF2 = 58, + KE_XF3 = 59, + KE_XF4 = 60, + KE_XEND = 61, // extra (vt100) end key for xterm + KE_ZEND = 62, // extra (vt100) end key for xterm + KE_XHOME = 63, // extra (vt100) home key for xterm + KE_ZHOME = 64, // extra (vt100) home key for xterm + KE_XUP = 65, // extra vt100 cursor keys for xterm + KE_XDOWN = 66, + KE_XLEFT = 67, + KE_XRIGHT = 68, + + KE_LEFTMOUSE_NM = 69, // non-mappable Left mouse button click + KE_LEFTRELEASE_NM = 70, // non-mappable left mouse button release + + KE_S_XF1 = 71, // vt100 shifted function keys for xterm + KE_S_XF2 = 72, + KE_S_XF3 = 73, + KE_S_XF4 = 74, + + // NOTE: The scroll wheel events are inverted: i.e. UP is the same as + // moving the actual scroll wheel down, LEFT is the same as moving the + // scroll wheel right. + KE_MOUSEDOWN = 75, // scroll wheel pseudo-button Down + KE_MOUSEUP = 76, // scroll wheel pseudo-button Up + KE_MOUSELEFT = 77, // scroll wheel pseudo-button Left + KE_MOUSERIGHT = 78, // scroll wheel pseudo-button Right + + KE_KINS = 79, // keypad Insert key + KE_KDEL = 80, // keypad Delete key + + // KE_CSI = 81, // Nvim doesn't need escaping CSI + KE_SNR = 82, // <SNR> + KE_PLUG = 83, // <Plug> + KE_CMDWIN = 84, // open command-line window from Command-line Mode + + KE_C_LEFT = 85, // control-left + KE_C_RIGHT = 86, // control-right + KE_C_HOME = 87, // control-home + KE_C_END = 88, // control-end + + KE_X1MOUSE = 89, // X1/X2 mouse-buttons + KE_X1DRAG = 90, + KE_X1RELEASE = 91, + KE_X2MOUSE = 92, + KE_X2DRAG = 93, + KE_X2RELEASE = 94, + + KE_DROP = 95, // DnD data is available + // , KE_CURSORHOLD = 96 // CursorHold event + KE_NOP = 97, // no-op: does nothing + // , KE_FOCUSGAINED = 98 // focus gained + // , KE_FOCUSLOST = 99 // focus lost + KE_MOUSEMOVE = 100, // mouse moved with no button down + // , KE_CANCEL = 101 // return from vgetc + KE_EVENT = 102, // event + KE_LUA = 103, // lua special key + KE_COMMAND = 104, // <Cmd> special key +}; + +// the three byte codes are replaced with the following int when using vgetc() + +#define K_ZERO TERMCAP2KEY(KS_ZERO, KE_FILLER) + +#define K_UP TERMCAP2KEY('k', 'u') +#define K_KUP TERMCAP2KEY('K', 'u') // keypad up +#define K_DOWN TERMCAP2KEY('k', 'd') +#define K_KDOWN TERMCAP2KEY('K', 'd') // keypad down +#define K_LEFT TERMCAP2KEY('k', 'l') +#define K_KLEFT TERMCAP2KEY('K', 'l') // keypad left +#define K_RIGHT TERMCAP2KEY('k', 'r') +#define K_KRIGHT TERMCAP2KEY('K', 'r') // keypad right +#define K_S_UP TERMCAP2KEY(KS_EXTRA, KE_S_UP) +#define K_S_DOWN TERMCAP2KEY(KS_EXTRA, KE_S_DOWN) +#define K_S_LEFT TERMCAP2KEY('#', '4') +#define K_C_LEFT TERMCAP2KEY(KS_EXTRA, KE_C_LEFT) +#define K_S_RIGHT TERMCAP2KEY('%', 'i') +#define K_C_RIGHT TERMCAP2KEY(KS_EXTRA, KE_C_RIGHT) +#define K_S_HOME TERMCAP2KEY('#', '2') +#define K_C_HOME TERMCAP2KEY(KS_EXTRA, KE_C_HOME) +#define K_S_END TERMCAP2KEY('*', '7') +#define K_C_END TERMCAP2KEY(KS_EXTRA, KE_C_END) +#define K_TAB TERMCAP2KEY(KS_EXTRA, KE_TAB) +#define K_S_TAB TERMCAP2KEY('k', 'B') + +// extra set of function keys F1-F4, for vt100 compatible xterm +#define K_XF1 TERMCAP2KEY(KS_EXTRA, KE_XF1) +#define K_XF2 TERMCAP2KEY(KS_EXTRA, KE_XF2) +#define K_XF3 TERMCAP2KEY(KS_EXTRA, KE_XF3) +#define K_XF4 TERMCAP2KEY(KS_EXTRA, KE_XF4) + +// extra set of cursor keys for vt100 compatible xterm +#define K_XUP TERMCAP2KEY(KS_EXTRA, KE_XUP) +#define K_XDOWN TERMCAP2KEY(KS_EXTRA, KE_XDOWN) +#define K_XLEFT TERMCAP2KEY(KS_EXTRA, KE_XLEFT) +#define K_XRIGHT TERMCAP2KEY(KS_EXTRA, KE_XRIGHT) + +#define K_F1 TERMCAP2KEY('k', '1') // function keys +#define K_F2 TERMCAP2KEY('k', '2') +#define K_F3 TERMCAP2KEY('k', '3') +#define K_F4 TERMCAP2KEY('k', '4') +#define K_F5 TERMCAP2KEY('k', '5') +#define K_F6 TERMCAP2KEY('k', '6') +#define K_F7 TERMCAP2KEY('k', '7') +#define K_F8 TERMCAP2KEY('k', '8') +#define K_F9 TERMCAP2KEY('k', '9') +#define K_F10 TERMCAP2KEY('k', ';') + +#define K_F11 TERMCAP2KEY('F', '1') +#define K_F12 TERMCAP2KEY('F', '2') +#define K_F13 TERMCAP2KEY('F', '3') +#define K_F14 TERMCAP2KEY('F', '4') +#define K_F15 TERMCAP2KEY('F', '5') +#define K_F16 TERMCAP2KEY('F', '6') +#define K_F17 TERMCAP2KEY('F', '7') +#define K_F18 TERMCAP2KEY('F', '8') +#define K_F19 TERMCAP2KEY('F', '9') +#define K_F20 TERMCAP2KEY('F', 'A') + +#define K_F21 TERMCAP2KEY('F', 'B') +#define K_F22 TERMCAP2KEY('F', 'C') +#define K_F23 TERMCAP2KEY('F', 'D') +#define K_F24 TERMCAP2KEY('F', 'E') +#define K_F25 TERMCAP2KEY('F', 'F') +#define K_F26 TERMCAP2KEY('F', 'G') +#define K_F27 TERMCAP2KEY('F', 'H') +#define K_F28 TERMCAP2KEY('F', 'I') +#define K_F29 TERMCAP2KEY('F', 'J') +#define K_F30 TERMCAP2KEY('F', 'K') + +#define K_F31 TERMCAP2KEY('F', 'L') +#define K_F32 TERMCAP2KEY('F', 'M') +#define K_F33 TERMCAP2KEY('F', 'N') +#define K_F34 TERMCAP2KEY('F', 'O') +#define K_F35 TERMCAP2KEY('F', 'P') +#define K_F36 TERMCAP2KEY('F', 'Q') +#define K_F37 TERMCAP2KEY('F', 'R') +#define K_F38 TERMCAP2KEY('F', 'S') +#define K_F39 TERMCAP2KEY('F', 'T') +#define K_F40 TERMCAP2KEY('F', 'U') + +#define K_F41 TERMCAP2KEY('F', 'V') +#define K_F42 TERMCAP2KEY('F', 'W') +#define K_F43 TERMCAP2KEY('F', 'X') +#define K_F44 TERMCAP2KEY('F', 'Y') +#define K_F45 TERMCAP2KEY('F', 'Z') +#define K_F46 TERMCAP2KEY('F', 'a') +#define K_F47 TERMCAP2KEY('F', 'b') +#define K_F48 TERMCAP2KEY('F', 'c') +#define K_F49 TERMCAP2KEY('F', 'd') +#define K_F50 TERMCAP2KEY('F', 'e') + +#define K_F51 TERMCAP2KEY('F', 'f') +#define K_F52 TERMCAP2KEY('F', 'g') +#define K_F53 TERMCAP2KEY('F', 'h') +#define K_F54 TERMCAP2KEY('F', 'i') +#define K_F55 TERMCAP2KEY('F', 'j') +#define K_F56 TERMCAP2KEY('F', 'k') +#define K_F57 TERMCAP2KEY('F', 'l') +#define K_F58 TERMCAP2KEY('F', 'm') +#define K_F59 TERMCAP2KEY('F', 'n') +#define K_F60 TERMCAP2KEY('F', 'o') + +#define K_F61 TERMCAP2KEY('F', 'p') +#define K_F62 TERMCAP2KEY('F', 'q') +#define K_F63 TERMCAP2KEY('F', 'r') + +#define K_F38 TERMCAP2KEY('F', 'S') +#define K_F39 TERMCAP2KEY('F', 'T') +#define K_F40 TERMCAP2KEY('F', 'U') +#define K_F41 TERMCAP2KEY('F', 'V') +#define K_F42 TERMCAP2KEY('F', 'W') +#define K_F43 TERMCAP2KEY('F', 'X') +#define K_F44 TERMCAP2KEY('F', 'Y') +#define K_F45 TERMCAP2KEY('F', 'Z') +#define K_F46 TERMCAP2KEY('F', 'a') +#define K_F47 TERMCAP2KEY('F', 'b') +#define K_F48 TERMCAP2KEY('F', 'c') +#define K_F49 TERMCAP2KEY('F', 'd') +#define K_F50 TERMCAP2KEY('F', 'e') +#define K_F51 TERMCAP2KEY('F', 'f') +#define K_F52 TERMCAP2KEY('F', 'g') +#define K_F53 TERMCAP2KEY('F', 'h') +#define K_F54 TERMCAP2KEY('F', 'i') +#define K_F55 TERMCAP2KEY('F', 'j') +#define K_F56 TERMCAP2KEY('F', 'k') +#define K_F57 TERMCAP2KEY('F', 'l') +#define K_F58 TERMCAP2KEY('F', 'm') +#define K_F59 TERMCAP2KEY('F', 'n') +#define K_F60 TERMCAP2KEY('F', 'o') +#define K_F61 TERMCAP2KEY('F', 'p') +#define K_F62 TERMCAP2KEY('F', 'q') +#define K_F63 TERMCAP2KEY('F', 'r') + +// extra set of shifted function keys F1-F4, for vt100 compatible xterm +#define K_S_XF1 TERMCAP2KEY(KS_EXTRA, KE_S_XF1) +#define K_S_XF2 TERMCAP2KEY(KS_EXTRA, KE_S_XF2) +#define K_S_XF3 TERMCAP2KEY(KS_EXTRA, KE_S_XF3) +#define K_S_XF4 TERMCAP2KEY(KS_EXTRA, KE_S_XF4) + +#define K_S_F1 TERMCAP2KEY(KS_EXTRA, KE_S_F1) // shifted func. keys +#define K_S_F2 TERMCAP2KEY(KS_EXTRA, KE_S_F2) +#define K_S_F3 TERMCAP2KEY(KS_EXTRA, KE_S_F3) +#define K_S_F4 TERMCAP2KEY(KS_EXTRA, KE_S_F4) +#define K_S_F5 TERMCAP2KEY(KS_EXTRA, KE_S_F5) +#define K_S_F6 TERMCAP2KEY(KS_EXTRA, KE_S_F6) +#define K_S_F7 TERMCAP2KEY(KS_EXTRA, KE_S_F7) +#define K_S_F8 TERMCAP2KEY(KS_EXTRA, KE_S_F8) +#define K_S_F9 TERMCAP2KEY(KS_EXTRA, KE_S_F9) +#define K_S_F10 TERMCAP2KEY(KS_EXTRA, KE_S_F10) + +#define K_S_F11 TERMCAP2KEY(KS_EXTRA, KE_S_F11) +#define K_S_F12 TERMCAP2KEY(KS_EXTRA, KE_S_F12) +// K_S_F13 to K_S_F37 are currently not used + +#define K_HELP TERMCAP2KEY('%', '1') +#define K_UNDO TERMCAP2KEY('&', '8') + +#define K_BS TERMCAP2KEY('k', 'b') + +#define K_INS TERMCAP2KEY('k', 'I') +#define K_KINS TERMCAP2KEY(KS_EXTRA, KE_KINS) +#define K_DEL TERMCAP2KEY('k', 'D') +#define K_KDEL TERMCAP2KEY(KS_EXTRA, KE_KDEL) +#define K_HOME TERMCAP2KEY('k', 'h') +#define K_KHOME TERMCAP2KEY('K', '1') // keypad home (upper left) +#define K_XHOME TERMCAP2KEY(KS_EXTRA, KE_XHOME) +#define K_ZHOME TERMCAP2KEY(KS_EXTRA, KE_ZHOME) +#define K_END TERMCAP2KEY('@', '7') +#define K_KEND TERMCAP2KEY('K', '4') // keypad end (lower left) +#define K_XEND TERMCAP2KEY(KS_EXTRA, KE_XEND) +#define K_ZEND TERMCAP2KEY(KS_EXTRA, KE_ZEND) +#define K_PAGEUP TERMCAP2KEY('k', 'P') +#define K_PAGEDOWN TERMCAP2KEY('k', 'N') +#define K_KPAGEUP TERMCAP2KEY('K', '3') // keypad pageup (upper R.) +#define K_KPAGEDOWN TERMCAP2KEY('K', '5') // keypad pagedown (lower R.) +#define K_KORIGIN TERMCAP2KEY('K', '2') // keypad center + +#define K_KPLUS TERMCAP2KEY('K', '6') // keypad plus +#define K_KMINUS TERMCAP2KEY('K', '7') // keypad minus +#define K_KDIVIDE TERMCAP2KEY('K', '8') // keypad / +#define K_KMULTIPLY TERMCAP2KEY('K', '9') // keypad * +#define K_KENTER TERMCAP2KEY('K', 'A') // keypad Enter +#define K_KPOINT TERMCAP2KEY('K', 'B') // keypad . or , + +#define K_K0 TERMCAP2KEY('K', 'C') // keypad 0 +#define K_K1 TERMCAP2KEY('K', 'D') // keypad 1 +#define K_K2 TERMCAP2KEY('K', 'E') // keypad 2 +#define K_K3 TERMCAP2KEY('K', 'F') // keypad 3 +#define K_K4 TERMCAP2KEY('K', 'G') // keypad 4 +#define K_K5 TERMCAP2KEY('K', 'H') // keypad 5 +#define K_K6 TERMCAP2KEY('K', 'I') // keypad 6 +#define K_K7 TERMCAP2KEY('K', 'J') // keypad 7 +#define K_K8 TERMCAP2KEY('K', 'K') // keypad 8 +#define K_K9 TERMCAP2KEY('K', 'L') // keypad 9 + +#define K_KCOMMA TERMCAP2KEY('K', 'M') // keypad comma +#define K_KEQUAL TERMCAP2KEY('K', 'N') // keypad equal + +#define K_MOUSE TERMCAP2KEY(KS_MOUSE, KE_FILLER) +#define K_MENU TERMCAP2KEY(KS_MENU, KE_FILLER) +#define K_VER_SCROLLBAR TERMCAP2KEY(KS_VER_SCROLLBAR, KE_FILLER) +#define K_HOR_SCROLLBAR TERMCAP2KEY(KS_HOR_SCROLLBAR, KE_FILLER) + +#define K_SELECT TERMCAP2KEY(KS_SELECT, KE_FILLER) + +#define K_TABLINE TERMCAP2KEY(KS_TABLINE, KE_FILLER) +#define K_TABMENU TERMCAP2KEY(KS_TABMENU, KE_FILLER) + +// Symbols for pseudo keys which are translated from the real key symbols +// above. + +#define K_LEFTMOUSE TERMCAP2KEY(KS_EXTRA, KE_LEFTMOUSE) +#define K_LEFTMOUSE_NM TERMCAP2KEY(KS_EXTRA, KE_LEFTMOUSE_NM) +#define K_LEFTDRAG TERMCAP2KEY(KS_EXTRA, KE_LEFTDRAG) +#define K_LEFTRELEASE TERMCAP2KEY(KS_EXTRA, KE_LEFTRELEASE) +#define K_LEFTRELEASE_NM TERMCAP2KEY(KS_EXTRA, KE_LEFTRELEASE_NM) +#define K_MOUSEMOVE TERMCAP2KEY(KS_EXTRA, KE_MOUSEMOVE) +#define K_MIDDLEMOUSE TERMCAP2KEY(KS_EXTRA, KE_MIDDLEMOUSE) +#define K_MIDDLEDRAG TERMCAP2KEY(KS_EXTRA, KE_MIDDLEDRAG) +#define K_MIDDLERELEASE TERMCAP2KEY(KS_EXTRA, KE_MIDDLERELEASE) +#define K_RIGHTMOUSE TERMCAP2KEY(KS_EXTRA, KE_RIGHTMOUSE) +#define K_RIGHTDRAG TERMCAP2KEY(KS_EXTRA, KE_RIGHTDRAG) +#define K_RIGHTRELEASE TERMCAP2KEY(KS_EXTRA, KE_RIGHTRELEASE) +#define K_X1MOUSE TERMCAP2KEY(KS_EXTRA, KE_X1MOUSE) +#define K_X1MOUSE TERMCAP2KEY(KS_EXTRA, KE_X1MOUSE) +#define K_X1DRAG TERMCAP2KEY(KS_EXTRA, KE_X1DRAG) +#define K_X1RELEASE TERMCAP2KEY(KS_EXTRA, KE_X1RELEASE) +#define K_X2MOUSE TERMCAP2KEY(KS_EXTRA, KE_X2MOUSE) +#define K_X2DRAG TERMCAP2KEY(KS_EXTRA, KE_X2DRAG) +#define K_X2RELEASE TERMCAP2KEY(KS_EXTRA, KE_X2RELEASE) + +#define K_IGNORE TERMCAP2KEY(KS_EXTRA, KE_IGNORE) +#define K_NOP TERMCAP2KEY(KS_EXTRA, KE_NOP) + +#define K_MOUSEDOWN TERMCAP2KEY(KS_EXTRA, KE_MOUSEDOWN) +#define K_MOUSEUP TERMCAP2KEY(KS_EXTRA, KE_MOUSEUP) +#define K_MOUSELEFT TERMCAP2KEY(KS_EXTRA, KE_MOUSELEFT) +#define K_MOUSERIGHT TERMCAP2KEY(KS_EXTRA, KE_MOUSERIGHT) + +#define K_SNR TERMCAP2KEY(KS_EXTRA, KE_SNR) +#define K_PLUG TERMCAP2KEY(KS_EXTRA, KE_PLUG) +#define K_CMDWIN TERMCAP2KEY(KS_EXTRA, KE_CMDWIN) + +#define K_DROP TERMCAP2KEY(KS_EXTRA, KE_DROP) + +#define K_EVENT TERMCAP2KEY(KS_EXTRA, KE_EVENT) +#define K_COMMAND TERMCAP2KEY(KS_EXTRA, KE_COMMAND) +#define K_LUA TERMCAP2KEY(KS_EXTRA, KE_LUA) + +// Bits for modifier mask +// 0x01 cannot be used, because the modifier must be 0x02 or higher +#define MOD_MASK_SHIFT 0x02 +#define MOD_MASK_CTRL 0x04 +#define MOD_MASK_ALT 0x08 // aka META +#define MOD_MASK_META 0x10 // META when it's different from ALT +#define MOD_MASK_2CLICK 0x20 // use MOD_MASK_MULTI_CLICK +#define MOD_MASK_3CLICK 0x40 // use MOD_MASK_MULTI_CLICK +#define MOD_MASK_4CLICK 0x60 // use MOD_MASK_MULTI_CLICK +#define MOD_MASK_CMD 0x80 // "super" key (macOS: command-key) + +#define MOD_MASK_MULTI_CLICK (MOD_MASK_2CLICK|MOD_MASK_3CLICK| \ + MOD_MASK_4CLICK) + +/// The length of the longest special key name, including modifiers. +/// Current longest is <M-C-S-T-D-A-4-ScrollWheelRight> (length includes '<' and '>'). +#define MAX_KEY_NAME_LEN 32 + +// Maximum length of a special key event as tokens. This includes modifiers. +// The longest event is something like <M-C-S-T-4-LeftDrag> which would be the +// following string of tokens: +// +// <K_SPECIAL> <KS_MODIFIER> bitmask <K_SPECIAL> <KS_EXTRA> <KE_LEFTDRAG>. +// +// This is a total of 6 tokens, and is currently the longest one possible. +#define MAX_KEY_CODE_LEN 6 + +#define FLAG_CPO_BSLASH 0x01 +#define CPO_TO_CPO_FLAGS ((vim_strchr((char *)p_cpo, CPO_BSLASH) == NULL) \ + ? 0 \ + : FLAG_CPO_BSLASH) + +// Flags for replace_termcodes() +enum { + REPTERM_FROM_PART = 1, + REPTERM_DO_LT = 2, + REPTERM_NO_SPECIAL = 4, + REPTERM_NO_SIMPLIFY = 8, +}; + +// Flags for find_special_key() +enum { + FSK_KEYCODE = 0x01, ///< prefer key code, e.g. K_DEL in place of DEL + FSK_KEEP_X_KEY = 0x02, ///< don’t translate xHome to Home key + FSK_IN_STRING = 0x04, ///< in string, double quote is escaped + FSK_SIMPLIFY = 0x08, ///< simplify <C-H>, etc. +}; + +#ifdef INCLUDE_GENERATED_DECLARATIONS +# include "keycodes.h.generated.h" +#endif +#endif // NVIM_KEYCODES_H |