/[pcre]/code/trunk/doc/pcrepattern.3

Diff of /code/trunk/doc/pcrepattern.3

Parent Directory | Revision Log | View Patch Patch

-revision 75 by nigel,
Sat Feb 24 21:40:37 2007 UTC
+revision 91 by nigel,
Sat Feb 24 21:41:34 2007 UTC
 Line 1
- .TH PCRE 3
+ .TH PCREPATTERN 3
  .SH NAME
  PCRE - Perl-compatible regular expressions
  .SH "PCRE REGULAR EXPRESSION DETAILS"
 Line 26 
 in the main
  .\"
  page.
  .P
+ The remainder of this document discusses the patterns that are supported by
+ PCRE when its main matching function, \fBpcre_exec()\fP, is used.
+ From release 6.0, PCRE offers a second matching function,
+ \fBpcre_dfa_exec()\fP, which matches using a different algorithm that is not
+ Perl-compatible. The advantages and disadvantages of the alternative function,
+ and how it differs from the normal function, are discussed in the
+ .\" HREF
+ \fBpcrematching\fP
+ .\"
+ page.
+ .P
  A regular expression is a pattern that is matched against a subject string from
  left to right. Most characters stand for themselves in a pattern, and match the
  corresponding characters in the subject. As a trivial example, the pattern
  .sp
    The quick brown fox
  .sp
- matches a portion of a subject string that is identical to itself. The power of
+ matches a portion of a subject string that is identical to itself. When
- regular expressions comes from the ability to include alternatives and
+ caseless matching is specified (the PCRE_CASELESS option), letters are matched
- repetitions in the pattern. These are encoded in the pattern by the use of
+ independently of case. In UTF-8 mode, PCRE always understands the concept of
+ case for characters whose values are less than 128, so caseless matching is
+ always possible. For characters with higher values, the concept of case is
+ supported if PCRE is compiled with Unicode property support, but not otherwise.
+ If you want to use caseless matching for characters 128 and above, you must
+ ensure that PCRE is compiled with Unicode property support as well as with
+ UTF-8 support.
+ .P
+ The power of regular expressions comes from the ability to include alternatives
+ and repetitions in the pattern. These are encoded in the pattern by the use of
  \fImetacharacters\fP, which do not stand for themselves but instead are
  interpreted in some special way.
  .P
-Line 76 
 The following sections describe the use
+Line 96 
 The following sections describe the use
  .rs
  .sp
  The backslash character has several uses. Firstly, if it is followed by a
- non-alphanumeric character, it takes away any special meaning that character may
+ non-alphanumeric character, it takes away any special meaning that character
- have. This use of backslash as an escape character applies both inside and
+ may have. This use of backslash as an escape character applies both inside and
  outside character classes.
  .P
  For example, if you want to match a * character, you write \e* in the pattern.
-Line 88 
 particular, if you want to match a backs
+Line 108 
 particular, if you want to match a backs
  .P
  If a pattern is compiled with the PCRE_EXTENDED option, whitespace in the
  pattern (other than in a character class) and characters between a # outside
- a character class and the next newline character are ignored. An escaping
+ a character class and the next newline are ignored. An escaping backslash can
- backslash can be used to include a whitespace or # character as part of the
+ be used to include a whitespace or # character as part of the pattern.
- pattern.
  .P
  If you want to remove the special meaning from a sequence of characters, you
  can do so by putting them between \eQ and \eE. This is different from Perl in
-Line 128 
 represents:
+Line 147 
 represents:
    \et        tab (hex 09)
    \eddd      character with octal code ddd, or backreference
    \exhh      character with hex code hh
-   \ex{hhh..} character with hex code hhh... (UTF-8 mode only)
+   \ex{hhh..} character with hex code hhh..
  .sp
  The precise effect of \ecx is as follows: if x is a lower case letter, it
  is converted to upper case. Then bit 6 of the character (hex 40) is inverted.
