trunk/doc/pcre_assign_jit_stack.3

.TH PCRE_ASSIGN_JIT_STACK 3 "13 January 2012" "PCRE 8.30"
.SH NAME
PCRE - Perl-compatible regular expressions
.SH SYNOPSIS
.rs
.sp
.B #include <pcre.h>
.PP
.SM
.B void pcre_assign_jit_stack(pcre_extra *\fIextra\fP,
.ti +5n
.B pcre_jit_callback \fIcallback\fP, void *\fIdata\fP);
.PP
.B void pcre16_assign_jit_stack(pcre16_extra *\fIextra\fP,
.ti +5n
.B pcre16_jit_callback \fIcallback\fP, void *\fIdata\fP);
.
.SH DESCRIPTION
.rs
.sp
This function provides control over the memory used as a stack at run-time by a
call to \fBpcre[16]_exec()\fP with a pattern that has been successfully
compiled with JIT optimization. The arguments are:
.sp
  extra     the data pointer returned by \fBpcre[16]_study()\fP
  callback  a callback function
  data      a JIT stack or a value to be passed to the callback
              function
.P
If \fIcallback\fP is NULL and \fIdata\fP is NULL, an internal 32K block on
the machine stack is used.
.P
If \fIcallback\fP is NULL and \fIdata\fP is not NULL, \fIdata\fP must
be a valid JIT stack, the result of calling \fBpcre[16]_jit_stack_alloc()\fP.
.P
If \fIcallback\fP not NULL, it is called with \fIdata\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 \fBpcre[16]_jit_stack_alloc()\fP.
.P
You may safely assign the same JIT stack to 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
\fBpcrejit\fP
.\"
page.
.P
There is a complete description of the PCRE native API in the
.\" HREF
\fBpcreapi\fP
.\"
page and a description of the POSIX API in the
.\" HREF
\fBpcreposix\fP
.\"
page.
1	.TH PCRE_ASSIGN_JIT_STACK 3 "13 January 2012" "PCRE 8.30"
2	.SH NAME
3	PCRE - Perl-compatible regular expressions
4	.SH SYNOPSIS
5	.rs
6	.sp
7	.B #include <pcre.h>
8	.PP
9	.SM
10	.B void pcre_assign_jit_stack(pcre_extra *\fIextra\fP,
11	.ti +5n
12	.B pcre_jit_callback \fIcallback\fP, void *\fIdata\fP);
13	.PP
14	.B void pcre16_assign_jit_stack(pcre16_extra *\fIextra\fP,
15	.ti +5n
16	.B pcre16_jit_callback \fIcallback\fP, void *\fIdata\fP);
17	.
18	.SH DESCRIPTION
19	.rs
20	.sp
21	This function provides control over the memory used as a stack at run-time by a
22	call to \fBpcre[16]_exec()\fP with a pattern that has been successfully
23	compiled with JIT optimization. The arguments are:
24	.sp
25	extra the data pointer returned by \fBpcre[16]_study()\fP
26	callback a callback function
27	data a JIT stack or a value to be passed to the callback
28	function
29	.P
30	If \fIcallback\fP is NULL and \fIdata\fP is NULL, an internal 32K block on
31	the machine stack is used.
32	.P
33	If \fIcallback\fP is NULL and \fIdata\fP is not NULL, \fIdata\fP must
34	be a valid JIT stack, the result of calling \fBpcre[16]_jit_stack_alloc()\fP.
35	.P
36	If \fIcallback\fP not NULL, it is called with \fIdata\fP as an argument at
37	the start of matching, in order to set up a JIT stack. If the result is NULL,
38	the internal 32K stack is used; otherwise the return value must be a valid JIT
39	stack, the result of calling \fBpcre[16]_jit_stack_alloc()\fP.
40	.P
41	You may safely assign the same JIT stack to multiple patterns, as long as they
42	are all matched in the same thread. In a multithread application, each thread
43	must use its own JIT stack. For more details, see the
44	.\" HREF
45	\fBpcrejit\fP
46	.\"
47	page.
48	.P
49	There is a complete description of the PCRE native API in the
50	.\" HREF
51	\fBpcreapi\fP
52	.\"
53	page and a description of the POSIX API in the
54	.\" HREF
55	\fBpcreposix\fP
56	.\"
57	page.