GROOVY-11260: ASTMatcher should support matching a var-arg placeholder

apache · Jan 1, 2024 · 412f566 · 412f566
1 parent 80e92ec
commit 412f566
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 2 deletions.
diff --git a/subprojects/groovy-macro/src/main/groovy/org/codehaus/groovy/macro/matcher/ASTMatcher.groovy b/subprojects/groovy-macro/src/main/groovy/org/codehaus/groovy/macro/matcher/ASTMatcher.groovy
@@ -33,6 +33,7 @@ import org.codehaus.groovy.ast.ModuleNode
 import org.codehaus.groovy.ast.PackageNode
 import org.codehaus.groovy.ast.Parameter
 import org.codehaus.groovy.ast.PropertyNode
+import org.codehaus.groovy.ast.expr.ArgumentListExpression
 import org.codehaus.groovy.ast.expr.ArrayExpression
 import org.codehaus.groovy.ast.expr.AttributeExpression
 import org.codehaus.groovy.ast.expr.BinaryExpression
@@ -159,9 +160,15 @@ class ASTMatcher extends ContextualClassCodeVisitor {
                 return exp.name
             } else if (exp instanceof ConstantExpression && placeholders.contains(exp.value)) {
                 return exp.value
-            } else {
-                return null
+            } else if (exp instanceof ArgumentListExpression && exp.size() == 1 && exp[0] instanceof VariableExpression) {
+                // TODO currently matches exactly all args, consider allowing
+                // other non-vararg nodes before the vararg one
+                VariableExpression ve = exp[0] as VariableExpression
+                if (varargPlaceholders.contains(ve.name)) {
+                    return ve.name
+                }
             }
+            return null
         }
     }
 

diff --git a/...groovy-macro/src/main/groovy/org/codehaus/groovy/macro/matcher/MatchingConstraints.groovy b/...groovy-macro/src/main/groovy/org/codehaus/groovy/macro/matcher/MatchingConstraints.groovy
@@ -35,6 +35,7 @@ class MatchingConstraints {
     public final static ConstraintPredicate<Token> ANY_TOKEN = AnyTokenMatch.INSTANCE
 
     final Set<String> placeholders
+    final Set<String> varargPlaceholders
     final ConstraintPredicate<Token> tokenPredicate
     final ConstraintPredicate<TreeContext> eventually
 }
diff --git a/.../main/groovy/org/codehaus/groovy/macro/matcher/internal/MatchingConstraintsBuilder.groovy b/.../main/groovy/org/codehaus/groovy/macro/matcher/internal/MatchingConstraintsBuilder.groovy
@@ -24,6 +24,7 @@ import org.codehaus.groovy.syntax.Token
 
 class MatchingConstraintsBuilder {
     Set<String> placeholders = new LinkedHashSet<>()
+    Set<String> varargPlaceholders = new LinkedHashSet<>()
     ConstraintPredicate<Token> tokenPredicate
     ConstraintPredicate<TreeContext> eventually
 
@@ -36,6 +37,7 @@ class MatchingConstraintsBuilder {
 
         new MatchingConstraints(
                 placeholders: Collections.unmodifiableSet(placeholders),
+                varargPlaceholders: Collections.unmodifiableSet(varargPlaceholders),
                 tokenPredicate: tokenPredicate,
                 eventually: eventually
         )
@@ -50,6 +52,11 @@ class MatchingConstraintsBuilder {
         this
     }
 
+    MatchingConstraintsBuilder varargPlaceholder(String... names) {
+        names.each { String it -> varargPlaceholders.add(it) }
+        this
+    }
+
     MatchingConstraintsBuilder anyToken() {
         tokenPredicate = MatchingConstraints.ANY_TOKEN
         this

diff --git a/...ects/groovy-macro/src/test/groovy/org/codehaus/groovy/macro/matcher/ASTMatcherTest.groovy b/...ects/groovy-macro/src/test/groovy/org/codehaus/groovy/macro/matcher/ASTMatcherTest.groovy
@@ -77,6 +77,24 @@ class ASTMatcherTest extends GroovyTestCase {
         '''
     }
 
+    void testMethodCallExpressionWithVarargs() {
+        assertScript '''
+        import org.codehaus.groovy.macro.matcher.ASTMatcher
+
+        def pattern = macro { foo(a) }.withConstraints{ varargPlaceholder a }
+        def ast2 = macro { foo() }
+        def ast3 = macro { foo(1) }
+        def ast4 = macro { foo(1, 2) }
+        def ast5 = macro { foo(1, 2, 3) }
+        def ast6 = macro { bar() }
+        assert ASTMatcher.matches(ast2, pattern)
+        assert ASTMatcher.matches(ast3, pattern)
+        assert ASTMatcher.matches(ast4, pattern)
+        assert ASTMatcher.matches(ast5, pattern)
+        assert !ASTMatcher.matches(ast6, pattern)
+        '''
+    }
+
     void testPropertyExpression() {
         assertScript '''
         import org.codehaus.groovy.macro.matcher.ASTMatcher