-Line 136 
 Thus \ecz becomes hex 1A, but \ec{ becom
+Line 155 
 Thus \ecz becomes hex 1A, but \ec{ becom
 B.
  .P
  After \ex, from zero to two hexadecimal digits are read (letters can be in
- upper or lower case). In UTF-8 mode, any number of hexadecimal digits may
+ upper or lower case). Any number of hexadecimal digits may appear between \ex{
- appear between \ex{ and }, but the value of the character code must be less
+ and }, but the value of the character code must be less than 256 in non-UTF-8
- than 2**31 (that is, the maximum hexadecimal value is 7FFFFFFF). If characters
+ mode, and less than 2**31 in UTF-8 mode (that is, the maximum hexadecimal value
- other than hexadecimal digits appear between \ex{ and }, or if there is no
+ is 7FFFFFFF). If characters other than hexadecimal digits appear between \ex{
- terminating }, this form of escape is not recognized. Instead, the initial
+ and }, or if there is no terminating }, this form of escape is not recognized.
- \ex will be interpreted as a basic hexadecimal escape, with no following
+ Instead, the initial \ex will be interpreted as a basic hexadecimal escape,
- digits, giving a character whose value is zero.
+ with no following digits, giving a character whose value is zero.
  .P
  Characters whose value is less than 256 can be defined by either of the two
- syntaxes for \ex when PCRE is in UTF-8 mode. There is no difference in the
+ syntaxes for \ex. There is no difference in the way they are handled. For
- way they are handled. For example, \exdc is exactly the same as \ex{dc}.
+ example, \exdc is exactly the same as \ex{dc}.
  .P
- After \e0 up to two further octal digits are read. In both cases, if there
+ After \e0 up to two further octal digits are read. If there are fewer than two
- are fewer than two digits, just those that are present are used. Thus the
+ digits, just those that are present are used. Thus the sequence \e0\ex\e07
- sequence \e0\ex\e07 specifies two binary zeros followed by a BEL character
+ specifies two binary zeros followed by a BEL character (code value 7). Make
- (code value 7). Make sure you supply two digits after the initial zero if the
+ sure you supply two digits after the initial zero if the pattern character that
- pattern character that follows is itself an octal digit.
+ follows is itself an octal digit.
  .P
  The handling of a backslash followed by a digit other than 0 is complicated.
  Outside a character class, PCRE reads it and any following digits as a decimal
-Line 171 
 parenthesized subpatterns.
+Line 190 
 parenthesized subpatterns.
  .P
  Inside a character class, or if the decimal number is greater than 9 and there
  have not been that many capturing subpatterns, PCRE re-reads up to three octal
- digits following the backslash, and generates a single byte from the least
+ digits following the backslash, ane uses them to generate a data character. Any
- significant 8 bits of the value. Any subsequent digits stand for themselves.
+ subsequent digits stand for themselves. In non-UTF-8 mode, the value of a
- For example:
+ character specified in octal must be less than \e400. In UTF-8 mode, values up
+ to \e777 are permitted. For example:
  .sp
    \e040   is another way of writing a space
  .\" JOIN
-Line 198 
 For example:
+Line 218 
 For example:
  Note that octal values of 100 or greater must not be introduced by a leading
  zero, because no more than three octal digits are ever read.
  .P
- All the sequences that define a single byte value or a single UTF-8 character
+ All the sequences that define a single character value can be used both inside
- (in UTF-8 mode) can be used both inside and outside character classes. In
+ and outside character classes. In addition, inside a character class, the
- addition, inside a character class, the sequence \eb is interpreted as the
+ sequence \eb is interpreted as the backspace character (hex 08), and the
- backspace character (hex 08), and the sequence \eX is interpreted as the
+ sequence \eX is interpreted as the character "X". Outside a character class,
- character "X". Outside a character class, these sequences have different
+ these sequences have different meanings
- meanings
  .\" HTML <a href="#uniextseq">
  .\" </a>
  (see below).
-Line 233 
 there is no character to match.
+Line 252 
 there is no character to match.
  .P
  For compatibility with Perl, \es does not match the VT character (code 11).
  This makes it different from the the POSIX "space" class. The \es characters
- are HT (9), LF (10), FF (12), CR (13), and space (32).
+ are HT (9), LF (10), FF (12), CR (13), and space (32). (If "use locale;" is
+ included in a Perl script, \es may match the VT character. In PCRE, it never
+ does.)
  .P
  A "word" character is an underscore or any character less than 256 that is a
  letter or digit. The definition of letters and digits is controlled by PCRE's
-Line 252 
 greater than 128 are used for accented l
