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