New result set model.

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

diff --git a/include/rset.h b/include/rset.h
index 79b4ae6..cf36870 100644 (file)
--- a/include/rset.h
+++ b/include/rset.h
@@ -1,10 +1,39 @@
 /*
- * Copyright (C) 1994-1995, Index Data I/S 
+ * Copyright (C) 1994-1998, Index Data I/S 
  * All rights reserved.
  * Sebastian Hammer, Adam Dickmeiss
  *
  * $Log: rset.h,v $
- * Revision 1.8  1995-10-06 14:37:53  adam
+ * Revision 1.15  1998-03-05 08:37:44  adam
+ * New result set model.
+ *
+ * Revision 1.14  1998/02/10 11:56:46  adam
+ * Implemented rset_dup.
+ *
+ * Revision 1.13  1997/12/18 10:54:24  adam
+ * New method result set method rs_hits that returns the number of
+ * hits in result-set (if known). The ranked result set returns real
+ * number of hits but only when not combined with other operands.
+ *
+ * Revision 1.12  1997/09/05 15:30:03  adam
+ * Changed prototype for chr_map_input - added const.
+ * Added support for C++, headers uses extern "C" for public definitions.
+ *
+ * Revision 1.11  1995/12/11 09:07:53  adam
+ * New rset member 'flag', that holds various flags about a result set -
+ * currently 'volatile' (set is register dependent) and 'ranked' (set is
+ * ranked).
+ * New set types sand/sor/snot. They handle and/or/not for ranked and
+ * semi-ranked result sets.
+ *
+ * Revision 1.10  1995/10/12  12:40:36  adam
+ * Private info (buf) moved from struct rset_control to struct rset.
+ * Member control in rset is statically set in rset_create.
+ *
+ * Revision 1.9  1995/10/10  14:00:01  adam
+ * Function rset_open changed its wflag parameter to general flags.
+ *
+ * Revision 1.8  1995/10/06  14:37:53  adam
  * New result set method: r_score.
  * Local no (sysno) and score is transferred to retrieveCtrl.
  *
@@ -39,51 +68,84 @@
 
 #include <stdlib.h>
 
+#ifdef __cplusplus
+extern "C" {
+#endif
 typedef void *RSFD;
 
-typedef struct rset_control
+typedef struct rset *RSET;
+typedef struct rset_term *RSET_TERM;
+
+struct rset_control
 {
     char *desc; /* text description of set type (for debugging) */
-    void *buf;  /* state data stored by subsystem */
-    struct rset_control *(*f_create)(const struct rset_control *sel, void *parms);
-    RSFD (*f_open)(struct rset_control *ct, int wflag);
+    void *(*f_create)(RSET ct, const struct rset_control *sel, void *parms);
+    RSFD (*f_open)(RSET ct, int wflag);
     void (*f_close)(RSFD rfd);
-    void (*f_delete)(struct rset_control *ct);
+    void (*f_delete)(RSET ct);
     void (*f_rewind)(RSFD rfd);
-    int (*f_count)(struct rset_control *ct);
-    int (*f_read)(RSFD rfd, void *buf);
+    int (*f_count)(RSET ct);
+    int (*f_read)(RSFD rfd, void *buf, int *term_index);
     int (*f_write)(RSFD rfd, const void *buf);
-    int (*f_score)(RSFD rfd, int *score);
-} rset_control;
+};
+
+struct rset_term {
+    char *name;
+    int  nn;
+    char *flags;
+};
 
 typedef struct rset
 {
-    rset_control *control;
-} rset, *RSET;
+    const struct rset_control *control;
+    int  flags;
+    int  count;
+    void *buf;
+    RSET_TERM *rset_terms;
+    int no_rset_terms;
+} rset;
+
+RSET_TERM rset_term_create (const char *name, int length, const char *flags);
+void rset_term_destroy (RSET_TERM t);
+RSET_TERM rset_term_dup (RSET_TERM t);
 
-RSET rset_create(const rset_control *sel, void *parms);       /* parameters? */
+#define RSETF_READ       0
+#define RSETF_WRITE      1
+
+RSET rset_create(const struct rset_control *sel, void *parms); 
+/* parameters? */
 
 /* int rset_open(RSET rs, int wflag); */
-#define rset_open(rs, wflag) ((*(rs)->control->f_open)((rs)->control, (wflag)))
+#define rset_open(rs, wflag) (*(rs)->control->f_open)((rs), (wflag))
 
 /* void rset_close(RSET rs); */
-#define rset_close(rs, rfd) ((*(rs)->control->f_close)((rfd)))
+#define rset_close(rs, rfd) (*(rs)->control->f_close)(rfd)
 
 void rset_delete(RSET rs);
 
+RSET rset_dup (RSET rs);
+
 /* void rset_rewind(RSET rs); */
-#define rset_rewind(rs, rfd) ((*(rs)->control->f_rewind)((rfd)))
+#define rset_rewind(rs, rfd) (*(rs)->control->f_rewind)((rfd))
 
 /* int rset_count(RSET rs); */
-#define rset_count(rs) ((*(rs)->control->f_count)((rs)->control))
+#define rset_count(rs) (*(rs)->control->f_count)(rs)
 
 /* int rset_read(RSET rs, void *buf); */
-#define rset_read(rs, fd, buf) ((*(rs)->control->f_read)((fd), (buf)))
+#define rset_read(rs, fd, buf, indx) (*(rs)->control->f_read)((fd), (buf), indx)
 
 /* int rset_write(RSET rs, const void *buf); */
-#define rset_write(rs, fd, buf) ((*(rs)->control->f_write)((fd), (buf)))
+#define rset_write(rs, fd, buf) (*(rs)->control->f_write)((fd), (buf))
 
-/* int rset_score(RSET rs, int *buf); */
-#define rset_score(rs, fd, score) ((*(rs)->control->f_score)((fd), (score)))
+/* int rset_type (RSET) */
+#define rset_type(rs) ((rs)->control->desc)
+
+#define RSET_FLAG_VOLATILE 1
+
+#define rset_is_volatile(rs) ((rs)->flags & RSET_FLAG_VOLATILE)
+
+#ifdef __cplusplus
+}
+#endif
 
 #endif