/[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 96 - (show annotations) (download)
Fri Mar 2 13:10:43 2007 UTC (7 years, 9 months ago) by nigel
File size: 3225 byte(s)
 r6896@hex:  nm | 2007-03-02 13:09:14 +0000
 Added EOL and keywork properties throughout

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 .br
11 .B int pcre_dfa_exec(const pcre *\fIcode\fP, "const pcre_extra *\fIextra\fP,"
12 .ti +5n
13 .B "const char *\fIsubject\fP," int \fIlength\fP, int \fIstartoffset\fP,
14 .ti +5n
15 .B int \fIoptions\fP, int *\fIovector\fP, int \fIovecsize\fP,
16 .ti +5n
17 .B int *\fIworkspace\fP, int \fIwscount\fP);
18 .
19 .SH DESCRIPTION
20 .rs
21 .sp
22 This function matches a compiled regular expression against a given subject
23 string, using an alternative matching algorithm that scans the subject string
24 just once (\fInot\fP Perl-compatible). Note that the main, Perl-compatible,
25 matching function is \fBpcre_exec()\fP. The arguments for this function are:
26 .sp
27 \fIcode\fP Points to the compiled pattern
28 \fIextra\fP Points to an associated \fBpcre_extra\fP structure,
29 or is NULL
30 \fIsubject\fP Points to the subject string
31 \fIlength\fP Length of the subject string, in bytes
32 \fIstartoffset\fP Offset in bytes in the subject at which to
33 start matching
34 \fIoptions\fP Option bits
35 \fIovector\fP Points to a vector of ints for result offsets
36 \fIovecsize\fP Number of elements in the vector
37 \fIworkspace\fP Points to a vector of ints used as working space
38 \fIwscount\fP Number of elements in the vector
39 .sp
40 The options are:
41 .sp
42 PCRE_ANCHORED Match only at the first position
43 PCRE_NEWLINE_ANY Recognize any Unicode newline sequence
44 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 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 There are restrictions on what may appear in a pattern when using this matching
58 function. Details are given in the
59 .\" 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 \fImatch_limit\fP Limit on internal resource use
69 \fImatch_limit_recursion\fP Limit on internal recursion depth
70 \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 PCRE_EXTRA_MATCH_LIMIT_RECURSION, PCRE_EXTRA_CALLOUT_DATA, and
75 PCRE_EXTRA_TABLES. For this matching function, the \fImatch_limit\fP and
76 \fImatch_limit_recursion\fP fields are not used, and must not be set.
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.

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