|
version 1.1.1.1, 2012/02/21 23:05:52
|
version 1.1.1.5, 2014/06/15 19:46:05
|
|
Line 1
|
Line 1
|
| .TH PCRE_EXEC 3 | .TH PCRE_EXEC 3 "12 May 2013" "PCRE 8.33" |
| .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 int pcre_exec(const pcre *\fIcode\fP, "const pcre_extra *\fIextra\fP," |
.B int pcre_exec(const pcre *\fIcode\fP, "const pcre_extra *\fIextra\fP," |
| .ti +5n | .B " const char *\fIsubject\fP, int \fIlength\fP, int \fIstartoffset\fP," |
| .B "const char *\fIsubject\fP," int \fIlength\fP, int \fIstartoffset\fP, | .B " int \fIoptions\fP, int *\fIovector\fP, int \fIovecsize\fP);" |
| .ti +5n | .sp |
| .B int \fIoptions\fP, int *\fIovector\fP, int \fIovecsize\fP); | .B int pcre16_exec(const pcre16 *\fIcode\fP, "const pcre16_extra *\fIextra\fP," |
| | .B " PCRE_SPTR16 \fIsubject\fP, int \fIlength\fP, int \fIstartoffset\fP," |
| | .B " int \fIoptions\fP, int *\fIovector\fP, int \fIovecsize\fP);" |
| | .sp |
| | .B int pcre32_exec(const pcre32 *\fIcode\fP, "const pcre32_extra *\fIextra\fP," |
| | .B " PCRE_SPTR32 \fIsubject\fP, int \fIlength\fP, int \fIstartoffset\fP," |
| | .B " int \fIoptions\fP, int *\fIovector\fP, int \fIovecsize\fP);" |
| | .fi |
| . |
. |
| .SH DESCRIPTION |
.SH DESCRIPTION |
| .rs |
.rs |
|
Line 21 string, using a matching algorithm that is similar to
|
Line 28 string, using a matching algorithm that is similar to
|
| offsets to captured substrings. Its arguments are: |
offsets to captured substrings. Its arguments are: |
| .sp |
.sp |
| \fIcode\fP Points to the compiled pattern |
\fIcode\fP Points to the compiled pattern |
| \fIextra\fP Points to an associated \fBpcre_extra\fP structure, | \fIextra\fP Points to an associated \fBpcre[16|32]_extra\fP structure, |
| or is NULL |
or is NULL |
| \fIsubject\fP Points to the subject string |
\fIsubject\fP Points to the subject string |
| \fIlength\fP Length of the subject string, in bytes | \fIlength\fP Length of the subject string |
| \fIstartoffset\fP Offset in bytes in the subject at which to | \fIstartoffset\fP Offset in the subject at which to start matching |
| start matching | |
| \fIoptions\fP Option bits |
\fIoptions\fP Option bits |
| \fIovector\fP Points to a vector of ints for result offsets |
\fIovector\fP Points to a vector of ints for result offsets |
| \fIovecsize\fP Number of elements in the vector (a multiple of 3) |
\fIovecsize\fP Number of elements in the vector (a multiple of 3) |
| .sp |
.sp |
| The options are: | The units for \fIlength\fP and \fIstartoffset\fP are bytes for |
| | \fBpcre_exec()\fP, 16-bit data items for \fBpcre16_exec()\fP, and 32-bit items |
| | for \fBpcre32_exec()\fP. The options are: |
| .sp |
.sp |
| PCRE_ANCHORED Match only at the first position |
PCRE_ANCHORED Match only at the first position |
| PCRE_BSR_ANYCRLF \eR matches only CR, LF, or CRLF |
PCRE_BSR_ANYCRLF \eR matches only CR, LF, or CRLF |
|
Line 47 The options are:
|
Line 55 The options are:
|
| PCRE_NOTEMPTY_ATSTART An empty string at the start of the subject |
PCRE_NOTEMPTY_ATSTART An empty string at the start of the subject |
| is not a valid match |
is not a valid match |
| PCRE_NO_START_OPTIMIZE Do not do "start-match" optimizations |
PCRE_NO_START_OPTIMIZE Do not do "start-match" optimizations |
| |
PCRE_NO_UTF16_CHECK Do not check the subject for UTF-16 |
| |
validity (only relevant if PCRE_UTF16 |
| |
was set at compile time) |
| |
PCRE_NO_UTF32_CHECK Do not check the subject for UTF-32 |
| |
validity (only relevant if PCRE_UTF32 |
| |
was set at compile time) |
| PCRE_NO_UTF8_CHECK Do not check the subject for UTF-8 |
PCRE_NO_UTF8_CHECK Do not check the subject for UTF-8 |
| validity (only relevant if PCRE_UTF8 |
validity (only relevant if PCRE_UTF8 |
| was set at compile time) |
was set at compile time) |
|
Line 62 For details of partial matching, see the
|
Line 76 For details of partial matching, see the
|
| page. A \fBpcre_extra\fP structure contains the following fields: |
page. A \fBpcre_extra\fP structure contains the following fields: |
| .sp |
.sp |
| \fIflags\fP Bits indicating which fields are set |
\fIflags\fP Bits indicating which fields are set |
| \fIstudy_data\fP Opaque data from \fBpcre_study()\fP | \fIstudy_data\fP Opaque data from \fBpcre[16|32]_study()\fP |
| \fImatch_limit\fP Limit on internal resource use |
\fImatch_limit\fP Limit on internal resource use |
| \fImatch_limit_recursion\fP Limit on internal recursion depth |
\fImatch_limit_recursion\fP Limit on internal recursion depth |
| \fIcallout_data\fP Opaque data passed back to callouts |
\fIcallout_data\fP Opaque data passed back to callouts |