Cleaned up the creation of rsets, added nmem
[idzebra-moved-to-github.git] / include / rset.h
index f7029a4..2add4a1 100644 (file)
-/*
- * Copyright (C) 1994, Index Data I/S 
- * All rights reserved.
- * Sebastian Hammer, Adam Dickmeiss
- *
- * $Log: rset.h,v $
- * Revision 1.3  1994-11-22 13:15:27  quinn
- * Simple
- *
- * Revision 1.2  1994/11/04  13:21:21  quinn
- * Working.
- *
- * Revision 1.1  1994/11/03  14:13:22  quinn
- * Result set manipulation
- *
- */
+/* $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
+
+This file is part of the Zebra server.
+
+Zebra is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free
+Software Foundation; either version 2, or (at your option) any later
+version.
+
+Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+for more details.
+
+You should have received a copy of the GNU General Public License
+along with Zebra; see the file LICENSE.zebra.  If not, write to the
+Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
+02111-1307, USA.
+*/
+
+
 
 #ifndef RSET_H
 #define RSET_H
 
-typedef struct rset_control
+#include <stdlib.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+typedef void *RSFD;       /* Rset "file descriptor" */
+typedef struct rset *RSET;
+
+struct rset_control
 {
     char *desc; /* text description of set type (for debugging) */
-    char *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);
-} rset_control;
+/* 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 (*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 (*f_write)(RSFD rfd, const void *buf);
+};
+
+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);
+
 
 typedef struct rset
 {
-    int is_open;
-    rset_control *control;
-} rset, *RSET;
+    const struct rset_control *control;
+    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 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. */
 
-RSET rset_create(const rset_control *sel, void *parms);       /* parameters? */
+#define RSETF_READ       0
+#define RSETF_WRITE      1
 
-/* int rset_open(RSET rs, int wflag); */
-#define rset_open(rs, wflag) ((*(rs)->control->f_open)((rs)->control, (wflag)))
+RSET rset_create_base(const struct rset_control *sel, NMEM nmem);
 
-/* void rset_close(RSET rs); */
-#define rset_close(rs) ((*(rs)->control->f_close)((rs)->control))
+RSET rset_create_OLD(const struct rset_control *sel, void *parms); 
+/* parameters? */
 
 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_rewind(RSET rs); */
-#define rset_rewind(rs, wflag) ((*(rs)->control->f_rewind)((rs)->control))
+#define rset_rewind(rs, rfd) (*(rs)->control->f_rewind)((rfd))
+
+/* 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_count(RSET rs); */
-#define rset_count(rs, wflag) ((*(rs)->control->f_count)((rs)->control))
+/* int rset_read(RSET rs, void *buf); */
+#define rset_read(rs, fd, buf) (*(rs)->control->f_read)((fd), (buf))
 
-/* int rset_read(RSET rs, void *buf); */   /* change parameters */
-#define rset_read(rs, buf) ((*(rs)->control->f_read)((rs)->control, (buf)))
+/* int rset_write(RSET rs, const void *buf); */
+#define rset_write(rs, fd, buf) (*(rs)->control->f_write)((fd), (buf))
 
+/* int rset_type (RSET) */
+#define rset_type(rs) ((rs)->control->desc)
 
-int rset_write(RSET rs, void *buf);  /* change parameters */
+
+#ifdef __cplusplus
+}
+#endif
 
 #endif