git.notmuchmail.org Git - notmuch/blob - bindings/ruby/init.c

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