summaryrefslogtreecommitdiff
path: root/doc/CALLOUTS.API
diff options
context:
space:
mode:
authorJörg Frings-Fürst <debian@jff.email>2021-04-26 17:40:17 +0200
committerJörg Frings-Fürst <debian@jff.email>2021-04-26 17:40:17 +0200
commit98f7065a3f7b386564840bb5b24b94f9335b2e97 (patch)
tree0bd27b59da70360ac879db886b2cfbf7f2f56e41 /doc/CALLOUTS.API
parentfc9ba4264eafbb5a6ec0f3cc4cd2e1964c9b8fcf (diff)
New upstream version 6.9.7.1upstream/6.9.7.1
Diffstat (limited to 'doc/CALLOUTS.API')
-rw-r--r--doc/CALLOUTS.API60
1 files changed, 36 insertions, 24 deletions
diff --git a/doc/CALLOUTS.API b/doc/CALLOUTS.API
index c4a13c8..7ecf6bc 100644
--- a/doc/CALLOUTS.API
+++ b/doc/CALLOUTS.API
@@ -1,4 +1,4 @@
-Callouts API Version 6.8.2 2018/06/08
+Callouts API Version 6.9.7 2021/03/21
#include <oniguruma.h>
@@ -273,48 +273,51 @@ Callouts API Version 6.8.2 2018/06/08
Returns the callout data value/type for a callout slot indicated by
callout_num/slot.
- normal return: ONIG_NORMAL
- 1: not yet set (type is ONIG_TYPE_VOID)
- < 0: error code
+ ONIG_NORMAL: normal return
+ ONIG_VALUE_IS_NOT_SET: value is not set / type is ONIG_TYPE_VOID
+ < 0: error code
# int onig_get_callout_data_by_callout_args_self(OnigCalloutArgs* args, int slot, OnigType* type, OnigValue* val)
Returns self callout data value/type.
- normal return: ONIG_NORMAL
- 1: not yet set (type is ONIG_TYPE_VOID)
- < 0: error code
+ ONIG_NORMAL: normal return
+ ONIG_VALUE_IS_NOT_SET: value is not set / type is ONIG_TYPE_VOID
+ < 0: error code
# int onig_set_callout_data_by_callout_args(OnigCalloutArgs* args, int callout_num, int slot, OnigType type, OnigValue* val)
Set the callout data value/type for a callout slot indicated by callout_num/slot.
- normal return: ONIG_NORMAL
- < 0: error code
+ ONIG_NORMAL: normal return
+ < 0: error code
# int onig_set_callout_data_by_callout_args_self(OnigCalloutArgs* args, int slot, OnigType type, OnigValue* val)
Set self callout data value/type for a callout slot indicated by slot.
- normal return: ONIG_NORMAL
- < 0: error code
+ ONIG_NORMAL: normal return
+ < 0: error code
# int onig_get_callout_data_by_callout_args_self_dont_clear_old(OnigCalloutArgs* args, int slot, OnigType* type, OnigValue* val)
This function is almost same as onig_get_callout_data_by_callout_args_self().
- But this function doesn't clear values which set in previous failed match process.
- Other onig_get_callout_data_xxxx() functions clear all values which set
- in previous failed match process.
+ But this function does not clear the value set in the collation position before the current position. (dont_clear_old)
+ The other onig_get_callout_data_xxxx() function clears the value set in the collation process of the previous position.
For example, Builtin callout (*TOTAL_COUNT) is implemented by using this
function for accumulate count of all of match processes in a search process.
Builtin callout (*COUNT) returns count in last success match process only,
because it doesn't use this function.
+ ONIG_NORMAL: normal return
+ ONIG_VALUE_IS_NOT_SET: value is not set / type is ONIG_TYPE_VOID
+ < 0: error code
+
(8) Callout data (used in applications)
@@ -323,34 +326,34 @@ Callouts API Version 6.8.2 2018/06/08
Returns the callout data value/type for a callout slot indicated by
callout_num/slot.
- normal return: ONIG_NORMAL
- 1: not yet set (type is ONIG_TYPE_VOID)
- < 0: error code
+ ONIG_NORMAL: normal return
+ ONIG_VALUE_IS_NOT_SET: value is not set / type is ONIG_TYPE_VOID
+ < 0: error code
# int onig_get_callout_data_by_tag(OnigRegex reg, OnigMatchParam* mp, const OnigUChar* tag, const OnigUChar* tag_end, int slot, OnigType* type, OnigValue* val)
Returns the callout data value/type for a callout slot indicated by tag/slot.
- normal return: ONIG_NORMAL
- 1: not yet set (type is ONIG_TYPE_VOID)
- < 0: error code
+ ONIG_NORMAL: normal return
+ ONIG_VALUE_IS_NOT_SET: value is not set / type is ONIG_TYPE_VOID
+ < 0: error code
# int onig_set_callout_data(OnigRegex reg, OnigMatchParam* mp, int callout_num, int slot, OnigType type, OnigValue* val)
Set the callout data value/type for a callout slot indicated by callout_num/slot.
- normal return: ONIG_NORMAL
- < 0: error code
+ ONIG_NORMAL: normal return
+ < 0: error code
# int onig_set_callout_data_by_tag(OnigRegex reg, OnigMatchParam* mp, const OnigUChar* tag, const OnigUChar* tag_end, int slot, OnigType type, OnigValue* val)
Set the callout data value/type for a callout slot indicated by tag/slot.
- normal return: ONIG_NORMAL
- < 0: error code
+ ONIG_NORMAL: normal return
+ < 0: error code
# int onig_get_callout_data_dont_clear_old(OnigRegex reg, OnigMatchParam* mp, int callout_num, int slot, OnigType* type, OnigValue* val)
@@ -359,6 +362,15 @@ Callouts API Version 6.8.2 2018/06/08
It will be abolished.
+# int onig_get_callout_data_by_tag_dont_clear_old(regex_t* reg, OnigMatchParam* mp, const UChar* tag, const UChar* tag_end, int slot, OnigType* type, OnigValue* val)
+
+ Returns the callout data value/type for a callout slot indicated by tag/slot.
+ This function does not clear the value set in the collation position before the current position. (dont_clear_old)
+
+ ONIG_NORMAL: 正常終了
+ ONIG_VALUE_IS_NOT_SET: 値が未セット / 型がVOID
+ < 0: エラーコード
+
(9) Miscellaneous functions