PCRE was originally written for the Exim MTA, but is now used by many high-profile open source projects, including Python, Apache, PHP, KDE, Postfix, Analog, and nmap. Other interesting projects using PCRE include Ferite, Onyx, Hypermail, and Askemos.
-----------------------------------------------------------------------------
NAME
PCRE - Perl-compatible regular expressions
DESCRIPTION
The PCRE library is a set of functions that implement regu-
lar expression pattern matching using the same syntax and
semantics as Perl, with just a few differences. The current
implementation of PCRE (release 4.x) corresponds approxi-
mately with Perl 5.8, including support for UTF-8 encoded
strings. However, this support has to be explicitly
enabled; it is not the default.
PCRE is written in C and released as a C library. However, a
number of people have written wrappers and interfaces of
various kinds. A C++ class is included in these contribu-
tions, which can be found in the Contrib directory at the
primary FTP site, which is:
ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre
Details of exactly which Perl regular expression features
are and are not supported by PCRE are given in separate
documents. See the pcrepattern and pcrecompat pages.
Some features of PCRE can be included, excluded, or changed
when the library is built. The pcre_config() function makes
it possible for a client to discover which features are
available. Documentation about building PCRE for various
operating systems can be found in the README file in the
source distribution.
USER DOCUMENTATION
The user documentation for PCRE has been split up into a
number of different sections. In the "man" format, each of
these is a separate "man page". In the HTML format, each is
a separate page, linked from the index page. In the plain
text format, all the sections are concatenated, for ease of
searching. The sections are as follows:
pcre this document
pcreapi details of PCRE's native API
pcrebuild options for building PCRE
pcrecallout details of the callout feature
pcrecompat discussion of Perl compatibility
pcregrep description of the pcregrep command
pcrepattern syntax and semantics of supported
regular expressions
pcreperform discussion of performance issues
pcreposix the POSIX-compatible API
pcresample discussion of the sample program
pcretest the pcretest testing command
In addition, in the "man" and HTML formats, there is a short
page for each library function, listing its arguments and
results.
LIMITATIONS
There are some size limitations in PCRE but it is hoped that
they will never in practice be relevant.
The maximum length of a compiled pattern is 65539 (sic)
bytes if PCRE is compiled with the default internal linkage
size of 2. If you want to process regular expressions that
are truly enormous, you can compile PCRE with an internal
linkage size of 3 or 4 (see the README file in the source
distribution and the pcrebuild documentation for details).
If these cases the limit is substantially larger. However,
the speed of execution will be slower.
All values in repeating quantifiers must be less than 65536.
The maximum number of capturing subpatterns is 65535.
There is no limit to the number of non-capturing subpat-
terns, but the maximum depth of nesting of all kinds of
parenthesized subpattern, including capturing subpatterns,
assertions, and other types of subpattern, is 200.
The maximum length of a subject string is the largest posi-
tive number that an integer variable can hold. However, PCRE
uses recursion to handle subpatterns and indefinite repeti-
tion. This means that the available stack space may limit
the size of a subject string that can be processed by cer-
tain patterns.
UTF-8 SUPPORT
Starting at release 3.3, PCRE has had some support for char-
acter strings encoded in the UTF-8 format. For release 4.0
this has been greatly extended to cover most common require-
ments.
In order process UTF-8 strings, you must build PCRE to
include UTF-8 support in the code, and, in addition, you
must call pcre_compile() with the PCRE_UTF8 option flag.
When you do this, both the pattern and any subject strings
that are matched against it are treated as UTF-8 strings
instead of just strings of bytes.
If you compile PCRE with UTF-8 support, but do not use it at
run time, the library will be a bit bigger, but the addi-
tional run time overhead is limited to testing the PCRE_UTF8
flag in several places, so should not be very large.
The following comments apply when PCRE is running in UTF-8
mode:
1. When you set the PCRE_UTF8 flag, the strings passed as
patterns and subjects are checked for validity on entry to
the relevant functions. If an invalid UTF-8 string is
passed, an error return is given. In some situations, you
may already know that your strings are valid, and therefore
want to skip these checks in order to improve performance.
If you set the PCRE_NO_UTF8_CHECK flag at compile time or at
run time, PCRE assumes that the pattern or subject it is
given (respectively) contains only valid UTF-8 codes. In
this case, it does not diagnose an invalid UTF-8 string. If
you pass an invalid UTF-8 string to PCRE when
PCRE_NO_UTF8_CHECK is set, the results are undefined. Your
program may crash.
2. In a pattern, the escape sequence \x{...}, where the con-
tents of the braces is a string of hexadecimal digits, is
interpreted as a UTF-8 character whose code number is the
given hexadecimal number, for example: \x{1234}. If a non-
hexadecimal digit appears between the braces, the item is
not recognized. This escape sequence can be used either as
a literal, or within a character class.
3. The original hexadecimal escape sequence, \xhh, matches a
two-byte UTF-8 character if the value is greater than 127.
4. Repeat quantifiers apply to complete UTF-8 characters,
not to individual bytes, for example: \x{100}{3}.
5. The dot metacharacter matches one UTF-8 character instead
of a single byte.
6. The escape sequence \C can be used to match a single byte
in UTF-8 mode, but its use can lead to some strange effects.
7. The character escapes \b, \B, \d, \D, \s, \S, \w, and \W
correctly test characters of any code value, but the charac-
ters that PCRE recognizes as digits, spaces, or word charac-
ters remain the same set as before, all with values less
than 256.
8. Case-insensitive matching applies only to characters
whose values are less than 256. PCRE does not support the
notion of "case" for higher-valued characters.
9. PCRE does not support the use of Unicode tables and pro-
perties or the Perl escapes \p, \P, and \X.
AUTHOR
Philip Hazel <ph10@cam.ac.uk>
University Computing Service,
Cambridge CB2 3QG, England.
Phone: +44 1223 334714
Last updated: 20 August 2003
Copyright (c) 1997-2003 University of Cambridge.
-----------------------------------------------------------------------------
NAME
PCRE - Perl-compatible regular expressions
PCRE BUILD-TIME OPTIONS
This document describes the optional features of PCRE that
can be selected when the library is compiled. They are all
selected, or deselected, by providing options to the config-
ure script which is run before the make command. The com-
plete list of options for configure (which includes the
standard ones such as the selection of the installation
directory) can be obtained by running
./configure --help
The following sections describe certain options whose names
begin with --enable or --disable. These settings specify
changes to the defaults for the configure command. Because
of the way that configure works, --enable and --disable
always come in pairs, so the complementary option always
exists as well, but as it specifies the default, it is not
described.
UTF-8 SUPPORT
To build PCRE with support for UTF-8 character strings, add
--enable-utf8
to the configure command. Of itself, this does not make PCRE
treat strings as UTF-8. As well as compiling PCRE with this
option, you also have have to set the PCRE_UTF8 option when
you call the pcre_compile() function.
CODE VALUE OF NEWLINE
By default, PCRE treats character 10 (linefeed) as the new-
line character. This is the normal newline character on
Unix-like systems. You can compile PCRE to use character 13
(carriage return) instead by adding
--enable-newline-is-cr
to the configure command. For completeness there is also a
--enable-newline-is-lf option, which explicitly specifies
linefeed as the newline character.
BUILDING SHARED AND STATIC LIBRARIES
The PCRE building process uses libtool to build both shared
and static Unix libraries by default. You can suppress one
of these by adding one of
--disable-shared
--disable-static
to the configure command, as required.
POSIX MALLOC USAGE
When PCRE is called through the POSIX interface (see the
pcreposix documentation), additional working storage is
required for holding the pointers to capturing substrings
because PCRE requires three integers per substring, whereas
the POSIX interface provides only two. If the number of
expected substrings is small, the wrapper function uses
space on the stack, because this is faster than using mal-
loc() for each call. The default threshold above which the
stack is no longer used is 10; it can be changed by adding a
setting such as
--with-posix-malloc-threshold=20
to the configure command.
LIMITING PCRE RESOURCE USAGE
Internally, PCRE has a function called match() which it
calls repeatedly (possibly recursively) when performing a
matching operation. By limiting the number of times this
function may be called, a limit can be placed on the
resources used by a single call to pcre_exec(). The limit
can be changed at run time, as described in the pcreapi
documentation. The default is 10 million, but this can be
changed by adding a setting such as
--with-match-limit=500000
to the configure command.
HANDLING VERY LARGE PATTERNS
Within a compiled pattern, offset values are used to point
from one part to another (for example, from an opening
parenthesis to an alternation metacharacter). By default
two-byte values are used for these offsets, leading to a
maximum size for a compiled pattern of around 64K. This is
sufficient to handle all but the most gigantic patterns.
Nevertheless, some people do want to process enormous pat-
terns, so it is possible to compile PCRE to use three-byte
or four-byte offsets by adding a setting such as
--with-link-size=3
to the configure command. The value given must be 2, 3, or
4. Using longer offsets slows down the operation of PCRE
because it has to load additional bytes when handling them.
If you build PCRE with an increased link size, test 2 (and
test 5 if you are using UTF-8) will fail. Part of the output
of these tests is a representation of the compiled pattern,
and this changes with the link size.
Last updated: 21 January 2003
Copyright (c) 1997-2003 University of Cambridge.
-----------------------------------------------------------------------------
NAME
PCRE - Perl-compatible regular expressions
SYNOPSIS OF PCRE API
#include <pcre.h>
pcre *pcre_compile(const char *pattern, int options,
const char **errptr, int *erroffset,
const unsigned char *tableptr);
pcre_extra *pcre_study(const pcre *code, int options,
const char **errptr);
int pcre_exec(const pcre *code, const pcre_extra *extra,
const char *subject, int length, int startoffset,
int options, int *ovector, int ovecsize);
int pcre_copy_named_substring(const pcre *code,
const char *subject, int *ovector,
int stringcount, const char *stringname,
char *buffer, int buffersize);
int pcre_copy_substring(const char *subject, int *ovector,
int stringcount, int stringnumber, char *buffer,
int buffersize);
int pcre_get_named_substring(const pcre *code,
const char *subject, int *ovector,
int stringcount, const char *stringname,
const char **stringptr);
int pcre_get_stringnumber(const pcre *code,
const char *name);
int pcre_get_substring(const char *subject, int *ovector,
int stringcount, int stringnumber,
const char **stringptr);
int pcre_get_substring_list(const char *subject,
int *ovector, int stringcount, const char ***listptr);
void pcre_free_substring(const char *stringptr);
void pcre_free_substring_list(const char **stringptr);
const unsigned char *pcre_maketables(void);
int pcre_fullinfo(const pcre *code, const pcre_extra *extra,
int what, void *where);
int pcre_info(const pcre *code, int *optptr, *firstcharptr);
int pcre_config(int what, void *where);
char *pcre_version(void);
void *(*pcre_malloc)(size_t);
void (*pcre_free)(void *);
int (*pcre_callout)(pcre_callout_block *);
PCRE API
PCRE has its own native API, which is described in this
document. There is also a set of wrapper functions that
correspond to the POSIX regular expression API. These are
described in the pcreposix documentation.
The native API function prototypes are defined in the header
file pcre.h, and on Unix systems the library itself is
called libpcre.a, so can be accessed by adding -lpcre to the
command for linking an application which calls it. The
header file defines the macros PCRE_MAJOR and PCRE_MINOR to
contain the major and minor release numbers for the library.
Applications can use these to include support for different
releases.
The functions pcre_compile(), pcre_study(), and pcre_exec()
are used for compiling and matching regular expressions. A
sample program that demonstrates the simplest way of using
them is given in the file pcredemo.c. The pcresample docu-
mentation describes how to run it.
There are convenience functions for extracting captured sub-
strings from a matched subject string. They are:
pcre_copy_substring()
pcre_copy_named_substring()
pcre_get_substring()
pcre_get_named_substring()
pcre_get_substring_list()
pcre_free_substring() and pcre_free_substring_list() are
also provided, to free the memory used for extracted
strings.
The function pcre_maketables() is used (optionally) to build
a set of character tables in the current locale for passing
to pcre_compile().
The function pcre_fullinfo() is used to find out information
about a compiled pattern; pcre_info() is an obsolete version
which returns only some of the available information, but is
retained for backwards compatibility. The function
pcre_version() returns a pointer to a string containing the
version of PCRE and its date of release.
The global variables pcre_malloc and pcre_free initially
contain the entry points of the standard malloc() and free()
functions respectively. PCRE calls the memory management
functions via these variables, so a calling program can
replace them if it wishes to intercept the calls. This
should be done before calling any PCRE functions.
The global variable pcre_callout initially contains NULL. It
can be set by the caller to a "callout" function, which PCRE
will then call at specified points during a matching opera-
tion. Details are given in the pcrecallout documentation.
MULTITHREADING
The PCRE functions can be used in multi-threading applica-
tions, with the proviso that the memory management functions
pointed to by pcre_malloc and pcre_free, and the callout
function pointed to by pcre_callout, are shared by all
threads.
The compiled form of a regular expression is not altered
during matching, so the same compiled pattern can safely be
used by several threads at once.
CHECKING BUILD-TIME OPTIONS
int pcre_config(int what, void *where);
The function pcre_config() makes it possible for a PCRE
client to discover which optional features have been com-
piled into the PCRE library. The pcrebuild documentation has
more details about these optional features.
The first argument for pcre_config() is an integer, specify-
ing which information is required; the second argument is a
pointer to a variable into which the information is placed.
The following information is available:
PCRE_CONFIG_UTF8
The output is an integer that is set to one if UTF-8 support
is available; otherwise it is set to zero.
PCRE_CONFIG_NEWLINE
The output is an integer that is set to the value of the
code that is used for the newline character. It is either
linefeed (10) or carriage return (13), and should normally
be the standard character for your operating system.
PCRE_CONFIG_LINK_SIZE
The output is an integer that contains the number of bytes
used for internal linkage in compiled regular expressions.
The value is 2, 3, or 4. Larger values allow larger regular
expressions to be compiled, at the expense of slower match-
ing. The default value of 2 is sufficient for all but the
most massive patterns, since it allows the compiled pattern
to be up to 64K in size.
PCRE_CONFIG_POSIX_MALLOC_THRESHOLD
The output is an integer that contains the threshold above
which the POSIX interface uses malloc() for output vectors.
Further details are given in the pcreposix documentation.
PCRE_CONFIG_MATCH_LIMIT
The output is an integer that gives the default limit for
the number of internal matching function calls in a
pcre_exec() execution. Further details are given with
pcre_exec() below.
COMPILING A PATTERN
pcre *pcre_compile(const char *pattern, int options,
const char **errptr, int *erroffset,
const unsigned char *tableptr);
The function pcre_compile() is called to compile a pattern
into an internal form. The pattern is a C string terminated
by a binary zero, and is passed in the argument pattern. A
pointer to a single block of memory that is obtained via
pcre_malloc is returned. This contains the compiled code and
related data. The pcre type is defined for the returned
block; this is a typedef for a structure whose contents are
not externally defined. It is up to the caller to free the
memory when it is no longer required.
Although the compiled code of a PCRE regex is relocatable,
that is, it does not depend on memory location, the complete
pcre data block is not fully relocatable, because it con-
tains a copy of the tableptr argument, which is an address
(see below).
The options argument contains independent bits that affect
the compilation. It should be zero if no options are
required. Some of the options, in particular, those that are
compatible with Perl, can also be set and unset from within
the pattern (see the detailed description of regular expres-
sions in the pcrepattern documentation). For these options,
the contents of the options argument specifies their initial
settings at the start of compilation and execution. The
PCRE_ANCHORED option can be set at the time of matching as
well as at compile time.
If errptr is NULL, pcre_compile() returns NULL immediately.
Otherwise, if compilation of a pattern fails, pcre_compile()
returns NULL, and sets the variable pointed to by errptr to
point to a textual error message. The offset from the start
of the pattern to the character where the error was
discovered is placed in the variable pointed to by
erroffset, which must not be NULL. If it is, an immediate
error is given.
If the final argument, tableptr, is NULL, PCRE uses a
default set of character tables which are built when it is
compiled, using the default C locale. Otherwise, tableptr
must be the result of a call to pcre_maketables(). See the
section on locale support below.
This code fragment shows a typical straightforward call to
pcre_compile():
pcre *re;
const char *error;
int erroffset;
re = pcre_compile(
"^A.*Z", /* the pattern */
0, /* default options */
&error, /* for error message */
&erroffset, /* for error offset */
NULL); /* use default character tables */
The following option bits are defined:
PCRE_ANCHORED
If this bit is set, the pattern is forced to be "anchored",
that is, it is constrained to match only at the first match-
ing point in the string which is being searched (the "sub-
ject string"). This effect can also be achieved by appropri-
ate constructs in the pattern itself, which is the only way
to do it in Perl.
PCRE_CASELESS
If this bit is set, letters in the pattern match both upper
and lower case letters. It is equivalent to Perl's /i
option, and it can be changed within a pattern by a (?i)
option setting.
PCRE_DOLLAR_ENDONLY
If this bit is set, a dollar metacharacter in the pattern
matches only at the end of the subject string. Without this
option, a dollar also matches immediately before the final
character if it is a newline (but not before any other new-
lines). The PCRE_DOLLAR_ENDONLY option is ignored if
PCRE_MULTILINE is set. There is no equivalent to this option
in Perl, and no way to set it within a pattern.
PCRE_DOTALL
If this bit is set, a dot metacharater in the pattern
matches all characters, including newlines. Without it, new-
lines are excluded. This option is equivalent to Perl's /s
option, and it can be changed within a pattern by a (?s)
option setting. A negative class such as [^a] always matches
a newline character, independent of the setting of this
option.
PCRE_EXTENDED
If this bit is set, whitespace data characters in the pat-
tern are totally ignored except when escaped or inside a
character class. Whitespace does not include the VT charac-
ter (code 11). In addition, characters between an unescaped
# outside a character class and the next newline character,
inclusive, are also ignored. This is equivalent to Perl's /x
option, and it can be changed within a pattern by a (?x)
option setting.
This option makes it possible to include comments inside
complicated patterns. Note, however, that this applies only
to data characters. Whitespace characters may never appear
within special character sequences in a pattern, for example
within the sequence (?( which introduces a conditional sub-
pattern.
PCRE_EXTRA
This option was invented in order to turn on additional
functionality of PCRE that is incompatible with Perl, but it
is currently of very little use. When set, any backslash in
a pattern that is followed by a letter that has no special
meaning causes an error, thus reserving these combinations
for future expansion. By default, as in Perl, a backslash
followed by a letter with no special meaning is treated as a
literal. There are at present no other features controlled
by this option. It can also be set by a (?X) option setting
within a pattern.
PCRE_MULTILINE
By default, PCRE treats the subject string as consisting of
a single "line" of characters (even if it actually contains
several newlines). The "start of line" metacharacter (^)
matches only at the start of the string, while the "end of
line" metacharacter ($) matches only at the end of the
string, or before a terminating newline (unless
PCRE_DOLLAR_ENDONLY is set). This is the same as Perl.
When PCRE_MULTILINE it is set, the "start of line" and "end
of line" constructs match immediately following or immedi-
ately before any newline in the subject string, respec-
tively, as well as at the very start and end. This is
equivalent to Perl's /m option, and it can be changed within
a pattern by a (?m) option setting. If there are no "\n"
characters in a subject string, or no occurrences of ^ or $
in a pattern, setting PCRE_MULTILINE has no effect.
PCRE_NO_AUTO_CAPTURE
If this option is set, it disables the use of numbered cap-
turing parentheses in the pattern. Any opening parenthesis
that is not followed by ? behaves as if it were followed by
?: but named parentheses can still be used for capturing
(and they acquire numbers in the usual way). There is no
equivalent of this option in Perl.
PCRE_UNGREEDY
This option inverts the "greediness" of the quantifiers so
that they are not greedy by default, but become greedy if
followed by "?". It is not compatible with Perl. It can also
be set by a (?U) option setting within the pattern.
PCRE_UTF8
This option causes PCRE to regard both the pattern and the
subject as strings of UTF-8 characters instead of single-
byte character strings. However, it is available only if
PCRE has been built to include UTF-8 support. If not, the
use of this option provokes an error. Details of how this
option changes the behaviour of PCRE are given in the sec-
tion on UTF-8 support in the main pcre page.
PCRE_NO_UTF8_CHECK
When PCRE_UTF8 is set, the validity of the pattern as a
UTF-8 string is automatically checked. If an invalid UTF-8
sequence of bytes is found, pcre_compile() returns an error.
If you already know that your pattern is valid, and you want
to skip this check for performance reasons, you can set the
PCRE_NO_UTF8_CHECK option. When it is set, the effect of
passing an invalid UTF-8 string as a pattern is undefined.
It may cause your program to crash. Note that there is a
similar option for suppressing the checking of subject
strings passed to pcre_exec().
STUDYING A PATTERN
pcre_extra *pcre_study(const pcre *code, int options,
const char **errptr);
When a pattern is going to be used several times, it is
worth spending more time analyzing it in order to speed up
the time taken for matching. The function pcre_study() takes
a pointer to a compiled pattern as its first argument. If
studing the pattern produces additional information that
will help speed up matching, pcre_study() returns a pointer
to a pcre_extra block, in which the study_data field points
to the results of the study.
The returned value from a pcre_study() can be passed
directly to pcre_exec(). However, the pcre_extra block also
contains other fields that can be set by the caller before
the block is passed; these are described below. If studying
the pattern does not produce any additional information,
pcre_study() returns NULL. In that circumstance, if the cal-
ling program wants to pass some of the other fields to
pcre_exec(), it must set up its own pcre_extra block.
The second argument contains option bits. At present, no
options are defined for pcre_study(), and this argument
should always be zero.
The third argument for pcre_study() is a pointer for an
error message. If studying succeeds (even if no data is
returned), the variable it points to is set to NULL. Other-
wise it points to a textual error message. You should there-
fore test the error pointer for NULL after calling
pcre_study(), to be sure that it has run successfully.
This is a typical call to pcre_study():
pcre_extra *pe;
pe = pcre_study(
re, /* result of pcre_compile() */
0, /* no options exist */
&error); /* set to NULL or points to a message */
At present, studying a pattern is useful only for non-
anchored patterns that do not have a single fixed starting
character. A bitmap of possible starting characters is
created.
LOCALE SUPPORT
PCRE handles caseless matching, and determines whether char-
acters are letters, digits, or whatever, by reference to a
set of tables. When running in UTF-8 mode, this applies only
to characters with codes less than 256. The library contains
a default set of tables that is created in the default C
locale when PCRE is compiled. This is used when the final
argument of pcre_compile() is NULL, and is sufficient for
many applications.
An alternative set of tables can, however, be supplied. Such
tables are built by calling the pcre_maketables() function,
which has no arguments, in the relevant locale. The result
can then be passed to pcre_compile() as often as necessary.
For example, to build and use tables that are appropriate
for the French locale (where accented characters with codes
greater than 128 are treated as letters), the following code
could be used:
setlocale(LC_CTYPE, "fr");
tables = pcre_maketables();
re = pcre_compile(..., tables);
The tables are built in memory that is obtained via
pcre_malloc. The pointer that is passed to pcre_compile is
saved with the compiled pattern, and the same tables are
used via this pointer by pcre_study() and pcre_exec(). Thus,
for any single pattern, compilation, studying and matching
all happen in the same locale, but different patterns can be
compiled in different locales. It is the caller's responsi-
bility to ensure that the memory containing the tables
remains available for as long as it is needed.
INFORMATION ABOUT A PATTERN
int pcre_fullinfo(const pcre *code, const pcre_extra *extra,
int what, void *where);
The pcre_fullinfo() function returns information about a
compiled pattern. It replaces the obsolete pcre_info() func-
tion, which is nevertheless retained for backwards compabil-
ity (and is documented below).
The first argument for pcre_fullinfo() is a pointer to the
compiled pattern. The second argument is the result of
pcre_study(), or NULL if the pattern was not studied. The
third argument specifies which piece of information is
required, and the fourth argument is a pointer to a variable
to receive the data. The yield of the function is zero for
success, or one of the following negative numbers:
PCRE_ERROR_NULL the argument code was NULL
the argument where was NULL
PCRE_ERROR_BADMAGIC the "magic number" was not found
PCRE_ERROR_BADOPTION the value of what was invalid
Here is a typical call of pcre_fullinfo(), to obtain the
length of the compiled pattern:
int rc;
unsigned long int length;
rc = pcre_fullinfo(
re, /* result of pcre_compile() */
pe, /* result of pcre_study(), or NULL */
PCRE_INFO_SIZE, /* what is required */
&length); /* where to put the data */
The possible values for the third argument are defined in
pcre.h, and are as follows:
PCRE_INFO_BACKREFMAX
Return the number of the highest back reference in the pat-
tern. The fourth argument should point to an int variable.
Zero is returned if there are no back references.
PCRE_INFO_CAPTURECOUNT
Return the number of capturing subpatterns in the pattern.
The fourth argument should point to an int variable.
PCRE_INFO_FIRSTBYTE
Return information about the first byte of any matched
string, for a non-anchored pattern. (This option used to be
called PCRE_INFO_FIRSTCHAR; the old name is still recognized
for backwards compatibility.)
If there is a fixed first byte, e.g. from a pattern such as
(cat|cow|coyote), it is returned in the integer pointed to
by where. Otherwise, if either
(a) the pattern was compiled with the PCRE_MULTILINE option,
and every branch starts with "^", or
(b) every branch of the pattern starts with ".*" and
PCRE_DOTALL is not set (if it were set, the pattern would be
anchored),
-1 is returned, indicating that the pattern matches only at
the start of a subject string or after any newline within
the string. Otherwise -2 is returned. For anchored patterns,
-2 is returned.
PCRE_INFO_FIRSTTABLE
If the pattern was studied, and this resulted in the con-
struction of a 256-bit table indicating a fixed set of bytes
for the first byte in any matching string, a pointer to the
table is returned. Otherwise NULL is returned. The fourth
argument should point to an unsigned char * variable.
PCRE_INFO_LASTLITERAL
Return the value of the rightmost literal byte that must
exist in any matched string, other than at its start, if
such a byte has been recorded. The fourth argument should
point to an int variable. If there is no such byte, -1 is
returned. For anchored patterns, a last literal byte is
recorded only if it follows something of variable length.
For example, for the pattern /^a\d+z\d+/ the returned value
is "z", but for /^a\dz\d/ the returned value is -1.
PCRE_INFO_NAMECOUNT
PCRE_INFO_NAMEENTRYSIZE
PCRE_INFO_NAMETABLE
PCRE supports the use of named as well as numbered capturing
parentheses. The names are just an additional way of identi-
fying the parentheses, which still acquire a number. A
caller that wants to extract data from a named subpattern
must convert the name to a number in order to access the
correct pointers in the output vector (described with
pcre_exec() below). In order to do this, it must first use
these three values to obtain the name-to-number mapping
table for the pattern.
The map consists of a number of fixed-size entries.
PCRE_INFO_NAMECOUNT gives the number of entries, and
PCRE_INFO_NAMEENTRYSIZE gives the size of each entry; both
of these return an int value. The entry size depends on the
length of the longest name. PCRE_INFO_NAMETABLE returns a
pointer to the first entry of the table (a pointer to char).
The first two bytes of each entry are the number of the cap-
turing parenthesis, most significant byte first. The rest of
the entry is the corresponding name, zero terminated. The
names are in alphabetical order. For example, consider the
following pattern (assume PCRE_EXTENDED is set, so white
space - including newlines - is ignored):
(?P<date> (?P<year>(\d\d)?\d\d) -
(?P<month>\d\d) - (?P<day>\d\d) )
There are four named subpatterns, so the table has four
entries, and each entry in the table is eight bytes long.
The table is as follows, with non-printing bytes shows in
hex, and undefined bytes shown as ??:
00 01 d a t e 00 ??
00 05 d a y 00 ?? ??
00 04 m o n t h 00
00 02 y e a r 00 ??
When writing code to extract data from named subpatterns,
remember that the length of each entry may be different for
each compiled pattern.
PCRE_INFO_OPTIONS
Return a copy of the options with which the pattern was com-
piled. The fourth argument should point to an unsigned long
int variable. These option bits are those specified in the
call to pcre_compile(), modified by any top-level option
settings within the pattern itself.
A pattern is automatically anchored by PCRE if all of its
top-level alternatives begin with one of the following:
^ unless PCRE_MULTILINE is set
\A always
\G always
.* if PCRE_DOTALL is set and there are no back
references to the subpattern in which .* appears
For such patterns, the PCRE_ANCHORED bit is set in the
options returned by pcre_fullinfo().
PCRE_INFO_SIZE
Return the size of the compiled pattern, that is, the value
that was passed as the argument to pcre_malloc() when PCRE
was getting memory in which to place the compiled data. The
fourth argument should point to a size_t variable.
PCRE_INFO_STUDYSIZE
Returns the size of the data block pointed to by the
study_data field in a pcre_extra block. That is, it is the
value that was passed to pcre_malloc() when PCRE was getting
memory into which to place the data created by pcre_study().
The fourth argument should point to a size_t variable.
OBSOLETE INFO FUNCTION
int pcre_info(const pcre *code, int *optptr, *firstcharptr);
The pcre_info() function is now obsolete because its inter-
face is too restrictive to return all the available data
about a compiled pattern. New programs should use
pcre_fullinfo() instead. The yield of pcre_info() is the
number of capturing subpatterns, or one of the following
negative numbers:
PCRE_ERROR_NULL the argument code was NULL
PCRE_ERROR_BADMAGIC the "magic number" was not found
If the optptr argument is not NULL, a copy of the options
with which the pattern was compiled is placed in the integer
it points to (see PCRE_INFO_OPTIONS above).
If the pattern is not anchored and the firstcharptr argument
is not NULL, it is used to pass back information about the
first character of any matched string (see
PCRE_INFO_FIRSTBYTE above).
MATCHING A PATTERN
int pcre_exec(const pcre *code, const pcre_extra *extra,
const char *subject, int length, int startoffset,
int options, int *ovector, int ovecsize);
The function pcre_exec() is called to match a subject string
against a pre-compiled pattern, which is passed in the code
argument. If the pattern has been studied, the result of the
study should be passed in the extra argument.
Here is an example of a simple call to pcre_exec():
int rc;
int ovector[30];
rc = pcre_exec(
re, /* result of pcre_compile() */
NULL, /* we didn't study the pattern */
"some string", /* the subject string */
11, /* the length of the subject string */
0, /* start at offset 0 in the subject */
0, /* default options */
ovector, /* vector for substring information */
30); /* number of elements in the vector */
If the extra argument is not NULL, it must point to a
pcre_extra data block. The pcre_study() function returns
such a block (when it doesn't return NULL), but you can also
create one for yourself, and pass additional information in
it. The fields in the block are as follows:
unsigned long int flags;
void *study_data;
unsigned long int match_limit;
void *callout_data;
The flags field is a bitmap that specifies which of the
other fields are set. The flag bits are:
PCRE_EXTRA_STUDY_DATA
PCRE_EXTRA_MATCH_LIMIT
PCRE_EXTRA_CALLOUT_DATA
Other flag bits should be set to zero. The study_data field
is set in the pcre_extra block that is returned by
pcre_study(), together with the appropriate flag bit. You
should not set this yourself, but you can add to the block
by setting the other fields.
The match_limit field provides a means of preventing PCRE
from using up a vast amount of resources when running pat-
terns that are not going to match, but which have a very
large number of possibilities in their search trees. The
classic example is the use of nested unlimited repeats.
Internally, PCRE uses a function called match() which it
calls repeatedly (sometimes recursively). The limit is
imposed on the number of times this function is called dur-
ing a match, which has the effect of limiting the amount of
recursion and backtracking that can take place. For patterns
that are not anchored, the count starts from zero for each
position in the subject string.
The default limit for the library can be set when PCRE is
built; the default default is 10 million, which handles all
but the most extreme cases. You can reduce the default by
suppling pcre_exec() with a pcre_extra block in which
match_limit is set to a smaller value, and
PCRE_EXTRA_MATCH_LIMIT is set in the flags field. If the
limit is exceeded, pcre_exec() returns
PCRE_ERROR_MATCHLIMIT.
The pcre_callout field is used in conjunction with the "cal-
lout" feature, which is described in the pcrecallout docu-
mentation.
The PCRE_ANCHORED option can be passed in the options argu-
ment, whose unused bits must be zero. This limits
pcre_exec() to matching at the first matching position. How-
ever, if a pattern was compiled with PCRE_ANCHORED, or
turned out to be anchored by virtue of its contents, it can-
not be made unachored at matching time.
When PCRE_UTF8 was set at compile time, the validity of the
subject as a UTF-8 string is automatically checked. If an
invalid UTF-8 sequence of bytes is found, pcre_exec()
returns the error PCRE_ERROR_BADUTF8. If you already know
that your subject is valid, and you want to skip this check
for performance reasons, you can set the PCRE_NO_UTF8_CHECK
option when calling pcre_exec(). When this option is set,
the effect of passing an invalid UTF-8 string as a subject
is undefined. It may cause your program to crash.
There are also three further options that can be set only at
matching time:
PCRE_NOTBOL
The first character of the string is not the beginning of a
line, so the circumflex metacharacter should not match
before it. Setting this without PCRE_MULTILINE (at compile
time) causes circumflex never to match.
PCRE_NOTEOL
The end of the string is not the end of a line, so the dol-
lar metacharacter should not match it nor (except in multi-
line mode) a newline immediately before it. Setting this
without PCRE_MULTILINE (at compile time) causes dollar never
to match.
PCRE_NOTEMPTY
An empty string is not considered to be a valid match if
this option is set. If there are alternatives in the pat-
tern, they are tried. If all the alternatives match the
empty string, the entire match fails. For example, if the
pattern
a?b?
is applied to a string not beginning with "a" or "b", it
matches the empty string at the start of the subject. With
PCRE_NOTEMPTY set, this match is not valid, so PCRE searches
further into the string for occurrences of "a" or "b".
Perl has no direct equivalent of PCRE_NOTEMPTY, but it does
make a special case of a pattern match of the empty string
within its split() function, and when using the /g modifier.
It is possible to emulate Perl's behaviour after matching a
null string by first trying the match again at the same
offset with PCRE_NOTEMPTY set, and then if that fails by
advancing the starting offset (see below) and trying an
ordinary match again.
The subject string is passed to pcre_exec() as a pointer in
subject, a length in length, and a starting offset in star-
toffset. Unlike the pattern string, the subject may contain
binary zero bytes. When the starting offset is zero, the
search for a match starts at the beginning of the subject,
and this is by far the most common case.
If the pattern was compiled with the PCRE_UTF8 option, the
subject must be a sequence of bytes that is a valid UTF-8
string. If an invalid UTF-8 string is passed, PCRE's
behaviour is not defined.
A non-zero starting offset is useful when searching for
another match in the same subject by calling pcre_exec()
again after a previous success. Setting startoffset differs
from just passing over a shortened string and setting
PCRE_NOTBOL in the case of a pattern that begins with any
kind of lookbehind. For example, consider the pattern
\Biss\B
which finds occurrences of "iss" in the middle of words. (\B
matches only if the current position in the subject is not a
word boundary.) When applied to the string "Mississipi" the
first call to pcre_exec() finds the first occurrence. If
pcre_exec() is called again with just the remainder of the
subject, namely "issipi", it does not match, because \B is
always false at the start of the subject, which is deemed to
be a word boundary. However, if pcre_exec() is passed the
entire string again, but with startoffset set to 4, it finds
the second occurrence of "iss" because it is able to look
behind the starting point to discover that it is preceded by
a letter.
If a non-zero starting offset is passed when the pattern is
anchored, one attempt to match at the given offset is tried.
This can only succeed if the pattern does not require the
match to be at the start of the subject.
In general, a pattern matches a certain portion of the sub-
ject, and in addition, further substrings from the subject
may be picked out by parts of the pattern. Following the
usage in Jeffrey Friedl's book, this is called "capturing"
in what follows, and the phrase "capturing subpattern" is
used for a fragment of a pattern that picks out a substring.
PCRE supports several other kinds of parenthesized subpat-
tern that do not cause substrings to be captured.
Captured substrings are returned to the caller via a vector
of integer offsets whose address is passed in ovector. The
number of elements in the vector is passed in ovecsize. The
first two-thirds of the vector is used to pass back captured
substrings, each substring using a pair of integers. The
remaining third of the vector is used as workspace by
pcre_exec() while matching capturing subpatterns, and is not
available for passing back information. The length passed in
ovecsize should always be a multiple of three. If it is not,
it is rounded down.
When a match has been successful, information about captured
substrings is returned in pairs of integers, starting at the
beginning of ovector, and continuing up to two-thirds of its
length at the most. The first element of a pair is set to
the offset of the first character in a substring, and the
second is set to the offset of the first character after the
end of a substring. The first pair, ovector[0] and ovec-
tor[1], identify the portion of the subject string matched
by the entire pattern. The next pair is used for the first
capturing subpattern, and so on. The value returned by
pcre_exec() is the number of pairs that have been set. If
there are no capturing subpatterns, the return value from a
successful match is 1, indicating that just the first pair
of offsets has been set.
Some convenience functions are provided for extracting the
captured substrings as separate strings. These are described
in the following section.
It is possible for an capturing subpattern number n+1 to
match some part of the subject when subpattern n has not
been used at all. For example, if the string "abc" is
matched against the pattern (a|(z))(bc) subpatterns 1 and 3
are matched, but 2 is not. When this happens, both offset
values corresponding to the unused subpattern are set to -1.
If a capturing subpattern is matched repeatedly, it is the
last portion of the string that it matched that gets
returned.
If the vector is too small to hold all the captured sub-
strings, it is used as far as possible (up to two-thirds of
its length), and the function returns a value of zero. In
particular, if the substring offsets are not of interest,
pcre_exec() may be called with ovector passed as NULL and
ovecsize as zero. However, if the pattern contains back
references and the ovector isn't big enough to remember the
related substrings, PCRE has to get additional memory for
use during matching. Thus it is usually advisable to supply
an ovector.
Note that pcre_info() can be used to find out how many cap-
turing subpatterns there are in a compiled pattern. The
smallest size for ovector that will allow for n captured
substrings, in addition to the offsets of the substring
matched by the whole pattern, is (n+1)*3.
If pcre_exec() fails, it returns a negative number. The fol-
lowing are defined in the header file:
PCRE_ERROR_NOMATCH (-1)
The subject string did not match the pattern.
PCRE_ERROR_NULL (-2)
Either code or subject was passed as NULL, or ovector was
NULL and ovecsize was not zero.
PCRE_ERROR_BADOPTION (-3)
An unrecognized bit was set in the options argument.
PCRE_ERROR_BADMAGIC (-4)
PCRE stores a 4-byte "magic number" at the start of the com-
piled code, to catch the case when it is passed a junk
pointer. This is the error it gives when the magic number
isn't present.
PCRE_ERROR_UNKNOWN_NODE (-5)
While running the pattern match, an unknown item was encoun-
tered in the compiled pattern. This error could be caused by
a bug in PCRE or by overwriting of the compiled pattern.
PCRE_ERROR_NOMEMORY (-6)
If a pattern contains back references, but the ovector that
is passed to pcre_exec() is not big enough to remember the
referenced substrings, PCRE gets a block of memory at the
start of matching to use for this purpose. If the call via
pcre_malloc() fails, this error is given. The memory is
freed at the end of matching.
PCRE_ERROR_NOSUBSTRING (-7)
This error is used by the pcre_copy_substring(),
pcre_get_substring(), and pcre_get_substring_list() func-
tions (see below). It is never returned by pcre_exec().
PCRE_ERROR_MATCHLIMIT (-8)
The recursion and backtracking limit, as specified by the
match_limit field in a pcre_extra structure (or defaulted)
was reached. See the description above.
PCRE_ERROR_CALLOUT (-9)
This error is never generated by pcre_exec() itself. It is
provided for use by callout functions that want to yield a
distinctive error code. See the pcrecallout documentation
for details.
PCRE_ERROR_BADUTF8 (-10)
A string that contains an invalid UTF-8 byte sequence was
passed as a subject.
EXTRACTING CAPTURED SUBSTRINGS BY NUMBER
int pcre_copy_substring(const char *subject, int *ovector,
int stringcount, int stringnumber, char *buffer,
int buffersize);
int pcre_get_substring(const char *subject, int *ovector,
int stringcount, int stringnumber,
const char **stringptr);
int pcre_get_substring_list(const char *subject,
int *ovector, int stringcount, const char ***listptr);
Captured substrings can be accessed directly by using the
offsets returned by pcre_exec() in ovector. For convenience,
the functions pcre_copy_substring(), pcre_get_substring(),
and pcre_get_substring_list() are provided for extracting
captured substrings as new, separate, zero-terminated
strings. These functions identify substrings by number. The
next section describes functions for extracting named sub-
strings. A substring that contains a binary zero is
correctly extracted and has a further zero added on the end,
but the result is not, of course, a C string.
The first three arguments are the same for all three of
these functions: subject is the subject string which has
just been successfully matched, ovector is a pointer to the
vector of integer offsets that was passed to pcre_exec(),
and stringcount is the number of substrings that were cap-
tured by the match, including the substring that matched the
entire regular expression. This is the value returned by
pcre_exec if it is greater than zero. If pcre_exec()
returned zero, indicating that it ran out of space in ovec-
tor, the value passed as stringcount should be the size of
the vector divided by three.
The functions pcre_copy_substring() and pcre_get_substring()
extract a single substring, whose number is given as string-
number. A value of zero extracts the substring that matched
the entire pattern, while higher values extract the captured
substrings. For pcre_copy_substring(), the string is placed
in buffer, whose length is given by buffersize, while for
pcre_get_substring() a new block of memory is obtained via
pcre_malloc, and its address is returned via stringptr. The
yield of the function is the length of the string, not
including the terminating zero, or one of
PCRE_ERROR_NOMEMORY (-6)
The buffer was too small for pcre_copy_substring(), or the
attempt to get memory failed for pcre_get_substring().
PCRE_ERROR_NOSUBSTRING (-7)
There is no substring whose number is stringnumber.
The pcre_get_substring_list() function extracts all avail-
able substrings and builds a list of pointers to them. All
this is done in a single block of memory which is obtained
via pcre_malloc. The address of the memory block is returned
via listptr, which is also the start of the list of string
pointers. The end of the list is marked by a NULL pointer.
The yield of the function is zero if all went well, or
PCRE_ERROR_NOMEMORY (-6)
if the attempt to get the memory block failed.
When any of these functions encounter a substring that is
unset, which can happen when capturing subpattern number n+1
matches some part of the subject, but subpattern n has not
been used at all, they return an empty string. This can be
distinguished from a genuine zero-length substring by
inspecting the appropriate offset in ovector, which is nega-
tive for unset substrings.
The two convenience functions pcre_free_substring() and
pcre_free_substring_list() can be used to free the memory
returned by a previous call of pcre_get_substring() or
pcre_get_substring_list(), respectively. They do nothing
more than call the function pointed to by pcre_free, which
of course could be called directly from a C program. How-
ever, PCRE is used in some situations where it is linked via
a special interface to another programming language which
cannot use pcre_free directly; it is for these cases that
the functions are provided.
EXTRACTING CAPTURED SUBSTRINGS BY NAME
int pcre_copy_named_substring(const pcre *code,
const char *subject, int *ovector,
int stringcount, const char *stringname,
char *buffer, int buffersize);
int pcre_get_stringnumber(const pcre *code,
const char *name);
int pcre_get_named_substring(const pcre *code,
const char *subject, int *ovector,
int stringcount, const char *stringname,
const char **stringptr);
To extract a substring by name, you first have to find asso-
ciated number. This can be done by calling
pcre_get_stringnumber(). The first argument is the compiled
pattern, and the second is the name. For example, for this
pattern
ab(?<xxx>\d+)...
the number of the subpattern called "xxx" is 1. Given the
number, you can then extract the substring directly, or use
one of the functions described in the previous section. For
convenience, there are also two functions that do the whole
job.
Most of the arguments of pcre_copy_named_substring() and
pcre_get_named_substring() are the same as those for the
functions that extract by number, and so are not re-
described here. There are just two differences.
First, instead of a substring number, a substring name is
given. Second, there is an extra argument, given at the
start, which is a pointer to the compiled pattern. This is
needed in order to gain access to the name-to-number trans-
lation table.
These functions call pcre_get_stringnumber(), and if it
succeeds, they then call pcre_copy_substring() or
pcre_get_substring(), as appropriate.
Last updated: 20 August 2003
Copyright (c) 1997-2003 University of Cambridge.
-----------------------------------------------------------------------------
NAME
PCRE - Perl-compatible regular expressions
PCRE CALLOUTS
int (*pcre_callout)(pcre_callout_block *);
PCRE provides a feature called "callout", which is a means
of temporarily passing control to the caller of PCRE in the
middle of pattern matching. The caller of PCRE provides an
external function by putting its entry point in the global
variable pcre_callout. By default, this variable contains
NULL, which disables all calling out.
Within a regular expression, (?C) indicates the points at
which the external function is to be called. Different cal-
lout points can be identified by putting a number less than
256 after the letter C. The default value is zero. For
example, this pattern has two callout points:
(?C1)9abc(?C2)def
During matching, when PCRE reaches a callout point (and
pcre_callout is set), the external function is called. Its
only argument is a pointer to a pcre_callout block. This
contains the following variables:
int version;
int callout_number;
int *offset_vector;
const char *subject;
int subject_length;
int start_match;
int current_position;
int capture_top;
int capture_last;
void *callout_data;
The version field is an integer containing the version
number of the block format. The current version is zero. The
version number may change in future if additional fields are
added, but the intention is never to remove any of the
existing fields.
The callout_number field contains the number of the callout,
as compiled into the pattern (that is, the number after ?C).
The offset_vector field is a pointer to the vector of
offsets that was passed by the caller to pcre_exec(). The
contents can be inspected in order to extract substrings
that have been matched so far, in the same way as for
extracting substrings after a match has completed.
The subject and subject_length fields contain copies the
values that were passed to pcre_exec().
The start_match field contains the offset within the subject
at which the current match attempt started. If the pattern
is not anchored, the callout function may be called several
times for different starting points.
The current_position field contains the offset within the
subject of the current match pointer.
The capture_top field contains one more than the number of
the highest numbered captured substring so far. If no sub-
strings have been captured, the value of capture_top is one.
The capture_last field contains the number of the most
recently captured substring.
The callout_data field contains a value that is passed to
pcre_exec() by the caller specifically so that it can be
passed back in callouts. It is passed in the pcre_callout
field of the pcre_extra data structure. If no such data was
passed, the value of callout_data in a pcre_callout block is
NULL. There is a description of the pcre_extra structure in
the pcreapi documentation.
RETURN VALUES
The callout function returns an integer. If the value is
zero, matching proceeds as normal. If the value is greater
than zero, matching fails at the current point, but back-
tracking to test other possibilities goes ahead, just as if
a lookahead assertion had failed. If the value is less than
zero, the match is abandoned, and pcre_exec() returns the
value.
Negative values should normally be chosen from the set of
PCRE_ERROR_xxx values. In particular, PCRE_ERROR_NOMATCH
forces a standard "no match" failure. The error number
PCRE_ERROR_CALLOUT is reserved for use by callout functions;
it will never be used by PCRE itself.
Last updated: 21 January 2003
Copyright (c) 1997-2003 University of Cambridge.
-----------------------------------------------------------------------------
NAME
PCRE - Perl-compatible regular expressions
DIFFERENCES FROM PERL
This document describes the differences in the ways that
PCRE and Perl handle regular expressions. The differences
described here are with respect to Perl 5.8.
1. PCRE does not allow repeat quantifiers on lookahead
assertions. Perl permits them, but they do not mean what you
might think. For example, (?!a){3} does not assert that the
next three characters are not "a". It just asserts that the
next character is not "a" three times.
2. Capturing subpatterns that occur inside negative looka-
head assertions are counted, but their entries in the
offsets vector are never set. Perl sets its numerical vari-
ables from any such patterns that are matched before the
assertion fails to match something (thereby succeeding), but
only if the negative lookahead assertion contains just one
branch.
3. Though binary zero characters are supported in the sub-
ject string, they are not allowed in a pattern string
because it is passed as a normal C string, terminated by
zero. The escape sequence "\0" can be used in the pattern to
represent a binary zero.
4. The following Perl escape sequences are not supported:
\l, \u, \L, \U, \P, \p, and \X. In fact these are imple-
mented by Perl's general string-handling and are not part of
its pattern matching engine. If any of these are encountered
by PCRE, an error is generated.
5. PCRE does support the \Q...\E escape for quoting sub-
strings. Characters in between are treated as literals. This
is slightly different from Perl in that $ and @ are also
handled as literals inside the quotes. In Perl, they cause
variable interpolation (but of course PCRE does not have
variables). Note the following examples:
Pattern PCRE matches Perl matches
\Qabc$xyz\E abc$xyz abc followed by the
contents of $xyz
\Qabc\$xyz\E abc\$xyz abc\$xyz
\Qabc\E\$\Qxyz\E abc$xyz abc$xyz
In PCRE, the \Q...\E mechanism is not recognized inside a
character class.
8. Fairly obviously, PCRE does not support the (?{code}) and
(?p{code}) constructions. However, there is some experimen-
tal support for recursive patterns using the non-Perl items
(?R), (?number) and (?P>name). Also, the PCRE "callout"
feature allows an external function to be called during pat-
tern matching.
9. There are some differences that are concerned with the
settings of captured strings when part of a pattern is
repeated. For example, matching "aba" against the pattern
/^(a(b)?)+$/ in Perl leaves $2 unset, but in PCRE it is set
to "b".
10. PCRE provides some extensions to the Perl regular
expression facilities:
(a) Although lookbehind assertions must match fixed length
strings, each alternative branch of a lookbehind assertion
can match a different length of string. Perl requires them
all to have the same length.
(b) If PCRE_DOLLAR_ENDONLY is set and PCRE_MULTILINE is not
set, the $ meta-character matches only at the very end of
the string.
(c) If PCRE_EXTRA is set, a backslash followed by a letter
with no special meaning is faulted.
(d) If PCRE_UNGREEDY is set, the greediness of the repeti-
tion quantifiers is inverted, that is, by default they are
not greedy, but if followed by a question mark they are.
(e) PCRE_ANCHORED can be used to force a pattern to be tried
only at the first matching position in the subject string.
(f) The PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, and
PCRE_NO_AUTO_CAPTURE options for pcre_exec() have no Perl
equivalents.
(g) The (?R), (?number), and (?P>name) constructs allows for
recursive pattern matching (Perl can do this using the
(?p{code}) construct, which PCRE cannot support.)
(h) PCRE supports named capturing substrings, using the
Python syntax.
(i) PCRE supports the possessive quantifier "++" syntax,
taken from Sun's Java package.
(j) The (R) condition, for testing recursion, is a PCRE
extension.
(k) The callout facility is PCRE-specific.
Last updated: 03 February 2003
Copyright (c) 1997-2003 University of Cambridge.
-----------------------------------------------------------------------------
NAME
PCRE - Perl-compatible regular expressions
PCRE REGULAR EXPRESSION DETAILS
The syntax and semantics of the regular expressions sup-
ported by PCRE are described below. Regular expressions are
also described in the Perl documentation and in a number of
other books, some of which have copious examples. Jeffrey
Friedl's "Mastering Regular Expressions", published by
O'Reilly, covers them in great detail. The description here
is intended as reference documentation.
The basic operation of PCRE is on strings of bytes. However,
there is also support for UTF-8 character strings. To use
this support you must build PCRE to include UTF-8 support,
and then call pcre_compile() with the PCRE_UTF8 option. How
this affects the pattern matching is mentioned in several
places below. There is also a summary of UTF-8 features in
the section on UTF-8 support in the main pcre page.
A regular expression is a pattern that is matched against a
subject string from left to right. Most characters stand for
themselves in a pattern, and match the corresponding charac-
ters in the subject. As a trivial example, the pattern
The quick brown fox
matches a portion of a subject string that is identical to
itself. The power of regular expressions comes from the
ability to include alternatives and repetitions in the pat-
tern. These are encoded in the pattern by the use of meta-
characters, which do not stand for themselves but instead
are interpreted in some special way.
There are two different sets of meta-characters: those that
are recognized anywhere in the pattern except within square
brackets, and those that are recognized in square brackets.
Outside square brackets, the meta-characters are as follows:
\ general escape character with several uses
^ assert start of string (or line, in multiline mode)
$ assert end of string (or line, in multiline mode)
. match any character except newline (by default)
[ start character class definition
| start of alternative branch
( start subpattern
) end subpattern
? extends the meaning of (
also 0 or 1 quantifier
also quantifier minimizer
* 0 or more quantifier
+ 1 or more quantifier
also "possessive quantifier"
{ start min/max quantifier
Part of a pattern that is in square brackets is called a
"character class". In a character class the only meta-
characters are:
\ general escape character
^ negate the class, but only if the first character
- indicates character range
[ POSIX character class (only if followed by POSIX
syntax)
] terminates the character class
The following sections describe the use of each of the
meta-characters.
BACKSLASH
The backslash character has several uses. Firstly, if it is
followed by a non-alphameric character, it takes away any
special meaning that character may have. This use of
backslash as an escape character applies both inside and
outside character classes.
For example, if you want to match a * character, you write
\* in the pattern. This escaping action applies whether or
not the following character would otherwise be interpreted
as a meta-character, so it is always safe to precede a non-
alphameric with backslash to specify that it stands for
itself. In particular, if you want to match a backslash, you
write \\.
If a pattern is compiled with the PCRE_EXTENDED option, whi-
tespace in the pattern (other than in a character class) and
characters between a # outside a character class and the
&nb