rroonga 1.2.9 → 1.3.0

data/ext/groonga/rb-grn-index-column.c

@@ -1,4 +1,4 @@
-/* -*- c-file-style: "ruby" -*- */
+/* -*- coding: utf-8; c-file-style: "ruby" -*- */
 /*
   Copyright (C) 2009  Kouhei Sutou <kou@clear-code.com>
 
@@ -31,7 +31,7 @@ VALUE rb_cGrnIndexColumn;
  * とにより高速な全文検索を実現できる。
  *
  * テーブルにGroonga::IndexColumnを定義する方法は
- * Groonga::Table#define_index_columnを参照。
+ * {Groonga::Table#define_index_column} を参照。
  */
 
 void
@@ -100,35 +100,36 @@ rb_grn_index_column_deconstruct (RbGrnIndexColumn *rb_grn_index_column,
  *   column[id] = value
  *   column[id] = options
  *
- * IDが_id_であるレコードを高速に全文検索するため転置索引を作
+ * IDが _id_ であるレコードを高速に全文検索するため転置索引を作
  * 成する。多くの場合、Groonga::Table#define_index_columnで
- * +:source+オプションを指定することにより、自動的に全文検索
+ * +:source+ オプションを指定することにより、自動的に全文検索
  * 用の索引は更新されるので、明示的にこのメソッドを使うこと
  * は少ない。
  *
- * _value_には文字列を指定する。
+ * _value_ には文字列を指定する。
  *
- * _options_を指定することにより、より索引の作成を制御できる。
- * _options_に指定可能な値は以下の通り。
+ * _options_ を指定することにより、より索引の作成を制御できる。
+ * @param [::Hash] options  The name and value
+ *   pairs. Omitted names are initialized as the default value
+ * @option options :section The section
  *
- * [+:section+]
  *   段落番号を指定する。省略した場合は1を指定したとみなされ
  *   る。
- *
  *   Groonga::Table#define_index_columnで
  *   <tt>{:with_section => true}</tt>を指定していなければい
  *   けない。
  *
- * [+:old_value+]
+ * @option options :old_value The old_value
+ *
  *   以前の値を指定する。省略した場合は現在の値が用いられる。
  *   通常は指定する必要はない。
  *
- * [+:value+]
- *   新しい値を指定する。_value_を指定した場合と_options_で
+ * @option options :value The value
+ *   新しい値を指定する。 _value_ を指定した場合と _options_ で
  *   <tt>{:value => value}</tt>を指定した場合は同じ動作とな
  *   る。
  *
- * 記事の段落毎に索引を作成する。
+ * @example 記事の段落毎に索引を作成する。
  *   articles = Groonga::Array.create(:name => "<articles>")
  *   articles.define_column("title", "ShortText")
  *   articles.define_column("content", "Text")
@@ -400,32 +401,35 @@ rb_grn_index_column_set_source (VALUE self, VALUE rb_source)
  * call-seq:
  *   column.search(query, options={}) -> Groonga::Hash
  *
- * _object_から_query_に対応するオブジェクトを検索し、見つかっ
+ * _object_ から _query_ に対応するオブジェクトを検索し、見つかっ
  * たオブジェクトのIDがキーになっているGroonga::Hashを返す。
  *
  * 利用可能なオプションは以下の通り。
- *
- * [+:result+]
+ * @param [::Hash] options The name and value
+ *   pairs. Omitted names are initialized as the default value
+ * @option options [Groonga::Hash] :result The result
  *   結果を格納するGroonga::Hash。指定しない場合は新しく
  *   Groonga::Hashを生成し、それに結果を格納して返す。
- * [+:operator+]
- *   以下のどれかの値を指定する。+nil+, <tt>"or"</tt>, <tt>"||"</tt>,
+ * @option options :operator The operator
+ *
+ *   以下のどれかの値を指定する。 +nil+ , <tt>"or"</tt>, <tt>"||"</tt>,
  *   <tt>"and"</tt>, <tt>"+"</tt>, <tt>"&&"</tt>, <tt>"but"</tt>,
  *   <tt>"not"</tt>, <tt>"-"</tt>, <tt>"adjust"</tt>, <tt>">"</tt>。
  *   それぞれ以下のようになる。（FIXME: 「以下」）
- * [+:exact+]
- *   +true+を指定すると完全一致で検索する
- * [+:longest_common_prefix+]
- *   +true+を指定すると_query_と同じ接頭辞をもつエントリのう
+ * @option options :exact The exact
+ *
+ *   +true+ を指定すると完全一致で検索する
+ * @option options :longest_common_prefix The longest_common_prefix
+ *   +true+ を指定すると _query_ と同じ接頭辞をもつエントリのう
  *   ち、もっとも長いエントリを検索する
- * [+:suffix+]
- *   +true+を指定すると_query_が後方一致するエントリを検索す
+ * @option options :suffix The suffix
+ *   +true+ を指定すると _query_ が後方一致するエントリを検索す
  *   る
- * [+:prefix+]
- *   +true+を指定すると_query_が前方一致するレコードを検索す
+ * @option options :prefix The prefix
+ *   +true+ を指定すると _query_ が前方一致するレコードを検索す
  *   る
- * [+:near+]
- *   +true+を指定すると_query_に指定した複数の語が近傍に含ま
+ * @option options :near The near
+ *   +true+ を指定すると _query_ に指定した複数の語が近傍に含ま
  *   れるレコードを検索する
  * [...]
  *   ...
@@ -494,7 +498,7 @@ rb_grn_index_column_search (int argc, VALUE *argv, VALUE self)
  * call-seq:
  *   column.with_section? -> true/false
  *
- * _column_が段落情報も格納する場合は+true+を返します。
+ * _column_ が段落情報も格納する場合は +true+ を返します。
  */
 static VALUE
 rb_grn_index_column_with_section_p (VALUE self)
@@ -515,7 +519,7 @@ rb_grn_index_column_with_section_p (VALUE self)
  * call-seq:
  *   column.with_weight? -> true/false
  *
- * _column_がウェイト情報も格納する場合は+true+を返します。
+ * _column_ がウェイト情報も格納する場合は +true+ を返します。
  */
 static VALUE
 rb_grn_index_column_with_weight_p (VALUE self)
@@ -536,7 +540,7 @@ rb_grn_index_column_with_weight_p (VALUE self)
  * call-seq:
  *   column.with_position? -> true/false
  *
- * _column_が位置情報も格納する場合は+true+を返します。
+ * _column_ が位置情報も格納する場合は +true+ を返します。
  */
 static VALUE
 rb_grn_index_column_with_position_p (VALUE self)

data/ext/groonga/rb-grn-index-cursor.c

@@ -1,4 +1,4 @@
-/* -*- c-file-style: "ruby" -*- */
+/* -*- coding: utf-8; c-file-style: "ruby" -*- */
 /*
   Copyright (C) 2011  Haruka Yoshihara <yoshihara@clear-code.com>
 

data/ext/groonga/rb-grn-logger.c

@@ -1,4 +1,4 @@
-/* -*- c-file-style: "ruby" -*- */
+/* -*- coding: utf-8; c-file-style: "ruby" -*- */
 /*
   Copyright (C) 2009-2011  Kouhei Sutou <kou@clear-code.com>
 
@@ -256,37 +256,42 @@ rb_grn_logger_initialize (int argc, VALUE *argv, VALUE self)
  * groongaがログを出力する度に呼び出されるブロックを登録す
  * る。
  *
- * ブロックに渡されてくる引数は_level_, _time_, _title_,
- * _message_, _location_の5つで、_level_はSymbol、それ以外は
- * 全て文字列で渡される。その4つについては_options_で+false+
+ * ブロックに渡されてくる引数は _level_ ,  _time_ ,  _title_ ,
+ * _message_ ,  _location_ の5つで、 _level_ はSymbol、それ以外は
+ * 全て文字列で渡される。その4つについては _options_ で +false+
  * を指定することでブロックに渡さないようにすることができ、
  * その場合は空文字列が実際には渡される。
  *
- * _options_に指定可能な値は以下の通り。
+ * _options_ に指定可能な値は以下の通り。
+ * @param options [::Hash] The name and value
+ *   pairs. Omitted names are initialized as the default value.
+ * @option options :level (:notice) The log level
  *
- * [+:level+]
- *   ログのレベルを+:none+, +:emergency+, +:alert+,
- *   +:critical+, +:error+, +:warning+, +:notice+, +:info+,
- *   +:debug+, +:dump+のいずれかで指定する。それより重要度が
+ *   ログのレベルを +:none+ ,  +:emergency+ ,  +:alert+ ,
+ *   +:critical+ , +:error+ , +:warning+ , +:notice+ , +:info+ ,
+ *   +:debug+ ,  +:dump+ のいずれかで指定する。それより重要度が
  *   低いログはブロックに渡されなくなる。デフォルトでは
- *   +:notice+。
+ *   +:notice+ 。
  *
- * [+:time+]
- *   ログが出力された時間をブロックに渡したいなら+true+を指
+ * @option options :time
+ *
+ *   ログが出力された時間をブロックに渡したいなら +true+ を指
  *   定する。デフォルトでは渡す。
  *
- * [+:title+]
- *   ログのタイトルをブロックに渡したいなら+true+を指定す
+ * @option options :title The title
+ *
+ *   ログのタイトルをブロックに渡したいなら +true+ を指定す
  *   る。デフォルトでは渡す。(FIXME: groongaで実装されてい
  *   ない?)
  *
- * [+:message+]
- *   ログのメッセージをブロックに渡したいなら+true+を指定す
+ * @option options :message The message
+ *   ログのメッセージをブロックに渡したいなら +true+ を指定す
  *   る。デフォルトでは渡す。
  *
- * [+:location+]
+ * @option options :location The location
+ *
  *   ログの発生元のプロセスIDとgroongaのソースコードのファイ
- *   ル名、行番号、関数名をブロックに渡したいなら+true+を指
+ *   ル名、行番号、関数名をブロックに渡したいなら +true+ を指
  *   定する。デフォルトでは渡す。
  */
 static VALUE

data/ext/groonga/rb-grn-object.c

@@ -1,4 +1,4 @@
-/* -*- c-file-style: "ruby" -*- */
+/* -*- coding: utf-8; c-file-style: "ruby" -*- */
 /*
   Copyright (C) 2009-2011  Kouhei Sutou <kou@clear-code.com>
 
@@ -108,11 +108,13 @@ rb_grn_object_run_finalizer (grn_ctx *context, grn_obj *grn_object,
       case GRN_PROC:
       case GRN_CURSOR_TABLE_HASH_KEY:
       case GRN_CURSOR_TABLE_PAT_KEY:
+      case GRN_CURSOR_TABLE_DAT_KEY:
       case GRN_CURSOR_TABLE_NO_KEY:
       case GRN_CURSOR_TABLE_VIEW:
 	break;
       case GRN_TABLE_HASH_KEY:
       case GRN_TABLE_PAT_KEY:
+      case GRN_TABLE_DAT_KEY:
 	rb_grn_table_key_support_finalizer(context, grn_object,
 					   RB_GRN_TABLE_KEY_SUPPORT(rb_grn_object));
 	break;
@@ -219,6 +221,9 @@ rb_grn_object_to_ruby_class (grn_obj *object)
       case GRN_TABLE_PAT_KEY:
 	klass = rb_cGrnPatriciaTrie;
 	break;
+      case GRN_TABLE_DAT_KEY:
+	klass = rb_cGrnDoubleArrayTrie;
+	break;
       case GRN_TABLE_NO_KEY:
 	klass = rb_cGrnArray;
 	break;
@@ -255,6 +260,9 @@ rb_grn_object_to_ruby_class (grn_obj *object)
       case GRN_CURSOR_TABLE_PAT_KEY:
 	klass = rb_cGrnPatriciaTrieCursor;
 	break;
+      case GRN_CURSOR_TABLE_DAT_KEY:
+	klass = rb_cGrnDoubleArrayTrieCursor;
+	break;
       case GRN_CURSOR_TABLE_NO_KEY:
 	klass = rb_cGrnArrayCursor;
 	break;
@@ -337,7 +345,6 @@ rb_grn_object_bind_common (VALUE klass, VALUE self, VALUE rb_context,
     }
 
     switch (object->header.type) {
-      case GRN_DB:
       case GRN_PROC:
       case GRN_TYPE:
       case GRN_ACCESSOR: /* TODO: We want to close GRN_ACCESSOR. */
@@ -384,6 +391,7 @@ rb_grn_object_assign (VALUE klass, VALUE self, VALUE rb_context,
 	(RVAL2CBOOL(rb_obj_is_kind_of(self, rb_cGrnType))) ||
 	klass == rb_cGrnHashCursor ||
 	klass == rb_cGrnPatriciaTrieCursor ||
+	klass == rb_cGrnDoubleArrayTrieCursor ||
 	klass == rb_cGrnArrayCursor ||
 	klass == rb_cGrnViewCursor ||
 	klass == rb_cGrnIndexCursor ||
@@ -527,7 +535,7 @@ rb_grn_object_deconstruct (RbGrnObject *rb_grn_object,
  * call-seq:
  *   object.close
  *
- * _object_が使用しているリソースを開放する。これ以降_object_を
+ * _object_ が使用しているリソースを開放する。これ以降 _object_ を
  * 使うことはできない。
  */
 VALUE
@@ -554,7 +562,7 @@ rb_grn_object_close (VALUE self)
  * call-seq:
  *   object.unlink
  *
- * _object_のリファレンスカウンタを1減少する。
+ * _object_ のリファレンスカウンタを1減少する。
  */
 VALUE
 rb_grn_object_unlink (VALUE self)
@@ -582,8 +590,8 @@ rb_grn_object_unlink (VALUE self)
  * call-seq:
  *   object.closed? -> true/false
  *
- * _object_が開放済みの場合は+true+を返し、そうでない場合は
- * +false+を返す。
+ * _object_ が開放済みの場合は+true+を返し、そうでない場合は
+ * +false+ を返す。
  */
 VALUE
 rb_grn_object_closed_p (VALUE self)
@@ -781,6 +789,8 @@ rb_grn_object_inspect_content_flags_with_label (VALUE inspected,
 	    rb_ary_push(inspected_flags, rb_str_new2("TABLE_HASH_KEY"));
 	if (flags & GRN_OBJ_TABLE_PAT_KEY)
 	    rb_ary_push(inspected_flags, rb_str_new2("TABLE_PAT_KEY"));
+	if (flags & GRN_OBJ_TABLE_DAT_KEY)
+	    rb_ary_push(inspected_flags, rb_str_new2("TABLE_DAT_KEY"));
 	if (flags & GRN_OBJ_TABLE_NO_KEY)
 	    rb_ary_push(inspected_flags, rb_str_new2("TABLE_NO_KEY"));
 	if (flags & GRN_OBJ_TABLE_VIEW)
@@ -805,6 +815,7 @@ rb_grn_object_inspect_content_flags_with_label (VALUE inspected,
     switch (object->header.type) {
       case GRN_TABLE_HASH_KEY:
       case GRN_TABLE_PAT_KEY:
+      case GRN_TABLE_DAT_KEY:
 	if (flags & GRN_OBJ_KEY_WITH_SIS)
 	    rb_ary_push(inspected_flags, rb_str_new2("KEY_WITH_SIS"));
 	if (flags & GRN_OBJ_KEY_NORMALIZE)
@@ -929,7 +940,7 @@ rb_grn_object_inspect_footer (VALUE self, VALUE inspected)
  * call-seq:
  *   object.inspect -> 詳細情報
  *
- * _object_の詳細を示した文字列を返す。デバッグ用。
+ * _object_ の詳細を示した文字列を返す。デバッグ用。
  */
 static VALUE
 rb_grn_object_inspect (VALUE self)
@@ -950,8 +961,8 @@ rb_grn_object_inspect (VALUE self)
  * call-seq:
  *   object.id -> ID/nil
  *
- * _object_のIDを返す。_object_が#closed?なときやIDがない場合
- * は+nil+を返す。
+ * _object_ のIDを返す。 _object_ が#closed?なときやIDがない場合
+ * は +nil+ を返す。
  */
 VALUE
 rb_grn_object_get_id (VALUE self)
@@ -976,8 +987,8 @@ rb_grn_object_get_id (VALUE self)
  * call-seq:
  *   object.path -> ファイルパス/nil
  *
- * _object_に対応するファイルパスを返す。一時_object_
- * なら+nil+を返す。
+ * _object_ に対応するファイルパスを返す。一時 _object_
+ * なら +nil+ を返す。
  */
 static VALUE
 rb_grn_object_get_path (VALUE self)
@@ -1003,8 +1014,8 @@ rb_grn_object_get_path (VALUE self)
  * call-seq:
  *   object.temporary? -> true/false
  *
- * _object_が一時オブジェクトなら+true+、永続オブジェクトな
- * ら+false+を返す。
+ * _object_ が一時オブジェクトなら +true+ 、永続オブジェクトな
+ * ら +false+ を返す。
  */
 static VALUE
 rb_grn_object_temporary_p (VALUE self)
@@ -1024,8 +1035,8 @@ rb_grn_object_temporary_p (VALUE self)
  * call-seq:
  *   object.persistent? -> true/false
  *
- * _object_が永続オブジェクトなら+true+、一時オブジェクトな
- * ら+false+を返す。
+ * _object_ が永続オブジェクトなら +true+ 、一時オブジェクトな
+ * ら +false+ を返す。
  */
 static VALUE
 rb_grn_object_persistent_p (VALUE self)
@@ -1045,9 +1056,9 @@ rb_grn_object_persistent_p (VALUE self)
  * call-seq:
  *   object.domain -> Groonga::Object/nil
  *
- * _object_の属しているGroonga::Objectを返す。例えば、
+ * _object_ の属しているGroonga::Objectを返す。例えば、
  * Groonga::ColumnはGroonga::Tableを返す。属している
- * Groonga::Objectがない場合は+nil+を返す。
+ * Groonga::Objectがない場合は +nil+ を返す。
  */
 static VALUE
 rb_grn_object_get_domain (VALUE self)
@@ -1083,7 +1094,7 @@ rb_grn_object_get_domain (VALUE self)
  * call-seq:
  *   object.name -> 名前/nil
  *
- * _object_の名前を返す。無名オブジェクトの場合は+nil+を返す。
+ * _object_ の名前を返す。無名オブジェクトの場合は +nil+ を返す。
  */
 static VALUE
 rb_grn_object_get_name (VALUE self)
@@ -1117,11 +1128,11 @@ rb_grn_object_get_name (VALUE self)
  * call-seq:
  *   object.range -> Groonga::Object/nil
  *
- * _object_の値がとりうる範囲を示したGroonga::Objectを返す。
+ * _object_ の値がとりうる範囲を示したGroonga::Objectを返す。
  * 例えば、Groonga::Columnの場合は
  * Groonga::Table#define_columnで指定されたGroonga::Typeや
  * Groonga::Tableを返す。
- * 範囲が指定されていないオブジェクトの場合は+nil+を返す。
+ * 範囲が指定されていないオブジェクトの場合は +nil+ を返す。
  */
 static VALUE
 rb_grn_object_get_range (VALUE self)
@@ -1157,8 +1168,8 @@ rb_grn_object_get_range (VALUE self)
  * call-seq:
  *   object == other -> true/false
  *
- * _object_と_other_が同じgroongaのオブジェクトなら+true+を返
- * し、そうでなければ+false+を返す。
+ * _object_ と _other_ が同じgroongaのオブジェクトなら +true+ を返
+ * し、そうでなければ +false+ を返す。
  */
 static VALUE
 rb_grn_object_equal (VALUE self, VALUE other)
@@ -1184,7 +1195,7 @@ rb_grn_object_equal (VALUE self, VALUE other)
  * call-seq:
  *   object[id] -> 値
  *
- * _object_の_id_に対応する値を返す。
+ * _object_ の _id_ に対応する値を返す。
  */
 VALUE
 rb_grn_object_array_reference (VALUE self, VALUE rb_id)
@@ -1212,6 +1223,7 @@ rb_grn_object_array_reference (VALUE self, VALUE rb_id)
     switch (object->header.type) {
       case GRN_TABLE_HASH_KEY:
       case GRN_TABLE_PAT_KEY:
+      case GRN_TABLE_DAT_KEY:
       case GRN_TABLE_NO_KEY:
 	GRN_OBJ_INIT(&value, GRN_BULK, 0, GRN_ID_NIL);
 	break;
@@ -1271,6 +1283,7 @@ rb_uvector_value_p (RbGrnObject *rb_grn_object, VALUE rb_value)
 	break;
       case GRN_TABLE_HASH_KEY:
       case GRN_TABLE_PAT_KEY:
+      case GRN_TABLE_DAT_KEY:
       case GRN_TABLE_NO_KEY:
       case GRN_TABLE_VIEW:
 	first_element = rb_ary_entry(rb_value, 0);
@@ -1345,7 +1358,7 @@ rb_grn_object_set (VALUE self, VALUE rb_id, VALUE rb_value, int flags)
  * call-seq:
  *   object[id] = value
  *
- * _object_の_id_に対応する値を設定する。既存の値は上書きさ
+ * _object_ の _id_ に対応する値を設定する。既存の値は上書きさ
  * れる。
  */
 static VALUE
@@ -1360,7 +1373,7 @@ rb_grn_object_array_set (VALUE self, VALUE rb_id, VALUE rb_value)
  * call-seq:
  *   object.append(id, value)
  *
- * _object_の_id_に対応する値の最後に_value_を追加する。
+ * _object_ の _id_ に対応する値の最後に _value_ を追加する。
  */
 static VALUE
 rb_grn_object_append_value (VALUE self, VALUE rb_id, VALUE rb_value)
@@ -1374,7 +1387,7 @@ rb_grn_object_append_value (VALUE self, VALUE rb_id, VALUE rb_value)
  * call-seq:
  *   object.prepend(id, value)
  *
- * _object_の_id_に対応する値の最初に_value_を追加する。
+ * _object_ の _id_ に対応する値の最初に _value_ を追加する。
  */
 static VALUE
 rb_grn_object_prepend_value (VALUE self, VALUE rb_id, VALUE rb_value)
@@ -1388,7 +1401,7 @@ rb_grn_object_prepend_value (VALUE self, VALUE rb_id, VALUE rb_value)
  * call-seq:
  *   object.remove
  *
- * _object_をメモリから解放し、それが永続オブジェクトであっ
+ * _object_ をメモリから解放し、それが永続オブジェクトであっ
  * た場合は、該当するファイル一式を削除する。
  */
 static VALUE