/[pcre]/code/trunk/README
ViewVC logotype

Diff of /code/trunk/README

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

revision 31 by nigel, Sat Feb 24 21:38:57 2007 UTC revision 254 by ph10, Mon Sep 17 11:05:37 2007 UTC
# Line 1  Line 1 
1  README file for PCRE (Perl-compatible regular expressions)  README file for PCRE (Perl-compatible regular expression library)
2  ----------------------------------------------------------  -----------------------------------------------------------------
3    
4  *******************************************************************************  The latest release of PCRE is always available from
 *           IMPORTANT FOR THOSE UPGRADING FROM VERSIONS BEFORE 2.00           *  
 *                                                                             *  
 * Please note that there has been a change in the API such that a larger      *  
 * ovector is required at matching time, to provide some additional workspace. *  
 * The new man page has details. This change was necessary in order to support *  
 * some of the new functionality in Perl 5.005.                                *  
 *                                                                             *  
 *           IMPORTANT FOR THOSE UPGRADING FROM VERSION 2.00                   *  
 *                                                                             *  
 * Another (I hope this is the last!) change has been made to the API for the  *  
 * pcre_compile() function. An additional argument has been added to make it   *  
 * possible to pass over a pointer to character tables built in the current    *  
 * locale by pcre_maketables(). To use the default tables, this new arguement  *  
 * should be passed as NULL.                                                   *  
 *******************************************************************************  
