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

Diff of /code/trunk/README

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

revision 135 by ph10, Thu Mar 29 09:09:33 2007 UTC revision 873 by ph10, Sat Jan 14 16:45:24 2012 UTC
# Line 1  Line 1 
1  README file for PCRE (Perl-compatible regular expression library)  README file for PCRE (Perl-compatible regular expression library)
2  -----------------------------------------------------------------  -----------------------------------------------------------------
3    
4  The latest release of PCRE is always available from  The latest release of PCRE is always available in three alternative formats
5    from:
6    
7    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.tar.gz    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.tar.gz
8      ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.tar.bz2
9      ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.zip
10    
11  There is a mailing list for discussion about the development of PCRE at  There is a mailing list for discussion about the development of PCRE at
12    
# Line 21  The contents of this README file are: Line 24  The contents of this README file are:
24    Shared libraries on Unix-like systems    Shared libraries on Unix-like systems
25    Cross-compiling on Unix-like systems    Cross-compiling on Unix-like systems
26    Using HP's ANSI C++ compiler (aCC)    Using HP's ANSI C++ compiler (aCC)
27      Using PCRE from MySQL
28    Making new tarballs    Making new tarballs
29    Testing PCRE    Testing PCRE
30    Character tables    Character tables
# Line 30  The contents of this README file are: Line 34  The contents of this README file are:
34  The PCRE APIs  The PCRE APIs
35  -------------  -------------
36    
37  PCRE is written in C, and it has its own API. The distribution also includes a  PCRE is written in C, and it has its own API. There are two sets of functions,
38  set of C++ wrapper functions (see the pcrecpp man page for details), courtesy  one for the 8-bit library, which processes strings of bytes, and one for the
39  of Google Inc.  16-bit library, which processes strings of 16-bit values. The distribution also
40    includes a set of C++ wrapper functions (see the pcrecpp man page for details),
41  In addition, there is a set of C wrapper functions that are based on the POSIX  courtesy of Google Inc., which can be used to call the 8-bit PCRE library from
42  regular expression API (see the pcreposix man page). These end up in the  C++.
43  library called libpcreposix. Note that this just provides a POSIX calling  
44  interface to PCRE; the regular expressions themselves still follow Perl syntax  In addition, there is a set of C wrapper functions (again, just for the 8-bit
45  and semantics. The POSIX API is restricted, and does not give full access to  library) that are based on the POSIX regular expression API (see the pcreposix
46  all of PCRE's facilities.  man page). These end up in the library called libpcreposix. Note that this just
47    provides a POSIX calling interface to PCRE; the regular expressions themselves
48    still follow Perl syntax and semantics. The POSIX API is restricted, and does
49    not give full access to all of PCRE's facilities.
50    
51  The header file for the POSIX-style functions is called pcreposix.h. The  The header file for the POSIX-style functions is called pcreposix.h. The
52  official POSIX name is regex.h, but I did not want to risk possible problems  official POSIX name is regex.h, but I did not want to risk possible problems
# Line 82  documentation is supplied in two other f Line 89  documentation is supplied in two other f
89       in various ways, and rooted in a file called index.html, is distributed in       in various ways, and rooted in a file called index.html, is distributed in
90       doc/html and installed in <prefix>/share/doc/pcre/html.       doc/html and installed in <prefix>/share/doc/pcre/html.
91    
92    Users of PCRE have contributed files containing the documentation for various
93    releases in CHM format. These can be found in the Contrib directory of the FTP
94    site (see next section).
95    
96    
97  Contributions by users of PCRE  Contributions by users of PCRE
98  ------------------------------  ------------------------------
# Line 103  Building PCRE on non-Unix systems Line 114  Building PCRE on non-Unix systems
114    
115  For a non-Unix system, please read the comments in the file NON-UNIX-USE,  For a non-Unix system, please read the comments in the file NON-UNIX-USE,
116  though if your system supports the use of "configure" and "make" you may be  though if your system supports the use of "configure" and "make" you may be
117  able to build PCRE in the same way as for Unix-like systems.  able to build PCRE in the same way as for Unix-like systems. PCRE can also be
118    configured in many platform environments using the GUI facility provided by
119    CMake's cmake-gui command. This creates Makefiles, solution files, etc.
120    
121  PCRE has been compiled on many different operating systems. It should be  PCRE has been compiled on many different operating systems. It should be
122  straightforward to build PCRE on any system that has a Standard C compiler and  straightforward to build PCRE on any system that has a Standard C compiler and
# Line 116  Building PCRE on Unix-like systems Line 129  Building PCRE on Unix-like systems
129  If you are using HP's ANSI C++ compiler (aCC), please see the special note  If you are using HP's ANSI C++ compiler (aCC), please see the special note
130  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.
131    
132    The following instructions assume the use of the widely used "configure, make,
133    make install" process. There is also support for CMake in the PCRE
134    distribution; there are some comments about using CMake in the NON-UNIX-USE
135    file, though it can also be used in Unix-like systems.
136    
137  To build PCRE on a Unix-like system, first run the "configure" command from the  To build PCRE on a Unix-like system, first run the "configure" command from the
138  PCRE distribution directory, with your current directory set to the directory  PCRE distribution directory, with your current directory set to the directory
139  where you want the files to be created. This command is a standard GNU  where you want the files to be created. This command is a standard GNU
# Line 128  the usual methods of changing standard d Line 146  the usual methods of changing standard d
146    
147  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local
148    
149  specifies that the C compiler should be run with the flags '-O2 -Wall' instead  This command specifies that the C compiler should be run with the flags '-O2
150  of the default, and that "make install" should install PCRE under /opt/local  -Wall' instead of the default, and that "make install" should install PCRE
151  instead of the default /usr/local.  under /opt/local instead of the default /usr/local.
152    
153  If you want to build in a different directory, just run "configure" with that  If you want to build in a different directory, just run "configure" with that
154  directory as current. For example, suppose you have unpacked the PCRE source  directory as current. For example, suppose you have unpacked the PCRE source
# Line 144  possible to build it as a C++ library, t Line 162  possible to build it as a C++ library, t
162  does not have any features to support this.  does not have any features to support this.
163    
164  There are some optional features that can be included or omitted from the PCRE  There are some optional features that can be included or omitted from the PCRE
165  library. You can read more about them in the pcrebuild man page.  library. They are also documented in the pcrebuild man page.
166    
167    . By default, both shared and static libraries are built. You can change this
168      by adding one of these options to the "configure" command:
169    
170  . If you want to suppress the building of the C++ wrapper library, you can add    --disable-shared
171    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,    --disable-static
172    it will try to find a C++ compiler and C++ header files, and if it succeeds,  
173    it will try to build the C++ wrapper.    (See also "Shared libraries on Unix-like systems" below.)
174    
175  . If you want to make use of the support for UTF-8 character strings in PCRE,  . By default, only the 8-bit library is built. If you add --enable-pcre16 to
176    you must add --enable-utf8 to the "configure" command. Without it, the code    the "configure" command, the 16-bit library is also built. If you want only
177    for handling UTF-8 is not included in the library. (Even when included, it    the 16-bit library, use "./configure --enable-pcre16 --disable-pcre8".
178    still has to be enabled by an option at run time.)  
179    . If you are building the 8-bit library and want to suppress the building of
180  . If, in addition to support for UTF-8 character strings, you want to include    the C++ wrapper library, you can add --disable-cpp to the "configure"
181    support for the \P, \p, and \X sequences that recognize Unicode character    command. Otherwise, when "configure" is run without --disable-pcre8, it will
182    properties, you must add --enable-unicode-properties to the "configure"    try to find a C++ compiler and C++ header files, and if it succeeds, it will
183    command. This adds about 30K to the size of the library (in the form of a    try to build the C++ wrapper.
184    property table); only the basic two-letter properties such as Lu are  
185    supported.  . If you want to include support for just-in-time compiling, which can give
186      large performance improvements on certain platforms, add --enable-jit to the
187      "configure" command. This support is available only for certain hardware
188      architectures. If you try to enable it on an unsupported architecture, there
189      will be a compile time error.
190    
191    . When JIT support is enabled, pcregrep automatically makes use of it, unless
192      you add --disable-pcregrep-jit to the "configure" command.
193    
194    . If you want to make use of the support for UTF-8 Unicode character strings in
195      the 8-bit library, or UTF-16 Unicode character strings in the 16-bit library,
196      you must add --enable-utf to the "configure" command. Without it, the code
197      for handling UTF-8 and UTF-16 is not included in the relevant library. Even
198      when --enable-utf is included, the use of a UTF encoding still has to be
199      enabled by an option at run time. When PCRE is compiled with this option, its
200      input can only either be ASCII or UTF-8/16, even when running on EBCDIC
201      platforms. It is not possible to use both --enable-utf and --enable-ebcdic at
202      the same time.
203    
204    . There are no separate options for enabling UTF-8 and UTF-16 independently
205      because that would allow ridiculous settings such as requesting UTF-16
206      support while building only the 8-bit library. However, the option
207      --enable-utf8 is retained for backwards compatibility with earlier releases
208      that did not support 16-bit character strings. It is synonymous with
209      --enable-utf. It is not possible to configure one library with UTF support
210      and the other without in the same configuration.
211    
212    . If, in addition to support for UTF-8/16 character strings, you want to
213      include support for the \P, \p, and \X sequences that recognize Unicode
214      character properties, you must add --enable-unicode-properties to the
215      "configure" command. This adds about 30K to the size of the library (in the
216      form of a property table); only the basic two-letter properties such as Lu
217      are supported.
218    
219  . You can build PCRE to recognize either CR or LF or the sequence CRLF or any  . You can build PCRE to recognize either CR or LF or the sequence CRLF or any
220    of the Unicode newline sequences as indicating the end of a line. Whatever    of the preceding, or any of the Unicode newline sequences as indicating the
221    you specify at build time is the default; the caller of PCRE can change the    end of a line. Whatever you specify at build time is the default; the caller
222    selection at run time. The default newline indicator is a single LF character    of PCRE can change the selection at run time. The default newline indicator
223    (the Unix standard). You can specify the default newline indicator by adding    is a single LF character (the Unix standard). You can specify the default
224    --newline-is-cr or --newline-is-lf or --newline-is-crlf or --newline-is-any    newline indicator by adding --enable-newline-is-cr or --enable-newline-is-lf
225    to the "configure" command, respectively.    or --enable-newline-is-crlf or --enable-newline-is-anycrlf or
226      --enable-newline-is-any to the "configure" command, respectively.
227    If you specify --newline-is-cr or --newline-is-crlf, some of the standard  
228    tests will fail, because the lines in the test files end with LF. Even if    If you specify --enable-newline-is-cr or --enable-newline-is-crlf, some of
229    the files are edited to change the line endings, there are likely to be some    the standard tests will fail, because the lines in the test files end with
230    failures. With --newline-is-any, many tests should succeed, but there may be    LF. Even if the files are edited to change the line endings, there are likely
231    some failures.    to be some failures. With --enable-newline-is-anycrlf or
232      --enable-newline-is-any, many tests should succeed, but there may be some
233      failures.
234    
235    . By default, the sequence \R in a pattern matches any Unicode line ending
236      sequence. This is independent of the option specifying what PCRE considers to
237      be the end of a line (see above). However, the caller of PCRE can restrict \R
238      to match only CR, LF, or CRLF. You can make this the default by adding
239      --enable-bsr-anycrlf to the "configure" command (bsr = "backslash R").
240    
241  . When called via the POSIX interface, PCRE uses malloc() to get additional  . When called via the POSIX interface, PCRE uses malloc() to get additional
242    storage for processing capturing parentheses if there are more than 10 of    storage for processing capturing parentheses if there are more than 10 of
# Line 206  library. You can read more about them in Line 267  library. You can read more about them in
267    sizes in the pcrestack man page.    sizes in the pcrestack man page.
268    
269  . The default maximum compiled pattern size is around 64K. You can increase  . The default maximum compiled pattern size is around 64K. You can increase
270    this by adding --with-link-size=3 to the "configure" command. You can    this by adding --with-link-size=3 to the "configure" command. In the 8-bit
271    increase it even more by setting --with-link-size=4, but this is unlikely    library, PCRE then uses three bytes instead of two for offsets to different
272    ever to be necessary. Increasing the internal link size will reduce    parts of the compiled pattern. In the 16-bit library, --with-link-size=3 is
273    performance.    the same as --with-link-size=4, which (in both libraries) uses four-byte
274      offsets. Increasing the internal link size reduces performance.
275    
276  . You can build PCRE so that its internal match() function that is called from  . You can build PCRE so that its internal match() function that is called from
277    pcre_exec() does not call itself recursively. Instead, it uses memory blocks    pcre_exec() does not call itself recursively. Instead, it uses memory blocks
# Line 221  library. You can read more about them in Line 283  library. You can read more about them in
283    
284    on the "configure" command. PCRE runs more slowly in this mode, but it may be    on the "configure" command. PCRE runs more slowly in this mode, but it may be
285    necessary in environments with limited stack sizes. This applies only to the    necessary in environments with limited stack sizes. This applies only to the
286    pcre_exec() function; it does not apply to pcre_dfa_exec(), which does not    normal execution of the pcre_exec() function; if JIT support is being
287    use deeply nested recursion. There is a discussion about stack sizes in the    successfully used, it is not relevant. Equally, it does not apply to
288    pcrestack man page.    pcre_dfa_exec(), which does not use deeply nested recursion. There is a
289      discussion about stack sizes in the pcrestack man page.
290    
291  . For speed, PCRE uses four tables for manipulating and identifying characters  . For speed, PCRE uses four tables for manipulating and identifying characters
292    whose code point values are less than 256. By default, it uses a set of    whose code point values are less than 256. By default, it uses a set of
# Line 237  library. You can read more about them in Line 300  library. You can read more about them in
300    pcre_chartables.c.dist. See "Character tables" below for further information.    pcre_chartables.c.dist. See "Character tables" below for further information.
301    
302  . It is possible to compile PCRE for use on systems that use EBCDIC as their  . It is possible to compile PCRE for use on systems that use EBCDIC as their
303    default character code (as opposed to ASCII) by specifying    character code (as opposed to ASCII) by specifying
304    
305    --enable-ebcdic    --enable-ebcdic
306    
307    This automatically implies --enable-rebuild-chartables (see above).    This automatically implies --enable-rebuild-chartables (see above). However,
308      when PCRE is built this way, it always operates in EBCDIC. It cannot support
309      both EBCDIC and UTF-8/16.
310    
311    . The pcregrep program currently supports only 8-bit data files, and so
312      requires the 8-bit PCRE library. It is possible to compile pcregrep to use
313      libz and/or libbz2, in order to read .gz and .bz2 files (respectively), by
314      specifying one or both of
315    
316      --enable-pcregrep-libz
317      --enable-pcregrep-libbz2
318    
319      Of course, the relevant libraries must be installed on your system.
320    
321    . The default size of internal buffer used by pcregrep can be set by, for
322      example:
323    
324      --with-pcregrep-bufsize=50K
325    
326      The default value is 20K.
327    
328    . It is possible to compile pcretest so that it links with the libreadline
329      library, by specifying
330    
331      --enable-pcretest-libreadline
332    
333      If this is done, when pcretest's input is from a terminal, it reads it using
334      the readline() function. This provides line-editing and history facilities.
335      Note that libreadline is GPL-licenced, so if you distribute a binary of
336      pcretest linked in this way, there may be licensing issues.
337    
338      Setting this option causes the -lreadline option to be added to the pcretest
339      build. In many operating environments with a sytem-installed readline
340      library this is sufficient. However, in some environments (e.g. if an
341      unmodified distribution version of readline is in use), it may be necessary
342      to specify something like LIBS="-lncurses" as well. This is because, to quote
343      the readline INSTALL, "Readline uses the termcap functions, but does not link
344      with the termcap or curses library itself, allowing applications which link
345      with readline the to choose an appropriate library." If you get error
346      messages about missing functions tgetstr, tgetent, tputs, tgetflag, or tgoto,
347      this is the problem, and linking with the ncurses library should fix it.
348    
349  The "configure" script builds the following files for the basic C library:  The "configure" script builds the following files for the basic C library:
350    
351  . Makefile is the makefile that builds the library  . Makefile             the makefile that builds the library
352  . config.h contains build-time configuration options for the library  . config.h             build-time configuration options for the library
353  . pcre.h is the public PCRE header file  . pcre.h               the public PCRE header file
354  . pcre-config is a script that shows the settings of "configure" options  . pcre-config          script that shows the building settings such as CFLAGS
355  . libpcre.pc is data for the pkg-config command                           that were set for "configure"
356  . libtool is a script that builds shared and/or static libraries  . libpcre.pc         ) data for the pkg-config command
357  . RunTest is a script for running tests on the basic C library  . libpcre16.pc       )
358  . RunGrepTest is a script for running tests on the pcregrep command  . libpcreposix.pc    )
359    . libtool              script that builds shared and/or static libraries
360  Versions of config.h and pcre.h are distributed in the PCRE tarballs under  . RunTest              script for running tests on the basic C library
361  the names config.h.generic and pcre.h.generic. These are provided for the  . RunGrepTest          script for running tests on the pcregrep command
362  benefit of those who have to built PCRE without the benefit of "configure". If  
363  you use "configure", the .generic versions are not used.  Versions of config.h and pcre.h are distributed in the PCRE tarballs under the
364    names config.h.generic and pcre.h.generic. These are provided for those who
365  If a C++ compiler is found, the following files are also built:  have to built PCRE without using "configure" or CMake. If you use "configure"
366    or CMake, the .generic versions are not used.
367  . libpcrecpp.pc is data for the pkg-config command  
368  . pcrecpparg.h is a header file for programs that call PCRE via the C++ wrapper  When building the 8-bit library, if a C++ compiler is found, the following
369  . pcre_stringpiece.h is the header for the C++ "stringpiece" functions  files are also built:
370    
371    . libpcrecpp.pc        data for the pkg-config command
372    . pcrecpparg.h         header file for calling PCRE via the C++ wrapper
373    . pcre_stringpiece.h   header for the C++ "stringpiece" functions
374    
375  The "configure" script also creates config.status, which is an executable  The "configure" script also creates config.status, which is an executable
376  script that can be run to recreate the configuration, and config.log, which  script that can be run to recreate the configuration, and config.log, which
377  contains compiler output from tests that "configure" runs.  contains compiler output from tests that "configure" runs.
378    
379  Once "configure" has run, you can run "make". It builds two libraries, called  Once "configure" has run, you can run "make". This builds either or both of the
380  libpcre and libpcreposix, a test program called pcretest, a demonstration  libraries libpcre and libpcre16, and a test program called pcretest. If you
381  program called pcredemo, and the pcregrep command. If a C++ compiler was found  enabled JIT support with --enable-jit, a test program called pcre_jit_test is
382  on your system, "make" also builds the C++ wrapper library, which is called  built as well.
383  libpcrecpp, and some test programs called pcrecpp_unittest,  
384  pcre_scanner_unittest, and pcre_stringpiece_unittest. Building the C++ wrapper  If the 8-bit library is built, libpcreposix and the pcregrep command are also
385  can be disabled by adding --disable-cpp to the "configure" command.  built, and if a C++ compiler was found on your system, and you did not disable
386    it with --disable-cpp, "make" builds the C++ wrapper library, which is called
387    libpcrecpp, as well as some test programs called pcrecpp_unittest,
388    pcre_scanner_unittest, and pcre_stringpiece_unittest.
389    
390  The command "make check" runs all the appropriate tests. Details of the PCRE  The command "make check" runs all the appropriate tests. Details of the PCRE
391  tests are given below in a separate section of this document.  tests are given below in a separate section of this document.
# Line 286  system. The following are installed (fil Line 396  system. The following are installed (fil
396    
397    Commands (bin):    Commands (bin):
398      pcretest      pcretest
399      pcregrep      pcregrep (if 8-bit support is enabled)
400      pcre-config      pcre-config
401    
402    Libraries (lib):    Libraries (lib):
403      libpcre      libpcre16     (if 16-bit support is enabled)
404      libpcreposix      libpcre       (if 8-bit support is enabled)
405      libpcrecpp (if C++ support is enabled)      libpcreposix  (if 8-bit support is enabled)
406        libpcrecpp    (if 8-bit and C++ support is enabled)
407    
408    Configuration information (lib/pkgconfig):    Configuration information (lib/pkgconfig):
409        libpcre16.pc
410      libpcre.pc      libpcre.pc
411        libpcreposix.pc
412      libpcrecpp.pc (if C++ support is enabled)      libpcrecpp.pc (if C++ support is enabled)
413    
414    Header files (include):    Header files (include):
# Line 309  system. The following are installed (fil Line 422  system. The following are installed (fil
422    Man pages (share/man/man{1,3}):    Man pages (share/man/man{1,3}):
423      pcregrep.1      pcregrep.1
424      pcretest.1      pcretest.1
425        pcre-config.1
426      pcre.3      pcre.3
427      pcre*.3 (lots more pages, all starting "pcre")      pcre*.3 (lots more pages, all starting "pcre")
428    
# Line 323  system. The following are installed (fil Line 437  system. The following are installed (fil
437      LICENCE      LICENCE
438      NEWS      NEWS
439      README      README
440      pcre.txt       (a concatenation of the man(3) pages)      pcre.txt         (a concatenation of the man(3) pages)
441      pcretest.txt   the pcretest man page      pcretest.txt     the pcretest man page
442      pcregrep.txt   the pcregrep man page      pcregrep.txt     the pcregrep man page
443        pcre-config.txt  the pcre-config man page
 Note that the pcredemo program that is built by "configure" is *not* installed  
 anywhere. It is a demonstration for programmers wanting to use PCRE.  
