rroonga 4.0.3-x86-mingw32 → 4.0.4-x86-mingw32

data/vendor/local/share/doc/groonga/en/html/_sources/reference/api/plugin.txt

@@ -17,10 +17,129 @@ tutorial about it.
 Reference
 ---------
 
+.. c:function:: grn_rc GRN_PLUGIN_INIT(grn_ctx *ctx)
+
+.. c:function:: grn_rc GRN_PLUGIN_REGISTER(grn_ctx *ctx)
+
+.. c:function:: grn_rc GRN_PLUGIN_FIN(grn_ctx *ctx)
+
+.. c:macro:: GRN_PLUGIN_MALLOC(ctx, size)
+
+   GRN_PLUGIN_MALLOC() allocates `size` bytes and returns a pointer to the
+   allocated memory space. Note that the memory space is associated with `ctx`.
+
+.. c:macro:: GRN_PLUGIN_REALLOC(ctx, ptr, size)
+
+   GRN_PLUGIN_REALLOC() resizes the memory space pointed to by `ptr` or
+   allocates a new memory space of `size` bytes. GRN_PLUGIN_REALLOC() returns
+   a pointer to the memory space. The contents is unchanged or copied from the
+   old memory space to the new memory space.
+
+.. c:macro:: GRN_PLUGIN_FREE(ctx, ptr)
+
+   GRN_PLUGIN_FREE() frees a memory space allocated by GRN_PLUGIN_MALLOC() or
+   GRN_PLUGIN_REALLOC(). This means that `ptr` must be a pointer returned by
+   GRN_PLUGIN_MALLOC() or GRN_PLUGIN_REALLOC().
+
+.. c:macro:: GRN_PLUGIN_LOG(ctx, level, ...)
+
+   GRN_PLUGIN_LOG() reports a log of `level`. Its error message is generated
+   from the varying number of arguments, in which the first one is the format
+   string and the rest are its arguments. See grn_log_level in "groonga.h" for
+   more details of `level`.
+
+.. c:macro:: GRN_PLUGIN_ERROR(ctx, error_code, ...)
+
+   GRN_PLUGIN_ERROR() reports an error of `error_code`. Its error message is
+   generated from the varying number of arguments, in which the first one is the
+   format string and the rest are its arguments. See grn_rc in "groonga.h" for
+   more details of `error_code`.
+
+.. c:type:: grn_plugin_mutex
+
+   grn_plugin_mutex is available to make a critical section. See the
+   following functions.
+
+.. c:function:: grn_plugin_mutex *grn_plugin_mutex_open(grn_ctx *ctx)
+
+   grn_plugin_mutex_open() returns a pointer to a new object of
+   grn_plugin_mutex. Memory for the new object is obtained with
+   GRN_PLUGIN_MALLOC(). grn_plugin_mutex_open() returns NULL if sufficient
+   memory is not available.
+
+.. c:function:: void grn_plugin_mutex_close(grn_ctx *ctx, grn_plugin_mutex *mutex)
+
+   grn_plugin_mutex_close() finalizes an object of grn_plugin_mutex and then
+   frees memory allocated for that object.
+
+.. c:function:: void grn_plugin_mutex_lock(grn_ctx *ctx, grn_plugin_mutex *mutex)
+
+   grn_plugin_mutex_lock() locks a mutex object. If the object is already
+   locked, the calling thread waits until the object will be unlocked.
+
+.. c:function:: void grn_plugin_mutex_unlock(grn_ctx *ctx, grn_plugin_mutex *mutex)
+
+   grn_plugin_mutex_unlock() unlocks a mutex object. grn_plugin_mutex_unlock()
+   should not be called for an unlocked object.
+
+.. c:function:: grn_obj *grn_plugin_proc_alloc(grn_ctx *ctx, grn_user_data *user_data, grn_id domain, grn_obj_flags flags)
+
+   grn_plugin_proc_alloc() allocates a `grn_obj` object.
+   You can use it in function that is registered as GRN_PROC_FUNCTION.
+
 .. c:function:: grn_obj grn_plugin_proc_get_var(grn_ctx *ctx, grn_user_data *user_data, const char *name, int name_size)
 
