debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-12-23 01:44:52 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge in ruby bindings.

Browse source 
Thanks to Ali Polatel for these bindings. This code was fetched from
the ruby branch of:

	git://github.com/alip/notmuch.git
This commit is contained in:
Carl Worth 2010-11-08 10:08:27 -08:00
commit 44ea57a0d1
14 changed files with 1971 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

321
bindings/ruby/database.c Normal file
View file

@ -0,0 +1,321 @@
/* 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>
*/
#include "defs.h"
VALUE
notmuch_rb_database_alloc(VALUE klass)
{
return Data_Wrap_Struct(klass, NULL, NULL, NULL);
}
/*
* call-seq: Notmuch::Database.new(path [, {:create => false, :mode => Notmuch::MODE_READ_ONLY}]) => DB
*
* Create or open a notmuch database using the given path.
*
* If :create is +true+, create the database instead of opening.
*
* The argument :mode specifies the open mode of the database.
*/
VALUE
notmuch_rb_database_initialize(int argc, VALUE *argv, VALUE self)
{
const char *path;
int create, mode;
VALUE pathv, hashv;
VALUE modev;
#if !defined(RSTRING_PTR)
#define RSTRING_PTR(v) (RSTRING((v))->ptr)
#endif /* !defined(RSTRING_PTR) */
/* Check arguments */
rb_scan_args(argc, argv, "11", &pathv, &hashv);
SafeStringValue(pathv);
path = RSTRING_PTR(pathv);
if (!NIL_P(hashv)) {
Check_Type(hashv, T_HASH);
create = RTEST(rb_hash_aref(hashv, ID2SYM(ID_db_create)));
modev = rb_hash_aref(hashv, ID2SYM(ID_db_mode));
if (NIL_P(modev))
mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
else if (!FIXNUM_P(modev))
rb_raise(rb_eTypeError, ":mode isn't a Fixnum");
else {
mode = FIX2INT(modev);
switch (mode) {
case NOTMUCH_DATABASE_MODE_READ_ONLY:
case NOTMUCH_DATABASE_MODE_READ_WRITE:
break;
default:
rb_raise(rb_eTypeError, "Invalid mode");
}
}
}
else {
create = 0;
mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
}
Check_Type(self, T_DATA);
DATA_PTR(self) = create ? notmuch_database_create(path) : notmuch_database_open(path, mode);
if (!DATA_PTR(self))
rb_raise(notmuch_rb_eDatabaseError, "Failed to open database");
return self;
}
/*
* call-seq: Notmuch::Database.open(path [, ahash]) {|db| ...}
*
* Identical to new, except that when it is called with a block, it yields with
* the new instance and closes it, and returns the result which is returned from
* the block.
*/
VALUE
notmuch_rb_database_open(int argc, VALUE *argv, VALUE klass)
{
VALUE obj;
obj = rb_class_new_instance(argc, argv, klass);
if (!rb_block_given_p())
return obj;
return rb_ensure(rb_yield, obj, notmuch_rb_database_close, obj);
}
/*
* call-seq: DB.close => nil
*
* Close the notmuch database.
*/
VALUE
notmuch_rb_database_close(VALUE self)
{
notmuch_database_t *db;
Data_Get_Notmuch_Database(self, db);
notmuch_database_close(db);
DATA_PTR(self) = NULL;
return Qnil;
}
/*
* call-seq: DB.path => String
*
* Return the path of the database
*/
VALUE
notmuch_rb_database_path(VALUE self)
{
notmuch_database_t *db;
Data_Get_Notmuch_Database(self, db);
return rb_str_new2(notmuch_database_get_path(db));
}
/*
* call-seq: DB.version => Fixnum
*
* Return the version of the database
*/
VALUE
notmuch_rb_database_version(VALUE self)
{
notmuch_database_t *db;
Data_Get_Notmuch_Database(self, db);
return INT2FIX(notmuch_database_get_version(db));
}
/*
* call-seq: DB.needs_upgrade? => true or false
*
* Return the +true+ if the database needs upgrading, +false+ otherwise
*/
VALUE
notmuch_rb_database_needs_upgrade(VALUE self)
{
notmuch_database_t *db;
Data_Get_Notmuch_Database(self, db);
return notmuch_database_needs_upgrade(db) ? Qtrue : Qfalse;
}
static void
notmuch_rb_upgrade_notify(void *closure, double progress)
{
VALUE *block = (VALUE *)closure;
rb_funcall(*block, ID_call, 1, rb_float_new(progress));
}
/*
* call-seq: DB.upgrade! [{|progress| block }] => nil
*
* Upgrade the database.
*
* If a block is given the block is called with a progress indicator as a
* floating point value in the range of [0.0..1.0].
*/
VALUE
notmuch_rb_database_upgrade(VALUE self)
{
notmuch_status_t ret;
void (*pnotify) (void *closure, double progress);
notmuch_database_t *db;
VALUE block;
Data_Get_Notmuch_Database(self, db);
if (rb_block_given_p()) {
pnotify = notmuch_rb_upgrade_notify;
block = rb_block_proc();
}
else
pnotify = NULL;
ret = notmuch_database_upgrade(db, pnotify, pnotify ? &block : NULL);
notmuch_rb_status_raise(ret);
return Qtrue;
}
/*
* call-seq: DB.get_directory(path) => DIR
*
* Retrieve a directory object from the database for 'path'
*/
VALUE
notmuch_rb_database_get_directory(VALUE self, VALUE pathv)
{
const char *path;
notmuch_directory_t *dir;
notmuch_database_t *db;
Data_Get_Notmuch_Database(self, db);
#if !defined(RSTRING_PTR)
#define RSTRING_PTR(v) (RSTRING((v))->ptr)
#endif /* !defined(RSTRING_PTR) */
SafeStringValue(pathv);
path = RSTRING_PTR(pathv);
dir = notmuch_database_get_directory(db, path);
if (!dir)
rb_raise(notmuch_rb_eXapianError, "Xapian exception");
return Data_Wrap_Struct(notmuch_rb_cDirectory, NULL, NULL, dir);
}
/*
* call-seq: DB.add_message(path) => MESSAGE, isdup
*
* Add a message to the database and return it.
*
* +isdup+ is a boolean that specifies whether the added message was a
* duplicate.
*/
VALUE
notmuch_rb_database_add_message(VALUE self, VALUE pathv)
{
const char *path;
notmuch_status_t ret;
notmuch_message_t *message;
notmuch_database_t *db;
Data_Get_Notmuch_Database(self, db);
#if !defined(RSTRING_PTR)
#define RSTRING_PTR(v) (RSTRING((v))->ptr)
#endif /* !defined(RSTRING_PTR) */
SafeStringValue(pathv);
path = RSTRING_PTR(pathv);
ret = notmuch_database_add_message(db, path, &message);
notmuch_rb_status_raise(ret);
return rb_assoc_new(Data_Wrap_Struct(notmuch_rb_cMessage, NULL, NULL, message),
(ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) ? Qtrue : Qfalse);
}
/*
* call-seq: DB.remove_message(path) => isdup
*
* Remove a message from the database.
*
* +isdup+ is a boolean that specifies whether the removed message was a
* duplicate.
*/
VALUE
notmuch_rb_database_remove_message(VALUE self, VALUE pathv)
{
const char *path;
notmuch_status_t ret;
notmuch_database_t *db;
Data_Get_Notmuch_Database(self, db);
#if !defined(RSTRING_PTR)
#define RSTRING_PTR(v) (RSTRING((v))->ptr)
#endif /* !defined(RSTRING_PTR) */
SafeStringValue(pathv);
path = RSTRING_PTR(pathv);
ret = notmuch_database_remove_message(db, path);
notmuch_rb_status_raise(ret);
return (ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) ? Qtrue : Qfalse;
}
/*
* call-seq: DB.query(query) => QUERY
*
* Retrieve a query object for the query string 'query'
*/
VALUE
notmuch_rb_database_query_create(VALUE self, VALUE qstrv)
{
const char *qstr;
notmuch_query_t *query;
notmuch_database_t *db;
Data_Get_Notmuch_Database(self, db);
#if !defined(RSTRING_PTR)
#define RSTRING_PTR(v) (RSTRING((v))->ptr)
#endif /* !defined(RSTRING_PTR) */
SafeStringValue(qstrv);
qstr = RSTRING_PTR(qstrv);
query = notmuch_query_create(db, qstr);
if (!query)
rb_raise(notmuch_rb_eMemoryError, "Out of memory");
return Data_Wrap_Struct(notmuch_rb_cQuery, NULL, NULL, query);
}

