X-Git-Url: http://git.indexdata.com/?p=idzebra-moved-to-github.git;a=blobdiff_plain;f=include%2Frset.h;h=48dfb65a4b8e1de34a924a748025acd2461236aa;hp=68acc15082fc30d0b23c66d9dbbf8b3af036e1c3;hb=7c3a0352f0492609a3b6b26b63a72b0b2d207aab;hpb=affd7e4168d70b94e015b777748b7eca1cd00ec0 diff --git a/include/rset.h b/include/rset.h index 68acc15..48dfb65 100644 --- a/include/rset.h +++ b/include/rset.h @@ -1,57 +1,202 @@ -/* - * Copyright (C) 1994, Index Data I/S - * All rights reserved. - * Sebastian Hammer, Adam Dickmeiss - * - * $Log: rset.h,v $ - * 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.34 2004-09-09 10:08:04 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 -typedef struct rset_control +#include + +/* unfortunately we need the isam includes here, for the arguments for */ +/* rsisamX_create */ +#include +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +typedef struct rsfd *RSFD; /* Rset "file descriptor" */ +typedef struct rset *RSET; /* Result set */ + +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) */ - char *buf; /* state data stored by subsystem */ - struct rset_control *(*f_create)(const struct rset_control *sel, void *parms); - int (*f_open)(struct rset_control *ct, int wflag); - void (*f_close)(struct rset_control *ct); - void (*f_delete)(struct rset_control *ct); - void (*f_rewind)(struct rset_control *ct); - int (*f_count)(struct rset_control *ct); - int (*f_read)(struct rset_control *ct, void *buf); - int (*f_write)(struct rset_control *ct, const void *buf); -} rset_control; +/* 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_rewind)(RSFD rfd); + 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 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 { - int is_open; - rset_control *control; -} rset, *RSET; - -RSET rset_create(const rset_control *sel, void *parms); /* parameters? */ + 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. */ -/* int rset_open(RSET rs, int wflag); */ -#define rset_open(rs, wflag) ((*(rs)->control->f_open)((rs)->control, (wflag))) +/* 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... */ -/* void rset_close(RSET rs); */ -#define rset_close(rs) ((*(rs)->control->f_close)((rs)->control)) +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)) -/* void rset_rewind(RSET rs); */ -#define rset_rewind(rs, wflag) ((*(rs)->control->f_rewind)((rs)->control)) +/* void rset_close(RSFD rfd); */ +#define rset_close(rfd) (*(rfd)->rset->control->f_close)(rfd) -/* int rset_count(RSET rs); */ -#define rset_count(rs, wflag) ((*(rs)->control->f_count)((rs)->control)) +/* void rset_rewind(RSFD rfd); */ +#define rset_rewind(rfd) (*(rfd)->rset->control->f_rewind)((rfd)) -int rset_read(RSET rs, void *buf); /* change parameters */ -int rset_write(RSET rs, void *buf); /* change parameters */ +/* int rset_forward(RSFD rfd, void *buf, void *untilbuf); */ +#define rset_forward(rfd, buf, untilbuf) \ + (*(rfd)->rset->control->f_forward)((rfd),(buf),(untilbuf)) + +/* int rset_pos(RSFD fd, double *current, double *total); */ +#define rset_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_write(RSFD rfd, const void *buf); */ +#define rset_write(rfd, buf) (*(rfd)->rset->control->f_write)((rfd), (buf)) + +/* 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 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_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); + +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 #endif