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