/*
 * Summary: implementation of XInclude
 * Description: API to handle XInclude processing,
 * implements the
 * World Wide Web Consortium Last Call WorkingDraft 10 November 2003
 * http://www.w3.org/TR/2003/WD-xinclude-20031110
 *
 * Copy: See Copyright for the status of this software.
 *
 * Author: Daniel Veillard
 */

/** @file
@publishedAll
@released
*/

#ifndef XML_XINCLUDE_H
#define XML_XINCLUDE_H

#include <stdapis/libxml2/libxml2_xmlversion.h>
#include <stdapis/libxml2/libxml2_tree.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * XINCLUDE_NS:
 *
 * Macro defining the Xinclude namespace: http://www.w3.org/2003/XInclude
 */
#define XINCLUDE_NS (const xmlChar *) "http://www.w3.org/2003/XInclude"
/**
 * XINCLUDE_OLD_NS:
 *
 * Macro defining the draftXinclude namespace: http://www.w3.org/2001/XInclude
 */
#define XINCLUDE_OLD_NS (const xmlChar *) "http://www.w3.org/2001/XInclude"
/**
 * XINCLUDE_NODE:
 *
 * Macro defining "include"
 */
#define XINCLUDE_NODE (const xmlChar *) "include"
/**
 * XINCLUDE_FALLBACK:
 *
 * Macro defining "fallback"
 */
#define XINCLUDE_FALLBACK (const xmlChar *) "fallback"
/**
 * XINCLUDE_HREF:
 *
 * Macro defining "href"
 */
#define XINCLUDE_HREF (const xmlChar *) "href"
/**
 * XINCLUDE_PARSE:
 *
 * Macro defining "parse"
 */
#define XINCLUDE_PARSE (const xmlChar *) "parse"
/**
 * XINCLUDE_PARSE_XML:
 *
 * Macro defining "xml"
 */
#define XINCLUDE_PARSE_XML (const xmlChar *) "xml"
/**
 * XINCLUDE_PARSE_TEXT:
 *
 * Macro defining "text"
 */
#define XINCLUDE_PARSE_TEXT (const xmlChar *) "text"
/**
 * XINCLUDE_PARSE_ENCODING:
 *
 * Macro defining "encoding"
 */
#define XINCLUDE_PARSE_ENCODING (const xmlChar *) "encoding"
/**
 * XINCLUDE_PARSE_XPOINTER:
 *
 * Macro defining "xpointer"
 */
#define XINCLUDE_PARSE_XPOINTER (const xmlChar *) "xpointer"

typedef struct _xmlXIncludeCtxt xmlXIncludeCtxt;
typedef xmlXIncludeCtxt *xmlXIncludeCtxtPtr;

/*
 * standalone processing
 */
XMLPUBFUN int XMLCALL
                xmlXIncludeProcess      (xmlDocPtr doc);
XMLPUBFUN int XMLCALL
                xmlXIncludeProcessFlags (xmlDocPtr doc,
                                         int flags);
XMLPUBFUN int XMLCALL
                xmlXIncludeProcessTree  (xmlNodePtr tree);
XMLPUBFUN int XMLCALL
                xmlXIncludeProcessTreeFlags(xmlNodePtr tree,
                                         int flags);
/*
 * contextual processing
 */
XMLPUBFUN xmlXIncludeCtxtPtr XMLCALL
                xmlXIncludeNewContext   (xmlDocPtr doc);
XMLPUBFUN int XMLCALL
                xmlXIncludeSetFlags     (xmlXIncludeCtxtPtr ctxt,
                                         int flags);
XMLPUBFUN void XMLCALL
                xmlXIncludeFreeContext  (xmlXIncludeCtxtPtr ctxt);
XMLPUBFUN int XMLCALL
                xmlXIncludeProcessNode  (xmlXIncludeCtxtPtr ctxt,
                                         xmlNodePtr tree);
#ifdef __cplusplus
}
#endif
#endif /* XML_XINCLUDE_H */
