d3e5bf806de2f88a7eb845af12504ff4be2d4fff
[yaz-moved-to-github.git] / include / yaz / prt-ext.h
1 /*
2  * Copyright (c) 1995-1999, 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     union
82     {
83         /* Generic types */
84         Odr_any *single_ASN1_type;
85         Odr_oct *octet_aligned;
86         Odr_bitmask *arbitrary;
87
88         /* Specific types */
89         Z_SUTRS *sutrs;
90         Z_ExplainRecord *explainRecord;
91         Z_ResourceReport1 *resourceReport1;
92         Z_ResourceReport2 *resourceReport2;
93         Z_PromptObject1 *promptObject1;
94         Z_GenericRecord *grs1;
95         Z_TaskPackage *extendedService;
96         Z_ItemOrder *itemOrder;
97         Z_DiagnosticFormat *diag1;
98         Z_Espec1 *espec1;
99         Z_BriefBib *summary;
100         Z_SearchInfoReport *searchResult1;
101         Z_IUUpdate *update;
102         Z_DateTime *dateTime;
103         Z_UniverseReport *universeReport;
104 #ifdef ASN_COMPILED
105         Z_Admin *adminService;
106 #endif
107     } u;
108 };
109
110
111 YAZ_EXPORT int z_External(ODR o, Z_External **p, int opt, const char *name);
112 YAZ_EXPORT Z_ext_typeent *z_ext_getentbyref(oid_value val);
113 YAZ_EXPORT Z_External *z_ext_record(ODR o, int format, const char *buf,
114                                     int len);
115
116 YAZ_END_CDECL
117
118 #endif