include/rset.h

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