/[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 921 by ph10, Sat Feb 18 18:45:55 2012 UTC revision 960 by ph10, Thu Apr 19 17:30:38 2012 UTC
# Line 1  Line 1 
1  .TH PCREAPI 3  .TH PCREAPI 3 "19 April 2012" "PCRE 8.31"
2  .SH NAME  .SH NAME
3  PCRE - Perl-compatible regular expressions  PCRE - Perl-compatible regular expressions
4  .sp  .sp
# Line 526  documentation). For those options that c Line 526  documentation). For those options that c
526  the pattern, the contents of the \fIoptions\fP argument specifies their  the pattern, the contents of the \fIoptions\fP argument specifies their
527  settings at the start of compilation and execution. The PCRE_ANCHORED,  settings at the start of compilation and execution. The PCRE_ANCHORED,
528  PCRE_BSR_\fIxxx\fP, PCRE_NEWLINE_\fIxxx\fP, PCRE_NO_UTF8_CHECK, and  PCRE_BSR_\fIxxx\fP, PCRE_NEWLINE_\fIxxx\fP, PCRE_NO_UTF8_CHECK, and
529  PCRE_NO_START_OPT options can be set at the time of matching as well as at  PCRE_NO_START_OPTIMIZE options can be set at the time of matching as well as at
530  compile time.  compile time.
531  .P  .P
532  If \fIerrptr\fP is NULL, \fBpcre_compile()\fP returns NULL immediately.  If \fIerrptr\fP is NULL, \fBpcre_compile()\fP returns NULL immediately.
# Line 1235  only if it follows something of variable Line 1235  only if it follows something of variable
1235  /^a\ed+z\ed+/ the returned value is "z", but for /^a\edz\ed/ the returned value  /^a\ed+z\ed+/ the returned value is "z", but for /^a\edz\ed/ the returned value
1236  is -1.  is -1.
1237  .sp  .sp
1238      PCRE_INFO_MAXLOOKBEHIND
1239    .sp
1240    Return the number of characters (NB not bytes) in the longest lookbehind
1241    assertion in the pattern. Note that the simple assertions \eb and \eB require a
1242    one-character lookbehind. This information is useful when doing multi-segment
1243    matching using the partial matching facilities.
1244    .sp
1245    PCRE_INFO_MINLENGTH    PCRE_INFO_MINLENGTH
1246  .sp  .sp
1247  If the pattern was studied and a minimum length for matching subject strings  If the pattern was studied and a minimum length for matching subject strings
# Line 1465  fields (not necessarily in this order): Line 1472  fields (not necessarily in this order):
1472  In the 16-bit version of this structure, the \fImark\fP field has type  In the 16-bit version of this structure, the \fImark\fP field has type
1473  "PCRE_UCHAR16 **".  "PCRE_UCHAR16 **".
1474  .P  .P
1475  The \fIflags\fP field is a bitmap that specifies which of the other fields  The \fIflags\fP field is used to specify which of the other fields are set. The
1476  are set. The flag bits are:  flag bits are:
1477  .sp  .sp
1478    PCRE_EXTRA_STUDY_DATA    PCRE_EXTRA_CALLOUT_DATA
1479    PCRE_EXTRA_EXECUTABLE_JIT    PCRE_EXTRA_EXECUTABLE_JIT
1480      PCRE_EXTRA_MARK
1481    PCRE_EXTRA_MATCH_LIMIT    PCRE_EXTRA_MATCH_LIMIT
1482    PCRE_EXTRA_MATCH_LIMIT_RECURSION    PCRE_EXTRA_MATCH_LIMIT_RECURSION
1483    PCRE_EXTRA_CALLOUT_DATA    PCRE_EXTRA_STUDY_DATA
1484    PCRE_EXTRA_TABLES    PCRE_EXTRA_TABLES
   PCRE_EXTRA_MARK  
1485  .sp  .sp
1486  Other flag bits should be set to zero. The \fIstudy_data\fP field and sometimes  Other flag bits should be set to zero. The \fIstudy_data\fP field and sometimes
1487  the \fIexecutable_jit\fP field are set in the \fBpcre_extra\fP block that is  the \fIexecutable_jit\fP field are set in the \fBpcre_extra\fP block that is
1488  returned by \fBpcre_study()\fP, together with the appropriate flag bits. You  returned by \fBpcre_study()\fP, together with the appropriate flag bits. You
1489  should not set these yourself, but you may add to the block by setting the  should not set these yourself, but you may add to the block by setting other
1490  other fields and their corresponding flag bits.  fields and their corresponding flag bits.
1491  .P  .P
1492  The \fImatch_limit\fP field provides a means of preventing PCRE from using up a  The \fImatch_limit\fP field provides a means of preventing PCRE from using up a
1493  vast amount of resources when running patterns that are not going to match,  vast amount of resources when running patterns that are not going to match,
# Line 1734  returned. Line 1741  returned.
1741  .sp  .sp
1742  When PCRE_UTF8 is set at compile time, the validity of the subject as a UTF-8  When PCRE_UTF8 is set at compile time, the validity of the subject as a UTF-8
1743  string is automatically checked when \fBpcre_exec()\fP is subsequently called.  string is automatically checked when \fBpcre_exec()\fP is subsequently called.
1744  The value of \fIstartoffset\fP is also checked to ensure that it points to the  The entire string is checked before any other processing takes place. The value
1745  start of a UTF-8 character. There is a discussion about the validity of UTF-8  of \fIstartoffset\fP is also checked to ensure that it points to the start of a
1746  strings in the  UTF-8 character. There is a discussion about the
1747    .\" HTML <a href="pcreunicode.html#utf8strings">
1748    .\" </a>
1749    validity of UTF-8 strings
1750    .\"
1751    in the
1752  .\" HREF  .\" HREF
1753  \fBpcreunicode\fP  \fBpcreunicode\fP
1754  .\"  .\"
# Line 1884  string that it matched that is returned. Line 1896  string that it matched that is returned.
1896  .P  .P
1897  If the vector is too small to hold all the captured substring offsets, it is  If the vector is too small to hold all the captured substring offsets, it is
1898  used as far as possible (up to two-thirds of its length), and the function  used as far as possible (up to two-thirds of its length), and the function
1899  returns a value of zero. If neither the actual string matched not any captured  returns a value of zero. If neither the actual string matched nor any captured
1900  substrings are of interest, \fBpcre_exec()\fP may be called with \fIovector\fP  substrings are of interest, \fBpcre_exec()\fP may be called with \fIovector\fP
1901  passed as NULL and \fIovecsize\fP as zero. However, if the pattern contains  passed as NULL and \fIovecsize\fP as zero. However, if the pattern contains
1902  back references and the \fIovector\fP is not big enough to remember the related  back references and the \fIovector\fP is not big enough to remember the related
# Line 2084  time. Line 2096  time.
2096  .sp  .sp
2097    PCRE_ERROR_JIT_STACKLIMIT (-27)    PCRE_ERROR_JIT_STACKLIMIT (-27)
2098  .sp  .sp
2099  This error is returned when a pattern that was successfully studied using the  This error is returned when a pattern that was successfully studied using a
2100  PCRE_STUDY_JIT_COMPILE option is being matched, but the memory available for  JIT compile option is being matched, but the memory available for the
2101  the just-in-time processing stack is not large enough. See the  just-in-time processing stack is not large enough. See the
2102  .\" HREF  .\" HREF
2103  \fBpcrejit\fP  \fBpcrejit\fP
2104  .\"  .\"
2105  documentation for more details.  documentation for more details.
2106  .sp  .sp
2107    PCRE_ERROR_BADMODE (-28)    PCRE_ERROR_BADMODE        (-28)
2108  .sp  .sp
2109  This error is given if a pattern that was compiled by the 8-bit library is  This error is given if a pattern that was compiled by the 8-bit library is
2110  passed to a 16-bit library function, or vice versa.  passed to a 16-bit library function, or vice versa.
2111  .sp  .sp
2112    PCRE_ERROR_BADENDIANNESS (-29)    PCRE_ERROR_BADENDIANNESS  (-29)
2113  .sp  .sp
2114  This error is given if a pattern that was compiled and saved is reloaded on a  This error is given if a pattern that was compiled and saved is reloaded on a
2115  host with different endianness. The utility function  host with different endianness. The utility function
2116  \fBpcre_pattern_to_host_byte_order()\fP can be used to convert such a pattern  \fBpcre_pattern_to_host_byte_order()\fP can be used to convert such a pattern
2117  so that it runs on the new host.  so that it runs on the new host.
2118  .P  .P
2119  Error numbers -16 to -20 and -22 are not used by \fBpcre_exec()\fP.  Error numbers -16 to -20, -22, and -30 are not used by \fBpcre_exec()\fP.
2120  .  .
2121  .  .
2122  .\" HTML <a name="badutf8reasons"></a>  .\" HTML <a name="badutf8reasons"></a>
# Line 2622  When a recursive subpattern is processed Line 2634  When a recursive subpattern is processed
2634  recursively, using private vectors for \fIovector\fP and \fIworkspace\fP. This  recursively, using private vectors for \fIovector\fP and \fIworkspace\fP. This
2635  error is given if the output vector is not large enough. This should be  error is given if the output vector is not large enough. This should be
2636  extremely rare, as a vector of size 1000 is used.  extremely rare, as a vector of size 1000 is used.
2637    .sp
2638      PCRE_ERROR_DFA_BADRESTART (-30)
2639    .sp
2640    When \fBpcre_dfa_exec()\fP is called with the \fBPCRE_DFA_RESTART\fP option,
2641    some plausibility checks are made on the contents of the workspace, which
2642    should contain data about the previous partial match. If any of these checks
2643    fail, this error is given.
2644  .  .
2645  .  .
2646  .SH "SEE ALSO"  .SH "SEE ALSO"
# Line 2646  Cambridge CB2 3QH, England. Line 2665  Cambridge CB2 3QH, England.
2665  .rs  .rs
2666  .sp  .sp
2667  .nf  .nf
2668  Last updated: 18 February 2012  Last updated: 19 April 2012
2669  Copyright (c) 1997-2012 University of Cambridge.  Copyright (c) 1997-2012 University of Cambridge.
2670  .fi  .fi

Legend:
Removed from v.921  
changed lines
  Added in v.960

  ViewVC Help
Powered by ViewVC 1.1.5