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.9  1995-10-10 14:00:01  adam
   8  * Function rset_open changed its wflag parameter to general flags.
   9  *
  10  * Revision 1.8  1995/10/06  14:37:53  adam
  11  * New result set method: r_score.
  12  * Local no (sysno) and score is transferred to retrieveCtrl.
  13  *
  14  * Revision 1.7  1995/09/07  13:58:08  adam
  15  * New parameter: result-set file descriptor (RSFD) to support multiple
  16  * positions within the same result-set.
  17  * Boolean operators: and, or, not implemented.
  18  *
  19  * Revision 1.6  1995/09/06  16:10:58  adam
  20  * More work on boolean sets.
  21  *
  22  * Revision 1.5  1995/09/04  15:20:13  adam
  23  * More work on temp sets. is_open member removed.
  24  *
  25  * Revision 1.4  1995/09/04  09:09:52  adam
  26  * String arg in dict lookup is const.
  27  * Minor changes.
  28  *
  29  * Revision 1.3  1994/11/22  13:15:27  quinn
  30  * Simple
  31  *
  32  * Revision 1.2  1994/11/04  13:21:21  quinn
  33  * Working.
  34  *
  35  * Revision 1.1  1994/11/03  14:13:22  quinn
  36  * Result set manipulation
  37  *
  38  */
  39
  40 #ifndef RSET_H
  41 #define RSET_H
  42
  43 #include <stdlib.h>
  44
  45 typedef void *RSFD;
  46
  47 typedef struct rset_control
  48 {
  49     char *desc; /* text description of set type (for debugging) */
  50     void *buf;  /* state data stored by subsystem */
  51     struct rset_control *(*f_create)(const struct rset_control *sel, void *parms);
  52     RSFD (*f_open)(struct rset_control *ct, int wflag);
  53     void (*f_close)(RSFD rfd);
  54     void (*f_delete)(struct rset_control *ct);
  55     void (*f_rewind)(RSFD rfd);
  56     int (*f_count)(struct rset_control *ct);
  57     int (*f_read)(RSFD rfd, void *buf);
  58     int (*f_write)(RSFD rfd, const void *buf);
  59     int (*f_score)(RSFD rfd, int *score);
  60 } rset_control;
  61
  62 typedef struct rset
  63 {
  64     rset_control *control;
  65 } rset, *RSET;
  66
  67 #define RSETF_READ       0
  68 #define RSETF_WRITE      1
  69
  70 #define RSETF_SORT_SYSNO 0
  71 #define RSETF_SORT_RANK  2
  72
  73 RSET rset_create(const rset_control *sel, void *parms);       /* parameters? */
  74
  75 /* int rset_open(RSET rs, int wflag); */
  76 #define rset_open(rs, wflag) ((*(rs)->control->f_open)((rs)->control, (wflag)))
  77
  78 /* void rset_close(RSET rs); */
  79 #define rset_close(rs, rfd) ((*(rs)->control->f_close)((rfd)))
  80
  81 void rset_delete(RSET rs);
  82
  83 /* void rset_rewind(RSET rs); */
  84 #define rset_rewind(rs, rfd) ((*(rs)->control->f_rewind)((rfd)))
  85
  86 /* int rset_count(RSET rs); */
  87 #define rset_count(rs) ((*(rs)->control->f_count)((rs)->control))
  88
  89 /* int rset_read(RSET rs, void *buf); */
  90 #define rset_read(rs, fd, buf) ((*(rs)->control->f_read)((fd), (buf)))
  91
  92 /* int rset_write(RSET rs, const void *buf); */
  93 #define rset_write(rs, fd, buf) ((*(rs)->control->f_write)((fd), (buf)))
  94
  95 /* int rset_score(RSET rs, int *buf); */
  96 #define rset_score(rs, fd, score) ((*(rs)->control->f_score)((fd), (score)))
  97
  98 #endif