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

Diff of /code/trunk/README

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

revision 127 by ph10, Mon Mar 19 11:44:45 2007 UTC revision 836 by ph10, Wed Dec 28 17:16:11 2011 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 now includes a  PCRE is written in C, and it has its own API. The distribution also includes a
38  set of C++ wrapper functions, courtesy of Google Inc. (see the pcrecpp man page  set of C++ wrapper functions (see the pcrecpp man page for details), courtesy
39  for details).  of Google Inc.
40    
41  Also included in the distribution are a set of C wrapper functions that are  In addition, there is a set of C wrapper functions that are based on the POSIX
42  based on the POSIX API. These end up in the library called libpcreposix. Note  regular expression API (see the pcreposix man page). These end up in the
43  that this just provides a POSIX calling interface to PCRE; the regular  library called libpcreposix. Note that this just provides a POSIX calling
44  expressions themselves still follow Perl syntax and semantics. The POSIX API is  interface to PCRE; the regular expressions themselves still follow Perl syntax
45  restricted, and does not give full access to all of PCRE's facilities.  and semantics. The POSIX API is restricted, and does not give full access to
46    all of PCRE's facilities.
47    
48  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
49  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 81  documentation is supplied in two other f Line 86  documentation is supplied in two other f
86       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
87       doc/html and installed in <prefix>/share/doc/pcre/html.       doc/html and installed in <prefix>/share/doc/pcre/html.
88    
89    Users of PCRE have contributed files containing the documentation for various
90    releases in CHM format. These can be found in the Contrib directory of the FTP
91    site (see next section).
92    
93    
94  Contributions by users of PCRE  Contributions by users of PCRE
95  ------------------------------  ------------------------------
# Line 91  You can find contributions from PCRE use Line 100  You can find contributions from PCRE use
100    
101  There is a README file giving brief descriptions of what they are. Some are  There is a README file giving brief descriptions of what they are. Some are
102  complete in themselves; others are pointers to URLs containing relevant files.  complete in themselves; others are pointers to URLs containing relevant files.
103  Some of this material is likely to be well out-of-date. In particular, several  Some of this material is likely to be well out-of-date. Several of the earlier
104  of the contributions provide support for compiling PCRE on various flavours of  contributions provided support for compiling PCRE on various flavours of
105  Windows (I myself do not use Windows), but nowadays there is more Windows  Windows (I myself do not use Windows). Nowadays there is more Windows support
106  support in the standard distribution.  in the standard distribution, so these contibutions have been archived.
107    
108    
109  Building PCRE on non-Unix systems  Building PCRE on non-Unix systems
# Line 102  Building PCRE on non-Unix systems Line 111  Building PCRE on non-Unix systems
111    
112  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,
113  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
114  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
115    configured in many platform environments using the GUI facility provided by
116    CMake's cmake-gui command. This creates Makefiles, solution files, etc.
117    
118  PCRE has been compiled on many different operating systems. It should be  PCRE has been compiled on many different operating systems. It should be
119  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 115  Building PCRE on Unix-like systems Line 126  Building PCRE on Unix-like systems
126  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
127  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.
128    
129    The following instructions assume the use of the widely used "configure, make,
130    make install" process. There is also support for CMake in the PCRE
131    distribution; there are some comments about using CMake in the NON-UNIX-USE
132    file, though it can also be used in Unix-like systems.
133    
134  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
135  PCRE distribution directory, with your current directory set to the directory  PCRE distribution directory, with your current directory set to the directory
136  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 143  possible to build it as a C++ library, t Line 159  possible to build it as a C++ library, t
159  does not have any features to support this.  does not have any features to support this.
160    
161  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
162  library. You can read more about them in the pcrebuild man page.  library. They are also documented in the pcrebuild man page.
163    
164    . By default, both shared and static libraries are built. You can change this
165      by adding one of these options to the "configure" command:
166    
167      --disable-shared
168      --disable-static
169    
170      (See also "Shared libraries on Unix-like systems" below.)
171    
172  . If you want to suppress the building of the C++ wrapper library, you can add  . If you want to suppress the building of the C++ wrapper library, you can add
173    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,
174    will try to find a C++ compiler and C++ header files, and if it succeeds, it    it will try to find a C++ compiler and C++ header files, and if it succeeds,
175    will try to build the C++ wrapper.    it will try to build the C++ wrapper.
176    
177  . If you want to make use of the support for UTF-8 character strings in PCRE,  . If you want to include support for just-in-time compiling, which can give
178    you must add --enable-utf8 to the "configure" command. Without it, the code    large performance improvements on certain platforms, add --enable-jit to the
179    for handling UTF-8 is not included in the library. (Even when included, it    "configure" command. This support is available only for certain hardware
180    still has to be enabled by an option at run time.)    architectures. If you try to enable it on an unsupported architecture, there
181      will be a compile time error.
182    
183    . When JIT support is enabled, pcregrep automatically makes use of it, unless
184      you add --disable-pcregrep-jit to the "configure" command.
185    
186    . If you want to make use of the support for UTF-8 Unicode character strings in
187      PCRE, you must add --enable-utf8 to the "configure" command. Without it, the
188      code for handling UTF-8 is not included in the library. Even when included,
189      it still has to be enabled by an option at run time. When PCRE is compiled
190      with this option, its input can only either be ASCII or UTF-8, even when
191      running on EBCDIC platforms. It is not possible to use both --enable-utf8 and
192      --enable-ebcdic at the same time.
193    
194  . If, in addition to support for UTF-8 character strings, you want to include  . If, in addition to support for UTF-8 character strings, you want to include
195    support for the \P, \p, and \X sequences that recognize Unicode character    support for the \P, \p, and \X sequences that recognize Unicode character
# Line 163  library. You can read more about them in Line 199  library. You can read more about them in
199    supported.    supported.
200    
201  . 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
202    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
203    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
204    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
205    (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
206    --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
207    to the "configure" command, respectively.    or --enable-newline-is-crlf or --enable-newline-is-anycrlf or
208      --enable-newline-is-any to the "configure" command, respectively.
209    If you specify --newline-is-cr or --newline-is-crlf, some of the standard  
210    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
211    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
212    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
213    some failures.    to be some failures. With --enable-newline-is-anycrlf or
214      --enable-newline-is-any, many tests should succeed, but there may be some
215      failures.
216    
217    . By default, the sequence \R in a pattern matches any Unicode line ending
218      sequence. This is independent of the option specifying what PCRE considers to
219      be the end of a line (see above). However, the caller of PCRE can restrict \R
220      to match only CR, LF, or CRLF. You can make this the default by adding
221      --enable-bsr-anycrlf to the "configure" command (bsr = "backslash R").
222    
223  . When called via the POSIX interface, PCRE uses malloc() to get additional  . When called via the POSIX interface, PCRE uses malloc() to get additional
224    storage for processing capturing parentheses if there are more than 10 of    storage for processing capturing parentheses if there are more than 10 of
225    them. You can increase this threshold by setting, for example,    them in a pattern. You can increase this threshold by setting, for example,
226    
227    --with-posix-malloc-threshold=20    --with-posix-malloc-threshold=20
228    
# Line 207  library. You can read more about them in Line 251  library. You can read more about them in
251  . The default maximum compiled pattern size is around 64K. You can increase  . The default maximum compiled pattern size is around 64K. You can increase
252    this by adding --with-link-size=3 to the "configure" command. You can    this by adding --with-link-size=3 to the "configure" command. You can
253    increase it even more by setting --with-link-size=4, but this is unlikely    increase it even more by setting --with-link-size=4, but this is unlikely
254    ever to be necessary.    ever to be necessary. Increasing the internal link size will reduce
255      performance.
256    
257  . 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
258    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 219  library. You can read more about them in Line 264  library. You can read more about them in
264    
265    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
266    necessary in environments with limited stack sizes. This applies only to the    necessary in environments with limited stack sizes. This applies only to the
267    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
268    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
269    pcrestack man page.    pcre_dfa_exec(), which does not use deeply nested recursion. There is a
270      discussion about stack sizes in the pcrestack man page.
271    
272    . For speed, PCRE uses four tables for manipulating and identifying characters
273      whose code point values are less than 256. By default, it uses a set of
274      tables for ASCII encoding that is part of the distribution. If you specify
275    
276      --enable-rebuild-chartables
277    
278      a program called dftables is compiled and run in the default C locale when
279      you obey "make". It builds a source file called pcre_chartables.c. If you do
280      not specify this option, pcre_chartables.c is created as a copy of
281      pcre_chartables.c.dist. See "Character tables" below for further information.
282    
283    . It is possible to compile PCRE for use on systems that use EBCDIC as their
284      character code (as opposed to ASCII) by specifying
285    
286      --enable-ebcdic
287    
288      This automatically implies --enable-rebuild-chartables (see above). However,
289      when PCRE is built this way, it always operates in EBCDIC. It cannot support
290      both EBCDIC and UTF-8.
291    
292    . It is possible to compile pcregrep to use libz and/or libbz2, in order to
293      read .gz and .bz2 files (respectively), by specifying one or both of
294    
295      --enable-pcregrep-libz
296      --enable-pcregrep-libbz2
297    
298      Of course, the relevant libraries must be installed on your system.
299    
300    . The default size of internal buffer used by pcregrep can be set by, for
301      example:
302    
303      --with-pcregrep-bufsize=50K
304    
305      The default value is 20K.
306    
307    . It is possible to compile pcretest so that it links with the libreadline
308      library, by specifying
309    
310      --enable-pcretest-libreadline
311    
312      If this is done, when pcretest's input is from a terminal, it reads it using
313      the readline() function. This provides line-editing and history facilities.
314      Note that libreadline is GPL-licenced, so if you distribute a binary of
315      pcretest linked in this way, there may be licensing issues.
316    
317      Setting this option causes the -lreadline option to be added to the pcretest
318      build. In many operating environments with a sytem-installed readline
319      library this is sufficient. However, in some environments (e.g. if an
320      unmodified distribution version of readline is in use), it may be necessary
321      to specify something like LIBS="-lncurses" as well. This is because, to quote
322      the readline INSTALL, "Readline uses the termcap functions, but does not link
323      with the termcap or curses library itself, allowing applications which link
324      with readline the to choose an appropriate library." If you get error
325      messages about missing functions tgetstr, tgetent, tputs, tgetflag, or tgoto,
326      this is the problem, and linking with the ncurses library should fix it.
327    
328  The "configure" script builds the following files for the basic C library:  The "configure" script builds the following files for the basic C library:
329    
330  . Makefile is the makefile that builds the library  . Makefile             the makefile that builds the library
331  . config.h contains build-time configuration options for the library  . config.h             build-time configuration options for the library
332  . pcre.h is the public PCRE header file  . pcre.h               the public PCRE header file
333  . pcre-config is a script that shows the settings of "configure" options  . pcre-config          script that shows the building settings such as CFLAGS
334  . libpcre.pc is data for the pkg-config command                           that were set for "configure"
335  . libtool is a script that builds shared and/or static libraries  . libpcre.pc         ) data for the pkg-config command
336  . RunTest is a script for running tests on the basic C library  . libpcreposix.pc    )
337  . RunGrepTest is a script for running tests on the pcregrep command  . libtool              script that builds shared and/or static libraries
338    . RunTest              script for running tests on the basic C library
339  Versions of config.h and pcre.h are distributed in the PCRE tarballs under  . RunGrepTest          script for running tests on the pcregrep command
340  the names config.h.generic and pcre.h.generic. These are provided for the  
341  benefit of those who have to built PCRE without the benefit of "configure". If  Versions of config.h and pcre.h are distributed in the PCRE tarballs under the
342  you use "configure", the .generic versions are not used.  names config.h.generic and pcre.h.generic. These are provided for those who
343    have to built PCRE without using "configure" or CMake. If you use "configure"
344    or CMake, the .generic versions are not used.
345    
346  If a C++ compiler is found, the following files are also built:  If a C++ compiler is found, the following files are also built:
347    
348  . libpcrecpp.pc is data for the pkg-config command  . libpcrecpp.pc        data for the pkg-config command
349  . pcrecpparg.h is a header file for programs that call PCRE via the C++ wrapper  . pcrecpparg.h         header file for calling PCRE via the C++ wrapper
350  . pcre_stringpiece.h is the header for the C++ "stringpiece" functions  . pcre_stringpiece.h   header for the C++ "stringpiece" functions
351    
352  The "configure" script also creates config.status, which is an executable  The "configure" script also creates config.status, which is an executable
353  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
354  contains compiler output from tests that "configure" runs.  contains compiler output from tests that "configure" runs.
355    
356  Once "configure" has run, you can run "make". It builds two libraries, called  Once "configure" has run, you can run "make". It builds two libraries, called
357  libpcre and libpcreposix, a test program called pcretest, a demonstration  libpcre and libpcreposix, a test program called pcretest, and the pcregrep
358  program called pcredemo, and the pcregrep command. If a C++ compiler was found  command. If a C++ compiler was found on your system, and you did not disable it
359  on your system, "make" also builds the C++ wrapper library, which is called  with --disable-cpp, "make" also builds the C++ wrapper library, which is called
360  libpcrecpp, and some test programs called pcrecpp_unittest,  libpcrecpp, and some test programs called pcrecpp_unittest,
361  pcre_scanner_unittest, and pcre_stringpiece_unittest. Building the C++ wrapper  pcre_scanner_unittest, and pcre_stringpiece_unittest. If you enabled JIT
362  can be disabled by adding --disable-cpp to the "configure" command.  support with --enable-jit, a test program called pcre_jit_test is also built.
363    
364  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
365  tests are given below in a separate section of this document.  tests are given below in a separate section of this document.
# Line 276  system. The following are installed (fil Line 380  system. The following are installed (fil
380    
381    Configuration information (lib/pkgconfig):    Configuration information (lib/pkgconfig):
382      libpcre.pc      libpcre.pc
383        libpcreposix.pc
384      libpcrecpp.pc (if C++ support is enabled)      libpcrecpp.pc (if C++ support is enabled)
385    
386    Header files (include):    Header files (include):
# Line 289  system. The following are installed (fil Line 394  system. The following are installed (fil
394    Man pages (share/man/man{1,3}):    Man pages (share/man/man{1,3}):
395      pcregrep.1      pcregrep.1
396      pcretest.1      pcretest.1
397        pcre-config.1
398      pcre.3      pcre.3
399      pcre*.3 (lots more pages, all starting "pcre")      pcre*.3 (lots more pages, all starting "pcre")
400    
# Line 303  system. The following are installed (fil Line 409  system. The following are installed (fil
409      LICENCE      LICENCE
410      NEWS      NEWS
411      README      README
412      pcre.txt       (a concatenation of the man(3) pages)      pcre.txt         (a concatenation of the man(3) pages)
413      pcretest.txt   the pcretest man page      pcretest.txt     the pcretest man page
414      pcregrep.txt   the pcregrep man page      pcregrep.txt     the pcregrep man page
415        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.  
416    
417  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".
418  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 371  Cross-compiling on Unix-like systems Line 475  Cross-compiling on Unix-like systems
475  ------------------------------------  ------------------------------------
476    
477  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
478  order to cross-compile PCRE for some other host. However, during the building  order to cross-compile PCRE for some other host. However, you should NOT
479  process, the dftables.c source file is compiled *and run* on the local host, in  specify --enable-rebuild-chartables, because if you do, the dftables.c source
480  order to generate the default character tables (the chartables.c file). It  file is compiled and run on the local host, in order to generate the inbuilt
481  therefore needs to be compiled with the local compiler, not the cross compiler.  character tables (the pcre_chartables.c file). This will probably not work,
482  You can do this by specifying CC_FOR_BUILD (and if necessary CFLAGS_FOR_BUILD;  because dftables.c needs to be compiled with the local compiler, not the cross
483  there are also CXX_FOR_BUILD and CXXFLAGS_FOR_BUILD for the C++ wrapper)  compiler.
484  when calling the "configure" command. If they are not specified, they default  
485  to the values of CC and CFLAGS.  When --enable-rebuild-chartables is not specified, pcre_chartables.c is created
486    by making a copy of pcre_chartables.c.dist, which is a default set of tables
487    that assumes ASCII code. Cross-compiling with the default tables should not be
488    a problem.
489    
490    If you need to modify the character tables when cross-compiling, you should
491    move pcre_chartables.c.dist out of the way, then compile dftables.c by hand and
492    run it on the local host to make a new version of pcre_chartables.c.dist.
493    Then when you cross-compile PCRE this new version of the tables will be used.
494    
495    
496  Using HP's ANSI C++ compiler (aCC)  Using HP's ANSI C++ compiler (aCC)
# Line 397  running the "configure" script: Line 509  running the "configure" script:
509    CXXLDFLAGS="-lstd_v2 -lCsup_v2"    CXXLDFLAGS="-lstd_v2 -lCsup_v2"
510    
511    
512    Using Sun's compilers for Solaris
513    ---------------------------------
514    
515    A user reports that the following configurations work on Solaris 9 sparcv9 and
516    Solaris 9 x86 (32-bit):
517    
518      Solaris 9 sparcv9: ./configure --disable-cpp CC=/bin/cc CFLAGS="-m64 -g"
519      Solaris 9 x86:     ./configure --disable-cpp CC=/bin/cc CFLAGS="-g"
520    
521    
522    Using PCRE from MySQL
523    ---------------------
524    
525    On systems where both PCRE and MySQL are installed, it is possible to make use
526    of PCRE from within MySQL, as an alternative to the built-in pattern matching.
527    There is a web page that tells you how to do this:
528    
529      http://www.mysqludf.org/lib_mysqludf_preg/index.php
530    
531    
532  Making new tarballs  Making new tarballs
533  -------------------  -------------------
534    
535  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
536  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
537  doc directory, you should first run the PrepareRelease script. This re-creates  build of the new distribution to ensure that it works.
538  the .txt and HTML forms of the documentation from the man pages.  
539    If you have modified any of the man page sources in the doc directory, you
540    should first run the PrepareRelease script before making a distribution. This
541    script creates the .txt and HTML forms of the documentation from the man pages.
542    
543    
544  Testing PCRE  Testing PCRE
# Line 413  To test the basic PCRE library on a Unix Line 548  To test the basic PCRE library on a Unix
548  created by the configuring process. There is also a script called RunGrepTest  created by the configuring process. There is also a script called RunGrepTest
549  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
550  built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and  built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and
551  pcre_stringpiece_unittest are also built.  pcre_stringpiece_unittest are also built. When JIT support is enabled, another
552    test program called pcre_jit_test is built.
553    
554  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
555  "make test". For other systems, see the instructions in NON-UNIX-USE.  "make test". For other systems, see the instructions in NON-UNIX-USE.
556    
557  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
558  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
559  turn, and compares the output with the contents of the corresponding testoutput  directory, and compares the output with the contents of the corresponding
560  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
561    were selected. For example, the tests for UTF-8 support are run only if
562    --enable-utf8 was used. RunTest outputs a comment when it skips a test.
563    
564    Many of the tests that are not skipped are run up to three times. The second
565    run forces pcre_study() to be called for all patterns except for a few in some
566    tests that are marked "never study" (see the pcretest program for how this is
567    done). If JIT support is available, the non-DFA tests are run a third time,
568    this time with a forced pcre_study() with the PCRE_STUDY_JIT_COMPILE option.
569    
570    RunTest uses a file called testtry to hold the main output from pcretest
571  (testsavedregex is also used as a working file). To run pcretest on just one of  (testsavedregex is also used as a working file). To run pcretest on just one of
572  the test files, give its number as an argument to RunTest, for example:  the test files, give its number as an argument to RunTest, for example:
573    
574    RunTest 2    RunTest 2
575    
576  The first test file can also be fed directly into the perltest.pl script to  The first test file can be fed directly into the perltest.pl script to check
577  check that Perl gives the same results. The only difference you should see is  that Perl gives the same results. The only difference you should see is in the
578  in the first few lines, where the Perl version is given instead of the PCRE  first few lines, where the Perl version is given instead of the PCRE version.
 version.  
