1 /* The Ruby interface to the notmuch mail library
3 * Copyright © 2010 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 http://www.gnu.org/licenses/ .
18 * Author: Ali Polatel <alip@exherbo.org>
27 VALUE notmuch_rb_cDatabase;
28 VALUE notmuch_rb_cDirectory;
29 VALUE notmuch_rb_cFileNames;
30 VALUE notmuch_rb_cQuery;
31 VALUE notmuch_rb_cThreads;
32 VALUE notmuch_rb_cThread;
33 VALUE notmuch_rb_cMessages;
34 VALUE notmuch_rb_cMessage;
35 VALUE notmuch_rb_cTags;
37 VALUE notmuch_rb_eBaseError;
38 VALUE notmuch_rb_eDatabaseError;
39 VALUE notmuch_rb_eMemoryError;
40 VALUE notmuch_rb_eReadOnlyError;
41 VALUE notmuch_rb_eXapianError;
42 VALUE notmuch_rb_eFileError;
43 VALUE notmuch_rb_eFileNotEmailError;
44 VALUE notmuch_rb_eNullPointerError;
45 VALUE notmuch_rb_eTagTooLongError;
46 VALUE notmuch_rb_eUnbalancedFreezeThawError;
47 VALUE notmuch_rb_eUnbalancedAtomicError;
53 #define Data_Get_Notmuch_Database(obj, ptr) \
55 Check_Type(obj, T_DATA); \
56 if (DATA_PTR(obj) == NULL) \
57 rb_raise(rb_eRuntimeError, "database closed"); \
58 Data_Get_Struct(obj, notmuch_database_t, ptr); \
61 #define Data_Get_Notmuch_Directory(obj, ptr) \
63 Check_Type(obj, T_DATA); \
64 if (DATA_PTR(obj) == NULL) \
65 rb_raise(rb_eRuntimeError, "directory destroyed"); \
66 Data_Get_Struct(obj, notmuch_directory_t, ptr); \
69 #define Data_Get_Notmuch_FileNames(obj, ptr) \
71 Check_Type(obj, T_DATA); \
72 if (DATA_PTR(obj) == NULL) \
73 rb_raise(rb_eRuntimeError, "filenames destroyed"); \
74 Data_Get_Struct(obj, notmuch_filenames_t, ptr); \
77 #define Data_Get_Notmuch_Query(obj, ptr) \
79 Check_Type(obj, T_DATA); \
80 if (DATA_PTR(obj) == NULL) \
81 rb_raise(rb_eRuntimeError, "query destroyed"); \
82 Data_Get_Struct(obj, notmuch_query_t, ptr); \
85 #define Data_Get_Notmuch_Threads(obj, ptr) \
87 Check_Type(obj, T_DATA); \
88 if (DATA_PTR(obj) == NULL) \
89 rb_raise(rb_eRuntimeError, "threads destroyed"); \
90 Data_Get_Struct(obj, notmuch_threads_t, ptr); \
93 #define Data_Get_Notmuch_Messages(obj, ptr) \
95 Check_Type(obj, T_DATA); \
96 if (DATA_PTR(obj) == NULL) \
97 rb_raise(rb_eRuntimeError, "messages destroyed"); \
98 Data_Get_Struct(obj, notmuch_messages_t, ptr); \
101 #define Data_Get_Notmuch_Thread(obj, ptr) \
103 Check_Type(obj, T_DATA); \
104 if (DATA_PTR(obj) == NULL) \
105 rb_raise(rb_eRuntimeError, "thread destroyed"); \
106 Data_Get_Struct(obj, notmuch_thread_t, ptr); \
109 #define Data_Get_Notmuch_Message(obj, ptr) \
111 Check_Type(obj, T_DATA); \
112 if (DATA_PTR(obj) == NULL) \
113 rb_raise(rb_eRuntimeError, "message destroyed"); \
114 Data_Get_Struct(obj, notmuch_message_t, ptr); \
117 #define Data_Get_Notmuch_Tags(obj, ptr) \
119 Check_Type(obj, T_DATA); \
120 if (DATA_PTR(obj) == NULL) \
121 rb_raise(rb_eRuntimeError, "tags destroyed"); \
122 Data_Get_Struct(obj, notmuch_tags_t, ptr); \
127 notmuch_rb_status_raise(notmuch_status_t status);
131 notmuch_rb_database_alloc(VALUE klass);
134 notmuch_rb_database_initialize(int argc, VALUE *argv, VALUE klass);
137 notmuch_rb_database_open(int argc, VALUE *argv, VALUE klass);
140 notmuch_rb_database_close(VALUE self);
143 notmuch_rb_database_path(VALUE self);
146 notmuch_rb_database_version(VALUE self);
149 notmuch_rb_database_needs_upgrade(VALUE self);
152 notmuch_rb_database_upgrade(VALUE self);
155 notmuch_rb_database_begin_atomic(VALUE self);
158 notmuch_rb_database_end_atomic(VALUE self);
161 notmuch_rb_database_get_directory(VALUE self, VALUE pathv);
164 notmuch_rb_database_add_message(VALUE self, VALUE pathv);
167 notmuch_rb_database_remove_message(VALUE self, VALUE pathv);
170 notmuch_rb_database_query_create(VALUE self, VALUE qstrv);
174 notmuch_rb_directory_destroy(VALUE self);
177 notmuch_rb_directory_get_mtime(VALUE self);
180 notmuch_rb_directory_set_mtime(VALUE self, VALUE mtimev);
183 notmuch_rb_directory_get_child_files(VALUE self);
186 notmuch_rb_directory_get_child_directories(VALUE self);
190 notmuch_rb_filenames_destroy(VALUE self);
193 notmuch_rb_filenames_each(VALUE self);
197 notmuch_rb_query_destroy(VALUE self);
200 notmuch_rb_query_get_sort(VALUE self);
203 notmuch_rb_query_set_sort(VALUE self, VALUE sortv);
206 notmuch_rb_query_get_string(VALUE self);
209 notmuch_rb_query_search_threads(VALUE self);
212 notmuch_rb_query_search_messages(VALUE self);
216 notmuch_rb_threads_destroy(VALUE self);
219 notmuch_rb_threads_each(VALUE self);
223 notmuch_rb_messages_destroy(VALUE self);
226 notmuch_rb_messages_each(VALUE self);
229 notmuch_rb_messages_collect_tags(VALUE self);
233 notmuch_rb_thread_destroy(VALUE self);
236 notmuch_rb_thread_get_thread_id(VALUE self);
239 notmuch_rb_thread_get_total_messages(VALUE self);
242 notmuch_rb_thread_get_toplevel_messages(VALUE self);
245 notmuch_rb_thread_get_matched_messages(VALUE self);
248 notmuch_rb_thread_get_authors(VALUE self);
251 notmuch_rb_thread_get_subject(VALUE self);
254 notmuch_rb_thread_get_oldest_date(VALUE self);
257 notmuch_rb_thread_get_newest_date(VALUE self);
260 notmuch_rb_thread_get_tags(VALUE self);
264 notmuch_rb_message_destroy(VALUE self);
267 notmuch_rb_message_get_message_id(VALUE self);
270 notmuch_rb_message_get_thread_id(VALUE self);
273 notmuch_rb_message_get_replies(VALUE self);
276 notmuch_rb_message_get_filename(VALUE self);
279 notmuch_rb_message_get_filenames(VALUE self);
282 notmuch_rb_message_get_flag(VALUE self, VALUE flagv);
285 notmuch_rb_message_set_flag(VALUE self, VALUE flagv, VALUE valuev);
288 notmuch_rb_message_get_date(VALUE self);
291 notmuch_rb_message_get_header(VALUE self, VALUE headerv);
294 notmuch_rb_message_get_tags(VALUE self);
297 notmuch_rb_message_add_tag(VALUE self, VALUE tagv);
300 notmuch_rb_message_remove_tag(VALUE self, VALUE tagv);
303 notmuch_rb_message_remove_all_tags(VALUE self);
306 notmuch_rb_message_maildir_flags_to_tags(VALUE self);
309 notmuch_rb_message_tags_to_maildir_flags(VALUE self);
312 notmuch_rb_message_freeze(VALUE self);
315 notmuch_rb_message_thaw(VALUE self);
319 notmuch_rb_tags_destroy(VALUE self);
322 notmuch_rb_tags_each(VALUE self);