Re-implemented a small file cache to provide file definition completion

It turned out that "calculating" the file definitions each time we need
them for completion is too slow. Let's see how this here works out.

Author: halirutan

src/de/halirutan/mathematica/codeinsight/completion/providers/FileSymbolCompletion.java

@@ -26,19 +26,17 @@
 import com.intellij.codeInsight.completion.*;
 import com.intellij.codeInsight.completion.impl.CamelHumpMatcher;
 import com.intellij.codeInsight.lookup.LookupElementBuilder;
-import com.intellij.openapi.diagnostic.Logger;
 import com.intellij.patterns.PlatformPatterns;
 import com.intellij.patterns.PsiElementPattern.Capture;
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiFile;
-import com.intellij.psi.util.PsiTreeUtil;
 import com.intellij.util.ProcessingContext;
-import de.halirutan.mathematica.lang.psi.LocalizationConstruct;
+import de.halirutan.mathematica.lang.psi.api.MathematicaPsiFile;
 import de.halirutan.mathematica.lang.psi.api.Symbol;
+import de.halirutan.mathematica.lang.resolve.SymbolResolveResult;
 import org.jetbrains.annotations.NotNull;
 
-import java.util.Set;
-import java.util.stream.Collectors;
+import java.util.HashSet;
 
 import static de.halirutan.mathematica.codeinsight.completion.MathematicaCompletionContributor.GLOBAL_VARIABLE_PRIORITY;
 
