libxml2/libxml/xmlsave.h

0001 /*
0002  * Summary: the XML document serializer
0003  * Description: API to save document or subtree of document
0004  *
0005  * Copy: See Copyright for the status of this software.
0006  *
0007  * Author: Daniel Veillard
0008  */
0009
0010 #ifndef __XML_XMLSAVE_H__
0011 #define __XML_XMLSAVE_H__
0012
0013 #include <libxml/xmlversion.h>
0014 #include <libxml/tree.h>
0015 #include <libxml/encoding.h>
0016 #include <libxml/xmlIO.h>
0017
0018 #ifdef LIBXML_OUTPUT_ENABLED
0019 #ifdef __cplusplus
0020 extern "C" {
0021 #endif
0022
0023 /**
0024  * xmlSaveOption:
0025  *
0026  * This is the set of XML save options that can be passed down
0027  * to the xmlSaveToFd() and similar calls.
0028  */
0029 typedef enum {
0030     XML_SAVE_FORMAT     = 1<<0, /* format save output */
0031     XML_SAVE_NO_DECL    = 1<<1, /* drop the xml declaration */
0032     XML_SAVE_NO_EMPTY   = 1<<2, /* no empty tags */
0033     XML_SAVE_NO_XHTML   = 1<<3, /* disable XHTML1 specific rules */
0034     XML_SAVE_XHTML  = 1<<4, /* force XHTML1 specific rules */
0035     XML_SAVE_AS_XML     = 1<<5, /* force XML serialization on HTML doc */
0036     XML_SAVE_AS_HTML    = 1<<6, /* force HTML serialization on XML doc */
0037     XML_SAVE_WSNONSIG   = 1<<7  /* format with non-significant whitespace */
0038 } xmlSaveOption;
0039
0040
0041 typedef struct _xmlSaveCtxt xmlSaveCtxt;
0042 typedef xmlSaveCtxt *xmlSaveCtxtPtr;
0043
0044 XMLPUBFUN xmlSaveCtxtPtr
0045         xmlSaveToFd     (int fd,
0046                      const char *encoding,
0047                      int options);
0048 XMLPUBFUN xmlSaveCtxtPtr
0049         xmlSaveToFilename   (const char *filename,
0050                      const char *encoding,
0051                      int options);
0052
0053 XMLPUBFUN xmlSaveCtxtPtr
0054         xmlSaveToBuffer     (xmlBufferPtr buffer,
0055                      const char *encoding,
0056                      int options);
0057
0058 XMLPUBFUN xmlSaveCtxtPtr
0059         xmlSaveToIO     (xmlOutputWriteCallback iowrite,
0060                      xmlOutputCloseCallback ioclose,
0061                      void *ioctx,
0062                      const char *encoding,
0063                      int options);
0064
0065 XMLPUBFUN long
0066         xmlSaveDoc      (xmlSaveCtxtPtr ctxt,
0067                      xmlDocPtr doc);
0068 XMLPUBFUN long
0069         xmlSaveTree     (xmlSaveCtxtPtr ctxt,
0070                      xmlNodePtr node);
0071
0072 XMLPUBFUN int
0073         xmlSaveFlush        (xmlSaveCtxtPtr ctxt);
0074 XMLPUBFUN int
0075         xmlSaveClose        (xmlSaveCtxtPtr ctxt);
0076 XMLPUBFUN int
0077         xmlSaveFinish       (xmlSaveCtxtPtr ctxt);
0078 XMLPUBFUN int
0079         xmlSaveSetEscape    (xmlSaveCtxtPtr ctxt,
0080                      xmlCharEncodingOutputFunc escape);
0081 XMLPUBFUN int
0082         xmlSaveSetAttrEscape    (xmlSaveCtxtPtr ctxt,
0083                      xmlCharEncodingOutputFunc escape);
0084
0085 XML_DEPRECATED
0086 XMLPUBFUN int
0087                 xmlThrDefIndentTreeOutput(int v);
0088 XML_DEPRECATED
0089 XMLPUBFUN const char *
0090                 xmlThrDefTreeIndentString(const char * v);
0091 XML_DEPRECATED
0092 XMLPUBFUN int
0093                 xmlThrDefSaveNoEmptyTags(int v);
0094
0095 #ifdef __cplusplus
0096 }
0097 #endif
0098
0099 #endif /* LIBXML_OUTPUT_ENABLED */
0100 #endif /* __XML_XMLSAVE_H__ */
0101
0102