/[pcre]/code/trunk/doc/html/pcre_dfa_exec.html
ViewVC logotype

Contents of /code/trunk/doc/html/pcre_dfa_exec.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1194 - (show annotations)
Wed Oct 31 17:42:29 2012 UTC (6 years, 9 months ago) by ph10
File MIME type: text/html
File size: 5786 byte(s)
More documentation updates
1 <html>
2 <head>
3 <title>pcre_dfa_exec specification</title>
4 </head>
5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6 <h1>pcre_dfa_exec man page</h1>
7 <p>
8 Return to the <a href="index.html">PCRE index page</a>.
9 </p>
10 <p>
11 This page is part of the PCRE HTML documentation. It was generated automatically
12 from the original man page. If there is any nonsense in it, please consult the
13 man page, in case the conversion went wrong.
14 <br>
15 <br><b>
16 SYNOPSIS
17 </b><br>
18 <P>
19 <b>#include &#60;pcre.h&#62;</b>
20 </P>
21 <P>
22 <b>int pcre_dfa_exec(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b>
23 <b>const char *<i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b>
24 <b>int <i>options</i>, int *<i>ovector</i>, int <i>ovecsize</i>,</b>
25 <b>int *<i>workspace</i>, int <i>wscount</i>);</b>
26 </P>
27 <P>
28 <b>int pcre16_dfa_exec(const pcre16 *<i>code</i>, const pcre16_extra *<i>extra</i>,</b>
29 <b>PCRE_SPTR16 <i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b>
30 <b>int <i>options</i>, int *<i>ovector</i>, int <i>ovecsize</i>,</b>
31 <b>int *<i>workspace</i>, int <i>wscount</i>);</b>
32 </P>
33 <P>
34 <b>int pcre32_dfa_exec(const pcre32 *<i>code</i>, const pcre32_extra *<i>extra</i>,</b>
35 <b>PCRE_SPTR32 <i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b>
36 <b>int <i>options</i>, int *<i>ovector</i>, int <i>ovecsize</i>,</b>
37 <b>int *<i>workspace</i>, int <i>wscount</i>);</b>
38 </P>
39 <br><b>
40 DESCRIPTION
41 </b><br>
42 <P>
43 This function matches a compiled regular expression against a given subject
44 string, using an alternative matching algorithm that scans the subject string
45 just once (<i>not</i> Perl-compatible). Note that the main, Perl-compatible,
46 matching function is <b>pcre[16|32]_exec()</b>. The arguments for this function
47 are:
48 <pre>
49 <i>code</i> Points to the compiled pattern
50 <i>extra</i> Points to an associated <b>pcre[16|32]_extra</b> structure,
51 or is NULL
52 <i>subject</i> Points to the subject string
53 <i>length</i> Length of the subject string, in bytes
54 <i>startoffset</i> Offset in bytes in the subject at which to
55 start matching
56 <i>options</i> Option bits
57 <i>ovector</i> Points to a vector of ints for result offsets
58 <i>ovecsize</i> Number of elements in the vector
59 <i>workspace</i> Points to a vector of ints used as working space
60 <i>wscount</i> Number of elements in the vector
61 </pre>
62 The options are:
63 <pre>
64 PCRE_ANCHORED Match only at the first position
65 PCRE_BSR_ANYCRLF \R matches only CR, LF, or CRLF
66 PCRE_BSR_UNICODE \R matches all Unicode line endings
67 PCRE_NEWLINE_ANY Recognize any Unicode newline sequence
68 PCRE_NEWLINE_ANYCRLF Recognize CR, LF, & CRLF as newline sequences
69 PCRE_NEWLINE_CR Recognize CR as the only newline sequence
70 PCRE_NEWLINE_CRLF Recognize CRLF as the only newline sequence
71 PCRE_NEWLINE_LF Recognize LF as the only newline sequence
72 PCRE_NOTBOL Subject is not the beginning of a line
73 PCRE_NOTEOL Subject is not the end of a line
74 PCRE_NOTEMPTY An empty string is not a valid match
75 PCRE_NOTEMPTY_ATSTART An empty string at the start of the subject
76 is not a valid match
77 PCRE_NO_START_OPTIMIZE Do not do "start-match" optimizations
78 PCRE_NO_UTF16_CHECK Do not check the subject for UTF-16
79 validity (only relevant if PCRE_UTF16
80 was set at compile time)
81 PCRE_NO_UTF32_CHECK Do not check the subject for UTF-32
82 validity (only relevant if PCRE_UTF32
83 was set at compile time)
84 PCRE_NO_UTF8_CHECK Do not check the subject for UTF-8
85 validity (only relevant if PCRE_UTF8
86 was set at compile time)
87 PCRE_PARTIAL ) Return PCRE_ERROR_PARTIAL for a partial
88 PCRE_PARTIAL_SOFT ) match if no full matches are found
89 PCRE_PARTIAL_HARD Return PCRE_ERROR_PARTIAL for a partial match
90 even if there is a full match as well
91 PCRE_DFA_SHORTEST Return only the shortest match
92 PCRE_DFA_RESTART Restart after a partial match
93 </pre>
94 There are restrictions on what may appear in a pattern when using this matching
95 function. Details are given in the
96 <a href="pcrematching.html"><b>pcrematching</b></a>
97 documentation. For details of partial matching, see the
98 <a href="pcrepartial.html"><b>pcrepartial</b></a>
99 page.
100 </P>
101 <P>
102 A <b>pcre[16|32]_extra</b> structure contains the following fields:
103 <pre>
104 <i>flags</i> Bits indicating which fields are set
105 <i>study_data</i> Opaque data from <b>pcre[16|32]_study()</b>
106 <i>match_limit</i> Limit on internal resource use
107 <i>match_limit_recursion</i> Limit on internal recursion depth
108 <i>callout_data</i> Opaque data passed back to callouts
109 <i>tables</i> Points to character tables or is NULL
110 <i>mark</i> For passing back a *MARK pointer
111 <i>executable_jit</i> Opaque data from JIT compilation
112 </pre>
113 The flag bits are PCRE_EXTRA_STUDY_DATA, PCRE_EXTRA_MATCH_LIMIT,
114 PCRE_EXTRA_MATCH_LIMIT_RECURSION, PCRE_EXTRA_CALLOUT_DATA,
115 PCRE_EXTRA_TABLES, PCRE_EXTRA_MARK and PCRE_EXTRA_EXECUTABLE_JIT. For this
116 matching function, the <i>match_limit</i> and <i>match_limit_recursion</i> fields
117 are not used, and must not be set. The PCRE_EXTRA_EXECUTABLE_JIT flag and
118 the corresponding variable are ignored.
119 </P>
120 <P>
121 There is a complete description of the PCRE native API in the
122 <a href="pcreapi.html"><b>pcreapi</b></a>
123 page and a description of the POSIX API in the
124 <a href="pcreposix.html"><b>pcreposix</b></a>
125 page.
126 <p>
127 Return to the <a href="index.html">PCRE index page</a>.
128 </p>

Properties

Name Value
svn:eol-style native
svn:keywords "Author Date Id Revision Url"

  ViewVC Help
Powered by ViewVC 1.1.5