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

Diff of /code/trunk/README

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

revision 836 by ph10, Wed Dec 28 17:16:11 2011 UTC revision 1404 by ph10, Tue Nov 19 15:36:57 2013 UTC
# Line 9  from: Line 9  from:
9    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.zip    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    pcre-dev@exim.org. You can access the archives and subscribe or manage your
13    subscription here:
14    
15    pcre-dev@exim.org     https://lists.exim.org/mailman/listinfo/pcre-dev
16    
17  Please read the NEWS file if you are upgrading from a previous release.  Please read the NEWS file if you are upgrading from a previous release.
18  The contents of this README file are:  The contents of this README file are:
# Line 18  The contents of this README file are: Line 20  The contents of this README file are:
20    The PCRE APIs    The PCRE APIs
21    Documentation for PCRE    Documentation for PCRE
22    Contributions by users of PCRE    Contributions by users of PCRE
23    Building PCRE on non-Unix systems    Building PCRE on non-Unix-like systems
24    Building PCRE on Unix-like systems    Building PCRE without using autotools
25    Retrieving configuration information on Unix-like systems    Building PCRE using autotools
26    Shared libraries on Unix-like systems    Retrieving configuration information
27    Cross-compiling on Unix-like systems    Shared libraries
28      Cross-compiling using autotools
29    Using HP's ANSI C++ compiler (aCC)    Using HP's ANSI C++ compiler (aCC)
30      Compiling in Tru64 using native compilers
31      Using Sun's compilers for Solaris
32    Using PCRE from MySQL    Using PCRE from MySQL
33    Making new tarballs    Making new tarballs
34    Testing PCRE    Testing PCRE
# Line 34  The contents of this README file are: Line 39  The contents of this README file are:
39  The PCRE APIs  The PCRE APIs
40  -------------  -------------
41    
42  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 three sets of
43  set of C++ wrapper functions (see the pcrecpp man page for details), courtesy  functions, one for the 8-bit library, which processes strings of bytes, one for
44  of Google Inc.  the 16-bit library, which processes strings of 16-bit values, and one for the
45    32-bit library, which processes strings of 32-bit values. The distribution also
46  In addition, there is a set of C wrapper functions that are based on the POSIX  includes a set of C++ wrapper functions (see the pcrecpp man page for details),
47  regular expression API (see the pcreposix man page). These end up in the  courtesy of Google Inc., which can be used to call the 8-bit PCRE library from
48  library called libpcreposix. Note that this just provides a POSIX calling  C++.
49  interface to PCRE; the regular expressions themselves still follow Perl syntax  
50  and semantics. The POSIX API is restricted, and does not give full access to  In addition, there is a set of C wrapper functions (again, just for the 8-bit
51  all of PCRE's facilities.  library) that are based on the POSIX regular expression API (see the pcreposix
52    man page). These end up in the library called libpcreposix. Note that this just
53    provides a POSIX calling interface to PCRE; the regular expressions themselves
54    still follow Perl syntax and semantics. The POSIX API is restricted, and does
55    not give full access to all of PCRE's facilities.
56    
57  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
58  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 105  contributions provided support for compi Line 114  contributions provided support for compi
114  Windows (I myself do not use Windows). Nowadays there is more Windows support  Windows (I myself do not use Windows). Nowadays there is more Windows support
115  in the standard distribution, so these contibutions have been archived.  in the standard distribution, so these contibutions have been archived.
116    
117    A PCRE user maintains downloadable Windows binaries of the pcregrep and
118    pcretest programs here:
119    
120  Building PCRE on non-Unix systems    http://www.rexegg.com/pcregrep-pcretest.html
121  ---------------------------------  
122    
123    Building PCRE on non-Unix-like systems
124    --------------------------------------
125    
126    For a non-Unix-like system, please read the comments in the file
127    NON-AUTOTOOLS-BUILD, though if your system supports the use of "configure" and
128    "make" you may be able to build PCRE using autotools in the same way as for
129    many Unix-like systems.
130    
131  For a non-Unix system, please read the comments in the file NON-UNIX-USE,  PCRE can also be configured using the GUI facility provided by CMake's
132  though if your system supports the use of "configure" and "make" you may be  cmake-gui command. This creates Makefiles, solution files, etc. The file
133  able to build PCRE in the same way as for Unix-like systems. PCRE can also be  NON-AUTOTOOLS-BUILD has information about CMake.
 configured in many platform environments using the GUI facility provided by  
 CMake's cmake-gui command. This creates Makefiles, solution files, etc.  
