feature: Record Patterns (JEP 440) (#5637)

doc/code_elements.md

@@ -299,6 +299,20 @@ switch (num) {
     int x = 0;
     x *= 3; // <-- a CtOperatorAssignment
 
+```
+### CtRecordPattern
+[(javadoc)](http://spoon.gforge.inria.fr/mvnsites/spoon-core/apidocs/spoon/reflect/code/CtRecordPattern.html)
+
+```java
+
+    Object obj = null;
+    boolean longerThanTwo = false;
+    record MyRecord(String value) {}
+    // MyRecord(var string) is the record pattern
+    if (obj instanceof MyRecord(var string)) {
+        longerThanTwo = string.length() > 2;
+    }
+
 ```
 ### CtReturn
 [(javadoc)](http://spoon.gforge.inria.fr/mvnsites/spoon-core/apidocs/spoon/reflect/code/CtReturn.html)

spoon-smpl/src/main/java/spoon/smpl/Substitutor.java

@@ -58,6 +58,7 @@
 import spoon.reflect.code.CtNewArray;
 import spoon.reflect.code.CtNewClass;
 import spoon.reflect.code.CtOperatorAssignment;
+import spoon.reflect.code.CtRecordPattern;
 import spoon.reflect.code.CtReturn;
 import spoon.reflect.code.CtStatement;
 import spoon.reflect.code.CtStatementList;
@@ -704,4 +705,9 @@ public void visitCtRecordComponent(CtRecordComponent recordComponent) {
 	public void visitCtCasePattern(CtCasePattern casePattern) {
 		throw new NotImplementedException("Not implemented");
 	}
+
+	@Override
+	public void visitCtRecordPattern(CtRecordPattern recordPattern) {
+		throw new NotImplementedException("Not implemented");
+	}
 }

spoon-smpl/src/main/java/spoon/smpl/pattern/PatternBuilder.java

@@ -56,6 +56,7 @@
 import spoon.reflect.code.CtNewArray;
 import spoon.reflect.code.CtNewClass;
 import spoon.reflect.code.CtOperatorAssignment;
+import spoon.reflect.code.CtRecordPattern;
 import spoon.reflect.code.CtReturn;
 import spoon.reflect.code.CtStatement;
 import spoon.reflect.code.CtStatementList;
@@ -845,6 +846,11 @@ public void visitCtCasePattern(CtCasePattern casePattern) {
 		throw new NotImplementedException("Not implemented");
 	}
 
+	@Override
+	public void visitCtRecordPattern(CtRecordPattern recordPattern) {
+		throw new NotImplementedException("Not implemented");
+	}
+
 
 	/**
 	 * Parameter identifiers.

src/main/java/spoon/metamodel/Metamodel.java

@@ -110,6 +110,7 @@ public static Set<CtType<?>> getAllMetamodelInterfaces() {
 		result.add(factory.Type().get(spoon.reflect.code.CtOperatorAssignment.class));
 		result.add(factory.Type().get(spoon.reflect.code.CtPattern.class));
 		result.add(factory.Type().get(spoon.reflect.code.CtRHSReceiver.class));
+		result.add(factory.Type().get(spoon.reflect.code.CtRecordPattern.class));
 		result.add(factory.Type().get(spoon.reflect.code.CtResource.class));
 		result.add(factory.Type().get(spoon.reflect.code.CtReturn.class));
 		result.add(factory.Type().get(spoon.reflect.code.CtStatement.class));

src/main/java/spoon/reflect/code/CtRecordPattern.java

@@ -0,0 +1,84 @@
+/*
+ * SPDX-License-Identifier: (MIT OR CECILL-C)
+ *
+ * Copyright (C) 2006-2023 INRIA and contributors
+ *
+ * Spoon is available either under the terms of the MIT License (see LICENSE-MIT.txt) or the Cecill-C License (see LICENSE-CECILL-C.txt). You as the user are entitled to choose the terms under which to adopt Spoon.
+ */
+package spoon.reflect.code;
+
+import spoon.reflect.annotations.PropertyGetter;
+import spoon.reflect.annotations.PropertySetter;
+import spoon.reflect.path.CtRole;
+import spoon.reflect.reference.CtTypeReference;
+import spoon.support.UnsettableProperty;
+
+import java.util.List;
+
+// TODO (440) metamodel
+
+/**
+ * This code element defines a record pattern, introduced in Java 21
+ * by <a href=https://openjdk.java.net/jeps/440>JEP 440</a>.
+ * <p>
+ * Example:
+ * <pre>
+ *     Object obj = null;
+ *     boolean longerThanTwo = false;
+ *     record MyRecord(String value) {}
+ *     // MyRecord(var string) is the record pattern
+ *     if (obj instanceof MyRecord(var string)) {
+ *         longerThanTwo = string.length() > 2;
+ *     }
+ * </pre>
+ */
+public interface CtRecordPattern extends CtPattern, CtExpression<Void> {
+
+	/**
+	 * {@return the type of the deconstructed record}
+	 */
+	@PropertyGetter(role = CtRole.TYPE_REF)
+	CtTypeReference<?> getRecordType();
+
+	/**
+	 * Sets the type of the deconstructed record.
+	 * @param recordType the record type.
+	 */
+	@PropertySetter(role = CtRole.TYPE_REF)
+	CtRecordPattern setRecordType(CtTypeReference<?> recordType);
+
+	/**
+	 * {@return the inner patterns of this record pattern}
+	 */
+	@PropertyGetter(role = CtRole.PATTERN)
+	List<CtPattern> getPatternList();
+
+	/**
+	 * Sets the inner patterns of this record pattern.
+	 * @param patternList the list of inner patterns.
+	 */
+	@PropertySetter(role = CtRole.PATTERN)
+	CtRecordPattern setPatternList(List<CtPattern> patternList);
+
+	/**
+	 * Adds an inner patterns to the list of inner patterns of this record.
+	 * @param pattern the inner pattern.
+	 */
+	@PropertySetter(role = CtRole.PATTERN)
+	CtRecordPattern addPattern(CtPattern pattern);
+
+	@Override
+	CtRecordPattern clone();
+
+	@Override
+	@UnsettableProperty
+	List<CtTypeReference<?>> getTypeCasts();
+
+	@Override
+	@UnsettableProperty
+	<C extends CtExpression<Void>> C setTypeCasts(List<CtTypeReference<?>> types);
+
+	@Override
+	@UnsettableProperty
+	<C extends CtExpression<Void>> C addTypeCast(CtTypeReference<?> type);
+}

src/main/java/spoon/reflect/factory/CoreFactory.java

@@ -44,6 +44,7 @@
 import spoon.reflect.code.CtNewArray;
 import spoon.reflect.code.CtNewClass;
 import spoon.reflect.code.CtOperatorAssignment;
+import spoon.reflect.code.CtRecordPattern;
 import spoon.reflect.code.CtReturn;
 import spoon.reflect.code.CtStatementList;
 import spoon.reflect.code.CtSuperAccess;
@@ -647,4 +648,9 @@ BodyHolderSourcePosition createBodyHolderSourcePosition(
 	 * @return the created case pattern.
 	 */
 	CtCasePattern createCasePattern();
+
+	/**
+	 * {@return a record pattern}
+	 */
+	CtRecordPattern createRecordPattern();
 }