579    
580  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),
581  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
# Line 461  is output to say why. If running this te Line 606  is output to say why. If running this te
606  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,
607  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.
608    
609  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
610  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
611  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
612  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
613  commented in the script, can be be used.)  document entitled NON-UNIX-USE.]
614    
615    The fourth test checks the UTF-8 support. This file can be also fed directly to
616    the perltest.pl script, provided you are running Perl 5.8 or higher.
617    
618  The fifth test checks error handling with UTF-8 encoding, and internal UTF-8  The fifth test checks error handling with UTF-8 encoding, and internal UTF-8
619  features of PCRE that are not relevant to Perl.  features of PCRE that are not relevant to Perl.
620    
621  The sixth test checks the support for Unicode character properties. It it not  The sixth test (which is Perl-5.10 compatible) checks the support for Unicode
622  run automatically unless PCRE is built with Unicode property support. To to  character properties. This file can be also fed directly to the perltest.pl
623  this you must set --enable-unicode-properties when running "configure".  script, provided you are running Perl 5.10 or higher.
624    
625  The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative  The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative
626  matching function, in non-UTF-8 mode, UTF-8 mode, and UTF-8 mode with Unicode  matching function, in non-UTF-8 mode, UTF-8 mode, and UTF-8 mode with Unicode
627  property support, respectively. The eighth and ninth tests are not run  property support, respectively.
628  automatically unless PCRE is build with the relevant support.  
629    The tenth test checks some internal offsets and code size features; it is run
630    only when the default "link size" of 2 is set (in other cases the sizes
631    change) and when Unicode property support is enabled.
632    
633    The eleventh and twelfth tests check out features that are new in Perl 5.10,
634    without and with UTF-8 support, respectively. This file can be also fed
635    directly to the perltest.pl script, provided you are running Perl 5.10 or
636    higher.
637    
638    The thirteenth test checks a number internals and non-Perl features concerned
639    with Unicode property support.
640    
641    The fourteenth test is run only when JIT support is available, and the
642    fifteenth test is run only when JIT support is not available. They test some
643    JIT-specific features such as information output from pcretest about JIT
644    compilation.
645    
646    
647  Character tables  Character tables
# Line 490  concatenated tables. A call to pcre_make Line 654  concatenated tables. A call to pcre_make
654  of tables in the current locale. If the final argument for pcre_compile() is  of tables in the current locale. If the final argument for pcre_compile() is
655  passed as NULL, a set of default tables that is built into the binary is used.  passed as NULL, a set of default tables that is built into the binary is used.
656    
657  The source file called chartables.c contains the default set of tables. This is  The source file called pcre_chartables.c contains the default set of tables. By
658  not supplied in the distribution, but is built by the program dftables  default, this is created as a copy of pcre_chartables.c.dist, which contains
659  (compiled from dftables.c), which uses the ANSI C character handling functions  tables for ASCII coding. However, if --enable-rebuild-chartables is specified
660  such as isalnum(), isalpha(), isupper(), islower(), etc. to build the table  for ./configure, a different version of pcre_chartables.c is built by the
661  sources. This means that the default C locale which is set for your system will  program dftables (compiled from dftables.c), which uses the ANSI C character
662  control the contents of these default tables. You can change the default tables  handling functions such as isalnum(), isalpha(), isupper(), islower(), etc. to
663  by editing chartables.c and then re-building PCRE. If you do this, you should  build the table sources. This means that the default C locale which is set for
664  take care to ensure that the file does not get automaticaly re-generated.  your system will control the contents of these default tables. You can change
665    the default tables by editing pcre_chartables.c and then re-building PCRE. If
666    you do this, you should take care to ensure that the file does not get
667    automatically re-generated. The best way to do this is to move
668    pcre_chartables.c.dist out of the way and replace it with your customized
669    tables.
670    
671    When the dftables program is run as a result of --enable-rebuild-chartables,
672    it uses the default C locale that is set on your system. It does not pay
673    attention to the LC_xxx environment variables. In other words, it uses the
674    system's default locale rather than whatever the compiling user happens to have
675    set. If you really do want to build a source set of character tables in a
676    locale that is specified by the LC_xxx variables, you can run the dftables
677    program by hand with the -L option. For example:
678    
679      ./dftables -L pcre_chartables.c.special
680    
681  The first two 256-byte tables provide lower casing and case flipping functions,  The first two 256-byte tables provide lower casing and case flipping functions,
682  respectively. The next table consists of three 32-byte bit maps which identify  respectively. The next table consists of three 32-byte bit maps which identify
# Line 526  The distribution should contain the foll Line 705  The distribution should contain the foll
705    
706  (A) Source files of the PCRE library functions and their headers:  (A) Source files of the PCRE library functions and their headers:
707    
708    dftables.c             auxiliary program for building chartables.c    dftables.c              auxiliary program for building pcre_chartables.c
709                                when --enable-rebuild-chartables is specified
710    
711    pcreposix.c            )    pcre_chartables.c.dist  a default set of character tables that assume ASCII
712    pcre_compile.c         )                              coding; used, unless --enable-rebuild-chartables is
713    pcre_config.c          )                              specified, by copying to pcre_chartables.c
714    pcre_dfa_exec.c        )  
715    pcre_exec.c            )    pcreposix.c             )
716    pcre_fullinfo.c        )    pcre_byte_order.c       )
717    pcre_get.c             ) sources for the functions in the library,    pcre_compile.c          )
718    pcre_globals.c         )   and some internal functions that they use    pcre_config.c           )
719    pcre_info.c            )    pcre_dfa_exec.c         )
720    pcre_maketables.c      )    pcre_exec.c             )
721    pcre_newline.c         )    pcre_fullinfo.c         )
722    pcre_ord2utf8.c        )    pcre_get.c              ) sources for the functions in the library,
723    pcre_refcount.c        )    pcre_globals.c          )   and some internal functions that they use
724    pcre_study.c           )    pcre_info.c             )
725    pcre_tables.c          )    pcre_jit_compile.c      )
726    pcre_try_flipped.c     )    pcre_maketables.c       )
727    pcre_ucp_searchfuncs.c )    pcre_newline.c          )
728    pcre_valid_utf8.c      )    pcre_ord2utf8.c         )
729    pcre_version.c         )    pcre_refcount.c         )
730    pcre_xclass.c          )    pcre_study.c            )
731    pcre_printint.src      ) debugging function that is #included in pcretest,    pcre_tables.c           )
732                           )   and can also be #included in pcre_compile()    pcre_ucd.c              )
733    pcre.h.in              template for pcre.h when built by "configure"    pcre_valid_utf8.c       )
734    pcreposix.h            header for the external POSIX wrapper API    pcre_version.c          )
735    pcre_internal.h        header for internal use    pcre_xclass.c           )
736    ucp.h                  ) headers concerned with    pcre_printint.src       ) debugging function that is #included in pcretest,
737    ucpinternal.h          )   Unicode property handling                            )   and can also be #included in pcre_compile()
738    ucptable.h             ) (this one is the data table)    pcre.h.in               template for pcre.h when built by "configure"
739      pcreposix.h             header for the external POSIX wrapper API
740    config.h.in            template for config.h, which is built by "configure"    pcre_internal.h         header for internal use
741      sljit/*                 16 files that make up the JIT compiler
742    pcrecpp.h              public header file for the C++ wrapper    ucp.h                   header for Unicode property handling
743    pcrecpparg.h.in        template for another C++ header file  
744    pcre_scanner.h         public header file for C++ scanner functions    config.h.in             template for config.h, which is built by "configure"
745    pcrecpp.cc             )  
746    pcre_scanner.cc        ) source for the C++ wrapper library    pcrecpp.h               public header file for the C++ wrapper
747      pcrecpparg.h.in         template for another C++ header file
748    pcre_stringpiece.h.in  template for pcre_stringpiece.h, the header for the    pcre_scanner.h          public header file for C++ scanner functions
749                             C++ stringpiece functions    pcrecpp.cc              )
750    pcre_stringpiece.cc    source for the C++ stringpiece functions    pcre_scanner.cc         ) source for the C++ wrapper library
751    
752      pcre_stringpiece.h.in   template for pcre_stringpiece.h, the header for the
753                                C++ stringpiece functions
754      pcre_stringpiece.cc     source for the C++ stringpiece functions
755    
756  (B) Source files for programs that use PCRE:  (B) Source files for programs that use PCRE:
757    
758    pcredemo.c             simple demonstration of coding calls to PCRE    pcredemo.c              simple demonstration of coding calls to PCRE
759    pcregrep.c             source of a grep utility that uses PCRE    pcregrep.c              source of a grep utility that uses PCRE
760    pcretest.c             comprehensive test program    pcretest.c              comprehensive test program
761    
762  (C) Auxiliary files:  (C) Auxiliary files:
763    
764    132html                script to turn "man" pages into HTML    132html                 script to turn "man" pages into HTML
765    AUTHORS                information about the author of PCRE    AUTHORS                 information about the author of PCRE
766    ChangeLog              log of changes to the code    ChangeLog               log of changes to the code
767    CleanTxt               script to clean nroff output for txt man pages    CleanTxt                script to clean nroff output for txt man pages
768    Detrail                script to remove trailing spaces    Detrail                 script to remove trailing spaces
769    HACKING                some notes about the internals of PCRE    HACKING                 some notes about the internals of PCRE
770    INSTALL                generic installation instructions    INSTALL                 generic installation instructions
771    LICENCE                conditions for the use of PCRE    LICENCE                 conditions for the use of PCRE
772    COPYING                the same, using GNU's standard name    COPYING                 the same, using GNU's standard name
773    Makefile.in            ) template for Unix Makefile, which is built by    Makefile.in             ) template for Unix Makefile, which is built by
774                           )   "configure"                            )   "configure"
775    Makefile.am            ) the automake input that was used to create    Makefile.am             ) the automake input that was used to create
776                           )   Makefile.in                            )   Makefile.in
777    NEWS                   important changes in this release    NEWS                    important changes in this release
778    NON-UNIX-USE           notes on building PCRE on non-Unix systems    NON-UNIX-USE            notes on building PCRE on non-Unix systems
779    PrepareRelease         script to make preparations for "make dist"    PrepareRelease          script to make preparations for "make dist"
780    README                 this file    README                  this file
781    RunTest.in             template for a Unix shell script for running tests    RunTest                 a Unix shell script for running tests
782    RunGrepTest.in         template for a Unix shell script for pcregrep tests    RunGrepTest             a Unix shell script for pcregrep tests
783    aclocal.m4             m4 macros (generated by "aclocal")    aclocal.m4              m4 macros (generated by "aclocal")
784    config.guess           ) files used by libtool,    config.guess            ) files used by libtool,
785    config.sub             )   used only when building a shared library    config.sub              )   used only when building a shared library
786    configure              a configuring shell script (built by autoconf)    configure               a configuring shell script (built by autoconf)
787    configure.ac           ) the autoconf input that was used to build    configure.ac            ) the autoconf input that was used to build
788                           )   "configure" and config.h                            )   "configure" and config.h
789    depcomp                ) script to find program dependencies, generated by    depcomp                 ) script to find program dependencies, generated by
790                           )   automake                            )   automake
791    doc/*.3                man page sources for the PCRE functions    doc/*.3                 man page sources for PCRE
792    doc/*.1                man page sources for pcregrep and pcretest    doc/*.1                 man page sources for pcregrep and pcretest
793    doc/index.html.src     the base HTML page    doc/index.html.src      the base HTML page
794    doc/html/*             HTML documentation    doc/html/*              HTML documentation
795    doc/pcre.txt           plain text version of the man pages    doc/pcre.txt            plain text version of the man pages
796    doc/pcretest.txt       plain text documentation of test program    doc/pcretest.txt        plain text documentation of test program
797    doc/perltest.txt       plain text documentation of Perl test program    doc/perltest.txt        plain text documentation of Perl test program
798    install-sh             a shell script for installing files    install-sh              a shell script for installing files
799    libpcre.pc.in          template for libpcre.pc for pkg-config    libpcre.pc.in           template for libpcre.pc for pkg-config
800    libpcrecpp.pc.in       template for libpcrecpp.pc for pkg-config    libpcreposix.pc.in      template for libpcreposix.pc for pkg-config
801    ltmain.sh              file used to build a libtool script    libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config
802    missing                ) common stub for a few missing GNU programs while    ltmain.sh               file used to build a libtool script
803                           )   installing, generated by automake    missing                 ) common stub for a few missing GNU programs while
804    mkinstalldirs          script for making install directories                            )   installing, generated by automake
805    perltest.pl            Perl test program    mkinstalldirs           script for making install directories
806    pcre-config.in         source of script which retains PCRE information    perltest.pl             Perl test program
807      pcre-config.in          source of script which retains PCRE information
808      pcre_jit_test.c         test program for the JIT compiler
809    pcrecpp_unittest.cc          )    pcrecpp_unittest.cc          )
810    pcre_scanner_unittest.cc     ) test programs for the C++ wrapper    pcre_scanner_unittest.cc     ) test programs for the C++ wrapper
811    pcre_stringpiece_unittest.cc )    pcre_stringpiece_unittest.cc )
812    testdata/testinput*    test data for main library tests    testdata/testinput*     test data for main library tests
813    testdata/testoutput*   expected test results    testdata/testoutput*    expected test results
814    testdata/grep*         input and output for pcregrep tests    testdata/grep*          input and output for pcregrep tests
815    
816  (D) Auxiliary files for cmake support  (D) Auxiliary files for cmake support
817    
818      cmake/COPYING-CMAKE-SCRIPTS
819      cmake/FindPackageHandleStandardArgs.cmake
820      cmake/FindReadline.cmake
821    CMakeLists.txt    CMakeLists.txt
822    config-cmake.h.in    config-cmake.h.in
823    
824  (E) Auxiliary files for VPASCAL  (E) Auxiliary files for VPASCAL
825    
826    makevp.bat    makevp.bat
827    makevp-compile.txt    makevp_c.txt
828    makevp-linklib.txt    makevp_l.txt
829    pcregexp.pas    pcregexp.pas
830    
831  (F) Auxiliary files for building PCRE "by hand"  (F) Auxiliary files for building PCRE "by hand"
832    
833    pcre.h.generic         ) a version of the public PCRE header file    pcre.h.generic          ) a version of the public PCRE header file
834                           )   for use in non-"configure" environments                            )   for use in non-"configure" environments
835    config.h.generic       ) a version of config.h for use in non-"configure"    config.h.generic        ) a version of config.h for use in non-"configure"
836                           )   environments                            )   environments
837    
838  (F) Miscellaneous  (F) Miscellaneous
839    
# Line 653  The distribution should contain the foll Line 842  The distribution should contain the foll
842  Philip Hazel  Philip Hazel
843  Email local part: ph10  Email local part: ph10
844  Email domain: cam.ac.uk  Email domain: cam.ac.uk
845  Last updated: March 2007  Last updated: 06 September 2011

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

  ViewVC Help
Powered by ViewVC 1.1.5