release/src/router/pcre/doc/pcrecompat.3

   1 .TH PCRECOMPAT 3 "24 June 2012" "PCRE 8.30"
   2 .SH NAME
   3 PCRE - Perl-compatible regular expressions
   4 .SH "DIFFERENCES BETWEEN PCRE AND PERL"
   5 .rs
   6 .sp
   7 This document describes the differences in the ways that PCRE and Perl handle
   8 regular expressions. The differences described here are with respect to Perl
   9 versions 5.10 and above.
  10 .P
  11 1. PCRE has only a subset of Perl's Unicode support. Details of what it does
  12 have are given in the
  13 .\" HREF
  14 \fBpcreunicode\fP
  15 .\"
  16 page.
  17 .P
  18 2. PCRE allows repeat quantifiers only on parenthesized assertions, but they do
  19 not mean what you might think. For example, (?!a){3} does not assert that the
  20 next three characters are not "a". It just asserts that the next character is
  21 not "a" three times (in principle: PCRE optimizes this to run the assertion
  22 just once). Perl allows repeat quantifiers on other assertions such as \eb, but
  23 these do not seem to have any use.
  24 .P
  25 3. Capturing subpatterns that occur inside negative lookahead assertions are
  26 counted, but their entries in the offsets vector are never set. Perl sets its
  27 numerical variables from any such patterns that are matched before the
  28 assertion fails to match something (thereby succeeding), but only if the
  29 negative lookahead assertion contains just one branch.
  30 .P
  31 4. Though binary zero characters are supported in the subject string, they are
  32 not allowed in a pattern string because it is passed as a normal C string,
  33 terminated by zero. The escape sequence \e0 can be used in the pattern to
  34 represent a binary zero.
  35 .P
  36 5. The following Perl escape sequences are not supported: \el, \eu, \eL,
  37 \eU, and \eN when followed by a character name or Unicode value. (\eN on its
  38 own, matching a non-newline character, is supported.) In fact these are
  39 implemented by Perl's general string-handling and are not part of its pattern
  40 matching engine. If any of these are encountered by PCRE, an error is
  41 generated by default. However, if the PCRE_JAVASCRIPT_COMPAT option is set,
  42 \eU and \eu are interpreted as JavaScript interprets them.
  43 .P
  44 6. The Perl escape sequences \ep, \eP, and \eX are supported only if PCRE is
  45 built with Unicode character property support. The properties that can be
  46 tested with \ep and \eP are limited to the general category properties such as
  47 Lu and Nd, script names such as Greek or Han, and the derived properties Any
  48 and L&. PCRE does support the Cs (surrogate) property, which Perl does not; the
  49 Perl documentation says "Because Perl hides the need for the user to understand
  50 the internal representation of Unicode characters, there is no need to
  51 implement the somewhat messy concept of surrogates."
  52 .P
  53 7. PCRE does support the \eQ...\eE escape for quoting substrings. Characters in
  54 between are treated as literals. This is slightly different from Perl in that $
  55 and @ are also handled as literals inside the quotes. In Perl, they cause
  56 variable interpolation (but of course PCRE does not have variables). Note the
  57 following examples:
  58 .sp
  59     Pattern            PCRE matches      Perl matches
  60 .sp
  61 .\" JOIN
  62     \eQabc$xyz\eE        abc$xyz           abc followed by the
  63                                            contents of $xyz
  64     \eQabc\e$xyz\eE       abc\e$xyz          abc\e$xyz
  65     \eQabc\eE\e$\eQxyz\eE   abc$xyz           abc$xyz
  66 .sp
  67 The \eQ...\eE sequence is recognized both inside and outside character classes.
  68 .P
  69 8. Fairly obviously, PCRE does not support the (?{code}) and (??{code})
  70 constructions. However, there is support for recursive patterns. This is not
  71 available in Perl 5.8, but it is in Perl 5.10. Also, the PCRE "callout"
  72 feature allows an external function to be called during pattern matching. See
  73 the
  74 .\" HREF
  75 \fBpcrecallout\fP
  76 .\"
  77 documentation for details.
  78 .P
  79 9. Subpatterns that are called as subroutines (whether or not recursively) are
  80 always treated as atomic groups in PCRE. This is like Python, but unlike Perl.
  81 Captured values that are set outside a subroutine call can be reference from
  82 inside in PCRE, but not in Perl. There is a discussion that explains these
  83 differences in more detail in the
  84 .\" HTML <a href="pcrepattern.html#recursiondifference">
  85 .\" </a>
  86 section on recursion differences from Perl
  87 .\"
  88 in the
  89 .\" HREF
  90 \fBpcrepattern\fP
  91 .\"
  92 page.
  93 .P
  94 10. If any of the backtracking control verbs are used in an assertion or in a
  95 subpattern that is called as a subroutine (whether or not recursively), their
  96 effect is confined to that subpattern; it does not extend to the surrounding
  97 pattern. This is not always the case in Perl. In particular, if (*THEN) is
  98 present in a group that is called as a subroutine, its action is limited to
  99 that group, even if the group does not contain any | characters. There is one
 100 exception to this: the name from a *(MARK), (*PRUNE), or (*THEN) that is
 101 encountered in a successful positive assertion \fIis\fP passed back when a
 102 match succeeds (compare capturing parentheses in assertions). Note that such
 103 subpatterns are processed as anchored at the point where they are tested.
 104 .P
 105 11. There are some differences that are concerned with the settings of captured
 106 strings when part of a pattern is repeated. For example, matching "aba" against
 107 the pattern /^(a(b)?)+$/ in Perl leaves $2 unset, but in PCRE it is set to "b".
 108 .P
 109 12. PCRE's handling of duplicate subpattern numbers and duplicate subpattern
 110 names is not as general as Perl's. This is a consequence of the fact the PCRE
 111 works internally just with numbers, using an external table to translate
 112 between numbers and names. In particular, a pattern such as (?|(?<a>A)|(?<b)B),
 113 where the two capturing parentheses have the same number but different names,
 114 is not supported, and causes an error at compile time. If it were allowed, it
 115 would not be possible to distinguish which parentheses matched, because both
 116 names map to capturing subpattern number 1. To avoid this confusing situation,
 117 an error is given at compile time.
 118 .P
 119 13. Perl recognizes comments in some places that PCRE does not, for example,
 120 between the ( and ? at the start of a subpattern. If the /x modifier is set,
 121 Perl allows white space between ( and ? but PCRE never does, even if the
 122 PCRE_EXTENDED option is set.
 123 .P
 124 14. PCRE provides some extensions to the Perl regular expression facilities.
 125 Perl 5.10 includes new features that are not in earlier versions of Perl, some
 126 of which (such as named parentheses) have been in PCRE for some time. This list
 127 is with respect to Perl 5.10:
 128 .sp
 129 (a) Although lookbehind assertions in PCRE must match fixed length strings,
 130 each alternative branch of a lookbehind assertion can match a different length
 131 of string. Perl requires them all to have the same length.
 132 .sp
 133 (b) If PCRE_DOLLAR_ENDONLY is set and PCRE_MULTILINE is not set, the $
 134 meta-character matches only at the very end of the string.
 135 .sp
 136 (c) If PCRE_EXTRA is set, a backslash followed by a letter with no special
 137 meaning is faulted. Otherwise, like Perl, the backslash is quietly ignored.
 138 (Perl can be made to issue a warning.)
 139 .sp
 140 (d) If PCRE_UNGREEDY is set, the greediness of the repetition quantifiers is
 141 inverted, that is, by default they are not greedy, but if followed by a
 142 question mark they are.
 143 .sp
 144 (e) PCRE_ANCHORED can be used at matching time to force a pattern to be tried
 145 only at the first matching position in the subject string.
 146 .sp
 147 (f) The PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NOTEMPTY_ATSTART, and
 148 PCRE_NO_AUTO_CAPTURE options for \fBpcre_exec()\fP have no Perl equivalents.
 149 .sp
 150 (g) The \eR escape sequence can be restricted to match only CR, LF, or CRLF
 151 by the PCRE_BSR_ANYCRLF option.
 152 .sp
 153 (h) The callout facility is PCRE-specific.
 154 .sp
 155 (i) The partial matching facility is PCRE-specific.
 156 .sp
 157 (j) Patterns compiled by PCRE can be saved and re-used at a later time, even on
 158 different hosts that have the other endianness. However, this does not apply to
 159 optimized data created by the just-in-time compiler.
 160 .sp
 161 (k) The alternative matching functions (\fBpcre_dfa_exec()\fP,
 162 \fBpcre16_dfa_exec()\fP and \fBpcre32_dfa_exec()\fP,) match in a different way
 163 and are not Perl-compatible.
 164 .sp
 165 (l) PCRE recognizes some special sequences such as (*CR) at the start of
 166 a pattern that set overall options that cannot be changed within the pattern.
 167 .
 168 .
 169 .SH AUTHOR
 170 .rs
 171 .sp
 172 .nf
 173 Philip Hazel
 174 University Computing Service
 175 Cambridge CB2 3QH, England.
 176 .fi
 177 .
 178 .
 179 .SH REVISION
 180 .rs
 181 .sp
 182 .nf
 183 Last updated: 25 August 2012
 184 Copyright (c) 1997-2012 University of Cambridge.
 185 .fi