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>
23 VALUE notmuch_rb_cDatabase;
24 VALUE notmuch_rb_cDirectory;
25 VALUE notmuch_rb_cQuery;
26 VALUE notmuch_rb_cThreads;
27 VALUE notmuch_rb_cThread;
28 VALUE notmuch_rb_cMessages;
29 VALUE notmuch_rb_cMessage;
31 VALUE notmuch_rb_eBaseError;
32 VALUE notmuch_rb_eDatabaseError;
33 VALUE notmuch_rb_eMemoryError;
34 VALUE notmuch_rb_eReadOnlyError;
35 VALUE notmuch_rb_eXapianError;
36 VALUE notmuch_rb_eFileError;
37 VALUE notmuch_rb_eFileNotEmailError;
38 VALUE notmuch_rb_eNullPointerError;
39 VALUE notmuch_rb_eTagTooLongError;
40 VALUE notmuch_rb_eUnbalancedFreezeThawError;
41 VALUE notmuch_rb_eUnbalancedAtomicError;
45 const rb_data_type_t notmuch_rb_object_type = {
46 .wrap_struct_name = "notmuch_object",
48 .dfree = notmuch_rb_object_free,
52 #define define_type(id) \
53 const rb_data_type_t notmuch_rb_ ## id ## _type = { \
54 .wrap_struct_name = "notmuch_" #id, \
55 .parent = ¬much_rb_object_type, \
56 .data = ¬much_ ## id ## _destroy, \
58 .dfree = notmuch_rb_object_free, \
62 define_type (database);
63 define_type (directory);
65 define_type (threads);
67 define_type (messages);
68 define_type (message);
71 * Document-module: Notmuch
75 * Ruby extension to the <tt>notmuch</tt> mail library.
79 * Following are the classes that are most likely to be of interest to
95 ID_call = rb_intern ("call");
97 mod = rb_define_module ("Notmuch");
100 * Document-const: Notmuch::MODE_READ_ONLY
102 * Open the database in read only mode
104 rb_define_const (mod, "MODE_READ_ONLY", INT2FIX (NOTMUCH_DATABASE_MODE_READ_ONLY));
106 * Document-const: Notmuch::MODE_READ_WRITE
108 * Open the database in read write mode
110 rb_define_const (mod, "MODE_READ_WRITE", INT2FIX (NOTMUCH_DATABASE_MODE_READ_WRITE));
112 * Document-const: Notmuch::SORT_OLDEST_FIRST
114 * Sort query results by oldest first
116 rb_define_const (mod, "SORT_OLDEST_FIRST", INT2FIX (NOTMUCH_SORT_OLDEST_FIRST));
118 * Document-const: Notmuch::SORT_NEWEST_FIRST
120 * Sort query results by newest first
122 rb_define_const (mod, "SORT_NEWEST_FIRST", INT2FIX (NOTMUCH_SORT_NEWEST_FIRST));
124 * Document-const: Notmuch::SORT_MESSAGE_ID
126 * Sort query results by message id
128 rb_define_const (mod, "SORT_MESSAGE_ID", INT2FIX (NOTMUCH_SORT_MESSAGE_ID));
130 * Document-const: Notmuch::SORT_UNSORTED
132 * Do not sort query results
134 rb_define_const (mod, "SORT_UNSORTED", INT2FIX (NOTMUCH_SORT_UNSORTED));
136 * Document-const: Notmuch::MESSAGE_FLAG_MATCH
138 * Message flag "match"
140 rb_define_const (mod, "MESSAGE_FLAG_MATCH", INT2FIX (NOTMUCH_MESSAGE_FLAG_MATCH));
142 * Document-const: Notmuch::MESSAGE_FLAG_EXCLUDED
144 * Message flag "excluded"
146 rb_define_const (mod, "MESSAGE_FLAG_EXCLUDED", INT2FIX (NOTMUCH_MESSAGE_FLAG_EXCLUDED));
148 * Document-const: Notmuch::TAG_MAX
150 * Maximum allowed length of a tag
152 rb_define_const (mod, "TAG_MAX", INT2FIX (NOTMUCH_TAG_MAX));
154 * Document-const: Notmuch::EXCLUDE_FLAG
156 * Only flag excluded results
158 rb_define_const (mod, "EXCLUDE_FLAG", INT2FIX (NOTMUCH_EXCLUDE_FLAG));
160 * Document-const: Notmuch::EXCLUDE_TRUE
162 * Exclude messages from the results
164 rb_define_const (mod, "EXCLUDE_TRUE", INT2FIX (NOTMUCH_EXCLUDE_TRUE));
166 * Document-const: Notmuch::EXCLUDE_FALSE
168 * Don't exclude anything
170 rb_define_const (mod, "EXCLUDE_FALSE", INT2FIX (NOTMUCH_EXCLUDE_FALSE));
172 * Document-const: Notmuch::EXCLUDE_ALL
174 * Exclude all results
176 rb_define_const (mod, "EXCLUDE_ALL", INT2FIX (NOTMUCH_EXCLUDE_ALL));
179 * Document-class: Notmuch::BaseError
181 * Base class for all notmuch exceptions
183 notmuch_rb_eBaseError = rb_define_class_under (mod, "BaseError", rb_eStandardError);
185 * Document-class: Notmuch::DatabaseError
187 * Raised when the database can't be created or opened.
189 notmuch_rb_eDatabaseError = rb_define_class_under (mod, "DatabaseError", notmuch_rb_eBaseError);
191 * Document-class: Notmuch::MemoryError
193 * Raised when notmuch is out of memory
195 notmuch_rb_eMemoryError = rb_define_class_under (mod, "MemoryError", notmuch_rb_eBaseError);
197 * Document-class: Notmuch::ReadOnlyError
199 * Raised when an attempt was made to write to a database opened in read-only
202 notmuch_rb_eReadOnlyError = rb_define_class_under (mod, "ReadOnlyError", notmuch_rb_eBaseError);
204 * Document-class: Notmuch::XapianError
206 * Raised when a Xapian exception occurs
208 notmuch_rb_eXapianError = rb_define_class_under (mod, "XapianError", notmuch_rb_eBaseError);
210 * Document-class: Notmuch::FileError
212 * Raised when an error occurs trying to read or write to a file.
214 notmuch_rb_eFileError = rb_define_class_under (mod, "FileError", notmuch_rb_eBaseError);
216 * Document-class: Notmuch::FileNotEmailError
218 * Raised when a file is presented that doesn't appear to be an email message.
220 notmuch_rb_eFileNotEmailError = rb_define_class_under (mod, "FileNotEmailError", notmuch_rb_eBaseError);
222 * Document-class: Notmuch::NullPointerError
224 * Raised when the user erroneously passes a +NULL+ pointer to a notmuch
227 notmuch_rb_eNullPointerError = rb_define_class_under (mod, "NullPointerError", notmuch_rb_eBaseError);
229 * Document-class: Notmuch::TagTooLongError
231 * Raised when a tag value is too long (exceeds Notmuch::TAG_MAX)
233 notmuch_rb_eTagTooLongError = rb_define_class_under (mod, "TagTooLongError", notmuch_rb_eBaseError);
235 * Document-class: Notmuch::UnbalancedFreezeThawError
237 * Raised when the notmuch_message_thaw function has been called more times
238 * than notmuch_message_freeze.
240 notmuch_rb_eUnbalancedFreezeThawError = rb_define_class_under (mod, "UnbalancedFreezeThawError",
241 notmuch_rb_eBaseError);
243 * Document-class: Notmuch::UnbalancedAtomicError
245 * Raised when notmuch_database_end_atomic has been called more times than
246 * notmuch_database_begin_atomic
248 notmuch_rb_eUnbalancedAtomicError = rb_define_class_under (mod, "UnbalancedAtomicError",
249 notmuch_rb_eBaseError);
251 * Document-class: Notmuch::Database
253 * Notmuch database interaction
255 notmuch_rb_cDatabase = rb_define_class_under (mod, "Database", rb_cObject);
256 rb_define_alloc_func (notmuch_rb_cDatabase, notmuch_rb_database_alloc);
257 rb_define_singleton_method (notmuch_rb_cDatabase, "open", notmuch_rb_database_open, -1); /* in database.c */
258 rb_define_method (notmuch_rb_cDatabase, "initialize", notmuch_rb_database_initialize, -1); /* in database.c */
259 rb_define_method (notmuch_rb_cDatabase, "destroy!", notmuch_rb_database_destroy, 0); /* in database.c */
260 rb_define_method (notmuch_rb_cDatabase, "close", notmuch_rb_database_close, 0); /* in database.c */
261 rb_define_method (notmuch_rb_cDatabase, "path", notmuch_rb_database_path, 0); /* in database.c */
262 rb_define_method (notmuch_rb_cDatabase, "version", notmuch_rb_database_version, 0); /* in database.c */
263 rb_define_method (notmuch_rb_cDatabase, "needs_upgrade?", notmuch_rb_database_needs_upgrade, 0); /* in database.c */
264 rb_define_method (notmuch_rb_cDatabase, "upgrade!", notmuch_rb_database_upgrade, 0); /* in database.c */
265 rb_define_method (notmuch_rb_cDatabase, "begin_atomic", notmuch_rb_database_begin_atomic, 0); /* in database.c */
266 rb_define_method (notmuch_rb_cDatabase, "end_atomic", notmuch_rb_database_end_atomic, 0); /* in database.c */
267 rb_define_method (notmuch_rb_cDatabase, "get_directory", notmuch_rb_database_get_directory, 1); /* in database.c */
268 rb_define_method (notmuch_rb_cDatabase, "add_message", notmuch_rb_database_add_message, 1); /* in database.c */
269 rb_define_method (notmuch_rb_cDatabase, "remove_message", notmuch_rb_database_remove_message, 1); /* in database.c */
270 rb_define_method (notmuch_rb_cDatabase, "find_message",
271 notmuch_rb_database_find_message, 1); /* in database.c */
272 rb_define_method (notmuch_rb_cDatabase, "find_message_by_filename",
273 notmuch_rb_database_find_message_by_filename, 1); /* in database.c */
274 rb_define_method (notmuch_rb_cDatabase, "all_tags", notmuch_rb_database_get_all_tags, 0); /* in database.c */
275 rb_define_method (notmuch_rb_cDatabase, "query", notmuch_rb_database_query_create, -1); /* in database.c */
278 * Document-class: Notmuch::Directory
282 notmuch_rb_cDirectory = rb_define_class_under (mod, "Directory", rb_cObject);
283 rb_undef_method (notmuch_rb_cDirectory, "initialize");
284 rb_define_method (notmuch_rb_cDirectory, "destroy!", notmuch_rb_directory_destroy, 0); /* in directory.c */
285 rb_define_method (notmuch_rb_cDirectory, "mtime", notmuch_rb_directory_get_mtime, 0); /* in directory.c */
286 rb_define_method (notmuch_rb_cDirectory, "mtime=", notmuch_rb_directory_set_mtime, 1); /* in directory.c */
287 rb_define_method (notmuch_rb_cDirectory, "child_files", notmuch_rb_directory_get_child_files, 0); /* in directory.c */
288 rb_define_method (notmuch_rb_cDirectory, "child_directories", notmuch_rb_directory_get_child_directories, 0); /* in directory.c */
291 * Document-class: Notmuch::Query
295 notmuch_rb_cQuery = rb_define_class_under (mod, "Query", rb_cObject);
296 rb_undef_method (notmuch_rb_cQuery, "initialize");
297 rb_define_method (notmuch_rb_cQuery, "destroy!", notmuch_rb_query_destroy, 0); /* in query.c */
298 rb_define_method (notmuch_rb_cQuery, "sort", notmuch_rb_query_get_sort, 0); /* in query.c */
299 rb_define_method (notmuch_rb_cQuery, "sort=", notmuch_rb_query_set_sort, 1); /* in query.c */
300 rb_define_method (notmuch_rb_cQuery, "to_s", notmuch_rb_query_get_string, 0); /* in query.c */
301 rb_define_method (notmuch_rb_cQuery, "add_tag_exclude", notmuch_rb_query_add_tag_exclude, 1); /* in query.c */
302 rb_define_method (notmuch_rb_cQuery, "omit_excluded=", notmuch_rb_query_set_omit_excluded, 1); /* in query.c */
303 rb_define_method (notmuch_rb_cQuery, "search_threads", notmuch_rb_query_search_threads, 0); /* in query.c */
304 rb_define_method (notmuch_rb_cQuery, "search_messages", notmuch_rb_query_search_messages, 0); /* in query.c */
305 rb_define_method (notmuch_rb_cQuery, "count_messages", notmuch_rb_query_count_messages, 0); /* in query.c */
306 rb_define_method (notmuch_rb_cQuery, "count_threads", notmuch_rb_query_count_threads, 0); /* in query.c */
309 * Document-class: Notmuch::Threads
313 notmuch_rb_cThreads = rb_define_class_under (mod, "Threads", rb_cObject);
314 rb_undef_method (notmuch_rb_cThreads, "initialize");
315 rb_define_method (notmuch_rb_cThreads, "destroy!", notmuch_rb_threads_destroy, 0); /* in threads.c */
316 rb_define_method (notmuch_rb_cThreads, "each", notmuch_rb_threads_each, 0); /* in threads.c */
317 rb_include_module (notmuch_rb_cThreads, rb_mEnumerable);
320 * Document-class: Notmuch::Messages
324 notmuch_rb_cMessages = rb_define_class_under (mod, "Messages", rb_cObject);
325 rb_undef_method (notmuch_rb_cMessages, "initialize");
326 rb_define_method (notmuch_rb_cMessages, "destroy!", notmuch_rb_messages_destroy, 0); /* in messages.c */
327 rb_define_method (notmuch_rb_cMessages, "each", notmuch_rb_messages_each, 0); /* in messages.c */
328 rb_define_method (notmuch_rb_cMessages, "tags", notmuch_rb_messages_collect_tags, 0); /* in messages.c */
329 rb_include_module (notmuch_rb_cMessages, rb_mEnumerable);
332 * Document-class: Notmuch::Thread
336 notmuch_rb_cThread = rb_define_class_under (mod, "Thread", rb_cObject);
337 rb_undef_method (notmuch_rb_cThread, "initialize");
338 rb_define_method (notmuch_rb_cThread, "destroy!", notmuch_rb_thread_destroy, 0); /* in thread.c */
339 rb_define_method (notmuch_rb_cThread, "thread_id", notmuch_rb_thread_get_thread_id, 0); /* in thread.c */
340 rb_define_method (notmuch_rb_cThread, "total_messages", notmuch_rb_thread_get_total_messages, 0); /* in thread.c */
341 rb_define_method (notmuch_rb_cThread, "toplevel_messages", notmuch_rb_thread_get_toplevel_messages, 0); /* in thread.c */
342 rb_define_method (notmuch_rb_cThread, "messages", notmuch_rb_thread_get_messages, 0); /* in thread.c */
343 rb_define_method (notmuch_rb_cThread, "matched_messages", notmuch_rb_thread_get_matched_messages, 0); /* in thread.c */
344 rb_define_method (notmuch_rb_cThread, "authors", notmuch_rb_thread_get_authors, 0); /* in thread.c */
345 rb_define_method (notmuch_rb_cThread, "subject", notmuch_rb_thread_get_subject, 0); /* in thread.c */
346 rb_define_method (notmuch_rb_cThread, "oldest_date", notmuch_rb_thread_get_oldest_date, 0); /* in thread.c */
347 rb_define_method (notmuch_rb_cThread, "newest_date", notmuch_rb_thread_get_newest_date, 0); /* in thread.c */
348 rb_define_method (notmuch_rb_cThread, "tags", notmuch_rb_thread_get_tags, 0); /* in thread.c */
351 * Document-class: Notmuch::Message
355 notmuch_rb_cMessage = rb_define_class_under (mod, "Message", rb_cObject);
356 rb_undef_method (notmuch_rb_cMessage, "initialize");
357 rb_define_method (notmuch_rb_cMessage, "destroy!", notmuch_rb_message_destroy, 0); /* in message.c */
358 rb_define_method (notmuch_rb_cMessage, "message_id", notmuch_rb_message_get_message_id, 0); /* in message.c */
359 rb_define_method (notmuch_rb_cMessage, "thread_id", notmuch_rb_message_get_thread_id, 0); /* in message.c */
360 rb_define_method (notmuch_rb_cMessage, "replies", notmuch_rb_message_get_replies, 0); /* in message.c */
361 rb_define_method (notmuch_rb_cMessage, "filename", notmuch_rb_message_get_filename, 0); /* in message.c */
362 rb_define_method (notmuch_rb_cMessage, "filenames", notmuch_rb_message_get_filenames, 0); /* in message.c */
363 rb_define_method (notmuch_rb_cMessage, "get_flag", notmuch_rb_message_get_flag, 1); /* in message.c */
364 rb_define_method (notmuch_rb_cMessage, "set_flag", notmuch_rb_message_set_flag, 2); /* in message.c */
365 rb_define_method (notmuch_rb_cMessage, "date", notmuch_rb_message_get_date, 0); /* in message.c */
366 rb_define_method (notmuch_rb_cMessage, "header", notmuch_rb_message_get_header, 1); /* in message.c */
367 rb_define_alias (notmuch_rb_cMessage, "[]", "header");
368 rb_define_method (notmuch_rb_cMessage, "tags", notmuch_rb_message_get_tags, 0); /* in message.c */
369 rb_define_method (notmuch_rb_cMessage, "add_tag", notmuch_rb_message_add_tag, 1); /* in message.c */
370 rb_define_alias (notmuch_rb_cMessage, "<<", "add_tag");
371 rb_define_method (notmuch_rb_cMessage, "remove_tag", notmuch_rb_message_remove_tag, 1); /* in message.c */
372 rb_define_method (notmuch_rb_cMessage, "remove_all_tags", notmuch_rb_message_remove_all_tags, 0); /* in message.c */
373 rb_define_method (notmuch_rb_cMessage, "maildir_flags_to_tags", notmuch_rb_message_maildir_flags_to_tags, 0); /* in message.c */
374 rb_define_method (notmuch_rb_cMessage, "tags_to_maildir_flags", notmuch_rb_message_tags_to_maildir_flags, 0); /* in message.c */
375 rb_define_method (notmuch_rb_cMessage, "freeze", notmuch_rb_message_freeze, 0); /* in message.c */
376 rb_define_method (notmuch_rb_cMessage, "thaw", notmuch_rb_message_thaw, 0); /* in message.c */