Merge pull request #4695 from MDoerner/InvalidateInspectionResultsAfterParsing

Invalidate inspection results after parsing

Author: Hosch250

Rubberduck.CodeAnalysis/Inspections/Abstract/InspectionBase.cs

@@ -166,5 +166,10 @@ public IEnumerable<IInspectionResult> GetInspectionResults(CancellationToken tok
             _logger.Trace("Intercepted invocation of '{0}.{1}' ran for {2}ms", GetType().Name, nameof(DoGetInspectionResults), _stopwatch.ElapsedMilliseconds);
             return result;
         }
+
+        public virtual bool ChangesInvalidateResult(IInspectionResult result, ICollection<QualifiedModuleName> modifiedModules)
+        {
+            return true;
+        }
     }
 }

Rubberduck.CodeAnalysis/Inspections/Abstract/InspectionResultBase.cs

@@ -1,4 +1,5 @@
-using System.IO;
+using System.Collections.Generic;
+using System.IO;
 using Antlr4.Runtime;
 using Rubberduck.Common;
 using Rubberduck.Parsing.Inspections;
@@ -39,6 +40,12 @@ protected InspectionResultBase(IInspection inspection,
         public Declaration Target { get; }
         public dynamic Properties { get; }
 
+        public virtual bool ChangesInvalidateResult(ICollection<QualifiedModuleName> modifiedModules)
+        {
+            return modifiedModules.Contains(QualifiedName) 
+                   || Inspection.ChangesInvalidateResult(this, modifiedModules);
+        }
+
         /// <summary>
         /// Gets the information needed to select the target instruction in the VBE.
         /// </summary>

Rubberduck.CodeAnalysis/Inspections/Results/DeclarationInspectionResult.cs

@@ -1,12 +1,13 @@
-using Rubberduck.Inspections.Abstract;
+using System.Collections.Generic;
+using Rubberduck.Inspections.Abstract;
 using Rubberduck.Parsing;
 using Rubberduck.Parsing.Inspections.Abstract;
 using Rubberduck.Parsing.Symbols;
 using Rubberduck.VBEditor;
 
 namespace Rubberduck.Inspections.Results
 {
-    internal class DeclarationInspectionResult : InspectionResultBase
+    public class DeclarationInspectionResult : InspectionResultBase
     {
         public DeclarationInspectionResult(IInspection inspection, string description, Declaration target, QualifiedContext context = null, dynamic properties = null) :
             base(inspection,
@@ -31,5 +32,11 @@ public DeclarationInspectionResult(IInspection inspection, string description, D
                 ? target.QualifiedName
                 : GetQualifiedMemberName(target.ParentDeclaration);
         }
+
+        public override bool ChangesInvalidateResult(ICollection<QualifiedModuleName> modifiedModules)
+        {
+            return modifiedModules.Contains(Target.QualifiedModuleName)
+                   || base.ChangesInvalidateResult(modifiedModules);
+        }
     }
 }

Rubberduck.CodeAnalysis/Inspections/Results/IdentifierReferenceInspectionResult.cs

@@ -1,4 +1,5 @@
-using System.Linq;
+using System.Collections.Generic;
+using System.Linq;
 using Rubberduck.Inspections.Abstract;
 using Rubberduck.Parsing;
 using Rubberduck.Parsing.Inspections.Abstract;
@@ -8,24 +9,30 @@
 
 namespace Rubberduck.Inspections.Results
 {
-    internal class IdentifierReferenceInspectionResult : InspectionResultBase
+    public class IdentifierReferenceInspectionResult : InspectionResultBase
     {
-        public IdentifierReferenceInspectionResult(IInspection inspection, string description, RubberduckParserState state, IdentifierReference reference, dynamic properties = null) :
+        public IdentifierReferenceInspectionResult(IInspection inspection, string description, IDeclarationFinderProvider declarationFinderProvider, IdentifierReference reference, dynamic properties = null) :
             base(inspection,
                  description,
                  reference.QualifiedModuleName,
                  reference.Context,
                  reference.Declaration,
                  new QualifiedSelection(reference.QualifiedModuleName, reference.Context.GetSelection()),
-                 GetQualifiedMemberName(state, reference),
+                 GetQualifiedMemberName(declarationFinderProvider, reference),
                  (object)properties)
         {
         }
 
-        private static QualifiedMemberName? GetQualifiedMemberName(RubberduckParserState state, IdentifierReference reference)
+        private static QualifiedMemberName? GetQualifiedMemberName(IDeclarationFinderProvider declarationFinderProvider, IdentifierReference reference)
         {
-            var members = state.DeclarationFinder.Members(reference.QualifiedModuleName);
+            var members = declarationFinderProvider.DeclarationFinder.Members(reference.QualifiedModuleName);
             return members.SingleOrDefault(m => reference.Context.IsDescendentOf(m.Context))?.QualifiedName;
         }
+
+        public override bool ChangesInvalidateResult(ICollection<QualifiedModuleName> modifiedModules)
+        {
+            return modifiedModules.Contains(Target.QualifiedModuleName)
+                || base.ChangesInvalidateResult(modifiedModules);
+        }
     }
 }

Rubberduck.CodeAnalysis/Inspections/Results/QualifiedContextInspectionResult.cs

@@ -5,7 +5,7 @@
 
 namespace Rubberduck.Inspections.Results
 {
-    internal class QualifiedContextInspectionResult : InspectionResultBase
+    public class QualifiedContextInspectionResult : InspectionResultBase
     {
         public QualifiedContextInspectionResult(IInspection inspection, string description, QualifiedContext context, dynamic properties = null) :
             base(inspection,
@@ -16,7 +16,6 @@ public QualifiedContextInspectionResult(IInspection inspection, string descripti
                  new QualifiedSelection(context.ModuleName, context.Context.GetSelection()),
                  context.MemberName,
                  (object)properties)
-        {
-        }
+        {}
     }
 }

Rubberduck.Core/UI/Inspections/AggregateInspectionResult.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using Antlr4.Runtime;
 using Rubberduck.Parsing.Inspections.Abstract;
 using Rubberduck.Parsing.Symbols;
@@ -29,6 +30,8 @@ public AggregateInspectionResult(IInspectionResult firstResult, int count)
 
         public dynamic Properties => throw new InvalidOperationException();
 
+        public virtual bool ChangesInvalidateResult(ICollection<QualifiedModuleName> modifiedModules) => true;
+
         public int CompareTo(IInspectionResult other)
         {
             if (other == this)

Rubberduck.Core/UI/Inspections/InspectionResultsViewModel.cs

@@ -14,10 +14,11 @@
 using Rubberduck.Parsing.Inspections.Abstract;
 using Rubberduck.Parsing.UIContext;
 using Rubberduck.Parsing.VBA;
+using Rubberduck.Parsing.VBA.Extensions;
 using Rubberduck.Settings;
 using Rubberduck.UI.Command;
-using Rubberduck.UI.Controls;
 using Rubberduck.UI.Settings;
+using Rubberduck.VBEditor;
 
 namespace Rubberduck.UI.Inspections
 {
@@ -383,6 +384,12 @@ private void HandleStateChanged(object sender, ParserStateEventArgs e)
             {
                 RefreshInspections(e.Token);
             }
+            else
+            {
+                //Todo: Find a way to get the actually modified modules in here.
+                var modifiedModules = _state.DeclarationFinder.AllModules.ToHashSet();
+                InvalidateStaleInspectionResults(modifiedModules);
+            }
         }
 
         private async void RefreshInspections(CancellationToken token)
@@ -442,6 +449,18 @@ private async void RefreshInspections(CancellationToken token)
             LogManager.GetCurrentClassLogger().Trace("Inspections loaded in {0}ms", stopwatch.ElapsedMilliseconds);
         }
 
+        private void InvalidateStaleInspectionResults(ICollection<QualifiedModuleName> modifiedModules)
+        {
+            var staleResults = Results.Where(result => result.ChangesInvalidateResult(modifiedModules)).ToList();
+            _uiDispatcher.Invoke(() =>
+            {
+                foreach (var staleResult in staleResults)
+                {
+                    Results.Remove(staleResult);
+                }
+            });
+        }
+
         private void ExecuteQuickFixCommand(object parameter)
         {
             var quickFix = parameter as IQuickFix;

Rubberduck.Parsing/Inspections/Abstract/IInspection.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Threading;
+using Rubberduck.VBEditor;
 
 namespace Rubberduck.Parsing.Inspections.Abstract
 {
@@ -15,5 +16,10 @@ public interface IInspection : IInspectionModel, IComparable<IInspection>, IComp
         /// <param name="token"></param>
         /// <returns>Returns inspection results, if any.</returns>
         IEnumerable<IInspectionResult> GetInspectionResults(CancellationToken token);
+
+        /// <summary>
+        /// Specifies whether an inspection result is deemed invalid after the specified modules have changed.
+        /// </summary>
+        bool ChangesInvalidateResult(IInspectionResult result, ICollection<QualifiedModuleName> modifiedModules);
     }
 }

Rubberduck.Parsing/Inspections/Abstract/IInspectionResult.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using Antlr4.Runtime;
 using Rubberduck.Parsing.Symbols;
 using Rubberduck.VBEditor;
@@ -14,5 +15,6 @@ public interface IInspectionResult : IComparable<IInspectionResult>, IComparable
         Declaration Target { get; }
         ParserRuleContext Context { get; }
         dynamic Properties { get; }
+        bool ChangesInvalidateResult(ICollection<QualifiedModuleName> modifiedModules);
     }
 }