vi-mode: Add dgg to delete from the beginning of the buffer to the current logical line (#1752)

Author: springcomp

PSReadLine/KeyBindings.cs

@@ -400,6 +400,7 @@ public static KeyHandlerGroup GetDisplayGrouping(string function)
             case nameof(DeleteCharOrExit):
             case nameof(DeleteEndOfBuffer):
             case nameof(DeleteEndOfWord):
+            case nameof(DeleteRelativeLines):
             case nameof(DeleteLine):
             case nameof(DeleteLineToFirstChar):
             case nameof(DeleteNextLines):

PSReadLine/KeyBindings.vi.cs

@@ -43,6 +43,7 @@ internal static ConsoleColor AlternateBackground(ConsoleColor bg)
         private static Dictionary<PSKeyInfo, KeyHandler> _viChordGTable;
         private static Dictionary<PSKeyInfo, KeyHandler> _viChordCTable;
         private static Dictionary<PSKeyInfo, KeyHandler> _viChordYTable;
+        private static Dictionary<PSKeyInfo, KeyHandler> _viChordDGTable;
 
         private static Dictionary<PSKeyInfo, Dictionary<PSKeyInfo, KeyHandler>> _viCmdChordTable;
         private static Dictionary<PSKeyInfo, Dictionary<PSKeyInfo, KeyHandler>> _viInsChordTable;
@@ -226,6 +227,7 @@ private void SetDefaultViBindings()
                 { Keys.W,               MakeKeyHandler( DeleteWord,                   "DeleteWord") },
                 { Keys.ucW,             MakeKeyHandler( ViDeleteGlob,                 "ViDeleteGlob") },
                 { Keys.E,               MakeKeyHandler( DeleteEndOfWord,              "DeleteEndOfWord") },
+                { Keys.G,               MakeKeyHandler( ViDGChord,                    "ViDGChord") },
                 { Keys.ucG,             MakeKeyHandler( DeleteEndOfBuffer,            "DeleteEndOfBuffer") },
                 { Keys.ucE,             MakeKeyHandler( ViDeleteEndOfGlob,            "ViDeleteEndOfGlob") },
                 { Keys.H,               MakeKeyHandler( BackwardDeleteChar,           "BackwardDeleteChar") },
@@ -287,6 +289,11 @@ private void SetDefaultViBindings()
                 { Keys.Percent,         MakeKeyHandler( ViYankPercent,         "ViYankPercent") },
             };
 
+            _viChordDGTable = new Dictionary<PSKeyInfo, KeyHandler>
+            {
+                { Keys.G,               MakeKeyHandler( DeleteRelativeLines,   "DeleteRelativeLines") },
+            };
+
             _viCmdChordTable = new Dictionary<PSKeyInfo, Dictionary<PSKeyInfo, KeyHandler>>();
             _viInsChordTable = new Dictionary<PSKeyInfo, Dictionary<PSKeyInfo, KeyHandler>>();
 

PSReadLine/PSReadLineResources.resx

@@ -811,4 +811,7 @@ Or not saving history with:
   <data name="DeleteNextLinesDescription" xml:space="preserve">
     <value>Deletes the current and next n logical lines in a multiline buffer</value>
   </data>
+  <data name="DeleteRelativeLinesDescription" xml:space="preserve">
+    <value>Delete from the current logical line to the n-th requested logical line in a multiline buffer</value>
+  </data>
 </root>

PSReadLine/ReadLine.vi.cs

@@ -368,7 +368,7 @@ public static void DeleteEndOfWord(ConsoleKeyInfo? key = null, object arg = null
             _singleton._buffer.Remove(_singleton._current, 1 + endPoint - _singleton._current);
             if (_singleton._current >= _singleton._buffer.Length)
             {
-                _singleton._current = Math.Max(0,_singleton._buffer.Length - 1);
+                _singleton._current = Math.Max(0, _singleton._buffer.Length - 1);
             }
             _singleton.Render();
         }
@@ -522,11 +522,11 @@ internal static IDisposable UseViCommandModeTables()
             _singleton._dispatchTable = _viCmdKeyMap;
             _singleton._chordDispatchTable = _viCmdChordTable;
 
