include/yaz/prt-ext.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 names 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: prt-ext.h,v 1.12 2005-01-27 09:08:42 adam Exp $
  27  */
  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.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     oid_value dref;    /* the direct-reference OID value. */
  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(oid_value val);
 143 /** \brief encodes EXTERNAL record based on OID (NULL if knot known) */
 144 YAZ_EXPORT Z_External *z_ext_record(ODR o, int format, const char *buf,
 145                                     int len);
 146
 147 YAZ_END_CDECL
 148
 149 #endif