X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch-private.h;h=99fbb4b2eb1b2e6c5d736e937cf5c3f5309aafe9;hp=53ea75fa4d1c7bb09f2f08af50afd821b3ab0c5d;hb=c33eed84f2c1a23d7f3835f7f7d480fde179ff4d;hpb=3b8e3ab666a54407f9596a53c66ba8ce623ac91d diff --git a/notmuch-private.h b/notmuch-private.h index 53ea75fa..99fbb4b2 100644 --- a/notmuch-private.h +++ b/notmuch-private.h @@ -22,7 +22,7 @@ #define NOTMUCH_PRIVATE_H #ifndef _GNU_SOURCE -#define _GNU_SOURCE /* For getline */ +#define _GNU_SOURCE /* For getline and asprintf */ #endif #include @@ -46,8 +46,34 @@ NOTMUCH_BEGIN_DECLS #include "xutil.h" +#ifdef DEBUG +# define DEBUG_DATABASE_SANITY 1 +# define DEBUG_QUERY 1 +#endif + #define COMPILE_TIME_ASSERT(pred) ((void)sizeof(char[1 - 2*!(pred)])) +/* 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); + +/* 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)) + /* 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. */ @@ -96,6 +122,42 @@ typedef enum _notmuch_private_status { 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) + +/* database.cc */ + +/* 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); + +/* thread.cc */ + +notmuch_thread_t * +_notmuch_thread_create (const void *talloc_owner, + notmuch_database_t *notmuch, + const char *thread_id); + +void +_notmuch_thread_add_message (notmuch_thread_t *thread, + notmuch_message_t *message); + /* message.cc */ notmuch_message_t * @@ -108,15 +170,10 @@ 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); + notmuch_private_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_message_get_subject (notmuch_message_t *message); notmuch_private_status_t _notmuch_message_add_term (notmuch_message_t *message, @@ -128,6 +185,11 @@ _notmuch_message_remove_term (notmuch_message_t *message, const char *prefix_name, const char *value); +notmuch_private_status_t +_notmuch_message_gen_terms (notmuch_message_t *message, + const char *prefix_name, + const char *text); + void _notmuch_message_set_filename (notmuch_message_t *message, const char *filename); @@ -146,6 +208,12 @@ _notmuch_message_set_date (notmuch_message_t *message, void _notmuch_message_sync (notmuch_message_t *message); +/* index.cc */ + +notmuch_status_t +_notmuch_message_index_file (notmuch_message_t *message, + const char *filename); + /* message-file.c */ /* XXX: I haven't decided yet whether these will actually get exported @@ -163,6 +231,10 @@ typedef struct _notmuch_message_file notmuch_message_file_t; notmuch_message_file_t * notmuch_message_file_open (const char *filename); +/* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */ +notmuch_message_file_t * +_notmuch_message_file_open_ctx (void *ctx, const char *filename); + /* Close a notmuch message preivously opened with notmuch_message_open. */ void notmuch_message_file_close (notmuch_message_file_t *message); @@ -206,6 +278,24 @@ const char * notmuch_message_file_get_header (notmuch_message_file_t *message, const char *header); +/* Get the entire set of headers from an email message as a string. + * + * The returned value is owned by the notmuch message and is valid + * only until the message is closed. The caller should copy it if + * needing to modify the value or to hold onto it for longer. + * + * Returns NULL in the case of any error. + */ +const char * +notmuch_message_file_get_all_headers (notmuch_message_file_t *message); + +/* Get the size in bytes of the full header section of 'message'. + * + * Returns 0 in the case of any error. + */ +size_t +notmuch_message_file_get_header_size (notmuch_message_file_t *message); + /* date.c */ /* Parse an RFC 8222 date string to a time_t value. @@ -226,6 +316,17 @@ notmuch_sha1_of_string (const char *str); char * notmuch_sha1_of_file (const char *filename); +/* tags.c */ + +notmuch_tags_t * +_notmuch_tags_create (void *ctx); + +void +_notmuch_tags_add_tag (notmuch_tags_t *tags, const char *tag); + +void +_notmuch_tags_prepare_iterator (notmuch_tags_t *tags); + NOTMUCH_END_DECLS #endif