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

Diff of /code/trunk/README

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

revision 109 by ph10, Wed Mar 7 15:35:57 2007 UTC revision 135 by ph10, Thu Mar 29 09:09:33 2007 UTC
# Line 5  The latest release of PCRE is always ava Line 5  The latest release of PCRE is always ava
5    
6    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
7    
8    There is a mailing list for discussion about the development of PCRE at
9    
10      pcre-dev@exim.org
11    
12  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.
13  The contents of this README file are:  The contents of this README file are:
14    
# Line 12  The contents of this README file are: Line 16  The contents of this README file are:
16    Documentation for PCRE    Documentation for PCRE
17    Contributions by users of PCRE    Contributions by users of PCRE
18    Building PCRE on non-Unix systems    Building PCRE on non-Unix systems
19    Building PCRE on a Unix-like system    Building PCRE on Unix-like systems
20    Retrieving configuration information on a Unix-like system    Retrieving configuration information on Unix-like systems
21    Shared libraries on Unix-like systems    Shared libraries on Unix-like systems
22    Cross-compiling on a Unix-like system    Cross-compiling on Unix-like systems
23    Using HP's ANSI C++ compiler (aCC)    Using HP's ANSI C++ compiler (aCC)
24      Making new tarballs
25    Testing PCRE    Testing PCRE
26    Character tables    Character tables
27    File manifest    File manifest
# Line 25  The contents of this README file are: Line 30  The contents of this README file are:
30  The PCRE APIs  The PCRE APIs
31  -------------  -------------
32    
33  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
34  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
35  for details).  of Google Inc.
36    
37  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
38  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
39  that this just provides a POSIX calling interface to PCRE; the regular  library called libpcreposix. Note that this just provides a POSIX calling
40  expressions themselves still follow Perl syntax and semantics. The POSIX API is  interface to PCRE; the regular expressions themselves still follow Perl syntax
41  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
42    all of PCRE's facilities.
43    
44  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
45  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 48  ensure that they link with PCRE's libpcr Line 54  ensure that they link with PCRE's libpcr
54  up the POSIX functions of the same name from the other library.  up the POSIX functions of the same name from the other library.
55    
56  One way of avoiding this confusion is to compile PCRE with the addition of  One way of avoiding this confusion is to compile PCRE with the addition of
57  -Dregcomp=PCREregcomp (and similarly for the other functions) to the compiler  -Dregcomp=PCREregcomp (and similarly for the other POSIX functions) to the
58  flags (CFLAGS if you are using "configure" -- see below). This has the effect  compiler flags (CFLAGS if you are using "configure" -- see below). This has the
59  of renaming the functions so that the names no longer clash. Of course, you  effect of renaming the functions so that the names no longer clash. Of course,
60  have to do the same thing for your applications, or write them using the new  you have to do the same thing for your applications, or write them using the
61  names.  new names.
62    
63    
64  Documentation for PCRE  Documentation for PCRE
65  ----------------------  ----------------------
66    
67  If you install PCRE in the normal way, you will end up with an installed set of  If you install PCRE in the normal way on a Unix-like system, you will end up
68  man pages whose names all start with "pcre". The one that is just called "pcre"  with a set of man pages whose names all start with "pcre". The one that is just
69  lists all the others. In addition to these man pages, the PCRE documentation is  called "pcre" lists all the others. In addition to these man pages, the PCRE
70  supplied in two other forms:  documentation is supplied in two other forms:
71    
72    1. There are files called doc/pcre.txt, doc/pcregrep.txt, and    1. There are files called doc/pcre.txt, doc/pcregrep.txt, and
73       doc/pcretest.txt in the source distribution. The first of these is a       doc/pcretest.txt in the source distribution. The first of these is a
# Line 69  supplied in two other forms: Line 75  supplied in two other forms:
75       those that summarize individual functions. The other two are the text       those that summarize individual functions. The other two are the text
76       forms of the section 1 man pages for the pcregrep and pcretest commands.       forms of the section 1 man pages for the pcregrep and pcretest commands.
77       These text forms are provided for ease of scanning with text editors or       These text forms are provided for ease of scanning with text editors or
78       similar tools.       similar tools. They are installed in <prefix>/share/doc/pcre, where
79         <prefix> is the installation prefix (defaulting to /usr/local).
80    
81    2. A set of files containing all the documentation in HTML form, hyperlinked    2. A set of files containing all the documentation in HTML form, hyperlinked
82       in various ways, and rooted in a file called index.html, is installed in       in various ways, and rooted in a file called index.html, is distributed in
83       the directory <prefix>/share/doc/pcre/html, where <prefix> is the       doc/html and installed in <prefix>/share/doc/pcre/html.
      installation prefix (defaulting to /usr/local).  
