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.util.Box;
044 import org.jetbrains.kotlin.util.slicedMap.*;
045
046 import java.util.Collection;
047 import java.util.Collections;
048
049 import static org.jetbrains.kotlin.util.slicedMap.RewritePolicy.DO_NOTHING;
050
051 public interface BindingContext {
052 BindingContext EMPTY = new BindingContext() {
053 @NotNull
054 @Override
055 public Diagnostics getDiagnostics() {
056 return Diagnostics.EMPTY;
057 }
058
059 @Override
060 public <K, V> V get(ReadOnlySlice<K, V> slice, K key) {
061 return null;
062 }
063
064 @NotNull
065 @Override
066 public <K, V> Collection<K> getKeys(WritableSlice<K, V> slice) {
067 return Collections.emptyList();
068 }
069
070 @NotNull
071 @TestOnly
072 @Override
073 public <K, V> ImmutableMap<K, V> getSliceContents(@NotNull ReadOnlySlice<K, V> slice) {
074 return ImmutableMap.of();
075 }
076 };
077
078 WritableSlice<AnnotationDescriptor, JetAnnotationEntry> ANNOTATION_DESCRIPTOR_TO_PSI_ELEMENT = Slices.createSimpleSlice();
079 WritableSlice<JetAnnotationEntry, AnnotationDescriptor> ANNOTATION =
080 Slices.<JetAnnotationEntry, AnnotationDescriptor>sliceBuilder().setOpposite(ANNOTATION_DESCRIPTOR_TO_PSI_ELEMENT).build();
081
082 WritableSlice<JetExpression, CompileTimeConstant<?>> COMPILE_TIME_VALUE = Slices.createSimpleSlice();
083
084 WritableSlice<JetTypeReference, JetType> TYPE = Slices.createSimpleSlice();
085 WritableSlice<JetExpression, JetType> EXPRESSION_TYPE = new BasicWritableSlice<JetExpression, JetType>(DO_NOTHING);
086 WritableSlice<JetExpression, JetType> EXPECTED_EXPRESSION_TYPE = new BasicWritableSlice<JetExpression, JetType>(DO_NOTHING);
087 WritableSlice<JetExpression, DataFlowInfo> EXPRESSION_DATA_FLOW_INFO = new BasicWritableSlice<JetExpression, DataFlowInfo>(DO_NOTHING);
088 WritableSlice<JetExpression, Approximation.Info> EXPRESSION_RESULT_APPROXIMATION = new BasicWritableSlice<JetExpression, Approximation.Info>(DO_NOTHING);
089 WritableSlice<JetExpression, DataFlowInfo> DATAFLOW_INFO_AFTER_CONDITION = Slices.createSimpleSlice();
090
091 /**
092 * A qualifier corresponds to a receiver expression (if any). For 'A.B' qualifier is recorded for 'A'.
093 */
094 WritableSlice<JetExpression, Qualifier> QUALIFIER = new BasicWritableSlice<JetExpression, Qualifier>(DO_NOTHING);
095
096 WritableSlice<JetReferenceExpression, DeclarationDescriptor> REFERENCE_TARGET =
097 new BasicWritableSlice<JetReferenceExpression, DeclarationDescriptor>(DO_NOTHING);
098
099 @KotlinSignature("val RESOLVED_CALL: WritableSlice<Call, ResolvedCall<out CallableDescriptor>>")
100 WritableSlice<Call, ResolvedCall<?>> RESOLVED_CALL = new BasicWritableSlice<Call, ResolvedCall<?>>(DO_NOTHING);
101 WritableSlice<ResolvedCall<?>, TailRecursionKind> TAIL_RECURSION_CALL = Slices.createSimpleSlice();
102 WritableSlice<JetElement, ConstraintSystemCompleter> CONSTRAINT_SYSTEM_COMPLETER = new BasicWritableSlice<JetElement, ConstraintSystemCompleter>(DO_NOTHING);
103 WritableSlice<JetElement, Call> CALL = new BasicWritableSlice<JetElement, Call>(DO_NOTHING);
104
105 @KotlinSignature("val AMBIGUOUS_REFERENCE_TARGET: WritableSlice<JetExpression, Collection<DeclarationDescriptor>>")
106 WritableSlice<JetExpression, Collection<? extends DeclarationDescriptor>> AMBIGUOUS_REFERENCE_TARGET =
107 new BasicWritableSlice<JetExpression, Collection<? extends DeclarationDescriptor>>(DO_NOTHING);
108
109 WritableSlice<JetExpression, DelegatingBindingTrace> TRACE_DELTAS_CACHE = Slices.createSimpleSlice();
110
111 WritableSlice<JetExpression, ResolvedCall<FunctionDescriptor>> LOOP_RANGE_ITERATOR_RESOLVED_CALL = Slices.createSimpleSlice();
112
113 WritableSlice<JetExpression, ResolvedCall<FunctionDescriptor>> LOOP_RANGE_HAS_NEXT_RESOLVED_CALL = Slices.createSimpleSlice();
114 WritableSlice<JetExpression, ResolvedCall<FunctionDescriptor>> LOOP_RANGE_NEXT_RESOLVED_CALL = Slices.createSimpleSlice();
115
116 WritableSlice<PropertyAccessorDescriptor, ResolvedCall<FunctionDescriptor>> DELEGATED_PROPERTY_RESOLVED_CALL = Slices.createSimpleSlice();
117 WritableSlice<PropertyAccessorDescriptor, Call> DELEGATED_PROPERTY_CALL = Slices.createSimpleSlice();
118
119 WritableSlice<PropertyDescriptor, ResolvedCall<FunctionDescriptor>> DELEGATED_PROPERTY_PD_RESOLVED_CALL = Slices.createSimpleSlice();
120
121 WritableSlice<JetMultiDeclarationEntry, ResolvedCall<FunctionDescriptor>> COMPONENT_RESOLVED_CALL = Slices.createSimpleSlice();
122
123 WritableSlice<JetExpression, ResolvedCall<FunctionDescriptor>> INDEXED_LVALUE_GET = Slices.createSimpleSlice();
124 WritableSlice<JetExpression, ResolvedCall<FunctionDescriptor>> INDEXED_LVALUE_SET = Slices.createSimpleSlice();
125
126 WritableSlice<JetExpression, JetType> SMARTCAST = Slices.createSimpleSlice();
127
128 WritableSlice<JetWhenExpression, Boolean> EXHAUSTIVE_WHEN = Slices.createSimpleSlice();
129
130 /**
131 * A scope where type of expression has been resolved
132 */
133 WritableSlice<JetTypeReference, JetScope> TYPE_RESOLUTION_SCOPE = Slices.createSimpleSlice();
134 WritableSlice<JetExpression, JetScope> RESOLUTION_SCOPE = Slices.createSimpleSlice();
135
136 WritableSlice<ScriptDescriptor, JetScope> SCRIPT_SCOPE = Slices.createSimpleSlice();
137
138 WritableSlice<JetExpression, Boolean> VARIABLE_REASSIGNMENT = Slices.createSimpleSetSlice();
139 WritableSlice<ValueParameterDescriptor, Boolean> AUTO_CREATED_IT = Slices.createSimpleSetSlice();
140
141 /**
142 * Has type of current expression has been already resolved
143 */
144 WritableSlice<JetExpression, Boolean> PROCESSED = Slices.createSimpleSetSlice();
145 WritableSlice<JetElement, Boolean> USED_AS_EXPRESSION = Slices.createRemovableSetSlice();
146 WritableSlice<JetElement, Boolean> UNREACHABLE_CODE = Slices.createRemovableSetSlice();
147
148 WritableSlice<VariableDescriptor, CaptureKind> CAPTURED_IN_CLOSURE = new BasicWritableSlice<VariableDescriptor, CaptureKind>(DO_NOTHING);
149
150 WritableSlice<CallableMemberDescriptor, Boolean> NEED_SYNTHETIC_ACCESSOR = new BasicWritableSlice<CallableMemberDescriptor, Boolean>(DO_NOTHING);
151
152 WritableSlice<Box<DeferredType>, Boolean> DEFERRED_TYPE = Slices.createCollectiveSetSlice();
153
154 WritableSlice<PropertyDescriptor, Boolean> BACKING_FIELD_REQUIRED = new Slices.SetSlice<PropertyDescriptor>(DO_NOTHING) {
155 @Override
156 public Boolean computeValue(
157 SlicedMap map,
158 PropertyDescriptor propertyDescriptor,
159 Boolean backingFieldRequired,
160 boolean valueNotFound
161 ) {
162 if (propertyDescriptor.getKind() != CallableMemberDescriptor.Kind.DECLARATION) {
163 return false;
164 }
165 backingFieldRequired = valueNotFound ? false : backingFieldRequired;
166 PsiElement declarationPsiElement = DescriptorToSourceUtils.descriptorToDeclaration(propertyDescriptor);
167 if (declarationPsiElement instanceof JetParameter) {
168 JetParameter jetParameter = (JetParameter) declarationPsiElement;
169 return jetParameter.hasValOrVarNode() ||
170 backingFieldRequired; // this part is unused because we do not allow access to constructor parameters in member bodies
171 }
172 if (propertyDescriptor.getModality() == Modality.ABSTRACT) return false;
173 PropertyGetterDescriptor getter = propertyDescriptor.getGetter();
174 PropertySetterDescriptor setter = propertyDescriptor.getSetter();
175
176 if (getter == null) return true;
177 if (propertyDescriptor.isVar() && setter == null) return true;
178 if (setter != null && !setter.hasBody() && setter.getModality() != Modality.ABSTRACT) return true;
179 if (!getter.hasBody() && getter.getModality() != Modality.ABSTRACT) return true;
180
181 return backingFieldRequired;
182 }
183 };
184 WritableSlice<PropertyDescriptor, Boolean> IS_INITIALIZED = Slices.createSimpleSetSlice();
185
186 WritableSlice<JetFunctionLiteralExpression, Boolean> BLOCK = new Slices.SetSlice<JetFunctionLiteralExpression>(DO_NOTHING) {
187 @Override
188 public Boolean computeValue(SlicedMap map, JetFunctionLiteralExpression expression, Boolean isBlock, boolean valueNotFound) {
189 isBlock = valueNotFound ? false : isBlock;
190 assert isBlock != null;
191 return isBlock && !expression.getFunctionLiteral().hasParameterSpecification();
192 }
193 };
194
195 WritableSlice<PsiElement, ClassDescriptor> CLASS = Slices.<PsiElement, ClassDescriptor>sliceBuilder().build();
196 WritableSlice<PsiElement, ScriptDescriptor> SCRIPT = Slices.<PsiElement, ScriptDescriptor>sliceBuilder().build();
197 WritableSlice<JetTypeParameter, TypeParameterDescriptor> TYPE_PARAMETER =
198 Slices.<JetTypeParameter, TypeParameterDescriptor>sliceBuilder().build();
199 /**
200 * @see BindingContextUtils#recordFunctionDeclarationToDescriptor(BindingTrace, PsiElement, SimpleFunctionDescriptor)}
201 */
202 WritableSlice<PsiElement, SimpleFunctionDescriptor> FUNCTION = Slices.<PsiElement, SimpleFunctionDescriptor>sliceBuilder().build();
203 WritableSlice<PsiElement, ConstructorDescriptor> CONSTRUCTOR = Slices.<PsiElement, ConstructorDescriptor>sliceBuilder().build();
204 WritableSlice<PsiElement, VariableDescriptor> VARIABLE = Slices.<PsiElement, VariableDescriptor>sliceBuilder().build();
205 WritableSlice<JetParameter, VariableDescriptor> VALUE_PARAMETER = Slices.<JetParameter, VariableDescriptor>sliceBuilder().build();
206 WritableSlice<JetPropertyAccessor, PropertyAccessorDescriptor> PROPERTY_ACCESSOR =
207 Slices.<JetPropertyAccessor, PropertyAccessorDescriptor>sliceBuilder().build();
208 WritableSlice<PsiElement, PropertyDescriptor> PRIMARY_CONSTRUCTOR_PARAMETER =
209 Slices.<PsiElement, PropertyDescriptor>sliceBuilder().build();
210
211 WritableSlice[] DECLARATIONS_TO_DESCRIPTORS = new WritableSlice[] {
212 CLASS, TYPE_PARAMETER, FUNCTION, CONSTRUCTOR, VARIABLE, VALUE_PARAMETER, PROPERTY_ACCESSOR,
213 PRIMARY_CONSTRUCTOR_PARAMETER
214 };
215
216 ReadOnlySlice<PsiElement, DeclarationDescriptor> DECLARATION_TO_DESCRIPTOR = Slices.<PsiElement, DeclarationDescriptor>sliceBuilder()
217 .setFurtherLookupSlices(DECLARATIONS_TO_DESCRIPTORS).build();
218
219 WritableSlice<JetReferenceExpression, PsiElement> LABEL_TARGET = Slices.<JetReferenceExpression, PsiElement>sliceBuilder().build();
220 @KotlinSignature("val AMBIGUOUS_LABEL_TARGET: WritableSlice<JetReferenceExpression, Collection<PsiElement>>")
221 WritableSlice<JetReferenceExpression, Collection<? extends PsiElement>> AMBIGUOUS_LABEL_TARGET =
222 Slices.<JetReferenceExpression, Collection<? extends PsiElement>>sliceBuilder().build();
223 WritableSlice<ValueParameterDescriptor, PropertyDescriptor> VALUE_PARAMETER_AS_PROPERTY =
224 Slices.<ValueParameterDescriptor, PropertyDescriptor>sliceBuilder().build();
225
226 WritableSlice<ValueParameterDescriptor, FunctionDescriptor> DATA_CLASS_COMPONENT_FUNCTION =
227 Slices.<ValueParameterDescriptor, FunctionDescriptor>sliceBuilder().build();
228 WritableSlice<ClassDescriptor, FunctionDescriptor> DATA_CLASS_COPY_FUNCTION =
229 Slices.<ClassDescriptor, FunctionDescriptor>sliceBuilder().build();
230
231 WritableSlice<FqNameUnsafe, ClassDescriptor> FQNAME_TO_CLASS_DESCRIPTOR = new BasicWritableSlice<FqNameUnsafe, ClassDescriptor>(DO_NOTHING, true);
232 WritableSlice<JetFile, PackageFragmentDescriptor> FILE_TO_PACKAGE_FRAGMENT = Slices.createSimpleSlice();
233 WritableSlice<FqName, Collection<JetFile>> PACKAGE_TO_FILES = Slices.createSimpleSlice();
234
235 WritableSlice<ClassDescriptor, Boolean> INCOMPLETE_HIERARCHY = Slices.createCollectiveSetSlice();
236
237 @SuppressWarnings("UnusedDeclaration")
238 @Deprecated // This field is needed only for the side effects of its initializer
239 Void _static_initializer = BasicWritableSlice.initSliceDebugNames(BindingContext.class);
240
241 @NotNull
242 Diagnostics getDiagnostics();
243
244 @Nullable
245 <K, V> V get(ReadOnlySlice<K, V> slice, K key);
246
247 // slice.isCollective() must be true
248 @NotNull
249 @ReadOnly
250 <K, V> Collection<K> getKeys(WritableSlice<K, V> slice);
251
252 /** This method should be used only for debug and testing */
253 @TestOnly
254 @NotNull
255 <K, V> ImmutableMap<K, V> getSliceContents(@NotNull ReadOnlySlice<K, V> slice);
256 }