Make empty block inspections derive from the same base providing the listener base

MDoerner · MDoerner · commit 0a517ae5b5d8 · 2020-03-07T15:59:45.000+01:00
diff --git a/Rubberduck.CodeAnalysis/Inspections/Abstract/EmptyBlockInspectionBase.cs b/Rubberduck.CodeAnalysis/Inspections/Abstract/EmptyBlockInspectionBase.cs
@@ -0,0 +1,85 @@
+﻿using System.Collections.Generic;
+using System.Diagnostics;
+using Antlr4.Runtime;
+using Antlr4.Runtime.Tree;
+using Rubberduck.Parsing.Grammar;
+using Rubberduck.Parsing.VBA;
+
+namespace Rubberduck.Inspections.Abstract
+{
+    public abstract class EmptyBlockInspectionBase<TContext> : ParseTreeInspectionBase<TContext>
+        where TContext : ParserRuleContext
+    {
+        protected EmptyBlockInspectionBase(IDeclarationFinderProvider declarationFinderProvider) 
+            : base(declarationFinderProvider)
+        {}
+
+        protected class EmptyBlockInspectionListenerBase : InspectionListenerBase<TContext>
+        {
+            public void InspectBlockForExecutableStatements<T>(VBAParser.BlockContext block, T context) where T : TContext
+            {
+                if (!BlockContainsExecutableStatements(block))
+                {
+                    SaveContext(context);
+                }
+            }
+
+            private bool BlockContainsExecutableStatements(VBAParser.BlockContext block)
+            {
+                return block?.children != null && ContainsExecutableStatements(block.children);
+            }
+
+            private bool ContainsExecutableStatements(IList<IParseTree> blockChildren)
+            {
+                foreach (var child in blockChildren)
+                {
+                    if (child is VBAParser.BlockStmtContext blockStmt)
+                    {
+                        var mainBlockStmt = blockStmt.mainBlockStmt();
+
+                        if (mainBlockStmt == null)
+                        {
+                            continue;   //We have a lone line label, which is not executable.
+                        }
+
+                        Debug.Assert(mainBlockStmt.ChildCount == 1);
+
+                        // exclude variables and consts because they are not executable statements
+                        if (mainBlockStmt.GetChild(0) is VBAParser.VariableStmtContext ||
+                            mainBlockStmt.GetChild(0) is VBAParser.ConstStmtContext)
+                        {
+                            continue;
+                        }
+
+                        return true;
+                    }
+
+                    if (child is VBAParser.RemCommentContext ||
+                        child is VBAParser.CommentContext ||
+                        child is VBAParser.CommentOrAnnotationContext ||
+                        child is VBAParser.EndOfStatementContext)
+                    {
+                        continue;
+                    }
+
+                    return true;
+                }
+
+                return false;
+            }
+
+            public void InspectBlockForExecutableStatements<T>(VBAParser.UnterminatedBlockContext block, T context) where T : TContext
+            {
+                if (!BlockContainsExecutableStatements(block))
+                {
+                    SaveContext(context);
+                }
+            }
+
+            private bool BlockContainsExecutableStatements(VBAParser.UnterminatedBlockContext block)
+            {
+                return block?.children != null && ContainsExecutableStatements(block.children);
+            }
+        }
+    }
+}
diff --git a/Rubberduck.CodeAnalysis/Inspections/Concrete/EmptyBlock/EmptyCaseBlockInspection.cs b/Rubberduck.CodeAnalysis/Inspections/Concrete/EmptyBlock/EmptyCaseBlockInspection.cs
@@ -40,7 +40,7 @@ namespace Rubberduck.Inspections.Concrete
     /// ]]>
     /// </example>
     [Experimental(nameof(ExperimentalNames.EmptyBlockInspections))]
