Move/refactoring of public interfaces..
[idzebra-moved-to-github.git] / index / index.h
index 56e7292..c87fc73 100644 (file)
@@ -1,5 +1,5 @@
-/* $Id: index.h,v 1.96 2003-03-12 17:11:23 pop Exp $
-   Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002
+/* $Id: index.h,v 1.127 2004-12-08 12:23:09 adam Exp $
+   Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003,2004
    Index Data Aps
 
 This file is part of the Zebra server.
@@ -20,15 +20,12 @@ Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 02111-1307, USA.
 */
 
-
-
 #ifndef INDEX_H
 #define INDEX_H
 
 #include <time.h>
-#include <zebraver.h>
+#include <idzebra/version.h>
 #include <zebrautl.h>
-#include <zebramap.h>
 #include <sortidx.h>
 
 #if HAVE_SYS_TIMES_H
@@ -36,34 +33,30 @@ Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 #endif
 #include <sys/stat.h>
 
-#include <dict.h>
+#include <idzebra/dict.h>
 #include <isams.h>
-#include <isam.h>
 #include <isamc.h>
-#include <isamd.h>
 #include <isamb.h>
-#define ISAM_DEFAULT "c"
-#include <data1.h>
-#include <recctrl.h>
+#include <d1_absyn.h>
+#include <idzebra/recgrs.h>
 #include "recindex.h"
-#include "zebraapi.h"
+#include <idzebra/api.h>
 #include "zinfo.h"
 #include <passwddb.h>
 #include <rset.h>
 
 YAZ_BEGIN_CDECL
 
+#define ISAM_DEFAULT "b"
+
 #define SU_SCHEME 1
 
 #define IT_MAX_WORD 256
-#define IT_KEY_HAVE_SEQNO 1
-#define IT_KEY_HAVE_FIELD 0
-
-typedef int SYSNO;
 
+#define IT_KEY_LEVEL_MAX 4
 struct it_key {
-    int  sysno;
-    int  seqno;
+    int  len;
+    zint mem[IT_KEY_LEVEL_MAX];
 };
 
 enum dirsKind { dirs_dir, dirs_file };
@@ -89,7 +82,7 @@ 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);
 void dirs_rmdir (struct dirs_info *p, const char *src);
-void dirs_add (struct dirs_info *p, const char *src, int sysno, time_t mtime);
+void dirs_add (struct dirs_info *p, const char *src, SYSNO sysno, time_t mtime);
 void dirs_del (struct dirs_info *p, const char *src);
 void dirs_free (struct dirs_info **pp);
 