134    
135  PCRE has been compiled on many different operating systems. It should be  PCRE has been compiled on many different operating systems. It should be
136  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
137  library, because it uses only Standard C functions.  library, because it uses only Standard C functions.
138    
139    
140  Building PCRE on Unix-like systems  Building PCRE without using autotools
141  ----------------------------------  -------------------------------------
142    
143    The use of autotools (in particular, libtool) is problematic in some
144    environments, even some that are Unix or Unix-like. See the NON-AUTOTOOLS-BUILD
145    file for ways of building PCRE without using autotools.
146    
147    
148    Building PCRE using autotools
149    -----------------------------
150    
151  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
152  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.
153    
154  The following instructions assume the use of the widely used "configure, make,  The following instructions assume the use of the widely used "configure; make;
155  make install" process. There is also support for CMake in the PCRE  make install" (autotools) process.
156  distribution; there are some comments about using CMake in the NON-UNIX-USE  
157  file, though it can also be used in Unix-like systems.  To build PCRE on system that supports autotools, first run the "configure"
158    command from the PCRE distribution directory, with your current directory set
159  To build PCRE on a Unix-like system, first run the "configure" command from the  to the directory where you want the files to be created. This command is a
160  PCRE distribution directory, with your current directory set to the directory  standard GNU "autoconf" configuration script, for which generic instructions
161  where you want the files to be created. This command is a standard GNU  are supplied in the file INSTALL.
 "autoconf" configuration script, for which generic instructions are supplied in  
 the file INSTALL.  
