Align Zebra API more so that ZEBRA_RES is used to signal error/OK.

[idzebra-moved-to-github.git] / index / index.h

diff --git a/index/index.h b/index/index.h
index eceba4e..61fe3f4 100644 (file)
--- a/index/index.h
+++ b/index/index.h
@@ -1,6 +1,6 @@
-/* $Id: index.h,v 1.128 2004-12-08 14:02:36 adam Exp $
-   Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003,2004
-   Index Data Aps
+/* $Id: index.h,v 1.138 2005-05-11 12:39:36 adam Exp $
+   Copyright (C) 1995-2005
+   Index Data ApS
 
 This file is part of the Zebra server.
 
@@ -24,8 +24,9 @@ Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 #define INDEX_H
 
 #include <time.h>
+#include <stdlib.h>
 #include <idzebra/version.h>
-#include <zebrautl.h>
+#include <idzebra/util.h>
 #include <sortidx.h>
 
 #if HAVE_SYS_TIMES_H
@@ -77,7 +78,7 @@ struct dirs_entry {
 void getFnameTmp (Res res, char *fname, int no);
         
 struct dirs_info *dirs_open (Dict dict, const char *rep, int rw);
-struct dirs_info *dirs_fopen (Dict dict, const char *path);
+struct dirs_info *dirs_fopen (Dict dict, const char *path, int rw);
 struct dirs_entry *dirs_read (struct dirs_info *p);
 struct dirs_entry *dirs_last (struct dirs_info *p);
 void dirs_mkdir (struct dirs_info *p, const char *src, time_t mtime);
@@ -305,6 +306,12 @@ struct zebra_session {
     int m_explain_database;
     int m_flag_rw;
     int m_file_verbose_limit;
+
+    void *store_data_buf;
+    size_t store_data_size;
+    NMEM nmem_error;
+
+    struct zebra_limit *m_limit;
 };
 
 struct rank_control {
@@ -334,41 +341,55 @@ struct term_set_list {
     struct term_set_entry *last;
 };
 
-RSET rpn_search (ZebraHandle zh, NMEM mem, NMEM rset_nmem,
-                Z_RPNQuery *rpn, int num_bases, char **basenames, 
-                const char *setname, ZebraSet sset);
 
+void zebra_limit_destroy(struct zebra_limit *zl);
+struct zebra_limit *zebra_limit_create(int exclude_flag, zint *ids);
+void zebra_limit_for_rset(struct zebra_limit *zl,
+                         int (**filter_func)(const void *buf, void *data),
+                         void (**filter_destroy)(void *data),
+                         void **filter_data);
+
+struct rset_key_control *zebra_key_control_create(ZebraHandle zh);
 
-void rpn_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
-              oid_value attributeset,
-              int num_bases, char **basenames,
-              int *position, int *num_entries, ZebraScanEntry **list,
-              int *is_partial, RSET limit_set, int return_zero);
+ZEBRA_RES rpn_search_top(ZebraHandle zh, Z_RPNStructure *zs,
+                        oid_value attributeSet, 
+                        NMEM stream, NMEM rset_nmem,
+                        Z_SortKeySpecList *sort_sequence,
+                        int num_bases, char **basenames,
+                        RSET *result_set);
 
-RSET rset_trunc (ZebraHandle zh, ISAMS_P *isam_p, int no,
+ZEBRA_RES rpn_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
+                   oid_value attributeset,
+                   int num_bases, char **basenames,
+                   int *position, int *num_entries, ZebraScanEntry **list,
+                   int *is_partial, RSET limit_set, int return_zero);
+
+RSET rset_trunc (ZebraHandle zh, ISAM_P *isam_p, int no,
                 const char *term, int length_term, const char *flags,
                  int preserve_position, int term_type, NMEM rset_nmem,
-                 const struct key_control *kctrl, int scope);
+                 struct rset_key_control *kctrl, int scope);
 
 void resultSetAddTerm (ZebraHandle zh, ZebraSet s, int reg_type,
                       const char *db, int set,
                       int use, const char *term);
 ZebraSet resultSetAdd (ZebraHandle zh, const char *name, int ov);
 ZebraSet resultSetGet (ZebraHandle zh, const char *name);
-ZebraSet resultSetAddRPN (ZebraHandle zh, NMEM m, Z_RPNQuery *rpn,
-                          int num_bases, char **basenames,
-                          const char *setname);
+ZEBRA_RES resultSetAddRPN (ZebraHandle zh, NMEM m, Z_RPNQuery *rpn,
+                    int num_bases, char **basenames,
+                    const char *setname);
 RSET resultSetRef (ZebraHandle zh, const char *resultSetId);
 void resultSetDestroy (ZebraHandle zh, int num_names, char **names,
                       int *statuses);
-void resultSetSort (ZebraHandle zh, NMEM nmem,
-                   int num_input_setnames, const char **input_setnames,
-                   const char *output_setname,
-                   Z_SortKeySpecList *sort_sequence, int *sort_status);
-void resultSetSortSingle (ZebraHandle zh, NMEM nmem,
-                         ZebraSet sset, RSET rset,
-                         Z_SortKeySpecList *sort_sequence, int *sort_status);
-void resultSetRank (ZebraHandle zh, ZebraSet zebraSet, RSET rset, NMEM nmem);
+ZEBRA_RES resultSetSort (ZebraHandle zh, NMEM nmem,
+                        int num_input_setnames, const char **input_setnames,
+                        const char *output_setname,
+                        Z_SortKeySpecList *sort_sequence, int *sort_status);
+ZEBRA_RES resultSetSortSingle (ZebraHandle zh, NMEM nmem,
+                              ZebraSet sset, RSET rset,
+                              Z_SortKeySpecList *sort_sequence,
+                              int *sort_status);
+ZEBRA_RES resultSetRank (ZebraHandle zh, ZebraSet zebraSet, RSET rset,
+                        NMEM nmem);
 void resultSetInvalidate (ZebraHandle zh);
 
 int zebra_server_lock_init (ZebraService zh);
@@ -404,16 +425,16 @@ void extract_get_fname_tmp (ZebraHandle zh, char *fname, int no);
 
 void zebra_index_merge (ZebraHandle zh);
 
-int buffer_extract_record (ZebraHandle zh, 
-                          const char *buf, size_t buf_size,
-                          int delete_flag,
-                          int test_mode, 
-                          const char *recordType,
-                          SYSNO *sysno,
-                          const char *match_criteria,
-                          const char *fname,
-                          int force_update,
-                          int allow_update);
+ZEBRA_RES buffer_extract_record (ZebraHandle zh, 
+                                const char *buf, size_t buf_size,
+                                int delete_flag,
+                                int test_mode, 
+                                const char *recordType,
+                                SYSNO *sysno,
+                                const char *match_criteria,
+                                const char *fname,
+                                int force_update,
+                                int allow_update);
 
 #if 0
 int extract_rec_in_mem (ZebraHandle zh, const char *recordType,
@@ -453,8 +474,8 @@ int explain_extract (void *handle, Record rec, data1_node *n);
 int fileExtract (ZebraHandle zh, SYSNO *sysno, const char *fname,
                 int deleteFlag);
 
-int zebra_begin_read (ZebraHandle zh);
-int zebra_end_read (ZebraHandle zh);
+ZEBRA_RES zebra_begin_read (ZebraHandle zh);
+ZEBRA_RES zebra_end_read (ZebraHandle zh);
 
 int zebra_file_stat (const char *file_name, struct stat *buf,
                      int follow_links);
@@ -470,6 +491,9 @@ void iscz1_encode (void *vp, char **dst, const char **src);
 Dict dict_open_res (BFiles bfs, const char *name, int cache, int rw,
                    int compact_flag, Res res);
 
+void zebra_setError(ZebraHandle zh, int code, const char *addinfo);
+void zebra_setError_zint(ZebraHandle zh, int code, zint i);
+
 YAZ_END_CDECL
 
 #endif