-/* $Id: rset.h,v 1.36 2004-09-30 13:07:06 heikki Exp $
+/* $Id: rset.h,v 1.43 2004-12-08 14:02:36 adam Exp $
Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002
Index Data Aps
/* unfortunately we need the isam includes here, for the arguments for */
/* rsisamX_create */
-#include <isamb.h>
-#include <isamc.h>
-#include <isams.h>
+#include <idzebra/isamb.h>
+#include <idzebra/isamc.h>
+#include <idzebra/isams.h>
#ifdef __cplusplus
extern "C" {
typedef struct rsfd *RSFD; /* Rset "file descriptor" */
typedef struct rset *RSET; /* Result set */
+
+/**
+ * rset_term is all we need to know of a term to do ranking etc.
+ * As far as the rsets are concerned, it is just a dummy pointer to
+ * be passed around.
+ */
+
+struct rset_term {
+ /** the term itself */
+ char *name;
+ char *flags;
+ int type;
+ /** the rset corresponding to this term */
+ RSET rset;
+ /** private stuff for the ranking algorithm */
+ void *rankpriv;
+};
+
+typedef struct rset_term *TERMID;
+TERMID rset_term_create (const char *name, int length, const char *flags,
+ int type, NMEM nmem);
+
+
+
+/** rsfd is a "file descriptor" for reading from a rset */
struct rsfd { /* the stuff common to all rsfd's. */
RSET rset; /* ptr to the rset this FD is opened to */
void *priv; /* private parameters for this type */
};
+/**
+ * rset_control has function pointers to all the important functions
+ * of a rset. Each type of rset will have its own control block, pointing
+ * to the functions for that type. They all have their own create function
+ * which is not part of the control block, as it takes different args for
+ * each type.
+ */
struct rset_control
{
- char *desc; /* text description of set type (for debugging) */
+ /** text description of set type (for debugging) */
+ char *desc;
/* RSET rs_something_create(const struct rset_control *sel, ...); */
void (*f_delete)(RSET ct);
+
+ /** recursively fills the terms array with terms. call with curterm=0 */
+ /* always counts them all into cur, but of course won't touch the term */
+ /* array past max. You can use this to count, set max=0 */
+ void (*f_getterms)(RSET ct, TERMID *terms, int maxterms, int *curterm);
+
RSFD (*f_open)(RSET ct, int wflag);
void (*f_close)(RSFD rfd);
- int (*f_forward)(RSFD rfd, void *buf, const void *untilbuf);
+ /** forward behaves like a read, but it skips some items first */
+ int (*f_forward)(RSFD rfd, void *buf, TERMID *term, 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_read)(RSFD rfd, void *buf, TERMID *term);
int (*f_write)(RSFD rfd, const void *buf);
};
-int rset_default_forward(RSFD rfd, void *buf,
+/** rset_default_forward implements a generic forward with a read-loop */
+int rset_default_forward(RSFD rfd, void *buf, TERMID *term,
const void *untilbuf);
+/** rset_get_no_terms is a getterms function for those that don't have any */
+void rset_get_no_terms(RSET ct, TERMID *terms, int maxterms, int *curterm);
+
+/**
+ * rset_get_one_term is a getterms function for those rsets that have
+ * exactly one term, like all rsisamX types.
+ */
+void rset_get_one_term(RSET ct,TERMID *terms,int maxterms,int *curterm);
+
+/**
+ * key_control contains all there is to know about the keys stored in
+ * an isam, and therefore operated by the rsets. Other than this info,
+ * all we assume is that all keys are the same size, and they can be
+ * memcpy'd around
+ */
struct key_control {
int key_size;
int scope; /* default for what level we operate (book/chapter/verse) on*/
/* FIXME - decode and encode, and lots of other stuff */
};
+/**
+ * A rset is an ordered sequence of keys, either directly from an underlaying
+ * isam, or from one of the higher-level operator rsets (and, or, ...).
+ * Actually, it is "virtual base class", no pure rsets exist in the system,
+ * they all are of some derived type.
+ */
typedef struct rset
{
const struct rset_control *control;
/* 1 if created with it, 0 if passed from above */
RSFD free_list; /* all rfd's allocated but not currently in use */
int scope; /* On what level do we count hits and compare them? */
+ TERMID term; /* the term thing for ranking etc */
} 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
* occurences, whereas if we are only counting hits, we do not need anything
* below the scope. Again 1 is seqnos, 2 sysnos (or verses), 3 books, etc.
*/
-/* FIXME - Add a resolution, to decide on what level we want to return */
-/* hits. That can well be below scope, if we need to get seqnos for prox */
-/* or suchlike... */
RSFD rfd_create_base(RSET rs);
void rfd_delete_base(RSFD rfd);
RSET rset_create_base(const struct rset_control *sel,
NMEM nmem,
const struct key_control *kcontrol,
- int scope );
+ int scope,
+ TERMID term);
+
void rset_delete(RSET rs);
RSET rset_dup (RSET rs);
/* void rset_close(RSFD rfd); */
#define rset_close(rfd) (*(rfd)->rset->control->f_close)(rfd)
-/* int rset_forward(RSFD rfd, void *buf, void *untilbuf); */
-#define rset_forward(rfd, buf, untilbuf) \
- (*(rfd)->rset->control->f_forward)((rfd),(buf),(untilbuf))
+/* int rset_forward(RSFD rfd, void *buf, TERMID term, void *untilbuf); */
+#define rset_forward(rfd, buf, term, untilbuf) \
+ (*(rfd)->rset->control->f_forward)((rfd),(buf),(term),(untilbuf))
+
+/* void rset_getterms(RSET ct, TERMID *terms, int maxterms, int *curterm); */
+#define rset_getterms(ct, terms, maxterms, curterm) \
+ (*(ct)->control->f_getterms)((ct),(terms),(maxterms),(curterm))
/* int rset_pos(RSFD fd, double *current, double *total); */
#define rset_pos(rfd,cur,tot) \
(*(rfd)->rset->control->f_pos)( (rfd),(cur),(tot))
-/* int rset_read(RSFD rfd, void *buf); */
-#define rset_read(rfd, buf) (*(rfd)->rset->control->f_read)((rfd), (buf))
+/* int rset_read(RSFD rfd, void *buf, TERMID term); */
+#define rset_read(rfd, buf, term) \
+ (*(rfd)->rset->control->f_read)((rfd), (buf), (term))
/* int rset_write(RSFD rfd, const void *buf); */
#define rset_write(rfd, buf) (*(rfd)->rset->control->f_write)((rfd), (buf))
/* int rset_type (RSET) */
#define rset_type(rs) ((rs)->control->desc)
+/** rset_count counts or estimates the keys in it*/
+zint rset_count(RSET rs);
+
RSET rstemp_create( NMEM nmem, const struct key_control *kcontrol,
int scope,
- const char *temp_path);
+ const char *temp_path, TERMID term);
RSET rsnull_create(NMEM nmem, const struct key_control *kcontrol);
RSET rsisamb_create( NMEM nmem, const struct key_control *kcontrol,
int scope,
- ISAMB is, ISAMB_P pos);
+ ISAMB is, ISAMB_P pos,
+ TERMID term);
RSET rsisamc_create( NMEM nmem, const struct key_control *kcontrol,
int scope,
- ISAMC is, ISAMC_P pos);
+ ISAMC is, ISAMC_P pos,
+ TERMID term);
RSET rsisams_create( NMEM nmem, const struct key_control *kcontrol,
int scope,
- ISAMS is, ISAMS_P pos);
+ ISAMS is, ISAMS_P pos,
+ TERMID term);
projects / idzebra-moved-to-github.git / blobdiff