-            return new Disposable( () =>
-            {
-                _singleton._dispatchTable = oldDispatchTable;
-                _singleton._chordDispatchTable = oldChordDispatchTable;
-            } );
+            return new Disposable(() =>
+           {
+               _singleton._dispatchTable = oldDispatchTable;
+               _singleton._chordDispatchTable = oldChordDispatchTable;
+           });
         }
 
         /// <summary>
@@ -540,11 +540,11 @@ internal static IDisposable UseViInsertModeTables()
             _singleton._dispatchTable = _viInsKeyMap;
             _singleton._chordDispatchTable = _viInsChordTable;
 
-            return new Disposable( () =>
-            {
-                _singleton._dispatchTable = oldDispatchTable;
-                _singleton._chordDispatchTable = oldChordDispatchTable;
-            } );
+            return new Disposable(() =>
+           {
+               _singleton._dispatchTable = oldDispatchTable;
+               _singleton._chordDispatchTable = oldChordDispatchTable;
+           });
         }
 
         private void ViIndicateCommandMode()
@@ -849,6 +849,38 @@ public static void DeletePreviousLines(ConsoleKeyInfo? key = null, object arg =
             }
         }
 
+        /// <summary>
+        /// Delete from the current logical line to the n-th requested logical line in a multiline buffer
+        /// </summary>
+        private static void DeleteRelativeLines(ConsoleKeyInfo? key = null, object arg = null)
+        {
+            if (TryGetArgAsInt(arg, out var requestedLineNumber, 1))
+            {
+                var currentLineIndex = _singleton.GetLogicalLineNumber() - 1;
+                var requestedLineIndex = requestedLineNumber - 1;
+                if (requestedLineIndex < 0)
+                {
+                    requestedLineIndex = 0;
+                }
+
+                var logicalLineCount = _singleton.GetLogicalLineCount();
+                if (requestedLineIndex >= logicalLineCount)
+                {
+                    requestedLineIndex = logicalLineCount - 1;
+                }
+
+                var requestedLineCount = requestedLineIndex - currentLineIndex;
+                if (requestedLineCount < 0)
+                {
+                    DeletePreviousLines(null, -requestedLineCount);
+                }
+                else
+                {
+                    DeleteNextLines(null, requestedLineCount);
+                }
+            }
+        }
+
         /// <summary>
         /// Deletes the previous word.
         /// </summary>
@@ -1106,39 +1138,54 @@ private static void ViChord(ConsoleKeyInfo? key = null, object arg = null)
 
             if (_singleton._chordDispatchTable.TryGetValue(PSKeyInfo.FromConsoleKeyInfo(key.Value), out var secondKeyDispatchTable))
             {
-                var secondKey = ReadKey();
-                if (secondKeyDispatchTable.TryGetValue(secondKey, out var handler))
+                ViChordHandler(secondKeyDispatchTable, arg);
+            }
+        }
+
+        private static void ViChordHandler(Dictionary<PSKeyInfo, KeyHandler> secondKeyDispatchTable, object arg = null)
+        {
+            var secondKey = ReadKey();
+            if (secondKeyDispatchTable.TryGetValue(secondKey, out var handler))
+            {
+                _singleton.ProcessOneKey(secondKey, secondKeyDispatchTable, ignoreIfNoAction: true, arg: arg);
+            }
+            else if (!IsNumeric(secondKey))
+            {
+                _singleton.ProcessOneKey(secondKey, secondKeyDispatchTable, ignoreIfNoAction: true, arg: arg);
+            }
+            else
+            {
+                var argBuffer = _singleton._statusBuffer;
+                argBuffer.Clear();
+                _singleton._statusLinePrompt = "digit-argument: ";
+                while (IsNumeric(secondKey))
                 {
-                    _singleton.ProcessOneKey(secondKey, secondKeyDispatchTable, ignoreIfNoAction: true, arg: arg);
+                    argBuffer.Append(secondKey.KeyChar);
+                    _singleton.Render();
+                    secondKey = ReadKey();
                 }
-                else if (!IsNumeric(secondKey))
+                int numericArg = int.Parse(argBuffer.ToString());
+                if (secondKeyDispatchTable.TryGetValue(secondKey, out handler))
                 {
-                    _singleton.ProcessOneKey(secondKey, secondKeyDispatchTable, ignoreIfNoAction: true, arg: arg);
+                    _singleton.ProcessOneKey(secondKey, secondKeyDispatchTable, ignoreIfNoAction: true, arg: numericArg);
                 }
                 else
                 {
-                    var argBuffer = _singleton._statusBuffer;
-                    argBuffer.Clear();
-                    _singleton._statusLinePrompt = "digit-argument: ";
-                    while (IsNumeric(secondKey))
-                    {
-                        argBuffer.Append(secondKey.KeyChar);
-                        _singleton.Render();
-                        secondKey = ReadKey();
-                    }
-                    int numericArg = int.Parse(argBuffer.ToString());
-                    if (secondKeyDispatchTable.TryGetValue(secondKey, out handler))
-                    {
-                        _singleton.ProcessOneKey(secondKey, secondKeyDispatchTable, ignoreIfNoAction: true, arg: numericArg);
-                    }
-                    else
-                    {
-                        Ding();
-                    }
-                    argBuffer.Clear();
-                    _singleton.ClearStatusMessage(render: true);
+                    Ding();
                 }
+                argBuffer.Clear();
+                _singleton.ClearStatusMessage(render: true);
+            }
+        }
+
+        private static void ViDGChord(ConsoleKeyInfo? key = null, object arg = null)
+        {
+            if (!key.HasValue)
+            {
+                throw new ArgumentNullException(nameof(key));
             }
+
+            ViChordHandler(_viChordDGTable, arg);
         }
 
         private static bool IsNumeric(PSKeyInfo key)
