include/yaz/record_conv.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2008 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 /** configures record conversion
  58     \param p record conversion handle
  59     \param node xmlNode pointer (root element of XML config)
  60     \retval 0 success
  61     \retval -1 failure
  62
  63     On failure, use yaz_record_conv_get_error to get error string.
  64
  65     \verbatim
  66     <backend syntax='xml'>
  67       <xslt stylesheet="dc2marcxml.xsl"/>
  68       <marc inputformat="xml" outputformat="marcxml" outputcharset="marc-8"/>
  69     </backend>
  70     \endverbatim
  71
  72     \verbatim
  73     <backend syntax='usmarc' name='F'>
  74       <marc inputformat="marc" outputformat="marcxml" inputcharset="marc-8"/>
  75       <xslt stylesheet="marcxml2mods.xsl"/>
  76       <xslt stylesheet="mods2dc.xsl"/>
  77     </backend>
  78     \endverbatim
  79 */
  80 YAZ_EXPORT
  81 int yaz_record_conv_configure(yaz_record_conv_t p, const xmlNode *node);
  82
  83 /** performs record conversion on record buffer (OCTET aligned)
  84     \param p record conversion handle
  85     \param input_record_buf input record buffer
  86     \param input_record_len length of input record buffer
  87     \param output_record resultint record (WRBUF string)
  88     \retval 0 success
  89     \retval -1 failure
  90
  91     On failure, use yaz_record_conv_get_error to get error string.
  92 */
  93 YAZ_EXPORT
  94 int yaz_record_conv_record(yaz_record_conv_t p, const char *input_record_buf,
  95                            size_t input_record_len,
  96                            WRBUF output_record);
  97
  98
  99 /** performs record conversion on OPAC record
 100     \param p record conversion handle
 101     \param input_record Z39.50 OPAC record
 102     \param output_record resultint record (WRBUF string)
 103     \retval 0 success
 104     \retval -1 failure
 105
 106     On failure, use yaz_record_conv_get_error to get error string.
 107 */
 108 YAZ_EXPORT
 109 int yaz_record_conv_opac_record(yaz_record_conv_t p,
 110                                 Z_OPACRecord *input_record,
 111                                 WRBUF output_record);
 112
 113 /** returns error string (for last error)
 114     \param p record conversion handle
 115     \return error string
 116 */
 117 YAZ_EXPORT
 118 const char *yaz_record_conv_get_error(yaz_record_conv_t p);
 119
 120
 121 /** set path for opening stylesheets etc.
 122     \param p record conversion handle
 123     \param path file path (UNIX style with : / Windows with ;)
 124 */
 125 YAZ_EXPORT
 126 void yaz_record_conv_set_path(yaz_record_conv_t p, const char *path);
 127
 128 YAZ_END_CDECL
 129
 130 #endif
 131 /*
 132  * Local variables:
 133  * c-basic-offset: 4
 134  * indent-tabs-mode: nil
 135  * End:
 136  * vim: shiftwidth=4 tabstop=8 expandtab
 137  */
 138