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