groonga 0.0.7 → 0.9.0

data/ext/rb-grn-context.c

@@ -285,6 +285,7 @@ rb_grn_context_initialize (int argc, VALUE *argv, VALUE self)
 
     rb_grn_context = ALLOC(RbGrnContext);
     DATA_PTR(self) = rb_grn_context;
+    rb_grn_context->self = self;
     context = rb_grn_context->context = grn_ctx_open(flags);
     rb_grn_context_check(context, self);
 
@@ -440,8 +441,6 @@ rb_grn_context_connect (int argc, VALUE *argv, VALUE self)
  *   context.send(string) -> ID
  *
  * groongaサーバにクエリ文字列を送信する。
- *
- * 実験的: APIが変わる可能性があります。
  */
 static VALUE
 rb_grn_context_send (VALUE self, VALUE rb_string)
@@ -466,8 +465,6 @@ rb_grn_context_send (VALUE self, VALUE rb_string)
  *   context.receive -> [ID, String]
  *
  * groongaサーバからクエリ実行結果文字列を受信する。
- *
- * 実験的: APIが変わる可能性があります。
  */
 static VALUE
 rb_grn_context_receive (VALUE self)
@@ -606,6 +603,13 @@ rb_grn_context_array_reference (VALUE self, VALUE name_or_id)
     return GRNOBJECT2RVAL(Qnil, context, object, RB_GRN_FALSE);
 }
 
