add descriptions about regset API

diff --git a/doc/API b/doc/API
index 0b0da54b3075ba0c5128a84466051f810a39fa95..3de3c0fbb3bc8c2cc814fd165e866762ceeb1457 100644 (file)
--- a/doc/API
+++ b/doc/API
@@ -1,4 +1,4 @@
-Oniguruma API  Version 6.9.3  2019/07/06
+Oniguruma API  Version 6.9.4  2019/09/24
 
 #include <oniguruma.h>
 
@@ -306,6 +306,7 @@ Oniguruma API  Version 6.9.3  2019/07/06
 
   normal return: match position offset (i.e.  p - str >= 0)
   not found:     ONIG_MISMATCH (< 0)
+  error:         error code    (< 0)
 
   arguments
   1 reg:    regex object
@@ -342,7 +343,8 @@ Oniguruma API  Version 6.9.3  2019/07/06
   Do not pass invalid byte string in the regex character encoding.
 
   normal return: match length  (>= 0)
-  not match:     ONIG_MISMATCH ( < 0)
+  not match:     ONIG_MISMATCH (< 0)
+  error:         error code    (< 0)
 
   arguments
   1 reg:    regex object
@@ -391,6 +393,91 @@ Oniguruma API  Version 6.9.3  2019/07/06
   7 callback_arg:  optional argument passed to callback
 
 
+# int onig_regset_new(OnigRegSet** rset, int n, regex_t* regs[])
+
+  Create a regset object.
+
+  arguments
+  1 rset: return address of regset object
+  2 n:    number of regex in regs
+  3 regs: array of regex
+
+  normal return: ONIG_NORMAL
+
+
+# int onig_regset_add(OnigRegSet* set, regex_t* reg)
+
+  Add a regex into regset.
+
+  arguments
+  1 set: regset object
+  2 reg: regex object
+
+  normal return: ONIG_NORMAL
+
+
+# void onig_regset_free(OnigRegSet* set)
+
+  Free memory used by regset object and regex objects in the regset.
+
+  arguments
+  1 set: regset object
+
+
+# OnigRegion* onig_regset_get_region(OnigRegSet* set, int at)
+
+  Returns the region object corresponding to the at-th regex.
+
+  arguments
+  1 set: regset object
+  2 at:  index of regex array (zero origin)
+
+
+# int onig_regset_search(OnigRegSet* set, const OnigUChar* str, const OnigUChar* end, const OnigUChar* start, const OnigUChar* range, OnigRegSetLead lead, OnigOptionType option, int* rmatch_pos)
+
+  Perform a search with regset.
+
+  return value:
+    normal return: index of match regex (zero origin)
+    not found:     ONIG_MISMATCH (< 0)
+    error:         error code    (< 0)
+
+  arguments
+  1 set:    regset object
+  2 str:    target string
+  3 end:    terminate address of target string
+  4 start:  search start address of target string
+  5 range:  search terminate address of target string
+  6 lead:   outer loop element (ONIG_REGSET_POSITION_LEAD or ONIG_REGSET_REGEX_LEAD)
+  7 option: search time option
+      ONIG_OPTION_NOTBOL    string head(str) isn't considered as begin of line
+      ONIG_OPTION_NOTEOL    string end (end) isn't considered as end of line
+  8 rmatch_pos: return address of match position (match_address - str)
+
+
+# int onig_regset_search_with_param(OnigRegSet* set, const OnigUChar* str, const OnigUChar* end, const OnigUChar* start, const OnigUChar* range,  OnigRegSetLead lead, OnigOptionType option, OnigMatchParam* mps[], int* rmatch_pos)
+
+  Perform a search with regset and match-params.
+
+  return value:
+    normal return: index of match regex (zero origin)
+    not found:     ONIG_MISMATCH (< 0)
+    error:         error code    (< 0)
+
+  arguments
+  1 set:    regset object
+  2 str:    target string
+  3 end:    terminate address of target string
+  4 start:  search start address of target string
+  5 range:  search terminate address of target string
+  6 lead:   outer loop element (ONIG_REGSET_POSITION_LEAD or ONIG_REGSET_REGEX_LEAD)
+  7 option: search time option
+      ONIG_OPTION_NOTBOL    string head(str) isn't considered as begin of line
+      ONIG_OPTION_NOTEOL    string end (end) isn't considered as end of line
+  8 mps:    array of match-params
+  9 rmatch_pos: return address of match position (match_address - str)
+
+
 # OnigRegion* onig_region_new(void)
 
   Create a region.

