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.resolve.inline;
018
019 import com.intellij.psi.PsiElement;
020 import org.jetbrains.annotations.NotNull;
021 import org.jetbrains.annotations.Nullable;
022 import org.jetbrains.kotlin.builtins.FunctionTypesKt;
023 import org.jetbrains.kotlin.builtins.KotlinBuiltIns;
024 import org.jetbrains.kotlin.descriptors.*;
025 import org.jetbrains.kotlin.psi.*;
026 import org.jetbrains.kotlin.resolve.BindingContext;
027 import org.jetbrains.kotlin.resolve.DescriptorToSourceUtils;
028 import org.jetbrains.kotlin.resolve.calls.callUtil.CallUtilKt;
029 import org.jetbrains.kotlin.resolve.calls.context.ResolutionContext;
030 import org.jetbrains.kotlin.resolve.calls.model.ArgumentMapping;
031 import org.jetbrains.kotlin.resolve.calls.model.ArgumentMatch;
032 import org.jetbrains.kotlin.resolve.calls.model.ResolvedCall;
033
034 public class InlineUtil {
035 public static boolean isInlineLambdaParameter(@NotNull ParameterDescriptor valueParameterOrReceiver) {
036 return !(valueParameterOrReceiver instanceof ValueParameterDescriptor
037 && ((ValueParameterDescriptor) valueParameterOrReceiver).isNoinline()) &&
038 FunctionTypesKt.isFunctionType(valueParameterOrReceiver.getOriginal().getType());
039 }
040
041 public static boolean isInline(@Nullable DeclarationDescriptor descriptor) {
042 return descriptor instanceof FunctionDescriptor && getInlineStrategy((FunctionDescriptor) descriptor).isInline();
043 }
044
045 public static boolean hasInlineAccessors(@NotNull PropertyDescriptor propertyDescriptor) {
046 PropertyGetterDescriptor getter = propertyDescriptor.getGetter();
047 PropertySetterDescriptor setter = propertyDescriptor.getSetter();
048 return getter != null && getter.isInline() || setter != null && setter.isInline();
049 }
050
051 public static boolean isPropertyWithAllAccessorsAreInline(@NotNull DeclarationDescriptor descriptor) {
052 if (!(descriptor instanceof PropertyDescriptor)) return false;
053
054 PropertyGetterDescriptor getter = ((PropertyDescriptor) descriptor).getGetter();
055 if (getter == null || !getter.isInline()) return false;
056
057 if (((PropertyDescriptor) descriptor).isVar()) {
058 PropertySetterDescriptor setter = ((PropertyDescriptor) descriptor).getSetter();
059 return setter != null && setter.isInline();
060 }
061
062 return true;
063 }
064
065 public static boolean isInlineOrContainingInline(@Nullable DeclarationDescriptor descriptor) {
066 if (isInline(descriptor)) return true;
067 if (descriptor == null) return false;
068 return isInlineOrContainingInline(descriptor.getContainingDeclaration());
069 }
070
071 @NotNull
072 private static InlineStrategy getInlineStrategy(@NotNull FunctionDescriptor descriptor) {
073 if (descriptor.isInline()) {
074 return InlineStrategy.AS_FUNCTION;
075 }
076
077 return InlineStrategy.NOT_INLINE;
078 }
079
080 public static boolean checkNonLocalReturnUsage(
081 @NotNull DeclarationDescriptor fromFunction,
082 @NotNull KtExpression startExpression,
083 @NotNull ResolutionContext<?> context
084 ) {
085 PsiElement containingFunction = context.getContextParentOfType(startExpression, KtClassOrObject.class, KtDeclarationWithBody.class);
086 if (containingFunction == null) {
087 return false;
088 }
089
090 return checkNonLocalReturnUsage(
091 fromFunction, context.trace.get(BindingContext.DECLARATION_TO_DESCRIPTOR, containingFunction), containingFunction,
092 context.trace.getBindingContext()
093 );
094 }
095
096 public static boolean checkNonLocalReturnUsage(
097 @NotNull DeclarationDescriptor fromFunction,
098 @Nullable DeclarationDescriptor containingFunctionDescriptor,
099 @Nullable PsiElement containingFunction,
100 @NotNull BindingContext bindingContext
101 ) {
102 if (containingFunctionDescriptor == null) return false;
103
104 while (canBeInlineArgument(containingFunction) && fromFunction != containingFunctionDescriptor) {
105 if (!isInlinedArgument((KtFunction) containingFunction, bindingContext, true)) {
106 return false;
107 }
108
109 containingFunctionDescriptor = getContainingClassOrFunctionDescriptor(containingFunctionDescriptor, true);
110
111 containingFunction = containingFunctionDescriptor != null
112 ? DescriptorToSourceUtils.descriptorToDeclaration(containingFunctionDescriptor)
113 : null;
114 }
115
116 return fromFunction == containingFunctionDescriptor;
117 }
118
119 public static boolean isInlinedArgument(
120 @NotNull KtFunction argument,
121 @NotNull BindingContext bindingContext,
122 boolean checkNonLocalReturn
123 ) {
124 ValueParameterDescriptor descriptor = getInlineArgumentDescriptor(argument, bindingContext);
125 if (descriptor != null) {
126 return !checkNonLocalReturn || allowsNonLocalReturns(descriptor);
127 }
128
129 return false;
130 }
131
132 @Nullable
133 public static ValueParameterDescriptor getInlineArgumentDescriptor(
134 @NotNull KtFunction argument,
135 @NotNull BindingContext bindingContext
136 ) {
137 if (!canBeInlineArgument(argument)) return null;
138
139 KtExpression call = KtPsiUtil.getParentCallIfPresent(argument);
140 if (call == null) return null;
141
142 ResolvedCall<?> resolvedCall = CallUtilKt.getResolvedCall(call, bindingContext);
143 if (resolvedCall == null) return null;
144
145 CallableDescriptor descriptor = resolvedCall.getResultingDescriptor();
146 if (!isInline(descriptor) && !isArrayConstructorWithLambda(descriptor)) return null;
147
148 ValueArgument valueArgument = CallUtilKt.getValueArgumentForExpression(resolvedCall.getCall(), argument);
149 if (valueArgument == null) return null;
150
151 ArgumentMapping mapping = resolvedCall.getArgumentMapping(valueArgument);
152 if (!(mapping instanceof ArgumentMatch)) return null;
153
154 ValueParameterDescriptor parameter = ((ArgumentMatch) mapping).getValueParameter();
155 return isInlineLambdaParameter(parameter) ? parameter : null;
156 }
157
158 public static boolean canBeInlineArgument(@Nullable PsiElement functionalExpression) {
159 return functionalExpression instanceof KtFunctionLiteral || functionalExpression instanceof KtNamedFunction;
160 }
161
162 /**
163 * @return true if the descriptor is the constructor of one of 9 array classes (Array<T>, IntArray, FloatArray, ...)
164 * which takes the size and an initializer lambda as parameters. Such constructors are marked as 'inline' but they are not loaded
165 * as such because the 'inline' flag is not stored for constructors in the binary metadata. Therefore we pretend that they are inline
166 */
167 public static boolean isArrayConstructorWithLambda(@NotNull CallableDescriptor descriptor) {
168 return descriptor.getValueParameters().size() == 2 &&
169 descriptor instanceof ConstructorDescriptor &&
170 KotlinBuiltIns.isArrayOrPrimitiveArray(((ConstructorDescriptor) descriptor).getConstructedClass());
171 }
172
173 @Nullable
174 public static DeclarationDescriptor getContainingClassOrFunctionDescriptor(@NotNull DeclarationDescriptor descriptor, boolean strict) {
175 DeclarationDescriptor current = strict ? descriptor.getContainingDeclaration() : descriptor;
176 while (current != null) {
177 if (current instanceof FunctionDescriptor || current instanceof ClassDescriptor) {
178 return current;
179 }
180 current = current.getContainingDeclaration();
181 }
182
183 return null;
184 }
185
186 public static boolean allowsNonLocalReturns(@NotNull CallableDescriptor lambda) {
187 if (lambda instanceof ValueParameterDescriptor) {
188 if (((ValueParameterDescriptor) lambda).isCrossinline()) {
189 //annotated
190 return false;
191 }
192 }
193 return true;
194 }
195
196 public static boolean containsReifiedTypeParameters(@NotNull CallableDescriptor descriptor) {
197 for (TypeParameterDescriptor typeParameterDescriptor : descriptor.getTypeParameters()) {
198 if (typeParameterDescriptor.isReified()) return true;
199 }
200
201 return false;
202 }
203 }