include/yaz/record_conv.h

   1 /*
   2  * Copyright (c) 1995-2007, 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 /* $Id: record_conv.h,v 1.9 2007-12-16 11:08:50 adam Exp $ */
  28
  29 /**
  30  * \file record_conv.h
  31  * \brief Record Conversions Utility
  32  */
  33
  34 #ifndef YAZ_RECORD_CONV_H
  35 #define YAZ_RECORD_CONV_H
  36
  37 #include <stddef.h>
  38 #include <yaz/wrbuf.h>
  39 #include <yaz/yconfig.h>
  40 #include <yaz/xmltypes.h>
  41 #include <yaz/z-opac.h>
  42
  43 YAZ_BEGIN_CDECL
  44
  45 /** record conversion handle  */
  46 typedef struct yaz_record_conv_struct *yaz_record_conv_t;
  47
  48 /** creates record handle
  49     \return record handle
  50 */
  51 YAZ_EXPORT yaz_record_conv_t yaz_record_conv_create(void);
  52
  53 /** destroys record handle
  54     \param p record conversion handle
  55 */
  56 YAZ_EXPORT void yaz_record_conv_destroy(yaz_record_conv_t p);
  57
  58 /** configures record conversion
  59     \param p record conversion handle
  60     \param node xmlNode pointer (root element of XML config)
  61     \retval 0 success
  62     \retval -1 failure
  63
  64     On failure, use yaz_record_conv_get_error to get error string.
  65
  66     \verbatim
  67     <backend syntax='xml'>
  68       <xslt stylesheet="dc2marcxml.xsl"/>
  69       <marc inputformat="xml" outputformat="marcxml" outputcharset="marc-8"/>
  70     </backend>
  71     \endverbatim
  72
  73     \verbatim
  74     <backend syntax='usmarc' name='F'>
  75       <marc inputformat="marc" outputformat="marcxml" inputcharset="marc-8"/>
  76       <xslt stylesheet="marcxml2mods.xsl"/>
  77       <xslt stylesheet="mods2dc.xsl"/>
  78     </backend>
  79     \endverbatim
  80 */
  81 YAZ_EXPORT
  82 int yaz_record_conv_configure(yaz_record_conv_t p, const xmlNode *node);
  83
  84 /** performs record conversion on record buffer (OCTET aligned)
  85     \param p record conversion handle
  86     \param input_record_buf input record buffer
  87     \param input_record_len length of input record buffer
  88     \param output_record resultint record (WRBUF string)
  89     \retval 0 success
  90     \retval -1 failure
  91
  92     On failure, use yaz_record_conv_get_error to get error string.
  93 */
  94 YAZ_EXPORT
  95 int yaz_record_conv_record(yaz_record_conv_t p, const char *input_record_buf,
  96                            size_t input_record_len,
  97                            WRBUF output_record);
  98
  99
 100 /** performs record conversion on OPAC record
 101     \param p record conversion handle
 102     \param input_record Z39.50 OPAC record
 103     \param output_record resultint record (WRBUF string)
 104     \retval 0 success
 105     \retval -1 failure
 106
 107     On failure, use yaz_record_conv_get_error to get error string.
 108 */
 109 YAZ_EXPORT
 110 int yaz_record_conv_opac_record(yaz_record_conv_t p,
 111                                 Z_OPACRecord *input_record,
 112                                 WRBUF output_record);
 113
 114 /** returns error string (for last error)
 115     \param p record conversion handle
 116     \return error string
 117 */
 118 YAZ_EXPORT
 119 const char *yaz_record_conv_get_error(yaz_record_conv_t p);
 120
 121
 122 /** set path for opening stylesheets etc.
 123     \param p record conversion handle
 124     \param path file path (UNIX style with : / Windows with ;)
 125 */
 126 YAZ_EXPORT
 127 void yaz_record_conv_set_path(yaz_record_conv_t p, const char *path);
 128
 129 YAZ_END_CDECL
 130
 131 #endif
 132 /*
 133  * Local variables:
 134  * c-basic-offset: 4
 135  * indent-tabs-mode: nil
 136  * End:
 137  * vim: shiftwidth=4 tabstop=8 expandtab
 138  */
 139