+/*
+ * call-seq:
+ *   context.pop -> 値
+ *
+ * コンテキスト内にあるスタックから値を取り出す。このスタッ
+ * クにはGroonga::Expression#executeの実行結果が格納される。
+ */
 static VALUE
 rb_grn_context_pop (VALUE self)
 {

data/ext/rb-grn-database.c

@@ -78,7 +78,7 @@ rb_grn_database_close (VALUE self)
 {
     VALUE rb_context;
 
-    rb_context = rb_iv_get(self, "context");
+    rb_context = rb_iv_get(self, "@context");
     if (!NIL_P(rb_context))
 	rb_iv_set(rb_context, "database", Qnil);
 
@@ -140,9 +140,8 @@ rb_grn_database_s_create (int argc, VALUE *argv, VALUE klass)
 	grn_obj_close(context, old_database);
     database = grn_db_create(context, path, &create_args);
     rb_grn_context_check(context, rb_ary_new4(argc, argv));
-    rb_database = rb_grn_object_alloc(klass);
-    rb_grn_object_assign(Qnil, rb_database, rb_context, context, database);
-    rb_iv_set(rb_database, "context", rb_context);
+    rb_database = GRNOBJECT2RVAL(klass, context, database, RB_GRN_TRUE);
+    rb_iv_set(rb_database, "@context", rb_context);
     if (!NIL_P(rb_context))
 	rb_iv_set(rb_context, "database", rb_database);
     rb_grn_context_check(context, rb_ary_new4(argc, argv));
@@ -194,7 +193,7 @@ rb_grn_database_initialize (int argc, VALUE *argv, VALUE self)
     rb_grn_object_assign(Qnil, self, rb_context, context, database);
     rb_grn_context_check(context, self);
 
-    rb_iv_set(self, "context", rb_context);
+    rb_iv_set(self, "@context", rb_context);
     if (!NIL_P(rb_context))
 	rb_iv_set(rb_context, "database", self);
 
@@ -222,7 +221,7 @@ rb_grn_database_s_open (int argc, VALUE *argv, VALUE klass)
 {
     VALUE database;
 
-    database = rb_grn_object_alloc(klass);
+    database = rb_obj_alloc(klass);
     rb_grn_database_initialize(argc, argv, database);
     if (rb_block_given_p())
         return rb_ensure(rb_yield, database, rb_grn_database_close, database);
@@ -253,7 +252,7 @@ rb_grn_database_each (VALUE self)
     rb_grn_database_deconstruct(SELF(self), &database, &context,
 				NULL, NULL, NULL, NULL);
     cursor = grn_table_cursor_open(context, database, NULL, 0, NULL, 0,
-				   0, 0, GRN_CURSOR_ASCENDING);
+				   0, -1, GRN_CURSOR_ASCENDING);
     rb_cursor = GRNTABLECURSOR2RVAL(Qnil, context, cursor);
     rb_iv_set(self, "cursor", rb_cursor);
     while ((id = grn_table_cursor_next(context, cursor)) != GRN_ID_NIL) {

data/ext/rb-grn-exception.c

@@ -1,6 +1,6 @@
 /* -*- c-file-style: "ruby" -*- */
 /*
-  Copyright (C) 2009  Kouhei Sutou <kou@clear-code.com>
+  Copyright (C) 2009-2010  Kouhei Sutou <kou@clear-code.com>
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
@@ -19,6 +19,8 @@
 #include "rb-grn.h"
 
 VALUE rb_eGrnError;
+VALUE rb_eGrnObjectClosed;
+VALUE rb_eGrnNoSuchColumn;
 
 static VALUE eGrnEndOfData;
 static VALUE eGrnUnknownError;
@@ -82,6 +84,11 @@ static VALUE eGrnOperationNotSupported;
 static VALUE eGrnAddressIsInUse;
 static VALUE eGrnZLibError;
 static VALUE eGrnLZOError;
+static VALUE eGrnStackOverFlow;
+static VALUE eGrnSyntaxError;
+static VALUE eGrnRetryMax;
+static VALUE eGrnIncompatibleFileFormat;
+static VALUE eGrnUpdateNotAllowed;
 
 VALUE
 rb_grn_rc_to_exception (grn_rc rc)
@@ -90,6 +97,7 @@ rb_grn_rc_to_exception (grn_rc rc)
 
     switch (rc) {
       case GRN_SUCCESS:
+	return Qnil;
         break;
       case GRN_END_OF_DATA:
         exception = eGrnEndOfData;
@@ -277,11 +285,26 @@ rb_grn_rc_to_exception (grn_rc rc)
       case GRN_LZO_ERROR:
         exception = eGrnLZOError;
         break;
-      default:
-        rb_raise(rb_eGrnError, "invalid return code: %d", rc);
+      case GRN_STACK_OVER_FLOW:
+        exception = eGrnStackOverFlow;
+        break;
+      case GRN_SYNTAX_ERROR:
+        exception = eGrnSyntaxError;
+        break;
+      case GRN_RETRY_MAX:
+        exception = eGrnRetryMax;
+        break;
+      case GRN_INCOMPATIBLE_FILE_FORMAT:
+        exception = eGrnIncompatibleFileFormat;
+        break;
+      case GRN_UPDATE_NOT_ALLOWED:
+        exception = eGrnUpdateNotAllowed;
         break;
     }
 
+    if (NIL_P(exception))
+        rb_raise(rb_eGrnError, "invalid return code: %d", rc);
+
     return exception;
 }
 
@@ -292,6 +315,7 @@ rb_grn_rc_to_message (grn_rc rc)
 
     switch (rc) {
       case GRN_SUCCESS:
+	return NULL;
 	break;
       case GRN_END_OF_DATA:
         message = "end of data";
@@ -479,11 +503,26 @@ rb_grn_rc_to_message (grn_rc rc)
       case GRN_LZO_ERROR:
         message = "LZO error";
         break;
-      default:
-        rb_raise(rb_eGrnError, "invalid return code: %d", rc);
+      case GRN_STACK_OVER_FLOW:
+        message = "stack over flow";
+        break;
+      case GRN_SYNTAX_ERROR:
+        message = "syntax error";
+        break;
+      case GRN_RETRY_MAX:
+        message = "retry max";
+        break;
+      case GRN_INCOMPATIBLE_FILE_FORMAT:
+        message = "incompatible file format";
+        break;
+      case GRN_UPDATE_NOT_ALLOWED:
+        message = "update isn't allowed";
         break;
     }
 
+    if (!message)
+        rb_raise(rb_eGrnError, "invalid return code: %d", rc);
+
     return message;
 }
 
@@ -515,6 +554,23 @@ rb_grn_init_exception (VALUE mGrn)
     rb_eGrnError =
         rb_define_class_under(mGrn, "Error", rb_eStandardError);
 
+    /*
+     * Document-class: Groonga::ObjectClosed
+     *
+     * groongaレベルでは破棄されているが、Rubyレベルでは生き
+     * ているオブジェクトにアクセスすると発生する。
+     */
+    rb_eGrnObjectClosed =
+        rb_define_class_under(mGrn, "ObjectClosed", rb_eGrnError);
+
+    /*
+     * Document-class: Groonga::NoSuchColumn
+     *
+     * 存在しないカラムにアクセスすると発生する。
+     */
+    rb_eGrnNoSuchColumn =
+        rb_define_class_under(mGrn, "NoSuchColumn", rb_eGrnError);
+
     /*
      * Document-class: Groonga::EndOfData
      *
@@ -1011,4 +1067,44 @@ rb_grn_init_exception (VALUE mGrn)
      */
     eGrnLZOError =
         rb_define_class_under(mGrn, "LZOError", rb_eGrnError);
+
+    /*
+     * Document-class: Groonga::StackOverFlow
+     *
+     * スタックオーバーフロー時に発生する。
+     */
+    eGrnStackOverFlow =
+        rb_define_class_under(mGrn, "StackOverFlow", rb_eGrnError);
+
+    /*
+     * Document-class: Groonga::SyntaxError
+     *
+     * 構文に問題があるときに発生する。
+     */
+    eGrnSyntaxError =
+        rb_define_class_under(mGrn, "SyntaxError", rb_eGrnError);
+
+    /*
+     * Document-class: Groonga::RetryMax
+     *
+     * 再試行回数が最大数に達したときに発生する。
+     */
+    eGrnRetryMax =
+        rb_define_class_under(mGrn, "RetryMax", rb_eGrnError);
+
+    /*
+     * Document-class: Groonga::IncompatibleFileFormat
+     *
+     * 互換性のないファイルフォーマットを読み込んだときに発生する。
+     */
+    eGrnIncompatibleFileFormat =
+        rb_define_class_under(mGrn, "IncompatibleFileFormat", rb_eGrnError);
+
+    /*
+     * Document-class: Groonga::UpdateNotAllowed
+     *
+     * 更新操作が許可されていないのに更新操作を行ったときに発生する。
+     */
+    eGrnUpdateNotAllowed =
+        rb_define_class_under(mGrn, "UpdateNotAllowed", rb_eGrnError);
 }

data/ext/rb-grn-expression.c

@@ -22,6 +22,13 @@
 
 VALUE rb_cGrnExpression;
 
+/*
+ * Document-class: Groonga::Expression < Groonga::Object
+ *
+ * 検索条件やデータベースへの操作を表現するオブジェクト。
+ *
+ */
+
 void
 rb_grn_expression_finalizer (grn_ctx *context, grn_obj *object,
 			     RbGrnExpression *rb_grn_expression)
@@ -94,6 +101,20 @@ rb_grn_expression_initialize (int argc, VALUE *argv, VALUE self)
     return Qnil;
 }
 
+/*
+ * call-seq:
+ *   expression.define_variable(options={}) -> Groonga::Variable
+ *
+ * _expression_で使用可能な変数を作成する。
+ *
+ * _options_に指定可能な値は以下の通り。
+ *
+ * [+:name+]
+ *   変数の名前。省略した場合は名前を付けない。
+ *
+ * [+:domain+]
+ *   テーブルを指定すると、そのテーブル用のレコードとして初期化する。
+ */
 static VALUE
 rb_grn_expression_define_variable (int argc, VALUE *argv, VALUE self)
 {
@@ -131,6 +152,14 @@ rb_grn_expression_define_variable (int argc, VALUE *argv, VALUE self)
     return rb_variable;
 }
 
+/*
+ * call-seq:
+ *   expression.append_object(object,
+ *                            operation=Groonga::Operation::PUSH,
+ *                            n_arguments=1) -> self
+ *
+ * _object_を追加し、_n_arguments_個の引数を取る_operation_を追加する。
+ */
 static VALUE
 rb_grn_expression_append_object (int argc, VALUE *argv, VALUE self)
 {
@@ -157,10 +186,19 @@ rb_grn_expression_append_object (int argc, VALUE *argv, VALUE self)
     return self;
 }
 
+/*
+ * call-seq:
+ *   expression.append_constant(constant,
+ *                              operation=Groonga::Operation::PUSH,
+ *                              n_arguments=1) -> self
+ *
+ * _constant_を追加し、_n_arguments_個の引数を取る_operation_を追加する。
+ */
 static VALUE
 rb_grn_expression_append_constant (int argc, VALUE *argv, VALUE self)
 {
     VALUE rb_constant, rb_operator, rb_n_arguments;
+    VALUE exception;
     grn_ctx *context = NULL;
     grn_obj *expression, *constant = NULL;
     grn_operator operator = GRN_OP_PUSH;
@@ -178,11 +216,21 @@ rb_grn_expression_append_constant (int argc, VALUE *argv, VALUE self)
 
     RVAL2GRNOBJ(rb_constant, context, &constant);
     grn_expr_append_const(context, expression, constant, operator, n_arguments);
+
+    exception = rb_grn_context_to_exception(context, self);
     grn_obj_close(context, constant);
-    rb_grn_context_check(context, self);
+    if (!NIL_P(exception))
+	rb_exc_raise(exception);
+
     return self;
 }
 
+/*
+ * call-seq:
+ *   expression.append_operation(operation, n_arguments)
+ *
+ * _n_arguments_個の引数を取る_operation_を追加する。
+ */
 static VALUE
 rb_grn_expression_append_operation (VALUE self, VALUE rb_operation,
 				    VALUE rb_n_arguments)
@@ -203,6 +251,84 @@ rb_grn_expression_append_operation (VALUE self, VALUE rb_operation,
     return Qnil;
 }
 
+/*
+ * call-seq:
+ *   expression.parse(query, options={})
+ *
+ * 文字列_query_をパースする。
+ *
+ * _options_に指定可能な値は以下の通り。
+ *
+ * [+:default_column+]
+ *   "column_name:hoge"ではなく"hoge"のようにcolumn_nameが指
+ *   定されない条件の検索対象となるカラムを指定する。
+ *
+ * [+:default_operator+]
+ *   "+"や"OR"で繋がれず、ただ列挙された複数の条件があった時、
+ *   _expression_全体として各レコードをヒットとみなすかの論理
+ *   条件を指定する。省略した場合はGroonga::Operation::AND。
+ *
+ *   [Groonga::Operation::OR]
+ *     レコードはいずれかの条件にマッチすればいい。
+ *   [Groonga::Operation::AND]
+ *     レコードは全ての条件にマッチしなければならない。
+ *   [Groonga::Operation::BUT]
+ *     最初の条件にレコードはマッチし、残りの条件にレコードは
+ *     マッチしてはならない。
+ *
+ * [+:default_mode+]
+ *   検索時のモードを指定する。省略した場合は
+ *   Groonga::Operation::MATCH。（FIXME: モードによってどう
+ *   いう動作になるかを書く。）
+ *
+ * [+:syntax+]
+ *   _query_の構文を指定する。指定可能な値は以下の通り。省略
+ *   した場合は+:query+。
+ *
+ *   [+nil+]
+ *     +:query+と同様。
+ *   [+:query+]
+ *     「文字列1 OR 文字列2」で「"文字列1"あるいは"文字列2"
+ *     にマッチという検索エンジンで利用できるような構文を使
+ *     う。
+ *
+ *     参考: grn式のquery形式（link:text/expression_rdoc.html）
+ *   [+:script+]
+ *     「[カラム名] == [値]」というようにECMAScript風の構文
+ *     を使う。
+ *
+ *     参考: grn式のscript形式（link:text/expression_rdoc.html）
+ *
+ * [+:allow_pragma+]
+ *   _query_の構文にqueryを用いているとき（+:syntax+オプショ
+ *   ン参照）、「*E-1」というようにクエリの先頭でpragmaを利
+ *   用できるようにする。script構文を用いているときはこのオ
+ *   プションを利用できない。
+ *
+ *   デフォルトではプラグマを利用できる。
+ *
+ *   参考: grn式のquery形式（link:text/expression_rdoc.html）
+ *
+ * [+:allow_column+]
+ *   _query_の構文にqueryを用いているとき（+:syntax+オプショ
+ *   ン参照）、「カラム名:値」というようにカラム名を指定した
+ *   条件式を利用できるようにする。script構文を用いていると
+ *   きはこのオプションを利用できない。
+ *
+ *   デフォルトではカラム名を指定した条件式を利用できる。
+ *
+ *   参考: grn式のquery形式（link:text/expression_rdoc.html）
+ *
+ * [+:allow_update+]
+ *   _query_の構文にscriptを用いているとき（+:syntax+オプショ
+ *   ン参照）、「カラム名 = 値」というように更新操作を利用で
+ *   きるようにする。query構文を用いているときはこのオプショ
+ *   ンを利用できない。
+ *
+ *   デフォルトでは更新操作を利用できる。
+ *
+ *   参考: grn式のscript形式（link:text/expression_rdoc.html）
+ */
 static VALUE
 rb_grn_expression_parse (int argc, VALUE *argv, VALUE self)
 {
@@ -213,9 +339,10 @@ rb_grn_expression_parse (int argc, VALUE *argv, VALUE self)
     grn_rc rc;
     char *query = NULL;
     unsigned query_size = 0;
-    int parse_level = 0;
+    grn_expr_flags flags = 0;
     VALUE options, rb_query, rb_default_column, rb_default_operator;
-    VALUE rb_default_mode, rb_parser;
+    VALUE rb_default_mode, rb_syntax;
+    VALUE rb_allow_pragma, rb_allow_column, rb_allow_update;
     VALUE exception = Qnil;
 
     rb_scan_args(argc, argv, "11", &rb_query, &options);
@@ -223,7 +350,10 @@ rb_grn_expression_parse (int argc, VALUE *argv, VALUE self)
                         "default_column", &rb_default_column,
                         "default_operator", &rb_default_operator,
                         "default_mode", &rb_default_mode,
-			"parser", &rb_parser,
+			"syntax", &rb_syntax,
+			"allow_pragma", &rb_allow_pragma,
+			"allow_column", &rb_allow_column,
+			"allow_update", &rb_allow_update,
                         NULL);
 
     query = StringValuePtr(rb_query);
@@ -238,29 +368,55 @@ rb_grn_expression_parse (int argc, VALUE *argv, VALUE self)
 	default_mode = RVAL2GRNOPERATOR(rb_default_mode);
     if (!NIL_P(rb_default_operator))
 	default_operator = RVAL2GRNOPERATOR(rb_default_operator);
-    if (NIL_P(rb_parser) ||
-	rb_grn_equal_option(rb_parser, "column") ||
-	rb_grn_equal_option(rb_parser, "column-query") ||
-	rb_grn_equal_option(rb_parser, "column_query")) {
-	parse_level = 0;
-    } else if (rb_grn_equal_option(rb_parser, "table") ||
-	       rb_grn_equal_option(rb_parser, "table-query") ||
-	       rb_grn_equal_option(rb_parser, "table_query")) {
-	parse_level = 2;
-    } else if (rb_grn_equal_option(rb_parser, "expression") ||
-	       rb_grn_equal_option(rb_parser, "language")) {
-	parse_level = 4;
+
+    if (NIL_P(rb_syntax) ||
+	rb_grn_equal_option(rb_syntax, "query")) {
+	flags = GRN_EXPR_SYNTAX_QUERY;
+    } else if (rb_grn_equal_option(rb_syntax, "script")) {
+	flags = GRN_EXPR_SYNTAX_SCRIPT;
     } else {
 	rb_raise(rb_eArgError,
-		 "parser should be one of "
-		 "[nil, :column, :column_query, :table, :table_query, "
-		 ":expression, :language]: %s",
-		 rb_grn_inspect(rb_parser));
+		 "syntax should be one of "
+		 "[nil, :query, :script]: %s",
+		 rb_grn_inspect(rb_syntax));
+    }
+
+    if (NIL_P(rb_allow_pragma)) {
+	if ((flags & GRN_EXPR_SYNTAX_QUERY) == GRN_EXPR_SYNTAX_QUERY)
+	    flags |= GRN_EXPR_ALLOW_PRAGMA;
+    } else {
+	if ((flags & GRN_EXPR_SYNTAX_SCRIPT) == GRN_EXPR_SYNTAX_SCRIPT)
+	    rb_raise(rb_eArgError,
+		 ":allow_pragma isn't allowed in script syntax");
+	if (RVAL2CBOOL(rb_allow_pragma))
+	    flags |= GRN_EXPR_ALLOW_PRAGMA;
+    }
+
+    if (NIL_P(rb_allow_column)) {
+	if ((flags & GRN_EXPR_SYNTAX_QUERY) == GRN_EXPR_SYNTAX_QUERY)
+	    flags |= GRN_EXPR_ALLOW_COLUMN;
+    } else {
+	if ((flags & GRN_EXPR_SYNTAX_SCRIPT) == GRN_EXPR_SYNTAX_SCRIPT)
+	    rb_raise(rb_eArgError,
+		     ":allow_column isn't allowed in script syntax");
+	if (RVAL2CBOOL(rb_allow_column))
+	    flags |= GRN_EXPR_ALLOW_COLUMN;
+    }
+
+    if (NIL_P(rb_allow_update)) {
+	if ((flags & GRN_EXPR_SYNTAX_SCRIPT) == GRN_EXPR_SYNTAX_SCRIPT)
+	    flags |= GRN_EXPR_ALLOW_UPDATE;
+    } else {
+	if ((flags & GRN_EXPR_SYNTAX_QUERY) == GRN_EXPR_SYNTAX_QUERY)
+	    rb_raise(rb_eArgError,
+		     ":allow_update isn't allowed in query syntax");
+	if (RVAL2CBOOL(rb_allow_update))
+	    flags |= GRN_EXPR_ALLOW_UPDATE;
     }
 
     rc = grn_expr_parse(context, expression, query, query_size,
 			default_column, default_mode, default_operator,
-			parse_level);
+			flags);
     if (rc != GRN_SUCCESS) {
 	VALUE related_object;
 
@@ -275,6 +431,12 @@ rb_grn_expression_parse (int argc, VALUE *argv, VALUE self)
     return Qnil;
 }
 
