/*
 * Copyright (c) 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.graal.java;

import com.oracle.graal.api.code.*;
import com.oracle.graal.api.meta.*;
import com.oracle.graal.api.replacements.*;
import com.oracle.graal.nodes.*;
import com.oracle.graal.nodes.calc.*;
import com.oracle.graal.nodes.extended.*;
import com.oracle.graal.nodes.spi.*;

/**
 * Used by a {@link GraphBuilderPlugin} to interface with a graph builder object.
 */
public interface GraphBuilderContext {

    <T extends ControlSinkNode> T append(T fixed);

    <T extends ControlSplitNode> T append(T fixed);

    <T extends FixedWithNextNode> T append(T fixed);

    <T extends FloatingNode> T append(T value);

    <T extends ValueNode> T append(T value);

    StampProvider getStampProvider();

    MetaAccessProvider getMetaAccess();

    Assumptions getAssumptions();

    ConstantReflectionProvider getConstantReflection();

    SnippetReflectionProvider getSnippetReflection();

    void push(Kind kind, ValueNode value);

    StructuredGraph getGraph();

    /**
     * Determines if the graph builder is parsing a snippet or method substitution.
     */
    boolean parsingReplacement();

    /**
     * @see GuardingPiNode#nullCheckedValue(ValueNode)
     */
    static ValueNode nullCheckedValue(GraphBuilderContext builder, ValueNode value) {
        ValueNode nonNullValue = GuardingPiNode.nullCheckedValue(value);
        if (nonNullValue != value) {
            builder.append((FixedWithNextNode) nonNullValue);
        }
        return nonNullValue;
    }

    GuardingNode getCurrentBlockGuard();
}