84    
85    
86  Contributions by users of PCRE  Contributions by users of PCRE
# Line 84  You can find contributions from PCRE use Line 90  You can find contributions from PCRE use
90    
91    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib
92    
93  where there is also a README file giving brief descriptions of what they are.  There is a README file giving brief descriptions of what they are. Some are
94  Some are complete in themselves; others are pointers to URLs containing  complete in themselves; others are pointers to URLs containing relevant files.
95  relevant files. Some of this material is likely to be well out-of-date. In  Some of this material is likely to be well out-of-date. Several of the earlier
96  particular, several of the contributions provide support for compiling PCRE on  contributions provided support for compiling PCRE on various flavours of
97  various flavours of Windows (I myself do not use Windows), but it is hoped that  Windows (I myself do not use Windows). Nowadays there is more Windows support
98  more Windows support will find its way into the standard distribution.  in the standard distribution, so these contibutions have been archived.
99    
100    
101  Building PCRE on non-Unix systems  Building PCRE on non-Unix systems
102  ---------------------------------  ---------------------------------
103    
104  For a non-Unix system, read the comments in the file NON-UNIX-USE, though if  For a non-Unix system, please read the comments in the file NON-UNIX-USE,
105  the system supports the use of "configure" and "make" you may be able to build  though if your system supports the use of "configure" and "make" you may be
106  PCRE in the same way as for Unix-like systems.  able to build PCRE in the same way as for Unix-like systems.
107    
108  PCRE has been compiled on many different operating systems. It should be  PCRE has been compiled on many different operating systems. It should be
109  straightforward to build PCRE on any system that has a Standard C compiler and  straightforward to build PCRE on any system that has a Standard C compiler and
110  library, because it uses only Standard C functions.  library, because it uses only Standard C functions.
111    
112    
113  Building PCRE on a Unix-like system  Building PCRE on Unix-like systems
114  -----------------------------------  ----------------------------------
115    
116  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
117  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.
# Line 114  To build PCRE on a Unix-like system, fir Line 120  To build PCRE on a Unix-like system, fir
120  PCRE distribution directory, with your current directory set to the directory  PCRE distribution directory, with your current directory set to the directory
121  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
122  "autoconf" configuration script, for which generic instructions are supplied in  "autoconf" configuration script, for which generic instructions are supplied in
123  INSTALL.  the file INSTALL.
124    
125  Most commonly, people build PCRE within its own distribution directory, and in  Most commonly, people build PCRE within its own distribution directory, and in
126  this case, on many systems, just running "./configure" is sufficient. However,  this case, on many systems, just running "./configure" is sufficient. However,
# Line 142  library. You can read more about them in Line 148  library. You can read more about them in
148    
149  . 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
150    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,
151    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,
152    will try to build the C++ wrapper.    it will try to build the C++ wrapper.
153    
154  . If you want to make use of the support for UTF-8 character strings in PCRE,  . If you want to make use of the support for UTF-8 character strings in PCRE,
155    you must add --enable-utf8 to the "configure" command. Without it, the code    you must add --enable-utf8 to the "configure" command. Without it, the code
# Line 173  library. You can read more about them in Line 179  library. You can read more about them in
179    
180  . When called via the POSIX interface, PCRE uses malloc() to get additional  . When called via the POSIX interface, PCRE uses malloc() to get additional
181    storage for processing capturing parentheses if there are more than 10 of    storage for processing capturing parentheses if there are more than 10 of
182    them. You can increase this threshold by setting, for example,    them in a pattern. You can increase this threshold by setting, for example,
183    
184    --with-posix-malloc-threshold=20    --with-posix-malloc-threshold=20
185    
# Line 186  library. You can read more about them in Line 192  library. You can read more about them in
192    --with-match-limit=500000    --with-match-limit=500000
193    
194    on the "configure" command. This is just the default; individual calls to    on the "configure" command. This is just the default; individual calls to
195    pcre_exec() can supply their own value. There is discussion on the pcreapi    pcre_exec() can supply their own value. There is more discussion on the
196    man page.    pcreapi man page.
197    
198  . There is a separate counter that limits the depth of recursive function calls  . There is a separate counter that limits the depth of recursive function calls
199    during a matching process. This also has a default of ten million, which is    during a matching process. This also has a default of ten million, which is
# Line 202  library. You can read more about them in Line 208  library. You can read more about them in
208  . The default maximum compiled pattern size is around 64K. You can increase  . The default maximum compiled pattern size is around 64K. You can increase
209    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
210    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
211    ever to be necessary. If you build PCRE with an increased link size, test 2    ever to be necessary. Increasing the internal link size will reduce
212    (and 5 if you are using UTF-8) will fail. Part of the output of these tests    performance.
   is a representation of the compiled pattern, and this changes with the link  
   size.  