444    
445  If you want to remove PCRE from your system, you can run "make uninstall".  If you want to remove PCRE from your system, you can run "make uninstall".
446  This removes all the files that "make install" installed. However, it does not  This removes all the files that "make install" installed. However, it does not
# Line 425  running the "configure" script: Line 537  running the "configure" script:
537    CXXLDFLAGS="-lstd_v2 -lCsup_v2"    CXXLDFLAGS="-lstd_v2 -lCsup_v2"
538    
539    
540    Using Sun's compilers for Solaris
541    ---------------------------------
542    
543    A user reports that the following configurations work on Solaris 9 sparcv9 and
544    Solaris 9 x86 (32-bit):
545    
546      Solaris 9 sparcv9: ./configure --disable-cpp CC=/bin/cc CFLAGS="-m64 -g"
547      Solaris 9 x86:     ./configure --disable-cpp CC=/bin/cc CFLAGS="-g"
548    
549    
550    Using PCRE from MySQL
551    ---------------------
552    
553    On systems where both PCRE and MySQL are installed, it is possible to make use
554    of PCRE from within MySQL, as an alternative to the built-in pattern matching.
555    There is a web page that tells you how to do this:
556    
557      http://www.mysqludf.org/lib_mysqludf_preg/index.php
558    
559    
560  Making new tarballs  Making new tarballs
561  -------------------  -------------------
562    
563  The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and  The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and
564  zip formats. However, if you have modified any of the man page sources in the  zip formats. The command "make distcheck" does the same, but then does a trial
565  doc directory, you should first run the PrepareRelease script. This re-creates  build of the new distribution to ensure that it works.
566  the .txt and HTML forms of the documentation from the man pages.  
567    If you have modified any of the man page sources in the doc directory, you
568    should first run the PrepareRelease script before making a distribution. This
569    script creates the .txt and HTML forms of the documentation from the man pages.
570    
571    
572  Testing PCRE  Testing PCRE
# Line 441  To test the basic PCRE library on a Unix Line 576  To test the basic PCRE library on a Unix
576  created by the configuring process. There is also a script called RunGrepTest  created by the configuring process. There is also a script called RunGrepTest
577  that tests the options of the pcregrep command. If the C++ wrapper library is  that tests the options of the pcregrep command. If the C++ wrapper library is
578  built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and  built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and
579  pcre_stringpiece_unittest are also built.  pcre_stringpiece_unittest are also built. When JIT support is enabled, another
580    test program called pcre_jit_test is built.
581    
582  Both the scripts and all the program tests are run if you obey "make check" or  Both the scripts and all the program tests are run if you obey "make check" or
583  "make test". For other systems, see the instructions in NON-UNIX-USE.  "make test". For other systems, see the instructions in NON-UNIX-USE.
584    
585  The RunTest script runs the pcretest test program (which is documented in its  The RunTest script runs the pcretest test program (which is documented in its
586  own man page) on each of the testinput files in the testdata directory in  own man page) on each of the relevant testinput files in the testdata
587  turn, and compares the output with the contents of the corresponding testoutput  directory, and compares the output with the contents of the corresponding
588  files. A file called testtry is used to hold the main output from pcretest  testoutput files. Some tests are relevant only when certain build-time options
589  (testsavedregex is also used as a working file). To run pcretest on just one of  were selected. For example, the tests for UTF-8/16 support are run only if
590  the test files, give its number as an argument to RunTest, for example:  --enable-utf was used. RunTest outputs a comment when it skips a test.
591    
592    RunTest 2  Many of the tests that are not skipped are run up to three times. The second
593    run forces pcre_study() to be called for all patterns except for a few in some
594  The first test file can also be fed directly into the perltest.pl script to  tests that are marked "never study" (see the pcretest program for how this is
595  check that Perl gives the same results. The only difference you should see is  done). If JIT support is available, the non-DFA tests are run a third time,
596  in the first few lines, where the Perl version is given instead of the PCRE  this time with a forced pcre_study() with the PCRE_STUDY_JIT_COMPILE option.
597  version.  
598    When both 8-bit and 16-bit support is enabled, the entire set of tests is run
599    twice, once for each library. If you want to run just one set of tests, call
600    RunTest with either the -8 or -16 option.
601    
602    RunTest uses a file called testtry to hold the main output from pcretest.
603    Other files whose names begin with "test" are used as working files in some
604    tests. To run pcretest on just one or more specific test files, give their
605    numbers as arguments to RunTest, for example:
606    
607      RunTest 2 7 11
608    
609    The first test file can be fed directly into the perltest.pl script to check
610    that Perl gives the same results. The only difference you should see is in the
611    first few lines, where the Perl version is given instead of the PCRE version.
612    
613  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),  The second set of tests check pcre_fullinfo(), pcre_study(),
614  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
615  detection, and run-time flags that are specific to PCRE, as well as the POSIX  detection, and run-time flags that are specific to PCRE, as well as the POSIX
616  wrapper API. It also uses the debugging flags to check some of the internals of  wrapper API. It also uses the debugging flags to check some of the internals of
# Line 489  is output to say why. If running this te Line 639  is output to say why. If running this te
639  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,
640  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.
641    
642  The fourth test checks the UTF-8 support. It is not run automatically unless  [If you are trying to run this test on Windows, you may be able to get it to
643  PCRE is built with UTF-8 support. To do this you must set --enable-utf8 when  work by changing "fr_FR" to "french" everywhere it occurs. Alternatively, use
644  running "configure". This file can be also fed directly to the perltest script,  RunTest.bat. The version of RunTest.bat included with PCRE 7.4 and above uses
645  provided you are running Perl 5.8 or higher. (For Perl 5.6, a small patch,  Windows versions of test 2. More info on using RunTest.bat is included in the
646  commented in the script, can be be used.)  document entitled NON-UNIX-USE.]
647    
648  The fifth test checks error handling with UTF-8 encoding, and internal UTF-8  The fourth and fifth tests check the UTF-8/16 support and error handling and
649  features of PCRE that are not relevant to Perl.  internal UTF features of PCRE that are not relevant to Perl, respectively. The
650    sixth and seventh tests do the same for Unicode character properties support.
651  The sixth test checks the support for Unicode character properties. It it not  
652  run automatically unless PCRE is built with Unicode property support. To to  The eighth, ninth, and tenth tests check the pcre_dfa_exec() alternative
653  this you must set --enable-unicode-properties when running "configure".  matching function, in non-UTF-8/16 mode, UTF-8/16 mode, and UTF-8/16 mode with
654    Unicode property support, respectively.
655  The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative  
656  matching function, in non-UTF-8 mode, UTF-8 mode, and UTF-8 mode with Unicode  The eleventh test checks some internal offsets and code size features; it is
657  property support, respectively. The eighth and ninth tests are not run  run only when the default "link size" of 2 is set (in other cases the sizes
658  automatically unless PCRE is build with the relevant support.  change) and when Unicode property support is enabled.
659    
660    The twelfth test is run only when JIT support is available, and the thirteenth
661    test is run only when JIT support is not available. They test some JIT-specific
662    features such as information output from pcretest about JIT compilation.
663    
664    The fourteenth, fifteenth, and sixteenth tests are run only in 8-bit mode, and
665    the seventeenth, eighteenth, and nineteenth tests are run only in 16-bit mode.
666    These are tests that generate different output in the two modes. They are for
667    general cases, UTF-8/16 support, and Unicode property support, respectively.
668    
669    The twentieth test is run only in 16-bit mode. It tests some specific 16-bit
670    features of the DFA matching engine.
671    
672    
673  Character tables  Character tables
# Line 565  will cause PCRE to malfunction. Line 727  will cause PCRE to malfunction.
727  File manifest  File manifest
728  -------------  -------------
729    
730  The distribution should contain the following files:  The distribution should contain the files listed below. Where a file name is
731    given as pcre[16]_xxx it means that there are two files, one with the name
732    pcre_xxx and the other with the name pcre16_xxx.
733    
734  (A) Source files of the PCRE library functions and their headers:  (A) Source files of the PCRE library functions and their headers:
735    
# Line 574  The distribution should contain the foll Line 738  The distribution should contain the foll
738    
739    pcre_chartables.c.dist  a default set of character tables that assume ASCII    pcre_chartables.c.dist  a default set of character tables that assume ASCII
740                              coding; used, unless --enable-rebuild-chartables is                              coding; used, unless --enable-rebuild-chartables is
741                              specified, by copying to pcre_chartables.c                              specified, by copying to pcre[16]_chartables.c
742    
743    pcreposix.c             )    pcreposix.c             )
744    pcre_compile.c          )    pcre[16]_byte_order.c   )
745    pcre_config.c           )    pcre[16]_compile.c      )
746    pcre_dfa_exec.c         )    pcre[16]_config.c       )
747    pcre_exec.c             )    pcre[16]_dfa_exec.c     )
748    pcre_fullinfo.c         )    pcre[16]_exec.c         )
749    pcre_get.c              ) sources for the functions in the library,    pcre[16]_fullinfo.c     )
750    pcre_globals.c          )   and some internal functions that they use    pcre[16]_get.c          ) sources for the functions in the library,
751    pcre_info.c             )    pcre[16]_globals.c      )   and some internal functions that they use
752    pcre_maketables.c       )    pcre[16]_jit_compile.c  )
753    pcre_newline.c          )    pcre[16]_maketables.c   )
754      pcre[16]_newline.c      )
755      pcre[16]_refcount.c     )
756      pcre[16]_string_utils.c )
757      pcre[16]_study.c        )
758      pcre[16]_tables.c       )
759      pcre[16]_ucd.c          )
760      pcre[16]_version.c      )
761      pcre[16]_xclass.c       )
762    pcre_ord2utf8.c         )    pcre_ord2utf8.c         )
   pcre_refcount.c         )  
   pcre_study.c            )  
   pcre_tables.c           )  
   pcre_try_flipped.c      )  
   pcre_ucp_searchfuncs.c  )  
