Added new feature: @Helper including both annotations and tests.

4 files changed, 319 insertions, 0 deletions

diff --git a/src/core/lombok/ConfigurationKeys.java b/src/core/lombok/ConfigurationKeys.java
index 699354e4..67d51895 100644
--- a/src/core/lombok/ConfigurationKeys.java
+++ b/src/core/lombok/ConfigurationKeys.java
@@ -402,6 +402,15 @@ public class ConfigurationKeys {
 	 */
 	public static final ConfigurationKey<FlagUsageType> FIELD_DEFAULTS_FLAG_USAGE = new ConfigurationKey<FlagUsageType>("lombok.fieldDefaults.flagUsage", "Emit a warning or error if @FieldDefaults is used.") {};
 	
+	// ----- Helper -----
+	
+	/**
+	 * lombok configuration: {@code lombok.helper.flagUsage} = {@code WARNING} | {@code ERROR}.
+	 * 
+	 * If set, <em>any</em> usage of {@code @Helper} results in a warning / error.
+	 */
+	public static final ConfigurationKey<FlagUsageType> HELPER_FLAG_USAGE = new ConfigurationKey<FlagUsageType>("lombok.helper.flagUsage", "Emit a warning or error if @Helper is used.") {};
+	
 	// ----- UtilityClass -----
 	
 	/**
diff --git a/src/core/lombok/eclipse/handlers/HandleHelper.java b/src/core/lombok/eclipse/handlers/HandleHelper.java
new file mode 100644
index 00000000..4e9a7c68
--- /dev/null
+++ b/src/core/lombok/eclipse/handlers/HandleHelper.java
@@ -0,0 +1,137 @@
+/*
+ * Copyright (C) 2015 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.core.handlers.HandlerUtil.handleExperimentalFlagUsage;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+
+import org.eclipse.jdt.internal.compiler.ASTVisitor;
+import org.eclipse.jdt.internal.compiler.ast.ASTNode;
+import org.eclipse.jdt.internal.compiler.ast.AbstractMethodDeclaration;
+import org.eclipse.jdt.internal.compiler.ast.AllocationExpression;
+import org.eclipse.jdt.internal.compiler.ast.Annotation;
+import org.eclipse.jdt.internal.compiler.ast.LocalDeclaration;
+import org.eclipse.jdt.internal.compiler.ast.MessageSend;
+import org.eclipse.jdt.internal.compiler.ast.MethodDeclaration;
+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.classfmt.ClassFileConstants;
+import org.eclipse.jdt.internal.compiler.lookup.BlockScope;
+import org.mangosdk.spi.ProviderFor;
+
+import lombok.ConfigurationKeys;
+import lombok.core.AST.Kind;
+import lombok.core.AnnotationValues;
+import lombok.eclipse.Eclipse;
+import lombok.eclipse.EclipseAnnotationHandler;
+import lombok.eclipse.EclipseNode;
+import lombok.experimental.Helper;
+
+/**
+ * Handles the {@code lombok.Cleanup} annotation for eclipse.
+ */
+@ProviderFor(EclipseAnnotationHandler.class)
+public class HandleHelper extends EclipseAnnotationHandler<Helper> {
+	@Override public void handle(AnnotationValues<Helper> annotation, Annotation ast, EclipseNode annotationNode) {
+		handleExperimentalFlagUsage(annotationNode, ConfigurationKeys.HELPER_FLAG_USAGE, "@Helper");
+		
+		EclipseNode annotatedType = annotationNode.up();
+		EclipseNode containingMethod = annotatedType == null ? null : annotatedType.up();
+		if (annotatedType == null || containingMethod == null || annotatedType.getKind() != Kind.TYPE || containingMethod.getKind() != Kind.METHOD) {
+			annotationNode.addError("@Helper is legal only on method-local classes.");
+			return;
+		}
+		
+		TypeDeclaration annotatedType_ = (TypeDeclaration) annotatedType.get();
+		AbstractMethodDeclaration amd = (AbstractMethodDeclaration) containingMethod.get();
+		Statement[] origStatements = amd.statements;
+		int indexOfType = -1;
+		for (int i = 0; i < origStatements.length; i++) {
+			if (origStatements[i] == annotatedType_) {
+				indexOfType = i;
+				break;
+			}
+		}
+		
+		final List<String> knownMethodNames = new ArrayList<String>();
+		
+		for (AbstractMethodDeclaration methodOfHelper : annotatedType_.methods) {
+			if (!(methodOfHelper instanceof MethodDeclaration)) continue;
+			char[] name = methodOfHelper.selector;
+			if (name != null && name.length > 0 && name[0] != '<') knownMethodNames.add(new String(name));
+		}
+		
+		Collections.sort(knownMethodNames);
+		final String[] knownMethodNames_ = knownMethodNames.toArray(new String[knownMethodNames.size()]);
+		
+		final char[] helperName = new char[annotatedType_.name.length + 1];
+		final boolean[] helperUsed = new boolean[1];
+		helperName[0] = '$';
+		System.arraycopy(annotatedType_.name, 0, helperName, 1, helperName.length - 1);
+		
+		ASTVisitor visitor = new ASTVisitor() {
+			@Override public boolean visit(MessageSend messageSend, BlockScope scope) {
+				if (messageSend.receiver instanceof ThisReference) {
+					if ((((ThisReference) messageSend.receiver).bits & ASTNode.IsImplicitThis) == 0) return true;
+				} else if (messageSend.receiver != null) return true;
+				
+				char[] name = messageSend.selector;
+				if (name == null || name.length == 0 || name[0] == '<') return true;
+				String n = new String(name);
+				if (Arrays.binarySearch(knownMethodNames_, n) < 0) return true;
+				messageSend.receiver = new SingleNameReference(helperName, Eclipse.pos(messageSend));
+				helperUsed[0] = true;
+				return true;
+			}
+		};
+		
+		for (int i = indexOfType + 1; i < origStatements.length; i++) {
+			origStatements[i].traverse(visitor, null);
+		}
+		
+		if (!helperUsed[0]) {
+			annotationNode.addWarning("No methods of this helper class are ever used.");
+			return;
+		}
+		
+		Statement[] newStatements = new Statement[origStatements.length + 1];
+		System.arraycopy(origStatements, 0, newStatements, 0, indexOfType + 1);
+		System.arraycopy(origStatements, indexOfType + 1, newStatements, indexOfType + 2, origStatements.length - indexOfType - 1);
+		LocalDeclaration decl = new LocalDeclaration(helperName, 0, 0);
+		decl.modifiers |= ClassFileConstants.AccFinal;
+		AllocationExpression alloc = new AllocationExpression();
+		alloc.type = new SingleTypeReference(annotatedType_.name, 0L);
+		decl.initialization = alloc;
+		decl.type = new SingleTypeReference(annotatedType_.name, 0L);
+		SetGeneratedByVisitor sgbvVisitor = new SetGeneratedByVisitor(annotationNode.get());
+		decl.traverse(sgbvVisitor, null);
+		newStatements[indexOfType + 1] = decl;
+		amd.statements = newStatements;
+	}
+}
diff --git a/src/core/lombok/experimental/Helper.java b/src/core/lombok/experimental/Helper.java
new file mode 100644
index 00000000..34745cbe
--- /dev/null
+++ b/src/core/lombok/experimental/Helper.java
@@ -0,0 +1,35 @@
+/*
+ * Copyright (C) 2015 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.experimental;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Use on a method local class to indicate that all methods inside should be exposed to the rest of
+ * the method as if they were helper methods.
+ */
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.SOURCE)
+public @interface Helper {}
diff --git a/src/core/lombok/javac/handlers/HandleHelper.java b/src/core/lombok/javac/handlers/HandleHelper.java
new file mode 100644
index 00000000..99131f70
--- /dev/null
+++ b/src/core/lombok/javac/handlers/HandleHelper.java
@@ -0,0 +1,138 @@
+/*
+ * Copyright (C) 2015 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.javac.handlers;
+
+import static lombok.core.handlers.HandlerUtil.*;
+import static lombok.javac.handlers.JavacHandlerUtil.*;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.Iterator;
+
+import org.mangosdk.spi.ProviderFor;
+
+import com.sun.source.tree.MethodInvocationTree;
+import com.sun.source.tree.TreeVisitor;
+import com.sun.source.util.TreeScanner;
+import com.sun.tools.javac.code.Flags;
+import com.sun.tools.javac.tree.JCTree.JCAnnotation;
+import com.sun.tools.javac.tree.JCTree.JCClassDecl;
+import com.sun.tools.javac.tree.JCTree.JCExpression;
+import com.sun.tools.javac.tree.JCTree.JCIdent;
+import com.sun.tools.javac.tree.JCTree.JCMethodDecl;
+import com.sun.tools.javac.tree.JCTree.JCMethodInvocation;
+import com.sun.tools.javac.tree.JCTree.JCStatement;
+import com.sun.tools.javac.tree.JCTree.JCVariableDecl;
+import com.sun.tools.javac.util.List;
+import com.sun.tools.javac.util.ListBuffer;
+import com.sun.tools.javac.util.Name;
+
+import lombok.ConfigurationKeys;
+import lombok.core.AST.Kind;
+import lombok.core.AnnotationValues;
+import lombok.experimental.Helper;
+import lombok.javac.JavacAnnotationHandler;
+import lombok.javac.JavacNode;
+import lombok.javac.JavacTreeMaker;
+
+@ProviderFor(JavacAnnotationHandler.class)
+public class HandleHelper extends JavacAnnotationHandler<Helper> {
+	@Override public void handle(AnnotationValues<Helper> annotation, JCAnnotation ast, JavacNode annotationNode) {
+		handleExperimentalFlagUsage(annotationNode, ConfigurationKeys.HELPER_FLAG_USAGE, "@Helper");
+		
+		deleteAnnotationIfNeccessary(annotationNode, Helper.class);
+		JavacNode annotatedType = annotationNode.up();
+		JavacNode containingMethod = annotatedType == null ? null : annotatedType.up();
+		
+		if (annotatedType == null || containingMethod == null || annotatedType.getKind() != Kind.TYPE || containingMethod.getKind() != Kind.METHOD) {
+			annotationNode.addError("@Helper is legal only on method-local classes.");
+			return;
+		}
+		
+		JCClassDecl annotatedType_ = (JCClassDecl) annotatedType.get();
+		JCMethodDecl amd = (JCMethodDecl) containingMethod.get();
+		List<JCStatement> origStatements = amd.body.stats;
+		Iterator<JCStatement> it = origStatements.iterator();
+		while (it.hasNext()) {
+			if (it.next() == annotatedType_) {
+				break;
+			}
+		}
+		
+		java.util.List<String> knownMethodNames = new ArrayList<String>();
+		
+		for (JavacNode ch : annotatedType.down()) {
+			if (ch.getKind() != Kind.METHOD) continue;
+			String n = ch.getName();
+			if (n == null || n.isEmpty() || n.charAt(0) == '<') continue;
+			knownMethodNames.add(n);
+		}
+		
+		Collections.sort(knownMethodNames);
+		final String[] knownMethodNames_ = knownMethodNames.toArray(new String[knownMethodNames.size()]);
+		
+		final Name helperName = annotationNode.toName("$" + annotatedType_.name);
+		final boolean[] helperUsed = new boolean[1];
+		final JavacTreeMaker maker = annotationNode.getTreeMaker();
+		
+		TreeVisitor<Void, Void> visitor = new TreeScanner<Void, Void>() {
+			@Override public Void visitMethodInvocation(MethodInvocationTree node, Void p) {
+				JCMethodInvocation jcmi = (JCMethodInvocation) node;
+				apply(jcmi);
+				return super.visitMethodInvocation(node, p);
+			}
+			
+			private void apply(JCMethodInvocation jcmi) {
+				if (!(jcmi.meth instanceof JCIdent)) return;
+				JCIdent jci = (JCIdent) jcmi.meth;
+				if (Arrays.binarySearch(knownMethodNames_, jci.name.toString()) < 0) return;
+				jcmi.meth = maker.Select(maker.Ident(helperName), jci.name);
+				helperUsed[0] = true;
+			}
+		};
+		
+		while (it.hasNext()) {
+			JCStatement stat = it.next();
+			stat.accept(visitor, null);
+		}
+		
+		if (!helperUsed[0]) {
+			annotationNode.addWarning("No methods of this helper class are ever used.");
+			return;
+		}
+		
+		ListBuffer<JCStatement> newStatements = new ListBuffer<JCStatement>();
+		
+		boolean mark = false;
+		for (JCStatement stat : origStatements) {
+			newStatements.append(stat);
+			if (mark || stat != annotatedType_) continue;
+			mark = true;
+			JCExpression init = maker.NewClass(null, List.<JCExpression>nil(), maker.Ident(annotatedType_.name), List.<JCExpression>nil(), null);
+			JCExpression varType = maker.Ident(annotatedType_.name);
+			JCVariableDecl decl = maker.VarDef(maker.Modifiers(Flags.FINAL), helperName, varType, init);
+			newStatements.append(decl);
+		}
+		amd.body.stats = newStatements.toList();
+	}
+}