whombx
null+****@clear*****
Sat Aug 10 01:37:59 JST 2013
whombx 2013-08-10 01:37:59 +0900 (Sat, 10 Aug 2013) New Revision: dc4c3346ae739cba00694e7df0e7064c77e4c246 https://github.com/groonga/groonga/commit/dc4c3346ae739cba00694e7df0e7064c77e4c246 Merged 5651aa2: Merge pull request #90 from whombx/grn-hook Message: doc: move grn_hook documents from groonga.h to Sphinx text Added files: doc/source/reference/api/grn_hook.txt Modified files: doc/files.am include/groonga.h Modified: doc/files.am (+4 -0) =================================================================== --- doc/files.am 2013-08-09 23:39:17 +0900 (b1a688b) +++ doc/files.am 2013-08-10 01:37:59 +0900 (a88272d) @@ -352,6 +352,7 @@ absolute_source_files = \ $(top_srcdir)/doc/source/reference/api/grn_db.txt \ $(top_srcdir)/doc/source/reference/api/grn_encoding.txt \ $(top_srcdir)/doc/source/reference/api/grn_expr.txt \ + $(top_srcdir)/doc/source/reference/api/grn_hook.txt \ $(top_srcdir)/doc/source/reference/api/grn_index_cursor.txt \ $(top_srcdir)/doc/source/reference/api/grn_info.txt \ $(top_srcdir)/doc/source/reference/api/grn_obj.txt \ @@ -823,6 +824,7 @@ source_files_relative_from_doc_dir = \ source/reference/api/grn_db.txt \ source/reference/api/grn_encoding.txt \ source/reference/api/grn_expr.txt \ + source/reference/api/grn_hook.txt \ source/reference/api/grn_index_cursor.txt \ source/reference/api/grn_info.txt \ source/reference/api/grn_obj.txt \ @@ -1061,6 +1063,7 @@ html_files_relative_from_locale_dir = \ html/_sources/reference/api/grn_db.txt \ html/_sources/reference/api/grn_encoding.txt \ html/_sources/reference/api/grn_expr.txt \ + html/_sources/reference/api/grn_hook.txt \ html/_sources/reference/api/grn_index_cursor.txt \ html/_sources/reference/api/grn_info.txt \ html/_sources/reference/api/grn_obj.txt \ @@ -1232,6 +1235,7 @@ html_files_relative_from_locale_dir = \ html/reference/api/grn_db.html \ html/reference/api/grn_encoding.html \ html/reference/api/grn_expr.html \ + html/reference/api/grn_hook.html \ html/reference/api/grn_index_cursor.html \ html/reference/api/grn_info.html \ html/reference/api/grn_obj.html \ Added: doc/source/reference/api/grn_hook.txt (+67 -0) 100644 =================================================================== --- /dev/null +++ doc/source/reference/api/grn_hook.txt 2013-08-10 01:37:59 +0900 (bdb2f17) @@ -0,0 +1,67 @@ +.. -*- rst -*- + +.. highlightlang:: none + +``grn_hook`` +============ + +Summary +------- + +TODO... + +Example +------- + +TODO... + +Reference +--------- + +.. c:type:: grn_hook_entry + + TODO... + +.. c:function:: grn_rc grn_obj_add_hook(grn_ctx *ctx, grn_obj *obj, grn_hook_entry entry, int offset, grn_obj *proc, grn_obj *data) + + objに対してhookを追加します。 + + :param obj: 対象objectを指定します。 + :param entry: + ``GRN_HOOK_GET`` は、objectの参照時に呼び出されるhookを定義します。 + + ``GRN_HOOK_SET`` は、objectの更新時に呼び出されるhookを定義します。 + + ``GRN_HOOK_SELECT`` は、検索処理の実行中に適時呼び出され、処理の実行状況を調べたり、実行の中断を指示することができます。 + :param offset: + hookの実行順位。offsetに対応するhookの直前に新たなhookを挿入します。 + + 0を指定した場合は先頭に挿入されます。-1を指定した場合は末尾に挿入されます。 + + objectに複数のhookが定義されている場合は順位の順に呼び出されます。 + :param proc: 手続きを指定します。 + :param data: hook固有情報を指定します。 + +.. c:function:: int grn_obj_get_nhooks(grn_ctx *ctx, grn_obj *obj, grn_hook_entry entry) + + objに定義されているhookの数を返します。 + + :param obj: 対象objectを指定します。 + :param entry: hookタイプを指定します。 + +.. c:function:: grn_obj *grn_obj_get_hook(grn_ctx *ctx, grn_obj *obj, grn_hook_entry entry, int offset, grn_obj *data) + + objに定義されているhookの手続き（proc）を返します。hook固有情報が定義されている場合は、その内容をdataにコピーして返します。 + + :param obj: 対象objectを指定します。 + :param entry: hookタイプを指定します。 + :param offset: 実行順位を指定します。 + :param data: hook固有情報格納バッファを指定します。 + +.. c:function:: grn_rc grn_obj_delete_hook(grn_ctx *ctx, grn_obj *obj, grn_hook_entry entry, int offset) + + objに定義されているhookを削除します。 + + :param obj: 対象objectを指定します。 + :param entry: hookタイプを指定します。 + :param offset: 実行順位を指定します。 Modified: include/groonga.h (+0 -43) =================================================================== --- include/groonga.h 2013-08-09 23:39:17 +0900 (d99e79d) +++ include/groonga.h 2013-08-10 01:37:59 +0900 (b15a3fe) @@ -1080,54 +1080,11 @@ typedef enum { GRN_HOOK_SELECT } grn_hook_entry; -/** - * grn_obj_add_hook: - * @obj: 対象object - * @entry: GRN_HOOK_GETは、objectの参照時に呼び出されるhookを定義する。 - GRN_HOOK_SETは、objectの更新時に呼び出されるhookを定義する。 - GRN_HOOK_SELECTは、検索処理の実行中に適時呼び出され、 - 処理の実行状況を調べたり、実行の中断を指示することができる。 - * @offset: hookの実行順位。offsetに対応するhookの直前に新たなhookを挿入する。 - 0を指定した場合は先頭に挿入される。-1を指定した場合は末尾に挿入される。 - objectに複数のhookが定義されている場合は順位の順に呼び出される。 - * @proc: 手続き - * @data: hook固有情報 - * - * objに対してhookを追加する。 - **/ GRN_API grn_rc grn_obj_add_hook(grn_ctx *ctx, grn_obj *obj, grn_hook_entry entry, int offset, grn_obj *proc, grn_obj *data); - -/** - * grn_obj_get_nhooks: - * @obj: 対象object - * @entry: hookタイプ - * - * objに定義されているhookの数を返す。 - **/ GRN_API int grn_obj_get_nhooks(grn_ctx *ctx, grn_obj *obj, grn_hook_entry entry); - -/** - * grn_obj_get_hook: - * @obj: 対象object - * @entry: hookタイプ - * @offset: 実行順位 - * @data: hook固有情報格納バッファ - * - * objに定義されているhookの手続き(proc)を返す。hook固有情報が定義されている場合は、 - * その内容をdataにコピーして返す。 - **/ GRN_API grn_obj *grn_obj_get_hook(grn_ctx *ctx, grn_obj *obj, grn_hook_entry entry, int offset, grn_obj *data); - -/** - * grn_obj_delete_hook: - * @obj: 対象object - * @entry: hookタイプ - * @offset: 実行順位 - * - * objに定義されているhookを削除する。 - **/ GRN_API grn_rc grn_obj_delete_hook(grn_ctx *ctx, grn_obj *obj, grn_hook_entry entry, int offset); GRN_API grn_obj *grn_obj_open(grn_ctx *ctx, unsigned char type, grn_obj_flags flags, grn_id domain); -------------- next part -------------- HTML����������������������������...下载
