Small utility to encode/decode init options as a string
[yaz-moved-to-github.git] / include / yaz / proto.h
1 /*
2  * Copyright (c) 1998-2004, Index Data
3  * See the file LICENSE for details.
4  *
5  * $Id: proto.h,v 1.12 2004-01-12 12:11:57 adam Exp $
6  */
7 #ifndef Z_PROTO_H
8 #define Z_PROTO_H
9
10 #define Z_95 1
11 #define ASN_COMPILED 1
12
13 #include <yaz/yaz-version.h>
14 #include <yaz/z-accdes1.h>
15 #include <yaz/z-accform1.h>
16 #include <yaz/z-acckrb1.h>
17 #include <yaz/z-core.h>
18 #include <yaz/z-diag1.h>
19 #include <yaz/z-espec1.h>
20 #include <yaz/z-estask.h>
21 #include <yaz/z-exp.h>
22 #include <yaz/z-grs.h>
23 #include <yaz/z-opac.h>
24 #include <yaz/z-rrf1.h>
25 #include <yaz/z-rrf2.h>
26 #include <yaz/z-sum.h>
27 #include <yaz/z-sutrs.h>
28 #include <yaz/z-uifr1.h>
29 #include <yaz/zes-expi.h>
30 #include <yaz/zes-exps.h>
31 #include <yaz/zes-order.h>
32 #include <yaz/zes-pquery.h>
33 #include <yaz/zes-psched.h>
34 #include <yaz/zes-pset.h>
35 #include <yaz/zes-update.h>
36 #include <yaz/zes-admin.h>
37 #include <yaz/z-date.h>
38 #include <yaz/z-univ.h>
39 #include <yaz/zes-update0.h>
40 #include <yaz/z-charneg.h>
41 #include <yaz/z-mterm2.h>
42 #include <yaz/oid.h>
43 #include <yaz/wrbuf.h>
44 #include <yaz/zgdu.h>
45 #include <yaz/z-oclcui.h>
46
47 YAZ_BEGIN_CDECL
48
49 #define Z_PRES_SUCCESS   Z_PresentStatus_success
50 #define Z_PRES_PARTIAL_1 Z_PresentStatus_partial_1
51 #define Z_PRES_PARTIAL_2 Z_PresentStatus_partial_2
52 #define Z_PRES_PARTIAL_3 Z_PresentStatus_partial_3
53 #define Z_PRES_PARTIAL_4 Z_PresentStatus_partial_4
54 #define Z_PRES_FAILURE   Z_PresentStatus_failure
55
56 #define Z_RES_SUBSET  Z_SearchResponse_subset
57 #define Z_RES_INTERIM Z_SearchResponse_interim
58 #define Z_RES_NONE    Z_SearchResponse_none
59
60 #define Z_SortStatus_success Z_SortResponse_success 
61 #define Z_SortStatus_partial_1 Z_SortResponse_partial_1
62 #define Z_SortStatus_failure Z_SortResponse_failure
63
64 #define Z_SortRelation_ascending            Z_SortKeySpec_ascending 
65 #define Z_SortRelation_descending           Z_SortKeySpec_descending
66 #define Z_SortRelation_ascendingByFreq      Z_SortKeySpec_ascendingByFrequency
67 #define Z_SortRelation_descendingByFreq     Z_SortKeySpec_descendingByfrequency 
68
69 #define Z_SortCase_caseSensitive            Z_SortKeySpec_caseSensitive
70 #define Z_SortCase_caseInsensitive          Z_SortKeySpec_caseInsensitive
71
72 #define Z_TriggerResourceCtrl_resourceReport Z_TriggerResourceControlRequest_resourceReport
73 #define Z_TriggerResourceCtrl_resourceControl  Z_TriggerResourceControlRequest_resourceControl
74 #define Z_TriggerResourceCtrl_cancel Z_TriggerResourceControlRequest_cancel
75
76 #define Z_DeleteRequest_list    Z_DeleteResultSetRequest_list
77 #define Z_DeleteRequest_all     Z_DeleteResultSetRequest_all
78
79 #define Z_AccessRequest_simpleForm Z_AccessControlRequest_simpleForm
80 #define Z_AccessRequest_externallyDefined Z_AccessControlRequest_externallyDefined
81
82 #define Z_AccessResponse_simpleForm Z_AccessControlResponse_simpleForm
83 #define Z_AccessResponse_externallyDefined Z_AccessControlResponse_externallyDefined
84
85 #define Z_ResourceReportStatus_success   Z_ResourceReportResponse_success
86 #define Z_ResourceReportStatus_partial   Z_ResourceReportResponse_partial
87 #define Z_ResourceReportStatus_failure_1 Z_ResourceReportResponse_failure_1
88 #define Z_ResourceReportStatus_failure_2 Z_ResourceReportResponse_failure_2
89 #define Z_ResourceReportStatus_failure_3 Z_ResourceReportResponse_failure_3
90 #define Z_ResourceReportStatus_failure_4 Z_ResourceReportResponse_failure_4
91 #define Z_ResourceReportStatus_failure_5 Z_ResourceReportResponse_failure_5
92 #define Z_ResourceReportStatus_failure_6 Z_ResourceReportResponse_failure_6
93
94 #define Z_SortResultSetStatus_empty       Z_SortResponse_empty
95 #define Z_SortResultSetStatus_interim     Z_SortResponse_interim
96 #define Z_SortResultSetStatus_unchanged   Z_SortResponse_unchanged
97 #define Z_SortResultSetStatus_none        Z_SortResponse_none
98
99 typedef Z_External Z_DatabaseRecord;
100 typedef struct Z_IOItemOrder Z_ItemOrder;
101
102 YAZ_EXPORT Z_APDU *zget_APDU(ODR o, int which);
103 YAZ_EXPORT Z_Close *zget_Close (ODR o);
104 YAZ_EXPORT Odr_oid *yaz_oidval_to_z3950oid (ODR o, int oid_class,
105                                             int oid_value);
106 YAZ_EXPORT Odr_oid *yaz_str_to_z3950oid (ODR o, int oid_class,
107                                          const char *str);
108 YAZ_EXPORT const char *yaz_z3950oid_to_str (Odr_oid *oid, int *oid_class);
109
110 YAZ_EXPORT const char* yaz_z3950_oid_value_to_str(oid_value ov, oid_class oc);
111
112 YAZ_EXPORT void yaz_display_grs1(WRBUF wrbuf, Z_GenericRecord *r, int flags);
113
114 YAZ_EXPORT void yaz_display_OPAC(WRBUF wrbuf, Z_OPACRecord *r, int flags);
115
116 YAZ_EXPORT int yaz_init_opt_encode(Z_Options *opt, const char *opt_str,
117                                    int *error_pos);
118 YAZ_EXPORT void yaz_init_opt_decode(Z_Options *opt,
119                                     void (*pr)(const char *name));
120 YAZ_END_CDECL
121
122 #include <yaz/prt-ext.h>
123
124 #endif