summaryrefslogtreecommitdiff
path: root/camel/camel-index.h
blob: 4d14fbbf3e67288e2ee6306f0344109e13ffe416 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
/*
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 * This library is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library. If not, see <http://www.gnu.org/licenses/>.
 *
 * Authors: Michael Zucchi <notzed@ximian.com>
 */

#if !defined (__CAMEL_H_INSIDE__) && !defined (CAMEL_COMPILATION)
#error "Only <camel/camel.h> can be included directly."
#endif

#ifndef CAMEL_INDEX_H
#define CAMEL_INDEX_H

#include <glib-object.h>

/* Standard GObject macros */
#define CAMEL_TYPE_INDEX \
	(camel_index_get_type ())
#define CAMEL_INDEX(obj) \
	(G_TYPE_CHECK_INSTANCE_CAST \
	((obj), CAMEL_TYPE_INDEX, CamelIndex))
#define CAMEL_INDEX_CLASS(cls) \
	(G_TYPE_CHECK_CLASS_CAST \
	((cls), CAMEL_TYPE_INDEX, CamelIndexClass))
#define CAMEL_IS_INDEX(obj) \
	(G_TYPE_CHECK_INSTANCE_TYPE \
	((obj), CAMEL_TYPE_INDEX))
#define CAMEL_IS_INDEX_CLASS(cls) \
	(G_TYPE_CHECK_CLASS_TYPE \
	((cls), CAMEL_TYPE_INDEX))
#define CAMEL_INDEX_GET_CLASS(obj) \
	(G_TYPE_INSTANCE_GET_CLASS \
	((obj), CAMEL_TYPE_INDEX, CamelIndexClass))

#define CAMEL_TYPE_INDEX_NAME \
	(camel_index_name_get_type ())
#define CAMEL_INDEX_NAME(obj) \
	(G_TYPE_CHECK_INSTANCE_CAST \
	((obj), CAMEL_TYPE_INDEX_NAME, CamelIndexName))
#define CAMEL_INDEX_NAME_CLASS(cls) \
	(G_TYPE_CHECK_CLASS_CAST \
	((cls), CAMEL_TYPE_INDEX_NAME, CamelIndexNameClass))
#define CAMEL_IS_INDEX_NAME(obj) \
	(G_TYPE_CHECK_INSTANCE_TYPE \
	((obj), CAMEL_TYPE_INDEX_NAME))
#define CAMEL_IS_INDEX_NAME_CLASS(cls) \
	(G_TYPE_CHECK_CLASS_TYPE \
	((cls), CAMEL_TYPE_INDEX_NAME))
#define CAMEL_INDEX_NAME_GET_CLASS(obj) \
	(G_TYPE_INSTANCE_GET_CLASS \
	((obj), CAMEL_TYPE_INDEX_NAME, CamelIndexNameClass))

#define CAMEL_TYPE_INDEX_CURSOR \
	(camel_index_cursor_get_type ())
#define CAMEL_INDEX_CURSOR(obj) \
	(G_TYPE_CHECK_INSTANCE_CAST \
	((obj), CAMEL_TYPE_INDEX_CURSOR, CamelIndexCursor))
#define CAMEL_INDEX_CURSOR_CLASS(cls) \
	(G_TYPE_CHECK_CLASS_CAST \
	((cls), CAMEL_TYPE_INDEX_CURSOR, CamelIndexCursorClass))
#define CAMEL_IS_INDEX_CURSOR(obj) \
	(G_TYPE_CHECK_INSTANCE_TYPE \
	((obj), CAMEL_TYPE_INDEX_CURSOR))
#define CAMEL_IS_INDEX_CURSOR_CLASS(cls) \
	(G_TYPE_CHECK_CLASS_TYPE \
	((cls), CAMEL_TYPE_INDEX_CURSOR))
#define CAMEL_INDEX_CURSOR_GET_CLASS(obj) \
	(G_TYPE_INSTANCE_GET_CLASS \
	((obj), CAMEL_TYPE_INDEX_CURSOR, CamelIndexCursorClass))

G_BEGIN_DECLS

typedef struct _CamelIndex CamelIndex;
typedef struct _CamelIndexClass CamelIndexClass;
typedef struct _CamelIndexPrivate CamelIndexPrivate;

