Skip to content

Commit

Permalink
Merge pull request #2355 from janrieke/superBuilderAvoidMoreNameClashes
Browse files Browse the repository at this point in the history
Avoid more name clashes for SuperBuilder
  • Loading branch information
rzwitserloot committed Feb 6, 2020
2 parents a678e7e + 4a34ed7 commit 680d63e
Show file tree
Hide file tree
Showing 6 changed files with 309 additions and 13 deletions.
37 changes: 30 additions & 7 deletions src/core/lombok/eclipse/handlers/HandleSuperBuilder.java 100755 → 100644
Expand Up @@ -29,6 +29,7 @@
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;

import org.eclipse.jdt.internal.compiler.ast.ASTNode;
Expand Down Expand Up @@ -222,12 +223,12 @@ public void handle(AnnotationValues<SuperBuilder> annotation, Annotation ast, Ec
// <C, B> are the generics for our builder.
String classGenericName = "C";
String builderGenericName = "B";
// If these generics' names collide with any generics on the annotated class, modify them.
// We have to make sure that the generics' names do not collide with any generics on the annotated class,
// the classname itself, or any member type name of the annotated class.
// For instance, if there are generics <B, B2, C> on the annotated class, use "C2" and "B3" for our builder.
java.util.List<String> typeParamStrings = new ArrayList<String>();
for (TypeParameter typeParam : typeParams) typeParamStrings.add(typeParam.toString());
classGenericName = generateNonclashingNameFor(classGenericName, typeParamStrings);
builderGenericName = generateNonclashingNameFor(builderGenericName, typeParamStrings);
java.util.Set<String> usedNames = gatherUsedTypeNames(typeParams, td);
classGenericName = generateNonclashingNameFor(classGenericName, usedNames);
builderGenericName = generateNonclashingNameFor(builderGenericName, usedNames);

TypeReference extendsClause = td.superclass;
TypeReference superclassBuilderClass = null;
Expand Down Expand Up @@ -415,7 +416,7 @@ public void handle(AnnotationValues<SuperBuilder> annotation, Annotation ast, Ec
}
}
}

