Initial ruby bindings
[notmuch] / bindings / ruby / init.c
1 /* The Ruby interface to the notmuch mail library
2  *
3  * Copyright © 2010 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 http://www.gnu.org/licenses/ .
17  *
18  * Author: Ali Polatel <alip@exherbo.org>
19  */
20
21 #include "defs.h"
22
23 /*
24  * Document-module: Notmuch
25  *
26  * == Summary
27  *
28  * Ruby extension to the <tt>notmuch</tt> mail library.
29  *
30  * == Constants
31  *
32  * - Notmuch::MODE_READ_ONLY
33  *
34  *   Open the database in read only mode.
35  *
36  * - Notmuch::MODE_READ_WRITE
37  *
38  *   Open the database in read write mode.
39  *
40  * - Notmuch::TAG_MAX
41  *
42  *   Maximum allowed length of a tag
43  */
44
45 /*
46  * Document-class: Notmuch::Database
47  *
48  * Notmuch database interaction
49  */
50
51 /*
52  * Document-class: Notmuch::Directory
53  *
54  * Notmuch directory
55  */
56
57 /*
58  * Document-class: Notmuch::FileNames
59  *
60  * Notmuch file names
61  */
62
63 /*
64  * Document-class: Notmuch::Query
65  *
66  * Notmuch query
67  */
68
69 /*
70  * Document-class: Notmuch::Threads
71  *
72  * Notmuch threads
73  */
74
75 /*
76  * Document-class: Notmuch::Messages
77  *
78  * Notmuch messages
79  */
80
81 /*
82  * Document-class: Notmuch::Thread
83  *
84  * Notmuch thread
85  */
86
87 /*
88  * Document-class: Notmuch::Message
89  *
90  * Notmuch message
91  */
92
93 /*
94  * Document-class: Notmuch::Tags
95  *
96  * Notmuch tags
97  */
98
99 /*
100  * Document-class: Notmuch::BaseError
101  *
102  * Base class for all notmuch exceptions
103  */
104
105 /*
106  * Document-class: Notmuch::DatabaseError
107  *
108  * Raised when the database can't be created or opened.
109  */
110
111 /*
112  * Document-class: Notmuch::MemoryError
113  *
114  * Raised when notmuch is out of memory
115  */
116
117 /*
118  * Document-class: Notmuch::ReadOnlyError
119  *
120  * Raised when an attempt was made to write to a database opened in read-only
121  * mode.
122  */
123
124 /*
125  * Document-class: Notmuch::XapianError
126  *
127  * Raised when a Xapian exception occurs
128  */
129
130 /*
131  * Document-class: Notmuch::FileError
132  *
133  * Raised when an error occurs trying to read or write to a file.
134  */
135
136 /*
137  * Document-class: Notmuch::FileNotEmailError
138  *
139  * Raised when a file is presented that doesn't appear to be an email message.
140  */
141
142 /*
143  * Document-class: Notmuch::NullPointerError
144  *
145  * Raised when the user erroneously passes a +NULL+ pointer to a notmuch
146  * function.
147  */
148
149 /*
150  * Document-class: Notmuch::TagTooLongError
151  *
152  * Raised when a tag value is too long (exceeds Notmuch::TAG_MAX)
153  */
154
155 /*
156  * Document-class: Notmuch::UnbalancedFreezeThawError
157  *
158  * Raised when the notmuch_message_thaw function has been called more times
159  * than notmuch_message_freeze.
160  */
161
162 #define RDOC_HATE 1
163
164 void
165 Init_notmuch(void)
166 {
167     VALUE mod;
168
169     ID_call = rb_intern("call");
170     ID_db_create = rb_intern("create");
171     ID_db_mode = rb_intern("mode");
172
173     mod = rb_define_module("Notmuch");
174
175     rb_define_const(mod, "MODE_READ_ONLY", INT2FIX(NOTMUCH_DATABASE_MODE_READ_ONLY));
176     rb_define_const(mod, "MODE_READ_WRITE", INT2FIX(NOTMUCH_DATABASE_MODE_READ_WRITE));
177     rb_define_const(mod, "SORT_OLDEST_FIRST", INT2FIX(NOTMUCH_SORT_OLDEST_FIRST));
178     rb_define_const(mod, "SORT_NEWEST_FIRST", INT2FIX(NOTMUCH_SORT_NEWEST_FIRST));
179     rb_define_const(mod, "SORT_MESSAGE_ID", INT2FIX(NOTMUCH_SORT_MESSAGE_ID));
180     rb_define_const(mod, "SORT_UNSORTED", INT2FIX(NOTMUCH_SORT_UNSORTED));
181     rb_define_const(mod, "MESSAGE_FLAG_MATCH", INT2FIX(NOTMUCH_MESSAGE_FLAG_MATCH));
182     rb_define_const(mod, "TAG_MAX", INT2FIX(NOTMUCH_TAG_MAX));
183
184     notmuch_rb_eBaseError = rb_define_class_under(mod, "BaseError", rb_eStandardError);
185     notmuch_rb_eDatabaseError = rb_define_class_under(mod, "DatabaseError", notmuch_rb_eBaseError);
186     notmuch_rb_eMemoryError = rb_define_class_under(mod, "MemoryError", notmuch_rb_eBaseError);
187     notmuch_rb_eReadOnlyError = rb_define_class_under(mod, "ReadOnlyError", notmuch_rb_eBaseError);
188     notmuch_rb_eXapianError = rb_define_class_under(mod, "XapianError", notmuch_rb_eBaseError);
189     notmuch_rb_eFileError = rb_define_class_under(mod, "FileError", notmuch_rb_eBaseError);
190     notmuch_rb_eFileNotEmailError = rb_define_class_under(mod, "FileNotEmailError", notmuch_rb_eBaseError);
191     notmuch_rb_eNullPointerError = rb_define_class_under(mod, "NullPointerError", notmuch_rb_eBaseError);
192     notmuch_rb_eTagTooLongError = rb_define_class_under(mod, "TagTooLongError", notmuch_rb_eBaseError);
193     notmuch_rb_eUnbalancedFreezeThawError = rb_define_class_under(mod, "UnbalancedFreezeThawError",
194             notmuch_rb_eBaseError);
195
196     notmuch_rb_cDatabase = rb_define_class_under(mod, "Database", rb_cObject);
197     rb_define_singleton_method(notmuch_rb_cDatabase, "new", notmuch_rb_database_new, -1);
198     rb_define_method(notmuch_rb_cDatabase, "close", notmuch_rb_database_close, 0);
199     rb_define_method(notmuch_rb_cDatabase, "path", notmuch_rb_database_path, 0);
200     rb_define_method(notmuch_rb_cDatabase, "version", notmuch_rb_database_version, 0);
201     rb_define_method(notmuch_rb_cDatabase, "needs_upgrade?", notmuch_rb_database_needs_upgrade, 0);
202     rb_define_method(notmuch_rb_cDatabase, "upgrade!", notmuch_rb_database_upgrade, 0);
203     rb_define_method(notmuch_rb_cDatabase, "get_directory", notmuch_rb_database_get_directory, 1);
204     rb_define_method(notmuch_rb_cDatabase, "add_message", notmuch_rb_database_add_message, 1);
205     rb_define_method(notmuch_rb_cDatabase, "remove_message", notmuch_rb_database_remove_message, 1);
206     rb_define_method(notmuch_rb_cDatabase, "query", notmuch_rb_database_query_create, 1);
207
208     notmuch_rb_cDirectory = rb_define_class_under(mod, "Directory", rb_cObject);
209     rb_undef_method(notmuch_rb_cDirectory, "initialize");
210     rb_define_method(notmuch_rb_cDirectory, "mtime", notmuch_rb_directory_get_mtime, 0);
211     rb_define_method(notmuch_rb_cDirectory, "mtime=", notmuch_rb_directory_set_mtime, 1);
212     rb_define_method(notmuch_rb_cDirectory, "child_files", notmuch_rb_directory_get_child_files, 0);
213     rb_define_method(notmuch_rb_cDirectory, "child_directories", notmuch_rb_directory_get_child_directories, 0);
214
215     notmuch_rb_cFileNames = rb_define_class_under(mod, "FileNames", rb_cObject);
216     rb_undef_method(notmuch_rb_cFileNames, "initialize");
217     rb_define_method(notmuch_rb_cFileNames, "each", notmuch_rb_filenames_each, 0);
218     rb_include_module(notmuch_rb_cFileNames, rb_mEnumerable);
219
220     notmuch_rb_cQuery = rb_define_class_under(mod, "Query", rb_cObject);
221     rb_undef_method(notmuch_rb_cQuery, "initialize");
222     rb_define_method(notmuch_rb_cQuery, "sort=", notmuch_rb_query_set_sort, 1);
223     rb_define_method(notmuch_rb_cQuery, "search_threads", notmuch_rb_query_search_threads, 0);
224     rb_define_method(notmuch_rb_cQuery, "search_messages", notmuch_rb_query_search_messages, 0);
225
226     notmuch_rb_cThreads = rb_define_class_under(mod, "Threads", rb_cObject);
227     rb_undef_method(notmuch_rb_cThreads, "initialize");
228     rb_define_method(notmuch_rb_cThreads, "each", notmuch_rb_threads_each, 0);
229     rb_include_module(notmuch_rb_cThreads, rb_mEnumerable);
230
231     notmuch_rb_cMessages = rb_define_class_under(mod, "Messages", rb_cObject);
232     rb_undef_method(notmuch_rb_cMessages, "initialize");
233     rb_define_method(notmuch_rb_cMessages, "each", notmuch_rb_messages_each, 0);
234     rb_define_method(notmuch_rb_cMessages, "tags", notmuch_rb_messages_collect_tags, 0);
235     rb_include_module(notmuch_rb_cMessages, rb_mEnumerable);
236
237     notmuch_rb_cThread = rb_define_class_under(mod, "Thread", rb_cObject);
238     rb_undef_method(notmuch_rb_cThread, "initialize");
239     rb_define_method(notmuch_rb_cThread, "thread_id", notmuch_rb_thread_get_thread_id, 0);
240     rb_define_method(notmuch_rb_cThread, "total_messages", notmuch_rb_thread_get_total_messages, 0);
241     rb_define_method(notmuch_rb_cThread, "toplevel_messages", notmuch_rb_thread_get_toplevel_messages, 0);
242     rb_define_method(notmuch_rb_cThread, "matched_messages", notmuch_rb_thread_get_matched_messages, 0);
243     rb_define_method(notmuch_rb_cThread, "authors", notmuch_rb_thread_get_authors, 0);
244     rb_define_method(notmuch_rb_cThread, "subject", notmuch_rb_thread_get_subject, 0);
245     rb_define_method(notmuch_rb_cThread, "oldest_date", notmuch_rb_thread_get_oldest_date, 0);
246     rb_define_method(notmuch_rb_cThread, "newest_date", notmuch_rb_thread_get_newest_date, 0);
247     rb_define_method(notmuch_rb_cThread, "tags", notmuch_rb_thread_get_tags, 0);
248
249     notmuch_rb_cMessage = rb_define_class_under(mod, "Message", rb_cObject);
250     rb_undef_method(notmuch_rb_cMessage, "initialize");
251     rb_define_method(notmuch_rb_cMessage, "message_id", notmuch_rb_message_get_message_id, 0);
252     rb_define_method(notmuch_rb_cMessage, "thread_id", notmuch_rb_message_get_thread_id, 0);
253     rb_define_method(notmuch_rb_cMessage, "replies", notmuch_rb_message_get_replies, 0);
254     rb_define_method(notmuch_rb_cMessage, "filename", notmuch_rb_message_get_filename, 0);
255     rb_define_method(notmuch_rb_cMessage, "get_flag", notmuch_rb_message_get_flag, 1);
256     rb_define_method(notmuch_rb_cMessage, "set_flag", notmuch_rb_message_set_flag, 2);
257     rb_define_method(notmuch_rb_cMessage, "date", notmuch_rb_message_get_date, 0);
258     rb_define_method(notmuch_rb_cMessage, "header", notmuch_rb_message_get_header, 1);
259     rb_define_alias(notmuch_rb_cMessage, "[]", "header");
260     rb_define_method(notmuch_rb_cMessage, "tags", notmuch_rb_message_get_tags, 0);
261     rb_define_method(notmuch_rb_cMessage, "add_tag", notmuch_rb_message_add_tag, 1);
262     rb_define_alias(notmuch_rb_cMessage, "<<", "add_tag");
263     rb_define_method(notmuch_rb_cMessage, "remove_tag", notmuch_rb_message_remove_tag, 1);
264     rb_define_method(notmuch_rb_cMessage, "remove_all_tags", notmuch_rb_message_remove_all_tags, 0);
265     rb_define_method(notmuch_rb_cMessage, "freeze", notmuch_rb_message_freeze, 0);
266     rb_define_method(notmuch_rb_cMessage, "thaw", notmuch_rb_message_thaw, 0);
267
268     notmuch_rb_cTags = rb_define_class_under(mod, "Tags", rb_cObject);
269     rb_undef_method(notmuch_rb_cTags, "initialize");
270     rb_define_method(notmuch_rb_cTags, "each", notmuch_rb_tags_each, 0);
271     rb_include_module(notmuch_rb_cTags, rb_mEnumerable);
272 }