Merge pull request #4264 from comintern/parser

Make parser aware of CDecl, add inspection for its use

Author: retailcoder

Rubberduck.CodeAnalysis/Inspections/Concrete/ObsoleteCallingConventionInspection.cs

@@ -0,0 +1,54 @@
+using System.Collections.Generic;
+using System.Linq;
+using Antlr4.Runtime;
+using Rubberduck.Inspections.Abstract;
+using Rubberduck.Inspections.Results;
+using Rubberduck.Parsing;
+using Rubberduck.Parsing.Grammar;
+using Rubberduck.Parsing.Inspections.Abstract;
+using Rubberduck.Parsing.VBA;
+using Rubberduck.Resources.Inspections;
+using Rubberduck.VBEditor;
+
+namespace Rubberduck.Inspections.Inspections.Concrete
+{
+    public sealed class ObsoleteCallingConventionInspection : ParseTreeInspectionBase
+    {
+        public ObsoleteCallingConventionInspection(RubberduckParserState state)
+            : base(state)
+        {
+            Listener = new ObsoleteCallingConventionListener();
+        }
+
+        public override IInspectionListener Listener { get; }
+
+        protected override IEnumerable<IInspectionResult> DoGetInspectionResults()
+        {
+            return Listener.Contexts
+                .Where(context => ((VBAParser.DeclareStmtContext) context.Context).CDECL() != null &&
+                    !IsIgnoringInspectionResultFor(context.ModuleName, context.Context.Start.Line))
+                .Select(context => new QualifiedContextInspectionResult(this,
+                    string.Format(InspectionResults.ObsoleteCallingConventionInspection,
+                        ((VBAParser.DeclareStmtContext) context.Context).identifier().GetText()), context));
+        }
+
+        public class ObsoleteCallingConventionListener : VBAParserBaseListener, IInspectionListener
+        {
+            private readonly List<QualifiedContext<ParserRuleContext>> _contexts = new List<QualifiedContext<ParserRuleContext>>();
+            public IReadOnlyList<QualifiedContext<ParserRuleContext>> Contexts => _contexts;
+
+            public QualifiedModuleName CurrentModuleName { get; set; }
+
+            public void ClearContexts()
+            {
+                _contexts.Clear();
+            }
+
+            public override void ExitDeclareStmt(VBAParser.DeclareStmtContext context)
+            {
+                _contexts.Add(new QualifiedContext<ParserRuleContext>(CurrentModuleName, context));
+                base.ExitDeclareStmt(context);
+            }
+        }
+    }
+}

Rubberduck.CodeAnalysis/Rubberduck.CodeAnalysis.csproj

@@ -79,6 +79,7 @@
     <Compile Include="Inspections\Concrete\EmptyForLoopBlockInspection.cs" />
     <Compile Include="Inspections\Concrete\BooleanAssignedInIfElseInspection.cs" />
     <Compile Include="Inspections\Concrete\EmptyWhileWendBlockInspection.cs" />
+    <Compile Include="Inspections\Concrete\ObsoleteCallingConventionInspection.cs" />
     <Compile Include="Inspections\Concrete\ObsoleteErrorSyntaxInspection.cs" />
     <Compile Include="Inspections\Concrete\ObsoleteMemberUsageInspection.cs" />
     <Compile Include="Inspections\Concrete\SheetAccessedUsingStringInspection.cs" />

Rubberduck.Core/Properties/Settings.Designer.cs

@@ -277,6 +277,7 @@
     <CodeInspection Name="StepOneIsRedundantInspection" Severity="Hint" InspectionType="LanguageOpportunities" />
     <CodeInspection Name="SheetAccessedUsingStringInspection" Severity="Suggestion" InspectionType="LanguageOpportunities" />
     <CodeInspection Name="ObsoleteMemberUsageInspection" Severity="Warning" InspectionType="MaintainabilityAndReadabilityIssues" />
+    <CodeInspection Name="ObsoleteCallingConventionInspection" Severity="Warning" InspectionType="CodeQualityIssues" />
   </CodeInspections>
   <WhitelistedIdentifiers />
   <RunInspectionsOnSuccessfulParse>true</RunInspectionsOnSuccessfulParse>

Rubberduck.Core/Properties/Settings.settings

@@ -398,6 +398,8 @@
                 InspectionType="LanguageOpportunities" />
               <CodeInspection Name="ObsoleteMemberUsageInspection" Severity="Warning"
                 InspectionType="MaintainabilityAndReadabilityIssues" />
+              <CodeInspection Name="ObsoleteCallingConventionInspection" Severity="Warning"
+                InspectionType="CodeQualityIssues" />
             </CodeInspections>
             <WhitelistedIdentifiers />
             <RunInspectionsOnSuccessfulParse>true</RunInspectionsOnSuccessfulParse>

Rubberduck.Core/app.config

@@ -80,6 +80,7 @@ BYREF : B Y R E F;
 BYTE : B Y T E;
 CALL : C A L L;
 CASE : C A S E;
+CDECL : C D E C L;
 CLASS : C L A S S;
 CLOSE : C L O S E;
 CONST : C O N S T;

Rubberduck.Parsing/Grammar/VBALexer.g4

@@ -297,7 +297,7 @@ variable : expression;
 constStmt : (visibility whiteSpace)? CONST whiteSpace constSubStmt (whiteSpace? COMMA whiteSpace? constSubStmt)*;
 constSubStmt : identifier (whiteSpace asTypeClause)? whiteSpace? EQ whiteSpace? expression;
 
-declareStmt : (visibility whiteSpace)? DECLARE whiteSpace (PTRSAFE whiteSpace)? (FUNCTION | SUB) whiteSpace identifier whiteSpace LIB whiteSpace STRINGLITERAL (whiteSpace ALIAS whiteSpace STRINGLITERAL)? (whiteSpace? argList)? (whiteSpace asTypeClause)?;
+declareStmt : (visibility whiteSpace)? DECLARE whiteSpace (PTRSAFE whiteSpace)? (FUNCTION | SUB) whiteSpace identifier whiteSpace (CDECL whiteSpace)? LIB whiteSpace STRINGLITERAL (whiteSpace ALIAS whiteSpace STRINGLITERAL)? (whiteSpace? argList)? (whiteSpace asTypeClause)?;
 
 argList : LPAREN (whiteSpace? arg (whiteSpace? COMMA whiteSpace? arg)*)? whiteSpace? RPAREN;
 

Rubberduck.Parsing/Grammar/VBAParser.g4

@@ -331,4 +331,7 @@ If the parameter can be null, ignore this inspection result; passing a null valu
   <data name="ObsoleteMemberUsageInspection" xml:space="preserve">
     <value>This member is marked '@Obsolete'. It should no longer be used, there should be a better alternative.</value>
   </data>
+  <data name="ObsoleteCallingConventionInspection" xml:space="preserve">
+    <value>Windows implementations of Visual Basic only support the StdCall calling convention, and use of of the CDecl calling convention is only supported in Macintosh versions of VBA. Use of this keyword in Windows will result in runtime error 49 - 'Bad DLL calling convention'. If this procedure is only intended to be used on Macintosh hosts, it should be conditionally compiled.</value>
+  </data>
 </root>