Cleaned up the creation of rsets, added nmem
[idzebra-moved-to-github.git] / include / rset.h
index e83870b..2add4a1 100644 (file)
@@ -1,4 +1,4 @@
-/* $Id: rset.h,v 1.28 2004-08-06 12:55:01 adam Exp $
+/* $Id: rset.h,v 1.31 2004-08-24 14:25:15 heikki Exp $
    Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002
    Index Data Aps
 
@@ -30,85 +30,78 @@ Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 #ifdef __cplusplus
 extern "C" {
 #endif
-typedef void *RSFD;
 
+typedef void *RSFD;       /* Rset "file descriptor" */
 typedef struct rset *RSET;
-typedef struct rset_term *RSET_TERM;
 
 struct rset_control
 {
     char *desc; /* text description of set type (for debugging) */
-    void *(*f_create)(RSET ct, const struct rset_control *sel, void *parms);
+/* 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)(RSET ct);
     void (*f_rewind)(RSFD rfd);
-    int (*f_forward)(RSET ct, RSFD rfd, void *buf,  int *term_index,
+    int (*f_forward)(RSET ct, RSFD rfd, void *buf,
                      int (*cmpfunc)(const void *p1, const void *p2), 
                      const void *untilbuf);
     void (*f_pos)(RSFD rfd, double *current, double *total);
        /* returns -1,-1 if pos function not implemented for this type */
-    int (*f_read)(RSFD rfd, void *buf, int *term_index);
+    int (*f_read)(RSFD rfd, void *buf);
     int (*f_write)(RSFD rfd, const void *buf);
 };
 
-int rset_default_forward(RSET ct, RSFD rfd, void *buf, int *term_index, 
+int rset_default_forward(RSET ct, RSFD rfd, void *buf, 
                      int (*cmpfunc)(const void *p1, const void *p2), 
                      const void *untilbuf);
 void rset_default_pos(RSFD rfd, double *current, double *total);
 
-struct rset_term {
-    char *name;
-    zint nn;
-    char *flags;
-    zint count;
-    int  type;
-};
 
 typedef struct rset
 {
     const struct rset_control *control;
-    int  flags;
-    int  count;
-    void *buf;
-    RSET_TERM *rset_terms;
-    int no_rset_terms;
+    int  count;  /* reference count */
+    void *priv;  /* stuff private to the given type of rset */
+    NMEM nmem;    /* nibble memory for various allocs */
+    char my_nmem; /* Should the nmem be destroyed with the rset?  */
+                  /* 1 if created with it, 0 if passed from above */
 } rset;
-
-RSET_TERM rset_term_create (const char *name, int length, const char *flags,
-                            int type);
-void rset_term_destroy (RSET_TERM t);
-RSET_TERM rset_term_dup (RSET_TERM t);
+/* rset is a "virtual base class", which will never exist on its own */
+/* all instances are rsets of some specific type, like rsisamb, or rsbool */
+/* They keep their own stuff behind the priv pointer. */
 
 #define RSETF_READ       0
 #define RSETF_WRITE      1
 
-RSET rset_create(const struct rset_control *sel, void *parms); 
+RSET rset_create_base(const struct rset_control *sel, NMEM nmem);
+
+RSET rset_create_OLD(const struct rset_control *sel, void *parms); 
 /* parameters? */
 
-/* int rset_open(RSET rs, int wflag); */
+void rset_delete(RSET rs);
+
+RSET rset_dup (RSET rs);
+
+
+/* RSFD rset_open(RSET rs, int 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)
 
-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))
 
-/* int rset_forward(RSET rs, void *buf, int *indx, void *untilbuf); */
-#define rset_forward(rs, fd, buf, indx, cmpfunc, untilbuf) \
-    (*(rs)->control->f_forward)((rs), (fd), (buf), (indx), (cmpfunc), (untilbuf))
+/* int rset_forward(RSET rs, void *buf, void *untilbuf); */
+#define rset_forward(rs, fd, buf, cmpfunc, untilbuf) \
+    (*(rs)->control->f_forward)((rs), (fd), (buf), (cmpfunc), (untilbuf))
 
 /* int rset_pos(RSET rs, RSFD fd, double *current, double *total); */
 #define rset_pos(rs,fd,cur,tot) \
     (*(rs)->control->f_pos)( (fd),(cur),(tot))
 
-/* int rset_read(RSET rs, void *buf, int *indx); */
-#define rset_read(rs, fd, buf, indx) (*(rs)->control->f_read)((fd), (buf), indx)
+/* int rset_read(RSET rs, void *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, fd, buf) (*(rs)->control->f_write)((fd), (buf))
@@ -116,9 +109,6 @@ RSET rset_dup (RSET rs);
 /* 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
 }