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