]> git.notmuchmail.org Git - notmuch/blobdiff - notmuch-private.h
add_message: Fix to not add multiple documents with the same message ID
[notmuch] / notmuch-private.h
index a8ec8ebeee1371e9a5522669a1515be2394ae6d6..8b317c2d8a3b9b59189de6982330773d6a7ff17e 100644 (file)
@@ -23,6 +23,8 @@
 
 #include "notmuch.h"
 
+NOTMUCH_BEGIN_DECLS
+
 #ifndef _GNU_SOURCE
 #define _GNU_SOURCE /* For getline */
 #endif
 #include <unistd.h>
 #include <ctype.h>
 
-NOTMUCH_BEGIN_DECLS
+#include <talloc.h>
 
-/* xutil.c */
-void *
-xcalloc (size_t nmemb, size_t size);
+#include "xutil.h"
 
-void *
-xmalloc (size_t size);
+/* 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
 
-void *
-xrealloc (void *ptrr, size_t size);
+/* These value numbers are chosen to be sup compatible (for now at
+ * least). */
 
-char *
-xstrdup (const char *s);
+typedef enum {
+    NOTMUCH_VALUE_MESSAGE_ID = 0,
+    NOTMUCH_VALUE_THREAD = 1,
+    NOTMUCH_VALUE_DATE = 2
+} notmuch_value_t;
 
-char *
-xstrndup (const char *s, size_t n);
+/* 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
 
-/* message.c */
+typedef enum _notmuch_private_status {
+    /* First, copy all the public status values. */
+    NOTMUCH_PRIVATE_STATUS_SUCCESS = NOTMUCH_STATUS_SUCCESS,
+    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_LAST_STATUS
+} notmuch_private_status_t;
+
+/* message.cc */
+
+notmuch_message_t *
+_notmuch_message_create (const void *talloc_owner,
+                        notmuch_database_t *notmuch,
+                        unsigned int doc_id);
+
+notmuch_message_t *
+_notmuch_message_create_for_message_id (const void *talloc_owner,
+                                       notmuch_database_t *notmuch,
+                                       const char *message_id);
+
+/* 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 +157,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 +181,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 +200,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 +215,20 @@ notmuch_message_get_header (notmuch_message_t *message,
 time_t
 notmuch_parse_date (const char *str, int *tz_offset);
 
+/* sha1.c */
+
+/* Create a hexadecimal string version of the SHA-1 digest of the
+ * named file.
+ *
+ * This function returns a newly allocated string which the caller
+ * should free() when finished.
+ *
+ * If any error occurs while reading the file, (permission denied,
+ * file not found, etc.), this function returns NULL.
+ */
+char *
+notmuch_sha1_of_file (const char *filename);
+
 NOTMUCH_END_DECLS
 
 #endif