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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 691 - (show annotations)
Sun Sep 11 14:31:21 2011 UTC (8 years ago) by ph10
File MIME type: text/plain
File size: 397489 byte(s)
Error occurred while calculating annotation data.
Final source and document tidies for 8.20-RC1.
1 -----------------------------------------------------------------------------
2 This file contains a concatenation of the PCRE man pages, converted to plain
3 text format for ease of searching with a text editor, or for use on systems
4 that do not have a man page processor. The small individual files that give
5 synopses of each function in the library have not been included. Neither has
6 the pcredemo program. There are separate text files for the pcregrep and
7 pcretest commands.
8 -----------------------------------------------------------------------------
9
10
11 PCRE(3) PCRE(3)
12
13
14 NAME
15 PCRE - Perl-compatible regular expressions
16
17
18 INTRODUCTION
19
20 The PCRE library is a set of functions that implement regular expres-
21 sion pattern matching using the same syntax and semantics as Perl, with
22 just a few differences. Some features that appeared in Python and PCRE
23 before they appeared in Perl are also available using the Python syn-
24 tax, there is some support for one or two .NET and Oniguruma syntax
25 items, and there is an option for requesting some minor changes that
26 give better JavaScript compatibility.
27
28 The current implementation of PCRE corresponds approximately with Perl
29 5.12, including support for UTF-8 encoded strings and Unicode general
30 category properties. However, UTF-8 and Unicode support has to be
31 explicitly enabled; it is not the default. The Unicode tables corre-
32 spond to Unicode release 6.0.0.
33
34 In addition to the Perl-compatible matching function, PCRE contains an
35 alternative function that matches the same compiled patterns in a dif-
36 ferent way. In certain circumstances, the alternative function has some
37 advantages. For a discussion of the two matching algorithms, see the
38 pcrematching page.
39
40 PCRE is written in C and released as a C library. A number of people
41 have written wrappers and interfaces of various kinds. In particular,
42 Google Inc. have provided a comprehensive C++ wrapper. This is now
43 included as part of the PCRE distribution. The pcrecpp page has details
44 of this interface. Other people's contributions can be found in the
45 Contrib directory at the primary FTP site, which is:
46
47 ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre
48
49 Details of exactly which Perl regular expression features are and are
50 not supported by PCRE are given in separate documents. See the pcrepat-
51 tern and pcrecompat pages. There is a syntax summary in the pcresyntax
52 page.
53
54 Some features of PCRE can be included, excluded, or changed when the
55 library is built. The pcre_config() function makes it possible for a
56 client to discover which features are available. The features them-
57 selves are described in the pcrebuild page. Documentation about build-
58 ing PCRE for various operating systems can be found in the README and
59 NON-UNIX-USE files in the source distribution.
60
61 The library contains a number of undocumented internal functions and
62 data tables that are used by more than one of the exported external
63 functions, but which are not intended for use by external callers.
64 Their names all begin with "_pcre_", which hopefully will not provoke
65 any name clashes. In some environments, it is possible to control which
66 external symbols are exported when a shared library is built, and in
67 these cases the undocumented symbols are not exported.
68
69
70 USER DOCUMENTATION
71
72 The user documentation for PCRE comprises a number of different sec-
73 tions. In the "man" format, each of these is a separate "man page". In
74 the HTML format, each is a separate page, linked from the index page.
75 In the plain text format, all the sections, except the pcredemo sec-
76 tion, are concatenated, for ease of searching. The sections are as fol-
77 lows:
78
79 pcre this document
80 pcre-config show PCRE installation configuration information
81 pcreapi details of PCRE's native C API
82 pcrebuild options for building PCRE
83 pcrecallout details of the callout feature
84 pcrecompat discussion of Perl compatibility
85 pcrecpp details of the C++ wrapper
86 pcredemo a demonstration C program that uses PCRE
87 pcregrep description of the pcregrep command
88 pcrejit discussion of the just-in-time optimization support
89 pcrelimits details of size and other limits
90 pcrematching discussion of the two matching algorithms
91 pcrepartial details of the partial matching facility
92 pcrepattern syntax and semantics of supported
93 regular expressions
94 pcreperform discussion of performance issues
95 pcreposix the POSIX-compatible C API
96 pcreprecompile details of saving and re-using precompiled patterns
97 pcresample discussion of the pcredemo program
98 pcrestack discussion of stack usage
99 pcresyntax quick syntax reference
100 pcretest description of the pcretest testing command
101 pcreunicode discussion of Unicode and UTF-8 support
102
103 In addition, in the "man" and HTML formats, there is a short page for
104 each C library function, listing its arguments and results.
105
106
107 AUTHOR
108
109 Philip Hazel
110 University Computing Service
111 Cambridge CB2 3QH, England.
112
113 Putting an actual email address here seems to have been a spam magnet,
114 so I've taken it away. If you want to email me, use my two initials,
115 followed by the two digits 10, at the domain cam.ac.uk.
116
117
118 REVISION
119
120 Last updated: 24 August 2011
121 Copyright (c) 1997-2011 University of Cambridge.
122 ------------------------------------------------------------------------------
123
124
125 PCREBUILD(3) PCREBUILD(3)
126
127
128 NAME
129 PCRE - Perl-compatible regular expressions
130
131
132 PCRE BUILD-TIME OPTIONS
133
134 This document describes the optional features of PCRE that can be
135 selected when the library is compiled. It assumes use of the configure
136 script, where the optional features are selected or deselected by pro-
137 viding options to configure before running the make command. However,
138 the same options can be selected in both Unix-like and non-Unix-like
139 environments using the GUI facility of cmake-gui if you are using CMake
140 instead of configure to build PCRE.
141
142 There is a lot more information about building PCRE in non-Unix-like
143 environments in the file called NON_UNIX_USE, which is part of the PCRE
144 distribution. You should consult this file as well as the README file
145 if you are building in a non-Unix-like environment.
146
147 The complete list of options for configure (which includes the standard
148 ones such as the selection of the installation directory) can be
149 obtained by running
150
151 ./configure --help
152
153 The following sections include descriptions of options whose names
154 begin with --enable or --disable. These settings specify changes to the
155 defaults for the configure command. Because of the way that configure
156 works, --enable and --disable always come in pairs, so the complemen-
157 tary option always exists as well, but as it specifies the default, it
158 is not described.
159
160
161 BUILDING SHARED AND STATIC LIBRARIES
162
163 The PCRE building process uses libtool to build both shared and static
164 Unix libraries by default. You can suppress one of these by adding one
165 of
166
167 --disable-shared
168 --disable-static
169
170 to the configure command, as required.
171
172
173 C++ SUPPORT
174
175 By default, the configure script will search for a C++ compiler and C++
176 header files. If it finds them, it automatically builds the C++ wrapper
177 library for PCRE. You can disable this by adding
178
179 --disable-cpp
180
181 to the configure command.
182
183
184 UTF-8 SUPPORT
185
186 To build PCRE with support for UTF-8 Unicode character strings, add
187
188 --enable-utf8
189
190 to the configure command. Of itself, this does not make PCRE treat
191 strings as UTF-8. As well as compiling PCRE with this option, you also
192 have have to set the PCRE_UTF8 option when you call the pcre_compile()
193 or pcre_compile2() functions.
194
195 If you set --enable-utf8 when compiling in an EBCDIC environment, PCRE
196 expects its input to be either ASCII or UTF-8 (depending on the runtime
197 option). It is not possible to support both EBCDIC and UTF-8 codes in
198 the same version of the library. Consequently, --enable-utf8 and
199 --enable-ebcdic are mutually exclusive.
200
201
202 UNICODE CHARACTER PROPERTY SUPPORT
203
204 UTF-8 support allows PCRE to process character values greater than 255
205 in the strings that it handles. On its own, however, it does not pro-
206 vide any facilities for accessing the properties of such characters. If
207 you want to be able to use the pattern escapes \P, \p, and \X, which
208 refer to Unicode character properties, you must add
209
210 --enable-unicode-properties
211
212 to the configure command. This implies UTF-8 support, even if you have
213 not explicitly requested it.
214
215 Including Unicode property support adds around 30K of tables to the
216 PCRE library. Only the general category properties such as Lu and Nd
217 are supported. Details are given in the pcrepattern documentation.
218
219
220 JUST-IN-TIME COMPILER SUPPORT
221
222 Just-in-time compiler support is included in the build by specifying
223
224 --enable-jit
225
226 This support is available only for certain hardware architectures. If
227 this option is set for an unsupported architecture, a compile time
228 error occurs. See the pcrejit documentation for a discussion of JIT
229 usage. When JIT support is enabled, pcregrep automatically makes use of
230 it, unless you add
231
232 --disable-pcregrep-jit
233
234 to the "configure" command.
235
236
237 CODE VALUE OF NEWLINE
238
239 By default, PCRE interprets the linefeed (LF) character as indicating
240 the end of a line. This is the normal newline character on Unix-like
241 systems. You can compile PCRE to use carriage return (CR) instead, by
242 adding
243
244 --enable-newline-is-cr
245
246 to the configure command. There is also a --enable-newline-is-lf
247 option, which explicitly specifies linefeed as the newline character.
248
249 Alternatively, you can specify that line endings are to be indicated by
250 the two character sequence CRLF. If you want this, add
251
252 --enable-newline-is-crlf
253
254 to the configure command. There is a fourth option, specified by
255
256 --enable-newline-is-anycrlf
257
258 which causes PCRE to recognize any of the three sequences CR, LF, or
259 CRLF as indicating a line ending. Finally, a fifth option, specified by
260
261 --enable-newline-is-any
262
263 causes PCRE to recognize any Unicode newline sequence.
264
265 Whatever line ending convention is selected when PCRE is built can be
266 overridden when the library functions are called. At build time it is
267 conventional to use the standard for your operating system.
268
269
270 WHAT \R MATCHES
271
272 By default, the sequence \R in a pattern matches any Unicode newline
273 sequence, whatever has been selected as the line ending sequence. If
274 you specify
275
276 --enable-bsr-anycrlf
277
278 the default is changed so that \R matches only CR, LF, or CRLF. What-
279 ever is selected when PCRE is built can be overridden when the library
280 functions are called.
281
282
283 POSIX MALLOC USAGE
284
285 When PCRE is called through the POSIX interface (see the pcreposix doc-
286 umentation), additional working storage is required for holding the
287 pointers to capturing substrings, because PCRE requires three integers
288 per substring, whereas the POSIX interface provides only two. If the
289 number of expected substrings is small, the wrapper function uses space
290 on the stack, because this is faster than using malloc() for each call.
291 The default threshold above which the stack is no longer used is 10; it
292 can be changed by adding a setting such as
293
294 --with-posix-malloc-threshold=20
295
296 to the configure command.
297
298
299 HANDLING VERY LARGE PATTERNS
300
301 Within a compiled pattern, offset values are used to point from one
302 part to another (for example, from an opening parenthesis to an alter-
303 nation metacharacter). By default, two-byte values are used for these
304 offsets, leading to a maximum size for a compiled pattern of around
305 64K. This is sufficient to handle all but the most gigantic patterns.
306 Nevertheless, some people do want to process truyl enormous patterns,
307 so it is possible to compile PCRE to use three-byte or four-byte off-
308 sets by adding a setting such as
309
310 --with-link-size=3
311
312 to the configure command. The value given must be 2, 3, or 4. Using
313 longer offsets slows down the operation of PCRE because it has to load
314 additional bytes when handling them.
315
316
317 AVOIDING EXCESSIVE STACK USAGE
318
319 When matching with the pcre_exec() function, PCRE implements backtrack-
320 ing by making recursive calls to an internal function called match().
321 In environments where the size of the stack is limited, this can se-
322 verely limit PCRE's operation. (The Unix environment does not usually
323 suffer from this problem, but it may sometimes be necessary to increase
324 the maximum stack size. There is a discussion in the pcrestack docu-
325 mentation.) An alternative approach to recursion that uses memory from
326 the heap to remember data, instead of using recursive function calls,
327 has been implemented to work round the problem of limited stack size.
328 If you want to build a version of PCRE that works this way, add
329
330 --disable-stack-for-recursion
331
332 to the configure command. With this configuration, PCRE will use the
333 pcre_stack_malloc and pcre_stack_free variables to call memory manage-
334 ment functions. By default these point to malloc() and free(), but you
335 can replace the pointers so that your own functions are used instead.
336
337 Separate functions are provided rather than using pcre_malloc and
338 pcre_free because the usage is very predictable: the block sizes
339 requested are always the same, and the blocks are always freed in
340 reverse order. A calling program might be able to implement optimized
341 functions that perform better than malloc() and free(). PCRE runs
342 noticeably more slowly when built in this way. This option affects only
343 the pcre_exec() function; it is not relevant for pcre_dfa_exec().
344
345
346 LIMITING PCRE RESOURCE USAGE
347
348 Internally, PCRE has a function called match(), which it calls repeat-
349 edly (sometimes recursively) when matching a pattern with the
350 pcre_exec() function. By controlling the maximum number of times this
351 function may be called during a single matching operation, a limit can
352 be placed on the resources used by a single call to pcre_exec(). The
353 limit can be changed at run time, as described in the pcreapi documen-
354 tation. The default is 10 million, but this can be changed by adding a
355 setting such as
356
357 --with-match-limit=500000
358
359 to the configure command. This setting has no effect on the
360 pcre_dfa_exec() matching function.
361
362 In some environments it is desirable to limit the depth of recursive
363 calls of match() more strictly than the total number of calls, in order
364 to restrict the maximum amount of stack (or heap, if --disable-stack-
365 for-recursion is specified) that is used. A second limit controls this;
366 it defaults to the value that is set for --with-match-limit, which
367 imposes no additional constraints. However, you can set a lower limit
368 by adding, for example,
369
370 --with-match-limit-recursion=10000
371
372 to the configure command. This value can also be overridden at run
373 time.
374
375
376 CREATING CHARACTER TABLES AT BUILD TIME
377
378 PCRE uses fixed tables for processing characters whose code values are
379 less than 256. By default, PCRE is built with a set of tables that are
380 distributed in the file pcre_chartables.c.dist. These tables are for
381 ASCII codes only. If you add
382
383 --enable-rebuild-chartables
384
385 to the configure command, the distributed tables are no longer used.
386 Instead, a program called dftables is compiled and run. This outputs
387 the source for new set of tables, created in the default locale of your
388 C runtime system. (This method of replacing the tables does not work if
389 you are cross compiling, because dftables is run on the local host. If
390 you need to create alternative tables when cross compiling, you will
391 have to do so "by hand".)
392
393
394 USING EBCDIC CODE
395
396 PCRE assumes by default that it will run in an environment where the
397 character code is ASCII (or Unicode, which is a superset of ASCII).
398 This is the case for most computer operating systems. PCRE can, how-
399 ever, be compiled to run in an EBCDIC environment by adding
400
401 --enable-ebcdic
402
403 to the configure command. This setting implies --enable-rebuild-charta-
404 bles. You should only use it if you know that you are in an EBCDIC
405 environment (for example, an IBM mainframe operating system). The
406 --enable-ebcdic option is incompatible with --enable-utf8.
407
408
409 PCREGREP OPTIONS FOR COMPRESSED FILE SUPPORT
410
411 By default, pcregrep reads all files as plain text. You can build it so
412 that it recognizes files whose names end in .gz or .bz2, and reads them
413 with libz or libbz2, respectively, by adding one or both of
414
415 --enable-pcregrep-libz
416 --enable-pcregrep-libbz2
417
418 to the configure command. These options naturally require that the rel-
419 evant libraries are installed on your system. Configuration will fail
420 if they are not.
421
422
423 PCREGREP BUFFER SIZE
424
425 pcregrep uses an internal buffer to hold a "window" on the file it is
426 scanning, in order to be able to output "before" and "after" lines when
427 it finds a match. The size of the buffer is controlled by a parameter
428 whose default value is 20K. The buffer itself is three times this size,
429 but because of the way it is used for holding "before" lines, the long-
430 est line that is guaranteed to be processable is the parameter size.
431 You can change the default parameter value by adding, for example,
432
433 --with-pcregrep-bufsize=50K
434
435 to the configure command. The caller of pcregrep can, however, override
436 this value by specifying a run-time option.
437
438
439 PCRETEST OPTION FOR LIBREADLINE SUPPORT
440
441 If you add
442
443 --enable-pcretest-libreadline
444
445 to the configure command, pcretest is linked with the libreadline
446 library, and when its input is from a terminal, it reads it using the
447 readline() function. This provides line-editing and history facilities.
448 Note that libreadline is GPL-licensed, so if you distribute a binary of
449 pcretest linked in this way, there may be licensing issues.
450
451 Setting this option causes the -lreadline option to be added to the
452 pcretest build. In many operating environments with a sytem-installed
453 libreadline this is sufficient. However, in some environments (e.g. if
454 an unmodified distribution version of readline is in use), some extra
455 configuration may be necessary. The INSTALL file for libreadline says
456 this:
457
458 "Readline uses the termcap functions, but does not link with the
459 termcap or curses library itself, allowing applications which link
460 with readline the to choose an appropriate library."
461
462 If your environment has not been set up so that an appropriate library
463 is automatically included, you may need to add something like
464
465 LIBS="-ncurses"
466
467 immediately before the configure command.
468
469
470 SEE ALSO
471
472 pcreapi(3), pcre_config(3).
473
474
475 AUTHOR
476
477 Philip Hazel
478 University Computing Service
479 Cambridge CB2 3QH, England.
480
481
482 REVISION
483
484 Last updated: 06 September 2011
485 Copyright (c) 1997-2011 University of Cambridge.
486 ------------------------------------------------------------------------------
487
488
489 PCREMATCHING(3) PCREMATCHING(3)
490
491
492 NAME
493 PCRE - Perl-compatible regular expressions
494
495
496 PCRE MATCHING ALGORITHMS
497
498 This document describes the two different algorithms that are available
499 in PCRE for matching a compiled regular expression against a given sub-
500 ject string. The "standard" algorithm is the one provided by the
501 pcre_exec() function. This works in the same was as Perl's matching
502 function, and provides a Perl-compatible matching operation.
503
504 An alternative algorithm is provided by the pcre_dfa_exec() function;
505 this operates in a different way, and is not Perl-compatible. It has
506 advantages and disadvantages compared with the standard algorithm, and
507 these are described below.
508
509 When there is only one possible way in which a given subject string can
510 match a pattern, the two algorithms give the same answer. A difference
511 arises, however, when there are multiple possibilities. For example, if
512 the pattern
513
514 ^<.*>
515
516 is matched against the string
517
518 <something> <something else> <something further>
519
520 there are three possible answers. The standard algorithm finds only one
521 of them, whereas the alternative algorithm finds all three.
522
523
524 REGULAR EXPRESSIONS AS TREES
525
526 The set of strings that are matched by a regular expression can be rep-
527 resented as a tree structure. An unlimited repetition in the pattern
528 makes the tree of infinite size, but it is still a tree. Matching the
529 pattern to a given subject string (from a given starting point) can be
530 thought of as a search of the tree. There are two ways to search a
531 tree: depth-first and breadth-first, and these correspond to the two
532 matching algorithms provided by PCRE.
533
534
535 THE STANDARD MATCHING ALGORITHM
536
537 In the terminology of Jeffrey Friedl's book "Mastering Regular Expres-
538 sions", the standard algorithm is an "NFA algorithm". It conducts a
539 depth-first search of the pattern tree. That is, it proceeds along a
540 single path through the tree, checking that the subject matches what is
541 required. When there is a mismatch, the algorithm tries any alterna-
542 tives at the current point, and if they all fail, it backs up to the
543 previous branch point in the tree, and tries the next alternative
544 branch at that level. This often involves backing up (moving to the
545 left) in the subject string as well. The order in which repetition
546 branches are tried is controlled by the greedy or ungreedy nature of
547 the quantifier.
548
549 If a leaf node is reached, a matching string has been found, and at
550 that point the algorithm stops. Thus, if there is more than one possi-
551 ble match, this algorithm returns the first one that it finds. Whether
552 this is the shortest, the longest, or some intermediate length depends
553 on the way the greedy and ungreedy repetition quantifiers are specified
554 in the pattern.
555
556 Because it ends up with a single path through the tree, it is rela-
557 tively straightforward for this algorithm to keep track of the sub-
558 strings that are matched by portions of the pattern in parentheses.
559 This provides support for capturing parentheses and back references.
560
561
562 THE ALTERNATIVE MATCHING ALGORITHM
563
564 This algorithm conducts a breadth-first search of the tree. Starting
565 from the first matching point in the subject, it scans the subject
566 string from left to right, once, character by character, and as it does
567 this, it remembers all the paths through the tree that represent valid
568 matches. In Friedl's terminology, this is a kind of "DFA algorithm",
569 though it is not implemented as a traditional finite state machine (it
570 keeps multiple states active simultaneously).
571
572 Although the general principle of this matching algorithm is that it
573 scans the subject string only once, without backtracking, there is one
574 exception: when a lookaround assertion is encountered, the characters
575 following or preceding the current point have to be independently
576 inspected.
577
578 The scan continues until either the end of the subject is reached, or
579 there are no more unterminated paths. At this point, terminated paths
580 represent the different matching possibilities (if there are none, the
581 match has failed). Thus, if there is more than one possible match,
582 this algorithm finds all of them, and in particular, it finds the long-
583 est. The matches are returned in decreasing order of length. There is
584 an option to stop the algorithm after the first match (which is neces-
585 sarily the shortest) is found.
586
587 Note that all the matches that are found start at the same point in the
588 subject. If the pattern
589
590 cat(er(pillar)?)?
591
592 is matched against the string "the caterpillar catchment", the result
593 will be the three strings "caterpillar", "cater", and "cat" that start
594 at the fifth character of the subject. The algorithm does not automati-
595 cally move on to find matches that start at later positions.
596
597 There are a number of features of PCRE regular expressions that are not
598 supported by the alternative matching algorithm. They are as follows:
599
600 1. Because the algorithm finds all possible matches, the greedy or
601 ungreedy nature of repetition quantifiers is not relevant. Greedy and
602 ungreedy quantifiers are treated in exactly the same way. However, pos-
603 sessive quantifiers can make a difference when what follows could also
604 match what is quantified, for example in a pattern like this:
605
606 ^a++\w!
607
608 This pattern matches "aaab!" but not "aaa!", which would be matched by
609 a non-possessive quantifier. Similarly, if an atomic group is present,
610 it is matched as if it were a standalone pattern at the current point,
611 and the longest match is then "locked in" for the rest of the overall
612 pattern.
613
614 2. When dealing with multiple paths through the tree simultaneously, it
615 is not straightforward to keep track of captured substrings for the
616 different matching possibilities, and PCRE's implementation of this
617 algorithm does not attempt to do this. This means that no captured sub-
618 strings are available.
619
620 3. Because no substrings are captured, back references within the pat-
621 tern are not supported, and cause errors if encountered.
622
623 4. For the same reason, conditional expressions that use a backrefer-
624 ence as the condition or test for a specific group recursion are not
625 supported.
626
627 5. Because many paths through the tree may be active, the \K escape
628 sequence, which resets the start of the match when encountered (but may
629 be on some paths and not on others), is not supported. It causes an
630 error if encountered.
631
632 6. Callouts are supported, but the value of the capture_top field is
633 always 1, and the value of the capture_last field is always -1.
634
635 7. The \C escape sequence, which (in the standard algorithm) matches a
636 single byte, even in UTF-8 mode, is not supported because the alterna-
637 tive algorithm moves through the subject string one character at a
638 time, for all active paths through the tree.
639
640 8. Except for (*FAIL), the backtracking control verbs such as (*PRUNE)
641 are not supported. (*FAIL) is supported, and behaves like a failing
642 negative assertion.
643
644
645 ADVANTAGES OF THE ALTERNATIVE ALGORITHM
646
647 Using the alternative matching algorithm provides the following advan-
648 tages:
649
650 1. All possible matches (at a single point in the subject) are automat-
651 ically found, and in particular, the longest match is found. To find
652 more than one match using the standard algorithm, you have to do kludgy
653 things with callouts.
654
655 2. Because the alternative algorithm scans the subject string just
656 once, and never needs to backtrack, it is possible to pass very long
657 subject strings to the matching function in several pieces, checking
658 for partial matching each time. Although it is possible to do multi-
659 segment matching using the standard algorithm (pcre_exec()), by retain-
660 ing partially matched substrings, it is more complicated. The pcrepar-
661 tial documentation gives details of partial matching and discusses
662 multi-segment matching.
663
664
665 DISADVANTAGES OF THE ALTERNATIVE ALGORITHM
666
667 The alternative algorithm suffers from a number of disadvantages:
668
669 1. It is substantially slower than the standard algorithm. This is
670 partly because it has to search for all possible matches, but is also
671 because it is less susceptible to optimization.
672
673 2. Capturing parentheses and back references are not supported.
674
675 3. Although atomic groups are supported, their use does not provide the
676 performance advantage that it does for the standard algorithm.
677
678
679 AUTHOR
680
681 Philip Hazel
682 University Computing Service
683 Cambridge CB2 3QH, England.
684
685
686 REVISION
687
688 Last updated: 17 November 2010
689 Copyright (c) 1997-2010 University of Cambridge.
690 ------------------------------------------------------------------------------
691
692
693 PCREAPI(3) PCREAPI(3)
694
695
696 NAME
697 PCRE - Perl-compatible regular expressions
698
699
700 PCRE NATIVE API BASIC FUNCTIONS
701
702 #include <pcre.h>
703
704 pcre *pcre_compile(const char *pattern, int options,
705 const char **errptr, int *erroffset,
706 const unsigned char *tableptr);
707
708 pcre *pcre_compile2(const char *pattern, int options,
709 int *errorcodeptr,
710 const char **errptr, int *erroffset,
711 const unsigned char *tableptr);
712
713 pcre_extra *pcre_study(const pcre *code, int options,
714 const char **errptr);
715
716 void pcre_free_study(pcre_extra *extra);
717
718 int pcre_exec(const pcre *code, const pcre_extra *extra,
719 const char *subject, int length, int startoffset,
720 int options, int *ovector, int ovecsize);
721
722
723 PCRE NATIVE API AUXILIARY FUNCTIONS
724
725 pcre_jit_stack *pcre_jit_stack_alloc(int startsize, int maxsize);
726
727 void pcre_jit_stack_free(pcre_jit_stack *stack);
728
729 void pcre_assign_jit_stack(pcre_extra *extra,
730 pcre_jit_callback callback, void *data);
731
732 int pcre_dfa_exec(const pcre *code, const pcre_extra *extra,
733 const char *subject, int length, int startoffset,
734 int options, int *ovector, int ovecsize,
735 int *workspace, int wscount);
736
737 int pcre_copy_named_substring(const pcre *code,
738 const char *subject, int *ovector,
739 int stringcount, const char *stringname,
740 char *buffer, int buffersize);
741
742 int pcre_copy_substring(const char *subject, int *ovector,
743 int stringcount, int stringnumber, char *buffer,
744 int buffersize);
745
746 int pcre_get_named_substring(const pcre *code,
747 const char *subject, int *ovector,
748 int stringcount, const char *stringname,
749 const char **stringptr);
750
751 int pcre_get_stringnumber(const pcre *code,
752 const char *name);
753
754 int pcre_get_stringtable_entries(const pcre *code,
755 const char *name, char **first, char **last);
756
757 int pcre_get_substring(const char *subject, int *ovector,
758 int stringcount, int stringnumber,
759 const char **stringptr);
760
761 int pcre_get_substring_list(const char *subject,
762 int *ovector, int stringcount, const char ***listptr);
763
764 void pcre_free_substring(const char *stringptr);
765
766 void pcre_free_substring_list(const char **stringptr);
767
768 const unsigned char *pcre_maketables(void);
769
770 int pcre_fullinfo(const pcre *code, const pcre_extra *extra,
771 int what, void *where);
772
773 int pcre_info(const pcre *code, int *optptr, int *firstcharptr);
774
775 int pcre_refcount(pcre *code, int adjust);
776
777 int pcre_config(int what, void *where);
778
779 char *pcre_version(void);
780
781
782 PCRE NATIVE API INDIRECTED FUNCTIONS
783
784 void *(*pcre_malloc)(size_t);
785
786 void (*pcre_free)(void *);
787
788 void *(*pcre_stack_malloc)(size_t);
789
790 void (*pcre_stack_free)(void *);
791
792 int (*pcre_callout)(pcre_callout_block *);
793
794
795 PCRE API OVERVIEW
796
797 PCRE has its own native API, which is described in this document. There
798 are also some wrapper functions that correspond to the POSIX regular
799 expression API, but they do not give access to all the functionality.
800 They are described in the pcreposix documentation. Both of these APIs
801 define a set of C function calls. A C++ wrapper is also distributed
802 with PCRE. It is documented in the pcrecpp page.
803
804 The native API C function prototypes are defined in the header file
805 pcre.h, and on Unix systems the library itself is called libpcre. It
806 can normally be accessed by adding -lpcre to the command for linking an
807 application that uses PCRE. The header file defines the macros
808 PCRE_MAJOR and PCRE_MINOR to contain the major and minor release num-
809 bers for the library. Applications can use these to include support
810 for different releases of PCRE.
811
812 In a Windows environment, if you want to statically link an application
813 program against a non-dll pcre.a file, you must define PCRE_STATIC
814 before including pcre.h or pcrecpp.h, because otherwise the pcre_mal-
815 loc() and pcre_free() exported functions will be declared
816 __declspec(dllimport), with unwanted results.
817
818 The functions pcre_compile(), pcre_compile2(), pcre_study(), and
819 pcre_exec() are used for compiling and matching regular expressions in
820 a Perl-compatible manner. A sample program that demonstrates the sim-
821 plest way of using them is provided in the file called pcredemo.c in
822 the PCRE source distribution. A listing of this program is given in the
823 pcredemo documentation, and the pcresample documentation describes how
824 to compile and run it.
825
826 Just-in-time compiler support is an optional feature of PCRE that can
827 be built in appropriate hardware environments. It greatly speeds up the
828 matching performance of many patterns. Simple programs can easily
829 request that it be used if available, by setting an option that is
830 ignored when it is not relevant. More complicated programs might need
831 to make use of the functions pcre_jit_stack_alloc(),
832 pcre_jit_stack_free(), and pcre_assign_jit_stack() in order to control
833 the JIT code's memory usage. These functions are discussed in the
834 pcrejit documentation.
835
836 A second matching function, pcre_dfa_exec(), which is not Perl-compati-
837 ble, is also provided. This uses a different algorithm for the match-
838 ing. The alternative algorithm finds all possible matches (at a given
839 point in the subject), and scans the subject just once (unless there
840 are lookbehind assertions). However, this algorithm does not return
841 captured substrings. A description of the two matching algorithms and
842 their advantages and disadvantages is given in the pcrematching docu-
843 mentation.
844
845 In addition to the main compiling and matching functions, there are
846 convenience functions for extracting captured substrings from a subject
847 string that is matched by pcre_exec(). They are:
848
849 pcre_copy_substring()
850 pcre_copy_named_substring()
851 pcre_get_substring()
852 pcre_get_named_substring()
853 pcre_get_substring_list()
854 pcre_get_stringnumber()
855 pcre_get_stringtable_entries()
856
857 pcre_free_substring() and pcre_free_substring_list() are also provided,
858 to free the memory used for extracted strings.
859
860 The function pcre_maketables() is used to build a set of character
861 tables in the current locale for passing to pcre_compile(),
862 pcre_exec(), or pcre_dfa_exec(). This is an optional facility that is
863 provided for specialist use. Most commonly, no special tables are
864 passed, in which case internal tables that are generated when PCRE is
865 built are used.
866
867 The function pcre_fullinfo() is used to find out information about a
868 compiled pattern; pcre_info() is an obsolete version that returns only
869 some of the available information, but is retained for backwards com-
870 patibility. The function pcre_version() returns a pointer to a string
871 containing the version of PCRE and its date of release.
872
873 The function pcre_refcount() maintains a reference count in a data
874 block containing a compiled pattern. This is provided for the benefit
875 of object-oriented applications.
876
877 The global variables pcre_malloc and pcre_free initially contain the
878 entry points of the standard malloc() and free() functions, respec-
879 tively. PCRE calls the memory management functions via these variables,
880 so a calling program can replace them if it wishes to intercept the
881 calls. This should be done before calling any PCRE functions.
882
883 The global variables pcre_stack_malloc and pcre_stack_free are also
884 indirections to memory management functions. These special functions
885 are used only when PCRE is compiled to use the heap for remembering
886 data, instead of recursive function calls, when running the pcre_exec()
887 function. See the pcrebuild documentation for details of how to do
888 this. It is a non-standard way of building PCRE, for use in environ-
889 ments that have limited stacks. Because of the greater use of memory
890 management, it runs more slowly. Separate functions are provided so
891 that special-purpose external code can be used for this case. When
892 used, these functions are always called in a stack-like manner (last
893 obtained, first freed), and always for memory blocks of the same size.
894 There is a discussion about PCRE's stack usage in the pcrestack docu-
895 mentation.
896
897 The global variable pcre_callout initially contains NULL. It can be set
898 by the caller to a "callout" function, which PCRE will then call at
899 specified points during a matching operation. Details are given in the
900 pcrecallout documentation.
901
902
903 NEWLINES
904
905 PCRE supports five different conventions for indicating line breaks in
906 strings: a single CR (carriage return) character, a single LF (line-
907 feed) character, the two-character sequence CRLF, any of the three pre-
908 ceding, or any Unicode newline sequence. The Unicode newline sequences
909 are the three just mentioned, plus the single characters VT (vertical
910 tab, U+000B), FF (formfeed, U+000C), NEL (next line, U+0085), LS (line
911 separator, U+2028), and PS (paragraph separator, U+2029).
912
913 Each of the first three conventions is used by at least one operating
914 system as its standard newline sequence. When PCRE is built, a default
915 can be specified. The default default is LF, which is the Unix stan-
916 dard. When PCRE is run, the default can be overridden, either when a
917 pattern is compiled, or when it is matched.
918
919 At compile time, the newline convention can be specified by the options
920 argument of pcre_compile(), or it can be specified by special text at
921 the start of the pattern itself; this overrides any other settings. See
922 the pcrepattern page for details of the special character sequences.
923
924 In the PCRE documentation the word "newline" is used to mean "the char-
925 acter or pair of characters that indicate a line break". The choice of
926 newline convention affects the handling of the dot, circumflex, and
927 dollar metacharacters, the handling of #-comments in /x mode, and, when
928 CRLF is a recognized line ending sequence, the match position advance-
929 ment for a non-anchored pattern. There is more detail about this in the
930 section on pcre_exec() options below.
931
932 The choice of newline convention does not affect the interpretation of
933 the \n or \r escape sequences, nor does it affect what \R matches,
934 which is controlled in a similar way, but by separate options.
935
936
937 MULTITHREADING
938
939 The PCRE functions can be used in multi-threading applications, with
940 the proviso that the memory management functions pointed to by
941 pcre_malloc, pcre_free, pcre_stack_malloc, and pcre_stack_free, and the
942 callout function pointed to by pcre_callout, are shared by all threads.
943
944 The compiled form of a regular expression is not altered during match-
945 ing, so the same compiled pattern can safely be used by several threads
946 at once.
947
948 If the just-in-time optimization feature is being used, it needs sepa-
949 rate memory stack areas for each thread. See the pcrejit documentation
950 for more details.
951
952
953 SAVING PRECOMPILED PATTERNS FOR LATER USE
954
955 The compiled form of a regular expression can be saved and re-used at a
956 later time, possibly by a different program, and even on a host other
957 than the one on which it was compiled. Details are given in the
958 pcreprecompile documentation. However, compiling a regular expression
959 with one version of PCRE for use with a different version is not guar-
960 anteed to work and may cause crashes.
961
962
963 CHECKING BUILD-TIME OPTIONS
964
965 int pcre_config(int what, void *where);
966
967 The function pcre_config() makes it possible for a PCRE client to dis-
968 cover which optional features have been compiled into the PCRE library.
969 The pcrebuild documentation has more details about these optional fea-
970 tures.
971
972 The first argument for pcre_config() is an integer, specifying which
973 information is required; the second argument is a pointer to a variable
974 into which the information is placed. The following information is
975 available:
976
977 PCRE_CONFIG_UTF8
978
979 The output is an integer that is set to one if UTF-8 support is avail-
980 able; otherwise it is set to zero.
981
982 PCRE_CONFIG_UNICODE_PROPERTIES
983
984 The output is an integer that is set to one if support for Unicode
985 character properties is available; otherwise it is set to zero.
986
987 PCRE_CONFIG_JIT
988
989 The output is an integer that is set to one if support for just-in-time
990 compiling is available; otherwise it is set to zero.
991
992 PCRE_CONFIG_NEWLINE
993
994 The output is an integer whose value specifies the default character
995 sequence that is recognized as meaning "newline". The four values that
996 are supported are: 10 for LF, 13 for CR, 3338 for CRLF, -2 for ANYCRLF,
997 and -1 for ANY. Though they are derived from ASCII, the same values
998 are returned in EBCDIC environments. The default should normally corre-
999 spond to the standard sequence for your operating system.
1000
1001 PCRE_CONFIG_BSR
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
1010
1011 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
1013 4. Larger values allow larger regular expressions to be compiled, at
1014 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
1016 pattern to be up to 64K in size.
1017
1018 PCRE_CONFIG_POSIX_MALLOC_THRESHOLD
1019
1020 The output is an integer that contains the threshold above which the
1021 POSIX interface uses malloc() for output vectors. Further details are
1022 given in the pcreposix documentation.
1023
1024 PCRE_CONFIG_MATCH_LIMIT
1025
1026 The output is a long integer that gives the default limit for the num-
1027 ber of internal matching function calls in a pcre_exec() execution.
1028 Further details are given with pcre_exec() below.
1029
1030 PCRE_CONFIG_MATCH_LIMIT_RECURSION
1031
1032 The output is a long integer that gives the default limit for the depth
1033 of recursion when calling the internal matching function in a
1034 pcre_exec() execution. Further details are given with pcre_exec()
1035 below.
1036
1037 PCRE_CONFIG_STACKRECURSE
1038
1039 The output is an integer that is set to one if internal recursion when
1040 running pcre_exec() is implemented by recursive function calls that use
1041 the stack to remember their state. This is the usual way that PCRE is
1042 compiled. The output is zero if PCRE was compiled to use blocks of data
1043 on the heap instead of recursive function calls. In this case,
1044 pcre_stack_malloc and pcre_stack_free are called to manage memory
1045 blocks on the heap, thus avoiding the use of the stack.
1046
1047
1048 COMPILING A PATTERN
1049
1050 pcre *pcre_compile(const char *pattern, int options,
1051 const char **errptr, int *erroffset,
1052 const unsigned char *tableptr);
1053
1054 pcre *pcre_compile2(const char *pattern, int options,
1055 int *errorcodeptr,
1056 const char **errptr, int *erroffset,
1057 const unsigned char *tableptr);
1058
1059 Either of the functions pcre_compile() or pcre_compile2() can be called
1060 to compile a pattern into an internal form. The only difference between
1061 the two interfaces is that pcre_compile2() has an additional argument,
1062 errorcodeptr, via which a numerical error code can be returned. To
1063 avoid too much repetition, we refer just to pcre_compile() below, but
1064 the information applies equally to pcre_compile2().
1065
1066 The pattern is a C string terminated by a binary zero, and is passed in
1067 the pattern argument. A pointer to a single block of memory that is
1068 obtained via pcre_malloc is returned. This contains the compiled code
1069 and related data. The pcre type is defined for the returned block; this
1070 is a typedef for a structure whose contents are not externally defined.
1071 It is up to the caller to free the memory (via pcre_free) when it is no
1072 longer required.
1073
1074 Although the compiled code of a PCRE regex is relocatable, that is, it
1075 does not depend on memory location, the complete pcre data block is not
1076 fully relocatable, because it may contain a copy of the tableptr argu-
1077 ment, which is an address (see below).
1078
1079 The options argument contains various bit settings that affect the com-
1080 pilation. It should be zero if no options are required. The available
1081 options are described below. Some of them (in particular, those that
1082 are compatible with Perl, but some others as well) can also be set and
1083 unset from within the pattern (see the detailed description in the
1084 pcrepattern documentation). For those options that can be different in
1085 different parts of the pattern, the contents of the options argument
1086 specifies their settings at the start of compilation and execution. The
1087 PCRE_ANCHORED, PCRE_BSR_xxx, PCRE_NEWLINE_xxx, PCRE_NO_UTF8_CHECK, and
1088 PCRE_NO_START_OPT options can be set at the time of matching as well as
1089 at compile time.
1090
1091 If errptr is NULL, pcre_compile() returns NULL immediately. Otherwise,
1092 if compilation of a pattern fails, pcre_compile() returns NULL, and
1093 sets the variable pointed to by errptr to point to a textual error mes-
1094 sage. This is a static string that is part of the library. You must not
1095 try to free it. Normally, the offset from the start of the pattern to
1096 the byte that was being processed when the error was discovered is
1097 placed in the variable pointed to by erroffset, which must not be NULL
1098 (if it is, an immediate error is given). However, for an invalid UTF-8
1099 string, the offset is that of the first byte of the failing character.
1100 Also, some errors are not detected until checks are carried out when
1101 the whole pattern has been scanned; in these cases the offset passed
1102 back is the length of the pattern.
1103
1104 Note that the offset is in bytes, not characters, even in UTF-8 mode.
1105 It may sometimes point into the middle of a UTF-8 character.
1106
1107 If pcre_compile2() is used instead of pcre_compile(), and the error-
1108 codeptr argument is not NULL, a non-zero error code number is returned
1109 via this argument in the event of an error. This is in addition to the
1110 textual error message. Error codes and messages are listed below.
1111
1112 If the final argument, tableptr, is NULL, PCRE uses a default set of
1113 character tables that are built when PCRE is compiled, using the
1114 default C locale. Otherwise, tableptr must be an address that is the
1115 result of a call to pcre_maketables(). This value is stored with the
1116 compiled pattern, and used again by pcre_exec(), unless another table
1117 pointer is passed to it. For more discussion, see the section on locale
1118 support below.
1119
1120 This code fragment shows a typical straightforward call to pcre_com-
1121 pile():
1122
1123 pcre *re;
1124 const char *error;
1125 int erroffset;
1126 re = pcre_compile(
1127 "^A.*Z", /* the pattern */
1128 0, /* default options */
1129 &error, /* for error message */
1130 &erroffset, /* for error offset */
1131 NULL); /* use default character tables */
1132
1133 The following names for option bits are defined in the pcre.h header
1134 file:
1135
1136 PCRE_ANCHORED
1137
1138 If this bit is set, the pattern is forced to be "anchored", that is, it
1139 is constrained to match only at the first matching point in the string
1140 that is being searched (the "subject string"). This effect can also be
1141 achieved by appropriate constructs in the pattern itself, which is the
1142 only way to do it in Perl.
1143
1144 PCRE_AUTO_CALLOUT
1145
1146 If this bit is set, pcre_compile() automatically inserts callout items,
1147 all with number 255, before each pattern item. For discussion of the
1148 callout facility, see the pcrecallout documentation.
1149
1150 PCRE_BSR_ANYCRLF
1151 PCRE_BSR_UNICODE
1152
1153 These options (which are mutually exclusive) control what the \R escape
1154 sequence matches. The choice is either to match only CR, LF, or CRLF,
1155 or to match any Unicode newline sequence. The default is specified when
1156 PCRE is built. It can be overridden from within the pattern, or by set-
1157 ting an option when a compiled pattern is matched.
1158
1159 PCRE_CASELESS
1160
1161 If this bit is set, letters in the pattern match both upper and lower
1162 case letters. It is equivalent to Perl's /i option, and it can be
1163 changed within a pattern by a (?i) option setting. In UTF-8 mode, PCRE
1164 always understands the concept of case for characters whose values are
1165 less than 128, so caseless matching is always possible. For characters
1166 with higher values, the concept of case is supported if PCRE is com-
1167 piled with Unicode property support, but not otherwise. If you want to
1168 use caseless matching for characters 128 and above, you must ensure
1169 that PCRE is compiled with Unicode property support as well as with
1170 UTF-8 support.
1171
1172 PCRE_DOLLAR_ENDONLY
1173
1174 If this bit is set, a dollar metacharacter in the pattern matches only
1175 at the end of the subject string. Without this option, a dollar also
1176 matches immediately before a newline at the end of the string (but not
1177 before any other newlines). The PCRE_DOLLAR_ENDONLY option is ignored
1178 if PCRE_MULTILINE is set. There is no equivalent to this option in
1179 Perl, and no way to set it within a pattern.
1180
1181 PCRE_DOTALL
1182
1183 If this bit is set, a dot metacharacter in the pattern matches a char-
1184 acter of any value, including one that indicates a newline. However, it
1185 only ever matches one character, even if newlines are coded as CRLF.
1186 Without this option, a dot does not match when the current position is
1187 at a newline. This option is equivalent to Perl's /s option, and it can
1188 be changed within a pattern by a (?s) option setting. A negative class
1189 such as [^a] always matches newline characters, independent of the set-
1190 ting of this option.
1191
1192 PCRE_DUPNAMES
1193
1194 If this bit is set, names used to identify capturing subpatterns need
1195 not be unique. This can be helpful for certain types of pattern when it
1196 is known that only one instance of the named subpattern can ever be
1197 matched. There are more details of named subpatterns below; see also
1198 the pcrepattern documentation.
1199
1200 PCRE_EXTENDED
1201
1202 If this bit is set, whitespace data characters in the pattern are
1203 totally ignored except when escaped or inside a character class. White-
1204 space does not include the VT character (code 11). In addition, charac-
1205 ters between an unescaped # outside a character class and the next new-
1206 line, inclusive, are also ignored. This is equivalent to Perl's /x
1207 option, and it can be changed within a pattern by a (?x) option set-
1208 ting.
1209
1210 Which characters are interpreted as newlines is controlled by the
1211 options passed to pcre_compile() or by a special sequence at the start
1212 of the pattern, as described in the section entitled "Newline conven-
1213 tions" in the pcrepattern documentation. Note that the end of this type
1214 of comment is a literal newline sequence in the pattern; escape
1215 sequences that happen to represent a newline do not count.
1216
1217 This option makes it possible to include comments inside complicated
1218 patterns. Note, however, that this applies only to data characters.
1219 Whitespace characters may never appear within special character
1220 sequences in a pattern, for example within the sequence (?( that intro-
1221 duces a conditional subpattern.
1222
1223 PCRE_EXTRA
1224
1225 This option was invented in order to turn on additional functionality
1226 of PCRE that is incompatible with Perl, but it is currently of very
1227 little use. When set, any backslash in a pattern that is followed by a
1228 letter that has no special meaning causes an error, thus reserving
1229 these combinations for future expansion. By default, as in Perl, a
1230 backslash followed by a letter with no special meaning is treated as a
1231 literal. (Perl can, however, be persuaded to give an error for this, by
1232 running it with the -w option.) There are at present no other features
1233 controlled by this option. It can also be set by a (?X) option setting
1234 within a pattern.
1235
1236 PCRE_FIRSTLINE
1237
1238 If this option is set, an unanchored pattern is required to match
1239 before or at the first newline in the subject string, though the
1240 matched text may continue over the newline.
1241
1242 PCRE_JAVASCRIPT_COMPAT
1243
1244 If this option is set, PCRE's behaviour is changed in some ways so that
1245 it is compatible with JavaScript rather than Perl. The changes are as
1246 follows:
1247
1248 (1) A lone closing square bracket in a pattern causes a compile-time
1249 error, because this is illegal in JavaScript (by default it is treated
1250 as a data character). Thus, the pattern AB]CD becomes illegal when this
1251 option is set.
1252
1253 (2) At run time, a back reference to an unset subpattern group matches
1254 an empty string (by default this causes the current matching alterna-
1255 tive to fail). A pattern such as (\1)(a) succeeds when this option is
1256 set (assuming it can find an "a" in the subject), whereas it fails by
1257 default, for Perl compatibility.
1258
1259 PCRE_MULTILINE
1260
1261 By default, PCRE treats the subject string as consisting of a single
1262 line of characters (even if it actually contains newlines). The "start
1263 of line" metacharacter (^) matches only at the start of the string,
1264 while the "end of line" metacharacter ($) matches only at the end of
1265 the string, or before a terminating newline (unless PCRE_DOLLAR_ENDONLY
1266 is set). This is the same as Perl.
1267
1268 When PCRE_MULTILINE it is set, the "start of line" and "end of line"
1269 constructs match immediately following or immediately before internal
1270 newlines in the subject string, respectively, as well as at the very
1271 start and end. This is equivalent to Perl's /m option, and it can be
1272 changed within a pattern by a (?m) option setting. If there are no new-
1273 lines in a subject string, or no occurrences of ^ or $ in a pattern,
1274 setting PCRE_MULTILINE has no effect.
1275
1276 PCRE_NEWLINE_CR
1277 PCRE_NEWLINE_LF
1278 PCRE_NEWLINE_CRLF
1279 PCRE_NEWLINE_ANYCRLF
1280 PCRE_NEWLINE_ANY
1281
1282 These options override the default newline definition that was chosen
1283 when PCRE was built. Setting the first or the second specifies that a
1284 newline is indicated by a single character (CR or LF, respectively).
1285 Setting PCRE_NEWLINE_CRLF specifies that a newline is indicated by the
1286 two-character CRLF sequence. Setting PCRE_NEWLINE_ANYCRLF specifies
1287 that any of the three preceding sequences should be recognized. Setting
1288 PCRE_NEWLINE_ANY specifies that any Unicode newline sequence should be
1289 recognized. The Unicode newline sequences are the three just mentioned,
1290 plus the single characters VT (vertical tab, U+000B), FF (formfeed,
1291 U+000C), NEL (next line, U+0085), LS (line separator, U+2028), and PS
1292 (paragraph separator, U+2029). The last two are recognized only in
1293 UTF-8 mode.
1294
1295 The newline setting in the options word uses three bits that are
1296 treated as a number, giving eight possibilities. Currently only six are
1297 used (default plus the five values above). This means that if you set
1298 more than one newline option, the combination may or may not be sensi-
1299 ble. For example, PCRE_NEWLINE_CR with PCRE_NEWLINE_LF is equivalent to
1300 PCRE_NEWLINE_CRLF, but other combinations may yield unused numbers and
1301 cause an error.
1302
1303 The only time that a line break in a pattern is specially recognized
1304 when compiling is when PCRE_EXTENDED is set. CR and LF are whitespace
1305 characters, and so are ignored in this mode. Also, an unescaped # out-
1306 side a character class indicates a comment that lasts until after the
1307 next line break sequence. In other circumstances, line break sequences
1308 in patterns are treated as literal data.
1309
1310 The newline option that is set at compile time becomes the default that
1311 is used for pcre_exec() and pcre_dfa_exec(), but it can be overridden.
1312
1313 PCRE_NO_AUTO_CAPTURE
1314
1315 If this option is set, it disables the use of numbered capturing paren-
1316 theses in the pattern. Any opening parenthesis that is not followed by
1317 ? behaves as if it were followed by ?: but named parentheses can still
1318 be used for capturing (and they acquire numbers in the usual way).
1319 There is no equivalent of this option in Perl.
1320
1321 NO_START_OPTIMIZE
1322
1323 This is an option that acts at matching time; that is, it is really an
1324 option for pcre_exec() or pcre_dfa_exec(). If it is set at compile
1325 time, it is remembered with the compiled pattern and assumed at match-
1326 ing time. For details see the discussion of PCRE_NO_START_OPTIMIZE
1327 below.
1328
1329 PCRE_UCP
1330
1331 This option changes the way PCRE processes \B, \b, \D, \d, \S, \s, \W,
1332 \w, and some of the POSIX character classes. By default, only ASCII
1333 characters are recognized, but if PCRE_UCP is set, Unicode properties
1334 are used instead to classify characters. More details are given in the
1335 section on generic character types in the pcrepattern page. If you set
1336 PCRE_UCP, matching one of the items it affects takes much longer. The
1337 option is available only if PCRE has been compiled with Unicode prop-
1338 erty support.
1339
1340 PCRE_UNGREEDY
1341
1342 This option inverts the "greediness" of the quantifiers so that they
1343 are not greedy by default, but become greedy if followed by "?". It is
1344 not compatible with Perl. It can also be set by a (?U) option setting
1345 within the pattern.
1346
1347 PCRE_UTF8
1348
1349 This option causes PCRE to regard both the pattern and the subject as
1350 strings of UTF-8 characters instead of single-byte character strings.
1351 However, it is available only when PCRE is built to include UTF-8 sup-
1352 port. If not, the use of this option provokes an error. Details of how
1353 this option changes the behaviour of PCRE are given in the pcreunicode
1354 page.
1355
1356 PCRE_NO_UTF8_CHECK
1357
1358 When PCRE_UTF8 is set, the validity of the pattern as a UTF-8 string is
1359 automatically checked. There is a discussion about the validity of
1360 UTF-8 strings in the main pcre page. If an invalid UTF-8 sequence of
1361 bytes is found, pcre_compile() returns an error. If you already know
1362 that your pattern is valid, and you want to skip this check for perfor-
1363 mance reasons, you can set the PCRE_NO_UTF8_CHECK option. When it is
1364 set, the effect of passing an invalid UTF-8 string as a pattern is
1365 undefined. It may cause your program to crash. Note that this option
1366 can also be passed to pcre_exec() and pcre_dfa_exec(), to suppress the
1367 UTF-8 validity checking of subject strings.
1368
1369
1370 COMPILATION ERROR CODES
1371
1372 The following table lists the error codes than may be returned by
1373 pcre_compile2(), along with the error messages that may be returned by
1374 both compiling functions. As PCRE has developed, some error codes have
1375 fallen out of use. To avoid confusion, they have not been re-used.
1376
1377 0 no error
1378 1 \ at end of pattern
1379 2 \c at end of pattern
1380 3 unrecognized character follows \
1381 4 numbers out of order in {} quantifier
1382 5 number too big in {} quantifier
1383 6 missing terminating ] for character class
1384 7 invalid escape sequence in character class
1385 8 range out of order in character class
1386 9 nothing to repeat
1387 10 [this code is not in use]
1388 11 internal error: unexpected repeat
1389 12 unrecognized character after (? or (?-
1390 13 POSIX named classes are supported only within a class
1391 14 missing )
1392 15 reference to non-existent subpattern
1393 16 erroffset passed as NULL
1394 17 unknown option bit(s) set
1395 18 missing ) after comment
1396 19 [this code is not in use]
1397 20 regular expression is too large
1398 21 failed to get memory
1399 22 unmatched parentheses
1400 23 internal error: code overflow
1401 24 unrecognized character after (?<
1402 25 lookbehind assertion is not fixed length
1403 26 malformed number or name after (?(
1404 27 conditional group contains more than two branches
1405 28 assertion expected after (?(
1406 29 (?R or (?[+-]digits must be followed by )
1407 30 unknown POSIX class name
1408 31 POSIX collating elements are not supported
1409 32 this version of PCRE is not compiled with PCRE_UTF8 support
1410 33 [this code is not in use]
1411 34 character value in \x{...} sequence is too large
1412 35 invalid condition (?(0)
1413 36 \C not allowed in lookbehind assertion
1414 37 PCRE does not support \L, \l, \N{name}, \U, or \u
1415 38 number after (?C is > 255
1416 39 closing ) for (?C expected
1417 40 recursive call could loop indefinitely
1418 41 unrecognized character after (?P
1419 42 syntax error in subpattern name (missing terminator)
1420 43 two named subpatterns have the same name
1421 44 invalid UTF-8 string
1422 45 support for \P, \p, and \X has not been compiled
1423 46 malformed \P or \p sequence
1424 47 unknown property name after \P or \p
1425 48 subpattern name is too long (maximum 32 characters)
1426 49 too many named subpatterns (maximum 10000)
1427 50 [this code is not in use]
1428 51 octal value is greater than \377 (not in UTF-8 mode)
1429 52 internal error: overran compiling workspace
1430 53 internal error: previously-checked referenced subpattern
1431 not found
1432 54 DEFINE group contains more than one branch
1433 55 repeating a DEFINE group is not allowed
1434 56 inconsistent NEWLINE options
1435 57 \g is not followed by a braced, angle-bracketed, or quoted
1436 name/number or by a plain number
1437 58 a numbered reference must not be zero
1438 59 an argument is not allowed for (*ACCEPT), (*FAIL), or (*COMMIT)
1439 60 (*VERB) not recognized
1440 61 number is too big
1441 62 subpattern name expected
1442 63 digit expected after (?+
1443 64 ] is an invalid data character in JavaScript compatibility mode
1444 65 different names for subpatterns of the same number are
1445 not allowed
1446 66 (*MARK) must have an argument
1447 67 this version of PCRE is not compiled with PCRE_UCP support
1448 68 \c must be followed by an ASCII character
1449 69 \k is not followed by a braced, angle-bracketed, or quoted name
1450
1451 The numbers 32 and 10000 in errors 48 and 49 are defaults; different
1452 values may be used if the limits were changed when PCRE was built.
1453
1454
1455 STUDYING A PATTERN
1456
1457 pcre_extra *pcre_study(const pcre *code, int options
1458 const char **errptr);
1459
1460 If a compiled pattern is going to be used several times, it is worth
1461 spending more time analyzing it in order to speed up the time taken for
1462 matching. The function pcre_study() takes a pointer to a compiled pat-
1463 tern as its first argument. If studying the pattern produces additional
1464 information that will help speed up matching, pcre_study() returns a
1465 pointer to a pcre_extra block, in which the study_data field points to
1466 the results of the study.
1467
1468 The returned value from pcre_study() can be passed directly to
1469 pcre_exec() or pcre_dfa_exec(). However, a pcre_extra block also con-
1470 tains other fields that can be set by the caller before the block is
1471 passed; these are described below in the section on matching a pattern.
1472
1473 If studying the pattern does not produce any useful information,
1474 pcre_study() returns NULL. In that circumstance, if the calling program
1475 wants to pass any of the other fields to pcre_exec() or
1476 pcre_dfa_exec(), it must set up its own pcre_extra block.
1477
1478 The second argument of pcre_study() contains option bits. There is only
1479 one option: PCRE_STUDY_JIT_COMPILE. If this is set, and the just-in-
1480 time compiler is available, the pattern is further compiled into
1481 machine code that executes much faster than the pcre_exec() matching
1482 function. If the just-in-time compiler is not available, this option is
1483 ignored. All other bits in the options argument must be zero.
1484
1485 JIT compilation is a heavyweight optimization. It can take some time
1486 for patterns to be analyzed, and for one-off matches and simple pat-
1487 terns the benefit of faster execution might be offset by a much slower
1488 study time. Not all patterns can be optimized by the JIT compiler. For
1489 those that cannot be handled, matching automatically falls back to the
1490 pcre_exec() interpreter. For more details, see the pcrejit documenta-
1491 tion.
1492
1493 The third argument for pcre_study() is a pointer for an error message.
1494 If studying succeeds (even if no data is returned), the variable it
1495 points to is set to NULL. Otherwise it is set to point to a textual
1496 error message. This is a static string that is part of the library. You
1497 must not try to free it. You should test the error pointer for NULL
1498 after calling pcre_study(), to be sure that it has run successfully.
1499
1500 When you are finished with a pattern, you can free the memory used for
1501 the study data by calling pcre_free_study(). This function was added to
1502 the API for release 8.20. For earlier versions, the memory could be
1503 freed with pcre_free(), just like the pattern itself. This will still
1504 work in cases where PCRE_STUDY_JIT_COMPILE is not used, but it is
1505 advisable to change to the new function when convenient.
1506
1507 This is a typical way in which pcre_study() is used (except that in a
1508 real application there should be tests for errors):
1509
1510 int rc;
1511 pcre *re;
1512 pcre_extra *sd;
1513 re = pcre_compile("pattern", 0, &error, &erroroffset, NULL);
1514 sd = pcre_study(
1515 re, /* result of pcre_compile() */
1516 0, /* no options */
1517 &error); /* set to NULL or points to a message */
1518 rc = pcre_exec( /* see below for details of pcre_exec() options */
1519 re, sd, "subject", 7, 0, 0, ovector, 30);
1520 ...
1521 pcre_free_study(sd);
1522 pcre_free(re);
1523
1524 Studying a pattern does two things: first, a lower bound for the length
1525 of subject string that is needed to match the pattern is computed. This
1526 does not mean that there are any strings of that length that match, but
1527 it does guarantee that no shorter strings match. The value is used by
1528 pcre_exec() and pcre_dfa_exec() to avoid wasting time by trying to
1529 match strings that are shorter than the lower bound. You can find out
1530 the value in a calling program via the pcre_fullinfo() function.
1531
1532 Studying a pattern is also useful for non-anchored patterns that do not
1533 have a single fixed starting character. A bitmap of possible starting
1534 bytes is created. This speeds up finding a position in the subject at
1535 which to start matching.
1536
1537 These two optimizations apply to both pcre_exec() and pcre_dfa_exec().
1538 However, they are not used by pcre_exec() if pcre_study() is called
1539 with the PCRE_STUDY_JIT_COMPILE option, and just-in-time compiling is
1540 successful. The optimizations can be disabled by setting the
1541 PCRE_NO_START_OPTIMIZE option when calling pcre_exec() or
1542 pcre_dfa_exec(). You might want to do this if your pattern contains
1543 callouts or (*MARK) (which cannot be handled by the JIT compiler), and
1544 you want to make use of these facilities in cases where matching fails.
1545 See the discussion of PCRE_NO_START_OPTIMIZE below.
1546
1547
1548 LOCALE SUPPORT
1549
1550 PCRE handles caseless matching, and determines whether characters are
1551 letters, digits, or whatever, by reference to a set of tables, indexed
1552 by character value. When running in UTF-8 mode, this applies only to
1553 characters with codes less than 128. By default, higher-valued codes
1554 never match escapes such as \w or \d, but they can be tested with \p if
1555 PCRE is built with Unicode character property support. Alternatively,
1556 the PCRE_UCP option can be set at compile time; this causes \w and
1557 friends to use Unicode property support instead of built-in tables. The
1558 use of locales with Unicode is discouraged. If you are handling charac-
1559 ters with codes greater than 128, you should either use UTF-8 and Uni-
1560 code, or use locales, but not try to mix the two.
1561
1562 PCRE contains an internal set of tables that are used when the final
1563 argument of pcre_compile() is NULL. These are sufficient for many
1564 applications. Normally, the internal tables recognize only ASCII char-
1565 acters. However, when PCRE is built, it is possible to cause the inter-
1566 nal tables to be rebuilt in the default "C" locale of the local system,
1567 which may cause them to be different.
1568
1569 The internal tables can always be overridden by tables supplied by the
1570 application that calls PCRE. These may be created in a different locale
1571 from the default. As more and more applications change to using Uni-
1572 code, the need for this locale support is expected to die away.
1573
1574 External tables are built by calling the pcre_maketables() function,
1575 which has no arguments, in the relevant locale. The result can then be
1576 passed to pcre_compile() or pcre_exec() as often as necessary. For
1577 example, to build and use tables that are appropriate for the French
1578 locale (where accented characters with values greater than 128 are
1579 treated as letters), the following code could be used:
1580
1581 setlocale(LC_CTYPE, "fr_FR");
1582 tables = pcre_maketables();
1583 re = pcre_compile(..., tables);
1584
1585 The locale name "fr_FR" is used on Linux and other Unix-like systems;
1586 if you are using Windows, the name for the French locale is "french".
1587
1588 When pcre_maketables() runs, the tables are built in memory that is
1589 obtained via pcre_malloc. It is the caller's responsibility to ensure
1590 that the memory containing the tables remains available for as long as
1591 it is needed.
1592
1593 The pointer that is passed to pcre_compile() is saved with the compiled
1594 pattern, and the same tables are used via this pointer by pcre_study()
1595 and normally also by pcre_exec(). Thus, by default, for any single pat-
1596 tern, compilation, studying and matching all happen in the same locale,
1597 but different patterns can be compiled in different locales.
1598
1599 It is possible to pass a table pointer or NULL (indicating the use of
1600 the internal tables) to pcre_exec(). Although not intended for this
1601 purpose, this facility could be used to match a pattern in a different
1602 locale from the one in which it was compiled. Passing table pointers at
1603 run time is discussed below in the section on matching a pattern.
1604
1605
1606 INFORMATION ABOUT A PATTERN
1607
1608 int pcre_fullinfo(const pcre *code, const pcre_extra *extra,
1609 int what, void *where);
1610
1611 The pcre_fullinfo() function returns information about a compiled pat-
1612 tern. It replaces the obsolete pcre_info() function, which is neverthe-
1613 less retained for backwards compability (and is documented below).
1614
1615 The first argument for pcre_fullinfo() is a pointer to the compiled
1616 pattern. The second argument is the result of pcre_study(), or NULL if
1617 the pattern was not studied. The third argument specifies which piece
1618 of information is required, and the fourth argument is a pointer to a
1619 variable to receive the data. The yield of the function is zero for
1620 success, or one of the following negative numbers:
1621
1622 PCRE_ERROR_NULL the argument code was NULL
1623 the argument where was NULL
1624 PCRE_ERROR_BADMAGIC the "magic number" was not found
1625 PCRE_ERROR_BADOPTION the value of what was invalid
1626
1627 The "magic number" is placed at the start of each compiled pattern as
1628 an simple check against passing an arbitrary memory pointer. Here is a
1629 typical call of pcre_fullinfo(), to obtain the length of the compiled
1630 pattern:
1631
1632 int rc;
1633 size_t length;
1634 rc = pcre_fullinfo(
1635 re, /* result of pcre_compile() */
1636 sd, /* result of pcre_study(), or NULL */
1637 PCRE_INFO_SIZE, /* what is required */
1638 &length); /* where to put the data */
1639
1640 The possible values for the third argument are defined in pcre.h, and
1641 are as follows:
1642
1643 PCRE_INFO_BACKREFMAX
1644
1645 Return the number of the highest back reference in the pattern. The
1646 fourth argument should point to an int variable. Zero is returned if
1647 there are no back references.
1648
1649 PCRE_INFO_CAPTURECOUNT
1650
1651 Return the number of capturing subpatterns in the pattern. The fourth
1652 argument should point to an int variable.
1653
1654 PCRE_INFO_DEFAULT_TABLES
1655
1656 Return a pointer to the internal default character tables within PCRE.
1657 The fourth argument should point to an unsigned char * variable. This
1658 information call is provided for internal use by the pcre_study() func-
1659 tion. External callers can cause PCRE to use its internal tables by
1660 passing a NULL table pointer.
1661
1662 PCRE_INFO_FIRSTBYTE
1663
1664 Return information about the first byte of any matched string, for a
1665 non-anchored pattern. The fourth argument should point to an int vari-
1666 able. (This option used to be called PCRE_INFO_FIRSTCHAR; the old name
1667 is still recognized for backwards compatibility.)
1668
1669 If there is a fixed first byte, for example, from a pattern such as
1670 (cat|cow|coyote), its value is returned. Otherwise, if either
1671
1672 (a) the pattern was compiled with the PCRE_MULTILINE option, and every
1673 branch starts with "^", or
1674
1675 (b) every branch of the pattern starts with ".*" and PCRE_DOTALL is not
1676 set (if it were set, the pattern would be anchored),
1677
1678 -1 is returned, indicating that the pattern matches only at the start
1679 of a subject string or after any newline within the string. Otherwise
1680 -2 is returned. For anchored patterns, -2 is returned.
1681
1682 PCRE_INFO_FIRSTTABLE
1683
1684 If the pattern was studied, and this resulted in the construction of a
1685 256-bit table indicating a fixed set of bytes for the first byte in any
1686 matching string, a pointer to the table is returned. Otherwise NULL is
1687 returned. The fourth argument should point to an unsigned char * vari-
1688 able.
1689
1690 PCRE_INFO_HASCRORLF
1691
1692 Return 1 if the pattern contains any explicit matches for CR or LF
1693 characters, otherwise 0. The fourth argument should point to an int
1694 variable. An explicit match is either a literal CR or LF character, or
1695 \r or \n.
1696
1697 PCRE_INFO_JCHANGED
1698
1699 Return 1 if the (?J) or (?-J) option setting is used in the pattern,
1700 otherwise 0. The fourth argument should point to an int variable. (?J)
1701 and (?-J) set and unset the local PCRE_DUPNAMES option, respectively.
1702
1703 PCRE_INFO_JIT
1704
1705 Return 1 if the pattern was studied with the PCRE_STUDY_JIT_COMPILE
1706 option, and just-in-time compiling was successful. The fourth argument
1707 should point to an int variable. A return value of 0 means that JIT
1708 support is not available in this version of PCRE, or that the pattern
1709 was not studied with the PCRE_STUDY_JIT_COMPILE option, or that the JIT
1710 compiler could not handle this particular pattern. See the pcrejit doc-
1711 umentation for details of what can and cannot be handled.
1712
1713 PCRE_INFO_LASTLITERAL
1714
1715 Return the value of the rightmost literal byte that must exist in any
1716 matched string, other than at its start, if such a byte has been
1717 recorded. The fourth argument should point to an int variable. If there
1718 is no such byte, -1 is returned. For anchored patterns, a last literal
1719 byte is recorded only if it follows something of variable length. For
1720 example, for the pattern /^a\d+z\d+/ the returned value is "z", but for
1721 /^a\dz\d/ the returned value is -1.
1722
1723 PCRE_INFO_MINLENGTH
1724
1725 If the pattern was studied and a minimum length for matching subject
1726 strings was computed, its value is returned. Otherwise the returned
1727 value is -1. The value is a number of characters, not bytes (this may
1728 be relevant in UTF-8 mode). The fourth argument should point to an int
1729 variable. A non-negative value is a lower bound to the length of any
1730 matching string. There may not be any strings of that length that do
1731 actually match, but every string that does match is at least that long.
1732
1733 PCRE_INFO_NAMECOUNT
1734 PCRE_INFO_NAMEENTRYSIZE
1735 PCRE_INFO_NAMETABLE
1736
1737 PCRE supports the use of named as well as numbered capturing parenthe-
1738 ses. The names are just an additional way of identifying the parenthe-
1739 ses, which still acquire numbers. Several convenience functions such as
1740 pcre_get_named_substring() are provided for extracting captured sub-
1741 strings by name. It is also possible to extract the data directly, by
1742 first converting the name to a number in order to access the correct
1743 pointers in the output vector (described with pcre_exec() below). To do
1744 the conversion, you need to use the name-to-number map, which is
1745 described by these three values.
1746
1747 The map consists of a number of fixed-size entries. PCRE_INFO_NAMECOUNT
1748 gives the number of entries, and PCRE_INFO_NAMEENTRYSIZE gives the size
1749 of each entry; both of these return an int value. The entry size
1750 depends on the length of the longest name. PCRE_INFO_NAMETABLE returns
1751 a pointer to the first entry of the table (a pointer to char). The
1752 first two bytes of each entry are the number of the capturing parenthe-
1753 sis, most significant byte first. The rest of the entry is the corre-
1754 sponding name, zero terminated.
1755
1756 The names are in alphabetical order. Duplicate names may appear if (?|
1757 is used to create multiple groups with the same number, as described in
1758 the section on duplicate subpattern numbers in the pcrepattern page.
1759 Duplicate names for subpatterns with different numbers are permitted
1760 only if PCRE_DUPNAMES is set. In all cases of duplicate names, they
1761 appear in the table in the order in which they were found in the pat-
1762 tern. In the absence of (?| this is the order of increasing number;
1763 when (?| is used this is not necessarily the case because later subpat-
1764 terns may have lower numbers.
1765
1766 As a simple example of the name/number table, consider the following
1767 pattern (assume PCRE_EXTENDED is set, so white space - including new-
1768 lines - is ignored):
1769
1770 (?<date> (?<year>(\d\d)?\d\d) -
1771 (?<month>\d\d) - (?<day>\d\d) )
1772
1773 There are four named subpatterns, so the table has four entries, and
1774 each entry in the table is eight bytes long. The table is as follows,
1775 with non-printing bytes shows in hexadecimal, and undefined bytes shown
1776 as ??:
1777
1778 00 01 d a t e 00 ??
1779 00 05 d a y 00 ?? ??
1780 00 04 m o n t h 00
1781 00 02 y e a r 00 ??
1782
1783 When writing code to extract data from named subpatterns using the
1784 name-to-number map, remember that the length of the entries is likely
1785 to be different for each compiled pattern.
1786
1787 PCRE_INFO_OKPARTIAL
1788
1789 Return 1 if the pattern can be used for partial matching with
1790 pcre_exec(), otherwise 0. The fourth argument should point to an int
1791 variable. From release 8.00, this always returns 1, because the
1792 restrictions that previously applied to partial matching have been
1793 lifted. The pcrepartial documentation gives details of partial match-
1794 ing.
1795
1796 PCRE_INFO_OPTIONS
1797
1798 Return a copy of the options with which the pattern was compiled. The
1799 fourth argument should point to an unsigned long int variable. These
1800 option bits are those specified in the call to pcre_compile(), modified
1801 by any top-level option settings at the start of the pattern itself. In
1802 other words, they are the options that will be in force when matching
1803 starts. For example, if the pattern /(?im)abc(?-i)d/ is compiled with
1804 the PCRE_EXTENDED option, the result is PCRE_CASELESS, PCRE_MULTILINE,
1805 and PCRE_EXTENDED.
1806
1807 A pattern is automatically anchored by PCRE if all of its top-level
1808 alternatives begin with one of the following:
1809
1810 ^ unless PCRE_MULTILINE is set
1811 \A always
1812 \G always
1813 .* if PCRE_DOTALL is set and there are no back
1814 references to the subpattern in which .* appears
1815
1816 For such patterns, the PCRE_ANCHORED bit is set in the options returned
1817 by pcre_fullinfo().
1818
1819 PCRE_INFO_SIZE
1820
1821 Return the size of the compiled pattern, that is, the value that was
1822 passed as the argument to pcre_malloc() when PCRE was getting memory in
1823 which to place the compiled data. The fourth argument should point to a
1824 size_t variable.
1825
1826 PCRE_INFO_STUDYSIZE
1827
1828 Return the size of the data block pointed to by the study_data field in
1829 a pcre_extra block. If pcre_extra is NULL, or there is no study data,
1830 zero is returned. The fourth argument should point to a size_t vari-
1831 able. The study_data field is set by pcre_study() to record informa-
1832 tion that will speed up matching (see the section entitled "Studying a
1833 pattern" above). The format of the study_data block is private, but its
1834 length is made available via this option so that it can be saved and
1835 restored (see the pcreprecompile documentation for details).
1836
1837
1838 OBSOLETE INFO FUNCTION
1839
1840 int pcre_info(const pcre *code, int *optptr, int *firstcharptr);
1841
1842 The pcre_info() function is now obsolete because its interface is too
1843 restrictive to return all the available data about a compiled pattern.
1844 New programs should use pcre_fullinfo() instead. The yield of
1845 pcre_info() is the number of capturing subpatterns, or one of the fol-
1846 lowing negative numbers:
1847
1848 PCRE_ERROR_NULL the argument code was NULL
1849 PCRE_ERROR_BADMAGIC the "magic number" was not found
1850
1851 If the optptr argument is not NULL, a copy of the options with which
1852 the pattern was compiled is placed in the integer it points to (see
1853 PCRE_INFO_OPTIONS above).
1854
1855 If the pattern is not anchored and the firstcharptr argument is not
1856 NULL, it is used to pass back information about the first character of
1857 any matched string (see PCRE_INFO_FIRSTBYTE above).
1858
1859
1860 REFERENCE COUNTS
1861
1862 int pcre_refcount(pcre *code, int adjust);
1863
1864 The pcre_refcount() function is used to maintain a reference count in
1865 the data block that contains a compiled pattern. It is provided for the
1866 benefit of applications that operate in an object-oriented manner,
1867 where different parts of the application may be using the same compiled
1868 pattern, but you want to free the block when they are all done.
1869
1870 When a pattern is compiled, the reference count field is initialized to
1871 zero. It is changed only by calling this function, whose action is to
1872 add the adjust value (which may be positive or negative) to it. The
1873 yield of the function is the new value. However, the value of the count
1874 is constrained to lie between 0 and 65535, inclusive. If the new value
1875 is outside these limits, it is forced to the appropriate limit value.
1876
1877 Except when it is zero, the reference count is not correctly preserved
1878 if a pattern is compiled on one host and then transferred to a host
1879 whose byte-order is different. (This seems a highly unlikely scenario.)
1880
1881
1882 MATCHING A PATTERN: THE TRADITIONAL FUNCTION
1883
1884 int pcre_exec(const pcre *code, const pcre_extra *extra,
1885 const char *subject, int length, int startoffset,
1886 int options, int *ovector, int ovecsize);
1887
1888 The function pcre_exec() is called to match a subject string against a
1889 compiled pattern, which is passed in the code argument. If the pattern
1890 was studied, the result of the study should be passed in the extra
1891 argument. This function is the main matching facility of the library,
1892 and it operates in a Perl-like manner. For specialist use there is also
1893 an alternative matching function, which is described below in the sec-
1894 tion about the pcre_dfa_exec() function.
1895
1896 In most applications, the pattern will have been compiled (and option-
1897 ally studied) in the same process that calls pcre_exec(). However, it
1898 is possible to save compiled patterns and study data, and then use them
1899 later in different processes, possibly even on different hosts. For a
1900 discussion about this, see the pcreprecompile documentation.
1901
1902 Here is an example of a simple call to pcre_exec():
1903
1904 int rc;
1905 int ovector[30];
1906 rc = pcre_exec(
1907 re, /* result of pcre_compile() */
1908 NULL, /* we didn't study the pattern */
1909 "some string", /* the subject string */
1910 11, /* the length of the subject string */
1911 0, /* start at offset 0 in the subject */
1912 0, /* default options */
1913 ovector, /* vector of integers for substring information */
1914 30); /* number of elements (NOT size in bytes) */
1915
1916 Extra data for pcre_exec()
1917
1918 If the extra argument is not NULL, it must point to a pcre_extra data
1919 block. The pcre_study() function returns such a block (when it doesn't
1920 return NULL), but you can also create one for yourself, and pass addi-
1921 tional information in it. The pcre_extra block contains the following
1922 fields (not necessarily in this order):
1923
1924 unsigned long int flags;
1925 void *study_data;
1926 void *executable_jit;
1927 unsigned long int match_limit;
1928 unsigned long int match_limit_recursion;
1929 void *callout_data;
1930 const unsigned char *tables;
1931 unsigned char **mark;
1932
1933 The flags field is a bitmap that specifies which of the other fields
1934 are set. The flag bits are:
1935
1936 PCRE_EXTRA_STUDY_DATA
1937 PCRE_EXTRA_EXECUTABLE_JIT
1938 PCRE_EXTRA_MATCH_LIMIT
1939 PCRE_EXTRA_MATCH_LIMIT_RECURSION
1940 PCRE_EXTRA_CALLOUT_DATA
1941 PCRE_EXTRA_TABLES
1942 PCRE_EXTRA_MARK
1943
1944 Other flag bits should be set to zero. The study_data field and some-
1945 times the executable_jit field are set in the pcre_extra block that is
1946 returned by pcre_study(), together with the appropriate flag bits. You
1947 should not set these yourself, but you may add to the block by setting
1948 the other fields and their corresponding flag bits.
1949
1950 The match_limit field provides a means of preventing PCRE from using up
1951 a vast amount of resources when running patterns that are not going to
1952 match, but which have a very large number of possibilities in their
1953 search trees. The classic example is a pattern that uses nested unlim-
1954 ited repeats.
1955
1956 Internally, pcre_exec() uses a function called match(), which it calls
1957 repeatedly (sometimes recursively). The limit set by match_limit is
1958 imposed on the number of times this function is called during a match,
1959 which has the effect of limiting the amount of backtracking that can
1960 take place. For patterns that are not anchored, the count restarts from
1961 zero for each position in the subject string.
1962
1963 When pcre_exec() is called with a pattern that was successfully studied
1964 with the PCRE_STUDY_JIT_COMPILE option, the way that the matching is
1965 executed is entirely different. However, there is still the possibility
1966 of runaway matching that goes on for a very long time, and so the
1967 match_limit value is also used in this case (but in a different way) to
1968 limit how long the matching can continue.
1969
1970 The default value for the limit can be set when PCRE is built; the
1971 default default is 10 million, which handles all but the most extreme
1972 cases. You can override the default by suppling pcre_exec() with a
1973 pcre_extra block in which match_limit is set, and
1974 PCRE_EXTRA_MATCH_LIMIT is set in the flags field. If the limit is
1975 exceeded, pcre_exec() returns PCRE_ERROR_MATCHLIMIT.
1976
1977 The match_limit_recursion field is similar to match_limit, but instead
1978 of limiting the total number of times that match() is called, it limits
1979 the depth of recursion. The recursion depth is a smaller number than
1980 the total number of calls, because not all calls to match() are recur-
1981 sive. This limit is of use only if it is set smaller than match_limit.
1982
1983 Limiting the recursion depth limits the amount of machine stack that
1984 can be used, or, when PCRE has been compiled to use memory on the heap
1985 instead of the stack, the amount of heap memory that can be used. This
1986 limit is not relevant, and is ignored, if the pattern was successfully
1987 studied with PCRE_STUDY_JIT_COMPILE.
1988
1989 The default value for match_limit_recursion can be set when PCRE is
1990 built; the default default is the same value as the default for
1991 match_limit. You can override the default by suppling pcre_exec() with
1992 a pcre_extra block in which match_limit_recursion is set, and
1993 PCRE_EXTRA_MATCH_LIMIT_RECURSION is set in the flags field. If the
1994 limit is exceeded, pcre_exec() returns PCRE_ERROR_RECURSIONLIMIT.
1995
1996 The callout_data field is used in conjunction with the "callout" fea-
1997 ture, and is described in the pcrecallout documentation.
1998
1999 The tables field is used to pass a character tables pointer to
2000 pcre_exec(); this overrides the value that is stored with the compiled
2001 pattern. A non-NULL value is stored with the compiled pattern only if
2002 custom tables were supplied to pcre_compile() via its tableptr argu-
2003 ment. If NULL is passed to pcre_exec() using this mechanism, it forces
2004 PCRE's internal tables to be used. This facility is helpful when re-
2005 using patterns that have been saved after compiling with an external
2006 set of tables, because the external tables might be at a different
2007 address when pcre_exec() is called. See the pcreprecompile documenta-
2008 tion for a discussion of saving compiled patterns for later use.
2009
2010 If PCRE_EXTRA_MARK is set in the flags field, the mark field must be
2011 set to point to a char * variable. If the pattern contains any back-
2012 tracking control verbs such as (*MARK:NAME), and the execution ends up
2013 with a name to pass back, a pointer to the name string (zero termi-
2014 nated) is placed in the variable pointed to by the mark field. The
2015 names are within the compiled pattern; if you wish to retain such a
2016 name you must copy it before freeing the memory of a compiled pattern.
2017 If there is no name to pass back, the variable pointed to by the mark
2018 field set to NULL. For details of the backtracking control verbs, see
2019 the section entitled "Backtracking control" in the pcrepattern documen-
2020 tation.
2021
2022 Option bits for pcre_exec()
2023
2024 The unused bits of the options argument for pcre_exec() must be zero.
2025 The only bits that may be set are PCRE_ANCHORED, PCRE_NEWLINE_xxx,
2026 PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NOTEMPTY_ATSTART,
2027 PCRE_NO_START_OPTIMIZE, PCRE_NO_UTF8_CHECK, PCRE_PARTIAL_SOFT, and
2028 PCRE_PARTIAL_HARD.
2029
2030 If the pattern was successfully studied with the PCRE_STUDY_JIT_COMPILE
2031 option, the only supported options for JIT execution are
2032 PCRE_NO_UTF8_CHECK, PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, and
2033 PCRE_NOTEMPTY_ATSTART. Note in particular that partial matching is not
2034 supported. If an unsupported option is used, JIT execution is disabled
2035 and the normal interpretive code in pcre_exec() is run.
2036
2037 PCRE_ANCHORED
2038
2039 The PCRE_ANCHORED option limits pcre_exec() to matching at the first
2040 matching position. If a pattern was compiled with PCRE_ANCHORED, or
2041 turned out to be anchored by virtue of its contents, it cannot be made
2042 unachored at matching time.
2043
2044 PCRE_BSR_ANYCRLF
2045 PCRE_BSR_UNICODE
2046
2047 These options (which are mutually exclusive) control what the \R escape
2048 sequence matches. The choice is either to match only CR, LF, or CRLF,
2049 or to match any Unicode newline sequence. These options override the
2050 choice that was made or defaulted when the pattern was compiled.
2051
2052 PCRE_NEWLINE_CR
2053 PCRE_NEWLINE_LF
2054 PCRE_NEWLINE_CRLF
2055 PCRE_NEWLINE_ANYCRLF
2056 PCRE_NEWLINE_ANY
2057
2058 These options override the newline definition that was chosen or
2059 defaulted when the pattern was compiled. For details, see the descrip-
2060 tion of pcre_compile() above. During matching, the newline choice
2061 affects the behaviour of the dot, circumflex, and dollar metacharac-
2062 ters. It may also alter the way the match position is advanced after a
2063 match failure for an unanchored pattern.
2064
2065 When PCRE_NEWLINE_CRLF, PCRE_NEWLINE_ANYCRLF, or PCRE_NEWLINE_ANY is
2066 set, and a match attempt for an unanchored pattern fails when the cur-
2067 rent position is at a CRLF sequence, and the pattern contains no
2068 explicit matches for CR or LF characters, the match position is
2069 advanced by two characters instead of one, in other words, to after the
2070 CRLF.
2071
2072 The above rule is a compromise that makes the most common cases work as
2073 expected. For example, if the pattern is .+A (and the PCRE_DOTALL
2074 option is not set), it does not match the string "\r\nA" because, after
2075 failing at the start, it skips both the CR and the LF before retrying.
2076 However, the pattern [\r\n]A does match that string, because it con-
2077 tains an explicit CR or LF reference, and so advances only by one char-
2078 acter after the first failure.
2079
2080 An explicit match for CR of LF is either a literal appearance of one of
2081 those characters, or one of the \r or \n escape sequences. Implicit
2082 matches such as [^X] do not count, nor does \s (which includes CR and
2083 LF in the characters that it matches).
2084
2085 Notwithstanding the above, anomalous effects may still occur when CRLF
2086 is a valid newline sequence and explicit \r or \n escapes appear in the
2087 pattern.
2088
2089 PCRE_NOTBOL
2090
2091 This option specifies that first character of the subject string is not
2092 the beginning of a line, so the circumflex metacharacter should not
2093 match before it. Setting this without PCRE_MULTILINE (at compile time)
2094 causes circumflex never to match. This option affects only the behav-
2095 iour of the circumflex metacharacter. It does not affect \A.
2096
2097 PCRE_NOTEOL
2098
2099 This option specifies that the end of the subject string is not the end
2100 of a line, so the dollar metacharacter should not match it nor (except
2101 in multiline mode) a newline immediately before it. Setting this with-
2102 out PCRE_MULTILINE (at compile time) causes dollar never to match. This
2103 option affects only the behaviour of the dollar metacharacter. It does
2104 not affect \Z or \z.
2105
2106 PCRE_NOTEMPTY
2107
2108 An empty string is not considered to be a valid match if this option is
2109 set. If there are alternatives in the pattern, they are tried. If all
2110 the alternatives match the empty string, the entire match fails. For
2111 example, if the pattern
2112
2113 a?b?
2114
2115 is applied to a string not beginning with "a" or "b", it matches an
2116 empty string at the start of the subject. With PCRE_NOTEMPTY set, this
2117 match is not valid, so PCRE searches further into the string for occur-
2118 rences of "a" or "b".
2119
2120 PCRE_NOTEMPTY_ATSTART
2121
2122 This is like PCRE_NOTEMPTY, except that an empty string match that is
2123 not at the start of the subject is permitted. If the pattern is
2124 anchored, such a match can occur only if the pattern contains \K.
2125
2126 Perl has no direct equivalent of PCRE_NOTEMPTY or
2127 PCRE_NOTEMPTY_ATSTART, but it does make a special case of a pattern
2128 match of the empty string within its split() function, and when using
2129 the /g modifier. It is possible to emulate Perl's behaviour after
2130 matching a null string by first trying the match again at the same off-
2131 set with PCRE_NOTEMPTY_ATSTART and PCRE_ANCHORED, and then if that
2132 fails, by advancing the starting offset (see below) and trying an ordi-
2133 nary match again. There is some code that demonstrates how to do this
2134 in the pcredemo sample program. In the most general case, you have to
2135 check to see if the newline convention recognizes CRLF as a newline,
2136 and if so, and the current character is CR followed by LF, advance the
2137 starting offset by two characters instead of one.
2138
2139 PCRE_NO_START_OPTIMIZE
2140
2141 There are a number of optimizations that pcre_exec() uses at the start
2142 of a match, in order to speed up the process. For example, if it is
2143 known that an unanchored match must start with a specific character, it
2144 searches the subject for that character, and fails immediately if it
2145 cannot find it, without actually running the main matching function.
2146 This means that a special item such as (*COMMIT) at the start of a pat-
2147 tern is not considered until after a suitable starting point for the
2148 match has been found. When callouts or (*MARK) items are in use, these
2149 "start-up" optimizations can cause them to be skipped if the pattern is
2150 never actually used. The start-up optimizations are in effect a pre-
2151 scan of the subject that takes place before the pattern is run.
2152
2153 The PCRE_NO_START_OPTIMIZE option disables the start-up optimizations,
2154 possibly causing performance to suffer, but ensuring that in cases
2155 where the result is "no match", the callouts do occur, and that items
2156 such as (*COMMIT) and (*MARK) are considered at every possible starting
2157 position in the subject string. If PCRE_NO_START_OPTIMIZE is set at
2158 compile time, it cannot be unset at matching time.
2159
2160 Setting PCRE_NO_START_OPTIMIZE can change the outcome of a matching
2161 operation. Consider the pattern
2162
2163 (*COMMIT)ABC
2164
2165 When this is compiled, PCRE records the fact that a match must start
2166 with the character "A". Suppose the subject string is "DEFABC". The
2167 start-up optimization scans along the subject, finds "A" and runs the
2168 first match attempt from there. The (*COMMIT) item means that the pat-
2169 tern must match the current starting position, which in this case, it
2170 does. However, if the same match is run with PCRE_NO_START_OPTIMIZE
2171 set, the initial scan along the subject string does not happen. The
2172 first match attempt is run starting from "D" and when this fails,
2173 (*COMMIT) prevents any further matches being tried, so the overall
2174 result is "no match". If the pattern is studied, more start-up opti-
2175 mizations may be used. For example, a minimum length for the subject
2176 may be recorded. Consider the pattern
2177
2178 (*MARK:A)(X|Y)
2179
2180 The minimum length for a match is one character. If the subject is
2181 "ABC", there will be attempts to match "ABC", "BC", "C", and then
2182 finally an empty string. If the pattern is studied, the final attempt
2183 does not take place, because PCRE knows that the subject is too short,
2184 and so the (*MARK) is never encountered. In this case, studying the
2185 pattern does not affect the overall match result, which is still "no
2186 match", but it does affect the auxiliary information that is returned.
2187
2188 PCRE_NO_UTF8_CHECK
2189
2190 When PCRE_UTF8 is set at compile time, the validity of the subject as a
2191 UTF-8 string is automatically checked when pcre_exec() is subsequently
2192 called. The value of startoffset is also checked to ensure that it
2193 points to the start of a UTF-8 character. There is a discussion about
2194 the validity of UTF-8 strings in the section on UTF-8 support in the
2195 main pcre page. If an invalid UTF-8 sequence of bytes is found,
2196 pcre_exec() returns the error PCRE_ERROR_BADUTF8 or, if PCRE_PAR-
2197 TIAL_HARD is set and the problem is a truncated UTF-8 character at the
2198 end of the subject, PCRE_ERROR_SHORTUTF8. In both cases, information
2199 about the precise nature of the error may also be returned (see the
2200 descriptions of these errors in the section entitled Error return val-
2201 ues from pcre_exec() below). If startoffset contains a value that does
2202 not point to the start of a UTF-8 character (or to the end of the sub-
2203 ject), PCRE_ERROR_BADUTF8_OFFSET is returned.
2204
2205 If you already know that your subject is valid, and you want to skip
2206 these checks for performance reasons, you can set the
2207 PCRE_NO_UTF8_CHECK option when calling pcre_exec(). You might want to
2208 do this for the second and subsequent calls to pcre_exec() if you are
2209 making repeated calls to find all the matches in a single subject
2210 string. However, you should be sure that the value of startoffset
2211 points to the start of a UTF-8 character (or the end of the subject).
2212 When PCRE_NO_UTF8_CHECK is set, the effect of passing an invalid UTF-8
2213 string as a subject or an invalid value of startoffset is undefined.
2214 Your program may crash.
2215
2216 PCRE_PARTIAL_HARD
2217 PCRE_PARTIAL_SOFT
2218
2219 These options turn on the partial matching feature. For backwards com-
2220 patibility, PCRE_PARTIAL is a synonym for PCRE_PARTIAL_SOFT. A partial
2221 match occurs if the end of the subject string is reached successfully,
2222 but there are not enough subject characters to complete the match. If
2223 this happens when PCRE_PARTIAL_SOFT (but not PCRE_PARTIAL_HARD) is set,
2224 matching continues by testing any remaining alternatives. Only if no
2225 complete match can be found is PCRE_ERROR_PARTIAL returned instead of
2226 PCRE_ERROR_NOMATCH. In other words, PCRE_PARTIAL_SOFT says that the
2227 caller is prepared to handle a partial match, but only if no complete
2228 match can be found.
2229
2230 If PCRE_PARTIAL_HARD is set, it overrides PCRE_PARTIAL_SOFT. In this
2231 case, if a partial match is found, pcre_exec() immediately returns
2232 PCRE_ERROR_PARTIAL, without considering any other alternatives. In
2233 other words, when PCRE_PARTIAL_HARD is set, a partial match is consid-
2234 ered to be more important that an alternative complete match.
2235
2236 In both cases, the portion of the string that was inspected when the
2237 partial match was found is set as the first matching string. There is a
2238 more detailed discussion of partial and multi-segment matching, with
2239 examples, in the pcrepartial documentation.
2240
2241 The string to be matched by pcre_exec()
2242
2243 The subject string is passed to pcre_exec() as a pointer in subject, a
2244 length (in bytes) in length, and a starting byte offset in startoffset.
2245 If this is negative or greater than the length of the subject,
2246 pcre_exec() returns PCRE_ERROR_BADOFFSET. When the starting offset is
2247 zero, the search for a match starts at the beginning of the subject,
2248 and this is by far the most common case. In UTF-8 mode, the byte offset
2249 must point to the start of a UTF-8 character (or the end of the sub-
2250 ject). Unlike the pattern string, the subject may contain binary zero
2251 bytes.
2252
2253 A non-zero starting offset is useful when searching for another match
2254 in the same subject by calling pcre_exec() again after a previous suc-
2255 cess. Setting startoffset differs from just passing over a shortened
2256 string and setting PCRE_NOTBOL in the case of a pattern that begins
2257 with any kind of lookbehind. For example, consider the pattern
2258
2259 \Biss\B
2260
2261 which finds occurrences of "iss" in the middle of words. (\B matches
2262 only if the current position in the subject is not a word boundary.)
2263 When applied to the string "Mississipi" the first call to pcre_exec()
2264 finds the first occurrence. If pcre_exec() is called again with just
2265 the remainder of the subject, namely "issipi", it does not match,
2266 because \B is always false at the start of the subject, which is deemed
2267 to be a word boundary. However, if pcre_exec() is passed the entire
2268 string again, but with startoffset set to 4, it finds the second occur-
2269 rence of "iss" because it is able to look behind the starting point to
2270 discover that it is preceded by a letter.
2271
2272 Finding all the matches in a subject is tricky when the pattern can
2273 match an empty string. It is possible to emulate Perl's /g behaviour by
2274 first trying the match again at the same offset, with the
2275 PCRE_NOTEMPTY_ATSTART and PCRE_ANCHORED options, and then if that
2276 fails, advancing the starting offset and trying an ordinary match
2277 again. There is some code that demonstrates how to do this in the pcre-
2278 demo sample program. In the most general case, you have to check to see
2279 if the newline convention recognizes CRLF as a newline, and if so, and
2280 the current character is CR followed by LF, advance the starting offset
2281 by two characters instead of one.
2282
2283 If a non-zero starting offset is passed when the pattern is anchored,
2284 one attempt to match at the given offset is made. This can only succeed
2285 if the pattern does not require the match to be at the start of the
2286 subject.
2287
2288 How pcre_exec() returns captured substrings
2289
2290 In general, a pattern matches a certain portion of the subject, and in
2291 addition, further substrings from the subject may be picked out by
2292 parts of the pattern. Following the usage in Jeffrey Friedl's book,
2293 this is called "capturing" in what follows, and the phrase "capturing
2294 subpattern" is used for a fragment of a pattern that picks out a sub-
2295 string. PCRE supports several other kinds of parenthesized subpattern
2296 that do not cause substrings to be captured.
2297
2298 Captured substrings are returned to the caller via a vector of integers
2299 whose address is passed in ovector. The number of elements in the vec-
2300 tor is passed in ovecsize, which must be a non-negative number. Note:
2301 this argument is NOT the size of ovector in bytes.
2302
2303 The first two-thirds of the vector is used to pass back captured sub-
2304 strings, each substring using a pair of integers. The remaining third
2305 of the vector is used as workspace by pcre_exec() while matching cap-
2306 turing subpatterns, and is not available for passing back information.
2307 The number passed in ovecsize should always be a multiple of three. If
2308 it is not, it is rounded down.
2309
2310 When a match is successful, information about captured substrings is
2311 returned in pairs of integers, starting at the beginning of ovector,
2312 and continuing up to two-thirds of its length at the most. The first
2313 element of each pair is set to the byte offset of the first character
2314 in a substring, and the second is set to the byte offset of the first
2315 character after the end of a substring. Note: these values are always
2316 byte offsets, even in UTF-8 mode. They are not character counts.
2317
2318 The first pair of integers, ovector[0] and ovector[1], identify the
2319 portion of the subject string matched by the entire pattern. The next
2320 pair is used for the first capturing subpattern, and so on. The value
2321 returned by pcre_exec() is one more than the highest numbered pair that
2322 has been set. For example, if two substrings have been captured, the
2323 returned value is 3. If there are no capturing subpatterns, the return
2324 value from a successful match is 1, indicating that just the first pair
2325 of offsets has been set.
2326
2327 If a capturing subpattern is matched repeatedly, it is the last portion
2328 of the string that it matched that is returned.
2329
2330 If the vector is too small to hold all the captured substring offsets,
2331 it is used as far as possible (up to two-thirds of its length), and the
2332 function returns a value of zero. If neither the actual string matched
2333 not any captured substrings are of interest, pcre_exec() may be called
2334 with ovector passed as NULL and ovecsize as zero. However, if the pat-
2335 tern contains back references and the ovector is not big enough to
2336 remember the related substrings, PCRE has to get additional memory for
2337 use during matching. Thus it is usually advisable to supply an ovector
2338 of reasonable size.
2339
2340 There are some cases where zero is returned (indicating vector over-
2341 flow) when in fact the vector is exactly the right size for the final
2342 match. For example, consider the pattern
2343
2344 (a)(?:(b)c|bd)
2345
2346 If a vector of 6 elements (allowing for only 1 captured substring) is
2347 given with subject string "abd", pcre_exec() will try to set the second
2348 captured string, thereby recording a vector overflow, before failing to
2349 match "c" and backing up to try the second alternative. The zero
2350 return, however, does correctly indicate that the maximum number of
2351 slots (namely 2) have been filled. In similar cases where there is tem-
2352 porary overflow, but the final number of used slots is actually less
2353 than the maximum, a non-zero value is returned.
2354
2355 The pcre_fullinfo() function can be used to find out how many capturing
2356 subpatterns there are in a compiled pattern. The smallest size for
2357 ovector that will allow for n captured substrings, in addition to the
2358 offsets of the substring matched by the whole pattern, is (n+1)*3.
2359
2360 It is possible for capturing subpattern number n+1 to match some part
2361 of the subject when subpattern n has not been used at all. For example,
2362 if the string "abc" is matched against the pattern (a|(z))(bc) the
2363 return from the function is 4, and subpatterns 1 and 3 are matched, but
2364 2 is not. When this happens, both values in the offset pairs corre-
2365 sponding to unused subpatterns are set to -1.
2366
2367 Offset values that correspond to unused subpatterns at the end of the
2368 expression are also set to -1. For example, if the string "abc" is
2369 matched against the pattern (abc)(x(yz)?)? subpatterns 2 and 3 are not
2370 matched. The return from the function is 2, because the highest used
2371 capturing subpattern number is 1, and the offsets for for the second
2372 and third capturing subpatterns (assuming the vector is large enough,
2373 of course) are set to -1.
2374
2375 Note: Elements in the first two-thirds of ovector that do not corre-
2376 spond to capturing parentheses in the pattern are never changed. That
2377 is, if a pattern contains n capturing parentheses, no more than ovec-
2378 tor[0] to ovector[2n+1] are set by pcre_exec(). The other elements (in
2379 the first two-thirds) retain whatever values they previously had.
2380
2381 Some convenience functions are provided for extracting the captured
2382 substrings as separate strings. These are described below.
2383
2384 Error return values from pcre_exec()
2385
2386 If pcre_exec() fails, it returns a negative number. The following are
2387 defined in the header file:
2388
2389 PCRE_ERROR_NOMATCH (-1)
2390
2391 The subject string did not match the pattern.
2392
2393 PCRE_ERROR_NULL (-2)
2394
2395 Either code or subject was passed as NULL, or ovector was NULL and
2396 ovecsize was not zero.
2397
2398 PCRE_ERROR_BADOPTION (-3)
2399
2400 An unrecognized bit was set in the options argument.
2401
2402 PCRE_ERROR_BADMAGIC (-4)
2403
2404 PCRE stores a 4-byte "magic number" at the start of the compiled code,
2405 to catch the case when it is passed a junk pointer and to detect when a
2406 pattern that was compiled in an environment of one endianness is run in
2407 an environment with the other endianness. This is the error that PCRE
2408 gives when the magic number is not present.
2409
2410 PCRE_ERROR_UNKNOWN_OPCODE (-5)
2411
2412 While running the pattern match, an unknown item was encountered in the
2413 compiled pattern. This error could be caused by a bug in PCRE or by
2414 overwriting of the compiled pattern.
2415
2416 PCRE_ERROR_NOMEMORY (-6)
2417
2418 If a pattern contains back references, but the ovector that is passed
2419 to pcre_exec() is not big enough to remember the referenced substrings,
2420 PCRE gets a block of memory at the start of matching to use for this
2421 purpose. If the call via pcre_malloc() fails, this error is given. The
2422 memory is automatically freed at the end of matching.
2423
2424 This error is also given if pcre_stack_malloc() fails in pcre_exec().
2425 This can happen only when PCRE has been compiled with --disable-stack-
2426 for-recursion.
2427
2428 PCRE_ERROR_NOSUBSTRING (-7)
2429
2430 This error is used by the pcre_copy_substring(), pcre_get_substring(),
2431 and pcre_get_substring_list() functions (see below). It is never
2432 returned by pcre_exec().
2433
2434 PCRE_ERROR_MATCHLIMIT (-8)
2435
2436 The backtracking limit, as specified by the match_limit field in a
2437 pcre_extra structure (or defaulted) was reached. See the description
2438 above.
2439
2440 PCRE_ERROR_CALLOUT (-9)
2441
2442 This error is never generated by pcre_exec() itself. It is provided for
2443 use by callout functions that want to yield a distinctive error code.
2444 See the pcrecallout documentation for details.
2445
2446 PCRE_ERROR_BADUTF8 (-10)
2447
2448 A string that contains an invalid UTF-8 byte sequence was passed as a
2449 subject, and the PCRE_NO_UTF8_CHECK option was not set. If the size of
2450 the output vector (ovecsize) is at least 2, the byte offset to the
2451 start of the the invalid UTF-8 character is placed in the first ele-
2452 ment, and a reason code is placed in the second element. The reason
2453 codes are listed in the following section. For backward compatibility,
2454 if PCRE_PARTIAL_HARD is set and the problem is a truncated UTF-8 char-
2455 acter at the end of the subject (reason codes 1 to 5),
2456 PCRE_ERROR_SHORTUTF8 is returned instead of PCRE_ERROR_BADUTF8.
2457
2458 PCRE_ERROR_BADUTF8_OFFSET (-11)
2459
2460 The UTF-8 byte sequence that was passed as a subject was checked and
2461 found to be valid (the PCRE_NO_UTF8_CHECK option was not set), but the
2462 value of startoffset did not point to the beginning of a UTF-8 charac-
2463 ter or the end of the subject.
2464
2465 PCRE_ERROR_PARTIAL (-12)
2466
2467 The subject string did not match, but it did match partially. See the
2468 pcrepartial documentation for details of partial matching.
2469
2470 PCRE_ERROR_BADPARTIAL (-13)
2471
2472 This code is no longer in use. It was formerly returned when the
2473 PCRE_PARTIAL option was used with a compiled pattern containing items
2474 that were not supported for partial matching. From release 8.00
2475 onwards, there are no restrictions on partial matching.
2476
2477 PCRE_ERROR_INTERNAL (-14)
2478
2479 An unexpected internal error has occurred. This error could be caused
2480 by a bug in PCRE or by overwriting of the compiled pattern.
2481
2482 PCRE_ERROR_BADCOUNT (-15)
2483
2484 This error is given if the value of the ovecsize argument is negative.
2485
2486 PCRE_ERROR_RECURSIONLIMIT (-21)
2487
2488 The internal recursion limit, as specified by the match_limit_recursion
2489 field in a pcre_extra structure (or defaulted) was reached. See the
2490 description above.
2491
2492 PCRE_ERROR_BADNEWLINE (-23)
2493
2494 An invalid combination of PCRE_NEWLINE_xxx options was given.
2495
2496 PCRE_ERROR_BADOFFSET (-24)
2497
2498 The value of startoffset was negative or greater than the length of the
2499 subject, that is, the value in length.
2500
2501 PCRE_ERROR_SHORTUTF8 (-25)
2502
2503 This error is returned instead of PCRE_ERROR_BADUTF8 when the subject
2504 string ends with a truncated UTF-8 character and the PCRE_PARTIAL_HARD
2505 option is set. Information about the failure is returned as for
2506 PCRE_ERROR_BADUTF8. It is in fact sufficient to detect this case, but
2507 this special error code for PCRE_PARTIAL_HARD precedes the implementa-
2508 tion of returned information; it is retained for backwards compatibil-
2509 ity.
2510
2511 PCRE_ERROR_RECURSELOOP (-26)
2512
2513 This error is returned when pcre_exec() detects a recursion loop within
2514 the pattern. Specifically, it means that either the whole pattern or a
2515 subpattern has been called recursively for the second time at the same
2516 position in the subject string. Some simple patterns that might do this
2517 are detected and faulted at compile time, but more complicated cases,
2518 in particular mutual recursions between two different subpatterns, can-
2519 not be detected until run time.
2520
2521 PCRE_ERROR_JIT_STACKLIMIT (-27)
2522
2523 This error is returned when a pattern that was successfully studied
2524 using the PCRE_STUDY_JIT_COMPILE option is being matched, but the mem-
2525 ory available for the just-in-time processing stack is not large
2526 enough. See the pcrejit documentation for more details.
2527
2528 Error numbers -16 to -20 and -22 are not used by pcre_exec().
2529
2530 Reason codes for invalid UTF-8 strings
2531
2532 When pcre_exec() returns either PCRE_ERROR_BADUTF8 or PCRE_ERROR_SHORT-
2533 UTF8, and the size of the output vector (ovecsize) is at least 2, the
2534 offset of the start of the invalid UTF-8 character is placed in the
2535 first output vector element (ovector[0]) and a reason code is placed in
2536 the second element (ovector[1]). The reason codes are given names in
2537 the pcre.h header file:
2538
2539 PCRE_UTF8_ERR1
2540 PCRE_UTF8_ERR2
2541 PCRE_UTF8_ERR3
2542 PCRE_UTF8_ERR4
2543 PCRE_UTF8_ERR5
2544
2545 The string ends with a truncated UTF-8 character; the code specifies
2546 how many bytes are missing (1 to 5). Although RFC 3629 restricts UTF-8
2547 characters to be no longer than 4 bytes, the encoding scheme (origi-
2548 nally defined by RFC 2279) allows for up to 6 bytes, and this is
2549 checked first; hence the possibility of 4 or 5 missing bytes.
2550
2551 PCRE_UTF8_ERR6
2552 PCRE_UTF8_ERR7
2553 PCRE_UTF8_ERR8
2554 PCRE_UTF8_ERR9
2555 PCRE_UTF8_ERR10
2556
2557 The two most significant bits of the 2nd, 3rd, 4th, 5th, or 6th byte of
2558 the character do not have the binary value 0b10 (that is, either the
2559 most significant bit is 0, or the next bit is 1).
2560
2561 PCRE_UTF8_ERR11
2562 PCRE_UTF8_ERR12
2563
2564 A character that is valid by the RFC 2279 rules is either 5 or 6 bytes
2565 long; these code points are excluded by RFC 3629.
2566
2567 PCRE_UTF8_ERR13
2568
2569 A 4-byte character has a value greater than 0x10fff; these code points
2570 are excluded by RFC 3629.
2571
2572 PCRE_UTF8_ERR14
2573
2574 A 3-byte character has a value in the range 0xd800 to 0xdfff; this
2575 range of code points are reserved by RFC 3629 for use with UTF-16, and
2576 so are excluded from UTF-8.
2577
2578 PCRE_UTF8_ERR15
2579 PCRE_UTF8_ERR16
2580 PCRE_UTF8_ERR17
2581 PCRE_UTF8_ERR18
2582 PCRE_UTF8_ERR19
2583
2584 A 2-, 3-, 4-, 5-, or 6-byte character is "overlong", that is, it codes
2585 for a value that can be represented by fewer bytes, which is invalid.
2586 For example, the two bytes 0xc0, 0xae give the value 0x2e, whose cor-
2587 rect coding uses just one byte.
2588
2589 PCRE_UTF8_ERR20
2590
2591 The two most significant bits of the first byte of a character have the
2592 binary value 0b10 (that is, the most significant bit is 1 and the sec-
2593 ond is 0). Such a byte can only validly occur as the second or subse-
2594 quent byte of a multi-byte character.
2595
2596 PCRE_UTF8_ERR21
2597
2598 The first byte of a character has the value 0xfe or 0xff. These values
2599 can never occur in a valid UTF-8 string.
2600
2601
2602 EXTRACTING CAPTURED SUBSTRINGS BY NUMBER
2603
2604 int pcre_copy_substring(const char *subject, int *ovector,
2605 int stringcount, int stringnumber, char *buffer,
2606 int buffersize);
2607
2608 int pcre_get_substring(const char *subject, int *ovector,
2609 int stringcount, int stringnumber,
2610 const char **stringptr);
2611
2612 int pcre_get_substring_list(const char *subject,
2613 int *ovector, int stringcount, const char ***listptr);
2614
2615 Captured substrings can be accessed directly by using the offsets
2616 returned by pcre_exec() in ovector. For convenience, the functions
2617 pcre_copy_substring(), pcre_get_substring(), and pcre_get_sub-
2618 string_list() are provided for extracting captured substrings as new,
2619 separate, zero-terminated strings. These functions identify substrings
2620 by number. The next section describes functions for extracting named
2621 substrings.
2622
2623 A substring that contains a binary zero is correctly extracted and has
2624 a further zero added on the end, but the result is not, of course, a C
2625 string. However, you can process such a string by referring to the
2626 length that is returned by pcre_copy_substring() and pcre_get_sub-
2627 string(). Unfortunately, the interface to pcre_get_substring_list() is
2628 not adequate for handling strings containing binary zeros, because the
2629 end of the final string is not independently indicated.
2630
2631 The first three arguments are the same for all three of these func-
2632 tions: subject is the subject string that has just been successfully
2633 matched, ovector is a pointer to the vector of integer offsets that was
2634 passed to pcre_exec(), and stringcount is the number of substrings that
2635 were captured by the match, including the substring that matched the
2636 entire regular expression. This is the value returned by pcre_exec() if
2637 it is greater than zero. If pcre_exec() returned zero, indicating that
2638 it ran out of space in ovector, the value passed as stringcount should
2639 be the number of elements in the vector divided by three.
2640
2641 The functions pcre_copy_substring() and pcre_get_substring() extract a
2642 single substring, whose number is given as stringnumber. A value of
2643 zero extracts the substring that matched the entire pattern, whereas
2644 higher values extract the captured substrings. For pcre_copy_sub-
2645 string(), the string is placed in buffer, whose length is given by
2646 buffersize, while for pcre_get_substring() a new block of memory is
2647 obtained via pcre_malloc, and its address is returned via stringptr.
2648 The yield of the function is the length of the string, not including
2649 the terminating zero, or one of these error codes:
2650
2651 PCRE_ERROR_NOMEMORY (-6)
2652
2653 The buffer was too small for pcre_copy_substring(), or the attempt to
2654 get memory failed for pcre_get_substring().
2655
2656 PCRE_ERROR_NOSUBSTRING (-7)
2657
2658 There is no substring whose number is stringnumber.
2659
2660 The pcre_get_substring_list() function extracts all available sub-
2661 strings and builds a list of pointers to them. All this is done in a
2662 single block of memory that is obtained via pcre_malloc. The address of
2663 the memory block is returned via listptr, which is also the start of
2664 the list of string pointers. The end of the list is marked by a NULL
2665 pointer. The yield of the function is zero if all went well, or the
2666 error code
2667
2668 PCRE_ERROR_NOMEMORY (-6)
2669
2670 if the attempt to get the memory block failed.
2671
2672 When any of these functions encounter a substring that is unset, which
2673 can happen when capturing subpattern number n+1 matches some part of
2674 the subject, but subpattern n has not been used at all, they return an
2675 empty string. This can be distinguished from a genuine zero-length sub-
2676 string by inspecting the appropriate offset in ovector, which is nega-
2677 tive for unset substrings.
2678
2679 The two convenience functions pcre_free_substring() and pcre_free_sub-
2680 string_list() can be used to free the memory returned by a previous
2681 call of pcre_get_substring() or pcre_get_substring_list(), respec-
2682 tively. They do nothing more than call the function pointed to by
2683 pcre_free, which of course could be called directly from a C program.
2684 However, PCRE is used in some situations where it is linked via a spe-
2685 cial interface to another programming language that cannot use
2686 pcre_free directly; it is for these cases that the functions are pro-
2687 vided.
2688
2689
2690 EXTRACTING CAPTURED SUBSTRINGS BY NAME
2691
2692 int pcre_get_stringnumber(const pcre *code,
2693 const char *name);
2694
2695 int pcre_copy_named_substring(const pcre *code,
2696 const char *subject, int *ovector,
2697 int stringcount, const char *stringname,
2698 char *buffer, int buffersize);
2699
2700 int pcre_get_named_substring(const pcre *code,
2701 const char *subject, int *ovector,
2702 int stringcount, const char *stringname,
2703 const char **stringptr);
2704
2705 To extract a substring by name, you first have to find associated num-
2706 ber. For example, for this pattern
2707
2708 (a+)b(?<xxx>\d+)...
2709
2710 the number of the subpattern called "xxx" is 2. If the name is known to
2711 be unique (PCRE_DUPNAMES was not set), you can find the number from the
2712 name by calling pcre_get_stringnumber(). The first argument is the com-
2713 piled pattern, and the second is the name. The yield of the function is
2714 the subpattern number, or PCRE_ERROR_NOSUBSTRING (-7) if there is no
2715 subpattern of that name.
2716
2717 Given the number, you can extract the substring directly, or use one of
2718 the functions described in the previous section. For convenience, there
2719 are also two functions that do the whole job.
2720
2721 Most of the arguments of pcre_copy_named_substring() and
2722 pcre_get_named_substring() are the same as those for the similarly
2723 named functions that extract by number. As these are described in the
2724 previous section, they are not re-described here. There are just two
2725 differences:
2726
2727 First, instead of a substring number, a substring name is given. Sec-
2728 ond, there is an extra argument, given at the start, which is a pointer
2729 to the compiled pattern. This is needed in order to gain access to the
2730 name-to-number translation table.
2731
2732 These functions call pcre_get_stringnumber(), and if it succeeds, they
2733 then call pcre_copy_substring() or pcre_get_substring(), as appropri-
2734 ate. NOTE: If PCRE_DUPNAMES is set and there are duplicate names, the
2735 behaviour may not be what you want (see the next section).
2736
2737 Warning: If the pattern uses the (?| feature to set up multiple subpat-
2738 terns with the same number, as described in the section on duplicate
2739 subpattern numbers in the pcrepattern page, you cannot use names to
2740 distinguish the different subpatterns, because names are not included
2741 in the compiled code. The matching process uses only numbers. For this
2742 reason, the use of different names for subpatterns of the same number
2743 causes an error at compile time.
2744
2745
2746 DUPLICATE SUBPATTERN NAMES
2747
2748 int pcre_get_stringtable_entries(const pcre *code,
2749 const char *name, char **first, char **last);
2750
2751 When a pattern is compiled with the PCRE_DUPNAMES option, names for
2752 subpatterns are not required to be unique. (Duplicate names are always
2753 allowed for subpatterns with the same number, created by using the (?|
2754 feature. Indeed, if such subpatterns are named, they are required to
2755 use the same names.)
2756
2757 Normally, patterns with duplicate names are such that in any one match,
2758 only one of the named subpatterns participates. An example is shown in
2759 the pcrepattern documentation.
2760
2761 When duplicates are present, pcre_copy_named_substring() and
2762 pcre_get_named_substring() return the first substring corresponding to
2763 the given name that is set. If none are set, PCRE_ERROR_NOSUBSTRING
2764 (-7) is returned; no data is returned. The pcre_get_stringnumber()
2765 function returns one of the numbers that are associated with the name,
2766 but it is not defined which it is.
2767
2768 If you want to get full details of all captured substrings for a given
2769 name, you must use the pcre_get_stringtable_entries() function. The
2770 first argument is the compiled pattern, and the second is the name. The
2771 third and fourth are pointers to variables which are updated by the
2772 function. After it has run, they point to the first and last entries in
2773 the name-to-number table for the given name. The function itself
2774 returns the length of each entry, or PCRE_ERROR_NOSUBSTRING (-7) if
2775 there are none. The format of the table is described above in the sec-
2776 tion entitled Information about a pattern above. Given all the rele-
2777 vant entries for the name, you can extract each of their numbers, and
2778 hence the captured data, if any.
2779
2780
2781 FINDING ALL POSSIBLE MATCHES
2782
2783 The traditional matching function uses a similar algorithm to Perl,
2784 which stops when it finds the first match, starting at a given point in
2785 the subject. If you want to find all possible matches, or the longest
2786 possible match, consider using the alternative matching function (see
2787 below) instead. If you cannot use the alternative function, but still
2788 need to find all possible matches, you can kludge it up by making use
2789 of the callout facility, which is described in the pcrecallout documen-
2790 tation.
2791
2792 What you have to do is to insert a callout right at the end of the pat-
2793 tern. When your callout function is called, extract and save the cur-
2794 rent matched substring. Then return 1, which forces pcre_exec() to
2795 backtrack and try other alternatives. Ultimately, when it runs out of
2796 matches, pcre_exec() will yield PCRE_ERROR_NOMATCH.
2797
2798
2799 MATCHING A PATTERN: THE ALTERNATIVE FUNCTION
2800
2801 int pcre_dfa_exec(const pcre *code, const pcre_extra *extra,
2802 const char *subject, int length, int startoffset,
2803 int options, int *ovector, int ovecsize,
2804 int *workspace, int wscount);
2805
2806 The function pcre_dfa_exec() is called to match a subject string
2807 against a compiled pattern, using a matching algorithm that scans the
2808 subject string just once, and does not backtrack. This has different
2809 characteristics to the normal algorithm, and is not compatible with
2810 Perl. Some of the features of PCRE patterns are not supported. Never-
2811 theless, there are times when this kind of matching can be useful. For
2812 a discussion of the two matching algorithms, and a list of features
2813 that pcre_dfa_exec() does not support, see the pcrematching documenta-
2814 tion.
2815
2816 The arguments for the pcre_dfa_exec() function are the same as for
2817 pcre_exec(), plus two extras. The ovector argument is used in a differ-
2818 ent way, and this is described below. The other common arguments are
2819 used in the same way as for pcre_exec(), so their description is not
2820 repeated here.
2821
2822 The two additional arguments provide workspace for the function. The
2823 workspace vector should contain at least 20 elements. It is used for
2824 keeping track of multiple paths through the pattern tree. More
2825 workspace will be needed for patterns and subjects where there are a
2826 lot of potential matches.
2827
2828 Here is an example of a simple call to pcre_dfa_exec():
2829
2830 int rc;
2831 int ovector[10];
2832 int wspace[20];
2833 rc = pcre_dfa_exec(
2834 re, /* result of pcre_compile() */
2835 NULL, /* we didn't study the pattern */
2836 "some string", /* the subject string */
2837 11, /* the length of the subject string */
2838 0, /* start at offset 0 in the subject */
2839 0, /* default options */
2840 ovector, /* vector of integers for substring information */
2841 10, /* number of elements (NOT size in bytes) */
2842 wspace, /* working space vector */
2843 20); /* number of elements (NOT size in bytes) */
2844
2845 Option bits for pcre_dfa_exec()
2846
2847 The unused bits of the options argument for pcre_dfa_exec() must be
2848 zero. The only bits that may be set are PCRE_ANCHORED, PCRE_NEW-
2849 LINE_xxx, PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY,
2850 PCRE_NOTEMPTY_ATSTART, PCRE_NO_UTF8_CHECK, PCRE_BSR_ANYCRLF,
2851 PCRE_BSR_UNICODE, PCRE_NO_START_OPTIMIZE, PCRE_PARTIAL_HARD, PCRE_PAR-
2852 TIAL_SOFT, PCRE_DFA_SHORTEST, and PCRE_DFA_RESTART. All but the last
2853 four of these are exactly the same as for pcre_exec(), so their
2854 description is not repeated here.
2855
2856 PCRE_PARTIAL_HARD
2857 PCRE_PARTIAL_SOFT
2858
2859 These have the same general effect as they do for pcre_exec(), but the
2860 details are slightly different. When PCRE_PARTIAL_HARD is set for
2861 pcre_dfa_exec(), it returns PCRE_ERROR_PARTIAL if the end of the sub-
2862 ject is reached and there is still at least one matching possibility
2863 that requires additional characters. This happens even if some complete
2864 matches have also been found. When PCRE_PARTIAL_SOFT is set, the return
2865 code PCRE_ERROR_NOMATCH is converted into PCRE_ERROR_PARTIAL if the end
2866 of the subject is reached, there have been no complete matches, but
2867 there is still at least one matching possibility. The portion of the
2868 string that was inspected when the longest partial match was found is
2869 set as the first matching string in both cases. There is a more
2870 detailed discussion of partial and multi-segment matching, with exam-
2871 ples, in the pcrepartial documentation.
2872
2873 PCRE_DFA_SHORTEST
2874
2875 Setting the PCRE_DFA_SHORTEST option causes the matching algorithm to
2876 stop as soon as it has found one match. Because of the way the alterna-
2877 tive algorithm works, this is necessarily the shortest possible match
2878 at the first possible matching point in the subject string.
2879
2880 PCRE_DFA_RESTART
2881
2882 When pcre_dfa_exec() returns a partial match, it is possible to call it
2883 again, with additional subject characters, and have it continue with
2884 the same match. The PCRE_DFA_RESTART option requests this action; when
2885 it is set, the workspace and wscount options must reference the same
2886 vector as before because data about the match so far is left in them
2887 after a partial match. There is more discussion of this facility in the
2888 pcrepartial documentation.
2889
2890 Successful returns from pcre_dfa_exec()
2891
2892 When pcre_dfa_exec() succeeds, it may have matched more than one sub-
2893 string in the subject. Note, however, that all the matches from one run
2894 of the function start at the same point in the subject. The shorter
2895 matches are all initial substrings of the longer matches. For example,
2896 if the pattern
2897
2898 <.*>
2899
2900 is matched against the string
2901
2902 This is <something> <something else> <something further> no more
2903
2904 the three matched strings are
2905
2906 <something>
2907 <something> <something else>
2908 <something> <something else> <something further>
2909
2910 On success, the yield of the function is a number greater than zero,
2911 which is the number of matched substrings. The substrings themselves
2912 are returned in ovector. Each string uses two elements; the first is
2913 the offset to the start, and the second is the offset to the end. In
2914 fact, all the strings have the same start offset. (Space could have
2915 been saved by giving this only once, but it was decided to retain some
2916 compatibility with the way pcre_exec() returns data, even though the
2917 meaning of the strings is different.)
2918
2919 The strings are returned in reverse order of length; that is, the long-
2920 est matching string is given first. If there were too many matches to
2921 fit into ovector, the yield of the function is zero, and the vector is
2922 filled with the longest matches. Unlike pcre_exec(), pcre_dfa_exec()
2923 can use the entire ovector for returning matched strings.
2924
2925 Error returns from pcre_dfa_exec()
2926
2927 The pcre_dfa_exec() function returns a negative number when it fails.
2928 Many of the errors are the same as for pcre_exec(), and these are
2929 described above. There are in addition the following errors that are
2930 specific to pcre_dfa_exec():
2931
2932 PCRE_ERROR_DFA_UITEM (-16)
2933
2934 This return is given if pcre_dfa_exec() encounters an item in the pat-
2935 tern that it does not support, for instance, the use of \C or a back
2936 reference.
2937
2938 PCRE_ERROR_DFA_UCOND (-17)
2939
2940 This return is given if pcre_dfa_exec() encounters a condition item
2941 that uses a back reference for the condition, or a test for recursion
2942 in a specific group. These are not supported.
2943
2944 PCRE_ERROR_DFA_UMLIMIT (-18)
2945
2946 This return is given if pcre_dfa_exec() is called with an extra block
2947 that contains a setting of the match_limit or match_limit_recursion
2948 fields. This is not supported (these fields are meaningless for DFA
2949 matching).
2950
2951 PCRE_ERROR_DFA_WSSIZE (-19)
2952
2953 This return is given if pcre_dfa_exec() runs out of space in the
2954 workspace vector.
2955
2956 PCRE_ERROR_DFA_RECURSE (-20)
2957
2958 When a recursive subpattern is processed, the matching function calls
2959 itself recursively, using private vectors for ovector and workspace.
2960 This error is given if the output vector is not large enough. This
2961 should be extremely rare, as a vector of size 1000 is used.
2962
2963
2964 SEE ALSO
2965
2966 pcrebuild(3), pcrecallout(3), pcrecpp(3)(3), pcrematching(3), pcrepar-
2967 tial(3), pcreposix(3), pcreprecompile(3), pcresample(3), pcrestack(3).
2968
2969
2970 AUTHOR
2971
2972 Philip Hazel
2973 University Computing Service
2974 Cambridge CB2 3QH, England.
2975
2976
2977 REVISION
2978
2979 Last updated: 06 September 2011
2980 Copyright (c) 1997-2011 University of Cambridge.
2981 ------------------------------------------------------------------------------
2982
2983
2984 PCRECALLOUT(3) PCRECALLOUT(3)
2985
2986
2987 NAME
2988 PCRE - Perl-compatible regular expressions
2989
2990
2991 PCRE CALLOUTS
2992
2993 int (*pcre_callout)(pcre_callout_block *);
2994
2995 PCRE provides a feature called "callout", which is a means of temporar-
2996 ily passing control to the caller of PCRE in the middle of pattern
2997 matching. The caller of PCRE provides an external function by putting
2998 its entry point in the global variable pcre_callout. By default, this
2999 variable contains NULL, which disables all calling out.
3000
3001 Within a regular expression, (?C) indicates the points at which the
3002 external function is to be called. Different callout points can be
3003 identified by putting a number less than 256 after the letter C. The
3004 default value is zero. For example, this pattern has two callout
3005 points:
3006
3007 (?C1)abc(?C2)def
3008
3009 If the PCRE_AUTO_CALLOUT option bit is set when pcre_compile() or
3010 pcre_compile2() is called, PCRE automatically inserts callouts, all
3011 with number 255, before each item in the pattern. For example, if
3012 PCRE_AUTO_CALLOUT is used with the pattern
3013
3014 A(\d{2}|--)
3015
3016 it is processed as if it were
3017
3018 (?C255)A(?C255)((?C255)\d{2}(?C255)|(?C255)-(?C255)-(?C255))(?C255)
3019
3020 Notice that there is a callout before and after each parenthesis and
3021 alternation bar. Automatic callouts can be used for tracking the
3022 progress of pattern matching. The pcretest command has an option that
3023 sets automatic callouts; when it is used, the output indicates how the
3024 pattern is matched. This is useful information when you are trying to
3025 optimize the performance of a particular pattern.
3026
3027 The use of callouts in a pattern makes it ineligible for optimization
3028 by the just-in-time compiler. Studying such a pattern with the
3029 PCRE_STUDY_JIT_COMPILE option always fails.
3030
3031
3032 MISSING CALLOUTS
3033
3034 You should be aware that, because of optimizations in the way PCRE
3035 matches patterns by default, callouts sometimes do not happen. For
3036 example, if the pattern is
3037
3038 ab(?C4)cd
3039
3040 PCRE knows that any matching string must contain the letter "d". If the
3041 subject string is "abyz", the lack of "d" means that matching doesn't
3042 ever start, and the callout is never reached. However, with "abyd",
3043 though the result is still no match, the callout is obeyed.
3044
3045 If the pattern is studied, PCRE knows the minimum length of a matching
3046 string, and will immediately give a "no match" return without actually
3047 running a match if the subject is not long enough, or, for unanchored
3048 patterns, if it has been scanned far enough.
3049
3050 You can disable these optimizations by passing the PCRE_NO_START_OPTI-
3051 MIZE option to pcre_compile(), pcre_exec(), or pcre_dfa_exec(), or by
3052 starting the pattern with (*NO_START_OPT). This slows down the matching
3053 process, but does ensure that callouts such as the example above are
3054 obeyed.
3055
3056
3057 THE CALLOUT INTERFACE
3058
3059 During matching, when PCRE reaches a callout point, the external func-
3060 tion defined by pcre_callout is called (if it is set). This applies to
3061 both the pcre_exec() and the pcre_dfa_exec() matching functions. The
3062 only argument to the callout function is a pointer to a pcre_callout
3063 block. This structure contains the following fields:
3064
3065 int version;
3066 int callout_number;
3067 int *offset_vector;
3068 const char *subject;
3069 int subject_length;
3070 int start_match;
3071 int current_position;
3072 int capture_top;
3073 int capture_last;
3074 void *callout_data;
3075 int pattern_position;
3076 int next_item_length;
3077 const unsigned char *mark;
3078
3079 The version field is an integer containing the version number of the
3080 block format. The initial version was 0; the current version is 2. The
3081 version number will change again in future if additional fields are
3082 added, but the intention is never to remove any of the existing fields.
3083
3084 The callout_number field contains the number of the callout, as com-
3085 piled into the pattern (that is, the number after ?C for manual call-
3086 outs, and 255 for automatically generated callouts).
3087
3088 The offset_vector field is a pointer to the vector of offsets that was
3089 passed by the caller to pcre_exec() or pcre_dfa_exec(). When
3090 pcre_exec() is used, the contents can be inspected in order to extract
3091 substrings that have been matched so far, in the same way as for
3092 extracting substrings after a match has completed. For pcre_dfa_exec()
3093 this field is not useful.
3094
3095 The subject and subject_length fields contain copies of the values that
3096 were passed to pcre_exec().
3097
3098 The start_match field normally contains the offset within the subject
3099 at which the current match attempt started. However, if the escape
3100 sequence \K has been encountered, this value is changed to reflect the
3101 modified starting point. If the pattern is not anchored, the callout
3102 function may be called several times from the same point in the pattern
3103 for different starting points in the subject.
3104
3105 The current_position field contains the offset within the subject of
3106 the current match pointer.
3107
3108 When the pcre_exec() function is used, the capture_top field contains
3109 one more than the number of the highest numbered captured substring so
3110 far. If no substrings have been captured, the value of capture_top is
3111 one. This is always the case when pcre_dfa_exec() is used, because it
3112 does not support captured substrings.
3113
3114 The capture_last field contains the number of the most recently cap-
3115 tured substring. If no substrings have been captured, its value is -1.
3116 This is always the case when pcre_dfa_exec() is used.
3117
3118 The callout_data field contains a value that is passed to pcre_exec()
3119 or pcre_dfa_exec() specifically so that it can be passed back in call-
3120 outs. It is passed in the pcre_callout field of the pcre_extra data
3121 structure. If no such data was passed, the value of callout_data in a
3122 pcre_callout block is NULL. There is a description of the pcre_extra
3123 structure in the pcreapi documentation.
3124
3125 The pattern_position field is present from version 1 of the pcre_call-
3126 out structure. It contains the offset to the next item to be matched in
3127 the pattern string.
3128
3129 The next_item_length field is present from version 1 of the pcre_call-
3130 out structure. It contains the length of the next item to be matched in
3131 the pattern string. When the callout immediately precedes an alterna-
3132 tion bar, a closing parenthesis, or the end of the pattern, the length
3133 is zero. When the callout precedes an opening parenthesis, the length
3134 is that of the entire subpattern.
3135
3136 The pattern_position and next_item_length fields are intended to help
3137 in distinguishing between different automatic callouts, which all have
3138 the same callout number. However, they are set for all callouts.
3139
3140 The mark field is present from version 2 of the pcre_callout structure.
3141 In callouts from pcre_exec() it contains a pointer to the zero-termi-
3142 nated name of the most recently passed (*MARK) item in the match, or
3143 NULL if there are no (*MARK)s in the current matching path. In callouts
3144 from pcre_dfa_exec() this field always contains NULL.
3145
3146
3147 RETURN VALUES
3148
3149 The external callout function returns an integer to PCRE. If the value
3150 is zero, matching proceeds as normal. If the value is greater than
3151 zero, matching fails at the current point, but the testing of other
3152 matching possibilities goes ahead, just as if a lookahead assertion had
3153 failed. If the value is less than zero, the match is abandoned, and
3154 pcre_exec() or pcre_dfa_exec() returns the negative value.
3155
3156 Negative values should normally be chosen from the set of
3157 PCRE_ERROR_xxx values. In particular, PCRE_ERROR_NOMATCH forces a stan-
3158 dard "no match" failure. The error number PCRE_ERROR_CALLOUT is
3159 reserved for use by callout functions; it will never be used by PCRE
3160 itself.
3161
3162
3163 AUTHOR
3164
3165 Philip Hazel
3166 University Computing Service
3167 Cambridge CB2 3QH, England.
3168
3169
3170 REVISION
3171
3172 Last updated: 26 August 2011
3173 Copyright (c) 1997-2011 University of Cambridge.
3174 ------------------------------------------------------------------------------
3175
3176
3177 PCRECOMPAT(3) PCRECOMPAT(3)
3178
3179
3180 NAME
3181 PCRE - Perl-compatible regular expressions
3182
3183
3184 DIFFERENCES BETWEEN PCRE AND PERL
3185
3186 This document describes the differences in the ways that PCRE and Perl
3187 handle regular expressions. The differences described here are with
3188 respect to Perl versions 5.10 and above.
3189
3190 1. PCRE has only a subset of Perl's UTF-8 and Unicode support. Details
3191 of what it does have are given in the pcreunicode page.
3192
3193 2. PCRE allows repeat quantifiers only on parenthesized assertions, but
3194 they do not mean what you might think. For example, (?!a){3} does not
3195 assert that the next three characters are not "a". It just asserts that
3196 the next character is not "a" three times (in principle: PCRE optimizes
3197 this to run the assertion just once). Perl allows repeat quantifiers on
3198 other assertions such as \b, but these do not seem to have any use.
3199
3200 3. Capturing subpatterns that occur inside negative lookahead asser-
3201 tions are counted, but their entries in the offsets vector are never
3202 set. Perl sets its numerical variables from any such patterns that are
3203 matched before the assertion fails to match something (thereby succeed-
3204 ing), but only if the negative lookahead assertion contains just one
3205 branch.
3206
3207 4. Though binary zero characters are supported in the subject string,
3208 they are not allowed in a pattern string because it is passed as a nor-
3209 mal C string, terminated by zero. The escape sequence \0 can be used in
3210 the pattern to represent a binary zero.
3211
3212 5. The following Perl escape sequences are not supported: \l, \u, \L,
3213 \U, and \N when followed by a character name or Unicode value. (\N on
3214 its own, matching a non-newline character, is supported.) In fact these
3215 are implemented by Perl's general string-handling and are not part of
3216 its pattern matching engine. If any of these are encountered by PCRE,
3217 an error is generated.
3218
3219 6. The Perl escape sequences \p, \P, and \X are supported only if PCRE
3220 is built with Unicode character property support. The properties that
3221 can be tested with \p and \P are limited to the general category prop-
3222 erties such as Lu and Nd, script names such as Greek or Han, and the
3223 derived properties Any and L&. PCRE does support the Cs (surrogate)
3224 property, which Perl does not; the Perl documentation says "Because
3225 Perl hides the need for the user to understand the internal representa-
3226 tion of Unicode characters, there is no need to implement the somewhat
3227 messy concept of surrogates."
3228
3229 7. PCRE implements a simpler version of \X than Perl, which changed to
3230 make \X match what Unicode calls an "extended grapheme cluster". This
3231 is more complicated than an extended Unicode sequence, which is what
3232 PCRE matches.
3233
3234 8. PCRE does support the \Q...\E escape for quoting substrings. Charac-
3235 ters in between are treated as literals. This is slightly different
3236 from Perl in that $ and @ are also handled as literals inside the
3237 quotes. In Perl, they cause variable interpolation (but of course PCRE
3238 does not have variables). Note the following examples:
3239
3240 Pattern PCRE matches Perl matches
3241
3242 \Qabc$xyz\E abc$xyz abc followed by the
3243 contents of $xyz
3244 \Qabc\$xyz\E abc\$xyz abc\$xyz
3245 \Qabc\E\$\Qxyz\E abc$xyz abc$xyz
3246
3247 The \Q...\E sequence is recognized both inside and outside character
3248 classes.
3249
3250 9. Fairly obviously, PCRE does not support the (?{code}) and (??{code})
3251 constructions. However, there is support for recursive patterns. This
3252 is not available in Perl 5.8, but it is in Perl 5.10. Also, the PCRE
3253 "callout" feature allows an external function to be called during pat-
3254 tern matching. See the pcrecallout documentation for details.
3255
3256 10. Subpatterns that are called recursively or as "subroutines" are
3257 always treated as atomic groups in PCRE. This is like Python, but
3258 unlike Perl. There is a discussion of an example that explains this in
3259 more detail in the section on recursion differences from Perl in the
3260 pcrepattern page.
3261
3262 11. There are some differences that are concerned with the settings of
3263 captured strings when part of a pattern is repeated. For example,
3264 matching "aba" against the pattern /^(a(b)?)+$/ in Perl leaves $2
3265 unset, but in PCRE it is set to "b".
3266
3267 12. PCRE's handling of duplicate subpattern numbers and duplicate sub-
3268 pattern names is not as general as Perl's. This is a consequence of the
3269 fact the PCRE works internally just with numbers, using an external ta-
3270 ble to translate between numbers and names. In particular, a pattern
3271 such as (?|(?<a>A)|(?<b)B), where the two capturing parentheses have
3272 the same number but different names, is not supported, and causes an
3273 error at compile time. If it were allowed, it would not be possible to
3274 distinguish which parentheses matched, because both names map to cap-
3275 turing subpattern number 1. To avoid this confusing situation, an error
3276 is given at compile time.
3277
3278 13. Perl recognizes comments in some places that PCRE does not, for
3279 example, between the ( and ? at the start of a subpattern. If the /x
3280 modifier is set, Perl allows whitespace between ( and ? but PCRE never
3281 does, even if the PCRE_EXTENDED option is set.
3282
3283 14. PCRE provides some extensions to the Perl regular expression facil-
3284 ities. Perl 5.10 includes new features that are not in earlier ver-
3285 sions of Perl, some of which (such as named parentheses) have been in
3286 PCRE for some time. This list is with respect to Perl 5.10:
3287
3288 (a) Although lookbehind assertions in PCRE must match fixed length
3289 strings, each alternative branch of a lookbehind assertion can match a
3290 different length of string. Perl requires them all to have the same
3291 length.
3292
3293 (b) If PCRE_DOLLAR_ENDONLY is set and PCRE_MULTILINE is not set, the $
3294 meta-character matches only at the very end of the string.
3295
3296 (c) If PCRE_EXTRA is set, a backslash followed by a letter with no spe-
3297 cial meaning is faulted. Otherwise, like Perl, the backslash is quietly
3298 ignored. (Perl can be made to issue a warning.)
3299
3300 (d) If PCRE_UNGREEDY is set, the greediness of the repetition quanti-
3301 fiers is inverted, that is, by default they are not greedy, but if fol-
3302 lowed by a question mark they are.
3303
3304 (e) PCRE_ANCHORED can be used at matching time to force a pattern to be
3305 tried only at the first matching position in the subject string.
3306
3307 (f) The PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NOTEMPTY_ATSTART,
3308 and PCRE_NO_AUTO_CAPTURE options for pcre_exec() have no Perl equiva-
3309 lents.
3310
3311 (g) The \R escape sequence can be restricted to match only CR, LF, or
3312 CRLF by the PCRE_BSR_ANYCRLF option.
3313
3314 (h) The callout facility is PCRE-specific.
3315
3316 (i) The partial matching facility is PCRE-specific.
3317
3318 (j) Patterns compiled by PCRE can be saved and re-used at a later time,
3319 even on different hosts that have the other endianness.
3320
3321 (k) The alternative matching function (pcre_dfa_exec()) matches in a
3322 different way and is not Perl-compatible.
3323
3324 (l) PCRE recognizes some special sequences such as (*CR) at the start
3325 of a pattern that set overall options that cannot be changed within the
3326 pattern.
3327
3328
3329 AUTHOR
3330
3331 Philip Hazel
3332 University Computing Service
3333 Cambridge CB2 3QH, England.
3334
3335
3336 REVISION
3337
3338 Last updated: 24 August 2011
3339 Copyright (c) 1997-2011 University of Cambridge.
3340 ------------------------------------------------------------------------------
3341
3342
3343 PCREPATTERN(3) PCREPATTERN(3)
3344
3345
3346 NAME
3347 PCRE - Perl-compatible regular expressions
3348
3349
3350 PCRE REGULAR EXPRESSION DETAILS
3351
3352 The syntax and semantics of the regular expressions that are supported
3353 by PCRE are described in detail below. There is a quick-reference syn-
3354 tax summary in the pcresyntax page. PCRE tries to match Perl syntax and
3355 semantics as closely as it can. PCRE also supports some alternative
3356 regular expression syntax (which does not conflict with the Perl syn-
3357 tax) in order to provide some compatibility with regular expressions in
3358 Python, .NET, and Oniguruma.
3359
3360 Perl's regular expressions are described in its own documentation, and
3361 regular expressions in general are covered in a number of books, some
3362 of which have copious examples. Jeffrey Friedl's "Mastering Regular
3363 Expressions", published by O'Reilly, covers regular expressions in
3364 great detail. This description of PCRE's regular expressions is
3365 intended as reference material.
3366
3367 The original operation of PCRE was on strings of one-byte characters.
3368 However, there is now also support for UTF-8 character strings. To use
3369 this, PCRE must be built to include UTF-8 support, and you must call
3370 pcre_compile() or pcre_compile2() with the PCRE_UTF8 option. There is
3371 also a special sequence that can be given at the start of a pattern:
3372
3373 (*UTF8)
3374
3375 Starting a pattern with this sequence is equivalent to setting the
3376 PCRE_UTF8 option. This feature is not Perl-compatible. How setting
3377 UTF-8 mode affects pattern matching is mentioned in several places
3378 below. There is also a summary of UTF-8 features in the pcreunicode
3379 page.
3380
3381 Another special sequence that may appear at the start of a pattern or
3382 in combination with (*UTF8) is:
3383
3384 (*UCP)
3385
3386 This has the same effect as setting the PCRE_UCP option: it causes
3387 sequences such as \d and \w to use Unicode properties to determine
3388 character types, instead of recognizing only characters with codes less
3389 than 128 via a lookup table.
3390
3391 If a pattern starts with (*NO_START_OPT), it has the same effect as
3392 setting the PCRE_NO_START_OPTIMIZE option either at compile or matching
3393 time. There are also some more of these special sequences that are con-
3394 cerned with the handling of newlines; they are described below.
3395
3396 The remainder of this document discusses the patterns that are sup-
3397 ported by PCRE when its main matching function, pcre_exec(), is used.
3398 From release 6.0, PCRE offers a second matching function,
3399 pcre_dfa_exec(), which matches using a different algorithm that is not
3400 Perl-compatible. Some of the features discussed below are not available
3401 when pcre_dfa_exec() is used. The advantages and disadvantages of the
3402 alternative function, and how it differs from the normal function, are
3403 discussed in the pcrematching page.
3404
3405
3406 NEWLINE CONVENTIONS
3407
3408 PCRE supports five different conventions for indicating line breaks in
3409 strings: a single CR (carriage return) character, a single LF (line-
3410 feed) character, the two-character sequence CRLF, any of the three pre-
3411 ceding, or any Unicode newline sequence. The pcreapi page has further
3412 discussion about newlines, and shows how to set the newline convention
3413 in the options arguments for the compiling and matching functions.
3414
3415 It is also possible to specify a newline convention by starting a pat-
3416 tern string with one of the following five sequences:
3417
3418 (*CR) carriage return
3419 (*LF) linefeed
3420 (*CRLF) carriage return, followed by linefeed
3421 (*ANYCRLF) any of the three above
3422 (*ANY) all Unicode newline sequences
3423
3424 These override the default and the options given to pcre_compile() or
3425 pcre_compile2(). For example, on a Unix system where LF is the default
3426 newline sequence, the pattern
3427
3428 (*CR)a.b
3429
3430 changes the convention to CR. That pattern matches "a\nb" because LF is
3431 no longer a newline. Note that these special settings, which are not
3432 Perl-compatible, are recognized only at the very start of a pattern,
3433 and that they must be in upper case. If more than one of them is
3434 present, the last one is used.
3435
3436 The newline convention affects the interpretation of the dot metachar-
3437 acter when PCRE_DOTALL is not set, and also the behaviour of \N. How-
3438 ever, it does not affect what the \R escape sequence matches. By
3439 default, this is any Unicode newline sequence, for Perl compatibility.
3440 However, this can be changed; see the description of \R in the section
3441 entitled "Newline sequences" below. A change of \R setting can be com-
3442 bined with a change of newline convention.
3443
3444
3445 CHARACTERS AND METACHARACTERS
3446
3447 A regular expression is a pattern that is matched against a subject
3448 string from left to right. Most characters stand for themselves in a
3449 pattern, and match the corresponding characters in the subject. As a
3450 trivial example, the pattern
3451
3452 The quick brown fox
3453
3454 matches a portion of a subject string that is identical to itself. When
3455 caseless matching is specified (the PCRE_CASELESS option), letters are
3456 matched independently of case. In UTF-8 mode, PCRE always understands
3457 the concept of case for characters whose values are less than 128, so
3458 caseless matching is always possible. For characters with higher val-
3459 ues, the concept of case is supported if PCRE is compiled with Unicode
3460 property support, but not otherwise. If you want to use caseless
3461 matching for characters 128 and above, you must ensure that PCRE is
3462 compiled with Unicode property support as well as with UTF-8 support.
3463
3464 The power of regular expressions comes from the ability to include
3465 alternatives and repetitions in the pattern. These are encoded in the
3466 pattern by the use of metacharacters, which do not stand for themselves
3467 but instead are interpreted in some special way.
3468
3469 There are two different sets of metacharacters: those that are recog-
3470 nized anywhere in the pattern except within square brackets, and those
3471 that are recognized within square brackets. Outside square brackets,
3472 the metacharacters are as follows:
3473
3474 \ general escape character with several uses
3475 ^ assert start of string (or line, in multiline mode)
3476 $ assert end of string (or line, in multiline mode)
3477 . match any character except newline (by default)
3478 [ start character class definition
3479 | start of alternative branch
3480 ( start subpattern
3481 ) end subpattern
3482 ? extends the meaning of (
3483 also 0 or 1 quantifier
3484 also quantifier minimizer
3485 * 0 or more quantifier
3486 + 1 or more quantifier
3487 also "possessive quantifier"
3488 { start min/max quantifier
3489
3490 Part of a pattern that is in square brackets is called a "character
3491 class". In a character class the only metacharacters are:
3492
3493 \ general escape character
3494 ^ negate the class, but only if the first character
3495 - indicates character range
3496 [ POSIX character class (only if followed by POSIX
3497 syntax)
3498 ] terminates the character class
3499
3500 The following sections describe the use of each of the metacharacters.
3501
3502
3503 BACKSLASH
3504
3505 The backslash character has several uses. Firstly, if it is followed by
3506 a character that is not a number or a letter, it takes away any special
3507 meaning that character may have. This use of backslash as an escape
3508 character applies both inside and outside character classes.
3509
3510 For example, if you want to match a * character, you write \* in the
3511 pattern. This escaping action applies whether or not the following
3512 character would otherwise be interpreted as a metacharacter, so it is
3513 always safe to precede a non-alphanumeric with backslash to specify
3514 that it stands for itself. In particular, if you want to match a back-
3515 slash, you write \\.
3516
3517 In UTF-8 mode, only ASCII numbers and letters have any special meaning
3518 after a backslash. All other characters (in particular, those whose
3519 codepoints are greater than 127) are treated as literals.
3520
3521 If a pattern is compiled with the PCRE_EXTENDED option, whitespace in
3522 the pattern (other than in a character class) and characters between a
3523 # outside a character class and the next newline are ignored. An escap-
3524 ing backslash can be used to include a whitespace or # character as
3525 part of the pattern.
3526
3527 If you want to remove the special meaning from a sequence of charac-
3528 ters, you can do so by putting them between \Q and \E. This is differ-
3529 ent from Perl in that $ and @ are handled as literals in \Q...\E
3530 sequences in PCRE, whereas in Perl, $ and @ cause variable interpola-
3531 tion. Note the following examples:
3532
3533 Pattern PCRE matches Perl matches
3534
3535 \Qabc$xyz\E abc$xyz abc followed by the
3536 contents of $xyz
3537 \Qabc\$xyz\E abc\$xyz abc\$xyz
3538 \Qabc\E\$\Qxyz\E abc$xyz abc$xyz
3539
3540 The \Q...\E sequence is recognized both inside and outside character
3541 classes. An isolated \E that is not preceded by \Q is ignored. If \Q
3542 is not followed by \E later in the pattern, the literal interpretation
3543 continues to the end of the pattern (that is, \E is assumed at the
3544 end). If the isolated \Q is inside a character class, this causes an
3545 error, because the character class is not terminated.
3546
3547 Non-printing characters
3548
3549 A second use of backslash provides a way of encoding non-printing char-
3550 acters in patterns in a visible manner. There is no restriction on the
3551 appearance of non-printing characters, apart from the binary zero that
3552 terminates a pattern, but when a pattern is being prepared by text
3553 editing, it is often easier to use one of the following escape
3554 sequences than the binary character it represents:
3555
3556 \a alarm, that is, the BEL character (hex 07)
3557 \cx "control-x", where x is any ASCII character
3558 \e escape (hex 1B)
3559 \f formfeed (hex 0C)
3560 \n linefeed (hex 0A)
3561 \r carriage return (hex 0D)
3562 \t tab (hex 09)
3563 \ddd character with octal code ddd, or back reference
3564 \xhh character with hex code hh
3565 \x{hhh..} character with hex code hhh..
3566
3567 The precise effect of \cx is as follows: if x is a lower case letter,
3568 it is converted to upper case. Then bit 6 of the character (hex 40) is
3569 inverted. Thus \cz becomes hex 1A (z is 7A), but \c{ becomes hex 3B ({
3570 is 7B), while \c; becomes hex 7B (; is 3B). If the byte following \c
3571 has a value greater than 127, a compile-time error occurs. This locks
3572 out non-ASCII characters in both byte mode and UTF-8 mode. (When PCRE
3573 is compiled in EBCDIC mode, all byte values are valid. A lower case
3574 letter is converted to upper case, and then the 0xc0 bits are flipped.)
3575
3576 After \x, from zero to two hexadecimal digits are read (letters can be
3577 in upper or lower case). Any number of hexadecimal digits may appear
3578 between \x{ and }, but the value of the character code must be less
3579 than 256 in non-UTF-8 mode, and less than 2**31 in UTF-8 mode. That is,
3580 the maximum value in hexadecimal is 7FFFFFFF. Note that this is bigger
3581 than the largest Unicode code point, which is 10FFFF.
3582
3583 If characters other than hexadecimal digits appear between \x{ and },
3584 or if there is no terminating }, this form of escape is not recognized.
3585 Instead, the initial \x will be interpreted as a basic hexadecimal
3586 escape, with no following digits, giving a character whose value is
3587 zero.
3588
3589 Characters whose value is less than 256 can be defined by either of the
3590 two syntaxes for \x. There is no difference in the way they are han-
3591 dled. For example, \xdc is exactly the same as \x{dc}.
3592
3593 After \0 up to two further octal digits are read. If there are fewer
3594 than two digits, just those that are present are used. Thus the
3595 sequence \0\x\07 specifies two binary zeros followed by a BEL character
3596 (code value 7). Make sure you supply two digits after the initial zero
3597 if the pattern character that follows is itself an octal digit.
3598
3599 The handling of a backslash followed by a digit other than 0 is compli-
3600 cated. Outside a character class, PCRE reads it and any following dig-
3601 its as a decimal number. If the number is less than 10, or if there
3602 have been at least that many previous capturing left parentheses in the
3603 expression, the entire sequence is taken as a back reference. A
3604 description of how this works is given later, following the discussion
3605 of parenthesized subpatterns.
3606
3607 Inside a character class, or if the decimal number is greater than 9
3608 and there have not been that many capturing subpatterns, PCRE re-reads
3609 up to three octal digits following the backslash, and uses them to gen-
3610 erate a data character. Any subsequent digits stand for themselves. In
3611 non-UTF-8 mode, the value of a character specified in octal must be
3612 less than \400. In UTF-8 mode, values up to \777 are permitted. For
3613 example:
3614
3615 \040 is another way of writing a space
3616 \40 is the same, provided there are fewer than 40
3617 previous capturing subpatterns
3618 \7 is always a back reference
3619 \11 might be a back reference, or another way of
3620 writing a tab
3621 \011 is always a tab
3622 \0113 is a tab followed by the character "3"
3623 \113 might be a back reference, otherwise the
3624 character with octal code 113
3625 \377 might be a back reference, otherwise
3626 the byte consisting entirely of 1 bits
3627 \81 is either a back reference, or a binary zero
3628 followed by the two characters "8" and "1"
3629
3630 Note that octal values of 100 or greater must not be introduced by a
3631 leading zero, because no more than three octal digits are ever read.
3632
3633 All the sequences that define a single character value can be used both
3634 inside and outside character classes. In addition, inside a character
3635 class, the sequence \b is interpreted as the backspace character (hex
3636 08). The sequences \B, \N, \R, and \X are not special inside a charac-
3637 ter class. Like any other unrecognized escape sequences, they are
3638 treated as the literal characters "B", "N", "R", and "X" by default,
3639 but cause an error if the PCRE_EXTRA option is set. Outside a character
3640 class, these sequences have different meanings.
3641
3642 Absolute and relative back references
3643
3644 The sequence \g followed by an unsigned or a negative number, option-
3645 ally enclosed in braces, is an absolute or relative back reference. A
3646 named back reference can be coded as \g{name}. Back references are dis-
3647 cussed later, following the discussion of parenthesized subpatterns.
3648
3649 Absolute and relative subroutine calls
3650
3651 For compatibility with Oniguruma, the non-Perl syntax \g followed by a
3652 name or a number enclosed either in angle brackets or single quotes, is
3653 an alternative syntax for referencing a subpattern as a "subroutine".
3654 Details are discussed later. Note that \g{...} (Perl syntax) and
3655 \g<...> (Oniguruma syntax) are not synonymous. The former is a back
3656 reference; the latter is a subroutine call.
3657
3658 Generic character types
3659
3660 Another use of backslash is for specifying generic character types:
3661
3662 \d any decimal digit
3663 \D any character that is not a decimal digit
3664 \h any horizontal whitespace character
3665 \H any character that is not a horizontal whitespace character
3666 \s any whitespace character
3667 \S any character that is not a whitespace character
3668 \v any vertical whitespace character
3669 \V any character that is not a vertical whitespace character
3670 \w any "word" character
3671 \W any "non-word" character
3672
3673 There is also the single sequence \N, which matches a non-newline char-
3674 acter. This is the same as the "." metacharacter when PCRE_DOTALL is
3675 not set.
3676
3677 Each pair of lower and upper case escape sequences partitions the com-
3678 plete set of characters into two disjoint sets. Any given character
3679 matches one, and only one, of each pair. The sequences can appear both
3680 inside and outside character classes. They each match one character of
3681 the appropriate type. If the current matching point is at the end of
3682 the subject string, all of them fail, because there is no character to
3683 match.
3684
3685 For compatibility with Perl, \s does not match the VT character (code
3686 11). This makes it different from the the POSIX "space" class. The \s
3687 characters are HT (9), LF (10), FF (12), CR (13), and space (32). If
3688 "use locale;" is included in a Perl script, \s may match the VT charac-
3689 ter. In PCRE, it never does.
3690
3691 A "word" character is an underscore or any character that is a letter
3692 or digit. By default, the definition of letters and digits is con-
3693 trolled by PCRE's low-valued character tables, and may vary if locale-
3694 specific matching is taking place (see "Locale support" in the pcreapi
3695 page). For example, in a French locale such as "fr_FR" in Unix-like
3696 systems, or "french" in Windows, some character codes greater than 128
3697 are used for accented letters, and these are then matched by \w. The
3698 use of locales with Unicode is discouraged.
3699
3700 By default, in UTF-8 mode, characters with values greater than 128
3701 never match \d, \s, or \w, and always match \D, \S, and \W. These
3702 sequences retain their original meanings from before UTF-8 support was
3703 available, mainly for efficiency reasons. However, if PCRE is compiled
3704 with Unicode property support, and the PCRE_UCP option is set, the be-
3705 haviour is changed so that Unicode properties are used to determine
3706 character types, as follows:
3707
3708 \d any character that \p{Nd} matches (decimal digit)
3709 \s any character that \p{Z} matches, plus HT, LF, FF, CR
3710 \w any character that \p{L} or \p{N} matches, plus underscore
3711
3712 The upper case escapes match the inverse sets of characters. Note that
3713 \d matches only decimal digits, whereas \w matches any Unicode digit,
3714 as well as any Unicode letter, and underscore. Note also that PCRE_UCP
3715 affects \b, and \B because they are defined in terms of \w and \W.
3716 Matching these sequences is noticeably slower when PCRE_UCP is set.
3717
3718 The sequences \h, \H, \v, and \V are features that were added to Perl
3719 at release 5.10. In contrast to the other sequences, which match only
3720 ASCII characters by default, these always match certain high-valued
3721 codepoints in UTF-8 mode, whether or not PCRE_UCP is set. The horizon-
3722 tal space characters are:
3723
3724 U+0009 Horizontal tab
3725 U+0020 Space
3726 U+00A0 Non-break space
3727 U+1680 Ogham space mark
3728 U+180E Mongolian vowel separator
3729 U+2000 En quad
3730 U+2001 Em quad
3731 U+2002 En space
3732 U+2003 Em space
3733 U+2004 Three-per-em space
3734 U+2005 Four-per-em space
3735 U+2006 Six-per-em space
3736 U+2007 Figure space
3737 U+2008 Punctuation space
3738 U+2009 Thin space
3739 U+200A Hair space
3740 U+202F Narrow no-break space
3741 U+205F Medium mathematical space
3742 U+3000 Ideographic space
3743
3744 The vertical space characters are:
3745
3746 U+000A Linefeed
3747 U+000B Vertical tab
3748 U+000C Formfeed
3749 U+000D Carriage return
3750 U+0085 Next line
3751 U+2028 Line separator
3752 U+2029 Paragraph separator
3753
3754 Newline sequences
3755
3756 Outside a character class, by default, the escape sequence \R matches
3757 any Unicode newline sequence. In non-UTF-8 mode \R is equivalent to the
3758 following:
3759
3760 (?>\r\n|\n|\x0b|\f|\r|\x85)
3761
3762 This is an example of an "atomic group", details of which are given
3763 below. This particular group matches either the two-character sequence
3764 CR followed by LF, or one of the single characters LF (linefeed,
3765 U+000A), VT (vertical tab, U+000B), FF (formfeed, U+000C), CR (carriage
3766 return, U+000D), or NEL (next line, U+0085). The two-character sequence
3767 is treated as a single unit that cannot be split.
3768
3769 In UTF-8 mode, two additional characters whose codepoints are greater
3770 than 255 are added: LS (line separator, U+2028) and PS (paragraph sepa-
3771 rator, U+2029). Unicode character property support is not needed for
3772 these characters to be recognized.
3773
3774 It is possible to restrict \R to match only CR, LF, or CRLF (instead of
3775 the complete set of Unicode line endings) by setting the option
3776 PCRE_BSR_ANYCRLF either at compile time or when the pattern is matched.
3777 (BSR is an abbrevation for "backslash R".) This can be made the default
3778 when PCRE is built; if this is the case, the other behaviour can be
3779 requested via the PCRE_BSR_UNICODE option. It is also possible to
3780 specify these settings by starting a pattern string with one of the
3781 following sequences:
3782
3783 (*BSR_ANYCRLF) CR, LF, or CRLF only
3784 (*BSR_UNICODE) any Unicode newline sequence
3785
3786 These override the default and the options given to pcre_compile() or
3787 pcre_compile2(), but they can be overridden by options given to
3788 pcre_exec() or pcre_dfa_exec(). Note that these special settings, which
3789 are not Perl-compatible, are recognized only at the very start of a
3790 pattern, and that they must be in upper case. If more than one of them
3791 is present, the last one is used. They can be combined with a change of
3792 newline convention; for example, a pattern can start with:
3793
3794 (*ANY)(*BSR_ANYCRLF)
3795
3796 They can also be combined with the (*UTF8) or (*UCP) special sequences.
3797 Inside a character class, \R is treated as an unrecognized escape
3798 sequence, and so matches the letter "R" by default, but causes an error
3799 if PCRE_EXTRA is set.
3800
3801 Unicode character properties
3802
3803 When PCRE is built with Unicode character property support, three addi-
3804 tional escape sequences that match characters with specific properties
3805 are available. When not in UTF-8 mode, these sequences are of course
3806 limited to testing characters whose codepoints are less than 256, but
3807 they do work in this mode. The extra escape sequences are:
3808
3809 \p{xx} a character with the xx property
3810 \P{xx} a character without the xx property
3811 \X an extended Unicode sequence
3812
3813 The property names represented by xx above are limited to the Unicode
3814 script names, the general category properties, "Any", which matches any
3815 character (including newline), and some special PCRE properties
3816 (described in the next section). Other Perl properties such as "InMu-
3817 sicalSymbols" are not currently supported by PCRE. Note that \P{Any}
3818 does not match any characters, so always causes a match failure.
3819
3820 Sets of Unicode characters are defined as belonging to certain scripts.
3821 A character from one of these sets can be matched using a script name.
3822 For example:
3823
3824 \p{Greek}
3825 \P{Han}
3826
3827 Those that are not part of an identified script are lumped together as
3828 "Common". The current list of scripts is:
3829
3830 Arabic, Armenian, Avestan, Balinese, Bamum, Bengali, Bopomofo, Braille,
3831 Buginese, Buhid, Canadian_Aboriginal, Carian, Cham, Cherokee, Common,
3832 Coptic, Cuneiform, Cypriot, Cyrillic, Deseret, Devanagari, Egyp-
3833 tian_Hieroglyphs, Ethiopic, Georgian, Glagolitic, Gothic, Greek,
3834 Gujarati, Gurmukhi, Han, Hangul, Hanunoo, Hebrew, Hiragana, Impe-
3835 rial_Aramaic, Inherited, Inscriptional_Pahlavi, Inscriptional_Parthian,
3836 Javanese, Kaithi, Kannada, Katakana, Kayah_Li, Kharoshthi, Khmer, Lao,
3837 Latin, Lepcha, Limbu, Linear_B, Lisu, Lycian, Lydian, Malayalam,
3838 Meetei_Mayek, Mongolian, Myanmar, New_Tai_Lue, Nko, Ogham, Old_Italic,
3839 Old_Persian, Old_South_Arabian, Old_Turkic, Ol_Chiki, Oriya, Osmanya,
3840 Phags_Pa, Phoenician, Rejang, Runic, Samaritan, Saurashtra, Shavian,
3841 Sinhala, Sundanese, Syloti_Nagri, Syriac, Tagalog, Tagbanwa, Tai_Le,
3842 Tai_Tham, Tai_Viet, Tamil, Telugu, Thaana, Thai, Tibetan, Tifinagh,
3843 Ugaritic, Vai, Yi.
3844
3845 Each character has exactly one Unicode general category property, spec-
3846 ified by a two-letter abbreviation. For compatibility with Perl, nega-
3847 tion can be specified by including a circumflex between the opening
3848 brace and the property name. For example, \p{^Lu} is the same as
3849 \P{Lu}.
3850
3851 If only one letter is specified with \p or \P, it includes all the gen-
3852 eral category properties that start with that letter. In this case, in
3853 the absence of negation, the curly brackets in the escape sequence are
3854 optional; these two examples have the same effect:
3855
3856 \p{L}
3857 \pL
3858
3859 The following general category property codes are supported:
3860
3861 C Other
3862 Cc Control
3863 Cf Format
3864 Cn Unassigned
3865 Co Private use
3866 Cs Surrogate
3867
3868 L Letter
3869 Ll Lower case letter
3870 Lm Modifier letter
3871 Lo Other letter
3872 Lt Title case letter
3873 Lu Upper case letter
3874
3875 M Mark
3876 Mc Spacing mark
3877 Me Enclosing mark
3878 Mn Non-spacing mark
3879
3880 N Number
3881 Nd Decimal number
3882 Nl Letter number
3883 No Other number
3884
3885 P Punctuation
3886 Pc Connector punctuation
3887 Pd Dash punctuation
3888 Pe Close punctuation
3889 Pf Final punctuation
3890 Pi Initial punctuation
3891 Po Other punctuation
3892 Ps Open punctuation
3893
3894 S Symbol
3895 Sc Currency symbol
3896 Sk Modifier symbol
3897 Sm Mathematical symbol
3898 So Other symbol
3899
3900 Z Separator
3901 Zl Line separator
3902 Zp Paragraph separator
3903 Zs Space separator
3904
3905 The special property L& is also supported: it matches a character that
3906 has the Lu, Ll, or Lt property, in other words, a letter that is not
3907 classified as a modifier or "other".
3908
3909 The Cs (Surrogate) property applies only to characters in the range
3910 U+D800 to U+DFFF. Such characters are not valid in UTF-8 strings (see
3911 RFC 3629) and so cannot be tested by PCRE, unless UTF-8 validity check-
3912 ing has been turned off (see the discussion of PCRE_NO_UTF8_CHECK in
3913 the pcreapi page). Perl does not support the Cs property.
3914
3915 The long synonyms for property names that Perl supports (such as
3916 \p{Letter}) are not supported by PCRE, nor is it permitted to prefix
3917 any of these properties with "Is".
3918
3919 No character that is in the Unicode table has the Cn (unassigned) prop-
3920 erty. Instead, this property is assumed for any code point that is not
3921 in the Unicode table.
3922
3923 Specifying caseless matching does not affect these escape sequences.
3924 For example, \p{Lu} always matches only upper case letters.
3925
3926 The \X escape matches any number of Unicode characters that form an
3927 extended Unicode sequence. \X is equivalent to
3928
3929 (?>\PM\pM*)
3930
3931 That is, it matches a character without the "mark" property, followed
3932 by zero or more characters with the "mark" property, and treats the
3933 sequence as an atomic group (see below). Characters with the "mark"
3934 property are typically accents that affect the preceding character.
3935 None of them have codepoints less than 256, so in non-UTF-8 mode \X
3936 matches any one character.
3937
3938 Note that recent versions of Perl have changed \X to match what Unicode
3939 calls an "extended grapheme cluster", which has a more complicated def-
3940 inition.
3941
3942 Matching characters by Unicode property is not fast, because PCRE has
3943 to search a structure that contains data for over fifteen thousand
3944 characters. That is why the traditional escape sequences such as \d and
3945 \w do not use Unicode properties in PCRE by default, though you can
3946 make them do so by setting the PCRE_UCP option for pcre_compile() or by
3947 starting the pattern with (*UCP).
3948
3949 PCRE's additional properties
3950
3951 As well as the standard Unicode properties described in the previous
3952 section, PCRE supports four more that make it possible to convert tra-
3953 ditional escape sequences such as \w and \s and POSIX character classes
3954 to use Unicode properties. PCRE uses these non-standard, non-Perl prop-
3955 erties internally when PCRE_UCP is set. They are:
3956
3957 Xan Any alphanumeric character
3958 Xps Any POSIX space character
3959 Xsp Any Perl space character
3960 Xwd Any Perl "word" character
3961
3962 Xan matches characters that have either the L (letter) or the N (num-
3963 ber) property. Xps matches the characters tab, linefeed, vertical tab,
3964 formfeed, or carriage return, and any other character that has the Z
3965 (separator) property. Xsp is the same as Xps, except that vertical tab
3966 is excluded. Xwd matches the same characters as Xan, plus underscore.
3967
3968 Resetting the match start
3969
3970 The escape sequence \K causes any previously matched characters not to
3971 be included in the final matched sequence. For example, the pattern:
3972
3973 foo\Kbar
3974
3975 matches "foobar", but reports that it has matched "bar". This feature
3976 is similar to a lookbehind assertion (described below). However, in
3977 this case, the part of the subject before the real match does not have
3978 to be of fixed length, as lookbehind assertions do. The use of \K does
3979 not interfere with the setting of captured substrings. For example,
3980 when the pattern
3981
3982 (foo)\Kbar
3983
3984 matches "foobar", the first substring is still set to "foo".
3985
3986 Perl documents that the use of \K within assertions is "not well
3987 defined". In PCRE, \K is acted upon when it occurs inside positive
3988 assertions, but is ignored in negative assertions.
3989
3990 Simple assertions
3991
3992 The final use of backslash is for certain simple assertions. An asser-
3993 tion specifies a condition that has to be met at a particular point in
3994 a match, without consuming any characters from the subject string. The
3995 use of subpatterns for more complicated assertions is described below.
3996 The backslashed assertions are:
3997
3998 \b matches at a word boundary
3999 \B matches when not at a word boundary
4000 \A matches at the start of the subject
4001 \Z matches at the end of the subject
4002 also matches before a newline at the end of the subject
4003 \z matches only at the end of the subject
4004 \G matches at the first matching position in the subject
4005
4006 Inside a character class, \b has a different meaning; it matches the
4007 backspace character. If any other of these assertions appears in a
4008 character class, by default it matches the corresponding literal char-
4009 acter (for example, \B matches the letter B). However, if the
4010 PCRE_EXTRA option is set, an "invalid escape sequence" error is gener-
4011 ated instead.
4012
4013 A word boundary is a position in the subject string where the current
4014 character and the previous character do not both match \w or \W (i.e.
4015 one matches \w and the other matches \W), or the start or end of the
4016 string if the first or last character matches \w, respectively. In
4017 UTF-8 mode, the meanings of \w and \W can be changed by setting the
4018 PCRE_UCP option. When this is done, it also affects \b and \B. Neither
4019 PCRE nor Perl has a separate "start of word" or "end of word" metase-
4020 quence. However, whatever follows \b normally determines which it is.
4021 For example, the fragment \ba matches "a" at the start of a word.
4022
4023 The \A, \Z, and \z assertions differ from the traditional circumflex
4024 and dollar (described in the next section) in that they only ever match
4025 at the very start and end of the subject string, whatever options are
4026 set. Thus, they are independent of multiline mode. These three asser-
4027 tions are not affected by the PCRE_NOTBOL or PCRE_NOTEOL options, which
4028 affect only the behaviour of the circumflex and dollar metacharacters.
4029 However, if the startoffset argument of pcre_exec() is non-zero, indi-
4030 cating that matching is to start at a point other than the beginning of
4031 the subject, \A can never match. The difference between \Z and \z is
4032 that \Z matches before a newline at the end of the string as well as at
4033 the very end, whereas \z matches only at the end.
4034
4035 The \G assertion is true only when the current matching position is at
4036 the start point of the match, as specified by the startoffset argument
4037 of pcre_exec(). It differs from \A when the value of startoffset is
4038 non-zero. By calling pcre_exec() multiple times with appropriate argu-
4039 ments, you can mimic Perl's /g option, and it is in this kind of imple-
4040 mentation where \G can be useful.
4041
4042 Note, however, that PCRE's interpretation of \G, as the start of the
4043 current match, is subtly different from Perl's, which defines it as the
4044 end of the previous match. In Perl, these can be different when the
4045 previously matched string was empty. Because PCRE does just one match
4046 at a time, it cannot reproduce this behaviour.
4047
4048 If all the alternatives of a pattern begin with \G, the expression is
4049 anchored to the starting match position, and the "anchored" flag is set
4050 in the compiled regular expression.
4051
4052
4053 CIRCUMFLEX AND DOLLAR
4054
4055 Outside a character class, in the default matching mode, the circumflex
4056 character is an assertion that is true only if the current matching
4057 point is at the start of the subject string. If the startoffset argu-
4058 ment of pcre_exec() is non-zero, circumflex can never match if the
4059 PCRE_MULTILINE option is unset. Inside a character class, circumflex
4060 has an entirely different meaning (see below).
4061
4062 Circumflex need not be the first character of the pattern if a number
4063 of alternatives are involved, but it should be the first thing in each
4064 alternative in which it appears if the pattern is ever to match that
4065 branch. If all possible alternatives start with a circumflex, that is,
4066 if the pattern is constrained to match only at the start of the sub-
4067 ject, it is said to be an "anchored" pattern. (There are also other
4068 constructs that can cause a pattern to be anchored.)
4069
4070 A dollar character is an assertion that is true only if the current
4071 matching point is at the end of the subject string, or immediately
4072 before a newline at the end of the string (by default). Dollar need not
4073 be the last character of the pattern if a number of alternatives are
4074 involved, but it should be the last item in any branch in which it
4075 appears. Dollar has no special meaning in a character class.
4076
4077 The meaning of dollar can be changed so that it matches only at the
4078 very end of the string, by setting the PCRE_DOLLAR_ENDONLY option at
4079 compile time. This does not affect the \Z assertion.
4080
4081 The meanings of the circumflex and dollar characters are changed if the
4082 PCRE_MULTILINE option is set. When this is the case, a circumflex
4083 matches immediately after internal newlines as well as at the start of
4084 the subject string. It does not match after a newline that ends the
4085 string. A dollar matches before any newlines in the string, as well as
4086 at the very end, when PCRE_MULTILINE is set. When newline is specified
4087 as the two-character sequence CRLF, isolated CR and LF characters do
4088 not indicate newlines.
4089
4090 For example, the pattern /^abc$/ matches the subject string "def\nabc"
4091 (where \n represents a newline) in multiline mode, but not otherwise.
4092 Consequently, patterns that are anchored in single line mode because
4093 all branches start with ^ are not anchored in multiline mode, and a
4094 match for circumflex is possible when the startoffset argument of
4095 pcre_exec() is non-zero. The PCRE_DOLLAR_ENDONLY option is ignored if
4096 PCRE_MULTILINE is set.
4097
4098 Note that the sequences \A, \Z, and \z can be used to match the start
4099 and end of the subject in both modes, and if all branches of a pattern
4100 start with \A it is always anchored, whether or not PCRE_MULTILINE is
4101 set.
4102
4103
4104 FULL STOP (PERIOD, DOT) AND \N
4105
4106 Outside a character class, a dot in the pattern matches any one charac-
4107 ter in the subject string except (by default) a character that signi-
4108 fies the end of a line. In UTF-8 mode, the matched character may be
4109 more than one byte long.
4110
4111 When a line ending is defined as a single character, dot never matches
4112 that character; when the two-character sequence CRLF is used, dot does
4113 not match CR if it is immediately followed by LF, but otherwise it
4114 matches all characters (including isolated CRs and LFs). When any Uni-
4115 code line endings are being recognized, dot does not match CR or LF or
4116 any of the other line ending characters.
4117
4118 The behaviour of dot with regard to newlines can be changed. If the
4119 PCRE_DOTALL option is set, a dot matches any one character, without
4120 exception. If the two-character sequence CRLF is present in the subject
4121 string, it takes two dots to match it.
4122
4123 The handling of dot is entirely independent of the handling of circum-
4124 flex and dollar, the only relationship being that they both involve
4125 newlines. Dot has no special meaning in a character class.
4126
4127 The escape sequence \N behaves like a dot, except that it is not
4128 affected by the PCRE_DOTALL option. In other words, it matches any
4129 character except one that signifies the end of a line.
4130
4131
4132 MATCHING A SINGLE BYTE
4133
4134 Outside a character class, the escape sequence \C matches any one byte,
4135 both in and out of UTF-8 mode. Unlike a dot, it always matches any
4136 line-ending characters. The feature is provided in Perl in order to
4137 match individual bytes in UTF-8 mode. Because it breaks up UTF-8 char-
4138 acters into individual bytes, the rest of the string may start with a
4139 malformed UTF-8 character. For this reason, the \C escape sequence is
4140 best avoided.
4141
4142 PCRE does not allow \C to appear in lookbehind assertions (described
4143 below), because in UTF-8 mode this would make it impossible to calcu-
4144 late the length of the lookbehind.
4145
4146
4147 SQUARE BRACKETS AND CHARACTER CLASSES
4148
4149 An opening square bracket introduces a character class, terminated by a
4150 closing square bracket. A closing square bracket on its own is not spe-
4151 cial by default. However, if the PCRE_JAVASCRIPT_COMPAT option is set,
4152 a lone closing square bracket causes a compile-time error. If a closing
4153 square bracket is required as a member of the class, it should be the
4154 first data character in the class (after an initial circumflex, if
4155 present) or escaped with a backslash.
4156
4157 A character class matches a single character in the subject. In UTF-8
4158 mode, the character may be more than one byte long. A matched character
4159 must be in the set of characters defined by the class, unless the first
4160 character in the class definition is a circumflex, in which case the
4161 subject character must not be in the set defined by the class. If a
4162 circumflex is actually required as a member of the class, ensure it is
4163 not the first character, or escape it with a backslash.
4164
4165 For example, the character class [aeiou] matches any lower case vowel,
4166 while [^aeiou] matches any character that is not a lower case vowel.
4167 Note that a circumflex is just a convenient notation for specifying the
4168 characters that are in the class by enumerating those that are not. A
4169 class that starts with a circumflex is not an assertion; it still con-
4170 sumes a character from the subject string, and therefore it fails if
4171 the current pointer is at the end of the string.
4172
4173 In UTF-8 mode, characters with values greater than 255 can be included
4174 in a class as a literal string of bytes, or by using the \x{ escaping
4175 mechanism.
4176
4177 When caseless matching is set, any letters in a class represent both
4178 their upper case and lower case versions, so for example, a caseless
4179 [aeiou] matches "A" as well as "a", and a caseless [^aeiou] does not
4180 match "A", whereas a caseful version would. In UTF-8 mode, PCRE always
4181 understands the concept of case for characters whose values are less
4182 than 128, so caseless matching is always possible. For characters with
4183 higher values, the concept of case is supported if PCRE is compiled
4184 with Unicode property support, but not otherwise. If you want to use
4185 caseless matching in UTF8-mode for characters 128 and above, you must
4186 ensure that PCRE is compiled with Unicode property support as well as
4187 with UTF-8 support.
4188
4189 Characters that might indicate line breaks are never treated in any
4190 special way when matching character classes, whatever line-ending
4191 sequence is in use, and whatever setting of the PCRE_DOTALL and
4192 PCRE_MULTILINE options is used. A class such as [^a] always matches one
4193 of these characters.
4194
4195 The minus (hyphen) character can be used to specify a range of charac-
4196 ters in a character class. For example, [d-m] matches any letter
4197 between d and m, inclusive. If a minus character is required in a
4198 class, it must be escaped with a backslash or appear in a position
4199 where it cannot be interpreted as indicating a range, typically as the
4200 first or last character in the class.
4201
4202 It is not possible to have the literal character "]" as the end charac-
4203 ter of a range. A pattern such as [W-]46] is interpreted as a class of
4204 two characters ("W" and "-") followed by a literal string "46]", so it
4205 would match "W46]" or "-46]". However, if the "]" is escaped with a
4206 backslash it is interpreted as the end of range, so [W-\]46] is inter-
4207 preted as a class containing a range followed by two other characters.
4208 The octal or hexadecimal representation of "]" can also be used to end
4209 a range.
4210
4211 Ranges operate in the collating sequence of character values. They can
4212 also be used for characters specified numerically, for example
4213 [\000-\037]. In UTF-8 mode, ranges can include characters whose values
4214 are greater than 255, for example [\x{100}-\x{2ff}].
4215
4216 If a range that includes letters is used when caseless matching is set,
4217 it matches the letters in either case. For example, [W-c] is equivalent
4218 to [][\\^_`wxyzabc], matched caselessly, and in non-UTF-8 mode, if
4219 character tables for a French locale are in use, [\xc8-\xcb] matches
4220 accented E characters in both cases. In UTF-8 mode, PCRE supports the
4221 concept of case for characters with values greater than 128 only when
4222 it is compiled with Unicode property support.
4223
4224 The character escape sequences \d, \D, \h, \H, \p, \P, \s, \S, \v, \V,
4225 \w, and \W may appear in a character class, and add the characters that
4226 they match to the class. For example, [\dABCDEF] matches any hexadeci-
4227 mal digit. In UTF-8 mode, the PCRE_UCP option affects the meanings of
4228 \d, \s, \w and their upper case partners, just as it does when they
4229 appear outside a character class, as described in the section entitled
4230 "Generic character types" above. The escape sequence \b has a different
4231 meaning inside a character class; it matches the backspace character.
4232 The sequences \B, \N, \R, and \X are not special inside a character
4233 class. Like any other unrecognized escape sequences, they are treated
4234 as the literal characters "B", "N", "R", and "X" by default, but cause
4235 an error if the PCRE_EXTRA option is set.
4236
4237 A circumflex can conveniently be used with the upper case character
4238 types to specify a more restricted set of characters than the matching
4239 lower case type. For example, the class [^\W_] matches any letter or
4240 digit, but not underscore, whereas [\w] includes underscore. A positive
4241 character class should be read as "something OR something OR ..." and a
4242 negative class as "NOT something AND NOT something AND NOT ...".
4243
4244 The only metacharacters that are recognized in character classes are
4245 backslash, hyphen (only where it can be interpreted as specifying a
4246 range), circumflex (only at the start), opening square bracket (only
4247 when it can be interpreted as introducing a POSIX class name - see the
4248 next section), and the terminating closing square bracket. However,
4249 escaping other non-alphanumeric characters does no harm.
4250
4251
4252 POSIX CHARACTER CLASSES
4253
4254 Perl supports the POSIX notation for character classes. This uses names
4255 enclosed by [: and :] within the enclosing square brackets. PCRE also
4256 supports this notation. For example,
4257
4258 [01[:alpha:]%]
4259
4260 matches "0", "1", any alphabetic character, or "%". The supported class
4261 names are:
4262
4263 alnum letters and digits
4264 alpha letters
4265 ascii character codes 0 - 127
4266 blank space or tab only
4267 cntrl control characters
4268 digit decimal digits (same as \d)
4269 graph printing characters, excluding space
4270 lower lower case letters
4271 print printing characters, including space
4272 punct printing characters, excluding letters and digits and space
4273 space white space (not quite the same as \s)
4274 upper upper case letters
4275 word "word" characters (same as \w)
4276 xdigit hexadecimal digits
4277
4278 The "space" characters are HT (9), LF (10), VT (11), FF (12), CR (13),
4279 and space (32). Notice that this list includes the VT character (code
4280 11). This makes "space" different to \s, which does not include VT (for
4281 Perl compatibility).
4282
4283 The name "word" is a Perl extension, and "blank" is a GNU extension
4284 from Perl 5.8. Another Perl extension is negation, which is indicated
4285 by a ^ character after the colon. For example,
4286
4287 [12[:^digit:]]
4288
4289 matches "1", "2", or any non-digit. PCRE (and Perl) also recognize the
4290 POSIX syntax [.ch.] and [=ch=] where "ch" is a "collating element", but
4291 these are not supported, and an error is given if they are encountered.
4292
4293 By default, in UTF-8 mode, characters with values greater than 128 do
4294 not match any of the POSIX character classes. However, if the PCRE_UCP
4295 option is passed to pcre_compile(), some of the classes are changed so
4296 that Unicode character properties are used. This is achieved by replac-
4297 ing the POSIX classes by other sequences, as follows:
4298
4299 [:alnum:] becomes \p{Xan}
4300 [:alpha:] becomes \p{L}
4301 [:blank:] becomes \h
4302 [:digit:] becomes \p{Nd}
4303 [:lower:] becomes \p{Ll}
4304 [:space:] becomes \p{Xps}
4305 [:upper:] becomes \p{Lu}
4306 [:word:] becomes \p{Xwd}
4307
4308 Negated versions, such as [:^alpha:] use \P instead of \p. The other
4309 POSIX classes are unchanged, and match only characters with code points
4310 less than 128.
4311
4312
4313 VERTICAL BAR
4314
4315 Vertical bar characters are used to separate alternative patterns. For
4316 example, the pattern
4317
4318 gilbert|sullivan
4319
4320 matches either "gilbert" or "sullivan". Any number of alternatives may
4321 appear, and an empty alternative is permitted (matching the empty
4322 string). The matching process tries each alternative in turn, from left
4323 to right, and the first one that succeeds is used. If the alternatives
4324 are within a subpattern (defined below), "succeeds" means matching the
4325 rest of the main pattern as well as the alternative in the subpattern.
4326
4327
4328 INTERNAL OPTION SETTING
4329
4330 The settings of the PCRE_CASELESS, PCRE_MULTILINE, PCRE_DOTALL, and
4331 PCRE_EXTENDED options (which are Perl-compatible) can be changed from
4332 within the pattern by a sequence of Perl option letters enclosed
4333 between "(?" and ")". The option letters are
4334
4335 i for PCRE_CASELESS
4336 m for PCRE_MULTILINE
4337 s for PCRE_DOTALL
4338 x for PCRE_EXTENDED
4339
4340 For example, (?im) sets caseless, multiline matching. It is also possi-
4341 ble to unset these options by preceding the letter with a hyphen, and a
4342 combined setting and unsetting such as (?im-sx), which sets PCRE_CASE-
4343 LESS and PCRE_MULTILINE while unsetting PCRE_DOTALL and PCRE_EXTENDED,
4344 is also permitted. If a letter appears both before and after the
4345 hyphen, the option is unset.
4346
4347 The PCRE-specific options PCRE_DUPNAMES, PCRE_UNGREEDY, and PCRE_EXTRA
4348 can be changed in the same way as the Perl-compatible options by using
4349 the characters J, U and X respectively.
4350
4351 When one of these option changes occurs at top level (that is, not
4352 inside subpattern parentheses), the change applies to the remainder of
4353 the pattern that follows. If the change is placed right at the start of
4354 a pattern, PCRE extracts it into the global options (and it will there-
4355 fore show up in data extracted by the pcre_fullinfo() function).
4356
4357 An option change within a subpattern (see below for a description of
4358 subpatterns) affects only that part of the subpattern that follows it,
4359 so
4360
4361 (a(?i)b)c
4362
4363 matches abc and aBc and no other strings (assuming PCRE_CASELESS is not
4364 used). By this means, options can be made to have different settings
4365 in different parts of the pattern. Any changes made in one alternative
4366 do carry on into subsequent branches within the same subpattern. For
4367 example,
4368
4369 (a(?i)b|c)
4370
4371 matches "ab", "aB", "c", and "C", even though when matching "C" the
4372 first branch is abandoned before the option setting. This is because
4373 the effects of option settings happen at compile time. There would be
4374 some very weird behaviour otherwise.
4375
4376 Note: There are other PCRE-specific options that can be set by the
4377 application when the compile or match functions are called. In some
4378 cases the pattern can contain special leading sequences such as (*CRLF)
4379 to override what the application has set or what has been defaulted.
4380 Details are given in the section entitled "Newline sequences" above.
4381 There are also the (*UTF8) and (*UCP) leading sequences that can be
4382 used to set UTF-8 and Unicode property modes; they are equivalent to
4383 setting the PCRE_UTF8 and the PCRE_UCP options, respectively.
4384
4385
4386 SUBPATTERNS
4387
4388 Subpatterns are delimited by parentheses (round brackets), which can be
4389 nested. Turning part of a pattern into a subpattern does two things:
4390
4391 1. It localizes a set of alternatives. For example, the pattern
4392
4393 cat(aract|erpillar|)
4394
4395 matches "cataract", "caterpillar", or "cat". Without the parentheses,
4396 it would match "cataract", "erpillar" or an empty string.
4397
4398 2. It sets up the subpattern as a capturing subpattern. This means
4399 that, when the whole pattern matches, that portion of the subject
4400 string that matched the subpattern is passed back to the caller via the
4401 ovector argument of pcre_exec(). Opening parentheses are counted from
4402 left to right (starting from 1) to obtain numbers for the capturing
4403 subpatterns. For example, if the string "the red king" is matched
4404 against the pattern
4405
4406 the ((red|white) (king|queen))
4407
4408 the captured substrings are "red king", "red", and "king", and are num-
4409 bered 1, 2, and 3, respectively.
4410
4411 The fact that plain parentheses fulfil two functions is not always
4412 helpful. There are often times when a grouping subpattern is required
4413 without a capturing requirement. If an opening parenthesis is followed
4414 by a question mark and a colon, the subpattern does not do any captur-
4415 ing, and is not counted when computing the number of any subsequent
4416 capturing subpatterns. For example, if the string "the white queen" is
4417 matched against the pattern
4418
4419 the ((?:red|white) (king|queen))
4420
4421 the captured substrings are "white queen" and "queen", and are numbered
4422 1 and 2. The maximum number of capturing subpatterns is 65535.
4423
4424 As a convenient shorthand, if any option settings are required at the
4425 start of a non-capturing subpattern, the option letters may appear
4426 between the "?" and the ":". Thus the two patterns
4427
4428 (?i:saturday|sunday)
4429 (?:(?i)saturday|sunday)
4430
4431 match exactly the same set of strings. Because alternative branches are
4432 tried from left to right, and options are not reset until the end of
4433 the subpattern is reached, an option setting in one branch does affect
4434 subsequent branches, so the above patterns match "SUNDAY" as well as
4435 "Saturday".
4436
4437
4438 DUPLICATE SUBPATTERN NUMBERS
4439
4440 Perl 5.10 introduced a feature whereby each alternative in a subpattern
4441 uses the same numbers for its capturing parentheses. Such a subpattern
4442 starts with (?| and is itself a non-capturing subpattern. For example,
4443 consider this pattern:
4444
4445 (?|(Sat)ur|(Sun))day
4446
4447 Because the two alternatives are inside a (?| group, both sets of cap-
4448 turing parentheses are numbered one. Thus, when the pattern matches,
4449 you can look at captured substring number one, whichever alternative
4450 matched. This construct is useful when you want to capture part, but
4451 not all, of one of a number of alternatives. Inside a (?| group, paren-
4452 theses are numbered as usual, but the number is reset at the start of
4453 each branch. The numbers of any capturing parentheses that follow the
4454 subpattern start after the highest number used in any branch. The fol-
4455 lowing example is taken from the Perl documentation. The numbers under-
4456 neath show in which buffer the captured content will be stored.
4457
4458 # before ---------------branch-reset----------- after
4459 / ( a ) (?| x ( y ) z | (p (q) r) | (t) u (v) ) ( z ) /x
4460 # 1 2 2 3 2 3 4
4461
4462 A back reference to a numbered subpattern uses the most recent value
4463 that is set for that number by any subpattern. The following pattern
4464 matches "abcabc" or "defdef":
4465
4466 /(?|(abc)|(def))\1/
4467
4468 In contrast, a recursive or "subroutine" call to a numbered subpattern
4469 always refers to the first one in the pattern with the given number.
4470 The following pattern matches "abcabc" or "defabc":
4471
4472 /(?|(abc)|(def))(?1)/
4473
4474 If a condition test for a subpattern's having matched refers to a non-
4475 unique number, the test is true if any of the subpatterns of that num-
4476 ber have matched.
4477
4478 An alternative approach to using this "branch reset" feature is to use
4479 duplicate named subpatterns, as described in the next section.
4480
4481
4482 NAMED SUBPATTERNS
4483
4484 Identifying capturing parentheses by number is simple, but it can be
4485 very hard to keep track of the numbers in complicated regular expres-
4486 sions. Furthermore, if an expression is modified, the numbers may
4487 change. To help with this difficulty, PCRE supports the naming of sub-
4488 patterns. This feature was not added to Perl until release 5.10. Python
4489 had the feature earlier, and PCRE introduced it at release 4.0, using
4490 the Python syntax. PCRE now supports both the Perl and the Python syn-
4491 tax. Perl allows identically numbered subpatterns to have different
4492 names, but PCRE does not.
4493
4494 In PCRE, a subpattern can be named in one of three ways: (?<name>...)
4495 or (?'name'...) as in Perl, or (?P<name>...) as in Python. References
4496 to capturing parentheses from other parts of the pattern, such as back
4497 references, recursion, and conditions, can be made by name as well as
4498 by number.
4499
4500 Names consist of up to 32 alphanumeric characters and underscores.
4501 Named capturing parentheses are still allocated numbers as well as
4502 names, exactly as if the names were not present. The PCRE API provides
4503 function calls for extracting the name-to-number translation table from
4504 a compiled pattern. There is also a convenience function for extracting
4505 a captured substring by name.
4506
4507 By default, a name must be unique within a pattern, but it is possible
4508 to relax this constraint by setting the PCRE_DUPNAMES option at compile
4509 time. (Duplicate names are also always permitted for subpatterns with
4510 the same number, set up as described in the previous section.) Dupli-
4511 cate names can be useful for patterns where only one instance of the
4512 named parentheses can match. Suppose you want to match the name of a
4513 weekday, either as a 3-letter abbreviation or as the full name, and in
4514 both cases you want to extract the abbreviation. This pattern (ignoring
4515 the line breaks) does the job:
4516
4517 (?<DN>Mon|Fri|Sun)(?:day)?|
4518 (?<DN>Tue)(?:sday)?|
4519 (?<DN>Wed)(?:nesday)?|
4520 (?<DN>Thu)(?:rsday)?|
4521 (?<DN>Sat)(?:urday)?
4522
4523 There are five capturing substrings, but only one is ever set after a
4524 match. (An alternative way of solving this problem is to use a "branch
4525 reset" subpattern, as described in the previous section.)
4526
4527 The convenience function for extracting the data by name returns the
4528 substring for the first (and in this example, the only) subpattern of
4529 that name that matched. This saves searching to find which numbered
4530 subpattern it was.
4531
4532 If you make a back reference to a non-unique named subpattern from
4533 elsewhere in the pattern, the one that corresponds to the first occur-
4534 rence of the name is used. In the absence of duplicate numbers (see the
4535 previous section) this is the one with the lowest number. If you use a
4536 named reference in a condition test (see the section about conditions
4537 below), either to check whether a subpattern has matched, or to check
4538 for recursion, all subpatterns with the same name are tested. If the
4539 condition is true for any one of them, the overall condition is true.
4540 This is the same behaviour as testing by number. For further details of
4541 the interfaces for handling named subpatterns, see the pcreapi documen-
4542 tation.
4543
4544 Warning: You cannot use different names to distinguish between two sub-
4545 patterns with the same number because PCRE uses only the numbers when
4546 matching. For this reason, an error is given at compile time if differ-
4547 ent names are given to subpatterns with the same number. However, you
4548 can give the same name to subpatterns with the same number, even when
4549 PCRE_DUPNAMES is not set.
4550
4551
4552 REPETITION
4553
4554 Repetition is specified by quantifiers, which can follow any of the
4555 following items:
4556
4557 a literal data character
4558 the dot metacharacter
4559 the \C escape sequence
4560 the \X escape sequence (in UTF-8 mode with Unicode properties)
4561 the \R escape sequence
4562 an escape such as \d or \pL that matches a single character
4563 a character class
4564 a back reference (see next section)
4565 a parenthesized subpattern (including assertions)
4566 a recursive or "subroutine" call to a subpattern
4567
4568 The general repetition quantifier specifies a minimum and maximum num-
4569 ber of permitted matches, by giving the two numbers in curly brackets
4570 (braces), separated by a comma. The numbers must be less than 65536,
4571 and the first must be less than or equal to the second. For example:
4572
4573 z{2,4}
4574
4575 matches "zz", "zzz", or "zzzz". A closing brace on its own is not a
4576 special character. If the second number is omitted, but the comma is
4577 present, there is no upper limit; if the second number and the comma
4578 are both omitted, the quantifier specifies an exact number of required
4579 matches. Thus
4580
4581 [aeiou]{3,}
4582
4583 matches at least 3 successive vowels, but may match many more, while
4584
4585 \d{8}
4586
4587 matches exactly 8 digits. An opening curly bracket that appears in a
4588 position where a quantifier is not allowed, or one that does not match
4589 the syntax of a quantifier, is taken as a literal character. For exam-
4590 ple, {,6} is not a quantifier, but a literal string of four characters.
4591
4592 In UTF-8 mode, quantifiers apply to UTF-8 characters rather than to
4593 individual bytes. Thus, for example, \x{100}{2} matches two UTF-8 char-
4594 acters, each of which is represented by a two-byte sequence. Similarly,
4595 when Unicode property support is available, \X{3} matches three Unicode
4596 extended sequences, each of which may be several bytes long (and they
4597 may be of different lengths).
4598
4599 The quantifier {0} is permitted, causing the expression to behave as if
4600 the previous item and the quantifier were not present. This may be use-
4601 ful for subpatterns that are referenced as subroutines from elsewhere
4602 in the pattern (but see also the section entitled "Defining subpatterns
4603 for use by reference only" below). Items other than subpatterns that
4604 have a {0} quantifier are omitted from the compiled pattern.
4605
4606 For convenience, the three most common quantifiers have single-charac-
4607 ter abbreviations:
4608
4609 * is equivalent to {0,}
4610 + is equivalent to {1,}
4611 ? is equivalent to {0,1}
4612
4613 It is possible to construct infinite loops by following a subpattern
4614 that can match no characters with a quantifier that has no upper limit,
4615 for example:
4616
4617 (a?)*
4618
4619 Earlier versions of Perl and PCRE used to give an error at compile time
4620 for such patterns. However, because there are cases where this can be
4621 useful, such patterns are now accepted, but if any repetition of the
4622 subpattern does in fact match no characters, the loop is forcibly bro-
4623 ken.
4624
4625 By default, the quantifiers are "greedy", that is, they match as much
4626 as possible (up to the maximum number of permitted times), without
4627 causing the rest of the pattern to fail. The classic example of where
4628 this gives problems is in trying to match comments in C programs. These
4629 appear between /* and */ and within the comment, individual * and /
4630 characters may appear. An attempt to match C comments by applying the
4631 pattern
4632
4633 /\*.*\*/
4634
4635 to the string
4636
4637 /* first comment */ not comment /* second comment */
4638
4639 fails, because it matches the entire string owing to the greediness of
4640 the .* item.
4641
4642 However, if a quantifier is followed by a question mark, it ceases to
4643 be greedy, and instead matches the minimum number of times possible, so
4644 the pattern
4645
4646 /\*.*?\*/
4647
4648 does the right thing with the C comments. The meaning of the various
4649 quantifiers is not otherwise changed, just the preferred number of
4650 matches. Do not confuse this use of question mark with its use as a
4651 quantifier in its own right. Because it has two uses, it can sometimes
4652 appear doubled, as in
4653
4654 \d??\d
4655
4656 which matches one digit by preference, but can match two if that is the
4657 only way the rest of the pattern matches.
4658
4659 If the PCRE_UNGREEDY option is set (an option that is not available in
4660 Perl), the quantifiers are not greedy by default, but individual ones
4661 can be made greedy by following them with a question mark. In other
4662 words, it inverts the default behaviour.
4663
4664 When a parenthesized subpattern is quantified with a minimum repeat
4665 count that is greater than 1 or with a limited maximum, more memory is
4666 required for the compiled pattern, in proportion to the size of the
4667 minimum or maximum.
4668
4669 If a pattern starts with .* or .{0,} and the PCRE_DOTALL option (equiv-
4670 alent to Perl's /s) is set, thus allowing the dot to match newlines,
4671 the pattern is implicitly anchored, because whatever follows will be
4672 tried against every character position in the subject string, so there
4673 is no point in retrying the overall match at any position after the
4674 first. PCRE normally treats such a pattern as though it were preceded
4675 by \A.
4676
4677 In cases where it is known that the subject string contains no new-
4678 lines, it is worth setting PCRE_DOTALL in order to obtain this opti-
4679 mization, or alternatively using ^ to indicate anchoring explicitly.
4680
4681 However, there is one situation where the optimization cannot be used.
4682 When .* is inside capturing parentheses that are the subject of a back
4683 reference elsewhere in the pattern, a match at the start may fail where
4684 a later one succeeds. Consider, for example:
4685
4686 (.*)abc\1
4687
4688 If the subject is "xyz123abc123" the match point is the fourth charac-
4689 ter. For this reason, such a pattern is not implicitly anchored.
4690
4691 When a capturing subpattern is repeated, the value captured is the sub-
4692 string that matched the final iteration. For example, after
4693
4694 (tweedle[dume]{3}\s*)+
4695
4696 has matched "tweedledum tweedledee" the value of the captured substring
4697 is "tweedledee". However, if there are nested capturing subpatterns,
4698 the corresponding captured values may have been set in previous itera-
4699 tions. For example, after
4700
4701 /(a|(b))+/
4702
4703 matches "aba" the value of the second captured substring is "b".
4704
4705
4706 ATOMIC GROUPING AND POSSESSIVE QUANTIFIERS
4707
4708 With both maximizing ("greedy") and minimizing ("ungreedy" or "lazy")
4709 repetition, failure of what follows normally causes the repeated item
4710 to be re-evaluated to see if a different number of repeats allows the
4711 rest of the pattern to match. Sometimes it is useful to prevent this,
4712 either to change the nature of the match, or to cause it fail earlier
4713 than it otherwise might, when the author of the pattern knows there is
4714 no point in carrying on.
4715
4716 Consider, for example, the pattern \d+foo when applied to the subject
4717 line
4718
4719 123456bar
4720
4721 After matching all 6 digits and then failing to match "foo", the normal
4722 action of the matcher is to try again with only 5 digits matching the
4723 \d+ item, and then with 4, and so on, before ultimately failing.
4724 "Atomic grouping" (a term taken from Jeffrey Friedl's book) provides
4725 the means for specifying that once a subpattern has matched, it is not
4726 to be re-evaluated in this way.
4727
4728 If we use atomic grouping for the previous example, the matcher gives
4729 up immediately on failing to match "foo" the first time. The notation
4730 is a kind of special parenthesis, starting with (?> as in this example:
4731
4732 (?>\d+)foo
4733
4734 This kind of parenthesis "locks up" the part of the pattern it con-
4735 tains once it has matched, and a failure further into the pattern is
4736 prevented from backtracking into it. Backtracking past it to previous
4737 items, however, works as normal.
4738
4739 An alternative description is that a subpattern of this type matches
4740 the string of characters that an identical standalone pattern would
4741 match, if anchored at the current point in the subject string.
4742
4743 Atomic grouping subpatterns are not capturing subpatterns. Simple cases
4744 such as the above example can be thought of as a maximizing repeat that
4745 must swallow everything it can. So, while both \d+ and \d+? are pre-
4746 pared to adjust the number of digits they match in order to make the
4747 rest of the pattern match, (?>\d+) can only match an entire sequence of
4748 digits.
4749
4750 Atomic groups in general can of course contain arbitrarily complicated
4751 subpatterns, and can be nested. However, when the subpattern for an
4752 atomic group is just a single repeated item, as in the example above, a
4753 simpler notation, called a "possessive quantifier" can be used. This
4754 consists of an additional + character following a quantifier. Using
4755 this notation, the previous example can be rewritten as
4756
4757 \d++foo
4758
4759 Note that a possessive quantifier can be used with an entire group, for
4760 example:
4761
4762 (abc|xyz){2,3}+
4763
4764 Possessive quantifiers are always greedy; the setting of the
4765 PCRE_UNGREEDY option is ignored. They are a convenient notation for the
4766 simpler forms of atomic group. However, there is no difference in the
4767 meaning of a possessive quantifier and the equivalent atomic group,
4768 though there may be a performance difference; possessive quantifiers
4769 should be slightly faster.
4770
4771 The possessive quantifier syntax is an extension to the Perl 5.8 syn-
4772 tax. Jeffrey Friedl originated the idea (and the name) in the first
4773 edition of his book. Mike McCloskey liked it, so implemented it when he
4774 built Sun's Java package, and PCRE copied it from there. It ultimately
4775 found its way into Perl at release 5.10.
4776
4777 PCRE has an optimization that automatically "possessifies" certain sim-
4778 ple pattern constructs. For example, the sequence A+B is treated as
4779 A++B because there is no point in backtracking into a sequence of A's
4780 when B must follow.
4781
4782 When a pattern contains an unlimited repeat inside a subpattern that
4783 can itself be repeated an unlimited number of times, the use of an
4784 atomic group is the only way to avoid some failing matches taking a
4785 very long time indeed. The pattern
4786
4787 (\D+|<\d+>)*[!?]
4788
4789 matches an unlimited number of substrings that either consist of non-
4790 digits, or digits enclosed in <>, followed by either ! or ?. When it
4791 matches, it runs quickly. However, if it is applied to
4792
4793 aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
4794
4795 it takes a long time before reporting failure. This is because the
4796 string can be divided between the internal \D+ repeat and the external
4797 * repeat in a large number of ways, and all have to be tried. (The
4798 example uses [!?] rather than a single character at the end, because
4799 both PCRE and Perl have an optimization that allows for fast failure
4800 when a single character is used. They remember the last single charac-
4801 ter that is required for a match, and fail early if it is not present
4802 in the string.) If the pattern is changed so that it uses an atomic
4803 group, like this:
4804
4805 ((?>\D+)|<\d+>)*[!?]
4806
4807 sequences of non-digits cannot be broken, and failure happens quickly.
4808
4809
4810 BACK REFERENCES
4811
4812 Outside a character class, a backslash followed by a digit greater than
4813 0 (and possibly further digits) is a back reference to a capturing sub-
4814 pattern earlier (that is, to its left) in the pattern, provided there
4815 have been that many previous capturing left parentheses.
4816
4817 However, if the decimal number following the backslash is less than 10,
4818 it is always taken as a back reference, and causes an error only if
4819 there are not that many capturing left parentheses in the entire pat-
4820 tern. In other words, the parentheses that are referenced need not be
4821 to the left of the reference for numbers less than 10. A "forward back
4822 reference" of this type can make sense when a repetition is involved
4823 and the subpattern to the right has participated in an earlier itera-
4824 tion.
4825
4826 It is not possible to have a numerical "forward back reference" to a
4827 subpattern whose number is 10 or more using this syntax because a
4828 sequence such as \50 is interpreted as a character defined in octal.
4829 See the subsection entitled "Non-printing characters" above for further
4830 details of the handling of digits following a backslash. There is no
4831 such problem when named parentheses are used. A back reference to any
4832 subpattern is possible using named parentheses (see below).
4833
4834 Another way of avoiding the ambiguity inherent in the use of digits
4835 following a backslash is to use the \g escape sequence. This escape
4836 must be followed by an unsigned number or a negative number, optionally
4837 enclosed in braces. These examples are all identical:
4838
4839 (ring), \1
4840 (ring), \g1
4841 (ring), \g{1}
4842
4843 An unsigned number specifies an absolute reference without the ambigu-
4844 ity that is present in the older syntax. It is also useful when literal
4845 digits follow the reference. A negative number is a relative reference.
4846 Consider this example:
4847
4848 (abc(def)ghi)\g{-1}
4849
4850 The sequence \g{-1} is a reference to the most recently started captur-
4851 ing subpattern before \g, that is, is it equivalent to \2 in this exam-
4852 ple. Similarly, \g{-2} would be equivalent to \1. The use of relative
4853 references can be helpful in long patterns, and also in patterns that
4854 are created by joining together fragments that contain references
4855 within themselves.
4856
4857 A back reference matches whatever actually matched the capturing sub-
4858 pattern in the current subject string, rather than anything matching
4859 the subpattern itself (see "Subpatterns as subroutines" below for a way
4860 of doing that). So the pattern
4861
4862 (sens|respons)e and \1ibility
4863
4864 matches "sense and sensibility" and "response and responsibility", but
4865 not "sense and responsibility". If caseful matching is in force at the
4866 time of the back reference, the case of letters is relevant. For exam-
4867 ple,
4868
4869 ((?i)rah)\s+\1
4870
4871 matches "rah rah" and "RAH RAH", but not "RAH rah", even though the
4872 original capturing subpattern is matched caselessly.
4873
4874 There are several different ways of writing back references to named
4875 subpatterns. The .NET syntax \k{name} and the Perl syntax \k<name> or
4876 \k'name' are supported, as is the Python syntax (?P=name). Perl 5.10's
4877 unified back reference syntax, in which \g can be used for both numeric
4878 and named references, is also supported. We could rewrite the above
4879 example in any of the following ways:
4880
4881 (?<p1>(?i)rah)\s+\k<p1>
4882 (?'p1'(?i)rah)\s+\k{p1}
4883 (?P<p1>(?i)rah)\s+(?P=p1)
4884 (?<p1>(?i)rah)\s+\g{p1}
4885
4886 A subpattern that is referenced by name may appear in the pattern
4887 before or after the reference.
4888
4889 There may be more than one back reference to the same subpattern. If a
4890 subpattern has not actually been used in a particular match, any back
4891 references to it always fail by default. For example, the pattern
4892
4893 (a|(bc))\2
4894
4895 always fails if it starts to match "a" rather than "bc". However, if
4896 the PCRE_JAVASCRIPT_COMPAT option is set at compile time, a back refer-
4897 ence to an unset value matches an empty string.
4898
4899 Because there may be many capturing parentheses in a pattern, all dig-
4900 its following a backslash are taken as part of a potential back refer-
4901 ence number. If the pattern continues with a digit character, some
4902 delimiter must be used to terminate the back reference. If the
4903 PCRE_EXTENDED option is set, this can be whitespace. Otherwise, the \g{
4904 syntax or an empty comment (see "Comments" below) can be used.
4905
4906 Recursive back references
4907
4908 A back reference that occurs inside the parentheses to which it refers
4909 fails when the subpattern is first used, so, for example, (a\1) never
4910 matches. However, such references can be useful inside repeated sub-
4911 patterns. For example, the pattern
4912
4913 (a|b\1)+
4914
4915 matches any number of "a"s and also "aba", "ababbaa" etc. At each iter-
4916 ation of the subpattern, the back reference matches the character
4917 string corresponding to the previous iteration. In order for this to
4918 work, the pattern must be such that the first iteration does not need
4919 to match the back reference. This can be done using alternation, as in
4920 the example above, or by a quantifier with a minimum of zero.
4921
4922 Back references of this type cause the group that they reference to be
4923 treated as an atomic group. Once the whole group has been matched, a
4924 subsequent matching failure cannot cause backtracking into the middle
4925 of the group.
4926
4927
4928 ASSERTIONS
4929
4930 An assertion is a test on the characters following or preceding the
4931 current matching point that does not actually consume any characters.
4932 The simple assertions coded as \b, \B, \A, \G, \Z, \z, ^ and $ are
4933 described above.
4934
4935 More complicated assertions are coded as subpatterns. There are two
4936 kinds: those that look ahead of the current position in the subject
4937 string, and those that look behind it. An assertion subpattern is
4938 matched in the normal way, except that it does not cause the current
4939 matching position to be changed.
4940
4941 Assertion subpatterns are not capturing subpatterns. If such an asser-
4942 tion contains capturing subpatterns within it, these are counted for
4943 the purposes of numbering the capturing subpatterns in the whole pat-
4944 tern. However, substring capturing is carried out only for positive
4945 assertions, because it does not make sense for negative assertions.
4946
4947 For compatibility with Perl, assertion subpatterns may be repeated;
4948 though it makes no sense to assert the same thing several times, the
4949 side effect of capturing parentheses may occasionally be useful. In
4950 practice, there only three cases:
4951
4952 (1) If the quantifier is {0}, the assertion is never obeyed during
4953 matching. However, it may contain internal capturing parenthesized
4954 groups that are called from elsewhere via the subroutine mechanism.
4955
4956 (2) If quantifier is {0,n} where n is greater than zero, it is treated
4957 as if it were {0,1}. At run time, the rest of the pattern match is
4958 tried with and without the assertion, the order depending on the greed-
4959 iness of the quantifier.
4960
4961 (3) If the minimum repetition is greater than zero, the quantifier is
4962 ignored. The assertion is obeyed just once when encountered during
4963 matching.
4964
4965 Lookahead assertions
4966
4967 Lookahead assertions start with (?= for positive assertions and (?! for
4968 negative assertions. For example,
4969
4970 \w+(?=;)
4971
4972 matches a word followed by a semicolon, but does not include the semi-
4973 colon in the match, and
4974
4975 foo(?!bar)
4976
4977 matches any occurrence of "foo" that is not followed by "bar". Note
4978 that the apparently similar pattern
4979
4980 (?!foo)bar
4981
4982 does not find an occurrence of "bar" that is preceded by something
4983 other than "foo"; it finds any occurrence of "bar" whatsoever, because
4984 the assertion (?!foo) is always true when the next three characters are
4985 "bar". A lookbehind assertion is needed to achieve the other effect.
4986
4987 If you want to force a matching failure at some point in a pattern, the
4988 most convenient way to do it is with (?!) because an empty string
4989 always matches, so an assertion that requires there not to be an empty
4990 string must always fail. The backtracking control verb (*FAIL) or (*F)
4991 is a synonym for (?!).
4992
4993 Lookbehind assertions
4994
4995 Lookbehind assertions start with (?<= for positive assertions and (?<!
4996 for negative assertions. For example,
4997
4998 (?<!foo)bar
4999
5000 does find an occurrence of "bar" that is not preceded by "foo". The
5001 contents of a lookbehind assertion are restricted such that all the
5002 strings it matches must have a fixed length. However, if there are sev-
5003 eral top-level alternatives, they do not all have to have the same
5004 fixed length. Thus
5005
5006 (?<=bullock|donkey)
5007
5008 is permitted, but
5009
5010 (?<!dogs?|cats?)
5011
5012 causes an error at compile time. Branches that match different length
5013 strings are permitted only at the top level of a lookbehind assertion.
5014 This is an extension compared with Perl, which requires all branches to
5015 match the same length of string. An assertion such as
5016
5017 (?<=ab(c|de))
5018
5019 is not permitted, because its single top-level branch can match two
5020 different lengths, but it is acceptable to PCRE if rewritten to use two
5021 top-level branches:
5022
5023 (?<=abc|abde)
5024
5025 In some cases, the escape sequence \K (see above) can be used instead
5026 of a lookbehind assertion to get round the fixed-length restriction.
5027
5028 The implementation of lookbehind assertions is, for each alternative,
5029 to temporarily move the current position back by the fixed length and
5030 then try to match. If there are insufficient characters before the cur-
5031 rent position, the assertion fails.
5032
5033 PCRE does not allow the \C escape (which matches a single byte in UTF-8
5034 mode) to appear in lookbehind assertions, because it makes it impossi-
5035 ble to calculate the length of the lookbehind. The \X and \R escapes,
5036 which can match different numbers of bytes, are also not permitted.
5037
5038 "Subroutine" calls (see below) such as (?2) or (?&X) are permitted in
5039 lookbehinds, as long as the subpattern matches a fixed-length string.
5040 Recursion, however, is not supported.
5041
5042 Possessive quantifiers can be used in conjunction with lookbehind
5043 assertions to specify efficient matching of fixed-length strings at the
5044 end of subject strings. Consider a simple pattern such as
5045
5046 abcd$
5047
5048 when applied to a long string that does not match. Because matching
5049 proceeds from left to right, PCRE will look for each "a" in the subject
5050 and then see if what follows matches the rest of the pattern. If the
5051 pattern is specified as
5052
5053 ^.*abcd$
5054
5055 the initial .* matches the entire string at first, but when this fails
5056 (because there is no following "a"), it backtracks to match all but the
5057 last character, then all but the last two characters, and so on. Once
5058 again the search for "a" covers the entire string, from right to left,
5059 so we are no better off. However, if the pattern is written as
5060
5061 ^.*+(?<=abcd)
5062
5063 there can be no backtracking for the .*+ item; it can match only the
5064 entire string. The subsequent lookbehind assertion does a single test
5065 on the last four characters. If it fails, the match fails immediately.
5066 For long strings, this approach makes a significant difference to the
5067 processing time.
5068
5069 Using multiple assertions
5070
5071 Several assertions (of any sort) may occur in succession. For example,
5072
5073 (?<=\d{3})(?<!999)foo
5074
5075 matches "foo" preceded by three digits that are not "999". Notice that
5076 each of the assertions is applied independently at the same point in
5077 the subject string. First there is a check that the previous three
5078 characters are all digits, and then there is a check that the same
5079 three characters are not "999". This pattern does not match "foo" pre-
5080 ceded by six characters, the first of which are digits and the last
5081 three of which are not "999". For example, it doesn't match "123abc-
5082 foo". A pattern to do that is
5083
5084 (?<=\d{3}...)(?<!999)foo
5085
5086 This time the first assertion looks at the preceding six characters,
5087 checking that the first three are digits, and then the second assertion
5088 checks that the preceding three characters are not "999".
5089
5090 Assertions can be nested in any combination. For example,
5091
5092 (?<=(?<!foo)bar)baz
5093
5094 matches an occurrence of "baz" that is preceded by "bar" which in turn
5095 is not preceded by "foo", while
5096
5097 (?<=\d{3}(?!999)...)foo
5098
5099 is another pattern that matches "foo" preceded by three digits and any
5100 three characters that are not "999".
5101
5102
5103 CONDITIONAL SUBPATTERNS
5104
5105 It is possible to cause the matching process to obey a subpattern con-
5106 ditionally or to choose between two alternative subpatterns, depending
5107 on the result of an assertion, or whether a specific capturing subpat-
5108 tern has already been matched. The two possible forms of conditional
5109 subpattern are:
5110
5111 (?(condition)yes-pattern)
5112 (?(condition)yes-pattern|no-pattern)
5113
5114 If the condition is satisfied, the yes-pattern is used; otherwise the
5115 no-pattern (if present) is used. If there are more than two alterna-
5116 tives in the subpattern, a compile-time error occurs. Each of the two
5117 alternatives may itself contain nested subpatterns of any form, includ-
5118 ing conditional subpatterns; the restriction to two alternatives
5119 applies only at the level of the condition. This pattern fragment is an
5120 example where the alternatives are complex:
5121
5122 (?(1) (A|B|C) | (D | (?(2)E|F) | E) )
5123
5124
5125 There are four kinds of condition: references to subpatterns, refer-
5126 ences to recursion, a pseudo-condition called DEFINE, and assertions.
5127
5128 Checking for a used subpattern by number
5129
5130 If the text between the parentheses consists of a sequence of digits,
5131 the condition is true if a capturing subpattern of that number has pre-
5132 viously matched. If there is more than one capturing subpattern with
5133 the same number (see the earlier section about duplicate subpattern
5134 numbers), the condition is true if any of them have matched. An alter-
5135 native notation is to precede the digits with a plus or minus sign. In
5136 this case, the subpattern number is relative rather than absolute. The
5137 most recently opened parentheses can be referenced by (?(-1), the next
5138 most recent by (?(-2), and so on. Inside loops it can also make sense
5139 to refer to subsequent groups. The next parentheses to be opened can be
5140 referenced as (?(+1), and so on. (The value zero in any of these forms
5141 is not used; it provokes a compile-time error.)
5142
5143 Consider the following pattern, which contains non-significant white
5144 space to make it more readable (assume the PCRE_EXTENDED option) and to
5145 divide it into three parts for ease of discussion:
5146
5147 ( \( )? [^()]+ (?(1) \) )
5148
5149 The first part matches an optional opening parenthesis, and if that
5150 character is present, sets it as the first captured substring. The sec-
5151 ond part matches one or more characters that are not parentheses. The
5152 third part is a conditional subpattern that tests whether or not the
5153 first set of parentheses matched. If they did, that is, if subject
5154 started with an opening parenthesis, the condition is true, and so the
5155 yes-pattern is executed and a closing parenthesis is required. Other-
5156 wise, since no-pattern is not present, the subpattern matches nothing.
5157 In other words, this pattern matches a sequence of non-parentheses,
5158 optionally enclosed in parentheses.
5159
5160 If you were embedding this pattern in a larger one, you could use a
5161 relative reference:
5162
5163 ...other stuff... ( \( )? [^()]+ (?(-1) \) ) ...
5164
5165 This makes the fragment independent of the parentheses in the larger
5166 pattern.
5167
5168 Checking for a used subpattern by name
5169
5170 Perl uses the syntax (?(<name>)...) or (?('name')...) to test for a
5171 used subpattern by name. For compatibility with earlier versions of
5172 PCRE, which had this facility before Perl, the syntax (?(name)...) is
5173 also recognized. However, there is a possible ambiguity with this syn-
5174 tax, because subpattern names may consist entirely of digits. PCRE
5175 looks first for a named subpattern; if it cannot find one and the name
5176 consists entirely of digits, PCRE looks for a subpattern of that num-
5177 ber, which must be greater than zero. Using subpattern names that con-
5178 sist entirely of digits is not recommended.
5179
5180 Rewriting the above example to use a named subpattern gives this:
5181
5182 (?<OPEN> \( )? [^()]+ (?(<OPEN>) \) )
5183
5184 If the name used in a condition of this kind is a duplicate, the test
5185 is applied to all subpatterns of the same name, and is true if any one
5186 of them has matched.
5187
5188 Checking for pattern recursion
5189
5190 If the condition is the string (R), and there is no subpattern with the
5191 name R, the condition is true if a recursive call to the whole pattern
5192 or any subpattern has been made. If digits or a name preceded by amper-
5193 sand follow the letter R, for example:
5194
5195 (?(R3)...) or (?(R&name)...)
5196
5197 the condition is true if the most recent recursion is into a subpattern
5198 whose number or name is given. This condition does not check the entire
5199 recursion stack. If the name used in a condition of this kind is a
5200 duplicate, the test is applied to all subpatterns of the same name, and
5201 is true if any one of them is the most recent recursion.
5202
5203 At "top level", all these recursion test conditions are false. The
5204 syntax for recursive patterns is described below.
5205
5206 Defining subpatterns for use by reference only
5207
5208 If the condition is the string (DEFINE), and there is no subpattern
5209 with the name DEFINE, the condition is always false. In this case,
5210 there may be only one alternative in the subpattern. It is always
5211 skipped if control reaches this point in the pattern; the idea of
5212 DEFINE is that it can be used to define "subroutines" that can be ref-
5213 erenced from elsewhere. (The use of "subroutines" is described below.)
5214 For example, a pattern to match an IPv4 address such as
5215 "192.168.23.245" could be written like this (ignore whitespace and line
5216 breaks):
5217
5218 (?(DEFINE) (?<byte> 2[0-4]\d | 25[0-5] | 1\d\d | [1-9]?\d) )
5219 \b (?&byte) (\.(?&byte)){3} \b
5220
5221 The first part of the pattern is a DEFINE group inside which a another
5222 group named "byte" is defined. This matches an individual component of
5223 an IPv4 address (a number less than 256). When matching takes place,
5224 this part of the pattern is skipped because DEFINE acts like a false
5225 condition. The rest of the pattern uses references to the named group
5226 to match the four dot-separated components of an IPv4 address, insist-
5227 ing on a word boundary at each end.
5228
5229 Assertion conditions
5230
5231 If the condition is not in any of the above formats, it must be an
5232 assertion. This may be a positive or negative lookahead or lookbehind
5233 assertion. Consider this pattern, again containing non-significant
5234 white space, and with the two alternatives on the second line:
5235
5236 (?(?=[^a-z]*[a-z])
5237 \d{2}-[a-z]{3}-\d{2} | \d{2}-\d{2}-\d{2} )
5238
5239 The condition is a positive lookahead assertion that matches an
5240 optional sequence of non-letters followed by a letter. In other words,
5241 it tests for the presence of at least one letter in the subject. If a
5242 letter is found, the subject is matched against the first alternative;
5243 otherwise it is matched against the second. This pattern matches
5244 strings in one of the two forms dd-aaa-dd or dd-dd-dd, where aaa are
5245 letters and dd are digits.
5246
5247
5248 COMMENTS
5249
5250 There are two ways of including comments in patterns that are processed
5251 by PCRE. In both cases, the start of the comment must not be in a char-
5252 acter class, nor in the middle of any other sequence of related charac-
5253 ters such as (?: or a subpattern name or number. The characters that
5254 make up a comment play no part in the pattern matching.
5255
5256 The sequence (?# marks the start of a comment that continues up to the
5257 next closing parenthesis. Nested parentheses are not permitted. If the
5258 PCRE_EXTENDED option is set, an unescaped # character also introduces a
5259 comment, which in this case continues to immediately after the next
5260 newline character or character sequence in the pattern. Which charac-
5261 ters are interpreted as newlines is controlled by the options passed to
5262 pcre_compile() or by a special sequence at the start of the pattern, as
5263 described in the section entitled "Newline conventions" above. Note
5264 that the end of this type of comment is a literal newline sequence in
5265 the pattern; escape sequences that happen to represent a newline do not
5266 count. For example, consider this pattern when PCRE_EXTENDED is set,
5267 and the default newline convention is in force:
5268
5269 abc #comment \n still comment
5270
5271 On encountering the # character, pcre_compile() skips along, looking
5272 for a newline in the pattern. The sequence \n is still literal at this
5273 stage, so it does not terminate the comment. Only an actual character
5274 with the code value 0x0a (the default newline) does so.
5275
5276
5277 RECURSIVE PATTERNS
5278
5279 Consider the problem of matching a string in parentheses, allowing for
5280 unlimited nested parentheses. Without the use of recursion, the best
5281 that can be done is to use a pattern that matches up to some fixed
5282 depth of nesting. It is not possible to handle an arbitrary nesting
5283 depth.
5284
5285 For some time, Perl has provided a facility that allows regular expres-
5286 sions to recurse (amongst other things). It does this by interpolating
5287 Perl code in the expression at run time, and the code can refer to the
5288 expression itself. A Perl pattern using code interpolation to solve the
5289 parentheses problem can be created like this:
5290
5291 $re = qr{\( (?: (?>[^()]+) | (?p{$re}) )* \)}x;
5292
5293 The (?p{...}) item interpolates Perl code at run time, and in this case
5294 refers recursively to the pattern in which it appears.
5295
5296 Obviously, PCRE cannot support the interpolation of Perl code. Instead,
5297 it supports special syntax for recursion of the entire pattern, and
5298 also for individual subpattern recursion. After its introduction in
5299 PCRE and Python, this kind of recursion was subsequently introduced
5300 into Perl at release 5.10.
5301
5302 A special item that consists of (? followed by a number greater than
5303 zero and a closing parenthesis is a recursive call of the subpattern of
5304 the given number, provided that it occurs inside that subpattern. (If
5305 not, it is a "subroutine" call, which is described in the next sec-
5306 tion.) The special item (?R) or (?0) is a recursive call of the entire
5307 regular expression.
5308
5309 This PCRE pattern solves the nested parentheses problem (assume the
5310 PCRE_EXTENDED option is set so that white space is ignored):
5311
5312 \( ( [^()]++ | (?R) )* \)
5313
5314 First it matches an opening parenthesis. Then it matches any number of
5315 substrings which can either be a sequence of non-parentheses, or a
5316 recursive match of the pattern itself (that is, a correctly parenthe-
5317 sized substring). Finally there is a closing parenthesis. Note the use
5318 of a possessive quantifier to avoid backtracking into sequences of non-
5319 parentheses.
5320
5321 If this were part of a larger pattern, you would not want to recurse
5322 the entire pattern, so instead you could use this:
5323
5324 ( \( ( [^()]++ | (?1) )* \) )
5325
5326 We have put the pattern into parentheses, and caused the recursion to
5327 refer to them instead of the whole pattern.
5328
5329 In a larger pattern, keeping track of parenthesis numbers can be
5330 tricky. This is made easier by the use of relative references. Instead
5331 of (?1) in the pattern above you can write (?-2) to refer to the second
5332 most recently opened parentheses preceding the recursion. In other
5333 words, a negative number counts capturing parentheses leftwards from
5334 the point at which it is encountered.
5335
5336 It is also possible to refer to subsequently opened parentheses, by
5337 writing references such as (?+2). However, these cannot be recursive
5338 because the reference is not inside the parentheses that are refer-
5339 enced. They are always "subroutine" calls, as described in the next
5340 section.
5341
5342 An alternative approach is to use named parentheses instead. The Perl
5343 syntax for this is (?&name); PCRE's earlier syntax (?P>name) is also
5344 supported. We could rewrite the above example as follows:
5345
5346 (?<pn> \( ( [^()]++ | (?&pn) )* \) )
5347
5348 If there is more than one subpattern with the same name, the earliest
5349 one is used.
5350
5351 This particular example pattern that we have been looking at contains
5352 nested unlimited repeats, and so the use of a possessive quantifier for
5353 matching strings of non-parentheses is important when applying the pat-
5354 tern to strings that do not match. For example, when this pattern is
5355 applied to
5356
5357 (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa()
5358
5359 it yields "no match" quickly. However, if a possessive quantifier is
5360 not used, the match runs for a very long time indeed because there are
5361 so many different ways the + and * repeats can carve up the subject,
5362 and all have to be tested before failure can be reported.
5363
5364 At the end of a match, the values of capturing parentheses are those
5365 from the outermost level. If you want to obtain intermediate values, a
5366 callout function can be used (see below and the pcrecallout documenta-
5367 tion). If the pattern above is matched against
5368
5369 (ab(cd)ef)
5370
5371 the value for the inner capturing parentheses (numbered 2) is "ef",
5372 which is the last value taken on at the top level. If a capturing sub-
5373 pattern is not matched at the top level, its final value is unset, even
5374 if it is (temporarily) set at a deeper level.
5375
5376 If there are more than 15 capturing parentheses in a pattern, PCRE has
5377 to obtain extra memory to store data during a recursion, which it does
5378 by using pcre_malloc, freeing it via pcre_free afterwards. If no memory
5379 can be obtained, the match fails with the PCRE_ERROR_NOMEMORY error.
5380
5381 Do not confuse the (?R) item with the condition (R), which tests for
5382 recursion. Consider this pattern, which matches text in angle brack-
5383 ets, allowing for arbitrary nesting. Only digits are allowed in nested
5384 brackets (that is, when recursing), whereas any characters are permit-
5385 ted at the outer level.
5386
5387 < (?: (?(R) \d++ | [^<>]*+) | (?R)) * >
5388
5389 In this pattern, (?(R) is the start of a conditional subpattern, with
5390 two different alternatives for the recursive and non-recursive cases.
5391 The (?R) item is the actual recursive call.
5392
5393 Recursion difference from Perl
5394
5395 In PCRE (like Python, but unlike Perl), a recursive subpattern call is
5396 always treated as an atomic group. That is, once it has matched some of
5397 the subject string, it is never re-entered, even if it contains untried
5398 alternatives and there is a subsequent matching failure. This can be
5399 illustrated by the following pattern, which purports to match a palin-
5400 dromic string that contains an odd number of characters (for example,
5401 "a", "aba", "abcba", "abcdcba"):
5402
5403 ^(.|(.)(?1)\2)$
5404
5405 The idea is that it either matches a single character, or two identical
5406 characters surrounding a sub-palindrome. In Perl, this pattern works;
5407 in PCRE it does not if the pattern is longer than three characters.
5408 Consider the subject string "abcba":
5409
5410 At the top level, the first character is matched, but as it is not at
5411 the end of the string, the first alternative fails; the second alterna-
5412 tive is taken and the recursion kicks in. The recursive call to subpat-
5413 tern 1 successfully matches the next character ("b"). (Note that the
5414 beginning and end of line tests are not part of the recursion).
5415
5416 Back at the top level, the next character ("c") is compared with what
5417 subpattern 2 matched, which was "a". This fails. Because the recursion
5418 is treated as an atomic group, there are now no backtracking points,
5419 and so the entire match fails. (Perl is able, at this point, to re-
5420 enter the recursion and try the second alternative.) However, if the
5421 pattern is written with the alternatives in the other order, things are
5422 different:
5423
5424 ^((.)(?1)\2|.)$
5425
5426 This time, the recursing alternative is tried first, and continues to
5427 recurse until it runs out of characters, at which point the recursion
5428 fails. But this time we do have another alternative to try at the
5429 higher level. That is the big difference: in the previous case the
5430 remaining alternative is at a deeper recursion level, which PCRE cannot
5431 use.
5432
5433 To change the pattern so that it matches all palindromic strings, not
5434 just those with an odd number of characters, it is tempting to change
5435 the pattern to this:
5436
5437 ^((.)(?1)\2|.?)$
5438
5439 Again, this works in Perl, but not in PCRE, and for the same reason.
5440 When a deeper recursion has matched a single character, it cannot be
5441 entered again in order to match an empty string. The solution is to
5442 separate the two cases, and write out the odd and even cases as alter-
5443 natives at the higher level:
5444
5445 ^(?:((.)(?1)\2|)|((.)(?3)\4|.))
5446
5447 If you want to match typical palindromic phrases, the pattern has to
5448 ignore all non-word characters, which can be done like this:
5449
5450 ^\W*+(?:((.)\W*+(?1)\W*+\2|)|((.)\W*+(?3)\W*+\4|\W*+.\W*+))\W*+$
5451
5452 If run with the PCRE_CASELESS option, this pattern matches phrases such
5453 as "A man, a plan, a canal: Panama!" and it works well in both PCRE and
5454 Perl. Note the use of the possessive quantifier *+ to avoid backtrack-
5455 ing into sequences of non-word characters. Without this, PCRE takes a
5456 great deal longer (ten times or more) to match typical phrases, and
5457 Perl takes so long that you think it has gone into a loop.
5458
5459 WARNING: The palindrome-matching patterns above work only if the sub-
5460 ject string does not start with a palindrome that is shorter than the
5461 entire string. For example, although "abcba" is correctly matched, if
5462 the subject is "ababa", PCRE finds the palindrome "aba" at the start,
5463 then fails at top level because the end of the string does not follow.
5464 Once again, it cannot jump back into the recursion to try other alter-
5465 natives, so the entire match fails.
5466
5467
5468 SUBPATTERNS AS SUBROUTINES
5469
5470 If the syntax for a recursive subpattern reference (either by number or
5471 by name) is used outside the parentheses to which it refers, it oper-
5472 ates like a subroutine in a programming language. The "called" subpat-
5473 tern may be defined before or after the reference. A numbered reference
5474 can be absolute or relative, as in these examples:
5475
5476 (...(absolute)...)...(?2)...
5477 (...(relative)...)...(?-1)...
5478 (...(?+1)...(relative)...
5479
5480 An earlier example pointed out that the pattern
5481
5482 (sens|respons)e and \1ibility
5483
5484 matches "sense and sensibility" and "response and responsibility", but
5485 not "sense and responsibility". If instead the pattern
5486
5487 (sens|respons)e and (?1)ibility
5488
5489 is used, it does match "sense and responsibility" as well as the other
5490 two strings. Another example is given in the discussion of DEFINE
5491 above.
5492
5493 Like recursive subpatterns, a subroutine call is always treated as an
5494 atomic group. That is, once it has matched some of the subject string,
5495 it is never re-entered, even if it contains untried alternatives and
5496 there is a subsequent matching failure. Any capturing parentheses that
5497 are set during the subroutine call revert to their previous values
5498 afterwards.
5499
5500 When a subpattern is used as a subroutine, processing options such as
5501 case-independence are fixed when the subpattern is defined. They cannot
5502 be changed for different calls. For example, consider this pattern:
5503
5504 (abc)(?i:(?-1))
5505
5506 It matches "abcabc". It does not match "abcABC" because the change of
5507 processing option does not affect the called subpattern.
5508
5509
5510 ONIGURUMA SUBROUTINE SYNTAX
5511
5512 For compatibility with Oniguruma, the non-Perl syntax \g followed by a
5513 name or a number enclosed either in angle brackets or single quotes, is
5514 an alternative syntax for referencing a subpattern as a subroutine,
5515 possibly recursively. Here are two of the examples used above, rewrit-
5516 ten using this syntax:
5517
5518 (?<pn> \( ( (?>[^()]+) | \g<pn> )* \) )
5519 (sens|respons)e and \g'1'ibility
5520
5521 PCRE supports an extension to Oniguruma: if a number is preceded by a
5522 plus or a minus sign it is taken as a relative reference. For example:
5523
5524 (abc)(?i:\g<-1>)
5525
5526 Note that \g{...} (Perl syntax) and \g<...> (Oniguruma syntax) are not
5527 synonymous. The former is a back reference; the latter is a subroutine
5528 call.
5529
5530
5531 CALLOUTS
5532
5533 Perl has a feature whereby using the sequence (?{...}) causes arbitrary
5534 Perl code to be obeyed in the middle of matching a regular expression.
5535 This makes it possible, amongst other things, to extract different sub-
5536 strings that match the same pair of parentheses when there is a repeti-
5537 tion.
5538
5539 PCRE provides a similar feature, but of course it cannot obey arbitrary
5540 Perl code. The feature is called "callout". The caller of PCRE provides
5541 an external function by putting its entry point in the global variable
5542 pcre_callout. By default, this variable contains NULL, which disables
5543 all calling out.
5544
5545 Within a regular expression, (?C) indicates the points at which the
5546 external function is to be called. If you want to identify different
5547 callout points, you can put a number less than 256 after the letter C.
5548 The default value is zero. For example, this pattern has two callout
5549 points:
5550
5551 (?C1)abc(?C2)def
5552
5553 If the PCRE_AUTO_CALLOUT flag is passed to pcre_compile(), callouts are
5554 automatically installed before each item in the pattern. They are all
5555 numbered 255.
5556
5557 During matching, when PCRE reaches a callout point (and pcre_callout is
5558 set), the external function is called. It is provided with the number
5559 of the callout, the position in the pattern, and, optionally, one item
5560 of data originally supplied by the caller of pcre_exec(). The callout
5561 function may cause matching to proceed, to backtrack, or to fail alto-
5562 gether. A complete description of the interface to the callout function
5563 is given in the pcrecallout documentation.
5564
5565
5566 BACKTRACKING CONTROL
5567
5568 Perl 5.10 introduced a number of "Special Backtracking Control Verbs",
5569 which are described in the Perl documentation as "experimental and sub-
5570 ject to change or removal in a future version of Perl". It goes on to
5571 say: "Their usage in production code should be noted to avoid problems
5572 during upgrades." The same remarks apply to the PCRE features described
5573 in this section.
5574
5575 Since these verbs are specifically related to backtracking, most of
5576 them can be used only when the pattern is to be matched using
5577 pcre_exec(), which uses a backtracking algorithm. With the exception of
5578 (*FAIL), which behaves like a failing negative assertion, they cause an
5579 error if encountered by pcre_dfa_exec().
5580
5581 If any of these verbs are used in an assertion or subroutine subpattern
5582 (including recursive subpatterns), their effect is confined to that
5583 subpattern; it does not extend to the surrounding pattern, with one
5584 exception: a *MARK that is encountered in a positive assertion is
5585 passed back (compare capturing parentheses in assertions). Note that
5586 such subpatterns are processed as anchored at the point where they are
5587 tested.
5588
5589 The new verbs make use of what was previously invalid syntax: an open-
5590 ing parenthesis followed by an asterisk. They are generally of the form
5591 (*VERB) or (*VERB:NAME). Some may take either form, with differing be-
5592 haviour, depending on whether or not an argument is present. An name is
5593 a sequence of letters, digits, and underscores. If the name is empty,
5594 that is, if the closing parenthesis immediately follows the colon, the
5595 effect is as if the colon were not there. Any number of these verbs may
5596 occur in a pattern.
5597
5598 PCRE contains some optimizations that are used to speed up matching by
5599 running some checks at the start of each match attempt. For example, it
5600 may know the minimum length of matching subject, or that a particular
5601 character must be present. When one of these optimizations suppresses
5602 the running of a match, any included backtracking verbs will not, of
5603 course, be processed. You can suppress the start-of-match optimizations
5604 by setting the PCRE_NO_START_OPTIMIZE option when calling pcre_com-
5605 pile() or pcre_exec(), or by starting the pattern with (*NO_START_OPT).
5606
5607 Verbs that act immediately
5608
5609 The following verbs act as soon as they are encountered. They may not
5610 be followed by a name.
5611
5612 (*ACCEPT)
5613
5614 This verb causes the match to end successfully, skipping the remainder
5615 of the pattern. When inside a recursion, only the innermost pattern is
5616 ended immediately. If (*ACCEPT) is inside capturing parentheses, the
5617 data so far is captured. (This feature was added to PCRE at release
5618 8.00.) For example:
5619
5620 A((?:A|B(*ACCEPT)|C)D)
5621
5622 This matches "AB", "AAD", or "ACD"; when it matches "AB", "B" is cap-
5623 tured by the outer parentheses.
5624
5625 (*FAIL) or (*F)
5626
5627 This verb causes the match to fail, forcing backtracking to occur. It
5628 is equivalent to (?!) but easier to read. The Perl documentation notes
5629 that it is probably useful only when combined with (?{}) or (??{}).
5630 Those are, of course, Perl features that are not present in PCRE. The
5631 nearest equivalent is the callout feature, as for example in this pat-
5632 tern:
5633
5634 a+(?C)(*FAIL)
5635
5636 A match with the string "aaaa" always fails, but the callout is taken
5637 before each backtrack happens (in this example, 10 times).
5638
5639 Recording which path was taken
5640
5641 There is one verb whose main purpose is to track how a match was
5642 arrived at, though it also has a secondary use in conjunction with
5643 advancing the match starting point (see (*SKIP) below).
5644
5645 (*MARK:NAME) or (*:NAME)
5646
5647 A name is always required with this verb. There may be as many
5648 instances of (*MARK) as you like in a pattern, and their names do not
5649 have to be unique.
5650
5651 When a match succeeds, the name of the last-encountered (*MARK) is
5652 passed back to the caller via the pcre_extra data structure, as
5653 described in the section on pcre_extra in the pcreapi documentation. No
5654 data is returned for a partial match. Here is an example of pcretest
5655 output, where the /K modifier requests the retrieval and outputting of
5656 (*MARK) data:
5657
5658 /X(*MARK:A)Y|X(*MARK:B)Z/K
5659 XY
5660 0: XY
5661 MK: A
5662 XZ
5663 0: XZ
5664 MK: B
5665
5666 The (*MARK) name is tagged with "MK:" in this output, and in this exam-
5667 ple it indicates which of the two alternatives matched. This is a more
5668 efficient way of obtaining this information than putting each alterna-
5669 tive in its own capturing parentheses.
5670
5671 If (*MARK) is encountered in a positive assertion, its name is recorded
5672 and passed back if it is the last-encountered. This does not happen for
5673 negative assetions.
5674
5675 A name may also be returned after a failed match if the final path
5676 through the pattern involves (*MARK). However, unless (*MARK) used in
5677 conjunction with (*COMMIT), this is unlikely to happen for an unan-
5678 chored pattern because, as the starting point for matching is advanced,
5679 the final check is often with an empty string, causing a failure before
5680 (*MARK) is reached. For example:
5681
5682 /X(*MARK:A)Y|X(*MARK:B)Z/K
5683 XP
5684 No match
5685
5686 There are three potential starting points for this match (starting with
5687 X, starting with P, and with an empty string). If the pattern is
5688 anchored, the result is different:
5689
5690 /^X(*MARK:A)Y|^X(*MARK:B)Z/K
5691 XP
5692 No match, mark = B
5693
5694 PCRE's start-of-match optimizations can also interfere with this. For
5695 example, if, as a result of a call to pcre_study(), it knows the mini-
5696 mum subject length for a match, a shorter subject will not be scanned
5697 at all.
5698
5699 Note that similar anomalies (though different in detail) exist in Perl,
5700 no doubt for the same reasons. The use of (*MARK) data after a failed
5701 match of an unanchored pattern is not recommended, unless (*COMMIT) is
5702 involved.
5703
5704 Verbs that act after backtracking
5705
5706 The following verbs do nothing when they are encountered. Matching con-
5707 tinues with what follows, but if there is no subsequent match, causing
5708 a backtrack to the verb, a failure is forced. That is, backtracking
5709 cannot pass to the left of the verb. However, when one of these verbs
5710 appears inside an atomic group, its effect is confined to that group,
5711 because once the group has been matched, there is never any backtrack-
5712 ing into it. In this situation, backtracking can "jump back" to the
5713 left of the entire atomic group. (Remember also, as stated above, that
5714 this localization also applies in subroutine calls and assertions.)
5715
5716 These verbs differ in exactly what kind of failure occurs when back-
5717 tracking reaches them.
5718
5719 (*COMMIT)
5720
5721 This verb, which may not be followed by a name, causes the whole match
5722 to fail outright if the rest of the pattern does not match. Even if the
5723 pattern is unanchored, no further attempts to find a match by advancing
5724 the starting point take place. Once (*COMMIT) has been passed,
5725 pcre_exec() is committed to finding a match at the current starting
5726 point, or not at all. For example:
5727
5728 a+(*COMMIT)b
5729
5730 This matches "xxaab" but not "aacaab". It can be thought of as a kind
5731 of dynamic anchor, or "I've started, so I must finish." The name of the
5732 most recently passed (*MARK) in the path is passed back when (*COMMIT)
5733 forces a match failure.
5734
5735 Note that (*COMMIT) at the start of a pattern is not the same as an
5736 anchor, unless PCRE's start-of-match optimizations are turned off, as
5737 shown in this pcretest example:
5738
5739 /(*COMMIT)abc/
5740 xyzabc
5741 0: abc
5742 xyzabc\Y
5743 No match
5744
5745 PCRE knows that any match must start with "a", so the optimization
5746 skips along the subject to "a" before running the first match attempt,
5747 which succeeds. When the optimization is disabled by the \Y escape in
5748 the second subject, the match starts at "x" and so the (*COMMIT) causes
5749 it to fail without trying any other starting points.
5750
5751 (*PRUNE) or (*PRUNE:NAME)
5752
5753 This verb causes the match to fail at the current starting position in
5754 the subject if the rest of the pattern does not match. If the pattern
5755 is unanchored, the normal "bumpalong" advance to the next starting
5756 character then happens. Backtracking can occur as usual to the left of
5757 (*PRUNE), before it is reached, or when matching to the right of
5758 (*PRUNE), but if there is no match to the right, backtracking cannot
5759 cross (*PRUNE). In simple cases, the use of (*PRUNE) is just an alter-
5760 native to an atomic group or possessive quantifier, but there are some
5761 uses of (*PRUNE) that cannot be expressed in any other way. The behav-
5762 iour of (*PRUNE:NAME) is the same as (*MARK:NAME)(*PRUNE) when the
5763 match fails completely; the name is passed back if this is the final
5764 attempt. (*PRUNE:NAME) does not pass back a name if the match suc-
5765 ceeds. In an anchored pattern (*PRUNE) has the same effect as (*COM-
5766 MIT).
5767
5768 (*SKIP)
5769
5770 This verb, when given without a name, is like (*PRUNE), except that if
5771 the pattern is unanchored, the "bumpalong" advance is not to the next
5772 character, but to the position in the subject where (*SKIP) was encoun-
5773 tered. (*SKIP) signifies that whatever text was matched leading up to
5774 it cannot be part of a successful match. Consider:
5775
5776 a+(*SKIP)b
5777
5778 If the subject is "aaaac...", after the first match attempt fails
5779 (starting at the first character in the string), the starting point
5780 skips on to start the next attempt at "c". Note that a possessive quan-
5781 tifer does not have the same effect as this example; although it would
5782 suppress backtracking during the first match attempt, the second
5783 attempt would start at the second character instead of skipping on to
5784 "c".
5785
5786 (*SKIP:NAME)
5787
5788 When (*SKIP) has an associated name, its behaviour is modified. If the
5789 following pattern fails to match, the previous path through the pattern
5790 is searched for the most recent (*MARK) that has the same name. If one
5791 is found, the "bumpalong" advance is to the subject position that cor-
5792 responds to that (*MARK) instead of to where (*SKIP) was encountered.
5793 If no (*MARK) with a matching name is found, normal "bumpalong" of one
5794 character happens (the (*SKIP) is ignored).
5795
5796 (*THEN) or (*THEN:NAME)
5797
5798 This verb causes a skip to the next alternation in the innermost
5799 enclosing group if the rest of the pattern does not match. That is, it
5800 cancels pending backtracking, but only within the current alternation.
5801 Its name comes from the observation that it can be used for a pattern-
5802 based if-then-else block:
5803
5804 ( COND1 (*THEN) FOO | COND2 (*THEN) BAR | COND3 (*THEN) BAZ ) ...
5805
5806 If the COND1 pattern matches, FOO is tried (and possibly further items
5807 after the end of the group if FOO succeeds); on failure the matcher
5808 skips to the second alternative and tries COND2, without backtracking
5809 into COND1. The behaviour of (*THEN:NAME) is exactly the same as
5810 (*MARK:NAME)(*THEN) if the overall match fails. If (*THEN) is not
5811 directly inside an alternation, it acts like (*PRUNE).
5812
5813 The above verbs provide four different "strengths" of control when sub-
5814 sequent matching fails. (*THEN) is the weakest, carrying on the match
5815 at the next alternation. (*PRUNE) comes next, failing the match at the
5816 current starting position, but allowing an advance to the next charac-
5817 ter (for an unanchored pattern). (*SKIP) is similar, except that the
5818 advance may be more than one character. (*COMMIT) is the strongest,
5819 causing the entire match to fail.
5820
5821 If more than one is present in a pattern, the "stongest" one wins. For
5822 example, consider this pattern, where A, B, etc. are complex pattern
5823 fragments:
5824
5825 (A(*COMMIT)B(*THEN)C|D)
5826
5827 Once A has matched, PCRE is committed to this match, at the current
5828 starting position. If subsequently B matches, but C does not, the nor-
5829 mal (*THEN) action of trying the next alternation (that is, D) does not
5830 happen because (*COMMIT) overrides.
5831
5832
5833 SEE ALSO
5834
5835 pcreapi(3), pcrecallout(3), pcrematching(3), pcresyntax(3), pcre(3).
5836
5837
5838 AUTHOR
5839
5840 Philip Hazel
5841 University Computing Service
5842 Cambridge CB2 3QH, England.
5843
5844
5845 REVISION
5846
5847 Last updated: 24 August 2011
5848 Copyright (c) 1997-2011 University of Cambridge.
5849 ------------------------------------------------------------------------------
5850
5851
5852 PCRESYNTAX(3) PCRESYNTAX(3)
5853
5854
5855 NAME
5856 PCRE - Perl-compatible regular expressions
5857
5858
5859 PCRE REGULAR EXPRESSION SYNTAX SUMMARY
5860
5861 The full syntax and semantics of the regular expressions that are sup-
5862 ported by PCRE are described in the pcrepattern documentation. This
5863 document contains just a quick-reference summary of the syntax.
5864
5865
5866 QUOTING
5867
5868 \x where x is non-alphanumeric is a literal x
5869 \Q...\E treat enclosed characters as literal
5870
5871
5872 CHARACTERS
5873
5874 \a alarm, that is, the BEL character (hex 07)
5875 \cx "control-x", where x is any ASCII character
5876 \e escape (hex 1B)
5877 \f formfeed (hex 0C)
5878 \n newline (hex 0A)
5879 \r carriage return (hex 0D)
5880 \t tab (hex 09)
5881 \ddd character with octal code ddd, or backreference
5882 \xhh character with hex code hh
5883 \x{hhh..} character with hex code hhh..
5884
5885
5886 CHARACTER TYPES
5887
5888 . any character except newline;
5889 in dotall mode, any character whatsoever
5890 \C one byte, even in UTF-8 mode (best avoided)
5891 \d a decimal digit
5892 \D a character that is not a decimal digit
5893 \h a horizontal whitespace character
5894 \H a character that is not a horizontal whitespace character
5895 \N a character that is not a newline
5896 \p{xx} a character with the xx property
5897 \P{xx} a character without the xx property
5898 \R a newline sequence
5899 \s a whitespace character
5900 \S a character that is not a whitespace character
5901 \v a vertical whitespace character
5902 \V a character that is not a vertical whitespace character
5903 \w a "word" character
5904 \W a "non-word" character
5905 \X an extended Unicode sequence
5906
5907 In PCRE, by default, \d, \D, \s, \S, \w, and \W recognize only ASCII
5908 characters, even in UTF-8 mode. However, this can be changed by setting
5909 the PCRE_UCP option.
5910
5911
5912 GENERAL CATEGORY PROPERTIES FOR \p and \P
5913
5914 C Other
5915 Cc Control
5916 Cf Format
5917 Cn Unassigned
5918 Co Private use
5919 Cs Surrogate
5920
5921 L Letter
5922 Ll Lower case letter
5923 Lm Modifier letter
5924 Lo Other letter
5925 Lt Title case letter
5926 Lu Upper case letter
5927 L& Ll, Lu, or Lt
5928
5929 M Mark
5930 Mc Spacing mark
5931 Me Enclosing mark
5932 Mn Non-spacing mark
5933
5934 N Number
5935 Nd Decimal number
5936 Nl Letter number
5937 No Other number
5938
5939 P Punctuation
5940 Pc Connector punctuation
5941 Pd Dash punctuation
5942 Pe Close punctuation
5943 Pf Final punctuation
5944 Pi Initial punctuation
5945 Po Other punctuation
5946 Ps Open punctuation
5947
5948 S Symbol
5949 Sc Currency symbol
5950 Sk Modifier symbol
5951 Sm Mathematical symbol
5952 So Other symbol
5953
5954 Z Separator
5955 Zl Line separator
5956 Zp Paragraph separator
5957 Zs Space separator
5958
5959
5960 PCRE SPECIAL CATEGORY PROPERTIES FOR \p and \P
5961
5962 Xan Alphanumeric: union of properties L and N
5963 Xps POSIX space: property Z or tab, NL, VT, FF, CR
5964 Xsp Perl space: property Z or tab, NL, FF, CR
5965 Xwd Perl word: property Xan or underscore
5966
5967
5968 SCRIPT NAMES FOR \p AND \P
5969
5970 Arabic, Armenian, Avestan, Balinese, Bamum, Bengali, Bopomofo, Braille,
5971 Buginese, Buhid, Canadian_Aboriginal, Carian, Cham, Cherokee, Common,
5972 Coptic, Cuneiform, Cypriot, Cyrillic, Deseret, Devanagari, Egyp-
5973 tian_Hieroglyphs, Ethiopic, Georgian, Glagolitic, Gothic, Greek,
5974 Gujarati, Gurmukhi, Han, Hangul, Hanunoo, Hebrew, Hiragana, Impe-
5975 rial_Aramaic, Inherited, Inscriptional_Pahlavi, Inscriptional_Parthian,
5976 Javanese, Kaithi, Kannada, Katakana, Kayah_Li, Kharoshthi, Khmer, Lao,
5977 Latin, Lepcha, Limbu, Linear_B, Lisu, Lycian, Lydian, Malayalam,
5978 Meetei_Mayek, Mongolian, Myanmar, New_Tai_Lue, Nko, Ogham, Old_Italic,
5979 Old_Persian, Old_South_Arabian, Old_Turkic, Ol_Chiki, Oriya, Osmanya,
5980 Phags_Pa, Phoenician, Rejang, Runic, Samaritan, Saurashtra, Shavian,
5981 Sinhala, Sundanese, Syloti_Nagri, Syriac, Tagalog, Tagbanwa, Tai_Le,
5982 Tai_Tham, Tai_Viet, Tamil, Telugu, Thaana, Thai, Tibetan, Tifinagh,
5983 Ugaritic, Vai, Yi.
5984
5985
5986 CHARACTER CLASSES
5987
5988 [...] positive character class
5989 [^...] negative character class
5990 [x-y] range (can be used for hex characters)
5991 [[:xxx:]] positive POSIX named set
5992 [[:^xxx:]] negative POSIX named set
5993
5994 alnum alphanumeric
5995 alpha alphabetic
5996 ascii 0-127
5997 blank space or tab
5998 cntrl control character
5999 digit decimal digit
6000 graph printing, excluding space
6001 lower lower case letter
6002 print printing, including space
6003 punct printing, excluding alphanumeric
6004 space whitespace
6005 upper upper case letter
6006 word same as \w
6007 xdigit hexadecimal digit
6008
6009 In PCRE, POSIX character set names recognize only ASCII characters by
6010 default, but some of them use Unicode properties if PCRE_UCP is set.
6011 You can use \Q...\E inside a character class.
6012
6013
6014 QUANTIFIERS
6015
6016 ? 0 or 1, greedy
6017 ?+ 0 or 1, possessive
6018 ?? 0 or 1, lazy
6019 * 0 or more, greedy
6020 *+ 0 or more, possessive
6021 *? 0 or more, lazy
6022 + 1 or more, greedy
6023 ++ 1 or more, possessive