Cleanup: NotNull/Nullable
[idea/community.git] / java / java-psi-impl / src / com / intellij / psi / impl / source / resolve / JavaResolveCache.java
1 /*
2  * Copyright 2000-2015 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
17 /*
18  * @author max
19  */
20 package com.intellij.psi.impl.source.resolve;
21
22 import com.intellij.openapi.components.ServiceManager;
23 import com.intellij.openapi.project.Project;
24 import com.intellij.openapi.util.Key;
25 import com.intellij.openapi.util.NotNullLazyKey;
26 import com.intellij.openapi.util.RecursionGuard;
27 import com.intellij.openapi.util.RecursionManager;
28 import com.intellij.psi.*;
29 import com.intellij.psi.impl.AnyPsiChangeListener;
30 import com.intellij.psi.impl.PsiManagerImpl;
31 import com.intellij.psi.impl.source.PsiClassReferenceType;
32 import com.intellij.psi.impl.source.PsiImmediateClassType;
33 import com.intellij.psi.impl.source.resolve.graphInference.PsiPolyExpressionUtil;
34 import com.intellij.psi.infos.MethodCandidateInfo;
35 import com.intellij.psi.util.TypeConversionUtil;
36 import com.intellij.util.ConcurrencyUtil;
37 import com.intellij.util.Function;
38 import com.intellij.util.containers.ContainerUtil;
39 import com.intellij.util.messages.MessageBus;
40 import org.jetbrains.annotations.NotNull;
41 import org.jetbrains.annotations.Nullable;
42
43 import java.util.Map;
44 import java.util.Set;
45 import java.util.concurrent.ConcurrentMap;
46 import java.util.concurrent.atomic.AtomicReference;
47
48 public class JavaResolveCache {
49   private static final NotNullLazyKey<JavaResolveCache, Project> INSTANCE_KEY = ServiceManager.createLazyKey(JavaResolveCache.class);
50
51   public static JavaResolveCache getInstance(Project project) {
52     return INSTANCE_KEY.getValue(project);
53   }
54
55   private final AtomicReference<ConcurrentMap<PsiExpression, PsiType>> myCalculatedTypes = new AtomicReference<>();
56   private final AtomicReference<Map<PsiVariable,Object>> myVarToConstValueMapPhysical = new AtomicReference<>();
57   private final AtomicReference<Map<PsiVariable,Object>> myVarToConstValueMapNonPhysical = new AtomicReference<>();
58
59   private static final Object NULL = Key.create("NULL");
60
61   public JavaResolveCache(@Nullable("can be null in com.intellij.core.JavaCoreApplicationEnvironment.JavaCoreApplicationEnvironment") MessageBus messageBus) {
62     if (messageBus != null) {
63       messageBus.connect().subscribe(PsiManagerImpl.ANY_PSI_CHANGE_TOPIC, new AnyPsiChangeListener.Adapter() {
64         @Override
65         public void beforePsiChanged(boolean isPhysical) {
66           clearCaches(isPhysical);
67         }
68       });
69     }
70   }
71
72   private void clearCaches(boolean isPhysical) {
73     myCalculatedTypes.set(null);
74     if (isPhysical) {
75       myVarToConstValueMapPhysical.set(null);
76     }
77     myVarToConstValueMapNonPhysical.set(null);
78   }
79
80   @Nullable
81   public <T extends PsiExpression> PsiType getType(@NotNull T expr, @NotNull Function<T, PsiType> f) {
82     final boolean isOverloadCheck = MethodCandidateInfo.isOverloadCheck() || LambdaUtil.isLambdaParameterCheck();
83     final boolean polyExpression = PsiPolyExpressionUtil.isPolyExpression(expr);
84
85     ConcurrentMap<PsiExpression, PsiType> map = myCalculatedTypes.get();
86     if (map == null) map = ConcurrencyUtil.cacheOrGet(myCalculatedTypes, ContainerUtil.createConcurrentWeakKeySoftValueMap());
87
88     PsiType type = isOverloadCheck && polyExpression ? null : map.get(expr);
89     if (type == null) {
90       RecursionGuard.StackStamp dStackStamp = RecursionManager.markStack();
91       type = f.fun(expr);
92       if (!dStackStamp.mayCacheNow()) {
93         return type;
94       }
95
96       //cache standalone expression types as they do not depend on the context
97       if (isOverloadCheck && polyExpression) {
98         return type;
99       }
100
101       if (type == null) type = TypeConversionUtil.NULL_TYPE;
102       map.put(expr, type);
103
104       if (type instanceof PsiClassReferenceType) {
105         // convert reference-based class type to the PsiImmediateClassType, since the reference may become invalid
106         PsiClassType.ClassResolveResult result = ((PsiClassReferenceType)type).resolveGenerics();
107         PsiClass psiClass = result.getElement();
108         type = psiClass == null
109                ? type // for type with unresolved reference, leave it in the cache
110                       // for clients still might be able to retrieve its getCanonicalText() from the reference text
111                : new PsiImmediateClassType(psiClass, result.getSubstitutor(), ((PsiClassReferenceType)type).getLanguageLevel(), type.getAnnotationProvider());
112       }
113     }
114
115     return type == TypeConversionUtil.NULL_TYPE ? null : type;
116   }
117
118   @Nullable
119   public Object computeConstantValueWithCaching(@NotNull PsiVariable variable, @NotNull ConstValueComputer computer, Set<PsiVariable> visitedVars){
120     boolean physical = variable.isPhysical();
121
122     AtomicReference<Map<PsiVariable, Object>> ref = physical ? myVarToConstValueMapPhysical : myVarToConstValueMapNonPhysical;
123     Map<PsiVariable, Object> map = ref.get();
124     if (map == null) map = ConcurrencyUtil.cacheOrGet(ref, ContainerUtil.createConcurrentWeakMap());
125
126     Object cached = map.get(variable);
127     if (cached == NULL) return null;
128     if (cached != null) return cached;
129
130     Object result = computer.execute(variable, visitedVars);
131     map.put(variable, result == null ? NULL : result);
132     return result;
133   }
134
135   @FunctionalInterface
136   public interface ConstValueComputer{
137     Object execute(@NotNull PsiVariable variable, Set<PsiVariable> visitedVars);
138   }
139 }