X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=include%2Frset.h;h=fad81d0af2d6888b6e23e39bc9850e23c897ca74;hb=6f514a5c6e5430d6bd9cc036e0faaa4477d04410;hp=e6bef930149ee4909bd2a585dd091edf903e762b;hpb=6c836c5e8eff1e57360dd0a33197c91301277c2c;p=idzebra-moved-to-github.git diff --git a/include/rset.h b/include/rset.h index e6bef93..fad81d0 100644 --- a/include/rset.h +++ b/include/rset.h @@ -1,121 +1,206 @@ -/* - * Copyright (C) 1994-1995, Index Data I/S - * All rights reserved. - * Sebastian Hammer, Adam Dickmeiss - * - * $Log: rset.h,v $ - * Revision 1.11 1995-12-11 09:07:53 adam - * New rset member 'flag', that holds various flags about a result set - - * currently 'volatile' (set is register dependent) and 'ranked' (set is - * ranked). - * New set types sand/sor/snot. They handle and/or/not for ranked and - * semi-ranked result sets. - * - * Revision 1.10 1995/10/12 12:40:36 adam - * Private info (buf) moved from struct rset_control to struct rset. - * Member control in rset is statically set in rset_create. - * - * Revision 1.9 1995/10/10 14:00:01 adam - * Function rset_open changed its wflag parameter to general flags. - * - * Revision 1.8 1995/10/06 14:37:53 adam - * New result set method: r_score. - * Local no (sysno) and score is transferred to retrieveCtrl. - * - * Revision 1.7 1995/09/07 13:58:08 adam - * New parameter: result-set file descriptor (RSFD) to support multiple - * positions within the same result-set. - * Boolean operators: and, or, not implemented. - * - * Revision 1.6 1995/09/06 16:10:58 adam - * More work on boolean sets. - * - * Revision 1.5 1995/09/04 15:20:13 adam - * More work on temp sets. is_open member removed. - * - * Revision 1.4 1995/09/04 09:09:52 adam - * String arg in dict lookup is const. - * Minor changes. - * - * 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.35 2004-09-28 16:39:46 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 #include -typedef void *RSFD; +/* unfortunately we need the isam includes here, for the arguments for */ +/* rsisamX_create */ +#include +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif -typedef struct rset *RSET; +typedef struct rsfd *RSFD; /* Rset "file descriptor" */ +typedef struct rset *RSET; /* Result set */ -typedef struct rset_control +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 */ + RSFD next; /* to keep lists of used/free rsfd's */ +}; + + +struct rset_control { char *desc; /* text description of set type (for debugging) */ - void *(*f_create)(const struct rset_control *sel, void *parms, - int *flags); +/* RSET rs_something_create(const struct rset_control *sel, ...); */ + void (*f_delete)(RSET ct); RSFD (*f_open)(RSET ct, int wflag); void (*f_close)(RSFD rfd); - void (*f_delete)(RSET ct); void (*f_rewind)(RSFD rfd); - int (*f_count)(RSET ct); + int (*f_forward)(RSFD rfd, void *buf, 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 (*f_score)(RSFD rfd, int *score); -} rset_control; +}; + +int rset_default_forward(RSFD rfd, void *buf, + const void *untilbuf); + +struct key_control { + 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); + 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 */ + /* FIXME - decode and encode, and lots of other stuff */ +}; typedef struct rset { - const rset_control *control; - int flags; - void *buf; + const struct rset_control *control; + const struct 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 */ + int scope; /* On what level do we count hits and compare them? */ } 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. */ + +/* On the old sysno-seqno type isams, the scope was hard-coded to be 2. + * This means that we count hits on the sysno level, and when matching an + * 'and', we consider it a match if both term occur within the same sysno. + * In more complex isams we can specify on what level we wish to do the + * matching and counting of hits. For example, we can have book / chapter / + * verse, and a seqno. Scope 2 means then "give me all verses that match", + * 3 would be chapters, 4 books. + * The resolution tells how much of the occurences we need to return. If we + * are doing some sort of proximity, we need to get the seqnos of all + * 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 ); +void rset_delete(RSET rs); +RSET rset_dup (RSET rs); + #define RSETF_READ 0 #define RSETF_WRITE 1 +/* RSFD rset_open(RSET rs, int wflag); */ +#define rset_open(rs, wflag) (*(rs)->control->f_open)((rs), (wflag)) -#define RSETF_SORT_SYSNO 0 -#define RSETF_SORT_RANK 2 +/* void rset_close(RSFD rfd); */ +#define rset_close(rfd) (*(rfd)->rset->control->f_close)(rfd) -RSET rset_create(const rset_control *sel, void *parms); /* parameters? */ +/* void rset_rewind(RSFD rfd); */ +#define rset_rewind(rfd) (*(rfd)->rset->control->f_rewind)((rfd)) -/* int rset_open(RSET rs, int wflag); */ -#define rset_open(rs, wflag) ((*(rs)->control->f_open)((rs), (wflag))) +/* 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_close(RSET rs); */ -#define rset_close(rs, rfd) ((*(rs)->control->f_close)((rfd))) +/* int rset_pos(RSFD fd, double *current, double *total); */ +#define rset_pos(rfd,cur,tot) \ + (*(rfd)->rset->control->f_pos)( (rfd),(cur),(tot)) -void rset_delete(RSET rs); +/* int rset_read(RSFD rfd, void *buf); */ +#define rset_read(rfd, buf) (*(rfd)->rset->control->f_read)((rfd), (buf)) -/* void rset_rewind(RSET rs); */ -#define rset_rewind(rs, rfd) ((*(rs)->control->f_rewind)((rfd))) +/* int rset_write(RSFD rfd, const void *buf); */ +#define rset_write(rfd, buf) (*(rfd)->rset->control->f_write)((rfd), (buf)) -/* int rset_count(RSET rs); */ -#define rset_count(rs) ((*(rs)->control->f_count)(rs)) +/* int rset_type (RSET) */ +#define rset_type(rs) ((rs)->control->desc) -/* int rset_read(RSET rs, void *buf); */ -#define rset_read(rs, fd, buf) ((*(rs)->control->f_read)((fd), (buf))) +RSET rstemp_create( NMEM nmem, const struct key_control *kcontrol, + int scope, + const char *temp_path); -/* int rset_write(RSET rs, const void *buf); */ -#define rset_write(rs, fd, buf) ((*(rs)->control->f_write)((fd), (buf))) +RSET rsnull_create(NMEM nmem, const struct key_control *kcontrol); -/* int rset_score(RSET rs, int *buf); */ -#define rset_score(rs, fd, score) ((*(rs)->control->f_score)((fd), (score))) +RSET rsbool_create_and( NMEM nmem, const struct key_control *kcontrol, + int scope, + RSET rset_l, RSET rset_r); -/* int rset_type (RSET) */ -#define rset_type(rs) ((rs)->control->desc) +RSET rsbool_create_or ( 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 rsbetween_create( NMEM nmem, const struct key_control *kcontrol, + int scope, + RSET rset_l, RSET rset_m, RSET rset_r, + RSET rset_attr); + +RSET rsmultior_create( NMEM nmem, const struct key_control *kcontrol, + int scope, + int no_rsets, RSET* rsets); -#define RSET_FLAG_VOLATILE 1 -#define RSET_FLAG_RANKED 2 +RSET rsmultiand_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 rsisamb_create( NMEM nmem, const struct key_control *kcontrol, + int scope, + ISAMB is, ISAMB_P pos); + +RSET rsisamc_create( NMEM nmem, const struct key_control *kcontrol, + int scope, + ISAMC is, ISAMC_P pos); + +RSET rsisams_create( NMEM nmem, const struct key_control *kcontrol, + int scope, + ISAMS is, ISAMS_P pos); + + + +#ifdef __cplusplus +} +#endif -#define rset_is_volatile(rs) ((rs)->flags & RSET_FLAG_VOLATILE) -#define rset_is_ranked(rs) ((rs)->flags & RSET_FLAG_RANKED) #endif