Merge branch 'master' of https://github.com/retailcoder/Rubberduck into source_control

Author: rubberduck203

RetailCoder.VBE/Inspections/ImplicitByRefParameterInspection.cs

@@ -24,7 +24,7 @@ public IEnumerable<CodeInspectionResultBase> GetInspectionResults(IEnumerable<VB
         {
             foreach (var module in parseResult)
             {
-                var procedures = (IEnumerable<ParserRuleContext>) module.ParseTree.GetContexts<ProcedureListener, ParserRuleContext>(new ProcedureListener());
+                var procedures = module.ParseTree.GetContexts<ProcedureListener, ParserRuleContext>(new ProcedureListener());
                 foreach (var procedure in procedures)
                 {
                     var args = GetArguments(procedure);

RetailCoder.VBE/Inspections/InspectionNames.Designer.cs

@@ -126,6 +126,9 @@
   <data name="MultipleDeclarations" xml:space="preserve">
     <value>Instruction contains multiple declarations</value>
   </data>
+  <data name="NonReturningFunction" xml:space="preserve">
+    <value>Function does not return anything</value>
+  </data>
   <data name="ObsoleteCall" xml:space="preserve">
     <value>Use of obsolete Call statement</value>
   </data>

RetailCoder.VBE/Inspections/InspectionNames.resx

@@ -0,0 +1,37 @@
+using System.Collections.Generic;
+using System.Linq;
+using Antlr4.Runtime;
+using Rubberduck.VBA;
+using Rubberduck.VBA.Grammar;
+using Rubberduck.VBA.Nodes;
+using Rubberduck.VBA.ParseTreeListeners;
+
+namespace Rubberduck.Inspections
+{
+    public class NonReturningFunctionInspection : IInspection
+    {
+        public NonReturningFunctionInspection()
+        {
+            Severity = CodeInspectionSeverity.Error;
+        }
+
+        public string Name { get { return InspectionNames.NonReturningFunction; } }
+        public CodeInspectionType InspectionType { get { return CodeInspectionType.CodeQualityIssues; } }
+        public CodeInspectionSeverity Severity { get; set; }
+
+        public IEnumerable<CodeInspectionResultBase> GetInspectionResults(IEnumerable<VBComponentParseResult> parseResult)
+        {
+            foreach (var module in parseResult)
+            {
+                var procedures = module.ParseTree.GetContexts<ProcedureListener, ParserRuleContext>(new ProcedureListener());
+                var functions = procedures.OfType<VisualBasic6Parser.FunctionStmtContext>()
+                    .Where(function => function.GetContexts<VariableAssignmentListener, VisualBasic6Parser.AmbiguousIdentifierContext>(new VariableAssignmentListener())
+                        .All(assignment => assignment.GetText() != function.ambiguousIdentifier().GetText()));
+                foreach (var unassignedFunction in functions)
+                {
+                    yield return new NonReturningFunctionInspectionResult(Name, Severity, new QualifiedContext<ParserRuleContext>(module.QualifiedName, unassignedFunction));
+                }
+            }
+        }
+    }
+}

RetailCoder.VBE/Inspections/NonReturningFunctionInspection.cs

@@ -0,0 +1,53 @@
+using System;
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.Linq;
+using Antlr4.Runtime;
+using Microsoft.Vbe.Interop;
+using Rubberduck.Extensions;
+using Rubberduck.VBA;
+using Rubberduck.VBA.Grammar;
+using Rubberduck.VBA.Nodes;
+
+namespace Rubberduck.Inspections
+{
+    public class NonReturningFunctionInspectionResult : CodeInspectionResultBase
+    {
+        public NonReturningFunctionInspectionResult(string inspection, CodeInspectionSeverity type, QualifiedContext<ParserRuleContext> qualifiedContext)
+            : base(inspection, type, qualifiedContext.QualifiedName, qualifiedContext.Context)
+        {
+        }
+
+        private new VisualBasic6Parser.FunctionStmtContext Context { get { return base.Context as VisualBasic6Parser.FunctionStmtContext; } }
+
+        public override IDictionary<string, Action<VBE>> GetQuickFixes()
+        {
+            return new Dictionary<string, Action<VBE>>
+            {
+                {"Convert function to procedure", ConvertFunctionToProcedure}
+            };
+        }
+
+        private void ConvertFunctionToProcedure(VBE vbe)
+        {
+            var visibility = Context.visibility() == null ? string.Empty : Context.visibility().GetText() + ' ';
+            var name = ' ' + Context.ambiguousIdentifier().GetText();
+            var args = Context.argList().GetText();
+            var asType = Context.asTypeClause() == null ? string.Empty : ' ' + Context.asTypeClause().GetText();
+
+            var oldSignature = visibility + Tokens.Function + name + args + asType;
+            var newSignature = visibility +  Tokens.Sub + name + args;
+
+            var procedure = Context.GetText();
+            var result = procedure.Replace(oldSignature, newSignature)
+                .Replace(Tokens.End + ' ' + Tokens.Function, Tokens.End + ' ' + Tokens.Sub)
+                .Replace(Tokens.Exit + ' ' + Tokens.Function, Tokens.Exit + ' ' + Tokens.Sub);
+
+            var module = vbe.FindCodeModules(QualifiedName).First();
+            var selection = Context.GetSelection();
+
+            module.DeleteLines(selection.StartLine, selection.LineCount);
+            module.InsertLines(selection.StartLine, result);
+        }
+    }
+}

RetailCoder.VBE/Inspections/NonReturningFunctionInspectionResult.cs

@@ -88,6 +88,8 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="Extensions\VbProjectExtensions.cs" />
+    <Compile Include="Inspections\NonReturningFunctionInspection.cs" />
+    <Compile Include="Inspections\NonReturningFunctionInspectionResult.cs" />
     <Compile Include="Inspections\ObsoleteCallStatementUsageInspection.cs" />
     <Compile Include="Inspections\ObsoleteCallStatementUsageInspectionResult.cs" />
     <Compile Include="Inspections\ObsoleteLetStatementUsageInspection.cs" />