X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch-private.h;h=d257f2b92c52294efe235d3d6377ce9750c82f72;hp=a8ec8ebeee1371e9a5522669a1515be2394ae6d6;hb=1ba3d46f;hpb=b6dd413903370bd9b4f50428a32276f1f8457937 diff --git a/notmuch-private.h b/notmuch-private.h index a8ec8ebe..d257f2b9 100644 --- a/notmuch-private.h +++ b/notmuch-private.h @@ -21,13 +21,15 @@ #ifndef NOTMUCH_PRIVATE_H #define NOTMUCH_PRIVATE_H -#include "notmuch.h" - #ifndef _GNU_SOURCE #define _GNU_SOURCE /* For getline */ #endif - #include + +#include "notmuch.h" + +NOTMUCH_BEGIN_DECLS + #include #include #include @@ -38,32 +40,167 @@ #include #include #include +#include -NOTMUCH_BEGIN_DECLS +#include -/* xutil.c */ -void * -xcalloc (size_t nmemb, size_t size); +#include "xutil.h" -void * -xmalloc (size_t size); +#ifdef DEBUG +# define DEBUG_DATABASE_SANITY 1 +# define DEBUG_QUERY 1 +#endif -void * -xrealloc (void *ptrr, size_t size); +#define COMPILE_TIME_ASSERT(pred) ((void)sizeof(char[1 - 2*!(pred)])) -char * -xstrdup (const char *s); +/* There's no point in continuing when we've detected that we've done + * something wrong internally (as opposed to the user passing in a + * bogus value). + * + * Note that PRINTF_ATTRIBUTE comes from talloc.h + */ +int +_internal_error (const char *format, ...) PRINTF_ATTRIBUTE (1, 2); -char * -xstrndup (const char *s, size_t n); +/* There's no point in continuing when we've detected that we've done + * something wrong internally (as opposed to the user passing in a + * bogus value). + * + * Note that __location__ comes from talloc.h. + */ +#define INTERNAL_ERROR(format, ...) \ + _internal_error (format " (%s).\n", \ + ##__VA_ARGS__, __location__) + +#define unused(x) x __attribute__ ((unused)) -/* message.c */ +/* Thanks to Andrew Tridgell's (SAMBA's) talloc for this definition of + * unlikely. The talloc source code comes to us via the GNU LGPL v. 3. + */ +/* these macros gain us a few percent of speed on gcc */ +#if (__GNUC__ >= 3) +/* the strange !! is to ensure that __builtin_expect() takes either 0 or 1 + as its first argument */ +#ifndef likely +#define likely(x) __builtin_expect(!!(x), 1) +#endif +#ifndef unlikely +#define unlikely(x) __builtin_expect(!!(x), 0) +#endif +#else +#ifndef likely +#define likely(x) (x) +#endif +#ifndef unlikely +#define unlikely(x) (x) +#endif +#endif + +typedef enum { + NOTMUCH_VALUE_TIMESTAMP = 0, + NOTMUCH_VALUE_MESSAGE_ID +} notmuch_value_t; + +/* Xapian (with flint backend) complains if we provide a term longer + * than this, but I haven't yet found a way to query the limit + * programmatically. */ +#define NOTMUCH_TERM_MAX 245 + +typedef enum _notmuch_private_status { + /* First, copy all the public status values. */ + NOTMUCH_PRIVATE_STATUS_SUCCESS = NOTMUCH_STATUS_SUCCESS, + NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY = NOTMUCH_STATUS_OUT_OF_MEMORY, + NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION = NOTMUCH_STATUS_XAPIAN_EXCEPTION, + NOTMUCH_PRIVATE_STATUS_FILE_NOT_EMAIL = NOTMUCH_STATUS_FILE_NOT_EMAIL, + NOTMUCH_PRIVATE_STATUS_NULL_POINTER = NOTMUCH_STATUS_NULL_POINTER, + NOTMUCH_PRIVATE_STATUS_TAG_TOO_LONG = NOTMUCH_STATUS_TAG_TOO_LONG, + + /* Then add our own private values. */ + NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG, + NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND, + + NOTMUCH_PRIVATE_STATUS_LAST_STATUS +} notmuch_private_status_t; + +/* Coerce a notmuch_private_status_t value to a notmuch_status_t + * value, generating an internal error if the private value is equal + * to or greater than NOTMUCH_STATUS_LAST_STATUS. (The idea here is + * that the caller has previously handled any expected + * notmuch_private_status_t values.) + */ +#define COERCE_STATUS(private_status, format, ...) \ + ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS)\ + ? \ + (notmuch_status_t) _internal_error (format " (%s).\n", \ + ##__VA_ARGS__, \ + __location__) \ + : \ + (notmuch_status_t) private_status) + +/* thread.cc */ + +notmuch_thread_t * +_notmuch_thread_create (const void *talloc_owner, + notmuch_database_t *notmuch, + const char *thread_id); + +/* message.cc */ + +notmuch_message_t * +_notmuch_message_create (const void *talloc_owner, + notmuch_database_t *notmuch, + unsigned int doc_id, + notmuch_private_status_t *status); + +notmuch_message_t * +_notmuch_message_create_for_message_id (const void *talloc_owner, + notmuch_database_t *notmuch, + const char *message_id, + notmuch_status_t *status); + +/* Lookup a prefix value by name. + * + * XXX: This should really be static inside of message.cc, and we can + * do that once we convert database.cc to use the + * _notmuch_message_add/remove_term functions. */ +const char * +_find_prefix (const char *name); + +notmuch_private_status_t +_notmuch_message_add_term (notmuch_message_t *message, + const char *prefix_name, + const char *value); + +notmuch_private_status_t +_notmuch_message_remove_term (notmuch_message_t *message, + const char *prefix_name, + const char *value); + +void +_notmuch_message_set_filename (notmuch_message_t *message, + const char *filename); + +void +_notmuch_message_add_thread_id (notmuch_message_t *message, + const char *thread_id); + +void +_notmuch_message_ensure_thread_id (notmuch_message_t *message); + +void +_notmuch_message_set_date (notmuch_message_t *message, + const char *date); + +void +_notmuch_message_sync (notmuch_message_t *message); + +/* message-file.c */ /* XXX: I haven't decided yet whether these will actually get exported * into the public interface in notmuch.h */ -typedef struct _notmuch_message notmuch_message_t; +typedef struct _notmuch_message_file notmuch_message_file_t; /* Open a file containing a single email message. * @@ -71,12 +208,12 @@ typedef struct _notmuch_message notmuch_message_t; * * Returns NULL if any error occurs. */ -notmuch_message_t * -notmuch_message_open (const char *filename); +notmuch_message_file_t * +notmuch_message_file_open (const char *filename); /* Close a notmuch message preivously opened with notmuch_message_open. */ void -notmuch_message_close (notmuch_message_t *message); +notmuch_message_file_close (notmuch_message_file_t *message); /* Restrict 'message' to only save the named headers. * @@ -95,12 +232,12 @@ notmuch_message_close (notmuch_message_t *message); * returned even if that header exists in the actual message. */ void -notmuch_message_restrict_headers (notmuch_message_t *message, ...); +notmuch_message_file_restrict_headers (notmuch_message_file_t *message, ...); /* Identical to notmuch_message_restrict_headers but accepting a va_list. */ void -notmuch_message_restrict_headersv (notmuch_message_t *message, - va_list va_headers); +notmuch_message_file_restrict_headersv (notmuch_message_file_t *message, + va_list va_headers); /* Get the value of the specified header from the message. * @@ -114,8 +251,8 @@ notmuch_message_restrict_headersv (notmuch_message_t *message, * 'header'. */ const char * -notmuch_message_get_header (notmuch_message_t *message, - const char *header); +notmuch_message_file_get_header (notmuch_message_file_t *message, + const char *header); /* date.c */ @@ -129,6 +266,14 @@ notmuch_message_get_header (notmuch_message_t *message, time_t notmuch_parse_date (const char *str, int *tz_offset); +/* sha1.c */ + +char * +notmuch_sha1_of_string (const char *str); + +char * +notmuch_sha1_of_file (const char *filename); + NOTMUCH_END_DECLS #endif