+Line 273 
 greater than 128 are used for accented l
  .P
  In UTF-8 mode, characters with values greater than 128 never match \ed, \es, or
  \ew, and always match \eD, \eS, and \eW. This is true even when Unicode
- character property support is available.
+ character property support is available. The use of locales with Unicode is
+ discouraged.
  .
  .
  .\" HTML <a name="uniextseq"></a>
-Line 260 
 character property support is available.
+Line 282 
 character property support is available.
  .rs
  .sp
  When PCRE is built with Unicode character property support, three additional
- escape sequences to match generic character types are available when UTF-8 mode
+ escape sequences to match character properties are available when UTF-8 mode
  is selected. They are:
  .sp
-  \ep{\fIxx\fP}   a character with the \fIxx\fP property
+   \ep{\fIxx\fP}   a character with the \fIxx\fP property
-  \eP{\fIxx\fP}   a character without the \fIxx\fP property
+   \eP{\fIxx\fP}   a character without the \fIxx\fP property
-  \eX       an extended Unicode sequence
+   \eX       an extended Unicode sequence
  .sp
- The property names represented by \fIxx\fP above are limited to the
+ The property names represented by \fIxx\fP above are limited to the Unicode
- Unicode general category properties. Each character has exactly one such
+ script names, the general category properties, and "Any", which matches any
- property, specified by a two-letter abbreviation. For compatibility with Perl,
+ character (including newline). Other properties such as "InMusicalSymbols" are
- negation can be specified by including a circumflex between the opening brace
+ not currently supported by PCRE. Note that \eP{Any} does not match any
- and the property name. For example, \ep{^Lu} is the same as \eP{Lu}.
+ characters, so always causes a match failure.
  .P
- If only one letter is specified with \ep or \eP, it includes all the properties
+ Sets of Unicode characters are defined as belonging to certain scripts. A
- that start with that letter. In this case, in the absence of negation, the
+ character from one of these sets can be matched using a script name. For
- curly brackets in the escape sequence are optional; these two examples have
+ example:
- the same effect:
+ .sp
+   \ep{Greek}
+   \eP{Han}
+ .sp
+ Those that are not part of an identified script are lumped together as
+ "Common". The current list of scripts is:
+ .P
+ Arabic,
+ Armenian,
+ Bengali,
+ Bopomofo,
+ Braille,
+ Buginese,
+ Buhid,
+ Canadian_Aboriginal,
+ Cherokee,
+ Common,
+ Coptic,
+ Cypriot,
+ Cyrillic,
+ Deseret,
+ Devanagari,
+ Ethiopic,
+ Georgian,
+ Glagolitic,
+ Gothic,
+ Greek,
+ Gujarati,
+ Gurmukhi,
+ Han,
+ Hangul,
+ Hanunoo,
+ Hebrew,
+ Hiragana,
+ Inherited,
+ Kannada,
+ Katakana,
+ Kharoshthi,
+ Khmer,
+ Lao,
+ Latin,
+ Limbu,
+ Linear_B,
+ Malayalam,
+ Mongolian,
+ Myanmar,
+ New_Tai_Lue,
+ Ogham,
+ Old_Italic,
+ Old_Persian,
+ Oriya,
+ Osmanya,
+ Runic,
+ Shavian,
+ Sinhala,
+ Syloti_Nagri,
+ Syriac,
+ Tagalog,
+ Tagbanwa,
+ Tai_Le,
+ Tamil,
+ Telugu,
+ Thaana,
+ Thai,
+ Tibetan,
+ Tifinagh,
+ Ugaritic,
+ Yi.
+ .P
+ Each character has exactly one general category property, specified by a
+ two-letter abbreviation. For compatibility with Perl, negation can be specified
+ by including a circumflex between the opening brace and the property name. For
+ example, \ep{^Lu} is the same as \eP{Lu}.
+ .P
+ If only one letter is specified with \ep or \eP, it includes all the general
+ category properties that start with that letter. In this case, in the absence
+ of negation, the curly brackets in the escape sequence are optional; these two
+ examples have the same effect:
  .sp
    \ep{L}
    \epL
  .sp
- The following property codes are supported:
+ The following general category property codes are supported:
  .sp
    C     Other
    Cc    Control
-Line 327 
 The following property codes are support
