trunk/doc/pcre_dfa_exec.3

.TH PCRE_DFA_EXEC 3
.SH NAME
PCRE - Perl-compatible regular expressions
.SH SYNOPSIS
.rs
.sp
.B #include <pcre.h>
.PP
.SM
.B int pcre_dfa_exec(const pcre *\fIcode\fP, "const pcre_extra *\fIextra\fP,"
.ti +5n
.B "const char *\fIsubject\fP," int \fIlength\fP, int \fIstartoffset\fP,
.ti +5n
.B int \fIoptions\fP, int *\fIovector\fP, int \fIovecsize\fP,
.ti +5n
.B int *\fIworkspace\fP, int \fIwscount\fP);
.
.SH DESCRIPTION
.rs
.sp
This function matches a compiled regular expression against a given subject
string, using an alternative matching algorithm that scans the subject string
just once (\fInot\fP Perl-compatible). Note that the main, Perl-compatible,
matching function is \fBpcre_exec()\fP. The arguments for this function are:
.sp
  \fIcode\fP         Points to the compiled pattern
  \fIextra\fP        Points to an associated \fBpcre_extra\fP structure,
                 or is NULL
  \fIsubject\fP      Points to the subject string
  \fIlength\fP       Length of the subject string, in bytes
  \fIstartoffset\fP  Offset in bytes in the subject at which to
                 start matching
  \fIoptions\fP      Option bits
  \fIovector\fP      Points to a vector of ints for result offsets
  \fIovecsize\fP     Number of elements in the vector
  \fIworkspace\fP    Points to a vector of ints used as working space
  \fIwscount\fP      Number of elements in the vector
.sp
The options are:
.sp
  PCRE_ANCHORED      Match only at the first position
  PCRE_NEWLINE_ANY   Recognize any Unicode newline sequence
  PCRE_NEWLINE_ANYCRLF  Recognize CR, LF, and CRLF as newline sequences
  PCRE_NEWLINE_CR    Set CR as the newline sequence
  PCRE_NEWLINE_CRLF  Set CRLF as the newline sequence
  PCRE_NEWLINE_LF    Set LF as the newline sequence
  PCRE_NOTBOL        Subject is not the beginning of a line
  PCRE_NOTEOL        Subject is not the end of a line
  PCRE_NOTEMPTY      An empty string is not a valid match
  PCRE_NO_UTF8_CHECK Do not check the subject for UTF-8
                       validity (only relevant if PCRE_UTF8
                       was set at compile time)
  PCRE_PARTIAL       Return PCRE_ERROR_PARTIAL for a partial match
  PCRE_DFA_SHORTEST  Return only the shortest match
  PCRE_DFA_RESTART   This is a restart after a partial match
.sp
There are restrictions on what may appear in a pattern when using this matching
function. Details are given in the
.\" HREF
\fBpcrematching\fP
.\"
documentation.
.P
A \fBpcre_extra\fP structure contains the following fields:
.sp
  \fIflags\fP        Bits indicating which fields are set
  \fIstudy_data\fP   Opaque data from \fBpcre_study()\fP
  \fImatch_limit\fP  Limit on internal resource use
  \fImatch_limit_recursion\fP  Limit on internal recursion depth
  \fIcallout_data\fP Opaque data passed back to callouts
  \fItables\fP       Points to character tables or is NULL
