include/yaz/ccl_xml.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 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 /**
  29  * \file ccl_xml.h
  30  * \brief Header for CCL + XML stuff
  31  */
  32 #ifndef YAZ_CCL_XML_H
  33 #define YAZ_CCL_XML_H
  34
  35 #include <yaz/ccl.h>
  36 #include <yaz/xmltypes.h>
  37
  38 YAZ_BEGIN_CDECL
  39
  40 #if YAZ_HAVE_XML2
  41 /** \brief configures CCL bibset using XML configuration
  42     \param bibset CCL bibliographic profile
  43     \param ptr xml node pointer pointing to "cclmap" element
  44     \param addinfo has error message if configuration could not be parsed
  45     \retval 0 OK
  46     \retval -1 errors. Inspect addinfo for error message
  47
  48     Configuration example:
  49 \verbatim
  50 <cclmap defaultattrset="bib-1">
  51    <qual name="term">
  52        <attr type="u" value="1016"/>
  53        <attr type="s" value="pw"/>
  54    </qual>
  55    <qual name="title">
  56        <attr type="u" value="4"/>
  57    </qual>
  58    <qual name="distributor">
  59        <attr attrset="gils" type="u" value="2000"/>
  60    </qual>
  61   <directive name="and" value="+"/>
  62 </cclmap>
  63 \endverbatim
  64 */
  65 YAZ_EXPORT
  66 int ccl_xml_config(CCL_bibset bibset, const xmlNode *ptr,
  67                    const char **addinfo);
  68 #endif
  69 YAZ_END_CDECL
  70
  71 #endif
  72 /*
  73  * Local variables:
  74  * c-basic-offset: 4
  75  * c-file-style: "Stroustrup"
  76  * indent-tabs-mode: nil
  77  * End:
  78  * vim: shiftwidth=4 tabstop=8 expandtab
  79  */
  80