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