@@ -48,9 +46,6 @@
  */
 public class FileSymbolCompletion extends MathematicaCompletionProvider {
 
-  private static final Logger LOG =
-      Logger.getInstance("#de.halirutan.mathematica.codeinsight.completion.providers.FileSymbolCompletion");
-
   @Override
   public void addTo(CompletionContributor contributor) {
     final Capture<PsiElement> symbolPattern = PlatformPatterns.psiElement().withParent(Symbol.class);
@@ -62,21 +57,23 @@ protected void addCompletions(@NotNull CompletionParameters parameters, Processi
     final PsiFile containingFile = parameters.getOriginalFile();
 
     String prefix = findCurrentText(parameters, parameters.getPosition());
-    if (!parameters.isExtendedCompletion() && !prefix.isEmpty()) {
+    if (!parameters.isExtendedCompletion() && !prefix.isEmpty() && containingFile instanceof MathematicaPsiFile) {
       final CamelHumpMatcher matcher = new CamelHumpMatcher(prefix, true);
       CompletionResultSet result2 = result.withPrefixMatcher(matcher);
-
-      LOG.debug("Running file symbol completion");
-      final Set<String> symbols = PsiTreeUtil.findChildrenOfType(containingFile, Symbol.class).stream().filter(
-          s -> {
-            final LocalizationConstruct.MScope localizationConstruct = s.getLocalizationConstruct();
-            return s.isValid() && localizationConstruct == LocalizationConstruct.MScope.FILE_SCOPE;
-          }
-      ).map(
-          Symbol::getSymbolName
-      ).collect(Collectors.toSet());
-      symbols.forEach(s -> result2.addElement(PrioritizedLookupElement.withPriority(LookupElementBuilder.create(s),
-          GLOBAL_VARIABLE_PRIORITY)));
+      final HashSet<SymbolResolveResult> cachedDefinitions =
+          ((MathematicaPsiFile) containingFile).getCachedDefinitions();
+      for (SymbolResolveResult cachedDefinition : cachedDefinitions) {
+        if (cachedDefinition.isValidResult() && cachedDefinition.getElement() != null) {
+          result2.addElement(
+              PrioritizedLookupElement
+                  .withPriority(
+                      LookupElementBuilder
+                          .create(cachedDefinition.getElement())
+                          .bold()
+                          .withTypeText("(" + containingFile.getName() + ")", true),
+                      GLOBAL_VARIABLE_PRIORITY));
+        }
+      }
     }
   }
 

src/de/halirutan/mathematica/codeinsight/completion/providers/ImportedSymbolCompletion.java

@@ -31,6 +31,7 @@
 import com.intellij.patterns.PlatformPatterns;
 import com.intellij.patterns.PsiElementPattern.Capture;
 import com.intellij.psi.PsiElement;
+import com.intellij.psi.PsiFile;
 import com.intellij.psi.search.GlobalSearchScope;
 import com.intellij.psi.search.ProjectScope;
 import com.intellij.util.ProcessingContext;
@@ -39,6 +40,8 @@
 import de.halirutan.mathematica.lang.psi.api.Symbol;
 import org.jetbrains.annotations.NotNull;
 
+import java.util.Objects;
+
 import static de.halirutan.mathematica.codeinsight.completion.MathematicaCompletionContributor.IMPORT_VARIABLE_PRIORITY;
 
 
@@ -59,18 +62,18 @@ protected void addCompletions(@NotNull CompletionParameters parameters, Processi
     final Project project = callingSymbol.getProject();
 
     String prefix = findCurrentText(parameters, parameters.getPosition());
+    final PsiFile originalFile = parameters.getOriginalFile();
     final Module module =
-        ModuleUtilCore.findModuleForFile(parameters.getOriginalFile().getVirtualFile(), project);
+        ModuleUtilCore.findModuleForFile(originalFile.getVirtualFile(), project);
     if (module != null) {
-
       if (!parameters.isExtendedCompletion() || !(prefix.isEmpty() || Character.isDigit(prefix.charAt(0)))) {
         final GlobalSearchScope moduleScope = GlobalSearchScope.moduleWithDependenciesAndLibrariesScope(module)
                                                                .union(ProjectScope.getLibrariesScope(project));
         final FileBasedIndex index = FileBasedIndex.getInstance();
         index.processAllKeys(
             MathematicaPackageExportIndex.INDEX_ID,
             key -> {
-              if (key.isExported()) {
+              if (key.isExported() && !Objects.equals(key.getFileName(), originalFile.getName())) {
                 result.addElement(PrioritizedLookupElement.withPriority(
                     LookupElementBuilder.create(key.getSymbol()).withTypeText("(" + key.getFileName() + ")", true),
                     IMPORT_VARIABLE_PRIORITY));

src/de/halirutan/mathematica/lang/psi/api/MathematicaPsiFile.java

@@ -24,10 +24,16 @@
 package de.halirutan.mathematica.lang.psi.api;
 
 import com.intellij.psi.PsiFile;
+import de.halirutan.mathematica.lang.resolve.SymbolResolveResult;
+
+import java.util.HashSet;
 
 /**
  * Created with IntelliJ IDEA. User: patrick Date: 1/3/13 Time: 12:09 PM Purpose:
  */
 public interface MathematicaPsiFile extends PsiFile, Expression {
 
+  void cacheLocalDefinition(SymbolResolveResult result);
+
+  HashSet<SymbolResolveResult> getCachedDefinitions();
 }

src/de/halirutan/mathematica/lang/psi/impl/MathematicaPsiFileImpl.java

@@ -29,16 +29,23 @@
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.ResolveState;
 import com.intellij.psi.scope.PsiScopeProcessor;
+import com.intellij.util.containers.ContainerUtil;
 import de.halirutan.mathematica.file.MathematicaFileType;
 import de.halirutan.mathematica.lang.MathematicaLanguage;
 import de.halirutan.mathematica.lang.psi.api.MathematicaPsiFile;
+import de.halirutan.mathematica.lang.resolve.SymbolResolveResult;
 import org.jetbrains.annotations.NotNull;
 
+import java.util.HashSet;
+
 /**
  * Created with IntelliJ IDEA. User: patrick Date: 1/3/13 Time: 12:09 PM Purpose:
  */
 public class MathematicaPsiFileImpl extends PsiFileBase implements MathematicaPsiFile {
 
+  private final HashSet<SymbolResolveResult> cachedDefintions = ContainerUtil.newHashSet();
+  private boolean isCacheOutdated = true;
+
   public MathematicaPsiFileImpl(@NotNull FileViewProvider viewProvider) {
     super(viewProvider, MathematicaLanguage.INSTANCE);
   }
@@ -58,4 +65,25 @@ public boolean processDeclarations(@NotNull PsiScopeProcessor processor, @NotNul
   public boolean headMatches(final Class clazz) {
     return clazz.isInstance(this);
   }
+
+  @Override
+  public void cacheLocalDefinition(SymbolResolveResult result) {
+    if (isCacheOutdated) {
+      cachedDefintions.clear();
+      isCacheOutdated = false;
+    }
+    if (result != null) {
+      cachedDefintions.add(result);
+    }
+  }
+
+  @Override
+  public HashSet<SymbolResolveResult> getCachedDefinitions() {
+    return cachedDefintions;
+  }
+
+  @Override
+  public void subtreeChanged() {
+    isCacheOutdated = true;
+  }
 }

src/de/halirutan/mathematica/lang/resolve/MathematicaGlobalSymbolResolver.java

@@ -35,6 +35,7 @@
 import com.intellij.psi.util.PsiTreeUtil;
 import com.intellij.util.indexing.FileBasedIndex;
 import de.halirutan.mathematica.index.packageexport.MathematicaPackageExportIndex;
+import de.halirutan.mathematica.lang.psi.api.MathematicaPsiFile;
 import de.halirutan.mathematica.lang.psi.api.Symbol;
 import de.halirutan.mathematica.lang.resolve.processors.GlobalDefinitionResolveProcessor;
 import org.jetbrains.annotations.NotNull;
@@ -81,6 +82,9 @@ public ResolveResult[] resolve(@NotNull Symbol ref, @NotNull PsiFile containingF
     final Symbol resolveResult = globalProcessor.getResolveResult();
     if (resolveResult != null) {
       final SymbolResolveResult result = symbolCache.cacheFileSymbol(resolveResult, containingFile);
+      if (containingFile instanceof MathematicaPsiFile) {
+        ((MathematicaPsiFile) containingFile).cacheLocalDefinition(result);
+      }
       return new ResolveResult[]{result};
     }