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