+Line 426 
 The following property codes are support
    Zp    Paragraph separator
    Zs    Space separator
  .sp
- Extended properties such as "Greek" or "InMusicalSymbols" are not supported by
+ The special property L& is also supported: it matches a character that has
- PCRE.
+ the Lu, Ll, or Lt property, in other words, a letter that is not classified as
+ a modifier or "other".
+ .P
+ The long synonyms for these properties that Perl supports (such as \ep{Letter})
+ are not supported by PCRE, nor is it permitted to prefix any of these
+ properties with "Is".
+ .P
+ No character that is in the Unicode table has the Cn (unassigned) property.
+ Instead, this property is assumed for any code point that is not in the
+ Unicode table.
  .P
  Specifying caseless matching does not affect these escape sequences. For
  example, \ep{Lu} always matches only upper case letters.
-Line 366 
 subpatterns for more complicated asserti
+Line 474 
 subpatterns for more complicated asserti
  .\" </a>
  below.
  .\"
- The backslashed
+ The backslashed assertions are:
- assertions are:
  .sp
    \eb     matches at a word boundary
    \eB     matches when not at a word boundary
-Line 392 
 PCRE_NOTBOL or PCRE_NOTEOL options, whic
+Line 499 
 PCRE_NOTBOL or PCRE_NOTEOL options, whic
  circumflex and dollar metacharacters. However, if the \fIstartoffset\fP
  argument of \fBpcre_exec()\fP is non-zero, indicating that matching is to start
  at a point other than the beginning of the subject, \eA can never match. The
- difference between \eZ and \ez is that \eZ matches before a newline that is the
+ difference between \eZ and \ez is that \eZ matches before a newline at the end
- last character of the string as well as at the end of the string, whereas \ez
+ of the string as well as at the very end, whereas \ez matches only at the end.
- matches only at the end.
  .P
  The \eG assertion is true only when the current matching position is at the
  start point of the match, as specified by the \fIstartoffset\fP argument of
-Line 438 
 to be anchored.)
+Line 544 
 to be anchored.)
  .P
  A dollar character is an assertion that is true only if the current matching
  point is at the end of the subject string, or immediately before a newline
- character that is the last character in the string (by default). Dollar need
+ at the end of the string (by default). Dollar need not be the last character of
- not be the last character of the pattern if a number of alternatives are
+ the pattern if a number of alternatives are involved, but it should be the last
- involved, but it should be the last item in any branch in which it appears.
+ item in any branch in which it appears. Dollar has no special meaning in a
- Dollar has no special meaning in a character class.
+ character class.
  .P
  The meaning of dollar can be changed so that it matches only at the very end of
  the string, by setting the PCRE_DOLLAR_ENDONLY option at compile time. This
  does not affect the \eZ assertion.
  .P
  The meanings of the circumflex and dollar characters are changed if the
- PCRE_MULTILINE option is set. When this is the case, they match immediately
+ PCRE_MULTILINE option is set. When this is the case, a circumflex matches
- after and immediately before an internal newline character, respectively, in
+ immediately after internal newlines as well as at the start of the subject
- addition to matching at the start and end of the subject string. For example,
+ string. It does not match after a newline that ends the string. A dollar
- the pattern /^abc$/ matches the subject string "def\enabc" (where \en
+ matches before any newlines in the string, as well as at the very end, when
- represents a newline character) in multiline mode, but not otherwise.
+ PCRE_MULTILINE is set. When newline is specified as the two-character
- Consequently, patterns that are anchored in single line mode because all
+ sequence CRLF, isolated CR and LF characters do not indicate newlines.
- branches start with ^ are not anchored in multiline mode, and a match for
+ .P
- circumflex is possible when the \fIstartoffset\fP argument of \fBpcre_exec()\fP
+ For example, the pattern /^abc$/ matches the subject string "def\enabc" (where
- is non-zero. The PCRE_DOLLAR_ENDONLY option is ignored if PCRE_MULTILINE is
+ \en represents a newline) in multiline mode, but not otherwise. Consequently,
- set.
+ patterns that are anchored in single line mode because all branches start with
+ ^ are not anchored in multiline mode, and a match for circumflex is possible
+ when the \fIstartoffset\fP argument of \fBpcre_exec()\fP is non-zero. The
+ PCRE_DOLLAR_ENDONLY option is ignored if PCRE_MULTILINE is set.
  .P
  Note that the sequences \eA, \eZ, and \ez can be used to match the start and
  end of the subject in both modes, and if all branches of a pattern start with