typedef struct _CamelIndexName CamelIndexName;
typedef struct _CamelIndexNameClass CamelIndexNameClass;
typedef struct _CamelIndexNamePrivate CamelIndexNamePrivate;

typedef struct _CamelIndexCursor CamelIndexCursor;
typedef struct _CamelIndexCursorClass CamelIndexCursorClass;
typedef struct _CamelIndexCursorPrivate CamelIndexCursorPrivate;

typedef gchar * (*CamelIndexNorm)(CamelIndex *index, const gchar *word, gpointer data);

/* ********************************************************************** */

struct _CamelIndexCursor {
	GObject parent;
	CamelIndexCursorPrivate *priv;

	CamelIndex *index;
};

struct _CamelIndexCursorClass {
	GObjectClass parent;

	const gchar * (*next) (CamelIndexCursor *idc);
};

GType           camel_index_cursor_get_type (void);
const gchar        *camel_index_cursor_next (CamelIndexCursor *idc);

/* ********************************************************************** */

struct _CamelIndexName {
	GObject parent;
	CamelIndexNamePrivate *priv;

	CamelIndex *index;

	gchar *name;		/* name being indexed */

	GByteArray *buffer;	/* used for normalisation */
	GHashTable *words;	/* unique list of words */
};

struct _CamelIndexNameClass {
	GObjectClass parent;

	void (*add_word)(CamelIndexName *name, const gchar *word);
	gsize (*add_buffer)(CamelIndexName *name, const gchar *buffer, gsize len);
};

GType           camel_index_name_get_type	(void);
void               camel_index_name_add_word (CamelIndexName *name, const gchar *word);
gsize             camel_index_name_add_buffer (CamelIndexName *name, const gchar *buffer, gsize len);

/* ********************************************************************** */

struct _CamelIndex {
	GObject parent;
	CamelIndexPrivate *priv;

	gchar *path;
	guint32 version;
	guint32 flags;		/* open flags */
	guint32 state;

	CamelIndexNorm normalize;
	gpointer normalize_data;
};

struct _CamelIndexClass {
	GObjectClass parent_class;

	gint		(*sync)			(CamelIndex *index);
	gint		(*compress)		(CamelIndex *index);
	gint		(*delete_)		(CamelIndex *index);
	gint		(*rename)		(CamelIndex *index,
						 const gchar *path);
	gint		(*has_name)		(CamelIndex *index,
						 const gchar *name);
	CamelIndexName *(*add_name)		(CamelIndex *index,
						 const gchar *name);
	gint		(*write_name)		(CamelIndex *index,
						 CamelIndexName *idn);
	CamelIndexCursor *
			(*find_name)		(CamelIndex *index,
						 const gchar *name);
	void		(*delete_name)		(CamelIndex *index,
						 const gchar *name);
	CamelIndexCursor *
			(*find)			(CamelIndex *index,
						 const gchar *word);
	CamelIndexCursor *
			(*words)		(CamelIndex *index);
};

/* flags, stored in 'state', set with set_state */
#define CAMEL_INDEX_DELETED (1 << 0)

GType		camel_index_get_type		(void);
void		camel_index_construct		(CamelIndex *index,
						 const gchar *path,
						 gint flags);
gint		camel_index_rename		(CamelIndex *index,
						 const gchar *path);
void		camel_index_set_normalize	(CamelIndex *index,
						 CamelIndexNorm func,
						 gpointer data);
gint		camel_index_sync		(CamelIndex *index);
gint		camel_index_compress		(CamelIndex *index);
gint		camel_index_delete		(CamelIndex *index);
gint		camel_index_has_name		(CamelIndex *index,
						 const gchar *name);
CamelIndexName *camel_index_add_name		(CamelIndex *index,
						 const gchar *name);
gint		camel_index_write_name		(CamelIndex *index,
						 CamelIndexName *idn);
CamelIndexCursor *
		camel_index_find_name		(CamelIndex *index,
						 const gchar *name);
void		camel_index_delete_name		(CamelIndex *index,
						 const gchar *name);
CamelIndexCursor *
		camel_index_find		(CamelIndex *index,
						 const gchar *word);
CamelIndexCursor *
		camel_index_words		(CamelIndex *index);

G_END_DECLS

#endif /* CAMEL_INDEX_H */