/[pcre]/code/tags/pcre-3.2/doc/pcre.3

Diff of /code/tags/pcre-3.2/doc/pcre.3

Parent Directory | Revision Log | View Patch Patch

-revision 43 by nigel,
Sat Feb 24 21:39:21 2007 UTC
+revision 47 by nigel,
Sat Feb 24 21:39:29 2007 UTC
 Line 323 
 no back references.
  Return information about the first character of any matched string, for a
  non-anchored pattern. If there is a fixed first character, e.g. from a pattern
- such as (cat|cow|coyote), then it is returned in the integer pointed to by
+ such as (cat|cow|coyote), it is returned in the integer pointed to by
  \fIwhere\fR. Otherwise, if either
  (a) the pattern was compiled with the PCRE_MULTILINE option, and every branch
 Line 332 
 starts with "^", or
  (b) every branch of the pattern starts with ".*" and PCRE_DOTALL is not set
  (if it were set, the pattern would be anchored),
- then -1 is returned, indicating that the pattern matches only at the
+ -1 is returned, indicating that the pattern matches only at the start of a
- start of a subject string or after any "\\n" within the string. Otherwise -2 is
+ subject string or after any "\\n" within the string. Otherwise -2 is returned.
- returned. For anchored patterns, -2 is returned.
+ For anchored patterns, -2 is returned.
    PCRE_INFO_FIRSTTABLE
 Line 550 
 is a pointer to the vector of integer of
  were captured by the match, including the substring that matched the entire
  regular expression. This is the value returned by \fBpcre_exec\fR if it
  is greater than zero. If \fBpcre_exec()\fR returned zero, indicating that it
- ran out of space in \fIovector\fR, then the value passed as
+ ran out of space in \fIovector\fR, the value passed as \fIstringcount\fR should
- \fIstringcount\fR should be the size of the vector divided by three.
+ be the size of the vector divided by three.
  The functions \fBpcre_copy_substring()\fR and \fBpcre_get_substring()\fR
  extract a single substring, whose number is given as \fIstringnumber\fR. A
 Line 650 
 patterns using the non-Perl item (?R).
  with the settings of captured strings when part of a pattern is repeated. For
  example, matching "aba" against the pattern /^(a(b)?)+$/ sets $2 to the value
  "b", but matching "aabbaa" against /^(aa(bb)?)+$/ leaves $2 unset. However, if
- the pattern is changed to /^(aa(b(b))?)+$/ then $2 (and $3) get set.
+ the pattern is changed to /^(aa(b(b))?)+$/ then $2 (and $3) are set.
  In Perl 5.004 $2 is set in both cases, and that is also true of PCRE. If in the
  future Perl changes to a consistent state that is different, PCRE may change to
 Line 920 
 end of the subject in both modes, and if
  .SH FULL STOP (PERIOD, DOT)
  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.
- If the PCRE_DOTALL option is set, then dots match newlines as well. The
+ If the PCRE_DOTALL option is set, dots match newlines as well. The handling of
- handling of dot is entirely independent of the handling of circumflex and
+ dot is entirely independent of the handling of circumflex and dollar, the only
- dollar, the only relationship being that they both involve newline characters.
+ relationship being that they both involve newline characters. Dot has no
- Dot has no special meaning in a character class.
+ special meaning in a character class.
  .SH SQUARE BRACKETS
 Line 1213 
 to the string
  fails, because it matches the entire string due to the greediness of the .*
  item.
- However, if a quantifier is followed by a question mark, then it ceases to be
+ However, if a quantifier is followed by a question mark, it ceases to be
  greedy, and instead matches the minimum number of times possible, so the
  pattern
 Line 1229 
 own right. Because it has two uses, it c
  which matches one digit by preference, but can match two if that is the only
  way the rest of the pattern matches.
