/*
 * Copyright (c) 2012, 2015, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.oracle.truffle.sl.nodes.instrument;

import com.oracle.truffle.api.frame.*;
import com.oracle.truffle.api.instrument.*;
import com.oracle.truffle.api.instrument.ProbeNode.WrapperNode;
import com.oracle.truffle.api.nodes.*;
import com.oracle.truffle.sl.nodes.*;
import com.oracle.truffle.sl.runtime.*;

/**
 * A Truffle node that can be inserted into a Simple AST (assumed not to have executed yet) to
 * enable "instrumentation" of an {@link SLExpressionNode}. Tools wishing to interact with AST
 * execution may attach {@link Instrument}s to the {@link Probe} uniquely associated with the
 * wrapper, and to which this wrapper routes execution events.
 */
@NodeInfo(cost = NodeCost.NONE)
public final class SLExpressionWrapperNode extends SLExpressionNode implements WrapperNode {
    @Child private SLExpressionNode child;
    @Child private ProbeNode probeNode;

    /**
     * Constructor.
     *
     * @param child The {@link SLExpressionNode} that this wrapper is wrapping
     */
    public SLExpressionWrapperNode(SLExpressionNode child) {
        super(child.getSourceSection());
        assert !(child instanceof SLExpressionWrapperNode);
        this.child = child;
    }

    public String instrumentationInfo() {
        return "Wrapper node for SL Expressions";
    }

    @Override
    public boolean isInstrumentable() {
        return false;
    }

    @Override
    public SLExpressionNode getNonWrapperNode() {
        return child;
    }

    public void insertProbe(ProbeNode newProbeNode) {
        this.probeNode = newProbeNode;
    }

    public Probe getProbe() {
        return probeNode.getProbe();
    }

    public Node getChild() {
        return child;
    }

    @Override
    public Object executeGeneric(VirtualFrame vFrame) {

        probeNode.enter(child, vFrame);
        Object result;

        try {
            result = child.executeGeneric(vFrame);
            probeNode.returnValue(child, vFrame, result);
        } catch (KillException e) {
            throw (e);
        } catch (Exception e) {
            probeNode.returnExceptional(child, vFrame, e);
            throw (e);
        }
        return result;
    }

    @Override
    public long executeLong(VirtualFrame vFrame) throws UnexpectedResultException {
        return SLTypesGen.expectLong(executeGeneric(vFrame));
    }

    @Override
    public boolean executeBoolean(VirtualFrame vFrame) throws UnexpectedResultException {
        return SLTypesGen.expectBoolean(executeGeneric(vFrame));
    }

    @Override
    public SLFunction executeFunction(VirtualFrame vFrame) throws UnexpectedResultException {
        probeNode.enter(child, vFrame);
        SLFunction result;

        try {
            result = child.executeFunction(vFrame);
            probeNode.returnValue(child, vFrame, result);
        } catch (Exception e) {
            probeNode.returnExceptional(child, vFrame, e);
            throw (e);
        }
        return result;
    }

}