com.oracle.truffle.js.nodes.cast.JSToNumericNode Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2018, 2024, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Universal Permissive License (UPL), Version 1.0
 *
 * Subject to the condition set forth below, permission is hereby granted to any
 * person obtaining a copy of this software, associated documentation and/or
 * data (collectively the "Software"), free of charge and under any and all
 * copyright rights in the Software, and any and all patent rights owned or
 * freely licensable by each licensor hereunder covering either (i) the
 * unmodified Software as contributed to or provided by such licensor, or (ii)
 * the Larger Works (as defined below), to deal in both
 *
 * (a) the Software, and
 *
 * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
 * one is included with the Software each a "Larger Work" to which the Software
 * is contributed by such licensors),
 *
 * without restriction, including without limitation the rights to copy, create
 * derivative works of, display, perform, and distribute the Software and make,
 * use, sell, offer for sale, import, export, have made, and have sold the
 * Software and the Larger Work(s), and to sublicense the foregoing rights on
 * either these or other terms.
 *
 * This license is subject to the following condition:
 *
 * The above copyright notice and either this complete permission notice or at a
 * minimum a reference to the UPL must be included in all copies or substantial
 * portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.oracle.truffle.js.nodes.cast;

import static com.oracle.truffle.js.builtins.OperatorsBuiltins.checkOverloadedOperatorsAllowed;

import java.util.Set;

import com.oracle.truffle.api.dsl.Cached;
import com.oracle.truffle.api.dsl.Cached.Shared;
import com.oracle.truffle.api.dsl.Fallback;
import com.oracle.truffle.api.dsl.GenerateCached;
import com.oracle.truffle.api.dsl.GenerateInline;
import com.oracle.truffle.api.dsl.Idempotent;
import com.oracle.truffle.api.dsl.ImportStatic;
import com.oracle.truffle.api.dsl.NeverDefault;
import com.oracle.truffle.api.dsl.Specialization;
import com.oracle.truffle.api.instrumentation.Tag;
import com.oracle.truffle.api.nodes.Node;
import com.oracle.truffle.js.nodes.JavaScriptBaseNode;
import com.oracle.truffle.js.nodes.JavaScriptNode;
import com.oracle.truffle.js.nodes.access.JSConstantNode;
import com.oracle.truffle.js.nodes.cast.JSToNumericNodeGen.JSToNumericWrapperNodeGen;
import com.oracle.truffle.js.nodes.unary.JSUnaryNode;
import com.oracle.truffle.js.runtime.BigInt;
import com.oracle.truffle.js.runtime.JSRuntime;
import com.oracle.truffle.js.runtime.Symbol;
import com.oracle.truffle.js.runtime.builtins.JSOverloadedOperatorsObject;

public abstract class JSToNumericNode extends JavaScriptBaseNode {

    /**
     * Whether this node implements the ToNumeric spec functions or the ToNumericOperand spec
     * function from the operator overloading proposal. The latter is identical except for the case
     * when the argument is an object with overloaded operators. In that case, it is not coerced to
     * a numeric type, but checked for whether its operators are enabled.
     */
    private final boolean toNumericOperand;

    public abstract Object execute(Object value);

    protected JSToNumericNode(boolean toNumericOperand) {
        super();
        this.toNumericOperand = toNumericOperand;
    }

    @NeverDefault
    public static JSToNumericNode create(boolean toNumericOperand) {
        return JSToNumericNodeGen.create(toNumericOperand);
    }

    @NeverDefault
    public static JSToNumericNode create() {
        return create(false);
    }

    @NeverDefault
    public static JSToNumericNode createToNumericOperand() {
        return create(true);
    }

    public static JavaScriptNode create(JavaScriptNode child, boolean toNumericOperand) {
        if (child.isResultAlwaysOfType(Number.class) || child.isResultAlwaysOfType(int.class) || child.isResultAlwaysOfType(double.class)) {
            return child;
        }
        if (child instanceof JSConstantNode) {
            Object constantOperand = ((JSConstantNode) child).getValue();
            if (constantOperand != null && !(constantOperand instanceof Symbol) && JSRuntime.isJSPrimitive(constantOperand)) {
                return JSConstantNode.create(JSRuntime.toNumeric(constantOperand));
            }
        }
        return JSToNumericWrapperNodeGen.create(child, toNumericOperand);
    }