- \eA it is always anchored, whether PCRE_MULTILINE is set or not.
+ \eA it is always anchored, whether or not PCRE_MULTILINE is set.
  .
  .
  .SH "FULL STOP (PERIOD, DOT)"
  .rs
  .sp
  Outside a character class, a dot in the pattern matches any one character in
- the subject, including a non-printing character, but not (by default) newline.
+ the subject string except (by default) a character that signifies the end of a
- In UTF-8 mode, a dot matches any UTF-8 character, which might be more than one
+ line. In UTF-8 mode, the matched character may be more than one byte long. When
- byte long, except (by default) newline. If the PCRE_DOTALL option is set,
+ a line ending is defined as a single character (CR or LF), dot never matches
- dots match newlines as well. The handling of dot is entirely independent of the
+ that character; when the two-character sequence CRLF is used, dot does not
- handling of circumflex and dollar, the only relationship being that they both
+ match CR if it is immediately followed by LF, but otherwise it matches all
- involve newline characters. Dot has no special meaning in a character class.
+ characters (including isolated CRs and LFs).
+ .P
+ The behaviour of dot with regard to newlines can be changed. If the PCRE_DOTALL
+ option is set, a dot matches any one character, without exception. If newline
+ is defined as the two-character sequence CRLF, it takes two dots to match it.
+ .P
+ The handling of dot is entirely independent of the handling of circumflex and
+ dollar, the only relationship being that they both involve newlines. Dot has no
+ special meaning in a character class.
  .
  .
  .SH "MATCHING A SINGLE BYTE"
  .rs
  .sp
  Outside a character class, the escape sequence \eC matches any one byte, both
- in and out of UTF-8 mode. Unlike a dot, it can match a newline. The feature is
+ in and out of UTF-8 mode. Unlike a dot, it always matches CR and LF. The
- provided in Perl in order to match individual bytes in UTF-8 mode. Because it
+ feature is provided in Perl in order to match individual bytes in UTF-8 mode.
- breaks up UTF-8 characters into individual bytes, what remains in the string
+ Because it breaks up UTF-8 characters into individual bytes, what remains in
- may be a malformed UTF-8 string. For this reason, the \eC escape sequence is
+ the string may be a malformed UTF-8 string. For this reason, the \eC escape
- best avoided.
+ sequence is best avoided.
  .P
  PCRE does not allow \eC to appear in lookbehind assertions
  .\" HTML <a href="#lookbehind">
-Line 527 
 class as a literal string of bytes, or b
+Line 644 
 class as a literal string of bytes, or b
  When caseless matching is set, any letters in a class represent both their
  upper case and lower case versions, so for example, a caseless [aeiou] matches
  "A" as well as "a", and a caseless [^aeiou] does not match "A", whereas a
- caseful version would. When running in UTF-8 mode, PCRE supports the concept of
+ caseful version would. In UTF-8 mode, PCRE always understands the concept of
- case for characters with values greater than 128 only when it is compiled with
+ case for characters whose values are less than 128, so caseless matching is
- Unicode property support.
+ always possible. For characters with higher values, the concept of case is
- .P
+ supported if PCRE is compiled with Unicode property support, but not otherwise.
- The newline character is never treated in any special way in character classes,
+ If you want to use caseless matching for characters 128 and above, you must
- whatever the setting of the PCRE_DOTALL or PCRE_MULTILINE options is. A class
+ ensure that PCRE is compiled with Unicode property support as well as with
- such as [^a] will always match a newline.
+ UTF-8 support.
+ .P
+ Characters that might indicate line breaks (CR and LF) are never treated in any
+ special way when matching character classes, whatever line-ending sequence is
+ in use, and whatever setting of the PCRE_DOTALL and PCRE_MULTILINE options is
+ used. A class such as [^a] always matches one of these characters.
  .P
  The minus (hyphen) character can be used to specify a range of characters in a
  character class. For example, [d-m] matches any letter between d and m,
-Line 632 
 the pattern
+Line 754 
 the pattern
    gilbert|sullivan
  .sp
  matches either "gilbert" or "sullivan". Any number of alternatives may appear,
