Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 1 | /* |
Daniel Veillard | be58697 | 2003-11-18 20:56:51 +0000 | [diff] [blame] | 2 | * Summary: implementation of XInclude |
| 3 | * Description: API to handle XInclude processing, |
| 4 | * implements the |
Daniel Veillard | e74d2e1 | 2003-12-09 11:35:37 +0000 | [diff] [blame] | 5 | * World Wide Web Consortium Last Call Working Draft 10 November 2003 |
| 6 | * http://www.w3.org/TR/2003/WD-xinclude-20031110 |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 7 | * |
Daniel Veillard | be58697 | 2003-11-18 20:56:51 +0000 | [diff] [blame] | 8 | * Copy: See Copyright for the status of this software. |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 9 | * |
Daniel Veillard | be58697 | 2003-11-18 20:56:51 +0000 | [diff] [blame] | 10 | * Author: Daniel Veillard |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 11 | */ |
| 12 | |
| 13 | #ifndef __XML_XINCLUDE_H__ |
| 14 | #define __XML_XINCLUDE_H__ |
| 15 | |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 16 | #include <libxml/xmlversion.h> |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 17 | #include <libxml/tree.h> |
| 18 | |
Daniel Veillard | a235132 | 2004-06-27 12:08:10 +0000 | [diff] [blame] | 19 | #ifdef LIBXML_XINCLUDE_ENABLED |
| 20 | |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 21 | #ifdef __cplusplus |
| 22 | extern "C" { |
| 23 | #endif |
| 24 | |
John Fleck | 0eaf41c | 2003-12-01 04:45:26 +0000 | [diff] [blame] | 25 | /** |
| 26 | * XINCLUDE_NS: |
| 27 | * |
Daniel Veillard | b5fa020 | 2003-12-08 17:41:29 +0000 | [diff] [blame] | 28 | * Macro defining the Xinclude namespace: http://www.w3.org/2003/XInclude |
John Fleck | 0eaf41c | 2003-12-01 04:45:26 +0000 | [diff] [blame] | 29 | */ |
Daniel Veillard | b5fa020 | 2003-12-08 17:41:29 +0000 | [diff] [blame] | 30 | #define XINCLUDE_NS (const xmlChar *) "http://www.w3.org/2003/XInclude" |
| 31 | /** |
| 32 | * XINCLUDE_OLD_NS: |
| 33 | * |
| 34 | * Macro defining the draft Xinclude namespace: http://www.w3.org/2001/XInclude |
| 35 | */ |
| 36 | #define XINCLUDE_OLD_NS (const xmlChar *) "http://www.w3.org/2001/XInclude" |
John Fleck | 0eaf41c | 2003-12-01 04:45:26 +0000 | [diff] [blame] | 37 | /** |
| 38 | * XINCLUDE_NODE: |
| 39 | * |
| 40 | * Macro defining "include" |
| 41 | */ |
Daniel Veillard | 7899c5c | 2003-11-03 12:31:38 +0000 | [diff] [blame] | 42 | #define XINCLUDE_NODE (const xmlChar *) "include" |
John Fleck | 0eaf41c | 2003-12-01 04:45:26 +0000 | [diff] [blame] | 43 | /** |
| 44 | * XINCLUDE_FALLBACK: |
| 45 | * |
| 46 | * Macro defining "fallback" |
| 47 | */ |
Daniel Veillard | 7899c5c | 2003-11-03 12:31:38 +0000 | [diff] [blame] | 48 | #define XINCLUDE_FALLBACK (const xmlChar *) "fallback" |
John Fleck | 0eaf41c | 2003-12-01 04:45:26 +0000 | [diff] [blame] | 49 | /** |
| 50 | * XINCLUDE_HREF: |
| 51 | * |
| 52 | * Macro defining "href" |
| 53 | */ |
Daniel Veillard | 7899c5c | 2003-11-03 12:31:38 +0000 | [diff] [blame] | 54 | #define XINCLUDE_HREF (const xmlChar *) "href" |
John Fleck | 0eaf41c | 2003-12-01 04:45:26 +0000 | [diff] [blame] | 55 | /** |
| 56 | * XINCLUDE_PARSE: |
| 57 | * |
| 58 | * Macro defining "parse" |
| 59 | */ |
Daniel Veillard | 7899c5c | 2003-11-03 12:31:38 +0000 | [diff] [blame] | 60 | #define XINCLUDE_PARSE (const xmlChar *) "parse" |
John Fleck | 0eaf41c | 2003-12-01 04:45:26 +0000 | [diff] [blame] | 61 | /** |
| 62 | * XINCLUDE_PARSE_XML: |
| 63 | * |
| 64 | * Macro defining "xml" |
| 65 | */ |
Daniel Veillard | 7899c5c | 2003-11-03 12:31:38 +0000 | [diff] [blame] | 66 | #define XINCLUDE_PARSE_XML (const xmlChar *) "xml" |
John Fleck | 0eaf41c | 2003-12-01 04:45:26 +0000 | [diff] [blame] | 67 | /** |
| 68 | * XINCLUDE_PARSE_TEXT: |
| 69 | * |
| 70 | * Macro defining "text" |
| 71 | */ |
Daniel Veillard | 7899c5c | 2003-11-03 12:31:38 +0000 | [diff] [blame] | 72 | #define XINCLUDE_PARSE_TEXT (const xmlChar *) "text" |
John Fleck | 0eaf41c | 2003-12-01 04:45:26 +0000 | [diff] [blame] | 73 | /** |
| 74 | * XINCLUDE_PARSE_ENCODING: |
| 75 | * |
| 76 | * Macro defining "encoding" |
| 77 | */ |
Daniel Veillard | 7899c5c | 2003-11-03 12:31:38 +0000 | [diff] [blame] | 78 | #define XINCLUDE_PARSE_ENCODING (const xmlChar *) "encoding" |
Daniel Veillard | b5fa020 | 2003-12-08 17:41:29 +0000 | [diff] [blame] | 79 | /** |
| 80 | * XINCLUDE_PARSE_XPOINTER: |
| 81 | * |
| 82 | * Macro defining "xpointer" |
| 83 | */ |
| 84 | #define XINCLUDE_PARSE_XPOINTER (const xmlChar *) "xpointer" |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 85 | |
Daniel Veillard | 7899c5c | 2003-11-03 12:31:38 +0000 | [diff] [blame] | 86 | typedef struct _xmlXIncludeCtxt xmlXIncludeCtxt; |
| 87 | typedef xmlXIncludeCtxt *xmlXIncludeCtxtPtr; |
| 88 | |
| 89 | /* |
| 90 | * standalone processing |
| 91 | */ |
Stefan Behnel | b9590e9 | 2009-08-24 19:45:54 +0200 | [diff] [blame] | 92 | XMLPUBFUN int XMLCALL |
Daniel Veillard | 7899c5c | 2003-11-03 12:31:38 +0000 | [diff] [blame] | 93 | xmlXIncludeProcess (xmlDocPtr doc); |
Stefan Behnel | b9590e9 | 2009-08-24 19:45:54 +0200 | [diff] [blame] | 94 | XMLPUBFUN int XMLCALL |
Daniel Veillard | e74d2e1 | 2003-12-09 11:35:37 +0000 | [diff] [blame] | 95 | xmlXIncludeProcessFlags (xmlDocPtr doc, |
| 96 | int flags); |
Stefan Behnel | b9590e9 | 2009-08-24 19:45:54 +0200 | [diff] [blame] | 97 | XMLPUBFUN int XMLCALL |
Daniel Veillard | 681e904 | 2006-09-29 09:16:00 +0000 | [diff] [blame] | 98 | xmlXIncludeProcessFlagsData(xmlDocPtr doc, |
| 99 | int flags, |
| 100 | void *data); |
Stefan Behnel | b9590e9 | 2009-08-24 19:45:54 +0200 | [diff] [blame] | 101 | XMLPUBFUN int XMLCALL |
| 102 | xmlXIncludeProcessTreeFlagsData(xmlNodePtr tree, |
| 103 | int flags, |
| 104 | void *data); |
| 105 | XMLPUBFUN int XMLCALL |
Daniel Veillard | 7899c5c | 2003-11-03 12:31:38 +0000 | [diff] [blame] | 106 | xmlXIncludeProcessTree (xmlNodePtr tree); |
Stefan Behnel | b9590e9 | 2009-08-24 19:45:54 +0200 | [diff] [blame] | 107 | XMLPUBFUN int XMLCALL |
Daniel Veillard | e74d2e1 | 2003-12-09 11:35:37 +0000 | [diff] [blame] | 108 | xmlXIncludeProcessTreeFlags(xmlNodePtr tree, |
| 109 | int flags); |
Daniel Veillard | 7899c5c | 2003-11-03 12:31:38 +0000 | [diff] [blame] | 110 | /* |
| 111 | * contextual processing |
| 112 | */ |
| 113 | XMLPUBFUN xmlXIncludeCtxtPtr XMLCALL |
| 114 | xmlXIncludeNewContext (xmlDocPtr doc); |
Daniel Veillard | e74d2e1 | 2003-12-09 11:35:37 +0000 | [diff] [blame] | 115 | XMLPUBFUN int XMLCALL |
| 116 | xmlXIncludeSetFlags (xmlXIncludeCtxtPtr ctxt, |
| 117 | int flags); |
Daniel Veillard | 7899c5c | 2003-11-03 12:31:38 +0000 | [diff] [blame] | 118 | XMLPUBFUN void XMLCALL |
| 119 | xmlXIncludeFreeContext (xmlXIncludeCtxtPtr ctxt); |
| 120 | XMLPUBFUN int XMLCALL |
| 121 | xmlXIncludeProcessNode (xmlXIncludeCtxtPtr ctxt, |
| 122 | xmlNodePtr tree); |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 123 | #ifdef __cplusplus |
| 124 | } |
| 125 | #endif |
Daniel Veillard | a235132 | 2004-06-27 12:08:10 +0000 | [diff] [blame] | 126 | |
| 127 | #endif /* LIBXML_XINCLUDE_ENABLED */ |
| 128 | |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 129 | #endif /* __XML_XINCLUDE_H__ */ |