-/*
- * Copyright (c) 1998-2001, Index Data
- * 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.
+/* This file is part of the YAZ toolkit.
+ * Copyright (C) 1995-2010 Index Data.
+ * All rights reserved.
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
*
- * 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.
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * Neither the name of Index Data nor the names of its contributors
+ * may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
*
+ * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/**
+ * \file proto.h
+ * \brief Header for Z39.50 Protocol
*/
#ifndef Z_PROTO_H
#define Z_PROTO_H
#include <yaz/z-espec1.h>
#include <yaz/z-estask.h>
#include <yaz/z-exp.h>
+#include <yaz/z-facet-1.h>
#include <yaz/z-grs.h>
#include <yaz/z-opac.h>
#include <yaz/z-rrf1.h>
#include <yaz/z-univ.h>
#include <yaz/zes-update0.h>
#include <yaz/z-charneg.h>
+#include <yaz/z-mterm2.h>
+#include <yaz/wrbuf.h>
+#include <yaz/matchstr.h>
+#include <yaz/zgdu.h>
+#include <yaz/z-oclcui.h>
+#include <yaz/marcdisp.h>
YAZ_BEGIN_CDECL
+/* Here are a lot of definitions that were defined in YAZ 1 and which
+ are still in use by some applications. We keep those to preserve
+ backwards compatibility.. They cause no harm.
+*/
#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
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);
-YAZ_EXPORT Odr_oid *yaz_str_to_z3950oid (ODR o, int oid_class,
- const char *str);
-YAZ_EXPORT const char *yaz_z3950oid_to_str (Odr_oid *oid, int *oid_class);
+
+/** \brief Performs "pretty" display of GRS-1 record to WRBUF */
+YAZ_EXPORT void yaz_display_grs1(WRBUF wrbuf, Z_GenericRecord *r, int flags);
+
+/** \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);
+
+/** \brief get element set name from RecordComposition
+ \param comp record composition
+ \returns element set name or NULL if no element set name was given
+*/
+YAZ_EXPORT
+const char *yaz_get_esn(Z_RecordComposition *comp);
+
+/** \brief set element set name in RecordComposition struct
+ \param comp_p record composition ptr
+ \param esn element set name string
+ \param nmem memory for result composition
+*/
+YAZ_EXPORT
+void yaz_set_esn(Z_RecordComposition **comp_p, const char *esn, NMEM nmem);
+
YAZ_END_CDECL
#include <yaz/prt-ext.h>
#endif
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * c-file-style: "Stroustrup"
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+
projects / yaz-moved-to-github.git / blobdiff