Merge pull request #4792 from retailcoder/scp-bugfix

SCP Fixes

Author: retailcoder

Rubberduck.Core/AutoComplete/AutoCompleteHandlerBase.cs

@@ -5,6 +5,9 @@
 
 namespace Rubberduck.AutoComplete
 {
+    /// <summary>
+    /// A base class/interface for AC services / "handlers".
+    /// </summary>
     public abstract class AutoCompleteHandlerBase
     {
         protected AutoCompleteHandlerBase(ICodePaneHandler pane)
@@ -14,6 +17,13 @@ protected AutoCompleteHandlerBase(ICodePaneHandler pane)
 
         protected ICodePaneHandler CodePaneHandler { get; }
 
+        /// <summary>
+        /// A method that returns <c>false</c> if the input isn't handled, <c>true</c> if it is.
+        /// </summary>
+        /// <param name="e">The autocompletion event info</param>
+        /// <param name="settings">The current AC settings</param>
+        /// <param name="result">If handled, the resulting <c>CodeString</c></param>
+        /// <returns></returns>
         public abstract bool Handle(AutoCompleteEventArgs e, AutoCompleteSettings settings, out CodeString result);
     }
 }

Rubberduck.Core/AutoComplete/Service/AutoCompleteService.cs renamed to Rubberduck.Core/AutoComplete/AutoCompleteService.cs

@@ -5,8 +5,12 @@
 using Rubberduck.Settings;
 using Rubberduck.VBEditor.Events;
 
-namespace Rubberduck.AutoComplete.Service
+namespace Rubberduck.AutoComplete
 {
+    /// <summary>
+    /// A service responsible for dispatching CodePane work to more specialized autocompletion services.
+    /// Handles changes in configuration settings.
+    /// </summary>
     public class AutoCompleteService : IDisposable
     {
         private static readonly ILogger Logger = LogManager.GetCurrentClassLogger();
@@ -151,6 +155,7 @@ private bool TryHandle(AutoCompleteEventArgs e, AutoCompleteHandlerBase handler)
                     return false;
                 }
 
+                Logger.Debug($"Keypress was handled by {handler.GetType().Name}.");
                 e.Handled = true;
                 return true;
 
@@ -169,7 +174,8 @@ public void Dispose()
         }
 
         private bool _isDisposed;