306
bindings/ruby/defs.h Normal file
View file

@ -0,0 +1,306 @@
/* 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;
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_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_set_sort(VALUE self, VALUE sortv);
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_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_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

115
bindings/ruby/directory.c Normal file
View file

@ -0,0 +1,115 @@
/* 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>
*/
#include "defs.h"
/*
* call-seq: DIR.destroy => nil
*
* Destroys the directory, freeing all resources allocated for it.
*/
VALUE
notmuch_rb_directory_destroy(VALUE self)
{
notmuch_directory_t *dir;
Data_Get_Struct(self, notmuch_directory_t, dir);
notmuch_directory_destroy(dir);
DATA_PTR(self) = NULL;
return Qnil;
}
/*
* call-seq: DIR.mtime => fixnum
*
* Returns the mtime of the directory or +0+ if no mtime has been previously
* stored.
*/
VALUE
notmuch_rb_directory_get_mtime(VALUE self)
{
notmuch_directory_t *dir;
Data_Get_Notmuch_Directory(self, dir);
return UINT2NUM(notmuch_directory_get_mtime(dir));
}
/*
* call-seq: DIR.mtime=(fixnum) => nil
*
* Store an mtime within the database for the directory object.
*/
VALUE
notmuch_rb_directory_set_mtime(VALUE self, VALUE mtimev)
{
notmuch_status_t ret;
notmuch_directory_t *dir;
Data_Get_Notmuch_Directory(self, dir);
if (!FIXNUM_P(mtimev))
rb_raise(rb_eTypeError, "First argument not a fixnum");
ret = notmuch_directory_set_mtime(dir, FIX2UINT(mtimev));
notmuch_rb_status_raise(ret);
return Qtrue;
}
/*
* call-seq: DIR.child_files => FILENAMES
*
* Return a Notmuch::FileNames object, which is an +Enumerable+ listing all the
* filenames of messages in the database within the given directory.
*/
VALUE
notmuch_rb_directory_get_child_files(VALUE self)
{
notmuch_directory_t *dir;
notmuch_filenames_t *fnames;
Data_Get_Notmuch_Directory(self, dir);
fnames = notmuch_directory_get_child_files(dir);
return Data_Wrap_Struct(notmuch_rb_cFileNames, NULL, NULL, fnames);
}
/*
* call-seq: DIR.child_directories => FILENAMES
*
* Return a Notmuch::FileNames object, which is an +Enumerable+ listing all the
* directories in the database within the given directory.
*/
VALUE
notmuch_rb_directory_get_child_directories(VALUE self)
{
notmuch_directory_t *dir;
notmuch_filenames_t *fnames;
Data_Get_Notmuch_Directory(self, dir);
fnames = notmuch_directory_get_child_directories(dir);
return Data_Wrap_Struct(notmuch_rb_cFileNames, NULL, NULL, fnames);
}

