include/rset.h

   1 /* $Id: rset.h,v 1.51 2005-05-03 09:11:34 adam Exp $
   2    Copyright (C) 1995-2005
   3    Index Data ApS
   4
   5 This file is part of the Zebra server.
   6
   7 Zebra is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 2, or (at your option) any later
  10 version.
  11
  12 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with Zebra; see the file LICENSE.zebra.  If not, write to the
  19 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  20 02111-1307, USA.
  21 */
  22
  23 #ifndef RSET_H
  24 #define RSET_H
  25
  26 #include <yaz/yaz-util.h>
  27 /* unfortunately we need the isam includes here, for the arguments for */
  28 /* rsisamX_create */
  29 #include <idzebra/isamb.h>
  30 #include <idzebra/isamc.h>
  31 #include <idzebra/isams.h>
  32
  33 YAZ_BEGIN_CDECL
  34
  35 typedef struct rsfd *RSFD; /* Rset "file descriptor" */
  36 typedef struct rset *RSET; /* Result set */
  37
  38
  39 /**
  40  * rset_term is all we need to know of a term to do ranking etc.
  41  * As far as the rsets are concerned, it is just a dummy pointer to
  42  * be passed around.
  43  */
  44
  45 struct rset_term {
  46     /** the term itself */
  47     char *name;
  48     char *flags;
  49     int  type;
  50     /** the rset corresponding to this term */
  51     RSET rset;
  52     /** private stuff for the ranking algorithm */
  53     void *rankpriv;
  54 };
  55
  56 typedef struct rset_term *TERMID;
  57 TERMID rset_term_create (const char *name, int length, const char *flags,
  58                          int type, NMEM nmem);
  59
  60 /** rsfd is a "file descriptor" for reading from a rset */
  61 struct rsfd {  /* the stuff common to all rsfd's. */
  62     RSET rset;  /* ptr to the rset this FD is opened to */
  63     void *priv; /* private parameters for this type */
  64     RSFD next;  /* to keep lists of used/free rsfd's */
  65 };
  66
  67
  68 /**
  69  * rset_control has function pointers to all the important functions
  70  * of a rset. Each type of rset will have its own control block, pointing
  71  * to the functions for that type. They all have their own create function
  72  * which is not part of the control block, as it takes different args for
  73  * each type.
  74  */
  75 struct rset_control
  76 {
  77     /** text description of set type (for debugging) */
  78     char *desc;
  79 /* RSET rs_something_create(const struct rset_control *sel, ...); */
  80     void (*f_delete)(RSET ct);
  81
  82     /** recursively fills the terms array with terms. call with curterm=0 */
  83     /* always counts them all into cur, but of course won't touch the term */
  84     /* array past max. You can use this to count, set max=0 */
  85     void (*f_getterms)(RSET ct, TERMID *terms, int maxterms, int *curterm);
  86
  87     RSFD (*f_open)(RSET ct, int wflag);
  88     void (*f_close)(RSFD rfd);
  89     /** forward behaves like a read, but it skips some items first */
  90     int (*f_forward)(RSFD rfd, void *buf, TERMID *term, const void *untilbuf);
  91     void (*f_pos)(RSFD rfd, double *current, double *total);
  92        /* returns -1,-1 if pos function not implemented for this type */
  93     int (*f_read)(RSFD rfd, void *buf, TERMID *term);
  94     int (*f_write)(RSFD rfd, const void *buf);
  95 };
  96
  97 /** rset_default_forward implements a generic forward with a read-loop */
  98 int rset_default_forward(RSFD rfd, void *buf, TERMID *term,
  99                      const void *untilbuf);
 100
 101 /** rset_get_no_terms is a getterms function for those that don't have any */
 102 void rset_get_no_terms(RSET ct, TERMID *terms, int maxterms, int *curterm);
 103
 104 /**
 105  * rset_get_one_term is a getterms function for those rsets that have
 106  * exactly one term, like all rsisamX types.
 107  */
 108 void rset_get_one_term(RSET ct,TERMID *terms,int maxterms,int *curterm);
 109
 110 /**
 111  * key_control contains all there is to know about the keys stored in
 112  * an isam, and therefore operated by the rsets. Other than this info,
 113  * all we assume is that all keys are the same size, and they can be
 114  * memcpy'd around
 115  */
 116 struct rset_key_control {
 117     void *context;
 118     int key_size;
 119     int scope;  /* default for what level we operate (book/chapter/verse) on*/
 120                 /* usual sysno/seqno is 2 */
 121     int (*cmp)(const void *p1, const void *p2);
 122     void (*key_logdump_txt) (int logmask, const void *p, const char *txt);
 123     zint (*getseq)(const void *p);
 124     int (*filter_func)(const void *p, void *data);
 125     void *filter_data;
 126     void (*inc)(struct rset_key_control *kc);
 127     void (*dec)(struct rset_key_control *kc);
 128     /* FIXME - Should not need a getseq, it won't make much sense with */
 129     /* higher-order keys. Use a (generalized) cmp instead, or something */
 130     /* FIXME - decode and encode, and lots of other stuff */
 131 };
 132
 133 /**
 134  * A rset is an ordered sequence of keys, either directly from an underlaying
 135  * isam, or from one of the higher-level operator rsets (and, or, ...).
 136  * Actually, it is "virtual base class", no pure rsets exist in the system,
 137  * they all are of some derived type.
 138  */
 139 typedef struct rset
 140 {
 141     const struct rset_control *control;
 142     struct rset_key_control *keycontrol;
 143     int  count;  /* reference count */
 144     void *priv;  /* stuff private to the given type of rset */
 145     NMEM nmem;    /* nibble memory for various allocs */
 146     char my_nmem; /* Should the nmem be destroyed with the rset?  */
 147                   /* 1 if created with it, 0 if passed from above */
 148     RSFD free_list; /* all rfd's allocated but not currently in use */
 149     RSFD use_list;  /* all rfd's in use */
 150     int scope;    /* On what level do we count hits and compare them? */
 151     TERMID term; /* the term thing for ranking etc */
 152 } rset;
 153 /* rset is a "virtual base class", which will never exist on its own
 154  * all instances are rsets of some specific type, like rsisamb, or rsbool
 155  * They keep their own stuff behind the priv pointer.  */
 156
 157 /* On the old sysno-seqno type isams, the scope was hard-coded to be 2.
 158  * This means that we count hits on the sysno level, and when matching an
 159  * 'and', we consider it a match if both term occur within the same sysno.
 160  * In more complex isams we can specify on what level we wish to do the
 161  * matching and counting of hits. For example, we can have book / chapter /
 162  * verse, and a seqno. Scope 2 means then "give me all verses that match",
 163  * 3 would be chapters, 4 books.
 164  * The resolution tells how much of the occurences we need to return. If we
 165  * are doing some sort of proximity, we need to get the seqnos of all
 166  * occurences, whereas if we are only counting hits, we do not need anything
 167  * below the scope. Again 1 is seqnos, 2 sysnos (or verses), 3 books, etc.
 168  */
 169
 170 RSFD rfd_create_base(RSET rs);
 171 void rfd_delete_base(RSFD rfd);
 172 int rfd_is_last(RSFD rfd);
 173
 174 RSET rset_create_base(const struct rset_control *sel,
 175                       NMEM nmem,
 176                       struct rset_key_control *kcontrol,
 177                       int scope,
 178                       TERMID term);
 179
 180 void rset_delete(RSET rs);
 181 RSET rset_dup (RSET rs);
 182
 183
 184 #define RSETF_READ       0
 185 #define RSETF_WRITE      1
 186 /* RSFD rset_open(RSET rs, int wflag); */
 187 #define rset_open(rs, wflag) (*(rs)->control->f_open)((rs), (wflag))
 188
 189 /* void rset_close(RSFD rfd); */
 190 #define rset_close(rfd) (*(rfd)->rset->control->f_close)(rfd)
 191
 192 /* int rset_forward(RSFD rfd, void *buf, TERMID term, void *untilbuf); */
 193 #define rset_forward(rfd, buf, term, untilbuf) \
 194     (*(rfd)->rset->control->f_forward)((rfd),(buf),(term),(untilbuf))
 195
 196 /* void rset_getterms(RSET ct, TERMID *terms, int maxterms, int *curterm); */
 197 #define rset_getterms(ct, terms, maxterms, curterm) \
 198     (*(ct)->control->f_getterms)((ct),(terms),(maxterms),(curterm))
 199
 200 /* int rset_pos(RSFD fd, double *current, double *total); */
 201 #define rset_pos(rfd,cur,tot) \
 202     (*(rfd)->rset->control->f_pos)((rfd),(cur),(tot))
 203
 204 /* int rset_read(RSFD rfd, void *buf, TERMID term); */
 205 #define rset_read(rfd, buf, term) \
 206     (*(rfd)->rset->control->f_read)((rfd), (buf), (term))
 207
 208 /* int rset_write(RSFD rfd, const void *buf); */
 209 #define rset_write(rfd, buf) (*(rfd)->rset->control->f_write)((rfd), (buf))
 210
 211 /* int rset_type (RSET) */
 212 #define rset_type(rs) ((rs)->control->desc)
 213
 214 /** rset_count counts or estimates the keys in it*/
 215 zint rset_count(RSET rs);
 216
 217 RSET rstemp_create(NMEM nmem, struct rset_key_control *kcontrol,
 218                     int scope, const char *temp_path, TERMID term);
 219
 220 RSET rsnull_create(NMEM nmem, struct rset_key_control *kcontrol);
 221
 222 RSET rsbool_create_and(NMEM nmem, struct rset_key_control *kcontrol,
 223                        int scope, RSET rset_l, RSET rset_r);
 224
 225 RSET rsbool_create_or(NMEM nmem, struct rset_key_control *kcontrol,
 226                       int scope, RSET rset_l, RSET rset_r);
 227
 228 RSET rsbool_create_not(NMEM nmem, struct rset_key_control *kcontrol,
 229                        int scope, RSET rset_l, RSET rset_r);
 230
 231 RSET rsbetween_create(NMEM nmem, struct rset_key_control *kcontrol,
 232                       int scope, RSET rset_l, RSET rset_m, RSET rset_r,
 233                       RSET rset_attr);
 234
 235 RSET rsmulti_or_create(NMEM nmem, struct rset_key_control *kcontrol,
 236                        int scope, int no_rsets, RSET* rsets);
 237
 238 RSET rsmulti_and_create(NMEM nmem, struct rset_key_control *kcontrol,
 239                         int scope, int no_rsets, RSET* rsets);
 240
 241 RSET rsprox_create(NMEM nmem, struct rset_key_control *kcontrol,
 242                    int scope, int rset_no, RSET *rset,
 243                    int ordered, int exclusion, int relation, int distance);
 244
 245 RSET rsisamb_create(NMEM nmem, struct rset_key_control *kcontrol,
 246                     int scope, ISAMB is, ISAM_P pos, TERMID term);
 247
 248 RSET rsisamc_create(NMEM nmem, struct rset_key_control *kcontrol,
 249                     int scope, ISAMC is, ISAM_P pos, TERMID term);
 250
 251 RSET rsisams_create(NMEM nmem, struct rset_key_control *kcontrol,
 252                     int scope, ISAMS is, ISAM_P pos, TERMID term);
 253
 254 YAZ_END_CDECL
 255
 256 #endif