Merge pull request #4417 from Hosch250/issue4166

On local error inspection

Author: Hosch250

Rubberduck.CodeAnalysis/Inspections/Concrete/OnLocalErrorInspection.cs

@@ -0,0 +1,54 @@
+using System.Collections.Generic;
+using System.Linq;
+using Antlr4.Runtime;
+using Rubberduck.Inspections.Abstract;
+using Rubberduck.Inspections.Results;
+using Rubberduck.Parsing;
+using Rubberduck.Parsing.Grammar;
+using Rubberduck.Parsing.Inspections.Abstract;
+using Rubberduck.Resources.Inspections;
+using Rubberduck.Parsing.VBA;
+using Rubberduck.VBEditor;
+using Antlr4.Runtime.Misc;
+
+namespace Rubberduck.Inspections.Concrete
+{
+    public sealed class OnLocalErrorInspection : ParseTreeInspectionBase
+    {
+        public OnLocalErrorInspection(RubberduckParserState state)
+            : base(state) { }
+
+        public override IInspectionListener Listener { get; } =
+            new OnLocalErrorListener();
+
+        protected override IEnumerable<IInspectionResult> DoGetInspectionResults()
+        {
+            return Listener.Contexts
+                .Where(result => !IsIgnoringInspectionResultFor(result.ModuleName, result.Context.Start.Line))
+                .Select(result => new QualifiedContextInspectionResult(this,
+                                                       InspectionResults.OnLocalErrorInspection,
+                                                       result));
+        }
+
+        public class OnLocalErrorListener : VBAParserBaseListener, IInspectionListener
+        {
+            private readonly List<QualifiedContext<ParserRuleContext>> _contexts = new List<QualifiedContext<ParserRuleContext>>();
+            public IReadOnlyList<QualifiedContext<ParserRuleContext>> Contexts => _contexts;
+            
+            public QualifiedModuleName CurrentModuleName { get; set; }
+
+            public void ClearContexts()
+            {
+                _contexts.Clear();
+            }
+
+            public override void ExitOnErrorStmt([NotNull] VBAParser.OnErrorStmtContext context)
+            {
+                if (context.ON_LOCAL_ERROR() != null)
+                {
+                    _contexts.Add(new QualifiedContext<ParserRuleContext>(CurrentModuleName, context));
+                }
+            }
+        }
+    }
+}

Rubberduck.CodeAnalysis/QuickFixes/RemoveLocalErrorQuickFix.cs

@@ -0,0 +1,33 @@
+using Rubberduck.Inspections.Abstract;
+using Rubberduck.Inspections.Concrete;
+using Rubberduck.Parsing.Grammar;
+using Rubberduck.Parsing.Inspections.Abstract;
+using Rubberduck.Parsing.VBA;
+
+namespace Rubberduck.Inspections.QuickFixes
+{
+    public sealed class RemoveLocalErrorQuickFix : QuickFixBase
+    {
+        private readonly RubberduckParserState _state;
+
+        public RemoveLocalErrorQuickFix(RubberduckParserState state)
+            : base(typeof(OnLocalErrorInspection))
+        {
+            _state = state;
+        }
+
+        public override void Fix(IInspectionResult result)
+        {
+            var errorStmt = (VBAParser.OnErrorStmtContext)result.Context;
+
+            var rewriter = _state.GetRewriter(result.QualifiedSelection.QualifiedName);
+            rewriter.Replace(errorStmt.ON_LOCAL_ERROR(), Tokens.On + " " + Tokens.Error);
+        }
+
+        public override string Description(IInspectionResult result) => Resources.Inspections.QuickFixes.RemoveLocalErrorQuickFix;
+
+        public override bool CanFixInProcedure => true;
+        public override bool CanFixInModule => true;
+        public override bool CanFixInProject => true;
+    }
+}

Rubberduck.CodeAnalysis/Rubberduck.CodeAnalysis.csproj

@@ -81,6 +81,7 @@
     <Compile Include="Inspections\Concrete\EmptyForEachBlockInspection.cs" />
     <Compile Include="Inspections\Concrete\EmptyForLoopBlockInspection.cs" />
     <Compile Include="Inspections\Concrete\BooleanAssignedInIfElseInspection.cs" />
+    <Compile Include="Inspections\Concrete\OnLocalErrorInspection.cs" />
     <Compile Include="Inspections\Concrete\ModuleWithoutFolderInspection.cs" />
     <Compile Include="Inspections\Concrete\EmptyWhileWendBlockInspection.cs" />
     <Compile Include="Inspections\Concrete\ObsoleteCallingConventionInspection.cs" />
@@ -157,6 +158,7 @@
     <Compile Include="Inspections\Concrete\ProcedureNotUsedInspection.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="QuickFixes\AccessSheetUsingCodeNameQuickFix.cs" />
+    <Compile Include="QuickFixes\RemoveLocalErrorQuickFix.cs" />
     <Compile Include="QuickFixes\RemoveDuplicatedAnnotationQuickFix.cs" />
     <Compile Include="QuickFixes\ReplaceIfElseWithConditionalStatementQuickFix.cs" />
     <Compile Include="QuickFixes\AddIdentifierToWhiteListQuickFix.cs" />

Rubberduck.Core/Properties/Settings.Designer.cs

@@ -280,6 +280,7 @@
     <CodeInspection Name="ObsoleteCallingConventionInspection" Severity="Warning" InspectionType="CodeQualityIssues" />
     <CodeInspection Name="DuplicatedAnnotationInspection" Severity="Error" InspectionType="RubberduckOpportunities" />
     <CodeInspection Name="ModuleWithoutFolderInspection" Severity="Suggestion" InspectionType="RubberduckOpportunities" />
+    <CodeInspection Name="OnLocalErrorInspection" Severity="Suggestion" InspectionType="LanguageOpportunities" />
   </CodeInspections>
   <WhitelistedIdentifiers />
   <RunInspectionsOnSuccessfulParse>true</RunInspectionsOnSuccessfulParse>

Rubberduck.Core/Properties/Settings.settings

@@ -404,6 +404,8 @@
                 InspectionType="RubberduckOpportunities" />
               <CodeInspection Name="ModuleWithoutFolderInspection" Severity="Suggestion"
                 InspectionType="RubberduckOpportunities" />
+              <CodeInspection Name="OnLocalErrorInspection" Severity="Suggestion"
+                InspectionType="LanguageOpportunities" />
             </CodeInspections>
             <WhitelistedIdentifiers />
             <RunInspectionsOnSuccessfulParse>true</RunInspectionsOnSuccessfulParse>

Rubberduck.Core/app.config

@@ -337,4 +337,7 @@ If the parameter can be null, ignore this inspection result; passing a null valu
   <data name="ModuleWithoutFolderInspection" xml:space="preserve">
     <value>Modules without the '@Folder' annotation cannot receive custom groupings in the Code Explorer. </value>
   </data>
+  <data name="OnLocalErrorInspection" xml:space="preserve">
+    <value>On Local Error exists only for compatibility with previous versions of Visual Basic, and all Errors are treated as Local regardless of the Error statement. Use of this keyword inaccurately gives the impression that there is a distinction between types of error handling when there is not.</value>
+  </data>
 </root>

Rubberduck.Resources/Inspections/InspectionInfo.Designer.cs

@@ -336,4 +336,7 @@
   <data name="ModuleWithoutFolderInspection" xml:space="preserve">
     <value>Module without '@Folder' annotation</value>
   </data>
+  <data name="OnLocalErrorInspection" xml:space="preserve">
+    <value>On Local Error statement</value>
+  </data>
 </root>