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

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

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

revision 389 by ph10, Sun Mar 15 18:24:05 2009 UTC revision 428 by ph10, Mon Aug 31 17:10:26 2009 UTC
# Line 317  properties is available; otherwise it is Line 317  properties is available; otherwise it is
317  .sp  .sp
318  The output is an integer whose value specifies the default character sequence  The output is an integer whose value specifies the default character sequence
319  that is recognized as meaning "newline". The four values that are supported  that is recognized as meaning "newline". The four values that are supported
320  are: 10 for LF, 13 for CR, 3338 for CRLF, -2 for ANYCRLF, and -1 for ANY. The  are: 10 for LF, 13 for CR, 3338 for CRLF, -2 for ANYCRLF, and -1 for ANY.
321  default should normally be the standard sequence for your operating system.  Though they are derived from ASCII, the same values are returned in EBCDIC
322    environments. The default should normally correspond to the standard sequence
323    for your operating system.
324  .sp  .sp
325    PCRE_CONFIG_BSR    PCRE_CONFIG_BSR
326  .sp  .sp
# Line 404  argument, which is an address (see below Line 406  argument, which is an address (see below
406  .P  .P
407  The \fIoptions\fP argument contains various bit settings that affect the  The \fIoptions\fP argument contains various bit settings that affect the
408  compilation. It should be zero if no options are required. The available  compilation. It should be zero if no options are required. The available
409  options are described below. Some of them, in particular, those that are  options are described below. Some of them (in particular, those that are
410  compatible with Perl, can also be set and unset from within the pattern (see  compatible with Perl, but also some others) can also be set and unset from
411  the detailed description in the  within the pattern (see the detailed description in the
412  .\" HREF  .\" HREF
413  \fBpcrepattern\fP  \fBpcrepattern\fP
414  .\"  .\"
415  documentation). For these options, the contents of the \fIoptions\fP argument  documentation). For those options that can be different in different parts of
416  specifies their initial settings at the start of compilation and execution. The  the pattern, the contents of the \fIoptions\fP argument specifies their initial
417  PCRE_ANCHORED and PCRE_NEWLINE_\fIxxx\fP options can be set at the time of  settings at the start of compilation and execution. The PCRE_ANCHORED and
418  matching as well as at compile time.  PCRE_NEWLINE_\fIxxx\fP options can be set at the time of matching as well as at
419    compile time.
420  .P  .P
421  If \fIerrptr\fP is NULL, \fBpcre_compile()\fP returns NULL immediately.  If \fIerrptr\fP is NULL, \fBpcre_compile()\fP returns NULL immediately.
422  Otherwise, if compilation of a pattern fails, \fBpcre_compile()\fP returns  Otherwise, if compilation of a pattern fails, \fBpcre_compile()\fP returns
# Line 1005  different for each compiled pattern. Line 1008  different for each compiled pattern.
1008    PCRE_INFO_OKPARTIAL    PCRE_INFO_OKPARTIAL
1009  .sp  .sp
1010  Return 1 if the pattern can be used for partial matching, otherwise 0. The  Return 1 if the pattern can be used for partial matching, otherwise 0. The
1011  fourth argument should point to an \fBint\fP variable. The  fourth argument should point to an \fBint\fP variable. From release 8.00, this
1012    always returns 1, because the restrictions that previously applied to partial
1013    matching have been lifted. The
1014  .\" HREF  .\" HREF
1015  \fBpcrepartial\fP  \fBpcrepartial\fP
1016  .\"  .\"
1017  documentation lists the restrictions that apply to patterns when partial  documentation gives details of partial matching.
 matching is used.  
