include/yaz/yaz-util.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2008 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 yaz-util.h
  30  * \brief Header for common YAZ utilities
  31  */
  32
  33 #ifndef YAZ_UTIL_H
  34 #define YAZ_UTIL_H
  35
  36 #include <yaz/yconfig.h>
  37 #include <yaz/yaz-version.h>
  38 #include <yaz/xmalloc.h>
  39
  40 #include <yaz/log.h>
  41
  42 #include <yaz/tpath.h>
  43 #include <yaz/options.h>
  44 #include <yaz/wrbuf.h>
  45 #include <yaz/nmem.h>
  46 #include <yaz/readconf.h>
  47 #include <yaz/marcdisp.h>
  48 #include <yaz/yaz-iconv.h>
  49
  50 /** \mainpage YAZ
  51     \section intro_sec Introduction
  52
  53     For a general introduction to YAZ, read the
  54     YAZ User's Guide and Reference at
  55     http://www.indexdata.com/yaz/doc/
  56     This is also located in the doc directory of the YAZ distribution.
  57
  58     The following sections is just a summary of the most important
  59     header files and where they belong.
  60
  61     \section utilities Utilies
  62     Logging (syslog-like) utility \ref log.h .
  63
  64     Memory management for small blocks \ref nmem.h .
  65
  66     Write string buffer \ref wrbuf.h .
  67
  68     Options handling \ref options.h .
  69
  70     Character conversion \ref yaz-iconv.h .
  71
  72     MARC / MARCXML \ref marcdisp.h .
  73
  74     Testing framework: \ref test.h .
  75
  76     Record conversion: \ref record_conv.h .
  77
  78     Record retrieval: \ref retrieval.h .
  79
  80     \section queryparsers Query parsers
  81
  82     PQF parsing: \ref pquery.h .
  83
  84     CCL parsing: \ref ccl.h .
  85
  86     CQL parsing and conversion: \ref cql.h .
  87
  88     Z39.50 sort: \ref sortspec.h .
  89
  90     \section ber BER handling
  91
  92     BER utilities (ODR): \ref odr.h .
  93
  94     \section z3950 Z39.50
  95
  96     Z39.50 common header: \ref proto.h .
  97
  98     Z39.50 core codecs: \ref z-core.h.
  99
 100     Z39.50 related formats:
 101     \ref z-accdes1.h ,  \ref z-core.h ,
 102     \ref z-estask.h , \ref z-oclcui.h , \ref z-sum.h
 103     \ref z-accform1.h , \ref z-date.h ,
 104     \ref z-exp.h ,    \ref z-opac.h ,   \ref z-sutrs.h
 105     \ref z-acckrb1.h ,  \ref z-diag1.h ,
 106     \ref z-grs.h ,    \ref z-rrf1.h ,   \ref z-uifr1.h
 107     \ref z-charneg.h ,  \ref z-espec1.h
 108     \ref z-mterm2.h , \ref z-rrf2.h ,   \ref z-univ.h .
 109
 110     Z39.50 extended services:
 111     \ref zes-admin.h , \ref zes-exps.h , \ref zes-pquery.h ,
 112     \ref zes-pset.h , \ref zes-update.h ,
 113     \ref zes-expi.h , \ref zes-order.h ,  \ref zes-psched.h ,
 114     \ref zes-update0.h .
 115
 116     Z39.50 diagnostics: \ref diagbib1.h .
 117
 118     Z39.50 externals: \ref prt-ext.h .
 119
 120     \section GDU Generic Data Unit (HTTP and BER)
 121
 122     Definitions for GDU and HTTP: \ref zgdu.h .
 123
 124     \section SRU SRU
 125
 126     SRU/SRW definitions: \ref srw.h .
 127
 128     SRW diagnostics: \ref diagsrw.h .
 129
 130     \section ILL ILL
 131
 132     Common header: \ref ill.h .
 133
 134     Codecs: \ref ill-core.h
 135
 136     \section ZOOM ZOOM
 137
 138     Common header: \ref zoom.h .
 139
 140     \section GFS Generic Frontend Server (GFS)
 141
 142     Header: \ref backend.h .
 143
 144 */
 145 #endif
 146
 147 /*
 148  * Local variables:
 149  * c-basic-offset: 4
 150  * indent-tabs-mode: nil
 151  * End:
 152  * vim: shiftwidth=4 tabstop=8 expandtab
 153  */
 154