1 /* notmuch-private.h - Internal interfaces for notmuch.
3 * Copyright © 2009 Carl Worth
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.
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.
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/ .
18 * Author: Carl Worth <cworth@cworth.org>
21 #ifndef NOTMUCH_PRIVATE_H
22 #define NOTMUCH_PRIVATE_H
25 #define _GNU_SOURCE /* For getline and asprintf */
37 #include <sys/types.h>
51 #pragma GCC visibility push(hidden)
54 # define DEBUG_DATABASE_SANITY 1
55 # define DEBUG_QUERY 1
58 #define COMPILE_TIME_ASSERT(pred) ((void)sizeof(char[1 - 2*!(pred)]))
60 #define STRNCMP_LITERAL(var, literal) \
61 strncmp ((var), (literal), sizeof (literal) - 1)
63 /* There's no point in continuing when we've detected that we've done
64 * something wrong internally (as opposed to the user passing in a
67 * Note that PRINTF_ATTRIBUTE comes from talloc.h
70 _internal_error (const char *format, ...) PRINTF_ATTRIBUTE (1, 2);
72 /* There's no point in continuing when we've detected that we've done
73 * something wrong internally (as opposed to the user passing in a
76 * Note that __location__ comes from talloc.h.
78 #define INTERNAL_ERROR(format, ...) \
79 _internal_error (format " (%s).\n", \
80 ##__VA_ARGS__, __location__)
82 #define unused(x) x __attribute__ ((unused))
85 # define visible __attribute__((visibility("default")))
90 /* Thanks to Andrew Tridgell's (SAMBA's) talloc for this definition of
91 * unlikely. The talloc source code comes to us via the GNU LGPL v. 3.
93 /* these macros gain us a few percent of speed on gcc */
95 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
96 as its first argument */
98 #define likely(x) __builtin_expect(!!(x), 1)
101 #define unlikely(x) __builtin_expect(!!(x), 0)
105 #define likely(x) (x)
108 #define unlikely(x) (x)
113 NOTMUCH_VALUE_TIMESTAMP = 0,
114 NOTMUCH_VALUE_MESSAGE_ID
117 /* Xapian (with flint backend) complains if we provide a term longer
118 * than this, but I haven't yet found a way to query the limit
119 * programmatically. */
120 #define NOTMUCH_TERM_MAX 245
122 #define NOTMUCH_METADATA_THREAD_ID_PREFIX "thread_id_"
124 /* For message IDs we have to be even more restrictive. Beyond fitting
125 * into the term limit, we also use message IDs to construct
126 * metadata-key values. And the documentation says that these should
127 * be restricted to about 200 characters. (The actual limit for the
128 * chert backend at least is 252.)
130 #define NOTMUCH_MESSAGE_ID_MAX (200 - sizeof (NOTMUCH_METADATA_THREAD_ID_PREFIX))
132 typedef enum _notmuch_private_status {
133 /* First, copy all the public status values. */
134 NOTMUCH_PRIVATE_STATUS_SUCCESS = NOTMUCH_STATUS_SUCCESS,
135 NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY = NOTMUCH_STATUS_OUT_OF_MEMORY,
136 NOTMUCH_PRIVATE_STATUS_READ_ONLY_DATABASE = NOTMUCH_STATUS_READ_ONLY_DATABASE,
137 NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION = NOTMUCH_STATUS_XAPIAN_EXCEPTION,
138 NOTMUCH_PRIVATE_STATUS_FILE_NOT_EMAIL = NOTMUCH_STATUS_FILE_NOT_EMAIL,
139 NOTMUCH_PRIVATE_STATUS_NULL_POINTER = NOTMUCH_STATUS_NULL_POINTER,
140 NOTMUCH_PRIVATE_STATUS_TAG_TOO_LONG = NOTMUCH_STATUS_TAG_TOO_LONG,
141 NOTMUCH_PRIVATE_STATUS_UNBALANCED_FREEZE_THAW = NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
143 /* Then add our own private values. */
144 NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG = NOTMUCH_STATUS_LAST_STATUS,
145 NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND,
147 NOTMUCH_PRIVATE_STATUS_LAST_STATUS
148 } notmuch_private_status_t;
150 /* Coerce a notmuch_private_status_t value to a notmuch_status_t
151 * value, generating an internal error if the private value is equal
152 * to or greater than NOTMUCH_STATUS_LAST_STATUS. (The idea here is
153 * that the caller has previously handled any expected
154 * notmuch_private_status_t values.)
156 #define COERCE_STATUS(private_status, format, ...) \
157 ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS)\
159 (notmuch_status_t) _internal_error (format " (%s).\n", \
163 (notmuch_status_t) private_status)
165 typedef struct _notmuch_doc_id_set notmuch_doc_id_set_t;
169 /* Lookup a prefix value by name.
171 * XXX: This should really be static inside of message.cc, and we can
172 * do that once we convert database.cc to use the
173 * _notmuch_message_add/remove_term functions. */
175 _find_prefix (const char *name);
178 _notmuch_database_ensure_writable (notmuch_database_t *notmuch);
181 _notmuch_database_relative_path (notmuch_database_t *notmuch,
185 _notmuch_database_split_path (void *ctx,
187 const char **directory,
188 const char **basename);
191 _notmuch_database_get_directory_db_path (const char *path);
194 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch);
196 notmuch_private_status_t
197 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
198 const char *prefix_name,
200 unsigned int *doc_id);
203 _notmuch_database_find_directory_id (notmuch_database_t *database,
205 unsigned int *directory_id);
208 _notmuch_database_get_directory_path (void *ctx,
209 notmuch_database_t *notmuch,
210 unsigned int doc_id);
213 _notmuch_database_filename_to_direntry (void *ctx,
214 notmuch_database_t *notmuch,
215 const char *filename,
220 notmuch_directory_t *
221 _notmuch_directory_create (notmuch_database_t *notmuch,
223 notmuch_status_t *status_ret);
226 _notmuch_directory_get_document_id (notmuch_directory_t *directory);
231 _notmuch_thread_create (void *ctx,
232 notmuch_database_t *notmuch,
233 unsigned int seed_doc_id,
234 notmuch_doc_id_set_t *match_set,
235 notmuch_sort_t sort);
240 _notmuch_message_create (const void *talloc_owner,
241 notmuch_database_t *notmuch,
243 notmuch_private_status_t *status);
246 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
247 const char *message_id,
248 notmuch_private_status_t *status);
251 _notmuch_message_get_doc_id (notmuch_message_t *message);
254 _notmuch_message_get_in_reply_to (notmuch_message_t *message);
256 notmuch_private_status_t
257 _notmuch_message_add_term (notmuch_message_t *message,
258 const char *prefix_name,
261 notmuch_private_status_t
262 _notmuch_message_remove_term (notmuch_message_t *message,
263 const char *prefix_name,
266 notmuch_private_status_t
267 _notmuch_message_gen_terms (notmuch_message_t *message,
268 const char *prefix_name,
272 _notmuch_message_upgrade_filename_storage (notmuch_message_t *message);
275 _notmuch_message_add_filename (notmuch_message_t *message,
276 const char *filename);
279 _notmuch_message_remove_filename (notmuch_message_t *message,
280 const char *filename);
283 _notmuch_message_rename (notmuch_message_t *message,
284 const char *new_filename);
287 _notmuch_message_ensure_thread_id (notmuch_message_t *message);
290 _notmuch_message_set_date (notmuch_message_t *message,
294 _notmuch_message_sync (notmuch_message_t *message);
297 _notmuch_message_delete (notmuch_message_t *message);
300 _notmuch_message_close (notmuch_message_t *message);
302 /* Get a copy of the data in this message document.
304 * Caller should talloc_free the result when done.
306 * This function is intended to support database upgrade and really
307 * shouldn't be used otherwise. */
309 _notmuch_message_talloc_copy_data (notmuch_message_t *message);
311 /* Clear the data in this message document.
313 * This function is intended to support database upgrade and really
314 * shouldn't be used otherwise. */
316 _notmuch_message_clear_data (notmuch_message_t *message);
318 /* Set the author member of 'message' - this is the representation used
319 * when displaying the message */
321 notmuch_message_set_author (notmuch_message_t *message, const char *author);
323 /* Get the author member of 'message' */
325 notmuch_message_get_author (notmuch_message_t *message);
331 _notmuch_message_index_file (notmuch_message_t *message,
332 const char *filename);
336 /* XXX: I haven't decided yet whether these will actually get exported
337 * into the public interface in notmuch.h
340 typedef struct _notmuch_message_file notmuch_message_file_t;
342 /* Open a file containing a single email message.
344 * The caller should call notmuch_message_close when done with this.
346 * Returns NULL if any error occurs.
348 notmuch_message_file_t *
349 notmuch_message_file_open (const char *filename);
351 /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */
352 notmuch_message_file_t *
353 _notmuch_message_file_open_ctx (void *ctx, const char *filename);
355 /* Close a notmuch message previously opened with notmuch_message_open. */
357 notmuch_message_file_close (notmuch_message_file_t *message);
359 /* Restrict 'message' to only save the named headers.
361 * When the caller is only interested in a short list of headers,
362 * known in advance, calling this function can avoid wasted time and
363 * memory parsing/saving header values that will never be needed.
365 * The variable arguments should be a list of const char * with a
366 * final '(const char *) NULL' to terminate the list.
368 * If this function is called, it must be called before any calls to
369 * notmuch_message_get_header for this message.
371 * After calling this function, if notmuch_message_get_header is
372 * called with a header name not in this list, then NULL will be
373 * returned even if that header exists in the actual message.
376 notmuch_message_file_restrict_headers (notmuch_message_file_t *message, ...);
378 /* Identical to notmuch_message_restrict_headers but accepting a va_list. */
380 notmuch_message_file_restrict_headersv (notmuch_message_file_t *message,
383 /* Get the value of the specified header from the message.
385 * The header name is case insensitive.
387 * The Received: header is special - for it all Received: headers in
388 * the message are concatenated
390 * The returned value is owned by the notmuch message and is valid
391 * only until the message is closed. The caller should copy it if
392 * needing to modify the value or to hold onto it for longer.
394 * Returns NULL if the message does not contain a header line matching
398 notmuch_message_file_get_header (notmuch_message_file_t *message,
403 typedef struct _notmuch_message_node {
404 notmuch_message_t *message;
405 struct _notmuch_message_node *next;
406 } notmuch_message_node_t;
408 typedef struct _notmuch_message_list {
409 notmuch_message_node_t *head;
410 notmuch_message_node_t **tail;
411 } notmuch_message_list_t;
413 /* There's a rumor that there's an alternate struct _notmuch_messages
414 * somewhere with some nasty C++ objects in it. We'll try to maintain
415 * ignorance of that here. (See notmuch_mset_messages_t in query.cc)
417 struct visible _notmuch_messages {
418 notmuch_bool_t is_of_list_type;
419 notmuch_message_node_t *iterator;
422 notmuch_message_list_t *
423 _notmuch_message_list_create (const void *ctx);
426 _notmuch_message_list_append (notmuch_message_list_t *list,
427 notmuch_message_node_t *node);
430 _notmuch_message_list_add_message (notmuch_message_list_t *list,
431 notmuch_message_t *message);
434 _notmuch_messages_create (notmuch_message_list_t *list);
439 _notmuch_mset_messages_valid (notmuch_messages_t *messages);
442 _notmuch_mset_messages_get (notmuch_messages_t *messages);
445 _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages);
448 _notmuch_doc_id_set_contains (notmuch_doc_id_set_t *doc_ids,
449 unsigned int doc_id);
452 _notmuch_doc_id_set_remove (notmuch_doc_id_set_t *doc_ids,
453 unsigned int doc_id);
458 _notmuch_message_add_reply (notmuch_message_t *message,
459 notmuch_message_node_t *reply);
464 notmuch_sha1_of_string (const char *str);
467 notmuch_sha1_of_file (const char *filename);
471 typedef struct _notmuch_string_node {
473 struct _notmuch_string_node *next;
474 } notmuch_string_node_t;
476 typedef struct _notmuch_string_list {
478 notmuch_string_node_t *head;
479 notmuch_string_node_t **tail;
480 } notmuch_string_list_t;
482 notmuch_string_list_t *
483 _notmuch_string_list_create (const void *ctx);
485 /* Add 'string' to 'list'.
487 * The list will create its own talloced copy of 'string'.
490 _notmuch_string_list_append (notmuch_string_list_t *list,
494 _notmuch_string_list_sort (notmuch_string_list_t *list);
499 _notmuch_tags_create (const void *ctx, notmuch_string_list_t *list);
503 /* The notmuch_filenames_t iterates over a notmuch_string_list_t of
505 notmuch_filenames_t *
506 _notmuch_filenames_create (const void *ctx,
507 notmuch_string_list_t *list);
509 #pragma GCC visibility pop