001 /*
002 * Copyright 2010-2016 JetBrains s.r.o.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017 package org.jetbrains.kotlin.resolve;
018
019 import com.google.common.collect.ImmutableMap;
020 import com.intellij.psi.PsiElement;
021 import org.jetbrains.annotations.NotNull;
022 import org.jetbrains.annotations.Nullable;
023 import org.jetbrains.annotations.ReadOnly;
024 import org.jetbrains.annotations.TestOnly;
025 import org.jetbrains.kotlin.cfg.LeakingThisDescriptor;
026 import org.jetbrains.kotlin.cfg.TailRecursionKind;
027 import org.jetbrains.kotlin.descriptors.*;
028 import org.jetbrains.kotlin.descriptors.annotations.AnnotationDescriptor;
029 import org.jetbrains.kotlin.name.FqName;
030 import org.jetbrains.kotlin.name.FqNameUnsafe;
031 import org.jetbrains.kotlin.psi.*;
032 import org.jetbrains.kotlin.resolve.calls.inference.ConstraintSystemCompleter;
033 import org.jetbrains.kotlin.resolve.calls.model.ResolvedCall;
034 import org.jetbrains.kotlin.resolve.calls.smartcasts.DataFlowInfo;
035 import org.jetbrains.kotlin.resolve.constants.CompileTimeConstant;
036 import org.jetbrains.kotlin.resolve.diagnostics.Diagnostics;
037 import org.jetbrains.kotlin.resolve.scopes.LexicalScope;
038 import org.jetbrains.kotlin.resolve.scopes.receivers.Qualifier;
039 import org.jetbrains.kotlin.types.DeferredType;
040 import org.jetbrains.kotlin.types.KotlinType;
041 import org.jetbrains.kotlin.types.expressions.CaptureKind;
042 import org.jetbrains.kotlin.types.expressions.KotlinTypeInfo;
043 import org.jetbrains.kotlin.types.expressions.PreliminaryDeclarationVisitor;
044 import org.jetbrains.kotlin.util.Box;
045 import org.jetbrains.kotlin.util.slicedMap.*;
046
047 import java.util.Collection;
048 import java.util.Collections;
049
050 import static org.jetbrains.kotlin.util.slicedMap.RewritePolicy.DO_NOTHING;
051
052 public interface BindingContext {
053 BindingContext EMPTY = new BindingContext() {
054 @NotNull
055 @Override
056 public Diagnostics getDiagnostics() {
057 return Diagnostics.Companion.getEMPTY();
058 }
059
060 @Override
061 public <K, V> V get(ReadOnlySlice<K, V> slice, K key) {
062 return null;
063 }
064
065 @NotNull
066 @Override
067 public <K, V> Collection<K> getKeys(WritableSlice<K, V> slice) {
068 return Collections.emptyList();
069 }
070
071 @NotNull
072 @TestOnly
073 @Override
074 public <K, V> ImmutableMap<K, V> getSliceContents(@NotNull ReadOnlySlice<K, V> slice) {
075 return ImmutableMap.of();
076 }
077
078 @Nullable
079 @Override
080 public KotlinType getType(@NotNull KtExpression expression) {
081 return null;
082 }
083
084 @Override
085 public void addOwnDataTo(@NotNull BindingTrace trace, boolean commitDiagnostics) {
086 // Do nothing
087 }
088 };
089
090 WritableSlice<KtAnnotationEntry, AnnotationDescriptor> ANNOTATION = Slices.createSimpleSlice();
091
092 WritableSlice<KtExpression, CompileTimeConstant<?>> COMPILE_TIME_VALUE = Slices.createSimpleSlice();
093
094 WritableSlice<KtTypeReference, KotlinType> TYPE = Slices.createSimpleSlice();
095 WritableSlice<KtExpression, KotlinTypeInfo> EXPRESSION_TYPE_INFO = new BasicWritableSlice<KtExpression, KotlinTypeInfo>(DO_NOTHING);
096 WritableSlice<KtExpression, KotlinType> EXPECTED_EXPRESSION_TYPE = new BasicWritableSlice<KtExpression, KotlinType>(DO_NOTHING);
097 WritableSlice<KtFunction, KotlinType> EXPECTED_RETURN_TYPE = new BasicWritableSlice<KtFunction, KotlinType>(DO_NOTHING);
098 WritableSlice<KtExpression, DataFlowInfo> DATAFLOW_INFO_AFTER_CONDITION = Slices.createSimpleSlice();
099 WritableSlice<KtExpression, LeakingThisDescriptor> LEAKING_THIS = Slices.createSimpleSlice();
100
101 /**
102 * A qualifier corresponds to a receiver expression (if any). For 'A.B' qualifier is recorded for 'A'.
103 */
104 WritableSlice<KtExpression, Qualifier> QUALIFIER = new BasicWritableSlice<KtExpression, Qualifier>(DO_NOTHING);
105
106 WritableSlice<KtSuperExpression, KotlinType> THIS_TYPE_FOR_SUPER_EXPRESSION =
107 new BasicWritableSlice<KtSuperExpression, KotlinType>(DO_NOTHING);
108
109 WritableSlice<KtReferenceExpression, DeclarationDescriptor> REFERENCE_TARGET =
110 new BasicWritableSlice<KtReferenceExpression, DeclarationDescriptor>(DO_NOTHING);
111 // if 'A' really means 'A.Companion' then this slice stores class descriptor for A, REFERENCE_TARGET stores descriptor Companion in this case
112 WritableSlice<KtReferenceExpression, ClassDescriptor> SHORT_REFERENCE_TO_COMPANION_OBJECT =
113 new BasicWritableSlice<KtReferenceExpression, ClassDescriptor>(DO_NOTHING);
114
115 WritableSlice<Call, ResolvedCall<?>> RESOLVED_CALL = new BasicWritableSlice<Call, ResolvedCall<?>>(DO_NOTHING);
116 WritableSlice<Call, TailRecursionKind> TAIL_RECURSION_CALL = Slices.createSimpleSlice();
117 WritableSlice<KtElement, ConstraintSystemCompleter> CONSTRAINT_SYSTEM_COMPLETER = new BasicWritableSlice<KtElement, ConstraintSystemCompleter>(DO_NOTHING);
118 WritableSlice<KtElement, Call> CALL = new BasicWritableSlice<KtElement, Call>(DO_NOTHING);
119
120 WritableSlice<KtExpression, Collection<? extends DeclarationDescriptor>> AMBIGUOUS_REFERENCE_TARGET =
121 new BasicWritableSlice<KtExpression, Collection<? extends DeclarationDescriptor>>(DO_NOTHING);
122
123 WritableSlice<KtExpression, ResolvedCall<FunctionDescriptor>> LOOP_RANGE_ITERATOR_RESOLVED_CALL = Slices.createSimpleSlice();
124
125 WritableSlice<KtExpression, ResolvedCall<FunctionDescriptor>> LOOP_RANGE_HAS_NEXT_RESOLVED_CALL = Slices.createSimpleSlice();
126 WritableSlice<KtExpression, ResolvedCall<FunctionDescriptor>> LOOP_RANGE_NEXT_RESOLVED_CALL = Slices.createSimpleSlice();
127
128 WritableSlice<PropertyAccessorDescriptor, ResolvedCall<FunctionDescriptor>> DELEGATED_PROPERTY_RESOLVED_CALL = Slices.createSimpleSlice();
129 WritableSlice<PropertyAccessorDescriptor, Call> DELEGATED_PROPERTY_CALL = Slices.createSimpleSlice();
130
131 WritableSlice<PropertyDescriptor, ResolvedCall<FunctionDescriptor>> DELEGATED_PROPERTY_PD_RESOLVED_CALL = Slices.createSimpleSlice();
132
133 WritableSlice<KtDestructuringDeclarationEntry, ResolvedCall<FunctionDescriptor>> COMPONENT_RESOLVED_CALL = Slices.createSimpleSlice();
134
135 WritableSlice<KtExpression, ResolvedCall<FunctionDescriptor>> INDEXED_LVALUE_GET = Slices.createSimpleSlice();
136 WritableSlice<KtExpression, ResolvedCall<FunctionDescriptor>> INDEXED_LVALUE_SET = Slices.createSimpleSlice();
137
138 WritableSlice<KtExpression, KotlinType> SMARTCAST = Slices.createSimpleSlice();
139 WritableSlice<KtExpression, Boolean> SMARTCAST_NULL = Slices.createSimpleSlice();
140 WritableSlice<KtExpression, KotlinType> IMPLICIT_RECEIVER_SMARTCAST = Slices.createSimpleSlice();
141
142 WritableSlice<KtWhenExpression, Boolean> EXHAUSTIVE_WHEN = Slices.createSimpleSlice();
143 WritableSlice<KtWhenExpression, Boolean> IMPLICIT_EXHAUSTIVE_WHEN = Slices.createSimpleSlice();
144
145 WritableSlice<KtElement, LexicalScope> LEXICAL_SCOPE = Slices.createSimpleSlice();
146
147 WritableSlice<ScriptDescriptor, LexicalScope> SCRIPT_SCOPE = Slices.createSimpleSlice();
148
149 WritableSlice<KtExpression, Boolean> VARIABLE_REASSIGNMENT = Slices.createSimpleSetSlice();
150 WritableSlice<ValueParameterDescriptor, Boolean> AUTO_CREATED_IT = Slices.createSimpleSetSlice();
151
152 /**
153 * Has type of current expression has been already resolved
154 */
155 WritableSlice<KtExpression, Boolean> PROCESSED = Slices.createSimpleSetSlice();
156 WritableSlice<KtElement, Boolean> USED_AS_EXPRESSION = Slices.createSimpleSetSlice();
157 WritableSlice<KtElement, Boolean> USED_AS_RESULT_OF_LAMBDA = Slices.createSimpleSetSlice();
158 WritableSlice<KtElement, Boolean> UNREACHABLE_CODE = Slices.createSimpleSetSlice();
159
160 WritableSlice<VariableDescriptor, CaptureKind> CAPTURED_IN_CLOSURE = new BasicWritableSlice<VariableDescriptor, CaptureKind>(DO_NOTHING);
161 WritableSlice<KtDeclaration, PreliminaryDeclarationVisitor> PRELIMINARY_VISITOR = new BasicWritableSlice<KtDeclaration, PreliminaryDeclarationVisitor>(DO_NOTHING);
162
163 WritableSlice<Box<DeferredType>, Boolean> DEFERRED_TYPE = Slices.createCollectiveSetSlice();
164
165 WritableSlice<PropertyDescriptor, Boolean> BACKING_FIELD_REQUIRED = new SetSlice<PropertyDescriptor>(DO_NOTHING) {
166 @Override
167 public Boolean computeValue(
168 SlicedMap map,
169 PropertyDescriptor propertyDescriptor,
170 Boolean backingFieldRequired,
171 boolean valueNotFound
172 ) {
173 if (propertyDescriptor.getKind() != CallableMemberDescriptor.Kind.DECLARATION) {
174 return false;
175 }
176 backingFieldRequired = valueNotFound ? false : backingFieldRequired;
177 PsiElement declarationPsiElement = DescriptorToSourceUtils.descriptorToDeclaration(propertyDescriptor);
178 if (declarationPsiElement instanceof KtParameter) {
179 KtParameter jetParameter = (KtParameter) declarationPsiElement;
180 return jetParameter.hasValOrVar() ||
181 backingFieldRequired; // this part is unused because we do not allow access to constructor parameters in member bodies
182 }
183 if (propertyDescriptor.getModality() == Modality.ABSTRACT) return false;
184 if (declarationPsiElement instanceof KtProperty &&
185 ((KtProperty) declarationPsiElement).hasDelegate()) return false;
186 PropertyGetterDescriptor getter = propertyDescriptor.getGetter();
187 PropertySetterDescriptor setter = propertyDescriptor.getSetter();
188
189 if (getter == null) return true;
190 if (propertyDescriptor.isVar() && setter == null) return true;
191 if (setter != null && !DescriptorPsiUtilsKt.hasBody(setter) && setter.getModality() != Modality.ABSTRACT) return true;
192 if (!DescriptorPsiUtilsKt.hasBody(getter) && getter.getModality() != Modality.ABSTRACT) return true;
193
194 return backingFieldRequired;
195 }
196 };
197 WritableSlice<PropertyDescriptor, Boolean> IS_UNINITIALIZED = Slices.createSimpleSetSlice();
198
199 WritableSlice<KtLambdaExpression, Boolean> BLOCK = new SetSlice<KtLambdaExpression>(DO_NOTHING) {
200 @Override
201 public Boolean computeValue(SlicedMap map, KtLambdaExpression expression, Boolean isBlock, boolean valueNotFound) {
202 isBlock = valueNotFound ? false : isBlock;
203 return isBlock && !expression.getFunctionLiteral().hasParameterSpecification();
204 }
205 };
206
207 WritableSlice<PsiElement, ClassDescriptor> CLASS = Slices.createSimpleSlice();
208 WritableSlice<PsiElement, ScriptDescriptor> SCRIPT = Slices.createSimpleSlice();
209 WritableSlice<KtTypeParameter, TypeParameterDescriptor> TYPE_PARAMETER = Slices.createSimpleSlice();
210 /**
211 * @see BindingContextUtils#recordFunctionDeclarationToDescriptor(BindingTrace, PsiElement, SimpleFunctionDescriptor)}
212 */
213 WritableSlice<PsiElement, SimpleFunctionDescriptor> FUNCTION = Slices.createSimpleSlice();
214 WritableSlice<PsiElement, ConstructorDescriptor> CONSTRUCTOR = Slices.createSimpleSlice();
215 WritableSlice<ConstructorDescriptor, ResolvedCall<ConstructorDescriptor>> CONSTRUCTOR_RESOLVED_DELEGATION_CALL =
216 Slices.createSimpleSlice();
217 WritableSlice<PsiElement, VariableDescriptor> VARIABLE = Slices.createSimpleSlice();
218 WritableSlice<KtParameter, VariableDescriptor> VALUE_PARAMETER = Slices.createSimpleSlice();
219 WritableSlice<KtPropertyAccessor, PropertyAccessorDescriptor> PROPERTY_ACCESSOR = Slices.createSimpleSlice();
220 WritableSlice<PsiElement, PropertyDescriptor> PRIMARY_CONSTRUCTOR_PARAMETER = Slices.createSimpleSlice();
221
222 WritableSlice[] DECLARATIONS_TO_DESCRIPTORS = new WritableSlice[] {
223 CLASS, TYPE_PARAMETER, FUNCTION, CONSTRUCTOR, VARIABLE, VALUE_PARAMETER, PROPERTY_ACCESSOR,
224 PRIMARY_CONSTRUCTOR_PARAMETER, SCRIPT
225 };
226
227 @SuppressWarnings("unchecked")
228 ReadOnlySlice<PsiElement, DeclarationDescriptor> DECLARATION_TO_DESCRIPTOR =
229 Slices.<PsiElement, DeclarationDescriptor>sliceBuilder()
230 .setFurtherLookupSlices(DECLARATIONS_TO_DESCRIPTORS)
231 .build();
232
233 WritableSlice<KtReferenceExpression, PsiElement> LABEL_TARGET = Slices.createSimpleSlice();
234 WritableSlice<KtReferenceExpression, Collection<? extends PsiElement>> AMBIGUOUS_LABEL_TARGET = Slices.createSimpleSlice();
235 WritableSlice<ValueParameterDescriptor, PropertyDescriptor> VALUE_PARAMETER_AS_PROPERTY = Slices.createSimpleSlice();
236
237 WritableSlice<ValueParameterDescriptor, FunctionDescriptor> DATA_CLASS_COMPONENT_FUNCTION = Slices.createSimpleSlice();
238 WritableSlice<ClassDescriptor, FunctionDescriptor> DATA_CLASS_COPY_FUNCTION = Slices.createSimpleSlice();
239
240 WritableSlice<FqNameUnsafe, ClassDescriptor> FQNAME_TO_CLASS_DESCRIPTOR =
241 new BasicWritableSlice<FqNameUnsafe, ClassDescriptor>(DO_NOTHING, true);
242 WritableSlice<KtFile, PackageFragmentDescriptor> FILE_TO_PACKAGE_FRAGMENT = Slices.createSimpleSlice();
243 WritableSlice<FqName, Collection<KtFile>> PACKAGE_TO_FILES = Slices.createSimpleSlice();
244
245 @SuppressWarnings("UnusedDeclaration")
246 @Deprecated // This field is needed only for the side effects of its initializer
247 Void _static_initializer = BasicWritableSlice.initSliceDebugNames(BindingContext.class);
248
249 @NotNull
250 Diagnostics getDiagnostics();
251
252 @Nullable
253 <K, V> V get(ReadOnlySlice<K, V> slice, K key);
254
255 // slice.isCollective() must be true
256 @NotNull
257 @ReadOnly
258 <K, V> Collection<K> getKeys(WritableSlice<K, V> slice);
259
260 /** This method should be used only for debug and testing */
261 @TestOnly
262 @NotNull
263 <K, V> ImmutableMap<K, V> getSliceContents(@NotNull ReadOnlySlice<K, V> slice);
264
265 @Nullable
266 KotlinType getType(@NotNull KtExpression expression);
267
268 void addOwnDataTo(@NotNull BindingTrace trace, boolean commitDiagnostics);
269 }