/*
 * Copyright (c) 2014, 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.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * 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.ruby.parser;

import com.oracle.truffle.api.nodes.instrument.*;
import com.oracle.truffle.ruby.nodes.*;
import com.oracle.truffle.ruby.runtime.methods.*;

public interface RubyNodeInstrumenter {

    /**
     * Adds instrumentation support at a node that should be considered a member of
     * {@link NodePhylum#STATEMENT}, possibly returning a new {@link InstrumentationProxyNode} that
     * holds the original as its child.
     */
    RubyNode instrumentAsStatement(RubyNode node);

    /**
     * Adds instrumentation support at a node that should be considered a member of
     * {@link NodePhylum#CALL}, possibly returning a new {@link InstrumentationProxyNode} that holds
     * the original as its child.
     */
    RubyNode instrumentAsCall(RubyNode node, String callName);

    /**
     * Adds instrumentation support at a node that should be considered a member of
     * {@link NodePhylum#ASSIGNMENT}, possibly returning a new {@link InstrumentationProxyNode} that
     * holds the original as its child.
     */
    RubyNode instrumentAsLocalAssignment(RubyNode node, UniqueMethodIdentifier methodIdentifier, String localName);

}