X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=include%2Fyaz%2Frecord_conv.h;h=d6af1581e644fac69d95d81460dd5456dcfe813f;hp=1ffae60fef5005cd038283725730ea8e26af25f9;hb=a3e65bcd3250b107397675bc65b35b5939355025;hpb=a0e27aac0589d493172c73f6660b844fc6460d7c

diff --git a/include/yaz/record_conv.h b/include/yaz/record_conv.h
index 1ffae60..d6af158 100644
--- a/include/yaz/record_conv.h
+++ b/include/yaz/record_conv.h
@@ -1,30 +1,30 @@
-/*
- * Copyright (C) 2005-2006, Index Data ApS
- *
- * Permission to use, copy, modify, distribute, and sell this software and
- * its documentation, in whole or in part, for any purpose, is hereby granted,
- * provided that:
- *
- * 1. This copyright and permission notice appear in all copies of the
- * software and its documentation. Notices of copyright or attribution
- * which appear at the beginning of any file must remain unchanged.
+/* This file is part of the YAZ toolkit.
+ * Copyright (C) 1995-2012 Index Data.
+ * All rights reserved.
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
  *
- * 2. The name of Index Data or the individual authors may not be used to
- * endorse or promote products derived from this software without specific
- * prior written permission.
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of Index Data nor the names of its contributors
+ *       may be used to endorse or promote products derived from this
+ *       software without specific prior written permission.
  *
- * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
- * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
- * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
- * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
- * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
- * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
- * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
- * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
- * OF THIS SOFTWARE.
- *
- * $Id: record_conv.h,v 1.1 2006-05-02 20:47:45 adam Exp $
+ * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
+
 /**
  * \file record_conv.h
  * \brief Record Conversions Utility
@@ -34,7 +34,10 @@
 #define YAZ_RECORD_CONV_H
 
 #include <stddef.h>
+#include <yaz/wrbuf.h>
 #include <yaz/yconfig.h>
+#include <yaz/xmltypes.h>
+#include <yaz/z-opac.h>
 
 YAZ_BEGIN_CDECL
 
@@ -51,48 +54,93 @@ YAZ_EXPORT yaz_record_conv_t yaz_record_conv_create(void);
 */
 YAZ_EXPORT void yaz_record_conv_destroy(yaz_record_conv_t p);
 
+#if YAZ_HAVE_XML2
+/** record conversion type */
+struct yaz_record_conv_type {
+    /** \brief pointer to next type ; NULL for last */
+    struct yaz_record_conv_type *next;
+
+    /** \brief construct and configure a type of ours */
+    void * (*construct)(yaz_record_conv_t , const xmlNode *, const char *path,
+                        WRBUF error_msg);
+
+    /** \brief converts a record */
+    int  (*convert)(void *info, WRBUF record, WRBUF error_msg);
+
+    /** \brief destroys our conversion handler */
+    void (*destroy)(void *info);
+};
 
 /** configures record conversion
     \param p record conversion handle
     \param node xmlNode pointer (root element of XML config)
     \retval 0 success
     \retval -1 failure
+
+    On failure, use yaz_record_conv_get_error to get error string.
     
     \verbatim
-    <convert>
+    <backend syntax='xml'>
       <xslt stylesheet="dc2marcxml.xsl"/>
-      <xmltomarc charset="marc-8"/>
-    </convert>
+      <marc inputformat="xml" outputformat="marcxml" outputcharset="marc-8"/>
+    </backend>
     \endverbatim
 
     \verbatim
-    <convert>
-      <marctoxml charset="marc-8"/>
+    <backend syntax='usmarc' name='F'>
+      <marc inputformat="marc" outputformat="marcxml" inputcharset="marc-8"/>
       <xslt stylesheet="marcxml2mods.xsl"/>
       <xslt stylesheet="mods2dc.xsl"/>
-    </convert>
+    </backend>
     \endverbatim
+*/
+YAZ_EXPORT
+int yaz_record_conv_configure(yaz_record_conv_t p, const xmlNode *node);
 
-    For retrieval (ignore here):
-    \verbatim
-    <retrievalinfo>
-       <retrieval syntax="usmarc" name="marcxml"
-            identifier="info:srw/schema/1/marcxml-v1.1"
-       >
-         <title>MARCXML</title>
-         <backend syntax="xml" name="dc" charset="utf-8"/>
-         <convert>
-           <xslt stylesheet="dc2marcxml.xsl"/>
-           <xmltomarc charset="marc-8"/>
-         </convert>
-       </retrieval>
-    </retrievalinfo>
-    \endverbatim
+/** configures record conversion with user-defined conversion types
+    \param p record conversion handle
+    \param node xmlNode pointer (root element of XML config)
+    \param types conversion types
+    \retval 0 success
+    \retval -1 failure
+
+*/
+YAZ_EXPORT
+int yaz_record_conv_configure_t(yaz_record_conv_t p, const xmlNode *node,
+                                struct yaz_record_conv_type *types);
+
+#endif
+
+/** performs record conversion on record buffer (OCTET aligned)
+    \param p record conversion handle
+    \param input_record_buf input record buffer
+    \param input_record_len length of input record buffer
+    \param output_record resultint record (WRBUF string)
+    \retval 0 success
+    \retval -1 failure
+
+    On failure, use yaz_record_conv_get_error to get error string.
 */
 YAZ_EXPORT
-int yaz_record_conv_configure(yaz_record_conv_t p, const void *node);
+int yaz_record_conv_record(yaz_record_conv_t p, const char *input_record_buf,
+                           size_t input_record_len,
+                           WRBUF output_record);
 
 
+/** performs record conversion on OPAC record
+    \param p record conversion handle
+    \param input_record Z39.50 OPAC record
+    \param output_record resultint record (WRBUF string)
+    \retval 0 success
+    \retval -1 failure
+
+    On failure, use yaz_record_conv_get_error to get error string.
+*/
+YAZ_EXPORT
+int yaz_record_conv_opac_record(yaz_record_conv_t p,
+                                Z_OPACRecord *input_record,
+                                WRBUF output_record);
+
 /** returns error string (for last error)
     \param p record conversion handle
     \return error string
@@ -100,12 +148,26 @@ int yaz_record_conv_configure(yaz_record_conv_t p, const void *node);
 YAZ_EXPORT
 const char *yaz_record_conv_get_error(yaz_record_conv_t p);
 
+
+/** set path for opening stylesheets etc.
+    \param p record conversion handle
+    \param path file path (UNIX style with : / Windows with ;)
+*/    
+YAZ_EXPORT
+void yaz_record_conv_set_path(yaz_record_conv_t p, const char *path);
+
+/** adds a type to our conversion handler
+    \param p record conversion handle
+    \param type info
+*/    
+
 YAZ_END_CDECL
 
 #endif
 /*
  * Local variables:
  * c-basic-offset: 4
+ * c-file-style: "Stroustrup"
  * indent-tabs-mode: nil
  * End:
  * vim: shiftwidth=4 tabstop=8 expandtab