/[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 91 - (hide annotations) (download)
Sat Feb 24 21:41:34 2007 UTC (7 years, 5 months ago) by nigel
File size: 3123 byte(s)
Load pcre-6.7 into code/trunk.

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     .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 a DFA matching algorithm (\fInot\fP Perl-compatible). Note that
24     the main, Perl-compatible, matching function is \fBpcre_exec()\fP. The
25     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 nigel 91 PCRE_NEWLINE_CR Set CR as the newline sequence
44     PCRE_NEWLINE_CRLF Set CRLF as the newline sequence
45     PCRE_NEWLINE_LF Set LF as the newline sequence
46 nigel 77 PCRE_NOTBOL Subject is not the beginning of a line
47     PCRE_NOTEOL Subject is not the end of a line
48     PCRE_NOTEMPTY An empty string is not a valid match
49     PCRE_NO_UTF8_CHECK Do not check the subject for UTF-8
50     validity (only relevant if PCRE_UTF8
51     was set at compile time)
52     PCRE_PARTIAL Return PCRE_ERROR_PARTIAL for a partial match
53     PCRE_DFA_SHORTEST Return only the shortest match
54     PCRE_DFA_RESTART This is a restart after a partial match
55     .sp
56     There are restrictions on what may appear in a pattern when matching using the
57     DFA algorithm is requested. Details are given in the
58     .\" HREF
59     \fBpcrematching\fP
60     .\"
61     documentation.
62     .P
63     A \fBpcre_extra\fP structure contains the following fields:
64     .sp
65     \fIflags\fP Bits indicating which fields are set
66     \fIstudy_data\fP Opaque data from \fBpcre_study()\fP
67 nigel 87 \fImatch_limit\fP Limit on internal resource use
68     \fImatch_limit_recursion\fP Limit on internal recursion depth
69 nigel 77 \fIcallout_data\fP Opaque data passed back to callouts
70     \fItables\fP Points to character tables or is NULL
71     .sp
72     The flag bits are PCRE_EXTRA_STUDY_DATA, PCRE_EXTRA_MATCH_LIMIT,
73 nigel 87 PCRE_EXTRA_MATCH_LIMIT_RECURSION, PCRE_EXTRA_CALLOUT_DATA, and
74     PCRE_EXTRA_TABLES. For DFA matching, the \fImatch_limit\fP and
75     \fImatch_limit_recursion\fP fields are not used, and must not be set.
76 nigel 77 .P
77     There is a complete description of the PCRE native API in the
78     .\" HREF
79     \fBpcreapi\fP
80     .\"
81     page and a description of the POSIX API in the
82     .\" HREF
83     \fBpcreposix\fP
84     .\"
85     page.

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12