/*
- * Copyright (c) 1995-2004, Index Data.
+ * Copyright (C) 1995-2006, Index Data ApS
*
* Permission to use, copy, modify, distribute, and sell this software and
* its documentation, in whole or in part, for any purpose, is hereby granted,
* LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
* OF THIS SOFTWARE.
*
- * $Id: marcdisp.h,v 1.10 2004-10-15 00:18:59 adam Exp $
+ * $Id: marcdisp.h,v 1.15 2006-04-19 10:05:02 adam Exp $
*/
/**
* \file marcdisp.h
- * \brief Header for MARC display - and conversion utilities
+ * \brief MARC conversion
*/
#ifndef MARCDISP_H
YAZ_BEGIN_CDECL
+/** \brief a yaz_marc_t handle (private content) */
typedef struct yaz_marc_t_ *yaz_marc_t;
-/* create handler */
+/** \brief construct yaz_marc_t handle */
YAZ_EXPORT yaz_marc_t yaz_marc_create(void);
-/* destroy */
+
+/** \brief destroy yaz_marc_t handle */
YAZ_EXPORT void yaz_marc_destroy(yaz_marc_t mt);
-/* set XML mode YAZ_MARC_LINE, YAZ_MARC_SIMPLEXML, ... */
+/** \brief set XML mode YAZ_MARC_LINE, YAZ_MARC_SIMPLEXML, ... */
YAZ_EXPORT void yaz_marc_xml(yaz_marc_t mt, int xmlmode);
+
+/** \brief Output format: Line-format */
#define YAZ_MARC_LINE 0
+/** \brief Output format: simplexml (no longer supported) */
#define YAZ_MARC_SIMPLEXML 1
+/** \brief Output format: OAI-MARC (no longer supported) */
#define YAZ_MARC_OAIMARC 2
+/** \brief Output format: MARCXML */
#define YAZ_MARC_MARCXML 3
+/** \brief Output format: ISO2709 */
#define YAZ_MARC_ISO2709 4
+/** \brief Output format: MarcXchange */
+#define YAZ_MARC_XCHANGE 5
-/* supply iconv handle for character set conversion .. */
+/** \brief supply iconv handle for character set conversion .. */
YAZ_EXPORT void yaz_marc_iconv(yaz_marc_t mt, yaz_iconv_t cd);
-/* set debug level, 0=none, 1=more, 2=even more, .. */
+/** \brief set debug level
+ \param mt handle
+ \param level level, where 0=lowest, 1 more debug, 2 even more
+*/
YAZ_EXPORT void yaz_marc_debug(yaz_marc_t mt, int level);
-/* decode MARC in buf of size bsize. Returns >0 on success; <=0 on failure.
- On success, result in *result with size *rsize. */
-YAZ_EXPORT int yaz_marc_decode_buf (yaz_marc_t mt, const char *buf, int bsize,
- char **result, int *rsize);
-
-/* decode MARC in buf of size bsize. Returns >0 on success; <=0 on failure.
- On success, result in WRBUF */
-YAZ_EXPORT int yaz_marc_decode_wrbuf (yaz_marc_t mt, const char *buf,
- int bsize, WRBUF wrbuf);
-
-/* old functions (depricated) */
-YAZ_EXPORT int marc_display (const char *buf, FILE *outf);
-YAZ_EXPORT int marc_display_ex (const char *buf, FILE *outf, int debug);
-YAZ_EXPORT int marc_display_exl (const char *buf, FILE *outf, int debug,
- int length);
-YAZ_EXPORT int marc_display_wrbuf (const char *buf, WRBUF wr, int debug,
- int bsize);
+/** \brief decodes ISO2709 buffer using straight buffers
+ \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)
+
+ decode MARC in buf of size bsize. Returns >0 on success; <=0 on failure.
+ On success, result in *result with size *rsize.
+ Returns -1 on error, 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 */
+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);
-/* like atoi except that it reads exactly len characters */
-YAZ_EXPORT int atoi_n (const char *buf, int len);
+/** \brief like atoi except that it reads exactly len characters */
+YAZ_EXPORT int atoi_n(const char *buf, int len);
-/* MARC control characters */
+/** \brief MARC control char: record separator (29 Dec, 1D Hex) */
#define ISO2709_RS 035
+/** \brief MARC control char: field separator (30 Dec, 1E Hex) */
#define ISO2709_FS 036
+/** \brief MARC control char: identifier-field separator (31 Dec, 1F Hex) */
#define ISO2709_IDFS 037
+/** \brief read ISO2709/MARC record from buffer */
+YAZ_EXPORT int yaz_marc_read_iso2709(yaz_marc_t mt,
+ const char *buf, int bsize);
+/** \brief read MARCXML record from buffer */
+YAZ_EXPORT int yaz_marc_read_xml(yaz_marc_t mt, const void *xmlnode);
+
+/** \brief writes record in line format */
+YAZ_EXPORT int yaz_marc_write_line(yaz_marc_t mt, WRBUF wrbuf);
+/** \brief writes record in MARCXML format */
+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 */
+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);
+
YAZ_END_CDECL
#endif
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+
projects / yaz-moved-to-github.git / blobdiff