Parent Directory
|
Revision Log
|
Patch
| revision 172 by ph10, Tue Jun 5 10:40:13 2007 UTC | revision 469 by ph10, Mon Oct 19 14:38:48 2009 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, including support for UTF-8 encoded strings and Unicode general |
| 30 | correspond to Unicode release 5.0.0. | 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.1. | |
| 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 the characters that PCRE recog- |
| 226 | nizes as digits, spaces, or word characters remain the same set as | nizes as digits, spaces, or word characters remain the same set as |
| 227 | before, all with values less than 256. This remains true even when PCRE | before, all with values less than 256. This remains true even when PCRE |
| 228 | includes Unicode property support, because to do otherwise would slow | includes Unicode property support, because to do otherwise would slow |
| 229 | down PCRE in many common cases. If you really want to test for a wider | down PCRE in many common cases. If you really want to test for a wider |
| 230 | sense of, say, "digit", you must use Unicode property tests such as | sense of, say, "digit", you must use Unicode property tests such as |
| 231 | \p{Nd}. | \p{Nd}. Note that this also applies to \b, because it is defined in |
| 232 | terms of \w and \W. | |
| 233 | ||
| 234 | 8. Similarly, characters that match the POSIX named character classes | 7. Similarly, characters that match the POSIX named character classes |
| 235 | are all low-valued characters. | are all low-valued characters. |
| 236 | ||
| 237 | 9. Case-insensitive matching applies only to characters whose values | 8. However, the Perl 5.10 horizontal and vertical whitespace matching |
| 238 | are less than 128, unless PCRE is built with Unicode property support. | escapes (\h, \H, \v, and \V) do match all the appropriate Unicode char- |
| 239 | Even when Unicode property support is available, PCRE still uses its | acters. |
| 240 | own character tables when checking the case of low-valued characters, | |
| 241 | so as not to degrade performance. The Unicode property information is | 9. Case-insensitive matching applies only to characters whose values |
| 242 | are less than 128, unless PCRE is built with Unicode property support. | |
| 243 | Even when Unicode property support is available, PCRE still uses its | |
| 244 | own character tables when checking the case of low-valued characters, | |
| 245 | so as not to degrade performance. The Unicode property information is | |
| 246 | used only for characters with higher values. Even when Unicode property | used only for characters with higher values. Even when Unicode property |
| 247 | support is available, PCRE supports case-insensitive matching only when | support is available, PCRE supports case-insensitive matching only when |
| 248 | 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 |
| 249 | 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- |
| 250 | ported by PCRE. | ported by PCRE. |
| 251 | ||
| 252 | ||
| # | Line 215 AUTHOR | Line 256 AUTHOR |
| 256 | University Computing Service | University Computing Service |
| 257 | Cambridge CB2 3QH, England. | Cambridge CB2 3QH, England. |
| 258 | ||
| 259 | 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, |
| 260 | 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, |
| 261 | followed by the two digits 10, at the domain cam.ac.uk. | followed by the two digits 10, at the domain cam.ac.uk. |
| 262 | ||
| 263 | ||
| 264 | REVISION | REVISION |
| 265 | ||
| 266 | Last updated: 18 April 2007 | Last updated: 28 September 2009 |
| 267 | Copyright (c) 1997-2007 University of Cambridge. | Copyright (c) 1997-2009 University of Cambridge. |
| 268 | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
| 269 | ||
| 270 | ||
| # | Line 237 NAME | Line 278 NAME |
| 278 | PCRE BUILD-TIME OPTIONS | PCRE BUILD-TIME OPTIONS |
| 279 | ||
| 280 | This document describes the optional features of PCRE that can be | This document describes the optional features of PCRE that can be |
| 281 | selected when the library is compiled. They are all selected, or dese- | selected when the library is compiled. It assumes use of the configure |
| 282 | lected, by providing options to the configure script that is run before | script, where the optional features are selected or deselected by pro- |
| 283 | the make command. The complete list of options for configure (which | viding options to configure before running the make command. However, |
| 284 | 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 |
| 285 | directory) can be obtained by running | environments using the GUI facility of cmake-gui if you are using CMake |
| 286 | instead of configure to build PCRE. | |
| 287 | ||
| 288 | There is a lot more information about building PCRE in non-Unix-like | |
| 289 | environments in the file called NON_UNIX_USE, which is part of the PCRE | |
| 290 | distribution. You should consult this file as well as the README file | |
| 291 | if you are building in a non-Unix-like environment. | |
| 292 | ||
| 293 | The complete list of options for configure (which includes the standard | |
| 294 | ones such as the selection of the installation directory) can be | |
| 295 | obtained by running | |
| 296 | ||
| 297 | ./configure --help | ./configure --help |
| 298 | ||
| # | Line 266 C++ SUPPORT | Line 317 C++ SUPPORT |
| 317 | ||
| 318 | UTF-8 SUPPORT | UTF-8 SUPPORT |
| 319 | ||
| 320 | To build PCRE with support for UTF-8 character strings, add | To build PCRE with support for UTF-8 Unicode character strings, add |
| 321 | ||
| 322 | --enable-utf8 | --enable-utf8 |
| 323 | ||
| 324 | to the configure command. Of itself, this does not make PCRE treat | to the configure command. Of itself, this does not make PCRE treat |
| 325 | 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 |
| 326 | 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() |
| 327 | function. | or pcre_compile2() functions. |
| 328 | ||
| 329 | If you set --enable-utf8 when compiling in an EBCDIC environment, PCRE | |
| 330 | expects its input to be either ASCII or UTF-8 (depending on the runtime | |
| 331 | option). It is not possible to support both EBCDIC and UTF-8 codes in | |
| 332 | the same version of the library. Consequently, --enable-utf8 and | |
| 333 | --enable-ebcdic are mutually exclusive. | |
| 334 | ||
| 335 | ||
| 336 | UNICODE CHARACTER PROPERTY SUPPORT | UNICODE CHARACTER PROPERTY SUPPORT |
| # | Line 296 UNICODE CHARACTER PROPERTY SUPPORT | Line 353 UNICODE CHARACTER PROPERTY SUPPORT |
| 353 | ||
| 354 | CODE VALUE OF NEWLINE | CODE VALUE OF NEWLINE |
| 355 | ||
| 356 | By default, PCRE interprets character 10 (linefeed, LF) as indicating | By default, PCRE interprets the linefeed (LF) character as indicating |
| 357 | 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 |
| 358 | systems. You can compile PCRE to use character 13 (carriage return, CR) | systems. You can compile PCRE to use carriage return (CR) instead, by |
| 359 | instead, by adding | adding |
| 360 | ||
| 361 | --enable-newline-is-cr | --enable-newline-is-cr |
| 362 | ||
| # | Line 322 CODE VALUE OF NEWLINE | Line 379 CODE VALUE OF NEWLINE |
| 379 | ||
| 380 | causes PCRE to recognize any Unicode newline sequence. | causes PCRE to recognize any Unicode newline sequence. |
| 381 | ||
| 382 | Whatever line ending convention is selected when PCRE is built can be | Whatever line ending convention is selected when PCRE is built can be |
| 383 | overridden when the library functions are called. At build time it is | overridden when the library functions are called. At build time it is |
| 384 | conventional to use the standard for your operating system. | conventional to use the standard for your operating system. |
| 385 | ||
| 386 | ||
| 387 | WHAT \R MATCHES | |
| 388 | ||
| 389 | By default, the sequence \R in a pattern matches any Unicode newline | |
| 390 | sequence, whatever has been selected as the line ending sequence. If | |
| 391 | you specify | |
| 392 | ||
| 393 | --enable-bsr-anycrlf | |
| 394 | ||
| 395 | the default is changed so that \R matches only CR, LF, or CRLF. What- | |
| 396 | ever is selected when PCRE is built can be overridden when the library | |
| 397 | functions are called. | |
| 398 | ||
| 399 | ||
| 400 | BUILDING SHARED AND STATIC LIBRARIES | BUILDING SHARED AND STATIC LIBRARIES |
| 401 | ||
| 402 | The PCRE building process uses libtool to build both shared and static | The PCRE building process uses libtool to build both shared and static |
| 403 | 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 |
| 404 | of | of |
| 405 | ||
| 406 | --disable-shared | --disable-shared |
| # | Line 342 BUILDING SHARED AND STATIC LIBRARIES | Line 412 BUILDING SHARED AND STATIC LIBRARIES |
| 412 | POSIX MALLOC USAGE | POSIX MALLOC USAGE |
| 413 | ||
| 414 | When PCRE is called through the POSIX interface (see the pcreposix doc- | When PCRE is called through the POSIX interface (see the pcreposix doc- |
| 415 | umentation), additional working storage is required for holding the | umentation), additional working storage is required for holding the |
| 416 | pointers to capturing substrings, because PCRE requires three integers | pointers to capturing substrings, because PCRE requires three integers |
| 417 | per substring, whereas the POSIX interface provides only two. If the | per substring, whereas the POSIX interface provides only two. If the |
| 418 | number of expected substrings is small, the wrapper function uses space | number of expected substrings is small, the wrapper function uses space |
| 419 | 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. |
| 420 | 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 427 POSIX MALLOC USAGE |
| 427 | ||
| 428 | HANDLING VERY LARGE PATTERNS | HANDLING VERY LARGE PATTERNS |
| 429 | ||
| 430 | Within a compiled pattern, offset values are used to point from one | Within a compiled pattern, offset values are used to point from one |
| 431 | part to another (for example, from an opening parenthesis to an alter- | part to another (for example, from an opening parenthesis to an alter- |
| 432 | nation metacharacter). By default, two-byte values are used for these | nation metacharacter). By default, two-byte values are used for these |
| 433 | offsets, leading to a maximum size for a compiled pattern of around | offsets, leading to a maximum size for a compiled pattern of around |
| 434 | 64K. This is sufficient to handle all but the most gigantic patterns. | 64K. This is sufficient to handle all but the most gigantic patterns. |
| 435 | Nevertheless, some people do want to process enormous patterns, so it | Nevertheless, some people do want to process truyl enormous patterns, |
| 436 | 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- |
| 437 | adding a setting such as | sets by adding a setting such as |
| 438 | ||
| 439 | --with-link-size=3 | --with-link-size=3 |
| 440 | ||
| 441 | 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 |
| 442 | 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 |
| 443 | additional bytes when handling them. | additional bytes when handling them. |
| 444 | ||
| 445 | ||
| 446 | AVOIDING EXCESSIVE STACK USAGE | AVOIDING EXCESSIVE STACK USAGE |
| 447 | ||
| 448 | When matching with the pcre_exec() function, PCRE implements backtrack- | When matching with the pcre_exec() function, PCRE implements backtrack- |
| 449 | ing by making recursive calls to an internal function called match(). | ing by making recursive calls to an internal function called match(). |
| 450 | 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- |
| 451 | verely limit PCRE's operation. (The Unix environment does not usually | verely limit PCRE's operation. (The Unix environment does not usually |
| 452 | suffer from this problem, but it may sometimes be necessary to increase | suffer from this problem, but it may sometimes be necessary to increase |
| 453 | the maximum stack size. There is a discussion in the pcrestack docu- | the maximum stack size. There is a discussion in the pcrestack docu- |
| 454 | mentation.) An alternative approach to recursion that uses memory from | mentation.) An alternative approach to recursion that uses memory from |
| 455 | the heap to remember data, instead of using recursive function calls, | the heap to remember data, instead of using recursive function calls, |
| 456 | has been implemented to work round the problem of limited stack size. | has been implemented to work round the problem of limited stack size. |
| 457 | 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 |
| 458 | ||
| 459 | --disable-stack-for-recursion | --disable-stack-for-recursion |
| 460 | ||
| 461 | to the configure command. With this configuration, PCRE will use the | to the configure command. With this configuration, PCRE will use the |
| 462 | pcre_stack_malloc and pcre_stack_free variables to call memory manage- | pcre_stack_malloc and pcre_stack_free variables to call memory manage- |
| 463 | ment functions. Separate functions are provided because the usage is | ment functions. By default these point to malloc() and free(), but you |
| 464 | very predictable: the block sizes requested are always the same, and | can replace the pointers so that your own functions are used instead. |
| 465 | the blocks are always freed in reverse order. A calling program might | |
| 466 | be able to implement optimized functions that perform better than the | Separate functions are provided rather than using pcre_malloc and |
| 467 | standard malloc() and free() functions. PCRE runs noticeably more | pcre_free because the usage is very predictable: the block sizes |
| 468 | 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 |
| 469 | function; it is not relevant for the the pcre_dfa_exec() function. | reverse order. A calling program might be able to implement optimized |
| 470 | functions that perform better than malloc() and free(). PCRE runs | |
| 471 | noticeably more slowly when built in this way. This option affects only | |
| 472 | the pcre_exec() function; it is not relevant for pcre_dfa_exec(). | |
| 473 | ||
| 474 | ||
| 475 | LIMITING PCRE RESOURCE USAGE | LIMITING PCRE RESOURCE USAGE |
| # | Line 451 USING EBCDIC CODE | Line 524 USING EBCDIC CODE |
| 524 | ||
| 525 | 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 |
| 526 | character code is ASCII (or Unicode, which is a superset of ASCII). | character code is ASCII (or Unicode, which is a superset of ASCII). |
| 527 | PCRE can, however, be compiled to run in an EBCDIC environment by | This is the case for most computer operating systems. PCRE can, how- |
| 528 | adding | ever, be compiled to run in an EBCDIC environment by adding |
| 529 | ||
| 530 | --enable-ebcdic | --enable-ebcdic |
| 531 | ||
| 532 | to the configure command. This setting implies --enable-rebuild-charta- | to the configure command. This setting implies --enable-rebuild-charta- |
| 533 | bles. | bles. You should only use it if you know that you are in an EBCDIC |
| 534 | environment (for example, an IBM mainframe operating system). The | |
| 535 | --enable-ebcdic option is incompatible with --enable-utf8. | |
| 536 | ||
| 537 | ||
| 538 | PCREGREP OPTIONS FOR COMPRESSED FILE SUPPORT | |
| 539 | ||
| 540 | By default, pcregrep reads all files as plain text. You can build it so | |
| 541 | that it recognizes files whose names end in .gz or .bz2, and reads them | |
| 542 | with libz or libbz2, respectively, by adding one or both of | |
| 543 | ||
| 544 | --enable-pcregrep-libz | |
| 545 | --enable-pcregrep-libbz2 | |
| 546 | ||
| 547 | to the configure command. These options naturally require that the rel- | |
| 548 | evant libraries are installed on your system. Configuration will fail | |
| 549 | if they are not. | |
| 550 | ||
| 551 | ||
| 552 | PCRETEST OPTION FOR LIBREADLINE SUPPORT | |
| 553 | ||
| 554 | If you add | |
| 555 | ||
| 556 | --enable-pcretest-libreadline | |
| 557 | ||
| 558 | to the configure command, pcretest is linked with the libreadline | |
| 559 | library, and when its input is from a terminal, it reads it using the | |
| 560 | readline() function. This provides line-editing and history facilities. | |
| 561 | Note that libreadline is GPL-licensed, so if you distribute a binary of | |
| 562 | pcretest linked in this way, there may be licensing issues. | |
| 563 | ||
| 564 | Setting this option causes the -lreadline option to be added to the | |
| 565 | pcretest build. In many operating environments with a sytem-installed | |
| 566 | libreadline this is sufficient. However, in some environments (e.g. if | |
| 567 | an unmodified distribution version of readline is in use), some extra | |
| 568 | configuration may be necessary. The INSTALL file for libreadline says | |
| 569 | this: | |
| 570 | ||
| 571 | "Readline uses the termcap functions, but does not link with the | |
| 572 | termcap or curses library itself, allowing applications which link | |
| 573 | with readline the to choose an appropriate library." | |
| 574 | ||
| 575 | If your environment has not been set up so that an appropriate library | |
| 576 | is automatically included, you may need to add something like | |
| 577 | ||
| 578 | LIBS="-ncurses" | |
| 579 | ||
| 580 | immediately before the configure command. | |
| 581 | ||
| 582 | ||
| 583 | SEE ALSO | SEE ALSO |
| # | Line 474 AUTHOR | Line 594 AUTHOR |
| 594 | ||
| 595 | REVISION | REVISION |
| 596 | ||
| 597 | Last updated: 16 April 2007 | Last updated: 29 September 2009 |
| 598 | Copyright (c) 1997-2007 University of Cambridge. | Copyright (c) 1997-2009 University of Cambridge. |
| 599 | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
| 600 | ||
| 601 | ||
| # | Line 562 THE ALTERNATIVE MATCHING ALGORITHM | Line 682 THE ALTERNATIVE MATCHING ALGORITHM |
| 682 | though it is not implemented as a traditional finite state machine (it | though it is not implemented as a traditional finite state machine (it |
| 683 | keeps multiple states active simultaneously). | keeps multiple states active simultaneously). |
| 684 | ||
| 685 | Although the general principle of this matching algorithm is that it | |
| 686 | scans the subject string only once, without backtracking, there is one | |
| 687 | exception: when a lookaround assertion is encountered, the characters | |
| 688 | following or preceding the current point have to be independently | |
| 689 | inspected. | |
| 690 | ||
| 691 | 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 |
| 692 | there are no more unterminated paths. At this point, terminated paths | there are no more unterminated paths. At this point, terminated paths |
| 693 | represent the different matching possibilities (if there are none, the | represent the different matching possibilities (if there are none, the |
| 694 | match has failed). Thus, if there is more than one possible match, | match has failed). Thus, if there is more than one possible match, |
| 695 | 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- |
| 696 | 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 |
| 697 | match (which is necessarily the shortest) has been found. | (which is necessarily the shortest) is found. |
| 698 | ||
| 699 | 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 |
| 700 | subject. If the pattern | subject. If the pattern |
| # | Line 618 THE ALTERNATIVE MATCHING ALGORITHM | Line 744 THE ALTERNATIVE MATCHING ALGORITHM |
| 744 | 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 |
| 745 | 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. |
| 746 | ||
| 747 | 7. The \C escape sequence, which (in the standard algorithm) matches a | 7. The \C escape sequence, which (in the standard algorithm) matches a |
| 748 | 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- |
| 749 | tive algorithm moves through the subject string one character at a | tive algorithm moves through the subject string one character at a |
| 750 | time, for all active paths through the tree. | time, for all active paths through the tree. |
| 751 | ||
| 752 | 8. Except for (*FAIL), the backtracking control verbs such as (*PRUNE) | |
| 753 | are not supported. (*FAIL) is supported, and behaves like a failing | |
| 754 | negative assertion. | |
| 755 | ||
| 756 | ||
| 757 | ADVANTAGES OF THE ALTERNATIVE ALGORITHM | ADVANTAGES OF THE ALTERNATIVE ALGORITHM |
| 758 | ||
| # | Line 634 ADVANTAGES OF THE ALTERNATIVE ALGORITHM | Line 764 ADVANTAGES OF THE ALTERNATIVE ALGORITHM |
| 764 | 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 |
| 765 | things with callouts. | things with callouts. |
| 766 | ||
| 767 | 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 | ||
| 768 | 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 |
| 769 | subject strings to the matching function in several pieces, checking | subject strings to the matching function in several pieces, checking |
| 770 | for partial matching each time. | for partial matching each time. The pcrepartial documentation gives |
| 771 | details of partial matching. | |
| 772 | ||
| 773 | ||
| 774 | DISADVANTAGES OF THE ALTERNATIVE ALGORITHM | DISADVANTAGES OF THE ALTERNATIVE ALGORITHM |
| 775 | ||
| 776 | The alternative algorithm suffers from a number of disadvantages: | The alternative algorithm suffers from a number of disadvantages: |
| 777 | ||
| 778 | 1. It is substantially slower than the standard algorithm. This is | 1. It is substantially slower than the standard algorithm. This is |
| 779 | 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 |
| 780 | because it is less susceptible to optimization. | because it is less susceptible to optimization. |
| 781 | ||
| 782 | 2. Capturing parentheses and back references are not supported. | 2. Capturing parentheses and back references are not supported. |
| # | Line 669 AUTHOR | Line 794 AUTHOR |
| 794 | ||
| 795 | REVISION | REVISION |
| 796 | ||
| 797 | Last updated: 29 May 2007 | Last updated: 29 September 2009 |
| 798 | Copyright (c) 1997-2007 University of Cambridge. | Copyright (c) 1997-2009 University of Cambridge. |
| 799 | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
| 800 | ||
| 801 | ||
| # | Line 781 PCRE API OVERVIEW | Line 906 PCRE API OVERVIEW |
| 906 | pcre_exec() are used for compiling and matching regular expressions in | pcre_exec() are used for compiling and matching regular expressions in |
| 907 | a Perl-compatible manner. A sample program that demonstrates the sim- | a Perl-compatible manner. A sample program that demonstrates the sim- |
| 908 | 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 |
| 909 | the source distribution. The pcresample documentation describes how to | the PCRE source distribution. A listing of this program is given in the |
| 910 | run it. | pcredemo documentation, and the pcresample documentation describes how |
| 911 | to compile and run it. | |
| 912 | ||
| 913 | A second matching function, pcre_dfa_exec(), which is not Perl-compati- | A second matching function, pcre_dfa_exec(), which is not Perl-compati- |
| 914 | ble, is also provided. This uses a different algorithm for the match- | ble, is also provided. This uses a different algorithm for the match- |
| 915 | ing. The alternative algorithm finds all possible matches (at a given | ing. The alternative algorithm finds all possible matches (at a given |
| 916 | point in the subject), and scans the subject just once. However, this | point in the subject), and scans the subject just once (unless there |
| 917 | algorithm does not return captured substrings. A description of the two | are lookbehind assertions). However, this algorithm does not return |
| 918 | matching algorithms and their advantages and disadvantages is given in | captured substrings. A description of the two matching algorithms and |
| 919 | the pcrematching documentation. | their advantages and disadvantages is given in the pcrematching docu- |
| 920 | mentation. | |
| 921 | ||
| 922 | In addition to the main compiling and matching functions, there are | In addition to the main compiling and matching functions, there are |
| 923 | convenience functions for extracting captured substrings from a subject | convenience functions for extracting captured substrings from a subject |
| # | Line 866 NEWLINES | Line 993 NEWLINES |
| 993 | 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 |
| 994 | pattern is compiled, or when it is matched. | pattern is compiled, or when it is matched. |
| 995 | ||
| 996 | At compile time, the newline convention can be specified by the options | |
| 997 | argument of pcre_compile(), or it can be specified by special text at | |
| 998 | the start of the pattern itself; this overrides any other settings. See | |
| 999 | the pcrepattern page for details of the special character sequences. | |
| 1000 | ||
| 1001 | 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- |
| 1002 | 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 |
| 1003 | newline convention affects the handling of the dot, circumflex, and | newline convention affects the handling of the dot, circumflex, and |
| 1004 | dollar metacharacters, the handling of #-comments in /x mode, and, when | dollar metacharacters, the handling of #-comments in /x mode, and, when |
| 1005 | CRLF is a recognized line ending sequence, the match position advance- | CRLF is a recognized line ending sequence, the match position advance- |
| 1006 | 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 |
| 1007 | not affect the interpretation of the \n or \r escape sequences. | section on pcre_exec() options below. |
| 1008 | ||
| 1009 | The choice of newline convention does not affect the interpretation of | |
| 1010 | the \n or \r escape sequences, nor does it affect what \R matches, | |
| 1011 | which is controlled in a similar way, but by separate options. | |
| 1012 | ||
| 1013 | ||
| 1014 | MULTITHREADING | MULTITHREADING |
| 1015 | ||
| 1016 | The PCRE functions can be used in multi-threading applications, with | The PCRE functions can be used in multi-threading applications, with |
| 1017 | the proviso that the memory management functions pointed to by | the proviso that the memory management functions pointed to by |
| 1018 | 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 |
| 1019 | 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 1062 CHECKING BUILD-TIME OPTIONS |
| 1062 | The output is an integer whose value specifies the default character | The output is an integer whose value specifies the default character |
| 1063 | sequence that is recognized as meaning "newline". The four values that | sequence that is recognized as meaning "newline". The four values that |
| 1064 | 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, |
| 1065 | 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 |
| 1066 | for your operating system. | are returned in EBCDIC environments. The default should normally corre- |
| 1067 | spond to the standard sequence for your operating system. | |
| 1068 | ||
| 1069 | PCRE_CONFIG_BSR | |
| 1070 | ||
| 1071 | The output is an integer whose value indicates what character sequences | |
| 1072 | the \R escape sequence matches by default. A value of 0 means that \R | |
| 1073 | matches any Unicode line ending sequence; a value of 1 means that \R | |
| 1074 | matches only CR, LF, or CRLF. The default can be overridden when a pat- | |
| 1075 | tern is compiled or matched. | |
| 1076 | ||
| 1077 | PCRE_CONFIG_LINK_SIZE | PCRE_CONFIG_LINK_SIZE |
| 1078 | ||
| 1079 | 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 |
| 1080 | internal linkage in compiled regular expressions. The value is 2, 3, or | internal linkage in compiled regular expressions. The value is 2, 3, or |
| 1081 | 4. Larger values allow larger regular expressions to be compiled, at | 4. Larger values allow larger regular expressions to be compiled, at |
| 1082 | the expense of slower matching. The default value of 2 is sufficient | the expense of slower matching. The default value of 2 is sufficient |
| 1083 | for all but the most massive patterns, since it allows the compiled | for all but the most massive patterns, since it allows the compiled |
| 1084 | pattern to be up to 64K in size. | pattern to be up to 64K in size. |
| 1085 | ||
| 1086 | PCRE_CONFIG_POSIX_MALLOC_THRESHOLD | PCRE_CONFIG_POSIX_MALLOC_THRESHOLD |
| 1087 | ||
| 1088 | The output is an integer that contains the threshold above which the | The output is an integer that contains the threshold above which the |
| 1089 | POSIX interface uses malloc() for output vectors. Further details are | POSIX interface uses malloc() for output vectors. Further details are |
| 1090 | given in the pcreposix documentation. | given in the pcreposix documentation. |
| 1091 | ||
| 1092 | PCRE_CONFIG_MATCH_LIMIT | PCRE_CONFIG_MATCH_LIMIT |
| 1093 | ||
| 1094 | 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- |
| 1095 | internal matching function calls in a pcre_exec() execution. Further | ber of internal matching function calls in a pcre_exec() execution. |
| 1096 | details are given with pcre_exec() below. | Further details are given with pcre_exec() below. |
| 1097 | ||
| 1098 | PCRE_CONFIG_MATCH_LIMIT_RECURSION | PCRE_CONFIG_MATCH_LIMIT_RECURSION |
| 1099 | ||
| 1100 | 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 |
| 1101 | recursion when calling the internal matching function in a pcre_exec() | of recursion when calling the internal matching function in a |
| 1102 | execution. Further details are given with pcre_exec() below. | pcre_exec() execution. Further details are given with pcre_exec() |
| 1103 | below. | |
| 1104 | ||
| 1105 | PCRE_CONFIG_STACKRECURSE | PCRE_CONFIG_STACKRECURSE |
| 1106 | ||
| # | Line 981 COMPILING A PATTERN | Line 1127 COMPILING A PATTERN |
| 1127 | Either of the functions pcre_compile() or pcre_compile2() can be called | Either of the functions pcre_compile() or pcre_compile2() can be called |
| 1128 | to compile a pattern into an internal form. The only difference between | to compile a pattern into an internal form. The only difference between |
| 1129 | the two interfaces is that pcre_compile2() has an additional argument, | the two interfaces is that pcre_compile2() has an additional argument, |
| 1130 | errorcodeptr, via which a numerical error code can be returned. | errorcodeptr, via which a numerical error code can be returned. To |
| 1131 | avoid too much repetition, we refer just to pcre_compile() below, but | |
| 1132 | the information applies equally to pcre_compile2(). | |
| 1133 | ||
| 1134 | 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 |
| 1135 | 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 1146 COMPILING A PATTERN |
| 1146 | ||
| 1147 | The options argument contains various bit settings that affect the com- | The options argument contains various bit settings that affect the com- |
| 1148 | pilation. It should be zero if no options are required. The available | pilation. It should be zero if no options are required. The available |
| 1149 | options are described below. Some of them, in particular, those that | options are described below. Some of them (in particular, those that |
| 1150 | 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 |
| 1151 | pattern (see the detailed description in the pcrepattern documenta- | unset from within the pattern (see the detailed description in the |
| 1152 | tion). For these options, the contents of the options argument speci- | pcrepattern documentation). For those options that can be different in |
| 1153 | fies their initial settings at the start of compilation and execution. | different parts of the pattern, the contents of the options argument |
| 1154 | 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 |
| 1155 | of matching as well as at compile time. | PCRE_ANCHORED, PCRE_BSR_xxx, and PCRE_NEWLINE_xxx options can be set at |
| 1156 | the time of matching as well as at compile time. | |
| 1157 | ||
| 1158 | If errptr is NULL, pcre_compile() returns NULL immediately. Otherwise, | If errptr is NULL, pcre_compile() returns NULL immediately. Otherwise, |
| 1159 | if compilation of a pattern fails, pcre_compile() returns NULL, and | if compilation of a pattern fails, pcre_compile() returns NULL, and |
| 1160 | 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- |
| 1161 | 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 |
| 1162 | 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 |
| 1163 | ter where the error was discovered is placed in the variable pointed to | character that was being processed when the error was discovered is |
| 1164 | 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. |
| 1165 | given. | If it is, an immediate error is given. Some errors are not detected |
| 1166 | until checks are carried out when the whole pattern has been scanned; | |
| 1167 | 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. |
| 1168 | codeptr argument is not NULL, a non-zero error code number is returned | |
| 1169 | 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- |
| 1170 | codeptr argument is not NULL, a non-zero error code number is returned | |
| 1171 | via this argument in the event of an error. This is in addition to the | |
| 1172 | textual error message. Error codes and messages are listed below. | textual error message. Error codes and messages are listed below. |
| 1173 | ||
| 1174 | 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 |
| 1175 | character tables that are built when PCRE is compiled, using the | character tables that are built when PCRE is compiled, using the |
| 1176 | default C locale. Otherwise, tableptr must be an address that is the | default C locale. Otherwise, tableptr must be an address that is the |
| 1177 | 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 |
| 1178 | compiled pattern, and used again by pcre_exec(), unless another table | compiled pattern, and used again by pcre_exec(), unless another table |
| 1179 | 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 |
| 1180 | support below. | support below. |
| 1181 | ||
| 1182 | This code fragment shows a typical straightforward call to pcre_com- | This code fragment shows a typical straightforward call to pcre_com- |
| 1183 | pile(): | pile(): |
| 1184 | ||
| 1185 | pcre *re; | pcre *re; |
| # | Line 1041 COMPILING A PATTERN | Line 1192 COMPILING A PATTERN |
| 1192 | &erroffset, /* for error offset */ | &erroffset, /* for error offset */ |
| 1193 | NULL); /* use default character tables */ | NULL); /* use default character tables */ |
| 1194 | ||
| 1195 | 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 |
| 1196 | file: | file: |
| 1197 | ||
| 1198 | PCRE_ANCHORED | PCRE_ANCHORED |
| 1199 | ||
| 1200 | 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 |
| 1201 | 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 |
| 1202 | that is being searched (the "subject string"). This effect can also be | that is being searched (the "subject string"). This effect can also be |
| 1203 | achieved by appropriate constructs in the pattern itself, which is the | achieved by appropriate constructs in the pattern itself, which is the |
| 1204 | only way to do it in Perl. | only way to do it in Perl. |
| 1205 | ||
| 1206 | PCRE_AUTO_CALLOUT | PCRE_AUTO_CALLOUT |
| 1207 | ||
| 1208 | If this bit is set, pcre_compile() automatically inserts callout items, | If this bit is set, pcre_compile() automatically inserts callout items, |
| 1209 | all with number 255, before each pattern item. For discussion of the | all with number 255, before each pattern item. For discussion of the |
| 1210 | callout facility, see the pcrecallout documentation. | callout facility, see the pcrecallout documentation. |
| 1211 | ||
| 1212 | PCRE_BSR_ANYCRLF | |
| 1213 | PCRE_BSR_UNICODE | |
| 1214 | ||
| 1215 | These options (which are mutually exclusive) control what the \R escape | |
| 1216 | sequence matches. The choice is either to match only CR, LF, or CRLF, | |
| 1217 | or to match any Unicode newline sequence. The default is specified when | |
| 1218 | PCRE is built. It can be overridden from within the pattern, or by set- | |
| 1219 | ting an option when a compiled pattern is matched. | |
| 1220 | ||
| 1221 | PCRE_CASELESS | PCRE_CASELESS |
| 1222 | ||
| 1223 | 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 |
| 1224 | 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 |
| 1225 | 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 |
| 1226 | always understands the concept of case for characters whose values are | always understands the concept of case for characters whose values are |
| 1227 | less than 128, so caseless matching is always possible. For characters | less than 128, so caseless matching is always possible. For characters |
| 1228 | 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- |
| 1229 | piled with Unicode property support, but not otherwise. If you want to | piled with Unicode property support, but not otherwise. If you want to |
| 1230 | use caseless matching for characters 128 and above, you must ensure | use caseless matching for characters 128 and above, you must ensure |
| 1231 | that PCRE is compiled with Unicode property support as well as with | that PCRE is compiled with Unicode property support as well as with |
| 1232 | UTF-8 support. | UTF-8 support. |
| 1233 | ||
| 1234 | PCRE_DOLLAR_ENDONLY | PCRE_DOLLAR_ENDONLY |
| 1235 | ||
| 1236 | 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 |
| 1237 | 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 |
| 1238 | 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 |
| 1239 | before any other newlines). The PCRE_DOLLAR_ENDONLY option is ignored | before any other newlines). The PCRE_DOLLAR_ENDONLY option is ignored |
| 1240 | 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 |
| 1241 | Perl, and no way to set it within a pattern. | Perl, and no way to set it within a pattern. |
| 1242 | ||
| 1243 | PCRE_DOTALL | PCRE_DOTALL |
| 1244 | ||
| 1245 | 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- |
| 1246 | acters, including those that indicate newline. Without it, a dot does | acters, including those that indicate newline. Without it, a dot does |
| 1247 | 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 |
| 1248 | 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 |
| 1249 | 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 |
| 1250 | newline characters, independent of the setting of this option. | newline characters, independent of the setting of this option. |
| 1251 | ||
| 1252 | PCRE_DUPNAMES | PCRE_DUPNAMES |
| 1253 | ||
| 1254 | If this bit is set, names used to identify capturing subpatterns need | If this bit is set, names used to identify capturing subpatterns need |
| 1255 | 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 |
| 1256 | 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 |
| 1257 | matched. There are more details of named subpatterns below; see also | matched. There are more details of named subpatterns below; see also |
| 1258 | the pcrepattern documentation. | the pcrepattern documentation. |
| 1259 | ||
| 1260 | PCRE_EXTENDED | PCRE_EXTENDED |
| 1261 | ||
| 1262 | If this bit is set, whitespace data characters in the pattern are | If this bit is set, whitespace data characters in the pattern are |
| 1263 | totally ignored except when escaped or inside a character class. White- | totally ignored except when escaped or inside a character class. White- |
| 1264 | space does not include the VT character (code 11). In addition, charac- | space does not include the VT character (code 11). In addition, charac- |
| 1265 | ters between an unescaped # outside a character class and the next new- | ters between an unescaped # outside a character class and the next new- |
| 1266 | line, inclusive, are also ignored. This is equivalent to Perl's /x | line, inclusive, are also ignored. This is equivalent to Perl's /x |
| 1267 | 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- |
| 1268 | ting. | ting. |
| 1269 | ||
| 1270 | This option makes it possible to include comments inside complicated | This option makes it possible to include comments inside complicated |
| 1271 | patterns. Note, however, that this applies only to data characters. | patterns. Note, however, that this applies only to data characters. |
| 1272 | Whitespace characters may never appear within special character | Whitespace characters may never appear within special character |
| 1273 | sequences in a pattern, for example within the sequence (?( which | sequences in a pattern, for example within the sequence (?( which |
| 1274 | introduces a conditional subpattern. | introduces a conditional subpattern. |
| 1275 | ||
| 1276 | PCRE_EXTRA | PCRE_EXTRA |
| 1277 | ||
| 1278 | This option was invented in order to turn on additional functionality | This option was invented in order to turn on additional functionality |
| 1279 | 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 |
| 1280 | 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 |
| 1281 | letter that has no special meaning causes an error, thus reserving | letter that has no special meaning causes an error, thus reserving |
| 1282 | these combinations for future expansion. By default, as in Perl, a | these combinations for future expansion. By default, as in Perl, a |
| 1283 | 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 |
| 1284 | literal. (Perl can, however, be persuaded to give a warning for this.) | literal. (Perl can, however, be persuaded to give a warning for this.) |
| 1285 | There are at present no other features controlled by this option. It | There are at present no other features controlled by this option. It |
| 1286 | can also be set by a (?X) option setting within a pattern. | can also be set by a (?X) option setting within a pattern. |
| 1287 | ||
| 1288 | PCRE_FIRSTLINE | PCRE_FIRSTLINE |
| 1289 | ||
| 1290 | If this option is set, an unanchored pattern is required to match | If this option is set, an unanchored pattern is required to match |
| 1291 | before or at the first newline in the subject string, though the | before or at the first newline in the subject string, though the |
| 1292 | matched text may continue over the newline. | matched text may continue over the newline. |
| 1293 | ||
| 1294 | PCRE_JAVASCRIPT_COMPAT | |
| 1295 | ||
| 1296 | If this option is set, PCRE's behaviour is changed in some ways so that | |
| 1297 | it is compatible with JavaScript rather than Perl. The changes are as | |
| 1298 | follows: | |
| 1299 | ||
| 1300 | (1) A lone closing square bracket in a pattern causes a compile-time | |
| 1301 | error, because this is illegal in JavaScript (by default it is treated | |
| 1302 | as a data character). Thus, the pattern AB]CD becomes illegal when this | |
| 1303 | option is set. | |
| 1304 | ||
| 1305 | (2) At run time, a back reference to an unset subpattern group matches | |
| 1306 | an empty string (by default this causes the current matching alterna- | |
| 1307 | tive to fail). A pattern such as (\1)(a) succeeds when this option is | |
| 1308 | set (assuming it can find an "a" in the subject), whereas it fails by | |
| 1309 | default, for Perl compatibility. | |
| 1310 | ||
| 1311 | PCRE_MULTILINE | PCRE_MULTILINE |
| 1312 | ||
| 1313 | By default, PCRE treats the subject string as consisting of a single | By default, PCRE treats the subject string as consisting of a single |
| # | Line 1184 COMPILING A PATTERN | Line 1361 COMPILING A PATTERN |
| 1361 | and are therefore ignored. | and are therefore ignored. |
| 1362 | ||
| 1363 | 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 |
| 1364 | 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. |
| 1365 | ||
| 1366 | PCRE_NO_AUTO_CAPTURE | PCRE_NO_AUTO_CAPTURE |
| 1367 | ||
| 1368 | If this option is set, it disables the use of numbered capturing paren- | If this option is set, it disables the use of numbered capturing paren- |
| 1369 | theses in the pattern. Any opening parenthesis that is not followed by | theses in the pattern. Any opening parenthesis that is not followed by |
| 1370 | ? behaves as if it were followed by ?: but named parentheses can still | ? behaves as if it were followed by ?: but named parentheses can still |
| 1371 | be used for capturing (and they acquire numbers in the usual way). | be used for capturing (and they acquire numbers in the usual way). |
| 1372 | There is no equivalent of this option in Perl. | There is no equivalent of this option in Perl. |
| 1373 | ||
| 1374 | PCRE_UNGREEDY | PCRE_UNGREEDY |
| 1375 | ||
| 1376 | This option inverts the "greediness" of the quantifiers so that they | This option inverts the "greediness" of the quantifiers so that they |
| 1377 | are not greedy by default, but become greedy if followed by "?". It is | are not greedy by default, but become greedy if followed by "?". It is |
| 1378 | not compatible with Perl. It can also be set by a (?U) option setting | not compatible with Perl. It can also be set by a (?U) option setting |
| 1379 | within the pattern. | within the pattern. |
| 1380 | ||
| 1381 | PCRE_UTF8 | PCRE_UTF8 |
| 1382 | ||
| 1383 | This option causes PCRE to regard both the pattern and the subject as | This option causes PCRE to regard both the pattern and the subject as |
| 1384 | strings of UTF-8 characters instead of single-byte character strings. | strings of UTF-8 characters instead of single-byte character strings. |
| 1385 | However, it is available only when PCRE is built to include UTF-8 sup- | However, it is available only when PCRE is built to include UTF-8 sup- |
| 1386 | port. If not, the use of this option provokes an error. Details of how | port. If not, the use of this option provokes an error. Details of how |
| 1387 | this option changes the behaviour of PCRE are given in the section on | this option changes the behaviour of PCRE are given in the section on |
| 1388 | UTF-8 support in the main pcre page. | UTF-8 support in the main pcre page. |
| 1389 | ||
| 1390 | PCRE_NO_UTF8_CHECK | PCRE_NO_UTF8_CHECK |
| 1391 | ||
| 1392 | 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 |
| 1393 | automatically checked. If an invalid UTF-8 sequence of bytes is found, | automatically checked. There is a discussion about the validity of |
| 1394 | 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 |
| 1395 | 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 |
| 1396 | 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- |
| 1397 | 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 |
| 1398 | 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 |
| 1399 | 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 |
| 1400 | ing of subject strings. | can also be passed to pcre_exec() and pcre_dfa_exec(), to suppress the |
| 1401 | UTF-8 validity checking of subject strings. | |
| 1402 | ||
| 1403 | ||
| 1404 | COMPILATION ERROR CODES | COMPILATION ERROR CODES |
| # | Line 1242 COMPILATION ERROR CODES | Line 1420 COMPILATION ERROR CODES |
| 1420 | 9 nothing to repeat | 9 nothing to repeat |
| 1421 | 10 [this code is not in use] | 10 [this code is not in use] |
| 1422 | 11 internal error: unexpected repeat | 11 internal error: unexpected repeat |
| 1423 | 12 unrecognized character after (? | 12 unrecognized character after (? or (?- |
| 1424 | 13 POSIX named classes are supported only within a class | 13 POSIX named classes are supported only within a class |
| 1425 | 14 missing ) | 14 missing ) |
| 1426 | 15 reference to non-existent subpattern | 15 reference to non-existent subpattern |
| # | Line 1250 COMPILATION ERROR CODES | Line 1428 COMPILATION ERROR CODES |
| 1428 | 17 unknown option bit(s) set | 17 unknown option bit(s) set |
| 1429 | 18 missing ) after comment | 18 missing ) after comment |
| 1430 | 19 [this code is not in use] | 19 [this code is not in use] |
| 1431 | 20 regular expression too large | 20 regular expression is too large |
| 1432 | 21 failed to get memory | 21 failed to get memory |
| 1433 | 22 unmatched parentheses | 22 unmatched parentheses |
| 1434 | 23 internal error: code overflow | 23 internal error: code overflow |
| # | Line 1259 COMPILATION ERROR CODES | Line 1437 COMPILATION ERROR CODES |
| 1437 | 26 malformed number or name after (?( | 26 malformed number or name after (?( |
| 1438 | 27 conditional group contains more than two branches | 27 conditional group contains more than two branches |
| 1439 | 28 assertion expected after (?( | 28 assertion expected after (?( |
| 1440 | 29 (?R or (?digits must be followed by ) | 29 (?R or (?[+-]digits must be followed by ) |
| 1441 | 30 unknown POSIX class name | 30 unknown POSIX class name |
| 1442 | 31 POSIX collating elements are not supported | 31 POSIX collating elements are not supported |
| 1443 | 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 1457 COMPILATION ERROR CODES |
| 1457 | 46 malformed \P or \p sequence | 46 malformed \P or \p sequence |
| 1458 | 47 unknown property name after \P or \p | 47 unknown property name after \P or \p |
| 1459 | 48 subpattern name is too long (maximum 32 characters) | 48 subpattern name is too long (maximum 32 characters) |
| 1460 | 49 too many named subpatterns (maximum 10,000) | 49 too many named subpatterns (maximum 10000) |
| 1461 | 50 repeated subpattern is too long | 50 [this code is not in use] |
| 1462 | 51 octal value is greater than \377 (not in UTF-8 mode) | 51 octal value is greater than \377 (not in UTF-8 mode) |
| 1463 | 52 internal error: overran compiling workspace | 52 internal error: overran compiling workspace |
| 1464 | 53 internal error: previously-checked referenced subpattern not | 53 internal error: previously-checked referenced subpattern not |
| 1465 | found | found |
| 1466 | 54 DEFINE group contains more than one branch | 54 DEFINE group contains more than one branch |
| 1467 | 55 repeating a DEFINE group is not allowed | 55 repeating a DEFINE group is not allowed |
| 1468 | 56 inconsistent NEWLINE options" | 56 inconsistent NEWLINE options |
| 1469 | 57 \g is not followed by a braced, angle-bracketed, or quoted | |
| 1470 | name/number or by a plain number | |
| 1471 | 58 a numbered reference must not be zero | |
| 1472 | 59 (*VERB) with an argument is not supported | |
| 1473 | 60 (*VERB) not recognized | |
| 1474 | 61 number is too big | |
| 1475 | 62 subpattern name expected | |
| 1476 | 63 digit expected after (?+ | |
| 1477 | 64 ] is an invalid data character in JavaScript compatibility mode | |
| 1478 | ||
| 1479 | The numbers 32 and 10000 in errors 48 and 49 are defaults; different | |
| 1480 | values may be used if the limits were changed when PCRE was built. | |
| 1481 | ||
| 1482 | ||
| 1483 | STUDYING A PATTERN | STUDYING A PATTERN |
| # | Line 1295 STUDYING A PATTERN | Line 1485 STUDYING A PATTERN |
| 1485 | pcre_extra *pcre_study(const pcre *code, int options | pcre_extra *pcre_study(const pcre *code, int options |
| 1486 | const char **errptr); | const char **errptr); |
| 1487 | ||
| 1488 | 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 |
| 1489 | 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 |
| 1490 | matching. The function pcre_study() takes a pointer to a compiled pat- | matching. The function pcre_study() takes a pointer to a compiled pat- |
| 1491 | tern as its first argument. If studying the pattern produces additional | tern as its first argument. If studying the pattern produces additional |
| 1492 | information that will help speed up matching, pcre_study() returns a | information that will help speed up matching, pcre_study() returns a |
| 1493 | 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 |
| 1494 | the results of the study. | the results of the study. |
| 1495 | ||
| 1496 | The returned value from pcre_study() can be passed directly to | The returned value from pcre_study() can be passed directly to |
| 1497 | pcre_exec(). However, a pcre_extra block also contains other fields | pcre_exec() or pcre_dfa_exec(). However, a pcre_extra block also con- |
| 1498 | 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 |
| 1499 | described below in the section on matching a pattern. | passed; these are described below in the section on matching a pattern. |
| 1500 | ||
| 1501 | If studying the pattern does not produce any additional information | If studying the pattern does not produce any useful information, |
| 1502 | pcre_study() returns NULL. In that circumstance, if the calling program | pcre_study() returns NULL. In that circumstance, if the calling program |
| 1503 | 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 |
| 1504 | its own pcre_extra block. | pcre_dfa_exec(), it must set up its own pcre_extra block. |
| 1505 | ||
| 1506 | The second argument of pcre_study() contains option bits. At present, | The second argument of pcre_study() contains option bits. At present, |
| 1507 | no options are defined, and this argument should always be zero. | no options are defined, and this argument should always be zero. |
| 1508 | ||
| 1509 | 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. |
| 1510 | If studying succeeds (even if no data is returned), the variable it | If studying succeeds (even if no data is returned), the variable it |
| 1511 | 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 |
| 1512 | 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 |
| 1513 | 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 |
| 1514 | after calling pcre_study(), to be sure that it has run successfully. | after calling pcre_study(), to be sure that it has run successfully. |
| 1515 | ||
| 1516 | This is a typical call to pcre_study(): | This is a typical call to pcre_study(): |
| # | Line 1331 STUDYING A PATTERN | Line 1521 STUDYING A PATTERN |
| 1521 | 0, /* no options exist */ | 0, /* no options exist */ |
| 1522 | &error); /* set to NULL or points to a message */ | &error); /* set to NULL or points to a message */ |
| 1523 | ||
| 1524 | 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 |
| 1525 | 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 |
| 1526 | ble starting bytes is created. | does not mean that there are any strings of that length that match, but |
| 1527 | it does guarantee that no shorter strings match. The value is used by | |
| 1528 | pcre_exec() and pcre_dfa_exec() to avoid wasting time by trying to | |
| 1529 | match strings that are shorter than the lower bound. You can find out | |
| 1530 | the value in a calling program via the pcre_fullinfo() function. | |
| 1531 | ||
| 1532 | Studying a pattern is also useful for non-anchored patterns that do not | |
| 1533 | have a single fixed starting character. A bitmap of possible starting | |
| 1534 | bytes is created. This speeds up finding a position in the subject at | |
| 1535 | which to start matching. | |
| 1536 | ||
| 1537 | ||
| 1538 | LOCALE SUPPORT | LOCALE SUPPORT |
| # | Line 1476 INFORMATION ABOUT A PATTERN | Line 1675 INFORMATION ABOUT A PATTERN |
| 1675 | returned. The fourth argument should point to an unsigned char * vari- | returned. The fourth argument should point to an unsigned char * vari- |
| 1676 | able. | able. |
| 1677 | ||
| 1678 | PCRE_INFO_HASCRORLF | |
| 1679 | ||
| 1680 | Return 1 if the pattern contains any explicit matches for CR or LF | |
| 1681 | characters, otherwise 0. The fourth argument should point to an int | |
| 1682 | variable. An explicit match is either a literal CR or LF character, or | |
| 1683 | \r or \n. | |
| 1684 | ||
| 1685 | PCRE_INFO_JCHANGED | PCRE_INFO_JCHANGED |
| 1686 | ||
| 1687 | 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, |
| 1688 | 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) |
| 1689 | nal option setting changes the local PCRE_DUPNAMES value. | and (?-J) set and unset the local PCRE_DUPNAMES option, respectively. |
| 1690 | ||
| 1691 | PCRE_INFO_LASTLITERAL | PCRE_INFO_LASTLITERAL |
| 1692 | ||
| 1693 | Return the value of the rightmost literal byte that must exist in any | Return the value of the rightmost literal byte that must exist in any |
| 1694 | matched string, other than at its start, if such a byte has been | matched string, other than at its start, if such a byte has been |
| 1695 | recorded. The fourth argument should point to an int variable. If there | recorded. The fourth argument should point to an int variable. If there |
| 1696 | is no such byte, -1 is returned. For anchored patterns, a last literal | is no such byte, -1 is returned. For anchored patterns, a last literal |
| 1697 | byte is recorded only if it follows something of variable length. For | byte is recorded only if it follows something of variable length. For |
| 1698 | 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 |
| 1699 | /^a\dz\d/ the returned value is -1. | /^a\dz\d/ the returned value is -1. |
| 1700 | ||
| 1701 | PCRE_INFO_MINLENGTH | |
| 1702 | ||
| 1703 | If the pattern was studied and a minimum length for matching subject | |
| 1704 | strings was computed, its value is returned. Otherwise the returned | |
| 1705 | value is -1. The value is a number of characters, not bytes (this may | |
| 1706 | be relevant in UTF-8 mode). The fourth argument should point to an int | |
| 1707 | variable. A non-negative value is a lower bound to the length of any | |
| 1708 | matching string. There may not be any strings of that length that do | |
| 1709 | actually match, but every string that does match is at least that long. | |
| 1710 | ||
| 1711 | PCRE_INFO_NAMECOUNT | PCRE_INFO_NAMECOUNT |
| 1712 | PCRE_INFO_NAMEENTRYSIZE | PCRE_INFO_NAMEENTRYSIZE |
| 1713 | PCRE_INFO_NAMETABLE | PCRE_INFO_NAMETABLE |
| 1714 | ||
| 1715 | PCRE supports the use of named as well as numbered capturing parenthe- | PCRE supports the use of named as well as numbered capturing parenthe- |
| 1716 | ses. The names are just an additional way of identifying the parenthe- | ses. The names are just an additional way of identifying the parenthe- |
| 1717 | ses, which still acquire numbers. Several convenience functions such as | ses, which still acquire numbers. Several convenience functions such as |
| 1718 | pcre_get_named_substring() are provided for extracting captured sub- | pcre_get_named_substring() are provided for extracting captured sub- |
| 1719 | strings by name. It is also possible to extract the data directly, by | strings by name. It is also possible to extract the data directly, by |
| 1720 | first converting the name to a number in order to access the correct | first converting the name to a number in order to access the correct |
| 1721 | pointers in the output vector (described with pcre_exec() below). To do | pointers in the output vector (described with pcre_exec() below). To do |
| 1722 | the conversion, you need to use the name-to-number map, which is | the conversion, you need to use the name-to-number map, which is |
| 1723 | described by these three values. | described by these three values. |
| 1724 | ||
| 1725 | The map consists of a number of fixed-size entries. PCRE_INFO_NAMECOUNT | The map consists of a number of fixed-size entries. PCRE_INFO_NAMECOUNT |
| 1726 | gives the number of entries, and PCRE_INFO_NAMEENTRYSIZE gives the size | gives the number of entries, and PCRE_INFO_NAMEENTRYSIZE gives the size |
| 1727 | of each entry; both of these return an int value. The entry size | of each entry; both of these return an int value. The entry size |
| 1728 | depends on the length of the longest name. PCRE_INFO_NAMETABLE returns | depends on the length of the longest name. PCRE_INFO_NAMETABLE returns |
| 1729 | 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 |
| 1730 | 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- |
| 1731 | 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- |
| 1732 | sponding name, zero terminated. The names are in alphabetical order. | sponding name, zero terminated. |
| 1733 | When PCRE_DUPNAMES is set, duplicate names are in order of their paren- | |
| 1734 | theses numbers. For example, consider the following pattern (assume | The names are in alphabetical order. Duplicate names may appear if (?| |
| 1735 | PCRE_EXTENDED is set, so white space - including newlines - is | is used to create multiple groups with the same number, as described in |
| 1736 | ignored): | the section on duplicate subpattern numbers in the pcrepattern page. |
| 1737 | Duplicate names for subpatterns with different numbers are permitted | |
| 1738 | only if PCRE_DUPNAMES is set. In all cases of duplicate names, they | |
| 1739 | appear in the table in the order in which they were found in the pat- | |
| 1740 | tern. In the absence of (?| this is the order of increasing number; | |
| 1741 | when (?| is used this is not necessarily the case because later subpat- | |
| 1742 | terns may have lower numbers. | |
| 1743 | ||
| 1744 | As a simple example of the name/number table, consider the following | |
| 1745 | pattern (assume PCRE_EXTENDED is set, so white space - including new- | |
| 1746 | lines - is ignored): | |
| 1747 | ||
| 1748 | (?<date> (?<year>(\d\d)?\d\d) - | (?<date> (?<year>(\d\d)?\d\d) - |
| 1749 | (?<month>\d\d) - (?<day>\d\d) ) | (?<month>\d\d) - (?<day>\d\d) ) |
| 1750 | ||
| 1751 | There are four named subpatterns, so the table has four entries, and | There are four named subpatterns, so the table has four entries, and |
| 1752 | each entry in the table is eight bytes long. The table is as follows, | each entry in the table is eight bytes long. The table is as follows, |
| 1753 | with non-printing bytes shows in hexadecimal, and undefined bytes shown | with non-printing bytes shows in hexadecimal, and undefined bytes shown |
| 1754 | as ??: | as ??: |
| 1755 | ||
| # | Line 1532 INFORMATION ABOUT A PATTERN | Line 1758 INFORMATION ABOUT A PATTERN |
| 1758 | 00 04 m o n t h 00 | 00 04 m o n t h 00 |
| 1759 | 00 02 y e a r 00 ?? | 00 02 y e a r 00 ?? |
| 1760 | ||
| 1761 | When writing code to extract data from named subpatterns using the | When writing code to extract data from named subpatterns using the |
| 1762 | name-to-number map, remember that the length of the entries is likely | name-to-number map, remember that the length of the entries is likely |
| 1763 | to be different for each compiled pattern. | to be different for each compiled pattern. |
| 1764 | ||
| 1765 | PCRE_INFO_OKPARTIAL | PCRE_INFO_OKPARTIAL |
| 1766 | ||
| 1767 | 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 |
| 1768 | The fourth argument should point to an int variable. The pcrepartial | pcre_exec(), otherwise 0. The fourth argument should point to an int |
| 1769 | documentation lists the restrictions that apply to patterns when par- | variable. From release 8.00, this always returns 1, because the |
| 1770 | tial matching is used. | restrictions that previously applied to partial matching have been |
| 1771 | lifted. The pcrepartial documentation gives details of partial match- | |
| 1772 | ing. | |
| 1773 | ||
| 1774 | PCRE_INFO_OPTIONS | PCRE_INFO_OPTIONS |
| 1775 | ||
| 1776 | 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 |
| 1777 | fourth argument should point to an unsigned long int variable. These | fourth argument should point to an unsigned long int variable. These |
| 1778 | option bits are those specified in the call to pcre_compile(), modified | option bits are those specified in the call to pcre_compile(), modified |
| 1779 | by any top-level option settings within the pattern itself. | by any top-level option settings at the start of the pattern itself. In |
| 1780 | other words, they are the options that will be in force when matching | |
| 1781 | starts. For example, if the pattern /(?im)abc(?-i)d/ is compiled with | |
| 1782 | the PCRE_EXTENDED option, the result is PCRE_CASELESS, PCRE_MULTILINE, | |
| 1783 | and PCRE_EXTENDED. | |
| 1784 | ||
| 1785 | 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 |
| 1786 | alternatives begin with one of the following: | alternatives begin with one of the following: |
| 1787 | ||
| 1788 | ^ unless PCRE_MULTILINE is set | ^ unless PCRE_MULTILINE is set |
| # | Line 1564 INFORMATION ABOUT A PATTERN | Line 1796 INFORMATION ABOUT A PATTERN |
| 1796 | ||
| 1797 | PCRE_INFO_SIZE | PCRE_INFO_SIZE |
| 1798 | ||
| 1799 | Return the size of the compiled pattern, that is, the value that was | Return the size of the compiled pattern, that is, the value that was |
| 1800 | passed as the argument to pcre_malloc() when PCRE was getting memory in | passed as the argument to pcre_malloc() when PCRE was getting memory in |
| 1801 | which to place the compiled data. The fourth argument should point to a | which to place the compiled data. The fourth argument should point to a |
| 1802 | size_t variable. | size_t variable. |
| # | Line 1572 INFORMATION ABOUT A PATTERN | Line 1804 INFORMATION ABOUT A PATTERN |
| 1804 | PCRE_INFO_STUDYSIZE | PCRE_INFO_STUDYSIZE |
| 1805 | ||
| 1806 | 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 |
| 1807 | 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 |
| 1808 | 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 |
| 1809 | 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 |
| 1810 | data, zero is returned. The fourth argument should point to a size_t | |
| 1811 | variable. | variable. |
| 1812 | ||
| 1813 | ||
| # | Line 1628 MATCHING A PATTERN: THE TRADITIONAL FUNC | Line 1861 MATCHING A PATTERN: THE TRADITIONAL FUNC |
| 1861 | const char *subject, int length, int startoffset, | const char *subject, int length, int startoffset, |
| 1862 | int options, int *ovector, int ovecsize); | int options, int *ovector, int ovecsize); |
| 1863 | ||
| 1864 | 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 |
| 1865 | compiled pattern, which is passed in the code argument. If the pattern | compiled pattern, which is passed in the code argument. If the pattern |
| 1866 | 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 |
| 1867 | argument. This function is the main matching facility of the library, | argument. This function is the main matching facility of the library, |
| 1868 | 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 |
| 1869 | an alternative matching function, which is described below in the sec- | an alternative matching function, which is described below in the sec- |
| 1870 | tion about the pcre_dfa_exec() function. | tion about the pcre_dfa_exec() function. |
| 1871 | ||
| 1872 | In most applications, the pattern will have been compiled (and option- | In most applications, the pattern will have been compiled (and option- |
| 1873 | ally studied) in the same process that calls pcre_exec(). However, it | ally studied) in the same process that calls pcre_exec(). However, it |
| 1874 | is possible to save compiled patterns and study data, and then use them | is possible to save compiled patterns and study data, and then use them |
| 1875 | later in different processes, possibly even on different hosts. For a | later in different processes, possibly even on different hosts. For a |
| 1876 | discussion about this, see the pcreprecompile documentation. | discussion about this, see the pcreprecompile documentation. |
| 1877 | ||
| 1878 | Here is an example of a simple call to pcre_exec(): | Here is an example of a simple call to pcre_exec(): |
| # | Line 1658 MATCHING A PATTERN: THE TRADITIONAL FUNC | Line 1891 MATCHING A PATTERN: THE TRADITIONAL FUNC |
| 1891 | ||
| 1892 | Extra data for pcre_exec() | Extra data for pcre_exec() |
| 1893 | ||
| 1894 | If the extra argument is not NULL, it must point to a pcre_extra data | If the extra argument is not NULL, it must point to a pcre_extra data |
| 1895 | block. The pcre_study() function returns such a block (when it doesn't | block. The pcre_study() function returns such a block (when it doesn't |
| 1896 | return NULL), but you can also create one for yourself, and pass addi- | return NULL), but you can also create one for yourself, and pass addi- |
| 1897 | tional information in it. The pcre_extra block contains the following | tional information in it. The pcre_extra block contains the following |
| 1898 | fields (not necessarily in this order): | fields (not necessarily in this order): |
| 1899 | ||
| 1900 | unsigned long int flags; | unsigned long int flags; |
| # | Line 1671 MATCHING A PATTERN: THE TRADITIONAL FUNC | Line 1904 MATCHING A PATTERN: THE TRADITIONAL FUNC |
| 1904 | void *callout_data; | void *callout_data; |
| 1905 | const unsigned char *tables; | const unsigned char *tables; |
| 1906 | ||
| 1907 | 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 |
| 1908 | are set. The flag bits are: | are set. The flag bits are: |
| 1909 | ||
| 1910 | PCRE_EXTRA_STUDY_DATA | PCRE_EXTRA_STUDY_DATA |
| # | Line 1680 MATCHING A PATTERN: THE TRADITIONAL FUNC | Line 1913 MATCHING A PATTERN: THE TRADITIONAL FUNC |
| 1913 | PCRE_EXTRA_CALLOUT_DATA | PCRE_EXTRA_CALLOUT_DATA |
| 1914 | PCRE_EXTRA_TABLES | PCRE_EXTRA_TABLES |
| 1915 | ||
| 1916 | 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 |
| 1917 | the pcre_extra block that is returned by pcre_study(), together with | the pcre_extra block that is returned by pcre_study(), together with |
| 1918 | the appropriate flag bit. You should not set this yourself, but you may | the appropriate flag bit. You should not set this yourself, but you may |
| 1919 | add to the block by setting the other fields and their corresponding | add to the block by setting the other fields and their corresponding |
| 1920 | flag bits. | flag bits. |
| 1921 | ||
| 1922 | 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 |
| 1923 | 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 |
| 1924 | match, but which have a very large number of possibilities in their | match, but which have a very large number of possibilities in their |
| 1925 | search trees. The classic example is the use of nested unlimited | search trees. The classic example is a pattern that uses nested unlim- |
| 1926 | repeats. | ited repeats. |
| 1927 | ||
| 1928 | Internally, PCRE uses a function called match() which it calls repeat- | Internally, PCRE uses a function called match() which it calls repeat- |
| 1929 | edly (sometimes recursively). The limit set by match_limit is imposed | edly (sometimes recursively). The limit set by match_limit is imposed |
| 1930 | on the number of times this function is called during a match, which | on the number of times this function is called during a match, which |
| 1931 | has the effect of limiting the amount of backtracking that can take | has the effect of limiting the amount of backtracking that can take |
| 1932 | place. For patterns that are not anchored, the count restarts from zero | place. For patterns that are not anchored, the count restarts from zero |
| 1933 | for each position in the subject string. | for each position in the subject string. |
| 1934 | ||
| 1935 | The default value for the limit can be set when PCRE is built; the | The default value for the limit can be set when PCRE is built; the |
| 1936 | default default is 10 million, which handles all but the most extreme | default default is 10 million, which handles all but the most extreme |
| 1937 | cases. You can override the default by suppling pcre_exec() with a | cases. You can override the default by suppling pcre_exec() with a |
| 1938 | pcre_extra block in which match_limit is set, and | pcre_extra block in which match_limit is set, and |
| 1939 | PCRE_EXTRA_MATCH_LIMIT is set in the flags field. If the limit is | PCRE_EXTRA_MATCH_LIMIT is set in the flags field. If the limit is |
| 1940 | exceeded, pcre_exec() returns PCRE_ERROR_MATCHLIMIT. | exceeded, pcre_exec() returns PCRE_ERROR_MATCHLIMIT. |
| 1941 | ||
| 1942 | The match_limit_recursion field is similar to match_limit, but instead | The match_limit_recursion field is similar to match_limit, but instead |
| 1943 | of limiting the total number of times that match() is called, it limits | of limiting the total number of times that match() is called, it limits |
| 1944 | the depth of recursion. The recursion depth is a smaller number than | the depth of recursion. The recursion depth is a smaller number than |
| 1945 | 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- |
| 1946 | 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. |
| 1947 | ||
| 1948 | Limiting the recursion depth limits the amount of stack that can be | Limiting the recursion depth limits the amount of stack that can be |
| # | Line 1723 MATCHING A PATTERN: THE TRADITIONAL FUNC | Line 1956 MATCHING A PATTERN: THE TRADITIONAL FUNC |
| 1956 | 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 |
| 1957 | limit is exceeded, pcre_exec() returns PCRE_ERROR_RECURSIONLIMIT. | limit is exceeded, pcre_exec() returns PCRE_ERROR_RECURSIONLIMIT. |
| 1958 | ||
| 1959 | The pcre_callout field is used in conjunction with the "callout" fea- | The callout_data field is used in conjunction with the "callout" fea- |
| 1960 | ture, which is described in the pcrecallout documentation. | ture, and is described in the pcrecallout documentation. |
| 1961 | ||
| 1962 | The tables field is used to pass a character tables pointer to | The tables field is used to pass a character tables pointer to |
| 1963 | pcre_exec(); this overrides the value that is stored with the compiled | pcre_exec(); this overrides the value that is stored with the compiled |
| # | Line 1741 MATCHING A PATTERN: THE TRADITIONAL FUNC | Line 1974 MATCHING A PATTERN: THE TRADITIONAL FUNC |
| 1974 | ||
| 1975 | 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. |
| 1976 | 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, |
| 1977 | PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NO_UTF8_CHECK and | PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NOTEMPTY_ATSTART, |
| 1978 | PCRE_PARTIAL. | PCRE_NO_START_OPTIMIZE, PCRE_NO_UTF8_CHECK, PCRE_PARTIAL_SOFT, and |
| 1979 | PCRE_PARTIAL_HARD. | |
| 1980 | ||
| 1981 | PCRE_ANCHORED | PCRE_ANCHORED |
| 1982 | ||
| 1983 | The PCRE_ANCHORED option limits pcre_exec() to matching at the first | The PCRE_ANCHORED option limits pcre_exec() to matching at the first |
| 1984 | matching position. If a pattern was compiled with PCRE_ANCHORED, or | matching position. If a pattern was compiled with PCRE_ANCHORED, or |
| 1985 | 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 |
| 1986 | unachored at matching time. | unachored at matching time. |
| 1987 | ||
| 1988 | PCRE_BSR_ANYCRLF | |
| 1989 | PCRE_BSR_UNICODE | |
| 1990 | ||
| 1991 | These options (which are mutually exclusive) control what the \R escape | |
| 1992 | sequence matches. The choice is either to match only CR, LF, or CRLF, | |
| 1993 | or to match any Unicode newline sequence. These options override the | |
| 1994 | choice that was made or defaulted when the pattern was compiled. | |
| 1995 | ||
| 1996 | PCRE_NEWLINE_CR | PCRE_NEWLINE_CR |
| 1997 | PCRE_NEWLINE_LF | PCRE_NEWLINE_LF |
| 1998 | PCRE_NEWLINE_CRLF | PCRE_NEWLINE_CRLF |
| # | Line 1762 MATCHING A PATTERN: THE TRADITIONAL FUNC | Line 2004 MATCHING A PATTERN: THE TRADITIONAL FUNC |
| 2004 | tion of pcre_compile() above. During matching, the newline choice | tion of pcre_compile() above. During matching, the newline choice |
| 2005 | affects the behaviour of the dot, circumflex, and dollar metacharac- | affects the behaviour of the dot, circumflex, and dollar metacharac- |
| 2006 | 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 |
| 2007 | match failure for an unanchored pattern. When PCRE_NEWLINE_CRLF, | match failure for an unanchored pattern. |
| 2008 | PCRE_NEWLINE_ANYCRLF, or PCRE_NEWLINE_ANY is set, and a match attempt | |
| 2009 | 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 |
| 2010 | 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- |
| 2011 | after the CRLF. | rent position is at a CRLF sequence, and the pattern contains no |
| 2012 | explicit matches for CR or LF characters, the match position is | |
| 2013 | advanced by two characters instead of one, in other words, to after the | |
| 2014 | CRLF. | |
| 2015 | ||
| 2016 | The above rule is a compromise that makes the most common cases work as | |
| 2017 | expected. For example, if the pattern is .+A (and the PCRE_DOTALL | |
| 2018 | option is not set), it does not match the string "\r\nA" because, after | |
| 2019 | failing at the start, it skips both the CR and the LF before retrying. | |
| 2020 | However, the pattern [\r\n]A does match that string, because it con- | |
| 2021 | tains an explicit CR or LF reference, and so advances only by one char- | |
| 2022 | acter after the first failure. | |
| 2023 | ||
| 2024 | An explicit match for CR of LF is either a literal appearance of one of | |
| 2025 | those characters, or one of the \r or \n escape sequences. Implicit | |
| 2026 | matches such as [^X] do not count, nor does \s (which includes CR and | |
| 2027 | LF in the characters that it matches). | |
| 2028 | ||
| 2029 | Notwithstanding the above, anomalous effects may still occur when CRLF | |
| 2030 | is a valid newline sequence and explicit \r or \n escapes appear in the | |
| 2031 | pattern. | |
| 2032 | ||
| 2033 | PCRE_NOTBOL | PCRE_NOTBOL |
| 2034 | ||
| # | Line 1794 MATCHING A PATTERN: THE TRADITIONAL FUNC | Line 2056 MATCHING A PATTERN: THE TRADITIONAL FUNC |
| 2056 | ||
| 2057 | a?b? | a?b? |
| 2058 | ||
| 2059 | 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 |
| 2060 | 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 |
| 2061 | 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- |
| 2062 | rences of "a" or "b". | rences of "a" or "b". |
| 2063 | ||
| 2064 | Perl has no direct equivalent of PCRE_NOTEMPTY, but it does make a spe- | PCRE_NOTEMPTY_ATSTART |
| 2065 | cial case of a pattern match of the empty string within its split() | |
| 2066 | 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 |
| 2067 | 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 |
| 2068 | 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. |
| 2069 | if that fails by advancing the starting offset (see below) and trying | |
| 2070 | an ordinary match again. There is some code that demonstrates how to do | Perl has no direct equivalent of PCRE_NOTEMPTY or |
| 2071 | this in the pcredemo.c sample program. | PCRE_NOTEMPTY_ATSTART, but it does make a special case of a pattern |
| 2072 | match of the empty string within its split() function, and when using | |
| 2073 | the /g modifier. It is possible to emulate Perl's behaviour after | |
| 2074 | matching a null string by first trying the match again at the same off- | |
| 2075 | set with PCRE_NOTEMPTY_ATSTART and PCRE_ANCHORED, and then if that | |
| 2076 | fails, by advancing the starting offset (see below) and trying an ordi- | |
| 2077 | nary match again. There is some code that demonstrates how to do this | |
| 2078 | in the pcredemo sample program. | |
| 2079 | ||
| 2080 | PCRE_NO_START_OPTIMIZE | |
| 2081 | ||
| 2082 | There are a number of optimizations that pcre_exec() uses at the start | |
| 2083 | of a match, in order to speed up the process. For example, if it is | |
| 2084 | known that a match must start with a specific character, it searches | |
| 2085 | the subject for that character, and fails immediately if it cannot find | |
| 2086 | it, without actually running the main matching function. When callouts | |
| 2087 | are in use, these optimizations can cause them to be skipped. This | |
| 2088 | option disables the "start-up" optimizations, causing performance to | |
| 2089 | suffer, but ensuring that the callouts do occur. | |
| 2090 | ||
| 2091 | PCRE_NO_UTF8_CHECK | PCRE_NO_UTF8_CHECK |
| 2092 | ||
| 2093 | 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 |
| 2094 | UTF-8 string is automatically checked when pcre_exec() is subsequently | UTF-8 string is automatically checked when pcre_exec() is subsequently |
| 2095 | called. The value of startoffset is also checked to ensure that it | called. The value of startoffset is also checked to ensure that it |
| 2096 | 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 |
| 2097 | 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 |
| 2098 | startoffset contains an invalid value, PCRE_ERROR_BADUTF8_OFFSET is | main pcre page. If an invalid UTF-8 sequence of bytes is found, |
| 2099 | returned. | pcre_exec() returns the error PCRE_ERROR_BADUTF8. If startoffset con- |
| 2100 | tains an invalid value, PCRE_ERROR_BADUTF8_OFFSET is returned. | |
| 2101 | If you already know that your subject is valid, and you want to skip | |
| 2102 | these checks for performance reasons, you can set the | If you already know that your subject is valid, and you want to skip |
| 2103 | PCRE_NO_UTF8_CHECK option when calling pcre_exec(). You might want to | these checks for performance reasons, you can set the |
| 2104 | 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 |
| 2105 | 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 |
| 2106 | string. However, you should be sure that the value of startoffset | making repeated calls to find all the matches in a single subject |
| 2107 | 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 |
| 2108 | 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 |
| 2109 | 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 |
| 2110 | value of startoffset that does not point to the start of a UTF-8 char- | |
| 2111 | acter, is undefined. Your program may crash. | acter, is undefined. Your program may crash. |
| 2112 | ||
| 2113 | PCRE_PARTIAL | PCRE_PARTIAL_HARD |
| 2114 | PCRE_PARTIAL_SOFT | |
| 2115 | ||
| 2116 | This option turns on the partial matching feature. If the subject | These options turn on the partial matching feature. For backwards com- |
| 2117 | 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 |
| 2118 | 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, |
| 2119 | partially matches the pattern and the failure to match occurred only | but there are not enough subject characters to complete the match. If |
| 2120 | because there were not enough subject characters), pcre_exec() returns | this happens when PCRE_PARTIAL_HARD is set, pcre_exec() immediately |
| 2121 | PCRE_ERROR_PARTIAL instead of PCRE_ERROR_NOMATCH. When PCRE_PARTIAL is | returns PCRE_ERROR_PARTIAL. Otherwise, if PCRE_PARTIAL_SOFT is set, |
| 2122 | used, there are restrictions on what may appear in the pattern. These | matching continues by testing any other alternatives. Only if they all |
| 2123 | are discussed in the pcrepartial documentation. | fail is PCRE_ERROR_PARTIAL returned (instead of PCRE_ERROR_NOMATCH). |
| 2124 | The portion of the string that was inspected when the partial match was | |
| 2125 | found is set as the first matching string. There is a more detailed | |
| 2126 | discussion in the pcrepartial documentation. | |
| 2127 | ||
| 2128 | The string to be matched by pcre_exec() | The string to be matched by pcre_exec() |
| 2129 | ||
| 2130 | 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 |
| 2131 | 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. |
| 2132 | 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- |
| 2133 | Unlike the pattern string, the subject may contain binary zero bytes. | acter. Unlike the pattern string, the subject may contain binary zero |
| 2134 | 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 |
| 2135 | 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 |
| 2136 | case. | |
| 2137 | A non-zero starting offset is useful when searching for another match | |
| 2138 | 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 |
| 2139 | cess. Setting startoffset differs from just passing over a shortened | in the same subject by calling pcre_exec() again after a previous suc- |
| 2140 | string and setting PCRE_NOTBOL in the case of a pattern that begins | cess. Setting startoffset differs from just passing over a shortened |
| 2141 | string and setting PCRE_NOTBOL in the case of a pattern that begins | |
| 2142 | with any kind of lookbehind. For example, consider the pattern | with any kind of lookbehind. For example, consider the pattern |
| 2143 | ||
| 2144 | \Biss\B | \Biss\B |
| 2145 | ||
| 2146 | which finds occurrences of "iss" in the middle of words. (\B matches | which finds occurrences of "iss" in the middle of words. (\B matches |
| 2147 | 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.) |
| 2148 | When applied to the string "Mississipi" the first call to pcre_exec() | When applied to the string "Mississipi" the first call to pcre_exec() |
| 2149 | finds the first occurrence. If pcre_exec() is called again with just | finds the first occurrence. If pcre_exec() is called again with just |
| 2150 | the remainder of the subject, namely "issipi", it does not match, | the remainder of the subject, namely "issipi", it does not match, |
| 2151 | 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 |
| 2152 | 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 |
| 2153 | 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- |
| 2154 | 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 |
| 2155 | discover that it is preceded by a letter. | discover that it is preceded by a letter. |
| 2156 | ||
| 2157 | 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, |
| 2158 | 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 |
| 2159 | 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 |
| 2160 | subject. | subject. |
| 2161 | ||
| 2162 | How pcre_exec() returns captured substrings | How pcre_exec() returns captured substrings |
| 2163 | ||
| 2164 | 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 |
| 2165 | addition, further substrings from the subject may be picked out by | addition, further substrings from the subject may be picked out by |
| 2166 | parts of the pattern. Following the usage in Jeffrey Friedl's book, | parts of the pattern. Following the usage in Jeffrey Friedl's book, |
| 2167 | this is called "capturing" in what follows, and the phrase "capturing | this is called "capturing" in what follows, and the phrase "capturing |
| 2168 | 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- |
| 2169 | string. PCRE supports several other kinds of parenthesized subpattern | string. PCRE supports several other kinds of parenthesized subpattern |
| 2170 | that do not cause substrings to be captured. | that do not cause substrings to be captured. |
| 2171 | ||
| 2172 | Captured substrings are returned to the caller via a vector of integer | Captured substrings are returned to the caller via a vector of integers |
| 2173 | 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- |
| 2174 | 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: |
| 2175 | Note: this argument is NOT the size of ovector in bytes. | this argument is NOT the size of ovector in bytes. |
| 2176 | ||
| 2177 | 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- |
| 2178 | strings, each substring using a pair of integers. The remaining third | strings, each substring using a pair of integers. The remaining third |
| 2179 | 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- |
| 2180 | turing subpatterns, and is not available for passing back information. | turing subpatterns, and is not available for passing back information. |
| 2181 | 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 |
| 2182 | it is not, it is rounded down. | it is not, it is rounded down. |
| 2183 | ||
| 2184 | When a match is successful, information about captured substrings is | When a match is successful, information about captured substrings is |
| 2185 | returned in pairs of integers, starting at the beginning of ovector, | returned in pairs of integers, starting at the beginning of ovector, |
| 2186 | 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 |
| 2187 | 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 |
| 2188 | 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 |
| 2189 | 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 |
| 2190 | tor[1], identify the portion of the subject string matched by the | byte offsets, even in UTF-8 mode. They are not character counts. |
| 2191 | entire pattern. The next pair is used for the first capturing subpat- | |
| 2192 | 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 |
| 2193 | highest numbered pair that has been set. For example, if two substrings | portion of the subject string matched by the entire pattern. The next |
| 2194 | 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 |
| 2195 | subpatterns, the return value from a successful match is 1, indicating | returned by pcre_exec() is one more than the highest numbered pair that |
| 2196 | that just the first pair of offsets has been set. | has been set. For example, if two substrings have been captured, the |
| 2197 | returned value is 3. If there are no capturing subpatterns, the return | |
| 2198 | value from a successful match is 1, indicating that just the first pair | |
| 2199 | of offsets has been set. | |
| 2200 | ||
| 2201 | If a capturing subpattern is matched repeatedly, it is the last portion | If a capturing subpattern is matched repeatedly, it is the last portion |
| 2202 | of the string that it matched that is returned. | of the string that it matched that is returned. |
| 2203 | ||
| 2204 | 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, |
| 2205 | 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 |
| 2206 | 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 |
| 2207 | 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 |
| 2208 | as NULL and ovecsize as zero. However, if the pattern contains back | ovecsize as zero. However, if the pattern contains back references and |
| 2209 | references and the ovector is not big enough to remember the related | the ovector is not big enough to remember the related substrings, PCRE |
| 2210 | substrings, PCRE has to get additional memory for use during matching. | has to get additional memory for use during matching. Thus it is usu- |
| 2211 | Thus it is usually advisable to supply an ovector. | ally advisable to supply an ovector. |
| 2212 | ||
| 2213 | 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 |
| 2214 | subpatterns there are in a compiled pattern. The smallest size for | subpatterns there are in a compiled pattern. The smallest size for |
| 2215 | ovector that will allow for n captured substrings, in addition to the | ovector that will allow for n captured substrings, in addition to the |
| 2216 | 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 2020 MATCHING A PATTERN: THE TRADITIONAL FUNC | Line 2309 MATCHING A PATTERN: THE TRADITIONAL FUNC |
| 2309 | ||
| 2310 | PCRE_ERROR_BADPARTIAL (-13) | PCRE_ERROR_BADPARTIAL (-13) |
| 2311 | ||
| 2312 | The PCRE_PARTIAL option was used with a compiled pattern containing | This code is no longer in use. It was formerly returned when the |
| 2313 | items that are not supported for partial matching. See the pcrepartial | PCRE_PARTIAL option was used with a compiled pattern containing items |
| 2314 | documentation for details of partial matching. | that were not supported for partial matching. From release 8.00 |
| 2315 | onwards, there are no restrictions on partial matching. | |
| 2316 | ||
| 2317 | PCRE_ERROR_INTERNAL (-14) | PCRE_ERROR_INTERNAL (-14) |
| 2318 | ||
| 2319 | An unexpected internal error has occurred. This error could be caused | An unexpected internal error has occurred. This error could be caused |
| 2320 | by a bug in PCRE or by overwriting of the compiled pattern. | by a bug in PCRE or by overwriting of the compiled pattern. |
| 2321 | ||
| 2322 | PCRE_ERROR_BADCOUNT (-15) | PCRE_ERROR_BADCOUNT (-15) |
| 2323 | ||
| 2324 | 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. |
| 2325 | ||
| 2326 | PCRE_ERROR_RECURSIONLIMIT (-21) | PCRE_ERROR_RECURSIONLIMIT (-21) |
| 2327 | ||
| # | Line 2039 MATCHING A PATTERN: THE TRADITIONAL FUNC | Line 2329 MATCHING A PATTERN: THE TRADITIONAL FUNC |
| 2329 | field in a pcre_extra structure (or defaulted) was reached. See the | field in a pcre_extra structure (or defaulted) was reached. See the |
| 2330 | description above. | description above. |
| 2331 | ||
| 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. | ||
| 2332 | PCRE_ERROR_BADNEWLINE (-23) | PCRE_ERROR_BADNEWLINE (-23) |
| 2333 | ||
| 2334 | An invalid combination of PCRE_NEWLINE_xxx options was given. | An invalid combination of PCRE_NEWLINE_xxx options was given. |
| 2335 | ||
| 2336 | Error numbers -16 to -20 are not used by pcre_exec(). | Error numbers -16 to -20 and -22 are not used by pcre_exec(). |
| 2337 | ||
| 2338 | ||
| 2339 | EXTRACTING CAPTURED SUBSTRINGS BY NUMBER | EXTRACTING CAPTURED SUBSTRINGS BY NUMBER |
| # | Line 2189 EXTRACTING CAPTURED SUBSTRINGS BY NAME | Line 2471 EXTRACTING CAPTURED SUBSTRINGS BY NAME |
| 2471 | 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 |
| 2472 | behaviour may not be what you want (see the next section). | behaviour may not be what you want (see the next section). |
| 2473 | ||
| 2474 | Warning: If the pattern uses the (?| feature to set up multiple subpat- | |
| 2475 | terns with the same number, as described in the section on duplicate | |
| 2476 | subpattern numbers in the pcrepattern page, you cannot use names to | |
| 2477 | distinguish the different subpatterns, because names are not included | |
| 2478 | in the compiled code. The matching process uses only numbers. For this | |
| 2479 | reason, the use of different names for subpatterns of the same number | |
| 2480 | causes an error at compile time. | |
| 2481 | ||
| 2482 | ||
| 2483 | DUPLICATE SUBPATTERN NAMES | DUPLICATE SUBPATTERN NAMES |
| 2484 | ||
| # | Line 2196 DUPLICATE SUBPATTERN NAMES | Line 2486 DUPLICATE SUBPATTERN NAMES |
| 2486 | const char *name, char **first, char **last); | const char *name, char **first, char **last); |
| 2487 | ||
| 2488 | When a pattern is compiled with the PCRE_DUPNAMES option, names for | When a pattern is compiled with the PCRE_DUPNAMES option, names for |
| 2489 | subpatterns are not required to be unique. Normally, patterns with | subpatterns are not required to be unique. (Duplicate names are always |
| 2490 | 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 (?| |
| 2491 | subpatterns participates. An example is shown in the pcrepattern docu- | feature. Indeed, if such subpatterns are named, they are required to |
| 2492 | mentation. When duplicates are present, pcre_copy_named_substring() and | use the same names.) |
| 2493 | ||
| 2494 | Normally, patterns with duplicate names are such that in any one match, | |
| 2495 | only one of the named subpatterns participates. An example is shown in | |
| 2496 | the pcrepattern documentation. | |
| 2497 | ||
| 2498 | When duplicates are present, pcre_copy_named_substring() and | |
| 2499 | pcre_get_named_substring() return the first substring corresponding to | pcre_get_named_substring() return the first substring corresponding to |
| 2500 | 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 |
| 2501 | returned. The pcre_get_stringnumber() function returns one of the num- | (-7) is returned; no data is returned. The pcre_get_stringnumber() |
| 2502 | 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, |
| 2503 | is. | but it is not defined which it is. |
| 2504 | ||
| 2505 | 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 |
| 2506 | 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 2546 MATCHING A PATTERN: THE ALTERNATIVE FUNC |
| 2546 | characteristics to the normal algorithm, and is not compatible with | characteristics to the normal algorithm, and is not compatible with |
| 2547 | Perl. Some of the features of PCRE patterns are not supported. Never- | Perl. Some of the features of PCRE patterns are not supported. Never- |
| 2548 | 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 |
| 2549 | a discussion of the two matching algorithms, see the pcrematching docu- | a discussion of the two matching algorithms, and a list of features |
| 2550 | mentation. | that pcre_dfa_exec() does not support, see the pcrematching documenta- |
| 2551 | tion. | |
| 2552 | ||
| 2553 | 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 |
| 2554 | 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- |
| 2555 | ent way, and this is described below. The other common arguments are | ent way, and this is described below. The other common arguments are |
| 2556 | 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 |
| 2557 | repeated here. | repeated here. |
| 2558 | ||
| 2559 | The two additional arguments provide workspace for the function. The | The two additional arguments provide workspace for the function. The |
| 2560 | workspace vector should contain at least 20 elements. It is used for | workspace vector should contain at least 20 elements. It is used for |
| 2561 | keeping track of multiple paths through the pattern tree. More | keeping track of multiple paths through the pattern tree. More |
| 2562 | workspace will be needed for patterns and subjects where there are a | workspace will be needed for patterns and subjects where there are a |
| 2563 | lot of potential matches. | lot of potential matches. |
| 2564 | ||
| 2565 | 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 2581 MATCHING A PATTERN: THE ALTERNATIVE FUNC |
| 2581 | ||
| 2582 | Option bits for pcre_dfa_exec() | Option bits for pcre_dfa_exec() |
| 2583 | ||
| 2584 | 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 |
| 2585 | 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- |
| 2586 | LINE_xxx, PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NO_UTF8_CHECK, | LINE_xxx, PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, |
| 2587 | PCRE_PARTIAL, PCRE_DFA_SHORTEST, and PCRE_DFA_RESTART. All but the last | PCRE_NOTEMPTY_ATSTART, PCRE_NO_UTF8_CHECK, PCRE_PARTIAL_HARD, PCRE_PAR- |
| 2588 | three of these are the same as for pcre_exec(), so their description is | TIAL_SOFT, PCRE_DFA_SHORTEST, and PCRE_DFA_RESTART. All but the last |
| 2589 | not repeated here. | four of these are exactly the same as for pcre_exec(), so their |
| 2590 | description is not repeated here. | |
| 2591 | PCRE_PARTIAL | |
| 2592 | PCRE_PARTIAL_HARD | |
| 2593 | This has the same general effect as it does for pcre_exec(), but the | PCRE_PARTIAL_SOFT |
| 2594 | details are slightly different. When PCRE_PARTIAL is set for | |
| 2595 | pcre_dfa_exec(), the return code PCRE_ERROR_NOMATCH is converted into | These have the same general effect as they do for pcre_exec(), but the |
| 2596 | PCRE_ERROR_PARTIAL if the end of the subject is reached, there have | details are slightly different. When PCRE_PARTIAL_HARD is set for |
| 2597 | been no complete matches, but there is still at least one matching pos- | pcre_dfa_exec(), it returns PCRE_ERROR_PARTIAL if the end of the sub- |
| 2598 | sibility. The portion of the string that provided the partial match is | ject is reached and there is still at least one matching possibility |
| 2599 | set as the first matching string. | that requires additional characters. This happens even if some complete |
| 2600 | matches have also been found. When PCRE_PARTIAL_SOFT is set, the return | |
| 2601 | code PCRE_ERROR_NOMATCH is converted into PCRE_ERROR_PARTIAL if the end | |
| 2602 | of the subject is reached, there have been no complete matches, but | |
| 2603 | there is still at least one matching possibility. The portion of the | |
| 2604 | string that was inspected when the longest partial match was found is | |
| 2605 | set as the first matching string in both cases. | |
| 2606 | ||
| 2607 | PCRE_DFA_SHORTEST | PCRE_DFA_SHORTEST |
| 2608 | ||
| # | Line 2310 MATCHING A PATTERN: THE ALTERNATIVE FUNC | Line 2613 MATCHING A PATTERN: THE ALTERNATIVE FUNC |
| 2613 | ||
| 2614 | PCRE_DFA_RESTART | PCRE_DFA_RESTART |
| 2615 | ||
| 2616 | 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 |
| 2617 | returns a partial match, it is possible to call it again, with addi- | again, with additional subject characters, and have it continue with |
| 2618 | tional subject characters, and have it continue with the same match. | the same match. The PCRE_DFA_RESTART option requests this action; when |
| 2619 | 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 |
| 2620 | 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 |
| 2621 | 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 |
| 2622 | match. There is more discussion of this facility in the pcrepartial | pcrepartial documentation. |
| documentation. | ||
| 2623 | ||
| 2624 | Successful returns from pcre_dfa_exec() | Successful returns from pcre_dfa_exec() |
| 2625 | ||
| 2626 | When pcre_dfa_exec() succeeds, it may have matched more than one sub- | When pcre_dfa_exec() succeeds, it may have matched more than one sub- |
| 2627 | string in the subject. Note, however, that all the matches from one run | string in the subject. Note, however, that all the matches from one run |
| 2628 | of the function start at the same point in the subject. The shorter | of the function start at the same point in the subject. The shorter |
| 2629 | matches are all initial substrings of the longer matches. For example, | matches are all initial substrings of the longer matches. For example, |
| 2630 | if the pattern | if the pattern |
| 2631 | ||
| 2632 | <.*> | <.*> |
| # | Line 2339 MATCHING A PATTERN: THE ALTERNATIVE FUNC | Line 2641 MATCHING A PATTERN: THE ALTERNATIVE FUNC |
| 2641 | <something> <something else> | <something> <something else> |
| 2642 | <something> <something else> <something further> | <something> <something else> <something further> |
| 2643 | ||
| 2644 | On success, the yield of the function is a number greater than zero, | On success, the yield of the function is a number greater than zero, |
| 2645 | which is the number of matched substrings. The substrings themselves | which is the number of matched substrings. The substrings themselves |
| 2646 | are returned in ovector. Each string uses two elements; the first is | are returned in ovector. Each string uses two elements; the first is |
| 2647 | the offset to the start, and the second is the offset to the end. In | the offset to the start, and the second is the offset to the end. In |
| 2648 | fact, all the strings have the same start offset. (Space could have | fact, all the strings have the same start offset. (Space could have |
| 2649 | been saved by giving this only once, but it was decided to retain some | been saved by giving this only once, but it was decided to retain some |
| 2650 | compatibility with the way pcre_exec() returns data, even though the | compatibility with the way pcre_exec() returns data, even though the |
| 2651 | meaning of the strings is different.) | meaning of the strings is different.) |
| 2652 | ||
| 2653 | The strings are returned in reverse order of length; that is, the long- | The strings are returned in reverse order of length; that is, the long- |
| 2654 | est matching string is given first. If there were too many matches to | est matching string is given first. If there were too many matches to |
| 2655 | fit into ovector, the yield of the function is zero, and the vector is | fit into ovector, the yield of the function is zero, and the vector is |
| 2656 | filled with the longest matches. | filled with the longest matches. |
| 2657 | ||
| 2658 | Error returns from pcre_dfa_exec() | Error returns from pcre_dfa_exec() |
| 2659 | ||
| 2660 | The pcre_dfa_exec() function returns a negative number when it fails. | The pcre_dfa_exec() function returns a negative number when it fails. |
| 2661 | Many of the errors are the same as for pcre_exec(), and these are | Many of the errors are the same as for pcre_exec(), and these are |
| 2662 | described above. There are in addition the following errors that are | described above. There are in addition the following errors that are |
| 2663 | specific to pcre_dfa_exec(): | specific to pcre_dfa_exec(): |
| 2664 | ||
| 2665 | PCRE_ERROR_DFA_UITEM (-16) | PCRE_ERROR_DFA_UITEM (-16) |
| 2666 | ||
| 2667 | This return is given if pcre_dfa_exec() encounters an item in the pat- | This return is given if pcre_dfa_exec() encounters an item in the pat- |
| 2668 | tern that it does not support, for instance, the use of \C or a back | tern that it does not support, for instance, the use of \C or a back |
| 2669 | reference. | reference. |
| 2670 | ||
| 2671 | PCRE_ERROR_DFA_UCOND (-17) | PCRE_ERROR_DFA_UCOND (-17) |
| 2672 | ||
| 2673 | This return is given if pcre_dfa_exec() encounters a condition item | This return is given if pcre_dfa_exec() encounters a condition item |
| 2674 | that uses a back reference for the condition, or a test for recursion | that uses a back reference for the condition, or a test for recursion |
| 2675 | in a specific group. These are not supported. | in a specific group. These are not supported. |
| 2676 | ||
| 2677 | PCRE_ERROR_DFA_UMLIMIT (-18) | PCRE_ERROR_DFA_UMLIMIT (-18) |
| 2678 | ||
| 2679 | This return is given if pcre_dfa_exec() is called with an extra block | This return is given if pcre_dfa_exec() is called with an extra block |
| 2680 | that contains a setting of the match_limit field. This is not supported | that contains a setting of the match_limit field. This is not supported |
| 2681 | (it is meaningless). | (it is meaningless). |
| 2682 | ||
| 2683 | PCRE_ERROR_DFA_WSSIZE (-19) | PCRE_ERROR_DFA_WSSIZE (-19) |
| 2684 | ||
| 2685 | This return is given if pcre_dfa_exec() runs out of space in the | This return is given if pcre_dfa_exec() runs out of space in the |
| 2686 | workspace vector. | workspace vector. |
| 2687 | ||
| 2688 | PCRE_ERROR_DFA_RECURSE (-20) | PCRE_ERROR_DFA_RECURSE (-20) |
| 2689 | ||
| 2690 | When a recursive subpattern is processed, the matching function calls | When a recursive subpattern is processed, the matching function calls |
| 2691 | itself recursively, using private vectors for ovector and workspace. | itself recursively, using private vectors for ovector and workspace. |
| 2692 | This error is given if the output vector is not large enough. This | This error is given if the output vector is not large enough. This |
| 2693 | should be extremely rare, as a vector of size 1000 is used. | should be extremely rare, as a vector of size 1000 is used. |
| 2694 | ||
| 2695 | ||
| 2696 | SEE ALSO | SEE ALSO |
| 2697 | ||
| 2698 | pcrebuild(3), pcrecallout(3), pcrecpp(3)(3), pcrematching(3), pcrepar- | pcrebuild(3), pcrecallout(3), pcrecpp(3)(3), pcrematching(3), pcrepar- |
| 2699 | tial(3), pcreposix(3), pcreprecompile(3), pcresample(3), pcrestack(3). | tial(3), pcreposix(3), pcreprecompile(3), pcresample(3), pcrestack(3). |
| 2700 | ||
| 2701 | ||
| 2702 | AUTHOR | AUTHOR |
| # | Line 2406 AUTHOR | Line 2708 AUTHOR |
| 2708 | ||
| 2709 | REVISION | REVISION |
| 2710 | ||
| 2711 | Last updated: 04 June 2007 | Last updated: 03 October 2009 |
| 2712 | Copyright (c) 1997-2007 University of Cambridge. | Copyright (c) 1997-2009 University of Cambridge. |
| 2713 | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
| 2714 | ||
| 2715 | ||
| # | Line 2436 PCRE CALLOUTS | Line 2738 PCRE CALLOUTS |
| 2738 | ||
| 2739 | (?C1)abc(?C2)def | (?C1)abc(?C2)def |
| 2740 | ||
| 2741 | 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 |
| 2742 | called, PCRE automatically inserts callouts, all with number 255, | pcre_compile2() is called, PCRE automatically inserts callouts, all |
| 2743 | 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 |
| 2744 | used with the pattern | PCRE_AUTO_CALLOUT is used with the pattern |
| 2745 | ||
| 2746 | A(\d{2}|--) | A(\d{2}|--) |
| 2747 | ||
| # | Line 2458 PCRE CALLOUTS | Line 2760 PCRE CALLOUTS |
| 2760 | MISSING CALLOUTS | MISSING CALLOUTS |
| 2761 | ||
| 2762 | You should be aware that, because of optimizations in the way PCRE | You should be aware that, because of optimizations in the way PCRE |
| 2763 | matches patterns, callouts sometimes do not happen. For example, if the | matches patterns by default, callouts sometimes do not happen. For |
| 2764 | pattern is | example, if the pattern is |
| 2765 | ||
| 2766 | ab(?C4)cd | ab(?C4)cd |
| 2767 | ||
| # | Line 2468 MISSING CALLOUTS | Line 2770 MISSING CALLOUTS |
| 2770 | ever start, and the callout is never reached. However, with "abyd", | ever start, and the callout is never reached. However, with "abyd", |
| 2771 | though the result is still no match, the callout is obeyed. | though the result is still no match, the callout is obeyed. |
| 2772 | ||
| 2773 | If the pattern is studied, PCRE knows the minimum length of a matching | |
| 2774 | string, and will immediately give a "no match" return without actually | |
| 2775 | running a match if the subject is not long enough, or, for unanchored | |
| 2776 | patterns, if it has been scanned far enough. | |
| 2777 | ||
| 2778 | You can disable these optimizations by passing the PCRE_NO_START_OPTI- | |
| 2779 | MIZE option to pcre_exec() or pcre_dfa_exec(). This slows down the | |
| 2780 | matching process, but does ensure that callouts such as the example | |
| 2781 | above are obeyed. | |
| 2782 | ||
| 2783 | ||
| 2784 | THE CALLOUT INTERFACE | THE CALLOUT INTERFACE |
| 2785 | ||
| # | Line 2495 THE CALLOUT INTERFACE | Line 2807 THE CALLOUT INTERFACE |
| 2807 | version number will change again in future if additional fields are | version number will change again in future if additional fields are |
| 2808 | 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. |
| 2809 | ||
| 2810 | The callout_number field contains the number of the callout, as com- | The callout_number field contains the number of the callout, as com- |
| 2811 | 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- |
| 2812 | outs, and 255 for automatically generated callouts). | outs, and 255 for automatically generated callouts). |
| 2813 | ||
| 2814 | 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 |
| 2815 | passed by the caller to pcre_exec() or pcre_dfa_exec(). When | passed by the caller to pcre_exec() or pcre_dfa_exec(). When |
| 2816 | 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 |
| 2817 | 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 |
| 2818 | extracting substrings after a match has completed. For pcre_dfa_exec() | extracting substrings after a match has completed. For pcre_dfa_exec() |
| 2819 | this field is not useful. | this field is not useful. |
| 2820 | ||
| 2821 | The subject and subject_length fields contain copies of the values that | The subject and subject_length fields contain copies of the values that |
| 2822 | were passed to pcre_exec(). | were passed to pcre_exec(). |
| 2823 | ||
| 2824 | The start_match field normally contains the offset within the subject | The start_match field normally contains the offset within the subject |
| 2825 | at which the current match attempt started. However, if the escape | at which the current match attempt started. However, if the escape |
| 2826 | sequence \K has been encountered, this value is changed to reflect the | sequence \K has been encountered, this value is changed to reflect the |
| 2827 | modified starting point. If the pattern is not anchored, the callout | modified starting point. If the pattern is not anchored, the callout |
| 2828 | 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 |
| 2829 | for different starting points in the subject. | for different starting points in the subject. |
| 2830 | ||
| 2831 | The current_position field contains the offset within the subject of | The current_position field contains the offset within the subject of |
| 2832 | the current match pointer. | the current match pointer. |
| 2833 | ||
| 2834 | When the pcre_exec() function is used, the capture_top field contains | When the pcre_exec() function is used, the capture_top field contains |
| 2835 | one more than the number of the highest numbered captured substring so | one more than the number of the highest numbered captured substring so |
| 2836 | 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 |
| 2837 | 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 |
| 2838 | does not support captured substrings. | does not support captured substrings. |
| 2839 | ||
| 2840 | The capture_last field contains the number of the most recently cap- | The capture_last field contains the number of the most recently cap- |
| 2841 | tured substring. If no substrings have been captured, its value is -1. | tured substring. If no substrings have been captured, its value is -1. |
| 2842 | This is always the case when pcre_dfa_exec() is used. | This is always the case when pcre_dfa_exec() is used. |
| 2843 | ||
| 2844 | 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() |
| 2845 | 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- |
| 2846 | 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 |
| 2847 | 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 |
| 2848 | 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 |
| 2849 | structure in the pcreapi documentation. | structure in the pcreapi documentation. |
| 2850 | ||
| 2851 | 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- |
| 2852 | 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 |
| 2853 | the pattern string. | the pattern string. |
| 2854 | ||
| 2855 | 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- |
| 2856 | 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 |
| 2857 | the pattern string. When the callout immediately precedes an alterna- | the pattern string. When the callout immediately precedes an alterna- |
| 2858 | 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 |
| 2859 | is zero. When the callout precedes an opening parenthesis, the length | is zero. When the callout precedes an opening parenthesis, the length |
| 2860 | is that of the entire subpattern. | is that of the entire subpattern. |
| 2861 | ||
| 2862 | The pattern_position and next_item_length fields are intended to help | The pattern_position and next_item_length fields are intended to help |
| 2863 | in distinguishing between different automatic callouts, which all have | in distinguishing between different automatic callouts, which all have |
| 2864 | the same callout number. However, they are set for all callouts. | the same callout number. However, they are set for all callouts. |
| 2865 | ||
| 2866 | ||
| 2867 | RETURN VALUES | RETURN VALUES |
| 2868 | ||
| 2869 | The external callout function returns an integer to PCRE. If the value | The external callout function returns an integer to PCRE. If the value |
| 2870 | is zero, matching proceeds as normal. If the value is greater than | is zero, matching proceeds as normal. If the value is greater than |
| 2871 | zero, matching fails at the current point, but the testing of other | zero, matching fails at the current point, but the testing of other |
| 2872 | matching possibilities goes ahead, just as if a lookahead assertion had | matching possibilities goes ahead, just as if a lookahead assertion had |
| 2873 | 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 |
| 2874 | pcre_exec() (or pcre_dfa_exec()) returns the negative value. | pcre_exec() or pcre_dfa_exec() returns the negative value. |
| 2875 | ||
| 2876 | Negative values should normally be chosen from the set of | Negative values should normally be chosen from the set of |
| 2877 | PCRE_ERROR_xxx values. In particular, PCRE_ERROR_NOMATCH forces a stan- | PCRE_ERROR_xxx values. In particular, PCRE_ERROR_NOMATCH forces a stan- |
| 2878 | dard "no match" failure. The error number PCRE_ERROR_CALLOUT is | dard "no match" failure. The error number PCRE_ERROR_CALLOUT is |
| 2879 | 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 |
| 2880 | itself. | itself. |
| 2881 | ||
| 2882 | ||
| # | Line 2577 AUTHOR | Line 2889 AUTHOR |
| 2889 | ||
| 2890 | REVISION | REVISION |
| 2891 | ||
| 2892 | Last updated: 29 May 2007 | Last updated: 29 September 2009 |
| 2893 | Copyright (c) 1997-2007 University of Cambridge. | Copyright (c) 1997-2009 University of Cambridge. |
| 2894 | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
| 2895 | ||
| 2896 | ||
| # | Line 2592 NAME | Line 2904 NAME |
| 2904 | DIFFERENCES BETWEEN PCRE AND PERL | DIFFERENCES BETWEEN PCRE AND PERL |
| 2905 | ||
| 2906 | This document describes the differences in the ways that PCRE and Perl | This document describes the differences in the ways that PCRE and Perl |
| 2907 | handle regular expressions. The differences described here are mainly | handle regular expressions. The differences described here are with |
| 2908 | with respect to Perl 5.8, though PCRE version 7.0 contains some fea- | respect to Perl 5.10. |
| tures that are expected to be in the forthcoming Perl 5.10. | ||
| 2909 | ||
| 2910 | 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 |
| 2911 | 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 |
| 2912 | main pcre page. | main pcre page. |
| 2913 | ||
| 2914 | 2. PCRE does not allow repeat quantifiers on lookahead assertions. Perl | 2. PCRE does not allow repeat quantifiers on lookahead assertions. Perl |
| 2915 | 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, |
| 2916 | (?!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 |
| 2917 | just asserts that the next character is not "a" three times. | just asserts that the next character is not "a" three times. |
| 2918 | ||
| 2919 | 3. Capturing subpatterns that occur inside negative lookahead asser- | 3. Capturing subpatterns that occur inside negative lookahead asser- |
| 2920 | tions are counted, but their entries in the offsets vector are never | tions are counted, but their entries in the offsets vector are never |
| 2921 | set. Perl sets its numerical variables from any such patterns that are | set. Perl sets its numerical variables from any such patterns that are |
| 2922 | matched before the assertion fails to match something (thereby succeed- | matched before the assertion fails to match something (thereby succeed- |
| 2923 | ing), but only if the negative lookahead assertion contains just one | ing), but only if the negative lookahead assertion contains just one |
| 2924 | branch. | branch. |
| 2925 | ||
| 2926 | 4. Though binary zero characters are supported in the subject string, | 4. Though binary zero characters are supported in the subject string, |
| 2927 | 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- |
| 2928 | 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 |
| 2929 | the pattern to represent a binary zero. | the pattern to represent a binary zero. |
| 2930 | ||
| 2931 | 5. The following Perl escape sequences are not supported: \l, \u, \L, | 5. The following Perl escape sequences are not supported: \l, \u, \L, |
| 2932 | \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- |
| 2933 | 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 |
| 2934 | are encountered by PCRE, an error is generated. | are encountered by PCRE, an error is generated. |
| 2935 | ||
| 2936 | 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 |
| 2937 | is built with Unicode character property support. The properties that | is built with Unicode character property support. The properties that |
| 2938 | 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- |
| 2939 | 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 |
| 2940 | derived properties Any and L&. | derived properties Any and L&. PCRE does support the Cs (surrogate) |
| 2941 | property, which Perl does not; the Perl documentation says "Because | |
| 2942 | Perl hides the need for the user to understand the internal representa- | |
| 2943 | tion of Unicode characters, there is no need to implement the somewhat | |
| 2944 | messy concept of surrogates." | |
| 2945 | ||
| 2946 | 7. PCRE does support the \Q...\E escape for quoting substrings. Charac- | 7. PCRE does support the \Q...\E escape for quoting substrings. Charac- |
| 2947 | ters in between are treated as literals. This is slightly different | ters in between are treated as literals. This is slightly different |
| 2948 | from Perl in that $ and @ are also handled as literals inside the | from Perl in that $ and @ are also handled as literals inside the |
| 2949 | quotes. In Perl, they cause variable interpolation (but of course PCRE | quotes. In Perl, they cause variable interpolation (but of course PCRE |
| 2950 | does not have variables). Note the following examples: | does not have variables). Note the following examples: |
| 2951 | ||
| 2952 | Pattern PCRE matches Perl matches | Pattern PCRE matches Perl matches |
| # | Line 2641 DIFFERENCES BETWEEN PCRE AND PERL | Line 2956 DIFFERENCES BETWEEN PCRE AND PERL |
| 2956 | \Qabc\$xyz\E abc\$xyz abc\$xyz | \Qabc\$xyz\E abc\$xyz abc\$xyz |
| 2957 | \Qabc\E\$\Qxyz\E abc$xyz abc$xyz | \Qabc\E\$\Qxyz\E abc$xyz abc$xyz |
| 2958 | ||
| 2959 | The \Q...\E sequence is recognized both inside and outside character | The \Q...\E sequence is recognized both inside and outside character |
| 2960 | classes. | classes. |
| 2961 | ||
| 2962 | 8. Fairly obviously, PCRE does not support the (?{code}) and (??{code}) | 8. Fairly obviously, PCRE does not support the (?{code}) and (??{code}) |
| 2963 | constructions. However, there is support for recursive patterns. This | constructions. However, there is support for recursive patterns. This |
| 2964 | 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 |
| 2965 | "callout" feature allows an external function to be called during pat- | "callout" feature allows an external function to be called during pat- |
| 2966 | tern matching. See the pcrecallout documentation for details. | tern matching. See the pcrecallout documentation for details. |
| 2967 | ||
| 2968 | 9. Subpatterns that are called recursively or as "subroutines" are | 9. Subpatterns that are called recursively or as "subroutines" are |
| 2969 | always treated as atomic groups in PCRE. This is like Python, but | always treated as atomic groups in PCRE. This is like Python, but |
| 2970 | unlike Perl. | unlike Perl. There is a discussion of an example that explains this in |
| 2971 | more detail in the section on recursion differences from Perl in the | |
| 2972 | 10. There are some differences that are concerned with the settings of | pcrepattern page. |
| 2973 | captured strings when part of a pattern is repeated. For example, | |
| 2974 | matching "aba" against the pattern /^(a(b)?)+$/ in Perl leaves $2 | 10. There are some differences that are concerned with the settings of |
| 2975 | captured strings when part of a pattern is repeated. For example, | |
| 2976 | matching "aba" against the pattern /^(a(b)?)+$/ in Perl leaves $2 | |
| 2977 | unset, but in PCRE it is set to "b". | unset, but in PCRE it is set to "b". |
| 2978 | ||
| 2979 | 11. PCRE provides some extensions to the Perl regular expression facil- | 11. PCRE does support Perl 5.10's backtracking verbs (*ACCEPT), |
| 2980 | ities. Perl 5.10 will include new features that are not in earlier | (*FAIL), (*F), (*COMMIT), (*PRUNE), (*SKIP), and (*THEN), but only in |
| 2981 | versions, some of which (such as named parentheses) have been in PCRE | the forms without an argument. PCRE does not support (*MARK). |
| 2982 | for some time. This list is with respect to Perl 5.10: | |
| 2983 | 12. PCRE's handling of duplicate subpattern numbers and duplicate sub- | |
| 2984 | (a) Although lookbehind assertions must match fixed length strings, | pattern names is not as general as Perl's. This is a consequence of the |
| 2985 | each alternative branch of a lookbehind assertion can match a different | fact the PCRE works internally just with numbers, using an external ta- |
| 2986 | length of string. Perl requires them all to have the same length. | ble to translate between numbers and names. In particular, a pattern |
| 2987 | such as (?|(?<a>A)|(?<b)B), where the two capturing parentheses have | |
| 2988 | the same number but different names, is not supported, and causes an | |
| 2989 | error at compile time. If it were allowed, it would not be possible to | |
| 2990 | distinguish which parentheses matched, because both names map to cap- | |
| 2991 | turing subpattern number 1. To avoid this confusing situation, an error | |
| 2992 | is given at compile time. | |
| 2993 | ||
| 2994 | 13. PCRE provides some extensions to the Perl regular expression facil- | |
| 2995 | ities. Perl 5.10 includes new features that are not in earlier ver- | |
| 2996 | sions of Perl, some of which (such as named parentheses) have been in | |
| 2997 | PCRE for some time. This list is with respect to Perl 5.10: | |
| 2998 | ||
| 2999 | (a) Although lookbehind assertions in PCRE must match fixed length | |
| 3000 | strings, each alternative branch of a lookbehind assertion can match a | |
| 3001 | different length of string. Perl requires them all to have the same | |
| 3002 | length. | |
| 3003 | ||
| 3004 | (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 $ |
| 3005 | meta-character matches only at the very end of the string. | meta-character matches only at the very end of the string. |
| 3006 | ||
| 3007 | (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- |
| 3008 | cial meaning is faulted. Otherwise, like Perl, the backslash is | cial meaning is faulted. Otherwise, like Perl, the backslash is quietly |
| 3009 | ignored. (Perl can be made to issue a warning.) | ignored. (Perl can be made to issue a warning.) |
| 3010 | ||
| 3011 | (d) If PCRE_UNGREEDY is set, the greediness of the repetition quanti- | (d) If PCRE_UNGREEDY is set, the greediness of the repetition quanti- |
| 3012 | 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- |
| 3013 | lowed by a question mark they are. | lowed by a question mark they are. |
| 3014 | ||
| 3015 | (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 |
| 3016 | tried only at the first matching position in the subject string. | tried only at the first matching position in the subject string. |
| 3017 | ||
| 3018 | (f) The PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, and PCRE_NO_AUTO_CAP- | (f) The PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NOTEMPTY_ATSTART, |
| 3019 | TURE options for pcre_exec() have no Perl equivalents. | and PCRE_NO_AUTO_CAPTURE options for pcre_exec() have no Perl equiva- |
| 3020 | lents. | |
| 3021 | ||
| 3022 | (g) The \R escape sequence can be restricted to match only CR, LF, or | |
| 3023 | CRLF by the PCRE_BSR_ANYCRLF option. | |
| 3024 | ||
| 3025 | (g) The callout facility is PCRE-specific. | (h) The callout facility is PCRE-specific. |
| 3026 | ||
| 3027 | (h) The partial matching facility is PCRE-specific. | (i) The partial matching facility is PCRE-specific. |
| 3028 | ||
| 3029 | (i) Patterns compiled by PCRE can be saved and re-used at a later time, | (j) Patterns compiled by PCRE can be saved and re-used at a later time, |
| 3030 | even on different hosts that have the other endianness. | even on different hosts that have the other endianness. |
| 3031 | ||
| 3032 | (j) The alternative matching function (pcre_dfa_exec()) matches in a | (k) The alternative matching function (pcre_dfa_exec()) matches in a |
| 3033 | different way and is not Perl-compatible. | different way and is not Perl-compatible. |
| 3034 | ||
| 3035 | (l) PCRE recognizes some special sequences such as (*CR) at the start | |
| 3036 | of a pattern that set overall options that cannot be changed within the | |
| 3037 | pattern. | |
| 3038 | ||
| 3039 | ||
| 3040 | AUTHOR | AUTHOR |
| 3041 | ||
| # | Line 2705 AUTHOR | Line 3046 AUTHOR |
| 3046 | ||
| 3047 | REVISION | REVISION |
| 3048 | ||
| 3049 | Last updated: 06 March 2007 | Last updated: 04 October 2009 |
| 3050 | Copyright (c) 1997-2007 University of Cambridge. | Copyright (c) 1997-2009 University of Cambridge. |
| 3051 | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
| 3052 | ||
| 3053 | ||
| # | Line 2719 NAME | Line 3060 NAME |
| 3060 | ||
| 3061 | PCRE REGULAR EXPRESSION DETAILS | PCRE REGULAR EXPRESSION DETAILS |
| 3062 | ||
| 3063 | The syntax and semantics of the regular expressions supported by PCRE | The syntax and semantics of the regular expressions that are supported |
| 3064 | are described below. Regular expressions are also described in the Perl | by PCRE are described in detail below. There is a quick-reference syn- |
| 3065 | 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 |
| 3066 | examples. Jeffrey Friedl's "Mastering Regular Expressions", published | semantics as closely as it can. PCRE also supports some alternative |
| 3067 | by O'Reilly, covers regular expressions in great detail. This descrip- | regular expression syntax (which does not conflict with the Perl syn- |
| 3068 | tion of PCRE's regular expressions is intended as reference material. | tax) in order to provide some compatibility with regular expressions in |
| 3069 | Python, .NET, and Oniguruma. | |
| 3070 | ||
| 3071 | Perl's regular expressions are described in its own documentation, and | |
| 3072 | regular expressions in general are covered in a number of books, some | |
| 3073 | of which have copious examples. Jeffrey Friedl's "Mastering Regular | |
| 3074 | Expressions", published by O'Reilly, covers regular expressions in | |
| 3075 | great detail. This description of PCRE's regular expressions is | |
| 3076 | intended as reference material. | |
| 3077 | ||
| 3078 | The original operation of PCRE was on strings of one-byte characters. | The original operation of PCRE was on strings of one-byte characters. |
| 3079 | 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 |
| 3080 | 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 |
| 3081 | pcre_compile() with the PCRE_UTF8 option. How this affects pattern | pcre_compile() or pcre_compile2() with the PCRE_UTF8 option. There is |
| 3082 | 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: |
| 3083 | of UTF-8 features in the section on UTF-8 support in the main pcre | |
| 3084 | page. | (*UTF8) |
| 3085 | ||
| 3086 | Starting a pattern with this sequence is equivalent to setting the | |
| 3087 | PCRE_UTF8 option. This feature is not Perl-compatible. How setting | |
| 3088 | UTF-8 mode affects pattern matching is mentioned in several places | |
| 3089 | below. There is also a summary of UTF-8 features in the section on | |
| 3090 | UTF-8 support in the main pcre page. | |
| 3091 | ||
| 3092 | The remainder of this document discusses the patterns that are sup- | The remainder of this document discusses the patterns that are sup- |
| 3093 | 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 3099 PCRE REGULAR EXPRESSION DETAILS |
| 3099 | discussed in the pcrematching page. | discussed in the pcrematching page. |
| 3100 | ||
| 3101 | ||
| 3102 | NEWLINE CONVENTIONS | |
| 3103 | ||
| 3104 | PCRE supports five different conventions for indicating line breaks in | |
| 3105 | strings: a single CR (carriage return) character, a single LF (line- | |
| 3106 | feed) character, the two-character sequence CRLF, any of the three pre- | |
| 3107 | ceding, or any Unicode newline sequence. The pcreapi page has further | |
| 3108 | discussion about newlines, and shows how to set the newline convention | |
| 3109 | in the options arguments for the compiling and matching functions. | |
| 3110 | ||
| 3111 | It is also possible to specify a newline convention by starting a pat- | |
| 3112 | tern string with one of the following five sequences: | |
| 3113 | ||
| 3114 | (*CR) carriage return | |
| 3115 | (*LF) linefeed | |
| 3116 | (*CRLF) carriage return, followed by linefeed | |
| 3117 | (*ANYCRLF) any of the three above | |
| 3118 | (*ANY) all Unicode newline sequences | |
| 3119 | ||
| 3120 | These override the default and the options given to pcre_compile() or | |
| 3121 | pcre_compile2(). For example, on a Unix system where LF is the default | |
| 3122 | newline sequence, the pattern | |
| 3123 | ||
| 3124 | (*CR)a.b | |
| 3125 | ||
| 3126 | changes the convention to CR. That pattern matches "a\nb" because LF is | |
| 3127 | no longer a newline. Note that these special settings, which are not | |
| 3128 | Perl-compatible, are recognized only at the very start of a pattern, | |
| 3129 | and that they must be in upper case. If more than one of them is | |
| 3130 | present, the last one is used. | |
| 3131 | ||
| 3132 | The newline convention does not affect what the \R escape sequence | |
| 3133 | matches. By default, this is any Unicode newline sequence, for Perl | |
| 3134 | compatibility. However, this can be changed; see the description of \R | |
| 3135 | in the section entitled "Newline sequences" below. A change of \R set- | |
| 3136 | ting can be combined with a change of newline convention. | |
| 3137 | ||
| 3138 | ||
| 3139 | CHARACTERS AND METACHARACTERS | CHARACTERS AND METACHARACTERS |
| 3140 | ||
| 3141 | 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 3191 CHARACTERS AND METACHARACTERS |
| 3191 | syntax) | syntax) |
| 3192 | ] terminates the character class | ] terminates the character class |
| 3193 | ||
| 3194 | The following sections describe the use of each of the metacharacters. | The following sections describe the use of each of the metacharacters. |
| 3195 | ||
| 3196 | ||
| 3197 | BACKSLASH | BACKSLASH |
| 3198 | ||
| 3199 | The backslash character has several uses. Firstly, if it is followed by | The backslash character has several uses. Firstly, if it is followed by |
| 3200 | a non-alphanumeric character, it takes away any special meaning that | a non-alphanumeric character, it takes away any special meaning that |
| 3201 | character may have. This use of backslash as an escape character | character may have. This use of backslash as an escape character |
| 3202 | applies both inside and outside character classes. | applies both inside and outside character classes. |
| 3203 | ||
| 3204 | 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 |
| 3205 | pattern. This escaping action applies whether or not the following | pattern. This escaping action applies whether or not the following |
| 3206 | character would otherwise be interpreted as a metacharacter, so it is | character would otherwise be interpreted as a metacharacter, so it is |
| 3207 | always safe to precede a non-alphanumeric with backslash to specify | always safe to precede a non-alphanumeric with backslash to specify |
| 3208 | 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- |
| 3209 | slash, you write \\. | slash, you write \\. |
| 3210 | ||
| 3211 | If a pattern is compiled with the PCRE_EXTENDED option, whitespace in | If a pattern is compiled with the PCRE_EXTENDED option, whitespace in |
| 3212 | the pattern (other than in a character class) and characters between a | the pattern (other than in a character class) and characters between a |
| 3213 | # outside a character class and the next newline are ignored. An escap- | # outside a character class and the next newline are ignored. An escap- |
| 3214 | ing backslash can be used to include a whitespace or # character as | ing backslash can be used to include a whitespace or # character as |
| 3215 | part of the pattern. | part of the pattern. |
| 3216 | ||
| 3217 | 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- |
| 3218 | 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- |
| 3219 | 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 |
| 3220 | sequences in PCRE, whereas in Perl, $ and @ cause variable interpola- | sequences in PCRE, whereas in Perl, $ and @ cause variable interpola- |
| 3221 | tion. Note the following examples: | tion. Note the following examples: |
| 3222 | ||
| 3223 | Pattern PCRE matches Perl matches | Pattern PCRE matches Perl matches |
| # | Line 2835 BACKSLASH | Line 3227 BACKSLASH |
| 3227 | \Qabc\$xyz\E abc\$xyz abc\$xyz | \Qabc\$xyz\E abc\$xyz abc\$xyz |
| 3228 | \Qabc\E\$\Qxyz\E abc$xyz abc$xyz | \Qabc\E\$\Qxyz\E abc$xyz abc$xyz |
| 3229 | ||
| 3230 | The \Q...\E sequence is recognized both inside and outside character | The \Q...\E sequence is recognized both inside and outside character |
| 3231 | classes. | classes. |
| 3232 | ||
| 3233 | Non-printing characters | Non-printing characters |
| 3234 | ||
| 3235 | 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- |
| 3236 | 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 |
| 3237 | appearance of non-printing characters, apart from the binary zero that | appearance of non-printing characters, apart from the binary zero that |
| 3238 | terminates a pattern, but when a pattern is being prepared by text | terminates a pattern, but when a pattern is being prepared by text |
| 3239 | editing, it is usually easier to use one of the following escape | editing, it is often easier to use one of the following escape |
| 3240 | sequences than the binary character it represents: | sequences than the binary character it represents: |
| 3241 | ||
| 3242 | \a alarm, that is, the BEL character (hex 07) | \a alarm, that is, the BEL character (hex 07) |
| 3243 | \cx "control-x", where x is any character | \cx "control-x", where x is any character |
| 3244 | \e escape (hex 1B) | \e escape (hex 1B) |
| 3245 | \f formfeed (hex 0C) | \f formfeed (hex 0C) |
| 3246 | \n newline (hex 0A) | \n linefeed (hex 0A) |
| 3247 | \r carriage return (hex 0D) | \r carriage return (hex 0D) |
| 3248 | \t tab (hex 09) | \t tab (hex 09) |
| 3249 | \ddd character with octal code ddd, or backreference | \ddd character with octal code ddd, or backreference |
| 3250 | \xhh character with hex code hh | \xhh character with hex code hh |
| 3251 | \x{hhh..} character with hex code hhh.. | \x{hhh..} character with hex code hhh.. |
| 3252 | ||
| 3253 | 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, |
| 3254 | 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 |
| 3255 | 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; |
| 3256 | becomes hex 7B. | becomes hex 7B. |
| 3257 | ||
| 3258 | 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 |
| 3259 | in upper or lower case). Any number of hexadecimal digits may appear | in upper or lower case). Any number of hexadecimal digits may appear |
| 3260 | 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 |
| 3261 | 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, |
| 3262 | the maximum hexadecimal value is 7FFFFFFF). If characters other than | the maximum value in hexadecimal is 7FFFFFFF. Note that this is bigger |
| 3263 | hexadecimal digits appear between \x{ and }, or if there is no termi- | than the largest Unicode code point, which is 10FFFF. |
| 3264 | nating }, this form of escape is not recognized. Instead, the initial | |
| 3265 | \x will be interpreted as a basic hexadecimal escape, with no following | If characters other than hexadecimal digits appear between \x{ and }, |
| 3266 | digits, giving a character whose value is zero. | or if there is no terminating }, this form of escape is not recognized. |
| 3267 | Instead, the initial \x will be interpreted as a basic hexadecimal | |
| 3268 | escape, with no following digits, giving a character whose value is | |
| 3269 | zero. | |
| 3270 | ||
| 3271 | 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 |
| 3272 | 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 2926 BACKSLASH | Line 3321 BACKSLASH |
| 3321 | ||
| 3322 | Absolute and relative back references | Absolute and relative back references |
| 3323 | ||
| 3324 | The sequence \g followed by a positive or negative number, optionally | The sequence \g followed by an unsigned or a negative number, option- |
| 3325 | enclosed in braces, is an absolute or relative back reference. A named | ally enclosed in braces, is an absolute or relative back reference. A |
| 3326 | 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- |
| 3327 | later, following the discussion of parenthesized subpatterns. | cussed later, following the discussion of parenthesized subpatterns. |
| 3328 | ||
| 3329 | Absolute and relative subroutine calls | |
| 3330 | ||
| 3331 | For compatibility with Oniguruma, the non-Perl syntax \g followed by a | |
| 3332 | name or a number enclosed either in angle brackets or single quotes, is | |
| 3333 | an alternative syntax for referencing a subpattern as a "subroutine". | |
| 3334 | Details are discussed later. Note that \g{...} (Perl syntax) and | |
| 3335 | \g<...> (Oniguruma syntax) are not synonymous. The former is a back | |
| 3336 | reference; the latter is a subroutine call. | |
| 3337 | ||
| 3338 | Generic character types | Generic character types |
| 3339 | ||
| # | Line 2938 BACKSLASH | Line 3342 BACKSLASH |
| 3342 | ||
| 3343 | \d any decimal digit | \d any decimal digit |
| 3344 | \D any character that is not a decimal digit | \D any character that is not a decimal digit |
| 3345 | \h any horizontal whitespace character | |
| 3346 | \H any character that is not a horizontal whitespace character | |
| 3347 | \s any whitespace character | \s any whitespace character |
| 3348 | \S any character that is not a whitespace character | \S any character that is not a whitespace character |
| 3349 | \v any vertical whitespace character | |
| 3350 | \V any character that is not a vertical whitespace character | |
| 3351 | \w any "word" character | \w any "word" character |
| 3352 | \W any "non-word" character | \W any "non-word" character |
| 3353 | ||
| 3354 | Each pair of escape sequences partitions the complete set of characters | Each pair of escape sequences partitions the complete set of characters |
| 3355 | into two disjoint sets. Any given character matches one, and only one, | into two disjoint sets. Any given character matches one, and only one, |
| 3356 | of each pair. | of each pair. |
| 3357 | ||
| 3358 | These character type sequences can appear both inside and outside char- | These character type sequences can appear both inside and outside char- |
| 3359 | acter classes. They each match one character of the appropriate type. | acter classes. They each match one character of the appropriate type. |
| 3360 | If the current matching point is at the end of the subject string, all | If the current matching point is at the end of the subject string, all |
| 3361 | of them fail, since there is no character to match. | of them fail, since there is no character to match. |
| 3362 | ||
| 3363 | For compatibility with Perl, \s does not match the VT character (code | For compatibility with Perl, \s does not match the VT character (code |
| 3364 | 11). This makes it different from the the POSIX "space" class. The \s | 11). This makes it different from the the POSIX "space" class. The \s |
| 3365 | characters are HT (9), LF (10), FF (12), CR (13), and space (32). (If | characters are HT (9), LF (10), FF (12), CR (13), and space (32). If |
| 3366 | "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- |
| 3367 | ter. In PCRE, it never does.) | ter. In PCRE, it never does. |
| 3368 | ||
| 3369 | In UTF-8 mode, characters with values greater than 128 never match \d, | |
| 3370 | \s, or \w, and always match \D, \S, and \W. This is true even when Uni- | |
| 3371 | code character property support is available. These sequences retain | |
| 3372 | their original meanings from before UTF-8 support was available, mainly | |
| 3373 | for efficiency reasons. Note that this also affects \b, because it is | |
| 3374 | defined in terms of \w and \W. | |
| 3375 | ||
| 3376 | The sequences \h, \H, \v, and \V are Perl 5.10 features. In contrast to | |
| 3377 | the other sequences, these do match certain high-valued codepoints in | |
| 3378 | UTF-8 mode. The horizontal space characters are: | |
| 3379 | ||
| 3380 | U+0009 Horizontal tab | |
| 3381 | U+0020 Space | |
| 3382 | U+00A0 Non-break space | |
| 3383 | U+1680 Ogham space mark | |
| 3384 | U+180E Mongolian vowel separator | |
| 3385 | U+2000 En quad | |
| 3386 | U+2001 Em quad | |
| 3387 | U+2002 En space | |
| 3388 | U+2003 Em space | |
| 3389 | U+2004 Three-per-em space | |
| 3390 | U+2005 Four-per-em space | |
| 3391 | U+2006 Six-per-em space | |
| 3392 | U+2007 Figure space | |
| 3393 | U+2008 Punctuation space | |
| 3394 | U+2009 Thin space | |
| 3395 | U+200A Hair space | |
| 3396 | U+202F Narrow no-break space | |
| 3397 | U+205F Medium mathematical space | |
| 3398 | U+3000 Ideographic space | |
| 3399 | ||
| 3400 | The vertical space characters are: | |
| 3401 | ||
| 3402 | U+000A Linefeed | |
| 3403 | U+000B Vertical tab | |
| 3404 | U+000C Formfeed | |
| 3405 | U+000D Carriage return | |
| 3406 | U+0085 Next line | |
| 3407 | U+2028 Line separator | |
| 3408 | U+2029 Paragraph separator | |
| 3409 | ||
| 3410 | A "word" character is an underscore or any character less than 256 that | A "word" character is an underscore or any character less than 256 that |
| 3411 | is a letter or digit. The definition of letters and digits is con- | is a letter or digit. The definition of letters and digits is con- |
| # | Line 2964 BACKSLASH | Line 3413 BACKSLASH |
| 3413 | specific matching is taking place (see "Locale support" in the pcreapi | specific matching is taking place (see "Locale support" in the pcreapi |
| 3414 | 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 |
| 3415 | systems, or "french" in Windows, some character codes greater than 128 | systems, or "french" in Windows, some character codes greater than 128 |
| 3416 | are used for accented letters, and these are matched by \w. | are used for accented letters, and these are matched by \w. The use of |
| 3417 | locales with Unicode is discouraged. | |
| In UTF-8 mode, characters with values greater than 128 never match \d, | ||
| \s, or \w, and always match \D, \S, and \W. This is true even when Uni- | ||
| code character property support is available. The use of locales with | ||
| Unicode is discouraged. | ||
| 3418 | ||
| 3419 | Newline sequences | Newline sequences |
| 3420 | ||
| 3421 | Outside a character class, the escape sequence \R matches any Unicode | Outside a character class, by default, the escape sequence \R matches |
| 3422 | 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 |
| 3423 | equivalent to the following: | mode \R is equivalent to the following: |
| 3424 | ||
| 3425 | (?>\r\n|\n|\x0b|\f|\r|\x85) | (?>\r\n|\n|\x0b|\f|\r|\x85) |
| 3426 | ||
| # | Line 2991 BACKSLASH | Line 3436 BACKSLASH |
| 3436 | rator, U+2029). Unicode character property support is not needed for | rator, U+2029). Unicode character property support is not needed for |
| 3437 | these characters to be recognized. | these characters to be recognized. |
| 3438 | ||
| 3439 | It is possible to restrict \R to match only CR, LF, or CRLF (instead of | |
| 3440 | the complete set of Unicode line endings) by setting the option | |
| 3441 | PCRE_BSR_ANYCRLF either at compile time or when the pattern is matched. | |
| 3442 | (BSR is an abbrevation for "backslash R".) This can be made the default | |
| 3443 | when PCRE is built; if this is the case, the other behaviour can be | |
| 3444 | requested via the PCRE_BSR_UNICODE option. It is also possible to | |
| 3445 | specify these settings by starting a pattern string with one of the | |
| 3446 | following sequences: | |
| 3447 | ||
| 3448 | (*BSR_ANYCRLF) CR, LF, or CRLF only | |
| 3449 | (*BSR_UNICODE) any Unicode newline sequence | |
| 3450 | ||
| 3451 | These override the default and the options given to pcre_compile() or | |
| 3452 | pcre_compile2(), but they can be overridden by options given to | |
| 3453 | pcre_exec() or pcre_dfa_exec(). Note that these special settings, which | |
| 3454 | are not Perl-compatible, are recognized only at the very start of a | |
| 3455 | pattern, and that they must be in upper case. If more than one of them | |
| 3456 | is present, the last one is used. They can be combined with a change of | |
| 3457 | newline convention, for example, a pattern can start with: | |
| 3458 | ||
| 3459 | (*ANY)(*BSR_ANYCRLF) | |
| 3460 | ||
| 3461 | Inside a character class, \R matches the letter "R". | Inside a character class, \R matches the letter "R". |
| 3462 | ||
| 3463 | Unicode character properties | Unicode character properties |
| 3464 | ||
| 3465 | When PCRE is built with Unicode character property support, three addi- | When PCRE is built with Unicode character property support, three addi- |
| 3466 | tional escape sequences to match character properties are available | tional escape sequences that match characters with specific properties |
| 3467 | when UTF-8 mode is selected. They are: | are available. When not in UTF-8 mode, these sequences are of course |
| 3468 | limited to testing characters whose codepoints are less than 256, but | |
| 3469 | they do work in this mode. The extra escape sequences are: | |
| 3470 | ||
| 3471 | \p{xx} a character with the xx property | \p{xx} a character with the xx property |
| 3472 | \P{xx} a character without the xx property | \P{xx} a character without the xx property |
| 3473 | \X an extended Unicode sequence | \X an extended Unicode sequence |
| 3474 | ||
| 3475 | The property names represented by xx above are limited to the Unicode | The property names represented by xx above are limited to the Unicode |
| 3476 | script names, the general category properties, and "Any", which matches | script names, the general category properties, and "Any", which matches |
| 3477 | any character (including newline). Other properties such as "InMusical- | any character (including newline). Other properties such as "InMusical- |
| 3478 | Symbols" are not currently supported by PCRE. Note that \P{Any} does | Symbols" are not currently supported by PCRE. Note that \P{Any} does |
| 3479 | not match any characters, so always causes a match failure. | not match any characters, so always causes a match failure. |
| 3480 | ||
| 3481 | Sets of Unicode characters are defined as belonging to certain scripts. | Sets of Unicode characters are defined as belonging to certain scripts. |
| 3482 | 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. |
| 3483 | For example: | For example: |
| 3484 | ||
| 3485 | \p{Greek} | \p{Greek} |
| 3486 | \P{Han} | \P{Han} |
| 3487 | ||
| 3488 | 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 |
| 3489 | "Common". The current list of scripts is: | "Common". The current list of scripts is: |
| 3490 | ||
| 3491 | Arabic, Armenian, Balinese, Bengali, Bopomofo, Braille, Buginese, | Arabic, Armenian, Balinese, Bengali, Bopomofo, Braille, Buginese, |
| 3492 | Buhid, Canadian_Aboriginal, Cherokee, Common, Coptic, Cuneiform, | Buhid, Canadian_Aboriginal, Cherokee, Common, Coptic, Cuneiform, |
| 3493 | Cypriot, Cyrillic, Deseret, Devanagari, Ethiopic, Georgian, Glagolitic, | Cypriot, Cyrillic, Deseret, Devanagari, Ethiopic, Georgian, Glagolitic, |
| 3494 | Gothic, Greek, Gujarati, Gurmukhi, Han, Hangul, Hanunoo, Hebrew, Hira- | Gothic, Greek, Gujarati, Gurmukhi, Han, Hangul, Hanunoo, Hebrew, Hira- |
| 3495 | gana, Inherited, Kannada, Katakana, Kharoshthi, Khmer, Lao, Latin, | gana, Inherited, Kannada, Katakana, Kharoshthi, Khmer, Lao, Latin, |
| 3496 | Limbu, Linear_B, Malayalam, Mongolian, Myanmar, New_Tai_Lue, Nko, | Limbu, Linear_B, Malayalam, Mongolian, Myanmar, New_Tai_Lue, Nko, |
| 3497 | Ogham, Old_Italic, Old_Persian, Oriya, Osmanya, Phags_Pa, Phoenician, | Ogham, Old_Italic, Old_Persian, Oriya, Osmanya, Phags_Pa, Phoenician, |
| 3498 | Runic, Shavian, Sinhala, Syloti_Nagri, Syriac, Tagalog, Tagbanwa, | Runic, Shavian, Sinhala, Syloti_Nagri, Syriac, Tagalog, Tagbanwa, |
| 3499 | Tai_Le, Tamil, Telugu, Thaana, Thai, Tibetan, Tifinagh, Ugaritic, Yi. | Tai_Le, Tamil, Telugu, Thaana, Thai, Tibetan, Tifinagh, Ugaritic, Yi. |
| 3500 | ||
| 3501 | Each character has exactly one general category property, specified by | Each character has exactly one general category property, specified by |
| 3502 | a two-letter abbreviation. For compatibility with Perl, negation can be | a two-letter abbreviation. For compatibility with Perl, negation can be |
| 3503 | specified by including a circumflex between the opening brace and the | specified by including a circumflex between the opening brace and the |
| 3504 | property name. For example, \p{^Lu} is the same as \P{Lu}. | property name. For example, \p{^Lu} is the same as \P{Lu}. |
| 3505 | ||
| 3506 | 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- |
| 3507 | eral category properties that start with that letter. In this case, in | eral category properties that start with that letter. In this case, in |
| 3508 | the absence of negation, the curly brackets in the escape sequence are | the absence of negation, the curly brackets in the escape sequence are |
| 3509 | optional; these two examples have the same effect: | optional; these two examples have the same effect: |
| 3510 | ||
| 3511 | \p{L} | \p{L} |
| # | Line 3088 BACKSLASH | Line 3557 BACKSLASH |
| 3557 | Zp Paragraph separator | Zp Paragraph separator |
| 3558 | Zs Space separator | Zs Space separator |
| 3559 | ||
| 3560 | The special property L& is also supported: it matches a character that | The special property L& is also supported: it matches a character that |
| 3561 | 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 |
| 3562 | classified as a modifier or "other". | classified as a modifier or "other". |
| 3563 | ||
| 3564 | The long synonyms for these properties that Perl supports (such as | The Cs (Surrogate) property applies only to characters in the range |
| 3565 | \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 |
| 3566 | RFC 3629) and so cannot be tested by PCRE, unless UTF-8 validity check- | |
| 3567 | ing has been turned off (see the discussion of PCRE_NO_UTF8_CHECK in | |
| 3568 | the pcreapi page). Perl does not support the Cs property. | |
| 3569 | ||
| 3570 | The long synonyms for property names that Perl supports (such as | |
| 3571 | \p{Letter}) are not supported by PCRE, nor is it permitted to prefix | |
| 3572 | any of these properties with "Is". | any of these properties with "Is". |
| 3573 | ||
| 3574 | 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- |
| 3575 | 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 |
| 3576 | in the Unicode table. | in the Unicode table. |
| 3577 | ||
| 3578 | Specifying caseless matching does not affect these escape sequences. | Specifying caseless matching does not affect these escape sequences. |
| 3579 | For example, \p{Lu} always matches only upper case letters. | For example, \p{Lu} always matches only upper case letters. |
| 3580 | ||
| 3581 | The \X escape matches any number of Unicode characters that form an | The \X escape matches any number of Unicode characters that form an |
| 3582 | extended Unicode sequence. \X is equivalent to | extended Unicode sequence. \X is equivalent to |
| 3583 | ||
| 3584 | (?>\PM\pM*) | (?>\PM\pM*) |
| 3585 | ||
| 3586 | That is, it matches a character without the "mark" property, followed | That is, it matches a character without the "mark" property, followed |
| 3587 | by zero or more characters with the "mark" property, and treats the | by zero or more characters with the "mark" property, and treats the |
| 3588 | sequence as an atomic group (see below). Characters with the "mark" | sequence as an atomic group (see below). Characters with the "mark" |
| 3589 | property are typically accents that affect the preceding character. | property are typically accents that affect the preceding character. |
| 3590 | None of them have codepoints less than 256, so in non-UTF-8 mode \X | |
| 3591 | matches any one character. | |
| 3592 | ||
| 3593 | Matching characters by Unicode property is not fast, because PCRE has | Matching characters by Unicode property is not fast, because PCRE has |
| 3594 | to search a structure that contains data for over fifteen thousand | to search a structure that contains data for over fifteen thousand |
| 3595 | characters. That is why the traditional escape sequences such as \d and | characters. That is why the traditional escape sequences such as \d and |
| 3596 | \w do not use Unicode properties in PCRE. | \w do not use Unicode properties in PCRE. |
| 3597 | ||
| 3598 | Resetting the match start | Resetting the match start |
| 3599 | ||
| 3600 | 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- |
| 3601 | ously matched characters not to be included in the final matched | ously matched characters not to be included in the final matched |
| 3602 | sequence. For example, the pattern: | sequence. For example, the pattern: |
| 3603 | ||
| 3604 | foo\Kbar | foo\Kbar |
| 3605 | ||
| 3606 | matches "foobar", but reports that it has matched "bar". This feature | matches "foobar", but reports that it has matched "bar". This feature |
| 3607 | is similar to a lookbehind assertion (described below). However, in | is similar to a lookbehind assertion (described below). However, in |
| 3608 | 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 |
| 3609 | 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 |
| 3610 | not interfere with the setting of captured substrings. For example, | not interfere with the setting of captured substrings. For example, |
| 3611 | when the pattern | when the pattern |
| 3612 | ||
| 3613 | (foo)\Kbar | (foo)\Kbar |
| # | Line 3139 BACKSLASH | Line 3616 BACKSLASH |
| 3616 | ||
| 3617 | Simple assertions | Simple assertions |
| 3618 | ||
| 3619 | The final use of backslash is for certain simple assertions. An asser- | The final use of backslash is for certain simple assertions. An asser- |
| 3620 | 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 |
| 3621 | a match, without consuming any characters from the subject string. The | a match, without consuming any characters from the subject string. The |
| 3622 | use of subpatterns for more complicated assertions is described below. | use of subpatterns for more complicated assertions is described below. |
| 3623 | The backslashed assertions are: | The backslashed assertions are: |
| 3624 | ||
| 3625 | \b matches at a word boundary | \b matches at a word boundary |
| # | Line 3153 BACKSLASH | Line 3630 BACKSLASH |
| 3630 | \z matches only at the end of the subject | \z matches only at the end of the subject |
| 3631 | \G matches at the first matching position in the subject | \G matches at the first matching position in the subject |
| 3632 | ||
| 3633 | These assertions may not appear in character classes (but note that \b | These assertions may not appear in character classes (but note that \b |
| 3634 | has a different meaning, namely the backspace character, inside a char- | has a different meaning, namely the backspace character, inside a char- |
| 3635 | acter class). | acter class). |
| 3636 | ||
| 3637 | 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 |
| 3638 | 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. |
| 3639 | 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 |
| 3640 | string if the first or last character matches \w, respectively. | string if the first or last character matches \w, respectively. Neither |
| 3641 | PCRE nor Perl has a separte "start of word" or "end of word" metase- | |
| 3642 | quence. However, whatever follows \b normally determines which it is. | |
| 3643 | For example, the fragment \ba matches "a" at the start of a word. | |
| 3644 | ||
| 3645 | The \A, \Z, and \z assertions differ from the traditional circumflex | The \A, \Z, and \z assertions differ from the traditional circumflex |
| 3646 | 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 |
| # | Line 3286 SQUARE BRACKETS AND CHARACTER CLASSES | Line 3766 SQUARE BRACKETS AND CHARACTER CLASSES |
| 3766 | ||
| 3767 | An opening square bracket introduces a character class, terminated by a | An opening square bracket introduces a character class, terminated by a |
| 3768 | 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- |
| 3769 | 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, |
| 3770 | 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 |
| 3771 | circumflex, if present) or escaped with a backslash. | square bracket is required as a member of the class, it should be the |
| 3772 | first data character in the class (after an initial circumflex, if | |
| 3773 | present) or escaped with a backslash. | |
| 3774 | ||
| 3775 | 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 |
| 3776 | 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 |
| 3777 | 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 |
| 3778 | character in the class definition is a circumflex, in which case the | character in the class definition is a circumflex, in which case the |
| 3779 | 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 |
| # | Line 3302 SQUARE BRACKETS AND CHARACTER CLASSES | Line 3784 SQUARE BRACKETS AND CHARACTER CLASSES |
| 3784 | while [^aeiou] matches any character that is not a lower case vowel. | while [^aeiou] matches any character that is not a lower case vowel. |
| 3785 | Note that a circumflex is just a convenient notation for specifying the | Note that a circumflex is just a convenient notation for specifying the |
| 3786 | 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 |
| 3787 | 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- |
| 3788 | sumes a character from the subject string, and therefore it fails if | sumes a character from the subject string, and therefore it fails if |
| 3789 | the current pointer is at the end of the string. | the current pointer is at the end of the string. |
| 3790 | ||
| # | Line 3318 SQUARE BRACKETS AND CHARACTER CLASSES | Line 3800 SQUARE BRACKETS AND CHARACTER CLASSES |
| 3800 | than 128, so caseless matching is always possible. For characters with | than 128, so caseless matching is always possible. For characters with |
| 3801 | higher values, the concept of case is supported if PCRE is compiled | higher values, the concept of case is supported if PCRE is compiled |
| 3802 | with Unicode property support, but not otherwise. If you want to use | with Unicode property support, but not otherwise. If you want to use |
| 3803 | caseless matching for characters 128 and above, you must ensure that | caseless matching in UTF8-mode for characters 128 and above, you must |
| 3804 | 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 |
| 3805 | support. | with UTF-8 support. |
| 3806 | ||
| 3807 | Characters that might indicate line breaks are never treated in any | Characters that might indicate line breaks are never treated in any |
| 3808 | special way when matching character classes, whatever line-ending | special way when matching character classes, whatever line-ending |
| # | Line 3420 POSIX CHARACTER CLASSES | Line 3902 POSIX CHARACTER CLASSES |
| 3902 | ||
| 3903 | VERTICAL BAR | VERTICAL BAR |
| 3904 | ||
| 3905 | Vertical bar characters are used to separate alternative patterns. For | Vertical bar characters are used to separate alternative patterns. For |
| 3906 | example, the pattern | example, the pattern |
| 3907 | ||
| 3908 | gilbert|sullivan | gilbert|sullivan |
| 3909 | ||
| 3910 | matches either "gilbert" or "sullivan". Any number of alternatives may | matches either "gilbert" or "sullivan". Any number of alternatives may |
| 3911 | appear, and an empty alternative is permitted (matching the empty | appear, and an empty alternative is permitted (matching the empty |
| 3912 | string). The matching process tries each alternative in turn, from left | string). The matching process tries each alternative in turn, from left |
| 3913 | to right, and the first one that succeeds is used. If the alternatives | to right, and the first one that succeeds is used. If the alternatives |
| 3914 | are within a subpattern (defined below), "succeeds" means matching the | are within a subpattern (defined below), "succeeds" means matching the |
| 3915 | rest of the main pattern as well as the alternative in the subpattern. | rest of the main pattern as well as the alternative in the subpattern. |
| 3916 | ||
| 3917 | ||
| 3918 | INTERNAL OPTION SETTING | INTERNAL OPTION SETTING |
| 3919 | ||
| 3920 | The settings of the PCRE_CASELESS, PCRE_MULTILINE, PCRE_DOTALL, and | The settings of the PCRE_CASELESS, PCRE_MULTILINE, PCRE_DOTALL, and |
| 3921 | PCRE_EXTENDED options can be changed from within the pattern by a | PCRE_EXTENDED options (which are Perl-compatible) can be changed from |
| 3922 | sequence of Perl option letters enclosed between "(?" and ")". The | within the pattern by a sequence of Perl option letters enclosed |
| 3923 | option letters are | between "(?" and ")". The option letters are |
| 3924 | ||
| 3925 | i for PCRE_CASELESS | i for PCRE_CASELESS |
| 3926 | m for PCRE_MULTILINE | m for PCRE_MULTILINE |
| # | Line 3452 INTERNAL OPTION SETTING | Line 3934 INTERNAL OPTION SETTING |
| 3934 | is also permitted. If a letter appears both before and after the | is also permitted. If a letter appears both before and after the |
| 3935 | hyphen, the option is unset. | hyphen, the option is unset. |
| 3936 | ||
| 3937 | When an option change occurs at top level (that is, not inside subpat- | The PCRE-specific options PCRE_DUPNAMES, PCRE_UNGREEDY, and PCRE_EXTRA |
| 3938 | tern parentheses), the change applies to the remainder of the pattern | can be changed in the same way as the Perl-compatible options by using |
| 3939 | that follows. If the change is placed right at the start of a pattern, | the characters J, U and X respectively. |
| 3940 | PCRE extracts it into the global options (and it will therefore show up | |
| 3941 | in data extracted by the pcre_fullinfo() function). | When one of these option changes occurs at top level (that is, not |
| 3942 | inside subpattern parentheses), the change applies to the remainder of | |
| 3943 | the pattern that follows. If the change is placed right at the start of | |
| 3944 | a pattern, PCRE extracts it into the global options (and it will there- | |
| 3945 | fore show up in data extracted by the pcre_fullinfo() function). | |
| 3946 | ||
| 3947 | An option change within a subpattern (see below for a description of | An option change within a subpattern (see below for a description of |
| 3948 | subpatterns) affects only that part of the current pattern that follows | subpatterns) affects only that part of the current pattern that follows |
| # | Line 3477 INTERNAL OPTION SETTING | Line 3963 INTERNAL OPTION SETTING |
| 3963 | the effects of option settings happen at compile time. There would be | the effects of option settings happen at compile time. There would be |
| 3964 | some very weird behaviour otherwise. | some very weird behaviour otherwise. |
| 3965 | ||
| 3966 | The PCRE-specific options PCRE_DUPNAMES, PCRE_UNGREEDY, and PCRE_EXTRA | Note: There are other PCRE-specific options that can be set by the |
| 3967 | can be changed in the same way as the Perl-compatible options by using | application when the compile or match functions are called. In some |
| 3968 | the characters J, U and X respectively. | cases the pattern can contain special leading sequences such as (*CRLF) |
| 3969 | to override what the application has set or what has been defaulted. | |
| 3970 | Details are given in the section entitled "Newline sequences" above. | |
| 3971 | There is also the (*UTF8) leading sequence that can be used to set | |
| 3972 | UTF-8 mode; this is equivalent to setting the PCRE_UTF8 option. | |
| 3973 | ||
| 3974 | ||
| 3975 | SUBPATTERNS | SUBPATTERNS |
| # | Line 3537 SUBPATTERNS | Line 4027 SUBPATTERNS |
| 4027 | "Saturday". | "Saturday". |
| 4028 | ||
| 4029 | ||
| 4030 | DUPLICATE SUBPATTERN NUMBERS | |
| 4031 | ||
| 4032 | Perl 5.10 introduced a feature whereby each alternative in a subpattern | |
| 4033 | uses the same numbers for its capturing parentheses. Such a subpattern | |
| 4034 | starts with (?| and is itself a non-capturing subpattern. For example, | |
| 4035 | consider this pattern: | |
| 4036 | ||
| 4037 | (?|(Sat)ur|(Sun))day | |
| 4038 | ||
| 4039 | Because the two alternatives are inside a (?| group, both sets of cap- | |
| 4040 | turing parentheses are numbered one. Thus, when the pattern matches, | |
| 4041 | you can look at captured substring number one, whichever alternative | |
| 4042 | matched. This construct is useful when you want to capture part, but | |
| 4043 | not all, of one of a number of alternatives. Inside a (?| group, paren- | |
| 4044 | theses are numbered as usual, but the number is reset at the start of | |
| 4045 | each branch. The numbers of any capturing buffers that follow the sub- | |
| 4046 | pattern start after the highest number used in any branch. The follow- | |
| 4047 | ing example is taken from the Perl documentation. The numbers under- | |
| 4048 | neath show in which buffer the captured content will be stored. | |
| 4049 | ||
| 4050 | # before ---------------branch-reset----------- after | |
| 4051 | / ( a ) (?| x ( y ) z | (p (q) r) | (t) u (v) ) ( z ) /x | |
| 4052 | # 1 2 2 3 2 3 4 | |
| 4053 | ||
| 4054 | A backreference to a numbered subpattern uses the most recent value | |
| 4055 | that is set for that number by any subpattern. The following pattern | |
| 4056 | matches "abcabc" or "defdef": | |
| 4057 | ||
| 4058 | /(?|(abc)|(def))\1/ | |
| 4059 | ||
| 4060 | In contrast, a recursive or "subroutine" call to a numbered subpattern | |
| 4061 | always refers to the first one in the pattern with the given number. | |
| 4062 | The following pattern matches "abcabc" or "defabc": | |
| 4063 | ||
| 4064 | /(?|(abc)|(def))(?1)/ | |
| 4065 | ||
| 4066 | If a condition test for a subpattern's having matched refers to a non- | |
| 4067 | unique number, the test is true if any of the subpatterns of that num- | |
| 4068 | ber have matched. | |
| 4069 | ||
| 4070 | An alternative approach to using this "branch reset" feature is to use | |
| 4071 | duplicate named subpatterns, as described in the next section. | |
| 4072 | ||
| 4073 | ||
| 4074 | NAMED SUBPATTERNS | NAMED SUBPATTERNS |
| 4075 | ||
| 4076 | Identifying capturing parentheses by number is simple, but it can be | Identifying capturing parentheses by number is simple, but it can be |
| 4077 | very hard to keep track of the numbers in complicated regular expres- | very hard to keep track of the numbers in complicated regular expres- |
| 4078 | sions. Furthermore, if an expression is modified, the numbers may | sions. Furthermore, if an expression is modified, the numbers may |
| 4079 | change. To help with this difficulty, PCRE supports the naming of sub- | change. To help with this difficulty, PCRE supports the naming of sub- |
| 4080 | patterns. This feature was not added to Perl until release 5.10. Python | patterns. This feature was not added to Perl until release 5.10. Python |
| 4081 | had the feature earlier, and PCRE introduced it at release 4.0, using | had the feature earlier, and PCRE introduced it at release 4.0, using |
| 4082 | the Python syntax. PCRE now supports both the Perl and the Python syn- | the Python syntax. PCRE now supports both the Perl and the Python syn- |
| 4083 | tax. | tax. Perl allows identically numbered subpatterns to have different |
| 4084 | names, but PCRE does not. | |
| 4085 | ||
| 4086 | In PCRE, a subpattern can be named in one of three ways: (?<name>...) | In PCRE, a subpattern can be named in one of three ways: (?<name>...) |
| 4087 | or (?'name'...) as in Perl, or (?P<name>...) as in Python. References | or (?'name'...) as in Perl, or (?P<name>...) as in Python. References |
| # | Line 3563 NAMED SUBPATTERNS | Line 4098 NAMED SUBPATTERNS |
| 4098 | ||
| 4099 | By default, a name must be unique within a pattern, but it is possible | By default, a name must be unique within a pattern, but it is possible |
| 4100 | to relax this constraint by setting the PCRE_DUPNAMES option at compile | to relax this constraint by setting the PCRE_DUPNAMES option at compile |
| 4101 | time. This can be useful for patterns where only one instance of the | time. (Duplicate names are also always permitted for subpatterns with |
| 4102 | the same number, set up as described in the previous section.) Dupli- | |
| 4103 | cate names can be useful for patterns where only one instance of the | |
| 4104 | named parentheses can match. Suppose you want to match the name of a | named parentheses can match. Suppose you want to match the name of a |
| 4105 | weekday, either as a 3-letter abbreviation or as the full name, and in | weekday, either as a 3-letter abbreviation or as the full name, and in |
| 4106 | both cases you want to extract the abbreviation. This pattern (ignoring | both cases you want to extract the abbreviation. This pattern (ignoring |
| # | Line 3576 NAMED SUBPATTERNS | Line 4113 NAMED SUBPATTERNS |
| 4113 | (?<DN>Sat)(?:urday)? | (?<DN>Sat)(?:urday)? |
| 4114 | ||
| 4115 | There are five capturing substrings, but only one is ever set after a | There are five capturing substrings, but only one is ever set after a |
| 4116 | match. The convenience function for extracting the data by name | match. (An alternative way of solving this problem is to use a "branch |
| 4117 | returns the substring for the first (and in this example, the only) | reset" subpattern, as described in the previous section.) |
| 4118 | subpattern of that name that matched. This saves searching to find | |
| 4119 | which numbered subpattern it was. If you make a reference to a non- | The convenience function for extracting the data by name returns the |
| 4120 | unique named subpattern from elsewhere in the pattern, the one that | substring for the first (and in this example, the only) subpattern of |
| 4121 | corresponds to the lowest number is used. For further details of the | that name that matched. This saves searching to find which numbered |
| 4122 | interfaces for handling named subpatterns, see the pcreapi documenta- | subpattern it was. |
| 4123 | tion. | |
| 4124 | If you make a backreference to a non-unique named subpattern from else- | |
| 4125 | where in the pattern, the one that corresponds to the first occurrence | |
| 4126 | of the name is used. In the absence of duplicate numbers (see the pre- | |
| 4127 | vious section) this is the one with the lowest number. If you use a | |
| 4128 | named reference in a condition test (see the section about conditions | |
| 4129 | below), either to check whether a subpattern has matched, or to check | |
| 4130 | for recursion, all subpatterns with the same name are tested. If the | |
| 4131 | condition is true for any one of them, the overall condition is true. | |
| 4132 | This is the same behaviour as testing by number. For further details of | |
| 4133 | the interfaces for handling named subpatterns, see the pcreapi documen- | |
| 4134 | tation. | |
| 4135 | ||
| 4136 | Warning: You cannot use different names to distinguish between two sub- | |
| 4137 | patterns with the same number because PCRE uses only the numbers when | |
| 4138 | matching. For this reason, an error is given at compile time if differ- | |
| 4139 | ent names are given to subpatterns with the same number. However, you | |
| 4140 | can give the same name to subpatterns with the same number, even when | |
| 4141 | PCRE_DUPNAMES is not set. | |
| 4142 | ||
| 4143 | ||
| 4144 | REPETITION | REPETITION |
| # | Line 3600 REPETITION | Line 4155 REPETITION |
| 4155 | a character class | a character class |
| 4156 | a back reference (see next section) | a back reference (see next section) |
| 4157 | a parenthesized subpattern (unless it is an assertion) | a parenthesized subpattern (unless it is an assertion) |
| 4158 | a recursive or "subroutine" call to a subpattern | |
| 4159 | ||
| 4160 | The general repetition quantifier specifies a minimum and maximum num- | The general repetition quantifier specifies a minimum and maximum num- |
| 4161 | ber of permitted matches, by giving the two numbers in curly brackets | ber of permitted matches, by giving the two numbers in curly brackets |
| # | Line 3625 REPETITION | Line 4181 REPETITION |
| 4181 | the syntax of a quantifier, is taken as a literal character. For exam- | the syntax of a quantifier, is taken as a literal character. For exam- |
| 4182 | ple, {,6} is not a quantifier, but a literal string of four characters. | ple, {,6} is not a quantifier, but a literal string of four characters. |
| 4183 | ||
| 4184 | In UTF-8 mode, quantifiers apply to UTF-8 characters rather than to | In UTF-8 mode, quantifiers apply to UTF-8 characters rather than to |
| 4185 | individual bytes. Thus, for example, \x{100}{2} matches two UTF-8 char- | individual bytes. Thus, for example, \x{100}{2} matches two UTF-8 char- |
| 4186 | acters, each of which is represented by a two-byte sequence. Similarly, | acters, each of which is represented by a two-byte sequence. Similarly, |
| 4187 | when Unicode property support is available, \X{3} matches three Unicode | when Unicode property support is available, \X{3} matches three Unicode |
| 4188 | extended sequences, each of which may be several bytes long (and they | extended sequences, each of which may be several bytes long (and they |
| 4189 | may be of different lengths). | may be of different lengths). |
| 4190 | ||
| 4191 | The quantifier {0} is permitted, causing the expression to behave as if | The quantifier {0} is permitted, causing the expression to behave as if |
| 4192 | the previous item and the quantifier were not present. | the previous item and the quantifier were not present. This may be use- |
| 4193 | ful for subpatterns that are referenced as subroutines from elsewhere | |
| 4194 | in the pattern. Items other than subpatterns that have a {0} quantifier | |
| 4195 | are omitted from the compiled pattern. | |
| 4196 | ||
| 4197 | For convenience, the three most common quantifiers have single-charac- | For convenience, the three most common quantifiers have single-charac- |
| 4198 | ter abbreviations: | ter abbreviations: |
| # | Line 3763 ATOMIC GROUPING AND POSSESSIVE QUANTIFIE | Line 4322 ATOMIC GROUPING AND POSSESSIVE QUANTIFIE |
| 4322 | ||
| 4323 | (?>\d+)foo | (?>\d+)foo |
| 4324 | ||
| 4325 | This kind of parenthesis "locks up" the part of the pattern it con- | This kind of parenthesis "locks up" the part of the pattern it con- |
| 4326 | tains once it has matched, and a failure further into the pattern is | tains once it has matched, and a failure further into the pattern is |
| 4327 | prevented from backtracking into it. Backtracking past it to previous | prevented from backtracking into it. Backtracking past it to previous |
| 4328 | items, however, works as normal. | items, however, works as normal. |
| 4329 | ||
| 4330 | An alternative description is that a subpattern of this type matches | An alternative description is that a subpattern of this type matches |
| 4331 | the string of characters that an identical standalone pattern would | the string of characters that an identical standalone pattern would |
| 4332 | match, if anchored at the current point in the subject string. | match, if anchored at the current point in the subject string. |
| 4333 | ||
| 4334 | Atomic grouping subpatterns are not capturing subpatterns. Simple cases | Atomic grouping subpatterns are not capturing subpatterns. Simple cases |
| 4335 | such as the above example can be thought of as a maximizing repeat that | such as the above example can be thought of as a maximizing repeat that |
| 4336 | must swallow everything it can. So, while both \d+ and \d+? are pre- | must swallow everything it can. So, while both \d+ and \d+? are pre- |
| 4337 | pared to adjust the number of digits they match in order to make the | pared to adjust the number of digits they match in order to make the |
| 4338 | rest of the pattern match, (?>\d+) can only match an entire sequence of | rest of the pattern match, (?>\d+) can only match an entire sequence of |
| 4339 | digits. | digits. |
| 4340 | ||
| 4341 | Atomic groups in general can of course contain arbitrarily complicated | Atomic groups in general can of course contain arbitrarily complicated |
| 4342 | subpatterns, and can be nested. However, when the subpattern for an | subpatterns, and can be nested. However, when the subpattern for an |
| 4343 | atomic group is just a single repeated item, as in the example above, a | atomic group is just a single repeated item, as in the example above, a |
| 4344 | simpler notation, called a "possessive quantifier" can be used. This | simpler notation, called a "possessive quantifier" can be used. This |
| 4345 | consists of an additional + character following a quantifier. Using | consists of an additional + character following a quantifier. Using |
| 4346 | this notation, the previous example can be rewritten as | this notation, the previous example can be rewritten as |
| 4347 | ||
| 4348 | \d++foo | \d++foo |
| 4349 | ||
| 4350 | Note that a possessive quantifier can be used with an entire group, for | |
| 4351 | example: | |
| 4352 | ||
| 4353 | (abc|xyz){2,3}+ | |
| 4354 | ||
| 4355 | Possessive quantifiers are always greedy; the setting of the | Possessive quantifiers are always greedy; the setting of the |
| 4356 | PCRE_UNGREEDY option is ignored. They are a convenient notation for the | PCRE_UNGREEDY option is ignored. They are a convenient notation for the |
| 4357 | simpler forms of atomic group. However, there is no difference in the | simpler forms of atomic group. However, there is no difference in the |
| # | Line 3831 ATOMIC GROUPING AND POSSESSIVE QUANTIFIE | Line 4395 ATOMIC GROUPING AND POSSESSIVE QUANTIFIE |
| 4395 | ||
| 4396 | ((?>\D+)|<\d+>)*[!?] | ((?>\D+)|<\d+>)*[!?] |
| 4397 | ||
| 4398 | sequences of non-digits cannot be broken, and failure happens quickly. | sequences of non-digits cannot be broken, and failure happens quickly. |
| 4399 | ||
| 4400 | ||
| 4401 | BACK REFERENCES | BACK REFERENCES |
| 4402 | ||
| 4403 | Outside a character class, a backslash followed by a digit greater than | Outside a character class, a backslash followed by a digit greater than |
| 4404 | 0 (and possibly further digits) is a back reference to a capturing sub- | 0 (and possibly further digits) is a back reference to a capturing sub- |
| 4405 | pattern earlier (that is, to its left) in the pattern, provided there | pattern earlier (that is, to its left) in the pattern, provided there |
| 4406 | have been that many previous capturing left parentheses. | have been that many previous capturing left parentheses. |
| 4407 | ||
| 4408 | However, if the decimal number following the backslash is less than 10, | However, if the decimal number following the backslash is less than 10, |
| 4409 | it is always taken as a back reference, and causes an error only if | it is always taken as a back reference, and causes an error only if |
| 4410 | there are not that many capturing left parentheses in the entire pat- | there are not that many capturing left parentheses in the entire pat- |
| 4411 | tern. In other words, the parentheses that are referenced need not be | tern. In other words, the parentheses that are referenced need not be |
| 4412 | to the left of the reference for numbers less than 10. A "forward back | to the left of the reference for numbers less than 10. A "forward back |
| 4413 | reference" of this type can make sense when a repetition is involved | reference" of this type can make sense when a repetition is involved |
| 4414 | and the subpattern to the right has participated in an earlier itera- | and the subpattern to the right has participated in an earlier itera- |
| 4415 | tion. | tion. |
| 4416 | ||
| 4417 | It is not possible to have a numerical "forward back reference" to a | It is not possible to have a numerical "forward back reference" to a |
| 4418 | subpattern whose number is 10 or more using this syntax because a | subpattern whose number is 10 or more using this syntax because a |
| 4419 | sequence such as \50 is interpreted as a character defined in octal. | sequence such as \50 is interpreted as a character defined in octal. |
| 4420 | See the subsection entitled "Non-printing characters" above for further | See the subsection entitled "Non-printing characters" above for further |
| 4421 | details of the handling of digits following a backslash. There is no | details of the handling of digits following a backslash. There is no |
| 4422 | such problem when named parentheses are used. A back reference to any | such problem when named parentheses are used. A back reference to any |
| 4423 | subpattern is possible using named parentheses (see below). | subpattern is possible using named parentheses (see below). |
| 4424 | ||
| 4425 | Another way of avoiding the ambiguity inherent in the use of digits | Another way of avoiding the ambiguity inherent in the use of digits |
| 4426 | following a backslash is to use the \g escape sequence, which is a fea- | following a backslash is to use the \g escape sequence, which is a fea- |
| 4427 | ture introduced in Perl 5.10. This escape must be followed by a posi- | ture introduced in Perl 5.10. This escape must be followed by an |
| 4428 | tive or a negative number, optionally enclosed in braces. These exam- | unsigned number or a negative number, optionally enclosed in braces. |
| 4429 | ples are all identical: | These examples are all identical: |
| 4430 | ||
| 4431 | (ring), \1 | (ring), \1 |
| 4432 | (ring), \g1 | (ring), \g1 |
| 4433 | (ring), \g{1} | (ring), \g{1} |
| 4434 | ||
| 4435 | A positive number specifies an absolute reference without the ambiguity | An unsigned number specifies an absolute reference without the ambigu- |
| 4436 | that is present in the older syntax. It is also useful when literal | ity that is present in the older syntax. It is also useful when literal |
| 4437 | digits follow the reference. A negative number is a relative reference. | digits follow the reference. A negative number is a relative reference. |
| 4438 | Consider this example: | Consider this example: |
| 4439 | ||
| 4440 | (abc(def)ghi)\g{-1} | (abc(def)ghi)\g{-1} |
| 4441 | ||
| 4442 | The sequence \g{-1} is a reference to the most recently started captur- | The sequence \g{-1} is a reference to the most recently started captur- |
| 4443 | ing subpattern before \g, that is, is it equivalent to \2. Similarly, | ing subpattern before \g, that is, is it equivalent to \2. Similarly, |
| 4444 | \g{-2} would be equivalent to \1. The use of relative references can be | \g{-2} would be equivalent to \1. The use of relative references can be |
| 4445 | helpful in long patterns, and also in patterns that are created by | helpful in long patterns, and also in patterns that are created by |
| 4446 | joining together fragments that contain references within themselves. | joining together fragments that contain references within themselves. |
| 4447 | ||
| 4448 | A back reference matches whatever actually matched the capturing sub- | A back reference matches whatever actually matched the capturing sub- |
| 4449 | pattern in the current subject string, rather than anything matching | pattern in the current subject string, rather than anything matching |
| 4450 | the subpattern itself (see "Subpatterns as subroutines" below for a way | the subpattern itself (see "Subpatterns as subroutines" below for a way |
| 4451 | of doing that). So the pattern | of doing that). So the pattern |
| 4452 | ||
| 4453 | (sens|respons)e and \1ibility | (sens|respons)e and \1ibility |
| 4454 | ||
| 4455 | matches "sense and sensibility" and "response and responsibility", but | matches "sense and sensibility" and "response and responsibility", but |
| 4456 | not "sense and responsibility". If caseful matching is in force at the | not "sense and responsibility". If caseful matching is in force at the |
| 4457 | time of the back reference, the case of letters is relevant. For exam- | time of the back reference, the case of letters is relevant. For exam- |
| 4458 | ple, | ple, |
| 4459 | ||
| 4460 | ((?i)rah)\s+\1 | ((?i)rah)\s+\1 |
| 4461 | ||
| 4462 | matches "rah rah" and "RAH RAH", but not "RAH rah", even though the | matches "rah rah" and "RAH RAH", but not "RAH rah", even though the |
| 4463 | original capturing subpattern is matched caselessly. | original capturing subpattern is matched caselessly. |
| 4464 | ||
| 4465 | There are several different ways of writing back references to named | There are several different ways of writing back references to named |
| 4466 | subpatterns. The .NET syntax \k{name} and the Perl syntax \k<name> or | subpatterns. The .NET syntax \k{name} and the Perl syntax \k<name> or |
| 4467 | \k'name' are supported, as is the Python syntax (?P=name). Perl 5.10's | \k'name' are supported, as is the Python syntax (?P=name). Perl 5.10's |
| 4468 | unified back reference syntax, in which \g can be used for both numeric | unified back reference syntax, in which \g can be used for both numeric |
| 4469 | and named references, is also supported. We could rewrite the above | and named references, is also supported. We could rewrite the above |
| 4470 | example in any of the following ways: | example in any of the following ways: |
| 4471 | ||
| 4472 | (?<p1>(?i)rah)\s+\k<p1> | (?<p1>(?i)rah)\s+\k<p1> |
| # | Line 3910 BACK REFERENCES | Line 4474 BACK REFERENCES |
| 4474 | (?P<p1>(?i)rah)\s+(?P=p1) | (?P<p1>(?i)rah)\s+(?P=p1) |
| 4475 | (?<p1>(?i)rah)\s+\g{p1} | (?<p1>(?i)rah)\s+\g{p1} |
| 4476 | ||
| 4477 | A subpattern that is referenced by name may appear in the pattern | A subpattern that is referenced by name may appear in the pattern |
| 4478 | before or after the reference. | before or after the reference. |
| 4479 | ||
| 4480 | There may be more than one back reference to the same subpattern. If a | There may be more than one back reference to the same subpattern. If a |
| 4481 | subpattern has not actually been used in a particular match, any back | subpattern has not actually been used in a particular match, any back |
| 4482 | references to it always fail. For example, the pattern | references to it always fail by default. For example, the pattern |
| 4483 | ||
| 4484 | (a|(bc))\2 | (a|(bc))\2 |
| 4485 | ||
| 4486 | always fails if it starts to match "a" rather than "bc". Because there | always fails if it starts to match "a" rather than "bc". However, if |
| 4487 | may be many capturing parentheses in a pattern, all digits following | the PCRE_JAVASCRIPT_COMPAT option is set at compile time, a back refer- |
| 4488 | the backslash are taken as part of a potential back reference number. | ence to an unset value matches an empty string. |
| 4489 | If the pattern continues with a digit character, some delimiter must be | |
| 4490 | used to terminate the back reference. If the PCRE_EXTENDED option is | Because there may be many capturing parentheses in a pattern, all dig- |
| 4491 | set, this can be whitespace. Otherwise an empty comment (see "Com- | its following a backslash are taken as part of a potential back refer- |
| 4492 | ments" below) can be used. | ence number. If the pattern continues with a digit character, some |
| 4493 | delimiter must be used to terminate the back reference. If the | |
| 4494 | PCRE_EXTENDED option is set, this can be whitespace. Otherwise, the \g{ | |
| 4495 | syntax or an empty comment (see "Comments" below) can be used. | |
| 4496 | ||
| 4497 | A back reference that occurs inside the parentheses to which it refers | A back reference that occurs inside the parentheses to which it refers |
| 4498 | fails when the subpattern is first used, so, for example, (a\1) never | fails when the subpattern is first used, so, for example, (a\1) never |
| # | Line 3988 ASSERTIONS | Line 4555 ASSERTIONS |
| 4555 | If you want to force a matching failure at some point in a pattern, the | If you want to force a matching failure at some point in a pattern, the |
| 4556 | most convenient way to do it is with (?!) because an empty string | most convenient way to do it is with (?!) because an empty string |
| 4557 | always matches, so an assertion that requires there not to be an empty | always matches, so an assertion that requires there not to be an empty |
| 4558 | string must always fail. | string must always fail. The Perl 5.10 backtracking control verb |
| 4559 | (*FAIL) or (*F) is essentially a synonym for (?!). | |
| 4560 | ||
| 4561 | Lookbehind assertions | Lookbehind assertions |
| 4562 | ||
| 4563 | Lookbehind assertions start with (?<= for positive assertions and (?<! | Lookbehind assertions start with (?<= for positive assertions and (?<! |
| 4564 | for negative assertions. For example, | for negative assertions. For example, |
| 4565 | ||
| 4566 | (?<!foo)bar | (?<!foo)bar |
| 4567 | ||
| 4568 | does find an occurrence of "bar" that is not preceded by "foo". The | does find an occurrence of "bar" that is not preceded by "foo". The |
| 4569 | contents of a lookbehind assertion are restricted such that all the | contents of a lookbehind assertion are restricted such that all the |
| 4570 | strings it matches must have a fixed length. However, if there are sev- | strings it matches must have a fixed length. However, if there are sev- |
| 4571 | eral top-level alternatives, they do not all have to have the same | eral top-level alternatives, they do not all have to have the same |
| 4572 | fixed length. Thus | fixed length. Thus |
| 4573 | ||
| 4574 | (?<=bullock|donkey) | (?<=bullock|donkey) |
| # | Line 4009 ASSERTIONS | Line 4577 ASSERTIONS |
| 4577 | ||
| 4578 | (?<!dogs?|cats?) | (?<!dogs?|cats?) |
| 4579 | ||
| 4580 | causes an error at compile time. Branches that match different length | causes an error at compile time. Branches that match different length |
| 4581 | strings are permitted only at the top level of a lookbehind assertion. | strings are permitted only at the top level of a lookbehind assertion. |
| 4582 | This is an extension compared with Perl (at least for 5.8), which | This is an extension compared with Perl (5.8 and 5.10), which requires |
| 4583 | requires all branches to match the same length of string. An assertion | all branches to match the same length of string. An assertion such as |
| such as | ||
| 4584 | ||
| 4585 | (?<=ab(c|de)) | (?<=ab(c|de)) |
| 4586 | ||
| 4587 | is not permitted, because its single top-level branch can match two | is not permitted, because its single top-level branch can match two |
| 4588 | different lengths, but it is acceptable if rewritten to use two top- | different lengths, but it is acceptable to PCRE if rewritten to use two |
| 4589 | level branches: | top-level branches: |
| 4590 | ||
| 4591 | (?<=abc|abde) | (?<=abc|abde) |
| 4592 | ||
| 4593 | In some cases, the Perl 5.10 escape sequence \K (see above) can be used | In some cases, the Perl 5.10 escape sequence \K (see above) can be used |
| 4594 | instead of a lookbehind assertion; this is not restricted to a fixed- | instead of a lookbehind assertion to get round the fixed-length |
| 4595 | length. | restriction. |
| 4596 | ||
| 4597 | The implementation of lookbehind assertions is, for each alternative, | The implementation of lookbehind assertions is, for each alternative, |
| 4598 | to temporarily move the current position back by the fixed length and | to temporarily move the current position back by the fixed length and |
| # | Line 4037 ASSERTIONS | Line 4604 ASSERTIONS |
| 4604 | ble to calculate the length of the lookbehind. The \X and \R escapes, | ble to calculate the length of the lookbehind. The \X and \R escapes, |
| 4605 | which can match different numbers of bytes, are also not permitted. | which can match different numbers of bytes, are also not permitted. |
| 4606 | ||
| 4607 | "Subroutine" calls (see below) such as (?2) or (?&X) are permitted in | |
| 4608 | lookbehinds, as long as the subpattern matches a fixed-length string. | |
| 4609 | Recursion, however, is not supported. | |
| 4610 | ||
| 4611 | Possessive quantifiers can be used in conjunction with lookbehind | Possessive quantifiers can be used in conjunction with lookbehind |
| 4612 | assertions to specify efficient matching at the end of the subject | assertions to specify efficient matching of fixed-length strings at the |
| 4613 | string. Consider a simple pattern such as | end of subject strings. Consider a simple pattern such as |
| 4614 | ||
| 4615 | abcd$ | abcd$ |
| 4616 | ||
| # | Line 4102 CONDITIONAL SUBPATTERNS | Line 4673 CONDITIONAL SUBPATTERNS |
| 4673 | ||
| 4674 | It is possible to cause the matching process to obey a subpattern con- | It is possible to cause the matching process to obey a subpattern con- |
| 4675 | ditionally or to choose between two alternative subpatterns, depending | ditionally or to choose between two alternative subpatterns, depending |
| 4676 | on the result of an assertion, or whether a previous capturing subpat- | on the result of an assertion, or whether a specific capturing subpat- |
| 4677 | tern matched or not. The two possible forms of conditional subpattern | tern has already been matched. The two possible forms of conditional |
| 4678 | are | subpattern are: |
| 4679 | ||
| 4680 | (?(condition)yes-pattern) | (?(condition)yes-pattern) |
| 4681 | (?(condition)yes-pattern|no-pattern) | (?(condition)yes-pattern|no-pattern) |
| # | Line 4119 CONDITIONAL SUBPATTERNS | Line 4690 CONDITIONAL SUBPATTERNS |
| 4690 | Checking for a used subpattern by number | Checking for a used subpattern by number |
| 4691 | ||
| 4692 | If the text between the parentheses consists of a sequence of digits, | If the text between the parentheses consists of a sequence of digits, |
| 4693 | the condition is true if the capturing subpattern of that number has | the condition is true if a capturing subpattern of that number has pre- |
| 4694 | previously matched. An alternative notation is to precede the digits | viously matched. If there is more than one capturing subpattern with |
| 4695 | with a plus or minus sign. In this case, the subpattern number is rela- | the same number (see the earlier section about duplicate subpattern |
| 4696 | tive rather than absolute. The most recently opened parentheses can be | numbers), the condition is true if any of them have been set. An alter- |
| 4697 | referenced by (?(-1), the next most recent by (?(-2), and so on. In | native notation is to precede the digits with a plus or minus sign. In |
| 4698 | looping constructs it can also make sense to refer to subsequent groups | this case, the subpattern number is relative rather than absolute. The |
| 4699 | with constructs such as (?(+2). | most recently opened parentheses can be referenced by (?(-1), the next |
| 4700 | most recent by (?(-2), and so on. In looping constructs it can also | |
| 4701 | make sense to refer to subsequent groups with constructs such as | |
| 4702 | (?(+2). | |
| 4703 | ||
| 4704 | Consider the following pattern, which contains non-significant white | Consider the following pattern, which contains non-significant white |
| 4705 | space to make it more readable (assume the PCRE_EXTENDED option) and to | space to make it more readable (assume the PCRE_EXTENDED option) and to |
| 4706 | divide it into three parts for ease of discussion: | divide it into three parts for ease of discussion: |
| 4707 | ||
| 4708 | ( \( )? [^()]+ (?(1) \) ) | ( \( )? [^()]+ (?(1) \) ) |
| 4709 | ||
| 4710 | The first part matches an optional opening parenthesis, and if that | The first part matches an optional opening parenthesis, and if that |
| 4711 | character is present, sets it as the first captured substring. The sec- | character is present, sets it as the first captured substring. The sec- |
| 4712 | ond part matches one or more characters that are not parentheses. The | ond part matches one or more characters that are not parentheses. The |
| 4713 | third part is a conditional subpattern that tests whether the first set | third part is a conditional subpattern that tests whether the first set |
| 4714 | of parentheses matched or not. If they did, that is, if subject started | of parentheses matched or not. If they did, that is, if subject started |
| 4715 | with an opening parenthesis, the condition is true, and so the yes-pat- | with an opening parenthesis, the condition is true, and so the yes-pat- |
| 4716 | tern is executed and a closing parenthesis is required. Otherwise, |