Merge pull request #3888 from Rawi01/eclipse-record-refactoring

Support records in upcoming eclipse version

Author: rzwitserloot

.github/workflows/ant.yml

@@ -94,6 +94,9 @@ jobs:
  - eclipse-oxygen
  - eclipse-202006
  - eclipse-202006-jdk8
+ - eclipse-202403
+ - eclipse-202503
+ - eclipse-I-build
  - eclipse-oxygen-full
  - eclipse-202403-full
  - eclipse-202503-full

buildScripts/setup.ant.xml

@@ -205,6 +205,8 @@ This buildfile is part of projectlombok.org. It sets up the build itself.
 <!-- osgi.extender dependecies -->
 <arg value="osgi.bundle:org.apache.felix.scr" />
 <arg value="osgi.bundle:org.apache.aries.spifly.dynamic.bundle" />
+<!-- Unresolvable until we add property based dependency resolution -->
+<arg value="osgi.bundle:org.eclipse.swt.svg" />
 <!-- Real dependencies -->
 <arg value="osgi.bundle:org.eclipse.jdt.core" />
 <arg value="osgi.bundle:org.eclipse.jdt.ui" />

src/core/lombok/eclipse/EclipseAST.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2009-2021 The Project Lombok Authors.
+ * Copyright (C) 2009-2025 The Project Lombok Authors.
  * 
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -40,6 +40,7 @@
 import org.eclipse.jdt.internal.compiler.CompilationResult;
 import org.eclipse.jdt.internal.compiler.ast.ASTNode;
 import org.eclipse.jdt.internal.compiler.ast.AbstractMethodDeclaration;
+import org.eclipse.jdt.internal.compiler.ast.AbstractVariableDeclaration;
 import org.eclipse.jdt.internal.compiler.ast.Annotation;
 import org.eclipse.jdt.internal.compiler.ast.Argument;
 import org.eclipse.jdt.internal.compiler.ast.CompilationUnitDeclaration;
