Nuke the remainings of _notmuch_message_add_thread_id.
[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
121     /* Then add our own private values. */
122     NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG,
123     NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND,
124
125     NOTMUCH_PRIVATE_STATUS_LAST_STATUS
126 } notmuch_private_status_t;
127
128 /* Coerce a notmuch_private_status_t value to a notmuch_status_t
129  * value, generating an internal error if the private value is equal
130  * to or greater than NOTMUCH_STATUS_LAST_STATUS. (The idea here is
131  * that the caller has previously handled any expected
132  * notmuch_private_status_t values.)
133  */
134 #define COERCE_STATUS(private_status, format, ...)                      \
135     ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS)\
136      ?                                                                  \
137      (notmuch_status_t) _internal_error (format " (%s).\n",             \
138                                          ##__VA_ARGS__,                 \
139                                          __location__)                  \
140      :                                                                  \
141      (notmuch_status_t) private_status)
142
143 /* database.cc */
144
145 /* Lookup a prefix value by name.
146  *
147  * XXX: This should really be static inside of message.cc, and we can
148  * do that once we convert database.cc to use the
149  * _notmuch_message_add/remove_term functions. */
150 const char *
151 _find_prefix (const char *name);
152
153 /* thread.cc */
154
155 notmuch_thread_t *
156 _notmuch_thread_create (void *ctx,
157                         notmuch_database_t *notmuch,
158                         const char *thread_id,
159                         const char *query_string);
160
161 /* message.cc */
162
163 notmuch_message_t *
164 _notmuch_message_create (const void *talloc_owner,
165                          notmuch_database_t *notmuch,
166                          unsigned int doc_id,
167                          notmuch_private_status_t *status);
168
169 notmuch_message_t *
170 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
171                                         const char *message_id,
172                                         notmuch_private_status_t *status);
173
174 const char *
175 _notmuch_message_get_in_reply_to (notmuch_message_t *message);
176
177 notmuch_private_status_t
178 _notmuch_message_add_term (notmuch_message_t *message,
179                            const char *prefix_name,
180                            const char *value);
181
182 notmuch_private_status_t
183 _notmuch_message_remove_term (notmuch_message_t *message,
184                               const char *prefix_name,
185                               const char *value);
186
187 notmuch_private_status_t
188 _notmuch_message_gen_terms (notmuch_message_t *message,
189                             const char *prefix_name,
190                             const char *text);
191
192 void
193 _notmuch_message_set_filename (notmuch_message_t *message,
194                                const char *filename);
195
196 void
197 _notmuch_message_ensure_thread_id (notmuch_message_t *message);
198
199 void
200 _notmuch_message_set_date (notmuch_message_t *message,
201                            const char *date);
202
203 void
204 _notmuch_message_sync (notmuch_message_t *message);
205
206 void
207 _notmuch_message_close (notmuch_message_t *message);
208
209 /* index.cc */
210
211 notmuch_status_t
212 _notmuch_message_index_file (notmuch_message_t *message,
213                              const char *filename);
214
215 /* message-file.c */
216
217 /* XXX: I haven't decided yet whether these will actually get exported
218  * into the public interface in notmuch.h
219  */
220
221 typedef struct _notmuch_message_file notmuch_message_file_t;
222
223 /* Open a file containing a single email message.
224  *
225  * The caller should call notmuch_message_close when done with this.
226  *
227  * Returns NULL if any error occurs.
228  */
229 notmuch_message_file_t *
230 notmuch_message_file_open (const char *filename);
231
232 /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */
233 notmuch_message_file_t *
234 _notmuch_message_file_open_ctx (void *ctx, const char *filename);
235
236 /* Close a notmuch message previously opened with notmuch_message_open. */
237 void
238 notmuch_message_file_close (notmuch_message_file_t *message);
239
240 /* Restrict 'message' to only save the named headers.
241  *
242  * When the caller is only interested in a short list of headers,
243  * known in advance, calling this function can avoid wasted time and
244  * memory parsing/saving header values that will never be needed.
245  *
246  * The variable arguments should be a list of const char * with a
247  * final '(const char *) NULL' to terminate the list.
248  *
249  * If this function is called, it must be called before any calls to
250  * notmuch_message_get_header for this message.
251  *
252  * After calling this function, if notmuch_message_get_header is
253  * called with a header name not in this list, then NULL will be
254  * returned even if that header exists in the actual message.
255  */
256 void
257 notmuch_message_file_restrict_headers (notmuch_message_file_t *message, ...);
258
259 /* Identical to notmuch_message_restrict_headers but accepting a va_list. */
260 void
261 notmuch_message_file_restrict_headersv (notmuch_message_file_t *message,
262                                         va_list va_headers);
263
264 /* Get the value of the specified header from the message.
265  *
266  * The header name is case insensitive.
267  *
268  * The returned value is owned by the notmuch message and is valid
269  * only until the message is closed. The caller should copy it if
270  * needing to modify the value or to hold onto it for longer.
271  *
272  * Returns NULL if the message does not contain a header line matching
273  * 'header'.
274  */
275 const char *
276 notmuch_message_file_get_header (notmuch_message_file_t *message,
277                                  const char *header);
278
279 /* messages.c */
280
281 typedef struct _notmuch_message_node {
282     notmuch_message_t *message;
283     struct _notmuch_message_node *next;
284 } notmuch_message_node_t;
285
286 typedef struct _notmuch_message_list {
287     notmuch_message_node_t *head;
288     notmuch_message_node_t **tail;
289 } notmuch_message_list_t;
290
291 /* There's a rumor that there's an alternate struct _notmuch_messages
292  * somewhere with some nasty C++ objects in it. We'll try to maintain
293  * ignorance of that here. (See notmuch_mset_messages_t in query.cc)
294  */
295 struct _notmuch_messages {
296     notmuch_bool_t is_of_list_type;
297     notmuch_message_node_t *iterator;
298 };
299
300 notmuch_message_list_t *
301 _notmuch_message_list_create (const void *ctx);
302
303 void
304 _notmuch_message_list_append (notmuch_message_list_t *list,
305                               notmuch_message_node_t *node);
306
307 void
308 _notmuch_message_list_add_message (notmuch_message_list_t *list,
309                                    notmuch_message_t *message);
310
311 notmuch_messages_t *
312 _notmuch_messages_create (notmuch_message_list_t *list);
313
314 /* query.cc */
315
316 notmuch_bool_t
317 _notmuch_mset_messages_has_more (notmuch_messages_t *messages);
318
319 notmuch_message_t *
320 _notmuch_mset_messages_get (notmuch_messages_t *messages);
321
322 void
323 _notmuch_mset_messages_advance (notmuch_messages_t *messages);
324
325 /* message.cc */
326
327 void
328 _notmuch_message_add_reply (notmuch_message_t *message,
329                             notmuch_message_node_t *reply);
330
331 /* sha1.c */
332
333 char *
334 notmuch_sha1_of_string (const char *str);
335
336 char *
337 notmuch_sha1_of_file (const char *filename);
338
339 /* tags.c */
340
341 notmuch_tags_t *
342 _notmuch_tags_create (void *ctx);
343
344 void
345 _notmuch_tags_add_tag (notmuch_tags_t *tags, const char *tag);
346
347 void
348 _notmuch_tags_prepare_iterator (notmuch_tags_t *tags);
349
350 NOTMUCH_END_DECLS
351
352 #endif