1 /* $Id: rset.h,v 1.56 2005-06-07 14:53:38 adam Exp $
2 Copyright (C) 1995-2005
5 This file is part of the Zebra server.
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
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
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
26 #include <yaz/yaz-util.h>
27 /* unfortunately we need the isam includes here, for the arguments for */
29 #include <idzebra/isamb.h>
30 #include <idzebra/isamc.h>
31 #include <idzebra/isams.h>
35 typedef struct rsfd *RSFD;
36 typedef struct rset *RSET;
40 struct ord_list *next;
43 struct ord_list *ord_list_create(NMEM nmem);
44 struct ord_list *ord_list_append(NMEM nmem, struct ord_list *list, int ord);
45 struct ord_list *ord_list_dup(NMEM nmem, struct ord_list *list);
48 * rset_term is all we need to know of a term to do ranking etc.
49 * As far as the rsets are concerned, it is just a dummy pointer to
53 char *name; /** the term itself in internal encoding (UTF-8/raw) */
54 char *flags; /** flags for rank method */
55 int type; /** Term_type from RPN Query. Actually this
56 is Z_Term_general, Z_Term_numeric,
57 Z_Term_characterString, ..
58 This info is used to return encoded term back for
61 int reg_type; /** register type */
62 RSET rset; /** the rset corresponding to this term */
63 void *rankpriv;/** private stuff for the ranking algorithm */
67 typedef struct rset_term *TERMID;
68 TERMID rset_term_create (const char *name, int length, const char *flags,
69 int type, NMEM nmem, struct ord_list *ol,
72 /** rsfd is a "file descriptor" for reading from a rset */
73 struct rsfd { /* the stuff common to all rsfd's. */
74 RSET rset; /* ptr to the rset this FD is opened to */
75 void *priv; /* private parameters for this type */
76 RSFD next; /* to keep lists of used/free rsfd's */
83 * rset_control has function pointers to all the important functions
84 * of a rset. Each type of rset will have its own control block, pointing
85 * to the functions for that type. They all have their own create function
86 * which is not part of the control block, as it takes different args for
91 /** text description of set type (for debugging) */
93 /* RSET rs_something_create(const struct rset_control *sel, ...); */
94 void (*f_delete)(RSET ct);
96 /** recursively fills the terms array with terms. call with curterm=0 */
97 /* always counts them all into cur, but of course won't touch the term */
98 /* array past max. You can use this to count, set max=0 */
99 void (*f_getterms)(RSET ct, TERMID *terms, int maxterms, int *curterm);
101 RSFD (*f_open)(RSET ct, int wflag);
102 void (*f_close)(RSFD rfd);
103 /** forward behaves like a read, but it skips some items first */
104 int (*f_forward)(RSFD rfd, void *buf, TERMID *term, const void *untilbuf);
105 void (*f_pos)(RSFD rfd, double *current, double *total);
106 /* returns -1,-1 if pos function not implemented for this type */
107 int (*f_read)(RSFD rfd, void *buf, TERMID *term);
108 int (*f_write)(RSFD rfd, const void *buf);
111 /** rset_default_forward implements a generic forward with a read-loop */
112 int rset_default_forward(RSFD rfd, void *buf, TERMID *term,
113 const void *untilbuf);
115 /** rset_default_read implements a generic read */
116 int rset_default_read(RSFD rfd, void *buf, TERMID *term);
118 void rset_get_one_term(RSET ct,TERMID *terms,int maxterms,int *curterm);
121 * key_control contains all there is to know about the keys stored in
122 * an isam, and therefore operated by the rsets. Other than this info,
123 * all we assume is that all keys are the same size, and they can be
126 struct rset_key_control {
129 int scope; /* default for what level we operate (book/chapter/verse) on*/
130 /* usual sysno/seqno is 2 */
131 int (*cmp)(const void *p1, const void *p2);
132 void (*key_logdump_txt) (int logmask, const void *p, const char *txt);
133 zint (*getseq)(const void *p);
134 int (*filter_func)(const void *p, void *data);
136 void (*inc)(struct rset_key_control *kc);
137 void (*dec)(struct rset_key_control *kc);
138 /* FIXME - Should not need a getseq, it won't make much sense with */
139 /* higher-order keys. Use a (generalized) cmp instead, or something */
140 /* FIXME - decode and encode, and lots of other stuff */
144 * A rset is an ordered sequence of keys, either directly from an underlaying
145 * isam, or from one of the higher-level operator rsets (and, or, ...).
146 * Actually, it is "virtual base class", no pure rsets exist in the system,
147 * they all are of some derived type.
151 const struct rset_control *control;
152 struct rset_key_control *keycontrol;
153 int refcount; /* reference count */
154 void *priv; /* stuff private to the given type of rset */
155 NMEM nmem; /* nibble memory for various allocs */
156 RSFD free_list; /* all rfd's allocated but not currently in use */
157 RSFD use_list; /* all rfd's in use */
158 int scope; /* On what level do we count hits and compare them? */
159 TERMID term; /* the term thing for ranking etc */
167 /* rset is a "virtual base class", which will never exist on its own
168 * all instances are rsets of some specific type, like rsisamb, or rsbool
169 * They keep their own stuff behind the priv pointer. */
171 /* On the old sysno-seqno type isams, the scope was hard-coded to be 2.
172 * This means that we count hits on the sysno level, and when matching an
173 * 'and', we consider it a match if both term occur within the same sysno.
174 * In more complex isams we can specify on what level we wish to do the
175 * matching and counting of hits. For example, we can have book / chapter /
176 * verse, and a seqno. Scope 2 means then "give me all verses that match",
177 * 3 would be chapters, 4 books.
178 * The resolution tells how much of the occurences we need to return. If we
179 * are doing some sort of proximity, we need to get the seqnos of all
180 * occurences, whereas if we are only counting hits, we do not need anything
181 * below the scope. Again 1 is seqnos, 2 sysnos (or verses), 3 books, etc.
184 RSFD rfd_create_base(RSET rs);
185 int rfd_is_last(RSFD rfd);
187 RSET rset_create_base(const struct rset_control *sel,
189 struct rset_key_control *kcontrol,
192 int no_children, RSET *children);
194 void rset_delete(RSET rs);
195 RSET rset_dup (RSET rs);
196 void rset_close(RSFD rfd);
199 #define RSETF_WRITE 1
200 /* RSFD rset_open(RSET rs, int wflag); */
201 #define rset_open(rs, wflag) (*(rs)->control->f_open)((rs), (wflag))
203 /* int rset_forward(RSFD rfd, void *buf, TERMID term, void *untilbuf); */
204 #define rset_forward(rfd, buf, term, untilbuf) \
205 rset_default_forward((rfd), (buf), (term), (untilbuf))
207 /* void rset_getterms(RSET ct, TERMID *terms, int maxterms, int *curterm); */
208 #define rset_getterms(ct, terms, maxterms, curterm) \
209 (*(ct)->control->f_getterms)((ct),(terms),(maxterms),(curterm))
211 /* int rset_pos(RSFD fd, double *current, double *total); */
212 #define rset_pos(rfd,cur,tot) \
213 (*(rfd)->rset->control->f_pos)((rfd),(cur),(tot))
215 /* int rset_read(RSFD rfd, void *buf, TERMID term); */
216 #define rset_read(rfd, buf, term) rset_default_read((rfd), (buf), (term))
218 /* int rset_write(RSFD rfd, const void *buf); */
219 #define rset_write(rfd, buf) (*(rfd)->rset->control->f_write)((rfd), (buf))
221 /* int rset_type (RSET) */
222 #define rset_type(rs) ((rs)->control->desc)
224 /** rset_count counts or estimates the keys in it*/
225 zint rset_count(RSET rs);
227 RSET rstemp_create(NMEM nmem, struct rset_key_control *kcontrol,
228 int scope, const char *temp_path, TERMID term);
230 RSET rsnull_create(NMEM nmem, struct rset_key_control *kcontrol, TERMID term);
232 RSET rsbool_create_and(NMEM nmem, struct rset_key_control *kcontrol,
233 int scope, RSET rset_l, RSET rset_r);
235 RSET rsbool_create_or(NMEM nmem, struct rset_key_control *kcontrol,
236 int scope, RSET rset_l, RSET rset_r);
238 RSET rsbool_create_not(NMEM nmem, struct rset_key_control *kcontrol,
239 int scope, RSET rset_l, RSET rset_r);
241 RSET rsbetween_create(NMEM nmem, struct rset_key_control *kcontrol,
242 int scope, RSET rset_l, RSET rset_m, RSET rset_r,
245 RSET rsmulti_or_create(NMEM nmem, struct rset_key_control *kcontrol,
246 int scope, TERMID termid, int no_rsets, RSET* rsets);
248 RSET rsmulti_and_create(NMEM nmem, struct rset_key_control *kcontrol,
249 int scope, int no_rsets, RSET* rsets);
251 RSET rsprox_create(NMEM nmem, struct rset_key_control *kcontrol,
252 int scope, int rset_no, RSET *rset,
253 int ordered, int exclusion, int relation, int distance);
255 RSET rsisamb_create(NMEM nmem, struct rset_key_control *kcontrol,
256 int scope, ISAMB is, ISAM_P pos, TERMID term);
258 RSET rsisamc_create(NMEM nmem, struct rset_key_control *kcontrol,
259 int scope, ISAMC is, ISAM_P pos, TERMID term);
261 RSET rsisams_create(NMEM nmem, struct rset_key_control *kcontrol,
262 int scope, ISAMS is, ISAM_P pos, TERMID term);
264 void rset_visit(RSET rset, int level);