15
bindings/ruby/extconf.rb Normal file
View file

@ -0,0 +1,15 @@
#!/usr/bin/env ruby
# coding: utf-8
# vim: set sw=2 sts=2 et nowrap fenc=utf-8 :
# Copyright 2010 Ali Polatel <alip@exherbo.org>
# Distributed under the terms of the GNU General Public License v3
require 'mkmf'
# Notmuch Library
find_header('notmuch.h', '../../lib')
find_library('notmuch', 'notmuch_database_create', '../../lib')
# Create Makefile
dir_config('notmuch')
create_makefile('notmuch')

58
bindings/ruby/filenames.c Normal file
View file

@ -0,0 +1,58 @@
/* 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>
*/
#include "defs.h"
/*
* call-seq: FILENAMES.destroy => nil
*
* Destroys the filenames, freeing all resources allocated for it.
*/
VALUE
notmuch_rb_filenames_destroy(VALUE self)
{
notmuch_filenames_t *fnames;
Data_Get_Notmuch_FileNames(self, fnames);
notmuch_filenames_destroy(fnames);
DATA_PTR(self) = NULL;
return Qnil;
}
/*
* call-seq: FILENAMES.each {|item| block } => FILENAMES
*
* Calls +block+ once for each element in +self+, passing that element as a
* parameter.
*/
VALUE
notmuch_rb_filenames_each(VALUE self)
{
notmuch_filenames_t *fnames;
Data_Get_Notmuch_FileNames(self, fnames);
for (; notmuch_filenames_valid(fnames); notmuch_filenames_move_to_next(fnames))
rb_yield(rb_str_new2(notmuch_filenames_get(fnames)));
return self;
}

282
bindings/ruby/init.c Normal file
View file

