notmuch/bindings/ruby/defs.h

/* The Ruby interface to the notmuch mail library
 *
 * Copyright © 2010 Ali Polatel
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see http://www.gnu.org/licenses/ .
 *
 * Author: Ali Polatel <alip@exherbo.org>
 */

#ifndef DEFS_H
#define DEFS_H

#include <notmuch.h>
#include <ruby.h>

VALUE notmuch_rb_cDatabase;
VALUE notmuch_rb_cDirectory;
VALUE notmuch_rb_cFileNames;
VALUE notmuch_rb_cQuery;
VALUE notmuch_rb_cThreads;
VALUE notmuch_rb_cThread;
VALUE notmuch_rb_cMessages;
VALUE notmuch_rb_cMessage;
VALUE notmuch_rb_cTags;

VALUE notmuch_rb_eBaseError;
VALUE notmuch_rb_eDatabaseError;
VALUE notmuch_rb_eMemoryError;
VALUE notmuch_rb_eReadOnlyError;
VALUE notmuch_rb_eXapianError;
VALUE notmuch_rb_eFileError;
VALUE notmuch_rb_eFileNotEmailError;
VALUE notmuch_rb_eNullPointerError;
VALUE notmuch_rb_eTagTooLongError;
VALUE notmuch_rb_eUnbalancedFreezeThawError;
VALUE notmuch_rb_eUnbalancedAtomicError;

ID ID_call;
ID ID_db_create;
ID ID_db_mode;

#define Data_Get_Notmuch_Database(obj, ptr)                \
    do {                                                   \
        Check_Type(obj, T_DATA);                           \
        if (DATA_PTR(obj) == NULL)                         \
            rb_raise(rb_eRuntimeError, "database closed"); \
        Data_Get_Struct(obj, notmuch_database_t, ptr);     \
    } while(0)

#define Data_Get_Notmuch_Directory(obj, ptr)                   \
    do {                                                       \
        Check_Type(obj, T_DATA);                               \
        if (DATA_PTR(obj) == NULL)                             \
            rb_raise(rb_eRuntimeError, "directory destroyed"); \
        Data_Get_Struct(obj, notmuch_directory_t, ptr);        \
    } while(0)

#define Data_Get_Notmuch_FileNames(obj, ptr)                   \
    do {                                                       \
        Check_Type(obj, T_DATA);                               \
        if (DATA_PTR(obj) == NULL)                             \
            rb_raise(rb_eRuntimeError, "filenames destroyed"); \
        Data_Get_Struct(obj, notmuch_filenames_t, ptr);        \
    } while(0)

#define Data_Get_Notmuch_Query(obj, ptr)                   \
    do {                                                   \
        Check_Type(obj, T_DATA);                           \
        if (DATA_PTR(obj) == NULL)                         \
            rb_raise(rb_eRuntimeError, "query destroyed"); \
        Data_Get_Struct(obj, notmuch_query_t, ptr);        \
    } while(0)

#define Data_Get_Notmuch_Threads(obj, ptr)                   \
    do {                                                     \
        Check_Type(obj, T_DATA);                             \
        if (DATA_PTR(obj) == NULL)                           \
            rb_raise(rb_eRuntimeError, "threads destroyed"); \
        Data_Get_Struct(obj, notmuch_threads_t, ptr);        \
    } while(0)

#define Data_Get_Notmuch_Messages(obj, ptr)                   \
    do {                                                      \
        Check_Type(obj, T_DATA);                              \
        if (DATA_PTR(obj) == NULL)                            \
            rb_raise(rb_eRuntimeError, "messages destroyed"); \
        Data_Get_Struct(obj, notmuch_messages_t, ptr);        \
    } while(0)

#define Data_Get_Notmuch_Thread(obj, ptr)                   \
    do {                                                    \
        Check_Type(obj, T_DATA);                            \
        if (DATA_PTR(obj) == NULL)                          \
            rb_raise(rb_eRuntimeError, "thread destroyed"); \
        Data_Get_Struct(obj, notmuch_thread_t, ptr);        \
    } while(0)

#define Data_Get_Notmuch_Message(obj, ptr)                   \
    do {                                                     \
        Check_Type(obj, T_DATA);                             \
        if (DATA_PTR(obj) == NULL)                           \
            rb_raise(rb_eRuntimeError, "message destroyed"); \
        Data_Get_Struct(obj, notmuch_message_t, ptr);        \
    } while(0)

#define Data_Get_Notmuch_Tags(obj, ptr)                   \
    do {                                                  \
        Check_Type(obj, T_DATA);                          \
        if (DATA_PTR(obj) == NULL)                        \
            rb_raise(rb_eRuntimeError, "tags destroyed"); \
        Data_Get_Struct(obj, notmuch_tags_t, ptr);        \
    } while(0)

/* status.c */
void
notmuch_rb_status_raise(notmuch_status_t status);

