/[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 155 by ph10, Tue Apr 24 13:36:11 2007 UTC revision 209 by ph10, Tue Aug 7 09:22:06 2007 UTC
# Line 601  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. Note that the check is for a syntactically valid UTF-8
605  \fBpcre_compile()\fP returns an error. If you already know that your pattern is  byte string, as defined by RFC 2279. It is \fInot\fP a check for a UTF-8 string
606  valid, and you want to skip this check for performance reasons, you can set the  of assigned or allowable Unicode code points.
607  PCRE_NO_UTF8_CHECK option. When it is set, the effect of passing an invalid  .P
608  UTF-8 string as a pattern is undefined. It may cause your program to crash.  If an invalid UTF-8 sequence of bytes is found, \fBpcre_compile()\fP returns an
609  Note that this option can also be passed to \fBpcre_exec()\fP and  error. If you already know that your pattern is valid, and you want to skip
610  \fBpcre_dfa_exec()\fP, to suppress the UTF-8 validity checking of subject  this check for performance reasons, you can set the PCRE_NO_UTF8_CHECK option.
611  strings.  When it is set, the effect of passing an invalid UTF-8 string as a pattern is
612    undefined. It may cause your program to crash. Note that this option can also
613    be passed to \fBpcre_exec()\fP and \fBpcre_dfa_exec()\fP, to suppress the UTF-8
614    validity checking of subject strings.
615  .  .
616  .  .
617  .SH "COMPILATION ERROR CODES"  .SH "COMPILATION ERROR CODES"
# Line 648  out of use. To avoid confusion, they hav Line 651  out of use. To avoid confusion, they hav
651    26  malformed number or name after (?(    26  malformed number or name after (?(
652    27  conditional group contains more than two branches    27  conditional group contains more than two branches
653    28  assertion expected after (?(    28  assertion expected after (?(
654    29  (?R or (?digits must be followed by )    29  (?R or (?[+-]digits must be followed by )
655    30  unknown POSIX class name    30  unknown POSIX class name
656    31  POSIX collating elements are not supported    31  POSIX collating elements are not supported
657    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 669  out of use. To avoid confusion, they hav Line 672  out of use. To avoid confusion, they hav
672    47  unknown property name after \eP or \ep    47  unknown property name after \eP or \ep
673    48  subpattern name is too long (maximum 32 characters)    48  subpattern name is too long (maximum 32 characters)
674    49  too many named subpatterns (maximum 10,000)    49  too many named subpatterns (maximum 10,000)
675    50  repeated subpattern is too long    50  [this code is not in use]
676    51  octal value is greater than \e377 (not in UTF-8 mode)    51  octal value is greater than \e377 (not in UTF-8 mode)
677    52  internal error: overran compiling workspace    52  internal error: overran compiling workspace
678    53  internal error: previously-checked referenced subpattern not found    53  internal error: previously-checked referenced subpattern not found
679    54  DEFINE group contains more than one branch    54  DEFINE group contains more than one branch
680    55  repeating a DEFINE group is not allowed    55  repeating a DEFINE group is not allowed
681    56  inconsistent NEWLINE options"    56  inconsistent NEWLINE options"
682      57  \eg is not followed by a braced name or an optionally braced
683            non-zero number
684      58  (?+ or (?- or (?(+ or (?(- must be followed by a non-zero number
685  .  .
686  .  .
687  .SH "STUDYING A PATTERN"  .SH "STUDYING A PATTERN"
# Line 871  table indicating a fixed set of bytes fo Line 877  table indicating a fixed set of bytes fo
877  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
878  fourth argument should point to an \fBunsigned char *\fP variable.  fourth argument should point to an \fBunsigned char *\fP variable.
879  .sp  .sp
880      PCRE_INFO_JCHANGED
881    .sp
882    Return 1 if the (?J) option setting is used in the pattern, otherwise 0. The
883    fourth argument should point to an \fBint\fP variable. The (?J) internal option
884    setting changes the local PCRE_DUPNAMES option.
885    .sp
886    PCRE_INFO_LASTLITERAL    PCRE_INFO_LASTLITERAL
887  .sp  .sp
888  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 923  When writing code to extract data from n Line 935  When writing code to extract data from n
935  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
936  different for each compiled pattern.  different for each compiled pattern.
937  .sp  .sp
938      PCRE_INFO_OKPARTIAL
939    .sp
940    Return 1 if the pattern can be used for partial matching, otherwise 0. The
941    fourth argument should point to an \fBint\fP variable. The
942    .\" HREF
943    \fBpcrepartial\fP
944    .\"
945    documentation lists the restrictions that apply to patterns when partial
946    matching is used.
947    .sp
948    PCRE_INFO_OPTIONS    PCRE_INFO_OPTIONS
949  .sp  .sp
950  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
951  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
952  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
953  top-level option settings within the pattern itself.  top-level option settings at the start of the pattern itself. In other words,
954    they are the options that will be in force when matching starts. For example,
955    if the pattern /(?im)abc(?-i)d/ is compiled with the PCRE_EXTENDED option, the
956    result is PCRE_CASELESS, PCRE_MULTILINE, and PCRE_EXTENDED.
957  .P  .P
958  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
959  alternatives begin with one of the following:  alternatives begin with one of the following:
# Line 1209  code that demonstrates how to do this in Line 1234  code that demonstrates how to do this in
1234  .sp  .sp
1235  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
1236  string is automatically checked when \fBpcre_exec()\fP is subsequently called.  string is automatically checked when \fBpcre_exec()\fP is subsequently called.
1237  The value of \fIstartoffset\fP is also checked to ensure that it points to the  Note that the check is for a syntactically valid UTF-8 byte string, as defined
1238  start of a UTF-8 character. If an invalid UTF-8 sequence of bytes is found,  by RFC 2279. It is \fInot\fP a check for a UTF-8 string of assigned or
1239  \fBpcre_exec()\fP returns the error PCRE_ERROR_BADUTF8. If \fIstartoffset\fP  allowable Unicode code points. The value of \fIstartoffset\fP is also checked
1240  contains an invalid value, PCRE_ERROR_BADUTF8_OFFSET is returned.  to ensure that it points to the start of a UTF-8 character. If an invalid UTF-8
1241    sequence of bytes is found, \fBpcre_exec()\fP returns the error
1242    PCRE_ERROR_BADUTF8. If \fIstartoffset\fP contains an invalid value,
1243    PCRE_ERROR_BADUTF8_OFFSET is returned.
1244  .P  .P
1245  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
1246  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 1444  The internal recursion limit, as specifi Line 1472  The internal recursion limit, as specifi
1472  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
1473  description above.  description above.
1474  .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  
1475    PCRE_ERROR_BADNEWLINE     (-23)    PCRE_ERROR_BADNEWLINE     (-23)
1476  .sp  .sp
1477  An invalid combination of PCRE_NEWLINE_\fIxxx\fP options was given.  An invalid combination of PCRE_NEWLINE_\fIxxx\fP options was given.
1478  .P  .P
1479  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.
1480  .  .
1481  .  .
1482  .SH "EXTRACTING CAPTURED SUBSTRINGS BY NUMBER"  .SH "EXTRACTING CAPTURED SUBSTRINGS BY NUMBER"
# Line 1621  example is shown in the Line 1641  example is shown in the
1641  .\" HREF  .\" HREF
1642  \fBpcrepattern\fP  \fBpcrepattern\fP
1643  .\"  .\"
1644  documentation. When duplicates are present, \fBpcre_copy_named_substring()\fP  documentation.
1645  and \fBpcre_get_named_substring()\fP return the first substring corresponding  .P
1646  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
1647  The \fBpcre_get_stringnumber()\fP function returns one of the numbers that are  \fBpcre_get_named_substring()\fP return the first substring corresponding to
1648  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
1649  .sp  returned; no data is returned. The \fBpcre_get_stringnumber()\fP function
1650    returns one of the numbers that are associated with the name, but it is not
1651    defined which it is.
1652    .P
1653  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,
1654  you must use the \fBpcre_get_stringtable_entries()\fP function. The first  you must use the \fBpcre_get_stringtable_entries()\fP function. The first
1655  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 1851  Cambridge CB2 3QH, England. Line 1874  Cambridge CB2 3QH, England.
1874  .rs  .rs
1875  .sp  .sp
1876  .nf  .nf
1877  Last updated: 24 April 2007  Last updated: 07 August 2007
1878  Copyright (c) 1997-2007 University of Cambridge.  Copyright (c) 1997-2007 University of Cambridge.
1879  .fi  .fi

Legend:
Removed from v.155  
changed lines
  Added in v.209

  ViewVC Help
Powered by ViewVC 1.1.5