Changed prototype for chr_map_input - added const.

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

diff --git a/include/rset.h b/include/rset.h
index b370071..2cfb23d 100644 (file)
--- a/include/rset.h
+++ b/include/rset.h
@@ -1,10 +1,37 @@
 /*
- * Copyright (C) 1994-1995, Index Data I/S 
+ * Copyright (C) 1994-1997, Index Data I/S 
  * All rights reserved.
  * Sebastian Hammer, Adam Dickmeiss
  *
  * $Log: rset.h,v $
- * Revision 1.6  1995-09-06 16:10:58  adam
+ * 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.
+ *
+ * Revision 1.7  1995/09/07  13:58:08  adam
+ * New parameter: result-set file descriptor (RSFD) to support multiple
+ * positions within the same result-set.
+ * Boolean operators: and, or, not implemented.
+ *
+ * Revision 1.6  1995/09/06  16:10:58  adam
  * More work on boolean sets.
  *
  * Revision 1.5  1995/09/04  15:20:13  adam
@@ -30,45 +57,77 @@
 
 #include <stdlib.h>
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+typedef void *RSFD;
+
+typedef struct rset *RSET;
+
 typedef 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);
-    int (*f_open)(struct rset_control *ct, int wflag);
-    void (*f_close)(struct rset_control *ct);
-    void (*f_delete)(struct rset_control *ct);
-    void (*f_rewind)(struct rset_control *ct);
-    int (*f_count)(struct rset_control *ct);
-    int (*f_read)(struct rset_control *ct, void *buf);
-    int (*f_write)(struct rset_control *ct, const void *buf);
+    void *(*f_create)(const struct rset_control *sel, void *parms,
+                      int *flags);
+    RSFD (*f_open)(RSET ct, int wflag);
+    void (*f_close)(RSFD rfd);
+    void (*f_delete)(RSET ct);
+    void (*f_rewind)(RSFD rfd);
+    int (*f_count)(RSET ct);
+    int (*f_read)(RSFD rfd, void *buf);
+    int (*f_write)(RSFD rfd, const void *buf);
+    int (*f_score)(RSFD rfd, int *score);
 } rset_control;
 
 typedef struct rset
 {
-    rset_control *control;
-} rset, *RSET;
+    const rset_control *control;
+    int  flags;
+    void *buf;
+} rset;
+
+#define RSETF_READ       0
+#define RSETF_WRITE      1
+
+#define RSETF_SORT_SYSNO 0
+#define RSETF_SORT_RANK  2
 
 RSET rset_create(const 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) ((*(rs)->control->f_close)((rs)->control))
+#define rset_close(rs, rfd) ((*(rs)->control->f_close)((rfd)))
 
 void rset_delete(RSET rs);
 
 /* void rset_rewind(RSET rs); */
-#define rset_rewind(rs) ((*(rs)->control->f_rewind)((rs)->control))
+#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, buf) ((*(rs)->control->f_read)((rs)->control, (buf)))
+#define rset_read(rs, fd, buf) ((*(rs)->control->f_read)((fd), (buf)))
 
 /* int rset_write(RSET rs, const void *buf); */
-#define rset_write(rs, buf) ((*(rs)->control->f_write)((rs)->control, (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_FLAG_RANKED 2
+
+#define rset_is_volatile(rs) ((rs)->flags & RSET_FLAG_VOLATILE)
+#define rset_is_ranked(rs) ((rs)->flags & RSET_FLAG_RANKED)
+
+#ifdef __cplusplus
+}
+#endif
 
 #endif