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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 456 by ph10, Fri Oct 2 08:53:31 2009 UTC revision 507 by ph10, Wed Mar 10 16:08:01 2010 UTC
# Line 21  published by O'Reilly, covers regular ex Line 21  published by O'Reilly, covers regular ex
21  description of PCRE's regular expressions is intended as reference material.  description of PCRE's regular expressions is intended as reference material.
22  .P  .P
23  The original operation of PCRE was on strings of one-byte characters. However,  The original operation of PCRE was on strings of one-byte characters. However,
24  there is now also support for UTF-8 character strings. To use this,  there is now also support for UTF-8 character strings. To use this,
25  PCRE must be built to include UTF-8 support, and you must call  PCRE must be built to include UTF-8 support, and you must call
26  \fBpcre_compile()\fP or \fBpcre_compile2()\fP with the PCRE_UTF8 option. There  \fBpcre_compile()\fP or \fBpcre_compile2()\fP with the PCRE_UTF8 option. There
27  is also a special sequence that can be given at the start of a pattern:  is also a special sequence that can be given at the start of a pattern:
# Line 83  string with one of the following five se Line 83  string with one of the following five se
83    (*ANYCRLF)   any of the three above    (*ANYCRLF)   any of the three above
84    (*ANY)       all Unicode newline sequences    (*ANY)       all Unicode newline sequences
85  .sp  .sp
86  These override the default and the options given to \fBpcre_compile()\fP or  These override the default and the options given to \fBpcre_compile()\fP or
87  \fBpcre_compile2()\fP. For example, on a Unix system where LF is the default  \fBpcre_compile2()\fP. For example, on a Unix system where LF is the default
88  newline sequence, the pattern  newline sequence, the pattern
89  .sp  .sp
# Line 217  one of the following escape sequences th Line 217  one of the following escape sequences th
217    \en        linefeed (hex 0A)    \en        linefeed (hex 0A)
218    \er        carriage return (hex 0D)    \er        carriage return (hex 0D)
219    \et        tab (hex 09)    \et        tab (hex 09)
220    \eddd      character with octal code ddd, or backreference    \eddd      character with octal code ddd, or back reference
221    \exhh      character with hex code hh    \exhh      character with hex code hh
222    \ex{hhh..} character with hex code hhh..    \ex{hhh..} character with hex code hhh..
223  .sp  .sp
# Line 333  syntax for referencing a subpattern as a Line 333  syntax for referencing a subpattern as a
333  later.  later.
334  .\"  .\"
335  Note that \eg{...} (Perl syntax) and \eg<...> (Oniguruma syntax) are \fInot\fP  Note that \eg{...} (Perl syntax) and \eg<...> (Oniguruma syntax) are \fInot\fP
336  synonymous. The former is a back reference; the latter is a  synonymous. The former is a back reference; the latter is a
337  .\" HTML <a href="#subpatternsassubroutines">  .\" HTML <a href="#subpatternsassubroutines">
338  .\" </a>  .\" </a>
339  subroutine  subroutine
# Line 468  one of the following sequences: Line 468  one of the following sequences:
468    (*BSR_ANYCRLF)   CR, LF, or CRLF only    (*BSR_ANYCRLF)   CR, LF, or CRLF only
469    (*BSR_UNICODE)   any Unicode newline sequence    (*BSR_UNICODE)   any Unicode newline sequence
470  .sp  .sp
471  These override the default and the options given to \fBpcre_compile()\fP or  These override the default and the options given to \fBpcre_compile()\fP or
472  \fBpcre_compile2()\fP, but they can be overridden by options given to  \fBpcre_compile2()\fP, but they can be overridden by options given to
473  \fBpcre_exec()\fP or \fBpcre_dfa_exec()\fP. Note that these special settings,  \fBpcre_exec()\fP or \fBpcre_dfa_exec()\fP. Note that these special settings,
474  which are not Perl-compatible, are recognized only at the very start of a  which are not Perl-compatible, are recognized only at the very start of a
# Line 513  Those that are not part of an identified Line 513  Those that are not part of an identified
513  .P  .P
514  Arabic,  Arabic,
515  Armenian,  Armenian,
516    Avestan,
517  Balinese,  Balinese,
518    Bamum,
519  Bengali,  Bengali,
520  Bopomofo,  Bopomofo,
521  Braille,  Braille,
522  Buginese,  Buginese,
523  Buhid,  Buhid,
524  Canadian_Aboriginal,  Canadian_Aboriginal,
525    Carian,
526    Cham,
527  Cherokee,  Cherokee,
528  Common,  Common,
529  Coptic,  Coptic,
# Line 528  Cypriot, Line 532  Cypriot,
532  Cyrillic,  Cyrillic,
533  Deseret,  Deseret,
534  Devanagari,  Devanagari,
535    Egyptian_Hieroglyphs,
536  Ethiopic,  Ethiopic,
537  Georgian,  Georgian,
538  Glagolitic,  Glagolitic,
# Line 540  Hangul, Line 545  Hangul,
545  Hanunoo,  Hanunoo,
546  Hebrew,  Hebrew,
547  Hiragana,  Hiragana,
548    Imperial_Aramaic,
549  Inherited,  Inherited,
550    Inscriptional_Pahlavi,
551    Inscriptional_Parthian,
552    Javanese,
553    Kaithi,
554  Kannada,  Kannada,
555  Katakana,  Katakana,
556    Kayah_Li,
557  Kharoshthi,  Kharoshthi,
558  Khmer,  Khmer,
559  Lao,  Lao,
560  Latin,  Latin,
561    Lepcha,
562  Limbu,  Limbu,
563  Linear_B,  Linear_B,
564    Lisu,
565    Lycian,
566    Lydian,
567  Malayalam,  Malayalam,
568    Meetei_Mayek,
569  Mongolian,  Mongolian,
570  Myanmar,  Myanmar,
571  New_Tai_Lue,  New_Tai_Lue,
# Line 557  Nko, Line 573  Nko,
573  Ogham,  Ogham,
574  Old_Italic,  Old_Italic,
575  Old_Persian,  Old_Persian,
576    Old_South_Arabian,
577    Old_Turkic,
578    Ol_Chiki,
579  Oriya,  Oriya,
580  Osmanya,  Osmanya,
581  Phags_Pa,  Phags_Pa,
582  Phoenician,  Phoenician,
583    Rejang,
584  Runic,  Runic,
585    Samaritan,
586    Saurashtra,
587  Shavian,  Shavian,
588  Sinhala,  Sinhala,
589    Sundanese,
590  Syloti_Nagri,  Syloti_Nagri,
591  Syriac,  Syriac,
592  Tagalog,  Tagalog,
593  Tagbanwa,  Tagbanwa,
594  Tai_Le,  Tai_Le,
595    Tai_Tham,
596    Tai_Viet,
597  Tamil,  Tamil,
598  Telugu,  Telugu,
599  Thaana,  Thaana,
# Line 576  Thai, Line 601  Thai,
601  Tibetan,  Tibetan,
602  Tifinagh,  Tifinagh,
603  Ugaritic,  Ugaritic,
604    Vai,
605  Yi.  Yi.
606  .P  .P
607  Each character has exactly one general category property, specified by a  Each character has exactly one general category property, specified by a
# Line 711  For example, when the pattern Line 737  For example, when the pattern
737    (foo)\eKbar    (foo)\eKbar
738  .sp  .sp
739  matches "foobar", the first substring is still set to "foo".  matches "foobar", the first substring is still set to "foo".
740    .P
741    Perl documents that the use of \eK within assertions is "not well defined". In
742    PCRE, \eK is acted upon when it occurs inside positive assertions, but is
743    ignored in negative assertions.
744  .  .
745  .  .
746  .\" HTML <a name="smallassertions"></a>  .\" HTML <a name="smallassertions"></a>
# Line 741  different meaning, namely the backspace Line 771  different meaning, namely the backspace
771  A word boundary is a position in the subject string where the current character  A word boundary is a position in the subject string where the current character
772  and the previous character do not both match \ew or \eW (i.e. one matches  and the previous character do not both match \ew or \eW (i.e. one matches
773  \ew and the other matches \eW), or the start or end of the string if the  \ew and the other matches \eW), or the start or end of the string if the
774  first or last character matches \ew, respectively. Neither PCRE nor Perl has a  first or last character matches \ew, respectively. Neither PCRE nor Perl has a
775  separte "start of word" or "end of word" metasequence. However, whatever  separte "start of word" or "end of word" metasequence. However, whatever
776  follows \eb normally determines which it is. For example, the fragment  follows \eb normally determines which it is. For example, the fragment
777  \eba matches "a" at the start of a word.  \eba matches "a" at the start of a word.
778  .P  .P
779  The \eA, \eZ, and \ez assertions differ from the traditional circumflex and  The \eA, \eZ, and \ez assertions differ from the traditional circumflex and
# Line 876  the lookbehind. Line 906  the lookbehind.
906  .rs  .rs
907  .sp  .sp
908  An opening square bracket introduces a character class, terminated by a closing  An opening square bracket introduces a character class, terminated by a closing
909  square bracket. A closing square bracket on its own is not special by default.  square bracket. A closing square bracket on its own is not special by default.
910  However, if the PCRE_JAVASCRIPT_COMPAT option is set, a lone closing square  However, if the PCRE_JAVASCRIPT_COMPAT option is set, a lone closing square
911  bracket causes a compile-time error. If a closing square bracket is required as  bracket causes a compile-time error. If a closing square bracket is required as
912  a member of the class, it should be the first data character in the class  a member of the class, it should be the first data character in the class
913  (after an initial circumflex, if present) or escaped with a backslash.  (after an initial circumflex, if present) or escaped with a backslash.
# Line 1163  stored. Line 1193  stored.
1193    / ( a )  (?| x ( y ) z | (p (q) r) | (t) u (v) ) ( z ) /x    / ( a )  (?| x ( y ) z | (p (q) r) | (t) u (v) ) ( z ) /x
1194    # 1            2         2  3        2     3     4    # 1            2         2  3        2     3     4
1195  .sp  .sp
1196  A backreference to a numbered subpattern uses the most recent value that is set  A back reference to a numbered subpattern uses the most recent value that is
1197  for that number by any subpattern. The following pattern matches "abcabc" or  set for that number by any subpattern. The following pattern matches "abcabc"
1198  "defdef":  or "defdef":
1199  .sp  .sp
1200    /(?|(abc)|(def))\1/    /(?|(abc)|(def))\e1/
1201  .sp  .sp
1202  In contrast, a recursive or "subroutine" call to a numbered subpattern always  In contrast, a recursive or "subroutine" call to a numbered subpattern always
1203  refers to the first one in the pattern with the given number. The following  refers to the first one in the pattern with the given number. The following
1204  pattern matches "abcabc" or "defabc":  pattern matches "abcabc" or "defabc":
1205  .sp  .sp
1206    /(?|(abc)|(def))(?1)/    /(?|(abc)|(def))(?1)/
1207  .sp  .sp
1208    If a
1209    .\" HTML <a href="#conditions">
1210    .\" </a>
1211    condition test
1212    .\"
1213    for a subpattern's having matched refers to a non-unique number, the test is
1214    true if any of the subpatterns of that number have matched.
1215  .P  .P
1216  An alternative approach to using the "branch reset" feature is to use  An alternative approach to using this "branch reset" feature is to use
1217  duplicate named subpatterns, as described in the next section.  duplicate named subpatterns, as described in the next section.
1218  .  .
1219  .  .
# Line 1189  if an expression is modified, the number Line 1226  if an expression is modified, the number
1226  difficulty, PCRE supports the naming of subpatterns. This feature was not  difficulty, PCRE supports the naming of subpatterns. This feature was not
1227  added to Perl until release 5.10. Python had the feature earlier, and PCRE  added to Perl until release 5.10. Python had the feature earlier, and PCRE
1228  introduced it at release 4.0, using the Python syntax. PCRE now supports both  introduced it at release 4.0, using the Python syntax. PCRE now supports both
1229  the Perl and the Python syntax.  the Perl and the Python syntax. Perl allows identically numbered subpatterns to
1230    have different names, but PCRE does not.
1231  .P  .P
1232  In PCRE, a subpattern can be named in one of three ways: (?<name>...) or  In PCRE, a subpattern can be named in one of three ways: (?<name>...) or
1233  (?'name'...) as in Perl, or (?P<name>...) as in Python. References to capturing  (?'name'...) as in Perl, or (?P<name>...) as in Python. References to capturing
1234  parentheses from other parts of the pattern, such as  parentheses from other parts of the pattern, such as
1235  .\" HTML <a href="#backreferences">  .\" HTML <a href="#backreferences">
1236  .\" </a>  .\" </a>
1237  backreferences,  back references,
1238  .\"  .\"
1239  .\" HTML <a href="#recursion">  .\" HTML <a href="#recursion">
1240  .\" </a>  .\" </a>
# Line 1216  extracting the name-to-number translatio Line 1254  extracting the name-to-number translatio
1254  is also a convenience function for extracting a captured substring by name.  is also a convenience function for extracting a captured substring by name.
1255  .P  .P
1256  By default, a name must be unique within a pattern, but it is possible to relax  By default, a name must be unique within a pattern, but it is possible to relax
1257  this constraint by setting the PCRE_DUPNAMES option at compile time. This can  this constraint by setting the PCRE_DUPNAMES option at compile time. (Duplicate
1258  be useful for patterns where only one instance of the named parentheses can  names are also always permitted for subpatterns with the same number, set up as
1259  match. Suppose you want to match the name of a weekday, either as a 3-letter  described in the previous section.) Duplicate names can be useful for patterns
1260  abbreviation or as the full name, and in both cases you want to extract the  where only one instance of the named parentheses can match. Suppose you want to
1261  abbreviation. This pattern (ignoring the line breaks) does the job:  match the name of a weekday, either as a 3-letter abbreviation or as the full
1262    name, and in both cases you want to extract the abbreviation. This pattern
1263    (ignoring the line breaks) does the job:
1264  .sp  .sp
1265    (?<DN>Mon|Fri|Sun)(?:day)?|    (?<DN>Mon|Fri|Sun)(?:day)?|
1266    (?<DN>Tue)(?:sday)?|    (?<DN>Tue)(?:sday)?|
# Line 1234  subpattern, as described in the previous Line 1274  subpattern, as described in the previous
1274  .P  .P
1275  The convenience function for extracting the data by name returns the substring  The convenience function for extracting the data by name returns the substring
1276  for the first (and in this example, the only) subpattern of that name that  for the first (and in this example, the only) subpattern of that name that
1277  matched. This saves searching to find which numbered subpattern it was. If you  matched. This saves searching to find which numbered subpattern it was.
1278  make a reference to a non-unique named subpattern from elsewhere in the  .P
1279  pattern, the one that corresponds to the lowest number is used. For further  If you make a back reference to a non-unique named subpattern from elsewhere in
1280  details of the interfaces for handling named subpatterns, see the  the pattern, the one that corresponds to the first occurrence of the name is
1281    used. In the absence of duplicate numbers (see the previous section) this is
1282    the one with the lowest number. If you use a named reference in a condition
1283    test (see the
1284    .\"
1285    .\" HTML <a href="#conditions">
1286    .\" </a>
1287    section about conditions
1288    .\"
1289    below), either to check whether a subpattern has matched, or to check for
1290    recursion, all subpatterns with the same name are tested. If the condition is
1291    true for any one of them, the overall condition is true. This is the same
1292    behaviour as testing by number. For further details of the interfaces for
1293    handling named subpatterns, see the
1294  .\" HREF  .\" HREF
1295  \fBpcreapi\fP  \fBpcreapi\fP
1296  .\"  .\"
1297  documentation.  documentation.
1298  .P  .P
1299  \fBWarning:\fP You cannot use different names to distinguish between two  \fBWarning:\fP You cannot use different names to distinguish between two
1300  subpatterns with the same number (see the previous section) because PCRE uses  subpatterns with the same number because PCRE uses only the numbers when
1301  only the numbers when matching.  matching. For this reason, an error is given at compile time if different names
1302    are given to subpatterns with the same number. However, you can give the same
1303    name to subpatterns with the same number, even when PCRE_DUPNAMES is not set.
1304  .  .
1305  .  .
1306  .SH REPETITION  .SH REPETITION
# Line 1263  items: Line 1318  items:
1318    a character class    a character class
1319    a back reference (see next section)    a back reference (see next section)
1320    a parenthesized subpattern (unless it is an assertion)    a parenthesized subpattern (unless it is an assertion)
1321    a recursive or "subroutine" call to a subpattern    a recursive or "subroutine" call to a subpattern
1322  .sp  .sp
1323  The general repetition quantifier specifies a minimum and maximum number of  The general repetition quantifier specifies a minimum and maximum number of
1324  permitted matches, by giving the two numbers in curly brackets (braces),  permitted matches, by giving the two numbers in curly brackets (braces),
# Line 1374  worth setting PCRE_DOTALL in order to ob Line 1429  worth setting PCRE_DOTALL in order to ob
1429  alternatively using ^ to indicate anchoring explicitly.  alternatively using ^ to indicate anchoring explicitly.
1430  .P  .P
1431  However, there is one situation where the optimization cannot be used. When .*  However, there is one situation where the optimization cannot be used. When .*
1432  is inside capturing parentheses that are the subject of a backreference  is inside capturing parentheses that are the subject of a back reference
1433  elsewhere in the pattern, a match at the start may fail where a later one  elsewhere in the pattern, a match at the start may fail where a later one
1434  succeeds. Consider, for example:  succeeds. Consider, for example:
1435  .sp  .sp
# Line 1589  references to it always fail by default. Line 1644  references to it always fail by default.
1644  .sp  .sp
1645    (a|(bc))\e2    (a|(bc))\e2
1646  .sp  .sp
1647  always fails if it starts to match "a" rather than "bc". However, if the  always fails if it starts to match "a" rather than "bc". However, if the
1648  PCRE_JAVASCRIPT_COMPAT option is set at compile time, a back reference to an  PCRE_JAVASCRIPT_COMPAT option is set at compile time, a back reference to an
1649  unset value matches an empty string.  unset value matches an empty string.
1650  .P  .P
1651  Because there may be many capturing parentheses in a pattern, all digits  Because there may be many capturing parentheses in a pattern, all digits
# Line 1603  whitespace. Otherwise, the \eg{ syntax o Line 1658  whitespace. Otherwise, the \eg{ syntax o
1658  "Comments"  "Comments"
1659  .\"  .\"
1660  below) can be used.  below) can be used.
1661  .P  .
1662    .SS "Recursive back references"
1663    .rs
1664    .sp
1665  A back reference that occurs inside the parentheses to which it refers fails  A back reference that occurs inside the parentheses to which it refers fails
1666  when the subpattern is first used, so, for example, (a\e1) never matches.  when the subpattern is first used, so, for example, (a\e1) never matches.
1667  However, such references can be useful inside repeated subpatterns. For  However, such references can be useful inside repeated subpatterns. For
# Line 1617  to the previous iteration. In order for Line 1675  to the previous iteration. In order for
1675  that the first iteration does not need to match the back reference. This can be  that the first iteration does not need to match the back reference. This can be
1676  done using alternation, as in the example above, or by a quantifier with a  done using alternation, as in the example above, or by a quantifier with a
1677  minimum of zero.  minimum of zero.
1678    .P
1679    Back references of this type cause the group that they reference to be treated
1680    as an
1681    .\" HTML <a href="#atomicgroup">
1682    .\" </a>
1683    atomic group.
1684    .\"
1685    Once the whole group has been matched, a subsequent matching failure cannot
1686    cause backtracking into the middle of the group.
1687  .  .
1688  .  .
1689  .\" HTML <a name="bigassertions"></a>  .\" HTML <a name="bigassertions"></a>
# Line 1712  In some cases, the Perl 5.10 escape sequ Line 1779  In some cases, the Perl 5.10 escape sequ
1779  .\" </a>  .\" </a>
1780  (see above)  (see above)
1781  .\"  .\"
1782  can be used instead of a lookbehind assertion to get round the fixed-length  can be used instead of a lookbehind assertion to get round the fixed-length
1783  restriction.  restriction.
1784  .P  .P
1785  The implementation of lookbehind assertions is, for each alternative, to  The implementation of lookbehind assertions is, for each alternative, to
# Line 1730  different numbers of bytes, are also not Line 1797  different numbers of bytes, are also not
1797  "Subroutine"  "Subroutine"
1798  .\"  .\"
1799  calls (see below) such as (?2) or (?&X) are permitted in lookbehinds, as long  calls (see below) such as (?2) or (?&X) are permitted in lookbehinds, as long
1800  as the subpattern matches a fixed-length string.  as the subpattern matches a fixed-length string.
1801  .\" HTML <a href="#recursion">  .\" HTML <a href="#recursion">
1802  .\" </a>  .\" </a>
1803  Recursion,  Recursion,
# Line 1803  characters that are not "999". Line 1870  characters that are not "999".
1870  .sp  .sp
1871  It is possible to cause the matching process to obey a subpattern  It is possible to cause the matching process to obey a subpattern
1872  conditionally or to choose between two alternative subpatterns, depending on  conditionally or to choose between two alternative subpatterns, depending on
1873  the result of an assertion, or whether a specific capturing subpattern has  the result of an assertion, or whether a specific capturing subpattern has
1874  already been matched. The two possible forms of conditional subpattern are:  already been matched. The two possible forms of conditional subpattern are:
1875  .sp  .sp
1876    (?(condition)yes-pattern)    (?(condition)yes-pattern)
# Line 1821  recursion, a pseudo-condition called DEF Line 1888  recursion, a pseudo-condition called DEF
1888  .sp  .sp
1889  If the text between the parentheses consists of a sequence of digits, the  If the text between the parentheses consists of a sequence of digits, the
1890  condition is true if a capturing subpattern of that number has previously  condition is true if a capturing subpattern of that number has previously
1891  matched. If there is more than one capturing subpattern with the same number  matched. If there is more than one capturing subpattern with the same number
1892  (see the earlier  (see the earlier
1893  .\"  .\"
1894  .\" HTML <a href="#recursion">  .\" HTML <a href="#recursion">
1895  .\" </a>  .\" </a>
# Line 1874  Rewriting the above example to use a nam Line 1941  Rewriting the above example to use a nam
1941  .sp  .sp
1942    (?<OPEN> \e( )?    [^()]+    (?(<OPEN>) \e) )    (?<OPEN> \e( )?    [^()]+    (?(<OPEN>) \e) )
1943  .sp  .sp
1944    If the name used in a condition of this kind is a duplicate, the test is
1945    applied to all subpatterns of the same name, and is true if any one of them has
1946    matched.
1947  .  .
1948  .SS "Checking for pattern recursion"  .SS "Checking for pattern recursion"
1949  .rs  .rs
# Line 1887  letter R, for example: Line 1957  letter R, for example:
1957  .sp  .sp
1958  the condition is true if the most recent recursion is into a subpattern whose  the condition is true if the most recent recursion is into a subpattern whose
1959  number or name is given. This condition does not check the entire recursion  number or name is given. This condition does not check the entire recursion
1960  stack.  stack. If the name used in a condition of this kind is a duplicate, the test is
1961    applied to all subpatterns of the same name, and is true if any one of them is
1962    the most recent recursion.
1963  .P  .P
1964  At "top level", all these recursion test conditions are false.  At "top level", all these recursion test conditions are false.
1965  .\" HTML <a href="#recursion">  .\" HTML <a href="#recursion">
1966  .\" </a>  .\" </a>
1967  Recursive patterns  The syntax for recursive patterns
1968  .\"  .\"
1969  are described below.  is described below.
1970  .  .
1971  .SS "Defining subpatterns for use by reference only"  .SS "Defining subpatterns for use by reference only"
1972  .rs  .rs
# Line 1903  If the condition is the string (DEFINE), Line 1975  If the condition is the string (DEFINE),
1975  name DEFINE, the condition is always false. In this case, there may be only one  name DEFINE, the condition is always false. In this case, there may be only one
1976  alternative in the subpattern. It is always skipped if control reaches this  alternative in the subpattern. It is always skipped if control reaches this
1977  point in the pattern; the idea of DEFINE is that it can be used to define  point in the pattern; the idea of DEFINE is that it can be used to define
1978  "subroutines" that can be referenced from elsewhere. (The use of  "subroutines" that can be referenced from elsewhere. (The use of
1979  .\" HTML <a href="#subpatternsassubroutines">  .\" HTML <a href="#subpatternsassubroutines">
1980  .\" </a>  .\" </a>
1981  "subroutines"  "subroutines"
# Line 1980  this kind of recursion was subsequently Line 2052  this kind of recursion was subsequently
2052  .P  .P
2053  A special item that consists of (? followed by a number greater than zero and a  A special item that consists of (? followed by a number greater than zero and a
2054  closing parenthesis is a recursive call of the subpattern of the given number,  closing parenthesis is a recursive call of the subpattern of the given number,
2055  provided that it occurs inside that subpattern. (If not, it is a  provided that it occurs inside that subpattern. (If not, it is a
2056  .\" HTML <a href="#subpatternsassubroutines">  .\" HTML <a href="#subpatternsassubroutines">
2057  .\" </a>  .\" </a>
2058  "subroutine"  "subroutine"
# Line 1996  PCRE_EXTENDED option is set so that whit Line 2068  PCRE_EXTENDED option is set so that whit
2068  First it matches an opening parenthesis. Then it matches any number of  First it matches an opening parenthesis. Then it matches any number of
2069  substrings which can either be a sequence of non-parentheses, or a recursive  substrings which can either be a sequence of non-parentheses, or a recursive
2070  match of the pattern itself (that is, a correctly parenthesized substring).  match of the pattern itself (that is, a correctly parenthesized substring).
2071  Finally there is a closing parenthesis. Note the use of a possessive quantifier  Finally there is a closing parenthesis. Note the use of a possessive quantifier
2072  to avoid backtracking into sequences of non-parentheses.  to avoid backtracking into sequences of non-parentheses.
2073  .P  .P
2074  If this were part of a larger pattern, you would not want to recurse the entire  If this were part of a larger pattern, you would not want to recurse the entire
# Line 2044  the match runs for a very long time inde Line 2116  the match runs for a very long time inde
2116  ways the + and * repeats can carve up the subject, and all have to be tested  ways the + and * repeats can carve up the subject, and all have to be tested
2117  before failure can be reported.  before failure can be reported.
2118  .P  .P
2119  At the end of a match, the values set for any capturing subpatterns are those  At the end of a match, the values of capturing parentheses are those from
2120  from the outermost level of the recursion at which the subpattern value is set.  the outermost level. If you want to obtain intermediate values, a callout
2121  If you want to obtain intermediate values, a callout function can be used (see  function can be used (see below and the
 below and the  
2122  .\" HREF  .\" HREF
2123  \fBpcrecallout\fP  \fBpcrecallout\fP
2124  .\"  .\"
# Line 2055  documentation). If the pattern above is Line 2126  documentation). If the pattern above is
2126  .sp  .sp
2127    (ab(cd)ef)    (ab(cd)ef)
2128  .sp  .sp
2129  the value for the capturing parentheses is "ef", which is the last value taken  the value for the inner capturing parentheses (numbered 2) is "ef", which is
2130  on at the top level. If additional parentheses are added, giving  the last value taken on at the top level. If a capturing subpattern is not
2131  .sp  matched at the top level, its final value is unset, even if it is (temporarily)
2132    \e( ( ( [^()]++ | (?R) )* ) \e)  set at a deeper level.
2133       ^                        ^  .P
2134       ^                        ^  If there are more than 15 capturing parentheses in a pattern, PCRE has to
2135  .sp  obtain extra memory to store data during a recursion, which it does by using
2136  the string they capture is "ab(cd)ef", the contents of the top level  \fBpcre_malloc\fP, freeing it via \fBpcre_free\fP afterwards. If no memory can
2137  parentheses. If there are more than 15 capturing parentheses in a pattern, PCRE  be obtained, the match fails with the PCRE_ERROR_NOMEMORY error.
 has to obtain extra memory to store data during a recursion, which it does by  
 using \fBpcre_malloc\fP, freeing it via \fBpcre_free\fP afterwards. If no  
 memory can be obtained, the match fails with the PCRE_ERROR_NOMEMORY error.  
2138  .P  .P
2139  Do not confuse the (?R) item with the condition (R), which tests for recursion.  Do not confuse the (?R) item with the condition (R), which tests for recursion.
2140  Consider this pattern, which matches text in angle brackets, allowing for  Consider this pattern, which matches text in angle brackets, allowing for
# Line 2087  is the actual recursive call. Line 2155  is the actual recursive call.
2155  In PCRE (like Python, but unlike Perl), a recursive subpattern call is always  In PCRE (like Python, but unlike Perl), a recursive subpattern call is always
2156  treated as an atomic group. That is, once it has matched some of the subject  treated as an atomic group. That is, once it has matched some of the subject
2157  string, it is never re-entered, even if it contains untried alternatives and  string, it is never re-entered, even if it contains untried alternatives and
2158  there is a subsequent matching failure. This can be illustrated by the  there is a subsequent matching failure. This can be illustrated by the
2159  following pattern, which purports to match a palindromic string that contains  following pattern, which purports to match a palindromic string that contains
2160  an odd number of characters (for example, "a", "aba", "abcba", "abcdcba"):  an odd number of characters (for example, "a", "aba", "abcba", "abcdcba"):
2161  .sp  .sp
2162    ^(.|(.)(?1)\e2)$    ^(.|(.)(?1)\e2)$
2163  .sp  .sp
2164  The idea is that it either matches a single character, or two identical  The idea is that it either matches a single character, or two identical
2165  characters surrounding a sub-palindrome. In Perl, this pattern works; in PCRE  characters surrounding a sub-palindrome. In Perl, this pattern works; in PCRE
2166  it does not if the pattern is longer than three characters. Consider the  it does not if the pattern is longer than three characters. Consider the
2167  subject string "abcba":  subject string "abcba":
2168  .P  .P
2169  At the top level, the first character is matched, but as it is not at the end  At the top level, the first character is matched, but as it is not at the end
2170  of the string, the first alternative fails; the second alternative is taken  of the string, the first alternative fails; the second alternative is taken
2171  and the recursion kicks in. The recursive call to subpattern 1 successfully  and the recursion kicks in. The recursive call to subpattern 1 successfully
2172  matches the next character ("b"). (Note that the beginning and end of line  matches the next character ("b"). (Note that the beginning and end of line
2173  tests are not part of the recursion).  tests are not part of the recursion).
2174  .P  .P
2175  Back at the top level, the next character ("c") is compared with what  Back at the top level, the next character ("c") is compared with what
2176  subpattern 2 matched, which was "a". This fails. Because the recursion is  subpattern 2 matched, which was "a". This fails. Because the recursion is
2177  treated as an atomic group, there are now no backtracking points, and so the  treated as an atomic group, there are now no backtracking points, and so the
2178  entire match fails. (Perl is able, at this point, to re-enter the recursion and  entire match fails. (Perl is able, at this point, to re-enter the recursion and
2179  try the second alternative.) However, if the pattern is written with the  try the second alternative.) However, if the pattern is written with the
# Line 2113  alternatives in the other order, things Line 2181  alternatives in the other order, things
2181  .sp  .sp
2182    ^((.)(?1)\e2|.)$    ^((.)(?1)\e2|.)$
2183  .sp  .sp
2184  This time, the recursing alternative is tried first, and continues to recurse  This time, the recursing alternative is tried first, and continues to recurse
2185  until it runs out of characters, at which point the recursion fails. But this  until it runs out of characters, at which point the recursion fails. But this
2186  time we do have another alternative to try at the higher level. That is the big  time we do have another alternative to try at the higher level. That is the big
2187  difference: in the previous case the remaining alternative is at a deeper  difference: in the previous case the remaining alternative is at a deeper
2188  recursion level, which PCRE cannot use.  recursion level, which PCRE cannot use.
2189  .P  .P
2190  To change the pattern so that matches all palindromic strings, not just those  To change the pattern so that matches all palindromic strings, not just those
2191  with an odd number of characters, it is tempting to change the pattern to this:  with an odd number of characters, it is tempting to change the pattern to this:
2192  .sp  .sp
2193    ^((.)(?1)\e2|.?)$    ^((.)(?1)\e2|.?)$
2194  .sp  .sp
2195  Again, this works in Perl, but not in PCRE, and for the same reason. When a  Again, this works in Perl, but not in PCRE, and for the same reason. When a
2196  deeper recursion has matched a single character, it cannot be entered again in  deeper recursion has matched a single character, it cannot be entered again in
2197  order to match an empty string. The solution is to separate the two cases, and  order to match an empty string. The solution is to separate the two cases, and
2198  write out the odd and even cases as alternatives at the higher level:  write out the odd and even cases as alternatives at the higher level:
2199  .sp  .sp
2200    ^(?:((.)(?1)\e2|)|((.)(?3)\e4|.))    ^(?:((.)(?1)\e2|)|((.)(?3)\e4|.))
2201  .sp  .sp
2202  If you want to match typical palindromic phrases, the pattern has to ignore all  If you want to match typical palindromic phrases, the pattern has to ignore all
2203  non-word characters, which can be done like this:  non-word characters, which can be done like this:
2204  .sp  .sp
2205    ^\eW*+(?:((.)\eW*+(?1)\eW*+\e2|)|((.)\eW*+(?3)\eW*+\4|\eW*+.\eW*+))\eW*+$    ^\eW*+(?:((.)\eW*+(?1)\eW*+\e2|)|((.)\eW*+(?3)\eW*+\e4|\eW*+.\eW*+))\eW*+$
2206  .sp  .sp
2207  If run with the PCRE_CASELESS option, this pattern matches phrases such as "A  If run with the PCRE_CASELESS option, this pattern matches phrases such as "A
2208  man, a plan, a canal: Panama!" and it works well in both PCRE and Perl. Note  man, a plan, a canal: Panama!" and it works well in both PCRE and Perl. Note
2209  the use of the possessive quantifier *+ to avoid backtracking into sequences of  the use of the possessive quantifier *+ to avoid backtracking into sequences of
2210  non-word characters. Without this, PCRE takes a great deal longer (ten times or  non-word characters. Without this, PCRE takes a great deal longer (ten times or
2211  more) to match typical phrases, and Perl takes so long that you think it has  more) to match typical phrases, and Perl takes so long that you think it has
2212  gone into a loop.  gone into a loop.
# Line 2177  matches "sense and sensibility" and "res Line 2245  matches "sense and sensibility" and "res
2245  is used, it does match "sense and responsibility" as well as the other two  is used, it does match "sense and responsibility" as well as the other two
2246  strings. Another example is given in the discussion of DEFINE above.  strings. Another example is given in the discussion of DEFINE above.
2247  .P  .P
2248  Like recursive subpatterns, a "subroutine" call is always treated as an atomic  Like recursive subpatterns, a subroutine call is always treated as an atomic
2249  group. That is, once it has matched some of the subject string, it is never  group. That is, once it has matched some of the subject string, it is never
2250  re-entered, even if it contains untried alternatives and there is a subsequent  re-entered, even if it contains untried alternatives and there is a subsequent
2251  matching failure.  matching failure. Any capturing parentheses that are set during the subroutine
2252    call revert to their previous values afterwards.
2253  .P  .P
2254  When a subpattern is used as a subroutine, processing options such as  When a subpattern is used as a subroutine, processing options such as
2255  case-independence are fixed when the subpattern is defined. They cannot be  case-independence are fixed when the subpattern is defined. They cannot be
# Line 2264  a backtracking algorithm. With the excep Line 2333  a backtracking algorithm. With the excep
2333  failing negative assertion, they cause an error if encountered by  failing negative assertion, they cause an error if encountered by
2334  \fBpcre_dfa_exec()\fP.  \fBpcre_dfa_exec()\fP.
2335  .P  .P
2336  If any of these verbs are used in an assertion subpattern, their effect is  If any of these verbs are used in an assertion or subroutine subpattern
2337  confined to that subpattern; it does not extend to the surrounding pattern.  (including recursive subpatterns), their effect is confined to that subpattern;
2338  Note that assertion subpatterns are processed as anchored at the point where  it does not extend to the surrounding pattern. Note that such subpatterns are
2339  they are tested.  processed as anchored at the point where they are tested.
2340  .P  .P
2341  The new verbs make use of what was previously invalid syntax: an opening  The new verbs make use of what was previously invalid syntax: an opening
2342  parenthesis followed by an asterisk. In Perl, they are generally of the form  parenthesis followed by an asterisk. In Perl, they are generally of the form
# Line 2289  captured. (This feature was added to PCR Line 2358  captured. (This feature was added to PCR
2358  .sp  .sp
2359    A((?:A|B(*ACCEPT)|C)D)    A((?:A|B(*ACCEPT)|C)D)
2360  .sp  .sp
2361  This matches "AB", "AAD", or "ACD"; when it matches "AB", "B" is captured by  This matches "AB", "AAD", or "ACD"; when it matches "AB", "B" is captured by
2362  the outer parentheses.  the outer parentheses.
2363  .sp  .sp
2364    (*FAIL) or (*F)    (*FAIL) or (*F)
# Line 2370  is used outside of any alternation, it a Line 2439  is used outside of any alternation, it a
2439  .SH "SEE ALSO"  .SH "SEE ALSO"
2440  .rs  .rs
2441  .sp  .sp
2442  \fBpcreapi\fP(3), \fBpcrecallout\fP(3), \fBpcrematching\fP(3),  \fBpcreapi\fP(3), \fBpcrecallout\fP(3), \fBpcrematching\fP(3),
2443  \fBpcresyntax\fP(3), \fBpcre\fP(3).  \fBpcresyntax\fP(3), \fBpcre\fP(3).
2444  .  .
2445  .  .
# Line 2388  Cambridge CB2 3QH, England. Line 2457  Cambridge CB2 3QH, England.
2457  .rs  .rs
2458  .sp  .sp
2459  .nf  .nf
2460  Last updated: 30 September 2009  Last updated: 06 March 2010
2461  Copyright (c) 1997-2009 University of Cambridge.  Copyright (c) 1997-2010 University of Cambridge.
2462  .fi  .fi

Legend:
Removed from v.456  
changed lines
  Added in v.507

  ViewVC Help
Powered by ViewVC 1.1.5