45 |
|
|
46 |
Details of exactly which Perl regular expression features are and are |
Details of exactly which Perl regular expression features are and are |
47 |
not supported by PCRE are given in separate documents. See the pcrepat- |
not supported by PCRE are given in separate documents. See the pcrepat- |
48 |
tern and pcrecompat pages. |
tern and pcrecompat pages. There is a syntax summary in the pcresyntax |
49 |
|
page. |
50 |
|
|
51 |
Some features of PCRE can be included, excluded, or changed when the |
Some features of PCRE can be included, excluded, or changed when the |
52 |
library is built. The pcre_config() function makes it possible for a |
library is built. The pcre_config() function makes it possible for a |
53 |
client to discover which features are available. The features them- |
client to discover which features are available. The features them- |
54 |
selves are described in the pcrebuild page. Documentation about build- |
selves are described in the pcrebuild page. Documentation about build- |
55 |
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 file |
56 |
in the source distribution. |
in the source distribution. |
57 |
|
|
58 |
The library contains a number of undocumented internal functions and |
The library contains a number of undocumented internal functions and |
59 |
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 |
60 |
functions, but which are not intended for use by external callers. |
functions, but which are not intended for use by external callers. |
61 |
Their names all begin with "_pcre_", which hopefully will not provoke |
Their names all begin with "_pcre_", which hopefully will not provoke |
62 |
any name clashes. In some environments, it is possible to control which |
any name clashes. In some environments, it is possible to control which |
63 |
external symbols are exported when a shared library is built, and in |
external symbols are exported when a shared library is built, and in |
64 |
these cases the undocumented symbols are not exported. |
these cases the undocumented symbols are not exported. |
65 |
|
|
66 |
|
|
67 |
USER DOCUMENTATION |
USER DOCUMENTATION |
68 |
|
|
69 |
The user documentation for PCRE comprises a number of different sec- |
The user documentation for PCRE comprises a number of different sec- |
70 |
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 |
71 |
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. |
72 |
In the plain text format, all the sections are concatenated, for ease |
In the plain text format, all the sections are concatenated, for ease |
73 |
of searching. The sections are as follows: |
of searching. The sections are as follows: |
74 |
|
|
75 |
pcre this document |
pcre this document |
84 |
pcrepartial details of the partial matching facility |
pcrepartial details of the partial matching facility |
85 |
pcrepattern syntax and semantics of supported |
pcrepattern syntax and semantics of supported |
86 |
regular expressions |
regular expressions |
87 |
|
pcresyntax quick syntax reference |
88 |
pcreperform discussion of performance issues |
pcreperform discussion of performance issues |
89 |
pcreposix the POSIX-compatible C API |
pcreposix the POSIX-compatible C API |
90 |
pcreprecompile details of saving and re-using precompiled patterns |
pcreprecompile details of saving and re-using precompiled patterns |
92 |
pcrestack discussion of stack usage |
pcrestack discussion of stack usage |
93 |
pcretest description of the pcretest testing command |
pcretest description of the pcretest testing command |
94 |
|
|
95 |
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 |
96 |
each C library function, listing its arguments and results. |
each C library function, listing its arguments and results. |
97 |
|
|
98 |
|
|
99 |
LIMITATIONS |
LIMITATIONS |
100 |
|
|
101 |
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 |
102 |
never in practice be relevant. |
never in practice be relevant. |
103 |
|
|
104 |
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 |
105 |
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 |
106 |
process regular expressions that are truly enormous, you can compile |
process regular expressions that are truly enormous, you can compile |
107 |
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 |
108 |
the source distribution and the pcrebuild documentation for details). |
the source distribution and the pcrebuild documentation for details). |
109 |
In these cases the limit is substantially larger. However, the speed |
In these cases the limit is substantially larger. However, the speed |
110 |
of execution is slower. |
of execution is slower. |
111 |
|
|
112 |
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. |
|
113 |
|
|
114 |
There is no limit to the number of parenthesized subpatterns, but there |
There is no limit to the number of parenthesized subpatterns, but there |
115 |
can be no more than 65535 capturing subpatterns. |
can be no more than 65535 capturing subpatterns. |
117 |
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 |
118 |
the maximum number of named subpatterns is 10000. |
the maximum number of named subpatterns is 10000. |
119 |
|
|
120 |
The maximum length of a subject string is the largest positive number |
The maximum length of a subject string is the largest positive number |
121 |
that an integer variable can hold. However, when using the traditional |
that an integer variable can hold. However, when using the traditional |
122 |
matching function, PCRE uses recursion to handle subpatterns and indef- |
matching function, PCRE uses recursion to handle subpatterns and indef- |
123 |
inite repetition. This means that the available stack space may limit |
inite repetition. This means that the available stack space may limit |
124 |
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. |
125 |
For a discussion of stack issues, see the pcrestack documentation. |
For a discussion of stack issues, see the pcrestack documentation. |
126 |
|
|
127 |
|
|
128 |
UTF-8 AND UNICODE PROPERTY SUPPORT |
UTF-8 AND UNICODE PROPERTY SUPPORT |
129 |
|
|
130 |
From release 3.3, PCRE has had some support for character strings |
From release 3.3, PCRE has had some support for character strings |
131 |
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 |
132 |
to cover most common requirements, and in release 5.0 additional sup- |
to cover most common requirements, and in release 5.0 additional sup- |
133 |
port for Unicode general category properties was added. |
port for Unicode general category properties was added. |
134 |
|
|
135 |
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 |
136 |
support in the code, and, in addition, you must call pcre_compile() |
support in the code, and, in addition, you must call pcre_compile() |
137 |
with the PCRE_UTF8 option flag. When you do this, both the pattern and |
with the PCRE_UTF8 option flag. When you do this, both the pattern and |
138 |
any subject strings that are matched against it are treated as UTF-8 |
any subject strings that are matched against it are treated as UTF-8 |
139 |
strings instead of just strings of bytes. |
strings instead of just strings of bytes. |
140 |
|
|
141 |
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, |
142 |
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 |
143 |
is limited to testing the PCRE_UTF8 flag occasionally, so should not be |
is limited to testing the PCRE_UTF8 flag occasionally, so should not be |
144 |
very big. |
very big. |
145 |
|
|
146 |
If PCRE is built with Unicode character property support (which implies |
If PCRE is built with Unicode character property support (which implies |
147 |
UTF-8 support), the escape sequences \p{..}, \P{..}, and \X are sup- |
UTF-8 support), the escape sequences \p{..}, \P{..}, and \X are sup- |
148 |
ported. The available properties that can be tested are limited to the |
ported. The available properties that can be tested are limited to the |
149 |
general category properties such as Lu for an upper case letter or Nd |
general category properties such as Lu for an upper case letter or Nd |
150 |
for a decimal number, the Unicode script names such as Arabic or Han, |
for a decimal number, the Unicode script names such as Arabic or Han, |
151 |
and the derived properties Any and L&. A full list is given in the |
and the derived properties Any and L&. A full list is given in the |
152 |
pcrepattern documentation. Only the short names for properties are sup- |
pcrepattern documentation. Only the short names for properties are sup- |
153 |
ported. For example, \p{L} matches a letter. Its Perl synonym, \p{Let- |
ported. For example, \p{L} matches a letter. Its Perl synonym, \p{Let- |
154 |
ter}, is not supported. Furthermore, in Perl, many properties may |
ter}, is not supported. Furthermore, in Perl, many properties may |
155 |
optionally be prefixed by "Is", for compatibility with Perl 5.6. PCRE |
optionally be prefixed by "Is", for compatibility with Perl 5.6. PCRE |
156 |
does not support this. |
does not support this. |
157 |
|
|
158 |
The following comments apply when PCRE is running in UTF-8 mode: |
Validity of UTF-8 strings |
159 |
|
|
160 |
|
When you set the PCRE_UTF8 flag, the strings passed as patterns and |
161 |
|
subjects are (by default) checked for validity on entry to the relevant |
162 |
|
functions. From release 7.3 of PCRE, the check is according the rules |
163 |
|
of RFC 3629, which are themselves derived from the Unicode specifica- |
164 |
|
tion. Earlier releases of PCRE followed the rules of RFC 2279, which |
165 |
|
allows the full range of 31-bit values (0 to 0x7FFFFFFF). The current |
166 |
|
check allows only values in the range U+0 to U+10FFFF, excluding U+D800 |
167 |
|
to U+DFFF. |
168 |
|
|
169 |
|
The excluded code points are the "Low Surrogate Area" of Unicode, of |
170 |
|
which the Unicode Standard says this: "The Low Surrogate Area does not |
171 |
|
contain any character assignments, consequently no character code |
172 |
|
charts or namelists are provided for this area. Surrogates are reserved |
173 |
|
for use with UTF-16 and then must be used in pairs." The code points |
174 |
|
that are encoded by UTF-16 pairs are available as independent code |
175 |
|
points in the UTF-8 encoding. (In other words, the whole surrogate |
176 |
|
thing is a fudge for UTF-16 which unfortunately messes up UTF-8.) |
177 |
|
|
178 |
|
If an invalid UTF-8 string is passed to PCRE, an error return |
179 |
|
(PCRE_ERROR_BADUTF8) is given. In some situations, you may already know |
180 |
|
that your strings are valid, and therefore want to skip these checks in |
181 |
|
order to improve performance. If you set the PCRE_NO_UTF8_CHECK flag at |
182 |
|
compile time or at run time, PCRE assumes that the pattern or subject |
183 |
|
it is given (respectively) contains only valid UTF-8 codes. In this |
184 |
|
case, it does not diagnose an invalid UTF-8 string. |
185 |
|
|
186 |
|
If you pass an invalid UTF-8 string when PCRE_NO_UTF8_CHECK is set, |
187 |
|
what happens depends on why the string is invalid. If the string con- |
188 |
|
forms to the "old" definition of UTF-8 (RFC 2279), it is processed as a |
189 |
|
string of characters in the range 0 to 0x7FFFFFFF. In other words, |
190 |
|
apart from the initial validity test, PCRE (when in UTF-8 mode) handles |
191 |
|
strings according to the more liberal rules of RFC 2279. However, if |
192 |
|
the string does not even conform to RFC 2279, the result is undefined. |
193 |
|
Your program may crash. |
194 |
|
|
195 |
|
If you want to process strings of values in the full range 0 to |
196 |
|
0x7FFFFFFF, encoded in a UTF-8-like manner as per the old RFC, you can |
197 |
|
set PCRE_NO_UTF8_CHECK to bypass the more restrictive test. However, in |
198 |
|
this situation, you will have to apply your own validity check. |
199 |
|
|
200 |
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. |
|
201 |
|
|
202 |
2. An unbraced hexadecimal escape sequence (such as \xb3) matches a |
1. An unbraced hexadecimal escape sequence (such as \xb3) matches a |
203 |
two-byte UTF-8 character if the value is greater than 127. |
two-byte UTF-8 character if the value is greater than 127. |
204 |
|
|
205 |
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 |
206 |
characters for values greater than \177. |
characters for values greater than \177. |
207 |
|
|
208 |
4. Repeat quantifiers apply to complete UTF-8 characters, not to indi- |
3. Repeat quantifiers apply to complete UTF-8 characters, not to indi- |
209 |
vidual bytes, for example: \x{100}{3}. |
vidual bytes, for example: \x{100}{3}. |
210 |
|
|
211 |
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- |
212 |
gle byte. |
gle byte. |
213 |
|
|
214 |
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 |
215 |
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 |
216 |
not available in the alternative matching function, pcre_dfa_exec(). |
not available in the alternative matching function, pcre_dfa_exec(). |
217 |
|
|
218 |
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 |
219 |
test characters of any code value, but the characters that PCRE recog- |
test characters of any code value, but the characters that PCRE recog- |
220 |
nizes as digits, spaces, or word characters remain the same set as |
nizes as digits, spaces, or word characters remain the same set as |
221 |
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 |
222 |
includes Unicode property support, because to do otherwise would slow |
includes Unicode property support, because to do otherwise would slow |
223 |
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 |
224 |
sense of, say, "digit", you must use Unicode property tests such as |
sense of, say, "digit", you must use Unicode property tests such as |
225 |
\p{Nd}. |
\p{Nd}. |
226 |
|
|
227 |
8. Similarly, characters that match the POSIX named character classes |
7. Similarly, characters that match the POSIX named character classes |
228 |
are all low-valued characters. |
are all low-valued characters. |
229 |
|
|
230 |
9. Case-insensitive matching applies only to characters whose values |
8. However, the Perl 5.10 horizontal and vertical whitespace matching |
231 |
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- |
232 |
Even when Unicode property support is available, PCRE still uses its |
acters. |
233 |
own character tables when checking the case of low-valued characters, |
|
234 |
so as not to degrade performance. The Unicode property information is |
9. Case-insensitive matching applies only to characters whose values |
235 |
|
are less than 128, unless PCRE is built with Unicode property support. |
236 |
|
Even when Unicode property support is available, PCRE still uses its |
237 |
|
own character tables when checking the case of low-valued characters, |
238 |
|
so as not to degrade performance. The Unicode property information is |
239 |
used only for characters with higher values. Even when Unicode property |
used only for characters with higher values. Even when Unicode property |
240 |
support is available, PCRE supports case-insensitive matching only when |
support is available, PCRE supports case-insensitive matching only when |
241 |
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 |
242 |
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- |
243 |
ported by PCRE. |
ported by PCRE. |
244 |
|
|
245 |
|
|
249 |
University Computing Service |
University Computing Service |
250 |
Cambridge CB2 3QH, England. |
Cambridge CB2 3QH, England. |
251 |
|
|
252 |
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, |
253 |
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, |
254 |
followed by the two digits 10, at the domain cam.ac.uk. |
followed by the two digits 10, at the domain cam.ac.uk. |
255 |
|
|
256 |
|
|
257 |
REVISION |
REVISION |
258 |
|
|
259 |
Last updated: 18 April 2007 |
Last updated: 09 August 2007 |
260 |
Copyright (c) 1997-2007 University of Cambridge. |
Copyright (c) 1997-2007 University of Cambridge. |
261 |
------------------------------------------------------------------------------ |
------------------------------------------------------------------------------ |
262 |
|
|
271 |
PCRE BUILD-TIME OPTIONS |
PCRE BUILD-TIME OPTIONS |
272 |
|
|
273 |
This document describes the optional features of PCRE that can be |
This document describes the optional features of PCRE that can be |
274 |
selected when the library is compiled. They are all selected, or dese- |
selected when the library is compiled. It assumes use of the configure |
275 |
lected, by providing options to the configure script that is run before |
script, where the optional features are selected or deselected by pro- |
276 |
the make command. The complete list of options for configure (which |
viding options to configure before running the make command. However, |
277 |
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 |
278 |
directory) can be obtained by running |
environments using the GUI facility of CMakeSetup if you are using |
279 |
|
CMake instead of configure to build PCRE. |
280 |
|
|
281 |
|
The complete list of options for configure (which includes the standard |
282 |
|
ones such as the selection of the installation directory) can be |
283 |
|
obtained by running |
284 |
|
|
285 |
./configure --help |
./configure --help |
286 |
|
|
287 |
The following sections include descriptions of options whose names |
The following sections include descriptions of options whose names |
288 |
begin with --enable or --disable. These settings specify changes to the |
begin with --enable or --disable. These settings specify changes to the |
289 |
defaults for the configure command. Because of the way that configure |
defaults for the configure command. Because of the way that configure |
290 |
works, --enable and --disable always come in pairs, so the complemen- |
works, --enable and --disable always come in pairs, so the complemen- |
291 |
tary option always exists as well, but as it specifies the default, it |
tary option always exists as well, but as it specifies the default, it |
292 |
is not described. |
is not described. |
293 |
|
|
294 |
|
|
309 |
|
|
310 |
--enable-utf8 |
--enable-utf8 |
311 |
|
|
312 |
to the configure command. Of itself, this does not make PCRE treat |
to the configure command. Of itself, this does not make PCRE treat |
313 |
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 |
314 |
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() |
315 |
function. |
function. |
316 |
|
|
317 |
|
|
318 |
UNICODE CHARACTER PROPERTY SUPPORT |
UNICODE CHARACTER PROPERTY SUPPORT |
319 |
|
|
320 |
UTF-8 support allows PCRE to process character values greater than 255 |
UTF-8 support allows PCRE to process character values greater than 255 |
321 |
in the strings that it handles. On its own, however, it does not pro- |
in the strings that it handles. On its own, however, it does not pro- |
322 |
vide any facilities for accessing the properties of such characters. If |
vide any facilities for accessing the properties of such characters. If |
323 |
you want to be able to use the pattern escapes \P, \p, and \X, which |
you want to be able to use the pattern escapes \P, \p, and \X, which |
324 |
refer to Unicode character properties, you must add |
refer to Unicode character properties, you must add |
325 |
|
|
326 |
--enable-unicode-properties |
--enable-unicode-properties |
327 |
|
|
328 |
to the configure command. This implies UTF-8 support, even if you have |
to the configure command. This implies UTF-8 support, even if you have |
329 |
not explicitly requested it. |
not explicitly requested it. |
330 |
|
|
331 |
Including Unicode property support adds around 30K of tables to the |
Including Unicode property support adds around 30K of tables to the |
332 |
PCRE library. Only the general category properties such as Lu and Nd |
PCRE library. Only the general category properties such as Lu and Nd |
333 |
are supported. Details are given in the pcrepattern documentation. |
are supported. Details are given in the pcrepattern documentation. |
334 |
|
|
335 |
|
|
336 |
CODE VALUE OF NEWLINE |
CODE VALUE OF NEWLINE |
337 |
|
|
338 |
By default, PCRE interprets character 10 (linefeed, LF) as indicating |
By default, PCRE interprets character 10 (linefeed, LF) as indicating |
339 |
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 |
340 |
systems. You can compile PCRE to use character 13 (carriage return, CR) |
systems. You can compile PCRE to use character 13 (carriage return, CR) |
341 |
instead, by adding |
instead, by adding |
342 |
|
|
343 |
--enable-newline-is-cr |
--enable-newline-is-cr |
344 |
|
|
345 |
to the configure command. There is also a --enable-newline-is-lf |
to the configure command. There is also a --enable-newline-is-lf |
346 |
option, which explicitly specifies linefeed as the newline character. |
option, which explicitly specifies linefeed as the newline character. |
347 |
|
|
348 |
Alternatively, you can specify that line endings are to be indicated by |
Alternatively, you can specify that line endings are to be indicated by |
354 |
|
|
355 |
--enable-newline-is-anycrlf |
--enable-newline-is-anycrlf |
356 |
|
|
357 |
which causes PCRE to recognize any of the three sequences CR, LF, or |
which causes PCRE to recognize any of the three sequences CR, LF, or |
358 |
CRLF as indicating a line ending. Finally, a fifth option, specified by |
CRLF as indicating a line ending. Finally, a fifth option, specified by |
359 |
|
|
360 |
--enable-newline-is-any |
--enable-newline-is-any |
361 |
|
|
362 |
causes PCRE to recognize any Unicode newline sequence. |
causes PCRE to recognize any Unicode newline sequence. |
363 |
|
|
364 |
Whatever line ending convention is selected when PCRE is built can be |
Whatever line ending convention is selected when PCRE is built can be |
365 |
overridden when the library functions are called. At build time it is |
overridden when the library functions are called. At build time it is |
366 |
conventional to use the standard for your operating system. |
conventional to use the standard for your operating system. |
367 |
|
|
368 |
|
|
369 |
|
WHAT \R MATCHES |
370 |
|
|
371 |
|
By default, the sequence \R in a pattern matches any Unicode newline |
372 |
|
sequence, whatever has been selected as the line ending sequence. If |
373 |
|
you specify |
374 |
|
|
375 |
|
--enable-bsr-anycrlf |
376 |
|
|
377 |
|
the default is changed so that \R matches only CR, LF, or CRLF. What- |
378 |
|
ever is selected when PCRE is built can be overridden when the library |
379 |
|
functions are called. |
380 |
|
|
381 |
|
|
382 |
BUILDING SHARED AND STATIC LIBRARIES |
BUILDING SHARED AND STATIC LIBRARIES |
383 |
|
|
384 |
The PCRE building process uses libtool to build both shared and static |
The PCRE building process uses libtool to build both shared and static |
385 |
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 |
386 |
of |
of |
387 |
|
|
388 |
--disable-shared |
--disable-shared |
394 |
POSIX MALLOC USAGE |
POSIX MALLOC USAGE |
395 |
|
|
396 |
When PCRE is called through the POSIX interface (see the pcreposix doc- |
When PCRE is called through the POSIX interface (see the pcreposix doc- |
397 |
umentation), additional working storage is required for holding the |
umentation), additional working storage is required for holding the |
398 |
pointers to capturing substrings, because PCRE requires three integers |
pointers to capturing substrings, because PCRE requires three integers |
399 |
per substring, whereas the POSIX interface provides only two. If the |
per substring, whereas the POSIX interface provides only two. If the |
400 |
number of expected substrings is small, the wrapper function uses space |
number of expected substrings is small, the wrapper function uses space |
401 |
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. |
402 |
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 |
409 |
|
|
410 |
HANDLING VERY LARGE PATTERNS |
HANDLING VERY LARGE PATTERNS |
411 |
|
|
412 |
Within a compiled pattern, offset values are used to point from one |
Within a compiled pattern, offset values are used to point from one |
413 |
part to another (for example, from an opening parenthesis to an alter- |
part to another (for example, from an opening parenthesis to an alter- |
414 |
nation metacharacter). By default, two-byte values are used for these |
nation metacharacter). By default, two-byte values are used for these |
415 |
offsets, leading to a maximum size for a compiled pattern of around |
offsets, leading to a maximum size for a compiled pattern of around |
416 |
64K. This is sufficient to handle all but the most gigantic patterns. |
64K. This is sufficient to handle all but the most gigantic patterns. |
417 |
Nevertheless, some people do want to process enormous patterns, so it |
Nevertheless, some people do want to process enormous patterns, so it |
418 |
is possible to compile PCRE to use three-byte or four-byte offsets by |
is possible to compile PCRE to use three-byte or four-byte offsets by |
419 |
adding a setting such as |
adding a setting such as |
420 |
|
|
421 |
--with-link-size=3 |
--with-link-size=3 |
422 |
|
|
423 |
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 |
424 |
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 |
425 |
additional bytes when handling them. |
additional bytes when handling them. |
426 |
|
|
427 |
|
|
428 |
AVOIDING EXCESSIVE STACK USAGE |
AVOIDING EXCESSIVE STACK USAGE |
429 |
|
|
430 |
When matching with the pcre_exec() function, PCRE implements backtrack- |
When matching with the pcre_exec() function, PCRE implements backtrack- |
431 |
ing by making recursive calls to an internal function called match(). |
ing by making recursive calls to an internal function called match(). |
432 |
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- |
433 |
verely limit PCRE's operation. (The Unix environment does not usually |
verely limit PCRE's operation. (The Unix environment does not usually |
434 |
suffer from this problem, but it may sometimes be necessary to increase |
suffer from this problem, but it may sometimes be necessary to increase |
435 |
the maximum stack size. There is a discussion in the pcrestack docu- |
the maximum stack size. There is a discussion in the pcrestack docu- |
436 |
mentation.) An alternative approach to recursion that uses memory from |
mentation.) An alternative approach to recursion that uses memory from |
437 |
the heap to remember data, instead of using recursive function calls, |
the heap to remember data, instead of using recursive function calls, |
438 |
has been implemented to work round the problem of limited stack size. |
has been implemented to work round the problem of limited stack size. |
439 |
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 |
440 |
|
|
441 |
--disable-stack-for-recursion |
--disable-stack-for-recursion |
442 |
|
|
443 |
to the configure command. With this configuration, PCRE will use the |
to the configure command. With this configuration, PCRE will use the |
444 |
pcre_stack_malloc and pcre_stack_free variables to call memory manage- |
pcre_stack_malloc and pcre_stack_free variables to call memory manage- |
445 |
ment functions. Separate functions are provided because the usage is |
ment functions. By default these point to malloc() and free(), but you |
446 |
very predictable: the block sizes requested are always the same, and |
can replace the pointers so that your own functions are used. |
447 |
the blocks are always freed in reverse order. A calling program might |
|
448 |
be able to implement optimized functions that perform better than the |
Separate functions are provided rather than using pcre_malloc and |
449 |
standard malloc() and free() functions. PCRE runs noticeably more |
pcre_free because the usage is very predictable: the block sizes |
450 |
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 |
451 |
function; it is not relevant for the the pcre_dfa_exec() function. |
reverse order. A calling program might be able to implement optimized |
452 |
|
functions that perform better than malloc() and free(). PCRE runs |
453 |
|
noticeably more slowly when built in this way. This option affects only |
454 |
|
the pcre_exec() function; it is not relevant for the the |
455 |
|
pcre_dfa_exec() function. |
456 |
|
|
457 |
|
|
458 |
LIMITING PCRE RESOURCE USAGE |
LIMITING PCRE RESOURCE USAGE |
459 |
|
|
460 |
Internally, PCRE has a function called match(), which it calls repeat- |
Internally, PCRE has a function called match(), which it calls repeat- |
461 |
edly (sometimes recursively) when matching a pattern with the |
edly (sometimes recursively) when matching a pattern with the |
462 |
pcre_exec() function. By controlling the maximum number of times this |
pcre_exec() function. By controlling the maximum number of times this |
463 |
function may be called during a single matching operation, a limit can |
function may be called during a single matching operation, a limit can |
464 |
be placed on the resources used by a single call to pcre_exec(). The |
be placed on the resources used by a single call to pcre_exec(). The |
465 |
limit can be changed at run time, as described in the pcreapi documen- |
limit can be changed at run time, as described in the pcreapi documen- |
466 |
tation. The default is 10 million, but this can be changed by adding a |
tation. The default is 10 million, but this can be changed by adding a |
467 |
setting such as |
setting such as |
468 |
|
|
469 |
--with-match-limit=500000 |
--with-match-limit=500000 |
470 |
|
|
471 |
to the configure command. This setting has no effect on the |
to the configure command. This setting has no effect on the |
472 |
pcre_dfa_exec() matching function. |
pcre_dfa_exec() matching function. |
473 |
|
|
474 |
In some environments it is desirable to limit the depth of recursive |
In some environments it is desirable to limit the depth of recursive |
475 |
calls of match() more strictly than the total number of calls, in order |
calls of match() more strictly than the total number of calls, in order |
476 |
to restrict the maximum amount of stack (or heap, if --disable-stack- |
to restrict the maximum amount of stack (or heap, if --disable-stack- |
477 |
for-recursion is specified) that is used. A second limit controls this; |
for-recursion is specified) that is used. A second limit controls this; |
478 |
it defaults to the value that is set for --with-match-limit, which |
it defaults to the value that is set for --with-match-limit, which |
479 |
imposes no additional constraints. However, you can set a lower limit |
imposes no additional constraints. However, you can set a lower limit |
480 |
by adding, for example, |
by adding, for example, |
481 |
|
|
482 |
--with-match-limit-recursion=10000 |
--with-match-limit-recursion=10000 |
483 |
|
|
484 |
to the configure command. This value can also be overridden at run |
to the configure command. This value can also be overridden at run |
485 |
time. |
time. |
486 |
|
|
487 |
|
|
488 |
CREATING CHARACTER TABLES AT BUILD TIME |
CREATING CHARACTER TABLES AT BUILD TIME |
489 |
|
|
490 |
PCRE uses fixed tables for processing characters whose code values are |
PCRE uses fixed tables for processing characters whose code values are |
491 |
less than 256. By default, PCRE is built with a set of tables that are |
less than 256. By default, PCRE is built with a set of tables that are |
492 |
distributed in the file pcre_chartables.c.dist. These tables are for |
distributed in the file pcre_chartables.c.dist. These tables are for |
493 |
ASCII codes only. If you add |
ASCII codes only. If you add |
494 |
|
|
495 |
--enable-rebuild-chartables |
--enable-rebuild-chartables |
496 |
|
|
497 |
to the configure command, the distributed tables are no longer used. |
to the configure command, the distributed tables are no longer used. |
498 |
Instead, a program called dftables is compiled and run. This outputs |
Instead, a program called dftables is compiled and run. This outputs |
499 |
the source for new set of tables, created in the default locale of your |
the source for new set of tables, created in the default locale of your |
500 |
C runtime system. (This method of replacing the tables does not work if |
C runtime system. (This method of replacing the tables does not work if |
501 |
you are cross compiling, because dftables is run on the local host. If |
you are cross compiling, because dftables is run on the local host. If |
502 |
you need to create alternative tables when cross compiling, you will |
you need to create alternative tables when cross compiling, you will |
503 |
have to do so "by hand".) |
have to do so "by hand".) |
504 |
|
|
505 |
|
|
506 |
USING EBCDIC CODE |
USING EBCDIC CODE |
507 |
|
|
508 |
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 |
509 |
character code is ASCII (or Unicode, which is a superset of ASCII). |
character code is ASCII (or Unicode, which is a superset of ASCII). |
510 |
PCRE can, however, be compiled to run in an EBCDIC environment by |
This is the case for most computer operating systems. PCRE can, how- |
511 |
adding |
ever, be compiled to run in an EBCDIC environment by adding |
512 |
|
|
513 |
--enable-ebcdic |
--enable-ebcdic |
514 |
|
|
515 |
to the configure command. This setting implies --enable-rebuild-charta- |
to the configure command. This setting implies --enable-rebuild-charta- |
516 |
bles. |
bles. You should only use it if you know that you are in an EBCDIC |
517 |
|
environment (for example, an IBM mainframe operating system). |
518 |
|
|
519 |
|
|
520 |
SEE ALSO |
SEE ALSO |
531 |
|
|
532 |
REVISION |
REVISION |
533 |
|
|
534 |
Last updated: 16 April 2007 |
Last updated: 21 September 2007 |
535 |
Copyright (c) 1997-2007 University of Cambridge. |
Copyright (c) 1997-2007 University of Cambridge. |
536 |
------------------------------------------------------------------------------ |
------------------------------------------------------------------------------ |
537 |
|
|
667 |
ence as the condition or test for a specific group recursion are not |
ence as the condition or test for a specific group recursion are not |
668 |
supported. |
supported. |
669 |
|
|
670 |
5. Callouts are supported, but the value of the capture_top field is |
5. Because many paths through the tree may be active, the \K escape |
671 |
|
sequence, which resets the start of the match when encountered (but may |
672 |
|
be on some paths and not on others), is not supported. It causes an |
673 |
|
error if encountered. |
674 |
|
|
675 |
|
6. Callouts are supported, but the value of the capture_top field is |
676 |
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. |
677 |
|
|
678 |
6. The \C escape sequence, which (in the standard algorithm) matches a |
7. The \C escape sequence, which (in the standard algorithm) matches a |
679 |
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- |
680 |
tive algorithm moves through the subject string one character at a |
tive algorithm moves through the subject string one character at a |
681 |
time, for all active paths through the tree. |
time, for all active paths through the tree. |
682 |
|
|
683 |
|
8. None of the backtracking control verbs such as (*PRUNE) are sup- |
684 |
|
ported. |
685 |
|
|
686 |
|
|
687 |
ADVANTAGES OF THE ALTERNATIVE ALGORITHM |
ADVANTAGES OF THE ALTERNATIVE ALGORITHM |
688 |
|
|
729 |
|
|
730 |
REVISION |
REVISION |
731 |
|
|
732 |
Last updated: 06 March 2007 |
Last updated: 08 August 2007 |
733 |
Copyright (c) 1997-2007 University of Cambridge. |
Copyright (c) 1997-2007 University of Cambridge. |
734 |
------------------------------------------------------------------------------ |
------------------------------------------------------------------------------ |
735 |
|
|
926 |
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 |
927 |
pattern is compiled, or when it is matched. |
pattern is compiled, or when it is matched. |
928 |
|
|
929 |
|
At compile time, the newline convention can be specified by the options |
930 |
|
argument of pcre_compile(), or it can be specified by special text at |
931 |
|
the start of the pattern itself; this overrides any other settings. See |
932 |
|
the pcrepattern page for details of the special character sequences. |
933 |
|
|
934 |
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- |
935 |
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 |
936 |
newline convention affects the handling of the dot, circumflex, and |
newline convention affects the handling of the dot, circumflex, and |
937 |
dollar metacharacters, the handling of #-comments in /x mode, and, when |
dollar metacharacters, the handling of #-comments in /x mode, and, when |
938 |
CRLF is a recognized line ending sequence, the match position advance- |
CRLF is a recognized line ending sequence, the match position advance- |
939 |
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 |
940 |
not affect the interpretation of the \n or \r escape sequences. |
section on pcre_exec() options below. |
941 |
|
|
942 |
|
The choice of newline convention does not affect the interpretation of |
943 |
|
the \n or \r escape sequences, nor does it affect what \R matches, |
944 |
|
which is controlled in a similar way, but by separate options. |
945 |
|
|
946 |
|
|
947 |
MULTITHREADING |
MULTITHREADING |
948 |
|
|
949 |
The PCRE functions can be used in multi-threading applications, with |
The PCRE functions can be used in multi-threading applications, with |
950 |
the proviso that the memory management functions pointed to by |
the proviso that the memory management functions pointed to by |
951 |
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 |
952 |
callout function pointed to by pcre_callout, are shared by all threads. |
callout function pointed to by pcre_callout, are shared by all threads. |
953 |
|
|
954 |
The compiled form of a regular expression is not altered during match- |
The compiled form of a regular expression is not altered during match- |
955 |
ing, so the same compiled pattern can safely be used by several threads |
ing, so the same compiled pattern can safely be used by several threads |
956 |
at once. |
at once. |
957 |
|
|
959 |
SAVING PRECOMPILED PATTERNS FOR LATER USE |
SAVING PRECOMPILED PATTERNS FOR LATER USE |
960 |
|
|
961 |
The compiled form of a regular expression can be saved and re-used at a |
The compiled form of a regular expression can be saved and re-used at a |
962 |
later time, possibly by a different program, and even on a host other |
later time, possibly by a different program, and even on a host other |
963 |
than the one on which it was compiled. Details are given in the |
than the one on which it was compiled. Details are given in the |
964 |
pcreprecompile documentation. However, compiling a regular expression |
pcreprecompile documentation. However, compiling a regular expression |
965 |
with one version of PCRE for use with a different version is not guar- |
with one version of PCRE for use with a different version is not guar- |
966 |
anteed to work and may cause crashes. |
anteed to work and may cause crashes. |
967 |
|
|
968 |
|
|
970 |
|
|
971 |
int pcre_config(int what, void *where); |
int pcre_config(int what, void *where); |
972 |
|
|
973 |
The function pcre_config() makes it possible for a PCRE client to dis- |
The function pcre_config() makes it possible for a PCRE client to dis- |
974 |
cover which optional features have been compiled into the PCRE library. |
cover which optional features have been compiled into the PCRE library. |
975 |
The pcrebuild documentation has more details about these optional fea- |
The pcrebuild documentation has more details about these optional fea- |
976 |
tures. |
tures. |
977 |
|
|
978 |
The first argument for pcre_config() is an integer, specifying which |
The first argument for pcre_config() is an integer, specifying which |
979 |
information is required; the second argument is a pointer to a variable |
information is required; the second argument is a pointer to a variable |
980 |
into which the information is placed. The following information is |
into which the information is placed. The following information is |
981 |
available: |
available: |
982 |
|
|
983 |
PCRE_CONFIG_UTF8 |
PCRE_CONFIG_UTF8 |
984 |
|
|
985 |
The output is an integer that is set to one if UTF-8 support is avail- |
The output is an integer that is set to one if UTF-8 support is avail- |
986 |
able; otherwise it is set to zero. |
able; otherwise it is set to zero. |
987 |
|
|
988 |
PCRE_CONFIG_UNICODE_PROPERTIES |
PCRE_CONFIG_UNICODE_PROPERTIES |
989 |
|
|
990 |
The output is an integer that is set to one if support for Unicode |
The output is an integer that is set to one if support for Unicode |
991 |
character properties is available; otherwise it is set to zero. |
character properties is available; otherwise it is set to zero. |
992 |
|
|
993 |
PCRE_CONFIG_NEWLINE |
PCRE_CONFIG_NEWLINE |
994 |
|
|
995 |
The output is an integer whose value specifies the default character |
The output is an integer whose value specifies the default character |
996 |
sequence that is recognized as meaning "newline". The four values that |
sequence that is recognized as meaning "newline". The four values that |
997 |
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, |
998 |
and -1 for ANY. The default should normally be the standard sequence |
and -1 for ANY. The default should normally be the standard sequence |
999 |
for your operating system. |
for your operating system. |
1000 |
|
|
1001 |
|
PCRE_CONFIG_BSR |
1002 |
|
|
1003 |
|
The output is an integer whose value indicates what character sequences |
1004 |
|
the \R escape sequence matches by default. A value of 0 means that \R |
1005 |
|
matches any Unicode line ending sequence; a value of 1 means that \R |
1006 |
|
matches only CR, LF, or CRLF. The default can be overridden when a pat- |
1007 |
|
tern is compiled or matched. |
1008 |
|
|
1009 |
PCRE_CONFIG_LINK_SIZE |
PCRE_CONFIG_LINK_SIZE |
1010 |
|
|
1011 |
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 |
1012 |
internal linkage in compiled regular expressions. The value is 2, 3, or |
internal linkage in compiled regular expressions. The value is 2, 3, or |
1013 |
4. Larger values allow larger regular expressions to be compiled, at |
4. Larger values allow larger regular expressions to be compiled, at |
1014 |
the expense of slower matching. The default value of 2 is sufficient |
the expense of slower matching. The default value of 2 is sufficient |
1015 |
for all but the most massive patterns, since it allows the compiled |
for all but the most massive patterns, since it allows the compiled |
1016 |
pattern to be up to 64K in size. |
pattern to be up to 64K in size. |
1017 |
|
|
1018 |
PCRE_CONFIG_POSIX_MALLOC_THRESHOLD |
PCRE_CONFIG_POSIX_MALLOC_THRESHOLD |
1019 |
|
|
1020 |
The output is an integer that contains the threshold above which the |
The output is an integer that contains the threshold above which the |
1021 |
POSIX interface uses malloc() for output vectors. Further details are |
POSIX interface uses malloc() for output vectors. Further details are |
1022 |
given in the pcreposix documentation. |
given in the pcreposix documentation. |
1023 |
|
|
1024 |
PCRE_CONFIG_MATCH_LIMIT |
PCRE_CONFIG_MATCH_LIMIT |
1025 |
|
|
1026 |
The output is an integer that gives the default limit for the number of |
The output is an integer that gives the default limit for the number of |
1027 |
internal matching function calls in a pcre_exec() execution. Further |
internal matching function calls in a pcre_exec() execution. Further |
1028 |
details are given with pcre_exec() below. |
details are given with pcre_exec() below. |
1029 |
|
|
1030 |
PCRE_CONFIG_MATCH_LIMIT_RECURSION |
PCRE_CONFIG_MATCH_LIMIT_RECURSION |
1031 |
|
|
1032 |
The output is an integer that gives the default limit for the depth of |
The output is an integer that gives the default limit for the depth of |
1033 |
recursion when calling the internal matching function in a pcre_exec() |
recursion when calling the internal matching function in a pcre_exec() |
1034 |
execution. Further details are given with pcre_exec() below. |
execution. Further details are given with pcre_exec() below. |
1035 |
|
|
1036 |
PCRE_CONFIG_STACKRECURSE |
PCRE_CONFIG_STACKRECURSE |
1037 |
|
|
1038 |
The output is an integer that is set to one if internal recursion when |
The output is an integer that is set to one if internal recursion when |
1039 |
running pcre_exec() is implemented by recursive function calls that use |
running pcre_exec() is implemented by recursive function calls that use |
1040 |
the stack to remember their state. This is the usual way that PCRE is |
the stack to remember their state. This is the usual way that PCRE is |
1041 |
compiled. The output is zero if PCRE was compiled to use blocks of data |
compiled. The output is zero if PCRE was compiled to use blocks of data |
1042 |
on the heap instead of recursive function calls. In this case, |
on the heap instead of recursive function calls. In this case, |
1043 |
pcre_stack_malloc and pcre_stack_free are called to manage memory |
pcre_stack_malloc and pcre_stack_free are called to manage memory |
1044 |
blocks on the heap, thus avoiding the use of the stack. |
blocks on the heap, thus avoiding the use of the stack. |
1045 |
|
|
1046 |
|
|
1057 |
|
|
1058 |
Either of the functions pcre_compile() or pcre_compile2() can be called |
Either of the functions pcre_compile() or pcre_compile2() can be called |
1059 |
to compile a pattern into an internal form. The only difference between |
to compile a pattern into an internal form. The only difference between |
1060 |
the two interfaces is that pcre_compile2() has an additional argument, |
the two interfaces is that pcre_compile2() has an additional argument, |
1061 |
errorcodeptr, via which a numerical error code can be returned. |
errorcodeptr, via which a numerical error code can be returned. |
1062 |
|
|
1063 |
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 |
1064 |
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 |
1065 |
obtained via pcre_malloc is returned. This contains the compiled code |
obtained via pcre_malloc is returned. This contains the compiled code |
1066 |
and related data. The pcre type is defined for the returned block; this |
and related data. The pcre type is defined for the returned block; this |
1067 |
is a typedef for a structure whose contents are not externally defined. |
is a typedef for a structure whose contents are not externally defined. |
1068 |
It is up to the caller to free the memory (via pcre_free) when it is no |
It is up to the caller to free the memory (via pcre_free) when it is no |
1069 |
longer required. |
longer required. |
1070 |
|
|
1071 |
Although the compiled code of a PCRE regex is relocatable, that is, it |
Although the compiled code of a PCRE regex is relocatable, that is, it |
1072 |
does not depend on memory location, the complete pcre data block is not |
does not depend on memory location, the complete pcre data block is not |
1073 |
fully relocatable, because it may contain a copy of the tableptr argu- |
fully relocatable, because it may contain a copy of the tableptr argu- |
1074 |
ment, which is an address (see below). |
ment, which is an address (see below). |
1075 |
|
|
1076 |
The options argument contains various bit settings that affect the com- |
The options argument contains various bit settings that affect the com- |
1077 |
pilation. It should be zero if no options are required. The available |
pilation. It should be zero if no options are required. The available |
1078 |
options are described below. Some of them, in particular, those that |
options are described below. Some of them, in particular, those that |
1079 |
are compatible with Perl, can also be set and unset from within the |
are compatible with Perl, can also be set and unset from within the |
1080 |
pattern (see the detailed description in the pcrepattern documenta- |
pattern (see the detailed description in the pcrepattern documenta- |
1081 |
tion). For these options, the contents of the options argument speci- |
tion). For these options, the contents of the options argument speci- |
1082 |
fies their initial settings at the start of compilation and execution. |
fies their initial settings at the start of compilation and execution. |
1083 |
The PCRE_ANCHORED and PCRE_NEWLINE_xxx options can be set at the time |
The PCRE_ANCHORED and PCRE_NEWLINE_xxx options can be set at the time |
1084 |
of matching as well as at compile time. |
of matching as well as at compile time. |
1085 |
|
|
1086 |
If errptr is NULL, pcre_compile() returns NULL immediately. Otherwise, |
If errptr is NULL, pcre_compile() returns NULL immediately. Otherwise, |
1087 |
if compilation of a pattern fails, pcre_compile() returns NULL, and |
if compilation of a pattern fails, pcre_compile() returns NULL, and |
1088 |
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- |
1089 |
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 |
1090 |
try to free it. The offset from the start of the pattern to the charac- |
try to free it. The offset from the start of the pattern to the charac- |
1091 |
ter where the error was discovered is placed in the variable pointed to |
ter where the error was discovered is placed in the variable pointed to |
1092 |
by erroffset, which must not be NULL. If it is, an immediate error is |
by erroffset, which must not be NULL. If it is, an immediate error is |
1093 |
given. |
given. |
1094 |
|
|
1095 |
If pcre_compile2() is used instead of pcre_compile(), and the error- |
If pcre_compile2() is used instead of pcre_compile(), and the error- |
1096 |
codeptr argument is not NULL, a non-zero error code number is returned |
codeptr argument is not NULL, a non-zero error code number is returned |
1097 |
via this argument in the event of an error. This is in addition to the |
via this argument in the event of an error. This is in addition to the |
1098 |
textual error message. Error codes and messages are listed below. |
textual error message. Error codes and messages are listed below. |
1099 |
|
|
1100 |
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 |
1101 |
character tables that are built when PCRE is compiled, using the |
character tables that are built when PCRE is compiled, using the |
1102 |
default C locale. Otherwise, tableptr must be an address that is the |
default C locale. Otherwise, tableptr must be an address that is the |
1103 |
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 |
1104 |
compiled pattern, and used again by pcre_exec(), unless another table |
compiled pattern, and used again by pcre_exec(), unless another table |
1105 |
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 |
1106 |
support below. |
support below. |
1107 |
|
|
1108 |
This code fragment shows a typical straightforward call to pcre_com- |
This code fragment shows a typical straightforward call to pcre_com- |
1109 |
pile(): |
pile(): |
1110 |
|
|
1111 |
pcre *re; |
pcre *re; |
1118 |
&erroffset, /* for error offset */ |
&erroffset, /* for error offset */ |
1119 |
NULL); /* use default character tables */ |
NULL); /* use default character tables */ |
1120 |
|
|
1121 |
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 |
1122 |
file: |
file: |
1123 |
|
|
1124 |
PCRE_ANCHORED |
PCRE_ANCHORED |
1125 |
|
|
1126 |
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 |
1127 |
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 |
1128 |
that is being searched (the "subject string"). This effect can also be |
that is being searched (the "subject string"). This effect can also be |
1129 |
achieved by appropriate constructs in the pattern itself, which is the |
achieved by appropriate constructs in the pattern itself, which is the |
1130 |
only way to do it in Perl. |
only way to do it in Perl. |
1131 |
|
|
1132 |
PCRE_AUTO_CALLOUT |
PCRE_AUTO_CALLOUT |
1133 |
|
|
1134 |
If this bit is set, pcre_compile() automatically inserts callout items, |
If this bit is set, pcre_compile() automatically inserts callout items, |
1135 |
all with number 255, before each pattern item. For discussion of the |
all with number 255, before each pattern item. For discussion of the |
1136 |
callout facility, see the pcrecallout documentation. |
callout facility, see the pcrecallout documentation. |
1137 |
|
|
1138 |
|
PCRE_BSR_ANYCRLF |
1139 |
|
PCRE_BSR_UNICODE |
1140 |
|
|
1141 |
|
These options (which are mutually exclusive) control what the \R escape |
1142 |
|
sequence matches. The choice is either to match only CR, LF, or CRLF, |
1143 |
|
or to match any Unicode newline sequence. The default is specified when |
1144 |
|
PCRE is built. It can be overridden from within the pattern, or by set- |
1145 |
|
ting an option when a compiled pattern is matched. |
1146 |
|
|
1147 |
PCRE_CASELESS |
PCRE_CASELESS |
1148 |
|
|
1149 |
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 |
1150 |
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 |
1151 |
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 |
1152 |
always understands the concept of case for characters whose values are |
always understands the concept of case for characters whose values are |
1153 |
less than 128, so caseless matching is always possible. For characters |
less than 128, so caseless matching is always possible. For characters |
1154 |
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- |
1155 |
piled with Unicode property support, but not otherwise. If you want to |
piled with Unicode property support, but not otherwise. If you want to |
1156 |
use caseless matching for characters 128 and above, you must ensure |
use caseless matching for characters 128 and above, you must ensure |
1157 |
that PCRE is compiled with Unicode property support as well as with |
that PCRE is compiled with Unicode property support as well as with |
1158 |
UTF-8 support. |
UTF-8 support. |
1159 |
|
|
1160 |
PCRE_DOLLAR_ENDONLY |
PCRE_DOLLAR_ENDONLY |
1161 |
|
|
1162 |
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 |
1163 |
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 |
1164 |
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 |
1165 |
before any other newlines). The PCRE_DOLLAR_ENDONLY option is ignored |
before any other newlines). The PCRE_DOLLAR_ENDONLY option is ignored |
1166 |
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 |
1167 |
Perl, and no way to set it within a pattern. |
Perl, and no way to set it within a pattern. |
1168 |
|
|
1169 |
PCRE_DOTALL |
PCRE_DOTALL |
1170 |
|
|
1171 |
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- |
1172 |
acters, including those that indicate newline. Without it, a dot does |
acters, including those that indicate newline. Without it, a dot does |
1173 |
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 |
1174 |
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 |
1175 |
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 |
1176 |
newline characters, independent of the setting of this option. |
newline characters, independent of the setting of this option. |
1177 |
|
|
1178 |
PCRE_DUPNAMES |
PCRE_DUPNAMES |
1179 |
|
|
1180 |
If this bit is set, names used to identify capturing subpatterns need |
If this bit is set, names used to identify capturing subpatterns need |
1181 |
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 |
1182 |
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 |
1183 |
matched. There are more details of named subpatterns below; see also |
matched. There are more details of named subpatterns below; see also |
1184 |
the pcrepattern documentation. |
the pcrepattern documentation. |
1185 |
|
|
1186 |
PCRE_EXTENDED |
PCRE_EXTENDED |
1187 |
|
|
1188 |
If this bit is set, whitespace data characters in the pattern are |
If this bit is set, whitespace data characters in the pattern are |
1189 |
totally ignored except when escaped or inside a character class. White- |
totally ignored except when escaped or inside a character class. White- |
1190 |
space does not include the VT character (code 11). In addition, charac- |
space does not include the VT character (code 11). In addition, charac- |
1191 |
ters between an unescaped # outside a character class and the next new- |
ters between an unescaped # outside a character class and the next new- |
1192 |
line, inclusive, are also ignored. This is equivalent to Perl's /x |
line, inclusive, are also ignored. This is equivalent to Perl's /x |
1193 |
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- |
1194 |
ting. |
ting. |
1195 |
|
|
1196 |
This option makes it possible to include comments inside complicated |
This option makes it possible to include comments inside complicated |
1197 |
patterns. Note, however, that this applies only to data characters. |
patterns. Note, however, that this applies only to data characters. |
1198 |
Whitespace characters may never appear within special character |
Whitespace characters may never appear within special character |
1199 |
sequences in a pattern, for example within the sequence (?( which |
sequences in a pattern, for example within the sequence (?( which |
1200 |
introduces a conditional subpattern. |
introduces a conditional subpattern. |
1201 |
|
|
1202 |
PCRE_EXTRA |
PCRE_EXTRA |
1203 |
|
|
1204 |
This option was invented in order to turn on additional functionality |
This option was invented in order to turn on additional functionality |
1205 |
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 |
1206 |
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 |
1207 |
letter that has no special meaning causes an error, thus reserving |
letter that has no special meaning causes an error, thus reserving |
1208 |
these combinations for future expansion. By default, as in Perl, a |
these combinations for future expansion. By default, as in Perl, a |
1209 |
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 |
1210 |
literal. (Perl can, however, be persuaded to give a warning for this.) |
literal. (Perl can, however, be persuaded to give a warning for this.) |
1211 |
There are at present no other features controlled by this option. It |
There are at present no other features controlled by this option. It |
1212 |
can also be set by a (?X) option setting within a pattern. |
can also be set by a (?X) option setting within a pattern. |
1213 |
|
|
1214 |
PCRE_FIRSTLINE |
PCRE_FIRSTLINE |
1215 |
|
|
1216 |
If this option is set, an unanchored pattern is required to match |
If this option is set, an unanchored pattern is required to match |
1217 |
before or at the first newline in the subject string, though the |
before or at the first newline in the subject string, though the |
1218 |
matched text may continue over the newline. |
matched text may continue over the newline. |
1219 |
|
|
1220 |
PCRE_MULTILINE |
PCRE_MULTILINE |
1221 |
|
|
1222 |
By default, PCRE treats the subject string as consisting of a single |
By default, PCRE treats the subject string as consisting of a single |
1223 |
line of characters (even if it actually contains newlines). The "start |
line of characters (even if it actually contains newlines). The "start |
1224 |
of line" metacharacter (^) matches only at the start of the string, |
of line" metacharacter (^) matches only at the start of the string, |
1225 |
while the "end of line" metacharacter ($) matches only at the end of |
while the "end of line" metacharacter ($) matches only at the end of |
1226 |
the string, or before a terminating newline (unless PCRE_DOLLAR_ENDONLY |
the string, or before a terminating newline (unless PCRE_DOLLAR_ENDONLY |
1227 |
is set). This is the same as Perl. |
is set). This is the same as Perl. |
1228 |
|
|
1229 |
When PCRE_MULTILINE it is set, the "start of line" and "end of line" |
When PCRE_MULTILINE it is set, the "start of line" and "end of line" |
1230 |
constructs match immediately following or immediately before internal |
constructs match immediately following or immediately before internal |
1231 |
newlines in the subject string, respectively, as well as at the very |
newlines in the subject string, respectively, as well as at the very |
1232 |
start and end. This is equivalent to Perl's /m option, and it can be |
start and end. This is equivalent to Perl's /m option, and it can be |
1233 |
changed within a pattern by a (?m) option setting. If there are no new- |
changed within a pattern by a (?m) option setting. If there are no new- |
1234 |
lines in a subject string, or no occurrences of ^ or $ in a pattern, |
lines in a subject string, or no occurrences of ^ or $ in a pattern, |
1235 |
setting PCRE_MULTILINE has no effect. |
setting PCRE_MULTILINE has no effect. |
1236 |
|
|
1237 |
PCRE_NEWLINE_CR |
PCRE_NEWLINE_CR |
1240 |
PCRE_NEWLINE_ANYCRLF |
PCRE_NEWLINE_ANYCRLF |
1241 |
PCRE_NEWLINE_ANY |
PCRE_NEWLINE_ANY |
1242 |
|
|
1243 |
These options override the default newline definition that was chosen |
These options override the default newline definition that was chosen |
1244 |
when PCRE was built. Setting the first or the second specifies that a |
when PCRE was built. Setting the first or the second specifies that a |
1245 |
newline is indicated by a single character (CR or LF, respectively). |
newline is indicated by a single character (CR or LF, respectively). |
1246 |
Setting PCRE_NEWLINE_CRLF specifies that a newline is indicated by the |
Setting PCRE_NEWLINE_CRLF specifies that a newline is indicated by the |
1247 |
two-character CRLF sequence. Setting PCRE_NEWLINE_ANYCRLF specifies |
two-character CRLF sequence. Setting PCRE_NEWLINE_ANYCRLF specifies |
1248 |
that any of the three preceding sequences should be recognized. Setting |
that any of the three preceding sequences should be recognized. Setting |
1249 |
PCRE_NEWLINE_ANY specifies that any Unicode newline sequence should be |
PCRE_NEWLINE_ANY specifies that any Unicode newline sequence should be |
1250 |
recognized. The Unicode newline sequences are the three just mentioned, |
recognized. The Unicode newline sequences are the three just mentioned, |
1251 |
plus the single characters VT (vertical tab, U+000B), FF (formfeed, |
plus the single characters VT (vertical tab, U+000B), FF (formfeed, |
1252 |
U+000C), NEL (next line, U+0085), LS (line separator, U+2028), and PS |
U+000C), NEL (next line, U+0085), LS (line separator, U+2028), and PS |
1253 |
(paragraph separator, U+2029). The last two are recognized only in |
(paragraph separator, U+2029). The last two are recognized only in |
1254 |
UTF-8 mode. |
UTF-8 mode. |
1255 |
|
|
1256 |
The newline setting in the options word uses three bits that are |
The newline setting in the options word uses three bits that are |
1257 |
treated as a number, giving eight possibilities. Currently only six are |
treated as a number, giving eight possibilities. Currently only six are |
1258 |
used (default plus the five values above). This means that if you set |
used (default plus the five values above). This means that if you set |
1259 |
more than one newline option, the combination may or may not be sensi- |
more than one newline option, the combination may or may not be sensi- |
1260 |
ble. For example, PCRE_NEWLINE_CR with PCRE_NEWLINE_LF is equivalent to |
ble. For example, PCRE_NEWLINE_CR with PCRE_NEWLINE_LF is equivalent to |
1261 |
PCRE_NEWLINE_CRLF, but other combinations may yield unused numbers and |
PCRE_NEWLINE_CRLF, but other combinations may yield unused numbers and |
1262 |
cause an error. |
cause an error. |
1263 |
|
|
1264 |
The only time that a line break is specially recognized when compiling |
The only time that a line break is specially recognized when compiling |
1265 |
a pattern is if PCRE_EXTENDED is set, and an unescaped # outside a |
a pattern is if PCRE_EXTENDED is set, and an unescaped # outside a |
1266 |
character class is encountered. This indicates a comment that lasts |
character class is encountered. This indicates a comment that lasts |
1267 |
until after the next line break sequence. In other circumstances, line |
until after the next line break sequence. In other circumstances, line |
1268 |
break sequences are treated as literal data, except that in |
break sequences are treated as literal data, except that in |
1269 |
PCRE_EXTENDED mode, both CR and LF are treated as whitespace characters |
PCRE_EXTENDED mode, both CR and LF are treated as whitespace characters |
1270 |
and are therefore ignored. |
and are therefore ignored. |
1271 |
|
|
1272 |
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 |
1273 |
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. |
1274 |
|
|
1275 |
PCRE_NO_AUTO_CAPTURE |
PCRE_NO_AUTO_CAPTURE |
1276 |
|
|
1277 |
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- |
1278 |
theses in the pattern. Any opening parenthesis that is not followed by |
theses in the pattern. Any opening parenthesis that is not followed by |
1279 |
? behaves as if it were followed by ?: but named parentheses can still |
? behaves as if it were followed by ?: but named parentheses can still |
1280 |
be used for capturing (and they acquire numbers in the usual way). |
be used for capturing (and they acquire numbers in the usual way). |
1281 |
There is no equivalent of this option in Perl. |
There is no equivalent of this option in Perl. |
1282 |
|
|
1283 |
PCRE_UNGREEDY |
PCRE_UNGREEDY |
1284 |
|
|
1285 |
This option inverts the "greediness" of the quantifiers so that they |
This option inverts the "greediness" of the quantifiers so that they |
1286 |
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 |
1287 |
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 |
1288 |
within the pattern. |
within the pattern. |
1289 |
|
|
1290 |
PCRE_UTF8 |
PCRE_UTF8 |
1291 |
|
|
1292 |
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 |
1293 |
strings of UTF-8 characters instead of single-byte character strings. |
strings of UTF-8 characters instead of single-byte character strings. |
1294 |
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- |
1295 |
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 |
1296 |
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 |
1297 |
UTF-8 support in the main pcre page. |
UTF-8 support in the main pcre page. |
1298 |
|
|
1299 |
PCRE_NO_UTF8_CHECK |
PCRE_NO_UTF8_CHECK |
1300 |
|
|
1301 |
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 |
1302 |
automatically checked. If an invalid UTF-8 sequence of bytes is found, |
automatically checked. There is a discussion about the validity of |
1303 |
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 |
1304 |
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 |
1305 |
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- |
1306 |
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 |
1307 |
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 |
1308 |
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 |
1309 |
ing of subject strings. |
can also be passed to pcre_exec() and pcre_dfa_exec(), to suppress the |
1310 |
|
UTF-8 validity checking of subject strings. |
1311 |
|
|
1312 |
|
|
1313 |
COMPILATION ERROR CODES |
COMPILATION ERROR CODES |
1346 |
26 malformed number or name after (?( |
26 malformed number or name after (?( |
1347 |
27 conditional group contains more than two branches |
27 conditional group contains more than two branches |
1348 |
28 assertion expected after (?( |
28 assertion expected after (?( |
1349 |
29 (?R or (?digits must be followed by ) |
29 (?R or (?[+-]digits must be followed by ) |
1350 |
30 unknown POSIX class name |
30 unknown POSIX class name |
1351 |
31 POSIX collating elements are not supported |
31 POSIX collating elements are not supported |
1352 |
32 this version of PCRE is not compiled with PCRE_UTF8 support |
32 this version of PCRE is not compiled with PCRE_UTF8 support |
1367 |
47 unknown property name after \P or \p |
47 unknown property name after \P or \p |
1368 |
48 subpattern name is too long (maximum 32 characters) |
48 subpattern name is too long (maximum 32 characters) |
1369 |
49 too many named subpatterns (maximum 10,000) |
49 too many named subpatterns (maximum 10,000) |
1370 |
50 repeated subpattern is too long |
50 [this code is not in use] |
1371 |
51 octal value is greater than \377 (not in UTF-8 mode) |
51 octal value is greater than \377 (not in UTF-8 mode) |
1372 |
52 internal error: overran compiling workspace |
52 internal error: overran compiling workspace |
1373 |
53 internal error: previously-checked referenced subpattern not |
53 internal error: previously-checked referenced subpattern not |
1374 |
found |
found |
1375 |
54 DEFINE group contains more than one branch |
54 DEFINE group contains more than one branch |
1376 |
55 repeating a DEFINE group is not allowed |
55 repeating a DEFINE group is not allowed |
1377 |
56 inconsistent NEWLINE options" |
56 inconsistent NEWLINE options |
1378 |
|
57 \g is not followed by a braced name or an optionally braced |
1379 |
|
non-zero number |
1380 |
|
58 (?+ or (?- or (?(+ or (?(- must be followed by a non-zero number |
1381 |
|
|
1382 |
|
|
1383 |
STUDYING A PATTERN |
STUDYING A PATTERN |
1566 |
returned. The fourth argument should point to an unsigned char * vari- |
returned. The fourth argument should point to an unsigned char * vari- |
1567 |
able. |
able. |
1568 |
|
|
1569 |
|
PCRE_INFO_HASCRORLF |
1570 |
|
|
1571 |
|
Return 1 if the pattern contains any explicit matches for CR or LF |
1572 |
|
characters, otherwise 0. The fourth argument should point to an int |
1573 |
|
variable. An explicit match is either a literal CR or LF character, or |
1574 |
|
\r or \n. |
1575 |
|
|
1576 |
|
PCRE_INFO_JCHANGED |
1577 |
|
|
1578 |
|
Return 1 if the (?J) option setting is used in the pattern, otherwise |
1579 |
|
0. The fourth argument should point to an int variable. The (?J) inter- |
1580 |
|
nal option setting changes the local PCRE_DUPNAMES option. |
1581 |
|
|
1582 |
PCRE_INFO_LASTLITERAL |
PCRE_INFO_LASTLITERAL |
1583 |
|
|
1584 |
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 |
1585 |
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 |
1586 |
recorded. The fourth argument should point to an int variable. If there |
recorded. The fourth argument should point to an int variable. If there |
1587 |
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 |
1588 |
byte is recorded only if it follows something of variable length. For |
byte is recorded only if it follows something of variable length. For |
1589 |
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 |
1590 |
/^a\dz\d/ the returned value is -1. |
/^a\dz\d/ the returned value is -1. |
1591 |
|
|
1593 |
PCRE_INFO_NAMEENTRYSIZE |
PCRE_INFO_NAMEENTRYSIZE |
1594 |
PCRE_INFO_NAMETABLE |
PCRE_INFO_NAMETABLE |
1595 |
|
|
1596 |
PCRE supports the use of named as well as numbered capturing parenthe- |
PCRE supports the use of named as well as numbered capturing parenthe- |
1597 |
ses. The names are just an additional way of identifying the parenthe- |
ses. The names are just an additional way of identifying the parenthe- |
1598 |
ses, which still acquire numbers. Several convenience functions such as |
ses, which still acquire numbers. Several convenience functions such as |
1599 |
pcre_get_named_substring() are provided for extracting captured sub- |
pcre_get_named_substring() are provided for extracting captured sub- |
1600 |
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 |
1601 |
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 |
1602 |
pointers in the output vector (described with pcre_exec() below). To do |
pointers in the output vector (described with pcre_exec() below). To do |
1603 |
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 |
1604 |
described by these three values. |
described by these three values. |
1605 |
|
|
1606 |
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 |
1607 |
gives the number of entries, and PCRE_INFO_NAMEENTRYSIZE gives the size |
gives the number of entries, and PCRE_INFO_NAMEENTRYSIZE gives the size |
1608 |
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 |
1609 |
depends on the length of the longest name. PCRE_INFO_NAMETABLE returns |
depends on the length of the longest name. PCRE_INFO_NAMETABLE returns |
1610 |
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 |
1611 |
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- |
1612 |
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- |
1613 |
sponding name, zero terminated. The names are in alphabetical order. |
sponding name, zero terminated. The names are in alphabetical order. |
1614 |
When PCRE_DUPNAMES is set, duplicate names are in order of their paren- |
When PCRE_DUPNAMES is set, duplicate names are in order of their paren- |
1615 |
theses numbers. For example, consider the following pattern (assume |
theses numbers. For example, consider the following pattern (assume |
1616 |
PCRE_EXTENDED is set, so white space - including newlines - is |
PCRE_EXTENDED is set, so white space - including newlines - is |
1617 |
ignored): |
ignored): |
1618 |
|
|
1619 |
(?<date> (?<year>(\d\d)?\d\d) - |
(?<date> (?<year>(\d\d)?\d\d) - |
1620 |
(?<month>\d\d) - (?<day>\d\d) ) |
(?<month>\d\d) - (?<day>\d\d) ) |
1621 |
|
|
1622 |
There are four named subpatterns, so the table has four entries, and |
There are four named subpatterns, so the table has four entries, and |
1623 |
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, |
1624 |
with non-printing bytes shows in hexadecimal, and undefined bytes shown |
with non-printing bytes shows in hexadecimal, and undefined bytes shown |
1625 |
as ??: |
as ??: |
1626 |
|
|
1629 |
00 04 m o n t h 00 |
00 04 m o n t h 00 |
1630 |
00 02 y e a r 00 ?? |
00 02 y e a r 00 ?? |
1631 |
|
|
1632 |
When writing code to extract data from named subpatterns using the |
When writing code to extract data from named subpatterns using the |
1633 |
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 |
1634 |
to be different for each compiled pattern. |
to be different for each compiled pattern. |
1635 |
|
|
1636 |
|
PCRE_INFO_OKPARTIAL |
1637 |
|
|
1638 |
|
Return 1 if the pattern can be used for partial matching, otherwise 0. |
1639 |
|
The fourth argument should point to an int variable. The pcrepartial |
1640 |
|
documentation lists the restrictions that apply to patterns when par- |
1641 |
|
tial matching is used. |
1642 |
|
|
1643 |
PCRE_INFO_OPTIONS |
PCRE_INFO_OPTIONS |
1644 |
|
|
1645 |
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 |
1646 |
fourth argument should point to an unsigned long int variable. These |
fourth argument should point to an unsigned long int variable. These |
1647 |
option bits are those specified in the call to pcre_compile(), modified |
option bits are those specified in the call to pcre_compile(), modified |
1648 |
by any top-level option settings within the pattern itself. |
by any top-level option settings at the start of the pattern itself. In |
1649 |
|
other words, they are the options that will be in force when matching |
1650 |
|
starts. For example, if the pattern /(?im)abc(?-i)d/ is compiled with |
1651 |
|
the PCRE_EXTENDED option, the result is PCRE_CASELESS, PCRE_MULTILINE, |
1652 |
|
and PCRE_EXTENDED. |
1653 |
|
|
1654 |
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 |
1655 |
alternatives begin with one of the following: |
alternatives begin with one of the following: |
1852 |
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 |
1853 |
unachored at matching time. |
unachored at matching time. |
1854 |
|
|
1855 |
|
PCRE_BSR_ANYCRLF |
1856 |
|
PCRE_BSR_UNICODE |
1857 |
|
|
1858 |
|
These options (which are mutually exclusive) control what the \R escape |
1859 |
|
sequence matches. The choice is either to match only CR, LF, or CRLF, |
1860 |
|
or to match any Unicode newline sequence. These options override the |
1861 |
|
choice that was made or defaulted when the pattern was compiled. |
1862 |
|
|
1863 |
PCRE_NEWLINE_CR |
PCRE_NEWLINE_CR |
1864 |
PCRE_NEWLINE_LF |
PCRE_NEWLINE_LF |
1865 |
PCRE_NEWLINE_CRLF |
PCRE_NEWLINE_CRLF |
1866 |
PCRE_NEWLINE_ANYCRLF |
PCRE_NEWLINE_ANYCRLF |
1867 |
PCRE_NEWLINE_ANY |
PCRE_NEWLINE_ANY |
1868 |
|
|
1869 |
These options override the newline definition that was chosen or |
These options override the newline definition that was chosen or |
1870 |
defaulted when the pattern was compiled. For details, see the descrip- |
defaulted when the pattern was compiled. For details, see the descrip- |
1871 |
tion of pcre_compile() above. During matching, the newline choice |
tion of pcre_compile() above. During matching, the newline choice |
1872 |
affects the behaviour of the dot, circumflex, and dollar metacharac- |
affects the behaviour of the dot, circumflex, and dollar metacharac- |
1873 |
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 |
1874 |
match failure for an unanchored pattern. When PCRE_NEWLINE_CRLF, |
match failure for an unanchored pattern. |
1875 |
PCRE_NEWLINE_ANYCRLF, or PCRE_NEWLINE_ANY is set, and a match attempt |
|
1876 |
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 |
1877 |
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- |
1878 |
after the CRLF. |
rent position is at a CRLF sequence, and the pattern contains no |
1879 |
|
explicit matches for CR or LF characters, the match position is |
1880 |
|
advanced by two characters instead of one, in other words, to after the |
1881 |
|
CRLF. |
1882 |
|
|
1883 |
|
The above rule is a compromise that makes the most common cases work as |
1884 |
|
expected. For example, if the pattern is .+A (and the PCRE_DOTALL |
1885 |
|
option is not set), it does not match the string "\r\nA" because, after |
1886 |
|
failing at the start, it skips both the CR and the LF before retrying. |
1887 |
|
However, the pattern [\r\n]A does match that string, because it con- |
1888 |
|
tains an explicit CR or LF reference, and so advances only by one char- |
1889 |
|
acter after the first failure. |
1890 |
|
|
1891 |
|
An explicit match for CR of LF is either a literal appearance of one of |
1892 |
|
those characters, or one of the \r or \n escape sequences. Implicit |
1893 |
|
matches such as [^X] do not count, nor does \s (which includes CR and |
1894 |
|
LF in the characters that it matches). |
1895 |
|
|
1896 |
|
Notwithstanding the above, anomalous effects may still occur when CRLF |
1897 |
|
is a valid newline sequence and explicit \r or \n escapes appear in the |
1898 |
|
pattern. |
1899 |
|
|
1900 |
PCRE_NOTBOL |
PCRE_NOTBOL |
1901 |
|
|
1902 |
This option specifies that first character of the subject string is not |
This option specifies that first character of the subject string is not |
1903 |
the beginning of a line, so the circumflex metacharacter should not |
the beginning of a line, so the circumflex metacharacter should not |
1904 |
match before it. Setting this without PCRE_MULTILINE (at compile time) |
match before it. Setting this without PCRE_MULTILINE (at compile time) |
1905 |
causes circumflex never to match. This option affects only the behav- |
causes circumflex never to match. This option affects only the behav- |
1906 |
iour of the circumflex metacharacter. It does not affect \A. |
iour of the circumflex metacharacter. It does not affect \A. |
1907 |
|
|
1908 |
PCRE_NOTEOL |
PCRE_NOTEOL |
1909 |
|
|
1910 |
This option specifies that the end of the subject string is not the end |
This option specifies that the end of the subject string is not the end |
1911 |
of a line, so the dollar metacharacter should not match it nor (except |
of a line, so the dollar metacharacter should not match it nor (except |
1912 |
in multiline mode) a newline immediately before it. Setting this with- |
in multiline mode) a newline immediately before it. Setting this with- |
1913 |
out PCRE_MULTILINE (at compile time) causes dollar never to match. This |
out PCRE_MULTILINE (at compile time) causes dollar never to match. This |
1914 |
option affects only the behaviour of the dollar metacharacter. It does |
option affects only the behaviour of the dollar metacharacter. It does |
1915 |
not affect \Z or \z. |
not affect \Z or \z. |
1916 |
|
|
1917 |
PCRE_NOTEMPTY |
PCRE_NOTEMPTY |
1918 |
|
|
1919 |
An empty string is not considered to be a valid match if this option is |
An empty string is not considered to be a valid match if this option is |
1920 |
set. If there are alternatives in the pattern, they are tried. If all |
set. If there are alternatives in the pattern, they are tried. If all |
1921 |
the alternatives match the empty string, the entire match fails. For |
the alternatives match the empty string, the entire match fails. For |
1922 |
example, if the pattern |
example, if the pattern |
1923 |
|
|
1924 |
a?b? |
a?b? |
1925 |
|
|
1926 |
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 the |
1927 |
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 |
1928 |
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- |
1929 |
rences of "a" or "b". |
rences of "a" or "b". |
1930 |
|
|
1931 |
Perl has no direct equivalent of PCRE_NOTEMPTY, but it does make a spe- |
Perl has no direct equivalent of PCRE_NOTEMPTY, but it does make a spe- |
1932 |
cial case of a pattern match of the empty string within its split() |
cial case of a pattern match of the empty string within its split() |
1933 |
function, and when using the /g modifier. It is possible to emulate |
function, and when using the /g modifier. It is possible to emulate |
1934 |
Perl's behaviour after matching a null string by first trying the match |
Perl's behaviour after matching a null string by first trying the match |
1935 |
again at the same offset with PCRE_NOTEMPTY and PCRE_ANCHORED, and then |
again at the same offset with PCRE_NOTEMPTY and PCRE_ANCHORED, and then |
1936 |
if that fails by advancing the starting offset (see below) and trying |
if that fails by advancing the starting offset (see below) and trying |
1937 |
an ordinary match again. There is some code that demonstrates how to do |
an ordinary match again. There is some code that demonstrates how to do |
1938 |
this in the pcredemo.c sample program. |
this in the pcredemo.c sample program. |
1939 |
|
|
1940 |
PCRE_NO_UTF8_CHECK |
PCRE_NO_UTF8_CHECK |
1941 |
|
|
1942 |
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 |
1943 |
UTF-8 string is automatically checked when pcre_exec() is subsequently |
UTF-8 string is automatically checked when pcre_exec() is subsequently |
1944 |
called. The value of startoffset is also checked to ensure that it |
called. The value of startoffset is also checked to ensure that it |
1945 |
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 |
1946 |
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 |
1947 |
startoffset contains an invalid value, PCRE_ERROR_BADUTF8_OFFSET is |
main pcre page. If an invalid UTF-8 sequence of bytes is found, |
1948 |
returned. |
pcre_exec() returns the error PCRE_ERROR_BADUTF8. If startoffset con- |
1949 |
|
tains an invalid value, PCRE_ERROR_BADUTF8_OFFSET is returned. |
1950 |
|
|
1951 |
If you already know that your subject is valid, and you want to skip |
If you already know that your subject is valid, and you want to skip |
1952 |
these checks for performance reasons, you can set the |
these checks for performance reasons, you can set the |
2169 |
field in a pcre_extra structure (or defaulted) was reached. See the |
field in a pcre_extra structure (or defaulted) was reached. See the |
2170 |
description above. |
description above. |
2171 |
|
|
|
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. |
|
|
|
|
2172 |
PCRE_ERROR_BADNEWLINE (-23) |
PCRE_ERROR_BADNEWLINE (-23) |
2173 |
|
|
2174 |
An invalid combination of PCRE_NEWLINE_xxx options was given. |
An invalid combination of PCRE_NEWLINE_xxx options was given. |
2175 |
|
|
2176 |
Error numbers -16 to -20 are not used by pcre_exec(). |
Error numbers -16 to -20 and -22 are not used by pcre_exec(). |
2177 |
|
|
2178 |
|
|
2179 |
EXTRACTING CAPTURED SUBSTRINGS BY NUMBER |
EXTRACTING CAPTURED SUBSTRINGS BY NUMBER |
2321 |
subpatterns are not required to be unique. Normally, patterns with |
subpatterns are not required to be unique. Normally, patterns with |
2322 |
duplicate names are such that in any one match, only one of the named |
duplicate names are such that in any one match, only one of the named |
2323 |
subpatterns participates. An example is shown in the pcrepattern docu- |
subpatterns participates. An example is shown in the pcrepattern docu- |
2324 |
mentation. When duplicates are present, pcre_copy_named_substring() and |
mentation. |
2325 |
|
|
2326 |
|
When duplicates are present, pcre_copy_named_substring() and |
2327 |
pcre_get_named_substring() return the first substring corresponding to |
pcre_get_named_substring() return the first substring corresponding to |
2328 |
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 |
2329 |
returned. The pcre_get_stringnumber() function returns one of the num- |
(-7) is returned; no data is returned. The pcre_get_stringnumber() |
2330 |
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, |
2331 |
is. |
but it is not defined which it is. |
2332 |
|
|
2333 |
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 |
2334 |
name, you must use the pcre_get_stringtable_entries() function. The |
name, you must use the pcre_get_stringtable_entries() function. The |
2530 |
|
|
2531 |
REVISION |
REVISION |
2532 |
|
|
2533 |
Last updated: 24 April 2007 |
Last updated: 11 September 2007 |
2534 |
Copyright (c) 1997-2007 University of Cambridge. |
Copyright (c) 1997-2007 University of Cambridge. |
2535 |
------------------------------------------------------------------------------ |
------------------------------------------------------------------------------ |
2536 |
|
|
2633 |
The subject and subject_length fields contain copies of the values that |
The subject and subject_length fields contain copies of the values that |
2634 |
were passed to pcre_exec(). |
were passed to pcre_exec(). |
2635 |
|
|
2636 |
The start_match field contains the offset within the subject at which |
The start_match field normally contains the offset within the subject |
2637 |
the current match attempt started. If the pattern is not anchored, the |
at which the current match attempt started. However, if the escape |
2638 |
callout function may be called several times from the same point in the |
sequence \K has been encountered, this value is changed to reflect the |
2639 |
pattern for different starting points in the subject. |
modified starting point. If the pattern is not anchored, the callout |
2640 |
|
function may be called several times from the same point in the pattern |
2641 |
|
for different starting points in the subject. |
2642 |
|
|
2643 |
The current_position field contains the offset within the subject of |
The current_position field contains the offset within the subject of |
2644 |
the current match pointer. |
the current match pointer. |
2701 |
|
|
2702 |
REVISION |
REVISION |
2703 |
|
|
2704 |
Last updated: 06 March 2007 |
Last updated: 29 May 2007 |
2705 |
Copyright (c) 1997-2007 University of Cambridge. |
Copyright (c) 1997-2007 University of Cambridge. |
2706 |
------------------------------------------------------------------------------ |
------------------------------------------------------------------------------ |
2707 |
|
|
2717 |
|
|
2718 |
This document describes the differences in the ways that PCRE and Perl |
This document describes the differences in the ways that PCRE and Perl |
2719 |
handle regular expressions. The differences described here are mainly |
handle regular expressions. The differences described here are mainly |
2720 |
with respect to Perl 5.8, though PCRE version 7.0 contains some fea- |
with respect to Perl 5.8, though PCRE versions 7.0 and later contain |
2721 |
tures that are expected to be in the forthcoming Perl 5.10. |
some features that are expected to be in the forthcoming Perl 5.10. |
2722 |
|
|
2723 |
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 |
2724 |
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 |
2783 |
matching "aba" against the pattern /^(a(b)?)+$/ in Perl leaves $2 |
matching "aba" against the pattern /^(a(b)?)+$/ in Perl leaves $2 |
2784 |
unset, but in PCRE it is set to "b". |
unset, but in PCRE it is set to "b". |
2785 |
|
|
2786 |
11. PCRE provides some extensions to the Perl regular expression facil- |
11. PCRE does support Perl 5.10's backtracking verbs (*ACCEPT), |
2787 |
|
(*FAIL), (*F), (*COMMIT), (*PRUNE), (*SKIP), and (*THEN), but only in |
2788 |
|
the forms without an argument. PCRE does not support (*MARK). If |
2789 |
|
(*ACCEPT) is within capturing parentheses, PCRE does not set that cap- |
2790 |
|
ture group; this is different to Perl. |
2791 |
|
|
2792 |
|
12. PCRE provides some extensions to the Perl regular expression facil- |
2793 |
ities. Perl 5.10 will include new features that are not in earlier |
ities. Perl 5.10 will include new features that are not in earlier |
2794 |
versions, some of which (such as named parentheses) have been in PCRE |
versions, some of which (such as named parentheses) have been in PCRE |
2795 |
for some time. This list is with respect to Perl 5.10: |
for some time. This list is with respect to Perl 5.10: |
2802 |
meta-character matches only at the very end of the string. |
meta-character matches only at the very end of the string. |
2803 |
|
|
2804 |
(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- |
2805 |
cial meaning is faulted. Otherwise, like Perl, the backslash is |
cial meaning is faulted. Otherwise, like Perl, the backslash is quietly |
2806 |
ignored. (Perl can be made to issue a warning.) |
ignored. (Perl can be made to issue a warning.) |
2807 |
|
|
2808 |
(d) If PCRE_UNGREEDY is set, the greediness of the repetition quanti- |
(d) If PCRE_UNGREEDY is set, the greediness of the repetition quanti- |
2809 |
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- |
2815 |
(f) The PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, and PCRE_NO_AUTO_CAP- |
(f) The PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, and PCRE_NO_AUTO_CAP- |
2816 |
TURE options for pcre_exec() have no Perl equivalents. |
TURE options for pcre_exec() have no Perl equivalents. |
2817 |
|
|
2818 |
(g) The callout facility is PCRE-specific. |
(g) The \R escape sequence can be restricted to match only CR, LF, or |
2819 |
|
CRLF by the PCRE_BSR_ANYCRLF option. |
2820 |
|
|
2821 |
|
(h) The callout facility is PCRE-specific. |
2822 |
|
|
2823 |
(h) The partial matching facility is PCRE-specific. |
(i) The partial matching facility is PCRE-specific. |
2824 |
|
|
2825 |
(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, |
2826 |
even on different hosts that have the other endianness. |
even on different hosts that have the other endianness. |
2827 |
|
|
2828 |
(j) The alternative matching function (pcre_dfa_exec()) matches in a |
(k) The alternative matching function (pcre_dfa_exec()) matches in a |
2829 |
different way and is not Perl-compatible. |
different way and is not Perl-compatible. |
2830 |
|
|
2831 |
|
(l) PCRE recognizes some special sequences such as (*CR) at the start |
2832 |
|
of a pattern that set overall options that cannot be changed within the |
2833 |
|
pattern. |
2834 |
|
|
2835 |
|
|
2836 |
AUTHOR |
AUTHOR |
2837 |
|
|
2842 |
|
|
2843 |
REVISION |
REVISION |
2844 |
|
|
2845 |
Last updated: 06 March 2007 |
Last updated: 11 September 2007 |
2846 |
Copyright (c) 1997-2007 University of Cambridge. |
Copyright (c) 1997-2007 University of Cambridge. |
2847 |
------------------------------------------------------------------------------ |
------------------------------------------------------------------------------ |
2848 |
|
|
2856 |
|
|
2857 |
PCRE REGULAR EXPRESSION DETAILS |
PCRE REGULAR EXPRESSION DETAILS |
2858 |
|
|
2859 |
The syntax and semantics of the regular expressions supported by PCRE |
The syntax and semantics of the regular expressions that are supported |
2860 |
are described below. Regular expressions are also described in the Perl |
by PCRE are described in detail below. There is a quick-reference syn- |
2861 |
documentation and in a number of books, some of which have copious |
tax summary in the pcresyntax page. Perl's regular expressions are |
2862 |
examples. Jeffrey Friedl's "Mastering Regular Expressions", published |
described in its own documentation, and regular expressions in general |
2863 |
by O'Reilly, covers regular expressions in great detail. This descrip- |
are covered in a number of books, some of which have copious examples. |
2864 |
tion of PCRE's regular expressions is intended as reference material. |
Jeffrey Friedl's "Mastering Regular Expressions", published by |
2865 |
|
O'Reilly, covers regular expressions in great detail. This description |
2866 |
|
of PCRE's regular expressions is intended as reference material. |
2867 |
|
|
2868 |
The original operation of PCRE was on strings of one-byte characters. |
The original operation of PCRE was on strings of one-byte characters. |
2869 |
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 |
2877 |
ported by PCRE when its main matching function, pcre_exec(), is used. |
ported by PCRE when its main matching function, pcre_exec(), is used. |
2878 |
From release 6.0, PCRE offers a second matching function, |
From release 6.0, PCRE offers a second matching function, |
2879 |
pcre_dfa_exec(), which matches using a different algorithm that is not |
pcre_dfa_exec(), which matches using a different algorithm that is not |
2880 |
Perl-compatible. The advantages and disadvantages of the alternative |
Perl-compatible. Some of the features discussed below are not available |
2881 |
function, and how it differs from the normal function, are discussed in |
when pcre_dfa_exec() is used. The advantages and disadvantages of the |
2882 |
the pcrematching page. |
alternative function, and how it differs from the normal function, are |
2883 |
|
discussed in the pcrematching page. |
2884 |
|
|
2885 |
|
|
2886 |
|
NEWLINE CONVENTIONS |
2887 |
|
|
2888 |
|
PCRE supports five different conventions for indicating line breaks in |
2889 |
|
strings: a single CR (carriage return) character, a single LF (line- |
2890 |
|
feed) character, the two-character sequence CRLF, any of the three pre- |
2891 |
|
ceding, or any Unicode newline sequence. The pcreapi page has further |
2892 |
|
discussion about newlines, and shows how to set the newline convention |
2893 |
|
in the options arguments for the compiling and matching functions. |
2894 |
|
|
2895 |
|
It is also possible to specify a newline convention by starting a pat- |
2896 |
|
tern string with one of the following five sequences: |
2897 |
|
|
2898 |
|
(*CR) carriage return |
2899 |
|
(*LF) linefeed |
2900 |
|
(*CRLF) carriage return, followed by linefeed |
2901 |
|
(*ANYCRLF) any of the three above |
2902 |
|
(*ANY) all Unicode newline sequences |
2903 |
|
|
2904 |
|
These override the default and the options given to pcre_compile(). For |
2905 |
|
example, on a Unix system where LF is the default newline sequence, the |
2906 |
|
pattern |
2907 |
|
|
2908 |
|
(*CR)a.b |
2909 |
|
|
2910 |
|
changes the convention to CR. That pattern matches "a\nb" because LF is |
2911 |
|
no longer a newline. Note that these special settings, which are not |
2912 |
|
Perl-compatible, are recognized only at the very start of a pattern, |
2913 |
|
and that they must be in upper case. If more than one of them is |
2914 |
|
present, the last one is used. |
2915 |
|
|
2916 |
|
The newline convention does not affect what the \R escape sequence |
2917 |
|
matches. By default, this is any Unicode newline sequence, for Perl |
2918 |
|
compatibility. However, this can be changed; see the description of \R |
2919 |
|
in the section entitled "Newline sequences" below. A change of \R set- |
2920 |
|
ting can be combined with a change of newline convention. |
2921 |
|
|
2922 |
|
|
2923 |
CHARACTERS AND METACHARACTERS |
CHARACTERS AND METACHARACTERS |
2924 |
|
|
2925 |
A regular expression is a pattern that is matched against a subject |
A regular expression is a pattern that is matched against a subject |
2926 |
string from left to right. Most characters stand for themselves in a |
string from left to right. Most characters stand for themselves in a |
2927 |
pattern, and match the corresponding characters in the subject. As a |
pattern, and match the corresponding characters in the subject. As a |
2928 |
trivial example, the pattern |
trivial example, the pattern |
2929 |
|
|
2930 |
The quick brown fox |
The quick brown fox |
2931 |
|
|
2932 |
matches a portion of a subject string that is identical to itself. When |
matches a portion of a subject string that is identical to itself. When |
2933 |
caseless matching is specified (the PCRE_CASELESS option), letters are |
caseless matching is specified (the PCRE_CASELESS option), letters are |
2934 |
matched independently of case. In UTF-8 mode, PCRE always understands |
matched independently of case. In UTF-8 mode, PCRE always understands |
2935 |
the concept of case for characters whose values are less than 128, so |
the concept of case for characters whose values are less than 128, so |
2936 |
caseless matching is always possible. For characters with higher val- |
caseless matching is always possible. For characters with higher val- |
2937 |
ues, the concept of case is supported if PCRE is compiled with Unicode |
ues, the concept of case is supported if PCRE is compiled with Unicode |
2938 |
property support, but not otherwise. If you want to use caseless |
property support, but not otherwise. If you want to use caseless |
2939 |
matching for characters 128 and above, you must ensure that PCRE is |
matching for characters 128 and above, you must ensure that PCRE is |
2940 |
compiled with Unicode property support as well as with UTF-8 support. |
compiled with Unicode property support as well as with UTF-8 support. |
2941 |
|
|
2942 |
The power of regular expressions comes from the ability to include |
The power of regular expressions comes from the ability to include |
2943 |
alternatives and repetitions in the pattern. These are encoded in the |
alternatives and repetitions in the pattern. These are encoded in the |
2944 |
pattern by the use of metacharacters, which do not stand for themselves |
pattern by the use of metacharacters, which do not stand for themselves |
2945 |
but instead are interpreted in some special way. |
but instead are interpreted in some special way. |
2946 |
|
|
2947 |
There are two different sets of metacharacters: those that are recog- |
There are two different sets of metacharacters: those that are recog- |
2948 |
nized anywhere in the pattern except within square brackets, and those |
nized anywhere in the pattern except within square brackets, and those |
2949 |
that are recognized within square brackets. Outside square brackets, |
that are recognized within square brackets. Outside square brackets, |
2950 |
the metacharacters are as follows: |
the metacharacters are as follows: |
2951 |
|
|
2952 |
\ general escape character with several uses |
\ general escape character with several uses |
2965 |
also "possessive quantifier" |
also "possessive quantifier" |
2966 |
{ start min/max quantifier |
{ start min/max quantifier |
2967 |
|
|
2968 |
Part of a pattern that is in square brackets is called a "character |
Part of a pattern that is in square brackets is called a "character |
2969 |
class". In a character class the only metacharacters are: |
class". In a character class the only metacharacters are: |
2970 |
|
|
2971 |
\ general escape character |
\ general escape character |
2975 |
syntax) |
syntax) |
2976 |
] terminates the character class |
] terminates the character class |
2977 |
|
|
2978 |
The following sections describe the use of each of the metacharacters. |
The following sections describe the use of each of the metacharacters. |
2979 |
|
|
2980 |
|
|
2981 |
BACKSLASH |
BACKSLASH |
2982 |
|
|
2983 |
The backslash character has several uses. Firstly, if it is followed by |
The backslash character has several uses. Firstly, if it is followed by |
2984 |
a non-alphanumeric character, it takes away any special meaning that |
a non-alphanumeric character, it takes away any special meaning that |
2985 |
character may have. This use of backslash as an escape character |
character may have. This use of backslash as an escape character |
2986 |
applies both inside and outside character classes. |
applies both inside and outside character classes. |
2987 |
|
|
2988 |
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 |
2989 |
pattern. This escaping action applies whether or not the following |
pattern. This escaping action applies whether or not the following |
2990 |
character would otherwise be interpreted as a metacharacter, so it is |
character would otherwise be interpreted as a metacharacter, so it is |
2991 |
always safe to precede a non-alphanumeric with backslash to specify |
always safe to precede a non-alphanumeric with backslash to specify |
2992 |
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- |
2993 |
slash, you write \\. |
slash, you write \\. |
2994 |
|
|
2995 |
If a pattern is compiled with the PCRE_EXTENDED option, whitespace in |
If a pattern is compiled with the PCRE_EXTENDED option, whitespace in |
2996 |
the pattern (other than in a character class) and characters between a |
the pattern (other than in a character class) and characters between a |
2997 |
# outside a character class and the next newline are ignored. An escap- |
# outside a character class and the next newline are ignored. An escap- |
2998 |
ing backslash can be used to include a whitespace or # character as |
ing backslash can be used to include a whitespace or # character as |
2999 |
part of the pattern. |
part of the pattern. |
3000 |
|
|
3001 |
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- |
3002 |
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- |
3003 |
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 |
3004 |
sequences in PCRE, whereas in Perl, $ and @ cause variable interpola- |
sequences in PCRE, whereas in Perl, $ and @ cause variable interpola- |
3005 |
tion. Note the following examples: |
tion. Note the following examples: |
3006 |
|
|
3007 |
Pattern PCRE matches Perl matches |
Pattern PCRE matches Perl matches |
3011 |
\Qabc\$xyz\E abc\$xyz abc\$xyz |
\Qabc\$xyz\E abc\$xyz abc\$xyz |
3012 |
\Qabc\E\$\Qxyz\E abc$xyz abc$xyz |
\Qabc\E\$\Qxyz\E abc$xyz abc$xyz |
3013 |
|
|
3014 |
The \Q...\E sequence is recognized both inside and outside character |
The \Q...\E sequence is recognized both inside and outside character |
3015 |
classes. |
classes. |
3016 |
|
|
3017 |
Non-printing characters |
Non-printing characters |
3018 |
|
|
3019 |
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- |
3020 |
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 |
3021 |
appearance of non-printing characters, apart from the binary zero that |
appearance of non-printing characters, apart from the binary zero that |
3022 |
terminates a pattern, but when a pattern is being prepared by text |
terminates a pattern, but when a pattern is being prepared by text |
3023 |
editing, it is usually easier to use one of the following escape |
editing, it is usually easier to use one of the following escape |
3024 |
sequences than the binary character it represents: |
sequences than the binary character it represents: |
3025 |
|
|
3026 |
\a alarm, that is, the BEL character (hex 07) |
\a alarm, that is, the BEL character (hex 07) |
3027 |
\cx "control-x", where x is any character |
\cx "control-x", where x is any character |
3028 |
\e escape (hex 1B) |
\e escape (hex 1B) |
3029 |
\f formfeed (hex 0C) |
\f formfeed (hex 0C) |
3030 |
\n newline (hex 0A) |
\n linefeed (hex 0A) |
3031 |
\r carriage return (hex 0D) |
\r carriage return (hex 0D) |
3032 |
\t tab (hex 09) |
\t tab (hex 09) |
3033 |
\ddd character with octal code ddd, or backreference |
\ddd character with octal code ddd, or backreference |
3034 |
\xhh character with hex code hh |
\xhh character with hex code hh |
3035 |
\x{hhh..} character with hex code hhh.. |
\x{hhh..} character with hex code hhh.. |
3036 |
|
|
3037 |
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, |
3038 |
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 |
3039 |
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; |
3040 |
becomes hex 7B. |
becomes hex 7B. |
3041 |
|
|
3042 |
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 |
3043 |
in upper or lower case). Any number of hexadecimal digits may appear |
in upper or lower case). Any number of hexadecimal digits may appear |
3044 |
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 |
3045 |
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, |
3046 |
the maximum hexadecimal value is 7FFFFFFF). If characters other than |
the maximum value in hexadecimal is 7FFFFFFF. Note that this is bigger |
3047 |
hexadecimal digits appear between \x{ and }, or if there is no termi- |
than the largest Unicode code point, which is 10FFFF. |
3048 |
nating }, this form of escape is not recognized. Instead, the initial |
|
3049 |
\x will be interpreted as a basic hexadecimal escape, with no following |
If characters other than hexadecimal digits appear between \x{ and }, |
3050 |
digits, giving a character whose value is zero. |
or if there is no terminating }, this form of escape is not recognized. |
3051 |
|
Instead, the initial \x will be interpreted as a basic hexadecimal |
3052 |
|
escape, with no following digits, giving a character whose value is |
3053 |
|
zero. |
3054 |
|
|
3055 |
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 |
3056 |
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- |
3105 |
|
|
3106 |
Absolute and relative back references |
Absolute and relative back references |
3107 |
|
|
3108 |
The sequence \g followed by a positive or negative number, optionally |
The sequence \g followed by an unsigned or a negative number, option- |
3109 |
enclosed in braces, is an absolute or relative back reference. Back |
ally enclosed in braces, is an absolute or relative back reference. A |
3110 |
references are discussed later, following the discussion of parenthe- |
named back reference can be coded as \g{name}. Back references are dis- |
3111 |
sized subpatterns. |
cussed later, following the discussion of parenthesized subpatterns. |
3112 |
|
|
3113 |
Generic character types |
Generic character types |
3114 |
|
|
3117 |
|
|
3118 |
\d any decimal digit |
\d any decimal digit |
3119 |
\D any character that is not a decimal digit |
\D any character that is not a decimal digit |
3120 |
|
\h any horizontal whitespace character |
3121 |
|
\H any character that is not a horizontal whitespace character |
3122 |
\s any whitespace character |
\s any whitespace character |
3123 |
\S any character that is not a whitespace character |
\S any character that is not a whitespace character |
3124 |
|
\v any vertical whitespace character |
3125 |
|
\V any character that is not a vertical whitespace character |
3126 |
\w any "word" character |
\w any "word" character |
3127 |
\W any "non-word" character |
\W any "non-word" character |
3128 |
|
|
3137 |
|
|
3138 |
For compatibility with Perl, \s does not match the VT character (code |
For compatibility with Perl, \s does not match the VT character (code |
3139 |
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 |
3140 |
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 |
3141 |
"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- |
3142 |
ter. In PCRE, it never does.) |
ter. In PCRE, it never does. |
3143 |
|
|
3144 |
|
In UTF-8 mode, characters with values greater than 128 never match \d, |
3145 |
|
\s, or \w, and always match \D, \S, and \W. This is true even when Uni- |
3146 |
|
code character property support is available. These sequences retain |
3147 |
|
their original meanings from before UTF-8 support was available, mainly |
3148 |
|
for efficiency reasons. |
3149 |
|
|
3150 |
|
The sequences \h, \H, \v, and \V are Perl 5.10 features. In contrast to |
3151 |
|
the other sequences, these do match certain high-valued codepoints in |
3152 |
|
UTF-8 mode. The horizontal space characters are: |
3153 |
|
|
3154 |
|
U+0009 Horizontal tab |
3155 |
|
U+0020 Space |
3156 |
|
U+00A0 Non-break space |
3157 |
|
U+1680 Ogham space mark |
3158 |
|
U+180E Mongolian vowel separator |
3159 |
|
U+2000 En quad |
3160 |
|
U+2001 Em quad |
3161 |
|
U+2002 En space |
3162 |
|
U+2003 Em space |
3163 |
|
U+2004 Three-per-em space |
3164 |
|
U+2005 Four-per-em space |
3165 |
|
U+2006 Six-per-em space |
3166 |
|
U+2007 Figure space |
3167 |
|
U+2008 Punctuation space |
3168 |
|
U+2009 Thin space |
3169 |
|
U+200A Hair space |
3170 |
|
U+202F Narrow no-break space |
3171 |
|
U+205F Medium mathematical space |
3172 |
|
U+3000 Ideographic space |
3173 |
|
|
3174 |
|
The vertical space characters are: |
3175 |
|
|
3176 |
|
U+000A Linefeed |
3177 |
|
U+000B Vertical tab |
3178 |
|
U+000C Formfeed |
3179 |
|
U+000D Carriage return |
3180 |
|
U+0085 Next line |
3181 |
|
U+2028 Line separator |
3182 |
|
U+2029 Paragraph separator |
3183 |
|
|
3184 |
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 |
3185 |
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- |
3187 |
specific matching is taking place (see "Locale support" in the pcreapi |
specific matching is taking place (see "Locale support" in the pcreapi |
3188 |
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 |
3189 |
systems, or "french" in Windows, some character codes greater than 128 |
systems, or "french" in Windows, some character codes greater than 128 |
3190 |
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 |
3191 |
|
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. |
|
3192 |
|
|
3193 |
Newline sequences |
Newline sequences |
3194 |
|
|
3195 |
Outside a character class, the escape sequence \R matches any Unicode |
Outside a character class, by default, the escape sequence \R matches |
3196 |
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 |
3197 |
equivalent to the following: |
mode \R is equivalent to the following: |
3198 |
|
|
3199 |
(?>\r\n|\n|\x0b|\f|\r|\x85) |
(?>\r\n|\n|\x0b|\f|\r|\x85) |
3200 |
|
|
3210 |
rator, U+2029). Unicode character property support is not needed for |
rator, U+2029). Unicode character property support is not needed for |
3211 |
these characters to be recognized. |
these characters to be recognized. |
3212 |
|
|
3213 |
|
It is possible to restrict \R to match only CR, LF, or CRLF (instead of |
3214 |
|
the complete set of Unicode line endings) by setting the option |
3215 |
|
PCRE_BSR_ANYCRLF either at compile time or when the pattern is matched. |
3216 |
|
(BSR is an abbrevation for "backslash R".) This can be made the default |
3217 |
|
when PCRE is built; if this is the case, the other behaviour can be |
3218 |
|
requested via the PCRE_BSR_UNICODE option. It is also possible to |
3219 |
|
specify these settings by starting a pattern string with one of the |
3220 |
|
following sequences: |
3221 |
|
|
3222 |
|
(*BSR_ANYCRLF) CR, LF, or CRLF only |
3223 |
|
(*BSR_UNICODE) any Unicode newline sequence |
3224 |
|
|
3225 |
|
These override the default and the options given to pcre_compile(), but |
3226 |
|
they can be overridden by options given to pcre_exec(). Note that these |
3227 |
|
special settings, which are not Perl-compatible, are recognized only at |
3228 |
|
the very start of a pattern, and that they must be in upper case. If |
3229 |
|
more than one of them is present, the last one is used. They can be |
3230 |
|
combined with a change of newline convention, for example, a pattern |
3231 |
|
can start with: |
3232 |
|
|
3233 |
|
(*ANY)(*BSR_ANYCRLF) |
3234 |
|
|
3235 |
Inside a character class, \R matches the letter "R". |
Inside a character class, \R matches the letter "R". |
3236 |
|
|
3237 |
Unicode character properties |
Unicode character properties |
3238 |
|
|
3239 |
When PCRE is built with Unicode character property support, three addi- |
When PCRE is built with Unicode character property support, three addi- |
3240 |
tional escape sequences to match character properties are available |
tional escape sequences that match characters with specific properties |
3241 |
when UTF-8 mode is selected. They are: |
are available. When not in UTF-8 mode, these sequences are of course |
3242 |
|
limited to testing characters whose codepoints are less than 256, but |
3243 |
|
they do work in this mode. The extra escape sequences are: |
3244 |
|
|
3245 |
\p{xx} a character with the xx property |
\p{xx} a character with the xx property |
3246 |
\P{xx} a character without the xx property |
\P{xx} a character without the xx property |
3247 |
\X an extended Unicode sequence |
\X an extended Unicode sequence |
3248 |
|
|
3249 |
The property names represented by xx above are limited to the Unicode |
The property names represented by xx above are limited to the Unicode |
3250 |
script names, the general category properties, and "Any", which matches |
script names, the general category properties, and "Any", which matches |
3251 |
any character (including newline). Other properties such as "InMusical- |
any character (including newline). Other properties such as "InMusical- |
3252 |
Symbols" are not currently supported by PCRE. Note that \P{Any} does |
Symbols" are not currently supported by PCRE. Note that \P{Any} does |
3253 |
not match any characters, so always causes a match failure. |
not match any characters, so always causes a match failure. |
3254 |
|
|
3255 |
Sets of Unicode characters are defined as belonging to certain scripts. |
Sets of Unicode characters are defined as belonging to certain scripts. |
3256 |
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. |
3257 |
For example: |
For example: |
3258 |
|
|
3259 |
\p{Greek} |
\p{Greek} |
3260 |
\P{Han} |
\P{Han} |
3261 |
|
|
3262 |
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 |
3263 |
"Common". The current list of scripts is: |
"Common". The current list of scripts is: |
3264 |
|
|
3265 |
Arabic, Armenian, Balinese, Bengali, Bopomofo, Braille, Buginese, |
Arabic, Armenian, Balinese, Bengali, Bopomofo, Braille, Buginese, |
3266 |
Buhid, Canadian_Aboriginal, Cherokee, Common, Coptic, Cuneiform, |
Buhid, Canadian_Aboriginal, Cherokee, Common, Coptic, Cuneiform, |
3267 |
Cypriot, Cyrillic, Deseret, Devanagari, Ethiopic, Georgian, Glagolitic, |
Cypriot, Cyrillic, Deseret, Devanagari, Ethiopic, Georgian, Glagolitic, |
3268 |
Gothic, Greek, Gujarati, Gurmukhi, Han, Hangul, Hanunoo, Hebrew, Hira- |
Gothic, Greek, Gujarati, Gurmukhi, Han, Hangul, Hanunoo, Hebrew, Hira- |
3269 |
gana, Inherited, Kannada, Katakana, Kharoshthi, Khmer, Lao, Latin, |
gana, Inherited, Kannada, Katakana, Kharoshthi, Khmer, Lao, Latin, |
3270 |
Limbu, Linear_B, Malayalam, Mongolian, Myanmar, New_Tai_Lue, Nko, |
Limbu, Linear_B, Malayalam, Mongolian, Myanmar, New_Tai_Lue, Nko, |
3271 |
Ogham, Old_Italic, Old_Persian, Oriya, Osmanya, Phags_Pa, Phoenician, |
Ogham, Old_Italic, Old_Persian, Oriya, Osmanya, Phags_Pa, Phoenician, |
3272 |
Runic, Shavian, Sinhala, Syloti_Nagri, Syriac, Tagalog, Tagbanwa, |
Runic, Shavian, Sinhala, Syloti_Nagri, Syriac, Tagalog, Tagbanwa, |
3273 |
Tai_Le, Tamil, Telugu, Thaana, Thai, Tibetan, Tifinagh, Ugaritic, Yi. |
Tai_Le, Tamil, Telugu, Thaana, Thai, Tibetan, Tifinagh, Ugaritic, Yi. |
3274 |
|
|
3275 |
Each character has exactly one general category property, specified by |
Each character has exactly one general category property, specified by |
3276 |
a two-letter abbreviation. For compatibility with Perl, negation can be |
a two-letter abbreviation. For compatibility with Perl, negation can be |
3277 |
specified by including a circumflex between the opening brace and the |
specified by including a circumflex between the opening brace and the |
3278 |
property name. For example, \p{^Lu} is the same as \P{Lu}. |
property name. For example, \p{^Lu} is the same as \P{Lu}. |
3279 |
|
|
3280 |
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- |
3281 |
eral category properties that start with that letter. In this case, in |
eral category properties that start with that letter. In this case, in |
3282 |
the absence of negation, the curly brackets in the escape sequence are |
the absence of negation, the curly brackets in the escape sequence are |
3283 |
optional; these two examples have the same effect: |
optional; these two examples have the same effect: |
3284 |
|
|
3285 |
\p{L} |
\p{L} |
3331 |
Zp Paragraph separator |
Zp Paragraph separator |
3332 |
Zs Space separator |
Zs Space separator |
3333 |
|
|
3334 |
The special property L& is also supported: it matches a character that |
The special property L& is also supported: it matches a character that |
3335 |
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 |
3336 |
classified as a modifier or "other". |
classified as a modifier or "other". |
3337 |
|
|
3338 |
The long synonyms for these properties that Perl supports (such as |
The Cs (Surrogate) property applies only to characters in the range |
3339 |
\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 |
3340 |
|
RFC 3629) and so cannot be tested by PCRE, unless UTF-8 validity check- |
3341 |
|
ing has been turned off (see the discussion of PCRE_NO_UTF8_CHECK in |
3342 |
|
the pcreapi page). |
3343 |
|
|
3344 |
|
The long synonyms for these properties that Perl supports (such as |
3345 |
|
\p{Letter}) are not supported by PCRE, nor is it permitted to prefix |
3346 |
any of these properties with "Is". |
any of these properties with "Is". |
3347 |
|
|
3348 |
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- |
3349 |
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 |
3350 |
in the Unicode table. |
in the Unicode table. |
3351 |
|
|
3352 |
Specifying caseless matching does not affect these escape sequences. |
Specifying caseless matching does not affect these escape sequences. |
3353 |
For example, \p{Lu} always matches only upper case letters. |
For example, \p{Lu} always matches only upper case letters. |
3354 |
|
|
3355 |
The \X escape matches any number of Unicode characters that form an |
The \X escape matches any number of Unicode characters that form an |
3356 |
extended Unicode sequence. \X is equivalent to |
extended Unicode sequence. \X is equivalent to |
3357 |
|
|
3358 |
(?>\PM\pM*) |
(?>\PM\pM*) |
3359 |
|
|
3360 |
That is, it matches a character without the "mark" property, followed |
That is, it matches a character without the "mark" property, followed |
3361 |
by zero or more characters with the "mark" property, and treats the |
by zero or more characters with the "mark" property, and treats the |
3362 |
sequence as an atomic group (see below). Characters with the "mark" |
sequence as an atomic group (see below). Characters with the "mark" |
3363 |
property are typically accents that affect the preceding character. |
property are typically accents that affect the preceding character. |
3364 |
|
None of them have codepoints less than 256, so in non-UTF-8 mode \X |
3365 |
|
matches any one character. |
3366 |
|
|
3367 |
Matching characters by Unicode property is not fast, because PCRE has |
Matching characters by Unicode property is not fast, because PCRE has |
3368 |
to search a structure that contains data for over fifteen thousand |
to search a structure that contains data for over fifteen thousand |
3369 |
characters. That is why the traditional escape sequences such as \d and |
characters. That is why the traditional escape sequences such as \d and |
3370 |
\w do not use Unicode properties in PCRE. |
\w do not use Unicode properties in PCRE. |
3371 |
|
|
3372 |
|
Resetting the match start |
3373 |
|
|
3374 |
|
The escape sequence \K, which is a Perl 5.10 feature, causes any previ- |
3375 |
|
ously matched characters not to be included in the final matched |
3376 |
|
sequence. For example, the pattern: |
3377 |
|
|
3378 |
|
foo\Kbar |
3379 |
|
|
3380 |
|
matches "foobar", but reports that it has matched "bar". This feature |
3381 |
|
is similar to a lookbehind assertion (described below). However, in |
3382 |
|
this case, the part of the subject before the real match does not have |
3383 |
|
to be of fixed length, as lookbehind assertions do. The use of \K does |
3384 |
|
not interfere with the setting of captured substrings. For example, |
3385 |
|
when the pattern |
3386 |
|
|
3387 |
|
(foo)\Kbar |
3388 |
|
|
3389 |
|
matches "foobar", the first substring is still set to "foo". |
3390 |
|
|
3391 |
Simple assertions |
Simple assertions |
3392 |
|
|
3393 |
The final use of backslash is for certain simple assertions. An asser- |
The final use of backslash is for certain simple assertions. An asser- |
3687 |
INTERNAL OPTION SETTING |
INTERNAL OPTION SETTING |
3688 |
|
|
3689 |
The settings of the PCRE_CASELESS, PCRE_MULTILINE, PCRE_DOTALL, and |
The settings of the PCRE_CASELESS, PCRE_MULTILINE, PCRE_DOTALL, and |
3690 |
PCRE_EXTENDED options can be changed from within the pattern by a |
PCRE_EXTENDED options (which are Perl-compatible) can be changed from |
3691 |
sequence of Perl option letters enclosed between "(?" and ")". The |
within the pattern by a sequence of Perl option letters enclosed |
3692 |
option letters are |
between "(?" and ")". The option letters are |
3693 |
|
|
3694 |
i for PCRE_CASELESS |
i for PCRE_CASELESS |
3695 |
m for PCRE_MULTILINE |
m for PCRE_MULTILINE |
3703 |
is also permitted. If a letter appears both before and after the |
is also permitted. If a letter appears both before and after the |
3704 |
hyphen, the option is unset. |
hyphen, the option is unset. |
3705 |
|
|
3706 |
|
The PCRE-specific options PCRE_DUPNAMES, PCRE_UNGREEDY, and PCRE_EXTRA |
3707 |
|
can be changed in the same way as the Perl-compatible options by using |
3708 |
|
the characters J, U and X respectively. |
3709 |
|
|
3710 |
When an option change occurs at top level (that is, not inside subpat- |
When an option change occurs at top level (that is, not inside subpat- |
3711 |
tern parentheses), the change applies to the remainder of the pattern |
tern parentheses), the change applies to the remainder of the pattern |
3712 |
that follows. If the change is placed right at the start of a pattern, |
that follows. If the change is placed right at the start of a pattern, |
3732 |
the effects of option settings happen at compile time. There would be |
the effects of option settings happen at compile time. There would be |
3733 |
some very weird behaviour otherwise. |
some very weird behaviour otherwise. |
3734 |
|
|
3735 |
The PCRE-specific options PCRE_DUPNAMES, PCRE_UNGREEDY, and PCRE_EXTRA |
Note: There are other PCRE-specific options that can be set by the |
3736 |
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 |
3737 |
the characters J, U and X respectively. |
cases the pattern can contain special leading sequences to override |
3738 |
|
what the application has set or what has been defaulted. Details are |
3739 |
|
given in the section entitled "Newline sequences" above. |
3740 |
|
|
3741 |
|
|
3742 |
SUBPATTERNS |
SUBPATTERNS |
3794 |
"Saturday". |
"Saturday". |
3795 |
|
|
3796 |
|
|
3797 |
|
DUPLICATE SUBPATTERN NUMBERS |
3798 |
|
|
3799 |
|
Perl 5.10 introduced a feature whereby each alternative in a subpattern |
3800 |
|
uses the same numbers for its capturing parentheses. Such a subpattern |
3801 |
|
starts with (?| and is itself a non-capturing subpattern. For example, |
3802 |
|
consider this pattern: |
3803 |
|
|
3804 |
|
(?|(Sat)ur|(Sun))day |
3805 |
|
|
3806 |
|
Because the two alternatives are inside a (?| group, both sets of cap- |
3807 |
|
turing parentheses are numbered one. Thus, when the pattern matches, |
3808 |
|
you can look at captured substring number one, whichever alternative |
3809 |
|
matched. This construct is useful when you want to capture part, but |
3810 |
|
not all, of one of a number of alternatives. Inside a (?| group, paren- |
3811 |
|
theses are numbered as usual, but the number is reset at the start of |
3812 |
|
each branch. The numbers of any capturing buffers that follow the sub- |
3813 |
|
pattern start after the highest number used in any branch. The follow- |
3814 |
|
ing example is taken from the Perl documentation. The numbers under- |
3815 |
|
neath show in which buffer the captured content will be stored. |
3816 |
|
|
3817 |
|
# before ---------------branch-reset----------- after |
3818 |
|
/ ( a ) (?| x ( y ) z | (p (q) r) | (t) u (v) ) ( z ) /x |
3819 |
|
# 1 2 2 3 2 3 4 |
3820 |
|
|
3821 |
|
A backreference or a recursive call to a numbered subpattern always |
3822 |
|
refers to the first one in the pattern with the given number. |
3823 |
|
|
3824 |
|
An alternative approach to using this "branch reset" feature is to use |
3825 |
|
duplicate named subpatterns, as described in the next section. |
3826 |
|
|
3827 |
|
|
3828 |
NAMED SUBPATTERNS |
NAMED SUBPATTERNS |
3829 |
|
|
3830 |
Identifying capturing parentheses by number is simple, but it can be |
Identifying capturing parentheses by number is simple, but it can be |
3864 |
(?<DN>Sat)(?:urday)? |
(?<DN>Sat)(?:urday)? |
3865 |
|
|
3866 |
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 |
3867 |
match. The convenience function for extracting the data by name |
match. (An alternative way of solving this problem is to use a "branch |
3868 |
returns the substring for the first (and in this example, the only) |
reset" subpattern, as described in the previous section.) |
3869 |
subpattern of that name that matched. This saves searching to find |
|
3870 |
which numbered subpattern it was. If you make a reference to a non- |
The convenience function for extracting the data by name returns the |
3871 |
unique named subpattern from elsewhere in the pattern, the one that |
substring for the first (and in this example, the only) subpattern of |
3872 |
corresponds to the lowest number is used. For further details of the |
that name that matched. This saves searching to find which numbered |
3873 |
interfaces for handling named subpatterns, see the pcreapi documenta- |
subpattern it was. If you make a reference to a non-unique named sub- |
3874 |
tion. |
pattern from elsewhere in the pattern, the one that corresponds to the |
3875 |
|
lowest number is used. For further details of the interfaces for han- |
3876 |
|
dling named subpatterns, see the pcreapi documentation. |
3877 |
|
|
3878 |
|
|
3879 |
REPETITION |
REPETITION |
4078 |
|
|
4079 |
\d++foo |
\d++foo |
4080 |
|
|
4081 |
Possessive quantifiers are always greedy; the setting of the |
Note that a possessive quantifier can be used with an entire group, for |
4082 |
|
example: |
4083 |
|
|
4084 |
|
(abc|xyz){2,3}+ |
4085 |
|
|
4086 |
|
Possessive quantifiers are always greedy; the setting of the |
4087 |
PCRE_UNGREEDY option is ignored. They are a convenient notation for the |
PCRE_UNGREEDY option is ignored. They are a convenient notation for the |
4088 |
simpler forms of atomic group. However, there is no difference in the |
simpler forms of atomic group. However, there is no difference in the |
4089 |
meaning of a possessive quantifier and the equivalent atomic group, |
meaning of a possessive quantifier and the equivalent atomic group, |
4090 |
though there may be a performance difference; possessive quantifiers |
though there may be a performance difference; possessive quantifiers |
4091 |
should be slightly faster. |
should be slightly faster. |
4092 |
|
|
4093 |
The possessive quantifier syntax is an extension to the Perl 5.8 syn- |
The possessive quantifier syntax is an extension to the Perl 5.8 syn- |
4094 |
tax. Jeffrey Friedl originated the idea (and the name) in the first |
tax. Jeffrey Friedl originated the idea (and the name) in the first |
4095 |
edition of his book. Mike McCloskey liked it, so implemented it when he |
edition of his book. Mike McCloskey liked it, so implemented it when he |
4096 |
built Sun's Java package, and PCRE copied it from there. It ultimately |
built Sun's Java package, and PCRE copied it from there. It ultimately |
4097 |
found its way into Perl at release 5.10. |
found its way into Perl at release 5.10. |
4098 |
|
|
4099 |
PCRE has an optimization that automatically "possessifies" certain sim- |
PCRE has an optimization that automatically "possessifies" certain sim- |
4100 |
ple pattern constructs. For example, the sequence A+B is treated as |
ple pattern constructs. For example, the sequence A+B is treated as |
4101 |
A++B because there is no point in backtracking into a sequence of A's |
A++B because there is no point in backtracking into a sequence of A's |
4102 |
when B must follow. |
when B must follow. |
4103 |
|
|
4104 |
When a pattern contains an unlimited repeat inside a subpattern that |
When a pattern contains an unlimited repeat inside a subpattern that |
4105 |
can itself be repeated an unlimited number of times, the use of an |
can itself be repeated an unlimited number of times, the use of an |
4106 |
atomic group is the only way to avoid some failing matches taking a |
atomic group is the only way to avoid some failing matches taking a |
4107 |
very long time indeed. The pattern |
very long time indeed. The pattern |
4108 |
|
|
4109 |
(\D+|<\d+>)*[!?] |
(\D+|<\d+>)*[!?] |
4110 |
|
|
4111 |
matches an unlimited number of substrings that either consist of non- |
matches an unlimited number of substrings that either consist of non- |
4112 |
digits, or digits enclosed in <>, followed by either ! or ?. When it |
digits, or digits enclosed in <>, followed by either ! or ?. When it |
4113 |
matches, it runs quickly. However, if it is applied to |
matches, it runs quickly. However, if it is applied to |
4114 |
|
|
4115 |
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa |
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa |
4116 |
|
|
4117 |
it takes a long time before reporting failure. This is because the |
it takes a long time before reporting failure. This is because the |
4118 |
string can be divided between the internal \D+ repeat and the external |
string can be divided between the internal \D+ repeat and the external |
4119 |
* repeat in a large number of ways, and all have to be tried. (The |
* repeat in a large number of ways, and all have to be tried. (The |
4120 |
example uses [!?] rather than a single character at the end, because |
example uses [!?] rather than a single character at the end, because |
4121 |
both PCRE and Perl have an optimization that allows for fast failure |
both PCRE and Perl have an optimization that allows for fast failure |
4122 |
when a single character is used. They remember the last single charac- |
when a single character is used. They remember the last single charac- |
4123 |
ter that is required for a match, and fail early if it is not present |
ter that is required for a match, and fail early if it is not present |
4124 |
in the string.) If the pattern is changed so that it uses an atomic |
in the string.) If the pattern is changed so that it uses an atomic |
4125 |
group, like this: |
group, like this: |
4126 |
|
|
4127 |
((?>\D+)|<\d+>)*[!?] |
((?>\D+)|<\d+>)*[!?] |
4128 |
|
|
4129 |
sequences of non-digits cannot be broken, and failure happens quickly. |
sequences of non-digits cannot be broken, and failure happens quickly. |
4130 |
|
|
4131 |
|
|
4132 |
BACK REFERENCES |
BACK REFERENCES |
4133 |
|
|
4134 |
Outside a character class, a backslash followed by a digit greater than |
Outside a character class, a backslash followed by a digit greater than |
4135 |
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- |
4136 |
pattern earlier (that is, to its left) in the pattern, provided there |
pattern earlier (that is, to its left) in the pattern, provided there |
4137 |
have been that many previous capturing left parentheses. |
have been that many previous capturing left parentheses. |
4138 |
|
|
4139 |
However, if the decimal number following the backslash is less than 10, |
However, if the decimal number following the backslash is less than 10, |
4140 |
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 |
4141 |
there are not that many capturing left parentheses in the entire pat- |
there are not that many capturing left parentheses in the entire pat- |
4142 |
tern. In other words, the parentheses that are referenced need not be |
tern. In other words, the parentheses that are referenced need not be |
4143 |
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 |
4144 |
reference" of this type can make sense when a repetition is involved |
reference" of this type can make sense when a repetition is involved |
4145 |
and the subpattern to the right has participated in an earlier itera- |
and the subpattern to the right has participated in an earlier itera- |
4146 |
tion. |
tion. |
4147 |
|
|
4148 |
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 |
4149 |
subpattern whose number is 10 or more using this syntax because a |
subpattern whose number is 10 or more using this syntax because a |
4150 |
sequence such as \50 is interpreted as a character defined in octal. |
sequence such as \50 is interpreted as a character defined in octal. |
4151 |
See the subsection entitled "Non-printing characters" above for further |
See the subsection entitled "Non-printing characters" above for further |
4152 |
details of the handling of digits following a backslash. There is no |
details of the handling of digits following a backslash. There is no |
4153 |
such problem when named parentheses are used. A back reference to any |
such problem when named parentheses are used. A back reference to any |
4154 |
subpattern is possible using named parentheses (see below). |
subpattern is possible using named parentheses (see below). |
4155 |
|
|
4156 |
Another way of avoiding the ambiguity inherent in the use of digits |
Another way of avoiding the ambiguity inherent in the use of digits |
4157 |
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- |
4158 |
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 |
4159 |
tive or a negative number, optionally enclosed in braces. These exam- |
unsigned number or a negative number, optionally enclosed in braces. |
4160 |
ples are all identical: |
These examples are all identical: |
4161 |
|
|
4162 |
(ring), \1 |
(ring), \1 |
4163 |
(ring), \g1 |
(ring), \g1 |
4164 |
(ring), \g{1} |
(ring), \g{1} |
4165 |
|
|
4166 |
A positive number specifies an absolute reference without the ambiguity |
An unsigned number specifies an absolute reference without the ambigu- |
4167 |
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 |
4168 |
digits follow the reference. A negative number is a relative reference. |
digits follow the reference. A negative number is a relative reference. |
4169 |
Consider this example: |
Consider this example: |
4170 |
|
|
4171 |
(abc(def)ghi)\g{-1} |
(abc(def)ghi)\g{-1} |
4172 |
|
|
4173 |
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- |
4174 |
ing subpattern before \g, that is, is it equivalent to \2. Similarly, |
ing subpattern before \g, that is, is it equivalent to \2. Similarly, |
4175 |
\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 |
4176 |
helpful in long patterns, and also in patterns that are created by |
helpful in long patterns, and also in patterns that are created by |
4177 |
joining together fragments that contain references within themselves. |
joining together fragments that contain references within themselves. |
4178 |
|
|
4179 |
A back reference matches whatever actually matched the capturing sub- |
A back reference matches whatever actually matched the capturing sub- |
4180 |
pattern in the current subject string, rather than anything matching |
pattern in the current subject string, rather than anything matching |
4181 |
the subpattern itself (see "Subpatterns as subroutines" below for a way |
the subpattern itself (see "Subpatterns as subroutines" below for a way |
4182 |
of doing that). So the pattern |
of doing that). So the pattern |
4183 |
|
|
4184 |
(sens|respons)e and \1ibility |
(sens|respons)e and \1ibility |
4185 |
|
|
4186 |
matches "sense and sensibility" and "response and responsibility", but |
matches "sense and sensibility" and "response and responsibility", but |
4187 |
not "sense and responsibility". If caseful matching is in force at the |
not "sense and responsibility". If caseful matching is in force at the |
4188 |
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- |
4189 |
ple, |
ple, |
4190 |
|
|
4191 |
((?i)rah)\s+\1 |
((?i)rah)\s+\1 |
4192 |
|
|
4193 |
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 |
4194 |
original capturing subpattern is matched caselessly. |
original capturing subpattern is matched caselessly. |
4195 |
|
|
4196 |
Back references to named subpatterns use the Perl syntax \k<name> or |
There are several different ways of writing back references to named |
4197 |
\k'name' or the Python syntax (?P=name). We could rewrite the above |
subpatterns. The .NET syntax \k{name} and the Perl syntax \k<name> or |
4198 |
example in either of the following ways: |
\k'name' are supported, as is the Python syntax (?P=name). Perl 5.10's |
4199 |
|
unified back reference syntax, in which \g can be used for both numeric |
4200 |
|
and named references, is also supported. We could rewrite the above |
4201 |
|
example in any of the following ways: |
4202 |
|
|
4203 |
(?<p1>(?i)rah)\s+\k<p1> |
(?<p1>(?i)rah)\s+\k<p1> |
4204 |
|
(?'p1'(?i)rah)\s+\k{p1} |
4205 |
(?P<p1>(?i)rah)\s+(?P=p1) |
(?P<p1>(?i)rah)\s+(?P=p1) |
4206 |
|
(?<p1>(?i)rah)\s+\g{p1} |
4207 |
|
|
4208 |
A subpattern that is referenced by name may appear in the pattern |
A subpattern that is referenced by name may appear in the pattern |
4209 |
before or after the reference. |
before or after the reference. |
4318 |
|
|
4319 |
(?<=abc|abde) |
(?<=abc|abde) |
4320 |
|
|
4321 |
|
In some cases, the Perl 5.10 escape sequence \K (see above) can be used |
4322 |
|
instead of a lookbehind assertion; this is not restricted to a fixed- |
4323 |
|
length. |
4324 |
|
|
4325 |
The implementation of lookbehind assertions is, for each alternative, |
The implementation of lookbehind assertions is, for each alternative, |
4326 |
to temporarily move the current position back by the fixed length and |
to temporarily move the current position back by the fixed length and |
4327 |
then try to match. If there are insufficient characters before the cur- |
then try to match. If there are insufficient characters before the cur- |
4415 |
|
|
4416 |
If the text between the parentheses consists of a sequence of digits, |
If the text between the parentheses consists of a sequence of digits, |
4417 |
the condition is true if the capturing subpattern of that number has |
the condition is true if the capturing subpattern of that number has |
4418 |
previously matched. |
previously matched. An alternative notation is to precede the digits |
4419 |
|
with a plus or minus sign. In this case, the subpattern number is rela- |
4420 |
|
tive rather than absolute. The most recently opened parentheses can be |
4421 |
|
referenced by (?(-1), the next most recent by (?(-2), and so on. In |
4422 |
|
looping constructs it can also make sense to refer to subsequent groups |
4423 |
|
with constructs such as (?(+2). |
4424 |
|
|
4425 |
Consider the following pattern, which contains non-significant white |
Consider the following pattern, which contains non-significant white |
4426 |
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 |
4427 |
divide it into three parts for ease of discussion: |
divide it into three parts for ease of discussion: |
4428 |
|
|
4429 |
( \( )? [^()]+ (?(1) \) ) |
( \( )? [^()]+ (?(1) \) ) |
4430 |
|
|
4431 |
The first part matches an optional opening parenthesis, and if that |
The first part matches an optional opening parenthesis, and if that |
4432 |
character is present, sets it as the first captured substring. The sec- |
character is present, sets it as the first captured substring. The sec- |
4433 |
ond part matches one or more characters that are not parentheses. The |
ond part matches one or more characters that are not parentheses. The |
4434 |
third part is a conditional subpattern that tests whether the first set |
third part is a conditional subpattern that tests whether the first set |
4435 |
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 |
4436 |
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- |
4437 |
tern is executed and a closing parenthesis is required. Otherwise, |
tern is executed and a closing parenthesis is required. Otherwise, |
4438 |
since no-pattern is not present, the subpattern matches nothing. In |
since no-pattern is not present, the subpattern matches nothing. In |
4439 |
other words, this pattern matches a sequence of non-parentheses, |
other words, this pattern matches a sequence of non-parentheses, |
4440 |
optionally enclosed in parentheses. |
optionally enclosed in parentheses. |
4441 |
|
|
4442 |
|
If you were embedding this pattern in a larger one, you could use a |
4443 |
|
relative reference: |
4444 |
|
|
4445 |
|
...other stuff... ( \( )? [^()]+ (?(-1) \) ) ... |
4446 |
|
|
4447 |
|
This makes the fragment independent of the parentheses in the larger |
4448 |
|
pattern. |
4449 |
|
|
4450 |
Checking for a used subpattern by name |
Checking for a used subpattern by name |
4451 |
|
|
4452 |
Perl uses the syntax (?(<name>)...) or (?('name')...) to test for a |
Perl uses the syntax (?(<name>)...) or (?('name')...) to test for a |
4453 |
used subpattern by name. For compatibility with earlier versions of |
used subpattern by name. For compatibility with earlier versions of |
4454 |
PCRE, which had this facility before Perl, the syntax (?(name)...) is |
PCRE, which had this facility before Perl, the syntax (?(name)...) is |
4455 |
also recognized. However, there is a possible ambiguity with this syn- |
also recognized. However, there is a possible ambiguity with this syn- |
4456 |
tax, because subpattern names may consist entirely of digits. PCRE |
tax, because subpattern names may consist entirely of digits. PCRE |
4457 |
looks first for a named subpattern; if it cannot find one and the name |
looks first for a named subpattern; if it cannot find one and the name |
4458 |
consists entirely of digits, PCRE looks for a subpattern of that num- |
consists entirely of digits, PCRE looks for a subpattern of that num- |
4459 |
ber, which must be greater than zero. Using subpattern names that con- |
ber, which must be greater than zero. Using subpattern names that con- |
4460 |
sist entirely of digits is not recommended. |
sist entirely of digits is not recommended. |
4461 |
|
|
4462 |
Rewriting the above example to use a named subpattern gives this: |
Rewriting the above example to use a named subpattern gives this: |
4467 |
Checking for pattern recursion |
Checking for pattern recursion |
4468 |
|
|
4469 |
If the condition is the string (R), and there is no subpattern with the |
If the condition is the string (R), and there is no subpattern with the |
4470 |
name R, the condition is true if a recursive call to the whole pattern |
name R, the condition is true if a recursive call to the whole pattern |
4471 |
or any subpattern has been made. If digits or a name preceded by amper- |
or any subpattern has been made. If digits or a name preceded by amper- |
4472 |
sand follow the letter R, for example: |
sand follow the letter R, for example: |
4473 |
|
|
4474 |
(?(R3)...) or (?(R&name)...) |
(?(R3)...) or (?(R&name)...) |
4475 |
|
|
4476 |
the condition is true if the most recent recursion is into the subpat- |
the condition is true if the most recent recursion is into the subpat- |
4477 |
tern whose number or name is given. This condition does not check the |
tern whose number or name is given. This condition does not check the |
4478 |
entire recursion stack. |
entire recursion stack. |
4479 |
|
|
4480 |
At "top level", all these recursion test conditions are false. Recur- |
At "top level", all these recursion test conditions are false. Recur- |
4481 |
sive patterns are described below. |
sive patterns are described below. |
4482 |
|
|
4483 |
Defining subpatterns for use by reference only |
Defining subpatterns for use by reference only |
4484 |
|
|
4485 |
If the condition is the string (DEFINE), and there is no subpattern |
If the condition is the string (DEFINE), and there is no subpattern |
4486 |
with the name DEFINE, the condition is always false. In this case, |
with the name DEFINE, the condition is always false. In this case, |
4487 |
there may be only one alternative in the subpattern. It is always |
there may be only one alternative in the subpattern. It is always |
4488 |
skipped if control reaches this point in the pattern; the idea of |
skipped if control reaches this point in the pattern; the idea of |
4489 |
DEFINE is that it can be used to define "subroutines" that can be ref- |
DEFINE is that it can be used to define "subroutines" that can be ref- |
4490 |
erenced from elsewhere. (The use of "subroutines" is described below.) |
erenced from elsewhere. (The use of "subroutines" is described below.) |
4491 |
For example, a pattern to match an IPv4 address could be written like |
For example, a pattern to match an IPv4 address could be written like |
4492 |
this (ignore whitespace and line breaks): |
this (ignore whitespace and line breaks): |
4493 |
|
|
4494 |
(?(DEFINE) (?<byte> 2[0-4]\d | 25[0-5] | 1\d\d | [1-9]?\d) ) |
(?(DEFINE) (?<byte> 2[0-4]\d | 25[0-5] | 1\d\d | [1-9]?\d) ) |
4495 |
\b (?&byte) (\.(?&byte)){3} \b |
\b (?&byte) (\.(?&byte)){3} \b |
4496 |
|
|
4497 |
The first part of the pattern is a DEFINE group inside which a another |
The first part of the pattern is a DEFINE group inside which a another |
4498 |
group named "byte" is defined. This matches an individual component of |
group named "byte" is defined. This matches an individual component of |
4499 |
an IPv4 address (a number less than 256). When matching takes place, |
an IPv4 address (a number less than 256). When matching takes place, |
4500 |
this part of the pattern is skipped because DEFINE acts like a false |
this part of the pattern is skipped because DEFINE acts like a false |
4501 |
condition. |
condition. |
4502 |
|
|
4503 |
The rest of the pattern uses references to the named group to match the |
The rest of the pattern uses references to the named group to match the |
4504 |
four dot-separated components of an IPv4 address, insisting on a word |
four dot-separated components of an IPv4 address, insisting on a word |
4505 |
boundary at each end. |
boundary at each end. |
4506 |
|
|
4507 |
Assertion conditions |
Assertion conditions |
4508 |
|
|
4509 |
If the condition is not in any of the above formats, it must be an |
If the condition is not in any of the above formats, it must be an |
4510 |
assertion. This may be a positive or negative lookahead or lookbehind |
assertion. This may be a positive or negative lookahead or lookbehind |
4511 |
assertion. Consider this pattern, again containing non-significant |
assertion. Consider this pattern, again containing non-significant |
4512 |
white space, and with the two alternatives on the second line: |
white space, and with the two alternatives on the second line: |
4513 |
|
|
4514 |
(?(?=[^a-z]*[a-z]) |
(?(?=[^a-z]*[a-z]) |
4515 |
\d{2}-[a-z]{3}-\d{2} | \d{2}-\d{2}-\d{2} ) |
\d{2}-[a-z]{3}-\d{2} | \d{2}-\d{2}-\d{2} ) |
4516 |
|
|
4517 |
The condition is a positive lookahead assertion that matches an |
The condition is a positive lookahead assertion that matches an |
4518 |
optional sequence of non-letters followed by a letter. In other words, |
optional sequence of non-letters followed by a letter. In other words, |
4519 |
it tests for the presence of at least one letter in the subject. If a |
it tests for the presence of at least one letter in the subject. If a |
4520 |
letter is found, the subject is matched against the first alternative; |
letter is found, the subject is matched against the first alternative; |
4521 |
otherwise it is matched against the second. This pattern matches |
otherwise it is matched against the second. This pattern matches |
4522 |
strings in one of the two forms dd-aaa-dd or dd-dd-dd, where aaa are |
strings in one of the two forms dd-aaa-dd or dd-dd-dd, where aaa are |
4523 |
letters and dd are digits. |
letters and dd are digits. |
4524 |
|
|
4525 |
|
|
4526 |
COMMENTS |
COMMENTS |
4527 |
|
|
4528 |
The sequence (?# marks the start of a comment that continues up to the |
The sequence (?# marks the start of a comment that continues up to the |
4529 |
next closing parenthesis. Nested parentheses are not permitted. The |
next closing parenthesis. Nested parentheses are not permitted. The |
4530 |
characters that make up a comment play no part in the pattern matching |
characters that make up a comment play no part in the pattern matching |
4531 |
at all. |
at all. |
4532 |
|
|
4533 |
If the PCRE_EXTENDED option is set, an unescaped # character outside a |
If the PCRE_EXTENDED option is set, an unescaped # character outside a |
4534 |
character class introduces a comment that continues to immediately |
character class introduces a comment that continues to immediately |
4535 |
after the next newline in the pattern. |
after the next newline in the pattern. |
4536 |
|
|
4537 |
|
|
4538 |
RECURSIVE PATTERNS |
RECURSIVE PATTERNS |
4539 |
|
|
4540 |
Consider the problem of matching a string in parentheses, allowing for |
Consider the problem of matching a string in parentheses, allowing for |
4541 |
unlimited nested parentheses. Without the use of recursion, the best |
unlimited nested parentheses. Without the use of recursion, the best |
4542 |
that can be done is to use a pattern that matches up to some fixed |
that can be done is to use a pattern that matches up to some fixed |
4543 |
depth of nesting. It is not possible to handle an arbitrary nesting |
depth of nesting. It is not possible to handle an arbitrary nesting |
4544 |
depth. |
depth. |
4545 |
|
|
4546 |
For some time, Perl has provided a facility that allows regular expres- |
For some time, Perl has provided a facility that allows regular expres- |
4547 |
sions to recurse (amongst other things). It does this by interpolating |
sions to recurse (amongst other things). It does this by interpolating |
4548 |
Perl code in the expression at run time, and the code can refer to the |
Perl code in the expression at run time, and the code can refer to the |
4549 |
expression itself. A Perl pattern using code interpolation to solve the |
expression itself. A Perl pattern using code interpolation to solve the |
4550 |
parentheses problem can be created like this: |
parentheses problem can be created like this: |
4551 |
|
|
4555 |
refers recursively to the pattern in which it appears. |
refers recursively to the pattern in which it appears. |
4556 |
|
|
4557 |
Obviously, PCRE cannot support the interpolation of Perl code. Instead, |
Obviously, PCRE cannot support the interpolation of Perl code. Instead, |
4558 |
it supports special syntax for recursion of the entire pattern, and |
it supports special syntax for recursion of the entire pattern, and |
4559 |
also for individual subpattern recursion. After its introduction in |
also for individual subpattern recursion. After its introduction in |
4560 |
PCRE and Python, this kind of recursion was introduced into Perl at |
PCRE and Python, this kind of recursion was introduced into Perl at |
4561 |
release 5.10. |
release 5.10. |
4562 |
|
|
4563 |
A special item that consists of (? followed by a number greater than |
A special item that consists of (? followed by a number greater than |
4564 |
zero and a closing parenthesis is a recursive call of the subpattern of |
zero and a closing parenthesis is a recursive call of the subpattern of |
4565 |
the given number, provided that it occurs inside that subpattern. (If |
the given number, provided that it occurs inside that subpattern. (If |
4566 |
not, it is a "subroutine" call, which is described in the next sec- |
not, it is a "subroutine" call, which is described in the next sec- |
4567 |
tion.) The special item (?R) or (?0) is a recursive call of the entire |
tion.) The special item (?R) or (?0) is a recursive call of the entire |
4568 |
regular expression. |
regular expression. |
4569 |
|
|
4570 |
In PCRE (like Python, but unlike Perl), a recursive subpattern call is |
In PCRE (like Python, but unlike Perl), a recursive subpattern call is |
4571 |
always treated as an atomic group. That is, once it has matched some of |
always treated as an atomic group. That is, once it has matched some of |
4572 |
the subject string, it is never re-entered, even if it contains untried |
the subject string, it is never re-entered, even if it contains untried |
4573 |
alternatives and there is a subsequent matching failure. |
alternatives and there is a subsequent matching failure. |
4574 |
|
|
4575 |
This PCRE pattern solves the nested parentheses problem (assume the |
This PCRE pattern solves the nested parentheses problem (assume the |
4576 |
PCRE_EXTENDED option is set so that white space is ignored): |
PCRE_EXTENDED option is set so that white space is ignored): |
4577 |
|
|
4578 |
\( ( (?>[^()]+) | (?R) )* \) |
\( ( (?>[^()]+) | (?R) )* \) |
4579 |
|
|
4580 |
First it matches an opening parenthesis. Then it matches any number of |
First it matches an opening parenthesis. Then it matches any number of |
4581 |
substrings which can either be a sequence of non-parentheses, or a |
substrings which can either be a sequence of non-parentheses, or a |
4582 |
recursive match of the pattern itself (that is, a correctly parenthe- |
recursive match of the pattern itself (that is, a correctly parenthe- |
4583 |
sized substring). Finally there is a closing parenthesis. |
sized substring). Finally there is a closing parenthesis. |
4584 |
|
|
4585 |
If this were part of a larger pattern, you would not want to recurse |
If this were part of a larger pattern, you would not want to recurse |
4586 |
the entire pattern, so instead you could use this: |
the entire pattern, so instead you could use this: |
4587 |
|
|
4588 |
( \( ( (?>[^()]+) | (?1) )* \) ) |
( \( ( (?>[^()]+) | (?1) )* \) ) |
4589 |
|
|
4590 |
We have put the pattern into parentheses, and caused the recursion to |
We have put the pattern into parentheses, and caused the recursion to |
4591 |
refer to them instead of the whole pattern. In a larger pattern, keep- |
refer to them instead of the whole pattern. |
4592 |
ing track of parenthesis numbers can be tricky. It may be more conve- |
|
4593 |
nient to use named parentheses instead. The Perl syntax for this is |
In a larger pattern, keeping track of parenthesis numbers can be |
4594 |
(?&name); PCRE's earlier syntax (?P>name) is also supported. We could |
tricky. This is made easier by the use of relative references. (A Perl |
4595 |
rewrite the above example as follows: |
5.10 feature.) Instead of (?1) in the pattern above you can write |
4596 |
|
(?-2) to refer to the second most recently opened parentheses preceding |
4597 |
|
the recursion. In other words, a negative number counts capturing |
4598 |
|
parentheses leftwards from the point at which it is encountered. |
4599 |
|
|
4600 |
|
It is also possible to refer to subsequently opened parentheses, by |
4601 |
|
writing references such as (?+2). However, these cannot be recursive |
4602 |
|
because the reference is not inside the parentheses that are refer- |
4603 |
|
enced. They are always "subroutine" calls, as described in the next |
4604 |
|
section. |
4605 |
|
|
4606 |
|
An alternative approach is to use named parentheses instead. The Perl |
4607 |
|
syntax for this is (?&name); PCRE's earlier syntax (?P>name) is also |
4608 |
|
supported. We could rewrite the above example as follows: |
4609 |
|
|
4610 |
(?<pn> \( ( (?>[^()]+) | (?&pn) )* \) ) |
(?<pn> \( ( (?>[^()]+) | (?&pn) )* \) ) |
4611 |
|
|
4612 |
If there is more than one subpattern with the same name, the earliest |
If there is more than one subpattern with the same name, the earliest |
4613 |
one is used. This particular example pattern contains nested unlimited |
one is used. |
4614 |
repeats, and so the use of atomic grouping for matching strings of non- |
|
4615 |
parentheses is important when applying the pattern to strings that do |
This particular example pattern that we have been looking at contains |
4616 |
not match. For example, when this pattern is applied to |
nested unlimited repeats, and so the use of atomic grouping for match- |
4617 |
|
ing strings of non-parentheses is important when applying the pattern |
4618 |
|
to strings that do not match. For example, when this pattern is applied |
4619 |
|
to |
4620 |
|
|
4621 |
(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa() |
(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa() |
4622 |
|
|
4623 |
it yields "no match" quickly. However, if atomic grouping is not used, |
it yields "no match" quickly. However, if atomic grouping is not used, |
4624 |
the match runs for a very long time indeed because there are so many |
the match runs for a very long time indeed because there are so many |
4625 |
different ways the + and * repeats can carve up the subject, and all |
different ways the + and * repeats can carve up the subject, and all |
4626 |
have to be tested before failure can be reported. |
have to be tested before failure can be reported. |
4627 |
|
|
4628 |
At the end of a match, the values set for any capturing subpatterns are |
At the end of a match, the values set for any capturing subpatterns are |
4629 |
those from the outermost level of the recursion at which the subpattern |
those from the outermost level of the recursion at which the subpattern |
4630 |
value is set. If you want to obtain intermediate values, a callout |
value is set. If you want to obtain intermediate values, a callout |
4631 |
function can be used (see below and the pcrecallout documentation). If |
function can be used (see below and the pcrecallout documentation). If |
4632 |
the pattern above is matched against |
the pattern above is matched against |
4633 |
|
|
4634 |
(ab(cd)ef) |
(ab(cd)ef) |
4635 |
|
|
4636 |
the value for the capturing parentheses is "ef", which is the last |
the value for the capturing parentheses is "ef", which is the last |
4637 |
value taken on at the top level. If additional parentheses are added, |
value taken on at the top level. If additional parentheses are added, |
4638 |
giving |
giving |
4639 |
|
|
4640 |
\( ( ( (?>[^()]+) | (?R) )* ) \) |
\( ( ( (?>[^()]+) | (?R) )* ) \) |
4641 |
^ ^ |
^ ^ |
4642 |
^ ^ |
^ ^ |
4643 |
|
|
4644 |
the string they capture is "ab(cd)ef", the contents of the top level |
the string they capture is "ab(cd)ef", the contents of the top level |
4645 |
parentheses. If there are more than 15 capturing parentheses in a pat- |
parentheses. If there are more than 15 capturing parentheses in a pat- |
4646 |
tern, PCRE has to obtain extra memory to store data during a recursion, |
tern, PCRE has to obtain extra memory to store data during a recursion, |
4647 |
which it does by using pcre_malloc, freeing it via pcre_free after- |
which it does by using pcre_malloc, freeing it via pcre_free after- |
4648 |
wards. If no memory can be obtained, the match fails with the |
wards. If no memory can be obtained, the match fails with the |
4649 |
PCRE_ERROR_NOMEMORY error. |
PCRE_ERROR_NOMEMORY error. |
4650 |
|
|
4651 |
Do not confuse the (?R) item with the condition (R), which tests for |
Do not confuse the (?R) item with the condition (R), which tests for |
4652 |
recursion. Consider this pattern, which matches text in angle brack- |
recursion. Consider this pattern, which matches text in angle brack- |
4653 |
ets, allowing for arbitrary nesting. Only digits are allowed in nested |
ets, allowing for arbitrary nesting. Only digits are allowed in nested |
4654 |
brackets (that is, when recursing), whereas any characters are permit- |
brackets (that is, when recursing), whereas any characters are permit- |
4655 |
ted at the outer level. |
ted at the outer level. |
4656 |
|
|
4657 |
< (?: (?(R) \d++ | [^<>]*+) | (?R)) * > |
< (?: (?(R) \d++ | [^<>]*+) | (?R)) * > |
4658 |
|
|
4659 |
In this pattern, (?(R) is the start of a conditional subpattern, with |
In this pattern, (?(R) is the start of a conditional subpattern, with |
4660 |
two different alternatives for the recursive and non-recursive cases. |
two different alternatives for the recursive and non-recursive cases. |
4661 |
The (?R) item is the actual recursive call. |
The (?R) item is the actual recursive call. |
4662 |
|
|
4663 |
|
|
4664 |
SUBPATTERNS AS SUBROUTINES |
SUBPATTERNS AS SUBROUTINES |
4665 |
|
|
4666 |
If the syntax for a recursive subpattern reference (either by number or |
If the syntax for a recursive subpattern reference (either by number or |
4667 |
by name) is used outside the parentheses to which it refers, it oper- |
by name) is used outside the parentheses to which it refers, it oper- |
4668 |
ates like a subroutine in a programming language. The "called" subpat- |
ates like a subroutine in a programming language. The "called" subpat- |
4669 |
tern may be defined before or after the reference. An earlier example |
tern may be defined before or after the reference. A numbered reference |
4670 |
pointed out that the pattern |
can be absolute or relative, as in these examples: |
4671 |
|
|
4672 |
|
(...(absolute)...)...(?2)... |
4673 |
|
(...(relative)...)...(?-1)... |
4674 |
|
(...(?+1)...(relative)... |
4675 |
|
|
4676 |
|
An earlier example pointed out that the pattern |
4677 |
|
|
4678 |
(sens|respons)e and \1ibility |
(sens|respons)e and \1ibility |
4679 |
|
|
4680 |
matches "sense and sensibility" and "response and responsibility", but |
matches "sense and sensibility" and "response and responsibility", but |
4681 |
not "sense and responsibility". If instead the pattern |
not "sense and responsibility". If instead the pattern |
4682 |
|
|
4683 |
(sens|respons)e and (?1)ibility |
(sens|respons)e and (?1)ibility |
4684 |
|
|
4685 |
is used, it does match "sense and responsibility" as well as the other |
is used, it does match "sense and responsibility" as well as the other |
4686 |
two strings. Another example is given in the discussion of DEFINE |
two strings. Another example is given in the discussion of DEFINE |
4687 |
above. |
above. |
4688 |
|
|
4689 |
Like recursive subpatterns, a "subroutine" call is always treated as an |
Like recursive subpatterns, a "subroutine" call is always treated as an |
4690 |
atomic group. That is, once it has matched some of the subject string, |
atomic group. That is, once it has matched some of the subject string, |
4691 |
it is never re-entered, even if it contains untried alternatives and |
it is never re-entered, even if it contains untried alternatives and |
4692 |
there is a subsequent matching failure. |
there is a subsequent matching failure. |
4693 |
|
|
4694 |
When a subpattern is used as a subroutine, processing options such as |
When a subpattern is used as a subroutine, processing options such as |
4695 |
case-independence are fixed when the subpattern is defined. They cannot |
case-independence are fixed when the subpattern is defined. They cannot |
4696 |
be changed for different calls. For example, consider this pattern: |
be changed for different calls. For example, consider this pattern: |
4697 |
|
|
4698 |
(abc)(?i:(?1)) |
(abc)(?i:(?-1)) |
4699 |
|
|
4700 |
It matches "abcabc". It does not match "abcABC" because the change of |
It matches "abcabc". It does not match "abcABC" because the change of |
4701 |
processing option does not affect the called subpattern. |
processing option does not affect the called subpattern. |
4702 |
|
|
4703 |
|
|
4704 |
CALLOUTS |
CALLOUTS |
4705 |
|
|
4706 |
Perl has a feature whereby using the sequence (?{...}) causes arbitrary |
Perl has a feature whereby using the sequence (?{...}) causes arbitrary |
4707 |
Perl code to be obeyed in the middle of matching a regular expression. |
Perl code to be obeyed in the middle of matching a regular expression. |
4708 |
This makes it possible, amongst other things, to extract different sub- |
This makes it possible, amongst other things, to extract different sub- |
4709 |
strings that match the same pair of parentheses when there is a repeti- |
strings that match the same pair of parentheses when there is a repeti- |
4710 |
tion. |
tion. |
4711 |
|
|
4712 |
PCRE provides a similar feature, but of course it cannot obey arbitrary |
PCRE provides a similar feature, but of course it cannot obey arbitrary |
4713 |
Perl code. The feature is called "callout". The caller of PCRE provides |
Perl code. The feature is called "callout". The caller of PCRE provides |
4714 |
an external function by putting its entry point in the global variable |
an external function by putting its entry point in the global variable |
4715 |
pcre_callout. By default, this variable contains NULL, which disables |
pcre_callout. By default, this variable contains NULL, which disables |
4716 |
all calling out. |
all calling out. |
4717 |
|
|
4718 |
Within a regular expression, (?C) indicates the points at which the |
Within a regular expression, (?C) indicates the points at which the |
4719 |
external function is to be called. If you want to identify different |
external function is to be called. If you want to identify different |
4720 |
callout points, you can put a number less than 256 after the letter C. |
callout points, you can put a number less than 256 after the letter C. |
4721 |
The default value is zero. For example, this pattern has two callout |
The default value is zero. For example, this pattern has two callout |
4722 |
points: |
points: |
4723 |
|
|
4724 |
(?C1)abc(?C2)def |
(?C1)abc(?C2)def |
4725 |
|
|
4726 |
If the PCRE_AUTO_CALLOUT flag is passed to pcre_compile(), callouts are |
If the PCRE_AUTO_CALLOUT flag is passed to pcre_compile(), callouts are |
4727 |
automatically installed before each item in the pattern. They are all |
automatically installed before each item in the pattern. They are all |
4728 |
numbered 255. |
numbered 255. |
4729 |
|
|
4730 |
During matching, when PCRE reaches a callout point (and pcre_callout is |
During matching, when PCRE reaches a callout point (and pcre_callout is |
4731 |
set), the external function is called. It is provided with the number |
set), the external function is called. It is provided with the number |
4732 |
of the callout, the position in the pattern, and, optionally, one item |
of the callout, the position in the pattern, and, optionally, one item |
4733 |
of data originally supplied by the caller of pcre_exec(). The callout |
of data originally supplied by the caller of pcre_exec(). The callout |
4734 |
function may cause matching to proceed, to backtrack, or to fail alto- |
function may cause matching to proceed, to backtrack, or to fail alto- |
4735 |
gether. A complete description of the interface to the callout function |
gether. A complete description of the interface to the callout function |
4736 |
is given in the pcrecallout documentation. |
is given in the pcrecallout documentation. |
4737 |
|
|
4738 |
|
|
4739 |
|
BACKTRACKING CONTROL |
4740 |
|
|
4741 |
|
Perl 5.10 introduced a number of "Special Backtracking Control Verbs", |
4742 |
|
which are described in the Perl documentation as "experimental and sub- |
4743 |
|
ject to change or removal in a future version of Perl". It goes on to |
4744 |
|
say: "Their usage in production code should be noted to avoid problems |
4745 |
|
during upgrades." The same remarks apply to the PCRE features described |
4746 |
|
in this section. |
4747 |
|
|
4748 |
|
Since these verbs are specifically related to backtracking, they can be |
4749 |
|
used only when the pattern is to be matched using pcre_exec(), which |
4750 |
|
uses a backtracking algorithm. They cause an error if encountered by |
4751 |
|
pcre_dfa_exec(). |
4752 |
|
|
4753 |
|
The new verbs make use of what was previously invalid syntax: an open- |
4754 |
|
ing parenthesis followed by an asterisk. In Perl, they are generally of |
4755 |
|
the form (*VERB:ARG) but PCRE does not support the use of arguments, so |
4756 |
|
its general form is just (*VERB). Any number of these verbs may occur |
4757 |
|
in a pattern. There are two kinds: |
4758 |
|
|
4759 |
|
Verbs that act immediately |
4760 |
|
|
4761 |
|
The following verbs act as soon as they are encountered: |
4762 |
|
|
4763 |
|
(*ACCEPT) |
4764 |
|
|
4765 |
|
This verb causes the match to end successfully, skipping the remainder |
4766 |
|
of the pattern. When inside a recursion, only the innermost pattern is |
4767 |
|
ended immediately. PCRE differs from Perl in what happens if the |
4768 |
|
(*ACCEPT) is inside capturing parentheses. In Perl, the data so far is |
4769 |
|
captured: in PCRE no data is captured. For example: |
4770 |
|
|
4771 |
|
A(A|B(*ACCEPT)|C)D |
4772 |
|
|
4773 |
|
This matches "AB", "AAD", or "ACD", but when it matches "AB", no data |
4774 |
|
is captured. |
4775 |
|
|
4776 |
|
(*FAIL) or (*F) |
4777 |
|
|
4778 |
|
This verb causes the match to fail, forcing backtracking to occur. It |
4779 |
|
is equivalent to (?!) but easier to read. The Perl documentation notes |
4780 |
|
that it is probably useful only when combined with (?{}) or (??{}). |
4781 |
|
Those are, of course, Perl features that are not present in PCRE. The |
4782 |
|
nearest equivalent is the callout feature, as for example in this pat- |
4783 |
|
tern: |
4784 |
|
|
4785 |
|
a+(?C)(*FAIL) |
4786 |
|
|
4787 |
|
A match with the string "aaaa" always fails, but the callout is taken |
4788 |
|
before each backtrack happens (in this example, 10 times). |
4789 |
|
|
4790 |
|
Verbs that act after backtracking |
4791 |
|
|
4792 |
|
The following verbs do nothing when they are encountered. Matching con- |
4793 |
|
tinues with what follows, but if there is no subsequent match, a fail- |
4794 |
|
ure is forced. The verbs differ in exactly what kind of failure |
4795 |
|
occurs. |
4796 |
|
|
4797 |
|
(*COMMIT) |
4798 |
|
|
4799 |
|
This verb causes the whole match to fail outright if the rest of the |
4800 |
|
pattern does not match. Even if the pattern is unanchored, no further |
4801 |
|
attempts to find a match by advancing the start point take place. Once |
4802 |
|
(*COMMIT) has been passed, pcre_exec() is committed to finding a match |
4803 |
|
at the current starting point, or not at all. For example: |
4804 |
|
|
4805 |
|
a+(*COMMIT)b |
4806 |
|
|
4807 |
|
This matches "xxaab" but not "aacaab". It can be thought of as a kind |
4808 |
|
of dynamic anchor, or "I've started, so I must finish." |
4809 |
|
|
4810 |
|
(*PRUNE) |
4811 |
|
|
4812 |
|
This verb causes the match to fail at the current position if the rest |
4813 |
|
of the pattern does not match. If the pattern is unanchored, the normal |
4814 |
|
"bumpalong" advance to the next starting character then happens. Back- |
4815 |
|
tracking can occur as usual to the left of (*PRUNE), or when matching |
4816 |
|
to the right of (*PRUNE), but if there is no match to the right, back- |
4817 |
|
tracking cannot cross (*PRUNE). In simple cases, the use of (*PRUNE) |
4818 |
|
is just an alternative to an atomic group or possessive quantifier, but |
4819 |
|
there are some uses of (*PRUNE) that cannot be expressed in any other |
4820 |
|
way. |
4821 |
|
|
4822 |
|
(*SKIP) |
4823 |
|
|
4824 |
|
This verb is like (*PRUNE), except that if the pattern is unanchored, |
4825 |
|
the "bumpalong" advance is not to the next character, but to the posi- |
4826 |
|
tion in the subject where (*SKIP) was encountered. (*SKIP) signifies |
4827 |
|
that whatever text was matched leading up to it cannot be part of a |
4828 |
|
successful match. Consider: |
4829 |
|
|
4830 |
|
a+(*SKIP)b |
4831 |
|
|
4832 |
|
If the subject is "aaaac...", after the first match attempt fails |
4833 |
|
(starting at the first character in the string), the starting point |
4834 |
|
skips on to start the next attempt at "c". Note that a possessive quan- |
4835 |
|
tifer does not have the same effect in this example; although it would |
4836 |
|
suppress backtracking during the first match attempt, the second |
4837 |
|
attempt would start at the second character instead of skipping on to |
4838 |
|
"c". |
4839 |
|
|
4840 |
|
(*THEN) |
4841 |
|
|
4842 |
|
This verb causes a skip to the next alternation if the rest of the pat- |
4843 |
|
tern does not match. That is, it cancels pending backtracking, but only |
4844 |
|
within the current alternation. Its name comes from the observation |
4845 |
|
that it can be used for a pattern-based if-then-else block: |
4846 |
|
|
4847 |
|
( COND1 (*THEN) FOO | COND2 (*THEN) BAR | COND3 (*THEN) BAZ ) ... |
4848 |
|
|
4849 |
|
If the COND1 pattern matches, FOO is tried (and possibly further items |
4850 |
|
after the end of the group if FOO succeeds); on failure the matcher |
4851 |
|
skips to the second alternative and tries COND2, without backtracking |
4852 |
|
into COND1. If (*THEN) is used outside of any alternation, it acts |
4853 |
|
exactly like (*PRUNE). |
4854 |
|
|
4855 |
|
|
4856 |
SEE ALSO |
SEE ALSO |
4857 |
|
|
4858 |
pcreapi(3), pcrecallout(3), pcrematching(3), pcre(3). |
pcreapi(3), pcrecallout(3), pcrematching(3), pcre(3). |
4867 |
|
|
4868 |
REVISION |
REVISION |
4869 |
|
|
4870 |
Last updated: 06 March 2007 |
Last updated: 17 September 2007 |
4871 |
|
Copyright (c) 1997-2007 University of Cambridge. |
4872 |
|
------------------------------------------------------------------------------ |
4873 |
|
|
4874 |
|
|
4875 |
|
PCRESYNTAX(3) PCRESYNTAX(3) |
4876 |
|
|
4877 |
|
|
4878 |
|
NAME |
4879 |
|
PCRE - Perl-compatible regular expressions |
4880 |
|
|
4881 |
|
|
4882 |
|
PCRE REGULAR EXPRESSION SYNTAX SUMMARY |
4883 |
|
|
4884 |
|
The full syntax and semantics of the regular expressions that are sup- |
4885 |
|
ported by PCRE are described in the pcrepattern documentation. This |
4886 |
|
document contains just a quick-reference summary of the syntax. |
4887 |
|
|
4888 |
|
|
4889 |
|
QUOTING |
4890 |
|
|
4891 |
|
\x where x is non-alphanumeric is a literal x |
4892 |
|
\Q...\E treat enclosed characters as literal |
4893 |
|
|
4894 |
|
|
4895 |
|
CHARACTERS |
4896 |
|
|
4897 |
|
\a alarm, that is, the BEL character (hex 07) |
4898 |
|
\cx "control-x", where x is any character |
4899 |
|
\e escape (hex 1B) |
4900 |
|
\f formfeed (hex 0C) |
4901 |
|
\n newline (hex 0A) |
4902 |
|
\r carriage return (hex 0D) |
4903 |
|
\t tab (hex 09) |
4904 |
|
\ddd character with octal code ddd, or backreference |
4905 |
|
\xhh character with hex code hh |
4906 |
|
\x{hhh..} character with hex code hhh.. |
4907 |
|
|
4908 |
|
|
4909 |
|
CHARACTER TYPES |
4910 |
|
|
4911 |
|
. any character except newline; |
4912 |
|
in dotall mode, any character whatsoever |
4913 |
|
\C one byte, even in UTF-8 mode (best avoided) |
4914 |
|
\d a decimal digit |
4915 |
|
\D a character that is not a decimal digit |
4916 |
|
\h a horizontal whitespace character |
4917 |
|
\H a character that is not a horizontal whitespace character |
4918 |
|
\p{xx} a character with the xx property |
4919 |
|
\P{xx} a character without the xx property |
4920 |
|
\R a newline sequence |
4921 |
|
\s a whitespace character |
4922 |
|
\S a character that is not a whitespace character |
4923 |
|
\v a vertical whitespace character |
4924 |
|
\V a character that is not a vertical whitespace character |
4925 |
|
\w a "word" character |
4926 |
|
\W a "non-word" character |
4927 |
|
\X an extended Unicode sequence |
4928 |
|
|
4929 |
|
In PCRE, \d, \D, \s, \S, \w, and \W recognize only ASCII characters. |
4930 |
|
|
4931 |
|
|
4932 |
|
GENERAL CATEGORY PROPERTY CODES FOR \p and \P |
4933 |
|
|
4934 |
|
C Other |
4935 |
|
Cc Control |
4936 |
|
Cf Format |
4937 |
|
Cn Unassigned |
4938 |
|
Co Private use |
4939 |
|
Cs Surrogate |
4940 |
|
|
4941 |
|
L Letter |
4942 |
|
Ll Lower case letter |
4943 |
|
Lm Modifier letter |
4944 |
|
Lo Other letter |
4945 |
|
Lt Title case letter |
4946 |
|
Lu Upper case letter |
4947 |
|
L& Ll, Lu, or Lt |
4948 |
|
|
4949 |
|
M Mark |
4950 |
|
Mc Spacing mark |
4951 |
|
Me Enclosing mark |
4952 |
|
Mn Non-spacing mark |
4953 |
|
|
4954 |
|
N Number |
4955 |
|
Nd Decimal number |
4956 |
|
Nl Letter number |
4957 |
|
No Other number |
4958 |
|
|
4959 |
|
P Punctuation |
4960 |
|
Pc Connector punctuation |
4961 |
|
Pd Dash punctuation |
4962 |
|
Pe Close punctuation |
4963 |
|
Pf Final punctuation |
4964 |
|
Pi Initial punctuation |
4965 |
|
Po Other punctuation |
4966 |
|
Ps Open punctuation |
4967 |
|
|
4968 |
|
S Symbol |
4969 |
|
Sc Currency symbol |
4970 |
|
Sk Modifier symbol |
4971 |
|
Sm Mathematical symbol |
4972 |
|
So Other symbol |
4973 |
|
|
4974 |
|
Z Separator |
4975 |
|
Zl Line separator |
4976 |
|
Zp Paragraph separator |
4977 |
|
Zs Space separator |
4978 |
|
|
4979 |
|
|
4980 |
|
SCRIPT NAMES FOR \p AND \P |
4981 |
|
|
4982 |
|
Arabic, Armenian, Balinese, Bengali, Bopomofo, Braille, Buginese, |
4983 |
|
Buhid, Canadian_Aboriginal, Cherokee, Common, Coptic, Cuneiform, |
4984 |
|
Cypriot, Cyrillic, Deseret, Devanagari, Ethiopic, Georgian, Glagolitic, |
4985 |
|
Gothic, Greek, Gujarati, Gurmukhi, Han, Hangul, Hanunoo, Hebrew, Hira- |
4986 |
|
gana, Inherited, Kannada, Katakana, Kharoshthi, Khmer, Lao, Latin, |
4987 |
|
Limbu, Linear_B, Malayalam, Mongolian, Myanmar, New_Tai_Lue, Nko, |
4988 |
|
Ogham, Old_Italic, Old_Persian, Oriya, Osmanya, Phags_Pa, Phoenician, |
4989 |
|
Runic, Shavian, Sinhala, Syloti_Nagri, Syriac, Tagalog, Tagbanwa, |
4990 |
|
Tai_Le, Tamil, Telugu, Thaana, Thai, Tibetan, Tifinagh, Ugaritic, Yi. |
4991 |
|
|
4992 |
|
|
4993 |
|
CHARACTER CLASSES |
4994 |
|
|
4995 |
|
[...] positive character class |
4996 |
|
[^...] negative character class |
4997 |
|
[x-y] range (can be used for hex characters) |
4998 |
|
[[:xxx:]] positive POSIX named set |
4999 |
|
[[^:xxx:]] negative POSIX named set |
5000 |
|
|
5001 |
|
alnum alphanumeric |
5002 |
|
alpha alphabetic |
5003 |
|
ascii 0-127 |
5004 |
|
blank space or tab |
5005 |
|
cntrl control character |
5006 |
|
digit decimal digit |
5007 |
|
graph printing, excluding space |
5008 |
|
lower lower case letter |
5009 |
|
print printing, including space |
5010 |
|
punct printing, excluding alphanumeric |
5011 |
|
space whitespace |
5012 |
|
upper upper case letter |
5013 |
|
word same as \w |
5014 |
|
xdigit hexadecimal digit |
5015 |
|
|
5016 |
|
In PCRE, POSIX character set names recognize only ASCII characters. You |
5017 |
|
can use \Q...\E inside a character class. |
5018 |
|
|
5019 |
|
|
5020 |
|
QUANTIFIERS |
5021 |
|
|
5022 |
|
? 0 or 1, greedy |
5023 |
|
?+ 0 or 1, possessive |
5024 |
|
?? 0 or 1, lazy |
5025 |
|
* 0 or more, greedy |
5026 |
|
*+ 0 or more, possessive |
5027 |
|
*? 0 or more, lazy |
5028 |
|
+ 1 or more, greedy |
5029 |
|
++ 1 or more, possessive |
5030 |
|
+? 1 or more, lazy |
5031 |
|
{n} exactly n |
5032 |
|
{n,m} at least n, no more than m, greedy |
5033 |
|
{n,m}+ at least n, no more than m, possessive |
5034 |
|
{n,m}? at least n, no more than m, lazy |
5035 |
|
{n,} n or more, greedy |
5036 |
|
{n,}+ n or more, possessive |
5037 |
|
{n,}? n or more, lazy |
5038 |
|
|
5039 |
|
|
5040 |
|
ANCHORS AND SIMPLE ASSERTIONS |
5041 |
|
|
5042 |
|
\b word boundary |
5043 |
|
\B not a word boundary |
5044 |
|
^ start of subject |
5045 |
|
also after internal newline in multiline mode |
5046 |
|
\A start of subject |
5047 |
|
$ end of subject |
5048 |
|
also before newline at end of subject |
5049 |
|
also before internal newline in multiline mode |
5050 |
|
\Z end of subject |
5051 |
|
also before newline at end of subject |
5052 |
|
\z end of subject |
5053 |
|
\G first matching position in subject |
5054 |
|
|
5055 |
|
|
5056 |
|
MATCH POINT RESET |
5057 |
|
|
5058 |
|
\K reset start of match |
5059 |
|
|
5060 |
|
|
5061 |
|
ALTERNATION |
5062 |
|
|
5063 |
|
expr|expr|expr... |
5064 |
|
|
5065 |
|
|
5066 |
|
CAPTURING |
5067 |
|
|
5068 |
|
(...) capturing group |
5069 |
|
(?<name>...) named capturing group (Perl) |
5070 |
|
(?'name'...) named capturing group (Perl) |
5071 |
|
(?P<name>...) named capturing group (Python) |
5072 |
|
(?:...) non-capturing group |
5073 |
|
(?|...) non-capturing group; reset group numbers for |
5074 |
|
capturing groups in each alternative |
5075 |
|
|
5076 |
|
|
5077 |
|
ATOMIC GROUPS |
5078 |
|
|
5079 |
|
(?>...) atomic, non-capturing group |
5080 |
|
|
5081 |
|
|
5082 |
|
COMMENT |
5083 |
|
|
5084 |
|
(?#....) comment (not nestable) |
5085 |
|
|
5086 |
|
|
5087 |
|
OPTION SETTING |
5088 |
|
|
5089 |
|
(?i) caseless |
5090 |
|
(?J) allow duplicate names |
5091 |
|
(?m) multiline |
5092 |
|
(?s) single line (dotall) |
5093 |
|
(?U) default ungreedy (lazy) |
5094 |
|
(?x) extended (ignore white space) |
5095 |
|
(?-...) unset option(s) |
5096 |
|
|
5097 |
|
|
5098 |
|
LOOKAHEAD AND LOOKBEHIND ASSERTIONS |
5099 |
|
|
5100 |
|
(?=...) positive look ahead |
5101 |
|
(?!...) negative look ahead |
5102 |
|
(?<=...) positive look behind |
5103 |
|
(?<!...) negative look behind |
5104 |
|
|
5105 |
|
Each top-level branch of a look behind must be of a fixed length. |
5106 |
|
|
5107 |
|
|
5108 |
|
BACKREFERENCES |
5109 |
|
|
5110 |
|
\n reference by number (can be ambiguous) |
5111 |
|
\gn reference by number |
5112 |
|
\g{n} reference by number |
5113 |
|
\g{-n} relative reference by number |
5114 |
|
\k<name> reference by name (Perl) |
5115 |
|
\k'name' reference by name (Perl) |
5116 |
|
\g{name} reference by name (Perl) |
5117 |
|
\k{name} reference by name (.NET) |
5118 |
|
(?P=name) reference by name (Python) |
5119 |
|
|
5120 |
|
|
5121 |
|
SUBROUTINE REFERENCES (POSSIBLY RECURSIVE) |
5122 |
|
|
5123 |
|
(?R) recurse whole pattern |
5124 |
|
(?n) call subpattern by absolute number |
5125 |
|
(?+n) call subpattern by relative number |
5126 |
|
(?-n) call subpattern by relative number |
5127 |
|
(?&name) call subpattern by name (Perl) |
5128 |
|
(?P>name) call subpattern by name (Python) |
5129 |
|
|
5130 |
|
|
5131 |
|
CONDITIONAL PATTERNS |
5132 |
|
|
5133 |
|
(?(condition)yes-pattern) |
5134 |
|
(?(condition)yes-pattern|no-pattern) |
5135 |
|
|
5136 |
|
(?(n)... absolute reference condition |
5137 |
|
(?(+n)... relative reference condition |
5138 |
|
(?(-n)... relative reference condition |
5139 |
|
(?(<name>)... named reference condition (Perl) |
5140 |
|
(?('name')... named reference condition (Perl) |
5141 |
|
(?(name)... named reference condition (PCRE) |
5142 |
|
(?(R)... overall recursion condition |
5143 |
|
(?(Rn)... specific group recursion condition |
5144 |
|
(?(R&name)... specific recursion condition |
5145 |
|
(?(DEFINE)... define subpattern for reference |
5146 |
|
(?(assert)... assertion condition |
5147 |
|
|
5148 |
|
|
5149 |
|
BACKTRACKING CONTROL |
5150 |
|
|
5151 |
|
The following act immediately they are reached: |
5152 |
|
|
5153 |
|
(*ACCEPT) force successful match |
5154 |
|
(*FAIL) force backtrack; synonym (*F) |
5155 |
|
|
5156 |
|
The following act only when a subsequent match failure causes a back- |
5157 |
|
track to reach them. They all force a match failure, but they differ in |
5158 |
|
what happens afterwards. Those that advance the start-of-match point do |
5159 |
|
so only if the pattern is not anchored. |
5160 |
|
|
5161 |
|
(*COMMIT) overall failure, no advance of starting point |
5162 |
|
(*PRUNE) advance to next starting character |
5163 |
|
(*SKIP) advance start to current matching position |
5164 |
|
(*THEN) local failure, backtrack to next alternation |
5165 |
|
|
5166 |
|
|
5167 |
|
NEWLINE CONVENTIONS |
5168 |
|
|
5169 |
|
These are recognized only at the very start of the pattern or after a |
5170 |
|
(*BSR_...) option. |
5171 |
|
|
5172 |
|
(*CR) |
5173 |
|
(*LF) |
5174 |
|
(*CRLF) |
5175 |
|
(*ANYCRLF) |
5176 |
|
(*ANY) |
5177 |
|
|
5178 |
|
|
5179 |
|
WHAT \R MATCHES |
5180 |
|
|
5181 |
|
These are recognized only at the very start of the pattern or after a |
5182 |
|
(*...) option that sets the newline convention. |
5183 |
|
|
5184 |
|
(*BSR_ANYCRLF) |
5185 |
|
(*BSR_UNICODE) |
5186 |
|
|
5187 |
|
|
5188 |
|
CALLOUTS |
5189 |
|
|
5190 |
|
(?C) callout |
5191 |
|
(?Cn) callout with data n |
5192 |
|
|
5193 |
|
|
5194 |
|
SEE ALSO |
5195 |
|
|
5196 |
|
pcrepattern(3), pcreapi(3), pcrecallout(3), pcrematching(3), pcre(3). |
5197 |
|
|
5198 |
|
|
5199 |
|
AUTHOR |
5200 |
|
|
5201 |
|
Philip Hazel |
5202 |
|
University Computing Service |
5203 |
|
Cambridge CB2 3QH, England. |
5204 |
|
|
5205 |
|
|
5206 |
|
REVISION |
5207 |
|
|
5208 |
|
Last updated: 21 September 2007 |
5209 |
Copyright (c) 1997-2007 University of Cambridge. |
Copyright (c) 1997-2007 University of Cambridge. |
5210 |
------------------------------------------------------------------------------ |
------------------------------------------------------------------------------ |
5211 |
|
|
5286 |
|
|
5287 |
If PCRE_PARTIAL is set for a pattern that does not conform to the |
If PCRE_PARTIAL is set for a pattern that does not conform to the |
5288 |
restrictions, pcre_exec() returns the error code PCRE_ERROR_BADPARTIAL |
restrictions, pcre_exec() returns the error code PCRE_ERROR_BADPARTIAL |
5289 |
(-13). |
(-13). You can use the PCRE_INFO_OKPARTIAL call to pcre_fullinfo() to |
5290 |
|
find out if a compiled pattern can be used for partial matching. |
5291 |
|
|
5292 |
|
|
5293 |
EXAMPLE OF PARTIAL MATCHING USING PCRETEST |
EXAMPLE OF PARTIAL MATCHING USING PCRETEST |
5294 |
|
|
5295 |
If the escape sequence \P is present in a pcretest data line, the |
If the escape sequence \P is present in a pcretest data line, the |
5296 |
PCRE_PARTIAL flag is used for the match. Here is a run of pcretest that |
PCRE_PARTIAL flag is used for the match. Here is a run of pcretest that |
5297 |
uses the date example quoted above: |
uses the date example quoted above: |
5298 |
|
|
5309 |
data> j\P |
data> j\P |
5310 |
No match |
No match |
5311 |
|
|
5312 |
The first data string is matched completely, so pcretest shows the |
The first data string is matched completely, so pcretest shows the |
5313 |
matched substrings. The remaining four strings do not match the com- |
matched substrings. The remaining four strings do not match the com- |
5314 |
plete pattern, but the first two are partial matches. The same test, |
plete pattern, but the first two are partial matches. The same test, |
5315 |
using pcre_dfa_exec() matching (by means of the \D escape sequence), |
using pcre_dfa_exec() matching (by means of the \D escape sequence), |
5316 |
produces the following output: |
produces the following output: |
5317 |
|
|
5318 |
re> /^\d?\d(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)\d\d$/ |
re> /^\d?\d(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)\d\d$/ |
5327 |
data> j\P\D |
data> j\P\D |
5328 |
No match |
No match |
5329 |
|
|
5330 |
Notice that in this case the portion of the string that was matched is |
Notice that in this case the portion of the string that was matched is |
5331 |
made available. |
made available. |
5332 |
|
|
5333 |
|
|
5334 |
MULTI-SEGMENT MATCHING WITH pcre_dfa_exec() |
MULTI-SEGMENT MATCHING WITH pcre_dfa_exec() |
5335 |
|
|
5336 |
When a partial match has been found using pcre_dfa_exec(), it is possi- |
When a partial match has been found using pcre_dfa_exec(), it is possi- |
5337 |
ble to continue the match by providing additional subject data and |
ble to continue the match by providing additional subject data and |
5338 |
calling pcre_dfa_exec() again with the same compiled regular expres- |
calling pcre_dfa_exec() again with the same compiled regular expres- |
5339 |
sion, this time setting the PCRE_DFA_RESTART option. You must also pass |
sion, this time setting the PCRE_DFA_RESTART option. You must also pass |
5340 |
the same working space as before, because this is where details of the |
the same working space as before, because this is where details of the |
5341 |
previous partial match are stored. Here is an example using pcretest, |
previous partial match are stored. Here is an example using pcretest, |
5342 |
using the \R escape sequence to set the PCRE_DFA_RESTART option (\P and |
using the \R escape sequence to set the PCRE_DFA_RESTART option (\P and |
5343 |
\D are as above): |
\D are as above): |
5344 |
|
|
5348 |
data> n05\R\D |
data> n05\R\D |
5349 |
0: n05 |
0: n05 |
5350 |
|
|
5351 |
The first call has "23ja" as the subject, and requests partial match- |
The first call has "23ja" as the subject, and requests partial match- |
5352 |
ing; the second call has "n05" as the subject for the continued |
ing; the second call has "n05" as the subject for the continued |
5353 |
(restarted) match. Notice that when the match is complete, only the |
(restarted) match. Notice that when the match is complete, only the |
5354 |
last part is shown; PCRE does not retain the previously partially- |
last part is shown; PCRE does not retain the previously partially- |
5355 |
matched string. It is up to the calling program to do that if it needs |
matched string. It is up to the calling program to do that if it needs |
5356 |
to. |
to. |
5357 |
|
|
5358 |
You can set PCRE_PARTIAL with PCRE_DFA_RESTART to continue partial |
You can set PCRE_PARTIAL with PCRE_DFA_RESTART to continue partial |
5359 |
matching over multiple segments. This facility can be used to pass very |
matching over multiple segments. This facility can be used to pass very |
5360 |
long subject strings to pcre_dfa_exec(). However, some care is needed |
long subject strings to pcre_dfa_exec(). However, some care is needed |
5361 |
for certain types of pattern. |
for certain types of pattern. |
5362 |
|
|
5363 |
1. If the pattern contains tests for the beginning or end of a line, |
1. If the pattern contains tests for the beginning or end of a line, |
5364 |
you need to pass the PCRE_NOTBOL or PCRE_NOTEOL options, as appropri- |
you need to pass the PCRE_NOTBOL or PCRE_NOTEOL options, as appropri- |
5365 |
ate, when the subject string for any call does not contain the begin- |
ate, when the subject string for any call does not contain the begin- |
5366 |
ning or end of a line. |
ning or end of a line. |
5367 |
|
|
5368 |
2. If the pattern contains backward assertions (including \b or \B), |
2. If the pattern contains backward assertions (including \b or \B), |
5369 |
you need to arrange for some overlap in the subject strings to allow |
you need to arrange for some overlap in the subject strings to allow |
5370 |
for this. For example, you could pass the subject in chunks that are |
for this. For example, you could pass the subject in chunks that are |
5371 |
500 bytes long, but in a buffer of 700 bytes, with the starting offset |
500 bytes long, but in a buffer of 700 bytes, with the starting offset |
5372 |
set to 200 and the previous 200 bytes at the start of the buffer. |
set to 200 and the previous 200 bytes at the start of the buffer. |
5373 |
|
|
5374 |
3. Matching a subject string that is split into multiple segments does |
3. Matching a subject string that is split into multiple segments does |
5375 |
not always produce exactly the same result as matching over one single |
not always produce exactly the same result as matching over one single |
5376 |
long string. The difference arises when there are multiple matching |
long string. The difference arises when there are multiple matching |
5377 |
possibilities, because a partial match result is given only when there |
possibilities, because a partial match result is given only when there |
5378 |
are no completed matches in a call to pcre_dfa_exec(). This means that |
are no completed matches in a call to pcre_dfa_exec(). This means that |
5379 |
as soon as the shortest match has been found, continuation to a new |
as soon as the shortest match has been found, continuation to a new |
5380 |
subject segment is no longer possible. Consider this pcretest example: |
subject segment is no longer possible. Consider this pcretest example: |
5381 |
|
|
5382 |
re> /dog(sbody)?/ |
re> /dog(sbody)?/ |
5388 |
0: dogsbody |
0: dogsbody |
5389 |
1: dog |
1: dog |
5390 |
|
|
5391 |
The pattern matches the words "dog" or "dogsbody". When the subject is |
The pattern matches the words "dog" or "dogsbody". When the subject is |
5392 |
presented in several parts ("do" and "gsb" being the first two) the |
presented in several parts ("do" and "gsb" being the first two) the |
5393 |
match stops when "dog" has been found, and it is not possible to con- |
match stops when "dog" has been found, and it is not possible to con- |
5394 |
tinue. On the other hand, if "dogsbody" is presented as a single |
tinue. On the other hand, if "dogsbody" is presented as a single |
5395 |
string, both matches are found. |
string, both matches are found. |
5396 |
|
|
5397 |
Because of this phenomenon, it does not usually make sense to end a |
Because of this phenomenon, it does not usually make sense to end a |
5398 |
pattern that is going to be matched in this way with a variable repeat. |
pattern that is going to be matched in this way with a variable repeat. |
5399 |
|
|
5400 |
4. Patterns that contain alternatives at the top level which do not all |
4. Patterns that contain alternatives at the top level which do not all |
5403 |
|
|
5404 |
1234|3789 |
1234|3789 |
5405 |
|
|
5406 |
If the first part of the subject is "ABC123", a partial match of the |
If the first part of the subject is "ABC123", a partial match of the |
5407 |
first alternative is found at offset 3. There is no partial match for |
first alternative is found at offset 3. There is no partial match for |
5408 |
the second alternative, because such a match does not start at the same |
the second alternative, because such a match does not start at the same |
5409 |
point in the subject string. Attempting to continue with the string |
point in the subject string. Attempting to continue with the string |
5410 |
"789" does not yield a match because only those alternatives that match |
"789" does not yield a match because only those alternatives that match |
5411 |
at one point in the subject are remembered. The problem arises because |
at one point in the subject are remembered. The problem arises because |
5412 |
the start of the second alternative matches within the first alterna- |
the start of the second alternative matches within the first alterna- |
5413 |
tive. There is no problem with anchored patterns or patterns such as: |
tive. There is no problem with anchored patterns or patterns such as: |
5414 |
|
|
5415 |
1234|ABCD |
1234|ABCD |
5426 |
|
|
5427 |
REVISION |
REVISION |
5428 |
|
|
5429 |
Last updated: 06 March 2007 |
Last updated: 04 June 2007 |
5430 |
Copyright (c) 1997-2007 University of Cambridge. |
Copyright (c) 1997-2007 University of Cambridge. |
5431 |
------------------------------------------------------------------------------ |
------------------------------------------------------------------------------ |
5432 |
|
|
5536 |
|
|
5537 |
COMPATIBILITY WITH DIFFERENT PCRE RELEASES |
COMPATIBILITY WITH DIFFERENT PCRE RELEASES |
5538 |
|
|
5539 |
The layout of the control block that is at the start of the data that |
In general, it is safest to recompile all saved patterns when you |
5540 |
makes up a compiled pattern was changed for release 5.0. If you have |
update to a new PCRE release, though not all updates actually require |
5541 |
any saved patterns that were compiled with previous releases (not a |
this. Recompiling is definitely needed for release 7.2. |
|
facility that was previously advertised), you will have to recompile |
|
|
them for release 5.0 and above. |
|
|
|
|
|
If you have any saved patterns in UTF-8 mode that use \p or \P that |
|
|
were compiled with any release up to and including 6.4, you will have |
|
|
to recompile them for release 6.5 and above. |
|
|
|
|
|
All saved patterns from earlier releases must be recompiled for release |
|
|
7.0 or higher, because there was an internal reorganization at that |
|
|
release. |
|
5542 |
|
|
5543 |
|
|
5544 |
AUTHOR |
AUTHOR |
5550 |
|
|
5551 |
REVISION |
REVISION |
5552 |
|
|
5553 |
Last updated: 24 April 2007 |
Last updated: 13 June 2007 |
5554 |
Copyright (c) 1997-2007 University of Cambridge. |
Copyright (c) 1997-2007 University of Cambridge. |
5555 |
------------------------------------------------------------------------------ |
------------------------------------------------------------------------------ |
5556 |
|
|
6285 |
bility of matching an empty string. Comments in the code explain what |
bility of matching an empty string. Comments in the code explain what |
6286 |
is going on. |
is going on. |
6287 |
|
|
6288 |
If PCRE is installed in the standard include and library directories |
The demonstration program is automatically built if you use "./config- |
6289 |
for your system, you should be able to compile the demonstration pro- |
ure;make" to build PCRE. Otherwise, if PCRE is installed in the stan- |
6290 |
gram using this command: |
dard include and library directories for your system, you should be |
6291 |
|
able to compile the demonstration program using this command: |
6292 |
|
|
6293 |
gcc -o pcredemo pcredemo.c -lpcre |
gcc -o pcredemo pcredemo.c -lpcre |
6294 |
|
|
6295 |
If PCRE is installed elsewhere, you may need to add additional options |
If PCRE is installed elsewhere, you may need to add additional options |
6296 |
to the command line. For example, on a Unix-like system that has PCRE |
to the command line. For example, on a Unix-like system that has PCRE |
6297 |
installed in /usr/local, you can compile the demonstration program |
installed in /usr/local, you can compile the demonstration program |
6298 |
using a command like this: |
using a command like this: |
6299 |
|
|
6300 |
gcc -o pcredemo -I/usr/local/include pcredemo.c \ |
gcc -o pcredemo -I/usr/local/include pcredemo.c \ |
6301 |
-L/usr/local/lib -lpcre |
-L/usr/local/lib -lpcre |
6302 |
|
|
6303 |
Once you have compiled the demonstration program, you can run simple |
Once you have compiled the demonstration program, you can run simple |
6304 |
tests like this: |
tests like this: |
6305 |
|
|
6306 |
./pcredemo 'cat|dog' 'the cat sat on the mat' |
./pcredemo 'cat|dog' 'the cat sat on the mat' |
6307 |
./pcredemo -g 'cat|dog' 'the dog sat on the cat' |
./pcredemo -g 'cat|dog' 'the dog sat on the cat' |
6308 |
|
|
6309 |
Note that there is a much more comprehensive test program, called |
Note that there is a much more comprehensive test program, called |
6310 |
pcretest, which supports many more facilities for testing regular |
pcretest, which supports many more facilities for testing regular |
6311 |
expressions and the PCRE library. The pcredemo program is provided as a |
expressions and the PCRE library. The pcredemo program is provided as a |
6312 |
simple coding example. |
simple coding example. |
6313 |
|
|
6315 |
the standard library directory, you may get an error like this when you |
the standard library directory, you may get an error like this when you |
6316 |
try to run pcredemo: |
try to run pcredemo: |
6317 |
|
|
6318 |
ld.so.1: a.out: fatal: libpcre.so.0: open failed: No such file or |
ld.so.1: a.out: fatal: libpcre.so.0: open failed: No such file or |
6319 |
directory |
directory |
6320 |
|
|
6321 |
This is caused by the way shared library support works on those sys- |
This is caused by the way shared library support works on those sys- |
6322 |
tems. You need to add |
tems. You need to add |
6323 |
|
|
6324 |
-R/usr/local/lib |
-R/usr/local/lib |
6335 |
|
|
6336 |
REVISION |
REVISION |
6337 |
|
|
6338 |
Last updated: 06 March 2007 |
Last updated: 13 June 2007 |
6339 |
Copyright (c) 1997-2007 University of Cambridge. |
Copyright (c) 1997-2007 University of Cambridge. |
6340 |
------------------------------------------------------------------------------ |
------------------------------------------------------------------------------ |
6341 |
PCRESTACK(3) PCRESTACK(3) |
PCRESTACK(3) PCRESTACK(3) |
6405 |
In environments where stack memory is constrained, you might want to |
In environments where stack memory is constrained, you might want to |
6406 |
compile PCRE to use heap memory instead of stack for remembering back- |
compile PCRE to use heap memory instead of stack for remembering back- |
6407 |
up points. This makes it run a lot more slowly, however. Details of how |
up points. This makes it run a lot more slowly, however. Details of how |
6408 |
to do this are given in the pcrebuild documentation. |
to do this are given in the pcrebuild documentation. When built in this |
6409 |
|
way, instead of using the stack, PCRE obtains and frees memory by call- |
6410 |
In Unix-like environments, there is not often a problem with the stack |
ing the functions that are pointed to by the pcre_stack_malloc and |
6411 |
unless very long strings are involved, though the default limit on |
pcre_stack_free variables. By default, these point to malloc() and |
6412 |
stack size varies from system to system. Values from 8Mb to 64Mb are |
free(), but you can replace the pointers to cause PCRE to use your own |
6413 |
|
functions. Since the block sizes are always the same, and are always |
6414 |
|
freed in reverse order, it may be possible to implement customized mem- |
6415 |
|
ory handlers that are more efficient than the standard functions. |
6416 |
|
|
6417 |
|
In Unix-like environments, there is not often a problem with the stack |
6418 |
|
unless very long strings are involved, though the default limit on |
6419 |
|
stack size varies from system to system. Values from 8Mb to 64Mb are |
6420 |
common. You can find your default limit by running the command: |
common. You can find your default limit by running the command: |
6421 |
|
|
6422 |
ulimit -s |
ulimit -s |
6423 |
|
|
6424 |
Unfortunately, the effect of running out of stack is often SIGSEGV, |
Unfortunately, the effect of running out of stack is often SIGSEGV, |
6425 |
though sometimes a more explicit error message is given. You can nor- |
though sometimes a more explicit error message is given. You can nor- |
6426 |
mally increase the limit on stack size by code such as this: |
mally increase the limit on stack size by code such as this: |
6427 |
|
|
6428 |
struct rlimit rlim; |
struct rlimit rlim; |
6430 |
rlim.rlim_cur = 100*1024*1024; |
rlim.rlim_cur = 100*1024*1024; |
6431 |
setrlimit(RLIMIT_STACK, &rlim); |
setrlimit(RLIMIT_STACK, &rlim); |
6432 |
|
|
6433 |
This reads the current limits (soft and hard) using getrlimit(), then |
This reads the current limits (soft and hard) using getrlimit(), then |
6434 |
attempts to increase the soft limit to 100Mb using setrlimit(). You |
attempts to increase the soft limit to 100Mb using setrlimit(). You |
6435 |
must do this before calling pcre_exec(). |
must do this before calling pcre_exec(). |
6436 |
|
|
6437 |
PCRE has an internal counter that can be used to limit the depth of |
PCRE has an internal counter that can be used to limit the depth of |
6438 |
recursion, and thus cause pcre_exec() to give an error code before it |
recursion, and thus cause pcre_exec() to give an error code before it |
6439 |
runs out of stack. By default, the limit is very large, and unlikely |
runs out of stack. By default, the limit is very large, and unlikely |
6440 |
ever to operate. It can be changed when PCRE is built, and it can also |
ever to operate. It can be changed when PCRE is built, and it can also |
6441 |
be set when pcre_exec() is called. For details of these interfaces, see |
be set when pcre_exec() is called. For details of these interfaces, see |
6442 |
the pcrebuild and pcreapi documentation. |
the pcrebuild and pcreapi documentation. |
6443 |
|
|
6444 |
As a very rough rule of thumb, you should reckon on about 500 bytes per |
As a very rough rule of thumb, you should reckon on about 500 bytes per |
6445 |
recursion. Thus, if you want to limit your stack usage to 8Mb, you |
recursion. Thus, if you want to limit your stack usage to 8Mb, you |
6446 |
should set the limit at 16000 recursions. A 64Mb stack, on the other |
should set the limit at 16000 recursions. A 64Mb stack, on the other |
6447 |
hand, can support around 128000 recursions. The pcretest test program |
hand, can support around 128000 recursions. The pcretest test program |
6448 |
has a command line option (-S) that can be used to increase the size of |
has a command line option (-S) that can be used to increase the size of |
6449 |
its stack. |
its stack. |
6450 |
|
|
6458 |
|
|
6459 |
REVISION |
REVISION |
6460 |
|
|
6461 |
Last updated: 12 March 2007 |
Last updated: 05 June 2007 |
6462 |
Copyright (c) 1997-2007 University of Cambridge. |
Copyright (c) 1997-2007 University of Cambridge. |
6463 |
------------------------------------------------------------------------------ |
------------------------------------------------------------------------------ |
6464 |
|
|