5    
6  The distribution should contain the following files:    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.tar.gz
7    
8    There is a mailing list for discussion about the development of PCRE at
9    
10    ChangeLog         log of changes to the code    pcre-dev@exim.org
11    LICENCE           conditions for the use of PCRE  
12    Makefile          for building PCRE  Please read the NEWS file if you are upgrading from a previous release.
13    README            this file  The contents of this README file are:
14    RunTest           a shell script for running tests  
15    Tech.Notes        notes on the encoding    The PCRE APIs
16    pcre.3            man page for the functions    Documentation for PCRE
17    pcreposix.3       man page for the POSIX wrapper API    Contributions by users of PCRE
18    dftables.c        auxiliary program for building chartables.c    Building PCRE on non-Unix systems
19    get.c             )    Building PCRE on Unix-like systems
20    maketables.c      )    Retrieving configuration information on Unix-like systems
21    study.c           ) source of    Shared libraries on Unix-like systems
22    pcre.c            )   the functions    Cross-compiling on Unix-like systems
23    pcreposix.c       )    Using HP's ANSI C++ compiler (aCC)
24    pcre.h            header for the external API    Making new tarballs
25    pcreposix.h       header for the external POSIX wrapper API    Testing PCRE
26    internal.h        header for internal use    Character tables
27    pcretest.c        test program    File manifest
28    pgrep.1           man page for pgrep  
29    pgrep.c           source of a grep utility that uses PCRE  
30    perltest          Perl test program  The PCRE APIs
31    testinput         test data, compatible with Perl 5.004 and 5.005  -------------
32    testinput2        test data for error messages and non-Perl things  
33    testinput3        test data, compatible with Perl 5.005  PCRE is written in C, and it has its own API. The distribution also includes a
34    testinput4        test data for locale-specific tests  set of C++ wrapper functions (see the pcrecpp man page for details), courtesy
35    testoutput        test results corresponding to testinput  of Google Inc.
36    testoutput2       test results corresponding to testinput2  
37    testoutput3       test results corresponding to testinput3  In addition, there is a set of C wrapper functions that are based on the POSIX
38    testoutput4       test results corresponding to testinput4  regular expression API (see the pcreposix man page). These end up in the
39    library called libpcreposix. Note that this just provides a POSIX calling
40  To build PCRE, edit Makefile for your system (it is a fairly simple make file,  interface to PCRE; the regular expressions themselves still follow Perl syntax
41  and there are some comments at the top) and then run it. It builds two  and semantics. The POSIX API is restricted, and does not give full access to
42  libraries called libpcre.a and libpcreposix.a, a test program called pcretest,  all of PCRE's facilities.
43  and the pgrep command.  
44    The header file for the POSIX-style functions is called pcreposix.h. The
45  To test PCRE, run the RunTest script in the pcre directory. This runs pcretest  official POSIX name is regex.h, but I did not want to risk possible problems
46  on each of the testinput files in turn, and compares the output with the  with existing files of that name by distributing it that way. To use PCRE with
47  contents of the corresponding testoutput file. A file called testtry is used to  an existing program that uses the POSIX API, pcreposix.h will have to be
48  hold the output from pcretest (which is documented below).  renamed or pointed at by a link.
49    
50  To run pcretest on just one of the test files, give its number as an argument  If you are using the POSIX interface to PCRE and there is already a POSIX regex
51  to RunTest, for example:  library installed on your system, as well as worrying about the regex.h header
52    file (as mentioned above), you must also take care when linking programs to
53    RunTest 3  ensure that they link with PCRE's libpcreposix library. Otherwise they may pick
54    up the POSIX functions of the same name from the other library.
55  The first and third test files can also be fed directly into the perltest  
56  program to check that Perl gives the same results. The third file requires the  One way of avoiding this confusion is to compile PCRE with the addition of
57  additional features of release 5.005, which is why it is kept separate from the  -Dregcomp=PCREregcomp (and similarly for the other POSIX functions) to the
58  main test input, which needs only Perl 5.004. In the long run, when 5.005 is  compiler flags (CFLAGS if you are using "configure" -- see below). This has the
59  widespread, these two test files may get amalgamated.  effect of renaming the functions so that the names no longer clash. Of course,
60    you have to do the same thing for your applications, or write them using the
61  The second set of tests check pcre_info(), pcre_study(), pcre_copy_substring(),  new names.
62  pcre_get_substring(), pcre_get_substring_list(), error detection and run-time  
63  flags that are specific to PCRE, as well as the POSIX wrapper API.  
64    Documentation for PCRE
65    ----------------------
66    
67    If you install PCRE in the normal way on a Unix-like system, you will end up
68    with a set of man pages whose names all start with "pcre". The one that is just
69    called "pcre" lists all the others. In addition to these man pages, the PCRE
70    documentation is supplied in two other forms:
71    
72      1. There are files called doc/pcre.txt, doc/pcregrep.txt, and
73         doc/pcretest.txt in the source distribution. The first of these is a
74         concatenation of the text forms of all the section 3 man pages except
75         those that summarize individual functions. The other two are the text
76         forms of the section 1 man pages for the pcregrep and pcretest commands.
77         These text forms are provided for ease of scanning with text editors or
78         similar tools. They are installed in <prefix>/share/doc/pcre, where
79         <prefix> is the installation prefix (defaulting to /usr/local).
80    
81      2. A set of files containing all the documentation in HTML form, hyperlinked
82         in various ways, and rooted in a file called index.html, is distributed in
83         doc/html and installed in <prefix>/share/doc/pcre/html.
84    
85    
86    Contributions by users of PCRE
87    ------------------------------
88    
89    You can find contributions from PCRE users in the directory
90    
91      ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib
92    
93    There is a README file giving brief descriptions of what they are. Some are
94    complete in themselves; others are pointers to URLs containing relevant files.
95    Some of this material is likely to be well out-of-date. Several of the earlier
96    contributions provided support for compiling PCRE on various flavours of
97    Windows (I myself do not use Windows). Nowadays there is more Windows support
98    in the standard distribution, so these contibutions have been archived.
99    
100    
101    Building PCRE on non-Unix systems
102    ---------------------------------
103    
104    For a non-Unix system, please read the comments in the file NON-UNIX-USE,
105    though if your system supports the use of "configure" and "make" you may be
106    able to build PCRE in the same way as for Unix-like systems.
107    
108    PCRE has been compiled on many different operating systems. It should be
109    straightforward to build PCRE on any system that has a Standard C compiler and
110    library, because it uses only Standard C functions.
111    
112    
113    Building PCRE on Unix-like systems
114    ----------------------------------
115    
116    If you are using HP's ANSI C++ compiler (aCC), please see the special note
117    in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.
118    
119    The following instructions assume the use of the widely used "configure, make,
120    make install" process. There is also some experimental support for "cmake" in
121    the PCRE distribution, but it is incomplete and not documented. However, if you
122    are a "cmake" user, you might want to try it.
123    
124    To build PCRE on a Unix-like system, first run the "configure" command from the
125    PCRE distribution directory, with your current directory set to the directory
126    where you want the files to be created. This command is a standard GNU
127    "autoconf" configuration script, for which generic instructions are supplied in
128    the file INSTALL.
129    
130    Most commonly, people build PCRE within its own distribution directory, and in
131    this case, on many systems, just running "./configure" is sufficient. However,
132    the usual methods of changing standard defaults are available. For example:
133    
134    CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local
135    
136    specifies that the C compiler should be run with the flags '-O2 -Wall' instead
137    of the default, and that "make install" should install PCRE under /opt/local
138    instead of the default /usr/local.
139    
140    If you want to build in a different directory, just run "configure" with that
141    directory as current. For example, suppose you have unpacked the PCRE source
142    into /source/pcre/pcre-xxx, but you want to build it in /build/pcre/pcre-xxx:
143    
144    cd /build/pcre/pcre-xxx
145    /source/pcre/pcre-xxx/configure
146    
147    PCRE is written in C and is normally compiled as a C library. However, it is
148    possible to build it as a C++ library, though the provided building apparatus
149    does not have any features to support this.
150    
151    There are some optional features that can be included or omitted from the PCRE
152    library. You can read more about them in the pcrebuild man page.
153    
154    . If you want to suppress the building of the C++ wrapper library, you can add
155      --disable-cpp to the "configure" command. Otherwise, when "configure" is run,
156      it will try to find a C++ compiler and C++ header files, and if it succeeds,
157      it will try to build the C++ wrapper.
158    
159    . If you want to make use of the support for UTF-8 character strings in PCRE,
160      you must add --enable-utf8 to the "configure" command. Without it, the code
161      for handling UTF-8 is not included in the library. (Even when included, it
162      still has to be enabled by an option at run time.)
163    
164    . If, in addition to support for UTF-8 character strings, you want to include
165      support for the \P, \p, and \X sequences that recognize Unicode character
166      properties, you must add --enable-unicode-properties to the "configure"
167      command. This adds about 30K to the size of the library (in the form of a
168      property table); only the basic two-letter properties such as Lu are
169      supported.
170    
171    . You can build PCRE to recognize either CR or LF or the sequence CRLF or any
172      of the preceding, or any of the Unicode newline sequences as indicating the
173      end of a line. Whatever you specify at build time is the default; the caller
174      of PCRE can change the selection at run time. The default newline indicator
175      is a single LF character (the Unix standard). You can specify the default
176      newline indicator by adding --enable-newline-is-cr or --enable-newline-is-lf
177      or --enable-newline-is-crlf or --enable-newline-is-anycrlf or
178      --enable-newline-is-any to the "configure" command, respectively.
179    
180      If you specify --enable-newline-is-cr or --enable-newline-is-crlf, some of
181      the standard tests will fail, because the lines in the test files end with
182      LF. Even if the files are edited to change the line endings, there are likely
183      to be some failures. With --enable-newline-is-anycrlf or
184      --enable-newline-is-any, many tests should succeed, but there may be some
185      failures.
186    
187    . By default, the sequence \R in a pattern matches any Unicode line ending
188      sequence. This is independent of the option specifying what PCRE considers to
189      be the end of a line (see above). However, the caller of PCRE can restrict \R
190      to match only CR, LF, or CRLF. You can make this the default by adding
191      --enable-bsr-anycrlf to the "configure" command (bsr = "backslash R").
192    
193    . When called via the POSIX interface, PCRE uses malloc() to get additional
194      storage for processing capturing parentheses if there are more than 10 of
195      them in a pattern. You can increase this threshold by setting, for example,
196    
197      --with-posix-malloc-threshold=20
198    
199      on the "configure" command.
200    
201    . PCRE has a counter that can be set to limit the amount of resources it uses.
202      If the limit is exceeded during a match, the match fails. The default is ten
203      million. You can change the default by setting, for example,
204    
205      --with-match-limit=500000
206    
207      on the "configure" command. This is just the default; individual calls to
208      pcre_exec() can supply their own value. There is more discussion on the
209      pcreapi man page.
210    
211    . There is a separate counter that limits the depth of recursive function calls
212      during a matching process. This also has a default of ten million, which is
213      essentially "unlimited". You can change the default by setting, for example,
214    
215      --with-match-limit-recursion=500000
216    
217      Recursive function calls use up the runtime stack; running out of stack can
218      cause programs to crash in strange ways. There is a discussion about stack
219      sizes in the pcrestack man page.
220    
221    . The default maximum compiled pattern size is around 64K. You can increase
222      this by adding --with-link-size=3 to the "configure" command. You can
223      increase it even more by setting --with-link-size=4, but this is unlikely
224      ever to be necessary. Increasing the internal link size will reduce
225      performance.
226    
227    . You can build PCRE so that its internal match() function that is called from
228      pcre_exec() does not call itself recursively. Instead, it uses memory blocks
229      obtained from the heap via the special functions pcre_stack_malloc() and
230      pcre_stack_free() to save data that would otherwise be saved on the stack. To
231      build PCRE like this, use
232    
233      --disable-stack-for-recursion
234    
235      on the "configure" command. PCRE runs more slowly in this mode, but it may be
236      necessary in environments with limited stack sizes. This applies only to the
237      pcre_exec() function; it does not apply to pcre_dfa_exec(), which does not
238      use deeply nested recursion. There is a discussion about stack sizes in the
239      pcrestack man page.
240    
241    . For speed, PCRE uses four tables for manipulating and identifying characters
242      whose code point values are less than 256. By default, it uses a set of
243      tables for ASCII encoding that is part of the distribution. If you specify
244    
245      --enable-rebuild-chartables
246    
247      a program called dftables is compiled and run in the default C locale when
248      you obey "make". It builds a source file called pcre_chartables.c. If you do
249      not specify this option, pcre_chartables.c is created as a copy of
250      pcre_chartables.c.dist. See "Character tables" below for further information.
251    
252    . It is possible to compile PCRE for use on systems that use EBCDIC as their
253      default character code (as opposed to ASCII) by specifying
254    
255      --enable-ebcdic
256    
257      This automatically implies --enable-rebuild-chartables (see above).
258    
259    The "configure" script builds the following files for the basic C library:
260    
261    . Makefile is the makefile that builds the library
262    . config.h contains build-time configuration options for the library
263    . pcre.h is the public PCRE header file
264    . pcre-config is a script that shows the settings of "configure" options
265    . libpcre.pc is data for the pkg-config command
266    . libtool is a script that builds shared and/or static libraries
267    . RunTest is a script for running tests on the basic C library
268    . RunGrepTest is a script for running tests on the pcregrep command
269    
270    Versions of config.h and pcre.h are distributed in the PCRE tarballs under
271    the names config.h.generic and pcre.h.generic. These are provided for the
272    benefit of those who have to built PCRE without the benefit of "configure". If
273    you use "configure", the .generic versions are not used.
274    
275    If a C++ compiler is found, the following files are also built:
276    
277    . libpcrecpp.pc is data for the pkg-config command
278    . pcrecpparg.h is a header file for programs that call PCRE via the C++ wrapper
279    . pcre_stringpiece.h is the header for the C++ "stringpiece" functions
280    
281    The "configure" script also creates config.status, which is an executable
282    script that can be run to recreate the configuration, and config.log, which
283    contains compiler output from tests that "configure" runs.
284    
285    Once "configure" has run, you can run "make". It builds two libraries, called
286    libpcre and libpcreposix, a test program called pcretest, a demonstration
287    program called pcredemo, and the pcregrep command. If a C++ compiler was found
288    on your system, "make" also builds the C++ wrapper library, which is called
289    libpcrecpp, and some test programs called pcrecpp_unittest,
290    pcre_scanner_unittest, and pcre_stringpiece_unittest. Building the C++ wrapper
291    can be disabled by adding --disable-cpp to the "configure" command.
292    
293    The command "make check" runs all the appropriate tests. Details of the PCRE
294    tests are given below in a separate section of this document.
295    
296    You can use "make install" to install PCRE into live directories on your
297    system. The following are installed (file names are all relative to the
298    <prefix> that is set when "configure" is run):
299    
300      Commands (bin):
301        pcretest
302        pcregrep
303        pcre-config
304    
305      Libraries (lib):
306        libpcre
307        libpcreposix
308        libpcrecpp (if C++ support is enabled)
309    
310      Configuration information (lib/pkgconfig):
311        libpcre.pc
312        libpcrecpp.pc (if C++ support is enabled)
313    
314      Header files (include):
315        pcre.h
316        pcreposix.h
317        pcre_scanner.h      )
318        pcre_stringpiece.h  ) if C++ support is enabled
319        pcrecpp.h           )
320        pcrecpparg.h        )
321    
322      Man pages (share/man/man{1,3}):
323        pcregrep.1
324        pcretest.1
325        pcre.3
326        pcre*.3 (lots more pages, all starting "pcre")
327    
328      HTML documentation (share/doc/pcre/html):
329        index.html
330        *.html (lots more pages, hyperlinked from index.html)
331    
332      Text file documentation (share/doc/pcre):
333        AUTHORS
334        COPYING
335        ChangeLog
336        LICENCE
337        NEWS
338        README
339        pcre.txt       (a concatenation of the man(3) pages)
340        pcretest.txt   the pcretest man page
341        pcregrep.txt   the pcregrep man page
342    
343    Note that the pcredemo program that is built by "configure" is *not* installed
344    anywhere. It is a demonstration for programmers wanting to use PCRE.
345    
346    If you want to remove PCRE from your system, you can run "make uninstall".
347    This removes all the files that "make install" installed. However, it does not
348    remove any directories, because these are often shared with other programs.
349    
350    
351    Retrieving configuration information on Unix-like systems
352    ---------------------------------------------------------
353    
354    Running "make install" installs the command pcre-config, which can be used to
355    recall information about the PCRE configuration and installation. For example:
356    
357      pcre-config --version
358    
359    prints the version number, and
360    
361      pcre-config --libs
362    
363    outputs information about where the library is installed. This command can be
364    included in makefiles for programs that use PCRE, saving the programmer from
365    having to remember too many details.
366    
367    The pkg-config command is another system for saving and retrieving information
368    about installed libraries. Instead of separate commands for each library, a
369    single command is used. For example:
370    
371      pkg-config --cflags pcre
372    
373    The data is held in *.pc files that are installed in a directory called
374    <prefix>/lib/pkgconfig.
375    
376    
377    Shared libraries on Unix-like systems
378    -------------------------------------
379    
380    The default distribution builds PCRE as shared libraries and static libraries,
381    as long as the operating system supports shared libraries. Shared library
382    support relies on the "libtool" script which is built as part of the
383    "configure" process.
384    
385    The libtool script is used to compile and link both shared and static
386    libraries. They are placed in a subdirectory called .libs when they are newly
387    built. The programs pcretest and pcregrep are built to use these uninstalled
388    libraries (by means of wrapper scripts in the case of shared libraries). When
389    you use "make install" to install shared libraries, pcregrep and pcretest are
390    automatically re-built to use the newly installed shared libraries before being
391    installed themselves. However, the versions left in the build directory still
392    use the uninstalled libraries.
393    
394    To build PCRE using static libraries only you must use --disable-shared when
395    configuring it. For example:
396    
397    ./configure --prefix=/usr/gnu --disable-shared
398    
399    Then run "make" in the usual way. Similarly, you can use --disable-static to
400    build only shared libraries.
401    
402    
403    Cross-compiling on Unix-like systems
404    ------------------------------------
405    
406    You can specify CC and CFLAGS in the normal way to the "configure" command, in
407    order to cross-compile PCRE for some other host. However, you should NOT
408    specify --enable-rebuild-chartables, because if you do, the dftables.c source
409    file is compiled and run on the local host, in order to generate the inbuilt
410    character tables (the pcre_chartables.c file). This will probably not work,
411    because dftables.c needs to be compiled with the local compiler, not the cross
412    compiler.
413    
414    When --enable-rebuild-chartables is not specified, pcre_chartables.c is created
415    by making a copy of pcre_chartables.c.dist, which is a default set of tables
416    that assumes ASCII code. Cross-compiling with the default tables should not be
417    a problem.
418    
419    If you need to modify the character tables when cross-compiling, you should
420    move pcre_chartables.c.dist out of the way, then compile dftables.c by hand and
421    run it on the local host to make a new version of pcre_chartables.c.dist.
422    Then when you cross-compile PCRE this new version of the tables will be used.
423    
424    
425    Using HP's ANSI C++ compiler (aCC)
426    ----------------------------------
427    
428    Unless C++ support is disabled by specifying the "--disable-cpp" option of the
429    "configure" script, you must include the "-AA" option in the CXXFLAGS
430    environment variable in order for the C++ components to compile correctly.
431    
432    Also, note that the aCC compiler on PA-RISC platforms may have a defect whereby
433    needed libraries fail to get included when specifying the "-AA" compiler
434    option. If you experience unresolved symbols when linking the C++ programs,
435    use the workaround of specifying the following environment variable prior to
436    running the "configure" script:
437    
438      CXXLDFLAGS="-lstd_v2 -lCsup_v2"
439    
440    
441    Making new tarballs
442    -------------------
443    
444    The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and
445    zip formats. The command "make distcheck" does the same, but then does a trial
446    build of the new distribution to ensure that it works.
447    
448    If you have modified any of the man page sources in the doc directory, you
449    should first run the PrepareRelease script before making a distribution. This
450    script creates the .txt and HTML forms of the documentation from the man pages.
451    
452    
453    Testing PCRE
454    ------------
455    
456    To test the basic PCRE library on a Unix system, run the RunTest script that is
457    created by the configuring process. There is also a script called RunGrepTest
458    that tests the options of the pcregrep command. If the C++ wrapper library is
459    built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and
460    pcre_stringpiece_unittest are also built.
461    
462    Both the scripts and all the program tests are run if you obey "make check" or
463    "make test". For other systems, see the instructions in NON-UNIX-USE.
464    
465    The RunTest script runs the pcretest test program (which is documented in its
466    own man page) on each of the testinput files in the testdata directory in
467    turn, and compares the output with the contents of the corresponding testoutput
468    files. A file called testtry is used to hold the main output from pcretest
469    (testsavedregex is also used as a working file). To run pcretest on just one of
470    the test files, give its number as an argument to RunTest, for example:
471    
472      RunTest 2
473    
474    The first test file can also be fed directly into the perltest.pl script to
475    check that Perl gives the same results. The only difference you should see is
476    in the first few lines, where the Perl version is given instead of the PCRE
477    version.
478    
479    The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),
480    pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
481    detection, and run-time flags that are specific to PCRE, as well as the POSIX
482    wrapper API. It also uses the debugging flags to check some of the internals of
483    pcre_compile().
484    
485    If you build PCRE with a locale setting that is not the standard C locale, the
486    character tables may be different (see next paragraph). In some cases, this may
487    cause failures in the second set of tests. For example, in a locale where the
488    isprint() function yields TRUE for characters in the range 128-255, the use of
489    [:isascii:] inside a character class defines a different set of characters, and
490    this shows up in this test as a difference in the compiled code, which is being
491    listed for checking. Where the comparison test output contains [\x00-\x7f] the
492    test will contain [\x00-\xff], and similarly in some other cases. This is not a
493    bug in PCRE.
494    
495  The fourth set of tests checks pcre_maketables(), the facility for building a  The third set of tests checks pcre_maketables(), the facility for building a
496  set of character tables for a specific locale and using them instead of the  set of character tables for a specific locale and using them instead of the
497  default tables. The tests make use of the "fr" (French) locale. Before running  default tables. The tests make use of the "fr_FR" (French) locale. Before
498  the test, the script checks for the presence of this locale by running the  running the test, the script checks for the presence of this locale by running
499  "locale" command. If that command fails, or if it doesn't include "fr" in the  the "locale" command. If that command fails, or if it doesn't include "fr_FR"
500  list of available locales, the fourth test cannot be run, and a comment is  in the list of available locales, the third test cannot be run, and a comment
501  output to say why. If running this test produces instances of the error  is output to say why. If running this test produces instances of the error
502    
503    ** Failed to set locale "fr"    ** Failed to set locale "fr_FR"
504    
505  in the comparison output, it means that locale is not available on your system,  in the comparison output, it means that locale is not available on your system,
506  despite being listed by "locale". This does not mean that PCRE is broken.  despite being listed by "locale". This does not mean that PCRE is broken.
507    
508  To install PCRE, copy libpcre.a to any suitable library directory (e.g.  [If you are trying to run this test on Windows, you may be able to get it to
509  /usr/local/lib), pcre.h to any suitable include directory (e.g.  work by changing "fr_FR" to "french" everywhere it occurs.]
510  /usr/local/include), and pcre.3 to any suitable man directory (e.g.  
511  /usr/local/man/man3).  The fourth test checks the UTF-8 support. It is not run automatically unless
512    PCRE is built with UTF-8 support. To do this you must set --enable-utf8 when
513  To install the pgrep command, copy it to any suitable binary directory, (e.g.  running "configure". This file can be also fed directly to the perltest script,
514  /usr/local/bin) and pgrep.1 to any suitable man directory (e.g.  provided you are running Perl 5.8 or higher. (For Perl 5.6, a small patch,
515  /usr/local/man/man1).  commented in the script, can be be used.)
516    
517  PCRE has its own native API, but a set of "wrapper" functions that are based on  The fifth test checks error handling with UTF-8 encoding, and internal UTF-8
518  the POSIX API are also supplied in the library libpcreposix.a. Note that this  features of PCRE that are not relevant to Perl.
519  just provides a POSIX calling interface to PCRE: the regular expressions  
520  themselves still follow Perl syntax and semantics. The header file  The sixth test checks the support for Unicode character properties. It it not
521  for the POSIX-style functions is called pcreposix.h. The official POSIX name is  run automatically unless PCRE is built with Unicode property support. To to
522  regex.h, but I didn't want to risk possible problems with existing files of  this you must set --enable-unicode-properties when running "configure".
523  that name by distributing it that way. To use it with an existing program that  
524  uses the POSIX API, it will have to be renamed or pointed at by a link.  The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative
525    matching function, in non-UTF-8 mode, UTF-8 mode, and UTF-8 mode with Unicode
526    property support, respectively. The eighth and ninth tests are not run
527    automatically unless PCRE is build with the relevant support.
528    
529    
530  Character tables  Character tables
531  ----------------  ----------------
532    
533  PCRE uses four tables for manipulating and identifying characters. The final  For speed, PCRE uses four tables for manipulating and identifying characters
534  argument of the pcre_compile() function is a pointer to a block of memory  whose code point values are less than 256. The final argument of the
535  containing the concatenated tables. A call to pcre_maketables() is used to  pcre_compile() function is a pointer to a block of memory containing the
536  generate a set of tables in the current locale. However, if the final argument  concatenated tables. A call to pcre_maketables() can be used to generate a set
537  is passed as NULL, a set of default tables that is built into the binary is  of tables in the current locale. If the final argument for pcre_compile() is
538  used.  passed as NULL, a set of default tables that is built into the binary is used.
539    
540  The source file called chartables.c contains the default set of tables. This is  The source file called pcre_chartables.c contains the default set of tables. By
541  not supplied in the distribution, but is built by the program dftables  default, this is created as a copy of pcre_chartables.c.dist, which contains
542  (compiled from dftables.c), which uses the ANSI C character handling functions  tables for ASCII coding. However, if --enable-rebuild-chartables is specified
543  such as isalnum(), isalpha(), isupper(), islower(), etc. to build the table  for ./configure, a different version of pcre_chartables.c is built by the
544  sources. This means that the default C locale set your system will control the  program dftables (compiled from dftables.c), which uses the ANSI C character
545  contents of the tables. You can change the default tables by editing  handling functions such as isalnum(), isalpha(), isupper(), islower(), etc. to
546  chartables.c and then re-building PCRE. If you do this, you should probably  build the table sources. This means that the default C locale which is set for
547  also edit Makefile to ensure that the file doesn't ever get re-generated.  your system will control the contents of these default tables. You can change
548    the default tables by editing pcre_chartables.c and then re-building PCRE. If
549    you do this, you should take care to ensure that the file does not get
550    automatically re-generated. The best way to do this is to move
551    pcre_chartables.c.dist out of the way and replace it with your customized
552    tables.
553    
554    When the dftables program is run as a result of --enable-rebuild-chartables,
555    it uses the default C locale that is set on your system. It does not pay
556    attention to the LC_xxx environment variables. In other words, it uses the
557    system's default locale rather than whatever the compiling user happens to have
558    set. If you really do want to build a source set of character tables in a
559    locale that is specified by the LC_xxx variables, you can run the dftables
560    program by hand with the -L option. For example:
561    
562      ./dftables -L pcre_chartables.c.special
563    
564  The first two 256-byte tables provide lower casing and case flipping functions,  The first two 256-byte tables provide lower casing and case flipping functions,
565  respectively. The next table consists of three 32-byte bit maps which identify  respectively. The next table consists of three 32-byte bit maps which identify
566  digits, "word" characters, and white space, respectively. These are used when  digits, "word" characters, and white space, respectively. These are used when
567  building 32-byte bit maps that represent character classes.  building 32-byte bit maps that represent character classes for code points less
568    than 256.
569    
570  The final 256-byte table has bits indicating various character types, as  The final 256-byte table has bits indicating various character types, as
571  follows:  follows:
# Line 145  You should not alter the set of characte Line 581  You should not alter the set of characte
581  will cause PCRE to malfunction.  will cause PCRE to malfunction.
582    
583    
584  The pcretest program  File manifest
585  --------------------  -------------
586    
587    The distribution should contain the following files:
588    
589  This program is intended for testing PCRE, but it can also be used for  (A) Source files of the PCRE library functions and their headers:
 experimenting with regular expressions.  