213    
214  . 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
215    pcre_exec() does not call itself recursively. Instead, it uses blocks of data    pcre_exec() does not call itself recursively. Instead, it uses memory blocks
216    from the heap via special functions pcre_stack_malloc() and pcre_stack_free()    obtained from the heap via the special functions pcre_stack_malloc() and
217    to save data that would otherwise be saved on the stack. To build PCRE like    pcre_stack_free() to save data that would otherwise be saved on the stack. To
218    this, use    build PCRE like this, use
219    
220    --disable-stack-for-recursion    --disable-stack-for-recursion
221    
222    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
223    necessary in environments with limited stack sizes. This applies only to the    necessary in environments with limited stack sizes. This applies only to the
224    pcre_exec() function; it does not apply to pcre_dfa_exec(), which does not    pcre_exec() function; it does not apply to pcre_dfa_exec(), which does not
225    use deeply nested recursion.    use deeply nested recursion. There is a discussion about stack sizes in the
226      pcrestack man page.
227    
228    . For speed, PCRE uses four tables for manipulating and identifying characters
229      whose code point values are less than 256. By default, it uses a set of
230      tables for ASCII encoding that is part of the distribution. If you specify
231    
232      --enable-rebuild-chartables
233    
234      a program called dftables is compiled and run in the default C locale when
235      you obey "make". It builds a source file called pcre_chartables.c. If you do
236      not specify this option, pcre_chartables.c is created as a copy of
237      pcre_chartables.c.dist. See "Character tables" below for further information.
238    
239    . It is possible to compile PCRE for use on systems that use EBCDIC as their
240      default character code (as opposed to ASCII) by specifying
241    
242      --enable-ebcdic
243    
244      This automatically implies --enable-rebuild-chartables (see above).
245    
246  The "configure" script builds the following files for the basic C library:  The "configure" script builds the following files for the basic C library:
247    
# Line 231  The "configure" script builds the follow Line 254  The "configure" script builds the follow
254  . RunTest is a script for running tests on the basic C library  . RunTest is a script for running tests on the basic C library
255  . RunGrepTest is a script for running tests on the pcregrep command  . RunGrepTest is a script for running tests on the pcregrep command
256    
257  Versions of config.h and pcre.h are distributed in the PCRE tarballs. These are  Versions of config.h and pcre.h are distributed in the PCRE tarballs under
258  provided for the benefit of those who have to compile PCRE without the benefit  the names config.h.generic and pcre.h.generic. These are provided for the
259  of "configure". If you use "configure", the distributed copies are replaced.  benefit of those who have to built PCRE without the benefit of "configure". If
260    you use "configure", the .generic versions are not used.
261    
262  If a C++ compiler is found, the following files are also built:  If a C++ compiler is found, the following files are also built:
263    
# Line 248  contains compiler output from tests that Line 272  contains compiler output from tests that
272  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
273  libpcre and libpcreposix, a test program called pcretest, a demonstration  libpcre and libpcreposix, a test program called pcretest, a demonstration
274  program called pcredemo, and the pcregrep command. If a C++ compiler was found  program called pcredemo, and the pcregrep command. If a C++ compiler was found
275  on your system, it also builds the C++ wrapper library, which is called  on your system, "make" also builds the C++ wrapper library, which is called
276  libpcrecpp, and some test programs called pcrecpp_unittest,  libpcrecpp, and some test programs called pcrecpp_unittest,
277  pcre_scanner_unittest, and pcre_stringpiece_unittest.  pcre_scanner_unittest, and pcre_stringpiece_unittest. Building the C++ wrapper
278    can be disabled by adding --disable-cpp to the "configure" command.
279    
280  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
281  tests are given below in a separate section of this document.  tests are given below in a separate section of this document.
# Line 262  system. The following are installed (fil Line 287  system. The following are installed (fil
287    Commands (bin):    Commands (bin):
288      pcretest      pcretest
289      pcregrep      pcregrep
290      pcre-config      pcre-config
291    
292    Libraries (lib):    Libraries (lib):
293      libpcre      libpcre
# Line 271  system. The following are installed (fil Line 296  system. The following are installed (fil
296    
297    Configuration information (lib/pkgconfig):    Configuration information (lib/pkgconfig):
298      libpcre.pc      libpcre.pc
299      libpcrecpp.ps (if C++ support is enabled)      libpcrecpp.pc (if C++ support is enabled)
300    
301    Header files (include):    Header files (include):
302      pcre.h      pcre.h
# Line 295  system. The following are installed (fil Line 320  system. The following are installed (fil
320      AUTHORS      AUTHORS
321      COPYING      COPYING
322      ChangeLog      ChangeLog
     INSTALL  
