Improved installation. Updated for inclusion of YAZ header files.
[idzebra-moved-to-github.git] / index / zserver.h
index dd93352..0b49c28 100644 (file)
@@ -1,10 +1,63 @@
 /*
- * Copyright (C) 1994-1998, Index Data I/S 
+ * Copyright (C) 1994-1999, Index Data 
  * All rights reserved.
  * Sebastian Hammer, Adam Dickmeiss
  *
  * $Log: zserver.h,v $
- * Revision 1.30  1998-03-05 08:45:13  adam
+ * Revision 1.45  1999-11-30 13:48:04  adam
+ * Improved installation. Updated for inclusion of YAZ header files.
+ *
+ * Revision 1.44  1999/11/04 15:00:45  adam
+ * Implemented delete result set(s).
+ *
+ * Revision 1.43  1999/07/14 10:59:27  adam
+ * Changed functions isc_getmethod, isams_getmethod.
+ * Improved fatal error handling (such as missing EXPLAIN schema).
+ *
+ * Revision 1.42  1999/05/26 07:49:13  adam
+ * C++ compilation.
+ *
+ * Revision 1.41  1999/05/12 13:08:06  adam
+ * First version of ISAMS.
+ *
+ * Revision 1.40  1998/11/16 16:03:45  adam
+ * Moved loggin utilities to Yaz. Was implemented in file zlogs.c.
+ *
+ * Revision 1.39  1998/10/16 08:14:35  adam
+ * Updated record control system.
+ *
+ * Revision 1.38  1998/09/22 10:03:44  adam
+ * Changed result sets to be persistent in the sense that they can
+ * be re-searched if needed.
+ * Fixed memory leak in rsm_or.
+ *
+ * Revision 1.37  1998/09/02 13:53:22  adam
+ * Extra parameter decode added to search routines to implement
+ * persistent queries.
+ *
+ * Revision 1.36  1998/06/24 12:16:16  adam
+ * Support for relations on text operands. Open range support in
+ * DFA module (i.e. [-j], [g-]).
+ *
+ * Revision 1.35  1998/06/23 15:33:35  adam
+ * Added feature to specify sort criteria in query (type 7 specifies
+ * sort flags).
+ *
+ * Revision 1.34  1998/06/22 11:36:50  adam
+ * Added authentication check facility to zebra.
+ *
+ * Revision 1.33  1998/06/12 12:22:14  adam
+ * Work on Zebra API.
+ *
+ * Revision 1.32  1998/05/27 16:57:47  adam
+ * Zebra returns surrogate diagnostic for single records when
+ * appropriate.
+ *
+ * Revision 1.31  1998/05/20 10:12:23  adam
+ * Implemented automatic EXPLAIN database maintenance.
+ * Modified Zebra to work with ASN.1 compiled version of YAZ.
+ *
+ * Revision 1.30  1998/03/05 08:45:13  adam
  * New result set model and modular ranking system. Moved towards
  * descent server API. System information stored as "SGML" records.
  *
  *
  */
 
-
-#ifndef USE_TIMES
-#ifdef __linux__
-#define USE_TIMES 1
-#else
-#define USE_TIMES 0
-#endif
-#endif
-
-#if USE_TIMES
+#if HAVE_SYS_TIMES_H
 #include <sys/times.h>
 #endif
 
-#include <backend.h>
+#include <yaz/backend.h>
 #include <rset.h>
 
 #include <sortidx.h>
+#include <passwddb.h>
 #include "index.h"
