1 /* $Id: rset.h,v 1.33 2004-09-01 15:01:32 heikki Exp $
2 Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002
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
30 /* unfortunately we need the isam includes here, for the arguments for */
40 typedef struct rsfd *RSFD; /* Rset "file descriptor" */
41 typedef struct rset *RSET; /* Result set */
43 struct rsfd { /* the stuff common to all rsfd's. */
44 RSET rset; /* ptr to the rset this FD is opened to */
45 void *priv; /* private parameters for this type */
46 RSFD next; /* to keep lists of used/free rsfd's */
52 char *desc; /* text description of set type (for debugging) */
53 /* RSET rs_something_create(const struct rset_control *sel, ...); */
54 void (*f_delete)(RSET ct);
55 RSFD (*f_open)(RSET ct, int wflag);
56 void (*f_close)(RSFD rfd);
57 void (*f_rewind)(RSFD rfd);
58 int (*f_forward)(RSFD rfd, void *buf, const void *untilbuf);
59 void (*f_pos)(RSFD rfd, double *current, double *total);
60 /* returns -1,-1 if pos function not implemented for this type */
61 int (*f_read)(RSFD rfd, void *buf);
62 int (*f_write)(RSFD rfd, const void *buf);
65 int rset_default_forward(RSFD rfd, void *buf,
66 const void *untilbuf);
70 int (*cmp) (const void *p1, const void *p2);
71 void (*key_logdump_txt) (int logmask, const void *p, const char *txt);
72 zint (*getseq)(const void *p);
73 /* FIXME - Should not need a getseq, it won't make much sense with */
74 /* higher-order keys. Use a (generalized) cmp instead, or something */
75 /* FIXME - decode and encode, and lots of other stuff */
80 const struct rset_control *control;
81 const struct key_control *keycontrol;
82 int count; /* reference count */
83 void *priv; /* stuff private to the given type of rset */
84 NMEM nmem; /* nibble memory for various allocs */
85 char my_nmem; /* Should the nmem be destroyed with the rset? */
86 /* 1 if created with it, 0 if passed from above */
87 RSFD free_list; /* all rfd's allocated but not currently in use */
89 /* rset is a "virtual base class", which will never exist on its own */
90 /* all instances are rsets of some specific type, like rsisamb, or rsbool */
91 /* They keep their own stuff behind the priv pointer. */
93 RSFD rfd_create_base(RSET rs);
94 void rfd_delete_base(RSFD rfd);
96 RSET rset_create_base(const struct rset_control *sel,
98 const struct key_control *kcontrol);
99 void rset_delete(RSET rs);
100 RSET rset_dup (RSET rs);
104 #define RSETF_WRITE 1
105 /* RSFD rset_open(RSET rs, int wflag); */
106 #define rset_open(rs, wflag) (*(rs)->control->f_open)((rs), (wflag))
108 /* void rset_close(RSFD rfd); */
109 #define rset_close(rfd) (*(rfd)->rset->control->f_close)(rfd)
111 /* void rset_rewind(RSFD rfd); */
112 #define rset_rewind(rfd) (*(rfd)->rset->control->f_rewind)((rfd))
114 /* int rset_forward(RSFD rfd, void *buf, void *untilbuf); */
115 #define rset_forward(rfd, buf, untilbuf) \
116 (*(rfd)->rset->control->f_forward)((rfd),(buf),(untilbuf))
118 /* int rset_pos(RSFD fd, double *current, double *total); */
119 #define rset_pos(rfd,cur,tot) \
120 (*(rfd)->rset->control->f_pos)( (rfd),(cur),(tot))
122 /* int rset_read(RSFD rfd, void *buf); */
123 #define rset_read(rfd, buf) (*(rfd)->rset->control->f_read)((rfd), (buf))
125 /* int rset_write(RSFD rfd, const void *buf); */
126 #define rset_write(rfd, buf) (*(rfd)->rset->control->f_write)((rfd), (buf))
128 /* int rset_type (RSET) */
129 #define rset_type(rs) ((rs)->control->desc)
131 RSET rstemp_create( NMEM nmem, const struct key_control *kcontrol,
132 const char *temp_path);
134 RSET rsnull_create(NMEM nmem, const struct key_control *kcontrol);
136 RSET rsbool_create_and( NMEM nmem, const struct key_control *kcontrol,
137 RSET rset_l, RSET rset_r);
139 RSET rsbool_create_or ( NMEM nmem, const struct key_control *kcontrol,
140 RSET rset_l, RSET rset_r);
142 RSET rsbool_create_not( NMEM nmem, const struct key_control *kcontrol,
143 RSET rset_l, RSET rset_r);
145 RSET rsbetween_create( NMEM nmem, const struct key_control *kcontrol,
146 RSET rset_l, RSET rset_m, RSET rset_r,
149 RSET rsmultior_create( NMEM nmem, const struct key_control *kcontrol,
150 int no_rsets, RSET* rsets);
152 RSET rsprox_create( NMEM nmem, const struct key_control *kcontrol,
153 int rset_no, RSET *rset,
154 int ordered, int exclusion,
155 int relation, int distance);
157 RSET rsisamb_create( NMEM nmem, const struct key_control *kcontrol,
158 ISAMB is, ISAMB_P pos);
160 RSET rsisamc_create( NMEM nmem, const struct key_control *kcontrol,
161 ISAMC is, ISAMC_P pos);
163 RSET rsisams_create( NMEM nmem, const struct key_control *kcontrol,
164 ISAMS is, ISAMS_P pos);