xref: /haiku/src/apps/mail/WIndex.h (revision 1e60bdeab63fa7a57bc9a55b032052e95a18bd2c)
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 #ifndef _WORD_INDEX_H
35 #define _WORD_INDEX_H
36 
37 
38 #include <DataIO.h>
39 #include <String.h>
40 
41 
42 struct WIndexHead {
43 	int32 entries;
44 	int32 entrySize;
45 	int32 offset;
46 };
47 
48 
49 struct WIndexEntry {
50 	int32 key;
51 	int32 offset;
52 };
53 
54 
55 class FileEntry : public BString {
56 public:
57 							FileEntry();
58 							FileEntry(const char* entryStr);
59 	virtual					~FileEntry();
60 };
61 
62 
63 class WIndex {
64 public:
65 							WIndex(BPositionIO* dataFile, int32 count = 100);
66 							WIndex(int32 count = 100);
67 	virtual					~WIndex();
68 
69 			status_t		InitIndex();
70 			status_t		UnflattenIndex(BPositionIO* io);
71 			status_t		FlattenIndex(BPositionIO* io);
72 
73 			int32			Lookup(int32 key);
74 
75 	inline	WIndexEntry*	ItemAt(int32 index) {
76 								return (WIndexEntry*)
77 									(fEntryList + (index * fEntrySize));
78 							}
79 
80 			status_t		AddItem(WIndexEntry* entry);
81 	inline	int32			CountItems() {
82 								return fEntries;
83 							}
84 	void SortItems();
85 
86 	virtual	int32			GetKey(const char* s);
87 	virtual	char*			NormalizeWord(const char* word, char* dest);
88 
89 			status_t		SetTo(BPositionIO* dataFile);
90 			status_t		SetTo(const char* dataPath, const char* indexPath);
91 			void			Unset();
92 
93 	virtual	status_t		BuildIndex() = 0;
94 
95 	virtual	int32			FindFirst(const char* word);
96 	virtual	FileEntry*		GetEntry(int32 index);
97 			FileEntry*		GetEntry(const char* word);
98 
99 protected:
100 			status_t		_BlockCheck();
101 	virtual	size_t			_GetEntrySize(WIndexEntry* entry,
102 								const char* entryData);
103 
104 			int32			fEntrySize;
105 			int32			fEntries;
106 			int32			fMaxEntries;
107 			int32			fEntriesPerBlock;
108 			int32			fBlockSize;
109 			int32			fBlocks;
110 			bool			fIsSorted;
111 			uint8*			fEntryList;
112 			BPositionIO*	fDataFile;
113 };
114 
115 #endif	// _WORD_INDEX_H
116 
117