Merge pull request #107 from cedricziel/dict-provider

Refactor Icon detection to use PsiReferences

Author: cedricziel

src/main/java/com/cedricziel/idea/typo3/codeInsight/IconCompletionContributor.java

@@ -0,0 +1,11 @@
+package com.cedricziel.idea.typo3.icons;
+
+public interface IconInterface {
+    public String getExtension();
+
+    public String getName();
+
+    public String getExtensionKey();
+
+    public String getProvider();
+}

src/main/java/com/cedricziel/idea/typo3/codeInsight/navigation/IconGotoDeclarationHandler.java

@@ -0,0 +1,35 @@
+package com.cedricziel.idea.typo3.icons;
+
+import com.intellij.codeInsight.lookup.LookupElement;
+import com.intellij.codeInsight.lookup.LookupElementPresentation;
+import com.intellij.icons.AllIcons;
+import org.jetbrains.annotations.NotNull;
+
+import javax.swing.*;
+
+public class IconLookupElement extends LookupElement {
+
+    private final IconInterface icon;
+
+    public IconLookupElement(@NotNull IconInterface icon) {
+        this.icon = icon;
+    }
+
+    @NotNull
+    @Override
+    public String getLookupString() {
+        return icon.getName();
+    }
+
+    @Override
+    public void renderElement(LookupElementPresentation presentation) {
+        presentation.setItemText(icon.getName());
+        presentation.setIcon(iconFromIconInterface(icon));
+        presentation.setTypeText(icon.getExtensionKey());
+        presentation.setTypeGrayed(true);
+    }
+
+    private Icon iconFromIconInterface(@NotNull IconInterface icon) {
+        return AllIcons.FileTypes.Custom;
+    }
+}

src/main/java/com/cedricziel/idea/typo3/icons/IconInterface.java

@@ -0,0 +1,32 @@
+package com.cedricziel.idea.typo3.icons;
+
+import com.cedricziel.idea.typo3.index.IconIndex;
+import com.cedricziel.idea.typo3.util.IconUtil;
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.PsiElementResolveResult;
+import com.intellij.psi.PsiPolyVariantReferenceBase;
+import com.intellij.psi.ResolveResult;
+import com.jetbrains.php.lang.psi.elements.StringLiteralExpression;
+import org.jetbrains.annotations.NotNull;
+
+public class IconReference extends PsiPolyVariantReferenceBase<PsiElement> {
+    private final String iconName;
+
+    public IconReference(StringLiteralExpression psiElement) {
+        super(psiElement);
+
+        iconName = psiElement.getContents();
+    }
+
+    @NotNull
+    @Override
+    public ResolveResult[] multiResolve(boolean incompleteCode) {
+        return PsiElementResolveResult.createResults(IconIndex.getIconDefinitionElements(myElement.getProject(), iconName));
+    }
+
+    @NotNull
+    @Override
+    public Object[] getVariants() {
+        return IconUtil.createIconLookupElements(myElement.getProject());
+    }
+}

src/main/java/com/cedricziel/idea/typo3/icons/IconLookupElement.java

@@ -0,0 +1,33 @@
+package com.cedricziel.idea.typo3.icons;
+
+import com.cedricziel.idea.typo3.util.PhpLangUtil;
+import com.intellij.patterns.PlatformPatterns;
+import com.intellij.psi.*;
+import com.intellij.util.ProcessingContext;
+import com.jetbrains.php.lang.psi.elements.StringLiteralExpression;
+import org.jetbrains.annotations.NotNull;
+
+public class IconReferenceContributor extends PsiReferenceContributor {
+    @Override
+    public void registerReferenceProviders(@NotNull PsiReferenceRegistrar registrar) {
+        // known method calls
+        registrar.registerReferenceProvider(
+                PlatformPatterns.psiElement(StringLiteralExpression.class),
+                new PsiReferenceProvider() {
+                    @NotNull
+                    @Override
+                    public PsiReference[] getReferencesByElement(@NotNull PsiElement element, @NotNull ProcessingContext context) {
+                        StringLiteralExpression stringLiteralExpression = (StringLiteralExpression) element;
+
+                        String methodName = PhpLangUtil.getMethodName(stringLiteralExpression);
+                        String className = PhpLangUtil.getClassName(stringLiteralExpression);
+                        if (methodName != null && className != null && methodName.equals("getIcon") && className.equals("\\TYPO3\\CMS\\Core\\Imaging\\IconFactory")) {
+                            return new PsiReference[]{new IconReference(stringLiteralExpression)};
+                        }
+
+                        return new PsiReference[0];
+                    }
+                }
+        );
+    }
+}

src/main/java/com/cedricziel/idea/typo3/icons/IconReference.java

