include/yaz/marcdisp.h

   1 /*
   2  * Copyright (C) 1995-2005, Index Data ApS
   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.14 2005-06-25 15:46:03 adam Exp $
  27  */
  28
  29 /**
  30  * \file marcdisp.h
  31  * \brief Header for MARC display - and conversion utilities
  32  */
  33
  34 #ifndef MARCDISP_H
  35 #define MARCDISP_H
  36
  37 #include <yaz/yconfig.h>
  38 #include <stdio.h>
  39 #include <yaz/wrbuf.h>
  40
  41 YAZ_BEGIN_CDECL
  42
  43 typedef struct yaz_marc_t_ *yaz_marc_t;
  44
  45 /* create handler */
  46 YAZ_EXPORT yaz_marc_t yaz_marc_create(void);
  47 /* destroy */
  48 YAZ_EXPORT void yaz_marc_destroy(yaz_marc_t mt);
  49
  50 /* set XML mode YAZ_MARC_LINE, YAZ_MARC_SIMPLEXML, ... */
  51 YAZ_EXPORT void yaz_marc_xml(yaz_marc_t mt, int xmlmode);
  52 #define YAZ_MARC_LINE      0
  53 #define YAZ_MARC_SIMPLEXML 1
  54 #define YAZ_MARC_OAIMARC   2
  55 #define YAZ_MARC_MARCXML   3
  56 #define YAZ_MARC_ISO2709   4
  57 #define YAZ_MARC_XCHANGE   5
  58
  59 /* supply iconv handle for character set conversion .. */
  60 YAZ_EXPORT void yaz_marc_iconv(yaz_marc_t mt, yaz_iconv_t cd);
  61
  62 /* set debug level, 0=none, 1=more, 2=even more, .. */
  63 YAZ_EXPORT void yaz_marc_debug(yaz_marc_t mt, int level);
  64
  65 /* decode MARC in buf of size bsize. Returns >0 on success; <=0 on failure.
  66    On success, result in *result with size *rsize. */
  67 YAZ_EXPORT int yaz_marc_decode_buf (yaz_marc_t mt, const char *buf, int bsize,
  68                                     char **result, int *rsize);
  69
  70 /* decode MARC in buf of size bsize. Returns >0 on success; <=0 on failure.
  71    On success, result in WRBUF */
  72 YAZ_EXPORT int yaz_marc_decode_wrbuf (yaz_marc_t mt, const char *buf,
  73                                       int bsize, WRBUF wrbuf);
  74
  75 /* old functions (depricated) */
  76 YAZ_EXPORT int marc_display (const char *buf, FILE *outf);
  77 YAZ_EXPORT int marc_display_ex (const char *buf, FILE *outf, int debug);
  78 YAZ_EXPORT int marc_display_exl (const char *buf, FILE *outf, int debug,
  79                                  int length);
  80 YAZ_EXPORT int marc_display_wrbuf (const char *buf, WRBUF wr, int debug,
  81                                    int bsize);
  82 YAZ_EXPORT int yaz_marc_decode(const char *buf, WRBUF wr,
  83                                int debug, int bsize, int xml);
  84
  85 YAZ_EXPORT void yaz_marc_subfield_str(yaz_marc_t mt, const char *s);
  86 YAZ_EXPORT void yaz_marc_endline_str(yaz_marc_t mt, const char *s);
  87
  88 /* like atoi except that it reads exactly len characters */
  89 YAZ_EXPORT int atoi_n (const char *buf, int len);
  90
  91 /* MARC control characters */
  92 #define ISO2709_RS 035
  93 #define ISO2709_FS 036
  94 #define ISO2709_IDFS 037
  95
  96 YAZ_END_CDECL
  97
  98 #endif
  99 /*
 100  * Local variables:
 101  * c-basic-offset: 4
 102  * indent-tabs-mode: nil
 103  * End:
 104  * vim: shiftwidth=4 tabstop=8 expandtab
 105  */
 106