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_BSR_ANYCRLF       \eR matches only CR, LF, or CRLF
  PCRE_BSR_UNICODE       \eR matches all Unicode line endings
  PCRE_NEWLINE_ANY       Recognize any Unicode newline sequence
  PCRE_NEWLINE_ANYCRLF   Recognize CR, LF, & CRLF as newline sequences
  PCRE_NEWLINE_CR        Recognize CR as the only newline sequence
  PCRE_NEWLINE_CRLF      Recognize CRLF as the only newline sequence
  PCRE_NEWLINE_LF        Recognize LF as the only 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_NOTEMPTY_ATSTART  An empty string at the start of the subject
                           is not a valid match
  PCRE_NO_START_OPTIMIZE Do not do "start-match" optimizations
  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
  PCRE_PARTIAL_SOFT      )   match if no full matches are found
  PCRE_PARTIAL_HARD      Return PCRE_ERROR_PARTIAL for a partial match 
                           even if there is a full match as well 
  PCRE_DFA_SHORTEST      Return only the shortest match
  PCRE_DFA_RESTART       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. For details of partial matching, see the
.\" HREF
\fBpcrepartial\fP
.\"
page.
.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	ph10	442	PCRE_ANCHORED Match only at the first position
42			PCRE_BSR_ANYCRLF \eR matches only CR, LF, or CRLF
43			PCRE_BSR_UNICODE \eR matches all Unicode line endings
44			PCRE_NEWLINE_ANY Recognize any Unicode newline sequence
45			PCRE_NEWLINE_ANYCRLF Recognize CR, LF, & CRLF as newline sequences
46			PCRE_NEWLINE_CR Recognize CR as the only newline sequence
47			PCRE_NEWLINE_CRLF Recognize CRLF as the only newline sequence
48			PCRE_NEWLINE_LF Recognize LF as the only newline sequence
49			PCRE_NOTBOL Subject is not the beginning of a line
50			PCRE_NOTEOL Subject is not the end of a line
51			PCRE_NOTEMPTY An empty string is not a valid match
52			PCRE_NOTEMPTY_ATSTART An empty string at the start of the subject
53			is not a valid match
54			PCRE_NO_START_OPTIMIZE Do not do "start-match" optimizations
55			PCRE_NO_UTF8_CHECK Do not check the subject for UTF-8
56			validity (only relevant if PCRE_UTF8
57			was set at compile time)
58			PCRE_PARTIAL ) Return PCRE_ERROR_PARTIAL for a partial
59			PCRE_PARTIAL_SOFT ) match if no full matches are found
60			PCRE_PARTIAL_HARD Return PCRE_ERROR_PARTIAL for a partial match
61			even if there is a full match as well
62			PCRE_DFA_SHORTEST Return only the shortest match
63			PCRE_DFA_RESTART Restart after a partial match
64	nigel	77	.sp
65	nigel	93	There are restrictions on what may appear in a pattern when using this matching
66			function. Details are given in the
67	nigel	77	.\" HREF
68			\fBpcrematching\fP
69			.\"
70	ph10	428	documentation. For details of partial matching, see the
71			.\" HREF
72			\fBpcrepartial\fP
73			.\"
74			page.
75	nigel	77	.P
76			A \fBpcre_extra\fP structure contains the following fields:
77			.sp
78			\fIflags\fP Bits indicating which fields are set
79			\fIstudy_data\fP Opaque data from \fBpcre_study()\fP
80	nigel	87	\fImatch_limit\fP Limit on internal resource use
81			\fImatch_limit_recursion\fP Limit on internal recursion depth
82	nigel	77	\fIcallout_data\fP Opaque data passed back to callouts
83			\fItables\fP Points to character tables or is NULL
84			.sp
85			The flag bits are PCRE_EXTRA_STUDY_DATA, PCRE_EXTRA_MATCH_LIMIT,
86	nigel	87	PCRE_EXTRA_MATCH_LIMIT_RECURSION, PCRE_EXTRA_CALLOUT_DATA, and
87	nigel	93	PCRE_EXTRA_TABLES. For this matching function, the \fImatch_limit\fP and
88	nigel	87	\fImatch_limit_recursion\fP fields are not used, and must not be set.
89	nigel	77	.P
90			There is a complete description of the PCRE native API in the
91			.\" HREF
92			\fBpcreapi\fP
93			.\"
94			page and a description of the POSIX API in the
95			.\" HREF
96			\fBpcreposix\fP
97			.\"
98			page.
Name	Value
svn:eol-style	native
svn:keywords	"Author Date Id Revision Url"