323      LICENCE      LICENCE
     NON-UNIX-USE  
324      NEWS      NEWS
325      README      README
326      pcre.txt       (a concatenation of the man(3) pages)      pcre.txt       (a concatenation of the man(3) pages)
327      pcretest.txt   the pcretest man page      pcretest.txt   the pcretest man page
328      pcregrep.txt   the pcregrep man page      pcregrep.txt   the pcregrep man page
     perltest.txt   some information about the perltest.pl script  
329    
330  Note that the pcredemo program that is built by "configure" is *not* installed  Note that the pcredemo program that is built by "configure" is *not* installed
331  anywhere. It is a demonstration for programmers wanting to use PCRE.  anywhere. It is a demonstration for programmers wanting to use PCRE.
332    
333  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".
# Line 313  This removes all the files that "make in Line 335  This removes all the files that "make in
335  remove any directories, because these are often shared with other programs.  remove any directories, because these are often shared with other programs.
336    
337    
338  Retrieving configuration information on a Unix-like system  Retrieving configuration information on Unix-like systems
339  ----------------------------------------------------------  ---------------------------------------------------------
340    
341  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
342  recall information about the PCRE configuration and installation. For example:  recall information about the PCRE configuration and installation. For example:
# Line 353  built. The programs pcretest and pcregre Line 375  built. The programs pcretest and pcregre
375  libraries (by means of wrapper scripts in the case of shared libraries). When  libraries (by means of wrapper scripts in the case of shared libraries). When
376  you use "make install" to install shared libraries, pcregrep and pcretest are  you use "make install" to install shared libraries, pcregrep and pcretest are
377  automatically re-built to use the newly installed shared libraries before being  automatically re-built to use the newly installed shared libraries before being
378  installed themselves. However, the versions left in the source directory still  installed themselves. However, the versions left in the build directory still
379  use the uninstalled libraries.  use the uninstalled libraries.
380    
381  To build PCRE using static libraries only you must use --disable-shared when  To build PCRE using static libraries only you must use --disable-shared when
# Line 365  Then run "make" in the usual way. Simila Line 387  Then run "make" in the usual way. Simila
387  build only shared libraries.  build only shared libraries.
388    
389    
390  Cross-compiling on a Unix-like system  Cross-compiling on Unix-like systems
391  -------------------------------------  ------------------------------------
392    
393  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
394  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
395  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
396  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
397  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,
398  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
399  there are also CXX_FOR_BUILD and CXXFLAGS_FOR_BUILD for the C++ wrapper)  compiler.
400  when calling the "configure" command. If they are not specified, they default  
401  to the values of CC and CFLAGS.  When --enable-rebuild-chartables is not specified, pcre_chartables.c is created
402    by making a copy of pcre_chartables.c.dist, which is a default set of tables
403    that assumes ASCII code. Cross-compiling with the default tables should not be
404    a problem.
405    
406    If you need to modify the character tables when cross-compiling, you should
407    move pcre_chartables.c.dist out of the way, then compile dftables.c by hand and
408    run it on the local host to make a new version of pcre_chartables.c.dist.
409    Then when you cross-compile PCRE this new version of the tables will be used.
410    
411    
412  Using HP's ANSI C++ compiler (aCC)  Using HP's ANSI C++ compiler (aCC)
413  ----------------------------------  ----------------------------------
414    
415  Unless C++ support is disabled by specifying the "--disable-cpp" option of the  Unless C++ support is disabled by specifying the "--disable-cpp" option of the
416  "configure" script, you *must* include the "-AA" option in the CXXFLAGS  "configure" script, you must include the "-AA" option in the CXXFLAGS
417  environment variable in order for the C++ components to compile correctly.  environment variable in order for the C++ components to compile correctly.
418    
419  Also, note that the aCC compiler on PA-RISC platforms may have a defect whereby  Also, note that the aCC compiler on PA-RISC platforms may have a defect whereby
# Line 395  running the "configure" script: Line 425  running the "configure" script:
425    CXXLDFLAGS="-lstd_v2 -lCsup_v2"    CXXLDFLAGS="-lstd_v2 -lCsup_v2"
426    
427    
428    Making new tarballs
429    -------------------
430    
431    The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and
432    zip formats. However, if you have modified any of the man page sources in the
433    doc directory, you should first run the PrepareRelease script. This re-creates
434    the .txt and HTML forms of the documentation from the man pages.
435    
436    
437  Testing PCRE  Testing PCRE
438  ------------  ------------
439    
440  To test PCRE on a Unix system, run the RunTest script that is created by the  To test the basic PCRE library on a Unix system, run the RunTest script that is
441  configuring process. There is also a script called RunGrepTest that tests the  created by the configuring process. There is also a script called RunGrepTest
442  options of the pcregrep command. If the C++ wrapper library is build, three  that tests the options of the pcregrep command. If the C++ wrapper library is
443  test programs called pcrecpp_unittest, pcre_scanner_unittest, and  built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and
444  pcre_stringpiece_unittest are also built.  pcre_stringpiece_unittest are also built.
445    
446  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
447  "make test". For other systems, see the instructions in NON-UNIX-USE.  "make test". For other systems, see the instructions in NON-UNIX-USE.
448    
449  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
450  own man page) on each of the testinput files (in the testdata directory) in  own man page) on each of the testinput files in the testdata directory in
451  turn, and compares the output with the contents of the corresponding testoutput  turn, and compares the output with the contents of the corresponding testoutput
452  files. A file called testtry is used to hold the main output from pcretest  files. A file called testtry is used to hold the main output from pcretest
453  (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
# Line 424  version. Line 463  version.
463  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),
464  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
465  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
466  wrapper API. It also uses the debugging flag to check some of the internals of  wrapper API. It also uses the debugging flags to check some of the internals of
467  pcre_compile().  pcre_compile().
468    
469  If you build PCRE with a locale setting that is not the standard C locale, the  If you build PCRE with a locale setting that is not the standard C locale, the
# Line 459  commented in the script, can be be used. Line 498  commented in the script, can be be used.
498  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
499  features of PCRE that are not relevant to Perl.  features of PCRE that are not relevant to Perl.
500    
501  The sixth and test checks the support for Unicode character properties. It it  The sixth test checks the support for Unicode character properties. It it not
502  not run automatically unless PCRE is built with Unicode property support. To to  run automatically unless PCRE is built with Unicode property support. To to
503  this you must set --enable-unicode-properties when running "configure".  this you must set --enable-unicode-properties when running "configure".
504    
505  The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative  The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative
# Line 472  automatically unless PCRE is build with Line 511  automatically unless PCRE is build with
511  Character tables  Character tables
512  ----------------  ----------------
513    
514  PCRE uses four tables for manipulating and identifying characters whose values  For speed, PCRE uses four tables for manipulating and identifying characters
515  are less than 256. The final argument of the pcre_compile() function is a  whose code point values are less than 256. The final argument of the
516  pointer to a block of memory containing the concatenated tables. A call to  pcre_compile() function is a pointer to a block of memory containing the
517  pcre_maketables() can be used to generate a set of tables in the current  concatenated tables. A call to pcre_maketables() can be used to generate a set
518  locale. If the final argument for pcre_compile() is passed as NULL, a set of  of tables in the current locale. If the final argument for pcre_compile() is
519  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.
520    
521  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
522  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
523  (compiled from dftables.c), which uses the ANSI C character handling functions  tables for ASCII coding. However, if --enable-rebuild-chartables is specified
524  such as isalnum(), isalpha(), isupper(), islower(), etc. to build the table  for ./configure, a different version of pcre_chartables.c is built by the
525  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
526  control the contents of these default tables. You can change the default tables  handling functions such as isalnum(), isalpha(), isupper(), islower(), etc. to
527  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
528  probably also edit Makefile to ensure that the file doesn't ever get  your system will control the contents of these default tables. You can change
529  re-generated.  the default tables by editing pcre_chartables.c and then re-building PCRE. If
530    you do this, you should take care to ensure that the file does not get
531    automatically re-generated. The best way to do this is to move
532    pcre_chartables.c.dist out of the way and replace it with your customized
533    tables.
534    
535    When the dftables program is run as a result of --enable-rebuild-chartables,
536    it uses the default C locale that is set on your system. It does not pay
537    attention to the LC_xxx environment variables. In other words, it uses the
538    system's default locale rather than whatever the compiling user happens to have
539    set. If you really do want to build a source set of character tables in a
540    locale that is specified by the LC_xxx variables, you can run the dftables
541    program by hand with the -L option. For example:
542    
543      ./dftables -L pcre_chartables.c.special
544    
545  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,
546  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
547  digits, "word" characters, and white space, respectively. These are used when  digits, "word" characters, and white space, respectively. These are used when
548  building 32-byte bit maps that represent character classes for code points less  building 32-byte bit maps that represent character classes for code points less
549  than 256.  than 256.
550    
551  The final 256-byte table has bits indicating various character types, as  The final 256-byte table has bits indicating various character types, as
# Line 516  The distribution should contain the foll Line 569  The distribution should contain the foll
569    
570  (A) Source files of the PCRE library functions and their headers:  (A) Source files of the PCRE library functions and their headers:
571    
572    dftables.c             auxiliary program for building chartables.c    dftables.c              auxiliary program for building pcre_chartables.c
573                                when --enable-rebuild-chartables is specified
574    pcreposix.c            )  
575    pcre_compile.c         )    pcre_chartables.c.dist  a default set of character tables that assume ASCII
576    pcre_config.c          )                              coding; used, unless --enable-rebuild-chartables is
577    pcre_dfa_exec.c        )                              specified, by copying to pcre_chartables.c
578    pcre_exec.c            )  
579    pcre_fullinfo.c        )    pcreposix.c             )
580    pcre_get.c             ) sources for the functions in the library,    pcre_compile.c          )
581    pcre_globals.c         )   and some internal functions that they use    pcre_config.c           )
582    pcre_info.c            )    pcre_dfa_exec.c         )
583    pcre_maketables.c      )    pcre_exec.c             )
584    pcre_newline.c         )    pcre_fullinfo.c         )
585    pcre_ord2utf8.c        )    pcre_get.c              ) sources for the functions in the library,
586    pcre_refcount.c        )    pcre_globals.c          )   and some internal functions that they use
587    pcre_study.c           )    pcre_info.c             )
588    pcre_tables.c          )    pcre_maketables.c       )
589    pcre_try_flipped.c     )    pcre_newline.c          )
590    pcre_ucp_searchfuncs.c )    pcre_ord2utf8.c         )
591    pcre_valid_utf8.c      )    pcre_refcount.c         )
592    pcre_version.c         )    pcre_study.c            )
593    pcre_xclass.c          )    pcre_tables.c           )
594    pcre_printint.src      ) debugging function that is #included in pcretest,    pcre_try_flipped.c      )
595                           )   and can also be #included in pcre_compile()    pcre_ucp_searchfuncs.c  )
596    pcre.h                 ) a version of the public PCRE header file    pcre_valid_utf8.c       )
597                           )   for use in non-"configure" environments    pcre_version.c          )
598    pcre.h.in              template for pcre.h when built by "configure"    pcre_xclass.c           )
599    pcreposix.h            header for the external POSIX wrapper API    pcre_printint.src       ) debugging function that is #included in pcretest,
600    pcre_internal.h        header for internal use                            )   and can also be #included in pcre_compile()
601    ucp.h                  ) headers concerned with    pcre.h.in               template for pcre.h when built by "configure"
602    ucpinternal.h          )   Unicode property handling    pcreposix.h             header for the external POSIX wrapper API
603    ucptable.h             ) (this one is the data table)    pcre_internal.h         header for internal use
604      ucp.h                   ) headers concerned with
605    config.h               ) a version of config.h for use in non-"configure"    ucpinternal.h           )   Unicode property handling
606                           )   environments    ucptable.h              ) (this one is the data table)
607    config.h.in            template for config.h when built by "configure"  
608      config.h.in             template for config.h, which is built by "configure"
609    pcrecpp.h              public header file for the C++ wrapper  
610    pcrecpparg.h.in        template for another C++ header file    pcrecpp.h               public header file for the C++ wrapper
611    pcre_scanner.h         public header file for C++ scanner functions    pcrecpparg.h.in         template for another C++ header file
612    pcrecpp.cc             )    pcre_scanner.h          public header file for C++ scanner functions
613    pcre_scanner.cc        ) source for the C++ wrapper library    pcrecpp.cc              )
614      pcre_scanner.cc         ) source for the C++ wrapper library
615    pcre_stringpiece.h.in  template for pcre_stringpiece.h, the header for the  
616                             C++ stringpiece functions    pcre_stringpiece.h.in   template for pcre_stringpiece.h, the header for the
617    pcre_stringpiece.cc    source for the C++ stringpiece functions                              C++ stringpiece functions
618      pcre_stringpiece.cc     source for the C++ stringpiece functions
619    
620  (B) Source files for programs that use PCRE:  (B) Source files for programs that use PCRE:
621    
622    pcredemo.c             simple demonstration of coding calls to PCRE    pcredemo.c              simple demonstration of coding calls to PCRE
623    pcregrep.c             source of a grep utility that uses PCRE    pcregrep.c              source of a grep utility that uses PCRE
624    pcretest.c             comprehensive test program    pcretest.c              comprehensive test program
625    
626  (C) Auxiliary files:  (C) Auxiliary files:
627    
628    AUTHORS                information about the author of PCRE    132html                 script to turn "man" pages into HTML
629    ChangeLog              log of changes to the code    AUTHORS                 information about the author of PCRE
630    INSTALL                generic installation instructions    ChangeLog               log of changes to the code
631    LICENCE                conditions for the use of PCRE    CleanTxt                script to clean nroff output for txt man pages
632    COPYING                the same, using GNU's standard name    Detrail                 script to remove trailing spaces
633    Makefile.in            ) template for Unix Makefile, which is built by    HACKING                 some notes about the internals of PCRE
634                           )   "configure"    INSTALL                 generic installation instructions
635    Makefile.am            ) the automake input that was used to create    LICENCE                 conditions for the use of PCRE
636                           )   Makefile.in    COPYING                 the same, using GNU's standard name
637    NEWS                   important changes in this release    Makefile.in             ) template for Unix Makefile, which is built by
638    NON-UNIX-USE           notes on building PCRE on non-Unix systems                            )   "configure"
639    README                 this file    Makefile.am             ) the automake input that was used to create
640    RunTest.in             template for a Unix shell script for running tests                            )   Makefile.in
641    RunGrepTest.in         template for a Unix shell script for pcregrep tests    NEWS                    important changes in this release
642    aclocal.m4             m4 macros (generated by "aclocal")    NON-UNIX-USE            notes on building PCRE on non-Unix systems
643    config.guess           ) files used by libtool,    PrepareRelease          script to make preparations for "make dist"
644    config.sub             )   used only when building a shared library    README                  this file
645    configure              a configuring shell script (built by autoconf)    RunTest.in              template for a Unix shell script for running tests
646    configure.ac           ) the autoconf input that was used to build    RunGrepTest.in          template for a Unix shell script for pcregrep tests
647                           )   "configure" and config.h    aclocal.m4              m4 macros (generated by "aclocal")
648    depcomp                ) script to find program dependencies, generated by    config.guess            ) files used by libtool,
649                           )   automake    config.sub              )   used only when building a shared library
650    doc/*.3                man page sources for the PCRE functions    configure               a configuring shell script (built by autoconf)
651    doc/*.1                man page sources for pcregrep and pcretest    configure.ac            ) the autoconf input that was used to build
652    doc/html/*             HTML documentation                            )   "configure" and config.h
653    doc/pcre.txt           plain text version of the man pages    depcomp                 ) script to find program dependencies, generated by
654    doc/pcretest.txt       plain text documentation of test program                            )   automake
655    doc/perltest.txt       plain text documentation of Perl test program    doc/*.3                 man page sources for the PCRE functions
656    install-sh             a shell script for installing files    doc/*.1                 man page sources for pcregrep and pcretest
657    libpcre.pc.in          template for libpcre.pc for pkg-config    doc/index.html.src      the base HTML page
658    libpcrecpp.pc.in       template for libpcrecpp.pc for pkg-config    doc/html/*              HTML documentation
659    ltmain.sh              file used to build a libtool script    doc/pcre.txt            plain text version of the man pages
660    missing                ) common stub for a few missing GNU programs while    doc/pcretest.txt        plain text documentation of test program
661                           )   installing, generated by automake    doc/perltest.txt        plain text documentation of Perl test program
662    mkinstalldirs          script for making install directories    install-sh              a shell script for installing files
663    perltest.pl            Perl test program    libpcre.pc.in           template for libpcre.pc for pkg-config
664    pcre-config.in         source of script which retains PCRE information    libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config
665    pcrecpp_unittest.c           )    ltmain.sh               file used to build a libtool script
666    pcre_scanner_unittest.c      ) test programs for the C++ wrapper    missing                 ) common stub for a few missing GNU programs while
667    pcre_stringpiece_unittest.c  )                            )   installing, generated by automake
668    testdata/testinput*    test data for main library tests    mkinstalldirs           script for making install directories
669    testdata/testoutput*   expected test results    perltest.pl             Perl test program
670    testdata/grep*         input and output for pcregrep tests    pcre-config.in          source of script which retains PCRE information
671      pcrecpp_unittest.cc          )
672      pcre_scanner_unittest.cc     ) test programs for the C++ wrapper
673      pcre_stringpiece_unittest.cc )
674      testdata/testinput*     test data for main library tests
675      testdata/testoutput*    expected test results
676      testdata/grep*          input and output for pcregrep tests
677    
678  (D) Auxiliary files for cmake support  (D) Auxiliary files for cmake support
679    
680    CMakeLists.txt    CMakeLists.txt
681    config-cmake.h.in    config-cmake.h.in
682    
683  (E) Auxiliary files for VPASCAL  (E) Auxiliary files for VPASCAL
684    
685    makevp.bat    makevp.bat
686    !compile.txt    makevp_c.txt
687    !linklib.txt    makevp_l.txt
688    pcregexp.pas    pcregexp.pas
689    
690    (F) Auxiliary files for building PCRE "by hand"
691    
692      pcre.h.generic          ) a version of the public PCRE header file
693                              )   for use in non-"configure" environments
694      config.h.generic        ) a version of config.h for use in non-"configure"
695                              )   environments
696    
697  (F) Miscellaneous  (F) Miscellaneous
698    
699    RunTest.bat            a script for running tests under Windows    RunTest.bat            a script for running tests under Windows
# Line 634  The distribution should contain the foll Line 701  The distribution should contain the foll
701  Philip Hazel  Philip Hazel
702  Email local part: ph10  Email local part: ph10
703  Email domain: cam.ac.uk  Email domain: cam.ac.uk
704  Last updated: March 2007  Last updated: 26 March 2007

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

  ViewVC Help
Powered by ViewVC 1.1.5