Blame doc/pcre2_jit_stack_create.3

Packit 504f36
.TH PCRE2_JIT_STACK_CREATE 3 "24 March 2017" "PCRE2 10.30"
Packit 504f36
.SH NAME
Packit 504f36
PCRE2 - Perl-compatible regular expressions (revised API)
Packit 504f36
.SH SYNOPSIS
Packit 504f36
.rs
Packit 504f36
.sp
Packit 504f36
.B #include <pcre2.h>
Packit 504f36
.PP
Packit 504f36
.nf
Packit 504f36
.B pcre2_jit_stack *pcre2_jit_stack_create(PCRE2_SIZE \fIstartsize\fP,
Packit 504f36
.B "  PCRE2_SIZE \fImaxsize\fP, pcre2_general_context *\fIgcontext\fP);"
Packit 504f36
.fi
Packit 504f36
.
Packit 504f36
.SH DESCRIPTION
Packit 504f36
.rs
Packit 504f36
.sp
Packit 504f36
This function is used to create a stack for use by the code compiled by the JIT
Packit 504f36
compiler. The first two arguments are a starting size for the stack, and a
Packit 504f36
maximum size to which it is allowed to grow. The final argument is a general
Packit 504f36
context, for memory allocation functions, or NULL for standard memory
Packit 504f36
allocation. The result can be passed to the JIT run-time code by calling
Packit 504f36
\fBpcre2_jit_stack_assign()\fP to associate the stack with a compiled pattern,
Packit 504f36
which can then be processed by \fBpcre2_match()\fP or \fBpcre2_jit_match()\fP.
Packit 504f36
A maximum stack size of 512KiB to 1MiB should be more than enough for any
Packit 504f36
pattern. For more details, see the
Packit 504f36
.\" HREF
Packit 504f36
\fBpcre2jit\fP
Packit 504f36
.\"
Packit 504f36
page.
Packit 504f36
.P
Packit 504f36
There is a complete description of the PCRE2 native API in the
Packit 504f36
.\" HREF
Packit 504f36
\fBpcre2api\fP
Packit 504f36
.\"
Packit 504f36
page and a description of the POSIX API in the
Packit 504f36
.\" HREF
Packit 504f36
\fBpcre2posix\fP
Packit 504f36
.\"
Packit 504f36
page.