-
-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
#107 Support go to declaration and completion for `Mapping#qualifiedB…
…yName`
- Loading branch information
1 parent
243f7b8
commit 3047d18
Showing
10 changed files
with
475 additions
and
0 deletions.
There are no files selected for viewing
174 changes: 174 additions & 0 deletions
174
...g/mapstruct/intellij/codeinsight/references/MapstructMappingQualifiedByNameReference.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,174 @@ | ||
| /* | ||
| * Copyright MapStruct Authors. | ||
| * | ||
| * Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0 | ||
| */ | ||
| package org.mapstruct.intellij.codeinsight.references; | ||
|
|
||
| import java.util.Arrays; | ||
| import java.util.Objects; | ||
| import java.util.stream.Collectors; | ||
| import java.util.stream.Stream; | ||
|
|
||
| import com.intellij.codeInsight.lookup.LookupElement; | ||
| import com.intellij.openapi.util.TextRange; | ||
| import com.intellij.openapi.util.text.StringUtil; | ||
| import com.intellij.psi.PsiAnnotation; | ||
| import com.intellij.psi.PsiClass; | ||
| import com.intellij.psi.PsiElement; | ||
| import com.intellij.psi.PsiMethod; | ||
| import com.intellij.psi.PsiParameter; | ||
| import com.intellij.psi.PsiReference; | ||
| import com.intellij.psi.PsiType; | ||
| import org.jetbrains.annotations.NotNull; | ||
| import org.jetbrains.annotations.Nullable; | ||
| import org.mapstruct.intellij.util.MapstructUtil; | ||
|
|
||
| import static com.intellij.codeInsight.AnnotationUtil.findAnnotation; | ||
| import static com.intellij.codeInsight.AnnotationUtil.getStringAttributeValue; | ||
| import static org.mapstruct.intellij.util.MapstructAnnotationUtils.findReferencedMapperClasses; | ||
| import static org.mapstruct.intellij.util.MapstructUtil.asLookupWithRepresentableText; | ||
|
|
||
| /** | ||
| * Reference for {@link org.mapstruct.Mapping#qualifiedByName()}. | ||
| * | ||
| * @author Oliver Erhart | ||
| */ | ||
| class MapstructMappingQualifiedByNameReference extends MapstructBaseReference { | ||
|
|
||
| /** | ||
| * Create a new {@link MapstructMappingQualifiedByNameReference} with the provided parameters | ||
| * | ||
| * @param element the element that the reference belongs to | ||
| * @param previousReference the previous reference if there is one (in nested properties for example) | ||
| * @param rangeInElement the range that the reference represent in the {@code element} | ||
| * @param value the matched value (useful when {@code rangeInElement} is empty) | ||
| */ | ||
| private MapstructMappingQualifiedByNameReference(PsiElement element, | ||
| MapstructMappingQualifiedByNameReference previousReference, | ||
| TextRange rangeInElement, String value) { | ||
| super( element, previousReference, rangeInElement, value ); | ||
| } | ||
|
|
||
| @Override | ||
| PsiElement resolveInternal(@NotNull String value, @NotNull PsiType psiType) { | ||
| return null; // not needed | ||
| } | ||
|
|
||
| @Override | ||
| PsiElement resolveInternal(@NotNull String value, @NotNull PsiMethod mappingMethod) { | ||
|
|
||
| return findAllNamedMethodsFromThisAndReferencedMappers( mappingMethod ) | ||
| .filter( a -> Objects.equals( getNamedValue( a ), value ) ) | ||
| .findAny() | ||
| .orElse( null ); | ||
| } | ||
|
|
||
| @Nullable | ||
| private String getNamedValue(PsiMethod method) { | ||
|
|
||
| PsiAnnotation annotation = findAnnotation( method, true, MapstructUtil.NAMED_ANNOTATION_FQN ); | ||
|
|
||
| if ( annotation == null ) { | ||
| return null; | ||
| } | ||
|
|
||
| return getStringAttributeValue( annotation, "value" ); | ||
| } | ||
|
|
||
| @NotNull | ||
| @Override | ||
| Object[] getVariantsInternal(@NotNull PsiType psiType) { | ||
| return LookupElement.EMPTY_ARRAY; // not needed | ||
| } | ||
|
|
||
| @NotNull | ||
| @Override | ||
| Object[] getVariantsInternal(@NotNull PsiMethod mappingMethod) { | ||
|
|
||
| return findAllNamedMethodsFromThisAndReferencedMappers( mappingMethod ) | ||
| .map( this::methodAsLookup ) | ||
| .filter( Objects::nonNull ) | ||
| .toArray(); | ||
| } | ||
|
|
||
| private boolean methodHasReturnType(@NotNull PsiMethod psiMethod) { | ||
| return !PsiType.VOID.equals( psiMethod.getReturnType() ); | ||
| } | ||
|
|
||
| @NotNull | ||
| private Stream<PsiMethod> findAllNamedMethodsFromThisAndReferencedMappers(@NotNull PsiMethod mappingMethod) { | ||
|
|
||
| PsiClass containingClass = mappingMethod.getContainingClass(); | ||
| if ( containingClass == null ) { | ||
| return Stream.empty(); | ||
| } | ||
|
|
||
| Stream<PsiMethod> internalMethods = Stream.of( containingClass.getMethods() ) | ||
| .filter( MapstructUtil::isNamedMethod ); | ||
|
|
||
| Stream<PsiMethod> externalMethods = findNamedMethodsInUsedMappers( containingClass ); | ||
|
|
||
| return Stream.concat( internalMethods, externalMethods ) | ||
| .filter( this::methodHasReturnType ); | ||
| } | ||
|
|
||
| @NotNull | ||
| private Stream<PsiMethod> findNamedMethodsInUsedMappers(@Nullable PsiClass containingClass) { | ||
|
|
||
| PsiAnnotation mapperAnnotation = findAnnotation( | ||
| containingClass, | ||
| MapstructUtil.MAPPER_ANNOTATION_FQN | ||
| ); | ||
|
|
||
| if ( mapperAnnotation == null ) { | ||
| return Stream.empty(); | ||
| } | ||
|
|
||
| return findReferencedMapperClasses( mapperAnnotation ) | ||
| .flatMap( psiClass -> Arrays.stream( psiClass.getMethods() ) ) | ||
| .filter( MapstructUtil::isNamedMethod ); | ||
| } | ||
|
|
||
| private LookupElement methodAsLookup(@NotNull PsiMethod method) { | ||
| String lookupString = getNamedValue( method ); | ||
| if ( StringUtil.isEmpty( lookupString ) ) { | ||
| return null; | ||
| } | ||
|
|
||
| return asLookupWithRepresentableText( | ||
| method, | ||
| lookupString, | ||
| lookupString, | ||
| String.format( | ||
| " %s#%s(%s)", | ||
| Objects.requireNonNull( method.getContainingClass() ).getName(), | ||
| method.getName(), | ||
| formatParameters( method ) | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| @NotNull | ||
| private static String formatParameters(@NotNull PsiMethod method) { | ||
| return Arrays.stream( method.getParameterList().getParameters() ) | ||
| .map( PsiParameter::getType ) | ||
| .map( PsiType::getPresentableText ) | ||
| .collect( Collectors.joining( ", " ) ); | ||
| } | ||
|
|
||
| @Nullable | ||
| @Override | ||
| PsiType resolvedType() { | ||
| return null; | ||
| } | ||
|
|
||
| /** | ||
| * @param psiElement the literal for which references need to be created | ||
| * @return the references for the given {@code psiLiteral} | ||
| */ | ||
| static PsiReference[] create(PsiElement psiElement) { | ||
| return MapstructBaseReference.create( psiElement, MapstructMappingQualifiedByNameReference::new, false ); | ||
| } | ||
|
|
||
| } |
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
Oops, something went wrong.