database: Export _notmuch_database_find_parent_id for internal use.
[notmuch] / lib / notmuch-private.h
1 /* notmuch-private.h - Internal interfaces for notmuch.
2  *
3  * Copyright © 2009 Carl Worth
4  *
5  * This program is free software: you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation, either version 3 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program.  If not, see http://www.gnu.org/licenses/ .
17  *
18  * Author: Carl Worth <cworth@cworth.org>
19  */
20
21 #ifndef NOTMUCH_PRIVATE_H
22 #define NOTMUCH_PRIVATE_H
23
24 #ifndef _GNU_SOURCE
25 #define _GNU_SOURCE /* For getline and asprintf */
26 #endif
27 #include <stdio.h>
28
29 #include "compat.h"
30
31 #include "notmuch.h"
32
33 NOTMUCH_BEGIN_DECLS
34
35 #include <stdlib.h>
36 #include <stdarg.h>
37 #include <sys/types.h>
38 #include <sys/stat.h>
39 #include <sys/mman.h>
40 #include <string.h>
41 #include <errno.h>
42 #include <fcntl.h>
43 #include <unistd.h>
44 #include <ctype.h>
45 #include <assert.h>
46
47 #include <talloc.h>
48
49 #include "xutil.h"
50
51 #ifdef DEBUG
52 # define DEBUG_DATABASE_SANITY 1
53 # define DEBUG_QUERY 1
54 #endif
55
56 #define COMPILE_TIME_ASSERT(pred) ((void)sizeof(char[1 - 2*!(pred)]))
57
58 /* There's no point in continuing when we've detected that we've done
59  * something wrong internally (as opposed to the user passing in a
60  * bogus value).
61  *
62  * Note that PRINTF_ATTRIBUTE comes from talloc.h
63  */
64 int
65 _internal_error (const char *format, ...) PRINTF_ATTRIBUTE (1, 2);
66
67 /* There's no point in continuing when we've detected that we've done
68  * something wrong internally (as opposed to the user passing in a
69  * bogus value).
70  *
71  * Note that __location__ comes from talloc.h.
72  */
73 #define INTERNAL_ERROR(format, ...)                     \
74     _internal_error (format " (%s).\n",                 \
75                      ##__VA_ARGS__, __location__)
76
77 #define unused(x) x __attribute__ ((unused))
78
79 /* Thanks to Andrew Tridgell's (SAMBA's) talloc for this definition of
80  * unlikely. The talloc source code comes to us via the GNU LGPL v. 3.
81  */
82 /* these macros gain us a few percent of speed on gcc */
83 #if (__GNUC__ >= 3)
84 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
85    as its first argument */
86 #ifndef likely
87 #define likely(x)   __builtin_expect(!!(x), 1)
88 #endif
89 #ifndef unlikely
90 #define unlikely(x) __builtin_expect(!!(x), 0)
91 #endif
92 #else
93 #ifndef likely
94 #define likely(x) (x)
95 #endif
96 #ifndef unlikely
97 #define unlikely(x) (x)
98 #endif
99 #endif
100
101 typedef enum {
102     NOTMUCH_VALUE_TIMESTAMP = 0,
103     NOTMUCH_VALUE_MESSAGE_ID
104 } notmuch_value_t;
105
106 /* Xapian (with flint backend) complains if we provide a term longer
107  * than this, but I haven't yet found a way to query the limit
108  * programmatically. */
109 #define NOTMUCH_TERM_MAX 245
110
111 typedef enum _notmuch_private_status {
112     /* First, copy all the public status values. */
113     NOTMUCH_PRIVATE_STATUS_SUCCESS = NOTMUCH_STATUS_SUCCESS,
114     NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY = NOTMUCH_STATUS_OUT_OF_MEMORY,
115     NOTMUCH_PRIVATE_STATUS_READONLY_DATABASE = NOTMUCH_STATUS_READONLY_DATABASE,
116     NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION = NOTMUCH_STATUS_XAPIAN_EXCEPTION,
117     NOTMUCH_PRIVATE_STATUS_FILE_NOT_EMAIL = NOTMUCH_STATUS_FILE_NOT_EMAIL,
118     NOTMUCH_PRIVATE_STATUS_NULL_POINTER = NOTMUCH_STATUS_NULL_POINTER,
119     NOTMUCH_PRIVATE_STATUS_TAG_TOO_LONG = NOTMUCH_STATUS_TAG_TOO_LONG,
120     NOTMUCH_PRIVATE_STATUS_UNBALANCED_FREEZE_THAW = NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
121
122     /* Then add our own private values. */
123     NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG = NOTMUCH_STATUS_LAST_STATUS,
124     NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND,
125
126     NOTMUCH_PRIVATE_STATUS_LAST_STATUS
127 } notmuch_private_status_t;
128
129 /* Coerce a notmuch_private_status_t value to a notmuch_status_t
130  * value, generating an internal error if the private value is equal
131  * to or greater than NOTMUCH_STATUS_LAST_STATUS. (The idea here is
132  * that the caller has previously handled any expected
133  * notmuch_private_status_t values.)
134  */
135 #define COERCE_STATUS(private_status, format, ...)                      \
136     ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS)\
137      ?                                                                  \
138      (notmuch_status_t) _internal_error (format " (%s).\n",             \
139                                          ##__VA_ARGS__,                 \
140                                          __location__)                  \
141      :                                                                  \
142      (notmuch_status_t) private_status)
143
144 /* database.cc */
145
146 /* Lookup a prefix value by name.
147  *
148  * XXX: This should really be static inside of message.cc, and we can
149  * do that once we convert database.cc to use the
150  * _notmuch_message_add/remove_term functions. */
151 const char *
152 _find_prefix (const char *name);
153
154 const char *
155 _notmuch_database_relative_path (notmuch_database_t *notmuch,
156                                  const char *path);
157
158 notmuch_status_t
159 _notmuch_database_find_parent_id (notmuch_database_t *notmuch,
160                                   const char *path,
161                                   unsigned int *parent_id);
162
163 /* thread.cc */
164
165 notmuch_thread_t *
166 _notmuch_thread_create (void *ctx,
167                         notmuch_database_t *notmuch,
168                         const char *thread_id,
169                         const char *query_string);
170
171 /* message.cc */
172
173 notmuch_message_t *
174 _notmuch_message_create (const void *talloc_owner,
175                          notmuch_database_t *notmuch,
176                          unsigned int doc_id,
177                          notmuch_private_status_t *status);
178
179 notmuch_message_t *
180 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
181                                         const char *message_id,
182                                         notmuch_private_status_t *status);
183
184 const char *
185 _notmuch_message_get_in_reply_to (notmuch_message_t *message);
186
187 notmuch_private_status_t
188 _notmuch_message_add_term (notmuch_message_t *message,
189                            const char *prefix_name,
190                            const char *value);
191
192 notmuch_private_status_t
193 _notmuch_message_remove_term (notmuch_message_t *message,
194                               const char *prefix_name,
195                               const char *value);
196
197 notmuch_private_status_t
198 _notmuch_message_gen_terms (notmuch_message_t *message,
199                             const char *prefix_name,
200                             const char *text);
201
202 void
203 _notmuch_message_set_filename (notmuch_message_t *message,
204                                const char *filename);
205
206 void
207 _notmuch_message_ensure_thread_id (notmuch_message_t *message);
208
209 void
210 _notmuch_message_set_date (notmuch_message_t *message,
211                            const char *date);
212
213 void
214 _notmuch_message_sync (notmuch_message_t *message);
215
216 void
217 _notmuch_message_close (notmuch_message_t *message);
218
219 /* index.cc */
220
221 notmuch_status_t
222 _notmuch_message_index_file (notmuch_message_t *message,
223                              const char *filename);
224
225 /* message-file.c */
226
227 /* XXX: I haven't decided yet whether these will actually get exported
228  * into the public interface in notmuch.h
229  */
230
231 typedef struct _notmuch_message_file notmuch_message_file_t;
232
233 /* Open a file containing a single email message.
234  *
235  * The caller should call notmuch_message_close when done with this.
236  *
237  * Returns NULL if any error occurs.
238  */
239 notmuch_message_file_t *
240 notmuch_message_file_open (const char *filename);
241
242 /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */
243 notmuch_message_file_t *
244 _notmuch_message_file_open_ctx (void *ctx, const char *filename);
245
246 /* Close a notmuch message previously opened with notmuch_message_open. */
247 void
248 notmuch_message_file_close (notmuch_message_file_t *message);
249
250 /* Restrict 'message' to only save the named headers.
251  *
252  * When the caller is only interested in a short list of headers,
253  * known in advance, calling this function can avoid wasted time and
254  * memory parsing/saving header values that will never be needed.
255  *
256  * The variable arguments should be a list of const char * with a
257  * final '(const char *) NULL' to terminate the list.
258  *
259  * If this function is called, it must be called before any calls to
260  * notmuch_message_get_header for this message.
261  *
262  * After calling this function, if notmuch_message_get_header is
263  * called with a header name not in this list, then NULL will be
264  * returned even if that header exists in the actual message.
265  */
266 void
267 notmuch_message_file_restrict_headers (notmuch_message_file_t *message, ...);
268
269 /* Identical to notmuch_message_restrict_headers but accepting a va_list. */
270 void
271 notmuch_message_file_restrict_headersv (notmuch_message_file_t *message,
272                                         va_list va_headers);
273
274 /* Get the value of the specified header from the message.
275  *
276  * The header name is case insensitive.
277  *
278  * The returned value is owned by the notmuch message and is valid
279  * only until the message is closed. The caller should copy it if
280  * needing to modify the value or to hold onto it for longer.
281  *
282  * Returns NULL if the message does not contain a header line matching
283  * 'header'.
284  */
285 const char *
286 notmuch_message_file_get_header (notmuch_message_file_t *message,
287                                  const char *header);
288
289 /* messages.c */
290
291 typedef struct _notmuch_message_node {
292     notmuch_message_t *message;
293     struct _notmuch_message_node *next;
294 } notmuch_message_node_t;
295
296 typedef struct _notmuch_message_list {
297     notmuch_message_node_t *head;
298     notmuch_message_node_t **tail;
299 } notmuch_message_list_t;
300
301 /* There's a rumor that there's an alternate struct _notmuch_messages
302  * somewhere with some nasty C++ objects in it. We'll try to maintain
303  * ignorance of that here. (See notmuch_mset_messages_t in query.cc)
304  */
305 struct _notmuch_messages {
306     notmuch_bool_t is_of_list_type;
307     notmuch_message_node_t *iterator;
308 };
309
310 notmuch_message_list_t *
311 _notmuch_message_list_create (const void *ctx);
312
313 void
314 _notmuch_message_list_append (notmuch_message_list_t *list,
315                               notmuch_message_node_t *node);
316
317 void
318 _notmuch_message_list_add_message (notmuch_message_list_t *list,
319                                    notmuch_message_t *message);
320
321 notmuch_messages_t *
322 _notmuch_messages_create (notmuch_message_list_t *list);
323
324 /* query.cc */
325
326 notmuch_bool_t
327 _notmuch_mset_messages_has_more (notmuch_messages_t *messages);
328
329 notmuch_message_t *
330 _notmuch_mset_messages_get (notmuch_messages_t *messages);
331
332 void
333 _notmuch_mset_messages_advance (notmuch_messages_t *messages);
334
335 /* message.cc */
336
337 void
338 _notmuch_message_add_reply (notmuch_message_t *message,
339                             notmuch_message_node_t *reply);
340
341 /* sha1.c */
342
343 char *
344 notmuch_sha1_of_string (const char *str);
345
346 char *
347 notmuch_sha1_of_file (const char *filename);
348
349 /* tags.c */
350
351 notmuch_tags_t *
352 _notmuch_tags_create (void *ctx);
353
354 void
355 _notmuch_tags_add_tag (notmuch_tags_t *tags, const char *tag);
356
357 void
358 _notmuch_tags_prepare_iterator (notmuch_tags_t *tags);
359
360 NOTMUCH_END_DECLS
361
362 #endif