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  *
  25  * Note: The file format is not considered stable yet. So expect
  26  * incompatibilities between file formats of different libfirm versions.
  27  */
  28 #ifndef FIRM_IR_IRIO_H
  29 #define FIRM_IR_IRIO_H
  30
  31 #include <stdio.h>
  32
  33 #include "firm_types.h"
  34 #include "begin.h"
  35
  36 /**
  37  * Exports the whole irp to the given file in a textual form.
  38  * Exports all types, all ir graphs, and the constant graph.
  39  *
  40  * @param filename  the name of the resulting file
  41  * @return  0 if no errors occured, other values in case of errors
  42  */
  43 FIRM_API int ir_export(const char *filename);
  44
  45 /**
  46  * same as ir_export but writes to a FILE*
  47  * @note As with any FILE* errors are indicated by ferror(output)
  48  */
  49 FIRM_API void ir_export_file(FILE *output);
  50
  51 /**
  52  * Imports the data stored in the given file.
  53  * Imports any type graphs and ir graphs contained in the file.
  54  *
  55  * @param filename  the name of the file
  56  * @returns 0 if no errors occured, other values in case of errors
  57  */
  58 FIRM_API int ir_import(const char *filename);
  59
  60 /**
  61  * same as ir_import but imports from a FILE*
  62  */
  63 FIRM_API int ir_import_file(FILE *input, const char *inputname);
  64
  65 #include "end.h"
  66
  67 #endif