Use index to store and query icon information

Author: cedricziel

.gitignore

@@ -70,4 +70,4 @@ fabric.properties
 /build_test
 /plugins/typo3-plugin
 /.cache
-/.gradle
+/.gradle

src/main/java/com/cedricziel/idea/typo3/TYPO3CMSProjectComponent.java

@@ -1,10 +1,8 @@
 package com.cedricziel.idea.typo3;
 
 import com.cedricziel.idea.typo3.container.IconProvider;
-import com.intellij.openapi.application.ApplicationManager;
 import com.intellij.openapi.components.ProjectComponent;
 import com.intellij.openapi.diagnostic.Logger;
-import com.intellij.openapi.project.DumbService;
 import com.intellij.openapi.project.Project;
 import org.jetbrains.annotations.NotNull;
 
@@ -18,6 +16,10 @@ public TYPO3CMSProjectComponent(Project project) {
         this.project = project;
     }
 
+    public static Logger getLogger() {
+        return LOG;
+    }
+
     @Override
     public void initComponent() {
     }
@@ -34,26 +36,10 @@ public String getComponentName() {
 
     @Override
     public void projectOpened() {
-        Project ref = this.project;
-
-            ApplicationManager.getApplication().executeOnPooledThread(() -> ApplicationManager.getApplication().runReadAction(() -> {
-                while (DumbService.isDumb(ref)) {
-                    try {
-                        Thread.sleep(1);
-                    } catch (InterruptedException e) {
-                        e.printStackTrace();
-                    }
-                }
-                IconProvider.getInstance(ref);
-            }));
-        }
+    }
 
     @Override
     public void projectClosed() {
         IconProvider.destroyInstance(project);
     }
-
-    public static Logger getLogger() {
-        return LOG;
-    }
 }

src/main/java/com/cedricziel/idea/typo3/annotation/IconAnnotator.java

@@ -1,12 +1,9 @@
 package com.cedricziel.idea.typo3.annotation;
 
-import com.cedricziel.idea.typo3.container.IconProvider;
+import com.cedricziel.idea.typo3.index.IconIndex;
 import com.cedricziel.idea.typo3.psi.PhpElementsUtil;
-import com.intellij.lang.annotation.Annotation;
 import com.intellij.lang.annotation.AnnotationHolder;
 import com.intellij.lang.annotation.Annotator;
-import com.intellij.openapi.editor.DefaultLanguageHighlighterColors;
-import com.intellij.openapi.util.TextRange;
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.util.PsiTreeUtil;
 import com.jetbrains.php.lang.psi.elements.MethodReference;
@@ -35,18 +32,14 @@ public void annotate(@NotNull PsiElement psiElement, @NotNull AnnotationHolder a
     }
 
     private void annotateIconUsage(PsiElement psiElement, AnnotationHolder annotationHolder, String value) {
-        IconProvider iconProvider = IconProvider.getInstance(psiElement.getProject());
-        annotateIcon(psiElement, annotationHolder, value, iconProvider);
+        annotateIcon(psiElement, annotationHolder, value);
     }
 
