/[pcre]/code/trunk/doc/pcre_dfa_exec.3
ViewVC logotype

Contents of /code/trunk/doc/pcre_dfa_exec.3

Parent Directory Parent Directory | Revision Log Revision Log


Revision 428 - (show annotations) (download)
Mon Aug 31 17:10:26 2009 UTC (4 years, 10 months ago) by ph10
File size: 3734 byte(s)
Further partial match change: add PCRE_PARTIAL_HARD and make more intuitive.

1 .TH PCRE_DFA_EXEC 3
2 .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 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 .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 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, and CRLF as newline sequences
46 PCRE_NEWLINE_CR Set CR as the newline sequence
47 PCRE_NEWLINE_CRLF Set CRLF as the newline sequence
48 PCRE_NEWLINE_LF Set LF as the 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_NO_START_OPTIMIZE Do not do "start-match" optimizations
53 PCRE_NO_UTF8_CHECK Do not check the subject for UTF-8
54 validity (only relevant if PCRE_UTF8
55 was set at compile time)
56 PCRE_PARTIAL ) Return PCRE_ERROR_PARTIAL for a partial match
57 PCRE_PARTIAL_SOFT ) if no full matches are found
58 PCRE_PARTIAL_HARD Return PCRE_ERROR_PARTIAL for a partial match
59 even if there is a full match as well
60 PCRE_DFA_SHORTEST Return only the shortest match
61 PCRE_DFA_RESTART This is a restart after a partial match
62 .sp
63 There are restrictions on what may appear in a pattern when using this matching
64 function. Details are given in the
65 .\" HREF
66 \fBpcrematching\fP
67 .\"
68 documentation. For details of partial matching, see the
69 .\" HREF
70 \fBpcrepartial\fP
71 .\"
72 page.
73 .P
74 A \fBpcre_extra\fP structure contains the following fields:
75 .sp
76 \fIflags\fP Bits indicating which fields are set
77 \fIstudy_data\fP Opaque data from \fBpcre_study()\fP
78 \fImatch_limit\fP Limit on internal resource use
79 \fImatch_limit_recursion\fP Limit on internal recursion depth
80 \fIcallout_data\fP Opaque data passed back to callouts
81 \fItables\fP Points to character tables or is NULL
82 .sp
83 The flag bits are PCRE_EXTRA_STUDY_DATA, PCRE_EXTRA_MATCH_LIMIT,
84 PCRE_EXTRA_MATCH_LIMIT_RECURSION, PCRE_EXTRA_CALLOUT_DATA, and
85 PCRE_EXTRA_TABLES. For this matching function, the \fImatch_limit\fP and
86 \fImatch_limit_recursion\fP fields are not used, and must not be set.
87 .P
88 There is a complete description of the PCRE native API in the
89 .\" HREF
90 \fBpcreapi\fP
91 .\"
92 page and a description of the POSIX API in the
93 .\" HREF
94 \fBpcreposix\fP
95 .\"
96 page.

Properties

Name Value
svn:eol-style native
svn:keywords "Author Date Id Revision Url"

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12