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