Load pcre-4.0 into code/trunk.

git-svn-id: svn://vcs.exim.org/pcre/code/trunk@63 2f5784b3-3f2a-0410-8824-cb99058d5e15

1 files changed, 93 insertions, 53 deletions

diff --git a/README b/README
index 7557374..a1e04cb 100644
--- a/README
+++ b/README
@@ -30,13 +30,14 @@ Windows systems (I myself do not use Windows). Some are complete in themselves;
 others are pointers to URLs containing relevant files.
 
 
-Building PCRE on a Unix system
-------------------------------
+Building PCRE on a Unix-like system
+-----------------------------------
 
-To build PCRE on a Unix system, first run the "configure" command from the PCRE
-distribution directory, with your current directory set to the directory where
-you want the files to be created. This command is a standard GNU "autoconf"
-configuration script, for which generic instructions are supplied in INSTALL.
+To build PCRE on a Unix-like system, first run the "configure" command from the
+PCRE distribution directory, with your current directory set to the directory
+where you want the files to be created. This command is a standard GNU
+"autoconf" configuration script, for which generic instructions are supplied in
+INSTALL.
 
 Most commonly, people build PCRE within its own distribution directory, and in
 this case, on many systems, just running "./configure" is sufficient, but the
@@ -55,11 +56,45 @@ into /source/pcre/pcre-xxx, but you want to build it in /build/pcre/pcre-xxx:
 cd /build/pcre/pcre-xxx
 /source/pcre/pcre-xxx/configure
 
-If you want to make use of the experimential, incomplete support for UTF-8
-character strings in PCRE, you must add --enable-utf8 to the "configure"
-command. Without it, the code for handling UTF-8 is not included in the
-library. (Even when included, it still has to be enabled by an option at run
-time.)
+There are some optional features that can be included or omitted from the PCRE
+library. You can read more about them in the pcrebuild man page.
+
+. If you want to make use of the support for UTF-8 character strings in PCRE,
+  you must add --enable-utf8 to the "configure" command. Without it, the code
+  for handling UTF-8 is not included in the library. (Even when included, it
+  still has to be enabled by an option at run time.)
+
+. You can build PCRE to recognized CR or NL as the newline character, instead
+  of whatever your compiler uses for "\n", by adding --newline-is-cr or
+  --newline-is-nl to the "configure" command, respectively. Only do this if you
+  really understand what you are doing. On traditional Unix-like systems, the
+  newline character is NL.
+
+. When called via the POSIX interface, PCRE uses malloc() to get additional
+  storage for processing capturing parentheses if there are more than 10 of
+  them. You can increase this threshold by setting, for example,
+
+  --with-posix-malloc-threshold=20
+
+  on the "configure" command.
+
+. PCRE has a counter which can be set to limit the amount of resources it uses.
+  If the limit is exceeded during a match, the match fails. The default is ten
+  million. You can change the default by setting, for example,
+
+  --with-match-limit=500000
+
+  on the "configure" command. This is just the default; individual calls to
+  pcre_exec() can supply their own value. There is discussion on the pcreapi
+  man page.
+
+. The default maximum compiled pattern size is around 64K. You can increase
+  this by adding --with-link-size=3 to the "configure" command. You can
+  increase it even more by setting --with-link-size=4, but this is unlikely
+  ever to be necessary. If you build PCRE with an increased link size, test 2
+  (and 5 if you are using UTF-8) will fail. Part of the output of these tests
+  is a representation of the compiled pattern, and this changes with the link
+  size.
 
 The "configure" script builds five files:
 
@@ -89,16 +124,9 @@ outputs information about where the library is installed. This command can be
 included in makefiles for programs that use PCRE, saving the programmer from
 having to remember too many details.
 
-There is one esoteric feature that is controlled by "configure". It concerns
-the character value used for "newline", and is something that you probably do
-not want to change on a Unix system. The default is to use whatever value your
-compiler gives to '\n'. By using --enable-newline-is-cr or
---enable-newline-is-lf you can force the value to be CR (13) or LF (10) if you
-really want to.
-
 
-Shared libraries on Unix systems
---------------------------------
+Shared libraries on Unix-like systems
+-------------------------------------
 
 The default distribution builds PCRE as two shared libraries and two static
 libraries, as long as the operating system supports shared libraries. Shared
@@ -123,6 +151,19 @@ Then run "make" in the usual way. Similarly, you can use --disable-static to
 build only shared libraries.
 
 
+Cross-compiling on a Unix-like system
+-------------------------------------
+
+You can specify CC and CFLAGS in the normal way to the "configure" command, in
+order to cross-compile PCRE for some other host. However, during the building
+process, the dftables.c source file is compiled *and run* on the local host, in
+order to generate the default character tables (the chartables.c file). It
+therefore needs to be compiled with the local compiler, not the cross compiler.
+You can do this by specifying HOST_CC (and if necessary HOST_CFLAGS) when
+calling the "configure" command. If they are not specified, they default to the
+values of CC and CFLAGS.
+
+
 Building on non-Unix systems
 ----------------------------
 
@@ -140,20 +181,18 @@ To test PCRE on a Unix system, run the RunTest script that is created by the
 configuring process. (This can also be run by "make runtest", "make check", or
 "make test".) For other systems, see the instruction in NON-UNIX-USE.
 
-The script runs the pcretest test program (which is documented in the doc
-directory) on each of the testinput files (in the testdata directory) in turn,
+The script runs the pcretest test program (which is documented in its own man
+page) on each of the testinput files (in the testdata directory) in turn,
 and compares the output with the contents of the corresponding testoutput file.
 A file called testtry is used to hold the output from pcretest. To run pcretest
 on just one of the test files, give its number as an argument to RunTest, for
 example:
 
