-
Notifications
You must be signed in to change notification settings - Fork 194
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
GROOVY-5728, GROOVY-6747, GROOVY-7686
- Loading branch information
1 parent
3c14090
commit 3a033f0
Showing
17 changed files
with
1,458 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
226 changes: 226 additions & 0 deletions
226
base/org.codehaus.groovy25/src/org/codehaus/groovy/classgen/EnumCompletionVisitor.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,226 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.codehaus.groovy.classgen; | ||
|
|
||
| import org.codehaus.groovy.ast.ClassCodeVisitorSupport; | ||
| import org.codehaus.groovy.ast.ClassHelper; | ||
| import org.codehaus.groovy.ast.ClassNode; | ||
| import org.codehaus.groovy.ast.CodeVisitorSupport; | ||
| import org.codehaus.groovy.ast.ConstructorNode; | ||
| import org.codehaus.groovy.ast.EnumConstantClassNode; | ||
| import org.codehaus.groovy.ast.InnerClassNode; | ||
| import org.codehaus.groovy.ast.Parameter; | ||
| import org.codehaus.groovy.ast.expr.ArgumentListExpression; | ||
| import org.codehaus.groovy.ast.expr.CastExpression; | ||
| import org.codehaus.groovy.ast.expr.ConstantExpression; | ||
| import org.codehaus.groovy.ast.expr.ConstructorCallExpression; | ||
| import org.codehaus.groovy.ast.expr.Expression; | ||
| import org.codehaus.groovy.ast.expr.TupleExpression; | ||
| import org.codehaus.groovy.ast.expr.VariableExpression; | ||
| import org.codehaus.groovy.ast.stmt.BlockStatement; | ||
| import org.codehaus.groovy.ast.stmt.ExpressionStatement; | ||
| import org.codehaus.groovy.ast.stmt.Statement; | ||
| import org.codehaus.groovy.control.CompilationUnit; | ||
| import org.codehaus.groovy.control.SourceUnit; | ||
| import org.codehaus.groovy.transform.TupleConstructorASTTransformation; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
|
|
||
| import static org.apache.groovy.ast.tools.ClassNodeUtils.addGeneratedConstructor; | ||
| import static groovyjarjarasm.asm.Opcodes.ACC_PRIVATE; | ||
| import static groovyjarjarasm.asm.Opcodes.ACC_SYNTHETIC; | ||
|
|
||
| /** | ||
| * Enums have a parent constructor with two arguments from java.lang.Enum. | ||
| * This visitor adds those two arguments into manually created constructors | ||
| * and performs the necessary super call. | ||
| */ | ||
| public class EnumCompletionVisitor extends ClassCodeVisitorSupport { | ||
| private final SourceUnit sourceUnit; | ||
|
|
||
| public EnumCompletionVisitor(CompilationUnit cu, SourceUnit su) { | ||
| sourceUnit = su; | ||
| } | ||
|
|
||
| public void visitClass(ClassNode node) { | ||
| if (!node.isEnum()) return; | ||
| completeEnum(node); | ||
| } | ||
|
|
||
| protected SourceUnit getSourceUnit() { | ||
| return sourceUnit; | ||
| } | ||
|
|
||
| private void completeEnum(ClassNode enumClass) { | ||
| boolean isAic = isAnonymousInnerClass(enumClass); | ||
| /* GRECLIPSE edit -- GROOVY-6747 | ||
| if (enumClass.getDeclaredConstructors().isEmpty()) { | ||
| */ | ||
| if (nonSyntheticConstructors(enumClass).isEmpty()) { | ||
| // GRECLIPSE end | ||
| addImplicitConstructors(enumClass, isAic); | ||
| } | ||
|
|
||
| /* GRECLIPSE edit -- GROOVY-6747 | ||
| for (ConstructorNode ctor : enumClass.getDeclaredConstructors()) { | ||
| */ | ||
| for (ConstructorNode ctor : nonSyntheticConstructors(enumClass)) { | ||
| // GRECLIPSE end | ||
| transformConstructor(ctor, isAic); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Add map and no-arg constructor or mirror those of the superclass (i.e. base enum). | ||
| */ | ||
| private static void addImplicitConstructors(ClassNode enumClass, boolean aic) { | ||
| /* GRECLIPSE edit -- GROOVY-6747 | ||
| if (aic) { | ||
| ClassNode sn = enumClass.getSuperClass(); | ||
| List<ConstructorNode> sctors = new ArrayList<ConstructorNode>(sn.getDeclaredConstructors()); | ||
| if (sctors.isEmpty()) { | ||
| addMapConstructors(enumClass); | ||
| } else { | ||
| for (ConstructorNode constructorNode : sctors) { | ||
| ConstructorNode init = new ConstructorNode(ACC_PUBLIC, constructorNode.getParameters(), ClassNode.EMPTY_ARRAY, new BlockStatement()); | ||
| enumClass.addConstructor(init); | ||
| } | ||
| } | ||
| } else { | ||
| addMapConstructors(enumClass); | ||
| } | ||
| */ | ||
| if (aic) { | ||
| List<ConstructorNode> superCtors = nonSyntheticConstructors(enumClass.getSuperClass()); | ||
| if (!superCtors.isEmpty()) { | ||
| for (ConstructorNode ctor : superCtors) { | ||
| addGeneratedConstructor(enumClass, ACC_PRIVATE, ctor.getParameters(), ClassNode.EMPTY_ARRAY, new BlockStatement()); | ||
| } | ||
| return; | ||
| } | ||
| } | ||
| addMapConstructors(enumClass); | ||
| // GRECLIPSE end | ||
| } | ||
|
|
||
| /** | ||
| * If constructor does not define a call to super, then transform constructor | ||
| * to get String,int parameters at beginning and add call super(String,int). | ||
| */ | ||
| private void transformConstructor(ConstructorNode ctor, boolean isAic) { | ||
| boolean chainedThisConstructorCall = false; | ||
| ConstructorCallExpression cce = null; | ||
| if (ctor.firstStatementIsSpecialConstructorCall()) { | ||
| Statement code = ctor.getFirstStatement(); | ||
| cce = (ConstructorCallExpression) ((ExpressionStatement) code).getExpression(); | ||
| if (cce.isSuperCall()) return; | ||
| // must be call to this(...) | ||
| chainedThisConstructorCall = true; | ||
| } | ||
| // we need to add parameters | ||
| Parameter[] oldP = ctor.getParameters(); | ||
| Parameter[] newP = new Parameter[oldP.length + 2]; | ||
| String stringParameterName = getUniqueVariableName("__str", ctor.getCode()); | ||
| newP[0] = new Parameter(ClassHelper.STRING_TYPE, stringParameterName); | ||
| String intParameterName = getUniqueVariableName("__int", ctor.getCode()); | ||
| newP[1] = new Parameter(ClassHelper.int_TYPE, intParameterName); | ||
| System.arraycopy(oldP, 0, newP, 2, oldP.length); | ||
| ctor.setParameters(newP); | ||
| VariableExpression stringVariable = new VariableExpression(newP[0]); | ||
| VariableExpression intVariable = new VariableExpression(newP[1]); | ||
| if (chainedThisConstructorCall) { | ||
| TupleExpression args = (TupleExpression) cce.getArguments(); | ||
| List<Expression> argsExprs = args.getExpressions(); | ||
| argsExprs.add(0, stringVariable); | ||
| argsExprs.add(1, intVariable); | ||
| } else { | ||
| // add a super call | ||
| List<Expression> args = new ArrayList<Expression>(); | ||
| args.add(stringVariable); | ||
| args.add(intVariable); | ||
| if (isAic) { | ||
| for (Parameter parameter : oldP) { | ||
| args.add(new VariableExpression(parameter.getName())); | ||
| } | ||
| // GRECLIPSE add -- GROOVY-6747 | ||
| ClassNode enumClass = ctor.getDeclaringClass().getSuperClass(); | ||
| makeBridgeConstructor(enumClass, newP); // bridge enum's private constructor | ||
| args.add(new CastExpression(enumClass.getPlainNodeReference(), ConstantExpression.NULL)); | ||
| // GRECLIPSE end | ||
| } | ||
| cce = new ConstructorCallExpression(ClassNode.SUPER, new ArgumentListExpression(args)); | ||
| BlockStatement code = new BlockStatement(); | ||
| code.addStatement(new ExpressionStatement(cce)); | ||
| Statement oldCode = ctor.getCode(); | ||
| if (oldCode != null) code.addStatement(oldCode); | ||
| ctor.setCode(code); | ||
| } | ||
| } | ||
|
|
||
| private static void addMapConstructors(ClassNode enumClass) { | ||
| TupleConstructorASTTransformation.addSpecialMapConstructors(ACC_PRIVATE, enumClass, "One of the enum constants for enum " + enumClass.getName() + | ||
| " was initialized with null. Please use a non-null value or define your own constructor.", true); | ||
| } | ||
|
|
||
| // GRECLIPSE add | ||
| /** | ||
| * Ensures the enum type {@code e} has an accessible constructor for its AIC | ||
| * constant class to call. This constructor delegates to the enum's private | ||
| * constructor. | ||
| */ | ||
| private static void makeBridgeConstructor(final ClassNode e, final Parameter[] p) { | ||
| Parameter[] newP = new Parameter[p.length + 1]; | ||
| for (int i = 0; i < p.length; i += 1) { | ||
| newP[i] = new Parameter(p[i].getType(), "p" + i); | ||
| } | ||
| newP[p.length] = new Parameter(e.getPlainNodeReference(), "$anonymous"); | ||
|
|
||
| if (e.getDeclaredConstructor(newP) == null) { | ||
| ArgumentListExpression args = new ArgumentListExpression(); | ||
| for (int i = 0; i < p.length; i += 1) args.addExpression(new VariableExpression(newP[i])); | ||
| Statement thisCtorCall = new ExpressionStatement(new ConstructorCallExpression(ClassNode.THIS, args)); | ||
| addGeneratedConstructor(e, ACC_SYNTHETIC, newP, ClassNode.EMPTY_ARRAY, thisCtorCall).setSynthetic(true); | ||
| } | ||
| } | ||
|
|
||
| private static List<ConstructorNode> nonSyntheticConstructors(final ClassNode cn) { | ||
| return cn.getDeclaredConstructors().stream().filter(c -> !c.isSynthetic()).collect(java.util.stream.Collectors.toList()); | ||
| } | ||
| // GRECLIPSE end | ||
|
|
||
| private String getUniqueVariableName(final String name, Statement code) { | ||
| if (code == null) return name; | ||
| final Object[] found = new Object[1]; | ||
| CodeVisitorSupport cv = new CodeVisitorSupport() { | ||
| public void visitVariableExpression(VariableExpression expression) { | ||
| if (expression.getName().equals(name)) found[0] = Boolean.TRUE; | ||
| } | ||
| }; | ||
| code.visit(cv); | ||
| if (found[0] != null) return getUniqueVariableName("_" + name, code); | ||
| return name; | ||
| } | ||
|
|
||
| private static boolean isAnonymousInnerClass(ClassNode enumClass) { | ||
| if (!(enumClass instanceof EnumConstantClassNode)) return false; | ||
| InnerClassNode ic = (InnerClassNode) enumClass; | ||
| return ic.getVariableScope() == null; | ||
| } | ||
| } |
Oops, something went wrong.