@ -0,0 +1,282 @@
/* 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>
*/
#include "defs.h"
/*
* Document-module: Notmuch
*
* == Summary
*
* Ruby extension to the <tt>notmuch</tt> mail library.
*
* == Constants
*
* - Notmuch::MODE_READ_ONLY
*
* Open the database in read only mode.
*
* - Notmuch::MODE_READ_WRITE
*
* Open the database in read write mode.
*
* - Notmuch::TAG_MAX
*
* Maximum allowed length of a tag
*/
/*
* Document-class: Notmuch::Database
*
* Notmuch database interaction
*/
/*
* Document-class: Notmuch::Directory
*
* Notmuch directory
*/
/*
* Document-class: Notmuch::FileNames
*
* Notmuch file names
*/
/*
* Document-class: Notmuch::Query
*
* Notmuch query
*/
/*
* Document-class: Notmuch::Threads
*
* Notmuch threads
*/
/*
* Document-class: Notmuch::Messages
*
* Notmuch messages
*/
/*
* Document-class: Notmuch::Thread
*
* Notmuch thread
*/
/*
* Document-class: Notmuch::Message
*
* Notmuch message
*/
/*
* Document-class: Notmuch::Tags
*
* Notmuch tags
*/
/*
* Document-class: Notmuch::BaseError
*
* Base class for all notmuch exceptions
*/
/*
* Document-class: Notmuch::DatabaseError
*
* Raised when the database can't be created or opened.
*/
/*
* Document-class: Notmuch::MemoryError
*
* Raised when notmuch is out of memory
*/
/*
* Document-class: Notmuch::ReadOnlyError
*
* Raised when an attempt was made to write to a database opened in read-only
* mode.
*/
/*
* Document-class: Notmuch::XapianError
*
* Raised when a Xapian exception occurs
*/
/*
* Document-class: Notmuch::FileError
*
* Raised when an error occurs trying to read or write to a file.
*/
/*
* Document-class: Notmuch::FileNotEmailError
*
* Raised when a file is presented that doesn't appear to be an email message.
*/
/*
* Document-class: Notmuch::NullPointerError
*
* Raised when the user erroneously passes a +NULL+ pointer to a notmuch
* function.
*/
/*
* Document-class: Notmuch::TagTooLongError
*
* Raised when a tag value is too long (exceeds Notmuch::TAG_MAX)
*/
/*
* Document-class: Notmuch::UnbalancedFreezeThawError
*
* Raised when the notmuch_message_thaw function has been called more times
* than notmuch_message_freeze.
*/
#define RDOC_HATE 1
void
Init_notmuch(void)
{
VALUE mod;
ID_call = rb_intern("call");
ID_db_create = rb_intern("create");
ID_db_mode = rb_intern("mode");
mod = rb_define_module("Notmuch");
rb_define_const(mod, "MODE_READ_ONLY", INT2FIX(NOTMUCH_DATABASE_MODE_READ_ONLY));
rb_define_const(mod, "MODE_READ_WRITE", INT2FIX(NOTMUCH_DATABASE_MODE_READ_WRITE));
rb_define_const(mod, "SORT_OLDEST_FIRST", INT2FIX(NOTMUCH_SORT_OLDEST_FIRST));
rb_define_const(mod, "SORT_NEWEST_FIRST", INT2FIX(NOTMUCH_SORT_NEWEST_FIRST));
rb_define_const(mod, "SORT_MESSAGE_ID", INT2FIX(NOTMUCH_SORT_MESSAGE_ID));
rb_define_const(mod, "SORT_UNSORTED", INT2FIX(NOTMUCH_SORT_UNSORTED));
rb_define_const(mod, "MESSAGE_FLAG_MATCH", INT2FIX(NOTMUCH_MESSAGE_FLAG_MATCH));
rb_define_const(mod, "TAG_MAX", INT2FIX(NOTMUCH_TAG_MAX));
notmuch_rb_eBaseError = rb_define_class_under(mod, "BaseError", rb_eStandardError);
notmuch_rb_eDatabaseError = rb_define_class_under(mod, "DatabaseError", notmuch_rb_eBaseError);
notmuch_rb_eMemoryError = rb_define_class_under(mod, "MemoryError", notmuch_rb_eBaseError);
notmuch_rb_eReadOnlyError = rb_define_class_under(mod, "ReadOnlyError", notmuch_rb_eBaseError);
notmuch_rb_eXapianError = rb_define_class_under(mod, "XapianError", notmuch_rb_eBaseError);
notmuch_rb_eFileError = rb_define_class_under(mod, "FileError", notmuch_rb_eBaseError);
notmuch_rb_eFileNotEmailError = rb_define_class_under(mod, "FileNotEmailError", notmuch_rb_eBaseError);
notmuch_rb_eNullPointerError = rb_define_class_under(mod, "NullPointerError", notmuch_rb_eBaseError);
notmuch_rb_eTagTooLongError = rb_define_class_under(mod, "TagTooLongError", notmuch_rb_eBaseError);
notmuch_rb_eUnbalancedFreezeThawError = rb_define_class_under(mod, "UnbalancedFreezeThawError",
notmuch_rb_eBaseError);
notmuch_rb_cDatabase = rb_define_class_under(mod, "Database", rb_cData);
rb_define_alloc_func(notmuch_rb_cDatabase, notmuch_rb_database_alloc);
rb_define_singleton_method(notmuch_rb_cDatabase, "open", notmuch_rb_database_open, -1);
rb_define_method(notmuch_rb_cDatabase, "initialize", notmuch_rb_database_initialize, -1);
rb_define_method(notmuch_rb_cDatabase, "close", notmuch_rb_database_close, 0);
rb_define_method(notmuch_rb_cDatabase, "path", notmuch_rb_database_path, 0);
rb_define_method(notmuch_rb_cDatabase, "version", notmuch_rb_database_version, 0);
rb_define_method(notmuch_rb_cDatabase, "needs_upgrade?", notmuch_rb_database_needs_upgrade, 0);
rb_define_method(notmuch_rb_cDatabase, "upgrade!", notmuch_rb_database_upgrade, 0);
rb_define_method(notmuch_rb_cDatabase, "get_directory", notmuch_rb_database_get_directory, 1);
rb_define_method(notmuch_rb_cDatabase, "add_message", notmuch_rb_database_add_message, 1);
rb_define_method(notmuch_rb_cDatabase, "remove_message", notmuch_rb_database_remove_message, 1);
rb_define_method(notmuch_rb_cDatabase, "query", notmuch_rb_database_query_create, 1);
notmuch_rb_cDirectory = rb_define_class_under(mod, "Directory", rb_cData);
rb_undef_method(notmuch_rb_cDirectory, "initialize");
rb_define_method(notmuch_rb_cDirectory, "destroy", notmuch_rb_directory_destroy, 0);
rb_define_method(notmuch_rb_cDirectory, "mtime", notmuch_rb_directory_get_mtime, 0);
rb_define_method(notmuch_rb_cDirectory, "mtime=", notmuch_rb_directory_set_mtime, 1);
rb_define_method(notmuch_rb_cDirectory, "child_files", notmuch_rb_directory_get_child_files, 0);
rb_define_method(notmuch_rb_cDirectory, "child_directories", notmuch_rb_directory_get_child_directories, 0);
notmuch_rb_cFileNames = rb_define_class_under(mod, "FileNames", rb_cData);
rb_undef_method(notmuch_rb_cFileNames, "initialize");
rb_define_method(notmuch_rb_cFileNames, "destroy", notmuch_rb_filenames_destroy, 0);
rb_define_method(notmuch_rb_cFileNames, "each", notmuch_rb_filenames_each, 0);
rb_include_module(notmuch_rb_cFileNames, rb_mEnumerable);
notmuch_rb_cQuery = rb_define_class_under(mod, "Query", rb_cData);
rb_undef_method(notmuch_rb_cQuery, "initialize");
rb_define_method(notmuch_rb_cQuery, "destroy", notmuch_rb_query_destroy, 0);
rb_define_method(notmuch_rb_cQuery, "sort=", notmuch_rb_query_set_sort, 1);
rb_define_method(notmuch_rb_cQuery, "search_threads", notmuch_rb_query_search_threads, 0);
rb_define_method(notmuch_rb_cQuery, "search_messages", notmuch_rb_query_search_messages, 0);
notmuch_rb_cThreads = rb_define_class_under(mod, "Threads", rb_cData);
rb_undef_method(notmuch_rb_cThreads, "initialize");
rb_define_method(notmuch_rb_cThreads, "destroy", notmuch_rb_threads_destroy, 0);
rb_define_method(notmuch_rb_cThreads, "each", notmuch_rb_threads_each, 0);
rb_include_module(notmuch_rb_cThreads, rb_mEnumerable);
notmuch_rb_cMessages = rb_define_class_under(mod, "Messages", rb_cData);
rb_undef_method(notmuch_rb_cMessages, "initialize");
rb_define_method(notmuch_rb_cMessages, "destroy", notmuch_rb_messages_destroy, 0);
rb_define_method(notmuch_rb_cMessages, "each", notmuch_rb_messages_each, 0);
rb_define_method(notmuch_rb_cMessages, "tags", notmuch_rb_messages_collect_tags, 0);
rb_include_module(notmuch_rb_cMessages, rb_mEnumerable);
notmuch_rb_cThread = rb_define_class_under(mod, "Thread", rb_cData);
rb_undef_method(notmuch_rb_cThread, "initialize");
rb_define_method(notmuch_rb_cThread, "destroy", notmuch_rb_thread_destroy, 0);
rb_define_method(notmuch_rb_cThread, "thread_id", notmuch_rb_thread_get_thread_id, 0);
rb_define_method(notmuch_rb_cThread, "total_messages", notmuch_rb_thread_get_total_messages, 0);
rb_define_method(notmuch_rb_cThread, "toplevel_messages", notmuch_rb_thread_get_toplevel_messages, 0);
rb_define_method(notmuch_rb_cThread, "matched_messages", notmuch_rb_thread_get_matched_messages, 0);
rb_define_method(notmuch_rb_cThread, "authors", notmuch_rb_thread_get_authors, 0);
rb_define_method(notmuch_rb_cThread, "subject", notmuch_rb_thread_get_subject, 0);
rb_define_method(notmuch_rb_cThread, "oldest_date", notmuch_rb_thread_get_oldest_date, 0);
rb_define_method(notmuch_rb_cThread, "newest_date", notmuch_rb_thread_get_newest_date, 0);
rb_define_method(notmuch_rb_cThread, "tags", notmuch_rb_thread_get_tags, 0);
notmuch_rb_cMessage = rb_define_class_under(mod, "Message", rb_cData);
rb_undef_method(notmuch_rb_cMessage, "initialize");
rb_define_method(notmuch_rb_cMessage, "destroy", notmuch_rb_message_destroy, 0);
rb_define_method(notmuch_rb_cMessage, "message_id", notmuch_rb_message_get_message_id, 0);
rb_define_method(notmuch_rb_cMessage, "thread_id", notmuch_rb_message_get_thread_id, 0);
rb_define_method(notmuch_rb_cMessage, "replies", notmuch_rb_message_get_replies, 0);
rb_define_method(notmuch_rb_cMessage, "filename", notmuch_rb_message_get_filename, 0);
rb_define_method(notmuch_rb_cMessage, "get_flag", notmuch_rb_message_get_flag, 1);
rb_define_method(notmuch_rb_cMessage, "set_flag", notmuch_rb_message_set_flag, 2);
rb_define_method(notmuch_rb_cMessage, "date", notmuch_rb_message_get_date, 0);
rb_define_method(notmuch_rb_cMessage, "header", notmuch_rb_message_get_header, 1);
rb_define_alias(notmuch_rb_cMessage, "[]", "header");
rb_define_method(notmuch_rb_cMessage, "tags", notmuch_rb_message_get_tags, 0);
rb_define_method(notmuch_rb_cMessage, "add_tag", notmuch_rb_message_add_tag, 1);
rb_define_alias(notmuch_rb_cMessage, "<<", "add_tag");
rb_define_method(notmuch_rb_cMessage, "remove_tag", notmuch_rb_message_remove_tag, 1);
rb_define_method(notmuch_rb_cMessage, "remove_all_tags", notmuch_rb_message_remove_all_tags, 0);
rb_define_method(notmuch_rb_cMessage, "freeze", notmuch_rb_message_freeze, 0);
rb_define_method(notmuch_rb_cMessage, "thaw", notmuch_rb_message_thaw, 0);
notmuch_rb_cTags = rb_define_class_under(mod, "Tags", rb_cData);
rb_undef_method(notmuch_rb_cTags, "initialize");
rb_define_method(notmuch_rb_cTags, "destroy", notmuch_rb_tags_destroy, 0);
rb_define_method(notmuch_rb_cTags, "each", notmuch_rb_tags_each, 0);
rb_include_module(notmuch_rb_cTags, rb_mEnumerable);
}

