X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=include%2Fyaz%2Fmarcdisp.h;h=dab19468e0a6b55f659a61a8ef96c25fe23e7612;hb=18066a4668e30a464d01cd5f01a060e453b368be;hp=13b41b5e9284c976a1b8acd0888f6382adeead4e;hpb=7057699040b614f56be178f3672b4a2b95301d5f;p=yaz-moved-to-github.git diff --git a/include/yaz/marcdisp.h b/include/yaz/marcdisp.h index 13b41b5..dab1946 100644 --- a/include/yaz/marcdisp.h +++ b/include/yaz/marcdisp.h @@ -1,80 +1,221 @@ /* - * Copyright (c) 1995-2001, Index Data. - * - * 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. - * - * 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. - * - * $Log: marcdisp.h,v $ - * Revision 1.3 2001-04-06 12:26:46 adam - * Optional CCL module. Moved atoi_n to marcdisp.h from yaz-util.h. - * - * Revision 1.2 2000/02/28 11:20:06 adam - * Using autoconf. New definitions: YAZ_BEGIN_CDECL/YAZ_END_CDECL. - * - * Revision 1.1 1999/11/30 13:47:11 adam - * Improved installation. Moved header files to include/yaz. - * - * Revision 1.8 1997/09/24 13:35:45 adam - * Added two members to data1_marctab to ease reading of weird MARC records. - * - * Revision 1.7 1997/09/04 07:57:51 adam - * Definition of ISO2709 control characters to this file. - * - * Revision 1.6 1997/09/01 08:49:49 adam - * New windows NT/95 port using MSV5.0. To export DLL functions the - * YAZ_EXPORT modifier was added. Defined in yconfig.h. - * - * Revision 1.5 1997/05/14 06:53:40 adam - * C++ support. - * - * Revision 1.4 1995/09/29 17:12:03 quinn - * Smallish - * - * Revision 1.3 1995/09/27 15:02:47 quinn - * Modified function heads & prototypes. - * - * Revision 1.2 1995/05/16 08:50:32 quinn - * License, documentation, and memory fixes - * - * Revision 1.1 1995/04/10 10:28:28 quinn - * Added copy of CCL. - * + * 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: + * + * * 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 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.19 2006-10-09 21:02:41 adam Exp $ */ + +/** + * \file marcdisp.h + * \brief MARC conversion */ #ifndef MARCDISP_H #define MARCDISP_H #include +#include +#include YAZ_BEGIN_CDECL -YAZ_EXPORT int marc_display (const char *buf, FILE *outf); -YAZ_EXPORT int marc_display_ex (const char *buf, FILE *outf, int debug); -YAZ_EXPORT int atoi_n (const char *buf, int len); +/** \brief a yaz_marc_t handle (private content) */ +typedef struct yaz_marc_t_ *yaz_marc_t; + +/** \brief construct yaz_marc_t handle */ +YAZ_EXPORT yaz_marc_t yaz_marc_create(void); + +/** \brief destroy yaz_marc_t handle */ +YAZ_EXPORT void yaz_marc_destroy(yaz_marc_t mt); + +/** \brief set XML mode YAZ_MARC_LINE, YAZ_MARC_SIMPLEXML, ... */ +YAZ_EXPORT void yaz_marc_xml(yaz_marc_t mt, int xmlmode); + +/** \brief Output format: Line-format */ +#define YAZ_MARC_LINE 0 +/** \brief Output format: simplexml (no longer supported) */ +#define YAZ_MARC_SIMPLEXML 1 +/** \brief Output format: OAI-MARC (no longer supported) */ +#define YAZ_MARC_OAIMARC 2 +/** \brief Output format: MARCXML */ +#define YAZ_MARC_MARCXML 3 +/** \brief Output format: ISO2709 */ +#define YAZ_MARC_ISO2709 4 +/** \brief Output format: MarcXchange */ +#define YAZ_MARC_XCHANGE 5 + +/** \brief supply iconv handle for character set conversion .. */ +YAZ_EXPORT void yaz_marc_iconv(yaz_marc_t mt, yaz_iconv_t cd); + +/** \brief set debug level + \param mt handle + \param level level, where 0=lowest, 1 more debug, 2 even more +*/ +YAZ_EXPORT void yaz_marc_debug(yaz_marc_t mt, int level); +/** \brief decodes ISO2709 buffer using straight buffers + \param mt marc handle + \param buf input buffer + \param bsize size of buffer or (-1 if "any size") + \param result result to be stored here (allocate before use!) + \param rsize size of result (set before calling) + + Decodes MARC in buf of size bsize. + On success, result in *result with size *rsize. + Returns -1 on error, or size of input record (>0) if OK +*/ +YAZ_EXPORT int yaz_marc_decode_buf(yaz_marc_t mt, const char *buf, int bsize, + char **result, int *rsize); + +/** \brief decodes ISO2709/MARC buffer and stores result in WRBUF + \param mt handle + \param buf input buffer + \param bsize size of buffer (-1 if "any size") + \param wrbuf WRBUF for output + + Decodes MARC in buf of size bsize. + On success, result in wrbuf + Returns -1 on error, or size of input record (>0) if OK +*/ +YAZ_EXPORT int yaz_marc_decode_wrbuf(yaz_marc_t mt, const char *buf, + int bsize, WRBUF wrbuf); + +/** \brief depricated */ +YAZ_EXPORT int marc_display(const char *buf, FILE *outf); +/** \brief depricated */ +YAZ_EXPORT int marc_display_ex(const char *buf, FILE *outf, int debug); +/** \brief depricated */ +YAZ_EXPORT int marc_display_exl(const char *buf, FILE *outf, int debug, + int length); +/** \brief depricated */ +YAZ_EXPORT int marc_display_wrbuf(const char *buf, WRBUF wr, int debug, + int bsize); +/** \brief depricated */ +YAZ_EXPORT int yaz_marc_decode(const char *buf, WRBUF wr, + int debug, int bsize, int xml); + +YAZ_EXPORT void yaz_marc_subfield_str(yaz_marc_t mt, const char *s); +YAZ_EXPORT void yaz_marc_endline_str(yaz_marc_t mt, const char *s); + +/** \brief modifies part of the MARC leader */ +YAZ_EXPORT void yaz_marc_modify_leader(yaz_marc_t mt, size_t off, + const char *str); + +/** \brief like atoi(3) except that it reads exactly len characters */ +YAZ_EXPORT int atoi_n(const char *buf, int len); + +/** \brief MARC control char: record separator (29 Dec, 1D Hex) */ #define ISO2709_RS 035 +/** \brief MARC control char: field separator (30 Dec, 1E Hex) */ #define ISO2709_FS 036 +/** \brief MARC control char: identifier-field separator (31 Dec, 1F Hex) */ #define ISO2709_IDFS 037 +/** \brief read ISO2709/MARC record from buffer + \param mt handle + \param buf ISO2709 buffer of size bsize + \param bsize size of buffer (-1 for unlimited size) + + Parses ISO2709 record from supplied buffer + Returns > 0 for OK (same as length), -1=ERROR +*/ +YAZ_EXPORT int yaz_marc_read_iso2709(yaz_marc_t mt, + const char *buf, int bsize); + +/** \brief parses MARCXML/MarcXchange record from xmlNode pointer + \param mt handle + \param xmlnode is a pointer to root xmlNode pointer + + Returns 0=OK, -1=ERROR +*/ +YAZ_EXPORT int yaz_marc_read_xml(yaz_marc_t mt, const void *xmlnode); + +/** \brief writes record in line format + \param mt handle + \param wrbuf WRBUF for output + + Returns 0=OK, -1=ERROR +*/ +YAZ_EXPORT int yaz_marc_write_line(yaz_marc_t mt, WRBUF wrbuf); + +/** \brief writes record in MARCXML format + \param mt handle + \param wrbuf WRBUF for output + + 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 + \param mt handle + \param wrbuf WRBUF for output + \param format record format (e.g. "MARC21") + \param type record type (e.g. Bibliographic) + + Returns 0=OK, -1=ERROR +*/ +YAZ_EXPORT int yaz_marc_write_marcxchange(yaz_marc_t mt, WRBUF wrbuf, + const char *format, + const char *type); + +/** \brief writes record in ISO2709 format + \param mt handle + \param wrbuf WRBUF for output + Returns 0=OK, -1=ERROR +*/ +YAZ_EXPORT int yaz_marc_write_iso2709(yaz_marc_t mt, WRBUF wrbuf); + +/** \brief writes record in mode - given by yaz_marc_xml mode + \param mt handle + \param wrbuf WRBUF for output + This function calls yaz_marc_write_iso2709, yaz_marc_write_marcxml, + etc.. depending on mode given by yaz_marc_xml. + Returns 0=OK, -1=ERROR +*/ +YAZ_EXPORT int yaz_marc_write_mode(yaz_marc_t mt, WRBUF wrbuf); + +/** \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); YAZ_END_CDECL #endif +/* + * Local variables: + * c-basic-offset: 4 + * indent-tabs-mode: nil + * End: + * vim: shiftwidth=4 tabstop=8 expandtab + */ +