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 org.jetbrains.annotations.NotNull;
020 import org.jetbrains.annotations.Nullable;
021 import org.jetbrains.jet.lang.descriptors.*;
022 import org.jetbrains.jet.lang.descriptors.impl.TypeParameterDescriptorImpl;
023 import org.jetbrains.jet.lang.resolve.OverridingUtil;
024 import org.jetbrains.jet.lang.resolve.java.JvmAnnotationNames;
025 import org.jetbrains.jet.lang.resolve.java.PackageClassUtils;
026 import org.jetbrains.jet.lang.resolve.java.structure.*;
027 import org.jetbrains.jet.lang.resolve.name.FqName;
028 import org.jetbrains.jet.lang.resolve.name.Name;
029 import org.jetbrains.jet.lang.types.TypeConstructor;
030 import org.jetbrains.jet.lang.types.TypeProjection;
031 import org.jetbrains.jet.lang.types.TypeProjectionImpl;
032 import org.jetbrains.jet.lang.types.TypeSubstitutor;
033
034 import java.util.*;
035
036 import static org.jetbrains.jet.lang.resolve.DescriptorUtils.isEnumClassObject;
037
038 public final class DescriptorResolverUtils {
039 private DescriptorResolverUtils() {
040 }
041
042 public static boolean isCompiledKotlinPackageClass(@NotNull JavaClass javaClass) {
043 if (javaClass.getOriginKind() == JavaClass.OriginKind.COMPILED) {
044 FqName fqName = javaClass.getFqName();
045 if (fqName != null && PackageClassUtils.isPackageClassFqName(fqName)) {
046 return javaClass.findAnnotation(JvmAnnotationNames.KOTLIN_PACKAGE) != null;
047 }
048 }
049 return false;
050 }
051
052 public static boolean isCompiledKotlinClass(@NotNull JavaClass javaClass) {
053 if (javaClass.getOriginKind() == JavaClass.OriginKind.COMPILED) {
054 return javaClass.findAnnotation(JvmAnnotationNames.KOTLIN_CLASS) != null;
055 }
056 return false;
057 }
058
059 public static boolean isCompiledKotlinClassOrPackageClass(@NotNull JavaClass javaClass) {
060 return isCompiledKotlinClass(javaClass) || isCompiledKotlinPackageClass(javaClass);
061 }
062
063 @NotNull
064 public static FqName fqNameByClass(@NotNull Class<?> clazz) {
065 return new FqName(clazz.getCanonicalName());
066 }
067
068 @NotNull
069 public static <D extends CallableMemberDescriptor> Collection<D> resolveOverrides(
070 @NotNull Name name,
071 @NotNull Collection<D> membersFromSupertypes,
072 @NotNull Collection<D> membersFromCurrent,
073 @NotNull ClassDescriptor classDescriptor,
074 @NotNull final ErrorReporter errorReporter
075 ) {
076 final Set<D> result = new HashSet<D>();
077
078 OverridingUtil.generateOverridesInFunctionGroup(
079 name, membersFromSupertypes, membersFromCurrent, classDescriptor,
080 new OverridingUtil.DescriptorSink() {
081 @Override
082 @SuppressWarnings("unchecked")
083 public void addToScope(@NotNull CallableMemberDescriptor fakeOverride) {
084 OverridingUtil.resolveUnknownVisibilityForMember(fakeOverride, new OverridingUtil.NotInferredVisibilitySink() {
085 @Override
086 public void cannotInferVisibility(@NotNull CallableMemberDescriptor descriptor) {
087 errorReporter.reportCannotInferVisibility(descriptor);
088 }
089 });
090 result.add((D) fakeOverride);
091 }
092
093 @Override
094 public void conflict(@NotNull CallableMemberDescriptor fromSuper, @NotNull CallableMemberDescriptor fromCurrent) {
095 // nop
096 }
097 }
098 );
099
100 return result;
101 }
102
103 @Nullable
104 public static ValueParameterDescriptor getAnnotationParameterByName(@NotNull Name name, @NotNull ClassDescriptor annotationClass) {
105 Collection<ConstructorDescriptor> constructors = annotationClass.getConstructors();
106 assert constructors.size() == 1 : "Annotation class descriptor must have only one constructor";
107
108 for (ValueParameterDescriptor parameter : constructors.iterator().next().getValueParameters()) {
109 if (parameter.getName().equals(name)) {
110 return parameter;
111 }
112 }
113
114 return null;
115 }
116
117 /**
118 * @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
119 * corresponding package). This applies to values() and valueOf(String) methods
120 */
121 public static boolean shouldBeInEnumClassObject(@NotNull JavaMethod method) {
122 if (!method.getContainingClass().isEnum()) return false;
123
124 String signature = JavaSignatureFormatter.getInstance().formatMethod(method);
125
126 return "values()".equals(signature) ||
127 "valueOf(java.lang.String)".equals(signature);
128 }
129
130 public static boolean isCorrectOwnerForEnumMethod(@NotNull ClassOrNamespaceDescriptor ownerDescriptor, @NotNull JavaMethod method) {
131 return isEnumClassObject(ownerDescriptor) == shouldBeInEnumClassObject(method);
132 }
133
134 public static boolean isObjectMethodInInterface(@NotNull JavaMember member) {
135 return member.getContainingClass().isInterface() && member instanceof JavaMethod && isObjectMethod((JavaMethod) member);
136 }
137
138 public static boolean isObjectMethod(@NotNull JavaMethod method) {
139 String signature = JavaSignatureFormatter.getInstance().formatMethod(method);
140 return "hashCode()".equals(signature) ||
141 "equals(java.lang.Object)".equals(signature) ||
142 "toString()".equals(signature);
143 }
144
145 @NotNull
146 public static Collection<JavaClass> getClassesInPackage(@NotNull JavaPackage javaPackage) {
147 Collection<JavaClass> classes = javaPackage.getClasses();
148 Set<FqName> addedQualifiedNames = new HashSet<FqName>(classes.size());
149 List<JavaClass> result = new ArrayList<JavaClass>(classes.size());
150
151 for (JavaClass javaClass : classes) {
152 FqName fqName = javaClass.getFqName();
153 if (fqName != null && addedQualifiedNames.add(fqName)) {
154 result.add(javaClass);
155 }
156 }
157
158 return result;
159 }
160
161 /**
162 * @see com.intellij.psi.util.TypeConversionUtil#erasure(com.intellij.psi.PsiType)
163 */
164 @Nullable
165 public static JavaType erasure(@NotNull JavaType type) {
166 return erasure(type, JavaTypeSubstitutor.EMPTY);
167 }
168
169 /**
170 * @see com.intellij.psi.util.TypeConversionUtil#erasure(com.intellij.psi.PsiType, com.intellij.psi.PsiSubstitutor)
171 */
172 @Nullable
173 public static JavaType erasure(@NotNull JavaType type, @NotNull JavaTypeSubstitutor substitutor) {
174 if (type instanceof JavaClassifierType) {
175 JavaClassifier classifier = ((JavaClassifierType) type).getClassifier();
176 if (classifier instanceof JavaClass) {
177 return ((JavaClass) classifier).getDefaultType();
178 }
179 else if (classifier instanceof JavaTypeParameter) {
180 JavaTypeParameter typeParameter = (JavaTypeParameter) classifier;
181 return typeParameterErasure(typeParameter, new HashSet<JavaTypeParameter>(), substitutor);
182 }
183 else {
184 return null;
185 }
186 }
187 else if (type instanceof JavaPrimitiveType) {
188 return type;
189 }
190 else if (type instanceof JavaArrayType) {
191 JavaType erasure = erasure(((JavaArrayType) type).getComponentType(), substitutor);
192 return erasure == null ? null : JavaElementFactory.getInstance().createArrayType(erasure);
193 }
194 else if (type instanceof JavaWildcardType) {
195 JavaWildcardType wildcardType = (JavaWildcardType) type;
196 JavaType bound = wildcardType.getBound();
197 if (bound != null && wildcardType.isExtends()) {
198 return erasure(bound, substitutor);
199 }
200 return wildcardType.getTypeProvider().createJavaLangObjectType();
201 }
202 else {
203 throw new IllegalStateException("Unsupported type: " + type);
204 }
205 }
206
207 /**
208 * @see com.intellij.psi.util.TypeConversionUtil#typeParameterErasure(com.intellij.psi.PsiTypeParameter)
209 */
210 @Nullable
211 private static JavaType typeParameterErasure(
212 @NotNull JavaTypeParameter typeParameter,
213 @NotNull HashSet<JavaTypeParameter> visited,
214 @NotNull JavaTypeSubstitutor substitutor
215 ) {
216 Collection<JavaClassifierType> upperBounds = typeParameter.getUpperBounds();
217 if (!upperBounds.isEmpty()) {
218 JavaClassifier classifier = upperBounds.iterator().next().getClassifier();
219 if (classifier instanceof JavaTypeParameter && !visited.contains(classifier)) {
220 JavaTypeParameter typeParameterBound = (JavaTypeParameter) classifier;
221 visited.add(typeParameterBound);
222 JavaType substitutedType = substitutor.substitute(typeParameterBound);
223 if (substitutedType != null) {
224 return erasure(substitutedType);
225 }
226 return typeParameterErasure(typeParameterBound, visited, substitutor);
227 }
228 else if (classifier instanceof JavaClass) {
229 return ((JavaClass) classifier).getDefaultType();
230 }
231 }
232 return typeParameter.getTypeProvider().createJavaLangObjectType();
233 }
234
235 @NotNull
236 public static Map<TypeParameterDescriptor, TypeParameterDescriptorImpl> recreateTypeParametersAndReturnMapping(
237 @NotNull List<TypeParameterDescriptor> originalParameters,
238 @Nullable DeclarationDescriptor newOwner
239 ) {
240 // LinkedHashMap to save the order of type parameters
241 Map<TypeParameterDescriptor, TypeParameterDescriptorImpl> result =
242 new LinkedHashMap<TypeParameterDescriptor, TypeParameterDescriptorImpl>();
243 for (TypeParameterDescriptor typeParameter : originalParameters) {
244 result.put(typeParameter,
245 TypeParameterDescriptorImpl.createForFurtherModification(
246 newOwner == null ? typeParameter.getContainingDeclaration() : newOwner,
247 typeParameter.getAnnotations(),
248 typeParameter.isReified(),
249 typeParameter.getVariance(),
250 typeParameter.getName(),
251 typeParameter.getIndex()));
252 }
253 return result;
254 }
255
256 @NotNull
257 public static TypeSubstitutor createSubstitutorForTypeParameters(
258 @NotNull Map<TypeParameterDescriptor, TypeParameterDescriptorImpl> originalToAltTypeParameters
259 ) {
260 Map<TypeConstructor, TypeProjection> typeSubstitutionContext = new HashMap<TypeConstructor, TypeProjection>();
261 for (Map.Entry<TypeParameterDescriptor, TypeParameterDescriptorImpl> originalToAltTypeParameter : originalToAltTypeParameters
262 .entrySet()) {
263 typeSubstitutionContext.put(originalToAltTypeParameter.getKey().getTypeConstructor(),
264 new TypeProjectionImpl(originalToAltTypeParameter.getValue().getDefaultType()));
265 }
266 return TypeSubstitutor.create(typeSubstitutionContext);
267 }
268 }