libxml2/libxml/xinclude.h

0001 /*
0002  * Summary: implementation of XInclude
0003  * Description: API to handle XInclude processing,
0004  * implements the
0005  * World Wide Web Consortium Last Call Working Draft 10 November 2003
0006  * http://www.w3.org/TR/2003/WD-xinclude-20031110
0007  *
0008  * Copy: See Copyright for the status of this software.
0009  *
0010  * Author: Daniel Veillard
0011  */
0012
0013 #ifndef __XML_XINCLUDE_H__
0014 #define __XML_XINCLUDE_H__
0015
0016 #include <libxml/xmlversion.h>
0017 #include <libxml/xmlerror.h>
0018 #include <libxml/tree.h>
0019
0020 #ifdef LIBXML_XINCLUDE_ENABLED
0021
0022 #ifdef __cplusplus
0023 extern "C" {
0024 #endif
0025
0026 /**
0027  * XINCLUDE_NS:
0028  *
0029  * Macro defining the Xinclude namespace: http://www.w3.org/2003/XInclude
0030  */
0031 #define XINCLUDE_NS (const xmlChar *) "http://www.w3.org/2003/XInclude"
0032 /**
0033  * XINCLUDE_OLD_NS:
0034  *
0035  * Macro defining the draft Xinclude namespace: http://www.w3.org/2001/XInclude
0036  */
0037 #define XINCLUDE_OLD_NS (const xmlChar *) "http://www.w3.org/2001/XInclude"
0038 /**
0039  * XINCLUDE_NODE:
0040  *
0041  * Macro defining "include"
0042  */
0043 #define XINCLUDE_NODE (const xmlChar *) "include"
0044 /**
0045  * XINCLUDE_FALLBACK:
0046  *
0047  * Macro defining "fallback"
0048  */
0049 #define XINCLUDE_FALLBACK (const xmlChar *) "fallback"
0050 /**
0051  * XINCLUDE_HREF:
0052  *
0053  * Macro defining "href"
0054  */
0055 #define XINCLUDE_HREF (const xmlChar *) "href"
0056 /**
0057  * XINCLUDE_PARSE:
0058  *
0059  * Macro defining "parse"
0060  */
0061 #define XINCLUDE_PARSE (const xmlChar *) "parse"
0062 /**
0063  * XINCLUDE_PARSE_XML:
0064  *
0065  * Macro defining "xml"
0066  */
0067 #define XINCLUDE_PARSE_XML (const xmlChar *) "xml"
0068 /**
0069  * XINCLUDE_PARSE_TEXT:
0070  *
0071  * Macro defining "text"
0072  */
0073 #define XINCLUDE_PARSE_TEXT (const xmlChar *) "text"
0074 /**
0075  * XINCLUDE_PARSE_ENCODING:
0076  *
0077  * Macro defining "encoding"
0078  */
0079 #define XINCLUDE_PARSE_ENCODING (const xmlChar *) "encoding"
0080 /**
0081  * XINCLUDE_PARSE_XPOINTER:
0082  *
0083  * Macro defining "xpointer"
0084  */
0085 #define XINCLUDE_PARSE_XPOINTER (const xmlChar *) "xpointer"
0086
0087 typedef struct _xmlXIncludeCtxt xmlXIncludeCtxt;
0088 typedef xmlXIncludeCtxt *xmlXIncludeCtxtPtr;
0089
0090 /*
0091  * standalone processing
0092  */
0093 XMLPUBFUN int
0094         xmlXIncludeProcess  (xmlDocPtr doc);
0095 XMLPUBFUN int
0096         xmlXIncludeProcessFlags (xmlDocPtr doc,
0097                      int flags);
0098 XMLPUBFUN int
0099         xmlXIncludeProcessFlagsData(xmlDocPtr doc,
0100                      int flags,
0101                      void *data);
0102 XMLPUBFUN int
0103                 xmlXIncludeProcessTreeFlagsData(xmlNodePtr tree,
0104                                          int flags,
0105                                          void *data);
0106 XMLPUBFUN int
0107         xmlXIncludeProcessTree  (xmlNodePtr tree);
0108 XMLPUBFUN int
0109         xmlXIncludeProcessTreeFlags(xmlNodePtr tree,
0110                      int flags);
0111 /*
0112  * contextual processing
0113  */
0114 XMLPUBFUN xmlXIncludeCtxtPtr
0115         xmlXIncludeNewContext   (xmlDocPtr doc);
0116 XMLPUBFUN int
0117         xmlXIncludeSetFlags (xmlXIncludeCtxtPtr ctxt,
0118                      int flags);
0119 XMLPUBFUN void
0120         xmlXIncludeSetErrorHandler(xmlXIncludeCtxtPtr ctxt,
0121                      xmlStructuredErrorFunc handler,
0122                      void *data);
0123 XMLPUBFUN int
0124         xmlXIncludeGetLastError (xmlXIncludeCtxtPtr ctxt);
0125 XMLPUBFUN void
0126         xmlXIncludeFreeContext  (xmlXIncludeCtxtPtr ctxt);
0127 XMLPUBFUN int
0128         xmlXIncludeProcessNode  (xmlXIncludeCtxtPtr ctxt,
0129                      xmlNodePtr tree);
0130 #ifdef __cplusplus
0131 }
0132 #endif
0133
0134 #endif /* LIBXML_XINCLUDE_ENABLED */
0135
0136 #endif /* __XML_XINCLUDE_H__ */