include/yaz/prt-ext.h

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