/[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 1220 by ph10, Thu Nov 8 17:03:43 2012 UTC revision 1221 by ph10, Sun Nov 11 20:27:03 2012 UTC
# Line 161  by UTF16 or UTF32, respectively. This fa Line 161  by UTF16 or UTF32, respectively. This fa
161  16-bit and 32-bit option names define the same bit values.  16-bit and 32-bit option names define the same bit values.
162  .P  .P
163  References to bytes and UTF-8 in this document should be read as references to  References to bytes and UTF-8 in this document should be read as references to
164  16-bit data quantities and UTF-16 when using the 16-bit library, or 32-bit data  16-bit data quantities and UTF-16 when using the 16-bit library, or 32-bit data
165  quantities and UTF-32 when using the 32-bit library, unless specified  quantities and UTF-32 when using the 32-bit library, unless specified
166  otherwise. More details of the specific differences for the 16-bit and 32-bit  otherwise. More details of the specific differences for the 16-bit and 32-bit
167  libraries are given in the  libraries are given in the
# Line 447  unaligned)". If JIT support is not avail Line 447  unaligned)". If JIT support is not avail
447    PCRE_CONFIG_NEWLINE    PCRE_CONFIG_NEWLINE
448  .sp  .sp
449  The output is an integer whose value specifies the default character sequence  The output is an integer whose value specifies the default character sequence
450  that is recognized as meaning "newline". The values that are supported in  that is recognized as meaning "newline". The values that are supported in
451  ASCII/Unicode environments are: 10 for LF, 13 for CR, 3338 for CRLF, -2 for  ASCII/Unicode environments are: 10 for LF, 13 for CR, 3338 for CRLF, -2 for
452  ANYCRLF, and -1 for ANY. In EBCDIC environments, CR, ANYCRLF, and ANY yield the  ANYCRLF, and -1 for ANY. In EBCDIC environments, CR, ANYCRLF, and ANY yield the
453  same values. However, the value for LF is normally 21, though some EBCDIC  same values. However, the value for LF is normally 21, though some EBCDIC
# Line 767  indicated by a single character (CR or L Line 767  indicated by a single character (CR or L
767  PCRE_NEWLINE_CRLF specifies that a newline is indicated by the two-character  PCRE_NEWLINE_CRLF specifies that a newline is indicated by the two-character
768  CRLF sequence. Setting PCRE_NEWLINE_ANYCRLF specifies that any of the three  CRLF sequence. Setting PCRE_NEWLINE_ANYCRLF specifies that any of the three
769  preceding sequences should be recognized. Setting PCRE_NEWLINE_ANY specifies  preceding sequences should be recognized. Setting PCRE_NEWLINE_ANY specifies
770  that any Unicode newline sequence should be recognized.  that any Unicode newline sequence should be recognized.
771  .P  .P
772  In an ASCII/Unicode environment, the Unicode newline sequences are the three  In an ASCII/Unicode environment, the Unicode newline sequences are the three
773  just mentioned, plus the single characters VT (vertical tab, U+000B), FF (form  just mentioned, plus the single characters VT (vertical tab, U+000B), FF (form
# Line 777  recognized only in UTF-8 mode. Line 777  recognized only in UTF-8 mode.
777  .P  .P
778  When PCRE is compiled to run in an EBCDIC (mainframe) environment, the code for  When PCRE is compiled to run in an EBCDIC (mainframe) environment, the code for
779  CR is 0x0d, the same as ASCII. However, the character code for LF is normally  CR is 0x0d, the same as ASCII. However, the character code for LF is normally
780  0x15, though in some EBCDIC environments 0x25 is used. Whichever of these is  0x15, though in some EBCDIC environments 0x25 is used. Whichever of these is
781  not LF is made to correspond to Unicode's NEL character. EBCDIC codes are all  not LF is made to correspond to Unicode's NEL character. EBCDIC codes are all
782  less than 256. For more details, see the  less than 256. For more details, see the
783  .\" HREF  .\" HREF
784  \fBpcrebuild\fP  \fBpcrebuild\fP
# Line 875  this check for performance reasons, you Line 875  this check for performance reasons, you
875  When it is set, the effect of passing an invalid UTF-8 string as a pattern is  When it is set, the effect of passing an invalid UTF-8 string as a pattern is
876  undefined. It may cause your program to crash. Note that this option can also  undefined. It may cause your program to crash. Note that this option can also
877  be passed to \fBpcre_exec()\fP and \fBpcre_dfa_exec()\fP, to suppress the  be passed to \fBpcre_exec()\fP and \fBpcre_dfa_exec()\fP, to suppress the
878  validity checking of subject strings only. If the same string is being matched  validity checking of subject strings only. If the same string is being matched
879  many times, the option can be safely set for the second and subsequent  many times, the option can be safely set for the second and subsequent
880  matchings to improve performance.  matchings to improve performance.
881  .  .
882  .  .
# Line 1005  in the section on matching a pattern. Line 1005  in the section on matching a pattern.
1005  If studying the pattern does not produce any useful information,  If studying the pattern does not produce any useful information,
1006  \fBpcre_study()\fP returns NULL by default. In that circumstance, if the  \fBpcre_study()\fP returns NULL by default. In that circumstance, if the
1007  calling program wants to pass any of the other fields to \fBpcre_exec()\fP or  calling program wants to pass any of the other fields to \fBpcre_exec()\fP or
1008  \fBpcre_dfa_exec()\fP, it must set up its own \fBpcre_extra\fP block. However,  \fBpcre_dfa_exec()\fP, it must set up its own \fBpcre_extra\fP block. However,
1009  if \fBpcre_study()\fP is called with the PCRE_STUDY_EXTRA_NEEDED option, it  if \fBpcre_study()\fP is called with the PCRE_STUDY_EXTRA_NEEDED option, it
1010  returns a \fBpcre_extra\fP block even if studying did not find any additional  returns a \fBpcre_extra\fP block even if studying did not find any additional
1011  information. It may still return NULL, however, if an error occurs in  information. It may still return NULL, however, if an error occurs in
# Line 2247  so that it runs on the new host. Line 2247  so that it runs on the new host.
2247  .sp  .sp
2248  This error is returned when a pattern that was successfully studied using a JIT  This error is returned when a pattern that was successfully studied using a JIT
2249  compile option is being matched, but the matching mode (partial or complete  compile option is being matched, but the matching mode (partial or complete
2250  match) does not correspond to any JIT compilation mode. When the JIT fast path  match) does not correspond to any JIT compilation mode. When the JIT fast path
2251  function is used, this error may be also given for invalid options. See the  function is used, this error may be also given for invalid options. See the
2252  .\" HREF  .\" HREF
2253  \fBpcrejit\fP  \fBpcrejit\fP
# Line 2256  documentation for more details. Line 2256  documentation for more details.
2256  .sp  .sp
2257    PCRE_ERROR_BADLENGTH      (-32)    PCRE_ERROR_BADLENGTH      (-32)
2258  .sp  .sp
2259  This error is given if \fBpcre_exec()\fP is called with a negative value for  This error is given if \fBpcre_exec()\fP is called with a negative value for
2260  the \fIlength\fP argument.  the \fIlength\fP argument.
2261  .P  .P
2262  Error numbers -16 to -20, -22, and 30 are not used by \fBpcre_exec()\fP.  Error numbers -16 to -20, -22, and 30 are not used by \fBpcre_exec()\fP.
2263  .  .
# Line 2275  and Line 2275  and
2275  .\" HREF  .\" HREF
2276  \fBpcre32\fP  \fBpcre32\fP
2277  .\"  .\"
2278  pages.  pages.
2279  .P  .P
2280  When \fBpcre_exec()\fP returns either PCRE_ERROR_BADUTF8 or  When \fBpcre_exec()\fP returns either PCRE_ERROR_BADUTF8 or
2281  PCRE_ERROR_SHORTUTF8, and the size of the output vector (\fIovecsize\fP) is at  PCRE_ERROR_SHORTUTF8, and the size of the output vector (\fIovecsize\fP) is at

Legend:
Removed from v.1220  
changed lines
  Added in v.1221

  ViewVC Help
Powered by ViewVC 1.1.5