test: increase cffi timeout
[notmuch] / bindings / ruby / init.c
1 /* The Ruby interface to the notmuch mail library
2  *
3  * Copyright © 2010, 2011, 2012 Ali Polatel
4  *
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.
9  *
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.
14  *
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/ .
17  *
18  * Author: Ali Polatel <alip@exherbo.org>
19  */
20
21 #include "defs.h"
22
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;
32
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;
44
45 ID ID_call;
46 ID ID_db_create;
47 ID ID_db_mode;
48
49 const rb_data_type_t notmuch_rb_object_type = {
50     .wrap_struct_name = "notmuch_object",
51     .function = {
52         .dfree = notmuch_rb_object_free,
53     },
54 };
55
56 #define define_type(id) \
57     const rb_data_type_t notmuch_rb_ ## id ## _type = { \
58         .wrap_struct_name = "notmuch_" #id, \
59         .parent = &notmuch_rb_object_type, \
60         .data = &notmuch_ ## id ## _destroy, \
61         .function = { \
62             .dfree = notmuch_rb_object_free, \
63         }, \
64     }
65
66 define_type (database);
67 define_type (directory);
68 define_type (filenames);
69 define_type (query);
70 define_type (threads);
71 define_type (thread);
72 define_type (messages);
73 define_type (message);
74 define_type (tags);
75
76 /*
77  * Document-module: Notmuch
78  *
79  * == Summary
80  *
81  * Ruby extension to the <tt>notmuch</tt> mail library.
82  *
83  * == Classes
84  *
85  * Following are the classes that are most likely to be of interest to
86  * the user:
87  *
88  * - Notmuch::Database
89  * - Notmuch::FileNames
90  * - Notmuch::Query
91  * - Notmuch::Threads
92  * - Notmuch::Messages
93  * - Notmuch::Thread
94  * - Notmuch::Message
95  * - Notmuch::Tags
96  */
97
98 void
99 Init_notmuch (void)
100 {
101     VALUE mod;
102
103     ID_call = rb_intern ("call");
104     ID_db_create = rb_intern ("create");
105     ID_db_mode = rb_intern ("mode");
106
107     mod = rb_define_module ("Notmuch");
108
109     /*
110      * Document-const: Notmuch::MODE_READ_ONLY
111      *
112      * Open the database in read only mode
113      */
114     rb_define_const (mod, "MODE_READ_ONLY", INT2FIX (NOTMUCH_DATABASE_MODE_READ_ONLY));
115     /*
116      * Document-const: Notmuch::MODE_READ_WRITE
117      *
118      * Open the database in read write mode
119      */
120     rb_define_const (mod, "MODE_READ_WRITE", INT2FIX (NOTMUCH_DATABASE_MODE_READ_WRITE));
121     /*
122      * Document-const: Notmuch::SORT_OLDEST_FIRST
123      *
124      * Sort query results by oldest first
125      */
126     rb_define_const (mod, "SORT_OLDEST_FIRST", INT2FIX (NOTMUCH_SORT_OLDEST_FIRST));
127     /*
128      * Document-const: Notmuch::SORT_NEWEST_FIRST
129      *
130      * Sort query results by newest first
131      */
132     rb_define_const (mod, "SORT_NEWEST_FIRST", INT2FIX (NOTMUCH_SORT_NEWEST_FIRST));
133     /*
134      * Document-const: Notmuch::SORT_MESSAGE_ID
135      *
136      * Sort query results by message id
137      */
138     rb_define_const (mod, "SORT_MESSAGE_ID", INT2FIX (NOTMUCH_SORT_MESSAGE_ID));
139     /*
140      * Document-const: Notmuch::SORT_UNSORTED
141      *
142      * Do not sort query results
143      */
144     rb_define_const (mod, "SORT_UNSORTED", INT2FIX (NOTMUCH_SORT_UNSORTED));
145     /*
146      * Document-const: Notmuch::MESSAGE_FLAG_MATCH
147      *
148      * Message flag "match"
149      */
150     rb_define_const (mod, "MESSAGE_FLAG_MATCH", INT2FIX (NOTMUCH_MESSAGE_FLAG_MATCH));
151     /*
152      * Document-const: Notmuch::MESSAGE_FLAG_EXCLUDED
153      *
154      * Message flag "excluded"
155      */
156     rb_define_const (mod, "MESSAGE_FLAG_EXCLUDED", INT2FIX (NOTMUCH_MESSAGE_FLAG_EXCLUDED));
157     /*
158      * Document-const: Notmuch::TAG_MAX
159      *
160      * Maximum allowed length of a tag
161      */
162     rb_define_const (mod, "TAG_MAX", INT2FIX (NOTMUCH_TAG_MAX));
163     /*
164      * Document-const: Notmuch::EXCLUDE_FLAG
165      *
166      * Only flag excluded results
167      */
168     rb_define_const (mod, "EXCLUDE_FLAG", INT2FIX (NOTMUCH_EXCLUDE_FLAG));
169     /*
170      * Document-const: Notmuch::EXCLUDE_TRUE
171      *
172      * Exclude messages from the results
173      */
174     rb_define_const (mod, "EXCLUDE_TRUE", INT2FIX (NOTMUCH_EXCLUDE_TRUE));
175     /*
176      * Document-const: Notmuch::EXCLUDE_FALSE
177      *
178      * Don't exclude anything
179      */
180     rb_define_const (mod, "EXCLUDE_FALSE", INT2FIX (NOTMUCH_EXCLUDE_FALSE));
181     /*
182      * Document-const: Notmuch::EXCLUDE_ALL
183      *
184      * Exclude all results
185      */
186     rb_define_const (mod, "EXCLUDE_ALL", INT2FIX (NOTMUCH_EXCLUDE_ALL));
187
188     /*
189      * Document-class: Notmuch::BaseError
190      *
191      * Base class for all notmuch exceptions
192      */
193     notmuch_rb_eBaseError = rb_define_class_under (mod, "BaseError", rb_eStandardError);
194     /*
195      * Document-class: Notmuch::DatabaseError
196      *
197      * Raised when the database can't be created or opened.
198      */
199     notmuch_rb_eDatabaseError = rb_define_class_under (mod, "DatabaseError", notmuch_rb_eBaseError);
200     /*
201      * Document-class: Notmuch::MemoryError
202      *
203      * Raised when notmuch is out of memory
204      */
205     notmuch_rb_eMemoryError = rb_define_class_under (mod, "MemoryError", notmuch_rb_eBaseError);
206     /*
207      * Document-class: Notmuch::ReadOnlyError
208      *
209      * Raised when an attempt was made to write to a database opened in read-only
210      * mode.
211      */
212     notmuch_rb_eReadOnlyError = rb_define_class_under (mod, "ReadOnlyError", notmuch_rb_eBaseError);
213     /*
214      * Document-class: Notmuch::XapianError
215      *
216      * Raised when a Xapian exception occurs
217      */
218     notmuch_rb_eXapianError = rb_define_class_under (mod, "XapianError", notmuch_rb_eBaseError);
219     /*
220      * Document-class: Notmuch::FileError
221      *
222      * Raised when an error occurs trying to read or write to a file.
223      */
224     notmuch_rb_eFileError = rb_define_class_under (mod, "FileError", notmuch_rb_eBaseError);
225     /*
226      * Document-class: Notmuch::FileNotEmailError
227      *
228      * Raised when a file is presented that doesn't appear to be an email message.
229      */
230     notmuch_rb_eFileNotEmailError = rb_define_class_under (mod, "FileNotEmailError", notmuch_rb_eBaseError);
231     /*
232      * Document-class: Notmuch::NullPointerError
233      *
234      * Raised when the user erroneously passes a +NULL+ pointer to a notmuch
235      * function.
236      */
237     notmuch_rb_eNullPointerError = rb_define_class_under (mod, "NullPointerError", notmuch_rb_eBaseError);
238     /*
239      * Document-class: Notmuch::TagTooLongError
240      *
241      * Raised when a tag value is too long (exceeds Notmuch::TAG_MAX)
242      */
243     notmuch_rb_eTagTooLongError = rb_define_class_under (mod, "TagTooLongError", notmuch_rb_eBaseError);
244     /*
245      * Document-class: Notmuch::UnbalancedFreezeThawError
246      *
247      * Raised when the notmuch_message_thaw function has been called more times
248      * than notmuch_message_freeze.
249      */
250     notmuch_rb_eUnbalancedFreezeThawError = rb_define_class_under (mod, "UnbalancedFreezeThawError",
251                                                                    notmuch_rb_eBaseError);
252     /*
253      * Document-class: Notmuch::UnbalancedAtomicError
254      *
255      * Raised when notmuch_database_end_atomic has been called more times than
256      * notmuch_database_begin_atomic
257      */
258     notmuch_rb_eUnbalancedAtomicError = rb_define_class_under (mod, "UnbalancedAtomicError",
259                                                                notmuch_rb_eBaseError);
260     /*
261      * Document-class: Notmuch::Database
262      *
263      * Notmuch database interaction
264      */
265     notmuch_rb_cDatabase = rb_define_class_under (mod, "Database", rb_cObject);
266     rb_define_alloc_func (notmuch_rb_cDatabase, notmuch_rb_database_alloc);
267     rb_define_singleton_method (notmuch_rb_cDatabase, "open", notmuch_rb_database_open, -1); /* in database.c */
268     rb_define_method (notmuch_rb_cDatabase, "initialize", notmuch_rb_database_initialize, -1); /* in database.c */
269     rb_define_method (notmuch_rb_cDatabase, "destroy!", notmuch_rb_database_destroy, 0); /* in database.c */
270     rb_define_method (notmuch_rb_cDatabase, "close", notmuch_rb_database_close, 0); /* in database.c */
271     rb_define_method (notmuch_rb_cDatabase, "path", notmuch_rb_database_path, 0); /* in database.c */
272     rb_define_method (notmuch_rb_cDatabase, "version", notmuch_rb_database_version, 0); /* in database.c */
273     rb_define_method (notmuch_rb_cDatabase, "needs_upgrade?", notmuch_rb_database_needs_upgrade, 0); /* in database.c */
274     rb_define_method (notmuch_rb_cDatabase, "upgrade!", notmuch_rb_database_upgrade, 0); /* in database.c */
275     rb_define_method (notmuch_rb_cDatabase, "begin_atomic", notmuch_rb_database_begin_atomic, 0); /* in database.c */
276     rb_define_method (notmuch_rb_cDatabase, "end_atomic", notmuch_rb_database_end_atomic, 0); /* in database.c */
277     rb_define_method (notmuch_rb_cDatabase, "get_directory", notmuch_rb_database_get_directory, 1); /* in database.c */
278     rb_define_method (notmuch_rb_cDatabase, "add_message", notmuch_rb_database_add_message, 1); /* in database.c */
279     rb_define_method (notmuch_rb_cDatabase, "remove_message", notmuch_rb_database_remove_message, 1); /* in database.c */
280     rb_define_method (notmuch_rb_cDatabase, "find_message",
281                       notmuch_rb_database_find_message, 1); /* in database.c */
282     rb_define_method (notmuch_rb_cDatabase, "find_message_by_filename",
283                       notmuch_rb_database_find_message_by_filename, 1); /* in database.c */
284     rb_define_method (notmuch_rb_cDatabase, "all_tags", notmuch_rb_database_get_all_tags, 0); /* in database.c */
285     rb_define_method (notmuch_rb_cDatabase, "query", notmuch_rb_database_query_create, -1); /* in database.c */
286
287     /*
288      * Document-class: Notmuch::Directory
289      *
290      * Notmuch directory
291      */
292     notmuch_rb_cDirectory = rb_define_class_under (mod, "Directory", rb_cObject);
293     rb_undef_method (notmuch_rb_cDirectory, "initialize");
294     rb_define_method (notmuch_rb_cDirectory, "destroy!", notmuch_rb_directory_destroy, 0); /* in directory.c */
295     rb_define_method (notmuch_rb_cDirectory, "mtime", notmuch_rb_directory_get_mtime, 0); /* in directory.c */
296     rb_define_method (notmuch_rb_cDirectory, "mtime=", notmuch_rb_directory_set_mtime, 1); /* in directory.c */
297     rb_define_method (notmuch_rb_cDirectory, "child_files", notmuch_rb_directory_get_child_files, 0); /* in directory.c */
298     rb_define_method (notmuch_rb_cDirectory, "child_directories", notmuch_rb_directory_get_child_directories, 0); /* in directory.c */
299
300     /*
301      * Document-class: Notmuch::FileNames
302      *
303      * Notmuch file names
304      */
305     notmuch_rb_cFileNames = rb_define_class_under (mod, "FileNames", rb_cObject);
306     rb_undef_method (notmuch_rb_cFileNames, "initialize");
307     rb_define_method (notmuch_rb_cFileNames, "destroy!", notmuch_rb_filenames_destroy, 0); /* in filenames.c */
308     rb_define_method (notmuch_rb_cFileNames, "each", notmuch_rb_filenames_each, 0); /* in filenames.c */
309     rb_include_module (notmuch_rb_cFileNames, rb_mEnumerable);
310
311     /*
312      * Document-class: Notmuch::Query
313      *
314      * Notmuch query
315      */
316     notmuch_rb_cQuery = rb_define_class_under (mod, "Query", rb_cObject);
317     rb_undef_method (notmuch_rb_cQuery, "initialize");
318     rb_define_method (notmuch_rb_cQuery, "destroy!", notmuch_rb_query_destroy, 0); /* in query.c */
319     rb_define_method (notmuch_rb_cQuery, "sort", notmuch_rb_query_get_sort, 0); /* in query.c */
320     rb_define_method (notmuch_rb_cQuery, "sort=", notmuch_rb_query_set_sort, 1); /* in query.c */
321     rb_define_method (notmuch_rb_cQuery, "to_s", notmuch_rb_query_get_string, 0); /* in query.c */
322     rb_define_method (notmuch_rb_cQuery, "add_tag_exclude", notmuch_rb_query_add_tag_exclude, 1); /* in query.c */
323     rb_define_method (notmuch_rb_cQuery, "omit_excluded=", notmuch_rb_query_set_omit_excluded, 1); /* in query.c */
324     rb_define_method (notmuch_rb_cQuery, "search_threads", notmuch_rb_query_search_threads, 0); /* in query.c */
325     rb_define_method (notmuch_rb_cQuery, "search_messages", notmuch_rb_query_search_messages, 0); /* in query.c */
326     rb_define_method (notmuch_rb_cQuery, "count_messages", notmuch_rb_query_count_messages, 0); /* in query.c */
327     rb_define_method (notmuch_rb_cQuery, "count_threads", notmuch_rb_query_count_threads, 0); /* in query.c */
328
329     /*
330      * Document-class: Notmuch::Threads
331      *
332      * Notmuch threads
333      */
334     notmuch_rb_cThreads = rb_define_class_under (mod, "Threads", rb_cObject);
335     rb_undef_method (notmuch_rb_cThreads, "initialize");
336     rb_define_method (notmuch_rb_cThreads, "destroy!", notmuch_rb_threads_destroy, 0); /* in threads.c */
337     rb_define_method (notmuch_rb_cThreads, "each", notmuch_rb_threads_each, 0); /* in threads.c */
338     rb_include_module (notmuch_rb_cThreads, rb_mEnumerable);
339
340     /*
341      * Document-class: Notmuch::Messages
342      *
343      * Notmuch messages
344      */
345     notmuch_rb_cMessages = rb_define_class_under (mod, "Messages", rb_cObject);
346     rb_undef_method (notmuch_rb_cMessages, "initialize");
347     rb_define_method (notmuch_rb_cMessages, "destroy!", notmuch_rb_messages_destroy, 0); /* in messages.c */
348     rb_define_method (notmuch_rb_cMessages, "each", notmuch_rb_messages_each, 0); /* in messages.c */
349     rb_define_method (notmuch_rb_cMessages, "tags", notmuch_rb_messages_collect_tags, 0); /* in messages.c */
350     rb_include_module (notmuch_rb_cMessages, rb_mEnumerable);
351
352     /*
353      * Document-class: Notmuch::Thread
354      *
355      * Notmuch thread
356      */
357     notmuch_rb_cThread = rb_define_class_under (mod, "Thread", rb_cObject);
358     rb_undef_method (notmuch_rb_cThread, "initialize");
359     rb_define_method (notmuch_rb_cThread, "destroy!", notmuch_rb_thread_destroy, 0); /* in thread.c */
360     rb_define_method (notmuch_rb_cThread, "thread_id", notmuch_rb_thread_get_thread_id, 0); /* in thread.c */
361     rb_define_method (notmuch_rb_cThread, "total_messages", notmuch_rb_thread_get_total_messages, 0); /* in thread.c */
362     rb_define_method (notmuch_rb_cThread, "toplevel_messages", notmuch_rb_thread_get_toplevel_messages, 0); /* in thread.c */
363     rb_define_method (notmuch_rb_cThread, "messages", notmuch_rb_thread_get_messages, 0); /* in thread.c */
364     rb_define_method (notmuch_rb_cThread, "matched_messages", notmuch_rb_thread_get_matched_messages, 0); /* in thread.c */
365     rb_define_method (notmuch_rb_cThread, "authors", notmuch_rb_thread_get_authors, 0); /* in thread.c */
366     rb_define_method (notmuch_rb_cThread, "subject", notmuch_rb_thread_get_subject, 0); /* in thread.c */
367     rb_define_method (notmuch_rb_cThread, "oldest_date", notmuch_rb_thread_get_oldest_date, 0); /* in thread.c */
368     rb_define_method (notmuch_rb_cThread, "newest_date", notmuch_rb_thread_get_newest_date, 0); /* in thread.c */
369     rb_define_method (notmuch_rb_cThread, "tags", notmuch_rb_thread_get_tags, 0); /* in thread.c */
370
371     /*
372      * Document-class: Notmuch::Message
373      *
374      * Notmuch message
375      */
376     notmuch_rb_cMessage = rb_define_class_under (mod, "Message", rb_cObject);
377     rb_undef_method (notmuch_rb_cMessage, "initialize");
378     rb_define_method (notmuch_rb_cMessage, "destroy!", notmuch_rb_message_destroy, 0); /* in message.c */
379     rb_define_method (notmuch_rb_cMessage, "message_id", notmuch_rb_message_get_message_id, 0); /* in message.c */
380     rb_define_method (notmuch_rb_cMessage, "thread_id", notmuch_rb_message_get_thread_id, 0); /* in message.c */
381     rb_define_method (notmuch_rb_cMessage, "replies", notmuch_rb_message_get_replies, 0); /* in message.c */
382     rb_define_method (notmuch_rb_cMessage, "filename", notmuch_rb_message_get_filename, 0); /* in message.c */
383     rb_define_method (notmuch_rb_cMessage, "filenames", notmuch_rb_message_get_filenames, 0); /* in message.c */
384     rb_define_method (notmuch_rb_cMessage, "get_flag", notmuch_rb_message_get_flag, 1); /* in message.c */
385     rb_define_method (notmuch_rb_cMessage, "set_flag", notmuch_rb_message_set_flag, 2); /* in message.c */
386     rb_define_method (notmuch_rb_cMessage, "date", notmuch_rb_message_get_date, 0); /* in message.c */
387     rb_define_method (notmuch_rb_cMessage, "header", notmuch_rb_message_get_header, 1); /* in message.c */
388     rb_define_alias (notmuch_rb_cMessage, "[]", "header");
389     rb_define_method (notmuch_rb_cMessage, "tags", notmuch_rb_message_get_tags, 0); /* in message.c */
390     rb_define_method (notmuch_rb_cMessage, "add_tag", notmuch_rb_message_add_tag, 1); /* in message.c */
391     rb_define_alias (notmuch_rb_cMessage, "<<", "add_tag");
392     rb_define_method (notmuch_rb_cMessage, "remove_tag", notmuch_rb_message_remove_tag, 1); /* in message.c */
393     rb_define_method (notmuch_rb_cMessage, "remove_all_tags", notmuch_rb_message_remove_all_tags, 0); /* in message.c */
394     rb_define_method (notmuch_rb_cMessage, "maildir_flags_to_tags", notmuch_rb_message_maildir_flags_to_tags, 0); /* in message.c */
395     rb_define_method (notmuch_rb_cMessage, "tags_to_maildir_flags", notmuch_rb_message_tags_to_maildir_flags, 0); /* in message.c */
396     rb_define_method (notmuch_rb_cMessage, "freeze", notmuch_rb_message_freeze, 0); /* in message.c */
397     rb_define_method (notmuch_rb_cMessage, "thaw", notmuch_rb_message_thaw, 0); /* in message.c */
398
399     /*
400      * Document-class: Notmuch::Tags
401      *
402      * Notmuch tags
403      */
404     notmuch_rb_cTags = rb_define_class_under (mod, "Tags", rb_cObject);
405     rb_undef_method (notmuch_rb_cTags, "initialize");
406     rb_define_method (notmuch_rb_cTags, "destroy!", notmuch_rb_tags_destroy, 0); /* in tags.c */
407     rb_define_method (notmuch_rb_cTags, "each", notmuch_rb_tags_each, 0); /* in tags.c */
408     rb_include_module (notmuch_rb_cTags, rb_mEnumerable);
409 }