]> git.notmuchmail.org Git - notmuch/blobdiff - bindings/ruby/query.c
ruby: Add wrapper for notmuch_query_add_tag_exclude
[notmuch] / bindings / ruby / query.c
index 6a70f192bbd06de0a2206fd7af64afee4b444642..2a800080bdd8a375c2cdda8caea8ad9adf5ccede 100644 (file)
@@ -1,6 +1,6 @@
 /* The Ruby interface to the notmuch mail library
  *
- * Copyright © 2010 Ali Polatel
+ * Copyright © 2010, 2011, 2012 Ali Polatel
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * Destroys the query, freeing all resources allocated for it.
  */
 VALUE
-notmuch_rb_query_destroy(VALUE self)
+notmuch_rb_query_destroy (VALUE self)
 {
     notmuch_query_t *query;
 
-    Data_Get_Notmuch_Query(self, query);
+    Data_Get_Notmuch_Query (self, query);
 
-    notmuch_query_destroy(query);
-    DATA_PTR(self) = NULL;
+    notmuch_query_destroy (query);
+    DATA_PTR (self) = NULL;
 
     return Qnil;
 }
@@ -44,13 +44,13 @@ notmuch_rb_query_destroy(VALUE self)
  * Get sort type of the +QUERY+
  */
 VALUE
-notmuch_rb_query_get_sort(VALUE self)
+notmuch_rb_query_get_sort (VALUE self)
 {
     notmuch_query_t *query;
 
-    Data_Get_Notmuch_Query(self, query);
+    Data_Get_Notmuch_Query (self, query);
 
-    return FIX2INT(notmuch_query_get_sort(query));
+    return FIX2INT (notmuch_query_get_sort (query));
 }
 
 /*
@@ -59,16 +59,16 @@ notmuch_rb_query_get_sort(VALUE self)
  * Set sort type of the +QUERY+
  */
 VALUE
-notmuch_rb_query_set_sort(VALUE self, VALUE sortv)
+notmuch_rb_query_set_sort (VALUE self, VALUE sortv)
 {
     notmuch_query_t *query;
 
-    Data_Get_Notmuch_Query(self, query);
+    Data_Get_Notmuch_Query (self, query);
 
-    if (!FIXNUM_P(sortv))
-        rb_raise(rb_eTypeError, "Not a Fixnum");
+    if (!FIXNUM_P (sortv))
+       rb_raise (rb_eTypeError, "Not a Fixnum");
 
-    notmuch_query_set_sort(query, FIX2UINT(sortv));
+    notmuch_query_set_sort (query, FIX2UINT (sortv));
 
     return Qnil;
 }
@@ -79,13 +79,31 @@ notmuch_rb_query_set_sort(VALUE self, VALUE sortv)
  * Get query string of the +QUERY+
  */
 VALUE
-notmuch_rb_query_get_string(VALUE self)
+notmuch_rb_query_get_string (VALUE self)
 {
     notmuch_query_t *query;
 
-    Data_Get_Notmuch_Query(self, query);
+    Data_Get_Notmuch_Query (self, query);
 
-    return rb_str_new2(notmuch_query_get_query_string(query));
+    return rb_str_new2 (notmuch_query_get_query_string (query));
+}
+
+/*
+ * call-seq: QUERY.add_tag_exclude(tag) => nil
+ *
+ * Add a tag that will be excluded from the query results by default.
+ */
+VALUE
+notmuch_rb_query_add_tag_exclude (VALUE self, VALUE tagv)
+{
+    notmuch_query_t *query;
+    const char *tag;
+
+    Data_Get_Notmuch_Query (self, query);
+    tag = RSTRING_PTR(tagv);
+
+    notmuch_query_add_tag_exclude(query, tag);
+    return Qnil;
 }
 
 /*
@@ -94,18 +112,18 @@ notmuch_rb_query_get_string(VALUE self)
  * Search for threads
  */
 VALUE
-notmuch_rb_query_search_threads(VALUE self)
+notmuch_rb_query_search_threads (VALUE self)
 {
     notmuch_query_t *query;
     notmuch_threads_t *threads;
 
-    Data_Get_Notmuch_Query(self, query);
+    Data_Get_Notmuch_Query (self, query);
 
-    threads = notmuch_query_search_threads(query);
+    threads = notmuch_query_search_threads (query);
     if (!threads)
-        rb_raise(notmuch_rb_eMemoryError, "Out of memory");
+       rb_raise (notmuch_rb_eMemoryError, "Out of memory");
 
-    return Data_Wrap_Struct(notmuch_rb_cThreads, NULL, NULL, threads);
+    return Data_Wrap_Struct (notmuch_rb_cThreads, NULL, NULL, threads);
 }
 
 /*
@@ -114,16 +132,35 @@ notmuch_rb_query_search_threads(VALUE self)
  * Search for messages
  */
 VALUE
-notmuch_rb_query_search_messages(VALUE self)
+notmuch_rb_query_search_messages (VALUE self)
 {
     notmuch_query_t *query;
     notmuch_messages_t *messages;
 
-    Data_Get_Notmuch_Query(self, query);
+    Data_Get_Notmuch_Query (self, query);
 
-    messages = notmuch_query_search_messages(query);
+    messages = notmuch_query_search_messages (query);
     if (!messages)
-        rb_raise(notmuch_rb_eMemoryError, "Out of memory");
+       rb_raise (notmuch_rb_eMemoryError, "Out of memory");
+
+    return Data_Wrap_Struct (notmuch_rb_cMessages, NULL, NULL, messages);
+}
+
+/*
+ * call-seq: QUERY.count_messages => Fixnum
+ *
+ * Return an estimate of the number of messages matching a search
+ */
+VALUE
+notmuch_rb_query_count_messages (VALUE self)
+{
+    notmuch_query_t *query;
+
+    Data_Get_Notmuch_Query (self, query);
 
-    return Data_Wrap_Struct(notmuch_rb_cMessages, NULL, NULL, messages);
+    /* Xapian exceptions are not handled properly.
+     * (function may return 0 after printing a message)
+     * Thus there is nothing we can do here...
+     */
+    return UINT2FIX(notmuch_query_count_messages(query));
 }