/[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 869 by ph10, Sat Jan 14 11:16:23 2012 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-         Starting with release 8.30, it is possible to compile two separate PCRE
29         mately with Perl 5.10, including support for UTF-8 encoded strings  and         libraries:  the  original,  which  supports  8-bit  character   strings
30         Unicode general category properties. However, UTF-8 and Unicode support         (including  UTF-8  strings),  and a second library that supports 16-bit
31         has to be explicitly enabled; it is not the default. The Unicode tables         character strings (including UTF-16 strings). The build process  allows
32         correspond to Unicode release 5.0.0.         either  one  or both to be built. The majority of the work to make this
33           possible was done by Zoltan Herczeg.
34    
35           The two libraries contain identical sets of functions, except that  the
36           names  in  the  16-bit  library start with pcre16_ instead of pcre_. To
37           avoid over-complication and reduce the documentation maintenance  load,
38           most of the documentation describes the 8-bit library, with the differ-
39           ences for the 16-bit library described separately in the  pcre16  page.
40           References  to  functions or structures of the form pcre[16]_xxx should
41           be  read  as  meaning  "pcre_xxx  when  using  the  8-bit  library  and
42           pcre16_xxx when using the 16-bit library".
43    
44           The  current implementation of PCRE corresponds approximately with Perl
45           5.12, including support for UTF-8/16 encoded strings and  Unicode  gen-
46           eral  category properties. However, UTF-8/16 and Unicode support has to
47           be explicitly enabled; it is not the default. The Unicode tables corre-
48           spond to Unicode release 6.0.0.
49    
50         In  addition to the Perl-compatible matching function, PCRE contains an         In  addition to the Perl-compatible matching function, PCRE contains an
51         alternative matching function that matches the same  compiled  patterns         alternative function that matches the same compiled patterns in a  dif-
52         in  a different way. In certain circumstances, the alternative function         ferent way. In certain circumstances, the alternative function has some
53         has some advantages. For a discussion of the two  matching  algorithms,         advantages.  For a discussion of the two matching algorithms,  see  the
54         see the pcrematching page.         pcrematching page.
55    
56         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
57         have written wrappers and interfaces of various kinds.  In  particular,         have written wrappers and interfaces of various kinds.  In  particular,
58         Google  Inc.   have  provided  a comprehensive C++ wrapper. This is now         Google  Inc.   have  provided a comprehensive C++ wrapper for the 8-bit
59         included as part of the PCRE distribution. The pcrecpp page has details         library. This is now included as part of  the  PCRE  distribution.  The
60         of  this  interface.  Other  people's contributions can be found in the         pcrecpp  page  has  details of this interface. Other people's contribu-
61         Contrib directory at the primary FTP site, which is:         tions can be found in the Contrib directory at the  primary  FTP  site,
62           which is:
63    
64         ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre         ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre
65    
66         Details of exactly which Perl regular expression features are  and  are         Details  of  exactly which Perl regular expression features are and are
67         not supported by PCRE are given in separate documents. See the pcrepat-         not supported by PCRE are given in separate documents. See the pcrepat-
68         tern and pcrecompat pages. There is a syntax summary in the  pcresyntax         tern  and pcrecompat pages. There is a syntax summary in the pcresyntax
69         page.         page.
70    
71         Some  features  of  PCRE can be included, excluded, or changed when the         Some features of PCRE can be included, excluded, or  changed  when  the
72         library is built. The pcre_config() function makes it  possible  for  a         library  is  built.  The pcre_config() function makes it possible for a
73         client  to  discover  which  features are available. The features them-         client to discover which features are  available.  The  features  them-
74         selves are described in the pcrebuild page. Documentation about  build-         selves  are described in the pcrebuild page. Documentation about build-
75         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
76         in the source distribution.         NON-UNIX-USE files in the source distribution.
77    
78         The library contains a number of undocumented  internal  functions  and         The  libraries contains a number of undocumented internal functions and
79         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
80         functions, but which are not intended  for  use  by  external  callers.         functions,  but  which  are  not  intended for use by external callers.
81         Their  names  all begin with "_pcre_", which hopefully will not provoke         Their names all begin with "_pcre_" or "_pcre16_", which hopefully will
82         any name clashes. In some environments, it is possible to control which         not  provoke  any name clashes. In some environments, it is possible to
83         external  symbols  are  exported when a shared library is built, and in         control which external symbols are exported when a  shared  library  is
84         these cases the undocumented symbols are not exported.         built, and in these cases the undocumented symbols are not exported.
85    
86    
87  USER DOCUMENTATION  USER DOCUMENTATION
88    
89         The user documentation for PCRE comprises a number  of  different  sec-         The  user  documentation  for PCRE comprises a number of different sec-
90         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
91         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.
92         In  the  plain text format, all the sections are concatenated, for ease         In the plain text format, all the sections, except  the  pcredemo  sec-
93         of searching. The sections are as follows:         tion, are concatenated, for ease of searching. The sections are as fol-
94           lows:
95    
96           pcre              this document           pcre              this document
97             pcre16            details of the 16-bit library
98           pcre-config       show PCRE installation configuration information           pcre-config       show PCRE installation configuration information
99           pcreapi           details of PCRE's native C API           pcreapi           details of PCRE's native C API
100           pcrebuild         options for building PCRE           pcrebuild         options for building PCRE
101           pcrecallout       details of the callout feature           pcrecallout       details of the callout feature
102           pcrecompat        discussion of Perl compatibility           pcrecompat        discussion of Perl compatibility
103           pcrecpp           details of the C++ wrapper           pcrecpp           details of the C++ wrapper for the 8-bit library
104           pcregrep          description of the pcregrep command           pcredemo          a demonstration C program that uses PCRE
105             pcregrep          description of the pcregrep command (8-bit only)
106             pcrejit           discussion of the just-in-time optimization support
107             pcrelimits        details of size and other limits
108           pcrematching      discussion of the two matching algorithms           pcrematching      discussion of the two matching algorithms
109           pcrepartial       details of the partial matching facility           pcrepartial       details of the partial matching facility
110           pcrepattern       syntax and semantics of supported           pcrepattern       syntax and semantics of supported
111                               regular expressions                               regular expressions
          pcresyntax        quick syntax reference  
112           pcreperform       discussion of performance issues           pcreperform       discussion of performance issues
113           pcreposix         the POSIX-compatible C API           pcreposix         the POSIX-compatible C API for the 8-bit library
114           pcreprecompile    details of saving and re-using precompiled patterns           pcreprecompile    details of saving and re-using precompiled patterns
115           pcresample        discussion of the sample program           pcresample        discussion of the pcredemo program
116           pcrestack         discussion of stack usage           pcrestack         discussion of stack usage
117             pcresyntax        quick syntax reference
118           pcretest          description of the pcretest testing command           pcretest          description of the pcretest testing command
119             pcreunicode       discussion of Unicode and UTF-8/16 support
120    
121         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
122         each C library function, listing its arguments and results.         each 8-bit C library function, listing its arguments and results.
123    
124    
125  LIMITATIONS  AUTHOR
126    
127         There are some size limitations in PCRE but it is hoped that they  will         Philip Hazel
128         never in practice be relevant.         University Computing Service
129           Cambridge CB2 3QH, England.
130    
131         The  maximum  length of a compiled pattern is 65539 (sic) bytes if PCRE         Putting  an actual email address here seems to have been a spam magnet,
132         is compiled with the default internal linkage size of 2. If you want to         so I've taken it away. If you want to email me, use  my  two  initials,
133         process  regular  expressions  that are truly enormous, you can compile         followed by the two digits 10, at the domain cam.ac.uk.
        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.  
134    
        All values in repeating quantifiers must be less than 65536.  
135    
136         There is no limit to the number of parenthesized subpatterns, but there  REVISION
        can be no more than 65535 capturing subpatterns.  
137    
138         The maximum length of name for a named subpattern is 32 characters, and         Last updated: 10 January 2012
139         the maximum number of named subpatterns is 10000.         Copyright (c) 1997-2012 University of Cambridge.
140    ------------------------------------------------------------------------------
141    
142    
143    PCRE(3)                                                                PCRE(3)
144    
        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.  
145    
146    NAME
147           PCRE - Perl-compatible regular expressions
148    
149  UTF-8 AND UNICODE PROPERTY SUPPORT         #include <pcre.h>
150    
        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.  
151    
152         If  you compile PCRE with UTF-8 support, but do not use it at run time,  PCRE 16-BIT API BASIC FUNCTIONS
        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.  
153    
154         If PCRE is built with Unicode character property support (which implies         pcre16 *pcre16_compile(PCRE_SPTR16 pattern, int options,
155         UTF-8  support),  the  escape sequences \p{..}, \P{..}, and \X are sup-              const char **errptr, int *erroffset,
156         ported.  The available properties that can be tested are limited to the              const unsigned char *tableptr);
        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.  
157    
158     Validity of UTF-8 strings         pcre16 *pcre16_compile2(PCRE_SPTR16 pattern, int options,
159                int *errorcodeptr,
160                const char **errptr, int *erroffset,
161                const unsigned char *tableptr);
162    
163         When you set the PCRE_UTF8 flag, the strings  passed  as  patterns  and         pcre16_extra *pcre16_study(const pcre16 *code, int options,
164         subjects are (by default) checked for validity on entry to the relevant              const char **errptr);
        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.  
165    
166         If you pass an invalid UTF-8 string  when  PCRE_NO_UTF8_CHECK  is  set,         void pcre16_free_study(pcre16_extra *extra);
        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.  
167    
168         If  you  want  to  process  strings  of  values  in the full range 0 to         int pcre16_exec(const pcre16 *code, const pcre16_extra *extra,
169         0x7FFFFFFF, encoded in a UTF-8-like manner as per the old RFC, you  can              PCRE_SPTR16 subject, int length, int startoffset,
170         set PCRE_NO_UTF8_CHECK to bypass the more restrictive test. However, in              int options, int *ovector, int ovecsize);
        this situation, you will have to apply your own validity check.  
171    
172     General comments about UTF-8 mode         int pcre16_dfa_exec(const pcre16 *code, const pcre16_extra *extra,
173                PCRE_SPTR16 subject, int length, int startoffset,
174                int options, int *ovector, int ovecsize,
175                int *workspace, int wscount);
176    
        1. An unbraced hexadecimal escape sequence (such  as  \xb3)  matches  a  
        two-byte UTF-8 character if the value is greater than 127.  
177    
178         2.  Octal  numbers  up to \777 are recognized, and match two-byte UTF-8  PCRE 16-BIT API STRING EXTRACTION FUNCTIONS
        characters for values greater than \177.  
179    
180         3. Repeat quantifiers apply to complete UTF-8 characters, not to  indi-         int pcre16_copy_named_substring(const pcre16 *code,
181         vidual bytes, for example: \x{100}{3}.              PCRE_SPTR16 subject, int *ovector,
182                int stringcount, PCRE_SPTR16 stringname,
183                PCRE_UCHAR16 *buffer, int buffersize);
184    
185         4.  The dot metacharacter matches one UTF-8 character instead of a sin-         int pcre16_copy_substring(PCRE_SPTR16 subject, int *ovector,
186         gle byte.              int stringcount, int stringnumber, PCRE_UCHAR16 *buffer,
187                int buffersize);
188    
189         5. The escape sequence \C can be used to match a single byte  in  UTF-8         int pcre16_get_named_substring(const pcre16 *code,
190         mode,  but  its  use can lead to some strange effects. This facility is              PCRE_SPTR16 subject, int *ovector,
191         not available in the alternative matching function, pcre_dfa_exec().              int stringcount, PCRE_SPTR16 stringname,
192                PCRE_SPTR16 *stringptr);
193    
194         6. The character escapes \b, \B, \d, \D, \s, \S, \w, and  \W  correctly         int pcre16_get_stringnumber(const pcre16 *code,
195         test  characters of any code value, but the characters that PCRE recog-              PCRE_SPTR16 name);
196         nizes as digits, spaces, or word characters  remain  the  same  set  as  
197         before, all with values less than 256. This remains true even when PCRE         int pcre16_get_stringtable_entries(const pcre16 *code,
198         includes Unicode property support, because to do otherwise  would  slow              PCRE_SPTR16 name, PCRE_UCHAR16 **first, PCRE_UCHAR16 **last);
199         down  PCRE in many common cases. If you really want to test for a wider  
200         sense of, say, "digit", you must use Unicode  property  tests  such  as         int pcre16_get_substring(PCRE_SPTR16 subject, int *ovector,
201         \p{Nd}.              int stringcount, int stringnumber,
202                PCRE_SPTR16 *stringptr);
203         7.  Similarly,  characters that match the POSIX named character classes  
204         are all low-valued characters.         int pcre16_get_substring_list(PCRE_SPTR16 subject,
205                int *ovector, int stringcount, PCRE_SPTR16 **listptr);
206         8. However, the Perl 5.10 horizontal and vertical  whitespace  matching  
207         escapes (\h, \H, \v, and \V) do match all the appropriate Unicode char-         void pcre16_free_substring(PCRE_SPTR16 stringptr);
208         acters.  
209           void pcre16_free_substring_list(PCRE_SPTR16 *stringptr);
210         9. Case-insensitive matching applies only to  characters  whose  values  
211         are  less than 128, unless PCRE is built with Unicode property support.  
212         Even when Unicode property support is available, PCRE  still  uses  its  PCRE 16-BIT API AUXILIARY FUNCTIONS
213         own  character  tables when checking the case of low-valued characters,  
214         so as not to degrade performance.  The Unicode property information  is         pcre16_jit_stack *pcre16_jit_stack_alloc(int startsize, int maxsize);
215         used only for characters with higher values. Even when Unicode property  
216         support is available, PCRE supports case-insensitive matching only when         void pcre16_jit_stack_free(pcre16_jit_stack *stack);
217         there  is  a  one-to-one  mapping between a letter's cases. There are a  
218         small number of many-to-one mappings in Unicode;  these  are  not  sup-         void pcre16_assign_jit_stack(pcre16_extra *extra,
219         ported by PCRE.              pcre16_jit_callback callback, void *data);
220    
221           const unsigned char *pcre16_maketables(void);
222    
223           int pcre16_fullinfo(const pcre16 *code, const pcre16_extra *extra,
224                int what, void *where);
225    
226           int pcre16_refcount(pcre16 *code, int adjust);
227    
228           int pcre16_config(int what, void *where);
229    
230           const char *pcre16_version(void);
231    
232           int pcre16_pattern_to_host_byte_order(pcre16 *code,
233                pcre16_extra *extra, const unsigned char *tables);
234    
235    
236    PCRE 16-BIT API INDIRECTED FUNCTIONS
237    
238           void *(*pcre16_malloc)(size_t);
239    
240           void (*pcre16_free)(void *);
241    
242           void *(*pcre16_stack_malloc)(size_t);
243    
244           void (*pcre16_stack_free)(void *);
245    
246           int (*pcre16_callout)(pcre16_callout_block *);
247    
248    
249    PCRE 16-BIT API 16-BIT-ONLY FUNCTION
250    
251           int pcre16_utf16_to_host_byte_order(PCRE_UCHAR16 *output,
252                PCRE_SPTR16 input, int length, int *byte_order,
253                int keep_boms);
254    
255    
256    THE PCRE 16-BIT LIBRARY
257    
258           Starting  with  release  8.30, it is possible to compile a PCRE library
259           that supports 16-bit character strings, including  UTF-16  strings,  as
260           well  as  or instead of the original 8-bit library. The majority of the
261           work to make  this  possible  was  done  by  Zoltan  Herczeg.  The  two
262           libraries contain identical sets of functions, used in exactly the same
263           way. Only the names of the functions and the data types of their  argu-
264           ments  and results are different. To avoid over-complication and reduce
265           the documentation maintenance load,  most  of  the  PCRE  documentation
266           describes  the  8-bit  library,  with only occasional references to the
267           16-bit library. This page describes what is different when you use  the
268           16-bit library.
269    
270           WARNING:  A  single  application can be linked with both libraries, but
271           you must take care when processing any particular pattern to use  func-
272           tions  from  just one library. For example, if you want to study a pat-
273           tern that was compiled with  pcre16_compile(),  you  must  do  so  with
274           pcre16_study(), not pcre_study(), and you must free the study data with
275           pcre16_free_study().
276    
277    
278    THE HEADER FILE
279    
280           There is only one header file, pcre.h. It contains prototypes  for  all
281           the  functions  in  both  libraries,  as  well as definitions of flags,
282           structures, error codes, etc.
283    
284    
285    THE LIBRARY NAME
286    
287           In Unix-like systems, the 16-bit library is called libpcre16,  and  can
288           normally  be  accesss  by adding -lpcre16 to the command for linking an
289           application that uses PCRE.
290    
291    
292    STRING TYPES
293    
294           In the 8-bit library, strings are passed to PCRE library  functions  as
295           vectors  of  bytes  with  the  C  type "char *". In the 16-bit library,
296           strings are passed as vectors of unsigned 16-bit quantities. The  macro
297           PCRE_UCHAR16  specifies  an  appropriate  data type, and PCRE_SPTR16 is
298           defined as "const PCRE_UCHAR16 *". In very  many  environments,  "short
299           int" is a 16-bit data type. When PCRE is built, it defines PCRE_UCHAR16
300           as "short int", but checks that it really is a 16-bit data type. If  it
301           is not, the build fails with an error message telling the maintainer to
302           modify the definition appropriately.
303    
304    
305    STRUCTURE TYPES
306    
307           The types of the opaque structures that are used  for  compiled  16-bit
308           patterns  and  JIT stacks are pcre16 and pcre16_jit_stack respectively.
309           The  type  of  the  user-accessible  structure  that  is  returned   by
310           pcre16_study()  is  pcre16_extra, and the type of the structure that is
311           used for passing data to a callout  function  is  pcre16_callout_block.
312           These structures contain the same fields, with the same names, as their
313           8-bit counterparts. The only difference is that pointers  to  character
314           strings are 16-bit instead of 8-bit types.
315    
316    
317    16-BIT FUNCTIONS
318    
319           For  every function in the 8-bit library there is a corresponding func-
320           tion in the 16-bit library with a name that starts with pcre16_ instead
321           of  pcre_.  The  prototypes are listed above. In addition, there is one
322           extra function, pcre16_utf16_to_host_byte_order(). This  is  a  utility
323           function  that converts a UTF-16 character string to host byte order if
324           necessary. The other 16-bit  functions  expect  the  strings  they  are
325           passed to be in host byte order.
326    
327           The input and output arguments of pcre16_utf16_to_host_byte_order() may
328           point to the same address, that is, conversion in place  is  supported.
329           The output buffer must be at least as long as the input.
330    
331           The  length  argument  specifies the number of 16-bit data units in the
332           input string; a negative value specifies a zero-terminated string.
333    
334           If byte_order is NULL, it is assumed that the string starts off in host
335           byte  order. This may be changed by byte-order marks (BOMs) anywhere in
336           the string (commonly as the first character).
337    
338           If byte_order is not NULL, a non-zero value of the integer to which  it
339           points  means  that  the input starts off in host byte order, otherwise
340           the opposite order is assumed. Again, BOMs in  the  string  can  change
341           this. The final byte order is passed back at the end of processing.
342    
343           If  keep_boms  is  not  zero,  byte-order  mark characters (0xfeff) are
344           copied into the output string. Otherwise they are discarded.
345    
346           The result of the function is the number of 16-bit  units  placed  into
347           the  output  buffer,  including  the  zero terminator if the string was
348           zero-terminated.
349    
350    
351    SUBJECT STRING OFFSETS
352    
353           The offsets within subject strings that are returned  by  the  matching
354           functions are in 16-bit units rather than bytes.
355    
356    
357    NAMED SUBPATTERNS
358    
359           The  name-to-number translation table that is maintained for named sub-
360           patterns uses 16-bit characters.  The  pcre16_get_stringtable_entries()
361           function returns the length of each entry in the table as the number of
362           16-bit data units.
363    
364    
365    OPTION NAMES
366    
367           There   are   two   new   general   option   names,   PCRE_UTF16    and
368           PCRE_NO_UTF16_CHECK,     which     correspond    to    PCRE_UTF8    and
369           PCRE_NO_UTF8_CHECK in the 8-bit library. In  fact,  these  new  options
370           define the same bits in the options word.
371    
372           For  the  pcre16_config() function there is an option PCRE_CONFIG_UTF16
373           that returns 1 if UTF-16 support is configured, otherwise  0.  If  this
374           option  is given to pcre_config(), or if the PCRE_CONFIG_UTF8 option is
375           given to pcre16_config(), the result is the PCRE_ERROR_BADOPTION error.
376    
377    
378    CHARACTER CODES
379    
380           In 16-bit mode, when  PCRE_UTF16  is  not  set,  character  values  are
381           treated in the same way as in 8-bit, non UTF-8 mode, except, of course,
382           that they can range from 0 to 0xffff instead of 0  to  0xff.  Character
383           types  for characters less than 0xff can therefore be influenced by the
384           locale in the same way as before.  Characters greater  than  0xff  have
385           only one case, and no "type" (such as letter or digit).
386    
387           In  UTF-16  mode,  the  character  code  is  Unicode, in the range 0 to
388           0x10ffff, with the exception of values in the range  0xd800  to  0xdfff
389           because  those  are "surrogate" values that are used in pairs to encode
390           values greater than 0xffff.
391    
392           A UTF-16 string can indicate its endianness by special code knows as  a
393           byte-order mark (BOM). The PCRE functions do not handle this, expecting
394           strings  to  be  in  host  byte  order.  A  utility   function   called
395           pcre16_utf16_to_host_byte_order()  is  provided  to help with this (see
396           above).
397    
398    
399    ERROR NAMES
400    
401           The errors PCRE_ERROR_BADUTF16_OFFSET and PCRE_ERROR_SHORTUTF16  corre-
402           spond  to  their  8-bit  counterparts.  The error PCRE_ERROR_BADMODE is
403           given when a compiled pattern is passed to a  function  that  processes
404           patterns  in  the  other  mode, for example, if a pattern compiled with
405           pcre_compile() is passed to pcre16_exec().
406    
407           There are new error codes whose names  begin  with  PCRE_UTF16_ERR  for
408           invalid  UTF-16  strings,  corresponding to the PCRE_UTF8_ERR codes for
409           UTF-8 strings that are described in the section entitled "Reason  codes
410           for  invalid UTF-8 strings" in the main pcreapi page. The UTF-16 errors
411           are:
412    
413             PCRE_UTF16_ERR1  Missing low surrogate at end of string
414             PCRE_UTF16_ERR2  Invalid low surrogate follows high surrogate
415             PCRE_UTF16_ERR3  Isolated low surrogate
416             PCRE_UTF16_ERR4  Invalid character 0xfffe
417    
418    
419    ERROR TEXTS
420    
421           If there is an error while compiling a pattern, the error text that  is
422           passed  back by pcre16_compile() or pcre16_compile2() is still an 8-bit
423           character string, zero-terminated.
424    
425    
426    CALLOUTS
427    
428           The subject and mark fields in the callout block that is  passed  to  a
429           callout function point to 16-bit vectors.
430    
431    
432    TESTING
433    
434           The  pcretest  program continues to operate with 8-bit input and output
435           files, but it can be used for testing the 16-bit library. If it is  run
436           with the command line option -16, patterns and subject strings are con-
437           verted from 8-bit to 16-bit before being passed to PCRE, and the 16-bit
438           library  functions  are used instead of the 8-bit ones. Returned 16-bit
439           strings are converted to 8-bit for output. If the 8-bit library was not
440           compiled, pcretest defaults to 16-bit and the -16 option is ignored.
441    
442           When  PCRE  is  being built, the RunTest script that is called by "make
443           check" uses the pcretest -C option to discover which of the  8-bit  and
444           16-bit libraries has been built, and runs the tests appropriately.
445    
446    
447    NOT SUPPORTED IN 16-BIT MODE
448    
449           Not all the features of the 8-bit library are available with the 16-bit
450           library. The C++ and POSIX wrapper functions  support  only  the  8-bit
451           library, and the pcregrep program is at present 8-bit only.
452    
453    
454  AUTHOR  AUTHOR
# Line 251  AUTHOR Line 457  AUTHOR
457         University Computing Service         University Computing Service
458         Cambridge CB2 3QH, England.         Cambridge CB2 3QH, England.
459    
        Putting  an actual email address here seems to have been a spam magnet,  
        so I've taken it away. If you want to email me, use  my  two  initials,  
        followed by the two digits 10, at the domain cam.ac.uk.  
   
460    
461  REVISION  REVISION
462    
463         Last updated: 12 April 2008         Last updated: 08 January 2012
464         Copyright (c) 1997-2008 University of Cambridge.         Copyright (c) 1997-2012 University of Cambridge.
465  ------------------------------------------------------------------------------  ------------------------------------------------------------------------------
466    
467    
468  PCREBUILD(3)                                                      PCREBUILD(3)  PCREBUILD(3)                                                      PCREBUILD(3)
469    
470    
# Line 277  PCRE BUILD-TIME OPTIONS Line 479  PCRE BUILD-TIME OPTIONS
479         script,  where the optional features are selected or deselected by pro-         script,  where the optional features are selected or deselected by pro-
480         viding options to configure before running the make  command.  However,         viding options to configure before running the make  command.  However,
481         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
482         environments using the GUI facility of  CMakeSetup  if  you  are  using         environments using the GUI facility of cmake-gui if you are using CMake
483         CMake instead of configure to build PCRE.         instead of configure to build PCRE.
484    
485           There  is  a  lot more information about building PCRE in non-Unix-like
486           environments in the file called NON_UNIX_USE, which is part of the PCRE
487           distribution.  You  should consult this file as well as the README file
488           if you are building in a non-Unix-like environment.
489    
490         The complete list of options for configure (which includes the standard         The complete list of options for configure (which includes the standard
491         ones such as the  selection  of  the  installation  directory)  can  be         ones  such  as  the  selection  of  the  installation directory) can be
492         obtained by running         obtained by running
493    
494           ./configure --help           ./configure --help
495    
496         The  following  sections  include  descriptions  of options whose names         The following sections include  descriptions  of  options  whose  names
497         begin with --enable or --disable. These settings specify changes to the         begin with --enable or --disable. These settings specify changes to the
498         defaults  for  the configure command. Because of the way that configure         defaults for the configure command. Because of the way  that  configure
499         works, --enable and --disable always come in pairs, so  the  complemen-         works,  --enable  and --disable always come in pairs, so the complemen-
500         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
501         is not described.         is not described.
502    
503    
504    BUILDING 8-BIT and 16-BIT LIBRARIES
505    
506           By  default,  a  library  called libpcre is built, containing functions
507           that take string arguments contained in vectors  of  bytes,  either  as
508           single-byte  characters,  or interpreted as UTF-8 strings. You can also
509           build a separate library, called libpcre16, in which strings  are  con-
510           tained  in  vectors of 16-bit data units and interpreted either as sin-
511           gle-unit characters or UTF-16 strings, by adding
512    
513             --enable-pcre16
514    
515           to the configure command. If you do not want the 8-bit library, add
516    
517             --disable-pcre8
518    
519           as well. At least one of the two libraries must be built. Note that the
520           C++  and  POSIX wrappers are for the 8-bit library only, and that pcre-
521           grep is an 8-bit program. None of these are built if  you  select  only
522           the 16-bit library.
523    
524    
525    BUILDING SHARED AND STATIC LIBRARIES
526    
527           The  PCRE building process uses libtool to build both shared and static
528           Unix libraries by default. You can suppress one of these by adding  one
529           of
530    
531             --disable-shared
532             --disable-static
533    
534           to the configure command, as required.
535    
536    
537  C++ SUPPORT  C++ SUPPORT
538    
539         By default, the configure script will search for a C++ compiler and C++         By  default,  if the 8-bit library is being built, the configure script
540         header files. If it finds them, it automatically builds the C++ wrapper         will search for a C++ compiler and C++ header files. If it finds  them,
541         library for PCRE. You can disable this by adding         it  automatically  builds  the C++ wrapper library (which supports only
542           8-bit strings). You can disable this by adding
543    
544           --disable-cpp           --disable-cpp
545    
546         to the configure command.         to the configure command.
547    
548    
549  UTF-8 SUPPORT  UTF-8 and UTF-16 SUPPORT
550    
551         To build PCRE with support for UTF-8 character strings, add         To build PCRE with support for UTF Unicode character strings, add
552    
553           --enable-utf8           --enable-utf
554    
555         to the configure command. Of itself, this  does  not  make  PCRE  treat         to the configure command.  This  setting  applies  to  both  libraries,
556         strings  as UTF-8. As well as compiling PCRE with this option, you also         adding support for UTF-8 to the 8-bit library and support for UTF-16 to
557         have have to set the PCRE_UTF8 option when you call the  pcre_compile()         the 16-bit library. It is not possible to build one  library  with  UTF
558         function.         support and the other without in the same configuration. (For backwards
559           compatibility, --enable-utf8 is a synonym of --enable-utf.)
560    
561           Of itself, this setting does not make PCRE treat strings  as  UTF-8  or
562           UTF-16.  As well as compiling PCRE with this option, you also have have
563           to set the PCRE_UTF8 or PCRE_UTF16 option when you call one of the pat-
564           tern compiling functions.
565    
566           If  you  set --enable-utf when compiling in an EBCDIC environment, PCRE
567           expects its input to be either ASCII or UTF-8 (depending on the runtime
568           option).  It  is not possible to support both EBCDIC and UTF-8 codes in
569           the  same  version  of  the  library.  Consequently,  --enable-utf  and
570           --enable-ebcdic are mutually exclusive.
571    
572    
573  UNICODE CHARACTER PROPERTY SUPPORT  UNICODE CHARACTER PROPERTY SUPPORT
574    
575         UTF-8  support allows PCRE to process character values greater than 255         UTF  support allows the libraries to process character codepoints up to
576         in the strings that it handles. On its own, however, it does  not  pro-         0x10ffff in the strings that they handle. On its own, however, it  does
577         vide any facilities for accessing the properties of such characters. If         not provide any facilities for accessing the properties of such charac-
578         you want to be able to use the pattern escapes \P, \p,  and  \X,  which         ters. If you want to be able to use the pattern escapes \P, \p, and \X,
579         refer to Unicode character properties, you must add         which refer to Unicode character properties, you must add
580    
581           --enable-unicode-properties           --enable-unicode-properties
582    
583         to  the configure command. This implies UTF-8 support, even if you have         to  the  configure  command. This implies UTF support, even if you have
584         not explicitly requested it.         not explicitly requested it.
585    
586         Including Unicode property support adds around 30K  of  tables  to  the         Including Unicode property support adds around 30K  of  tables  to  the
# Line 335  UNICODE CHARACTER PROPERTY SUPPORT Line 588  UNICODE CHARACTER PROPERTY SUPPORT
588         are supported. Details are given in the pcrepattern documentation.         are supported. Details are given in the pcrepattern documentation.
589    
590    
591    JUST-IN-TIME COMPILER SUPPORT
592    
593           Just-in-time compiler support is included in the build by specifying
594    
595             --enable-jit
596    
597           This support is available only for certain hardware  architectures.  If
598           this  option  is  set  for  an unsupported architecture, a compile time
599           error occurs.  See the pcrejit documentation for a  discussion  of  JIT
600           usage. When JIT support is enabled, pcregrep automatically makes use of
601           it, unless you add
602    
603             --disable-pcregrep-jit
604    
605           to the "configure" command.
606    
607    
608  CODE VALUE OF NEWLINE  CODE VALUE OF NEWLINE
609    
610         By default, PCRE interprets character 10 (linefeed, LF)  as  indicating         By default, PCRE interprets the linefeed (LF) character  as  indicating
611         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
612         systems. You can compile PCRE to use character 13 (carriage return, CR)         systems. You can compile PCRE to use carriage return (CR)  instead,  by
613         instead, by adding         adding
614    
615           --enable-newline-is-cr           --enable-newline-is-cr
616    
# Line 363  CODE VALUE OF NEWLINE Line 633  CODE VALUE OF NEWLINE
633    
634         causes PCRE to recognize any Unicode newline sequence.         causes PCRE to recognize any Unicode newline sequence.
635    
636         Whatever  line  ending convention is selected when PCRE is built can be         Whatever line ending convention is selected when PCRE is built  can  be
637         overridden when the library functions are called. At build time  it  is         overridden  when  the library functions are called. At build time it is
638         conventional to use the standard for your operating system.         conventional to use the standard for your operating system.
639    
640    
641  WHAT \R MATCHES  WHAT \R MATCHES
642    
643         By  default,  the  sequence \R in a pattern matches any Unicode newline         By default, the sequence \R in a pattern matches  any  Unicode  newline
644         sequence, whatever has been selected as the line  ending  sequence.  If         sequence,  whatever  has  been selected as the line ending sequence. If
645         you specify         you specify
646    
647           --enable-bsr-anycrlf           --enable-bsr-anycrlf
648    
649         the  default  is changed so that \R matches only CR, LF, or CRLF. What-         the default is changed so that \R matches only CR, LF, or  CRLF.  What-
650         ever is selected when PCRE is built can be overridden when the  library         ever  is selected when PCRE is built can be overridden when the library
651         functions are called.         functions are called.
652    
653    
 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.  
   
   
654  POSIX MALLOC USAGE  POSIX MALLOC USAGE
655    
656         When PCRE is called through the POSIX interface (see the pcreposix doc-         When the 8-bit library is called through the POSIX interface  (see  the
657         umentation), additional working storage is  required  for  holding  the         pcreposix  documentation),  additional  working storage is required for
658         pointers  to capturing substrings, because PCRE requires three integers         holding the pointers to capturing  substrings,  because  PCRE  requires
659         per substring, whereas the POSIX interface provides only  two.  If  the         three integers per substring, whereas the POSIX interface provides only
660         number of expected substrings is small, the wrapper function uses space         two. If the number of expected substrings is small, the  wrapper  func-
661         on the stack, because this is faster than using malloc() for each call.         tion  uses  space  on the stack, because this is faster than using mal-
662         The default threshold above which the stack is no longer used is 10; it         loc() for each call. The default threshold above which the stack is  no
663         can be changed by adding a setting such as         longer used is 10; it can be changed by adding a setting such as
664    
665           --with-posix-malloc-threshold=20           --with-posix-malloc-threshold=20
666    
# Line 411  POSIX MALLOC USAGE Line 669  POSIX MALLOC USAGE
669    
670  HANDLING VERY LARGE PATTERNS  HANDLING VERY LARGE PATTERNS
671    
672         Within a compiled pattern, offset values are used  to  point  from  one         Within  a  compiled  pattern,  offset values are used to point from one
673         part  to another (for example, from an opening parenthesis to an alter-         part to another (for example, from an opening parenthesis to an  alter-
674         nation metacharacter). By default, two-byte values are used  for  these         nation  metacharacter).  By default, two-byte values are used for these
675         offsets,  leading  to  a  maximum size for a compiled pattern of around         offsets, leading to a maximum size for a  compiled  pattern  of  around
676         64K. This is sufficient to handle all but the most  gigantic  patterns.         64K.  This  is sufficient to handle all but the most gigantic patterns.
677         Nevertheless,  some  people do want to process enormous patterns, so it         Nevertheless, some people do want to process truly  enormous  patterns,
678         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-
679         adding a setting such as         sets by adding a setting such as
680    
681           --with-link-size=3           --with-link-size=3
682    
683         to  the  configure  command.  The value given must be 2, 3, or 4. Using         to the configure command. The value given must be 2, 3, or 4.  For  the
684         longer offsets slows down the operation of PCRE because it has to  load         16-bit  library,  a value of 3 is rounded up to 4. Using longer offsets
685         additional bytes when handling them.         slows down the operation of PCRE because it has to load additional data
686           when handling them.
687    
688    
689  AVOIDING EXCESSIVE STACK USAGE  AVOIDING EXCESSIVE STACK USAGE
# Line 445  AVOIDING EXCESSIVE STACK USAGE Line 704  AVOIDING EXCESSIVE STACK USAGE
704         to the configure command. With this configuration, PCRE  will  use  the         to the configure command. With this configuration, PCRE  will  use  the
705         pcre_stack_malloc  and pcre_stack_free variables to call memory manage-         pcre_stack_malloc  and pcre_stack_free variables to call memory manage-
706         ment functions. By default these point to malloc() and free(), but  you         ment functions. By default these point to malloc() and free(), but  you
707         can replace the pointers so that your own functions are used.         can replace the pointers so that your own functions are used instead.
708    
709         Separate  functions  are  provided  rather  than  using pcre_malloc and         Separate  functions  are  provided  rather  than  using pcre_malloc and
710         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 712  AVOIDING EXCESSIVE STACK USAGE
712         reverse order. A calling program might be able to  implement  optimized         reverse order. A calling program might be able to  implement  optimized
713         functions  that  perform  better  than  malloc()  and free(). PCRE runs         functions  that  perform  better  than  malloc()  and free(). PCRE runs
714         noticeably more slowly when built in this way. This option affects only         noticeably more slowly when built in this way. This option affects only
715         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.  
716    
717    
718  LIMITING PCRE RESOURCE USAGE  LIMITING PCRE RESOURCE USAGE
719    
720         Internally, PCRE has a function called match(), which it calls  repeat-         Internally,  PCRE has a function called match(), which it calls repeat-
721         edly   (sometimes   recursively)  when  matching  a  pattern  with  the         edly  (sometimes  recursively)  when  matching  a  pattern   with   the
722         pcre_exec() function. By controlling the maximum number of  times  this         pcre_exec()  function.  By controlling the maximum number of times this
723         function  may be called during a single matching operation, a limit can         function may be called during a single matching operation, a limit  can
724         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
725         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-
726         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
727         setting such as         setting such as
728    
729           --with-match-limit=500000           --with-match-limit=500000
730    
731         to   the   configure  command.  This  setting  has  no  effect  on  the         to  the  configure  command.  This  setting  has  no  effect   on   the
732         pcre_dfa_exec() matching function.         pcre_dfa_exec() matching function.
733    
734         In some environments it is desirable to limit the  depth  of  recursive         In  some  environments  it is desirable to limit the depth of recursive
735         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
736         to restrict the maximum amount of stack (or heap,  if  --disable-stack-         to  restrict  the maximum amount of stack (or heap, if --disable-stack-
737         for-recursion is specified) that is used. A second limit controls this;         for-recursion is specified) that is used. A second limit controls this;
738         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
739         imposes  no  additional constraints. However, you can set a lower limit         imposes no additional constraints. However, you can set a  lower  limit
740         by adding, for example,         by adding, for example,
741    
742           --with-match-limit-recursion=10000           --with-match-limit-recursion=10000
743    
744         to the configure command. This value can  also  be  overridden  at  run         to  the  configure  command.  This  value can also be overridden at run
745         time.         time.
746    
747    
748  CREATING CHARACTER TABLES AT BUILD TIME  CREATING CHARACTER TABLES AT BUILD TIME
749    
750         PCRE  uses fixed tables for processing characters whose code values are         PCRE uses fixed tables for processing characters whose code values  are
751         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
752         distributed  in  the  file pcre_chartables.c.dist. These tables are for         distributed in the file pcre_chartables.c.dist. These  tables  are  for
753         ASCII codes only. If you add         ASCII codes only. If you add
754    
755           --enable-rebuild-chartables           --enable-rebuild-chartables
756    
757         to the configure command, the distributed tables are  no  longer  used.         to  the  configure  command, the distributed tables are no longer used.
758         Instead,  a  program  called dftables is compiled and run. This outputs         Instead, a program called dftables is compiled and  run.  This  outputs
759         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
760         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
761         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
762         you  need  to  create alternative tables when cross compiling, you will         you need to create alternative tables when cross  compiling,  you  will
763         have to do so "by hand".)         have to do so "by hand".)
764    
765    
766  USING EBCDIC CODE  USING EBCDIC CODE
767    
768         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
769         character  code  is  ASCII  (or Unicode, which is a superset of ASCII).         character code is ASCII (or Unicode, which is  a  superset  of  ASCII).
770         This is the case for most computer operating systems.  PCRE  can,  how-         This  is  the  case for most computer operating systems. PCRE can, how-
771         ever, be compiled to run in an EBCDIC environment by adding         ever, be compiled to run in an EBCDIC environment by adding
772    
773           --enable-ebcdic           --enable-ebcdic
774    
775         to the configure command. This setting implies --enable-rebuild-charta-         to the configure command. This setting implies --enable-rebuild-charta-
776         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
777         environment (for example, an IBM mainframe operating system).         environment (for example,  an  IBM  mainframe  operating  system).  The
778           --enable-ebcdic option is incompatible with --enable-utf.
779    
780    
781  PCREGREP OPTIONS FOR COMPRESSED FILE SUPPORT  PCREGREP OPTIONS FOR COMPRESSED FILE SUPPORT
# Line 533  PCREGREP OPTIONS FOR COMPRESSED FILE SUP Line 792  PCREGREP OPTIONS FOR COMPRESSED FILE SUP
792         if they are not.         if they are not.
793    
794    
795    PCREGREP BUFFER SIZE
796    
797           pcregrep  uses  an internal buffer to hold a "window" on the file it is
798           scanning, in order to be able to output "before" and "after" lines when
799           it  finds  a match. The size of the buffer is controlled by a parameter
800           whose default value is 20K. The buffer itself is three times this size,
801           but because of the way it is used for holding "before" lines, the long-
802           est line that is guaranteed to be processable is  the  parameter  size.
803           You can change the default parameter value by adding, for example,
804    
805             --with-pcregrep-bufsize=50K
806    
807           to the configure command. The caller of pcregrep can, however, override
808           this value by specifying a run-time option.
809    
810    
811  PCRETEST OPTION FOR LIBREADLINE SUPPORT  PCRETEST OPTION FOR LIBREADLINE SUPPORT
812    
813         If you add         If you add
814    
815           --enable-pcretest-libreadline           --enable-pcretest-libreadline
816    
817         to  the  configure  command,  pcretest  is  linked with the libreadline         to the configure command,  pcretest  is  linked  with  the  libreadline
818         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
819         readline() function. This provides line-editing and history facilities.         readline() function. This provides line-editing and history facilities.
820         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
821         pcretest linked in this way, there may be licensing issues.         pcretest linked in this way, there may be licensing issues.
822    
823         Setting  this  option  causes  the -lreadline option to be added to the         Setting this option causes the -lreadline option to  be  added  to  the
824         pcretest build. In many operating environments with  a  sytem-installed         pcretest  build.  In many operating environments with a sytem-installed
825         libreadline this is sufficient. However, in some environments (e.g.  if         libreadline this is sufficient. However, in some environments (e.g.  if
826         an unmodified distribution version of readline is in use),  some  extra         an  unmodified  distribution version of readline is in use), some extra
827         configuration  may  be necessary. The INSTALL file for libreadline says         configuration may be necessary. The INSTALL file for  libreadline  says
828         this:         this:
829    
830           "Readline uses the termcap functions, but does not link with the           "Readline uses the termcap functions, but does not link with the
831           termcap or curses library itself, allowing applications which link           termcap or curses library itself, allowing applications which link
832           with readline the to choose an appropriate library."           with readline the to choose an appropriate library."
833    
834         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
835         is automatically included, you may need to add something like         is automatically included, you may need to add something like
836    
837           LIBS="-ncurses"           LIBS="-ncurses"
# Line 566  PCRETEST OPTION FOR LIBREADLINE SUPPORT Line 841  PCRETEST OPTION FOR LIBREADLINE SUPPORT
841    
842  SEE ALSO  SEE ALSO
843    
844         pcreapi(3), pcre_config(3).         pcreapi(3), pcre16, pcre_config(3).
845    
846    
847  AUTHOR  AUTHOR
# Line 578  AUTHOR Line 853  AUTHOR
853    
854  REVISION  REVISION
855    
856         Last updated: 13 April 2008         Last updated: 07 January 2012
857         Copyright (c) 1997-2008 University of Cambridge.         Copyright (c) 1997-2012 University of Cambridge.
858  ------------------------------------------------------------------------------  ------------------------------------------------------------------------------
859    
860    
861  PCREMATCHING(3)                                                PCREMATCHING(3)  PCREMATCHING(3)                                                PCREMATCHING(3)
862    
863    
# Line 595  PCRE MATCHING ALGORITHMS Line 870  PCRE MATCHING ALGORITHMS
870         This document describes the two different algorithms that are available         This document describes the two different algorithms that are available
871         in PCRE for matching a compiled regular expression against a given sub-         in PCRE for matching a compiled regular expression against a given sub-
872         ject  string.  The  "standard"  algorithm  is  the  one provided by the         ject  string.  The  "standard"  algorithm  is  the  one provided by the
873         pcre_exec() function.  This works in the same was  as  Perl's  matching         pcre_exec() and pcre16_exec() functions. These work in the same was  as
874         function, and provides a Perl-compatible matching operation.         Perl's matching function, and provide a Perl-compatible matching opera-
875           tion. The just-in-time (JIT) optimization  that  is  described  in  the
876         An  alternative  algorithm is provided by the pcre_dfa_exec() function;         pcrejit documentation is compatible with these functions.
877         this operates in a different way, and is not  Perl-compatible.  It  has  
878         advantages  and disadvantages compared with the standard algorithm, and         An  alternative  algorithm  is  provided  by  the  pcre_dfa_exec()  and
879         these are described below.         pcre16_dfa_exec() functions; they operate in a different way,  and  are
880           not  Perl-compatible. This alternative has advantages and disadvantages
881           compared with the standard algorithm, and these are described below.
882    
883         When there is only one possible way in which a given subject string can         When there is only one possible way in which a given subject string can
884         match  a pattern, the two algorithms give the same answer. A difference         match  a pattern, the two algorithms give the same answer. A difference
# Line 666  THE ALTERNATIVE MATCHING ALGORITHM Line 943  THE ALTERNATIVE MATCHING ALGORITHM
943         though  it is not implemented as a traditional finite state machine (it         though  it is not implemented as a traditional finite state machine (it
944         keeps multiple states active simultaneously).         keeps multiple states active simultaneously).
945    
946           Although the general principle of this matching algorithm  is  that  it
947           scans  the subject string only once, without backtracking, there is one
948           exception: when a lookaround assertion is encountered,  the  characters
949           following  or  preceding  the  current  point  have to be independently
950           inspected.
951    
952         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
953         there  are  no more unterminated paths. At this point, terminated paths         there  are  no more unterminated paths. At this point, terminated paths
954         represent the different matching possibilities (if there are none,  the         represent the different matching possibilities (if there are none,  the
955         match  has  failed).   Thus,  if there is more than one possible match,         match  has  failed).   Thus,  if there is more than one possible match,
956         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-
957         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
958         match (which is necessarily the shortest) has been found.         an option to stop the algorithm after the first match (which is  neces-
959           sarily the shortest) is found.
960    
961         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
962         subject. If the pattern         subject. If the pattern
963    
964           cat(er(pillar)?)           cat(er(pillar)?)?
965    
966         is  matched  against the string "the caterpillar catchment", the result         is matched against the string "the caterpillar catchment",  the  result
967         will be the three strings "cat", "cater", and "caterpillar" that  start         will  be the three strings "caterpillar", "cater", and "cat" that start
968         at the fourth character of the subject. The algorithm does not automat-         at the fifth character of the subject. The algorithm does not automati-
969         ically move on to find matches that start at later positions.         cally move on to find matches that start at later positions.
970    
971         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
972         supported by the alternative matching algorithm. They are as follows:         supported by the alternative matching algorithm. They are as follows:
973    
974         1.  Because  the  algorithm  finds  all possible matches, the greedy or         1. Because the algorithm finds all  possible  matches,  the  greedy  or
975         ungreedy nature of repetition quantifiers is not relevant.  Greedy  and         ungreedy  nature  of repetition quantifiers is not relevant. Greedy and
976         ungreedy quantifiers are treated in exactly the same way. However, pos-         ungreedy quantifiers are treated in exactly the same way. However, pos-
977         sessive quantifiers can make a difference when what follows could  also         sessive  quantifiers can make a difference when what follows could also
978         match what is quantified, for example in a pattern like this:         match what is quantified, for example in a pattern like this:
979    
980           ^a++\w!           ^a++\w!
981    
982         This  pattern matches "aaab!" but not "aaa!", which would be matched by         This pattern matches "aaab!" but not "aaa!", which would be matched  by
983         a non-possessive quantifier. Similarly, if an atomic group is  present,         a  non-possessive quantifier. Similarly, if an atomic group is present,
984         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,
985         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
986         pattern.         pattern.
987    
988         2. When dealing with multiple paths through the tree simultaneously, it         2. When dealing with multiple paths through the tree simultaneously, it
989         is not straightforward to keep track of  captured  substrings  for  the         is  not  straightforward  to  keep track of captured substrings for the
990         different  matching  possibilities,  and  PCRE's implementation of this         different matching possibilities, and  PCRE's  implementation  of  this
991         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-
992         strings are available.         strings are available.
993    
994         3.  Because no substrings are captured, back references within the pat-         3. Because no substrings are captured, back references within the  pat-
995         tern are not supported, and cause errors if encountered.         tern are not supported, and cause errors if encountered.
996    
997         4. For the same reason, conditional expressions that use  a  backrefer-         4.  For  the same reason, conditional expressions that use a backrefer-
998         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
999         supported.         supported.
1000    
1001         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
1002         sequence, which resets the start of the match when encountered (but may         sequence, which resets the start of the match when encountered (but may
1003         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
1004         error if encountered.         error if encountered.
1005    
1006         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
1007         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.
1008    
1009         7. The \C escape sequence, which (in the standard algorithm) matches  a         7.  The  \C  escape  sequence, which (in the standard algorithm) always
1010         single  byte, even in UTF-8 mode, is not supported because the alterna-         matches a single data unit, even in UTF-8 or UTF-16 modes, is not  sup-
1011         tive algorithm moves through the subject  string  one  character  at  a         ported  in these modes, because the alternative algorithm moves through
1012         time, for all active paths through the tree.         the subject string one character (not data unit) at  a  time,  for  all
1013           active paths through the tree.
1014    
1015         8.  Except for (*FAIL), the backtracking control verbs such as (*PRUNE)         8.  Except for (*FAIL), the backtracking control verbs such as (*PRUNE)
1016         are not supported. (*FAIL) is supported, and  behaves  like  a  failing         are not supported. (*FAIL) is supported, and  behaves  like  a  failing
# Line 742  ADVANTAGES OF THE ALTERNATIVE ALGORITHM Line 1027  ADVANTAGES OF THE ALTERNATIVE ALGORITHM
1027         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
1028         things with callouts.         things with callouts.
1029    
1030         2.  There is much better support for partial matching. The restrictions         2.  Because  the  alternative  algorithm  scans the subject string just
1031         on the content of the pattern that apply when using the standard  algo-         once, and never needs to backtrack (except for lookbehinds), it is pos-
1032         rithm  for  partial matching do not apply to the alternative algorithm.         sible  to  pass  very  long subject strings to the matching function in
1033         For non-anchored patterns, the starting position of a partial match  is         several pieces, checking for partial matching each time. Although it is
1034         available.         possible  to  do multi-segment matching using the standard algorithm by
1035           retaining partially matched substrings, it  is  more  complicated.  The
1036         3.  Because  the  alternative  algorithm  scans the subject string just         pcrepartial  documentation  gives  details of partial matching and dis-
1037         once, and never needs to backtrack, it is possible to  pass  very  long         cusses multi-segment matching.
        subject  strings  to  the matching function in several pieces, checking  
        for partial matching each time.  
1038    
1039    
1040  DISADVANTAGES OF THE ALTERNATIVE ALGORITHM  DISADVANTAGES OF THE ALTERNATIVE ALGORITHM
# Line 777  AUTHOR Line 1060  AUTHOR
1060    
1061  REVISION  REVISION
1062    
1063         Last updated: 19 April 2008         Last updated: 08 January 2012
1064         Copyright (c) 1997-2008 University of Cambridge.         Copyright (c) 1997-2012 University of Cambridge.
1065  ------------------------------------------------------------------------------  ------------------------------------------------------------------------------
1066    
1067    
1068  PCREAPI(3)                                                          PCREAPI(3)  PCREAPI(3)                                                          PCREAPI(3)
1069    
1070    
1071  NAME  NAME
1072         PCRE - Perl-compatible regular expressions         PCRE - Perl-compatible regular expressions
1073    
1074           #include <pcre.h>
1075    
 PCRE NATIVE API  
1076    
1077         #include <pcre.h>  PCRE NATIVE API BASIC FUNCTIONS
1078    
1079         pcre *pcre_compile(const char *pattern, int options,         pcre *pcre_compile(const char *pattern, int options,
1080              const char **errptr, int *erroffset,              const char **errptr, int *erroffset,
# Line 805  PCRE NATIVE API Line 1088  PCRE NATIVE API
1088         pcre_extra *pcre_study(const pcre *code, int options,         pcre_extra *pcre_study(const pcre *code, int options,
1089              const char **errptr);              const char **errptr);
1090    
1091           void pcre_free_study(pcre_extra *extra);
1092    
1093         int pcre_exec(const pcre *code, const pcre_extra *extra,         int pcre_exec(const pcre *code, const pcre_extra *extra,
1094              const char *subject, int length, int startoffset,              const char *subject, int length, int startoffset,
1095              int options, int *ovector, int ovecsize);              int options, int *ovector, int ovecsize);
# Line 814  PCRE NATIVE API Line 1099  PCRE NATIVE API
1099              int options, int *ovector, int ovecsize,              int options, int *ovector, int ovecsize,
1100              int *workspace, int wscount);              int *workspace, int wscount);
1101    
1102    
1103    PCRE NATIVE API STRING EXTRACTION FUNCTIONS
1104    
1105         int pcre_copy_named_substring(const pcre *code,         int pcre_copy_named_substring(const pcre *code,
1106              const char *subject, int *ovector,              const char *subject, int *ovector,
1107              int stringcount, const char *stringname,              int stringcount, const char *stringname,
# Line 845  PCRE NATIVE API Line 1133  PCRE NATIVE API
1133    
1134         void pcre_free_substring_list(const char **stringptr);         void pcre_free_substring_list(const char **stringptr);
1135    
1136    
1137    PCRE NATIVE API AUXILIARY FUNCTIONS
1138    
1139           pcre_jit_stack *pcre_jit_stack_alloc(int startsize, int maxsize);
1140    
1141           void pcre_jit_stack_free(pcre_jit_stack *stack);
1142    
1143           void pcre_assign_jit_stack(pcre_extra *extra,
1144                pcre_jit_callback callback, void *data);
1145    
1146         const unsigned char *pcre_maketables(void);         const unsigned char *pcre_maketables(void);
1147    
1148         int pcre_fullinfo(const pcre *code, const pcre_extra *extra,         int pcre_fullinfo(const pcre *code, const pcre_extra *extra,
1149              int what, void *where);              int what, void *where);
1150    
        int pcre_info(const pcre *code, int *optptr, int *firstcharptr);  
   
1151         int pcre_refcount(pcre *code, int adjust);         int pcre_refcount(pcre *code, int adjust);
1152    
1153         int pcre_config(int what, void *where);         int pcre_config(int what, void *where);
1154    
1155         char *pcre_version(void);         const char *pcre_version(void);
1156    
1157           int pcre_pattern_to_host_byte_order(pcre *code,
1158                pcre_extra *extra, const unsigned char *tables);
1159    
1160    
1161    PCRE NATIVE API INDIRECTED FUNCTIONS
1162    
1163         void *(*pcre_malloc)(size_t);         void *(*pcre_malloc)(size_t);
1164    
# Line 869  PCRE NATIVE API Line 1171  PCRE NATIVE API
1171         int (*pcre_callout)(pcre_callout_block *);         int (*pcre_callout)(pcre_callout_block *);
1172    
1173    
1174    PCRE 8-BIT AND 16-BIT LIBRARIES
1175    
1176           From  release  8.30,  PCRE  can  be  compiled as a library for handling
1177           16-bit character strings as  well  as,  or  instead  of,  the  original
1178           library that handles 8-bit character strings. To avoid too much compli-
1179           cation, this document describes the 8-bit versions  of  the  functions,
1180           with only occasional references to the 16-bit library.
1181    
1182           The  16-bit  functions  operate in the same way as their 8-bit counter-
1183           parts; they just use different  data  types  for  their  arguments  and
1184           results, and their names start with pcre16_ instead of pcre_. For every
1185           option that has UTF8 in its name (for example, PCRE_UTF8), there  is  a
1186           corresponding 16-bit name with UTF8 replaced by UTF16. This facility is
1187           in fact just cosmetic; the 16-bit option names define the same bit val-
1188           ues.
1189    
1190           References to bytes and UTF-8 in this document should be read as refer-
1191           ences to 16-bit data  quantities  and  UTF-16  when  using  the  16-bit
1192           library,  unless specified otherwise. More details of the specific dif-
1193           ferences for the 16-bit library are given in the pcre16 page.
1194    
1195    
1196  PCRE API OVERVIEW  PCRE API OVERVIEW
1197    
1198         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
1199         are also some wrapper functions that correspond to  the  POSIX  regular         are  also some wrapper functions (for the 8-bit library only) that cor-
1200         expression  API.  These  are  described in the pcreposix documentation.         respond to the POSIX regular expression  API,  but  they  do  not  give
1201         Both of these APIs define a set of C function calls. A C++  wrapper  is         access  to  all  the functionality. They are described in the pcreposix
1202         distributed with PCRE. It is documented in the pcrecpp page.         documentation. Both of these APIs define a set of C function  calls.  A
1203           C++ wrapper (again for the 8-bit library only) is also distributed with
1204         The  native  API  C  function prototypes are defined in the header file         PCRE. It is documented in the pcrecpp page.
1205         pcre.h, and on Unix systems the library itself is called  libpcre.   It  
1206         can normally be accessed by adding -lpcre to the command for linking an         The native API C function prototypes are defined  in  the  header  file
1207         application  that  uses  PCRE.  The  header  file  defines  the  macros         pcre.h,  and  on Unix-like systems the (8-bit) library itself is called
1208         PCRE_MAJOR  and  PCRE_MINOR to contain the major and minor release num-         libpcre. It can normally be accessed by adding -lpcre  to  the  command
1209         bers for the library.  Applications can use these  to  include  support         for  linking an application that uses PCRE. The header file defines the
1210           macros PCRE_MAJOR and PCRE_MINOR to contain the major and minor release
1211           numbers  for the library. Applications can use these to include support
1212         for different releases of PCRE.         for different releases of PCRE.
1213    
1214         The   functions   pcre_compile(),  pcre_compile2(),  pcre_study(),  and         In a Windows environment, if you want to statically link an application
1215         pcre_exec() are used for compiling and matching regular expressions  in         program  against  a  non-dll  pcre.a  file, you must define PCRE_STATIC
1216         a  Perl-compatible  manner. A sample program that demonstrates the sim-         before including pcre.h or pcrecpp.h, because otherwise  the  pcre_mal-
1217         plest way of using them is provided in the file  called  pcredemo.c  in         loc()   and   pcre_free()   exported   functions   will   be   declared
1218         the  source distribution. The pcresample documentation describes how to         __declspec(dllimport), with unwanted results.
1219         compile and run it.  
1220           The  functions  pcre_compile(),  pcre_compile2(),   pcre_study(),   and
1221           pcre_exec()  are used for compiling and matching regular expressions in
1222           a Perl-compatible manner. A sample program that demonstrates  the  sim-
1223           plest  way  of  using them is provided in the file called pcredemo.c in
1224           the PCRE source distribution. A listing of this program is given in the
1225           pcredemo  documentation, and the pcresample documentation describes how
1226           to compile and run it.
1227    
1228           Just-in-time compiler support is an optional feature of PCRE  that  can
1229           be built in appropriate hardware environments. It greatly speeds up the
1230           matching performance of  many  patterns.  Simple  programs  can  easily
1231           request  that  it  be  used  if available, by setting an option that is
1232           ignored when it is not relevant. More complicated programs  might  need
1233           to     make    use    of    the    functions    pcre_jit_stack_alloc(),
1234           pcre_jit_stack_free(), and pcre_assign_jit_stack() in order to  control
1235           the  JIT  code's  memory  usage.   These functions are discussed in the
1236           pcrejit documentation.
1237    
1238         A second matching function, pcre_dfa_exec(), which is not Perl-compati-         A second matching function, pcre_dfa_exec(), which is not Perl-compati-
1239         ble,  is  also provided. This uses a different algorithm for the match-         ble,  is  also provided. This uses a different algorithm for the match-
1240         ing. The alternative algorithm finds all possible matches (at  a  given         ing. The alternative algorithm finds all possible matches (at  a  given
1241         point  in  the subject), and scans the subject just once. However, this         point  in  the  subject), and scans the subject just once (unless there
1242         algorithm does not return captured substrings. A description of the two         are lookbehind assertions). However, this  algorithm  does  not  return
1243         matching  algorithms and their advantages and disadvantages is given in         captured  substrings.  A description of the two matching algorithms and
1244         the pcrematching documentation.         their advantages and disadvantages is given in the  pcrematching  docu-
1245           mentation.
1246    
1247         In addition to the main compiling and  matching  functions,  there  are         In  addition  to  the  main compiling and matching functions, there are
1248         convenience functions for extracting captured substrings from a subject         convenience functions for extracting captured substrings from a subject
1249         string that is matched by pcre_exec(). They are:         string that is matched by pcre_exec(). They are:
1250    
# Line 915  PCRE API OVERVIEW Line 1259  PCRE API OVERVIEW
1259         pcre_free_substring() and pcre_free_substring_list() are also provided,         pcre_free_substring() and pcre_free_substring_list() are also provided,
1260         to free the memory used for extracted strings.         to free the memory used for extracted strings.
1261    
1262         The  function  pcre_maketables()  is  used  to build a set of character         The function pcre_maketables() is used to  build  a  set  of  character
1263         tables  in  the  current  locale   for   passing   to   pcre_compile(),         tables   in   the   current   locale  for  passing  to  pcre_compile(),
1264         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
1265         provided for specialist use.  Most  commonly,  no  special  tables  are         provided  for  specialist  use.  Most  commonly,  no special tables are
1266         passed,  in  which case internal tables that are generated when PCRE is         passed, in which case internal tables that are generated when  PCRE  is
1267         built are used.         built are used.
1268    
1269         The function pcre_fullinfo() is used to find out  information  about  a         The  function  pcre_fullinfo()  is used to find out information about a
1270         compiled  pattern; pcre_info() is an obsolete version that returns only         compiled pattern. The function pcre_version() returns a  pointer  to  a
1271         some of the available information, but is retained for  backwards  com-         string containing the version of PCRE and its date of release.
        patibility.   The function pcre_version() returns a pointer to a string  
        containing the version of PCRE and its date of release.  
1272    
1273         The function pcre_refcount() maintains a  reference  count  in  a  data         The  function  pcre_refcount()  maintains  a  reference count in a data
1274         block  containing  a compiled pattern. This is provided for the benefit         block containing a compiled pattern. This is provided for  the  benefit
1275         of object-oriented applications.         of object-oriented applications.
1276    
1277         The global variables pcre_malloc and pcre_free  initially  contain  the         The  global  variables  pcre_malloc and pcre_free initially contain the
1278         entry  points  of  the  standard malloc() and free() functions, respec-         entry points of the standard malloc()  and  free()  functions,  respec-
1279         tively. PCRE calls the memory management functions via these variables,         tively. PCRE calls the memory management functions via these variables,
1280         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
1281         calls. This should be done before calling any PCRE functions.         calls. This should be done before calling any PCRE functions.
1282    
1283         The global variables pcre_stack_malloc  and  pcre_stack_free  are  also         The  global  variables  pcre_stack_malloc  and pcre_stack_free are also
1284         indirections  to  memory  management functions. These special functions         indirections to memory management functions.  These  special  functions
1285         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
1286         data, instead of recursive function calls, when running the pcre_exec()         data, instead of recursive function calls, when running the pcre_exec()
1287         function. See the pcrebuild documentation for  details  of  how  to  do         function.  See  the  pcrebuild  documentation  for details of how to do
1288         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-
1289         ments that have limited stacks. Because of the greater  use  of  memory         ments  that  have  limited stacks. Because of the greater use of memory
1290         management,  it  runs  more  slowly. Separate functions are provided so         management, it runs more slowly. Separate  functions  are  provided  so
1291         that special-purpose external code can be  used  for  this  case.  When         that  special-purpose  external  code  can  be used for this case. When
1292         used,  these  functions  are always called in a stack-like manner (last         used, these functions are always called in a  stack-like  manner  (last
1293         obtained, first freed), and always for memory blocks of the same  size.         obtained,  first freed), and always for memory blocks of the same size.
1294         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-
1295         mentation.         mentation.
1296    
1297         The global variable pcre_callout initially contains NULL. It can be set         The global variable pcre_callout initially contains NULL. It can be set
1298         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
1299         specified points during a matching operation. Details are given in  the         specified  points during a matching operation. Details are given in the
1300         pcrecallout documentation.         pcrecallout documentation.
1301    
1302    
1303  NEWLINES  NEWLINES
1304    
1305         PCRE  supports five different conventions for indicating line breaks in         PCRE supports five different conventions for indicating line breaks  in
1306         strings: a single CR (carriage return) character, a  single  LF  (line-         strings:  a  single  CR (carriage return) character, a single LF (line-
1307         feed) character, the two-character sequence CRLF, any of the three pre-         feed) character, the two-character sequence CRLF, any of the three pre-
1308         ceding, or any Unicode newline sequence. The Unicode newline  sequences         ceding,  or any Unicode newline sequence. The Unicode newline sequences
1309         are  the  three just mentioned, plus the single characters VT (vertical         are the three just mentioned, plus the single characters  VT  (vertical
1310         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
1311         separator, U+2028), and PS (paragraph separator, U+2029).         separator, U+2028), and PS (paragraph separator, U+2029).
1312    
1313         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
1314         system as its standard newline sequence. When PCRE is built, a  default         system  as its standard newline sequence. When PCRE is built, a default
1315         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-
1316         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
1317         pattern is compiled, or when it is matched.         pattern is compiled, or when it is matched.
1318    
1319         At compile time, the newline convention can be specified by the options         At compile time, the newline convention can be specified by the options
1320         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
1321         the start of the pattern itself; this overrides any other settings. See         the start of the pattern itself; this overrides any other settings. See
1322         the pcrepattern page for details of the special character sequences.         the pcrepattern page for details of the special character sequences.
1323    
1324         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-
1325         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
1326         newline convention affects the handling of  the  dot,  circumflex,  and         newline  convention  affects  the  handling of the dot, circumflex, and
1327         dollar metacharacters, the handling of #-comments in /x mode, and, when         dollar metacharacters, the handling of #-comments in /x mode, and, when
1328         CRLF is a recognized line ending sequence, the match position  advance-         CRLF  is a recognized line ending sequence, the match position advance-
1329         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
1330         section on pcre_exec() options below.         section on pcre_exec() options below.
1331    
1332         The choice of newline convention does not affect the interpretation  of         The  choice of newline convention does not affect the interpretation of
1333         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,
1334         which is controlled in a similar way, but by separate options.         which is controlled in a similar way, but by separate options.
1335    
1336    
1337  MULTITHREADING  MULTITHREADING
1338    
1339         The PCRE functions can be used in  multi-threading  applications,  with         The  PCRE  functions  can be used in multi-threading applications, with
1340         the  proviso  that  the  memory  management  functions  pointed  to  by         the  proviso  that  the  memory  management  functions  pointed  to  by
1341         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
1342         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 1345  MULTITHREADING
1345         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
1346         at once.         at once.
1347    
1348           If the just-in-time optimization feature is being used, it needs  sepa-
1349           rate  memory stack areas for each thread. See the pcrejit documentation
1350           for more details.
1351    
1352    
1353  SAVING PRECOMPILED PATTERNS FOR LATER USE  SAVING PRECOMPILED PATTERNS FOR LATER USE
1354    
1355         The compiled form of a regular expression can be saved and re-used at a         The compiled form of a regular expression can be saved and re-used at a
1356         later  time,  possibly by a different program, and even on a host other         later  time,  possibly by a different program, and even on a host other
1357         than the one on which  it  was  compiled.  Details  are  given  in  the         than the one on which  it  was  compiled.  Details  are  given  in  the
1358         pcreprecompile  documentation.  However, compiling a regular expression         pcreprecompile  documentation,  which  includes  a  description  of the
1359         with one version of PCRE for use with a different version is not  guar-         pcre_pattern_to_host_byte_order() function. However, compiling a  regu-
1360         anteed to work and may cause crashes.         lar  expression  with one version of PCRE for use with a different ver-
1361           sion is not guaranteed to work and may cause crashes.
1362    
1363    
1364  CHECKING BUILD-TIME OPTIONS  CHECKING BUILD-TIME OPTIONS
1365    
1366         int pcre_config(int what, void *where);         int pcre_config(int what, void *where);
1367    
1368         The  function pcre_config() makes it possible for a PCRE client to dis-         The function pcre_config() makes it possible for a PCRE client to  dis-
1369         cover which optional features have been compiled into the PCRE library.         cover which optional features have been compiled into the PCRE library.
1370         The  pcrebuild documentation has more details about these optional fea-         The pcrebuild documentation has more details about these optional  fea-
1371         tures.         tures.
1372    
1373         The first argument for pcre_config() is an  integer,  specifying  which         The  first  argument  for pcre_config() is an integer, specifying which
1374         information is required; the second argument is a pointer to a variable         information is required; the second argument is a pointer to a variable
1375         into which the information is  placed.  The  following  information  is         into  which  the  information  is placed. The returned value is zero on
1376           success, or the negative error code PCRE_ERROR_BADOPTION if  the  value
1377           in  the  first argument is not recognized. The following information is
1378         available:         available:
1379    
1380           PCRE_CONFIG_UTF8           PCRE_CONFIG_UTF8
1381    
1382         The  output is an integer that is set to one if UTF-8 support is avail-         The output is an integer that is set to one if UTF-8 support is  avail-
1383         able; otherwise it is set to zero.         able;  otherwise  it  is  set  to  zero. If this option is given to the
1384           16-bit  version  of  this  function,  pcre16_config(),  the  result  is
1385           PCRE_ERROR_BADOPTION.
1386    
1387             PCRE_CONFIG_UTF16
1388    
1389           The output is an integer that is set to one if UTF-16 support is avail-
1390           able; otherwise it is set to zero. This value should normally be  given
1391           to the 16-bit version of this function, pcre16_config(). If it is given
1392           to the 8-bit version of this function, the result is  PCRE_ERROR_BADOP-
1393           TION.
1394    
1395           PCRE_CONFIG_UNICODE_PROPERTIES           PCRE_CONFIG_UNICODE_PROPERTIES
1396    
1397         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
1398         character properties is available; otherwise it is set to zero.         character properties is available; otherwise it is set to zero.
1399    
1400             PCRE_CONFIG_JIT
1401    
1402           The output is an integer that is set to one if support for just-in-time
1403           compiling is available; otherwise it is set to zero.
1404    
1405           PCRE_CONFIG_NEWLINE           PCRE_CONFIG_NEWLINE
1406    
1407         The  output  is  an integer whose value specifies the default character         The  output  is  an integer whose value specifies the default character
1408         sequence that is recognized as meaning "newline". The four values  that         sequence that is recognized as meaning "newline". The four values  that
1409         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,
1410         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
1411         for your operating system.         are returned in EBCDIC environments. The default should normally corre-
1412           spond to the standard sequence for your operating system.
1413    
1414           PCRE_CONFIG_BSR           PCRE_CONFIG_BSR
1415    
1416         The output is an integer whose value indicates what character sequences         The output is an integer whose value indicates what character sequences
1417         the \R escape sequence matches by default. A value of 0 means  that  \R         the  \R  escape sequence matches by default. A value of 0 means that \R
1418         matches  any  Unicode  line ending sequence; a value of 1 means that \R         matches any Unicode line ending sequence; a value of 1  means  that  \R
1419         matches only CR, LF, or CRLF. The default can be overridden when a pat-         matches only CR, LF, or CRLF. The default can be overridden when a pat-
1420         tern is compiled or matched.         tern is compiled or matched.
1421    
1422           PCRE_CONFIG_LINK_SIZE           PCRE_CONFIG_LINK_SIZE
1423    
1424         The  output  is  an  integer that contains the number of bytes used for         The output is an integer that contains the number  of  bytes  used  for
1425         internal linkage in compiled regular expressions. The value is 2, 3, or         internal  linkage  in  compiled  regular  expressions.  For  the  8-bit
1426         4.  Larger  values  allow larger regular expressions to be compiled, at         library, the value can be 2, 3, or 4. For the 16-bit library, the value
1427         the expense of slower matching. The default value of  2  is  sufficient         is either 2 or 4 and is still a number of bytes. The default value of 2
1428         for  all  but  the  most massive patterns, since it allows the compiled         is sufficient for all but the most massive patterns,  since  it  allows
1429         pattern to be up to 64K in size.         the  compiled  pattern  to  be  up to 64K in size.  Larger values allow
1430           larger regular expressions to be compiled, at  the  expense  of  slower
1431           matching.
1432    
1433           PCRE_CONFIG_POSIX_MALLOC_THRESHOLD           PCRE_CONFIG_POSIX_MALLOC_THRESHOLD
1434    
1435         The output is an integer that contains the threshold  above  which  the         The  output  is  an integer that contains the threshold above which the
1436         POSIX  interface  uses malloc() for output vectors. Further details are         POSIX interface uses malloc() for output vectors. Further  details  are
1437         given in the pcreposix documentation.         given in the pcreposix documentation.
1438    
1439           PCRE_CONFIG_MATCH_LIMIT           PCRE_CONFIG_MATCH_LIMIT
1440    
1441         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-
1442         internal  matching  function  calls in a pcre_exec() execution. Further         ber of internal matching function calls  in  a  pcre_exec()  execution.
1443         details are given with pcre_exec() below.         Further details are given with pcre_exec() below.
1444    
1445           PCRE_CONFIG_MATCH_LIMIT_RECURSION           PCRE_CONFIG_MATCH_LIMIT_RECURSION
1446    
1447         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
1448         recursion  when calling the internal matching function in a pcre_exec()         of  recursion  when  calling  the  internal  matching  function  in   a
1449         execution. Further details are given with pcre_exec() below.         pcre_exec()  execution.  Further  details  are  given  with pcre_exec()
1450           below.
1451    
1452           PCRE_CONFIG_STACKRECURSE           PCRE_CONFIG_STACKRECURSE
1453    
# Line 1106  COMPILING A PATTERN Line 1474  COMPILING A PATTERN
1474         Either of the functions pcre_compile() or pcre_compile2() can be called         Either of the functions pcre_compile() or pcre_compile2() can be called
1475         to compile a pattern into an internal form. The only difference between         to compile a pattern into an internal form. The only difference between
1476         the two interfaces is that pcre_compile2() has an additional  argument,         the two interfaces is that pcre_compile2() has an additional  argument,
1477         errorcodeptr, via which a numerical error code can be returned.         errorcodeptr,  via  which  a  numerical  error code can be returned. To
1478           avoid too much repetition, we refer just to pcre_compile()  below,  but
1479           the information applies equally to pcre_compile2().
1480    
1481         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
1482         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
# Line 1123  COMPILING A PATTERN Line 1493  COMPILING A PATTERN
1493    
1494         The options argument contains various bit settings that affect the com-         The options argument contains various bit settings that affect the com-
1495         pilation.  It  should be zero if no options are required. The available         pilation.  It  should be zero if no options are required. The available
1496         options are described below. Some of them, in  particular,  those  that         options are described below. Some of them (in  particular,  those  that
1497         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
1498         pattern (see the detailed description  in  the  pcrepattern  documenta-         unset from within the pattern (see  the  detailed  description  in  the
1499         tion).  For  these options, the contents of the options argument speci-         pcrepattern  documentation). For those options that can be different in
1500         fies their initial settings at the start of compilation and  execution.         different parts of the pattern, the contents of  the  options  argument
1501         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
1502         of matching as well as at compile time.         PCRE_ANCHORED, PCRE_BSR_xxx, PCRE_NEWLINE_xxx, PCRE_NO_UTF8_CHECK,  and
1503           PCRE_NO_START_OPT options can be set at the time of matching as well as
1504           at compile time.
1505    
1506         If errptr is NULL, pcre_compile() returns NULL immediately.  Otherwise,         If errptr is NULL, pcre_compile() returns NULL immediately.  Otherwise,
1507         if  compilation  of  a  pattern fails, pcre_compile() returns NULL, and         if  compilation  of  a  pattern fails, pcre_compile() returns NULL, and
1508         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-
1509         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
1510         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
1511         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
1512         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
1513         given.         (if  it is, an immediate error is given). However, for an invalid UTF-8
1514           string, the offset is that of the first byte of the failing character.
1515    
1516           Some errors are not detected until the whole pattern has been  scanned;
1517           in  these  cases,  the offset passed back is the length of the pattern.
1518           Note that the offset is in bytes, not characters, even in  UTF-8  mode.
1519           It may sometimes point into the middle of a UTF-8 character.
1520    
1521         If  pcre_compile2()  is  used instead of pcre_compile(), and the error-         If  pcre_compile2()  is  used instead of pcre_compile(), and the error-
1522         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 1594  COMPILING A PATTERN
1594    
1595           PCRE_DOTALL           PCRE_DOTALL
1596    
1597         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-
1598         acters,  including  those that indicate newline. Without it, a dot does         acter of any value, including one that indicates a newline. However, it
1599         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.
1600         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
1601         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
1602         newline characters, independent of the setting of this option.         be  changed within a pattern by a (?s) option setting. A negative class
1603           such as [^a] always matches newline characters, independent of the set-
1604           ting of this option.
1605    
1606           PCRE_DUPNAMES           PCRE_DUPNAMES
1607    
# Line 1241  COMPILING A PATTERN Line 1621  COMPILING A PATTERN
1621         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-
1622         ting.         ting.
1623    
1624         This  option  makes  it possible to include comments inside complicated         Which  characters  are  interpreted  as  newlines  is controlled by the
1625         patterns.  Note, however, that this applies only  to  data  characters.         options passed to pcre_compile() or by a special sequence at the  start
1626         Whitespace   characters  may  never  appear  within  special  character         of  the  pattern, as described in the section entitled "Newline conven-
1627         sequences in a pattern, for  example  within  the  sequence  (?(  which         tions" in the pcrepattern documentation. Note that the end of this type
1628         introduces a conditional subpattern.         of  comment  is  a  literal  newline  sequence  in  the pattern; escape
1629           sequences that happen to represent a newline do not count.
1630    
1631           This option makes it possible to include  comments  inside  complicated
1632           patterns.   Note,  however,  that this applies only to data characters.
1633           Whitespace  characters  may  never  appear  within  special   character
1634           sequences in a pattern, for example within the sequence (?( that intro-
1635           duces a conditional subpattern.
1636    
1637           PCRE_EXTRA           PCRE_EXTRA
1638    
1639         This  option  was invented in order to turn on additional functionality         This option was invented in order to turn on  additional  functionality
1640         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
1641         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
1642         letter that has no special meaning  causes  an  error,  thus  reserving         letter  that  has  no  special  meaning causes an error, thus reserving
1643         these  combinations  for  future  expansion.  By default, as in Perl, a         these combinations for future expansion. By  default,  as  in  Perl,  a
1644         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
1645         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
1646         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
1647         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
1648           within a pattern.
1649    
1650           PCRE_FIRSTLINE           PCRE_FIRSTLINE
1651    
# Line 1282  COMPILING A PATTERN Line 1670  COMPILING A PATTERN
1670         set  (assuming  it can find an "a" in the subject), whereas it fails by         set  (assuming  it can find an "a" in the subject), whereas it fails by
1671         default, for Perl compatibility.         default, for Perl compatibility.
1672    
1673           (3) \U matches an upper case "U" character; by default \U causes a com-
1674           pile time error (Perl uses \U to upper case subsequent characters).
1675    
1676           (4) \u matches a lower case "u" character unless it is followed by four
1677           hexadecimal digits, in which case the hexadecimal  number  defines  the
1678           code  point  to match. By default, \u causes a compile time error (Perl
1679           uses it to upper case the following character).
1680    
1681           (5) \x matches a lower case "x" character unless it is followed by  two
1682           hexadecimal  digits,  in  which case the hexadecimal number defines the
1683           code point to match. By default, as in Perl, a  hexadecimal  number  is
1684           always expected after \x, but it may have zero, one, or two digits (so,
1685           for example, \xz matches a binary zero character followed by z).
1686    
1687           PCRE_MULTILINE           PCRE_MULTILINE
1688    
1689         By default, PCRE treats the subject string as consisting  of  a  single         By default, PCRE treats the subject string as consisting  of  a  single
# Line 1315  COMPILING A PATTERN Line 1717  COMPILING A PATTERN
1717         recognized. The Unicode newline sequences are the three just mentioned,         recognized. The Unicode newline sequences are the three just mentioned,
1718         plus  the  single  characters  VT (vertical tab, U+000B), FF (formfeed,         plus  the  single  characters  VT (vertical tab, U+000B), FF (formfeed,
1719         U+000C), NEL (next line, U+0085), LS (line separator, U+2028),  and  PS         U+000C), NEL (next line, U+0085), LS (line separator, U+2028),  and  PS
1720         (paragraph  separator,  U+2029).  The  last  two are recognized only in         (paragraph  separator, U+2029). For the 8-bit library, the last two are
1721         UTF-8 mode.         recognized only in UTF-8 mode.
1722    
1723         The newline setting in the  options  word  uses  three  bits  that  are         The newline setting in the  options  word  uses  three  bits  that  are
1724         treated as a number, giving eight possibilities. Currently only six are         treated as a number, giving eight possibilities. Currently only six are
# Line 1326  COMPILING A PATTERN Line 1728  COMPILING A PATTERN
1728         PCRE_NEWLINE_CRLF,  but other combinations may yield unused numbers and         PCRE_NEWLINE_CRLF,  but other combinations may yield unused numbers and
1729         cause an error.         cause an error.
1730    
1731         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
1732         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
1733         character class is encountered. This indicates  a  comment  that  lasts         characters, and so are ignored in this mode. Also, an unescaped #  out-
1734         until  after the next line break sequence. In other circumstances, line         side  a  character class indicates a comment that lasts until after the
1735         break  sequences  are  treated  as  literal  data,   except   that   in         next line break sequence. In other circumstances, line break  sequences
1736         PCRE_EXTENDED mode, both CR and LF are treated as whitespace characters         in patterns are treated as literal data.
        and are therefore ignored.  
1737    
1738         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
1739         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.
1740    
1741           PCRE_NO_AUTO_CAPTURE           PCRE_NO_AUTO_CAPTURE
1742    
# Line 1345  COMPILING A PATTERN Line 1746  COMPILING A PATTERN
1746         be  used  for  capturing  (and  they acquire numbers in the usual way).         be  used  for  capturing  (and  they acquire numbers in the usual way).
1747         There is no equivalent of this option in Perl.         There is no equivalent of this option in Perl.
1748    
1749             NO_START_OPTIMIZE
1750    
1751           This is an option that acts at matching time; that is, it is really  an
1752           option  for  pcre_exec()  or  pcre_dfa_exec().  If it is set at compile
1753           time, it is remembered with the compiled pattern and assumed at  match-
1754           ing  time.  For  details  see  the discussion of PCRE_NO_START_OPTIMIZE
1755           below.
1756    
1757             PCRE_UCP
1758    
1759           This option changes the way PCRE processes \B, \b, \D, \d, \S, \s,  \W,
1760           \w,  and  some  of  the POSIX character classes. By default, only ASCII
1761           characters are recognized, but if PCRE_UCP is set,  Unicode  properties
1762           are  used instead to classify characters. More details are given in the
1763           section on generic character types in the pcrepattern page. If you  set
1764           PCRE_UCP,  matching  one of the items it affects takes much longer. The
1765           option is available only if PCRE has been compiled with  Unicode  prop-
1766           erty support.
1767    
1768           PCRE_UNGREEDY           PCRE_UNGREEDY
1769    
1770         This option inverts the "greediness" of the quantifiers  so  that  they         This  option  inverts  the "greediness" of the quantifiers so that they
1771         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
1772         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
1773         within the pattern.         within the pattern.
1774    
1775           PCRE_UTF8           PCRE_UTF8
1776    
1777         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
1778         strings of UTF-8 characters instead of single-byte  character  strings.         strings of UTF-8 characters instead of single-byte strings. However, it
1779         However,  it is available only when PCRE is built to include UTF-8 sup-         is available only when PCRE is built to include UTF  support.  If  not,
1780         port. If not, the use of this option provokes an error. Details of  how         the  use  of  this option provokes an error. Details of how this option
1781         this  option  changes the behaviour of PCRE are given in the section on         changes the behaviour of PCRE are given in the pcreunicode page.
        UTF-8 support in the main pcre page.  
1782    
1783           PCRE_NO_UTF8_CHECK           PCRE_NO_UTF8_CHECK
1784    
1785         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
1786         automatically  checked.  There  is  a  discussion about the validity of         automatically  checked.  There  is  a  discussion about the validity of
1787         UTF-8 strings in the main pcre page. If an invalid  UTF-8  sequence  of         UTF-8 strings in the pcreunicode page. If an invalid UTF-8 sequence  is
1788         bytes  is  found,  pcre_compile() returns an error. If you already know         found,  pcre_compile()  returns an error. If you already know that your
1789         that your pattern is valid, and you want to skip this check for perfor-         pattern is valid, and you want to skip this check for performance  rea-
1790         mance  reasons,  you  can set the PCRE_NO_UTF8_CHECK option. When it is         sons,  you  can set the PCRE_NO_UTF8_CHECK option.  When it is set, the
1791         set, the effect of passing an invalid UTF-8  string  as  a  pattern  is         effect of passing an invalid UTF-8 string as a pattern is undefined. It
1792         undefined.  It  may  cause your program to crash. Note that this option         may  cause  your  program  to  crash. Note that this option can also be
1793         can also be passed to pcre_exec() and pcre_dfa_exec(), to suppress  the         passed to pcre_exec() and pcre_dfa_exec(),  to  suppress  the  validity
1794         UTF-8 validity checking of subject strings.         checking of subject strings.
1795    
1796    
1797  COMPILATION ERROR CODES  COMPILATION ERROR CODES
1798    
1799         The  following  table  lists  the  error  codes than may be returned by         The  following  table  lists  the  error  codes than may be returned by
1800         pcre_compile2(), along with the error messages that may be returned  by         pcre_compile2(), along with the error messages that may be returned  by
1801         both  compiling functions. As PCRE has developed, some error codes have         both  compiling  functions.  Note  that error messages are always 8-bit
1802         fallen out of use. To avoid confusion, they have not been re-used.         ASCII strings, even in 16-bit mode. As PCRE has developed,  some  error
1803           codes  have  fallen  out of use. To avoid confusion, they have not been
1804           re-used.
1805    
1806            0  no error            0  no error
1807            1  \ at end of pattern            1  \ at end of pattern
# Line 1414  COMPILATION ERROR CODES Line 1835  COMPILATION ERROR CODES
1835           29  (?R or (?[+-]digits must be followed by )           29  (?R or (?[+-]digits must be followed by )
1836           30  unknown POSIX class name           30  unknown POSIX class name
1837           31  POSIX collating elements are not supported           31  POSIX collating elements are not supported
1838           32  this version of PCRE is not compiled with PCRE_UTF8 support           32  this version of PCRE is compiled without UTF support
1839           33  [this code is not in use]           33  [this code is not in use]
1840           34  character value in \x{...} sequence is too large           34  character value in \x{...} sequence is too large
1841           35  invalid condition (?(0)           35  invalid condition (?(0)
1842           36  \C not allowed in lookbehind assertion           36  \C not allowed in lookbehind assertion
1843           37  PCRE does not support \L, \l, \N, \U, or \u           37  PCRE does not support \L, \l, \N{name}, \U, or \u
1844           38  number after (?C is > 255           38  number after (?C is > 255
1845           39  closing ) for (?C expected           39  closing ) for (?C expected
1846           40  recursive call could loop indefinitely           40  recursive call could loop indefinitely
1847           41  unrecognized character after (?P           41  unrecognized character after (?P
1848           42  syntax error in subpattern name (missing terminator)           42  syntax error in subpattern name (missing terminator)
1849           43  two named subpatterns have the same name           43  two named subpatterns have the same name
1850           44  invalid UTF-8 string           44  invalid UTF-8 string (specifically UTF-8)
1851           45  support for \P, \p, and \X has not been compiled           45  support for \P, \p, and \X has not been compiled
1852           46  malformed \P or \p sequence           46  malformed \P or \p sequence
1853           47  unknown property name after \P or \p           47  unknown property name after \P or \p
1854           48  subpattern name is too long (maximum 32 characters)           48  subpattern name is too long (maximum 32 characters)
1855           49  too many named subpatterns (maximum 10000)           49  too many named subpatterns (maximum 10000)
1856           50  [this code is not in use]           50  [this code is not in use]
1857           51  octal value is greater than \377 (not in UTF-8 mode)           51  octal value is greater than \377 in 8-bit non-UTF-8 mode
1858           52  internal error: overran compiling workspace           52  internal error: overran compiling workspace
1859           53  internal  error:  previously-checked  referenced  subpattern  not           53  internal error: previously-checked referenced subpattern
1860         found                 not found
1861           54  DEFINE group contains more than one branch           54  DEFINE group contains more than one branch
1862           55  repeating a DEFINE group is not allowed           55  repeating a DEFINE group is not allowed
1863           56  inconsistent NEWLINE options           56  inconsistent NEWLINE options
1864           57  \g is not followed by a braced, angle-bracketed, or quoted           57  \g is not followed by a braced, angle-bracketed, or quoted
1865                 name/number or by a plain number                 name/number or by a plain number
1866           58  a numbered reference must not be zero           58  a numbered reference must not be zero
1867           59  (*VERB) with an argument is not supported           59  an argument is not allowed for (*ACCEPT), (*FAIL), or (*COMMIT)
1868           60  (*VERB) not recognized           60  (*VERB) not recognized
1869           61  number is too big           61  number is too big
1870           62  subpattern name expected           62  subpattern name expected
1871           63  digit expected after (?+           63  digit expected after (?+
1872           64  ] is an invalid data character in JavaScript compatibility mode           64  ] is an invalid data character in JavaScript compatibility mode
1873             65  different names for subpatterns of the same number are
1874                   not allowed
1875             66  (*MARK) must have an argument
1876             67  this version of PCRE is not compiled with Unicode property
1877                   support
1878             68  \c must be followed by an ASCII character
1879             69  \k is not followed by a braced, angle-bracketed, or quoted name
1880             70  internal error: unknown opcode in find_fixedlength()
1881             71  \N is not supported in a class
1882             72  too many forward references
1883             73  disallowed Unicode code point (>= 0xd800 && <= 0xdfff)
1884             74  invalid UTF-16 string (specifically UTF-16)
1885    
1886         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
1887         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.
1888    
1889    
# Line 1459  STUDYING A PATTERN Line 1892  STUDYING A PATTERN
1892         pcre_extra *pcre_study(const pcre *code, int options         pcre_extra *pcre_study(const pcre *code, int options
1893              const char **errptr);              const char **errptr);
1894    
1895         If a compiled pattern is going to be used several times,  it  is  worth         If  a  compiled  pattern is going to be used several times, it is worth
1896         spending more time analyzing it in order to speed up the time taken for         spending more time analyzing it in order to speed up the time taken for
1897         matching. The function pcre_study() takes a pointer to a compiled  pat-         matching.  The function pcre_study() takes a pointer to a compiled pat-
1898         tern as its first argument. If studying the pattern produces additional         tern as its first argument. If studying the pattern produces additional
1899         information that will help speed up matching,  pcre_study()  returns  a         information  that  will  help speed up matching, pcre_study() returns a
1900         pointer  to a pcre_extra block, in which the study_data field points to         pointer to a pcre_extra block, in which the study_data field points  to
1901         the results of the study.         the results of the study.
1902    
1903         The  returned  value  from  pcre_study()  can  be  passed  directly  to         The  returned  value  from  pcre_study()  can  be  passed  directly  to
1904         pcre_exec().  However,  a  pcre_extra  block also contains other fields         pcre_exec() or pcre_dfa_exec(). However, a pcre_extra block  also  con-
1905         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
1906         described below in the section on matching a pattern.         passed; these are described below in the section on matching a pattern.
1907    
1908         If  studying  the  pattern  does not produce any additional information         If studying the  pattern  does  not  produce  any  useful  information,
1909         pcre_study() returns NULL. In that circumstance, if the calling program         pcre_study() returns NULL. In that circumstance, if the calling program
1910         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
1911         its own pcre_extra block.         pcre_dfa_exec(), it must set up its own pcre_extra block.
1912    
1913         The second argument of pcre_study() contains option bits.  At  present,         The second argument of pcre_study() contains option bits. There is only
1914         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-
1915           time  compiler  is  available,  the  pattern  is  further compiled into
1916           machine code that executes much faster than  the  pcre_exec()  matching
1917           function. If the just-in-time compiler is not available, this option is
1918           ignored. All other bits in the options argument must be zero.
1919    
1920           JIT compilation is a heavyweight optimization. It can  take  some  time
1921           for  patterns  to  be analyzed, and for one-off matches and simple pat-
1922           terns the benefit of faster execution might be offset by a much  slower
1923           study time.  Not all patterns can be optimized by the JIT compiler. For
1924           those that cannot be handled, matching automatically falls back to  the
1925           pcre_exec()  interpreter.  For more details, see the pcrejit documenta-
1926           tion.
1927    
1928         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.
1929         If studying succeeds (even if no data is  returned),  the  variable  it         If  studying  succeeds  (even  if no data is returned), the variable it
1930         points  to  is  set  to NULL. Otherwise it is set to point to a textual         points to is set to NULL. Otherwise it is set to  point  to  a  textual
1931         error message. This is a static string that is part of the library. You         error message. This is a static string that is part of the library. You
1932         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
1933         after calling pcre_study(), to be sure that it has run successfully.         after calling pcre_study(), to be sure that it has run successfully.
1934    
1935         This is a typical call to pcre_study():         When  you are finished with a pattern, you can free the memory used for
1936           the study data by calling pcre_free_study(). This function was added to
1937           the  API  for  release  8.20. For earlier versions, the memory could be
1938           freed with pcre_free(), just like the pattern itself. This  will  still
1939           work  in  cases  where  PCRE_STUDY_JIT_COMPILE  is  not used, but it is
1940           advisable to change to the new function when convenient.
1941    
1942           This is a typical way in which pcre_study() is used (except that  in  a
1943           real application there should be tests for errors):
1944    
1945           pcre_extra *pe;           int rc;
1946           pe = pcre_study(           pcre *re;
1947             pcre_extra *sd;
1948             re = pcre_compile("pattern", 0, &error, &erroroffset, NULL);
1949             sd = pcre_study(
1950             re,             /* result of pcre_compile() */             re,             /* result of pcre_compile() */
1951             0,              /* no options exist */             0,              /* no options */
1952             &error);        /* set to NULL or points to a message */             &error);        /* set to NULL or points to a message */
1953             rc = pcre_exec(   /* see below for details of pcre_exec() options */
1954         At present, studying a pattern is useful only for non-anchored patterns             re, sd, "subject", 7, 0, 0, ovector, 30);
1955         that  do not have a single fixed starting character. A bitmap of possi-           ...
1956         ble starting bytes is created.           pcre_free_study(sd);
1957             pcre_free(re);
1958    
1959           Studying a pattern does two things: first, a lower bound for the length
1960           of subject string that is needed to match the pattern is computed. This
1961           does not mean that there are any strings of that length that match, but
1962           it does guarantee that no shorter strings match. The value is  used  by
1963           pcre_exec()  and  pcre_dfa_exec()  to  avoid  wasting time by trying to
1964           match strings that are shorter than the lower bound. You can  find  out
1965           the value in a calling program via the pcre_fullinfo() function.
1966    
1967           Studying a pattern is also useful for non-anchored patterns that do not
1968           have a single fixed starting character. A bitmap of  possible  starting
1969           bytes  is  created. This speeds up finding a position in the subject at
1970           which to start matching. (In 16-bit mode, the bitmap is used for 16-bit
1971           values less than 256.)
1972    
1973           These  two optimizations apply to both pcre_exec() and pcre_dfa_exec().
1974           However, they are not used by pcre_exec()  if  pcre_study()  is  called
1975           with  the  PCRE_STUDY_JIT_COMPILE option, and just-in-time compiling is
1976           successful.  The  optimizations  can  be  disabled   by   setting   the
1977           PCRE_NO_START_OPTIMIZE    option    when    calling    pcre_exec()   or
1978           pcre_dfa_exec(). You might want to do this  if  your  pattern  contains
1979           callouts  or (*MARK) (which cannot be handled by the JIT compiler), and
1980           you want to make use of these facilities in cases where matching fails.
1981           See the discussion of PCRE_NO_START_OPTIMIZE below.
1982    
1983    
1984  LOCALE SUPPORT  LOCALE SUPPORT
1985    
1986         PCRE handles caseless matching, and determines whether  characters  are         PCRE  handles  caseless matching, and determines whether characters are
1987         letters,  digits, or whatever, by reference to a set of tables, indexed         letters, digits, or whatever, by reference to a set of tables,  indexed
1988         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
1989         characters  with  codes  less than 128. Higher-valued codes never match         characters with codes less than 128. By  default,  higher-valued  codes
1990         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
1991         with  Unicode  character property support. The use of locales with Uni-         PCRE is built with Unicode character property  support.  Alternatively,
1992         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
1993         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
1994         not try to mix the two.         use of locales with Unicode is discouraged. If you are handling charac-
1995           ters with codes greater than 128, you should either use UTF-8 and  Uni-
1996           code, or use locales, but not try to mix the two.
1997    
1998         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
1999         argument  of  pcre_compile()  is  NULL.  These  are sufficient for many         argument of pcre_compile() is  NULL.  These  are  sufficient  for  many
2000         applications.  Normally, the internal tables recognize only ASCII char-         applications.  Normally, the internal tables recognize only ASCII char-
2001         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-
2002         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,
2003         which may cause them to be different.         which may cause them to be different.
2004    
2005         The  internal tables can always be overridden by tables supplied by the         The internal tables can always be overridden by tables supplied by  the
2006         application that calls PCRE. These may be created in a different locale         application that calls PCRE. These may be created in a different locale
2007         from  the  default.  As more and more applications change to using Uni-         from the default. As more and more applications change  to  using  Uni-
2008         code, the need for this locale support is expected to die away.         code, the need for this locale support is expected to die away.
2009    
2010         External tables are built by calling  the  pcre_maketables()  function,         External  tables  are  built by calling the pcre_maketables() function,
2011         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
2012         passed to pcre_compile() or pcre_exec()  as  often  as  necessary.  For         passed  to  pcre_compile()  or  pcre_exec()  as often as necessary. For
2013         example,  to  build  and use tables that are appropriate for the French         example, to build and use tables that are appropriate  for  the  French
2014         locale (where accented characters with  values  greater  than  128  are         locale  (where  accented  characters  with  values greater than 128 are
2015         treated as letters), the following code could be used:         treated as letters), the following code could be used:
2016    
2017           setlocale(LC_CTYPE, "fr_FR");           setlocale(LC_CTYPE, "fr_FR");
2018           tables = pcre_maketables();           tables = pcre_maketables();
2019           re = pcre_compile(..., tables);           re = pcre_compile(..., tables);
2020    
2021         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;
2022         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".
2023    
2024         When pcre_maketables() runs, the tables are built  in  memory  that  is         When  pcre_maketables()  runs,  the  tables are built in memory that is
2025         obtained  via  pcre_malloc. It is the caller's responsibility to ensure         obtained via pcre_malloc. It is the caller's responsibility  to  ensure
2026         that the memory containing the tables remains available for as long  as         that  the memory containing the tables remains available for as long as
2027         it is needed.         it is needed.
2028    
2029         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
2030         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()
2031         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-
2032         tern, compilation, studying and matching all happen in the same locale,         tern, compilation, studying and matching all happen in the same locale,
2033         but different patterns can be compiled in different locales.         but different patterns can be compiled in different locales.
2034    
2035         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
2036         the internal tables) to pcre_exec(). Although  not  intended  for  this         the  internal  tables)  to  pcre_exec(). Although not intended for this
2037         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
2038         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
2039         run time is discussed below in the section on matching a pattern.         run time is discussed below in the section on matching a pattern.
2040    
# Line 1561  INFORMATION ABOUT A PATTERN Line 2044  INFORMATION ABOUT A PATTERN
2044         int pcre_fullinfo(const pcre *code, const pcre_extra *extra,         int pcre_fullinfo(const pcre *code, const pcre_extra *extra,
2045              int what, void *where);              int what, void *where);
2046    
2047         The  pcre_fullinfo() function returns information about a compiled pat-         The pcre_fullinfo() function returns information about a compiled  pat-
2048         tern. It replaces the obsolete pcre_info() function, which is neverthe-         tern.  It replaces the pcre_info() function, which was removed from the
2049         less retained for backwards compability (and is documented below).         library at version 8.30, after more than 10 years of obsolescence.
2050    
2051         The  first  argument  for  pcre_fullinfo() is a pointer to the compiled         The first argument for pcre_fullinfo() is a  pointer  to  the  compiled
2052         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
2053         the  pattern  was not studied. The third argument specifies which piece         the pattern was not studied. The third argument specifies  which  piece
2054         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
2055         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
2056         success, or one of the following negative numbers:         success, or one of the following negative numbers:
2057    
2058           PCRE_ERROR_NULL       the argument code was NULL           PCRE_ERROR_NULL           the argument code was NULL
2059                                 the argument where was NULL                                     the argument where was NULL
2060           PCRE_ERROR_BADMAGIC   the "magic number" was not found           PCRE_ERROR_BADMAGIC       the "magic number" was not found
2061           PCRE_ERROR_BADOPTION  the value of what was invalid           PCRE_ERROR_BADENDIANNESS  the pattern was compiled with different
2062                                       endianness
2063         The "magic number" is placed at the start of each compiled  pattern  as           PCRE_ERROR_BADOPTION      the value of what was invalid
2064         an  simple check against passing an arbitrary memory pointer. Here is a  
2065         typical call of pcre_fullinfo(), to obtain the length of  the  compiled         The  "magic  number" is placed at the start of each compiled pattern as
2066         pattern:         an simple check against passing an arbitrary memory pointer. The  endi-
2067           anness error can occur if a compiled pattern is saved and reloaded on a
2068           different host. Here is a typical call of  pcre_fullinfo(),  to  obtain
2069           the length of the compiled pattern:
2070    
2071           int rc;           int rc;
2072           size_t length;           size_t length;
2073           rc = pcre_fullinfo(           rc = pcre_fullinfo(
2074             re,               /* result of pcre_compile() */             re,               /* result of pcre_compile() */
2075             pe,               /* result of pcre_study(), or NULL */             sd,               /* result of pcre_study(), or NULL */
2076             PCRE_INFO_SIZE,   /* what is required */             PCRE_INFO_SIZE,   /* what is required */
2077             &length);         /* where to put the data */             &length);         /* where to put the data */
2078    
# Line 1614  INFORMATION ABOUT A PATTERN Line 2100  INFORMATION ABOUT A PATTERN
2100    
2101           PCRE_INFO_FIRSTBYTE           PCRE_INFO_FIRSTBYTE
2102    
2103         Return  information  about  the first byte of any matched string, for a         Return information about the first data unit of any matched string, for
2104         non-anchored pattern. The fourth argument should point to an int  vari-         a non-anchored pattern. (The name of this option refers  to  the  8-bit
2105         able.  (This option used to be called PCRE_INFO_FIRSTCHAR; the old name         library,  where data units are bytes.) The fourth argument should point
2106         is still recognized for backwards compatibility.)         to an int variable.
2107    
2108           If there is a fixed first value, for example, the  letter  "c"  from  a
2109           pattern  such  as (cat|cow|coyote), its value is returned. In the 8-bit
2110           library, the value is always less than 256; in the 16-bit  library  the
2111           value can be up to 0xffff.
2112    
2113         If there is a fixed first byte, for example, from  a  pattern  such  as         If there is no fixed first value, and if either
        (cat|cow|coyote), its value is returned. Otherwise, if either  
2114    
2115         (a)  the pattern was compiled with the PCRE_MULTILINE option, and every         (a)  the pattern was compiled with the PCRE_MULTILINE option, and every
2116         branch starts with "^", or         branch starts with "^", or
# Line 1635  INFORMATION ABOUT A PATTERN Line 2125  INFORMATION ABOUT A PATTERN
2125           PCRE_INFO_FIRSTTABLE           PCRE_INFO_FIRSTTABLE
2126    
2127         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
2128         256-bit table indicating a fixed set of bytes for the first byte in any         256-bit table indicating a fixed set of values for the first data  unit
2129         matching  string, a pointer to the table is returned. Otherwise NULL is         in  any  matching string, a pointer to the table is returned. Otherwise
2130         returned. The fourth argument should point to an unsigned char *  vari-         NULL is returned. The fourth argument should point to an unsigned  char
2131         able.         * variable.
2132    
2133           PCRE_INFO_HASCRORLF           PCRE_INFO_HASCRORLF
2134    
# Line 1653  INFORMATION ABOUT A PATTERN Line 2143  INFORMATION ABOUT A PATTERN
2143         otherwise  0. The fourth argument should point to an int variable. (?J)         otherwise  0. The fourth argument should point to an int variable. (?J)
2144         and (?-J) set and unset the local PCRE_DUPNAMES option, respectively.         and (?-J) set and unset the local PCRE_DUPNAMES option, respectively.
2145    
2146             PCRE_INFO_JIT
2147    
2148           Return 1 if the pattern was  studied  with  the  PCRE_STUDY_JIT_COMPILE
2149           option,  and just-in-time compiling was successful. The fourth argument
2150           should point to an int variable. A return value of  0  means  that  JIT
2151           support  is  not available in this version of PCRE, or that the pattern
2152           was not studied with the PCRE_STUDY_JIT_COMPILE option, or that the JIT
2153           compiler could not handle this particular pattern. See the pcrejit doc-
2154           umentation for details of what can and cannot be handled.
2155    
2156             PCRE_INFO_JITSIZE
2157    
2158           If the pattern was successfully studied with the PCRE_STUDY_JIT_COMPILE
2159           option,  return  the  size  of  the JIT compiled code, otherwise return
2160           zero. The fourth argument should point to a size_t variable.
2161    
2162           PCRE_INFO_LASTLITERAL           PCRE_INFO_LASTLITERAL
2163    
2164         Return the value of the rightmost literal byte that must exist  in  any         Return the value of the rightmost literal data unit that must exist  in
2165         matched  string,  other  than  at  its  start,  if such a byte has been         any  matched  string, other than at its start, if such a value has been
2166         recorded. The fourth argument should point to an int variable. If there         recorded. The fourth argument should point to an int variable. If there
2167         is  no such byte, -1 is returned. For anchored patterns, a last literal         is no such value, -1 is returned. For anchored patterns, a last literal
2168         byte is recorded only if it follows something of variable  length.  For         value is recorded only if it follows something of variable length.  For
2169         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
2170         /^a\dz\d/ the returned value is -1.         /^a\dz\d/ the returned value is -1.
2171    
2172             PCRE_INFO_MINLENGTH
2173    
2174           If the pattern was studied and a minimum length  for  matching  subject
2175           strings  was  computed,  its  value is returned. Otherwise the returned
2176           value is -1. The value is a number of characters, which in  UTF-8  mode
2177           may  be  different from the number of bytes. The fourth argument should
2178           point to an int variable. A non-negative value is a lower bound to  the
2179           length  of  any  matching  string. There may not be any strings of that
2180           length that do actually match, but every string that does match  is  at
2181           least that long.
2182    
2183           PCRE_INFO_NAMECOUNT           PCRE_INFO_NAMECOUNT
2184           PCRE_INFO_NAMEENTRYSIZE           PCRE_INFO_NAMEENTRYSIZE
2185           PCRE_INFO_NAMETABLE           PCRE_INFO_NAMETABLE
2186    
2187         PCRE supports the use of named as well as numbered capturing  parenthe-         PCRE  supports the use of named as well as numbered capturing parenthe-
2188         ses.  The names are just an additional way of identifying the parenthe-         ses. The names are just an additional way of identifying the  parenthe-
2189         ses, which still acquire numbers. Several convenience functions such as         ses, which still acquire numbers. Several convenience functions such as
2190         pcre_get_named_substring()  are  provided  for extracting captured sub-         pcre_get_named_substring() are provided for  extracting  captured  sub-
2191         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
2192         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
2193         pointers in the output vector (described with pcre_exec() below). To do         pointers in the output vector (described with pcre_exec() below). To do
2194         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
2195         described by these three values.         described by these three values.
2196    
2197         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
2198         gives the number of entries, and PCRE_INFO_NAMEENTRYSIZE gives the size         gives the number of entries, and PCRE_INFO_NAMEENTRYSIZE gives the size
2199         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
2200         depends  on the length of the longest name. PCRE_INFO_NAMETABLE returns         depends on the length of the longest name. PCRE_INFO_NAMETABLE  returns
2201         a pointer to the first entry of the table  (a  pointer  to  char).  The         a pointer to the first entry of the table. This is a pointer to char in
2202         first two bytes of each entry are the number of the capturing parenthe-         the 8-bit library, where the first two bytes of each entry are the num-
2203         sis, most significant byte first. The rest of the entry is  the  corre-         ber  of  the capturing parenthesis, most significant byte first. In the
2204         sponding  name,  zero  terminated. The names are in alphabetical order.         16-bit library, the pointer points to 16-bit data units, the  first  of
2205         When PCRE_DUPNAMES is set, duplicate names are in order of their paren-         which  contains  the  parenthesis  number. The rest of the entry is the
2206         theses  numbers.  For  example,  consider the following pattern (assume         corresponding name, zero terminated.
2207         PCRE_EXTENDED is  set,  so  white  space  -  including  newlines  -  is  
2208         ignored):         The names are in alphabetical order. Duplicate names may appear if  (?|
2209           is used to create multiple groups with the same number, as described in
2210           the section on duplicate subpattern numbers in  the  pcrepattern  page.
2211           Duplicate  names  for  subpatterns with different numbers are permitted
2212           only if PCRE_DUPNAMES is set. In all cases  of  duplicate  names,  they
2213           appear  in  the table in the order in which they were found in the pat-
2214           tern. In the absence of (?| this is the  order  of  increasing  number;
2215           when (?| is used this is not necessarily the case because later subpat-
2216           terns may have lower numbers.
2217    
2218           As a simple example of the name/number table,  consider  the  following
2219           pattern after compilation by the 8-bit library (assume PCRE_EXTENDED is
2220           set, so white space - including newlines - is ignored):
2221    
2222           (?<date> (?<year>(\d\d)?\d\d) -           (?<date> (?<year>(\d\d)?\d\d) -
2223           (?<month>\d\d) - (?<day>\d\d) )           (?<month>\d\d) - (?<day>\d\d) )
2224    
2225         There  are  four  named subpatterns, so the table has four entries, and         There are four named subpatterns, so the table has  four  entries,  and
2226         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,
2227         with non-printing bytes shows in hexadecimal, and undefined bytes shown         with non-printing bytes shows in hexadecimal, and undefined bytes shown
2228         as ??:         as ??:
2229    
# Line 1703  INFORMATION ABOUT A PATTERN Line 2232  INFORMATION ABOUT A PATTERN
2232           00 04 m  o  n  t  h  00           00 04 m  o  n  t  h  00
2233           00 02 y  e  a  r  00 ??           00 02 y  e  a  r  00 ??
2234    
2235         When writing code to extract data  from  named  subpatterns  using  the         When  writing  code  to  extract  data from named subpatterns using the
2236         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
2237         to be different for each compiled pattern.         to be different for each compiled pattern.
2238    
2239           PCRE_INFO_OKPARTIAL           PCRE_INFO_OKPARTIAL
2240    
2241         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
2242         The  fourth  argument  should point to an int variable. The pcrepartial         pcre_exec(), otherwise 0. The fourth argument should point  to  an  int
2243         documentation lists the restrictions that apply to patterns  when  par-         variable.  From  release  8.00,  this  always  returns  1,  because the
2244         tial matching is used.         restrictions that previously applied  to  partial  matching  have  been
2245           lifted.  The  pcrepartial documentation gives details of partial match-
2246           ing.
2247    
2248           PCRE_INFO_OPTIONS           PCRE_INFO_OPTIONS
2249    
2250         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
2251         fourth argument should point to an unsigned long  int  variable.  These         fourth  argument  should  point to an unsigned long int variable. These
2252         option bits are those specified in the call to pcre_compile(), modified         option bits are those specified in the call to pcre_compile(), modified
2253         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
2254         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
2255         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
2256         the  PCRE_EXTENDED option, the result is PCRE_CASELESS, PCRE_MULTILINE,         the PCRE_EXTENDED option, the result is PCRE_CASELESS,  PCRE_MULTILINE,
2257         and PCRE_EXTENDED.         and PCRE_EXTENDED.
2258    
2259         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
2260         alternatives begin with one of the following:         alternatives begin with one of the following:
2261    
2262           ^     unless PCRE_MULTILINE is set           ^     unless PCRE_MULTILINE is set
# Line 1739  INFORMATION ABOUT A PATTERN Line 2270  INFORMATION ABOUT A PATTERN
2270    
2271           PCRE_INFO_SIZE           PCRE_INFO_SIZE
2272    
2273         Return the size of the compiled pattern, that is, the  value  that  was         Return  the size of the compiled pattern in bytes (for both libraries).
2274         passed as the argument to pcre_malloc() when PCRE was getting memory in         The fourth argument should point to a size_t variable. This value  does
2275         which to place the compiled data. The fourth argument should point to a         not  include  the  size  of  the  pcre  structure  that  is returned by
2276         size_t variable.         pcre_compile(). The value that is passed as the argument  to  pcre_mal-
2277           loc()  when pcre_compile() is getting memory in which to place the com-
2278           piled data is the value returned by this option plus the  size  of  the
2279           pcre  structure. Studying a compiled pattern, with or without JIT, does
2280           not alter the value returned by this option.
2281    
2282           PCRE_INFO_STUDYSIZE           PCRE_INFO_STUDYSIZE
2283    
2284         Return the size of the data block pointed to by the study_data field in         Return the size in bytes of the data block pointed to by the study_data
2285         a pcre_extra block. That is,  it  is  the  value  that  was  passed  to         field  in  a  pcre_extra  block.  If pcre_extra is NULL, or there is no
2286         pcre_malloc() when PCRE was getting memory into which to place the data         study data, zero is returned. The fourth argument  should  point  to  a
2287         created by pcre_study(). The fourth argument should point to  a  size_t         size_t  variable. The study_data field is set by pcre_study() to record
2288         variable.         information that will speed  up  matching  (see  the  section  entitled
2289           "Studying a pattern" above). The format of the study_data block is pri-
2290           vate, but its length is made available via this option so that  it  can
2291  OBSOLETE INFO FUNCTION         be  saved  and  restored  (see  the  pcreprecompile  documentation  for
2292           details).
        int pcre_info(const pcre *code, int *optptr, int *firstcharptr);  
   
        The  pcre_info()  function is now obsolete because its interface is too  
        restrictive to return all the available data about a compiled  pattern.  
        New   programs   should  use  pcre_fullinfo()  instead.  The  yield  of  
        pcre_info() is the number of capturing subpatterns, or one of the  fol-  
        lowing negative numbers:  
   
          PCRE_ERROR_NULL       the argument code was NULL  
          PCRE_ERROR_BADMAGIC   the "magic number" was not found  
   
        If  the  optptr  argument is not NULL, a copy of the options with which  
        the pattern was compiled is placed in the integer  it  points  to  (see  
        PCRE_INFO_OPTIONS above).  
   
        If  the  pattern  is  not anchored and the firstcharptr argument is not  
        NULL, it is used to pass back information about the first character  of  
        any matched string (see PCRE_INFO_FIRSTBYTE above).  
2293    
2294    
2295  REFERENCE COUNTS  REFERENCE COUNTS
2296    
2297         int pcre_refcount(pcre *code, int adjust);         int pcre_refcount(pcre *code, int adjust);
2298    
2299         The  pcre_refcount()  function is used to maintain a reference count in         The pcre_refcount() function is used to maintain a reference  count  in
2300         the data block that contains a compiled pattern. It is provided for the         the data block that contains a compiled pattern. It is provided for the
2301         benefit  of  applications  that  operate  in an object-oriented manner,         benefit of applications that  operate  in  an  object-oriented  manner,
2302         where different parts of the application may be using the same compiled         where different parts of the application may be using the same compiled
2303         pattern, but you want to free the block when they are all done.         pattern, but you want to free the block when they are all done.
2304    
2305         When a pattern is compiled, the reference count field is initialized to         When a pattern is compiled, the reference count field is initialized to
2306         zero.  It is changed only by calling this function, whose action is  to         zero.   It is changed only by calling this function, whose action is to
2307         add  the  adjust  value  (which may be positive or negative) to it. The         add the adjust value (which may be positive or  negative)  to  it.  The
2308         yield of the function is the new value. However, the value of the count         yield of the function is the new value. However, the value of the count
2309         is  constrained to lie between 0 and 65535, inclusive. If the new value         is constrained to lie between 0 and 65535, inclusive. If the new  value
2310         is outside these limits, it is forced to the appropriate limit value.         is outside these limits, it is forced to the appropriate limit value.
2311    
2312         Except when it is zero, the reference count is not correctly  preserved         Except  when it is zero, the reference count is not correctly preserved
2313         if  a  pattern  is  compiled on one host and then transferred to a host         if a pattern is compiled on one host and then  transferred  to  a  host
2314         whose byte-order is different. (This seems a highly unlikely scenario.)         whose byte-order is different. (This seems a highly unlikely scenario.)
2315    
2316    
# Line 1805  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 2322  MATCHING A PATTERN: THE TRADITIONAL FUNC
2322    
2323         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
2324         compiled pattern, which is passed in the code argument. If the  pattern         compiled pattern, which is passed in the code argument. If the  pattern
2325         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
2326         argument. This function is the main matching facility of  the  library,         argument. You can call pcre_exec() with the same code and  extra  argu-
2327         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
2328         an alternative matching function, which is described below in the  sec-         strings with the same pattern.
2329         tion about the pcre_dfa_exec() function.  
2330           This function is the main matching facility  of  the  library,  and  it
2331           operates  in  a  Perl-like  manner. For specialist use there is also an
2332           alternative matching function, which is described below in the  section
2333           about the pcre_dfa_exec() function.
2334    
2335         In  most applications, the pattern will have been compiled (and option-         In  most applications, the pattern will have been compiled (and option-
2336         ally studied) in the same process that calls pcre_exec().  However,  it         ally studied) in the same process that calls pcre_exec().  However,  it
# Line 1841  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 2362  MATCHING A PATTERN: THE TRADITIONAL FUNC
2362    
2363           unsigned long int flags;           unsigned long int flags;
2364           void *study_data;           void *study_data;
2365             void *executable_jit;
2366           unsigned long int match_limit;           unsigned long int match_limit;
2367           unsigned long int match_limit_recursion;           unsigned long int match_limit_recursion;
2368           void *callout_data;           void *callout_data;
2369           const unsigned char *tables;           const unsigned char *tables;
2370             unsigned char **mark;
2371    
2372         The  flags  field  is a bitmap that specifies which of the other fields         In  the  16-bit  version  of  this  structure,  the mark field has type
2373           "PCRE_UCHAR16 **".
2374    
2375           The flags field is a bitmap that specifies which of  the  other  fields
2376         are set. The flag bits are:         are set. The flag bits are:
2377    
2378           PCRE_EXTRA_STUDY_DATA           PCRE_EXTRA_STUDY_DATA
2379             PCRE_EXTRA_EXECUTABLE_JIT
2380           PCRE_EXTRA_MATCH_LIMIT           PCRE_EXTRA_MATCH_LIMIT
2381           PCRE_EXTRA_MATCH_LIMIT_RECURSION           PCRE_EXTRA_MATCH_LIMIT_RECURSION
2382           PCRE_EXTRA_CALLOUT_DATA           PCRE_EXTRA_CALLOUT_DATA
2383           PCRE_EXTRA_TABLES           PCRE_EXTRA_TABLES
2384             PCRE_EXTRA_MARK
2385    
2386         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-
2387         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
2388         the appropriate flag bit. You should not set this yourself, but you may         returned  by pcre_study(), together with the appropriate flag bits. You
2389         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
2390         flag bits.         the other fields and their corresponding flag bits.
2391    
2392         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
2393         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
2394         match, but which have a very large number  of  possibilities  in  their         match,  but  which  have  a very large number of possibilities in their
2395         search  trees.  The  classic  example  is  the  use of nested unlimited         search trees. The classic example is a pattern that uses nested  unlim-
2396         repeats.         ited repeats.
2397    
2398         Internally, PCRE uses a function called match() which it calls  repeat-         Internally,  pcre_exec() uses a function called match(), which it calls
2399         edly  (sometimes  recursively). The limit set by match_limit is imposed         repeatedly (sometimes recursively). The limit  set  by  match_limit  is
2400         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,
2401         has  the  effect  of  limiting the amount of backtracking that can take         which has the effect of limiting the amount of  backtracking  that  can
2402         place. For patterns that are not anchored, the count restarts from zero         take place. For patterns that are not anchored, the count restarts from
2403         for each position in the subject string.         zero for each position in the subject string.
2404    
2405           When pcre_exec() is called with a pattern that was successfully studied
2406           with  the  PCRE_STUDY_JIT_COMPILE  option, the way that the matching is
2407           executed is entirely different. However, there is still the possibility
2408           of  runaway  matching  that  goes  on  for a very long time, and so the
2409           match_limit value is also used in this case (but in a different way) to
2410           limit how long the matching can continue.
2411    
2412         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
2413         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 2422  MATCHING A PATTERN: THE TRADITIONAL FUNC
2422         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-
2423         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.
2424    
2425         Limiting  the  recursion  depth  limits the amount of stack that can be         Limiting the recursion depth limits the amount of  machine  stack  that
2426         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
2427         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
2428           limit  is not relevant, and is ignored, if the pattern was successfully
2429         The  default  value  for  match_limit_recursion can be set when PCRE is         studied with PCRE_STUDY_JIT_COMPILE.
2430         built; the default default  is  the  same  value  as  the  default  for  
2431         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
2432         a  pcre_extra  block  in  which  match_limit_recursion  is   set,   and         built;  the  default  default  is  the  same  value  as the default for
2433         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
2434           a   pcre_extra   block  in  which  match_limit_recursion  is  set,  and
2435           PCRE_EXTRA_MATCH_LIMIT_RECURSION is set in  the  flags  field.  If  the
2436         limit is exceeded, pcre_exec() returns PCRE_ERROR_RECURSIONLIMIT.         limit is exceeded, pcre_exec() returns PCRE_ERROR_RECURSIONLIMIT.
2437    
2438         The pcre_callout field is used in conjunction with the  "callout"  fea-         The  callout_data  field is used in conjunction with the "callout" fea-
2439         ture, which is described in the pcrecallout documentation.         ture, and is described in the pcrecallout documentation.
2440    
2441         The  tables  field  is  used  to  pass  a  character  tables pointer to         The tables field  is  used  to  pass  a  character  tables  pointer  to
2442         pcre_exec(); this overrides the value that is stored with the  compiled         pcre_exec();  this overrides the value that is stored with the compiled
2443         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
2444         custom tables were supplied to pcre_compile() via  its  tableptr  argu-         custom  tables  were  supplied to pcre_compile() via its tableptr argu-
2445         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
2446         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-
2447         using  patterns  that  have been saved after compiling with an external         using patterns that have been saved after compiling  with  an  external
2448         set of tables, because the external tables  might  be  at  a  different         set  of  tables,  because  the  external tables might be at a different
2449         address  when  pcre_exec() is called. See the pcreprecompile documenta-         address when pcre_exec() is called. See the  pcreprecompile  documenta-
2450         tion for a discussion of saving compiled patterns for later use.         tion for a discussion of saving compiled patterns for later use.
2451    
2452           If  PCRE_EXTRA_MARK  is  set in the flags field, the mark field must be
2453           set to point to a suitable variable. If the pattern contains any  back-
2454           tracking  control verbs such as (*MARK:NAME), and the execution ends up
2455           with a name to pass back, a pointer to the  name  string  (zero  termi-
2456           nated)  is  placed  in  the  variable pointed to by the mark field. The
2457           names are within the compiled pattern; if you wish  to  retain  such  a
2458           name  you must copy it before freeing the memory of a compiled pattern.
2459           If there is no name to pass back, the variable pointed to by  the  mark
2460           field  is  set  to NULL. For details of the backtracking control verbs,
2461           see the section entitled "Backtracking control" in the pcrepattern doc-
2462           umentation.
2463    
2464     Option bits for pcre_exec()     Option bits for pcre_exec()
2465    
2466         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.
2467         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,
2468         PCRE_NOTBOL,   PCRE_NOTEOL,   PCRE_NOTEMPTY,   PCRE_NO_UTF8_CHECK   and         PCRE_NOTBOL,    PCRE_NOTEOL,    PCRE_NOTEMPTY,   PCRE_NOTEMPTY_ATSTART,
2469         PCRE_PARTIAL.         PCRE_NO_START_OPTIMIZE,  PCRE_NO_UTF8_CHECK,   PCRE_PARTIAL_SOFT,   and
2470           PCRE_PARTIAL_HARD.
2471    
2472           If the pattern was successfully studied with the PCRE_STUDY_JIT_COMPILE
2473           option,  the   only   supported   options   for   JIT   execution   are
2474           PCRE_NO_UTF8_CHECK,   PCRE_NOTBOL,   PCRE_NOTEOL,   PCRE_NOTEMPTY,  and
2475           PCRE_NOTEMPTY_ATSTART. Note in particular that partial matching is  not
2476           supported.  If an unsupported option is used, JIT execution is disabled
2477           and the normal interpretive code in pcre_exec() is run.
2478    
2479           PCRE_ANCHORED           PCRE_ANCHORED
2480    
2481         The  PCRE_ANCHORED  option  limits pcre_exec() to matching at the first         The PCRE_ANCHORED option limits pcre_exec() to matching  at  the  first
2482         matching position. If a pattern was  compiled  with  PCRE_ANCHORED,  or         matching  position.  If  a  pattern was compiled with PCRE_ANCHORED, or
2483         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
2484         unachored at matching time.         unachored at matching time.
2485    
2486           PCRE_BSR_ANYCRLF           PCRE_BSR_ANYCRLF
2487           PCRE_BSR_UNICODE           PCRE_BSR_UNICODE
2488    
2489         These options (which are mutually exclusive) control what the \R escape         These options (which are mutually exclusive) control what the \R escape
2490         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,
2491         or to match any Unicode newline sequence. These  options  override  the         or  to  match  any Unicode newline sequence. These options override the
2492         choice that was made or defaulted when the pattern was compiled.         choice that was made or defaulted when the pattern was compiled.
2493    
2494           PCRE_NEWLINE_CR           PCRE_NEWLINE_CR
# Line 1940  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 2497  MATCHING A PATTERN: THE TRADITIONAL FUNC
2497           PCRE_NEWLINE_ANYCRLF           PCRE_NEWLINE_ANYCRLF
2498           PCRE_NEWLINE_ANY           PCRE_NEWLINE_ANY
2499    
2500         These  options  override  the  newline  definition  that  was chosen or         These options override  the  newline  definition  that  was  chosen  or
2501         defaulted when the pattern was compiled. For details, see the  descrip-         defaulted  when the pattern was compiled. For details, see the descrip-
2502         tion  of  pcre_compile()  above.  During  matching,  the newline choice         tion of pcre_compile()  above.  During  matching,  the  newline  choice
2503         affects the behaviour of the dot, circumflex,  and  dollar  metacharac-         affects  the  behaviour  of the dot, circumflex, and dollar metacharac-
2504         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
2505         match failure for an unanchored pattern.         match failure for an unanchored pattern.
2506    
2507         When PCRE_NEWLINE_CRLF, PCRE_NEWLINE_ANYCRLF,  or  PCRE_NEWLINE_ANY  is         When  PCRE_NEWLINE_CRLF,  PCRE_NEWLINE_ANYCRLF,  or PCRE_NEWLINE_ANY is
2508         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-
2509         rent position is at a  CRLF  sequence,  and  the  pattern  contains  no         rent  position  is  at  a  CRLF  sequence,  and the pattern contains no
2510         explicit  matches  for  CR  or  LF  characters,  the  match position is         explicit matches for  CR  or  LF  characters,  the  match  position  is
2511         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
2512         CRLF.         CRLF.
2513    
2514         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
2515         expected. For example, if the  pattern  is  .+A  (and  the  PCRE_DOTALL         expected.  For  example,  if  the  pattern  is .+A (and the PCRE_DOTALL
2516         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
2517         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.
2518         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-
2519         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-
2520         acter after the first failure.         acter after the first failure.
2521    
2522         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
2523         those characters, or one of the \r or  \n  escape  sequences.  Implicit         those  characters,  or  one  of the \r or \n escape sequences. Implicit
2524         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
2525         LF in the characters that it matches).         LF in the characters that it matches).
2526    
2527         Notwithstanding the above, anomalous effects may still occur when  CRLF         Notwithstanding  the above, anomalous effects may still occur when CRLF
2528         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
2529         pattern.         pattern.
2530    
2531           PCRE_NOTBOL           PCRE_NOTBOL
2532    
2533         This option specifies that first character of the subject string is not         This option specifies that first character of the subject string is not
2534         the  beginning  of  a  line, so the circumflex metacharacter should not         the beginning of a line, so the  circumflex  metacharacter  should  not
2535         match before it. Setting this without PCRE_MULTILINE (at compile  time)         match  before it. Setting this without PCRE_MULTILINE (at compile time)
2536         causes  circumflex  never to match. This option affects only the behav-         causes circumflex never to match. This option affects only  the  behav-
2537         iour of the circumflex metacharacter. It does not affect \A.         iour of the circumflex metacharacter. It does not affect \A.
2538    
2539           PCRE_NOTEOL           PCRE_NOTEOL
2540    
2541         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
2542         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
2543         in multiline mode) a newline immediately before it. Setting this  with-         in  multiline mode) a newline immediately before it. Setting this with-
2544         out PCRE_MULTILINE (at compile time) causes dollar never to match. This         out PCRE_MULTILINE (at compile time) causes dollar never to match. This
2545         option affects only the behaviour of the dollar metacharacter. It  does         option  affects only the behaviour of the dollar metacharacter. It does
2546         not affect \Z or \z.         not affect \Z or \z.
2547    
2548           PCRE_NOTEMPTY           PCRE_NOTEMPTY
2549    
2550         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
2551         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
2552         the  alternatives  match  the empty string, the entire match fails. For         the alternatives match the empty string, the entire  match  fails.  For
2553         example, if the pattern         example, if the pattern
2554    
2555           a?b?           a?b?
2556    
2557         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
2558         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
2559         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-
2560         rences of "a" or "b".         rences of "a" or "b".
2561    
2562         Perl has no direct equivalent of PCRE_NOTEMPTY, but it does make a spe-           PCRE_NOTEMPTY_ATSTART
2563         cial case of a pattern match of the empty  string  within  its  split()  
2564         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
2565         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
2566         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.
2567         if that fails by advancing the starting offset (see below)  and  trying  
2568         an ordinary match again. There is some code that demonstrates how to do         Perl    has    no    direct    equivalent    of    PCRE_NOTEMPTY     or
2569         this in the pcredemo.c sample program.         PCRE_NOTEMPTY_ATSTART,  but  it  does  make a special case of a pattern
2570           match of the empty string within its split() function, and  when  using
2571           the  /g  modifier.  It  is  possible  to emulate Perl's behaviour after
2572           matching a null string by first trying the match again at the same off-
2573           set  with  PCRE_NOTEMPTY_ATSTART  and  PCRE_ANCHORED,  and then if that
2574           fails, by advancing the starting offset (see below) and trying an ordi-
2575           nary  match  again. There is some code that demonstrates how to do this
2576           in the pcredemo sample program. In the most general case, you  have  to
2577           check  to  see  if the newline convention recognizes CRLF as a newline,
2578           and if so, and the current character is CR followed by LF, advance  the
2579           starting offset by two characters instead of one.
2580    
2581             PCRE_NO_START_OPTIMIZE
2582    
2583           There  are a number of optimizations that pcre_exec() uses at the start
2584           of a match, in order to speed up the process. For  example,  if  it  is
2585           known that an unanchored match must start with a specific character, it
2586           searches the subject for that character, and fails  immediately  if  it
2587           cannot  find  it,  without actually running the main matching function.
2588           This means that a special item such as (*COMMIT) at the start of a pat-
2589           tern  is  not  considered until after a suitable starting point for the
2590           match has been found. When callouts or (*MARK) items are in use,  these
2591           "start-up" optimizations can cause them to be skipped if the pattern is
2592           never actually used. The start-up optimizations are in  effect  a  pre-
2593           scan of the subject that takes place before the pattern is run.
2594    
2595           The  PCRE_NO_START_OPTIMIZE option disables the start-up optimizations,
2596           possibly causing performance to suffer,  but  ensuring  that  in  cases
2597           where  the  result is "no match", the callouts do occur, and that items
2598           such as (*COMMIT) and (*MARK) are considered at every possible starting
2599           position  in  the  subject  string. If PCRE_NO_START_OPTIMIZE is set at
2600           compile time, it cannot be unset at matching time.
2601    
2602           Setting PCRE_NO_START_OPTIMIZE can change the  outcome  of  a  matching
2603           operation.  Consider the pattern
2604    
2605             (*COMMIT)ABC
2606    
2607           When  this  is  compiled, PCRE records the fact that a match must start
2608           with the character "A". Suppose the subject  string  is  "DEFABC".  The
2609           start-up  optimization  scans along the subject, finds "A" and runs the
2610           first match attempt from there. The (*COMMIT) item means that the  pat-
2611           tern  must  match the current starting position, which in this case, it
2612           does. However, if the same match  is  run  with  PCRE_NO_START_OPTIMIZE
2613           set,  the  initial  scan  along the subject string does not happen. The
2614           first match attempt is run starting  from  "D"  and  when  this  fails,
2615           (*COMMIT)  prevents  any  further  matches  being tried, so the overall
2616           result is "no match". If the pattern is studied,  more  start-up  opti-
2617           mizations  may  be  used. For example, a minimum length for the subject
2618           may be recorded. Consider the pattern
2619    
2620             (*MARK:A)(X|Y)
2621    
2622           The minimum length for a match is one  character.  If  the  subject  is
2623           "ABC",  there  will  be  attempts  to  match "ABC", "BC", "C", and then
2624           finally an empty string.  If the pattern is studied, the final  attempt
2625           does  not take place, because PCRE knows that the subject is too short,
2626           and so the (*MARK) is never encountered.  In this  case,  studying  the
2627           pattern  does  not  affect the overall match result, which is still "no
2628           match", but it does affect the auxiliary information that is returned.
2629    
2630           PCRE_NO_UTF8_CHECK           PCRE_NO_UTF8_CHECK
2631    
# Line 2017  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 2633  MATCHING A PATTERN: THE TRADITIONAL FUNC
2633         UTF-8  string is automatically checked when pcre_exec() is subsequently         UTF-8  string is automatically checked when pcre_exec() is subsequently
2634         called.  The value of startoffset is also checked  to  ensure  that  it         called.  The value of startoffset is also checked  to  ensure  that  it
2635         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
2636         the validity of UTF-8 strings in the section on UTF-8  support  in  the         the validity of UTF-8 strings in the pcreunicode page.  If  an  invalid
2637         main  pcre  page.  If  an  invalid  UTF-8  sequence  of bytes is found,         sequence   of   bytes   is   found,   pcre_exec()   returns  the  error
2638         pcre_exec() returns the error PCRE_ERROR_BADUTF8. If  startoffset  con-         PCRE_ERROR_BADUTF8 or, if PCRE_PARTIAL_HARD is set and the problem is a
2639         tains an invalid value, PCRE_ERROR_BADUTF8_OFFSET is returned.         truncated character at the end of the subject, PCRE_ERROR_SHORTUTF8. In
2640           both cases, information about the precise nature of the error may  also
2641         If  you  already  know that your subject is valid, and you want to skip         be  returned (see the descriptions of these errors in the section enti-
2642         these   checks   for   performance   reasons,   you   can    set    the         tled Error return values from pcre_exec() below).  If startoffset  con-
2643         PCRE_NO_UTF8_CHECK  option  when calling pcre_exec(). You might want to         tains a value that does not point to the start of a UTF-8 character (or
2644         do this for the second and subsequent calls to pcre_exec() if  you  are         to the end of the subject), PCRE_ERROR_BADUTF8_OFFSET is returned.
2645         making  repeated  calls  to  find  all  the matches in a single subject  
2646         string. However, you should be  sure  that  the  value  of  startoffset         If you already know that your subject is valid, and you  want  to  skip
2647         points  to  the  start of a UTF-8 character. When PCRE_NO_UTF8_CHECK is         these    checks    for   performance   reasons,   you   can   set   the
2648         set, the effect of passing an invalid UTF-8 string as a subject,  or  a         PCRE_NO_UTF8_CHECK option when calling pcre_exec(). You might  want  to
2649         value  of startoffset that does not point to the start of a UTF-8 char-         do  this  for the second and subsequent calls to pcre_exec() if you are
2650         acter, is undefined. Your program may crash.         making repeated calls to find all  the  matches  in  a  single  subject
2651           string.  However,  you  should  be  sure  that the value of startoffset
2652           PCRE_PARTIAL         points to the start of a character (or the end of  the  subject).  When
2653           PCRE_NO_UTF8_CHECK is set, the effect of passing an invalid string as a
2654         This option turns on the  partial  matching  feature.  If  the  subject         subject or an invalid value of startoffset is undefined.  Your  program
2655         string  fails to match the pattern, but at some point during the match-         may crash.
2656         ing process the end of the subject was reached (that  is,  the  subject  
2657         partially  matches  the  pattern and the failure to match occurred only           PCRE_PARTIAL_HARD
2658         because there were not enough subject characters), pcre_exec()  returns           PCRE_PARTIAL_SOFT
2659         PCRE_ERROR_PARTIAL  instead of PCRE_ERROR_NOMATCH. When PCRE_PARTIAL is  
2660         used, there are restrictions on what may appear in the  pattern.  These         These  options turn on the partial matching feature. For backwards com-
2661         are discussed in the pcrepartial documentation.         patibility, PCRE_PARTIAL is a synonym for PCRE_PARTIAL_SOFT. A  partial
2662           match  occurs if the end of the subject string is reached successfully,
2663           but there are not enough subject characters to complete the  match.  If
2664           this happens when PCRE_PARTIAL_SOFT (but not PCRE_PARTIAL_HARD) is set,
2665           matching continues by testing any remaining alternatives.  Only  if  no
2666           complete  match  can be found is PCRE_ERROR_PARTIAL returned instead of
2667           PCRE_ERROR_NOMATCH. In other words,  PCRE_PARTIAL_SOFT  says  that  the
2668           caller  is  prepared to handle a partial match, but only if no complete
2669           match can be found.
2670    
2671           If PCRE_PARTIAL_HARD is set, it overrides  PCRE_PARTIAL_SOFT.  In  this
2672           case,  if  a  partial  match  is found, pcre_exec() immediately returns
2673           PCRE_ERROR_PARTIAL, without  considering  any  other  alternatives.  In
2674           other  words, when PCRE_PARTIAL_HARD is set, a partial match is consid-
2675           ered to be more important that an alternative complete match.
2676    
2677           In both cases, the portion of the string that was  inspected  when  the
2678           partial match was found is set as the first matching string. There is a
2679           more detailed discussion of partial and  multi-segment  matching,  with
2680           examples, in the pcrepartial documentation.
2681    
2682     The string to be matched by pcre_exec()     The string to be matched by pcre_exec()
2683    
2684         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
2685         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.
2686         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,
2687         Unlike the pattern string, the subject may contain binary  zero  bytes.         pcre_exec() returns PCRE_ERROR_BADOFFSET. When the starting  offset  is
2688         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,
2689         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
2690           must  point  to  the start of a UTF-8 character (or the end of the sub-
2691         A non-zero starting offset is useful when searching for  another  match         ject). Unlike the pattern string, the subject may contain  binary  zero
2692         in  the same subject by calling pcre_exec() again after a previous suc-         bytes.
2693         cess.  Setting startoffset differs from just passing over  a  shortened  
2694         string  and  setting  PCRE_NOTBOL  in the case of a pattern that begins         A  non-zero  starting offset is useful when searching for another match
2695           in the same subject by calling pcre_exec() again after a previous  suc-
2696           cess.   Setting  startoffset differs from just passing over a shortened
2697           string and setting PCRE_NOTBOL in the case of  a  pattern  that  begins
2698         with any kind of lookbehind. For example, consider the pattern         with any kind of lookbehind. For example, consider the pattern
2699    
2700           \Biss\B           \Biss\B
2701    
2702         which finds occurrences of "iss" in the middle of  words.  (\B  matches         which  finds  occurrences  of "iss" in the middle of words. (\B matches
2703         only  if  the  current position in the subject is not a word boundary.)         only if the current position in the subject is not  a  word  boundary.)
2704         When applied to the string "Mississipi" the first call  to  pcre_exec()         When  applied  to the string "Mississipi" the first call to pcre_exec()
2705         finds  the  first  occurrence. If pcre_exec() is called again with just         finds the first occurrence. If pcre_exec() is called  again  with  just
2706         the remainder of the subject,  namely  "issipi",  it  does  not  match,         the  remainder  of  the  subject,  namely  "issipi", it does not match,
2707         because \B is always false at the start of the subject, which is deemed         because \B is always false at the start of the subject, which is deemed
2708         to be a word boundary. However, if pcre_exec()  is  passed  the  entire         to  be  a  word  boundary. However, if pcre_exec() is passed the entire
2709         string again, but with startoffset set to 4, it finds the second occur-         string again, but with startoffset set to 4, it finds the second occur-
2710         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
2711         discover that it is preceded by a letter.         discover that it is preceded by a letter.
2712    
2713           Finding all the matches in a subject is tricky  when  the  pattern  can
2714           match an empty string. It is possible to emulate Perl's /g behaviour by
2715           first  trying  the  match  again  at  the   same   offset,   with   the
2716           PCRE_NOTEMPTY_ATSTART  and  PCRE_ANCHORED  options,  and  then  if that
2717           fails, advancing the starting  offset  and  trying  an  ordinary  match
2718           again. There is some code that demonstrates how to do this in the pcre-
2719           demo sample program. In the most general case, you have to check to see
2720           if  the newline convention recognizes CRLF as a newline, and if so, and
2721           the current character is CR followed by LF, advance the starting offset
2722           by two characters instead of one.
2723    
2724         If  a  non-zero starting offset is passed when the pattern is anchored,         If  a  non-zero starting offset is passed when the pattern is anchored,
2725         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
2726         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
# Line 2087  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 2736  MATCHING A PATTERN: THE TRADITIONAL FUNC
2736         string.  PCRE  supports several other kinds of parenthesized subpattern         string.  PCRE  supports several other kinds of parenthesized subpattern
2737         that do not cause substrings to be captured.         that do not cause substrings to be captured.
2738    
2739         Captured substrings are returned to the caller via a vector of  integer         Captured substrings are returned to the caller via a vector of integers
2740         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-
2741         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:
2742         Note: this argument is NOT the size of ovector in bytes.         this argument is NOT the size of ovector in bytes.
2743    
2744         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-
2745         strings, each substring using a pair of integers. The  remaining  third         strings, each substring using a pair of integers. The  remaining  third
2746         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-
2747         turing subpatterns, and is not available for passing back  information.         turing subpatterns, and is not available for passing back  information.
2748         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
2749         it is not, it is rounded down.         it is not, it is rounded down.
2750    
2751         When a match is successful, information about  captured  substrings  is         When a match is successful, information about  captured  substrings  is
2752         returned  in  pairs  of integers, starting at the beginning of ovector,         returned  in  pairs  of integers, starting at the beginning of ovector,
2753         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
2754         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
2755         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
2756         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
2757         tor[1], identify the portion of  the  subject  string  matched  by  the         byte offsets, even in UTF-8 mode. They are not character counts.
2758         entire  pattern.  The next pair is used for the first capturing subpat-  
2759         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
2760         highest numbered pair that has been set. For example, if two substrings         portion  of  the subject string matched by the entire pattern. The next
2761         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
2762         subpatterns,  the return value from a successful match is 1, indicating         returned by pcre_exec() is one more than the highest numbered pair that
2763         that just the first pair of offsets has been set.         has been set.  For example, if two substrings have been  captured,  the
2764           returned  value is 3. If there are no capturing subpatterns, the return
2765           value from a successful match is 1, indicating that just the first pair
2766           of offsets has been set.
2767    
2768         If a capturing subpattern is matched repeatedly, it is the last portion         If a capturing subpattern is matched repeatedly, it is the last portion
2769         of the string that it matched that is returned.         of the string that it matched that is returned.
2770    
2771         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,
2772         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
2773         function  returns a value of zero. In particular, if the substring off-         function returns a value of zero. If neither the actual string  matched
2774         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
2775         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-
2776         references and the ovector is not big enough to  remember  the  related         tern  contains  back  references  and  the ovector is not big enough to
2777         substrings,  PCRE has to get additional memory for use during matching.         remember the related substrings, PCRE has to get additional memory  for
2778         Thus it is usually advisable to supply an ovector.         use  during matching. Thus it is usually advisable to supply an ovector
2779           of reasonable size.
2780         The pcre_info() function can be used to find  out  how  many  capturing  
2781         subpatterns  there  are  in  a  compiled pattern. The smallest size for         There are some cases where zero is returned  (indicating  vector  over-
2782         ovector that will allow for n captured substrings, in addition  to  the         flow)  when  in fact the vector is exactly the right size for the final
2783           match. For example, consider the pattern
2784    
2785             (a)(?:(b)c|bd)
2786    
2787           If a vector of 6 elements (allowing for only 1 captured  substring)  is
2788           given with subject string "abd", pcre_exec() will try to set the second
2789           captured string, thereby recording a vector overflow, before failing to
2790           match  "c"  and  backing  up  to  try  the second alternative. The zero
2791           return, however, does correctly indicate that  the  maximum  number  of
2792           slots (namely 2) have been filled. In similar cases where there is tem-
2793           porary overflow, but the final number of used slots  is  actually  less
2794           than the maximum, a non-zero value is returned.
2795    
2796           The pcre_fullinfo() function can be used to find out how many capturing
2797           subpatterns there are in a compiled  pattern.  The  smallest  size  for
2798           ovector  that  will allow for n captured substrings, in addition to the
2799         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.
2800    
2801         It  is  possible for capturing subpattern number n+1 to match some part         It is possible for capturing subpattern number n+1 to match  some  part
2802         of the subject when subpattern n has not been used at all. For example,         of the subject when subpattern n has not been used at all. For example,
2803         if  the  string  "abc"  is  matched against the pattern (a|(z))(bc) the         if the string "abc" is matched  against  the  pattern  (a|(z))(bc)  the
2804         return from the function is 4, and subpatterns 1 and 3 are matched, but         return from the function is 4, and subpatterns 1 and 3 are matched, but
2805         2  is  not.  When  this happens, both values in the offset pairs corre-         2 is not. When this happens, both values in  the  offset  pairs  corre-
2806         sponding to unused subpatterns are set to -1.         sponding to unused subpatterns are set to -1.
2807    
2808         Offset values that correspond to unused subpatterns at the end  of  the         Offset  values  that correspond to unused subpatterns at the end of the
2809         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
2810         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
2811         matched.  The  return  from the function is 2, because the highest used         matched. The return from the function is 2, because  the  highest  used
2812         capturing subpattern number is 1. However, you can refer to the offsets         capturing  subpattern  number  is 1, and the offsets for for the second
2813         for  the  second  and third capturing subpatterns if you wish (assuming         and third capturing subpatterns (assuming the vector is  large  enough,
2814         the vector is large enough, of course).         of course) are set to -1.
2815    
2816           Note:  Elements  in  the first two-thirds of ovector that do not corre-
2817           spond to capturing parentheses in the pattern are never  changed.  That
2818           is,  if  a pattern contains n capturing parentheses, no more than ovec-
2819           tor[0] to ovector[2n+1] are set by pcre_exec(). The other elements  (in
2820           the first two-thirds) retain whatever values they previously had.
2821    
2822         Some convenience functions are provided  for  extracting  the  captured         Some  convenience  functions  are  provided for extracting the captured
2823         substrings as separate strings. These are described below.         substrings as separate strings. These are described below.
2824    
2825     Error return values from pcre_exec()     Error return values from pcre_exec()
2826    
2827         If  pcre_exec()  fails, it returns a negative number. The following are         If pcre_exec() fails, it returns a negative number. The  following  are
2828         defined in the header file:         defined in the header file:
2829    
2830           PCRE_ERROR_NOMATCH        (-1)           PCRE_ERROR_NOMATCH        (-1)
# Line 2159  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 2833  MATCHING A PATTERN: THE TRADITIONAL FUNC
2833    
2834           PCRE_ERROR_NULL           (-2)           PCRE_ERROR_NULL           (-2)
2835    
2836         Either code or subject was passed as NULL,  or  ovector  was  NULL  and         Either  code  or  subject  was  passed as NULL, or ovector was NULL and
2837         ovecsize was not zero.         ovecsize was not zero.
2838    
2839           PCRE_ERROR_BADOPTION      (-3)           PCRE_ERROR_BADOPTION      (-3)
# Line 2168  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 2842  MATCHING A PATTERN: THE TRADITIONAL FUNC
2842    
2843           PCRE_ERROR_BADMAGIC       (-4)           PCRE_ERROR_BADMAGIC       (-4)
2844    
2845         PCRE  stores a 4-byte "magic number" at the start of the compiled code,         PCRE stores a 4-byte "magic number" at the start of the compiled  code,
2846         to catch the case when it is passed a junk pointer and to detect when a         to catch the case when it is passed a junk pointer and to detect when a
2847         pattern that was compiled in an environment of one endianness is run in         pattern that was compiled in an environment of one endianness is run in
2848         an environment with the other endianness. This is the error  that  PCRE         an  environment  with the other endianness. This is the error that PCRE
2849         gives when the magic number is not present.         gives when the magic number is not present.
2850    
2851           PCRE_ERROR_UNKNOWN_OPCODE (-5)           PCRE_ERROR_UNKNOWN_OPCODE (-5)
2852    
2853         While running the pattern match, an unknown item was encountered in the         While running the pattern match, an unknown item was encountered in the
2854         compiled pattern. This error could be caused by a bug  in  PCRE  or  by         compiled  pattern.  This  error  could be caused by a bug in PCRE or by
2855         overwriting of the compiled pattern.         overwriting of the compiled pattern.
2856    
2857           PCRE_ERROR_NOMEMORY       (-6)           PCRE_ERROR_NOMEMORY       (-6)
2858    
2859         If  a  pattern contains back references, but the ovector that is passed         If a pattern contains back references, but the ovector that  is  passed
2860         to pcre_exec() is not big enough to remember the referenced substrings,         to pcre_exec() is not big enough to remember the referenced substrings,
2861         PCRE  gets  a  block of memory at the start of matching to use for this         PCRE gets a block of memory at the start of matching to  use  for  this
2862         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
2863         memory is automatically freed at the end of matching.         memory is automatically freed at the end of matching.
2864    
2865           This error is also given if pcre_stack_malloc() fails  in  pcre_exec().
2866           This  can happen only when PCRE has been compiled with --disable-stack-
2867           for-recursion.
2868    
2869           PCRE_ERROR_NOSUBSTRING    (-7)           PCRE_ERROR_NOSUBSTRING    (-7)
2870    
2871         This  error is used by the pcre_copy_substring(), pcre_get_substring(),         This error is used by the pcre_copy_substring(),  pcre_get_substring(),
2872         and  pcre_get_substring_list()  functions  (see  below).  It  is  never         and  pcre_get_substring_list()  functions  (see  below).  It  is  never
2873         returned by pcre_exec().         returned by pcre_exec().
2874    
2875           PCRE_ERROR_MATCHLIMIT     (-8)           PCRE_ERROR_MATCHLIMIT     (-8)
2876    
2877         The  backtracking  limit,  as  specified  by the match_limit field in a         The backtracking limit, as specified by  the  match_limit  field  in  a
2878         pcre_extra structure (or defaulted) was reached.  See  the  description         pcre_extra  structure  (or  defaulted) was reached. See the description
2879         above.         above.
2880    
2881           PCRE_ERROR_CALLOUT        (-9)           PCRE_ERROR_CALLOUT        (-9)
2882    
2883         This error is never generated by pcre_exec() itself. It is provided for         This error is never generated by pcre_exec() itself. It is provided for
2884         use by callout functions that want to yield a distinctive  error  code.         use  by  callout functions that want to yield a distinctive error code.
2885         See the pcrecallout documentation for details.         See the pcrecallout documentation for details.
2886    
2887           PCRE_ERROR_BADUTF8        (-10)           PCRE_ERROR_BADUTF8        (-10)
2888    
2889         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
2890         subject.         subject,  and the PCRE_NO_UTF8_CHECK option was not set. If the size of
2891           the output vector (ovecsize) is at least 2,  the  byte  offset  to  the
2892           start  of  the  the invalid UTF-8 character is placed in the first ele-
2893           ment, and a reason code is placed in the  second  element.  The  reason
2894           codes are listed in the following section.  For backward compatibility,
2895           if PCRE_PARTIAL_HARD is set and the problem is a truncated UTF-8  char-
2896           acter   at   the   end   of   the   subject  (reason  codes  1  to  5),
2897           PCRE_ERROR_SHORTUTF8 is returned instead of PCRE_ERROR_BADUTF8.
2898    
2899           PCRE_ERROR_BADUTF8_OFFSET (-11)           PCRE_ERROR_BADUTF8_OFFSET (-11)
2900    
2901         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
2902         value  of startoffset did not point to the beginning of a UTF-8 charac-         found  to be valid (the PCRE_NO_UTF8_CHECK option was not set), but the
2903         ter.         value of startoffset did not point to the beginning of a UTF-8  charac-
2904           ter or the end of the subject.
2905    
2906           PCRE_ERROR_PARTIAL        (-12)           PCRE_ERROR_PARTIAL        (-12)
2907    
2908         The subject string did not match, but it did match partially.  See  the         The  subject  string did not match, but it did match partially. See the
2909         pcrepartial documentation for details of partial matching.         pcrepartial documentation for details of partial matching.
2910    
2911           PCRE_ERROR_BADPARTIAL     (-13)           PCRE_ERROR_BADPARTIAL     (-13)
2912    
2913         The  PCRE_PARTIAL  option  was  used with a compiled pattern containing         This code is no longer in  use.  It  was  formerly  returned  when  the
2914         items that are not supported for partial matching. See the  pcrepartial         PCRE_PARTIAL  option  was used with a compiled pattern containing items
2915         documentation for details of partial matching.         that were  not  supported  for  partial  matching.  From  release  8.00
2916           onwards, there are no restrictions on partial matching.
2917    
2918           PCRE_ERROR_INTERNAL       (-14)           PCRE_ERROR_INTERNAL       (-14)
2919    
# Line 2235  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 2922  MATCHING A PATTERN: THE TRADITIONAL FUNC
2922    
2923           PCRE_ERROR_BADCOUNT       (-15)           PCRE_ERROR_BADCOUNT       (-15)
2924    
2925         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.
2926    
2927           PCRE_ERROR_RECURSIONLIMIT (-21)           PCRE_ERROR_RECURSIONLIMIT (-21)
2928    
2929         The internal recursion limit, as specified by the match_limit_recursion         The internal recursion limit, as specified by the match_limit_recursion
2930         field in a pcre_extra structure (or defaulted)  was  reached.  See  the         field  in  a  pcre_extra  structure (or defaulted) was reached. See the
2931         description above.         description above.
2932    
2933           PCRE_ERROR_BADNEWLINE     (-23)           PCRE_ERROR_BADNEWLINE     (-23)
2934    
2935         An invalid combination of PCRE_NEWLINE_xxx options was given.         An invalid combination of PCRE_NEWLINE_xxx options was given.
2936    
2937             PCRE_ERROR_BADOFFSET      (-24)
2938    
2939           The value of startoffset was negative or greater than the length of the
2940           subject, that is, the value in length.
2941    
2942             PCRE_ERROR_SHORTUTF8      (-25)
2943    
2944           This  error  is returned instead of PCRE_ERROR_BADUTF8 when the subject
2945           string ends with a truncated UTF-8 character and the  PCRE_PARTIAL_HARD
2946           option  is  set.   Information  about  the  failure  is returned as for
2947           PCRE_ERROR_BADUTF8. It is in fact sufficient to detect this  case,  but
2948           this  special error code for PCRE_PARTIAL_HARD precedes the implementa-
2949           tion of returned information; it is retained for backwards  compatibil-
2950           ity.
2951    
2952             PCRE_ERROR_RECURSELOOP    (-26)
2953    
2954           This error is returned when pcre_exec() detects a recursion loop within
2955           the pattern. Specifically, it means that either the whole pattern or  a
2956           subpattern  has been called recursively for the second time at the same
2957           position in the subject string. Some simple patterns that might do this
2958           are  detected  and faulted at compile time, but more complicated cases,
2959           in particular mutual recursions between two different subpatterns, can-
2960           not be detected until run time.
2961    
2962             PCRE_ERROR_JIT_STACKLIMIT (-27)
2963    
2964           This  error  is  returned  when a pattern that was successfully studied
2965           using the PCRE_STUDY_JIT_COMPILE option is being matched, but the  mem-
2966           ory  available  for  the  just-in-time  processing  stack  is not large
2967           enough. See the pcrejit documentation for more details.
2968    
2969             PCRE_ERROR_BADMODE (-28)
2970    
2971           This error is given if a pattern that was compiled by the 8-bit library
2972           is passed to a 16-bit library function, or vice versa.
2973    
2974             PCRE_ERROR_BADENDIANNESS (-29)
2975    
2976           This  error  is  given  if  a  pattern  that  was compiled and saved is
2977           reloaded on a host with  different  endianness.  The  utility  function
2978           pcre_pattern_to_host_byte_order() can be used to convert such a pattern
2979           so that it runs on the new host.
2980    
2981         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().
2982    
2983       Reason codes for invalid UTF-8 strings
2984    
2985           This section applies only  to  the  8-bit  library.  The  corresponding
2986           information for the 16-bit library is given in the pcre16 page.
2987    
2988           When pcre_exec() returns either PCRE_ERROR_BADUTF8 or PCRE_ERROR_SHORT-
2989           UTF8, and the size of the output vector (ovecsize) is at least  2,  the
2990           offset  of  the  start  of the invalid UTF-8 character is placed in the
2991           first output vector element (ovector[0]) and a reason code is placed in
2992           the  second  element  (ovector[1]). The reason codes are given names in
2993           the pcre.h header file:
2994    
2995             PCRE_UTF8_ERR1
2996             PCRE_UTF8_ERR2
2997             PCRE_UTF8_ERR3
2998             PCRE_UTF8_ERR4
2999             PCRE_UTF8_ERR5
3000    
3001           The string ends with a truncated UTF-8 character;  the  code  specifies
3002           how  many bytes are missing (1 to 5). Although RFC 3629 restricts UTF-8
3003           characters to be no longer than 4 bytes, the  encoding  scheme  (origi-
3004           nally  defined  by  RFC  2279)  allows  for  up to 6 bytes, and this is
3005           checked first; hence the possibility of 4 or 5 missing bytes.
3006    
3007             PCRE_UTF8_ERR6
3008             PCRE_UTF8_ERR7
3009             PCRE_UTF8_ERR8
3010             PCRE_UTF8_ERR9
3011             PCRE_UTF8_ERR10
3012    
3013           The two most significant bits of the 2nd, 3rd, 4th, 5th, or 6th byte of
3014           the  character  do  not have the binary value 0b10 (that is, either the
3015           most significant bit is 0, or the next bit is 1).
3016    
3017             PCRE_UTF8_ERR11
3018             PCRE_UTF8_ERR12
3019    
3020           A character that is valid by the RFC 2279 rules is either 5 or 6  bytes
3021           long; these code points are excluded by RFC 3629.
3022    
3023             PCRE_UTF8_ERR13
3024    
3025           A  4-byte character has a value greater than 0x10fff; these code points
3026           are excluded by RFC 3629.
3027    
3028             PCRE_UTF8_ERR14
3029    
3030           A 3-byte character has a value in the  range  0xd800  to  0xdfff;  this
3031           range  of code points are reserved by RFC 3629 for use with UTF-16, and
3032           so are excluded from UTF-8.
3033    
3034             PCRE_UTF8_ERR15
3035             PCRE_UTF8_ERR16
3036             PCRE_UTF8_ERR17
3037             PCRE_UTF8_ERR18
3038             PCRE_UTF8_ERR19
3039    
3040           A 2-, 3-, 4-, 5-, or 6-byte character is "overlong", that is, it  codes
3041           for  a  value that can be represented by fewer bytes, which is invalid.
3042           For example, the two bytes 0xc0, 0xae give the value 0x2e,  whose  cor-
3043           rect coding uses just one byte.
3044    
3045             PCRE_UTF8_ERR20
3046    
3047           The two most significant bits of the first byte of a character have the
3048           binary value 0b10 (that is, the most significant bit is 1 and the  sec-
3049           ond  is  0). Such a byte can only validly occur as the second or subse-
3050           quent byte of a multi-byte character.
3051    
3052             PCRE_UTF8_ERR21
3053    
3054           The first byte of a character has the value 0xfe or 0xff. These  values
3055           can never occur in a valid UTF-8 string.
3056    
3057    
3058  EXTRACTING CAPTURED SUBSTRINGS BY NUMBER  EXTRACTING CAPTURED SUBSTRINGS BY NUMBER
3059    
# Line 2385  EXTRACTING CAPTURED SUBSTRINGS BY NAME Line 3190  EXTRACTING CAPTURED SUBSTRINGS BY NAME
3190         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
3191         behaviour may not be what you want (see the next section).         behaviour may not be what you want (see the next section).
3192    
3193           Warning: If the pattern uses the (?| feature to set up multiple subpat-
3194           terns with the same number, as described in the  section  on  duplicate
3195           subpattern  numbers  in  the  pcrepattern page, you cannot use names to
3196           distinguish the different subpatterns, because names are  not  included
3197           in  the compiled code. The matching process uses only numbers. For this
3198           reason, the use of different names for subpatterns of the  same  number
3199           causes an error at compile time.
3200    
3201    
3202  DUPLICATE SUBPATTERN NAMES  DUPLICATE SUBPATTERN NAMES
3203    
# Line 2392  DUPLICATE SUBPATTERN NAMES Line 3205  DUPLICATE SUBPATTERN NAMES
3205              const char *name, char **first, char **last);              const char *name, char **first, char **last);
3206    
3207         When  a  pattern  is  compiled with the PCRE_DUPNAMES option, names for         When  a  pattern  is  compiled with the PCRE_DUPNAMES option, names for
3208         subpatterns are not required to  be  unique.  Normally,  patterns  with         subpatterns are not required to be unique. (Duplicate names are  always
3209         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 (?|
3210         subpatterns participates. An example is shown in the pcrepattern  docu-         feature. Indeed, if such subpatterns are named, they  are  required  to
3211         mentation.         use the same names.)
3212    
3213           Normally, patterns with duplicate names are such that in any one match,
3214           only one of the named subpatterns participates. An example is shown  in
3215           the pcrepattern documentation.
3216    
3217         When    duplicates   are   present,   pcre_copy_named_substring()   and         When    duplicates   are   present,   pcre_copy_named_substring()   and
3218         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 3229  DUPLICATE SUBPATTERN NAMES
3229         the  name-to-number  table  for  the  given  name.  The function itself         the  name-to-number  table  for  the  given  name.  The function itself
3230         returns the length of each entry,  or  PCRE_ERROR_NOSUBSTRING  (-7)  if         returns the length of each entry,  or  PCRE_ERROR_NOSUBSTRING  (-7)  if
3231         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-
3232         tion entitled Information about a  pattern.   Given  all  the  relevant         tion entitled Information about a pattern above.  Given all  the  rele-
3233         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
3234         the captured data, if any.         hence the captured data, if any.
3235    
3236    
3237  FINDING ALL POSSIBLE MATCHES  FINDING ALL POSSIBLE MATCHES
# Line 2448  MATCHING A PATTERN: THE ALTERNATIVE FUNC Line 3265  MATCHING A PATTERN: THE ALTERNATIVE FUNC
3265         characteristics to the normal algorithm, and  is  not  compatible  with         characteristics to the normal algorithm, and  is  not  compatible  with
3266         Perl.  Some  of the features of PCRE patterns are not supported. Never-         Perl.  Some  of the features of PCRE patterns are not supported. Never-
3267         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
3268         a discussion of the two matching algorithms, see the pcrematching docu-         a  discussion  of  the  two matching algorithms, and a list of features
3269         mentation.         that pcre_dfa_exec() does not support, see the pcrematching  documenta-
3270           tion.
3271    
3272         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
3273         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-
3274         ent way, and this is described below. The other  common  arguments  are         ent  way,  and  this is described below. The other common arguments are
3275         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
3276         repeated here.         repeated here.
3277    
3278         The two additional arguments provide workspace for  the  function.  The         The  two  additional  arguments provide workspace for the function. The
3279         workspace  vector  should  contain at least 20 elements. It is used for         workspace vector should contain at least 20 elements. It  is  used  for
3280         keeping  track  of  multiple  paths  through  the  pattern  tree.  More         keeping  track  of  multiple  paths  through  the  pattern  tree.  More
3281         workspace  will  be  needed for patterns and subjects where there are a         workspace will be needed for patterns and subjects where  there  are  a
3282         lot of potential matches.         lot of potential matches.
3283    
3284         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 3300  MATCHING A PATTERN: THE ALTERNATIVE FUNC
3300    
3301     Option bits for pcre_dfa_exec()     Option bits for pcre_dfa_exec()
3302    
3303         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
3304         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-
3305         LINE_xxx, PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY,  PCRE_NO_UTF8_CHECK,         LINE_xxx,        PCRE_NOTBOL,        PCRE_NOTEOL,        PCRE_NOTEMPTY,
3306         PCRE_PARTIAL, PCRE_DFA_SHORTEST, and PCRE_DFA_RESTART. All but the last         PCRE_NOTEMPTY_ATSTART,      PCRE_NO_UTF8_CHECK,       PCRE_BSR_ANYCRLF,
3307         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-
3308         not repeated here.         TIAL_SOFT, PCRE_DFA_SHORTEST, and PCRE_DFA_RESTART.  All but  the  last
3309           four  of  these  are  exactly  the  same  as  for pcre_exec(), so their
3310           PCRE_PARTIAL         description is not repeated here.
3311    
3312         This  has  the  same general effect as it does for pcre_exec(), but the           PCRE_PARTIAL_HARD
3313         details  are  slightly  different.  When  PCRE_PARTIAL   is   set   for           PCRE_PARTIAL_SOFT
3314         pcre_dfa_exec(),  the  return code PCRE_ERROR_NOMATCH is converted into  
3315         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
3316         been no complete matches, but there is still at least one matching pos-         details  are  slightly  different.  When  PCRE_PARTIAL_HARD  is set for
3317         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-
3318         set as the first matching string.         ject  is  reached  and there is still at least one matching possibility
3319           that requires additional characters. This happens even if some complete
3320           matches have also been found. When PCRE_PARTIAL_SOFT is set, the return
3321           code PCRE_ERROR_NOMATCH is converted into PCRE_ERROR_PARTIAL if the end
3322           of  the  subject  is  reached, there have been no complete matches, but
3323           there is still at least one matching possibility. The  portion  of  the
3324           string  that  was inspected when the longest partial match was found is
3325           set as the first matching string  in  both  cases.   There  is  a  more
3326           detailed  discussion  of partial and multi-segment matching, with exam-
3327           ples, in the pcrepartial documentation.
3328    
3329           PCRE_DFA_SHORTEST           PCRE_DFA_SHORTEST
3330    
3331         Setting  the  PCRE_DFA_SHORTEST option causes the matching algorithm to         Setting the PCRE_DFA_SHORTEST option causes the matching  algorithm  to
3332         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-
3333         tive  algorithm  works, this is necessarily the shortest possible match         tive algorithm works, this is necessarily the shortest  possible  match
3334         at the first possible matching point in the subject string.         at the first possible matching point in the subject string.
3335    
3336           PCRE_DFA_RESTART           PCRE_DFA_RESTART
3337    
3338         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
3339         returns  a  partial  match, it is possible to call it again, with addi-         again, with additional subject characters, and have  it  continue  with
3340         tional subject characters, and have it continue with  the  same  match.         the  same match. The PCRE_DFA_RESTART option requests this action; when
3341         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
3342         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
3343         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
3344         match. There is more discussion of this  facility  in  the  pcrepartial         pcrepartial documentation.
        documentation.  
3345    
3346     Successful returns from pcre_dfa_exec()     Successful returns from pcre_dfa_exec()
3347    
# Line 2549  MATCHING A PATTERN: THE ALTERNATIVE FUNC Line 3375  MATCHING A PATTERN: THE ALTERNATIVE FUNC
3375         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-
3376         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
3377         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
3378         filled with the longest matches.         filled  with  the  longest matches. Unlike pcre_exec(), pcre_dfa_exec()
3379           can use the entire ovector for returning matched strings.
3380    
3381     Error returns from pcre_dfa_exec()     Error returns from pcre_dfa_exec()
3382    
3383         The  pcre_dfa_exec()  function returns a negative number when it fails.         The pcre_dfa_exec() function returns a negative number when  it  fails.
3384         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
3385         described  above.   There are in addition the following errors that are         described above.  There are in addition the following errors  that  are
3386         specific to pcre_dfa_exec():         specific to pcre_dfa_exec():
3387    
3388           PCRE_ERROR_DFA_UITEM      (-16)           PCRE_ERROR_DFA_UITEM      (-16)
3389    
3390         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-
3391         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
3392         reference.         reference.
3393    
3394           PCRE_ERROR_DFA_UCOND      (-17)           PCRE_ERROR_DFA_UCOND      (-17)
3395    
3396         This return is given if pcre_dfa_exec()  encounters  a  condition  item         This  return  is  given  if pcre_dfa_exec() encounters a condition item
3397         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
3398         in a specific group. These are not supported.         in a specific group. These are not supported.
3399    
3400           PCRE_ERROR_DFA_UMLIMIT    (-18)           PCRE_ERROR_DFA_UMLIMIT    (-18)
3401    
3402         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
3403         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
3404         (it is meaningless).         fields.  This  is  not  supported (these fields are meaningless for DFA
3405           matching).
3406    
3407           PCRE_ERROR_DFA_WSSIZE     (-19)           PCRE_ERROR_DFA_WSSIZE     (-19)
3408    
# Line 2591  MATCHING A PATTERN: THE ALTERNATIVE FUNC Line 3419  MATCHING A PATTERN: THE ALTERNATIVE FUNC
3419    
3420  SEE ALSO  SEE ALSO
3421    
3422         pcrebuild(3), pcrecallout(3), pcrecpp(3)(3), pcrematching(3),  pcrepar-         pcre16(3),  pcrebuild(3),  pcrecallout(3),  pcrecpp(3)(3),   pcrematch-
3423         tial(3),  pcreposix(3), pcreprecompile(3), pcresample(3), pcrestack(3).         ing(3), pcrepartial(3), pcreposix(3), pcreprecompile(3), pcresample(3),
3424           pcrestack(3).
3425    
3426    
3427  AUTHOR  AUTHOR
# Line 2604  AUTHOR Line 3433  AUTHOR
3433    
3434  REVISION  REVISION
3435    
3436         Last updated: 12 April 2008         Last updated: 07 January 2012
3437         Copyright (c) 1997-2008 University of Cambridge.         Copyright (c) 1997-2012 University of Cambridge.
3438  ------------------------------------------------------------------------------  ------------------------------------------------------------------------------
3439    
3440    
3441  PCRECALLOUT(3)                                                  PCRECALLOUT(3)  PCRECALLOUT(3)                                                  PCRECALLOUT(3)
3442    
3443    
# Line 2620  PCRE CALLOUTS Line 3449  PCRE CALLOUTS
3449    
3450         int (*pcre_callout)(pcre_callout_block *);         int (*pcre_callout)(pcre_callout_block *);
3451    
3452           int (*pcre16_callout)(pcre16_callout_block *);
3453    
3454         PCRE provides a feature called "callout", which is a means of temporar-         PCRE provides a feature called "callout", which is a means of temporar-
3455         ily passing control to the caller of PCRE  in  the  middle  of  pattern         ily passing control to the caller of PCRE  in  the  middle  of  pattern
3456         matching.  The  caller of PCRE provides an external function by putting         matching.  The  caller of PCRE provides an external function by putting
3457         its entry point in the global variable pcre_callout. By  default,  this         its entry point in the global variable pcre_callout (pcre16_callout for
3458         variable contains NULL, which disables all calling out.         the  16-bit  library).  By  default, this variable contains NULL, which
3459           disables all calling out.
3460         Within  a  regular  expression,  (?C) indicates the points at which the  
3461         external function is to be called.  Different  callout  points  can  be         Within a regular expression, (?C) indicates the  points  at  which  the
3462         identified  by  putting  a number less than 256 after the letter C. The         external  function  is  to  be  called. Different callout points can be
3463         default value is zero.  For  example,  this  pattern  has  two  callout         identified by putting a number less than 256 after the  letter  C.  The
3464           default  value  is  zero.   For  example,  this pattern has two callout
3465         points:         points:
3466    
3467           (?C1)abc(?C2)def           (?C1)abc(?C2)def
3468    
3469         If  the  PCRE_AUTO_CALLOUT  option  bit  is  set when pcre_compile() is         If the PCRE_AUTO_CALLOUT option bit is set when a pattern is  compiled,
3470         called, PCRE automatically  inserts  callouts,  all  with  number  255,         PCRE  automatically  inserts callouts, all with number 255, before each
3471         before  each  item in the pattern. For example, if PCRE_AUTO_CALLOUT is         item in the pattern. For example, if PCRE_AUTO_CALLOUT is used with the
3472         used with the pattern         pattern
3473    
3474           A(\d{2}|--)           A(\d{2}|--)
3475    
# Line 2645  PCRE CALLOUTS Line 3477  PCRE CALLOUTS
3477    
3478         (?C255)A(?C255)((?C255)\d{2}(?C255)|(?C255)-(?C255)-(?C255))(?C255)         (?C255)A(?C255)((?C255)\d{2}(?C255)|(?C255)-(?C255)-(?C255))(?C255)
3479    
3480         Notice that there is a callout before and after  each  parenthesis  and         Notice  that  there  is a callout before and after each parenthesis and
3481         alternation  bar.  Automatic  callouts  can  be  used  for tracking the         alternation bar. Automatic  callouts  can  be  used  for  tracking  the
3482         progress of pattern matching. The pcretest command has an  option  that         progress  of  pattern matching. The pcretest command has an option that
3483         sets  automatic callouts; when it is used, the output indicates how the         sets automatic callouts; when it is used, the output indicates how  the
3484         pattern is matched. This is useful information when you are  trying  to         pattern  is  matched. This is useful information when you are trying to
3485         optimize the performance of a particular pattern.         optimize the performance of a particular pattern.
3486    
3487           The use of callouts in a pattern makes it ineligible  for  optimization
3488           by  the  just-in-time  compiler.  Studying  such  a  pattern  with  the
3489           PCRE_STUDY_JIT_COMPILE option always fails.
3490    
3491    
3492  MISSING CALLOUTS  MISSING CALLOUTS
3493    
3494         You  should  be  aware  that,  because of optimizations in the way PCRE         You should be aware that, because of  optimizations  in  the  way  PCRE
3495         matches patterns, callouts sometimes do not happen. For example, if the         matches  patterns  by  default,  callouts  sometimes do not happen. For
3496         pattern is         example, if the pattern is
3497    
3498           ab(?C4)cd           ab(?C4)cd
3499