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