diagnostics for outdated anchor in SymbolCollectingProcessor (EA-63219 - IAE: ObjectU...
[idea/community.git] / java / java-psi-impl / src / com / intellij / psi / impl / source / resolve / SymbolCollectingProcessor.java
1 /*
2  * Copyright 2000-2014 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.intellij.psi.impl.source.resolve;
17
18 import com.intellij.openapi.util.Key;
19 import com.intellij.psi.PsiAnchor;
20 import com.intellij.psi.PsiElement;
21 import com.intellij.psi.PsiNamedElement;
22 import com.intellij.psi.ResolveState;
23 import com.intellij.psi.scope.BaseScopeProcessor;
24 import com.intellij.psi.scope.ElementClassHint;
25 import com.intellij.psi.scope.JavaScopeProcessorEvent;
26 import com.intellij.psi.scope.PsiScopeProcessor;
27 import com.intellij.util.containers.MostlySingularMultiMap;
28 import org.jetbrains.annotations.NotNull;
29
30 /**
31  * @author max
32  */
33 public class SymbolCollectingProcessor extends BaseScopeProcessor implements ElementClassHint {
34   private final MostlySingularMultiMap<String, ResultWithContext> myResult = new MostlySingularMultiMap<String, ResultWithContext>();
35   private PsiElement myCurrentFileContext = null;
36
37   @Override
38   public <T> T getHint(@NotNull Key<T> hintKey) {
39     if (hintKey == ElementClassHint.KEY) {
40       //noinspection unchecked
41       return (T)this;
42     }
43     return null;
44   }
45
46   @Override
47   public void handleEvent(@NotNull PsiScopeProcessor.Event event, Object associated) {
48     if (event == JavaScopeProcessorEvent.SET_CURRENT_FILE_CONTEXT) {
49       myCurrentFileContext = (PsiElement)associated;
50     }
51   }
52
53   @Override
54   public boolean execute(@NotNull PsiElement element, @NotNull ResolveState state) {
55     if (element instanceof PsiNamedElement && element.isValid()) {
56       PsiNamedElement named = (PsiNamedElement)element;
57       String name = named.getName();
58       if (name != null) {
59         myResult.add(name, new ResultWithContext(named, myCurrentFileContext));
60       }
61     }
62     return true;
63   }
64
65   @Override
66   public boolean shouldProcess(DeclarationKind kind) {
67     return kind == DeclarationKind.CLASS || kind == DeclarationKind.PACKAGE || kind == DeclarationKind.METHOD || kind == DeclarationKind.FIELD;
68   }
69
70   public MostlySingularMultiMap<String, ResultWithContext> getResults() {
71     return myResult;
72   }
73
74   public static class ResultWithContext {
75     private final PsiAnchor myElement;
76     private final PsiAnchor myFileContext;
77
78     public ResultWithContext(@NotNull PsiNamedElement element, PsiElement fileContext) {
79       myElement = PsiAnchor.create(element);
80       myFileContext = fileContext == null ? null : PsiAnchor.create(fileContext);
81     }
82
83     @NotNull
84     public PsiNamedElement getElement() {
85       PsiElement element = myElement.retrieve();
86       if (element == null) {
87         String message = "Anchor hasn't survived: " + myElement;
88         if (myElement instanceof PsiAnchor.StubIndexReference) {
89           message += "; diagnostics=" + ((PsiAnchor.StubIndexReference)myElement).diagnoseNull();
90         }
91         throw new AssertionError(message);
92       }
93
94       return (PsiNamedElement)element;
95     }
96
97     public PsiElement getFileContext() {
98       return myFileContext == null ? null : myFileContext.retrieve();
99     }
100
101     @Override
102     public String toString() {
103       return myElement.toString();
104     }
105   }
106 }