162    
163  Most commonly, people build PCRE within its own distribution directory, and in  Most commonly, people build PCRE within its own distribution directory, and in
164  this case, on many systems, just running "./configure" is sufficient. However,  this case, on many systems, just running "./configure" is sufficient. However,
# Line 143  the usual methods of changing standard d Line 166  the usual methods of changing standard d
166    
167  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local
168    
169  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
170  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
171  instead of the default /usr/local.  under /opt/local instead of the default /usr/local.
172    
173  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
174  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 169  library. They are also documented in the Line 192  library. They are also documented in the
192    
193    (See also "Shared libraries on Unix-like systems" below.)    (See also "Shared libraries on Unix-like systems" below.)
194    
195  . If you want to suppress the building of the C++ wrapper library, you can add  . By default, only the 8-bit library is built. If you add --enable-pcre16 to
196    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,    the "configure" command, the 16-bit library is also built. If you add
197    it will try to find a C++ compiler and C++ header files, and if it succeeds,    --enable-pcre32 to the "configure" command, the 32-bit library is also built.
198    it will try to build the C++ wrapper.    If you want only the 16-bit or 32-bit library, use --disable-pcre8 to disable
199      building the 8-bit library.
200    
201    . If you are building the 8-bit library and want to suppress the building of
202      the C++ wrapper library, you can add --disable-cpp to the "configure"
203      command. Otherwise, when "configure" is run without --disable-pcre8, it will
204      try to find a C++ compiler and C++ header files, and if it succeeds, it will
205      try to build the C++ wrapper.
206    
207  . If you want to include support for just-in-time compiling, which can give  . If you want to include support for just-in-time compiling, which can give
208    large performance improvements on certain platforms, add --enable-jit to the    large performance improvements on certain platforms, add --enable-jit to the
# Line 184  library. They are also documented in the Line 214  library. They are also documented in the
214    you add --disable-pcregrep-jit to the "configure" command.    you add --disable-pcregrep-jit to the "configure" command.
215    
216  . If you want to make use of the support for UTF-8 Unicode character strings in  . If you want to make use of the support for UTF-8 Unicode character strings in
217    PCRE, you must add --enable-utf8 to the "configure" command. Without it, the    the 8-bit library, or UTF-16 Unicode character strings in the 16-bit library,
218    code for handling UTF-8 is not included in the library. Even when included,    or UTF-32 Unicode character strings in the 32-bit library, you must add
219    it still has to be enabled by an option at run time. When PCRE is compiled    --enable-utf to the "configure" command. Without it, the code for handling
220    with this option, its input can only either be ASCII or UTF-8, even when    UTF-8, UTF-16 and UTF-8 is not included in the relevant library. Even
221    running on EBCDIC platforms. It is not possible to use both --enable-utf8 and    when --enable-utf is included, the use of a UTF encoding still has to be
222    --enable-ebcdic at the same time.    enabled by an option at run time. When PCRE is compiled with this option, its
223      input can only either be ASCII or UTF-8/16/32, even when running on EBCDIC
224  . If, in addition to support for UTF-8 character strings, you want to include    platforms. It is not possible to use both --enable-utf and --enable-ebcdic at
225    support for the \P, \p, and \X sequences that recognize Unicode character    the same time.
226    properties, you must add --enable-unicode-properties to the "configure"  
227    command. This adds about 30K to the size of the library (in the form of a  . There are no separate options for enabling UTF-8, UTF-16 and UTF-32
228    property table); only the basic two-letter properties such as Lu are    independently because that would allow ridiculous settings such as requesting
229    supported.    UTF-16 support while building only the 8-bit library. However, the option
230      --enable-utf8 is retained for backwards compatibility with earlier releases
231      that did not support 16-bit or 32-bit character strings. It is synonymous with
232      --enable-utf. It is not possible to configure one library with UTF support
233      and the other without in the same configuration.
234    
235    . If, in addition to support for UTF-8/16/32 character strings, you want to
236      include support for the \P, \p, and \X sequences that recognize Unicode
237      character properties, you must add --enable-unicode-properties to the
238      "configure" command. This adds about 30K to the size of the library (in the
239      form of a property table); only the basic two-letter properties such as Lu
240      are supported.
241    
242  . 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
243    of the preceding, or any of the Unicode newline sequences as indicating the    of the preceding, or any of the Unicode newline sequences as indicating the
# Line 228  library. They are also documented in the Line 269  library. They are also documented in the
269    
270    on the "configure" command.    on the "configure" command.
271    
272  . PCRE has a counter that can be set to limit the amount of resources it uses.  . PCRE has a counter that limits the depth of nesting of parentheses in a
273    If the limit is exceeded during a match, the match fails. The default is ten    pattern. This limits the amount of system stack that a pattern uses when it
274    million. You can change the default by setting, for example,    is compiled. The default is 250, but you can change it by setting, for
275      example,
276    
277      --with-parens-nest-limit=500
278    
279    . PCRE has a counter that can be set to limit the amount of resources it uses
280      when matching a pattern. If the limit is exceeded during a match, the match
281      fails. The default is ten million. You can change the default by setting, for
282      example,
283    
284    --with-match-limit=500000    --with-match-limit=500000
285    
# Line 249  library. They are also documented in the Line 298  library. They are also documented in the
298    sizes in the pcrestack man page.    sizes in the pcrestack man page.
299    
300  . The default maximum compiled pattern size is around 64K. You can increase  . The default maximum compiled pattern size is around 64K. You can increase
301    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
302    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
303    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
304    performance.    the same as --with-link-size=4, which (in both libraries) uses four-byte
305      offsets. Increasing the internal link size reduces performance. In the 32-bit
306      library, the only supported link size is 4.
307    
308  . 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
309    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 281  library. They are also documented in the Line 332  library. They are also documented in the
332    pcre_chartables.c.dist. See "Character tables" below for further information.    pcre_chartables.c.dist. See "Character tables" below for further information.
333    
334  . 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
335    character code (as opposed to ASCII) by specifying    character code (as opposed to ASCII/Unicode) by specifying
336    
337    --enable-ebcdic    --enable-ebcdic
338    
339    This automatically implies --enable-rebuild-chartables (see above). However,    This automatically implies --enable-rebuild-chartables (see above). However,
340    when PCRE is built this way, it always operates in EBCDIC. It cannot support    when PCRE is built this way, it always operates in EBCDIC. It cannot support
341    both EBCDIC and UTF-8.    both EBCDIC and UTF-8/16/32. There is a second option, --enable-ebcdic-nl25,
342      which specifies that the code value for the EBCDIC NL character is 0x25
343  . It is possible to compile pcregrep to use libz and/or libbz2, in order to    instead of the default 0x15.
344    read .gz and .bz2 files (respectively), by specifying one or both of  
345    . In environments where valgrind is installed, if you specify
346    
347      --enable-valgrind
348    
349      PCRE will use valgrind annotations to mark certain memory regions as
350      unaddressable. This allows it to detect invalid memory accesses, and is
351      mostly useful for debugging PCRE itself.
352    
353    . In environments where the gcc compiler is used and lcov version 1.6 or above
354      is installed, if you specify
355    
356      --enable-coverage
357    
358      the build process implements a code coverage report for the test suite. The
359      report is generated by running "make coverage". If ccache is installed on
360      your system, it must be disabled when building PCRE for coverage reporting.
361      You can do this by setting the environment variable CCACHE_DISABLE=1 before
362      running "make" to build PCRE. There is more information about coverage
363      reporting in the "pcrebuild" documentation.
364    
365    . The pcregrep program currently supports only 8-bit data files, and so
366      requires the 8-bit PCRE library. It is possible to compile pcregrep to use
367      libz and/or libbz2, in order to read .gz and .bz2 files (respectively), by
368      specifying one or both of
369    
370    --enable-pcregrep-libz    --enable-pcregrep-libz
371    --enable-pcregrep-libbz2    --enable-pcregrep-libbz2
# Line 305  library. They are also documented in the Line 380  library. They are also documented in the
380    The default value is 20K.    The default value is 20K.
381    
382  . It is possible to compile pcretest so that it links with the libreadline  . It is possible to compile pcretest so that it links with the libreadline
383    library, by specifying    or libedit libraries, by specifying, respectively,
384    
385    --enable-pcretest-libreadline    --enable-pcretest-libreadline or --enable-pcretest-libedit
386    
387    If this is done, when pcretest's input is from a terminal, it reads it using    If this is done, when pcretest's input is from a terminal, it reads it using
388    the readline() function. This provides line-editing and history facilities.    the readline() function. This provides line-editing and history facilities.
389    Note that libreadline is GPL-licenced, so if you distribute a binary of    Note that libreadline is GPL-licenced, so if you distribute a binary of
390    pcretest linked in this way, there may be licensing issues.    pcretest linked in this way, there may be licensing issues. These can be
391      avoided by linking with libedit (which has a BSD licence) instead.
392    
393    Setting this option causes the -lreadline option to be added to the pcretest    Enabling libreadline causes the -lreadline option to be added to the pcretest
394    build. In many operating environments with a sytem-installed readline    build. In many operating environments with a sytem-installed readline
395    library this is sufficient. However, in some environments (e.g. if an    library this is sufficient. However, in some environments (e.g. if an
396    unmodified distribution version of readline is in use), it may be necessary    unmodified distribution version of readline is in use), it may be necessary
# Line 333  The "configure" script builds the follow Line 409  The "configure" script builds the follow
409  . pcre-config          script that shows the building settings such as CFLAGS  . pcre-config          script that shows the building settings such as CFLAGS
410                           that were set for "configure"                           that were set for "configure"
411  . libpcre.pc         ) data for the pkg-config command  . libpcre.pc         ) data for the pkg-config command
412    . libpcre16.pc       )
413    . libpcre32.pc       )
414  . libpcreposix.pc    )  . libpcreposix.pc    )
415  . libtool              script that builds shared and/or static libraries  . libtool              script that builds shared and/or static libraries
 . RunTest              script for running tests on the basic C library  
 . RunGrepTest          script for running tests on the pcregrep command  
