Annotation of embedaddon/pcre/doc/html/pcre_dfa_exec.html, revision 1.1.1.2
1.1 misho 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 <pcre.h></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>
1.1.1.2 ! misho 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>
1.1 misho 33: <br><b>
34: DESCRIPTION
35: </b><br>
36: <P>
37: This function matches a compiled regular expression against a given subject
38: string, using an alternative matching algorithm that scans the subject string
39: just once (<i>not</i> Perl-compatible). Note that the main, Perl-compatible,
1.1.1.2 ! misho 40: matching function is <b>pcre[16]_exec()</b>. The arguments for this function
! 41: are:
1.1 misho 42: <pre>
43: <i>code</i> Points to the compiled pattern
1.1.1.2 ! misho 44: <i>extra</i> Points to an associated <b>pcre[16]_extra</b> structure,
1.1 misho 45: or is NULL
46: <i>subject</i> Points to the subject string
47: <i>length</i> Length of the subject string, in bytes
48: <i>startoffset</i> Offset in bytes in the subject at which to
49: start matching
50: <i>options</i> Option bits
51: <i>ovector</i> Points to a vector of ints for result offsets
52: <i>ovecsize</i> Number of elements in the vector
53: <i>workspace</i> Points to a vector of ints used as working space
54: <i>wscount</i> Number of elements in the vector
55: </pre>
56: The options are:
57: <pre>
58: PCRE_ANCHORED Match only at the first position
59: PCRE_BSR_ANYCRLF \R matches only CR, LF, or CRLF
60: PCRE_BSR_UNICODE \R matches all Unicode line endings
61: PCRE_NEWLINE_ANY Recognize any Unicode newline sequence
62: PCRE_NEWLINE_ANYCRLF Recognize CR, LF, & CRLF as newline sequences
63: PCRE_NEWLINE_CR Recognize CR as the only newline sequence
64: PCRE_NEWLINE_CRLF Recognize CRLF as the only newline sequence
65: PCRE_NEWLINE_LF Recognize LF as the only newline sequence
66: PCRE_NOTBOL Subject is not the beginning of a line
67: PCRE_NOTEOL Subject is not the end of a line
68: PCRE_NOTEMPTY An empty string is not a valid match
69: PCRE_NOTEMPTY_ATSTART An empty string at the start of the subject
70: is not a valid match
71: PCRE_NO_START_OPTIMIZE Do not do "start-match" optimizations
1.1.1.2 ! misho 72: PCRE_NO_UTF16_CHECK Do not check the subject for UTF-16
! 73: validity (only relevant if PCRE_UTF16
! 74: was set at compile time)
1.1 misho 75: PCRE_NO_UTF8_CHECK Do not check the subject for UTF-8
76: validity (only relevant if PCRE_UTF8
77: was set at compile time)
78: PCRE_PARTIAL ) Return PCRE_ERROR_PARTIAL for a partial
79: PCRE_PARTIAL_SOFT ) match if no full matches are found
80: PCRE_PARTIAL_HARD Return PCRE_ERROR_PARTIAL for a partial match
81: even if there is a full match as well
82: PCRE_DFA_SHORTEST Return only the shortest match
83: PCRE_DFA_RESTART Restart after a partial match
84: </pre>
85: There are restrictions on what may appear in a pattern when using this matching
86: function. Details are given in the
87: <a href="pcrematching.html"><b>pcrematching</b></a>
88: documentation. For details of partial matching, see the
89: <a href="pcrepartial.html"><b>pcrepartial</b></a>
90: page.
91: </P>
92: <P>
1.1.1.2 ! misho 93: A <b>pcre[16]_extra</b> structure contains the following fields:
1.1 misho 94: <pre>
95: <i>flags</i> Bits indicating which fields are set
1.1.1.2 ! misho 96: <i>study_data</i> Opaque data from <b>pcre[16]_study()</b>
1.1 misho 97: <i>match_limit</i> Limit on internal resource use
98: <i>match_limit_recursion</i> Limit on internal recursion depth
99: <i>callout_data</i> Opaque data passed back to callouts
100: <i>tables</i> Points to character tables or is NULL
101: <i>mark</i> For passing back a *MARK pointer
102: <i>executable_jit</i> Opaque data from JIT compilation
103: </pre>
104: The flag bits are PCRE_EXTRA_STUDY_DATA, PCRE_EXTRA_MATCH_LIMIT,
105: PCRE_EXTRA_MATCH_LIMIT_RECURSION, PCRE_EXTRA_CALLOUT_DATA,
106: PCRE_EXTRA_TABLES, PCRE_EXTRA_MARK and PCRE_EXTRA_EXECUTABLE_JIT. For this
107: matching function, the <i>match_limit</i> and <i>match_limit_recursion</i> fields
108: are not used, and must not be set. The PCRE_EXTRA_EXECUTABLE_JIT flag and
109: the corresponding variable are ignored.
110: </P>
111: <P>
112: There is a complete description of the PCRE native API in the
113: <a href="pcreapi.html"><b>pcreapi</b></a>
114: page and a description of the POSIX API in the
115: <a href="pcreposix.html"><b>pcreposix</b></a>
116: page.
117: <p>
118: Return to the <a href="index.html">PCRE index page</a>.
119: </p>
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>