aboutsummaryrefslogtreecommitdiff
path: root/src/lombok/javac/handlers/HandleCleanup.java
blob: 9a8cf51600a49d74707525a8e92ef68c18136ebf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
package lombok.javac.handlers;

import lombok.Cleanup;
import lombok.core.AnnotationValues;
import lombok.core.AST.Kind;
import lombok.javac.JavacAnnotationHandler;
import lombok.javac.JavacAST.Node;

import org.mangosdk.spi.ProviderFor;

import com.sun.tools.javac.tree.JCTree;
import com.sun.tools.javac.tree.TreeMaker;
import com.sun.tools.javac.tree.JCTree.JCAnnotation;
import com.sun.tools.javac.tree.JCTree.JCAssign;
import com.sun.tools.javac.tree.JCTree.JCBlock;
import com.sun.tools.javac.tree.JCTree.JCCase;
import com.sun.tools.javac.tree.JCTree.JCCatch;
import com.sun.tools.javac.tree.JCTree.JCExpression;
import com.sun.tools.javac.tree.JCTree.JCExpressionStatement;
import com.sun.tools.javac.tree.JCTree.JCFieldAccess;
import com.sun.tools.javac.tree.JCTree.JCIdent;
import com.sun.tools.javac.tree.JCTree.JCMethodDecl;
import com.sun.tools.javac.tree.JCTree.JCStatement;
import com.sun.tools.javac.tree.JCTree.JCTypeCast;
import com.sun.tools.javac.tree.JCTree.JCVariableDecl;
import com.sun.tools.javac.util.List;
import com.sun.tools.javac.util.Name;

@ProviderFor(JavacAnnotationHandler.class)
public class HandleCleanup implements JavacAnnotationHandler<Cleanup> {
	@Override public boolean handle(AnnotationValues<Cleanup> annotation, JCAnnotation ast, Node annotationNode) {
		String cleanupName = annotation.getInstance().cleanupMethod();
		if ( cleanupName.length() == 0 ) {
			annotationNode.addError("cleanupName cannot be the empty string.");
			return true;
		}
		
		if ( annotationNode.up().getKind() != Kind.LOCAL ) {
			annotationNode.addError("@Cleanup is legal only on local variable declarations.");
			return true;
		}
		
		JCVariableDecl decl = (JCVariableDecl)annotationNode.up().get();
		
		Node ancestor = annotationNode.up().directUp();
		JCTree blockNode = ancestor.get();
		
		final List<JCStatement> statements;
		if ( blockNode instanceof JCBlock ) {
			statements = ((JCBlock)blockNode).stats;
		} else if ( blockNode instanceof JCCase ) {
			statements = ((JCCase)blockNode).stats;
		} else if ( blockNode instanceof JCMethodDecl ) {
			statements = ((JCMethodDecl)blockNode).body.stats;
		} else {
			annotationNode.addError("@Cleanup is legal only on a local variable declaration inside a block.");
			return true;
		}
		
		boolean seenDeclaration = false;
		List<JCStatement> tryBlock = List.nil();
		List<JCStatement> newStatements = List.nil();
		for ( JCStatement statement : statements ) {
			if ( !seenDeclaration ) {
				if ( statement == decl ) seenDeclaration = true;
				newStatements = newStatements.append(statement);
			} else tryBlock = tryBlock.append(statement);
		}
		
		if ( !seenDeclaration ) {
			annotationNode.addError("LOMBOK BUG: Can't find this local variable declaration inside its parent.");
			return true;
		}
		
		doAssignmentCheck(annotationNode, tryBlock, decl.name);
		
		TreeMaker maker = annotationNode.getTreeMaker();
		JCFieldAccess cleanupCall = maker.Select(maker.Ident(decl.name), annotationNode.toName(cleanupName));
		List<JCStatement> finalizerBlock = List.<JCStatement>of(maker.Exec(
				maker.Apply(List.<JCExpression>nil(), cleanupCall, List.<JCExpression>nil())));
		
		JCBlock finalizer = maker.Block(0, finalizerBlock);
		newStatements = newStatements.append(maker.Try(maker.Block(0, tryBlock), List.<JCCatch>nil(), finalizer));
		
		if ( blockNode instanceof JCBlock ) {
			((JCBlock)blockNode).stats = newStatements;
		} else if ( blockNode instanceof JCCase ) {
			((JCCase)blockNode).stats = newStatements;
		} else if ( blockNode instanceof JCMethodDecl ) {
			((JCMethodDecl)blockNode).body.stats = newStatements;
		} else throw new AssertionError("Should not get here");
		
		ancestor.rebuild();
		
		return true;
	}
	
	private void doAssignmentCheck(Node node, List<JCStatement> statements, Name name) {
		for ( JCStatement statement : statements ) doAssignmentCheck0(node, statement, name);
	}
	
	private void doAssignmentCheck0(Node node, JCTree statement, Name name) {
		if ( statement instanceof JCAssign ) doAssignmentCheck0(node, ((JCAssign)statement).rhs, name);
		if ( statement instanceof JCExpressionStatement ) doAssignmentCheck0(node,
				((JCExpressionStatement)statement).expr, name);
		if ( statement instanceof JCVariableDecl ) doAssignmentCheck0(node, ((JCVariableDecl)statement).init, name);
		if ( statement instanceof JCTypeCast ) doAssignmentCheck0(node, ((JCTypeCast)statement).expr, name);
		if ( statement instanceof JCIdent ) {
			if ( ((JCIdent)statement).name.contentEquals(name) ) {
				Node problemNode = node.getNodeFor(statement);
				if ( problemNode != null ) problemNode.addWarning(
				"You're assigning a guarded variable to something else. This is a bad idea.");
			}
		}
	}
}