416    
417  Versions of config.h and pcre.h are distributed in the PCRE tarballs under the  Versions of config.h and pcre.h are distributed in the PCRE tarballs under the
418  names config.h.generic and pcre.h.generic. These are provided for those who  names config.h.generic and pcre.h.generic. These are provided for those who
419  have to built PCRE without using "configure" or CMake. If you use "configure"  have to built PCRE without using "configure" or CMake. If you use "configure"
420  or CMake, the .generic versions are not used.  or CMake, the .generic versions are not used.
421    
422  If a C++ compiler is found, the following files are also built:  When building the 8-bit library, if a C++ compiler is found, the following
423    files are also built:
424    
425  . libpcrecpp.pc        data for the pkg-config command  . libpcrecpp.pc        data for the pkg-config command
426  . pcrecpparg.h         header file for calling PCRE via the C++ wrapper  . pcrecpparg.h         header file for calling PCRE via the C++ wrapper
# Line 353  The "configure" script also creates conf Line 430  The "configure" script also creates conf
430  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
431  contains compiler output from tests that "configure" runs.  contains compiler output from tests that "configure" runs.
432    
433  Once "configure" has run, you can run "make". It builds two libraries, called  Once "configure" has run, you can run "make". This builds the the libraries
434  libpcre and libpcreposix, a test program called pcretest, and the pcregrep  libpcre, libpcre16 and/or libpcre32, and a test program called pcretest. If you
435  command. If a C++ compiler was found on your system, and you did not disable it  enabled JIT support with --enable-jit, a test program called pcre_jit_test is
436  with --disable-cpp, "make" also builds the C++ wrapper library, which is called  built as well.
437  libpcrecpp, and some test programs called pcrecpp_unittest,  
438  pcre_scanner_unittest, and pcre_stringpiece_unittest. If you enabled JIT  If the 8-bit library is built, libpcreposix and the pcregrep command are also
439  support with --enable-jit, a test program called pcre_jit_test is also built.  built, and if a C++ compiler was found on your system, and you did not disable
440    it with --disable-cpp, "make" builds the C++ wrapper library, which is called
441    libpcrecpp, as well as some test programs called pcrecpp_unittest,
442    pcre_scanner_unittest, and pcre_stringpiece_unittest.
443    
444  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
445  tests are given below in a separate section of this document.  tests are given below in a separate section of this document.
# Line 370  system. The following are installed (fil Line 450  system. The following are installed (fil
450    
451    Commands (bin):    Commands (bin):
452      pcretest      pcretest
453      pcregrep      pcregrep (if 8-bit support is enabled)
454      pcre-config      pcre-config
455    
456    Libraries (lib):    Libraries (lib):
457      libpcre      libpcre16     (if 16-bit support is enabled)
458      libpcreposix      libpcre32     (if 32-bit support is enabled)
459      libpcrecpp (if C++ support is enabled)      libpcre       (if 8-bit support is enabled)
460        libpcreposix  (if 8-bit support is enabled)
461        libpcrecpp    (if 8-bit and C++ support is enabled)
462    
463    Configuration information (lib/pkgconfig):    Configuration information (lib/pkgconfig):
464        libpcre16.pc
465        libpcre32.pc
466      libpcre.pc      libpcre.pc
467      libpcreposix.pc      libpcreposix.pc
468      libpcrecpp.pc (if C++ support is enabled)      libpcrecpp.pc (if C++ support is enabled)
# Line 419  This removes all the files that "make in Line 503  This removes all the files that "make in
503  remove any directories, because these are often shared with other programs.  remove any directories, because these are often shared with other programs.
504    
505    
506  Retrieving configuration information on Unix-like systems  Retrieving configuration information
507  ---------------------------------------------------------  ------------------------------------
508    
509  Running "make install" installs the command pcre-config, which can be used to  Running "make install" installs the command pcre-config, which can be used to
510  recall information about the PCRE configuration and installation. For example:  recall information about the PCRE configuration and installation. For example:
# Line 445  The data is held in *.pc files that are Line 529  The data is held in *.pc files that are
529  <prefix>/lib/pkgconfig.  <prefix>/lib/pkgconfig.
530    
531    
532  Shared libraries on Unix-like systems  Shared libraries
533  -------------------------------------  ----------------
534    
535  The default distribution builds PCRE as shared libraries and static libraries,  The default distribution builds PCRE as shared libraries and static libraries,
536  as long as the operating system supports shared libraries. Shared library  as long as the operating system supports shared libraries. Shared library
# Line 471  Then run "make" in the usual way. Simila Line 555  Then run "make" in the usual way. Simila
555  build only shared libraries.  build only shared libraries.
556    
557    
558  Cross-compiling on Unix-like systems  Cross-compiling using autotools
559  ------------------------------------  -------------------------------
560    
561  You can specify CC and CFLAGS in the normal way to the "configure" command, in  You can specify CC and CFLAGS in the normal way to the "configure" command, in
562  order to cross-compile PCRE for some other host. However, you should NOT  order to cross-compile PCRE for some other host. However, you should NOT
# Line 509  running the "configure" script: Line 593  running the "configure" script:
593    CXXLDFLAGS="-lstd_v2 -lCsup_v2"    CXXLDFLAGS="-lstd_v2 -lCsup_v2"
594    
595    
596    Compiling in Tru64 using native compilers
597    -----------------------------------------
598    
599    The following error may occur when compiling with native compilers in the Tru64
600    operating system:
601    
602      CXX    libpcrecpp_la-pcrecpp.lo
603    cxx: Error: /usr/lib/cmplrs/cxx/V7.1-006/include/cxx/iosfwd, line 58: #error
604              directive: "cannot include iosfwd -- define __USE_STD_IOSTREAM to
605              override default - see section 7.1.2 of the C++ Using Guide"
606    #error "cannot include iosfwd -- define __USE_STD_IOSTREAM to override default
607    - see section 7.1.2 of the C++ Using Guide"
608    
609    This may be followed by other errors, complaining that 'namespace "std" has no
610    member'. The solution to this is to add the line
611    
612    #define __USE_STD_IOSTREAM 1
613    
614    to the config.h file.
615    
616    
617  Using Sun's compilers for Solaris  Using Sun's compilers for Solaris
618  ---------------------------------  ---------------------------------
619    
# Line 544  script creates the .txt and HTML forms o Line 649  script creates the .txt and HTML forms o
649  Testing PCRE  Testing PCRE
650  ------------  ------------
651    
652  To test the basic PCRE library on a Unix system, run the RunTest script that is  To test the basic PCRE library on a Unix-like system, run the RunTest script.
653  created by the configuring process. There is also a script called RunGrepTest  There is another script called RunGrepTest that tests the options of the
654  that tests the options of the pcregrep command. If the C++ wrapper library is  pcregrep command. If the C++ wrapper library is built, three test programs
655  built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and  called pcrecpp_unittest, pcre_scanner_unittest, and pcre_stringpiece_unittest
656  pcre_stringpiece_unittest are also built. When JIT support is enabled, another  are also built. When JIT support is enabled, another test program called
657  test program called pcre_jit_test is built.  pcre_jit_test is built.
658    
659  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
660  "make test". For other systems, see the instructions in NON-UNIX-USE.  "make test". For other environments, see the instructions in
661    NON-AUTOTOOLS-BUILD.
662    
663  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
664  own man page) on each of the relevant testinput files in the testdata  own man page) on each of the relevant testinput files in the testdata
665  directory, and compares the output with the contents of the corresponding  directory, and compares the output with the contents of the corresponding
666  testoutput files. Some tests are relevant only when certain build-time options  testoutput files. RunTest uses a file called testtry to hold the main output
667  were selected. For example, the tests for UTF-8 support are run only if  from pcretest. Other files whose names begin with "test" are used as working
668  --enable-utf8 was used. RunTest outputs a comment when it skips a test.  files in some tests.
669    
670    Some tests are relevant only when certain build-time options were selected. For
671    example, the tests for UTF-8/16/32 support are run only if --enable-utf was
672    used. RunTest outputs a comment when it skips a test.
673    
674  Many of the tests that are not skipped are run up to three times. The second  Many of the tests that are not skipped are run up to three times. The second
675  run forces pcre_study() to be called for all patterns except for a few in some  run forces pcre_study() to be called for all patterns except for a few in some
676  tests that are marked "never study" (see the pcretest program for how this is  tests that are marked "never study" (see the pcretest program for how this is
677  done). If JIT support is available, the non-DFA tests are run a third time,  done). If JIT support is available, the non-DFA tests are run a third time,
678  this time with a forced pcre_study() with the PCRE_STUDY_JIT_COMPILE option.  this time with a forced pcre_study() with the PCRE_STUDY_JIT_COMPILE option.
679    This testing can be suppressed by putting "nojit" on the RunTest command line.
680    
681    The entire set of tests is run once for each of the 8-bit, 16-bit and 32-bit
682    libraries that are enabled. If you want to run just one set of tests, call
683    RunTest with either the -8, -16 or -32 option.
684    
685    If valgrind is installed, you can run the tests under it by putting "valgrind"
686    on the RunTest command line. To run pcretest on just one or more specific test
687    files, give their numbers as arguments to RunTest, for example:
688    
689  RunTest uses a file called testtry to hold the main output from pcretest    RunTest 2 7 11
 (testsavedregex is also used as a working file). To run pcretest on just one of  
 the test files, give its number as an argument to RunTest, for example:  
