Added MarcXchange support.
[yaz-moved-to-github.git] / include / yaz / marcdisp.h
index 86abc0f..f027be3 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1995-2001, Index Data.
+ * Copyright (C) 1995-2005, 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.
  *
- * $Log: marcdisp.h,v $
- * Revision 1.4  2001-10-29 09:17:19  adam
- * New function marc_display_exl - used by YAZ client. Server returns
- * bad record on position 98 (for testing).
- *
- * Revision 1.3  2001/04/06 12:26:46  adam
- * Optional CCL module. Moved atoi_n to marcdisp.h from yaz-util.h.
- *
- * Revision 1.2  2000/02/28 11:20:06  adam
- * Using autoconf. New definitions: YAZ_BEGIN_CDECL/YAZ_END_CDECL.
- *
- * Revision 1.1  1999/11/30 13:47:11  adam
- * Improved installation. Moved header files to include/yaz.
- *
- * Revision 1.8  1997/09/24 13:35:45  adam
- * Added two members to data1_marctab to ease reading of weird MARC records.
- *
- * Revision 1.7  1997/09/04 07:57:51  adam
- * Definition of ISO2709 control characters to this file.
- *
- * Revision 1.6  1997/09/01 08:49:49  adam
- * New windows NT/95 port using MSV5.0. To export DLL functions the
- * YAZ_EXPORT modifier was added. Defined in yconfig.h.
- *
- * Revision 1.5  1997/05/14 06:53:40  adam
- * C++ support.
- *
- * Revision 1.4  1995/09/29 17:12:03  quinn
- * Smallish
- *
- * Revision 1.3  1995/09/27  15:02:47  quinn
- * Modified function heads & prototypes.
- *
- * Revision 1.2  1995/05/16  08:50:32  quinn
- * License, documentation, and memory fixes
- *
- * Revision 1.1  1995/04/10  10:28:28  quinn
- * Added copy of CCL.
- *
+ * $Id: marcdisp.h,v 1.13 2005-02-08 13:51:30 adam Exp $
+ */
+
+/**
+ * \file marcdisp.h
+ * \brief Header for MARC display - and conversion utilities
  */
 
 #ifndef MARCDISP_H
 #define MARCDISP_H
 
 #include <yaz/yconfig.h>
+#include <stdio.h>
+#include <yaz/wrbuf.h>
 
 YAZ_BEGIN_CDECL
 
+typedef struct yaz_marc_t_ *yaz_marc_t;
+
+/* create handler */
+YAZ_EXPORT yaz_marc_t yaz_marc_create(void);
+/* destroy */
+YAZ_EXPORT void yaz_marc_destroy(yaz_marc_t mt);
+
+/* set XML mode YAZ_MARC_LINE, YAZ_MARC_SIMPLEXML, ... */
+YAZ_EXPORT void yaz_marc_xml(yaz_marc_t mt, int xmlmode);
+#define YAZ_MARC_LINE      0
+#define YAZ_MARC_SIMPLEXML 1
+#define YAZ_MARC_OAIMARC   2
+#define YAZ_MARC_MARCXML   3
+#define YAZ_MARC_ISO2709   4
+#define YAZ_MARC_XCHANGE   5
+
+/* 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, .. */
+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);
+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);
 
+/* MARC control characters */
 #define ISO2709_RS 035
 #define ISO2709_FS 036
 #define ISO2709_IDFS 037