- If the PCRE_UNGREEDY option is set (an option which is not available in Perl)
+ If the PCRE_UNGREEDY option is set (an option which is not available in Perl),
- then the quantifiers are not greedy by default, but individual ones can be made
+ the quantifiers are not greedy by default, but individual ones can be made
  greedy by following them with a question mark. In other words, it inverts the
  default behaviour.
 Line 1239 
 is greater than 1 or with a limited maxi
  compiled pattern, in proportion to the size of the minimum or maximum.
  If a pattern starts with .* or .{0,} and the PCRE_DOTALL option (equivalent
- to Perl's /s) is set, thus allowing the . to match newlines, then the pattern
+ to Perl's /s) is set, thus allowing the . to match newlines, the pattern is
- is implicitly anchored, because whatever follows will be tried against every
+ implicitly anchored, because whatever follows will be tried against every
  character position in the subject string, so there is no point in retrying the
  overall match at any position after the first. PCRE treats such a pattern as
  though it were preceded by \\A. In cases where it is known that the subject
 Line 1284 
 itself. So the pattern
  matches "sense and sensibility" and "response and responsibility", but not
  "sense and responsibility". If caseful matching is in force at the time of the
- back reference, then the case of letters is relevant. For example,
+ back reference, the case of letters is relevant. For example,
    ((?i)rah)\\s+\\1
 Line 1292 
 matches "rah rah" and "RAH RAH", but not
  capturing subpattern is matched caselessly.
  There may be more than one back reference to the same subpattern. If a
- subpattern has not actually been used in a particular match, then any back
+ subpattern has not actually been used in a particular match, any back
  references to it always fail. For example, the pattern
    (a|(bc))\\2
 Line 1300 
 references to it always fail. For exampl
  always fails if it starts to match "a" rather than "bc". Because there may be
  up to 99 back references, all digits following the backslash are taken
  as part of a potential back reference number. If the pattern continues with a
- digit character, then some delimiter must be used to terminate the back
+ digit character, some delimiter must be used to terminate the back reference.
- reference. If the PCRE_EXTENDED option is set, this can be whitespace.
+ If the PCRE_EXTENDED option is set, this can be whitespace. Otherwise an empty
- Otherwise an empty comment can be used.
+ comment can be used.
  A back reference that occurs inside the parentheses to which it refers fails
  when the subpattern is first used, so, for example, (a\\1) never matches.
 Line 1390 
 Several assertions (of any sort) may occ
  matches "foo" preceded by three digits that are not "999". Notice that each of
  the assertions is applied independently at the same point in the subject
  string. First there is a check that the previous three characters are all
- digits, then there is a check that the same three characters are not "999".
+ digits, and then there is a check that the same three characters are not "999".
  This pattern does \fInot\fR match "foo" preceded by six characters, the first
  of which are digits and the last three of which are not "999". For example, it
  doesn't match "123abcfoo". A pattern to do that is
 Line 1475 
 what follows matches the rest of the pat
    ^.*abcd$
- then the initial .* matches the entire string at first, but when this fails
+ the initial .* matches the entire string at first, but when this fails (because
- (because there is no following "a"), it backtracks to match all but the last
+ there is no following "a"), it backtracks to match all but the last character,
- character, then all but the last two characters, and so on. Once again the
+ then all but the last two characters, and so on. Once again the search for "a"
- search for "a" covers the entire string, from right to left, so we are no
+ covers the entire string, from right to left, so we are no better off. However,
- better off. However, if the pattern is written as
+ if the pattern is written as
    ^(?>.*)(?<=abcd)
- then there can be no backtracking for the .* item; it can match only the entire
+ there can be no backtracking for the .* item; it can match only the entire
  string. The subsequent lookbehind assertion does a single test on the last four
  characters. If it fails, the match fails immediately. For long strings, this
  approach makes a significant difference to the processing time.
 Line 1528 
 no-pattern (if present) is used. If ther
  subpattern, a compile-time error occurs.
  There are two kinds of condition. If the text between the parentheses consists
- of a sequence of digits, then the condition is satisfied if the capturing
+ of a sequence of digits, the condition is satisfied if the capturing subpattern
- subpattern of that number has previously matched. Consider the following
+ of that number has previously matched. Consider the following pattern, which
- pattern, which contains non-significant white space to make it more readable
+ contains non-significant white space to make it more readable (assume the
- (assume the PCRE_EXTENDED option) and to divide it into three parts for ease
+ PCRE_EXTENDED option) and to divide it into three parts for ease of discussion:
- of discussion:
    ( \\( )?    [^()]+    (?(1) \\) )
-Line 1622 
 on at the top level. If additional paren
+Line 1621 
 on at the top level. If additional paren
    \\( ( ( (?>[^()]+) | (?R) )* ) \\)
       ^                        ^
       ^                        ^
- then the string they capture is "ab(cd)ef", the contents of the top level
+ the string they capture is "ab(cd)ef", the contents of the top level
  parentheses. If there are more than 15 capturing parentheses in a pattern, PCRE
  has to obtain extra memory to store data during a recursion, which it does by
  using \fBpcre_malloc\fR, freeing it via \fBpcre_free\fR afterwards. If no

 Legend:



Removed from v.43
 


changed lines


 
Added in v.47
 Legend:



Removed from v.43
 


changed lines


 
Added in v.47
-Removed from v.43
+Added in v.47

	ViewVC Help
Powered by ViewVC 1.1.5