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