+/*
+ * call-seq:
+ *   expression.execute
+ *
+ * _expression_を実行する。
+ */
 static VALUE
 rb_grn_expression_execute (VALUE self)
 {
@@ -293,6 +455,12 @@ rb_grn_expression_execute (VALUE self)
     return Qnil;
 }
 
+/*
+ * call-seq:
+ *   expression.compile
+ *
+ * _expression_をコンパイルする。
+ */
 static VALUE
 rb_grn_expression_compile (VALUE self)
 {
@@ -311,6 +479,15 @@ rb_grn_expression_compile (VALUE self)
     return Qnil;
 }
 
+/*
+ * call-seq:
+ *   expression[name] -> 変数の値
+ *   expression[offset] -> 変数の値
+ *
+ * _expression_で使用可能な変数のうち、名前が_name_または
+ * _offset_番目にExpression#append_objectされた変数の値を返
+ * す。
+ */
 static VALUE
 rb_grn_expression_array_reference (VALUE self, VALUE rb_name_or_offset)
 {
@@ -329,12 +506,12 @@ rb_grn_expression_array_reference (VALUE self, VALUE rb_name_or_offset)
         name = RSTRING_PTR(rb_name_or_offset);
         name_size = RSTRING_LEN(rb_name_or_offset);
         variable = grn_expr_get_var(context, expression, name, name_size);
-        return GRNBULK2RVAL(context, variable, self);
+        return GRNBULK2RVAL(context, variable, NULL, self);
         break;
     case T_FIXNUM:
         offset = NUM2INT(rb_name_or_offset);
         value = grn_expr_get_var_by_offset(context, expression, offset);
-        return GRNBULK2RVAL(context, value, self);
+        return GRNBULK2RVAL(context, value, NULL, self);
         break;
     default:
         rb_raise(rb_eArgError, "xxx");
@@ -347,6 +524,12 @@ rb_grn_expression_array_reference (VALUE self, VALUE rb_name_or_offset)
 /* REMOVE ME */
 grn_rc grn_expr_inspect(grn_ctx *ctx, grn_obj *buf, grn_obj *expr);
 
+/*
+ * call-seq:
+ *   _expression_.inspect -> String
+ *
+ * _expression_の中身を人に見やすい文字列で返す。
+ */
 static VALUE
 rb_grn_expression_inspect (VALUE self)
 {