-/* $Id: rset.h,v 1.38 2004-10-20 14:32:28 heikki Exp $
- Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002
- Index Data Aps
+/* $Id: rset.h,v 1.51 2005-05-03 09:11:34 adam Exp $
+ Copyright (C) 1995-2005
+ Index Data ApS
This file is part of the Zebra server.
02111-1307, USA.
*/
-
-
#ifndef RSET_H
#define RSET_H
-#include <stdlib.h>
-
+#include <yaz/yaz-util.h>
/* 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" {
-#endif
+YAZ_BEGIN_CDECL
typedef struct rsfd *RSFD; /* Rset "file descriptor" */
typedef struct rset *RSET; /* Result set */
*/
struct rset_term {
+ /** the term itself */
char *name;
- int nn;
char *flags;
- int count;
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);
-
-
+ int type, NMEM nmem);
/** rsfd is a "file descriptor" for reading from a rset */
struct rsfd { /* the stuff common to all rsfd's. */
*/
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);
+ /** 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 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 {
+struct rset_key_control {
+ void *context;
int key_size;
int scope; /* default for what level we operate (book/chapter/verse) on*/
/* usual sysno/seqno is 2 */
- int (*cmp) (const void *p1, const void *p2);
+ int (*cmp)(const void *p1, const void *p2);
void (*key_logdump_txt) (int logmask, const void *p, const char *txt);
zint (*getseq)(const void *p);
- /* FIXME - Should not need a getseq, it won't make much sense with */
- /* higher-order keys. Use a (generalized) cmp instead, or something */
+ int (*filter_func)(const void *p, void *data);
+ void *filter_data;
+ void (*inc)(struct rset_key_control *kc);
+ void (*dec)(struct rset_key_control *kc);
+ /* FIXME - Should not need a getseq, it won't make much sense with */
+ /* higher-order keys. Use a (generalized) cmp instead, or something */
/* FIXME - decode and encode, and lots of other stuff */
};
typedef struct rset
{
const struct rset_control *control;
- const struct key_control *keycontrol;
+ struct rset_key_control *keycontrol;
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 */
RSFD free_list; /* all rfd's allocated but not currently in use */
+ RSFD use_list; /* all rfd's in use */
int scope; /* On what level do we count hits and compare them? */
TERMID term; /* the term thing for ranking etc */
} rset;
RSFD rfd_create_base(RSET rs);
void rfd_delete_base(RSFD rfd);
+int rfd_is_last(RSFD rfd);
RSET rset_create_base(const struct rset_control *sel,
NMEM nmem,
- const struct key_control *kcontrol,
+ struct rset_key_control *kcontrol,
int scope,
TERMID term);
#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))
+ (*(rfd)->rset->control->f_pos)((rfd),(cur),(tot))
/* int rset_read(RSFD rfd, void *buf, TERMID term); */
#define rset_read(rfd, buf, term) \
/* int rset_type (RSET) */
#define rset_type(rs) ((rs)->control->desc)
-RSET rstemp_create( NMEM nmem, const struct key_control *kcontrol,
- int scope,
- const char *temp_path);
-
-RSET rsnull_create(NMEM nmem, const struct key_control *kcontrol);
+/** rset_count counts or estimates the keys in it*/
+zint rset_count(RSET rs);
-RSET rsbool_create_and( NMEM nmem, const struct key_control *kcontrol,
- int scope,
- RSET rset_l, RSET rset_r);
+RSET rstemp_create(NMEM nmem, struct rset_key_control *kcontrol,
+ int scope, const char *temp_path, TERMID term);
-RSET rsbool_create_or ( NMEM nmem, const struct key_control *kcontrol,
- int scope,
- RSET rset_l, RSET rset_r);
+RSET rsnull_create(NMEM nmem, struct rset_key_control *kcontrol);
-RSET rsbool_create_not( NMEM nmem, const struct key_control *kcontrol,
- int scope,
- RSET rset_l, RSET rset_r);
+RSET rsbool_create_and(NMEM nmem, struct rset_key_control *kcontrol,
+ int scope, RSET rset_l, RSET rset_r);
-RSET rsbetween_create( NMEM nmem, const struct key_control *kcontrol,
- int scope,
- RSET rset_l, RSET rset_m, RSET rset_r,
- RSET rset_attr);
+RSET rsbool_create_or(NMEM nmem, struct rset_key_control *kcontrol,
+ int scope, RSET rset_l, RSET rset_r);
-RSET rsmultior_create( NMEM nmem, const struct key_control *kcontrol,
- int scope,
- int no_rsets, RSET* rsets);
+RSET rsbool_create_not(NMEM nmem, struct rset_key_control *kcontrol,
+ int scope, RSET rset_l, RSET rset_r);
-RSET rsmultiand_create( NMEM nmem, const struct key_control *kcontrol,
- int scope,
- int no_rsets, RSET* rsets);
+RSET rsbetween_create(NMEM nmem, struct rset_key_control *kcontrol,
+ int scope, RSET rset_l, RSET rset_m, RSET rset_r,
+ RSET rset_attr);
-RSET rsprox_create( NMEM nmem, const struct key_control *kcontrol,
- int scope,
- int rset_no, RSET *rset,
- int ordered, int exclusion,
- int relation, int distance);
+RSET rsmulti_or_create(NMEM nmem, struct rset_key_control *kcontrol,
+ int scope, int no_rsets, RSET* rsets);
-RSET rsisamb_create( NMEM nmem, const struct key_control *kcontrol,
- int scope,
- ISAMB is, ISAMB_P pos,
- TERMID term);
+RSET rsmulti_and_create(NMEM nmem, struct rset_key_control *kcontrol,
+ int scope, int no_rsets, RSET* rsets);
-RSET rsisamc_create( NMEM nmem, const struct key_control *kcontrol,
- int scope,
- ISAMC is, ISAMC_P pos,
- TERMID term);
+RSET rsprox_create(NMEM nmem, struct rset_key_control *kcontrol,
+ int scope, int rset_no, RSET *rset,
+ int ordered, int exclusion, int relation, int distance);
-RSET rsisams_create( NMEM nmem, const struct key_control *kcontrol,
- int scope,
- ISAMS is, ISAMS_P pos,
- TERMID term);
+RSET rsisamb_create(NMEM nmem, struct rset_key_control *kcontrol,
+ int scope, ISAMB is, ISAM_P pos, TERMID term);
+RSET rsisamc_create(NMEM nmem, struct rset_key_control *kcontrol,
+ int scope, ISAMC is, ISAM_P pos, TERMID term);
+RSET rsisams_create(NMEM nmem, struct rset_key_control *kcontrol,
+ int scope, ISAMS is, ISAM_P pos, TERMID term);
-#ifdef __cplusplus
-}
-#endif
+YAZ_END_CDECL
#endif