Move/refactoring of public interfaces..
[idzebra-moved-to-github.git] / dict / dict-p.h
1 /* $Id: dict-p.h,v 1.1 2004-12-08 12:23:08 adam Exp $
2    Copyright (C) 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 #ifndef DICT_P_H
24 #define DICT_P_H
25
26 #include <idzebra/dict.h>
27
28 YAZ_BEGIN_CDECL
29
30 #define DICT_MAGIC "dict01"
31
32 #define DICT_DEFAULT_PAGESIZE 4096
33
34 struct Dict_head {
35     char magic_str[8];
36     int page_size;
37     int compact_flag;
38     Dict_ptr root, last, freelist;
39 };
40
41 struct Dict_file_block
42 {
43     struct Dict_file_block *h_next, **h_prev;
44     struct Dict_file_block *lru_next, *lru_prev;
45     void *data;
46     int dirty;
47     int no;
48     int nbytes;
49 };
50
51 typedef struct Dict_file_struct
52 {
53     int cache;
54     BFile bf;
55     
56     struct Dict_file_block *all_blocks;
57     struct Dict_file_block *free_list;
58     struct Dict_file_block **hash_array;
59     
60     struct Dict_file_block *lru_back, *lru_front;
61     int hash_size;
62     void *all_data;
63     
64     int  block_size;
65     int  hits;
66     int  misses;
67     int  compact_flag;
68 } *Dict_BFile;
69
70 struct Dict_struct {
71     int rw;
72     Dict_BFile dbf;
73     const char **(*grep_cmap)(void *vp, const char **from, int len);
74     void *grep_cmap_data;
75     struct Dict_head head;
76 };
77
78 int        dict_bf_readp (Dict_BFile bf, int no, void **bufp);
79 int        dict_bf_newp (Dict_BFile bf, int no, void **bufp, int nbytes);
80 int        dict_bf_touch (Dict_BFile bf, int no);
81 void       dict_bf_flush_blocks (Dict_BFile bf, int no_to_flush);
82 Dict_BFile dict_bf_open (BFiles bfs, const char *name, int block_size,
83                          int cache, int rw);
84 int        dict_bf_close (Dict_BFile dbf);
85 void       dict_bf_compact (Dict_BFile dbf);
86
87 #define DICT_EOS        0
88 #define DICT_type(x)    0[(Dict_ptr*) x]
89 #define DICT_backptr(x) 1[(Dict_ptr*) x]
90 #define DICT_bsize(x)   2[(short*)((char*)(x)+2*sizeof(Dict_ptr))]
91 #define DICT_nodir(x)   0[(short*)((char*)(x)+2*sizeof(Dict_ptr))]
92 #define DICT_size(x)    1[(short*)((char*)(x)+2*sizeof(Dict_ptr))]
93 #define DICT_infoffset  (2*sizeof(Dict_ptr)+3*sizeof(short))
94 #define DICT_xxxxpagesize(x) ((x)->head.page_size)
95
96 #define DICT_to_str(x)  sizeof(Dict_info)+sizeof(Dict_ptr)
97
98 /*
99    type            type of page
100    backptr         pointer to parent
101    nextptr         pointer to next page (if any)
102    nodir           no of words
103    size            size of strings,info,ptr entries
104
105    dir[0..nodir-1]
106    ptr,info,string
107  */
108      
109 YAZ_END_CDECL
110
111 #endif