include/yaz/marcdisp.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2009 Index Data.
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of Index Data nor the names of its contributors
  13  *       may be used to endorse or promote products derived from this
  14  *       software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 /**
  29  * \file marcdisp.h
  30  * \brief MARC conversion
  31  */
  32
  33 #ifndef MARCDISP_H
  34 #define MARCDISP_H
  35
  36 #include <yaz/yconfig.h>
  37 #include <stdio.h>
  38 #include <yaz/wrbuf.h>
  39
  40 #include <yaz/nmem.h>
  41 #include <yaz/xmltypes.h>
  42 #include <yaz/z-opac.h>
  43
  44 YAZ_BEGIN_CDECL
  45
  46 /** \brief a yaz_marc_t handle (private content) */
  47 typedef struct yaz_marc_t_ *yaz_marc_t;
  48
  49 /** \brief construct yaz_marc_t handle */
  50 YAZ_EXPORT yaz_marc_t yaz_marc_create(void);
  51
  52 /** \brief destroy yaz_marc_t handle */
  53 YAZ_EXPORT void yaz_marc_destroy(yaz_marc_t mt);
  54
  55 /** \brief set XML mode YAZ_MARC_LINE, YAZ_MARC_SIMPLEXML, ... */
  56 YAZ_EXPORT void yaz_marc_xml(yaz_marc_t mt, int xmlmode);
  57
  58 /** \brief Output format: Line-format */
  59 #define YAZ_MARC_LINE      0
  60 /** \brief Output format: simplexml (no longer supported) */
  61 #define YAZ_MARC_SIMPLEXML 1
  62 /** \brief Output format: OAI-MARC (no longer supported) */
  63 #define YAZ_MARC_OAIMARC   2
  64 /** \brief Output format: MARCXML */
  65 #define YAZ_MARC_MARCXML   3
  66 /** \brief Output format: ISO2709 */
  67 #define YAZ_MARC_ISO2709   4
  68 /** \brief Output format: MarcXchange */
  69 #define YAZ_MARC_XCHANGE   5
  70 /** \brief Output format: check only (no marc output) */
  71 #define YAZ_MARC_CHECK  6
  72
  73 /** \brief set iconv handle for character set conversion .. */
  74 YAZ_EXPORT void yaz_marc_iconv(yaz_marc_t mt, yaz_iconv_t cd);
  75
  76 /** \brief supply iconv handle for character set conversion .. */
  77 YAZ_EXPORT yaz_iconv_t yaz_marc_get_iconv(yaz_marc_t mt);
  78
  79 /** \brief set debug level
  80     \param mt handle
  81     \param level level, where 0=lowest, 1 more debug, 2 even more
  82 */
  83 YAZ_EXPORT void yaz_marc_debug(yaz_marc_t mt, int level);
  84
  85 /** \brief decodes ISO2709 buffer using straight buffers
  86     \param mt marc handle
  87     \param buf input buffer
  88     \param bsize size of buffer or (-1 if "any size")
  89     \param result result to be stored here
  90     \param rsize size of result (memory "owned" by yaz_marc_mt handle)
  91
  92     Decodes MARC in buf of size bsize.
  93     On success, result in *result with size *rsize.
  94     Returns -1 on error, or size of input record (>0) if OK
  95 */
  96 YAZ_EXPORT int yaz_marc_decode_buf(yaz_marc_t mt, const char *buf, int bsize,
  97                                    const char **result, size_t *rsize);
  98
  99 /** \brief decodes ISO2709/MARC buffer and stores result in WRBUF
 100     \param mt handle
 101     \param buf input buffer
 102     \param bsize size of buffer (-1 if "any size")
 103     \param wrbuf WRBUF for output
 104
 105     Decodes MARC in buf of size bsize.
 106     On success, result in wrbuf
 107     Returns -1 on error, or size of input record (>0) if OK
 108 */
 109 YAZ_EXPORT int yaz_marc_decode_wrbuf(yaz_marc_t mt, const char *buf,
 110                                      int bsize, WRBUF wrbuf);
 111
 112 YAZ_EXPORT void yaz_marc_subfield_str(yaz_marc_t mt, const char *s);
 113 YAZ_EXPORT void yaz_marc_endline_str(yaz_marc_t mt, const char *s);
 114
 115 /** \brief modifies part of the MARC leader */
 116 YAZ_EXPORT void yaz_marc_modify_leader(yaz_marc_t mt, size_t off,
 117                                        const char *str);
 118
 119 /** \brief like atoi(3) except that it reads exactly len characters */
 120 YAZ_EXPORT int atoi_n(const char *buf, int len);
 121
 122 /** \brief like atoi_n but checks for proper formatting
 123     \param buf buffer to read values from
 124     \param size size of buffer
 125     \param val value of decimal number (if successful)
 126     \retval 0 no value found (non-digits found)
 127     \retval 1 value found and *val holds value
 128 */
 129 YAZ_EXPORT
 130 int atoi_n_check(const char *buf, int size, int *val);
 131
 132 /** \brief MARC control char: record separator (29 Dec, 1D Hex) */
 133 #define ISO2709_RS 035
 134 /** \brief MARC control char: field separator (30 Dec, 1E Hex) */
 135 #define ISO2709_FS 036
 136 /** \brief MARC control char: identifier-field separator (31 Dec, 1F Hex) */
 137 #define ISO2709_IDFS 037
 138
 139 /** \brief read ISO2709/MARC record from buffer
 140     \param mt handle
 141     \param buf ISO2709 buffer of size bsize
 142     \param bsize size of buffer (-1 for unlimited size)
 143
 144     Parses ISO2709 record from supplied buffer
 145     Returns > 0 for OK (same as length), -1=ERROR
 146 */
 147 YAZ_EXPORT int yaz_marc_read_iso2709(yaz_marc_t mt,
 148                                      const char *buf, int bsize);
 149
 150 /** \brief read MARC lineformat from stream
 151     \param mt handle
 152     \param getbyte get one byte handler
 153     \param ungetbyte unget one byte handler
 154     \param client_data opaque data for handers
 155
 156     Parses MARC line record from stream
 157     Returns > 0 for OK (same as length), -1=ERROR
 158 */
 159 YAZ_EXPORT
 160 int yaz_marc_read_line(yaz_marc_t mt,
 161                        int (*getbyte)(void *client_data),
 162                        void (*ungetbyte)(int b, void *client_data),
 163                        void *client_data);
 164
 165 #if YAZ_HAVE_XML2
 166 /** \brief parses MARCXML/MarcXchange record from xmlNode pointer
 167     \param mt handle
 168     \param ptr is a pointer to root xml node
 169
 170     Returns 0=OK, -1=ERROR
 171 */
 172 YAZ_EXPORT int yaz_marc_read_xml(yaz_marc_t mt, const xmlNode *ptr);
 173 #endif
 174
 175 /** \brief writes record in line format
 176     \param mt handle
 177     \param wrbuf WRBUF for output
 178
 179     Returns 0=OK, -1=ERROR
 180 */
 181 YAZ_EXPORT int yaz_marc_write_line(yaz_marc_t mt, WRBUF wrbuf);
 182
 183 /** \brief writes record in MARCXML format
 184     \param mt handle
 185     \param wrbuf WRBUF for output
 186
 187     Sets leader[9]='a' . Returns 0=OK, -1=ERROR .
 188 */
 189 YAZ_EXPORT int yaz_marc_write_marcxml(yaz_marc_t mt, WRBUF wrbuf);
 190
 191 /** \brief writes record in MarcXchange XML
 192     \param mt handle
 193     \param wrbuf WRBUF for output
 194     \param format record format (e.g. "MARC21")
 195     \param type record type (e.g. Bibliographic)
 196
 197     Returns 0=OK, -1=ERROR
 198 */
 199 YAZ_EXPORT int yaz_marc_write_marcxchange(yaz_marc_t mt, WRBUF wrbuf,
 200                                           const char *format,
 201                                           const char *type);
 202
 203 /** \brief writes record in ISO2709 format
 204     \param mt handle
 205     \param wrbuf WRBUF for output
 206     Returns 0=OK, -1=ERROR
 207 */
 208 YAZ_EXPORT int yaz_marc_write_iso2709(yaz_marc_t mt, WRBUF wrbuf);
 209
 210 /** \brief writes record in mode - given by yaz_marc_xml mode
 211     \param mt handle
 212     \param wrbuf WRBUF for output
 213     This function calls yaz_marc_write_iso2709, yaz_marc_write_marcxml,
 214     etc.. depending on mode given by yaz_marc_xml.
 215     Returns 0=OK, -1=ERROR
 216 */
 217 YAZ_EXPORT int yaz_marc_write_mode(yaz_marc_t mt, WRBUF wrbuf);
 218
 219 #if YAZ_HAVE_XML2
 220 /** \brief writes MARC record as libxml2 tree
 221     \param mt handle
 222     \param root_ptr pointer to record node
 223     \param ns namespace of record (such as "http://www.loc.gov/MARC21/slim")
 224     \param format MarcXchange format (NULL for none)
 225     \param type MarcXchange format (NULL for none)
 226     \retval 0 Creation successful and *root_ptr is "record" node
 227     \retval -1 ERROR
 228 */
 229 YAZ_EXPORT
 230 int yaz_marc_write_xml(yaz_marc_t mt, xmlNode **root_ptr,
 231                        const char *ns,
 232                        const char *format,
 233                        const char *type);
 234 #endif
 235
 236 /** \brief sets leader spec (for modifying bytes in 24 byte leader)
 237     \param mt handle
 238     \param leader_spec
 239     \retval 0 OK
 240     \retval -1 ERROR
 241
 242     Spec takes form pos=val,pos=val,...
 243     where value is either a number (decimal char value) or a
 244     string in 'a', e.g. 9='a'
 245
 246 */
 247 YAZ_EXPORT int yaz_marc_leader_spec(yaz_marc_t mt, const char *leader_spec);
 248
 249
 250 /** \brief sets leader, validates it, and returns important values
 251     \param mt handle
 252     \param leader of the 24 byte leader to be set
 253     \param indicator_length indicator length (returned value)
 254     \param identifier_length identifier length (returned value)
 255     \param base_address base address (returned value)
 256     \param length_data_entry length of data entry (returned value)
 257     \param length_starting length of starting
 258     \param length_implementation length of implementation defined data
 259 */
 260 YAZ_EXPORT
 261 void yaz_marc_set_leader(yaz_marc_t mt, const char *leader,
 262                          int *indicator_length,
 263                          int *identifier_length,
 264                          int *base_address,
 265                          int *length_data_entry,
 266                          int *length_starting,
 267                          int *length_implementation);
 268
 269
 270 /** \brief adds MARC comment string
 271     \param mt handle
 272     \param comment comment to be added)
 273 */
 274 YAZ_EXPORT
 275 void yaz_marc_add_comment(yaz_marc_t mt, char *comment);
 276
 277 /** \brief adds MARC annotation - printf interface
 278     \param mt handle
 279     \param fmt printf format string
 280 */
 281 YAZ_EXPORT
 282 void yaz_marc_cprintf(yaz_marc_t mt, const char *fmt, ...);
 283
 284 /** \brief adds subfield to MARC structure
 285     \param mt handle
 286     \param code_data code data buffer
 287     \param code_data_len length of code data
 288 */
 289 YAZ_EXPORT
 290 void yaz_marc_add_subfield(yaz_marc_t mt,
 291                            const char *code_data, size_t code_data_len);
 292
 293
 294 /** \brief adds controlfield to MARC structure
 295     \param mt handle
 296     \param tag (e.g. "001"
 297     \param data value for this tag
 298     \param data_len length of data
 299 */
 300 YAZ_EXPORT
 301 void yaz_marc_add_controlfield(yaz_marc_t mt, const char *tag,
 302                                const char *data, size_t data_len);
 303
 304
 305 #if YAZ_HAVE_XML2
 306 /** \brief adds controlfield to MARC structure using xml Nodes
 307     \param mt handle
 308     \param ptr_tag value of tag (TEXT xmlNode)
 309     \param ptr_data value of data (TEXT xmlNode)
 310 */
 311 YAZ_EXPORT
 312 void yaz_marc_add_controlfield_xml(yaz_marc_t mt, const xmlNode *ptr_tag,
 313                                    const xmlNode *ptr_data);
 314 #endif
 315
 316 /** \brief adds datafield to MARC structure using strings
 317     \param mt handle
 318     \param tag value of tag as string
 319     \param indicator indicator string
 320     \param indicator_len length of indicator string
 321 */
 322 YAZ_EXPORT
 323 void yaz_marc_add_datafield(yaz_marc_t mt, const char *tag,
 324                             const char *indicator, size_t indicator_len);
 325
 326 #if YAZ_HAVE_XML2
 327 /** \brief adds datafield to MARC structure using xml Nodes
 328     \param mt handle
 329     \param ptr_tag value of tag (TEXT xmlNode)
 330     \param indicator indicator string
 331     \param indicator_len length of indicator string
 332 */
 333 YAZ_EXPORT
 334 void yaz_marc_add_datafield_xml(yaz_marc_t mt, const xmlNode *ptr_tag,
 335                                 const char *indicator, size_t indicator_len);
 336 #endif
 337
 338 /** \brief returns memory for MARC handle
 339     \param mt handle
 340     \retval NMEM handle for MARC system
 341 */
 342 YAZ_EXPORT
 343 NMEM yaz_marc_get_nmem(yaz_marc_t mt);
 344
 345 /** \brief clears memory and MARC record
 346     \param mt handle
 347 */
 348 YAZ_EXPORT
 349 void yaz_marc_reset(yaz_marc_t mt);
 350
 351 /** \brief gets debug level for MARC system
 352     \param mt handle
 353 */
 354 YAZ_EXPORT
 355 int yaz_marc_get_debug(yaz_marc_t mt);
 356
 357 /** \brief convert MARC format type to format type(YAZ_MARC_..)
 358     \param arg string
 359     \returns -1 if arg is not a known format; YAZ_MARC_.. otherwise (OK)
 360 */
 361 YAZ_EXPORT
 362 int yaz_marc_decode_formatstr(const char *arg);
 363
 364 /** \brief enable writing of MARC XML records using Libxml2
 365     \param mt handle
 366     \param enable 0=disable, 1=enable
 367 */
 368 YAZ_EXPORT
 369 void yaz_marc_write_using_libxml2(yaz_marc_t mt, int enable);
 370
 371 /** \brief Performs "pretty" display of OPAC record to WRBUF */
 372 YAZ_EXPORT void yaz_display_OPAC(WRBUF wrbuf, Z_OPACRecord *r, int flags);
 373
 374 /** \brief Performs "pretty" display of OPAC record to WRBUF using marc_t */
 375 YAZ_EXPORT void yaz_opac_decode_wrbuf(yaz_marc_t mt, Z_OPACRecord *r, WRBUF wrbuf);
 376
 377
 378 /** \brief flushes records
 379     \param mt handle
 380     \param wr WRBUF for output
 381     \retval 0 OK
 382     \retval -1 ERROR
 383 */
 384 YAZ_EXPORT int yaz_marc_write_trailer(yaz_marc_t mt, WRBUF wr);
 385
 386 /** \brief enables record collection output
 387     \param mt handle
 388 */
 389 YAZ_EXPORT void yaz_marc_enable_collection(yaz_marc_t mt);
 390
 391 YAZ_END_CDECL
 392
 393 #endif
 394 /*
 395  * Local variables:
 396  * c-basic-offset: 4
 397  * c-file-style: "Stroustrup"
 398  * indent-tabs-mode: nil
 399  * End:
 400  * vim: shiftwidth=4 tabstop=8 expandtab
 401  */
 402