@@ -98,25 +91,26 @@ struct dir_entry *dir_open (const char *rep, const char *base,
 void dir_sort (struct dir_entry *e);
 void dir_free (struct dir_entry **e_p);
 
-void repositoryUpdate (ZebraHandle zh);
-void repositoryAdd (ZebraHandle zh);
-void repositoryDelete (ZebraHandle zh);
-void repositoryShow (ZebraHandle zh);
+void repositoryUpdate (ZebraHandle zh, const char *path);
+void repositoryAdd (ZebraHandle zh, const char *path);
+void repositoryDelete (ZebraHandle zh, const char *path);
+void repositoryShow (ZebraHandle zh, const char *path);
 
 int key_open (ZebraHandle zh, int mem);
 int key_close (ZebraHandle zh);
 int key_compare (const void *p1, const void *p2);
+void key_init(struct it_key *k);
 char *key_print_it (const void *p, char *buf);
-int key_get_pos (const void *p);
+zint key_get_seq (const void *p);
 int key_compare_it (const void *p1, const void *p2);
 int key_qsort_compare (const void *p1, const void *p2);
 void key_logdump (int mask, const void *p);
+void key_logdump_txt (int logmask, const void *p, const char *txt);
 void inv_prstat (ZebraHandle zh);
 void inv_compact (BFiles bfs);
 void key_input (ZebraHandle zh, int nkeys, int cache, Res res);
-ISAMS_M key_isams_m (Res res, ISAMS_M me);
-ISAMC_M key_isamc_m (Res res, ISAMC_M me);
-ISAMD_M key_isamd_m (Res res, ISAMD_M me);
+ISAMS_M *key_isams_m (Res res, ISAMS_M *me);
+ISAMC_M *key_isamc_m (Res res, ISAMC_M *me);
 int merge_sort (char **buf, int from, int to);
 int key_SU_code (int ch, char *out);
 
@@ -179,6 +173,7 @@ struct encode_info {
     int prevseq;
     int prevcmd;
     int keylen; /* tells if we have an unwritten key in buf, and how long*/
+    void *encode_handle;
     char buf[ENCODE_BUFLEN];
 };
 
@@ -187,13 +182,6 @@ char *encode_key_int (int d, char *bp);
 void encode_key_write (char *k, struct encode_info *i, FILE *outf);
 void encode_key_flush (struct encode_info *i, FILE *outf);
 
-typedef struct {
-    char *term;
-    char *db;
-    int sysno;
-    int score;
-} *ZebraPosSet;
-
 typedef struct zebra_set *ZebraSet;
 
 typedef struct zebra_rank_class {
@@ -207,34 +195,20 @@ struct recKeys {
     int buf_used;
     int buf_max;
     char *buf;
-    char prevAttrSet;
-    short prevAttrUse;
-    int prevSeqNo;
+    void *codec_handle;
 };
 
-#if 1
 struct sortKeys {
     int buf_used;
     int buf_max;
     char *buf;
 };
-#else
-struct sortKey {
-    char *string;
-    int length;
-    int attrSet;
-    int attrUse;
-    struct sortKey *next;
-};
-#endif
 
 struct zebra_register {
     char *name;
     
     ISAMS isams;
-    ISAM isam;
     ISAMC isamc;
-    ISAMD isamd;
     ISAMB isamb;
     Dict dict;
     Dict matchDict;
@@ -276,7 +250,9 @@ struct zebra_service {
     struct zebra_register *regs;
     Zebra_mutex_cond session_lock;
     Passwd_db passwd_db;
-    char *path_root;
+    const char *path_root;
+    RecTypeClass record_classes;
+    NMEM nmem;
 };
 
 
@@ -285,7 +261,7 @@ struct zebra_session {
     struct zebra_service *service;
     struct zebra_register *reg;
 
-    char *admin_databaseName;
+    char *xadmin_databaseName;
 
     char **basenames;
     int num_basenames;
@@ -301,34 +277,51 @@ struct zebra_session {
     int destroyed;
     ZebraSet sets;
     Res res;
+    char *user_perm;
     int errCode;
-    int hits;
+    zint hits;
     char *errString;
 #if HAVE_SYS_TIMES_H
     struct tms tms1;
     struct tms tms2;    
 #endif
-    struct recordGroup rGroup;
     int  shadow_enable;
 
-    int records_inserted;
-    int records_updated;
-    int records_deleted;
-    int records_processed;
+    zint records_inserted;
+    zint records_updated;
+    zint records_deleted;
+    zint records_processed;
     char *record_encoding;
 
     yaz_iconv_t iconv_to_utf8;
     yaz_iconv_t iconv_from_utf8;
+
+    int m_follow_links;
+    const char *m_group;
+    const char *m_record_id;
+    const char *m_record_type;
+    int m_store_data;
+    int m_store_keys;
+    int m_explain_database;
+    int m_flag_rw;
+    int m_file_verbose_limit;
 };
 
 struct rank_control {
     char *name;
-    void *(*create)(struct zebra_register *reg);
+    void *(*create)(ZebraHandle zh);
     void (*destroy)(struct zebra_register *reg, void *class_handle);
-    void *(*begin)(struct zebra_register *reg, void *class_handle, RSET rset);
+    void *(*begin)(struct zebra_register *reg, 
+                   void *class_handle, RSET rset, NMEM nmem,
+                   TERMID *terms, int numterms);
+    /* ### Could add parameters to begin:
+     * char *index;    // author, title, etc.
+     * int dbsize;     // number of records in database
+     * int rssize;     // number of records in result set (estimate?)
+     */
     void (*end)(struct zebra_register *reg, void *set_handle);
-    int (*calc)(void *set_handle, int sysno);
-    void (*add)(void *set_handle, int seqno, int term_index);
+    int (*calc)(void *set_handle, zint sysno);
+    void (*add)(void *set_handle, int seqno, TERMID term);
 };
 
 struct term_set_entry {
@@ -341,7 +334,7 @@ struct term_set_list {
     struct term_set_entry *last;
 };
 
-RSET rpn_search (ZebraHandle zh, NMEM mem,
+RSET rpn_search (ZebraHandle zh, NMEM mem, NMEM rset_nmem,
                 Z_RPNQuery *rpn, int num_bases, char **basenames, 
                 const char *setname, ZebraSet sset);
 
@@ -354,25 +347,20 @@ void rpn_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
 
 RSET rset_trunc (ZebraHandle zh, ISAMS_P *isam_p, int no,
                 const char *term, int length_term, const char *flags,
-                 int preserve_position, int term_type);
+                 int preserve_position, int term_type, NMEM rset_nmem,
+                 const struct 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, ODR stream, ODR decode,
-                          Z_RPNQuery *rpn, int num_bases,
-                          char **basenames, const char *setname);
+ZebraSet 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);
-
-
-ZebraPosSet zebraPosSetCreate (ZebraHandle zh, const char *name,
-                              int num, int *positions);
-void zebraPosSetDestroy (ZebraHandle zh, ZebraPosSet records, int num);
-
 void resultSetSort (ZebraHandle zh, NMEM nmem,
                    int num_input_setnames, const char **input_setnames,
                    const char *output_setname,
@@ -380,7 +368,7 @@ void resultSetSort (ZebraHandle zh, NMEM nmem,
 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);
+void resultSetRank (ZebraHandle zh, ZebraSet zebraSet, RSET rset, NMEM nmem);
 void resultSetInvalidate (ZebraHandle zh);
 
 int zebra_server_lock_init (ZebraService zh);
@@ -399,37 +387,43 @@ void zebraRankInstall (struct zebra_register *reg, struct rank_control *ctrl);
 ZebraRankClass zebraRankLookup (ZebraHandle zh, const char *name);
 void zebraRankDestroy (struct zebra_register *reg);
 
-int att_getentbyatt(ZebraHandle zh, attent *res, oid_value set, int att);
+int att_getentbyatt(ZebraHandle zh, attent *res, oid_value set, int att,
+               const char *sattr);
 
 extern struct rank_control *rank1_class;
 extern struct rank_control *rankzv_class;
+extern struct rank_control *rankliv_class;
 
-int zebra_record_fetch (ZebraHandle zh, int sysno, int score, ODR stream,
+int zebra_record_fetch (ZebraHandle zh, SYSNO sysno, int score, ODR stream,
                        oid_value input_format, Z_RecordComposition *comp,
                        oid_value *output_format, char **rec_bufp,
-                       int *rec_lenp, char **basenamep);
+                       int *rec_lenp, char **basenamep,
+                       char **addinfo);
 
 void extract_get_fname_tmp (ZebraHandle zh, char *fname, int no);
-void zebra_index_merge (ZebraHandle zh);
 
-int bufferExtractRecord (ZebraHandle zh, 
-                        const char *buf, size_t buf_size,
-                        struct recordGroup *rGroup, 
-                        int delete_flag,
-                        int test_mode, 
-                        const char *recordType,
-                        int *sysno,
-                        const char *match_criteria,
-                        const char *fname,
-                        int force_update);
+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);
+
+#if 0
 int extract_rec_in_mem (ZebraHandle zh, const char *recordType,
                         const char *buf, size_t buf_size,
                         const char *databaseName, int delete_flag,
                         int test_mode, int *sysno,
                         int store_keys, int store_data,
                         const char *match_criteria);
-void extract_flushWriteKeys (ZebraHandle zh);
+#endif
+void extract_flushWriteKeys (ZebraHandle zh, int final);
 
 struct zebra_fetch_control {
     off_t offset_end;
@@ -457,14 +451,25 @@ void extract_token_add (RecWord *p);
 int explain_extract (void *handle, Record rec, data1_node *n);
 
 int fileExtract (ZebraHandle zh, SYSNO *sysno, const char *fname,
-                 const struct recordGroup *rGroup, int deleteFlag);
+                int deleteFlag);
 
 int zebra_begin_read (ZebraHandle zh);
-void zebra_end_read (ZebraHandle zh);
+int zebra_end_read (ZebraHandle zh);
 
 int zebra_file_stat (const char *file_name, struct stat *buf,
                      int follow_links);
 
+void zebra_livcode_transform(ZebraHandle zh, Z_RPNQuery *query);
+
+void *iscz1_start ();
+void iscz1_reset (void *vp);
+void iscz1_stop (void *p);
+void iscz1_decode (void *vp, char **dst, const char **src);
+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);
+
 YAZ_END_CDECL
 
 #endif