]> git.notmuchmail.org Git - notmuch/blobdiff - bindings/ruby/database.c
ruby: Wrap notmuch_database_{begin,end}_atomic
[notmuch] / bindings / ruby / database.c
index fae5af28c24c1d0c5d5db6231fbd73a4b989b470..a4659ca3737a712f77f50fba55cb43ac05cb33c5 100644 (file)
@@ -1,6 +1,6 @@
 /* The Ruby interface to the notmuch mail library
  *
- * Copyright © 2010 Ali Polatel
+ * Copyright © 2010, 2011 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
 
 #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
+ * 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_new(int argc, VALUE *argv, VALUE klass)
+notmuch_rb_database_initialize(int argc, VALUE *argv, VALUE self)
 {
     const char *path;
     int create, mode;
-    notmuch_rb_database_t *db;
-    VALUE modev, dbv;
+    VALUE pathv, hashv;
+    VALUE modev;
 
 #if !defined(RSTRING_PTR)
 #define RSTRING_PTR(v) (RSTRING((v))->ptr)
 #endif /* !defined(RSTRING_PTR) */
 
     /* Check arguments */
-    if (argc < 1 || argc > 2)
-        rb_raise(rb_eTypeError, "Wrong number of arguments");
+    rb_scan_args(argc, argv, "11", &pathv, &hashv);
 
-    SafeStringValue(argv[0]);
-    path = RSTRING_PTR(argv[0]);
+    SafeStringValue(pathv);
+    path = RSTRING_PTR(pathv);
 
-    if (argc == 2) {
-        Check_Type(argv[1], T_HASH);
-        create = RTEST(rb_hash_aref(argv[1], ID2SYM(ID_db_create)));
-        modev = rb_hash_aref(argv[1], ID2SYM(ID_db_mode));
+    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))
@@ -70,12 +77,31 @@ notmuch_rb_database_new(int argc, VALUE *argv, VALUE klass)
         mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
     }
 
