include/rset.h

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