include/rset.h

   1 /* $Id: rset.h,v 1.20 2004-01-16 18:04:33 heikki Exp $
   2    Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002
   3    Index Data Aps
   4
   5 This file is part of the Zebra server.
   6
   7 Zebra is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 2, or (at your option) any later
  10 version.
  11
  12 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with Zebra; see the file LICENSE.zebra.  If not, write to the
  19 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  20 02111-1307, USA.
  21 */
  22
  23
  24
  25 #ifndef RSET_H
  26 #define RSET_H
  27
  28 #include <stdlib.h>
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33 typedef void *RSFD;
  34
  35 typedef struct rset *RSET;
  36 typedef struct rset_term *RSET_TERM;
  37
  38 struct rset_control
  39 {
  40     char *desc; /* text description of set type (for debugging) */
  41     void *(*f_create)(RSET ct, const struct rset_control *sel, void *parms);
  42     RSFD (*f_open)(RSET ct, int wflag);
  43     void (*f_close)(RSFD rfd);
  44     void (*f_delete)(RSET ct);
  45     void (*f_rewind)(RSFD rfd);
  46     int (*f_forward)(RSFD rfd, void *buf, const void *untilbuf);
  47     int (*f_count)(RSET ct);
  48     int (*f_read)(RSFD rfd, void *buf, int *term_index);
  49     int (*f_write)(RSFD rfd, const void *buf);
  50 };
  51
  52 int rset_default_forward(RSFD rfd, void *buf, const void *untilbuf);
  53
  54 struct rset_term {
  55     char *name;
  56     int  nn;
  57     char *flags;
  58     int  count;
  59     int  type;
  60 };
  61
  62 typedef struct rset
  63 {
  64     const struct rset_control *control;
  65     int  flags;
  66     int  count;
  67     void *buf;
  68     RSET_TERM *rset_terms;
  69     int no_rset_terms;
  70 } rset;
  71
  72 RSET_TERM rset_term_create (const char *name, int length, const char *flags,
  73                             int type);
  74 void rset_term_destroy (RSET_TERM t);
  75 RSET_TERM rset_term_dup (RSET_TERM t);
  76
  77 #define RSETF_READ       0
  78 #define RSETF_WRITE      1
  79
  80 RSET rset_create(const struct rset_control *sel, void *parms);
  81 /* parameters? */
  82
  83 /* int rset_open(RSET rs, int wflag); */
  84 #define rset_open(rs, wflag) (*(rs)->control->f_open)((rs), (wflag))
  85
  86 /* void rset_close(RSET rs); */
  87 #define rset_close(rs, rfd) (*(rs)->control->f_close)(rfd)
  88
  89 void rset_delete(RSET rs);
  90
  91 RSET rset_dup (RSET rs);
  92
  93 /* void rset_rewind(RSET rs); */
  94 #define rset_rewind(rs, rfd) (*(rs)->control->f_rewind)((rfd))
  95
  96 /* int rset_count(RSET rs); */
  97 #define rset_count(rs) (*(rs)->control->f_count)(rs)
  98
  99 /* int rset_read(RSET rs, void *buf); */
 100 #define rset_read(rs, fd, buf, indx) (*(rs)->control->f_read)((fd), (buf), indx)
 101
 102 /* int rset_write(RSET rs, const void *buf); */
 103 #define rset_write(rs, fd, buf) (*(rs)->control->f_write)((fd), (buf))
 104
 105 /* int rset_type (RSET) */
 106 #define rset_type(rs) ((rs)->control->desc)
 107
 108 #define RSET_FLAG_VOLATILE 1
 109
 110 #define rset_is_volatile(rs) ((rs)->flags & RSET_FLAG_VOLATILE)
 111
 112 #ifdef __cplusplus
 113 }
 114 #endif
 115
 116 #endif