-  RunTest 3
+  RunTest 2
 
-The first and third test files can also be fed directly into the perltest
-script to check that Perl gives the same results. The third file requires the
-additional features of release 5.005, which is why it is kept separate from the
-main test input, which needs only Perl 5.004. In the long run, when 5.005 (or
-higher) is widespread, these two test files may get amalgamated.
+The first file can also be fed directly into the perltest script to check that
+Perl gives the same results. The only difference you should see is in the first
+few lines, where the Perl version is given instead of the PCRE version.
 
 The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),
 pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
@@ -171,12 +210,12 @@ listed for checking. Where the comparison test output contains [\x00-\x7f] the
 test will contain [\x00-\xff], and similarly in some other cases. This is not a
 bug in PCRE.
 
-The fourth set of tests checks pcre_maketables(), the facility for building a
+The third set of tests checks pcre_maketables(), the facility for building a
 set of character tables for a specific locale and using them instead of the
 default tables. The tests make use of the "fr" (French) locale. Before running
 the test, the script checks for the presence of this locale by running the
 "locale" command. If that command fails, or if it doesn't include "fr" in the
-list of available locales, the fourth test cannot be run, and a comment is
+list of available locales, the third test cannot be run, and a comment is
 output to say why. If running this test produces instances of the error
 
   ** Failed to set locale "fr"
@@ -184,10 +223,14 @@ output to say why. If running this test produces instances of the error
 in the comparison output, it means that locale is not available on your system,
 despite being listed by "locale". This does not mean that PCRE is broken.
 
-The fifth test checks the experimental, incomplete UTF-8 support. It is not run
-automatically unless PCRE is built with UTF-8 support. This file can be fed
-directly to the perltest8 script, which requires Perl 5.6 or higher. The sixth
-file tests internal UTF-8 features of PCRE that are not relevant to Perl.
+The fourth test checks the UTF-8 support. It is not run automatically unless
+PCRE is built with UTF-8 support. To do this you must set --enable-utf8 when
+running "configure". This file can be also fed directly to the perltest script,
+provided you are running Perl 5.8 or higher. (For Perl 5.6, a small patch,
+commented in the script, can be be used.)
+
+The fifth and final file tests error handling with UTF-8 encoding, and internal
+UTF-8 features of PCRE that are not relevant to Perl.
 
 
 Character tables
@@ -243,6 +286,7 @@ The distribution should contain the following files:
   study.c               ) source of
   pcre.c                )   the functions
   pcreposix.c           )
+  printint.c            )
   pcre.in               "source" for the header for the external API; pcre.h
                           is built from this by "configure"
   pcreposix.h           header for the external POSIX wrapper API
@@ -266,42 +310,38 @@ The distribution should contain the following files:
   configure             a configuring shell script (built by autoconf)
   configure.in          the autoconf input used to build configure
   doc/Tech.Notes        notes on the encoding
-  doc/pcre.3            man page source for the PCRE functions
-  doc/pcre.html         HTML version
-  doc/pcre.txt          plain text version
-  doc/pcreposix.3       man page source for the POSIX wrapper API
-  doc/pcreposix.html    HTML version
-  doc/pcreposix.txt     plain text version
-  doc/pcretest.txt      documentation of test program
-  doc/perltest.txt      documentation of Perl test program
-  doc/pcregrep.1        man page source for the pcregrep utility
-  doc/pcregrep.html     HTML version
-  doc/pcregrep.txt      plain text version
+  doc/*.3               man page sources for the PCRE functions
+  doc/*.1               man page sources for pcregrep and pcretest
+  doc/html/*            HTML documentation
+  doc/pcre.txt          plain text version of the man pages
+  doc/pcretest.txt      plain text documentation of test program
+  doc/perltest.txt      plain text documentation of Perl test program
   install-sh            a shell script for installing files
   ltmain.sh             file used to build a libtool script
   pcretest.c            comprehensive test program
   pcredemo.c            simple demonstration of coding calls to PCRE
   perltest              Perl test program
-  perltest8             Perl test program for UTF-8 tests
   pcregrep.c            source of a grep utility that uses PCRE
   pcre-config.in        source of script which retains PCRE information
-  testdata/testinput1   test data, compatible with Perl 5.004 and 5.005
+  testdata/testinput1   test data, compatible with Perl
   testdata/testinput2   test data for error messages and non-Perl things
-  testdata/testinput3   test data, compatible with Perl 5.005
-  testdata/testinput4   test data for locale-specific tests
-  testdata/testinput5   test data for UTF-8 tests compatible with Perl 5.6
-  testdata/testinput6   test data for other UTF-8 tests
+  testdata/testinput3   test data for locale-specific tests
+  testdata/testinput4   test data for UTF-8 tests compatible with Perl
+  testdata/testinput5   test data for other UTF-8 tests
   testdata/testoutput1  test results corresponding to testinput1
   testdata/testoutput2  test results corresponding to testinput2
   testdata/testoutput3  test results corresponding to testinput3
   testdata/testoutput4  test results corresponding to testinput4
   testdata/testoutput5  test results corresponding to testinput5
-  testdata/testoutput6  test results corresponding to testinput6
 
 (C) Auxiliary files for Win32 DLL
 
   dll.mk
   pcre.def
 
+(D) Auxiliary file for VPASCAL
+
+  makevp.bat
+
 Philip Hazel <ph10@cam.ac.uk>
-August 2001
+February 2003