690    
691    RunTest 2  You can also specify ranges of tests such as 3-6 or 3- (meaning 3 to the
692    end), or a number preceded by ~ to exclude a test. For example:
693    
694      Runtest 3-15 ~10
695    
696    This runs tests 3 to 15, excluding test 10, and just ~13 runs all the tests
697    except test 13. Whatever order the arguments are in, the tests are always run
698    in numerical order.
699    
700    You can also call RunTest with the single argument "list" to cause it to output
701    a list of tests.
702    
703  The first test file can be fed directly into the perltest.pl script to check  The first test file can be fed directly into the perltest.pl script to check
704  that Perl gives the same results. The only difference you should see is in the  that Perl gives the same results. The only difference you should see is in the
705  first few lines, where the Perl version is given instead of the PCRE version.  first few lines, where the Perl version is given instead of the PCRE version.
706    
707  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),  The second set of tests check pcre_fullinfo(), pcre_study(),
708  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
709  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
710  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 612  RunTest.bat. The version of RunTest.bat Line 739  RunTest.bat. The version of RunTest.bat
739  Windows versions of test 2. More info on using RunTest.bat is included in the  Windows versions of test 2. More info on using RunTest.bat is included in the
740  document entitled NON-UNIX-USE.]  document entitled NON-UNIX-USE.]
741    
742  The fourth test checks the UTF-8 support. This file can be also fed directly to  The fourth and fifth tests check the UTF-8/16/32 support and error handling and
743  the perltest.pl script, provided you are running Perl 5.8 or higher.  internal UTF features of PCRE that are not relevant to Perl, respectively. The
744    sixth and seventh tests do the same for Unicode character properties support.
745    
746    The eighth, ninth, and tenth tests check the pcre_dfa_exec() alternative
747    matching function, in non-UTF-8/16/32 mode, UTF-8/16/32 mode, and UTF-8/16/32
748    mode with Unicode property support, respectively.
749    
750  The fifth test checks error handling with UTF-8 encoding, and internal UTF-8  The eleventh test checks some internal offsets and code size features; it is
751  features of PCRE that are not relevant to Perl.  run only when the default "link size" of 2 is set (in other cases the sizes
752    change) and when Unicode property support is enabled.
753    
754  The sixth test (which is Perl-5.10 compatible) checks the support for Unicode  The twelfth test is run only when JIT support is available, and the thirteenth
755  character properties. This file can be also fed directly to the perltest.pl  test is run only when JIT support is not available. They test some JIT-specific
756  script, provided you are running Perl 5.10 or higher.  features such as information output from pcretest about JIT compilation.
757    
758  The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative  The fourteenth, fifteenth, and sixteenth tests are run only in 8-bit mode, and
759  matching function, in non-UTF-8 mode, UTF-8 mode, and UTF-8 mode with Unicode  the seventeenth, eighteenth, and nineteenth tests are run only in 16/32-bit
760  property support, respectively.  mode. These are tests that generate different output in the two modes. They are
761    for general cases, UTF-8/16/32 support, and Unicode property support,
762    respectively.
763    
764    The twentieth test is run only in 16/32-bit mode. It tests some specific
765    16/32-bit features of the DFA matching engine.
766    
767    The twenty-first and twenty-second tests are run only in 16/32-bit mode, when
768    the link size is set to 2 for the 16-bit library. They test reloading
769    pre-compiled patterns.
770    
771  The tenth test checks some internal offsets and code size features; it is run  The twenty-third and twenty-fourth tests are run only in 16-bit mode. They are
772  only when the default "link size" of 2 is set (in other cases the sizes  for general cases, and UTF-16 support, respectively.
 change) and when Unicode property support is enabled.  