-        protected virtual void Dispose(bool disposing)
+
+        private void Dispose(bool disposing)
         {
             if (_isDisposed || !disposing)
             {

Rubberduck.Core/AutoComplete/Service/SelfClosingPair.cs renamed to Rubberduck.Core/AutoComplete/SelfClosingPairs/SelfClosingPair.cs

@@ -1,7 +1,7 @@
-using Rubberduck.VBEditor;
-using System;
+using System;
+using Rubberduck.VBEditor;
 
-namespace Rubberduck.AutoComplete.Service
+namespace Rubberduck.AutoComplete.SelfClosingPairs
 {
     public class SelfClosingPair : IEquatable<SelfClosingPair>
     {

Rubberduck.Core/AutoComplete/Service/SelfClosingPairCompletionService.cs renamed to Rubberduck.Core/AutoComplete/SelfClosingPairs/SelfClosingPairCompletionService.cs

@@ -8,7 +8,7 @@
 using Rubberduck.Parsing.VBA.Parsing;
 using Rubberduck.VBEditor;
 
-namespace Rubberduck.AutoComplete.Service
+namespace Rubberduck.AutoComplete.SelfClosingPairs
 {
     public class SelfClosingPairCompletionService
     {

Rubberduck.Core/AutoComplete/Service/SelfClosingPairHandler.cs renamed to Rubberduck.Core/AutoComplete/SelfClosingPairs/SelfClosingPairHandler.cs

@@ -1,13 +1,16 @@
-using System.Collections.Generic;
-using System.Diagnostics;
+using System;
+using System.Collections.Generic;
 using System.Linq;
 using Rubberduck.Settings;
 using Rubberduck.VBEditor;
 using Rubberduck.VBEditor.Events;
 using Rubberduck.VBEditor.SourceCodeHandling;
 
-namespace Rubberduck.AutoComplete.Service
+namespace Rubberduck.AutoComplete.SelfClosingPairs
 {
+    /// <summary>
+    /// An AC handler that automatically closes certain specific "pairs" of characters, e.g. double quotes, or parentheses.
+    /// </summary>
     public class SelfClosingPairHandler : AutoCompleteHandlerBase
     {
         private const int MaximumLines = 25;
@@ -39,6 +42,7 @@ public override bool Handle(AutoCompleteEventArgs e, AutoCompleteSettings settin
             result = null;
             if (!_scpInputLookup.TryGetValue(e.Character, out var pair) && e.Character != '\b')
             {
+                // not an interesting keypress.
                 return false;
             }
 
@@ -50,15 +54,25 @@ public override bool Handle(AutoCompleteEventArgs e, AutoCompleteSettings settin
                 return false;
             }
 
+            if (!original.CaretPosition.IsSingleCharacter)
+            {
+                // here would be an opportunity to "wrap selection" with a SCP.
+                // todo: WrapSelectionWith(pair)?
+                result = null;
+                return false;
+            }
+
             if (pair != null)
             {
+                // found a SCP for the input key; see if we should handle it:
                 if (!HandleInternal(e, original, pair, out result))
                 {
                     return false;
                 }
             }
             else if (e.Character == '\b')
             {
+                // backspace - see if SCP logic needs to intervene:
                 foreach (var scp in _selfClosingPairs)
                 {
                     if (HandleInternal(e, original, scp, out result))
@@ -70,9 +84,11 @@ public override bool Handle(AutoCompleteEventArgs e, AutoCompleteSettings settin
 
             if (result == null)
             {
+                // no meaningful output; let the input be handled by another handler, maybe.
                 return false;
             }
 
+            // 1-based selection span in the code pane starts at column 1 but really encompasses the entire line.
             var snippetPosition = new Selection(result.SnippetPosition.StartLine, 1, result.SnippetPosition.EndLine, 1);
             result = new CodeString(result.Code, result.CaretPosition, snippetPosition);
 
@@ -82,13 +98,6 @@ public override bool Handle(AutoCompleteEventArgs e, AutoCompleteSettings settin
 
         private bool HandleInternal(AutoCompleteEventArgs e, CodeString original, SelfClosingPair pair, out CodeString result)
         {
-            if (!original.CaretPosition.IsSingleCharacter)
-            {
-                // todo: WrapSelectionWith(pair)?
-                result = null;
-                return false;
-            }
-
             // if executing the SCP against the original code yields no result, we need to bail out.
             if (!_scpService.Execute(pair, original, e.Character, out result))
             {
@@ -115,21 +124,34 @@ private bool HandleInternal(AutoCompleteEventArgs e, CodeString original, SelfCl
                 );
             }
 
+            if (original.CaretLine.EndsWith(" ") && 
+                string.Equals(original.CaretLine, prettified.CaretLine + " ", StringComparison.InvariantCultureIgnoreCase))
+            {
+                prettified = original;
+            }
+
             // if executing the SCP against the prettified code yields no result, we need to bail out.
             if (!_scpService.Execute(pair, prettified, e.Character, out result))
             {
                 return false;
             }
 
             var reprettified = CodePaneHandler.Prettify(e.Module, result);
-            if (pair.OpeningChar == '(' && e.Character == pair.OpeningChar && !reprettified.Equals(result))
+            if (pair.OpeningChar == '(' && e.Character == pair.OpeningChar)
             {
+                if (string.Equals(reprettified.Code, result.Code, StringComparison.InvariantCultureIgnoreCase))
+                {
+                    e.Handled = true;
+                    result = reprettified;
+                    return true;
+                }
+
                 // VBE eats it. bail out but don't swallow the keypress.
                 e.Handled = false;
                 result = null;
                 return false;
             }
-            
+
             var currentLine = reprettified.Lines[reprettified.CaretPosition.StartLine];
             if (!string.IsNullOrWhiteSpace(currentLine) &&
                 currentLine.EndsWith(" ") &&

Rubberduck.Core/AutoComplete/Service/ShowIntelliSenseCommand.cs renamed to Rubberduck.Core/AutoComplete/ShowIntelliSenseCommand.cs

@@ -3,7 +3,7 @@
 using Rubberduck.UI.Command;
 using Rubberduck.VBEditor.SafeComWrappers.Abstract;
 
-namespace Rubberduck.AutoComplete.Service
+namespace Rubberduck.AutoComplete
 {
     public interface IShowIntelliSenseCommand
     {

Rubberduck.Core/AutoComplete/Service/SmartConcatenationHandler.cs renamed to Rubberduck.Core/AutoComplete/SmartConcat/SmartConcatenationHandler.cs

@@ -4,7 +4,7 @@
 using Rubberduck.VBEditor.Events;
 using Rubberduck.VBEditor.SourceCodeHandling;
 
-namespace Rubberduck.AutoComplete.Service
+namespace Rubberduck.AutoComplete.SmartConcat
 {
     /// <summary>
     /// Adds a line continuation when {ENTER} is pressed when inside a string literal.

Rubberduck.Core/Common/RubberduckHooks.cs

@@ -8,7 +8,6 @@
 using Rubberduck.VBEditor.SafeComWrappers.Abstract;
 using Rubberduck.VBEditor.WindowsApi;
 using Rubberduck.AutoComplete;
-using Rubberduck.AutoComplete.Service;
 
 namespace Rubberduck.Common
 {

Rubberduck.Core/UI/Settings/AutoCompleteSettings.xaml

@@ -130,6 +130,7 @@
                                        MaxNumber="{Binding Path=DataContext.ConcatMaxLinesMaxValue, RelativeSource={RelativeSource Self}}">
                     
                 </controls:NumberPicker>-->
+                <!--
                 <Label Margin="10" 
                        Content="{Resx ResxName=Rubberduck.Resources.Settings.AutoCompletesPage, Key=BlockCompletion}"
                        FontWeight="Bold" />
@@ -145,6 +146,7 @@
                           IsEnabled="{Binding EnableBlockCompletion}"
                           IsChecked="{Binding CompleteBlockOnTab}" 
                           Content="{Resx ResxName=Rubberduck.Resources.Settings.AutoCompletesPage, Key=CompleteBlockOnTab}" />
+                -->
             </StackPanel>
         </ScrollViewer>
     </Grid>

Rubberduck.Main/Root/RubberduckIoCInstaller.cs

@@ -41,7 +41,6 @@
 using Rubberduck.VBEditor.Events;
 using Rubberduck.VBEditor.Utility;
 using Rubberduck.AutoComplete;
-using Rubberduck.AutoComplete.Service;
 using Rubberduck.CodeAnalysis.CodeMetrics;
 using Rubberduck.Parsing.Rewriter;
 using Rubberduck.Parsing.VBA.ComReferenceLoading;