include/yaz/record_conv.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2012 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 record_conv.h
  30  * \brief Record Conversions Utility
  31  */
  32
  33 #ifndef YAZ_RECORD_CONV_H
  34 #define YAZ_RECORD_CONV_H
  35
  36 #include <stddef.h>
  37 #include <yaz/wrbuf.h>
  38 #include <yaz/yconfig.h>
  39 #include <yaz/xmltypes.h>
  40 #include <yaz/z-opac.h>
  41
  42 YAZ_BEGIN_CDECL
  43
  44 /** record conversion handle  */
  45 typedef struct yaz_record_conv_struct *yaz_record_conv_t;
  46
  47 /** creates record handle
  48     \return record handle
  49 */
  50 YAZ_EXPORT yaz_record_conv_t yaz_record_conv_create(void);
  51
  52 /** destroys record handle
  53     \param p record conversion handle
  54 */
  55 YAZ_EXPORT void yaz_record_conv_destroy(yaz_record_conv_t p);
  56
  57 #if YAZ_HAVE_XML2
  58 /** record conversion type */
  59 struct yaz_record_conv_type {
  60     /** \brief pointer to next type ; NULL for last */
  61     struct yaz_record_conv_type *next;
  62
  63     /** \brief construct and configure a type of ours */
  64     void * (*construct)(const xmlNode *, const char *path,
  65                         WRBUF error_msg);
  66
  67     /** \brief converts a record */
  68     int  (*convert)(void *info, WRBUF record, WRBUF error_msg);
  69
  70     /** \brief destroys our conversion handler */
  71     void (*destroy)(void *info);
  72 };
  73
  74 /** configures record conversion
  75     \param p record conversion handle
  76     \param node xmlNode pointer (root element of XML config)
  77     \retval 0 success
  78     \retval -1 failure
  79
  80     On failure, use yaz_record_conv_get_error to get error string.
  81
  82     \verbatim
  83     <backend syntax='xml'>
  84       <xslt stylesheet="dc2marcxml.xsl"/>
  85       <marc inputformat="xml" outputformat="marcxml" outputcharset="marc-8"/>
  86     </backend>
  87     \endverbatim
  88
  89     \verbatim
  90     <backend syntax='usmarc' name='F'>
  91       <marc inputformat="marc" outputformat="marcxml" inputcharset="marc-8"/>
  92       <xslt stylesheet="marcxml2mods.xsl"/>
  93       <xslt stylesheet="mods2dc.xsl"/>
  94     </backend>
  95     \endverbatim
  96 */
  97 YAZ_EXPORT
  98 int yaz_record_conv_configure(yaz_record_conv_t p, const xmlNode *node);
  99
 100 /** configures record conversion with user-defined conversion types
 101     \param p record conversion handle
 102     \param node xmlNode pointer (root element of XML config)
 103     \param types conversion types
 104     \retval 0 success
 105     \retval -1 failure
 106
 107 */
 108 YAZ_EXPORT
 109 int yaz_record_conv_configure_t(yaz_record_conv_t p, const xmlNode *node,
 110                                 struct yaz_record_conv_type *types);
 111
 112 #endif
 113
 114 /** performs record conversion on record buffer (OCTET aligned)
 115     \param p record conversion handle
 116     \param input_record_buf input record buffer
 117     \param input_record_len length of input record buffer
 118     \param output_record resultint record (WRBUF string)
 119     \retval 0 success
 120     \retval -1 failure
 121
 122     On failure, use yaz_record_conv_get_error to get error string.
 123 */
 124 YAZ_EXPORT
 125 int yaz_record_conv_record(yaz_record_conv_t p, const char *input_record_buf,
 126                            size_t input_record_len,
 127                            WRBUF output_record);
 128
 129
 130 /** performs record conversion on OPAC record
 131     \param p record conversion handle
 132     \param input_record Z39.50 OPAC record
 133     \param output_record resultint record (WRBUF string)
 134     \retval 0 success
 135     \retval -1 failure
 136
 137     On failure, use yaz_record_conv_get_error to get error string.
 138 */
 139 YAZ_EXPORT
 140 int yaz_record_conv_opac_record(yaz_record_conv_t p,
 141                                 Z_OPACRecord *input_record,
 142                                 WRBUF output_record);
 143
 144 /** returns error string (for last error)
 145     \param p record conversion handle
 146     \return error string
 147 */
 148 YAZ_EXPORT
 149 const char *yaz_record_conv_get_error(yaz_record_conv_t p);
 150
 151
 152 /** set path for opening stylesheets etc.
 153     \param p record conversion handle
 154     \param path file path (UNIX style with : / Windows with ;)
 155 */
 156 YAZ_EXPORT
 157 void yaz_record_conv_set_path(yaz_record_conv_t p, const char *path);
 158
 159 /** adds a type to our conversion handler
 160     \param p record conversion handle
 161     \param type info
 162 */
 163
 164 YAZ_END_CDECL
 165
 166 #endif
 167 /*
 168  * Local variables:
 169  * c-basic-offset: 4
 170  * c-file-style: "Stroustrup"
 171  * indent-tabs-mode: nil
 172  * End:
 173  * vim: shiftwidth=4 tabstop=8 expandtab
 174  */
 175