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