/[pcre]/code/trunk/doc/pcre.txt
ViewVC logotype

Diff of /code/trunk/doc/pcre.txt

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

revision 358 by ph10, Wed Jul 9 11:03:07 2008 UTC revision 835 by ph10, Wed Dec 28 16:10:09 2011 UTC
# Line 2  Line 2 
2  This file contains a concatenation of the PCRE man pages, converted to plain  This file contains a concatenation of the PCRE man pages, converted to plain
3  text format for ease of searching with a text editor, or for use on systems  text format for ease of searching with a text editor, or for use on systems
4  that do not have a man page processor. The small individual files that give  that do not have a man page processor. The small individual files that give
5  synopses of each function in the library have not been included. There are  synopses of each function in the library have not been included. Neither has
6  separate text files for the pcregrep and pcretest commands.  the pcredemo program. There are separate text files for the pcregrep and
7    pcretest commands.
8  -----------------------------------------------------------------------------  -----------------------------------------------------------------------------
9    
10    
# Line 18  INTRODUCTION Line 19  INTRODUCTION
19    
20         The  PCRE  library is a set of functions that implement regular expres-         The  PCRE  library is a set of functions that implement regular expres-
21         sion pattern matching using the same syntax and semantics as Perl, with         sion pattern matching using the same syntax and semantics as Perl, with
22         just  a  few  differences. Certain features that appeared in Python and         just  a few differences. Some features that appeared in Python and PCRE
23         PCRE before they appeared in Perl are also available using  the  Python         before they appeared in Perl are also available using the  Python  syn-
24         syntax.  There is also some support for certain .NET and Oniguruma syn-         tax,  there  is  some  support for one or two .NET and Oniguruma syntax
25         tax items, and there is an option for  requesting  some  minor  changes         items, and there is an option for requesting some  minor  changes  that
26         that give better JavaScript compatibility.         give better JavaScript compatibility.
27    
28         The  current  implementation of PCRE (release 7.x) corresponds approxi-         The  current implementation of PCRE corresponds approximately with Perl
29         mately with Perl 5.10, including support for UTF-8 encoded strings  and         5.12, including support for UTF-8 encoded strings and  Unicode  general
30         Unicode general category properties. However, UTF-8 and Unicode support         category  properties.  However,  UTF-8  and  Unicode  support has to be
31         has to be explicitly enabled; it is not the default. The Unicode tables         explicitly enabled; it is not the default. The  Unicode  tables  corre-
32         correspond to Unicode release 5.0.0.         spond to Unicode release 6.0.0.
33    
34         In  addition to the Perl-compatible matching function, PCRE contains an         In  addition to the Perl-compatible matching function, PCRE contains an
35         alternative matching function that matches the same  compiled  patterns         alternative function that matches the same compiled patterns in a  dif-
36         in  a different way. In certain circumstances, the alternative function         ferent way. In certain circumstances, the alternative function has some
37         has some advantages. For a discussion of the two  matching  algorithms,         advantages.  For a discussion of the two matching algorithms,  see  the
38         see the pcrematching page.         pcrematching page.
39    
40         PCRE  is  written  in C and released as a C library. A number of people         PCRE  is  written  in C and released as a C library. A number of people
41         have written wrappers and interfaces of various kinds.  In  particular,         have written wrappers and interfaces of various kinds.  In  particular,
# Line 54  INTRODUCTION Line 55  INTRODUCTION
55         library is built. The pcre_config() function makes it  possible  for  a         library is built. The pcre_config() function makes it  possible  for  a
56         client  to  discover  which  features are available. The features them-         client  to  discover  which  features are available. The features them-
57         selves are described in the pcrebuild page. Documentation about  build-         selves are described in the pcrebuild page. Documentation about  build-
58         ing  PCRE for various operating systems can be found in the README file         ing  PCRE  for various operating systems can be found in the README and
59         in the source distribution.         NON-UNIX-USE files in the source distribution.
60    
61         The library contains a number of undocumented  internal  functions  and         The library contains a number of undocumented  internal  functions  and
62         data  tables  that  are  used by more than one of the exported external         data  tables  that  are  used by more than one of the exported external
# Line 71  USER DOCUMENTATION Line 72  USER DOCUMENTATION
72         The user documentation for PCRE comprises a number  of  different  sec-         The user documentation for PCRE comprises a number  of  different  sec-
73         tions.  In the "man" format, each of these is a separate "man page". In         tions.  In the "man" format, each of these is a separate "man page". In
74         the HTML format, each is a separate page, linked from the  index  page.         the HTML format, each is a separate page, linked from the  index  page.
75         In  the  plain text format, all the sections are concatenated, for ease         In  the  plain  text format, all the sections, except the pcredemo sec-
76         of searching. The sections are as follows:         tion, are concatenated, for ease of searching. The sections are as fol-
77           lows:
78    
79           pcre              this document           pcre              this document
80           pcre-config       show PCRE installation configuration information           pcre-config       show PCRE installation configuration information
# Line 81  USER DOCUMENTATION Line 83  USER DOCUMENTATION
83           pcrecallout       details of the callout feature           pcrecallout       details of the callout feature
84           pcrecompat        discussion of Perl compatibility           pcrecompat        discussion of Perl compatibility
85           pcrecpp           details of the C++ wrapper           pcrecpp           details of the C++ wrapper
86             pcredemo          a demonstration C program that uses PCRE
87           pcregrep          description of the pcregrep command           pcregrep          description of the pcregrep command
88             pcrejit           discussion of the just-in-time optimization support
89             pcrelimits        details of size and other limits
90           pcrematching      discussion of the two matching algorithms           pcrematching      discussion of the two matching algorithms
91           pcrepartial       details of the partial matching facility           pcrepartial       details of the partial matching facility
92           pcrepattern       syntax and semantics of supported           pcrepattern       syntax and semantics of supported
93                               regular expressions                               regular expressions
          pcresyntax        quick syntax reference  
94           pcreperform       discussion of performance issues           pcreperform       discussion of performance issues
95           pcreposix         the POSIX-compatible C API           pcreposix         the POSIX-compatible C API
96           pcreprecompile    details of saving and re-using precompiled patterns           pcreprecompile    details of saving and re-using precompiled patterns
97           pcresample        discussion of the sample program           pcresample        discussion of the pcredemo program
98           pcrestack         discussion of stack usage           pcrestack         discussion of stack usage
99             pcresyntax        quick syntax reference
100           pcretest          description of the pcretest testing command           pcretest          description of the pcretest testing command
101             pcreunicode       discussion of Unicode and UTF-8 support
102    
103         In  addition,  in the "man" and HTML formats, there is a short page for         In  addition,  in the "man" and HTML formats, there is a short page for
104         each C library function, listing its arguments and results.         each C library function, listing its arguments and results.
105    
106    
 LIMITATIONS  
   
        There are some size limitations in PCRE but it is hoped that they  will  
        never in practice be relevant.  
   
        The  maximum  length of a compiled pattern is 65539 (sic) bytes if PCRE  
        is compiled with the default internal linkage size of 2. If you want to  
        process  regular  expressions  that are truly enormous, you can compile  
        PCRE with an internal linkage size of 3 or 4 (see the  README  file  in  
        the  source  distribution and the pcrebuild documentation for details).  
        In these cases the limit is substantially larger.  However,  the  speed  
        of execution is slower.  
   
        All values in repeating quantifiers must be less than 65536.  
   
        There is no limit to the number of parenthesized subpatterns, but there  
        can be no more than 65535 capturing subpatterns.  
   
        The maximum length of name for a named subpattern is 32 characters, and  
        the maximum number of named subpatterns is 10000.  
   
        The  maximum  length of a subject string is the largest positive number  
        that an integer variable can hold. However, when using the  traditional  
        matching function, PCRE uses recursion to handle subpatterns and indef-  
        inite repetition.  This means that the available stack space may  limit  
        the size of a subject string that can be processed by certain patterns.  
        For a discussion of stack issues, see the pcrestack documentation.  
   
   
 UTF-8 AND UNICODE PROPERTY SUPPORT  
   
        From release 3.3, PCRE has  had  some  support  for  character  strings  
        encoded  in the UTF-8 format. For release 4.0 this was greatly extended  
        to cover most common requirements, and in release 5.0  additional  sup-  
        port for Unicode general category properties was added.  
   
        In  order  process  UTF-8 strings, you must build PCRE to include UTF-8  
        support in the code, and, in addition,  you  must  call  pcre_compile()  
        with  the PCRE_UTF8 option flag. When you do this, both the pattern and  
        any subject strings that are matched against it are  treated  as  UTF-8  
        strings instead of just strings of bytes.  
   
        If  you compile PCRE with UTF-8 support, but do not use it at run time,  
        the library will be a bit bigger, but the additional run time  overhead  
        is limited to testing the PCRE_UTF8 flag occasionally, so should not be  
        very big.  
   
        If PCRE is built with Unicode character property support (which implies  
        UTF-8  support),  the  escape sequences \p{..}, \P{..}, and \X are sup-  
        ported.  The available properties that can be tested are limited to the  
        general  category  properties such as Lu for an upper case letter or Nd  
        for a decimal number, the Unicode script names such as Arabic  or  Han,  
        and  the  derived  properties  Any  and L&. A full list is given in the  
        pcrepattern documentation. Only the short names for properties are sup-  
        ported.  For example, \p{L} matches a letter. Its Perl synonym, \p{Let-  
        ter}, is not supported.  Furthermore,  in  Perl,  many  properties  may  
        optionally  be  prefixed by "Is", for compatibility with Perl 5.6. PCRE  
        does not support this.  
   
    Validity of UTF-8 strings  
   
        When you set the PCRE_UTF8 flag, the strings  passed  as  patterns  and  
        subjects are (by default) checked for validity on entry to the relevant  
        functions. From release 7.3 of PCRE, the check is according  the  rules  
        of  RFC  3629, which are themselves derived from the Unicode specifica-  
        tion. Earlier releases of PCRE followed the rules of  RFC  2279,  which  
        allows  the  full range of 31-bit values (0 to 0x7FFFFFFF). The current  
        check allows only values in the range U+0 to U+10FFFF, excluding U+D800  
        to U+DFFF.  
   
        The  excluded  code  points are the "Low Surrogate Area" of Unicode, of  
        which the Unicode Standard says this: "The Low Surrogate Area does  not  
        contain  any  character  assignments,  consequently  no  character code  
        charts or namelists are provided for this area. Surrogates are reserved  
        for  use  with  UTF-16 and then must be used in pairs." The code points  
        that are encoded by UTF-16 pairs  are  available  as  independent  code  
        points  in  the  UTF-8  encoding.  (In other words, the whole surrogate  
        thing is a fudge for UTF-16 which unfortunately messes up UTF-8.)  
   
        If an  invalid  UTF-8  string  is  passed  to  PCRE,  an  error  return  
        (PCRE_ERROR_BADUTF8) is given. In some situations, you may already know  
        that your strings are valid, and therefore want to skip these checks in  
        order to improve performance. If you set the PCRE_NO_UTF8_CHECK flag at  
        compile time or at run time, PCRE assumes that the pattern  or  subject  
        it  is  given  (respectively)  contains only valid UTF-8 codes. In this  
        case, it does not diagnose an invalid UTF-8 string.  
   
        If you pass an invalid UTF-8 string  when  PCRE_NO_UTF8_CHECK  is  set,  
        what  happens  depends on why the string is invalid. If the string con-  
        forms to the "old" definition of UTF-8 (RFC 2279), it is processed as a  
        string  of  characters  in  the  range 0 to 0x7FFFFFFF. In other words,  
        apart from the initial validity test, PCRE (when in UTF-8 mode) handles  
        strings  according  to  the more liberal rules of RFC 2279. However, if  
        the string does not even conform to RFC 2279, the result is  undefined.  
        Your program may crash.  
   
        If  you  want  to  process  strings  of  values  in the full range 0 to  
        0x7FFFFFFF, encoded in a UTF-8-like manner as per the old RFC, you  can  
        set PCRE_NO_UTF8_CHECK to bypass the more restrictive test. However, in  
        this situation, you will have to apply your own validity check.  
   
    General comments about UTF-8 mode  
   
        1. An unbraced hexadecimal escape sequence (such  as  \xb3)  matches  a  
        two-byte UTF-8 character if the value is greater than 127.  
   
        2.  Octal  numbers  up to \777 are recognized, and match two-byte UTF-8  
        characters for values greater than \177.  
   
        3. Repeat quantifiers apply to complete UTF-8 characters, not to  indi-  
        vidual bytes, for example: \x{100}{3}.  
   
        4.  The dot metacharacter matches one UTF-8 character instead of a sin-  
        gle byte.  
   
        5. The escape sequence \C can be used to match a single byte  in  UTF-8  
        mode,  but  its  use can lead to some strange effects. This facility is  
        not available in the alternative matching function, pcre_dfa_exec().  
   
        6. The character escapes \b, \B, \d, \D, \s, \S, \w, and  \W  correctly  
        test  characters of any code value, but the characters that PCRE recog-  
        nizes as digits, spaces, or word characters  remain  the  same  set  as  
        before, all with values less than 256. This remains true even when PCRE  
        includes Unicode property support, because to do otherwise  would  slow  
        down  PCRE in many common cases. If you really want to test for a wider  
        sense of, say, "digit", you must use Unicode  property  tests  such  as  
        \p{Nd}.  
   
        7.  Similarly,  characters that match the POSIX named character classes  
        are all low-valued characters.  
   
        8. However, the Perl 5.10 horizontal and vertical  whitespace  matching  
        escapes (\h, \H, \v, and \V) do match all the appropriate Unicode char-  
        acters.  
   
        9. Case-insensitive matching applies only to  characters  whose  values  
        are  less than 128, unless PCRE is built with Unicode property support.  
        Even when Unicode property support is available, PCRE  still  uses  its  
        own  character  tables when checking the case of low-valued characters,  
        so as not to degrade performance.  The Unicode property information  is  
        used only for characters with higher values. Even when Unicode property  
        support is available, PCRE supports case-insensitive matching only when  
        there  is  a  one-to-one  mapping between a letter's cases. There are a  
        small number of many-to-one mappings in Unicode;  these  are  not  sup-  
        ported by PCRE.  
   
   
107  AUTHOR  AUTHOR
108    
109         Philip Hazel         Philip Hazel
110         University Computing Service         University Computing Service
111         Cambridge CB2 3QH, England.         Cambridge CB2 3QH, England.
112    
113         Putting  an actual email address here seems to have been a spam magnet,         Putting an actual email address here seems to have been a spam  magnet,
114         so I've taken it away. If you want to email me, use  my  two  initials,         so  I've  taken  it away. If you want to email me, use my two initials,
115         followed by the two digits 10, at the domain cam.ac.uk.         followed by the two digits 10, at the domain cam.ac.uk.
116    
117    
118  REVISION  REVISION
119    
120         Last updated: 12 April 2008         Last updated: 24 August 2011
121         Copyright (c) 1997-2008 University of Cambridge.         Copyright (c) 1997-2011 University of Cambridge.
122  ------------------------------------------------------------------------------  ------------------------------------------------------------------------------
123    
124    
# Line 277  PCRE BUILD-TIME OPTIONS Line 136  PCRE BUILD-TIME OPTIONS
136         script,  where the optional features are selected or deselected by pro-         script,  where the optional features are selected or deselected by pro-
137         viding options to configure before running the make  command.  However,         viding options to configure before running the make  command.  However,
138         the  same  options  can be selected in both Unix-like and non-Unix-like         the  same  options  can be selected in both Unix-like and non-Unix-like
139         environments using the GUI facility of  CMakeSetup  if  you  are  using         environments using the GUI facility of cmake-gui if you are using CMake
140         CMake instead of configure to build PCRE.         instead of configure to build PCRE.
141    
142           There  is  a  lot more information about building PCRE in non-Unix-like
143           environments in the file called NON_UNIX_USE, which is part of the PCRE
144           distribution.  You  should consult this file as well as the README file
145           if you are building in a non-Unix-like environment.
146    
147         The complete list of options for configure (which includes the standard         The complete list of options for configure (which includes the standard
148         ones such as the  selection  of  the  installation  directory)  can  be         ones  such  as  the  selection  of  the  installation directory) can be
149         obtained by running         obtained by running
150    
151           ./configure --help           ./configure --help
152    
153         The  following  sections  include  descriptions  of options whose names         The following sections include  descriptions  of  options  whose  names
154         begin with --enable or --disable. These settings specify changes to the         begin with --enable or --disable. These settings specify changes to the
155         defaults  for  the configure command. Because of the way that configure         defaults for the configure command. Because of the way  that  configure
156         works, --enable and --disable always come in pairs, so  the  complemen-         works,  --enable  and --disable always come in pairs, so the complemen-
157         tary  option always exists as well, but as it specifies the default, it         tary option always exists as well, but as it specifies the default,  it
158         is not described.         is not described.
159    
160    
161    BUILDING SHARED AND STATIC LIBRARIES
162    
163           The  PCRE building process uses libtool to build both shared and static
164           Unix libraries by default. You can suppress one of these by adding  one
165           of
166    
167             --disable-shared
168             --disable-static
169    
170           to the configure command, as required.
171    
172    
173  C++ SUPPORT  C++ SUPPORT
174    
175         By default, the configure script will search for a C++ compiler and C++         By default, the configure script will search for a C++ compiler and C++
# Line 307  C++ SUPPORT Line 183  C++ SUPPORT
183    
184  UTF-8 SUPPORT  UTF-8 SUPPORT
185    
186         To build PCRE with support for UTF-8 character strings, add         To build PCRE with support for UTF-8 Unicode character strings, add
187    
188           --enable-utf8           --enable-utf8
189    
190         to the configure command. Of itself, this  does  not  make  PCRE  treat         to  the  configure  command.  Of  itself, this does not make PCRE treat
191         strings  as UTF-8. As well as compiling PCRE with this option, you also         strings as UTF-8. As well as compiling PCRE with this option, you  also
192         have have to set the PCRE_UTF8 option when you call the  pcre_compile()         have  have to set the PCRE_UTF8 option when you call the pcre_compile()
193         function.         or pcre_compile2() functions.
194    
195           If you set --enable-utf8 when compiling in an EBCDIC environment,  PCRE
196           expects its input to be either ASCII or UTF-8 (depending on the runtime
197           option). It is not possible to support both EBCDIC and UTF-8  codes  in
198           the  same  version  of  the  library.  Consequently,  --enable-utf8 and
199           --enable-ebcdic are mutually exclusive.
200    
201    
202  UNICODE CHARACTER PROPERTY SUPPORT  UNICODE CHARACTER PROPERTY SUPPORT
203    
204         UTF-8  support allows PCRE to process character values greater than 255         UTF-8 support allows PCRE to process character values greater than  255
205         in the strings that it handles. On its own, however, it does  not  pro-         in  the  strings that it handles. On its own, however, it does not pro-
206         vide any facilities for accessing the properties of such characters. If         vide any facilities for accessing the properties of such characters. If
207         you want to be able to use the pattern escapes \P, \p,  and  \X,  which         you  want  to  be able to use the pattern escapes \P, \p, and \X, which
208         refer to Unicode character properties, you must add         refer to Unicode character properties, you must add
209    
210           --enable-unicode-properties           --enable-unicode-properties
211    
212         to  the configure command. This implies UTF-8 support, even if you have         to the configure command. This implies UTF-8 support, even if you  have
213         not explicitly requested it.         not explicitly requested it.
214    
215         Including Unicode property support adds around 30K  of  tables  to  the         Including  Unicode  property  support  adds around 30K of tables to the
216         PCRE  library.  Only  the general category properties such as Lu and Nd         PCRE library. Only the general category properties such as  Lu  and  Nd
217         are supported. Details are given in the pcrepattern documentation.         are supported. Details are given in the pcrepattern documentation.
218    
219    
220    JUST-IN-TIME COMPILER SUPPORT
221    
222           Just-in-time compiler support is included in the build by specifying
223    
224             --enable-jit
225    
226           This  support  is available only for certain hardware architectures. If
227           this option is set for an  unsupported  architecture,  a  compile  time
228           error  occurs.   See  the pcrejit documentation for a discussion of JIT
229           usage. When JIT support is enabled, pcregrep automatically makes use of
230           it, unless you add
231    
232             --disable-pcregrep-jit
233    
234           to the "configure" command.
235    
236    
237  CODE VALUE OF NEWLINE  CODE VALUE OF NEWLINE
238    
239         By default, PCRE interprets character 10 (linefeed, LF)  as  indicating         By  default,  PCRE interprets the linefeed (LF) character as indicating
240         the  end  of  a line. This is the normal newline character on Unix-like         the end of a line. This is the normal newline  character  on  Unix-like
241         systems. You can compile PCRE to use character 13 (carriage return, CR)         systems.  You  can compile PCRE to use carriage return (CR) instead, by
242         instead, by adding         adding
243    
244           --enable-newline-is-cr           --enable-newline-is-cr
245    
246         to  the  configure  command.  There  is  also  a --enable-newline-is-lf         to the  configure  command.  There  is  also  a  --enable-newline-is-lf
247         option, which explicitly specifies linefeed as the newline character.         option, which explicitly specifies linefeed as the newline character.
248    
249         Alternatively, you can specify that line endings are to be indicated by         Alternatively, you can specify that line endings are to be indicated by
# Line 356  CODE VALUE OF NEWLINE Line 255  CODE VALUE OF NEWLINE
255    
256           --enable-newline-is-anycrlf           --enable-newline-is-anycrlf
257    
258         which  causes  PCRE  to recognize any of the three sequences CR, LF, or         which causes PCRE to recognize any of the three sequences  CR,  LF,  or
259         CRLF as indicating a line ending. Finally, a fifth option, specified by         CRLF as indicating a line ending. Finally, a fifth option, specified by
260    
261           --enable-newline-is-any           --enable-newline-is-any
# Line 381  WHAT \R MATCHES Line 280  WHAT \R MATCHES
280         functions are called.         functions are called.
281    
282    
 BUILDING SHARED AND STATIC LIBRARIES  
   
        The  PCRE building process uses libtool to build both shared and static  
        Unix libraries by default. You can suppress one of these by adding  one  
        of  
   
          --disable-shared  
          --disable-static  
   
        to the configure command, as required.  
   
   
283  POSIX MALLOC USAGE  POSIX MALLOC USAGE
284    
285         When PCRE is called through the POSIX interface (see the pcreposix doc-         When PCRE is called through the POSIX interface (see the pcreposix doc-
# Line 416  HANDLING VERY LARGE PATTERNS Line 303  HANDLING VERY LARGE PATTERNS
303         nation metacharacter). By default, two-byte values are used  for  these         nation metacharacter). By default, two-byte values are used  for  these
304         offsets,  leading  to  a  maximum size for a compiled pattern of around         offsets,  leading  to  a  maximum size for a compiled pattern of around
305         64K. This is sufficient to handle all but the most  gigantic  patterns.         64K. This is sufficient to handle all but the most  gigantic  patterns.
306         Nevertheless,  some  people do want to process enormous patterns, so it         Nevertheless,  some  people do want to process truyl enormous patterns,
307         is possible to compile PCRE to use three-byte or four-byte  offsets  by         so it is possible to compile PCRE to use three-byte or  four-byte  off-
308         adding a setting such as         sets by adding a setting such as
309    
310           --with-link-size=3           --with-link-size=3
311    
# Line 445  AVOIDING EXCESSIVE STACK USAGE Line 332  AVOIDING EXCESSIVE STACK USAGE
332         to the configure command. With this configuration, PCRE  will  use  the         to the configure command. With this configuration, PCRE  will  use  the
333         pcre_stack_malloc  and pcre_stack_free variables to call memory manage-         pcre_stack_malloc  and pcre_stack_free variables to call memory manage-
334         ment functions. By default these point to malloc() and free(), but  you         ment functions. By default these point to malloc() and free(), but  you
335         can replace the pointers so that your own functions are used.         can replace the pointers so that your own functions are used instead.
336    
337         Separate  functions  are  provided  rather  than  using pcre_malloc and         Separate  functions  are  provided  rather  than  using pcre_malloc and
338         pcre_free because the  usage  is  very  predictable:  the  block  sizes         pcre_free because the  usage  is  very  predictable:  the  block  sizes
# Line 453  AVOIDING EXCESSIVE STACK USAGE Line 340  AVOIDING EXCESSIVE STACK USAGE
340         reverse order. A calling program might be able to  implement  optimized         reverse order. A calling program might be able to  implement  optimized
341         functions  that  perform  better  than  malloc()  and free(). PCRE runs         functions  that  perform  better  than  malloc()  and free(). PCRE runs
342         noticeably more slowly when built in this way. This option affects only         noticeably more slowly when built in this way. This option affects only
343         the   pcre_exec()   function;   it   is   not   relevant  for  the  the         the pcre_exec() function; it is not relevant for pcre_dfa_exec().
        pcre_dfa_exec() function.  