322
bindings/ruby/message.c Normal file
View file

@ -0,0 +1,322 @@
/* 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>
*/
#include "defs.h"
/*
* call-seq: MESSAGE.destroy => nil
*
* Destroys the message, freeing all resources allocated for it.
*/
VALUE
notmuch_rb_message_destroy(VALUE self)
{
notmuch_message_t *message;
Data_Get_Notmuch_Message(self, message);
notmuch_message_destroy(message);
DATA_PTR(self) = NULL;
return Qnil;
}
/*
* call-seq: MESSAGE.message_id => String
*
* Get the message ID of 'message'.
*/
VALUE
notmuch_rb_message_get_message_id(VALUE self)
{
const char *msgid;
notmuch_message_t *message;
Data_Get_Notmuch_Message(self, message);
msgid = notmuch_message_get_message_id(message);
return rb_str_new2(msgid);
}
/*
* call-seq: MESSAGE.thread_id => String
*
* Get the thread ID of 'message'.
*/
VALUE
notmuch_rb_message_get_thread_id(VALUE self)
{
const char *tid;
notmuch_message_t *message;
Data_Get_Notmuch_Message(self, message);
tid = notmuch_message_get_thread_id(message);
return rb_str_new2(tid);
}
/*
* call-seq: MESSAGE.replies => MESSAGES
*
* Get a Notmuch::Messages enumerable for all of the replies to 'message'.
*/
VALUE
notmuch_rb_message_get_replies(VALUE self)
{
notmuch_messages_t *messages;
notmuch_message_t *message;
Data_Get_Notmuch_Message(self, message);
messages = notmuch_message_get_replies(message);
return Data_Wrap_Struct(notmuch_rb_cMessages, NULL, NULL, messages);
}
/*
* call-seq: MESSAGE.filename => String
*
* Get a filename for the email corresponding to 'message'
*/
VALUE
notmuch_rb_message_get_filename(VALUE self)
{
const char *fname;
notmuch_message_t *message;
Data_Get_Notmuch_Message(self, message);
fname = notmuch_message_get_filename(message);
return rb_str_new2(fname);
}
/*
* call-seq: MESSAGE.get_flag(flag) => true or false
*
* Get a value of a flag for the email corresponding to 'message'
*/
VALUE
notmuch_rb_message_get_flag(VALUE self, VALUE flagv)
{
notmuch_message_t *message;
Data_Get_Notmuch_Message(self, message);
if (!FIXNUM_P(flagv))
rb_raise(rb_eTypeError, "Flag not a Fixnum");
return notmuch_message_get_flag(message, FIX2INT(flagv)) ? Qtrue : Qfalse;
}
/*
* call-seq: MESSAGE.set_flag(flag, value) => nil
*
* Set a value of a flag for the email corresponding to 'message'
*/
VALUE
notmuch_rb_message_set_flag(VALUE self, VALUE flagv, VALUE valuev)
{
notmuch_message_t *message;
Data_Get_Notmuch_Message(self, message);
if (!FIXNUM_P(flagv))
rb_raise(rb_eTypeError, "Flag not a Fixnum");
notmuch_message_set_flag(message, FIX2INT(flagv), RTEST(valuev));
return Qnil;
}
/*
* call-seq: MESSAGE.date => Fixnum
*
* Get the date of 'message'
*/
VALUE
notmuch_rb_message_get_date(VALUE self)
{
notmuch_message_t *message;
Data_Get_Notmuch_Message(self, message);
return UINT2NUM(notmuch_message_get_date(message));
}
/*
* call-seq: MESSAGE.header(name) => String
*
* Get the value of the specified header from 'message'
*/
VALUE
notmuch_rb_message_get_header(VALUE self, VALUE headerv)
{
const char *header, *value;
notmuch_message_t *message;
Data_Get_Notmuch_Message(self, message);
#if !defined(RSTRING_PTR)
#define RSTRING_PTR(v) (RSTRING((v))->ptr)
#endif /* !defined(RSTRING_PTR) */
SafeStringValue(headerv);
header = RSTRING_PTR(headerv);
value = notmuch_message_get_header(message, header);
if (!value)
rb_raise(notmuch_rb_eMemoryError, "Out of memory");
return rb_str_new2(value);
}
/*
* call-seq: MESSAGE.tags => TAGS
*
* Get a Notmuch::Tags enumerable for all of the tags of 'message'.
*/
VALUE
notmuch_rb_message_get_tags(VALUE self)
{
notmuch_message_t *message;
notmuch_tags_t *tags;
Data_Get_Notmuch_Message(self, message);
tags = notmuch_message_get_tags(message);
if (!tags)
rb_raise(notmuch_rb_eMemoryError, "Out of memory");
return Data_Wrap_Struct(notmuch_rb_cTags, NULL, NULL, tags);
}
/*
* call-seq: MESSAGE.add_tag(tag) => true
*
* Add a tag to the 'message'
*/
VALUE
notmuch_rb_message_add_tag(VALUE self, VALUE tagv)
{
const char *tag;
notmuch_status_t ret;
notmuch_message_t *message;
Data_Get_Notmuch_Message(self, message);
#if !defined(RSTRING_PTR)
#define RSTRING_PTR(v) (RSTRING((v))->ptr)
#endif /* !defined(RSTRING_PTR) */
SafeStringValue(tagv);
tag = RSTRING_PTR(tagv);
ret = notmuch_message_add_tag(message, tag);
notmuch_rb_status_raise(ret);
return Qtrue;
}
/*
* call-seq: MESSAGE.remove_tag(tag) => true
*
* Remove a tag from the 'message'
*/
VALUE
notmuch_rb_message_remove_tag(VALUE self, VALUE tagv)
{
const char *tag;
notmuch_status_t ret;
notmuch_message_t *message;
Data_Get_Notmuch_Message(self, message);
#if !defined(RSTRING_PTR)
#define RSTRING_PTR(v) (RSTRING((v))->ptr)
#endif /* !defined(RSTRING_PTR) */
SafeStringValue(tagv);
tag = RSTRING_PTR(tagv);
ret = notmuch_message_remove_tag(message, tag);
notmuch_rb_status_raise(ret);
return Qtrue;
}
/*
* call-seq: MESSAGE.remove_all_tags => true
*
* Remove all tags of the 'message'
*/
VALUE
notmuch_rb_message_remove_all_tags(VALUE self)
{
notmuch_status_t ret;
notmuch_message_t *message;
Data_Get_Notmuch_Message(self, message);
ret = notmuch_message_remove_all_tags(message);
notmuch_rb_status_raise(ret);
return Qtrue;
}
/*
* call-seq: MESSAGE.freeze => true
*
* Freeze the 'message'
*/
VALUE
notmuch_rb_message_freeze(VALUE self)
{
notmuch_status_t ret;
notmuch_message_t *message;
Data_Get_Notmuch_Message(self, message);
ret = notmuch_message_freeze(message);
notmuch_rb_status_raise(ret);
return Qtrue;
}
/*
* call-seq: MESSAGE.thaw => true
*
* Thaw a 'message'
*/
VALUE
notmuch_rb_message_thaw(VALUE self)
{
notmuch_status_t ret;
notmuch_message_t *message;
Data_Get_Notmuch_Message(self, message);
ret = notmuch_message_thaw(message);
notmuch_rb_status_raise(ret);
return Qtrue;
}

