/[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 150 by ph10, Tue Apr 17 08:22:40 2007 UTC revision 211 by ph10, Thu Aug 9 09:52:43 2007 UTC
# Line 265  which it was compiled. Details are given Line 265  which it was compiled. Details are given
265  .\" HREF  .\" HREF
266  \fBpcreprecompile\fP  \fBpcreprecompile\fP
267  .\"  .\"
268  documentation.  documentation. However, compiling a regular expression with one version of PCRE
269    for use with a different version is not guaranteed to work and may cause
270    crashes.
271  .  .
272  .  .
273  .SH "CHECKING BUILD-TIME OPTIONS"  .SH "CHECKING BUILD-TIME OPTIONS"
# Line 599  page. Line 601  page.
601    PCRE_NO_UTF8_CHECK    PCRE_NO_UTF8_CHECK
602  .sp  .sp
603  When PCRE_UTF8 is set, the validity of the pattern as a UTF-8 string is  When PCRE_UTF8 is set, the validity of the pattern as a UTF-8 string is
604  automatically checked. If an invalid UTF-8 sequence of bytes is found,  automatically checked. There is a discussion about the
605  \fBpcre_compile()\fP returns an error. If you already know that your pattern is  .\" HTML <a href="pcre.html#utf8strings">
606  valid, and you want to skip this check for performance reasons, you can set the  .\" </a>
607  PCRE_NO_UTF8_CHECK option. When it is set, the effect of passing an invalid  validity of UTF-8 strings
608  UTF-8 string as a pattern is undefined. It may cause your program to crash.  .\"
609  Note that this option can also be passed to \fBpcre_exec()\fP and  in the main
610  \fBpcre_dfa_exec()\fP, to suppress the UTF-8 validity checking of subject  .\" HREF
611  strings.  \fBpcre\fP
612    .\"
613    page. If an invalid UTF-8 sequence of bytes is found, \fBpcre_compile()\fP
614    returns an error. If you already know that your pattern is valid, and you want
615    to skip this check for performance reasons, you can set the PCRE_NO_UTF8_CHECK
616    option. When it is set, the effect of passing an invalid UTF-8 string as a
617    pattern is undefined. It may cause your program to crash. Note that this option
618    can also be passed to \fBpcre_exec()\fP and \fBpcre_dfa_exec()\fP, to suppress
619    the UTF-8 validity checking of subject strings.
620  .  .
621  .  .
622  .SH "COMPILATION ERROR CODES"  .SH "COMPILATION ERROR CODES"
# Line 646  out of use. To avoid confusion, they hav Line 656  out of use. To avoid confusion, they hav
656    26  malformed number or name after (?(    26  malformed number or name after (?(
657    27  conditional group contains more than two branches    27  conditional group contains more than two branches
658    28  assertion expected after (?(    28  assertion expected after (?(
659    29  (?R or (?digits must be followed by )    29  (?R or (?[+-]digits must be followed by )
660    30  unknown POSIX class name    30  unknown POSIX class name
661    31  POSIX collating elements are not supported    31  POSIX collating elements are not supported
662    32  this version of PCRE is not compiled with PCRE_UTF8 support    32  this version of PCRE is not compiled with PCRE_UTF8 support
# Line 667  out of use. To avoid confusion, they hav Line 677  out of use. To avoid confusion, they hav
677    47  unknown property name after \eP or \ep    47  unknown property name after \eP or \ep
678    48  subpattern name is too long (maximum 32 characters)    48  subpattern name is too long (maximum 32 characters)
679    49  too many named subpatterns (maximum 10,000)    49  too many named subpatterns (maximum 10,000)
680    50  repeated subpattern is too long    50  [this code is not in use]
681    51  octal value is greater than \e377 (not in UTF-8 mode)    51  octal value is greater than \e377 (not in UTF-8 mode)
682    52  internal error: overran compiling workspace    52  internal error: overran compiling workspace
683    53  internal error: previously-checked referenced subpattern not found    53  internal error: previously-checked referenced subpattern not found
684    54  DEFINE group contains more than one branch    54  DEFINE group contains more than one branch
685    55  repeating a DEFINE group is not allowed    55  repeating a DEFINE group is not allowed
686    56  inconsistent NEWLINE options"    56  inconsistent NEWLINE options"
687      57  \eg is not followed by a braced name or an optionally braced
688            non-zero number
689      58  (?+ or (?- or (?(+ or (?(- must be followed by a non-zero number
690  .  .
691  .  .
692  .SH "STUDYING A PATTERN"  .SH "STUDYING A PATTERN"
# Line 869  table indicating a fixed set of bytes fo Line 882  table indicating a fixed set of bytes fo
882  string, a pointer to the table is returned. Otherwise NULL is returned. The  string, a pointer to the table is returned. Otherwise NULL is returned. The
883  fourth argument should point to an \fBunsigned char *\fP variable.  fourth argument should point to an \fBunsigned char *\fP variable.
884  .sp  .sp
885      PCRE_INFO_JCHANGED
886    .sp
887    Return 1 if the (?J) option setting is used in the pattern, otherwise 0. The
888    fourth argument should point to an \fBint\fP variable. The (?J) internal option
889    setting changes the local PCRE_DUPNAMES option.
890    .sp
891    PCRE_INFO_LASTLITERAL    PCRE_INFO_LASTLITERAL
892  .sp  .sp
893  Return the value of the rightmost literal byte that must exist in any matched  Return the value of the rightmost literal byte that must exist in any matched
# Line 921  When writing code to extract data from n Line 940  When writing code to extract data from n
940  name-to-number map, remember that the length of the entries is likely to be  name-to-number map, remember that the length of the entries is likely to be
941  different for each compiled pattern.  different for each compiled pattern.
942  .sp  .sp
943      PCRE_INFO_OKPARTIAL
944    .sp
945    Return 1 if the pattern can be used for partial matching, otherwise 0. The
946    fourth argument should point to an \fBint\fP variable. The
947    .\" HREF
948    \fBpcrepartial\fP
949    .\"
950    documentation lists the restrictions that apply to patterns when partial
951    matching is used.
952    .sp
953    PCRE_INFO_OPTIONS    PCRE_INFO_OPTIONS
954  .sp  .sp
955  Return a copy of the options with which the pattern was compiled. The fourth  Return a copy of the options with which the pattern was compiled. The fourth
956  argument should point to an \fBunsigned long int\fP variable. These option bits  argument should point to an \fBunsigned long int\fP variable. These option bits
957  are those specified in the call to \fBpcre_compile()\fP, modified by any  are those specified in the call to \fBpcre_compile()\fP, modified by any
958  top-level option settings within the pattern itself.  top-level option settings at the start of the pattern itself. In other words,
959    they are the options that will be in force when matching starts. For example,
960    if the pattern /(?im)abc(?-i)d/ is compiled with the PCRE_EXTENDED option, the
961    result is PCRE_CASELESS, PCRE_MULTILINE, and PCRE_EXTENDED.
962  .P  .P
963  A pattern is automatically anchored by PCRE if all of its top-level  A pattern is automatically anchored by PCRE if all of its top-level
964  alternatives begin with one of the following:  alternatives begin with one of the following:
# Line 1208  code that demonstrates how to do this in Line 1240  code that demonstrates how to do this in
1240  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
1241  string is automatically checked when \fBpcre_exec()\fP is subsequently called.  string is automatically checked when \fBpcre_exec()\fP is subsequently called.
1242  The value of \fIstartoffset\fP is also checked to ensure that it points to the  The value of \fIstartoffset\fP is also checked to ensure that it points to the
1243  start of a UTF-8 character. If an invalid UTF-8 sequence of bytes is found,  start of a UTF-8 character. There is a discussion about the validity of UTF-8
1244  \fBpcre_exec()\fP returns the error PCRE_ERROR_BADUTF8. If \fIstartoffset\fP  strings in the
1245  contains an invalid value, PCRE_ERROR_BADUTF8_OFFSET is returned.  .\" HTML <a href="pcre.html#utf8strings">
1246    .\" </a>
1247    section on UTF-8 support
1248    .\"
1249    in the main
1250    .\" HREF
1251    \fBpcre\fP
1252    .\"
1253    page. If an invalid UTF-8 sequence of bytes is found, \fBpcre_exec()\fP returns
1254    the error PCRE_ERROR_BADUTF8. If \fIstartoffset\fP contains an invalid value,
1255    PCRE_ERROR_BADUTF8_OFFSET is returned.
1256  .P  .P
1257  If you already know that your subject is valid, and you want to skip these  If you already know that your subject is valid, and you want to skip these
1258  checks for performance reasons, you can set the PCRE_NO_UTF8_CHECK option when  checks for performance reasons, you can set the PCRE_NO_UTF8_CHECK option when
# Line 1442  The internal recursion limit, as specifi Line 1484  The internal recursion limit, as specifi
1484  field in a \fBpcre_extra\fP structure (or defaulted) was reached. See the  field in a \fBpcre_extra\fP structure (or defaulted) was reached. See the
1485  description above.  description above.
1486  .sp  .sp
   PCRE_ERROR_NULLWSLIMIT    (-22)  
 .sp  
 When a group that can match an empty substring is repeated with an unbounded  
 upper limit, the subject position at the start of the group must be remembered,  
 so that a test for an empty string can be made when the end of the group is  
 reached. Some workspace is required for this; if it runs out, this error is  
 given.  
 .sp  
1487    PCRE_ERROR_BADNEWLINE     (-23)    PCRE_ERROR_BADNEWLINE     (-23)
1488  .sp  .sp
1489  An invalid combination of PCRE_NEWLINE_\fIxxx\fP options was given.  An invalid combination of PCRE_NEWLINE_\fIxxx\fP options was given.
1490  .P  .P
1491  Error numbers -16 to -20 are not used by \fBpcre_exec()\fP.  Error numbers -16 to -20 and -22 are not used by \fBpcre_exec()\fP.
1492  .  .
1493  .  .
1494  .SH "EXTRACTING CAPTURED SUBSTRINGS BY NUMBER"  .SH "EXTRACTING CAPTURED SUBSTRINGS BY NUMBER"
# Line 1619  example is shown in the Line 1653  example is shown in the
1653  .\" HREF  .\" HREF
1654  \fBpcrepattern\fP  \fBpcrepattern\fP
1655  .\"  .\"
1656  documentation. When duplicates are present, \fBpcre_copy_named_substring()\fP  documentation.
1657  and \fBpcre_get_named_substring()\fP return the first substring corresponding  .P
1658  to the given name that is set. If none are set, an empty string is returned.  When duplicates are present, \fBpcre_copy_named_substring()\fP and
1659  The \fBpcre_get_stringnumber()\fP function returns one of the numbers that are  \fBpcre_get_named_substring()\fP return the first substring corresponding to
1660  associated with the name, but it is not defined which it is.  the given name that is set. If none are set, PCRE_ERROR_NOSUBSTRING (-7) is
1661  .sp  returned; no data is returned. The \fBpcre_get_stringnumber()\fP function
1662    returns one of the numbers that are associated with the name, but it is not
1663    defined which it is.
1664    .P
1665  If you want to get full details of all captured substrings for a given name,  If you want to get full details of all captured substrings for a given name,
1666  you must use the \fBpcre_get_stringtable_entries()\fP function. The first  you must use the \fBpcre_get_stringtable_entries()\fP function. The first
1667  argument is the compiled pattern, and the second is the name. The third and  argument is the compiled pattern, and the second is the name. The third and
# Line 1849  Cambridge CB2 3QH, England. Line 1886  Cambridge CB2 3QH, England.
1886  .rs  .rs
1887  .sp  .sp
1888  .nf  .nf
1889  Last updated: 16 April 2007  Last updated: 09 August 2007
1890  Copyright (c) 1997-2007 University of Cambridge.  Copyright (c) 1997-2007 University of Cambridge.
1891  .fi  .fi
Legend:
Removed from v.150  
changed lines
  Added in v.211
  ViewVC Help
Powered by ViewVC 1.1.5