~ubuntu-branches/ubuntu/trusty/pcre3/trusty

« back to all changes in this revision

Viewing changes to doc/pcre_dfa_exec.3

  • Committer: Package Import Robot
  • Author(s): Mark Baker
  • Date: 2012-03-23 22:34:54 UTC
  • mfrom: (23.1.9 sid)
  • Revision ID: package-import@ubuntu.com-20120323223454-grhqqolk8a7x1h24
Tags: 1:8.30-4
* Reluctantly using an epoch, as it seems the funny version number with
  extra dots causes problems
* Bumped standard version to 3.9.3. No changes needed
* Converted to use new source format / quilt
* Put back obsolete pcre_info() API that upstream have dropped (Closes:
  #665300, #665356)
* Don't include pcregrep binary in debug package

Thanks to Elimar Riesebieter for the conversion to the new source format.

Show diffs side-by-side

added added

removed removed

Lines of Context:
14
14
.B int \fIoptions\fP, int *\fIovector\fP, int \fIovecsize\fP,
15
15
.ti +5n
16
16
.B int *\fIworkspace\fP, int \fIwscount\fP);
 
17
.PP
 
18
.B int pcre16_dfa_exec(const pcre16 *\fIcode\fP, "const pcre16_extra *\fIextra\fP,"
 
19
.ti +5n
 
20
.B "PCRE_SPTR16 \fIsubject\fP," int \fIlength\fP, int \fIstartoffset\fP,
 
21
.ti +5n
 
22
.B int \fIoptions\fP, int *\fIovector\fP, int \fIovecsize\fP,
 
23
.ti +5n
 
24
.B int *\fIworkspace\fP, int \fIwscount\fP);
17
25
.
18
26
.SH DESCRIPTION
19
27
.rs
21
29
This function matches a compiled regular expression against a given subject
22
30
string, using an alternative matching algorithm that scans the subject string
23
31
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:
 
32
matching function is \fBpcre[16]_exec()\fP. The arguments for this function
 
33
are:
25
34
.sp
26
35
  \fIcode\fP         Points to the compiled pattern
27
 
  \fIextra\fP        Points to an associated \fBpcre_extra\fP structure,
 
36
  \fIextra\fP        Points to an associated \fBpcre[16]_extra\fP structure,
28
37
                 or is NULL
29
38
  \fIsubject\fP      Points to the subject string
30
39
  \fIlength\fP       Length of the subject string, in bytes
52
61
  PCRE_NOTEMPTY_ATSTART  An empty string at the start of the subject
53
62
                           is not a valid match
54
63
  PCRE_NO_START_OPTIMIZE Do not do "start-match" optimizations
 
64
  PCRE_NO_UTF16_CHECK    Do not check the subject for UTF-16
 
65
                           validity (only relevant if PCRE_UTF16
 
66
                           was set at compile time)
55
67
  PCRE_NO_UTF8_CHECK     Do not check the subject for UTF-8
56
68
                           validity (only relevant if PCRE_UTF8
57
69
                           was set at compile time)
73
85
.\"
74
86
page.
75
87
.P
76
 
A \fBpcre_extra\fP structure contains the following fields:
 
88
A \fBpcre[16]_extra\fP structure contains the following fields:
77
89
.sp
78
 
  \fIflags\fP        Bits indicating which fields are set
79
 
  \fIstudy_data\fP   Opaque data from \fBpcre_study()\fP
80
 
  \fImatch_limit\fP  Limit on internal resource use
 
90
  \fIflags\fP            Bits indicating which fields are set
 
91
  \fIstudy_data\fP       Opaque data from \fBpcre[16]_study()\fP
 
92
  \fImatch_limit\fP      Limit on internal resource use
81
93
  \fImatch_limit_recursion\fP  Limit on internal recursion depth
82
 
  \fIcallout_data\fP Opaque data passed back to callouts
83
 
  \fItables\fP       Points to character tables or is NULL
 
94
  \fIcallout_data\fP     Opaque data passed back to callouts
 
95
  \fItables\fP           Points to character tables or is NULL
 
96
  \fImark\fP             For passing back a *MARK pointer
 
97
  \fIexecutable_jit\fP   Opaque data from JIT compilation
84
98
.sp
85
99
The flag bits are PCRE_EXTRA_STUDY_DATA, PCRE_EXTRA_MATCH_LIMIT,
86
 
PCRE_EXTRA_MATCH_LIMIT_RECURSION, PCRE_EXTRA_CALLOUT_DATA, and
87
 
PCRE_EXTRA_TABLES. For this matching function, the \fImatch_limit\fP and
88
 
\fImatch_limit_recursion\fP fields are not used, and must not be set.
 
100
PCRE_EXTRA_MATCH_LIMIT_RECURSION, PCRE_EXTRA_CALLOUT_DATA,
 
101
PCRE_EXTRA_TABLES, PCRE_EXTRA_MARK and PCRE_EXTRA_EXECUTABLE_JIT. For this
 
102
matching function, the \fImatch_limit\fP and \fImatch_limit_recursion\fP fields
 
103
are not used, and must not be set. The PCRE_EXTRA_EXECUTABLE_JIT flag and
 
104
the corresponding variable are ignored.
89
105
.P
90
106
There is a complete description of the PCRE native API in the
91
107
.\" HREF