763    pcre_valid_utf8.c       )    pcre_valid_utf8.c       )
764    pcre_version.c          )    pcre16_ord2utf16.c      )
765    pcre_xclass.c           )    pcre16_utf16_utils.c    )
766    pcre_printint.src       ) debugging function that is #included in pcretest,    pcre16_valid_utf16.c    )
767    
768      pcre[16]_printint.c     ) debugging function that is used by pcretest,
769                            )   and can also be #included in pcre_compile()                            )   and can also be #included in pcre_compile()
770    
771    pcre.h.in               template for pcre.h when built by "configure"    pcre.h.in               template for pcre.h when built by "configure"
772    pcreposix.h             header for the external POSIX wrapper API    pcreposix.h             header for the external POSIX wrapper API
773    pcre_internal.h         header for internal use    pcre_internal.h         header for internal use
774    ucp.h                   ) headers concerned with    sljit/*                 16 files that make up the JIT compiler
775    ucpinternal.h           )   Unicode property handling    ucp.h                   header for Unicode property handling
   ucptable.h              ) (this one is the data table)  
776    
777    config.h.in             template for config.h, which is built by "configure"    config.h.in             template for config.h, which is built by "configure"
778    
# Line 642  The distribution should contain the foll Line 811  The distribution should contain the foll
811    NON-UNIX-USE            notes on building PCRE on non-Unix systems    NON-UNIX-USE            notes on building PCRE on non-Unix systems
812    PrepareRelease          script to make preparations for "make dist"    PrepareRelease          script to make preparations for "make dist"
813    README                  this file    README                  this file
814    RunTest.in              template for a Unix shell script for running tests    RunTest                 a Unix shell script for running tests
815    RunGrepTest.in          template for a Unix shell script for pcregrep tests    RunGrepTest             a Unix shell script for pcregrep tests
816    aclocal.m4              m4 macros (generated by "aclocal")    aclocal.m4              m4 macros (generated by "aclocal")
817    config.guess            ) files used by libtool,    config.guess            ) files used by libtool,
818    config.sub              )   used only when building a shared library    config.sub              )   used only when building a shared library
# Line 652  The distribution should contain the foll Line 821  The distribution should contain the foll
821                            )   "configure" and config.h                            )   "configure" and config.h
822    depcomp                 ) script to find program dependencies, generated by    depcomp                 ) script to find program dependencies, generated by
823                            )   automake                            )   automake
824    doc/*.3                 man page sources for the PCRE functions    doc/*.3                 man page sources for PCRE
825    doc/*.1                 man page sources for pcregrep and pcretest    doc/*.1                 man page sources for pcregrep and pcretest
826    doc/index.html.src      the base HTML page    doc/index.html.src      the base HTML page
827    doc/html/*              HTML documentation    doc/html/*              HTML documentation
# Line 660  The distribution should contain the foll Line 829  The distribution should contain the foll
829    doc/pcretest.txt        plain text documentation of test program    doc/pcretest.txt        plain text documentation of test program
830    doc/perltest.txt        plain text documentation of Perl test program    doc/perltest.txt        plain text documentation of Perl test program
831    install-sh              a shell script for installing files    install-sh              a shell script for installing files
832      libpcre16.pc.in         template for libpcre16.pc for pkg-config
833    libpcre.pc.in           template for libpcre.pc for pkg-config    libpcre.pc.in           template for libpcre.pc for pkg-config
834      libpcreposix.pc.in      template for libpcreposix.pc for pkg-config
835    libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config    libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config
836    ltmain.sh               file used to build a libtool script    ltmain.sh               file used to build a libtool script
837    missing                 ) common stub for a few missing GNU programs while    missing                 ) common stub for a few missing GNU programs while
# Line 668  The distribution should contain the foll Line 839  The distribution should contain the foll
839    mkinstalldirs           script for making install directories    mkinstalldirs           script for making install directories
840    perltest.pl             Perl test program    perltest.pl             Perl test program
841    pcre-config.in          source of script which retains PCRE information    pcre-config.in          source of script which retains PCRE information
842      pcre_jit_test.c         test program for the JIT compiler
843    pcrecpp_unittest.cc          )    pcrecpp_unittest.cc          )
844    pcre_scanner_unittest.cc     ) test programs for the C++ wrapper    pcre_scanner_unittest.cc     ) test programs for the C++ wrapper
845    pcre_stringpiece_unittest.cc )    pcre_stringpiece_unittest.cc )
846    testdata/testinput*     test data for main library tests    testdata/testinput*     test data for main library tests
847    testdata/testoutput*    expected test results    testdata/testoutput*    expected test results
848    testdata/grep*          input and output for pcregrep tests    testdata/grep*          input and output for pcregrep tests
849      testdata/*              other supporting test files
850    
851  (D) Auxiliary files for cmake support  (D) Auxiliary files for cmake support
852    
853      cmake/COPYING-CMAKE-SCRIPTS
854      cmake/FindPackageHandleStandardArgs.cmake
855      cmake/FindReadline.cmake
856    CMakeLists.txt    CMakeLists.txt
857    config-cmake.h.in    config-cmake.h.in
858    
# Line 701  The distribution should contain the foll Line 877  The distribution should contain the foll
877  Philip Hazel  Philip Hazel
878  Email local part: ph10  Email local part: ph10
879  Email domain: cam.ac.uk  Email domain: cam.ac.uk
880  Last updated: 26 March 2007  Last updated: 30 December 2011

Legend:
Removed from v.135  
changed lines
  Added in v.873

  ViewVC Help
Powered by ViewVC 1.1.5