Merge pull request #2096 from Haehnchen/feature/controller-method-inspection.recursive

replace recursive visiting for controller method inspection

Author: Haehnchen

src/main/java/fr/adrienbrault/idea/symfony2plugin/routing/inspection/ControllerMethodInspection.java

@@ -2,13 +2,12 @@
 
 import com.intellij.codeInspection.LocalInspectionTool;
 import com.intellij.codeInspection.ProblemsHolder;
+import com.intellij.lang.Language;
+import com.intellij.lang.xml.XMLLanguage;
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiElementVisitor;
-import com.intellij.psi.PsiFile;
-import com.intellij.psi.PsiRecursiveElementWalkingVisitor;
 import com.intellij.psi.util.PsiTreeUtil;
 import com.intellij.psi.xml.XmlAttribute;
-import com.intellij.psi.xml.XmlFile;
 import com.intellij.psi.xml.XmlTag;
 import fr.adrienbrault.idea.symfony2plugin.Symfony2ProjectComponent;
 import fr.adrienbrault.idea.symfony2plugin.codeInspection.InspectionUtil;
@@ -19,7 +18,7 @@
 import org.apache.commons.lang.StringUtils;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
-import org.jetbrains.yaml.psi.YAMLFile;
+import org.jetbrains.yaml.YAMLLanguage;
 import org.jetbrains.yaml.psi.YAMLKeyValue;
 
 /**
@@ -36,104 +35,73 @@ public PsiElementVisitor buildVisitor(final @NotNull ProblemsHolder holder, bool
 
         return new PsiElementVisitor() {
             @Override
-            public void visitFile(PsiFile psiFile) {
-                if(psiFile instanceof YAMLFile) {
-                    visitYaml(holder, psiFile);
-                }
+            public void visitElement(@NotNull PsiElement element) {
+                Language language = element.getLanguage();
 
-                if(psiFile instanceof XmlFile) {
-                    visitXml(holder, psiFile);
+                if (language == YAMLLanguage.INSTANCE) {
+                    visitYamlElement(element, holder);
+                } else if(language == XMLLanguage.INSTANCE) {
+                    visitXmlElement(element, holder);
                 }
 
-                super.visitFile(psiFile);
+                super.visitElement(element);
             }
         };
     }
 
-    private void visitYaml(final ProblemsHolder holder, PsiFile psiFile) {
-        psiFile.acceptChildren(new PsiRecursiveElementWalkingVisitor() {
-            @Override
-            public void visitElement(PsiElement element) {
-                if(YamlElementPatternHelper.getSingleLineScalarKey("_controller", "controller").accepts(element)) {
-                    String text = PsiElementUtils.trimQuote(element.getText());
-                    if(StringUtils.isNotBlank(text)) {
-                        InspectionUtil.inspectController(element, text, holder, new YamlLazyRouteName(element));
-                    }
-                }
-
-                super.visitElement(element);
+    private void visitYamlElement(@NotNull PsiElement element, @NotNull ProblemsHolder holder) {
+        if (YamlElementPatternHelper.getSingleLineScalarKey("_controller", "controller").accepts(element)) {
+            String text = PsiElementUtils.trimQuote(element.getText());
+            if (StringUtils.isNotBlank(text)) {
+                InspectionUtil.inspectController(element, text, holder, new YamlLazyRouteName(element));
             }
-        });
+        }
     }
 
-    private void visitXml(final ProblemsHolder holder, PsiFile psiFile) {
-        psiFile.acceptChildren(new PsiRecursiveElementWalkingVisitor() {
-            @Override
-            public void visitElement(PsiElement element) {
-                if(XmlHelper.getRouteControllerPattern().accepts(element)) {
-                    String text = PsiElementUtils.trimQuote(element.getText());
-                    if(StringUtils.isNotBlank(text)) {
-                        InspectionUtil.inspectController(element, text, holder, new XmlLazyRouteName(element));
-                    }
-                }
-
-                super.visitElement(element);
+    public void visitXmlElement(@NotNull PsiElement element, @NotNull ProblemsHolder holder) {
+        if(XmlHelper.getRouteControllerPattern().accepts(element)) {
+            String text = PsiElementUtils.trimQuote(element.getText());
+            if(StringUtils.isNotBlank(text)) {
+                InspectionUtil.inspectController(element, text, holder, new XmlLazyRouteName(element));
             }
-        });
-    }
-
-    public class YamlLazyRouteName implements InspectionUtil.LazyControllerNameResolve {
-
-        private final PsiElement psiElement;
-
-        public YamlLazyRouteName(PsiElement psiElement) {
-            this.psiElement = psiElement;
         }
+    }
 
+    private record YamlLazyRouteName(@NotNull PsiElement psiElement) implements InspectionUtil.LazyControllerNameResolve {
         @Nullable
-        @Override
-        public String getRouteName() {
+            @Override
+            public String getRouteName() {
+                YAMLKeyValue defaultKeyValue = PsiTreeUtil.getParentOfType(this.psiElement.getParent(), YAMLKeyValue.class);
+                if (defaultKeyValue == null) {
+                    return null;
+                }
 
-            YAMLKeyValue defaultKeyValue = PsiTreeUtil.getParentOfType(this.psiElement.getParent(), YAMLKeyValue.class);
-            if(defaultKeyValue == null) {
-                return null;
-            }
+                YAMLKeyValue def = PsiTreeUtil.getParentOfType(defaultKeyValue, YAMLKeyValue.class);
+                if (def == null) {
+                    return null;
+                }
 
-            YAMLKeyValue def = PsiTreeUtil.getParentOfType(defaultKeyValue, YAMLKeyValue.class);
-            if(def == null) {
-                return null;
+                return YamlHelper.getYamlKeyName(def);
             }
-
-            return YamlHelper.getYamlKeyName(def);
         }
-    }
-
-    public class XmlLazyRouteName implements InspectionUtil.LazyControllerNameResolve {
-
-        private final PsiElement psiElement;
 
-        public XmlLazyRouteName(PsiElement psiElement) {
-            this.psiElement = psiElement;
-        }
+    private record XmlLazyRouteName(@NotNull PsiElement psiElement) implements InspectionUtil.LazyControllerNameResolve {
 
         @Nullable
-        @Override
-        public String getRouteName() {
-
-            XmlTag defaultTag = PsiTreeUtil.getParentOfType(this.psiElement, XmlTag.class);
-            if(defaultTag != null) {
-                XmlTag routeTag = PsiTreeUtil.getParentOfType(defaultTag, XmlTag.class);
-                if(routeTag != null) {
-                    XmlAttribute id = routeTag.getAttribute("id");
-                    if(id != null) {
-                        return id.getValue();
+            @Override
+            public String getRouteName() {
+                XmlTag defaultTag = PsiTreeUtil.getParentOfType(this.psiElement, XmlTag.class);
+                if (defaultTag != null) {
+                    XmlTag routeTag = PsiTreeUtil.getParentOfType(defaultTag, XmlTag.class);
+                    if (routeTag != null) {
+                        XmlAttribute id = routeTag.getAttribute("id");
+                        if (id != null) {
+                            return id.getValue();
+                        }
                     }
                 }
-            }
 
-            return null;
+                return null;
+            }
         }
-
-    }
-
 }