From 98f7065a3f7b386564840bb5b24b94f9335b2e97 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Frings-F=C3=BCrst?= Date: Mon, 26 Apr 2021 17:40:17 +0200 Subject: New upstream version 6.9.7.1 --- doc/API.ja | 169 +++++++++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 121 insertions(+), 48 deletions(-) (limited to 'doc/API.ja') diff --git a/doc/API.ja b/doc/API.ja index 283bea3..21dc527 100644 --- a/doc/API.ja +++ b/doc/API.ja @@ -1,4 +1,4 @@ -鬼車インターフェース Version 6.9.6 2020/07/12 +鬼車インターフェース Version 6.9.7 2021/03/16 #include @@ -14,6 +14,10 @@ 1 use_encodings: 使用する文字エンコーディングの配列 2 num_encodings: 文字エンコーディングの数 + 戻り値 + 正常終了: ONIG_NORMAL == 0 + エラー時: エラーコード < 0 + # int onig_error_code_to_str(UChar* err_buf, int err_code, ...) @@ -22,7 +26,8 @@ この関数を、onig_new()の結果に対して呼び出す場合には、onig_new()のpattern引数を メモリ解放するよりも前に呼び出さなければならない。 - 正常終了戻り値: エラーメッセージ文字列のバイト長 + 戻り値 + 正常終了: エラーメッセージ文字列のバイト長 引数 1 err_buf: エラーメッセージを格納する領域 @@ -60,7 +65,9 @@ 正規表現オブジェクト(regex)を作成する。 - 正常終了戻り値: ONIG_NORMAL + 戻り値 + 正常終了: ONIG_NORMAL == 0 + エラー時: エラーコード < 0 引数 1 reg: 作成された正規表現オブジェクトを返すアドレス @@ -75,13 +82,11 @@ ONIG_OPTION_EXTEND パターン拡張形式 ONIG_OPTION_FIND_LONGEST 最長マッチ ONIG_OPTION_FIND_NOT_EMPTY 空マッチを無視 - ONIG_OPTION_NEGATE_SINGLELINE - ONIG_SYNTAX_POSIX_BASIC, ONIG_SYNTAX_POSIX_EXTENDED, - ONIG_SYNTAX_PERL, ONIG_SYNTAX_PERL_NG, ONIG_SYNTAX_JAVAで - デフォルトで有効なONIG_OPTION_SINGLELINEをクリアする。 + ONIG_OPTION_NEGATE_SINGLELINE ONIG_SYNTAX_POSIX_BASIC/POSIX_EXTENDED/PERL/PERL_NG/PYTHON/JAVAでデフォルトで有効なONIG_OPTION_SINGLELINEをクリアする。 ONIG_OPTION_DONT_CAPTURE_GROUP 名前付き捕獲式集合のみ捕獲 ONIG_OPTION_CAPTURE_GROUP 名前無し捕獲式集合も捕獲 + ONIG_OPTION_IGNORECASE_IS_ASCII IGNORECASE((?i))をASCII文字の範囲に制限する 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:]]) @@ -142,6 +147,7 @@ ONIG_SYNTAX_JAVA Java (Sun java.util.regex) ONIG_SYNTAX_PERL Perl ONIG_SYNTAX_PERL_NG Perl + 名前付き捕獲式集合 + ONIG_SYNTAX_PYTHON Python ONIG_SYNTAX_ONIGURUMA Oniguruma ONIG_SYNTAX_DEFAULT default (== ONIG_SYNTAX_ONIGURUMA) onig_set_default_syntax() @@ -161,20 +167,24 @@ 正規表現オブジェクト(regex)を作成する。 regの領域を内部で割り当てない。 - 正常終了戻り値: ONIG_NORMAL + 戻り値 + 正常終了: ONIG_NORMAL == 0 + エラー時: エラーコード < 0 # int onig_new_deluxe(regex_t** reg, const UChar* pattern, const UChar* pattern_end, OnigCompileInfo* ci, OnigErrorInfo* einfo) - この関数は廃止予定。 + この関数は廃止(使用不可)。 パターンと対象文字列の文字エンコーディングが異なる場合を許さなくなった。 正規表現オブジェクト(regex)を作成する。 この関数は、onig_new()のデラックス版。 - 正常終了戻り値: ONIG_NORMAL + 戻り値 + 正常終了: ONIG_NORMAL == 0 + エラー時: エラーコード < 0 引数 1 reg: 作成された正規表現オブジェクトを返すアドレス @@ -316,8 +326,11 @@ 正規表現で文字列を検索し、検索結果とマッチ領域を返す。 正規表現オブジェクトの文字エンコーディングで、検索文字列として不正な文字列を渡してはいけない。 - 正常終了戻り値: マッチ位置 (p - str >= 0) - 検索失敗: ONIG_MISMATCH (< 0) + 戻り値 + 正常終了: マッチ位置 (p - str >= 0) + 検索失敗: ONIG_MISMATCH (< 0) + + * 若しONIG_OPTION_CALLBACK_EACH_MATCHが使用されると、マッチするものがあってもONIG_MISMATCHが返される。 引数 1 reg: 正規表現オブジェクト @@ -330,12 +343,24 @@ 6 region: マッチ領域情報(region) (NULLも許される) 7 option: 検索時オプション - ONIG_OPTION_NOTBOL strを行頭および文字列先頭と看做さない + ONIG_OPTION_NOTBOL strの先頭を行頭および文字列先頭と看做さない ONIG_OPTION_NOTEOL endを行末および文字列終端と看做さない - ONIG_OPTION_NOT_BEGIN_STRING strを文字列の先頭と看做さない (\A 失敗) - ONIG_OPTION_NOT_END_STRING end文字列終端と看做さない (\z, \Z 失敗) + ONIG_OPTION_NOT_BEGIN_STRING strの先頭を文字列の先頭と看做さない (\A 失敗) + ONIG_OPTION_NOT_END_STRING endを文字列終端と看做さない (\z, \Z 失敗) ONIG_OPTION_NOT_BEGIN_POSITION startを検索開始位置と看做さない (\G 失敗) + ONIG_OPTION_CALLBACK_EACH_MATCH + 全てのマッチ成功に対してコールバック関数が呼び出される。 + (マッチ開始位置が同じものも含めて) + ある位置でマッチするものが見つかっても探索が止まることはない。 + 呼び出されるコールバック関数は、onig_set_callback_each_match()で与える。 + コールバック関数に渡される引数の中のuser_dataは、 + onig_set_callout_user_data_of_match_param(mp, user_data)で指定する。 + このため、user_dataを指定したい場合には、onig_search()ではなく、 + onig_search_with_param()を使用することになる。 + onig_set_callout_user_data_of_match_param()で指定するuser_dataは、 + calloutで使用されるuser_dataと共用される。 + # int onig_search_with_param(regex_t* reg, const UChar* str, const UChar* end, const UChar* start, const UChar* range, OnigRegion* region, @@ -355,8 +380,11 @@ 文字列の指定位置でマッチングを行い、結果とマッチ領域を返す。 正規表現オブジェクトの文字エンコーディングで、検索文字列として不正な文字列を渡してはいけない。 - 正常終了戻り値: マッチしたバイト長 (>= 0) - not match: ONIG_MISMATCH ( < 0) + 戻り値 + 正常終了: マッチしたバイト長 (>= 0) + not match: ONIG_MISMATCH ( < 0) + + * 若しONIG_OPTION_CALLBACK_EACH_MATCHが使用されると、マッチするものがあってもONIG_MISMATCHが返される。 引数 1 reg: 正規表現オブジェクト @@ -366,11 +394,12 @@ 5 region: マッチ領域情報(region) (NULLも許される) 6 option: 検索時オプション - ONIG_OPTION_NOTBOL strを行頭および文字列先頭と看做さない + ONIG_OPTION_NOTBOL strの先頭を行頭および文字列先頭と看做さない ONIG_OPTION_NOTEOL endを行末および文字列終端と看做さない - ONIG_OPTION_NOT_BEGIN_STRING strを文字列の先頭と看做さない (\A 失敗) - ONIG_OPTION_NOT_END_STRING end文字列終端と看做さない (\z, \Z 失敗) - ONIG_OPTION_NOT_BEGIN_POSITION atを検索開始位置と看做さない (\G 失敗) + ONIG_OPTION_NOT_BEGIN_STRING strの先頭を文字列の先頭と看做さない (\A 失敗) + ONIG_OPTION_NOT_END_STRING endを文字列終端と看做さない (\z, \Z 失敗) + ONIG_OPTION_NOT_BEGIN_POSITION startを検索開始位置と看做さない (\G 失敗) + ONIG_OPTION_CALLBACK_EACH_MATCH 全てのマッチ成功に対してコールバック関数が呼び出される。 # int onig_match_with_param(regex_t* reg, const UChar* str, const UChar* end, @@ -393,6 +422,7 @@ 正規表現で文字列をスキャンして、マッチングする毎にコールバック関数を呼び出す。 正規表現オブジェクトの文字エンコーディングで、検索文字列として不正な文字列を渡してはいけない。 + 戻り値 正常終了: マッチ回数 (0回も含める) エラー: エラーコード (< 0) 中断: コールバック関数が０以外の戻り値を返したとき、その値を戻り値として中断 @@ -418,7 +448,9 @@ 2 n: 正規表現の個数 3 regs: 正規表現オブジェクトの配列 - 正常終了戻り値: ONIG_NORMAL + 戻り値 + 正常終了: ONIG_NORMAL == 0 + エラー時: エラーコード < 0 # int onig_regset_add(OnigRegSet* set, regex_t* reg) @@ -431,7 +463,9 @@ 1 set: regsetオブジェクト 2 reg: 正規表現オブジェクト - 正常終了戻り値: ONIG_NORMAL + 戻り値 + 正常終了: ONIG_NORMAL == 0 + エラー時: エラーコード < 0 # int onig_regset_replace(OnigRegSet* set, int at, regex_t* reg) @@ -444,7 +478,9 @@ 2 at: 変更する場所のインデックス 2 reg: 正規表現オブジェクト - 正常終了戻り値: ONIG_NORMAL + 戻り値 + 正常終了: ONIG_NORMAL == 0 + エラー時: エラーコード < 0 # void onig_regset_free(OnigRegSet* set) @@ -486,10 +522,10 @@ regsetによる検索を実行する。 - 戻り値: - 検索成功: マッチした正規表現オブジェクトのインデックス (ゼロ開始) - 検索失敗: ONIG_MISMATCH (< 0) - エラー: エラーコード (< 0) + 戻り値 + 検索成功: マッチした正規表現オブジェクトのインデックス (ゼロ開始) + 検索失敗: ONIG_MISMATCH (< 0) + エラー: エラーコード (< 0) 引数 1 set: regsetオブジェクト @@ -503,10 +539,10 @@ ONIG_REGSET_REGEX_LEAD (最左位置でマッチした結果を返す) ONIG_REGSET_PRIORITY_TO_REGEX_ORDER (最初にマッチした正規表現の結果を返す) 7 option: 検索時オプション - ONIG_OPTION_NOTBOL strを行頭および文字列先頭と看做さない + ONIG_OPTION_NOTBOL strの先頭を行頭および文字列先頭と看做さない ONIG_OPTION_NOTEOL endを行末および文字列終端と看做さない - ONIG_OPTION_NOT_BEGIN_STRING strを文字列の先頭と看做さない (\A 失敗) - ONIG_OPTION_NOT_END_STRING end文字列終端と看做さない (\z, \Z 失敗) + ONIG_OPTION_NOT_BEGIN_STRING strの先頭を文字列の先頭と看做さない (\A 失敗) + ONIG_OPTION_NOT_END_STRING endを文字列終端と看做さない (\z, \Z 失敗) ONIG_OPTION_NOT_BEGIN_POSITION startを検索開始位置と看做さない (\G 失敗) 8 rmatch_pos: マッチした位置を返すためのアドレス (match_address - str) @@ -519,10 +555,10 @@ regsetとOnigMatchParamオブジェクトによる検索を実行する。 - 戻り値: - 検索成功: マッチした正規表現オブジェクトのインデックス (ゼロ開始) - 検索失敗: ONIG_MISMATCH (< 0) - エラー: エラーコード (< 0) + 戻り値 + 検索成功: マッチした正規表現オブジェクトのインデックス (ゼロ開始) + 検索失敗: ONIG_MISMATCH (< 0) + エラー: エラーコード (< 0) 引数 1 set: regsetオブジェクト @@ -536,10 +572,10 @@ ONIG_REGSET_REGEX_LEAD (最左位置でマッチした結果を返す) ONIG_REGSET_PRIORITY_TO_REGEX_ORDER (最初にマッチした正規表現の結果を返す) 7 option: 検索時オプション - ONIG_OPTION_NOTBOL strを行頭および文字列先頭と看做さない + ONIG_OPTION_NOTBOL strの先頭を行頭および文字列先頭と看做さない ONIG_OPTION_NOTEOL endを行末および文字列終端と看做さない - ONIG_OPTION_NOT_BEGIN_STRING strを文字列の先頭と看做さない (\A 失敗) - ONIG_OPTION_NOT_END_STRING end文字列終端と看做さない (\z, \Z 失敗) + ONIG_OPTION_NOT_BEGIN_STRING strの先頭を文字列の先頭と看做さない (\A 失敗) + ONIG_OPTION_NOT_END_STRING endを文字列終端と看做さない (\z, \Z 失敗) ONIG_OPTION_NOT_BEGIN_POSITION startを検索開始位置と看做さない (\G 失敗) 8 mps: OnigMatchParamオブジェクトの配列 9 rmatch_pos: マッチした位置を返すためのアドレス (match_address - str) @@ -580,7 +616,9 @@ マッチ領域情報(region)の捕獲式集合(グループ)数を変更する。 - 正常終了戻り値: ONIG_NORMAL + 戻り値 + 正常終了: ONIG_NORMAL == 0 + エラー時: エラーコード < 0 引数 1 region: 対象領域 @@ -594,8 +632,9 @@ グループ番号リストを返す。 名前付き捕獲式集合は、(?....)によって定義できる。 - 正常終了戻り値: 指定された名前に対するグループ数 - (例 /(?..)(?..)/ ==> 2) + 戻り値 + 正常終了: 指定された名前に対するグループ数 + (例 /(?..)(?..)/ ==> 2) 名前に対するグループが存在しない: -1 引数 @@ -613,7 +652,9 @@ 名前に対する捕獲式集合が一個しかないときには、対応するマッチ領域が有効か どうかに関係なく、その番号を返す。(従って、regionにはNULLを渡してもよい。) - 正常終了戻り値: 番号 + 戻り値 + 正常終了: 番号 + エラー時: エラーコード < 0 引数 1 reg: 正規表現オブジェクト @@ -628,8 +669,9 @@ 全ての名前に対してコールバック関数呼び出しを実行する。 - 正常終了戻り値: 0 - エラー: コールバック関数の戻り値 + 戻り値 + 正常終了: ONIG_NORMAL == 0 + エラー時: コールバック関数の戻り値 引数 1 reg: 正規表現オブジェクト @@ -654,7 +696,6 @@ # OnigEncoding onig_get_encoding(regex_t* reg) # OnigOptionType onig_get_options(regex_t* reg) -# OnigCaseFoldType onig_get_case_fold_flag(regex_t* reg) # OnigSyntaxType* onig_get_syntax(regex_t* reg) 正規表現オブジェクトに対して、対応する値を返す。 @@ -663,6 +704,15 @@ 1 reg: 正規表現オブジェクト +# OnigCaseFoldType onig_get_case_fold_flag(regex_t* reg) + + 正規表現オブジェクトに対して、case_fold_flag値を返す。 + この関数は廃止予定(非推奨)。 + + 引数 + 1 reg: 正規表現オブジェクト + + # int onig_number_of_captures(regex_t* reg) パターン中で定義された捕獲グループの数を返す。 @@ -671,6 +721,23 @@ 1 reg: 正規表現オブジェクト +# OnigCallbackEachMatchFunc onig_get_callback_each_match(void) + + ONIG_OPTION_CALLBACK_EACH_MATCHに対する現在のコールバック関数を返す。 + + +# int onig_set_callback_each_match(OnigCallbackEachMatchFunc func) + + ONIG_OPTION_CALLBACK_EACH_MATCHに対するコールバック関数をセットする。 + 若しNULLがセットされると、コールバックは実行されない。 + + 戻り値 + 正常終了: ONIG_NORMAL == 0 + + 引数 + 1 func: コールバック関数 + + # int onig_number_of_capture_histories(regex_t* reg) パターン中で定義された捕獲履歴(?@...)の数を返す。 @@ -697,8 +764,9 @@ 捕獲履歴データ木を巡回してコールバックする。 - 正常終了戻り値: 0 - エラー: コールバック関数の戻り値 + 戻り値 + 正常終了: ONIG_NORMAL == 0 + エラー時: コールバック関数の戻り値 引数 1 region: マッチ領域 @@ -733,6 +801,7 @@ 名前なし式集合の捕獲機能が有効かどうかを返す。 + 戻り値 有効: 1 無効: 0 @@ -869,11 +938,13 @@ # OnigCaseFoldType onig_get_default_case_fold_flag() デフォルトのcase foldフラグを取得する。 + この関数は廃止予定(非推奨)。 # int onig_set_default_case_fold_flag(OnigCaseFoldType case_fold_flag) デフォルトのcase foldフラグをセットする。 + この関数は廃止予定(非推奨)。 引数 1 case_fold_flag: case foldフラグ @@ -996,7 +1067,9 @@ * この関数を呼んだ後で、rangesを変更/破壊しないこと - 正常終了戻り値: ONIG_NORMAL + 戻り値 + 正常終了: ONIG_NORMAL == 0 + エラー時: エラーコード < 0 # unsigned int onig_get_parse_depth_limit(void) -- cgit v1.2.3