isam.h

Go to the documentation of this file.

/* This file is part of the Zebra server.
   Copyright (C) Index Data
 
Zebra is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2, or (at your option) any later
version.
 
Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.
 
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
*/
 
#ifndef ISAM_H
#define ISAM_H
 
#include <idzebra/bfile.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
struct key_control {
    int key_size;
 
    int scope;
 
    int (*cmp) (const void *p1, const void *p2);
 
    void (*key_logdump_txt) (int logmask, const void *p, const char *txt);
 
    zint (*getseq)(const void *p);
 
    ISAM_CODEC *codec;
};
 
typedef struct key_control KEY_CONTROL;
 
const KEY_CONTROL *default_key_control();
  /* FIXME - in zrpn.c, time being. Needs to be moved out */
 
 
struct isam_data_stream {
    int (*read_item)(void *clientData, char **dst, int *insertMode);
    void *clientData;
};
 
typedef struct isam_data_stram ISAM_DATA_STREAM;
 
 
typedef zint ISAM_POS;
 
typedef struct ISAM_s *ISAM;
 
typedef struct ISAM_CUR_s *ISAM_CUR;
 
struct isam_conrol {
    char *desc;
    const char *def_filename;
 
    /* there is an isam_open function, but it is not part of this */
    /* dynamic table, as it is what provides this table */
 
    void (*f_close)(ISAM i);
 
    ISAM_POS (*f_put)(ISAM is, ISAM_POS pos, const void *buf);
 
    int (*f_del)(ISAM is, ISAM_POS pos, const void *buf);
 
    int (*f_get)(ISAM is, ISAM_POS pos, void *buf );
 
    ISAM_POS (*f_merge)(ISAM is, ISAM_POS pos, ISAM_DATA_STREAM *data);
 
    ISAM_CUR (*f_cur_open)(ISAM is, ISAM_POS pos);
 
    int (*f_read)(ISAM_CUR cur, void *buf);
 
    int (*f_forward)(ISAM_CUR cur, void *buf, const void *untilbuf);
 
    void (*f_pos)(ISAM_CUR cur, double *current, double *total);
 
    void (*f_cur_close)(ISAM_CUR cur);
 
    int (*f_unlink)(ISAM is, ISAM_POS pos);
 
};
 
struct ISAM_s {
    const struct isam_control *ictrl;  /* the functions */
    const KEY_CONTROL *kctrl; /* all about the keys stored in the isam */
    BFiles bfs;  /* The underlying block file system */
    void *priv; /* various types of ISAMs hand their private parts here */
};
 
struct ISAM_CUR {
    ISAM is;
    void *priv;
};
 
 
 
ISAM isam_open (BFiles bfs,
                const char *isamtype, /* usually "b" */
                const char *filename,  /* optional, use default from control ?? */
                int flags, /* FIXME - define read/write, and some special ones */
                const KEY_CONTROL *key_control);
 
 
#define isam_close(is) (*(is)->ictrl->f_close)(is)
 
#define isam_puf(is,pos,buf) (*(is)->ictrl->f_put)((is),(pos)(buf))
 
#define isam_del(is,pos,buf) (*(is)->ictrl->f_del)((is),(pos)(buf))
 
#define isam_get(is,pos,buf) (*(is)->ictrl->f_get)((is),(pos)(buf))
 
#define isam_merge(is,pos,data) (*(is)->ictrl->f_merge)((is),(pos)(data))
 
#define isam_cur_open(is,pos) (*(is)->ictrl->f_cur_open)((is),(pos))
 
#define isam_read(cur,buf) (*(is)->ictrl->f_read)((cur),(buf))
 
#define isam_forward(cur,buf,untilbuf) (*(is)->ictrl->f_forward)((cur),(buf)(untilbuf))
 
#define isam_pos(cur,current,total) (*(is)->ictrl->f_pos)((cur),(current),(total))
 
#define isam_cur_close(cur) (*(is)->ictrl->f_cur_close)(cur)
 
#define isam_unlink(is,pos) (*(is)->ictrl->f_unlink)((is),(pos))
 
 
#ifdef __cplusplus
}
#endif
 
#endif  /* ISAM_H */
/*
 * Local variables:
 * c-basic-offset: 4
 * c-file-style: "Stroustrup"
 * indent-tabs-mode: nil
 * End:
 * vim: shiftwidth=4 tabstop=8 expandtab
 */