SRW, CQL, 2003
[yaz-moved-to-github.git] / include / yaz / marcdisp.h
1 /*
2  * Copyright (c) 1995-2003, Index Data.
3  *
4  * Permission to use, copy, modify, distribute, and sell this software and
5  * its documentation, in whole or in part, for any purpose, is hereby granted,
6  * provided that:
7  *
8  * 1. This copyright and permission notice appear in all copies of the
9  * software and its documentation. Notices of copyright or attribution
10  * which appear at the beginning of any file must remain unchanged.
11  *
12  * 2. The name of Index Data or the individual authors may not be used to
13  * endorse or promote products derived from this software without specific
14  * prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
18  * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
19  * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
20  * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
21  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
22  * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
23  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
24  * OF THIS SOFTWARE.
25  *
26  * $Id: marcdisp.h,v 1.8 2003-01-06 08:20:27 adam Exp $
27  */
28
29 #ifndef MARCDISP_H
30 #define MARCDISP_H
31
32 #include <yaz/yconfig.h>
33 #include <stdio.h>
34 #include <yaz/wrbuf.h>
35
36 YAZ_BEGIN_CDECL
37
38 typedef struct yaz_marc_t_ *yaz_marc_t;
39
40 /* create handler */
41 YAZ_EXPORT yaz_marc_t yaz_marc_create(void);
42 /* destroy */
43 YAZ_EXPORT void yaz_marc_destroy(yaz_marc_t mt);
44
45 /* set XML mode YAZ_MARC_LINE, YAZ_MARC_SIMPLEXML, ... */
46 YAZ_EXPORT void yaz_marc_xml(yaz_marc_t mt, int xmlmode);
47 #define YAZ_MARC_LINE      0
48 #define YAZ_MARC_SIMPLEXML 1
49 #define YAZ_MARC_OAIMARC   2
50 #define YAZ_MARC_MARCXML   3
51
52 /* set debug level, 0=none, 1=more, 2=even more, .. */
53 YAZ_EXPORT void yaz_marc_debug(yaz_marc_t mt, int level);
54
55 /* decode MARC in buf of size bsize. Returns >0 on success; <=0 on failure.
56    On success, result in *result with size *rsize. */
57 YAZ_EXPORT int yaz_marc_decode_buf (yaz_marc_t mt, const char *buf, int bsize,
58                                     char **result, int *rsize);
59
60 /* decode MARC in buf of size bsize. Returns >0 on success; <=0 on failure.
61    On success, result in WRBUF */
62 YAZ_EXPORT int yaz_marc_decode_wrbuf (yaz_marc_t mt, const char *buf,
63                                       int bsize, WRBUF wrbuf);
64
65 /* old functions (depricated) */
66 YAZ_EXPORT int marc_display (const char *buf, FILE *outf);
67 YAZ_EXPORT int marc_display_ex (const char *buf, FILE *outf, int debug);
68 YAZ_EXPORT int marc_display_exl (const char *buf, FILE *outf, int debug,
69                                  int length);
70 YAZ_EXPORT int marc_display_wrbuf (const char *buf, WRBUF wr, int debug,
71                                    int bsize);
72 YAZ_EXPORT int yaz_marc_decode(const char *buf, WRBUF wr,
73                                int debug, int bsize, int xml);
74
75
76 /* like atoi except that it reads exactly len characters */
77 YAZ_EXPORT int atoi_n (const char *buf, int len);
78
79 /* MARC control characters */
80 #define ISO2709_RS 035
81 #define ISO2709_FS 036
82 #define ISO2709_IDFS 037
83
84 YAZ_END_CDECL
85
86 #endif