-    internal sealed class EmptyCaseBlockInspection : ParseTreeInspectionBase<VBAParser.CaseClauseContext>
+    internal sealed class EmptyCaseBlockInspection : EmptyBlockInspectionBase<VBAParser.CaseClauseContext>
     {
         public EmptyCaseBlockInspection(IDeclarationFinderProvider declarationFinderProvider)
             : base(declarationFinderProvider)
@@ -55,7 +55,7 @@ protected override string ResultDescription(QualifiedContext<VBAParser.CaseClaus
             return InspectionResults.EmptyCaseBlockInspection;
         }
 
-        private class EmptyCaseBlockListener : EmptyBlockInspectionListenerBase<VBAParser.CaseClauseContext>
+        private class EmptyCaseBlockListener : EmptyBlockInspectionListenerBase
         {
             public override void EnterCaseClause([NotNull] VBAParser.CaseClauseContext context)
             {
diff --git a/Rubberduck.CodeAnalysis/Inspections/Concrete/EmptyBlock/EmptyDoWhileBlockInspection.cs b/Rubberduck.CodeAnalysis/Inspections/Concrete/EmptyBlock/EmptyDoWhileBlockInspection.cs
@@ -35,7 +35,7 @@ namespace Rubberduck.Inspections.Concrete
     /// ]]>
     /// </example>
     [Experimental(nameof(ExperimentalNames.EmptyBlockInspections))]
-    internal sealed class EmptyDoWhileBlockInspection : ParseTreeInspectionBase<VBAParser.DoLoopStmtContext>
+    internal sealed class EmptyDoWhileBlockInspection : EmptyBlockInspectionBase<VBAParser.DoLoopStmtContext>
     {
         public EmptyDoWhileBlockInspection(IDeclarationFinderProvider declarationFinderProvider)
             : base(declarationFinderProvider)
@@ -50,7 +50,7 @@ protected override string ResultDescription(QualifiedContext<VBAParser.DoLoopStm
             return InspectionResults.EmptyDoWhileBlockInspection;
         }
 
-        private class EmptyDoWhileBlockListener : EmptyBlockInspectionListenerBase<VBAParser.DoLoopStmtContext>
+        private class EmptyDoWhileBlockListener : EmptyBlockInspectionListenerBase
         {
             public override void EnterDoLoopStmt([NotNull] VBAParser.DoLoopStmtContext context)
             {
diff --git a/Rubberduck.CodeAnalysis/Inspections/Concrete/EmptyBlock/EmptyElseBlockInspection.cs b/Rubberduck.CodeAnalysis/Inspections/Concrete/EmptyBlock/EmptyElseBlockInspection.cs
@@ -37,7 +37,7 @@ namespace Rubberduck.Inspections.Concrete
     /// ]]>
     /// </example>
     [Experimental(nameof(ExperimentalNames.EmptyBlockInspections))]
-    internal sealed class EmptyElseBlockInspection : ParseTreeInspectionBase<VBAParser.ElseBlockContext>
+    internal sealed class EmptyElseBlockInspection : EmptyBlockInspectionBase<VBAParser.ElseBlockContext>
     {
         public EmptyElseBlockInspection(IDeclarationFinderProvider declarationFinderProvider)
             : base(declarationFinderProvider)
@@ -52,7 +52,7 @@ protected override string ResultDescription(QualifiedContext<VBAParser.ElseBlock
             return InspectionResults.EmptyElseBlockInspection;
         }
 
-        private class EmptyElseBlockListener : EmptyBlockInspectionListenerBase<VBAParser.ElseBlockContext>
+        private class EmptyElseBlockListener : EmptyBlockInspectionListenerBase
         {
             public override void EnterElseBlock([NotNull] VBAParser.ElseBlockContext context)
             {
diff --git a/Rubberduck.CodeAnalysis/Inspections/Concrete/EmptyBlock/EmptyForEachBlockInspection.cs b/Rubberduck.CodeAnalysis/Inspections/Concrete/EmptyBlock/EmptyForEachBlockInspection.cs
@@ -37,7 +37,7 @@ namespace Rubberduck.Inspections.Concrete
     /// ]]>
     /// </example>
     [Experimental(nameof(ExperimentalNames.EmptyBlockInspections))]
-    internal sealed class EmptyForEachBlockInspection : ParseTreeInspectionBase<VBAParser.ForEachStmtContext>
+    internal sealed class EmptyForEachBlockInspection : EmptyBlockInspectionBase<VBAParser.ForEachStmtContext>
     {
         public EmptyForEachBlockInspection(IDeclarationFinderProvider declarationFinderProvider)
             : base(declarationFinderProvider)
@@ -52,7 +52,7 @@ protected override string ResultDescription(QualifiedContext<VBAParser.ForEachSt
             return InspectionResults.EmptyForEachBlockInspection;
         }
 
-        private class EmptyForEachBlockListener : EmptyBlockInspectionListenerBase<VBAParser.ForEachStmtContext>
+        private class EmptyForEachBlockListener : EmptyBlockInspectionListenerBase
         {
             public override void EnterForEachStmt([NotNull] VBAParser.ForEachStmtContext context)
             {
diff --git a/Rubberduck.CodeAnalysis/Inspections/Concrete/EmptyBlock/EmptyForLoopBlockInspection.cs b/Rubberduck.CodeAnalysis/Inspections/Concrete/EmptyBlock/EmptyForLoopBlockInspection.cs
@@ -37,7 +37,7 @@ namespace Rubberduck.Inspections.Concrete
     /// ]]>
     /// </example>
     [Experimental(nameof(ExperimentalNames.EmptyBlockInspections))]
-    internal sealed class EmptyForLoopBlockInspection : ParseTreeInspectionBase<VBAParser.ForNextStmtContext>
+    internal sealed class EmptyForLoopBlockInspection : EmptyBlockInspectionBase<VBAParser.ForNextStmtContext>
     {
         public EmptyForLoopBlockInspection(IDeclarationFinderProvider declarationFinderProvider)
             : base(declarationFinderProvider)
@@ -52,7 +52,7 @@ protected override string ResultDescription(QualifiedContext<VBAParser.ForNextSt
             return InspectionResults.EmptyForLoopBlockInspection;
         }
 
-        private class EmptyForLoopBlockListener : EmptyBlockInspectionListenerBase<VBAParser.ForNextStmtContext>
+        private class EmptyForLoopBlockListener : EmptyBlockInspectionListenerBase
         {
             public override void EnterForNextStmt([NotNull] VBAParser.ForNextStmtContext context)
             {
diff --git a/Rubberduck.CodeAnalysis/Inspections/Concrete/EmptyBlock/EmptyIfBlockInspection.cs b/Rubberduck.CodeAnalysis/Inspections/Concrete/EmptyBlock/EmptyIfBlockInspection.cs
@@ -34,7 +34,7 @@ namespace Rubberduck.Inspections.Concrete
     /// End Sub
     /// ]]>
     /// </example>
-    internal sealed class EmptyIfBlockInspection : ParseTreeInspectionBase<ParserRuleContext>
+    internal sealed class EmptyIfBlockInspection : EmptyBlockInspectionBase<ParserRuleContext>
     {
         public EmptyIfBlockInspection(IDeclarationFinderProvider declarationFinderProvider)
             : base(declarationFinderProvider)
@@ -49,7 +49,7 @@ protected override string ResultDescription(QualifiedContext<ParserRuleContext>
 
         protected override IInspectionListener<ParserRuleContext> ContextListener { get; }
 
-        private class EmptyIfBlockListener : EmptyBlockInspectionListenerBase<ParserRuleContext>
+        private class EmptyIfBlockListener : EmptyBlockInspectionListenerBase
         {
             public override void EnterIfStmt([NotNull] VBAParser.IfStmtContext context)
             {
diff --git a/Rubberduck.CodeAnalysis/Inspections/Concrete/EmptyBlock/EmptyWhileWendBlockInspection.cs b/Rubberduck.CodeAnalysis/Inspections/Concrete/EmptyBlock/EmptyWhileWendBlockInspection.cs
@@ -35,7 +35,7 @@ namespace Rubberduck.Inspections.Concrete
     /// ]]>
     /// </example>
     [Experimental(nameof(ExperimentalNames.EmptyBlockInspections))]
-    internal sealed class EmptyWhileWendBlockInspection : ParseTreeInspectionBase<VBAParser.WhileWendStmtContext>
+    internal sealed class EmptyWhileWendBlockInspection : EmptyBlockInspectionBase<VBAParser.WhileWendStmtContext>
     {
         public EmptyWhileWendBlockInspection(IDeclarationFinderProvider declarationFinderProvider)
             : base(declarationFinderProvider)
@@ -50,7 +50,7 @@ protected override string ResultDescription(QualifiedContext<VBAParser.WhileWend
             return InspectionResults.EmptyWhileWendBlockInspection;
         }
 
-        private class EmptyWhileWendBlockListener : EmptyBlockInspectionListenerBase<VBAParser.WhileWendStmtContext>
+        private class EmptyWhileWendBlockListener : EmptyBlockInspectionListenerBase
         {
             public override void EnterWhileWendStmt([NotNull] VBAParser.WhileWendStmtContext context)
             {
diff --git a/Rubberduck.CodeAnalysis/Inspections/Concrete/EmptyBlockInspectionListenerBase.cs b/Rubberduck.CodeAnalysis/Inspections/Concrete/EmptyBlockInspectionListenerBase.cs

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ namespace Rubberduck.Inspections.Concrete`
`40`	`40`	`/// ]]>`
`41`	`41`	`/// </example>`
`42`	`42`	`[Experimental(nameof(ExperimentalNames.EmptyBlockInspections))]`
`43`		`- internal sealed class EmptyCaseBlockInspection : ParseTreeInspectionBase<VBAParser.CaseClauseContext>`
	`43`	`+ internal sealed class EmptyCaseBlockInspection : EmptyBlockInspectionBase<VBAParser.CaseClauseContext>`
`44`	`44`	`{`
`45`	`45`	`public EmptyCaseBlockInspection(IDeclarationFinderProvider declarationFinderProvider)`
`46`	`46`	`: base(declarationFinderProvider)`
`@@ -55,7 +55,7 @@ protected override string ResultDescription(QualifiedContext<VBAParser.CaseClaus`
`55`	`55`	`return InspectionResults.EmptyCaseBlockInspection;`
`56`	`56`	`}`
`57`	`57`
`58`		`- private class EmptyCaseBlockListener : EmptyBlockInspectionListenerBase<VBAParser.CaseClauseContext>`
	`58`	`+ private class EmptyCaseBlockListener : EmptyBlockInspectionListenerBase`
`59`	`59`	`{`
`60`	`60`	`public override void EnterCaseClause([NotNull] VBAParser.CaseClauseContext context)`
`61`	`61`	`{`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ namespace Rubberduck.Inspections.Concrete`
`35`	`35`	`/// ]]>`
`36`	`36`	`/// </example>`
`37`	`37`	`[Experimental(nameof(ExperimentalNames.EmptyBlockInspections))]`
`38`		`- internal sealed class EmptyDoWhileBlockInspection : ParseTreeInspectionBase<VBAParser.DoLoopStmtContext>`
	`38`	`+ internal sealed class EmptyDoWhileBlockInspection : EmptyBlockInspectionBase<VBAParser.DoLoopStmtContext>`
`39`	`39`	`{`
`40`	`40`	`public EmptyDoWhileBlockInspection(IDeclarationFinderProvider declarationFinderProvider)`
`41`	`41`	`: base(declarationFinderProvider)`
`@@ -50,7 +50,7 @@ protected override string ResultDescription(QualifiedContext<VBAParser.DoLoopStm`
`50`	`50`	`return InspectionResults.EmptyDoWhileBlockInspection;`
`51`	`51`	`}`
`52`	`52`
`53`		`- private class EmptyDoWhileBlockListener : EmptyBlockInspectionListenerBase<VBAParser.DoLoopStmtContext>`
	`53`	`+ private class EmptyDoWhileBlockListener : EmptyBlockInspectionListenerBase`
`54`	`54`	`{`
`55`	`55`	`public override void EnterDoLoopStmt([NotNull] VBAParser.DoLoopStmtContext context)`
`56`	`56`	`{`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ namespace Rubberduck.Inspections.Concrete`
`37`	`37`	`/// ]]>`
`38`	`38`	`/// </example>`
`39`	`39`	`[Experimental(nameof(ExperimentalNames.EmptyBlockInspections))]`
`40`		`- internal sealed class EmptyElseBlockInspection : ParseTreeInspectionBase<VBAParser.ElseBlockContext>`
	`40`	`+ internal sealed class EmptyElseBlockInspection : EmptyBlockInspectionBase<VBAParser.ElseBlockContext>`
`41`	`41`	`{`
`42`	`42`	`public EmptyElseBlockInspection(IDeclarationFinderProvider declarationFinderProvider)`
`43`	`43`	`: base(declarationFinderProvider)`
`@@ -52,7 +52,7 @@ protected override string ResultDescription(QualifiedContext<VBAParser.ElseBlock`
`52`	`52`	`return InspectionResults.EmptyElseBlockInspection;`
`53`	`53`	`}`
`54`	`54`
`55`		`- private class EmptyElseBlockListener : EmptyBlockInspectionListenerBase<VBAParser.ElseBlockContext>`
	`55`	`+ private class EmptyElseBlockListener : EmptyBlockInspectionListenerBase`
`56`	`56`	`{`
`57`	`57`	`public override void EnterElseBlock([NotNull] VBAParser.ElseBlockContext context)`
`58`	`58`	`{`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ namespace Rubberduck.Inspections.Concrete`
`34`	`34`	`/// End Sub`
`35`	`35`	`/// ]]>`
`36`	`36`	`/// </example>`
`37`		`- internal sealed class EmptyIfBlockInspection : ParseTreeInspectionBase<ParserRuleContext>`
	`37`	`+ internal sealed class EmptyIfBlockInspection : EmptyBlockInspectionBase<ParserRuleContext>`
`38`	`38`	`{`
`39`	`39`	`public EmptyIfBlockInspection(IDeclarationFinderProvider declarationFinderProvider)`
`40`	`40`	`: base(declarationFinderProvider)`
`@@ -49,7 +49,7 @@ protected override string ResultDescription(QualifiedContext<ParserRuleContext>`
`49`	`49`
`50`	`50`	`protected override IInspectionListener<ParserRuleContext> ContextListener { get; }`
`51`	`51`
`52`		`- private class EmptyIfBlockListener : EmptyBlockInspectionListenerBase<ParserRuleContext>`
	`52`	`+ private class EmptyIfBlockListener : EmptyBlockInspectionListenerBase`
`53`	`53`	`{`
`54`	`54`	`public override void EnterIfStmt([NotNull] VBAParser.IfStmtContext context)`
`55`	`55`	`{`