1PCRE2_COMPILE(3) Library Functions Manual PCRE2_COMPILE(3)
2
6 PCRE2 - Perl-compatible regular expressions (revised API)
7
9 #include <pcre2.h>
11 pcre2_code *pcre2_compile(PCRE2_SPTR pattern, PCRE2_SIZE length,
13 uint32_t options, int *errorcode, PCRE2_SIZE *erroroffset,
14 pcre2_compile_context *ccontext);
15
17 This function compiles a regular expression pattern into an internal
19 form. Its arguments are:
20 pattern A string containing expression to be compiled
22 length The length of the string or PCRE2_ZERO_TERMINATED
23 options Option bits
24 errorcode Where to put an error code
25 erroffset Where to put an error offset
26 ccontext Pointer to a compile context or NULL
27 The length of the string and any error offset that is returned are in
29 code units, not characters. A compile context is needed only if you
30 want to change
31 What \R matches (Unicode newlines or CR, LF, CRLF only)
33 PCRE2's character tables
34 The newline character sequence
35 The compile time nested parentheses limit
36 or provide an external function for stack size checking. The option
38 bits are:
39 PCRE2_ANCHORED Force pattern anchoring
41 PCRE2_ALT_BSUX Alternative handling of \u, \U, and \x
42 PCRE2_ALT_CIRCUMFLEX Alternative handling of ^ in multiline mode
43 PCRE2_AUTO_CALLOUT Compile automatic callouts
44 PCRE2_CASELESS Do caseless matching
45 PCRE2_DOLLAR_ENDONLY $ not to match newline at end
46 PCRE2_DOTALL . matches anything including NL
47 PCRE2_DUPNAMES Allow duplicate names for subpatterns
48 PCRE2_EXTENDED Ignore white space and # comments
49 PCRE2_FIRSTLINE Force matching to be before newline
50 PCRE2_MATCH_UNSET_BACKREF Match unset back references
51 PCRE2_MULTILINE ^ and $ match newlines within data
52 PCRE2_NEVER_BACKSLASH_C Lock out the use of \C in patterns
53 PCRE2_NEVER_UCP Lock out PCRE2_UCP, e.g. via (*UCP)
54 PCRE2_NEVER_UTF Lock out PCRE2_UTF, e.g. via (*UTF)
55 PCRE2_NO_AUTO_CAPTURE Disable numbered capturing paren-
56 theses (named ones available)
57 PCRE2_NO_AUTO_POSSESS Disable auto-possessification
58 PCRE2_NO_DOTSTAR_ANCHOR Disable automatic anchoring for .*
59 PCRE2_NO_START_OPTIMIZE Disable match-time start optimizations
60 PCRE2_NO_UTF_CHECK Do not check the pattern for UTF validity
61 (only relevant if PCRE2_UTF is set)
62 PCRE2_UCP Use Unicode properties for \d, \w, etc.
63 PCRE2_UNGREEDY Invert greediness of quantifiers
64 PCRE2_UTF Treat pattern and subjects as UTF strings
65 PCRE2 must be built with Unicode support in order to use PCRE2_UTF,
67 PCRE2_UCP and related options.
68 The yield of the function is a pointer to a private data structure that
70 contains the compiled pattern, or NULL if an error was detected.
71 There is a complete description of the PCRE2 native API in the pcre2api
73 page and a description of the POSIX API in the pcre2posix page.
74PCRE2 10.20 22 April 2015 PCRE2_COMPILE(3)