/[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 428 by ph10, Mon Aug 31 17:10:26 2009 UTC revision 440 by ph10, Wed Sep 9 10:14:40 2009 UTC
# Line 135  Applications can use these to include su Line 135  Applications can use these to include su
135  The functions \fBpcre_compile()\fP, \fBpcre_compile2()\fP, \fBpcre_study()\fP,  The functions \fBpcre_compile()\fP, \fBpcre_compile2()\fP, \fBpcre_study()\fP,
136  and \fBpcre_exec()\fP are used for compiling and matching regular expressions  and \fBpcre_exec()\fP are used for compiling and matching regular expressions
137  in a Perl-compatible manner. A sample program that demonstrates the simplest  in a Perl-compatible manner. A sample program that demonstrates the simplest
138  way of using them is provided in the file called \fIpcredemo.c\fP in the source  way of using them is provided in the file called \fIpcredemo.c\fP in the PCRE
139  distribution. The  source distribution. A listing of this program is given in the
140    .\" HREF
141    \fBpcredemo\fP
142    .\"
143    documentation, and the
144  .\" HREF  .\" HREF
145  \fBpcresample\fP  \fBpcresample\fP
146  .\"  .\"
# Line 145  documentation describes how to compile a Line 149  documentation describes how to compile a
149  A second matching function, \fBpcre_dfa_exec()\fP, which is not  A second matching function, \fBpcre_dfa_exec()\fP, which is not
150  Perl-compatible, is also provided. This uses a different algorithm for the  Perl-compatible, is also provided. This uses a different algorithm for the
151  matching. The alternative algorithm finds all possible matches (at a given  matching. The alternative algorithm finds all possible matches (at a given
152  point in the subject), and scans the subject just once. However, this algorithm  point in the subject), and scans the subject just once (unless there are
153  does not return captured substrings. A description of the two matching  lookbehind assertions). However, this algorithm does not return captured
154  algorithms and their advantages and disadvantages is given in the  substrings. A description of the two matching algorithms and their advantages
155    and disadvantages is given in the
156  .\" HREF  .\" HREF
157  \fBpcrematching\fP  \fBpcrematching\fP
158  .\"  .\"
# Line 1007  different for each compiled pattern. Line 1012  different for each compiled pattern.
1012  .sp  .sp
1013    PCRE_INFO_OKPARTIAL    PCRE_INFO_OKPARTIAL
1014  .sp  .sp
1015  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 with
1016  fourth argument should point to an \fBint\fP variable. From release 8.00, this  \fBpcre_exec()\fP, otherwise 0. The fourth argument should point to an
1017  always returns 1, because the restrictions that previously applied to partial  \fBint\fP variable. From release 8.00, this always returns 1, because the
1018  matching have been lifted. The  restrictions that previously applied to partial matching have been lifted. The
1019  .\" HREF  .\" HREF
1020  \fBpcrepartial\fP  \fBpcrepartial\fP
1021  .\"  .\"
# Line 1214  with a \fBpcre_extra\fP block in which \ Line 1219  with a \fBpcre_extra\fP block in which \
1219  PCRE_EXTRA_MATCH_LIMIT_RECURSION is set in the \fIflags\fP field. If the limit  PCRE_EXTRA_MATCH_LIMIT_RECURSION is set in the \fIflags\fP field. If the limit
1220  is exceeded, \fBpcre_exec()\fP returns PCRE_ERROR_RECURSIONLIMIT.  is exceeded, \fBpcre_exec()\fP returns PCRE_ERROR_RECURSIONLIMIT.
1221  .P  .P
1222  The \fIpcre_callout\fP field is used in conjunction with the "callout" feature,  The \fIcallout_data\fP field is used in conjunction with the "callout" feature,
1223  which is described in the  and is described in the
1224  .\" HREF  .\" HREF
1225  \fBpcrecallout\fP  \fBpcrecallout\fP
1226  .\"  .\"
# Line 1327  when using the /g modifier. It is possib Line 1332  when using the /g modifier. It is possib
1332  matching a null string by first trying the match again at the same offset with  matching a null string by first trying the match again at the same offset with
1333  PCRE_NOTEMPTY and PCRE_ANCHORED, and then if that fails by advancing the  PCRE_NOTEMPTY and PCRE_ANCHORED, and then if that fails by advancing the
1334  starting offset (see below) and trying an ordinary match again. There is some  starting offset (see below) and trying an ordinary match again. There is some
1335  code that demonstrates how to do this in the \fIpcredemo.c\fP sample program.  code that demonstrates how to do this in the
1336    .\" HREF
1337    \fBpcredemo\fP
1338    .\"
1339    sample program.
1340  .sp  .sp
1341    PCRE_NO_START_OPTIMIZE    PCRE_NO_START_OPTIMIZE
1342  .sp  .sp
# Line 1379  PCRE_PARTIAL_HARD is set, \fBpcre_exec() Line 1388  PCRE_PARTIAL_HARD is set, \fBpcre_exec()
1388  PCRE_ERROR_PARTIAL. Otherwise, if PCRE_PARTIAL_SOFT is set, matching continues  PCRE_ERROR_PARTIAL. Otherwise, if PCRE_PARTIAL_SOFT is set, matching continues
1389  by testing any other alternatives. Only if they all fail is PCRE_ERROR_PARTIAL  by testing any other alternatives. Only if they all fail is PCRE_ERROR_PARTIAL
1390  returned (instead of PCRE_ERROR_NOMATCH). The portion of the string that  returned (instead of PCRE_ERROR_NOMATCH). The portion of the string that
1391  provided the partial match is set as the first matching string. There is a more  was inspected when the partial match was found is set as the first matching
1392  detailed discussion in the  string. There is a more detailed discussion in the
1393  .\" HREF  .\" HREF
1394  \fBpcrepartial\fP  \fBpcrepartial\fP
1395  .\"  .\"
# Line 1826  a compiled pattern, using a matching alg Line 1835  a compiled pattern, using a matching alg
1835  just once, and does not backtrack. This has different characteristics to the  just once, and does not backtrack. This has different characteristics to the
1836  normal algorithm, and is not compatible with Perl. Some of the features of PCRE  normal algorithm, and is not compatible with Perl. Some of the features of PCRE
1837  patterns are not supported. Nevertheless, there are times when this kind of  patterns are not supported. Nevertheless, there are times when this kind of
1838  matching can be useful. For a discussion of the two matching algorithms, see  matching can be useful. For a discussion of the two matching algorithms, and a
1839  the  list of features that \fBpcre_dfa_exec()\fP does not support, see the
1840  .\" HREF  .\" HREF
1841  \fBpcrematching\fP  \fBpcrematching\fP
1842  .\"  .\"
# Line 1882  additional characters. This happens even Line 1891  additional characters. This happens even
1891  been found. When PCRE_PARTIAL_SOFT is set, the return code PCRE_ERROR_NOMATCH  been found. When PCRE_PARTIAL_SOFT is set, the return code PCRE_ERROR_NOMATCH
1892  is converted into PCRE_ERROR_PARTIAL if the end of the subject is reached,  is converted into PCRE_ERROR_PARTIAL if the end of the subject is reached,
1893  there have been no complete matches, but there is still at least one matching  there have been no complete matches, but there is still at least one matching
1894  possibility. The portion of the string that provided the longest partial match  possibility. The portion of the string that was inspected when the longest
1895  is set as the first matching string in both cases.  partial match was found is set as the first matching string in both cases.
1896  .sp  .sp
1897    PCRE_DFA_SHORTEST    PCRE_DFA_SHORTEST
1898  .sp  .sp
# Line 2003  Cambridge CB2 3QH, England. Line 2012  Cambridge CB2 3QH, England.
2012  .rs  .rs
2013  .sp  .sp
2014  .nf  .nf
2015  Last updated: 29 August 2009  Last updated: 09 September 2009
2016  Copyright (c) 1997-2009 University of Cambridge.  Copyright (c) 1997-2009 University of Cambridge.
2017  .fi  .fi

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

  ViewVC Help
Powered by ViewVC 1.1.5