Rename yaz_use_attribute_create to zget_AttributeList_use_string

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

diff --git a/include/yaz/proto.h b/include/yaz/proto.h
index 92b3da1..6380341 100644 (file)
--- a/include/yaz/proto.h
+++ b/include/yaz/proto.h
@@ -1,5 +1,5 @@
-/*
- * Copyright (c) 1995-2006, Index Data
+/* This file is part of the YAZ toolkit.
+ * Copyright (C) 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:
@@ -24,7 +24,6 @@
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
-/* $Id: proto.h,v 1.25 2006-11-14 08:37:38 adam Exp $ */
 
 /**
  * \file proto.h
@@ -45,6 +44,7 @@
 #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>
@@ -65,15 +65,18 @@
 #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/matchstr.h>
 #include <yaz/zgdu.h>
 #include <yaz/z-oclcui.h>
 
 #include <yaz/marcdisp.h>
 YAZ_BEGIN_CDECL
 
-#if 1
+/* 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
@@ -85,14 +88,14 @@ YAZ_BEGIN_CDECL
 #define Z_RES_INTERIM Z_SearchResponse_interim
 #define Z_RES_NONE    Z_SearchResponse_none
 
-#define Z_SortStatus_success Z_SortResponse_success 
+#define Z_SortStatus_success Z_SortResponse_success
 #define Z_SortStatus_partial_1 Z_SortResponse_partial_1
 #define Z_SortStatus_failure Z_SortResponse_failure
 
-#define Z_SortRelation_ascending            Z_SortKeySpec_ascending 
+#define Z_SortRelation_ascending            Z_SortKeySpec_ascending
 #define Z_SortRelation_descending           Z_SortKeySpec_descending
 #define Z_SortRelation_ascendingByFreq      Z_SortKeySpec_ascendingByFrequency
-#define Z_SortRelation_descendingByFreq     Z_SortKeySpec_descendingByfrequency 
+#define Z_SortRelation_descendingByFreq     Z_SortKeySpec_descendingByfrequency
 
 #define Z_SortCase_caseSensitive            Z_SortKeySpec_caseSensitive
 #define Z_SortCase_caseInsensitive          Z_SortKeySpec_caseInsensitive
@@ -123,30 +126,15 @@ 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;
 
 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);
-
-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);
@@ -197,6 +185,21 @@ const char *yaz_get_esn(Z_RecordComposition *comp);
 YAZ_EXPORT
 void yaz_set_esn(Z_RecordComposition **comp_p, const char *esn, NMEM nmem);
 
+/** \brief returns diagnostics from an init response
+    \param no number of diagnotic entry to get. 0=first, 1=second, ..
+    \param initrs InitResponse structure
+    \returns diag entry or 0 (NULL) if none could be found
+*/
+YAZ_EXPORT
+Z_DefaultDiagFormat *yaz_decode_init_diag(int no, Z_InitResponse *initrs);
+
+/** \brief creates AttributeList with type=1(use) and string value
+    \param o ODR for encoding
+    \param name use-value
+    \returns attribute list with only one use-attribute
+*/
+YAZ_EXPORT
+Z_AttributeList *zget_AttributeList_use_string(ODR o, const char *name);
 
 YAZ_END_CDECL
 
@@ -206,6 +209,7 @@ YAZ_END_CDECL
 /*
  * Local variables:
  * c-basic-offset: 4
+ * c-file-style: "Stroustrup"
  * indent-tabs-mode: nil
  * End:
  * vim: shiftwidth=4 tabstop=8 expandtab