include/rset.h

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