xref: /haiku/src/apps/mail/WIndex.h (revision 1e36cfc2721ef13a187c6f7354dc9cbc485e89d3)
1 /*
2 Open Tracker License
3 
4 Terms and Conditions
5 
6 Copyright (c) 1991-2001, Be Incorporated. All rights reserved.
7 
8 Permission is hereby granted, free of charge, to any person obtaining a copy of
9 this software and associated documentation files (the "Software"), to deal in
10 the Software without restriction, including without limitation the rights to
11 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
12 of the Software, and to permit persons to whom the Software is furnished to do
13 so, subject to the following conditions:
14 
15 The above copyright notice and this permission notice applies to all licensees
16 and shall be included in all copies or substantial portions of the Software.
17 
18 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF TITLE, MERCHANTABILITY,
20 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 BE INCORPORATED BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
22 AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION
23 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24 
25 Except as contained in this notice, the name of Be Incorporated shall not be
26 used in advertising or otherwise to promote the sale, use or other dealings in
27 this Software without prior written authorization from Be Incorporated.
28 
29 BeMail(TM), Tracker(TM), Be(R), BeOS(R), and BeIA(TM) are trademarks or registered trademarks
30 of Be Incorporated in the United States and other countries. Other brand product
31 names are registered trademarks or trademarks of their respective holders.
32 All rights reserved.
33 */
34 
35 #ifndef _WORD_INDEX_H
36 #define _WORD_INDEX_H
37 
38 #include <DataIO.h>
39 #include <String.h>
40 
41 struct WIndexHead {
42 	int32 entries;
43 	int32 entrySize;
44 	int32 offset;
45 };
46 
47 struct WIndexEntry {
48 	int32 key;
49 	int32 offset;
50 };
51 
52 class FileEntry : public BString {
53 public:
54 	FileEntry(void);
55 	FileEntry(const char *entryStr);
56 	virtual ~FileEntry(void);
57 };
58 
59 class WIndex {
60 public:
61 	WIndex(BPositionIO *dataFile, int32 count = 100);
62 	WIndex(int32 count = 100);
63 	virtual ~WIndex(void);
64 
65 	status_t InitIndex(void);
66 	status_t UnflattenIndex(BPositionIO *io);
67 	status_t FlattenIndex(BPositionIO *io);
68 
69 	int32 Lookup(int32 key);
70 
71 	inline WIndexEntry *ItemAt(int32 index)
72 		{ return (WIndexEntry *)(entryList+(index*entrySize)); }
73 	status_t AddItem(WIndexEntry *entry);
74 	inline int32 CountItems(void)
75 		{ return entries; }
76 	void SortItems(void);
77 
78 	virtual int32 GetKey(const char *s);
79 	virtual char *NormalizeWord(const char *word, char *dest);
80 
81 	status_t SetTo(BPositionIO *dataFile);
82 	status_t SetTo(const char *dataPath, const char *indexPath);
83 	void Unset(void);
84 
85 	virtual status_t BuildIndex(void) = 0;
86 
87 	virtual int32 FindFirst(const char *word);
88 	virtual FileEntry *GetEntry(int32 index);
89 	FileEntry *GetEntry(const char *word);
90 
91 protected:
92 	status_t BlockCheck(void);
93 	virtual size_t GetEntrySize(WIndexEntry *entry, const char *entryData);
94 
95 	int32 entrySize;
96 	int32 entries;
97 	int32 maxEntries;
98 	int32 ePerB;
99 	int32 blockSize;
100 	int32 blocks;
101 	bool isSorted;
102 	uint8 *entryList;
103 	BPositionIO *dataFile;
104 };
105 
106 #endif // #ifndef _WORD_INDEX_H
107