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.java.resolver;
018
019 import kotlin.Function1;
020 import kotlin.Unit;
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.impl.TypeParameterDescriptorImpl;
025 import org.jetbrains.jet.lang.resolve.OverridingUtil;
026 import org.jetbrains.jet.lang.resolve.java.sam.SingleAbstractMethodUtils;
027 import org.jetbrains.jet.lang.resolve.java.structure.*;
028 import org.jetbrains.jet.lang.resolve.name.FqName;
029 import org.jetbrains.jet.lang.resolve.name.Name;
030 import org.jetbrains.jet.lang.resolve.scopes.JetScope;
031 import org.jetbrains.jet.lang.types.TypeConstructor;
032 import org.jetbrains.jet.lang.types.TypeProjection;
033 import org.jetbrains.jet.lang.types.TypeProjectionImpl;
034 import org.jetbrains.jet.lang.types.TypeSubstitutor;
035 import org.jetbrains.jet.lang.types.lang.KotlinBuiltIns;
036
037 import java.util.*;
038
039 public final class DescriptorResolverUtils {
040 private DescriptorResolverUtils() {
041 }
042
043 @NotNull
044 public static <D extends CallableMemberDescriptor> Collection<D> resolveOverrides(
045 @NotNull Name name,
046 @NotNull Collection<D> membersFromSupertypes,
047 @NotNull Collection<D> membersFromCurrent,
048 @NotNull ClassDescriptor classDescriptor,
049 @NotNull final ErrorReporter errorReporter
050 ) {
051 final Set<D> result = new HashSet<D>();
052
053 OverridingUtil.generateOverridesInFunctionGroup(
054 name, membersFromSupertypes, membersFromCurrent, classDescriptor,
055 new OverridingUtil.DescriptorSink() {
056 @Override
057 @SuppressWarnings("unchecked")
058 public void addToScope(@NotNull CallableMemberDescriptor fakeOverride) {
059 OverridingUtil.resolveUnknownVisibilityForMember(fakeOverride, new Function1<CallableMemberDescriptor, Unit>() {
060 @Override
061 public Unit invoke(@NotNull CallableMemberDescriptor descriptor) {
062 errorReporter.reportCannotInferVisibility(descriptor);
063 return Unit.INSTANCE$;
064 }
065 });
066 result.add((D) fakeOverride);
067 }
068
069 @Override
070 public void conflict(@NotNull CallableMemberDescriptor fromSuper, @NotNull CallableMemberDescriptor fromCurrent) {
071 // nop
072 }
073 }
074 );
075
076 return result;
077 }
078
079 @Nullable
080 public static ValueParameterDescriptor getAnnotationParameterByName(@NotNull Name name, @NotNull ClassDescriptor annotationClass) {
081 Collection<ConstructorDescriptor> constructors = annotationClass.getConstructors();
082 assert constructors.size() == 1 : "Annotation class descriptor must have only one constructor";
083
084 for (ValueParameterDescriptor parameter : constructors.iterator().next().getValueParameters()) {
085 if (parameter.getName().equals(name)) {
086 return parameter;
087 }
088 }
089
090 return null;
091 }
092
093 /**
094 * @return true if {@code method} is a static method of enum class, which is to be put into its class object (and not into the
095 * corresponding package). This applies to values() and valueOf(String) methods
096 */
097 public static boolean shouldBeInEnumClassObject(@NotNull JavaMethod method) {
098 if (!method.getContainingClass().isEnum()) return false;
099
100 String name = method.getName().asString();
101 if (name.equals("values")) {
102 return method.getValueParameters().isEmpty();
103 }
104 else if (name.equals("valueOf")) {
105 return isMethodWithOneParameterWithFqName(method, "java.lang.String");
106 }
107 return false;
108 }
109
110 public static boolean isObjectMethodInInterface(@NotNull JavaMember member) {
111 return member.getContainingClass().isInterface() && member instanceof JavaMethod && isObjectMethod((JavaMethod) member);
112 }
113
114 public static boolean isObjectMethod(@NotNull JavaMethod method) {
115 String name = method.getName().asString();
116 if (name.equals("toString") || name.equals("hashCode")) {
117 return method.getValueParameters().isEmpty();
118 }
119 else if (name.equals("equals")) {
120 return isMethodWithOneParameterWithFqName(method, "java.lang.Object");
121 }
122 return false;
123 }
124
125 private static boolean isMethodWithOneParameterWithFqName(@NotNull JavaMethod method, @NotNull String fqName) {
126 List<JavaValueParameter> parameters = method.getValueParameters();
127 if (parameters.size() == 1) {
128 JavaType type = parameters.get(0).getType();
129 if (type instanceof JavaClassifierType) {
130 JavaClassifier classifier = ((JavaClassifierType) type).getClassifier();
131 if (classifier instanceof JavaClass) {
132 FqName classFqName = ((JavaClass) classifier).getFqName();
133 return classFqName != null && classFqName.asString().equals(fqName);
134 }
135 }
136 }
137 return false;
138 }
139
140 @NotNull
141 public static Collection<JavaClass> getClassesInPackage(@NotNull JavaPackage javaPackage) {
142 Collection<JavaClass> classes = javaPackage.getClasses();
143 Set<FqName> addedQualifiedNames = new HashSet<FqName>(classes.size());
144 List<JavaClass> result = new ArrayList<JavaClass>(classes.size());
145
146 for (JavaClass javaClass : classes) {
147 FqName fqName = javaClass.getFqName();
148 if (fqName != null && addedQualifiedNames.add(fqName)) {
149 result.add(javaClass);
150 }
151 }
152
153 return result;
154 }
155
156 /**
157 * @see com.intellij.psi.util.TypeConversionUtil#erasure(com.intellij.psi.PsiType)
158 */
159 @Nullable
160 public static JavaType erasure(@NotNull JavaType type) {
161 return erasure(type, JavaTypeSubstitutor.EMPTY);
162 }
163
164 /**
165 * @see com.intellij.psi.util.TypeConversionUtil#erasure(com.intellij.psi.PsiType, com.intellij.psi.PsiSubstitutor)
166 */
167 @Nullable
168 public static JavaType erasure(@NotNull JavaType type, @NotNull JavaTypeSubstitutor substitutor) {
169 if (type instanceof JavaClassifierType) {
170 JavaClassifier classifier = ((JavaClassifierType) type).getClassifier();
171 if (classifier instanceof JavaClass) {
172 return ((JavaClass) classifier).getDefaultType();
173 }
174 else if (classifier instanceof JavaTypeParameter) {
175 JavaTypeParameter typeParameter = (JavaTypeParameter) classifier;
176 return typeParameterErasure(typeParameter, new HashSet<JavaTypeParameter>(), substitutor);
177 }
178 else {
179 return null;
180 }
181 }
182 else if (type instanceof JavaPrimitiveType) {
183 return type;
184 }
185 else if (type instanceof JavaArrayType) {
186 JavaType erasure = erasure(((JavaArrayType) type).getComponentType(), substitutor);
187 return erasure == null ? null : erasure.createArrayType();
188 }
189 else if (type instanceof JavaWildcardType) {
190 JavaWildcardType wildcardType = (JavaWildcardType) type;
191 JavaType bound = wildcardType.getBound();
192 if (bound != null && wildcardType.isExtends()) {
193 return erasure(bound, substitutor);
194 }
195 return wildcardType.getTypeProvider().createJavaLangObjectType();
196 }
197 else {
198 throw new IllegalStateException("Unsupported type: " + type);
199 }
200 }
201
202 /**
203 * @see com.intellij.psi.util.TypeConversionUtil#typeParameterErasure(com.intellij.psi.PsiTypeParameter)
204 */
205 @Nullable
206 private static JavaType typeParameterErasure(
207 @NotNull JavaTypeParameter typeParameter,
208 @NotNull HashSet<JavaTypeParameter> visited,
209 @NotNull JavaTypeSubstitutor substitutor
210 ) {
211 Collection<JavaClassifierType> upperBounds = typeParameter.getUpperBounds();
212 if (!upperBounds.isEmpty()) {
213 JavaClassifier classifier = upperBounds.iterator().next().getClassifier();
214 if (classifier instanceof JavaTypeParameter && !visited.contains(classifier)) {
215 JavaTypeParameter typeParameterBound = (JavaTypeParameter) classifier;
216 visited.add(typeParameterBound);
217 JavaType substitutedType = substitutor.substitute(typeParameterBound);
218 if (substitutedType != null) {
219 return erasure(substitutedType);
220 }
221 return typeParameterErasure(typeParameterBound, visited, substitutor);
222 }
223 else if (classifier instanceof JavaClass) {
224 return ((JavaClass) classifier).getDefaultType();
225 }
226 }
227 return typeParameter.getTypeProvider().createJavaLangObjectType();
228 }
229
230 @NotNull
231 public static Map<TypeParameterDescriptor, TypeParameterDescriptorImpl> recreateTypeParametersAndReturnMapping(
232 @NotNull List<TypeParameterDescriptor> originalParameters,
233 @Nullable DeclarationDescriptor newOwner
234 ) {
235 // LinkedHashMap to save the order of type parameters
236 Map<TypeParameterDescriptor, TypeParameterDescriptorImpl> result =
237 new LinkedHashMap<TypeParameterDescriptor, TypeParameterDescriptorImpl>();
238 for (TypeParameterDescriptor typeParameter : originalParameters) {
239 result.put(typeParameter,
240 TypeParameterDescriptorImpl.createForFurtherModification(
241 newOwner == null ? typeParameter.getContainingDeclaration() : newOwner,
242 typeParameter.getAnnotations(),
243 typeParameter.isReified(),
244 typeParameter.getVariance(),
245 typeParameter.getName(),
246 typeParameter.getIndex(),
247 SourceElement.NO_SOURCE)
248 );
249 }
250 return result;
251 }
252
253 @NotNull
254 public static TypeSubstitutor createSubstitutorForTypeParameters(
255 @NotNull Map<TypeParameterDescriptor, TypeParameterDescriptorImpl> originalToAltTypeParameters
256 ) {
257 Map<TypeConstructor, TypeProjection> typeSubstitutionContext = new HashMap<TypeConstructor, TypeProjection>();
258 for (Map.Entry<TypeParameterDescriptor, TypeParameterDescriptorImpl> originalToAltTypeParameter : originalToAltTypeParameters
259 .entrySet()) {
260 typeSubstitutionContext.put(originalToAltTypeParameter.getKey().getTypeConstructor(),
261 new TypeProjectionImpl(originalToAltTypeParameter.getValue().getDefaultType()));
262 }
263 return TypeSubstitutor.create(typeSubstitutionContext);
264 }
265
266 public static boolean hasStaticMembers(@NotNull JavaClass javaClass) {
267 for (JavaMethod method : javaClass.getMethods()) {
268 if (method.isStatic() && !shouldBeInEnumClassObject(method)) {
269 return true;
270 }
271 }
272
273 for (JavaField field : javaClass.getFields()) {
274 if (field.isStatic() && !field.isEnumEntry()) {
275 return true;
276 }
277 }
278
279 for (JavaClass nestedClass : javaClass.getInnerClasses()) {
280 if (SingleAbstractMethodUtils.isSamInterface(nestedClass)) {
281 return true;
282 }
283 if (nestedClass.isStatic() && hasStaticMembers(nestedClass)) {
284 return true;
285 }
286 }
287
288 return false;
289 }
290
291 @Nullable
292 public static ClassDescriptor getKotlinBuiltinClassDescriptor(@NotNull FqName qualifiedName) {
293 if (!qualifiedName.firstSegmentIs(KotlinBuiltIns.BUILT_INS_PACKAGE_NAME)) return null;
294
295 List<Name> segments = qualifiedName.pathSegments();
296 if (segments.size() < 2) return null;
297
298 JetScope scope = KotlinBuiltIns.getInstance().getBuiltInsPackageScope();
299 for (int i = 1, size = segments.size(); i < size; i++) {
300 ClassifierDescriptor classifier = scope.getClassifier(segments.get(i));
301 if (classifier == null) return null;
302 assert classifier instanceof ClassDescriptor : "Unexpected classifier in built-ins: " + classifier;
303 scope = ((ClassDescriptor) classifier).getUnsubstitutedInnerClassesScope();
304 }
305
306 return (ClassDescriptor) scope.getContainingDeclaration();
307 }
308 }