/* database.c */
VALUE
notmuch_rb_database_alloc(VALUE klass);

VALUE
notmuch_rb_database_initialize(int argc, VALUE *argv, VALUE klass);

VALUE
notmuch_rb_database_open(int argc, VALUE *argv, VALUE klass);

VALUE
notmuch_rb_database_close(VALUE self);

VALUE
notmuch_rb_database_path(VALUE self);

VALUE
notmuch_rb_database_version(VALUE self);

VALUE
notmuch_rb_database_needs_upgrade(VALUE self);

VALUE
notmuch_rb_database_upgrade(VALUE self);

VALUE
notmuch_rb_database_begin_atomic(VALUE self);

VALUE
notmuch_rb_database_end_atomic(VALUE self);

VALUE
notmuch_rb_database_get_directory(VALUE self, VALUE pathv);

VALUE
notmuch_rb_database_add_message(VALUE self, VALUE pathv);

VALUE
notmuch_rb_database_remove_message(VALUE self, VALUE pathv);

VALUE
notmuch_rb_database_query_create(VALUE self, VALUE qstrv);

/* directory.c */
VALUE
notmuch_rb_directory_destroy(VALUE self);

VALUE
notmuch_rb_directory_get_mtime(VALUE self);

VALUE
notmuch_rb_directory_set_mtime(VALUE self, VALUE mtimev);

VALUE
notmuch_rb_directory_get_child_files(VALUE self);

VALUE
notmuch_rb_directory_get_child_directories(VALUE self);

/* filenames.c */
VALUE
notmuch_rb_filenames_destroy(VALUE self);

VALUE
notmuch_rb_filenames_each(VALUE self);

/* query.c */
VALUE
notmuch_rb_query_destroy(VALUE self);

VALUE
notmuch_rb_query_get_sort(VALUE self);

VALUE
notmuch_rb_query_set_sort(VALUE self, VALUE sortv);

VALUE
notmuch_rb_query_get_string(VALUE self);

VALUE
notmuch_rb_query_search_threads(VALUE self);

VALUE
notmuch_rb_query_search_messages(VALUE self);

/* threads.c */
VALUE
notmuch_rb_threads_destroy(VALUE self);

VALUE
notmuch_rb_threads_each(VALUE self);

/* messages.c */
VALUE
notmuch_rb_messages_destroy(VALUE self);

VALUE
notmuch_rb_messages_each(VALUE self);

VALUE
notmuch_rb_messages_collect_tags(VALUE self);

/* thread.c */
VALUE
notmuch_rb_thread_destroy(VALUE self);

VALUE
notmuch_rb_thread_get_thread_id(VALUE self);

VALUE
notmuch_rb_thread_get_total_messages(VALUE self);

VALUE
notmuch_rb_thread_get_toplevel_messages(VALUE self);

VALUE
notmuch_rb_thread_get_matched_messages(VALUE self);

VALUE
notmuch_rb_thread_get_authors(VALUE self);

VALUE
notmuch_rb_thread_get_subject(VALUE self);

VALUE
notmuch_rb_thread_get_oldest_date(VALUE self);

VALUE
notmuch_rb_thread_get_newest_date(VALUE self);

VALUE
notmuch_rb_thread_get_tags(VALUE self);

/* message.c */
VALUE
notmuch_rb_message_destroy(VALUE self);

VALUE
notmuch_rb_message_get_message_id(VALUE self);

VALUE
notmuch_rb_message_get_thread_id(VALUE self);

VALUE
notmuch_rb_message_get_replies(VALUE self);

VALUE
notmuch_rb_message_get_filename(VALUE self);

VALUE
notmuch_rb_message_get_filenames(VALUE self);

VALUE
notmuch_rb_message_get_flag(VALUE self, VALUE flagv);

VALUE
notmuch_rb_message_set_flag(VALUE self, VALUE flagv, VALUE valuev);

VALUE
notmuch_rb_message_get_date(VALUE self);

VALUE
notmuch_rb_message_get_header(VALUE self, VALUE headerv);

VALUE
notmuch_rb_message_get_tags(VALUE self);

VALUE
notmuch_rb_message_add_tag(VALUE self, VALUE tagv);

VALUE
notmuch_rb_message_remove_tag(VALUE self, VALUE tagv);

VALUE
notmuch_rb_message_remove_all_tags(VALUE self);

VALUE
notmuch_rb_message_maildir_flags_to_tags(VALUE self);

VALUE
notmuch_rb_message_tags_to_maildir_flags(VALUE self);

VALUE
notmuch_rb_message_freeze(VALUE self);

VALUE
notmuch_rb_message_thaw(VALUE self);

/* tags.c */
VALUE
notmuch_rb_tags_destroy(VALUE self);

VALUE
notmuch_rb_tags_each(VALUE self);

/* init.c */
void
Init_notmuch(void);

#endif