| Daniel Veillard | 1a8741c | 2004-03-04 13:40:59 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Summary: the XML document serializer |
| 3 | * Description: API to save document or subtree of document |
| 4 | * |
| 5 | * Copy: See Copyright for the status of this software. |
| 6 | * |
| 7 | * Author: Daniel Veillard |
| 8 | */ |
| 9 | |
| 10 | #ifndef __XML_XMLSAVE_H__ |
| 11 | #define __XML_XMLSAVE_H__ |
| 12 | |
| 13 | #include <libxml/xmlversion.h> |
| 14 | #include <libxml/tree.h> |
| Daniel Veillard | 3995bc3 | 2004-05-15 18:57:31 +0000 | [diff] [blame] | 15 | #include <libxml/encoding.h> |
| Daniel Veillard | 1a8741c | 2004-03-04 13:40:59 +0000 | [diff] [blame] | 16 | #include <libxml/xmlIO.h> |
| 17 | |
| Daniel Veillard | 2156d43 | 2004-03-04 15:59:36 +0000 | [diff] [blame] | 18 | #ifdef LIBXML_OUTPUT_ENABLED |
| Daniel Veillard | 1a8741c | 2004-03-04 13:40:59 +0000 | [diff] [blame] | 19 | #ifdef __cplusplus |
| 20 | extern "C" { |
| 21 | #endif |
| 22 | |
| Daniel Veillard | 6fc5db0 | 2005-01-16 00:05:58 +0000 | [diff] [blame] | 23 | /** |
| 24 | * xmlSaveOption: |
| 25 | * |
| 26 | * This is the set of XML save options that can be passed down |
| 27 | * to the xmlSaveToFd() and similar calls. |
| 28 | */ |
| 29 | typedef enum { |
| Daniel Veillard | 100e180 | 2005-08-08 14:44:11 +0000 | [diff] [blame] | 30 | XML_SAVE_FORMAT = 1<<0, /* format save output */ |
| Rob Richards | 2ce51c0 | 2005-09-12 12:16:35 +0000 | [diff] [blame] | 31 | XML_SAVE_NO_DECL = 1<<1, /* drop the xml declaration */ |
| 32 | XML_SAVE_NO_EMPTY = 1<<2 /* no empty tags */ |
| Daniel Veillard | 6fc5db0 | 2005-01-16 00:05:58 +0000 | [diff] [blame] | 33 | } xmlSaveOption; |
| 34 | |
| 35 | |
| Daniel Veillard | 1a8741c | 2004-03-04 13:40:59 +0000 | [diff] [blame] | 36 | typedef struct _xmlSaveCtxt xmlSaveCtxt; |
| 37 | typedef xmlSaveCtxt *xmlSaveCtxtPtr; |
| 38 | |
| 39 | XMLPUBFUN xmlSaveCtxtPtr XMLCALL |
| 40 | xmlSaveToFd (int fd, |
| 41 | const char *encoding, |
| 42 | int options); |
| 43 | XMLPUBFUN xmlSaveCtxtPtr XMLCALL |
| 44 | xmlSaveToFilename (const char *filename, |
| 45 | const char *encoding, |
| 46 | int options); |
| Daniel Veillard | a235132 | 2004-06-27 12:08:10 +0000 | [diff] [blame] | 47 | /****** |
| 48 | Not yet implemented. |
| 49 | |
| Daniel Veillard | 1a8741c | 2004-03-04 13:40:59 +0000 | [diff] [blame] | 50 | XMLPUBFUN xmlSaveCtxtPtr XMLCALL |
| 51 | xmlSaveToBuffer (xmlBufferPtr buffer, |
| 52 | const char *encoding, |
| 53 | int options); |
| Daniel Veillard | a235132 | 2004-06-27 12:08:10 +0000 | [diff] [blame] | 54 | ******/ |
| Daniel Veillard | 1a8741c | 2004-03-04 13:40:59 +0000 | [diff] [blame] | 55 | XMLPUBFUN xmlSaveCtxtPtr XMLCALL |
| 56 | xmlSaveToIO (xmlOutputWriteCallback iowrite, |
| 57 | xmlOutputCloseCallback ioclose, |
| 58 | void *ioctx, |
| 59 | const char *encoding, |
| 60 | int options); |
| 61 | |
| 62 | XMLPUBFUN long XMLCALL |
| 63 | xmlSaveDoc (xmlSaveCtxtPtr ctxt, |
| 64 | xmlDocPtr doc); |
| 65 | XMLPUBFUN long XMLCALL |
| 66 | xmlSaveTree (xmlSaveCtxtPtr ctxt, |
| 67 | xmlNodePtr node); |
| 68 | |
| 69 | XMLPUBFUN int XMLCALL |
| 70 | xmlSaveFlush (xmlSaveCtxtPtr ctxt); |
| 71 | XMLPUBFUN int XMLCALL |
| 72 | xmlSaveClose (xmlSaveCtxtPtr ctxt); |
| Daniel Veillard | 3995bc3 | 2004-05-15 18:57:31 +0000 | [diff] [blame] | 73 | XMLPUBFUN int XMLCALL |
| 74 | xmlSaveSetEscape (xmlSaveCtxtPtr ctxt, |
| 75 | xmlCharEncodingOutputFunc escape); |
| 76 | XMLPUBFUN int XMLCALL |
| 77 | xmlSaveSetAttrEscape (xmlSaveCtxtPtr ctxt, |
| 78 | xmlCharEncodingOutputFunc escape); |
| Daniel Veillard | 1a8741c | 2004-03-04 13:40:59 +0000 | [diff] [blame] | 79 | #ifdef __cplusplus |
| 80 | } |
| 81 | #endif |
| Daniel Veillard | 2156d43 | 2004-03-04 15:59:36 +0000 | [diff] [blame] | 82 | #endif /* LIBXML_OUTPUT_ENABLED */ |
| Daniel Veillard | 1a8741c | 2004-03-04 13:40:59 +0000 | [diff] [blame] | 83 | #endif /* __XML_XMLSAVE_H__ */ |
| 84 | |
| 85 | |