.sp
The flag bits are PCRE_EXTRA_STUDY_DATA, PCRE_EXTRA_MATCH_LIMIT,
PCRE_EXTRA_MATCH_LIMIT_RECURSION, PCRE_EXTRA_CALLOUT_DATA, and
PCRE_EXTRA_TABLES. For this matching function, the \fImatch_limit\fP and
\fImatch_limit_recursion\fP fields are not used, and must not be set.
.P
There is a complete description of the PCRE native API in the
.\" HREF
\fBpcreapi\fP
.\"
page and a description of the POSIX API in the
.\" HREF
\fBpcreposix\fP
.\"
page.
1	nigel	79	.TH PCRE_DFA_EXEC 3
2	nigel	77	.SH NAME
3			PCRE - Perl-compatible regular expressions
4			.SH SYNOPSIS
5			.rs
6			.sp
7			.B #include <pcre.h>
8			.PP
9			.SM
10			.B int pcre_dfa_exec(const pcre \fIcode\fP, "const pcre_extra \fIextra\fP,"
11			.ti +5n
12			.B "const char *\fIsubject\fP," int \fIlength\fP, int \fIstartoffset\fP,
13			.ti +5n
14			.B int \fIoptions\fP, int *\fIovector\fP, int \fIovecsize\fP,
15			.ti +5n
16			.B int *\fIworkspace\fP, int \fIwscount\fP);
17			.
18			.SH DESCRIPTION
19			.rs
20			.sp
21			This function matches a compiled regular expression against a given subject
22	nigel	93	string, using an alternative matching algorithm that scans the subject string
23			just once (\fInot\fP Perl-compatible). Note that the main, Perl-compatible,
24			matching function is \fBpcre_exec()\fP. The arguments for this function are:
25	nigel	77	.sp
26			\fIcode\fP Points to the compiled pattern
27			\fIextra\fP Points to an associated \fBpcre_extra\fP structure,
28			or is NULL
29			\fIsubject\fP Points to the subject string
30			\fIlength\fP Length of the subject string, in bytes
31			\fIstartoffset\fP Offset in bytes in the subject at which to
32			start matching
33			\fIoptions\fP Option bits
34			\fIovector\fP Points to a vector of ints for result offsets
35			\fIovecsize\fP Number of elements in the vector
36			\fIworkspace\fP Points to a vector of ints used as working space
37			\fIwscount\fP Number of elements in the vector
38			.sp
39			The options are:
40			.sp
41			PCRE_ANCHORED Match only at the first position
42	nigel	93	PCRE_NEWLINE_ANY Recognize any Unicode newline sequence
43	ph10	149	PCRE_NEWLINE_ANYCRLF Recognize CR, LF, and CRLF as newline sequences
44	nigel	91	PCRE_NEWLINE_CR Set CR as the newline sequence
45			PCRE_NEWLINE_CRLF Set CRLF as the newline sequence
46			PCRE_NEWLINE_LF Set LF as the newline sequence
47	nigel	77	PCRE_NOTBOL Subject is not the beginning of a line
48			PCRE_NOTEOL Subject is not the end of a line
49			PCRE_NOTEMPTY An empty string is not a valid match
50			PCRE_NO_UTF8_CHECK Do not check the subject for UTF-8
51			validity (only relevant if PCRE_UTF8
52			was set at compile time)
53			PCRE_PARTIAL Return PCRE_ERROR_PARTIAL for a partial match
54			PCRE_DFA_SHORTEST Return only the shortest match
55			PCRE_DFA_RESTART This is a restart after a partial match
56			.sp
57	nigel	93	There are restrictions on what may appear in a pattern when using this matching
58			function. Details are given in the
59	nigel	77	.\" HREF
60			\fBpcrematching\fP
61			.\"
62			documentation.
63			.P
64			A \fBpcre_extra\fP structure contains the following fields:
65			.sp
66			\fIflags\fP Bits indicating which fields are set
67			\fIstudy_data\fP Opaque data from \fBpcre_study()\fP
68	nigel	87	\fImatch_limit\fP Limit on internal resource use
69			\fImatch_limit_recursion\fP Limit on internal recursion depth
70	nigel	77	\fIcallout_data\fP Opaque data passed back to callouts
71			\fItables\fP Points to character tables or is NULL
72			.sp
73			The flag bits are PCRE_EXTRA_STUDY_DATA, PCRE_EXTRA_MATCH_LIMIT,
74	nigel	87	PCRE_EXTRA_MATCH_LIMIT_RECURSION, PCRE_EXTRA_CALLOUT_DATA, and
75	nigel	93	PCRE_EXTRA_TABLES. For this matching function, the \fImatch_limit\fP and
76	nigel	87	\fImatch_limit_recursion\fP fields are not used, and must not be set.
77	nigel	77	.P
78			There is a complete description of the PCRE native API in the
79			.\" HREF
80			\fBpcreapi\fP
81			.\"
82			page and a description of the POSIX API in the
83			.\" HREF
84			\fBpcreposix\fP
85			.\"
86			page.
Name	Value
svn:eol-style	native
svn:keywords	"Author Date Id Revision Url"