pcre2_jit_match(3) — Linux manual page

NAME \| SYNOPSIS \| DESCRIPTION \| COLOPHON

PCRE2_JIT_MATCH(3)      Library Functions Manual      PCRE2_JIT_MATCH(3)

NAME top

       PCRE2 - Perl-compatible regular expressions (revised API)

SYNOPSIS top


       #include <pcre2.h>

       int pcre2_jit_match(const pcre2_code *code, PCRE2_SPTR subject,
         PCRE2_SIZE length, PCRE2_SIZE startoffset,
         uint32_t options, pcre2_match_data *match_data,
         pcre2_match_context *mcontext);

DESCRIPTION top


       This function matches a compiled regular expression that has been
       successfully processed by the JIT compiler against a given
       subject string, using a matching algorithm that is similar to
       Perl's. It is a "fast path" interface to JIT, and it bypasses
       some of the sanity checks that pcre2_match() applies.

       In UTF mode, the subject string is not checked for UTF validity.
       Unless PCRE2_MATCH_INVALID_UTF was set when the pattern was
       compiled, passing an invalid UTF string results in undefined
       behaviour. Your program may crash or loop or give wrong results.
       In the absence of PCRE2_MATCH_INVALID_UTF you should only call
       pcre2_jit_match() in UTF mode if you are sure the subject is
       valid.

       The arguments for pcre2_jit_match() are exactly the same as for
       pcre2_match(), except that the subject string must be specified
       with a length; PCRE2_ZERO_TERMINATED is not supported.

       The supported options are PCRE2_NOTBOL, PCRE2_NOTEOL,
       PCRE2_NOTEMPTY, PCRE2_NOTEMPTY_ATSTART, PCRE2_PARTIAL_HARD, and
       PCRE2_PARTIAL_SOFT. Unsupported options are ignored.

       The return values are the same as for pcre2_match() plus
       PCRE2_ERROR_JIT_BADOPTION if a matching mode (partial or
       complete) is requested that was not compiled. For details of
       partial matching, see the pcre2partial page.

       There is a complete description of the PCRE2 native API in the
       pcre2api page and a description of the JIT API in the pcre2jit
       page.

COLOPHON top

       This page is part of the PCRE (Perl Compatible Regular
       Expressions) project.  Information about the project can be found
       at ⟨http://www.pcre.org/⟩.  If you have a bug report for this
       manual page, see
       ⟨http://bugs.exim.org/enter_bug.cgi?product=PCRE⟩.  This page was
       obtained from the tarball fetched from
       ⟨https://github.com/PhilipHazel/pcre2.git⟩ on 2024-06-14.  If you
       discover any rendering problems in this HTML version of the page,
       or you believe there is a better or more up-to-date source for
       the page, or you have corrections or improvements to the
       information in this COLOPHON (which is not part of the original
       manual page), send a mail to [email protected]

PCRE2 10.43                  20 January 2023          PCRE2_JIT_MATCH(3)