private EclipseNode generateBuilderAbstractClass(EclipseNode tdParent, String builderClass,
TypeReference superclassBuilderClass, TypeParameter[] typeParams,
ASTNode source, String classGenericName, String builderGenericName) {
Expand Down Expand Up @@ -1052,7 +1053,29 @@ private SingularData getSingularData(EclipseNode node, ASTNode source) {
return null;
}

private String generateNonclashingNameFor(String classGenericName, java.util.List<String> typeParamStrings) {
private java.util.Set<String> gatherUsedTypeNames(TypeParameter[] typeParams, TypeDeclaration td) {
java.util.HashSet<String> usedNames = new HashSet<String>();

// 1. Add type parameter names.
for (TypeParameter typeParam : typeParams)
usedNames.add(typeParam.toString());

// 2. Add class name.
usedNames.add(String.valueOf(td.name));

// 3. Add used type names.
if (td.fields != null) {
for (FieldDeclaration field : td.fields) {
char[][] typeName = field.type.getTypeName();
if (typeName.length >= 1) // Add the first token, because only that can collide.
usedNames.add(String.valueOf(typeName[0]));
}
}

return usedNames;
}

private String generateNonclashingNameFor(String classGenericName, java.util.Set<String> typeParamStrings) {
if (!typeParamStrings.contains(classGenericName)) return classGenericName;
int counter = 2;
while (typeParamStrings.contains(classGenericName + counter)) counter++;
Expand Down
35 changes: 29 additions & 6 deletions src/core/lombok/javac/handlers/HandleSuperBuilder.java
Expand Up @@ -27,6 +27,7 @@

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;

import javax.lang.model.element.Modifier;

Expand Down Expand Up @@ -209,12 +210,12 @@ public void handle(AnnotationValues<SuperBuilder> annotation, JCAnnotation ast,
// <C, B> are the generics for our builder.
String classGenericName = "C";
String builderGenericName = "B";
// If these generics' names collide with any generics on the annotated class, modify them.
// We have to make sure that the generics' names do not collide with any generics on the annotated class,
// the classname itself, or any member type name of the annotated class.
// For instance, if there are generics <B, B2, C> on the annotated class, use "C2" and "B3" for our builder.
java.util.List<String> typeParamStrings = new ArrayList<String>();
for (JCTypeParameter typeParam : typeParams) typeParamStrings.add(typeParam.getName().toString());
classGenericName = generateNonclashingNameFor(classGenericName, typeParamStrings);
builderGenericName = generateNonclashingNameFor(builderGenericName, typeParamStrings);
java.util.HashSet<String> usedNames = gatherUsedTypeNames(typeParams, td);
classGenericName = generateNonclashingNameFor(classGenericName, usedNames);
builderGenericName = generateNonclashingNameFor(builderGenericName, usedNames);

thrownExceptions = List.nil();

Expand Down Expand Up @@ -987,7 +988,29 @@ private SingularData getSingularData(JavacNode node) {
return null;
}

private String generateNonclashingNameFor(String classGenericName, java.util.List<String> typeParamStrings) {
private java.util.HashSet<String> gatherUsedTypeNames(List<JCTypeParameter> typeParams, JCClassDecl td) {
java.util.HashSet<String> usedNames = new HashSet<String>();

// 1. Add type parameter names.
for (JCTypeParameter typeParam : typeParams)
usedNames.add(typeParam.getName().toString());

// 2. Add class name.
usedNames.add(td.name.toString());

// 3. Add used type names.
for (JCTree member : td.getMembers()) {
if (member.getKind() == com.sun.source.tree.Tree.Kind.VARIABLE && member instanceof JCVariableDecl) {
JCTree type = ((JCVariableDecl)member).getType();
if (type instanceof JCIdent)
usedNames.add(((JCIdent)type).getName().toString());
}
}

return usedNames;
}

private String generateNonclashingNameFor(String classGenericName, java.util.HashSet<String> typeParamStrings) {
if (!typeParamStrings.contains(classGenericName)) return classGenericName;
int counter = 2;
while (typeParamStrings.contains(classGenericName + counter)) counter++;
Expand Down
126 changes: 126 additions & 0 deletions test/transform/resource/after-delombok/SuperBuilderNameClashes.java
@@ -0,0 +1,126 @@
public class SuperBuilderNameClashes {
public static class GenericsClash<B, C, C2> {
@java.lang.SuppressWarnings("all")
public static abstract class GenericsClashBuilder<B, C, C2, C3 extends GenericsClash<B, C, C2>, B2 extends GenericsClashBuilder<B, C, C2, C3, B2>> {
@java.lang.SuppressWarnings("all")
protected abstract B2 self();
@java.lang.SuppressWarnings("all")
public abstract C3 build();
@java.lang.Override
@java.lang.SuppressWarnings("all")
public java.lang.String toString() {
return "SuperBuilderNameClashes.GenericsClash.GenericsClashBuilder()";
}
}
@java.lang.SuppressWarnings("all")
private static final class GenericsClashBuilderImpl<B, C, C2> extends GenericsClashBuilder<B, C, C2, GenericsClash<B, C, C2>, GenericsClashBuilderImpl<B, C, C2>> {
@java.lang.SuppressWarnings("all")
private GenericsClashBuilderImpl() {
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
protected GenericsClashBuilderImpl<B, C, C2> self() {
return this;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
public GenericsClash<B, C, C2> build() {
return new GenericsClash<B, C, C2>(this);
}
}
@java.lang.SuppressWarnings("all")
protected GenericsClash(final GenericsClashBuilder<B, C, C2, ?, ?> b) {
}
@java.lang.SuppressWarnings("all")
public static <B, C, C2> GenericsClashBuilder<B, C, C2, ?, ?> builder() {
return new GenericsClashBuilderImpl<B, C, C2>();
}
}
public static class B {
@java.lang.SuppressWarnings("all")
public static abstract class BBuilder<C extends B, B2 extends BBuilder<C, B2>> {
@java.lang.SuppressWarnings("all")
protected abstract B2 self();
@java.lang.SuppressWarnings("all")
public abstract C build();
@java.lang.Override
@java.lang.SuppressWarnings("all")
public java.lang.String toString() {
return "SuperBuilderNameClashes.B.BBuilder()";
}
}
@java.lang.SuppressWarnings("all")
private static final class BBuilderImpl extends BBuilder<B, BBuilderImpl> {
@java.lang.SuppressWarnings("all")
private BBuilderImpl() {
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
protected BBuilderImpl self() {
return this;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
public B build() {
return new B(this);
}
}
@java.lang.SuppressWarnings("all")
protected B(final BBuilder<?, ?> b) {
}
@java.lang.SuppressWarnings("all")
public static BBuilder<?, ?> builder() {
return new BBuilderImpl();
}
}
public static class C2 {
}
public static class C {
C2 c2;
@java.lang.SuppressWarnings("all")
public static abstract class CBuilder<C3 extends C, B extends CBuilder<C3, B>> {
@java.lang.SuppressWarnings("all")
private C2 c2;
@java.lang.SuppressWarnings("all")
protected abstract B self();
@java.lang.SuppressWarnings("all")
public abstract C3 build();
@java.lang.SuppressWarnings("all")
public B c2(final C2 c2) {
this.c2 = c2;
return self();
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
public java.lang.String toString() {
return "SuperBuilderNameClashes.C.CBuilder(c2=" + this.c2 + ")";
}
}
@java.lang.SuppressWarnings("all")
private static final class CBuilderImpl extends CBuilder<C, CBuilderImpl> {
@java.lang.SuppressWarnings("all")
private CBuilderImpl() {
}

@java.lang.Override
@java.lang.SuppressWarnings("all")
protected CBuilderImpl self() {
return this;
}

@java.lang.Override
@java.lang.SuppressWarnings("all")
public C build() {
return new C(this);
}
}
@java.lang.SuppressWarnings("all")
protected C(final CBuilder<?, ?> b) {
this.c2 = b.c2;
}
@java.lang.SuppressWarnings("all")
public static CBuilder<?, ?> builder() {
return new CBuilderImpl();
}
}
}
104 changes: 104 additions & 0 deletions test/transform/resource/after-ecj/SuperBuilderNameClashes.java
@@ -0,0 +1,104 @@
public class SuperBuilderNameClashes {
public static @lombok.experimental.SuperBuilder class GenericsClash<B, C, C2> {
public static abstract @java.lang.SuppressWarnings("all") class GenericsClashBuilder<B, C, C2, C3 extends GenericsClash<B, C, C2>, B2 extends GenericsClashBuilder<B, C, C2, C3, B2>> {
public GenericsClashBuilder() {
super();
}
protected abstract @java.lang.SuppressWarnings("all") B2 self();
public abstract @java.lang.SuppressWarnings("all") C3 build();
public @java.lang.Override @java.lang.SuppressWarnings("all") java.lang.String toString() {
return "SuperBuilderNameClashes.GenericsClash.GenericsClashBuilder()";
}
}
private static final @java.lang.SuppressWarnings("all") class GenericsClashBuilderImpl<B, C, C2> extends GenericsClashBuilder<B, C, C2, GenericsClash<B, C, C2>, GenericsClashBuilderImpl<B, C, C2>> {
private GenericsClashBuilderImpl() {
super();
}
protected @java.lang.Override @java.lang.SuppressWarnings("all") GenericsClashBuilderImpl<B, C, C2> self() {
return this;
}
public @java.lang.Override @java.lang.SuppressWarnings("all") GenericsClash<B, C, C2> build() {
return new GenericsClash<B, C, C2>(this);
}
}
protected @java.lang.SuppressWarnings("all") GenericsClash(final GenericsClashBuilder<B, C, C2, ?, ?> b) {
super();
}
public static @java.lang.SuppressWarnings("all") <B, C, C2>GenericsClashBuilder<B, C, C2, ?, ?> builder() {
return new GenericsClashBuilderImpl<B, C, C2>();
}
}
public static @lombok.experimental.SuperBuilder class B {
public static abstract @java.lang.SuppressWarnings("all") class BBuilder<C extends B, B2 extends BBuilder<C, B2>> {
public BBuilder() {
super();
}
protected abstract @java.lang.SuppressWarnings("all") B2 self();
public abstract @java.lang.SuppressWarnings("all") C build();
public @java.lang.Override @java.lang.SuppressWarnings("all") java.lang.String toString() {
return "SuperBuilderNameClashes.B.BBuilder()";
}
}
private static final @java.lang.SuppressWarnings("all") class BBuilderImpl extends BBuilder<B, BBuilderImpl> {
private BBuilderImpl() {
super();
}
protected @java.lang.Override @java.lang.SuppressWarnings("all") BBuilderImpl self() {
return this;
}
public @java.lang.Override @java.lang.SuppressWarnings("all") B build() {
return new B(this);
}
}
protected @java.lang.SuppressWarnings("all") B(final BBuilder<?, ?> b) {
super();
}
public static @java.lang.SuppressWarnings("all") BBuilder<?, ?> builder() {
return new BBuilderImpl();
}
}
public static class C2 {
public C2() {
super();
}
}
public static @lombok.experimental.SuperBuilder class C {
public static abstract @java.lang.SuppressWarnings("all") class CBuilder<C3 extends C, B extends CBuilder<C3, B>> {
private @java.lang.SuppressWarnings("all") C2 c2;
public CBuilder() {
super();
}
protected abstract @java.lang.SuppressWarnings("all") B self();
public abstract @java.lang.SuppressWarnings("all") C3 build();
public @java.lang.SuppressWarnings("all") B c2(final C2 c2) {
this.c2 = c2;
return self();
}
public @java.lang.Override @java.lang.SuppressWarnings("all") java.lang.String toString() {
return (("SuperBuilderNameClashes.C.CBuilder(c2=" + this.c2) + ")");
}
}
private static final @java.lang.SuppressWarnings("all") class CBuilderImpl extends CBuilder<C, CBuilderImpl> {
private CBuilderImpl() {
super();
}
protected @java.lang.Override @java.lang.SuppressWarnings("all") CBuilderImpl self() {
return this;
}
public @java.lang.Override @java.lang.SuppressWarnings("all") C build() {
return new C(this);
}
}
C2 c2;
protected @java.lang.SuppressWarnings("all") C(final CBuilder<?, ?> b) {
super();
this.c2 = b.c2;
}
public static @java.lang.SuppressWarnings("all") CBuilder<?, ?> builder() {
return new CBuilderImpl();
}
}
public SuperBuilderNameClashes() {
super();
}
}
17 changes: 17 additions & 0 deletions test/transform/resource/before/SuperBuilderNameClashes.java
@@ -0,0 +1,17 @@
public class SuperBuilderNameClashes {
@lombok.experimental.SuperBuilder
public static class GenericsClash<B, C, C2> {
}

@lombok.experimental.SuperBuilder
public static class B {
}

public static class C2 {
}

@lombok.experimental.SuperBuilder
public static class C {
C2 c2;
}
}
@@ -0,0 +1,3 @@
3 WARNING The type parameter B is hiding the type SuperBuilderNameClashes.B
3 WARNING The type parameter C is hiding the type SuperBuilderNameClashes.C
3 WARNING The type parameter C2 is hiding the type SuperBuilderNameClashes.C2

0 comments on commit 680d63e

Please sign in to comment.