X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=include%2Fyaz%2Fmarcdisp.h;h=834e37f92b42cce98dbcdf73c381ec4249d30edf;hb=ffc156e81106f536a43f949379cee95b16e0c957;hp=97fad09dc0a1336c4b6ce287c4002e4a151a3a0a;hpb=8f8560e0ab3b370263683d8aea81b839c5927091;p=yaz-moved-to-github.git diff --git a/include/yaz/marcdisp.h b/include/yaz/marcdisp.h index 97fad09..834e37f 100644 --- a/include/yaz/marcdisp.h +++ b/include/yaz/marcdisp.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 1995-2006, Index Data + * Copyright (c) 1995-2007, 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: @@ -24,7 +24,7 @@ * (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.21 2006-12-13 11:25:17 adam Exp $ */ +/* $Id: marcdisp.h,v 1.28 2007-03-19 14:40:06 adam Exp $ */ /** * \file marcdisp.h @@ -38,6 +38,7 @@ #include #include +#include #include YAZ_BEGIN_CDECL @@ -82,15 +83,15 @@ YAZ_EXPORT void yaz_marc_debug(yaz_marc_t mt, int level); \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) + \param result result to be stored here + \param rsize size of result (memory "owned" by yaz_marc_mt handle) 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); + const char **result, size_t *rsize); /** \brief decodes ISO2709/MARC buffer and stores result in WRBUF \param mt handle @@ -105,20 +106,6 @@ YAZ_EXPORT int yaz_marc_decode_buf(yaz_marc_t mt, const char *buf, int bsize, 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); @@ -129,6 +116,16 @@ YAZ_EXPORT void yaz_marc_modify_leader(yaz_marc_t mt, size_t off, /** \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) */ @@ -147,6 +144,21 @@ YAZ_EXPORT int atoi_n(const char *buf, int len); 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 ptr is a pointer to root xml node @@ -199,6 +211,21 @@ YAZ_EXPORT int yaz_marc_write_iso2709(yaz_marc_t mt, WRBUF wrbuf); */ 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 @@ -211,6 +238,127 @@ YAZ_EXPORT int yaz_marc_write_mode(yaz_marc_t mt, WRBUF wrbuf); */ 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, + 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