-   TODO...
+   It gets a variable value from `grn_user_data` by specifying the variable name.
+
+   :param name: The variable name.
+   :param name_size: The number of bytes of name. If `name_size` is negative, `name` must be NUL-terminated. `name_size` is computed by `strlen(name)` for the case.
+   :return: A variable value on success, NULL otherwise.
+
+.. c:function:: grn_obj *grn_plugin_proc_get_var_by_offset(grn_ctx *ctx, grn_user_data *user_data, unsigned int offset)
+
+   It gets a variable value from `grn_user_data` by specifying the offset position of the variable.
+
+   :param offset: The offset position of the variable.
+   :return: A variable value on success, NULL otherwise.
+
+.. c:function:: const char *grn_plugin_win32_base_dir(void)
+
+   grn_plugin_win32_base_dir() returns the groonga install directory.
+   The install directory is computed from the directory that has
+   `groonga.dll`. You can use the directory to generate install
+   directory aware path.
+   It only works on Windows. It returns `NULL` on other platforms.
+
+.. c:function:: int grn_plugin_charlen(grn_ctx *ctx, const char *str_ptr, unsigned int str_length, grn_encoding encoding)
+
+   grn_plugin_charlen() returns the length (#bytes) of the first character
+   in the string specified by `str_ptr` and `str_length`. If the starting bytes
+   are invalid as a character, grn_plugin_charlen() returns 0. See
+   grn_encoding in "groonga.h" for more details of `encoding`.
+
+.. c:function:: int grn_plugin_isspace(grn_ctx *ctx, const char *str_ptr, unsigned int str_length, grn_encoding encoding)
+
+   grn_plugin_isspace() returns the length (#bytes) of the first character
+   in the string specified by `str_ptr` and `str_length` if it is a space
+   character. Otherwise, grn_plugin_isspace() returns 0.
+
+.. c:function:: grn_rc grn_plugin_expr_var_init(grn_ctx *ctx, grn_expr_var *var, const char *name, int name_size)
+
+   It initializes a `grn_expr_var`.
+
+   :param var: The pointer of `grn_expr_var` object to be initialized.
+   :param name: The name of `grn_expr_var` object to be initialized.
+   :param name_size: The number of bytes of name. If `name_size` is negative, `name` must be NUL-terminated. `name_size` is computed by `strlen(name)` for the case.
+   :return: ``GRN_SUCCESS``. It doesn't fail.
+
+.. c:function:: grn_obj * grn_plugin_command_create(grn_ctx *ctx, const char *name, int name_size, grn_proc_func func, unsigned int n_vars, grn_expr_var *vars)
 
-.. c:function:: grn_obj *grn_plugin_proc_get_var_by_offset(grn_ctx *ctx, grn_user_data *user_data, unsigned int offset);
+   It creates a command.
 
-   TODO...
+   :param name: The `proc` name of the command to be created.
+   :param name_size: The number of bytes of name. If `name_size` is negative, `name` must be NUL-terminated. `name_size` is computed by `strlen(name)` for the case.
+   :param func: The function name to be called by the created command.
+   :param n_vars: The number of the variables of the command to create.
+   :param vars:  The pointer of initialized `grn_expr_var` object.
+   :return: The created command object if it creates a command successfully,
+            `NULL` otherwise. See `ctx` for error details.

data/vendor/local/share/doc/groonga/en/html/_sources/reference/columns/vector.txt

@@ -199,7 +199,6 @@ Here are limitations:
   * You need to use string representation for element value on load.
     For example, you can't use ``29`` for number 29. You need to use
     ``"29"`` for number 29.
-  * You can't use reference type.
 
 How to create
 """""""""""""

data/vendor/local/share/doc/groonga/en/html/_sources/reference/commands/check.txt

@@ -2,39 +2,72 @@
 
 .. highlightlang:: none
 
-check
-=====
+``check``
+=========
 
-名前
-----
+Summary
+-------
 
 check - オブジェクトの状態表示
 
-書式
-----
+Groonga組込コマンドの一つであるcheckについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+
+checkコマンドは、groongaプロセス内の指定したオブジェクトの状態を表示します。主にデータベースが壊れた場合など異常時の問題解決のために使用することを想定しています。デバッグ用のため、返値のフォーマットが安定しているということは保証されません。（フォーマットが変更される可能性が高い）
+
+Syntax
+------
 ::
 
  check obj
 
-説明
-----
+Usage
+-----
 
-Groonga組込コマンドの一つであるcheckについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+テーブルTermsのインデックスカラムnameの状態を表示します。::
 
-checkコマンドは、groongaプロセス内の指定したオブジェクトの状態を表示します。主にデータベースが壊れた場合など異常時の問題解決のために使用することを想定しています。デバッグ用のため、返値のフォーマットが安定しているということは保証されません。（フォーマットが変更される可能性が高い）
+ check Terms.name
+ [{"flags":"00008202",
+   "max sid":1,
+   "number of garbage segments":0,
+   "number of array segments":1,
+   "max id of array segment":1,
+   "number of buffer segments":110,
+   "max id of buffer segment":111,
+   "max id of physical segment in use":111,
+   "number of unmanaged segments":4294967185,
+   "total chunk size":7470239,
+   "max id of chunk segments in use":127,
+   "number of garbage chunk":[0,0,0,0,0,0,0,0,2,2,0,0,0,0,0]},
+  {"buffer id":0,
+   "chunk size":94392,
+   "buffer term":["596","59777","6",...],
+   "buffer free":152944,
+   "size in buffer":7361,
+   "nterms":237,
+   "nterms with chunk":216,
+   "buffer id":1,
+   "chunk size":71236,
+   "buffer term":[["に述",18149,18149,2,25,6,6],
+                  ["に追",4505,4505,76,485,136,174],
+                  ["に退",26568,26568,2,9,2,2],
+                  ...],
+   "buffer free":120000,
+   "size in buffer":11155,
+   "nterms":121,
+   "nterms with chunk":116},
+   {"buffer id":1,
+    ...},
+   ...]
 
-引数
-----
+Parameters
+----------
 
 ``obj``
 
   状態を表示するオブジェクトの名前を指定します。
 
-返値
-----
-
-json形式
-^^^^^^^^
+Return value
+------------
 
 チェックするオブジェクトにより返される値が変わります。
 
@@ -126,41 +159,3 @@ json形式
 
     バッファ内にある語のうち、チャンクを使っている語の数です。
 
-例
---
-
-テーブルTermsのインデックスカラムnameの状態を表示します。::
-
- check Terms.name
- [{"flags":"00008202",
-   "max sid":1,
-   "number of garbage segments":0,
-   "number of array segments":1,
-   "max id of array segment":1,
-   "number of buffer segments":110,
-   "max id of buffer segment":111,
-   "max id of physical segment in use":111,
-   "number of unmanaged segments":4294967185,
-   "total chunk size":7470239,
-   "max id of chunk segments in use":127,
-   "number of garbage chunk":[0,0,0,0,0,0,0,0,2,2,0,0,0,0,0]},
-  {"buffer id":0,
-   "chunk size":94392,
-   "buffer term":["596","59777","6",...],
-   "buffer free":152944,
-   "size in buffer":7361,
-   "nterms":237,
-   "nterms with chunk":216,
-   "buffer id":1,
-   "chunk size":71236,
-   "buffer term":[["に述",18149,18149,2,25,6,6],
-                  ["に追",4505,4505,76,485,136,174],
-                  ["に退",26568,26568,2,9,2,2],
-                  ...],
-   "buffer free":120000,
-   "size in buffer":11155,
-   "nterms":121,
-   "nterms with chunk":116},
-   {"buffer id":1,
-    ...},
-   ...]

data/vendor/local/share/doc/groonga/en/html/_sources/reference/commands/clearlock.txt

@@ -2,39 +2,46 @@
 
 .. highlightlang:: none
 
-clearlock
-=========
+``clearlock``
+=============
 
-名前
-----
+Summary
+-------
 
 clearlock - オブジェクトにセットされたロックを解除する
 
-書式
-----
+Groonga組込コマンドの一つであるclearlockについて説明します。組込コマンドは、groonga実行ファイルの引数、標準>入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+
+clearlockは、対象となるオブジェクト(データベース,テーブル,インデックス等)を指定し、オブジェクトにかけられた>ロックを再帰的に解除します。
+
+Syntax
+------
 ::
 
  clearlock objname
 
-説明
-----
+Usage
+-----
 
-Groonga組込コマンドの一つであるclearlockについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+開いているデータベースのロックをすべて解除する::
 
-clearlockは、対象となるオブジェクト(データベース,テーブル,インデックス等)を指定し、オブジェクトにかけられたロックを再帰的に解除します。
+ clearlock
+ [true]
 
-引数
-----
+テーブル名 Entry のカラム body のロックを解除する::
+
+ clearlock Entry.body
+ [true]
+
+Parameters
+----------
 
 ``objname``
 
   対象となるオブジェクト名を指定します。空の場合、開いているdbオブジェクトが対象となります。
 
-返値
-----
-
-json形式
-^^^^^^^^
+Return value
+------------
 
 ::
 
@@ -44,20 +51,7 @@ json形式
 
   エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
 
-例
---
-
-開いているデータベースのロックをすべて解除する::
-
- clearlock
- [true]
-
-テーブル名 Entry のカラム body のロックを解除する::
-
- clearlock Entry.body
- [true]
-
-関連項目
+See also
 --------
 
 :doc:`load`

data/vendor/local/share/doc/groonga/en/html/_sources/reference/commands/column_remove.txt

@@ -2,42 +2,50 @@
 
 .. highlightlang:: none
 
-column_remove
-=============
+``column_remove``
+=================
 
-名前
-----
+Summary
+-------
 
 column_remove - テーブルに定義されているカラムの削除
 
-書式
-----
+Groonga組込コマンドの一つであるcolumn_removeについて説明します。組込コマンドは、groonga実行ファイルの引数、>標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+
+column_removeはテーブルに定義されているカラムを削除します。
+また、付随するインデックスも削除されます。[#]_
+
+Syntax
+------
 ::
 
  column_remove table name
 
-説明
-----
+Usage
+-----
+::
 
-Groonga組込コマンドの一つであるcolumn_removeについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+ column_remove Entry body
 
-column_removeはテーブルに定義されているカラムを削除します。
-また、付随するインデックスも削除されます。[#]_
+ [true]
+
+.. rubric:: 脚注
+
+.. [#] マルチセクションインデックスの一部である場合も、インデックスが削除されます。
 
-引数
-----
+Parameters
+----------
 
 ``table``
+
   削除対象のカラムが定義されているテーブルの名前を指定します。
 
 ``name``
-  削除対象のカラム名を指定します。
 
-返値
-----
+  削除対象のカラム名を指定します。
 
-json形式
-^^^^^^^^
+Return value
+------------
 
 ::
 
@@ -47,14 +55,3 @@ json形式
 
    エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
 
-例
---
-::
-
- column_remove Entry body
-
- [true]
-
-.. rubric:: 脚注
-
-.. [#] マルチセクションインデックスの一部である場合も、インデックスが削除されます。

data/vendor/local/share/doc/groonga/en/html/_sources/reference/commands/define_selector.txt

@@ -2,31 +2,36 @@
 
 .. highlightlang:: none
 
-define_selector
-===============
+``define_selector``
+===================
 
-名前
-----
+Summary
+-------
 
 define_selector - 検索コマンドを定義
 
-書式
-----
+Groonga組込コマンドの一つであるdefine_selectorについて説明します。組込コマンドは、groonga実行ファイルの引数>、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+
+define_selectorは、検索条件をカスタマイズした新たな検索コマンドを定義します。
+
+Syntax
+------
 ::
 
  define_selector name table [match_columns [query [filter [scorer [sortby
                  [output_columns [offset [limit [drilldown [drilldown_sortby
                  [drilldown_output_columns [drilldown_offset [drilldown_limit]]]]]]]]]]]]]
 
-説明
-----
+Usage
+-----
 
-Groonga組込コマンドの一つであるdefine_selectorについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+テーブルEntryの全レコード・全カラムの値を出力するselectorコマンドを定義します。::
 
-define_selectorは、検索条件をカスタマイズした新たな検索コマンドを定義します。
+ define_selector entry_selector Entry
+ [true]
 
-引数
-----
+Parameters
+----------
 
 ``name``
 
@@ -88,11 +93,8 @@ define_selectorは、検索条件をカスタマイズした新たな検索コ
 
   追加するselectorコマンドのdrilldown_limit引数のデフォルト値を指定します。
 
-返値
-----
-
-json形式
-^^^^^^^^
+Return value
+------------
 
 ::
 
@@ -102,15 +104,7 @@ json形式
 
   エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
 
-例
---
-
-テーブルEntryの全レコード・全カラムの値を出力するselectorコマンドを定義します。::
-
- define_selector entry_selector Entry
- [true]
-
-関連項目
+See also
 --------
 
 :doc:`/reference/grn_expr`