[java] Support vararg/array in RecordComponent and empty components

hirsute-chauve · Feb 28, 2020 · e017def · e017def
1 parent 5f43e19
commit e017def
Show file tree

Hide file tree

Showing 7 changed files with 63 additions and 9 deletions.
diff --git a/pmd-java/etc/grammar/Java.jjt b/pmd-java/etc/grammar/Java.jjt
@@ -1139,13 +1139,16 @@ void RecordDeclaration(int modifiers):
 void RecordComponentList() :
 {}
 {
-  "(" RecordComponent() ("," RecordComponent())* ")"
+  "(" [ RecordComponent() ("," RecordComponent())* ] ")"
 }
 
 void RecordComponent():
 {}
 {
-  (TypeAnnotation())* Type() <IDENTIFIER> { jjtThis.setImage(token.image); }
+  (Annotation())*
+  Type()
+  [ (Annotation())* "..." {jjtThis.setVarargs();} ]
+  VariableDeclaratorId()
 }
 
 void RecordBody():

diff --git a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/ASTRecordComponent.java b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/ASTRecordComponent.java
@@ -12,14 +12,17 @@
  *
  * <pre class="grammar">
  *
- * RecordComponent ::= ({@linkplain ASTTypeAnnotation TypeAnnotation})*
+ * RecordComponent ::= ({@linkplain ASTAnnotation Annotation})*
  *                     {@linkplain ASTType Type}
- *                     &lt;IDENTIFIER&gt;
+ *                     ( ({@linkplain ASTAnnotation Annotation})* "..." )?
+ *                     {@linkplain ASTVariableDeclaratorId VariableDeclaratorId}
  *
  * </pre>
  */
 @Experimental
 public class ASTRecordComponent extends AbstractJavaNode {
+    private boolean varargs;
+
     ASTRecordComponent(int id) {
         super(id);
     }
@@ -32,4 +35,20 @@ public class ASTRecordComponent extends AbstractJavaNode {
     public Object jjtAccept(JavaParserVisitor visitor, Object data) {
         return visitor.visit(this, data);
     }
+
+    public boolean isVarargs() {
+        return varargs;
+    }
+
+    void setVarargs() {
+        varargs = true;
+    }
+
+    public ASTType getTypeNode() {
+        return getFirstChildOfType(ASTType.class);
+    }
+
+    public ASTVariableDeclaratorId getVariableDeclaratorId() {
+        return getFirstChildOfType(ASTVariableDeclaratorId.class);
+    }
 }
diff --git a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/ASTRecordComponentList.java b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/ASTRecordComponentList.java
@@ -12,8 +12,7 @@
  *
  * <pre class="grammar">
  *
- * RecordComponentList ::= "("       {@linkplain ASTRecordComponent RecordComponent}
- *                             ( "," {@linkplain ASTRecordComponent RecordComponent} )* ")"
+ * RecordComponentList ::= "(" ( {@linkplain ASTRecordComponent RecordComponent} ( "," {@linkplain ASTRecordComponent RecordComponent} )* )? ")"
  *
  * </pre>
  */

diff --git a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/ASTRecordDeclaration.java b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/ASTRecordDeclaration.java
@@ -57,4 +57,8 @@ public List<ASTAnyTypeBodyDeclaration> getDeclarations() {
     public boolean isFindBoundary() {
         return isNested();
     }
+
+    public List<ASTRecordComponent> getRecordComponents() {
+        return getFirstChildOfType(ASTRecordComponentList.class).findChildrenOfType(ASTRecordComponent.class);
+    }
 }
diff --git a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/ASTVariableDeclaratorId.java b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/ASTVariableDeclaratorId.java
@@ -303,6 +303,8 @@ public ASTType getTypeNode() {
             return null;
         } else if (getParent() instanceof ASTTypeTestPattern) {
             return ((ASTTypeTestPattern) getParent()).getTypeNode();
+        } else if (getParent() instanceof ASTRecordComponent) {
+            return ((ASTRecordComponent) getParent()).getTypeNode();
         } else {
             Node n = getParent().getParent();
             if (n instanceof ASTLocalVariableDeclaration || n instanceof ASTFieldDeclaration) {

diff --git a/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/ast/Java14PreviewTest.java b/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/ast/Java14PreviewTest.java
@@ -99,8 +99,8 @@ public void recordPoint() {
         List<ASTRecordComponent> components = recordDecl.getFirstChildOfType(ASTRecordComponentList.class)
                 .findChildrenOfType(ASTRecordComponent.class);
         Assert.assertEquals(2, components.size());
-        Assert.assertEquals("x", components.get(0).getImage());
-        Assert.assertEquals("y", components.get(1).getImage());
+        Assert.assertEquals("x", components.get(0).getVariableDeclaratorId().getImage());
+        Assert.assertEquals("y", components.get(1).getVariableDeclaratorId().getImage());
     }
 
     @Test(expected = ParseException.class)
@@ -112,7 +112,28 @@ public void recordPointBeforeJava14PreviewShouldFail() {
     public void innerRecords() {
         ASTCompilationUnit compilationUnit = java14p.parseResource("Records.java");
         List<ASTRecordDeclaration> recordDecls = compilationUnit.findDescendantsOfType(ASTRecordDeclaration.class);
-        Assert.assertEquals(2, recordDecls.size());
+        Assert.assertEquals(5, recordDecls.size());
+
+        ASTRecordDeclaration range = recordDecls.get(1);
+        Assert.assertEquals("Range", range.getImage());
+        Assert.assertEquals(2, range.getRecordComponents().size());
+        List<ASTRecordConstructorDeclaration> rangeConstructors = range.findDescendantsOfType(ASTRecordConstructorDeclaration.class);
+        Assert.assertEquals(1, rangeConstructors.size());
+        Assert.assertEquals("Range", rangeConstructors.get(0).getImage());
+
+        ASTRecordDeclaration varRec = recordDecls.get(2);
+        Assert.assertEquals("VarRec", varRec.getImage());
+        Assert.assertEquals("x", varRec.getRecordComponents().get(0).getVariableDeclaratorId().getImage());
+        Assert.assertTrue(varRec.getRecordComponents().get(0).isVarargs());
+
+        ASTRecordDeclaration arrayRec = recordDecls.get(3);
+        Assert.assertEquals("ArrayRec", arrayRec.getImage());
+        Assert.assertEquals("x", arrayRec.getRecordComponents().get(0).getVariableDeclaratorId().getImage());
+        Assert.assertTrue(arrayRec.getRecordComponents().get(0).getVariableDeclaratorId().hasArrayType());
+
+        ASTRecordDeclaration emptyRec = recordDecls.get(4);
+        Assert.assertEquals("EmptyRec", emptyRec.getImage());
+        Assert.assertEquals(0, emptyRec.getRecordComponents().size());
     }
 
     @Test(expected = ParseException.class)

diff --git a/.../src/test/resources/net/sourceforge/pmd/lang/java/ast/jdkversiontests/java14/Records.java b/.../src/test/resources/net/sourceforge/pmd/lang/java/ast/jdkversiontests/java14/Records.java
@@ -15,4 +15,10 @@ public record Range(int lo, int hi) {
             throw new IllegalArgumentException(String.format("(%d,%d)", lo, hi));
         }
     }
+
+    public record VarRec(int ... x) {};
+
+    public record ArrayRec(int x[]) {};
+
+    public record EmptyRec() {};
 }