src/external/pcre2-10.32/doc/pcre2compat.3

   1 .TH PCRE2COMPAT 3 "28 July 2018" "PCRE2 10.32"
   2 .SH NAME
   3 PCRE2 - Perl-compatible regular expressions (revised API)
   4 .SH "DIFFERENCES BETWEEN PCRE2 AND PERL"
   5 .rs
   6 .sp
   7 This document describes the differences in the ways that PCRE2 and Perl handle
   8 regular expressions. The differences described here are with respect to Perl
   9 versions 5.26, but as both Perl and PCRE2 are continually changing, the
  10 information may sometimes be out of date.
  11 .P
  12 1. PCRE2 has only a subset of Perl's Unicode support. Details of what it does
  13 have are given in the
  14 .\" HREF
  15 \fBpcre2unicode\fP
  16 .\"
  17 page.
  18 .P
  19 2. Like Perl, PCRE2 allows repeat quantifiers on parenthesized assertions, but
  20 they do not mean what you might think. For example, (?!a){3} does not assert
  21 that the next three characters are not "a". It just asserts that the next
  22 character is not "a" three times (in principle; PCRE2 optimizes this to run the
  23 assertion just once). Perl allows some repeat quantifiers on other assertions,
  24 for example, \eb* (but not \eb{3}), but these do not seem to have any use.
  25 .P
  26 3. Capturing subpatterns that occur inside negative lookaround assertions are
  27 counted, but their entries in the offsets vector are set only when a negative
  28 assertion is a condition that has a matching branch (that is, the condition is
  29 false).
  30 .P
  31 4. The following Perl escape sequences are not supported: \eF, \el, \eL, \eu,
  32 \eU, and \eN when followed by a character name. \eN on its own, matching a
  33 non-newline character, and \eN{U+dd..}, matching a Unicode code point, are
  34 supported. The escapes that modify the case of following letters are
  35 implemented by Perl's general string-handling and are not part of its pattern
  36 matching engine. If any of these are encountered by PCRE2, an error is
  37 generated by default. However, if the PCRE2_ALT_BSUX option is set, \eU and \eu
  38 are interpreted as ECMAScript interprets them.
  39 .P
  40 5. The Perl escape sequences \ep, \eP, and \eX are supported only if PCRE2 is
  41 built with Unicode support (the default). The properties that can be tested
  42 with \ep and \eP are limited to the general category properties such as Lu and
  43 Nd, script names such as Greek or Han, and the derived properties Any and L&.
  44 PCRE2 does support the Cs (surrogate) property, which Perl does not; the Perl
  45 documentation says "Because Perl hides the need for the user to understand the
  46 internal representation of Unicode characters, there is no need to implement
  47 the somewhat messy concept of surrogates."
  48 .P
  49 6. PCRE2 supports the \eQ...\eE escape for quoting substrings. Characters
  50 in between are treated as literals. However, this is slightly different from
  51 Perl in that $ and @ are also handled as literals inside the quotes. In Perl,
  52 they cause variable interpolation (but of course PCRE2 does not have
  53 variables). Also, Perl does "double-quotish backslash interpolation" on any
  54 backslashes between \eQ and \eE which, its documentation says, "may lead to
  55 confusing results". PCRE2 treats a backslash between \eQ and \eE just like any
  56 other character. Note the following examples:
  57 .sp
  58     Pattern            PCRE2 matches     Perl matches
  59 .sp
  60 .\" JOIN
  61     \eQabc$xyz\eE        abc$xyz           abc followed by the
  62                                            contents of $xyz
  63     \eQabc\e$xyz\eE       abc\e$xyz          abc\e$xyz
  64     \eQabc\eE\e$\eQxyz\eE   abc$xyz           abc$xyz
  65     \eQA\eB\eE            A\eB               A\eB
  66     \eQ\e\eE              \e                 \e\eE
  67 .sp
  68 The \eQ...\eE sequence is recognized both inside and outside character classes.
  69 .P
  70 7. Fairly obviously, PCRE2 does not support the (?{code}) and (??{code})
  71 constructions. However, PCRE2 does have a "callout" feature, which allows an
  72 external function to be called during pattern matching. See the
  73 .\" HREF
  74 \fBpcre2callout\fP
  75 .\"
  76 documentation for details.
  77 .P
  78 8. Subroutine calls (whether recursive or not) were treated as atomic groups up
  79 to PCRE2 release 10.23, but from release 10.30 this changed, and backtracking
  80 into subroutine calls is now supported, as in Perl.
  81 .P
  82 9. If any of the backtracking control verbs are used in a subpattern that is
  83 called as a subroutine (whether or not recursively), their effect is confined
  84 to that subpattern; it does not extend to the surrounding pattern. This is not
  85 always the case in Perl. In particular, if (*THEN) is present in a group that
  86 is called as a subroutine, its action is limited to that group, even if the
  87 group does not contain any | characters. Note that such subpatterns are
  88 processed as anchored at the point where they are tested.
  89 .P
  90 10. If a pattern contains more than one backtracking control verb, the first
  91 one that is backtracked onto acts. For example, in the pattern
  92 A(*COMMIT)B(*PRUNE)C a failure in B triggers (*COMMIT), but a failure in C
  93 triggers (*PRUNE). Perl's behaviour is more complex; in many cases it is the
  94 same as PCRE2, but there are cases where it differs.
  95 .P
  96 11. Most backtracking verbs in assertions have their normal actions. They are
  97 not confined to the assertion.
  98 .P
  99 12. There are some differences that are concerned with the settings of captured
 100 strings when part of a pattern is repeated. For example, matching "aba" against
 101 the pattern /^(a(b)?)+$/ in Perl leaves $2 unset, but in PCRE2 it is set to
 102 "b".
 103 .P
 104 13. PCRE2's handling of duplicate subpattern numbers and duplicate subpattern
 105 names is not as general as Perl's. This is a consequence of the fact the PCRE2
 106 works internally just with numbers, using an external table to translate
 107 between numbers and names. In particular, a pattern such as (?|(?<a>A)|(?<b>B),
 108 where the two capturing parentheses have the same number but different names,
 109 is not supported, and causes an error at compile time. If it were allowed, it
 110 would not be possible to distinguish which parentheses matched, because both
 111 names map to capturing subpattern number 1. To avoid this confusing situation,
 112 an error is given at compile time.
 113 .P
 114 14. Perl used to recognize comments in some places that PCRE2 does not, for
 115 example, between the ( and ? at the start of a subpattern. If the /x modifier
 116 is set, Perl allowed white space between ( and ? though the latest Perls give
 117 an error (for a while it was just deprecated). There may still be some cases
 118 where Perl behaves differently.
 119 .P
 120 15. Perl, when in warning mode, gives warnings for character classes such as
 121 [A-\ed] or [a-[:digit:]]. It then treats the hyphens as literals. PCRE2 has no
 122 warning features, so it gives an error in these cases because they are almost
 123 certainly user mistakes.
 124 .P
 125 16. In PCRE2, the upper/lower case character properties Lu and Ll are not
 126 affected when case-independent matching is specified. For example, \ep{Lu}
 127 always matches an upper case letter. I think Perl has changed in this respect;
 128 in the release at the time of writing (5.24), \ep{Lu} and \ep{Ll} match all
 129 letters, regardless of case, when case independence is specified.
 130 .P
 131 17. PCRE2 provides some extensions to the Perl regular expression facilities.
 132 Perl 5.10 includes new features that are not in earlier versions of Perl, some
 133 of which (such as named parentheses) were in PCRE2 for some time before. This
 134 list is with respect to Perl 5.26:
 135 .sp
 136 (a) Although lookbehind assertions in PCRE2 must match fixed length strings,
 137 each alternative branch of a lookbehind assertion can match a different length
 138 of string. Perl requires them all to have the same length.
 139 .sp
 140 (b) From PCRE2 10.23, backreferences to groups of fixed length are supported
 141 in lookbehinds, provided that there is no possibility of referencing a
 142 non-unique number or name. Perl does not support backreferences in lookbehinds.
 143 .sp
 144 (c) If PCRE2_DOLLAR_ENDONLY is set and PCRE2_MULTILINE is not set, the $
 145 meta-character matches only at the very end of the string.
 146 .sp
 147 (d) A backslash followed by a letter with no special meaning is faulted. (Perl
 148 can be made to issue a warning.)
 149 .sp
 150 (e) If PCRE2_UNGREEDY is set, the greediness of the repetition quantifiers is
 151 inverted, that is, by default they are not greedy, but if followed by a
 152 question mark they are.
 153 .sp
 154 (f) PCRE2_ANCHORED can be used at matching time to force a pattern to be tried
 155 only at the first matching position in the subject string.
 156 .sp
 157 (g) The PCRE2_NOTBOL, PCRE2_NOTEOL, PCRE2_NOTEMPTY and PCRE2_NOTEMPTY_ATSTART
 158 options have no Perl equivalents.
 159 .sp
 160 (h) The \eR escape sequence can be restricted to match only CR, LF, or CRLF
 161 by the PCRE2_BSR_ANYCRLF option.
 162 .sp
 163 (i) The callout facility is PCRE2-specific. Perl supports codeblocks and
 164 variable interpolation, but not general hooks on every match.
 165 .sp
 166 (j) The partial matching facility is PCRE2-specific.
 167 .sp
 168 (k) The alternative matching function (\fBpcre2_dfa_match()\fP matches in a
 169 different way and is not Perl-compatible.
 170 .sp
 171 (l) PCRE2 recognizes some special sequences such as (*CR) or (*NO_JIT) at
 172 the start of a pattern that set overall options that cannot be changed within
 173 the pattern.
 174 .P
 175 18. The Perl /a modifier restricts /d numbers to pure ascii, and the /aa
 176 modifier restricts /i case-insensitive matching to pure ascii, ignoring Unicode
 177 rules. This separation cannot be represented with PCRE2_UCP.
 178 .P
 179 19. Perl has different limits than PCRE2. See the
 180 .\" HREF
 181 \fBpcre2limit\fP
 182 .\"
 183 documentation for details. Perl went with 5.10 from recursion to iteration
 184 keeping the intermediate matches on the heap, which is ~10% slower but does not
 185 fall into any stack-overflow limit. PCRE2 made a similar change at release
 186 10.30, and also has many build-time and run-time customizable limits.
 187 .
 188 .
 189 .SH AUTHOR
 190 .rs
 191 .sp
 192 .nf
 193 Philip Hazel
 194 University Computing Service
 195 Cambridge, England.
 196 .fi
 197 .
 198 .
 199 .SH REVISION
 200 .rs
 201 .sp
 202 .nf
 203 Last updated: 28 July 2018
 204 Copyright (c) 1997-2018 University of Cambridge.
 205 .fi