Did you know ... | Search Documentation: |
Predicate re_compile/3 |
regex
(see blob/2). Defined Options
are given below. Please consult the PCRE2
API documentation for details. If an option is repeated, the first
value is used and subsequent values are ignored. Unrecognized options
are ignored. Unless otherwise specified, boolean options default to false
.
Some options may not exist on your system, depending on the PCRE2
version and how it was built - these unsupported options are silently
ignored.
The various matching predicates can take either a Regex blob or a string pattern; if they are given a string pattern, they call re_compile/3 and cache the result; so, there is little reason to use re_compile/3 directly.
anchored(Bool)
If true
, match only at the
first positionauto_capture(Bool)
Enable use of numbered capturing
parentheses. (default true
)bsr(Mode)
If anycrlf
, \
R only
matches CR, LF or CRLF; if unicode
,
\
R matches all Unicode line endings.bsr2(Mode)
- synonym for bsr(Mode)
.caseless(Bool)
If true
, do caseless
matching.compat(With)
Error - PCRE1 had compat(javascript)
for JavaScript compatibility, but PCRE2 has removed that.dollar_endonly(Bool)
If true
, $ not to
match newline at enddotall(Bool)
If true
, . matches anything
including NLdupnames(Bool)
If true
, allow duplicate
names for subpatternsextended(Bool)
If true
, ignore white space
and # commentsfirstline(Bool)
If true
, force matching to
be before newlinegreedy(Bool)
If true
, operators such as +
and *
are greedy unless followed by ?
; if false
,
the operators are not greedy and ?
has the opposite
meaning. It can also beset by a‘(?U)` within the pattern - see the PCRE2
pattern internal option setting documentation for details and note
that the PCRE2 option is UNGREEDY, which is the inverse of
this packages greedy
options. (default true
)compat(With)
Raises an errr - PCRE1 had compat(javascript)
for JavaScript compatibility, but PCRE2 has removed that option .
Consider using the alt_bsux
and extra_alt_bsux
options.multiline(Bool)
If true
, ^
and $ match newlines within datanewline(Mode)
If any
, recognize any
Unicode newline sequence; if anycrlf
(default), recognize
CR, LF, and CRLF as newline sequences; if
cr
, recognize CR; if lf
, recognize LF; crlf
recognize CRLF as newline; if nul
, recognize the NULL
character (0x00) as newline.newline2(Mode)
- synonym for newline(Mode)
.ucp(Bool)
If true
, use Unicode properties
for \
d, \
w, etc.utf_check(Bool)
- see PCRE2
API documentation You should not need this because SWI-Prolog
ensures that the UTF8 strings are valid,endanchored(boolean)
- see PCRE2
API documentationallow_empty_class(boolean)
- see PCRE2
API documentationalt_bsux(boolean)
- see PCRE2
API documentationauto_callout(boolean)
- see PCRE2
API documentationmatch_unset_backref(boolean)
- see PCRE2
API documentationnever_ucp(boolean)
- see PCRE2
API documentationnever_utf(boolean)
- see PCRE2
API documentationauto_possess(boolean)
- see PCRE2
API documentation (default true
)dotstar_anchor(boolean)
- see PCRE2
API documentation (default true
)start_optimize(boolean)
- see PCRE2
API documentation (default true
)utf(boolean)
- see PCRE2
API documentationnever_backslash_c(boolean)
- see PCRE2
API documentationalt_circumflex(boolean)
- see PCRE2
API documentationalt_verbnames(boolean)
- see PCRE2
API documentationuse_offset_limit(boolean)
- see PCRE2
API documentationextended_more(boolean)
- see PCRE2
API documentationliteral(boolean)
- see PCRE2
API documentationmatch_invalid_utf(boolean)
- see PCRE2
API documentationjit_complete(boolean)
- see PCRE2
API documentationjit_partial_soft(boolean)
- see PCRE2
API documentationjit_partial_hard(boolean)
- see PCRE2
API documentationjit_invalid_utf(boolean)
- see PCRE2
API documentationjit(boolean)
- see PCRE2
API documentation (default true
)copy_matched_subject(boolean)
- see PCRE2
API documentationIn addition to the options above that directly map to PCRE flags the following options are processed:
optimise(Bool)
or optimize(Bool)
Turns on
the JIT compiler for additional optimization that greatly that speeds up
the matching performance of many patterns. (Note that he meaning has
changed slightly from the PCRE1 implementationcapture_type(+Type)
How to return the matched part of
the input and possibly captured groups in there. Possible values are:
Start-Length
. Note
that we use Start-Length
rather than the more conventional
Start-End
to allow for immediate use with sub_atom/5
and
sub_string/5.
The capture_type
specifies the default for this pattern.
The interface supports a different type for each named group
using the syntax‘(?<name_T>...)`,
where T is one of S
(string),
A
(atom), I
(integer), F
(float), N
(number), T
(term) and R
(range). In the
current implementation I
,
F
and N
are synonyms for T
.
Future versions may act different if the parsed value is not of the
requested numeric type.
Note that re_compile/3 does not support the Pattern/Flags form that is supported by re_match/3, re_replace/4, etc.; the Pattern must be text and all compile options specified in Options.