1 /* The Ruby interface to the notmuch mail library
3 * Copyright © 2010, 2011, 2012 Ali Polatel
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see https://www.gnu.org/licenses/ .
18 * Author: Ali Polatel <alip@exherbo.org>
24 * call-seq: QUERY.destroy! => nil
26 * Destroys the query, freeing all resources allocated for it.
29 notmuch_rb_query_destroy (VALUE self)
31 notmuch_query_t *query;
33 Data_Get_Notmuch_Query (self, query);
35 notmuch_query_destroy (query);
36 DATA_PTR (self) = NULL;
42 * call-seq: QUERY.sort => fixnum
44 * Get sort type of the +QUERY+
47 notmuch_rb_query_get_sort (VALUE self)
49 notmuch_query_t *query;
51 Data_Get_Notmuch_Query (self, query);
53 return FIX2INT (notmuch_query_get_sort (query));
57 * call-seq: QUERY.sort=(fixnum) => nil
59 * Set sort type of the +QUERY+
62 notmuch_rb_query_set_sort (VALUE self, VALUE sortv)
64 notmuch_query_t *query;
66 Data_Get_Notmuch_Query (self, query);
68 if (!FIXNUM_P (sortv))
69 rb_raise (rb_eTypeError, "Not a Fixnum");
71 notmuch_query_set_sort (query, FIX2UINT (sortv));
77 * call-seq: QUERY.to_s => string
79 * Get query string of the +QUERY+
82 notmuch_rb_query_get_string (VALUE self)
84 notmuch_query_t *query;
86 Data_Get_Notmuch_Query (self, query);
88 return rb_str_new2 (notmuch_query_get_query_string (query));
92 * call-seq: QUERY.add_tag_exclude(tag) => nil
94 * Add a tag that will be excluded from the query results by default.
97 notmuch_rb_query_add_tag_exclude (VALUE self, VALUE tagv)
99 notmuch_query_t *query;
102 Data_Get_Notmuch_Query (self, query);
103 tag = RSTRING_PTR(tagv);
105 notmuch_query_add_tag_exclude(query, tag);
110 * call-seq: QUERY.omit_excluded=(boolean) => nil
112 * Specify whether to omit excluded results or simply flag them.
113 * By default, this is set to +true+.
116 notmuch_rb_query_set_omit_excluded (VALUE self, VALUE omitv)
118 notmuch_query_t *query;
120 Data_Get_Notmuch_Query (self, query);
122 notmuch_query_set_omit_excluded (query, RTEST (omitv));
128 * call-seq: QUERY.search_threads => THREADS
133 notmuch_rb_query_search_threads (VALUE self)
135 notmuch_query_t *query;
136 notmuch_threads_t *threads;
137 notmuch_status_t status;
139 Data_Get_Notmuch_Query (self, query);
141 status = notmuch_query_search_threads (query, &threads);
143 notmuch_rb_status_raise (status);
145 return Data_Wrap_Notmuch_Object (notmuch_rb_cThreads, ¬much_rb_threads_type, threads);
149 * call-seq: QUERY.search_messages => MESSAGES
151 * Search for messages
154 notmuch_rb_query_search_messages (VALUE self)
156 notmuch_query_t *query;
157 notmuch_messages_t *messages;
158 notmuch_status_t status;
160 Data_Get_Notmuch_Query (self, query);
162 status = notmuch_query_search_messages (query, &messages);
164 notmuch_rb_status_raise (status);
166 return Data_Wrap_Notmuch_Object (notmuch_rb_cMessages, ¬much_rb_messages_type, messages);
170 * call-seq: QUERY.count_messages => Fixnum
172 * Return an estimate of the number of messages matching a search
175 notmuch_rb_query_count_messages (VALUE self)
177 notmuch_query_t *query;
178 notmuch_status_t status;
181 Data_Get_Notmuch_Query (self, query);
183 status = notmuch_query_count_messages (query, &count);
185 notmuch_rb_status_raise (status);
187 return UINT2NUM(count);
191 * call-seq: QUERY.count_threads => Fixnum
193 * Return an estimate of the number of threads matching a search
196 notmuch_rb_query_count_threads (VALUE self)
198 notmuch_query_t *query;
199 notmuch_status_t status;
202 Data_Get_Notmuch_Query (self, query);
204 status = notmuch_query_count_threads (query, &count);
206 notmuch_rb_status_raise (status);
208 return UINT2NUM(count);