Xtend refactoring handling of anonymous class #2898
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2023 itemis AG (http://www.itemis.eu) and others. | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License 2.0 which is available at | ||
| * http://www.eclipse.org/legal/epl-2.0. | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| *******************************************************************************/ | ||
| package org.eclipse.xtend.core.compiler; | ||
|
|
||
| import org.eclipse.emf.ecore.EObject; | ||
| import org.eclipse.xtend.core.xtend.AnonymousClass; | ||
| import org.eclipse.xtend.core.xtend.XtendField; | ||
| import org.eclipse.xtend.core.xtend.XtendFunction; | ||
| import org.eclipse.xtend.core.xtend.XtendMember; | ||
| import org.eclipse.xtext.common.types.JvmType; | ||
| import org.eclipse.xtext.util.IResourceScopeCache; | ||
| import org.eclipse.xtext.util.Tuples; | ||
| import org.eclipse.xtext.xbase.jvmmodel.IJvmModelAssociations; | ||
|
|
||
| import com.google.inject.Inject; | ||
|
|
||
| /** | ||
| * @author Lorenzo Bettini - Initial contribution and API | ||
| */ | ||
| public class XtendCompilerHelper { | ||
|
|
||
| @Inject | ||
| private IResourceScopeCache cache; | ||
|
|
||
| @Inject | ||
| private IJvmModelAssociations associations; | ||
|
|
||
| /** | ||
| * Assumes that the passed type is anonymous. | ||
| */ | ||
| public boolean canCompileToJavaAnonymousClass(JvmType type) { | ||
| return cache.get(Tuples.pair("anonymousJava", type), type.eResource(), () -> { | ||
| EObject sourceElement = associations.getPrimarySourceElement(type); | ||
| return sourceElement instanceof AnonymousClass && | ||
| canCompileToJavaAnonymousClass((AnonymousClass) sourceElement); | ||
| }); | ||
| } | ||
|
|
||
| public boolean canCompileToJavaAnonymousClass(AnonymousClass anonymousClass) { | ||
| return cache.get(Tuples.pair("anonymousJava", anonymousClass), anonymousClass.eResource(), () -> { | ||
| for(XtendMember member: anonymousClass.getMembers()) { | ||
| if(member instanceof XtendField || | ||
| (member instanceof XtendFunction && !((XtendFunction) member).isOverride())) | ||
| return false; | ||
| } | ||
| return true; | ||
| }); | ||
| } | ||
| } | ||
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 |
|---|---|---|
|
|
@@ -46,6 +46,12 @@ import org.eclipse.xtext.xbase.compiler.output.ITreeAppendable | |
| import org.eclipse.xtext.xbase.compiler.output.SharedAppendableState | ||
| import org.eclipse.xtext.xbase.typesystem.IBatchTypeResolver | ||
| import org.eclipse.xtext.xbase.typesystem.references.ITypeReferenceOwner | ||
| import org.eclipse.xtext.xbase.compiler.ImportManager | ||
| import org.eclipse.xtext.generator.trace.ITraceURIConverter | ||
| import org.eclipse.xtext.resource.ILocationInFileProvider | ||
| import org.eclipse.xtext.xbase.jvmmodel.IJvmModelAssociations | ||
| import org.eclipse.emf.ecore.EObject | ||
| import org.eclipse.xtend.core.compiler.output.AnonymousClassAwareTreeAppendable | ||
|
|
||
| /** | ||
| * @author Sven Efftinge - Initial contribution and API | ||
|
|
@@ -56,7 +62,8 @@ class XtendGenerator extends JvmModelGenerator implements IGenerator2 { | |
| @Inject OperationCanceledManager operationCanceledManager | ||
|
|
||
| @Inject ElementIssueProvider.Factory issueProviderFactory | ||
| @Inject XtendCompilerHelper compilerHelper | ||
|
|
||
| override doGenerate(Resource input, IFileSystemAccess fsa) { | ||
| super.doGenerate(input, fsa) | ||
| callMacroProcessors(input) | ||
|
|
@@ -164,9 +171,12 @@ class XtendGenerator extends JvmModelGenerator implements IGenerator2 { | |
| } | ||
|
|
||
| def compileLocalTypeStubs(JvmFeature feature, ITreeAppendable appendable, GeneratorConfig config) { | ||
| feature.localClasses.forEach[ | ||
| if (compilerHelper.canCompileToJavaAnonymousClass(it)) { | ||
|
There was a problem hiding this comment. Yet this code here doesn't do both. There was a problem hiding this comment. At least in the current implementation anonymous classes are local classes |
||
| return | ||
| } | ||
| val anonymousClass = sourceElements.head as AnonymousClass | ||
| appendable.newLine | ||
| val childAppendable = appendable.trace(anonymousClass) | ||
| childAppendable.append('abstract class ') | ||
| childAppendable.traceSignificant(anonymousClass).append(simpleName) | ||
|
|
@@ -320,7 +330,9 @@ class XtendGenerator extends JvmModelGenerator implements IGenerator2 { | |
| } | ||
| if (declaringType.local && it instanceof JvmOperation) { | ||
| val declarator = declaringType as JvmGenericType | ||
| if (!declarator.anonymous || | ||
|
There was a problem hiding this comment. I'm not sure whether I like the fact that the helper doesn't check the declarator itself but this code here has to do both. There was a problem hiding this comment. Indeed I had put a Javadoc comment on the helper https://github.com/eclipse/xtext/pull/2898/files/bc766b0068465148679855a36c8c9c88e5c62065#diff-c6ea2a981e27e70dc2cd53ff982ee051ac65096607807462e10196d625518f88R35 There was a problem hiding this comment. @szarnekow I've just pushed 6af742c that check for anonymous is redundant |
||
| !compilerHelper.canCompileToJavaAnonymousClass(declarator) | ||
| ) { | ||
| return result | ||
| } | ||
| } | ||
|
|
@@ -386,5 +398,9 @@ class XtendGenerator extends JvmModelGenerator implements IGenerator2 { | |
| } | ||
|
|
||
| } | ||
|
|
||
| override createAppendable(ImportManager importManager, ITraceURIConverter converter, ILocationInFileProvider locationProvider, IJvmModelAssociations jvmModelAssociations, EObject source, String indentation, String lineSeparator) { | ||
| return new AnonymousClassAwareTreeAppendable(compilerHelper, importManager, converter, locationProvider, jvmModelAssociations, source, indentation, lineSeparator) | ||
| } | ||
|
|
||
| } | ||
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,74 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2023 itemis AG (http://www.itemis.eu) and others. | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License 2.0 which is available at | ||
| * http://www.eclipse.org/legal/epl-2.0. | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| *******************************************************************************/ | ||
| package org.eclipse.xtend.core.compiler.output; | ||
|
|
||
| import java.util.Set; | ||
|
|
||
| import org.eclipse.emf.ecore.EObject; | ||
| import org.eclipse.xtend.core.compiler.XtendCompilerHelper; | ||
| import org.eclipse.xtext.generator.trace.ILocationData; | ||
| import org.eclipse.xtext.generator.trace.ITraceURIConverter; | ||
| import org.eclipse.xtext.resource.ILocationInFileProvider; | ||
| import org.eclipse.xtext.xbase.compiler.ImportManager; | ||
| import org.eclipse.xtext.xbase.compiler.output.SharedAppendableState; | ||
| import org.eclipse.xtext.xbase.compiler.output.TreeAppendable; | ||
| import org.eclipse.xtext.xbase.jvmmodel.IJvmModelAssociations; | ||
| import org.eclipse.xtext.xbase.typesystem.references.LightweightTypeReferenceSerializer; | ||
| import org.eclipse.xtext.xbase.typesystem.references.ParameterizedTypeReference; | ||
|
|
||
| /** | ||
| * A custom implementation that takes into consideration anonymous classes, | ||
| * which, in some cases, cannot be compiled into standard Java anonymous classes: | ||
| * they are compiled into nested local classes. | ||
| * | ||
| * It uses a custom {@link LightweightTypeReferenceSerializer}. | ||
| * | ||
| * @author Lorenzo Bettini - Initial contribution and API | ||
| */ | ||
| public class AnonymousClassAwareTreeAppendable extends TreeAppendable { | ||
|
|
||
| private XtendCompilerHelper compilerHelper; | ||
|
|
||
| public AnonymousClassAwareTreeAppendable(XtendCompilerHelper compilerHelper, ImportManager importManager, ITraceURIConverter converter, | ||
| ILocationInFileProvider locationProvider, IJvmModelAssociations jvmModelAssociations, EObject source, String indentation, | ||
| String lineSeparator) { | ||
| super(importManager, converter, locationProvider, jvmModelAssociations, source, indentation, lineSeparator); | ||
| this.compilerHelper = compilerHelper; | ||
| } | ||
|
|
||
| protected AnonymousClassAwareTreeAppendable(XtendCompilerHelper compilerHelper, SharedAppendableState state, ITraceURIConverter converter, | ||
| ILocationInFileProvider locationProvider, IJvmModelAssociations jvmModelAssociations, Set<ILocationData> sourceLocations, | ||
| boolean useForDebugging) { | ||
| super(state, converter, locationProvider, jvmModelAssociations, sourceLocations, useForDebugging); | ||
| this.compilerHelper = compilerHelper; | ||
| } | ||
|
|
||
| @Override | ||
| protected LightweightTypeReferenceSerializer createLightweightTypeReferenceSerializer() { | ||
| return new LightweightTypeReferenceSerializer(this) { | ||
| @Override | ||
| protected void doVisitParameterizedTypeReference(ParameterizedTypeReference reference) { | ||
| if (reference.isAnonymous() && | ||
| !compilerHelper.canCompileToJavaAnonymousClass(reference.getType())) { | ||
| // serialize the type of the generated nested local class | ||
| AnonymousClassAwareTreeAppendable.this.append(reference.getType()); | ||
| } else { | ||
| super.doVisitParameterizedTypeReference(reference); | ||
| } | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| @Override | ||
| protected TreeAppendable createChild(SharedAppendableState state, ITraceURIConverter converter, ILocationInFileProvider locationProvider, | ||
| IJvmModelAssociations jvmModelAssociations, Set<ILocationData> newData, boolean useForDebugging) { | ||
| return new AnonymousClassAwareTreeAppendable(compilerHelper, state, converter, locationProvider, jvmModelAssociations, newData, useForDebugging); | ||
| } | ||
|
|
||
| } |
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this can only answer whether a JvmType can be compiled to an anonymous class, maybe a more restrictive name should be chosen?
AnonymousClassCompilerHelper?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Indeed that was my second choice, so I'll rename it :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
By the way, we already have https://github.com/eclipse/xtext/blob/88acf1555988cd81e1756abc0d6d2c3f1f1efa11/org.eclipse.xtend.core/src/org/eclipse/xtend/core/jvmmodel/AnonymousClassUtil.java#L39
should I put the methods of
XtendCompilerHelperdirectly there?