/[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 172 by ph10, Tue Jun 5 10:40:13 2007 UTC revision 548 by ph10, Fri Jun 25 14:42:00 2010 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.)         tax,  there  is  some  support for one or two .NET and Oniguruma syntax
25           items, and there is an option for requesting some  minor  changes  that
26         The  current  implementation of PCRE (release 7.x) corresponds approxi-         give better JavaScript compatibility.
27         mately with Perl 5.10, including support for UTF-8 encoded strings  and  
28         Unicode general category properties. However, UTF-8 and Unicode support         The  current implementation of PCRE corresponds approximately with Perl
29         has to be explicitly enabled; it is not the default. The Unicode tables         5.10/5.11, including support for UTF-8 encoded strings and Unicode gen-
30         correspond to Unicode release 5.0.0.         eral  category properties. However, UTF-8 and Unicode support has to be
31           explicitly enabled; it is not the default. The  Unicode  tables  corre-
32           spond to Unicode release 5.2.0.
33    
34         In  addition to the Perl-compatible matching function, PCRE contains an         In  addition to the Perl-compatible matching function, PCRE contains an
35         alternative matching function that matches the same  compiled  patterns         alternative function that matches the same compiled patterns in a  dif-
36         in  a different way. In certain circumstances, the alternative function         ferent way. In certain circumstances, the alternative function has some
37         has some advantages. For a discussion of the two  matching  algorithms,         advantages.  For a discussion of the two matching algorithms,  see  the
38         see the pcrematching page.         pcrematching page.
39    
40         PCRE  is  written  in C and released as a C library. A number of people         PCRE  is  written  in C and released as a C library. A number of people
41         have written wrappers and interfaces of various kinds.  In  particular,         have written wrappers and interfaces of various kinds.  In  particular,
# Line 45  INTRODUCTION Line 48  INTRODUCTION
48    
49         Details of exactly which Perl regular expression features are  and  are         Details of exactly which Perl regular expression features are  and  are
50         not supported by PCRE are given in separate documents. See the pcrepat-         not supported by PCRE are given in separate documents. See the pcrepat-
51         tern and pcrecompat pages.         tern and pcrecompat pages. There is a syntax summary in the  pcresyntax
52           page.
53    
54         Some features of PCRE can be included, excluded, or  changed  when  the         Some  features  of  PCRE can be included, excluded, or changed when the
55         library  is  built.  The pcre_config() function makes it possible for a         library is built. The pcre_config() function makes it  possible  for  a
56         client to discover which features are  available.  The  features  them-         client  to  discover  which  features are available. The features them-
57         selves  are described in the pcrebuild page. Documentation about build-         selves are described in the pcrebuild page. Documentation about  build-
58         ing PCRE for various operating systems can be found in the README  file         ing  PCRE  for various operating systems can be found in the README and
59         in the source distribution.         NON-UNIX-USE files in the source distribution.
60    
61         The  library  contains  a number of undocumented internal functions and         The library contains a number of undocumented  internal  functions  and
62         data tables that are used by more than one  of  the  exported  external         data  tables  that  are  used by more than one of the exported external
63         functions,  but  which  are  not  intended for use by external callers.         functions, but which are not intended  for  use  by  external  callers.
64         Their names all begin with "_pcre_", which hopefully will  not  provoke         Their  names  all begin with "_pcre_", which hopefully will not provoke
65         any name clashes. In some environments, it is possible to control which         any name clashes. In some environments, it is possible to control which
66         external symbols are exported when a shared library is  built,  and  in         external  symbols  are  exported when a shared library is built, and in
67         these cases the undocumented symbols are not exported.         these cases the undocumented symbols are not exported.
68    
69    
70  USER DOCUMENTATION  USER DOCUMENTATION
71    
72         The  user  documentation  for PCRE comprises a number of different sec-         The user documentation for PCRE comprises a number  of  different  sec-
73         tions. In the "man" format, each of these is a separate "man page".  In         tions.  In the "man" format, each of these is a separate "man page". In
74         the  HTML  format, each is a separate page, linked from the index page.         the HTML format, each is a separate page, linked from the  index  page.
75         In the plain text format, all the sections are concatenated,  for  ease         In  the  plain  text format, all the sections, except the pcredemo sec-
76         of searching. The sections are as follows:         tion, are concatenated, for ease of searching. The sections are as fol-
77           lows:
78    
79           pcre              this document           pcre              this document
80           pcre-config       show PCRE installation configuration information           pcre-config       show PCRE installation configuration information
# Line 78  USER DOCUMENTATION Line 83  USER DOCUMENTATION
83           pcrecallout       details of the callout feature           pcrecallout       details of the callout feature
84           pcrecompat        discussion of Perl compatibility           pcrecompat        discussion of Perl compatibility
85           pcrecpp           details of the C++ wrapper           pcrecpp           details of the C++ wrapper
86             pcredemo          a demonstration C program that uses PCRE
87           pcregrep          description of the pcregrep command           pcregrep          description of the pcregrep command
88           pcrematching      discussion of the two matching algorithms           pcrematching      discussion of the two matching algorithms
89           pcrepartial       details of the partial matching facility           pcrepartial       details of the partial matching facility
# Line 86  USER DOCUMENTATION Line 92  USER DOCUMENTATION
92           pcreperform       discussion of performance issues           pcreperform       discussion of performance issues
93           pcreposix         the POSIX-compatible C API           pcreposix         the POSIX-compatible C API
94           pcreprecompile    details of saving and re-using precompiled patterns           pcreprecompile    details of saving and re-using precompiled patterns
95           pcresample        discussion of the sample program           pcresample        discussion of the pcredemo program
96           pcrestack         discussion of stack usage           pcrestack         discussion of stack usage
97             pcresyntax        quick syntax reference
98           pcretest          description of the pcretest testing command           pcretest          description of the pcretest testing command
99    
100         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
101         each C library function, listing its arguments and results.         each C library function, listing its arguments and results.
102    
103    
104  LIMITATIONS  LIMITATIONS
105    
106         There  are some size limitations in PCRE but it is hoped that they will         There are some size limitations in PCRE but it is hoped that they  will
107         never in practice be relevant.         never in practice be relevant.
108    
109         The maximum length of a compiled pattern is 65539 (sic) bytes  if  PCRE         The  maximum  length of a compiled pattern is 65539 (sic) bytes if PCRE
110         is compiled with the default internal linkage size of 2. If you want to         is compiled with the default internal linkage size of 2. If you want to
111         process regular expressions that are truly enormous,  you  can  compile         process  regular  expressions  that are truly enormous, you can compile
112         PCRE  with  an  internal linkage size of 3 or 4 (see the README file in         PCRE with an internal linkage size of 3 or 4 (see the  README  file  in
113         the source distribution and the pcrebuild documentation  for  details).         the  source  distribution and the pcrebuild documentation for details).
114         In  these  cases the limit is substantially larger.  However, the speed         In these cases the limit is substantially larger.  However,  the  speed
115         of execution is slower.         of execution is slower.
116    
117         All values in repeating quantifiers must be less than 65536. The  maxi-         All values in repeating quantifiers must be less than 65536.
        mum  compiled  length  of  subpattern  with an explicit repeat count is  
        30000 bytes. The maximum number of capturing subpatterns is 65535.  
118    
119         There is no limit to the number of parenthesized subpatterns, but there         There is no limit to the number of parenthesized subpatterns, but there
120         can be no more than 65535 capturing subpatterns.         can be no more than 65535 capturing subpatterns.
# Line 117  LIMITATIONS Line 122  LIMITATIONS
122         The maximum length of name for a named subpattern is 32 characters, and         The maximum length of name for a named subpattern is 32 characters, and
123         the maximum number of named subpatterns is 10000.         the maximum number of named subpatterns is 10000.
124    
125         The maximum length of a subject string is the largest  positive  number         The  maximum  length of a subject string is the largest positive number
126         that  an integer variable can hold. However, when using the traditional         that an integer variable can hold. However, when using the  traditional
127         matching function, PCRE uses recursion to handle subpatterns and indef-         matching function, PCRE uses recursion to handle subpatterns and indef-
128         inite  repetition.  This means that the available stack space may limit         inite repetition.  This means that the available stack space may  limit
129         the size of a subject string that can be processed by certain patterns.         the size of a subject string that can be processed by certain patterns.
130         For a discussion of stack issues, see the pcrestack documentation.         For a discussion of stack issues, see the pcrestack documentation.
131    
132    
133  UTF-8 AND UNICODE PROPERTY SUPPORT  UTF-8 AND UNICODE PROPERTY SUPPORT
134    
135         From  release  3.3,  PCRE  has  had  some support for character strings         From release 3.3, PCRE has  had  some  support  for  character  strings
136         encoded in the UTF-8 format. For release 4.0 this was greatly  extended         encoded  in the UTF-8 format. For release 4.0 this was greatly extended
137         to  cover  most common requirements, and in release 5.0 additional sup-         to cover most common requirements, and in release 5.0  additional  sup-
138         port for Unicode general category properties was added.         port for Unicode general category properties was added.
139    
140         In order process UTF-8 strings, you must build PCRE  to  include  UTF-8         In  order  process  UTF-8 strings, you must build PCRE to include UTF-8
141         support  in  the  code,  and, in addition, you must call pcre_compile()         support in the code, and, in addition,  you  must  call  pcre_compile()
142         with the PCRE_UTF8 option flag. When you do this, both the pattern  and         with  the  PCRE_UTF8  option  flag,  or the pattern must start with the
143         any  subject  strings  that are matched against it are treated as UTF-8         sequence (*UTF8). When either of these is the case,  both  the  pattern
144         strings instead of just strings of bytes.         and  any  subject  strings  that  are matched against it are treated as
145           UTF-8 strings instead of strings of 1-byte characters.
146    
147         If you compile PCRE with UTF-8 support, but do not use it at run  time,         If you compile PCRE with UTF-8 support, but do not use it at run  time,
148         the  library will be a bit bigger, but the additional run time overhead         the  library will be a bit bigger, but the additional run time overhead
# Line 155  UTF-8 AND UNICODE PROPERTY SUPPORT Line 161  UTF-8 AND UNICODE PROPERTY SUPPORT
161         optionally be prefixed by "Is", for compatibility with Perl  5.6.  PCRE         optionally be prefixed by "Is", for compatibility with Perl  5.6.  PCRE
162         does not support this.         does not support this.
163    
164         The following comments apply when PCRE is running in UTF-8 mode:     Validity of UTF-8 strings
165    
166           When  you  set  the  PCRE_UTF8 flag, the strings passed as patterns and
167           subjects are (by default) checked for validity on entry to the relevant
168           functions.  From  release 7.3 of PCRE, the check is according the rules
169           of RFC 3629, which are themselves derived from the  Unicode  specifica-
170           tion.  Earlier  releases  of PCRE followed the rules of RFC 2279, which
171           allows the full range of 31-bit values (0 to 0x7FFFFFFF).  The  current
172           check allows only values in the range U+0 to U+10FFFF, excluding U+D800
173           to U+DFFF.
174    
175           The excluded code points are the "Low Surrogate Area"  of  Unicode,  of
176           which  the Unicode Standard says this: "The Low Surrogate Area does not
177           contain any  character  assignments,  consequently  no  character  code
178           charts or namelists are provided for this area. Surrogates are reserved
179           for use with UTF-16 and then must be used in pairs."  The  code  points
180           that  are  encoded  by  UTF-16  pairs are available as independent code
181           points in the UTF-8 encoding. (In  other  words,  the  whole  surrogate
182           thing is a fudge for UTF-16 which unfortunately messes up UTF-8.)
183    
184           If  an  invalid  UTF-8  string  is  passed  to  PCRE,  an  error return
185           (PCRE_ERROR_BADUTF8) is given. In some situations, you may already know
186           that your strings are valid, and therefore want to skip these checks in
187           order to improve performance. If you set the PCRE_NO_UTF8_CHECK flag at
188           compile  time  or at run time, PCRE assumes that the pattern or subject
189           it is given (respectively) contains only valid  UTF-8  codes.  In  this
190           case, it does not diagnose an invalid UTF-8 string.
191    
192           If  you  pass  an  invalid UTF-8 string when PCRE_NO_UTF8_CHECK is set,
193           what happens depends on why the string is invalid. If the  string  con-
194           forms to the "old" definition of UTF-8 (RFC 2279), it is processed as a
195           string of characters in the range 0  to  0x7FFFFFFF.  In  other  words,
196           apart from the initial validity test, PCRE (when in UTF-8 mode) handles
197           strings according to the more liberal rules of RFC  2279.  However,  if
198           the  string does not even conform to RFC 2279, the result is undefined.
199           Your program may crash.
200    
201           If you want to process strings  of  values  in  the  full  range  0  to
202           0x7FFFFFFF,  encoded in a UTF-8-like manner as per the old RFC, you can
203           set PCRE_NO_UTF8_CHECK to bypass the more restrictive test. However, in
204           this situation, you will have to apply your own validity check.
205    
206         1.  When you set the PCRE_UTF8 flag, the strings passed as patterns and     General comments about UTF-8 mode
        subjects are checked for validity on entry to the  relevant  functions.  
        If an invalid UTF-8 string is passed, an error return is given. In some  
        situations, you may already know  that  your  strings  are  valid,  and  
        therefore want to skip these checks in order to improve performance. If  
        you set the PCRE_NO_UTF8_CHECK flag at compile time  or  at  run  time,  
        PCRE  assumes  that  the  pattern or subject it is given (respectively)  
        contains only valid UTF-8 codes. In this case, it does not diagnose  an  
        invalid  UTF-8 string. If you pass an invalid UTF-8 string to PCRE when  
        PCRE_NO_UTF8_CHECK is set, the results are undefined. Your program  may  
        crash.  
207    
208         2.  An  unbraced  hexadecimal  escape sequence (such as \xb3) matches a         1.  An  unbraced  hexadecimal  escape sequence (such as \xb3) matches a
209         two-byte UTF-8 character if the value is greater than 127.         two-byte UTF-8 character if the value is greater than 127.
210    
211         3. Octal numbers up to \777 are recognized, and  match  two-byte  UTF-8         2. Octal numbers up to \777 are recognized, and  match  two-byte  UTF-8
212         characters for values greater than \177.         characters for values greater than \177.
213    
214         4.  Repeat quantifiers apply to complete UTF-8 characters, not to indi-         3.  Repeat quantifiers apply to complete UTF-8 characters, not to indi-
215         vidual bytes, for example: \x{100}{3}.         vidual bytes, for example: \x{100}{3}.
216    
217         5. The dot metacharacter matches one UTF-8 character instead of a  sin-         4. The dot metacharacter matches one UTF-8 character instead of a  sin-
218         gle byte.         gle byte.
219    
220         6.  The  escape sequence \C can be used to match a single byte in UTF-8         5.  The  escape sequence \C can be used to match a single byte in UTF-8
221         mode, but its use can lead to some strange effects.  This  facility  is         mode, but its use can lead to some strange effects.  This  facility  is
222         not available in the alternative matching function, pcre_dfa_exec().         not available in the alternative matching function, pcre_dfa_exec().
223    
224         7.  The  character escapes \b, \B, \d, \D, \s, \S, \w, and \W correctly         6.  The  character escapes \b, \B, \d, \D, \s, \S, \w, and \W correctly
225         test characters of any code value, but the characters that PCRE  recog-         test characters of any code value, but, by default, the characters that
226         nizes  as  digits,  spaces,  or  word characters remain the same set as         PCRE  recognizes  as digits, spaces, or word characters remain the same
227         before, all with values less than 256. This remains true even when PCRE         set as before, all with values less than 256. This  remains  true  even
228         includes  Unicode  property support, because to do otherwise would slow         when  PCRE  is built to include Unicode property support, because to do
229         down PCRE in many common cases. If you really want to test for a  wider         otherwise would slow down PCRE in many common  cases.  Note  that  this
230         sense  of,  say,  "digit",  you must use Unicode property tests such as         also applies to \b, because it is defined in terms of \w and \W. If you
231         \p{Nd}.         really want to test for a wider sense of, say,  "digit",  you  can  use
232           explicit  Unicode property tests such as \p{Nd}.  Alternatively, if you
233         8. Similarly, characters that match the POSIX named  character  classes         set the PCRE_UCP option, the way that the  character  escapes  work  is
234         are all low-valued characters.         changed  so that Unicode properties are used to determine which charac-
235           ters match. There are more details in the section on generic  character
236         9.  Case-insensitive  matching  applies only to characters whose values         types in the pcrepattern documentation.
237         are less than 128, unless PCRE is built with Unicode property  support.  
238         Even  when  Unicode  property support is available, PCRE still uses its         7.  Similarly,  characters that match the POSIX named character classes
239         own character tables when checking the case of  low-valued  characters,         are all low-valued characters, unless the PCRE_UCP option is set.
240         so  as not to degrade performance.  The Unicode property information is  
241           8. However, the Perl 5.10 horizontal and vertical  whitespace  matching
242           escapes (\h, \H, \v, and \V) do match all the appropriate Unicode char-
243           acters, whether or not PCRE_UCP is set.
244    
245           9. Case-insensitive matching applies only to  characters  whose  values
246           are  less than 128, unless PCRE is built with Unicode property support.
247           Even when Unicode property support is available, PCRE  still  uses  its
248           own  character  tables when checking the case of low-valued characters,
249           so as not to degrade performance.  The Unicode property information  is
250         used only for characters with higher values. Even when Unicode property         used only for characters with higher values. Even when Unicode property
251         support is available, PCRE supports case-insensitive matching only when         support is available, PCRE supports case-insensitive matching only when
252         there is a one-to-one mapping between a letter's  cases.  There  are  a         there  is  a  one-to-one  mapping between a letter's cases. There are a
253         small  number  of  many-to-one  mappings in Unicode; these are not sup-         small number of many-to-one mappings in Unicode;  these  are  not  sup-
254         ported by PCRE.         ported by PCRE.
255    
256    
# Line 215  AUTHOR Line 260  AUTHOR
260         University Computing Service         University Computing Service
261         Cambridge CB2 3QH, England.         Cambridge CB2 3QH, England.
262    
263         Putting an actual email address here seems to have been a spam  magnet,         Putting  an actual email address here seems to have been a spam magnet,
264         so  I've  taken  it away. If you want to email me, use my two initials,         so I've taken it away. If you want to email me, use  my  two  initials,
265         followed by the two digits 10, at the domain cam.ac.uk.         followed by the two digits 10, at the domain cam.ac.uk.
266    
267    
268  REVISION  REVISION
269    
270         Last updated: 18 April 2007         Last updated: 12 May 2010
271         Copyright (c) 1997-2007 University of Cambridge.         Copyright (c) 1997-2010 University of Cambridge.
272  ------------------------------------------------------------------------------  ------------------------------------------------------------------------------
273    
274    
# Line 237  NAME Line 282  NAME
282  PCRE BUILD-TIME OPTIONS  PCRE BUILD-TIME OPTIONS
283    
284         This  document  describes  the  optional  features  of PCRE that can be         This  document  describes  the  optional  features  of PCRE that can be
285         selected when the library is compiled. They are all selected, or  dese-         selected when the library is compiled. It assumes use of the  configure
286         lected, by providing options to the configure script that is run before         script,  where the optional features are selected or deselected by pro-
287         the make command. The complete list of  options  for  configure  (which         viding options to configure before running the make  command.  However,
288         includes  the  standard  ones such as the selection of the installation         the  same  options  can be selected in both Unix-like and non-Unix-like
289         directory) can be obtained by running         environments using the GUI facility of cmake-gui if you are using CMake
290           instead of configure to build PCRE.
291    
292           There  is  a  lot more information about building PCRE in non-Unix-like
293           environments in the file called NON_UNIX_USE, which is part of the PCRE
294           distribution.  You  should consult this file as well as the README file
295           if you are building in a non-Unix-like environment.
296    
297           The complete list of options for configure (which includes the standard
298           ones  such  as  the  selection  of  the  installation directory) can be
299           obtained by running
300    
301           ./configure --help           ./configure --help
302    
# Line 266  C++ SUPPORT Line 321  C++ SUPPORT
321    
322  UTF-8 SUPPORT  UTF-8 SUPPORT
323    
324         To build PCRE with support for UTF-8 character strings, add         To build PCRE with support for UTF-8 Unicode character strings, add
325    
326           --enable-utf8           --enable-utf8
327    
328         to  the  configure  command.  Of  itself, this does not make PCRE treat         to  the  configure  command.  Of  itself, this does not make PCRE treat
329         strings as UTF-8. As well as compiling PCRE with this option, you  also         strings as UTF-8. As well as compiling PCRE with this option, you  also
330         have  have to set the PCRE_UTF8 option when you call the pcre_compile()         have  have to set the PCRE_UTF8 option when you call the pcre_compile()
331         function.         or pcre_compile2() functions.
332    
333           If you set --enable-utf8 when compiling in an EBCDIC environment,  PCRE
334           expects its input to be either ASCII or UTF-8 (depending on the runtime
335           option). It is not possible to support both EBCDIC and UTF-8  codes  in
336           the  same  version  of  the  library.  Consequently,  --enable-utf8 and
337           --enable-ebcdic are mutually exclusive.
338    
339    
340  UNICODE CHARACTER PROPERTY SUPPORT  UNICODE CHARACTER PROPERTY SUPPORT
# Line 296  UNICODE CHARACTER PROPERTY SUPPORT Line 357  UNICODE CHARACTER PROPERTY SUPPORT
357    
358  CODE VALUE OF NEWLINE  CODE VALUE OF NEWLINE
359    
360         By  default,  PCRE interprets character 10 (linefeed, LF) as indicating         By  default,  PCRE interprets the linefeed (LF) character as indicating
361         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
362         systems. You can compile PCRE to use character 13 (carriage return, CR)         systems.  You  can compile PCRE to use carriage return (CR) instead, by
363         instead, by adding         adding
364    
365           --enable-newline-is-cr           --enable-newline-is-cr
366    
# Line 322  CODE VALUE OF NEWLINE Line 383  CODE VALUE OF NEWLINE
383    
384         causes PCRE to recognize any Unicode newline sequence.         causes PCRE to recognize any Unicode newline sequence.
385    
386         Whatever line ending convention is selected when PCRE is built  can  be         Whatever  line  ending convention is selected when PCRE is built can be
387         overridden  when  the library functions are called. At build time it is         overridden when the library functions are called. At build time  it  is
388         conventional to use the standard for your operating system.         conventional to use the standard for your operating system.
389    
390    
391    WHAT \R MATCHES
392    
393           By  default,  the  sequence \R in a pattern matches any Unicode newline
394           sequence, whatever has been selected as the line  ending  sequence.  If
395           you specify
396    
397             --enable-bsr-anycrlf
398    
399           the  default  is changed so that \R matches only CR, LF, or CRLF. What-
400           ever is selected when PCRE is built can be overridden when the  library
401           functions are called.
402    
403    
404  BUILDING SHARED AND STATIC LIBRARIES  BUILDING SHARED AND STATIC LIBRARIES
405    
406         The PCRE building process uses libtool to build both shared and  static         The  PCRE building process uses libtool to build both shared and static
407         Unix  libraries by default. You can suppress one of these by adding one         Unix libraries by default. You can suppress one of these by adding  one
408         of         of
409    
410           --disable-shared           --disable-shared
# Line 342  BUILDING SHARED AND STATIC LIBRARIES Line 416  BUILDING SHARED AND STATIC LIBRARIES
416  POSIX MALLOC USAGE  POSIX MALLOC USAGE
417    
418         When PCRE is called through the POSIX interface (see the pcreposix doc-         When PCRE is called through the POSIX interface (see the pcreposix doc-
419         umentation),  additional  working  storage  is required for holding the         umentation), additional working storage is  required  for  holding  the
420         pointers to capturing substrings, because PCRE requires three  integers         pointers  to capturing substrings, because PCRE requires three integers
421         per  substring,  whereas  the POSIX interface provides only two. If the         per substring, whereas the POSIX interface provides only  two.  If  the
422         number of expected substrings is small, the wrapper function uses space         number of expected substrings is small, the wrapper function uses space
423         on the stack, because this is faster than using malloc() for each call.         on the stack, because this is faster than using malloc() for each call.
424         The default threshold above which the stack is no longer used is 10; it         The default threshold above which the stack is no longer used is 10; it
# Line 357  POSIX MALLOC USAGE Line 431  POSIX MALLOC USAGE
431    
432  HANDLING VERY LARGE PATTERNS  HANDLING VERY LARGE PATTERNS
433    
434         Within  a  compiled  pattern,  offset values are used to point from one         Within a compiled pattern, offset values are used  to  point  from  one
435         part to another (for example, from an opening parenthesis to an  alter-         part  to another (for example, from an opening parenthesis to an alter-
436         nation  metacharacter).  By default, two-byte values are used for these         nation metacharacter). By default, two-byte values are used  for  these
437         offsets, leading to a maximum size for a  compiled  pattern  of  around         offsets,  leading  to  a  maximum size for a compiled pattern of around
438         64K.  This  is sufficient to handle all but the most gigantic patterns.         64K. This is sufficient to handle all but the most  gigantic  patterns.
439         Nevertheless, some people do want to process enormous patterns,  so  it         Nevertheless,  some  people do want to process truyl enormous patterns,
440         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-
441         adding a setting such as         sets by adding a setting such as
442    
443           --with-link-size=3           --with-link-size=3
444    
445         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. Using
446         longer  offsets slows down the operation of PCRE because it has to load         longer offsets slows down the operation of PCRE because it has to  load
447         additional bytes when handling them.         additional bytes when handling them.
448    
449    
450  AVOIDING EXCESSIVE STACK USAGE  AVOIDING EXCESSIVE STACK USAGE
451    
452         When matching with the pcre_exec() function, PCRE implements backtrack-         When matching with the pcre_exec() function, PCRE implements backtrack-
453         ing  by  making recursive calls to an internal function called match().         ing by making recursive calls to an internal function  called  match().
454         In environments where the size of the stack is limited,  this  can  se-         In  environments  where  the size of the stack is limited, this can se-
455         verely  limit  PCRE's operation. (The Unix environment does not usually         verely limit PCRE's operation. (The Unix environment does  not  usually
456         suffer from this problem, but it may sometimes be necessary to increase         suffer from this problem, but it may sometimes be necessary to increase
457         the  maximum  stack size.  There is a discussion in the pcrestack docu-         the maximum stack size.  There is a discussion in the  pcrestack  docu-
458         mentation.) An alternative approach to recursion that uses memory  from         mentation.)  An alternative approach to recursion that uses memory from
459         the  heap  to remember data, instead of using recursive function calls,         the heap to remember data, instead of using recursive  function  calls,
460         has been implemented to work round the problem of limited  stack  size.         has  been  implemented to work round the problem of limited stack size.
461         If you want to build a version of PCRE that works this way, add         If you want to build a version of PCRE that works this way, add
462    
463           --disable-stack-for-recursion           --disable-stack-for-recursion
464    
465         to  the  configure  command. With this configuration, PCRE will use the         to the configure command. With this configuration, PCRE  will  use  the
466         pcre_stack_malloc and pcre_stack_free variables to call memory  manage-         pcre_stack_malloc  and pcre_stack_free variables to call memory manage-
467         ment  functions.  Separate  functions are provided because the usage is         ment functions. By default these point to malloc() and free(), but  you
468         very predictable: the block sizes requested are always  the  same,  and         can replace the pointers so that your own functions are used instead.
469         the  blocks  are always freed in reverse order. A calling program might  
470         be able to implement optimized functions that perform better  than  the         Separate  functions  are  provided  rather  than  using pcre_malloc and
471         standard  malloc()  and  free()  functions.  PCRE  runs noticeably more         pcre_free because the  usage  is  very  predictable:  the  block  sizes
472         slowly when built in this way. This option affects only the pcre_exec()         requested  are  always  the  same,  and  the blocks are always freed in
473         function; it is not relevant for the the pcre_dfa_exec() function.         reverse order. A calling program might be able to  implement  optimized
474           functions  that  perform  better  than  malloc()  and free(). PCRE runs
475           noticeably more slowly when built in this way. This option affects only
476           the pcre_exec() function; it is not relevant for pcre_dfa_exec().
477    
478    
479  LIMITING PCRE RESOURCE USAGE  LIMITING PCRE RESOURCE USAGE
# Line 451  USING EBCDIC CODE Line 528  USING EBCDIC CODE
528    
529         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
530         character code is ASCII (or Unicode, which is  a  superset  of  ASCII).         character code is ASCII (or Unicode, which is  a  superset  of  ASCII).
531         PCRE  can,  however,  be  compiled  to  run in an EBCDIC environment by         This  is  the  case for most computer operating systems. PCRE can, how-
532         adding         ever, be compiled to run in an EBCDIC environment by adding
533    
534           --enable-ebcdic           --enable-ebcdic
535    
536         to the configure command. This setting implies --enable-rebuild-charta-         to the configure command. This setting implies --enable-rebuild-charta-
537         bles.         bles.  You  should  only  use  it if you know that you are in an EBCDIC
538           environment (for example,  an  IBM  mainframe  operating  system).  The
539           --enable-ebcdic option is incompatible with --enable-utf8.
540    
541    
542    PCREGREP OPTIONS FOR COMPRESSED FILE SUPPORT
543    
544           By default, pcregrep reads all files as plain text. You can build it so
545           that it recognizes files whose names end in .gz or .bz2, and reads them
546           with libz or libbz2, respectively, by adding one or both of
547    
548             --enable-pcregrep-libz
549             --enable-pcregrep-libbz2
550    
551           to the configure command. These options naturally require that the rel-
552           evant libraries are installed on your system. Configuration  will  fail
553           if they are not.
554    
555    
556    PCRETEST OPTION FOR LIBREADLINE SUPPORT
557    
558           If you add
559    
560             --enable-pcretest-libreadline
561    
562           to  the  configure  command,  pcretest  is  linked with the libreadline
563           library, and when its input is from a terminal, it reads it  using  the
564           readline() function. This provides line-editing and history facilities.
565           Note that libreadline is GPL-licensed, so if you distribute a binary of
566           pcretest linked in this way, there may be licensing issues.
567    
568           Setting  this  option  causes  the -lreadline option to be added to the
569           pcretest build. In many operating environments with  a  sytem-installed
570           libreadline this is sufficient. However, in some environments (e.g.  if
571           an unmodified distribution version of readline is in use),  some  extra
572           configuration  may  be necessary. The INSTALL file for libreadline says
573           this:
574    
575             "Readline uses the termcap functions, but does not link with the
576             termcap or curses library itself, allowing applications which link
577             with readline the to choose an appropriate library."
578    
579           If your environment has not been set up so that an appropriate  library
580           is automatically included, you may need to add something like
581    
582             LIBS="-ncurses"
583    
584           immediately before the configure command.
585    
586    
587  SEE ALSO  SEE ALSO
# Line 474  AUTHOR Line 598  AUTHOR
598    
599  REVISION  REVISION
600    
601         Last updated: 16 April 2007         Last updated: 29 September 2009
602         Copyright (c) 1997-2007 University of Cambridge.         Copyright (c) 1997-2009 University of Cambridge.
603  ------------------------------------------------------------------------------  ------------------------------------------------------------------------------
604    
605    
# Line 562  THE ALTERNATIVE MATCHING ALGORITHM Line 686  THE ALTERNATIVE MATCHING ALGORITHM
686         though  it is not implemented as a traditional finite state machine (it         though  it is not implemented as a traditional finite state machine (it
687         keeps multiple states active simultaneously).         keeps multiple states active simultaneously).
688    
689           Although the general principle of this matching algorithm  is  that  it
690           scans  the subject string only once, without backtracking, there is one
691           exception: when a lookaround assertion is encountered,  the  characters
692           following  or  preceding  the  current  point  have to be independently
693           inspected.
694    
695         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
696         there  are  no more unterminated paths. At this point, terminated paths         there  are  no more unterminated paths. At this point, terminated paths
697         represent the different matching possibilities (if there are none,  the         represent the different matching possibilities (if there are none,  the
698         match  has  failed).   Thus,  if there is more than one possible match,         match  has  failed).   Thus,  if there is more than one possible match,
699         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-
700         est.  In PCRE, there is an option to stop the algorithm after the first         est.  There  is  an  option to stop the algorithm after the first match
701         match (which is necessarily the shortest) has been found.         (which is necessarily the shortest) is found.
702    
703         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
704         subject. If the pattern         subject. If the pattern
# Line 618  THE ALTERNATIVE MATCHING ALGORITHM Line 748  THE ALTERNATIVE MATCHING ALGORITHM
748         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
749         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.
750    
751         7.  The \C escape sequence, which (in the standard algorithm) matches a         7. The \C escape sequence, which (in the standard algorithm) matches  a
752         single  byte, even in UTF-8 mode, is not supported because the alterna-         single  byte, even in UTF-8 mode, is not supported because the alterna-
753         tive algorithm moves through the subject  string  one  character  at  a         tive algorithm moves through the subject  string  one  character  at  a
754         time, for all active paths through the tree.         time, for all active paths through the tree.
755    
756           8.  Except for (*FAIL), the backtracking control verbs such as (*PRUNE)
757           are not supported. (*FAIL) is supported, and  behaves  like  a  failing
758           negative assertion.
759    
760    
761  ADVANTAGES OF THE ALTERNATIVE ALGORITHM  ADVANTAGES OF THE ALTERNATIVE ALGORITHM
762    
# Line 634  ADVANTAGES OF THE ALTERNATIVE ALGORITHM Line 768  ADVANTAGES OF THE ALTERNATIVE ALGORITHM
768         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
769         things with callouts.         things with callouts.
770    
771         2.  There is much better support for partial matching. The restrictions         2.  Because  the  alternative  algorithm  scans the subject string just
        on the content of the pattern that apply when using the standard  algo-  
        rithm  for  partial matching do not apply to the alternative algorithm.  
        For non-anchored patterns, the starting position of a partial match  is  
        available.  
   
        3.  Because  the  alternative  algorithm  scans the subject string just  
