For estimated hit counts, Zebra returns resultSetStatus=estimtate as

[idzebra-moved-to-github.git] / include / idzebra / api.h

diff --git a/include/idzebra/api.h b/include/idzebra/api.h
index fb6efea..1a41b65 100644 (file)
--- a/include/idzebra/api.h
+++ b/include/idzebra/api.h
@@ -1,5 +1,5 @@
-/* $Id: api.h,v 1.36 2006-06-07 10:14:40 adam Exp $
-   Copyright (C) 1995-2005
+/* $Id: api.h,v 1.43 2007-01-16 15:01:15 adam Exp $
+   Copyright (C) 1995-2007
    Index Data ApS
 
 This file is part of the Zebra server.
@@ -15,9 +15,9 @@ FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 for more details.
 
 You should have received a copy of the GNU General Public License
-along with Zebra; see the file LICENSE.zebra.  If not, write to the
-Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
-02111-1307, USA.
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
 */
 
 /** \file api.h
@@ -39,19 +39,6 @@ Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 
 YAZ_BEGIN_CDECL
 
-/**
-  expand GCC_ATTRIBUTE if GCC is in use. See :
-  http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html
-*/
-
-#ifndef GCC_ATTRIBUTE
-#ifdef __GNUC__
-#define GCC_ATTRIBUTE(x) __attribute__ (x)
-#else
-#define GCC_ATTRIBUTE(x)
-#endif
-#endif
-
 typedef struct {
     zint processed;
     zint inserted;
@@ -70,13 +57,13 @@ typedef struct {
     int len;             /* length */
     oid_value format;    /* record syntax */
     char *base; 
-    SYSNO sysno;
+    zint sysno;
     int  score;
 } ZebraRetrievalRecord;
 
 /** Scan Term Descriptor */
 typedef struct {
-    int occurrences;     /* scan term occurrences */
+    zint occurrences;    /* scan term occurrences */
     char *term;          /* scan term string */
 } ZebraScanEntry;
 
@@ -97,7 +84,7 @@ typedef struct zebra_service *ZebraService;
 */
 YAZ_EXPORT
 ZebraService zebra_start(const char *configName
-    ) GCC_ATTRIBUTE((warn_unused_result));
+    ) ZEBRA_GCC_ATTR((warn_unused_result));
 
 /** \brief Creates a Zebra service with resources.
     \param configName name of configuration file
@@ -110,7 +97,7 @@ ZebraService zebra_start(const char *configName
 YAZ_EXPORT
 ZebraService zebra_start_res(const char *configName,
                             Res def_res, Res over_res
-    ) GCC_ATTRIBUTE((warn_unused_result));
+    ) ZEBRA_GCC_ATTR((warn_unused_result));
 
 /** \brief stops a Zebra service.
     \param zs service handle
@@ -140,7 +127,7 @@ void zebra_filter_info(ZebraService zs, void *cd,
 */
 YAZ_EXPORT
 ZebraHandle zebra_open(ZebraService zs, Res res
-    ) GCC_ATTRIBUTE((warn_unused_result));
+    ) ZEBRA_GCC_ATTR((warn_unused_result));
 
 /** \brief Destroys Zebra session handle.
     \param zh zebra session handle.
@@ -199,6 +186,22 @@ ZEBRA_RES zebra_search_PQF(ZebraHandle zh, const char *pqf_query,
     \param query RPN query using YAZ structure
     \param setname name of resultset
     \param hits number of hits is returned
+    \param estimated_hit_count whether hit count is an estimate
+    \param partial_resultset whether result is only partially evaluated
+*/
+YAZ_EXPORT
+ZEBRA_RES zebra_search_RPN_x(ZebraHandle zh, ODR o, Z_RPNQuery *query,
+                           const char *setname, zint *hits,
+                           int *estimated_hit_count,
+                           int *partial_resultset);
+
+
+/** \brief Search using RPN Query structure (from ASN.1)
+    \param zh session handle
+    \param o ODR handle
+    \param query RPN query using YAZ structure
+    \param setname name of resultset
+    \param hits number of hits is returned
 */
 YAZ_EXPORT
 ZEBRA_RES zebra_search_RPN(ZebraHandle zh, ODR o, Z_RPNQuery *query,
@@ -369,11 +372,11 @@ ZEBRA_RES zebra_admin_exchange_record(ZebraHandle zh,
 
 YAZ_EXPORT 
 ZEBRA_RES zebra_begin_trans(ZebraHandle zh, int rw
-    ) GCC_ATTRIBUTE((warn_unused_result));
+    ) ZEBRA_GCC_ATTR((warn_unused_result));
 
 YAZ_EXPORT
 ZEBRA_RES zebra_end_trans(ZebraHandle zh
-    ) GCC_ATTRIBUTE((warn_unused_result));
+    ) ZEBRA_GCC_ATTR((warn_unused_result));
 
 YAZ_EXPORT
 ZEBRA_RES zebra_end_transaction(ZebraHandle zh,
@@ -406,21 +409,22 @@ ZEBRA_RES zebra_add_record(ZebraHandle zh, const char *buf, int buf_size);
 YAZ_EXPORT 
 ZEBRA_RES zebra_insert_record(ZebraHandle zh, 
                              const char *recordType,
-                             SYSNO *sysno, const char *match,
+                             zint *sysno, const char *match,
                              const char *fname,
                              const char *buf, int buf_size,
                              int force_update);
 YAZ_EXPORT
 ZEBRA_RES zebra_update_record(ZebraHandle zh, 
                              const char *recordType,
-                             SYSNO *sysno, const char *match,
+                             zint *sysno, const char *match,
                              const char *fname,
                              const char *buf, int buf_size,
                              int force_update);
 YAZ_EXPORT 
 ZEBRA_RES zebra_delete_record(ZebraHandle zh, 
                              const char *recordType,
-                             SYSNO *sysno, const char *match, const char *fname,
+                             zint *sysno, const char *match,
+                              const char *fname,
                              const char *buf, int buf_size,
                              int force_update);
 
@@ -431,16 +435,16 @@ ZEBRA_RES zebra_sort(ZebraHandle zh, ODR stream,
                     const char *output_setname,
                     Z_SortKeySpecList *sort_sequence,
                     int *sort_status
-    ) GCC_ATTRIBUTE((warn_unused_result));    
+    ) ZEBRA_GCC_ATTR((warn_unused_result));    
 
 YAZ_EXPORT
 ZEBRA_RES zebra_select_databases(ZebraHandle zh, int num_bases, 
                                 const char **basenames
-    ) GCC_ATTRIBUTE((warn_unused_result));
+    ) ZEBRA_GCC_ATTR((warn_unused_result));
 
 YAZ_EXPORT
 ZEBRA_RES zebra_select_database(ZebraHandle zh, const char *basename
-    ) GCC_ATTRIBUTE((warn_unused_result));
+    ) ZEBRA_GCC_ATTR((warn_unused_result));
 
 YAZ_EXPORT
 void zebra_shadow_enable(ZebraHandle zh, int value);