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>
50 #include "error_util.h"
52 #pragma GCC visibility push(hidden)
55 # define DEBUG_DATABASE_SANITY 1
56 # define DEBUG_QUERY 1
59 #define COMPILE_TIME_ASSERT(pred) ((void)sizeof(char[1 - 2*!(pred)]))
61 #define STRNCMP_LITERAL(var, literal) \
62 strncmp ((var), (literal), sizeof (literal) - 1)
64 #define unused(x) x __attribute__ ((unused))
67 # define visible __attribute__((visibility("default")))
72 /* Thanks to Andrew Tridgell's (SAMBA's) talloc for this definition of
73 * unlikely. The talloc source code comes to us via the GNU LGPL v. 3.
75 /* these macros gain us a few percent of speed on gcc */
77 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
78 as its first argument */
80 #define likely(x) __builtin_expect(!!(x), 1)
83 #define unlikely(x) __builtin_expect(!!(x), 0)
90 #define unlikely(x) (x)
95 NOTMUCH_VALUE_TIMESTAMP = 0,
96 NOTMUCH_VALUE_MESSAGE_ID,
101 /* Xapian (with flint backend) complains if we provide a term longer
102 * than this, but I haven't yet found a way to query the limit
103 * programmatically. */
104 #define NOTMUCH_TERM_MAX 245
106 #define NOTMUCH_METADATA_THREAD_ID_PREFIX "thread_id_"
108 /* For message IDs we have to be even more restrictive. Beyond fitting
109 * into the term limit, we also use message IDs to construct
110 * metadata-key values. And the documentation says that these should
111 * be restricted to about 200 characters. (The actual limit for the
112 * chert backend at least is 252.)
114 #define NOTMUCH_MESSAGE_ID_MAX (200 - sizeof (NOTMUCH_METADATA_THREAD_ID_PREFIX))
116 typedef enum _notmuch_private_status {
117 /* First, copy all the public status values. */
118 NOTMUCH_PRIVATE_STATUS_SUCCESS = NOTMUCH_STATUS_SUCCESS,
119 NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY = NOTMUCH_STATUS_OUT_OF_MEMORY,
120 NOTMUCH_PRIVATE_STATUS_READ_ONLY_DATABASE = NOTMUCH_STATUS_READ_ONLY_DATABASE,
121 NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION = NOTMUCH_STATUS_XAPIAN_EXCEPTION,
122 NOTMUCH_PRIVATE_STATUS_FILE_NOT_EMAIL = NOTMUCH_STATUS_FILE_NOT_EMAIL,
123 NOTMUCH_PRIVATE_STATUS_NULL_POINTER = NOTMUCH_STATUS_NULL_POINTER,
124 NOTMUCH_PRIVATE_STATUS_TAG_TOO_LONG = NOTMUCH_STATUS_TAG_TOO_LONG,
125 NOTMUCH_PRIVATE_STATUS_UNBALANCED_FREEZE_THAW = NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
127 /* Then add our own private values. */
128 NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG = NOTMUCH_STATUS_LAST_STATUS,
129 NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND,
131 NOTMUCH_PRIVATE_STATUS_LAST_STATUS
132 } notmuch_private_status_t;
134 /* Coerce a notmuch_private_status_t value to a notmuch_status_t
135 * value, generating an internal error if the private value is equal
136 * to or greater than NOTMUCH_STATUS_LAST_STATUS. (The idea here is
137 * that the caller has previously handled any expected
138 * notmuch_private_status_t values.)
140 * Note that the function _internal_error does not return. Evaluating
141 * to NOTMUCH_STATUS_SUCCESS is done purely to appease the compiler.
143 #define COERCE_STATUS(private_status, format, ...) \
144 ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS)\
146 _internal_error (format " (%s).\n", \
149 (notmuch_status_t) NOTMUCH_PRIVATE_STATUS_SUCCESS \
151 (notmuch_status_t) private_status)
153 /* Flags shared by various lookup functions. */
154 typedef enum _notmuch_find_flags {
155 /* Lookup without creating any documents. This is the default
157 NOTMUCH_FIND_LOOKUP = 0,
158 /* If set, create the necessary document (or documents) if they
159 * are missing. Requires a read/write database. */
160 NOTMUCH_FIND_CREATE = 1<<0,
161 } notmuch_find_flags_t;
163 typedef struct _notmuch_doc_id_set notmuch_doc_id_set_t;
167 /* Lookup a prefix value by name.
169 * XXX: This should really be static inside of message.cc, and we can
170 * do that once we convert database.cc to use the
171 * _notmuch_message_add/remove_term functions. */
173 _find_prefix (const char *name);
176 _notmuch_database_ensure_writable (notmuch_database_t *notmuch);
179 _notmuch_database_relative_path (notmuch_database_t *notmuch,
183 _notmuch_database_split_path (void *ctx,
185 const char **directory,
186 const char **basename);
189 _notmuch_database_get_directory_db_path (const char *path);
192 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch);
194 notmuch_private_status_t
195 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
196 const char *prefix_name,
198 unsigned int *doc_id);
201 _notmuch_database_find_directory_id (notmuch_database_t *database,
203 notmuch_find_flags_t flags,
204 unsigned int *directory_id);
207 _notmuch_database_get_directory_path (void *ctx,
208 notmuch_database_t *notmuch,
209 unsigned int doc_id);
212 _notmuch_database_filename_to_direntry (void *ctx,
213 notmuch_database_t *notmuch,
214 const char *filename,
215 notmuch_find_flags_t flags,
220 notmuch_directory_t *
221 _notmuch_directory_create (notmuch_database_t *notmuch,
223 notmuch_find_flags_t flags,
224 notmuch_status_t *status_ret);
227 _notmuch_directory_get_document_id (notmuch_directory_t *directory);
232 _notmuch_message_create (const void *talloc_owner,
233 notmuch_database_t *notmuch,
235 notmuch_private_status_t *status);
238 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
239 const char *message_id,
240 notmuch_private_status_t *status);
243 _notmuch_message_get_doc_id (notmuch_message_t *message);
246 _notmuch_message_get_in_reply_to (notmuch_message_t *message);
248 notmuch_private_status_t
249 _notmuch_message_add_term (notmuch_message_t *message,
250 const char *prefix_name,
253 notmuch_private_status_t
254 _notmuch_message_remove_term (notmuch_message_t *message,
255 const char *prefix_name,
258 notmuch_private_status_t
259 _notmuch_message_gen_terms (notmuch_message_t *message,
260 const char *prefix_name,
264 _notmuch_message_upgrade_filename_storage (notmuch_message_t *message);
267 _notmuch_message_upgrade_folder (notmuch_message_t *message);
270 _notmuch_message_add_filename (notmuch_message_t *message,
271 const char *filename);
274 _notmuch_message_remove_filename (notmuch_message_t *message,
275 const char *filename);
278 _notmuch_message_rename (notmuch_message_t *message,
279 const char *new_filename);
282 _notmuch_message_ensure_thread_id (notmuch_message_t *message);
285 _notmuch_message_set_header_values (notmuch_message_t *message,
288 const char *subject);
290 _notmuch_message_sync (notmuch_message_t *message);
293 _notmuch_message_delete (notmuch_message_t *message);
296 _notmuch_message_close (notmuch_message_t *message);
298 /* Get a copy of the data in this message document.
300 * Caller should talloc_free the result when done.
302 * This function is intended to support database upgrade and really
303 * shouldn't be used otherwise. */
305 _notmuch_message_talloc_copy_data (notmuch_message_t *message);
307 /* Clear the data in this message document.
309 * This function is intended to support database upgrade and really
310 * shouldn't be used otherwise. */
312 _notmuch_message_clear_data (notmuch_message_t *message);
314 /* Set the author member of 'message' - this is the representation used
315 * when displaying the message */
317 notmuch_message_set_author (notmuch_message_t *message, const char *author);
319 /* Get the author member of 'message' */
321 notmuch_message_get_author (notmuch_message_t *message);
327 _notmuch_message_index_file (notmuch_message_t *message,
328 const char *filename);
332 /* XXX: I haven't decided yet whether these will actually get exported
333 * into the public interface in notmuch.h
336 typedef struct _notmuch_message_file notmuch_message_file_t;
338 /* Open a file containing a single email message.
340 * The caller should call notmuch_message_close when done with this.
342 * Returns NULL if any error occurs.
344 notmuch_message_file_t *
345 notmuch_message_file_open (const char *filename);
347 /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */
348 notmuch_message_file_t *
349 _notmuch_message_file_open_ctx (void *ctx, const char *filename);
351 /* Close a notmuch message previously opened with notmuch_message_open. */
353 notmuch_message_file_close (notmuch_message_file_t *message);
355 /* Restrict 'message' to only save the named headers.
357 * When the caller is only interested in a short list of headers,
358 * known in advance, calling this function can avoid wasted time and
359 * memory parsing/saving header values that will never be needed.
361 * The variable arguments should be a list of const char * with a
362 * final '(const char *) NULL' to terminate the list.
364 * If this function is called, it must be called before any calls to
365 * notmuch_message_get_header for this message.
367 * After calling this function, if notmuch_message_get_header is
368 * called with a header name not in this list, then NULL will be
369 * returned even if that header exists in the actual message.
372 notmuch_message_file_restrict_headers (notmuch_message_file_t *message, ...);
374 /* Identical to notmuch_message_restrict_headers but accepting a va_list. */
376 notmuch_message_file_restrict_headersv (notmuch_message_file_t *message,
379 /* Get the value of the specified header from the message as a UTF-8 string.
381 * The header name is case insensitive.
383 * The Received: header is special - for it all Received: headers in
384 * the message are concatenated
386 * The returned value is owned by the notmuch message and is valid
387 * only until the message is closed. The caller should copy it if
388 * needing to modify the value or to hold onto it for longer.
390 * Returns NULL if the message does not contain a header line matching
394 notmuch_message_file_get_header (notmuch_message_file_t *message,
399 typedef struct _notmuch_message_node {
400 notmuch_message_t *message;
401 struct _notmuch_message_node *next;
402 } notmuch_message_node_t;
404 typedef struct _notmuch_message_list {
405 notmuch_message_node_t *head;
406 notmuch_message_node_t **tail;
407 } notmuch_message_list_t;
409 /* There's a rumor that there's an alternate struct _notmuch_messages
410 * somewhere with some nasty C++ objects in it. We'll try to maintain
411 * ignorance of that here. (See notmuch_mset_messages_t in query.cc)
413 struct visible _notmuch_messages {
414 notmuch_bool_t is_of_list_type;
415 notmuch_doc_id_set_t *excluded_doc_ids;
416 notmuch_message_node_t *iterator;
419 notmuch_message_list_t *
420 _notmuch_message_list_create (const void *ctx);
423 _notmuch_message_list_add_message (notmuch_message_list_t *list,
424 notmuch_message_t *message);
427 _notmuch_messages_create (notmuch_message_list_t *list);
432 _notmuch_mset_messages_valid (notmuch_messages_t *messages);
435 _notmuch_mset_messages_get (notmuch_messages_t *messages);
438 _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages);
441 _notmuch_doc_id_set_contains (notmuch_doc_id_set_t *doc_ids,
442 unsigned int doc_id);
445 _notmuch_doc_id_set_remove (notmuch_doc_id_set_t *doc_ids,
446 unsigned int doc_id);
451 _notmuch_message_add_reply (notmuch_message_t *message,
452 notmuch_message_t *reply);
457 notmuch_sha1_of_string (const char *str);
460 notmuch_sha1_of_file (const char *filename);
464 typedef struct _notmuch_string_node {
466 struct _notmuch_string_node *next;
467 } notmuch_string_node_t;
469 typedef struct visible _notmuch_string_list {
471 notmuch_string_node_t *head;
472 notmuch_string_node_t **tail;
473 } notmuch_string_list_t;
475 notmuch_string_list_t *
476 _notmuch_string_list_create (const void *ctx);
478 /* Add 'string' to 'list'.
480 * The list will create its own talloced copy of 'string'.
483 _notmuch_string_list_append (notmuch_string_list_t *list,
487 _notmuch_string_list_sort (notmuch_string_list_t *list);
492 _notmuch_tags_create (const void *ctx, notmuch_string_list_t *list);
496 /* The notmuch_filenames_t iterates over a notmuch_string_list_t of
498 notmuch_filenames_t *
499 _notmuch_filenames_create (const void *ctx,
500 notmuch_string_list_t *list);
505 _notmuch_thread_create (void *ctx,
506 notmuch_database_t *notmuch,
507 unsigned int seed_doc_id,
508 notmuch_doc_id_set_t *match_set,
509 notmuch_string_list_t *excluded_terms,
510 notmuch_exclude_t omit_exclude,
511 notmuch_sort_t sort);
516 /* Implicit typecast from 'void *' to 'T *' is okay in C, but not in
517 * C++. In talloc_steal, an explicit cast is provided for type safety
518 * in some GCC versions. Otherwise, a cast is required. Provide a
519 * template function for this to maintain type safety, and redefine
520 * talloc_steal to use it.
523 template <class T> T *
524 _notmuch_talloc_steal (const void *new_ctx, const T *ptr)
526 return static_cast<T *> (talloc_steal (new_ctx, ptr));
529 #define talloc_steal _notmuch_talloc_steal
533 #pragma GCC visibility pop