    public static JavaScriptNode createToNumericOperand(JavaScriptNode child) {
        return create(child, true);
    }

    @Specialization
    protected static int doInt(int value) {
        return value;
    }

    @Specialization
    protected static double doDouble(double value) {
        return value;
    }

    @Specialization(guards = "!value.isForeign()")
    protected static BigInt doBigInt(BigInt value) {
        return value;
    }

    @Specialization(guards = "value.isForeign()")
    protected static double doForeignBigInt(BigInt value) {
        return value.doubleValue();
    }

    @Specialization(guards = {"isToNumericOperand()"})
    protected Object doOverloaded(JSOverloadedOperatorsObject arg) {
        checkOverloadedOperatorsAllowed(arg, this);
        return arg;
    }

    @Specialization(guards = {"isToNumericOperand()", "!hasOverloadedOperators(value)"})
    protected final Object doToNumericOperandOther(Object value,
                    @Shared @Cached("createHintNumber()") JSToPrimitiveNode toPrimitiveNode,
                    @Shared @Cached PrimitiveToNumericOrNullNode numericOrNullNode,
                    @Shared @Cached JSToNumberNode toNumberNode) {
        Object primValue = toPrimitiveNode.execute(value);
        Object alreadyNumeric = numericOrNullNode.execute(this, primValue);
        if (alreadyNumeric != null) {
            return alreadyNumeric;
        }
        return toNumberNode.executeNumber(primValue);
    }

    @Specialization(guards = {"!isToNumericOperand()", "!isBigInt(value)"})
    protected final Object doToNumericOther(Object value,
                    @Shared @Cached("createHintNumber()") JSToPrimitiveNode toPrimitiveNode,
                    @Shared @Cached PrimitiveToNumericOrNullNode numericOrNullNode,
                    @Shared @Cached JSToNumberNode toNumberNode) {
        Object primValue = toPrimitiveNode.execute(value);
        Object alreadyNumeric = numericOrNullNode.execute(this, primValue);
        if (alreadyNumeric != null) {
            return alreadyNumeric;
        }
        return toNumberNode.executeNumber(primValue);
    }

    @Idempotent
    protected final boolean isToNumericOperand() {
        return toNumericOperand;
    }

    public abstract static class JSToNumericWrapperNode extends JSUnaryNode {

        protected final boolean toNumericOperand;

        protected JSToNumericWrapperNode(JavaScriptNode operand, boolean toNumericOperand) {
            super(operand);
            this.toNumericOperand = toNumericOperand;
        }

        @Specialization
        protected static Object doDefault(Object value,
                        @Cached("create(toNumericOperand)") JSToNumericNode toNumericNode) {
            return toNumericNode.execute(value);
        }

        @Override
        protected JavaScriptNode copyUninitialized(Set> materializedTags) {
            return create(cloneUninitialized(getOperand(), materializedTags), toNumericOperand);
        }

        @Override
        public String expressionToString() {
            return getOperand().expressionToString();
        }
    }

    /**
     * Returns true if the value is already a numeric value that should not be converted ToNumber.
     */
    @ImportStatic(JSToNumericNode.class)
    @GenerateInline
    @GenerateCached(false)
    protected abstract static class PrimitiveToNumericOrNullNode extends JavaScriptBaseNode {

        public abstract Object execute(Node node, Object value);

        @Specialization(guards = "!value.isForeign()")
        protected static BigInt doBigInt(BigInt value) {
            return value;
        }

        @Specialization(guards = "value.isForeign()")
        protected static double doForeignBigInt(BigInt value) {
            return value.doubleValue();
        }

        @Specialization
        protected static double doLong(long value) {
            return value;
        }

        @Fallback
        protected static Object doOther(@SuppressWarnings("unused") Object value) {
            return null;
        }
    }
}