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

   1 .TH PCRE2_JIT_MATCH 3 "03 November 2014" "PCRE2 10.0"
   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_match(const pcre2_code *\fIcode\fP, PCRE2_SPTR \fIsubject\fP,
  11 .B "  PCRE2_SIZE \fIlength\fP, PCRE2_SIZE \fIstartoffset\fP,"
  12 .B "  uint32_t \fIoptions\fP, pcre2_match_data *\fImatch_data\fP,"
  13 .B "  pcre2_match_context *\fImcontext\fP);"
  14 .fi
  15 .
  16 .SH DESCRIPTION
  17 .rs
  18 .sp
  19 This function matches a compiled regular expression that has been successfully
  20 processed by the JIT compiler against a given subject string, using a matching
  21 algorithm that is similar to Perl's. It is a "fast path" interface to JIT, and
  22 it bypasses some of the sanity checks that \fBpcre2_match()\fP applies.
  23 Its arguments are exactly the same as for
  24 .\" HREF
  25 \fBpcre2_match()\fP.
  26 .\"
  27 .P
  28 The supported options are PCRE2_NOTBOL, PCRE2_NOTEOL, PCRE2_NOTEMPTY,
  29 PCRE2_NOTEMPTY_ATSTART, PCRE2_PARTIAL_HARD, and PCRE2_PARTIAL_SOFT. Unsupported
  30 options are ignored. The subject string is not checked for UTF validity.
  31 .P
  32 The return values are the same as for \fBpcre2_match()\fP plus
  33 PCRE2_ERROR_JIT_BADOPTION if a matching mode (partial or complete) is requested
  34 that was not compiled. For details of partial matching, see the
  35 .\" HREF
  36 \fBpcre2partial\fP
  37 .\"
  38 page.
  39 .P
  40 There is a complete description of the PCRE2 native API in the
  41 .\" HREF
  42 \fBpcre2api\fP
  43 .\"
  44 page and a description of the JIT API in the
  45 .\" HREF
  46 \fBpcre2jit\fP
  47 .\"
  48 page.