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

   1 .TH PCRE2_JIT_COMPILE 3 "21 October 2014" "PCRE2 10.00"
   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 int pcre2_jit_compile(pcre2_code *\fIcode\fP, uint32_t \fIoptions\fP);
  11 .fi
  12 .
  13 .SH DESCRIPTION
  14 .rs
  15 .sp
  16 This function requests JIT compilation, which, if the just-in-time compiler is
  17 available, further processes a compiled pattern into machine code that executes
  18 much faster than the \fBpcre2_match()\fP interpretive matching function. Full
  19 details are given in the
  20 .\" HREF
  21 \fBpcre2jit\fP
  22 .\"
  23 documentation.
  24 .P
  25 The first argument is a pointer that was returned by a successful call to
  26 \fBpcre2_compile()\fP, and the second must contain one or more of the following
  27 bits:
  28 .sp
  29   PCRE2_JIT_COMPLETE      compile code for full matching
  30   PCRE2_JIT_PARTIAL_SOFT  compile code for soft partial matching
  31   PCRE2_JIT_PARTIAL_HARD  compile code for hard partial matching
  32 .sp
  33 The yield of the function is 0 for success, or a negative error code otherwise.
  34 In particular, PCRE2_ERROR_JIT_BADOPTION is returned if JIT is not supported or
  35 if an unknown bit is set in \fIoptions\fP.
  36 .P
  37 There is a complete description of the PCRE2 native API in the
  38 .\" HREF
  39 \fBpcre2api\fP
  40 .\"
  41 page and a description of the POSIX API in the
  42 .\" HREF
  43 \fBpcre2posix\fP
  44 .\"
  45 page.