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

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

Parent Directory | Revision Log | View Patch Patch

-revision 426 by ph10,
Wed Aug 26 15:38:32 2009 UTC
+revision 428 by ph10,
Mon Aug 31 17:10:26 2009 UTC
 Line 1242 
 documentation for a discussion of saving
  The unused bits of the \fIoptions\fP argument for \fBpcre_exec()\fP must be
  zero. The only bits that may be set are PCRE_ANCHORED, PCRE_NEWLINE_\fIxxx\fP,
  PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NO_START_OPTIMIZE,
- PCRE_NO_UTF8_CHECK and PCRE_PARTIAL.
+ PCRE_NO_UTF8_CHECK, PCRE_PARTIAL_SOFT, and PCRE_PARTIAL_HARD.
  .sp
    PCRE_ANCHORED
  .sp
 Line 1368 
 PCRE_NO_UTF8_CHECK is set, the effect of
  subject, or a value of \fIstartoffset\fP that does not point to the start of a
  UTF-8 character, is undefined. Your program may crash.
  .sp
-   PCRE_PARTIAL
+   PCRE_PARTIAL_HARD
+   PCRE_PARTIAL_SOFT
  .sp
- This option turns on the partial matching feature. If the subject string fails
+ These options turn on the partial matching feature. For backwards
- to match the pattern, but at some point during the matching process the end of
+ compatibility, PCRE_PARTIAL is a synonym for PCRE_PARTIAL_SOFT. A partial match
- the subject was reached (that is, the subject partially matches the pattern and
+ occurs if the end of the subject string is reached successfully, but there are
- the failure to match occurred only because there were not enough subject
+ not enough subject characters to complete the match. If this happens when
- characters), \fBpcre_exec()\fP returns PCRE_ERROR_PARTIAL instead of
+ PCRE_PARTIAL_HARD is set, \fBpcre_exec()\fP immediately returns
- PCRE_ERROR_NOMATCH. The portion of the string that provided the longest partial
+ PCRE_ERROR_PARTIAL. Otherwise, if PCRE_PARTIAL_SOFT is set, matching continues
- match is set as the first matching string. There is further discussion in the
+ by testing any other alternatives. Only if they all fail is PCRE_ERROR_PARTIAL
+ returned (instead of PCRE_ERROR_NOMATCH). The portion of the string that
+ provided the partial match is set as the first matching string. There is a more
+ detailed discussion in the
  .\" HREF
  \fBpcrepartial\fP
  .\"
-Line 1862 
 Here is an example of a simple call to \
+Line 1866 
 Here is an example of a simple call to \
  .sp
  The unused bits of the \fIoptions\fP argument for \fBpcre_dfa_exec()\fP must be
  zero. The only bits that may be set are PCRE_ANCHORED, PCRE_NEWLINE_\fIxxx\fP,
- PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NO_UTF8_CHECK, PCRE_PARTIAL,
+ PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NO_UTF8_CHECK, PCRE_PARTIAL_HARD,
- PCRE_DFA_SHORTEST, and PCRE_DFA_RESTART. All but the last three of these are
+ PCRE_PARTIAL_SOFT, PCRE_DFA_SHORTEST, and PCRE_DFA_RESTART. All but the last
- exactly the same as for \fBpcre_exec()\fP, so their description is not repeated
+ four of these are exactly the same as for \fBpcre_exec()\fP, so their
- here.
+ description is not repeated here.
  .sp
-   PCRE_PARTIAL
+   PCRE_PARTIAL_HARD
- .sp
+   PCRE_PARTIAL_SOFT
- This has the same general effect as it does for \fBpcre_exec()\fP, but the
+ .sp
- details are slightly different. When PCRE_PARTIAL is set for
+ These have the same general effect as they do for \fBpcre_exec()\fP, but the
- \fBpcre_dfa_exec()\fP, the return code PCRE_ERROR_NOMATCH is converted into
+ details are slightly different. When PCRE_PARTIAL_HARD is set for
- PCRE_ERROR_PARTIAL if the end of the subject is reached, there have been no
+ \fBpcre_dfa_exec()\fP, it returns PCRE_ERROR_PARTIAL if the end of the subject
- complete matches, but there is still at least one matching possibility. The
+ is reached and there is still at least one matching possibility that requires
- portion of the string that provided the longest partial match is set as the
+ additional characters. This happens even if some complete matches have also
- first matching string.
+ been found. When PCRE_PARTIAL_SOFT is set, the return code PCRE_ERROR_NOMATCH
+ is converted into PCRE_ERROR_PARTIAL if the end of the subject is reached,
+ there have been no complete matches, but there is still at least one matching
+ possibility. The portion of the string that provided the longest partial match
+ is set as the first matching string in both cases.
  .sp
    PCRE_DFA_SHORTEST
  .sp
-Line 1886 
 matching point in the subject string.
+Line 1894 
 matching point in the subject string.
  .sp
    PCRE_DFA_RESTART
  .sp
- When \fBpcre_dfa_exec()\fP is called with the PCRE_PARTIAL option, and returns
+ When \fBpcre_dfa_exec()\fP returns a partial match, it is possible to call it
- a partial match, it is possible to call it again, with additional subject
+ again, with additional subject characters, and have it continue with the same
- characters, and have it continue with the same match. The PCRE_DFA_RESTART
+ match. The PCRE_DFA_RESTART option requests this action; when it is set, the
- option requests this action; when it is set, the \fIworkspace\fP and
+ \fIworkspace\fP and \fIwscount\fP options must reference the same vector as
- \fIwscount\fP options must reference the same vector as before because data
+ before because data about the match so far is left in them after a partial
- about the match so far is left in them after a partial match. There is more
+ match. There is more discussion of this facility in the
- discussion of this facility in the
  .\" HREF
  \fBpcrepartial\fP
  .\"
-Line 1996 
 Cambridge CB2 3QH, England.
+Line 2003 
 Cambridge CB2 3QH, England.
  .rs
  .sp
  .nf
- Last updated: 26 August 2009
+ Last updated: 29 August 2009
  Copyright (c) 1997-2009 University of Cambridge.
  .fi

 Legend:



Removed from v.426
 


changed lines


 
Added in v.428
 Legend:



Removed from v.426
 


changed lines


 
Added in v.428
-Removed from v.426
+Added in v.428

	ViewVC Help
Powered by ViewVC 1.1.5