Add 'notmuch count' command to show the count of matching messages

[notmuch] / lib / notmuch.h

diff --git a/lib/notmuch.h b/lib/notmuch.h
index cc713a3309af6d3a44d0e4bbeca315a8caa84bb0..260cc22d370088bf74ca3cee81d5b88dc19dbb4b 100644 (file)
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -86,6 +86,7 @@ typedef int notmuch_bool_t;
 typedef enum _notmuch_status {
     NOTMUCH_STATUS_SUCCESS = 0,
     NOTMUCH_STATUS_OUT_OF_MEMORY,
 typedef enum _notmuch_status {
     NOTMUCH_STATUS_SUCCESS = 0,
     NOTMUCH_STATUS_OUT_OF_MEMORY,

+    NOTMUCH_STATUS_READONLY_DATABASE,

     NOTMUCH_STATUS_XAPIAN_EXCEPTION,
     NOTMUCH_STATUS_FILE_ERROR,
     NOTMUCH_STATUS_FILE_NOT_EMAIL,
     NOTMUCH_STATUS_XAPIAN_EXCEPTION,
     NOTMUCH_STATUS_FILE_ERROR,
     NOTMUCH_STATUS_FILE_NOT_EMAIL,


@@ -136,6 +137,11 @@ typedef struct _notmuch_tags notmuch_tags_t;
 notmuch_database_t *
 notmuch_database_create (const char *path);
 
 notmuch_database_t *
 notmuch_database_create (const char *path);
 

+typedef enum {
+    NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
+    NOTMUCH_DATABASE_MODE_READ_WRITE
+} notmuch_database_mode_t;
+

 /* XXX: I think I'd like this to take an extra argument of
  * notmuch_status_t* for returning a status value on failure. */
 
 /* XXX: I think I'd like this to take an extra argument of
  * notmuch_status_t* for returning a status value on failure. */
 


@@ -143,7 +149,9 @@ notmuch_database_create (const char *path);
  *
  * The database should have been created at some time in the past,
  * (not necessarily by this process), by calling
  *
  * The database should have been created at some time in the past,
  * (not necessarily by this process), by calling

- * notmuch_database_create with 'path'.
+ * notmuch_database_create with 'path'. By default the database should be
+ * opened for reading only. In order to write to the database you need to
+ * pass the NOTMUCH_DATABASE_MODE_WRITABLE mode.

  *
  * An existing notmuch database can be identified by the presence of a
  * directory named ".notmuch" below 'path'.
  *
  * An existing notmuch database can be identified by the presence of a
  * directory named ".notmuch" below 'path'.


@@ -155,7 +163,8 @@ notmuch_database_create (const char *path);
  * an error message on stderr).
  */
 notmuch_database_t *
  * an error message on stderr).
  */
 notmuch_database_t *

-notmuch_database_open (const char *path);
+notmuch_database_open (const char *path,
+                      notmuch_database_mode_t mode);

 
 /* Close the given notmuch database, freeing all associated
  * resources. See notmuch_database_open. */
 
 /* Close the given notmuch database, freeing all associated
  * resources. See notmuch_database_open. */


@@ -459,6 +468,14 @@ notmuch_threads_advance (notmuch_threads_t *threads);
 void
 notmuch_threads_destroy (notmuch_threads_t *threads);
 
 void
 notmuch_threads_destroy (notmuch_threads_t *threads);
 

+/* Return an estimate of the number of messages matching a search
+ *
+ * This function performs a search and returns Xapian's best
+ * guess as to number of matching messages.
+ */
+unsigned
+notmuch_query_count_messages (notmuch_query_t *query);
+ 

 /* Get the thread ID of 'thread'.
  *
  * The returned string belongs to 'thread' and as such, should not be
 /* Get the thread ID of 'thread'.
  *
  * The returned string belongs to 'thread' and as such, should not be