/* This file is part of the YAZ toolkit.
- * Copyright (C) 1995-2008 Index Data.
+ * Copyright (C) 1995-2011 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:
/** \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, ... */
+/** \brief set XML mode YAZ_MARC_LINE, YAZ_MARCXML, YAZ_MARC_ISO2709 ..
+ \param mt MARC handle
+ \param xmlmode mode.
+
+ This function ONLY affects yaz_marc_write_mode, yaz_marc_write_trailer.
+*/
YAZ_EXPORT void yaz_marc_xml(yaz_marc_t mt, int xmlmode);
/** \brief Output format: Line-format */
#define YAZ_MARC_MARCXML 3
/** \brief Output format: ISO2709 */
#define YAZ_MARC_ISO2709 4
-/** \brief Output format: MarcXchange */
+/** \brief Output format: MarcXchange (ISO25577) */
#define YAZ_MARC_XCHANGE 5
/** \brief Output format: check only (no marc output) */
-#define YAZ_MARC_CHECK 6
+#define YAZ_MARC_CHECK 6
+/** \brief Output format: Turbo MARC Index Data format (XML based) */
+#define YAZ_MARC_TURBOMARC 7
-/** \brief set iconv handle for character set conversion .. */
+/** \brief set iconv handle for character set conversion */
YAZ_EXPORT void yaz_marc_iconv(yaz_marc_t mt, yaz_iconv_t cd);
-/** \brief supply iconv handle for character set conversion .. */
+/** \brief supply iconv handle for character set conversion */
YAZ_EXPORT yaz_iconv_t yaz_marc_get_iconv(yaz_marc_t mt);
/** \brief set debug level
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 */
+/** \brief like atoi(3) except that it reads exactly len characters
+ \param buf buffer to read
+ \param len number of bytes to consider (being digits)
+ \returns value
+ */
YAZ_EXPORT int atoi_n(const char *buf, int len);
/** \brief like atoi_n but checks for proper formatting
\param bsize size of buffer (-1 for unlimited size)
Parses ISO2709 record from supplied buffer
- Returns > 0 for OK (same as length), -1=ERROR
+ \retval -1 ERROR
+ \retval >0 OK (length)
*/
YAZ_EXPORT int yaz_marc_read_iso2709(yaz_marc_t mt,
const char *buf, int bsize);
\param getbyte get one byte handler
\param ungetbyte unget one byte handler
\param client_data opaque data for handers
+ \retval -1 ERROR
+ \retval >0 OK (length)
Parses MARC line record from stream
Returns > 0 for OK (same as length), -1=ERROR
void *client_data);
#if YAZ_HAVE_XML2
-/** \brief parses MARCXML/MarcXchange record from xmlNode pointer
+/** \brief parses MARCXML/MarcXchange/TurboMARC record from xmlNode pointer
\param mt handle
\param ptr is a pointer to root xml node
-
- Returns 0=OK, -1=ERROR
+ \retval 0 OK
+ \retval -1 ERROR
*/
YAZ_EXPORT int yaz_marc_read_xml(yaz_marc_t mt, const xmlNode *ptr);
#endif
/** \brief writes record in line format
\param mt handle
\param wrbuf WRBUF for output
-
- Returns 0=OK, -1=ERROR
+ \retval 0 OK
+ \retval -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
+ \retval 0 OK
+ \retval -1 ERROR
- Sets leader[9]='a' . Returns 0=OK, -1=ERROR .
+ Sets leader[9]='a' .
*/
YAZ_EXPORT int yaz_marc_write_marcxml(yaz_marc_t mt, WRBUF wrbuf);
-/** \brief writes record in MarcXchange XML
+/** \brief writes record in TurboMARC format
+ \param mt handle
+ \param wrbuf WRBUF for output
+ \retval 0 OK
+ \retval -1 ERROR
+*/
+YAZ_EXPORT int yaz_marc_write_turbomarc(yaz_marc_t mt, WRBUF wrbuf);
+
+/** \brief writes record in MarcXchange XML (ISO25577)
\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
+ \retval 0 OK
+ \retval -1 ERROR
*/
YAZ_EXPORT int yaz_marc_write_marcxchange(yaz_marc_t mt, WRBUF wrbuf,
const char *format,
/** \brief writes record in ISO2709 format
\param mt handle
\param wrbuf WRBUF for output
- Returns 0=OK, -1=ERROR
+ \retval 0 OK
+ \retval -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
+ \retval 0 OK
+ \retval -1 ERROR
+
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);
YAZ_EXPORT
void yaz_marc_add_controlfield_xml(yaz_marc_t mt, const xmlNode *ptr_tag,
const xmlNode *ptr_data);
+
+/** \brief adds controlfield to MARC structure using xml Nodes for data
+ \param mt handle
+ \param tag string tag
+ \param ptr_data value of data (TEXT xmlNode)
+*/
+YAZ_EXPORT
+void yaz_marc_add_controlfield_xml2(yaz_marc_t mt, char *tag,
+ const xmlNode *ptr_data);
#endif
/** \brief adds datafield to MARC structure using strings
YAZ_EXPORT
void yaz_marc_add_datafield_xml(yaz_marc_t mt, const xmlNode *ptr_tag,
const char *indicator, size_t indicator_len);
+
+/** \brief adds datafield to MARC structure using xml Nodes
+ \param mt handle
+ \param tag_value string value (pointer copied verbatim, not strdupped)
+ \param indicators indicator string ; pointer copied verbatim; not strdupped
+*/
+YAZ_EXPORT
+void yaz_marc_add_datafield_xml2(yaz_marc_t mt, char *tag_value,
+ char *indicators);
+
#endif
/** \brief returns memory for MARC handle
YAZ_EXPORT
int yaz_marc_get_debug(yaz_marc_t mt);
-/** \brief convert MARC format type to format type(YAZ_MARC_..)
+/** \brief Converts MARC format type to format type(YAZ_MARC_..)
\param arg string
- \returns -1 if arg is not a known format; YAZ_MARC_.. otherwise (OK)
+ \retval -1 unknown format (bad arg)
+ \retval >= 0 OK (one of YAZ_MARC - values)
*/
YAZ_EXPORT
int yaz_marc_decode_formatstr(const char *arg);
-/** \brief enable writing of MARC XML records using Libxml2
+/** \brief Enables or disables 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);
-/** \brief Performs "pretty" display of OPAC record to WRBUF */
-YAZ_EXPORT void yaz_display_OPAC(WRBUF wrbuf, Z_OPACRecord *r, int flags);
+/** \brief Performs "pretty" display of OPAC record to WRBUF using marc_t
+ \param mt handle
+ \param r OPAC record
+ \param wrbuf WRBUF for resulting display string
+
+ This function uses iconv_handle of yaz_marc_t for character set
+ conversion of both OPAC + ISO2709 part.
+ \*/
+YAZ_EXPORT void yaz_opac_decode_wrbuf(yaz_marc_t mt, Z_OPACRecord *r,
+ WRBUF wrbuf);
-/** \brief Performs "pretty" display of OPAC record to WRBUF using marc_t */
-YAZ_EXPORT void yaz_opac_decode_wrbuf(yaz_marc_t mt, Z_OPACRecord *r, WRBUF wrbuf);
+/** \brief Performs "pretty" display of OPAC record to WRBUF using marc_t
+ \param mt handle
+ \param r OPAC record
+ \param wrbuf WRBUF for resulting display string
+ \param cd iconv handle for OPAC content (not ISO2709 part)
+ This function uses iconv handle of yaz_marc_t for character set
+ conversion of ISO2709 part and supplied handle (cd) for OPAC part.
+ \*/
+YAZ_EXPORT void yaz_opac_decode_wrbuf2(yaz_marc_t mt, Z_OPACRecord *r,
+ WRBUF wrbuf, yaz_iconv_t cd);
/** \brief flushes records
\param mt handle
/*
* Local variables:
* c-basic-offset: 4
+ * c-file-style: "Stroustrup"
* indent-tabs-mode: nil
* End:
* vim: shiftwidth=4 tabstop=8 expandtab