- and an empty alternative is permitted (matching the empty string).
+ and an empty alternative is permitted (matching the empty string). The matching
- The matching process tries each alternative in turn, from left to right,
+ process tries each alternative in turn, from left to right, and the first one
- and the first one that succeeds is used. If the alternatives are within a
+ that succeeds is used. If the alternatives are within a subpattern
- subpattern
  .\" HTML <a href="#subpattern">
  .\" </a>
  (defined below),
-Line 686 
 branch is abandoned before the option se
+Line 807 
 branch is abandoned before the option se
  option settings happen at compile time. There would be some very weird
  behaviour otherwise.
  .P
- The PCRE-specific options PCRE_UNGREEDY and PCRE_EXTRA can be changed in the
+ The PCRE-specific options PCRE_DUPNAMES, PCRE_UNGREEDY, and PCRE_EXTRA can be
- same way as the Perl-compatible options by using the characters U and X
+ changed in the same way as the Perl-compatible options by using the characters
- respectively. The (?X) flag setting is special in that it must always occur
+ J, U and X respectively.
- earlier in the pattern than any of the additional features it turns on, even
- when it is at top level. It is best to put it at the start.
  .
  .
  .\" HTML <a name="subpattern"></a>
-Line 753 
 Identifying capturing parentheses by num
+Line 872 
 Identifying capturing parentheses by num
  to keep track of the numbers in complicated regular expressions. Furthermore,
  if an expression is modified, the numbers may change. To help with this
  difficulty, PCRE supports the naming of subpatterns, something that Perl does
- not provide. The Python syntax (?P<name>...) is used. Names consist of
+ not provide. The Python syntax (?P<name>...) is used. References to capturing
- alphanumeric characters and underscores, and must be unique within a pattern.
+ parentheses from other parts of the pattern, such as
+ .\" HTML <a href="#backreferences">
+ .\" </a>
+ backreferences,
+ .\"
+ .\" HTML <a href="#recursion">
+ .\" </a>
+ recursion,
+ .\"
+ and
+ .\" HTML <a href="#conditions">
+ .\" </a>
+ conditions,
+ .\"
+ can be made by name as well as by number.
  .P
- Named capturing parentheses are still allocated numbers as well as names. The
+ Names consist of up to 32 alphanumeric characters and underscores. Named
- PCRE API provides function calls for extracting the name-to-number translation
+ capturing parentheses are still allocated numbers as well as names. The PCRE
- table from a compiled pattern. There is also a convenience function for
+ API provides function calls for extracting the name-to-number translation table
- extracting a captured substring by name. For further details see the
+ from a compiled pattern. There is also a convenience function for extracting a
+ captured substring by name.
+ .P
+ By default, a name must be unique within a pattern, but it is possible to relax
+ this constraint by setting the PCRE_DUPNAMES option at compile time. This can
+ be useful for patterns where only one instance of the named parentheses can
+ match. Suppose you want to match the name of a weekday, either as a 3-letter
+ abbreviation or as the full name, and in both cases you want to extract the
+ abbreviation. This pattern (ignoring the line breaks) does the job:
+ .sp
+   (?P<DN>Mon|Fri|Sun)(?:day)?|
+   (?P<DN>Tue)(?:sday)?|
+   (?P<DN>Wed)(?:nesday)?|
+   (?P<DN>Thu)(?:rsday)?|
+   (?P<DN>Sat)(?:urday)?
+ .sp
+ There are five capturing substrings, but only one is ever set after a match.
+ The convenience function for extracting the data by name returns the substring
+ for the first, and in this example, the only, subpattern of that name that
+ matched. This saves searching to find which numbered subpattern it was. If you
+ make a reference to a non-unique named subpattern from elsewhere in the
+ pattern, the one that corresponds to the lowest number is used. For further
+ details of the interfaces for handling named subpatterns, see the
  .\" HREF
  \fBpcreapi\fP
  .\"
-Line 963 
 option is ignored. They are a convenient
+Line 1118 
 option is ignored. They are a convenient
  atomic group. However, there is no difference in the meaning or processing of a
  possessive quantifier and the equivalent atomic group.
  .P
