/*
- * Copyright (C) 1995-2006, Index Data ApS
+ * Copyright (c) 1995-2006, 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:
*
- * 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:
+ * * 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.
*
- * 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.
- *
- * 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.
- *
- * 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: marcdisp.h,v 1.17 2006-04-20 20:35:02 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.
*/
+/* $Id: marcdisp.h,v 1.24 2006-12-18 10:32:47 adam Exp $ */
/**
* \file marcdisp.h
#include <stdio.h>
#include <yaz/wrbuf.h>
+#include <yaz/nmem.h>
+#include <yaz/xmltypes.h>
+
YAZ_BEGIN_CDECL
/** \brief a yaz_marc_t handle (private content) */
#define YAZ_MARC_ISO2709 4
/** \brief Output format: MarcXchange */
#define YAZ_MARC_XCHANGE 5
+/** \brief Output format: check only (no marc output) */
+#define YAZ_MARC_CHECK 6
/** \brief supply iconv handle for character set conversion .. */
YAZ_EXPORT void yaz_marc_iconv(yaz_marc_t mt, yaz_iconv_t cd);
/** \brief like atoi(3) except that it reads exactly len characters */
YAZ_EXPORT int atoi_n(const char *buf, int len);
+/** \brief like atoi_n but checks for proper formatting
+ \param buf buffer to read values from
+ \param size size of buffer
+ \param val value of decimal number (if successful)
+ \retval 0 no value found (non-digits found)
+ \retval 1 value found and *val holds value
+*/
+YAZ_EXPORT
+int atoi_n_check(const char *buf, int size, int *val);
+
/** \brief MARC control char: record separator (29 Dec, 1D Hex) */
#define ISO2709_RS 035
/** \brief MARC control char: field separator (30 Dec, 1E Hex) */
YAZ_EXPORT int yaz_marc_read_iso2709(yaz_marc_t mt,
const char *buf, int bsize);
+/** \brief read MARC lineformat from stream
+ \param mt handle
+ \param getbyte get one byte handler
+ \param ungetbyte unget one byte handler
+ \param client_data opaque data for handers
+
+ Parses MARC line record from stream
+ Returns > 0 for OK (same as length), -1=ERROR
+*/
+YAZ_EXPORT
+int yaz_marc_read_line(yaz_marc_t mt,
+ int (*getbyte)(void *client_data),
+ void (*ungetbyte)(int b, void *client_data),
+ void *client_data);
+
/** \brief parses MARCXML/MarcXchange record from xmlNode pointer
\param mt handle
- \param xmlnode is a pointer to root xmlNode pointer
+ \param ptr is a pointer to root xml node
Returns 0=OK, -1=ERROR
*/
-YAZ_EXPORT int yaz_marc_read_xml(yaz_marc_t mt, const void *xmlnode);
+YAZ_EXPORT int yaz_marc_read_xml(yaz_marc_t mt, const xmlNode *ptr);
/** \brief writes record in line format
\param mt handle
Sets leader[9]='a' . Returns 0=OK, -1=ERROR .
*/
-
YAZ_EXPORT int yaz_marc_write_marcxml(yaz_marc_t mt, WRBUF wrbuf);
/** \brief writes record in MarcXchange XML
*/
YAZ_EXPORT int yaz_marc_write_mode(yaz_marc_t mt, WRBUF wrbuf);
+/** \brief writes MARC record as libxml2 tree
+ \param mt handle
+ \param root_ptr pointer to record node
+ \param ns namespace of record (such as "http://www.loc.gov/MARC21/slim")
+ \param format MarcXchange format (NULL for none)
+ \param type MarcXchange format (NULL for none)
+ \retval 0 Creation successful and *root_ptr is "record" node
+ \retval -1 ERROR
+*/
+YAZ_EXPORT
+int yaz_marc_write_xml(yaz_marc_t mt, xmlNode **root_ptr,
+ const char *ns,
+ const char *format,
+ const char *type);
+
+/** \brief sets leader spec (for modifying bytes in 24 byte leader)
+ \param mt handle
+ \param leader_spec
+ \retval 0 OK
+ \retval -1 ERROR
+
+ Spec takes form pos=val,pos=val,...
+ where value is either a number (decimal char value) or a
+ string in 'a', e.g. 9='a'
+
+*/
+YAZ_EXPORT int yaz_marc_leader_spec(yaz_marc_t mt, const char *leader_spec);
+
+
+/** \brief sets leader, validates it, and returns important values
+ \param mt handle
+ \param leader of the 24 byte leader to be set
+ \param indicator_length indicator length (returned value)
+ \param identifier_length identifier length (returned value)
+ \param base_address base address (returned value)
+ \param length_data_entry length of data entry (returned value)
+ \param length_starting length of starting
+ \param length_implementation length of implementation defined data
+*/
+YAZ_EXPORT
+void yaz_marc_set_leader(yaz_marc_t mt, const char *leader_c,
+ int *indicator_length,
+ int *identifier_length,
+ int *base_address,
+ int *length_data_entry,
+ int *length_starting,
+ int *length_implementation);
+
+
+/** \brief adds MARC comment string
+ \param mt handle
+ \param comment comment to be added)
+*/
+YAZ_EXPORT
+void yaz_marc_add_comment(yaz_marc_t mt, char *comment);
+
+/** \brief adds MARC annotation - printf interface
+ \param mt handle
+ \param fmt printf format string
+*/
+YAZ_EXPORT
+void yaz_marc_cprintf(yaz_marc_t mt, const char *fmt, ...);
+
+/** \brief adds subfield to MARC structure
+ \param mt handle
+ \param code_data code data buffer
+ \param code_data_len length of code data
+*/
+YAZ_EXPORT
+void yaz_marc_add_subfield(yaz_marc_t mt,
+ const char *code_data, size_t code_data_len);
+
+
+/** \brief adds controlfield to MARC structure
+ \param mt handle
+ \param tag (e.g. "001"
+ \param data value for this tag
+ \param data_len length of data
+*/
+YAZ_EXPORT
+void yaz_marc_add_controlfield(yaz_marc_t mt, const char *tag,
+ const char *data, size_t data_len);
+
+
+/** \brief adds controlfield to MARC structure using xml Nodes
+ \param mt handle
+ \param ptr_tag value of tag (TEXT xmlNode)
+ \param ptr_data value of data (TEXT xmlNode)
+*/
+YAZ_EXPORT
+void yaz_marc_add_controlfield_xml(yaz_marc_t mt, const xmlNode *ptr_tag,
+ const xmlNode *ptr_data);
+
+
+/** \brief adds datafield to MARC structure using strings
+ \param mt handle
+ \param tag value of tag as string
+ \param indicator indicator string
+ \param indicator_len length of indicator string
+*/
+YAZ_EXPORT
+void yaz_marc_add_datafield(yaz_marc_t mt, const char *tag,
+ const char *indicator, size_t indicator_len);
+
+/** \brief adds datafield to MARC structure using xml Nodes
+ \param mt handle
+ \param ptr_tag value of tag (TEXT xmlNode)
+ \param indicator indicator string
+ \param indicator_len length of indicator string
+*/
+YAZ_EXPORT
+void yaz_marc_add_datafield_xml(yaz_marc_t mt, const xmlNode *ptr_tag,
+ const char *indicator, size_t indicator_len);
+
+
+/** \brief returns memory for MARC handle
+ \param mt handle
+ \retval NMEM handle for MARC system
+*/
+YAZ_EXPORT
+NMEM yaz_marc_get_nmem(yaz_marc_t mt);
+
+/** \brief clears memory and MARC record
+ \param mt handle
+*/
+YAZ_EXPORT
+void yaz_marc_reset(yaz_marc_t mt);
+
+/** \brief gets debug level for MARC system
+ \param mt handle
+*/
+YAZ_EXPORT
+int yaz_marc_get_debug(yaz_marc_t mt);
+
+/** \brief convert MARC format type to format type(YAZ_MARC_..)
+ \param arg string
+ \returns -1 if arg is not a known format; YAZ_MARC_.. otherwise (OK)
+*/
+YAZ_EXPORT
+int yaz_marc_decode_formatstr(const char *arg);
+
+/** \brief enable writing of MARC XML records using Libxml2
+ \param mt handle
+ \param enable 0=disable, 1=enable
+*/
+YAZ_EXPORT
+void yaz_marc_write_using_libxml2(yaz_marc_t mt, int enable);
+
YAZ_END_CDECL
#endif
projects / yaz-moved-to-github.git / blobdiff