Merge pull request #1715 from Hosch250/Issue1712

retailcoder · retailcoder · commit aeb361d3c016 · 2016-06-06T14:10:11.000-04:00
Fix Implicit Variant Function Return Type
diff --git a/RetailCoder.VBE/Inspections/ImplicitVariantReturnTypeInspectionResult.cs b/RetailCoder.VBE/Inspections/ImplicitVariantReturnTypeInspectionResult.cs
@@ -1,9 +1,12 @@
+using System;
 using System.Collections.Generic;
+using System.Linq;
 using Antlr4.Runtime;
+using Antlr4.Runtime.Tree;
 using Rubberduck.Parsing;
 using Rubberduck.Parsing.Grammar;
 using Rubberduck.Parsing.Symbols;
-using Rubberduck.Parsing.VBA.Nodes;
+using Rubberduck.Parsing.VBA;
 using Rubberduck.UI;
 using Rubberduck.VBEditor;
 
@@ -51,16 +54,12 @@ public SetExplicitVariantReturnTypeQuickFix(ParserRuleContext context, Qualified
 
         public override void Fix()
         {
-            // note: turns a multiline signature into a one-liner signature.
-            // bug: removes all comments.
-
-            var node = GetNode(Context as VBAParser.FunctionStmtContext)
-                    ?? GetNode(Context as VBAParser.PropertyGetStmtContext);
-
-            var signature = node.Signature.TrimEnd();
-
             var procedure = Context.GetText();
-            var result = procedure.Replace(signature, signature + ' ' + Tokens.As + ' ' + Tokens.Variant);
+            var indexOfLastClosingParen = procedure.LastIndexOf(')');
+
+            var result = indexOfLastClosingParen == procedure.Length
+                ? procedure + ' ' + Tokens.As + ' ' + Tokens.Variant
+                : procedure.Insert(procedure.LastIndexOf(')') + 1, ' ' + Tokens.As + ' ' + Tokens.Variant);
             
             var module = Selection.QualifiedName.Component.CodeModule;
             var selection = Context.GetSelection();
@@ -69,28 +68,49 @@ public override void Fix()
             module.InsertLines(selection.StartLine, result);
         }
 
-        private ProcedureNode GetNode(VBAParser.FunctionStmtContext context)
+        private string GetSignature(VBAParser.FunctionStmtContext context)
         {
             if (context == null)
             {
                 return null;
             }
 
-            var scope = Selection.QualifiedName.ToString();
-            var localScope = scope + "." + context.functionName().identifier().GetText();
-            return new ProcedureNode(context, scope, localScope);
+            var @static = context.STATIC() == null ? string.Empty : context.STATIC().GetText() + ' ';
+            var keyword = context.FUNCTION().GetText() + ' ';
+            var args = context.argList() == null ? "()" : context.argList().GetText() + ' ';
+            var asTypeClause = context.asTypeClause() == null ? string.Empty : context.asTypeClause().GetText();
+            var visibility = context.visibility() == null ? string.Empty : context.visibility().GetText() + ' ';
+
+            return visibility + @static + keyword + context.functionName().identifier().GetText() + args + asTypeClause;
         }
 
-        private ProcedureNode GetNode(VBAParser.PropertyGetStmtContext context)
+        private string GetSignature(VBAParser.PropertyGetStmtContext context)
         {
             if (context == null)
             {
                 return null;
             }
 
-            var scope = Selection.QualifiedName.ToString();
-            var localScope = scope + "." + context.functionName().identifier().GetText();
-            return new ProcedureNode(context, scope, localScope);
+            var @static = context.STATIC() == null ? string.Empty : context.STATIC().GetText() + ' ';
+            var keyword = context.PROPERTY_GET().GetText() + ' ';
+            var args = context.argList() == null ? "()" : context.argList().GetText() + ' ';
+            var asTypeClause = context.asTypeClause() == null ? string.Empty : context.asTypeClause().GetText();
+            var visibility = context.visibility() == null ? string.Empty : context.visibility().GetText() + ' ';
+
+            return visibility + @static + keyword + context.functionName().identifier().GetText() + args + asTypeClause;
+        }
+
+        private string GetSignature(VBAParser.DeclareStmtContext context)
+        {
+            if (context == null)
+            {
+                return null;
+            }
+
+            var args = context.argList() == null ? "()" : context.argList().GetText() + ' ';
+            var asTypeClause = context.asTypeClause() == null ? string.Empty : context.asTypeClause().GetText();
+
+            return args + asTypeClause;
         }
     }
 }
diff --git a/RetailCoder.VBE/Inspections/InspectionResultBase.cs b/RetailCoder.VBE/Inspections/InspectionResultBase.cs
@@ -2,7 +2,6 @@
 using System.Linq;
 using Antlr4.Runtime;
 using Rubberduck.Parsing;
-using Rubberduck.Parsing.Nodes;
 using Rubberduck.Parsing.Symbols;
 using Rubberduck.UI;
 using Rubberduck.UI.Controls;