- The possessive quantifier syntax is an extension to the Perl syntax. It
+ The possessive quantifier syntax is an extension to the Perl syntax. Jeffrey
- originates in Sun's Java package.
+ Friedl originated the idea (and the name) in the first edition of his book.
+ Mike McCloskey liked it, so implemented it when he built Sun's Java package,
+ and PCRE copied it from there.
  .P
  When a pattern contains an unlimited repeat inside a subpattern that can itself
  be repeated an unlimited number of times, the use of an atomic group is the
-Line 1006 
 However, if the decimal number following
+Line 1163 
 However, if the decimal number following
  always taken as a back reference, and causes an error only if there are not
  that many capturing left parentheses in the entire pattern. In other words, the
  parentheses that are referenced need not be to the left of the reference for
- numbers less than 10. See the subsection entitled "Non-printing characters"
+ numbers less than 10. A "forward back reference" of this type can make sense
+ when a repetition is involved and the subpattern to the right has participated
+ in an earlier iteration.
+ .P
+ It is not possible to have a numerical "forward back reference" to subpattern
+ whose number is 10 or more. However, a back reference to any subpattern is
+ possible using named parentheses (see below). See also the subsection entitled
+ "Non-printing characters"
  .\" HTML <a href="#digitsafterbackslash">
  .\" </a>
  above
-Line 1036 
 capturing subpattern is matched caseless
+Line 1200 
 capturing subpattern is matched caseless
  Back references to named subpatterns use the Python syntax (?P=name). We could
  rewrite the above example as follows:
  .sp
-   (?<p1>(?i)rah)\es+(?P=p1)
+   (?P<p1>(?i)rah)\es+(?P=p1)
  .sp
+ A subpattern that is referenced by name may appear in the pattern before or
+ after the reference.
+ .P
  There may be more than one back reference to the same subpattern. If a
  subpattern has not actually been used in a particular match, any back
  references to it always fail. For example, the pattern
-Line 1099 
 because it does not make sense for negat
+Line 1266 
 because it does not make sense for negat
  .SS "Lookahead assertions"
  .rs
  .sp
