Skip to content

Commit

Permalink
Fix for #760: propose completions for super trait methods and properties
Browse files Browse the repository at this point in the history
  • Loading branch information
@eric-milles
eric-milles committed Aug 20, 2020
1 parent 142cec9 commit 8fd19cb
Show file tree
Hide file tree
Showing 3 changed files with 213 additions and 19 deletions.
100 changes: 98 additions & 2 deletions ...assist.test/src/org/codehaus/groovy/eclipse/codeassist/tests/MethodCompletionTests.groovy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -427,7 +427,6 @@ final class MethodCompletionTests extends CompletionTestSuite {
| String getFoo() { 'foo' }
|}
|'''.stripMargin()

buildProject()

String contents = '''\
Expand Down Expand Up @@ -1114,7 +1113,7 @@ final class MethodCompletionTests extends CompletionTestSuite {
|}
|'''.stripMargin()
ICompletionProposal[] proposals = createProposalsAtOffset(contents.replace('x', ''), contents.indexOf('x'))
proposalExists(proposals, 'm1', 1)
proposalExists(proposals, 'm1', 2)
proposalExists(proposals, 'm2', 0)
proposalExists(proposals, 'm3', 1)
proposalExists(proposals, 'm4', 1)
Expand Down Expand Up @@ -1202,6 +1201,103 @@ final class MethodCompletionTests extends CompletionTestSuite {
proposalExists(proposals, 'm1', 0)
}

@Test // https://github.com/groovy/groovy-eclipse/issues/760
void testTraitMethods11() {
addGroovySource '''\
|package p
|trait T {
| def m1() {}
|}
|'''.stripMargin(), 'T', 'p'
buildProject()

String contents = '''\
|class C implements p.T {
| def m1() {}
| void test() {
| x
| }
|}
|'''.stripMargin()
ICompletionProposal[] proposals = createProposalsAtOffset(contents.replace('x', ''), contents.indexOf('x'))
proposalExists(proposals, 'm1', 2)

applyProposalAndCheck(findFirstProposal(proposals, 'm1() : Object - p.T'), '''\
|import p.T
|
|class C implements p.T {
| def m1() {}
| void test() {
| T.super.m1()
| }
|}
|'''.stripMargin())
}

@Test // https://github.com/groovy/groovy-eclipse/issues/760
void testTraitMethods12() {
addGroovySource '''\
|package p
|trait T {
| static m1() {}
|}
|'''.stripMargin(), 'T', 'p'
buildProject()

String contents = '''\
|class C implements p.T {
| static m1() {}
| void test() {
| x
| }
|}
|'''.stripMargin()
ICompletionProposal[] proposals = createProposalsAtOffset(contents.replace('x', ''), contents.indexOf('x'))
proposalExists(proposals, 'm1', 2)

applyProposalAndCheck(findFirstProposal(proposals, 'm1() : Object - p.T'), '''\
|import p.T
|
|class C implements p.T {
| static m1() {}
| void test() {
| T.super.m1()
| }
|}
|'''.stripMargin())
}

@Test // https://github.com/groovy/groovy-eclipse/issues/760
void testTraitMethods13() {
addGroovySource '''\
|package p
|trait T {
| def getFoo() { 'foo' }
|}
|'''.stripMargin(), 'T', 'p'
buildProject()

String contents = '''\
|class C implements p.T {
| void test() {
| x
| }
|}
|'''.stripMargin()
ICompletionProposal[] proposals = createProposalsAtOffset(contents.replace('x', ''), contents.indexOf('x'))
proposalExists(proposals, 'foo', 2)

applyProposalAndCheck(findFirstProposal(proposals, 'foo : Object - T'), '''\
|import p.T
|
|class C implements p.T {
| void test() {
| T.super.foo
| }
|}
|'''.stripMargin())
}

@Test
void testTraitSyntheticMethods1() {
String contents = '''\
Expand Down
4 changes: 2 additions & 2 deletions ...deassist/src/org/codehaus/groovy/eclipse/codeassist/creators/AbstractProposalCreator.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,9 @@ public void setNameMatchingStrategy(BiPredicate<String, String> strategy) {

//--------------------------------------------------------------------------

protected static FieldNode createMockField(MethodNode method) {
protected static FieldNode createMockField(final MethodNode method) {
String fieldName = ProposalUtils.createMockFieldName(method.getName());
int fieldModifiers = method.getModifiers() | (GroovyUtils.isDeprecated(method) ? Flags.AccDeprecated : 0);
int fieldModifiers = (method.getModifiers() & 0xF) | (GroovyUtils.isDeprecated(method) ? Flags.AccDeprecated : 0);
ClassNode fieldType = AccessorSupport.isSetter(method) ? DefaultGroovyMethods.last(method.getParameters()).getType() : method.getReturnType();

FieldNode fieldNode = new FieldNode(fieldName, fieldModifiers, fieldType, method.getDeclaringClass(), null);
Expand Down
128 changes: 113 additions & 15 deletions ...codeassist/src/org/codehaus/groovy/eclipse/codeassist/creators/MethodProposalCreator.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
*/
package org.codehaus.groovy.eclipse.codeassist.creators;

import static org.codehaus.groovy.transform.trait.Traits.decomposeSuperCallName;
import static org.codehaus.groovy.transform.trait.Traits.findTraits;

import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedList;
Expand All @@ -34,8 +37,19 @@
import org.codehaus.groovy.eclipse.codeassist.proposals.GroovyFieldProposal;
import org.codehaus.groovy.eclipse.codeassist.proposals.GroovyMethodProposal;
import org.codehaus.groovy.eclipse.codeassist.proposals.IGroovyProposal;
import org.codehaus.groovy.eclipse.codeassist.requestor.ContentAssistContext;
import org.eclipse.jdt.core.CompletionProposal;
import org.eclipse.jdt.core.Flags;
import org.eclipse.jdt.groovy.core.util.GroovyUtils;
import org.eclipse.jdt.groovy.core.util.ReflectionUtils;
import org.eclipse.jdt.groovy.search.VariableScope;
import org.eclipse.jdt.internal.codeassist.CompletionEngine;
import org.eclipse.jdt.internal.ui.text.java.AbstractJavaCompletionProposal;
import org.eclipse.jdt.internal.ui.text.java.LazyJavaCompletionProposal;
import org.eclipse.jdt.internal.ui.text.java.MemberProposalInfo;
import org.eclipse.jdt.internal.ui.text.java.ProposalInfo;
import org.eclipse.jdt.ui.text.java.IJavaCompletionProposal;
import org.eclipse.jdt.ui.text.java.JavaContentAssistInvocationContext;

/**
* Generates all of the method proposals for a given location.
Expand All @@ -46,7 +60,7 @@ public class MethodProposalCreator extends AbstractProposalCreator {
private Set<ClassNode> alreadySeen = new HashSet<>();

@Override
public List<IGroovyProposal> findAllProposals(ClassNode type, Set<ClassNode> categories, String prefix, boolean isStatic, boolean isPrimary) {
public List<IGroovyProposal> findAllProposals(final ClassNode type, final Set<ClassNode> categories, final String prefix, final boolean isStatic, final boolean isPrimary) {
List<IGroovyProposal> proposals = new LinkedList<>();

Set<String> alreadySeenFields = new HashSet<>();
Expand All @@ -55,24 +69,37 @@ public List<IGroovyProposal> findAllProposals(ClassNode type, Set<ClassNode> cat
}
boolean firstTime = alreadySeen.isEmpty();
boolean isMapType = GeneralUtils.isOrImplements(type, VariableScope.MAP_CLASS_NODE);
for (MethodNode method : getAllMethods(type, alreadySeen)) { String methodName = method.getName();
for (MethodNode method : getAllMethods(type, alreadySeen)) {
String methodName = method.getName();
String[] traitAndMethodNames = decomposeSuperCallName(methodName);
if (traitAndMethodNames != null) methodName = traitAndMethodNames[1];

if (!isStatic || method.isStatic() || method.getDeclaringClass().equals(VariableScope.OBJECT_CLASS_NODE)) {
if (matcher.test(prefix, methodName) && !"<clinit>".equals(methodName)) {
GroovyMethodProposal proposal = new GroovyMethodProposal(method);
final GroovyMethodProposal proposal;
if (traitAndMethodNames != null) {
proposal = new TraitSuperMethodProposal(method, traitAndMethodNames);
} else {
proposal = new GroovyMethodProposal(method);
}
setRelevanceMultiplier(proposal, isStatic);
proposals.add(proposal);
}

// if method is an accessor, then add a proposal for the property name
if (!"getClass".equals(methodName) && (!isMapType || isStatic) &&
findLooselyMatchedAccessorKind(prefix, methodName, false).isAccessorKind(method, false)) {
FieldNode mockField = createMockField(method);
if (alreadySeenFields.add(mockField.getName())) {
ClassNode declaringClass = method.getDeclaringClass();
FieldNode realField = declaringClass.getField(mockField.getName());
if (realField == null) realField = declaringClass.getField(ProposalUtils.createCapitalMockFieldName(methodName));
if (realField == null || leftIsMoreAccessible(mockField, realField)) {
proposals.add(new GroovyFieldProposal(mockField));
if (traitAndMethodNames != null) {
proposals.add(new TraitSuperPropertyProposal(method, traitAndMethodNames));
} else {
FieldNode mockField = createMockField(method);
if (alreadySeenFields.add(mockField.getName())) {
ClassNode declaringClass = method.getDeclaringClass();
FieldNode realField = declaringClass.getField(mockField.getName());
if (realField == null) realField = declaringClass.getField(ProposalUtils.createCapitalMockFieldName(methodName));
if (realField == null || leftIsMoreAccessible(mockField, realField)) {
proposals.add(new GroovyFieldProposal(mockField));
}
}
}
}
Expand Down Expand Up @@ -105,7 +132,7 @@ public List<IGroovyProposal> findAllProposals(ClassNode type, Set<ClassNode> cat
return proposals;
}

private void findStaticImportProposals(List<IGroovyProposal> proposals, String prefix, ModuleNode module) {
private void findStaticImportProposals(final List<IGroovyProposal> proposals, final String prefix, final ModuleNode module) {
for (Map.Entry<String, ImportNode> entry : module.getStaticStarImports().entrySet()) {
ClassNode typeNode = entry.getValue().getType();
if (typeNode != null) {
Expand Down Expand Up @@ -134,7 +161,7 @@ private void findStaticImportProposals(List<IGroovyProposal> proposals, String p
}
}

private void findStaticFavoriteProposals(List<IGroovyProposal> proposals, String prefix, ModuleNode module) {
private void findStaticFavoriteProposals(final List<IGroovyProposal> proposals, final String prefix, final ModuleNode module) {
for (String favoriteStaticMember : favoriteStaticMembers) {
int pos = favoriteStaticMember.lastIndexOf('.');
String typeName = favoriteStaticMember.substring(0, pos);
Expand Down Expand Up @@ -171,9 +198,7 @@ private void findStaticFavoriteProposals(List<IGroovyProposal> proposals, String
}
}

//--------------------------------------------------------------------------

private static void setRelevanceMultiplier(GroovyMethodProposal proposal, boolean isStatic) {
private static void setRelevanceMultiplier(final GroovyMethodProposal proposal, final boolean isStatic) {
MethodNode method = proposal.getMethod();

float relevanceMultiplier;
Expand All @@ -187,4 +212,77 @@ private static void setRelevanceMultiplier(GroovyMethodProposal proposal, boolea

proposal.setRelevanceMultiplier(relevanceMultiplier);
}

//--------------------------------------------------------------------------

private static class TraitSuperMethodProposal extends GroovyMethodProposal {

TraitSuperMethodProposal(final MethodNode method, final String[] traitAndMethodNames) {
super(findTraits(method.getDeclaringClass()).stream()
.filter(t -> t.getName().equals(traitAndMethodNames[0])).findFirst()
.map(t -> t.getMethod(traitAndMethodNames[1], method.getParameters())).get());
setRequiredQualifier("super");
}

@Override
public IJavaCompletionProposal createJavaProposal(final CompletionEngine engine,
final ContentAssistContext context, final JavaContentAssistInvocationContext javaContext) {
IJavaCompletionProposal javaProposal = super.createJavaProposal(engine, context, javaContext);
if (javaProposal instanceof LazyJavaCompletionProposal) {
//CompletionProposal proposal = ((LazyJavaCompletionProposal) javaProposal).getProposal();
CompletionProposal proposal = ReflectionUtils.executePrivateMethod(LazyJavaCompletionProposal.class, "getProposal", javaProposal);

// create supporting proposal for trait type so full completion will be "Type.super.method()" plus import or qualifier
CompletionProposal typeProposal = CompletionProposal.create(CompletionProposal.TYPE_IMPORT, context.completionLocation);
typeProposal.setSignature(proposal.getDeclarationSignature());

proposal.setRequiredProposals(new CompletionProposal[] {typeProposal});
}
return javaProposal;
}

@Override
protected int computeRelevance(final ContentAssistContext context) {
return (super.computeRelevance(context) - 1);
}

@Override
protected int getModifiers() {
return (super.getModifiers() & ~Flags.AccAbstract);
}
}

private static class TraitSuperPropertyProposal extends GroovyFieldProposal {

TraitSuperPropertyProposal(final MethodNode method, final String[] traitAndMethodNames) {
super(createMockField(findTraits(method.getDeclaringClass()).stream()
.filter(t -> t.getName().equals(traitAndMethodNames[0])).findFirst()
.map(t -> t.getMethod(traitAndMethodNames[1], method.getParameters())).get()));
setRequiredQualifier("super");
}

@Override
public IJavaCompletionProposal createJavaProposal(final CompletionEngine engine,
final ContentAssistContext context, final JavaContentAssistInvocationContext javaContext) {
IJavaCompletionProposal javaProposal = super.createJavaProposal(engine, context, javaContext);
if (javaProposal instanceof AbstractJavaCompletionProposal) {
//ProposalInfo proposalInfo = ((AbstractJavaCompletionProposal) javaProposal).getProposalInfo();
ProposalInfo proposalInfo = ReflectionUtils.executePrivateMethod(AbstractJavaCompletionProposal.class, "getProposalInfo", javaProposal);
//CompletionProposal proposal = ((MemberProposalInfo) proposalInfo).fProposal;
CompletionProposal proposal = ReflectionUtils.getPrivateField(MemberProposalInfo.class, "fProposal", proposalInfo);

// create supporting proposal for trait type so full completion will be "Type.super.property" plus import or qualifier
CompletionProposal typeProposal = CompletionProposal.create(CompletionProposal.TYPE_IMPORT, context.completionLocation);
typeProposal.setSignature(proposal.getDeclarationSignature());

proposal.setRequiredProposals(new CompletionProposal[] {typeProposal});
}
return javaProposal;
}

@Override
protected int computeRelevance(final ContentAssistContext context) {
return (super.computeRelevance(context) - 1);
}
}
}

0 comments on commit 8fd19cb

Please sign in to comment.