• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<title>pcre2compat specification</title>
4</head>
5<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6<h1>pcre2compat 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>
16DIFFERENCES BETWEEN PCRE2 AND PERL
17</b><br>
18<P>
19This document describes the differences in the ways that PCRE2 and Perl handle
20regular expressions. The differences described here are with respect to Perl
21versions 5.10 and above.
22</P>
23<P>
241. PCRE2 has only a subset of Perl's Unicode support. Details of what it does
25have are given in the
26<a href="pcre2unicode.html"><b>pcre2unicode</b></a>
27page.
28</P>
29<P>
302. PCRE2 allows repeat quantifiers only on parenthesized assertions, but they
31do not mean what you might think. For example, (?!a){3} does not assert that
32the next three characters are not "a". It just asserts that the next character
33is not "a" three times (in principle: PCRE2 optimizes this to run the assertion
34just once). Perl allows repeat quantifiers on other assertions such as \b, but
35these do not seem to have any use.
36</P>
37<P>
383. Capturing subpatterns that occur inside negative lookahead assertions are
39counted, but their entries in the offsets vector are never set. Perl sometimes
40(but not always) sets its numerical variables from inside negative assertions.
41</P>
42<P>
434. The following Perl escape sequences are not supported: \l, \u, \L,
44\U, and \N when followed by a character name or Unicode value. (\N on its
45own, matching a non-newline character, is supported.) In fact these are
46implemented by Perl's general string-handling and are not part of its pattern
47matching engine. If any of these are encountered by PCRE2, an error is
48generated by default. However, if the PCRE2_ALT_BSUX option is set,
49\U and \u are interpreted as ECMAScript interprets them.
50</P>
51<P>
525. The Perl escape sequences \p, \P, and \X are supported only if PCRE2 is
53built with Unicode support. The properties that can be tested with \p and \P
54are limited to the general category properties such as Lu and Nd, script names
55such as Greek or Han, and the derived properties Any and L&. PCRE2 does support
56the Cs (surrogate) property, which Perl does not; the Perl documentation says
57"Because Perl hides the need for the user to understand the internal
58representation of Unicode characters, there is no need to implement the
59somewhat messy concept of surrogates."
60</P>
61<P>
626. PCRE2 does support the \Q...\E escape for quoting substrings. Characters
63in between are treated as literals. This is slightly different from Perl in
64that $ and @ are also handled as literals inside the quotes. In Perl, they
65cause variable interpolation (but of course PCRE2 does not have variables).
66Note the following examples:
67<pre>
68    Pattern            PCRE2 matches      Perl matches
69
70    \Qabc$xyz\E        abc$xyz           abc followed by the contents of $xyz
71    \Qabc\$xyz\E       abc\$xyz          abc\$xyz
72    \Qabc\E\$\Qxyz\E   abc$xyz           abc$xyz
73</pre>
74The \Q...\E sequence is recognized both inside and outside character classes.
75</P>
76<P>
777. Fairly obviously, PCRE2 does not support the (?{code}) and (??{code})
78constructions. However, there is support for recursive patterns. This is not
79available in Perl 5.8, but it is in Perl 5.10. Also, the PCRE2 "callout"
80feature allows an external function to be called during pattern matching. See
81the
82<a href="pcre2callout.html"><b>pcre2callout</b></a>
83documentation for details.
84</P>
85<P>
868. Subroutine calls (whether recursive or not) are treated as atomic groups.
87Atomic recursion is like Python, but unlike Perl. Captured values that are set
88outside a subroutine call can be referenced from inside in PCRE2, but not in
89Perl. There is a discussion that explains these differences in more detail in
90the
91<a href="pcre2pattern.html#recursiondifference">section on recursion differences from Perl</a>
92in the
93<a href="pcre2pattern.html"><b>pcre2pattern</b></a>
94page.
95</P>
96<P>
979. If any of the backtracking control verbs are used in a subpattern that is
98called as a subroutine (whether or not recursively), their effect is confined
99to that subpattern; it does not extend to the surrounding pattern. This is not
100always the case in Perl. In particular, if (*THEN) is present in a group that
101is called as a subroutine, its action is limited to that group, even if the
102group does not contain any | characters. Note that such subpatterns are
103processed as anchored at the point where they are tested.
104</P>
105<P>
10610. If a pattern contains more than one backtracking control verb, the first
107one that is backtracked onto acts. For example, in the pattern
108A(*COMMIT)B(*PRUNE)C a failure in B triggers (*COMMIT), but a failure in C
109triggers (*PRUNE). Perl's behaviour is more complex; in many cases it is the
110same as PCRE2, but there are examples where it differs.
111</P>
112<P>
11311. Most backtracking verbs in assertions have their normal actions. They are
114not confined to the assertion.
115</P>
116<P>
11712. There are some differences that are concerned with the settings of captured
118strings when part of a pattern is repeated. For example, matching "aba" against
119the pattern /^(a(b)?)+$/ in Perl leaves $2 unset, but in PCRE2 it is set to
120"b".
121</P>
122<P>
12313. PCRE2's handling of duplicate subpattern numbers and duplicate subpattern
124names is not as general as Perl's. This is a consequence of the fact the PCRE2
125works internally just with numbers, using an external table to translate
126between numbers and names. In particular, a pattern such as (?|(?&#60;a&#62;A)|(?&#60;b)B),
127where the two capturing parentheses have the same number but different names,
128is not supported, and causes an error at compile time. If it were allowed, it
129would not be possible to distinguish which parentheses matched, because both
130names map to capturing subpattern number 1. To avoid this confusing situation,
131an error is given at compile time.
132</P>
133<P>
13414. Perl recognizes comments in some places that PCRE2 does not, for example,
135between the ( and ? at the start of a subpattern. If the /x modifier is set,
136Perl allows white space between ( and ? (though current Perls warn that this is
137deprecated) but PCRE2 never does, even if the PCRE2_EXTENDED option is set.
138</P>
139<P>
14015. Perl, when in warning mode, gives warnings for character classes such as
141[A-\d] or [a-[:digit:]]. It then treats the hyphens as literals. PCRE2 has no
142warning features, so it gives an error in these cases because they are almost
143certainly user mistakes.
144</P>
145<P>
14616. In PCRE2, the upper/lower case character properties Lu and Ll are not
147affected when case-independent matching is specified. For example, \p{Lu}
148always matches an upper case letter. I think Perl has changed in this respect;
149in the release at the time of writing (5.16), \p{Lu} and \p{Ll} match all
150letters, regardless of case, when case independence is specified.
151</P>
152<P>
15317. PCRE2 provides some extensions to the Perl regular expression facilities.
154Perl 5.10 includes new features that are not in earlier versions of Perl, some
155of which (such as named parentheses) have been in PCRE2 for some time. This
156list is with respect to Perl 5.10:
157<br>
158<br>
159(a) Although lookbehind assertions in PCRE2 must match fixed length strings,
160each alternative branch of a lookbehind assertion can match a different length
161of string. Perl requires them all to have the same length.
162<br>
163<br>
164(b) If PCRE2_DOLLAR_ENDONLY is set and PCRE2_MULTILINE is not set, the $
165meta-character matches only at the very end of the string.
166<br>
167<br>
168(c) A backslash followed by a letter with no special meaning is faulted. (Perl
169can be made to issue a warning.)
170<br>
171<br>
172(d) If PCRE2_UNGREEDY is set, the greediness of the repetition quantifiers is
173inverted, that is, by default they are not greedy, but if followed by a
174question mark they are.
175<br>
176<br>
177(e) PCRE2_ANCHORED can be used at matching time to force a pattern to be tried
178only at the first matching position in the subject string.
179<br>
180<br>
181(f) The PCRE2_NOTBOL, PCRE2_NOTEOL, PCRE2_NOTEMPTY, PCRE2_NOTEMPTY_ATSTART, and
182PCRE2_NO_AUTO_CAPTURE options have no Perl equivalents.
183<br>
184<br>
185(g) The \R escape sequence can be restricted to match only CR, LF, or CRLF
186by the PCRE2_BSR_ANYCRLF option.
187<br>
188<br>
189(h) The callout facility is PCRE2-specific.
190<br>
191<br>
192(i) The partial matching facility is PCRE2-specific.
193<br>
194<br>
195(j) The alternative matching function (<b>pcre2_dfa_match()</b> matches in a
196different way and is not Perl-compatible.
197<br>
198<br>
199(k) PCRE2 recognizes some special sequences such as (*CR) at the start of
200a pattern that set overall options that cannot be changed within the pattern.
201</P>
202<br><b>
203AUTHOR
204</b><br>
205<P>
206Philip Hazel
207<br>
208University Computing Service
209<br>
210Cambridge, England.
211<br>
212</P>
213<br><b>
214REVISION
215</b><br>
216<P>
217Last updated: 15 March 2015
218<br>
219Copyright &copy; 1997-2015 University of Cambridge.
220<br>
221<p>
222Return to the <a href="index.html">PCRE2 index page</a>.
223</p>
224