]> git.notmuchmail.org Git - notmuch/blobdiff - bindings/ruby/query.c
emacs: Add new option notmuch-search-hide-excluded
[notmuch] / bindings / ruby / query.c
index 50edf170893df3cb6795778d9e906f1cc3b007cf..077def02f63021336de66d2c8c8e68edf1b4e6c4 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
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see http://www.gnu.org/licenses/ .
+ * along with this program.  If not, see https://www.gnu.org/licenses/ .
  *
  * Author: Ali Polatel <alip@exherbo.org>
  */
 
 #include "defs.h"
 
+/*
+ * call-seq: QUERY.destroy! => nil
+ *
+ * Destroys the query, freeing all resources allocated for it.
+ */
+VALUE
+notmuch_rb_query_destroy (VALUE self)
+{
+    notmuch_rb_object_destroy (self, &notmuch_rb_query_type);
+
+    return Qnil;
+}
+
+/*
+ * call-seq: QUERY.sort => fixnum
+ *
+ * Get sort type of the +QUERY+
+ */
+VALUE
+notmuch_rb_query_get_sort (VALUE self)
+{
+    notmuch_query_t *query;
+
+    Data_Get_Notmuch_Query (self, query);
+
+    return INT2FIX (notmuch_query_get_sort (query));
+}
+
 /*
  * call-seq: QUERY.sort=(fixnum) => nil
  *
  * 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_rb_query_t *query;
+    notmuch_query_t *query;
 
-    Data_Get_Struct(self, notmuch_rb_query_t, 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));
+
+    return Qnil;
+}
+
+/*
+ * call-seq: QUERY.to_s => string
+ *
+ * Get query string of the +QUERY+
+ */
+VALUE
+notmuch_rb_query_get_string (VALUE self)
+{
+    notmuch_query_t *query;
+
+    Data_Get_Notmuch_Query (self, 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;
+}
+
+/*
+ * call-seq: QUERY.omit_excluded=(fixnum) => nil
+ *
+ * Specify whether to omit excluded results or simply flag them.
+ * By default, this is set to +Notmuch::EXCLUDE_TRUE+.
+ */
+VALUE
+notmuch_rb_query_set_omit_excluded (VALUE self, VALUE omitv)
+{
+    notmuch_query_t *query;
+    notmuch_exclude_t value;
+
+    Data_Get_Notmuch_Query (self, query);
+
+    value = FIXNUM_P (omitv) ? FIX2UINT (omitv) : RTEST(omitv);
+    notmuch_query_set_omit_excluded (query, value);
 
-    notmuch_query_set_sort(query->nm_query, FIX2UINT(sortv));
     return Qnil;
 }
 
@@ -45,22 +127,19 @@ notmuch_rb_query_set_sort(VALUE self, VALUE sortv)
  * Search for threads
  */
 VALUE
-notmuch_rb_query_search_threads(VALUE self)
+notmuch_rb_query_search_threads (VALUE self)
 {
-    notmuch_rb_query_t *query;
-    notmuch_rb_threads_t *threads;
-    VALUE threadsv;
+    notmuch_query_t *query;
+    notmuch_threads_t *threads;
+    notmuch_status_t status;
 
-    Data_Get_Struct(self, notmuch_rb_query_t, query);
+    Data_Get_Notmuch_Query (self, query);
 
-    threadsv = Data_Make_Struct(notmuch_rb_cThreads, notmuch_rb_threads_t,
-            notmuch_rb_threads_mark, notmuch_rb_threads_free, threads);
-    threads->nm_threads = notmuch_query_search_threads(query->nm_query);
-    threads->query = self;
-    if (!threads->nm_threads)
-        rb_raise(notmuch_rb_eMemoryError, "out of memory");
+    status = notmuch_query_search_threads (query, &threads);
+    if (status)
+       notmuch_rb_status_raise (status);
 
-    return threadsv;
+    return Data_Wrap_Notmuch_Object (notmuch_rb_cThreads, &notmuch_rb_threads_type, threads);
 }
 
 /*
@@ -69,20 +148,59 @@ 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;
+    notmuch_status_t status;
+
+    Data_Get_Notmuch_Query (self, query);
+
+    status = notmuch_query_search_messages (query, &messages);
+    if (status)
+       notmuch_rb_status_raise (status);
+
+    return Data_Wrap_Notmuch_Object (notmuch_rb_cMessages, &notmuch_rb_messages_type, 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;
+    notmuch_status_t status;
+    unsigned int count;
+
+    Data_Get_Notmuch_Query (self, query);
+
+    status = notmuch_query_count_messages (query, &count);
+    if (status)
+       notmuch_rb_status_raise (status);
+
+    return UINT2NUM(count);
+}
+
+/*
+ * call-seq: QUERY.count_threads => Fixnum
+ *
+ * Return an estimate of the number of threads matching a search
+ */
+VALUE
+notmuch_rb_query_count_threads (VALUE self)
 {
-    notmuch_rb_query_t *query;
-    notmuch_rb_messages_t *messages;
-    VALUE messagesv;
+    notmuch_query_t *query;
+    notmuch_status_t status;
+    unsigned int count;
 
-    Data_Get_Struct(self, notmuch_rb_query_t, query);
+    Data_Get_Notmuch_Query (self, query);
 
-    messagesv = Data_Make_Struct(notmuch_rb_cMessages, notmuch_rb_messages_t,
-            notmuch_rb_messages_mark, notmuch_rb_messages_free, messages);
-    messages->nm_messages = notmuch_query_search_messages(query->nm_query);
-    messages->parent = self;
-    if (!messages->nm_messages)
-        rb_raise(notmuch_rb_eMemoryError, "out of memory");
+    status = notmuch_query_count_threads (query, &count);
+    if (status)
+       notmuch_rb_status_raise (status);
 
-    return messagesv;
+    return UINT2NUM(count);
 }