344    
345    
346  LIMITING PCRE RESOURCE USAGE  LIMITING PCRE RESOURCE USAGE
347    
348         Internally, PCRE has a function called match(), which it calls  repeat-         Internally,  PCRE has a function called match(), which it calls repeat-
349         edly   (sometimes   recursively)  when  matching  a  pattern  with  the         edly  (sometimes  recursively)  when  matching  a  pattern   with   the
350         pcre_exec() function. By controlling the maximum number of  times  this         pcre_exec()  function.  By controlling the maximum number of times this
351         function  may be called during a single matching operation, a limit can         function may be called during a single matching operation, a limit  can
352         be placed on the resources used by a single call  to  pcre_exec().  The         be  placed  on  the resources used by a single call to pcre_exec(). The
353         limit  can be changed at run time, as described in the pcreapi documen-         limit can be changed at run time, as described in the pcreapi  documen-
354         tation. The default is 10 million, but this can be changed by adding  a         tation.  The default is 10 million, but this can be changed by adding a
355         setting such as         setting such as
356    
357           --with-match-limit=500000           --with-match-limit=500000
358    
359         to   the   configure  command.  This  setting  has  no  effect  on  the         to  the  configure  command.  This  setting  has  no  effect   on   the
360         pcre_dfa_exec() matching function.         pcre_dfa_exec() matching function.
361    
362         In some environments it is desirable to limit the  depth  of  recursive         In  some  environments  it is desirable to limit the depth of recursive
363         calls of match() more strictly than the total number of calls, in order         calls of match() more strictly than the total number of calls, in order
364         to restrict the maximum amount of stack (or heap,  if  --disable-stack-         to  restrict  the maximum amount of stack (or heap, if --disable-stack-
365         for-recursion is specified) that is used. A second limit controls this;         for-recursion is specified) that is used. A second limit controls this;
366         it defaults to the value that  is  set  for  --with-match-limit,  which         it  defaults  to  the  value  that is set for --with-match-limit, which
367         imposes  no  additional constraints. However, you can set a lower limit         imposes no additional constraints. However, you can set a  lower  limit
368         by adding, for example,         by adding, for example,
369    
370           --with-match-limit-recursion=10000           --with-match-limit-recursion=10000
371    
372         to the configure command. This value can  also  be  overridden  at  run         to  the  configure  command.  This  value can also be overridden at run
373         time.         time.
374    
375    
376  CREATING CHARACTER TABLES AT BUILD TIME  CREATING CHARACTER TABLES AT BUILD TIME
377    
378         PCRE  uses fixed tables for processing characters whose code values are         PCRE uses fixed tables for processing characters whose code values  are
379         less than 256. By default, PCRE is built with a set of tables that  are         less  than 256. By default, PCRE is built with a set of tables that are
380         distributed  in  the  file pcre_chartables.c.dist. These tables are for         distributed in the file pcre_chartables.c.dist. These  tables  are  for
381         ASCII codes only. If you add         ASCII codes only. If you add
382    
383           --enable-rebuild-chartables           --enable-rebuild-chartables
384    
385         to the configure command, the distributed tables are  no  longer  used.         to  the  configure  command, the distributed tables are no longer used.
386         Instead,  a  program  called dftables is compiled and run. This outputs         Instead, a program called dftables is compiled and  run.  This  outputs
387         the source for new set of tables, created in the default locale of your         the source for new set of tables, created in the default locale of your
388         C runtime system. (This method of replacing the tables does not work if         C runtime system. (This method of replacing the tables does not work if
389         you are cross compiling, because dftables is run on the local host.  If         you  are cross compiling, because dftables is run on the local host. If
390         you  need  to  create alternative tables when cross compiling, you will         you need to create alternative tables when cross  compiling,  you  will
391         have to do so "by hand".)         have to do so "by hand".)
392    
393    
394  USING EBCDIC CODE  USING EBCDIC CODE
395    
396         PCRE assumes by default that it will run in an  environment  where  the         PCRE  assumes  by  default that it will run in an environment where the
397         character  code  is  ASCII  (or Unicode, which is a superset of ASCII).         character code is ASCII (or Unicode, which is  a  superset  of  ASCII).
398         This is the case for most computer operating systems.  PCRE  can,  how-         This  is  the  case for most computer operating systems. PCRE can, how-
399         ever, be compiled to run in an EBCDIC environment by adding         ever, be compiled to run in an EBCDIC environment by adding
400    
401           --enable-ebcdic           --enable-ebcdic
402    
403         to the configure command. This setting implies --enable-rebuild-charta-         to the configure command. This setting implies --enable-rebuild-charta-
404         bles. You should only use it if you know that  you  are  in  an  EBCDIC         bles.  You  should  only  use  it if you know that you are in an EBCDIC
405         environment (for example, an IBM mainframe operating system).         environment (for example,  an  IBM  mainframe  operating  system).  The
406           --enable-ebcdic option is incompatible with --enable-utf8.
407    
408    
409  PCREGREP OPTIONS FOR COMPRESSED FILE SUPPORT  PCREGREP OPTIONS FOR COMPRESSED FILE SUPPORT
# Line 533  PCREGREP OPTIONS FOR COMPRESSED FILE SUP Line 420  PCREGREP OPTIONS FOR COMPRESSED FILE SUP
420         if they are not.         if they are not.
421    
422    
423    PCREGREP BUFFER SIZE
424    
425           pcregrep  uses  an internal buffer to hold a "window" on the file it is
426           scanning, in order to be able to output "before" and "after" lines when
427           it  finds  a match. The size of the buffer is controlled by a parameter
428           whose default value is 20K. The buffer itself is three times this size,
429           but because of the way it is used for holding "before" lines, the long-
430           est line that is guaranteed to be processable is  the  parameter  size.
431           You can change the default parameter value by adding, for example,
432    
433             --with-pcregrep-bufsize=50K
434    
435           to the configure command. The caller of pcregrep can, however, override
436           this value by specifying a run-time option.
437    
438    
439  PCRETEST OPTION FOR LIBREADLINE SUPPORT  PCRETEST OPTION FOR LIBREADLINE SUPPORT
440    
441         If you add         If you add
442    
443           --enable-pcretest-libreadline           --enable-pcretest-libreadline
444    
445         to  the  configure  command,  pcretest  is  linked with the libreadline         to the configure command,  pcretest  is  linked  with  the  libreadline
446         library, and when its input is from a terminal, it reads it  using  the         library,  and  when its input is from a terminal, it reads it using the
447         readline() function. This provides line-editing and history facilities.         readline() function. This provides line-editing and history facilities.
448         Note that libreadline is GPL-licenced, so if you distribute a binary of         Note that libreadline is GPL-licensed, so if you distribute a binary of
449         pcretest linked in this way, there may be licensing issues.         pcretest linked in this way, there may be licensing issues.
450    
451         Setting  this  option  causes  the -lreadline option to be added to the         Setting this option causes the -lreadline option to  be  added  to  the
452         pcretest build. In many operating environments with  a  sytem-installed         pcretest  build.  In many operating environments with a sytem-installed
453         libreadline this is sufficient. However, in some environments (e.g.  if         libreadline this is sufficient. However, in some environments (e.g.  if
454         an unmodified distribution version of readline is in use),  some  extra         an  unmodified  distribution version of readline is in use), some extra
455         configuration  may  be necessary. The INSTALL file for libreadline says         configuration may be necessary. The INSTALL file for  libreadline  says
456         this:         this:
457    
458           "Readline uses the termcap functions, but does not link with the           "Readline uses the termcap functions, but does not link with the
459           termcap or curses library itself, allowing applications which link           termcap or curses library itself, allowing applications which link
460           with readline the to choose an appropriate library."           with readline the to choose an appropriate library."
461    
462         If your environment has not been set up so that an appropriate  library         If  your environment has not been set up so that an appropriate library
463         is automatically included, you may need to add something like         is automatically included, you may need to add something like
464    
465           LIBS="-ncurses"           LIBS="-ncurses"
# Line 578  AUTHOR Line 481  AUTHOR
481    
482  REVISION  REVISION
483    
484         Last updated: 13 April 2008         Last updated: 06 September 2011
485         Copyright (c) 1997-2008 University of Cambridge.         Copyright (c) 1997-2011 University of Cambridge.
486  ------------------------------------------------------------------------------  ------------------------------------------------------------------------------
487    
488    
# Line 666  THE ALTERNATIVE MATCHING ALGORITHM Line 569  THE ALTERNATIVE MATCHING ALGORITHM
569         though  it is not implemented as a traditional finite state machine (it         though  it is not implemented as a traditional finite state machine (it
570         keeps multiple states active simultaneously).         keeps multiple states active simultaneously).
571    
572           Although the general principle of this matching algorithm  is  that  it
573           scans  the subject string only once, without backtracking, there is one
574           exception: when a lookaround assertion is encountered,  the  characters
575           following  or  preceding  the  current  point  have to be independently
576           inspected.
577    
578         The scan continues until either the end of the subject is  reached,  or         The scan continues until either the end of the subject is  reached,  or
579         there  are  no more unterminated paths. At this point, terminated paths         there  are  no more unterminated paths. At this point, terminated paths
580         represent the different matching possibilities (if there are none,  the         represent the different matching possibilities (if there are none,  the
581         match  has  failed).   Thus,  if there is more than one possible match,         match  has  failed).   Thus,  if there is more than one possible match,
582         this algorithm finds all of them, and in particular, it finds the long-         this algorithm finds all of them, and in particular, it finds the long-
583         est.  In PCRE, there is an option to stop the algorithm after the first         est.  The  matches are returned in decreasing order of length. There is
584         match (which is necessarily the shortest) has been found.         an option to stop the algorithm after the first match (which is  neces-
585           sarily the shortest) is found.
586    
587         Note that all the matches that are found start at the same point in the         Note that all the matches that are found start at the same point in the
588         subject. If the pattern         subject. If the pattern
589    
590           cat(er(pillar)?)           cat(er(pillar)?)?
591    
592         is  matched  against the string "the caterpillar catchment", the result         is matched against the string "the caterpillar catchment",  the  result
593         will be the three strings "cat", "cater", and "caterpillar" that  start         will  be the three strings "caterpillar", "cater", and "cat" that start
594         at the fourth character of the subject. The algorithm does not automat-         at the fifth character of the subject. The algorithm does not automati-
595         ically move on to find matches that start at later positions.         cally move on to find matches that start at later positions.
596    
597         There are a number of features of PCRE regular expressions that are not         There are a number of features of PCRE regular expressions that are not
598         supported by the alternative matching algorithm. They are as follows:         supported by the alternative matching algorithm. They are as follows:
599    
600         1.  Because  the  algorithm  finds  all possible matches, the greedy or         1. Because the algorithm finds all  possible  matches,  the  greedy  or
601         ungreedy nature of repetition quantifiers is not relevant.  Greedy  and         ungreedy  nature  of repetition quantifiers is not relevant. Greedy and
602         ungreedy quantifiers are treated in exactly the same way. However, pos-         ungreedy quantifiers are treated in exactly the same way. However, pos-
603         sessive quantifiers can make a difference when what follows could  also         sessive  quantifiers can make a difference when what follows could also
604         match what is quantified, for example in a pattern like this:         match what is quantified, for example in a pattern like this:
605    
606           ^a++\w!           ^a++\w!
607    
608         This  pattern matches "aaab!" but not "aaa!", which would be matched by         This pattern matches "aaab!" but not "aaa!", which would be matched  by
609         a non-possessive quantifier. Similarly, if an atomic group is  present,         a  non-possessive quantifier. Similarly, if an atomic group is present,
610         it  is matched as if it were a standalone pattern at the current point,         it is matched as if it were a standalone pattern at the current  point,
611         and the longest match is then "locked in" for the rest of  the  overall         and  the  longest match is then "locked in" for the rest of the overall
612         pattern.         pattern.
613    
614         2. When dealing with multiple paths through the tree simultaneously, it         2. When dealing with multiple paths through the tree simultaneously, it
615         is not straightforward to keep track of  captured  substrings  for  the         is  not  straightforward  to  keep track of captured substrings for the
616         different  matching  possibilities,  and  PCRE's implementation of this         different matching possibilities, and  PCRE's  implementation  of  this
617         algorithm does not attempt to do this. This means that no captured sub-         algorithm does not attempt to do this. This means that no captured sub-
618         strings are available.         strings are available.
619    
620         3.  Because no substrings are captured, back references within the pat-         3. Because no substrings are captured, back references within the  pat-
621         tern are not supported, and cause errors if encountered.         tern are not supported, and cause errors if encountered.
622    
623         4. For the same reason, conditional expressions that use  a  backrefer-         4.  For  the same reason, conditional expressions that use a backrefer-
624         ence  as  the  condition or test for a specific group recursion are not         ence as the condition or test for a specific group  recursion  are  not
625         supported.         supported.
626    
627         5. Because many paths through the tree may be  active,  the  \K  escape         5.  Because  many  paths  through the tree may be active, the \K escape
628         sequence, which resets the start of the match when encountered (but may         sequence, which resets the start of the match when encountered (but may
629         be on some paths and not on others), is not  supported.  It  causes  an         be  on  some  paths  and not on others), is not supported. It causes an
630         error if encountered.         error if encountered.
631    
632         6.  Callouts  are  supported, but the value of the capture_top field is         6. Callouts are supported, but the value of the  capture_top  field  is
633         always 1, and the value of the capture_last field is always -1.         always 1, and the value of the capture_last field is always -1.
634    
635         7. The \C escape sequence, which (in the standard algorithm) matches  a         7.  The \C escape sequence, which (in the standard algorithm) matches a
636         single  byte, even in UTF-8 mode, is not supported because the alterna-         single byte, even in UTF-8 mode, is not supported because the  alterna-
637         tive algorithm moves through the subject  string  one  character  at  a         tive  algorithm  moves  through  the  subject string one character at a
638         time, for all active paths through the tree.         time, for all active paths through the tree.
639    
640         8.  Except for (*FAIL), the backtracking control verbs such as (*PRUNE)         8. Except for (*FAIL), the backtracking control verbs such as  (*PRUNE)
641         are not supported. (*FAIL) is supported, and  behaves  like  a  failing         are  not  supported.  (*FAIL)  is supported, and behaves like a failing
642         negative assertion.         negative assertion.
643    
644    
645  ADVANTAGES OF THE ALTERNATIVE ALGORITHM  ADVANTAGES OF THE ALTERNATIVE ALGORITHM
646    
647         Using  the alternative matching algorithm provides the following advan-         Using the alternative matching algorithm provides the following  advan-
648         tages:         tages:
649    
650         1. All possible matches (at a single point in the subject) are automat-         1. All possible matches (at a single point in the subject) are automat-
651         ically  found,  and  in particular, the longest match is found. To find         ically found, and in particular, the longest match is  found.  To  find
652         more than one match using the standard algorithm, you have to do kludgy         more than one match using the standard algorithm, you have to do kludgy
653         things with callouts.         things with callouts.
654    
655         2.  There is much better support for partial matching. The restrictions         2. Because the alternative algorithm  scans  the  subject  string  just
656         on the content of the pattern that apply when using the standard  algo-         once,  and  never  needs to backtrack, it is possible to pass very long
657         rithm  for  partial matching do not apply to the alternative algorithm.         subject strings to the matching function in  several  pieces,  checking
658         For non-anchored patterns, the starting position of a partial match  is         for  partial  matching  each time. Although it is possible to do multi-
659         available.         segment matching using the standard algorithm (pcre_exec()), by retain-
660           ing  partially matched substrings, it is more complicated. The pcrepar-
661         3.  Because  the  alternative  algorithm  scans the subject string just         tial documentation gives details  of  partial  matching  and  discusses
662         once, and never needs to backtrack, it is possible to  pass  very  long         multi-segment matching.
        subject  strings  to  the matching function in several pieces, checking  
        for partial matching each time.  
