• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<title>pcre2_jit_compile specification</title>
4</head>
5<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6<h1>pcre2_jit_compile man page</h1>
7<p>
8Return to the <a href="index.html">PCRE2 index page</a>.
9</p>
10<p>
11This page is part of the PCRE2 HTML documentation. It was generated
12automatically from the original man page. If there is any nonsense in it,
13please consult the man page, in case the conversion went wrong.
14<br>
15<br><b>
16SYNOPSIS
17</b><br>
18<P>
19<b>#include &#60;pcre2.h&#62;</b>
20</P>
21<P>
22<b>int pcre2_jit_compile(pcre2_code *<i>code</i>, uint32_t <i>options</i>);</b>
23</P>
24<br><b>
25DESCRIPTION
26</b><br>
27<P>
28This function requests JIT compilation, which, if the just-in-time compiler is
29available, further processes a compiled pattern into machine code that executes
30much faster than the <b>pcre2_match()</b> interpretive matching function. Full
31details are given in the
32<a href="pcre2jit.html"><b>pcre2jit</b></a>
33documentation.
34</P>
35<P>
36The first argument is a pointer that was returned by a successful call to
37<b>pcre2_compile()</b>, and the second must contain one or more of the following
38bits:
39<pre>
40  PCRE2_JIT_COMPLETE      compile code for full matching
41  PCRE2_JIT_PARTIAL_SOFT  compile code for soft partial matching
42  PCRE2_JIT_PARTIAL_HARD  compile code for hard partial matching
43</pre>
44There is also an obsolete option called PCRE2_JIT_INVALID_UTF, which has been
45superseded by the <b>pcre2_compile()</b> option PCRE2_MATCH_INVALID_UTF. The old
46option is deprecated and may be removed in the future.
47</P>
48<P>
49The yield of the function is 0 for success, or a negative error code otherwise.
50In particular, PCRE2_ERROR_JIT_BADOPTION is returned if JIT is not supported or
51if an unknown bit is set in <i>options</i>. The function can also return
52PCRE2_ERROR_NOMEMORY if JIT is unable to allocate executable memory for the
53compiler, even if it was because of a system security restriction.
54</P>
55<P>
56There is a complete description of the PCRE2 native API in the
57<a href="pcre2api.html"><b>pcre2api</b></a>
58page and a description of the POSIX API in the
59<a href="pcre2posix.html"><b>pcre2posix</b></a>
60page.
61<p>
62Return to the <a href="index.html">PCRE2 index page</a>.
63</p>
64