diff options
author | Matthew Vernon <matthew@debian.org> | 2015-11-22 17:40:07 +0000 |
---|---|---|
committer | Matthew Vernon <matthew@debian.org> | 2015-11-22 17:40:07 +0000 |
commit | c27ff5607e8146d7dcacf9ab7c25a931f14e1fbd (patch) | |
tree | c146457ebdc1247ca5b921d74e35e680be1f941a /doc/pcre2_jit_stack_assign.3 |
Imported Upstream version 10.20
Diffstat (limited to 'doc/pcre2_jit_stack_assign.3')
-rw-r--r-- | doc/pcre2_jit_stack_assign.3 | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/doc/pcre2_jit_stack_assign.3 b/doc/pcre2_jit_stack_assign.3 new file mode 100644 index 0000000..66b8095 --- /dev/null +++ b/doc/pcre2_jit_stack_assign.3 @@ -0,0 +1,55 @@ +.TH PCRE2_JIT_STACK_ASSIGN 3 "08 November 2014" "PCRE2 10.0" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include <pcre2.h> +.PP +.nf +.B void pcre2_jit_stack_assign(pcre2_match_context *\fImcontext\fP, +.B " pcre2_jit_callback \fIcallback_function\fP, void *\fIcallback_data\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function provides control over the memory used by JIT as a run-time stack +when \fBpcre2_match()\fP or \fBpcre2_jit_match()\fP is called with a pattern +that has been successfully processed by the JIT compiler. The information that +determines which stack is used is put into a match context that is subsequently +passed to a matching function. The arguments of this function are: +.sp + mcontext a pointer to a match context + callback a callback function + callback_data a JIT stack or a value to be passed to the callback +.P +If \fIcallback\fP is NULL and \fIcallback_data\fP is NULL, an internal 32K +block on the machine stack is used. +.P +If \fIcallback\fP is NULL and \fIcallback_data\fP is not NULL, +\fIcallback_data\fP must be a valid JIT stack, the result of calling +\fBpcre2_jit_stack_create()\fP. +.P +If \fIcallback\fP not NULL, it is called with \fIcallback_data\fP as an +argument at the start of matching, in order to set up a JIT stack. If the +result is NULL, the internal 32K stack is used; otherwise the return value must +be a valid JIT stack, the result of calling \fBpcre2_jit_stack_create()\fP. +.P +You may safely use the same JIT stack for multiple patterns, as long as they +are all matched in the same thread. In a multithread application, each thread +must use its own JIT stack. For more details, see the +.\" HREF +\fBpcre2jit\fP +.\" +page. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. |