80
bindings/ruby/messages.c Normal file
View file

@ -0,0 +1,80 @@
/* 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>
*/
#include "defs.h"
/*
* call-seq: MESSAGES.destroy => nil
*
* Destroys the messages, freeing all resources allocated for it.
*/
VALUE
notmuch_rb_messages_destroy(VALUE self)
{
notmuch_messages_t *messages;
Data_Get_Notmuch_Messages(self, messages);
notmuch_messages_destroy(messages);
DATA_PTR(self) = NULL;
return Qnil;
}
/* call-seq: MESSAGES.each {|item| block } => MESSAGES
*
* Calls +block+ once for each message in +self+, passing that element as a
* parameter.
*/
VALUE
notmuch_rb_messages_each(VALUE self)
{
notmuch_message_t *message;
notmuch_messages_t *messages;
Data_Get_Notmuch_Messages(self, messages);
for (; notmuch_messages_valid(messages); notmuch_messages_move_to_next(messages)) {
message = notmuch_messages_get(messages);
rb_yield(Data_Wrap_Struct(notmuch_rb_cMessage, NULL, NULL, message));
}
return self;
}
/*
* call-seq: MESSAGES.tags => TAGS
*
* Collect tags from the messages
*/
VALUE
notmuch_rb_messages_collect_tags(VALUE self)
{
notmuch_tags_t *tags;
notmuch_messages_t *messages;
Data_Get_Notmuch_Messages(self, messages);
tags = notmuch_messages_collect_tags(messages);
if (!tags)
rb_raise(notmuch_rb_eMemoryError, "Out of memory");
return Data_Wrap_Struct(notmuch_rb_cTags, NULL, NULL, tags);
}