663    
664    
665  DISADVANTAGES OF THE ALTERNATIVE ALGORITHM  DISADVANTAGES OF THE ALTERNATIVE ALGORITHM
666    
667         The alternative algorithm suffers from a number of disadvantages:         The alternative algorithm suffers from a number of disadvantages:
668    
669         1. It is substantially slower than  the  standard  algorithm.  This  is         1.  It  is  substantially  slower  than the standard algorithm. This is
670         partly  because  it has to search for all possible matches, but is also         partly because it has to search for all possible matches, but  is  also
671         because it is less susceptible to optimization.         because it is less susceptible to optimization.
672    
673         2. Capturing parentheses and back references are not supported.         2. Capturing parentheses and back references are not supported.
# Line 777  AUTHOR Line 685  AUTHOR
685    
686  REVISION  REVISION
687    
688         Last updated: 19 April 2008         Last updated: 17 November 2010
689         Copyright (c) 1997-2008 University of Cambridge.         Copyright (c) 1997-2010 University of Cambridge.
690  ------------------------------------------------------------------------------  ------------------------------------------------------------------------------
691    
692    
# Line 789  NAME Line 697  NAME
697         PCRE - Perl-compatible regular expressions         PCRE - Perl-compatible regular expressions
698    
699    
700  PCRE NATIVE API  PCRE NATIVE API BASIC FUNCTIONS
701    
702         #include <pcre.h>         #include <pcre.h>
703    
# Line 805  PCRE NATIVE API Line 713  PCRE NATIVE API
713         pcre_extra *pcre_study(const pcre *code, int options,         pcre_extra *pcre_study(const pcre *code, int options,
714              const char **errptr);              const char **errptr);
715    
716           void pcre_free_study(pcre_extra *extra);
717    
718         int pcre_exec(const pcre *code, const pcre_extra *extra,         int pcre_exec(const pcre *code, const pcre_extra *extra,
719              const char *subject, int length, int startoffset,              const char *subject, int length, int startoffset,
720              int options, int *ovector, int ovecsize);              int options, int *ovector, int ovecsize);
721    
722    
723    PCRE NATIVE API AUXILIARY FUNCTIONS
724    
725           pcre_jit_stack *pcre_jit_stack_alloc(int startsize, int maxsize);
726    
727           void pcre_jit_stack_free(pcre_jit_stack *stack);
728    
729           void pcre_assign_jit_stack(pcre_extra *extra,
730                pcre_jit_callback callback, void *data);
731    
732         int pcre_dfa_exec(const pcre *code, const pcre_extra *extra,         int pcre_dfa_exec(const pcre *code, const pcre_extra *extra,
733              const char *subject, int length, int startoffset,              const char *subject, int length, int startoffset,
734              int options, int *ovector, int ovecsize,              int options, int *ovector, int ovecsize,
# Line 858  PCRE NATIVE API Line 778  PCRE NATIVE API
778    
779         char *pcre_version(void);         char *pcre_version(void);
780    
781    
782    PCRE NATIVE API INDIRECTED FUNCTIONS
783    
784         void *(*pcre_malloc)(size_t);         void *(*pcre_malloc)(size_t);
785    
786         void (*pcre_free)(void *);         void (*pcre_free)(void *);
# Line 873  PCRE API OVERVIEW Line 796  PCRE API OVERVIEW
796    
797         PCRE has its own native API, which is described in this document. There         PCRE has its own native API, which is described in this document. There
798         are also some wrapper functions that correspond to  the  POSIX  regular         are also some wrapper functions that correspond to  the  POSIX  regular
799         expression  API.  These  are  described in the pcreposix documentation.         expression  API,  but they do not give access to all the functionality.
800         Both of these APIs define a set of C function calls. A C++  wrapper  is         They are described in the pcreposix documentation. Both of  these  APIs
801         distributed with PCRE. It is documented in the pcrecpp page.         define  a  set  of  C function calls. A C++ wrapper is also distributed
802           with PCRE. It is documented in the pcrecpp page.
803    
804         The  native  API  C  function prototypes are defined in the header file         The native API C function prototypes are defined  in  the  header  file
805         pcre.h, and on Unix systems the library itself is called  libpcre.   It         pcre.h,  and  on Unix systems the library itself is called libpcre.  It
806         can normally be accessed by adding -lpcre to the command for linking an         can normally be accessed by adding -lpcre to the command for linking an
807         application  that  uses  PCRE.  The  header  file  defines  the  macros         application  that  uses  PCRE.  The  header  file  defines  the  macros
808         PCRE_MAJOR  and  PCRE_MINOR to contain the major and minor release num-         PCRE_MAJOR and PCRE_MINOR to contain the major and minor  release  num-
809         bers for the library.  Applications can use these  to  include  support         bers  for  the  library.  Applications can use these to include support
810         for different releases of PCRE.         for different releases of PCRE.
811    
812         The   functions   pcre_compile(),  pcre_compile2(),  pcre_study(),  and         In a Windows environment, if you want to statically link an application
813         pcre_exec() are used for compiling and matching regular expressions  in         program  against  a  non-dll  pcre.a  file, you must define PCRE_STATIC
814         a  Perl-compatible  manner. A sample program that demonstrates the sim-         before including pcre.h or pcrecpp.h, because otherwise  the  pcre_mal-
815         plest way of using them is provided in the file  called  pcredemo.c  in         loc()   and   pcre_free()   exported   functions   will   be   declared
816         the  source distribution. The pcresample documentation describes how to         __declspec(dllimport), with unwanted results.
817         compile and run it.  
818           The  functions  pcre_compile(),  pcre_compile2(),   pcre_study(),   and
819           pcre_exec()  are used for compiling and matching regular expressions in
820           a Perl-compatible manner. A sample program that demonstrates  the  sim-
821           plest  way  of  using them is provided in the file called pcredemo.c in
822           the PCRE source distribution. A listing of this program is given in the
823           pcredemo  documentation, and the pcresample documentation describes how
824           to compile and run it.
825    
826           Just-in-time compiler support is an optional feature of PCRE  that  can
827           be built in appropriate hardware environments. It greatly speeds up the
828           matching performance of  many  patterns.  Simple  programs  can  easily
829           request  that  it  be  used  if available, by setting an option that is
830           ignored when it is not relevant. More complicated programs  might  need
831           to     make    use    of    the    functions    pcre_jit_stack_alloc(),
832           pcre_jit_stack_free(), and pcre_assign_jit_stack() in order to  control
833           the  JIT  code's  memory  usage.   These functions are discussed in the
834           pcrejit documentation.
835    
836         A second matching function, pcre_dfa_exec(), which is not Perl-compati-         A second matching function, pcre_dfa_exec(), which is not Perl-compati-
837         ble,  is  also provided. This uses a different algorithm for the match-         ble,  is  also provided. This uses a different algorithm for the match-
838         ing. The alternative algorithm finds all possible matches (at  a  given         ing. The alternative algorithm finds all possible matches (at  a  given
839         point  in  the subject), and scans the subject just once. However, this         point  in  the  subject), and scans the subject just once (unless there
840         algorithm does not return captured substrings. A description of the two         are lookbehind assertions). However, this  algorithm  does  not  return
841         matching  algorithms and their advantages and disadvantages is given in         captured  substrings.  A description of the two matching algorithms and
842         the pcrematching documentation.         their advantages and disadvantages is given in the  pcrematching  docu-
843           mentation.
844    
845         In addition to the main compiling and  matching  functions,  there  are         In  addition  to  the  main compiling and matching functions, there are
846         convenience functions for extracting captured substrings from a subject         convenience functions for extracting captured substrings from a subject
847         string that is matched by pcre_exec(). They are:         string that is matched by pcre_exec(). They are:
848    
# Line 915  PCRE API OVERVIEW Line 857  PCRE API OVERVIEW
857         pcre_free_substring() and pcre_free_substring_list() are also provided,         pcre_free_substring() and pcre_free_substring_list() are also provided,
858         to free the memory used for extracted strings.         to free the memory used for extracted strings.
859    
860         The  function  pcre_maketables()  is  used  to build a set of character         The function pcre_maketables() is used to  build  a  set  of  character
861         tables  in  the  current  locale   for   passing   to   pcre_compile(),         tables   in   the   current   locale  for  passing  to  pcre_compile(),
862         pcre_exec(),  or  pcre_dfa_exec(). This is an optional facility that is         pcre_exec(), or pcre_dfa_exec(). This is an optional facility  that  is
863         provided for specialist use.  Most  commonly,  no  special  tables  are         provided  for  specialist  use.  Most  commonly,  no special tables are
864         passed,  in  which case internal tables that are generated when PCRE is         passed, in which case internal tables that are generated when  PCRE  is
865         built are used.         built are used.
866    
867         The function pcre_fullinfo() is used to find out  information  about  a         The  function  pcre_fullinfo()  is used to find out information about a
868         compiled  pattern; pcre_info() is an obsolete version that returns only         compiled pattern; pcre_info() is an obsolete version that returns  only
869         some of the available information, but is retained for  backwards  com-         some  of  the available information, but is retained for backwards com-
870         patibility.   The function pcre_version() returns a pointer to a string         patibility.  The function pcre_version() returns a pointer to a  string
871         containing the version of PCRE and its date of release.         containing the version of PCRE and its date of release.
872    
873         The function pcre_refcount() maintains a  reference  count  in  a  data         The  function  pcre_refcount()  maintains  a  reference count in a data
874         block  containing  a compiled pattern. This is provided for the benefit         block containing a compiled pattern. This is provided for  the  benefit
875         of object-oriented applications.         of object-oriented applications.
876    
877         The global variables pcre_malloc and pcre_free  initially  contain  the         The  global  variables  pcre_malloc and pcre_free initially contain the
878         entry  points  of  the  standard malloc() and free() functions, respec-         entry points of the standard malloc()  and  free()  functions,  respec-
879         tively. PCRE calls the memory management functions via these variables,         tively. PCRE calls the memory management functions via these variables,
880         so  a  calling  program  can replace them if it wishes to intercept the         so a calling program can replace them if it  wishes  to  intercept  the
881         calls. This should be done before calling any PCRE functions.         calls. This should be done before calling any PCRE functions.
882    
883         The global variables pcre_stack_malloc  and  pcre_stack_free  are  also         The  global  variables  pcre_stack_malloc  and pcre_stack_free are also
884         indirections  to  memory  management functions. These special functions         indirections to memory management functions.  These  special  functions
885         are used only when PCRE is compiled to use  the  heap  for  remembering         are  used  only  when  PCRE is compiled to use the heap for remembering
886         data, instead of recursive function calls, when running the pcre_exec()         data, instead of recursive function calls, when running the pcre_exec()
887         function. See the pcrebuild documentation for  details  of  how  to  do         function.  See  the  pcrebuild  documentation  for details of how to do
888         this.  It  is  a non-standard way of building PCRE, for use in environ-         this. It is a non-standard way of building PCRE, for  use  in  environ-
889         ments that have limited stacks. Because of the greater  use  of  memory         ments  that  have  limited stacks. Because of the greater use of memory
890         management,  it  runs  more  slowly. Separate functions are provided so         management, it runs more slowly. Separate  functions  are  provided  so
891         that special-purpose external code can be  used  for  this  case.  When         that  special-purpose  external  code  can  be used for this case. When
892         used,  these  functions  are always called in a stack-like manner (last         used, these functions are always called in a  stack-like  manner  (last
893         obtained, first freed), and always for memory blocks of the same  size.         obtained,  first freed), and always for memory blocks of the same size.
894         There  is  a discussion about PCRE's stack usage in the pcrestack docu-         There is a discussion about PCRE's stack usage in the  pcrestack  docu-
895         mentation.         mentation.
896    
897         The global variable pcre_callout initially contains NULL. It can be set         The global variable pcre_callout initially contains NULL. It can be set
898         by  the  caller  to  a "callout" function, which PCRE will then call at         by the caller to a "callout" function, which PCRE  will  then  call  at
899         specified points during a matching operation. Details are given in  the         specified  points during a matching operation. Details are given in the
900         pcrecallout documentation.         pcrecallout documentation.
901    
902    
903  NEWLINES  NEWLINES
904    
905         PCRE  supports five different conventions for indicating line breaks in         PCRE supports five different conventions for indicating line breaks  in
906         strings: a single CR (carriage return) character, a  single  LF  (line-         strings:  a  single  CR (carriage return) character, a single LF (line-
907         feed) character, the two-character sequence CRLF, any of the three pre-         feed) character, the two-character sequence CRLF, any of the three pre-
908         ceding, or any Unicode newline sequence. The Unicode newline  sequences         ceding,  or any Unicode newline sequence. The Unicode newline sequences
909         are  the  three just mentioned, plus the single characters VT (vertical         are the three just mentioned, plus the single characters  VT  (vertical
910         tab, U+000B), FF (formfeed, U+000C), NEL (next line, U+0085), LS  (line         tab,  U+000B), FF (formfeed, U+000C), NEL (next line, U+0085), LS (line
911         separator, U+2028), and PS (paragraph separator, U+2029).         separator, U+2028), and PS (paragraph separator, U+2029).
912    
913         Each  of  the first three conventions is used by at least one operating         Each of the first three conventions is used by at least  one  operating
914         system as its standard newline sequence. When PCRE is built, a  default         system  as its standard newline sequence. When PCRE is built, a default
915         can  be  specified.  The default default is LF, which is the Unix stan-         can be specified.  The default default is LF, which is the  Unix  stan-
916         dard. When PCRE is run, the default can be overridden,  either  when  a         dard.  When  PCRE  is run, the default can be overridden, either when a
917         pattern is compiled, or when it is matched.         pattern is compiled, or when it is matched.
918    
919         At compile time, the newline convention can be specified by the options         At compile time, the newline convention can be specified by the options
920         argument of pcre_compile(), or it can be specified by special  text  at         argument  of  pcre_compile(), or it can be specified by special text at
921         the start of the pattern itself; this overrides any other settings. See         the start of the pattern itself; this overrides any other settings. See
922         the pcrepattern page for details of the special character sequences.         the pcrepattern page for details of the special character sequences.
923    
924         In the PCRE documentation the word "newline" is used to mean "the char-         In the PCRE documentation the word "newline" is used to mean "the char-
925         acter  or pair of characters that indicate a line break". The choice of         acter or pair of characters that indicate a line break". The choice  of
926         newline convention affects the handling of  the  dot,  circumflex,  and         newline  convention  affects  the  handling of the dot, circumflex, and
927         dollar metacharacters, the handling of #-comments in /x mode, and, when         dollar metacharacters, the handling of #-comments in /x mode, and, when
928         CRLF is a recognized line ending sequence, the match position  advance-         CRLF  is a recognized line ending sequence, the match position advance-
929         ment for a non-anchored pattern. There is more detail about this in the         ment for a non-anchored pattern. There is more detail about this in the
930         section on pcre_exec() options below.         section on pcre_exec() options below.
931    
932         The choice of newline convention does not affect the interpretation  of         The  choice of newline convention does not affect the interpretation of
933         the  \n  or  \r  escape  sequences, nor does it affect what \R matches,         the \n or \r escape sequences, nor does  it  affect  what  \R  matches,
934         which is controlled in a similar way, but by separate options.         which is controlled in a similar way, but by separate options.
935    
936    
937  MULTITHREADING  MULTITHREADING
938    
939         The PCRE functions can be used in  multi-threading  applications,  with         The  PCRE  functions  can be used in multi-threading applications, with
940         the  proviso  that  the  memory  management  functions  pointed  to  by         the  proviso  that  the  memory  management  functions  pointed  to  by
941         pcre_malloc, pcre_free, pcre_stack_malloc, and pcre_stack_free, and the         pcre_malloc, pcre_free, pcre_stack_malloc, and pcre_stack_free, and the
942         callout function pointed to by pcre_callout, are shared by all threads.         callout function pointed to by pcre_callout, are shared by all threads.
# Line 1003  MULTITHREADING Line 945  MULTITHREADING
945         ing, so the same compiled pattern can safely be used by several threads         ing, so the same compiled pattern can safely be used by several threads
946         at once.         at once.
947    
948           If the just-in-time optimization feature is being used, it needs  sepa-
949           rate  memory stack areas for each thread. See the pcrejit documentation
950           for more details.
951    
952    
953  SAVING PRECOMPILED PATTERNS FOR LATER USE  SAVING PRECOMPILED PATTERNS FOR LATER USE
954    
# Line 1038  CHECKING BUILD-TIME OPTIONS Line 984  CHECKING BUILD-TIME OPTIONS
984         The output is an integer that is set to  one  if  support  for  Unicode         The output is an integer that is set to  one  if  support  for  Unicode
985         character properties is available; otherwise it is set to zero.         character properties is available; otherwise it is set to zero.
986    
987             PCRE_CONFIG_JIT
988    
989           The output is an integer that is set to one if support for just-in-time
990           compiling is available; otherwise it is set to zero.
991    
992           PCRE_CONFIG_NEWLINE           PCRE_CONFIG_NEWLINE
993    
994         The  output  is  an integer whose value specifies the default character         The output is an integer whose value specifies  the  default  character
995         sequence that is recognized as meaning "newline". The four values  that         sequence  that is recognized as meaning "newline". The four values that
996         are supported are: 10 for LF, 13 for CR, 3338 for CRLF, -2 for ANYCRLF,         are supported are: 10 for LF, 13 for CR, 3338 for CRLF, -2 for ANYCRLF,
997         and -1 for ANY. The default should normally be  the  standard  sequence         and  -1  for  ANY.  Though they are derived from ASCII, the same values
998         for your operating system.         are returned in EBCDIC environments. The default should normally corre-
999           spond to the standard sequence for your operating system.
1000    
1001           PCRE_CONFIG_BSR           PCRE_CONFIG_BSR
1002    
# Line 1071  CHECKING BUILD-TIME OPTIONS Line 1023  CHECKING BUILD-TIME OPTIONS
1023    
1024           PCRE_CONFIG_MATCH_LIMIT           PCRE_CONFIG_MATCH_LIMIT
1025    
1026         The output is an integer that gives the default limit for the number of         The output is a long integer that gives the default limit for the  num-
1027         internal  matching  function  calls in a pcre_exec() execution. Further         ber  of  internal  matching  function calls in a pcre_exec() execution.
1028         details are given with pcre_exec() below.         Further details are given with pcre_exec() below.
1029    
1030           PCRE_CONFIG_MATCH_LIMIT_RECURSION           PCRE_CONFIG_MATCH_LIMIT_RECURSION
1031    
1032         The output is an integer that gives the default limit for the depth  of         The output is a long integer that gives the default limit for the depth
1033         recursion  when calling the internal matching function in a pcre_exec()         of   recursion  when  calling  the  internal  matching  function  in  a
1034         execution. Further details are given with pcre_exec() below.         pcre_exec() execution.  Further  details  are  given  with  pcre_exec()
1035           below.
1036    
1037           PCRE_CONFIG_STACKRECURSE           PCRE_CONFIG_STACKRECURSE
1038    
1039         The output is an integer that is set to one if internal recursion  when         The  output is an integer that is set to one if internal recursion when
1040         running pcre_exec() is implemented by recursive function calls that use         running pcre_exec() is implemented by recursive function calls that use
1041         the stack to remember their state. This is the usual way that  PCRE  is         the  stack  to remember their state. This is the usual way that PCRE is
1042         compiled. The output is zero if PCRE was compiled to use blocks of data         compiled. The output is zero if PCRE was compiled to use blocks of data
1043         on the  heap  instead  of  recursive  function  calls.  In  this  case,         on  the  heap  instead  of  recursive  function  calls.  In  this case,
1044         pcre_stack_malloc  and  pcre_stack_free  are  called  to  manage memory         pcre_stack_malloc and  pcre_stack_free  are  called  to  manage  memory
1045         blocks on the heap, thus avoiding the use of the stack.         blocks on the heap, thus avoiding the use of the stack.
1046    
1047    
# Line 1105  COMPILING A PATTERN Line 1058  COMPILING A PATTERN
1058    
1059         Either of the functions pcre_compile() or pcre_compile2() can be called         Either of the functions pcre_compile() or pcre_compile2() can be called
1060         to compile a pattern into an internal form. The only difference between         to compile a pattern into an internal form. The only difference between
1061         the two interfaces is that pcre_compile2() has an additional  argument,         the  two interfaces is that pcre_compile2() has an additional argument,
1062         errorcodeptr, via which a numerical error code can be returned.         errorcodeptr, via which a numerical error  code  can  be  returned.  To
1063           avoid  too  much repetition, we refer just to pcre_compile() below, but
1064           the information applies equally to pcre_compile2().
1065    
1066         The pattern is a C string terminated by a binary zero, and is passed in         The pattern is a C string terminated by a binary zero, and is passed in
1067         the pattern argument. A pointer to a single block  of  memory  that  is         the  pattern  argument.  A  pointer to a single block of memory that is
1068         obtained  via  pcre_malloc is returned. This contains the compiled code         obtained via pcre_malloc is returned. This contains the  compiled  code
1069         and related data. The pcre type is defined for the returned block; this         and related data. The pcre type is defined for the returned block; this
1070         is a typedef for a structure whose contents are not externally defined.         is a typedef for a structure whose contents are not externally defined.
1071         It is up to the caller to free the memory (via pcre_free) when it is no         It is up to the caller to free the memory (via pcre_free) when it is no
1072         longer required.         longer required.
1073    
1074         Although  the compiled code of a PCRE regex is relocatable, that is, it         Although the compiled code of a PCRE regex is relocatable, that is,  it
1075         does not depend on memory location, the complete pcre data block is not         does not depend on memory location, the complete pcre data block is not
1076         fully  relocatable, because it may contain a copy of the tableptr argu-         fully relocatable, because it may contain a copy of the tableptr  argu-
1077         ment, which is an address (see below).         ment, which is an address (see below).
1078    
1079         The options argument contains various bit settings that affect the com-         The options argument contains various bit settings that affect the com-
1080         pilation.  It  should be zero if no options are required. The available         pilation. It should be zero if no options are required.  The  available
1081         options are described below. Some of them, in  particular,  those  that         options  are  described  below. Some of them (in particular, those that
1082         are  compatible  with  Perl,  can also be set and unset from within the         are compatible with Perl, but some others as well) can also be set  and
1083         pattern (see the detailed description  in  the  pcrepattern  documenta-         unset  from  within  the  pattern  (see the detailed description in the
1084         tion).  For  these options, the contents of the options argument speci-         pcrepattern documentation). For those options that can be different  in
1085         fies their initial settings at the start of compilation and  execution.         different  parts  of  the pattern, the contents of the options argument
1086         The  PCRE_ANCHORED  and PCRE_NEWLINE_xxx options can be set at the time         specifies their settings at the start of compilation and execution. The
1087         of matching as well as at compile time.         PCRE_ANCHORED,  PCRE_BSR_xxx, PCRE_NEWLINE_xxx, PCRE_NO_UTF8_CHECK, and
1088           PCRE_NO_START_OPT options can be set at the time of matching as well as
1089           at compile time.
1090    
1091         If errptr is NULL, pcre_compile() returns NULL immediately.  Otherwise,         If errptr is NULL, pcre_compile() returns NULL immediately.  Otherwise,
1092         if  compilation  of  a  pattern fails, pcre_compile() returns NULL, and         if compilation of a pattern fails,  pcre_compile()  returns  NULL,  and
1093         sets the variable pointed to by errptr to point to a textual error mes-         sets the variable pointed to by errptr to point to a textual error mes-
1094         sage. This is a static string that is part of the library. You must not         sage. This is a static string that is part of the library. You must not
1095         try to free it. The offset from the start of the pattern to the charac-         try  to  free it. Normally, the offset from the start of the pattern to
1096         ter where the error was discovered is placed in the variable pointed to         the byte that was being processed when  the  error  was  discovered  is
1097         by erroffset, which must not be NULL. If it is, an immediate  error  is         placed  in the variable pointed to by erroffset, which must not be NULL
1098         given.         (if it is, an immediate error is given). However, for an invalid  UTF-8
1099           string,  the offset is that of the first byte of the failing character.
1100           Also, some errors are not detected until checks are  carried  out  when
1101           the  whole  pattern  has been scanned; in these cases the offset passed
1102           back is the length of the pattern.
1103    
1104           Note that the offset is in bytes, not characters, even in  UTF-8  mode.
1105           It may sometimes point into the middle of a UTF-8 character.
1106    
1107         If  pcre_compile2()  is  used instead of pcre_compile(), and the error-         If  pcre_compile2()  is  used instead of pcre_compile(), and the error-
1108         codeptr argument is not NULL, a non-zero error code number is  returned         codeptr argument is not NULL, a non-zero error code number is  returned
# Line 1216  COMPILING A PATTERN Line 1180  COMPILING A PATTERN
1180    
1181           PCRE_DOTALL           PCRE_DOTALL
1182    
1183         If this bit is set, a dot metacharater in the pattern matches all char-         If this bit is set, a dot metacharacter in the pattern matches a  char-
1184         acters,  including  those that indicate newline. Without it, a dot does         acter of any value, including one that indicates a newline. However, it
1185         not match when the current position is at a  newline.  This  option  is         only ever matches one character, even if newlines are  coded  as  CRLF.
1186         equivalent  to Perl's /s option, and it can be changed within a pattern         Without  this option, a dot does not match when the current position is
1187         by a (?s) option setting. A negative class such as [^a] always  matches         at a newline. This option is equivalent to Perl's /s option, and it can
1188         newline characters, independent of the setting of this option.         be  changed within a pattern by a (?s) option setting. A negative class
1189           such as [^a] always matches newline characters, independent of the set-
1190           ting of this option.
1191    
1192           PCRE_DUPNAMES           PCRE_DUPNAMES
1193    
# Line 1241  COMPILING A PATTERN Line 1207  COMPILING A PATTERN
1207         option, and it can be changed within a pattern by a  (?x)  option  set-         option, and it can be changed within a pattern by a  (?x)  option  set-
1208         ting.         ting.
1209    
1210         This  option  makes  it possible to include comments inside complicated         Which  characters  are  interpreted  as  newlines  is controlled by the
1211         patterns.  Note, however, that this applies only  to  data  characters.         options passed to pcre_compile() or by a special sequence at the  start
1212         Whitespace   characters  may  never  appear  within  special  character         of  the  pattern, as described in the section entitled "Newline conven-
1213         sequences in a pattern, for  example  within  the  sequence  (?(  which         tions" in the pcrepattern documentation. Note that the end of this type
1214         introduces a conditional subpattern.         of  comment  is  a  literal  newline  sequence  in  the pattern; escape
1215           sequences that happen to represent a newline do not count.
1216    
1217           This option makes it possible to include  comments  inside  complicated
1218           patterns.   Note,  however,  that this applies only to data characters.
1219           Whitespace  characters  may  never  appear  within  special   character
1220           sequences in a pattern, for example within the sequence (?( that intro-
1221           duces a conditional subpattern.
1222    
1223           PCRE_EXTRA           PCRE_EXTRA
1224    
1225         This  option  was invented in order to turn on additional functionality         This option was invented in order to turn on  additional  functionality
1226         of PCRE that is incompatible with Perl, but it  is  currently  of  very         of  PCRE  that  is  incompatible with Perl, but it is currently of very
1227         little  use. When set, any backslash in a pattern that is followed by a         little use. When set, any backslash in a pattern that is followed by  a
1228         letter that has no special meaning  causes  an  error,  thus  reserving         letter  that  has  no  special  meaning causes an error, thus reserving
1229         these  combinations  for  future  expansion.  By default, as in Perl, a         these combinations for future expansion. By  default,  as  in  Perl,  a
1230         backslash followed by a letter with no special meaning is treated as  a         backslash  followed by a letter with no special meaning is treated as a
1231         literal.  (Perl can, however, be persuaded to give a warning for this.)         literal. (Perl can, however, be persuaded to give an error for this, by
1232         There are at present no other features controlled by  this  option.  It         running  it with the -w option.) There are at present no other features
1233         can also be set by a (?X) option setting within a pattern.         controlled by this option. It can also be set by a (?X) option  setting
1234           within a pattern.
1235    
1236           PCRE_FIRSTLINE           PCRE_FIRSTLINE
1237    
# Line 1326  COMPILING A PATTERN Line 1300  COMPILING A PATTERN
1300         PCRE_NEWLINE_CRLF,  but other combinations may yield unused numbers and         PCRE_NEWLINE_CRLF,  but other combinations may yield unused numbers and
1301         cause an error.         cause an error.
1302    
1303         The only time that a line break is specially recognized when  compiling         The only time that a line break in a pattern  is  specially  recognized
1304         a  pattern  is  if  PCRE_EXTENDED  is set, and an unescaped # outside a         when  compiling  is when PCRE_EXTENDED is set. CR and LF are whitespace
1305         character class is encountered. This indicates  a  comment  that  lasts         characters, and so are ignored in this mode. Also, an unescaped #  out-
1306         until  after the next line break sequence. In other circumstances, line         side  a  character class indicates a comment that lasts until after the
1307         break  sequences  are  treated  as  literal  data,   except   that   in         next line break sequence. In other circumstances, line break  sequences
1308         PCRE_EXTENDED mode, both CR and LF are treated as whitespace characters         in patterns are treated as literal data.
        and are therefore ignored.  
1309    
1310         The newline option that is set at compile time becomes the default that         The newline option that is set at compile time becomes the default that
1311         is  used for pcre_exec() and pcre_dfa_exec(), but it can be overridden.         is used for pcre_exec() and pcre_dfa_exec(), but it can be overridden.
1312    
1313           PCRE_NO_AUTO_CAPTURE           PCRE_NO_AUTO_CAPTURE
1314    
# Line 1345  COMPILING A PATTERN Line 1318  COMPILING A PATTERN
1318         be  used  for  capturing  (and  they acquire numbers in the usual way).         be  used  for  capturing  (and  they acquire numbers in the usual way).
1319         There is no equivalent of this option in Perl.         There is no equivalent of this option in Perl.
1320    
1321             NO_START_OPTIMIZE
1322    
1323           This is an option that acts at matching time; that is, it is really  an
1324           option  for  pcre_exec()  or  pcre_dfa_exec().  If it is set at compile
1325           time, it is remembered with the compiled pattern and assumed at  match-
1326           ing  time.  For  details  see  the discussion of PCRE_NO_START_OPTIMIZE
1327           below.
1328    
1329             PCRE_UCP
1330    
1331           This option changes the way PCRE processes \B, \b, \D, \d, \S, \s,  \W,
1332           \w,  and  some  of  the POSIX character classes. By default, only ASCII
1333           characters are recognized, but if PCRE_UCP is set,  Unicode  properties
1334           are  used instead to classify characters. More details are given in the
1335           section on generic character types in the pcrepattern page. If you  set
1336           PCRE_UCP,  matching  one of the items it affects takes much longer. The
1337           option is available only if PCRE has been compiled with  Unicode  prop-
1338           erty support.
1339    
1340           PCRE_UNGREEDY           PCRE_UNGREEDY
1341    
1342         This option inverts the "greediness" of the quantifiers  so  that  they         This  option  inverts  the "greediness" of the quantifiers so that they
1343         are  not greedy by default, but become greedy if followed by "?". It is         are not greedy by default, but become greedy if followed by "?". It  is
1344         not compatible with Perl. It can also be set by a (?U)  option  setting         not  compatible  with Perl. It can also be set by a (?U) option setting
1345         within the pattern.         within the pattern.
1346    
1347           PCRE_UTF8           PCRE_UTF8
1348    
1349         This  option  causes PCRE to regard both the pattern and the subject as         This option causes PCRE to regard both the pattern and the  subject  as
1350         strings of UTF-8 characters instead of single-byte  character  strings.         strings  of  UTF-8 characters instead of single-byte character strings.
1351         However,  it is available only when PCRE is built to include UTF-8 sup-         However, it is available only when PCRE is built to include UTF-8  sup-
1352         port. If not, the use of this option provokes an error. Details of  how         port.  If not, the use of this option provokes an error. Details of how
1353         this  option  changes the behaviour of PCRE are given in the section on         this option changes the behaviour of PCRE are given in the  pcreunicode
1354         UTF-8 support in the main pcre page.         page.
1355    
1356           PCRE_NO_UTF8_CHECK           PCRE_NO_UTF8_CHECK
1357    
1358         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
1359         automatically  checked.  There  is  a  discussion about the validity of         automatically checked. There is a  discussion  about  the  validity  of
1360         UTF-8 strings in the main pcre page. If an invalid  UTF-8  sequence  of         UTF-8  strings  in  the main pcre page. If an invalid UTF-8 sequence of
1361         bytes  is  found,  pcre_compile() returns an error. If you already know         bytes is found, pcre_compile() returns an error. If  you  already  know
1362         that your pattern is valid, and you want to skip this check for perfor-         that your pattern is valid, and you want to skip this check for perfor-
1363         mance  reasons,  you  can set the PCRE_NO_UTF8_CHECK option. When it is         mance reasons, you can set the PCRE_NO_UTF8_CHECK option.  When  it  is
1364         set, the effect of passing an invalid UTF-8  string  as  a  pattern  is         set,  the  effect  of  passing  an invalid UTF-8 string as a pattern is
1365         undefined.  It  may  cause your program to crash. Note that this option         undefined. It may cause your program to crash. Note  that  this  option
1366         can also be passed to pcre_exec() and pcre_dfa_exec(), to suppress  the         can  also be passed to pcre_exec() and pcre_dfa_exec(), to suppress the
1367         UTF-8 validity checking of subject strings.         UTF-8 validity checking of subject strings.
1368    
1369    
1370  COMPILATION ERROR CODES  COMPILATION ERROR CODES
1371    
1372         The  following  table  lists  the  error  codes than may be returned by         The following table lists the error  codes  than  may  be  returned  by
1373         pcre_compile2(), along with the error messages that may be returned  by         pcre_compile2(),  along with the error messages that may be returned by
1374         both  compiling functions. As PCRE has developed, some error codes have         both compiling functions. As PCRE has developed, some error codes  have
1375         fallen out of use. To avoid confusion, they have not been re-used.         fallen out of use. To avoid confusion, they have not been re-used.
1376    
1377            0  no error            0  no error
# Line 1419  COMPILATION ERROR CODES Line 1411  COMPILATION ERROR CODES
1411           34  character value in \x{...} sequence is too large           34  character value in \x{...} sequence is too large
1412           35  invalid condition (?(0)           35  invalid condition (?(0)
1413           36  \C not allowed in lookbehind assertion           36  \C not allowed in lookbehind assertion
1414           37  PCRE does not support \L, \l, \N, \U, or \u           37  PCRE does not support \L, \l, \N{name}, \U, or \u
1415           38  number after (?C is > 255           38  number after (?C is > 255
1416           39  closing ) for (?C expected           39  closing ) for (?C expected
1417           40  recursive call could loop indefinitely           40  recursive call could loop indefinitely
# Line 1435  COMPILATION ERROR CODES Line 1427  COMPILATION ERROR CODES
1427           50  [this code is not in use]           50  [this code is not in use]
1428           51  octal value is greater than \377 (not in UTF-8 mode)           51  octal value is greater than \377 (not in UTF-8 mode)
1429           52  internal error: overran compiling workspace           52  internal error: overran compiling workspace
1430           53  internal  error:  previously-checked  referenced  subpattern  not           53  internal error: previously-checked referenced subpattern
1431         found                 not found
1432           54  DEFINE group contains more than one branch           54  DEFINE group contains more than one branch
1433           55  repeating a DEFINE group is not allowed           55  repeating a DEFINE group is not allowed
1434           56  inconsistent NEWLINE options           56  inconsistent NEWLINE options
1435           57  \g is not followed by a braced, angle-bracketed, or quoted           57  \g is not followed by a braced, angle-bracketed, or quoted
1436                 name/number or by a plain number                 name/number or by a plain number
1437           58  a numbered reference must not be zero           58  a numbered reference must not be zero
1438           59  (*VERB) with an argument is not supported           59  an argument is not allowed for (*ACCEPT), (*FAIL), or (*COMMIT)
1439           60  (*VERB) not recognized           60  (*VERB) not recognized
1440           61  number is too big           61  number is too big
1441           62  subpattern name expected           62  subpattern name expected
1442           63  digit expected after (?+           63  digit expected after (?+
1443           64  ] is an invalid data character in JavaScript compatibility mode           64  ] is an invalid data character in JavaScript compatibility mode
1444             65  different names for subpatterns of the same number are
1445                   not allowed
1446             66  (*MARK) must have an argument
1447             67  this version of PCRE is not compiled with PCRE_UCP support
1448             68  \c must be followed by an ASCII character
1449             69  \k is not followed by a braced, angle-bracketed, or quoted name
1450    
1451         The  numbers  32  and 10000 in errors 48 and 49 are defaults; different         The  numbers  32  and 10000 in errors 48 and 49 are defaults; different
1452         values may be used if the limits were changed when PCRE was built.         values may be used if the limits were changed when PCRE was built.
# Line 1468  STUDYING A PATTERN Line 1466  STUDYING A PATTERN
1466         the results of the study.         the results of the study.
1467    
1468         The  returned  value  from  pcre_study()  can  be  passed  directly  to         The  returned  value  from  pcre_study()  can  be  passed  directly  to
1469         pcre_exec().  However,  a  pcre_extra  block also contains other fields         pcre_exec()  or  pcre_dfa_exec(). However, a pcre_extra block also con-
1470         that can be set by the caller before the block  is  passed;  these  are         tains other fields that can be set by the caller before  the  block  is
1471         described below in the section on matching a pattern.         passed; these are described below in the section on matching a pattern.
1472    
1473         If  studying  the  pattern  does not produce any additional information         If  studying  the  pattern  does  not  produce  any useful information,
1474         pcre_study() returns NULL. In that circumstance, if the calling program         pcre_study() returns NULL. In that circumstance, if the calling program
1475         wants  to  pass  any of the other fields to pcre_exec(), it must set up         wants   to   pass   any   of   the   other  fields  to  pcre_exec()  or
1476         its own pcre_extra block.         pcre_dfa_exec(), it must set up its own pcre_extra block.
1477    
1478         The second argument of pcre_study() contains option bits.  At  present,         The second argument of pcre_study() contains option bits. There is only
1479         no options are defined, and this argument should always be zero.         one  option:  PCRE_STUDY_JIT_COMPILE.  If this is set, and the just-in-
1480           time compiler is  available,  the  pattern  is  further  compiled  into
1481           machine  code  that  executes much faster than the pcre_exec() matching
1482           function. If the just-in-time compiler is not available, this option is
1483           ignored. All other bits in the options argument must be zero.
1484    
1485           JIT  compilation  is  a heavyweight optimization. It can take some time
1486           for patterns to be analyzed, and for one-off matches  and  simple  pat-
1487           terns  the benefit of faster execution might be offset by a much slower
1488           study time.  Not all patterns can be optimized by the JIT compiler. For
1489           those  that cannot be handled, matching automatically falls back to the
1490           pcre_exec() interpreter. For more details, see the  pcrejit  documenta-
1491           tion.
1492    
1493         The  third argument for pcre_study() is a pointer for an error message.         The  third argument for pcre_study() is a pointer for an error message.
1494         If studying succeeds (even if no data is  returned),  the  variable  it         If studying succeeds (even if no data is  returned),  the  variable  it
# Line 1487  STUDYING A PATTERN Line 1497  STUDYING A PATTERN
1497         must  not  try  to  free it. You should test the error pointer for NULL         must  not  try  to  free it. You should test the error pointer for NULL
1498         after calling pcre_study(), to be sure that it has run successfully.         after calling pcre_study(), to be sure that it has run successfully.
1499    
1500         This is a typical call to pcre_study():         When you are finished with a pattern, you can free the memory used  for
1501           the study data by calling pcre_free_study(). This function was added to
1502           the API for release 8.20. For earlier versions,  the  memory  could  be
1503           freed  with  pcre_free(), just like the pattern itself. This will still
1504           work in cases where PCRE_STUDY_JIT_COMPILE  is  not  used,  but  it  is
1505           advisable to change to the new function when convenient.
1506    
1507           This  is  a typical way in which pcre_study() is used (except that in a
1508           real application there should be tests for errors):
1509    
1510           pcre_extra *pe;           int rc;
1511           pe = pcre_study(           pcre *re;
1512             pcre_extra *sd;
1513             re = pcre_compile("pattern", 0, &error, &erroroffset, NULL);
1514             sd = pcre_study(
1515             re,             /* result of pcre_compile() */             re,             /* result of pcre_compile() */
1516             0,              /* no options exist */             0,              /* no options */
1517             &error);        /* set to NULL or points to a message */             &error);        /* set to NULL or points to a message */
1518             rc = pcre_exec(   /* see below for details of pcre_exec() options */
1519         At present, studying a pattern is useful only for non-anchored patterns             re, sd, "subject", 7, 0, 0, ovector, 30);
1520         that  do not have a single fixed starting character. A bitmap of possi-           ...
1521         ble starting bytes is created.           pcre_free_study(sd);
1522             pcre_free(re);
1523    
1524           Studying a pattern does two things: first, a lower bound for the length
1525           of subject string that is needed to match the pattern is computed. This
1526           does not mean that there are any strings of that length that match, but
1527           it  does  guarantee that no shorter strings match. The value is used by
1528           pcre_exec() and pcre_dfa_exec() to avoid  wasting  time  by  trying  to
1529           match  strings  that are shorter than the lower bound. You can find out
1530           the value in a calling program via the pcre_fullinfo() function.
1531    
1532           Studying a pattern is also useful for non-anchored patterns that do not
1533           have  a  single fixed starting character. A bitmap of possible starting
1534           bytes is created. This speeds up finding a position in the  subject  at
1535           which to start matching.
1536    
1537           These  two optimizations apply to both pcre_exec() and pcre_dfa_exec().
1538           However, they are not used by pcre_exec()  if  pcre_study()  is  called
1539           with  the  PCRE_STUDY_JIT_COMPILE option, and just-in-time compiling is
1540           successful.  The  optimizations  can  be  disabled   by   setting   the
1541           PCRE_NO_START_OPTIMIZE    option    when    calling    pcre_exec()   or
1542           pcre_dfa_exec(). You might want to do this  if  your  pattern  contains
1543           callouts  or (*MARK) (which cannot be handled by the JIT compiler), and
1544           you want to make use of these facilities in cases where matching fails.
1545           See the discussion of PCRE_NO_START_OPTIMIZE below.
1546    
1547    
1548  LOCALE SUPPORT  LOCALE SUPPORT
1549    
1550         PCRE handles caseless matching, and determines whether  characters  are         PCRE  handles  caseless matching, and determines whether characters are
1551         letters,  digits, or whatever, by reference to a set of tables, indexed         letters, digits, or whatever, by reference to a set of tables,  indexed
1552         by character value. When running in UTF-8 mode, this  applies  only  to         by  character  value.  When running in UTF-8 mode, this applies only to
1553         characters  with  codes  less than 128. Higher-valued codes never match         characters with codes less than 128. By  default,  higher-valued  codes
1554         escapes such as \w or \d, but can be tested with \p if  PCRE  is  built         never match escapes such as \w or \d, but they can be tested with \p if
1555         with  Unicode  character property support. The use of locales with Uni-         PCRE is built with Unicode character property  support.  Alternatively,
1556         code is discouraged. If you are handling characters with codes  greater         the  PCRE_UCP  option  can  be  set at compile time; this causes \w and
1557         than  128, you should either use UTF-8 and Unicode, or use locales, but         friends to use Unicode property support instead of built-in tables. The
1558         not try to mix the two.         use of locales with Unicode is discouraged. If you are handling charac-
1559           ters with codes greater than 128, you should either use UTF-8 and  Uni-
1560           code, or use locales, but not try to mix the two.
1561    
1562         PCRE contains an internal set of tables that are used  when  the  final         PCRE  contains  an  internal set of tables that are used when the final
1563         argument  of  pcre_compile()  is  NULL.  These  are sufficient for many         argument of pcre_compile() is  NULL.  These  are  sufficient  for  many
1564         applications.  Normally, the internal tables recognize only ASCII char-         applications.  Normally, the internal tables recognize only ASCII char-
1565         acters. However, when PCRE is built, it is possible to cause the inter-         acters. However, when PCRE is built, it is possible to cause the inter-
1566         nal tables to be rebuilt in the default "C" locale of the local system,         nal tables to be rebuilt in the default "C" locale of the local system,
1567         which may cause them to be different.         which may cause them to be different.
1568    
1569         The  internal tables can always be overridden by tables supplied by the         The internal tables can always be overridden by tables supplied by  the
1570         application that calls PCRE. These may be created in a different locale         application that calls PCRE. These may be created in a different locale
1571         from  the  default.  As more and more applications change to using Uni-         from the default. As more and more applications change  to  using  Uni-
1572         code, the need for this locale support is expected to die away.         code, the need for this locale support is expected to die away.
1573    
1574         External tables are built by calling  the  pcre_maketables()  function,         External  tables  are  built by calling the pcre_maketables() function,
1575         which  has no arguments, in the relevant locale. The result can then be         which has no arguments, in the relevant locale. The result can then  be
1576         passed to pcre_compile() or pcre_exec()  as  often  as  necessary.  For         passed  to  pcre_compile()  or  pcre_exec()  as often as necessary. For
1577         example,  to  build  and use tables that are appropriate for the French         example, to build and use tables that are appropriate  for  the  French
1578         locale (where accented characters with  values  greater  than  128  are         locale  (where  accented  characters  with  values greater than 128 are
1579         treated as letters), the following code could be used:         treated as letters), the following code could be used:
1580    
1581           setlocale(LC_CTYPE, "fr_FR");           setlocale(LC_CTYPE, "fr_FR");
1582           tables = pcre_maketables();           tables = pcre_maketables();
1583           re = pcre_compile(..., tables);           re = pcre_compile(..., tables);
1584    
1585         The  locale  name "fr_FR" is used on Linux and other Unix-like systems;         The locale name "fr_FR" is used on Linux and other  Unix-like  systems;
1586         if you are using Windows, the name for the French locale is "french".         if you are using Windows, the name for the French locale is "french".
1587    
1588         When pcre_maketables() runs, the tables are built  in  memory  that  is         When  pcre_maketables()  runs,  the  tables are built in memory that is
1589         obtained  via  pcre_malloc. It is the caller's responsibility to ensure         obtained via pcre_malloc. It is the caller's responsibility  to  ensure
1590         that the memory containing the tables remains available for as long  as         that  the memory containing the tables remains available for as long as
1591         it is needed.         it is needed.
1592    
1593         The pointer that is passed to pcre_compile() is saved with the compiled         The pointer that is passed to pcre_compile() is saved with the compiled
1594         pattern, and the same tables are used via this pointer by  pcre_study()         pattern,  and the same tables are used via this pointer by pcre_study()
1595         and normally also by pcre_exec(). Thus, by default, for any single pat-         and normally also by pcre_exec(). Thus, by default, for any single pat-
1596         tern, compilation, studying and matching all happen in the same locale,         tern, compilation, studying and matching all happen in the same locale,
1597         but different patterns can be compiled in different locales.         but different patterns can be compiled in different locales.
1598    
1599         It  is  possible to pass a table pointer or NULL (indicating the use of         It is possible to pass a table pointer or NULL (indicating the  use  of
1600         the internal tables) to pcre_exec(). Although  not  intended  for  this         the  internal  tables)  to  pcre_exec(). Although not intended for this
1601         purpose,  this facility could be used to match a pattern in a different         purpose, this facility could be used to match a pattern in a  different
1602         locale from the one in which it was compiled. Passing table pointers at         locale from the one in which it was compiled. Passing table pointers at
1603         run time is discussed below in the section on matching a pattern.         run time is discussed below in the section on matching a pattern.
1604    
# Line 1561  INFORMATION ABOUT A PATTERN Line 1608  INFORMATION ABOUT A PATTERN
1608         int pcre_fullinfo(const pcre *code, const pcre_extra *extra,         int pcre_fullinfo(const pcre *code, const pcre_extra *extra,
1609              int what, void *where);              int what, void *where);
1610    
1611         The  pcre_fullinfo() function returns information about a compiled pat-         The pcre_fullinfo() function returns information about a compiled  pat-
1612         tern. It replaces the obsolete pcre_info() function, which is neverthe-         tern. It replaces the obsolete pcre_info() function, which is neverthe-
1613         less retained for backwards compability (and is documented below).         less retained for backwards compability (and is documented below).
1614    
1615         The  first  argument  for  pcre_fullinfo() is a pointer to the compiled         The first argument for pcre_fullinfo() is a  pointer  to  the  compiled
1616         pattern. The second argument is the result of pcre_study(), or NULL  if         pattern.  The second argument is the result of pcre_study(), or NULL if
1617         the  pattern  was not studied. The third argument specifies which piece         the pattern was not studied. The third argument specifies  which  piece
1618         of information is required, and the fourth argument is a pointer  to  a         of  information  is required, and the fourth argument is a pointer to a
1619         variable  to  receive  the  data. The yield of the function is zero for         variable to receive the data. The yield of the  function  is  zero  for
1620         success, or one of the following negative numbers:         success, or one of the following negative numbers:
1621    
1622           PCRE_ERROR_NULL       the argument code was NULL           PCRE_ERROR_NULL       the argument code was NULL
# Line 1577  INFORMATION ABOUT A PATTERN Line 1624  INFORMATION ABOUT A PATTERN
1624           PCRE_ERROR_BADMAGIC   the "magic number" was not found           PCRE_ERROR_BADMAGIC   the "magic number" was not found
1625           PCRE_ERROR_BADOPTION  the value of what was invalid           PCRE_ERROR_BADOPTION  the value of what was invalid
1626    
1627         The "magic number" is placed at the start of each compiled  pattern  as         The  "magic  number" is placed at the start of each compiled pattern as
1628         an  simple check against passing an arbitrary memory pointer. Here is a         an simple check against passing an arbitrary memory pointer. Here is  a
1629         typical call of pcre_fullinfo(), to obtain the length of  the  compiled         typical  call  of pcre_fullinfo(), to obtain the length of the compiled
1630         pattern:         pattern:
1631    
1632           int rc;           int rc;
1633           size_t length;           size_t length;
1634           rc = pcre_fullinfo(           rc = pcre_fullinfo(
1635             re,               /* result of pcre_compile() */             re,               /* result of pcre_compile() */
1636             pe,               /* result of pcre_study(), or NULL */             sd,               /* result of pcre_study(), or NULL */
1637             PCRE_INFO_SIZE,   /* what is required */             PCRE_INFO_SIZE,   /* what is required */
1638             &length);         /* where to put the data */             &length);         /* where to put the data */
1639    
1640         The  possible  values for the third argument are defined in pcre.h, and         The possible values for the third argument are defined in  pcre.h,  and
1641         are as follows:         are as follows:
1642    
1643           PCRE_INFO_BACKREFMAX           PCRE_INFO_BACKREFMAX
1644    
1645         Return the number of the highest back reference  in  the  pattern.  The         Return  the  number  of  the highest back reference in the pattern. The
1646         fourth  argument  should  point to an int variable. Zero is returned if         fourth argument should point to an int variable. Zero  is  returned  if
1647         there are no back references.         there are no back references.
1648    
1649           PCRE_INFO_CAPTURECOUNT           PCRE_INFO_CAPTURECOUNT
1650    
1651         Return the number of capturing subpatterns in the pattern.  The  fourth         Return  the  number of capturing subpatterns in the pattern. The fourth
1652         argument should point to an int variable.         argument should point to an int variable.
1653    
1654           PCRE_INFO_DEFAULT_TABLES           PCRE_INFO_DEFAULT_TABLES
1655    
1656         Return  a pointer to the internal default character tables within PCRE.         Return a pointer to the internal default character tables within  PCRE.
1657         The fourth argument should point to an unsigned char *  variable.  This         The  fourth  argument should point to an unsigned char * variable. This
1658         information call is provided for internal use by the pcre_study() func-         information call is provided for internal use by the pcre_study() func-
1659         tion. External callers can cause PCRE to use  its  internal  tables  by         tion.  External  callers  can  cause PCRE to use its internal tables by
1660         passing a NULL table pointer.         passing a NULL table pointer.
1661    
1662           PCRE_INFO_FIRSTBYTE           PCRE_INFO_FIRSTBYTE
1663    
1664         Return  information  about  the first byte of any matched string, for a         Return information about the first byte of any matched  string,  for  a
1665         non-anchored pattern. The fourth argument should point to an int  vari-         non-anchored  pattern. The fourth argument should point to an int vari-
1666         able.  (This option used to be called PCRE_INFO_FIRSTCHAR; the old name         able. (This option used to be called PCRE_INFO_FIRSTCHAR; the old  name
1667         is still recognized for backwards compatibility.)         is still recognized for backwards compatibility.)
1668    
1669         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
1670         (cat|cow|coyote), its value is returned. Otherwise, if either         (cat|cow|coyote), its value is returned. Otherwise, if either
1671    
1672         (a)  the pattern was compiled with the PCRE_MULTILINE option, and every         (a) the pattern was compiled with the PCRE_MULTILINE option, and  every
1673         branch starts with "^", or         branch starts with "^", or
1674    
1675         (b) every branch of the pattern starts with ".*" and PCRE_DOTALL is not         (b) every branch of the pattern starts with ".*" and PCRE_DOTALL is not
1676         set (if it were set, the pattern would be anchored),         set (if it were set, the pattern would be anchored),
1677    
1678         -1  is  returned, indicating that the pattern matches only at the start         -1 is returned, indicating that the pattern matches only at  the  start
1679         of a subject string or after any newline within the  string.  Otherwise         of  a  subject string or after any newline within the string. Otherwise
1680         -2 is returned. For anchored patterns, -2 is returned.         -2 is returned. For anchored patterns, -2 is returned.
1681    
1682           PCRE_INFO_FIRSTTABLE           PCRE_INFO_FIRSTTABLE
1683    
1684         If  the pattern was studied, and this resulted in the construction of a         If the pattern was studied, and this resulted in the construction of  a
1685         256-bit table indicating a fixed set of bytes for the first byte in any         256-bit table indicating a fixed set of bytes for the first byte in any
1686         matching  string, a pointer to the table is returned. Otherwise NULL is         matching string, a pointer to the table is returned. Otherwise NULL  is
1687         returned. The fourth argument should point to an unsigned char *  vari-         returned.  The fourth argument should point to an unsigned char * vari-
1688         able.         able.
1689    
1690           PCRE_INFO_HASCRORLF           PCRE_INFO_HASCRORLF
1691    
1692         Return  1  if  the  pattern  contains any explicit matches for CR or LF         Return 1 if the pattern contains any explicit  matches  for  CR  or  LF
1693         characters, otherwise 0. The fourth argument should  point  to  an  int         characters,  otherwise  0.  The  fourth argument should point to an int
1694         variable.  An explicit match is either a literal CR or LF character, or         variable. An explicit match is either a literal CR or LF character,  or
1695         \r or \n.         \r or \n.
1696    
1697           PCRE_INFO_JCHANGED           PCRE_INFO_JCHANGED
1698    
1699         Return 1 if the (?J) or (?-J) option setting is used  in  the  pattern,         Return  1  if  the (?J) or (?-J) option setting is used in the pattern,
1700         otherwise  0. The fourth argument should point to an int variable. (?J)         otherwise 0. The fourth argument should point to an int variable.  (?J)
1701         and (?-J) set and unset the local PCRE_DUPNAMES option, respectively.         and (?-J) set and unset the local PCRE_DUPNAMES option, respectively.
1702    
1703             PCRE_INFO_JIT
1704    
1705           Return  1  if  the  pattern was studied with the PCRE_STUDY_JIT_COMPILE
1706           option, and just-in-time compiling was successful. The fourth  argument
1707           should  point  to  an  int variable. A return value of 0 means that JIT
1708           support is not available in this version of PCRE, or that  the  pattern
1709           was not studied with the PCRE_STUDY_JIT_COMPILE option, or that the JIT
1710           compiler could not handle this particular pattern. See the pcrejit doc-
1711           umentation for details of what can and cannot be handled.
1712    
1713           PCRE_INFO_LASTLITERAL           PCRE_INFO_LASTLITERAL
1714    
1715         Return the value of the rightmost literal byte that must exist  in  any         Return  the  value of the rightmost literal byte that must exist in any
1716         matched  string,  other  than  at  its  start,  if such a byte has been         matched string, other than at its  start,  if  such  a  byte  has  been
1717         recorded. The fourth argument should point to an int variable. If there         recorded. The fourth argument should point to an int variable. If there
1718         is  no such byte, -1 is returned. For anchored patterns, a last literal         is no such byte, -1 is returned. For anchored patterns, a last  literal
1719         byte is recorded only if it follows something of variable  length.  For         byte  is  recorded only if it follows something of variable length. For
1720         example, for the pattern /^a\d+z\d+/ the returned value is "z", but for         example, for the pattern /^a\d+z\d+/ the returned value is "z", but for
1721         /^a\dz\d/ the returned value is -1.         /^a\dz\d/ the returned value is -1.
1722    
1723             PCRE_INFO_MINLENGTH
1724    
1725           If  the  pattern  was studied and a minimum length for matching subject
1726           strings was computed, its value is  returned.  Otherwise  the  returned
1727           value  is  -1. The value is a number of characters, not bytes (this may
1728           be relevant in UTF-8 mode). The fourth argument should point to an  int
1729           variable.  A  non-negative  value is a lower bound to the length of any
1730           matching string. There may not be any strings of that  length  that  do
1731           actually match, but every string that does match is at least that long.
1732    
1733           PCRE_INFO_NAMECOUNT           PCRE_INFO_NAMECOUNT
1734           PCRE_INFO_NAMEENTRYSIZE           PCRE_INFO_NAMEENTRYSIZE
1735           PCRE_INFO_NAMETABLE           PCRE_INFO_NAMETABLE
1736    
1737         PCRE supports the use of named as well as numbered capturing  parenthe-         PCRE  supports the use of named as well as numbered capturing parenthe-
1738         ses.  The names are just an additional way of identifying the parenthe-         ses. The names are just an additional way of identifying the  parenthe-
1739         ses, which still acquire numbers. Several convenience functions such as         ses, which still acquire numbers. Several convenience functions such as
1740         pcre_get_named_substring()  are  provided  for extracting captured sub-         pcre_get_named_substring() are provided for  extracting  captured  sub-
1741         strings by name. It is also possible to extract the data  directly,  by         strings  by  name. It is also possible to extract the data directly, by
1742         first  converting  the  name to a number in order to access the correct         first converting the name to a number in order to  access  the  correct
1743         pointers in the output vector (described with pcre_exec() below). To do         pointers in the output vector (described with pcre_exec() below). To do
1744         the  conversion,  you  need  to  use  the  name-to-number map, which is         the conversion, you need  to  use  the  name-to-number  map,  which  is
1745         described by these three values.         described by these three values.
1746    
1747         The map consists of a number of fixed-size entries. PCRE_INFO_NAMECOUNT         The map consists of a number of fixed-size entries. PCRE_INFO_NAMECOUNT
1748         gives the number of entries, and PCRE_INFO_NAMEENTRYSIZE gives the size         gives the number of entries, and PCRE_INFO_NAMEENTRYSIZE gives the size
1749         of each entry; both of these  return  an  int  value.  The  entry  size         of  each  entry;  both  of  these  return  an int value. The entry size
1750         depends  on the length of the longest name. PCRE_INFO_NAMETABLE returns         depends on the length of the longest name. PCRE_INFO_NAMETABLE  returns
1751         a pointer to the first entry of the table  (a  pointer  to  char).  The         a  pointer  to  the  first  entry of the table (a pointer to char). The
1752         first two bytes of each entry are the number of the capturing parenthe-         first two bytes of each entry are the number of the capturing parenthe-
1753         sis, most significant byte first. The rest of the entry is  the  corre-         sis,  most  significant byte first. The rest of the entry is the corre-
1754         sponding  name,  zero  terminated. The names are in alphabetical order.         sponding name, zero terminated.
1755         When PCRE_DUPNAMES is set, duplicate names are in order of their paren-  
1756         theses  numbers.  For  example,  consider the following pattern (assume         The names are in alphabetical order. Duplicate names may appear if  (?|
1757         PCRE_EXTENDED is  set,  so  white  space  -  including  newlines  -  is         is used to create multiple groups with the same number, as described in
1758         ignored):         the section on duplicate subpattern numbers in  the  pcrepattern  page.
1759           Duplicate  names  for  subpatterns with different numbers are permitted
1760           only if PCRE_DUPNAMES is set. In all cases  of  duplicate  names,  they
1761           appear  in  the table in the order in which they were found in the pat-
1762           tern. In the absence of (?| this is the  order  of  increasing  number;
1763           when (?| is used this is not necessarily the case because later subpat-
1764           terns may have lower numbers.
1765    
1766           As a simple example of the name/number table,  consider  the  following
1767           pattern  (assume  PCRE_EXTENDED is set, so white space - including new-
1768           lines - is ignored):
1769    
1770           (?<date> (?<year>(\d\d)?\d\d) -           (?<date> (?<year>(\d\d)?\d\d) -
1771           (?<month>\d\d) - (?<day>\d\d) )           (?<month>\d\d) - (?<day>\d\d) )
1772    
1773         There  are  four  named subpatterns, so the table has four entries, and         There are four named subpatterns, so the table has  four  entries,  and
1774         each entry in the table is eight bytes long. The table is  as  follows,         each  entry  in the table is eight bytes long. The table is as follows,
1775         with non-printing bytes shows in hexadecimal, and undefined bytes shown         with non-printing bytes shows in hexadecimal, and undefined bytes shown
1776         as ??:         as ??:
1777    
# Line 1703  INFORMATION ABOUT A PATTERN Line 1780  INFORMATION ABOUT A PATTERN
1780           00 04 m  o  n  t  h  00           00 04 m  o  n  t  h  00
1781           00 02 y  e  a  r  00 ??           00 02 y  e  a  r  00 ??
1782    
1783         When writing code to extract data  from  named  subpatterns  using  the         When  writing  code  to  extract  data from named subpatterns using the
1784         name-to-number  map,  remember that the length of the entries is likely         name-to-number map, remember that the length of the entries  is  likely
1785         to be different for each compiled pattern.         to be different for each compiled pattern.
1786    
1787           PCRE_INFO_OKPARTIAL           PCRE_INFO_OKPARTIAL
1788    
1789         Return 1 if the pattern can be used for partial matching, otherwise  0.         Return  1  if  the  pattern  can  be  used  for  partial  matching with
1790         The  fourth  argument  should point to an int variable. The pcrepartial         pcre_exec(), otherwise 0. The fourth argument should point  to  an  int
1791         documentation lists the restrictions that apply to patterns  when  par-         variable.  From  release  8.00,  this  always  returns  1,  because the
1792         tial matching is used.         restrictions that previously applied  to  partial  matching  have  been
1793           lifted.  The  pcrepartial documentation gives details of partial match-
1794           ing.
1795    
1796           PCRE_INFO_OPTIONS           PCRE_INFO_OPTIONS
1797    
1798         Return  a  copy of the options with which the pattern was compiled. The         Return a copy of the options with which the pattern was  compiled.  The
1799         fourth argument should point to an unsigned long  int  variable.  These         fourth  argument  should  point to an unsigned long int variable. These
1800         option bits are those specified in the call to pcre_compile(), modified         option bits are those specified in the call to pcre_compile(), modified
1801         by any top-level option settings at the start of the pattern itself. In         by any top-level option settings at the start of the pattern itself. In
1802         other  words,  they are the options that will be in force when matching         other words, they are the options that will be in force  when  matching
1803         starts. For example, if the pattern /(?im)abc(?-i)d/ is  compiled  with         starts.  For  example, if the pattern /(?im)abc(?-i)d/ is compiled with
1804         the  PCRE_EXTENDED option, the result is PCRE_CASELESS, PCRE_MULTILINE,         the PCRE_EXTENDED option, the result is PCRE_CASELESS,  PCRE_MULTILINE,
1805         and PCRE_EXTENDED.         and PCRE_EXTENDED.
1806    
1807         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
1808         alternatives begin with one of the following:         alternatives begin with one of the following:
1809    
1810           ^     unless PCRE_MULTILINE is set           ^     unless PCRE_MULTILINE is set
# Line 1739  INFORMATION ABOUT A PATTERN Line 1818  INFORMATION ABOUT A PATTERN
1818    
1819           PCRE_INFO_SIZE           PCRE_INFO_SIZE
1820    
1821         Return the size of the compiled pattern, that is, the  value  that  was         Return  the  size  of the compiled pattern, that is, the value that was
1822         passed as the argument to pcre_malloc() when PCRE was getting memory in         passed as the argument to pcre_malloc() when PCRE was getting memory in
1823         which to place the compiled data. The fourth argument should point to a         which to place the compiled data. The fourth argument should point to a
1824         size_t variable.         size_t variable.
# Line 1747  INFORMATION ABOUT A PATTERN Line 1826  INFORMATION ABOUT A PATTERN
1826           PCRE_INFO_STUDYSIZE           PCRE_INFO_STUDYSIZE
1827    
1828         Return the size of the data block pointed to by the study_data field in         Return the size of the data block pointed to by the study_data field in
1829         a pcre_extra block. That is,  it  is  the  value  that  was  passed  to         a  pcre_extra  block. If pcre_extra is NULL, or there is no study data,
1830         pcre_malloc() when PCRE was getting memory into which to place the data         zero is returned. The fourth argument should point to  a  size_t  vari-
1831         created by pcre_study(). The fourth argument should point to  a  size_t         able.   The  study_data field is set by pcre_study() to record informa-
1832         variable.         tion that will speed up matching (see the section entitled "Studying  a
1833           pattern" above). The format of the study_data block is private, but its
1834           length is made available via this option so that it can  be  saved  and
1835           restored (see the pcreprecompile documentation for details).
1836    
1837    
1838  OBSOLETE INFO FUNCTION  OBSOLETE INFO FUNCTION
# Line 1803  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 1885  MATCHING A PATTERN: THE TRADITIONAL FUNC
1885              const char *subject, int length, int startoffset,              const char *subject, int length, int startoffset,
1886              int options, int *ovector, int ovecsize);              int options, int *ovector, int ovecsize);
1887    
1888         The  function pcre_exec() is called to match a subject string against a         The function pcre_exec() is called to match a subject string against  a
1889         compiled pattern, which is passed in the code argument. If the  pattern         compiled  pattern, which is passed in the code argument. If the pattern
1890         has been studied, the result of the study should be passed in the extra         was studied, the result of the study should  be  passed  in  the  extra
1891         argument. This function is the main matching facility of  the  library,         argument.  You  can call pcre_exec() with the same code and extra argu-
1892         and it operates in a Perl-like manner. For specialist use there is also         ments as many times as you like, in order to  match  different  subject
1893         an alternative matching function, which is described below in the  sec-         strings with the same pattern.
1894         tion about the pcre_dfa_exec() function.  
1895           This  function  is  the  main  matching facility of the library, and it
1896           operates in a Perl-like manner. For specialist use  there  is  also  an
1897           alternative  matching function, which is described below in the section
1898           about the pcre_dfa_exec() function.
1899    
1900         In  most applications, the pattern will have been compiled (and option-         In most applications, the pattern will have been compiled (and  option-
1901         ally studied) in the same process that calls pcre_exec().  However,  it         ally  studied)  in the same process that calls pcre_exec(). However, it
1902         is possible to save compiled patterns and study data, and then use them         is possible to save compiled patterns and study data, and then use them
1903         later in different processes, possibly even on different hosts.  For  a         later  in  different processes, possibly even on different hosts. For a
1904         discussion about this, see the pcreprecompile documentation.         discussion about this, see the pcreprecompile documentation.
1905    
1906         Here is an example of a simple call to pcre_exec():         Here is an example of a simple call to pcre_exec():
# Line 1833  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 1919  MATCHING A PATTERN: THE TRADITIONAL FUNC
1919    
1920     Extra data for pcre_exec()     Extra data for pcre_exec()
1921    
1922         If  the  extra argument is not NULL, it must point to a pcre_extra data         If the extra argument is not NULL, it must point to a  pcre_extra  data
1923         block. The pcre_study() function returns such a block (when it  doesn't         block.  The pcre_study() function returns such a block (when it doesn't
1924         return  NULL), but you can also create one for yourself, and pass addi-         return NULL), but you can also create one for yourself, and pass  addi-
1925         tional information in it. The pcre_extra block contains  the  following         tional  information  in it. The pcre_extra block contains the following
1926         fields (not necessarily in this order):         fields (not necessarily in this order):
1927    
1928           unsigned long int flags;           unsigned long int flags;
1929           void *study_data;           void *study_data;
1930             void *executable_jit;
1931           unsigned long int match_limit;           unsigned long int match_limit;
1932           unsigned long int match_limit_recursion;           unsigned long int match_limit_recursion;
1933           void *callout_data;           void *callout_data;
1934           const unsigned char *tables;           const unsigned char *tables;
1935             unsigned char **mark;
1936    
1937         The  flags  field  is a bitmap that specifies which of the other fields         The flags field is a bitmap that specifies which of  the  other  fields
1938         are set. The flag bits are:         are set. The flag bits are:
1939    
1940           PCRE_EXTRA_STUDY_DATA           PCRE_EXTRA_STUDY_DATA
1941             PCRE_EXTRA_EXECUTABLE_JIT
1942           PCRE_EXTRA_MATCH_LIMIT           PCRE_EXTRA_MATCH_LIMIT
1943           PCRE_EXTRA_MATCH_LIMIT_RECURSION           PCRE_EXTRA_MATCH_LIMIT_RECURSION
1944           PCRE_EXTRA_CALLOUT_DATA           PCRE_EXTRA_CALLOUT_DATA
1945           PCRE_EXTRA_TABLES           PCRE_EXTRA_TABLES
1946             PCRE_EXTRA_MARK
1947    
1948         Other flag bits should be set to zero. The study_data field is  set  in         Other  flag  bits should be set to zero. The study_data field and some-
1949         the  pcre_extra  block  that is returned by pcre_study(), together with         times the executable_jit field are set in the pcre_extra block that  is
1950         the appropriate flag bit. You should not set this yourself, but you may         returned  by pcre_study(), together with the appropriate flag bits. You
1951         add  to  the  block by setting the other fields and their corresponding         should not set these yourself, but you may add to the block by  setting
1952         flag bits.         the other fields and their corresponding flag bits.
1953    
1954         The match_limit field provides a means of preventing PCRE from using up         The match_limit field provides a means of preventing PCRE from using up
1955         a  vast amount of resources when running patterns that are not going to         a vast amount of resources when running patterns that are not going  to
1956         match, but which have a very large number  of  possibilities  in  their         match,  but  which  have  a very large number of possibilities in their
1957         search  trees.  The  classic  example  is  the  use of nested unlimited         search trees. The classic example is a pattern that uses nested  unlim-
1958         repeats.         ited repeats.
1959    
1960         Internally, PCRE uses a function called match() which it calls  repeat-         Internally,  pcre_exec() uses a function called match(), which it calls
1961         edly  (sometimes  recursively). The limit set by match_limit is imposed         repeatedly (sometimes recursively). The limit  set  by  match_limit  is
1962         on the number of times this function is called during  a  match,  which         imposed  on the number of times this function is called during a match,
1963         has  the  effect  of  limiting the amount of backtracking that can take         which has the effect of limiting the amount of  backtracking  that  can
1964         place. For patterns that are not anchored, the count restarts from zero         take place. For patterns that are not anchored, the count restarts from
1965         for each position in the subject string.         zero for each position in the subject string.
1966    
1967           When pcre_exec() is called with a pattern that was successfully studied
1968           with  the  PCRE_STUDY_JIT_COMPILE  option, the way that the matching is
1969           executed is entirely different. However, there is still the possibility
1970           of  runaway  matching  that  goes  on  for a very long time, and so the
1971           match_limit value is also used in this case (but in a different way) to
1972           limit how long the matching can continue.
1973    
1974         The  default  value  for  the  limit can be set when PCRE is built; the         The  default  value  for  the  limit can be set when PCRE is built; the
1975         default default is 10 million, which handles all but the  most  extreme         default default is 10 million, which handles all but the  most  extreme
# Line 1887  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 1984  MATCHING A PATTERN: THE TRADITIONAL FUNC
1984         the  total number of calls, because not all calls to match() are recur-         the  total number of calls, because not all calls to match() are recur-
1985         sive.  This limit is of use only if it is set smaller than match_limit.         sive.  This limit is of use only if it is set smaller than match_limit.
1986    
1987         Limiting  the  recursion  depth  limits the amount of stack that can be         Limiting the recursion depth limits the amount of  machine  stack  that
1988         used, or, when PCRE has been compiled to use memory on the heap instead         can  be used, or, when PCRE has been compiled to use memory on the heap
1989         of the stack, the amount of heap memory that can be used.         instead of the stack, the amount of heap memory that can be used.  This
1990           limit  is not relevant, and is ignored, if the pattern was successfully
1991         The  default  value  for  match_limit_recursion can be set when PCRE is         studied with PCRE_STUDY_JIT_COMPILE.
1992         built; the default default  is  the  same  value  as  the  default  for  
1993         match_limit.  You can override the default by suppling pcre_exec() with         The default value for match_limit_recursion can be  set  when  PCRE  is
1994         a  pcre_extra  block  in  which  match_limit_recursion  is   set,   and         built;  the  default  default  is  the  same  value  as the default for
1995         PCRE_EXTRA_MATCH_LIMIT_RECURSION  is  set  in  the  flags field. If the         match_limit. You can override the default by suppling pcre_exec()  with
1996           a   pcre_extra   block  in  which  match_limit_recursion  is  set,  and
1997           PCRE_EXTRA_MATCH_LIMIT_RECURSION is set in  the  flags  field.  If  the
1998         limit is exceeded, pcre_exec() returns PCRE_ERROR_RECURSIONLIMIT.         limit is exceeded, pcre_exec() returns PCRE_ERROR_RECURSIONLIMIT.
1999    
2000         The pcre_callout field is used in conjunction with the  "callout"  fea-         The  callout_data  field is used in conjunction with the "callout" fea-
2001         ture, which is described in the pcrecallout documentation.         ture, and is described in the pcrecallout documentation.
2002    
2003         The  tables  field  is  used  to  pass  a  character  tables pointer to         The tables field  is  used  to  pass  a  character  tables  pointer  to
2004         pcre_exec(); this overrides the value that is stored with the  compiled         pcre_exec();  this overrides the value that is stored with the compiled
2005         pattern.  A  non-NULL value is stored with the compiled pattern only if         pattern. A non-NULL value is stored with the compiled pattern  only  if
2006         custom tables were supplied to pcre_compile() via  its  tableptr  argu-         custom  tables  were  supplied to pcre_compile() via its tableptr argu-
2007         ment.  If NULL is passed to pcre_exec() using this mechanism, it forces         ment.  If NULL is passed to pcre_exec() using this mechanism, it forces
2008         PCRE's internal tables to be used. This facility is  helpful  when  re-         PCRE's  internal  tables  to be used. This facility is helpful when re-
2009         using  patterns  that  have been saved after compiling with an external         using patterns that have been saved after compiling  with  an  external
2010         set of tables, because the external tables  might  be  at  a  different         set  of  tables,  because  the  external tables might be at a different
2011         address  when  pcre_exec() is called. See the pcreprecompile documenta-         address when pcre_exec() is called. See the  pcreprecompile  documenta-
2012         tion for a discussion of saving compiled patterns for later use.         tion for a discussion of saving compiled patterns for later use.
2013    
2014           If  PCRE_EXTRA_MARK  is  set in the flags field, the mark field must be
2015           set to point to a char * variable. If the pattern  contains  any  back-
2016           tracking  control verbs such as (*MARK:NAME), and the execution ends up
2017           with a name to pass back, a pointer to the  name  string  (zero  termi-
2018           nated)  is  placed  in  the  variable pointed to by the mark field. The
2019           names are within the compiled pattern; if you wish  to  retain  such  a
2020           name  you must copy it before freeing the memory of a compiled pattern.
2021           If there is no name to pass back, the variable pointed to by  the  mark
2022           field  set  to NULL. For details of the backtracking control verbs, see
2023           the section entitled "Backtracking control" in the pcrepattern documen-
2024           tation.
2025    
2026     Option bits for pcre_exec()     Option bits for pcre_exec()
2027    
2028         The unused bits of the options argument for pcre_exec() must  be  zero.         The  unused  bits of the options argument for pcre_exec() must be zero.
2029         The  only  bits  that  may  be set are PCRE_ANCHORED, PCRE_NEWLINE_xxx,         The only bits that may  be  set  are  PCRE_ANCHORED,  PCRE_NEWLINE_xxx,
2030         PCRE_NOTBOL,   PCRE_NOTEOL,   PCRE_NOTEMPTY,   PCRE_NO_UTF8_CHECK   and         PCRE_NOTBOL,    PCRE_NOTEOL,    PCRE_NOTEMPTY,   PCRE_NOTEMPTY_ATSTART,
2031         PCRE_PARTIAL.         PCRE_NO_START_OPTIMIZE,  PCRE_NO_UTF8_CHECK,   PCRE_PARTIAL_SOFT,   and
2032           PCRE_PARTIAL_HARD.
2033    
2034           If the pattern was successfully studied with the PCRE_STUDY_JIT_COMPILE
2035           option,  the   only   supported   options   for   JIT   execution   are
2036           PCRE_NO_UTF8_CHECK,   PCRE_NOTBOL,   PCRE_NOTEOL,   PCRE_NOTEMPTY,  and
2037           PCRE_NOTEMPTY_ATSTART. Note in particular that partial matching is  not
2038           supported.  If an unsupported option is used, JIT execution is disabled
2039           and the normal interpretive code in pcre_exec() is run.
2040    
2041           PCRE_ANCHORED           PCRE_ANCHORED
2042    
2043         The  PCRE_ANCHORED  option  limits pcre_exec() to matching at the first         The PCRE_ANCHORED option limits pcre_exec() to matching  at  the  first
2044         matching position. If a pattern was  compiled  with  PCRE_ANCHORED,  or         matching  position.  If  a  pattern was compiled with PCRE_ANCHORED, or
2045         turned  out to be anchored by virtue of its contents, it cannot be made         turned out to be anchored by virtue of its contents, it cannot be  made
2046         unachored at matching time.         unachored at matching time.
2047    
2048           PCRE_BSR_ANYCRLF           PCRE_BSR_ANYCRLF
2049           PCRE_BSR_UNICODE           PCRE_BSR_UNICODE
2050    
2051         These options (which are mutually exclusive) control what the \R escape         These options (which are mutually exclusive) control what the \R escape
2052         sequence  matches.  The choice is either to match only CR, LF, or CRLF,         sequence matches. The choice is either to match only CR, LF,  or  CRLF,
2053         or to match any Unicode newline sequence. These  options  override  the         or  to  match  any Unicode newline sequence. These options override the
2054         choice that was made or defaulted when the pattern was compiled.         choice that was made or defaulted when the pattern was compiled.
2055    
2056           PCRE_NEWLINE_CR           PCRE_NEWLINE_CR
# Line 1940  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 2059  MATCHING A PATTERN: THE TRADITIONAL FUNC
2059           PCRE_NEWLINE_ANYCRLF           PCRE_NEWLINE_ANYCRLF
2060           PCRE_NEWLINE_ANY           PCRE_NEWLINE_ANY
2061    
2062         These  options  override  the  newline  definition  that  was chosen or         These options override  the  newline  definition  that  was  chosen  or
2063         defaulted when the pattern was compiled. For details, see the  descrip-         defaulted  when the pattern was compiled. For details, see the descrip-
2064         tion  of  pcre_compile()  above.  During  matching,  the newline choice         tion of pcre_compile()  above.  During  matching,  the  newline  choice
2065         affects the behaviour of the dot, circumflex,  and  dollar  metacharac-         affects  the  behaviour  of the dot, circumflex, and dollar metacharac-
2066         ters.  It may also alter the way the match position is advanced after a         ters. It may also alter the way the match position is advanced after  a
2067         match failure for an unanchored pattern.         match failure for an unanchored pattern.
2068    
2069         When PCRE_NEWLINE_CRLF, PCRE_NEWLINE_ANYCRLF,  or  PCRE_NEWLINE_ANY  is         When  PCRE_NEWLINE_CRLF,  PCRE_NEWLINE_ANYCRLF,  or PCRE_NEWLINE_ANY is
2070         set,  and a match attempt for an unanchored pattern fails when the cur-         set, and a match attempt for an unanchored pattern fails when the  cur-
2071         rent position is at a  CRLF  sequence,  and  the  pattern  contains  no         rent  position  is  at  a  CRLF  sequence,  and the pattern contains no
2072         explicit  matches  for  CR  or  LF  characters,  the  match position is         explicit matches for  CR  or  LF  characters,  the  match  position  is
2073         advanced by two characters instead of one, in other words, to after the         advanced by two characters instead of one, in other words, to after the
2074         CRLF.         CRLF.
2075    
2076         The above rule is a compromise that makes the most common cases work as         The above rule is a compromise that makes the most common cases work as
2077         expected. For example, if the  pattern  is  .+A  (and  the  PCRE_DOTALL         expected.  For  example,  if  the  pattern  is .+A (and the PCRE_DOTALL
2078         option is not set), it does not match the string "\r\nA" because, after         option is not set), it does not match the string "\r\nA" because, after
2079         failing at the start, it skips both the CR and the LF before  retrying.         failing  at the start, it skips both the CR and the LF before retrying.
2080         However,  the  pattern  [\r\n]A does match that string, because it con-         However, the pattern [\r\n]A does match that string,  because  it  con-
2081         tains an explicit CR or LF reference, and so advances only by one char-         tains an explicit CR or LF reference, and so advances only by one char-
2082         acter after the first failure.         acter after the first failure.
2083    
2084         An explicit match for CR of LF is either a literal appearance of one of         An explicit match for CR of LF is either a literal appearance of one of
2085         those characters, or one of the \r or  \n  escape  sequences.  Implicit         those  characters,  or  one  of the \r or \n escape sequences. Implicit
2086         matches  such  as [^X] do not count, nor does \s (which includes CR and         matches such as [^X] do not count, nor does \s (which includes  CR  and
2087         LF in the characters that it matches).         LF in the characters that it matches).
2088    
2089         Notwithstanding the above, anomalous effects may still occur when  CRLF         Notwithstanding  the above, anomalous effects may still occur when CRLF
2090         is a valid newline sequence and explicit \r or \n escapes appear in the         is a valid newline sequence and explicit \r or \n escapes appear in the
2091         pattern.         pattern.
2092    
2093           PCRE_NOTBOL           PCRE_NOTBOL
2094    
2095         This option specifies that first character of the subject string is not         This option specifies that first character of the subject string is not
2096         the  beginning  of  a  line, so the circumflex metacharacter should not         the beginning of a line, so the  circumflex  metacharacter  should  not
2097         match before it. Setting this without PCRE_MULTILINE (at compile  time)         match  before it. Setting this without PCRE_MULTILINE (at compile time)
2098         causes  circumflex  never to match. This option affects only the behav-         causes circumflex never to match. This option affects only  the  behav-
2099         iour of the circumflex metacharacter. It does not affect \A.         iour of the circumflex metacharacter. It does not affect \A.
2100    
2101           PCRE_NOTEOL           PCRE_NOTEOL
2102    
2103         This option specifies that the end of the subject string is not the end         This option specifies that the end of the subject string is not the end
2104         of  a line, so the dollar metacharacter should not match it nor (except         of a line, so the dollar metacharacter should not match it nor  (except
2105         in multiline mode) a newline immediately before it. Setting this  with-         in  multiline mode) a newline immediately before it. Setting this with-
2106         out PCRE_MULTILINE (at compile time) causes dollar never to match. This         out PCRE_MULTILINE (at compile time) causes dollar never to match. This
2107         option affects only the behaviour of the dollar metacharacter. It  does         option  affects only the behaviour of the dollar metacharacter. It does
2108         not affect \Z or \z.         not affect \Z or \z.
2109    
2110           PCRE_NOTEMPTY           PCRE_NOTEMPTY
2111    
2112         An empty string is not considered to be a valid match if this option is         An empty string is not considered to be a valid match if this option is
2113         set. If there are alternatives in the pattern, they are tried.  If  all         set.  If  there are alternatives in the pattern, they are tried. If all
2114         the  alternatives  match  the empty string, the entire match fails. For         the alternatives match the empty string, the entire  match  fails.  For
2115         example, if the pattern         example, if the pattern
2116    
2117           a?b?           a?b?
2118    
2119         is applied to a string not beginning with "a" or "b",  it  matches  the         is  applied  to  a  string not beginning with "a" or "b", it matches an
2120         empty  string at the start of the subject. With PCRE_NOTEMPTY set, this         empty string at the start of the subject. With PCRE_NOTEMPTY set,  this
2121         match is not valid, so PCRE searches further into the string for occur-         match is not valid, so PCRE searches further into the string for occur-
2122         rences of "a" or "b".         rences of "a" or "b".
2123    
2124         Perl has no direct equivalent of PCRE_NOTEMPTY, but it does make a spe-           PCRE_NOTEMPTY_ATSTART
2125         cial case of a pattern match of the empty  string  within  its  split()  
2126         function,  and  when  using  the /g modifier. It is possible to emulate         This is like PCRE_NOTEMPTY, except that an empty string match  that  is
2127         Perl's behaviour after matching a null string by first trying the match         not  at  the  start  of  the  subject  is  permitted. If the pattern is
2128         again at the same offset with PCRE_NOTEMPTY and PCRE_ANCHORED, and then         anchored, such a match can occur only if the pattern contains \K.
2129         if that fails by advancing the starting offset (see below)  and  trying  
2130         an ordinary match again. There is some code that demonstrates how to do         Perl    has    no    direct    equivalent    of    PCRE_NOTEMPTY     or
2131         this in the pcredemo.c sample program.         PCRE_NOTEMPTY_ATSTART,  but  it  does  make a special case of a pattern
2132           match of the empty string within its split() function, and  when  using
2133           the  /g  modifier.  It  is  possible  to emulate Perl's behaviour after
2134           matching a null string by first trying the match again at the same off-
2135           set  with  PCRE_NOTEMPTY_ATSTART  and  PCRE_ANCHORED,  and then if that
2136           fails, by advancing the starting offset (see below) and trying an ordi-
2137           nary  match  again. There is some code that demonstrates how to do this
2138           in the pcredemo sample program. In the most general case, you  have  to
2139           check  to  see  if the newline convention recognizes CRLF as a newline,
2140           and if so, and the current character is CR followed by LF, advance  the
2141           starting offset by two characters instead of one.
2142    
2143             PCRE_NO_START_OPTIMIZE
2144    
2145           There  are a number of optimizations that pcre_exec() uses at the start
2146           of a match, in order to speed up the process. For  example,  if  it  is
2147           known that an unanchored match must start with a specific character, it
2148           searches the subject for that character, and fails  immediately  if  it
2149           cannot  find  it,  without actually running the main matching function.
2150           This means that a special item such as (*COMMIT) at the start of a pat-
2151           tern  is  not  considered until after a suitable starting point for the
2152           match has been found. When callouts or (*MARK) items are in use,  these
2153           "start-up" optimizations can cause them to be skipped if the pattern is
2154           never actually used. The start-up optimizations are in  effect  a  pre-
2155           scan of the subject that takes place before the pattern is run.
2156    
2157           The  PCRE_NO_START_OPTIMIZE option disables the start-up optimizations,
2158           possibly causing performance to suffer,  but  ensuring  that  in  cases
2159           where  the  result is "no match", the callouts do occur, and that items
2160           such as (*COMMIT) and (*MARK) are considered at every possible starting
2161           position  in  the  subject  string. If PCRE_NO_START_OPTIMIZE is set at
2162           compile time, it cannot be unset at matching time.
2163    
2164           Setting PCRE_NO_START_OPTIMIZE can change the  outcome  of  a  matching
2165           operation.  Consider the pattern
2166    
2167             (*COMMIT)ABC
2168    
2169           When  this  is  compiled, PCRE records the fact that a match must start
2170           with the character "A". Suppose the subject  string  is  "DEFABC".  The
2171           start-up  optimization  scans along the subject, finds "A" and runs the
2172           first match attempt from there. The (*COMMIT) item means that the  pat-
2173           tern  must  match the current starting position, which in this case, it
2174           does. However, if the same match  is  run  with  PCRE_NO_START_OPTIMIZE
2175           set,  the  initial  scan  along the subject string does not happen. The
2176           first match attempt is run starting  from  "D"  and  when  this  fails,
2177           (*COMMIT)  prevents  any  further  matches  being tried, so the overall
2178           result is "no match". If the pattern is studied,  more  start-up  opti-
2179           mizations  may  be  used. For example, a minimum length for the subject
2180           may be recorded. Consider the pattern
2181    
2182             (*MARK:A)(X|Y)
2183    
2184           The minimum length for a match is one  character.  If  the  subject  is
2185           "ABC",  there  will  be  attempts  to  match "ABC", "BC", "C", and then
2186           finally an empty string.  If the pattern is studied, the final  attempt
2187           does  not take place, because PCRE knows that the subject is too short,
2188           and so the (*MARK) is never encountered.  In this  case,  studying  the
2189           pattern  does  not  affect the overall match result, which is still "no
2190           match", but it does affect the auxiliary information that is returned.
2191    
2192           PCRE_NO_UTF8_CHECK           PCRE_NO_UTF8_CHECK
2193    
# Line 2019  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 2197  MATCHING A PATTERN: THE TRADITIONAL FUNC
2197         points  to  the start of a UTF-8 character. There is a discussion about         points  to  the start of a UTF-8 character. There is a discussion about
2198         the validity of UTF-8 strings in the section on UTF-8  support  in  the         the validity of UTF-8 strings in the section on UTF-8  support  in  the
2199         main  pcre  page.  If  an  invalid  UTF-8  sequence  of bytes is found,         main  pcre  page.  If  an  invalid  UTF-8  sequence  of bytes is found,
2200         pcre_exec() returns the error PCRE_ERROR_BADUTF8. If  startoffset  con-         pcre_exec() returns  the  error  PCRE_ERROR_BADUTF8  or,  if  PCRE_PAR-
2201         tains an invalid value, PCRE_ERROR_BADUTF8_OFFSET is returned.         TIAL_HARD  is set and the problem is a truncated UTF-8 character at the
2202           end of the subject, PCRE_ERROR_SHORTUTF8. In  both  cases,  information
2203           about  the  precise  nature  of the error may also be returned (see the
2204           descriptions of these errors in the section entitled Error return  val-
2205           ues from pcre_exec() below).  If startoffset contains a value that does
2206           not point to the start of a UTF-8 character (or to the end of the  sub-
2207           ject), PCRE_ERROR_BADUTF8_OFFSET is returned.
2208    
2209         If  you  already  know that your subject is valid, and you want to skip         If  you  already  know that your subject is valid, and you want to skip
2210         these   checks   for   performance   reasons,   you   can    set    the         these   checks   for   performance   reasons,   you   can    set    the
# Line 2028  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 2212  MATCHING A PATTERN: THE TRADITIONAL FUNC
2212         do this for the second and subsequent calls to pcre_exec() if  you  are         do this for the second and subsequent calls to pcre_exec() if  you  are
2213         making  repeated  calls  to  find  all  the matches in a single subject         making  repeated  calls  to  find  all  the matches in a single subject
2214         string. However, you should be  sure  that  the  value  of  startoffset         string. However, you should be  sure  that  the  value  of  startoffset
2215         points  to  the  start of a UTF-8 character. When PCRE_NO_UTF8_CHECK is         points  to  the start of a UTF-8 character (or the end of the subject).
2216         set, the effect of passing an invalid UTF-8 string as a subject,  or  a         When PCRE_NO_UTF8_CHECK is set, the effect of passing an invalid  UTF-8
2217         value  of startoffset that does not point to the start of a UTF-8 char-         string  as  a  subject or an invalid value of startoffset is undefined.
2218         acter, is undefined. Your program may crash.         Your program may crash.
2219    
2220           PCRE_PARTIAL           PCRE_PARTIAL_HARD
2221             PCRE_PARTIAL_SOFT
2222         This option turns on the  partial  matching  feature.  If  the  subject  
2223         string  fails to match the pattern, but at some point during the match-         These options turn on the partial matching feature. For backwards  com-
2224         ing process the end of the subject was reached (that  is,  the  subject         patibility,  PCRE_PARTIAL is a synonym for PCRE_PARTIAL_SOFT. A partial
2225         partially  matches  the  pattern and the failure to match occurred only         match occurs if the end of the subject string is reached  successfully,
2226         because there were not enough subject characters), pcre_exec()  returns         but  there  are not enough subject characters to complete the match. If
2227         PCRE_ERROR_PARTIAL  instead of PCRE_ERROR_NOMATCH. When PCRE_PARTIAL is         this happens when PCRE_PARTIAL_SOFT (but not PCRE_PARTIAL_HARD) is set,
2228         used, there are restrictions on what may appear in the  pattern.  These         matching  continues  by  testing any remaining alternatives. Only if no
2229         are discussed in the pcrepartial documentation.         complete match can be found is PCRE_ERROR_PARTIAL returned  instead  of
2230           PCRE_ERROR_NOMATCH.  In  other  words,  PCRE_PARTIAL_SOFT says that the
2231           caller is prepared to handle a partial match, but only if  no  complete
2232           match can be found.
2233    
2234           If  PCRE_PARTIAL_HARD  is  set, it overrides PCRE_PARTIAL_SOFT. In this
2235           case, if a partial match  is  found,  pcre_exec()  immediately  returns
2236           PCRE_ERROR_PARTIAL,  without  considering  any  other  alternatives. In
2237           other words, when PCRE_PARTIAL_HARD is set, a partial match is  consid-
2238           ered to be more important that an alternative complete match.
2239    
2240           In  both  cases,  the portion of the string that was inspected when the
2241           partial match was found is set as the first matching string. There is a
2242           more  detailed  discussion  of partial and multi-segment matching, with
2243           examples, in the pcrepartial documentation.
2244    
2245     The string to be matched by pcre_exec()     The string to be matched by pcre_exec()
2246    
2247         The  subject string is passed to pcre_exec() as a pointer in subject, a         The subject string is passed to pcre_exec() as a pointer in subject,  a
2248         length in length, and a starting byte offset in startoffset.  In  UTF-8         length (in bytes) in length, and a starting byte offset in startoffset.
2249         mode,  the  byte  offset  must point to the start of a UTF-8 character.         If this is  negative  or  greater  than  the  length  of  the  subject,
2250         Unlike the pattern string, the subject may contain binary  zero  bytes.         pcre_exec()  returns  PCRE_ERROR_BADOFFSET. When the starting offset is
2251         When  the starting offset is zero, the search for a match starts at the         zero, the search for a match starts at the beginning  of  the  subject,
2252         beginning of the subject, and this is by far the most common case.         and this is by far the most common case. In UTF-8 mode, the byte offset
2253           must point to the start of a UTF-8 character (or the end  of  the  sub-
2254           ject).  Unlike  the pattern string, the subject may contain binary zero
2255           bytes.
2256    
2257         A non-zero starting offset is useful when searching for  another  match         A non-zero starting offset is useful when searching for  another  match
2258         in  the same subject by calling pcre_exec() again after a previous suc-         in  the same subject by calling pcre_exec() again after a previous suc-
# Line 2072  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 2273  MATCHING A PATTERN: THE TRADITIONAL FUNC
2273         rence of "iss" because it is able to look behind the starting point  to         rence of "iss" because it is able to look behind the starting point  to
2274         discover that it is preceded by a letter.         discover that it is preceded by a letter.
2275    
2276         If  a  non-zero starting offset is passed when the pattern is anchored,         Finding  all  the  matches  in a subject is tricky when the pattern can
2277           match an empty string. It is possible to emulate Perl's /g behaviour by
2278           first   trying   the   match   again  at  the  same  offset,  with  the
2279           PCRE_NOTEMPTY_ATSTART and  PCRE_ANCHORED  options,  and  then  if  that
2280           fails,  advancing  the  starting  offset  and  trying an ordinary match
2281           again. There is some code that demonstrates how to do this in the pcre-
2282           demo sample program. In the most general case, you have to check to see
2283           if the newline convention recognizes CRLF as a newline, and if so,  and
2284           the current character is CR followed by LF, advance the starting offset
2285           by two characters instead of one.
2286    
2287           If a non-zero starting offset is passed when the pattern  is  anchored,
2288         one attempt to match at the given offset is made. This can only succeed         one attempt to match at the given offset is made. This can only succeed
2289         if  the  pattern  does  not require the match to be at the start of the         if the pattern does not require the match to be at  the  start  of  the
2290         subject.         subject.
2291    
2292     How pcre_exec() returns captured substrings     How pcre_exec() returns captured substrings
2293    
2294         In general, a pattern matches a certain portion of the subject, and  in         In  general, a pattern matches a certain portion of the subject, and in
2295         addition,  further  substrings  from  the  subject may be picked out by         addition, further substrings from the subject  may  be  picked  out  by
2296         parts of the pattern. Following the usage  in  Jeffrey  Friedl's  book,         parts  of  the  pattern.  Following the usage in Jeffrey Friedl's book,
2297         this  is  called "capturing" in what follows, and the phrase "capturing         this is called "capturing" in what follows, and the  phrase  "capturing
2298         subpattern" is used for a fragment of a pattern that picks out  a  sub-         subpattern"  is  used for a fragment of a pattern that picks out a sub-
2299         string.  PCRE  supports several other kinds of parenthesized subpattern         string. PCRE supports several other kinds of  parenthesized  subpattern
2300         that do not cause substrings to be captured.         that do not cause substrings to be captured.
2301    
2302         Captured substrings are returned to the caller via a vector of  integer         Captured substrings are returned to the caller via a vector of integers
2303         offsets  whose  address is passed in ovector. The number of elements in         whose address is passed in ovector. The number of elements in the  vec-
2304         the vector is passed in ovecsize, which must be a non-negative  number.         tor  is  passed in ovecsize, which must be a non-negative number. Note:
2305         Note: this argument is NOT the size of ovector in bytes.         this argument is NOT the size of ovector in bytes.
2306    
2307         The  first  two-thirds of the vector is used to pass back captured sub-         The first two-thirds of the vector is used to pass back  captured  sub-
2308         strings, each substring using a pair of integers. The  remaining  third         strings,  each  substring using a pair of integers. The remaining third
2309         of  the  vector is used as workspace by pcre_exec() while matching cap-         of the vector is used as workspace by pcre_exec() while  matching  cap-
2310         turing subpatterns, and is not available for passing back  information.         turing  subpatterns, and is not available for passing back information.
2311         The  length passed in ovecsize should always be a multiple of three. If         The number passed in ovecsize should always be a multiple of three.  If
2312         it is not, it is rounded down.         it is not, it is rounded down.
2313    
2314         When a match is successful, information about  captured  substrings  is         When  a  match  is successful, information about captured substrings is
2315         returned  in  pairs  of integers, starting at the beginning of ovector,         returned in pairs of integers, starting at the  beginning  of  ovector,
2316         and continuing up to two-thirds of its length at the  most.  The  first         and  continuing  up  to two-thirds of its length at the most. The first
2317         element of a pair is set to the offset of the first character in a sub-         element of each pair is set to the byte offset of the  first  character
2318         string, and the second is set to the  offset  of  the  first  character         in  a  substring, and the second is set to the byte offset of the first
2319         after  the  end  of  a  substring. The first pair, ovector[0] and ovec-         character after the end of a substring. Note: these values  are  always
2320         tor[1], identify the portion of  the  subject  string  matched  by  the         byte offsets, even in UTF-8 mode. They are not character counts.
2321         entire  pattern.  The next pair is used for the first capturing subpat-  
2322         tern, and so on. The value returned by pcre_exec() is one more than the         The  first  pair  of  integers, ovector[0] and ovector[1], identify the
2323         highest numbered pair that has been set. For example, if two substrings         portion of the subject string matched by the entire pattern.  The  next
2324         have been captured, the returned value is 3. If there are no  capturing         pair  is  used for the first capturing subpattern, and so on. The value
2325         subpatterns,  the return value from a successful match is 1, indicating         returned by pcre_exec() is one more than the highest numbered pair that
2326         that just the first pair of offsets has been set.         has  been  set.  For example, if two substrings have been captured, the
2327           returned value is 3. If there are no capturing subpatterns, the  return
2328           value from a successful match is 1, indicating that just the first pair
2329           of offsets has been set.
2330    
2331         If a capturing subpattern is matched repeatedly, it is the last portion         If a capturing subpattern is matched repeatedly, it is the last portion
2332         of the string that it matched that is returned.         of the string that it matched that is returned.
2333    
2334         If  the vector is too small to hold all the captured substring offsets,         If  the vector is too small to hold all the captured substring offsets,
2335         it is used as far as possible (up to two-thirds of its length), and the         it is used as far as possible (up to two-thirds of its length), and the
2336         function  returns a value of zero. In particular, if the substring off-         function  returns a value of zero. If neither the actual string matched
2337         sets are not of interest, pcre_exec() may be called with ovector passed         not any captured substrings are of interest, pcre_exec() may be  called
2338         as  NULL  and  ovecsize  as zero. However, if the pattern contains back         with  ovector passed as NULL and ovecsize as zero. However, if the pat-
2339         references and the ovector is not big enough to  remember  the  related         tern contains back references and the ovector  is  not  big  enough  to
2340         substrings,  PCRE has to get additional memory for use during matching.         remember  the related substrings, PCRE has to get additional memory for
2341         Thus it is usually advisable to supply an ovector.         use during matching. Thus it is usually advisable to supply an  ovector
2342           of reasonable size.
2343    
2344           There  are  some  cases where zero is returned (indicating vector over-
2345           flow) when in fact the vector is exactly the right size for  the  final
2346           match. For example, consider the pattern
2347    
2348             (a)(?:(b)c|bd)
2349    
2350           If  a  vector of 6 elements (allowing for only 1 captured substring) is
2351           given with subject string "abd", pcre_exec() will try to set the second
2352           captured string, thereby recording a vector overflow, before failing to
2353           match "c" and backing up  to  try  the  second  alternative.  The  zero
2354           return,  however,  does  correctly  indicate that the maximum number of
2355           slots (namely 2) have been filled. In similar cases where there is tem-
2356           porary  overflow,  but  the final number of used slots is actually less
2357           than the maximum, a non-zero value is returned.
2358    
2359         The pcre_info() function can be used to find  out  how  many  capturing         The pcre_fullinfo() function can be used to find out how many capturing
2360         subpatterns  there  are  in  a  compiled pattern. The smallest size for         subpatterns  there  are  in  a  compiled pattern. The smallest size for
2361         ovector that will allow for n captured substrings, in addition  to  the         ovector that will allow for n captured substrings, in addition  to  the
2362         offsets of the substring matched by the whole pattern, is (n+1)*3.         offsets of the substring matched by the whole pattern, is (n+1)*3.
# Line 2141  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 2372  MATCHING A PATTERN: THE TRADITIONAL FUNC
2372         expression  are  also  set  to  -1. For example, if the string "abc" is         expression  are  also  set  to  -1. For example, if the string "abc" is
2373         matched against the pattern (abc)(x(yz)?)? subpatterns 2 and 3 are  not         matched against the pattern (abc)(x(yz)?)? subpatterns 2 and 3 are  not
2374         matched.  The  return  from the function is 2, because the highest used         matched.  The  return  from the function is 2, because the highest used
2375         capturing subpattern number is 1. However, you can refer to the offsets         capturing subpattern number is 1, and the offsets for  for  the  second
2376         for  the  second  and third capturing subpatterns if you wish (assuming         and  third  capturing subpatterns (assuming the vector is large enough,
2377         the vector is large enough, of course).         of course) are set to -1.
2378    
2379           Note: Elements in the first two-thirds of ovector that  do  not  corre-
2380           spond  to  capturing parentheses in the pattern are never changed. That
2381           is, if a pattern contains n capturing parentheses, no more  than  ovec-
2382           tor[0]  to ovector[2n+1] are set by pcre_exec(). The other elements (in
2383           the first two-thirds) retain whatever values they previously had.
2384    
2385         Some convenience functions are provided  for  extracting  the  captured         Some convenience functions are provided  for  extracting  the  captured
2386         substrings as separate strings. These are described below.         substrings as separate strings. These are described below.
# Line 2188  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 2425  MATCHING A PATTERN: THE TRADITIONAL FUNC
2425         purpose. If the call via pcre_malloc() fails, this error is given.  The         purpose. If the call via pcre_malloc() fails, this error is given.  The
2426         memory is automatically freed at the end of matching.         memory is automatically freed at the end of matching.
2427    
2428           This  error  is also given if pcre_stack_malloc() fails in pcre_exec().
2429           This can happen only when PCRE has been compiled with  --disable-stack-
2430           for-recursion.
2431    
2432           PCRE_ERROR_NOSUBSTRING    (-7)           PCRE_ERROR_NOSUBSTRING    (-7)
2433    
2434         This  error is used by the pcre_copy_substring(), pcre_get_substring(),         This  error is used by the pcre_copy_substring(), pcre_get_substring(),
# Line 2209  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 2450  MATCHING A PATTERN: THE TRADITIONAL FUNC
2450           PCRE_ERROR_BADUTF8        (-10)           PCRE_ERROR_BADUTF8        (-10)
2451    
2452         A  string  that contains an invalid UTF-8 byte sequence was passed as a         A  string  that contains an invalid UTF-8 byte sequence was passed as a
2453         subject.         subject, and the PCRE_NO_UTF8_CHECK option was not set. If the size  of
2454           the  output  vector  (ovecsize)  is  at least 2, the byte offset to the
2455           start of the the invalid UTF-8 character is placed in  the  first  ele-
2456           ment,  and  a  reason  code is placed in the second element. The reason
2457           codes are listed in the following section.  For backward compatibility,
2458           if  PCRE_PARTIAL_HARD is set and the problem is a truncated UTF-8 char-
2459           acter  at  the  end  of  the   subject   (reason   codes   1   to   5),
2460           PCRE_ERROR_SHORTUTF8 is returned instead of PCRE_ERROR_BADUTF8.
2461    
2462           PCRE_ERROR_BADUTF8_OFFSET (-11)           PCRE_ERROR_BADUTF8_OFFSET (-11)
2463    
2464         The UTF-8 byte sequence that was passed as a subject was valid, but the         The  UTF-8  byte  sequence that was passed as a subject was checked and
2465           found to be valid (the PCRE_NO_UTF8_CHECK option was not set), but  the
2466         value  of startoffset did not point to the beginning of a UTF-8 charac-         value  of startoffset did not point to the beginning of a UTF-8 charac-
2467         ter.         ter or the end of the subject.
2468    
2469           PCRE_ERROR_PARTIAL        (-12)           PCRE_ERROR_PARTIAL        (-12)
2470    
# Line 2224  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 2473  MATCHING A PATTERN: THE TRADITIONAL FUNC
2473    
2474           PCRE_ERROR_BADPARTIAL     (-13)           PCRE_ERROR_BADPARTIAL     (-13)
2475    
2476         The  PCRE_PARTIAL  option  was  used with a compiled pattern containing         This  code  is  no  longer  in  use.  It was formerly returned when the
2477         items that are not supported for partial matching. See the  pcrepartial         PCRE_PARTIAL option was used with a compiled pattern  containing  items
2478         documentation for details of partial matching.         that  were  not  supported  for  partial  matching.  From  release 8.00
2479           onwards, there are no restrictions on partial matching.
2480    
2481           PCRE_ERROR_INTERNAL       (-14)           PCRE_ERROR_INTERNAL       (-14)
2482    
2483         An  unexpected  internal error has occurred. This error could be caused         An unexpected internal error has occurred. This error could  be  caused
2484         by a bug in PCRE or by overwriting of the compiled pattern.         by a bug in PCRE or by overwriting of the compiled pattern.
2485    
2486           PCRE_ERROR_BADCOUNT       (-15)           PCRE_ERROR_BADCOUNT       (-15)
2487    
2488         This error is given if the value of the ovecsize argument is  negative.         This error is given if the value of the ovecsize argument is negative.
2489    
2490           PCRE_ERROR_RECURSIONLIMIT (-21)           PCRE_ERROR_RECURSIONLIMIT (-21)
2491    
# Line 2247  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 2497  MATCHING A PATTERN: THE TRADITIONAL FUNC
2497    
2498         An invalid combination of PCRE_NEWLINE_xxx options was given.         An invalid combination of PCRE_NEWLINE_xxx options was given.
2499    
2500             PCRE_ERROR_BADOFFSET      (-24)
2501    
2502           The value of startoffset was negative or greater than the length of the
2503           subject, that is, the value in length.
2504    
2505             PCRE_ERROR_SHORTUTF8      (-25)
2506    
2507           This error is returned instead of PCRE_ERROR_BADUTF8 when  the  subject
2508           string  ends with a truncated UTF-8 character and the PCRE_PARTIAL_HARD
2509           option is set.  Information  about  the  failure  is  returned  as  for
2510           PCRE_ERROR_BADUTF8.  It  is in fact sufficient to detect this case, but
2511           this special error code for PCRE_PARTIAL_HARD precedes the  implementa-
2512           tion  of returned information; it is retained for backwards compatibil-
2513           ity.
2514    
2515             PCRE_ERROR_RECURSELOOP    (-26)
2516    
2517           This error is returned when pcre_exec() detects a recursion loop within
2518           the  pattern. Specifically, it means that either the whole pattern or a
2519           subpattern has been called recursively for the second time at the  same
2520           position in the subject string. Some simple patterns that might do this
2521           are detected and faulted at compile time, but more  complicated  cases,
2522           in particular mutual recursions between two different subpatterns, can-
2523           not be detected until run time.
2524    
2525             PCRE_ERROR_JIT_STACKLIMIT (-27)
2526    
2527           This error is returned when a pattern  that  was  successfully  studied
2528           using  the PCRE_STUDY_JIT_COMPILE option is being matched, but the mem-
2529           ory available for  the  just-in-time  processing  stack  is  not  large
2530           enough. See the pcrejit documentation for more details.
2531    
2532         Error numbers -16 to -20 and -22 are not used by pcre_exec().         Error numbers -16 to -20 and -22 are not used by pcre_exec().
2533    
2534       Reason codes for invalid UTF-8 strings
2535    
2536           When pcre_exec() returns either PCRE_ERROR_BADUTF8 or PCRE_ERROR_SHORT-
2537           UTF8, and the size of the output vector (ovecsize) is at least  2,  the
2538           offset  of  the  start  of the invalid UTF-8 character is placed in the
2539           first output vector element (ovector[0]) and a reason code is placed in
2540           the  second  element  (ovector[1]). The reason codes are given names in
2541           the pcre.h header file:
2542    
2543             PCRE_UTF8_ERR1
2544             PCRE_UTF8_ERR2
2545             PCRE_UTF8_ERR3
2546             PCRE_UTF8_ERR4
2547             PCRE_UTF8_ERR5
2548    
2549           The string ends with a truncated UTF-8 character;  the  code  specifies
2550           how  many bytes are missing (1 to 5). Although RFC 3629 restricts UTF-8
2551           characters to be no longer than 4 bytes, the  encoding  scheme  (origi-
2552           nally  defined  by  RFC  2279)  allows  for  up to 6 bytes, and this is
2553           checked first; hence the possibility of 4 or 5 missing bytes.
2554    
2555             PCRE_UTF8_ERR6
2556             PCRE_UTF8_ERR7
2557             PCRE_UTF8_ERR8
2558             PCRE_UTF8_ERR9
2559             PCRE_UTF8_ERR10
2560    
2561           The two most significant bits of the 2nd, 3rd, 4th, 5th, or 6th byte of
2562           the  character  do  not have the binary value 0b10 (that is, either the
2563           most significant bit is 0, or the next bit is 1).
2564    
2565             PCRE_UTF8_ERR11
2566             PCRE_UTF8_ERR12
2567    
2568           A character that is valid by the RFC 2279 rules is either 5 or 6  bytes
2569           long; these code points are excluded by RFC 3629.
2570    
2571             PCRE_UTF8_ERR13
2572    
2573           A  4-byte character has a value greater than 0x10fff; these code points
2574           are excluded by RFC 3629.
2575    
2576             PCRE_UTF8_ERR14
2577    
2578           A 3-byte character has a value in the  range  0xd800  to  0xdfff;  this
2579           range  of code points are reserved by RFC 3629 for use with UTF-16, and
2580           so are excluded from UTF-8.
2581    
2582             PCRE_UTF8_ERR15
2583             PCRE_UTF8_ERR16
2584             PCRE_UTF8_ERR17
2585             PCRE_UTF8_ERR18
2586             PCRE_UTF8_ERR19
2587    
2588           A 2-, 3-, 4-, 5-, or 6-byte character is "overlong", that is, it  codes
2589           for  a  value that can be represented by fewer bytes, which is invalid.
2590           For example, the two bytes 0xc0, 0xae give the value 0x2e,  whose  cor-
2591           rect coding uses just one byte.
2592    
2593             PCRE_UTF8_ERR20
2594    
2595           The two most significant bits of the first byte of a character have the
2596           binary value 0b10 (that is, the most significant bit is 1 and the  sec-
2597           ond  is  0). Such a byte can only validly occur as the second or subse-
2598           quent byte of a multi-byte character.
2599    
2600             PCRE_UTF8_ERR21
2601    
2602           The first byte of a character has the value 0xfe or 0xff. These  values
2603           can never occur in a valid UTF-8 string.
2604    
2605    
2606  EXTRACTING CAPTURED SUBSTRINGS BY NUMBER  EXTRACTING CAPTURED SUBSTRINGS BY NUMBER
2607    
# Line 2385  EXTRACTING CAPTURED SUBSTRINGS BY NAME Line 2738  EXTRACTING CAPTURED SUBSTRINGS BY NAME
2738         ate. NOTE: If PCRE_DUPNAMES is set and there are duplicate  names,  the         ate. NOTE: If PCRE_DUPNAMES is set and there are duplicate  names,  the
2739         behaviour may not be what you want (see the next section).         behaviour may not be what you want (see the next section).
2740    
2741           Warning: If the pattern uses the (?| feature to set up multiple subpat-
2742           terns with the same number, as described in the  section  on  duplicate
2743           subpattern  numbers  in  the  pcrepattern page, you cannot use names to
2744           distinguish the different subpatterns, because names are  not  included
2745           in  the compiled code. The matching process uses only numbers. For this
2746           reason, the use of different names for subpatterns of the  same  number
2747           causes an error at compile time.
2748    
2749    
2750  DUPLICATE SUBPATTERN NAMES  DUPLICATE SUBPATTERN NAMES
2751    
# Line 2392  DUPLICATE SUBPATTERN NAMES Line 2753  DUPLICATE SUBPATTERN NAMES
2753              const char *name, char **first, char **last);              const char *name, char **first, char **last);
2754    
2755         When  a  pattern  is  compiled with the PCRE_DUPNAMES option, names for         When  a  pattern  is  compiled with the PCRE_DUPNAMES option, names for
2756         subpatterns are not required to  be  unique.  Normally,  patterns  with         subpatterns are not required to be unique. (Duplicate names are  always
2757         duplicate  names  are such that in any one match, only one of the named         allowed  for subpatterns with the same number, created by using the (?|
2758         subpatterns participates. An example is shown in the pcrepattern  docu-         feature. Indeed, if such subpatterns are named, they  are  required  to
2759         mentation.         use the same names.)
2760    
2761           Normally, patterns with duplicate names are such that in any one match,
2762           only one of the named subpatterns participates. An example is shown  in
2763           the pcrepattern documentation.
2764    
2765         When    duplicates   are   present,   pcre_copy_named_substring()   and         When    duplicates   are   present,   pcre_copy_named_substring()   and
2766         pcre_get_named_substring() return the first substring corresponding  to         pcre_get_named_substring() return the first substring corresponding  to
# Line 2412  DUPLICATE SUBPATTERN NAMES Line 2777  DUPLICATE SUBPATTERN NAMES
2777         the  name-to-number  table  for  the  given  name.  The function itself         the  name-to-number  table  for  the  given  name.  The function itself
2778         returns the length of each entry,  or  PCRE_ERROR_NOSUBSTRING  (-7)  if         returns the length of each entry,  or  PCRE_ERROR_NOSUBSTRING  (-7)  if
2779         there  are none. The format of the table is described above in the sec-         there  are none. The format of the table is described above in the sec-
2780         tion entitled Information about a  pattern.   Given  all  the  relevant         tion entitled Information about a pattern above.  Given all  the  rele-
2781         entries  for the name, you can extract each of their numbers, and hence         vant  entries  for the name, you can extract each of their numbers, and
2782         the captured data, if any.         hence the captured data, if any.
2783    
2784    
2785  FINDING ALL POSSIBLE MATCHES  FINDING ALL POSSIBLE MATCHES
# Line 2448  MATCHING A PATTERN: THE ALTERNATIVE FUNC Line 2813  MATCHING A PATTERN: THE ALTERNATIVE FUNC
2813         characteristics to the normal algorithm, and  is  not  compatible  with         characteristics to the normal algorithm, and  is  not  compatible  with
2814         Perl.  Some  of the features of PCRE patterns are not supported. Never-         Perl.  Some  of the features of PCRE patterns are not supported. Never-
2815         theless, there are times when this kind of matching can be useful.  For         theless, there are times when this kind of matching can be useful.  For
2816         a discussion of the two matching algorithms, see the pcrematching docu-         a  discussion  of  the  two matching algorithms, and a list of features
2817         mentation.         that pcre_dfa_exec() does not support, see the pcrematching  documenta-
2818           tion.
2819    
2820         The arguments for the pcre_dfa_exec() function  are  the  same  as  for         The  arguments  for  the  pcre_dfa_exec()  function are the same as for
2821         pcre_exec(), plus two extras. The ovector argument is used in a differ-         pcre_exec(), plus two extras. The ovector argument is used in a differ-
2822         ent way, and this is described below. The other  common  arguments  are         ent  way,  and  this is described below. The other common arguments are
2823         used  in  the  same way as for pcre_exec(), so their description is not         used in the same way as for pcre_exec(), so their  description  is  not
2824         repeated here.         repeated here.
2825    
2826         The two additional arguments provide workspace for  the  function.  The         The  two  additional  arguments provide workspace for the function. The
2827         workspace  vector  should  contain at least 20 elements. It is used for         workspace vector should contain at least 20 elements. It  is  used  for
2828         keeping  track  of  multiple  paths  through  the  pattern  tree.  More         keeping  track  of  multiple  paths  through  the  pattern  tree.  More
2829         workspace  will  be  needed for patterns and subjects where there are a         workspace will be needed for patterns and subjects where  there  are  a
2830         lot of potential matches.         lot of potential matches.
2831    
2832         Here is an example of a simple call to pcre_dfa_exec():         Here is an example of a simple call to pcre_dfa_exec():
# Line 2482  MATCHING A PATTERN: THE ALTERNATIVE FUNC Line 2848  MATCHING A PATTERN: THE ALTERNATIVE FUNC
2848    
2849     Option bits for pcre_dfa_exec()     Option bits for pcre_dfa_exec()
2850    
2851         The unused bits of the options argument  for  pcre_dfa_exec()  must  be         The  unused  bits  of  the options argument for pcre_dfa_exec() must be
2852         zero.  The  only  bits  that  may  be  set are PCRE_ANCHORED, PCRE_NEW-         zero. The only bits  that  may  be  set  are  PCRE_ANCHORED,  PCRE_NEW-
2853         LINE_xxx, PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY,  PCRE_NO_UTF8_CHECK,         LINE_xxx,        PCRE_NOTBOL,        PCRE_NOTEOL,        PCRE_NOTEMPTY,
2854         PCRE_PARTIAL, PCRE_DFA_SHORTEST, and PCRE_DFA_RESTART. All but the last         PCRE_NOTEMPTY_ATSTART,      PCRE_NO_UTF8_CHECK,       PCRE_BSR_ANYCRLF,
2855         three of these are the same as for pcre_exec(), so their description is         PCRE_BSR_UNICODE,  PCRE_NO_START_OPTIMIZE, PCRE_PARTIAL_HARD, PCRE_PAR-
2856         not repeated here.         TIAL_SOFT, PCRE_DFA_SHORTEST, and PCRE_DFA_RESTART.  All but  the  last
2857           four  of  these  are  exactly  the  same  as  for pcre_exec(), so their
2858           PCRE_PARTIAL         description is not repeated here.
2859    
2860         This  has  the  same general effect as it does for pcre_exec(), but the           PCRE_PARTIAL_HARD
2861         details  are  slightly  different.  When  PCRE_PARTIAL   is   set   for           PCRE_PARTIAL_SOFT
2862         pcre_dfa_exec(),  the  return code PCRE_ERROR_NOMATCH is converted into  
2863         PCRE_ERROR_PARTIAL if the end of the subject  is  reached,  there  have         These have the same general effect as they do for pcre_exec(), but  the
2864         been no complete matches, but there is still at least one matching pos-         details  are  slightly  different.  When  PCRE_PARTIAL_HARD  is set for
2865         sibility. The portion of the string that provided the partial match  is         pcre_dfa_exec(), it returns PCRE_ERROR_PARTIAL if the end of  the  sub-
2866         set as the first matching string.         ject  is  reached  and there is still at least one matching possibility
2867           that requires additional characters. This happens even if some complete
2868           matches have also been found. When PCRE_PARTIAL_SOFT is set, the return
2869           code PCRE_ERROR_NOMATCH is converted into PCRE_ERROR_PARTIAL if the end
2870           of  the  subject  is  reached, there have been no complete matches, but
2871           there is still at least one matching possibility. The  portion  of  the
2872           string  that  was inspected when the longest partial match was found is
2873           set as the first matching string  in  both  cases.   There  is  a  more
2874           detailed  discussion  of partial and multi-segment matching, with exam-
2875           ples, in the pcrepartial documentation.
2876    
2877           PCRE_DFA_SHORTEST           PCRE_DFA_SHORTEST
2878    
2879         Setting  the  PCRE_DFA_SHORTEST option causes the matching algorithm to         Setting the PCRE_DFA_SHORTEST option causes the matching  algorithm  to
2880         stop as soon as it has found one match. Because of the way the alterna-         stop as soon as it has found one match. Because of the way the alterna-
2881         tive  algorithm  works, this is necessarily the shortest possible match         tive algorithm works, this is necessarily the shortest  possible  match
2882         at the first possible matching point in the subject string.         at the first possible matching point in the subject string.
2883    
2884           PCRE_DFA_RESTART           PCRE_DFA_RESTART
2885    
2886         When pcre_dfa_exec()  is  called  with  the  PCRE_PARTIAL  option,  and         When pcre_dfa_exec() returns a partial match, it is possible to call it
2887         returns  a  partial  match, it is possible to call it again, with addi-         again, with additional subject characters, and have  it  continue  with
2888         tional subject characters, and have it continue with  the  same  match.         the  same match. The PCRE_DFA_RESTART option requests this action; when
2889         The  PCRE_DFA_RESTART  option requests this action; when it is set, the         it is set, the workspace and wscount options must  reference  the  same
2890         workspace and wscount options must reference the same vector as  before         vector  as  before  because data about the match so far is left in them
2891         because  data  about  the  match so far is left in them after a partial         after a partial match. There is more discussion of this facility in the
2892         match. There is more discussion of this  facility  in  the  pcrepartial         pcrepartial documentation.
        documentation.  
2893    
2894     Successful returns from pcre_dfa_exec()     Successful returns from pcre_dfa_exec()
2895    
# Line 2549  MATCHING A PATTERN: THE ALTERNATIVE FUNC Line 2923  MATCHING A PATTERN: THE ALTERNATIVE FUNC
2923         The strings are returned in reverse order of length; that is, the long-         The strings are returned in reverse order of length; that is, the long-
2924         est  matching  string is given first. If there were too many matches to         est  matching  string is given first. If there were too many matches to
2925         fit into ovector, the yield of the function is zero, and the vector  is         fit into ovector, the yield of the function is zero, and the vector  is
2926         filled with the longest matches.         filled  with  the  longest matches. Unlike pcre_exec(), pcre_dfa_exec()
2927           can use the entire ovector for returning matched strings.
2928    
2929     Error returns from pcre_dfa_exec()     Error returns from pcre_dfa_exec()
2930    
2931         The  pcre_dfa_exec()  function returns a negative number when it fails.         The pcre_dfa_exec() function returns a negative number when  it  fails.
2932         Many of the errors are the same  as  for  pcre_exec(),  and  these  are         Many  of  the  errors  are  the  same as for pcre_exec(), and these are
2933         described  above.   There are in addition the following errors that are         described above.  There are in addition the following errors  that  are
2934         specific to pcre_dfa_exec():         specific to pcre_dfa_exec():
2935    
2936           PCRE_ERROR_DFA_UITEM      (-16)           PCRE_ERROR_DFA_UITEM      (-16)
2937    
2938         This return is given if pcre_dfa_exec() encounters an item in the  pat-         This  return is given if pcre_dfa_exec() encounters an item in the pat-
2939         tern  that  it  does not support, for instance, the use of \C or a back         tern that it does not support, for instance, the use of \C  or  a  back
2940         reference.         reference.
2941    
2942           PCRE_ERROR_DFA_UCOND      (-17)           PCRE_ERROR_DFA_UCOND      (-17)
2943    
2944         This return is given if pcre_dfa_exec()  encounters  a  condition  item         This  return  is  given  if pcre_dfa_exec() encounters a condition item
2945         that  uses  a back reference for the condition, or a test for recursion         that uses a back reference for the condition, or a test  for  recursion
2946         in a specific group. These are not supported.         in a specific group. These are not supported.
2947    
2948           PCRE_ERROR_DFA_UMLIMIT    (-18)           PCRE_ERROR_DFA_UMLIMIT    (-18)
2949    
2950         This return is given if pcre_dfa_exec() is called with an  extra  block         This  return  is given if pcre_dfa_exec() is called with an extra block
2951         that contains a setting of the match_limit field. This is not supported         that contains a setting of  the  match_limit  or  match_limit_recursion
2952         (it is meaningless).         fields.  This  is  not  supported (these fields are meaningless for DFA
2953           matching).
2954    
2955           PCRE_ERROR_DFA_WSSIZE     (-19)           PCRE_ERROR_DFA_WSSIZE     (-19)
2956    
# Line 2592  MATCHING A PATTERN: THE ALTERNATIVE FUNC Line 2968  MATCHING A PATTERN: THE ALTERNATIVE FUNC
2968  SEE ALSO  SEE ALSO
2969    
2970         pcrebuild(3), pcrecallout(3), pcrecpp(3)(3), pcrematching(3),  pcrepar-         pcrebuild(3), pcrecallout(3), pcrecpp(3)(3), pcrematching(3),  pcrepar-
2971         tial(3),  pcreposix(3), pcreprecompile(3), pcresample(3), pcrestack(3).         tial(3), pcreposix(3), pcreprecompile(3), pcresample(3), pcrestack(3).
2972    
2973    
2974  AUTHOR  AUTHOR
# Line 2604  AUTHOR Line 2980  AUTHOR
2980    
2981  REVISION  REVISION
2982    
2983         Last updated: 12 April 2008         Last updated: 23 September 2011
2984         Copyright (c) 1997-2008 University of Cambridge.         Copyright (c) 1997-2011 University of Cambridge.
2985  ------------------------------------------------------------------------------  ------------------------------------------------------------------------------
2986    
2987    
# Line 2634  PCRE CALLOUTS Line 3010  PCRE CALLOUTS
3010    
3011           (?C1)abc(?C2)def           (?C1)abc(?C2)def
3012    
3013         If  the  PCRE_AUTO_CALLOUT  option  bit  is  set when pcre_compile() is         If  the  PCRE_AUTO_CALLOUT  option  bit  is  set when pcre_compile() or
3014         called, PCRE automatically  inserts  callouts,  all  with  number  255,         pcre_compile2() is called, PCRE  automatically  inserts  callouts,  all
3015         before  each  item in the pattern. For example, if PCRE_AUTO_CALLOUT is         with  number  255,  before  each  item  in the pattern. For example, if
3016         used with the pattern         PCRE_AUTO_CALLOUT is used with the pattern
3017    
3018           A(\d{2}|--)           A(\d{2}|--)
3019    
# Line 2652  PCRE CALLOUTS Line 3028  PCRE CALLOUTS
3028         pattern is matched. This is useful information when you are  trying  to         pattern is matched. This is useful information when you are  trying  to
3029         optimize the performance of a particular pattern.         optimize the performance of a particular pattern.
3030    
3031           The  use  of callouts in a pattern makes it ineligible for optimization
3032           by  the  just-in-time  compiler.  Studying  such  a  pattern  with  the
3033           PCRE_STUDY_JIT_COMPILE option always fails.
3034    
3035    
3036  MISSING CALLOUTS  MISSING CALLOUTS
3037    
3038         You  should  be  aware  that,  because of optimizations in the way PCRE         You  should  be  aware  that,  because of optimizations in the way PCRE
3039         matches patterns, callouts sometimes do not happen. For example, if the         matches patterns by default, callouts  sometimes  do  not  happen.  For
3040         pattern is         example, if the pattern is
3041    
3042           ab(?C4)cd           ab(?C4)cd
3043    
# Line 2666  MISSING CALLOUTS Line 3046  MISSING CALLOUTS
3046         ever  start,  and  the  callout is never reached. However, with "abyd",         ever  start,  and  the  callout is never reached. However, with "abyd",
3047         though the result is still no match, the callout is obeyed.         though the result is still no match, the callout is obeyed.
3048    
3049           If the pattern is studied, PCRE knows the minimum length of a  matching
3050           string,  and will immediately give a "no match" return without actually
3051           running a match if the subject is not long enough, or,  for  unanchored
3052           patterns, if it has been scanned far enough.
3053    
3054           You  can disable these optimizations by passing the PCRE_NO_START_OPTI-
3055           MIZE option to pcre_compile(), pcre_exec(), or pcre_dfa_exec(),  or  by
3056           starting the pattern with (*NO_START_OPT). This slows down the matching
3057           process, but does ensure that callouts such as the  example  above  are
3058           obeyed.
3059    
3060    
3061  THE CALLOUT INTERFACE  THE CALLOUT INTERFACE
3062    
3063         During matching, when PCRE reaches a callout point, the external  func-         During  matching, when PCRE reaches a callout point, the external func-
3064         tion  defined by pcre_callout is called (if it is set). This applies to         tion defined by pcre_callout is called (if it is set). This applies  to
3065         both the pcre_exec() and the pcre_dfa_exec()  matching  functions.  The         both  the  pcre_exec()  and the pcre_dfa_exec() matching functions. The
3066         only  argument  to  the callout function is a pointer to a pcre_callout         only argument to the callout function is a pointer  to  a  pcre_callout
3067         block. This structure contains the following fields:         block. This structure contains the following fields:
3068    
3069           int          version;           int         version;
3070           int          callout_number;           int         callout_number;
3071           int         *offset_vector;           int        *offset_vector;
3072           const char  *subject;           const char *subject;
3073           int          subject_length;           int         subject_length;
3074           int          start_match;           int         start_match;
3075           int          current_position;           int         current_position;
3076           int          capture_top;           int         capture_top;
3077           int          capture_last;           int         capture_last;
3078           void        *callout_data;           void       *callout_data;
3079           int          pattern_position;           int         pattern_position;
3080           int          next_item_length;           int         next_item_length;
3081             const unsigned char *mark;
3082         The version field is an integer containing the version  number  of  the  
3083         block  format. The initial version was 0; the current version is 1. The         The  version  field  is an integer containing the version number of the
3084         version number will change again in future  if  additional  fields  are         block format. The initial version was 0; the current version is 2.  The
3085           version  number  will  change  again in future if additional fields are
3086         added, but the intention is never to remove any of the existing fields.         added, but the intention is never to remove any of the existing fields.
3087    
3088         The callout_number field contains the number of the  callout,  as  com-         The callout_number field contains the number of the  callout,  as  com-
# Line 2749  THE CALLOUT INTERFACE Line 3141  THE CALLOUT INTERFACE
3141         in  distinguishing between different automatic callouts, which all have         in  distinguishing between different automatic callouts, which all have
3142         the same callout number. However, they are set for all callouts.         the same callout number. However, they are set for all callouts.
3143    
3144           The mark field is present from version 2 of the pcre_callout structure.
3145           In  callouts  from pcre_exec() it contains a pointer to the zero-termi-
3146           nated name of the most recently passed (*MARK) item in  the  match,  or
3147           NULL if there are no (*MARK)s in the current matching path. In callouts
3148           from pcre_dfa_exec() this field always contains NULL.
3149    
3150    
3151  RETURN VALUES  RETURN VALUES
3152    
# Line 2757  RETURN VALUES Line 3155  RETURN VALUES
3155         zero, matching fails at the current point, but  the  testing  of  other         zero, matching fails at the current point, but  the  testing  of  other
3156         matching possibilities goes ahead, just as if a lookahead assertion had         matching possibilities goes ahead, just as if a lookahead assertion had
3157         failed. If the value is less than zero, the  match  is  abandoned,  and         failed. If the value is less than zero, the  match  is  abandoned,  and
3158         pcre_exec() (or pcre_dfa_exec()) returns the negative value.         pcre_exec() or pcre_dfa_exec() returns the negative value.
3159    
3160         Negative   values   should   normally   be   chosen  from  the  set  of         Negative   values   should   normally   be   chosen  from  the  set  of
3161         PCRE_ERROR_xxx values. In particular, PCRE_ERROR_NOMATCH forces a stan-         PCRE_ERROR_xxx values. In particular, PCRE_ERROR_NOMATCH forces a stan-
# Line 2775  AUTHOR Line 3173  AUTHOR
3173    
3174  REVISION  REVISION
3175    
3176         Last updated: 29 May 2007         Last updated: 26 August 2011
3177         Copyright (c) 1997-2007 University of Cambridge.         Copyright (c) 1997-2011 University of Cambridge.
3178  ------------------------------------------------------------------------------  ------------------------------------------------------------------------------
3179    
3180    
# Line 2790  NAME Line 3188  NAME
3188  DIFFERENCES BETWEEN PCRE AND PERL  DIFFERENCES BETWEEN PCRE AND PERL
3189    
3190         This  document describes the differences in the ways that PCRE and Perl         This  document describes the differences in the ways that PCRE and Perl
3191         handle regular expressions. The differences described here  are  mainly         handle regular expressions. The differences  described  here  are  with
3192         with  respect  to  Perl 5.8, though PCRE versions 7.0 and later contain         respect to Perl versions 5.10 and above.
3193         some features that are expected to be in the forthcoming Perl 5.10.  
3194           1.  PCRE has only a subset of Perl's UTF-8 and Unicode support. Details
3195         1. PCRE has only a subset of Perl's UTF-8 and Unicode support.  Details         of what it does have are given in the pcreunicode page.
3196         of  what  it does have are given in the section on UTF-8 support in the  
3197         main pcre page.         2. PCRE allows repeat quantifiers only on parenthesized assertions, but
3198           they  do  not mean what you might think. For example, (?!a){3} does not
3199         2. PCRE does not allow repeat quantifiers on lookahead assertions. Perl         assert that the next three characters are not "a". It just asserts that
3200         permits  them,  but they do not mean what you might think. For example,         the next character is not "a" three times (in principle: PCRE optimizes
3201         (?!a){3} does not assert that the next three characters are not "a". It         this to run the assertion just once). Perl allows repeat quantifiers on
3202         just asserts that the next character is not "a" three times.         other assertions such as \b, but these do not seem to have any use.
3203    
3204         3.  Capturing  subpatterns  that occur inside negative lookahead asser-         3.  Capturing  subpatterns  that occur inside negative lookahead asser-
3205         tions are counted, but their entries in the offsets  vector  are  never         tions are counted, but their entries in the offsets  vector  are  never
# Line 2816  DIFFERENCES BETWEEN PCRE AND PERL Line 3214  DIFFERENCES BETWEEN PCRE AND PERL
3214         the pattern to represent a binary zero.         the pattern to represent a binary zero.
3215    
3216         5.  The  following Perl escape sequences are not supported: \l, \u, \L,         5.  The  following Perl escape sequences are not supported: \l, \u, \L,
3217         \U, and \N. In fact these are implemented by Perl's general string-han-         \U, and \N when followed by a character name or Unicode value.  (\N  on
3218         dling  and are not part of its pattern matching engine. If any of these         its own, matching a non-newline character, is supported.) In fact these
3219         are encountered by PCRE, an error is generated.         are implemented by Perl's general string-handling and are not  part  of
3220           its  pattern  matching engine. If any of these are encountered by PCRE,
3221           an error is generated.
3222    
3223         6. The Perl escape sequences \p, \P, and \X are supported only if  PCRE         6. The Perl escape sequences \p, \P, and \X are supported only if  PCRE
3224         is  built  with Unicode character property support. The properties that         is  built  with Unicode character property support. The properties that
3225         can be tested with \p and \P are limited to the general category  prop-         can be tested with \p and \P are limited to the general category  prop-
3226         erties  such  as  Lu and Nd, script names such as Greek or Han, and the         erties  such  as  Lu and Nd, script names such as Greek or Han, and the
3227         derived properties Any and L&.         derived properties Any and L&. PCRE does  support  the  Cs  (surrogate)
3228           property,  which  Perl  does  not; the Perl documentation says "Because
3229         7. PCRE does support the \Q...\E escape for quoting substrings. Charac-         Perl hides the need for the user to understand the internal representa-
3230         ters  in  between  are  treated as literals. This is slightly different         tion  of Unicode characters, there is no need to implement the somewhat
3231         from Perl in that $ and @ are  also  handled  as  literals  inside  the         messy concept of surrogates."
3232         quotes.  In Perl, they cause variable interpolation (but of course PCRE  
3233           7. PCRE implements a simpler version of \X than Perl, which changed  to
3234           make  \X  match what Unicode calls an "extended grapheme cluster". This
3235           is more complicated than an extended Unicode sequence,  which  is  what
3236           PCRE matches.
3237    
3238           8. PCRE does support the \Q...\E escape for quoting substrings. Charac-
3239           ters in between are treated as literals.  This  is  slightly  different
3240           from  Perl  in  that  $  and  @ are also handled as literals inside the
3241           quotes. In Perl, they cause variable interpolation (but of course  PCRE
3242         does not have variables). Note the following examples:         does not have variables). Note the following examples:
3243    
3244             Pattern            PCRE matches      Perl matches             Pattern            PCRE matches      Perl matches
# Line 2839  DIFFERENCES BETWEEN PCRE AND PERL Line 3248  DIFFERENCES BETWEEN PCRE AND PERL
3248             \Qabc\$xyz\E       abc\$xyz          abc\$xyz             \Qabc\$xyz\E       abc\$xyz          abc\$xyz
3249             \Qabc\E\$\Qxyz\E   abc$xyz           abc$xyz             \Qabc\E\$\Qxyz\E   abc$xyz           abc$xyz
3250    
3251         The \Q...\E sequence is recognized both inside  and  outside  character         The  \Q...\E  sequence  is recognized both inside and outside character
3252         classes.         classes.
3253    
3254         8. Fairly obviously, PCRE does not support the (?{code}) and (??{code})         9. Fairly obviously, PCRE does not support the (?{code}) and (??{code})
3255         constructions. However, there is support for recursive  patterns.  This         constructions.  However,  there is support for recursive patterns. This
3256         is  not available in Perl 5.8, but will be in Perl 5.10. Also, the PCRE         is not available in Perl 5.8, but it is in Perl 5.10.  Also,  the  PCRE
3257         "callout" feature allows an external function to be called during  pat-         "callout"  feature allows an external function to be called during pat-
3258         tern matching. See the pcrecallout documentation for details.         tern matching. See the pcrecallout documentation for details.
3259    
3260         9.  Subpatterns  that  are  called  recursively or as "subroutines" are         10. Subpatterns that are called as subroutines (whether or  not  recur-
3261         always treated as atomic groups in  PCRE.  This  is  like  Python,  but         sively)  are  always  treated  as  atomic  groups in PCRE. This is like
3262         unlike Perl.         Python, but unlike Perl.  Captured values that are set outside  a  sub-
3263           routine  call  can  be  reference from inside in PCRE, but not in Perl.
3264           There is a discussion that explains these differences in more detail in
3265           the section on recursion differences from Perl in the pcrepattern page.
3266    
3267           11.  If  (*THEN)  is present in a group that is called as a subroutine,
3268           its action is limited to that group, even if the group does not contain
3269           any | characters.
3270    
3271         10.  There are some differences that are concerned with the settings of         12.  There are some differences that are concerned with the settings of
3272         captured strings when part of  a  pattern  is  repeated.  For  example,         captured strings when part of  a  pattern  is  repeated.  For  example,
3273         matching  "aba"  against  the  pattern  /^(a(b)?)+$/  in Perl leaves $2         matching  "aba"  against  the  pattern  /^(a(b)?)+$/  in Perl leaves $2
3274         unset, but in PCRE it is set to "b".         unset, but in PCRE it is set to "b".
3275    
3276         11.  PCRE  does  support  Perl  5.10's  backtracking  verbs  (*ACCEPT),         13. PCRE's handling of duplicate subpattern numbers and duplicate  sub-
3277         (*FAIL),  (*F),  (*COMMIT), (*PRUNE), (*SKIP), and (*THEN), but only in         pattern names is not as general as Perl's. This is a consequence of the
3278         the forms without an  argument.  PCRE  does  not  support  (*MARK).  If         fact the PCRE works internally just with numbers, using an external ta-
3279         (*ACCEPT)  is within capturing parentheses, PCRE does not set that cap-         ble  to  translate  between numbers and names. In particular, a pattern
3280         ture group; this is different to Perl.         such as (?|(?<a>A)|(?<b)B), where the two  capturing  parentheses  have
3281           the  same  number  but different names, is not supported, and causes an
3282         12. PCRE provides some extensions to the Perl regular expression facil-         error at compile time. If it were allowed, it would not be possible  to
3283         ities.   Perl  5.10  will  include new features that are not in earlier         distinguish  which  parentheses matched, because both names map to cap-
3284         versions, some of which (such as named parentheses) have been  in  PCRE         turing subpattern number 1. To avoid this confusing situation, an error
3285         for some time. This list is with respect to Perl 5.10:         is given at compile time.
3286    
3287         (a)  Although  lookbehind  assertions  must match fixed length strings,         14.  Perl  recognizes  comments  in some places that PCRE does not, for
3288         each alternative branch of a lookbehind assertion can match a different         example, between the ( and ? at the start of a subpattern.  If  the  /x
3289         length of string. Perl requires them all to have the same length.         modifier  is set, Perl allows whitespace between ( and ? but PCRE never
3290           does, even if the PCRE_EXTENDED option is set.
3291    
3292           15. PCRE provides some extensions to the Perl regular expression facil-
3293           ities.   Perl  5.10  includes new features that are not in earlier ver-
3294           sions of Perl, some of which (such as named parentheses) have  been  in
3295           PCRE for some time. This list is with respect to Perl 5.10:
3296    
3297           (a)  Although  lookbehind  assertions  in  PCRE must match fixed length
3298           strings, each alternative branch of a lookbehind assertion can match  a
3299           different  length  of  string.  Perl requires them all to have the same
3300           length.
3301    
3302         (b)  If PCRE_DOLLAR_ENDONLY is set and PCRE_MULTILINE is not set, the $         (b) If PCRE_DOLLAR_ENDONLY is set and PCRE_MULTILINE is not set, the  $
3303         meta-character matches only at the very end of the string.         meta-character matches only at the very end of the string.
3304    
3305         (c) If PCRE_EXTRA is set, a backslash followed by a letter with no spe-         (c) If PCRE_EXTRA is set, a backslash followed by a letter with no spe-
3306         cial meaning is faulted. Otherwise, like Perl, the backslash is quietly         cial meaning is faulted. Otherwise, like Perl, the backslash is quietly
3307         ignored.  (Perl can be made to issue a warning.)         ignored.  (Perl can be made to issue a warning.)
3308    
3309         (d) If PCRE_UNGREEDY is set, the greediness of the  repetition  quanti-         (d)  If  PCRE_UNGREEDY is set, the greediness of the repetition quanti-
3310         fiers is inverted, that is, by default they are not greedy, but if fol-         fiers is inverted, that is, by default they are not greedy, but if fol-
3311         lowed by a question mark they are.         lowed by a question mark they are.
3312    
3313         (e) PCRE_ANCHORED can be used at matching time to force a pattern to be         (e) PCRE_ANCHORED can be used at matching time to force a pattern to be
3314         tried only at the first matching position in the subject string.         tried only at the first matching position in the subject string.
3315    
3316         (f)  The PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, and PCRE_NO_AUTO_CAP-         (f) The PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NOTEMPTY_ATSTART,
3317         TURE options for pcre_exec() have no Perl equivalents.         and  PCRE_NO_AUTO_CAPTURE  options for pcre_exec() have no Perl equiva-
3318           lents.
3319    
3320         (g) The \R escape sequence can be restricted to match only CR,  LF,  or         (g) The \R escape sequence can be restricted to match only CR,  LF,  or
3321         CRLF by the PCRE_BSR_ANYCRLF option.         CRLF by the PCRE_BSR_ANYCRLF option.
# Line 2897  DIFFERENCES BETWEEN PCRE AND PERL Line 3325  DIFFERENCES BETWEEN PCRE AND PERL
3325         (i) The partial matching facility is PCRE-specific.         (i) The partial matching facility is PCRE-specific.
3326    
3327         (j) Patterns compiled by PCRE can be saved and re-used at a later time,         (j) Patterns compiled by PCRE can be saved and re-used at a later time,
3328         even on different hosts that have the other endianness.         even on different hosts that have the other endianness.  However,  this
3329           does not apply to optimized data created by the just-in-time compiler.
3330    
3331         (k) The alternative matching function (pcre_dfa_exec())  matches  in  a         (k)  The  alternative  matching function (pcre_dfa_exec()) matches in a
3332         different way and is not Perl-compatible.         different way and is not Perl-compatible.
3333    
3334         (l)  PCRE  recognizes some special sequences such as (*CR) at the start         (l) PCRE recognizes some special sequences such as (*CR) at  the  start
3335         of a pattern that set overall options that cannot be changed within the         of a pattern that set overall options that cannot be changed within the
3336         pattern.         pattern.
3337    
# Line 2916  AUTHOR Line 3345  AUTHOR
3345    
3346  REVISION  REVISION
3347    
3348         Last updated: 11 September 2007         Last updated: 09 October 2011
3349         Copyright (c) 1997-2007 University of Cambridge.         Copyright (c) 1997-2011 University of Cambridge.
3350  ------------------------------------------------------------------------------  ------------------------------------------------------------------------------
3351    
3352    
# Line 2947  PCRE REGULAR EXPRESSION DETAILS Line 3376  PCRE REGULAR EXPRESSION DETAILS
3376    
3377         The original operation of PCRE was on strings of  one-byte  characters.         The original operation of PCRE was on strings of  one-byte  characters.
3378         However,  there is now also support for UTF-8 character strings. To use         However,  there is now also support for UTF-8 character strings. To use
3379         this, you must build PCRE to  include  UTF-8  support,  and  then  call         this, PCRE must be built to include UTF-8 support, and  you  must  call
3380         pcre_compile()  with  the  PCRE_UTF8  option.  How this affects pattern         pcre_compile()  or  pcre_compile2() with the PCRE_UTF8 option. There is
3381         matching is mentioned in several places below. There is also a  summary         also a special sequence that can be given at the start of a pattern:
3382         of  UTF-8  features  in  the  section on UTF-8 support in the main pcre  
3383             (*UTF8)
3384    
3385           Starting a pattern with this sequence  is  equivalent  to  setting  the
3386           PCRE_UTF8  option.  This  feature  is  not Perl-compatible. How setting
3387           UTF-8 mode affects pattern matching  is  mentioned  in  several  places
3388           below.  There  is  also  a summary of UTF-8 features in the pcreunicode
3389         page.         page.
3390    
3391         The remainder of this document discusses the  patterns  that  are  sup-         Another special sequence that may appear at the start of a  pattern  or
3392         ported  by  PCRE when its main matching function, pcre_exec(), is used.         in combination with (*UTF8) is:
3393         From  release  6.0,   PCRE   offers   a   second   matching   function,  
3394         pcre_dfa_exec(),  which matches using a different algorithm that is not           (*UCP)
3395    
3396           This  has  the  same  effect  as setting the PCRE_UCP option: it causes
3397           sequences such as \d and \w to  use  Unicode  properties  to  determine
3398           character types, instead of recognizing only characters with codes less
3399           than 128 via a lookup table.
3400    
3401           If a pattern starts with (*NO_START_OPT), it has  the  same  effect  as
3402           setting the PCRE_NO_START_OPTIMIZE option either at compile or matching
3403           time. There are also some more of these special sequences that are con-
3404           cerned with the handling of newlines; they are described below.
3405    
3406           The  remainder  of  this  document discusses the patterns that are sup-
3407           ported by PCRE when its main matching function, pcre_exec(),  is  used.
3408           From   release   6.0,   PCRE   offers   a   second  matching  function,
3409           pcre_dfa_exec(), which matches using a different algorithm that is  not
3410         Perl-compatible. Some of the features discussed below are not available         Perl-compatible. Some of the features discussed below are not available
3411         when  pcre_dfa_exec()  is used. The advantages and disadvantages of the         when pcre_dfa_exec() is used. The advantages and disadvantages  of  the
3412         alternative function, and how it differs from the normal function,  are         alternative  function, and how it differs from the normal function, are
3413         discussed in the pcrematching page.         discussed in the pcrematching page.
3414    
3415    
3416  NEWLINE CONVENTIONS  NEWLINE CONVENTIONS
3417    
3418         PCRE  supports five different conventions for indicating line breaks in         PCRE supports five different conventions for indicating line breaks  in
3419         strings: a single CR (carriage return) character, a  single  LF  (line-         strings:  a  single  CR (carriage return) character, a single LF (line-
3420         feed) character, the two-character sequence CRLF, any of the three pre-         feed) character, the two-character sequence CRLF, any of the three pre-
3421         ceding, or any Unicode newline sequence. The pcreapi page  has  further         ceding,  or  any Unicode newline sequence. The pcreapi page has further
3422         discussion  about newlines, and shows how to set the newline convention         discussion about newlines, and shows how to set the newline  convention
3423         in the options arguments for the compiling and matching functions.         in the options arguments for the compiling and matching functions.
3424    
3425         It is also possible to specify a newline convention by starting a  pat-         It  is also possible to specify a newline convention by starting a pat-
3426         tern string with one of the following five sequences:         tern string with one of the following five sequences:
3427    
3428           (*CR)        carriage return           (*CR)        carriage return
# Line 2981  NEWLINE CONVENTIONS Line 3431  NEWLINE CONVENTIONS
3431           (*ANYCRLF)   any of the three above           (*ANYCRLF)   any of the three above
3432           (*ANY)       all Unicode newline sequences           (*ANY)       all Unicode newline sequences
3433    
3434         These override the default and the options given to pcre_compile(). For         These override the default and the options given to  pcre_compile()  or
3435         example, on a Unix system where LF is the default newline sequence, the         pcre_compile2().  For example, on a Unix system where LF is the default
3436         pattern         newline sequence, the pattern
3437    
3438           (*CR)a.b           (*CR)a.b
3439    
3440         changes the convention to CR. That pattern matches "a\nb" because LF is         changes the convention to CR. That pattern matches "a\nb" because LF is
3441         no longer a newline. Note that these special settings,  which  are  not         no  longer  a  newline. Note that these special settings, which are not
3442         Perl-compatible,  are  recognized  only at the very start of a pattern,         Perl-compatible, are recognized only at the very start  of  a  pattern,
3443         and that they must be in upper case.  If  more  than  one  of  them  is         and  that  they  must  be  in  upper  case. If more than one of them is
3444         present, the last one is used.         present, the last one is used.
3445    
3446         The  newline  convention  does  not  affect what the \R escape sequence         The newline convention affects the interpretation of the dot  metachar-
3447         matches. By default, this is any Unicode  newline  sequence,  for  Perl         acter  when  PCRE_DOTALL is not set, and also the behaviour of \N. How-
3448         compatibility.  However, this can be changed; see the description of \R         ever, it does not affect  what  the  \R  escape  sequence  matches.  By
3449         in the section entitled "Newline sequences" below. A change of \R  set-         default,  this is any Unicode newline sequence, for Perl compatibility.
3450         ting can be combined with a change of newline convention.         However, this can be changed; see the description of \R in the  section
3451           entitled  "Newline sequences" below. A change of \R setting can be com-
3452           bined with a change of newline convention.
3453    
3454    
3455  CHARACTERS AND METACHARACTERS  CHARACTERS AND METACHARACTERS
3456    
3457         A  regular  expression  is  a pattern that is matched against a subject         A regular expression is a pattern that is  matched  against  a  subject
3458         string from left to right. Most characters stand for  themselves  in  a         string  from  left  to right. Most characters stand for themselves in a
3459         pattern,  and  match  the corresponding characters in the subject. As a         pattern, and match the corresponding characters in the  subject.  As  a
3460         trivial example, the pattern         trivial example, the pattern
3461    
3462           The quick brown fox           The quick brown fox
3463    
3464         matches a portion of a subject string that is identical to itself. When         matches a portion of a subject string that is identical to itself. When
3465         caseless  matching is specified (the PCRE_CASELESS option), letters are         caseless matching is specified (the PCRE_CASELESS option), letters  are
3466         matched independently of case. In UTF-8 mode, PCRE  always  understands         matched  independently  of case. In UTF-8 mode, PCRE always understands
3467         the  concept  of case for characters whose values are less than 128, so         the concept of case for characters whose values are less than  128,  so
3468         caseless matching is always possible. For characters with  higher  val-         caseless  matching  is always possible. For characters with higher val-
3469         ues,  the concept of case is supported if PCRE is compiled with Unicode         ues, the concept of case is supported if PCRE is compiled with  Unicode
3470         property support, but not otherwise.   If  you  want  to  use  caseless         property  support,  but  not  otherwise.   If  you want to use caseless
3471         matching  for  characters  128  and above, you must ensure that PCRE is         matching for characters 128 and above, you must  ensure  that  PCRE  is
3472         compiled with Unicode property support as well as with UTF-8 support.         compiled with Unicode property support as well as with UTF-8 support.
3473    
3474         The power of regular expressions comes  from  the  ability  to  include         The  power  of  regular  expressions  comes from the ability to include
3475         alternatives  and  repetitions in the pattern. These are encoded in the         alternatives and repetitions in the pattern. These are encoded  in  the
3476         pattern by the use of metacharacters, which do not stand for themselves         pattern by the use of metacharacters, which do not stand for themselves
3477         but instead are interpreted in some special way.         but instead are interpreted in some special way.
3478    
3479         There  are  two different sets of metacharacters: those that are recog-         There are two different sets of metacharacters: those that  are  recog-
3480         nized anywhere in the pattern except within square brackets, and  those         nized  anywhere in the pattern except within square brackets, and those
3481         that  are  recognized  within square brackets. Outside square brackets,         that are recognized within square brackets.  Outside  square  brackets,
3482         the metacharacters are as follows:         the metacharacters are as follows:
3483    
3484           \      general escape character with several uses           \      general escape character with several uses
# Line 3045  CHARACTERS AND METACHARACTERS Line 3497  CHARACTERS AND METACHARACTERS
3497                  also "possessive quantifier"                  also "possessive quantifier"
3498           {      start min/max quantifier           {      start min/max quantifier
3499    
3500         Part of a pattern that is in square brackets  is  called  a  "character         Part  of  a  pattern  that is in square brackets is called a "character
3501         class". In a character class the only metacharacters are:         class". In a character class the only metacharacters are:
3502    
3503           \      general escape character           \      general escape character
# Line 3055  CHARACTERS AND METACHARACTERS Line 3507  CHARACTERS AND METACHARACTERS
3507                    syntax)                    syntax)
3508           ]      terminates the character class           ]      terminates the character class
3509    
3510         The  following sections describe the use of each of the metacharacters.         The following sections describe the use of each of the metacharacters.
3511    
3512    
3513  BACKSLASH  BACKSLASH
3514    
3515         The backslash character has several uses. Firstly, if it is followed by         The backslash character has several uses. Firstly, if it is followed by
3516         a  non-alphanumeric  character,  it takes away any special meaning that         a character that is not a number or a letter, it takes away any special
3517         character may have. This  use  of  backslash  as  an  escape  character         meaning that character may have. This use of  backslash  as  an  escape
3518         applies both inside and outside character classes.         character applies both inside and outside character classes.
3519    
3520         For  example,  if  you want to match a * character, you write \* in the         For  example,  if  you want to match a * character, you write \* in the
3521         pattern.  This escaping action applies whether  or  not  the  following         pattern.  This escaping action applies whether  or  not  the  following
# Line 3072  BACKSLASH Line 3524  BACKSLASH
3524         that  it stands for itself. In particular, if you want to match a back-         that  it stands for itself. In particular, if you want to match a back-
3525         slash, you write \\.         slash, you write \\.
3526    
3527           In UTF-8 mode, only ASCII numbers and letters have any special  meaning
3528           after  a  backslash.  All  other characters (in particular, those whose
3529           codepoints are greater than 127) are treated as literals.
3530    
3531         If a pattern is compiled with the PCRE_EXTENDED option,  whitespace  in         If a pattern is compiled with the PCRE_EXTENDED option,  whitespace  in
3532         the  pattern (other than in a character class) and characters between a         the  pattern (other than in a character class) and characters between a
3533         # outside a character class and the next newline are ignored. An escap-         # outside a character class and the next newline are ignored. An escap-
# Line 3092  BACKSLASH Line 3548  BACKSLASH
3548           \Qabc\E\$\Qxyz\E   abc$xyz        abc$xyz           \Qabc\E\$\Qxyz\E   abc$xyz        abc$xyz
3549    
3550         The \Q...\E sequence is recognized both inside  and  outside  character         The \Q...\E sequence is recognized both inside  and  outside  character
3551         classes.         classes.   An  isolated \E that is not preceded by \Q is ignored. If \Q
3552           is not followed by \E later in the pattern, the literal  interpretation
3553           continues  to  the  end  of  the pattern (that is, \E is assumed at the
3554           end). If the isolated \Q is inside a character class,  this  causes  an
3555           error, because the character class is not terminated.
3556    
3557     Non-printing characters     Non-printing characters
3558    
# Line 3100  BACKSLASH Line 3560  BACKSLASH
3560         acters in patterns in a visible manner. There is no restriction on  the         acters in patterns in a visible manner. There is no restriction on  the
3561         appearance  of non-printing characters, apart from the binary zero that         appearance  of non-printing characters, apart from the binary zero that
3562         terminates a pattern, but when a pattern  is  being  prepared  by  text         terminates a pattern, but when a pattern  is  being  prepared  by  text
3563         editing,  it  is  usually  easier  to  use  one of the following escape         editing,  it  is  often  easier  to  use  one  of  the following escape
3564         sequences than the binary character it represents:         sequences than the binary character it represents:
3565    
3566           \a        alarm, that is, the BEL character (hex 07)           \a        alarm, that is, the BEL character (hex 07)
3567           \cx       "control-x", where x is any character           \cx       "control-x", where x is any ASCII character
3568           \e        escape (hex 1B)           \e        escape (hex 1B)
3569           \f        formfeed (hex 0C)           \f        formfeed (hex 0C)
3570           \n        linefeed (hex 0A)           \n        linefeed (hex 0A)
3571           \r        carriage return (hex 0D)           \r        carriage return (hex 0D)
3572           \t        tab (hex 09)           \t        tab (hex 09)
3573           \ddd      character with octal code ddd, or backreference           \ddd      character with octal code ddd, or back reference
3574           \xhh      character with hex code hh           \xhh      character with hex code hh
3575           \x{hhh..} character with hex code hhh..           \x{hhh..} character with hex code hhh..
3576    
3577         The precise effect of \cx is as follows: if x is a lower  case  letter,         The precise effect of \cx is as follows: if x is a lower  case  letter,
3578         it  is converted to upper case. Then bit 6 of the character (hex 40) is         it  is converted to upper case. Then bit 6 of the character (hex 40) is
3579         inverted.  Thus \cz becomes hex 1A, but \c{ becomes hex 3B,  while  \c;         inverted.  Thus \cz becomes hex 1A (z is 7A), but \c{ becomes hex 3B ({
3580         becomes hex 7B.         is  7B),  while  \c; becomes hex 7B (; is 3B). If the byte following \c
3581           has a value greater than 127, a compile-time error occurs.  This  locks
3582           out  non-ASCII  characters in both byte mode and UTF-8 mode. (When PCRE
3583           is compiled in EBCDIC mode, all byte values are  valid.  A  lower  case
3584           letter is converted to upper case, and then the 0xc0 bits are flipped.)
3585    
3586         After  \x, from zero to two hexadecimal digits are read (letters can be         After  \x, from zero to two hexadecimal digits are read (letters can be
3587         in upper or lower case). Any number of hexadecimal  digits  may  appear         in upper or lower case). Any number of hexadecimal  digits  may  appear
# Line 3179  BACKSLASH Line 3643  BACKSLASH
3643         All the sequences that define a single character value can be used both         All the sequences that define a single character value can be used both
3644         inside and outside character classes. In addition, inside  a  character         inside and outside character classes. In addition, inside  a  character
3645         class,  the  sequence \b is interpreted as the backspace character (hex         class,  the  sequence \b is interpreted as the backspace character (hex
3646         08), and the sequences \R and \X are interpreted as the characters  "R"         08). The sequences \B, \N, \R, and \X are not special inside a  charac-
3647         and  "X", respectively. Outside a character class, these sequences have         ter  class.  Like  any  other  unrecognized  escape sequences, they are
3648         different meanings (see below).         treated as the literal characters "B", "N", "R", and  "X"  by  default,
3649           but cause an error if the PCRE_EXTRA option is set. Outside a character
3650           class, these sequences have different meanings.
3651    
3652     Absolute and relative back references     Absolute and relative back references
3653    
# Line 3201  BACKSLASH Line 3667  BACKSLASH
3667    
3668     Generic character types     Generic character types
3669    
3670         Another use of backslash is for specifying generic character types. The         Another use of backslash is for specifying generic character types:
        following are always recognized:  
3671    
3672           \d     any decimal digit           \d     any decimal digit
3673           \D     any character that is not a decimal digit           \D     any character that is not a decimal digit
# Line 3215  BACKSLASH Line 3680  BACKSLASH
3680           \w     any "word" character           \w     any "word" character
3681           \W     any "non-word" character           \W     any "non-word" character
3682    
3683         Each pair of escape sequences partitions the complete set of characters         There is also the single sequence \N, which matches a non-newline char-
3684         into two disjoint sets. Any given character matches one, and only  one,         acter.   This  is the same as the "." metacharacter when PCRE_DOTALL is
3685         of each pair.         not set.
3686    
3687         These character type sequences can appear both inside and outside char-         Each pair of lower and upper case escape sequences partitions the  com-
3688         acter classes. They each match one character of the  appropriate  type.         plete  set  of  characters  into two disjoint sets. Any given character
3689         If  the current matching point is at the end of the subject string, all         matches one, and only one, of each pair. The sequences can appear  both
3690         of them fail, since there is no character to match.         inside  and outside character classes. They each match one character of
3691           the appropriate type. If the current matching point is at  the  end  of
3692           the  subject string, all of them fail, because there is no character to
3693           match.
3694    
3695         For compatibility with Perl, \s does not match the VT  character  (code         For compatibility with Perl, \s does not match the VT  character  (code
3696         11).   This makes it different from the the POSIX "space" class. The \s         11).   This makes it different from the the POSIX "space" class. The \s
# Line 3230  BACKSLASH Line 3698  BACKSLASH
3698         "use locale;" is included in a Perl script, \s may match the VT charac-         "use locale;" is included in a Perl script, \s may match the VT charac-
3699         ter. In PCRE, it never does.         ter. In PCRE, it never does.
3700    
3701         In UTF-8 mode, characters with values greater than 128 never match  \d,         A "word" character is an underscore or any character that is  a  letter
3702         \s, or \w, and always match \D, \S, and \W. This is true even when Uni-         or  digit.   By  default,  the definition of letters and digits is con-
3703         code character property support is available.  These  sequences  retain         trolled by PCRE's low-valued character tables, and may vary if  locale-
3704         their original meanings from before UTF-8 support was available, mainly         specific  matching is taking place (see "Locale support" in the pcreapi
3705         for efficiency reasons.         page). For example, in a French locale such  as  "fr_FR"  in  Unix-like
3706           systems,  or "french" in Windows, some character codes greater than 128
3707         The sequences \h, \H, \v, and \V are Perl 5.10 features. In contrast to         are used for accented letters, and these are then matched  by  \w.  The
3708         the  other  sequences, these do match certain high-valued codepoints in         use of locales with Unicode is discouraged.
3709         UTF-8 mode.  The horizontal space characters are:  
3710           By  default,  in  UTF-8  mode,  characters with values greater than 128
3711           never match \d, \s, or \w, and always  match  \D,  \S,  and  \W.  These
3712           sequences  retain their original meanings from before UTF-8 support was
3713           available, mainly for efficiency reasons. However, if PCRE is  compiled
3714           with  Unicode property support, and the PCRE_UCP option is set, the be-
3715           haviour is changed so that Unicode properties  are  used  to  determine
3716           character types, as follows:
3717    
3718             \d  any character that \p{Nd} matches (decimal digit)
3719             \s  any character that \p{Z} matches, plus HT, LF, FF, CR
3720             \w  any character that \p{L} or \p{N} matches, plus underscore
3721    
3722           The  upper case escapes match the inverse sets of characters. Note that
3723           \d matches only decimal digits, whereas \w matches any  Unicode  digit,
3724           as  well as any Unicode letter, and underscore. Note also that PCRE_UCP
3725           affects \b, and \B because they are defined in  terms  of  \w  and  \W.
3726           Matching these sequences is noticeably slower when PCRE_UCP is set.
3727    
3728           The  sequences  \h, \H, \v, and \V are features that were added to Perl
3729           at release 5.10. In contrast to the other sequences, which  match  only
3730           ASCII  characters  by  default,  these always match certain high-valued
3731           codepoints in UTF-8 mode, whether or not PCRE_UCP is set. The  horizon-
3732           tal space characters are:
3733    
3734           U+0009     Horizontal tab           U+0009     Horizontal tab
3735           U+0020     Space           U+0020     Space
# Line 3270  BACKSLASH Line 3761  BACKSLASH
3761           U+2028     Line separator           U+2028     Line separator
3762           U+2029     Paragraph separator           U+2029     Paragraph separator
3763    
        A "word" character is an underscore or any character less than 256 that  
        is  a  letter  or  digit.  The definition of letters and digits is con-  
        trolled by PCRE's low-valued character tables, and may vary if  locale-  
        specific  matching is taking place (see "Locale support" in the pcreapi  
        page). For example, in a French locale such  as  "fr_FR"  in  Unix-like  
        systems,  or "french" in Windows, some character codes greater than 128  
        are used for accented letters, and these are matched by \w. The use  of  
        locales with Unicode is discouraged.  
   
3764     Newline sequences     Newline sequences
3765    
3766         Outside  a  character class, by default, the escape sequence \R matches         Outside  a  character class, by default, the escape sequence \R matches
3767         any Unicode newline sequence. This is a Perl 5.10 feature. In non-UTF-8         any Unicode newline sequence. In non-UTF-8 mode \R is equivalent to the
3768         mode \R is equivalent to the following:         following:
3769    
3770           (?>\r\n|\n|\x0b|\f|\r|\x85)           (?>\r\n|\n|\x0b|\f|\r|\x85)
3771    
# Line 3311  BACKSLASH Line 3793  BACKSLASH
3793           (*BSR_ANYCRLF)   CR, LF, or CRLF only           (*BSR_ANYCRLF)   CR, LF, or CRLF only
3794           (*BSR_UNICODE)   any Unicode newline sequence           (*BSR_UNICODE)   any Unicode newline sequence
3795    
3796         These override the default and the options given to pcre_compile(), but         These override the default and the options given to  pcre_compile()  or
3797         they can be overridden by options given to pcre_exec(). Note that these         pcre_compile2(),  but  they  can  be  overridden  by  options  given to
3798         special settings, which are not Perl-compatible, are recognized only at         pcre_exec() or pcre_dfa_exec(). Note that these special settings, which
3799         the  very  start  of a pattern, and that they must be in upper case. If         are  not  Perl-compatible,  are  recognized only at the very start of a
3800         more than one of them is present, the last one is  used.  They  can  be         pattern, and that they must be in upper case. If more than one of  them
3801         combined  with  a  change of newline convention, for example, a pattern         is present, the last one is used. They can be combined with a change of
3802         can start with:         newline convention; for example, a pattern can start with:
3803    
3804           (*ANY)(*BSR_ANYCRLF)           (*ANY)(*BSR_ANYCRLF)
3805    
3806         Inside a character class, \R matches the letter "R".         They can also be combined with the (*UTF8) or (*UCP) special sequences.
3807           Inside  a  character  class,  \R  is  treated as an unrecognized escape
3808           sequence, and so matches the letter "R" by default, but causes an error
3809           if PCRE_EXTRA is set.
3810    
3811     Unicode character properties     Unicode character properties
3812    
3813         When PCRE is built with Unicode character property support, three addi-         When PCRE is built with Unicode character property support, three addi-
3814         tional  escape sequences that match characters with specific properties         tional escape sequences that match characters with specific  properties
3815         are available.  When not in UTF-8 mode, these sequences are  of  course         are  available.   When not in UTF-8 mode, these sequences are of course
3816         limited  to  testing characters whose codepoints are less than 256, but         limited to testing characters whose codepoints are less than  256,  but
3817         they do work in this mode.  The extra escape sequences are:         they do work in this mode.  The extra escape sequences are:
3818    
3819           \p{xx}   a character with the xx property           \p{xx}   a character with the xx property
3820           \P{xx}   a character without the xx property           \P{xx}   a character without the xx property
3821           \X       an extended Unicode sequence           \X       an extended Unicode sequence
3822    
3823         The property names represented by xx above are limited to  the  Unicode         The  property  names represented by xx above are limited to the Unicode
3824         script names, the general category properties, and "Any", which matches         script names, the general category properties, "Any", which matches any
3825         any character (including newline). Other properties such as "InMusical-         character   (including  newline),  and  some  special  PCRE  properties
3826         Symbols"  are  not  currently supported by PCRE. Note that \P{Any} does         (described in the next section).  Other Perl properties such as  "InMu-
3827         not match any characters, so always causes a match failure.         sicalSymbols"  are  not  currently supported by PCRE. Note that \P{Any}
3828           does not match any characters, so always causes a match failure.
3829    
3830         Sets of Unicode characters are defined as belonging to certain scripts.         Sets of Unicode characters are defined as belonging to certain scripts.
3831         A  character from one of these sets can be matched using a script name.         A  character from one of these sets can be matched using a script name.
# Line 3351  BACKSLASH Line 3837  BACKSLASH
3837         Those that are not part of an identified script are lumped together  as         Those that are not part of an identified script are lumped together  as
3838         "Common". The current list of scripts is:         "Common". The current list of scripts is:
3839    
3840         Arabic,  Armenian,  Balinese,  Bengali,  Bopomofo,  Braille,  Buginese,         Arabic, Armenian, Avestan, Balinese, Bamum, Bengali, Bopomofo, Braille,
3841         Buhid,  Canadian_Aboriginal,  Cherokee,  Common,   Coptic,   Cuneiform,         Buginese, Buhid, Canadian_Aboriginal, Carian, Cham,  Cherokee,  Common,
3842         Cypriot, Cyrillic, Deseret, Devanagari, Ethiopic, Georgian, Glagolitic,         Coptic,   Cuneiform,  Cypriot,  Cyrillic,  Deseret,  Devanagari,  Egyp-
3843         Gothic, Greek, Gujarati, Gurmukhi, Han, Hangul, Hanunoo, Hebrew,  Hira-         tian_Hieroglyphs,  Ethiopic,  Georgian,  Glagolitic,   Gothic,   Greek,
3844         gana,  Inherited,  Kannada,  Katakana,  Kharoshthi,  Khmer, Lao, Latin,         Gujarati,  Gurmukhi,  Han,  Hangul,  Hanunoo,  Hebrew,  Hiragana, Impe-
3845         Limbu,  Linear_B,  Malayalam,  Mongolian,  Myanmar,  New_Tai_Lue,  Nko,         rial_Aramaic, Inherited, Inscriptional_Pahlavi, Inscriptional_Parthian,
3846         Ogham,  Old_Italic,  Old_Persian, Oriya, Osmanya, Phags_Pa, Phoenician,         Javanese,  Kaithi, Kannada, Katakana, Kayah_Li, Kharoshthi, Khmer, Lao,
3847         Runic,  Shavian,  Sinhala,  Syloti_Nagri,  Syriac,  Tagalog,  Tagbanwa,         Latin,  Lepcha,  Limbu,  Linear_B,  Lisu,  Lycian,  Lydian,  Malayalam,
3848         Tai_Le, Tamil, Telugu, Thaana, Thai, Tibetan, Tifinagh, Ugaritic, Yi.         Meetei_Mayek,  Mongolian, Myanmar, New_Tai_Lue, Nko, Ogham, Old_Italic,
3849           Old_Persian, Old_South_Arabian, Old_Turkic, Ol_Chiki,  Oriya,  Osmanya,
3850         Each  character has exactly one general category property, specified by         Phags_Pa,  Phoenician,  Rejang,  Runic, Samaritan, Saurashtra, Shavian,
3851         a two-letter abbreviation. For compatibility with Perl, negation can be         Sinhala, Sundanese, Syloti_Nagri, Syriac,  Tagalog,  Tagbanwa,  Tai_Le,
3852         specified  by  including a circumflex between the opening brace and the         Tai_Tham,  Tai_Viet,  Tamil,  Telugu,  Thaana, Thai, Tibetan, Tifinagh,
3853         property name. For example, \p{^Lu} is the same as \P{Lu}.         Ugaritic, Vai, Yi.
3854    
3855           Each character has exactly one Unicode general category property, spec-
3856           ified  by a two-letter abbreviation. For compatibility with Perl, nega-
3857           tion can be specified by including a  circumflex  between  the  opening
3858           brace  and  the  property  name.  For  example,  \p{^Lu} is the same as
3859           \P{Lu}.
3860    
3861         If only one letter is specified with \p or \P, it includes all the gen-         If only one letter is specified with \p or \P, it includes all the gen-
3862         eral  category properties that start with that letter. In this case, in         eral  category properties that start with that letter. In this case, in
# Line 3428  BACKSLASH Line 3920  BACKSLASH
3920         U+D800 to U+DFFF. Such characters are not valid in UTF-8  strings  (see         U+D800 to U+DFFF. Such characters are not valid in UTF-8  strings  (see
3921         RFC 3629) and so cannot be tested by PCRE, unless UTF-8 validity check-         RFC 3629) and so cannot be tested by PCRE, unless UTF-8 validity check-
3922         ing has been turned off (see the discussion  of  PCRE_NO_UTF8_CHECK  in         ing has been turned off (see the discussion  of  PCRE_NO_UTF8_CHECK  in
3923         the pcreapi page).         the pcreapi page). Perl does not support the Cs property.
3924    
3925         The  long  synonyms  for  these  properties that Perl supports (such as         The  long  synonyms  for  property  names  that  Perl supports (such as
3926         \p{Letter}) are not supported by PCRE, nor is it  permitted  to  prefix         \p{Letter}) are not supported by PCRE, nor is it  permitted  to  prefix
3927         any of these properties with "Is".         any of these properties with "Is".
3928    
# Line 3453  BACKSLASH Line 3945  BACKSLASH
3945         None  of  them  have  codepoints less than 256, so in non-UTF-8 mode \X         None  of  them  have  codepoints less than 256, so in non-UTF-8 mode \X
3946         matches any one character.         matches any one character.
3947    
3948           Note that recent versions of Perl have changed \X to match what Unicode
3949           calls an "extended grapheme cluster", which has a more complicated def-
3950           inition.
3951    
3952         Matching characters by Unicode property is not fast, because  PCRE  has         Matching characters by Unicode property is not fast, because  PCRE  has
3953         to  search  a  structure  that  contains data for over fifteen thousand         to  search  a  structure  that  contains data for over fifteen thousand
3954         characters. That is why the traditional escape sequences such as \d and         characters. That is why the traditional escape sequences such as \d and
3955         \w do not use Unicode properties in PCRE.         \w  do  not  use  Unicode properties in PCRE by default, though you can
3956           make them do so by setting the PCRE_UCP option for pcre_compile() or by
3957           starting the pattern with (*UCP).
3958    
3959       PCRE's additional properties
3960    
3961           As  well  as  the standard Unicode properties described in the previous
3962           section, PCRE supports four more that make it possible to convert  tra-
3963           ditional escape sequences such as \w and \s and POSIX character classes
3964           to use Unicode properties. PCRE uses these non-standard, non-Perl prop-
3965           erties internally when PCRE_UCP is set. They are:
3966    
3967             Xan   Any alphanumeric character
3968             Xps   Any POSIX space character
3969             Xsp   Any Perl space character
3970             Xwd   Any Perl "word" character
3971    
3972           Xan  matches  characters that have either the L (letter) or the N (num-
3973           ber) property. Xps matches the characters tab, linefeed, vertical  tab,
3974           formfeed,  or  carriage  return, and any other character that has the Z
3975           (separator) property.  Xsp is the same as Xps, except that vertical tab
3976           is excluded. Xwd matches the same characters as Xan, plus underscore.
3977    
3978     Resetting the match start     Resetting the match start
3979    
3980         The escape sequence \K, which is a Perl 5.10 feature, causes any previ-         The  escape sequence \K causes any previously matched characters not to
3981         ously matched characters not  to  be  included  in  the  final  matched         be included in the final matched sequence. For example, the pattern:
        sequence. For example, the pattern:  
3982    
3983