772         once, and never needs to backtrack, it is possible to  pass  very  long         once, and never needs to backtrack, it is possible to  pass  very  long
773         subject  strings  to  the matching function in several pieces, checking         subject  strings  to  the matching function in several pieces, checking
774         for partial matching each time.         for partial matching each time.  The  pcrepartial  documentation  gives
775           details of partial matching.
776    
777    
778  DISADVANTAGES OF THE ALTERNATIVE ALGORITHM  DISADVANTAGES OF THE ALTERNATIVE ALGORITHM
779    
780         The alternative algorithm suffers from a number of disadvantages:         The alternative algorithm suffers from a number of disadvantages:
781    
782         1. It is substantially slower than  the  standard  algorithm.  This  is         1.  It  is  substantially  slower  than the standard algorithm. This is
783         partly  because  it has to search for all possible matches, but is also         partly because it has to search for all possible matches, but  is  also
784         because it is less susceptible to optimization.         because it is less susceptible to optimization.
785    
786         2. Capturing parentheses and back references are not supported.         2. Capturing parentheses and back references are not supported.
# Line 669  AUTHOR Line 798  AUTHOR
798    
799  REVISION  REVISION
800    
801         Last updated: 29 May 2007         Last updated: 29 September 2009
802         Copyright (c) 1997-2007 University of Cambridge.         Copyright (c) 1997-2009 University of Cambridge.
803  ------------------------------------------------------------------------------  ------------------------------------------------------------------------------
804    
805    
# Line 777  PCRE API OVERVIEW Line 906  PCRE API OVERVIEW
906         bers for the library.  Applications can use these  to  include  support         bers for the library.  Applications can use these  to  include  support
907         for different releases of PCRE.         for different releases of PCRE.
908    
909           In a Windows environment, if you want to statically link an application
910           program against a non-dll pcre.a  file,  you  must  define  PCRE_STATIC
911           before  including  pcre.h or pcrecpp.h, because otherwise the pcre_mal-
912           loc()   and   pcre_free()   exported   functions   will   be   declared
913           __declspec(dllimport), with unwanted results.
914    
915         The   functions   pcre_compile(),  pcre_compile2(),  pcre_study(),  and         The   functions   pcre_compile(),  pcre_compile2(),  pcre_study(),  and
916         pcre_exec() are used for compiling and matching regular expressions  in         pcre_exec() are used for compiling and matching regular expressions  in
917         a  Perl-compatible  manner. A sample program that demonstrates the sim-         a  Perl-compatible  manner. A sample program that demonstrates the sim-
918         plest way of using them is provided in the file  called  pcredemo.c  in         plest way of using them is provided in the file  called  pcredemo.c  in
919         the  source distribution. The pcresample documentation describes how to         the PCRE source distribution. A listing of this program is given in the
920         run it.         pcredemo documentation, and the pcresample documentation describes  how
921           to compile and run it.
922    
923         A second matching function, pcre_dfa_exec(), which is not Perl-compati-         A second matching function, pcre_dfa_exec(), which is not Perl-compati-
924         ble,  is  also provided. This uses a different algorithm for the match-         ble, is also provided. This uses a different algorithm for  the  match-
925         ing. The alternative algorithm finds all possible matches (at  a  given         ing.  The  alternative algorithm finds all possible matches (at a given
926         point  in  the subject), and scans the subject just once. However, this         point in the subject), and scans the subject just  once  (unless  there
927         algorithm does not return captured substrings. A description of the two         are  lookbehind  assertions).  However,  this algorithm does not return
928         matching  algorithms and their advantages and disadvantages is given in         captured substrings. A description of the two matching  algorithms  and
929         the pcrematching documentation.         their  advantages  and disadvantages is given in the pcrematching docu-
930           mentation.
931    
932         In addition to the main compiling and  matching  functions,  there  are         In addition to the main compiling and  matching  functions,  there  are
933         convenience functions for extracting captured substrings from a subject         convenience functions for extracting captured substrings from a subject
# Line 866  NEWLINES Line 1003  NEWLINES
1003         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
1004         pattern is compiled, or when it is matched.         pattern is compiled, or when it is matched.
1005    
1006           At compile time, the newline convention can be specified by the options
1007           argument of pcre_compile(), or it can be specified by special  text  at
1008           the start of the pattern itself; this overrides any other settings. See
1009           the pcrepattern page for details of the special character sequences.
1010    
1011         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-
1012         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
1013         newline  convention  affects  the  handling of the dot, circumflex, and         newline convention affects the handling of  the  dot,  circumflex,  and
1014         dollar metacharacters, the handling of #-comments in /x mode, and, when         dollar metacharacters, the handling of #-comments in /x mode, and, when
1015         CRLF  is a recognized line ending sequence, the match position advance-         CRLF is a recognized line ending sequence, the match position  advance-
1016         ment for a non-anchored pattern. The choice of newline convention  does         ment for a non-anchored pattern. There is more detail about this in the
1017         not affect the interpretation of the \n or \r escape sequences.         section on pcre_exec() options below.
1018    
1019           The choice of newline convention does not affect the interpretation  of
1020           the  \n  or  \r  escape  sequences, nor does it affect what \R matches,
1021           which is controlled in a similar way, but by separate options.
1022    
1023    
1024  MULTITHREADING  MULTITHREADING
1025    
1026         The  PCRE  functions  can be used in multi-threading applications, with         The PCRE functions can be used in  multi-threading  applications,  with
1027         the  proviso  that  the  memory  management  functions  pointed  to  by         the  proviso  that  the  memory  management  functions  pointed  to  by
1028         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
1029         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 926  CHECKING BUILD-TIME OPTIONS Line 1072  CHECKING BUILD-TIME OPTIONS
1072         The output is an integer whose value specifies  the  default  character         The output is an integer whose value specifies  the  default  character
1073         sequence  that is recognized as meaning "newline". The four values that         sequence  that is recognized as meaning "newline". The four values that
1074         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,
1075         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
1076         for your operating system.         are returned in EBCDIC environments. The default should normally corre-
1077           spond to the standard sequence for your operating system.
1078    
1079             PCRE_CONFIG_BSR
1080    
1081           The output is an integer whose value indicates what character sequences
1082           the \R escape sequence matches by default. A value of 0 means  that  \R
1083           matches  any  Unicode  line ending sequence; a value of 1 means that \R
1084           matches only CR, LF, or CRLF. The default can be overridden when a pat-
1085           tern is compiled or matched.
1086    
1087           PCRE_CONFIG_LINK_SIZE           PCRE_CONFIG_LINK_SIZE
1088    
1089         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
1090         internal linkage in compiled regular expressions. The value is 2, 3, or         internal linkage in compiled regular expressions. The value is 2, 3, or
1091         4. Larger values allow larger regular expressions to  be  compiled,  at         4.  Larger  values  allow larger regular expressions to be compiled, at
1092         the  expense  of  slower matching. The default value of 2 is sufficient         the expense of slower matching. The default value of  2  is  sufficient
1093         for all but the most massive patterns, since  it  allows  the  compiled         for  all  but  the  most massive patterns, since it allows the compiled
1094         pattern to be up to 64K in size.         pattern to be up to 64K in size.
1095    
1096           PCRE_CONFIG_POSIX_MALLOC_THRESHOLD           PCRE_CONFIG_POSIX_MALLOC_THRESHOLD
1097    
1098         The  output  is  an integer that contains the threshold above which the         The output is an integer that contains the threshold  above  which  the
1099         POSIX interface uses malloc() for output vectors. Further  details  are         POSIX  interface  uses malloc() for output vectors. Further details are
1100         given in the pcreposix documentation.         given in the pcreposix documentation.
1101    
1102           PCRE_CONFIG_MATCH_LIMIT           PCRE_CONFIG_MATCH_LIMIT
1103    
1104         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-
1105         internal matching function calls in a  pcre_exec()  execution.  Further         ber  of  internal  matching  function calls in a pcre_exec() execution.
1106         details are given with pcre_exec() below.         Further details are given with pcre_exec() below.
1107    
1108           PCRE_CONFIG_MATCH_LIMIT_RECURSION           PCRE_CONFIG_MATCH_LIMIT_RECURSION
1109    
1110         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
1111         recursion when calling the internal matching function in a  pcre_exec()         of   recursion  when  calling  the  internal  matching  function  in  a
1112         execution. Further details are given with pcre_exec() below.         pcre_exec() execution.  Further  details  are  given  with  pcre_exec()
1113           below.
1114    
1115           PCRE_CONFIG_STACKRECURSE           PCRE_CONFIG_STACKRECURSE
1116    
# Line 981  COMPILING A PATTERN Line 1137  COMPILING A PATTERN
1137         Either of the functions pcre_compile() or pcre_compile2() can be called         Either of the functions pcre_compile() or pcre_compile2() can be called
1138         to compile a pattern into an internal form. The only difference between         to compile a pattern into an internal form. The only difference between
1139         the  two interfaces is that pcre_compile2() has an additional argument,         the  two interfaces is that pcre_compile2() has an additional argument,
1140         errorcodeptr, via which a numerical error code can be returned.         errorcodeptr, via which a numerical error  code  can  be  returned.  To
1141           avoid  too  much repetition, we refer just to pcre_compile() below, but
1142           the information applies equally to pcre_compile2().
1143    
1144         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
1145         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 998  COMPILING A PATTERN Line 1156  COMPILING A PATTERN
1156    
1157         The options argument contains various bit settings that affect the com-         The options argument contains various bit settings that affect the com-
1158         pilation. It should be zero if no options are required.  The  available         pilation. It should be zero if no options are required.  The  available
1159         options  are  described  below. Some of them, in particular, those that         options  are  described  below. Some of them (in particular, those that
1160         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
1161         pattern  (see  the  detailed  description in the pcrepattern documenta-         unset  from  within  the  pattern  (see the detailed description in the
1162         tion). For these options, the contents of the options  argument  speci-         pcrepattern documentation). For those options that can be different  in
1163         fies  their initial settings at the start of compilation and execution.         different  parts  of  the pattern, the contents of the options argument
1164         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
1165         of matching as well as at compile time.         PCRE_ANCHORED, PCRE_BSR_xxx, and PCRE_NEWLINE_xxx options can be set at
1166           the time of matching as well as at compile time.
1167    
1168         If errptr is NULL, pcre_compile() returns NULL immediately.  Otherwise,         If errptr is NULL, pcre_compile() returns NULL immediately.  Otherwise,
1169         if compilation of a pattern fails,  pcre_compile()  returns  NULL,  and         if  compilation  of  a  pattern fails, pcre_compile() returns NULL, and
1170         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-
1171         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
1172         try to free it. The offset from the start of the pattern to the charac-         try to free it. The byte offset from the start of the  pattern  to  the
1173         ter where the error was discovered is placed in the variable pointed to         character  that  was  being  processed when the error was discovered is
1174         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.
1175         given.         If  it  is,  an  immediate error is given. Some errors are not detected
1176           until checks are carried out when the whole pattern has  been  scanned;
1177         If pcre_compile2() is used instead of pcre_compile(),  and  the  error-         in this case the offset is set to the end of the pattern.
1178         codeptr  argument is not NULL, a non-zero error code number is returned  
1179         via this argument in the event of an error. This is in addition to  the         If  pcre_compile2()  is  used instead of pcre_compile(), and the error-
1180           codeptr argument is not NULL, a non-zero error code number is  returned
1181           via  this argument in the event of an error. This is in addition to the
1182         textual error message. Error codes and messages are listed below.         textual error message. Error codes and messages are listed below.
1183    
1184         If  the  final  argument, tableptr, is NULL, PCRE uses a default set of         If the final argument, tableptr, is NULL, PCRE uses a  default  set  of
1185         character tables that are  built  when  PCRE  is  compiled,  using  the         character  tables  that  are  built  when  PCRE  is compiled, using the
1186         default  C  locale.  Otherwise, tableptr must be an address that is the         default C locale. Otherwise, tableptr must be an address  that  is  the
1187         result of a call to pcre_maketables(). This value is  stored  with  the         result  of  a  call to pcre_maketables(). This value is stored with the
1188         compiled  pattern,  and used again by pcre_exec(), unless another table         compiled pattern, and used again by pcre_exec(), unless  another  table
1189         pointer is passed to it. For more discussion, see the section on locale         pointer is passed to it. For more discussion, see the section on locale
1190         support below.         support below.
1191    
1192         This  code  fragment  shows a typical straightforward call to pcre_com-         This code fragment shows a typical straightforward  call  to  pcre_com-
1193         pile():         pile():
1194    
1195           pcre *re;           pcre *re;
# Line 1041  COMPILING A PATTERN Line 1202  COMPILING A PATTERN
1202             &erroffset,       /* for error offset */             &erroffset,       /* for error offset */
1203             NULL);            /* use default character tables */             NULL);            /* use default character tables */
1204    
1205         The following names for option bits are defined in  the  pcre.h  header         The  following  names  for option bits are defined in the pcre.h header
1206         file:         file:
1207    
1208           PCRE_ANCHORED           PCRE_ANCHORED
1209    
1210         If this bit is set, the pattern is forced to be "anchored", that is, it         If this bit is set, the pattern is forced to be "anchored", that is, it
1211         is constrained to match only at the first matching point in the  string         is  constrained to match only at the first matching point in the string
1212         that  is being searched (the "subject string"). This effect can also be         that is being searched (the "subject string"). This effect can also  be
1213         achieved by appropriate constructs in the pattern itself, which is  the         achieved  by appropriate constructs in the pattern itself, which is the
1214         only way to do it in Perl.         only way to do it in Perl.
1215    
1216           PCRE_AUTO_CALLOUT           PCRE_AUTO_CALLOUT
1217    
1218         If this bit is set, pcre_compile() automatically inserts callout items,         If this bit is set, pcre_compile() automatically inserts callout items,
1219         all with number 255, before each pattern item. For  discussion  of  the         all  with  number  255, before each pattern item. For discussion of the
1220         callout facility, see the pcrecallout documentation.         callout facility, see the pcrecallout documentation.
1221    
1222             PCRE_BSR_ANYCRLF
1223             PCRE_BSR_UNICODE
1224    
1225           These options (which are mutually exclusive) control what the \R escape
1226           sequence  matches.  The choice is either to match only CR, LF, or CRLF,
1227           or to match any Unicode newline sequence. The default is specified when
1228           PCRE is built. It can be overridden from within the pattern, or by set-
1229           ting an option when a compiled pattern is matched.
1230    
1231           PCRE_CASELESS           PCRE_CASELESS
1232    
1233         If  this  bit is set, letters in the pattern match both upper and lower         If this bit is set, letters in the pattern match both upper  and  lower
1234         case letters. It is equivalent to Perl's  /i  option,  and  it  can  be         case  letters.  It  is  equivalent  to  Perl's /i option, and it can be
1235         changed  within a pattern by a (?i) option setting. In UTF-8 mode, PCRE         changed within a pattern by a (?i) option setting. In UTF-8 mode,  PCRE
1236         always understands the concept of case for characters whose values  are         always  understands the concept of case for characters whose values are
1237         less  than 128, so caseless matching is always possible. For characters         less than 128, so caseless matching is always possible. For  characters
1238         with higher values, the concept of case is supported if  PCRE  is  com-         with  higher  values,  the concept of case is supported if PCRE is com-
1239         piled  with Unicode property support, but not otherwise. If you want to         piled with Unicode property support, but not otherwise. If you want  to
1240         use caseless matching for characters 128 and  above,  you  must  ensure         use  caseless  matching  for  characters 128 and above, you must ensure
1241         that  PCRE  is  compiled  with Unicode property support as well as with         that PCRE is compiled with Unicode property support  as  well  as  with
1242         UTF-8 support.         UTF-8 support.
1243    
1244           PCRE_DOLLAR_ENDONLY           PCRE_DOLLAR_ENDONLY
1245    
1246         If this bit is set, a dollar metacharacter in the pattern matches  only         If  this bit is set, a dollar metacharacter in the pattern matches only
1247         at  the  end  of the subject string. Without this option, a dollar also         at the end of the subject string. Without this option,  a  dollar  also
1248         matches immediately before a newline at the end of the string (but  not         matches  immediately before a newline at the end of the string (but not
1249         before  any  other newlines). The PCRE_DOLLAR_ENDONLY option is ignored         before any other newlines). The PCRE_DOLLAR_ENDONLY option  is  ignored
1250         if PCRE_MULTILINE is set.  There is no equivalent  to  this  option  in         if  PCRE_MULTILINE  is  set.   There is no equivalent to this option in
1251         Perl, and no way to set it within a pattern.         Perl, and no way to set it within a pattern.
1252    
1253           PCRE_DOTALL           PCRE_DOTALL
1254    
1255         If this bit is set, a dot metacharater in the pattern matches all char-         If this bit is set, a dot metacharater in the pattern matches all char-
1256         acters, including those that indicate newline. Without it, a  dot  does         acters,  including  those that indicate newline. Without it, a dot does
1257         not  match  when  the  current position is at a newline. This option is         not match when the current position is at a  newline.  This  option  is
1258         equivalent to Perl's /s option, and it can be changed within a  pattern         equivalent  to Perl's /s option, and it can be changed within a pattern
1259         by  a (?s) option setting. A negative class such as [^a] always matches         by a (?s) option setting. A negative class such as [^a] always  matches
1260         newline characters, independent of the setting of this option.         newline characters, independent of the setting of this option.
1261    
1262           PCRE_DUPNAMES           PCRE_DUPNAMES
1263    
1264         If this bit is set, names used to identify capturing  subpatterns  need         If  this  bit is set, names used to identify capturing subpatterns need
1265         not be unique. This can be helpful for certain types of pattern when it         not be unique. This can be helpful for certain types of pattern when it
1266         is known that only one instance of the named  subpattern  can  ever  be         is  known  that  only  one instance of the named subpattern can ever be
1267         matched.  There  are  more details of named subpatterns below; see also         matched. There are more details of named subpatterns  below;  see  also
1268         the pcrepattern documentation.         the pcrepattern documentation.
1269    
1270           PCRE_EXTENDED           PCRE_EXTENDED
1271    
1272         If this bit is set, whitespace  data  characters  in  the  pattern  are         If  this  bit  is  set,  whitespace  data characters in the pattern are
1273         totally ignored except when escaped or inside a character class. White-         totally ignored except when escaped or inside a character class. White-
1274         space does not include the VT character (code 11). In addition, charac-         space does not include the VT character (code 11). In addition, charac-
1275         ters between an unescaped # outside a character class and the next new-         ters between an unescaped # outside a character class and the next new-
1276         line, inclusive, are also ignored. This  is  equivalent  to  Perl's  /x         line,  inclusive,  are  also  ignored.  This is equivalent to Perl's /x
1277         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-
1278         ting.         ting.
1279    
1280         This option makes it possible to include  comments  inside  complicated         This  option  makes  it possible to include comments inside complicated
1281         patterns.   Note,  however,  that this applies only to data characters.         patterns.  Note, however, that this applies only  to  data  characters.
1282         Whitespace  characters  may  never  appear  within  special   character         Whitespace   characters  may  never  appear  within  special  character
1283         sequences  in  a  pattern,  for  example  within the sequence (?( which         sequences in a pattern, for  example  within  the  sequence  (?(  which
1284         introduces a conditional subpattern.         introduces a conditional subpattern.
1285    
1286           PCRE_EXTRA           PCRE_EXTRA
1287    
1288         This option was invented in order to turn on  additional  functionality         This  option  was invented in order to turn on additional functionality
1289         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
1290         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
1291         letter  that  has  no  special  meaning causes an error, thus reserving         letter that has no special meaning  causes  an  error,  thus  reserving
1292         these combinations for future expansion. By  default,  as  in  Perl,  a         these  combinations  for  future  expansion.  By default, as in Perl, a
1293         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
1294         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
1295         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
1296         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
1297           within a pattern.
1298    
1299           PCRE_FIRSTLINE           PCRE_FIRSTLINE
1300    
# Line 1131  COMPILING A PATTERN Line 1302  COMPILING A PATTERN
1302         before  or  at  the  first  newline  in  the subject string, though the         before  or  at  the  first  newline  in  the subject string, though the
1303         matched text may continue over the newline.         matched text may continue over the newline.
1304    
1305             PCRE_JAVASCRIPT_COMPAT
1306    
1307           If this option is set, PCRE's behaviour is changed in some ways so that
1308           it  is  compatible with JavaScript rather than Perl. The changes are as
1309           follows:
1310    
1311           (1) A lone closing square bracket in a pattern  causes  a  compile-time
1312           error,  because this is illegal in JavaScript (by default it is treated
1313           as a data character). Thus, the pattern AB]CD becomes illegal when this
1314           option is set.
1315    
1316           (2)  At run time, a back reference to an unset subpattern group matches
1317           an empty string (by default this causes the current  matching  alterna-
1318           tive  to  fail). A pattern such as (\1)(a) succeeds when this option is
1319           set (assuming it can find an "a" in the subject), whereas it  fails  by
1320           default, for Perl compatibility.
1321    
1322           PCRE_MULTILINE           PCRE_MULTILINE
1323    
1324         By default, PCRE treats the subject string as consisting  of  a  single         By  default,  PCRE  treats the subject string as consisting of a single
1325         line  of characters (even if it actually contains newlines). The "start         line of characters (even if it actually contains newlines). The  "start
1326         of line" metacharacter (^) matches only at the  start  of  the  string,         of  line"  metacharacter  (^)  matches only at the start of the string,
1327         while  the  "end  of line" metacharacter ($) matches only at the end of         while the "end of line" metacharacter ($) matches only at  the  end  of
1328         the string, or before a terminating newline (unless PCRE_DOLLAR_ENDONLY         the string, or before a terminating newline (unless PCRE_DOLLAR_ENDONLY
1329         is set). This is the same as Perl.         is set). This is the same as Perl.
1330    
1331         When  PCRE_MULTILINE  it  is set, the "start of line" and "end of line"         When PCRE_MULTILINE it is set, the "start of line" and  "end  of  line"
1332         constructs match immediately following or immediately  before  internal         constructs  match  immediately following or immediately before internal
1333         newlines  in  the  subject string, respectively, as well as at the very         newlines in the subject string, respectively, as well as  at  the  very
1334         start and end. This is equivalent to Perl's /m option, and  it  can  be         start  and  end.  This is equivalent to Perl's /m option, and it can be
1335         changed within a pattern by a (?m) option setting. If there are no new-         changed within a pattern by a (?m) option setting. If there are no new-
1336         lines in a subject string, or no occurrences of ^ or $  in  a  pattern,         lines  in  a  subject string, or no occurrences of ^ or $ in a pattern,
1337         setting PCRE_MULTILINE has no effect.         setting PCRE_MULTILINE has no effect.
1338    
1339           PCRE_NEWLINE_CR           PCRE_NEWLINE_CR
# Line 1154  COMPILING A PATTERN Line 1342  COMPILING A PATTERN
1342           PCRE_NEWLINE_ANYCRLF           PCRE_NEWLINE_ANYCRLF
1343           PCRE_NEWLINE_ANY           PCRE_NEWLINE_ANY
1344    
1345         These  options  override the default newline definition that was chosen         These options override the default newline definition that  was  chosen
1346         when PCRE was built. Setting the first or the second specifies  that  a         when  PCRE  was built. Setting the first or the second specifies that a
1347         newline  is  indicated  by a single character (CR or LF, respectively).         newline is indicated by a single character (CR  or  LF,  respectively).
1348         Setting PCRE_NEWLINE_CRLF specifies that a newline is indicated by  the         Setting  PCRE_NEWLINE_CRLF specifies that a newline is indicated by the
1349         two-character  CRLF  sequence.  Setting  PCRE_NEWLINE_ANYCRLF specifies         two-character CRLF  sequence.  Setting  PCRE_NEWLINE_ANYCRLF  specifies
1350         that any of the three preceding sequences should be recognized. Setting         that any of the three preceding sequences should be recognized. Setting
1351         PCRE_NEWLINE_ANY  specifies that any Unicode newline sequence should be         PCRE_NEWLINE_ANY specifies that any Unicode newline sequence should  be
1352         recognized. The Unicode newline sequences are the three just mentioned,         recognized. The Unicode newline sequences are the three just mentioned,
1353         plus  the  single  characters  VT (vertical tab, U+000B), FF (formfeed,         plus the single characters VT (vertical  tab,  U+000B),  FF  (formfeed,
1354         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
1355         (paragraph  separator,  U+2029).  The  last  two are recognized only in         (paragraph separator, U+2029). The last  two  are  recognized  only  in
1356         UTF-8 mode.         UTF-8 mode.
1357    
1358         The newline setting in the  options  word  uses  three  bits  that  are         The  newline  setting  in  the  options  word  uses three bits that are
1359         treated as a number, giving eight possibilities. Currently only six are         treated as a number, giving eight possibilities. Currently only six are
1360         used (default plus the five values above). This means that if  you  set         used  (default  plus the five values above). This means that if you set
1361         more  than one newline option, the combination may or may not be sensi-         more than one newline option, the combination may or may not be  sensi-
1362         ble. For example, PCRE_NEWLINE_CR with PCRE_NEWLINE_LF is equivalent to         ble. For example, PCRE_NEWLINE_CR with PCRE_NEWLINE_LF is equivalent to
1363         PCRE_NEWLINE_CRLF,  but other combinations may yield unused numbers and         PCRE_NEWLINE_CRLF, but other combinations may yield unused numbers  and
1364         cause an error.         cause an error.
1365    
1366         The only time that a line break is specially recognized when  compiling         The  only time that a line break is specially recognized when compiling
1367         a  pattern  is  if  PCRE_EXTENDED  is set, and an unescaped # outside a         a pattern is if PCRE_EXTENDED is set, and  an  unescaped  #  outside  a
1368         character class is encountered. This indicates  a  comment  that  lasts         character  class  is  encountered.  This indicates a comment that lasts
1369         until  after the next line break sequence. In other circumstances, line         until after the next line break sequence. In other circumstances,  line
1370         break  sequences  are  treated  as  literal  data,   except   that   in         break   sequences   are   treated  as  literal  data,  except  that  in
1371         PCRE_EXTENDED mode, both CR and LF are treated as whitespace characters         PCRE_EXTENDED mode, both CR and LF are treated as whitespace characters
1372         and are therefore ignored.         and are therefore ignored.
1373    
1374         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
1375         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.
1376    
1377           PCRE_NO_AUTO_CAPTURE           PCRE_NO_AUTO_CAPTURE
1378    
# Line 1194  COMPILING A PATTERN Line 1382  COMPILING A PATTERN
1382         be  used  for  capturing  (and  they acquire numbers in the usual way).         be  used  for  capturing  (and  they acquire numbers in the usual way).
1383         There is no equivalent of this option in Perl.         There is no equivalent of this option in Perl.
1384    
1385             PCRE_UCP
1386    
1387           This option changes the way PCRE processes \b, \d, \s, \w, and some  of
1388           the POSIX character classes. By default, only ASCII characters are rec-
1389           ognized, but if PCRE_UCP is set, Unicode properties are used instead to
1390           classify  characters.  More details are given in the section on generic
1391           character types in the pcrepattern page. If you set PCRE_UCP,  matching
1392           one  of the items it affects takes much longer. The option is available
1393           only if PCRE has been compiled with Unicode property support.
1394    
1395           PCRE_UNGREEDY           PCRE_UNGREEDY
1396    
1397         This option inverts the "greediness" of the quantifiers  so  that  they         This option inverts the "greediness" of the quantifiers  so  that  they
# Line 1213  COMPILING A PATTERN Line 1411  COMPILING A PATTERN
1411           PCRE_NO_UTF8_CHECK           PCRE_NO_UTF8_CHECK
1412    
1413         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
1414         automatically  checked. If an invalid UTF-8 sequence of bytes is found,         automatically  checked.  There  is  a  discussion about the validity of
1415         pcre_compile() returns an error. If you already know that your  pattern         UTF-8 strings in the main pcre page. If an invalid  UTF-8  sequence  of
1416         is  valid, and you want to skip this check for performance reasons, you         bytes  is  found,  pcre_compile() returns an error. If you already know
1417         can set the PCRE_NO_UTF8_CHECK option. When it is set,  the  effect  of         that your pattern is valid, and you want to skip this check for perfor-
1418         passing an invalid UTF-8 string as a pattern is undefined. It may cause         mance  reasons,  you  can set the PCRE_NO_UTF8_CHECK option. When it is
1419         your program to crash.  Note that this option can  also  be  passed  to         set, the effect of passing an invalid UTF-8  string  as  a  pattern  is
1420         pcre_exec()  and pcre_dfa_exec(), to suppress the UTF-8 validity check-         undefined.  It  may  cause your program to crash. Note that this option
1421         ing of subject strings.         can also be passed to pcre_exec() and pcre_dfa_exec(), to suppress  the
1422           UTF-8 validity checking of subject strings.
1423    
1424    
1425  COMPILATION ERROR CODES  COMPILATION ERROR CODES
1426    
1427         The following table lists the error  codes  than  may  be  returned  by         The  following  table  lists  the  error  codes than may be returned by
1428         pcre_compile2(),  along with the error messages that may be returned by         pcre_compile2(), along with the error messages that may be returned  by
1429         both compiling functions. As PCRE has developed, some error codes  have         both  compiling functions. As PCRE has developed, some error codes have
1430         fallen out of use. To avoid confusion, they have not been re-used.         fallen out of use. To avoid confusion, they have not been re-used.
1431    
1432            0  no error            0  no error
# Line 1242  COMPILATION ERROR CODES Line 1441  COMPILATION ERROR CODES
1441            9  nothing to repeat            9  nothing to repeat
1442           10  [this code is not in use]           10  [this code is not in use]
1443           11  internal error: unexpected repeat           11  internal error: unexpected repeat
1444           12  unrecognized character after (?           12  unrecognized character after (? or (?-
1445           13  POSIX named classes are supported only within a class           13  POSIX named classes are supported only within a class
1446           14  missing )           14  missing )
1447           15  reference to non-existent subpattern           15  reference to non-existent subpattern
# Line 1250  COMPILATION ERROR CODES Line 1449  COMPILATION ERROR CODES
1449           17  unknown option bit(s) set           17  unknown option bit(s) set
1450           18  missing ) after comment           18  missing ) after comment
1451           19  [this code is not in use]           19  [this code is not in use]
1452           20  regular expression too large           20  regular expression is too large
1453           21  failed to get memory           21  failed to get memory
1454           22  unmatched parentheses           22  unmatched parentheses
1455           23  internal error: code overflow           23  internal error: code overflow
# Line 1259  COMPILATION ERROR CODES Line 1458  COMPILATION ERROR CODES
1458           26  malformed number or name after (?(           26  malformed number or name after (?(
1459           27  conditional group contains more than two branches           27  conditional group contains more than two branches
1460           28  assertion expected after (?(           28  assertion expected after (?(
1461           29  (?R or (?digits must be followed by )           29  (?R or (?[+-]digits must be followed by )
1462           30  unknown POSIX class name           30  unknown POSIX class name
1463           31  POSIX collating elements are not supported           31  POSIX collating elements are not supported
1464           32  this version of PCRE is not compiled with PCRE_UTF8 support           32  this version of PCRE is not compiled with PCRE_UTF8 support
# Line 1279  COMPILATION ERROR CODES Line 1478  COMPILATION ERROR CODES
1478           46  malformed \P or \p sequence           46  malformed \P or \p sequence
1479           47  unknown property name after \P or \p           47  unknown property name after \P or \p
1480           48  subpattern name is too long (maximum 32 characters)           48  subpattern name is too long (maximum 32 characters)
1481           49  too many named subpatterns (maximum 10,000)           49  too many named subpatterns (maximum 10000)
1482           50  repeated subpattern is too long           50  [this code is not in use]
1483           51  octal value is greater than \377 (not in UTF-8 mode)           51  octal value is greater than \377 (not in UTF-8 mode)
1484           52  internal error: overran compiling workspace           52  internal error: overran compiling workspace
1485           53   internal  error:  previously-checked  referenced  subpattern not           53  internal error: previously-checked referenced subpattern
1486         found                 not found
1487           54  DEFINE group contains more than one branch           54  DEFINE group contains more than one branch
1488           55  repeating a DEFINE group is not allowed           55  repeating a DEFINE group is not allowed
1489           56  inconsistent NEWLINE options"           56  inconsistent NEWLINE options
1490             57  \g is not followed by a braced, angle-bracketed, or quoted
1491                   name/number or by a plain number
1492             58  a numbered reference must not be zero
1493             59  an argument is not allowed for (*ACCEPT), (*FAIL), or (*COMMIT)
1494             60  (*VERB) not recognized
1495             61  number is too big
1496             62  subpattern name expected
1497             63  digit expected after (?+
1498             64  ] is an invalid data character in JavaScript compatibility mode
1499             65  different names for subpatterns of the same number are
1500                   not allowed
1501             66  (*MARK) must have an argument
1502             67  this version of PCRE is not compiled with PCRE_UCP support
1503    
1504           The numbers 32 and 10000 in errors 48 and 49  are  defaults;  different
1505           values may be used if the limits were changed when PCRE was built.
1506    
1507    
1508  STUDYING A PATTERN  STUDYING A PATTERN
# Line 1295  STUDYING A PATTERN Line 1510  STUDYING A PATTERN
1510         pcre_extra *pcre_study(const pcre *code, int options         pcre_extra *pcre_study(const pcre *code, int options
1511              const char **errptr);              const char **errptr);
1512    
1513         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
1514         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
1515         matching. The function pcre_study() takes a pointer to a compiled  pat-         matching.  The function pcre_study() takes a pointer to a compiled pat-
1516         tern as its first argument. If studying the pattern produces additional         tern as its first argument. If studying the pattern produces additional
1517         information that will help speed up matching,  pcre_study()  returns  a         information  that  will  help speed up matching, pcre_study() returns a
1518         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
1519         the results of the study.         the results of the study.
1520    
1521         The  returned  value  from  pcre_study()  can  be  passed  directly  to         The  returned  value  from  pcre_study()  can  be  passed  directly  to
1522         pcre_exec().  However,  a  pcre_extra  block also contains other fields         pcre_exec() or pcre_dfa_exec(). However, a pcre_extra block  also  con-
1523         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
1524         described below in the section on matching a pattern.         passed; these are described below in the section on matching a pattern.
1525    
1526         If  studying  the  pattern  does not produce any additional information         If studying the  pattern  does  not  produce  any  useful  information,
1527         pcre_study() returns NULL. In that circumstance, if the calling program         pcre_study() returns NULL. In that circumstance, if the calling program
1528         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
1529         its own pcre_extra block.         pcre_dfa_exec(), it must set up its own pcre_extra block.
1530    
1531         The second argument of pcre_study() contains option bits.  At  present,         The  second  argument of pcre_study() contains option bits. At present,
1532         no options are defined, and this argument should always be zero.         no options are defined, and this argument should always be zero.
1533    
1534         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.
1535         If studying succeeds (even if no data is  returned),  the  variable  it         If  studying  succeeds  (even  if no data is returned), the variable it
1536         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
1537         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
1538         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
1539         after calling pcre_study(), to be sure that it has run successfully.         after calling pcre_study(), to be sure that it has run successfully.
1540    
1541         This is a typical call to pcre_study():         This is a typical call to pcre_study():
# Line 1331  STUDYING A PATTERN Line 1546  STUDYING A PATTERN
1546             0,              /* no options exist */             0,              /* no options exist */
1547             &error);        /* set to NULL or points to a message */             &error);        /* set to NULL or points to a message */
1548    
1549         At present, studying a pattern is useful only for non-anchored patterns         Studying a pattern does two things: first, a lower bound for the length
1550         that  do not have a single fixed starting character. A bitmap of possi-         of subject string that is needed to match the pattern is computed. This
1551         ble starting bytes is created.         does not mean that there are any strings of that length that match, but
1552           it does guarantee that no shorter strings match. The value is  used  by
1553           pcre_exec()  and  pcre_dfa_exec()  to  avoid  wasting time by trying to
1554           match strings that are shorter than the lower bound. You can  find  out
1555           the value in a calling program via the pcre_fullinfo() function.
1556    
1557           Studying a pattern is also useful for non-anchored patterns that do not
1558           have a single fixed starting character. A bitmap of  possible  starting
1559           bytes  is  created. This speeds up finding a position in the subject at
1560           which to start matching.
1561    
1562           The two optimizations just described can be  disabled  by  setting  the
1563           PCRE_NO_START_OPTIMIZE    option    when    calling    pcre_exec()   or
1564           pcre_dfa_exec(). You might want to do this  if  your  pattern  contains
1565           callouts,  or  make  use of (*MARK), and you make use of these in cases
1566           where matching fails.  See  the  discussion  of  PCRE_NO_START_OPTIMIZE
1567           below.
1568    
1569    
1570  LOCALE SUPPORT  LOCALE SUPPORT
1571    
1572         PCRE handles caseless matching, and determines whether  characters  are         PCRE  handles  caseless matching, and determines whether characters are
1573         letters,  digits, or whatever, by reference to a set of tables, indexed         letters, digits, or whatever, by reference to a set of tables,  indexed
1574         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
1575         characters  with  codes  less than 128. Higher-valued codes never match         characters with codes less than 128. By  default,  higher-valued  codes
1576         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
1577         with  Unicode  character property support. The use of locales with Uni-         PCRE is built with Unicode character property  support.  Alternatively,
1578         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
1579         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
1580         not try to mix the two.         use of locales with Unicode is discouraged. If you are handling charac-
1581           ters with codes greater than 128, you should either use UTF-8 and  Uni-
1582           code, or use locales, but not try to mix the two.
1583    
1584         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
1585         argument  of  pcre_compile()  is  NULL.  These  are sufficient for many         argument of pcre_compile() is  NULL.  These  are  sufficient  for  many
1586         applications.  Normally, the internal tables recognize only ASCII char-         applications.  Normally, the internal tables recognize only ASCII char-
1587         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-
1588         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,
1589         which may cause them to be different.         which may cause them to be different.
1590    
1591         The  internal tables can always be overridden by tables supplied by the         The internal tables can always be overridden by tables supplied by  the
1592         application that calls PCRE. These may be created in a different locale         application that calls PCRE. These may be created in a different locale
1593         from  the  default.  As more and more applications change to using Uni-         from the default. As more and more applications change  to  using  Uni-
1594         code, the need for this locale support is expected to die away.         code, the need for this locale support is expected to die away.
1595    
1596         External tables are built by calling  the  pcre_maketables()  function,         External  tables  are  built by calling the pcre_maketables() function,
1597         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
1598         passed to pcre_compile() or pcre_exec()  as  often  as  necessary.  For         passed  to  pcre_compile()  or  pcre_exec()  as often as necessary. For
1599         example,  to  build  and use tables that are appropriate for the French         example, to build and use tables that are appropriate  for  the  French
1600         locale (where accented characters with  values  greater  than  128  are         locale  (where  accented  characters  with  values greater than 128 are
1601         treated as letters), the following code could be used:         treated as letters), the following code could be used:
1602    
1603           setlocale(LC_CTYPE, "fr_FR");           setlocale(LC_CTYPE, "fr_FR");
1604           tables = pcre_maketables();           tables = pcre_maketables();
1605           re = pcre_compile(..., tables);           re = pcre_compile(..., tables);
1606    
1607         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;
1608         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".
1609    
1610         When pcre_maketables() runs, the tables are built  in  memory  that  is         When  pcre_maketables()  runs,  the  tables are built in memory that is
1611         obtained  via  pcre_malloc. It is the caller's responsibility to ensure         obtained via pcre_malloc. It is the caller's responsibility  to  ensure
1612         that the memory containing the tables remains available for as long  as         that  the memory containing the tables remains available for as long as
1613         it is needed.         it is needed.
1614    
1615         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
1616         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()
1617         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-
1618         tern, compilation, studying and matching all happen in the same locale,         tern, compilation, studying and matching all happen in the same locale,
1619         but different patterns can be compiled in different locales.         but different patterns can be compiled in different locales.
1620    
1621         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
1622         the internal tables) to pcre_exec(). Although  not  intended  for  this         the  internal  tables)  to  pcre_exec(). Although not intended for this
1623         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
1624         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
1625         run time is discussed below in the section on matching a pattern.         run time is discussed below in the section on matching a pattern.
1626    
# Line 1397  INFORMATION ABOUT A PATTERN Line 1630  INFORMATION ABOUT A PATTERN
1630         int pcre_fullinfo(const pcre *code, const pcre_extra *extra,         int pcre_fullinfo(const pcre *code, const pcre_extra *extra,
1631              int what, void *where);              int what, void *where);
1632    
1633         The  pcre_fullinfo() function returns information about a compiled pat-         The pcre_fullinfo() function returns information about a compiled  pat-
1634         tern. It replaces the obsolete pcre_info() function, which is neverthe-         tern. It replaces the obsolete pcre_info() function, which is neverthe-
1635         less retained for backwards compability (and is documented below).         less retained for backwards compability (and is documented below).
1636    
1637         The  first  argument  for  pcre_fullinfo() is a pointer to the compiled         The first argument for pcre_fullinfo() is a  pointer  to  the  compiled
1638         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
1639         the  pattern  was not studied. The third argument specifies which piece         the pattern was not studied. The third argument specifies  which  piece
1640         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
1641         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
1642         success, or one of the following negative numbers:         success, or one of the following negative numbers:
1643    
1644           PCRE_ERROR_NULL       the argument code was NULL           PCRE_ERROR_NULL       the argument code was NULL
# Line 1413  INFORMATION ABOUT A PATTERN Line 1646  INFORMATION ABOUT A PATTERN
1646           PCRE_ERROR_BADMAGIC   the "magic number" was not found           PCRE_ERROR_BADMAGIC   the "magic number" was not found
1647           PCRE_ERROR_BADOPTION  the value of what was invalid           PCRE_ERROR_BADOPTION  the value of what was invalid
1648    
1649         The "magic number" is placed at the start of each compiled  pattern  as         The  "magic  number" is placed at the start of each compiled pattern as
1650         an  simple check against passing an arbitrary memory pointer. Here is a         an simple check against passing an arbitrary memory pointer. Here is  a
1651         typical call of pcre_fullinfo(), to obtain the length of  the  compiled         typical  call  of pcre_fullinfo(), to obtain the length of the compiled
1652         pattern:         pattern:
1653    
1654           int rc;           int rc;
# Line 1426  INFORMATION ABOUT A PATTERN Line 1659  INFORMATION ABOUT A PATTERN
1659             PCRE_INFO_SIZE,   /* what is required */             PCRE_INFO_SIZE,   /* what is required */
1660             &length);         /* where to put the data */             &length);         /* where to put the data */
1661    
1662         The  possible  values for the third argument are defined in pcre.h, and         The possible values for the third argument are defined in  pcre.h,  and
1663         are as follows:         are as follows:
1664    
1665           PCRE_INFO_BACKREFMAX           PCRE_INFO_BACKREFMAX
1666    
1667         Return the number of the highest back reference  in  the  pattern.  The         Return  the  number  of  the highest back reference in the pattern. The
1668         fourth  argument  should  point to an int variable. Zero is returned if         fourth argument should point to an int variable. Zero  is  returned  if
1669         there are no back references.         there are no back references.
1670    
1671           PCRE_INFO_CAPTURECOUNT           PCRE_INFO_CAPTURECOUNT
1672    
1673         Return the number of capturing subpatterns in the pattern.  The  fourth         Return  the  number of capturing subpatterns in the pattern. The fourth
1674         argument should point to an int variable.         argument should point to an int variable.
1675    
1676           PCRE_INFO_DEFAULT_TABLES           PCRE_INFO_DEFAULT_TABLES
1677    
1678         Return  a pointer to the internal default character tables within PCRE.         Return a pointer to the internal default character tables within  PCRE.
1679         The fourth argument should point to an unsigned char *  variable.  This         The  fourth  argument should point to an unsigned char * variable. This
1680         information call is provided for internal use by the pcre_study() func-         information call is provided for internal use by the pcre_study() func-
1681         tion. External callers can cause PCRE to use  its  internal  tables  by         tion.  External  callers  can  cause PCRE to use its internal tables by
1682         passing a NULL table pointer.         passing a NULL table pointer.
1683    
1684           PCRE_INFO_FIRSTBYTE           PCRE_INFO_FIRSTBYTE
1685    
1686         Return  information  about  the first byte of any matched string, for a         Return information about the first byte of any matched  string,  for  a
1687         non-anchored pattern. The fourth argument should point to an int  vari-         non-anchored  pattern. The fourth argument should point to an int vari-
1688         able.  (This option used to be called PCRE_INFO_FIRSTCHAR; the old name         able. (This option used to be called PCRE_INFO_FIRSTCHAR; the old  name
1689         is still recognized for backwards compatibility.)         is still recognized for backwards compatibility.)
1690    
1691         If there is a fixed first byte, for example, from  a  pattern  such  as         If  there  is  a  fixed first byte, for example, from a pattern such as
1692         (cat|cow|coyote), its value is returned. Otherwise, if either         (cat|cow|coyote), its value is returned. Otherwise, if either
1693    
1694         (a)  the pattern was compiled with the PCRE_MULTILINE option, and every         (a) the pattern was compiled with the PCRE_MULTILINE option, and  every
1695         branch starts with "^", or         branch starts with "^", or
1696    
1697         (b) every branch of the pattern starts with ".*" and PCRE_DOTALL is not         (b) every branch of the pattern starts with ".*" and PCRE_DOTALL is not
1698         set (if it were set, the pattern would be anchored),         set (if it were set, the pattern would be anchored),
1699    
1700         -1  is  returned, indicating that the pattern matches only at the start         -1 is returned, indicating that the pattern matches only at  the  start
1701         of a subject string or after any newline within the  string.  Otherwise         of  a  subject string or after any newline within the string. Otherwise
1702         -2 is returned. For anchored patterns, -2 is returned.         -2 is returned. For anchored patterns, -2 is returned.
1703    
1704           PCRE_INFO_FIRSTTABLE           PCRE_INFO_FIRSTTABLE
1705    
1706         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
1707         256-bit table indicating a fixed set of bytes for the first byte in any         256-bit table indicating a fixed set of bytes for the first byte in any
1708         matching  string, a pointer to the table is returned. Otherwise NULL is         matching string, a pointer to the table is returned. Otherwise NULL  is
1709         returned. The fourth argument should point to an unsigned char *  vari-         returned.  The fourth argument should point to an unsigned char * vari-
1710         able.         able.
1711    
1712             PCRE_INFO_HASCRORLF
1713    
1714           Return 1 if the pattern contains any explicit  matches  for  CR  or  LF
1715           characters,  otherwise  0.  The  fourth argument should point to an int
1716           variable. An explicit match is either a literal CR or LF character,  or
1717           \r or \n.
1718    
1719           PCRE_INFO_JCHANGED           PCRE_INFO_JCHANGED
1720    
1721         Return  1  if the (?J) option setting is used in the pattern, otherwise         Return  1  if  the (?J) or (?-J) option setting is used in the pattern,
1722         0. The fourth argument should point to an int variable. The (?J) inter-         otherwise 0. The fourth argument should point to an int variable.  (?J)
1723         nal option setting changes the local PCRE_DUPNAMES value.         and (?-J) set and unset the local PCRE_DUPNAMES option, respectively.
1724    
1725           PCRE_INFO_LASTLITERAL           PCRE_INFO_LASTLITERAL
1726    
# Line 1492  INFORMATION ABOUT A PATTERN Line 1732  INFORMATION ABOUT A PATTERN
1732         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
1733         /^a\dz\d/ the returned value is -1.         /^a\dz\d/ the returned value is -1.
1734    
1735             PCRE_INFO_MINLENGTH
1736    
1737           If  the  pattern  was studied and a minimum length for matching subject
1738           strings was computed, its value is  returned.  Otherwise  the  returned
1739           value  is  -1. The value is a number of characters, not bytes (this may
1740           be relevant in UTF-8 mode). The fourth argument should point to an  int
1741           variable.  A  non-negative  value is a lower bound to the length of any
1742           matching string. There may not be any strings of that  length  that  do
1743           actually match, but every string that does match is at least that long.
1744    
1745           PCRE_INFO_NAMECOUNT           PCRE_INFO_NAMECOUNT
1746           PCRE_INFO_NAMEENTRYSIZE           PCRE_INFO_NAMEENTRYSIZE
1747           PCRE_INFO_NAMETABLE           PCRE_INFO_NAMETABLE
# Line 1513  INFORMATION ABOUT A PATTERN Line 1763  INFORMATION ABOUT A PATTERN
1763         a  pointer  to  the  first  entry of the table (a pointer to char). The         a  pointer  to  the  first  entry of the table (a pointer to char). The
1764         first two bytes of each entry are the number of the capturing parenthe-         first two bytes of each entry are the number of the capturing parenthe-
1765         sis,  most  significant byte first. The rest of the entry is the corre-         sis,  most  significant byte first. The rest of the entry is the corre-
1766         sponding name, zero terminated. The names are  in  alphabetical  order.         sponding name, zero terminated.
1767         When PCRE_DUPNAMES is set, duplicate names are in order of their paren-  
1768         theses numbers. For example, consider  the  following  pattern  (assume         The names are in alphabetical order. Duplicate names may appear if  (?|
1769         PCRE_EXTENDED  is  set,  so  white  space  -  including  newlines  - is         is used to create multiple groups with the same number, as described in
1770         ignored):         the section on duplicate subpattern numbers in  the  pcrepattern  page.
1771           Duplicate  names  for  subpatterns with different numbers are permitted
1772           only if PCRE_DUPNAMES is set. In all cases  of  duplicate  names,  they
1773           appear  in  the table in the order in which they were found in the pat-
1774           tern. In the absence of (?| this is the  order  of  increasing  number;
1775           when (?| is used this is not necessarily the case because later subpat-
1776           terns may have lower numbers.
1777    
1778           As a simple example of the name/number table,  consider  the  following
1779           pattern  (assume  PCRE_EXTENDED is set, so white space - including new-
1780           lines - is ignored):
1781    
1782           (?<date> (?<year>(\d\d)?\d\d) -           (?<date> (?<year>(\d\d)?\d\d) -
1783           (?<month>\d\d) - (?<day>\d\d) )           (?<month>\d\d) - (?<day>\d\d) )
# Line 1538  INFORMATION ABOUT A PATTERN Line 1798  INFORMATION ABOUT A PATTERN
1798    
1799           PCRE_INFO_OKPARTIAL           PCRE_INFO_OKPARTIAL
1800    
1801         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
1802         The fourth argument should point to an int  variable.  The  pcrepartial         pcre_exec(), otherwise 0. The fourth argument should point  to  an  int
1803         documentation  lists  the restrictions that apply to patterns when par-         variable.  From  release  8.00,  this  always  returns  1,  because the
1804         tial matching is used.         restrictions that previously applied  to  partial  matching  have  been
1805           lifted.  The  pcrepartial documentation gives details of partial match-
1806           ing.
1807    
1808           PCRE_INFO_OPTIONS           PCRE_INFO_OPTIONS
1809    
1810         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
1811         fourth  argument  should  point to an unsigned long int variable. These         fourth  argument  should  point to an unsigned long int variable. These
1812         option bits are those specified in the call to pcre_compile(), modified         option bits are those specified in the call to pcre_compile(), modified
1813         by any top-level option settings within the pattern itself.         by any top-level option settings at the start of the pattern itself. In
1814           other words, they are the options that will be in force  when  matching
1815           starts.  For  example, if the pattern /(?im)abc(?-i)d/ is compiled with
1816           the PCRE_EXTENDED option, the result is PCRE_CASELESS,  PCRE_MULTILINE,
1817           and PCRE_EXTENDED.
1818    
1819         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
1820         alternatives begin with one of the following:         alternatives begin with one of the following:
# Line 1574  INFORMATION ABOUT A PATTERN Line 1840  INFORMATION ABOUT A PATTERN
1840         Return the size of the data block pointed to by the study_data field in         Return the size of the data block pointed to by the study_data field in
1841         a  pcre_extra  block.  That  is,  it  is  the  value that was passed to         a  pcre_extra  block.  That  is,  it  is  the  value that was passed to
1842         pcre_malloc() when PCRE was getting memory into which to place the data         pcre_malloc() when PCRE was getting memory into which to place the data
1843         created  by  pcre_study(). The fourth argument should point to a size_t         created  by  pcre_study().  If pcre_extra is NULL, or there is no study
1844           data, zero is returned. The fourth argument should point  to  a  size_t
1845         variable.         variable.
1846    
1847    
# Line 1582  OBSOLETE INFO FUNCTION Line 1849  OBSOLETE INFO FUNCTION
1849    
1850         int pcre_info(const pcre *code, int *optptr, int *firstcharptr);         int pcre_info(const pcre *code, int *optptr, int *firstcharptr);
1851    
1852         The pcre_info() function is now obsolete because its interface  is  too         The  pcre_info()  function is now obsolete because its interface is too
1853         restrictive  to return all the available data about a compiled pattern.         restrictive to return all the available data about a compiled  pattern.
1854         New  programs  should  use  pcre_fullinfo()  instead.  The   yield   of         New   programs   should  use  pcre_fullinfo()  instead.  The  yield  of
1855         pcre_info()  is the number of capturing subpatterns, or one of the fol-         pcre_info() is the number of capturing subpatterns, or one of the  fol-
1856         lowing negative numbers:         lowing negative numbers:
1857    
1858           PCRE_ERROR_NULL       the argument code was NULL           PCRE_ERROR_NULL       the argument code was NULL
1859           PCRE_ERROR_BADMAGIC   the "magic number" was not found           PCRE_ERROR_BADMAGIC   the "magic number" was not found
1860    
1861         If the optptr argument is not NULL, a copy of the  options  with  which         If  the  optptr  argument is not NULL, a copy of the options with which
1862         the  pattern  was  compiled  is placed in the integer it points to (see         the pattern was compiled is placed in the integer  it  points  to  (see
1863         PCRE_INFO_OPTIONS above).         PCRE_INFO_OPTIONS above).
1864    
1865         If the pattern is not anchored and the  firstcharptr  argument  is  not         If  the  pattern  is  not anchored and the firstcharptr argument is not
1866         NULL,  it is used to pass back information about the first character of         NULL, it is used to pass back information about the first character  of
1867         any matched string (see PCRE_INFO_FIRSTBYTE above).         any matched string (see PCRE_INFO_FIRSTBYTE above).
1868    
1869    
# Line 1604  REFERENCE COUNTS Line 1871  REFERENCE COUNTS
1871    
1872         int pcre_refcount(pcre *code, int adjust);         int pcre_refcount(pcre *code, int adjust);
1873    
1874         The pcre_refcount() function is used to maintain a reference  count  in         The  pcre_refcount()  function is used to maintain a reference count in
1875         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
1876         benefit of applications that  operate  in  an  object-oriented  manner,         benefit  of  applications  that  operate  in an object-oriented manner,
1877         where different parts of the application may be using the same compiled         where different parts of the application may be using the same compiled
1878         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.
1879    
1880         When a pattern is compiled, the reference count field is initialized to         When a pattern is compiled, the reference count field is initialized to
1881         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
1882         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
1883         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
1884         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
1885         is outside these limits, it is forced to the appropriate limit value.         is outside these limits, it is forced to the appropriate limit value.
1886    
1887         Except  when it is zero, the reference count is not correctly preserved         Except when it is zero, the reference count is not correctly  preserved
1888         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
1889         whose byte-order is different. (This seems a highly unlikely scenario.)         whose byte-order is different. (This seems a highly unlikely scenario.)
1890    
1891    
# Line 1630  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 1897  MATCHING A PATTERN: THE TRADITIONAL FUNC
1897    
1898         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
1899         compiled  pattern, which is passed in the code argument. If the pattern         compiled  pattern, which is passed in the code argument. If the pattern
1900         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
1901         argument.  This  function is the main matching facility of the library,         argument.  This  function is the main matching facility of the library,
1902         and it operates in a Perl-like manner. For specialist use there is also         and it operates in a Perl-like manner. For specialist use there is also
1903         an  alternative matching function, which is described below in the sec-         an  alternative matching function, which is described below in the sec-
# Line 1670  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 1937  MATCHING A PATTERN: THE TRADITIONAL FUNC
1937           unsigned long int match_limit_recursion;           unsigned long int match_limit_recursion;
1938           void *callout_data;           void *callout_data;
1939           const unsigned char *tables;           const unsigned char *tables;
1940             unsigned char **mark;
1941    
1942         The flags field is a bitmap that specifies which of  the  other  fields         The flags field is a bitmap that specifies which of  the  other  fields
1943         are set. The flag bits are:         are set. The flag bits are:
# Line 1679  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 1947  MATCHING A PATTERN: THE TRADITIONAL FUNC
1947           PCRE_EXTRA_MATCH_LIMIT_RECURSION           PCRE_EXTRA_MATCH_LIMIT_RECURSION
1948           PCRE_EXTRA_CALLOUT_DATA           PCRE_EXTRA_CALLOUT_DATA
1949           PCRE_EXTRA_TABLES           PCRE_EXTRA_TABLES
1950             PCRE_EXTRA_MARK
1951    
1952         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 is set in
1953         the pcre_extra block that is returned by  pcre_study(),  together  with         the pcre_extra block that is returned by  pcre_study(),  together  with
# Line 1689  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 1958  MATCHING A PATTERN: THE TRADITIONAL FUNC
1958         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
1959         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
1960         match,  but  which  have  a very large number of possibilities in their         match,  but  which  have  a very large number of possibilities in their
1961         search trees. The classic  example  is  the  use  of  nested  unlimited         search trees. The classic example is a pattern that uses nested  unlim-
1962         repeats.         ited repeats.
1963    
1964         Internally,  PCRE uses a function called match() which it calls repeat-         Internally,  PCRE uses a function called match() which it calls repeat-
1965         edly (sometimes recursively). The limit set by match_limit  is  imposed         edly (sometimes recursively). The limit set by match_limit  is  imposed
# Line 1712  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 1981  MATCHING A PATTERN: THE TRADITIONAL FUNC
1981         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-
1982         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.
1983    
1984         Limiting the recursion depth limits the amount of  stack  that  can  be         Limiting  the  recursion  depth  limits the amount of stack that can be
1985         used, or, when PCRE has been compiled to use memory on the heap instead         used, or, when PCRE has been compiled to use memory on the heap instead
1986         of the stack, the amount of heap memory that can be used.         of the stack, the amount of heap memory that can be used.
1987    
1988         The default value for match_limit_recursion can be  set  when  PCRE  is         The  default  value  for  match_limit_recursion can be set when PCRE is
1989         built;  the  default  default  is  the  same  value  as the default for         built; the default default  is  the  same  value  as  the  default  for
1990         match_limit. You can override the default by suppling pcre_exec()  with         match_limit.  You can override the default by suppling pcre_exec() with
1991         a   pcre_extra   block  in  which  match_limit_recursion  is  set,  and         a  pcre_extra  block  in  which  match_limit_recursion  is   set,   and
1992         PCRE_EXTRA_MATCH_LIMIT_RECURSION is set in  the  flags  field.  If  the         PCRE_EXTRA_MATCH_LIMIT_RECURSION  is  set  in  the  flags field. If the
1993         limit is exceeded, pcre_exec() returns PCRE_ERROR_RECURSIONLIMIT.         limit is exceeded, pcre_exec() returns PCRE_ERROR_RECURSIONLIMIT.
1994    
1995         The  pcre_callout  field is used in conjunction with the "callout" fea-         The callout_data field is used in conjunction with the  "callout"  fea-
1996         ture, which is described in the pcrecallout documentation.         ture, and is described in the pcrecallout documentation.
1997    
1998         The tables field  is  used  to  pass  a  character  tables  pointer  to         The  tables  field  is  used  to  pass  a  character  tables pointer to
1999         pcre_exec();  this overrides the value that is stored with the compiled         pcre_exec(); this overrides the value that is stored with the  compiled
2000         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
2001         custom  tables  were  supplied to pcre_compile() via its tableptr argu-         custom tables were supplied to pcre_compile() via  its  tableptr  argu-
2002         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
2003         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-
2004         using patterns that have been saved after compiling  with  an  external         using  patterns  that  have been saved after compiling with an external
2005         set  of  tables,  because  the  external tables might be at a different         set of tables, because the external tables  might  be  at  a  different
2006         address when pcre_exec() is called. See the  pcreprecompile  documenta-         address  when  pcre_exec() is called. See the pcreprecompile documenta-
2007         tion for a discussion of saving compiled patterns for later use.         tion for a discussion of saving compiled patterns for later use.
2008    
2009           If PCRE_EXTRA_MARK is set in the flags field, the mark  field  must  be
2010           set  to  point  to a char * variable. If the pattern contains any back-
2011           tracking control verbs such as (*MARK:NAME), and the execution ends  up
2012           with  a  name  to  pass back, a pointer to the name string (zero termi-
2013           nated) is placed in the variable pointed to  by  the  mark  field.  The
2014           names  are  within  the  compiled pattern; if you wish to retain such a
2015           name you must copy it before freeing the memory of a compiled  pattern.
2016           If  there  is no name to pass back, the variable pointed to by the mark
2017           field set to NULL. For details of the backtracking control  verbs,  see
2018           the section entitled "Backtracking control" in the pcrepattern documen-
2019           tation.
2020    
2021     Option bits for pcre_exec()     Option bits for pcre_exec()
2022    
2023         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.
2024         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,
2025         PCRE_NOTBOL,   PCRE_NOTEOL,   PCRE_NOTEMPTY,   PCRE_NO_UTF8_CHECK   and         PCRE_NOTBOL,   PCRE_NOTEOL,    PCRE_NOTEMPTY,    PCRE_NOTEMPTY_ATSTART,
2026         PCRE_PARTIAL.         PCRE_NO_START_OPTIMIZE,   PCRE_NO_UTF8_CHECK,   PCRE_PARTIAL_SOFT,  and
2027           PCRE_PARTIAL_HARD.
2028    
2029           PCRE_ANCHORED           PCRE_ANCHORED
2030    
# Line 1751  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 2033  MATCHING A PATTERN: THE TRADITIONAL FUNC
2033         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
2034         unachored at matching time.         unachored at matching time.
2035    
2036             PCRE_BSR_ANYCRLF
2037             PCRE_BSR_UNICODE
2038    
2039           These options (which are mutually exclusive) control what the \R escape
2040           sequence matches. The choice is either to match only CR, LF,  or  CRLF,
2041           or  to  match  any Unicode newline sequence. These options override the
2042           choice that was made or defaulted when the pattern was compiled.
2043    
2044           PCRE_NEWLINE_CR           PCRE_NEWLINE_CR
2045           PCRE_NEWLINE_LF           PCRE_NEWLINE_LF
2046           PCRE_NEWLINE_CRLF           PCRE_NEWLINE_CRLF
2047           PCRE_NEWLINE_ANYCRLF           PCRE_NEWLINE_ANYCRLF
2048           PCRE_NEWLINE_ANY           PCRE_NEWLINE_ANY
2049    
2050         These  options  override  the  newline  definition  that  was chosen or         These options override  the  newline  definition  that  was  chosen  or
2051         defaulted when the pattern was compiled. For details, see the  descrip-         defaulted  when the pattern was compiled. For details, see the descrip-
2052         tion  of  pcre_compile()  above.  During  matching,  the newline choice         tion of pcre_compile()  above.  During  matching,  the  newline  choice
2053         affects the behaviour of the dot, circumflex,  and  dollar  metacharac-         affects  the  behaviour  of the dot, circumflex, and dollar metacharac-
2054         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
2055         match  failure  for  an  unanchored  pattern.  When  PCRE_NEWLINE_CRLF,         match failure for an unanchored pattern.
2056         PCRE_NEWLINE_ANYCRLF,  or  PCRE_NEWLINE_ANY is set, and a match attempt  
2057         fails when the current position is at a CRLF sequence, the match  posi-         When  PCRE_NEWLINE_CRLF,  PCRE_NEWLINE_ANYCRLF,  or PCRE_NEWLINE_ANY is
2058         tion  is  advanced by two characters instead of one, in other words, to         set, and a match attempt for an unanchored pattern fails when the  cur-
2059         after the CRLF.         rent  position  is  at  a  CRLF  sequence,  and the pattern contains no
2060           explicit matches for  CR  or  LF  characters,  the  match  position  is
2061           advanced by two characters instead of one, in other words, to after the
2062           CRLF.
2063    
2064           The above rule is a compromise that makes the most common cases work as
2065           expected.  For  example,  if  the  pattern  is .+A (and the PCRE_DOTALL
2066           option is not set), it does not match the string "\r\nA" because, after
2067           failing  at the start, it skips both the CR and the LF before retrying.
2068           However, the pattern [\r\n]A does match that string,  because  it  con-
2069           tains an explicit CR or LF reference, and so advances only by one char-
2070           acter after the first failure.
2071    
2072           An explicit match for CR of LF is either a literal appearance of one of
2073           those  characters,  or  one  of the \r or \n escape sequences. Implicit
2074           matches such as [^X] do not count, nor does \s (which includes  CR  and
2075           LF in the characters that it matches).
2076    
2077           Notwithstanding  the above, anomalous effects may still occur when CRLF
2078           is a valid newline sequence and explicit \r or \n escapes appear in the
2079           pattern.
2080    
2081           PCRE_NOTBOL           PCRE_NOTBOL
2082    
2083         This option specifies that first character of the subject string is not         This option specifies that first character of the subject string is not
2084         the  beginning  of  a  line, so the circumflex metacharacter should not         the beginning of a line, so the  circumflex  metacharacter  should  not
2085         match before it. Setting this without PCRE_MULTILINE (at compile  time)         match  before it. Setting this without PCRE_MULTILINE (at compile time)
2086         causes  circumflex  never to match. This option affects only the behav-         causes circumflex never to match. This option affects only  the  behav-
2087         iour of the circumflex metacharacter. It does not affect \A.         iour of the circumflex metacharacter. It does not affect \A.
2088    
2089           PCRE_NOTEOL           PCRE_NOTEOL
2090    
2091         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
2092         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
2093         in multiline mode) a newline immediately before it. Setting this  with-         in  multiline mode) a newline immediately before it. Setting this with-
2094         out PCRE_MULTILINE (at compile time) causes dollar never to match. This         out PCRE_MULTILINE (at compile time) causes dollar never to match. This
2095         option affects only the behaviour of the dollar metacharacter. It  does         option  affects only the behaviour of the dollar metacharacter. It does
2096         not affect \Z or \z.         not affect \Z or \z.
2097    
2098           PCRE_NOTEMPTY           PCRE_NOTEMPTY
2099    
2100         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
2101         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
2102         the  alternatives  match  the empty string, the entire match fails. For         the alternatives match the empty string, the entire  match  fails.  For
2103         example, if the pattern         example, if the pattern
2104    
2105           a?b?           a?b?
2106    
2107         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
2108         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
2109         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-
2110         rences of "a" or "b".         rences of "a" or "b".
2111    
2112         Perl has no direct equivalent of PCRE_NOTEMPTY, but it does make a spe-           PCRE_NOTEMPTY_ATSTART
2113         cial case of a pattern match of the empty  string  within  its  split()  
2114         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
2115         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
2116         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.
2117         if that fails by advancing the starting offset (see below)  and  trying  
2118         an ordinary match again. There is some code that demonstrates how to do         Perl    has    no    direct    equivalent    of    PCRE_NOTEMPTY     or
2119         this in the pcredemo.c sample program.         PCRE_NOTEMPTY_ATSTART,  but  it  does  make a special case of a pattern
2120           match of the empty string within its split() function, and  when  using
2121           the  /g  modifier.  It  is  possible  to emulate Perl's behaviour after
2122           matching a null string by first trying the match again at the same off-
2123           set  with  PCRE_NOTEMPTY_ATSTART  and  PCRE_ANCHORED,  and then if that
2124           fails, by advancing the starting offset (see below) and trying an ordi-
2125           nary  match  again. There is some code that demonstrates how to do this
2126           in the pcredemo sample program.
2127    
2128             PCRE_NO_START_OPTIMIZE
2129    
2130           There are a number of optimizations that pcre_exec() uses at the  start
2131           of  a  match,  in  order to speed up the process. For example, if it is
2132           known that an unanchored match must start with a specific character, it
2133           searches  the  subject  for that character, and fails immediately if it
2134           cannot find it, without actually running the  main  matching  function.
2135           This means that a special item such as (*COMMIT) at the start of a pat-
2136           tern is not considered until after a suitable starting  point  for  the
2137           match  has been found. When callouts or (*MARK) items are in use, these
2138           "start-up" optimizations can cause them to be skipped if the pattern is
2139           never  actually  used.  The start-up optimizations are in effect a pre-
2140           scan of the subject that takes place before the pattern is run.
2141    
2142           The PCRE_NO_START_OPTIMIZE option disables the start-up  optimizations,
2143           possibly  causing  performance  to  suffer,  but ensuring that in cases
2144           where the result is "no match", the callouts do occur, and  that  items
2145           such as (*COMMIT) and (*MARK) are considered at every possible starting
2146           position in the subject  string.   Setting  PCRE_NO_START_OPTIMIZE  can
2147           change the outcome of a matching operation.  Consider the pattern
2148    
2149             (*COMMIT)ABC
2150    
2151           When  this  is  compiled, PCRE records the fact that a match must start
2152           with the character "A". Suppose the subject  string  is  "DEFABC".  The
2153           start-up  optimization  scans along the subject, finds "A" and runs the
2154           first match attempt from there. The (*COMMIT) item means that the  pat-
2155           tern  must  match the current starting position, which in this case, it
2156           does. However, if the same match  is  run  with  PCRE_NO_START_OPTIMIZE
2157           set,  the  initial  scan  along the subject string does not happen. The
2158           first match attempt is run starting  from  "D"  and  when  this  fails,
2159           (*COMMIT)  prevents  any  further  matches  being tried, so the overall
2160           result is "no match". If the pattern is studied,  more  start-up  opti-
2161           mizations  may  be  used. For example, a minimum length for the subject
2162           may be recorded. Consider the pattern
2163    
2164             (*MARK:A)(X|Y)
2165    
2166           The minimum length for a match is one  character.  If  the  subject  is
2167           "ABC",  there  will  be  attempts  to  match "ABC", "BC", "C", and then
2168           finally an empty string.  If the pattern is studied, the final  attempt
2169           does  not take place, because PCRE knows that the subject is too short,
2170           and so the (*MARK) is never encountered.  In this  case,  studying  the
2171           pattern  does  not  affect the overall match result, which is still "no
2172           match", but it does affect the auxiliary information that is returned.
2173    
2174           PCRE_NO_UTF8_CHECK           PCRE_NO_UTF8_CHECK
2175    
2176         When PCRE_UTF8 is set at compile time, the validity of the subject as a         When PCRE_UTF8 is set at compile time, the validity of the subject as a
2177         UTF-8  string is automatically checked when pcre_exec() is subsequently         UTF-8  string is automatically checked when pcre_exec() is subsequently
2178         called.  The value of startoffset is also checked  to  ensure  that  it         called.  The value of startoffset is also checked  to  ensure  that  it
2179         points  to the start of a UTF-8 character. If an invalid UTF-8 sequence         points  to  the start of a UTF-8 character. There is a discussion about
2180         of bytes is found, pcre_exec() returns the error PCRE_ERROR_BADUTF8. If         the validity of UTF-8 strings in the section on UTF-8  support  in  the
2181         startoffset  contains  an  invalid  value, PCRE_ERROR_BADUTF8_OFFSET is         main  pcre  page.  If  an  invalid  UTF-8  sequence  of bytes is found,
2182         returned.         pcre_exec() returns the error PCRE_ERROR_BADUTF8. If  startoffset  con-
2183           tains an invalid value, PCRE_ERROR_BADUTF8_OFFSET is returned.
2184         If you already know that your subject is valid, and you  want  to  skip  
2185         these    checks    for   performance   reasons,   you   can   set   the         If  you  already  know that your subject is valid, and you want to skip
2186         PCRE_NO_UTF8_CHECK option when calling pcre_exec(). You might  want  to         these   checks   for   performance   reasons,   you   can    set    the
2187         do  this  for the second and subsequent calls to pcre_exec() if you are         PCRE_NO_UTF8_CHECK  option  when calling pcre_exec(). You might want to
2188         making repeated calls to find all  the  matches  in  a  single  subject         do this for the second and subsequent calls to pcre_exec() if  you  are
2189         string.  However,  you  should  be  sure  that the value of startoffset         making  repeated  calls  to  find  all  the matches in a single subject
2190         points to the start of a UTF-8 character.  When  PCRE_NO_UTF8_CHECK  is         string. However, you should be  sure  that  the  value  of  startoffset
2191         set,  the  effect of passing an invalid UTF-8 string as a subject, or a         points  to  the  start of a UTF-8 character. When PCRE_NO_UTF8_CHECK is
2192         value of startoffset that does not point to the start of a UTF-8  char-         set, the effect of passing an invalid UTF-8 string as a subject,  or  a
2193           value  of startoffset that does not point to the start of a UTF-8 char-
2194         acter, is undefined. Your program may crash.         acter, is undefined. Your program may crash.
2195    
2196           PCRE_PARTIAL           PCRE_PARTIAL_HARD
2197             PCRE_PARTIAL_SOFT
2198    
2199         This  option  turns  on  the  partial  matching feature. If the subject         These options turn on the partial matching feature. For backwards  com-
2200         string fails to match the pattern, but at some point during the  match-         patibility,  PCRE_PARTIAL is a synonym for PCRE_PARTIAL_SOFT. A partial
2201         ing  process  the  end of the subject was reached (that is, the subject         match occurs if the end of the subject string is reached  successfully,
2202         partially matches the pattern and the failure to  match  occurred  only         but  there  are not enough subject characters to complete the match. If
2203         because  there were not enough subject characters), pcre_exec() returns         this happens when PCRE_PARTIAL_HARD  is  set,  pcre_exec()  immediately
2204         PCRE_ERROR_PARTIAL instead of PCRE_ERROR_NOMATCH. When PCRE_PARTIAL  is         returns  PCRE_ERROR_PARTIAL.  Otherwise,  if  PCRE_PARTIAL_SOFT is set,
2205         used,  there  are restrictions on what may appear in the pattern. These         matching continues by testing any other alternatives. Only if they  all
2206         are discussed in the pcrepartial documentation.         fail  is  PCRE_ERROR_PARTIAL  returned (instead of PCRE_ERROR_NOMATCH).
2207           The portion of the string that was inspected when the partial match was
2208           found  is  set  as  the first matching string. There is a more detailed
2209           discussion in the pcrepartial documentation.
2210    
2211     The string to be matched by pcre_exec()     The string to be matched by pcre_exec()
2212    
2213         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
2214         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.
2215         mode, the byte offset must point to the start  of  a  UTF-8  character.         In UTF-8 mode, the byte offset must point to the start of a UTF-8 char-
2216         Unlike  the  pattern string, the subject may contain binary zero bytes.         acter.  Unlike  the pattern string, the subject may contain binary zero
2217         When the starting offset is zero, the search for a match starts at  the         bytes. When the starting offset is zero, the search for a match  starts
2218         beginning of the subject, and this is by far the most common case.         at  the  beginning  of  the subject, and this is by far the most common
2219           case.
2220         A  non-zero  starting offset is useful when searching for another match  
2221         in the same subject by calling pcre_exec() again after a previous  suc-         A non-zero starting offset is useful when searching for  another  match
2222         cess.   Setting  startoffset differs from just passing over a shortened         in  the same subject by calling pcre_exec() again after a previous suc-
2223         string and setting PCRE_NOTBOL in the case of  a  pattern  that  begins         cess.  Setting startoffset differs from just passing over  a  shortened
2224           string  and  setting  PCRE_NOTBOL  in the case of a pattern that begins
2225         with any kind of lookbehind. For example, consider the pattern         with any kind of lookbehind. For example, consider the pattern
2226    
2227           \Biss\B           \Biss\B
2228    
2229         which  finds  occurrences  of "iss" in the middle of words. (\B matches         which finds occurrences of "iss" in the middle of  words.  (\B  matches
2230         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.)
2231         When  applied  to the string "Mississipi" the first call to pcre_exec()         When applied to the string "Mississipi" the first call  to  pcre_exec()
2232         finds the first occurrence. If pcre_exec() is called  again  with  just         finds  the  first  occurrence. If pcre_exec() is called again with just
2233         the  remainder  of  the  subject,  namely  "issipi", it does not match,         the remainder of the subject,  namely  "issipi",  it  does  not  match,
2234         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
2235         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
2236         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-
2237         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
2238         discover that it is preceded by a letter.         discover that it is preceded by a letter.
2239    
2240         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,
2241         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
2242         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
2243         subject.         subject.
2244    
2245     How pcre_exec() returns captured substrings     How pcre_exec() returns captured substrings
2246    
2247         In  general, a pattern matches a certain portion of the subject, and in         In general, a pattern matches a certain portion of the subject, and  in
2248         addition, further substrings from the subject  may  be  picked  out  by         addition,  further  substrings  from  the  subject may be picked out by
2249         parts  of  the  pattern.  Following the usage in Jeffrey Friedl's book,         parts of the pattern. Following the usage  in  Jeffrey  Friedl's  book,
2250         this is called "capturing" in what follows, and the  phrase  "capturing         this  is  called "capturing" in what follows, and the phrase "capturing
2251         subpattern"  is  used for a fragment of a pattern that picks out a sub-         subpattern" is used for a fragment of a pattern that picks out  a  sub-
2252         string. PCRE supports several other kinds of  parenthesized  subpattern         string.  PCRE  supports several other kinds of parenthesized subpattern
2253         that do not cause substrings to be captured.         that do not cause substrings to be captured.
2254    
2255         Captured  substrings are returned to the caller via a vector of integer         Captured substrings are returned to the caller via a vector of integers
2256         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-
2257         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:
2258         Note: this argument is NOT the size of ovector in bytes.         this argument is NOT the size of ovector in bytes.
2259    
2260         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-
2261         strings,  each  substring using a pair of integers. The remaining third         strings, each substring using a pair of integers. The  remaining  third
2262         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-
2263         turing  subpatterns, and is not available for passing back information.         turing subpatterns, and is not available for passing back  information.
2264         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
2265         it is not, it is rounded down.         it is not, it is rounded down.
2266    
2267         When  a  match  is successful, information about captured substrings is         When a match is successful, information about  captured  substrings  is
2268         returned in pairs of integers, starting at the  beginning  of  ovector,         returned  in  pairs  of integers, starting at the beginning of ovector,
2269         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
2270         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
2271         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
2272         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
2273         tor[1],  identify  the  portion  of  the  subject string matched by the         byte offsets, even in UTF-8 mode. They are not character counts.
2274         entire pattern. The next pair is used for the first  capturing  subpat-  
2275         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
2276         highest numbered pair that has been set. For example, if two substrings         portion  of  the subject string matched by the entire pattern. The next
2277         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
2278         subpatterns, the return value from a successful match is 1,  indicating         returned by pcre_exec() is one more than the highest numbered pair that
2279         that just the first pair of offsets has been set.         has been set.  For example, if two substrings have been  captured,  the
2280           returned  value is 3. If there are no capturing subpatterns, the return
2281           value from a successful match is 1, indicating that just the first pair
2282           of offsets has been set.
2283    
2284         If a capturing subpattern is matched repeatedly, it is the last portion         If a capturing subpattern is matched repeatedly, it is the last portion
2285         of the string that it matched that is returned.         of the string that it matched that is returned.
2286    
2287         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,
2288         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
2289         function returns a value of zero. In particular, if the substring  off-         function returns a value of zero. If the substring offsets are  not  of
2290         sets are not of interest, pcre_exec() may be called with ovector passed         interest,  pcre_exec()  may  be  called with ovector passed as NULL and
2291         as NULL and ovecsize as zero. However, if  the  pattern  contains  back         ovecsize as zero. However, if the pattern contains back references  and
2292         references  and  the  ovector is not big enough to remember the related         the  ovector is not big enough to remember the related substrings, PCRE
2293         substrings, PCRE has to get additional memory for use during  matching.         has to get additional memory for use during matching. Thus it  is  usu-
2294         Thus it is usually advisable to supply an ovector.         ally advisable to supply an ovector.
2295    
2296         The  pcre_info()  function  can  be used to find out how many capturing         The pcre_fullinfo() function can be used to find out how many capturing
2297         subpatterns there are in a compiled  pattern.  The  smallest  size  for         subpatterns there are in a compiled  pattern.  The  smallest  size  for
2298         ovector  that  will allow for n captured substrings, in addition to the         ovector  that  will allow for n captured substrings, in addition to the
2299         offsets of the substring matched by the whole pattern, is (n+1)*3.         offsets of the substring matched by the whole pattern, is (n+1)*3.
# Line 1984  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 2356  MATCHING A PATTERN: THE TRADITIONAL FUNC
2356         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
2357         memory is automatically freed at the end of matching.         memory is automatically freed at the end of matching.
2358    
2359           This error is also given if pcre_stack_malloc() fails  in  pcre_exec().
2360           This  can happen only when PCRE has been compiled with --disable-stack-
2361           for-recursion.
2362    
2363           PCRE_ERROR_NOSUBSTRING    (-7)           PCRE_ERROR_NOSUBSTRING    (-7)
2364    
2365         This error is used by the pcre_copy_substring(),  pcre_get_substring(),         This error is used by the pcre_copy_substring(),  pcre_get_substring(),
# Line 2020  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 2396  MATCHING A PATTERN: THE TRADITIONAL FUNC
2396    
2397           PCRE_ERROR_BADPARTIAL     (-13)           PCRE_ERROR_BADPARTIAL     (-13)
2398    
2399         The PCRE_PARTIAL option was used with  a  compiled  pattern  containing         This code is no longer in  use.  It  was  formerly  returned  when  the
2400         items  that are not supported for partial matching. See the pcrepartial         PCRE_PARTIAL  option  was used with a compiled pattern containing items
2401         documentation for details of partial matching.         that were  not  supported  for  partial  matching.  From  release  8.00
2402           onwards, there are no restrictions on partial matching.
2403    
2404           PCRE_ERROR_INTERNAL       (-14)           PCRE_ERROR_INTERNAL       (-14)
2405    
2406         An unexpected internal error has occurred. This error could  be  caused         An  unexpected  internal error has occurred. This error could be caused
2407         by a bug in PCRE or by overwriting of the compiled pattern.         by a bug in PCRE or by overwriting of the compiled pattern.
2408    
2409           PCRE_ERROR_BADCOUNT       (-15)           PCRE_ERROR_BADCOUNT       (-15)
2410    
2411         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.
2412    
2413           PCRE_ERROR_RECURSIONLIMIT (-21)           PCRE_ERROR_RECURSIONLIMIT (-21)
2414    
# Line 2039  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 2416  MATCHING A PATTERN: THE TRADITIONAL FUNC
2416         field  in  a  pcre_extra  structure (or defaulted) was reached. See the         field  in  a  pcre_extra  structure (or defaulted) was reached. See the
2417         description above.         description above.
2418    
          PCRE_ERROR_NULLWSLIMIT    (-22)  
   
        When a group that can match an empty  substring  is  repeated  with  an  
        unbounded  upper  limit, the subject position at the start of the group  
        must be remembered, so that a test for an empty string can be made when  
        the  end  of the group is reached. Some workspace is required for this;  
        if it runs out, this error is given.  
   
2419           PCRE_ERROR_BADNEWLINE     (-23)           PCRE_ERROR_BADNEWLINE     (-23)
2420    
2421         An invalid combination of PCRE_NEWLINE_xxx options was given.         An invalid combination of PCRE_NEWLINE_xxx options was given.
2422    
2423         Error numbers -16 to -20 are not used by pcre_exec().         Error numbers -16 to -20 and -22 are not used by pcre_exec().
2424    
2425    
2426  EXTRACTING CAPTURED SUBSTRINGS BY NUMBER  EXTRACTING CAPTURED SUBSTRINGS BY NUMBER
# Line 2189  EXTRACTING CAPTURED SUBSTRINGS BY NAME Line 2558  EXTRACTING CAPTURED SUBSTRINGS BY NAME
2558         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
2559         behaviour may not be what you want (see the next section).         behaviour may not be what you want (see the next section).
2560    
2561           Warning: If the pattern uses the (?| feature to set up multiple subpat-
2562           terns  with  the  same number, as described in the section on duplicate
2563           subpattern numbers in the pcrepattern page, you  cannot  use  names  to
2564           distinguish  the  different subpatterns, because names are not included
2565           in the compiled code. The matching process uses only numbers. For  this
2566           reason,  the  use of different names for subpatterns of the same number
2567           causes an error at compile time.
2568    
2569    
2570  DUPLICATE SUBPATTERN NAMES  DUPLICATE SUBPATTERN NAMES
2571    
# Line 2196  DUPLICATE SUBPATTERN NAMES Line 2573  DUPLICATE SUBPATTERN NAMES
2573              const char *name, char **first, char **last);              const char *name, char **first, char **last);
2574    
2575         When a pattern is compiled with the  PCRE_DUPNAMES  option,  names  for         When a pattern is compiled with the  PCRE_DUPNAMES  option,  names  for
2576         subpatterns  are  not  required  to  be unique. Normally, patterns with         subpatterns  are not required to be unique. (Duplicate names are always
2577         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  (?|
2578         subpatterns  participates. An example is shown in the pcrepattern docu-         feature.  Indeed,  if  such subpatterns are named, they are required to
2579         mentation. When duplicates are present, pcre_copy_named_substring() and         use the same names.)
2580    
2581           Normally, patterns with duplicate names are such that in any one match,
2582           only  one of the named subpatterns participates. An example is shown in
2583           the pcrepattern documentation.
2584    
2585           When   duplicates   are   present,   pcre_copy_named_substring()    and
2586         pcre_get_named_substring()  return the first substring corresponding to         pcre_get_named_substring()  return the first substring corresponding to
2587         the given name that is set.  If  none  are  set,  an  empty  string  is         the given name that is set. If  none  are  set,  PCRE_ERROR_NOSUBSTRING
2588         returned.  The pcre_get_stringnumber() function returns one of the num-         (-7)  is  returned;  no  data  is returned. The pcre_get_stringnumber()
2589         bers that are associated with the name, but it is not defined which  it         function returns one of the numbers that are associated with the  name,
2590         is.         but it is not defined which it is.
2591    
2592         If  you want to get full details of all captured substrings for a given         If  you want to get full details of all captured substrings for a given
2593         name, you must use  the  pcre_get_stringtable_entries()  function.  The         name, you must use  the  pcre_get_stringtable_entries()  function.  The
# Line 2250  MATCHING A PATTERN: THE ALTERNATIVE FUNC Line 2633  MATCHING A PATTERN: THE ALTERNATIVE FUNC
2633         characteristics  to  the  normal  algorithm, and is not compatible with         characteristics  to  the  normal  algorithm, and is not compatible with
2634         Perl. Some of the features of PCRE patterns are not  supported.  Never-         Perl. Some of the features of PCRE patterns are not  supported.  Never-
2635         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
2636         a discussion of the two matching algorithms, see the pcrematching docu-         a discussion of the two matching algorithms, and  a  list  of  features
2637         mentation.         that  pcre_dfa_exec() does not support, see the pcrematching documenta-
2638           tion.
2639    
2640         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
2641         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-
2642         ent  way,  and  this is described below. The other common arguments are         ent way, and this is described below. The other  common  arguments  are
2643         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
2644         repeated here.         repeated here.
2645    
2646         The  two  additional  arguments provide workspace for the function. The         The two additional arguments provide workspace for  the  function.  The
2647         workspace vector should contain at least 20 elements. It  is  used  for         workspace  vector  should  contain at least 20 elements. It is used for
2648         keeping  track  of  multiple  paths  through  the  pattern  tree.  More         keeping  track  of  multiple  paths  through  the  pattern  tree.  More
2649         workspace will be needed for patterns and subjects where  there  are  a         workspace  will  be  needed for patterns and subjects where there are a
2650         lot of potential matches.         lot of potential matches.
2651    
2652         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 2284  MATCHING A PATTERN: THE ALTERNATIVE FUNC Line 2668  MATCHING A PATTERN: THE ALTERNATIVE FUNC
2668    
2669     Option bits for pcre_dfa_exec()     Option bits for pcre_dfa_exec()
2670    
2671         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
2672         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-
2673         LINE_xxx,  PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NO_UTF8_CHECK,         LINE_xxx,        PCRE_NOTBOL,        PCRE_NOTEOL,        PCRE_NOTEMPTY,
2674         PCRE_PARTIAL, PCRE_DFA_SHORTEST, and PCRE_DFA_RESTART. All but the last         PCRE_NOTEMPTY_ATSTART,       PCRE_NO_UTF8_CHECK,      PCRE_BSR_ANYCRLF,
2675         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-
2676         not repeated here.         TIAL_SOFT,  PCRE_DFA_SHORTEST,  and PCRE_DFA_RESTART.  All but the last
2677           four of these are  exactly  the  same  as  for  pcre_exec(),  so  their
2678           PCRE_PARTIAL         description is not repeated here.
2679    
2680         This has the same general effect as it does for  pcre_exec(),  but  the           PCRE_PARTIAL_HARD
2681         details   are   slightly   different.  When  PCRE_PARTIAL  is  set  for           PCRE_PARTIAL_SOFT
2682         pcre_dfa_exec(), the return code PCRE_ERROR_NOMATCH is  converted  into  
2683         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
2684         been no complete matches, but there is still at least one matching pos-         details are slightly  different.  When  PCRE_PARTIAL_HARD  is  set  for
2685         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-
2686         set as the first matching string.         ject is reached and there is still at least  one  matching  possibility
2687           that requires additional characters. This happens even if some complete
2688           matches have also been found. When PCRE_PARTIAL_SOFT is set, the return
2689           code PCRE_ERROR_NOMATCH is converted into PCRE_ERROR_PARTIAL if the end
2690           of the subject is reached, there have been  no  complete  matches,  but
2691           there  is  still  at least one matching possibility. The portion of the
2692           string that was inspected when the longest partial match was  found  is
2693           set as the first matching string in both cases.
2694    
2695           PCRE_DFA_SHORTEST           PCRE_DFA_SHORTEST
2696    
2697         Setting the PCRE_DFA_SHORTEST option causes the matching  algorithm  to         Setting  the  PCRE_DFA_SHORTEST option causes the matching algorithm to
2698         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-
2699         tive algorithm works, this is necessarily the shortest  possible  match         tive  algorithm  works, this is necessarily the shortest possible match
2700         at the first possible matching point in the subject string.         at the first possible matching point in the subject string.
2701    
2702           PCRE_DFA_RESTART           PCRE_DFA_RESTART
2703    
2704         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
2705         returns a partial match, it is possible to call it  again,  with  addi-         again,  with  additional  subject characters, and have it continue with
2706         tional  subject  characters,  and have it continue with the same match.         the same match. The PCRE_DFA_RESTART option requests this action;  when
2707         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
2708         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
2709         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
2710         match.  There  is  more  discussion of this facility in the pcrepartial         pcrepartial documentation.
        documentation.  
2711    
2712     Successful returns from pcre_dfa_exec()     Successful returns from pcre_dfa_exec()
2713    
# Line 2394  MATCHING A PATTERN: THE ALTERNATIVE FUNC Line 2784  MATCHING A PATTERN: THE ALTERNATIVE FUNC
2784  SEE ALSO  SEE ALSO
2785    
2786         pcrebuild(3),  pcrecallout(3), pcrecpp(3)(3), pcrematching(3), pcrepar-         pcrebuild(3),  pcrecallout(3), pcrecpp(3)(3), pcrematching(3), pcrepar-
2787         tial(3), pcreposix(3), pcreprecompile(3), pcresample(3),  pcrestack(3).         tial(3), pcreposix(3), pcreprecompile(3), pcresample(3), pcrestack(3).
2788    
2789    
2790  AUTHOR  AUTHOR
# Line 2406  AUTHOR Line 2796  AUTHOR
2796    
2797  REVISION  REVISION
2798    
2799         Last updated: 04 June 2007         Last updated: 21 June 2010
2800         Copyright (c) 1997-2007 University of Cambridge.         Copyright (c) 1997-2010 University of Cambridge.
2801  ------------------------------------------------------------------------------  ------------------------------------------------------------------------------
2802    
2803    
# Line 2436  PCRE CALLOUTS Line 2826  PCRE CALLOUTS
2826    
2827           (?C1)abc(?C2)def           (?C1)abc(?C2)def
2828    
2829         If  the  PCRE_AUTO_CALLOUT  option  bit  is  set when pcre_compile() is         If  the  PCRE_AUTO_CALLOUT  option  bit  is  set when pcre_compile() or
2830         called, PCRE automatically  inserts  callouts,  all  with  number  255,         pcre_compile2() is called, PCRE  automatically  inserts  callouts,  all
2831         before  each  item in the pattern. For example, if PCRE_AUTO_CALLOUT is         with  number  255,  before  each  item  in the pattern. For example, if
2832         used with the pattern         PCRE_AUTO_CALLOUT is used with the pattern
2833    
2834           A(\d{2}|--)           A(\d{2}|--)
2835    
# Line 2458  PCRE CALLOUTS Line 2848  PCRE CALLOUTS
2848  MISSING CALLOUTS  MISSING CALLOUTS
2849    
2850         You  should  be  aware  that,  because of optimizations in the way PCRE         You  should  be  aware  that,  because of optimizations in the way PCRE
2851         matches patterns, callouts sometimes do not happen. For example, if the         matches patterns by default, callouts  sometimes  do  not  happen.  For
2852         pattern is         example, if the pattern is
2853    
2854           ab(?C4)cd           ab(?C4)cd
2855    
# Line 2468  MISSING CALLOUTS Line 2858  MISSING CALLOUTS
2858         ever  start,  and  the  callout is never reached. However, with "abyd",         ever  start,  and  the  callout is never reached. However, with "abyd",
2859         though the result is still no match, the callout is obeyed.         though the result is still no match, the callout is obeyed.
2860    
2861           If the pattern is studied, PCRE knows the minimum length of a  matching
2862           string,  and will immediately give a "no match" return without actually
2863           running a match if the subject is not long enough, or,  for  unanchored
2864           patterns, if it has been scanned far enough.
2865    
2866           You  can disable these optimizations by passing the PCRE_NO_START_OPTI-
2867           MIZE option to pcre_exec() or  pcre_dfa_exec().  This  slows  down  the
2868           matching  process,  but  does  ensure that callouts such as the example
2869           above are obeyed.
2870    
2871    
2872  THE CALLOUT INTERFACE  THE CALLOUT INTERFACE
2873    
# Line 2495  THE CALLOUT INTERFACE Line 2895  THE CALLOUT INTERFACE
2895         version number will change again in future  if  additional  fields  are         version number will change again in future  if  additional  fields  are
2896         added, but the intention is never to remove any of the existing fields.         added, but the intention is never to remove any of the existing fields.
2897    
2898         The callout_number field contains the number of the  callout,  as  com-         The  callout_number  field  contains the number of the callout, as com-
2899         piled  into  the pattern (that is, the number after ?C for manual call-         piled into the pattern (that is, the number after ?C for  manual  call-
2900         outs, and 255 for automatically generated callouts).         outs, and 255 for automatically generated callouts).
2901    
2902         The offset_vector field is a pointer to the vector of offsets that  was         The  offset_vector field is a pointer to the vector of offsets that was
2903         passed   by   the   caller  to  pcre_exec()  or  pcre_dfa_exec().  When         passed  by  the  caller  to  pcre_exec()   or   pcre_dfa_exec().   When
2904         pcre_exec() is used, the contents can be inspected in order to  extract         pcre_exec()  is used, the contents can be inspected in order to extract
2905         substrings  that  have  been  matched  so  far,  in the same way as for         substrings that have been matched so  far,  in  the  same  way  as  for
2906         extracting substrings after a match has completed. For  pcre_dfa_exec()         extracting  substrings after a match has completed. For pcre_dfa_exec()
2907         this field is not useful.         this field is not useful.
2908    
2909         The subject and subject_length fields contain copies of the values that         The subject and subject_length fields contain copies of the values that
2910         were passed to pcre_exec().         were passed to pcre_exec().
2911    
2912         The start_match field normally contains the offset within  the  subject         The  start_match  field normally contains the offset within the subject
2913         at  which  the  current  match  attempt started. However, if the escape         at which the current match attempt  started.  However,  if  the  escape
2914         sequence \K has been encountered, this value is changed to reflect  the         sequence  \K has been encountered, this value is changed to reflect the
2915         modified  starting  point.  If the pattern is not anchored, the callout         modified starting point. If the pattern is not  anchored,  the  callout
2916         function may be called several times from the same point in the pattern         function may be called several times from the same point in the pattern
2917         for different starting points in the subject.         for different starting points in the subject.
2918    
2919         The  current_position  field  contains the offset within the subject of         The current_position field contains the offset within  the  subject  of
2920         the current match pointer.         the current match pointer.
2921    
2922         When the pcre_exec() function is used, the capture_top  field  contains         When  the  pcre_exec() function is used, the capture_top field contains
2923         one  more than the number of the highest numbered captured substring so         one more than the number of the highest numbered captured substring  so
2924         far. If no substrings have been captured, the value of  capture_top  is         far.  If  no substrings have been captured, the value of capture_top is
2925         one.  This  is always the case when pcre_dfa_exec() is used, because it         one. This is always the case when pcre_dfa_exec() is used,  because  it
2926         does not support captured substrings.         does not support captured substrings.
2927    
2928         The capture_last field contains the number of the  most  recently  cap-         The  capture_last  field  contains the number of the most recently cap-
2929         tured  substring. If no substrings have been captured, its value is -1.         tured substring. If no substrings have been captured, its value is  -1.
2930         This is always the case when pcre_dfa_exec() is used.         This is always the case when pcre_dfa_exec() is used.
2931    
2932         The callout_data field contains a value that is passed  to  pcre_exec()         The  callout_data  field contains a value that is passed to pcre_exec()
2933         or  pcre_dfa_exec() specifically so that it can be passed back in call-         or pcre_dfa_exec() specifically so that it can be passed back in  call-
2934         outs. It is passed in the pcre_callout field  of  the  pcre_extra  data         outs.  It  is  passed  in the pcre_callout field of the pcre_extra data
2935         structure.  If  no such data was passed, the value of callout_data in a         structure. If no such data was passed, the value of callout_data  in  a
2936         pcre_callout block is NULL. There is a description  of  the  pcre_extra         pcre_callout  block  is  NULL. There is a description of the pcre_extra
2937         structure in the pcreapi documentation.         structure in the pcreapi documentation.
2938    
2939         The  pattern_position field is present from version 1 of the pcre_call-         The pattern_position field is present from version 1 of the  pcre_call-
2940         out structure. It contains the offset to the next item to be matched in         out structure. It contains the offset to the next item to be matched in
2941         the pattern string.         the pattern string.
2942    
2943         The  next_item_length field is present from version 1 of the pcre_call-         The next_item_length field is present from version 1 of the  pcre_call-
2944         out structure. It contains the length of the next item to be matched in         out structure. It contains the length of the next item to be matched in
2945         the  pattern  string. When the callout immediately precedes an alterna-         the pattern string. When the callout immediately precedes  an  alterna-
2946         tion bar, a closing parenthesis, or the end of the pattern, the  length         tion  bar, a closing parenthesis, or the end of the pattern, the length
2947         is  zero.  When the callout precedes an opening parenthesis, the length         is zero. When the callout precedes an opening parenthesis,  the  length
2948         is that of the entire subpattern.         is that of the entire subpattern.
2949    
2950         The pattern_position and next_item_length fields are intended  to  help         The  pattern_position  and next_item_length fields are intended to help
2951         in  distinguishing between different automatic callouts, which all have         in distinguishing between different automatic callouts, which all  have
2952         the same callout number. However, they are set for all callouts.         the same callout number. However, they are set for all callouts.
2953    
2954    
2955  RETURN VALUES  RETURN VALUES
2956    
2957         The external callout function returns an integer to PCRE. If the  value         The  external callout function returns an integer to PCRE. If the value
2958         is  zero,  matching  proceeds  as  normal. If the value is greater than         is zero, matching proceeds as normal. If  the  value  is  greater  than
2959         zero, matching fails at the current point, but  the  testing  of  other         zero,  matching  fails  at  the current point, but the testing of other
2960         matching possibilities goes ahead, just as if a lookahead assertion had         matching possibilities goes ahead, just as if a lookahead assertion had
2961         failed. If the value is less than zero, the  match  is  abandoned,  and         failed.  If  the  value  is less than zero, the match is abandoned, and
2962         pcre_exec() (or pcre_dfa_exec()) returns the negative value.         pcre_exec() or pcre_dfa_exec() returns the negative value.
2963    
2964         Negative   values   should   normally   be   chosen  from  the  set  of         Negative  values  should  normally  be   chosen   from   the   set   of
2965         PCRE_ERROR_xxx values. In particular, PCRE_ERROR_NOMATCH forces a stan-         PCRE_ERROR_xxx values. In particular, PCRE_ERROR_NOMATCH forces a stan-
2966         dard  "no  match"  failure.   The  error  number  PCRE_ERROR_CALLOUT is         dard "no  match"  failure.   The  error  number  PCRE_ERROR_CALLOUT  is
2967         reserved for use by callout functions; it will never be  used  by  PCRE         reserved  for  use  by callout functions; it will never be used by PCRE
2968         itself.         itself.
2969    
2970    
# Line 2577  AUTHOR Line 2977  AUTHOR
2977    
2978  REVISION  REVISION
2979    
2980         Last updated: 29 May 2007         Last updated: 29 September 2009
2981         Copyright (c) 1997-2007 University of Cambridge.         Copyright (c) 1997-2009 University of Cambridge.
2982  ------------------------------------------------------------------------------  ------------------------------------------------------------------------------
2983    
2984    
# Line 2592  NAME Line 2992  NAME
2992  DIFFERENCES BETWEEN PCRE AND PERL  DIFFERENCES BETWEEN PCRE AND PERL
2993    
2994         This  document describes the differences in the ways that PCRE and Perl         This  document describes the differences in the ways that PCRE and Perl
2995         handle regular expressions. The differences described here  are  mainly         handle regular expressions. The differences  described  here  are  with
2996         with  respect  to  Perl 5.8, though PCRE version 7.0 contains some fea-         respect to Perl 5.10/5.11.
        tures that are expected to be in the forthcoming Perl 5.10.  
2997    
2998         1. PCRE has only a subset of Perl's UTF-8 and Unicode support.  Details         1.  PCRE has only a subset of Perl's UTF-8 and Unicode support. Details
2999         of  what  it does have are given in the section on UTF-8 support in the         of what it does have are given in the section on UTF-8 support  in  the
3000         main pcre page.         main pcre page.
3001    
3002         2. PCRE does not allow repeat quantifiers on lookahead assertions. Perl         2. PCRE does not allow repeat quantifiers on lookahead assertions. Perl
3003         permits  them,  but they do not mean what you might think. For example,         permits them, but they do not mean what you might think.  For  example,
3004         (?!a){3} does not assert that the next three characters are not "a". It         (?!a){3} does not assert that the next three characters are not "a". It
3005         just asserts that the next character is not "a" three times.         just asserts that the next character is not "a" three times.
3006    
3007         3.  Capturing  subpatterns  that occur inside negative lookahead asser-         3. Capturing subpatterns that occur inside  negative  lookahead  asser-
3008         tions are counted, but their entries in the offsets  vector  are  never         tions  are  counted,  but their entries in the offsets vector are never
3009         set.  Perl sets its numerical variables from any such patterns that are         set. Perl sets its numerical variables from any such patterns that  are
3010         matched before the assertion fails to match something (thereby succeed-         matched before the assertion fails to match something (thereby succeed-
3011         ing),  but  only  if the negative lookahead assertion contains just one         ing), but only if the negative lookahead assertion  contains  just  one
3012         branch.         branch.
3013    
3014         4. Though binary zero characters are supported in the  subject  string,         4.  Though  binary zero characters are supported in the subject string,
3015         they are not allowed in a pattern string because it is passed as a nor-         they are not allowed in a pattern string because it is passed as a nor-
3016         mal C string, terminated by zero. The escape sequence \0 can be used in         mal C string, terminated by zero. The escape sequence \0 can be used in
3017         the pattern to represent a binary zero.         the pattern to represent a binary zero.
3018    
3019         5.  The  following Perl escape sequences are not supported: \l, \u, \L,         5. The following Perl escape sequences are not supported: \l,  \u,  \L,
3020         \U, and \N. In fact these are implemented by Perl's general string-han-         \U, and \N. In fact these are implemented by Perl's general string-han-
3021         dling  and are not part of its pattern matching engine. If any of these         dling and are not part of its pattern matching engine. If any of  these
3022         are encountered by PCRE, an error is generated.         are encountered by PCRE, an error is generated.
3023    
3024         6. The Perl escape sequences \p, \P, and \X are supported only if  PCRE         6.  The Perl escape sequences \p, \P, and \X are supported only if PCRE
3025         is  built  with Unicode character property support. The properties that         is built with Unicode character property support. The  properties  that
3026         can be tested with \p and \P are limited to the general category  prop-         can  be tested with \p and \P are limited to the general category prop-
3027         erties  such  as  Lu and Nd, script names such as Greek or Han, and the         erties such as Lu and Nd, script names such as Greek or  Han,  and  the
3028         derived properties Any and L&.         derived  properties  Any  and  L&. PCRE does support the Cs (surrogate)
3029           property, which Perl does not; the  Perl  documentation  says  "Because
3030           Perl hides the need for the user to understand the internal representa-
3031           tion of Unicode characters, there is no need to implement the  somewhat
3032           messy concept of surrogates."
3033    
3034         7. PCRE does support the \Q...\E escape for quoting substrings. Charac-         7. PCRE does support the \Q...\E escape for quoting substrings. Charac-
3035         ters  in  between  are  treated as literals. This is slightly different         ters in between are treated as literals.  This  is  slightly  different
3036         from Perl in that $ and @ are  also  handled  as  literals  inside  the         from  Perl  in  that  $  and  @ are also handled as literals inside the
3037         quotes.  In Perl, they cause variable interpolation (but of course PCRE         quotes. In Perl, they cause variable interpolation (but of course  PCRE
3038         does not have variables). Note the following examples:         does not have variables). Note the following examples:
3039    
3040             Pattern            PCRE matches      Perl matches             Pattern            PCRE matches      Perl matches
# Line 2641  DIFFERENCES BETWEEN PCRE AND PERL Line 3044  DIFFERENCES BETWEEN PCRE AND PERL
3044             \Qabc\$xyz\E       abc\$xyz          abc\$xyz             \Qabc\$xyz\E       abc\$xyz          abc\$xyz
3045             \Qabc\E\$\Qxyz\E   abc$xyz           abc$xyz             \Qabc\E\$\Qxyz\E   abc$xyz           abc$xyz
3046    
3047         The \Q...\E sequence is recognized both inside  and  outside  character         The  \Q...\E  sequence  is recognized both inside and outside character
3048         classes.         classes.
3049    
3050         8. Fairly obviously, PCRE does not support the (?{code}) and (??{code})         8. Fairly obviously, PCRE does not support the (?{code}) and (??{code})
3051         constructions. However, there is support for recursive  patterns.  This         constructions.  However,  there is support for recursive patterns. This
3052         is  not available in Perl 5.8, but will be in Perl 5.10. Also, the PCRE         is not available in Perl 5.8, but it is in Perl 5.10.  Also,  the  PCRE
3053         "callout" feature allows an external function to be called during  pat-         "callout"  feature allows an external function to be called during pat-
3054         tern matching. See the pcrecallout documentation for details.         tern matching. See the pcrecallout documentation for details.
3055    
3056         9.  Subpatterns  that  are  called  recursively or as "subroutines" are         9. Subpatterns that are called  recursively  or  as  "subroutines"  are
3057         always treated as atomic groups in  PCRE.  This  is  like  Python,  but         always  treated  as  atomic  groups  in  PCRE. This is like Python, but
3058         unlike Perl.         unlike Perl. There is a discussion of an example that explains this  in
3059           more  detail  in  the section on recursion differences from Perl in the
3060         10.  There are some differences that are concerned with the settings of         pcrepattern page.
3061         captured strings when part of  a  pattern  is  repeated.  For  example,  
3062         matching  "aba"  against  the  pattern  /^(a(b)?)+$/  in Perl leaves $2         10. There are some differences that are concerned with the settings  of
3063           captured  strings  when  part  of  a  pattern is repeated. For example,
3064           matching "aba" against the  pattern  /^(a(b)?)+$/  in  Perl  leaves  $2
3065         unset, but in PCRE it is set to "b".         unset, but in PCRE it is set to "b".
3066    
3067         11. PCRE provides some extensions to the Perl regular expression facil-         11.  PCRE's handling of duplicate subpattern numbers and duplicate sub-
3068         ities.   Perl  5.10  will  include new features that are not in earlier         pattern names is not as general as Perl's. This is a consequence of the
3069         versions, some of which (such as named parentheses) have been  in  PCRE         fact the PCRE works internally just with numbers, using an external ta-
3070         for some time. This list is with respect to Perl 5.10:         ble to translate between numbers and names. In  particular,  a  pattern
3071           such  as  (?|(?<a>A)|(?<b)B),  where the two capturing parentheses have
3072         (a)  Although  lookbehind  assertions  must match fixed length strings,         the same number but different names, is not supported,  and  causes  an
3073         each alternative branch of a lookbehind assertion can match a different         error  at compile time. If it were allowed, it would not be possible to
3074         length of string. Perl requires them all to have the same length.         distinguish which parentheses matched, because both names map  to  cap-
3075           turing subpattern number 1. To avoid this confusing situation, an error
3076           is given at compile time.
3077    
3078           12. PCRE provides some extensions to the Perl regular expression facil-
3079           ities.   Perl  5.10  includes new features that are not in earlier ver-
3080           sions of Perl, some of which (such as named parentheses) have  been  in
3081           PCRE for some time. This list is with respect to Perl 5.10:
3082    
3083           (a)  Although  lookbehind  assertions  in  PCRE must match fixed length
3084           strings, each alternative branch of a lookbehind assertion can match  a
3085           different  length  of  string.  Perl requires them all to have the same
3086           length.
3087    
3088         (b)  If PCRE_DOLLAR_ENDONLY is set and PCRE_MULTILINE is not set, the $         (b) If PCRE_DOLLAR_ENDONLY is set and PCRE_MULTILINE is not set, the  $
3089         meta-character matches only at the very end of the string.         meta-character matches only at the very end of the string.
3090    
3091         (c) If PCRE_EXTRA is set, a backslash followed by a letter with no spe-         (c) If PCRE_EXTRA is set, a backslash followed by a letter with no spe-
3092         cial  meaning  is  faulted.  Otherwise,  like  Perl,  the  backslash is         cial meaning is faulted. Otherwise, like Perl, the backslash is quietly
3093         ignored. (Perl can be made to issue a warning.)         ignored.  (Perl can be made to issue a warning.)
3094    
3095         (d) If PCRE_UNGREEDY is set, the greediness of the  repetition  quanti-         (d)  If  PCRE_UNGREEDY is set, the greediness of the repetition quanti-
3096         fiers is inverted, that is, by default they are not greedy, but if fol-         fiers is inverted, that is, by default they are not greedy, but if fol-
3097         lowed by a question mark they are.         lowed by a question mark they are.
3098    
3099         (e) PCRE_ANCHORED can be used at matching time to force a pattern to be         (e) PCRE_ANCHORED can be used at matching time to force a pattern to be
3100         tried only at the first matching position in the subject string.         tried only at the first matching position in the subject string.
3101    
3102         (f)  The PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, and PCRE_NO_AUTO_CAP-         (f) The PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NOTEMPTY_ATSTART,
3103         TURE options for pcre_exec() have no Perl equivalents.         and  PCRE_NO_AUTO_CAPTURE  options for pcre_exec() have no Perl equiva-
3104           lents.
3105    
3106         (g) The callout facility is PCRE-specific.         (g) The \R escape sequence can be restricted to match only CR,  LF,  or
3107           CRLF by the PCRE_BSR_ANYCRLF option.
3108    
3109         (h) The partial matching facility is PCRE-specific.         (h) The callout facility is PCRE-specific.
3110    
3111         (i) Patterns compiled by PCRE can be saved and re-used at a later time,         (i) The partial matching facility is PCRE-specific.
3112    
3113           (j) Patterns compiled by PCRE can be saved and re-used at a later time,
3114         even on different hosts that have the other endianness.         even on different hosts that have the other endianness.
3115    
3116         (j)  The  alternative  matching function (pcre_dfa_exec()) matches in a         (k) The alternative matching function (pcre_dfa_exec())  matches  in  a
3117         different way and is not Perl-compatible.         different way and is not Perl-compatible.
3118    
3119           (l)  PCRE  recognizes some special sequences such as (*CR) at the start
3120           of a pattern that set overall options that cannot be changed within the
3121           pattern.
3122    
3123    
3124  AUTHOR  AUTHOR
3125    
# Line 2705  AUTHOR Line 3130  AUTHOR
3130    
3131  REVISION  REVISION
3132    
3133         Last updated: 06 March 2007         Last updated: 12 May 2010
3134         Copyright (c) 1997-2007 University of Cambridge.         Copyright (c) 1997-2010 University of Cambridge.
3135  ------------------------------------------------------------------------------  ------------------------------------------------------------------------------
3136    
3137    
# Line 2719  NAME Line 3144  NAME
3144    
3145  PCRE REGULAR EXPRESSION DETAILS  PCRE REGULAR EXPRESSION DETAILS
3146    
3147         The  syntax  and semantics of the regular expressions supported by PCRE         The  syntax and semantics of the regular expressions that are supported
3148         are described below. Regular expressions are also described in the Perl         by PCRE are described in detail below. There is a quick-reference  syn-
3149         documentation  and  in  a  number  of books, some of which have copious         tax summary in the pcresyntax page. PCRE tries to match Perl syntax and
3150         examples.  Jeffrey Friedl's "Mastering Regular Expressions",  published         semantics as closely as it can. PCRE  also  supports  some  alternative
3151         by  O'Reilly, covers regular expressions in great detail. This descrip-         regular  expression  syntax (which does not conflict with the Perl syn-
3152         tion of PCRE's regular expressions is intended as reference material.         tax) in order to provide some compatibility with regular expressions in
3153           Python, .NET, and Oniguruma.
3154    
3155           Perl's  regular expressions are described in its own documentation, and
3156           regular expressions in general are covered in a number of  books,  some
3157           of  which  have  copious  examples. Jeffrey Friedl's "Mastering Regular
3158           Expressions", published by  O'Reilly,  covers  regular  expressions  in
3159           great  detail.  This  description  of  PCRE's  regular  expressions  is
3160           intended as reference material.
3161    
3162         The original operation of PCRE was on strings of  one-byte  characters.         The original operation of PCRE was on strings of  one-byte  characters.
3163         However,  there is now also support for UTF-8 character strings. To use         However,  there is now also support for UTF-8 character strings. To use
3164         this, you must build PCRE to  include  UTF-8  support,  and  then  call         this, PCRE must be built to include UTF-8 support, and  you  must  call
3165         pcre_compile()  with  the  PCRE_UTF8  option.  How this affects pattern         pcre_compile()  or  pcre_compile2() with the PCRE_UTF8 option. There is
3166         matching is mentioned in several places below. There is also a  summary         also a special sequence that can be given at the start of a pattern:
3167         of  UTF-8  features  in  the  section on UTF-8 support in the main pcre  
3168         page.           (*UTF8)
3169    
3170           Starting a pattern with this sequence  is  equivalent  to  setting  the
3171           PCRE_UTF8  option.  This  feature  is  not Perl-compatible. How setting
3172           UTF-8 mode affects pattern matching  is  mentioned  in  several  places
3173           below.  There  is  also  a  summary of UTF-8 features in the section on
3174           UTF-8 support in the main pcre page.
3175    
3176           Another special sequence that may appear at the start of a  pattern  or
3177           in combination with (*UTF8) is:
3178    
3179             (*UCP)
3180    
3181           This  has  the  same  effect  as setting the PCRE_UCP option: it causes
3182           sequences such as \d and \w to  use  Unicode  properties  to  determine
3183           character types, instead of recognizing only characters with codes less
3184           than 128 via a lookup table.
3185    
3186         The remainder of this document discusses the  patterns  that  are  sup-         The remainder of this document discusses the  patterns  that  are  sup-
3187         ported  by  PCRE when its main matching function, pcre_exec(), is used.         ported  by  PCRE when its main matching function, pcre_exec(), is used.
# Line 2744  PCRE REGULAR EXPRESSION DETAILS Line 3193  PCRE REGULAR EXPRESSION DETAILS
3193         discussed in the pcrematching page.         discussed in the pcrematching page.
3194    
3195    
3196    NEWLINE CONVENTIONS
3197    
3198           PCRE  supports five different conventions for indicating line breaks in
3199           strings: a single CR (carriage return) character, a  single  LF  (line-
3200           feed) character, the two-character sequence CRLF, any of the three pre-
3201           ceding, or any Unicode newline sequence. The pcreapi page  has  further
3202           discussion  about newlines, and shows how to set the newline convention
3203           in the options arguments for the compiling and matching functions.
3204    
3205           It is also possible to specify a newline convention by starting a  pat-
3206           tern string with one of the following five sequences:
3207    
3208             (*CR)        carriage return
3209             (*LF)        linefeed
3210             (*CRLF)      carriage return, followed by linefeed
3211             (*ANYCRLF)   any of the three above
3212             (*ANY)       all Unicode newline sequences
3213    
3214           These  override  the default and the options given to pcre_compile() or
3215           pcre_compile2(). For example, on a Unix system where LF is the  default
3216           newline sequence, the pattern
3217    
3218             (*CR)a.b
3219    
3220           changes the convention to CR. That pattern matches "a\nb" because LF is
3221           no longer a newline. Note that these special settings,  which  are  not
3222           Perl-compatible,  are  recognized  only at the very start of a pattern,
3223           and that they must be in upper case.  If  more  than  one  of  them  is
3224           present, the last one is used.
3225    
3226           The  newline convention affects the interpretation of the dot metachar-
3227           acter when PCRE_DOTALL is not set, and also the behaviour of  \N.  How-
3228           ever,  it  does  not  affect  what  the  \R escape sequence matches. By
3229           default, this is any Unicode newline sequence, for Perl  compatibility.
3230           However,  this can be changed; see the description of \R in the section
3231           entitled "Newline sequences" below. A change of \R setting can be  com-
3232           bined with a change of newline convention.
3233    
3234    
3235  CHARACTERS AND METACHARACTERS  CHARACTERS AND METACHARACTERS
3236    
3237         A  regular  expression  is  a pattern that is matched against a subject         A  regular  expression  is  a pattern that is matched against a subject
# Line 2799  CHARACTERS AND METACHARACTERS Line 3287  CHARACTERS AND METACHARACTERS
3287                    syntax)                    syntax)
3288           ]      terminates the character class           ]      terminates the character class
3289    
3290         The  following sections describe the use of each of the metacharacters.         The following sections describe the use of each of the metacharacters.
3291    
3292    
3293  BACKSLASH  BACKSLASH
3294    
3295         The backslash character has several uses. Firstly, if it is followed by         The backslash character has several uses. Firstly, if it is followed by
3296         a  non-alphanumeric  character,  it takes away any special meaning that         a non-alphanumeric character, it takes away any  special  meaning  that
3297         character may have. This  use  of  backslash  as  an  escape  character         character  may  have.  This  use  of  backslash  as an escape character
3298         applies both inside and outside character classes.         applies both inside and outside character classes.
3299    
3300         For  example,  if  you want to match a * character, you write \* in the         For example, if you want to match a * character, you write  \*  in  the
3301         pattern.  This escaping action applies whether  or  not  the  following         pattern.   This  escaping  action  applies whether or not the following
3302         character  would  otherwise be interpreted as a metacharacter, so it is         character would otherwise be interpreted as a metacharacter, so  it  is
3303         always safe to precede a non-alphanumeric  with  backslash  to  specify         always  safe  to  precede  a non-alphanumeric with backslash to specify
3304         that  it stands for itself. In particular, if you want to match a back-         that it stands for itself. In particular, if you want to match a  back-
3305         slash, you write \\.         slash, you write \\.
3306    
3307         If a pattern is compiled with the PCRE_EXTENDED option,  whitespace  in         If  a  pattern is compiled with the PCRE_EXTENDED option, whitespace in
3308         the  pattern (other than in a character class) and characters between a         the pattern (other than in a character class) and characters between  a
3309         # outside a character class and the next newline are ignored. An escap-         # outside a character class and the next newline are ignored. An escap-
3310         ing  backslash  can  be  used to include a whitespace or # character as         ing backslash can be used to include a whitespace  or  #  character  as
3311         part of the pattern.         part of the pattern.
3312    
3313         If you want to remove the special meaning from a  sequence  of  charac-         If  you  want  to remove the special meaning from a sequence of charac-
3314         ters,  you can do so by putting them between \Q and \E. This is differ-         ters, you can do so by putting them between \Q and \E. This is  differ-
3315         ent from Perl in that $ and  @  are  handled  as  literals  in  \Q...\E         ent  from  Perl  in  that  $  and  @ are handled as literals in \Q...\E
3316         sequences  in  PCRE, whereas in Perl, $ and @ cause variable interpola-         sequences in PCRE, whereas in Perl, $ and @ cause  variable  interpola-
3317         tion. Note the following examples:         tion. Note the following examples:
3318    
3319           Pattern            PCRE matches   Perl matches           Pattern            PCRE matches   Perl matches
# Line 2835  BACKSLASH Line 3323  BACKSLASH
3323           \Qabc\$xyz\E       abc\$xyz       abc\$xyz           \Qabc\$xyz\E       abc\$xyz       abc\$xyz
3324           \Qabc\E\$\Qxyz\E   abc$xyz        abc$xyz           \Qabc\E\$\Qxyz\E   abc$xyz        abc$xyz
3325    
3326         The \Q...\E sequence is recognized both inside  and  outside  character         The  \Q...\E  sequence  is recognized both inside and outside character
3327         classes.         classes.
3328    
3329     Non-printing characters     Non-printing characters
3330    
3331         A second use of backslash provides a way of encoding non-printing char-         A second use of backslash provides a way of encoding non-printing char-
3332         acters in patterns in a visible manner. There is no restriction on  the         acters  in patterns in a visible manner. There is no restriction on the
3333         appearance  of non-printing characters, apart from the binary zero that         appearance of non-printing characters, apart from the binary zero  that
3334         terminates a pattern, but when a pattern  is  being  prepared  by  text         terminates  a  pattern,  but  when  a pattern is being prepared by text
3335         editing,  it  is  usually  easier  to  use  one of the following escape         editing, it is  often  easier  to  use  one  of  the  following  escape
3336         sequences than the binary character it represents:         sequences than the binary character it represents:
3337    
3338           \a        alarm, that is, the BEL character (hex 07)           \a        alarm, that is, the BEL character (hex 07)
3339           \cx       "control-x", where x is any character           \cx       "control-x", where x is any character
3340           \e        escape (hex 1B)           \e        escape (hex 1B)
3341           \f        formfeed (hex 0C)           \f        formfeed (hex 0C)
3342           \n        newline (hex 0A)           \n        linefeed (hex 0A)
3343           \r        carriage return (hex 0D)           \r        carriage return (hex 0D)
3344           \t        tab (hex 09)           \t        tab (hex 09)
3345           \ddd      character with octal code ddd, or backreference           \ddd      character with octal code ddd, or back reference
3346           \xhh      character with hex code hh           \xhh      character with hex code hh
3347           \x{hhh..} character with hex code hhh..           \x{hhh..} character with hex code hhh..
3348    
3349         The precise effect of \cx is as follows: if x is a lower  case  letter,         The  precise  effect of \cx is as follows: if x is a lower case letter,
3350         it  is converted to upper case. Then bit 6 of the character (hex 40) is         it is converted to upper case. Then bit 6 of the character (hex 40)  is
3351         inverted.  Thus \cz becomes hex 1A, but \c{ becomes hex 3B,  while  \c;         inverted.   Thus  \cz becomes hex 1A, but \c{ becomes hex 3B, while \c;
3352         becomes hex 7B.         becomes hex 7B.
3353    
3354         After  \x, from zero to two hexadecimal digits are read (letters can be         After \x, from zero to two hexadecimal digits are read (letters can  be
3355         in upper or lower case). Any number of hexadecimal  digits  may  appear         in  upper  or  lower case). Any number of hexadecimal digits may appear
3356         between  \x{  and  },  but the value of the character code must be less         between \x{ and }, but the value of the character  code  must  be  less
3357         than 256 in non-UTF-8 mode, and less than 2**31 in UTF-8 mode (that is,         than 256 in non-UTF-8 mode, and less than 2**31 in UTF-8 mode. That is,
3358         the  maximum  hexadecimal  value is 7FFFFFFF). If characters other than         the maximum value in hexadecimal is 7FFFFFFF. Note that this is  bigger
3359         hexadecimal digits appear between \x{ and }, or if there is  no  termi-         than the largest Unicode code point, which is 10FFFF.
3360         nating  }, this form of escape is not recognized.  Instead, the initial  
3361         \x will be interpreted as a basic hexadecimal escape, with no following         If  characters  other than hexadecimal digits appear between \x{ and },
3362         digits, giving a character whose value is zero.         or if there is no terminating }, this form of escape is not recognized.
3363           Instead,  the  initial  \x  will  be interpreted as a basic hexadecimal
3364           escape, with no following digits, giving a  character  whose  value  is
3365           zero.
3366    
3367         Characters whose value is less than 256 can be defined by either of the         Characters whose value is less than 256 can be defined by either of the
3368         two syntaxes for \x. There is no difference in the way  they  are  han-         two syntaxes for \x. There is no difference in the way  they  are  han-
# Line 2920  BACKSLASH Line 3411  BACKSLASH
3411         All the sequences that define a single character value can be used both         All the sequences that define a single character value can be used both
3412         inside  and  outside character classes. In addition, inside a character         inside  and  outside character classes. In addition, inside a character
3413         class, the sequence \b is interpreted as the backspace  character  (hex         class, the sequence \b is interpreted as the backspace  character  (hex
3414         08),  and the sequences \R and \X are interpreted as the characters "R"         08).  The sequences \B, \N, \R, and \X are not special inside a charac-
3415         and "X", respectively. Outside a character class, these sequences  have         ter class. Like any  other  unrecognized  escape  sequences,  they  are
3416         different meanings (see below).         treated  as  the  literal characters "B", "N", "R", and "X" by default,
3417           but cause an error if the PCRE_EXTRA option is set. Outside a character
3418           class, these sequences have different meanings.
3419    
3420     Absolute and relative back references     Absolute and relative back references
3421    
3422         The  sequence  \g followed by a positive or negative number, optionally         The  sequence  \g followed by an unsigned or a negative number, option-
3423         enclosed in braces, is an absolute or relative back reference. A  named         ally enclosed in braces, is an absolute or relative back  reference.  A
3424         back  reference can be coded as \g{name}. Back references are discussed         named back reference can be coded as \g{name}. Back references are dis-
3425         later, following the discussion of parenthesized subpatterns.         cussed later, following the discussion of parenthesized subpatterns.
3426    
3427       Absolute and relative subroutine calls
3428    
3429           For compatibility with Oniguruma, the non-Perl syntax \g followed by  a
3430           name or a number enclosed either in angle brackets or single quotes, is
3431           an alternative syntax for referencing a subpattern as  a  "subroutine".
3432           Details  are  discussed  later.   Note  that  \g{...} (Perl syntax) and
3433           \g<...> (Oniguruma syntax) are not synonymous. The  former  is  a  back
3434           reference; the latter is a subroutine call.
3435    
3436     Generic character types     Generic character types
3437    
3438         Another use of backslash is for specifying generic character types. The         Another use of backslash is for specifying generic character types:
        following are always recognized:  
3439    
3440           \d     any decimal digit           \d     any decimal digit
3441           \D     any character that is not a decimal digit           \D     any character that is not a decimal digit
3442             \h     any horizontal whitespace character
3443             \H     any character that is not a horizontal whitespace character
3444           \s     any whitespace character           \s     any whitespace character
3445           \S     any character that is not a whitespace character           \S     any character that is not a whitespace character
3446             \v     any vertical whitespace character
3447             \V     any character that is not a vertical whitespace character
3448           \w     any "word" character           \w     any "word" character
3449           \W     any "non-word" character           \W     any "non-word" character
3450    
3451         Each pair of escape sequences partitions the complete set of characters         There is also the single sequence \N, which matches a non-newline char-
3452         into two disjoint sets. Any given character matches one, and only  one,         acter.  This is the same as the "." metacharacter when  PCRE_DOTALL  is
3453         of each pair.         not set.
3454    
3455         These character type sequences can appear both inside and outside char-         Each  pair of lower and upper case escape sequences partitions the com-
3456         acter classes. They each match one character of the  appropriate  type.         plete set of characters into two disjoint  sets.  Any  given  character
3457         If  the current matching point is at the end of the subject string, all         matches  one, and only one, of each pair. The sequences can appear both
3458         of them fail, since there is no character to match.         inside and outside character classes. They each match one character  of
3459           the  appropriate  type.  If the current matching point is at the end of
3460         For compatibility with Perl, \s does not match the VT  character  (code         the subject string, all of them fail, because there is no character  to
3461         11).   This makes it different from the the POSIX "space" class. The \s         match.
3462         characters are HT (9), LF (10), FF (12), CR (13), and space  (32).  (If  
3463           For  compatibility  with Perl, \s does not match the VT character (code
3464           11).  This makes it different from the the POSIX "space" class. The  \s
3465           characters  are  HT  (9), LF (10), FF (12), CR (13), and space (32). If
3466         "use locale;" is included in a Perl script, \s may match the VT charac-         "use locale;" is included in a Perl script, \s may match the VT charac-
3467         ter. In PCRE, it never does.)         ter. In PCRE, it never does.
3468    
3469         A "word" character is an underscore or any character less than 256 that         A  "word"  character is an underscore or any character that is a letter
3470         is  a  letter  or  digit.  The definition of letters and digits is con-         or digit.  By default, the definition of letters  and  digits  is  con-
3471         trolled by PCRE's low-valued character tables, and may vary if  locale-         trolled  by PCRE's low-valued character tables, and may vary if locale-
3472         specific  matching is taking place (see "Locale support" in the pcreapi         specific matching is taking place (see "Locale support" in the  pcreapi
3473         page). For example, in a French locale such  as  "fr_FR"  in  Unix-like         page).  For  example,  in  a French locale such as "fr_FR" in Unix-like
3474         systems,  or "french" in Windows, some character codes greater than 128         systems, or "french" in Windows, some character codes greater than  128
3475         are used for accented letters, and these are matched by \w.         are  used  for  accented letters, and these are then matched by \w. The
3476           use of locales with Unicode is discouraged.
3477         In UTF-8 mode, characters with values greater than 128 never match  \d,  
3478         \s, or \w, and always match \D, \S, and \W. This is true even when Uni-         By default, in UTF-8 mode, characters  with  values  greater  than  128
3479         code character property support is available. The use of  locales  with         never  match  \d,  \s,  or  \w,  and always match \D, \S, and \W. These
3480         Unicode is discouraged.         sequences retain their original meanings from before UTF-8 support  was
3481           available,  mainly for efficiency reasons. However, if PCRE is compiled
3482           with Unicode property support, and the PCRE_UCP option is set, the  be-
3483           haviour  is  changed  so  that Unicode properties are used to determine
3484           character types, as follows:
3485    
3486             \d  any character that \p{Nd} matches (decimal digit)
3487             \s  any character that \p{Z} matches, plus HT, LF, FF, CR
3488             \w  any character that \p{L} or \p{N} matches, plus underscore
3489    
3490           The upper case escapes match the inverse sets of characters. Note  that
3491           \d  matches  only decimal digits, whereas \w matches any Unicode digit,
3492           as well as any Unicode letter, and underscore. Note also that  PCRE_UCP
3493           affects  \b,  and  \B  because  they are defined in terms of \w and \W.
3494           Matching these sequences is noticeably slower when PCRE_UCP is set.
3495    
3496           The sequences \h, \H, \v, and \V are Perl 5.10 features. In contrast to
3497           the  other  sequences,  which  match  only ASCII characters by default,
3498           these always  match  certain  high-valued  codepoints  in  UTF-8  mode,
3499           whether or not PCRE_UCP is set. The horizontal space characters are:
3500    
3501             U+0009     Horizontal tab
3502             U+0020     Space
3503             U+00A0     Non-break space
3504             U+1680     Ogham space mark
3505             U+180E     Mongolian vowel separator
3506             U+2000     En quad
3507             U+2001     Em quad
3508             U+2002     En space
3509             U+2003     Em space
3510             U+2004     Three-per-em space
3511             U+2005     Four-per-em space
3512             U+2006     Six-per-em space
3513             U+2007     Figure space
3514             U+2008     Punctuation space
3515             U+2009     Thin space
3516             U+200A     Hair space
3517             U+202F     Narrow no-break space
3518             U+205F     Medium mathematical space
3519             U+3000     Ideographic space
3520    
3521           The vertical space characters are:
3522    
3523             U+000A     Linefeed
3524             U+000B     Vertical tab
3525             U+000C     Formfeed
3526             U+000D     Carriage return
3527             U+0085     Next line
3528             U+2028     Line separator
3529             U+2029     Paragraph separator
3530    
3531     Newline sequences     Newline sequences
3532    
3533         Outside  a  character class, the escape sequence \R matches any Unicode         Outside  a  character class, by default, the escape sequence \R matches
3534         newline sequence. This is an extension to Perl. In non-UTF-8 mode \R is         any Unicode newline sequence. This is a Perl 5.10 feature. In non-UTF-8
3535         equivalent to the following:         mode \R is equivalent to the following:
3536    
3537           (?>\r\n|\n|\x0b|\f|\r|\x85)           (?>\r\n|\n|\x0b|\f|\r|\x85)
3538    
# Line 2991  BACKSLASH Line 3548  BACKSLASH
3548         rator, U+2029).  Unicode character property support is not  needed  for         rator, U+2029).  Unicode character property support is not  needed  for
3549         these characters to be recognized.         these characters to be recognized.
3550    
3551         Inside a character class, \R matches the letter "R".         It is possible to restrict \R to match only CR, LF, or CRLF (instead of
3552           the complete set  of  Unicode  line  endings)  by  setting  the  option
3553           PCRE_BSR_ANYCRLF either at compile time or when the pattern is matched.
3554           (BSR is an abbrevation for "backslash R".) This can be made the default
3555           when  PCRE  is  built;  if this is the case, the other behaviour can be
3556           requested via the PCRE_BSR_UNICODE option.   It  is  also  possible  to
3557           specify  these  settings  by  starting a pattern string with one of the
3558           following sequences:
3559    
3560             (*BSR_ANYCRLF)   CR, LF, or CRLF only
3561             (*BSR_UNICODE)   any Unicode newline sequence
3562    
3563           These override the default and the options given to  pcre_compile()  or
3564           pcre_compile2(),  but  they  can  be  overridden  by  options  given to
3565           pcre_exec() or pcre_dfa_exec(). Note that these special settings, which
3566           are  not  Perl-compatible,  are  recognized only at the very start of a
3567           pattern, and that they must be in upper case. If more than one of  them
3568           is present, the last one is used. They can be combined with a change of
3569           newline convention; for example, a pattern can start with:
3570    
3571             (*ANY)(*BSR_ANYCRLF)
3572    
3573           They can also be combined with the (*UTF8) or (*UCP) special sequences.
3574           Inside  a  character  class,  \R  is  treated as an unrecognized escape
3575           sequence, and so matches the letter "R" by default, but causes an error
3576           if PCRE_EXTRA is set.
3577    
3578     Unicode character properties     Unicode character properties
3579    
3580         When PCRE is built with Unicode character property support, three addi-         When PCRE is built with Unicode character property support, three addi-
3581         tional escape sequences to match  character  properties  are  available         tional escape sequences that match characters with specific  properties
3582         when UTF-8 mode is selected. They are:         are  available.   When not in UTF-8 mode, these sequences are of course
3583           limited to testing characters whose codepoints are less than  256,  but
3584           they do work in this mode.  The extra escape sequences are:
3585    
3586           \p{xx}   a character with the xx property           \p{xx}   a character with the xx property
3587           \P{xx}   a character without the xx property           \P{xx}   a character without the xx property
3588           \X       an extended Unicode sequence           \X       an extended Unicode sequence
3589    
3590         The  property  names represented by xx above are limited to the Unicode         The  property  names represented by xx above are limited to the Unicode
3591         script names, the general category properties, and "Any", which matches         script names, the general category properties, "Any", which matches any
3592         any character (including newline). Other properties such as "InMusical-         character   (including  newline),  and  some  special  PCRE  properties
3593         Symbols" are not currently supported by PCRE. Note  that  \P{Any}  does         (described in the next section).  Other Perl properties such as  "InMu-
3594         not match any characters, so always causes a match failure.         sicalSymbols"  are  not  currently supported by PCRE. Note that \P{Any}
3595           does not match any characters, so always causes a match failure.
3596    
3597         Sets of Unicode characters are defined as belonging to certain scripts.         Sets of Unicode characters are defined as belonging to certain scripts.
3598         A character from one of these sets can be matched using a script  name.         A  character from one of these sets can be matched using a script name.
3599         For example:         For example:
3600    
3601           \p{Greek}           \p{Greek}
3602           \P{Han}           \P{Han}
3603    
3604         Those  that are not part of an identified script are lumped together as         Those that are not part of an identified script are lumped together  as
3605         "Common". The current list of scripts is:         "Common". The current list of scripts is:
3606    
3607         Arabic,  Armenian,  Balinese,  Bengali,  Bopomofo,  Braille,  Buginese,         Arabic, Armenian, Avestan, Balinese, Bamum, Bengali, Bopomofo, Braille,
3608         Buhid,   Canadian_Aboriginal,   Cherokee,  Common,  Coptic,  Cuneiform,         Buginese, Buhid, Canadian_Aboriginal, Carian, Cham,  Cherokee,  Common,
3609         Cypriot, Cyrillic, Deseret, Devanagari, Ethiopic, Georgian, Glagolitic,         Coptic,   Cuneiform,  Cypriot,  Cyrillic,  Deseret,  Devanagari,  Egyp-
3610         Gothic,  Greek, Gujarati, Gurmukhi, Han, Hangul, Hanunoo, Hebrew, Hira-         tian_Hieroglyphs,  Ethiopic,  Georgian,  Glagolitic,   Gothic,   Greek,
3611         gana, Inherited, Kannada,  Katakana,  Kharoshthi,  Khmer,  Lao,  Latin,         Gujarati,  Gurmukhi,  Han,  Hangul,  Hanunoo,  Hebrew,  Hiragana, Impe-
3612         Limbu,  Linear_B,  Malayalam,  Mongolian,  Myanmar,  New_Tai_Lue,  Nko,         rial_Aramaic, Inherited, Inscriptional_Pahlavi, Inscriptional_Parthian,
3613         Ogham, Old_Italic, Old_Persian, Oriya, Osmanya,  Phags_Pa,  Phoenician,         Javanese,  Kaithi, Kannada, Katakana, Kayah_Li, Kharoshthi, Khmer, Lao,
3614         Runic,  Shavian,  Sinhala,  Syloti_Nagri,  Syriac,  Tagalog,  Tagbanwa,         Latin,  Lepcha,  Limbu,  Linear_B,  Lisu,  Lycian,  Lydian,  Malayalam,
3615         Tai_Le, Tamil, Telugu, Thaana, Thai, Tibetan, Tifinagh, Ugaritic, Yi.         Meetei_Mayek,  Mongolian, Myanmar, New_Tai_Lue, Nko, Ogham, Old_Italic,
3616           Old_Persian, Old_South_Arabian, Old_Turkic, Ol_Chiki,  Oriya,  Osmanya,
3617         Each character has exactly one general category property, specified  by         Phags_Pa,  Phoenician,  Rejang,  Runic, Samaritan, Saurashtra, Shavian,
3618         a two-letter abbreviation. For compatibility with Perl, negation can be         Sinhala, Sundanese, Syloti_Nagri, Syriac,  Tagalog,  Tagbanwa,  Tai_Le,
3619         specified by including a circumflex between the opening brace  and  the         Tai_Tham,  Tai_Viet,  Tamil,  Telugu,  Thaana, Thai, Tibetan, Tifinagh,
3620         property name. For example, \p{^Lu} is the same as \P{Lu}.         Ugaritic, Vai, Yi.
3621    
3622           Each character has exactly one Unicode general category property, spec-
3623           ified  by a two-letter abbreviation. For compatibility with Perl, nega-
3624           tion can be specified by including a  circumflex  between  the  opening
3625           brace  and  the  property  name.  For  example,  \p{^Lu} is the same as
3626           \P{Lu}.
3627    
3628         If only one letter is specified with \p or \P, it includes all the gen-         If only one letter is specified with \p or \P, it includes all the gen-
3629         eral category properties that start with that letter. In this case,  in         eral  category properties that start with that letter. In this case, in
3630         the  absence of negation, the curly brackets in the escape sequence are         the absence of negation, the curly brackets in the escape sequence  are
3631         optional; these two examples have the same effect:         optional; these two examples have the same effect:
3632    
3633           \p{L}           \p{L}
# Line 3088  BACKSLASH Line 3679  BACKSLASH
3679           Zp    Paragraph separator           Zp    Paragraph separator
3680           Zs    Space separator           Zs    Space separator
3681    
3682         The special property L& is also supported: it matches a character  that         The  special property L& is also supported: it matches a character that
3683         has  the  Lu,  Ll, or Lt property, in other words, a letter that is not         has the Lu, Ll, or Lt property, in other words, a letter  that  is  not
3684         classified as a modifier or "other".         classified as a modifier or "other".
3685    
3686         The long synonyms for these properties  that  Perl  supports  (such  as         The  Cs  (Surrogate)  property  applies only to characters in the range
3687         \p{Letter})  are  not  supported by PCRE, nor is it permitted to prefix         U+D800 to U+DFFF. Such characters are not valid in UTF-8  strings  (see
3688           RFC 3629) and so cannot be tested by PCRE, unless UTF-8 validity check-
3689           ing has been turned off (see the discussion  of  PCRE_NO_UTF8_CHECK  in
3690           the pcreapi page). Perl does not support the Cs property.
3691    
3692           The  long  synonyms  for  property  names  that  Perl supports (such as
3693           \p{Letter}) are not supported by PCRE, nor is it  permitted  to  prefix
3694         any of these properties with "Is".         any of these properties with "Is".
3695    
3696         No character that is in the Unicode table has the Cn (unassigned) prop-         No character that is in the Unicode table has the Cn (unassigned) prop-
3697         erty.  Instead, this property is assumed for any code point that is not         erty.  Instead, this property is assumed for any code point that is not
3698         in the Unicode table.         in the Unicode table.
3699    
3700         Specifying caseless matching does not affect  these  escape  sequences.         Specifying  caseless  matching  does not affect these escape sequences.
3701         For example, \p{Lu} always matches only upper case letters.         For example, \p{Lu} always matches only upper case letters.
3702    
3703         The  \X  escape  matches  any number of Unicode characters that form an         The \X escape matches any number of Unicode  characters  that  form  an
3704         extended Unicode sequence. \X is equivalent to         extended Unicode sequence. \X is equivalent to
3705    
3706           (?>\PM\pM*)           (?>\PM\pM*)
3707    
3708         That is, it matches a character without the "mark"  property,  followed         That  is,  it matches a character without the "mark" property, followed
3709         by  zero  or  more  characters with the "mark" property, and treats the         by zero or more characters with the "mark"  property,  and  treats  the
3710         sequence as an atomic group (see below).  Characters  with  the  "mark"         sequence  as  an  atomic group (see below).  Characters with the "mark"
3711         property are typically accents that affect the preceding character.         property are typically accents that  affect  the  preceding  character.
3712           None  of  them  have  codepoints less than 256, so in non-UTF-8 mode \X
3713           matches any one character.
3714    
3715         Matching  characters  by Unicode property is not fast, because PCRE has         Matching characters by Unicode property is not fast, because  PCRE  has
3716         to search a structure that contains  data  for  over  fifteen  thousand         to  search  a  structure  that  contains data for over fifteen thousand
3717         characters. That is why the traditional escape sequences such as \d and         characters. That is why the traditional escape sequences such as \d and
3718         \w do not use Unicode properties in PCRE.         \w  do  not  use  Unicode properties in PCRE by default, though you can
3719           make them do so by setting the PCRE_UCP option for pcre_compile() or by
3720           starting the pattern with (*UCP).
3721    
3722       PCRE's additional properties
3723    
3724           As  well  as  the standard Unicode properties described in the previous
3725           section, PCRE supports four more that make it possible to convert  tra-
3726           ditional escape sequences such as \w and \s and POSIX character classes
3727           to use Unicode properties. PCRE uses these non-standard, non-Perl prop-
3728           erties internally when PCRE_UCP is set. They are:
3729    
3730             Xan   Any alphanumeric character
3731             Xps   Any POSIX space character
3732             Xsp   Any Perl space character
3733             Xwd   Any Perl "word" character
3734    
3735           Xan  matches  characters that have either the L (letter) or the N (num-
3736           ber) property. Xps matches the characters tab, linefeed, vertical  tab,
3737           formfeed,  or  carriage  return, and any other character that has the Z
3738           (separator) property.  Xsp is the same as Xps, except that vertical tab
3739           is excluded. Xwd matches the same characters as Xan, plus underscore.
3740    
3741     Resetting the match start     Resetting the match start
3742    
3743         The escape sequence \K, which is a Perl 5.10 feature, causes any previ-         The escape sequence \K, which is a Perl 5.10 feature, causes any previ-
3744         ously  matched  characters  not  to  be  included  in the final matched         ously matched characters not  to  be  included  in  the  final  matched
3745         sequence. For example, the pattern:         sequence. For example, the pattern:
3746    
3747           foo\Kbar           foo\Kbar
3748    
3749         matches "foobar", but reports that it has matched "bar".  This  feature         matches  "foobar",  but reports that it has matched "bar". This feature
3750         is  similar  to  a lookbehind assertion (described below).  However, in         is similar to a lookbehind assertion (described  below).   However,  in
3751         this case, the part of the subject before the real match does not  have         this  case, the part of the subject before the real match does not have
3752         to  be of fixed length, as lookbehind assertions do. The use of \K does         to be of fixed length, as lookbehind assertions do. The use of \K  does
3753         not interfere with the setting of captured  substrings.   For  example,         not  interfere  with  the setting of captured substrings.  For example,
3754         when the pattern         when the pattern
3755    
3756           (foo)\Kbar           (foo)\Kbar
3757    
3758         matches "foobar", the first substring is still set to "foo".         matches "foobar", the first substring is still set to "foo".
3759    
3760           Perl documents that the use  of  \K  within  assertions  is  "not  well
3761           defined".  In  PCRE,  \K  is  acted upon when it occurs inside positive
3762           assertions, but is ignored in negative assertions.
3763    
3764     Simple assertions     Simple assertions
3765    
3766         The  final use of backslash is for certain simple assertions. An asser-         The final use of backslash is for certain simple assertions. An  asser-
3767         tion specifies a condition that has to be met at a particular point  in         tion  specifies a condition that has to be met at a particular point in
3768         a  match, without consuming any characters from the subject string. The         a match, without consuming any characters from the subject string.  The
3769         use of subpatterns for more complicated assertions is described  below.         use  of subpatterns for more complicated assertions is described below.
3770         The backslashed assertions are:         The backslashed assertions are:
3771    
3772           \b     matches at a word boundary           \b     matches at a word boundary
# Line 3153  BACKSLASH Line 3777  BACKSLASH
3777           \z     matches only at the end of the subject           \z     matches only at the end of the subject
3778           \G     matches at the first matching position in the subject           \G     matches at the first matching position in the subject
3779    
3780         These  assertions may not appear in character classes (but note that \b         Inside a character class, \b has a different meaning;  it  matches  the
3781         has a different meaning, namely the backspace character, inside a char-         backspace  character.  If  any  other  of these assertions appears in a
3782         acter class).         character class, by default it matches the corresponding literal  char-
3783           acter  (for  example,  \B  matches  the  letter  B).  However,  if  the
3784           PCRE_EXTRA option is set, an "invalid escape sequence" error is  gener-
3785           ated instead.
3786    
3787         A  word  boundary is a position in the subject string where the current         A  word  boundary is a position in the subject string where the current
3788         character and the previous character do not both match \w or  \W  (i.e.         character and the previous character do not both match \w or  \W  (i.e.
3789         one  matches  \w  and the other matches \W), or the start or end of the         one  matches  \w  and the other matches \W), or the start or end of the
3790         string if the first or last character matches \w, respectively.         string if the first or last  character  matches  \w,  respectively.  In
3791           UTF-8  mode,  the  meanings  of \w and \W can be changed by setting the
3792           PCRE_UCP option. When this is done, it also affects \b and \B.  Neither
3793           PCRE  nor  Perl has a separate "start of word" or "end of word" metase-
3794           quence. However, whatever follows \b normally determines which  it  is.
3795           For example, the fragment \ba matches "a" at the start of a word.
3796    
3797         The \A, \Z, and \z assertions differ from  the  traditional  circumflex         The  \A,  \Z,  and \z assertions differ from the traditional circumflex
3798         and dollar (described in the next section) in that they only ever match         and dollar (described in the next section) in that they only ever match
3799         at the very start and end of the subject string, whatever  options  are         at  the  very start and end of the subject string, whatever options are
3800         set.  Thus,  they are independent of multiline mode. These three asser-         set. Thus, they are independent of multiline mode. These  three  asser-
3801         tions are not affected by the PCRE_NOTBOL or PCRE_NOTEOL options, which         tions are not affected by the PCRE_NOTBOL or PCRE_NOTEOL options, which
3802         affect  only the behaviour of the circumflex and dollar metacharacters.         affect only the behaviour of the circumflex and dollar  metacharacters.
3803         However, if the startoffset argument of pcre_exec() is non-zero,  indi-         However,  if the startoffset argument of pcre_exec() is non-zero, indi-
3804         cating that matching is to start at a point other than the beginning of         cating that matching is to start at a point other than the beginning of
3805         the subject, \A can never match. The difference between \Z  and  \z  is         the  subject,  \A  can never match. The difference between \Z and \z is
3806         that \Z matches before a newline at the end of the string as well as at         that \Z matches before a newline at the end of the string as well as at
3807         the very end, whereas \z matches only at the end.         the very end, whereas \z matches only at the end.
3808    
3809         The \G assertion is true only when the current matching position is  at         The  \G assertion is true only when the current matching position is at
3810         the  start point of the match, as specified by the startoffset argument         the start point of the match, as specified by the startoffset  argument
3811         of pcre_exec(). It differs from \A when the  value  of  startoffset  is         of  pcre_exec().  It  differs  from \A when the value of startoffset is
3812         non-zero.  By calling pcre_exec() multiple times with appropriate argu-         non-zero. By calling pcre_exec() multiple times with appropriate  argu-
3813         ments, you can mimic Perl's /g option, and it is in this kind of imple-         ments, you can mimic Perl's /g option, and it is in this kind of imple-
3814         mentation where \G can be useful.         mentation where \G can be useful.
3815    
3816         Note,  however,  that  PCRE's interpretation of \G, as the start of the         Note, however, that PCRE's interpretation of \G, as the  start  of  the
3817         current match, is subtly different from Perl's, which defines it as the         current match, is subtly different from Perl's, which defines it as the
3818         end  of  the  previous  match. In Perl, these can be different when the         end of the previous match. In Perl, these can  be  different  when  the
3819         previously matched string was empty. Because PCRE does just  one  match         previously  matched  string was empty. Because PCRE does just one match
3820         at a time, it cannot reproduce this behaviour.         at a time, it cannot reproduce this behaviour.
3821    
3822         If  all  the alternatives of a pattern begin with \G, the expression is         If all the alternatives of a pattern begin with \G, the  expression  is
3823         anchored to the starting match position, and the "anchored" flag is set         anchored to the starting match position, and the "anchored" flag is set
3824         in the compiled regular expression.         in the compiled regular expression.
3825    
# Line 3195  BACKSLASH Line 3827  BACKSLASH
3827  CIRCUMFLEX AND DOLLAR  CIRCUMFLEX AND DOLLAR
3828    
3829         Outside a character class, in the default matching mode, the circumflex         Outside a character class, in the default matching mode, the circumflex
3830         character is an assertion that is true only  if  the  current  matching         character  is  an  assertion  that is true only if the current matching
3831         point  is  at the start of the subject string. If the startoffset argu-         point is at the start of the subject string. If the  startoffset  argu-
3832         ment of pcre_exec() is non-zero, circumflex  can  never  match  if  the         ment  of  pcre_exec()  is  non-zero,  circumflex can never match if the
3833         PCRE_MULTILINE  option  is  unset. Inside a character class, circumflex         PCRE_MULTILINE option is unset. Inside a  character  class,  circumflex
3834         has an entirely different meaning (see below).         has an entirely different meaning (see below).
3835    
3836         Circumflex need not be the first character of the pattern if  a  number         Circumflex  need  not be the first character of the pattern if a number
3837         of  alternatives are involved, but it should be the first thing in each         of alternatives are involved, but it should be the first thing in  each
3838         alternative in which it appears if the pattern is ever  to  match  that         alternative  in  which  it appears if the pattern is ever to match that
3839         branch.  If all possible alternatives start with a circumflex, that is,         branch. If all possible alternatives start with a circumflex, that  is,
3840         if the pattern is constrained to match only at the start  of  the  sub-         if  the  pattern  is constrained to match only at the start of the sub-
3841         ject,  it  is  said  to be an "anchored" pattern. (There are also other         ject, it is said to be an "anchored" pattern.  (There  are  also  other
3842         constructs that can cause a pattern to be anchored.)         constructs that can cause a pattern to be anchored.)
3843    
3844         A dollar character is an assertion that is true  only  if  the  current         A  dollar  character  is  an assertion that is true only if the current
3845         matching  point  is  at  the  end of the subject string, or immediately         matching point is at the end of  the  subject  string,  or  immediately
3846         before a newline at the end of the string (by default). Dollar need not         before a newline at the end of the string (by default). Dollar need not
3847         be  the  last  character of the pattern if a number of alternatives are         be the last character of the pattern if a number  of  alternatives  are
3848         involved, but it should be the last item in  any  branch  in  which  it         involved,  but  it  should  be  the last item in any branch in which it
3849         appears. Dollar has no special meaning in a character class.         appears. Dollar has no special meaning in a character class.
3850    
3851         The  meaning  of  dollar  can be changed so that it matches only at the         The meaning of dollar can be changed so that it  matches  only  at  the
3852         very end of the string, by setting the  PCRE_DOLLAR_ENDONLY  option  at         very  end  of  the string, by setting the PCRE_DOLLAR_ENDONLY option at
3853         compile time. This does not affect the \Z assertion.         compile time. This does not affect the \Z assertion.
3854    
3855         The meanings of the circumflex and dollar characters are changed if the         The meanings of the circumflex and dollar characters are changed if the
3856         PCRE_MULTILINE option is set. When  this  is  the  case,  a  circumflex         PCRE_MULTILINE  option  is  set.  When  this  is the case, a circumflex
3857         matches  immediately after internal newlines as well as at the start of         matches immediately after internal newlines as well as at the start  of
3858         the subject string. It does not match after a  newline  that  ends  the         the  subject  string.  It  does not match after a newline that ends the
3859         string.  A dollar matches before any newlines in the string, as well as         string. A dollar matches before any newlines in the string, as well  as
3860         at the very end, when PCRE_MULTILINE is set. When newline is  specified         at  the very end, when PCRE_MULTILINE is set. When newline is specified
3861         as  the  two-character  sequence CRLF, isolated CR and LF characters do         as the two-character sequence CRLF, isolated CR and  LF  characters  do
3862         not indicate newlines.         not indicate newlines.
3863    
3864         For example, the pattern /^abc$/ matches the subject string  "def\nabc"         For  example, the pattern /^abc$/ matches the subject string "def\nabc"
3865         (where  \n  represents a newline) in multiline mode, but not otherwise.         (where \n represents a newline) in multiline mode, but  not  otherwise.
3866         Consequently, patterns that are anchored in single  line  mode  because         Consequently,  patterns  that  are anchored in single line mode because
3867         all  branches  start  with  ^ are not anchored in multiline mode, and a         all branches start with ^ are not anchored in  multiline  mode,  and  a
3868         match for circumflex is  possible  when  the  startoffset  argument  of         match  for  circumflex  is  possible  when  the startoffset argument of
3869         pcre_exec()  is  non-zero. The PCRE_DOLLAR_ENDONLY option is ignored if         pcre_exec() is non-zero. The PCRE_DOLLAR_ENDONLY option is  ignored  if
3870         PCRE_MULTILINE is set.         PCRE_MULTILINE is set.
3871    
3872         Note that the sequences \A, \Z, and \z can be used to match  the  start         Note  that  the sequences \A, \Z, and \z can be used to match the start
3873         and  end of the subject in both modes, and if all branches of a pattern         and end of the subject in both modes, and if all branches of a  pattern
3874         start with \A it is always anchored, whether or not  PCRE_MULTILINE  is         start  with  \A it is always anchored, whether or not PCRE_MULTILINE is
3875         set.         set.
3876    
3877    
3878  FULL STOP (PERIOD, DOT)  FULL STOP (PERIOD, DOT) AND \N
3879    
3880         Outside a character class, a dot in the pattern matches any one charac-         Outside a character class, a dot in the pattern matches any one charac-
3881         ter in the subject string except (by default) a character  that  signi-         ter  in  the subject string except (by default) a character that signi-
3882         fies  the  end  of  a line. In UTF-8 mode, the matched character may be         fies the end of a line. In UTF-8 mode, the  matched  character  may  be
3883         more than one byte long.         more than one byte long.
3884    
3885         When a line ending is defined as a single character, dot never  matches         When  a line ending is defined as a single character, dot never matches
3886         that  character; when the two-character sequence CRLF is used, dot does         that character; when the two-character sequence CRLF is used, dot  does
3887         not match CR if it is immediately followed  by  LF,  but  otherwise  it         not  match  CR  if  it  is immediately followed by LF, but otherwise it
3888         matches  all characters (including isolated CRs and LFs). When any Uni-         matches all characters (including isolated CRs and LFs). When any  Uni-
3889         code line endings are being recognized, dot does not match CR or LF  or         code  line endings are being recognized, dot does not match CR or LF or
3890         any of the other line ending characters.         any of the other line ending characters.
3891    
3892         The  behaviour  of  dot  with regard to newlines can be changed. If the         The behaviour of dot with regard to newlines can  be  changed.  If  the
3893         PCRE_DOTALL option is set, a dot matches  any  one  character,  without         PCRE_DOTALL  option  is  set,  a dot matches any one character, without
3894         exception. If the two-character sequence CRLF is present in the subject         exception. If the two-character sequence CRLF is present in the subject
3895         string, it takes two dots to match it.         string, it takes two dots to match it.
3896    
3897         The handling of dot is entirely independent of the handling of  circum-         The  handling of dot is entirely independent of the handling of circum-
3898         flex  and  dollar,  the  only relationship being that they both involve         flex and dollar, the only relationship being  that  they  both  involve
3899         newlines. Dot has no special meaning in a character class.         newlines. Dot has no special meaning in a character class.
3900    
3901           The escape sequence \N always behaves as a dot does when PCRE_DOTALL is
3902           not set. In other words, it matches any one character except  one  that
3903           signifies the end of a line.
3904    
3905    
3906  MATCHING A SINGLE BYTE  MATCHING A SINGLE BYTE
3907    
3908         Outside a character class, the escape sequence \C matches any one byte,         Outside a character class, the escape sequence \C matches any one byte,
3909         both  in  and  out  of  UTF-8 mode. Unlike a dot, it always matches any         both in and out of UTF-8 mode. Unlike a  dot,  it  always  matches  any
3910         line-ending characters. The feature is provided in  Perl  in  order  to         line-ending  characters.  The  feature  is provided in Perl in order to
3911         match  individual bytes in UTF-8 mode. Because it breaks up UTF-8 char-         match individual bytes in UTF-8 mode. Because it breaks up UTF-8  char-
3912         acters into individual bytes, what remains in the string may be a  mal-         acters  into individual bytes, what remains in the string may be a mal-
3913         formed  UTF-8  string.  For this reason, the \C escape sequence is best         formed UTF-8 string. For this reason, the \C escape  sequence  is  best
3914         avoided.         avoided.
3915    
3916         PCRE does not allow \C to appear in  lookbehind  assertions  (described         PCRE  does  not  allow \C to appear in lookbehind assertions (described
3917         below),  because  in UTF-8 mode this would make it impossible to calcu-         below), because in UTF-8 mode this would make it impossible  to  calcu-
3918         late the length of the lookbehind.         late the length of the lookbehind.
3919    
3920    
# Line 3286  SQUARE BRACKETS AND CHARACTER CLASSES Line 3922  SQUARE BRACKETS AND CHARACTER CLASSES
3922    
3923         An opening square bracket introduces a character class, terminated by a         An opening square bracket introduces a character class, terminated by a
3924         closing square bracket. A closing square bracket on its own is not spe-         closing square bracket. A closing square bracket on its own is not spe-
3925         cial. If a closing square bracket is required as a member of the class,         cial by default.  However, if the PCRE_JAVASCRIPT_COMPAT option is set,
3926         it  should  be  the first data character in the class (after an initial         a lone closing square bracket causes a compile-time error. If a closing
3927         circumflex, if present) or escaped with a backslash.         square  bracket  is required as a member of the class, it should be the
3928           first data character in the class  (after  an  initial  circumflex,  if
3929           present) or escaped with a backslash.
3930    
3931         A character class matches a single character in the subject.  In  UTF-8         A  character  class matches a single character in the subject. In UTF-8
3932         mode,  the character may occupy more than one byte. A matched character         mode, the character may be more than one byte long. A matched character
3933         must be in the set of characters defined by the class, unless the first         must be in the set of characters defined by the class, unless the first
3934         character  in  the  class definition is a circumflex, in which case the         character in the class definition is a circumflex, in  which  case  the
3935         subject character must not be in the set defined by  the  class.  If  a         subject  character  must  not  be in the set defined by the class. If a
3936         circumflex  is actually required as a member of the class, ensure it is         circumflex is actually required as a member of the class, ensure it  is
3937         not the first character, or escape it with a backslash.         not the first character, or escape it with a backslash.
3938    
3939         For example, the character class [aeiou] matches any lower case  vowel,         For  example, the character class [aeiou] matches any lower case vowel,
3940         while  [^aeiou]  matches  any character that is not a lower case vowel.         while [^aeiou] matches any character that is not a  lower  case  vowel.
3941         Note that a circumflex is just a convenient notation for specifying the         Note that a circumflex is just a convenient notation for specifying the
3942         characters  that  are in the class by enumerating those that are not. A         characters that are in the class by enumerating those that are  not.  A
3943         class that starts with a circumflex is not an assertion: it still  con-         class  that starts with a circumflex is not an assertion; it still con-
3944         sumes  a  character  from the subject string, and therefore it fails if         sumes a character from the subject string, and therefore  it  fails  if
3945         the current pointer is at the end of the string.         the current pointer is at the end of the string.
3946    
3947         In UTF-8 mode, characters with values greater than 255 can be  included         In  UTF-8 mode, characters with values greater than 255 can be included
3948         in  a  class as a literal string of bytes, or by using the \x{ escaping         in a class as a literal string of bytes, or by using the  \x{  escaping
3949         mechanism.         mechanism.
3950    
3951         When caseless matching is set, any letters in a  class  represent  both         When  caseless  matching  is set, any letters in a class represent both
3952         their  upper  case  and lower case versions, so for example, a caseless         their upper case and lower case versions, so for  example,  a  caseless
3953         [aeiou] matches "A" as well as "a", and a caseless  [^aeiou]  does  not         [aeiou]  matches  "A"  as well as "a", and a caseless [^aeiou] does not
3954         match  "A", whereas a caseful version would. In UTF-8 mode, PCRE always         match "A", whereas a caseful version would. In UTF-8 mode, PCRE  always
3955         understands the concept of case for characters whose  values  are  less         understands  the  concept  of case for characters whose values are less
3956         than  128, so caseless matching is always possible. For characters with         than 128, so caseless matching is always possible. For characters  with
3957         higher values, the concept of case is supported  if  PCRE  is  compiled         higher  values,  the  concept  of case is supported if PCRE is compiled
3958         with  Unicode  property support, but not otherwise.  If you want to use         with Unicode property support, but not otherwise.  If you want  to  use
3959         caseless matching for characters 128 and above, you  must  ensure  that         caseless  matching  in UTF8-mode for characters 128 and above, you must
3960         PCRE  is  compiled  with Unicode property support as well as with UTF-8         ensure that PCRE is compiled with Unicode property support as  well  as
3961         support.         with UTF-8 support.
3962    
3963         Characters that might indicate line breaks are  never  treated  in  any         Characters  that  might  indicate  line breaks are never treated in any
3964         special  way  when  matching  character  classes,  whatever line-ending         special way  when  matching  character  classes,  whatever  line-ending
3965         sequence is in  use,  and  whatever  setting  of  the  PCRE_DOTALL  and         sequence  is  in  use,  and  whatever  setting  of  the PCRE_DOTALL and
3966         PCRE_MULTILINE options is used. A class such as [^a] always matches one         PCRE_MULTILINE options is used. A class such as [^a] always matches one
3967         of these characters.         of these characters.
3968    
3969         The minus (hyphen) character can be used to specify a range of  charac-         The  minus (hyphen) character can be used to specify a range of charac-
3970         ters  in  a  character  class.  For  example,  [d-m] matches any letter         ters in a character  class.  For  example,  [d-m]  matches  any  letter
3971         between d and m, inclusive. If a  minus  character  is  required  in  a         between  d  and  m,  inclusive.  If  a minus character is required in a
3972         class,  it  must  be  escaped  with a backslash or appear in a position         class, it must be escaped with a backslash  or  appear  in  a  position
3973         where it cannot be interpreted as indicating a range, typically as  the         where  it cannot be interpreted as indicating a range, typically as the
3974         first or last character in the class.         first or last character in the class.
3975    
3976         It is not possible to have the literal character "]" as the end charac-         It is not possible to have the literal character "]" as the end charac-
3977         ter of a range. A pattern such as [W-]46] is interpreted as a class  of         ter  of a range. A pattern such as [W-]46] is interpreted as a class of
3978         two  characters ("W" and "-") followed by a literal string "46]", so it         two characters ("W" and "-") followed by a literal string "46]", so  it
3979         would match "W46]" or "-46]". However, if the "]"  is  escaped  with  a         would  match  "W46]"  or  "-46]". However, if the "]" is escaped with a
3980         backslash  it is interpreted as the end of range, so [W-\]46] is inter-         backslash it is interpreted as the end of range, so [W-\]46] is  inter-
3981         preted as a class containing a range followed by two other  characters.         preted  as a class containing a range followed by two other characters.
3982         The  octal or hexadecimal representation of "]" can also be used to end         The octal or hexadecimal representation of "]" can also be used to  end
3983         a range.         a range.
3984    
3985         Ranges operate in the collating sequence of character values. They  can         Ranges  operate in the collating sequence of character values. They can
3986         also   be  used  for  characters  specified  numerically,  for  example         also  be  used  for  characters  specified  numerically,  for   example
3987         [\000-\037]. In UTF-8 mode, ranges can include characters whose  values         [\000-\037].  In UTF-8 mode, ranges can include characters whose values
3988         are greater than 255, for example [\x{100}-\x{2ff}].         are greater than 255, for example [\x{100}-\x{2ff}].
3989    
3990         If a range that includes letters is used when caseless matching is set,         If a range that includes letters is used when caseless matching is set,
3991         it matches the letters in either case. For example, [W-c] is equivalent         it matches the letters in either case. For example, [W-c] is equivalent
3992         to  [][\\^_`wxyzabc],  matched  caselessly,  and  in non-UTF-8 mode, if &