src/external/pcre2-10.32/doc/pcre2_jit_stack_create.3

   1 .TH PCRE2_JIT_STACK_CREATE 3 "24 March 2017" "PCRE2 10.30"
   2 .SH NAME
   3 PCRE2 - Perl-compatible regular expressions (revised API)
   4 .SH SYNOPSIS
   5 .rs
   6 .sp
   7 .B #include <pcre2.h>
   8 .PP
   9 .nf
  10 .B pcre2_jit_stack *pcre2_jit_stack_create(PCRE2_SIZE \fIstartsize\fP,
  11 .B "  PCRE2_SIZE \fImaxsize\fP, pcre2_general_context *\fIgcontext\fP);"
  12 .fi
  13 .
  14 .SH DESCRIPTION
  15 .rs
  16 .sp
  17 This function is used to create a stack for use by the code compiled by the JIT
  18 compiler. The first two arguments are a starting size for the stack, and a
  19 maximum size to which it is allowed to grow. The final argument is a general
  20 context, for memory allocation functions, or NULL for standard memory
  21 allocation. The result can be passed to the JIT run-time code by calling
  22 \fBpcre2_jit_stack_assign()\fP to associate the stack with a compiled pattern,
  23 which can then be processed by \fBpcre2_match()\fP or \fBpcre2_jit_match()\fP.
  24 A maximum stack size of 512KiB to 1MiB should be more than enough for any
  25 pattern. For more details, see the
  26 .\" HREF
  27 \fBpcre2jit\fP
  28 .\"
  29 page.
  30 .P
  31 There is a complete description of the PCRE2 native API in the
  32 .\" HREF
  33 \fBpcre2api\fP
  34 .\"
  35 page and a description of the POSIX API in the
  36 .\" HREF
  37 \fBpcre2posix\fP
  38 .\"
  39 page.