rroonga 2.0.4-x86-mingw32 → 2.0.7-x86-mingw32

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

@@ -107,20 +107,17 @@ rb_grn_expression_initialize (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   expression.define_variable(options={}) -> Groonga::Variable
- *
  * _expression_ で使用可能な変数を作成する。
  *
- * _options_ に指定可能な値は以下の通り。
- * @param options [::Hash] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :name (false)
- *
- *   変数の名前。省略した場合は名前を付けない。
- * @option options :domain
+ * @overload define_variable(options={})
+ *   @param [::Hash] options The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :name (false)
+ *     変数の名前。省略した場合は名前を付けない。
+ *   @option options :domain
+ *     テーブルを指定すると、そのテーブル用のレコードとして初期化する。
+ * @return [Groonga::Variable]
  *
- *   テーブルを指定すると、そのテーブル用のレコードとして初期化する。
  */
 static VALUE
 rb_grn_expression_define_variable (int argc, VALUE *argv, VALUE self)
@@ -160,12 +157,14 @@ rb_grn_expression_define_variable (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   expression.append_object(object,
- *                            operation=Groonga::Operator::PUSH,
- *                            n_arguments=1) -> self
- *
  * _object_ を追加し、 _n_arguments_ 個の引数を取る _operation_ を追加する。
+ *
+ * @overload append_object(object, operation=Groonga::Operator::PUSH, n_arguments=1)
+ *   @param [Object] object 追加するオブジェクト
+ *   @param [Groonga::Operator::XXX] operation 追加する _operation_
+ *   @param [Integer] n_arguments _operation_ の取る引数
+ * @return [Self] self
+ *
  */
 static VALUE
 rb_grn_expression_append_object (int argc, VALUE *argv, VALUE self)
@@ -196,12 +195,13 @@ rb_grn_expression_append_object (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   expression.append_constant(constant,
- *                              operation=Groonga::Operator::PUSH,
- *                              n_arguments=1) -> self
- *
  * _constant_ を追加し、 _n_arguments_ 個の引数を取る _operation_ を追加する。
+ *
+ * @overload append_constant(constant, operation=Groonga::Operator::PUSH, n_arguments=1)
+ *   @param [Object] constant 追加する _constant_
+ *   @param [Groonga::Operator::XXX] operation 追加する _operation_
+ *   @param [Integer] n_arguments _operation_ の取る引数
+ * @return [Self] self
  */
 static VALUE
 rb_grn_expression_append_constant (int argc, VALUE *argv, VALUE self)
@@ -235,10 +235,9 @@ rb_grn_expression_append_constant (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   expression.append_operation(operation, n_arguments)
- *
  * _n_arguments_ 個の引数を取る _operation_ を追加する。
+ *
+ * @overload append_operation(operation, n_arguments)
  */
 static VALUE
 rb_grn_expression_append_operation (VALUE self, VALUE rb_operation,
@@ -261,87 +260,71 @@ rb_grn_expression_append_operation (VALUE self, VALUE rb_operation,
 }
 
 /*
- * call-seq:
- *   expression.parse(query, options={})
- *
  * 文字列 _query_ をパースする。
- *
- * _options_ に指定可能な値は以下の通り。
- * @param options [::Hash] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :default_column The default_column
- *
- *   "column_name:hoge"ではなく"hoge"のようにcolumn_nameが指
- *   定されない条件の検索対象となるカラムを指定する。
- * @option options :default_operator (Groonga::Operator::AND)
- *
- *   The default_operator
- *   "+"や"OR"で繋がれず、ただ列挙された複数の条件があった時、
- *   _expression_ 全体として各レコードをヒットとみなすかの論理
- *   条件を指定する。省略した場合はGroonga::Operator::AND。
- *   [Groonga::Operator::OR]
- *     レコードはいずれかの条件にマッチすればいい。
- *   [Groonga::Operator::AND]
- *     レコードは全ての条件にマッチしなければならない。
- *   [Groonga::Operator::BUT]
- *     最初の条件にレコードはマッチし、残りの条件にレコードは
- *     マッチしてはならない。
- * @option options :default_mode (Groonga::Operator::MATCH) The default_mode
- *
- *   検索時のモードを指定する。省略した場合は
- *   Groonga::Operator::MATCH。（FIXME: モードによってどう
- *   いう動作になるかを書く。）
- *
- * @option options :syntax (:query) The 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）
- *
- * @option options :allow_pragma The allow_pragma
- *   _query_ の構文に query を用いているとき（ +:syntax+
- *   オプション参照）、「*E-1」というようにクエリの先頭で
- *   pragmaを利用できるようにする。script構文を用いている
- *   ときはこのオプションを利用できない。
- *
- *   デフォルトではプラグマを利用できる。
- *
- *   参考: grn式のquery形式（link:text/expression_rdoc.html）
- *
- * @option options :allow_column The allow_column
- *
- *   _query_ の構文にqueryを用いているとき（+:syntax+オプショ
- *   ン参照）、「カラム名:値」というようにカラム名を指定した
- *   条件式を利用できるようにする。script構文を用いていると
- *   きはこのオプションを利用できない。
- *
- *   デフォルトではカラム名を指定した条件式を利用できる。
- *
- *   参考: grn式のquery形式（link:text/expression_rdoc.html）
- *
- * @option options :allow_update The allow_update
- *
- *   _query_の構文にscriptを用いているとき（ +:syntax+ オプショ
- *   ン参照）、「カラム名 = 値」というように更新操作を利用で
- *   きるようにする。query構文を用いているときはこのオプショ
- *   ンを利用できない。
- *
- *   デフォルトでは更新操作を利用できる。
- *
- *   参考: grn式のscript形式（link:text/expression_rdoc.html）
+ * @overload parse(query, options={})
+ *   @param [String] query パースする文字列
+ *   @param [::Hash] options The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :default_column
+ *     "column_name:hoge"ではなく"hoge"のようにcolumn_nameが指
+ *     定されない条件の検索対象となるカラムを指定する。
+ *   @option options :default_operator (Groonga::Operator::AND)
+ *     "+"や"OR"で繋がれず、ただ列挙された複数の条件があった時、
+ *     _expression_ 全体として各レコードをヒットとみなすかの論理
+ *     条件を指定する。省略した場合はGroonga::Operator::AND。
+ *
+ *     - Groonga::Operator::OR :=
+ *       レコードはいずれかの条件にマッチすればいい。 =:
+ *     - Groonga::Operator::AND :=
+ *       レコードは全ての条件にマッチしなければならない。 =:
+ *     - Groonga::Operator::BUT :=
+ *       最初の条件にレコードはマッチし、残りの条件にレコードは
+ *       マッチしてはならない。 =:
+ *
+ *   @option options :default_mode (Groonga::Operator::MATCH)
+ *     検索時のモードを指定する。省略した場合はGroonga::Operator::MATCH。
+ *     （FIXME: モードによってどういう動作になるかを書く。）
+ *   @option options :syntax (:query)
+ *     _query_ の構文を指定する。指定可能な値は以下の通り。省略
+ *     した場合は +:query+ 。
+ *
+ *     - +:query+ :=
+ *       「文字列1 OR 文字列2」で「"文字列1"あるいは"文字列2"
+ *       にマッチという検索エンジンで利用できるような構文を使
+ *       う。
+ *       参考: "Groongaのクエリ構文のドキュメント":http://groonga.org/ja/docs/reference/grn_expr/query_syntax.html =:
+ *     - +nil+ :=
+ *       +:query+と同様 =:
+ *     - +:script+ :=
+ *       「[カラム名] == [値]」というようにECMAScript風の構文を使う。
+ *       参考: "Groongaのscript構文のドキュメント":http://groonga.org/ja/docs/reference/grn_expr/script_syntax.html =:
+ *   @option options :allow_pragma
+ *     _query_ の構文に query を用いているとき（ +:syntax+
+ *     オプション参照）、「*E-1」というようにクエリの先頭で
+ *     pragmaを利用できるようにする。script構文を用いている
+ *     ときはこのオプションを利用できない。
+ *
+ *     デフォルトではプラグマを利用できる。
+ *
+ *     参考: "Groongaのクエリ構文のドキュメント":http://groonga.org/ja/docs/reference/grn_expr/query_syntax.html
+ *   @option options :allow_column
+ *     _query_ の構文にqueryを用いているとき（ +:syntax+ オプショ
+ *     ン参照）、「カラム名:値」というようにカラム名を指定した
+ *     条件式を利用できるようにする。script構文を用いていると
+ *     きはこのオプションを利用できない。
+ *
+ *     デフォルトではカラム名を指定した条件式を利用できる。
+ *
+ *     参考: "Groongaのクエリ構文のドキュメント":http://groonga.org/ja/docs/reference/grn_expr/query_syntax.html
+ *   @option options :allow_update
+ *     _query_ の構文にscriptを用いているとき（ +:syntax+ オプショ
+ *     ン参照）、「カラム名 = 値」というように更新操作を利用で
+ *     きるようにする。query構文を用いているときはこのオプショ
+ *     ンを利用できない。
+ *
+ *     デフォルトでは更新操作を利用できる。
+ *
+ *     参考: "Groongaのクエリ構文のドキュメント":http://groonga.org/ja/docs/reference/grn_expr/query_syntax.html
  */
 static VALUE
 rb_grn_expression_parse (int argc, VALUE *argv, VALUE self)
@@ -357,7 +340,7 @@ rb_grn_expression_parse (int argc, VALUE *argv, VALUE self)
     grn_expr_flags flags = 0;
     VALUE options, rb_query, rb_default_column, rb_default_operator;
     VALUE rb_default_mode, rb_syntax;
-    VALUE rb_allow_pragma, rb_allow_column, rb_allow_update;
+    VALUE rb_allow_pragma, rb_allow_column, rb_allow_update, rb_allow_leading_not;
     VALUE exception = Qnil;
 
     rb_scan_args(argc, argv, "11", &rb_query, &options);
@@ -369,6 +352,7 @@ rb_grn_expression_parse (int argc, VALUE *argv, VALUE self)
 			"allow_pragma", &rb_allow_pragma,
 			"allow_column", &rb_allow_column,
 			"allow_update", &rb_allow_update,
+			"allow_leading_not", &rb_allow_leading_not,
                         NULL);
 
     query = StringValuePtr(rb_query);
@@ -433,6 +417,11 @@ rb_grn_expression_parse (int argc, VALUE *argv, VALUE self)
 	    flags |= GRN_EXPR_ALLOW_UPDATE;
     }
 
+    if (!NIL_P(rb_allow_leading_not)) {
+	if (RVAL2CBOOL(rb_allow_leading_not))
+	    flags |= GRN_EXPR_ALLOW_LEADING_NOT;
+    }
+
     rc = grn_expr_parse(context, expression, query, query_size,
 			default_column, default_mode, default_operator,
 			flags);
@@ -452,10 +441,10 @@ rb_grn_expression_parse (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   expression.execute -> 値
+ * _expression_ を実行し、実行した結果を返す。
  *
- * _expression_を実行し、実行した結果を返す。
+ * @overload execute
+ *   @return [値]
  */
 static VALUE
 rb_grn_expression_execute (VALUE self)
@@ -475,10 +464,9 @@ rb_grn_expression_execute (VALUE self)
 }
 
 /*
- * call-seq:
- *   expression.compile
+ * _expression_ をコンパイルする。
  *
- * _expression_をコンパイルする。
+ * @overload compile
  */
 static VALUE
 rb_grn_expression_compile (VALUE self)
@@ -499,13 +487,14 @@ rb_grn_expression_compile (VALUE self)
 }
 
 /*
- * call-seq:
- *   expression[name] -> 変数の値
- *   expression[offset] -> 変数の値
- *
- * _expression_ で使用可能な変数のうち、名前が _name_ または
- * _offset_ 番目にExpression#append_objectされた変数の値を返
- * す。
+ * _expression_ で使用可能な変数のうち、名前が _name_
+ * または _offset_ 番目に {Expression#append_object}
+ * された変数の値を返す。
+ *
+ * @overload [](name)
+ *   @return [変数の値]
+ * @overload [](offset)
+ *   @return [変数の値]
  */
 static VALUE
 rb_grn_expression_array_reference (VALUE self, VALUE rb_name_or_offset)
@@ -544,10 +533,10 @@ rb_grn_expression_array_reference (VALUE self, VALUE rb_name_or_offset)
 grn_rc grn_expr_inspect(grn_ctx *ctx, grn_obj *buf, grn_obj *expr);
 
 /*
- * call-seq:
- *   _expression_.inspect -> String
- *
  * _expression_ の中身を人に見やすい文字列で返す。
+ *
+ * @overload inspect
+ *   @return [String]
  */
 static VALUE
 rb_grn_expression_inspect (VALUE self)
@@ -578,20 +567,17 @@ rb_grn_expression_inspect (VALUE self)
 }
 
 /*
- * call-seq:
- *   expression.snippet(tags, options) -> Groonga::Snippet
- *
- * _expression_ からGroonga::Snippetを生成する。 _tags_ には
+ * _expression_ から {Groonga::Snippet} を生成する。 _tags_ には
  * キーワードの前後に挿入するタグの配列を以下のような形式で指定
  * する。
  *
  * <pre>
  * !!!ruby
- * [
- *  ["キーワード前に挿入する文字列1", "キーワード後に挿入する文字列1"],
- *  ["キーワード前に挿入する文字列2", "キーワード後に挿入する文字列2"],
- *  # ...,
- * ]
+ *   [
+ *    ["キーワード前に挿入する文字列1", "キーワード後に挿入する文字列1"],
+ *    ["キーワード前に挿入する文字列2", "キーワード後に挿入する文字列2"],
+ *    # ...,
+ *   ]
  * </pre>
  *
  * もし、1つのスニペットの中に _tags_ で指定したタグより多くの
@@ -600,37 +586,33 @@ rb_grn_expression_inspect (VALUE self)
  *
  * <pre>
  * !!!ruby
- * expression.parse("Ruby groonga 検索")
- * tags = [["<tag1>", "</tag1>"], ["<tag2>", "</tag2>"]]
- * snippet = expression.snippet(tags)
- * p snippet.execute("Rubyでgroonga使って全文検索、高速検索。")
- *    # => ["<tag1>Ruby</tag1>で<tag2>groonga</tag2>"
- *    # =>  "使って全文<tag1>検索</tag1>、高速<tag2>検索</tag2>。"]
+ *   expression.parse("Ruby groonga 検索")
+ *   tags = [["<tag1>", "</tag1>"], ["<tag2>", "</tag2>"]]
+ *   snippet = expression.snippet(tags)
+ *   p snippet.execute("Rubyでgroonga使って全文検索、高速検索。")
+ *      # => ["<tag1>Ruby</tag1>で<tag2>groonga</tag2>"
+ *      # =>  "使って全文<tag1>検索</tag1>、高速<tag2>検索</tag2>。"]
  * </pre>
  *
- * _options_ に指定可能な値は以下の通り。
- * @param options [::Hash] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :normalize (false) The normalize
- *
- *   キーワード文字列・スニペット元の文字列を正規化するかど
- *   うか。省略した場合は +false+ で正規化しない。
- *
- * @option options :skip_leading_spaces (false) The skip_leading_spaces
- *
- *   先頭の空白を無視するかどうか。省略した場合は +false+ で無
- *   視しない。
- *
- * @option options :width (100) The width
- *
- *   スニペット文字列の長さ。省略した場合は100文字。
- * @option options :max_results (3) The max_results
- *
- *   生成するスニペットの最大数。省略した場合は3。
- * @option options :html_escape (false) The html_escape
- *
- *   スニペット内の +<+, +>+, +&+, +"+ をHTMLエスケープするか
- *   どうか。省略した場合は +false+ で、HTMLエスケープしない。
+ * @overload snippet(tags, options)
+ *   @param tags [Array<string>] キーワードの前後に挿入するタグの配列
+ *     （詳細は上記を参照）
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :normalize (false)
+ *     キーワード文字列・スニペット元の文字列を正規化するかど
+ *     うか。省略した場合は +false+ で正規化しない。
+ *   @option options :skip_leading_spaces (false)
+ *     先頭の空白を無視するかどうか。省略した場合は +false+ で無
+ *     視しない。
+ *   @option options :width (100)
+ *     スニペット文字列の長さ。省略した場合は100文字。
+ *   @option options :max_results (3)
+ *     生成するスニペットの最大数。省略した場合は3。
+ *   @option options :html_escape (false)
+ *     スニペット内の +<+, +>+, +&+, +"+ をHTMLエスケープするか
+ *     どうか。省略した場合は +false+ で、HTMLエスケープしない。
+ * @return [Groonga::Snippet]
  */
 static VALUE
 rb_grn_expression_snippet (int argc, VALUE *argv, VALUE self)

data/ext/groonga/rb-grn-fix-size-column.c

@@ -29,10 +29,10 @@ VALUE rb_cGrnFixSizeColumn;
  */
 
 /*
- * call-seq:
- *   column[id] -> 値
- *
  * _column_ の _id_ に対応する値を返す。
+ *
+ * @overload column[id]
+ *   @return [値]
  */
 VALUE
 rb_grn_fix_size_column_array_reference (VALUE self, VALUE rb_id)
@@ -56,10 +56,11 @@ rb_grn_fix_size_column_array_reference (VALUE self, VALUE rb_id)
 }
 
 /*
- * call-seq:
- *   column[id] = value
- *
  * _column_ の _id_ に対応する値を設定する。
+ *
+ * @overload []=(id, value)
+ *   @param [Integer] id 設定する値に対応する _column_ の _id_
+ *   @param [Groonga::Object] value 設定する値
  */
 static VALUE
 rb_grn_fix_size_column_array_set (VALUE self, VALUE rb_id, VALUE rb_value)