diff --git a/RetailCoder.VBE/Inspections/ObsoleteCommentSyntaxInspectionResult.cs b/RetailCoder.VBE/Inspections/ObsoleteCommentSyntaxInspectionResult.cs
@@ -1,7 +1,7 @@
 ﻿using System.Collections.Generic;
 using Antlr4.Runtime;
 using Rubberduck.Parsing.Grammar;
-using Rubberduck.Parsing.Nodes;
+using Rubberduck.Parsing.Symbols;
 using Rubberduck.Parsing.VBA;
 using Rubberduck.VBEditor;
 
diff --git a/RetailCoder.VBE/Inspections/OptionBaseInspectionResult.cs b/RetailCoder.VBE/Inspections/OptionBaseInspectionResult.cs
@@ -1,5 +1,5 @@
 using Rubberduck.Parsing.Grammar;
-using Rubberduck.Parsing.Nodes;
+using Rubberduck.Parsing.Symbols;
 using Rubberduck.VBEditor;
 
 namespace Rubberduck.Inspections
diff --git a/RetailCoder.VBE/Inspections/OptionExplicitInspectionResult.cs b/RetailCoder.VBE/Inspections/OptionExplicitInspectionResult.cs
@@ -2,7 +2,7 @@
 using System.Collections.Generic;
 using Antlr4.Runtime;
 using Rubberduck.Parsing.Grammar;
-using Rubberduck.Parsing.Nodes;
+using Rubberduck.Parsing.Symbols;
 using Rubberduck.VBEditor;
 
 namespace Rubberduck.Inspections
diff --git a/RetailCoder.VBE/ToDoItems/ToDoItem.cs b/RetailCoder.VBE/ToDoItems/ToDoItem.cs
@@ -1,4 +1,4 @@
-﻿using Rubberduck.Parsing.Nodes;
+﻿using Rubberduck.Parsing.Symbols;
 using Rubberduck.UI;
 using Rubberduck.UI.Controls;
 using Rubberduck.VBEditor;
diff --git a/RetailCoder.VBE/UI/ToDoItems/ToDoExplorerViewModel.cs b/RetailCoder.VBE/UI/ToDoItems/ToDoExplorerViewModel.cs
@@ -3,14 +3,14 @@
 using System.Collections.ObjectModel;
 using System.Linq;
 using System.Windows.Input;
-using Rubberduck.Parsing.Nodes;
 using Rubberduck.Parsing.VBA;
 using Rubberduck.Settings;
 using Rubberduck.ToDoItems;
 using Rubberduck.UI.Command;
 using Rubberduck.UI.Controls;
 using Rubberduck.UI.Settings;
 using Rubberduck.Common;
