/*
 * Copyright (c) 2020, 2020, 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.array;

import static com.oracle.truffle.js.runtime.builtins.JSAbstractArray.arraySetArrayType;

import java.util.Objects;

import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
import com.oracle.truffle.api.dsl.Cached;
import com.oracle.truffle.api.dsl.Specialization;
import com.oracle.truffle.api.object.DynamicObject;
import com.oracle.truffle.js.nodes.JavaScriptBaseNode;
import com.oracle.truffle.js.runtime.JSContext;
import com.oracle.truffle.js.runtime.array.ScriptArray;
import com.oracle.truffle.js.runtime.builtins.JSArray;

Deletes an index from a JS array. Does not shrink the array. Used by delete. /**
 * Deletes an index from a JS array. Does not shrink the array.
 *
 * Used by {@code delete}.
 */
public abstract class JSArrayDeleteIndexNode extends JavaScriptBaseNode {

    protected final JSContext context;
    protected final boolean strict;

    protected JSArrayDeleteIndexNode(JSContext context, boolean strict) {
        this.context = Objects.requireNonNull(context);
        this.strict = strict;
    }

    public static JSArrayDeleteIndexNode create(JSContext context, boolean strict) {
        return JSArrayDeleteIndexNodeGen.create(context, strict);
    }

    public abstract boolean execute(DynamicObject array, ScriptArray arrayType, long index);

    @Specialization(guards = {"cachedArrayType.isInstance(arrayType)"}, limit = "5")
    protected boolean doCached(DynamicObject array, @SuppressWarnings("unused") ScriptArray arrayType, long index,
                    @Cached("arrayType") @SuppressWarnings("unused") ScriptArray cachedArrayType) {
        assert JSArray.isJSFastArray(array);
        if (cachedArrayType.canDeleteElement(array, index, strict)) {
            arraySetArrayType(array, cachedArrayType.deleteElement(array, index, strict));
            return true;
        } else {
            return false;
        }
    }

    @TruffleBoundary
    @Specialization(replaces = {"doCached"})
    protected boolean doUncached(DynamicObject array, ScriptArray arrayType, long index) {
        return doCached(array, arrayType, index, arrayType);
    }
}