provide custom Twig file overlay to indicate "extends" and attached controller template types Haehnchen#1485

Author: Haehnchen

src/main/java/fr/adrienbrault/idea/symfony2plugin/Symfony2Icons.java

@@ -61,6 +61,7 @@ public class Symfony2Icons {
     public static final Icon TWIG_LINE_MARKER = IconLoader.getIcon("/icons/twig_line_marker.png");
     public static final Icon TWIG_LINE_OVERWRITE = IconLoader.getIcon("/icons/overwrite.png");
 
+    public static final Icon TWIG_CONTROLLER_FILE = IconLoader.getIcon("/icons/twig_controller_file.png");
     public static final Icon TWIG_EXTENDS_FILE = IconLoader.getIcon("/icons/twig_extends_file.png");
     public static final Icon TWIG_IMPLEMENTS_FILE = IconLoader.getIcon("/icons/twig_implements_file.png");
 

src/main/java/fr/adrienbrault/idea/symfony2plugin/twig/icon/TwigIconProvider.java

@@ -0,0 +1,58 @@
+package fr.adrienbrault.idea.symfony2plugin.twig.icon;
+
+import com.intellij.ide.IconProvider;
+import com.intellij.openapi.project.DumbService;
+import com.intellij.openapi.util.Iconable;
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.util.PsiTreeUtil;
+import com.intellij.ui.LayeredIcon;
+import com.jetbrains.twig.TwigFile;
+import com.jetbrains.twig.elements.TwigExtendsTag;
+import fr.adrienbrault.idea.symfony2plugin.Symfony2Icons;
+import fr.adrienbrault.idea.symfony2plugin.Symfony2ProjectComponent;
+import fr.adrienbrault.idea.symfony2plugin.templating.util.TwigUtil;
+import icons.TwigIcons;
+import org.jetbrains.annotations.NotNull;
+
+import javax.swing.*;
+
+/**
+ * Based on Twig content add overlay to the default Twig file icon, indicating the possible template type
+ *
+ * @author Daniel Espendiller <[email protected]>
+ */
+public class TwigIconProvider extends IconProvider {
+    public Icon getIcon(@NotNull PsiElement element, @Iconable.IconFlags int flags) {
+        if (!(element instanceof TwigFile) || !Symfony2ProjectComponent.isEnabled(element.getProject()) || DumbService.getInstance(element.getProject()).isDumb()) {
+            return null;
+        }
+
+        // attach controller icon overlay
+        LayeredIcon icon = null;
+        if (hasController((TwigFile) element)) {
+            icon = new LayeredIcon(TwigIcons.TwigFileIcon, Symfony2Icons.TWIG_CONTROLLER_FILE);
+            icon.setIcon(Symfony2Icons.TWIG_CONTROLLER_FILE, 1, SwingConstants.NORTH_WEST);
+        }
+
+        // file provides extends tag, add another layer on top; but put the layer below the previous layer if provided
+        TwigExtendsTag childOfType = PsiTreeUtil.findChildOfType(element, TwigExtendsTag.class);
+        if (childOfType != null) {
+            if (icon == null) {
+                // we are alone so just place the icon
+                icon = new LayeredIcon(TwigIcons.TwigFileIcon, Symfony2Icons.TWIG_EXTENDS_FILE);
+                icon.setIcon(Symfony2Icons.TWIG_EXTENDS_FILE, 1, SwingConstants.NORTH_WEST);
+            } else {
+                // icon should be below first one
+                icon = new LayeredIcon(icon, Symfony2Icons.TWIG_IMPLEMENTS_FILE);
+                icon.setIcon(Symfony2Icons.TWIG_EXTENDS_FILE, 1, 0, Symfony2Icons.TWIG_CONTROLLER_FILE.getIconHeight() + 1);
+            }
+        }
+
+        return icon;
+    }
+
+    private boolean hasController(@NotNull TwigFile twigFile) {
+        return TwigUtil.findTwigFileController(twigFile).size() > 0
+            || TwigUtil.getTwigFileMethodUsageOnIndex(twigFile).size() > 0;
+    }
+}

src/main/resources/META-INF/plugin.xml

@@ -246,6 +246,7 @@
         <codeInsight.parameterNameHints language="yaml" implementationClass="fr.adrienbrault.idea.symfony2plugin.dic.ServiceArgumentParameterHintsProvider"/>
 
         <multiHostInjector implementation="fr.adrienbrault.idea.symfony2plugin.lang.ParameterLanguageInjector"/>
+        <iconProvider implementation="fr.adrienbrault.idea.symfony2plugin.twig.icon.TwigIconProvider"/>
 
         <localInspection groupPath="Symfony" shortName="PhpRouteMissingInspection" displayName="Route Missing"
                          groupName="Route"