nsz Git - libfirm/blob - include/libfirm/irio.h

   1 /*
   2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief   Import/export textual representation of firm.
  23  * @author  Moritz Kroll
  24  * @version $Id$
  25  *
  26  * Note: The file format is not considered stable yet. So expect
  27  * incompatibilities between file formats of different libfirm versions.
  28  */
  29 #ifndef FIRM_IR_IRIO_H
  30 #define FIRM_IR_IRIO_H
  31
  32 #include <stdio.h>
  33
  34 #include "firm_types.h"
  35 #include "begin.h"
  36
  37 /**
  38  * Exports the whole irp to the given file in a textual form.
  39  *
  40  * @param filename  the name of the resulting file
  41  *
  42  * Exports all types, all ir graphs, and the constant graph.
  43  */
  44 FIRM_API void ir_export(const char *filename);
  45
  46 /**
  47  * same as ir_export but writes to a FILE*
  48  */
  49 FIRM_API void ir_export_file(FILE *output, const char *outputname);
  50
  51 /**
  52  * Write the given ir graph to a stream in a textual format
  53  *
  54  * @param irg         the ir graph
  55  * @param output      output stream the irg is written to
  56  * @param outputname  a name for the output stream (used for error messages)
  57  *
  58  * Exports the type graph used by the given graph and the graph itself.
  59  */
  60 FIRM_API void ir_export_irg(ir_graph *irg, FILE *output,
  61                             const char *outputname);
  62
  63 /**
  64  * Imports the data stored in the given file.
  65  *
  66  * @param filename  the name of the file
  67  *
  68  * Imports any type graphs and ir graphs contained in the file.
  69  */
  70 FIRM_API void ir_import(const char *filename);
  71
  72 /**
  73  * same as ir_import but imports from a FILE*
  74  */
  75 FIRM_API void ir_import_file(FILE *input, const char *inputname);
  76
  77 #include "end.h"
  78
  79 #endif