New method log_item for the various isams to print log an item (for debug)
[idzebra-moved-to-github.git] / include / isamc.h
1 /* $Id: isamc.h,v 1.12 2004-06-01 12:56:38 adam Exp $
2    Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003,2004
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 ISAMC_H
26 #define ISAMC_H
27
28 #include <bfile.h>
29
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33
34 typedef struct ISAMC_s *ISAMC;
35 typedef int ISAMC_P;
36 typedef struct ISAMC_PP_s *ISAMC_PP;
37
38 typedef struct ISAMC_filecat_s {
39     int bsize;         /* block size */
40     int ifill;         /* initial fill */
41     int mfill;         /* minimum fill */
42     int mblocks;       /* maximum blocks */
43 } *ISAMC_filecat;
44
45 typedef struct ISAMC_M_s {
46     ISAMC_filecat filecat;
47
48     int (*compare_item)(const void *a, const void *b);
49     void (*log_item)(int logmask, const void *p, const char *txt);
50
51 #define ISAMC_DECODE 0
52 #define ISAMC_ENCODE 1
53     void *(*code_start)(int mode);
54     void (*code_stop)(int mode, void *p);
55     void (*code_item)(int mode, void *p, char **dst, char **src);
56     void (*code_reset)(void *p);
57
58     int max_blocks_mem;
59     int debug;
60 } ISAMC_M;
61
62 typedef struct ISAMC_I_s {
63     int (*read_item)(void *clientData, char **dst, int *insertMode);
64     void *clientData;
65 } ISAMC_I;
66
67 void isc_getmethod (ISAMC_M *m);
68
69 ISAMC isc_open (BFiles bfs, const char *name, int writeflag, ISAMC_M *method);
70 int isc_close (ISAMC is);
71 ISAMC_P isc_merge (ISAMC is, ISAMC_P pos, ISAMC_I *data);
72
73 ISAMC_PP isc_pp_open (ISAMC is, ISAMC_P pos);
74 void isc_pp_close (ISAMC_PP pp);
75 int isc_read_item (ISAMC_PP pp, char **dst);
76 int isc_pp_read (ISAMC_PP pp, void *buf);
77 int isc_pp_num (ISAMC_PP pp);
78
79 int isc_block_used (ISAMC is, int type);
80 int isc_block_size (ISAMC is, int type);
81
82 #define isc_type(x) ((x) & 7)
83 #define isc_block(x) ((x) >> 3)
84
85 #ifdef __cplusplus
86 }
87 #endif
88
89 #endif