Add YAZ_EXPORT yaz_opac_decode_wrbuf

[yaz-moved-to-github.git] / include / yaz / proto.h

diff --git a/include/yaz/proto.h b/include/yaz/proto.h
index be0d05b..453a87b 100644 (file)
--- a/include/yaz/proto.h
+++ b/include/yaz/proto.h
@@ -1,49 +1,12 @@
 /*
- * Copyright (c) 1998-2001, Index Data
+ * Copyright (C) 1995-2005, Index Data ApS
  * See the file LICENSE for details.
- * Sebastian Hammer, Adam Dickmeiss
- *
- * $Log: proto.h,v $
- * Revision 1.2  2002-02-11 23:25:26  adam
- * Rustam's patch
- *
- * Revision 1.1  2001/10/23 21:00:19  adam
- * Old Z39.50 codecs gone. Added ZOOM. WRBUF MARC display util.
- *
- * Revision 1.7  2001/09/24 21:51:55  adam
- * New Z39.50 OID utilities: yaz_oidval_to_z3950oid, yaz_str_to_z3950oid
- * and yaz_z3950oid_to_str.
- *
- * Revision 1.6  2001/09/19 10:19:07  adam
- * Z_SortCase_caseInsensitive was set to wrong value.
- *
- * Revision 1.5  2001/05/17 14:16:15  adam
- * Added EXTERNAL handling for item update0 (1.0).
- *
- * Revision 1.4  2000/03/14 09:19:49  ian
- * Added admin extended service encoders & decoders.
- *
- * Revision 1.3  2000/02/28 11:20:06  adam
- * Using autoconf. New definitions: YAZ_BEGIN_CDECL/YAZ_END_CDECL.
- *
- * Revision 1.2  1999/12/16 23:36:19  adam
- * Implemented ILL protocol. Minor updates ASN.1 compiler.
- *
- * Revision 1.1  1999/11/30 13:47:11  adam
- * Improved installation. Moved header files to include/yaz.
- *
- * Revision 1.2  1999/06/09 10:52:11  adam
- * Added YAZ_EXPORT.
- *
- * Revision 1.1  1999/06/08 13:11:55  adam
- * Fixed problem with proto.h.
- *
- * Revision 1.2  1999/04/20 10:37:04  adam
- * Updated for ODR - added name parameter.
- *
- * Revision 1.1  1998/03/31 16:04:05  adam
- * First version of proto.h which is almost compatible with the old one.
  *
+ * $Id: proto.h,v 1.22 2006-03-30 14:15:20 adam Exp $
+ */
+/**
+ * \file proto.h
+ * \brief Header for Z39.50 Protocol
  */
 #ifndef Z_PROTO_H
 #define Z_PROTO_H
@@ -79,9 +42,16 @@
 #include <yaz/z-univ.h>
 #include <yaz/zes-update0.h>
 #include <yaz/z-charneg.h>
+#include <yaz/z-mterm2.h>
+#include <yaz/oid.h>
+#include <yaz/wrbuf.h>
+#include <yaz/zgdu.h>
+#include <yaz/z-oclcui.h>
 
+#include <yaz/marcdisp.h>
 YAZ_BEGIN_CDECL
 
+#if 1
 #define Z_PRES_SUCCESS   Z_PresentStatus_success
 #define Z_PRES_PARTIAL_1 Z_PresentStatus_partial_1
 #define Z_PRES_PARTIAL_2 Z_PresentStatus_partial_2
@@ -131,6 +101,7 @@ YAZ_BEGIN_CDECL
 #define Z_SortResultSetStatus_interim     Z_SortResponse_interim
 #define Z_SortResultSetStatus_unchanged   Z_SortResponse_unchanged
 #define Z_SortResultSetStatus_none        Z_SortResponse_none
+#endif
 
 typedef Z_External Z_DatabaseRecord;
 typedef struct Z_IOItemOrder Z_ItemOrder;
@@ -138,13 +109,67 @@ typedef struct Z_IOItemOrder Z_ItemOrder;
 YAZ_EXPORT Z_APDU *zget_APDU(ODR o, int which);
 YAZ_EXPORT Z_Close *zget_Close (ODR o);
 YAZ_EXPORT Odr_oid *yaz_oidval_to_z3950oid (ODR o, int oid_class,
-                                           int oid_value);
+                                            int oid_value);
 YAZ_EXPORT Odr_oid *yaz_str_to_z3950oid (ODR o, int oid_class,
-                                        const char *str);
+                                         const char *str);
 YAZ_EXPORT const char *yaz_z3950oid_to_str (Odr_oid *oid, int *oid_class);
 
+YAZ_EXPORT const char* yaz_z3950_oid_value_to_str(oid_value ov, oid_class oc);
+
+/** \brief Performs "pretty" display of GRS-1 record to WRBUF */
+YAZ_EXPORT void yaz_display_grs1(WRBUF wrbuf, Z_GenericRecord *r, int flags);
+
+/** \brief Performs "pretty" display of OPAC record to WRBUF */
+YAZ_EXPORT void yaz_display_OPAC(WRBUF wrbuf, Z_OPACRecord *r, int flags);
+
+/** \brief Performs "pretty" display of OPAC record to WRBUF using marc_t */
+YAZ_EXPORT void yaz_opac_decode_wrbuf(yaz_marc_t mt, Z_OPACRecord *r, WRBUF wrbuf);
+
+/** \brief Encodes Z39.50 Init OPtions based on string mnemonics */
+YAZ_EXPORT int yaz_init_opt_encode(Z_Options *opt, const char *opt_str,
+                                   int *error_pos);
+
+/** \brief Decodes Z39.50 Init Options - for printing */
+YAZ_EXPORT void yaz_init_opt_decode(Z_Options *opt,
+                                    void (*pr)(const char *name,
+                                               void *clientData),
+                                    void *clientData);
+/** \brief Creates Default Diag Format Diagnostic */
+YAZ_EXPORT
+Z_DefaultDiagFormat *zget_DefaultDiagFormat(ODR o, int error,
+                                            const char *addinfo);
+
+/** \brief Creates Surrogate Diagnostic Records */
+YAZ_EXPORT
+Z_NamePlusRecord *zget_surrogateDiagRec(ODR o, const char *dbname,
+                                        int error, const char *addinfo);
+
+/** \brief Creates Initialize Response diagnostics */
+YAZ_EXPORT
+Z_External *zget_init_diagnostics(ODR odr, int error, const char *addinfo);
+
+/** \brief Creates Initialize Response diagnostics (Octet-aligned EXTERNAL) */
+YAZ_EXPORT
+Z_External *zget_init_diagnostics_octet(ODR odr, int error, const char *addinfo);
+
+/** \brief Creates Diagnostic record - Z_DiagRecs type */
+YAZ_EXPORT
+Z_DiagRecs *zget_DiagRecs(ODR o, int error, const char *addinfo);
+
+/** \brief Creates Diagnostic record - Z_DiagRecs type */
+YAZ_EXPORT
+Z_DiagRec *zget_DiagRec(ODR o, int error, const char *addinfo);
+
 YAZ_END_CDECL
 
 #include <yaz/prt-ext.h>
 
 #endif
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+