/[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 231 - (hide annotations) (download)
Tue Sep 11 11:15:33 2007 UTC (7 years, 1 month ago) by ph10
File size: 3405 byte(s)
Add facility to make \R match only CR, LF, or CRLF.

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 ph10 231 PCRE_BSR_ANYCRLF \eR matches only CR, LF, or CRLF
43     PCRE_BSR_UNICODE \eR matches all Unicode line endings
44 nigel 93 PCRE_NEWLINE_ANY Recognize any Unicode newline sequence
45 ph10 149 PCRE_NEWLINE_ANYCRLF Recognize CR, LF, and CRLF as newline sequences
46 nigel 91 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 nigel 77 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_UTF8_CHECK Do not check the subject for UTF-8
53     validity (only relevant if PCRE_UTF8
54     was set at compile time)
55     PCRE_PARTIAL Return PCRE_ERROR_PARTIAL for a partial match
56     PCRE_DFA_SHORTEST Return only the shortest match
57     PCRE_DFA_RESTART This is a restart after a partial match
58     .sp
59 nigel 93 There are restrictions on what may appear in a pattern when using this matching
60     function. Details are given in the
61 nigel 77 .\" HREF
62     \fBpcrematching\fP
63     .\"
64     documentation.
65     .P
66     A \fBpcre_extra\fP structure contains the following fields:
67     .sp
68     \fIflags\fP Bits indicating which fields are set
69     \fIstudy_data\fP Opaque data from \fBpcre_study()\fP
70 nigel 87 \fImatch_limit\fP Limit on internal resource use
71     \fImatch_limit_recursion\fP Limit on internal recursion depth
72 nigel 77 \fIcallout_data\fP Opaque data passed back to callouts
73     \fItables\fP Points to character tables or is NULL
74     .sp
75     The flag bits are PCRE_EXTRA_STUDY_DATA, PCRE_EXTRA_MATCH_LIMIT,
76 nigel 87 PCRE_EXTRA_MATCH_LIMIT_RECURSION, PCRE_EXTRA_CALLOUT_DATA, and
77 nigel 93 PCRE_EXTRA_TABLES. For this matching function, the \fImatch_limit\fP and
78 nigel 87 \fImatch_limit_recursion\fP fields are not used, and must not be set.
79 nigel 77 .P
80     There is a complete description of the PCRE native API in the
81     .\" HREF
82     \fBpcreapi\fP
83     .\"
84     page and a description of the POSIX API in the
85     .\" HREF
86     \fBpcreposix\fP
87     .\"
88     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