include/yaz/xml_include.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2010 Index Data.
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of Index Data nor the names of its contributors
  13  *       may be used to endorse or promote products derived from this
  14  *       software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 /** \file
  29     \brief XML Include (not to be confused with W3C XInclude)
  30 */
  31
  32 #ifndef YAZ_XML_INCLUDE_H
  33 #define YAZ_XML_INCLUDE_H
  34
  35 #include <yaz/yconfig.h>
  36 #include <yaz/xmltypes.h>
  37
  38 YAZ_BEGIN_CDECL
  39
  40 #if YAZ_HAVE_XML2
  41
  42 /** \brief substitute include nodes in a tree
  43     \param n node where include is peformed
  44     \param base_path base_path - for relative file specs
  45     \retval 0 OK
  46     \retval -1 FAILURE
  47
  48     Nodes of the form <include src="glob-pattern"/> are substituted with
  49     contents of files matching glob-pattern. Do not use this function
  50     on XML from untrusted sources -- from the net for example -- local
  51     trusted XML configuration ONLY.
  52 */
  53 YAZ_EXPORT
  54 int yaz_xml_include_simple(xmlNode *n, const char *base_path);
  55
  56 #endif
  57 YAZ_END_CDECL
  58
  59 #endif
  60
  61 /*
  62  * Local variables:
  63  * c-basic-offset: 4
  64  * c-file-style: "Stroustrup"
  65  * indent-tabs-mode: nil
  66  * End:
  67  * vim: shiftwidth=4 tabstop=8 expandtab
  68  */
  69