773    
774  The eleventh and twelfth tests check out features that are new in Perl 5.10,  The twenty-fifth and twenty-sixth tests are run only in 32-bit mode. They are
775  without and with UTF-8 support, respectively. This file can be also fed  for general cases, and UTF-32 support, respectively.
 directly to the perltest.pl script, provided you are running Perl 5.10 or  
 higher.  
   
 The thirteenth test checks a number internals and non-Perl features concerned  
 with Unicode property support.  
   
 The fourteenth test is run only when JIT support is available, and the  
 fifteenth test is run only when JIT support is not available. They test some  
 JIT-specific features such as information output from pcretest about JIT  
 compilation.  
776    
777    
778  Character tables  Character tables
# Line 701  will cause PCRE to malfunction. Line 832  will cause PCRE to malfunction.
832  File manifest  File manifest
833  -------------  -------------
834    
835  The distribution should contain the following files:  The distribution should contain the files listed below. Where a file name is
836    given as pcre[16|32]_xxx it means that there are three files, one with the name
837    pcre_xxx, one with the name pcre16_xx, and a third with the name pcre32_xxx.
838    
839  (A) Source files of the PCRE library functions and their headers:  (A) Source files of the PCRE library functions and their headers:
840    
841    dftables.c              auxiliary program for building pcre_chartables.c    dftables.c              auxiliary program for building pcre_chartables.c
842                              when --enable-rebuild-chartables is specified                            when --enable-rebuild-chartables is specified
843    
844    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
845                              coding; used, unless --enable-rebuild-chartables is                            coding; used, unless --enable-rebuild-chartables is
846                              specified, by copying to pcre_chartables.c                            specified, by copying to pcre[16]_chartables.c
847    
848      pcreposix.c                )
849      pcre[16|32]_byte_order.c   )
850      pcre[16|32]_compile.c      )
851      pcre[16|32]_config.c       )
852      pcre[16|32]_dfa_exec.c     )
853      pcre[16|32]_exec.c         )
854      pcre[16|32]_fullinfo.c     )
855      pcre[16|32]_get.c          ) sources for the functions in the library,
856      pcre[16|32]_globals.c      )   and some internal functions that they use
857      pcre[16|32]_jit_compile.c  )
858      pcre[16|32]_maketables.c   )
859      pcre[16|32]_newline.c      )
860      pcre[16|32]_refcount.c     )
861      pcre[16|32]_string_utils.c )
862      pcre[16|32]_study.c        )
863      pcre[16|32]_tables.c       )
864      pcre[16|32]_ucd.c          )
865      pcre[16|32]_version.c      )
866      pcre[16|32]_xclass.c       )
867      pcre_ord2utf8.c            )
868      pcre_valid_utf8.c          )
869      pcre16_ord2utf16.c         )
870      pcre16_utf16_utils.c       )
871      pcre16_valid_utf16.c       )
872      pcre32_utf32_utils.c       )
873      pcre32_valid_utf32.c       )
874    
875      pcre[16|32]_printint.c     ) debugging function that is used by pcretest,
876                                 )   and can also be #included in pcre_compile()
877    
   pcreposix.c             )  
   pcre_byte_order.c       )  
   pcre_compile.c          )  
   pcre_config.c           )  
   pcre_dfa_exec.c         )  
   pcre_exec.c             )  
   pcre_fullinfo.c         )  
   pcre_get.c              ) sources for the functions in the library,  
   pcre_globals.c          )   and some internal functions that they use  
   pcre_info.c             )  
   pcre_jit_compile.c      )  
   pcre_maketables.c       )  
   pcre_newline.c          )  
   pcre_ord2utf8.c         )  
   pcre_refcount.c         )  
   pcre_study.c            )  
   pcre_tables.c           )  
   pcre_ucd.c              )  
   pcre_valid_utf8.c       )  
   pcre_version.c          )  
   pcre_xclass.c           )  
   pcre_printint.src       ) debugging function that is #included in pcretest,  
                           )   and can also be #included in pcre_compile()  
