Merge pull request #213 from kindermannhubert/auto-format

Support for automatic formatting

src/PrettyPrompt/Documents/Document.cs

@@ -102,11 +102,11 @@ public void Clear(CodePane codePane)
         }
     }
 
-    public void SetContents(CodePane codePane, string contents)
+    public void SetContents(CodePane codePane, string contents, int caret)
     {
         using (BeginChanges(codePane))
         {
-            stringBuilder.SetContents(contents);
+            stringBuilder.SetContents(contents, caret);
         }
     }
 

src/PrettyPrompt/Documents/StringBuilderWithCaret.cs

@@ -64,10 +64,10 @@ public void Clear()
         }
     }
 
-    public void SetContents(string contents)
+    public void SetContents(string contents, int? caret = null)
     {
         sb.SetContents(contents);
-        Caret = sb.Length;
+        Caret = caret ?? sb.Length;
         InvokeChangedEvent();
     }
 

src/PrettyPrompt/History/HistoryLog.cs

@@ -186,7 +186,7 @@ private static void SetContents(CodePane codepane, string contents)
     {
         if (codepane.Document.Equals(contents)) return;
 
-        codepane.Document.SetContents(codepane, contents);
+        codepane.Document.SetContents(codepane, contents, caret: contents.Length);
     }
 
     internal void Track(CodePane codePane)

src/PrettyPrompt/Panes/OverloadPane.cs

@@ -128,9 +128,9 @@ private void UpdateSelectedItem()
             signatureLines = WordWrapping.WrapWords(selectedOverload.Signature, maxLength: availableWidth, maxLines: dedicatedLines[0]);
             summaryLines = WordWrapping.WrapWords(selectedOverload.Summary, maxLength: availableWidth, maxLines: dedicatedLines[1]);
 
-            var paramIndex = selectedArgumentIndex.Clamp(0, selectedOverload.Parameters.Count - 1);
             if (selectedOverload.Parameters.Count > 0)
             {
+                var paramIndex = selectedArgumentIndex.Clamp(0, selectedOverload.Parameters.Count - 1);
                 var param = selectedOverload.Parameters[paramIndex];
                 var name = new FormattedString(param.Name, new ConsoleFormat(Bold: true));
                 paramDescriptionLines = WordWrapping.WrapWords(spacesUnderCounter + name + ": " + param.Description, maxLength: availableWidth, maxLines: dedicatedLines[2]);

src/PrettyPrompt/PrettyPrompt.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <Version>4.0.0-beta5</Version>
+    <Version>4.0.0-beta6</Version>
 
     <PackageId>PrettyPrompt</PackageId>
     <PackageTags>repl readline console cli</PackageTags>

src/PrettyPrompt/Prompt.cs

@@ -60,10 +60,10 @@ public Prompt(
     public async Task<PromptResult> ReadLineAsync()
     {
         using var renderer = new Renderer(console, configuration);
-        
+
         // code pane contains the code the user is typing. It does not include the prompt (i.e. "> ")
         var codePane = new CodePane(console, configuration, clipboard);
-        
+
         renderer.RenderPrompt(codePane);
 
         var overloadPane = new OverloadPane(
@@ -114,7 +114,7 @@ public async Task<PromptResult> ReadLineAsync()
 
         Debug.Assert(false, "Should never reach here due to infinite " + nameof(KeyPress.ReadForever));
         return null;
-        
+
         async Task InterpretKeyPress(KeyPress key, CancellationToken cancellationToken)
         {
             if (!completionPane.WouldKeyPressCommitCompletionItem(key))
@@ -128,6 +128,23 @@ async Task InterpretKeyPress(KeyPress key, CancellationToken cancellationToken)
             foreach (var panes in new IKeyPressHandler[] { completionPane, overloadPane, history, codePane })
                 await panes.OnKeyUp(key, cancellationToken).ConfigureAwait(false);
 
+            //Possible automatic formatting of the document;
+            var text = codePane.Document.GetText();
+            var (formattedText, newCaret) = await promptCallbacks.FormatInput(text, codePane.Document.Caret, key, cancellationToken).ConfigureAwait(false);
+            if (text != formattedText)
+            {
+                int removedChars = 0;
+                for (int i = 0; i < newCaret; i++)
+                {
+                    if (formattedText[i] == '\r') ++removedChars;
+                }
+                codePane.Document.SetContents(codePane, formattedText.Replace("\r\n", "\n"), newCaret - removedChars);
+            }
+            else
+            {
+                Debug.Assert(codePane.Document.Caret == newCaret);
+            }
+
             //we don't support text selection while completion list is open
             //text selection can put completion list into broken state, where filtering does not work
             //so we want this assert to be true

src/PrettyPrompt/PromptCallbacks.cs

@@ -120,6 +120,16 @@ public interface IPromptCallbacks
     /// <param name="cancellationToken">Cancellation token</param>
     /// <returns><see langword="true"/> if the completion item should be submitted or <see langword="false"/> otherwise.</returns>
     Task<bool> ConfirmCompletionCommit(string text, int caret, KeyPress keyPress, CancellationToken cancellationToken);
+
+    /// <summary>
+    /// Provides way to automatically format input text.
+    /// </summary>
+    /// <param name="text">The user's input text</param>
+    /// <param name="caret">The index of the text caret in the input text</param>
+    /// <param name="keyPress">Key press pattern in question</param>
+    /// <param name="cancellationToken">Cancellation token</param>
+    /// <returns>Formatted input and new caret position.</returns>
+    Task<(string Text, int Caret)> FormatInput(string text, int caret, KeyPress keyPress, CancellationToken cancellationToken);
 }
 
 public class PromptCallbacks : IPromptCallbacks
@@ -188,6 +198,13 @@ Task<bool> IPromptCallbacks.ConfirmCompletionCommit(string text, int caret, KeyP
         return ConfirmCompletionCommit(text, caret, keyPress, cancellationToken);
     }
 
+    Task<(string Text, int Caret)> IPromptCallbacks.FormatInput(string text, int caret, KeyPress keyPress, CancellationToken cancellationToken)
+    {
+        Debug.Assert(caret >= 0 && caret <= text.Length);
+
+        return FormatInput(text, caret, keyPress, cancellationToken);
+    }
+
     Task<(IReadOnlyList<OverloadItem>, int ArgumentIndex)> IPromptCallbacks.GetOverloadsAsync(string text, int caret, CancellationToken cancellationToken)
     {
         Debug.Assert(caret >= 0 && caret <= text.Length);
@@ -275,6 +292,10 @@ protected virtual Task<KeyPress> TransformKeyPressAsync(string text, int caret,
     protected virtual Task<bool> ConfirmCompletionCommit(string text, int caret, KeyPress keyPress, CancellationToken cancellationToken)
         => Task.FromResult(true);
 
+    /// <inheritdoc cref="IPromptCallbacks.FormatInput(string, int, KeyPress, CancellationToken)"/>
+    protected virtual Task<(string Text, int Caret)> FormatInput(string text, int caret, KeyPress keyPress, CancellationToken cancellationToken)
+        => Task.FromResult((text, caret));
+
     /// <inheritdoc cref="GetOverloadsAsync(string, int, CancellationToken)"/>
     protected virtual Task<(IReadOnlyList<OverloadItem>, int ArgumentIndex)> GetOverloadsAsync(string text, int caret, CancellationToken cancellationToken)
         => Task.FromResult<(IReadOnlyList<OverloadItem>, int ArgumentIndex)>((Array.Empty<OverloadItem>(), 0));