590    
591  If it is given two filename arguments, it reads from the first and writes to    dftables.c              auxiliary program for building pcre_chartables.c
592  the second. If it is given only one filename argument, it reads from that file                              when --enable-rebuild-chartables is specified
 and writes to stdout. Otherwise, it reads from stdin and writes to stdout, and  
 prompts for each line of input.  
   
 The program handles any number of sets of input on a single input file. Each  
 set starts with a regular expression, and continues with any number of data  
 lines to be matched against the pattern. An empty line signals the end of the  
 set. The regular expressions are given enclosed in any non-alphameric  
 delimiters other than backslash, for example  
   
   /(a|bc)x+yz/  
   
 White space before the initial delimiter is ignored. A regular expression may  
 be continued over several input lines, in which case the newline characters are  
 included within it. See the testinput files for many examples. It is possible  
 to include the delimiter within the pattern by escaping it, for example  
   
   /abc\/def/  
   
 If you do so, the escape and the delimiter form part of the pattern, but since  
 delimiters are always non-alphameric, this does not affect its interpretation.  
 If the terminating delimiter is immediately followed by a backslash, for  
 example,  
   
   /abc/\  
   
 then a backslash is added to the end of the pattern. This provides a way of  
 testing the error condition that arises if a pattern finishes with a backslash,  
 because  
   
   /abc\/  
   
 is interpreted as the first line of a pattern that starts with "abc/", causing  
 pcretest to read the next line as a continuation of the regular expression.  
   
 The pattern may be followed by i, m, s, or x to set the PCRE_CASELESS,  
 PCRE_MULTILINE, PCRE_DOTALL, or PCRE_EXTENDED options, respectively. These  
 options have the same effect as they do in Perl.  
   
 There are also some upper case options that do not match Perl options: /A, /E,  
 and /X set PCRE_ANCHORED, PCRE_DOLLAR_ENDONLY, and PCRE_EXTRA respectively.  
   
 The /L option must be followed directly by the name of a locale, for example,  
   
   /pattern/Lfr  
   
 For this reason, it must be the last option letter. The given locale is set,  
 pcre_maketables() is called to build a set of character tables for the locale,  
 and this is then passed to pcre_compile() when compiling the regular  
 expression. Without an /L option, NULL is passed as the tables pointer; that  
 is, /L applies only to the expression on which it appears.  
   
 The /I option requests that pcretest output information about the compiled  
 expression (whether it is anchored, has a fixed first character, and so on). It  
 does this by calling pcre_info() after compiling an expression, and outputting  
 the information it gets back. If the pattern is studied, the results of that  
 are also output.  
   
 The /D option is a PCRE debugging feature, which also assumes /I. It causes the  
 internal form of compiled regular expressions to be output after compilation.  
   
 The /S option causes pcre_study() to be called after the expression has been  
 compiled, and the results used when the expression is matched.  
   
 The /M option causes information about the size of memory block used to hold  
 the compile pattern to be output.  
   
 Finally, the /P option causes pcretest to call PCRE via the POSIX wrapper API  
 rather than its native API. When this is done, all other options except /i and  
 /m are ignored. REG_ICASE is set if /i is present, and REG_NEWLINE is set if /m  
 is present. The wrapper functions force PCRE_DOLLAR_ENDONLY always, and  
 PCRE_DOTALL unless REG_NEWLINE is set.  
   
 Before each data line is passed to pcre_exec(), leading and trailing whitespace  
 is removed, and it is then scanned for \ escapes. The following are recognized:  
   
   \a     alarm (= BEL)  
   \b     backspace  
   \e     escape  
   \f     formfeed  
   \n     newline  
   \r     carriage return  
   \t     tab  
   \v     vertical tab  
   \nnn   octal character (up to 3 octal digits)  
   \xhh   hexadecimal character (up to 2 hex digits)  
   
   \A     pass the PCRE_ANCHORED option to pcre_exec()  
   \B     pass the PCRE_NOTBOL option to pcre_exec()  
   \Cdd   call pcre_copy_substring() for substring dd after a successful match  
            (any decimal number less than 32)  
   \Gdd   call pcre_get_substring() for substring dd after a successful match  
            (any decimal number less than 32)  
   \L     call pcre_get_substringlist() after a successful match  
   \Odd   set the size of the output vector passed to pcre_exec() to dd  
            (any number of decimal digits)  
   \Z     pass the PCRE_NOTEOL option to pcre_exec()  
   
 A backslash followed by anything else just escapes the anything else. If the  
 very last character is a backslash, it is ignored. This gives a way of passing  
 an empty line as data, since a real empty line terminates the data input.  
   
 If /P was present on the regex, causing the POSIX wrapper API to be used, only  
 \B, and \Z have any effect, causing REG_NOTBOL and REG_NOTEOL to be passed to  
 regexec() respectively.  
   
 When a match succeeds, pcretest outputs the list of captured substrings that  
 pcre_exec() returns, starting with number 0 for the string that matched the  
 whole pattern. Here is an example of an interactive pcretest run.  
   
   $ pcretest  
   Testing Perl-Compatible Regular Expressions  
   PCRE version 0.90 08-Sep-1997  
   
     re> /^abc(\d+)/  
   data> abc123  
     0: abc123  
     1: 123  
   data> xyz  
   No match  
   
 If any of \C, \G, or \L are present in a data line that is successfully  
 matched, the substrings extracted by the convenience functions are output with  
 C, G, or L after the string number instead of a colon. This is in addition to  
 the normal full list. The string length (that is, the return from the  
 extraction function) is given in parentheses after each string for \C and \G.  
   
 Note that while patterns can be continued over several lines (a plain ">"  
 prompt is used for continuations), data lines may not. However newlines can be  
 included in data by means of the \n escape.  
   
 If the -p option is given to pcretest, it is equivalent to adding /P to each  
 regular expression: the POSIX wrapper API is used to call PCRE. None of the  
 following flags has any effect in this case.  
   
 If the option -d is given to pcretest, it is equivalent to adding /D to each  
 regular expression: the internal form is output after compilation.  
   
 If the option -i is given to pcretest, it is equivalent to adding /I to each  
 regular expression: information about the compiled pattern is given after  
 compilation.  
   
 If the option -m is given to pcretest, it outputs the size of each compiled  
 pattern after it has been compiled. It is equivalent to adding /M to each  
 regular expression. For compatibility with earlier versions of pcretest, -s is  
 a synonym for -m.  
   
 If the -t option is given, each compile, study, and match is run 20000 times  
 while being timed, and the resulting time per compile or match is output in  
 milliseconds. Do not set -t with -s, because you will then get the size output  
 20000 times and the timing will be distorted. If you want to change the number  
 of repetitions used for timing, edit the definition of LOOPREPEAT at the top of  
 pcretest.c  
   
   
   
 The perltest program  
 --------------------  
   
 The perltest program tests Perl's regular expressions; it has the same  
 specification as pcretest, and so can be given identical input, except that  
 input patterns can be followed only by Perl's lower case options. The contents  
 of testinput and testinput3 meet this condition.  
   
 The data lines are processed as Perl strings, so if they contain $ or @  
 characters, these have to be escaped. For this reason, all such characters in  
 the testinput file are escaped so that it can be used for perltest as well as  
 for pcretest, and the special upper case options such as /A that pcretest  
 recognizes are not used in this file. The output should be identical, apart  
 from the initial identifying banner.  
   
 The testinput2 and testinput4 files are not suitable for feeding to Perltest,  
 since they do make use of the special upper case options and escapes that  
 pcretest uses to test some features of PCRE. The first of these files also  
 contains malformed regular expressions, in order to check that PCRE diagnoses  
 them correctly.  
