X-Git-Url: http://git.indexdata.com/?p=idzebra-moved-to-github.git;a=blobdiff_plain;f=include%2Frset.h;h=0352a1c09b9c2db836ea11e9c740405897bcb27b;hp=fad81d0af2d6888b6e23e39bc9850e23c897ca74;hb=8add234f71c852fd95ca3aef168e3563265c93b9;hpb=6f514a5c6e5430d6bd9cc036e0faaa4477d04410 diff --git a/include/rset.h b/include/rset.h index fad81d0..0352a1c 100644 --- a/include/rset.h +++ b/include/rset.h @@ -1,6 +1,6 @@ -/* $Id: rset.h,v 1.35 2004-09-28 16:39:46 heikki Exp $ - Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002 - Index Data Aps +/* $Id: rset.h,v 1.46 2005-01-16 23:14:56 adam Exp $ + Copyright (C) 1995-2005 + Index Data ApS This file is part of the Zebra server. @@ -20,26 +20,45 @@ Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ - - #ifndef RSET_H #define RSET_H -#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 */ + +/** + * 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 */ @@ -47,24 +66,54 @@ 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); - void (*f_rewind)(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*/ @@ -77,6 +126,12 @@ struct key_control { /* 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; @@ -88,6 +143,7 @@ typedef struct rset /* 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 @@ -105,9 +161,6 @@ typedef struct rset * 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); @@ -115,7 +168,9 @@ 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); @@ -128,19 +183,21 @@ RSET rset_dup (RSET rs); /* void rset_close(RSFD rfd); */ #define rset_close(rfd) (*(rfd)->rset->control->f_close)(rfd) -/* void rset_rewind(RSFD rfd); */ -#define rset_rewind(rfd) (*(rfd)->rset->control->f_rewind)((rfd)) +/* 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)) -/* int rset_forward(RSFD rfd, void *buf, void *untilbuf); */ -#define rset_forward(rfd, buf, untilbuf) \ - (*(rfd)->rset->control->f_forward)((rfd),(buf),(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); */ -#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)) @@ -148,59 +205,48 @@ 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, +/** 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 rsbool_create_and( NMEM nmem, const struct key_control *kcontrol, - int scope, - RSET rset_l, RSET rset_r); - -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, const struct 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, const struct 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, const struct 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, const struct 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, const struct 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, const struct 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); +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 rsisamc_create( NMEM nmem, const struct key_control *kcontrol, - int scope, - ISAMC is, ISAMC_P pos); +RSET rsisamb_create(NMEM nmem, const struct key_control *kcontrol, + int scope, ISAMB is, ISAMB_P pos, TERMID term); -RSET rsisams_create( NMEM nmem, const struct key_control *kcontrol, - int scope, - ISAMS is, ISAMS_P pos); +RSET rsisamc_create(NMEM nmem, const struct key_control *kcontrol, + int scope, ISAMC is, ISAMC_P pos, TERMID term); +RSET rsisams_create(NMEM nmem, const struct key_control *kcontrol, + int scope, ISAMS is, ISAMS_P pos, TERMID term); -#ifdef __cplusplus -} -#endif +YAZ_END_CDECL #endif