include/yaz/record_conv.h

   1 /*
   2  * Copyright (c) 1995-2006, 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.5 2006-10-09 21:02:41 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
  41 YAZ_BEGIN_CDECL
  42
  43 /** record conversion handle  */
  44 typedef struct yaz_record_conv_struct *yaz_record_conv_t;
  45
  46 /** creates record handle
  47     \return record handle
  48 */
  49 YAZ_EXPORT yaz_record_conv_t yaz_record_conv_create(void);
  50
  51 /** destroys record handle
  52     \param p record conversion handle
  53 */
  54 YAZ_EXPORT void yaz_record_conv_destroy(yaz_record_conv_t p);
  55
  56 /** configures record conversion
  57     \param p record conversion handle
  58     \param node xmlNode pointer (root element of XML config)
  59     \retval 0 success
  60     \retval -1 failure
  61
  62     On failure, use yaz_record_conv_get_error to get error string.
  63
  64     \verbatim
  65     <convert>
  66       <xslt stylesheet="dc2marcxml.xsl"/>
  67       <marc inputformat="xml" outputformat="marcxml" outputcharset="marc-8"/>
  68     </convert>
  69     \endverbatim
  70
  71     \verbatim
  72     <convert>
  73       <marc inputformat="marc" outputformat="marcxml" inputcharset="marc-8"/>
  74       <xslt stylesheet="marcxml2mods.xsl"/>
  75       <xslt stylesheet="mods2dc.xsl"/>
  76     </convert>
  77     \endverbatim
  78
  79
  80 */
  81 YAZ_EXPORT
  82 int yaz_record_conv_configure(yaz_record_conv_t p, const void *node);
  83
  84 /** performs record conversion
  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 /** returns error string (for last error)
 100     \param p record conversion handle
 101     \return error string
 102 */
 103 YAZ_EXPORT
 104 const char *yaz_record_conv_get_error(yaz_record_conv_t p);
 105
 106
 107 /** set path for opening stylesheets etc.
 108     \param p record conversion handle
 109     \param path file path (UNIX style with : / Windows with ;)
 110 */
 111 YAZ_EXPORT
 112 void yaz_record_conv_set_path(yaz_record_conv_t p, const char *path);
 113
 114 YAZ_END_CDECL
 115
 116 #endif
 117 /*
 118  * Local variables:
 119  * c-basic-offset: 4
 120  * indent-tabs-mode: nil
 121  * End:
 122  * vim: shiftwidth=4 tabstop=8 expandtab
 123  */
 124