1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2011 Index Data.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
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.
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.
30 * \brief Header for utilities that handles Z39.50 EXTERNALs
34 * Biased-choice External for Z39.50.
40 #include <yaz/yconfig.h>
41 #include <yaz/oid_util.h>
47 * Used to keep track of known External definitions (a loose approach
50 typedef struct Z_ext_typeent
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 */
57 /** \brief structure for all known EXTERNALs */
60 Odr_oid *direct_reference;
61 Odr_int *indirect_reference;
65 #define Z_External_single 0
66 #define Z_External_octet 1
67 #define Z_External_arbitrary 2
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
104 Odr_any *single_ASN1_type;
105 Odr_oct *octet_aligned;
106 Odr_bitmask *arbitrary;
110 Z_ExplainRecord *explainRecord;
112 Z_ResourceReport1 *resourceReport1;
113 Z_ResourceReport2 *resourceReport2;
114 Z_PromptObject1 *promptObject1;
115 Z_GenericRecord *grs1;
116 Z_TaskPackage *extendedService;
118 Z_ItemOrder *itemOrder;
119 Z_DiagnosticFormat *diag1;
124 Z_SearchInfoReport *searchResult1;
126 Z_DateTime *dateTime;
127 Z_UniverseReport *universeReport;
128 Z_Admin *adminService;
130 Z_IU0Update *update0;
131 Z_OtherInformation *userInfo1;
132 Z_CharSetandLanguageNegotiation *charNeg3;
133 Z_PromptObject1 *acfPrompt1;
134 Z_DES_RN_Object *acfDes1;
136 Z_KRBObject *acfKrb1;
137 Z_MultipleSearchTerms_2 *multipleSearchTerms_2;
138 Z_InternationalString *cql;
139 Z_OCLC_UserInformation *oclc;
140 Z_PRPersistentResultSet *persistentResultSet;
142 Z_PQueryPersistentQuery *persistentQuery;
143 Z_PQSPeriodicQuerySchedule *periodicQuerySchedule;
144 Z_ESExportSpecification *exportSpecification;
145 Z_EIExportInvocation *exportInvocation;
146 Z_FacetList *facetList;
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 as ANY */
159 YAZ_EXPORT Z_External *z_ext_record_oid_any(ODR o, const Odr_oid *oid,
160 const char *buf, int len);
161 /** \brief encodes EXTERNAL XML record */
162 YAZ_EXPORT Z_External *z_ext_record_xml(ODR o, const char *buf, int len);
164 /** \brief encodes EXTERNAL SUTRS record */
165 YAZ_EXPORT Z_External *z_ext_record_sutrs(ODR o, const char *buf, int len);
167 /** \brief encodes EXTERNAL USMARC/MARC21 record */
168 YAZ_EXPORT Z_External *z_ext_record_usmarc(ODR o, const char *buf, int len);
176 * c-file-style: "Stroustrup"
177 * indent-tabs-mode: nil
179 * vim: shiftwidth=4 tabstop=8 expandtab