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;
52 #define Data_Get_Notmuch_Database(obj, ptr) \
54 Check_Type(obj, T_DATA); \
55 if (DATA_PTR(obj) == NULL) \
56 rb_raise(rb_eRuntimeError, "database closed"); \
57 Data_Get_Struct(obj, notmuch_database_t, ptr); \
60 #define Data_Get_Notmuch_Directory(obj, ptr) \
62 Check_Type(obj, T_DATA); \
63 if (DATA_PTR(obj) == NULL) \
64 rb_raise(rb_eRuntimeError, "directory destroyed"); \
65 Data_Get_Struct(obj, notmuch_directory_t, ptr); \
68 #define Data_Get_Notmuch_FileNames(obj, ptr) \
70 Check_Type(obj, T_DATA); \
71 if (DATA_PTR(obj) == NULL) \
72 rb_raise(rb_eRuntimeError, "filenames destroyed"); \
73 Data_Get_Struct(obj, notmuch_filenames_t, ptr); \
76 #define Data_Get_Notmuch_Query(obj, ptr) \
78 Check_Type(obj, T_DATA); \
79 if (DATA_PTR(obj) == NULL) \
80 rb_raise(rb_eRuntimeError, "query destroyed"); \
81 Data_Get_Struct(obj, notmuch_query_t, ptr); \
84 #define Data_Get_Notmuch_Threads(obj, ptr) \
86 Check_Type(obj, T_DATA); \
87 if (DATA_PTR(obj) == NULL) \
88 rb_raise(rb_eRuntimeError, "threads destroyed"); \
89 Data_Get_Struct(obj, notmuch_threads_t, ptr); \
92 #define Data_Get_Notmuch_Messages(obj, ptr) \
94 Check_Type(obj, T_DATA); \
95 if (DATA_PTR(obj) == NULL) \
96 rb_raise(rb_eRuntimeError, "messages destroyed"); \
97 Data_Get_Struct(obj, notmuch_messages_t, ptr); \
100 #define Data_Get_Notmuch_Thread(obj, ptr) \
102 Check_Type(obj, T_DATA); \
103 if (DATA_PTR(obj) == NULL) \
104 rb_raise(rb_eRuntimeError, "thread destroyed"); \
105 Data_Get_Struct(obj, notmuch_thread_t, ptr); \
108 #define Data_Get_Notmuch_Message(obj, ptr) \
110 Check_Type(obj, T_DATA); \
111 if (DATA_PTR(obj) == NULL) \
112 rb_raise(rb_eRuntimeError, "message destroyed"); \
113 Data_Get_Struct(obj, notmuch_message_t, ptr); \
116 #define Data_Get_Notmuch_Tags(obj, ptr) \
118 Check_Type(obj, T_DATA); \
119 if (DATA_PTR(obj) == NULL) \
120 rb_raise(rb_eRuntimeError, "tags destroyed"); \
121 Data_Get_Struct(obj, notmuch_tags_t, ptr); \
126 notmuch_rb_status_raise(notmuch_status_t status);
130 notmuch_rb_database_alloc(VALUE klass);
133 notmuch_rb_database_initialize(int argc, VALUE *argv, VALUE klass);
136 notmuch_rb_database_open(int argc, VALUE *argv, VALUE klass);
139 notmuch_rb_database_close(VALUE self);
142 notmuch_rb_database_path(VALUE self);
145 notmuch_rb_database_version(VALUE self);
148 notmuch_rb_database_needs_upgrade(VALUE self);
151 notmuch_rb_database_upgrade(VALUE self);
154 notmuch_rb_database_get_directory(VALUE self, VALUE pathv);
157 notmuch_rb_database_add_message(VALUE self, VALUE pathv);
160 notmuch_rb_database_remove_message(VALUE self, VALUE pathv);
163 notmuch_rb_database_query_create(VALUE self, VALUE qstrv);
167 notmuch_rb_directory_destroy(VALUE self);
170 notmuch_rb_directory_get_mtime(VALUE self);
173 notmuch_rb_directory_set_mtime(VALUE self, VALUE mtimev);
176 notmuch_rb_directory_get_child_files(VALUE self);
179 notmuch_rb_directory_get_child_directories(VALUE self);
183 notmuch_rb_filenames_destroy(VALUE self);
186 notmuch_rb_filenames_each(VALUE self);
190 notmuch_rb_query_destroy(VALUE self);
193 notmuch_rb_query_get_sort(VALUE self);
196 notmuch_rb_query_set_sort(VALUE self, VALUE sortv);
199 notmuch_rb_query_get_string(VALUE self);
202 notmuch_rb_query_search_threads(VALUE self);
205 notmuch_rb_query_search_messages(VALUE self);
209 notmuch_rb_threads_destroy(VALUE self);
212 notmuch_rb_threads_each(VALUE self);
216 notmuch_rb_messages_destroy(VALUE self);
219 notmuch_rb_messages_each(VALUE self);
222 notmuch_rb_messages_collect_tags(VALUE self);
226 notmuch_rb_thread_destroy(VALUE self);
229 notmuch_rb_thread_get_thread_id(VALUE self);
232 notmuch_rb_thread_get_total_messages(VALUE self);
235 notmuch_rb_thread_get_toplevel_messages(VALUE self);
238 notmuch_rb_thread_get_matched_messages(VALUE self);
241 notmuch_rb_thread_get_authors(VALUE self);
244 notmuch_rb_thread_get_subject(VALUE self);
247 notmuch_rb_thread_get_oldest_date(VALUE self);
250 notmuch_rb_thread_get_newest_date(VALUE self);
253 notmuch_rb_thread_get_tags(VALUE self);
257 notmuch_rb_message_destroy(VALUE self);
260 notmuch_rb_message_get_message_id(VALUE self);
263 notmuch_rb_message_get_thread_id(VALUE self);
266 notmuch_rb_message_get_replies(VALUE self);
269 notmuch_rb_message_get_filename(VALUE self);
272 notmuch_rb_message_get_filenames(VALUE self);
275 notmuch_rb_message_get_flag(VALUE self, VALUE flagv);
278 notmuch_rb_message_set_flag(VALUE self, VALUE flagv, VALUE valuev);
281 notmuch_rb_message_get_date(VALUE self);
284 notmuch_rb_message_get_header(VALUE self, VALUE headerv);
287 notmuch_rb_message_get_tags(VALUE self);
290 notmuch_rb_message_add_tag(VALUE self, VALUE tagv);
293 notmuch_rb_message_remove_tag(VALUE self, VALUE tagv);
296 notmuch_rb_message_remove_all_tags(VALUE self);
299 notmuch_rb_message_maildir_flags_to_tags(VALUE self);
302 notmuch_rb_message_tags_to_maildir_flags(VALUE self);
305 notmuch_rb_message_freeze(VALUE self);
308 notmuch_rb_message_thaw(VALUE self);
312 notmuch_rb_tags_destroy(VALUE self);
315 notmuch_rb_tags_each(VALUE self);