+using Rubberduck.Parsing.Symbols;
 
 namespace Rubberduck.UI.ToDoItems
 {
diff --git a/Rubberduck.Parsing/Rubberduck.Parsing.csproj b/Rubberduck.Parsing/Rubberduck.Parsing.csproj
@@ -128,6 +128,7 @@
     <Compile Include="Preprocessing\VBAConditionalCompilationParserListener.cs" />
     <Compile Include="Preprocessing\VBAConditionalCompilationParserVisitor.cs" />
     <Compile Include="Symbols\ComInformation.cs" />
+    <Compile Include="Symbols\CommentNode.cs" />
     <Compile Include="Symbols\ComParameter.cs" />
     <Compile Include="Symbols\Identifier.cs" />
     <Compile Include="Binding\IBindingContext.cs" />
@@ -256,7 +257,6 @@
     <Compile Include="Symbols\ProjectReference.cs" />
     <Compile Include="Symbols\ReferencedDeclarationsCollector.cs" />
     <Compile Include="Symbols\SyntaxErrorException.cs" />
-    <Compile Include="Nodes\CommentNode.cs" />
     <Compile Include="ParserRuleContextExtensions.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="QualifiedContext.cs" />
@@ -277,7 +277,6 @@
     <Compile Include="VBA\ModuleState.cs" />
     <Compile Include="VBA\Nodes\INode.cs" />
     <Compile Include="VBA\Nodes\Node.cs" />
-    <Compile Include="VBA\Nodes\ProcedureNode.cs" />
     <Compile Include="VBA\ParseErrorEventArgs.cs" />
     <Compile Include="VBA\ParserState.cs" />
     <Compile Include="VBA\ReferencePriorityMap.cs" />
diff --git a/Rubberduck.Parsing/Symbols/CommentNode.cs b/Rubberduck.Parsing/Symbols/CommentNode.cs
@@ -1,6 +1,6 @@
 using Rubberduck.VBEditor;
 
-namespace Rubberduck.Parsing.Nodes
+namespace Rubberduck.Parsing.Symbols
 {
     /// <summary>
     /// Represents a comment.
diff --git a/Rubberduck.Parsing/Symbols/DeclarationFinder.cs b/Rubberduck.Parsing/Symbols/DeclarationFinder.cs
@@ -1,6 +1,5 @@
 using NLog;
 using Rubberduck.Parsing.Annotations;
-using Rubberduck.Parsing.Nodes;
 using Rubberduck.VBEditor;
 using System;
 using System.Collections.Generic;
diff --git a/Rubberduck.Parsing/Symbols/DeclarationSymbolsListener.cs b/Rubberduck.Parsing/Symbols/DeclarationSymbolsListener.cs
@@ -3,7 +3,6 @@
 using Microsoft.Vbe.Interop.Forms;
 using Rubberduck.Parsing.Annotations;
 using Rubberduck.Parsing.Grammar;
-using Rubberduck.Parsing.Nodes;
 using Rubberduck.Parsing.VBA;
 using Rubberduck.VBEditor;
 using System;
@@ -247,7 +246,7 @@ private Declaration CreateDeclaration(
                 }
                 else if (declarationType == DeclarationType.LibraryProcedure || declarationType == DeclarationType.LibraryFunction)
                 {
-                    result = new ExternalProcedureDeclaration(new QualifiedMemberName(_qualifiedName, identifierName), _parentDeclaration, _currentScopeDeclaration, declarationType, asTypeName, accessibility, context, selection, false, annotations);
+                    result = new ExternalProcedureDeclaration(new QualifiedMemberName(_qualifiedName, identifierName), _parentDeclaration, _currentScopeDeclaration, declarationType, asTypeName, asTypeContext, accessibility, context, selection, false, annotations);
                 }
                 else if (declarationType == DeclarationType.PropertyGet)
                 {
diff --git a/Rubberduck.Parsing/Symbols/ExternalProcedureDeclaration.cs b/Rubberduck.Parsing/Symbols/ExternalProcedureDeclaration.cs
@@ -3,6 +3,7 @@
 using Rubberduck.VBEditor;
 using System.Collections.Generic;
 using System.Linq;
+using Rubberduck.Parsing.Grammar;
 
 namespace Rubberduck.Parsing.Symbols
 {
@@ -16,6 +17,7 @@ public ExternalProcedureDeclaration(
             Declaration parentScope,
             DeclarationType declarationType,
             string asTypeName,
+            VBAParser.AsTypeClauseContext asTypeContext,
             Accessibility accessibility,
             ParserRuleContext context,
             Selection selection,
@@ -34,7 +36,7 @@ public ExternalProcedureDeclaration(
                   context,
                   selection,
                   false,
-                  null,
+                  asTypeContext,
                   isBuiltIn,
                   annotations,
                   null)
diff --git a/Rubberduck.Parsing/VBA/ComponentParseTask.cs b/Rubberduck.Parsing/VBA/ComponentParseTask.cs
@@ -5,7 +5,6 @@
 using NLog;
 using Rubberduck.Parsing.Annotations;
 using Rubberduck.Parsing.Grammar;
-using Rubberduck.Parsing.Nodes;
 using Rubberduck.Parsing.Preprocessing;
 using Rubberduck.Parsing.Symbols;
 using Rubberduck.VBEditor;
diff --git a/Rubberduck.Parsing/VBA/ModuleState.cs b/Rubberduck.Parsing/VBA/ModuleState.cs
@@ -5,7 +5,6 @@
 using Antlr4.Runtime;
 using Antlr4.Runtime.Tree;
 using Rubberduck.Parsing.Annotations;
-using Rubberduck.Parsing.Nodes;
 using Rubberduck.Parsing.Symbols;
 
 namespace Rubberduck.Parsing.VBA
diff --git a/Rubberduck.Parsing/VBA/Nodes/ProcedureNode.cs b/Rubberduck.Parsing/VBA/Nodes/ProcedureNode.cs
diff --git a/Rubberduck.Parsing/VBA/RubberduckParser.cs b/Rubberduck.Parsing/VBA/RubberduckParser.cs
@@ -13,7 +13,6 @@
 using System.Diagnostics;
 using Rubberduck.Parsing.Annotations;
 using Rubberduck.Parsing.Grammar;
-using Rubberduck.Parsing.Nodes;
 using Rubberduck.VBEditor.Extensions;
 using System.IO;
 using NLog;
diff --git a/Rubberduck.Parsing/VBA/RubberduckParserState.cs b/Rubberduck.Parsing/VBA/RubberduckParserState.cs
@@ -8,7 +8,6 @@
 using Antlr4.Runtime;
 using Antlr4.Runtime.Tree;
 using Microsoft.Vbe.Interop;
-using Rubberduck.Parsing.Nodes;
 using Rubberduck.Parsing.Symbols;
 using Rubberduck.VBEditor;
 using Rubberduck.Parsing.Annotations;
diff --git a/RubberduckTests/Inspections/ImplicitVariantReturnTypeInspectionTests.cs b/RubberduckTests/Inspections/ImplicitVariantReturnTypeInspectionTests.cs

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-using Rubberduck.Parsing.Nodes;`
	`1`	`+using Rubberduck.Parsing.Symbols;`
`2`	`2`	`using Rubberduck.UI;`
`3`	`3`	`using Rubberduck.UI.Controls;`
`4`	`4`	`using Rubberduck.VBEditor;`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`using Rubberduck.VBEditor;`
`2`	`2`
`3`		`-namespace Rubberduck.Parsing.Nodes`
	`3`	`+namespace Rubberduck.Parsing.Symbols`
`4`	`4`	`{`
`5`	`5`	`/// <summary>`
`6`	`6`	`/// Represents a comment.`