2 * Copyright (C) 1994-1997, Index Data I/S
4 * Sebastian Hammer, Adam Dickmeiss
7 * Revision 1.13 1997-12-18 10:54:24 adam
8 * New method result set method rs_hits that returns the number of
9 * hits in result-set (if known). The ranked result set returns real
10 * number of hits but only when not combined with other operands.
12 * Revision 1.12 1997/09/05 15:30:03 adam
13 * Changed prototype for chr_map_input - added const.
14 * Added support for C++, headers uses extern "C" for public definitions.
16 * Revision 1.11 1995/12/11 09:07:53 adam
17 * New rset member 'flag', that holds various flags about a result set -
18 * currently 'volatile' (set is register dependent) and 'ranked' (set is
20 * New set types sand/sor/snot. They handle and/or/not for ranked and
21 * semi-ranked result sets.
23 * Revision 1.10 1995/10/12 12:40:36 adam
24 * Private info (buf) moved from struct rset_control to struct rset.
25 * Member control in rset is statically set in rset_create.
27 * Revision 1.9 1995/10/10 14:00:01 adam
28 * Function rset_open changed its wflag parameter to general flags.
30 * Revision 1.8 1995/10/06 14:37:53 adam
31 * New result set method: r_score.
32 * Local no (sysno) and score is transferred to retrieveCtrl.
34 * Revision 1.7 1995/09/07 13:58:08 adam
35 * New parameter: result-set file descriptor (RSFD) to support multiple
36 * positions within the same result-set.
37 * Boolean operators: and, or, not implemented.
39 * Revision 1.6 1995/09/06 16:10:58 adam
40 * More work on boolean sets.
42 * Revision 1.5 1995/09/04 15:20:13 adam
43 * More work on temp sets. is_open member removed.
45 * Revision 1.4 1995/09/04 09:09:52 adam
46 * String arg in dict lookup is const.
49 * Revision 1.3 1994/11/22 13:15:27 quinn
52 * Revision 1.2 1994/11/04 13:21:21 quinn
55 * Revision 1.1 1994/11/03 14:13:22 quinn
56 * Result set manipulation
70 typedef struct rset *RSET;
72 typedef struct rset_control
74 char *desc; /* text description of set type (for debugging) */
75 void *(*f_create)(const struct rset_control *sel, void *parms,
77 RSFD (*f_open)(RSET ct, int wflag);
78 void (*f_close)(RSFD rfd);
79 void (*f_delete)(RSET ct);
80 void (*f_rewind)(RSFD rfd);
81 int (*f_count)(RSET ct);
82 int (*f_hits)(RSET ct, void *oi);
83 int (*f_read)(RSFD rfd, void *buf);
84 int (*f_write)(RSFD rfd, const void *buf);
85 int (*f_score)(RSFD rfd, int *score);
90 const rset_control *control;
98 #define RSETF_SORT_SYSNO 0
99 #define RSETF_SORT_RANK 2
101 RSET rset_create(const rset_control *sel, void *parms); /* parameters? */
103 /* int rset_open(RSET rs, int wflag); */
104 #define rset_open(rs, wflag) (*(rs)->control->f_open)((rs), (wflag))
106 /* void rset_close(RSET rs); */
107 #define rset_close(rs, rfd) (*(rs)->control->f_close)(rfd)
109 void rset_delete(RSET rs);
111 /* void rset_rewind(RSET rs); */
112 #define rset_rewind(rs, rfd) (*(rs)->control->f_rewind)((rfd))
114 /* int rset_count(RSET rs); */
115 #define rset_count(rs) (*(rs)->control->f_count)(rs)
117 /* int rset_hits (RSET) */
118 #define rset_hits(rs) (*(rs)->control->f_hits)((rs), 0)
120 /* int rset_read(RSET rs, void *buf); */
121 #define rset_read(rs, fd, buf) (*(rs)->control->f_read)((fd), (buf))
123 /* int rset_write(RSET rs, const void *buf); */
124 #define rset_write(rs, fd, buf) (*(rs)->control->f_write)((fd), (buf))
126 /* int rset_score(RSET rs, int *buf); */
127 #define rset_score(rs, fd, score) (*(rs)->control->f_score)((fd), (score))
130 /* int rset_type (RSET) */
131 #define rset_type(rs) ((rs)->control->desc)
133 #define RSET_FLAG_VOLATILE 1
134 #define RSET_FLAG_RANKED 2
136 #define rset_is_volatile(rs) ((rs)->flags & RSET_FLAG_VOLATILE)
137 #define rset_is_ranked(rs) ((rs)->flags & RSET_FLAG_RANKED)