include/rset.h

   1 /*
   2  * Copyright (C) 1994-1998, Index Data I/S
   3  * All rights reserved.
   4  * Sebastian Hammer, Adam Dickmeiss
   5  *
   6  * $Log: rset.h,v $
   7  * Revision 1.14  1998-02-10 11:56:46  adam
   8  * Implemented rset_dup.
   9  *
  10  * Revision 1.13  1997/12/18 10:54:24  adam
  11  * New method result set method rs_hits that returns the number of
  12  * hits in result-set (if known). The ranked result set returns real
  13  * number of hits but only when not combined with other operands.
  14  *
  15  * Revision 1.12  1997/09/05 15:30:03  adam
  16  * Changed prototype for chr_map_input - added const.
  17  * Added support for C++, headers uses extern "C" for public definitions.
  18  *
  19  * Revision 1.11  1995/12/11 09:07:53  adam
  20  * New rset member 'flag', that holds various flags about a result set -
  21  * currently 'volatile' (set is register dependent) and 'ranked' (set is
  22  * ranked).
  23  * New set types sand/sor/snot. They handle and/or/not for ranked and
  24  * semi-ranked result sets.
  25  *
  26  * Revision 1.10  1995/10/12  12:40:36  adam
  27  * Private info (buf) moved from struct rset_control to struct rset.
  28  * Member control in rset is statically set in rset_create.
  29  *
  30  * Revision 1.9  1995/10/10  14:00:01  adam
  31  * Function rset_open changed its wflag parameter to general flags.
  32  *
  33  * Revision 1.8  1995/10/06  14:37:53  adam
  34  * New result set method: r_score.
  35  * Local no (sysno) and score is transferred to retrieveCtrl.
  36  *
  37  * Revision 1.7  1995/09/07  13:58:08  adam
  38  * New parameter: result-set file descriptor (RSFD) to support multiple
  39  * positions within the same result-set.
  40  * Boolean operators: and, or, not implemented.
  41  *
  42  * Revision 1.6  1995/09/06  16:10:58  adam
  43  * More work on boolean sets.
  44  *
  45  * Revision 1.5  1995/09/04  15:20:13  adam
  46  * More work on temp sets. is_open member removed.
  47  *
  48  * Revision 1.4  1995/09/04  09:09:52  adam
  49  * String arg in dict lookup is const.
  50  * Minor changes.
  51  *
  52  * Revision 1.3  1994/11/22  13:15:27  quinn
  53  * Simple
  54  *
  55  * Revision 1.2  1994/11/04  13:21:21  quinn
  56  * Working.
  57  *
  58  * Revision 1.1  1994/11/03  14:13:22  quinn
  59  * Result set manipulation
  60  *
  61  */
  62
  63 #ifndef RSET_H
  64 #define RSET_H
  65
  66 #include <stdlib.h>
  67
  68 #ifdef __cplusplus
  69 extern "C" {
  70 #endif
  71 typedef void *RSFD;
  72
  73 typedef struct rset *RSET;
  74
  75 typedef struct rset_control
  76 {
  77     char *desc; /* text description of set type (for debugging) */
  78     void *(*f_create)(const struct rset_control *sel, void *parms,
  79                       int *flags);
  80     RSFD (*f_open)(RSET ct, int wflag);
  81     void (*f_close)(RSFD rfd);
  82     void (*f_delete)(RSET ct);
  83     void (*f_rewind)(RSFD rfd);
  84     int (*f_count)(RSET ct);
  85     int (*f_hits)(RSET ct, void *oi);
  86     int (*f_read)(RSFD rfd, void *buf);
  87     int (*f_write)(RSFD rfd, const void *buf);
  88     int (*f_score)(RSFD rfd, int *score);
  89 } rset_control;
  90
  91 typedef struct rset
  92 {
  93     const rset_control *control;
  94     int  flags;
  95     int  count;
  96     void *buf;
  97 } rset;
  98
  99 #define RSETF_READ       0
 100 #define RSETF_WRITE      1
 101
 102 #define RSETF_SORT_SYSNO 0
 103 #define RSETF_SORT_RANK  2
 104
 105 RSET rset_create(const rset_control *sel, void *parms);       /* parameters? */
 106
 107 /* int rset_open(RSET rs, int wflag); */
 108 #define rset_open(rs, wflag) (*(rs)->control->f_open)((rs), (wflag))
 109
 110 /* void rset_close(RSET rs); */
 111 #define rset_close(rs, rfd) (*(rs)->control->f_close)(rfd)
 112
 113 void rset_delete(RSET rs);
 114
 115 RSET rset_dup (RSET rs);
 116
 117 /* void rset_rewind(RSET rs); */
 118 #define rset_rewind(rs, rfd) (*(rs)->control->f_rewind)((rfd))
 119
 120 /* int rset_count(RSET rs); */
 121 #define rset_count(rs) (*(rs)->control->f_count)(rs)
 122
 123 /* int rset_hits (RSET) */
 124 #define rset_hits(rs) (*(rs)->control->f_hits)((rs), 0)
 125
 126 /* int rset_read(RSET rs, void *buf); */
 127 #define rset_read(rs, fd, buf) (*(rs)->control->f_read)((fd), (buf))
 128
 129 /* int rset_write(RSET rs, const void *buf); */
 130 #define rset_write(rs, fd, buf) (*(rs)->control->f_write)((fd), (buf))
 131
 132 /* int rset_score(RSET rs, int *buf); */
 133 #define rset_score(rs, fd, score) (*(rs)->control->f_score)((fd), (score))
 134
 135
 136 /* int rset_type (RSET) */
 137 #define rset_type(rs) ((rs)->control->desc)
 138
 139 #define RSET_FLAG_VOLATILE 1
 140 #define RSET_FLAG_RANKED 2
 141
 142 #define rset_is_volatile(rs) ((rs)->flags & RSET_FLAG_VOLATILE)
 143 #define rset_is_ranked(rs) ((rs)->flags & RSET_FLAG_RANKED)
 144
 145 #ifdef __cplusplus
 146 }
 147 #endif
 148
 149 #endif