99
bindings/ruby/query.c Normal file
View file

@ -0,0 +1,99 @@
/* 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>
*/
#include "defs.h"
/*
* call-seq: QUERY.destroy => nil
*
* Destroys the query, freeing all resources allocated for it.
*/
VALUE
notmuch_rb_query_destroy(VALUE self)
{
notmuch_query_t *query;
Data_Get_Notmuch_Query(self, query);
notmuch_query_destroy(query);
DATA_PTR(self) = NULL;
return Qnil;
}
/*
* call-seq: QUERY.sort=(fixnum) => nil
*
* Set sort type of the +QUERY+
*/
VALUE
notmuch_rb_query_set_sort(VALUE self, VALUE sortv)
{
notmuch_query_t *query;
Data_Get_Notmuch_Query(self, query);
if (!FIXNUM_P(sortv))
rb_raise(rb_eTypeError, "Not a Fixnum");
notmuch_query_set_sort(query, FIX2UINT(sortv));
return Qnil;
}
/*
* call-seq: QUERY.search_threads => THREADS
*
* Search for threads
*/
VALUE
notmuch_rb_query_search_threads(VALUE self)
{
notmuch_query_t *query;
notmuch_threads_t *threads;
Data_Get_Notmuch_Query(self, query);
threads = notmuch_query_search_threads(query);
if (!threads)
rb_raise(notmuch_rb_eMemoryError, "Out of memory");
return Data_Wrap_Struct(notmuch_rb_cThreads, NULL, NULL, threads);
}
/*
* call-seq: QUERY.search_messages => MESSAGES
*
* Search for messages
*/
VALUE
notmuch_rb_query_search_messages(VALUE self)
{
notmuch_query_t *query;
notmuch_messages_t *messages;
Data_Get_Notmuch_Query(self, query);
messages = notmuch_query_search_messages(query);
if (!messages)
rb_raise(notmuch_rb_eMemoryError, "Out of memory");
return Data_Wrap_Struct(notmuch_rb_cMessages, NULL, NULL, messages);
}

10
bindings/ruby/rdoc.sh Executable file
View file

@ -0,0 +1,10 @@
#!/bin/sh
# vim: set sw=4 et sts=4 tw=80 :
# RDoc fails to document C extension split into many files.
# This is a hack to generate documentation properly.
rm -fr ruby
cat *.c > rdoc-sucks.c
rdoc --main 'Notmuch' --title 'Notmuch Ruby API' --op ruby rdoc-sucks.c
rm -f rdoc-sucks.c

49
bindings/ruby/status.c Normal file
View file

@ -0,0 +1,49 @@
/* 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>
*/
#include "defs.h"
void
notmuch_rb_status_raise(notmuch_status_t status)
{
switch (status) {
case NOTMUCH_STATUS_SUCCESS:
case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
break;
case NOTMUCH_STATUS_OUT_OF_MEMORY:
rb_raise(notmuch_rb_eMemoryError, "out of memory");
case NOTMUCH_STATUS_READ_ONLY_DATABASE:
rb_raise(notmuch_rb_eReadOnlyError, "read-only database");
case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
rb_raise(notmuch_rb_eXapianError, "xapian exception");
case NOTMUCH_STATUS_FILE_ERROR:
rb_raise(notmuch_rb_eFileError, "failed to read/write file");
case NOTMUCH_STATUS_FILE_NOT_EMAIL:
rb_raise(notmuch_rb_eFileNotEmailError, "file not email");
case NOTMUCH_STATUS_NULL_POINTER:
rb_raise(notmuch_rb_eNullPointerError, "null pointer");
case NOTMUCH_STATUS_TAG_TOO_LONG:
rb_raise(notmuch_rb_eTagTooLongError, "tag too long");
case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW:
rb_raise(notmuch_rb_eUnbalancedFreezeThawError, "unbalanced freeze/thaw");
default:
rb_raise(notmuch_rb_eBaseError, "unknown notmuch error");
}
}

61
bindings/ruby/tags.c Normal file
View file

@ -0,0 +1,61 @@
/* 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>
*/
#include "defs.h"
/*
* call-seq: TAGS.destroy => nil
*
* Destroys the tags, freeing all resources allocated for it.
*/
VALUE
notmuch_rb_tags_destroy(VALUE self)
{
notmuch_tags_t *tags;
Data_Get_Notmuch_Tags(self, tags);
notmuch_tags_destroy(tags);
DATA_PTR(self) = NULL;
return Qnil;
}
/*
* call-seq: TAGS.each {|item| block } => TAGS
*
* Calls +block+ once for each element in +self+, passing that element as a
* parameter.
*/
VALUE
notmuch_rb_tags_each(VALUE self)
{
const char *tag;
notmuch_tags_t *tags;
Data_Get_Notmuch_Tags(self, tags);
for (; notmuch_tags_valid(tags); notmuch_tags_move_to_next(tags)) {
tag = notmuch_tags_get(tags);
rb_yield(rb_str_new2(tag));
}
return self;
}

