X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=include%2Frset.h;h=f9ea485ecde6a0c0f49e15e8b352ac78ae6b8573;hb=2ca7b6bfd7e8d9a2cb9c36bf2520b46511a594eb;hp=ae1dd371d24f8eb2601665dbb882631e5532bb9c;hpb=0229bb1ac74706a4e460a11a8a8712b4ea0f2ebe;p=idzebra-moved-to-github.git diff --git a/include/rset.h b/include/rset.h index ae1dd37..f9ea485 100644 --- a/include/rset.h +++ b/include/rset.h @@ -1,6 +1,6 @@ -/* $Id: rset.h,v 1.37 2004-10-15 10:07:32 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. @@ -20,34 +20,44 @@ Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ - - #ifndef RSET_H #define RSET_H -#include - +#include /* unfortunately we need the isam includes here, for the arguments for */ /* rsisamX_create */ -#include -#include -#include +#include +#include +#include -#ifdef __cplusplus -extern "C" { -#endif +YAZ_BEGIN_CDECL typedef struct rsfd *RSFD; /* Rset "file descriptor" */ typedef struct rset *RSET; /* Result set */ -/* -typedef struct terminfo *TERMID; -*/ -typedef int TERMID; - /* term thing for the rsets. They don't need to */ - /* know what it is. FIXME - define that somewhere */ -/* using int while testing, to get more type checking to work */ +/** + * 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 */ @@ -55,13 +65,28 @@ struct rsfd { /* the stuff common to all rsfd's. */ }; +/** + * 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); + /** 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 */ @@ -69,31 +94,59 @@ struct rset_control int (*f_write)(RSFD rfd, const 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); -struct key_control { +/** 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 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 */ }; +/** + * 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; - 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; @@ -116,10 +169,11 @@ typedef struct 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); @@ -139,9 +193,13 @@ RSET rset_dup (RSET rs); #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) \ @@ -153,62 +211,46 @@ RSET rset_dup (RSET rs); /* 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_count counts or estimates the keys in it*/ +zint rset_count(RSET rs); -RSET rsnull_create(NMEM nmem, const struct key_control *kcontrol); +RSET rstemp_create(NMEM nmem, struct rset_key_control *kcontrol, + int scope, const char *temp_path, TERMID term); -RSET rsbool_create_and( 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_or ( 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 rsbool_create_not( NMEM nmem, const struct key_control *kcontrol, - int scope, - RSET rset_l, RSET rset_r); +RSET rsbool_create_or(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_not(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 rsbetween_create(NMEM nmem, struct rset_key_control *kcontrol, + int scope, RSET rset_l, RSET rset_m, RSET rset_r, + RSET rset_attr); -RSET rsmultiand_create( NMEM nmem, const struct key_control *kcontrol, - int scope, - int no_rsets, RSET* rsets); +RSET rsmulti_or_create(NMEM nmem, struct rset_key_control *kcontrol, + int scope, int no_rsets, RSET* rsets); -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_and_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 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 rsisamc_create( NMEM nmem, const struct key_control *kcontrol, - int scope, - ISAMC is, ISAMC_P pos, - TERMID term); +RSET rsisamb_create(NMEM nmem, struct rset_key_control *kcontrol, + int scope, ISAMB is, ISAM_P pos, TERMID term); -RSET rsisams_create( NMEM nmem, const struct key_control *kcontrol, - int scope, - ISAMS is, ISAMS_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