Exteded yaz_marc_write_marcxhange new parameters, format and type.

More Doxygen comments.

diff --git a/include/yaz/marcdisp.h b/include/yaz/marcdisp.h
index 420f53b..77fba49 100644 (file)
--- a/include/yaz/marcdisp.h
+++ b/include/yaz/marcdisp.h
@@ -23,7 +23,7 @@
  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  * OF THIS SOFTWARE.
  *
- * $Id: marcdisp.h,v 1.16 2006-04-20 19:47:01 adam Exp $
+ * $Id: marcdisp.h,v 1.17 2006-04-20 20:35:02 adam Exp $
  */
 
 /**
@@ -80,15 +80,24 @@ YAZ_EXPORT void yaz_marc_debug(yaz_marc_t mt, int level);
     \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)
-    
-    decode MARC in buf of size bsize. Returns >0 on success; <=0 on failure.
+
+    Decodes MARC in buf of size bsize.
     On success, result in *result with size *rsize. 
-    Returns -1 on error, size of input record (>0) if OK
+    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/MAC buffer and stores result in WRBUF */
+/** \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);
 
@@ -113,7 +122,7 @@ 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);
 
-/** \brief like atoi except that it reads exactly len characters */
+/** \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) */
@@ -123,22 +132,69 @@ YAZ_EXPORT int atoi_n(const char *buf, int len);
 /** \brief MARC control char: identifier-field separator (31 Dec, 1F Hex) */
 #define ISO2709_IDFS 037
 
-/** \brief read ISO2709/MARC record from buffer */
+/** \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 read MARCXML record from buffer */
+
+/** \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 */
+/** \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 */
+
+/** \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 format */
-YAZ_EXPORT int yaz_marc_write_marcxchange(yaz_marc_t mt, WRBUF wrbuf);
-/** \brief writes record in ISO2709 format */
+
+/** \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 */
-YAZ_EXPORT int yaz_marc_write_mode(yaz_marc_t mt, WRBUF wr);
+
+/** \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);
 
 YAZ_END_CDECL
 

diff --git a/src/marcdisp.c b/src/marcdisp.c
index 846c38f..f56f280 100644 (file)
--- a/src/marcdisp.c
+++ b/src/marcdisp.c
@@ -2,7 +2,7 @@
  * Copyright (C) 1995-2006, Index Data ApS
  * See the file LICENSE for details.
  *
- * $Id: marcdisp.c,v 1.27 2006-04-20 19:47:01 adam Exp $
+ * $Id: marcdisp.c,v 1.28 2006-04-20 20:35:02 adam Exp $
  */
 
 /**
@@ -370,16 +370,6 @@ void yaz_marc_endline_str(yaz_marc_t mt, const char *s)
     mt->endline_str[sizeof(mt->endline_str)-1] = '\0';
 }
 
-static void marc_cdata (yaz_marc_t mt, const char *buf, size_t len, WRBUF wr)
-{
-    if (mt->xml == YAZ_MARC_ISO2709)
-        wrbuf_iconv_write(wr, mt->iconv_cd, buf, len);
-    else if (mt->xml == YAZ_MARC_LINE)
-        wrbuf_iconv_write(wr, mt->iconv_cd, buf, len);
-    else
-        wrbuf_iconv_write_cdata(wr, mt->iconv_cd, buf, len);
-}
-
 /* try to guess how many bytes the identifier really is! */
 static size_t cdata_one_character(yaz_marc_t mt, const char *buf)
 {
@@ -484,15 +474,24 @@ int yaz_marc_write_mode(yaz_marc_t mt, WRBUF wr)
     case YAZ_MARC_MARCXML:
         return yaz_marc_write_marcxml(mt, wr);
     case YAZ_MARC_XCHANGE:
-        return yaz_marc_write_marcxchange(mt, wr);
+        return yaz_marc_write_marcxchange(mt, wr, 0, 0); /* no format, type */
     case YAZ_MARC_ISO2709:
         return yaz_marc_write_iso2709(mt, wr);
     }
     return -1;
 }
 
+/** \brief common MARC XML/Xchange writer
+    \param mt handle
+    \param wr WRBUF output
+    \param ns XMLNS for the elements
+    \param format record format (e.g. "MARC21")
+    \param type record type (e.g. "Bibliographic")
+*/
 static int yaz_marc_write_marcxml_ns(yaz_marc_t mt, WRBUF wr,
-                                     const char *ns)
+                                     const char *ns, 
+                                     const char *format,
+                                     const char *type)
 {
     struct yaz_marc_node *n;
     int identifier_length;
@@ -510,7 +509,12 @@ static int yaz_marc_write_marcxml_ns(yaz_marc_t mt, WRBUF wr,
     if (!atoi_n_check(leader+11, 1, &identifier_length))
         return -1;
 
-    wrbuf_printf(wr, "<record xmlns=\"%s\">\n", ns);
+    wrbuf_printf(wr, "<record xmlns=\"%s\"", ns);
+    if (format)
+        wrbuf_printf(wr, " format=\"%.80s\"", format);
+    if (type)
+        wrbuf_printf(wr, " type=\"%.80s\"", type);
+    wrbuf_printf(wr, ">\n");
     for (n = mt->nodes; n; n = n->next)
     {
         struct yaz_marc_subfield *s;
@@ -580,13 +584,17 @@ static int yaz_marc_write_marcxml_ns(yaz_marc_t mt, WRBUF wr,
 int yaz_marc_write_marcxml(yaz_marc_t mt, WRBUF wr)
 {
     yaz_marc_modify_leader(mt, 9, "a");
-    return yaz_marc_write_marcxml_ns(mt, wr, "http://www.loc.gov/MARC21/slim");
+    return yaz_marc_write_marcxml_ns(mt, wr, "http://www.loc.gov/MARC21/slim",
+                                     0, 0);
 }
 
-int yaz_marc_write_marcxchange(yaz_marc_t mt, WRBUF wr)
+int yaz_marc_write_marcxchange(yaz_marc_t mt, WRBUF wr,
+                               const char *format,
+                               const char *type)
 {
     return yaz_marc_write_marcxml_ns(mt, wr,
-                                     "http://www.bs.dk/standards/MarcXchange");
+                                     "http://www.bs.dk/standards/MarcXchange",
+                                     0, 0);
 }
 
 int yaz_marc_write_iso2709(yaz_marc_t mt, WRBUF wr)