diff options
Diffstat (limited to 'doc/API')
| -rw-r--r-- | doc/API | 134 | 
1 files changed, 132 insertions, 2 deletions
| @@ -1,4 +1,4 @@ -Oniguruma API  Version 6.7.0  2017/12/08 +Oniguruma API  Version 6.8.0  2018/03/13  #include <oniguruma.h> @@ -222,6 +222,77 @@ Oniguruma API  Version 6.7.0  2017/12/08    1 reg: regex object. +# OnigMatchParam* onig_new_match_param() + +  Allocate a OnigMatchParam object and initialize the contents by +  onig_initialize_match_param(). + + +# void onig_free_match_param(OnigMatchParam* mp) + +  Free memory used by a OnigMatchParam object. + +  arguments +  1 mp: OnigMatchParam object + + +# void onig_initialize_match_param(OnigMatchParam* mp) + +  Set match-param fields to default values. +  Match-param is used in onig_match_with_param() and onig_search_with_param(). + +  arguments +  1 mp: match-param pointer + + +# int onig_set_match_stack_limit_size_of_match_param(OnigMatchParam* mp, unsigned int limit) + +  Set a maximum number of match-stack depth. +  0 means unlimited. + +  arguments +  1 mp: match-param pointer +  2 limit: number of limit + +  normal return: ONIG_NORMAL + + +# int onig_set_retry_limit_in_match_of_match_param(OnigMatchParam* mp, unsigned long limit) + +  Set a retry limit count of a match process. + +  arguments +  1 mp: match-param pointer +  2 limit: number of limit + +  normal return: ONIG_NORMAL + + +# int onig_set_progress_callout_of_match_param(OnigMatchParam* mp, OnigCalloutFunc f) + +  Set a function for callouts of contents in progress. +  If 0 (NULL) is set, never called in progress. + +  arguments +  1 mp: match-param pointer +  2 f: function + +  normal return: ONIG_NORMAL + + +# int onig_set_retraction_callout_of_match_param(OnigMatchParam* mp, OnigCalloutFunc f) + +  Set a function for callouts of contents in retraction (backtrack). +  If 0 (NULL) is set, never called in retraction. + +  arguments +  1 mp: match-param pointer +  2 f: function + +  normal return: ONIG_NORMAL + + +  # int onig_search(regex_t* reg, const UChar* str, const UChar* end, const UChar* start,                     const UChar* range, OnigRegion* region, OnigOptionType option) @@ -246,8 +317,17 @@ Oniguruma API  Version 6.7.0  2017/12/08      ONIG_OPTION_POSIX_REGION  region argument is regmatch_t[] of POSIX API. +# int onig_search_with_param(regex_t* reg, const UChar* str, const UChar* end, +                   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) + +  # int onig_match(regex_t* reg, const UChar* str, const UChar* end, const UChar* at, -		 OnigRegion* region, OnigOptionType option) +                 OnigRegion* region, OnigOptionType option)    Match string and return result and matching region. @@ -267,6 +347,15 @@ Oniguruma API  Version 6.7.0  2017/12/08      ONIG_OPTION_POSIX_REGION region argument is regmatch_t[] type of POSIX API. +# int onig_match_with_param(regex_t* reg, const UChar* str, const UChar* end, +                            const UChar* at, OnigRegion* region, +                            OnigOptionType option, OnigMatchParam* mp) + +   arguments +   1-6:  same as onig_match() +   7 mp: match parameter values (match_stack_limit, retry_limit_in_match) + +  # int onig_scan(regex_t* reg, const UChar* str, const UChar* end,                  OnigRegion* region, OnigOptionType option,                  int (*scan_callback)(int, int, OnigRegion*, void*), @@ -623,6 +712,47 @@ Oniguruma API  Version 6.7.0  2017/12/08    normal return: ONIG_NORMAL +# unsigned long onig_get_retry_limit_in_match(void) + +  Return the limit of retry counts in matching process. +  (default: 10000000) + +  normal return: limit value + + +# int onig_set_retry_limit_in_match(unsigned long n) + +  Set the limit of retry counts in matching process. + +  normal return: ONIG_NORMAL + + +# OnigCalloutFunc onig_get_progress_callout(void) + +  Get a function for callouts of contents in progress. + + +# int onig_set_progress_callout(OnigCalloutFunc f) + +  Set a function for callouts of contents in progress. +  If 0 (NULL) is set, never called in progress. + +  normal return: ONIG_NORMAL + + +# OnigCalloutFunc onig_get_retraction_callout(void) + +  Get a function for callouts of contents in retraction (backtrack). + + +# int onig_set_retraction_callout(OnigCalloutFunc f) + +  Set a function for callouts of contents in retraction (backtrack). +  If 0 (NULL) is set, never called in retraction. + +  normal return: ONIG_NORMAL + +  # int onig_unicode_define_user_property(const char* name, OnigCodePoint* ranges))    Define new Unicode property. | 
