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