1  /* libxml2 - Library for parsing XML documents
       2   * Copyright (C) 2006-2019 Free Software Foundation, Inc.
       3   *
       4   * This file is not part of the GNU gettext program, but is used with
       5   * GNU gettext.
       6   *
       7   * The original copyright notice is as follows:
       8   */
       9  
      10  /*
      11   * Copyright (C) 1998-2012 Daniel Veillard.  All Rights Reserved.
      12   *
      13   * Permission is hereby granted, free of charge, to any person obtaining a copy
      14   * of this software and associated documentation files (the "Software"), to deal
      15   * in the Software without restriction, including without limitation the rights
      16   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
      17   * copies of the Software, and to permit persons to whom the Software is fur-
      18   * nished to do so, subject to the following conditions:
      19   *
      20   * The above copyright notice and this permission notice shall be included in
      21   * all copies or substantial portions of the Software.
      22   *
      23   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
      24   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FIT-
      25   * NESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
      26   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
      27   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
      28   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
      29   * THE SOFTWARE.
      30   *
      31   * Author: Daniel Veillard
      32   */
      33  
      34  /*
      35   * Summary: implementation of XInclude
      36   * Description: API to handle XInclude processing,
      37   * implements the
      38   * World Wide Web Consortium Last Call Working Draft 10 November 2003
      39   * http://www.w3.org/TR/2003/WD-xinclude-20031110
      40   */
      41  
      42  #ifndef __XML_XINCLUDE_H__
      43  #define __XML_XINCLUDE_H__
      44  
      45  #include <libxml/xmlversion.h>
      46  #include <libxml/tree.h>
      47  
      48  #ifdef LIBXML_XINCLUDE_ENABLED
      49  
      50  #ifdef __cplusplus
      51  extern "C" {
      52  #endif
      53  
      54  /**
      55   * XINCLUDE_NS:
      56   *
      57   * Macro defining the Xinclude namespace: http://www.w3.org/2003/XInclude
      58   */
      59  #define XINCLUDE_NS (const xmlChar *) "http://www.w3.org/2003/XInclude"
      60  /**
      61   * XINCLUDE_OLD_NS:
      62   *
      63   * Macro defining the draft Xinclude namespace: http://www.w3.org/2001/XInclude
      64   */
      65  #define XINCLUDE_OLD_NS (const xmlChar *) "http://www.w3.org/2001/XInclude"
      66  /**
      67   * XINCLUDE_NODE:
      68   *
      69   * Macro defining "include"
      70   */
      71  #define XINCLUDE_NODE (const xmlChar *) "include"
      72  /**
      73   * XINCLUDE_FALLBACK:
      74   *
      75   * Macro defining "fallback"
      76   */
      77  #define XINCLUDE_FALLBACK (const xmlChar *) "fallback"
      78  /**
      79   * XINCLUDE_HREF:
      80   *
      81   * Macro defining "href"
      82   */
      83  #define XINCLUDE_HREF (const xmlChar *) "href"
      84  /**
      85   * XINCLUDE_PARSE:
      86   *
      87   * Macro defining "parse"
      88   */
      89  #define XINCLUDE_PARSE (const xmlChar *) "parse"
      90  /**
      91   * XINCLUDE_PARSE_XML:
      92   *
      93   * Macro defining "xml"
      94   */
      95  #define XINCLUDE_PARSE_XML (const xmlChar *) "xml"
      96  /**
      97   * XINCLUDE_PARSE_TEXT:
      98   *
      99   * Macro defining "text"
     100   */
     101  #define XINCLUDE_PARSE_TEXT (const xmlChar *) "text"
     102  /**
     103   * XINCLUDE_PARSE_ENCODING:
     104   *
     105   * Macro defining "encoding"
     106   */
     107  #define XINCLUDE_PARSE_ENCODING (const xmlChar *) "encoding"
     108  /**
     109   * XINCLUDE_PARSE_XPOINTER:
     110   *
     111   * Macro defining "xpointer"
     112   */
     113  #define XINCLUDE_PARSE_XPOINTER (const xmlChar *) "xpointer"
     114  
     115  typedef struct _xmlXIncludeCtxt xmlXIncludeCtxt;
     116  typedef xmlXIncludeCtxt *xmlXIncludeCtxtPtr;
     117  
     118  /*
     119   * standalone processing
     120   */
     121  XMLPUBFUN int XMLCALL
     122  		xmlXIncludeProcess	(xmlDocPtr doc);
     123  XMLPUBFUN int XMLCALL
     124  		xmlXIncludeProcessFlags	(xmlDocPtr doc,
     125  					 int flags);
     126  XMLPUBFUN int XMLCALL
     127  		xmlXIncludeProcessFlagsData(xmlDocPtr doc,
     128  					 int flags,
     129  					 void *data);
     130  XMLPUBFUN int XMLCALL
     131                  xmlXIncludeProcessTreeFlagsData(xmlNodePtr tree,
     132                                           int flags,
     133                                           void *data);
     134  XMLPUBFUN int XMLCALL
     135  		xmlXIncludeProcessTree	(xmlNodePtr tree);
     136  XMLPUBFUN int XMLCALL
     137  		xmlXIncludeProcessTreeFlags(xmlNodePtr tree,
     138  					 int flags);
     139  /*
     140   * contextual processing
     141   */
     142  XMLPUBFUN xmlXIncludeCtxtPtr XMLCALL
     143  		xmlXIncludeNewContext	(xmlDocPtr doc);
     144  XMLPUBFUN int XMLCALL
     145  		xmlXIncludeSetFlags	(xmlXIncludeCtxtPtr ctxt,
     146  					 int flags);
     147  XMLPUBFUN void XMLCALL
     148  		xmlXIncludeFreeContext	(xmlXIncludeCtxtPtr ctxt);
     149  XMLPUBFUN int XMLCALL
     150  		xmlXIncludeProcessNode	(xmlXIncludeCtxtPtr ctxt,
     151  					 xmlNodePtr tree);
     152  #ifdef __cplusplus
     153  }
     154  #endif
     155  
     156  #endif /* LIBXML_XINCLUDE_ENABLED */
     157  
     158  #endif /* __XML_XINCLUDE_H__ */