1018  .sp  .sp
1019    PCRE_INFO_OPTIONS    PCRE_INFO_OPTIONS
1020  .sp  .sp
# Line 1238  documentation for a discussion of saving Line 1242  documentation for a discussion of saving
1242  The unused bits of the \fIoptions\fP argument for \fBpcre_exec()\fP must be  The unused bits of the \fIoptions\fP argument for \fBpcre_exec()\fP must be
1243  zero. The only bits that may be set are PCRE_ANCHORED, PCRE_NEWLINE_\fIxxx\fP,  zero. The only bits that may be set are PCRE_ANCHORED, PCRE_NEWLINE_\fIxxx\fP,
1244  PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NO_START_OPTIMIZE,  PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NO_START_OPTIMIZE,
1245  PCRE_NO_UTF8_CHECK and PCRE_PARTIAL.  PCRE_NO_UTF8_CHECK, PCRE_PARTIAL_SOFT, and PCRE_PARTIAL_HARD.
1246  .sp  .sp
1247    PCRE_ANCHORED    PCRE_ANCHORED
1248  .sp  .sp
# Line 1327  code that demonstrates how to do this in Line 1331  code that demonstrates how to do this in
1331  .sp  .sp
1332    PCRE_NO_START_OPTIMIZE    PCRE_NO_START_OPTIMIZE
1333  .sp  .sp
1334  There are a number of optimizations that \fBpcre_exec()\fP uses at the start of  There are a number of optimizations that \fBpcre_exec()\fP uses at the start of
1335  a match, in order to speed up the process. For example, if it is known that a  a match, in order to speed up the process. For example, if it is known that a
1336  match must start with a specific character, it searches the subject for that  match must start with a specific character, it searches the subject for that
1337  character, and fails immediately if it cannot find it, without actually running  character, and fails immediately if it cannot find it, without actually running
# Line 1364  PCRE_NO_UTF8_CHECK is set, the effect of Line 1368  PCRE_NO_UTF8_CHECK is set, the effect of
1368  subject, or a value of \fIstartoffset\fP that does not point to the start of a  subject, or a value of \fIstartoffset\fP that does not point to the start of a
1369  UTF-8 character, is undefined. Your program may crash.  UTF-8 character, is undefined. Your program may crash.
1370  .sp  .sp
1371    PCRE_PARTIAL    PCRE_PARTIAL_HARD
1372      PCRE_PARTIAL_SOFT
1373  .sp  .sp
1374  This option turns on the partial matching feature. If the subject string fails  These options turn on the partial matching feature. For backwards
1375  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
1376  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
1377  the failure to match occurred only because there were not enough subject  not enough subject characters to complete the match. If this happens when
1378  characters), \fBpcre_exec()\fP returns PCRE_ERROR_PARTIAL instead of  PCRE_PARTIAL_HARD is set, \fBpcre_exec()\fP immediately returns
1379  PCRE_ERROR_NOMATCH. When PCRE_PARTIAL is used, there are restrictions on what  PCRE_ERROR_PARTIAL. Otherwise, if PCRE_PARTIAL_SOFT is set, matching continues
1380  may appear in the pattern. These are discussed in the  by testing any other alternatives. Only if they all fail is PCRE_ERROR_PARTIAL
1381    returned (instead of PCRE_ERROR_NOMATCH). The portion of the string that
1382    provided the partial match is set as the first matching string. There is a more
1383    detailed discussion in the
1384  .\" HREF  .\" HREF
1385  \fBpcrepartial\fP  \fBpcrepartial\fP
1386  .\"  .\"
# Line 1565  documentation for details of partial mat Line 1573  documentation for details of partial mat
1573  .sp  .sp
1574    PCRE_ERROR_BADPARTIAL     (-13)    PCRE_ERROR_BADPARTIAL     (-13)
1575  .sp  .sp
1576  The PCRE_PARTIAL option was used with a compiled pattern containing items that  This code is no longer in use. It was formerly returned when the PCRE_PARTIAL
1577  are not supported for partial matching. See the  option was used with a compiled pattern containing items that were not
1578  .\" HREF  supported for partial matching. From release 8.00 onwards, there are no
1579  \fBpcrepartial\fP  restrictions on partial matching.
 .\"  
 documentation for details of partial matching.  