@@ -1,12 +1,11 @@
-package com.cedricziel.idea.typo3.domain;
+package com.cedricziel.idea.typo3.icons;
 
 import com.intellij.openapi.util.TextRange;
-import com.intellij.openapi.vfs.VirtualFile;
 import com.intellij.psi.PsiElement;
 
 import java.io.Serializable;
 
-public class IconStub implements Serializable {
+public class IconStub implements IconInterface, Serializable {
 
     private String identifier;
     private String extension;
@@ -42,18 +41,34 @@ public void setSource(String source) {
         this.source = source;
     }
 
+    public TextRange getTextRange() {
+        return textRange;
+    }
+
+    @Override
+    public String getExtension() {
+        return null;
+    }
+
+    @Override
+    public String getName() {
+        return identifier;
+    }
+
+    @Override
+    public String getExtensionKey() {
+        return null;
+    }
+
+    @Override
     public String getProvider() {
-        return provider;
+        return null;
     }
 
     public void setProvider(String provider) {
         this.provider = provider;
     }
 
-    public TextRange getTextRange() {
-        return textRange;
-    }
-
     @Override
     public boolean equals(Object o) {
         if (this == o) return true;

src/main/java/com/cedricziel/idea/typo3/icons/IconReferenceContributor.java

@@ -1,6 +1,6 @@
 package com.cedricziel.idea.typo3.index;
 
-import com.cedricziel.idea.typo3.domain.IconStub;
+import com.cedricziel.idea.typo3.icons.IconStub;
 import com.cedricziel.idea.typo3.index.externalizer.ObjectStreamDataExternalizer;
 import com.cedricziel.idea.typo3.psi.visitor.CoreFlagParserVisitor;
 import com.cedricziel.idea.typo3.psi.visitor.CoreIconParserVisitor;
@@ -32,6 +32,7 @@ public class IconIndex extends FileBasedIndexExtension<String, IconStub> {
 
     public static ID<String, IconStub> KEY = ID.create("com.cedricziel.idea.typo3.index.icon");
 
+    @NotNull
     public static Collection<String> getAllAvailableIcons(@NotNull Project project) {
 
         return FileBasedIndex.getInstance().getAllKeys(KEY, project);
@@ -75,6 +76,17 @@ public static PsiElement[] getIconDefinitionElements(@NotNull Project project, @
         return new PsiElement[0];
     }
 
+    @NotNull
+    public static IconStub[] getAllIcons(@NotNull Project project) {
+        List<IconStub> iconStubs = new ArrayList<>();
+        FileBasedIndex.getInstance().getAllKeys(IconIndex.KEY, project).forEach(k -> {
+            List<IconStub> values = FileBasedIndex.getInstance().getValues(IconIndex.KEY, k, GlobalSearchScope.allScope(project));
+            iconStubs.addAll(values);
+        });
+
+        return iconStubs.toArray(new IconStub[iconStubs.size()]);
+    }
+
     @NotNull
     @Override
     public ID<String, IconStub> getName() {
@@ -107,7 +119,7 @@ public DataIndexer<String, IconStub, FileContent> getIndexer() {
                                         CoreIconParserVisitor visitor = new CoreIconParserVisitor();
                                         visitor.visitElement(field.getDefaultValue());
 
-                                        visitor.getMap().forEach(map::put);
+                                        Map<String, IconStub> map1 = visitor.getMap();map1.forEach(map::put);
                                     }
                                 }
                             }
@@ -120,7 +132,8 @@ public DataIndexer<String, IconStub, FileContent> getIndexer() {
                                 method.accept(visitor);
                                 visitor.visitElement(method);
 
-                                visitor.getMap().forEach(map::put);
+                                Map<String, IconStub> map1 = visitor.getMap();
+                                map1.forEach(map::put);
                             }
                         }
                     }

src/main/java/com/cedricziel/idea/typo3/domain/IconStub.java renamed to src/main/java/com/cedricziel/idea/typo3/icons/IconStub.java

@@ -1,6 +1,6 @@
 package com.cedricziel.idea.typo3.psi.visitor;
 
-import com.cedricziel.idea.typo3.domain.IconStub;
+import com.cedricziel.idea.typo3.icons.IconStub;
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiElementVisitor;
 import com.intellij.psi.util.PsiTreeUtil;

src/main/java/com/cedricziel/idea/typo3/index/IconIndex.java

@@ -1,6 +1,6 @@
 package com.cedricziel.idea.typo3.psi.visitor;
 
-import com.cedricziel.idea.typo3.domain.IconStub;
+import com.cedricziel.idea.typo3.icons.IconStub;
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiRecursiveElementVisitor;
 import com.jetbrains.php.lang.psi.elements.*;