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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 77 by nigel, Sat Feb 24 21:40:45 2007 UTC revision 345 by ph10, Mon Apr 28 15:10:02 2008 UTC
# Line 15  man page, in case the conversion went wr Line 15  man page, in case the conversion went wr
15  <ul>  <ul>
16  <li><a name="TOC1" href="#SEC1">PCRE NATIVE API</a>  <li><a name="TOC1" href="#SEC1">PCRE NATIVE API</a>
17  <li><a name="TOC2" href="#SEC2">PCRE API OVERVIEW</a>  <li><a name="TOC2" href="#SEC2">PCRE API OVERVIEW</a>
18  <li><a name="TOC3" href="#SEC3">MULTITHREADING</a>  <li><a name="TOC3" href="#SEC3">NEWLINES</a>
19  <li><a name="TOC4" href="#SEC4">SAVING PRECOMPILED PATTERNS FOR LATER USE</a>  <li><a name="TOC4" href="#SEC4">MULTITHREADING</a>
20  <li><a name="TOC5" href="#SEC5">CHECKING BUILD-TIME OPTIONS</a>  <li><a name="TOC5" href="#SEC5">SAVING PRECOMPILED PATTERNS FOR LATER USE</a>
21  <li><a name="TOC6" href="#SEC6">COMPILING A PATTERN</a>  <li><a name="TOC6" href="#SEC6">CHECKING BUILD-TIME OPTIONS</a>
22  <li><a name="TOC7" href="#SEC7">COMPILATION ERROR CODES</a>  <li><a name="TOC7" href="#SEC7">COMPILING A PATTERN</a>
23  <li><a name="TOC8" href="#SEC8">STUDYING A PATTERN</a>  <li><a name="TOC8" href="#SEC8">COMPILATION ERROR CODES</a>
24  <li><a name="TOC9" href="#SEC9">LOCALE SUPPORT</a>  <li><a name="TOC9" href="#SEC9">STUDYING A PATTERN</a>
25  <li><a name="TOC10" href="#SEC10">INFORMATION ABOUT A PATTERN</a>  <li><a name="TOC10" href="#SEC10">LOCALE SUPPORT</a>
26  <li><a name="TOC11" href="#SEC11">OBSOLETE INFO FUNCTION</a>  <li><a name="TOC11" href="#SEC11">INFORMATION ABOUT A PATTERN</a>
27  <li><a name="TOC12" href="#SEC12">REFERENCE COUNTS</a>  <li><a name="TOC12" href="#SEC12">OBSOLETE INFO FUNCTION</a>
28  <li><a name="TOC13" href="#SEC13">MATCHING A PATTERN: THE TRADITIONAL FUNCTION</a>  <li><a name="TOC13" href="#SEC13">REFERENCE COUNTS</a>
29  <li><a name="TOC14" href="#SEC14">EXTRACTING CAPTURED SUBSTRINGS BY NUMBER</a>  <li><a name="TOC14" href="#SEC14">MATCHING A PATTERN: THE TRADITIONAL FUNCTION</a>
30  <li><a name="TOC15" href="#SEC15">EXTRACTING CAPTURED SUBSTRINGS BY NAME</a>  <li><a name="TOC15" href="#SEC15">EXTRACTING CAPTURED SUBSTRINGS BY NUMBER</a>
31  <li><a name="TOC16" href="#SEC16">FINDING ALL POSSIBLE MATCHES</a>  <li><a name="TOC16" href="#SEC16">EXTRACTING CAPTURED SUBSTRINGS BY NAME</a>
32  <li><a name="TOC17" href="#SEC17">MATCHING A PATTERN: THE ALTERNATIVE FUNCTION</a>  <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>  </ul>
39  <br><a name="SEC1" href="#TOC1">PCRE NATIVE API</a><br>  <br><a name="SEC1" href="#TOC1">PCRE NATIVE API</a><br>
40  <P>  <P>
# Line 83  man page, in case the conversion went wr Line 88  man page, in case the conversion went wr
88  <b>const char *<i>name</i>);</b>  <b>const char *<i>name</i>);</b>
89  </P>  </P>
90  <P>  <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>  <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>  <b>int <i>stringcount</i>, int <i>stringnumber</i>,</b>
97  <b>const char **<i>stringptr</i>);</b>  <b>const char **<i>stringptr</i>);</b>
# Line 134  man page, in case the conversion went wr Line 143  man page, in case the conversion went wr
143  </P>  </P>
144  <br><a name="SEC2" href="#TOC1">PCRE API OVERVIEW</a><br>  <br><a name="SEC2" href="#TOC1">PCRE API OVERVIEW</a><br>
145  <P>  <P>
146  PCRE has its own native API, which is described in this document. There is  PCRE has its own native API, which is described in this document. There are
147  also a set of wrapper functions that correspond to the POSIX regular expression  also some wrapper functions that correspond to the POSIX regular expression
148  API. These are described in the  API. These are described in the
149  <a href="pcreposix.html"><b>pcreposix</b></a>  <a href="pcreposix.html"><b>pcreposix</b></a>
150  documentation. Both of these APIs define a set of C function calls. A C++  documentation. Both of these APIs define a set of C function calls. A C++
# Line 158  in a Perl-compatible manner. A sample pr Line 167  in a Perl-compatible manner. A sample pr
167  way of using them is provided in the file called <i>pcredemo.c</i> in the source  way of using them is provided in the file called <i>pcredemo.c</i> in the source
168  distribution. The  distribution. The
169  <a href="pcresample.html"><b>pcresample</b></a>  <a href="pcresample.html"><b>pcresample</b></a>
170  documentation describes how to run it.  documentation describes how to compile and run it.
171  </P>  </P>
172  <P>  <P>
173  A second matching function, <b>pcre_dfa_exec()</b>, which is not  A second matching function, <b>pcre_dfa_exec()</b>, which is not
174  Perl-compatible, is also provided. This uses a different algorithm for the  Perl-compatible, is also provided. This uses a different algorithm for the
175  matching. This allows it to find all possible matches (at a given point in the  matching. The alternative algorithm finds all possible matches (at a given
176  subject), not just one. However, this algorithm does not return captured  point in the subject), and scans the subject just once. However, this algorithm
177  substrings. A description of the two matching algorithms and their advantages  does not return captured substrings. A description of the two matching
178  and disadvantages is given in the  algorithms and their advantages and disadvantages is given in the
179  <a href="pcrematching.html"><b>pcrematching</b></a>  <a href="pcrematching.html"><b>pcrematching</b></a>
180  documentation.  documentation.
181  </P>  </P>
# Line 181  matched by <b>pcre_exec()</b>. They are: Line 190  matched by <b>pcre_exec()</b>. They are:
190    <b>pcre_get_named_substring()</b>    <b>pcre_get_named_substring()</b>
191    <b>pcre_get_substring_list()</b>    <b>pcre_get_substring_list()</b>
192    <b>pcre_get_stringnumber()</b>    <b>pcre_get_stringnumber()</b>
193      <b>pcre_get_stringtable_entries()</b>
194  </pre>  </pre>
195  <b>pcre_free_substring()</b> and <b>pcre_free_substring_list()</b> are also  <b>pcre_free_substring()</b> and <b>pcre_free_substring_list()</b> are also
196  provided, to free the memory used for extracted strings.  provided, to free the memory used for extracted strings.
# Line 215  should be done before calling any PCRE f Line 225  should be done before calling any PCRE f
225  The global variables <b>pcre_stack_malloc</b> and <b>pcre_stack_free</b> are also  The global variables <b>pcre_stack_malloc</b> and <b>pcre_stack_free</b> are also
226  indirections to memory management functions. These special functions are used  indirections to memory management functions. These special functions are used
227  only when PCRE is compiled to use the heap for remembering data, instead of  only when PCRE is compiled to use the heap for remembering data, instead of
228  recursive function calls, when running the <b>pcre_exec()</b> function. This is  recursive function calls, when running the <b>pcre_exec()</b> function. See the
229  a non-standard way of building PCRE, for use in environments that have limited  <a href="pcrebuild.html"><b>pcrebuild</b></a>
230  stacks. Because of the greater use of memory management, it runs more slowly.  documentation for details of how to do this. It is a non-standard way of
231  Separate functions are provided so that special-purpose external code can be  building PCRE, for use in environments that have limited stacks. Because of the
232  used for this case. When used, these functions are always called in a  greater use of memory management, it runs more slowly. Separate functions are
233  stack-like manner (last obtained, first freed), and always for memory blocks of  provided so that special-purpose external code can be used for this case. When
234  the same size.  used, these functions are always called in a stack-like manner (last obtained,
235    first freed), and always for memory blocks of the same size. There is a
236    discussion about PCRE's stack usage in the
237    <a href="pcrestack.html"><b>pcrestack</b></a>
238    documentation.
239  </P>  </P>
240  <P>  <P>
241  The global variable <b>pcre_callout</b> initially contains NULL. It can be set  The global variable <b>pcre_callout</b> initially contains NULL. It can be set
# Line 229  by the caller to a "callout" function, w Line 243  by the caller to a "callout" function, w
243  points during a matching operation. Details are given in the  points during a matching operation. Details are given in the
244  <a href="pcrecallout.html"><b>pcrecallout</b></a>  <a href="pcrecallout.html"><b>pcrecallout</b></a>
245  documentation.  documentation.
246    <a name="newlines"></a></P>
247    <br><a name="SEC3" href="#TOC1">NEWLINES</a><br>
248    <P>
249    PCRE supports five different conventions for indicating line breaks in
250    strings: a single CR (carriage return) character, a single LF (linefeed)
251    character, the two-character sequence CRLF, any of the three preceding, or any
252    Unicode newline sequence. The Unicode newline sequences are the three just
253    mentioned, plus the single characters VT (vertical tab, U+000B), FF (formfeed,
254    U+000C), NEL (next line, U+0085), LS (line separator, U+2028), and PS
255    (paragraph separator, U+2029).
256    </P>
257    <P>
258    Each of the first three conventions is used by at least one operating system as
259    its standard newline sequence. When PCRE is built, a default can be specified.
260    The default default is LF, which is the Unix standard. When PCRE is run, the
261    default can be overridden, either when a pattern is compiled, or when it is
262    matched.
263    </P>
264    <P>
265    At compile time, the newline convention can be specified by the <i>options</i>
266    argument of <b>pcre_compile()</b>, or it can be specified by special text at the
267    start of the pattern itself; this overrides any other settings. See the
268    <a href="pcrepattern.html"><b>pcrepattern</b></a>
269    page for details of the special character sequences.
270  </P>  </P>
271  <br><a name="SEC3" href="#TOC1">MULTITHREADING</a><br>  <P>
272    In the PCRE documentation the word "newline" is used to mean "the character or
273    pair of characters that indicate a line break". The choice of newline
274    convention affects the handling of the dot, circumflex, and dollar
275    metacharacters, the handling of #-comments in /x mode, and, when CRLF is a
276    recognized line ending sequence, the match position advancement for a
277    non-anchored pattern. There is more detail about this in the
278    <a href="#execoptions">section on <b>pcre_exec()</b> options</a>
279    below.
280    </P>
281    <P>
282    The choice of newline convention does not affect the interpretation of
283    the \n or \r escape sequences, nor does it affect what \R matches, which is
284    controlled in a similar way, but by separate options.
285    </P>
286    <br><a name="SEC4" href="#TOC1">MULTITHREADING</a><br>
287  <P>  <P>
288  The PCRE functions can be used in multi-threading applications, with the  The PCRE functions can be used in multi-threading applications, with the
289  proviso that the memory management functions pointed to by <b>pcre_malloc</b>,  proviso that the memory management functions pointed to by <b>pcre_malloc</b>,
# Line 241  callout function pointed to by <b>pcre_c Line 294  callout function pointed to by <b>pcre_c
294  The compiled form of a regular expression is not altered during matching, so  The compiled form of a regular expression is not altered during matching, so
295  the same compiled pattern can safely be used by several threads at once.  the same compiled pattern can safely be used by several threads at once.
296  </P>  </P>
297  <br><a name="SEC4" href="#TOC1">SAVING PRECOMPILED PATTERNS FOR LATER USE</a><br>  <br><a name="SEC5" href="#TOC1">SAVING PRECOMPILED PATTERNS FOR LATER USE</a><br>
298  <P>  <P>
299  The compiled form of a regular expression can be saved and re-used at a later  The compiled form of a regular expression can be saved and re-used at a later
300  time, possibly by a different program, and even on a host other than the one on  time, possibly by a different program, and even on a host other than the one on
301  which it was compiled. Details are given in the  which it was compiled. Details are given in the
302  <a href="pcreprecompile.html"><b>pcreprecompile</b></a>  <a href="pcreprecompile.html"><b>pcreprecompile</b></a>
303  documentation.  documentation. However, compiling a regular expression with one version of PCRE
304    for use with a different version is not guaranteed to work and may cause
305    crashes.
306  </P>  </P>
307  <br><a name="SEC5" href="#TOC1">CHECKING BUILD-TIME OPTIONS</a><br>  <br><a name="SEC6" href="#TOC1">CHECKING BUILD-TIME OPTIONS</a><br>
308  <P>  <P>
309  <b>int pcre_config(int <i>what</i>, void *<i>where</i>);</b>  <b>int pcre_config(int <i>what</i>, void *<i>where</i>);</b>
310  </P>  </P>
# Line 276  properties is available; otherwise it is Line 331  properties is available; otherwise it is
331  <pre>  <pre>
332    PCRE_CONFIG_NEWLINE    PCRE_CONFIG_NEWLINE
333  </pre>  </pre>
334  The output is an integer that is set to the value of the code that is used for  The output is an integer whose value specifies the default character sequence
335  the newline character. It is either linefeed (10) or carriage return (13), and  that is recognized as meaning "newline". The four values that are supported
336  should normally be the standard character for your operating system.  are: 10 for LF, 13 for CR, 3338 for CRLF, -2 for ANYCRLF, and -1 for ANY. The
337    default should normally be the standard sequence for your operating system.
338    <pre>
339      PCRE_CONFIG_BSR
340    </pre>
341    The output is an integer whose value indicates what character sequences the \R
342    escape sequence matches by default. A value of 0 means that \R matches any
343    Unicode line ending sequence; a value of 1 means that \R matches only CR, LF,
344    or CRLF. The default can be overridden when a pattern is compiled or matched.
345  <pre>  <pre>
346    PCRE_CONFIG_LINK_SIZE    PCRE_CONFIG_LINK_SIZE
347  </pre>  </pre>
# Line 302  The output is an integer that gives the Line 365  The output is an integer that gives the
365  internal matching function calls in a <b>pcre_exec()</b> execution. Further  internal matching function calls in a <b>pcre_exec()</b> execution. Further
366  details are given with <b>pcre_exec()</b> below.  details are given with <b>pcre_exec()</b> below.
367  <pre>  <pre>
368      PCRE_CONFIG_MATCH_LIMIT_RECURSION
369    </pre>
370    The output is an integer that gives the default limit for the depth of
371    recursion when calling the internal matching function in a <b>pcre_exec()</b>
372    execution. Further details are given with <b>pcre_exec()</b> below.
373    <pre>
374    PCRE_CONFIG_STACKRECURSE    PCRE_CONFIG_STACKRECURSE
375  </pre>  </pre>
376  The output is an integer that is set to one if internal recursion when running  The output is an integer that is set to one if internal recursion when running
# Line 312  of recursive function calls. In this cas Line 381  of recursive function calls. In this cas
381  <b>pcre_stack_free</b> are called to manage memory blocks on the heap, thus  <b>pcre_stack_free</b> are called to manage memory blocks on the heap, thus
382  avoiding the use of the stack.  avoiding the use of the stack.
383  </P>  </P>
384  <br><a name="SEC6" href="#TOC1">COMPILING A PATTERN</a><br>  <br><a name="SEC7" href="#TOC1">COMPILING A PATTERN</a><br>
385  <P>  <P>
386  <b>pcre *pcre_compile(const char *<i>pattern</i>, int <i>options</i>,</b>  <b>pcre *pcre_compile(const char *<i>pattern</i>, int <i>options</i>,</b>
387  <b>const char **<i>errptr</i>, int *<i>erroffset</i>,</b>  <b>const char **<i>errptr</i>, int *<i>erroffset</i>,</b>
# Line 334  The pattern is a C string terminated by Line 403  The pattern is a C string terminated by
403  via <b>pcre_malloc</b> is returned. This contains the compiled code and related  via <b>pcre_malloc</b> is returned. This contains the compiled code and related
404  data. The <b>pcre</b> type is defined for the returned block; this is a typedef  data. The <b>pcre</b> type is defined for the returned block; this is a typedef
405  for a structure whose contents are not externally defined. It is up to the  for a structure whose contents are not externally defined. It is up to the
406  caller to free the memory when it is no longer required.  caller to free the memory (via <b>pcre_free</b>) when it is no longer required.
407  </P>  </P>
408  <P>  <P>
409  Although the compiled code of a PCRE regex is relocatable, that is, it does not  Although the compiled code of a PCRE regex is relocatable, that is, it does not
# Line 343  fully relocatable, because it may contai Line 412  fully relocatable, because it may contai
412  argument, which is an address (see below).  argument, which is an address (see below).
413  </P>  </P>
414  <P>  <P>
415  The <i>options</i> argument contains independent bits that affect the  The <i>options</i> argument contains various bit settings that affect the
416  compilation. It should be zero if no options are required. The available  compilation. It should be zero if no options are required. The available
417  options are described below. Some of them, in particular, those that are  options are described below. Some of them, in particular, those that are
418  compatible with Perl, can also be set and unset from within the pattern (see  compatible with Perl, can also be set and unset from within the pattern (see
# Line 351  the detailed description in the Line 420  the detailed description in the
420  <a href="pcrepattern.html"><b>pcrepattern</b></a>  <a href="pcrepattern.html"><b>pcrepattern</b></a>
421  documentation). For these options, the contents of the <i>options</i> argument  documentation). For these options, the contents of the <i>options</i> argument
422  specifies their initial settings at the start of compilation and execution. The  specifies their initial settings at the start of compilation and execution. The
423  PCRE_ANCHORED option can be set at the time of matching as well as at compile  PCRE_ANCHORED and PCRE_NEWLINE_<i>xxx</i> options can be set at the time of
424  time.  matching as well as at compile time.
425  </P>  </P>
426  <P>  <P>
427  If <i>errptr</i> is NULL, <b>pcre_compile()</b> returns NULL immediately.  If <i>errptr</i> is NULL, <b>pcre_compile()</b> returns NULL immediately.
428  Otherwise, if compilation of a pattern fails, <b>pcre_compile()</b> returns  Otherwise, if compilation of a pattern fails, <b>pcre_compile()</b> returns
429  NULL, and sets the variable pointed to by <i>errptr</i> to point to a textual  NULL, and sets the variable pointed to by <i>errptr</i> to point to a textual
430  error message. The offset from the start of the pattern to the character where  error message. This is a static string that is part of the library. You must
431  the error was discovered is placed in the variable pointed to by  not try to free it. The offset from the start of the pattern to the character
432    where the error was discovered is placed in the variable pointed to by
433  <i>erroffset</i>, which must not be NULL. If it is, an immediate error is given.  <i>erroffset</i>, which must not be NULL. If it is, an immediate error is given.
434  </P>  </P>
435  <P>  <P>
# Line 408  facility, see the Line 478  facility, see the
478  <a href="pcrecallout.html"><b>pcrecallout</b></a>  <a href="pcrecallout.html"><b>pcrecallout</b></a>
479  documentation.  documentation.
480  <pre>  <pre>
481      PCRE_BSR_ANYCRLF
482      PCRE_BSR_UNICODE
483    </pre>
484    These options (which are mutually exclusive) control what the \R escape
485    sequence matches. The choice is either to match only CR, LF, or CRLF, or to
486    match any Unicode newline sequence. The default is specified when PCRE is
487    built. It can be overridden from within the pattern, or by setting an option
488    when a compiled pattern is matched.
489    <pre>
490    PCRE_CASELESS    PCRE_CASELESS
491  </pre>  </pre>
492  If this bit is set, letters in the pattern match both upper and lower case  If this bit is set, letters in the pattern match both upper and lower case
# Line 424  with UTF-8 support. Line 503  with UTF-8 support.
503  </pre>  </pre>
504  If this bit is set, a dollar metacharacter in the pattern matches only at the  If this bit is set, a dollar metacharacter in the pattern matches only at the
505  end of the subject string. Without this option, a dollar also matches  end of the subject string. Without this option, a dollar also matches
506  immediately before the final character if it is a newline (but not before any  immediately before a newline at the end of the string (but not before any other
507  other newlines). The PCRE_DOLLAR_ENDONLY option is ignored if PCRE_MULTILINE is  newlines). The PCRE_DOLLAR_ENDONLY option is ignored if PCRE_MULTILINE is set.
508  set. There is no equivalent to this option in Perl, and no way to set it within  There is no equivalent to this option in Perl, and no way to set it within a
509  a pattern.  pattern.
510  <pre>  <pre>
511    PCRE_DOTALL    PCRE_DOTALL
512  </pre>  </pre>
513  If this bit is set, a dot metacharater in the pattern matches all characters,  If this bit is set, a dot metacharater in the pattern matches all characters,
514  including newlines. Without it, newlines are excluded. This option is  including those that indicate newline. Without it, a dot does not match when
515  equivalent to Perl's /s option, and it can be changed within a pattern by a  the current position is at a newline. This option is equivalent to Perl's /s
516  (?s) option setting. A negative class such as [^a] always matches a newline  option, and it can be changed within a pattern by a (?s) option setting. A
517  character, independent of the setting of this option.  negative class such as [^a] always matches newline characters, independent of
518    the setting of this option.
519    <pre>
520      PCRE_DUPNAMES
521    </pre>
522    If this bit is set, names used to identify capturing subpatterns need not be
523    unique. This can be helpful for certain types of pattern when it is known that
524    only one instance of the named subpattern can ever be matched. There are more
525    details of named subpatterns below; see also the
526    <a href="pcrepattern.html"><b>pcrepattern</b></a>
527    documentation.
528  <pre>  <pre>
529    PCRE_EXTENDED    PCRE_EXTENDED
530  </pre>  </pre>
531  If this bit is set, whitespace data characters in the pattern are totally  If this bit is set, whitespace data characters in the pattern are totally
532  ignored except when escaped or inside a character class. Whitespace does not  ignored except when escaped or inside a character class. Whitespace does not
533  include the VT character (code 11). In addition, characters between an  include the VT character (code 11). In addition, characters between an
534  unescaped # outside a character class and the next newline character,  unescaped # outside a character class and the next newline, inclusive, are also
535  inclusive, are also ignored. This is equivalent to Perl's /x option, and it can  ignored. This is equivalent to Perl's /x option, and it can be changed within a
536  be changed within a pattern by a (?x) option setting.  pattern by a (?x) option setting.
537  </P>  </P>
538  <P>  <P>
539  This option makes it possible to include comments inside complicated patterns.  This option makes it possible to include comments inside complicated patterns.
# Line 459  that is incompatible with Perl, but it i Line 548  that is incompatible with Perl, but it i
548  set, any backslash in a pattern that is followed by a letter that has no  set, any backslash in a pattern that is followed by a letter that has no
549  special meaning causes an error, thus reserving these combinations for future  special meaning causes an error, thus reserving these combinations for future
550  expansion. By default, as in Perl, a backslash followed by a letter with no  expansion. By default, as in Perl, a backslash followed by a letter with no
551  special meaning is treated as a literal. There are at present no other features  special meaning is treated as a literal. (Perl can, however, be persuaded to
552  controlled by this option. It can also be set by a (?X) option setting within a  give a warning for this.) There are at present no other features controlled by
553  pattern.  this option. It can also be set by a (?X) option setting within a pattern.
554  <pre>  <pre>
555    PCRE_FIRSTLINE    PCRE_FIRSTLINE
556  </pre>  </pre>
557  If this option is set, an unanchored pattern is required to match before or at  If this option is set, an unanchored pattern is required to match before or at
558  the first newline character in the subject string, though the matched text may  the first newline in the subject string, though the matched text may continue
559  continue over the newline.  over the newline.
560    <pre>
561      PCRE_JAVASCRIPT_COMPAT
562    </pre>
563    If this option is set, PCRE's behaviour is changed in some ways so that it is
564    compatible with JavaScript rather than Perl. The changes are as follows:
565    </P>
566    <P>
567    (1) A lone closing square bracket in a pattern causes a compile-time error,
568    because this is illegal in JavaScript (by default it is treated as a data
569    character). Thus, the pattern AB]CD becomes illegal when this option is set.
570    </P>
571    <P>
572    (2) At run time, a back reference to an unset subpattern group matches an empty
573    string (by default this causes the current matching alternative to fail). A
574    pattern such as (\1)(a) succeeds when this option is set (assuming it can find
575    an "a" in the subject), whereas it fails by default, for Perl compatibility.
576  <pre>  <pre>
577    PCRE_MULTILINE    PCRE_MULTILINE
578  </pre>  </pre>
# Line 480  Perl. Line 585  Perl.
585  </P>  </P>
586  <P>  <P>
587  When PCRE_MULTILINE it is set, the "start of line" and "end of line" constructs  When PCRE_MULTILINE it is set, the "start of line" and "end of line" constructs
588  match immediately following or immediately before any newline in the subject  match immediately following or immediately before internal newlines in the
589  string, respectively, as well as at the very start and end. This is equivalent  subject string, respectively, as well as at the very start and end. This is
590  to Perl's /m option, and it can be changed within a pattern by a (?m) option  equivalent to Perl's /m option, and it can be changed within a pattern by a
591  setting. If there are no "\n" characters in a subject string, or no  (?m) option setting. If there are no newlines in a subject string, or no
592  occurrences of ^ or $ in a pattern, setting PCRE_MULTILINE has no effect.  occurrences of ^ or $ in a pattern, setting PCRE_MULTILINE has no effect.
593  <pre>  <pre>
594      PCRE_NEWLINE_CR
595      PCRE_NEWLINE_LF
596      PCRE_NEWLINE_CRLF
597      PCRE_NEWLINE_ANYCRLF
598      PCRE_NEWLINE_ANY
599    </pre>
600    These options override the default newline definition that was chosen when PCRE
601    was built. Setting the first or the second specifies that a newline is
602    indicated by a single character (CR or LF, respectively). Setting
603    PCRE_NEWLINE_CRLF specifies that a newline is indicated by the two-character
604    CRLF sequence. Setting PCRE_NEWLINE_ANYCRLF specifies that any of the three
605    preceding sequences should be recognized. Setting PCRE_NEWLINE_ANY specifies
606    that any Unicode newline sequence should be recognized. The Unicode newline
607    sequences are the three just mentioned, plus the single characters VT (vertical
608    tab, U+000B), FF (formfeed, U+000C), NEL (next line, U+0085), LS (line
609    separator, U+2028), and PS (paragraph separator, U+2029). The last two are
610    recognized only in UTF-8 mode.
611    </P>
612    <P>
613    The newline setting in the options word uses three bits that are treated
614    as a number, giving eight possibilities. Currently only six are used (default
615    plus the five values above). This means that if you set more than one newline
616    option, the combination may or may not be sensible. For example,
617    PCRE_NEWLINE_CR with PCRE_NEWLINE_LF is equivalent to PCRE_NEWLINE_CRLF, but
618    other combinations may yield unused numbers and cause an error.
619    </P>
620    <P>
621    The only time that a line break is specially recognized when compiling a
622    pattern is if PCRE_EXTENDED is set, and an unescaped # outside a character
623    class is encountered. This indicates a comment that lasts until after the next
624    line break sequence. In other circumstances, line break sequences are treated
625    as literal data, except that in PCRE_EXTENDED mode, both CR and LF are treated
626    as whitespace characters and are therefore ignored.
627    </P>
628    <P>
629    The newline option that is set at compile time becomes the default that is used
630    for <b>pcre_exec()</b> and <b>pcre_dfa_exec()</b>, but it can be overridden.
631    <pre>
632    PCRE_NO_AUTO_CAPTURE    PCRE_NO_AUTO_CAPTURE
633  </pre>  </pre>
634  If this option is set, it disables the use of numbered capturing parentheses in  If this option is set, it disables the use of numbered capturing parentheses in
# Line 515  page. Line 658  page.
658    PCRE_NO_UTF8_CHECK    PCRE_NO_UTF8_CHECK
659  </pre>  </pre>
660  When PCRE_UTF8 is set, the validity of the pattern as a UTF-8 string is  When PCRE_UTF8 is set, the validity of the pattern as a UTF-8 string is
661  automatically checked. If an invalid UTF-8 sequence of bytes is found,  automatically checked. There is a discussion about the
662  <b>pcre_compile()</b> returns an error. If you already know that your pattern is  <a href="pcre.html#utf8strings">validity of UTF-8 strings</a>
663  valid, and you want to skip this check for performance reasons, you can set the  in the main
664  PCRE_NO_UTF8_CHECK option. When it is set, the effect of passing an invalid  <a href="pcre.html"><b>pcre</b></a>
665  UTF-8 string as a pattern is undefined. It may cause your program to crash.  page. If an invalid UTF-8 sequence of bytes is found, <b>pcre_compile()</b>
666  Note that this option can also be passed to <b>pcre_exec()</b> and  returns an error. If you already know that your pattern is valid, and you want
667  <b>pcre_dfa_exec()</b>, to suppress the UTF-8 validity checking of subject  to skip this check for performance reasons, you can set the PCRE_NO_UTF8_CHECK
668  strings.  option. When it is set, the effect of passing an invalid UTF-8 string as a
669    pattern is undefined. It may cause your program to crash. Note that this option
670    can also be passed to <b>pcre_exec()</b> and <b>pcre_dfa_exec()</b>, to suppress
671    the UTF-8 validity checking of subject strings.
672  </P>  </P>
673  <br><a name="SEC7" href="#TOC1">COMPILATION ERROR CODES</a><br>  <br><a name="SEC8" href="#TOC1">COMPILATION ERROR CODES</a><br>
674  <P>  <P>
675  The following table lists the error codes than may be returned by  The following table lists the error codes than may be returned by
676  <b>pcre_compile2()</b>, along with the error messages that may be returned by  <b>pcre_compile2()</b>, along with the error messages that may be returned by
677  both compiling functions.  both compiling functions. As PCRE has developed, some error codes have fallen
678    out of use. To avoid confusion, they have not been re-used.
679  <pre>  <pre>
680     0  no error     0  no error
681     1  \ at end of pattern     1  \ at end of pattern
# Line 540  both compiling functions. Line 687  both compiling functions.
687     7  invalid escape sequence in character class     7  invalid escape sequence in character class
688     8  range out of order in character class     8  range out of order in character class
689     9  nothing to repeat     9  nothing to repeat
690    10  operand of unlimited repeat could match the empty string    10  [this code is not in use]
691    11  internal error: unexpected repeat    11  internal error: unexpected repeat
692    12  unrecognized character after (?    12  unrecognized character after (? or (?-
693    13  POSIX named classes are supported only within a class    13  POSIX named classes are supported only within a class
694    14  missing )    14  missing )
695    15  reference to non-existent subpattern    15  reference to non-existent subpattern
696    16  erroffset passed as NULL    16  erroffset passed as NULL
697    17  unknown option bit(s) set    17  unknown option bit(s) set
698    18  missing ) after comment    18  missing ) after comment
699    19  parentheses nested too deeply    19  [this code is not in use]
700    20  regular expression too large    20  regular expression is too large
701    21  failed to get memory    21  failed to get memory
702    22  unmatched parentheses    22  unmatched parentheses
703    23  internal error: code overflow    23  internal error: code overflow
704    24  unrecognized character after (?&#60;    24  unrecognized character after (?&#60;
705    25  lookbehind assertion is not fixed length    25  lookbehind assertion is not fixed length
706    26  malformed number after (?(    26  malformed number or name after (?(
707    27  conditional group contains more than two branches    27  conditional group contains more than two branches
708    28  assertion expected after (?(    28  assertion expected after (?(
709    29  (?R or (?digits must be followed by )    29  (?R or (?[+-]digits must be followed by )
710    30  unknown POSIX class name    30  unknown POSIX class name
711    31  POSIX collating elements are not supported    31  POSIX collating elements are not supported
712    32  this version of PCRE is not compiled with PCRE_UTF8 support    32  this version of PCRE is not compiled with PCRE_UTF8 support
713    33  spare error    33  [this code is not in use]
714    34  character value in \x{...} sequence is too large    34  character value in \x{...} sequence is too large
715    35  invalid condition (?(0)    35  invalid condition (?(0)
716    36  \C not allowed in lookbehind assertion    36  \C not allowed in lookbehind assertion
# Line 572  both compiling functions. Line 719  both compiling functions.
719    39  closing ) for (?C expected    39  closing ) for (?C expected
720    40  recursive call could loop indefinitely    40  recursive call could loop indefinitely
721    41  unrecognized character after (?P    41  unrecognized character after (?P
722    42  syntax error after (?P    42  syntax error in subpattern name (missing terminator)
723    43  two named groups have the same name    43  two named subpatterns have the same name
724    44  invalid UTF-8 string    44  invalid UTF-8 string
725    45  support for \P, \p, and \X has not been compiled    45  support for \P, \p, and \X has not been compiled
726    46  malformed \P or \p sequence    46  malformed \P or \p sequence
727    47  unknown property name after \P or \p    47  unknown property name after \P or \p
728  </PRE>    48  subpattern name is too long (maximum 32 characters)
729      49  too many named subpatterns (maximum 10000)
730      50  [this code is not in use]
731      51  octal value is greater than \377 (not in UTF-8 mode)
732      52  internal error: overran compiling workspace
733      53  internal error: previously-checked referenced subpattern not found
734      54  DEFINE group contains more than one branch
735      55  repeating a DEFINE group is not allowed
736      56  inconsistent NEWLINE options
737      57  \g is not followed by a braced, angle-bracketed, or quoted
738            name/number or by a plain number
739      58  a numbered reference must not be zero
740      59  (*VERB) with an argument is not supported
741      60  (*VERB) not recognized
742      61  number is too big
743      62  subpattern name expected
744      63  digit expected after (?+
745      64  ] is an invalid data character in JavaScript compatibility mode
746    </pre>
747    The numbers 32 and 10000 in errors 48 and 49 are defaults; different values may
748    be used if the limits were changed when PCRE was built.
749  </P>  </P>
750  <br><a name="SEC8" href="#TOC1">STUDYING A PATTERN</a><br>  <br><a name="SEC9" href="#TOC1">STUDYING A PATTERN</a><br>
751  <P>  <P>
752  <b>pcre_extra *pcre_study(const pcre *<i>code</i>, int <i>options</i></b>  <b>pcre_extra *pcre_study(const pcre *<i>code</i>, int <i>options</i></b>
753  <b>const char **<i>errptr</i>);</b>  <b>const char **<i>errptr</i>);</b>
# Line 615  options are defined, and this argument s Line 782  options are defined, and this argument s
782  <P>  <P>
783  The third argument for <b>pcre_study()</b> is a pointer for an error message. If  The third argument for <b>pcre_study()</b> is a pointer for an error message. If
784  studying succeeds (even if no data is returned), the variable it points to is  studying succeeds (even if no data is returned), the variable it points to is
785  set to NULL. Otherwise it points to a textual error message. You should  set to NULL. Otherwise it is set to point to a textual error message. This is a
786  therefore test the error pointer for NULL after calling <b>pcre_study()</b>, to  static string that is part of the library. You must not try to free it. You
787  be sure that it has run successfully.  should test the error pointer for NULL after calling <b>pcre_study()</b>, to be
788    sure that it has run successfully.
789  </P>  </P>
790  <P>  <P>
791  This is a typical call to <b>pcre_study</b>():  This is a typical call to <b>pcre_study</b>():
# Line 632  At present, studying a pattern is useful Line 800  At present, studying a pattern is useful
800  not have a single fixed starting character. A bitmap of possible starting  not have a single fixed starting character. A bitmap of possible starting
801  bytes is created.  bytes is created.
802  <a name="localesupport"></a></P>  <a name="localesupport"></a></P>
803  <br><a name="SEC9" href="#TOC1">LOCALE SUPPORT</a><br>  <br><a name="SEC10" href="#TOC1">LOCALE SUPPORT</a><br>
804  <P>  <P>
805  PCRE handles caseless matching, and determines whether characters are letters  PCRE handles caseless matching, and determines whether characters are letters,
806  digits, or whatever, by reference to a set of tables, indexed by character  digits, or whatever, by reference to a set of tables, indexed by character
807  value. When running in UTF-8 mode, this applies only to characters with codes  value. When running in UTF-8 mode, this applies only to characters with codes
808  less than 128. Higher-valued codes never match escapes such as \w or \d, but  less than 128. Higher-valued codes never match escapes such as \w or \d, but
809  can be tested with \p if PCRE is built with Unicode character property  can be tested with \p if PCRE is built with Unicode character property
810  support.  support. The use of locales with Unicode is discouraged. If you are handling
811  </P>  characters with codes greater than 128, you should either use UTF-8 and
812  <P>  Unicode, or use locales, but not try to mix the two.
813  An internal set of tables is created in the default C locale when PCRE is  </P>
814  built. This is used when the final argument of <b>pcre_compile()</b> is NULL,  <P>
815  and is sufficient for many applications. An alternative set of tables can,  PCRE contains an internal set of tables that are used when the final argument
816  however, be supplied. These may be created in a different locale from the  of <b>pcre_compile()</b> is NULL. These are sufficient for many applications.
817  default. As more and more applications change to using Unicode, the need for  Normally, the internal tables recognize only ASCII characters. However, when
818  this locale support is expected to die away.  PCRE is built, it is possible to cause the internal tables to be rebuilt in the
819    default "C" locale of the local system, which may cause them to be different.
820    </P>
821    <P>
822    The internal tables can always be overridden by tables supplied by the
823    application that calls PCRE. These may be created in a different locale from
824    the default. As more and more applications change to using Unicode, the need
825    for this locale support is expected to die away.
826  </P>  </P>
827  <P>  <P>
828  External tables are built by calling the <b>pcre_maketables()</b> function,  External tables are built by calling the <b>pcre_maketables()</b> function,
# Line 661  the following code could be used: Line 836  the following code could be used:
836    tables = pcre_maketables();    tables = pcre_maketables();
837    re = pcre_compile(..., tables);    re = pcre_compile(..., tables);
838  </pre>  </pre>
839    The locale name "fr_FR" is used on Linux and other Unix-like systems; if you
840    are using Windows, the name for the French locale is "french".
841    </P>
842    <P>
843  When <b>pcre_maketables()</b> runs, the tables are built in memory that is  When <b>pcre_maketables()</b> runs, the tables are built in memory that is
844  obtained via <b>pcre_malloc</b>. It is the caller's responsibility to ensure  obtained via <b>pcre_malloc</b>. It is the caller's responsibility to ensure
845  that the memory containing the tables remains available for as long as it is  that the memory containing the tables remains available for as long as it is
# Line 680  this facility could be used to match a p Line 859  this facility could be used to match a p
859  one in which it was compiled. Passing table pointers at run time is discussed  one in which it was compiled. Passing table pointers at run time is discussed
860  below in the section on matching a pattern.  below in the section on matching a pattern.
861  </P>  </P>
862  <br><a name="SEC10" href="#TOC1">INFORMATION ABOUT A PATTERN</a><br>  <br><a name="SEC11" href="#TOC1">INFORMATION ABOUT A PATTERN</a><br>
863  <P>  <P>
864  <b>int pcre_fullinfo(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b>  <b>int pcre_fullinfo(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b>
865  <b>int <i>what</i>, void *<i>where</i>);</b>  <b>int <i>what</i>, void *<i>where</i>);</b>
# Line 708  check against passing an arbitrary memor Line 887  check against passing an arbitrary memor
887  <b>pcre_fullinfo()</b>, to obtain the length of the compiled pattern:  <b>pcre_fullinfo()</b>, to obtain the length of the compiled pattern:
888  <pre>  <pre>
889    int rc;    int rc;
890    unsigned long int length;    size_t length;
891    rc = pcre_fullinfo(    rc = pcre_fullinfo(
892      re,               /* result of pcre_compile() */      re,               /* result of pcre_compile() */
893      pe,               /* result of pcre_study(), or NULL */      pe,               /* result of pcre_study(), or NULL */
# Line 740  a NULL table pointer. Line 919  a NULL table pointer.
919    PCRE_INFO_FIRSTBYTE    PCRE_INFO_FIRSTBYTE
920  </pre>  </pre>
921  Return information about the first byte of any matched string, for a  Return information about the first byte of any matched string, for a
922  non-anchored pattern. (This option used to be called PCRE_INFO_FIRSTCHAR; the  non-anchored pattern. The fourth argument should point to an <b>int</b>
923  old name is still recognized for backwards compatibility.)  variable. (This option used to be called PCRE_INFO_FIRSTCHAR; the old name is
924    still recognized for backwards compatibility.)
925  </P>  </P>
926  <P>  <P>
927  If there is a fixed first byte, for example, from a pattern such as  If there is a fixed first byte, for example, from a pattern such as
928  (cat|cow|coyote), it is returned in the integer pointed to by <i>where</i>.  (cat|cow|coyote), its value is returned. Otherwise, if either
 Otherwise, if either  
929  <br>  <br>
930  <br>  <br>
931  (a) the pattern was compiled with the PCRE_MULTILINE option, and every branch  (a) the pattern was compiled with the PCRE_MULTILINE option, and every branch
# Line 768  table indicating a fixed set of bytes fo Line 947  table indicating a fixed set of bytes fo
947  string, a pointer to the table is returned. Otherwise NULL is returned. The  string, a pointer to the table is returned. Otherwise NULL is returned. The
948  fourth argument should point to an <b>unsigned char *</b> variable.  fourth argument should point to an <b>unsigned char *</b> variable.
949  <pre>  <pre>
950      PCRE_INFO_HASCRORLF
951    </pre>
952    Return 1 if the pattern contains any explicit matches for CR or LF characters,
953    otherwise 0. The fourth argument should point to an <b>int</b> variable. An
954    explicit match is either a literal CR or LF character, or \r or \n.
955    <pre>
956      PCRE_INFO_JCHANGED
957    </pre>
958    Return 1 if the (?J) or (?-J) option setting is used in the pattern, otherwise
959    0. The fourth argument should point to an <b>int</b> variable. (?J) and
960    (?-J) set and unset the local PCRE_DUPNAMES option, respectively.
961    <pre>
962    PCRE_INFO_LASTLITERAL    PCRE_INFO_LASTLITERAL
963  </pre>  </pre>
964  Return the value of the rightmost literal byte that must exist in any matched  Return the value of the rightmost literal byte that must exist in any matched
# Line 784  is -1. Line 975  is -1.
975  </pre>  </pre>
976  PCRE supports the use of named as well as numbered capturing parentheses. The  PCRE supports the use of named as well as numbered capturing parentheses. The
977  names are just an additional way of identifying the parentheses, which still  names are just an additional way of identifying the parentheses, which still
978  acquire numbers. A convenience function called <b>pcre_get_named_substring()</b>  acquire numbers. Several convenience functions such as
979  is provided for extracting an individual captured substring by name. It is also  <b>pcre_get_named_substring()</b> are provided for extracting captured
980  possible to extract the data directly, by first converting the name to a number  substrings by name. It is also possible to extract the data directly, by first
981  in order to access the correct pointers in the output vector (described with  converting the name to a number in order to access the correct pointers in the
982  <b>pcre_exec()</b> below). To do the conversion, you need to use the  output vector (described with <b>pcre_exec()</b> below). To do the conversion,
983  name-to-number map, which is described by these three values.  you need to use the name-to-number map, which is described by these three
984    values.
985  </P>  </P>
986  <P>  <P>
987  The map consists of a number of fixed-size entries. PCRE_INFO_NAMECOUNT gives  The map consists of a number of fixed-size entries. PCRE_INFO_NAMECOUNT gives
# Line 799  length of the longest name. PCRE_INFO_NA Line 991  length of the longest name. PCRE_INFO_NA
991  entry of the table (a pointer to <b>char</b>). The first two bytes of each entry  entry of the table (a pointer to <b>char</b>). The first two bytes of each entry
992  are the number of the capturing parenthesis, most significant byte first. The  are the number of the capturing parenthesis, most significant byte first. The
993  rest of the entry is the corresponding name, zero terminated. The names are in  rest of the entry is the corresponding name, zero terminated. The names are in
994  alphabetical order. For example, consider the following pattern (assume  alphabetical order. When PCRE_DUPNAMES is set, duplicate names are in order of
995    their parentheses numbers. For example, consider the following pattern (assume
996  PCRE_EXTENDED is set, so white space - including newlines - is ignored):  PCRE_EXTENDED is set, so white space - including newlines - is ignored):
997  <pre>  <pre>
998    (?P&#60;date&#62; (?P&#60;year&#62;(\d\d)?\d\d) - (?P&#60;month&#62;\d\d) - (?P&#60;day&#62;\d\d) )    (?&#60;date&#62; (?&#60;year&#62;(\d\d)?\d\d) - (?&#60;month&#62;\d\d) - (?&#60;day&#62;\d\d) )
999  </pre>  </pre>
1000  There are four named subpatterns, so the table has four entries, and each entry  There are four named subpatterns, so the table has four entries, and each entry
1001  in the table is eight bytes long. The table is as follows, with non-printing  in the table is eight bytes long. The table is as follows, with non-printing
# Line 814  bytes shows in hexadecimal, and undefine Line 1007  bytes shows in hexadecimal, and undefine
1007    00 02 y  e  a  r  00 ??    00 02 y  e  a  r  00 ??
1008  </pre>  </pre>
1009  When writing code to extract data from named subpatterns using the  When writing code to extract data from named subpatterns using the
1010  name-to-number map, remember that the length of each entry is likely to be  name-to-number map, remember that the length of the entries is likely to be
1011  different for each compiled pattern.  different for each compiled pattern.
1012  <pre>  <pre>
1013      PCRE_INFO_OKPARTIAL
1014    </pre>
1015    Return 1 if the pattern can be used for partial matching, otherwise 0. The
1016    fourth argument should point to an <b>int</b> variable. The
1017    <a href="pcrepartial.html"><b>pcrepartial</b></a>
1018    documentation lists the restrictions that apply to patterns when partial
1019    matching is used.
1020    <pre>
1021    PCRE_INFO_OPTIONS    PCRE_INFO_OPTIONS
1022  </pre>  </pre>
1023  Return a copy of the options with which the pattern was compiled. The fourth  Return a copy of the options with which the pattern was compiled. The fourth
1024  argument should point to an <b>unsigned long int</b> variable. These option bits  argument should point to an <b>unsigned long int</b> variable. These option bits
1025  are those specified in the call to <b>pcre_compile()</b>, modified by any  are those specified in the call to <b>pcre_compile()</b>, modified by any
1026  top-level option settings within the pattern itself.  top-level option settings at the start of the pattern itself. In other words,
1027    they are the options that will be in force when matching starts. For example,
1028    if the pattern /(?im)abc(?-i)d/ is compiled with the PCRE_EXTENDED option, the
1029    result is PCRE_CASELESS, PCRE_MULTILINE, and PCRE_EXTENDED.
1030  </P>  </P>
1031  <P>  <P>
1032  A pattern is automatically anchored by PCRE if all of its top-level  A pattern is automatically anchored by PCRE if all of its top-level
# Line 851  a <b>pcre_extra</b> block. That is, it i Line 1055  a <b>pcre_extra</b> block. That is, it i
1055  created by <b>pcre_study()</b>. The fourth argument should point to a  created by <b>pcre_study()</b>. The fourth argument should point to a
1056  <b>size_t</b> variable.  <b>size_t</b> variable.
1057  </P>  </P>
1058  <br><a name="SEC11" href="#TOC1">OBSOLETE INFO FUNCTION</a><br>  <br><a name="SEC12" href="#TOC1">OBSOLETE INFO FUNCTION</a><br>
1059  <P>  <P>
1060  <b>int pcre_info(const pcre *<i>code</i>, int *<i>optptr</i>, int</b>  <b>int pcre_info(const pcre *<i>code</i>, int *<i>optptr</i>, int</b>
1061  <b>*<i>firstcharptr</i>);</b>  <b>*<i>firstcharptr</i>);</b>
# Line 875  If the pattern is not anchored and the < Line 1079  If the pattern is not anchored and the <
1079  it is used to pass back information about the first character of any matched  it is used to pass back information about the first character of any matched
1080  string (see PCRE_INFO_FIRSTBYTE above).  string (see PCRE_INFO_FIRSTBYTE above).
1081  </P>  </P>
1082  <br><a name="SEC12" href="#TOC1">REFERENCE COUNTS</a><br>  <br><a name="SEC13" href="#TOC1">REFERENCE COUNTS</a><br>
1083  <P>  <P>
1084  <b>int pcre_refcount(pcre *<i>code</i>, int <i>adjust</i>);</b>  <b>int pcre_refcount(pcre *<i>code</i>, int <i>adjust</i>);</b>
1085  </P>  </P>
# Line 899  Except when it is zero, the reference co Line 1103  Except when it is zero, the reference co
1103  pattern is compiled on one host and then transferred to a host whose byte-order  pattern is compiled on one host and then transferred to a host whose byte-order
1104  is different. (This seems a highly unlikely scenario.)  is different. (This seems a highly unlikely scenario.)
1105  </P>  </P>
1106  <br><a name="SEC13" href="#TOC1">MATCHING A PATTERN: THE TRADITIONAL FUNCTION</a><br>  <br><a name="SEC14" href="#TOC1">MATCHING A PATTERN: THE TRADITIONAL FUNCTION</a><br>
1107  <P>  <P>
1108  <b>int pcre_exec(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b>  <b>int pcre_exec(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b>
1109  <b>const char *<i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b>  <b>const char *<i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b>
# Line 947  Extra data for <b>pcre_exec()</b> Line 1151  Extra data for <b>pcre_exec()</b>
1151  If the <i>extra</i> argument is not NULL, it must point to a <b>pcre_extra</b>  If the <i>extra</i> argument is not NULL, it must point to a <b>pcre_extra</b>
1152  data block. The <b>pcre_study()</b> function returns such a block (when it  data block. The <b>pcre_study()</b> function returns such a block (when it
1153  doesn't return NULL), but you can also create one for yourself, and pass  doesn't return NULL), but you can also create one for yourself, and pass
1154  additional information in it. The fields in a <b>pcre_extra</b> block are as  additional information in it. The <b>pcre_extra</b> block contains the following
1155  follows:  fields (not necessarily in this order):
1156  <pre>  <pre>
1157    unsigned long int <i>flags</i>;    unsigned long int <i>flags</i>;
1158    void *<i>study_data</i>;    void *<i>study_data</i>;
1159    unsigned long int <i>match_limit</i>;    unsigned long int <i>match_limit</i>;
1160      unsigned long int <i>match_limit_recursion</i>;
1161    void *<i>callout_data</i>;    void *<i>callout_data</i>;
1162    const unsigned char *<i>tables</i>;    const unsigned char *<i>tables</i>;
1163  </pre>  </pre>
# Line 961  are set. The flag bits are: Line 1166  are set. The flag bits are:
1166  <pre>  <pre>
1167    PCRE_EXTRA_STUDY_DATA    PCRE_EXTRA_STUDY_DATA
1168    PCRE_EXTRA_MATCH_LIMIT    PCRE_EXTRA_MATCH_LIMIT
1169      PCRE_EXTRA_MATCH_LIMIT_RECURSION
1170    PCRE_EXTRA_CALLOUT_DATA    PCRE_EXTRA_CALLOUT_DATA
1171    PCRE_EXTRA_TABLES    PCRE_EXTRA_TABLES
1172  </pre>  </pre>
# Line 977  classic example is the use of nested unl Line 1183  classic example is the use of nested unl
1183  </P>  </P>
1184  <P>  <P>
1185  Internally, PCRE uses a function called <b>match()</b> which it calls repeatedly  Internally, PCRE uses a function called <b>match()</b> which it calls repeatedly
1186  (sometimes recursively). The limit is imposed on the number of times this  (sometimes recursively). The limit set by <i>match_limit</i> is imposed on the
1187  function is called during a match, which has the effect of limiting the amount  number of times this function is called during a match, which has the effect of
1188  of recursion and backtracking that can take place. For patterns that are not  limiting the amount of backtracking that can take place. For patterns that are
1189  anchored, the count starts from zero for each position in the subject string.  not anchored, the count restarts from zero for each position in the subject
1190    string.
1191  </P>  </P>
1192  <P>  <P>
1193  The default limit for the library can be set when PCRE is built; the default  The default value for the limit can be set when PCRE is built; the default
1194  default is 10 million, which handles all but the most extreme cases. You can  default is 10 million, which handles all but the most extreme cases. You can
1195  reduce the default by suppling <b>pcre_exec()</b> with a <b>pcre_extra</b> block  override the default by suppling <b>pcre_exec()</b> with a <b>pcre_extra</b>
1196  in which <i>match_limit</i> is set to a smaller value, and  block in which <i>match_limit</i> is set, and PCRE_EXTRA_MATCH_LIMIT is set in
1197  PCRE_EXTRA_MATCH_LIMIT is set in the <i>flags</i> field. If the limit is  the <i>flags</i> field. If the limit is exceeded, <b>pcre_exec()</b> returns
1198  exceeded, <b>pcre_exec()</b> returns PCRE_ERROR_MATCHLIMIT.  PCRE_ERROR_MATCHLIMIT.
1199    </P>
1200    <P>
1201    The <i>match_limit_recursion</i> field is similar to <i>match_limit</i>, but
1202    instead of limiting the total number of times that <b>match()</b> is called, it
1203    limits the depth of recursion. The recursion depth is a smaller number than the
1204    total number of calls, because not all calls to <b>match()</b> are recursive.
1205    This limit is of use only if it is set smaller than <i>match_limit</i>.
1206    </P>
1207    <P>
1208    Limiting the recursion depth limits the amount of stack that can be used, or,
1209    when PCRE has been compiled to use memory on the heap instead of the stack, the
1210    amount of heap memory that can be used.
1211    </P>
1212    <P>
1213    The default value for <i>match_limit_recursion</i> can be set when PCRE is
1214    built; the default default is the same value as the default for
1215    <i>match_limit</i>. You can override the default by suppling <b>pcre_exec()</b>
1216    with a <b>pcre_extra</b> block in which <i>match_limit_recursion</i> is set, and
1217    PCRE_EXTRA_MATCH_LIMIT_RECURSION is set in the <i>flags</i> field. If the limit
1218    is exceeded, <b>pcre_exec()</b> returns PCRE_ERROR_RECURSIONLIMIT.
1219  </P>  </P>
1220  <P>  <P>
1221  The <i>pcre_callout</i> field is used in conjunction with the "callout" feature,  The <i>pcre_callout</i> field is used in conjunction with the "callout" feature,
# Line 1008  the external tables might be at a differ Line 1235  the external tables might be at a differ
1235  called. See the  called. See the
1236  <a href="pcreprecompile.html"><b>pcreprecompile</b></a>  <a href="pcreprecompile.html"><b>pcreprecompile</b></a>
1237  documentation for a discussion of saving compiled patterns for later use.  documentation for a discussion of saving compiled patterns for later use.
1238  </P>  <a name="execoptions"></a></P>
1239  <br><b>  <br><b>
1240  Option bits for <b>pcre_exec()</b>  Option bits for <b>pcre_exec()</b>
1241  </b><br>  </b><br>
1242  <P>  <P>
1243  The unused bits of the <i>options</i> argument for <b>pcre_exec()</b> must be  The unused bits of the <i>options</i> argument for <b>pcre_exec()</b> must be
1244  zero. The only bits that may be set are PCRE_ANCHORED, PCRE_NOTBOL,  zero. The only bits that may be set are PCRE_ANCHORED, PCRE_NEWLINE_<i>xxx</i>,
1245  PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NO_UTF8_CHECK and PCRE_PARTIAL.  PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NO_UTF8_CHECK and PCRE_PARTIAL.
1246  <pre>  <pre>
1247    PCRE_ANCHORED    PCRE_ANCHORED
1248  </pre>  </pre>
# Line 1024  matching position. If a pattern was comp Line 1251  matching position. If a pattern was comp
1251  to be anchored by virtue of its contents, it cannot be made unachored at  to be anchored by virtue of its contents, it cannot be made unachored at
1252  matching time.  matching time.
1253  <pre>  <pre>
1254      PCRE_BSR_ANYCRLF
1255      PCRE_BSR_UNICODE
1256    </pre>
1257    These options (which are mutually exclusive) control what the \R escape
1258    sequence matches. The choice is either to match only CR, LF, or CRLF, or to
1259    match any Unicode newline sequence. These options override the choice that was
1260    made or defaulted when the pattern was compiled.
1261    <pre>
1262      PCRE_NEWLINE_CR
1263      PCRE_NEWLINE_LF
1264      PCRE_NEWLINE_CRLF
1265      PCRE_NEWLINE_ANYCRLF
1266      PCRE_NEWLINE_ANY
1267    </pre>
1268    These options override the newline definition that was chosen or defaulted when
1269    the pattern was compiled. For details, see the description of
1270    <b>pcre_compile()</b> above. During matching, the newline choice affects the
1271    behaviour of the dot, circumflex, and dollar metacharacters. It may also alter
1272    the way the match position is advanced after a match failure for an unanchored
1273    pattern.
1274    </P>
1275    <P>
1276    When PCRE_NEWLINE_CRLF, PCRE_NEWLINE_ANYCRLF, or PCRE_NEWLINE_ANY is set, and a
1277    match attempt for an unanchored pattern fails when the current position is at a
1278    CRLF sequence, and the pattern contains no explicit matches for CR or LF
1279    characters, the match position is advanced by two characters instead of one, in
1280    other words, to after the CRLF.
1281    </P>
1282    <P>
1283    The above rule is a compromise that makes the most common cases work as
1284    expected. For example, if the pattern is .+A (and the PCRE_DOTALL option is not
1285    set), it does not match the string "\r\nA" because, after failing at the
1286    start, it skips both the CR and the LF before retrying. However, the pattern
1287    [\r\n]A does match that string, because it contains an explicit CR or LF
1288    reference, and so advances only by one character after the first failure.
1289    </P>
1290    <P>
1291    An explicit match for CR of LF is either a literal appearance of one of those
1292    characters, or one of the \r or \n escape sequences. Implicit matches such as
1293    [^X] do not count, nor does \s (which includes CR and LF in the characters
1294    that it matches).
1295    </P>
1296    <P>
1297    Notwithstanding the above, anomalous effects may still occur when CRLF is a
1298    valid newline sequence and explicit \r or \n escapes appear in the pattern.
1299    <pre>
1300    PCRE_NOTBOL    PCRE_NOTBOL
1301  </pre>  </pre>
1302  This option specifies that first character of the subject string is not the  This option specifies that first character of the subject string is not the
# Line 1066  code that demonstrates how to do this in Line 1339  code that demonstrates how to do this in
1339  When PCRE_UTF8 is set at compile time, the validity of the subject as a UTF-8  When PCRE_UTF8 is set at compile time, the validity of the subject as a UTF-8
1340  string is automatically checked when <b>pcre_exec()</b> is subsequently called.  string is automatically checked when <b>pcre_exec()</b> is subsequently called.
1341  The value of <i>startoffset</i> is also checked to ensure that it points to the  The value of <i>startoffset</i> is also checked to ensure that it points to the
1342  start of a UTF-8 character. If an invalid UTF-8 sequence of bytes is found,  start of a UTF-8 character. There is a discussion about the validity of UTF-8
1343  <b>pcre_exec()</b> returns the error PCRE_ERROR_BADUTF8. If <i>startoffset</i>  strings in the
1344  contains an invalid value, PCRE_ERROR_BADUTF8_OFFSET is returned.  <a href="pcre.html#utf8strings">section on UTF-8 support</a>
1345    in the main
1346    <a href="pcre.html"><b>pcre</b></a>
1347    page. If an invalid UTF-8 sequence of bytes is found, <b>pcre_exec()</b> returns
1348    the error PCRE_ERROR_BADUTF8. If <i>startoffset</i> contains an invalid value,
1349    PCRE_ERROR_BADUTF8_OFFSET is returned.
1350  </P>  </P>
1351  <P>  <P>
1352  If you already know that your subject is valid, and you want to skip these  If you already know that your subject is valid, and you want to skip these
# Line 1162  is set to the offset of the first charac Line 1440  is set to the offset of the first charac
1440  first pair, <i>ovector[0]</i> and <i>ovector[1]</i>, identify the portion of the  first pair, <i>ovector[0]</i> and <i>ovector[1]</i>, identify the portion of the
1441  subject string matched by the entire pattern. The next pair is used for the  subject string matched by the entire pattern. The next pair is used for the
1442  first capturing subpattern, and so on. The value returned by <b>pcre_exec()</b>  first capturing subpattern, and so on. The value returned by <b>pcre_exec()</b>
1443  is the number of pairs that have been set. If there are no capturing  is one more than the highest numbered pair that has been set. For example, if
1444  subpatterns, the return value from a successful match is 1, indicating that  two substrings have been captured, the returned value is 3. If there are no
1445  just the first pair of offsets has been set.  capturing subpatterns, the return value from a successful match is 1,
1446  </P>  indicating that just the first pair of offsets has been set.
 <P>  
 Some convenience functions are provided for extracting the captured substrings  
 as separate strings. These are described in the following section.  
 </P>  
 <P>  
 It is possible for an capturing subpattern number <i>n+1</i> to match some  
 part of the subject when subpattern <i>n</i> has not been used at all. For  
 example, if the string "abc" is matched against the pattern (a|(z))(bc)  
 subpatterns 1 and 3 are matched, but 2 is not. When this happens, both offset  
 values corresponding to the unused subpattern are set to -1.  
1447  </P>  </P>
1448  <P>  <P>
1449  If a capturing subpattern is matched repeatedly, it is the last portion of the  If a capturing subpattern is matched repeatedly, it is the last portion of the
# Line 1192  has to get additional memory for use dur Line 1460  has to get additional memory for use dur
1460  advisable to supply an <i>ovector</i>.  advisable to supply an <i>ovector</i>.
1461  </P>  </P>
1462  <P>  <P>
1463  Note that <b>pcre_info()</b> can be used to find out how many capturing  The <b>pcre_info()</b> function can be used to find out how many capturing
1464  subpatterns there are in a compiled pattern. The smallest size for  subpatterns there are in a compiled pattern. The smallest size for
1465  <i>ovector</i> that will allow for <i>n</i> captured substrings, in addition to  <i>ovector</i> that will allow for <i>n</i> captured substrings, in addition to
1466  the offsets of the substring matched by the whole pattern, is (<i>n</i>+1)*3.  the offsets of the substring matched by the whole pattern, is (<i>n</i>+1)*3.
1467    </P>
1468    <P>
1469    It is possible for capturing subpattern number <i>n+1</i> to match some part of
1470    the subject when subpattern <i>n</i> has not been used at all. For example, if
1471    the string "abc" is matched against the pattern (a|(z))(bc) the return from the
1472    function is 4, and subpatterns 1 and 3 are matched, but 2 is not. When this
1473    happens, both values in the offset pairs corresponding to unused subpatterns
1474    are set to -1.
1475    </P>
1476    <P>
1477    Offset values that correspond to unused subpatterns at the end of the
1478    expression are also set to -1. For example, if the string "abc" is matched
1479    against the pattern (abc)(x(yz)?)? subpatterns 2 and 3 are not matched. The
1480    return from the function is 2, because the highest used capturing subpattern
1481    number is 1. However, you can refer to the offsets for the second and third
1482    capturing subpatterns if you wish (assuming the vector is large enough, of
1483    course).
1484    </P>
1485    <P>
1486    Some convenience functions are provided for extracting the captured substrings
1487    as separate strings. These are described below.
1488  <a name="errorlist"></a></P>  <a name="errorlist"></a></P>
1489  <br><b>  <br><b>
1490  Return values from <b>pcre_exec()</b>  Error return values from <b>pcre_exec()</b>
1491  </b><br>  </b><br>
1492  <P>  <P>
1493  If <b>pcre_exec()</b> fails, it returns a negative number. The following are  If <b>pcre_exec()</b> fails, it returns a negative number. The following are
# Line 1225  compiled in an environment of one endian Line 1514  compiled in an environment of one endian
1514  other endianness. This is the error that PCRE gives when the magic number is  other endianness. This is the error that PCRE gives when the magic number is
1515  not present.  not present.
1516  <pre>  <pre>
1517    PCRE_ERROR_UNKNOWN_NODE   (-5)    PCRE_ERROR_UNKNOWN_OPCODE (-5)
1518  </pre>  </pre>
1519  While running the pattern match, an unknown item was encountered in the  While running the pattern match, an unknown item was encountered in the
1520  compiled pattern. This error could be caused by a bug in PCRE or by overwriting  compiled pattern. This error could be caused by a bug in PCRE or by overwriting
# Line 1247  below). It is never returned by <b>pcre_ Line 1536  below). It is never returned by <b>pcre_
1536  <pre>  <pre>
1537    PCRE_ERROR_MATCHLIMIT     (-8)    PCRE_ERROR_MATCHLIMIT     (-8)
1538  </pre>  </pre>
1539  The recursion and backtracking limit, as specified by the <i>match_limit</i>  The backtracking limit, as specified by the <i>match_limit</i> field in a
1540  field in a <b>pcre_extra</b> structure (or defaulted) was reached. See the  <b>pcre_extra</b> structure (or defaulted) was reached. See the description
1541  description above.  above.
1542  <pre>  <pre>
1543    PCRE_ERROR_CALLOUT        (-9)    PCRE_ERROR_CALLOUT        (-9)
1544  </pre>  </pre>
# Line 1288  in PCRE or by overwriting of the compile Line 1577  in PCRE or by overwriting of the compile
1577    PCRE_ERROR_BADCOUNT       (-15)    PCRE_ERROR_BADCOUNT       (-15)
1578  </pre>  </pre>
1579  This error is given if the value of the <i>ovecsize</i> argument is negative.  This error is given if the value of the <i>ovecsize</i> argument is negative.
1580    <pre>
1581      PCRE_ERROR_RECURSIONLIMIT (-21)
1582    </pre>
1583    The internal recursion limit, as specified by the <i>match_limit_recursion</i>
1584    field in a <b>pcre_extra</b> structure (or defaulted) was reached. See the
1585    description above.
1586    <pre>
1587      PCRE_ERROR_BADNEWLINE     (-23)
1588    </pre>
1589    An invalid combination of PCRE_NEWLINE_<i>xxx</i> options was given.
1590    </P>
1591    <P>
1592    Error numbers -16 to -20 and -22 are not used by <b>pcre_exec()</b>.
1593  </P>  </P>
1594  <br><a name="SEC14" href="#TOC1">EXTRACTING CAPTURED SUBSTRINGS BY NUMBER</a><br>  <br><a name="SEC15" href="#TOC1">EXTRACTING CAPTURED SUBSTRINGS BY NUMBER</a><br>
1595  <P>  <P>
1596  <b>int pcre_copy_substring(const char *<i>subject</i>, int *<i>ovector</i>,</b>  <b>int pcre_copy_substring(const char *<i>subject</i>, int *<i>ovector</i>,</b>
1597  <b>int <i>stringcount</i>, int <i>stringnumber</i>, char *<i>buffer</i>,</b>  <b>int <i>stringcount</i>, int <i>stringnumber</i>, char *<i>buffer</i>,</b>
# Line 1311  Captured substrings can be accessed dire Line 1613  Captured substrings can be accessed dire
1613  <b>pcre_get_substring_list()</b> are provided for extracting captured substrings  <b>pcre_get_substring_list()</b> are provided for extracting captured substrings
1614  as new, separate, zero-terminated strings. These functions identify substrings  as new, separate, zero-terminated strings. These functions identify substrings
1615  by number. The next section describes functions for extracting named  by number. The next section describes functions for extracting named
1616  substrings. A substring that contains a binary zero is correctly extracted and  substrings.
1617  has a further zero added on the end, but the result is not, of course,  </P>
1618  a C string.  <P>
1619    A substring that contains a binary zero is correctly extracted and has a
1620    further zero added on the end, but the result is not, of course, a C string.
1621    However, you can process such a string by referring to the length that is
1622    returned by <b>pcre_copy_substring()</b> and <b>pcre_get_substring()</b>.
1623    Unfortunately, the interface to <b>pcre_get_substring_list()</b> is not adequate
1624    for handling strings containing binary zeros, because the end of the final
1625    string is not independently indicated.
1626  </P>  </P>
1627  <P>  <P>
1628  The first three arguments are the same for all three of these functions:  The first three arguments are the same for all three of these functions:
# Line 1335  the string is placed in <i>buffer</i>, w Line 1644  the string is placed in <i>buffer</i>, w
1644  <i>buffersize</i>, while for <b>pcre_get_substring()</b> a new block of memory is  <i>buffersize</i>, while for <b>pcre_get_substring()</b> a new block of memory is
1645  obtained via <b>pcre_malloc</b>, and its address is returned via  obtained via <b>pcre_malloc</b>, and its address is returned via
1646  <i>stringptr</i>. The yield of the function is the length of the string, not  <i>stringptr</i>. The yield of the function is the length of the string, not
1647  including the terminating zero, or one of  including the terminating zero, or one of these error codes:
1648  <pre>  <pre>
1649    PCRE_ERROR_NOMEMORY       (-6)    PCRE_ERROR_NOMEMORY       (-6)
1650  </pre>  </pre>
# Line 1352  and builds a list of pointers to them. A Line 1661  and builds a list of pointers to them. A
1661  memory that is obtained via <b>pcre_malloc</b>. The address of the memory block  memory that is obtained via <b>pcre_malloc</b>. The address of the memory block
1662  is returned via <i>listptr</i>, which is also the start of the list of string  is returned via <i>listptr</i>, which is also the start of the list of string
1663  pointers. The end of the list is marked by a NULL pointer. The yield of the  pointers. The end of the list is marked by a NULL pointer. The yield of the
1664  function is zero if all went well, or  function is zero if all went well, or the error code
1665  <pre>  <pre>
1666    PCRE_ERROR_NOMEMORY       (-6)    PCRE_ERROR_NOMEMORY       (-6)
1667  </pre>  </pre>
# Line 1373  a previous call of <b>pcre_get_substring Line 1682  a previous call of <b>pcre_get_substring
1682  <b>pcre_get_substring_list()</b>, respectively. They do nothing more than call  <b>pcre_get_substring_list()</b>, respectively. They do nothing more than call
1683  the function pointed to by <b>pcre_free</b>, which of course could be called  the function pointed to by <b>pcre_free</b>, which of course could be called
1684  directly from a C program. However, PCRE is used in some situations where it is  directly from a C program. However, PCRE is used in some situations where it is
1685  linked via a special interface to another programming language which cannot use  linked via a special interface to another programming language that cannot use
1686  <b>pcre_free</b> directly; it is for these cases that the functions are  <b>pcre_free</b> directly; it is for these cases that the functions are
1687  provided.  provided.
1688  </P>  </P>
1689  <br><a name="SEC15" href="#TOC1">EXTRACTING CAPTURED SUBSTRINGS BY NAME</a><br>  <br><a name="SEC16" href="#TOC1">EXTRACTING CAPTURED SUBSTRINGS BY NAME</a><br>
1690  <P>  <P>
1691  <b>int pcre_get_stringnumber(const pcre *<i>code</i>,</b>  <b>int pcre_get_stringnumber(const pcre *<i>code</i>,</b>
1692  <b>const char *<i>name</i>);</b>  <b>const char *<i>name</i>);</b>
# Line 1400  For example, for this pattern Line 1709  For example, for this pattern
1709  <pre>  <pre>
1710    (a+)b(?&#60;xxx&#62;\d+)...    (a+)b(?&#60;xxx&#62;\d+)...
1711  </pre>  </pre>
1712  the number of the subpattern called "xxx" is 2. You can find the number from  the number of the subpattern called "xxx" is 2. If the name is known to be
1713  the name by calling <b>pcre_get_stringnumber()</b>. The first argument is the  unique (PCRE_DUPNAMES was not set), you can find the number from the name by
1714  compiled pattern, and the second is the name. The yield of the function is the  calling <b>pcre_get_stringnumber()</b>. The first argument is the compiled
1715    pattern, and the second is the name. The yield of the function is the
1716  subpattern number, or PCRE_ERROR_NOSUBSTRING (-7) if there is no subpattern of  subpattern number, or PCRE_ERROR_NOSUBSTRING (-7) if there is no subpattern of
1717  that name.  that name.
1718  </P>  </P>
# Line 1412  functions described in the previous sect Line 1722  functions described in the previous sect
1722  two functions that do the whole job.  two functions that do the whole job.
1723  </P>  </P>
1724  <P>  <P>
1725  Most of the arguments of <i>pcre_copy_named_substring()</i> and  Most of the arguments of <b>pcre_copy_named_substring()</b> and
1726  <i>pcre_get_named_substring()</i> are the same as those for the similarly named  <b>pcre_get_named_substring()</b> are the same as those for the similarly named
1727  functions that extract by number. As these are described in the previous  functions that extract by number. As these are described in the previous
1728  section, they are not re-described here. There are just two differences:  section, they are not re-described here. There are just two differences:
1729  </P>  </P>
# Line 1425  translation table. Line 1735  translation table.
1735  </P>  </P>
1736  <P>  <P>
1737  These functions call <b>pcre_get_stringnumber()</b>, and if it succeeds, they  These functions call <b>pcre_get_stringnumber()</b>, and if it succeeds, they
1738  then call <i>pcre_copy_substring()</i> or <i>pcre_get_substring()</i>, as  then call <b>pcre_copy_substring()</b> or <b>pcre_get_substring()</b>, as
1739  appropriate.  appropriate. <b>NOTE:</b> If PCRE_DUPNAMES is set and there are duplicate names,
1740    the behaviour may not be what you want (see the next section).
1741  </P>  </P>
1742  <br><a name="SEC16" href="#TOC1">FINDING ALL POSSIBLE MATCHES</a><br>  <br><a name="SEC17" href="#TOC1">DUPLICATE SUBPATTERN NAMES</a><br>
1743    <P>
1744    <b>int pcre_get_stringtable_entries(const pcre *<i>code</i>,</b>
1745    <b>const char *<i>name</i>, char **<i>first</i>, char **<i>last</i>);</b>
1746    </P>
1747    <P>
1748    When a pattern is compiled with the PCRE_DUPNAMES option, names for subpatterns
1749    are not required to be unique. Normally, patterns with duplicate names are such
1750    that in any one match, only one of the named subpatterns participates. An
1751    example is shown in the
1752    <a href="pcrepattern.html"><b>pcrepattern</b></a>
1753    documentation.
1754    </P>
1755    <P>
1756    When duplicates are present, <b>pcre_copy_named_substring()</b> and
1757    <b>pcre_get_named_substring()</b> return the first substring corresponding to
1758    the given name that is set. If none are set, PCRE_ERROR_NOSUBSTRING (-7) is
1759    returned; no data is returned. The <b>pcre_get_stringnumber()</b> function
1760    returns one of the numbers that are associated with the name, but it is not
1761    defined which it is.
1762    </P>
1763    <P>
1764    If you want to get full details of all captured substrings for a given name,
1765    you must use the <b>pcre_get_stringtable_entries()</b> function. The first
1766    argument is the compiled pattern, and the second is the name. The third and
1767    fourth are pointers to variables which are updated by the function. After it
1768    has run, they point to the first and last entries in the name-to-number table
1769    for the given name. The function itself returns the length of each entry, or
1770    PCRE_ERROR_NOSUBSTRING (-7) if there are none. The format of the table is
1771    described above in the section entitled <i>Information about a pattern</i>.
1772    Given all the relevant entries for the name, you can extract each of their
1773    numbers, and hence the captured data, if any.
1774    </P>
1775    <br><a name="SEC18" href="#TOC1">FINDING ALL POSSIBLE MATCHES</a><br>
1776  <P>  <P>
1777  The traditional matching function uses a similar algorithm to Perl, which stops  The traditional matching function uses a similar algorithm to Perl, which stops
1778  when it finds the first match, starting at a given point in the subject. If you  when it finds the first match, starting at a given point in the subject. If you
# Line 1447  substring. Then return 1, which forces < Line 1791  substring. Then return 1, which forces <
1791  other alternatives. Ultimately, when it runs out of matches, <b>pcre_exec()</b>  other alternatives. Ultimately, when it runs out of matches, <b>pcre_exec()</b>
1792  will yield PCRE_ERROR_NOMATCH.  will yield PCRE_ERROR_NOMATCH.
1793  <a name="dfamatch"></a></P>  <a name="dfamatch"></a></P>
1794  <br><a name="SEC17" href="#TOC1">MATCHING A PATTERN: THE ALTERNATIVE FUNCTION</a><br>  <br><a name="SEC19" href="#TOC1">MATCHING A PATTERN: THE ALTERNATIVE FUNCTION</a><br>
1795  <P>  <P>
1796  <b>int pcre_dfa_exec(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b>  <b>int pcre_dfa_exec(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b>
1797  <b>const char *<i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b>  <b>const char *<i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b>
# Line 1456  will yield PCRE_ERROR_NOMATCH. Line 1800  will yield PCRE_ERROR_NOMATCH.
1800  </P>  </P>
1801  <P>  <P>
1802  The function <b>pcre_dfa_exec()</b> is called to match a subject string against  The function <b>pcre_dfa_exec()</b> is called to match a subject string against
1803  a compiled pattern, using a "DFA" matching algorithm. This has different  a compiled pattern, using a matching algorithm that scans the subject string
1804  characteristics to the normal algorithm, and is not compatible with Perl. Some  just once, and does not backtrack. This has different characteristics to the
1805  of the features of PCRE patterns are not supported. Nevertheless, there are  normal algorithm, and is not compatible with Perl. Some of the features of PCRE
1806  times when this kind of matching can be useful. For a discussion of the two  patterns are not supported. Nevertheless, there are times when this kind of
1807  matching algorithms, see the  matching can be useful. For a discussion of the two matching algorithms, see
1808    the
1809  <a href="pcrematching.html"><b>pcrematching</b></a>  <a href="pcrematching.html"><b>pcrematching</b></a>
1810  documentation.  documentation.
1811  </P>  </P>
# Line 1475  here. Line 1820  here.
1820  The two additional arguments provide workspace for the function. The workspace  The two additional arguments provide workspace for the function. The workspace
1821  vector should contain at least 20 elements. It is used for keeping track of  vector should contain at least 20 elements. It is used for keeping track of
1822  multiple paths through the pattern tree. More workspace will be needed for  multiple paths through the pattern tree. More workspace will be needed for
1823  patterns and subjects where there are a lot of possible matches.  patterns and subjects where there are a lot of potential matches.
1824  </P>  </P>
1825  <P>  <P>
1826  Here is an example of a simple call to <b>pcre_exec()</b>:  Here is an example of a simple call to <b>pcre_dfa_exec()</b>:
1827  <pre>  <pre>
1828    int rc;    int rc;
1829    int ovector[10];    int ovector[10];
1830    int wspace[20];    int wspace[20];
1831    rc = pcre_exec(    rc = pcre_dfa_exec(
1832      re,             /* result of pcre_compile() */      re,             /* result of pcre_compile() */
1833      NULL,           /* we didn't study the pattern */      NULL,           /* we didn't study the pattern */
1834      "some string",  /* the subject string */      "some string",  /* the subject string */
# Line 1501  Option bits for <b>pcre_dfa_exec()</b> Line 1846  Option bits for <b>pcre_dfa_exec()</b>
1846  </b><br>  </b><br>
1847  <P>  <P>
1848  The unused bits of the <i>options</i> argument for <b>pcre_dfa_exec()</b> must be  The unused bits of the <i>options</i> argument for <b>pcre_dfa_exec()</b> must be
1849  zero. The only bits that may be set are PCRE_ANCHORED, PCRE_NOTBOL,  zero. The only bits that may be set are PCRE_ANCHORED, PCRE_NEWLINE_<i>xxx</i>,
1850  PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NO_UTF8_CHECK, PCRE_PARTIAL,  PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NO_UTF8_CHECK, PCRE_PARTIAL,
1851  PCRE_DFA_SHORTEST, and PCRE_DFA_RESTART. All but the last three of these are  PCRE_DFA_SHORTEST, and PCRE_DFA_RESTART. All but the last three of these are
1852  the same as for <b>pcre_exec()</b>, so their description is not repeated here.  the same as for <b>pcre_exec()</b>, so their description is not repeated here.
1853  <pre>  <pre>
# Line 1519  matching string. Line 1864  matching string.
1864    PCRE_DFA_SHORTEST    PCRE_DFA_SHORTEST
1865  </pre>  </pre>
1866  Setting the PCRE_DFA_SHORTEST option causes the matching algorithm to stop as  Setting the PCRE_DFA_SHORTEST option causes the matching algorithm to stop as
1867  soon as it has found one match. Because of the way the DFA algorithm works,  soon as it has found one match. Because of the way the alternative algorithm
1868  this is necessarily the shortest possible match at the first possible matching  works, this is necessarily the shortest possible match at the first possible
1869  point in the subject string.  matching point in the subject string.
1870  <pre>  <pre>
1871    PCRE_DFA_RESTART    PCRE_DFA_RESTART
1872  </pre>  </pre>
# Line 1559  the three matched strings are Line 1904  the three matched strings are
1904  On success, the yield of the function is a number greater than zero, which is  On success, the yield of the function is a number greater than zero, which is
1905  the number of matched substrings. The substrings themselves are returned in  the number of matched substrings. The substrings themselves are returned in
1906  <i>ovector</i>. Each string uses two elements; the first is the offset to the  <i>ovector</i>. Each string uses two elements; the first is the offset to the
1907  start, and the second is the offset to the end. All the strings have the same  start, and the second is the offset to the end. In fact, all the strings have
1908  start offset. (Space could have been saved by giving this only once, but it was  the same start offset. (Space could have been saved by giving this only once,
1909  decided to retain some compatibility with the way <b>pcre_exec()</b> returns  but it was decided to retain some compatibility with the way <b>pcre_exec()</b>
1910  data, even though the meaning of the strings is different.)  returns data, even though the meaning of the strings is different.)
1911  </P>  </P>
1912  <P>  <P>
1913  The strings are returned in reverse order of length; that is, the longest  The strings are returned in reverse order of length; that is, the longest
# Line 1588  that it does not support, for instance, Line 1933  that it does not support, for instance,
1933  <pre>  <pre>
1934    PCRE_ERROR_DFA_UCOND      (-17)    PCRE_ERROR_DFA_UCOND      (-17)
1935  </pre>  </pre>
1936  This return is given if <b>pcre_dfa_exec()</b> encounters a condition item in a  This return is given if <b>pcre_dfa_exec()</b> encounters a condition item that
1937  pattern that uses a back reference for the condition. This is not supported.  uses a back reference for the condition, or a test for recursion in a specific
1938    group. These are not supported.
1939  <pre>  <pre>
1940    PCRE_ERROR_DFA_UMLIMIT    (-18)    PCRE_ERROR_DFA_UMLIMIT    (-18)
1941  </pre>  </pre>
# Line 1609  recursively, using private vectors for < Line 1955  recursively, using private vectors for <
1955  error is given if the output vector is not large enough. This should be  error is given if the output vector is not large enough. This should be
1956  extremely rare, as a vector of size 1000 is used.  extremely rare, as a vector of size 1000 is used.
1957  </P>  </P>
1958    <br><a name="SEC20" href="#TOC1">SEE ALSO</a><br>
1959    <P>
1960    <b>pcrebuild</b>(3), <b>pcrecallout</b>(3), <b>pcrecpp(3)</b>(3),
1961    <b>pcrematching</b>(3), <b>pcrepartial</b>(3), <b>pcreposix</b>(3),
1962    <b>pcreprecompile</b>(3), <b>pcresample</b>(3), <b>pcrestack</b>(3).
1963    </P>
1964    <br><a name="SEC21" href="#TOC1">AUTHOR</a><br>
1965  <P>  <P>
1966  Last updated: 16 May 2005  Philip Hazel
1967    <br>
1968    University Computing Service
1969    <br>
1970    Cambridge CB2 3QH, England.
1971    <br>
1972    </P>
1973    <br><a name="SEC22" href="#TOC1">REVISION</a><br>
1974    <P>
1975    Last updated: 12 April 2008
1976    <br>
1977    Copyright &copy; 1997-2008 University of Cambridge.
1978  <br>  <br>
 Copyright &copy; 1997-2005 University of Cambridge.  
1979  <p>  <p>
1980  Return to the <a href="index.html">PCRE index page</a>.  Return to the <a href="index.html">PCRE index page</a>.
1981  </p>  </p>

Legend:
Removed from v.77  
changed lines
  Added in v.345

  ViewVC Help
Powered by ViewVC 1.1.5