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

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

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

revision 75 by nigel, Sat Feb 24 21:40:37 2007 UTC revision 99 by ph10, Tue Mar 6 12:27:42 2007 UTC
# Line 7  Line 7 
7  <p>  <p>
8  Return to the <a href="index.html">PCRE index page</a>.  Return to the <a href="index.html">PCRE index page</a>.
9  </p>  </p>
10  <p>  <p>
11  This page is part of the PCRE HTML documentation. It was generated automatically  This page is part of the PCRE HTML documentation. It was generated automatically
12  from the original man page. If there is any nonsense in it, please consult the  from the original man page. If there is any nonsense in it, please consult the
13  man page, in case the conversion went wrong.  man page, in case the conversion went wrong.
14  <br>  <br>
15  <ul>  <ul>
16  <li><a name="TOC1" href="#SEC1">INTRODUCTION</a>  <li><a name="TOC1" href="#SEC1">INTRODUCTION</a>
17  <li><a name="TOC2" href="#SEC2">USER DOCUMENTATION</a>  <li><a name="TOC2" href="#SEC2">USER DOCUMENTATION</a>
18  <li><a name="TOC3" href="#SEC3">LIMITATIONS</a>  <li><a name="TOC3" href="#SEC3">LIMITATIONS</a>
19  <li><a name="TOC4" href="#SEC4">UTF-8 AND UNICODE PROPERTY SUPPORT</a>  <li><a name="TOC4" href="#SEC4">UTF-8 AND UNICODE PROPERTY SUPPORT</a>
20  <li><a name="TOC5" href="#SEC5">AUTHOR</a>  <li><a name="TOC5" href="#SEC5">AUTHOR</a>
21    <li><a name="TOC6" href="#SEC6">REVISION</a>
22  </ul>  </ul>
23  <br><a name="SEC1" href="#TOC1">INTRODUCTION</a><br>  <br><a name="SEC1" href="#TOC1">INTRODUCTION</a><br>
24  <P>  <P>
25  The PCRE library is a set of functions that implement regular expression  The PCRE library is a set of functions that implement regular expression
26  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
27  differences. The current implementation of PCRE (release 5.x) corresponds  differences. (Certain features that appeared in Python and PCRE before they
28  approximately with Perl 5.8, including support for UTF-8 encoded strings and  appeared in Perl are also available using the Python syntax.)
29  Unicode general category properties. However, this support has to be explicitly  </P>
30  enabled; it is not the default.  <P>
31    The current implementation of PCRE (release 7.x) corresponds approximately with
32    Perl 5.10, including support for UTF-8 encoded strings and Unicode general
33    category properties. However, UTF-8 and Unicode support has to be explicitly
34    enabled; it is not the default. The Unicode tables correspond to Unicode
35    release 5.0.0.
36    </P>
37    <P>
38    In addition to the Perl-compatible matching function, PCRE contains an
39    alternative matching function that matches the same compiled patterns in a
40    different way. In certain circumstances, the alternative function has some
41    advantages. For a discussion of the two matching algorithms, see the
42    <a href="pcrematching.html"><b>pcrematching</b></a>
43    page.
44  </P>  </P>
45  <P>  <P>
46  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
47  written wrappers and interfaces of various kinds. A C++ class is included in  written wrappers and interfaces of various kinds. In particular, Google Inc.
48  these contributions, which can be found in the <i>Contrib</i> directory at the  have provided a comprehensive C++ wrapper. This is now included as part of the
49  primary FTP site, which is:  PCRE distribution. The
50    <a href="pcrecpp.html"><b>pcrecpp</b></a>
51    page has details of this interface. Other people's contributions can be found
52    in the <i>Contrib</i> directory at the primary FTP site, which is:
53  <a href="ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre">ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre</a>  <a href="ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre">ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre</a>
54  </P>  </P>
55  <P>  <P>
# Line 53  available. The features themselves are d Line 70  available. The features themselves are d
70  page. Documentation about building PCRE for various operating systems can be  page. Documentation about building PCRE for various operating systems can be
71  found in the <b>README</b> file in the source distribution.  found in the <b>README</b> file in the source distribution.
72  </P>  </P>
73    <P>
74    The library contains a number of undocumented internal functions and data
75    tables that are used by more than one of the exported external functions, but
76    which are not intended for use by external callers. Their names all begin with
77    "_pcre_", which hopefully will not provoke any name clashes. In some
78    environments, it is possible to control which external symbols are exported
79    when a shared library is built, and in these cases the undocumented symbols are
80    not exported.
81    </P>
82  <br><a name="SEC2" href="#TOC1">USER DOCUMENTATION</a><br>  <br><a name="SEC2" href="#TOC1">USER DOCUMENTATION</a><br>
83  <P>  <P>
84  The user documentation for PCRE comprises a number of different sections. In  The user documentation for PCRE comprises a number of different sections. In
# Line 62  all the sections are concatenated, for e Line 88  all the sections are concatenated, for e
88  follows:  follows:
89  <pre>  <pre>
90    pcre              this document    pcre              this document
91    pcreapi           details of PCRE's native API    pcreapi           details of PCRE's native C API
92    pcrebuild         options for building PCRE    pcrebuild         options for building PCRE
93    pcrecallout       details of the callout feature    pcrecallout       details of the callout feature
94    pcrecompat        discussion of Perl compatibility    pcrecompat        discussion of Perl compatibility
95      pcrecpp           details of the C++ wrapper
96    pcregrep          description of the <b>pcregrep</b> command    pcregrep          description of the <b>pcregrep</b> command
97      pcrematching      discussion of the two matching algorithms
98    pcrepartial       details of the partial matching facility    pcrepartial       details of the partial matching facility
99    pcrepattern       syntax and semantics of supported regular expressions    pcrepattern       syntax and semantics of supported regular expressions
100    pcreperform       discussion of performance issues    pcreperform       discussion of performance issues
101    pcreposix         the POSIX-compatible API    pcreposix         the POSIX-compatible C API
102    pcreprecompile    details of saving and re-using precompiled patterns    pcreprecompile    details of saving and re-using precompiled patterns
103    pcresample        discussion of the sample program    pcresample        discussion of the sample program
104      pcrestack         discussion of stack usage
105    pcretest          description of the <b>pcretest</b> testing command    pcretest          description of the <b>pcretest</b> testing command
106  </pre>  </pre>
107  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
108  library function, listing its arguments and results.  C library function, listing its arguments and results.
109  </P>  </P>
110  <br><a name="SEC3" href="#TOC1">LIMITATIONS</a><br>  <br><a name="SEC3" href="#TOC1">LIMITATIONS</a><br>
111  <P>  <P>
# Line 91  internal linkage size of 3 or 4 (see the Line 120  internal linkage size of 3 or 4 (see the
120  distribution and the  distribution and the
121  <a href="pcrebuild.html"><b>pcrebuild</b></a>  <a href="pcrebuild.html"><b>pcrebuild</b></a>
122  documentation for details). In these cases the limit is substantially larger.  documentation for details). In these cases the limit is substantially larger.
123  However, the speed of execution will be slower.  However, the speed of execution is slower.
124  </P>  </P>
125  <P>  <P>
126  All values in repeating quantifiers must be less than 65536.  All values in repeating quantifiers must be less than 65536. The maximum
127  The maximum number of capturing subpatterns is 65535.  compiled length of subpattern with an explicit repeat count is 30000 bytes. The
128    maximum number of capturing subpatterns is 65535.
129  </P>  </P>
130  <P>  <P>
131  There is no limit to the number of non-capturing subpatterns, but the maximum  There is no limit to the number of parenthesized subpatterns, but there can be
132  depth of nesting of all kinds of parenthesized subpattern, including capturing  no more than 65535 capturing subpatterns.
133  subpatterns, assertions, and other types of subpattern, is 200.  </P>
134    <P>
135    The maximum length of name for a named subpattern is 32 characters, and the
136    maximum number of named subpatterns is 10000.
137  </P>  </P>
138  <P>  <P>
139  The maximum length of a subject string is the largest positive number that an  The maximum length of a subject string is the largest positive number that an
140  integer variable can hold. However, PCRE uses recursion to handle subpatterns  integer variable can hold. However, when using the traditional matching
141  and indefinite repetition. This means that the available stack space may limit  function, PCRE uses recursion to handle subpatterns and indefinite repetition.
142  the size of a subject string that can be processed by certain patterns.  This means that the available stack space may limit the size of a subject
143    string that can be processed by certain patterns. For a discussion of stack
144    issues, see the
145    <a href="pcrestack.html"><b>pcrestack</b></a>
146    documentation.
147  <a name="utf8support"></a></P>  <a name="utf8support"></a></P>
148  <br><a name="SEC4" href="#TOC1">UTF-8 AND UNICODE PROPERTY SUPPORT</a><br>  <br><a name="SEC4" href="#TOC1">UTF-8 AND UNICODE PROPERTY SUPPORT</a><br>
149  <P>  <P>
# Line 126  instead of just strings of bytes. Line 163  instead of just strings of bytes.
163  <P>  <P>
164  If you compile PCRE with UTF-8 support, but do not use it at run time, the  If you compile PCRE with UTF-8 support, but do not use it at run time, the
165  library will be a bit bigger, but the additional run time overhead is limited  library will be a bit bigger, but the additional run time overhead is limited
166  to testing the PCRE_UTF8 flag in several places, so should not be very large.  to testing the PCRE_UTF8 flag occasionally, so should not be very big.
167  </P>  </P>
168  <P>  <P>
169  If PCRE is built with Unicode character property support (which implies UTF-8  If PCRE is built with Unicode character property support (which implies UTF-8
170  support), the escape sequences \p{..}, \P{..}, and \X are supported.  support), the escape sequences \p{..}, \P{..}, and \X are supported.
171  The available properties that can be tested are limited to the general  The available properties that can be tested are limited to the general
172  category properties such as Lu for an upper case letter or Nd for a decimal  category properties such as Lu for an upper case letter or Nd for a decimal
173  number. A full list is given in the  number, the Unicode script names such as Arabic or Han, and the derived
174    properties Any and L&. A full list is given in the
175  <a href="pcrepattern.html"><b>pcrepattern</b></a>  <a href="pcrepattern.html"><b>pcrepattern</b></a>
176  documentation. The PCRE library is increased in size by about 90K when Unicode  documentation. Only the short names for properties are supported. For example,
177  property support is included.  \p{L} matches a letter. Its Perl synonym, \p{Letter}, is not supported.
178    Furthermore, in Perl, many properties may optionally be prefixed by "Is", for
179    compatibility with Perl 5.6. PCRE does not support this.
180  </P>  </P>
181  <P>  <P>
182  The following comments apply when PCRE is running in UTF-8 mode:  The following comments apply when PCRE is running in UTF-8 mode:
# Line 154  PCRE when PCRE_NO_UTF8_CHECK is set, the Line 194  PCRE when PCRE_NO_UTF8_CHECK is set, the
194  may crash.  may crash.
195  </P>  </P>
196  <P>  <P>
197  2. In a pattern, the escape sequence \x{...}, where the contents of the braces  2. An unbraced hexadecimal escape sequence (such as \xb3) matches a two-byte
198  is a string of hexadecimal digits, is interpreted as a UTF-8 character whose  UTF-8 character if the value is greater than 127.
 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.  
