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 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 /* RSTRING_PTR() is new in ruby-1.9 */
54 #if !defined(RSTRING_PTR)
55 # define RSTRING_PTR(v) (RSTRING((v))->ptr)
56 #endif /* !defined (RSTRING_PTR) */
58 #define Data_Get_Notmuch_Database(obj, ptr) \
60 Check_Type ((obj), T_DATA); \
61 if (DATA_PTR ((obj)) == NULL) \
62 rb_raise (rb_eRuntimeError, "database closed"); \
63 Data_Get_Struct ((obj), notmuch_database_t, (ptr)); \
66 #define Data_Get_Notmuch_Directory(obj, ptr) \
68 Check_Type ((obj), T_DATA); \
69 if (DATA_PTR ((obj)) == NULL) \
70 rb_raise (rb_eRuntimeError, "directory destroyed"); \
71 Data_Get_Struct ((obj), notmuch_directory_t, (ptr)); \
74 #define Data_Get_Notmuch_FileNames(obj, ptr) \
76 Check_Type ((obj), T_DATA); \
77 if (DATA_PTR ((obj)) == NULL) \
78 rb_raise (rb_eRuntimeError, "filenames destroyed"); \
79 Data_Get_Struct ((obj), notmuch_filenames_t, (ptr)); \
82 #define Data_Get_Notmuch_Query(obj, ptr) \
84 Check_Type ((obj), T_DATA); \
85 if (DATA_PTR ((obj)) == NULL) \
86 rb_raise (rb_eRuntimeError, "query destroyed"); \
87 Data_Get_Struct ((obj), notmuch_query_t, (ptr)); \
90 #define Data_Get_Notmuch_Threads(obj, ptr) \
92 Check_Type ((obj), T_DATA); \
93 if (DATA_PTR ((obj)) == NULL) \
94 rb_raise (rb_eRuntimeError, "threads destroyed"); \
95 Data_Get_Struct ((obj), notmuch_threads_t, (ptr)); \
98 #define Data_Get_Notmuch_Messages(obj, ptr) \
100 Check_Type ((obj), T_DATA); \
101 if (DATA_PTR ((obj)) == NULL) \
102 rb_raise (rb_eRuntimeError, "messages destroyed"); \
103 Data_Get_Struct ((obj), notmuch_messages_t, (ptr)); \
106 #define Data_Get_Notmuch_Thread(obj, ptr) \
108 Check_Type ((obj), T_DATA); \
109 if (DATA_PTR ((obj)) == NULL) \
110 rb_raise (rb_eRuntimeError, "thread destroyed"); \
111 Data_Get_Struct ((obj), notmuch_thread_t, (ptr)); \
114 #define Data_Get_Notmuch_Message(obj, ptr) \
116 Check_Type ((obj), T_DATA); \
117 if (DATA_PTR ((obj)) == NULL) \
118 rb_raise (rb_eRuntimeError, "message destroyed"); \
119 Data_Get_Struct ((obj), notmuch_message_t, (ptr)); \
122 #define Data_Get_Notmuch_Tags(obj, ptr) \
124 Check_Type ((obj), T_DATA); \
125 if (DATA_PTR ((obj)) == NULL) \
126 rb_raise (rb_eRuntimeError, "tags destroyed"); \
127 Data_Get_Struct ((obj), notmuch_tags_t, (ptr)); \
132 notmuch_rb_status_raise (notmuch_status_t status);
136 notmuch_rb_database_alloc (VALUE klass);
139 notmuch_rb_database_initialize (int argc, VALUE *argv, VALUE klass);
142 notmuch_rb_database_open (int argc, VALUE *argv, VALUE klass);
145 notmuch_rb_database_close (VALUE self);
148 notmuch_rb_database_path (VALUE self);
151 notmuch_rb_database_version (VALUE self);
154 notmuch_rb_database_needs_upgrade (VALUE self);
157 notmuch_rb_database_upgrade (VALUE self);
160 notmuch_rb_database_begin_atomic (VALUE self);
163 notmuch_rb_database_end_atomic (VALUE self);
166 notmuch_rb_database_get_directory (VALUE self, VALUE pathv);
169 notmuch_rb_database_add_message (VALUE self, VALUE pathv);
172 notmuch_rb_database_remove_message (VALUE self, VALUE pathv);
175 notmuch_rb_database_find_message (VALUE self, VALUE idv);
178 notmuch_rb_database_find_message_by_filename (VALUE self, VALUE pathv);
181 notmuch_rb_database_query_create (VALUE self, VALUE qstrv);
185 notmuch_rb_directory_destroy (VALUE self);
188 notmuch_rb_directory_get_mtime (VALUE self);
191 notmuch_rb_directory_set_mtime (VALUE self, VALUE mtimev);
194 notmuch_rb_directory_get_child_files (VALUE self);
197 notmuch_rb_directory_get_child_directories (VALUE self);
201 notmuch_rb_filenames_destroy (VALUE self);
204 notmuch_rb_filenames_each (VALUE self);
208 notmuch_rb_query_destroy (VALUE self);
211 notmuch_rb_query_get_sort (VALUE self);
214 notmuch_rb_query_set_sort (VALUE self, VALUE sortv);
217 notmuch_rb_query_get_string (VALUE self);
220 notmuch_rb_query_add_tag_exclude (VALUE self, VALUE tagv);
223 notmuch_rb_query_set_omit_excluded (VALUE self, VALUE omitv);
226 notmuch_rb_query_search_threads (VALUE self);
229 notmuch_rb_query_search_messages (VALUE self);
232 notmuch_rb_query_count_messages (VALUE self);
236 notmuch_rb_threads_destroy (VALUE self);
239 notmuch_rb_threads_each (VALUE self);
243 notmuch_rb_messages_destroy (VALUE self);
246 notmuch_rb_messages_each (VALUE self);
249 notmuch_rb_messages_collect_tags (VALUE self);
253 notmuch_rb_thread_destroy (VALUE self);
256 notmuch_rb_thread_get_thread_id (VALUE self);
259 notmuch_rb_thread_get_total_messages (VALUE self);
262 notmuch_rb_thread_get_toplevel_messages (VALUE self);
265 notmuch_rb_thread_get_matched_messages (VALUE self);
268 notmuch_rb_thread_get_authors (VALUE self);
271 notmuch_rb_thread_get_subject (VALUE self);
274 notmuch_rb_thread_get_oldest_date (VALUE self);
277 notmuch_rb_thread_get_newest_date (VALUE self);
280 notmuch_rb_thread_get_tags (VALUE self);
284 notmuch_rb_message_destroy (VALUE self);
287 notmuch_rb_message_get_message_id (VALUE self);
290 notmuch_rb_message_get_thread_id (VALUE self);
293 notmuch_rb_message_get_replies (VALUE self);
296 notmuch_rb_message_get_filename (VALUE self);
299 notmuch_rb_message_get_filenames (VALUE self);
302 notmuch_rb_message_get_flag (VALUE self, VALUE flagv);
305 notmuch_rb_message_set_flag (VALUE self, VALUE flagv, VALUE valuev);
308 notmuch_rb_message_get_date (VALUE self);
311 notmuch_rb_message_get_header (VALUE self, VALUE headerv);
314 notmuch_rb_message_get_tags (VALUE self);
317 notmuch_rb_message_add_tag (VALUE self, VALUE tagv);
320 notmuch_rb_message_remove_tag (VALUE self, VALUE tagv);
323 notmuch_rb_message_remove_all_tags (VALUE self);
326 notmuch_rb_message_maildir_flags_to_tags (VALUE self);
329 notmuch_rb_message_tags_to_maildir_flags (VALUE self);
332 notmuch_rb_message_freeze (VALUE self);
335 notmuch_rb_message_thaw (VALUE self);
339 notmuch_rb_tags_destroy (VALUE self);
342 notmuch_rb_tags_each (VALUE self);