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>
23 VALUE notmuch_rb_cDatabase;
24 VALUE notmuch_rb_cDirectory;
25 VALUE notmuch_rb_cFileNames;
26 VALUE notmuch_rb_cQuery;
27 VALUE notmuch_rb_cThreads;
28 VALUE notmuch_rb_cThread;
29 VALUE notmuch_rb_cMessages;
30 VALUE notmuch_rb_cMessage;
31 VALUE notmuch_rb_cTags;
33 VALUE notmuch_rb_eBaseError;
34 VALUE notmuch_rb_eDatabaseError;
35 VALUE notmuch_rb_eMemoryError;
36 VALUE notmuch_rb_eReadOnlyError;
37 VALUE notmuch_rb_eXapianError;
38 VALUE notmuch_rb_eFileError;
39 VALUE notmuch_rb_eFileNotEmailError;
40 VALUE notmuch_rb_eNullPointerError;
41 VALUE notmuch_rb_eTagTooLongError;
42 VALUE notmuch_rb_eUnbalancedFreezeThawError;
43 VALUE notmuch_rb_eUnbalancedAtomicError;
50 * Document-module: Notmuch
54 * Ruby extension to the <tt>notmuch</tt> mail library.
58 * Following are the classes that are most likely to be of interest to
62 * - Notmuch::FileNames
76 ID_call = rb_intern ("call");
77 ID_db_create = rb_intern ("create");
78 ID_db_mode = rb_intern ("mode");
80 mod = rb_define_module ("Notmuch");
83 * Document-const: Notmuch::MODE_READ_ONLY
85 * Open the database in read only mode
87 rb_define_const (mod, "MODE_READ_ONLY", INT2FIX (NOTMUCH_DATABASE_MODE_READ_ONLY));
89 * Document-const: Notmuch::MODE_READ_WRITE
91 * Open the database in read write mode
93 rb_define_const (mod, "MODE_READ_WRITE", INT2FIX (NOTMUCH_DATABASE_MODE_READ_WRITE));
95 * Document-const: Notmuch::SORT_OLDEST_FIRST
97 * Sort query results by oldest first
99 rb_define_const (mod, "SORT_OLDEST_FIRST", INT2FIX (NOTMUCH_SORT_OLDEST_FIRST));
101 * Document-const: Notmuch::SORT_NEWEST_FIRST
103 * Sort query results by newest first
105 rb_define_const (mod, "SORT_NEWEST_FIRST", INT2FIX (NOTMUCH_SORT_NEWEST_FIRST));
107 * Document-const: Notmuch::SORT_MESSAGE_ID
109 * Sort query results by message id
111 rb_define_const (mod, "SORT_MESSAGE_ID", INT2FIX (NOTMUCH_SORT_MESSAGE_ID));
113 * Document-const: Notmuch::SORT_UNSORTED
115 * Do not sort query results
117 rb_define_const (mod, "SORT_UNSORTED", INT2FIX (NOTMUCH_SORT_UNSORTED));
119 * Document-const: Notmuch::MESSAGE_FLAG_MATCH
121 * Message flag "match"
123 rb_define_const (mod, "MESSAGE_FLAG_MATCH", INT2FIX (NOTMUCH_MESSAGE_FLAG_MATCH));
125 * Document-const: Notmuch::MESSAGE_FLAG_EXCLUDED
127 * Message flag "excluded"
129 rb_define_const (mod, "MESSAGE_FLAG_EXCLUDED", INT2FIX (NOTMUCH_MESSAGE_FLAG_EXCLUDED));
131 * Document-const: Notmuch::TAG_MAX
133 * Maximum allowed length of a tag
135 rb_define_const (mod, "TAG_MAX", INT2FIX (NOTMUCH_TAG_MAX));
138 * Document-class: Notmuch::BaseError
140 * Base class for all notmuch exceptions
142 notmuch_rb_eBaseError = rb_define_class_under (mod, "BaseError", rb_eStandardError);
144 * Document-class: Notmuch::DatabaseError
146 * Raised when the database can't be created or opened.
148 notmuch_rb_eDatabaseError = rb_define_class_under (mod, "DatabaseError", notmuch_rb_eBaseError);
150 * Document-class: Notmuch::MemoryError
152 * Raised when notmuch is out of memory
154 notmuch_rb_eMemoryError = rb_define_class_under (mod, "MemoryError", notmuch_rb_eBaseError);
156 * Document-class: Notmuch::ReadOnlyError
158 * Raised when an attempt was made to write to a database opened in read-only
161 notmuch_rb_eReadOnlyError = rb_define_class_under (mod, "ReadOnlyError", notmuch_rb_eBaseError);
163 * Document-class: Notmuch::XapianError
165 * Raised when a Xapian exception occurs
167 notmuch_rb_eXapianError = rb_define_class_under (mod, "XapianError", notmuch_rb_eBaseError);
169 * Document-class: Notmuch::FileError
171 * Raised when an error occurs trying to read or write to a file.
173 notmuch_rb_eFileError = rb_define_class_under (mod, "FileError", notmuch_rb_eBaseError);
175 * Document-class: Notmuch::FileNotEmailError
177 * Raised when a file is presented that doesn't appear to be an email message.
179 notmuch_rb_eFileNotEmailError = rb_define_class_under (mod, "FileNotEmailError", notmuch_rb_eBaseError);
181 * Document-class: Notmuch::NullPointerError
183 * Raised when the user erroneously passes a +NULL+ pointer to a notmuch
186 notmuch_rb_eNullPointerError = rb_define_class_under (mod, "NullPointerError", notmuch_rb_eBaseError);
188 * Document-class: Notmuch::TagTooLongError
190 * Raised when a tag value is too long (exceeds Notmuch::TAG_MAX)
192 notmuch_rb_eTagTooLongError = rb_define_class_under (mod, "TagTooLongError", notmuch_rb_eBaseError);
194 * Document-class: Notmuch::UnbalancedFreezeThawError
196 * Raised when the notmuch_message_thaw function has been called more times
197 * than notmuch_message_freeze.
199 notmuch_rb_eUnbalancedFreezeThawError = rb_define_class_under (mod, "UnbalancedFreezeThawError",
200 notmuch_rb_eBaseError);
202 * Document-class: Notmuch::UnbalancedAtomicError
204 * Raised when notmuch_database_end_atomic has been called more times than
205 * notmuch_database_begin_atomic
207 notmuch_rb_eUnbalancedAtomicError = rb_define_class_under (mod, "UnbalancedAtomicError",
208 notmuch_rb_eBaseError);
210 * Document-class: Notmuch::Database
212 * Notmuch database interaction
214 notmuch_rb_cDatabase = rb_define_class_under (mod, "Database", rb_cData);
215 rb_define_alloc_func (notmuch_rb_cDatabase, notmuch_rb_database_alloc);
216 rb_define_singleton_method (notmuch_rb_cDatabase, "open", notmuch_rb_database_open, -1); /* in database.c */
217 rb_define_method (notmuch_rb_cDatabase, "initialize", notmuch_rb_database_initialize, -1); /* in database.c */
218 rb_define_method (notmuch_rb_cDatabase, "close", notmuch_rb_database_close, 0); /* in database.c */
219 rb_define_method (notmuch_rb_cDatabase, "path", notmuch_rb_database_path, 0); /* in database.c */
220 rb_define_method (notmuch_rb_cDatabase, "version", notmuch_rb_database_version, 0); /* in database.c */
221 rb_define_method (notmuch_rb_cDatabase, "needs_upgrade?", notmuch_rb_database_needs_upgrade, 0); /* in database.c */
222 rb_define_method (notmuch_rb_cDatabase, "upgrade!", notmuch_rb_database_upgrade, 0); /* in database.c */
223 rb_define_method (notmuch_rb_cDatabase, "begin_atomic", notmuch_rb_database_begin_atomic, 0); /* in database.c */
224 rb_define_method (notmuch_rb_cDatabase, "end_atomic", notmuch_rb_database_end_atomic, 0); /* in database.c */
225 rb_define_method (notmuch_rb_cDatabase, "get_directory", notmuch_rb_database_get_directory, 1); /* in database.c */
226 rb_define_method (notmuch_rb_cDatabase, "add_message", notmuch_rb_database_add_message, 1); /* in database.c */
227 rb_define_method (notmuch_rb_cDatabase, "remove_message", notmuch_rb_database_remove_message, 1); /* in database.c */
228 rb_define_method (notmuch_rb_cDatabase, "find_message",
229 notmuch_rb_database_find_message, 1); /* in database.c */
230 rb_define_method (notmuch_rb_cDatabase, "find_message_by_filename",
231 notmuch_rb_database_find_message_by_filename, 1); /* in database.c */
232 rb_define_method (notmuch_rb_cDatabase, "query", notmuch_rb_database_query_create, 1); /* in database.c */
235 * Document-class: Notmuch::Directory
239 notmuch_rb_cDirectory = rb_define_class_under (mod, "Directory", rb_cData);
240 rb_undef_method (notmuch_rb_cDirectory, "initialize");
241 rb_define_method (notmuch_rb_cDirectory, "destroy!", notmuch_rb_directory_destroy, 0); /* in directory.c */
242 rb_define_method (notmuch_rb_cDirectory, "mtime", notmuch_rb_directory_get_mtime, 0); /* in directory.c */
243 rb_define_method (notmuch_rb_cDirectory, "mtime=", notmuch_rb_directory_set_mtime, 1); /* in directory.c */
244 rb_define_method (notmuch_rb_cDirectory, "child_files", notmuch_rb_directory_get_child_files, 0); /* in directory.c */
245 rb_define_method (notmuch_rb_cDirectory, "child_directories", notmuch_rb_directory_get_child_directories, 0); /* in directory.c */
248 * Document-class: Notmuch::FileNames
252 notmuch_rb_cFileNames = rb_define_class_under (mod, "FileNames", rb_cData);
253 rb_undef_method (notmuch_rb_cFileNames, "initialize");
254 rb_define_method (notmuch_rb_cFileNames, "destroy!", notmuch_rb_filenames_destroy, 0); /* in filenames.c */
255 rb_define_method (notmuch_rb_cFileNames, "each", notmuch_rb_filenames_each, 0); /* in filenames.c */
256 rb_include_module (notmuch_rb_cFileNames, rb_mEnumerable);
259 * Document-class: Notmuch::Query
263 notmuch_rb_cQuery = rb_define_class_under (mod, "Query", rb_cData);
264 rb_undef_method (notmuch_rb_cQuery, "initialize");
265 rb_define_method (notmuch_rb_cQuery, "destroy!", notmuch_rb_query_destroy, 0); /* in query.c */
266 rb_define_method (notmuch_rb_cQuery, "sort", notmuch_rb_query_get_sort, 0); /* in query.c */
267 rb_define_method (notmuch_rb_cQuery, "sort=", notmuch_rb_query_set_sort, 1); /* in query.c */
268 rb_define_method (notmuch_rb_cQuery, "to_s", notmuch_rb_query_get_string, 0); /* in query.c */
269 rb_define_method (notmuch_rb_cQuery, "add_tag_exclude", notmuch_rb_query_add_tag_exclude, 1); /* in query.c */
270 rb_define_method (notmuch_rb_cQuery, "omit_excluded=", notmuch_rb_query_set_omit_excluded, 1); /* in query.c */
271 rb_define_method (notmuch_rb_cQuery, "search_threads", notmuch_rb_query_search_threads, 0); /* in query.c */
272 rb_define_method (notmuch_rb_cQuery, "search_messages", notmuch_rb_query_search_messages, 0); /* in query.c */
273 rb_define_method (notmuch_rb_cQuery, "count_messages", notmuch_rb_query_count_messages, 0); /* in query.c */
276 * Document-class: Notmuch::Threads
280 notmuch_rb_cThreads = rb_define_class_under (mod, "Threads", rb_cData);
281 rb_undef_method (notmuch_rb_cThreads, "initialize");
282 rb_define_method (notmuch_rb_cThreads, "destroy!", notmuch_rb_threads_destroy, 0); /* in threads.c */
283 rb_define_method (notmuch_rb_cThreads, "each", notmuch_rb_threads_each, 0); /* in threads.c */
284 rb_include_module (notmuch_rb_cThreads, rb_mEnumerable);
287 * Document-class: Notmuch::Messages
291 notmuch_rb_cMessages = rb_define_class_under (mod, "Messages", rb_cData);
292 rb_undef_method (notmuch_rb_cMessages, "initialize");
293 rb_define_method (notmuch_rb_cMessages, "destroy!", notmuch_rb_messages_destroy, 0); /* in messages.c */
294 rb_define_method (notmuch_rb_cMessages, "each", notmuch_rb_messages_each, 0); /* in messages.c */
295 rb_define_method (notmuch_rb_cMessages, "tags", notmuch_rb_messages_collect_tags, 0); /* in messages.c */
296 rb_include_module (notmuch_rb_cMessages, rb_mEnumerable);
299 * Document-class: Notmuch::Thread
303 notmuch_rb_cThread = rb_define_class_under (mod, "Thread", rb_cData);
304 rb_undef_method (notmuch_rb_cThread, "initialize");
305 rb_define_method (notmuch_rb_cThread, "destroy!", notmuch_rb_thread_destroy, 0); /* in thread.c */
306 rb_define_method (notmuch_rb_cThread, "thread_id", notmuch_rb_thread_get_thread_id, 0); /* in thread.c */
307 rb_define_method (notmuch_rb_cThread, "total_messages", notmuch_rb_thread_get_total_messages, 0); /* in thread.c */
308 rb_define_method (notmuch_rb_cThread, "toplevel_messages", notmuch_rb_thread_get_toplevel_messages, 0); /* in thread.c */
309 rb_define_method (notmuch_rb_cThread, "messages", notmuch_rb_thread_get_messages, 0); /* in thread.c */
310 rb_define_method (notmuch_rb_cThread, "matched_messages", notmuch_rb_thread_get_matched_messages, 0); /* in thread.c */
311 rb_define_method (notmuch_rb_cThread, "authors", notmuch_rb_thread_get_authors, 0); /* in thread.c */
312 rb_define_method (notmuch_rb_cThread, "subject", notmuch_rb_thread_get_subject, 0); /* in thread.c */
313 rb_define_method (notmuch_rb_cThread, "oldest_date", notmuch_rb_thread_get_oldest_date, 0); /* in thread.c */
314 rb_define_method (notmuch_rb_cThread, "newest_date", notmuch_rb_thread_get_newest_date, 0); /* in thread.c */
315 rb_define_method (notmuch_rb_cThread, "tags", notmuch_rb_thread_get_tags, 0); /* in thread.c */
318 * Document-class: Notmuch::Message
322 notmuch_rb_cMessage = rb_define_class_under (mod, "Message", rb_cData);
323 rb_undef_method (notmuch_rb_cMessage, "initialize");
324 rb_define_method (notmuch_rb_cMessage, "destroy!", notmuch_rb_message_destroy, 0); /* in message.c */
325 rb_define_method (notmuch_rb_cMessage, "message_id", notmuch_rb_message_get_message_id, 0); /* in message.c */
326 rb_define_method (notmuch_rb_cMessage, "thread_id", notmuch_rb_message_get_thread_id, 0); /* in message.c */
327 rb_define_method (notmuch_rb_cMessage, "replies", notmuch_rb_message_get_replies, 0); /* in message.c */
328 rb_define_method (notmuch_rb_cMessage, "filename", notmuch_rb_message_get_filename, 0); /* in message.c */
329 rb_define_method (notmuch_rb_cMessage, "filenames", notmuch_rb_message_get_filenames, 0); /* in message.c */
330 rb_define_method (notmuch_rb_cMessage, "get_flag", notmuch_rb_message_get_flag, 1); /* in message.c */
331 rb_define_method (notmuch_rb_cMessage, "set_flag", notmuch_rb_message_set_flag, 2); /* in message.c */
332 rb_define_method (notmuch_rb_cMessage, "date", notmuch_rb_message_get_date, 0); /* in message.c */
333 rb_define_method (notmuch_rb_cMessage, "header", notmuch_rb_message_get_header, 1); /* in message.c */
334 rb_define_alias (notmuch_rb_cMessage, "[]", "header");
335 rb_define_method (notmuch_rb_cMessage, "tags", notmuch_rb_message_get_tags, 0); /* in message.c */
336 rb_define_method (notmuch_rb_cMessage, "add_tag", notmuch_rb_message_add_tag, 1); /* in message.c */
337 rb_define_alias (notmuch_rb_cMessage, "<<", "add_tag");
338 rb_define_method (notmuch_rb_cMessage, "remove_tag", notmuch_rb_message_remove_tag, 1); /* in message.c */
339 rb_define_method (notmuch_rb_cMessage, "remove_all_tags", notmuch_rb_message_remove_all_tags, 0); /* in message.c */
340 rb_define_method (notmuch_rb_cMessage, "maildir_flags_to_tags", notmuch_rb_message_maildir_flags_to_tags, 0); /* in message.c */
341 rb_define_method (notmuch_rb_cMessage, "tags_to_maildir_flags", notmuch_rb_message_tags_to_maildir_flags, 0); /* in message.c */
342 rb_define_method (notmuch_rb_cMessage, "freeze", notmuch_rb_message_freeze, 0); /* in message.c */
343 rb_define_method (notmuch_rb_cMessage, "thaw", notmuch_rb_message_thaw, 0); /* in message.c */
346 * Document-class: Notmuch::Tags
350 notmuch_rb_cTags = rb_define_class_under (mod, "Tags", rb_cData);
351 rb_undef_method (notmuch_rb_cTags, "initialize");
352 rb_define_method (notmuch_rb_cTags, "destroy!", notmuch_rb_tags_destroy, 0); /* in tags.c */
353 rb_define_method (notmuch_rb_cTags, "each", notmuch_rb_tags_each, 0); /* in tags.c */
354 rb_include_module (notmuch_rb_cTags, rb_mEnumerable);