593    
594  Philip Hazel <ph10@cam.ac.uk>    pcre_chartables.c.dist  a default set of character tables that assume ASCII
595  February 1999                              coding; used, unless --enable-rebuild-chartables is
596                                specified, by copying to pcre_chartables.c
597    
598      pcreposix.c             )
599      pcre_compile.c          )
600      pcre_config.c           )
601      pcre_dfa_exec.c         )
602      pcre_exec.c             )
603      pcre_fullinfo.c         )
604      pcre_get.c              ) sources for the functions in the library,
605      pcre_globals.c          )   and some internal functions that they use
606      pcre_info.c             )
607      pcre_maketables.c       )
608      pcre_newline.c          )
609      pcre_ord2utf8.c         )
610      pcre_refcount.c         )
611      pcre_study.c            )
612      pcre_tables.c           )
613      pcre_try_flipped.c      )
614      pcre_ucp_searchfuncs.c  )
615      pcre_valid_utf8.c       )
616      pcre_version.c          )
617      pcre_xclass.c           )
618      pcre_printint.src       ) debugging function that is #included in pcretest,
619                              )   and can also be #included in pcre_compile()
620      pcre.h.in               template for pcre.h when built by "configure"
621      pcreposix.h             header for the external POSIX wrapper API
622      pcre_internal.h         header for internal use
623      ucp.h                   ) headers concerned with
624      ucpinternal.h           )   Unicode property handling
625      ucptable.h              ) (this one is the data table)
626    
627      config.h.in             template for config.h, which is built by "configure"
628    
629      pcrecpp.h               public header file for the C++ wrapper
630      pcrecpparg.h.in         template for another C++ header file
631      pcre_scanner.h          public header file for C++ scanner functions
632      pcrecpp.cc              )
633      pcre_scanner.cc         ) source for the C++ wrapper library
634    
635      pcre_stringpiece.h.in   template for pcre_stringpiece.h, the header for the
636                                C++ stringpiece functions
637      pcre_stringpiece.cc     source for the C++ stringpiece functions
638    
639    (B) Source files for programs that use PCRE:
640    
641      pcredemo.c              simple demonstration of coding calls to PCRE
642      pcregrep.c              source of a grep utility that uses PCRE
643      pcretest.c              comprehensive test program
644    
645    (C) Auxiliary files:
646    
647      132html                 script to turn "man" pages into HTML
648      AUTHORS                 information about the author of PCRE
649      ChangeLog               log of changes to the code
650      CleanTxt                script to clean nroff output for txt man pages
651      Detrail                 script to remove trailing spaces
652      HACKING                 some notes about the internals of PCRE
653      INSTALL                 generic installation instructions
654      LICENCE                 conditions for the use of PCRE
655      COPYING                 the same, using GNU's standard name
656      Makefile.in             ) template for Unix Makefile, which is built by
657                              )   "configure"
658      Makefile.am             ) the automake input that was used to create
659                              )   Makefile.in
660      NEWS                    important changes in this release
661      NON-UNIX-USE            notes on building PCRE on non-Unix systems
662      PrepareRelease          script to make preparations for "make dist"
663      README                  this file
664      RunTest                 a Unix shell script for running tests
665      RunGrepTest             a Unix shell script for pcregrep tests
666      aclocal.m4              m4 macros (generated by "aclocal")
667      config.guess            ) files used by libtool,
668      config.sub              )   used only when building a shared library
669      configure               a configuring shell script (built by autoconf)
670      configure.ac            ) the autoconf input that was used to build
671                              )   "configure" and config.h
672      depcomp                 ) script to find program dependencies, generated by
673                              )   automake
674      doc/*.3                 man page sources for the PCRE functions
675      doc/*.1                 man page sources for pcregrep and pcretest
676      doc/index.html.src      the base HTML page
677      doc/html/*              HTML documentation
678      doc/pcre.txt            plain text version of the man pages
679      doc/pcretest.txt        plain text documentation of test program
680      doc/perltest.txt        plain text documentation of Perl test program
681      install-sh              a shell script for installing files
682      libpcre.pc.in           template for libpcre.pc for pkg-config
683      libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config
684      ltmain.sh               file used to build a libtool script
685      missing                 ) common stub for a few missing GNU programs while
686                              )   installing, generated by automake
687      mkinstalldirs           script for making install directories
688      perltest.pl             Perl test program
689      pcre-config.in          source of script which retains PCRE information
690      pcrecpp_unittest.cc          )
691      pcre_scanner_unittest.cc     ) test programs for the C++ wrapper
692      pcre_stringpiece_unittest.cc )
693      testdata/testinput*     test data for main library tests
694      testdata/testoutput*    expected test results
695      testdata/grep*          input and output for pcregrep tests
696    
697    (D) Auxiliary files for cmake support
698    
699      CMakeLists.txt
700      config-cmake.h.in
701    
702    (E) Auxiliary files for VPASCAL
703    
704      makevp.bat
705      makevp_c.txt
706      makevp_l.txt
707      pcregexp.pas
708    
709    (F) Auxiliary files for building PCRE "by hand"
710    
711      pcre.h.generic          ) a version of the public PCRE header file
712                              )   for use in non-"configure" environments
713      config.h.generic        ) a version of config.h for use in non-"configure"
714                              )   environments
715    
716    (F) Miscellaneous
717    
718      RunTest.bat            a script for running tests under Windows
719    
720    Philip Hazel
721    Email local part: ph10
722    Email domain: cam.ac.uk
723    Last updated: 17 September 2007

Legend:
Removed from v.31  
changed lines
  Added in v.254

  ViewVC Help
Powered by ViewVC 1.1.5