diff --git a/doc/API.ja b/doc/API.ja
index 5871558e9c9de9d8ac04a43c8d76aa2a3cd293f9..5622a2a959fb1fbfcc36d731efd5f0825b065e25 100644 (file)
--- a/doc/API.ja
+++ b/doc/API.ja
@@ -1,4 +1,4 @@
-鬼車インターフェース Version 6.9.3   2019/07/06
+鬼車インターフェース Version 6.9.4   2019/09/24
 
 #include <oniguruma.h>
 
@@ -390,6 +390,93 @@
   7 callback_arg:  コールバック関数に渡される付加引数値
 
 
+# int onig_regset_new(OnigRegSet** rset, int n, regex_t* regs[])
+
+  regsetオブジェクトを生成する。
+
+  引数
+  1 rset: regsetオブジェクトを返すためのアドレス
+  2 n:    正規表現の個数
+  3 regs: 正規表現オブジェクトの配列
+
+  正常終了戻り値: ONIG_NORMAL
+
+
+# int onig_regset_add(OnigRegSet* set, regex_t* reg)
+
+  regsetオブジェクトに正規表現を追加する。
+
+  引数
+  1 set: regsetオブジェクト
+  2 reg: 正規表現オブジェクト
+
+  正常終了戻り値: ONIG_NORMAL
+
+
+# void onig_regset_free(OnigRegSet* set)
+
+  regsetオブジェクトとその中の正規表現オブジェクトの使用メモリを開放する。
+
+  引数
+  1 set: regsetオブジェクト
+
+
+# OnigRegion* onig_regset_get_region(OnigRegSet* set, int at)
+
+  regsetのat番目の正規表現に対応する領域を返す。
+
+  引数
+  1 set: regsetオブジェクト
+  2 at:  正規表現オブジェクトのインデックス (ゼロ開始)
+
+
+# int onig_regset_search(OnigRegSet* set, const OnigUChar* str, const OnigUChar* end, const OnigUChar* start, const OnigUChar* range, OnigRegSetLead lead, OnigOptionType option, int* rmatch_pos)
+
+  regsetによる検索を実行する。
+
+  戻り値:
+    検索成功: マッチした正規表現オブジェクトのインデックス (ゼロ開始)
+    検索失敗: ONIG_MISMATCH (< 0)
+    エラー:   エラーコード   (< 0)
+
+  引数
+  1 set:    regsetオブジェクト
+  2 str:    検索対象文字列
+  3 end:    検索対象文字列の終端アドレス
+  4 start:  検索対象文字列の検索先頭位置アドレス
+  5 range:  検索対象文字列の検索終了位置アドレス
+            (start <= 探索される文字列 < range)
+  6 lead:   外側のループ要素 (ONIG_REGSET_POSITION_LEAD or ONIG_REGSET_REGEX_LEAD)
+  7 option: 検索時オプション
+    ONIG_OPTION_NOTBOL        文字列の先頭(str)を行頭と看做さない
+    ONIG_OPTION_NOTEOL        文字列の終端(end)を行末と看做さない
+  8 rmatch_pos: マッチした位置を返すためのアドレス (match_address - str)
+
+
+# int onig_regset_search_with_param(OnigRegSet* set, const OnigUChar* str, const OnigUChar* end, const OnigUChar* start, const OnigUChar* range,  OnigRegSetLead lead, OnigOptionType option, OnigMatchParam* mps[], int* rmatch_pos)
+
+  regsetとOnigMatchParamオブジェクトによる検索を実行する。
+
+  戻り値:
+    検索成功: マッチした正規表現オブジェクトのインデックス (ゼロ開始)
+    検索失敗: ONIG_MISMATCH (< 0)
+    エラー:   エラーコード   (< 0)
+
+  引数
+  1 set:    regsetオブジェクト
+  2 str:    検索対象文字列
+  3 end:    検索対象文字列の終端アドレス
+  4 start:  検索対象文字列の検索先頭位置アドレス
+  5 range:  検索対象文字列の検索終了位置アドレス
+            (start <= 探索される文字列 < range)
+  6 lead:   外側のループ要素 (ONIG_REGSET_POSITION_LEAD or ONIG_REGSET_REGEX_LEAD)
+  7 option: 検索時オプション
+    ONIG_OPTION_NOTBOL        文字列の先頭(str)を行頭と看做さない
+    ONIG_OPTION_NOTEOL        文字列の終端(end)を行末と看做さない
+  8 mps:    OnigMatchParamオブジェクトの配列
+  9 rmatch_pos: マッチした位置を返すためのアドレス (match_address - str)
+
+
 # OnigRegion* onig_region_new(void)
 
   マッチ領域情報(region)を作成する。