version 1.1, 2012/02/21 23:05:52
|
version 1.1.1.5, 2014/06/15 19:46:04
|
Line 1
|
Line 1
|
.TH PCRE_COMPILE2 3 | .TH PCRE_COMPILE2 3 "01 October 2013" "PCRE 8.34" |
.SH NAME |
.SH NAME |
PCRE - Perl-compatible regular expressions |
PCRE - Perl-compatible regular expressions |
.SH SYNOPSIS |
.SH SYNOPSIS |
Line 6 PCRE - Perl-compatible regular expressions
|
Line 6 PCRE - Perl-compatible regular expressions
|
.sp |
.sp |
.B #include <pcre.h> |
.B #include <pcre.h> |
.PP |
.PP |
.SM | .nf |
.B pcre *pcre_compile2(const char *\fIpattern\fP, int \fIoptions\fP, |
.B pcre *pcre_compile2(const char *\fIpattern\fP, int \fIoptions\fP, |
.ti +5n | .B " int *\fIerrorcodeptr\fP," |
.B int *\fIerrorcodeptr\fP, | .B " const char **\fIerrptr\fP, int *\fIerroffset\fP," |
.ti +5n | .B " const unsigned char *\fItableptr\fP);" |
.B const char **\fIerrptr\fP, int *\fIerroffset\fP, | .sp |
.ti +5n | .B pcre16 *pcre16_compile2(PCRE_SPTR16 \fIpattern\fP, int \fIoptions\fP, |
.B const unsigned char *\fItableptr\fP); | . |
| .B " const char **\fIerrptr\fP, int *\fIerroffset\fP," |
| .B " const unsigned char *\fItableptr\fP);" |
| .sp |
| .B pcre32 *pcre32_compile2(PCRE_SPTR32 \fIpattern\fP, int \fIoptions\fP, |
| .B " int *\fIerrorcodeptr\fP,£ |
| .B " const char **\fIerrptr\fP, int *\fIerroffset\fP," |
| .B " const unsigned char *\fItableptr\fP);" |
| .fi |
. |
. |
.SH DESCRIPTION |
.SH DESCRIPTION |
.rs |
.rs |
.sp |
.sp |
This function compiles a regular expression into an internal form. It is the |
This function compiles a regular expression into an internal form. It is the |
same as \fBpcre_compile()\fP, except for the addition of the \fIerrorcodeptr\fP | same as \fBpcre[16|32]_compile()\fP, except for the addition of the |
argument. The arguments are: | \fIerrorcodeptr\fP argument. The arguments are: |
. |
. |
.sp |
.sp |
\fIpattern\fP A zero-terminated string containing the |
\fIpattern\fP A zero-terminated string containing the |
Line 42 The option bits are:
|
Line 50 The option bits are:
|
PCRE_DOLLAR_ENDONLY $ not to match newline at end |
PCRE_DOLLAR_ENDONLY $ not to match newline at end |
PCRE_DOTALL . matches anything including NL |
PCRE_DOTALL . matches anything including NL |
PCRE_DUPNAMES Allow duplicate names for subpatterns |
PCRE_DUPNAMES Allow duplicate names for subpatterns |
PCRE_EXTENDED Ignore whitespace and # comments | PCRE_EXTENDED Ignore white space and # comments |
PCRE_EXTRA PCRE extra features |
PCRE_EXTRA PCRE extra features |
(not much use currently) |
(not much use currently) |
PCRE_FIRSTLINE Force matching to be before newline |
PCRE_FIRSTLINE Force matching to be before newline |
PCRE_JAVASCRIPT_COMPAT JavaScript compatibility |
PCRE_JAVASCRIPT_COMPAT JavaScript compatibility |
PCRE_MULTILINE ^ and $ match newlines within data |
PCRE_MULTILINE ^ and $ match newlines within data |
|
PCRE_NEVER_UTF Lock out UTF, e.g. via (*UTF) |
PCRE_NEWLINE_ANY Recognize any Unicode newline sequence |
PCRE_NEWLINE_ANY Recognize any Unicode newline sequence |
PCRE_NEWLINE_ANYCRLF Recognize CR, LF, and CRLF as newline |
PCRE_NEWLINE_ANYCRLF Recognize CR, LF, and CRLF as newline |
sequences |
sequences |
Line 56 The option bits are:
|
Line 65 The option bits are:
|
PCRE_NEWLINE_LF Set LF as the newline sequence |
PCRE_NEWLINE_LF Set LF as the newline sequence |
PCRE_NO_AUTO_CAPTURE Disable numbered capturing paren- |
PCRE_NO_AUTO_CAPTURE Disable numbered capturing paren- |
theses (named ones available) |
theses (named ones available) |
|
PCRE_NO_AUTO_POSSESS Disable auto-possessification |
|
PCRE_NO_START_OPTIMIZE Disable match-time start optimizations |
|
PCRE_NO_UTF16_CHECK Do not check the pattern for UTF-16 |
|
validity (only relevant if |
|
PCRE_UTF16 is set) |
|
PCRE_NO_UTF32_CHECK Do not check the pattern for UTF-32 |
|
validity (only relevant if |
|
PCRE_UTF32 is set) |
PCRE_NO_UTF8_CHECK Do not check the pattern for UTF-8 |
PCRE_NO_UTF8_CHECK Do not check the pattern for UTF-8 |
validity (only relevant if |
validity (only relevant if |
PCRE_UTF8 is set) |
PCRE_UTF8 is set) |
PCRE_UCP Use Unicode properties for \ed, \ew, etc. |
PCRE_UCP Use Unicode properties for \ed, \ew, etc. |
PCRE_UNGREEDY Invert greediness of quantifiers |
PCRE_UNGREEDY Invert greediness of quantifiers |
PCRE_UTF8 Run in UTF-8 mode | PCRE_UTF16 Run \fBpcre16_compile()\fP in UTF-16 mode |
| PCRE_UTF32 Run \fBpcre32_compile()\fP in UTF-32 mode |
| PCRE_UTF8 Run \fBpcre_compile()\fP in UTF-8 mode |
.sp |
.sp |
PCRE must be built with UTF-8 support in order to use PCRE_UTF8 and | PCRE must be built with UTF support in order to use PCRE_UTF8/16/32 and |
PCRE_NO_UTF8_CHECK, and with UCP support if PCRE_UCP is used. | PCRE_NO_UTF8/16/32_CHECK, and with UCP support if PCRE_UCP is used. |
.P |
.P |
The yield of the function is a pointer to a private data structure that |
The yield of the function is a pointer to a private data structure that |
contains the compiled pattern, or NULL if an error was detected. Note that |
contains the compiled pattern, or NULL if an error was detected. Note that |