added autocompletion for #If...#EndIf blocks

rubberduck-vba · Jun 4, 2018 · c5ac600 · c5ac600
1 parent 07b15a5
commit c5ac600
Show file tree

Hide file tree

Showing 12 changed files with 54 additions and 8 deletions.
diff --git a/Rubberduck.Core/AutoComplete/AutoCompleteBlockBase.cs b/Rubberduck.Core/AutoComplete/AutoCompleteBlockBase.cs
@@ -1,6 +1,5 @@
-using Rubberduck.Parsing.Grammar;
+using Rubberduck.Parsing.VBA;
 using Rubberduck.SmartIndenter;
-using Rubberduck.VBEditor.ComManagement.TypeLibsAPI;
 using Rubberduck.VBEditor.Events;
 using System.Linq;
 using System.Text.RegularExpressions;
@@ -19,6 +18,7 @@ protected AutoCompleteBlockBase(IIndenterSettings indenterSettings, string input
         }
 
         protected virtual bool FindInputTokenAtBeginningOfCurrentLine => false;
+        protected virtual bool SkipPreCompilerDirective => true;
 
         protected readonly IIndenterSettings IndenterSettings;
 
@@ -30,22 +30,23 @@ protected AutoCompleteBlockBase(IIndenterSettings indenterSettings, string input
         private bool _executing;
         public override bool Execute(AutoCompleteEventArgs e)
         {
-            if (_executing)
+            if (_executing || (SkipPreCompilerDirective && e.OldCode.Trim().StartsWith("#")))
             {
                 return false;
             }
 
             var selection = e.CodePane.Selection;
             var stdIndent = IndentBody ? IndenterSettings.IndentSpaces : 0;
 
+            var pattern = SkipPreCompilerDirective
+                            ? $"\\b{InputToken}\\b"
+                            : $"{InputToken}\\b"; // word boundary marker (\b) would prevent matching the # character
+
             var isMatch = MatchInputTokenAtEndOfLineOnly 
                             ? e.OldCode.EndsWith(InputToken)
-                            : Regex.IsMatch(e.OldCode.Trim(), $"\\b{InputToken}\\b");
-
-            // todo: handle line-continuating and non-start-of-line comments
-            var isComment = e.OldCode.Trim().StartsWith("'") || e.OldCode.Trim().StartsWith(Tokens.Rem);
+                            : Regex.IsMatch(e.OldCode.Trim(), pattern);
 
-            if (!isComment && isMatch && (!ExecuteOnCommittedInputOnly || e.IsCommitted))
+            if (!e.OldCode.HasComment(out _) && isMatch && (!ExecuteOnCommittedInputOnly || e.IsCommitted))
             {
                 var indent = e.OldCode.TakeWhile(c => char.IsWhiteSpace(c)).Count();
                 using (var module = e.CodePane.CodeModule)

diff --git a/Rubberduck.Core/AutoComplete/AutoCompletePrecompilerIfBlock.cs b/Rubberduck.Core/AutoComplete/AutoCompletePrecompilerIfBlock.cs
@@ -0,0 +1,13 @@
+using Rubberduck.Parsing.Grammar;
+using Rubberduck.SmartIndenter;
+
+namespace Rubberduck.AutoComplete
+{
+    public class AutoCompletePrecompilerIfBlock : AutoCompleteBlockBase
+    {
+        public AutoCompletePrecompilerIfBlock(IIndenterSettings indenterSettings)
+            : base(indenterSettings, $"#{Tokens.If}", $"#{Tokens.End} {Tokens.If}") { }
+
+        protected override bool SkipPreCompilerDirective => false;
+    }
+}
diff --git a/Rubberduck.Core/Properties/Settings.Designer.cs b/Rubberduck.Core/Properties/Settings.Designer.cs
diff --git a/Rubberduck.Core/Properties/Settings.settings b/Rubberduck.Core/Properties/Settings.settings
@@ -270,6 +270,7 @@
     &lt;AutoComplete Key="AutoCompleteForBlock" IsEnabled="true" /&gt;
     &lt;AutoComplete Key="AutoCompleteIfBlock" IsEnabled="true" /&gt;
     &lt;AutoComplete Key="AutoCompleteOnErrorResumeNextBlock" IsEnabled="true" /&gt;
+    &lt;AutoComplete Key="AutoCompletePrecompilerIfBlock" IsEnabled="true" /&gt;
     &lt;AutoComplete Key="AutoCompleteSelectBlock" IsEnabled="true" /&gt;
     &lt;AutoComplete Key="AutoCompleteTypeBlock" IsEnabled="true" /&gt;
     &lt;AutoComplete Key="AutoCompleteWhileBlock" IsEnabled="true" /&gt;

diff --git a/Rubberduck.Core/Rubberduck.Core.csproj b/Rubberduck.Core/Rubberduck.Core.csproj
@@ -302,6 +302,7 @@
     <Compile Include="AutoComplete\AutoCompleteForBlock.cs" />
     <Compile Include="AutoComplete\AutoCompleteIfBlock.cs" />
     <Compile Include="AutoComplete\AutoCompleteOnErrorResumeNextBlock.cs" />
+    <Compile Include="AutoComplete\AutoCompletePrecompilerIfBlock.cs" />
     <Compile Include="AutoComplete\AutoCompleteSelectBlock.cs" />
     <Compile Include="AutoComplete\AutoCompleteTypeBlock.cs" />
     <Compile Include="AutoComplete\AutoCompleteWhileBlock.cs" />

diff --git a/Rubberduck.Core/app.config b/Rubberduck.Core/app.config
@@ -389,6 +389,7 @@
               <AutoComplete Key="AutoCompleteForBlock" IsEnabled="true" />
               <AutoComplete Key="AutoCompleteIfBlock" IsEnabled="true" />
               <AutoComplete Key="AutoCompleteOnErrorResumeNextBlock" IsEnabled="true" />
+              <AutoComplete Key="AutoCompletePrecompilerIfBlock" IsEnabled="true" />
               <AutoComplete Key="AutoCompleteSelectBlock" IsEnabled="true" />
               <AutoComplete Key="AutoCompleteTypeBlock" IsEnabled="true" />
               <AutoComplete Key="AutoCompleteWhileBlock" IsEnabled="true" />

diff --git a/Rubberduck.Resources/Settings/AutoCompletesPage.Designer.cs b/Rubberduck.Resources/Settings/AutoCompletesPage.Designer.cs
diff --git a/Rubberduck.Resources/Settings/AutoCompletesPage.cs.resx b/Rubberduck.Resources/Settings/AutoCompletesPage.cs.resx
@@ -144,6 +144,9 @@
   <data name="AutoCompleteOnErrorResumeNextBlockDescription" xml:space="preserve">
     <value>Treat 'On Error Resume Next...GoTo 0' as a block</value>
   </data>
+  <data name="AutoCompletePrecompilerIfBlockDescription" xml:space="preserve">
+    <value>Close precompiler '#If' blocks</value>
+  </data>
   <data name="AutoCompleteSelectBlockDescription" xml:space="preserve">
     <value>Close 'Select' blocks</value>
   </data>

diff --git a/Rubberduck.Resources/Settings/AutoCompletesPage.de.resx b/Rubberduck.Resources/Settings/AutoCompletesPage.de.resx
@@ -144,6 +144,9 @@
   <data name="AutoCompleteOnErrorResumeNextBlockDescription" xml:space="preserve">
     <value>Treat 'On Error Resume Next...GoTo 0' as a block</value>
   </data>
+  <data name="AutoCompletePrecompilerIfBlockDescription" xml:space="preserve">
+    <value>Close precompiler '#If' blocks</value>
+  </data>
   <data name="AutoCompleteSelectBlockDescription" xml:space="preserve">
     <value>Close 'Select' blocks</value>
   </data>

diff --git a/Rubberduck.Resources/Settings/AutoCompletesPage.fr.resx b/Rubberduck.Resources/Settings/AutoCompletesPage.fr.resx
@@ -144,6 +144,9 @@
   <data name="AutoCompleteOnErrorResumeNextBlockDescription" xml:space="preserve">
     <value>Traiter 'On Error Resume Next...GoTo 0' comme un bloc</value>
   </data>
+  <data name="AutoCompletePrecompilerIfBlockDescription" xml:space="preserve">
+    <value>Fermer les blocs '#If' (préprocesseur)</value>
+  </data>
   <data name="AutoCompleteSelectBlockDescription" xml:space="preserve">
     <value>Fermer les blocs 'Select'</value>
   </data>

diff --git a/Rubberduck.Resources/Settings/AutoCompletesPage.resx b/Rubberduck.Resources/Settings/AutoCompletesPage.resx
@@ -144,6 +144,9 @@
   <data name="AutoCompleteOnErrorResumeNextBlockDescription" xml:space="preserve">
     <value>Treat 'On Error Resume Next...GoTo 0' as a block</value>
   </data>
+  <data name="AutoCompletePrecompilerIfBlockDescription" xml:space="preserve">
+    <value>Close precompiler '#If' blocks</value>
+  </data>
   <data name="AutoCompleteSelectBlockDescription" xml:space="preserve">
     <value>Close 'Select' blocks</value>
   </data>

diff --git a/Rubberduck.VBEEditor/Events/AutoCompleteEventArgs.cs b/Rubberduck.VBEEditor/Events/AutoCompleteEventArgs.cs
@@ -16,10 +16,12 @@ public AutoCompleteEventArgs(ICodePane pane)
                 if (string.IsNullOrWhiteSpace(atSelection))
                 {
                     IsCommitted = true;
+                    OldPrecedingLine = module.GetLines(selection.PreviousLine.PreviousLine);
                     OldCode = module.GetLines(selection.PreviousLine);
                 }
                 else
                 {
+                    OldPrecedingLine = module.GetLines(selection.PreviousLine);
                     OldCode = module.GetLines(selection);
                 }
             }
@@ -48,6 +50,11 @@ public AutoCompleteEventArgs(ICodePane pane)
         /// </summary>
         public string OldCode { get; }
 
+        /// <summary>
+        /// The line of code immediately above <see cref="OldCode"/>; used to determine whether we're looking at a line-continuated comment.
+        /// </summary>
+        public string OldPrecedingLine { get; }
+
         /// <summary>
         /// The autocompleted line of code, assigned by the autocomplete implementation. Used for caching, to prevent misfiring autocompletes.
         /// If autocomplete works off committed input, this should match the <see cref="OldCode"/>.