-    private void annotateIcon(PsiElement psiElement, AnnotationHolder annotationHolder, String value, IconProvider iconProvider) {
-        if (iconProvider.has(psiElement.getProject(), value)) {
-            TextRange range = new TextRange(psiElement.getTextRange().getStartOffset(), psiElement.getTextRange().getEndOffset());
-            Annotation annotation = annotationHolder.createInfoAnnotation(range, null);
-            annotation.setTextAttributes(DefaultLanguageHighlighterColors.LINE_COMMENT);
+    private void annotateIcon(PsiElement psiElement, AnnotationHolder annotationHolder, String value) {
+        if (IconIndex.getAllAvailableIcons(psiElement.getProject()).contains(value)) {
+            annotationHolder.createInfoAnnotation(psiElement, null);
         } else {
-            TextRange range = new TextRange(psiElement.getTextRange().getStartOffset(), psiElement.getTextRange().getEndOffset());
-            annotationHolder.createWarningAnnotation(range, "Unresolved icon - this may also occur if the icon is defined in your extension, but not in the global icon registry.");
+            annotationHolder.createWarningAnnotation(psiElement, "Unresolved icon - this may also occur if the icon is defined in your extension, but not in the global icon registry.");
         }
     }
 }

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

@@ -1,9 +1,8 @@
 package com.cedricziel.idea.typo3.codeInsight;
 
 import com.cedricziel.idea.typo3.TYPO3CMSIcons;
-import com.cedricziel.idea.typo3.container.IconProvider;
+import com.cedricziel.idea.typo3.index.IconIndex;
 import com.cedricziel.idea.typo3.psi.PhpElementsUtil;
-import com.cedricziel.idea.typo3.util.IconUtil;
 import com.intellij.codeInsight.completion.*;
 import com.intellij.codeInsight.lookup.LookupElementBuilder;
 import com.intellij.patterns.PlatformPatterns;
@@ -14,9 +13,6 @@
 import com.jetbrains.php.lang.psi.elements.ParameterList;
 import org.jetbrains.annotations.NotNull;
 
-import javax.swing.*;
-import java.io.IOException;
-
 public class IconCompletionContributor extends CompletionContributor {
     public IconCompletionContributor() {
         extend(CompletionType.BASIC,
@@ -33,42 +29,16 @@ public void addCompletions(@NotNull CompletionParameters parameters,
 
                         PsiElement methodReference = PsiTreeUtil.getParentOfType(element, MethodReference.class);
                         if (PhpElementsUtil.isMethodWithFirstStringOrFieldReference(methodReference, "getIcon")) {
-                            completeAvailableIcons(element, resultSet);
+                            completeIconsFromIndex(element, resultSet);
                         }
                     }
                 }
         );
     }
 
-    private void completeAvailableIcons(PsiElement element, CompletionResultSet resultSet) {
-        IconProvider iconProvider = IconProvider.getInstance(element.getProject());
-        iconProvider.all(element.getProject()).forEach(iconDefinition -> {
-            LookupElementBuilder lookupElement;
-            try {
-                if (iconDefinition.getVirtualFile() == null) {
-                    throw new IOException("Could not find icon source");
-                }
-                Icon iconFromFile = IconUtil.createIconFromFile(iconDefinition.getVirtualFile());
-                if (iconFromFile == null) {
-                    throw new IOException("Unable to create image from icon source");
-                }
-                lookupElement = LookupElementBuilder
-                        .create(iconDefinition.getIdentifier())
-                        .withIcon(iconFromFile);
-            } catch (IOException e) {
-                // Silent error
-                lookupElement = LookupElementBuilder
-                        .create(iconDefinition.getIdentifier())
-                        .withIcon(TYPO3CMSIcons.ICON_NOT_RESOLVED);
-            }
-
-            if (iconDefinition.getFilename() != null) {
-                lookupElement = lookupElement.appendTailText(iconDefinition.getFilename(), true);
-            } else if (iconDefinition.getProvider() != null) {
-                lookupElement = lookupElement.appendTailText(iconDefinition.getProvider().getText(), true);
-            }
-
-            resultSet.addElement(lookupElement);
-        });
+    private void completeIconsFromIndex(PsiElement element, CompletionResultSet resultSet) {
+        IconIndex
+                .getAllAvailableIcons(element.getProject())
+                .forEach(iconIdentifier -> resultSet.addElement(LookupElementBuilder.create(iconIdentifier).withIcon(TYPO3CMSIcons.ICON_NOT_RESOLVED)));
     }
 }

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

@@ -0,0 +1,46 @@
+package com.cedricziel.idea.typo3.codeInsight.navigation;
+
+import com.cedricziel.idea.typo3.index.IconIndex;
+import com.intellij.codeInsight.navigation.actions.GotoDeclarationHandler;
+import com.intellij.openapi.actionSystem.DataContext;
+import com.intellij.openapi.editor.Editor;
+import com.intellij.patterns.PlatformPatterns;
+import com.intellij.psi.PsiElement;
+import com.jetbrains.php.lang.parser.PhpElementTypes;
+import com.jetbrains.php.lang.psi.elements.StringLiteralExpression;
+import org.jetbrains.annotations.Nullable;
+
+public class IconGotoDeclarationHandler implements GotoDeclarationHandler {
+    /**
+     * Provides an array of target declarations for given {@code sourceElement}.
+     *
+     * @param sourceElement input PSI element
+     * @param offset        offset in the file
+     * @param editor
+     * @return all target declarations as an array of {@code PsiElement} or null if none were found
+     */
+    @Nullable
+    @Override
+    public PsiElement[] getGotoDeclarationTargets(@Nullable PsiElement sourceElement, int offset, Editor editor) {
+        if (sourceElement != null && PlatformPatterns.psiElement().withParent(StringLiteralExpression.class).accepts(sourceElement)) {
+            String iconIdentifier = ((StringLiteralExpression) sourceElement.getParent()).getContents();
+            if (IconIndex.getAllAvailableIcons(sourceElement.getProject()).contains(iconIdentifier)) {
+                return IconIndex.getIconDefinitionElements(sourceElement.getProject(), iconIdentifier);
+            }
+        }
+
+        return new PsiElement[0];
+    }
+
+    /**
+     * Provides the custom action text.
+     *
+     * @param context the action data context
+     * @return the custom text or null to use the default text
+     */
+    @Nullable
+    @Override
+    public String getActionText(DataContext context) {
+        return null;
+    }
+}