|
|
|
@ -6905,12 +6905,17 @@ BACKSLASH
|
|
|
|
calSymbols" are not supported by PCRE2. Note that \P{Any} does not
|
|
|
|
calSymbols" are not supported by PCRE2. Note that \P{Any} does not
|
|
|
|
match any characters, so always causes a match failure.
|
|
|
|
match any characters, so always causes a match failure.
|
|
|
|
|
|
|
|
|
|
|
|
Sets of Unicode characters are defined as belonging to certain scripts.
|
|
|
|
There are three different syntax forms for matching a script. Each Uni-
|
|
|
|
A character from one of these sets can be matched using a script name.
|
|
|
|
code character has a basic script and, optionally, a list of other
|
|
|
|
For example:
|
|
|
|
scripts ("Script Extentions") with which it is commonly used. Using the
|
|
|
|
|
|
|
|
Adlam script as an example, \p{sc:Adlam} matches characters whose basic
|
|
|
|
\p{Greek}
|
|
|
|
script is Adlam, whereas \p{scx:Adlam} matches, in addition, characters
|
|
|
|
\P{Han}
|
|
|
|
that have Adlam in their extensions list. The full names "script" and
|
|
|
|
|
|
|
|
"script extensions" for the property types are recognized, and a equals
|
|
|
|
|
|
|
|
sign is an alternative to the colon. If a script name is given without
|
|
|
|
|
|
|
|
a property type, for example, \p{Adlam}, it is treated as \p{scx:Ad-
|
|
|
|
|
|
|
|
lam}. Perl changed to this interpretation at release 5.26 and PCRE2
|
|
|
|
|
|
|
|
changed at release 10.40.
|
|
|
|
|
|
|
|
|
|
|
|
Unassigned characters (and in non-UTF 32-bit mode, characters with code
|
|
|
|
Unassigned characters (and in non-UTF 32-bit mode, characters with code
|
|
|
|
points greater than 0x10FFFF) are assigned the "Unknown" script. Others
|
|
|
|
points greater than 0x10FFFF) are assigned the "Unknown" script. Others
|
|
|
|
@ -9702,7 +9707,7 @@ AUTHOR
|
|
|
|
|
|
|
|
|
|
|
|
REVISION
|
|
|
|
REVISION
|
|
|
|
|
|
|
|
|
|
|
|
Last updated: 10 December 2021
|
|
|
|
Last updated: 22 December 2021
|
|
|
|
Copyright (c) 1997-2021 University of Cambridge.
|
|
|
|
Copyright (c) 1997-2021 University of Cambridge.
|
|
|
|
------------------------------------------------------------------------------
|
|
|
|
------------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
|
|
@ -10670,6 +10675,7 @@ GENERAL CATEGORY PROPERTIES FOR \p and \P
|
|
|
|
Lo Other letter
|
|
|
|
Lo Other letter
|
|
|
|
Lt Title case letter
|
|
|
|
Lt Title case letter
|
|
|
|
Lu Upper case letter
|
|
|
|
Lu Upper case letter
|
|
|
|
|
|
|
|
Lc Ll, Lu, or Lt
|
|
|
|
L& Ll, Lu, or Lt
|
|
|
|
L& Ll, Lu, or Lt
|
|
|
|
|
|
|
|
|
|
|
|
M Mark
|
|
|
|
M Mark
|
|
|
|
@ -10716,32 +10722,35 @@ PCRE2 SPECIAL CATEGORY PROPERTIES FOR \p and \P
|
|
|
|
acter set at release 5.18.
|
|
|
|
acter set at release 5.18.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
SCRIPT NAMES FOR \p AND \P
|
|
|
|
SCRIPT MATCHING WITH \p AND \P
|
|
|
|
|
|
|
|
|
|
|
|
Adlam, Ahom, Anatolian_Hieroglyphs, Arabic, Armenian, Avestan, Bali-
|
|
|
|
The following script names are recognized in \p{sc:...} or \p{scx:...}
|
|
|
|
nese, Bamum, Bassa_Vah, Batak, Bengali, Bhaiksuki, Bopomofo, Brahmi,
|
|
|
|
items, or on their own with \p (and also \P of course):
|
|
|
|
Braille, Buginese, Buhid, Canadian_Aboriginal, Carian, Caucasian_Alba-
|
|
|
|
|
|
|
|
nian, Chakma, Cham, Cherokee, Chorasmian, Common, Coptic, Cuneiform,
|
|
|
|
Adlam, Ahom, Anatolian_Hieroglyphs, Arabic, Armenian, Avestan, Bali-
|
|
|
|
Cypriot, Cypro_Minoan, Cyrillic, Deseret, Devanagari, Dives_Akuru, Do-
|
|
|
|
nese, Bamum, Bassa_Vah, Batak, Bengali, Bhaiksuki, Bopomofo, Brahmi,
|
|
|
|
gra, Duployan, Egyptian_Hieroglyphs, Elbasan, Elymaic, Ethiopic, Geor-
|
|
|
|
Braille, Buginese, Buhid, Canadian_Aboriginal, Carian, Caucasian_Alba-
|
|
|
|
|
|
|
|
nian, Chakma, Cham, Cherokee, Chorasmian, Common, Coptic, Cuneiform,
|
|
|
|
|
|
|
|
Cypriot, Cypro_Minoan, Cyrillic, Deseret, Devanagari, Dives_Akuru, Do-
|
|
|
|
|
|
|
|
gra, Duployan, Egyptian_Hieroglyphs, Elbasan, Elymaic, Ethiopic, Geor-
|
|
|
|
gian, Glagolitic, Gothic, Grantha, Greek, Gujarati, Gunjala_Gondi, Gur-
|
|
|
|
gian, Glagolitic, Gothic, Grantha, Greek, Gujarati, Gunjala_Gondi, Gur-
|
|
|
|
mukhi, Han, Hangul, Hanifi_Rohingya, Hanunoo, Hatran, Hebrew, Hiragana,
|
|
|
|
mukhi, Han, Hangul, Hanifi_Rohingya, Hanunoo, Hatran, Hebrew, Hiragana,
|
|
|
|
Imperial_Aramaic, Inherited, Inscriptional_Pahlavi, Inscrip-
|
|
|
|
Imperial_Aramaic, Inherited, Inscriptional_Pahlavi, Inscrip-
|
|
|
|
tional_Parthian, Javanese, Kaithi, Kannada, Katakana, Kayah_Li,
|
|
|
|
tional_Parthian, Javanese, Kaithi, Kannada, Katakana, Kayah_Li,
|
|
|
|
Kharoshthi, Khitan_Small_Script, Khmer, Khojki, Khudawadi, Lao, Latin,
|
|
|
|
Kharoshthi, Khitan_Small_Script, Khmer, Khojki, Khudawadi, Lao, Latin,
|
|
|
|
Lepcha, Limbu, Linear_A, Linear_B, Lisu, Lycian, Lydian, Mahajani,
|
|
|
|
Lepcha, Limbu, Linear_A, Linear_B, Lisu, Lycian, Lydian, Mahajani,
|
|
|
|
Makasar, Malayalam, Mandaic, Manichaean, Marchen, Masaram_Gondi, Mede-
|
|
|
|
Makasar, Malayalam, Mandaic, Manichaean, Marchen, Masaram_Gondi, Mede-
|
|
|
|
faidrin, Meetei_Mayek, Mende_Kikakui, Meroitic_Cursive, Meroitic_Hiero-
|
|
|
|
faidrin, Meetei_Mayek, Mende_Kikakui, Meroitic_Cursive, Meroitic_Hiero-
|
|
|
|
glyphs, Miao, Modi, Mongolian, Mro, Multani, Myanmar, Nabataean, Nandi-
|
|
|
|
glyphs, Miao, Modi, Mongolian, Mro, Multani, Myanmar, Nabataean, Nandi-
|
|
|
|
nagari, New_Tai_Lue, Newa, Nko, Nushu, Nyakeng_Puachue_Hmong, Ogham,
|
|
|
|
nagari, New_Tai_Lue, Newa, Nko, Nushu, Nyakeng_Puachue_Hmong, Ogham,
|
|
|
|
Ol_Chiki, Old_Hungarian, Old_Italic, Old_North_Arabian, Old_Permic,
|
|
|
|
Ol_Chiki, Old_Hungarian, Old_Italic, Old_North_Arabian, Old_Permic,
|
|
|
|
Old_Persian, Old_Sogdian, Old_South_Arabian, Old_Turkic, Old_Uyghur,
|
|
|
|
Old_Persian, Old_Sogdian, Old_South_Arabian, Old_Turkic, Old_Uyghur,
|
|
|
|
Oriya, Osage, Osmanya, Pahawh_Hmong, Palmyrene, Pau_Cin_Hau, Phags_Pa,
|
|
|
|
Oriya, Osage, Osmanya, Pahawh_Hmong, Palmyrene, Pau_Cin_Hau, Phags_Pa,
|
|
|
|
Phoenician, Psalter_Pahlavi, Rejang, Runic, Samaritan, Saurashtra,
|
|
|
|
Phoenician, Psalter_Pahlavi, Rejang, Runic, Samaritan, Saurashtra,
|
|
|
|
Sharada, Shavian, Siddham, SignWriting, Sinhala, Sogdian, Sora_Sompeng,
|
|
|
|
Sharada, Shavian, Siddham, SignWriting, Sinhala, Sogdian, Sora_Sompeng,
|
|
|
|
Soyombo, Sundanese, Syloti_Nagri, Syriac, Tagalog, Tagbanwa, Tai_Le,
|
|
|
|
Soyombo, Sundanese, Syloti_Nagri, Syriac, Tagalog, Tagbanwa, Tai_Le,
|
|
|
|
Tai_Tham, Tai_Viet, Takri, Tamil, Tangsa, Tangut, Telugu, Thaana, Thai,
|
|
|
|
Tai_Tham, Tai_Viet, Takri, Tamil, Tangsa, Tangut, Telugu, Thaana, Thai,
|
|
|
|
Tibetan, Tifinagh, Tirhuta, Toto, Ugaritic, Vai, Vithkuqi, Wancho,
|
|
|
|
Tibetan, Tifinagh, Tirhuta, Toto, Ugaritic, Vai, Vithkuqi, Wancho,
|
|
|
|
Warang_Citi, Yezidi, Yi, Zanabazar_Square.
|
|
|
|
Warang_Citi, Yezidi, Yi, Zanabazar_Square.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@ -10802,8 +10811,8 @@ CHARACTER CLASSES
|
|
|
|
word same as \w
|
|
|
|
word same as \w
|
|
|
|
xdigit hexadecimal digit
|
|
|
|
xdigit hexadecimal digit
|
|
|
|
|
|
|
|
|
|
|
|
In PCRE2, POSIX character set names recognize only ASCII characters by
|
|
|
|
In PCRE2, POSIX character set names recognize only ASCII characters by
|
|
|
|
default, but some of them use Unicode properties if PCRE2_UCP is set.
|
|
|
|
default, but some of them use Unicode properties if PCRE2_UCP is set.
|
|
|
|
You can use \Q...\E inside a character class.
|
|
|
|
You can use \Q...\E inside a character class.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@ -10848,8 +10857,8 @@ REPORTED MATCH POINT SETTING
|
|
|
|
|
|
|
|
|
|
|
|
\K set reported start of match
|
|
|
|
\K set reported start of match
|
|
|
|
|
|
|
|
|
|
|
|
From release 10.38 \K is not permitted by default in lookaround asser-
|
|
|
|
From release 10.38 \K is not permitted by default in lookaround asser-
|
|
|
|
tions, for compatibility with Perl. However, if the PCRE2_EXTRA_AL-
|
|
|
|
tions, for compatibility with Perl. However, if the PCRE2_EXTRA_AL-
|
|
|
|
LOW_LOOKAROUND_BSK option is set, the previous behaviour is re-enabled.
|
|
|
|
LOW_LOOKAROUND_BSK option is set, the previous behaviour is re-enabled.
|
|
|
|
When this option is set, \K is honoured in positive assertions, but ig-
|
|
|
|
When this option is set, \K is honoured in positive assertions, but ig-
|
|
|
|
nored in negative ones.
|
|
|
|
nored in negative ones.
|
|
|
|
@ -10870,8 +10879,8 @@ CAPTURING
|
|
|
|
(?|...) non-capture group; reset group numbers for
|
|
|
|
(?|...) non-capture group; reset group numbers for
|
|
|
|
capture groups in each alternative
|
|
|
|
capture groups in each alternative
|
|
|
|
|
|
|
|
|
|
|
|
In non-UTF modes, names may contain underscores and ASCII letters and
|
|
|
|
In non-UTF modes, names may contain underscores and ASCII letters and
|
|
|
|
digits; in UTF modes, any Unicode letters and Unicode decimal digits
|
|
|
|
digits; in UTF modes, any Unicode letters and Unicode decimal digits
|
|
|
|
are permitted. In both cases, a name must not start with a digit.
|
|
|
|
are permitted. In both cases, a name must not start with a digit.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@ -10887,7 +10896,7 @@ COMMENT
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
OPTION SETTING
|
|
|
|
OPTION SETTING
|
|
|
|
Changes of these options within a group are automatically cancelled at
|
|
|
|
Changes of these options within a group are automatically cancelled at
|
|
|
|
the end of the group.
|
|
|
|
the end of the group.
|
|
|
|
|
|
|
|
|
|
|
|
(?i) caseless
|
|
|
|
(?i) caseless
|
|
|
|
@ -10901,7 +10910,7 @@ OPTION SETTING
|
|
|
|
(?-...) unset option(s)
|
|
|
|
(?-...) unset option(s)
|
|
|
|
(?^) unset imnsx options
|
|
|
|
(?^) unset imnsx options
|
|
|
|
|
|
|
|
|
|
|
|
Unsetting x or xx unsets both. Several options may be set at once, and
|
|
|
|
Unsetting x or xx unsets both. Several options may be set at once, and
|
|
|
|
a mixture of setting and unsetting such as (?i-x) is allowed, but there
|
|
|
|
a mixture of setting and unsetting such as (?i-x) is allowed, but there
|
|
|
|
may be only one hyphen. Setting (but no unsetting) is allowed after (?^
|
|
|
|
may be only one hyphen. Setting (but no unsetting) is allowed after (?^
|
|
|
|
for example (?^in). An option setting may appear at the start of a non-
|
|
|
|
for example (?^in). An option setting may appear at the start of a non-
|
|
|
|
@ -10923,11 +10932,11 @@ OPTION SETTING
|
|
|
|
(*UTF) set appropriate UTF mode for the library in use
|
|
|
|
(*UTF) set appropriate UTF mode for the library in use
|
|
|
|
(*UCP) set PCRE2_UCP (use Unicode properties for \d etc)
|
|
|
|
(*UCP) set PCRE2_UCP (use Unicode properties for \d etc)
|
|
|
|
|
|
|
|
|
|
|
|
Note that LIMIT_DEPTH, LIMIT_HEAP, and LIMIT_MATCH can only reduce the
|
|
|
|
Note that LIMIT_DEPTH, LIMIT_HEAP, and LIMIT_MATCH can only reduce the
|
|
|
|
value of the limits set by the caller of pcre2_match() or
|
|
|
|
value of the limits set by the caller of pcre2_match() or
|
|
|
|
pcre2_dfa_match(), not increase them. LIMIT_RECURSION is an obsolete
|
|
|
|
pcre2_dfa_match(), not increase them. LIMIT_RECURSION is an obsolete
|
|
|
|
synonym for LIMIT_DEPTH. The application can lock out the use of (*UTF)
|
|
|
|
synonym for LIMIT_DEPTH. The application can lock out the use of (*UTF)
|
|
|
|
and (*UCP) by setting the PCRE2_NEVER_UTF or PCRE2_NEVER_UCP options,
|
|
|
|
and (*UCP) by setting the PCRE2_NEVER_UTF or PCRE2_NEVER_UCP options,
|
|
|
|
respectively, at compile time.
|
|
|
|
respectively, at compile time.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@ -11048,16 +11057,16 @@ CONDITIONAL PATTERNS
|
|
|
|
(?(VERSION[>]=n.m) test PCRE2 version
|
|
|
|
(?(VERSION[>]=n.m) test PCRE2 version
|
|
|
|
(?(assert) assertion condition
|
|
|
|
(?(assert) assertion condition
|
|
|
|
|
|
|
|
|
|
|
|
Note the ambiguity of (?(R) and (?(Rn) which might be named reference
|
|
|
|
Note the ambiguity of (?(R) and (?(Rn) which might be named reference
|
|
|
|
conditions or recursion tests. Such a condition is interpreted as a
|
|
|
|
conditions or recursion tests. Such a condition is interpreted as a
|
|
|
|
reference condition if the relevant named group exists.
|
|
|
|
reference condition if the relevant named group exists.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
BACKTRACKING CONTROL
|
|
|
|
BACKTRACKING CONTROL
|
|
|
|
|
|
|
|
|
|
|
|
All backtracking control verbs may be in the form (*VERB:NAME). For
|
|
|
|
All backtracking control verbs may be in the form (*VERB:NAME). For
|
|
|
|
(*MARK) the name is mandatory, for the others it is optional. (*SKIP)
|
|
|
|
(*MARK) the name is mandatory, for the others it is optional. (*SKIP)
|
|
|
|
changes its behaviour if :NAME is present. The others just set a name
|
|
|
|
changes its behaviour if :NAME is present. The others just set a name
|
|
|
|
for passing back to the caller, but this is not a name that (*SKIP) can
|
|
|
|
for passing back to the caller, but this is not a name that (*SKIP) can
|
|
|
|
see. The following act immediately they are reached:
|
|
|
|
see. The following act immediately they are reached:
|
|
|
|
|
|
|
|
|
|
|
|
@ -11065,7 +11074,7 @@ BACKTRACKING CONTROL
|
|
|
|
(*FAIL) force backtrack; synonym (*F)
|
|
|
|
(*FAIL) force backtrack; synonym (*F)
|
|
|
|
(*MARK:NAME) set name to be passed back; synonym (*:NAME)
|
|
|
|
(*MARK:NAME) set name to be passed back; synonym (*:NAME)
|
|
|
|
|
|
|
|
|
|
|
|
The following act only when a subsequent match failure causes a back-
|
|
|
|
The following act only when a subsequent match failure causes a back-
|
|
|
|
track to reach them. They all force a match failure, but they differ in
|
|
|
|
track to reach them. They all force a match failure, but they differ in
|
|
|
|
what happens afterwards. Those that advance the start-of-match point do
|
|
|
|
what happens afterwards. Those that advance the start-of-match point do
|
|
|
|
so only if the pattern is not anchored.
|
|
|
|
so only if the pattern is not anchored.
|
|
|
|
@ -11077,7 +11086,7 @@ BACKTRACKING CONTROL
|
|
|
|
(*MARK:NAME); if not found, the (*SKIP) is ignored
|
|
|
|
(*MARK:NAME); if not found, the (*SKIP) is ignored
|
|
|
|
(*THEN) local failure, backtrack to next alternation
|
|
|
|
(*THEN) local failure, backtrack to next alternation
|
|
|
|
|
|
|
|
|
|
|
|
The effect of one of these verbs in a group called as a subroutine is
|
|
|
|
The effect of one of these verbs in a group called as a subroutine is
|
|
|
|
confined to the subroutine call.
|
|
|
|
confined to the subroutine call.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@ -11088,14 +11097,14 @@ CALLOUTS
|
|
|
|
(?C"text") callout with string data
|
|
|
|
(?C"text") callout with string data
|
|
|
|
|
|
|
|
|
|
|
|
The allowed string delimiters are ` ' " ^ % # $ (which are the same for
|
|
|
|
The allowed string delimiters are ` ' " ^ % # $ (which are the same for
|
|
|
|
the start and the end), and the starting delimiter { matched with the
|
|
|
|
the start and the end), and the starting delimiter { matched with the
|
|
|
|
ending delimiter }. To encode the ending delimiter within the string,
|
|
|
|
ending delimiter }. To encode the ending delimiter within the string,
|
|
|
|
double it.
|
|
|
|
double it.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
SEE ALSO
|
|
|
|
SEE ALSO
|
|
|
|
|
|
|
|
|
|
|
|
pcre2pattern(3), pcre2api(3), pcre2callout(3), pcre2matching(3),
|
|
|
|
pcre2pattern(3), pcre2api(3), pcre2callout(3), pcre2matching(3),
|
|
|
|
pcre2(3).
|
|
|
|
pcre2(3).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@ -11108,7 +11117,7 @@ AUTHOR
|
|
|
|
|
|
|
|
|
|
|
|
REVISION
|
|
|
|
REVISION
|
|
|
|
|
|
|
|
|
|
|
|
Last updated: 10 December 2021
|
|
|
|
Last updated: 22 December 2021
|
|
|
|
Copyright (c) 1997-2021 University of Cambridge.
|
|
|
|
Copyright (c) 1997-2021 University of Cambridge.
|
|
|
|
------------------------------------------------------------------------------
|
|
|
|
------------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
|
|
@ -11151,255 +11160,256 @@ UNICODE PROPERTY SUPPORT
|
|
|
|
|
|
|
|
|
|
|
|
When PCRE2 is built with Unicode support, the escape sequences \p{..},
|
|
|
|
When PCRE2 is built with Unicode support, the escape sequences \p{..},
|
|
|
|
\P{..}, and \X can be used. This is not dependent on the PCRE2_UTF set-
|
|
|
|
\P{..}, and \X can be used. This is not dependent on the PCRE2_UTF set-
|
|
|
|
ting. The Unicode properties that can be tested are limited to the
|
|
|
|
ting. The Unicode properties that can be tested are a subset of those
|
|
|
|
general category properties such as Lu for an upper case letter or Nd
|
|
|
|
that Perl supports. Currently they are limited to the general category
|
|
|
|
for a decimal number, the Unicode script names such as Arabic or Han,
|
|
|
|
properties such as Lu for an upper case letter or Nd for a decimal num-
|
|
|
|
Bidi_Class, Bidi_Control, and the derived properties Any and LC (syn-
|
|
|
|
ber, the Unicode script names such as Arabic or Han, Bidi_Class,
|
|
|
|
onym L&). Full lists are given in the pcre2pattern and pcre2syntax doc-
|
|
|
|
Bidi_Control, and the derived properties Any and LC (synonym L&). Full
|
|
|
|
umentation. Only the short names for properties are supported. For ex-
|
|
|
|
lists are given in the pcre2pattern and pcre2syntax documentation. In
|
|
|
|
ample, \p{L} matches a letter. Its longer synonym, \p{Letter}, is not
|
|
|
|
general, only the short names for properties are supported. For exam-
|
|
|
|
supported. Furthermore, in Perl, many properties may optionally be
|
|
|
|
ple, \p{L} matches a letter. Its longer synonym, \p{Letter}, is not
|
|
|
|
prefixed by "Is", for compatibility with Perl 5.6. PCRE2 does not sup-
|
|
|
|
supported. Furthermore, in Perl, many properties may optionally be pre-
|
|
|
|
port this.
|
|
|
|
fixed by "Is", for compatibility with Perl 5.6. PCRE2 does not support
|
|
|
|
|
|
|
|
this.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
WIDE CHARACTERS AND UTF MODES
|
|
|
|
WIDE CHARACTERS AND UTF MODES
|
|
|
|
|
|
|
|
|
|
|
|
Code points less than 256 can be specified in patterns by either braced
|
|
|
|
Code points less than 256 can be specified in patterns by either braced
|
|
|
|
or unbraced hexadecimal escape sequences (for example, \x{b3} or \xb3).
|
|
|
|
or unbraced hexadecimal escape sequences (for example, \x{b3} or \xb3).
|
|
|
|
Larger values have to use braced sequences. Unbraced octal code points
|
|
|
|
Larger values have to use braced sequences. Unbraced octal code points
|
|
|
|
up to \777 are also recognized; larger ones can be coded using \o{...}.
|
|
|
|
up to \777 are also recognized; larger ones can be coded using \o{...}.
|
|
|
|
|
|
|
|
|
|
|
|
The escape sequence \N{U+<hex digits>} is recognized as another way of
|
|
|
|
The escape sequence \N{U+<hex digits>} is recognized as another way of
|
|
|
|
specifying a Unicode character by code point in a UTF mode. It is not
|
|
|
|
specifying a Unicode character by code point in a UTF mode. It is not
|
|
|
|
allowed in non-UTF mode.
|
|
|
|
allowed in non-UTF mode.
|
|
|
|
|
|
|
|
|
|
|
|
In UTF mode, repeat quantifiers apply to complete UTF characters, not
|
|
|
|
In UTF mode, repeat quantifiers apply to complete UTF characters, not
|
|
|
|
to individual code units.
|
|
|
|
to individual code units.
|
|
|
|
|
|
|
|
|
|
|
|
In UTF mode, the dot metacharacter matches one UTF character instead of
|
|
|
|
In UTF mode, the dot metacharacter matches one UTF character instead of
|
|
|
|
a single code unit.
|
|
|
|
a single code unit.
|
|
|
|
|
|
|
|
|
|
|
|
In UTF mode, capture group names are not restricted to ASCII, and may
|
|
|
|
In UTF mode, capture group names are not restricted to ASCII, and may
|
|
|
|
contain any Unicode letters and decimal digits, as well as underscore.
|
|
|
|
contain any Unicode letters and decimal digits, as well as underscore.
|
|
|
|
|
|
|
|
|
|
|
|
The escape sequence \C can be used to match a single code unit in UTF
|
|
|
|
The escape sequence \C can be used to match a single code unit in UTF
|
|
|
|
mode, but its use can lead to some strange effects because it breaks up
|
|
|
|
mode, but its use can lead to some strange effects because it breaks up
|
|
|
|
multi-unit characters (see the description of \C in the pcre2pattern
|
|
|
|
multi-unit characters (see the description of \C in the pcre2pattern
|
|
|
|
documentation). For this reason, there is a build-time option that dis-
|
|
|
|
documentation). For this reason, there is a build-time option that dis-
|
|
|
|
ables support for \C completely. There is also a less draconian com-
|
|
|
|
ables support for \C completely. There is also a less draconian com-
|
|
|
|
pile-time option for locking out the use of \C when a pattern is com-
|
|
|
|
pile-time option for locking out the use of \C when a pattern is com-
|
|
|
|
piled.
|
|
|
|
piled.
|
|
|
|
|
|
|
|
|
|
|
|
The use of \C is not supported by the alternative matching function
|
|
|
|
The use of \C is not supported by the alternative matching function
|
|
|
|
pcre2_dfa_match() when in UTF-8 or UTF-16 mode, that is, when a charac-
|
|
|
|
pcre2_dfa_match() when in UTF-8 or UTF-16 mode, that is, when a charac-
|
|
|
|
ter may consist of more than one code unit. The use of \C in these
|
|
|
|
ter may consist of more than one code unit. The use of \C in these
|
|
|
|
modes provokes a match-time error. Also, the JIT optimization does not
|
|
|
|
modes provokes a match-time error. Also, the JIT optimization does not
|
|
|
|
support \C in these modes. If JIT optimization is requested for a UTF-8
|
|
|
|
support \C in these modes. If JIT optimization is requested for a UTF-8
|
|
|
|
or UTF-16 pattern that contains \C, it will not succeed, and so when
|
|
|
|
or UTF-16 pattern that contains \C, it will not succeed, and so when
|
|
|
|
pcre2_match() is called, the matching will be carried out by the inter-
|
|
|
|
pcre2_match() is called, the matching will be carried out by the inter-
|
|
|
|
pretive function.
|
|
|
|
pretive function.
|
|
|
|
|
|
|
|
|
|
|
|
The character escapes \b, \B, \d, \D, \s, \S, \w, and \W correctly test
|
|
|
|
The character escapes \b, \B, \d, \D, \s, \S, \w, and \W correctly test
|
|
|
|
characters of any code value, but, by default, the characters that
|
|
|
|
characters of any code value, but, by default, the characters that
|
|
|
|
PCRE2 recognizes as digits, spaces, or word characters remain the same
|
|
|
|
PCRE2 recognizes as digits, spaces, or word characters remain the same
|
|
|
|
set as in non-UTF mode, all with code points less than 256. This re-
|
|
|
|
set as in non-UTF mode, all with code points less than 256. This re-
|
|
|
|
mains true even when PCRE2 is built to include Unicode support, because
|
|
|
|
mains true even when PCRE2 is built to include Unicode support, because
|
|
|
|
to do otherwise would slow down matching in many common cases. Note
|
|
|
|
to do otherwise would slow down matching in many common cases. Note
|
|
|
|
that this also applies to \b and \B, because they are defined in terms
|
|
|
|
that this also applies to \b and \B, because they are defined in terms
|
|
|
|
of \w and \W. If you want to test for a wider sense of, say, "digit",
|
|
|
|
of \w and \W. If you want to test for a wider sense of, say, "digit",
|
|
|
|
you can use explicit Unicode property tests such as \p{Nd}. Alterna-
|
|
|
|
you can use explicit Unicode property tests such as \p{Nd}. Alterna-
|
|
|
|
tively, if you set the PCRE2_UCP option, the way that the character es-
|
|
|
|
tively, if you set the PCRE2_UCP option, the way that the character es-
|
|
|
|
capes work is changed so that Unicode properties are used to determine
|
|
|
|
capes work is changed so that Unicode properties are used to determine
|
|
|
|
which characters match. There are more details in the section on
|
|
|
|
which characters match. There are more details in the section on
|
|
|
|
generic character types in the pcre2pattern documentation.
|
|
|
|
generic character types in the pcre2pattern documentation.
|
|
|
|
|
|
|
|
|
|
|
|
Similarly, characters that match the POSIX named character classes are
|
|
|
|
Similarly, characters that match the POSIX named character classes are
|
|
|
|
all low-valued characters, unless the PCRE2_UCP option is set.
|
|
|
|
all low-valued characters, unless the PCRE2_UCP option is set.
|
|
|
|
|
|
|
|
|
|
|
|
However, the special horizontal and vertical white space matching es-
|
|
|
|
However, the special horizontal and vertical white space matching es-
|
|
|
|
capes (\h, \H, \v, and \V) do match all the appropriate Unicode charac-
|
|
|
|
capes (\h, \H, \v, and \V) do match all the appropriate Unicode charac-
|
|
|
|
ters, whether or not PCRE2_UCP is set.
|
|
|
|
ters, whether or not PCRE2_UCP is set.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
UNICODE CASE-EQUIVALENCE
|
|
|
|
UNICODE CASE-EQUIVALENCE
|
|
|
|
|
|
|
|
|
|
|
|
If either PCRE2_UTF or PCRE2_UCP is set, upper/lower case processing
|
|
|
|
If either PCRE2_UTF or PCRE2_UCP is set, upper/lower case processing
|
|
|
|
makes use of Unicode properties except for characters whose code points
|
|
|
|
makes use of Unicode properties except for characters whose code points
|
|
|
|
are less than 128 and that have at most two case-equivalent values. For
|
|
|
|
are less than 128 and that have at most two case-equivalent values. For
|
|
|
|
these, a direct table lookup is used for speed. A few Unicode charac-
|
|
|
|
these, a direct table lookup is used for speed. A few Unicode charac-
|
|
|
|
ters such as Greek sigma have more than two code points that are case-
|
|
|
|
ters such as Greek sigma have more than two code points that are case-
|
|
|
|
equivalent, and these are treated specially. Setting PCRE2_UCP without
|
|
|
|
equivalent, and these are treated specially. Setting PCRE2_UCP without
|
|
|
|
PCRE2_UTF allows Unicode-style case processing for non-UTF character
|
|
|
|
PCRE2_UTF allows Unicode-style case processing for non-UTF character
|
|
|
|
encodings such as UCS-2.
|
|
|
|
encodings such as UCS-2.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
SCRIPT RUNS
|
|
|
|
SCRIPT RUNS
|
|
|
|
|
|
|
|
|
|
|
|
The pattern constructs (*script_run:...) and (*atomic_script_run:...),
|
|
|
|
The pattern constructs (*script_run:...) and (*atomic_script_run:...),
|
|
|
|
with synonyms (*sr:...) and (*asr:...), verify that the string matched
|
|
|
|
with synonyms (*sr:...) and (*asr:...), verify that the string matched
|
|
|
|
within the parentheses is a script run. In concept, a script run is a
|
|
|
|
within the parentheses is a script run. In concept, a script run is a
|
|
|
|
sequence of characters that are all from the same Unicode script. How-
|
|
|
|
sequence of characters that are all from the same Unicode script. How-
|
|
|
|
ever, because some scripts are commonly used together, and because some
|
|
|
|
ever, because some scripts are commonly used together, and because some
|
|
|
|
diacritical and other marks are used with multiple scripts, it is not
|
|
|
|
diacritical and other marks are used with multiple scripts, it is not
|
|
|
|
that simple.
|
|
|
|
that simple.
|
|
|
|
|
|
|
|
|
|
|
|
Every Unicode character has a Script property, mostly with a value cor-
|
|
|
|
Every Unicode character has a Script property, mostly with a value cor-
|
|
|
|
responding to the name of a script, such as Latin, Greek, or Cyrillic.
|
|
|
|
responding to the name of a script, such as Latin, Greek, or Cyrillic.
|
|
|
|
There are also three special values:
|
|
|
|
There are also three special values:
|
|
|
|
|
|
|
|
|
|
|
|
"Unknown" is used for code points that have not been assigned, and also
|
|
|
|
"Unknown" is used for code points that have not been assigned, and also
|
|
|
|
for the surrogate code points. In the PCRE2 32-bit library, characters
|
|
|
|
for the surrogate code points. In the PCRE2 32-bit library, characters
|
|
|
|
whose code points are greater than the Unicode maximum (U+10FFFF),
|
|
|
|
whose code points are greater than the Unicode maximum (U+10FFFF),
|
|
|
|
which are accessible only in non-UTF mode, are assigned the Unknown
|
|
|
|
which are accessible only in non-UTF mode, are assigned the Unknown
|
|
|
|
script.
|
|
|
|
script.
|
|
|
|
|
|
|
|
|
|
|
|
"Common" is used for characters that are used with many scripts. These
|
|
|
|
"Common" is used for characters that are used with many scripts. These
|
|
|
|
include punctuation, emoji, mathematical, musical, and currency sym-
|
|
|
|
include punctuation, emoji, mathematical, musical, and currency sym-
|
|
|
|
bols, and the ASCII digits 0 to 9.
|
|
|
|
bols, and the ASCII digits 0 to 9.
|
|
|
|
|
|
|
|
|
|
|
|
"Inherited" is used for characters such as diacritical marks that mod-
|
|
|
|
"Inherited" is used for characters such as diacritical marks that mod-
|
|
|
|
ify a previous character. These are considered to take on the script of
|
|
|
|
ify a previous character. These are considered to take on the script of
|
|
|
|
the character that they modify.
|
|
|
|
the character that they modify.
|
|
|
|
|
|
|
|
|
|
|
|
Some Inherited characters are used with many scripts, but many of them
|
|
|
|
Some Inherited characters are used with many scripts, but many of them
|
|
|
|
are only normally used with a small number of scripts. For example,
|
|
|
|
are only normally used with a small number of scripts. For example,
|
|
|
|
U+102E0 (Coptic Epact thousands mark) is used only with Arabic and Cop-
|
|
|
|
U+102E0 (Coptic Epact thousands mark) is used only with Arabic and Cop-
|
|
|
|
tic. In order to make it possible to check this, a Unicode property
|
|
|
|
tic. In order to make it possible to check this, a Unicode property
|
|
|
|
called Script Extension exists. Its value is a list of scripts that ap-
|
|
|
|
called Script Extension exists. Its value is a list of scripts that ap-
|
|
|
|
ply to the character. For the majority of characters, the list contains
|
|
|
|
ply to the character. For the majority of characters, the list contains
|
|
|
|
just one script, the same one as the Script property. However, for
|
|
|
|
just one script, the same one as the Script property. However, for
|
|
|
|
characters such as U+102E0 more than one Script is listed. There are
|
|
|
|
characters such as U+102E0 more than one Script is listed. There are
|
|
|
|
also some Common characters that have a single, non-Common script in
|
|
|
|
also some Common characters that have a single, non-Common script in
|
|
|
|
their Script Extension list.
|
|
|
|
their Script Extension list.
|
|
|
|
|
|
|
|
|
|
|
|
The next section describes the basic rules for deciding whether a given
|
|
|
|
The next section describes the basic rules for deciding whether a given
|
|
|
|
string of characters is a script run. Note, however, that there are
|
|
|
|
string of characters is a script run. Note, however, that there are
|
|
|
|
some special cases involving the Chinese Han script, and an additional
|
|
|
|
some special cases involving the Chinese Han script, and an additional
|
|
|
|
constraint for decimal digits. These are covered in subsequent sec-
|
|
|
|
constraint for decimal digits. These are covered in subsequent sec-
|
|
|
|
tions.
|
|
|
|
tions.
|
|
|
|
|
|
|
|
|
|
|
|
Basic script run rules
|
|
|
|
Basic script run rules
|
|
|
|
|
|
|
|
|
|
|
|
A string that is less than two characters long is a script run. This is
|
|
|
|
A string that is less than two characters long is a script run. This is
|
|
|
|
the only case in which an Unknown character can be part of a script
|
|
|
|
the only case in which an Unknown character can be part of a script
|
|
|
|
run. Longer strings are checked using only the Script Extensions prop-
|
|
|
|
run. Longer strings are checked using only the Script Extensions prop-
|
|
|
|
erty, not the basic Script property.
|
|
|
|
erty, not the basic Script property.
|
|
|
|
|
|
|
|
|
|
|
|
If a character's Script Extension property is the single value "Inher-
|
|
|
|
If a character's Script Extension property is the single value "Inher-
|
|
|
|
ited", it is always accepted as part of a script run. This is also true
|
|
|
|
ited", it is always accepted as part of a script run. This is also true
|
|
|
|
for the property "Common", subject to the checking of decimal digits
|
|
|
|
for the property "Common", subject to the checking of decimal digits
|
|
|
|
described below. All the remaining characters in a script run must have
|
|
|
|
described below. All the remaining characters in a script run must have
|
|
|
|
at least one script in common in their Script Extension lists. In set-
|
|
|
|
at least one script in common in their Script Extension lists. In set-
|
|
|
|
theoretic terminology, the intersection of all the sets of scripts must
|
|
|
|
theoretic terminology, the intersection of all the sets of scripts must
|
|
|
|
not be empty.
|
|
|
|
not be empty.
|
|
|
|
|
|
|
|
|
|
|
|
A simple example is an Internet name such as "google.com". The letters
|
|
|
|
A simple example is an Internet name such as "google.com". The letters
|
|
|
|
are all in the Latin script, and the dot is Common, so this string is a
|
|
|
|
are all in the Latin script, and the dot is Common, so this string is a
|
|
|
|
script run. However, the Cyrillic letter "o" looks exactly the same as
|
|
|
|
script run. However, the Cyrillic letter "o" looks exactly the same as
|
|
|
|
the Latin "o"; a string that looks the same, but with Cyrillic "o"s is
|
|
|
|
the Latin "o"; a string that looks the same, but with Cyrillic "o"s is
|
|
|
|
not a script run.
|
|
|
|
not a script run.
|
|
|
|
|
|
|
|
|
|
|
|
More interesting examples involve characters with more than one script
|
|
|
|
More interesting examples involve characters with more than one script
|
|
|
|
in their Script Extension. Consider the following characters:
|
|
|
|
in their Script Extension. Consider the following characters:
|
|
|
|
|
|
|
|
|
|
|
|
U+060C Arabic comma
|
|
|
|
U+060C Arabic comma
|
|
|
|
U+06D4 Arabic full stop
|
|
|
|
U+06D4 Arabic full stop
|
|
|
|
|
|
|
|
|
|
|
|
The first has the Script Extension list Arabic, Hanifi Rohingya, Syr-
|
|
|
|
The first has the Script Extension list Arabic, Hanifi Rohingya, Syr-
|
|
|
|
iac, and Thaana; the second has just Arabic and Hanifi Rohingya. Both
|
|
|
|
iac, and Thaana; the second has just Arabic and Hanifi Rohingya. Both
|
|
|
|
of them could appear in script runs of either Arabic or Hanifi Ro-
|
|
|
|
of them could appear in script runs of either Arabic or Hanifi Ro-
|
|
|
|
hingya. The first could also appear in Syriac or Thaana script runs,
|
|
|
|
hingya. The first could also appear in Syriac or Thaana script runs,
|
|
|
|
but the second could not.
|
|
|
|
but the second could not.
|
|
|
|
|
|
|
|
|
|
|
|
The Chinese Han script
|
|
|
|
The Chinese Han script
|
|
|
|
|
|
|
|
|
|
|
|
The Chinese Han script is commonly used in conjunction with other
|
|
|
|
The Chinese Han script is commonly used in conjunction with other
|
|
|
|
scripts for writing certain languages. Japanese uses the Hiragana and
|
|
|
|
scripts for writing certain languages. Japanese uses the Hiragana and
|
|
|
|
Katakana scripts together with Han; Korean uses Hangul and Han; Tai-
|
|
|
|
Katakana scripts together with Han; Korean uses Hangul and Han; Tai-
|
|
|
|
wanese Mandarin uses Bopomofo and Han. These three combinations are
|
|
|
|
wanese Mandarin uses Bopomofo and Han. These three combinations are
|
|
|
|
treated as special cases when checking script runs and are, in effect,
|
|
|
|
treated as special cases when checking script runs and are, in effect,
|
|
|
|
"virtual scripts". Thus, a script run may contain a mixture of Hira-
|
|
|
|
"virtual scripts". Thus, a script run may contain a mixture of Hira-
|
|
|
|
gana, Katakana, and Han, or a mixture of Hangul and Han, or a mixture
|
|
|
|
gana, Katakana, and Han, or a mixture of Hangul and Han, or a mixture
|
|
|
|
of Bopomofo and Han, but not, for example, a mixture of Hangul and
|
|
|
|
of Bopomofo and Han, but not, for example, a mixture of Hangul and
|
|
|
|
Bopomofo and Han. PCRE2 (like Perl) follows Unicode's Technical Stan-
|
|
|
|
Bopomofo and Han. PCRE2 (like Perl) follows Unicode's Technical Stan-
|
|
|
|
dard 39 ("Unicode Security Mechanisms", http://unicode.org/re-
|
|
|
|
dard 39 ("Unicode Security Mechanisms", http://unicode.org/re-
|
|
|
|
ports/tr39/) in allowing such mixtures.
|
|
|
|
ports/tr39/) in allowing such mixtures.
|
|
|
|
|
|
|
|
|
|
|
|
Decimal digits
|
|
|
|
Decimal digits
|
|
|
|
|
|
|
|
|
|
|
|
Unicode contains many sets of 10 decimal digits in different scripts,
|
|
|
|
Unicode contains many sets of 10 decimal digits in different scripts,
|
|
|
|
and some scripts (including the Common script) contain more than one
|
|
|
|
and some scripts (including the Common script) contain more than one
|
|
|
|
set. Some of these decimal digits them are visually indistinguishable
|
|
|
|
set. Some of these decimal digits them are visually indistinguishable
|
|
|
|
from the common ASCII digits. In addition to the script checking de-
|
|
|
|
from the common ASCII digits. In addition to the script checking de-
|
|
|
|
scribed above, if a script run contains any decimal digits, they must
|
|
|
|
scribed above, if a script run contains any decimal digits, they must
|
|
|
|
all come from the same set of 10 adjacent characters.
|
|
|
|
all come from the same set of 10 adjacent characters.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
VALIDITY OF UTF STRINGS
|
|
|
|
VALIDITY OF UTF STRINGS
|
|
|
|
|
|
|
|
|
|
|
|
When the PCRE2_UTF option is set, the strings passed as patterns and
|
|
|
|
When the PCRE2_UTF option is set, the strings passed as patterns and
|
|
|
|
subjects are (by default) checked for validity on entry to the relevant
|
|
|
|
subjects are (by default) checked for validity on entry to the relevant
|
|
|
|
functions. If an invalid UTF string is passed, a negative error code is
|
|
|
|
functions. If an invalid UTF string is passed, a negative error code is
|
|
|
|
returned. The code unit offset to the offending character can be ex-
|
|
|
|
returned. The code unit offset to the offending character can be ex-
|
|
|
|
tracted from the match data block by calling pcre2_get_startchar(),
|
|
|
|
tracted from the match data block by calling pcre2_get_startchar(),
|
|
|
|
which is used for this purpose after a UTF error.
|
|
|
|
which is used for this purpose after a UTF error.
|
|
|
|
|
|
|
|
|
|
|
|
In some situations, you may already know that your strings are valid,
|
|
|
|
In some situations, you may already know that your strings are valid,
|
|
|
|
and therefore want to skip these checks in order to improve perfor-
|
|
|
|
and therefore want to skip these checks in order to improve perfor-
|
|
|
|
mance, for example in the case of a long subject string that is being
|
|
|
|
mance, for example in the case of a long subject string that is being
|
|
|
|
scanned repeatedly. If you set the PCRE2_NO_UTF_CHECK option at com-
|
|
|
|
scanned repeatedly. If you set the PCRE2_NO_UTF_CHECK option at com-
|
|
|
|
pile time or at match time, PCRE2 assumes that the pattern or subject
|
|
|
|
pile time or at match time, PCRE2 assumes that the pattern or subject
|
|
|
|
it is given (respectively) contains only valid UTF code unit sequences.
|
|
|
|
it is given (respectively) contains only valid UTF code unit sequences.
|
|
|
|
|
|
|
|
|
|
|
|
If you pass an invalid UTF string when PCRE2_NO_UTF_CHECK is set, the
|
|
|
|
If you pass an invalid UTF string when PCRE2_NO_UTF_CHECK is set, the
|
|
|
|
result is undefined and your program may crash or loop indefinitely or
|
|
|
|
result is undefined and your program may crash or loop indefinitely or
|
|
|
|
give incorrect results. There is, however, one mode of matching that
|
|
|
|
give incorrect results. There is, however, one mode of matching that
|
|
|
|
can handle invalid UTF subject strings. This is enabled by passing
|
|
|
|
can handle invalid UTF subject strings. This is enabled by passing
|
|
|
|
PCRE2_MATCH_INVALID_UTF to pcre2_compile() and is discussed below in
|
|
|
|
PCRE2_MATCH_INVALID_UTF to pcre2_compile() and is discussed below in
|
|
|
|
the next section. The rest of this section covers the case when
|
|
|
|
the next section. The rest of this section covers the case when
|
|
|
|
PCRE2_MATCH_INVALID_UTF is not set.
|
|
|
|
PCRE2_MATCH_INVALID_UTF is not set.
|
|
|
|
|
|
|
|
|
|
|
|
Passing PCRE2_NO_UTF_CHECK to pcre2_compile() just disables the UTF
|
|
|
|
Passing PCRE2_NO_UTF_CHECK to pcre2_compile() just disables the UTF
|
|
|
|
check for the pattern; it does not also apply to subject strings. If
|
|
|
|
check for the pattern; it does not also apply to subject strings. If
|
|
|
|
you want to disable the check for a subject string you must pass this
|
|
|
|
you want to disable the check for a subject string you must pass this
|
|
|
|
same option to pcre2_match() or pcre2_dfa_match().
|
|
|
|
same option to pcre2_match() or pcre2_dfa_match().
|
|
|
|
|
|
|
|
|
|
|
|
UTF-16 and UTF-32 strings can indicate their endianness by special code
|
|
|
|
UTF-16 and UTF-32 strings can indicate their endianness by special code
|
|
|
|
knows as a byte-order mark (BOM). The PCRE2 functions do not handle
|
|
|
|
knows as a byte-order mark (BOM). The PCRE2 functions do not handle
|
|
|
|
this, expecting strings to be in host byte order.
|
|
|
|
this, expecting strings to be in host byte order.
|
|
|
|
|
|
|
|
|
|
|
|
Unless PCRE2_NO_UTF_CHECK is set, a UTF string is checked before any
|
|
|
|
Unless PCRE2_NO_UTF_CHECK is set, a UTF string is checked before any
|
|
|
|
other processing takes place. In the case of pcre2_match() and
|
|
|
|
other processing takes place. In the case of pcre2_match() and
|
|
|
|
pcre2_dfa_match() calls with a non-zero starting offset, the check is
|
|
|
|
pcre2_dfa_match() calls with a non-zero starting offset, the check is
|
|
|
|
applied only to that part of the subject that could be inspected during
|
|
|
|
applied only to that part of the subject that could be inspected during
|
|
|
|
matching, and there is a check that the starting offset points to the
|
|
|
|
matching, and there is a check that the starting offset points to the
|
|
|
|
first code unit of a character or to the end of the subject. If there
|
|
|
|
first code unit of a character or to the end of the subject. If there
|
|
|
|
are no lookbehind assertions in the pattern, the check starts at the
|
|
|
|
are no lookbehind assertions in the pattern, the check starts at the
|
|
|
|
starting offset. Otherwise, it starts at the length of the longest
|
|
|
|
starting offset. Otherwise, it starts at the length of the longest
|
|
|
|
lookbehind before the starting offset, or at the start of the subject
|
|
|
|
lookbehind before the starting offset, or at the start of the subject
|
|
|
|
if there are not that many characters before the starting offset. Note
|
|
|
|
if there are not that many characters before the starting offset. Note
|
|
|
|
that the sequences \b and \B are one-character lookbehinds.
|
|
|
|
that the sequences \b and \B are one-character lookbehinds.
|
|
|
|
|
|
|
|
|
|
|
|
In addition to checking the format of the string, there is a check to
|
|
|
|
In addition to checking the format of the string, there is a check to
|
|
|
|
ensure that all code points lie in the range U+0 to U+10FFFF, excluding
|
|
|
|
ensure that all code points lie in the range U+0 to U+10FFFF, excluding
|
|
|
|
the surrogate area. The so-called "non-character" code points are not
|
|
|
|
the surrogate area. The so-called "non-character" code points are not
|
|
|
|
excluded because Unicode corrigendum #9 makes it clear that they should
|
|
|
|
excluded because Unicode corrigendum #9 makes it clear that they should
|
|
|
|
not be.
|
|
|
|
not be.
|
|
|
|
|
|
|
|
|
|
|
|
Characters in the "Surrogate Area" of Unicode are reserved for use by
|
|
|
|
Characters in the "Surrogate Area" of Unicode are reserved for use by
|
|
|
|
UTF-16, where they are used in pairs to encode code points with values
|
|
|
|
UTF-16, where they are used in pairs to encode code points with values
|
|
|
|
greater than 0xFFFF. The code points that are encoded by UTF-16 pairs
|
|
|
|
greater than 0xFFFF. The code points that are encoded by UTF-16 pairs
|
|
|
|
are available independently in the UTF-8 and UTF-32 encodings. (In
|
|
|
|
are available independently in the UTF-8 and UTF-32 encodings. (In
|
|
|
|
other words, the whole surrogate thing is a fudge for UTF-16 which un-
|
|
|
|
other words, the whole surrogate thing is a fudge for UTF-16 which un-
|
|
|
|
fortunately messes up UTF-8 and UTF-32.)
|
|
|
|
fortunately messes up UTF-8 and UTF-32.)
|
|
|
|
|
|
|
|
|
|
|
|
Setting PCRE2_NO_UTF_CHECK at compile time does not disable the error
|
|
|
|
Setting PCRE2_NO_UTF_CHECK at compile time does not disable the error
|
|
|
|
that is given if an escape sequence for an invalid Unicode code point
|
|
|
|
that is given if an escape sequence for an invalid Unicode code point
|
|
|
|
is encountered in the pattern. If you want to allow escape sequences
|
|
|
|
is encountered in the pattern. If you want to allow escape sequences
|
|
|
|
such as \x{d800} (a surrogate code point) you can set the PCRE2_EX-
|
|
|
|
such as \x{d800} (a surrogate code point) you can set the PCRE2_EX-
|
|
|
|
TRA_ALLOW_SURROGATE_ESCAPES extra option. However, this is possible
|
|
|
|
TRA_ALLOW_SURROGATE_ESCAPES extra option. However, this is possible
|
|
|
|
only in UTF-8 and UTF-32 modes, because these values are not repre-
|
|
|
|
only in UTF-8 and UTF-32 modes, because these values are not repre-
|
|
|
|
sentable in UTF-16.
|
|
|
|
sentable in UTF-16.
|
|
|
|
|
|
|
|
|
|
|
|
Errors in UTF-8 strings
|
|
|
|
Errors in UTF-8 strings
|
|
|
|
@ -11412,10 +11422,10 @@ VALIDITY OF UTF STRINGS
|
|
|
|
PCRE2_ERROR_UTF8_ERR4
|
|
|
|
PCRE2_ERROR_UTF8_ERR4
|
|
|
|
PCRE2_ERROR_UTF8_ERR5
|
|
|
|
PCRE2_ERROR_UTF8_ERR5
|
|
|
|
|
|
|
|
|
|
|
|
The string ends with a truncated UTF-8 character; the code specifies
|
|
|
|
The string ends with a truncated UTF-8 character; the code specifies
|
|
|
|
how many bytes are missing (1 to 5). Although RFC 3629 restricts UTF-8
|
|
|
|
how many bytes are missing (1 to 5). Although RFC 3629 restricts UTF-8
|
|
|
|
characters to be no longer than 4 bytes, the encoding scheme (origi-
|
|
|
|
characters to be no longer than 4 bytes, the encoding scheme (origi-
|
|
|
|
nally defined by RFC 2279) allows for up to 6 bytes, and this is
|
|
|
|
nally defined by RFC 2279) allows for up to 6 bytes, and this is
|
|
|
|
checked first; hence the possibility of 4 or 5 missing bytes.
|
|
|
|
checked first; hence the possibility of 4 or 5 missing bytes.
|
|
|
|
|
|
|
|
|
|
|
|
PCRE2_ERROR_UTF8_ERR6
|
|
|
|
PCRE2_ERROR_UTF8_ERR6
|
|
|
|
@ -11425,13 +11435,13 @@ VALIDITY OF UTF STRINGS
|
|
|
|
PCRE2_ERROR_UTF8_ERR10
|
|
|
|
PCRE2_ERROR_UTF8_ERR10
|
|
|
|
|
|
|
|
|
|
|
|
The two most significant bits of the 2nd, 3rd, 4th, 5th, or 6th byte of
|
|
|
|
The two most significant bits of the 2nd, 3rd, 4th, 5th, or 6th byte of
|
|
|
|
the character do not have the binary value 0b10 (that is, either the
|
|
|
|
the character do not have the binary value 0b10 (that is, either the
|
|
|
|
most significant bit is 0, or the next bit is 1).
|
|
|
|
most significant bit is 0, or the next bit is 1).
|
|
|
|
|
|
|
|
|
|
|
|
PCRE2_ERROR_UTF8_ERR11
|
|
|
|
PCRE2_ERROR_UTF8_ERR11
|
|
|
|
PCRE2_ERROR_UTF8_ERR12
|
|
|
|
PCRE2_ERROR_UTF8_ERR12
|
|
|
|
|
|
|
|
|
|
|
|
A character that is valid by the RFC 2279 rules is either 5 or 6 bytes
|
|
|
|
A character that is valid by the RFC 2279 rules is either 5 or 6 bytes
|
|
|
|
long; these code points are excluded by RFC 3629.
|
|
|
|
long; these code points are excluded by RFC 3629.
|
|
|
|
|
|
|
|
|
|
|
|
PCRE2_ERROR_UTF8_ERR13
|
|
|
|
PCRE2_ERROR_UTF8_ERR13
|
|
|
|
@ -11441,8 +11451,8 @@ VALIDITY OF UTF STRINGS
|
|
|
|
|
|
|
|
|
|
|
|
PCRE2_ERROR_UTF8_ERR14
|
|
|
|
PCRE2_ERROR_UTF8_ERR14
|
|
|
|
|
|
|
|
|
|
|
|
A 3-byte character has a value in the range 0xd800 to 0xdfff; this
|
|
|
|
A 3-byte character has a value in the range 0xd800 to 0xdfff; this
|
|
|
|
range of code points are reserved by RFC 3629 for use with UTF-16, and
|
|
|
|
range of code points are reserved by RFC 3629 for use with UTF-16, and
|
|
|
|
so are excluded from UTF-8.
|
|
|
|
so are excluded from UTF-8.
|
|
|
|
|
|
|
|
|
|
|
|
PCRE2_ERROR_UTF8_ERR15
|
|
|
|
PCRE2_ERROR_UTF8_ERR15
|
|
|
|
@ -11451,26 +11461,26 @@ VALIDITY OF UTF STRINGS
|
|
|
|
PCRE2_ERROR_UTF8_ERR18
|
|
|
|
PCRE2_ERROR_UTF8_ERR18
|
|
|
|
PCRE2_ERROR_UTF8_ERR19
|
|
|
|
PCRE2_ERROR_UTF8_ERR19
|
|
|
|
|
|
|
|
|
|
|
|
A 2-, 3-, 4-, 5-, or 6-byte character is "overlong", that is, it codes
|
|
|
|
A 2-, 3-, 4-, 5-, or 6-byte character is "overlong", that is, it codes
|
|
|
|
for a value that can be represented by fewer bytes, which is invalid.
|
|
|
|
for a value that can be represented by fewer bytes, which is invalid.
|
|
|
|
For example, the two bytes 0xc0, 0xae give the value 0x2e, whose cor-
|
|
|
|
For example, the two bytes 0xc0, 0xae give the value 0x2e, whose cor-
|
|
|
|
rect coding uses just one byte.
|
|
|
|
rect coding uses just one byte.
|
|
|
|
|
|
|
|
|
|
|
|
PCRE2_ERROR_UTF8_ERR20
|
|
|
|
PCRE2_ERROR_UTF8_ERR20
|
|
|
|
|
|
|
|
|
|
|
|
The two most significant bits of the first byte of a character have the
|
|
|
|
The two most significant bits of the first byte of a character have the
|
|
|
|
binary value 0b10 (that is, the most significant bit is 1 and the sec-
|
|
|
|
binary value 0b10 (that is, the most significant bit is 1 and the sec-
|
|
|
|
ond is 0). Such a byte can only validly occur as the second or subse-
|
|
|
|
ond is 0). Such a byte can only validly occur as the second or subse-
|
|
|
|
quent byte of a multi-byte character.
|
|
|
|
quent byte of a multi-byte character.
|
|
|
|
|
|
|
|
|
|
|
|
PCRE2_ERROR_UTF8_ERR21
|
|
|
|
PCRE2_ERROR_UTF8_ERR21
|
|
|
|
|
|
|
|
|
|
|
|
The first byte of a character has the value 0xfe or 0xff. These values
|
|
|
|
The first byte of a character has the value 0xfe or 0xff. These values
|
|
|
|
can never occur in a valid UTF-8 string.
|
|
|
|
can never occur in a valid UTF-8 string.
|
|
|
|
|
|
|
|
|
|
|
|
Errors in UTF-16 strings
|
|
|
|
Errors in UTF-16 strings
|
|
|
|
|
|
|
|
|
|
|
|
The following negative error codes are given for invalid UTF-16
|
|
|
|
The following negative error codes are given for invalid UTF-16
|
|
|
|
strings:
|
|
|
|
strings:
|
|
|
|
|
|
|
|
|
|
|
|
PCRE2_ERROR_UTF16_ERR1 Missing low surrogate at end of string
|
|
|
|
PCRE2_ERROR_UTF16_ERR1 Missing low surrogate at end of string
|
|
|
|
@ -11480,7 +11490,7 @@ VALIDITY OF UTF STRINGS
|
|
|
|
|
|
|
|
|
|
|
|
Errors in UTF-32 strings
|
|
|
|
Errors in UTF-32 strings
|
|
|
|
|
|
|
|
|
|
|
|
The following negative error codes are given for invalid UTF-32
|
|
|
|
The following negative error codes are given for invalid UTF-32
|
|
|
|
strings:
|
|
|
|
strings:
|
|
|
|
|
|
|
|
|
|
|
|
PCRE2_ERROR_UTF32_ERR1 Surrogate character (0xd800 to 0xdfff)
|
|
|
|
PCRE2_ERROR_UTF32_ERR1 Surrogate character (0xd800 to 0xdfff)
|
|
|
|
@ -11490,47 +11500,47 @@ VALIDITY OF UTF STRINGS
|
|
|
|
MATCHING IN INVALID UTF STRINGS
|
|
|
|
MATCHING IN INVALID UTF STRINGS
|
|
|
|
|
|
|
|
|
|
|
|
You can run pattern matches on subject strings that may contain invalid
|
|
|
|
You can run pattern matches on subject strings that may contain invalid
|
|
|
|
UTF sequences if you call pcre2_compile() with the PCRE2_MATCH_IN-
|
|
|
|
UTF sequences if you call pcre2_compile() with the PCRE2_MATCH_IN-
|
|
|
|
VALID_UTF option. This is supported by pcre2_match(), including JIT
|
|
|
|
VALID_UTF option. This is supported by pcre2_match(), including JIT
|
|
|
|
matching, but not by pcre2_dfa_match(). When PCRE2_MATCH_INVALID_UTF is
|
|
|
|
matching, but not by pcre2_dfa_match(). When PCRE2_MATCH_INVALID_UTF is
|
|
|
|
set, it forces PCRE2_UTF to be set as well. Note, however, that the
|
|
|
|
set, it forces PCRE2_UTF to be set as well. Note, however, that the
|
|
|
|
pattern itself must be a valid UTF string.
|
|
|
|
pattern itself must be a valid UTF string.
|
|
|
|
|
|
|
|
|
|
|
|
Setting PCRE2_MATCH_INVALID_UTF does not affect what pcre2_compile()
|
|
|
|
Setting PCRE2_MATCH_INVALID_UTF does not affect what pcre2_compile()
|
|
|
|
generates, but if pcre2_jit_compile() is subsequently called, it does
|
|
|
|
generates, but if pcre2_jit_compile() is subsequently called, it does
|
|
|
|
generate different code. If JIT is not used, the option affects the be-
|
|
|
|
generate different code. If JIT is not used, the option affects the be-
|
|
|
|
haviour of the interpretive code in pcre2_match(). When PCRE2_MATCH_IN-
|
|
|
|
haviour of the interpretive code in pcre2_match(). When PCRE2_MATCH_IN-
|
|
|
|
VALID_UTF is set at compile time, PCRE2_NO_UTF_CHECK is ignored at
|
|
|
|
VALID_UTF is set at compile time, PCRE2_NO_UTF_CHECK is ignored at
|
|
|
|
match time.
|
|
|
|
match time.
|
|
|
|
|
|
|
|
|
|
|
|
In this mode, an invalid code unit sequence in the subject never
|
|
|
|
In this mode, an invalid code unit sequence in the subject never
|
|
|
|
matches any pattern item. It does not match dot, it does not match
|
|
|
|
matches any pattern item. It does not match dot, it does not match
|
|
|
|
\p{Any}, it does not even match negative items such as [^X]. A lookbe-
|
|
|
|
\p{Any}, it does not even match negative items such as [^X]. A lookbe-
|
|
|
|
hind assertion fails if it encounters an invalid sequence while moving
|
|
|
|
hind assertion fails if it encounters an invalid sequence while moving
|
|
|
|
the current point backwards. In other words, an invalid UTF code unit
|
|
|
|
the current point backwards. In other words, an invalid UTF code unit
|
|
|
|
sequence acts as a barrier which no match can cross.
|
|
|
|
sequence acts as a barrier which no match can cross.
|
|
|
|
|
|
|
|
|
|
|
|
You can also think of this as the subject being split up into fragments
|
|
|
|
You can also think of this as the subject being split up into fragments
|
|
|
|
of valid UTF, delimited internally by invalid code unit sequences. The
|
|
|
|
of valid UTF, delimited internally by invalid code unit sequences. The
|
|
|
|
pattern is matched fragment by fragment. The result of a successful
|
|
|
|
pattern is matched fragment by fragment. The result of a successful
|
|
|
|
match, however, is given as code unit offsets in the entire subject
|
|
|
|
match, however, is given as code unit offsets in the entire subject
|
|
|
|
string in the usual way. There are a few points to consider:
|
|
|
|
string in the usual way. There are a few points to consider:
|
|
|
|
|
|
|
|
|
|
|
|
The internal boundaries are not interpreted as the beginnings or ends
|
|
|
|
The internal boundaries are not interpreted as the beginnings or ends
|
|
|
|
of lines and so do not match circumflex or dollar characters in the
|
|
|
|
of lines and so do not match circumflex or dollar characters in the
|
|
|
|
pattern.
|
|
|
|
pattern.
|
|
|
|
|
|
|
|
|
|
|
|
If pcre2_match() is called with an offset that points to an invalid
|
|
|
|
If pcre2_match() is called with an offset that points to an invalid
|
|
|
|
UTF-sequence, that sequence is skipped, and the match starts at the
|
|
|
|
UTF-sequence, that sequence is skipped, and the match starts at the
|
|
|
|
next valid UTF character, or the end of the subject.
|
|
|
|
next valid UTF character, or the end of the subject.
|
|
|
|
|
|
|
|
|
|
|
|
At internal fragment boundaries, \b and \B behave in the same way as at
|
|
|
|
At internal fragment boundaries, \b and \B behave in the same way as at
|
|
|
|
the beginning and end of the subject. For example, a sequence such as
|
|
|
|
the beginning and end of the subject. For example, a sequence such as
|
|
|
|
\bWORD\b would match an instance of WORD that is surrounded by invalid
|
|
|
|
\bWORD\b would match an instance of WORD that is surrounded by invalid
|
|
|
|
UTF code units.
|
|
|
|
UTF code units.
|
|
|
|
|
|
|
|
|
|
|
|
Using PCRE2_MATCH_INVALID_UTF, an application can run matches on arbi-
|
|
|
|
Using PCRE2_MATCH_INVALID_UTF, an application can run matches on arbi-
|
|
|
|
trary data, knowing that any matched strings that are returned are
|
|
|
|
trary data, knowing that any matched strings that are returned are
|
|
|
|
valid UTF. This can be useful when searching for UTF text in executable
|
|
|
|
valid UTF. This can be useful when searching for UTF text in executable
|
|
|
|
or other binary files.
|
|
|
|
or other binary files.
|
|
|
|
|
|
|
|
|
|
|
|
@ -11538,13 +11548,13 @@ MATCHING IN INVALID UTF STRINGS
|
|
|
|
AUTHOR
|
|
|
|
AUTHOR
|
|
|
|
|
|
|
|
|
|
|
|
Philip Hazel
|
|
|
|
Philip Hazel
|
|
|
|
University Computing Service
|
|
|
|
Retired from University Computing Service
|
|
|
|
Cambridge, England.
|
|
|
|
Cambridge, England.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
REVISION
|
|
|
|
REVISION
|
|
|
|
|
|
|
|
|
|
|
|
Last updated: 08 December 2021
|
|
|
|
Last updated: 22 December 2021
|
|
|
|
Copyright (c) 1997-2021 University of Cambridge.
|
|
|
|
Copyright (c) 1997-2021 University of Cambridge.
|
|
|
|
------------------------------------------------------------------------------
|
|
|
|
------------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
|
|
|
Philip Hazel