Imported Upstream version 6.1.0upstream/6.1.0

1 files changed, 26 insertions, 1 deletions

diff --git a/doc/API.ja b/doc/API.ja
index ac8cc6a..f617a1c 100644
--- a/doc/API.ja
+++ b/doc/API.ja
@@ -1,4 +1,4 @@
-鬼車インターフェース Version 6.0.0   2016/05/06
+鬼車インターフェース Version 6.1.0   2016/08/22
 
 #include <oniguruma.h>
 
@@ -256,6 +256,27 @@
     ONIG_OPTION_POSIX_REGION  region引数をPOSIX APIのregmatch_t[]にする
 
 
+# int onig_scan(regex_t* reg, const UChar* str, const UChar* end,
+                OnigRegion* region, OnigOptionType option,
+                int (*scan_callback)(int, int, OnigRegion*, void*),
+                void* callback_arg)
+
+  正規表現で文字列をスキャンして、マッチングする毎にコールバック関数を呼び出す。
+
+  正常終了: マッチ回数 (0回も含める)
+  エラー:   エラーコード (< 0)
+  中断: コールバック関数が０以外の戻り値を返したとき、その値を戻り値として中断
+
+  引数
+  1 reg:    正規表現オブジェクト
+  2 str:    検索対象文字列
+  3 end:    検索対象文字列の終端アドレス
+  4 region: マッチ領域情報(region)  (NULLも許される)
+  5 option: 検索時オプション
+  6 scan_callback: コールバック関数
+  7 callback_arg:  コールバック関数に渡される付加引数値
+
+
 # OnigRegion* onig_region_new(void)
 
   マッチ領域情報(region)を作成する。
@@ -608,6 +629,10 @@
   2 ranges:  プロパティコードポイント範囲
              (最初の要素は範囲の数)
 
+    [num-of-ranges, 1st-range-start, 1st-range-end, 2nd-range-start... ]
+
+    * この関数を呼んだ後で、rangesを変更/破壊しないこと
+
   正常終了戻り値: ONIG_NORMAL