Along with renaming notmuch_results_t to notmuch_message_results_t.
The new type is quite a mouthful, but I don't expect it to be
used much other than the for-loop idiom in the documentation,
(which does at least fit nicely within 80 columns).
This is all in preparation for the addition of a new
notmuch_query_search_threads of course.
void *local = talloc_new (NULL);
notmuch_database_t *notmuch = NULL;
notmuch_query_t *query;
void *local = talloc_new (NULL);
notmuch_database_t *notmuch = NULL;
notmuch_query_t *query;
- notmuch_results_t *results;
+ notmuch_message_results_t *results;
notmuch_message_t *message;
notmuch_tags_t *tags;
char *query_str;
notmuch_message_t *message;
notmuch_tags_t *tags;
char *query_str;
- for (results = notmuch_query_search (query);
- notmuch_results_has_more (results);
- notmuch_results_advance (results))
+ for (results = notmuch_query_search_messages (query);
+ notmuch_message_results_has_more (results);
+ notmuch_message_results_advance (results))
- message = notmuch_results_get (results);
+ message = notmuch_message_results_get (results);
printf ("%s (", notmuch_message_get_message_id (message));
printf ("%s (", notmuch_message_get_message_id (message));
FILE *output;
notmuch_database_t *notmuch = NULL;
notmuch_query_t *query;
FILE *output;
notmuch_database_t *notmuch = NULL;
notmuch_query_t *query;
- notmuch_results_t *results;
+ notmuch_message_results_t *results;
notmuch_message_t *message;
notmuch_tags_t *tags;
int ret = 0;
notmuch_message_t *message;
notmuch_tags_t *tags;
int ret = 0;
notmuch_query_set_sort (query, NOTMUCH_SORT_MESSAGE_ID);
notmuch_query_set_sort (query, NOTMUCH_SORT_MESSAGE_ID);
- for (results = notmuch_query_search (query);
- notmuch_results_has_more (results);
- notmuch_results_advance (results))
+ for (results = notmuch_query_search_messages (query);
+ notmuch_message_results_has_more (results);
+ notmuch_message_results_advance (results))
- message = notmuch_results_get (results);
+ message = notmuch_message_results_get (results);
fprintf (output,
"%s (", notmuch_message_get_message_id (message));
fprintf (output,
"%s (", notmuch_message_get_message_id (message));
* notmuch_<foo> functions below. */
typedef struct _notmuch_database notmuch_database_t;
typedef struct _notmuch_query notmuch_query_t;
* 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_message_results notmuch_message_results_t;
typedef struct _notmuch_message notmuch_message_t;
typedef struct _notmuch_tags notmuch_tags_t;
typedef struct _notmuch_message notmuch_message_t;
typedef struct _notmuch_tags notmuch_tags_t;
void
notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
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 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;
*
* Typical usage might be:
*
* notmuch_query_t *query;
- * notmuch_results_t *results;
+ * notmuch_message_results_t *results;
+ * notmuch_message_t *message;
*
* query = notmuch_query_create (database, query_string);
*
*
* 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_messages (query);
+ * notmuch_message_results_has_more (results);
+ * notmuch_message_results_advance (results))
- * message = notmuch_results_get (results);
+ * message = notmuch_message_results_get (results);
* ....
* notmuch_message_destroy (message);
* }
* ....
* notmuch_message_destroy (message);
* }
* when the query is destroyed.
*
* Note that there's no explicit destructor needed for the
* 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.
*
/* Destroy a notmuch_query_t along with any associated resources.
*
void
notmuch_query_destroy (notmuch_query_t *query);
void
notmuch_query_destroy (notmuch_query_t *query);
-/* Does the given notmuch_results_t object contain any more results.
+/* Does the given notmuch_message_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_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 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.
-notmuch_results_has_more (notmuch_results_t *results);
+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).
*
/* 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 *
*
* 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.
*
/* 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.
-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
*
* 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.
-notmuch_results_destroy (notmuch_results_t *results);
+notmuch_message_results_destroy (notmuch_message_results_t *results);
/* Get the message ID of 'message'.
*
/* Get the message ID of 'message'.
*
const char *
notmuch_message_get_message_id (notmuch_message_t *message);
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
/* Get the thread ID of 'message'.
*
* The returned string belongs to 'message' and as such, should not be
-struct _notmuch_results {
+struct _notmuch_message_results {
notmuch_database_t *notmuch;
Xapian::MSetIterator iterator;
Xapian::MSetIterator iterator_end;
notmuch_database_t *notmuch;
Xapian::MSetIterator iterator;
Xapian::MSetIterator iterator_end;
* talloc_set_destructor at all otherwise).
*/
static int
* talloc_set_destructor at all otherwise).
*/
static int
-_notmuch_results_destructor (notmuch_results_t *results)
+_notmuch_message_results_destructor (notmuch_message_results_t *results)
{
results->iterator.~MSetIterator ();
results->iterator_end.~MSetIterator ();
{
results->iterator.~MSetIterator ();
results->iterator_end.~MSetIterator ();
-notmuch_results_t *
-notmuch_query_search (notmuch_query_t *query)
+notmuch_message_results_t *
+notmuch_query_search_messages (notmuch_query_t *query)
{
notmuch_database_t *notmuch = query->notmuch;
const char *query_string = query->query_string;
{
notmuch_database_t *notmuch = query->notmuch;
const char *query_string = query->query_string;
- notmuch_results_t *results;
+ notmuch_message_results_t *results;
- results = talloc (query, notmuch_results_t);
+ results = talloc (query, notmuch_message_results_t);
if (unlikely (results == NULL))
return NULL;
if (unlikely (results == NULL))
return NULL;
new (&results->iterator) Xapian::MSetIterator ();
new (&results->iterator_end) Xapian::MSetIterator ();
new (&results->iterator) Xapian::MSetIterator ();
new (&results->iterator_end) Xapian::MSetIterator ();
- talloc_set_destructor (results, _notmuch_results_destructor);
+ talloc_set_destructor (results, _notmuch_message_results_destructor);
results->iterator = mset.begin ();
results->iterator_end = mset.end ();
results->iterator = mset.begin ();
results->iterator_end = mset.end ();
-notmuch_results_has_more (notmuch_results_t *results)
+notmuch_message_results_has_more (notmuch_message_results_t *results)
{
return (results->iterator != results->iterator_end);
}
notmuch_message_t *
{
return (results->iterator != results->iterator_end);
}
notmuch_message_t *
-notmuch_results_get (notmuch_results_t *results)
+notmuch_message_results_get (notmuch_message_results_t *results)
{
notmuch_message_t *message;
Xapian::docid doc_id;
{
notmuch_message_t *message;
Xapian::docid doc_id;
-notmuch_results_advance (notmuch_results_t *results)
+notmuch_message_results_advance (notmuch_message_results_t *results)
{
results->iterator++;
}
void
{
results->iterator++;
}
void
-notmuch_results_destroy (notmuch_results_t *results)
+notmuch_message_results_destroy (notmuch_message_results_t *results)
{
talloc_free (results);
}
{
talloc_free (results);
}