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