+#include "zebraapi.h"
 #include "zinfo.h"
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 typedef struct {
     int sysno;
     int score;
@@ -139,38 +189,40 @@ typedef struct zebra_rank_class {
     void *class_handle;
     struct zebra_rank_class *next;
 } *ZebraRankClass;
-   
+
 struct zebra_info {
     int registerState; /* 0 (no commit pages), 1 (use commit pages) */
     time_t registerChange;
     ZebraSet sets;
     Dict dict;
     SortIdx sortIdx;
+    ISAMS isams;
+#if ZMBOL
     ISAM isam;
     ISAMC isamc;
+#endif
     Records records;
     int errCode;
     int hits;
     char *errString;
     ZebraExplainInfo zei;
     data1_handle dh;
-    data1_attset *registered_sets;
     BFiles bfs;
     Res res;
 
     ZebraLockHandle server_lock_cmt;
     ZebraLockHandle server_lock_org;
     char *server_path_prefix;
-#if USE_TIMES
+#if HAVE_SYS_TIMES_H
     struct tms tms1;
     struct tms tms2;    
 #endif
     ZebraMaps zebra_maps;
     ZebraRankClass rank_classes;
+    RecTypes recTypes;
+    Passwd_db passwd_db;
 };
 
-typedef struct zebra_info *ZebraHandle;
-
 struct rank_control {
     char *name;
     void *(*create)(ZebraHandle zh);
@@ -181,48 +233,46 @@ struct rank_control {
     void (*add)(void *set_handle, int seqno, int term_index);
 };
 
-void rpn_search (ZebraHandle zh, ODR stream,
+RSET rpn_search (ZebraHandle zh, NMEM mem,
                 Z_RPNQuery *rpn, int num_bases, char **basenames, 
-                const char *setname);
+                const char *setname, ZebraSet sset);
 
 
-typedef struct {
-    int occurrences;
-    char *term;
-} ZebraScanEntry;
-
 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 rset_trunc (ZebraHandle zh, ISAM_P *isam_p, int no,
+RSET rset_trunc (ZebraHandle zh, ISAMS_P *isam_p, int no,
                 const char *term, int length_term, const char *flags);
 
-ZebraSet resultSetAdd (ZebraHandle zh, const char *name,
-                          int ov, RSET rset, int *hits);
+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);
 RSET resultSetRef (ZebraHandle zh, Z_ResultSetId *resultSetId);
-void resultSetDestroy (ZebraHandle zh);
+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, ODR stream,
-                   int num_input_setnames, char **input_setnames,
-                   char *output_setname, Z_SortKeySpecList *sort_sequence,
-                   int *sort_status);
+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);
 
 void zebra_sort (ZebraHandle zh, ODR stream,
-                int num_input_setnames, char **input_setnames,
-                char *output_setname, Z_SortKeySpecList *sort_sequence,
+                int num_input_setnames, const char **input_setnames,
+                const char *output_setname, Z_SortKeySpecList *sort_sequence,
                 int *sort_status);
 
-void zlog_rpn (Z_RPNQuery *rpn);
-void zlog_scan (Z_AttributesPlusTerm *zapt, oid_value ast);
-
 int zebra_server_lock_init (ZebraHandle zh);
 int zebra_server_lock_destroy (ZebraHandle zh);
 int zebra_server_lock (ZebraHandle zh, int lockCommit);
@@ -243,34 +293,11 @@ int att_getentbyatt(ZebraHandle zh, attent *res, oid_value set, int att);
 
 extern struct rank_control *rank1_class;
 
-ZebraHandle zebra_open (const char *host, const char *configName);
-void zebra_search_rpn (ZebraHandle zh, ODR stream,
-                      Z_RPNQuery *query, int num_bases, char **basenames, 
-                      const char *setname);
-
-typedef struct {
-    int position;
-    char *buf;
-    int len;
-    oid_value format;
-    char *base;
-} ZebraRetrievalRecord;
-
-void zebra_records_retrieve (ZebraHandle zh, ODR stream,
-                            const char *setname, Z_RecordComposition *comp,
-                            oid_value input_format,
-                            int num_recs, ZebraRetrievalRecord *recs);
-
 int zebra_record_fetch (ZebraHandle zh, int sysno, int score, ODR stream,
                        oid_value input_format, Z_RecordComposition *comp,
                        oid_value *output_format, char **rec_bufp,
                        int *rec_lenp, char **basenamep);
 
-void zebra_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);
-
-void zebra_close (ZebraHandle zh);
-
+#ifdef __cplusplus
+}
+#endif