irio.h 1.89 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
/*
 * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
 *
 * This file is part of libFirm.
 *
 * This file may be distributed and/or modified under the terms of the
 * GNU General Public License version 2 as published by the Free Software
 * Foundation and appearing in the file LICENSE.GPL included in the
 * packaging of this file.
 *
 * Licensees holding valid libFirm Professional Edition licenses may use
 * this file in accordance with the libFirm Commercial License.
 * Agreement provided with the Software.
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE.
 */

/**
 * @file
 * @brief   Import/export textual representation of firm.
 * @author  Moritz Kroll
24
25
26
 *
 * Note: The file format is not considered stable yet. So expect
 * incompatibilities between file formats of different libfirm versions.
27
28
29
30
31
32
33
 */
#ifndef FIRM_IR_IRIO_H
#define FIRM_IR_IRIO_H

#include <stdio.h>

#include "firm_types.h"
34
#include "begin.h"
35

36
37
/**
 * Exports the whole irp to the given file in a textual form.
Matthias Braun's avatar
Matthias Braun committed
38
 * Exports all types, all ir graphs, and the constant graph.
39
40
 *
 * @param filename  the name of the resulting file
Matthias Braun's avatar
Matthias Braun committed
41
 * @return  0 if no errors occured, other values in case of errors
42
 */
Matthias Braun's avatar
Matthias Braun committed
43
FIRM_API int ir_export(const char *filename);
44

45
46
/**
 * same as ir_export but writes to a FILE*
Matthias Braun's avatar
Matthias Braun committed
47
 * @note As with any FILE* errors are indicated by ferror(output)
48
 */
Matthias Braun's avatar
Matthias Braun committed
49
FIRM_API void ir_export_file(FILE *output);
50
51
52

/**
 * Imports the data stored in the given file.
Matthias Braun's avatar
Matthias Braun committed
53
 * Imports any type graphs and ir graphs contained in the file.
54
55
 *
 * @param filename  the name of the file
Matthias Braun's avatar
Matthias Braun committed
56
 * @returns 0 if no errors occured, other values in case of errors
57
 */
Matthias Braun's avatar
Matthias Braun committed
58
FIRM_API int ir_import(const char *filename);
59

60
61
62
/**
 * same as ir_import but imports from a FILE*
 */
Matthias Braun's avatar
Matthias Braun committed
63
FIRM_API int ir_import_file(FILE *input, const char *inputname);
64
65

#include "end.h"
66

67
#endif