Added
[yaz-moved-to-github.git] / include / yaz / proto.h
1 /*
2  * Copyright (c) 1998-2001, Index Data
3  * See the file LICENSE for details.
4  * Sebastian Hammer, Adam Dickmeiss
5  *
6  * $Log: proto.h,v $
7  * Revision 1.3  2002-08-29 19:36:09  ja7
8  * Added
9  * YAZ_EXPORT const char* yaz_z3950_oid_value_to_str(oid_value ov, oid_class oc);
10  * Used for gettting ui friendly names for oid_value's
11  *
12  * Revision 1.2  2002/02/11 23:25:26  adam
13  * Rustam's patch
14  *
15  * Revision 1.1  2001/10/23 21:00:19  adam
16  * Old Z39.50 codecs gone. Added ZOOM. WRBUF MARC display util.
17  *
18  * Revision 1.7  2001/09/24 21:51:55  adam
19  * New Z39.50 OID utilities: yaz_oidval_to_z3950oid, yaz_str_to_z3950oid
20  * and yaz_z3950oid_to_str.
21  *
22  * Revision 1.6  2001/09/19 10:19:07  adam
23  * Z_SortCase_caseInsensitive was set to wrong value.
24  *
25  * Revision 1.5  2001/05/17 14:16:15  adam
26  * Added EXTERNAL handling for item update0 (1.0).
27  *
28  * Revision 1.4  2000/03/14 09:19:49  ian
29  * Added admin extended service encoders & decoders.
30  *
31  * Revision 1.3  2000/02/28 11:20:06  adam
32  * Using autoconf. New definitions: YAZ_BEGIN_CDECL/YAZ_END_CDECL.
33  *
34  * Revision 1.2  1999/12/16 23:36:19  adam
35  * Implemented ILL protocol. Minor updates ASN.1 compiler.
36  *
37  * Revision 1.1  1999/11/30 13:47:11  adam
38  * Improved installation. Moved header files to include/yaz.
39  *
40  * Revision 1.2  1999/06/09 10:52:11  adam
41  * Added YAZ_EXPORT.
42  *
43  * Revision 1.1  1999/06/08 13:11:55  adam
44  * Fixed problem with proto.h.
45  *
46  * Revision 1.2  1999/04/20 10:37:04  adam
47  * Updated for ODR - added name parameter.
48  *
49  * Revision 1.1  1998/03/31 16:04:05  adam
50  * First version of proto.h which is almost compatible with the old one.
51  *
52  */
53 #ifndef Z_PROTO_H
54 #define Z_PROTO_H
55
56 #define Z_95 1
57 #define ASN_COMPILED 1
58
59 #include <yaz/yaz-version.h>
60 #include <yaz/z-accdes1.h>
61 #include <yaz/z-accform1.h>
62 #include <yaz/z-acckrb1.h>
63 #include <yaz/z-core.h>
64 #include <yaz/z-diag1.h>
65 #include <yaz/z-espec1.h>
66 #include <yaz/z-estask.h>
67 #include <yaz/z-exp.h>
68 #include <yaz/z-grs.h>
69 #include <yaz/z-opac.h>
70 #include <yaz/z-rrf1.h>
71 #include <yaz/z-rrf2.h>
72 #include <yaz/z-sum.h>
73 #include <yaz/z-sutrs.h>
74 #include <yaz/z-uifr1.h>
75 #include <yaz/zes-expi.h>
76 #include <yaz/zes-exps.h>
77 #include <yaz/zes-order.h>
78 #include <yaz/zes-pquery.h>
79 #include <yaz/zes-psched.h>
80 #include <yaz/zes-pset.h>
81 #include <yaz/zes-update.h>
82 #include <yaz/zes-admin.h>
83 #include <yaz/z-date.h>
84 #include <yaz/z-univ.h>
85 #include <yaz/zes-update0.h>
86 #include <yaz/z-charneg.h>
87 #include <yaz/oid.h>
88
89 YAZ_BEGIN_CDECL
90
91 #define Z_PRES_SUCCESS   Z_PresentStatus_success
92 #define Z_PRES_PARTIAL_1 Z_PresentStatus_partial_1
93 #define Z_PRES_PARTIAL_2 Z_PresentStatus_partial_2
94 #define Z_PRES_PARTIAL_3 Z_PresentStatus_partial_3
95 #define Z_PRES_PARTIAL_4 Z_PresentStatus_partial_4
96 #define Z_PRES_FAILURE   Z_PresentStatus_failure
97
98 #define Z_RES_SUBSET  Z_SearchResponse_subset
99 #define Z_RES_INTERIM Z_SearchResponse_interim
100 #define Z_RES_NONE    Z_SearchResponse_none
101
102 #define Z_SortStatus_success Z_SortResponse_success 
103 #define Z_SortStatus_partial_1 Z_SortResponse_partial_1
104 #define Z_SortStatus_failure Z_SortResponse_failure
105
106 #define Z_SortRelation_ascending            Z_SortKeySpec_ascending 
107 #define Z_SortRelation_descending           Z_SortKeySpec_descending
108 #define Z_SortRelation_ascendingByFreq      Z_SortKeySpec_ascendingByFrequency
109 #define Z_SortRelation_descendingByFreq     Z_SortKeySpec_descendingByfrequency 
110
111 #define Z_SortCase_caseSensitive            Z_SortKeySpec_caseSensitive
112 #define Z_SortCase_caseInsensitive          Z_SortKeySpec_caseInsensitive
113
114 #define Z_TriggerResourceCtrl_resourceReport Z_TriggerResourceControlRequest_resourceReport
115 #define Z_TriggerResourceCtrl_resourceControl  Z_TriggerResourceControlRequest_resourceControl
116 #define Z_TriggerResourceCtrl_cancel Z_TriggerResourceControlRequest_cancel
117
118 #define Z_DeleteRequest_list    Z_DeleteResultSetRequest_list
119 #define Z_DeleteRequest_all     Z_DeleteResultSetRequest_all
120
121 #define Z_AccessRequest_simpleForm Z_AccessControlRequest_simpleForm
122 #define Z_AccessRequest_externallyDefined Z_AccessControlRequest_externallyDefined
123
124 #define Z_AccessResponse_simpleForm Z_AccessControlResponse_simpleForm
125 #define Z_AccessResponse_externallyDefined Z_AccessControlResponse_externallyDefined
126
127 #define Z_ResourceReportStatus_success   Z_ResourceReportResponse_success
128 #define Z_ResourceReportStatus_partial   Z_ResourceReportResponse_partial
129 #define Z_ResourceReportStatus_failure_1 Z_ResourceReportResponse_failure_1
130 #define Z_ResourceReportStatus_failure_2 Z_ResourceReportResponse_failure_2
131 #define Z_ResourceReportStatus_failure_3 Z_ResourceReportResponse_failure_3
132 #define Z_ResourceReportStatus_failure_4 Z_ResourceReportResponse_failure_4
133 #define Z_ResourceReportStatus_failure_5 Z_ResourceReportResponse_failure_5
134 #define Z_ResourceReportStatus_failure_6 Z_ResourceReportResponse_failure_6
135
136 #define Z_SortResultSetStatus_empty       Z_SortResponse_empty
137 #define Z_SortResultSetStatus_interim     Z_SortResponse_interim
138 #define Z_SortResultSetStatus_unchanged   Z_SortResponse_unchanged
139 #define Z_SortResultSetStatus_none        Z_SortResponse_none
140
141 typedef Z_External Z_DatabaseRecord;
142 typedef struct Z_IOItemOrder Z_ItemOrder;
143
144 YAZ_EXPORT Z_APDU *zget_APDU(ODR o, int which);
145 YAZ_EXPORT Z_Close *zget_Close (ODR o);
146 YAZ_EXPORT Odr_oid *yaz_oidval_to_z3950oid (ODR o, int oid_class,
147                                             int oid_value);
148 YAZ_EXPORT Odr_oid *yaz_str_to_z3950oid (ODR o, int oid_class,
149                                          const char *str);
150 YAZ_EXPORT const char *yaz_z3950oid_to_str (Odr_oid *oid, int *oid_class);
151
152 YAZ_EXPORT const char* yaz_z3950_oid_value_to_str(oid_value ov, oid_class oc);
153
154 YAZ_END_CDECL
155
156 #include <yaz/prt-ext.h>
157
158 #endif