doc/pcre_jit_stack_alloc.3

   1 .TH PCRE_JIT_STACK_ALLOC 3 "24 June 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 .nf
  10 .B pcre_jit_stack *pcre_jit_stack_alloc(int \fIstartsize\fP,
  11 .B "     int \fImaxsize\fP);"
  12 .sp
  13 .B pcre16_jit_stack *pcre16_jit_stack_alloc(int \fIstartsize\fP,
  14 .B "     int \fImaxsize\fP);"
  15 .sp
  16 .B pcre32_jit_stack *pcre32_jit_stack_alloc(int \fIstartsize\fP,
  17 .B "     int \fImaxsize\fP);"
  18 .fi
  19 .
  20 .SH DESCRIPTION
  21 .rs
  22 .sp
  23 This function is used to create a stack for use by the code compiled by the JIT
  24 optimization of \fBpcre[16|32]_study()\fP. The arguments are a starting size for
  25 the stack, and a maximum size to which it is allowed to grow. The result can be
  26 passed to the JIT run-time code by \fBpcre[16|32]_assign_jit_stack()\fP, or that
  27 function can set up a callback for obtaining a stack. A maximum stack size of
  28 512K to 1M should be more than enough for any pattern. For more details, see
  29 the
  30 .\" HREF
  31 \fBpcrejit\fP
  32 .\"
  33 page.
  34 .P
  35 There is a complete description of the PCRE native API in the
  36 .\" HREF
  37 \fBpcreapi\fP
  38 .\"
  39 page and a description of the POSIX API in the
  40 .\" HREF
  41 \fBpcreposix\fP
  42 .\"
  43 page.