193
bindings/ruby/thread.c Normal file
View file

@ -0,0 +1,193 @@
/* 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>
*/
#include "defs.h"
/*
* call-seq: THREAD.destroy => nil
*
* Destroys the thread, freeing all resources allocated for it.
*/
VALUE
notmuch_rb_thread_destroy(VALUE self)
{
notmuch_thread_t *thread;
Data_Get_Notmuch_Thread(self, thread);
notmuch_thread_destroy(thread);
DATA_PTR(self) = NULL;
return Qnil;
}
/*
* call-seq: THREAD.thread_id => String
*
* Returns the thread id
*/
VALUE
notmuch_rb_thread_get_thread_id(VALUE self)
{
const char *tid;
notmuch_thread_t *thread;
Data_Get_Notmuch_Thread(self, thread);
tid = notmuch_thread_get_thread_id(thread);
return rb_str_new2(tid);
}
/*
* call-seq: THREAD.total_messages => fixnum
*
* Returns the number of total messages
*/
VALUE
notmuch_rb_thread_get_total_messages(VALUE self)
{
notmuch_thread_t *thread;
Data_Get_Notmuch_Thread(self, thread);
return INT2FIX(notmuch_thread_get_total_messages(thread));
}
/*
* call-seq: THREAD.toplevel_messages => MESSAGES
*
* Get a Notmuch::Messages iterator for the top level messages in thread.
*/
VALUE
notmuch_rb_thread_get_toplevel_messages(VALUE self)
{
notmuch_messages_t *messages;
notmuch_thread_t *thread;
Data_Get_Notmuch_Thread(self, thread);
messages = notmuch_thread_get_toplevel_messages(thread);
if (!messages)
rb_raise(notmuch_rb_eMemoryError, "Out of memory");
return Data_Wrap_Struct(notmuch_rb_cMessages, NULL, NULL, messages);
}
/*
* call-seq: THREAD.matched_messages => fixnum
*
* Get the number of messages in thread that matched the search
*/
VALUE
notmuch_rb_thread_get_matched_messages(VALUE self)
{
notmuch_thread_t *thread;
Data_Get_Notmuch_Thread(self, thread);
return INT2FIX(notmuch_thread_get_matched_messages(thread));
}
/*
* call-seq: THREAD.authors => String
*
* Get a comma-separated list of the names of the authors.
*/
VALUE
notmuch_rb_thread_get_authors(VALUE self)
{
const char *authors;
notmuch_thread_t *thread;
Data_Get_Notmuch_Thread(self, thread);
authors = notmuch_thread_get_authors(thread);
return rb_str_new2(authors);
}
/*
* call-seq: THREAD.subject => String
*
* Returns the subject of the thread
*/
VALUE
notmuch_rb_thread_get_subject(VALUE self)
{
const char *subject;
notmuch_thread_t *thread;
Data_Get_Notmuch_Thread(self, thread);
subject = notmuch_thread_get_subject(thread);
return rb_str_new2(subject);
}
/*
* call-seq: THREAD.oldest_date => Fixnum
*
* Get the date of the oldest message in thread.
*/
VALUE
notmuch_rb_thread_get_oldest_date(VALUE self)
{
notmuch_thread_t *thread;
Data_Get_Notmuch_Thread(self, thread);
return UINT2NUM(notmuch_thread_get_oldest_date(thread));
}
/*
* call-seq: THREAD.newest_date => fixnum
*
* Get the date of the newest message in thread.
*/
VALUE
notmuch_rb_thread_get_newest_date(VALUE self)
{
notmuch_thread_t *thread;
Data_Get_Notmuch_Thread(self, thread);
return UINT2NUM(notmuch_thread_get_newest_date(thread));
}
/*
* call-seq: THREAD.tags => TAGS
*
* Get a Notmuch::Tags iterator for the tags of the thread
*/
VALUE
notmuch_rb_thread_get_tags(VALUE self)
{
notmuch_thread_t *thread;
notmuch_tags_t *tags;
Data_Get_Notmuch_Thread(self, thread);
tags = notmuch_thread_get_tags(thread);
if (!tags)
rb_raise(notmuch_rb_eMemoryError, "Out of memory");
return Data_Wrap_Struct(notmuch_rb_cTags, NULL, NULL, tags);
}

60
bindings/ruby/threads.c Normal file
View file

@ -0,0 +1,60 @@
/* 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>
*/
#include "defs.h"
/*
* call-seq: THREADS.destroy => nil
*
* Destroys the threads, freeing all resources allocated for it.
*/
VALUE
notmuch_rb_threads_destroy(VALUE self)
{
notmuch_threads_t *threads;
Data_Get_Struct(self, notmuch_threads_t, threads);
notmuch_threads_destroy(threads);
DATA_PTR(self) = NULL;
return Qnil;
}
/* call-seq: THREADS.each {|item| block } => THREADS
*
* Calls +block+ once for each thread in +self+, passing that element as a
* parameter.
*/
VALUE
notmuch_rb_threads_each(VALUE self)
{
notmuch_thread_t *thread;
notmuch_threads_t *threads;
Data_Get_Notmuch_Threads(self, threads);
for (; notmuch_threads_valid(threads); notmuch_threads_move_to_next(threads)) {
thread = notmuch_threads_get(threads);
rb_yield(Data_Wrap_Struct(notmuch_rb_cThread, NULL, NULL, thread));
}
return self;
}