199  </P>  </P>
200  <P>  <P>
201  3. The original hexadecimal escape sequence, \xhh, matches a two-byte UTF-8  3. Octal numbers up to \777 are recognized, and match two-byte UTF-8
202  character if the value is greater than 127.  characters for values greater than \177.
203  </P>  </P>
204  <P>  <P>
205  4. Repeat quantifiers apply to complete UTF-8 characters, not to individual  4. Repeat quantifiers apply to complete UTF-8 characters, not to individual
# Line 174  bytes, for example: \x{100}{3}. Line 210  bytes, for example: \x{100}{3}.
210  </P>  </P>
211  <P>  <P>
212  6. The escape sequence \C can be used to match a single byte in UTF-8 mode,  6. The escape sequence \C can be used to match a single byte in UTF-8 mode,
213  but its use can lead to some strange effects.  but its use can lead to some strange effects. This facility is not available in
214    the alternative matching function, <b>pcre_dfa_exec()</b>.
215  </P>  </P>
216  <P>  <P>
217  7. The character escapes \b, \B, \d, \D, \s, \S, \w, and \W correctly  7. The character escapes \b, \B, \d, \D, \s, \S, \w, and \W correctly
# Line 195  than 128, unless PCRE is built with Unic Line 232  than 128, unless PCRE is built with Unic
232  property support is available, PCRE still uses its own character tables when  property support is available, PCRE still uses its own character tables when
233  checking the case of low-valued characters, so as not to degrade performance.  checking the case of low-valued characters, so as not to degrade performance.
234  The Unicode property information is used only for characters with higher  The Unicode property information is used only for characters with higher
235  values.  values. Even when Unicode property support is available, PCRE supports
236    case-insensitive matching only when there is a one-to-one mapping between a
237    letter's cases. There are a small number of many-to-one mappings in Unicode;
238    these are not supported by PCRE.
239  </P>  </P>
240  <br><a name="SEC5" href="#TOC1">AUTHOR</a><br>  <br><a name="SEC5" href="#TOC1">AUTHOR</a><br>
241  <P>  <P>
242  Philip Hazel &#60;ph10@cam.ac.uk&#62;  Philip Hazel
243    <br>
244    University Computing Service
245  <br>  <br>
246  University Computing Service,  Cambridge CB2 3QH, England.
247  <br>  <br>
248  Cambridge CB2 3QG, England.  </P>
249    <P>
250    Putting an actual email address here seems to have been a spam magnet, so I've
251    taken it away. If you want to email me, use my initial and surname, separated
252    by a dot, at the domain ucs.cam.ac.uk.
253    </P>
254    <br><a name="SEC6" href="#TOC1">REVISION</a><br>
255    <P>
256    Last updated: 06 March 2007
257  <br>  <br>
258  Phone: +44 1223 334714  Copyright &copy; 1997-2007 University of Cambridge.
 Last updated: 09 September 2004  
259  <br>  <br>
 Copyright &copy; 1997-2004 University of Cambridge.  
260  <p>  <p>
261  Return to the <a href="index.html">PCRE index page</a>.  Return to the <a href="index.html">PCRE index page</a>.
262  </p>  </p>

Legend:
Removed from v.75  
changed lines
  Added in v.99

  ViewVC Help
Powered by ViewVC 1.1.5