doc/pcre.3

   1 .TH PCRE 3
   2 .SH NAME
   3 PCRE - Perl-compatible regular expressions
   4 .SH INTRODUCTION
   5 .rs
   6 .sp
   7 The PCRE library is a set of functions that implement regular expression
   8 pattern matching using the same syntax and semantics as Perl, with just a few
   9 differences. Some features that appeared in Python and PCRE before they
  10 appeared in Perl are also available using the Python syntax, there is some
  11 support for one or two .NET and Oniguruma syntax items, and there is an option
  12 for requesting some minor changes that give better JavaScript compatibility.
  13 .P
  14 The current implementation of PCRE corresponds approximately with Perl 5.12,
  15 including support for UTF-8 encoded strings and Unicode general category
  16 properties. However, UTF-8 and Unicode support has to be explicitly enabled; it
  17 is not the default. The Unicode tables correspond to Unicode release 5.2.0.
  18 .P
  19 In addition to the Perl-compatible matching function, PCRE contains an
  20 alternative function that matches the same compiled patterns in a different
  21 way. In certain circumstances, the alternative function has some advantages.
  22 For a discussion of the two matching algorithms, see the
  23 .\" HREF
  24 \fBpcrematching\fP
  25 .\"
  26 page.
  27 .P
  28 PCRE is written in C and released as a C library. A number of people have
  29 written wrappers and interfaces of various kinds. In particular, Google Inc.
  30 have provided a comprehensive C++ wrapper. This is now included as part of the
  31 PCRE distribution. The
  32 .\" HREF
  33 \fBpcrecpp\fP
  34 .\"
  35 page has details of this interface. Other people's contributions can be found
  36 in the \fIContrib\fR directory at the primary FTP site, which is:
  37 .sp
  38 .\" HTML <a href="ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre">
  39 .\" </a>
  40 ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre
  41 .P
  42 Details of exactly which Perl regular expression features are and are not
  43 supported by PCRE are given in separate documents. See the
  44 .\" HREF
  45 \fBpcrepattern\fR
  46 .\"
  47 and
  48 .\" HREF
  49 \fBpcrecompat\fR
  50 .\"
  51 pages. There is a syntax summary in the
  52 .\" HREF
  53 \fBpcresyntax\fR
  54 .\"
  55 page.
  56 .P
  57 Some features of PCRE can be included, excluded, or changed when the library is
  58 built. The
  59 .\" HREF
  60 \fBpcre_config()\fR
  61 .\"
  62 function makes it possible for a client to discover which features are
  63 available. The features themselves are described in the
  64 .\" HREF
  65 \fBpcrebuild\fP
  66 .\"
  67 page. Documentation about building PCRE for various operating systems can be
  68 found in the \fBREADME\fP and \fBNON-UNIX-USE\fP files in the source
  69 distribution.
  70 .P
  71 The library contains a number of undocumented internal functions and data
  72 tables that are used by more than one of the exported external functions, but
  73 which are not intended for use by external callers. Their names all begin with
  74 "_pcre_", which hopefully will not provoke any name clashes. In some
  75 environments, it is possible to control which external symbols are exported
  76 when a shared library is built, and in these cases the undocumented symbols are
  77 not exported.
  78 .
  79 .
  80 .SH "USER DOCUMENTATION"
  81 .rs
  82 .sp
  83 The user documentation for PCRE comprises a number of different sections. In
  84 the "man" format, each of these is a separate "man page". In the HTML format,
  85 each is a separate page, linked from the index page. In the plain text format,
  86 all the sections, except the \fBpcredemo\fP section, are concatenated, for ease
  87 of searching. The sections are as follows:
  88 .sp
  89   pcre              this document
  90   pcre-config       show PCRE installation configuration information
  91   pcreapi           details of PCRE's native C API
  92   pcrebuild         options for building PCRE
  93   pcrecallout       details of the callout feature
  94   pcrecompat        discussion of Perl compatibility
  95   pcrecpp           details of the C++ wrapper
  96   pcredemo          a demonstration C program that uses PCRE
  97   pcregrep          description of the \fBpcregrep\fP command
  98   pcrematching      discussion of the two matching algorithms
  99   pcrepartial       details of the partial matching facility
 100 .\" JOIN
 101   pcrepattern       syntax and semantics of supported
 102                       regular expressions
 103   pcreperform       discussion of performance issues
 104   pcreposix         the POSIX-compatible C API
 105   pcreprecompile    details of saving and re-using precompiled patterns
 106   pcresample        discussion of the pcredemo program
 107   pcrestack         discussion of stack usage
 108   pcresyntax        quick syntax reference
 109   pcretest          description of the \fBpcretest\fP testing command
 110 .sp
 111 In addition, in the "man" and HTML formats, there is a short page for each
 112 C library function, listing its arguments and results.
 113 .
 114 .
 115 .SH LIMITATIONS
 116 .rs
 117 .sp
 118 There are some size limitations in PCRE but it is hoped that they will never in
 119 practice be relevant.
 120 .P
 121 The maximum length of a compiled pattern is 65539 (sic) bytes if PCRE is
 122 compiled with the default internal linkage size of 2. If you want to process
 123 regular expressions that are truly enormous, you can compile PCRE with an
 124 internal linkage size of 3 or 4 (see the \fBREADME\fP file in the source
 125 distribution and the
 126 .\" HREF
 127 \fBpcrebuild\fP
 128 .\"
 129 documentation for details). In these cases the limit is substantially larger.
 130 However, the speed of execution is slower.
 131 .P
 132 All values in repeating quantifiers must be less than 65536.
 133 .P
 134 There is no limit to the number of parenthesized subpatterns, but there can be
 135 no more than 65535 capturing subpatterns.
 136 .P
 137 The maximum length of name for a named subpattern is 32 characters, and the
 138 maximum number of named subpatterns is 10000.
 139 .P
 140 The maximum length of a subject string is the largest positive number that an
 141 integer variable can hold. However, when using the traditional matching
 142 function, PCRE uses recursion to handle subpatterns and indefinite repetition.
 143 This means that the available stack space may limit the size of a subject
 144 string that can be processed by certain patterns. For a discussion of stack
 145 issues, see the
 146 .\" HREF
 147 \fBpcrestack\fP
 148 .\"
 149 documentation.
 150 .
 151 .
 152 .\" HTML <a name="utf8support"></a>
 153 .SH "UTF-8 AND UNICODE PROPERTY SUPPORT"
 154 .rs
 155 .sp
 156 From release 3.3, PCRE has had some support for character strings encoded in
 157 the UTF-8 format. For release 4.0 this was greatly extended to cover most
 158 common requirements, and in release 5.0 additional support for Unicode general
 159 category properties was added.
 160 .P
 161 In order process UTF-8 strings, you must build PCRE to include UTF-8 support in
 162 the code, and, in addition, you must call
 163 .\" HREF
 164 \fBpcre_compile()\fP
 165 .\"
 166 with the PCRE_UTF8 option flag, or the pattern must start with the sequence
 167 (*UTF8). When either of these is the case, both the pattern and any subject
 168 strings that are matched against it are treated as UTF-8 strings instead of
 169 strings of 1-byte characters.
 170 .P
 171 If you compile PCRE with UTF-8 support, but do not use it at run time, the
 172 library will be a bit bigger, but the additional run time overhead is limited
 173 to testing the PCRE_UTF8 flag occasionally, so should not be very big.
 174 .P
 175 If PCRE is built with Unicode character property support (which implies UTF-8
 176 support), the escape sequences \ep{..}, \eP{..}, and \eX are supported.
 177 The available properties that can be tested are limited to the general
 178 category properties such as Lu for an upper case letter or Nd for a decimal
 179 number, the Unicode script names such as Arabic or Han, and the derived
 180 properties Any and L&. A full list is given in the
 181 .\" HREF
 182 \fBpcrepattern\fP
 183 .\"
 184 documentation. Only the short names for properties are supported. For example,
 185 \ep{L} matches a letter. Its Perl synonym, \ep{Letter}, is not supported.
 186 Furthermore, in Perl, many properties may optionally be prefixed by "Is", for
 187 compatibility with Perl 5.6. PCRE does not support this.
 188 .
 189 .
 190 .\" HTML <a name="utf8strings"></a>
 191 .SS "Validity of UTF-8 strings"
 192 .rs
 193 .sp
 194 When you set the PCRE_UTF8 flag, the strings passed as patterns and subjects
 195 are (by default) checked for validity on entry to the relevant functions. From
 196 release 7.3 of PCRE, the check is according the rules of RFC 3629, which are
 197 themselves derived from the Unicode specification. Earlier releases of PCRE
 198 followed the rules of RFC 2279, which allows the full range of 31-bit values (0
 199 to 0x7FFFFFFF). The current check allows only values in the range U+0 to
 200 U+10FFFF, excluding U+D800 to U+DFFF.
 201 .P
 202 The excluded code points are the "Low Surrogate Area" of Unicode, of which the
 203 Unicode Standard says this: "The Low Surrogate Area does not contain any
 204 character assignments, consequently no character code charts or namelists are
 205 provided for this area. Surrogates are reserved for use with UTF-16 and then
 206 must be used in pairs." The code points that are encoded by UTF-16 pairs are
 207 available as independent code points in the UTF-8 encoding. (In other words,
 208 the whole surrogate thing is a fudge for UTF-16 which unfortunately messes up
 209 UTF-8.)
 210 .P
 211 If an invalid UTF-8 string is passed to PCRE, an error return
 212 (PCRE_ERROR_BADUTF8) is given. In some situations, you may already know that
 213 your strings are valid, and therefore want to skip these checks in order to
 214 improve performance. If you set the PCRE_NO_UTF8_CHECK flag at compile time or
 215 at run time, PCRE assumes that the pattern or subject it is given
 216 (respectively) contains only valid UTF-8 codes. In this case, it does not
 217 diagnose an invalid UTF-8 string.
 218 .P
 219 If you pass an invalid UTF-8 string when PCRE_NO_UTF8_CHECK is set, what
 220 happens depends on why the string is invalid. If the string conforms to the
 221 "old" definition of UTF-8 (RFC 2279), it is processed as a string of characters
 222 in the range 0 to 0x7FFFFFFF. In other words, apart from the initial validity
 223 test, PCRE (when in UTF-8 mode) handles strings according to the more liberal
 224 rules of RFC 2279. However, if the string does not even conform to RFC 2279,
 225 the result is undefined. Your program may crash.
 226 .P
 227 If you want to process strings of values in the full range 0 to 0x7FFFFFFF,
 228 encoded in a UTF-8-like manner as per the old RFC, you can set
 229 PCRE_NO_UTF8_CHECK to bypass the more restrictive test. However, in this
 230 situation, you will have to apply your own validity check.
 231 .
 232 .
 233 .SS "General comments about UTF-8 mode"
 234 .rs
 235 .sp
 236 1. An unbraced hexadecimal escape sequence (such as \exb3) matches a two-byte
 237 UTF-8 character if the value is greater than 127.
 238 .P
 239 2. Octal numbers up to \e777 are recognized, and match two-byte UTF-8
 240 characters for values greater than \e177.
 241 .P
 242 3. Repeat quantifiers apply to complete UTF-8 characters, not to individual
 243 bytes, for example: \ex{100}{3}.
 244 .P
 245 4. The dot metacharacter matches one UTF-8 character instead of a single byte.
 246 .P
 247 5. The escape sequence \eC can be used to match a single byte in UTF-8 mode,
 248 but its use can lead to some strange effects. This facility is not available in
 249 the alternative matching function, \fBpcre_dfa_exec()\fP.
 250 .P
 251 6. The character escapes \eb, \eB, \ed, \eD, \es, \eS, \ew, and \eW correctly
 252 test characters of any code value, but, by default, the characters that PCRE
 253 recognizes as digits, spaces, or word characters remain the same set as before,
 254 all with values less than 256. This remains true even when PCRE is built to
 255 include Unicode property support, because to do otherwise would slow down PCRE
 256 in many common cases. Note in particular that this applies to \eb and \eB,
 257 because they are defined in terms of \ew and \eW. If you really want to test
 258 for a wider sense of, say, "digit", you can use explicit Unicode property tests
 259 such as \ep{Nd}. Alternatively, if you set the PCRE_UCP option, the way that
 260 the character escapes work is changed so that Unicode properties are used to
 261 determine which characters match. There are more details in the section on
 262 .\" HTML <a href="pcrepattern.html#genericchartypes">
 263 .\" </a>
 264 generic character types
 265 .\"
 266 in the
 267 .\" HREF
 268 \fBpcrepattern\fP
 269 .\"
 270 documentation.
 271 .P
 272 7. Similarly, characters that match the POSIX named character classes are all
 273 low-valued characters, unless the PCRE_UCP option is set.
 274 .P
 275 8. However, the horizontal and vertical whitespace matching escapes (\eh, \eH,
 276 \ev, and \eV) do match all the appropriate Unicode characters, whether or not
 277 PCRE_UCP is set.
 278 .P
 279 9. Case-insensitive matching applies only to characters whose values are less
 280 than 128, unless PCRE is built with Unicode property support. Even when Unicode
 281 property support is available, PCRE still uses its own character tables when
 282 checking the case of low-valued characters, so as not to degrade performance.
 283 The Unicode property information is used only for characters with higher
 284 values. Furthermore, PCRE supports case-insensitive matching only when there is
 285 a one-to-one mapping between a letter's cases. There are a small number of
 286 many-to-one mappings in Unicode; these are not supported by PCRE.
 287 .
 288 .
 289 .SH AUTHOR
 290 .rs
 291 .sp
 292 .nf
 293 Philip Hazel
 294 University Computing Service
 295 Cambridge CB2 3QH, England.
 296 .fi
 297 .P
 298 Putting an actual email address here seems to have been a spam magnet, so I've
 299 taken it away. If you want to email me, use my two initials, followed by the
 300 two digits 10, at the domain cam.ac.uk.
 301 .
 302 .
 303 .SH REVISION
 304 .rs
 305 .sp
 306 .nf
 307 Last updated: 13 November 2010
 308 Copyright (c) 1997-2010 University of Cambridge.
 309 .fi