2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief Input/Output textual representation of firm.
23 * @author Moritz Kroll
25 #ifndef FIRM_IR_IRIO_H
26 #define FIRM_IR_IRIO_H
30 #include "firm_types.h"
34 * @defgroup irio Input and Output
35 * @note The file format is not considered stable yet. So expect
36 * incompatibilities between file formats of different libfirm versions.
41 * Exports the whole irp to the given file in a textual form.
42 * Exports all types, all ir graphs, and the constant graph.
44 * @param filename the name of the resulting file
45 * @return 0 if no errors occured, other values in case of errors
47 FIRM_API int ir_export(const char *filename);
50 * same as ir_export but writes to a FILE*
51 * @note As with any FILE* errors are indicated by ferror(output)
53 FIRM_API void ir_export_file(FILE *output);
56 * Imports the data stored in the given file.
57 * Imports any type graphs and ir graphs contained in the file.
59 * @param filename the name of the file
60 * @returns 0 if no errors occured, other values in case of errors
62 FIRM_API int ir_import(const char *filename);
65 * same as ir_import but imports from a FILE*
67 FIRM_API int ir_import_file(FILE *input, const char *inputname);