include/yaz/prt-ext.h

   1 /*
   2  * Copyright (c) 1995-2007, 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 /* $Id: prt-ext.h,v 1.20 2007-05-08 08:22:35 adam Exp $ */
  28
  29 /**
  30  * \file prt-ext.h
  31  * \brief Header for utilities that handles Z39.50 EXTERNALs
  32  */
  33
  34 /*
  35  * Biased-choice External for Z39.50.
  36  */
  37
  38 #ifndef PRT_EXT_H
  39 #define PRT_EXT_H
  40
  41 #include <yaz/yconfig.h>
  42 #include <yaz/oid_util.h>
  43
  44
  45 YAZ_BEGIN_CDECL
  46
  47 /**
  48  * Used to keep track of known External definitions (a loose approach
  49  * to DEFINED_BY).
  50  */
  51 typedef struct Z_ext_typeent
  52 {
  53     Odr_oid oid[OID_SIZE]; /* the direct-reference OID */
  54     int what;          /* discriminator value for the external CHOICE */
  55     Odr_fun fun;       /* decoder function */
  56 } Z_ext_typeent;
  57
  58 /** \brief structure for all known EXTERNALs */
  59 struct Z_External
  60 {
  61     Odr_oid *direct_reference;
  62     int *indirect_reference;
  63     char *descriptor;
  64     int which;
  65 /* Generic types */
  66 #define Z_External_single 0
  67 #define Z_External_octet 1
  68 #define Z_External_arbitrary 2
  69 /* Specific types */
  70 #define Z_External_sutrs 3
  71 #define Z_External_explainRecord 4
  72 #define Z_External_resourceReport1 5
  73 #define Z_External_resourceReport2 6
  74 #define Z_External_promptObject1 7
  75 #define Z_External_grs1 8
  76 #define Z_External_extendedService 9
  77 #define Z_External_itemOrder 10
  78 #define Z_External_diag1 11
  79 #define Z_External_espec1 12
  80 #define Z_External_summary 13
  81 #define Z_External_OPAC 14
  82 #define Z_External_searchResult1 15
  83 #define Z_External_update 16
  84 #define Z_External_dateTime 17
  85 #define Z_External_universeReport 18
  86 #define Z_External_ESAdmin 19
  87 #define Z_External_update0 20
  88 #define Z_External_userInfo1 21
  89 #define Z_External_charSetandLanguageNegotiation 22
  90 #define Z_External_acfPrompt1 23
  91 #define Z_External_acfDes1 24
  92 #define Z_External_acfKrb1 25
  93 #define Z_External_multisrch2 26
  94 #define Z_External_CQL 27
  95 #define Z_External_OCLCUserInfo 28
  96     union
  97     {
  98         /* Generic types */
  99         Odr_any *single_ASN1_type;
 100         Odr_oct *octet_aligned;
 101         Odr_bitmask *arbitrary;
 102
 103         /* Specific types */
 104         Z_SUTRS *sutrs;
 105         Z_ExplainRecord *explainRecord;
 106
 107         Z_ResourceReport1 *resourceReport1;
 108         Z_ResourceReport2 *resourceReport2;
 109         Z_PromptObject1 *promptObject1;
 110         Z_GenericRecord *grs1;
 111         Z_TaskPackage *extendedService;
 112
 113         Z_ItemOrder *itemOrder;
 114         Z_DiagnosticFormat *diag1;
 115         Z_Espec1 *espec1;
 116         Z_BriefBib *summary;
 117         Z_OPACRecord *opac;
 118
 119         Z_SearchInfoReport *searchResult1;
 120         Z_IUUpdate *update;
 121         Z_DateTime *dateTime;
 122         Z_UniverseReport *universeReport;
 123         Z_Admin *adminService;
 124
 125         Z_IU0Update *update0;
 126         Z_OtherInformation *userInfo1;
 127         Z_CharSetandLanguageNegotiation *charNeg3;
 128         Z_PromptObject1 *acfPrompt1;
 129         Z_DES_RN_Object *acfDes1;
 130
 131         Z_KRBObject *acfKrb1;
 132         Z_MultipleSearchTerms_2 *multipleSearchTerms_2;
 133         Z_InternationalString *cql;
 134         Z_OCLC_UserInformation *oclc;
 135     } u;
 136 };
 137
 138
 139 /** \brief codec for BER EXTERNAL */
 140 YAZ_EXPORT int z_External(ODR o, Z_External **p, int opt, const char *name);
 141 /** \brief returns type information for OID (NULL if not known) */
 142 YAZ_EXPORT Z_ext_typeent *z_ext_getentbyref(const Odr_oid *oid);
 143 /** \brief encodes EXTERNAL record based on OID (NULL if not known) */
 144 YAZ_EXPORT Z_External *z_ext_record_oid(ODR o, const Odr_oid *oid,
 145                                         const char *buf, int len);
 146 /** \brief encodes EXTERNAL XML record */
 147 YAZ_EXPORT Z_External *z_ext_record_xml(ODR o, const char *buf, int len);
 148
 149 /** \brief encodes EXTERNAL SUTRS record */
 150 YAZ_EXPORT Z_External *z_ext_record_sutrs(ODR o, const char *buf, int len);
 151
 152 /** \brief encodes EXTERNAL USMARC/MARC21 record */
 153 YAZ_EXPORT Z_External *z_ext_record_usmarc(ODR o, const char *buf, int len);
 154
 155 YAZ_END_CDECL
 156
 157 #endif
 158 /*
 159  * Local variables:
 160  * c-basic-offset: 4
 161  * indent-tabs-mode: nil
 162  * End:
 163  * vim: shiftwidth=4 tabstop=8 expandtab
 164  */
 165