PCRE2Project/pcre2
1
0
Fork 0
mirror of https://github.com/PCRE2Project/pcre2.git synced 2025-10-20 12:55:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updates to the README and some documentation (#681)

Browse Source
This commit is contained in:
Nicholas Wilson
2025-02-01 15:50:20 +00:00
committed by GitHub
parent ec7f0a708b
commit 1fffb0d44e
117 changed files with 3812 additions and 3802 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
doc/html/pcre2_jit_stack_assign.html
View File

@@ -15,17 +15,17 @@ please consult the man page, in case the conversion went wrong.
<br><b>
SYNOPSIS
</b><br>
<P>
<p>
<b>#include &#60;pcre2.h&#62;</b>
</P>
<P>
</p>
<p>
<b>void pcre2_jit_stack_assign(pcre2_match_context *<i>mcontext</i>,</b>
<b> pcre2_jit_callback <i>callback_function</i>, void *<i>callback_data</i>);</b>
</P>
</p>
<br><b>
DESCRIPTION
</b><br>
<P>
<p>
This function provides control over the memory used by JIT as a run-time stack
when <b>pcre2_match()</b> or <b>pcre2_jit_match()</b> is called with a pattern
that has been successfully processed by the JIT compiler. The information that
@@ -35,36 +35,36 @@ passed to a matching function. The arguments of this function are:
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
</PRE>
</P>
<P>
</pre>
</p>
<p>
If <i>mcontext</i> is NULL, the function returns immediately, without doing
anything.
</P>
<P>
</p>
<p>
If <i>callback</i> is NULL and <i>callback_data</i> is NULL, an internal 32KiB
block on the machine stack is used.
</P>
<P>
</p>
<p>
If <i>callback</i> is NULL and <i>callback_data</i> is not NULL,
<i>callback_data</i> must be a valid JIT stack, the result of calling
<b>pcre2_jit_stack_create()</b>.
</P>
<P>
</p>
<p>
If <i>callback</i> not NULL, it is called with <i>callback_data</i> as an
argument at the start of matching, in order to set up a JIT stack. If the
result is NULL, the internal 32KiB stack is used; otherwise the return value
must be a valid JIT stack, the result of calling
<b>pcre2_jit_stack_create()</b>.
</P>
<P>
</p>
<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
<a href="pcre2jit.html"><b>pcre2jit</b></a>
page.
</P>
<P>
</p>
<p>
There is a complete description of the PCRE2 native API in the
<a href="pcre2api.html"><b>pcre2api</b></a>
page and a description of the POSIX API in the