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 member} is a static member of enum class, which is to be put into its class object (and not into the
119 * corresponding package). This applies to enum entries, values() and valueOf(String) methods
120 */
121 public static boolean shouldBeInEnumClassObject(@NotNull JavaMember member) {
122 if (!member.getContainingClass().isEnum()) return false;
123
124 if (member instanceof JavaField && ((JavaField) member).isEnumEntry()) return true;
125
126 if (!(member instanceof JavaMethod)) return false;
127 String signature = JavaSignatureFormatter.getInstance().formatMethod((JavaMethod) member);
128
129 return "values()".equals(signature) ||
130 "valueOf(java.lang.String)".equals(signature);
131 }
132
133 public static boolean isCorrectOwnerForEnumMember(@NotNull ClassOrNamespaceDescriptor ownerDescriptor, @NotNull JavaMember member) {
134 return isEnumClassObject(ownerDescriptor) == shouldBeInEnumClassObject(member);
135 }
136
137 public static boolean isObjectMethodInInterface(@NotNull JavaMember member) {
138 return member.getContainingClass().isInterface() && member instanceof JavaMethod && isObjectMethod((JavaMethod) member);
139 }
140
141 public static boolean isObjectMethod(@NotNull JavaMethod method) {
142 String signature = JavaSignatureFormatter.getInstance().formatMethod(method);
143 return "hashCode()".equals(signature) ||
144 "equals(java.lang.Object)".equals(signature) ||
145 "toString()".equals(signature);
146 }
147
148 @NotNull
149 public static Collection<JavaClass> getClassesInPackage(@NotNull JavaPackage javaPackage) {
150 Collection<JavaClass> classes = javaPackage.getClasses();
151 Set<FqName> addedQualifiedNames = new HashSet<FqName>(classes.size());
152 List<JavaClass> result = new ArrayList<JavaClass>(classes.size());
153
154 for (JavaClass javaClass : classes) {
155 FqName fqName = javaClass.getFqName();
156 if (fqName != null && addedQualifiedNames.add(fqName)) {
157 result.add(javaClass);
158 }
159 }
160
161 return result;
162 }
163
164 /**
165 * @see com.intellij.psi.util.TypeConversionUtil#erasure(com.intellij.psi.PsiType)
166 */
167 @Nullable
168 public static JavaType erasure(@NotNull JavaType type) {
169 return erasure(type, JavaTypeSubstitutor.EMPTY);
170 }
171
172 /**
173 * @see com.intellij.psi.util.TypeConversionUtil#erasure(com.intellij.psi.PsiType, com.intellij.psi.PsiSubstitutor)
174 */
175 @Nullable
176 public static JavaType erasure(@NotNull JavaType type, @NotNull JavaTypeSubstitutor substitutor) {
177 if (type instanceof JavaClassifierType) {
178 JavaClassifier classifier = ((JavaClassifierType) type).getClassifier();
179 if (classifier instanceof JavaClass) {
180 return ((JavaClass) classifier).getDefaultType();
181 }
182 else if (classifier instanceof JavaTypeParameter) {
183 JavaTypeParameter typeParameter = (JavaTypeParameter) classifier;
184 return typeParameterErasure(typeParameter, new HashSet<JavaTypeParameter>(), substitutor);
185 }
186 else {
187 return null;
188 }
189 }
190 else if (type instanceof JavaPrimitiveType) {
191 return type;
192 }
193 else if (type instanceof JavaArrayType) {
194 JavaType erasure = erasure(((JavaArrayType) type).getComponentType(), substitutor);
195 return erasure == null ? null : JavaElementFactory.getInstance().createArrayType(erasure);
196 }
197 else if (type instanceof JavaWildcardType) {
198 JavaWildcardType wildcardType = (JavaWildcardType) type;
199 JavaType bound = wildcardType.getBound();
200 if (bound != null && wildcardType.isExtends()) {
201 return erasure(bound, substitutor);
202 }
203 return wildcardType.getTypeProvider().createJavaLangObjectType();
204 }
205 else {
206 throw new IllegalStateException("Unsupported type: " + type);
207 }
208 }
209
210 /**
211 * @see com.intellij.psi.util.TypeConversionUtil#typeParameterErasure(com.intellij.psi.PsiTypeParameter)
212 */
213 @Nullable
214 private static JavaType typeParameterErasure(
215 @NotNull JavaTypeParameter typeParameter,
216 @NotNull HashSet<JavaTypeParameter> visited,
217 @NotNull JavaTypeSubstitutor substitutor
218 ) {
219 Collection<JavaClassifierType> upperBounds = typeParameter.getUpperBounds();
220 if (!upperBounds.isEmpty()) {
221 JavaClassifier classifier = upperBounds.iterator().next().getClassifier();
222 if (classifier instanceof JavaTypeParameter && !visited.contains(classifier)) {
223 JavaTypeParameter typeParameterBound = (JavaTypeParameter) classifier;
224 visited.add(typeParameterBound);
225 JavaType substitutedType = substitutor.substitute(typeParameterBound);
226 if (substitutedType != null) {
227 return erasure(substitutedType);
228 }
229 return typeParameterErasure(typeParameterBound, visited, substitutor);
230 }
231 else if (classifier instanceof JavaClass) {
232 return ((JavaClass) classifier).getDefaultType();
233 }
234 }
235 return typeParameter.getTypeProvider().createJavaLangObjectType();
236 }
237
238 @NotNull
239 public static Map<TypeParameterDescriptor, TypeParameterDescriptorImpl> recreateTypeParametersAndReturnMapping(
240 @NotNull List<TypeParameterDescriptor> originalParameters,
241 @Nullable DeclarationDescriptor newOwner
242 ) {
243 // LinkedHashMap to save the order of type parameters
244 Map<TypeParameterDescriptor, TypeParameterDescriptorImpl> result =
245 new LinkedHashMap<TypeParameterDescriptor, TypeParameterDescriptorImpl>();
246 for (TypeParameterDescriptor typeParameter : originalParameters) {
247 result.put(typeParameter,
248 TypeParameterDescriptorImpl.createForFurtherModification(
249 newOwner == null ? typeParameter.getContainingDeclaration() : newOwner,
250 typeParameter.getAnnotations(),
251 typeParameter.isReified(),
252 typeParameter.getVariance(),
253 typeParameter.getName(),
254 typeParameter.getIndex()));
255 }
256 return result;
257 }
258
259 @NotNull
260 public static TypeSubstitutor createSubstitutorForTypeParameters(
261 @NotNull Map<TypeParameterDescriptor, TypeParameterDescriptorImpl> originalToAltTypeParameters
262 ) {
263 Map<TypeConstructor, TypeProjection> typeSubstitutionContext = new HashMap<TypeConstructor, TypeProjection>();
264 for (Map.Entry<TypeParameterDescriptor, TypeParameterDescriptorImpl> originalToAltTypeParameter : originalToAltTypeParameters
265 .entrySet()) {
266 typeSubstitutionContext.put(originalToAltTypeParameter.getKey().getTypeConstructor(),
267 new TypeProjectionImpl(originalToAltTypeParameter.getValue().getDefaultType()));
268 }
269 return TypeSubstitutor.create(typeSubstitutionContext);
270 }
271 }