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.descriptors.impl;
018
019 import com.google.common.collect.Lists;
020 import com.google.common.collect.Sets;
021 import org.jetbrains.annotations.NotNull;
022 import org.jetbrains.annotations.Nullable;
023 import org.jetbrains.jet.lang.descriptors.*;
024 import org.jetbrains.jet.lang.descriptors.annotations.Annotations;
025 import org.jetbrains.jet.lang.resolve.DescriptorFactory;
026 import org.jetbrains.jet.lang.resolve.OverridingUtil;
027 import org.jetbrains.jet.lang.resolve.name.Name;
028 import org.jetbrains.jet.lang.types.DescriptorSubstitutor;
029 import org.jetbrains.jet.lang.types.JetType;
030 import org.jetbrains.jet.lang.types.TypeSubstitutor;
031 import org.jetbrains.jet.lang.types.Variance;
032
033 import java.util.ArrayList;
034 import java.util.List;
035 import java.util.Set;
036
037 public abstract class FunctionDescriptorImpl extends DeclarationDescriptorNonRootImpl implements FunctionDescriptor {
038
039 protected List<TypeParameterDescriptor> typeParameters;
040 protected List<ValueParameterDescriptor> unsubstitutedValueParameters;
041 protected JetType unsubstitutedReturnType;
042 private ReceiverParameterDescriptor receiverParameter;
043 protected ReceiverParameterDescriptor expectedThisObject;
044
045 protected Modality modality;
046 protected Visibility visibility;
047 protected final Set<FunctionDescriptor> overriddenFunctions = Sets.newLinkedHashSet(); // LinkedHashSet is essential here
048 private final FunctionDescriptor original;
049 private final Kind kind;
050
051 protected FunctionDescriptorImpl(
052 @NotNull DeclarationDescriptor containingDeclaration,
053 @Nullable FunctionDescriptor original,
054 @NotNull Annotations annotations,
055 @NotNull Name name,
056 @NotNull Kind kind) {
057 super(containingDeclaration, annotations, name);
058 this.original = original == null ? this : original;
059 this.kind = kind;
060 }
061
062 @NotNull
063 public FunctionDescriptorImpl initialize(
064 @Nullable JetType receiverParameterType,
065 @Nullable ReceiverParameterDescriptor expectedThisObject,
066 @NotNull List<? extends TypeParameterDescriptor> typeParameters,
067 @NotNull List<ValueParameterDescriptor> unsubstitutedValueParameters,
068 @Nullable JetType unsubstitutedReturnType,
069 @Nullable Modality modality,
070 @NotNull Visibility visibility) {
071 this.typeParameters = Lists.newArrayList(typeParameters);
072 this.unsubstitutedValueParameters = unsubstitutedValueParameters;
073 this.unsubstitutedReturnType = unsubstitutedReturnType;
074 this.modality = modality;
075 this.visibility = visibility;
076 this.receiverParameter = DescriptorFactory.createReceiverParameterForCallable(this, receiverParameterType);
077 this.expectedThisObject = expectedThisObject;
078
079 for (int i = 0; i < typeParameters.size(); ++i) {
080 TypeParameterDescriptor typeParameterDescriptor = typeParameters.get(i);
081 if (typeParameterDescriptor.getIndex() != i) {
082 throw new IllegalStateException(typeParameterDescriptor + " index is " + typeParameterDescriptor.getIndex() + " but position is " + i);
083 }
084 }
085
086 for (int i = 0; i < unsubstitutedValueParameters.size(); ++i) {
087 // TODO fill me
088 int firstValueParameterOffset = 0; // receiverParameter.exists() ? 1 : 0;
089 ValueParameterDescriptor valueParameterDescriptor = unsubstitutedValueParameters.get(i);
090 if (valueParameterDescriptor.getIndex() != i + firstValueParameterOffset) {
091 throw new IllegalStateException(valueParameterDescriptor + "index is " + valueParameterDescriptor.getIndex() + " but position is " + i);
092 }
093 }
094
095 return this;
096 }
097
098 public void setVisibility(@NotNull Visibility visibility) {
099 this.visibility = visibility;
100 }
101
102 public void setReturnType(@NotNull JetType unsubstitutedReturnType) {
103 if (this.unsubstitutedReturnType != null) {
104 // TODO: uncomment and fix tests
105 //throw new IllegalStateException("returnType already set");
106 }
107 this.unsubstitutedReturnType = unsubstitutedReturnType;
108 }
109
110 @Nullable
111 @Override
112 public ReceiverParameterDescriptor getReceiverParameter() {
113 return receiverParameter;
114 }
115
116 @Nullable
117 @Override
118 public ReceiverParameterDescriptor getExpectedThisObject() {
119 return expectedThisObject;
120 }
121
122 @NotNull
123 @Override
124 public Set<? extends FunctionDescriptor> getOverriddenDescriptors() {
125 return overriddenFunctions;
126 }
127
128 @NotNull
129 @Override
130 public Modality getModality() {
131 return modality;
132 }
133
134 @NotNull
135 @Override
136 public Visibility getVisibility() {
137 return visibility;
138 }
139
140 @Override
141 public void addOverriddenDescriptor(@NotNull CallableMemberDescriptor overriddenFunction) {
142 overriddenFunctions.add((FunctionDescriptor) overriddenFunction);
143 }
144
145 @Override
146 @NotNull
147 public List<TypeParameterDescriptor> getTypeParameters() {
148 return typeParameters;
149 }
150
151 @Override
152 @NotNull
153 public List<ValueParameterDescriptor> getValueParameters() {
154 return unsubstitutedValueParameters;
155 }
156
157 @Override
158 public boolean hasStableParameterNames() {
159 return true;
160 }
161
162 @Override
163 public boolean hasSynthesizedParameterNames() {
164 return false;
165 }
166
167 @Override
168 public JetType getReturnType() {
169 return unsubstitutedReturnType;
170 }
171
172 @NotNull
173 @Override
174 public FunctionDescriptor getOriginal() {
175 return original == this ? this : original.getOriginal();
176 }
177
178 @NotNull
179 @Override
180 public Kind getKind() {
181 return kind;
182 }
183
184 @Override
185 public final FunctionDescriptor substitute(@NotNull TypeSubstitutor originalSubstitutor) {
186 if (originalSubstitutor.isEmpty()) {
187 return this;
188 }
189 return doSubstitute(originalSubstitutor, getContainingDeclaration(), modality, visibility, getOriginal(), true, getKind());
190 }
191
192 @Nullable
193 protected FunctionDescriptor doSubstitute(@NotNull TypeSubstitutor originalSubstitutor,
194 @NotNull DeclarationDescriptor newOwner,
195 @NotNull Modality newModality,
196 @NotNull Visibility newVisibility,
197 @Nullable FunctionDescriptor original,
198 boolean copyOverrides,
199 @NotNull Kind kind
200 ) {
201 FunctionDescriptorImpl substitutedDescriptor = createSubstitutedCopy(newOwner, original, kind);
202
203 List<TypeParameterDescriptor> substitutedTypeParameters = Lists.newArrayList();
204 TypeSubstitutor substitutor = DescriptorSubstitutor.substituteTypeParameters(getTypeParameters(), originalSubstitutor, substitutedDescriptor, substitutedTypeParameters);
205
206 JetType substitutedReceiverParameterType = null;
207 if (receiverParameter != null) {
208 substitutedReceiverParameterType = substitutor.substitute(getReceiverParameter().getType(), Variance.IN_VARIANCE);
209 if (substitutedReceiverParameterType == null) {
210 return null;
211 }
212 }
213
214 ReceiverParameterDescriptor substitutedExpectedThis = null;
215 if (expectedThisObject != null) {
216 substitutedExpectedThis = expectedThisObject.substitute(substitutor);
217 if (substitutedExpectedThis == null) {
218 return null;
219 }
220 }
221
222 List<ValueParameterDescriptor> substitutedValueParameters = getSubstitutedValueParameters(substitutedDescriptor, this, substitutor);
223 if (substitutedValueParameters == null) {
224 return null;
225 }
226
227 JetType substitutedReturnType = substitutor.substitute(getReturnType(), Variance.OUT_VARIANCE);
228 if (substitutedReturnType == null) {
229 return null;
230 }
231
232 substitutedDescriptor.initialize(
233 substitutedReceiverParameterType,
234 substitutedExpectedThis,
235 substitutedTypeParameters,
236 substitutedValueParameters,
237 substitutedReturnType,
238 newModality,
239 newVisibility
240 );
241 if (copyOverrides) {
242 for (FunctionDescriptor overriddenFunction : overriddenFunctions) {
243 OverridingUtil.bindOverride(substitutedDescriptor, overriddenFunction.substitute(substitutor));
244 }
245 }
246 return substitutedDescriptor;
247 }
248
249 @NotNull
250 protected abstract FunctionDescriptorImpl createSubstitutedCopy(
251 @NotNull DeclarationDescriptor newOwner,
252 @Nullable FunctionDescriptor original,
253 @NotNull Kind kind
254 );
255
256 @Override
257 public <R, D> R accept(DeclarationDescriptorVisitor<R, D> visitor, D data) {
258 return visitor.visitFunctionDescriptor(this, data);
259 }
260
261 @Nullable
262 public static List<ValueParameterDescriptor> getSubstitutedValueParameters(FunctionDescriptor substitutedDescriptor, @NotNull FunctionDescriptor functionDescriptor, @NotNull TypeSubstitutor substitutor) {
263 List<ValueParameterDescriptor> result = new ArrayList<ValueParameterDescriptor>();
264 List<ValueParameterDescriptor> unsubstitutedValueParameters = functionDescriptor.getValueParameters();
265 for (ValueParameterDescriptor unsubstitutedValueParameter : unsubstitutedValueParameters) {
266 // TODO : Lazy?
267 JetType substitutedType = substitutor.substitute(unsubstitutedValueParameter.getType(), Variance.IN_VARIANCE);
268 JetType varargElementType = unsubstitutedValueParameter.getVarargElementType();
269 JetType substituteVarargElementType = varargElementType == null ? null : substitutor.substitute(varargElementType, Variance.IN_VARIANCE);
270 if (substitutedType == null) return null;
271 result.add(new ValueParameterDescriptorImpl(
272 substitutedDescriptor,
273 unsubstitutedValueParameter,
274 unsubstitutedValueParameter.getIndex(),
275 unsubstitutedValueParameter.getAnnotations(),
276 unsubstitutedValueParameter.getName(),
277 substitutedType,
278 unsubstitutedValueParameter.declaresDefaultValue(),
279 substituteVarargElementType)
280 );
281 }
282 return result;
283 }
284 }