-    dbv = Data_Make_Struct(klass, notmuch_rb_database_t, NULL, notmuch_rb_database_free, db);
-    db->nm_db = create ? notmuch_database_create(path) : notmuch_database_open(path, mode);
-    if (!db->nm_db)
-        rb_raise(notmuch_rb_eDatabaseError, "failed to open database");
+    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 dbv;
+    return rb_ensure(rb_yield, obj, notmuch_rb_database_close, obj);
 }
 
 /*
@@ -86,13 +112,11 @@ notmuch_rb_database_new(int argc, VALUE *argv, VALUE klass)
 VALUE
 notmuch_rb_database_close(VALUE self)
 {
-    notmuch_rb_database_t *db;
+    notmuch_database_t *db;
 
-    Data_Get_Struct(self, notmuch_rb_database_t, db);
-    if (db->nm_db) {
-        notmuch_database_close(db->nm_db);
-        db->nm_db = NULL;
-    }
+    Data_Get_Notmuch_Database(self, db);
+    notmuch_database_close(db);
+    DATA_PTR(self) = NULL;
 
     return Qnil;
 }
@@ -105,13 +129,11 @@ notmuch_rb_database_close(VALUE self)
 VALUE
 notmuch_rb_database_path(VALUE self)
 {
-    notmuch_rb_database_t *db;
+    notmuch_database_t *db;
 
-    Data_Get_Struct(self, notmuch_rb_database_t, db);
-    if (!db->nm_db)
-        rb_raise(rb_eRuntimeError, "Database closed");
+    Data_Get_Notmuch_Database(self, db);
 
-    return rb_str_new2(notmuch_database_get_path(db->nm_db));
+    return rb_str_new2(notmuch_database_get_path(db));
 }
 
 /*
@@ -122,13 +144,11 @@ notmuch_rb_database_path(VALUE self)
 VALUE
 notmuch_rb_database_version(VALUE self)
 {
-    notmuch_rb_database_t *db;
+    notmuch_database_t *db;
 
-    Data_Get_Struct(self, notmuch_rb_database_t, db);
-    if (!db->nm_db)
-        rb_raise(rb_eRuntimeError, "Database closed");
+    Data_Get_Notmuch_Database(self, db);
 
-    return INT2FIX(notmuch_database_get_version(db->nm_db));
+    return INT2FIX(notmuch_database_get_version(db));
 }
 
 /*
@@ -139,13 +159,11 @@ notmuch_rb_database_version(VALUE self)
 VALUE
 notmuch_rb_database_needs_upgrade(VALUE self)
 {
-    notmuch_rb_database_t *db;
+    notmuch_database_t *db;
 
-    Data_Get_Struct(self, notmuch_rb_database_t, db);
-    if (!db->nm_db)
-        rb_raise(rb_eRuntimeError, "Database closed");
+    Data_Get_Notmuch_Database(self, db);
 
-    return notmuch_database_needs_upgrade(db->nm_db) ? Qtrue : Qfalse;
+    return notmuch_database_needs_upgrade(db) ? Qtrue : Qfalse;
 }
 
 static void
@@ -168,12 +186,10 @@ notmuch_rb_database_upgrade(VALUE self)
 {
     notmuch_status_t ret;
     void (*pnotify) (void *closure, double progress);
-    notmuch_rb_database_t *db;
+    notmuch_database_t *db;
     VALUE block;
 
-    Data_Get_Struct(self, notmuch_rb_database_t, db);
-    if (!db->nm_db)
-        rb_raise(rb_eRuntimeError, "Database closed");
+    Data_Get_Notmuch_Database(self, db);
 
     if (rb_block_given_p()) {
         pnotify = notmuch_rb_upgrade_notify;
@@ -182,8 +198,47 @@ notmuch_rb_database_upgrade(VALUE self)
     else
         pnotify = NULL;
 
-    ret = notmuch_database_upgrade(db->nm_db, pnotify, pnotify ? &block : NULL);
+    ret = notmuch_database_upgrade(db, pnotify, pnotify ? &block : NULL);
     notmuch_rb_status_raise(ret);
+
+    return Qtrue;
+}
+
+/*
+ * call-seq: DB.begin_atomic => nil
+ *
+ * Begin an atomic database operation.
+ */
+VALUE
+notmuch_rb_database_begin_atomic(VALUE self)
+{
+    notmuch_status_t ret;
+    notmuch_database_t *db;
+
+    Data_Get_Notmuch_Database(self, db);
+
+    ret = notmuch_database_begin_atomic(db);
+    notmuch_rb_status_raise(ret);
+
+    return Qtrue;
+}
+
+/*
+ * call-seq: DB.end_atomic => nil
+ *
+ * Indicate the end of an atomic database operation.
+ */
+VALUE
+notmuch_rb_database_end_atomic(VALUE self)
+{
+    notmuch_status_t ret;
+    notmuch_database_t *db;
+
+    Data_Get_Notmuch_Database(self, db);
+
+    ret = notmuch_database_end_atomic(db);
+    notmuch_rb_status_raise(ret);
+
     return Qtrue;
 }
 
