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

Diff of /code/trunk/doc/pcre.3

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 182 by ph10, Wed Jun 13 15:09:54 2007 UTC revision 861 by ph10, Tue Jan 10 14:54:28 2012 UTC
# Line 6  PCRE - Perl-compatible regular expressio Line 6  PCRE - Perl-compatible regular expressio
6  .sp  .sp
7  The PCRE library is a set of functions that implement regular expression  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  pattern matching using the same syntax and semantics as Perl, with just a few
9  differences. (Certain features that appeared in Python and PCRE before they  differences. Some features that appeared in Python and PCRE before they
10  appeared in Perl are also available using the Python syntax.)  appeared in Perl are also available using the Python syntax, there is some
11  .P  support for one or two .NET and Oniguruma syntax items, and there is an option
12  The current implementation of PCRE (release 7.x) corresponds approximately with  for requesting some minor changes that give better JavaScript compatibility.
13  Perl 5.10, including support for UTF-8 encoded strings and Unicode general  .P
14  category properties. However, UTF-8 and Unicode support has to be explicitly  Starting with release 8.30, it is possible to compile two separate PCRE
15  enabled; it is not the default. The Unicode tables correspond to Unicode  libraries: the original, which supports 8-bit character strings (including
16  release 5.0.0.  UTF-8 strings), and a second library that supports 16-bit character strings
17    (including UTF-16 strings). The build process allows either one or both to be
18    built. The majority of the work to make this possible was done by Zoltan
19    Herczeg.
20    .P
21    The two libraries contain identical sets of functions, except that the names in
22    the 16-bit library start with \fBpcre16_\fP instead of \fBpcre_\fP. To avoid
23    over-complication and reduce the documentation maintenance load, most of the
24    documentation describes the 8-bit library, with the differences for the 16-bit
25    library described separately in the
26    .\" HREF
27    \fBpcre16\fP
28    .\"
29    page. References to functions or structures of the form \fIpcre[16]_xxx\fP
30    should be read as meaning "\fIpcre_xxx\fP when using the 8-bit library and
31    \fIpcre16_xxx\fP when using the 16-bit library".
32    .P
33    The current implementation of PCRE corresponds approximately with Perl 5.12,
34    including support for UTF-8/16 encoded strings and Unicode general category
35    properties. However, UTF-8/16 and Unicode support has to be explicitly enabled;
36    it is not the default. The Unicode tables correspond to Unicode release 6.0.0.
37  .P  .P
38  In addition to the Perl-compatible matching function, PCRE contains an  In addition to the Perl-compatible matching function, PCRE contains an
39  alternative matching function that matches the same compiled patterns in a  alternative function that matches the same compiled patterns in a different
40  different way. In certain circumstances, the alternative function has some  way. In certain circumstances, the alternative function has some advantages.
41  advantages. For a discussion of the two matching algorithms, see the  For a discussion of the two matching algorithms, see the
42  .\" HREF  .\" HREF
43  \fBpcrematching\fP  \fBpcrematching\fP
44  .\"  .\"
# Line 26  page. Line 46  page.
46  .P  .P
47  PCRE is written in C and released as a C library. A number of people have  PCRE is written in C and released as a C library. A number of people have
48  written wrappers and interfaces of various kinds. In particular, Google Inc.  written wrappers and interfaces of various kinds. In particular, Google Inc.
49  have provided a comprehensive C++ wrapper. This is now included as part of the  have provided a comprehensive C++ wrapper for the 8-bit library. This is now
50  PCRE distribution. The  included as part of the PCRE distribution. The
51  .\" HREF  .\" HREF
52  \fBpcrecpp\fP  \fBpcrecpp\fP
53  .\"  .\"
54  page has details of this interface. Other people's contributions can be found  page has details of this interface. Other people's contributions can be found
55  in the \fIContrib\fR directory at the primary FTP site, which is:  in the \fIContrib\fP directory at the primary FTP site, which is:
56  .sp  .sp
57  .\" HTML <a href="ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre">  .\" HTML <a href="ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre">
58  .\" </a>  .\" </a>
# Line 41  ftp://ftp.csx.cam.ac.uk/pub/software/pro Line 61  ftp://ftp.csx.cam.ac.uk/pub/software/pro
61  Details of exactly which Perl regular expression features are and are not  Details of exactly which Perl regular expression features are and are not
62  supported by PCRE are given in separate documents. See the  supported by PCRE are given in separate documents. See the
63  .\" HREF  .\" HREF
64  \fBpcrepattern\fR  \fBpcrepattern\fP
65  .\"  .\"
66  and  and
67  .\" HREF  .\" HREF
68  \fBpcrecompat\fR  \fBpcrecompat\fP
69    .\"
70    pages. There is a syntax summary in the
71    .\" HREF
72    \fBpcresyntax\fP
73  .\"  .\"
74  pages.  page.
75  .P  .P
76  Some features of PCRE can be included, excluded, or changed when the library is  Some features of PCRE can be included, excluded, or changed when the library is
77  built. The  built. The
78  .\" HREF  .\" HREF
79  \fBpcre_config()\fR  \fBpcre_config()\fP
80  .\"  .\"
81  function makes it possible for a client to discover which features are  function makes it possible for a client to discover which features are
82  available. The features themselves are described in the  available. The features themselves are described in the
# Line 60  available. The features themselves are d Line 84  available. The features themselves are d
84  \fBpcrebuild\fP  \fBpcrebuild\fP
85  .\"  .\"
86  page. Documentation about building PCRE for various operating systems can be  page. Documentation about building PCRE for various operating systems can be
87  found in the \fBREADME\fP file in the source distribution.  found in the \fBREADME\fP and \fBNON-UNIX-USE\fP files in the source
88    distribution.
89  .P  .P
90  The library contains a number of undocumented internal functions and data  The libraries contains a number of undocumented internal functions and data
91  tables that are used by more than one of the exported external functions, but  tables that are used by more than one of the exported external functions, but
92  which are not intended for use by external callers. Their names all begin with  which are not intended for use by external callers. Their names all begin with
93  "_pcre_", which hopefully will not provoke any name clashes. In some  "_pcre_" or "_pcre16_", which hopefully will not provoke any name clashes. In
94  environments, it is possible to control which external symbols are exported  some environments, it is possible to control which external symbols are
95  when a shared library is built, and in these cases the undocumented symbols are  exported when a shared library is built, and in these cases the undocumented
96  not exported.  symbols are not exported.
97  .  .
98  .  .
99  .SH "USER DOCUMENTATION"  .SH "USER DOCUMENTATION"
# Line 77  not exported. Line 102  not exported.
102  The user documentation for PCRE comprises a number of different sections. In  The user documentation for PCRE comprises a number of different sections. In
103  the "man" format, each of these is a separate "man page". In the HTML format,  the "man" format, each of these is a separate "man page". In the HTML format,
104  each is a separate page, linked from the index page. In the plain text format,  each is a separate page, linked from the index page. In the plain text format,
105  all the sections are concatenated, for ease of searching. The sections are as  all the sections, except the \fBpcredemo\fP section, are concatenated, for ease
106  follows:  of searching. The sections are as follows:
107  .sp  .sp
108    pcre              this document    pcre              this document
109      pcre16            details of the 16-bit library
110    pcre-config       show PCRE installation configuration information    pcre-config       show PCRE installation configuration information
111    pcreapi           details of PCRE's native C API    pcreapi           details of PCRE's native C API
112    pcrebuild         options for building PCRE    pcrebuild         options for building PCRE
113    pcrecallout       details of the callout feature    pcrecallout       details of the callout feature
114    pcrecompat        discussion of Perl compatibility    pcrecompat        discussion of Perl compatibility
115    pcrecpp           details of the C++ wrapper    pcrecpp           details of the C++ wrapper for the 8-bit library
116    pcregrep          description of the \fBpcregrep\fP command    pcredemo          a demonstration C program that uses PCRE
117      pcregrep          description of the \fBpcregrep\fP command (8-bit only)
118      pcrejit           discussion of the just-in-time optimization support
119      pcrelimits        details of size and other limits
120    pcrematching      discussion of the two matching algorithms    pcrematching      discussion of the two matching algorithms
121    pcrepartial       details of the partial matching facility    pcrepartial       details of the partial matching facility
122  .\" JOIN  .\" JOIN
123    pcrepattern       syntax and semantics of supported    pcrepattern       syntax and semantics of supported
124                        regular expressions                        regular expressions
125    pcreperform       discussion of performance issues    pcreperform       discussion of performance issues
126    pcreposix         the POSIX-compatible C API    pcreposix         the POSIX-compatible C API for the 8-bit library
127    pcreprecompile    details of saving and re-using precompiled patterns    pcreprecompile    details of saving and re-using precompiled patterns
128    pcresample        discussion of the sample program    pcresample        discussion of the pcredemo program
129    pcrestack         discussion of stack usage    pcrestack         discussion of stack usage
130      pcresyntax        quick syntax reference
131    pcretest          description of the \fBpcretest\fP testing command    pcretest          description of the \fBpcretest\fP testing command
132      pcreunicode       discussion of Unicode and UTF-8/16 support
133  .sp  .sp
134  In addition, in the "man" and HTML formats, there is a short page for each  In addition, in the "man" and HTML formats, there is a short page for each
135  C library function, listing its arguments and results.  8-bit C library function, listing its arguments and results.
 .  
 .  
 .SH LIMITATIONS  
 .rs  
 .sp  
 There are some size limitations in PCRE but it is hoped that they will never in  
 practice be relevant.  
 .P  
 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 \fBREADME\fP file in the source  
 distribution and the  
 .\" HREF  
 \fBpcrebuild\fP  
 .\"  
 documentation for details). In these cases the limit is substantially larger.  
 However, the speed of execution is slower.  
 .P  
 All values in repeating quantifiers must be less than 65536. The maximum  
 compiled length of subpattern with an explicit repeat count is 30000 bytes. The  
 maximum number of capturing subpatterns is 65535.  
 .P  
 There is no limit to the number of parenthesized subpatterns, but there can be  
 no more than 65535 capturing subpatterns.  
 .P  
 The maximum length of name for a named subpattern is 32 characters, and the  
 maximum number of named subpatterns is 10000.  
 .P  
 The maximum length of a subject string is the largest positive number that an  
 integer variable can hold. However, when using the traditional matching  
 function, PCRE uses recursion to handle subpatterns and indefinite repetition.  
 This means that the available stack space may limit the size of a subject  
 string that can be processed by certain patterns. For a discussion of stack  
 issues, see the  
 .\" HREF  
 \fBpcrestack\fP  
 .\"  
 documentation.  
 .sp  
 .\" HTML <a name="utf8support"></a>  
 .  
 .  
 .SH "UTF-8 AND UNICODE PROPERTY SUPPORT"  
 .rs  
 .sp  
 From release 3.3, PCRE has had some support for character strings encoded in  
 the UTF-8 format. For release 4.0 this was greatly extended to cover most  
 common requirements, and in release 5.0 additional support for Unicode general  
 category properties was added.  
 .P  
 In order process UTF-8 strings, you must build PCRE to include UTF-8 support in  
 the code, and, in addition, you must call  
 .\" HREF  
 \fBpcre_compile()\fP  
 .\"  
 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.  
 .P  
 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 additional run time overhead is limited  
 to testing the PCRE_UTF8 flag occasionally, so should not be very big.  
 .P  
 If PCRE is built with Unicode character property support (which implies UTF-8  
 support), the escape sequences \ep{..}, \eP{..}, and \eX are supported.  
 The available properties that can be tested are limited to the general  
 category properties such as Lu for an upper case letter or Nd for a decimal  
 number, the Unicode script names such as Arabic or Han, and the derived  
 properties Any and L&. A full list is given in the  
 .\" HREF  
 \fBpcrepattern\fP  
 .\"  
 documentation. Only the short names for properties are supported. For example,  
 \ep{L} matches a letter. Its Perl synonym, \ep{Letter}, is not supported.  
 Furthermore, in Perl, many properties may optionally be prefixed by "Is", for  
 compatibility with Perl 5.6. PCRE does not support this.  
 .P  
 The following comments apply when PCRE is running in UTF-8 mode:  
 .P  
 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.  
 .P  
 2. An unbraced hexadecimal escape sequence (such as \exb3) matches a two-byte  
 UTF-8 character if the value is greater than 127.  
 .P  
 3. Octal numbers up to \e777 are recognized, and match two-byte UTF-8  
 characters for values greater than \e177.  
 .P  
 4. Repeat quantifiers apply to complete UTF-8 characters, not to individual  
 bytes, for example: \ex{100}{3}.  
 .P  
 5. The dot metacharacter matches one UTF-8 character instead of a single byte.  
 .P  
 6. The escape sequence \eC can be used to match a single byte in UTF-8 mode,  
 but its use can lead to some strange effects. This facility is not available in  
 the alternative matching function, \fBpcre_dfa_exec()\fP.  
 .P  
 7. The character escapes \eb, \eB, \ed, \eD, \es, \eS, \ew, and \eW correctly  
 test characters of any code value, but the characters that PCRE recognizes as  
 digits, spaces, or word characters remain the same set as before, all with  
 values less than 256. This remains true even when PCRE includes Unicode  
 property support, because to do otherwise would slow down PCRE in many common  
 cases. If you really want to test for a wider sense of, say, "digit", you  
 must use Unicode property tests such as \ep{Nd}.  
 .P  
 8. Similarly, characters that match the POSIX named character classes are all  
 low-valued characters.  
 .P  
 9. However, the Perl 5.10 horizontal and vertical whitespace matching escapes  
 (\eh, \eH, \ev, and \eV) do match all the appropriate Unicode characters.  
 .P  
 10. Case-insensitive matching applies only to characters whose values are less  
 than 128, unless PCRE is built with Unicode property support. Even when Unicode  
 property support is available, PCRE still uses its own character tables when  
 checking the case of low-valued characters, so as not to degrade performance.  
 The Unicode property information is used only for characters with higher  
 values. Even when Unicode property support is available, PCRE supports  
 case-insensitive matching only when there is a one-to-one mapping between a  
 letter's cases. There are a small number of many-to-one mappings in Unicode;  
 these are not supported by PCRE.  
136  .  .
137  .  .
138  .SH AUTHOR  .SH AUTHOR
# Line 251  two digits 10, at the domain cam.ac.uk. Line 153  two digits 10, at the domain cam.ac.uk.
153  .rs  .rs
154  .sp  .sp
155  .nf  .nf
156  Last updated: 13 June 2007  Last updated: 10 January 2012
157  Copyright (c) 1997-2007 University of Cambridge.  Copyright (c) 1997-2012 University of Cambridge.
158  .fi  .fi

Legend:
Removed from v.182  
changed lines
  Added in v.861

  ViewVC Help
Powered by ViewVC 1.1.5