1580  .sp  .sp
1581    PCRE_ERROR_INTERNAL       (-14)    PCRE_ERROR_INTERNAL       (-14)
1582  .sp  .sp
# Line 1742  appropriate. \fBNOTE:\fP If PCRE_DUPNAME Line 1748  appropriate. \fBNOTE:\fP If PCRE_DUPNAME
1748  the behaviour may not be what you want (see the next section).  the behaviour may not be what you want (see the next section).
1749  .P  .P
1750  \fBWarning:\fP If the pattern uses the "(?|" feature to set up multiple  \fBWarning:\fP If the pattern uses the "(?|" feature to set up multiple
1751  subpatterns with the same number, you cannot use names to distinguish them,  subpatterns with the same number, you cannot use names to distinguish them,
1752  because names are not included in the compiled code. The matching process uses  because names are not included in the compiled code. The matching process uses
1753  only numbers.  only numbers.
1754  .  .
1755  .SH "DUPLICATE SUBPATTERN NAMES"  .SH "DUPLICATE SUBPATTERN NAMES"
# Line 1860  Here is an example of a simple call to \ Line 1866  Here is an example of a simple call to \
1866  .sp  .sp
1867  The unused bits of the \fIoptions\fP argument for \fBpcre_dfa_exec()\fP must be  The unused bits of the \fIoptions\fP argument for \fBpcre_dfa_exec()\fP must be
1868  zero. The only bits that may be set are PCRE_ANCHORED, PCRE_NEWLINE_\fIxxx\fP,  zero. The only bits that may be set are PCRE_ANCHORED, PCRE_NEWLINE_\fIxxx\fP,
1869  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,
1870  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
1871  the same as for \fBpcre_exec()\fP, so their description is not repeated here.  four of these are exactly the same as for \fBpcre_exec()\fP, so their
1872  .sp  description is not repeated here.
1873    PCRE_PARTIAL  .sp
1874  .sp    PCRE_PARTIAL_HARD
1875  This has the same general effect as it does for \fBpcre_exec()\fP, but the    PCRE_PARTIAL_SOFT
1876  details are slightly different. When PCRE_PARTIAL is set for  .sp
1877  \fBpcre_dfa_exec()\fP, the return code PCRE_ERROR_NOMATCH is converted into  These have the same general effect as they do for \fBpcre_exec()\fP, but the
1878  PCRE_ERROR_PARTIAL if the end of the subject is reached, there have been no  details are slightly different. When PCRE_PARTIAL_HARD is set for
1879  complete matches, but there is still at least one matching possibility. The  \fBpcre_dfa_exec()\fP, it returns PCRE_ERROR_PARTIAL if the end of the subject
1880  portion of the string that provided the partial match is set as the first  is reached and there is still at least one matching possibility that requires
1881  matching string.  additional characters. This happens even if some complete matches have also
1882    been found. When PCRE_PARTIAL_SOFT is set, the return code PCRE_ERROR_NOMATCH
1883    is converted into PCRE_ERROR_PARTIAL if the end of the subject is reached,
1884    there have been no complete matches, but there is still at least one matching
1885    possibility. The portion of the string that provided the longest partial match
1886    is set as the first matching string in both cases.
1887  .sp  .sp
1888    PCRE_DFA_SHORTEST    PCRE_DFA_SHORTEST
1889  .sp  .sp
# Line 1883  matching point in the subject string. Line 1894  matching point in the subject string.
1894  .sp  .sp
1895    PCRE_DFA_RESTART    PCRE_DFA_RESTART
1896  .sp  .sp
1897  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
1898  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
1899  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
1900  option requests this action; when it is set, the \fIworkspace\fP and  \fIworkspace\fP and \fIwscount\fP options must reference the same vector as
1901  \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
1902  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  
1903  .\" HREF  .\" HREF
1904  \fBpcrepartial\fP  \fBpcrepartial\fP
1905  .\"  .\"
# Line 1993  Cambridge CB2 3QH, England. Line 2003  Cambridge CB2 3QH, England.
2003  .rs  .rs
2004  .sp  .sp
2005  .nf  .nf
2006  Last updated: 15 March 2009  Last updated: 29 August 2009
2007  Copyright (c) 1997-2009 University of Cambridge.  Copyright (c) 1997-2009 University of Cambridge.
2008  .fi  .fi

Legend:
Removed from v.389  
changed lines
  Added in v.428

  ViewVC Help
Powered by ViewVC 1.1.5