X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch-private.h;h=d257f2b92c52294efe235d3d6377ce9750c82f72;hp=384cc2de50e6cbaf2028c8ac5546f906a8682366;hb=1ba3d46f;hpb=6142216132ca5aa2727431e8cde44422de6ed24c

diff --git a/notmuch-private.h b/notmuch-private.h
index 384cc2de..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 <stdio.h>
+
+#include "notmuch.h"
+
+NOTMUCH_BEGIN_DECLS
+
 #include <stdlib.h>
 #include <stdarg.h>
 #include <sys/types.h>
@@ -38,13 +40,40 @@
 #include <fcntl.h>
 #include <unistd.h>
 #include <ctype.h>
-
-NOTMUCH_BEGIN_DECLS
+#include <assert.h>
 
 #include <talloc.h>
 
 #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.
  */
@@ -67,29 +96,104 @@ NOTMUCH_BEGIN_DECLS
 #endif
 #endif
 
-/* These value numbers are chosen to be sup compatible (for now at
- * least). */
-
 typedef enum {
-    NOTMUCH_VALUE_MESSAGE_ID = 0,
-    NOTMUCH_VALUE_THREAD = 1,
-    NOTMUCH_VALUE_DATE = 2
+    NOTMUCH_VALUE_TIMESTAMP = 0,
+    NOTMUCH_VALUE_MESSAGE_ID
 } notmuch_value_t;
 
-/* Xapian complains if we provide a term longer than this. */
-#define NOTMUCH_MAX_TERM 245
+/* 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 (notmuch_results_t *owner,
+_notmuch_message_create (const void *talloc_owner,
 			 notmuch_database_t *notmuch,
-			 unsigned int doc_id);
+			 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. */
+/* 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
@@ -162,6 +266,14 @@ notmuch_message_file_get_header (notmuch_message_file_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