@@ -77,7 +78,7 @@ rb_grn_fix_size_column_array_set (VALUE self, VALUE rb_id, VALUE rb_value)
 			      &value, &range_id, &range);
 
     id = NUM2UINT(rb_id);
-    RVAL2GRNBULK_WITH_TYPE(rb_value, context, value, range_id, range);
+    RVAL2GRNVALUE(rb_value, context, value, range_id, range);
 
     rc = grn_obj_set_value(context, column, id, value, GRN_OBJ_SET);
     rb_grn_context_check(context, self);
@@ -117,11 +118,10 @@ rb_grn_fix_size_column_integer_set (int argc, VALUE *argv, VALUE self, int flags
 }
 
 /*
- * call-seq:
- *   column.increment!(id, delta=nil)
- *
  * _column_ の _id_ に対応する値を _delta_ だけ増加する。 _delta_
  * が +nil+ の場合は1増加する。
+ *
+ * @overload increment!(id, delta=nil)
  */
 static VALUE
 rb_grn_fix_size_column_increment (int argc, VALUE *argv, VALUE self)
@@ -130,11 +130,10 @@ rb_grn_fix_size_column_increment (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   column.decrement!(id, delta=nil)
- *
  * _column_ の _id_ に対応する値を _delta_ だけ減少する。 _delta_
  * が +nil+ の場合は1減少する。
+ *
+ * @overload decrement!(id, delta=nil)
  */
 static VALUE
 rb_grn_fix_size_column_decrement (int argc, VALUE *argv, VALUE self)

data/ext/groonga/rb-grn-geo-point.c

@@ -0,0 +1,55 @@
+/* -*- coding: utf-8; c-file-style: "ruby" -*- */
+/*
+  Copyright (C) 2012  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
+  License version 2.1 as published by the Free Software Foundation.
+
+  This library 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
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+*/
+
+#include "rb-grn.h"
+
+VALUE rb_cGrnTokyoGeoPoint;
+VALUE rb_cGrnWGS84GeoPoint;
+
+VALUE
+rb_grn_tokyo_geo_point_new (int latitude, int longitude)
+{
+    return rb_grn_tokyo_geo_point_new_raw(INT2NUM(latitude), INT2NUM(longitude));
+}
+
+VALUE
+rb_grn_wgs84_geo_point_new (int latitude, int longitude)
+{
+    return rb_grn_wgs84_geo_point_new_raw(INT2NUM(latitude), INT2NUM(longitude));
+}
+
+VALUE
+rb_grn_tokyo_geo_point_new_raw (VALUE latitude, VALUE longitude)
+{
+    return rb_funcall(rb_cGrnTokyoGeoPoint, rb_intern("new"), 2,
+		      latitude, longitude);
+}
+
+VALUE
+rb_grn_wgs84_geo_point_new_raw (VALUE latitude, VALUE longitude)
+{
+    return rb_funcall(rb_cGrnWGS84GeoPoint, rb_intern("new"), 2,
+		      latitude, longitude);
+}
+
+void
+rb_grn_init_geo_point (VALUE mGrn)
+{
+    rb_cGrnTokyoGeoPoint = rb_const_get(mGrn, rb_intern("TokyoGeoPoint"));
+    rb_cGrnWGS84GeoPoint = rb_const_get(mGrn, rb_intern("WGS84GeoPoint"));
+}

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

@@ -23,9 +23,9 @@ VALUE rb_cGrnHashCursor;
 /*
  * Document-class: Groonga::HashCursor < Groonga::TableCursor
  *
- * Groonga::Hashに登録されているレコードを順番に取り出すため
- * のオブジェクト。利用できるメソッドはGroonga::TableCursor
- * とGroonga::TableCursorKeySupportを参照。
+ * {Groonga::Hash} に登録されているレコードを順番に取り出すため
+ * のオブジェクト。利用できるメソッドは {Groonga::TableCursor}
+ * と {Groonga::TableCursorKeySupport} を参照。
  */
 
 void