Record management uses the bfile system.
[idzebra-moved-to-github.git] / index / index.h
1 /*
2  * Copyright (C) 1994-1995, Index Data I/S 
3  * All rights reserved.
4  * Sebastian Hammer, Adam Dickmeiss
5  *
6  * $Log: index.h,v $
7  * Revision 1.26  1995-11-22 17:19:17  adam
8  * Record management uses the bfile system.
9  *
10  * Revision 1.25  1995/11/21  15:29:12  adam
11  * Config file 'base' read by default by both indexer and server.
12  *
13  * Revision 1.24  1995/11/21  15:01:15  adam
14  * New general match criteria implemented.
15  * New feature: document groups.
16  *
17  * Revision 1.23  1995/11/20  16:59:45  adam
18  * New update method: the 'old' keys are saved for each records.
19  *
20  * Revision 1.22  1995/11/20  11:56:26  adam
21  * Work on new traversal.
22  *
23  * Revision 1.21  1995/11/16  15:34:55  adam
24  * Uses new record management system in both indexer and server.
25  *
26  * Revision 1.20  1995/11/15  14:46:18  adam
27  * Started work on better record management system.
28  *
29  * Revision 1.19  1995/10/27  14:00:11  adam
30  * Implemented detection of database availability.
31  *
32  * Revision 1.18  1995/10/17  18:02:08  adam
33  * New feature: databases. Implemented as prefix to words in dictionary.
34  *
35  * Revision 1.17  1995/10/13  16:01:49  adam
36  * Work on relations.
37  *
38  * Revision 1.16  1995/10/10  12:24:38  adam
39  * Temporary sort files are compressed.
40  *
41  * Revision 1.15  1995/10/04  16:57:19  adam
42  * Key input and merge sort in one pass.
43  *
44  * Revision 1.14  1995/09/29  14:01:40  adam
45  * Bug fixes.
46  *
47  * Revision 1.13  1995/09/28  14:22:56  adam
48  * Sort uses smaller temporary files.
49  *
50  * Revision 1.12  1995/09/28  12:10:32  adam
51  * Bug fixes. Field prefix used in queries.
52  *
53  * Revision 1.11  1995/09/27  12:22:28  adam
54  * More work on extract in record control.
55  * Field name is not in isam keys but in prefix in dictionary words.
56  *
57  * Revision 1.10  1995/09/14  07:48:23  adam
58  * Record control management.
59  *
60  * Revision 1.9  1995/09/11  13:09:33  adam
61  * More work on relevance feedback.
62  *
63  * Revision 1.8  1995/09/08  14:52:27  adam
64  * Minor changes. Dictionary is lower case now.
65  *
66  * Revision 1.7  1995/09/06  16:11:16  adam
67  * Option: only one word key per file.
68  *
69  * Revision 1.6  1995/09/05  15:28:39  adam
70  * More work on search engine.
71  *
72  * Revision 1.5  1995/09/04  12:33:42  adam
73  * Various cleanup. YAZ util used instead.
74  *
75  * Revision 1.4  1995/09/04  09:10:35  adam
76  * More work on index add/del/update.
77  * Merge sort implemented.
78  * Initial work on z39 server.
79  *
80  * Revision 1.3  1995/09/01  14:06:35  adam
81  * Split of work into more files.
82  *
83  * Revision 1.2  1995/09/01  10:30:24  adam
84  * More work on indexing. Not working yet.
85  *
86  * Revision 1.1  1995/08/31  14:50:24  adam
87  * New simple file index tool.
88  *
89  */
90
91 #include <alexutil.h>
92 #include <dict.h>
93 #include <isam.h>
94
95 #define IT_MAX_WORD 256
96 #define IT_KEY_HAVE_SEQNO 1
97 #define IT_KEY_HAVE_FIELD 0
98
99 struct it_key {
100     int  sysno;
101     int   seqno;
102 };
103
104 enum dirsKind { dirs_dir, dirs_file };
105
106 struct dir_entry {
107     enum dirsKind kind;
108     char *name;
109     int ctime;
110 };
111
112 struct dirs_entry {
113     enum dirsKind kind;
114     char path[256];
115     SYSNO sysno;
116     int ctime;
117 };
118
119 struct recordGroup {
120     char *groupName;
121     char *databaseName;
122     char *path;
123 };
124
125 struct dirs_info *dirs_open (Dict dict, const char *rep);
126 struct dirs_entry *dirs_read (struct dirs_info *p);
127 struct dirs_entry *dirs_last (struct dirs_info *p);
128 void dirs_mkdir (struct dirs_info *p, const char *src, int ctime);
129 void dirs_rmdir (struct dirs_info *p, const char *src);
130 void dirs_add (struct dirs_info *p, const char *src, int sysno, int ctime);
131 void dirs_del (struct dirs_info *p, const char *src);
132 void dirs_free (struct dirs_info **pp);
133
134 struct dir_entry *dir_open (const char *rep);
135 void dir_sort (struct dir_entry *e);
136 void dir_free (struct dir_entry **e_p);
137
138 void repositoryUpdate (struct recordGroup *rGroup);
139 void repositoryAdd (struct recordGroup *rGroup);
140 void repositoryDelete (struct recordGroup *rGroup);
141
142 void key_open (int mem);
143 int key_close (void);
144 void key_write (int cmd, struct it_key *k, const char *str);
145 int key_compare (const void *p1, const void *p2);
146 int key_qsort_compare (const void *p1, const void *p2);
147 void key_logdump (int mask, const void *p);
148 void key_input (const char *dict_fname, const char *isam_fname,
149                  int nkeys, int cache);
150 int merge_sort (char **buf, int from, int to);
151
152 #define TEMP_FNAME  "keys%d.tmp"
153 #define FNAME_WORD_DICT "worddict"
154 #define FNAME_WORD_ISAM "wordisam"
155
156 struct strtab *strtab_mk (void);
157 int strtab_src (struct strtab *t, const char *name, void ***infop);
158 void strtab_del (struct strtab *t,
159                  void (*func)(const char *name, void *info, void *data),
160                  void *data);
161 int index_char_cvt (int c);
162 int index_word_prefix (char *string, int attset_ordinal,
163                        int local_attribute, const char *databaseName);
164
165 int fileExtract (SYSNO *sysno, const char *fname,
166                  struct recordGroup *rGroup, int deleteFlag);