From: K.Kosako Date: Sat, 6 Jul 2019 13:29:49 +0000 (+0900) Subject: update doc/API X-Git-Tag: v6.9.3~66 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=88c4aa19312b8ab8524c871dbff110cc1831c709;p=onig update doc/API --- diff --git a/doc/API b/doc/API index bc72e72..049db02 100644 --- a/doc/API +++ b/doc/API @@ -1,4 +1,4 @@ -Oniguruma API Version 6.9.3 2019/06/27 +Oniguruma API Version 6.9.3 2019/07/06 #include @@ -168,9 +168,8 @@ Oniguruma API Version 6.9.3 2019/06/27 # int onig_new_deluxe(regex_t** reg, const UChar* pattern, const UChar* pattern_end, OnigCompileInfo* ci, OnigErrorInfo* einfo) - From 6.9.3: - This function is obsolete, and it does not allow the case where - the encoding of pattern and target is different. + This function is deprecate, and it does not allow the case where + the encoding of pattern and target is different. Create a regex object. This function is deluxe version of onig_new(). @@ -303,6 +302,7 @@ Oniguruma API Version 6.9.3 2019/06/27 const UChar* range, OnigRegion* region, OnigOptionType option) Search string and return search result and matching region. + Do not pass invalid byte string in the regex character encoding. normal return: match position offset (i.e. p - str >= 0) not found: ONIG_MISMATCH (< 0) @@ -327,15 +327,19 @@ Oniguruma API Version 6.9.3 2019/06/27 const UChar* start, const UChar* range, OnigRegion* region, OnigOptionType option, OnigMatchParam* mp) - arguments - 1-7: same as onig_search() - 8 mp: match parameter values (match_stack_limit, retry_limit_in_match) + Search string and return search result and matching region. + Do not pass invalid byte string in the regex character encoding. + + arguments + 1-7: same as onig_search() + 8 mp: match parameter values (match_stack_limit, retry_limit_in_match) # int onig_match(regex_t* reg, const UChar* str, const UChar* end, const UChar* at, OnigRegion* region, OnigOptionType option) Match string and return result and matching region. + Do not pass invalid byte string in the regex character encoding. normal return: match length (>= 0) not match: ONIG_MISMATCH ( < 0) @@ -357,6 +361,9 @@ Oniguruma API Version 6.9.3 2019/06/27 const UChar* at, OnigRegion* region, OnigOptionType option, OnigMatchParam* mp) + Match string and return result and matching region. + Do not pass invalid byte string in the regex character encoding. + arguments 1-6: same as onig_match() 7 mp: match parameter values (match_stack_limit, retry_limit_in_match) @@ -368,6 +375,7 @@ Oniguruma API Version 6.9.3 2019/06/27 void* callback_arg) Scan string and callback with matching region. + Do not pass invalid byte string in the regex character encoding. normal return: number of matching times error: error code @@ -615,14 +623,20 @@ Oniguruma API Version 6.9.3 2019/06/27 # int onigenc_strlen(OnigEncoding enc, const UChar* s, const UChar* end) + + Return number of characters in the string. + + # int onigenc_strlen_null(OnigEncoding enc, const UChar* s) Return number of characters in the string. + Do not pass invalid byte string in the character encoding. # int onigenc_str_bytelen_null(OnigEncoding enc, const UChar* s) Return number of bytes in the string. + Do not pass invalid byte string in the character encoding. # int onig_set_default_syntax(OnigSyntaxType* syntax) diff --git a/doc/API.ja b/doc/API.ja index a7e597c..5871558 100644 --- a/doc/API.ja +++ b/doc/API.ja @@ -1,4 +1,4 @@ -鬼車インターフェース Version 6.9.3 2019/06/27 +鬼車インターフェース Version 6.9.3 2019/07/06 #include @@ -167,10 +167,8 @@ # int onig_new_deluxe(regex_t** reg, const UChar* pattern, const UChar* pattern_end, OnigCompileInfo* ci, OnigErrorInfo* einfo) - 6.9.3から: - この関数は廃止された。 - パターンと対象文字列の文字エンコーディングが異なる場合を許さなくなった。 - + この関数は廃止予定。 + パターンと対象文字列の文字エンコーディングが異なる場合を許さなくなった。 正規表現オブジェクト(regex)を作成する。 この関数は、onig_new()のデラックス版。 @@ -303,6 +301,7 @@ const UChar* range, OnigRegion* region, OnigOptionType option) 正規表現で文字列を検索し、検索結果とマッチ領域を返す。 + 正規表現オブジェクトの文字エンコーディングで、検索文字列として不正な文字列を渡してはいけない。 正常終了戻り値: マッチ位置 (p - str >= 0) 検索失敗: ONIG_MISMATCH (< 0) @@ -327,6 +326,9 @@ const UChar* start, const UChar* range, OnigRegion* region, OnigOptionType option, OnigMatchParam* mp) + 正規表現で文字列を検索し、検索結果とマッチ領域を返す。 + 正規表現オブジェクトの文字エンコーディングで、検索文字列として不正な文字列を渡してはいけない。 + 引数 1-7: onig_search()と同じ 8 mp: マッチパラメタ値 (match_stack_limit, retry_limit_in_match) @@ -336,6 +338,7 @@ const UChar* at, OnigRegion* region, OnigOptionType option) 文字列の指定位置でマッチングを行い、結果とマッチ領域を返す。 + 正規表現オブジェクトの文字エンコーディングで、検索文字列として不正な文字列を渡してはいけない。 正常終了戻り値: マッチしたバイト長 (>= 0) not match: ONIG_MISMATCH ( < 0) @@ -357,6 +360,9 @@ const UChar* at, OnigRegion* region, OnigOptionType option, OnigMatchParam* mp) + 文字列の指定位置でマッチングを行い、結果とマッチ領域を返す。 + 正規表現オブジェクトの文字エンコーディングで、検索文字列として不正な文字列を渡してはいけない。 + 引数 1-6: onig_match()と同じ 7 mp: マッチパラメタ値 (match_stack_limit, retry_limit_in_match) @@ -368,6 +374,7 @@ void* callback_arg) 正規表現で文字列をスキャンして、マッチングする毎にコールバック関数を呼び出す。 + 正規表現オブジェクトの文字エンコーディングで、検索文字列として不正な文字列を渡してはいけない。 正常終了: マッチ回数 (0回も含める) エラー: エラーコード (< 0) @@ -621,14 +628,20 @@ # int onigenc_strlen(OnigEncoding enc, const UChar* s, const UChar* end) + + 文字列の文字数を返す。 + + # int onigenc_strlen_null(OnigEncoding enc, const UChar* s) 文字列の文字数を返す。 + 文字エンコーディングに対して、不正な文字列を渡してはいけない。 # int onigenc_str_bytelen_null(OnigEncoding enc, const UChar* s) 文字列のバイト数を返す。 + 文字エンコーディングに対して、不正な文字列を渡してはいけない。 # int onig_set_default_syntax(OnigSyntaxType* syntax)