- Lookahead assertions start
+ Lookahead assertions start with (?= for positive assertions and (?! for
- with (?= for positive assertions and (?! for negative assertions. For example,
+ negative assertions. For example,
  .sp
    \ew+(?=;)
  .sp
-Line 1135 
 negative assertions. For example,
+Line 1302 
 negative assertions. For example,
  .sp
  does find an occurrence of "bar" that is not preceded by "foo". The contents of
  a lookbehind assertion are restricted such that all the strings it matches must
- have a fixed length. However, if there are several alternatives, they do not
+ have a fixed length. However, if there are several top-level alternatives, they
- all have to have the same fixed length. Thus
+ do not all have to have the same fixed length. Thus
  .sp
    (?<=bullock|donkey)
  .sp
-Line 1230 
 is another pattern that matches "foo" pr
+Line 1397 
 is another pattern that matches "foo" pr
  characters that are not "999".
  .
  .
+ .\" HTML <a name="conditions"></a>
  .SH "CONDITIONAL SUBPATTERNS"
  .rs
  .sp
-Line 1246 
 no-pattern (if present) is used. If ther
+Line 1414 
 no-pattern (if present) is used. If ther
  subpattern, a compile-time error occurs.
  .P
  There are three kinds of condition. If the text between the parentheses
- consists of a sequence of digits, the condition is satisfied if the capturing
+ consists of a sequence of digits, or a sequence of alphanumeric characters and
- subpattern of that number has previously matched. The number must be greater
+ underscores, the condition is satisfied if the capturing subpattern of that
- than zero. Consider the following pattern, which contains non-significant white
+ number or name has previously matched. There is a possible ambiguity here,
- space to make it more readable (assume the PCRE_EXTENDED option) and to divide
+ because subpattern names may consist entirely of digits. PCRE looks first for a
- it into three parts for ease of discussion:
+ named subpattern; if it cannot find one and the text consists entirely of
+ digits, it looks for a subpattern of that number, which must be greater than
+ zero. Using subpattern names that consist entirely of digits is not
+ recommended.
+ .P
+ Consider the following pattern, which contains non-significant white space to
+ make it more readable (assume the PCRE_EXTENDED option) and to divide it into
+ three parts for ease of discussion:
  .sp
    ( \e( )?    [^()]+    (?(1) \e) )
  .sp
-Line 1262 
 or not. If they did, that is, if subject
+Line 1437 
 or not. If they did, that is, if subject
  the condition is true, and so the yes-pattern is executed and a closing
  parenthesis is required. Otherwise, since no-pattern is not present, the
  subpattern matches nothing. In other words, this pattern matches a sequence of
- non-parentheses, optionally enclosed in parentheses.
+ non-parentheses, optionally enclosed in parentheses. Rewriting it to use a
- .P
+ named subpattern gives this:
- If the condition is the string (R), it is satisfied if a recursive call to the
+ .sp
- pattern or subpattern has been made. At "top level", the condition is false.
+   (?P<OPEN> \e( )?    [^()]+    (?(OPEN) \e) )
- This is a PCRE extension. Recursive patterns are described in the next section.
+ .sp
+ If the condition is the string (R), and there is no subpattern with the name R,
+ the condition is satisfied if a recursive call to the pattern or subpattern has
+ been made. At "top level", the condition is false. This is a PCRE extension.
+ Recursive patterns are described in the next section.
  .P
  If the condition is not a sequence of digits or (R), it must be an assertion.
  This may be a positive or negative lookahead or lookbehind assertion. Consider
-Line 1293 
 closing parenthesis. Nested parentheses
+Line 1472 
 closing parenthesis. Nested parentheses
  that make up a comment play no part in the pattern matching at all.
  .P
  If the PCRE_EXTENDED option is set, an unescaped # character outside a
- character class introduces a comment that continues up to the next newline
+ character class introduces a comment that continues to immediately after the
- character in the pattern.
+ next newline in the pattern.
  .
  .
+ .\" HTML <a name="recursion"></a>
  .SH "RECURSIVE PATTERNS"
  .rs
  .sp
-Line 1322 
 number, provided that it occurs inside t
+Line 1502 
 number, provided that it occurs inside t
  "subroutine" call, which is described in the next section.) The special item
  (?R) is a recursive call of the entire regular expression.
  .P
- For example, this PCRE pattern solves the nested parentheses problem (assume
+ A recursive subpattern call is always treated as an atomic group. That is, once
- the PCRE_EXTENDED option is set so that white space is ignored):
+ it has matched some of the subject string, it is never re-entered, even if
+ it contains untried alternatives and there is a subsequent matching failure.
+ .P
+ This PCRE pattern solves the nested parentheses problem (assume the
+ PCRE_EXTENDED option is set so that white space is ignored):
  .sp
    \e( ( (?>[^()]+) | (?R) )* \e)
  .sp
  First it matches an opening parenthesis. Then it matches any number of
  substrings which can either be a sequence of non-parentheses, or a recursive
- match of the pattern itself (that is a correctly parenthesized substring).
+ match of the pattern itself (that is, a correctly parenthesized substring).
  Finally there is a closing parenthesis.
  .P
  If this were part of a larger pattern, you would not want to recurse the entire
-Line 1411 
 matches "sense and sensibility" and "res
+Line 1595 
 matches "sense and sensibility" and "res
    (sens|respons)e and (?1)ibility
  .sp
  is used, it does match "sense and responsibility" as well as the other two
- strings. Such references must, however, follow the subpattern to which they
+ strings. Such references, if given numerically, must follow the subpattern to
- refer.
+ which they refer. However, named references can refer to later subpatterns.
+ .P
+ Like recursive subpatterns, a "subroutine" call is always treated as an atomic
+ group. That is, once it has matched some of the subject string, it is never
+ re-entered, even if it contains untried alternatives and there is a subsequent
+ matching failure.
  .
  .
  .SH CALLOUTS
-Line 1451 
 description of the interface to the call
+Line 1640 
 description of the interface to the call
  documentation.
  .P
  .in 0
- Last updated: 09 September 2004
+ Last updated: 06 June 2006
  .br
- Copyright (c) 1997-2004 University of Cambridge.
+ Copyright (c) 1997-2006 University of Cambridge.

 Legend:



Removed from v.75
 


changed lines


 
Added in v.91
 Legend:



Removed from v.75
 


changed lines


 
Added in v.91
-Removed from v.75
+Added in v.91

	ViewVC Help
Powered by ViewVC 1.1.5