878    pcre.h.in               template for pcre.h when built by "configure"    pcre.h.in               template for pcre.h when built by "configure"
879    pcreposix.h             header for the external POSIX wrapper API    pcreposix.h             header for the external POSIX wrapper API
880    pcre_internal.h         header for internal use    pcre_internal.h         header for internal use
# Line 775  The distribution should contain the foll Line 915  The distribution should contain the foll
915    Makefile.am             ) the automake input that was used to create    Makefile.am             ) the automake input that was used to create
916                            )   Makefile.in                            )   Makefile.in
917    NEWS                    important changes in this release    NEWS                    important changes in this release
918    NON-UNIX-USE            notes on building PCRE on non-Unix systems    NON-UNIX-USE            the previous name for NON-AUTOTOOLS-BUILD
919      NON-AUTOTOOLS-BUILD     notes on building PCRE without using autotools
920    PrepareRelease          script to make preparations for "make dist"    PrepareRelease          script to make preparations for "make dist"
921    README                  this file    README                  this file
922    RunTest                 a Unix shell script for running tests    RunTest                 a Unix shell script for running tests
# Line 796  The distribution should contain the foll Line 937  The distribution should contain the foll
937    doc/pcretest.txt        plain text documentation of test program    doc/pcretest.txt        plain text documentation of test program
938    doc/perltest.txt        plain text documentation of Perl test program    doc/perltest.txt        plain text documentation of Perl test program
939    install-sh              a shell script for installing files    install-sh              a shell script for installing files
940      libpcre16.pc.in         template for libpcre16.pc for pkg-config
941      libpcre32.pc.in         template for libpcre32.pc for pkg-config
942    libpcre.pc.in           template for libpcre.pc for pkg-config    libpcre.pc.in           template for libpcre.pc for pkg-config
943    libpcreposix.pc.in      template for libpcreposix.pc for pkg-config    libpcreposix.pc.in      template for libpcreposix.pc for pkg-config
944    libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config    libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config
# Line 812  The distribution should contain the foll Line 955  The distribution should contain the foll
955    testdata/testinput*     test data for main library tests    testdata/testinput*     test data for main library tests
956    testdata/testoutput*    expected test results    testdata/testoutput*    expected test results
957    testdata/grep*          input and output for pcregrep tests    testdata/grep*          input and output for pcregrep tests
958      testdata/*              other supporting test files
959    
960  (D) Auxiliary files for cmake support  (D) Auxiliary files for cmake support
961    
962    cmake/COPYING-CMAKE-SCRIPTS    cmake/COPYING-CMAKE-SCRIPTS
963    cmake/FindPackageHandleStandardArgs.cmake    cmake/FindPackageHandleStandardArgs.cmake
964      cmake/FindEditline.cmake
965    cmake/FindReadline.cmake    cmake/FindReadline.cmake
966    CMakeLists.txt    CMakeLists.txt
967    config-cmake.h.in    config-cmake.h.in
# Line 842  The distribution should contain the foll Line 987  The distribution should contain the foll
987  Philip Hazel  Philip Hazel
988  Email local part: ph10  Email local part: ph10
989  Email domain: cam.ac.uk  Email domain: cam.ac.uk
990  Last updated: 06 September 2011  Last updated: 05 November 2013

Legend:
Removed from v.836  
changed lines
  Added in v.1404

  ViewVC Help
Powered by ViewVC 1.1.5