From 99d4c8c29c4a9371c268cc20e4805709d86fb686 Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Sat, 20 Feb 2016 17:09:15 -0500
Subject: keymap: Support <D-...> (super/command key).

Adds support for:
  - api:vim_input("<D-a>")
  - ":nnoremap <C-D-S-...>" and permutations thereof

UIs must capture the modifier and send it as "<D-...>" to vim_input().

Note: Before this commit, any arbitrary ":nnoremap <{foo}-{bar}>"
mapping could already be invoked with feedkeys("\<{foo}-{bar}>"). This
commit supports "D-" as a modifier that can be combined with "C-", "A-",
"S-" in any order.

For non-GUI (terminal) support, user must:
  :set <D-a>={CSI sequence}
then send the {CSI sequence} from their terminal. But this does not work
yet (regression #2204).

Closes #2190
---
 src/nvim/keymap.h | 36 ++++++++++++++++++------------------
 1 file changed, 18 insertions(+), 18 deletions(-)

(limited to 'src/nvim/keymap.h')

diff --git a/src/nvim/keymap.h b/src/nvim/keymap.h
index 766362d145..8f9980c6b4 100644
--- a/src/nvim/keymap.h
+++ b/src/nvim/keymap.h
@@ -112,11 +112,11 @@
 #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.
- *
- * K_SPECIAL KS_EXTRA KE_xxx
- */
+// Codes for keys that do not have a termcap name.
+//
+// K_SPECIAL KS_EXTRA KE_xxx
+//
+// Entries must be in the range 0x02-0x7f (see comment at K_SPECIAL).
 enum key_extra {
   KE_NAME = 3           /* name of this terminal entry */
 
@@ -436,11 +436,12 @@ enum key_extra {
 /* 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_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 (OSX/Mac: command-key)
 
 #define MOD_MASK_MULTI_CLICK    (MOD_MASK_2CLICK|MOD_MASK_3CLICK| \
                                  MOD_MASK_4CLICK)
@@ -451,14 +452,13 @@ enum key_extra {
  */
 #define MAX_KEY_NAME_LEN    25
 
-/* 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> <KT_LEFTDRAG>.
- *
- * This is a total of 6 tokens, and is currently the longest one possible.
- */
+// 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
 
 
-- 
cgit