Minor changes.
[idzebra-moved-to-github.git] / include / dict.h
1 /*
2  * Copyright (C) 1994, Index Data I/S 
3  * All rights reserved.
4  * Sebastian Hammer, Adam Dickmeiss
5  *
6  * $Log: dict.h,v $
7  * Revision 1.9  1994-10-04 12:08:19  adam
8  * Minor changes.
9  *
10  * Revision 1.8  1994/10/03  17:23:11  adam
11  * First version of dictionary lookup with regular expressions and errors.
12  *
13  * Revision 1.7  1994/09/22  10:44:47  adam
14  * Don't remember what changed!!
15  *
16  * Revision 1.6  1994/09/16  15:39:21  adam
17  * Initial code of lookup - not tested yet.
18  *
19  * Revision 1.5  1994/09/06  13:05:29  adam
20  * Further development of insertion. Some special cases are
21  * not properly handled yet! assert(0) are put here. The
22  * binary search in each page definitely reduce usr CPU.
23  *
24  * Revision 1.4  1994/09/01  17:44:40  adam
25  * Work on insertion in dictionary. Not finished yet.
26  * CVS ----------------------------------------------------------------------
27  *
28  * Revision 1.3  1994/08/18  12:41:12  adam
29  * Some development of dictionary. Not finished at all!
30  *
31  * Revision 1.2  1994/08/17  13:32:33  adam
32  * Use cache in dict - not in bfile.
33  *
34  * Revision 1.1  1994/08/16  16:26:53  adam
35  * Added dict.
36  *
37  */
38
39 #ifndef DICT_H
40 #define DICT_H
41
42 #include <bfile.h>
43
44 typedef unsigned Dict_ptr;
45 typedef char Dict_char;
46
47 struct Dict_head {
48     char magic_str[8];
49     int page_size;
50     Dict_ptr free_list, last;
51 };
52
53 struct Dict_file_block
54 {
55     struct Dict_file_block *h_next, **h_prev;
56     struct Dict_file_block *lru_next, *lru_prev;
57     void *data;
58     int dirty;
59     int no;
60 };
61
62 typedef struct Dict_file_struct
63 {
64     int cache;
65     BFile bf;
66     
67     struct Dict_file_block *all_blocks;
68     struct Dict_file_block *free_list;
69     struct Dict_file_block **hash_array;
70     
71     struct Dict_file_block *lru_back, *lru_front;
72     int hash_size;
73     void *all_data;
74     
75     int  block_size;
76     int  hits;
77     int  misses;
78 } *Dict_BFile;
79
80 typedef struct Dict_struct {
81     int rw;
82     Dict_BFile dbf;
83     struct Dict_head head;
84 }
85 *Dict;
86
87 #define DICT_MAGIC "dict00"
88
89 #define DICT_PAGESIZE 8192
90
91 int        dict_bf_readp (Dict_BFile bf, int no, void **bufp);
92 int        dict_bf_newp (Dict_BFile bf, int no, void **bufp);
93 int        dict_bf_touch (Dict_BFile bf, int no);
94 void       dict_bf_flush_blocks (Dict_BFile bf, int no_to_flush);
95 Dict_BFile dict_bf_open (const char *name, int block_size, int cache, int rw);
96 int        dict_bf_close (Dict_BFile dbf);
97      
98 Dict       dict_open (const char *name, int cache, int rw);
99 int        dict_close (Dict dict);
100 int        dict_insert (Dict dict, const Dict_char *p, int userlen,
101                         void *userinfo);
102 char      *dict_lookup (Dict dict, Dict_char *p);
103 int        dict_lookup_ec (Dict dict, Dict_char *p, int range,
104                            int (*f)(Dict_char *name));
105 int        dict_lookup_grep (Dict dict, Dict_char *p, int range, 
106                              int (*f)(Dict_char *name, char *info));       
107 int        dict_strcmp (const Dict_char *s1, const Dict_char *s2);
108 int        dict_strlen (const Dict_char *s);
109
110 #define DICT_EOS        0
111 #define DICT_type(x)    0[(Dict_ptr*) x]
112 #define DICT_backptr(x) 1[(Dict_ptr*) x]
113 #define DICT_nextptr(x) 2[(Dict_ptr*) x]
114 #define DICT_nodir(x)   0[(short*)((char*)(x)+3*sizeof(Dict_ptr))]
115 #define DICT_size(x)    1[(short*)((char*)(x)+3*sizeof(Dict_ptr))]
116 #define DICT_infoffset  (3*sizeof(Dict_ptr)+2*sizeof(short))
117
118 #define DICT_to_str(x)  sizeof(Dict_info)+sizeof(Dict_ptr)
119
120 /*
121    type            type of page
122    backptr         pointer to parent
123    nextptr         pointer to next page (if any)
124    nodir           no of words
125    size            size of strings,info,ptr entries
126
127    dir[0..nodir-1]
128    ptr,info,string
129  */
130
131    
132 #endif