org.jetbrains.kotlin.js.translate.utils.JsAstUtils Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlin-compiler-embeddable Show documentation
Show all versions of kotlin-compiler-embeddable Show documentation
the Kotlin compiler embeddable
/*
* Copyright 2010-2017 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jetbrains.kotlin.js.translate.utils;
import com.intellij.util.SmartList;
import kotlin.Pair;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.kotlin.builtins.StandardNames;
import org.jetbrains.kotlin.descriptors.ClassDescriptor;
import org.jetbrains.kotlin.descriptors.SourceElement;
import org.jetbrains.kotlin.js.backend.ast.*;
import org.jetbrains.kotlin.js.backend.ast.metadata.MetadataProperties;
import org.jetbrains.kotlin.js.backend.ast.metadata.SideEffectKind;
import org.jetbrains.kotlin.js.translate.context.Namer;
import org.jetbrains.kotlin.js.translate.context.TranslationContext;
import org.jetbrains.kotlin.js.translate.reference.ReferenceTranslator;
import org.jetbrains.kotlin.name.ClassId;
import org.jetbrains.kotlin.resolve.source.PsiSourceElementKt;
import org.jetbrains.kotlin.util.OperatorNameConventions;
import java.util.Collections;
import java.util.List;
import static org.jetbrains.kotlin.descriptors.FindClassInModuleKt.findClassAcrossModuleDependencies;
public final class JsAstUtils {
private static final JsNameRef DEFINE_PROPERTY = pureFqn("defineProperty", null);
private static final JsNameRef VALUE = new JsNameRef("value");
private static final JsPropertyInitializer WRITABLE = new JsPropertyInitializer(pureFqn("writable", null), new JsBooleanLiteral(true));
private static final JsPropertyInitializer ENUMERABLE = new JsPropertyInitializer(pureFqn("enumerable", null),
new JsBooleanLiteral(false));
static {
JsNameRef globalObjectReference = new JsNameRef("Object");
DEFINE_PROPERTY.setQualifier(globalObjectReference);
}
private JsAstUtils() {
}
@NotNull
public static JsStatement convertToStatement(@NotNull JsNode jsNode) {
assert (jsNode instanceof JsExpression) || (jsNode instanceof JsStatement)
: "Unexpected node of type: " + jsNode.getClass().toString();
if (jsNode instanceof JsExpression) {
JsExpression expression = (JsExpression) jsNode;
JsExpressionStatement statement = new JsExpressionStatement(expression);
if (expression instanceof JsNullLiteral || MetadataProperties.getSynthetic(expression)) {
MetadataProperties.setSynthetic(statement, true);
}
return statement;
}
return (JsStatement) jsNode;
}
@NotNull
public static JsBlock convertToBlock(@NotNull JsNode jsNode) {
if (jsNode instanceof JsBlock) {
return (JsBlock) jsNode;
}
JsBlock block = new JsBlock();
block.getStatements().add(convertToStatement(jsNode));
return block;
}
@NotNull
private static JsStatement deBlockIfPossible(@NotNull JsStatement statement) {
if (statement instanceof JsBlock && ((JsBlock)statement).getStatements().size() == 1) {
return ((JsBlock)statement).getStatements().get(0);
}
else {
return statement;
}
}
@NotNull
public static JsIf newJsIf(
@NotNull JsExpression ifExpression,
@NotNull JsStatement thenStatement,
@Nullable JsStatement elseStatement
) {
elseStatement = elseStatement != null ? deBlockIfPossible(elseStatement) : null;
return new JsIf(ifExpression, deBlockIfPossible(thenStatement), elseStatement);
}
@NotNull
public static JsIf newJsIf(@NotNull JsExpression ifExpression, @NotNull JsStatement thenStatement) {
return newJsIf(ifExpression, thenStatement, null);
}
@Nullable
public static JsExpression extractExpressionFromStatement(@Nullable JsStatement statement) {
return statement instanceof JsExpressionStatement ? ((JsExpressionStatement) statement).getExpression() : null;
}
@NotNull
public static JsStatement mergeStatementInBlockIfNeeded(@NotNull JsStatement statement, @NotNull JsBlock block) {
if (block.isEmpty()) {
return statement;
} else {
if (isEmptyStatement(statement)) {
return deBlockIfPossible(block);
}
block.getStatements().add(statement);
return block;
}
}
public static boolean isEmptyStatement(@NotNull JsStatement statement) {
return statement instanceof JsEmpty;
}
@NotNull
public static JsInvocation invokeKotlinFunction(@NotNull String name, @NotNull JsExpression... argument) {
return invokeMethod(Namer.kotlinObject(), name, argument);
}
@NotNull
public static JsInvocation invokeMethod(@NotNull JsExpression thisObject, @NotNull String name, @NotNull JsExpression... arguments) {
return new JsInvocation(pureFqn(name, thisObject), arguments);
}
@NotNull
public static JsExpression toInt32(@NotNull JsExpression expression) {
return new JsBinaryOperation(JsBinaryOperator.BIT_OR, expression, new JsIntLiteral(0));
}
@Nullable
public static JsExpression extractToInt32Argument(@NotNull JsExpression expression) {
if (!(expression instanceof JsBinaryOperation)) return null;
JsBinaryOperation binary = (JsBinaryOperation) expression;
if (binary.getOperator() != JsBinaryOperator.BIT_OR) return null;
if (!(binary.getArg2() instanceof JsIntLiteral)) return null;
JsIntLiteral arg2 = (JsIntLiteral) binary.getArg2();
return arg2.value == 0 ? binary.getArg1() : null;
}
@NotNull
public static JsExpression charToInt(@NotNull JsExpression expression) {
return toInt32(expression);
}
@NotNull
public static JsExpression charToString(@NotNull JsExpression expression) {
return new JsInvocation(new JsNameRef("fromCharCode", new JsNameRef("String")), expression);
}
@NotNull
public static JsExpression compareTo(@NotNull JsExpression left, @NotNull JsExpression right) {
return invokeKotlinFunction(OperatorNameConventions.COMPARE_TO.getIdentifier(), left, right);
}
@NotNull
public static JsExpression primitiveCompareTo(@NotNull JsExpression left, @NotNull JsExpression right) {
return invokeKotlinFunction(Namer.PRIMITIVE_COMPARE_TO, left, right);
}
public static JsExpression newLong(long value) {
JsExpression result;
if (value < Integer.MIN_VALUE || value > Integer.MAX_VALUE) {
if (value == Long.MAX_VALUE) {
return new JsNameRef(Namer.LONG_MAX_VALUE, Namer.kotlinLong());
}
else if (value == Long.MIN_VALUE) {
return new JsNameRef(Namer.LONG_MIN_VALUE, Namer.kotlinLong());
}
else {
int low = (int) value;
int high = (int) (value >> 32);
List args = new SmartList<>();
args.add(new JsIntLiteral(low));
args.add(new JsIntLiteral(high));
result = new JsNew(Namer.kotlinLong(), args);
}
}
else {
if (value == 0) {
result = new JsNameRef(Namer.LONG_ZERO, Namer.kotlinLong());
}
else if (value == 1) {
result = new JsNameRef(Namer.LONG_ONE, Namer.kotlinLong());
}
else if (value == -1) {
result = new JsNameRef(Namer.LONG_NEG_ONE, Namer.kotlinLong());
}
else {
result = longFromInt(new JsIntLiteral((int) value));
}
}
MetadataProperties.setSideEffects(result, SideEffectKind.PURE);
return result;
}
@NotNull
public static JsExpression longFromInt(@NotNull JsExpression expression) {
return invokeMethod(Namer.kotlinLong(), Namer.LONG_FROM_INT, expression);
}
@NotNull
public static JsExpression longFromNumber(@NotNull JsExpression expression) {
return invokeMethod(Namer.kotlinLong(), Namer.LONG_FROM_NUMBER, expression);
}
@NotNull
public static JsExpression longToNumber(@NotNull JsExpression expression) {
return invokeMethod(expression, Namer.LONG_TO_NUMBER);
}
@NotNull
public static JsExpression byteToUByte(byte value, @NotNull TranslationContext context) {
// replace with external builder
return toUnsignedNumber(new JsIntLiteral(value), context, StandardNames.FqNames.uByte);
}
@NotNull
public static JsExpression shortToUShort(short value, @NotNull TranslationContext context) {
// replace with external builder
return toUnsignedNumber(new JsIntLiteral(value), context, StandardNames.FqNames.uShort);
}
@NotNull
public static JsExpression intToUInt(int value, @NotNull TranslationContext context) {
// replace with external builder
return toUnsignedNumber(new JsIntLiteral(value), context, StandardNames.FqNames.uInt);
}
@NotNull
public static JsExpression longToULong(@NotNull JsExpression expression, @NotNull TranslationContext context) {
// replace with external builder
return toUnsignedNumber(expression, context, StandardNames.FqNames.uLong);
}
private static JsExpression toUnsignedNumber(
@NotNull JsExpression expression,
@NotNull TranslationContext context,
@NotNull ClassId unsignedClassId
) {
ClassDescriptor classDescriptor = findClassAcrossModuleDependencies(context.getCurrentModule(), unsignedClassId);
assert classDescriptor != null : "Class descriptor is null for " + unsignedClassId;
return new JsNew(ReferenceTranslator.translateAsTypeReference(classDescriptor, context), Collections.singletonList(expression));
}
@NotNull
public static JsExpression compareForObject(@NotNull JsExpression left, @NotNull JsExpression right) {
return invokeMethod(left, Namer.COMPARE_TO_METHOD_NAME, right);
}
@NotNull
public static JsExpression notOptimized(@NotNull JsExpression expression) {
if (expression instanceof JsUnaryOperation) {
JsUnaryOperation unary = (JsUnaryOperation) expression;
if (unary.getOperator() == JsUnaryOperator.NOT) return unary.getArg();
}
else if (expression instanceof JsBinaryOperation) {
JsBinaryOperation binary = (JsBinaryOperation) expression;
switch (binary.getOperator()) {
case AND:
return or(notOptimized(binary.getArg1()), notOptimized(binary.getArg2()));
case OR:
return and(notOptimized(binary.getArg1()), notOptimized(binary.getArg2()));
case EQ:
return new JsBinaryOperation(JsBinaryOperator.NEQ, binary.getArg1(), binary.getArg2());
case NEQ:
return new JsBinaryOperation(JsBinaryOperator.EQ, binary.getArg1(), binary.getArg2());
case REF_EQ:
return inequality(binary.getArg1(), binary.getArg2());
case REF_NEQ:
return equality(binary.getArg1(), binary.getArg2());
case LT:
return greaterThanEq(binary.getArg1(), binary.getArg2());
case LTE:
return greaterThan(binary.getArg1(), binary.getArg2());
case GT:
return lessThanEq(binary.getArg1(), binary.getArg2());
case GTE:
return lessThan(binary.getArg1(), binary.getArg2());
default:
break;
}
}
return not(expression);
}
@NotNull
public static JsBinaryOperation and(@NotNull JsExpression op1, @NotNull JsExpression op2) {
return new JsBinaryOperation(JsBinaryOperator.AND, op1, op2);
}
@NotNull
public static JsBinaryOperation or(@NotNull JsExpression op1, @NotNull JsExpression op2) {
return new JsBinaryOperation(JsBinaryOperator.OR, op1, op2);
}
private static void setQualifier(@NotNull JsExpression selector, @Nullable JsExpression receiver) {
assert (selector instanceof JsInvocation || selector instanceof JsNameRef);
if (selector instanceof JsInvocation) {
setQualifier(((JsInvocation) selector).getQualifier(), receiver);
return;
}
setQualifierForNameRef((JsNameRef) selector, receiver);
}
private static void setQualifierForNameRef(@NotNull JsNameRef selector, @Nullable JsExpression receiver) {
JsExpression qualifier = selector.getQualifier();
if (qualifier == null) {
selector.setQualifier(receiver);
}
else {
setQualifier(qualifier, receiver);
}
}
@NotNull
public static JsBinaryOperation equality(@NotNull JsExpression arg1, @NotNull JsExpression arg2) {
return new JsBinaryOperation(JsBinaryOperator.REF_EQ, arg1, arg2);
}
@NotNull
public static JsBinaryOperation inequality(@NotNull JsExpression arg1, @NotNull JsExpression arg2) {
return new JsBinaryOperation(JsBinaryOperator.REF_NEQ, arg1, arg2);
}
@NotNull
public static JsBinaryOperation lessThanEq(@NotNull JsExpression arg1, @NotNull JsExpression arg2) {
return new JsBinaryOperation(JsBinaryOperator.LTE, arg1, arg2);
}
@NotNull
public static JsBinaryOperation lessThan(@NotNull JsExpression arg1, @NotNull JsExpression arg2) {
return new JsBinaryOperation(JsBinaryOperator.LT, arg1, arg2);
}
@NotNull
public static JsBinaryOperation greaterThan(@NotNull JsExpression arg1, @NotNull JsExpression arg2) {
return new JsBinaryOperation(JsBinaryOperator.GT, arg1, arg2);
}
@NotNull
public static JsBinaryOperation greaterThanEq(@NotNull JsExpression arg1, @NotNull JsExpression arg2) {
return new JsBinaryOperation(JsBinaryOperator.GTE, arg1, arg2);
}
@NotNull
public static JsBinaryOperation assignment(@NotNull JsExpression left, @NotNull JsExpression right) {
return new JsBinaryOperation(JsBinaryOperator.ASG, left, right);
}
@NotNull
public static JsStatement assignmentToThisField(@NotNull String fieldName, @NotNull JsExpression right) {
return assignment(new JsNameRef(fieldName, new JsThisRef()), right).source(right.getSource()).makeStmt();
}
public static JsStatement asSyntheticStatement(@NotNull JsExpression expression) {
JsExpressionStatement statement = new JsExpressionStatement(expression);
MetadataProperties.setSynthetic(statement, true);
return statement;
}
@Nullable
public static Pair decomposeAssignment(@NotNull JsExpression expr) {
if (!(expr instanceof JsBinaryOperation)) return null;
JsBinaryOperation binary = (JsBinaryOperation) expr;
if (binary.getOperator() != JsBinaryOperator.ASG) return null;
return new Pair<>(binary.getArg1(), binary.getArg2());
}
@Nullable
public static Pair decomposeAssignmentToVariable(@NotNull JsExpression expr) {
Pair assignment = decomposeAssignment(expr);
if (assignment == null || !(assignment.getFirst() instanceof JsNameRef)) return null;
JsNameRef nameRef = (JsNameRef) assignment.getFirst();
if (nameRef.getName() == null || nameRef.getQualifier() != null) return null;
return new Pair<>(nameRef.getName(), assignment.getSecond());
}
@NotNull
public static JsBinaryOperation sum(@NotNull JsExpression left, @NotNull JsExpression right) {
return new JsBinaryOperation(JsBinaryOperator.ADD, left, right);
}
@NotNull
public static JsBinaryOperation addAssign(@NotNull JsExpression left, @NotNull JsExpression right) {
return new JsBinaryOperation(JsBinaryOperator.ASG_ADD, left, right);
}
@NotNull
public static JsBinaryOperation subtract(@NotNull JsExpression left, @NotNull JsExpression right) {
return new JsBinaryOperation(JsBinaryOperator.SUB, left, right);
}
@NotNull
public static JsBinaryOperation mul(@NotNull JsExpression left, @NotNull JsExpression right) {
return new JsBinaryOperation(JsBinaryOperator.MUL, left, right);
}
@NotNull
public static JsBinaryOperation div(@NotNull JsExpression left, @NotNull JsExpression right) {
return new JsBinaryOperation(JsBinaryOperator.DIV, left, right);
}
@NotNull
public static JsBinaryOperation mod(@NotNull JsExpression left, @NotNull JsExpression right) {
return new JsBinaryOperation(JsBinaryOperator.MOD, left, right);
}
@NotNull
public static JsPrefixOperation not(@NotNull JsExpression expression) {
return new JsPrefixOperation(JsUnaryOperator.NOT, expression);
}
@NotNull
public static JsBinaryOperation typeOfIs(@NotNull JsExpression expression, @NotNull JsStringLiteral string) {
return equality(new JsPrefixOperation(JsUnaryOperator.TYPEOF, expression), string);
}
@NotNull
public static JsVars newVar(@NotNull JsName name, @Nullable JsExpression expr) {
return new JsVars(new JsVars.JsVar(name, expr));
}
@NotNull
public static JsExpression newSequence(@NotNull List expressions) {
assert !expressions.isEmpty();
if (expressions.size() == 1) {
return expressions.get(0);
}
JsExpression result = expressions.get(0);
for (int i = 1; i < expressions.size(); i++) {
result = new JsBinaryOperation(JsBinaryOperator.COMMA, result, expressions.get(i));
}
return result;
}
@NotNull
public static JsFunction createFunctionWithEmptyBody(@NotNull JsScope parent) {
return new JsFunction(parent, new JsBlock(), "");
}
@NotNull
public static List toStringLiteralList(@NotNull List strings) {
if (strings.isEmpty()) {
return Collections.emptyList();
}
List result = new SmartList<>();
for (String str : strings) {
result.add(new JsStringLiteral(str));
}
return result;
}
@NotNull
public static JsInvocation defineProperty(
@NotNull JsExpression receiver,
@NotNull String name,
@NotNull JsExpression value
) {
return new JsInvocation(DEFINE_PROPERTY.deepCopy(), receiver, new JsStringLiteral(name), value);
}
@NotNull
public static JsStatement defineSimpleProperty(@NotNull JsName name, @NotNull JsExpression value, @Nullable SourceElement source) {
JsExpression assignment = assignment(new JsNameRef(name, new JsThisRef()), value);
if (source != null) {
assignment.setSource(PsiSourceElementKt.getPsi(source));
}
return assignment.makeStmt();
}
@NotNull
public static JsObjectLiteral createDataDescriptor(@NotNull JsExpression value, boolean writable, boolean enumerable) {
JsObjectLiteral dataDescriptor = new JsObjectLiteral();
dataDescriptor.getPropertyInitializers().add(new JsPropertyInitializer(VALUE.deepCopy(), value));
if (writable) {
dataDescriptor.getPropertyInitializers().add(WRITABLE.deepCopy());
}
if (enumerable) {
dataDescriptor.getPropertyInitializers().add(ENUMERABLE.deepCopy());
}
return dataDescriptor;
}
@NotNull
public static JsObjectLiteral wrapValue(@NotNull JsExpression label, @NotNull JsExpression value) {
return new JsObjectLiteral(Collections.singletonList(new JsPropertyInitializer(label, value)));
}
@NotNull
public static List flattenStatement(@NotNull JsStatement statement) {
if (statement instanceof JsBlock) {
return ((JsBlock) statement).getStatements();
}
return new SmartList<>(statement);
}
@NotNull
public static JsNameRef pureFqn(@NotNull String identifier, @Nullable JsExpression qualifier) {
JsNameRef result = new JsNameRef(identifier, qualifier);
MetadataProperties.setSideEffects(result, SideEffectKind.PURE);
return result;
}
@NotNull
public static JsNameRef pureFqn(@NotNull JsName identifier, @Nullable JsExpression qualifier) {
JsNameRef result = new JsNameRef(identifier, qualifier);
MetadataProperties.setSideEffects(result, SideEffectKind.PURE);
return result;
}
@NotNull
public static JsInvocation invokeBind(@NotNull JsExpression receiver, @NotNull JsExpression method) {
return invokeMethod(method, "bind", receiver);
}
public static boolean isUndefinedExpression(JsExpression expression) {
if (!(expression instanceof JsUnaryOperation)) return false;
JsUnaryOperation unary = (JsUnaryOperation) expression;
return unary.getOperator() == JsUnaryOperator.VOID;
}
@NotNull
public static JsExpression defineGetter(
@NotNull JsExpression receiver,
@NotNull String name,
@NotNull JsExpression body
) {
JsObjectLiteral propertyLiteral = new JsObjectLiteral(true);
propertyLiteral.getPropertyInitializers().add(new JsPropertyInitializer(new JsNameRef("get"), body));
return defineProperty(receiver, name, propertyLiteral);
}
@NotNull
public static JsExpression prototypeOf(@NotNull JsExpression expression) {
return pureFqn("prototype", expression);
}
@NotNull
public static JsExpression stateMachineReceiver() {
JsNameRef result = pureFqn("$this$", null);
MetadataProperties.setCoroutineReceiver(result, true);
return result;
}
}