001/*
002 * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation.
008 *
009 * This code is distributed in the hope that it will be useful, but WITHOUT
010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
011 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
012 * version 2 for more details (a copy is included in the LICENSE file that
013 * accompanied this code).
014 *
015 * You should have received a copy of the GNU General Public License version
016 * 2 along with this work; if not, write to the Free Software Foundation,
017 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
018 *
019 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
020 * or visit www.oracle.com if you need additional information or have any
021 * questions.
022 */
023package com.oracle.graal.printer;
024
025import java.io.*;
026
027import jdk.internal.jvmci.meta.*;
028
029import com.oracle.graal.graph.*;
030import com.oracle.graal.phases.schedule.*;
031
032interface GraphPrinter extends Closeable {
033
034    /**
035     * Starts a new group of graphs with the given name, short name and method byte code index (BCI)
036     * as properties.
037     */
038    void beginGroup(String name, String shortName, ResolvedJavaMethod method, int bci) throws IOException;
039
040    /**
041     * Prints an entire {@link Graph} with the specified title, optionally using short names for
042     * nodes.
043     */
044    void print(Graph graph, String title, SchedulePhase predefinedSchedule) throws IOException;
045
046    /**
047     * Ends the current group.
048     */
049    void endGroup() throws IOException;
050
051    @Override
052    void close();
053}