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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 512 - (show annotations)
Tue Mar 30 11:11:52 2010 UTC (9 years, 5 months ago) by ph10
File MIME type: text/html
File size: 95777 byte(s)
Error occurred while calculating annotation data.
Fix compile problems when heap is in use
1 <html>
2 <head>
3 <title>pcreapi specification</title>
4 </head>
5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6 <h1>pcreapi 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 <ul>
16 <li><a name="TOC1" href="#SEC1">PCRE NATIVE API</a>
17 <li><a name="TOC2" href="#SEC2">PCRE API OVERVIEW</a>
18 <li><a name="TOC3" href="#SEC3">NEWLINES</a>
19 <li><a name="TOC4" href="#SEC4">MULTITHREADING</a>
20 <li><a name="TOC5" href="#SEC5">SAVING PRECOMPILED PATTERNS FOR LATER USE</a>
21 <li><a name="TOC6" href="#SEC6">CHECKING BUILD-TIME OPTIONS</a>
22 <li><a name="TOC7" href="#SEC7">COMPILING A PATTERN</a>
23 <li><a name="TOC8" href="#SEC8">COMPILATION ERROR CODES</a>
24 <li><a name="TOC9" href="#SEC9">STUDYING A PATTERN</a>
25 <li><a name="TOC10" href="#SEC10">LOCALE SUPPORT</a>
26 <li><a name="TOC11" href="#SEC11">INFORMATION ABOUT A PATTERN</a>
27 <li><a name="TOC12" href="#SEC12">OBSOLETE INFO FUNCTION</a>
28 <li><a name="TOC13" href="#SEC13">REFERENCE COUNTS</a>
29 <li><a name="TOC14" href="#SEC14">MATCHING A PATTERN: THE TRADITIONAL FUNCTION</a>
30 <li><a name="TOC15" href="#SEC15">EXTRACTING CAPTURED SUBSTRINGS BY NUMBER</a>
31 <li><a name="TOC16" href="#SEC16">EXTRACTING CAPTURED SUBSTRINGS BY NAME</a>
32 <li><a name="TOC17" href="#SEC17">DUPLICATE SUBPATTERN NAMES</a>
33 <li><a name="TOC18" href="#SEC18">FINDING ALL POSSIBLE MATCHES</a>
34 <li><a name="TOC19" href="#SEC19">MATCHING A PATTERN: THE ALTERNATIVE FUNCTION</a>
35 <li><a name="TOC20" href="#SEC20">SEE ALSO</a>
36 <li><a name="TOC21" href="#SEC21">AUTHOR</a>
37 <li><a name="TOC22" href="#SEC22">REVISION</a>
38 </ul>
39 <br><a name="SEC1" href="#TOC1">PCRE NATIVE API</a><br>
40 <P>
41 <b>#include &#60;pcre.h&#62;</b>
42 </P>
43 <P>
44 <b>pcre *pcre_compile(const char *<i>pattern</i>, int <i>options</i>,</b>
45 <b>const char **<i>errptr</i>, int *<i>erroffset</i>,</b>
46 <b>const unsigned char *<i>tableptr</i>);</b>
47 </P>
48 <P>
49 <b>pcre *pcre_compile2(const char *<i>pattern</i>, int <i>options</i>,</b>
50 <b>int *<i>errorcodeptr</i>,</b>
51 <b>const char **<i>errptr</i>, int *<i>erroffset</i>,</b>
52 <b>const unsigned char *<i>tableptr</i>);</b>
53 </P>
54 <P>
55 <b>pcre_extra *pcre_study(const pcre *<i>code</i>, int <i>options</i>,</b>
56 <b>const char **<i>errptr</i>);</b>
57 </P>
58 <P>
59 <b>int pcre_exec(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b>
60 <b>const char *<i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b>
61 <b>int <i>options</i>, int *<i>ovector</i>, int <i>ovecsize</i>);</b>
62 </P>
63 <P>
64 <b>int pcre_dfa_exec(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b>
65 <b>const char *<i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b>
66 <b>int <i>options</i>, int *<i>ovector</i>, int <i>ovecsize</i>,</b>
67 <b>int *<i>workspace</i>, int <i>wscount</i>);</b>
68 </P>
69 <P>
70 <b>int pcre_copy_named_substring(const pcre *<i>code</i>,</b>
71 <b>const char *<i>subject</i>, int *<i>ovector</i>,</b>
72 <b>int <i>stringcount</i>, const char *<i>stringname</i>,</b>
73 <b>char *<i>buffer</i>, int <i>buffersize</i>);</b>
74 </P>
75 <P>
76 <b>int pcre_copy_substring(const char *<i>subject</i>, int *<i>ovector</i>,</b>
77 <b>int <i>stringcount</i>, int <i>stringnumber</i>, char *<i>buffer</i>,</b>
78 <b>int <i>buffersize</i>);</b>
79 </P>
80 <P>
81 <b>int pcre_get_named_substring(const pcre *<i>code</i>,</b>
82 <b>const char *<i>subject</i>, int *<i>ovector</i>,</b>
83 <b>int <i>stringcount</i>, const char *<i>stringname</i>,</b>
84 <b>const char **<i>stringptr</i>);</b>
85 </P>
86 <P>
87 <b>int pcre_get_stringnumber(const pcre *<i>code</i>,</b>
88 <b>const char *<i>name</i>);</b>
89 </P>
90 <P>
91 <b>int pcre_get_stringtable_entries(const pcre *<i>code</i>,</b>
92 <b>const char *<i>name</i>, char **<i>first</i>, char **<i>last</i>);</b>
93 </P>
94 <P>
95 <b>int pcre_get_substring(const char *<i>subject</i>, int *<i>ovector</i>,</b>
96 <b>int <i>stringcount</i>, int <i>stringnumber</i>,</b>
97 <b>const char **<i>stringptr</i>);</b>
98 </P>
99 <P>
100 <b>int pcre_get_substring_list(const char *<i>subject</i>,</b>
101 <b>int *<i>ovector</i>, int <i>stringcount</i>, const char ***<i>listptr</i>);</b>
102 </P>
103 <P>
104 <b>void pcre_free_substring(const char *<i>stringptr</i>);</b>
105 </P>
106 <P>
107 <b>void pcre_free_substring_list(const char **<i>stringptr</i>);</b>
108 </P>
109 <P>
110 <b>const unsigned char *pcre_maketables(void);</b>
111 </P>
112 <P>
113 <b>int pcre_fullinfo(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b>
114 <b>int <i>what</i>, void *<i>where</i>);</b>
115 </P>
116 <P>
117 <b>int pcre_info(const pcre *<i>code</i>, int *<i>optptr</i>, int</b>
118 <b>*<i>firstcharptr</i>);</b>
119 </P>
120 <P>
121 <b>int pcre_refcount(pcre *<i>code</i>, int <i>adjust</i>);</b>
122 </P>
123 <P>
124 <b>int pcre_config(int <i>what</i>, void *<i>where</i>);</b>
125 </P>
126 <P>
127 <b>char *pcre_version(void);</b>
128 </P>
129 <P>
130 <b>void *(*pcre_malloc)(size_t);</b>
131 </P>
132 <P>
133 <b>void (*pcre_free)(void *);</b>
134 </P>
135 <P>
136 <b>void *(*pcre_stack_malloc)(size_t);</b>
137 </P>
138 <P>
139 <b>void (*pcre_stack_free)(void *);</b>
140 </P>
141 <P>
142 <b>int (*pcre_callout)(pcre_callout_block *);</b>
143 </P>
144 <br><a name="SEC2" href="#TOC1">PCRE API OVERVIEW</a><br>
145 <P>
146 PCRE has its own native API, which is described in this document. There are
147 also some wrapper functions that correspond to the POSIX regular expression
148 API. These are described in the
149 <a href="pcreposix.html"><b>pcreposix</b></a>
150 documentation. Both of these APIs define a set of C function calls. A C++
151 wrapper is distributed with PCRE. It is documented in the
152 <a href="pcrecpp.html"><b>pcrecpp</b></a>
153 page.
154 </P>
155 <P>
156 The native API C function prototypes are defined in the header file
157 <b>pcre.h</b>, and on Unix systems the library itself is called <b>libpcre</b>.
158 It can normally be accessed by adding <b>-lpcre</b> to the command for linking
159 an application that uses PCRE. The header file defines the macros PCRE_MAJOR
160 and PCRE_MINOR to contain the major and minor release numbers for the library.
161 Applications can use these to include support for different releases of PCRE.
162 </P>
163 <P>
164 The functions <b>pcre_compile()</b>, <b>pcre_compile2()</b>, <b>pcre_study()</b>,
165 and <b>pcre_exec()</b> are used for compiling and matching regular expressions
166 in a Perl-compatible manner. A sample program that demonstrates the simplest
167 way of using them is provided in the file called <i>pcredemo.c</i> in the PCRE
168 source distribution. A listing of this program is given in the
169 <a href="pcredemo.html"><b>pcredemo</b></a>
170 documentation, and the
171 <a href="pcresample.html"><b>pcresample</b></a>
172 documentation describes how to compile and run it.
173 </P>
174 <P>
175 A second matching function, <b>pcre_dfa_exec()</b>, which is not
176 Perl-compatible, is also provided. This uses a different algorithm for the
177 matching. The alternative algorithm finds all possible matches (at a given
178 point in the subject), and scans the subject just once (unless there are
179 lookbehind assertions). However, this algorithm does not return captured
180 substrings. A description of the two matching algorithms and their advantages
181 and disadvantages is given in the
182 <a href="pcrematching.html"><b>pcrematching</b></a>
183 documentation.
184 </P>
185 <P>
186 In addition to the main compiling and matching functions, there are convenience
187 functions for extracting captured substrings from a subject string that is
188 matched by <b>pcre_exec()</b>. They are:
189 <pre>
190 <b>pcre_copy_substring()</b>
191 <b>pcre_copy_named_substring()</b>
192 <b>pcre_get_substring()</b>
193 <b>pcre_get_named_substring()</b>
194 <b>pcre_get_substring_list()</b>
195 <b>pcre_get_stringnumber()</b>
196 <b>pcre_get_stringtable_entries()</b>
197 </pre>
198 <b>pcre_free_substring()</b> and <b>pcre_free_substring_list()</b> are also
199 provided, to free the memory used for extracted strings.
200 </P>
201 <P>
202 The function <b>pcre_maketables()</b> is used to build a set of character tables
203 in the current locale for passing to <b>pcre_compile()</b>, <b>pcre_exec()</b>,
204 or <b>pcre_dfa_exec()</b>. This is an optional facility that is provided for
205 specialist use. Most commonly, no special tables are passed, in which case
206 internal tables that are generated when PCRE is built are used.
207 </P>
208 <P>
209 The function <b>pcre_fullinfo()</b> is used to find out information about a
210 compiled pattern; <b>pcre_info()</b> is an obsolete version that returns only
211 some of the available information, but is retained for backwards compatibility.
212 The function <b>pcre_version()</b> returns a pointer to a string containing the
213 version of PCRE and its date of release.
214 </P>
215 <P>
216 The function <b>pcre_refcount()</b> maintains a reference count in a data block
217 containing a compiled pattern. This is provided for the benefit of
218 object-oriented applications.
219 </P>
220 <P>
221 The global variables <b>pcre_malloc</b> and <b>pcre_free</b> initially contain
222 the entry points of the standard <b>malloc()</b> and <b>free()</b> functions,
223 respectively. PCRE calls the memory management functions via these variables,
224 so a calling program can replace them if it wishes to intercept the calls. This
225 should be done before calling any PCRE functions.
226 </P>
227 <P>
228 The global variables <b>pcre_stack_malloc</b> and <b>pcre_stack_free</b> are also
229 indirections to memory management functions. These special functions are used
230 only when PCRE is compiled to use the heap for remembering data, instead of
231 recursive function calls, when running the <b>pcre_exec()</b> function. See the
232 <a href="pcrebuild.html"><b>pcrebuild</b></a>
233 documentation for details of how to do this. It is a non-standard way of
234 building PCRE, for use in environments that have limited stacks. Because of the
235 greater use of memory management, it runs more slowly. Separate functions are
236 provided so that special-purpose external code can be used for this case. When
237 used, these functions are always called in a stack-like manner (last obtained,
238 first freed), and always for memory blocks of the same size. There is a
239 discussion about PCRE's stack usage in the
240 <a href="pcrestack.html"><b>pcrestack</b></a>
241 documentation.
242 </P>
243 <P>
244 The global variable <b>pcre_callout</b> initially contains NULL. It can be set
245 by the caller to a "callout" function, which PCRE will then call at specified
246 points during a matching operation. Details are given in the
247 <a href="pcrecallout.html"><b>pcrecallout</b></a>
248 documentation.
249 <a name="newlines"></a></P>
250 <br><a name="SEC3" href="#TOC1">NEWLINES</a><br>
251 <P>
252 PCRE supports five different conventions for indicating line breaks in
253 strings: a single CR (carriage return) character, a single LF (linefeed)
254 character, the two-character sequence CRLF, any of the three preceding, or any
255 Unicode newline sequence. The Unicode newline sequences are the three just
256 mentioned, plus the single characters VT (vertical tab, U+000B), FF (formfeed,
257 U+000C), NEL (next line, U+0085), LS (line separator, U+2028), and PS
258 (paragraph separator, U+2029).
259 </P>
260 <P>
261 Each of the first three conventions is used by at least one operating system as
262 its standard newline sequence. When PCRE is built, a default can be specified.
263 The default default is LF, which is the Unix standard. When PCRE is run, the
264 default can be overridden, either when a pattern is compiled, or when it is
265 matched.
266 </P>
267 <P>
268 At compile time, the newline convention can be specified by the <i>options</i>
269 argument of <b>pcre_compile()</b>, or it can be specified by special text at the
270 start of the pattern itself; this overrides any other settings. See the
271 <a href="pcrepattern.html"><b>pcrepattern</b></a>
272 page for details of the special character sequences.
273 </P>
274 <P>
275 In the PCRE documentation the word "newline" is used to mean "the character or
276 pair of characters that indicate a line break". The choice of newline
277 convention affects the handling of the dot, circumflex, and dollar
278 metacharacters, the handling of #-comments in /x mode, and, when CRLF is a
279 recognized line ending sequence, the match position advancement for a
280 non-anchored pattern. There is more detail about this in the
281 <a href="#execoptions">section on <b>pcre_exec()</b> options</a>
282 below.
283 </P>
284 <P>
285 The choice of newline convention does not affect the interpretation of
286 the \n or \r escape sequences, nor does it affect what \R matches, which is
287 controlled in a similar way, but by separate options.
288 </P>
289 <br><a name="SEC4" href="#TOC1">MULTITHREADING</a><br>
290 <P>
291 The PCRE functions can be used in multi-threading applications, with the
292 proviso that the memory management functions pointed to by <b>pcre_malloc</b>,
293 <b>pcre_free</b>, <b>pcre_stack_malloc</b>, and <b>pcre_stack_free</b>, and the
294 callout function pointed to by <b>pcre_callout</b>, are shared by all threads.
295 </P>
296 <P>
297 The compiled form of a regular expression is not altered during matching, so
298 the same compiled pattern can safely be used by several threads at once.
299 </P>
300 <br><a name="SEC5" href="#TOC1">SAVING PRECOMPILED PATTERNS FOR LATER USE</a><br>
301 <P>
302 The compiled form of a regular expression can be saved and re-used at a later
303 time, possibly by a different program, and even on a host other than the one on
304 which it was compiled. Details are given in the
305 <a href="pcreprecompile.html"><b>pcreprecompile</b></a>
306 documentation. However, compiling a regular expression with one version of PCRE
307 for use with a different version is not guaranteed to work and may cause
308 crashes.
309 </P>
310 <br><a name="SEC6" href="#TOC1">CHECKING BUILD-TIME OPTIONS</a><br>
311 <P>
312 <b>int pcre_config(int <i>what</i>, void *<i>where</i>);</b>
313 </P>
314 <P>
315 The function <b>pcre_config()</b> makes it possible for a PCRE client to
316 discover which optional features have been compiled into the PCRE library. The
317 <a href="pcrebuild.html"><b>pcrebuild</b></a>
318 documentation has more details about these optional features.
319 </P>
320 <P>
321 The first argument for <b>pcre_config()</b> is an integer, specifying which
322 information is required; the second argument is a pointer to a variable into
323 which the information is placed. The following information is available:
324 <pre>
325 PCRE_CONFIG_UTF8
326 </pre>
327 The output is an integer that is set to one if UTF-8 support is available;
328 otherwise it is set to zero.
329 <pre>
330 PCRE_CONFIG_UNICODE_PROPERTIES
331 </pre>
332 The output is an integer that is set to one if support for Unicode character
333 properties is available; otherwise it is set to zero.
334 <pre>
335 PCRE_CONFIG_NEWLINE
336 </pre>
337 The output is an integer whose value specifies the default character sequence
338 that is recognized as meaning "newline". The four values that are supported
339 are: 10 for LF, 13 for CR, 3338 for CRLF, -2 for ANYCRLF, and -1 for ANY.
340 Though they are derived from ASCII, the same values are returned in EBCDIC
341 environments. The default should normally correspond to the standard sequence
342 for your operating system.
343 <pre>
344 PCRE_CONFIG_BSR
345 </pre>
346 The output is an integer whose value indicates what character sequences the \R
347 escape sequence matches by default. A value of 0 means that \R matches any
348 Unicode line ending sequence; a value of 1 means that \R matches only CR, LF,
349 or CRLF. The default can be overridden when a pattern is compiled or matched.
350 <pre>
351 PCRE_CONFIG_LINK_SIZE
352 </pre>
353 The output is an integer that contains the number of bytes used for internal
354 linkage in compiled regular expressions. The value is 2, 3, or 4. Larger values
355 allow larger regular expressions to be compiled, at the expense of slower
356 matching. The default value of 2 is sufficient for all but the most massive
357 patterns, since it allows the compiled pattern to be up to 64K in size.
358 <pre>
359 PCRE_CONFIG_POSIX_MALLOC_THRESHOLD
360 </pre>
361 The output is an integer that contains the threshold above which the POSIX
362 interface uses <b>malloc()</b> for output vectors. Further details are given in
363 the
364 <a href="pcreposix.html"><b>pcreposix</b></a>
365 documentation.
366 <pre>
367 PCRE_CONFIG_MATCH_LIMIT
368 </pre>
369 The output is a long integer that gives the default limit for the number of
370 internal matching function calls in a <b>pcre_exec()</b> execution. Further
371 details are given with <b>pcre_exec()</b> below.
372 <pre>
373 PCRE_CONFIG_MATCH_LIMIT_RECURSION
374 </pre>
375 The output is a long integer that gives the default limit for the depth of
376 recursion when calling the internal matching function in a <b>pcre_exec()</b>
377 execution. Further details are given with <b>pcre_exec()</b> below.
378 <pre>
379 PCRE_CONFIG_STACKRECURSE
380 </pre>
381 The output is an integer that is set to one if internal recursion when running
382 <b>pcre_exec()</b> is implemented by recursive function calls that use the stack
383 to remember their state. This is the usual way that PCRE is compiled. The
384 output is zero if PCRE was compiled to use blocks of data on the heap instead
385 of recursive function calls. In this case, <b>pcre_stack_malloc</b> and
386 <b>pcre_stack_free</b> are called to manage memory blocks on the heap, thus
387 avoiding the use of the stack.
388 </P>
389 <br><a name="SEC7" href="#TOC1">COMPILING A PATTERN</a><br>
390 <P>
391 <b>pcre *pcre_compile(const char *<i>pattern</i>, int <i>options</i>,</b>
392 <b>const char **<i>errptr</i>, int *<i>erroffset</i>,</b>
393 <b>const unsigned char *<i>tableptr</i>);</b>
394 <b>pcre *pcre_compile2(const char *<i>pattern</i>, int <i>options</i>,</b>
395 <b>int *<i>errorcodeptr</i>,</b>
396 <b>const char **<i>errptr</i>, int *<i>erroffset</i>,</b>
397 <b>const unsigned char *<i>tableptr</i>);</b>
398 </P>
399 <P>
400 Either of the functions <b>pcre_compile()</b> or <b>pcre_compile2()</b> can be
401 called to compile a pattern into an internal form. The only difference between
402 the two interfaces is that <b>pcre_compile2()</b> has an additional argument,
403 <i>errorcodeptr</i>, via which a numerical error code can be returned. To avoid
404 too much repetition, we refer just to <b>pcre_compile()</b> below, but the
405 information applies equally to <b>pcre_compile2()</b>.
406 </P>
407 <P>
408 The pattern is a C string terminated by a binary zero, and is passed in the
409 <i>pattern</i> argument. A pointer to a single block of memory that is obtained
410 via <b>pcre_malloc</b> is returned. This contains the compiled code and related
411 data. The <b>pcre</b> type is defined for the returned block; this is a typedef
412 for a structure whose contents are not externally defined. It is up to the
413 caller to free the memory (via <b>pcre_free</b>) when it is no longer required.
414 </P>
415 <P>
416 Although the compiled code of a PCRE regex is relocatable, that is, it does not
417 depend on memory location, the complete <b>pcre</b> data block is not
418 fully relocatable, because it may contain a copy of the <i>tableptr</i>
419 argument, which is an address (see below).
420 </P>
421 <P>
422 The <i>options</i> argument contains various bit settings that affect the
423 compilation. It should be zero if no options are required. The available
424 options are described below. Some of them (in particular, those that are
425 compatible with Perl, but some others as well) can also be set and unset from
426 within the pattern (see the detailed description in the
427 <a href="pcrepattern.html"><b>pcrepattern</b></a>
428 documentation). For those options that can be different in different parts of
429 the pattern, the contents of the <i>options</i> argument specifies their
430 settings at the start of compilation and execution. The PCRE_ANCHORED,
431 PCRE_BSR_<i>xxx</i>, and PCRE_NEWLINE_<i>xxx</i> options can be set at the time
432 of matching as well as at compile time.
433 </P>
434 <P>
435 If <i>errptr</i> is NULL, <b>pcre_compile()</b> returns NULL immediately.
436 Otherwise, if compilation of a pattern fails, <b>pcre_compile()</b> returns
437 NULL, and sets the variable pointed to by <i>errptr</i> to point to a textual
438 error message. This is a static string that is part of the library. You must
439 not try to free it. The byte offset from the start of the pattern to the
440 character that was being processed when the error was discovered is placed in
441 the variable pointed to by <i>erroffset</i>, which must not be NULL. If it is,
442 an immediate error is given. Some errors are not detected until checks are
443 carried out when the whole pattern has been scanned; in this case the offset is
444 set to the end of the pattern.
445 </P>
446 <P>
447 If <b>pcre_compile2()</b> is used instead of <b>pcre_compile()</b>, and the
448 <i>errorcodeptr</i> argument is not NULL, a non-zero error code number is
449 returned via this argument in the event of an error. This is in addition to the
450 textual error message. Error codes and messages are listed below.
451 </P>
452 <P>
453 If the final argument, <i>tableptr</i>, is NULL, PCRE uses a default set of
454 character tables that are built when PCRE is compiled, using the default C
455 locale. Otherwise, <i>tableptr</i> must be an address that is the result of a
456 call to <b>pcre_maketables()</b>. This value is stored with the compiled
457 pattern, and used again by <b>pcre_exec()</b>, unless another table pointer is
458 passed to it. For more discussion, see the section on locale support below.
459 </P>
460 <P>
461 This code fragment shows a typical straightforward call to <b>pcre_compile()</b>:
462 <pre>
463 pcre *re;
464 const char *error;
465 int erroffset;
466 re = pcre_compile(
467 "^A.*Z", /* the pattern */
468 0, /* default options */
469 &error, /* for error message */
470 &erroffset, /* for error offset */
471 NULL); /* use default character tables */
472 </pre>
473 The following names for option bits are defined in the <b>pcre.h</b> header
474 file:
475 <pre>
476 PCRE_ANCHORED
477 </pre>
478 If this bit is set, the pattern is forced to be "anchored", that is, it is
479 constrained to match only at the first matching point in the string that is
480 being searched (the "subject string"). This effect can also be achieved by
481 appropriate constructs in the pattern itself, which is the only way to do it in
482 Perl.
483 <pre>
484 PCRE_AUTO_CALLOUT
485 </pre>
486 If this bit is set, <b>pcre_compile()</b> automatically inserts callout items,
487 all with number 255, before each pattern item. For discussion of the callout
488 facility, see the
489 <a href="pcrecallout.html"><b>pcrecallout</b></a>
490 documentation.
491 <pre>
492 PCRE_BSR_ANYCRLF
493 PCRE_BSR_UNICODE
494 </pre>
495 These options (which are mutually exclusive) control what the \R escape
496 sequence matches. The choice is either to match only CR, LF, or CRLF, or to
497 match any Unicode newline sequence. The default is specified when PCRE is
498 built. It can be overridden from within the pattern, or by setting an option
499 when a compiled pattern is matched.
500 <pre>
501 PCRE_CASELESS
502 </pre>
503 If this bit is set, letters in the pattern match both upper and lower case
504 letters. It is equivalent to Perl's /i option, and it can be changed within a
505 pattern by a (?i) option setting. In UTF-8 mode, PCRE always understands the
506 concept of case for characters whose values are less than 128, so caseless
507 matching is always possible. For characters with higher values, the concept of
508 case is supported if PCRE is compiled with Unicode property support, but not
509 otherwise. If you want to use caseless matching for characters 128 and above,
510 you must ensure that PCRE is compiled with Unicode property support as well as
511 with UTF-8 support.
512 <pre>
513 PCRE_DOLLAR_ENDONLY
514 </pre>
515 If this bit is set, a dollar metacharacter in the pattern matches only at the
516 end of the subject string. Without this option, a dollar also matches
517 immediately before a newline at the end of the string (but not before any other
518 newlines). The PCRE_DOLLAR_ENDONLY option is ignored if PCRE_MULTILINE is set.
519 There is no equivalent to this option in Perl, and no way to set it within a
520 pattern.
521 <pre>
522 PCRE_DOTALL
523 </pre>
524 If this bit is set, a dot metacharater in the pattern matches all characters,
525 including those that indicate newline. Without it, a dot does not match when
526 the current position is at a newline. This option is equivalent to Perl's /s
527 option, and it can be changed within a pattern by a (?s) option setting. A
528 negative class such as [^a] always matches newline characters, independent of
529 the setting of this option.
530 <pre>
531 PCRE_DUPNAMES
532 </pre>
533 If this bit is set, names used to identify capturing subpatterns need not be
534 unique. This can be helpful for certain types of pattern when it is known that
535 only one instance of the named subpattern can ever be matched. There are more
536 details of named subpatterns below; see also the
537 <a href="pcrepattern.html"><b>pcrepattern</b></a>
538 documentation.
539 <pre>
540 PCRE_EXTENDED
541 </pre>
542 If this bit is set, whitespace data characters in the pattern are totally
543 ignored except when escaped or inside a character class. Whitespace does not
544 include the VT character (code 11). In addition, characters between an
545 unescaped # outside a character class and the next newline, inclusive, are also
546 ignored. This is equivalent to Perl's /x option, and it can be changed within a
547 pattern by a (?x) option setting.
548 </P>
549 <P>
550 This option makes it possible to include comments inside complicated patterns.
551 Note, however, that this applies only to data characters. Whitespace characters
552 may never appear within special character sequences in a pattern, for example
553 within the sequence (?( which introduces a conditional subpattern.
554 <pre>
555 PCRE_EXTRA
556 </pre>
557 This option was invented in order to turn on additional functionality of PCRE
558 that is incompatible with Perl, but it is currently of very little use. When
559 set, any backslash in a pattern that is followed by a letter that has no
560 special meaning causes an error, thus reserving these combinations for future
561 expansion. By default, as in Perl, a backslash followed by a letter with no
562 special meaning is treated as a literal. (Perl can, however, be persuaded to
563 give a warning for this.) There are at present no other features controlled by
564 this option. It can also be set by a (?X) option setting within a pattern.
565 <pre>
566 PCRE_FIRSTLINE
567 </pre>
568 If this option is set, an unanchored pattern is required to match before or at
569 the first newline in the subject string, though the matched text may continue
570 over the newline.
571 <pre>
572 PCRE_JAVASCRIPT_COMPAT
573 </pre>
574 If this option is set, PCRE's behaviour is changed in some ways so that it is
575 compatible with JavaScript rather than Perl. The changes are as follows:
576 </P>
577 <P>
578 (1) A lone closing square bracket in a pattern causes a compile-time error,
579 because this is illegal in JavaScript (by default it is treated as a data
580 character). Thus, the pattern AB]CD becomes illegal when this option is set.
581 </P>
582 <P>
583 (2) At run time, a back reference to an unset subpattern group matches an empty
584 string (by default this causes the current matching alternative to fail). A
585 pattern such as (\1)(a) succeeds when this option is set (assuming it can find
586 an "a" in the subject), whereas it fails by default, for Perl compatibility.
587 <pre>
588 PCRE_MULTILINE
589 </pre>
590 By default, PCRE treats the subject string as consisting of a single line of
591 characters (even if it actually contains newlines). The "start of line"
592 metacharacter (^) matches only at the start of the string, while the "end of
593 line" metacharacter ($) matches only at the end of the string, or before a
594 terminating newline (unless PCRE_DOLLAR_ENDONLY is set). This is the same as
595 Perl.
596 </P>
597 <P>
598 When PCRE_MULTILINE it is set, the "start of line" and "end of line" constructs
599 match immediately following or immediately before internal newlines in the
600 subject string, respectively, as well as at the very start and end. This is
601 equivalent to Perl's /m option, and it can be changed within a pattern by a
602 (?m) option setting. If there are no newlines in a subject string, or no
603 occurrences of ^ or $ in a pattern, setting PCRE_MULTILINE has no effect.
604 <pre>
605 PCRE_NEWLINE_CR
606 PCRE_NEWLINE_LF
607 PCRE_NEWLINE_CRLF
608 PCRE_NEWLINE_ANYCRLF
609 PCRE_NEWLINE_ANY
610 </pre>
611 These options override the default newline definition that was chosen when PCRE
612 was built. Setting the first or the second specifies that a newline is
613 indicated by a single character (CR or LF, respectively). Setting
614 PCRE_NEWLINE_CRLF specifies that a newline is indicated by the two-character
615 CRLF sequence. Setting PCRE_NEWLINE_ANYCRLF specifies that any of the three
616 preceding sequences should be recognized. Setting PCRE_NEWLINE_ANY specifies
617 that any Unicode newline sequence should be recognized. The Unicode newline
618 sequences are the three just mentioned, plus the single characters VT (vertical
619 tab, U+000B), FF (formfeed, U+000C), NEL (next line, U+0085), LS (line
620 separator, U+2028), and PS (paragraph separator, U+2029). The last two are
621 recognized only in UTF-8 mode.
622 </P>
623 <P>
624 The newline setting in the options word uses three bits that are treated
625 as a number, giving eight possibilities. Currently only six are used (default
626 plus the five values above). This means that if you set more than one newline
627 option, the combination may or may not be sensible. For example,
628 PCRE_NEWLINE_CR with PCRE_NEWLINE_LF is equivalent to PCRE_NEWLINE_CRLF, but
629 other combinations may yield unused numbers and cause an error.
630 </P>
631 <P>
632 The only time that a line break is specially recognized when compiling a
633 pattern is if PCRE_EXTENDED is set, and an unescaped # outside a character
634 class is encountered. This indicates a comment that lasts until after the next
635 line break sequence. In other circumstances, line break sequences are treated
636 as literal data, except that in PCRE_EXTENDED mode, both CR and LF are treated
637 as whitespace characters and are therefore ignored.
638 </P>
639 <P>
640 The newline option that is set at compile time becomes the default that is used
641 for <b>pcre_exec()</b> and <b>pcre_dfa_exec()</b>, but it can be overridden.
642 <pre>
643 PCRE_NO_AUTO_CAPTURE
644 </pre>
645 If this option is set, it disables the use of numbered capturing parentheses in
646 the pattern. Any opening parenthesis that is not followed by ? behaves as if it
647 were followed by ?: but named parentheses can still be used for capturing (and
648 they acquire numbers in the usual way). There is no equivalent of this option
649 in Perl.
650 <pre>
651 PCRE_UNGREEDY
652 </pre>
653 This option inverts the "greediness" of the quantifiers so that they are not
654 greedy by default, but become greedy if followed by "?". It is not compatible
655 with Perl. It can also be set by a (?U) option setting within the pattern.
656 <pre>
657 PCRE_UTF8
658 </pre>
659 This option causes PCRE to regard both the pattern and the subject as strings
660 of UTF-8 characters instead of single-byte character strings. However, it is
661 available only when PCRE is built to include UTF-8 support. If not, the use
662 of this option provokes an error. Details of how this option changes the
663 behaviour of PCRE are given in the
664 <a href="pcre.html#utf8support">section on UTF-8 support</a>
665 in the main
666 <a href="pcre.html"><b>pcre</b></a>
667 page.
668 <pre>
669 PCRE_NO_UTF8_CHECK
670 </pre>
671 When PCRE_UTF8 is set, the validity of the pattern as a UTF-8 string is
672 automatically checked. There is a discussion about the
673 <a href="pcre.html#utf8strings">validity of UTF-8 strings</a>
674 in the main
675 <a href="pcre.html"><b>pcre</b></a>
676 page. If an invalid UTF-8 sequence of bytes is found, <b>pcre_compile()</b>
677 returns an error. If you already know that your pattern is valid, and you want
678 to skip this check for performance reasons, you can set the PCRE_NO_UTF8_CHECK
679 option. When it is set, the effect of passing an invalid UTF-8 string as a
680 pattern is undefined. It may cause your program to crash. Note that this option
681 can also be passed to <b>pcre_exec()</b> and <b>pcre_dfa_exec()</b>, to suppress
682 the UTF-8 validity checking of subject strings.
683 </P>
684 <br><a name="SEC8" href="#TOC1">COMPILATION ERROR CODES</a><br>
685 <P>
686 The following table lists the error codes than may be returned by
687 <b>pcre_compile2()</b>, along with the error messages that may be returned by
688 both compiling functions. As PCRE has developed, some error codes have fallen
689 out of use. To avoid confusion, they have not been re-used.
690 <pre>
691 0 no error
692 1 \ at end of pattern
693 2 \c at end of pattern
694 3 unrecognized character follows \
695 4 numbers out of order in {} quantifier
696 5 number too big in {} quantifier
697 6 missing terminating ] for character class
698 7 invalid escape sequence in character class
699 8 range out of order in character class
700 9 nothing to repeat
701 10 [this code is not in use]
702 11 internal error: unexpected repeat
703 12 unrecognized character after (? or (?-
704 13 POSIX named classes are supported only within a class
705 14 missing )
706 15 reference to non-existent subpattern
707 16 erroffset passed as NULL
708 17 unknown option bit(s) set
709 18 missing ) after comment
710 19 [this code is not in use]
711 20 regular expression is too large
712 21 failed to get memory
713 22 unmatched parentheses
714 23 internal error: code overflow
715 24 unrecognized character after (?&#60;
716 25 lookbehind assertion is not fixed length
717 26 malformed number or name after (?(
718 27 conditional group contains more than two branches
719 28 assertion expected after (?(
720 29 (?R or (?[+-]digits must be followed by )
721 30 unknown POSIX class name
722 31 POSIX collating elements are not supported
723 32 this version of PCRE is not compiled with PCRE_UTF8 support
724 33 [this code is not in use]
725 34 character value in \x{...} sequence is too large
726 35 invalid condition (?(0)
727 36 \C not allowed in lookbehind assertion
728 37 PCRE does not support \L, \l, \N, \U, or \u
729 38 number after (?C is &#62; 255
730 39 closing ) for (?C expected
731 40 recursive call could loop indefinitely
732 41 unrecognized character after (?P
733 42 syntax error in subpattern name (missing terminator)
734 43 two named subpatterns have the same name
735 44 invalid UTF-8 string
736 45 support for \P, \p, and \X has not been compiled
737 46 malformed \P or \p sequence
738 47 unknown property name after \P or \p
739 48 subpattern name is too long (maximum 32 characters)
740 49 too many named subpatterns (maximum 10000)
741 50 [this code is not in use]
742 51 octal value is greater than \377 (not in UTF-8 mode)
743 52 internal error: overran compiling workspace
744 53 internal error: previously-checked referenced subpattern not found
745 54 DEFINE group contains more than one branch
746 55 repeating a DEFINE group is not allowed
747 56 inconsistent NEWLINE options
748 57 \g is not followed by a braced, angle-bracketed, or quoted
749 name/number or by a plain number
750 58 a numbered reference must not be zero
751 59 an argument is not allowed for (*ACCEPT), (*FAIL), or (*COMMIT)
752 60 (*VERB) not recognized
753 61 number is too big
754 62 subpattern name expected
755 63 digit expected after (?+
756 64 ] is an invalid data character in JavaScript compatibility mode
757 65 different names for subpatterns of the same number are not allowed
758 66 (*MARK) must have an argument
759 </pre>
760 The numbers 32 and 10000 in errors 48 and 49 are defaults; different values may
761 be used if the limits were changed when PCRE was built.
762 </P>
763 <br><a name="SEC9" href="#TOC1">STUDYING A PATTERN</a><br>
764 <P>
765 <b>pcre_extra *pcre_study(const pcre *<i>code</i>, int <i>options</i></b>
766 <b>const char **<i>errptr</i>);</b>
767 </P>
768 <P>
769 If a compiled pattern is going to be used several times, it is worth spending
770 more time analyzing it in order to speed up the time taken for matching. The
771 function <b>pcre_study()</b> takes a pointer to a compiled pattern as its first
772 argument. If studying the pattern produces additional information that will
773 help speed up matching, <b>pcre_study()</b> returns a pointer to a
774 <b>pcre_extra</b> block, in which the <i>study_data</i> field points to the
775 results of the study.
776 </P>
777 <P>
778 The returned value from <b>pcre_study()</b> can be passed directly to
779 <b>pcre_exec()</b> or <b>pcre_dfa_exec()</b>. However, a <b>pcre_extra</b> block
780 also contains other fields that can be set by the caller before the block is
781 passed; these are described
782 <a href="#extradata">below</a>
783 in the section on matching a pattern.
784 </P>
785 <P>
786 If studying the pattern does not produce any useful information,
787 <b>pcre_study()</b> returns NULL. In that circumstance, if the calling program
788 wants to pass any of the other fields to <b>pcre_exec()</b> or
789 <b>pcre_dfa_exec()</b>, it must set up its own <b>pcre_extra</b> block.
790 </P>
791 <P>
792 The second argument of <b>pcre_study()</b> contains option bits. At present, no
793 options are defined, and this argument should always be zero.
794 </P>
795 <P>
796 The third argument for <b>pcre_study()</b> is a pointer for an error message. If
797 studying succeeds (even if no data is returned), the variable it points to is
798 set to NULL. Otherwise it is set to point to a textual error message. This is a
799 static string that is part of the library. You must not try to free it. You
800 should test the error pointer for NULL after calling <b>pcre_study()</b>, to be
801 sure that it has run successfully.
802 </P>
803 <P>
804 This is a typical call to <b>pcre_study</b>():
805 <pre>
806 pcre_extra *pe;
807 pe = pcre_study(
808 re, /* result of pcre_compile() */
809 0, /* no options exist */
810 &error); /* set to NULL or points to a message */
811 </pre>
812 Studying a pattern does two things: first, a lower bound for the length of
813 subject string that is needed to match the pattern is computed. This does not
814 mean that there are any strings of that length that match, but it does
815 guarantee that no shorter strings match. The value is used by
816 <b>pcre_exec()</b> and <b>pcre_dfa_exec()</b> to avoid wasting time by trying to
817 match strings that are shorter than the lower bound. You can find out the value
818 in a calling program via the <b>pcre_fullinfo()</b> function.
819 </P>
820 <P>
821 Studying a pattern is also useful for non-anchored patterns that do not have a
822 single fixed starting character. A bitmap of possible starting bytes is
823 created. This speeds up finding a position in the subject at which to start
824 matching.
825 <a name="localesupport"></a></P>
826 <br><a name="SEC10" href="#TOC1">LOCALE SUPPORT</a><br>
827 <P>
828 PCRE handles caseless matching, and determines whether characters are letters,
829 digits, or whatever, by reference to a set of tables, indexed by character
830 value. When running in UTF-8 mode, this applies only to characters with codes
831 less than 128. Higher-valued codes never match escapes such as \w or \d, but
832 can be tested with \p if PCRE is built with Unicode character property
833 support. The use of locales with Unicode is discouraged. If you are handling
834 characters with codes greater than 128, you should either use UTF-8 and
835 Unicode, or use locales, but not try to mix the two.
836 </P>
837 <P>
838 PCRE contains an internal set of tables that are used when the final argument
839 of <b>pcre_compile()</b> is NULL. These are sufficient for many applications.
840 Normally, the internal tables recognize only ASCII characters. However, when
841 PCRE is built, it is possible to cause the internal tables to be rebuilt in the
842 default "C" locale of the local system, which may cause them to be different.
843 </P>
844 <P>
845 The internal tables can always be overridden by tables supplied by the
846 application that calls PCRE. These may be created in a different locale from
847 the default. As more and more applications change to using Unicode, the need
848 for this locale support is expected to die away.
849 </P>
850 <P>
851 External tables are built by calling the <b>pcre_maketables()</b> function,
852 which has no arguments, in the relevant locale. The result can then be passed
853 to <b>pcre_compile()</b> or <b>pcre_exec()</b> as often as necessary. For
854 example, to build and use tables that are appropriate for the French locale
855 (where accented characters with values greater than 128 are treated as letters),
856 the following code could be used:
857 <pre>
858 setlocale(LC_CTYPE, "fr_FR");
859 tables = pcre_maketables();
860 re = pcre_compile(..., tables);
861 </pre>
862 The locale name "fr_FR" is used on Linux and other Unix-like systems; if you
863 are using Windows, the name for the French locale is "french".
864 </P>
865 <P>
866 When <b>pcre_maketables()</b> runs, the tables are built in memory that is
867 obtained via <b>pcre_malloc</b>. It is the caller's responsibility to ensure
868 that the memory containing the tables remains available for as long as it is
869 needed.
870 </P>
871 <P>
872 The pointer that is passed to <b>pcre_compile()</b> is saved with the compiled
873 pattern, and the same tables are used via this pointer by <b>pcre_study()</b>
874 and normally also by <b>pcre_exec()</b>. Thus, by default, for any single
875 pattern, compilation, studying and matching all happen in the same locale, but
876 different patterns can be compiled in different locales.
877 </P>
878 <P>
879 It is possible to pass a table pointer or NULL (indicating the use of the
880 internal tables) to <b>pcre_exec()</b>. Although not intended for this purpose,
881 this facility could be used to match a pattern in a different locale from the
882 one in which it was compiled. Passing table pointers at run time is discussed
883 below in the section on matching a pattern.
884 </P>
885 <br><a name="SEC11" href="#TOC1">INFORMATION ABOUT A PATTERN</a><br>
886 <P>
887 <b>int pcre_fullinfo(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b>
888 <b>int <i>what</i>, void *<i>where</i>);</b>
889 </P>
890 <P>
891 The <b>pcre_fullinfo()</b> function returns information about a compiled
892 pattern. It replaces the obsolete <b>pcre_info()</b> function, which is
893 nevertheless retained for backwards compability (and is documented below).
894 </P>
895 <P>
896 The first argument for <b>pcre_fullinfo()</b> is a pointer to the compiled
897 pattern. The second argument is the result of <b>pcre_study()</b>, or NULL if
898 the pattern was not studied. The third argument specifies which piece of
899 information is required, and the fourth argument is a pointer to a variable
900 to receive the data. The yield of the function is zero for success, or one of
901 the following negative numbers:
902 <pre>
903 PCRE_ERROR_NULL the argument <i>code</i> was NULL
904 the argument <i>where</i> was NULL
905 PCRE_ERROR_BADMAGIC the "magic number" was not found
906 PCRE_ERROR_BADOPTION the value of <i>what</i> was invalid
907 </pre>
908 The "magic number" is placed at the start of each compiled pattern as an simple
909 check against passing an arbitrary memory pointer. Here is a typical call of
910 <b>pcre_fullinfo()</b>, to obtain the length of the compiled pattern:
911 <pre>
912 int rc;
913 size_t length;
914 rc = pcre_fullinfo(
915 re, /* result of pcre_compile() */
916 pe, /* result of pcre_study(), or NULL */
917 PCRE_INFO_SIZE, /* what is required */
918 &length); /* where to put the data */
919 </pre>
920 The possible values for the third argument are defined in <b>pcre.h</b>, and are
921 as follows:
922 <pre>
923 PCRE_INFO_BACKREFMAX
924 </pre>
925 Return the number of the highest back reference in the pattern. The fourth
926 argument should point to an <b>int</b> variable. Zero is returned if there are
927 no back references.
928 <pre>
929 PCRE_INFO_CAPTURECOUNT
930 </pre>
931 Return the number of capturing subpatterns in the pattern. The fourth argument
932 should point to an <b>int</b> variable.
933 <pre>
934 PCRE_INFO_DEFAULT_TABLES
935 </pre>
936 Return a pointer to the internal default character tables within PCRE. The
937 fourth argument should point to an <b>unsigned char *</b> variable. This
938 information call is provided for internal use by the <b>pcre_study()</b>
939 function. External callers can cause PCRE to use its internal tables by passing
940 a NULL table pointer.
941 <pre>
942 PCRE_INFO_FIRSTBYTE
943 </pre>
944 Return information about the first byte of any matched string, for a
945 non-anchored pattern. The fourth argument should point to an <b>int</b>
946 variable. (This option used to be called PCRE_INFO_FIRSTCHAR; the old name is
947 still recognized for backwards compatibility.)
948 </P>
949 <P>
950 If there is a fixed first byte, for example, from a pattern such as
951 (cat|cow|coyote), its value is returned. Otherwise, if either
952 <br>
953 <br>
954 (a) the pattern was compiled with the PCRE_MULTILINE option, and every branch
955 starts with "^", or
956 <br>
957 <br>
958 (b) every branch of the pattern starts with ".*" and PCRE_DOTALL is not set
959 (if it were set, the pattern would be anchored),
960 <br>
961 <br>
962 -1 is returned, indicating that the pattern matches only at the start of a
963 subject string or after any newline within the string. Otherwise -2 is
964 returned. For anchored patterns, -2 is returned.
965 <pre>
966 PCRE_INFO_FIRSTTABLE
967 </pre>
968 If the pattern was studied, and this resulted in the construction of a 256-bit
969 table indicating a fixed set of bytes for the first byte in any matching
970 string, a pointer to the table is returned. Otherwise NULL is returned. The
971 fourth argument should point to an <b>unsigned char *</b> variable.
972 <pre>
973 PCRE_INFO_HASCRORLF
974 </pre>
975 Return 1 if the pattern contains any explicit matches for CR or LF characters,
976 otherwise 0. The fourth argument should point to an <b>int</b> variable. An
977 explicit match is either a literal CR or LF character, or \r or \n.
978 <pre>
979 PCRE_INFO_JCHANGED
980 </pre>
981 Return 1 if the (?J) or (?-J) option setting is used in the pattern, otherwise
982 0. The fourth argument should point to an <b>int</b> variable. (?J) and
983 (?-J) set and unset the local PCRE_DUPNAMES option, respectively.
984 <pre>
985 PCRE_INFO_LASTLITERAL
986 </pre>
987 Return the value of the rightmost literal byte that must exist in any matched
988 string, other than at its start, if such a byte has been recorded. The fourth
989 argument should point to an <b>int</b> variable. If there is no such byte, -1 is
990 returned. For anchored patterns, a last literal byte is recorded only if it
991 follows something of variable length. For example, for the pattern
992 /^a\d+z\d+/ the returned value is "z", but for /^a\dz\d/ the returned value
993 is -1.
994 <pre>
995 PCRE_INFO_MINLENGTH
996 </pre>
997 If the pattern was studied and a minimum length for matching subject strings
998 was computed, its value is returned. Otherwise the returned value is -1. The
999 value is a number of characters, not bytes (this may be relevant in UTF-8
1000 mode). The fourth argument should point to an <b>int</b> variable. A
1001 non-negative value is a lower bound to the length of any matching string. There
1002 may not be any strings of that length that do actually match, but every string
1003 that does match is at least that long.
1004 <pre>
1005 PCRE_INFO_NAMECOUNT
1006 PCRE_INFO_NAMEENTRYSIZE
1007 PCRE_INFO_NAMETABLE
1008 </pre>
1009 PCRE supports the use of named as well as numbered capturing parentheses. The
1010 names are just an additional way of identifying the parentheses, which still
1011 acquire numbers. Several convenience functions such as
1012 <b>pcre_get_named_substring()</b> are provided for extracting captured
1013 substrings by name. It is also possible to extract the data directly, by first
1014 converting the name to a number in order to access the correct pointers in the
1015 output vector (described with <b>pcre_exec()</b> below). To do the conversion,
1016 you need to use the name-to-number map, which is described by these three
1017 values.
1018 </P>
1019 <P>
1020 The map consists of a number of fixed-size entries. PCRE_INFO_NAMECOUNT gives
1021 the number of entries, and PCRE_INFO_NAMEENTRYSIZE gives the size of each
1022 entry; both of these return an <b>int</b> value. The entry size depends on the
1023 length of the longest name. PCRE_INFO_NAMETABLE returns a pointer to the first
1024 entry of the table (a pointer to <b>char</b>). The first two bytes of each entry
1025 are the number of the capturing parenthesis, most significant byte first. The
1026 rest of the entry is the corresponding name, zero terminated.
1027 </P>
1028 <P>
1029 The names are in alphabetical order. Duplicate names may appear if (?| is used
1030 to create multiple groups with the same number, as described in the
1031 <a href="pcrepattern.html#dupsubpatternnumber">section on duplicate subpattern numbers</a>
1032 in the
1033 <a href="pcrepattern.html"><b>pcrepattern</b></a>
1034 page. Duplicate names for subpatterns with different numbers are permitted only
1035 if PCRE_DUPNAMES is set. In all cases of duplicate names, they appear in the
1036 table in the order in which they were found in the pattern. In the absence of
1037 (?| this is the order of increasing number; when (?| is used this is not
1038 necessarily the case because later subpatterns may have lower numbers.
1039 </P>
1040 <P>
1041 As a simple example of the name/number table, consider the following pattern
1042 (assume PCRE_EXTENDED is set, so white space - including newlines - is
1043 ignored):
1044 <pre>
1045 (?&#60;date&#62; (?&#60;year&#62;(\d\d)?\d\d) - (?&#60;month&#62;\d\d) - (?&#60;day&#62;\d\d) )
1046 </pre>
1047 There are four named subpatterns, so the table has four entries, and each entry
1048 in the table is eight bytes long. The table is as follows, with non-printing
1049 bytes shows in hexadecimal, and undefined bytes shown as ??:
1050 <pre>
1051 00 01 d a t e 00 ??
1052 00 05 d a y 00 ?? ??
1053 00 04 m o n t h 00
1054 00 02 y e a r 00 ??
1055 </pre>
1056 When writing code to extract data from named subpatterns using the
1057 name-to-number map, remember that the length of the entries is likely to be
1058 different for each compiled pattern.
1059 <pre>
1060 PCRE_INFO_OKPARTIAL
1061 </pre>
1062 Return 1 if the pattern can be used for partial matching with
1063 <b>pcre_exec()</b>, otherwise 0. The fourth argument should point to an
1064 <b>int</b> variable. From release 8.00, this always returns 1, because the
1065 restrictions that previously applied to partial matching have been lifted. The
1066 <a href="pcrepartial.html"><b>pcrepartial</b></a>
1067 documentation gives details of partial matching.
1068 <pre>
1069 PCRE_INFO_OPTIONS
1070 </pre>
1071 Return a copy of the options with which the pattern was compiled. The fourth
1072 argument should point to an <b>unsigned long int</b> variable. These option bits
1073 are those specified in the call to <b>pcre_compile()</b>, modified by any
1074 top-level option settings at the start of the pattern itself. In other words,
1075 they are the options that will be in force when matching starts. For example,
1076 if the pattern /(?im)abc(?-i)d/ is compiled with the PCRE_EXTENDED option, the
1077 result is PCRE_CASELESS, PCRE_MULTILINE, and PCRE_EXTENDED.
1078 </P>
1079 <P>
1080 A pattern is automatically anchored by PCRE if all of its top-level
1081 alternatives begin with one of the following:
1082 <pre>
1083 ^ unless PCRE_MULTILINE is set
1084 \A always
1085 \G always
1086 .* if PCRE_DOTALL is set and there are no back references to the subpattern in which .* appears
1087 </pre>
1088 For such patterns, the PCRE_ANCHORED bit is set in the options returned by
1089 <b>pcre_fullinfo()</b>.
1090 <pre>
1091 PCRE_INFO_SIZE
1092 </pre>
1093 Return the size of the compiled pattern, that is, the value that was passed as
1094 the argument to <b>pcre_malloc()</b> when PCRE was getting memory in which to
1095 place the compiled data. The fourth argument should point to a <b>size_t</b>
1096 variable.
1097 <pre>
1098 PCRE_INFO_STUDYSIZE
1099 </pre>
1100 Return the size of the data block pointed to by the <i>study_data</i> field in
1101 a <b>pcre_extra</b> block. That is, it is the value that was passed to
1102 <b>pcre_malloc()</b> when PCRE was getting memory into which to place the data
1103 created by <b>pcre_study()</b>. If <b>pcre_extra</b> is NULL, or there is no
1104 study data, zero is returned. The fourth argument should point to a
1105 <b>size_t</b> variable.
1106 </P>
1107 <br><a name="SEC12" href="#TOC1">OBSOLETE INFO FUNCTION</a><br>
1108 <P>
1109 <b>int pcre_info(const pcre *<i>code</i>, int *<i>optptr</i>, int</b>
1110 <b>*<i>firstcharptr</i>);</b>
1111 </P>
1112 <P>
1113 The <b>pcre_info()</b> function is now obsolete because its interface is too
1114 restrictive to return all the available data about a compiled pattern. New
1115 programs should use <b>pcre_fullinfo()</b> instead. The yield of
1116 <b>pcre_info()</b> is the number of capturing subpatterns, or one of the
1117 following negative numbers:
1118 <pre>
1119 PCRE_ERROR_NULL the argument <i>code</i> was NULL
1120 PCRE_ERROR_BADMAGIC the "magic number" was not found
1121 </pre>
1122 If the <i>optptr</i> argument is not NULL, a copy of the options with which the
1123 pattern was compiled is placed in the integer it points to (see
1124 PCRE_INFO_OPTIONS above).
1125 </P>
1126 <P>
1127 If the pattern is not anchored and the <i>firstcharptr</i> argument is not NULL,
1128 it is used to pass back information about the first character of any matched
1129 string (see PCRE_INFO_FIRSTBYTE above).
1130 </P>
1131 <br><a name="SEC13" href="#TOC1">REFERENCE COUNTS</a><br>
1132 <P>
1133 <b>int pcre_refcount(pcre *<i>code</i>, int <i>adjust</i>);</b>
1134 </P>
1135 <P>
1136 The <b>pcre_refcount()</b> function is used to maintain a reference count in the
1137 data block that contains a compiled pattern. It is provided for the benefit of
1138 applications that operate in an object-oriented manner, where different parts
1139 of the application may be using the same compiled pattern, but you want to free
1140 the block when they are all done.
1141 </P>
1142 <P>
1143 When a pattern is compiled, the reference count field is initialized to zero.
1144 It is changed only by calling this function, whose action is to add the
1145 <i>adjust</i> value (which may be positive or negative) to it. The yield of the
1146 function is the new value. However, the value of the count is constrained to
1147 lie between 0 and 65535, inclusive. If the new value is outside these limits,
1148 it is forced to the appropriate limit value.
1149 </P>
1150 <P>
1151 Except when it is zero, the reference count is not correctly preserved if a
1152 pattern is compiled on one host and then transferred to a host whose byte-order
1153 is different. (This seems a highly unlikely scenario.)
1154 </P>
1155 <br><a name="SEC14" href="#TOC1">MATCHING A PATTERN: THE TRADITIONAL FUNCTION</a><br>
1156 <P>
1157 <b>int pcre_exec(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b>
1158 <b>const char *<i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b>
1159 <b>int <i>options</i>, int *<i>ovector</i>, int <i>ovecsize</i>);</b>
1160 </P>
1161 <P>
1162 The function <b>pcre_exec()</b> is called to match a subject string against a
1163 compiled pattern, which is passed in the <i>code</i> argument. If the
1164 pattern was studied, the result of the study should be passed in the
1165 <i>extra</i> argument. This function is the main matching facility of the
1166 library, and it operates in a Perl-like manner. For specialist use there is
1167 also an alternative matching function, which is described
1168 <a href="#dfamatch">below</a>
1169 in the section about the <b>pcre_dfa_exec()</b> function.
1170 </P>
1171 <P>
1172 In most applications, the pattern will have been compiled (and optionally
1173 studied) in the same process that calls <b>pcre_exec()</b>. However, it is
1174 possible to save compiled patterns and study data, and then use them later
1175 in different processes, possibly even on different hosts. For a discussion
1176 about this, see the
1177 <a href="pcreprecompile.html"><b>pcreprecompile</b></a>
1178 documentation.
1179 </P>
1180 <P>
1181 Here is an example of a simple call to <b>pcre_exec()</b>:
1182 <pre>
1183 int rc;
1184 int ovector[30];
1185 rc = pcre_exec(
1186 re, /* result of pcre_compile() */
1187 NULL, /* we didn't study the pattern */
1188 "some string", /* the subject string */
1189 11, /* the length of the subject string */
1190 0, /* start at offset 0 in the subject */
1191 0, /* default options */
1192 ovector, /* vector of integers for substring information */
1193 30); /* number of elements (NOT size in bytes) */
1194 <a name="extradata"></a></PRE>
1195 </P>
1196 <br><b>
1197 Extra data for <b>pcre_exec()</b>
1198 </b><br>
1199 <P>
1200 If the <i>extra</i> argument is not NULL, it must point to a <b>pcre_extra</b>
1201 data block. The <b>pcre_study()</b> function returns such a block (when it
1202 doesn't return NULL), but you can also create one for yourself, and pass
1203 additional information in it. The <b>pcre_extra</b> block contains the following
1204 fields (not necessarily in this order):
1205 <pre>
1206 unsigned long int <i>flags</i>;
1207 void *<i>study_data</i>;
1208 unsigned long int <i>match_limit</i>;
1209 unsigned long int <i>match_limit_recursion</i>;
1210 void *<i>callout_data</i>;
1211 const unsigned char *<i>tables</i>;
1212 unsigned char **<i>mark</i>;
1213 </pre>
1214 The <i>flags</i> field is a bitmap that specifies which of the other fields
1215 are set. The flag bits are:
1216 <pre>
1217 PCRE_EXTRA_STUDY_DATA
1218 PCRE_EXTRA_MATCH_LIMIT
1219 PCRE_EXTRA_MATCH_LIMIT_RECURSION
1220 PCRE_EXTRA_CALLOUT_DATA
1221 PCRE_EXTRA_TABLES
1222 PCRE_EXTRA_MARK
1223 </pre>
1224 Other flag bits should be set to zero. The <i>study_data</i> field is set in the
1225 <b>pcre_extra</b> block that is returned by <b>pcre_study()</b>, together with
1226 the appropriate flag bit. You should not set this yourself, but you may add to
1227 the block by setting the other fields and their corresponding flag bits.
1228 </P>
1229 <P>
1230 The <i>match_limit</i> field provides a means of preventing PCRE from using up a
1231 vast amount of resources when running patterns that are not going to match,
1232 but which have a very large number of possibilities in their search trees. The
1233 classic example is a pattern that uses nested unlimited repeats.
1234 </P>
1235 <P>
1236 Internally, PCRE uses a function called <b>match()</b> which it calls repeatedly
1237 (sometimes recursively). The limit set by <i>match_limit</i> is imposed on the
1238 number of times this function is called during a match, which has the effect of
1239 limiting the amount of backtracking that can take place. For patterns that are
1240 not anchored, the count restarts from zero for each position in the subject
1241 string.
1242 </P>
1243 <P>
1244 The default value for the limit can be set when PCRE is built; the default
1245 default is 10 million, which handles all but the most extreme cases. You can
1246 override the default by suppling <b>pcre_exec()</b> with a <b>pcre_extra</b>
1247 block in which <i>match_limit</i> is set, and PCRE_EXTRA_MATCH_LIMIT is set in
1248 the <i>flags</i> field. If the limit is exceeded, <b>pcre_exec()</b> returns
1249 PCRE_ERROR_MATCHLIMIT.
1250 </P>
1251 <P>
1252 The <i>match_limit_recursion</i> field is similar to <i>match_limit</i>, but
1253 instead of limiting the total number of times that <b>match()</b> is called, it
1254 limits the depth of recursion. The recursion depth is a smaller number than the
1255 total number of calls, because not all calls to <b>match()</b> are recursive.
1256 This limit is of use only if it is set smaller than <i>match_limit</i>.
1257 </P>
1258 <P>
1259 Limiting the recursion depth limits the amount of stack that can be used, or,
1260 when PCRE has been compiled to use memory on the heap instead of the stack, the
1261 amount of heap memory that can be used.
1262 </P>
1263 <P>
1264 The default value for <i>match_limit_recursion</i> can be set when PCRE is
1265 built; the default default is the same value as the default for
1266 <i>match_limit</i>. You can override the default by suppling <b>pcre_exec()</b>
1267 with a <b>pcre_extra</b> block in which <i>match_limit_recursion</i> is set, and
1268 PCRE_EXTRA_MATCH_LIMIT_RECURSION is set in the <i>flags</i> field. If the limit
1269 is exceeded, <b>pcre_exec()</b> returns PCRE_ERROR_RECURSIONLIMIT.
1270 </P>
1271 <P>
1272 The <i>callout_data</i> field is used in conjunction with the "callout" feature,
1273 and is described in the
1274 <a href="pcrecallout.html"><b>pcrecallout</b></a>
1275 documentation.
1276 </P>
1277 <P>
1278 The <i>tables</i> field is used to pass a character tables pointer to
1279 <b>pcre_exec()</b>; this overrides the value that is stored with the compiled
1280 pattern. A non-NULL value is stored with the compiled pattern only if custom
1281 tables were supplied to <b>pcre_compile()</b> via its <i>tableptr</i> argument.
1282 If NULL is passed to <b>pcre_exec()</b> using this mechanism, it forces PCRE's
1283 internal tables to be used. This facility is helpful when re-using patterns
1284 that have been saved after compiling with an external set of tables, because
1285 the external tables might be at a different address when <b>pcre_exec()</b> is
1286 called. See the
1287 <a href="pcreprecompile.html"><b>pcreprecompile</b></a>
1288 documentation for a discussion of saving compiled patterns for later use.
1289 </P>
1290 <P>
1291 If PCRE_EXTRA_MARK is set in the <i>flags</i> field, the <i>mark</i> field must
1292 be set to point to a <b>char *</b> variable. If the pattern contains any
1293 backtracking control verbs such as (*MARK:NAME), and the execution ends up with
1294 a name to pass back, a pointer to the name string (zero terminated) is placed
1295 in the variable pointed to by the <i>mark</i> field. The names are within the
1296 compiled pattern; if you wish to retain such a name you must copy it before
1297 freeing the memory of a compiled pattern. If there is no name to pass back, the
1298 variable pointed to by the <i>mark</i> field set to NULL. For details of the
1299 backtracking control verbs, see the section entitled
1300 <a href="pcrepattern#backtrackcontrol">"Backtracking control"</a>
1301 in the
1302 <a href="pcrepattern.html"><b>pcrepattern</b></a>
1303 documentation.
1304 <a name="execoptions"></a></P>
1305 <br><b>
1306 Option bits for <b>pcre_exec()</b>
1307 </b><br>
1308 <P>
1309 The unused bits of the <i>options</i> argument for <b>pcre_exec()</b> must be
1310 zero. The only bits that may be set are PCRE_ANCHORED, PCRE_NEWLINE_<i>xxx</i>,
1311 PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NOTEMPTY_ATSTART,
1312 PCRE_NO_START_OPTIMIZE, PCRE_NO_UTF8_CHECK, PCRE_PARTIAL_SOFT, and
1313 PCRE_PARTIAL_HARD.
1314 <pre>
1315 PCRE_ANCHORED
1316 </pre>
1317 The PCRE_ANCHORED option limits <b>pcre_exec()</b> to matching at the first
1318 matching position. If a pattern was compiled with PCRE_ANCHORED, or turned out
1319 to be anchored by virtue of its contents, it cannot be made unachored at
1320 matching time.
1321 <pre>
1322 PCRE_BSR_ANYCRLF
1323 PCRE_BSR_UNICODE
1324 </pre>
1325 These options (which are mutually exclusive) control what the \R escape
1326 sequence matches. The choice is either to match only CR, LF, or CRLF, or to
1327 match any Unicode newline sequence. These options override the choice that was
1328 made or defaulted when the pattern was compiled.
1329 <pre>
1330 PCRE_NEWLINE_CR
1331 PCRE_NEWLINE_LF
1332 PCRE_NEWLINE_CRLF
1333 PCRE_NEWLINE_ANYCRLF
1334 PCRE_NEWLINE_ANY
1335 </pre>
1336 These options override the newline definition that was chosen or defaulted when
1337 the pattern was compiled. For details, see the description of
1338 <b>pcre_compile()</b> above. During matching, the newline choice affects the
1339 behaviour of the dot, circumflex, and dollar metacharacters. It may also alter
1340 the way the match position is advanced after a match failure for an unanchored
1341 pattern.
1342 </P>
1343 <P>
1344 When PCRE_NEWLINE_CRLF, PCRE_NEWLINE_ANYCRLF, or PCRE_NEWLINE_ANY is set, and a
1345 match attempt for an unanchored pattern fails when the current position is at a
1346 CRLF sequence, and the pattern contains no explicit matches for CR or LF
1347 characters, the match position is advanced by two characters instead of one, in
1348 other words, to after the CRLF.
1349 </P>
1350 <P>
1351 The above rule is a compromise that makes the most common cases work as
1352 expected. For example, if the pattern is .+A (and the PCRE_DOTALL option is not
1353 set), it does not match the string "\r\nA" because, after failing at the
1354 start, it skips both the CR and the LF before retrying. However, the pattern
1355 [\r\n]A does match that string, because it contains an explicit CR or LF
1356 reference, and so advances only by one character after the first failure.
1357 </P>
1358 <P>
1359 An explicit match for CR of LF is either a literal appearance of one of those
1360 characters, or one of the \r or \n escape sequences. Implicit matches such as
1361 [^X] do not count, nor does \s (which includes CR and LF in the characters
1362 that it matches).
1363 </P>
1364 <P>
1365 Notwithstanding the above, anomalous effects may still occur when CRLF is a
1366 valid newline sequence and explicit \r or \n escapes appear in the pattern.
1367 <pre>
1368 PCRE_NOTBOL
1369 </pre>
1370 This option specifies that first character of the subject string is not the
1371 beginning of a line, so the circumflex metacharacter should not match before
1372 it. Setting this without PCRE_MULTILINE (at compile time) causes circumflex
1373 never to match. This option affects only the behaviour of the circumflex
1374 metacharacter. It does not affect \A.
1375 <pre>
1376 PCRE_NOTEOL
1377 </pre>
1378 This option specifies that the end of the subject string is not the end of a
1379 line, so the dollar metacharacter should not match it nor (except in multiline
1380 mode) a newline immediately before it. Setting this without PCRE_MULTILINE (at
1381 compile time) causes dollar never to match. This option affects only the
1382 behaviour of the dollar metacharacter. It does not affect \Z or \z.
1383 <pre>
1384 PCRE_NOTEMPTY
1385 </pre>
1386 An empty string is not considered to be a valid match if this option is set. If
1387 there are alternatives in the pattern, they are tried. If all the alternatives
1388 match the empty string, the entire match fails. For example, if the pattern
1389 <pre>
1390 a?b?
1391 </pre>
1392 is applied to a string not beginning with "a" or "b", it matches an empty
1393 string at the start of the subject. With PCRE_NOTEMPTY set, this match is not
1394 valid, so PCRE searches further into the string for occurrences of "a" or "b".
1395 <pre>
1396 PCRE_NOTEMPTY_ATSTART
1397 </pre>
1398 This is like PCRE_NOTEMPTY, except that an empty string match that is not at
1399 the start of the subject is permitted. If the pattern is anchored, such a match
1400 can occur only if the pattern contains \K.
1401 </P>
1402 <P>
1403 Perl has no direct equivalent of PCRE_NOTEMPTY or PCRE_NOTEMPTY_ATSTART, but it
1404 does make a special case of a pattern match of the empty string within its
1405 <b>split()</b> function, and when using the /g modifier. It is possible to
1406 emulate Perl's behaviour after matching a null string by first trying the match
1407 again at the same offset with PCRE_NOTEMPTY_ATSTART and PCRE_ANCHORED, and then
1408 if that fails, by advancing the starting offset (see below) and trying an
1409 ordinary match again. There is some code that demonstrates how to do this in
1410 the
1411 <a href="pcredemo.html"><b>pcredemo</b></a>
1412 sample program.
1413 <pre>
1414 PCRE_NO_START_OPTIMIZE
1415 </pre>
1416 There are a number of optimizations that <b>pcre_exec()</b> uses at the start of
1417 a match, in order to speed up the process. For example, if it is known that a
1418 match must start with a specific character, it searches the subject for that
1419 character, and fails immediately if it cannot find it, without actually running
1420 the main matching function. When callouts are in use, these optimizations can
1421 cause them to be skipped. This option disables the "start-up" optimizations,
1422 causing performance to suffer, but ensuring that the callouts do occur.
1423 <pre>
1424 PCRE_NO_UTF8_CHECK
1425 </pre>
1426 When PCRE_UTF8 is set at compile time, the validity of the subject as a UTF-8
1427 string is automatically checked when <b>pcre_exec()</b> is subsequently called.
1428 The value of <i>startoffset</i> is also checked to ensure that it points to the
1429 start of a UTF-8 character. There is a discussion about the validity of UTF-8
1430 strings in the
1431 <a href="pcre.html#utf8strings">section on UTF-8 support</a>
1432 in the main
1433 <a href="pcre.html"><b>pcre</b></a>
1434 page. If an invalid UTF-8 sequence of bytes is found, <b>pcre_exec()</b> returns
1435 the error PCRE_ERROR_BADUTF8. If <i>startoffset</i> contains an invalid value,
1436 PCRE_ERROR_BADUTF8_OFFSET is returned.
1437 </P>
1438 <P>
1439 If you already know that your subject is valid, and you want to skip these
1440 checks for performance reasons, you can set the PCRE_NO_UTF8_CHECK option when
1441 calling <b>pcre_exec()</b>. You might want to do this for the second and
1442 subsequent calls to <b>pcre_exec()</b> if you are making repeated calls to find
1443 all the matches in a single subject string. However, you should be sure that
1444 the value of <i>startoffset</i> points to the start of a UTF-8 character. When
1445 PCRE_NO_UTF8_CHECK is set, the effect of passing an invalid UTF-8 string as a
1446 subject, or a value of <i>startoffset</i> that does not point to the start of a
1447 UTF-8 character, is undefined. Your program may crash.
1448 <pre>
1449 PCRE_PARTIAL_HARD
1450 PCRE_PARTIAL_SOFT
1451 </pre>
1452 These options turn on the partial matching feature. For backwards
1453 compatibility, PCRE_PARTIAL is a synonym for PCRE_PARTIAL_SOFT. A partial match
1454 occurs if the end of the subject string is reached successfully, but there are
1455 not enough subject characters to complete the match. If this happens when
1456 PCRE_PARTIAL_HARD is set, <b>pcre_exec()</b> immediately returns
1457 PCRE_ERROR_PARTIAL. Otherwise, if PCRE_PARTIAL_SOFT is set, matching continues
1458 by testing any other alternatives. Only if they all fail is PCRE_ERROR_PARTIAL
1459 returned (instead of PCRE_ERROR_NOMATCH). The portion of the string that
1460 was inspected when the partial match was found is set as the first matching
1461 string. There is a more detailed discussion in the
1462 <a href="pcrepartial.html"><b>pcrepartial</b></a>
1463 documentation.
1464 </P>
1465 <br><b>
1466 The string to be matched by <b>pcre_exec()</b>
1467 </b><br>
1468 <P>
1469 The subject string is passed to <b>pcre_exec()</b> as a pointer in
1470 <i>subject</i>, a length (in bytes) in <i>length</i>, and a starting byte offset
1471 in <i>startoffset</i>. In UTF-8 mode, the byte offset must point to the start of
1472 a UTF-8 character. Unlike the pattern string, the subject may contain binary
1473 zero bytes. When the starting offset is zero, the search for a match starts at
1474 the beginning of the subject, and this is by far the most common case.
1475 </P>
1476 <P>
1477 A non-zero starting offset is useful when searching for another match in the
1478 same subject by calling <b>pcre_exec()</b> again after a previous success.
1479 Setting <i>startoffset</i> differs from just passing over a shortened string and
1480 setting PCRE_NOTBOL in the case of a pattern that begins with any kind of
1481 lookbehind. For example, consider the pattern
1482 <pre>
1483 \Biss\B
1484 </pre>
1485 which finds occurrences of "iss" in the middle of words. (\B matches only if
1486 the current position in the subject is not a word boundary.) When applied to
1487 the string "Mississipi" the first call to <b>pcre_exec()</b> finds the first
1488 occurrence. If <b>pcre_exec()</b> is called again with just the remainder of the
1489 subject, namely "issipi", it does not match, because \B is always false at the
1490 start of the subject, which is deemed to be a word boundary. However, if
1491 <b>pcre_exec()</b> is passed the entire string again, but with <i>startoffset</i>
1492 set to 4, it finds the second occurrence of "iss" because it is able to look
1493 behind the starting point to discover that it is preceded by a letter.
1494 </P>
1495 <P>
1496 If a non-zero starting offset is passed when the pattern is anchored, one
1497 attempt to match at the given offset is made. This can only succeed if the
1498 pattern does not require the match to be at the start of the subject.
1499 </P>
1500 <br><b>
1501 How <b>pcre_exec()</b> returns captured substrings
1502 </b><br>
1503 <P>
1504 In general, a pattern matches a certain portion of the subject, and in
1505 addition, further substrings from the subject may be picked out by parts of the
1506 pattern. Following the usage in Jeffrey Friedl's book, this is called
1507 "capturing" in what follows, and the phrase "capturing subpattern" is used for
1508 a fragment of a pattern that picks out a substring. PCRE supports several other
1509 kinds of parenthesized subpattern that do not cause substrings to be captured.
1510 </P>
1511 <P>
1512 Captured substrings are returned to the caller via a vector of integers whose
1513 address is passed in <i>ovector</i>. The number of elements in the vector is
1514 passed in <i>ovecsize</i>, which must be a non-negative number. <b>Note</b>: this
1515 argument is NOT the size of <i>ovector</i> in bytes.
1516 </P>
1517 <P>
1518 The first two-thirds of the vector is used to pass back captured substrings,
1519 each substring using a pair of integers. The remaining third of the vector is
1520 used as workspace by <b>pcre_exec()</b> while matching capturing subpatterns,
1521 and is not available for passing back information. The number passed in
1522 <i>ovecsize</i> should always be a multiple of three. If it is not, it is
1523 rounded down.
1524 </P>
1525 <P>
1526 When a match is successful, information about captured substrings is returned
1527 in pairs of integers, starting at the beginning of <i>ovector</i>, and
1528 continuing up to two-thirds of its length at the most. The first element of
1529 each pair is set to the byte offset of the first character in a substring, and
1530 the second is set to the byte offset of the first character after the end of a
1531 substring. <b>Note</b>: these values are always byte offsets, even in UTF-8
1532 mode. They are not character counts.
1533 </P>
1534 <P>
1535 The first pair of integers, <i>ovector[0]</i> and <i>ovector[1]</i>, identify the
1536 portion of the subject string matched by the entire pattern. The next pair is
1537 used for the first capturing subpattern, and so on. The value returned by
1538 <b>pcre_exec()</b> is one more than the highest numbered pair that has been set.
1539 For example, if two substrings have been captured, the returned value is 3. If
1540 there are no capturing subpatterns, the return value from a successful match is
1541 1, indicating that just the first pair of offsets has been set.
1542 </P>
1543 <P>
1544 If a capturing subpattern is matched repeatedly, it is the last portion of the
1545 string that it matched that is returned.
1546 </P>
1547 <P>
1548 If the vector is too small to hold all the captured substring offsets, it is
1549 used as far as possible (up to two-thirds of its length), and the function
1550 returns a value of zero. If the substring offsets are not of interest,
1551 <b>pcre_exec()</b> may be called with <i>ovector</i> passed as NULL and
1552 <i>ovecsize</i> as zero. However, if the pattern contains back references and
1553 the <i>ovector</i> is not big enough to remember the related substrings, PCRE
1554 has to get additional memory for use during matching. Thus it is usually
1555 advisable to supply an <i>ovector</i>.
1556 </P>
1557 <P>
1558 The <b>pcre_fullinfo()</b> function can be used to find out how many capturing
1559 subpatterns there are in a compiled pattern. The smallest size for
1560 <i>ovector</i> that will allow for <i>n</i> captured substrings, in addition to
1561 the offsets of the substring matched by the whole pattern, is (<i>n</i>+1)*3.
1562 </P>
1563 <P>
1564 It is possible for capturing subpattern number <i>n+1</i> to match some part of
1565 the subject when subpattern <i>n</i> has not been used at all. For example, if
1566 the string "abc" is matched against the pattern (a|(z))(bc) the return from the
1567 function is 4, and subpatterns 1 and 3 are matched, but 2 is not. When this
1568 happens, both values in the offset pairs corresponding to unused subpatterns
1569 are set to -1.
1570 </P>
1571 <P>
1572 Offset values that correspond to unused subpatterns at the end of the
1573 expression are also set to -1. For example, if the string "abc" is matched
1574 against the pattern (abc)(x(yz)?)? subpatterns 2 and 3 are not matched. The
1575 return from the function is 2, because the highest used capturing subpattern
1576 number is 1. However, you can refer to the offsets for the second and third
1577 capturing subpatterns if you wish (assuming the vector is large enough, of
1578 course).
1579 </P>
1580 <P>
1581 Some convenience functions are provided for extracting the captured substrings
1582 as separate strings. These are described below.
1583 <a name="errorlist"></a></P>
1584 <br><b>
1585 Error return values from <b>pcre_exec()</b>
1586 </b><br>
1587 <P>
1588 If <b>pcre_exec()</b> fails, it returns a negative number. The following are
1589 defined in the header file:
1590 <pre>
1591 PCRE_ERROR_NOMATCH (-1)
1592 </pre>
1593 The subject string did not match the pattern.
1594 <pre>
1595 PCRE_ERROR_NULL (-2)
1596 </pre>
1597 Either <i>code</i> or <i>subject</i> was passed as NULL, or <i>ovector</i> was
1598 NULL and <i>ovecsize</i> was not zero.
1599 <pre>
1600 PCRE_ERROR_BADOPTION (-3)
1601 </pre>
1602 An unrecognized bit was set in the <i>options</i> argument.
1603 <pre>
1604 PCRE_ERROR_BADMAGIC (-4)
1605 </pre>
1606 PCRE stores a 4-byte "magic number" at the start of the compiled code, to catch
1607 the case when it is passed a junk pointer and to detect when a pattern that was
1608 compiled in an environment of one endianness is run in an environment with the
1609 other endianness. This is the error that PCRE gives when the magic number is
1610 not present.
1611 <pre>
1612 PCRE_ERROR_UNKNOWN_OPCODE (-5)
1613 </pre>
1614 While running the pattern match, an unknown item was encountered in the
1615 compiled pattern. This error could be caused by a bug in PCRE or by overwriting
1616 of the compiled pattern.
1617 <pre>
1618 PCRE_ERROR_NOMEMORY (-6)
1619 </pre>
1620 If a pattern contains back references, but the <i>ovector</i> that is passed to
1621 <b>pcre_exec()</b> is not big enough to remember the referenced substrings, PCRE
1622 gets a block of memory at the start of matching to use for this purpose. If the
1623 call via <b>pcre_malloc()</b> fails, this error is given. The memory is
1624 automatically freed at the end of matching.
1625 <pre>
1626 PCRE_ERROR_NOSUBSTRING (-7)
1627 </pre>
1628 This error is used by the <b>pcre_copy_substring()</b>,
1629 <b>pcre_get_substring()</b>, and <b>pcre_get_substring_list()</b> functions (see
1630 below). It is never returned by <b>pcre_exec()</b>.
1631 <pre>
1632 PCRE_ERROR_MATCHLIMIT (-8)
1633 </pre>
1634 The backtracking limit, as specified by the <i>match_limit</i> field in a
1635 <b>pcre_extra</b> structure (or defaulted) was reached. See the description
1636 above.
1637 <pre>
1638 PCRE_ERROR_CALLOUT (-9)
1639 </pre>
1640 This error is never generated by <b>pcre_exec()</b> itself. It is provided for
1641 use by callout functions that want to yield a distinctive error code. See the
1642 <a href="pcrecallout.html"><b>pcrecallout</b></a>
1643 documentation for details.
1644 <pre>
1645 PCRE_ERROR_BADUTF8 (-10)
1646 </pre>
1647 A string that contains an invalid UTF-8 byte sequence was passed as a subject.
1648 <pre>
1649 PCRE_ERROR_BADUTF8_OFFSET (-11)
1650 </pre>
1651 The UTF-8 byte sequence that was passed as a subject was valid, but the value
1652 of <i>startoffset</i> did not point to the beginning of a UTF-8 character.
1653 <pre>
1654 PCRE_ERROR_PARTIAL (-12)
1655 </pre>
1656 The subject string did not match, but it did match partially. See the
1657 <a href="pcrepartial.html"><b>pcrepartial</b></a>
1658 documentation for details of partial matching.
1659 <pre>
1660 PCRE_ERROR_BADPARTIAL (-13)
1661 </pre>
1662 This code is no longer in use. It was formerly returned when the PCRE_PARTIAL
1663 option was used with a compiled pattern containing items that were not
1664 supported for partial matching. From release 8.00 onwards, there are no
1665 restrictions on partial matching.
1666 <pre>
1667 PCRE_ERROR_INTERNAL (-14)
1668 </pre>
1669 An unexpected internal error has occurred. This error could be caused by a bug
1670 in PCRE or by overwriting of the compiled pattern.
1671 <pre>
1672 PCRE_ERROR_BADCOUNT (-15)
1673 </pre>
1674 This error is given if the value of the <i>ovecsize</i> argument is negative.
1675 <pre>
1676 PCRE_ERROR_RECURSIONLIMIT (-21)
1677 </pre>
1678 The internal recursion limit, as specified by the <i>match_limit_recursion</i>
1679 field in a <b>pcre_extra</b> structure (or defaulted) was reached. See the
1680 description above.
1681 <pre>
1682 PCRE_ERROR_BADNEWLINE (-23)
1683 </pre>
1684 An invalid combination of PCRE_NEWLINE_<i>xxx</i> options was given.
1685 </P>
1686 <P>
1687 Error numbers -16 to -20 and -22 are not used by <b>pcre_exec()</b>.
1688 </P>
1689 <br><a name="SEC15" href="#TOC1">EXTRACTING CAPTURED SUBSTRINGS BY NUMBER</a><br>
1690 <P>
1691 <b>int pcre_copy_substring(const char *<i>subject</i>, int *<i>ovector</i>,</b>
1692 <b>int <i>stringcount</i>, int <i>stringnumber</i>, char *<i>buffer</i>,</b>
1693 <b>int <i>buffersize</i>);</b>
1694 </P>
1695 <P>
1696 <b>int pcre_get_substring(const char *<i>subject</i>, int *<i>ovector</i>,</b>
1697 <b>int <i>stringcount</i>, int <i>stringnumber</i>,</b>
1698 <b>const char **<i>stringptr</i>);</b>
1699 </P>
1700 <P>
1701 <b>int pcre_get_substring_list(const char *<i>subject</i>,</b>
1702 <b>int *<i>ovector</i>, int <i>stringcount</i>, const char ***<i>listptr</i>);</b>
1703 </P>
1704 <P>
1705 Captured substrings can be accessed directly by using the offsets returned by
1706 <b>pcre_exec()</b> in <i>ovector</i>. For convenience, the functions
1707 <b>pcre_copy_substring()</b>, <b>pcre_get_substring()</b>, and
1708 <b>pcre_get_substring_list()</b> are provided for extracting captured substrings
1709 as new, separate, zero-terminated strings. These functions identify substrings
1710 by number. The next section describes functions for extracting named
1711 substrings.
1712 </P>
1713 <P>
1714 A substring that contains a binary zero is correctly extracted and has a
1715 further zero added on the end, but the result is not, of course, a C string.
1716 However, you can process such a string by referring to the length that is
1717 returned by <b>pcre_copy_substring()</b> and <b>pcre_get_substring()</b>.
1718 Unfortunately, the interface to <b>pcre_get_substring_list()</b> is not adequate
1719 for handling strings containing binary zeros, because the end of the final
1720 string is not independently indicated.
1721 </P>
1722 <P>
1723 The first three arguments are the same for all three of these functions:
1724 <i>subject</i> is the subject string that has just been successfully matched,
1725 <i>ovector</i> is a pointer to the vector of integer offsets that was passed to
1726 <b>pcre_exec()</b>, and <i>stringcount</i> is the number of substrings that were
1727 captured by the match, including the substring that matched the entire regular
1728 expression. This is the value returned by <b>pcre_exec()</b> if it is greater
1729 than zero. If <b>pcre_exec()</b> returned zero, indicating that it ran out of
1730 space in <i>ovector</i>, the value passed as <i>stringcount</i> should be the
1731 number of elements in the vector divided by three.
1732 </P>
1733 <P>
1734 The functions <b>pcre_copy_substring()</b> and <b>pcre_get_substring()</b>
1735 extract a single substring, whose number is given as <i>stringnumber</i>. A
1736 value of zero extracts the substring that matched the entire pattern, whereas
1737 higher values extract the captured substrings. For <b>pcre_copy_substring()</b>,
1738 the string is placed in <i>buffer</i>, whose length is given by
1739 <i>buffersize</i>, while for <b>pcre_get_substring()</b> a new block of memory is
1740 obtained via <b>pcre_malloc</b>, and its address is returned via
1741 <i>stringptr</i>. The yield of the function is the length of the string, not
1742 including the terminating zero, or one of these error codes:
1743 <pre>
1744 PCRE_ERROR_NOMEMORY (-6)
1745 </pre>
1746 The buffer was too small for <b>pcre_copy_substring()</b>, or the attempt to get
1747 memory failed for <b>pcre_get_substring()</b>.
1748 <pre>
1749 PCRE_ERROR_NOSUBSTRING (-7)
1750 </pre>
1751 There is no substring whose number is <i>stringnumber</i>.
1752 </P>
1753 <P>
1754 The <b>pcre_get_substring_list()</b> function extracts all available substrings
1755 and builds a list of pointers to them. All this is done in a single block of
1756 memory that is obtained via <b>pcre_malloc</b>. The address of the memory block
1757 is returned via <i>listptr</i>, which is also the start of the list of string
1758 pointers. The end of the list is marked by a NULL pointer. The yield of the
1759 function is zero if all went well, or the error code
1760 <pre>
1761 PCRE_ERROR_NOMEMORY (-6)
1762 </pre>
1763 if the attempt to get the memory block failed.
1764 </P>
1765 <P>
1766 When any of these functions encounter a substring that is unset, which can
1767 happen when capturing subpattern number <i>n+1</i> matches some part of the
1768 subject, but subpattern <i>n</i> has not been used at all, they return an empty
1769 string. This can be distinguished from a genuine zero-length substring by
1770 inspecting the appropriate offset in <i>ovector</i>, which is negative for unset
1771 substrings.
1772 </P>
1773 <P>
1774 The two convenience functions <b>pcre_free_substring()</b> and
1775 <b>pcre_free_substring_list()</b> can be used to free the memory returned by
1776 a previous call of <b>pcre_get_substring()</b> or
1777 <b>pcre_get_substring_list()</b>, respectively. They do nothing more than call
1778 the function pointed to by <b>pcre_free</b>, which of course could be called
1779 directly from a C program. However, PCRE is used in some situations where it is
1780 linked via a special interface to another programming language that cannot use
1781 <b>pcre_free</b> directly; it is for these cases that the functions are
1782 provided.
1783 </P>
1784 <br><a name="SEC16" href="#TOC1">EXTRACTING CAPTURED SUBSTRINGS BY NAME</a><br>
1785 <P>
1786 <b>int pcre_get_stringnumber(const pcre *<i>code</i>,</b>
1787 <b>const char *<i>name</i>);</b>
1788 </P>
1789 <P>
1790 <b>int pcre_copy_named_substring(const pcre *<i>code</i>,</b>
1791 <b>const char *<i>subject</i>, int *<i>ovector</i>,</b>
1792 <b>int <i>stringcount</i>, const char *<i>stringname</i>,</b>
1793 <b>char *<i>buffer</i>, int <i>buffersize</i>);</b>
1794 </P>
1795 <P>
1796 <b>int pcre_get_named_substring(const pcre *<i>code</i>,</b>
1797 <b>const char *<i>subject</i>, int *<i>ovector</i>,</b>
1798 <b>int <i>stringcount</i>, const char *<i>stringname</i>,</b>
1799 <b>const char **<i>stringptr</i>);</b>
1800 </P>
1801 <P>
1802 To extract a substring by name, you first have to find associated number.
1803 For example, for this pattern
1804 <pre>
1805 (a+)b(?&#60;xxx&#62;\d+)...
1806 </pre>
1807 the number of the subpattern called "xxx" is 2. If the name is known to be
1808 unique (PCRE_DUPNAMES was not set), you can find the number from the name by
1809 calling <b>pcre_get_stringnumber()</b>. The first argument is the compiled
1810 pattern, and the second is the name. The yield of the function is the
1811 subpattern number, or PCRE_ERROR_NOSUBSTRING (-7) if there is no subpattern of
1812 that name.
1813 </P>
1814 <P>
1815 Given the number, you can extract the substring directly, or use one of the
1816 functions described in the previous section. For convenience, there are also
1817 two functions that do the whole job.
1818 </P>
1819 <P>
1820 Most of the arguments of <b>pcre_copy_named_substring()</b> and
1821 <b>pcre_get_named_substring()</b> are the same as those for the similarly named
1822 functions that extract by number. As these are described in the previous
1823 section, they are not re-described here. There are just two differences:
1824 </P>
1825 <P>
1826 First, instead of a substring number, a substring name is given. Second, there
1827 is an extra argument, given at the start, which is a pointer to the compiled
1828 pattern. This is needed in order to gain access to the name-to-number
1829 translation table.
1830 </P>
1831 <P>
1832 These functions call <b>pcre_get_stringnumber()</b>, and if it succeeds, they
1833 then call <b>pcre_copy_substring()</b> or <b>pcre_get_substring()</b>, as
1834 appropriate. <b>NOTE:</b> If PCRE_DUPNAMES is set and there are duplicate names,
1835 the behaviour may not be what you want (see the next section).
1836 </P>
1837 <P>
1838 <b>Warning:</b> If the pattern uses the (?| feature to set up multiple
1839 subpatterns with the same number, as described in the
1840 <a href="pcrepattern.html#dupsubpatternnumber">section on duplicate subpattern numbers</a>
1841 in the
1842 <a href="pcrepattern.html"><b>pcrepattern</b></a>
1843 page, you cannot use names to distinguish the different subpatterns, because
1844 names are not included in the compiled code. The matching process uses only
1845 numbers. For this reason, the use of different names for subpatterns of the
1846 same number causes an error at compile time.
1847 </P>
1848 <br><a name="SEC17" href="#TOC1">DUPLICATE SUBPATTERN NAMES</a><br>
1849 <P>
1850 <b>int pcre_get_stringtable_entries(const pcre *<i>code</i>,</b>
1851 <b>const char *<i>name</i>, char **<i>first</i>, char **<i>last</i>);</b>
1852 </P>
1853 <P>
1854 When a pattern is compiled with the PCRE_DUPNAMES option, names for subpatterns
1855 are not required to be unique. (Duplicate names are always allowed for
1856 subpatterns with the same number, created by using the (?| feature. Indeed, if
1857 such subpatterns are named, they are required to use the same names.)
1858 </P>
1859 <P>
1860 Normally, patterns with duplicate names are such that in any one match, only
1861 one of the named subpatterns participates. An example is shown in the
1862 <a href="pcrepattern.html"><b>pcrepattern</b></a>
1863 documentation.
1864 </P>
1865 <P>
1866 When duplicates are present, <b>pcre_copy_named_substring()</b> and
1867 <b>pcre_get_named_substring()</b> return the first substring corresponding to
1868 the given name that is set. If none are set, PCRE_ERROR_NOSUBSTRING (-7) is
1869 returned; no data is returned. The <b>pcre_get_stringnumber()</b> function
1870 returns one of the numbers that are associated with the name, but it is not
1871 defined which it is.
1872 </P>
1873 <P>
1874 If you want to get full details of all captured substrings for a given name,
1875 you must use the <b>pcre_get_stringtable_entries()</b> function. The first
1876 argument is the compiled pattern, and the second is the name. The third and
1877 fourth are pointers to variables which are updated by the function. After it
1878 has run, they point to the first and last entries in the name-to-number table
1879 for the given name. The function itself returns the length of each entry, or
1880 PCRE_ERROR_NOSUBSTRING (-7) if there are none. The format of the table is
1881 described above in the section entitled <i>Information about a pattern</i>.
1882 Given all the relevant entries for the name, you can extract each of their
1883 numbers, and hence the captured data, if any.
1884 </P>
1885 <br><a name="SEC18" href="#TOC1">FINDING ALL POSSIBLE MATCHES</a><br>
1886 <P>
1887 The traditional matching function uses a similar algorithm to Perl, which stops
1888 when it finds the first match, starting at a given point in the subject. If you
1889 want to find all possible matches, or the longest possible match, consider
1890 using the alternative matching function (see below) instead. If you cannot use
1891 the alternative function, but still need to find all possible matches, you
1892 can kludge it up by making use of the callout facility, which is described in
1893 the
1894 <a href="pcrecallout.html"><b>pcrecallout</b></a>
1895 documentation.
1896 </P>
1897 <P>
1898 What you have to do is to insert a callout right at the end of the pattern.
1899 When your callout function is called, extract and save the current matched
1900 substring. Then return 1, which forces <b>pcre_exec()</b> to backtrack and try
1901 other alternatives. Ultimately, when it runs out of matches, <b>pcre_exec()</b>
1902 will yield PCRE_ERROR_NOMATCH.
1903 <a name="dfamatch"></a></P>
1904 <br><a name="SEC19" href="#TOC1">MATCHING A PATTERN: THE ALTERNATIVE FUNCTION</a><br>
1905 <P>
1906 <b>int pcre_dfa_exec(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b>
1907 <b>const char *<i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b>
1908 <b>int <i>options</i>, int *<i>ovector</i>, int <i>ovecsize</i>,</b>
1909 <b>int *<i>workspace</i>, int <i>wscount</i>);</b>
1910 </P>
1911 <P>
1912 The function <b>pcre_dfa_exec()</b> is called to match a subject string against
1913 a compiled pattern, using a matching algorithm that scans the subject string
1914 just once, and does not backtrack. This has different characteristics to the
1915 normal algorithm, and is not compatible with Perl. Some of the features of PCRE
1916 patterns are not supported. Nevertheless, there are times when this kind of
1917 matching can be useful. For a discussion of the two matching algorithms, and a
1918 list of features that <b>pcre_dfa_exec()</b> does not support, see the
1919 <a href="pcrematching.html"><b>pcrematching</b></a>
1920 documentation.
1921 </P>
1922 <P>
1923 The arguments for the <b>pcre_dfa_exec()</b> function are the same as for
1924 <b>pcre_exec()</b>, plus two extras. The <i>ovector</i> argument is used in a
1925 different way, and this is described below. The other common arguments are used
1926 in the same way as for <b>pcre_exec()</b>, so their description is not repeated
1927 here.
1928 </P>
1929 <P>
1930 The two additional arguments provide workspace for the function. The workspace
1931 vector should contain at least 20 elements. It is used for keeping track of
1932 multiple paths through the pattern tree. More workspace will be needed for
1933 patterns and subjects where there are a lot of potential matches.
1934 </P>
1935 <P>
1936 Here is an example of a simple call to <b>pcre_dfa_exec()</b>:
1937 <pre>
1938 int rc;
1939 int ovector[10];
1940 int wspace[20];
1941 rc = pcre_dfa_exec(
1942 re, /* result of pcre_compile() */
1943 NULL, /* we didn't study the pattern */
1944 "some string", /* the subject string */
1945 11, /* the length of the subject string */
1946 0, /* start at offset 0 in the subject */
1947 0, /* default options */
1948 ovector, /* vector of integers for substring information */
1949 10, /* number of elements (NOT size in bytes) */
1950 wspace, /* working space vector */
1951 20); /* number of elements (NOT size in bytes) */
1952 </PRE>
1953 </P>
1954 <br><b>
1955 Option bits for <b>pcre_dfa_exec()</b>
1956 </b><br>
1957 <P>
1958 The unused bits of the <i>options</i> argument for <b>pcre_dfa_exec()</b> must be
1959 zero. The only bits that may be set are PCRE_ANCHORED, PCRE_NEWLINE_<i>xxx</i>,
1960 PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NOTEMPTY_ATSTART,
1961 PCRE_NO_UTF8_CHECK, PCRE_PARTIAL_HARD, PCRE_PARTIAL_SOFT, PCRE_DFA_SHORTEST,
1962 and PCRE_DFA_RESTART. All but the last four of these are exactly the same as
1963 for <b>pcre_exec()</b>, so their description is not repeated here.
1964 <pre>
1965 PCRE_PARTIAL_HARD
1966 PCRE_PARTIAL_SOFT
1967 </pre>
1968 These have the same general effect as they do for <b>pcre_exec()</b>, but the
1969 details are slightly different. When PCRE_PARTIAL_HARD is set for
1970 <b>pcre_dfa_exec()</b>, it returns PCRE_ERROR_PARTIAL if the end of the subject
1971 is reached and there is still at least one matching possibility that requires
1972 additional characters. This happens even if some complete matches have also
1973 been found. When PCRE_PARTIAL_SOFT is set, the return code PCRE_ERROR_NOMATCH
1974 is converted into PCRE_ERROR_PARTIAL if the end of the subject is reached,
1975 there have been no complete matches, but there is still at least one matching
1976 possibility. The portion of the string that was inspected when the longest
1977 partial match was found is set as the first matching string in both cases.
1978 <pre>
1979 PCRE_DFA_SHORTEST
1980 </pre>
1981 Setting the PCRE_DFA_SHORTEST option causes the matching algorithm to stop as
1982 soon as it has found one match. Because of the way the alternative algorithm
1983 works, this is necessarily the shortest possible match at the first possible
1984 matching point in the subject string.
1985 <pre>
1986 PCRE_DFA_RESTART
1987 </pre>
1988 When <b>pcre_dfa_exec()</b> returns a partial match, it is possible to call it
1989 again, with additional subject characters, and have it continue with the same
1990 match. The PCRE_DFA_RESTART option requests this action; when it is set, the
1991 <i>workspace</i> and <i>wscount</i> options must reference the same vector as
1992 before because data about the match so far is left in them after a partial
1993 match. There is more discussion of this facility in the
1994 <a href="pcrepartial.html"><b>pcrepartial</b></a>
1995 documentation.
1996 </P>
1997 <br><b>
1998 Successful returns from <b>pcre_dfa_exec()</b>
1999 </b><br>
2000 <P>
2001 When <b>pcre_dfa_exec()</b> succeeds, it may have matched more than one
2002 substring in the subject. Note, however, that all the matches from one run of
2003 the function start at the same point in the subject. The shorter matches are
2004 all initial substrings of the longer matches. For example, if the pattern
2005 <pre>
2006 &#60;.*&#62;
2007 </pre>
2008 is matched against the string
2009 <pre>
2010 This is &#60;something&#62; &#60;something else&#62; &#60;something further&#62; no more
2011 </pre>
2012 the three matched strings are
2013 <pre>
2014 &#60;something&#62;
2015 &#60;something&#62; &#60;something else&#62;
2016 &#60;something&#62; &#60;something else&#62; &#60;something further&#62;
2017 </pre>
2018 On success, the yield of the function is a number greater than zero, which is
2019 the number of matched substrings. The substrings themselves are returned in
2020 <i>ovector</i>. Each string uses two elements; the first is the offset to the
2021 start, and the second is the offset to the end. In fact, all the strings have
2022 the same start offset. (Space could have been saved by giving this only once,
2023 but it was decided to retain some compatibility with the way <b>pcre_exec()</b>
2024 returns data, even though the meaning of the strings is different.)
2025 </P>
2026 <P>
2027 The strings are returned in reverse order of length; that is, the longest
2028 matching string is given first. If there were too many matches to fit into
2029 <i>ovector</i>, the yield of the function is zero, and the vector is filled with
2030 the longest matches.
2031 </P>
2032 <br><b>
2033 Error returns from <b>pcre_dfa_exec()</b>
2034 </b><br>
2035 <P>
2036 The <b>pcre_dfa_exec()</b> function returns a negative number when it fails.
2037 Many of the errors are the same as for <b>pcre_exec()</b>, and these are
2038 described
2039 <a href="#errorlist">above.</a>
2040 There are in addition the following errors that are specific to
2041 <b>pcre_dfa_exec()</b>:
2042 <pre>
2043 PCRE_ERROR_DFA_UITEM (-16)
2044 </pre>
2045 This return is given if <b>pcre_dfa_exec()</b> encounters an item in the pattern
2046 that it does not support, for instance, the use of \C or a back reference.
2047 <pre>
2048 PCRE_ERROR_DFA_UCOND (-17)
2049 </pre>
2050 This return is given if <b>pcre_dfa_exec()</b> encounters a condition item that
2051 uses a back reference for the condition, or a test for recursion in a specific
2052 group. These are not supported.
2053 <pre>
2054 PCRE_ERROR_DFA_UMLIMIT (-18)
2055 </pre>
2056 This return is given if <b>pcre_dfa_exec()</b> is called with an <i>extra</i>
2057 block that contains a setting of the <i>match_limit</i> field. This is not
2058 supported (it is meaningless).
2059 <pre>
2060 PCRE_ERROR_DFA_WSSIZE (-19)
2061 </pre>
2062 This return is given if <b>pcre_dfa_exec()</b> runs out of space in the
2063 <i>workspace</i> vector.
2064 <pre>
2065 PCRE_ERROR_DFA_RECURSE (-20)
2066 </pre>
2067 When a recursive subpattern is processed, the matching function calls itself
2068 recursively, using private vectors for <i>ovector</i> and <i>workspace</i>. This
2069 error is given if the output vector is not large enough. This should be
2070 extremely rare, as a vector of size 1000 is used.
2071 </P>
2072 <br><a name="SEC20" href="#TOC1">SEE ALSO</a><br>
2073 <P>
2074 <b>pcrebuild</b>(3), <b>pcrecallout</b>(3), <b>pcrecpp(3)</b>(3),
2075 <b>pcrematching</b>(3), <b>pcrepartial</b>(3), <b>pcreposix</b>(3),
2076 <b>pcreprecompile</b>(3), <b>pcresample</b>(3), <b>pcrestack</b>(3).
2077 </P>
2078 <br><a name="SEC21" href="#TOC1">AUTHOR</a><br>
2079 <P>
2080 Philip Hazel
2081 <br>
2082 University Computing Service
2083 <br>
2084 Cambridge CB2 3QH, England.
2085 <br>
2086 </P>
2087 <br><a name="SEC22" href="#TOC1">REVISION</a><br>
2088 <P>
2089 Last updated: 26 March 2010
2090 <br>
2091 Copyright &copy; 1997-2010 University of Cambridge.
2092 <br>
2093 <p>
2094 Return to the <a href="index.html">PCRE index page</a>.
2095 </p>

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.5