CCL: add two new diagnostics for unsupported masking

[yaz-moved-to-github.git] / include / yaz / marcdisp.h

diff --git a/include/yaz/marcdisp.h b/include/yaz/marcdisp.h
index 0e85c3b..437fc0a 100644 (file)
--- a/include/yaz/marcdisp.h
+++ b/include/yaz/marcdisp.h
@@ -1,5 +1,5 @@
-/*
- * Copyright (c) 1995-2006, Index Data
+/* This file is part of the YAZ toolkit.
+ * Copyright (C) 1995-2012 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:
  * 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,6 @@
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
  * (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
 
 /**
  * \file marcdisp.h

@@ -40,6 +39,7 @@
 
 #include <yaz/nmem.h>
 #include <yaz/xmltypes.h>
 
 #include <yaz/nmem.h>
 #include <yaz/xmltypes.h>

+#include <yaz/z-opac.h>

 
 YAZ_BEGIN_CDECL
 
 
 YAZ_BEGIN_CDECL
 

@@ -52,7 +52,12 @@ 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 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 */
 YAZ_EXPORT void yaz_marc_xml(yaz_marc_t mt, int xmlmode);
 
 /** \brief Output format: Line-format */

@@ -65,14 +70,19 @@ YAZ_EXPORT void yaz_marc_xml(yaz_marc_t mt, int xmlmode);
 #define YAZ_MARC_MARCXML   3
 /** \brief Output format: ISO2709 */
 #define YAZ_MARC_ISO2709   4
 #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_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 supply 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);
 
 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 
     \param mt handle
     \param level level, where 0=lowest, 1 more debug, 2 even more 
 /** \brief set debug level 
     \param mt handle
     \param level level, where 0=lowest, 1 more debug, 2 even more 

@@ -83,15 +93,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 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,
 
     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
 
 /** \brief decodes ISO2709/MARC buffer and stores result in WRBUF
     \param mt handle

@@ -106,20 +116,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);
 
 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);
 
 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);
 

@@ -127,7 +123,11 @@ YAZ_EXPORT void yaz_marc_endline_str(yaz_marc_t mt, const char *s);
 YAZ_EXPORT void yaz_marc_modify_leader(yaz_marc_t mt, size_t off,
                                        const char *str);
 
 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
 YAZ_EXPORT int atoi_n(const char *buf, int len);
 
 /** \brief like atoi_n but checks for proper formatting

@@ -153,7 +153,8 @@ int atoi_n_check(const char *buf, int size, int *val);
     \param bsize size of buffer (-1 for unlimited size)
 
     Parses ISO2709 record from supplied buffer
     \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);
 */
 YAZ_EXPORT int yaz_marc_read_iso2709(yaz_marc_t mt,
                                      const char *buf, int bsize);

@@ -163,6 +164,8 @@ YAZ_EXPORT int yaz_marc_read_iso2709(yaz_marc_t mt,
     \param getbyte get one byte handler
     \param ungetbyte unget one byte handler
     \param client_data opaque data for handers
     \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
 
     Parses MARC line record from stream
     Returns > 0 for OK (same as length), -1=ERROR

@@ -173,37 +176,49 @@ int yaz_marc_read_line(yaz_marc_t mt,
                        void (*ungetbyte)(int b, void *client_data),
                        void *client_data);
 
                        void (*ungetbyte)(int b, void *client_data),
                        void *client_data);
 