@@ -1247,7 +1294,7 @@ public static void ViInsertLine(ConsoleKeyInfo? key = null, object arg = null)
             _singleton.MoveToBeginningOfPhrase();
             _singleton._buffer.Insert(_singleton._current, '\n');
             //_singleton._current = Math.Max(0, _singleton._current - 1);
-            _singleton.SaveEditItem(EditItemInsertChar.Create( '\n', _singleton._current));
+            _singleton.SaveEditItem(EditItemInsertChar.Create('\n', _singleton._current));
             _singleton.Render();
             ViInsertMode();
         }

test/BasicEditingTest.VI.cs

@@ -567,6 +567,50 @@ public void ViDeleteNextLines()
                 ));
         }
 
+        [SkippableFact]
+        public void ViDeleteRelativeLines()
+        {
+            TestSetup(KeyMode.Vi);
+
+            var continuationPrefixLength = PSConsoleReadLineOptions.DefaultContinuationPrompt.Length;
+
+            Test("\"\nthree\n\"", Keys(
+                _.DQuote, _.Enter,
+                "one", _.Enter,
+                "two", _.Enter,
+                "three", _.Enter,
+                _.DQuote, _.Escape,
+                "kkl", // go to the 'wo' portion of "two"
+                // delete from line 2 to the current line (3)
+                "2dgg",
+                CheckThat(() => AssertCursorLeftIs(continuationPrefixLength + 0))
+                ));
+
+            Test("\"\none\nthree\n\"", Keys(
+                _.DQuote, _.Enter,
+                "one", _.Enter,
+                "two", _.Enter,
+                "three", _.Enter,
+                _.DQuote, _.Escape,
+                "kkl", // go to the 'wo' portion of "two"
+                // delete the current line (3)
+                "3dgg",
+                CheckThat(() => AssertCursorLeftIs(continuationPrefixLength + 0))
+                ));
+
+            Test("\"\none\n\"", Keys(
+                _.DQuote, _.Enter,
+                "one", _.Enter,
+                "two", _.Enter,
+                "three", _.Enter,
+                _.DQuote, _.Escape,
+                "kkl", // go to the 'wo' portion of "two"
+                // delete from the current line (3) to line 4
+                "4dgg",
+                CheckThat(() => AssertCursorLeftIs(continuationPrefixLength + 0))
+                ));
+        }
+
         [SkippableFact]
         public void ViGlobDelete()
         {