@@ -196,13 +251,10 @@ VALUE
 notmuch_rb_database_get_directory(VALUE self, VALUE pathv)
 {
     const char *path;
-    notmuch_rb_directory_t *dir;
-    notmuch_rb_database_t *db;
-    VALUE dirv;
+    notmuch_directory_t *dir;
+    notmuch_database_t *db;
 
-    Data_Get_Struct(self, notmuch_rb_database_t, db);
-    if (!db->nm_db)
-        rb_raise(rb_eRuntimeError, "Database closed");
+    Data_Get_Notmuch_Database(self, db);
 
 #if !defined(RSTRING_PTR)
 #define RSTRING_PTR(v) (RSTRING((v))->ptr)
@@ -211,20 +263,18 @@ notmuch_rb_database_get_directory(VALUE self, VALUE pathv)
     SafeStringValue(pathv);
     path = RSTRING_PTR(pathv);
 
-    dirv = Data_Make_Struct(notmuch_rb_cDirectory, notmuch_rb_directory_t,
-            notmuch_rb_directory_mark, notmuch_rb_directory_free, dir);
-    dir->nm_dir = notmuch_database_get_directory(db->nm_db, path);
-    dir->db = self;
-    if (!dir->nm_dir)
+    dir = notmuch_database_get_directory(db, path);
+    if (!dir)
         rb_raise(notmuch_rb_eXapianError, "Xapian exception");
 
-    return dirv;
+    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
+ * Add a message to the database and return it.
+ *
  * +isdup+ is a boolean that specifies whether the added message was a
  * duplicate.
  */
@@ -233,13 +283,10 @@ notmuch_rb_database_add_message(VALUE self, VALUE pathv)
 {
     const char *path;
     notmuch_status_t ret;
-    notmuch_rb_message_t *message;
-    notmuch_rb_database_t *db;
-    VALUE messagev;
+    notmuch_message_t *message;
+    notmuch_database_t *db;
 
-    Data_Get_Struct(self, notmuch_rb_database_t, db);
-    if (!db->nm_db)
-        rb_raise(rb_eRuntimeError, "Database closed");
+    Data_Get_Notmuch_Database(self, db);
 
 #if !defined(RSTRING_PTR)
 #define RSTRING_PTR(v) (RSTRING((v))->ptr)
@@ -248,18 +295,17 @@ notmuch_rb_database_add_message(VALUE self, VALUE pathv)
     SafeStringValue(pathv);
     path = RSTRING_PTR(pathv);
 
-    messagev = Data_Make_Struct(notmuch_rb_cMessage, notmuch_rb_message_t,
-            notmuch_rb_message_mark, notmuch_rb_message_free, message);
-    ret = notmuch_database_add_message(db->nm_db, path, &message->nm_message);
-    message->parent = self;
+    ret = notmuch_database_add_message(db, path, &message);
     notmuch_rb_status_raise(ret);
-    return rb_assoc_new(messagev, (ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) ? Qtrue : Qfalse);
+    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.
  */
@@ -268,11 +314,9 @@ notmuch_rb_database_remove_message(VALUE self, VALUE pathv)
 {
     const char *path;
     notmuch_status_t ret;
-    notmuch_rb_database_t *db;
+    notmuch_database_t *db;
 
-    Data_Get_Struct(self, notmuch_rb_database_t, db);
-    if (!db->nm_db)
-        rb_raise(rb_eRuntimeError, "Database closed");
+    Data_Get_Notmuch_Database(self, db);
 
 #if !defined(RSTRING_PTR)
 #define RSTRING_PTR(v) (RSTRING((v))->ptr)
@@ -281,7 +325,7 @@ notmuch_rb_database_remove_message(VALUE self, VALUE pathv)
     SafeStringValue(pathv);
     path = RSTRING_PTR(pathv);
 
-    ret = notmuch_database_remove_message(db->nm_db, path);
+    ret = notmuch_database_remove_message(db, path);
     notmuch_rb_status_raise(ret);
     return (ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) ? Qtrue : Qfalse;
 }
@@ -295,13 +339,10 @@ VALUE
 notmuch_rb_database_query_create(VALUE self, VALUE qstrv)
 {
     const char *qstr;
-    notmuch_rb_query_t *query;
-    notmuch_rb_database_t *db;
-    VALUE queryv;
+    notmuch_query_t *query;
+    notmuch_database_t *db;
 
-    Data_Get_Struct(self, notmuch_rb_database_t, db);
-    if (!db->nm_db)
-        rb_raise(rb_eRuntimeError, "Database closed");
+    Data_Get_Notmuch_Database(self, db);
 
 #if !defined(RSTRING_PTR)
 #define RSTRING_PTR(v) (RSTRING((v))->ptr)
@@ -310,12 +351,9 @@ notmuch_rb_database_query_create(VALUE self, VALUE qstrv)
     SafeStringValue(qstrv);
     qstr = RSTRING_PTR(qstrv);
 
-    queryv = Data_Make_Struct(notmuch_rb_cQuery, notmuch_rb_query_t,
-            notmuch_rb_query_mark, notmuch_rb_query_free, query);
-    query->nm_query = notmuch_query_create(db->nm_db, qstr);
-    query->db = self;
-    if (!query->nm_query)
-        rb_raise(notmuch_rb_eMemoryError, "out of memory");
+    query = notmuch_query_create(db, qstr);
+    if (!query)
+        rb_raise(notmuch_rb_eMemoryError, "Out of memory");
 
-    return queryv;
+    return Data_Wrap_Struct(notmuch_rb_cQuery, NULL, NULL, query);
 }