Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

pcre2_jit_compile (3)

Name

pcre2_jit_compile - compatible regular expressions (revised API)

Synopsis

#include <pcre2.h>

int pcre2_jit_compile(pcre2_code *code, uint32_t options);

Description

PCRE2_JIT_COMPILE(3)       Library Functions Manual       PCRE2_JIT_COMPILE(3)



NAME
       PCRE2 - Perl-compatible regular expressions (revised API)

SYNOPSIS

       #include <pcre2.h>

       int pcre2_jit_compile(pcre2_code *code, uint32_t options);

DESCRIPTION

       This function requests JIT compilation, which, if the just-in-time com-
       piler is available, further processes a compiled pattern  into  machine
       code  that  executes  much  faster  than the pcre2_match() interpretive
       matching function. Full details are given in  the  pcre2jit  documenta-
       tion.

       The  first argument is a pointer that was returned by a successful call
       to pcre2_compile(), and the second must contain one or more of the fol-
       lowing bits:

         PCRE2_JIT_COMPLETE      compile code for full matching
         PCRE2_JIT_PARTIAL_SOFT  compile code for soft partial matching
         PCRE2_JIT_PARTIAL_HARD  compile code for hard partial matching

       There  is  also  an obsolete option called PCRE2_JIT_INVALID_UTF, which
       has    been    superseded     by     the     pcre2_compile()     option
       PCRE2_MATCH_INVALID_UTF.  The  old  option  is  deprecated  and  may be
       removed in the future.

       The yield of the function is 0 for success, or a  negative  error  code
       otherwise.  In particular, PCRE2_ERROR_JIT_BADOPTION is returned if JIT
       is not supported or if an unknown bit is set in options.  The  function
       can  also return PCRE2_ERROR_NOMEMORY if JIT is unable to allocate exe-
       cutable memory for the compiler, even if it was  because  of  a  system
       security restriction.

       There is a complete description of the PCRE2 native API in the pcre2api
       page and a description of the POSIX API in the pcre2posix page.



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/pcre2    |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source     was     downloaded     from       https://github.com/Philip-
       Hazel/pcre2/releases/download/pcre2-10.39/pcre2-10.39.tar.gz.

       Further information about this software can be found on the open source
       community website at http://pcre.org/.



PCRE2 10.34                      29 July 2019             PCRE2_JIT_COMPILE(3)