/*
 * Copyright (c) 2020, 2021, 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.graal.python.nodes.argument.keywords;

import com.oracle.graal.python.builtins.objects.common.EmptyStorage;
import com.oracle.graal.python.builtins.objects.common.HashingStorage;
import com.oracle.graal.python.builtins.objects.common.HashingStorageLibrary;
import com.oracle.graal.python.builtins.objects.common.SequenceNodes;
import com.oracle.graal.python.builtins.objects.common.SequenceStorageNodes;
import com.oracle.graal.python.builtins.objects.dict.PDict;
import com.oracle.graal.python.builtins.objects.function.BuiltinMethodDescriptors;
import com.oracle.graal.python.lib.PyObjectCallMethodObjArgs;
import com.oracle.graal.python.lib.PyObjectGetItem;
import com.oracle.graal.python.nodes.PGuards;
import com.oracle.graal.python.nodes.PNodeWithContext;
import com.oracle.graal.python.nodes.attributes.LookupCallableSlotInMRONode;
import com.oracle.graal.python.nodes.builtins.ListNodes;
import com.oracle.graal.python.nodes.expression.ExpressionNode;
import com.oracle.graal.python.nodes.object.GetClassNode;
import com.oracle.graal.python.nodes.object.IsBuiltinClassProfile;
import com.oracle.graal.python.runtime.exception.PException;
import com.oracle.graal.python.runtime.object.PythonObjectFactory;
import com.oracle.graal.python.runtime.sequence.PSequence;
import com.oracle.graal.python.runtime.sequence.storage.SequenceStorage;
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.Specialization;
import com.oracle.truffle.api.frame.VirtualFrame;
import com.oracle.truffle.api.library.CachedLibrary;
import com.oracle.truffle.api.nodes.ExplodeLoop;
import com.oracle.truffle.api.profiles.BranchProfile;
import com.oracle.truffle.api.profiles.ConditionProfile;

public abstract class ConcatKeywordsNode extends ExpressionNode {

    @Children final ExpressionNode[] mappables;

    protected ConcatKeywordsNode(ExpressionNode... mappablesNodes) {
        this.mappables = mappablesNodes;
    }

    @ExplodeLoop
    @Specialization
    protected Object concat(VirtualFrame frame,
                    @Cached("createConcatNodes()") ConcatDictToStorageNode[] concatNodes,
                    @Cached PythonObjectFactory factory) {
        HashingStorage result = EmptyStorage.INSTANCE; // The node has a special case for empty
                                                       // storage
        for (int i = 0; i < mappables.length; i++) {
            result = concatNodes[i].execute(frame, result, mappables[i].execute(frame));
        }
        return factory.createDict(result);
    }

    protected ConcatDictToStorageNode[] createConcatNodes() {
        ConcatDictToStorageNode[] nodes = new ConcatDictToStorageNode[mappables.length];
        for (int i = 0; i < nodes.length; i++) {
            nodes[i] = ConcatKeywordsNodeGen.ConcatDictToStorageNodeGen.create();
        }
        return nodes;
    }

    protected abstract static class ConcatDictToStorageNode extends PNodeWithContext {
        public abstract HashingStorage execute(VirtualFrame frame, HashingStorage dest, Object other);

        @Specialization(guards = "hasBuiltinIter(other, getClassNode, lookupIter)", limit = "1")
        HashingStorage doBuiltinDictEmptyDest(@SuppressWarnings("unused") EmptyStorage dest, PDict other,
                        @SuppressWarnings("unused") @Shared("getClassNode") @Cached GetClassNode getClassNode,
                        @SuppressWarnings("unused") @Shared("lookupIter") @Cached(parameters = "Iter") LookupCallableSlotInMRONode lookupIter,
                        @Shared("hlib") @CachedLibrary(limit = "3") HashingStorageLibrary hlib) {
            return hlib.copy(other.getDictStorage());
        }

        @Specialization(guards = "hasBuiltinIter(other, getClassNode, lookupIter)", limit = "1")
        HashingStorage doBuiltinDict(VirtualFrame frame, HashingStorage dest, PDict other,
                        @SuppressWarnings("unused") @Shared("getClassNode") @Cached GetClassNode getClassNode,
                        @SuppressWarnings("unused") @Shared("lookupIter") @Cached(parameters = "Iter") LookupCallableSlotInMRONode lookupIter,
                        @Shared("hlib") @CachedLibrary(limit = "3") HashingStorageLibrary hlib,
                        @Shared("hasFrame") @Cached ConditionProfile hasFrame,
                        @Shared("sameKeyProfile") @Cached BranchProfile sameKeyProfile) {
            HashingStorage result = dest;
            HashingStorage otherStorage = other.getDictStorage();
            for (Object key : hlib.keys(otherStorage)) {
                Object value = hlib.getItemWithFrame(otherStorage, key, hasFrame, frame);
                if (hlib.hasKey(result, key)) {
                    sameKeyProfile.enter();
                    throw new SameDictKeyException(key);
                }
                result = hlib.setItemWithFrame(result, key, value, hasFrame, frame);
            }
            return result;
        }

        @Fallback
        HashingStorage doMapping(VirtualFrame frame, HashingStorage dest, Object other,
                        @Shared("hlib") @CachedLibrary(limit = "3") HashingStorageLibrary hlib,
                        @Shared("hasFrame") @Cached ConditionProfile hasFrame,
                        @Shared("sameKeyProfile") @Cached BranchProfile sameKeyProfile,
                        @Cached PyObjectCallMethodObjArgs callKeys,
                        @Cached IsBuiltinClassProfile errorProfile,
                        @Cached ListNodes.FastConstructListNode asList,
                        @Cached SequenceNodes.GetSequenceStorageNode getSequenceStorage,
                        @Cached SequenceStorageNodes.LenNode lenNode,
                        @Cached SequenceStorageNodes.GetItemScalarNode sequenceGetItem,
                        @Cached PyObjectGetItem getItem) {
            HashingStorage result = dest;
            try {
                PSequence keys = asList.execute(frame, callKeys.execute(frame, other, "keys"));
                SequenceStorage keysStorage = getSequenceStorage.execute(keys);
                int keysLen = lenNode.execute(keysStorage);
                for (int i = 0; i < keysLen; i++) {
                    Object key = sequenceGetItem.execute(keysStorage, i);
                    if (hlib.hasKey(result, key)) {
                        sameKeyProfile.enter();
                        throw new SameDictKeyException(key);
                    }
                    Object value = getItem.execute(frame, other, key);
                    result = hlib.setItemWithFrame(result, key, value, hasFrame, frame);
                }
                return result;
            } catch (PException e) {
                e.expectAttributeError(errorProfile);
                throw new NonMappingException(other);
            }
        }

        /* CPython tests that tp_iter is dict_iter */
        protected static boolean hasBuiltinIter(PDict dict, GetClassNode getClassNode, LookupCallableSlotInMRONode lookupIter) {
            return PGuards.isBuiltinDict(dict) || lookupIter.execute(getClassNode.execute(dict)) == BuiltinMethodDescriptors.DICT_ITER;
        }
    }
}
