001 /*
002 * Copyright 2010-2015 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.kotlin.backend.common;
018
019 import com.intellij.openapi.editor.Document;
020 import com.intellij.openapi.util.TextRange;
021 import com.intellij.psi.PsiElement;
022 import com.intellij.psi.PsiFile;
023 import org.jetbrains.annotations.NotNull;
024 import org.jetbrains.annotations.Nullable;
025 import org.jetbrains.kotlin.descriptors.*;
026 import org.jetbrains.kotlin.psi.*;
027 import org.jetbrains.kotlin.resolve.BindingContext;
028 import org.jetbrains.kotlin.resolve.DescriptorUtils;
029 import org.jetbrains.kotlin.resolve.calls.CallResolverUtil;
030 import org.jetbrains.kotlin.resolve.calls.callUtil.CallUtilPackage;
031 import org.jetbrains.kotlin.resolve.calls.model.ResolvedCall;
032 import org.jetbrains.kotlin.name.Name;
033 import org.jetbrains.kotlin.types.JetType;
034 import org.jetbrains.kotlin.types.TypeUtils;
035 import org.jetbrains.kotlin.types.checker.JetTypeChecker;
036 import org.jetbrains.kotlin.builtins.KotlinBuiltIns;
037 import org.jetbrains.kotlin.backend.common.bridges.BridgesPackage;
038
039 import java.util.*;
040
041 /**
042 * Backend-independent utility class.
043 */
044 public class CodegenUtil {
045
046 private CodegenUtil() {
047 }
048
049 // TODO: consider putting predefined method signatures here too.
050 public static final String EQUALS_METHOD_NAME = "equals";
051 public static final String TO_STRING_METHOD_NAME = "toString";
052 public static final String HASH_CODE_METHOD_NAME = "hashCode";
053
054 @Nullable
055 public static FunctionDescriptor getDeclaredFunctionByRawSignature(
056 @NotNull ClassDescriptor owner,
057 @NotNull Name name,
058 @NotNull ClassifierDescriptor returnedClassifier,
059 @NotNull ClassifierDescriptor... valueParameterClassifiers
060 ) {
061 Collection<FunctionDescriptor> functions = owner.getDefaultType().getMemberScope().getFunctions(name);
062 for (FunctionDescriptor function : functions) {
063 if (!CallResolverUtil.isOrOverridesSynthesized(function)
064 && function.getTypeParameters().isEmpty()
065 && valueParameterClassesMatch(function.getValueParameters(), Arrays.asList(valueParameterClassifiers))
066 && rawTypeMatches(function.getReturnType(), returnedClassifier)) {
067 return function;
068 }
069 }
070 return null;
071 }
072
073 public static FunctionDescriptor getAnyEqualsMethod() {
074 ClassDescriptor anyClass = KotlinBuiltIns.getInstance().getAny();
075 FunctionDescriptor function =
076 getDeclaredFunctionByRawSignature(anyClass, Name.identifier(EQUALS_METHOD_NAME),
077 KotlinBuiltIns.getInstance().getBoolean(),
078 anyClass);
079 assert function != null;
080 return function;
081 }
082
083 public static FunctionDescriptor getAnyToStringMethod() {
084 ClassDescriptor anyClass = KotlinBuiltIns.getInstance().getAny();
085 FunctionDescriptor function =
086 getDeclaredFunctionByRawSignature(anyClass, Name.identifier(TO_STRING_METHOD_NAME),
087 KotlinBuiltIns.getInstance().getString());
088 assert function != null;
089 return function;
090 }
091
092 public static FunctionDescriptor getAnyHashCodeMethod() {
093 ClassDescriptor anyClass = KotlinBuiltIns.getInstance().getAny();
094 FunctionDescriptor function =
095 getDeclaredFunctionByRawSignature(anyClass, Name.identifier(HASH_CODE_METHOD_NAME),
096 KotlinBuiltIns.getInstance().getInt());
097 assert function != null;
098 return function;
099 }
100
101 @Nullable
102 public static PropertyDescriptor getDelegatePropertyIfAny(JetExpression expression, ClassDescriptor classDescriptor, BindingContext bindingContext) {
103 PropertyDescriptor propertyDescriptor = null;
104 if (expression instanceof JetSimpleNameExpression) {
105 ResolvedCall<?> call = CallUtilPackage.getResolvedCall(expression, bindingContext);
106 if (call != null) {
107 CallableDescriptor callResultingDescriptor = call.getResultingDescriptor();
108 if (callResultingDescriptor instanceof ValueParameterDescriptor) {
109 ValueParameterDescriptor valueParameterDescriptor = (ValueParameterDescriptor) callResultingDescriptor;
110 // constructor parameter
111 if (valueParameterDescriptor.getContainingDeclaration() instanceof ConstructorDescriptor) {
112 // constructor of my class
113 if (valueParameterDescriptor.getContainingDeclaration().getContainingDeclaration() == classDescriptor) {
114 propertyDescriptor = bindingContext.get(BindingContext.VALUE_PARAMETER_AS_PROPERTY, valueParameterDescriptor);
115 }
116 }
117 }
118
119 // todo: when and if frontend will allow properties defined not as constructor parameters to be used in delegation specifier
120 }
121 }
122 return propertyDescriptor;
123 }
124
125 public static boolean isFinalPropertyWithBackingField(PropertyDescriptor propertyDescriptor, BindingContext bindingContext) {
126 return propertyDescriptor != null &&
127 !propertyDescriptor.isVar() &&
128 Boolean.TRUE.equals(bindingContext.get(BindingContext.BACKING_FIELD_REQUIRED, propertyDescriptor));
129 }
130
131 @NotNull
132 public static Map<FunctionDescriptor, FunctionDescriptor> getTraitMethods(ClassDescriptor descriptor) {
133 Map<FunctionDescriptor, FunctionDescriptor> result = new LinkedHashMap<FunctionDescriptor, FunctionDescriptor>();
134 for (DeclarationDescriptor declaration : descriptor.getDefaultType().getMemberScope().getAllDescriptors()) {
135 if (!(declaration instanceof CallableMemberDescriptor)) continue;
136
137 CallableMemberDescriptor inheritedMember = (CallableMemberDescriptor) declaration;
138 CallableMemberDescriptor traitMember = BridgesPackage.findTraitImplementation(inheritedMember);
139 if (traitMember == null) continue;
140
141 assert traitMember.getModality() != Modality.ABSTRACT : "Cannot delegate to abstract trait method: " + inheritedMember;
142
143 // inheritedMember can be abstract here. In order for FunctionCodegen to generate the method body, we're creating a copy here
144 // with traitMember's modality
145 result.putAll(copyFunctions(inheritedMember, traitMember, inheritedMember.getContainingDeclaration(), traitMember.getModality(), Visibilities.PUBLIC,
146 CallableMemberDescriptor.Kind.DECLARATION, true));
147 }
148 return result;
149 }
150
151 @NotNull
152 public static Map<FunctionDescriptor, FunctionDescriptor> copyFunctions(
153 @NotNull CallableMemberDescriptor inheritedMember,
154 @NotNull CallableMemberDescriptor traitMember,
155 DeclarationDescriptor newOwner,
156 Modality modality,
157 Visibility visibility,
158 CallableMemberDescriptor.Kind kind,
159 boolean copyOverrides
160 ) {
161 CallableMemberDescriptor copy = inheritedMember.copy(newOwner, modality, visibility, kind, copyOverrides);
162 Map<FunctionDescriptor, FunctionDescriptor> result = new LinkedHashMap<FunctionDescriptor, FunctionDescriptor>(0);
163 if (traitMember instanceof SimpleFunctionDescriptor) {
164 result.put((FunctionDescriptor) traitMember, (FunctionDescriptor) copy);
165 }
166 else if (traitMember instanceof PropertyDescriptor) {
167 for (PropertyAccessorDescriptor traitAccessor : ((PropertyDescriptor) traitMember).getAccessors()) {
168 for (PropertyAccessorDescriptor inheritedAccessor : ((PropertyDescriptor) copy).getAccessors()) {
169 if (inheritedAccessor.getClass() == traitAccessor.getClass()) { // same accessor kind
170 result.put(traitAccessor, inheritedAccessor);
171 }
172 }
173 }
174 }
175 return result;
176 }
177
178 @NotNull
179 public static ClassDescriptor getSuperClassByDelegationSpecifier(@NotNull JetDelegationSpecifier specifier, @NotNull BindingContext bindingContext) {
180 JetType superType = bindingContext.get(BindingContext.TYPE, specifier.getTypeReference());
181 assert superType != null : "superType should not be null: " + specifier.getText();
182
183 ClassDescriptor superClassDescriptor = (ClassDescriptor) superType.getConstructor().getDeclarationDescriptor();
184 assert superClassDescriptor != null : "superClassDescriptor should not be null: " + specifier.getText();
185 return superClassDescriptor;
186 }
187
188 private static boolean valueParameterClassesMatch(
189 @NotNull List<ValueParameterDescriptor> parameters,
190 @NotNull List<ClassifierDescriptor> classifiers
191 ) {
192 if (parameters.size() != classifiers.size()) return false;
193 for (int i = 0; i < parameters.size(); i++) {
194 ValueParameterDescriptor parameterDescriptor = parameters.get(i);
195 ClassifierDescriptor classDescriptor = classifiers.get(i);
196 if (!rawTypeMatches(parameterDescriptor.getType(), classDescriptor)) {
197 return false;
198 }
199 }
200 return true;
201 }
202
203 private static boolean rawTypeMatches(JetType type, ClassifierDescriptor classifier) {
204 return type.getConstructor().equals(classifier.getTypeConstructor());
205 }
206
207 public static boolean isEnumValueOfMethod(@NotNull FunctionDescriptor functionDescriptor) {
208 List<ValueParameterDescriptor> methodTypeParameters = functionDescriptor.getValueParameters();
209 JetType nullableString = TypeUtils.makeNullable(KotlinBuiltIns.getInstance().getStringType());
210 return DescriptorUtils.ENUM_VALUE_OF.equals(functionDescriptor.getName())
211 && methodTypeParameters.size() == 1
212 && JetTypeChecker.DEFAULT.isSubtypeOf(methodTypeParameters.get(0).getType(), nullableString);
213 }
214
215 public static boolean isEnumValuesMethod(@NotNull FunctionDescriptor functionDescriptor) {
216 List<ValueParameterDescriptor> methodTypeParameters = functionDescriptor.getValueParameters();
217 return DescriptorUtils.ENUM_VALUES.equals(functionDescriptor.getName())
218 && methodTypeParameters.isEmpty();
219 }
220
221 @Nullable
222 public static Integer getLineNumberForElement(@NotNull PsiElement statement, boolean markEndOffset) {
223 PsiFile file = statement.getContainingFile();
224 if (file instanceof JetFile) {
225 if (PsiPackage.getDoNotAnalyze((JetFile) file) != null) {
226 return null;
227 }
228 }
229 Document document = file.getViewProvider().getDocument();
230 TextRange textRange = statement.getTextRange();
231 return document != null ? document.getLineNumber(markEndOffset ? textRange.getEndOffset() : textRange.getStartOffset()) + 1 : null;
232 }
233 }