replace recursive visting of elements inside Routing indexer with direct level visiting

Author: Haehnchen

src/main/java/fr/adrienbrault/idea/symfony2plugin/routing/RouteHelper.java

@@ -39,7 +39,7 @@
 import fr.adrienbrault.idea.symfony2plugin.stubs.cache.FileIndexCaches;
 import fr.adrienbrault.idea.symfony2plugin.stubs.dict.StubIndexedRoute;
 import fr.adrienbrault.idea.symfony2plugin.stubs.indexes.RoutesStubIndex;
-import fr.adrienbrault.idea.symfony2plugin.stubs.indexes.visitor.AnnotationRouteElementWalkingVisitor;
+import fr.adrienbrault.idea.symfony2plugin.stubs.indexes.visitor.AnnotationRouteElementVisitor;
 import fr.adrienbrault.idea.symfony2plugin.ui.dict.AbstractUiFilePath;
 import fr.adrienbrault.idea.symfony2plugin.util.*;
 import fr.adrienbrault.idea.symfony2plugin.util.controller.ControllerAction;
@@ -1121,11 +1121,11 @@ public static Collection<PsiElement> getRouteNameTarget(@NotNull Project project
                 Collection<PsiElement> targets = new ArrayList<>();
 
                 for (PhpClass phpClass : PhpPsiUtil.findAllClasses((PhpFile) psiFile)) {
-                    phpClass.accept(new AnnotationRouteElementWalkingVisitor(pair -> {
+                    new AnnotationRouteElementVisitor(pair -> {
                         if (routeName.equalsIgnoreCase(pair.getFirst())) {
                             targets.add(pair.getSecond());
                         }
-                    }));
+                    }).visitFile(phpClass);
                 }
 
                 return targets;

src/main/java/fr/adrienbrault/idea/symfony2plugin/stubs/indexes/RoutesStubIndex.java

@@ -17,7 +17,7 @@
 import fr.adrienbrault.idea.symfony2plugin.stubs.dict.StubIndexedRoute;
 import fr.adrienbrault.idea.symfony2plugin.stubs.indexes.externalizer.ObjectStreamDataExternalizer;
 import fr.adrienbrault.idea.symfony2plugin.stubs.indexes.inputFilter.FileInputFilter;
-import fr.adrienbrault.idea.symfony2plugin.stubs.indexes.visitor.AnnotationRouteElementWalkingVisitor;
+import fr.adrienbrault.idea.symfony2plugin.stubs.indexes.visitor.AnnotationRouteElementVisitor;
 import fr.adrienbrault.idea.symfony2plugin.util.ProjectUtil;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.yaml.psi.YAMLDocument;
@@ -84,7 +84,7 @@ public DataIndexer<String, StubIndexedRoute, FileContent> getIndexer() {
                 }
 
                 for (PhpClass phpClass : PhpPsiUtil.findAllClasses((PhpFile) psiFile)) {
-                    phpClass.accept(new AnnotationRouteElementWalkingVisitor(map));
+                    new AnnotationRouteElementVisitor(map).visitFile(phpClass);
                 }
             }
 

src/main/java/fr/adrienbrault/idea/symfony2plugin/stubs/indexes/visitor/AnnotationRouteElementWalkingVisitor.java renamed to src/main/java/fr/adrienbrault/idea/symfony2plugin/stubs/indexes/visitor/AnnotationRouteElementVisitor.java

@@ -2,9 +2,9 @@
 
 import com.intellij.patterns.PlatformPatterns;
 import com.intellij.psi.PsiElement;
-import com.intellij.psi.PsiRecursiveElementWalkingVisitor;
 import com.intellij.psi.util.PsiTreeUtil;
 import com.intellij.util.containers.ContainerUtil;
+import com.jetbrains.php.lang.documentation.phpdoc.PhpDocUtil;
 import com.jetbrains.php.lang.documentation.phpdoc.parser.PhpDocElementTypes;
 import com.jetbrains.php.lang.documentation.phpdoc.psi.PhpDocComment;
 import com.jetbrains.php.lang.documentation.phpdoc.psi.tags.PhpDocTag;
@@ -30,7 +30,7 @@
  *
  * @author Daniel Espendiller <daniel@espendiller.net>
  */
-public class AnnotationRouteElementWalkingVisitor extends PsiRecursiveElementWalkingVisitor {
+public class AnnotationRouteElementVisitor {
     @NotNull
     private final Map<String, StubIndexedRoute> map;
 
@@ -40,32 +40,35 @@ public class AnnotationRouteElementWalkingVisitor extends PsiRecursiveElementWal
     @NotNull
     private final Consumer<Pair<String, PsiElement>> consumer;
 
-    public AnnotationRouteElementWalkingVisitor(@NotNull Consumer<Pair<String, PsiElement>> consumer) {
+    public AnnotationRouteElementVisitor(@NotNull Consumer<Pair<String, PsiElement>> consumer) {
         this.consumer = consumer;
         this.map = new HashMap<>();
     }
 
-    public AnnotationRouteElementWalkingVisitor(@NotNull Map<String, StubIndexedRoute> map) {
+    public AnnotationRouteElementVisitor(@NotNull Map<String, StubIndexedRoute> map) {
         this.map = map;
         this.consumer = c -> {};
     }
 
-    @Override
-    public void visitElement(PsiElement element) {
-        if ((element instanceof PhpDocTag)) {
-            visitPhpDocTag((PhpDocTag) element);
-        }
+    public void visitFile(@NotNull PhpClass phpClass) {
+        for (Method method : phpClass.getOwnMethods()) {
+            PhpDocComment docComment = method.getDocComment();
+            if (docComment != null) {
+                PhpDocUtil.processTagElementsByName(docComment, null, docTag -> {
+                    visitPhpDocTag(docTag);
+                    return true;
+                });
+            }
 
-        if ((element instanceof PhpAttributesList)) {
-            visitPhpAttributesList((PhpAttributesList) element);
+            PhpAttributesList childOfType = PsiTreeUtil.getChildOfType(method, PhpAttributesList.class);
+            if (childOfType != null) {
+                visitPhpAttributesList(childOfType);
+            }
         }
-
-        super.visitElement(element);
     }
-
     private void visitPhpDocTag(@NotNull PhpDocTag phpDocTag) {
 
-        // "@var" and user non related tags dont need an action
+        // "@var" and user non-related tags don't need an action
         if(AnnotationBackportUtil.NON_ANNOTATION_TAGS.contains(phpDocTag.getName())) {
             return;
         }
@@ -89,7 +92,7 @@ private void visitPhpDocTag(@NotNull PhpDocTag phpDocTag) {
             routeName = AnnotationBackportUtil.getRouteByMethod(phpDocTag);
         }
 
-        if(routeName != null && StringUtils.isNotBlank(routeName)) {
+        if(StringUtils.isNotBlank(routeName)) {
             // prepend route name on PhpClass scope
             String routeNamePrefix = getRouteNamePrefix(phpDocTag);
             if(routeNamePrefix != null) {