X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch.h;h=522bf1b97eeafa833dc316bf7fd6c5a41b7ec89a;hp=a6f3f5d4342ea198293a2bb8f0ce36194c77f383;hb=1ba3d46f;hpb=a360670c03475b1489ea5e2327cc3037cc8dff0b

diff --git a/notmuch.h b/notmuch.h
index a6f3f5d4..522bf1b9 100644
--- a/notmuch.h
+++ b/notmuch.h
@@ -102,7 +102,9 @@ notmuch_status_to_string (notmuch_status_t status);
  * notmuch_<foo> functions below. */
 typedef struct _notmuch_database notmuch_database_t;
 typedef struct _notmuch_query notmuch_query_t;
-typedef struct _notmuch_results notmuch_results_t;
+typedef struct _notmuch_thread_results notmuch_thread_results_t;
+typedef struct _notmuch_thread notmuch_thread_t;
+typedef struct _notmuch_message_results notmuch_message_results_t;
 typedef struct _notmuch_message notmuch_message_t;
 typedef struct _notmuch_tags notmuch_tags_t;
 
@@ -313,22 +315,63 @@ typedef enum {
 void
 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
 
-/* Execute a query, returning a notmuch_results_t object which can be
- * used to iterate over the results. The results object is owned by
- * the query and as such, will only be valid until notmuch_query_destroy.
+/* Execute a query for threads, returning a notmuch_thread_results_t
+ * object which can be used to iterate over the results. The results
+ * object is owned by the query and as such, will only be valid until
+ * notmuch_query_destroy.
  *
  * Typical usage might be:
  *
  *     notmuch_query_t *query;
- *     notmuch_results_t *results;
+ *     notmuch_thread_results_t *results;
+ *     notmuch_thread_t *thread;
  *
  *     query = notmuch_query_create (database, query_string);
  *
- *     for (results = notmuch_query_search (query);
- *          notmuch_results_has_more (results);
- *          notmuch_result_advance (results))
+ *     for (results = notmuch_query_search_threads (query);
+ *          notmuch_thread_results_has_more (results);
+ *          notmuch_thread_results_advance (results))
  *     {
- *         message = notmuch_results_get (results);
+ *         thread = notmuch_thread_results_get (results);
+ *         ....
+ *         notmuch_thread_destroy (thread);
+ *     }
+ *
+ *     notmuch_query_destroy (query);
+ *
+ * Note: If you are finished with a thread before its containing
+ * query, you can call notmuch_thread_destroy to clean up some memory
+ * sooner (as in the above example). Otherwise, if your thread objects
+ * are long-lived, then you don't need to call notmuch_thread_destroy
+ * and all the memory will still be reclaimed when the query is
+ * destroyed.
+ *
+ * Note that there's no explicit destructor needed for the
+ * notmuch_thread_results_t object. (For consistency, we do provide a
+ * notmuch_thread_results_destroy function, but there's no good reason
+ * to call it if the query is about to be destroyed).
+ */
+notmuch_thread_results_t *
+notmuch_query_search_threads (notmuch_query_t *query);
+
+/* Execute a query for messages, returning a notmuch_message_results_t
+ * object which can be used to iterate over the results. The results
+ * object is owned by the query and as such, will only be valid until
+ * notmuch_query_destroy.
+ *
+ * Typical usage might be:
+ *
+ *     notmuch_query_t *query;
+ *     notmuch_message_results_t *results;
+ *     notmuch_message_t *message;
+ *
+ *     query = notmuch_query_create (database, query_string);
+ *
+ *     for (results = notmuch_query_search_messages (query);
+ *          notmuch_message_results_has_more (results);
+ *          notmuch_message_results_advance (results))
+ *     {
+ *         message = notmuch_message_results_get (results);
  *         ....
  *         notmuch_message_destroy (message);
  *     }
@@ -343,64 +386,128 @@ notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
  * when the query is destroyed.
  *
  * Note that there's no explicit destructor needed for the
- * notmuch_results_t object. (For consistency, we do provide a
- * notmuch_results_destroy function, but there's no good reason to
- * call it if the query is about to be destroyed).
+ * notmuch_message_results_t object. (For consistency, we do provide a
+ * notmuch_message_results_destroy function, but there's no good
+ * reason to call it if the query is about to be destroyed).
  */
-notmuch_results_t *
-notmuch_query_search (notmuch_query_t *query);
+notmuch_message_results_t *
+notmuch_query_search_messages (notmuch_query_t *query);
 
 /* Destroy a notmuch_query_t along with any associated resources.
  *
- * This will in turn destroy any notmuch_results_t objects generated
- * by this query, (and in turn any notmuch_message_t objects generated
- * from those results, etc.).
+ * This will in turn destroy any notmuch_thread_results_t and
+ * notmuch_message_results_t objects generated by this query, (and in
+ * turn any notmuch_thrad_t and notmuch_message_t objects generated
+ * from those results, etc.), if such objects haven't already been
+ * destroyed.
  */
 void
 notmuch_query_destroy (notmuch_query_t *query);
 
-/* Does the given notmuch_results_t object contain any more results.
+/* Does the given notmuch_thread_results_t object contain any more
+ * results.
  *
- * When this function returns TRUE, notmuch_results_get will return a
- * valid object. Whereas when this function returns FALSE,
- * notmuch_results_get will return NULL.
+ * When this function returns TRUE, notmuch_thread_results_get will
+ * return a valid object. Whereas when this function returns FALSE,
+ * notmuch_thread_results_get will return NULL.
  *
- * See the documentation of notmuch_query_search for example code
- * showing how to iterate over a notmuch_results_t object.
+ * See the documentation of notmuch_query_search_threads for example
+ * code showing how to iterate over a notmuch_thread_results_t object.
  */
 notmuch_bool_t
-notmuch_results_has_more (notmuch_results_t *results);
+notmuch_thread_results_has_more (notmuch_thread_results_t *results);
+
+/* Get the current result from 'results' as a notmuch_thread_t.
+ *
+ * Note: The returned thread belongs to 'results' and has a lifetime
+ * identical to it (and the query to which it belongs).
+ *
+ * See the documentation of notmuch_query_search_threads for example
+ * code showing how to iterate over a notmuch_thread_results_t object.
+ *
+ * If an out-of-memory situation occurs, this function will return
+ * NULL.
+ */
+notmuch_thread_t *
+notmuch_thread_results_get (notmuch_thread_results_t *results);
+
+/* Advance the 'results' iterator to the next result.
+ *
+ * See the documentation of notmuch_query_search_threads for example
+ * code showing how to iterate over a notmuch_thread_results_t object.
+ */
+void
+notmuch_thread_results_advance (notmuch_thread_results_t *results);
+
+/* Destroy a notmuch_thread_results_t object.
+ *
+ * It's not strictly necessary to call this function. All memory from
+ * the notmuch_thread_results_t object will be reclaimed when the
+ * containg query object is destroyed.
+ */
+void
+notmuch_thread_results_destroy (notmuch_thread_results_t *results);
+
+/* Get the thread ID of 'thread'.
+ *
+ * The returned string belongs to 'thread' and as such, should not be
+ * modified by the caller and will only be valid for as long as the
+ * thread is valid, (which is until notmuch_thread_destroy or until
+ * the query from which it derived is destroyed).
+ */
+const char *
+notmuch_thread_get_thread_id (notmuch_thread_t *thread);
+
+/* Destroy a notmuch_thread_t object. */
+void
+notmuch_thread_destroy (notmuch_thread_t *thread);
+
+/* Does the given notmuch_message_results_t object contain any more
+ * results.
+ *
+ * When this function returns TRUE, notmuch_message_results_get will
+ * return a valid object. Whereas when this function returns FALSE,
+ * notmuch_message_results_get will return NULL.
+ *
+ * See the documentation of notmuch_query_search_messages for example
+ * code showing how to iterate over a notmuch_message_results_t
+ * object.
+ */
+notmuch_bool_t
+notmuch_message_results_has_more (notmuch_message_results_t *results);
 
 /* Get the current result from 'results' as a notmuch_message_t.
  *
  * Note: The returned message belongs to 'results' and has a lifetime
  * identical to it (and the query to which it belongs).
  *
- * See the documentation of notmuch_query_search for example code
- * showing how to iterate over a notmuch_results_t object.
+ * See the documentation of notmuch_query_search_messages for example
+ * code showing how to iterate over a notmuch_message_results_t
+ * object.
  *
  * If an out-of-memory situation occurs, this function will return
  * NULL.
  */
 notmuch_message_t *
-notmuch_results_get (notmuch_results_t *results);
+notmuch_message_results_get (notmuch_message_results_t *results);
 
 /* Advance the 'results' iterator to the next result.
  *
- * See the documentation of notmuch_query_search for example code
- * showing how to iterate over a notmuch_results_t object.
+ * See the documentation of notmuch_query_search_messages for example
+ * code showing how to iterate over a notmuch_message_results_t
+ * object.
  */
 void
-notmuch_results_advance (notmuch_results_t *results);
+notmuch_message_results_advance (notmuch_message_results_t *results);
 
-/* Destroy a notmuch_results_t object.
+/* Destroy a notmuch_message_results_t object.
  *
  * It's not strictly necessary to call this function. All memory from
- * the notmuch_results_t object will be reclaimed when the containg
- * query object is destroyed.
+ * the notmuch_message_results_t object will be reclaimed when the
+ * containg query object is destroyed.
  */
 void
-notmuch_results_destroy (notmuch_results_t *results);
+notmuch_message_results_destroy (notmuch_message_results_t *results);
 
 /* Get the message ID of 'message'.
  *
@@ -416,7 +523,6 @@ notmuch_results_destroy (notmuch_results_t *results);
 const char *
 notmuch_message_get_message_id (notmuch_message_t *message);
 
-
 /* Get the thread ID of 'message'.
  *
  * The returned string belongs to 'message' and as such, should not be