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