Merge tag '0.31.4'
[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 /*
50  * Document-module: Notmuch
51  *
52  * == Summary
53  *
54  * Ruby extension to the <tt>notmuch</tt> mail library.
55  *
56  * == Classes
57  *
58  * Following are the classes that are most likely to be of interest to
59  * the user:
60  *
61  * - Notmuch::Database
62  * - Notmuch::FileNames
63  * - Notmuch::Query
64  * - Notmuch::Threads
65  * - Notmuch::Messages
66  * - Notmuch::Thread
67  * - Notmuch::Message
68  * - Notmuch::Tags
69  */
70
71 void
72 Init_notmuch (void)
73 {
74     VALUE mod;
75
76     ID_call = rb_intern ("call");
77     ID_db_create = rb_intern ("create");
78     ID_db_mode = rb_intern ("mode");
79
80     mod = rb_define_module ("Notmuch");
81
82     /*
83      * Document-const: Notmuch::MODE_READ_ONLY
84      *
85      * Open the database in read only mode
86      */
87     rb_define_const (mod, "MODE_READ_ONLY", INT2FIX (NOTMUCH_DATABASE_MODE_READ_ONLY));
88     /*
89      * Document-const: Notmuch::MODE_READ_WRITE
90      *
91      * Open the database in read write mode
92      */
93     rb_define_const (mod, "MODE_READ_WRITE", INT2FIX (NOTMUCH_DATABASE_MODE_READ_WRITE));
94     /*
95      * Document-const: Notmuch::SORT_OLDEST_FIRST
96      *
97      * Sort query results by oldest first
98      */
99     rb_define_const (mod, "SORT_OLDEST_FIRST", INT2FIX (NOTMUCH_SORT_OLDEST_FIRST));
100     /*
101      * Document-const: Notmuch::SORT_NEWEST_FIRST
102      *
103      * Sort query results by newest first
104      */
105     rb_define_const (mod, "SORT_NEWEST_FIRST", INT2FIX (NOTMUCH_SORT_NEWEST_FIRST));
106     /*
107      * Document-const: Notmuch::SORT_MESSAGE_ID
108      *
109      * Sort query results by message id
110      */
111     rb_define_const (mod, "SORT_MESSAGE_ID", INT2FIX (NOTMUCH_SORT_MESSAGE_ID));
112     /*
113      * Document-const: Notmuch::SORT_UNSORTED
114      *
115      * Do not sort query results
116      */
117     rb_define_const (mod, "SORT_UNSORTED", INT2FIX (NOTMUCH_SORT_UNSORTED));
118     /*
119      * Document-const: Notmuch::MESSAGE_FLAG_MATCH
120      *
121      * Message flag "match"
122      */
123     rb_define_const (mod, "MESSAGE_FLAG_MATCH", INT2FIX (NOTMUCH_MESSAGE_FLAG_MATCH));
124     /*
125      * Document-const: Notmuch::MESSAGE_FLAG_EXCLUDED
126      *
127      * Message flag "excluded"
128      */
129     rb_define_const (mod, "MESSAGE_FLAG_EXCLUDED", INT2FIX (NOTMUCH_MESSAGE_FLAG_EXCLUDED));
130     /*
131      * Document-const: Notmuch::TAG_MAX
132      *
133      * Maximum allowed length of a tag
134      */
135     rb_define_const (mod, "TAG_MAX", INT2FIX (NOTMUCH_TAG_MAX));
136
137     /*
138      * Document-class: Notmuch::BaseError
139      *
140      * Base class for all notmuch exceptions
141      */
142     notmuch_rb_eBaseError = rb_define_class_under (mod, "BaseError", rb_eStandardError);
143     /*
144      * Document-class: Notmuch::DatabaseError
145      *
146      * Raised when the database can't be created or opened.
147      */
148     notmuch_rb_eDatabaseError = rb_define_class_under (mod, "DatabaseError", notmuch_rb_eBaseError);
149     /*
150      * Document-class: Notmuch::MemoryError
151      *
152      * Raised when notmuch is out of memory
153      */
154     notmuch_rb_eMemoryError = rb_define_class_under (mod, "MemoryError", notmuch_rb_eBaseError);
155     /*
156      * Document-class: Notmuch::ReadOnlyError
157      *
158      * Raised when an attempt was made to write to a database opened in read-only
159      * mode.
160      */
161     notmuch_rb_eReadOnlyError = rb_define_class_under (mod, "ReadOnlyError", notmuch_rb_eBaseError);
162     /*
163      * Document-class: Notmuch::XapianError
164      *
165      * Raised when a Xapian exception occurs
166      */
167     notmuch_rb_eXapianError = rb_define_class_under (mod, "XapianError", notmuch_rb_eBaseError);
168     /*
169      * Document-class: Notmuch::FileError
170      *
171      * Raised when an error occurs trying to read or write to a file.
172      */
173     notmuch_rb_eFileError = rb_define_class_under (mod, "FileError", notmuch_rb_eBaseError);
174     /*
175      * Document-class: Notmuch::FileNotEmailError
176      *
177      * Raised when a file is presented that doesn't appear to be an email message.
178      */
179     notmuch_rb_eFileNotEmailError = rb_define_class_under (mod, "FileNotEmailError", notmuch_rb_eBaseError);
180     /*
181      * Document-class: Notmuch::NullPointerError
182      *
183      * Raised when the user erroneously passes a +NULL+ pointer to a notmuch
184      * function.
185      */
186     notmuch_rb_eNullPointerError = rb_define_class_under (mod, "NullPointerError", notmuch_rb_eBaseError);
187     /*
188      * Document-class: Notmuch::TagTooLongError
189      *
190      * Raised when a tag value is too long (exceeds Notmuch::TAG_MAX)
191      */
192     notmuch_rb_eTagTooLongError = rb_define_class_under (mod, "TagTooLongError", notmuch_rb_eBaseError);
193     /*
194      * Document-class: Notmuch::UnbalancedFreezeThawError
195      *
196      * Raised when the notmuch_message_thaw function has been called more times
197      * than notmuch_message_freeze.
198      */
199     notmuch_rb_eUnbalancedFreezeThawError = rb_define_class_under (mod, "UnbalancedFreezeThawError",
200                                                                    notmuch_rb_eBaseError);
201     /*
202      * Document-class: Notmuch::UnbalancedAtomicError
203      *
204      * Raised when notmuch_database_end_atomic has been called more times than
205      * notmuch_database_begin_atomic
206      */
207     notmuch_rb_eUnbalancedAtomicError = rb_define_class_under (mod, "UnbalancedAtomicError",
208                                                                notmuch_rb_eBaseError);
209     /*
210      * Document-class: Notmuch::Database
211      *
212      * Notmuch database interaction
213      */
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, "all_tags", notmuch_rb_database_get_all_tags, 0); /* in database.c */
233     rb_define_method (notmuch_rb_cDatabase, "query", notmuch_rb_database_query_create, 1); /* in database.c */
234
235     /*
236      * Document-class: Notmuch::Directory
237      *
238      * Notmuch directory
239      */
240     notmuch_rb_cDirectory = rb_define_class_under (mod, "Directory", rb_cData);
241     rb_undef_method (notmuch_rb_cDirectory, "initialize");
242     rb_define_method (notmuch_rb_cDirectory, "destroy!", notmuch_rb_directory_destroy, 0); /* in directory.c */
243     rb_define_method (notmuch_rb_cDirectory, "mtime", notmuch_rb_directory_get_mtime, 0); /* in directory.c */
244     rb_define_method (notmuch_rb_cDirectory, "mtime=", notmuch_rb_directory_set_mtime, 1); /* in directory.c */
245     rb_define_method (notmuch_rb_cDirectory, "child_files", notmuch_rb_directory_get_child_files, 0); /* in directory.c */
246     rb_define_method (notmuch_rb_cDirectory, "child_directories", notmuch_rb_directory_get_child_directories, 0); /* in directory.c */
247
248     /*
249      * Document-class: Notmuch::FileNames
250      *
251      * Notmuch file names
252      */
253     notmuch_rb_cFileNames = rb_define_class_under (mod, "FileNames", rb_cData);
254     rb_undef_method (notmuch_rb_cFileNames, "initialize");
255     rb_define_method (notmuch_rb_cFileNames, "destroy!", notmuch_rb_filenames_destroy, 0); /* in filenames.c */
256     rb_define_method (notmuch_rb_cFileNames, "each", notmuch_rb_filenames_each, 0); /* in filenames.c */
257     rb_include_module (notmuch_rb_cFileNames, rb_mEnumerable);
258
259     /*
260      * Document-class: Notmuch::Query
261      *
262      * Notmuch query
263      */
264     notmuch_rb_cQuery = rb_define_class_under (mod, "Query", rb_cData);
265     rb_undef_method (notmuch_rb_cQuery, "initialize");
266     rb_define_method (notmuch_rb_cQuery, "destroy!", notmuch_rb_query_destroy, 0); /* in query.c */
267     rb_define_method (notmuch_rb_cQuery, "sort", notmuch_rb_query_get_sort, 0); /* in query.c */
268     rb_define_method (notmuch_rb_cQuery, "sort=", notmuch_rb_query_set_sort, 1); /* in query.c */
269     rb_define_method (notmuch_rb_cQuery, "to_s", notmuch_rb_query_get_string, 0); /* in query.c */
270     rb_define_method (notmuch_rb_cQuery, "add_tag_exclude", notmuch_rb_query_add_tag_exclude, 1); /* in query.c */
271     rb_define_method (notmuch_rb_cQuery, "omit_excluded=", notmuch_rb_query_set_omit_excluded, 1); /* in query.c */
272     rb_define_method (notmuch_rb_cQuery, "search_threads", notmuch_rb_query_search_threads, 0); /* in query.c */
273     rb_define_method (notmuch_rb_cQuery, "search_messages", notmuch_rb_query_search_messages, 0); /* in query.c */
274     rb_define_method (notmuch_rb_cQuery, "count_messages", notmuch_rb_query_count_messages, 0); /* in query.c */
275     rb_define_method (notmuch_rb_cQuery, "count_threads", notmuch_rb_query_count_threads, 0); /* in query.c */
276
277     /*
278      * Document-class: Notmuch::Threads
279      *
280      * Notmuch threads
281      */
282     notmuch_rb_cThreads = rb_define_class_under (mod, "Threads", rb_cData);
283     rb_undef_method (notmuch_rb_cThreads, "initialize");
284     rb_define_method (notmuch_rb_cThreads, "destroy!", notmuch_rb_threads_destroy, 0); /* in threads.c */
285     rb_define_method (notmuch_rb_cThreads, "each", notmuch_rb_threads_each, 0); /* in threads.c */
286     rb_include_module (notmuch_rb_cThreads, rb_mEnumerable);
287
288     /*
289      * Document-class: Notmuch::Messages
290      *
291      * Notmuch messages
292      */
293     notmuch_rb_cMessages = rb_define_class_under (mod, "Messages", rb_cData);
294     rb_undef_method (notmuch_rb_cMessages, "initialize");
295     rb_define_method (notmuch_rb_cMessages, "destroy!", notmuch_rb_messages_destroy, 0); /* in messages.c */
296     rb_define_method (notmuch_rb_cMessages, "each", notmuch_rb_messages_each, 0); /* in messages.c */
297     rb_define_method (notmuch_rb_cMessages, "tags", notmuch_rb_messages_collect_tags, 0); /* in messages.c */
298     rb_include_module (notmuch_rb_cMessages, rb_mEnumerable);
299
300     /*
301      * Document-class: Notmuch::Thread
302      *
303      * Notmuch thread
304      */
305     notmuch_rb_cThread = rb_define_class_under (mod, "Thread", rb_cData);
306     rb_undef_method (notmuch_rb_cThread, "initialize");
307     rb_define_method (notmuch_rb_cThread, "destroy!", notmuch_rb_thread_destroy, 0); /* in thread.c */
308     rb_define_method (notmuch_rb_cThread, "thread_id", notmuch_rb_thread_get_thread_id, 0); /* in thread.c */
309     rb_define_method (notmuch_rb_cThread, "total_messages", notmuch_rb_thread_get_total_messages, 0); /* in thread.c */
310     rb_define_method (notmuch_rb_cThread, "toplevel_messages", notmuch_rb_thread_get_toplevel_messages, 0); /* in thread.c */
311     rb_define_method (notmuch_rb_cThread, "messages", notmuch_rb_thread_get_messages, 0); /* in thread.c */
312     rb_define_method (notmuch_rb_cThread, "matched_messages", notmuch_rb_thread_get_matched_messages, 0); /* in thread.c */
313     rb_define_method (notmuch_rb_cThread, "authors", notmuch_rb_thread_get_authors, 0); /* in thread.c */
314     rb_define_method (notmuch_rb_cThread, "subject", notmuch_rb_thread_get_subject, 0); /* in thread.c */
315     rb_define_method (notmuch_rb_cThread, "oldest_date", notmuch_rb_thread_get_oldest_date, 0); /* in thread.c */
316     rb_define_method (notmuch_rb_cThread, "newest_date", notmuch_rb_thread_get_newest_date, 0); /* in thread.c */
317     rb_define_method (notmuch_rb_cThread, "tags", notmuch_rb_thread_get_tags, 0); /* in thread.c */
318
319     /*
320      * Document-class: Notmuch::Message
321      *
322      * Notmuch message
323      */
324     notmuch_rb_cMessage = rb_define_class_under (mod, "Message", rb_cData);
325     rb_undef_method (notmuch_rb_cMessage, "initialize");
326     rb_define_method (notmuch_rb_cMessage, "destroy!", notmuch_rb_message_destroy, 0); /* in message.c */
327     rb_define_method (notmuch_rb_cMessage, "message_id", notmuch_rb_message_get_message_id, 0); /* in message.c */
328     rb_define_method (notmuch_rb_cMessage, "thread_id", notmuch_rb_message_get_thread_id, 0); /* in message.c */
329     rb_define_method (notmuch_rb_cMessage, "replies", notmuch_rb_message_get_replies, 0); /* in message.c */
330     rb_define_method (notmuch_rb_cMessage, "filename", notmuch_rb_message_get_filename, 0); /* in message.c */
331     rb_define_method (notmuch_rb_cMessage, "filenames", notmuch_rb_message_get_filenames, 0); /* in message.c */
332     rb_define_method (notmuch_rb_cMessage, "get_flag", notmuch_rb_message_get_flag, 1); /* in message.c */
333     rb_define_method (notmuch_rb_cMessage, "set_flag", notmuch_rb_message_set_flag, 2); /* in message.c */
334     rb_define_method (notmuch_rb_cMessage, "date", notmuch_rb_message_get_date, 0); /* in message.c */
335     rb_define_method (notmuch_rb_cMessage, "header", notmuch_rb_message_get_header, 1); /* in message.c */
336     rb_define_alias (notmuch_rb_cMessage, "[]", "header");
337     rb_define_method (notmuch_rb_cMessage, "tags", notmuch_rb_message_get_tags, 0); /* in message.c */
338     rb_define_method (notmuch_rb_cMessage, "add_tag", notmuch_rb_message_add_tag, 1); /* in message.c */
339     rb_define_alias (notmuch_rb_cMessage, "<<", "add_tag");
340     rb_define_method (notmuch_rb_cMessage, "remove_tag", notmuch_rb_message_remove_tag, 1); /* in message.c */
341     rb_define_method (notmuch_rb_cMessage, "remove_all_tags", notmuch_rb_message_remove_all_tags, 0); /* in message.c */
342     rb_define_method (notmuch_rb_cMessage, "maildir_flags_to_tags", notmuch_rb_message_maildir_flags_to_tags, 0); /* in message.c */
343     rb_define_method (notmuch_rb_cMessage, "tags_to_maildir_flags", notmuch_rb_message_tags_to_maildir_flags, 0); /* in message.c */
344     rb_define_method (notmuch_rb_cMessage, "freeze", notmuch_rb_message_freeze, 0); /* in message.c */
345     rb_define_method (notmuch_rb_cMessage, "thaw", notmuch_rb_message_thaw, 0); /* in message.c */
346
347     /*
348      * Document-class: Notmuch::Tags
349      *
350      * Notmuch tags
351      */
352     notmuch_rb_cTags = rb_define_class_under (mod, "Tags", rb_cData);
353     rb_undef_method (notmuch_rb_cTags, "initialize");
354     rb_define_method (notmuch_rb_cTags, "destroy!", notmuch_rb_tags_destroy, 0); /* in tags.c */
355     rb_define_method (notmuch_rb_cTags, "each", notmuch_rb_tags_each, 0); /* in tags.c */
356     rb_include_module (notmuch_rb_cTags, rb_mEnumerable);
357 }