mirror of
https://github.com/tiennm99/lombok.git
synced 2026-08-01 00:21:13 +00:00
Untested implementation of HandleWither for eclipse along with minor refactors to HandleSetter
This commit is contained in:
Reinier Zwitserloot
@@ -476,6 +476,31 @@ public class EclipseHandlerUtil {
|
||||
return typeMatches(type, node, ((Annotation)node.get()).type);
|
||||
}
|
||||
|
||||
public static TypeReference cloneSelfType(EclipseNode context, ASTNode source) {
|
||||
int pS = source.sourceStart, pE = source.sourceEnd;
|
||||
long p = (long)pS << 32 | pE;
|
||||
EclipseNode type = context;
|
||||
TypeReference result = null;
|
||||
while (type != null && type.getKind() != Kind.TYPE) type = type.up();
|
||||
if (type != null && type.get() instanceof TypeDeclaration) {
|
||||
TypeDeclaration typeDecl = (TypeDeclaration) type.get();
|
||||
if (typeDecl.typeParameters != null && typeDecl.typeParameters.length > 0) {
|
||||
TypeReference[] refs = new TypeReference[typeDecl.typeParameters.length];
|
||||
int idx = 0;
|
||||
for (TypeParameter param : typeDecl.typeParameters) {
|
||||
TypeReference typeRef = new SingleTypeReference(param.name, (long)param.sourceStart << 32 | param.sourceEnd);
|
||||
setGeneratedBy(typeRef, source);
|
||||
refs[idx++] = typeRef;
|
||||
}
|
||||
result = new ParameterizedSingleTypeReference(typeDecl.name, refs, 0, p);
|
||||
} else {
|
||||
result = new SingleTypeReference(((TypeDeclaration)type.get()).name, p);
|
||||
}
|
||||
}
|
||||
if (result != null) setGeneratedBy(result, source);
|
||||
return result;
|
||||
}
|
||||
|
||||
public static TypeReference makeType(TypeBinding binding, ASTNode pos, boolean allowCompound) {
|
||||
int dims = binding.dimensions();
|
||||
binding = binding.leafComponentType();
|
||||
|
||||
@@ -46,14 +46,11 @@ import org.eclipse.jdt.internal.compiler.ast.Expression;
|
||||
import org.eclipse.jdt.internal.compiler.ast.FieldDeclaration;
|
||||
import org.eclipse.jdt.internal.compiler.ast.MethodDeclaration;
|
||||
import org.eclipse.jdt.internal.compiler.ast.NameReference;
|
||||
import org.eclipse.jdt.internal.compiler.ast.ParameterizedSingleTypeReference;
|
||||
import org.eclipse.jdt.internal.compiler.ast.ReturnStatement;
|
||||
import org.eclipse.jdt.internal.compiler.ast.SingleNameReference;
|
||||
import org.eclipse.jdt.internal.compiler.ast.SingleTypeReference;
|
||||
import org.eclipse.jdt.internal.compiler.ast.Statement;
|
||||
import org.eclipse.jdt.internal.compiler.ast.ThisReference;
|
||||
import org.eclipse.jdt.internal.compiler.ast.TypeDeclaration;
|
||||
import org.eclipse.jdt.internal.compiler.ast.TypeParameter;
|
||||
import org.eclipse.jdt.internal.compiler.ast.TypeReference;
|
||||
import org.eclipse.jdt.internal.compiler.classfmt.ClassFileConstants;
|
||||
import org.eclipse.jdt.internal.compiler.lookup.TypeIds;
|
||||
@@ -183,11 +180,11 @@ public class HandleSetter extends EclipseAnnotationHandler<Setter> {
|
||||
}
|
||||
}
|
||||
|
||||
MethodDeclaration method = generateSetter((TypeDeclaration) fieldNode.up().get(), fieldNode, setterName, shouldReturnThis, modifier, source);
|
||||
MethodDeclaration method = createSetter((TypeDeclaration) fieldNode.up().get(), fieldNode, setterName, shouldReturnThis, modifier, source);
|
||||
injectMethod(fieldNode.up(), method);
|
||||
}
|
||||
|
||||
private MethodDeclaration generateSetter(TypeDeclaration parent, EclipseNode fieldNode, String name, boolean shouldReturnThis, int modifier, ASTNode source) {
|
||||
private MethodDeclaration createSetter(TypeDeclaration parent, EclipseNode fieldNode, String name, boolean shouldReturnThis, int modifier, ASTNode source) {
|
||||
FieldDeclaration field = (FieldDeclaration) fieldNode.get();
|
||||
int pS = source.sourceStart, pE = source.sourceEnd;
|
||||
long p = (long)pS << 32 | pE;
|
||||
@@ -195,29 +192,15 @@ public class HandleSetter extends EclipseAnnotationHandler<Setter> {
|
||||
setGeneratedBy(method, source);
|
||||
method.modifiers = modifier;
|
||||
if (shouldReturnThis) {
|
||||
EclipseNode type = fieldNode;
|
||||
while (type != null && type.getKind() != Kind.TYPE) type = type.up();
|
||||
if (type != null && type.get() instanceof TypeDeclaration) {
|
||||
TypeDeclaration typeDecl = (TypeDeclaration) type.get();
|
||||
if (typeDecl.typeParameters != null && typeDecl.typeParameters.length > 0) {
|
||||
TypeReference[] refs = new TypeReference[typeDecl.typeParameters.length];
|
||||
int idx = 0;
|
||||
for (TypeParameter param : typeDecl.typeParameters) {
|
||||
TypeReference typeRef = new SingleTypeReference(param.name, (long)param.sourceStart << 32 | param.sourceEnd);
|
||||
setGeneratedBy(typeRef, source);
|
||||
refs[idx++] = typeRef;
|
||||
}
|
||||
method.returnType = new ParameterizedSingleTypeReference(typeDecl.name, refs, 0, p);
|
||||
} else method.returnType = new SingleTypeReference(((TypeDeclaration)type.get()).name, p);
|
||||
}
|
||||
method.returnType = cloneSelfType(fieldNode, source);
|
||||
}
|
||||
|
||||
if (method.returnType == null) {
|
||||
method.returnType = TypeReference.baseTypeReference(TypeIds.T_void, 0);
|
||||
method.returnType.sourceStart = pS; method.returnType.sourceEnd = pE;
|
||||
setGeneratedBy(method.returnType, source);
|
||||
shouldReturnThis = false;
|
||||
}
|
||||
setGeneratedBy(method.returnType, source);
|
||||
if (isFieldDeprecated(fieldNode)) {
|
||||
method.annotations = new Annotation[] { generateDeprecatedAnnotation(source) };
|
||||
}
|
||||
|
||||
@@ -0,0 +1,271 @@
|
||||
/*
|
||||
* Copyright (C) 2012 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
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
package lombok.eclipse.handlers;
|
||||
|
||||
import static lombok.eclipse.Eclipse.*;
|
||||
import static lombok.eclipse.handlers.EclipseHandlerUtil.*;
|
||||
|
||||
import java.lang.reflect.Modifier;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Collection;
|
||||
import java.util.List;
|
||||
|
||||
import lombok.AccessLevel;
|
||||
import lombok.core.AST.Kind;
|
||||
import lombok.core.AnnotationValues;
|
||||
import lombok.core.TransformationsUtil;
|
||||
import lombok.eclipse.EclipseAnnotationHandler;
|
||||
import lombok.eclipse.EclipseNode;
|
||||
import lombok.eclipse.handlers.EclipseHandlerUtil.FieldAccess;
|
||||
import lombok.experimental.Wither;
|
||||
|
||||
import org.eclipse.jdt.internal.compiler.ast.ASTNode;
|
||||
import org.eclipse.jdt.internal.compiler.ast.AllocationExpression;
|
||||
import org.eclipse.jdt.internal.compiler.ast.Annotation;
|
||||
import org.eclipse.jdt.internal.compiler.ast.Argument;
|
||||
import org.eclipse.jdt.internal.compiler.ast.ConditionalExpression;
|
||||
import org.eclipse.jdt.internal.compiler.ast.EqualExpression;
|
||||
import org.eclipse.jdt.internal.compiler.ast.Expression;
|
||||
import org.eclipse.jdt.internal.compiler.ast.FieldDeclaration;
|
||||
import org.eclipse.jdt.internal.compiler.ast.MethodDeclaration;
|
||||
import org.eclipse.jdt.internal.compiler.ast.OperatorIds;
|
||||
import org.eclipse.jdt.internal.compiler.ast.ReturnStatement;
|
||||
import org.eclipse.jdt.internal.compiler.ast.SingleNameReference;
|
||||
import org.eclipse.jdt.internal.compiler.ast.Statement;
|
||||
import org.eclipse.jdt.internal.compiler.ast.ThisReference;
|
||||
import org.eclipse.jdt.internal.compiler.ast.TypeDeclaration;
|
||||
import org.eclipse.jdt.internal.compiler.ast.TypeReference;
|
||||
import org.eclipse.jdt.internal.compiler.classfmt.ClassFileConstants;
|
||||
import org.mangosdk.spi.ProviderFor;
|
||||
|
||||
@ProviderFor(EclipseAnnotationHandler.class)
|
||||
public class HandleWither extends EclipseAnnotationHandler<Wither> {
|
||||
public boolean generateWitherForType(EclipseNode typeNode, EclipseNode pos, AccessLevel level, boolean checkForTypeLevelWither) {
|
||||
if (checkForTypeLevelWither) {
|
||||
if (typeNode != null) for (EclipseNode child : typeNode.down()) {
|
||||
if (child.getKind() == Kind.ANNOTATION) {
|
||||
if (annotationTypeMatches(Wither.class, child)) {
|
||||
//The annotation will make it happen, so we can skip it.
|
||||
return true;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
TypeDeclaration typeDecl = null;
|
||||
if (typeNode.get() instanceof TypeDeclaration) typeDecl = (TypeDeclaration) typeNode.get();
|
||||
int modifiers = typeDecl == null ? 0 : typeDecl.modifiers;
|
||||
boolean notAClass = (modifiers &
|
||||
(ClassFileConstants.AccInterface | ClassFileConstants.AccAnnotation | ClassFileConstants.AccEnum)) != 0;
|
||||
|
||||
if (typeDecl == null || notAClass) {
|
||||
pos.addError("@Wither is only supported on a class or a field.");
|
||||
return false;
|
||||
}
|
||||
|
||||
for (EclipseNode field : typeNode.down()) {
|
||||
if (field.getKind() != Kind.FIELD) continue;
|
||||
FieldDeclaration fieldDecl = (FieldDeclaration) field.get();
|
||||
if (!filterField(fieldDecl)) continue;
|
||||
|
||||
//Skip final fields.
|
||||
if ((fieldDecl.modifiers & ClassFileConstants.AccFinal) != 0 && fieldDecl.initialization != null) continue;
|
||||
|
||||
generateWitherForField(field, pos.get(), level);
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Generates a wither on the stated field.
|
||||
*
|
||||
* Used by {@link HandleValue}.
|
||||
*
|
||||
* The difference between this call and the handle method is as follows:
|
||||
*
|
||||
* If there is a {@code lombok.experimental.Wither} annotation on the field, it is used and the
|
||||
* same rules apply (e.g. warning if the method already exists, stated access level applies).
|
||||
* If not, the wither is still generated if it isn't already there, though there will not
|
||||
* be a warning if its already there. The default access level is used.
|
||||
*/
|
||||
public void generateWitherForField(EclipseNode fieldNode, ASTNode pos, AccessLevel level) {
|
||||
for (EclipseNode child : fieldNode.down()) {
|
||||
if (child.getKind() == Kind.ANNOTATION) {
|
||||
if (annotationTypeMatches(Wither.class, child)) {
|
||||
//The annotation will make it happen, so we can skip it.
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
createWitherForField(level, fieldNode, fieldNode, pos, false);
|
||||
}
|
||||
|
||||
@Override public void handle(AnnotationValues<Wither> annotation, Annotation ast, EclipseNode annotationNode) {
|
||||
EclipseNode node = annotationNode.up();
|
||||
AccessLevel level = annotation.getInstance().value();
|
||||
if (level == AccessLevel.NONE || node == null) return;
|
||||
|
||||
switch (node.getKind()) {
|
||||
case FIELD:
|
||||
createWitherForFields(level, annotationNode.upFromAnnotationToFields(), annotationNode, annotationNode.get(), true);
|
||||
break;
|
||||
case TYPE:
|
||||
generateWitherForType(node, annotationNode, level, false);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
private void createWitherForFields(AccessLevel level, Collection<EclipseNode> fieldNodes, EclipseNode errorNode, ASTNode source, boolean whineIfExists) {
|
||||
for (EclipseNode fieldNode : fieldNodes) {
|
||||
createWitherForField(level, fieldNode, errorNode, source, whineIfExists);
|
||||
}
|
||||
}
|
||||
|
||||
private void createWitherForField(AccessLevel level,
|
||||
EclipseNode fieldNode, EclipseNode errorNode, ASTNode source, boolean whineIfExists) {
|
||||
if (fieldNode.getKind() != Kind.FIELD) {
|
||||
errorNode.addError("@Wither is only supported on a class or a field.");
|
||||
return;
|
||||
}
|
||||
|
||||
FieldDeclaration field = (FieldDeclaration) fieldNode.get();
|
||||
TypeReference fieldType = copyType(field.type, source);
|
||||
boolean isBoolean = nameEquals(fieldType.getTypeName(), "boolean") && fieldType.dimensions() == 0;
|
||||
String witherName = toWitherName(fieldNode, isBoolean);
|
||||
|
||||
if (witherName == null) {
|
||||
errorNode.addWarning("Not generating wither for this field: It does not fit your @Accessors prefix list.");
|
||||
return;
|
||||
}
|
||||
|
||||
if ((field.modifiers & ClassFileConstants.AccStatic) != 0) {
|
||||
errorNode.addWarning("Not generating wither for this field: Withers cannot be generated for static fields.");
|
||||
return;
|
||||
}
|
||||
|
||||
if ((field.modifiers & ClassFileConstants.AccFinal) != 0 && field.initialization != null) {
|
||||
errorNode.addWarning("Not generating wither for this field: Withers cannot be generated for final, initialized fields.");
|
||||
return;
|
||||
}
|
||||
|
||||
if (field.name != null && field.name.length > 0 && field.name[0] == '$') {
|
||||
errorNode.addWarning("Not generating wither for this field: Withers cannot be generated for fields starting with $.");
|
||||
return;
|
||||
}
|
||||
|
||||
for (String altName : toAllWitherNames(fieldNode, isBoolean)) {
|
||||
switch (methodExists(altName, fieldNode, false, 1)) {
|
||||
case EXISTS_BY_LOMBOK:
|
||||
return;
|
||||
case EXISTS_BY_USER:
|
||||
if (whineIfExists) {
|
||||
String altNameExpl = "";
|
||||
if (!altName.equals(witherName)) altNameExpl = String.format(" (%s)", altName);
|
||||
errorNode.addWarning(
|
||||
String.format("Not generating %s(): A method with that name already exists%s", witherName, altNameExpl));
|
||||
}
|
||||
return;
|
||||
default:
|
||||
case NOT_EXISTS:
|
||||
//continue scanning the other alt names.
|
||||
}
|
||||
}
|
||||
|
||||
int modifier = toEclipseModifier(level);
|
||||
|
||||
MethodDeclaration method = createWither((TypeDeclaration) fieldNode.up().get(), fieldNode, witherName, modifier, source);
|
||||
injectMethod(fieldNode.up(), method);
|
||||
}
|
||||
|
||||
private MethodDeclaration createWither(TypeDeclaration parent, EclipseNode fieldNode, String name, int modifier, ASTNode source) {
|
||||
if (name == null) return null;
|
||||
FieldDeclaration field = (FieldDeclaration) fieldNode.get();
|
||||
int pS = source.sourceStart, pE = source.sourceEnd;
|
||||
long p = (long)pS << 32 | pE;
|
||||
MethodDeclaration method = new MethodDeclaration(parent.compilationResult);
|
||||
method.modifiers = modifier;
|
||||
method.returnType = cloneSelfType(fieldNode, source);
|
||||
if (method.returnType == null) return null;
|
||||
|
||||
if (isFieldDeprecated(fieldNode)) {
|
||||
method.annotations = new Annotation[] { generateDeprecatedAnnotation(source) };
|
||||
}
|
||||
Argument param = new Argument(field.name, p, copyType(field.type, source), Modifier.FINAL);
|
||||
param.sourceStart = pS; param.sourceEnd = pE;
|
||||
method.arguments = new Argument[] { param };
|
||||
method.selector = name.toCharArray();
|
||||
method.binding = null;
|
||||
method.thrownExceptions = null;
|
||||
method.typeParameters = null;
|
||||
method.bits |= ECLIPSE_DO_NOT_TOUCH_FLAG;
|
||||
|
||||
List<Expression> args = new ArrayList<Expression>();
|
||||
for (EclipseNode child : fieldNode.up().down()) {
|
||||
if (child.getKind() != Kind.FIELD) continue;
|
||||
FieldDeclaration childDecl = (FieldDeclaration) child.get();
|
||||
// Skip fields that start with $
|
||||
if (childDecl.name.toString().startsWith("$")) continue;
|
||||
long fieldFlags = childDecl.modifiers;
|
||||
// Skip static fields.
|
||||
if ((fieldFlags & ClassFileConstants.AccStatic) != 0) continue;
|
||||
// Skip initialized final fields.
|
||||
if (((fieldFlags & ClassFileConstants.AccFinal) != 0) && childDecl.initialization != null) continue;
|
||||
if (child.get() == fieldNode.get()) {
|
||||
args.add(new SingleNameReference(field.name, p));
|
||||
} else {
|
||||
args.add(createFieldAccessor(child, FieldAccess.ALWAYS_FIELD, source));
|
||||
}
|
||||
}
|
||||
|
||||
AllocationExpression constructorCall = new AllocationExpression();
|
||||
constructorCall.arguments = args.toArray(new Expression[0]);
|
||||
constructorCall.type = cloneSelfType(fieldNode, source);
|
||||
|
||||
Expression identityCheck = new EqualExpression(
|
||||
new SingleNameReference(field.name, p),
|
||||
createFieldAccessor(fieldNode, FieldAccess.ALWAYS_FIELD, source),
|
||||
OperatorIds.EQUAL_EQUAL);
|
||||
ThisReference thisRef = new ThisReference(pS, pE);
|
||||
Expression conditional = new ConditionalExpression(identityCheck, thisRef, constructorCall);
|
||||
Statement returnStatement = new ReturnStatement(conditional, pS, pE);
|
||||
method.bodyStart = method.declarationSourceStart = method.sourceStart = source.sourceStart;
|
||||
method.bodyEnd = method.declarationSourceEnd = method.sourceEnd = source.sourceEnd;
|
||||
|
||||
Annotation[] nonNulls = findAnnotations(field, TransformationsUtil.NON_NULL_PATTERN);
|
||||
Annotation[] nullables = findAnnotations(field, TransformationsUtil.NULLABLE_PATTERN);
|
||||
List<Statement> statements = new ArrayList<Statement>(5);
|
||||
if (nonNulls.length > 0) {
|
||||
Statement nullCheck = generateNullCheck(field, source);
|
||||
if (nullCheck != null) statements.add(nullCheck);
|
||||
}
|
||||
statements.add(returnStatement);
|
||||
|
||||
method.statements = statements.toArray(new Statement[0]);
|
||||
|
||||
Annotation[] copiedAnnotations = copyAnnotations(source, nonNulls, nullables);
|
||||
if (copiedAnnotations.length != 0) param.annotations = copiedAnnotations;
|
||||
method.traverse(new SetGeneratedByVisitor(source), parent.scope);
|
||||
return method;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user