X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=include%2Flibfirm%2Firio.h;h=1e38ad981f043188f340741915b596e3aab5af8b;hb=b9a1bfdbce56c76bd4d5ff772963628523ecfc41;hp=1f4fad500dfecc754a53f9e0d847da2f16daeabc;hpb=069bc5fb3a3fa261f842524415fcdb040efd767f;p=libfirm diff --git a/include/libfirm/irio.h b/include/libfirm/irio.h index 1f4fad500..1e38ad981 100644 --- a/include/libfirm/irio.h +++ b/include/libfirm/irio.h @@ -19,12 +19,8 @@ /** * @file - * @brief Import/export textual representation of firm. + * @brief Input/Output textual representation of firm. * @author Moritz Kroll - * @version $Id$ - * - * Note: The file format is not considered stable yet. So expect - * incompatibilities between file formats of different libfirm versions. */ #ifndef FIRM_IR_IRIO_H #define FIRM_IR_IRIO_H @@ -32,44 +28,46 @@ #include #include "firm_types.h" +#include "begin.h" + +/** + * @defgroup irio Input and Output + * @note The file format is not considered stable yet. So expect + * incompatibilities between file formats of different libfirm versions. + * @{ + */ /** * Exports the whole irp to the given file in a textual form. + * Exports all types, all ir graphs, and the constant graph. * * @param filename the name of the resulting file - * - * Exports all types, all ir graphs, and the constant graph. + * @return 0 if no errors occured, other values in case of errors */ -void ir_export(const char *filename); +FIRM_API int ir_export(const char *filename); /** * same as ir_export but writes to a FILE* + * @note As with any FILE* errors are indicated by ferror(output) */ -void ir_export_file(FILE *output, const char *outputname); - -/** - * Write the given ir graph to a stream in a textual format - * - * @param irg the ir graph - * @param output output stream the irg is written to - * @param outputname a name for the output stream (used for error messages) - * - * Exports the type graph used by the given graph and the graph itself. - */ -void ir_export_irg(ir_graph *irg, FILE *output, const char *outputname); +FIRM_API void ir_export_file(FILE *output); /** * Imports the data stored in the given file. + * Imports any type graphs and ir graphs contained in the file. * * @param filename the name of the file - * - * Imports any type graphs and ir graphs contained in the file. + * @returns 0 if no errors occured, other values in case of errors */ -void ir_import(const char *filename); +FIRM_API int ir_import(const char *filename); /** * same as ir_import but imports from a FILE* */ -void ir_import_file(FILE *input, const char *inputname); +FIRM_API int ir_import_file(FILE *input, const char *inputname); + +/** @} */ + +#include "end.h" #endif