Merge pull request #4004 from mansellan/1505

Parser support for PSet special form (VB6)

Author: retailcoder

Rubberduck.Parsing/Grammar/VBAParser.g4

@@ -148,6 +148,7 @@ mainBlockStmt :
     | lineSpecialForm
     | circleSpecialForm
     | scaleSpecialForm
+    | pSetSpecialForm
     | callStmt
     | nameStmt
 ;
@@ -548,10 +549,11 @@ withStmt :
     statementLabelDefinition? whiteSpace? END_WITH
 ;
 
-// Special forms with special syntax, only available in a report.
+// Special forms with special syntax, only available in VBA reports or VB6 forms and pictureboxes.
 lineSpecialForm : expression whiteSpace (STEP whiteSpace?)? tuple MINUS (STEP whiteSpace?)? tuple whiteSpace? (COMMA whiteSpace? expression)? whiteSpace? (COMMA whiteSpace? lineSpecialFormOption)?;
 circleSpecialForm : (expression whiteSpace? DOT whiteSpace?)? CIRCLE whiteSpace (STEP whiteSpace?)? tuple (whiteSpace? COMMA whiteSpace? expression)+;
 scaleSpecialForm : (expression whiteSpace? DOT whiteSpace?)? SCALE whiteSpace tuple whiteSpace? MINUS whiteSpace? tuple;
+pSetSpecialForm : (expression whiteSpace? DOT whiteSpace?)? PSET (whiteSpace STEP)? whiteSpace? tuple whiteSpace? (COMMA whiteSpace? expression)?;
 tuple : LPAREN whiteSpace? expression whiteSpace? COMMA whiteSpace? expression whiteSpace? RPAREN;
 lineSpecialFormOption : {_input.Lt(1).Text.ToLower().Equals("b") || _input.Lt(1).Text.ToLower().Equals("bf")}? unrestrictedIdentifier;
 

Rubberduck.Parsing/Symbols/IdentifierReferenceListener.cs

@@ -331,6 +331,11 @@ public override void EnterScaleSpecialForm(VBAParser.ScaleSpecialFormContext con
             _resolver.Resolve(context);
         }
 
+        public override void EnterPSetSpecialForm(VBAParser.PSetSpecialFormContext context)
+        {
+            _resolver.Resolve(context);
+        }
+
         public override void EnterDebugPrintStmt([NotNull] VBAParser.DebugPrintStmtContext context)
         {
             _resolver.Resolve(context);

Rubberduck.Parsing/Symbols/IdentifierReferenceResolver.cs

@@ -761,6 +761,15 @@ public void Resolve(VBAParser.ScaleSpecialFormContext context)
             }
         }
 
+        public void Resolve(VBAParser.PSetSpecialFormContext context)
+        {
+            foreach (var expr in context.expression())
+            {
+                ResolveDefault(expr);
+            }
+            ResolveTuple(context.tuple());
+        }
+
         private void ResolveTuple(VBAParser.TupleContext tuple)
         {
             foreach (var expr in tuple.expression())

RubberduckTests/Grammar/ResolverTests.cs

@@ -2402,6 +2402,27 @@ End Sub
             }
         }
 
+        [Category("Grammar")]
+        [Category("Resolver")]
+        [Test]
+        public void PSetSpecialForm_IsReferenceToLocalVariable()
+        {
+            var code = @"
+Public Sub Test()
+    Dim referenced As Integer
+    PSet (referenced, referenced)
+End Sub
+";
+            using (var state = Resolve(code))
+            {
+
+                var declaration = state.AllUserDeclarations.Single(item =>
+                    item.DeclarationType == DeclarationType.Variable && item.IdentifierName == "referenced");
+
+                Assert.AreEqual(2, declaration.References.Count());
+            }
+        }
+
         [Category("Grammar")]
         [Category("Resolver")]
         [Test]

RubberduckTests/Grammar/VBAParserTests.cs

@@ -2211,6 +2211,66 @@ Sub Test()
             AssertTree(parseResult.Item1, parseResult.Item2, "//scaleSpecialForm");
         }
 
+        [Category("Parser")]
+        [Test]
+        public void TestPSetVBForm_WithoutStep()
+        {
+            string code = @"
+Sub Test()
+    Me.PSet (1, 2), vbBlack
+End Sub";
+            var parseResult = Parse(code);
+            AssertTree(parseResult.Item1, parseResult.Item2, "//pSetSpecialForm");
+        }
+
+        [Category("Parser")]
+        [Test]
+        public void TestPSetVBForm_WithoutOptionalArguments()
+        {
+            string code = @"
+Sub Test()
+    Me.PSet (1, 2)
+End Sub";
+            var parseResult = Parse(code);
+            AssertTree(parseResult.Item1, parseResult.Item2, "//pSetSpecialForm");
+        }
+
+        [Category("Parser")]
+        [Test]
+        public void TestPSetSpecialForm()
+        {
+            string code = @"
+Sub Test()
+    PSet Step(1, 2), vbBlack
+End Sub";
+            var parseResult = Parse(code);
+            AssertTree(parseResult.Item1, parseResult.Item2, "//pSetSpecialForm");
+        }
+
+        [Category("Parser")]
+        [Test]
+        public void TestPSetSpecialForm_WithoutStep()
+        {
+            string code = @"
+Sub Test()
+    PSet (1, 2), vbBlack
+End Sub";
+            var parseResult = Parse(code);
+            AssertTree(parseResult.Item1, parseResult.Item2, "//pSetSpecialForm");
+        }
+
+        [Category("Parser")]
+        [Test]
+        public void TestPSetSpecialForm_WithoutOptionalArguments()
+        {
+            string code = @"
+Sub Test()
+    PSet (1, 2)
+End Sub";
+            var parseResult = Parse(code);
+            AssertTree(parseResult.Item1, parseResult.Item2, "//pSetSpecialForm");
+        }
+
         [Category("Parser")]
         [Test]
         public void TestPtrSafeAsSub()