@@ -354,7 +355,7 @@ public static boolean isComplete(CompilationUnitDeclaration unit) {
 case TYPE:
 return buildType((TypeDeclaration) node);
 case FIELD:
-return buildField((FieldDeclaration) node, null);
+return buildField((FieldDeclaration) node);
 case INITIALIZER:
 return buildInitializer((Initializer) node);
 case METHOD:
@@ -393,17 +394,38 @@ private List<EclipseNode> buildTypes(TypeDeclaration[] children) {
 private EclipseNode buildType(TypeDeclaration type) {
 if (setAndGetAsHandled(type)) return null;
 List<EclipseNode> childNodes = new ArrayList<EclipseNode>();
-childNodes.addAll(buildFields(type.fields, getRecordFieldAnnotations(type)));
+childNodes.addAll(buildRecordComponents(getRecordComponents(type)));
+childNodes.addAll(buildFields(type.fields));
 childNodes.addAll(buildTypes(type.memberTypes));
 childNodes.addAll(buildMethods(type.methods));
 childNodes.addAll(buildAnnotations(type.annotations, false));
 return putInMap(new EclipseNode(this, type, childNodes, Kind.TYPE));
 }
 
-private Collection<EclipseNode> buildFields(FieldDeclaration[] children, Annotation[][] annotations) {
+private Collection<EclipseNode> buildRecordComponents(AbstractVariableDeclaration[] children) {
 List<EclipseNode> childNodes = new ArrayList<EclipseNode>();
 if (children != null) for (int i = 0; i < children.length; i++) {
-addIfNotNull(childNodes, buildField(children[i], annotations[i]));
+addIfNotNull(childNodes, buildRecordComponent(children[i]));
+}
+return childNodes;
+}
+
+private EclipseNode buildRecordComponent(AbstractVariableDeclaration field) {
+List<EclipseNode> childNodes = new ArrayList<EclipseNode>();
+addIfNotNull(childNodes, buildTypeUse(field.type));
+addIfNotNull(childNodes, buildStatement(field.initialization));
+childNodes.addAll(buildAnnotations(field.annotations, true));
+FieldDeclaration fieldDeclaration = new FieldDeclaration(field.name, field.sourceStart, field.sourceEnd);
+fieldDeclaration.type = field.type;
+fieldDeclaration.modifiers = field.modifiers | Eclipse.AccRecord;
+fieldDeclaration.annotations = field.annotations;
+return putInMap(new EclipseNode(this, fieldDeclaration, childNodes, Kind.FIELD));
+}
+
+private Collection<EclipseNode> buildFields(FieldDeclaration[] children) {
+List<EclipseNode> childNodes = new ArrayList<EclipseNode>();
+if (children != null) for (int i = 0; i < children.length; i++) {
+addIfNotNull(childNodes, buildField(children[i]));
 }
 return childNodes;
 }
@@ -414,13 +436,14 @@ private static <T> List<T> singleton(T item) {
 return list;
 }
 
-private EclipseNode buildField(FieldDeclaration field, Annotation[] annotations) {
+private EclipseNode buildField(FieldDeclaration field) {
 if (field instanceof Initializer) return buildInitializer((Initializer) field);
 if (setAndGetAsHandled(field)) return null;
+if (isRecordField(field)) return null;
 List<EclipseNode> childNodes = new ArrayList<EclipseNode>();
 addIfNotNull(childNodes, buildTypeUse(field.type));
 addIfNotNull(childNodes, buildStatement(field.initialization));
-childNodes.addAll(buildAnnotations(annotations != null ? annotations : field.annotations, true));
+childNodes.addAll(buildAnnotations(field.annotations, true));
 return putInMap(new EclipseNode(this, field, childNodes, Kind.FIELD));
 }
 

src/core/lombok/eclipse/handlers/HandleLockedUtil.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2024 The Project Lombok Authors.
+ * Copyright (C) 2024-2025 The Project Lombok Authors.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -87,6 +87,8 @@ public static void preHandle(String annotationValue, char[][] lockTypeClass, cha
 if (methodNode == null || methodNode.getKind() != AST.Kind.METHOD || !(methodNode.get() instanceof MethodDeclaration)) return;
 MethodDeclaration method = (MethodDeclaration) methodNode.get();
 if (method.isAbstract()) return;
+EclipseNode typeNode = upToTypeNode(annotationNode);
+if (isRecord(typeNode)) return;
 
 createLockField(annotationValue, annotationNode, lockTypeClass, lockImplClass, new AtomicBoolean(method.isStatic()), false);
 }

src/core/lombok/eclipse/handlers/HandleNonNull.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2013-2021 The Project Lombok Authors.
+ * Copyright (C) 2013-2025 The Project Lombok Authors.
  * 
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -168,10 +168,15 @@ private EclipseNode addCompactConstructorIfNeeded(EclipseNode typeNode, EclipseN
 }
 }
 if (posToInsert == -1) {
-AbstractMethodDeclaration[] na = new AbstractMethodDeclaration[td.methods.length + 1];
-posToInsert = td.methods.length;
-System.arraycopy(td.methods, 0, na, 0, posToInsert);
-td.methods = na;
+if (td.methods == null) {
+td.methods = new AbstractMethodDeclaration[1];
+posToInsert = 0;
+} else {
+posToInsert = td.methods.length;
+AbstractMethodDeclaration[] na = new AbstractMethodDeclaration[posToInsert + 1];
+System.arraycopy(td.methods, 0, na, 0, posToInsert);
+td.methods = na;
+}
 }
 
 ConstructorDeclaration cd = new ConstructorDeclaration(((CompilationUnitDeclaration) typeNode.top().get()).compilationResult);
@@ -186,8 +191,9 @@ private EclipseNode addCompactConstructorIfNeeded(EclipseNode typeNode, EclipseN
 
 for (int i = 0; i < cd.arguments.length; i++) {
 FieldDeclaration cmp = recordComponents.get(i);
-cd.arguments[i] = new Argument(cmp.name, cmp.sourceStart, cmp.type, 0);
+cd.arguments[i] = new Argument(cmp.name, cmp.sourceStart, cmp.type, cmp.modifiers);
 cd.arguments[i].bits = ASTNode.IsArgument | ASTNode.IgnoreRawTypeCheck | ASTNode.IsReachable;
+cd.arguments[i].annotations = cmp.annotations;
 FieldReference lhs = new FieldReference(cmp.name, 0);
 lhs.receiver = new ThisReference(0, 0);
 SingleNameReference rhs = new SingleNameReference(cmp.name, 0);
@@ -304,6 +310,11 @@ private void handle0(Annotation ast, EclipseNode annotationNode, boolean force)
 return;
 }
 
+if ((param.modifiers & AccRecord) != 0) {
+addNullCheckIfNeeded(declaration, param, annotationNode);
+node.up().rebuild();
+}
+
 if (!force && isGenerated(declaration)) return;
 
 if (declaration.isAbstract()) {

src/core/lombok/eclipse/handlers/HandleSynchronized.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2009-2024 The Project Lombok Authors.
+ * Copyright (C) 2009-2025 The Project Lombok Authors.
  * 
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -69,6 +69,8 @@ public class HandleSynchronized extends EclipseAnnotationHandler<Synchronized> {
 if (methodNode == null || methodNode.getKind() != Kind.METHOD || !(methodNode.get() instanceof MethodDeclaration)) return;
 MethodDeclaration method = (MethodDeclaration) methodNode.get();
 if (method.isAbstract()) return;
+EclipseNode typeNode = upToTypeNode(annotationNode);
+if (isRecord(typeNode)) return;
 
 createLockField(annotation, annotationNode, new boolean[] {method.isStatic()}, false);
 

src/eclipseAgent/lombok/eclipse/agent/EclipsePatcher.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2009-2024 The Project Lombok Authors.
+ * Copyright (C) 2009-2025 The Project Lombok Authors.
  * 
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -333,7 +333,7 @@ private static void patchDomAstReparseIssues(ScriptManager sm) {
 .transplant()
 .build());
 
-sm.addScriptIfComplexWitness(new String[][] {OSGI_TYPES, new String[] {"org/eclipse/jdt/internal/compiler/parser/TerminalToken"}}, ScriptBuilder.replaceMethodCall()
+sm.addScriptIfWitness(OSGI_TYPES, ScriptBuilder.replaceMethodCall()
 .target(new MethodTarget("org.eclipse.jdt.internal.core.dom.rewrite.ASTRewriteAnalyzer", "visit"))
 .methodToReplace(new Hook("org.eclipse.jdt.internal.core.dom.rewrite.TokenScanner", "getTokenEndOffset", "int", "org.eclipse.jdt.internal.compiler.parser.TerminalToken", "int"))
 .replacementMethod(new Hook("lombok.launch.PatchFixesHider$PatchFixes", "getTokenEndOffsetFixed", "int", "org.eclipse.jdt.internal.core.dom.rewrite.TokenScanner", "java.lang.Object", "int", "java.lang.Object"))
@@ -1156,6 +1156,23 @@ private static void patchForTests(ScriptManager sm) {
 .request(StackRequest.THIS, StackRequest.PARAM2)
 .transplant()
 .build());
+
+// Remove implicit record fields in tests
+sm.addScriptIfWitness(ECLIPSE_TEST_CLASSES, ScriptBuilder.exitEarly()
+.target(new MethodTarget("org.eclipse.jdt.internal.compiler.ast.FieldDeclaration", "print", "java.lang.StringBuilder", "int", "java.lang.StringBuilder"))
+.decisionMethod(new Hook("lombok.launch.PatchFixesHider$Tests", "isRecordComponent", "boolean", "org.eclipse.jdt.internal.compiler.ast.FieldDeclaration", "java.lang.Object"))
+.valueMethod(new Hook("lombok.launch.PatchFixesHider$Tests", "returnStringBuilder", "java.lang.StringBuilder", "java.lang.Object", "java.lang.StringBuilder"))
+.request(StackRequest.THIS, StackRequest.PARAM2)
+.transplant()
+.build());
+
+sm.addScriptIfWitness(ECLIPSE_TEST_CLASSES, ScriptBuilder.exitEarly()
+.target(new MethodTarget("org.eclipse.jdt.internal.compiler.ast.FieldDeclaration", "print", "java.lang.StringBuffer", "int", "java.lang.StringBuffer"))
+.decisionMethod(new Hook("lombok.launch.PatchFixesHider$Tests", "isRecordComponent", "boolean", "org.eclipse.jdt.internal.compiler.ast.FieldDeclaration", "java.lang.Object"))
+.valueMethod(new Hook("lombok.launch.PatchFixesHider$Tests", "returnStringBuffer", "java.lang.StringBuffer", "java.lang.Object", "java.lang.StringBuffer"))
+.request(StackRequest.THIS, StackRequest.PARAM2)
+.transplant()
+.build());
 }
 
 }

src/eclipseAgent/lombok/launch/PatchFixesHider.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2010-2024 The Project Lombok Authors.
+ * Copyright (C) 2010-2025 The Project Lombok Authors.
  * 
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -1117,6 +1117,10 @@ public static boolean isImplicitCanonicalConstructor(AbstractMethodDeclaration m
 return (method.bits & IsCanonicalConstructor) != 0 && (method.bits & IsImplicit) != 0;
 }
 
+public static boolean isRecordComponent(FieldDeclaration field, Object parameter) {
+return (field.modifiers & AccRecord) != 0;
+}
+
 public static StringBuffer returnStringBuffer(Object p1, StringBuffer buffer) {
 return buffer;
 }

src/support/lombok/eclipse/dependencies/DownloadEclipseDependencies.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2022-2024 The Project Lombok Authors.
+ * Copyright (C) 2022-2025 The Project Lombok Authors.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -51,6 +51,7 @@ public static void main(String[] args) throws Exception {
 String updateSiteUrl = args[2];
 boolean resolveDependencies = Boolean.parseBoolean(args[3]);
 List<String> bundles = Arrays.asList(Arrays.copyOfRange(args, 4, args.length));
+boolean isCi = "true".equalsIgnoreCase(System.getenv("CI"));
 
 UpdateSite updateSite = new UpdateSite();
 updateSite.read(updateSiteUrl);
@@ -69,14 +70,16 @@ public static void main(String[] args) throws Exception {
 // Download artifact
 downloadFile(artifact, pluginSource, pluginTarget);
 
-// Download artifact source
-int index = artifact.lastIndexOf("_");
-String source = artifact.substring(0, index) + ".source" + artifact.substring(index);
-try {
-downloadFile(source, pluginSource, pluginTarget);
-} catch (Exception e) {
-// It's just the source; sometimes these aren't present (specifically, `org.eclipse.swt` doesn't currently appear to have the sources, at least not using the `_sources` naming scheme). Don't fail, just skip them.
-System.out.println("[failed]");
+// Download artifact source for local development
+if (!isCi) {
+int index = artifact.lastIndexOf("_");
+String source = artifact.substring(0, index) + ".source" + artifact.substring(index);
+try {
+downloadFile(source, pluginSource, pluginTarget);
+} catch (Exception e) {
+// It's just the source; sometimes these aren't present (specifically, `org.eclipse.swt` doesn't currently appear to have the sources, at least not using the `_sources` naming scheme). Don't fail, just skip them.
+System.out.println("[failed]");
+}
 }
 }
 

test/transform/resource/after-ecj/BuilderOnNestedRecord.java

@@ -19,10 +19,8 @@ public record BuilderOnNestedRecord(T t)<T> {
  return (("BuilderOnNestedRecord.Nested.NestedBuilder(a=" + this.a) + ")");
  }
  }
-/* Implicit */ private final String a;
  public static @java.lang.SuppressWarnings("all") @lombok.Generated BuilderOnNestedRecord.Nested.NestedBuilder builder() {
  return new BuilderOnNestedRecord.Nested.NestedBuilder();
  }
  }
-/* Implicit */ private final T t;
 }