include/yaz/prt-ext.h

   1 /*
   2  * Copyright (c) 1995-2002, Index Data.
   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  */
  27
  28 /*
  29  * Biased-choice External for Z39.50.
  30  */
  31
  32 #ifndef PRT_EXT_H
  33 #define PRT_EXT_H
  34
  35 #include <yaz/yconfig.h>
  36 #include <yaz/oid.h>
  37
  38
  39 YAZ_BEGIN_CDECL
  40
  41 /*
  42  * Used to keep track of known External definitions (a loose approach
  43  * to DEFINED_BY).
  44  */
  45
  46 typedef struct Z_ext_typeent
  47 {
  48     oid_value dref;    /* the direct-reference OID value. */
  49     int what;          /* discriminator value for the external CHOICE */
  50     Odr_fun fun;       /* decoder function */
  51 } Z_ext_typeent;
  52
  53 struct Z_External
  54 {
  55     Odr_oid *direct_reference;
  56     int *indirect_reference;
  57     char *descriptor;
  58     int which;
  59 /* Generic types */
  60 #define Z_External_single 0
  61 #define Z_External_octet 1
  62 #define Z_External_arbitrary 2
  63 /* Specific types */
  64 #define Z_External_sutrs 3
  65 #define Z_External_explainRecord 4
  66 #define Z_External_resourceReport1 5
  67 #define Z_External_resourceReport2 6
  68 #define Z_External_promptObject1 7
  69 #define Z_External_grs1 8
  70 #define Z_External_extendedService 9
  71 #define Z_External_itemOrder 10
  72 #define Z_External_diag1 11
  73 #define Z_External_espec1 12
  74 #define Z_External_summary 13
  75 #define Z_External_OPAC 14
  76 #define Z_External_searchResult1 15
  77 #define Z_External_update 16
  78 #define Z_External_dateTime 17
  79 #define Z_External_universeReport 18
  80 #define Z_External_ESAdmin 19
  81 #define Z_External_update0 20
  82 #define Z_External_userInfo1 21
  83 #define Z_External_charSetandLanguageNegotiation 22
  84 #define Z_External_acfPrompt1 23
  85 #define Z_External_acfDes1 24
  86 #define Z_External_acfKrb1 25
  87 #define Z_External_multisrch2 26
  88     union
  89     {
  90         /* Generic types */
  91         Odr_any *single_ASN1_type;
  92         Odr_oct *octet_aligned;
  93         Odr_bitmask *arbitrary;
  94
  95         /* Specific types */
  96         Z_SUTRS *sutrs;
  97         Z_ExplainRecord *explainRecord;
  98
  99         Z_ResourceReport1 *resourceReport1;
 100         Z_ResourceReport2 *resourceReport2;
 101         Z_PromptObject1 *promptObject1;
 102         Z_GenericRecord *grs1;
 103         Z_TaskPackage *extendedService;
 104
 105         Z_ItemOrder *itemOrder;
 106         Z_DiagnosticFormat *diag1;
 107         Z_Espec1 *espec1;
 108         Z_BriefBib *summary;
 109         Z_OPACRecord *opac;
 110
 111         Z_SearchInfoReport *searchResult1;
 112         Z_IUUpdate *update;
 113         Z_DateTime *dateTime;
 114         Z_UniverseReport *universeReport;
 115         Z_Admin *adminService;
 116
 117         Z_IU0Update *update0;
 118         Z_OtherInformation *userInfo1;
 119         Z_CharSetandLanguageNegotiation *charNeg3;
 120         Z_PromptObject1 *acfPrompt1;
 121         Z_DES_RN_Object *acfDes1;
 122
 123         Z_KRBObject *acfKrb1;
 124         Z_MultipleSearchTerms_2 *multipleSearchTerms_2;
 125     } u;
 126 };
 127
 128
 129 YAZ_EXPORT int z_External(ODR o, Z_External **p, int opt, const char *name);
 130 YAZ_EXPORT Z_ext_typeent *z_ext_getentbyref(oid_value val);
 131 YAZ_EXPORT Z_External *z_ext_record(ODR o, int format, const char *buf,
 132                                     int len);
 133
 134 YAZ_END_CDECL
 135
 136 #endif