Update source headers for 2008. Omit CVS ID keyword subst.
[yaz-moved-to-github.git] / include / yaz / proto.h
1 /* This file is part of the YAZ toolkit.
2  * Copyright (C) 1995-2008 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 /* $Id: proto.h,v 1.28 2007-12-16 11:08:50 adam Exp $ */
28
29 /**
30  * \file proto.h
31  * \brief Header for Z39.50 Protocol
32  */
33 #ifndef Z_PROTO_H
34 #define Z_PROTO_H
35
36 #define Z_95 1
37 #define ASN_COMPILED 1
38
39 #include <yaz/yaz-version.h>
40 #include <yaz/z-accdes1.h>
41 #include <yaz/z-accform1.h>
42 #include <yaz/z-acckrb1.h>
43 #include <yaz/z-core.h>
44 #include <yaz/z-diag1.h>
45 #include <yaz/z-espec1.h>
46 #include <yaz/z-estask.h>
47 #include <yaz/z-exp.h>
48 #include <yaz/z-grs.h>
49 #include <yaz/z-opac.h>
50 #include <yaz/z-rrf1.h>
51 #include <yaz/z-rrf2.h>
52 #include <yaz/z-sum.h>
53 #include <yaz/z-sutrs.h>
54 #include <yaz/z-uifr1.h>
55 #include <yaz/zes-expi.h>
56 #include <yaz/zes-exps.h>
57 #include <yaz/zes-order.h>
58 #include <yaz/zes-pquery.h>
59 #include <yaz/zes-psched.h>
60 #include <yaz/zes-pset.h>
61 #include <yaz/zes-update.h>
62 #include <yaz/zes-admin.h>
63 #include <yaz/z-date.h>
64 #include <yaz/z-univ.h>
65 #include <yaz/zes-update0.h>
66 #include <yaz/z-charneg.h>
67 #include <yaz/z-mterm2.h>
68 #include <yaz/wrbuf.h>
69 #include <yaz/zgdu.h>
70 #include <yaz/z-oclcui.h>
71
72 #include <yaz/marcdisp.h>
73 YAZ_BEGIN_CDECL
74
75 #if 1
76 #define Z_PRES_SUCCESS   Z_PresentStatus_success
77 #define Z_PRES_PARTIAL_1 Z_PresentStatus_partial_1
78 #define Z_PRES_PARTIAL_2 Z_PresentStatus_partial_2
79 #define Z_PRES_PARTIAL_3 Z_PresentStatus_partial_3
80 #define Z_PRES_PARTIAL_4 Z_PresentStatus_partial_4
81 #define Z_PRES_FAILURE   Z_PresentStatus_failure
82
83 #define Z_RES_SUBSET  Z_SearchResponse_subset
84 #define Z_RES_INTERIM Z_SearchResponse_interim
85 #define Z_RES_NONE    Z_SearchResponse_none
86
87 #define Z_SortStatus_success Z_SortResponse_success 
88 #define Z_SortStatus_partial_1 Z_SortResponse_partial_1
89 #define Z_SortStatus_failure Z_SortResponse_failure
90
91 #define Z_SortRelation_ascending            Z_SortKeySpec_ascending 
92 #define Z_SortRelation_descending           Z_SortKeySpec_descending
93 #define Z_SortRelation_ascendingByFreq      Z_SortKeySpec_ascendingByFrequency
94 #define Z_SortRelation_descendingByFreq     Z_SortKeySpec_descendingByfrequency 
95
96 #define Z_SortCase_caseSensitive            Z_SortKeySpec_caseSensitive
97 #define Z_SortCase_caseInsensitive          Z_SortKeySpec_caseInsensitive
98
99 #define Z_TriggerResourceCtrl_resourceReport Z_TriggerResourceControlRequest_resourceReport
100 #define Z_TriggerResourceCtrl_resourceControl  Z_TriggerResourceControlRequest_resourceControl
101 #define Z_TriggerResourceCtrl_cancel Z_TriggerResourceControlRequest_cancel
102
103 #define Z_DeleteRequest_list    Z_DeleteResultSetRequest_list
104 #define Z_DeleteRequest_all     Z_DeleteResultSetRequest_all
105
106 #define Z_AccessRequest_simpleForm Z_AccessControlRequest_simpleForm
107 #define Z_AccessRequest_externallyDefined Z_AccessControlRequest_externallyDefined
108
109 #define Z_AccessResponse_simpleForm Z_AccessControlResponse_simpleForm
110 #define Z_AccessResponse_externallyDefined Z_AccessControlResponse_externallyDefined
111
112 #define Z_ResourceReportStatus_success   Z_ResourceReportResponse_success
113 #define Z_ResourceReportStatus_partial   Z_ResourceReportResponse_partial
114 #define Z_ResourceReportStatus_failure_1 Z_ResourceReportResponse_failure_1
115 #define Z_ResourceReportStatus_failure_2 Z_ResourceReportResponse_failure_2
116 #define Z_ResourceReportStatus_failure_3 Z_ResourceReportResponse_failure_3
117 #define Z_ResourceReportStatus_failure_4 Z_ResourceReportResponse_failure_4
118 #define Z_ResourceReportStatus_failure_5 Z_ResourceReportResponse_failure_5
119 #define Z_ResourceReportStatus_failure_6 Z_ResourceReportResponse_failure_6
120
121 #define Z_SortResultSetStatus_empty       Z_SortResponse_empty
122 #define Z_SortResultSetStatus_interim     Z_SortResponse_interim
123 #define Z_SortResultSetStatus_unchanged   Z_SortResponse_unchanged
124 #define Z_SortResultSetStatus_none        Z_SortResponse_none
125 #endif
126
127 typedef Z_External Z_DatabaseRecord;
128 typedef struct Z_IOItemOrder Z_ItemOrder;
129
130 YAZ_EXPORT Z_APDU *zget_APDU(ODR o, int which);
131 YAZ_EXPORT Z_Close *zget_Close (ODR o);
132
133 /** \brief Performs "pretty" display of GRS-1 record to WRBUF */
134 YAZ_EXPORT void yaz_display_grs1(WRBUF wrbuf, Z_GenericRecord *r, int flags);
135
136 /** \brief Encodes Z39.50 Init OPtions based on string mnemonics */
137 YAZ_EXPORT int yaz_init_opt_encode(Z_Options *opt, const char *opt_str,
138                                    int *error_pos);
139
140 /** \brief Decodes Z39.50 Init Options - for printing */
141 YAZ_EXPORT void yaz_init_opt_decode(Z_Options *opt,
142                                     void (*pr)(const char *name,
143                                                void *clientData),
144                                     void *clientData);
145 /** \brief Creates Default Diag Format Diagnostic */
146 YAZ_EXPORT
147 Z_DefaultDiagFormat *zget_DefaultDiagFormat(ODR o, int error,
148                                             const char *addinfo);
149
150 /** \brief Creates Surrogate Diagnostic Records */
151 YAZ_EXPORT
152 Z_NamePlusRecord *zget_surrogateDiagRec(ODR o, const char *dbname,
153                                         int error, const char *addinfo);
154
155 /** \brief Creates Initialize Response diagnostics */
156 YAZ_EXPORT
157 Z_External *zget_init_diagnostics(ODR odr, int error, const char *addinfo);
158
159 /** \brief Creates Initialize Response diagnostics (Octet-aligned EXTERNAL) */
160 YAZ_EXPORT
161 Z_External *zget_init_diagnostics_octet(ODR odr, int error, const char *addinfo);
162
163 /** \brief Creates Diagnostic record - Z_DiagRecs type */
164 YAZ_EXPORT
165 Z_DiagRecs *zget_DiagRecs(ODR o, int error, const char *addinfo);
166
167 /** \brief Creates Diagnostic record - Z_DiagRecs type */
168 YAZ_EXPORT
169 Z_DiagRec *zget_DiagRec(ODR o, int error, const char *addinfo);
170
171 /** \brief get element set name from RecordComposition
172     \param comp record composition
173     \returns element set name or NULL if no element set name was given
174 */
175 YAZ_EXPORT
176 const char *yaz_get_esn(Z_RecordComposition *comp);
177
178 /** \brief set element set name in RecordComposition struct
179     \param comp_p record composition ptr
180     \param esn element set name string
181     \param nmem memory for result composition
182 */
183 YAZ_EXPORT
184 void yaz_set_esn(Z_RecordComposition **comp_p, const char *esn, NMEM nmem);
185
186
187 YAZ_END_CDECL
188
189 #include <yaz/prt-ext.h>
190
191 #endif
192 /*
193  * Local variables:
194  * c-basic-offset: 4
195  * indent-tabs-mode: nil
196  * End:
197  * vim: shiftwidth=4 tabstop=8 expandtab
198  */
199