/* This file is part of the YAZ toolkit.
- * Copyright (C) 1995-2010 Index Data.
+ * Copyright (C) 1995-2013 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 */
/** \brief Output format: MarcXchange (ISO25577) */
#define YAZ_MARC_XCHANGE 5
/** \brief Output format: check only (no marc output) */
-#define YAZ_MARC_CHECK 6
-/** \brief Output format: Turbo MARCXML Index Data format*/
-#define YAZ_MARC_TMARCXML 7
+#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 */
YAZ_EXPORT void yaz_marc_iconv(yaz_marc_t mt, yaz_iconv_t cd);
/** \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
+/** \brief set debug level
\param mt handle
- \param level level, where 0=lowest, 1 more debug, 2 even more
+ \param level level, where 0=lowest, 1 more debug, 2 even more
*/
YAZ_EXPORT void yaz_marc_debug(yaz_marc_t mt, int level);
\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.
+ 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,
Parses MARC line record from stream
Returns > 0 for OK (same as length), -1=ERROR
*/
-YAZ_EXPORT
+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);
#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
+ \param ptr is a pointer to root xml node
\retval 0 OK
\retval -1 ERROR
*/
*/
YAZ_EXPORT int yaz_marc_write_marcxml(yaz_marc_t mt, WRBUF wrbuf);
+/** \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
\retval -1 ERROR
This function calls yaz_marc_write_iso2709, yaz_marc_write_marcxml,
- etc.. depending on mode given by yaz_marc_xml.
-*/
+ etc.. depending on mode given by yaz_marc_xml.
+*/
YAZ_EXPORT int yaz_marc_write_mode(yaz_marc_t mt, WRBUF wrbuf);
#if YAZ_HAVE_XML2
\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 *ns,
const char *format,
const char *type);
#endif
\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);
\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_starting length of starting
\param length_implementation length of implementation defined data
*/
YAZ_EXPORT
/** \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, ...);
\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);
\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);
\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 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
\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);
\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 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
\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);
\param arg string
\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 Enables or disables 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);
\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
+ \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);
+
+#if YAZ_HAVE_XML2
+/** \brief Converts XML to OPAC
+ \param mt marc handle
+ \param src XML root node (presumably opacRecord node)
+ \param dst Z39.50 OPAC result - allocated by NMEM on marc handle
+ \param cd iconv handle for the OPAC content (not ISO2709 part)
+
+ \*/
+YAZ_EXPORT void yaz_xml_to_opac(yaz_marc_t mt, xmlNode *src,
+ Z_OPACRecord **dst, yaz_iconv_t cd);
+#endif
+
/** \brief flushes records
\param mt handle
\param wr WRBUF for output
\retval 0 OK
\retval -1 ERROR
-*/
+*/
YAZ_EXPORT int yaz_marc_write_trailer(yaz_marc_t mt, WRBUF wr);
/** \brief enables record collection output
\param mt handle
-*/
+*/
YAZ_EXPORT void yaz_marc_enable_collection(yaz_marc_t mt);
YAZ_END_CDECL
projects / yaz-moved-to-github.git / blobdiff