Merge branch 'next' of https://github.com/comintern/Rubberduck.git

Author: comintern

RetailCoder.VBE/Common/UndocumentedAttribute.cs

@@ -0,0 +1,13 @@
+using System;
+
+namespace Rubberduck.Common
+{
+    /// <summary>
+    /// Mark a feature as undocumented.
+    /// </summary>
+    /// <remarks>The RubberduckWeb project may this attribute to filter viewable content.</remarks>
+    [AttributeUsage(AttributeTargets.Class)]
+    public class UndocumentedAttribute : Attribute
+    {
+    }
+}

RetailCoder.VBE/Inspections/IInspection.cs renamed to RetailCoder.VBE/Inspections/Abstract/IInspection.cs

@@ -2,7 +2,7 @@
 using System.Collections.Generic;
 using Rubberduck.Root;
 
-namespace Rubberduck.Inspections
+namespace Rubberduck.Inspections.Abstract
 {
     /// <summary>
     /// An interface that abstracts a runnable code inspection.

RetailCoder.VBE/Inspections/IInspectionModel.cs renamed to RetailCoder.VBE/Inspections/Abstract/IInspectionModel.cs

@@ -1,4 +1,6 @@
-namespace Rubberduck.Inspections
+using Rubberduck.Inspections.Resources;
+
+namespace Rubberduck.Inspections.Abstract
 {
     /// <summary>
     /// An interface that abstracts the data structure for a code inspection

RetailCoder.VBE/Inspections/Abstract/IInspectionResult.cs

@@ -0,0 +1,15 @@
+using System;
+using System.Collections.Generic;
+using Rubberduck.VBEditor;
+
+namespace Rubberduck.Inspections.Abstract
+{
+    public interface IInspectionResult : IComparable<IInspectionResult>, IComparable
+    {
+        IEnumerable<QuickFixBase> QuickFixes { get; }
+        string Description { get; }
+        QualifiedSelection QualifiedSelection { get; }
+        IInspection Inspection { get; }
+        object[] ToArray();
+    }
+}

RetailCoder.VBE/Inspections/Abstract/IInspector.cs

@@ -0,0 +1,13 @@
+using System;
+using System.Collections.Generic;
+using System.Threading;
+using System.Threading.Tasks;
+using Rubberduck.Parsing.VBA;
+
+namespace Rubberduck.Inspections.Abstract
+{
+    public interface IInspector : IDisposable
+    {
+        Task<IEnumerable<IInspectionResult>> FindIssuesAsync(RubberduckParserState state, CancellationToken token);
+    }
+}

RetailCoder.VBE/Inspections/Abstract/IParseTreeInspection.cs

@@ -0,0 +1,23 @@
+using System.Collections.Generic;
+using Antlr4.Runtime;
+using Rubberduck.Parsing;
+
+namespace Rubberduck.Inspections.Abstract
+{
+    public interface IParseTreeInspection : IInspection
+    {
+        /// <summary>
+        /// Parse tree inspections have their results property-injected.
+        /// </summary>
+        void SetResults(IEnumerable<QualifiedContext> results);
+    }
+
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <typeparam name="TContext"></typeparam>
+    public interface IParseTreeInspection<TContext> : IParseTreeInspection where TContext : ParserRuleContext
+    {
+        IEnumerable<QualifiedContext<TContext>> ParseTreeResults { get; }
+    }
+}

RetailCoder.VBE/Inspections/InspectionBase.cs renamed to RetailCoder.VBE/Inspections/Abstract/InspectionBase.cs

@@ -1,12 +1,13 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using Rubberduck.Inspections.Resources;
 using Rubberduck.Parsing.Annotations;
 using Rubberduck.Parsing.Symbols;
 using Rubberduck.Parsing.VBA;
 using Rubberduck.VBEditor.SafeComWrappers.Abstract;
 
-namespace Rubberduck.Inspections
+namespace Rubberduck.Inspections.Abstract
 {
     public abstract class InspectionBase : IInspection
     {

RetailCoder.VBE/Inspections/InspectionResultBase.cs renamed to RetailCoder.VBE/Inspections/Abstract/InspectionResultBase.cs

@@ -1,15 +1,16 @@
 using System.Collections.Generic;
 using System.Linq;
 using Antlr4.Runtime;
+using Rubberduck.Inspections.Resources;
 using Rubberduck.Parsing;
 using Rubberduck.Parsing.Symbols;
 using Rubberduck.UI;
 using Rubberduck.UI.Controls;
 using Rubberduck.VBEditor;
 
-namespace Rubberduck.Inspections
+namespace Rubberduck.Inspections.Abstract
 {
-    public abstract class InspectionResultBase : ICodeInspectionResult, INavigateSource
+    public abstract class InspectionResultBase : IInspectionResult, INavigateSource
     {
         protected InspectionResultBase(IInspection inspection, Declaration target)
             : this(inspection, target.QualifiedName.QualifiedModuleName, target.Context)
@@ -84,13 +85,13 @@ public QualifiedSelection QualifiedSelection
         /// <summary>
         /// Gets all available "quick fixes" for a code inspection result.
         /// </summary>
-        public virtual IEnumerable<CodeInspectionQuickFix> QuickFixes { get { return new CodeInspectionQuickFix[] {}; } }
+        public virtual IEnumerable<QuickFixBase> QuickFixes { get { return new QuickFixBase[] {}; } }
 
         public bool HasQuickFixes { get { return QuickFixes.Any(); } }
 
-        public virtual CodeInspectionQuickFix DefaultQuickFix { get { return QuickFixes.FirstOrDefault(); } }
+        public virtual QuickFixBase DefaultQuickFix { get { return QuickFixes.FirstOrDefault(); } }
 
-        public int CompareTo(ICodeInspectionResult other)
+        public int CompareTo(IInspectionResult other)
         {
             return Inspection.CompareTo(other.Inspection);
         }
@@ -115,25 +116,13 @@ public virtual NavigateCodeEventArgs GetNavigationArgs()
 
         public int CompareTo(object obj)
         {
-            return CompareTo(obj as ICodeInspectionResult);
+            return CompareTo(obj as IInspectionResult);
         }
 
         public object[] ToArray()
         {
             var module = QualifiedSelection.QualifiedName;
             return new object[] { Inspection.Severity.ToString(), module.ProjectName, module.ComponentName, Description, QualifiedSelection.Selection.StartLine, QualifiedSelection.Selection.StartColumn };
         }
-
-        public string ToCsvString()
-        {
-            var module = QualifiedSelection.QualifiedName;
-            return string.Format(
-                "\"{0}\",\"{1}\",\"{2}\",\"{3}\",{4}",
-                Inspection.Severity,
-                Description,
-                module.ProjectId,
-                module.ComponentName,
-                QualifiedSelection.Selection.StartLine);
-        }
     }
 }

RetailCoder.VBE/Inspections/CodeInspectionQuickFix.cs renamed to RetailCoder.VBE/Inspections/Abstract/QuickFixBase.cs

@@ -2,15 +2,15 @@
 using Antlr4.Runtime;
 using Rubberduck.VBEditor;
 
-namespace Rubberduck.Inspections
+namespace Rubberduck.Inspections.Abstract
 {
-    public abstract class CodeInspectionQuickFix
+    public abstract class QuickFixBase
     {
         private readonly ParserRuleContext _context;
         private readonly QualifiedSelection _selection;
         private readonly string _description;
 
-        public CodeInspectionQuickFix(ParserRuleContext context, QualifiedSelection selection, string description)
+        public QuickFixBase(ParserRuleContext context, QualifiedSelection selection, string description)
         {
             Dispatcher.CurrentDispatcher.Thread.CurrentCulture = UI.Settings.Settings.Culture;
             Dispatcher.CurrentDispatcher.Thread.CurrentUICulture = UI.Settings.Settings.Culture;

RetailCoder.VBE/Inspections/AssignedByValParameterInspection.cs

@@ -1,5 +1,8 @@
 using System.Collections.Generic;
 using System.Linq;
+using Rubberduck.Inspections.Abstract;
+using Rubberduck.Inspections.Resources;
+using Rubberduck.Inspections.Results;
 using Rubberduck.Parsing.Grammar;
 using Rubberduck.Parsing.Symbols;
 using Rubberduck.Parsing.VBA;