add description of onig_initialize_match_params()

[onig] / doc / API.ja

diff --git a/doc/API.ja b/doc/API.ja
index cd77f7fd385d0ffe344581d124169bfeb80e3ee5..60f9ec27101c8ba97e09ef0ab69658935c3587af 100644 (file)
--- a/doc/API.ja
+++ b/doc/API.ja
@@ -1,4 +1,4 @@
-鬼車インターフェース Version 6.1.0   2016/08/22
+鬼車インターフェース Version 6.7.2   2018/01/30
 
 #include <oniguruma.h>
 
@@ -82,6 +82,15 @@
 
       ONIG_OPTION_DONT_CAPTURE_GROUP 名前付き捕獲式集合のみ捕獲
       ONIG_OPTION_CAPTURE_GROUP      名前無し捕獲式集合も捕獲
+      ONIG_OPTION_WORD_IS_ASCII      wordがASCIIのみ (\w, \p{Word}, [[:word:]])
+                                     word boundがASCIIのみ (\b)
+      ONIG_OPTION_DIGIT_IS_ASCII     digitがASCIIのみ (\d, \p{Digit}, [[:digit:]])
+      ONIG_OPTION_SPACE_IS_ASCII     spaceがASCIIのみ (\s, \p{Space}, [[:space:]])
+      ONIG_OPTION_POSIX_IS_ASCII     POSIXプロパティがASCIIのみ
+                                     (word, digit, spaceを全て含んでいる)
+                                     (alnum, alpha, blank, cntrl, digit, graph,
+                                      lower, print, punct, space, upper, xdigit,
+                                      word)
 
   5 enc:        文字エンコーディング
 
@@ -130,7 +139,8 @@
       ONIG_SYNTAX_PERL              Perl
       ONIG_SYNTAX_PERL_NG           Perl + 名前付き捕獲式集合
       ONIG_SYNTAX_RUBY              Ruby
-      ONIG_SYNTAX_DEFAULT           default (== Ruby)
+      ONIG_SYNTAX_ONIGURUMA         Oniguruma
+      ONIG_SYNTAX_DEFAULT           default (== ONIG_SYNTAX_ONIGURUMA)
                                     onig_set_default_syntax()
 
       または、ユーザが定義したOnigSyntaxTypeデータのアドレス
@@ -210,6 +220,15 @@
   1 reg: 正規表現オブジェクト
 
 
+# void onig_initialize_match_params(OnigMatchParams* mp)
+
+  マッチパラメタ構造体にデフォルト値をセットする。
+  マッチパラメタは、onig_match_with_params(), onig_search_with_params()で
+  使用される。
+
+  引数
+  1 mp: マッチパラメタアドレス
+
 
 # int onig_search(regex_t* reg, const UChar* str, const UChar* end, const UChar* start,
                    const UChar* range, OnigRegion* region, OnigOptionType option)
@@ -235,6 +254,15 @@
     ONIG_OPTION_POSIX_REGION  region引数をPOSIX APIのregmatch_t[]にする
 
 
+# int onig_search_with_params(regex_t* reg, const UChar* str, const UChar* end,
+                   const UChar* start, const UChar* range, OnigRegion* region,
+                   OnigOptionType option, OnigMatchParams* mp)
+
+  引数
+  1-7:  onig_search()と同じ
+  8 mp: マッチパラメタ値 (match_stack_limit, try_in_match_limit)
+
+
 # int onig_match(regex_t* reg, const UChar* str, const UChar* end, const UChar* at,
                 OnigRegion* region, OnigOptionType option)
 
@@ -256,6 +284,15 @@
     ONIG_OPTION_POSIX_REGION  region引数をPOSIX APIのregmatch_t[]にする
 
 
+# int onig_match_with_params(regex_t* reg, const UChar* str, const UChar* end,
+                             const UChar* at, OnigRegion* region,
+                             OnigOptionType option, OnigMatchParams* mp)
+
+  引数
+  1-6:  onig_match()と同じ
+  7 mp: マッチパラメタ値 (match_stack_limit, try_in_match_limit)
+
+
 # int onig_scan(regex_t* reg, const UChar* str, const UChar* end,
                 OnigRegion* region, OnigOptionType option,
                 int (*scan_callback)(int, int, OnigRegion*, void*),
@@ -619,6 +656,21 @@
   正常終了戻り値: ONIG_NORMAL
 
 
+# unsigned long onig_get_try_in_match_limit(void)
+
+  マッチング関数内でのトライ数の制限値を返す。
+  (デフォルト: 10000000)
+
+  正常終了戻り値: 制限値
+
+
+# int onig_set_try_in_match_limit(unsigned long n)
+
+  マッチング関数内でのトライ数の制限値を指定する。
+
+  正常終了戻り値: ONIG_NORMAL
+
+
 # int onig_unicode_define_user_property(const char* name, OnigCodePoint* ranges))
 
   新しいUnicodeプロパティを定義する。