-/** \brief parses MARCXML/MarcXchange record from xmlNode pointer 
+#if YAZ_HAVE_XML2
+/** \brief parses MARCXML/MarcXchange/TurboMARC record from xmlNode pointer 

     \param mt handle
     \param ptr is a pointer to root xml node 
     \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);
 */
 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
 
 /** \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
 */
 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);
 
 */
 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)
     \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,
 */
 YAZ_EXPORT int yaz_marc_write_marcxchange(yaz_marc_t mt, WRBUF wrbuf,
                                           const char *format,

@@ -212,19 +227,23 @@ YAZ_EXPORT int yaz_marc_write_marcxchange(yaz_marc_t mt, WRBUF wrbuf,
 /** \brief writes record in ISO2709 format
     \param mt handle
     \param wrbuf WRBUF for output
 /** \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
 */
 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. 
     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 int yaz_marc_write_mode(yaz_marc_t mt, WRBUF wrbuf);
 

+#if YAZ_HAVE_XML2

 /** \brief writes MARC record as libxml2 tree
     \param mt handle
     \param root_ptr pointer to record node
 /** \brief writes MARC record as libxml2 tree
     \param mt handle
     \param root_ptr pointer to record node

@@ -239,6 +258,7 @@ int yaz_marc_write_xml(yaz_marc_t mt, xmlNode **root_ptr,
                        const char *ns, 
                        const char *format,
                        const char *type);
                        const char *ns, 
                        const char *format,
                        const char *type);

+#endif

 
 /** \brief sets leader spec (for modifying bytes in 24 byte leader)
     \param mt handle
 
 /** \brief sets leader spec (for modifying bytes in 24 byte leader)
     \param mt handle

@@ -265,7 +285,7 @@ YAZ_EXPORT int yaz_marc_leader_spec(yaz_marc_t mt, const char *leader_spec);
     \param length_implementation length of implementation defined data
 */
 YAZ_EXPORT
     \param length_implementation length of implementation defined data
 */
 YAZ_EXPORT

-void yaz_marc_set_leader(yaz_marc_t mt, const char *leader_c,
+void yaz_marc_set_leader(yaz_marc_t mt, const char *leader,

                          int *indicator_length,
                          int *identifier_length,
                          int *base_address,
                          int *indicator_length,
                          int *identifier_length,
                          int *base_address,

@@ -309,6 +329,7 @@ void yaz_marc_add_controlfield(yaz_marc_t mt, const char *tag,
                                const char *data, size_t data_len);
 
 
                                const char *data, size_t data_len);
 
 

+#if YAZ_HAVE_XML2

 /** \brief adds controlfield to MARC structure using xml Nodes
     \param mt handle
     \param ptr_tag value of tag (TEXT xmlNode)
 /** \brief adds controlfield to MARC structure using xml Nodes
     \param mt handle
     \param ptr_tag value of tag (TEXT xmlNode)

@@ -318,6 +339,15 @@ YAZ_EXPORT
 void yaz_marc_add_controlfield_xml(yaz_marc_t mt, const xmlNode *ptr_tag,
                                    const xmlNode *ptr_data);
 
 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 mt handle
 
 /** \brief adds datafield to MARC structure using strings
     \param mt handle

@@ -329,6 +359,7 @@ YAZ_EXPORT
 void yaz_marc_add_datafield(yaz_marc_t mt, const char *tag,
                             const char *indicator, size_t indicator_len);
 
 void yaz_marc_add_datafield(yaz_marc_t mt, const char *tag,
                             const char *indicator, size_t indicator_len);
 

+#if YAZ_HAVE_XML2

 /** \brief adds datafield to MARC structure using xml Nodes
     \param mt handle
     \param ptr_tag value of tag (TEXT xmlNode)
 /** \brief adds datafield to MARC structure using xml Nodes
     \param mt handle
     \param ptr_tag value of tag (TEXT xmlNode)

@@ -339,6 +370,16 @@ YAZ_EXPORT
 void yaz_marc_add_datafield_xml(yaz_marc_t mt, const xmlNode *ptr_tag,
                                 const char *indicator, size_t indicator_len);
 
 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
 
 /** \brief returns memory for MARC handle
     \param mt handle

@@ -359,26 +400,64 @@ void yaz_marc_reset(yaz_marc_t mt);
 YAZ_EXPORT
 int yaz_marc_get_debug(yaz_marc_t mt);
 
 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
     \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);
 
 */  
 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);
 
     \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 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
+    \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
+    \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
 
 #endif
 /*
  * Local variables:
  * c-basic-offset: 4
 YAZ_END_CDECL
 
 #endif
 /*
  * Local variables:
  * c-basic-offset: 4

+ * c-file-style: "Stroustrup"

  * indent-tabs-mode: nil
  * End:
  * vim: shiftwidth=4 tabstop=8 expandtab
  * indent-tabs-mode: nil
  * End:
  * vim: shiftwidth=4 tabstop=8 expandtab