001 /*
002 * Copyright 2010-2015 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 jet.runtime.typeinfo.KotlinSignature;
022 import org.jetbrains.annotations.NotNull;
023 import org.jetbrains.annotations.Nullable;
024 import org.jetbrains.annotations.ReadOnly;
025 import org.jetbrains.annotations.TestOnly;
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.JetScope;
038 import org.jetbrains.kotlin.resolve.scopes.receivers.Qualifier;
039 import org.jetbrains.kotlin.types.Approximation;
040 import org.jetbrains.kotlin.types.DeferredType;
041 import org.jetbrains.kotlin.types.JetType;
042 import org.jetbrains.kotlin.types.expressions.CaptureKind;
043 import org.jetbrains.kotlin.types.expressions.JetTypeInfo;
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.EMPTY;
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 JetType getType(@NotNull JetExpression expression) {
081 return null;
082 }
083 };
084
085 WritableSlice<AnnotationDescriptor, JetAnnotationEntry> ANNOTATION_DESCRIPTOR_TO_PSI_ELEMENT = Slices.createSimpleSlice();
086 WritableSlice<JetAnnotationEntry, AnnotationDescriptor> ANNOTATION =
087 Slices.<JetAnnotationEntry, AnnotationDescriptor>sliceBuilder().setOpposite(ANNOTATION_DESCRIPTOR_TO_PSI_ELEMENT).build();
088
089 WritableSlice<JetExpression, CompileTimeConstant<?>> COMPILE_TIME_VALUE = Slices.createSimpleSlice();
090
091 WritableSlice<JetTypeReference, JetType> TYPE = Slices.createSimpleSlice();
092 WritableSlice<JetExpression, JetTypeInfo> EXPRESSION_TYPE_INFO = new BasicWritableSlice<JetExpression, JetTypeInfo>(DO_NOTHING);
093 WritableSlice<JetExpression, JetType> EXPECTED_EXPRESSION_TYPE = new BasicWritableSlice<JetExpression, JetType>(DO_NOTHING);
094 WritableSlice<JetFunction, JetType> EXPECTED_RETURN_TYPE = new BasicWritableSlice<JetFunction, JetType>(DO_NOTHING);
095 WritableSlice<JetExpression, Approximation.Info> EXPRESSION_RESULT_APPROXIMATION = new BasicWritableSlice<JetExpression, Approximation.Info>(DO_NOTHING);
096 WritableSlice<JetExpression, DataFlowInfo> DATAFLOW_INFO_AFTER_CONDITION = Slices.createSimpleSlice();
097
098 /**
099 * A qualifier corresponds to a receiver expression (if any). For 'A.B' qualifier is recorded for 'A'.
100 */
101 WritableSlice<JetExpression, Qualifier> QUALIFIER = new BasicWritableSlice<JetExpression, Qualifier>(DO_NOTHING);
102
103 WritableSlice<JetReferenceExpression, DeclarationDescriptor> REFERENCE_TARGET =
104 new BasicWritableSlice<JetReferenceExpression, DeclarationDescriptor>(DO_NOTHING);
105 // if 'A' really means 'A.Companion' then this slice stores class descriptor for A, REFERENCE_TARGET stores descriptor Companion in this case
106 WritableSlice<JetReferenceExpression, ClassDescriptor> SHORT_REFERENCE_TO_COMPANION_OBJECT =
107 new BasicWritableSlice<JetReferenceExpression, ClassDescriptor>(DO_NOTHING);
108
109 @KotlinSignature("val RESOLVED_CALL: WritableSlice<Call, ResolvedCall<out CallableDescriptor>>")
110 WritableSlice<Call, ResolvedCall<?>> RESOLVED_CALL = new BasicWritableSlice<Call, ResolvedCall<?>>(DO_NOTHING);
111 WritableSlice<ResolvedCall<?>, TailRecursionKind> TAIL_RECURSION_CALL = Slices.createSimpleSlice();
112 WritableSlice<JetElement, ConstraintSystemCompleter> CONSTRAINT_SYSTEM_COMPLETER = new BasicWritableSlice<JetElement, ConstraintSystemCompleter>(DO_NOTHING);
113 WritableSlice<JetElement, Call> CALL = new BasicWritableSlice<JetElement, Call>(DO_NOTHING);
114
115 @KotlinSignature("val AMBIGUOUS_REFERENCE_TARGET: WritableSlice<JetExpression, Collection<DeclarationDescriptor>>")
116 WritableSlice<JetExpression, Collection<? extends DeclarationDescriptor>> AMBIGUOUS_REFERENCE_TARGET =
117 new BasicWritableSlice<JetExpression, Collection<? extends DeclarationDescriptor>>(DO_NOTHING);
118
119 WritableSlice<JetExpression, ResolvedCall<FunctionDescriptor>> LOOP_RANGE_ITERATOR_RESOLVED_CALL = Slices.createSimpleSlice();
120
121 WritableSlice<JetExpression, ResolvedCall<FunctionDescriptor>> LOOP_RANGE_HAS_NEXT_RESOLVED_CALL = Slices.createSimpleSlice();
122 WritableSlice<JetExpression, ResolvedCall<FunctionDescriptor>> LOOP_RANGE_NEXT_RESOLVED_CALL = Slices.createSimpleSlice();
123
124 WritableSlice<PropertyAccessorDescriptor, ResolvedCall<FunctionDescriptor>> DELEGATED_PROPERTY_RESOLVED_CALL = Slices.createSimpleSlice();
125 WritableSlice<PropertyAccessorDescriptor, Call> DELEGATED_PROPERTY_CALL = Slices.createSimpleSlice();
126
127 WritableSlice<PropertyDescriptor, ResolvedCall<FunctionDescriptor>> DELEGATED_PROPERTY_PD_RESOLVED_CALL = Slices.createSimpleSlice();
128
129 WritableSlice<JetMultiDeclarationEntry, ResolvedCall<FunctionDescriptor>> COMPONENT_RESOLVED_CALL = Slices.createSimpleSlice();
130
131 WritableSlice<JetExpression, ResolvedCall<FunctionDescriptor>> INDEXED_LVALUE_GET = Slices.createSimpleSlice();
132 WritableSlice<JetExpression, ResolvedCall<FunctionDescriptor>> INDEXED_LVALUE_SET = Slices.createSimpleSlice();
133
134 WritableSlice<JetExpression, JetType> SMARTCAST = Slices.createSimpleSlice();
135
136 WritableSlice<JetWhenExpression, Boolean> EXHAUSTIVE_WHEN = Slices.createSimpleSlice();
137
138 /**
139 * A scope where type of expression has been resolved
140 */
141 WritableSlice<JetTypeReference, JetScope> TYPE_RESOLUTION_SCOPE = Slices.createSimpleSlice();
142 WritableSlice<JetExpression, JetScope> RESOLUTION_SCOPE = Slices.createSimpleSlice();
143
144 WritableSlice<ScriptDescriptor, JetScope> SCRIPT_SCOPE = Slices.createSimpleSlice();
145
146 WritableSlice<JetExpression, Boolean> VARIABLE_REASSIGNMENT = Slices.createSimpleSetSlice();
147 WritableSlice<ValueParameterDescriptor, Boolean> AUTO_CREATED_IT = Slices.createSimpleSetSlice();
148
149 /**
150 * Has type of current expression has been already resolved
151 */
152 WritableSlice<JetExpression, Boolean> PROCESSED = Slices.createSimpleSetSlice();
153 WritableSlice<JetElement, Boolean> USED_AS_EXPRESSION = Slices.createRemovableSetSlice();
154 WritableSlice<JetElement, Boolean> UNREACHABLE_CODE = Slices.createRemovableSetSlice();
155
156 WritableSlice<VariableDescriptor, CaptureKind> CAPTURED_IN_CLOSURE = new BasicWritableSlice<VariableDescriptor, CaptureKind>(DO_NOTHING);
157
158 WritableSlice<CallableMemberDescriptor, Boolean> NEED_SYNTHETIC_ACCESSOR = new BasicWritableSlice<CallableMemberDescriptor, Boolean>(DO_NOTHING);
159
160 WritableSlice<Box<DeferredType>, Boolean> DEFERRED_TYPE = Slices.createCollectiveSetSlice();
161
162 WritableSlice<PropertyDescriptor, Boolean> BACKING_FIELD_REQUIRED = new Slices.SetSlice<PropertyDescriptor>(DO_NOTHING) {
163 @Override
164 public Boolean computeValue(
165 SlicedMap map,
166 PropertyDescriptor propertyDescriptor,
167 Boolean backingFieldRequired,
168 boolean valueNotFound
169 ) {
170 if (propertyDescriptor.getKind() != CallableMemberDescriptor.Kind.DECLARATION) {
171 return false;
172 }
173 backingFieldRequired = valueNotFound ? false : backingFieldRequired;
174 PsiElement declarationPsiElement = DescriptorToSourceUtils.descriptorToDeclaration(propertyDescriptor);
175 if (declarationPsiElement instanceof JetParameter) {
176 JetParameter jetParameter = (JetParameter) declarationPsiElement;
177 return jetParameter.hasValOrVarNode() ||
178 backingFieldRequired; // this part is unused because we do not allow access to constructor parameters in member bodies
179 }
180 if (propertyDescriptor.getModality() == Modality.ABSTRACT) return false;
181 PropertyGetterDescriptor getter = propertyDescriptor.getGetter();
182 PropertySetterDescriptor setter = propertyDescriptor.getSetter();
183
184 if (getter == null) return true;
185 if (propertyDescriptor.isVar() && setter == null) return true;
186 if (setter != null && !setter.hasBody() && setter.getModality() != Modality.ABSTRACT) return true;
187 if (!getter.hasBody() && getter.getModality() != Modality.ABSTRACT) return true;
188
189 return backingFieldRequired;
190 }
191 };
192 WritableSlice<PropertyDescriptor, Boolean> IS_UNINITIALIZED = Slices.createSimpleSetSlice();
193
194 WritableSlice<JetFunctionLiteralExpression, Boolean> BLOCK = new Slices.SetSlice<JetFunctionLiteralExpression>(DO_NOTHING) {
195 @Override
196 public Boolean computeValue(SlicedMap map, JetFunctionLiteralExpression expression, Boolean isBlock, boolean valueNotFound) {
197 isBlock = valueNotFound ? false : isBlock;
198 assert isBlock != null;
199 return isBlock && !expression.getFunctionLiteral().hasParameterSpecification();
200 }
201 };
202
203 WritableSlice<PsiElement, ClassDescriptor> CLASS = Slices.<PsiElement, ClassDescriptor>sliceBuilder().build();
204 WritableSlice<PsiElement, ScriptDescriptor> SCRIPT = Slices.<PsiElement, ScriptDescriptor>sliceBuilder().build();
205 WritableSlice<JetTypeParameter, TypeParameterDescriptor> TYPE_PARAMETER =
206 Slices.<JetTypeParameter, TypeParameterDescriptor>sliceBuilder().build();
207 /**
208 * @see BindingContextUtils#recordFunctionDeclarationToDescriptor(BindingTrace, PsiElement, SimpleFunctionDescriptor)}
209 */
210 WritableSlice<PsiElement, SimpleFunctionDescriptor> FUNCTION = Slices.<PsiElement, SimpleFunctionDescriptor>sliceBuilder().build();
211 WritableSlice<PsiElement, ConstructorDescriptor> CONSTRUCTOR = Slices.<PsiElement, ConstructorDescriptor>sliceBuilder().build();
212 WritableSlice<ConstructorDescriptor, ResolvedCall<ConstructorDescriptor>> CONSTRUCTOR_RESOLVED_DELEGATION_CALL =
213 Slices.<ConstructorDescriptor, ResolvedCall<ConstructorDescriptor>>sliceBuilder().build();
214 WritableSlice<PsiElement, VariableDescriptor> VARIABLE = Slices.<PsiElement, VariableDescriptor>sliceBuilder().build();
215 WritableSlice<JetParameter, VariableDescriptor> VALUE_PARAMETER = Slices.<JetParameter, VariableDescriptor>sliceBuilder().build();
216 WritableSlice<JetPropertyAccessor, PropertyAccessorDescriptor> PROPERTY_ACCESSOR =
217 Slices.<JetPropertyAccessor, PropertyAccessorDescriptor>sliceBuilder().build();
218 WritableSlice<PsiElement, PropertyDescriptor> PRIMARY_CONSTRUCTOR_PARAMETER =
219 Slices.<PsiElement, PropertyDescriptor>sliceBuilder().build();
220
221 WritableSlice[] DECLARATIONS_TO_DESCRIPTORS = new WritableSlice[] {
222 CLASS, TYPE_PARAMETER, FUNCTION, CONSTRUCTOR, VARIABLE, VALUE_PARAMETER, PROPERTY_ACCESSOR,
223 PRIMARY_CONSTRUCTOR_PARAMETER
224 };
225
226 ReadOnlySlice<PsiElement, DeclarationDescriptor> DECLARATION_TO_DESCRIPTOR = Slices.<PsiElement, DeclarationDescriptor>sliceBuilder()
227 .setFurtherLookupSlices(DECLARATIONS_TO_DESCRIPTORS).build();
228
229 WritableSlice<JetReferenceExpression, PsiElement> LABEL_TARGET = Slices.<JetReferenceExpression, PsiElement>sliceBuilder().build();
230 @KotlinSignature("val AMBIGUOUS_LABEL_TARGET: WritableSlice<JetReferenceExpression, Collection<PsiElement>>")
231 WritableSlice<JetReferenceExpression, Collection<? extends PsiElement>> AMBIGUOUS_LABEL_TARGET =
232 Slices.<JetReferenceExpression, Collection<? extends PsiElement>>sliceBuilder().build();
233 WritableSlice<ValueParameterDescriptor, PropertyDescriptor> VALUE_PARAMETER_AS_PROPERTY =
234 Slices.<ValueParameterDescriptor, PropertyDescriptor>sliceBuilder().build();
235
236 WritableSlice<ValueParameterDescriptor, FunctionDescriptor> DATA_CLASS_COMPONENT_FUNCTION =
237 Slices.<ValueParameterDescriptor, FunctionDescriptor>sliceBuilder().build();
238 WritableSlice<ClassDescriptor, FunctionDescriptor> DATA_CLASS_COPY_FUNCTION =
239 Slices.<ClassDescriptor, FunctionDescriptor>sliceBuilder().build();
240
241 WritableSlice<FqNameUnsafe, ClassDescriptor> FQNAME_TO_CLASS_DESCRIPTOR = new BasicWritableSlice<FqNameUnsafe, ClassDescriptor>(DO_NOTHING, true);
242 WritableSlice<JetFile, PackageFragmentDescriptor> FILE_TO_PACKAGE_FRAGMENT = Slices.createSimpleSlice();
243 WritableSlice<FqName, Collection<JetFile>> 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 JetType getType(@NotNull JetExpression expression);
267 }