/[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 99 - (hide annotations) (download)
Tue Mar 6 12:27:42 2007 UTC (7 years, 8 months ago) by ph10
File size: 3221 byte(s)
1. Move the comment about version numbers from pcre.h.in to configure.ac 
because that's where they are now set.
2. Update all the man pages to remove the use of .br and .in because this
causes trouble for some HTML converters. Also standardised the final sections 
giving author information and revision date.
3. Update the maintain/132html man page converter to handle .nf/.fi and to barf 
at .br/.in.

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 nigel 93 PCRE_NEWLINE_ANY Recognize any Unicode newline sequence
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 nigel 93 There are restrictions on what may appear in a pattern when using this matching
57     function. Details are given in the
58 nigel 77 .\" 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 nigel 93 PCRE_EXTRA_TABLES. For this matching function, the \fImatch_limit\fP and
75 nigel 87 \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.

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