Merge pull request #2438 from ricksladkey/shift-notation

Normalize modifiers in the right hand side of key mappings

Src/VimCore/KeyInput.fs

@@ -424,6 +424,13 @@ module KeyInputUtil =
             | _ -> VimKeyModifiers.None
         ApplyKeyModifiers keyInput modifiers
 
+    let NormalizeKeyModifiers (keyInput: KeyInput) =
+        match keyInput.RawChar with
+        | Some c ->
+            ApplyKeyModifiersToChar c keyInput.KeyModifiers
+        | None ->
+            ApplyKeyModifiersToKey keyInput.Key keyInput.KeyModifiers
+
     let CharWithControlToKeyInput ch = 
         let keyInput = ch |> CharToKeyInput  
         ApplyKeyModifiers keyInput VimKeyModifiers.Control

Src/VimCore/KeyInput.fsi

@@ -88,6 +88,9 @@ module KeyInputUtil =
     /// Apply a click count to the given key input
     val ApplyClickCount: keyInput: KeyInput -> clickCount: int -> KeyInput
 
+    /// Normalize key modifiers, e.g. removing an irrelevant shift
+    val NormalizeKeyModifiers: keyInput: KeyInput -> KeyInput
+
     /// Try and convert the given char to a KeyInput value
     val CharToKeyInput: c: char -> KeyInput
 

Src/VimCore/KeyMap.fs

@@ -221,6 +221,13 @@ type internal KeyMap
             let rhs = KeyNotationUtil.TryStringToKeyInputSet rhs
             match key, rhs with
             | Some left, Some right ->
+                // Empirically with vim/gvim, <S-$> on the left is never
+                // matched, but <S-$> on the right is treated as '$'. Reported
+                // in issue #2313.
+                let right =
+                    right.KeyInputs
+                    |> Seq.map KeyInputUtil.NormalizeKeyModifiers
+                    |> KeyInputSetUtil.OfSeq
                 let keyMapping = {
                     Left = left
                     Right = right

Test/VimCoreTest/NormalModeIntegrationTest.cs

@@ -2792,6 +2792,19 @@ public void Issue1435()
                     Assert.Equal("  cat", _textBuffer.GetLine(0).GetText());
                     Assert.Equal("dog", _textBuffer.GetLine(1).GetText());
                 }
+
+                /// <summary>
+                /// Key modifiers in the right hand side of mappings are normalized
+                /// </summary>
+                [WpfFact]
+                public void NormalizedRightHandSide()
+                {
+                    // Reported in issue #2313.
+                    Create("cat", "dog", "");
+                    _vimBuffer.Process(":map nn <S-$>", enter: true);
+                    _vimBuffer.Process("nn");
+                    Assert.Equal(2, _textView.GetCaretPoint().Position);
+                }
             }
         }