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

Diff of /code/trunk/README

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

revision 75 by nigel, Sat Feb 24 21:40:37 2007 UTC revision 145 by ph10, Wed Apr 4 14:06:52 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:
14    
15  PCRE has its own native API, but a set of "wrapper" functions that are based on    The PCRE APIs
16  the POSIX API are also supplied in the library libpcreposix. Note that this    Documentation for PCRE
17  just provides a POSIX calling interface to PCRE: the regular expressions    Contributions by users of PCRE
18  themselves still follow Perl syntax and semantics. The header file    Building PCRE on non-Unix systems
19  for the POSIX-style functions is called pcreposix.h. The official POSIX name is    Building PCRE on Unix-like systems
20  regex.h, but I didn't want to risk possible problems with existing files of    Retrieving configuration information on Unix-like systems
21  that name by distributing it that way. To use it with an existing program that    Shared libraries on Unix-like systems
22  uses the POSIX API, it will have to be renamed or pointed at by a link.    Cross-compiling on Unix-like systems
23      Using HP's ANSI C++ compiler (aCC)
24      Making new tarballs
25      Testing PCRE
26      Character tables
27      File manifest
28    
29    
30    The PCRE APIs
31    -------------
32    
33    PCRE is written in C, and it has its own API. The distribution also includes a
34    set of C++ wrapper functions (see the pcrecpp man page for details), courtesy
35    of Google Inc.
36    
37    In addition, there is a set of C wrapper functions that are based on the POSIX
38    regular expression API (see the pcreposix man page). These end up in the
39    library called libpcreposix. Note that this just provides a POSIX calling
40    interface to PCRE; the regular expressions themselves still follow Perl syntax
41    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
45    official POSIX name is regex.h, but I did not want to risk possible problems
46    with existing files of that name by distributing it that way. To use PCRE with
47    an existing program that uses the POSIX API, pcreposix.h will have to be
48    renamed or pointed at by a link.
49    
50  If you are using the POSIX interface to PCRE and there is already a POSIX regex  If you are using the POSIX interface to PCRE and there is already a POSIX regex
51  library installed on your system, you must take care when linking programs to  library installed on your system, as well as worrying about the regex.h header
52    file (as mentioned above), you must also take care when linking programs to
53  ensure that they link with PCRE's libpcreposix library. Otherwise they may pick  ensure that they link with PCRE's libpcreposix library. Otherwise they may pick
54  up the "real" POSIX functions of the same name.  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
57    -Dregcomp=PCREregcomp (and similarly for the other POSIX functions) to the
58    compiler flags (CFLAGS if you are using "configure" -- see below). This has the
59    effect of renaming the functions so that the names no longer clash. Of course,
60    you have to do the same thing for your applications, or write them using the
61    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 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; however, as there is no standard place to install  documentation is supplied in two other forms:
71  them, they are left in the doc directory of the unpacked source distribution.  
72  These forms are:    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
74    1. Files called doc/pcre.txt, doc/pcregrep.txt, and doc/pcretest.txt. The       concatenation of the text forms of all the section 3 man pages except
75       first of these is a concatenation of the text forms of all the section 3       those that summarize individual functions. The other two are the text
76       man pages except those that summarize individual functions. The other two       forms of the section 1 man pages for the pcregrep and pcretest commands.
77       are the text forms of the section 1 man pages for the pcregrep and       These text forms are provided for ease of scanning with text editors or
78       pcretest commands. Text forms are provided for ease of scanning with text       similar tools. They are installed in <prefix>/share/doc/pcre, where
79       editors or similar tools.       <prefix> is the installation prefix (defaulting to /usr/local).
80    
81    2. A subdirectory called doc/html contains all the documentation in HTML    2. A set of files containing all the documentation in HTML form, hyperlinked
82       form, hyperlinked in various ways, and rooted in a file called       in various ways, and rooted in a file called index.html, is distributed in
83       doc/index.html.       doc/html and installed in <prefix>/share/doc/pcre/html.
84    
85    
86  Contributions by users of PCRE  Contributions by users of PCRE
# Line 51  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  Several of them provide support for compiling PCRE on various flavours of  complete in themselves; others are pointers to URLs containing relevant files.
95  Windows systems (I myself do not use Windows). Some are complete in themselves;  Some of this material is likely to be well out-of-date. Several of the earlier
96  others are pointers to URLs containing relevant files.  contributions provided support for compiling PCRE on various flavours of
97    Windows (I myself do not use Windows). Nowadays there is more Windows support
98    in the standard distribution, so these contibutions have been archived.
99    
100    
101    Building PCRE on non-Unix systems
102    ---------------------------------
103    
104    For a non-Unix system, please read the comments in the file NON-UNIX-USE,
105    though if your system supports the use of "configure" and "make" you may be
106    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
109    straightforward to build PCRE on any system that has a Standard C compiler and
110    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
117    in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.
118    
119    The following instructions assume the use of the widely used "configure, make,
120    make install" process. There is also some experimental support for "cmake" in
121    the PCRE distribution, but it is incomplete and not documented. However, if you
122    are a "cmake" user, you might want to try it.
123    
124  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
125  PCRE distribution directory, with your current directory set to the directory  PCRE distribution directory, with your current directory set to the directory
126  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
127  "autoconf" configuration script, for which generic instructions are supplied in  "autoconf" configuration script, for which generic instructions are supplied in
128  INSTALL.  the file INSTALL.
129    
130  Most commonly, people build PCRE within its own distribution directory, and in  Most commonly, people build PCRE within its own distribution directory, and in
131  this case, on many systems, just running "./configure" is sufficient, but the  this case, on many systems, just running "./configure" is sufficient. However,
132  usual methods of changing standard defaults are available. For example:  the usual methods of changing standard defaults are available. For example:
133    
134  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local
135    
# Line 83  into /source/pcre/pcre-xxx, but you want Line 144  into /source/pcre/pcre-xxx, but you want
144  cd /build/pcre/pcre-xxx  cd /build/pcre/pcre-xxx
145  /source/pcre/pcre-xxx/configure  /source/pcre/pcre-xxx/configure
146    
147    PCRE is written in C and is normally compiled as a C library. However, it is
148    possible to build it as a C++ library, though the provided building apparatus
149    does not have any features to support this.
150    
151  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
152  library. You can read more about them in the pcrebuild man page.  library. You can read more about them in the pcrebuild man page.
153    
154    . If you want to suppress the building of the C++ wrapper library, you can add
155      --disable-cpp to the "configure" command. Otherwise, when "configure" is run,
156      it will try to find a C++ compiler and C++ header files, and if it succeeds,
157      it will try to build the C++ wrapper.
158    
159  . 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,
160    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
161    for handling UTF-8 is not included in the library. (Even when included, it    for handling UTF-8 is not included in the library. (Even when included, it
# Line 94  library. You can read more about them in Line 164  library. You can read more about them in
164  . 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
165    support for the \P, \p, and \X sequences that recognize Unicode character    support for the \P, \p, and \X sequences that recognize Unicode character
166    properties, you must add --enable-unicode-properties to the "configure"    properties, you must add --enable-unicode-properties to the "configure"
167    command. This adds about 90K to the size of the library (in the form of a    command. This adds about 30K to the size of the library (in the form of a
168    property table); only the basic two-letter properties such as Lu are    property table); only the basic two-letter properties such as Lu are
169    supported.    supported.
170    
171  . You can build PCRE to recognized CR or NL as the newline character, instead  . You can build PCRE to recognize either CR or LF or the sequence CRLF or any
172    of whatever your compiler uses for "\n", by adding --newline-is-cr or    of the Unicode newline sequences as indicating the end of a line. Whatever
173    --newline-is-nl to the "configure" command, respectively. Only do this if you    you specify at build time is the default; the caller of PCRE can change the
174    really understand what you are doing. On traditional Unix-like systems, the    selection at run time. The default newline indicator is a single LF character
175    newline character is NL.    (the Unix standard). You can specify the default newline indicator by adding
176      --newline-is-cr or --newline-is-lf or --newline-is-crlf or --newline-is-any
177      to the "configure" command, respectively.
178    
179      If you specify --newline-is-cr or --newline-is-crlf, some of the standard
180      tests will fail, because the lines in the test files end with LF. Even if
181      the files are edited to change the line endings, there are likely to be some
182      failures. With --newline-is-any, many tests should succeed, but there may be
183      some failures.
184    
185  . When called via the POSIX interface, PCRE uses malloc() to get additional  . When called via the POSIX interface, PCRE uses malloc() to get additional
186    storage for processing capturing parentheses if there are more than 10 of    storage for processing capturing parentheses if there are more than 10 of
187    them. You can increase this threshold by setting, for example,    them in a pattern. You can increase this threshold by setting, for example,
188    
189    --with-posix-malloc-threshold=20    --with-posix-malloc-threshold=20
190    
191    on the "configure" command.    on the "configure" command.
192    
193  . PCRE has a counter which can be set to limit the amount of resources it uses.  . PCRE has a counter that can be set to limit the amount of resources it uses.
194    If the limit is exceeded during a match, the match fails. The default is ten    If the limit is exceeded during a match, the match fails. The default is ten
195    million. You can change the default by setting, for example,    million. You can change the default by setting, for example,
196    
197    --with-match-limit=500000    --with-match-limit=500000
198    
199    on the "configure" command. This is just the default; individual calls to    on the "configure" command. This is just the default; individual calls to
200    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
201    man page.    pcreapi man page.
202    
203    . There is a separate counter that limits the depth of recursive function calls
204      during a matching process. This also has a default of ten million, which is
205      essentially "unlimited". You can change the default by setting, for example,
206    
207      --with-match-limit-recursion=500000
208    
209      Recursive function calls use up the runtime stack; running out of stack can
210      cause programs to crash in strange ways. There is a discussion about stack
211      sizes in the pcrestack man page.
212    
213  . The default maximum compiled pattern size is around 64K. You can increase  . The default maximum compiled pattern size is around 64K. You can increase
214    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
215    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
216    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
217    (and 5 if you are using UTF-8) will fail. Part of the output of these tests    performance.
218    is a representation of the compiled pattern, and this changes with the link  
219    size.  . You can build PCRE so that its internal match() function that is called from
220      pcre_exec() does not call itself recursively. Instead, it uses memory blocks
221  . You can build PCRE so that its match() function does not call itself    obtained from the heap via the special functions pcre_stack_malloc() and
222    recursively. Instead, it uses blocks of data from the heap via special    pcre_stack_free() to save data that would otherwise be saved on the stack. To
223    functions pcre_stack_malloc() and pcre_stack_free() to save data that would    build PCRE like this, use
   otherwise be saved on the stack. To build PCRE like this, use  
224    
225    --disable-stack-for-recursion    --disable-stack-for-recursion
226    
227    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
228    necessary in environments with limited stack sizes.    necessary in environments with limited stack sizes. This applies only to the
229      pcre_exec() function; it does not apply to pcre_dfa_exec(), which does not
230      use deeply nested recursion. There is a discussion about stack sizes in the
231      pcrestack man page.
232    
233    . For speed, PCRE uses four tables for manipulating and identifying characters
234      whose code point values are less than 256. By default, it uses a set of
235      tables for ASCII encoding that is part of the distribution. If you specify
236    
237  The "configure" script builds seven files:    --enable-rebuild-chartables
238    
239  . pcre.h is build by copying pcre.in and making substitutions    a program called dftables is compiled and run in the default C locale when
240  . Makefile is built by copying Makefile.in and making substitutions.    you obey "make". It builds a source file called pcre_chartables.c. If you do
241  . config.h is built by copying config.in and making substitutions.    not specify this option, pcre_chartables.c is created as a copy of
242  . pcre-config is built by copying pcre-config.in and making substitutions.    pcre_chartables.c.dist. See "Character tables" below for further information.
243  . libpcre.pc is data for the pkg-config command, built from libpcre.pc.in  
244    . It is possible to compile PCRE for use on systems that use EBCDIC as their
245      default character code (as opposed to ASCII) by specifying
246    
247      --enable-ebcdic
248    
249      This automatically implies --enable-rebuild-chartables (see above).
250    
251    The "configure" script builds the following files for the basic C library:
252    
253    . Makefile is the makefile that builds the library
254    . config.h contains build-time configuration options for the library
255    . pcre.h is the public PCRE header file
256    . pcre-config is a script that shows the settings of "configure" options
257    . libpcre.pc is data for the pkg-config command
258  . libtool is a script that builds shared and/or static libraries  . libtool is a script that builds shared and/or static libraries
259  . RunTest is a script for running tests  . RunTest is a script for running tests on the basic C library
260    . RunGrepTest is a script for running tests on the pcregrep command
261    
262  Once "configure" has run, you can run "make". It builds two libraries called  Versions of config.h and pcre.h are distributed in the PCRE tarballs under
263  libpcre and libpcreposix, a test program called pcretest, and the pcregrep  the names config.h.generic and pcre.h.generic. These are provided for the
264  command. You can use "make install" to copy these, the public header files  benefit of those who have to built PCRE without the benefit of "configure". If
265  pcre.h and pcreposix.h, and the man pages to appropriate live directories on  you use "configure", the .generic versions are not used.
266  your system, in the normal way.  
267    If a C++ compiler is found, the following files are also built:
268    
269    . libpcrecpp.pc is data for the pkg-config command
270    . pcrecpparg.h is a header file for programs that call PCRE via the C++ wrapper
271    . pcre_stringpiece.h is the header for the C++ "stringpiece" functions
272    
273    The "configure" script also creates config.status, which is an executable
274    script that can be run to recreate the configuration, and config.log, which
275    contains compiler output from tests that "configure" runs.
276    
277    Once "configure" has run, you can run "make". It builds two libraries, called
278    libpcre and libpcreposix, a test program called pcretest, a demonstration
279    program called pcredemo, and the pcregrep command. If a C++ compiler was found
280    on your system, "make" also builds the C++ wrapper library, which is called
281    libpcrecpp, and some test programs called pcrecpp_unittest,
282    pcre_scanner_unittest, and pcre_stringpiece_unittest. Building the C++ wrapper
283    can be disabled by adding --disable-cpp to the "configure" command.
284    
285    The command "make check" runs all the appropriate tests. Details of the PCRE
286    tests are given below in a separate section of this document.
287    
288    You can use "make install" to install PCRE into live directories on your
289    system. The following are installed (file names are all relative to the
290    <prefix> that is set when "configure" is run):
291    
292      Commands (bin):
293        pcretest
294        pcregrep
295        pcre-config
296    
297      Libraries (lib):
298        libpcre
299        libpcreposix
300        libpcrecpp (if C++ support is enabled)
301    
302      Configuration information (lib/pkgconfig):
303        libpcre.pc
304        libpcrecpp.pc (if C++ support is enabled)
305    
306      Header files (include):
307        pcre.h
308        pcreposix.h
309        pcre_scanner.h      )
310        pcre_stringpiece.h  ) if C++ support is enabled
311        pcrecpp.h           )
312        pcrecpparg.h        )
313    
314      Man pages (share/man/man{1,3}):
315        pcregrep.1
316        pcretest.1
317        pcre.3
318        pcre*.3 (lots more pages, all starting "pcre")
319    
320      HTML documentation (share/doc/pcre/html):
321        index.html
322        *.html (lots more pages, hyperlinked from index.html)
323    
324      Text file documentation (share/doc/pcre):
325        AUTHORS
326        COPYING
327        ChangeLog
328        LICENCE
329        NEWS
330        README
331        pcre.txt       (a concatenation of the man(3) pages)
332        pcretest.txt   the pcretest man page
333        pcregrep.txt   the pcregrep man page
334    
335    Note that the pcredemo program that is built by "configure" is *not* installed
336    anywhere. It is a demonstration for programmers wanting to use PCRE.
337    
338    If you want to remove PCRE from your system, you can run "make uninstall".
339    This removes all the files that "make install" installed. However, it does not
340    remove any directories, because these are often shared with other programs.
341    
342    
343  Retrieving configuration information on Unix-like systems  Retrieving configuration information on Unix-like systems
344  ---------------------------------------------------------  ---------------------------------------------------------
345    
346  Running "make install" also installs the command pcre-config, which can be used  Running "make install" installs the command pcre-config, which can be used to
347  to recall information about the PCRE configuration and installation. For  recall information about the PCRE configuration and installation. For example:
 example:  
348    
349    pcre-config --version    pcre-config --version
350    
# Line 181  single command is used. For example: Line 363  single command is used. For example:
363    pkg-config --cflags pcre    pkg-config --cflags pcre
364    
365  The data is held in *.pc files that are installed in a directory called  The data is held in *.pc files that are installed in a directory called
366  pkgconfig.  <prefix>/lib/pkgconfig.
367    
368    
369  Shared libraries on Unix-like systems  Shared libraries on Unix-like systems
370  -------------------------------------  -------------------------------------
371    
372  The default distribution builds PCRE as two shared libraries and two static  The default distribution builds PCRE as shared libraries and static libraries,
373  libraries, as long as the operating system supports shared libraries. Shared  as long as the operating system supports shared libraries. Shared library
374  library support relies on the "libtool" script which is built as part of the  support relies on the "libtool" script which is built as part of the
375  "configure" process.  "configure" process.
376    
377  The libtool script is used to compile and link both shared and static  The libtool script is used to compile and link both shared and static
# Line 198  built. The programs pcretest and pcregre Line 380  built. The programs pcretest and pcregre
380  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
381  you use "make install" to install shared libraries, pcregrep and pcretest are  you use "make install" to install shared libraries, pcregrep and pcretest are
382  automatically re-built to use the newly installed shared libraries before being  automatically re-built to use the newly installed shared libraries before being
383  installed themselves. However, the versions left in the source directory still  installed themselves. However, the versions left in the build directory still
384  use the uninstalled libraries.  use the uninstalled libraries.
385    
386  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 210  Then run "make" in the usual way. Simila Line 392  Then run "make" in the usual way. Simila
392  build only shared libraries.  build only shared libraries.
393    
394    
395  Cross-compiling on a Unix-like system  Cross-compiling on Unix-like systems
396  -------------------------------------  ------------------------------------
397    
398  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
399  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
400  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
401  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
402  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,
403  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
404  when calling the "configure" command. If they are not specified, they default  compiler.
405  to the values of CC and CFLAGS.  
406    When --enable-rebuild-chartables is not specified, pcre_chartables.c is created
407    by making a copy of pcre_chartables.c.dist, which is a default set of tables
408  Building on non-Unix systems  that assumes ASCII code. Cross-compiling with the default tables should not be
409  ----------------------------  a problem.
410    
411  For a non-Unix system, read the comments in the file NON-UNIX-USE, though if  If you need to modify the character tables when cross-compiling, you should
412  the system supports the use of "configure" and "make" you may be able to build  move pcre_chartables.c.dist out of the way, then compile dftables.c by hand and
413  PCRE in the same way as for Unix systems.  run it on the local host to make a new version of pcre_chartables.c.dist.
414    Then when you cross-compile PCRE this new version of the tables will be used.
415  PCRE has been compiled on Windows systems and on Macintoshes, but I don't know  
416  the details because I don't use those systems. It should be straightforward to  
417  build PCRE on any system that has a Standard C compiler, because it uses only  Using HP's ANSI C++ compiler (aCC)
418  Standard C functions.  ----------------------------------
419    
420    Unless C++ support is disabled by specifying the "--disable-cpp" option of the
421    "configure" script, you must include the "-AA" option in the CXXFLAGS
422    environment variable in order for the C++ components to compile correctly.
423    
424    Also, note that the aCC compiler on PA-RISC platforms may have a defect whereby
425    needed libraries fail to get included when specifying the "-AA" compiler
426    option. If you experience unresolved symbols when linking the C++ programs,
427    use the workaround of specifying the following environment variable prior to
428    running the "configure" script:
429    
430      CXXLDFLAGS="-lstd_v2 -lCsup_v2"
431    
432    
433    Making new tarballs
434    -------------------
435    
436    The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and
437    zip formats. However, if you have modified any of the man page sources in the
438    doc directory, you should first run the PrepareRelease script. This re-creates
439    the .txt and HTML forms of the documentation from the man pages.
440    
441    
442  Testing PCRE  Testing PCRE
443  ------------  ------------
444    
445  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
446  configuring process. (This can also be run by "make runtest", "make check", or  created by the configuring process. There is also a script called RunGrepTest
447  "make test".) For other systems, see the instructions in NON-UNIX-USE.  that tests the options of the pcregrep command. If the C++ wrapper library is
448    built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and
449  The script runs the pcretest test program (which is documented in its own man  pcre_stringpiece_unittest are also built.
450  page) on each of the testinput files (in the testdata directory) in turn,  
451  and compares the output with the contents of the corresponding testoutput file.  Both the scripts and all the program tests are run if you obey "make check" or
452  A file called testtry is used to hold the main output from pcretest  "make test". For other systems, see the instructions in NON-UNIX-USE.
453    
454    The RunTest script runs the pcretest test program (which is documented in its
455    own man page) on each of the testinput files in the testdata directory in
456    turn, and compares the output with the contents of the corresponding testoutput
457    files. A file called testtry is used to hold the main output from pcretest
458  (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
459  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:
460    
461    RunTest 2    RunTest 2
462    
463  The first file can also be fed directly into the perltest script to check that  The first test file can also be fed directly into the perltest.pl script to
464  Perl gives the same results. The only difference you should see is in the first  check that Perl gives the same results. The only difference you should see is
465  few lines, where the Perl version is given instead of the PCRE version.  in the first few lines, where the Perl version is given instead of the PCRE
466    version.
467    
468  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),
469  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
470  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
471  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
472  pcre_compile().  pcre_compile().
473    
474  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 285  is output to say why. If running this te Line 494  is output to say why. If running this te
494  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,
495  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.
496    
497    [If you are trying to run this test on Windows, you may be able to get it to
498    work by changing "fr_FR" to "french" everywhere it occurs.]
499    
500  The fourth test checks the UTF-8 support. It is not run automatically unless  The fourth test checks the UTF-8 support. It is not run automatically unless
501  PCRE is built with UTF-8 support. To do this you must set --enable-utf8 when  PCRE is built with UTF-8 support. To do this you must set --enable-utf8 when
502  running "configure". This file can be also fed directly to the perltest script,  running "configure". This file can be also fed directly to the perltest script,
# Line 294  commented in the script, can be be used. Line 506  commented in the script, can be be used.
506  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
507  features of PCRE that are not relevant to Perl.  features of PCRE that are not relevant to Perl.
508    
509  The sixth and final test checks the support for Unicode character properties.  The sixth test checks the support for Unicode character properties. It it not
510  It it not run automatically unless PCRE is built with Unicode property support.  run automatically unless PCRE is built with Unicode property support. To to
511  To to this you must set --enable-unicode-properties when running "configure".  this you must set --enable-unicode-properties when running "configure".
512    
513    The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative
514    matching function, in non-UTF-8 mode, UTF-8 mode, and UTF-8 mode with Unicode
515    property support, respectively. The eighth and ninth tests are not run
516    automatically unless PCRE is build with the relevant support.
517    
518    
519  Character tables  Character tables
520  ----------------  ----------------
521    
522  PCRE uses four tables for manipulating and identifying characters whose values  For speed, PCRE uses four tables for manipulating and identifying characters
523  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
524  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
525  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
526  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
527  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.
528    
529  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
530  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
531  (compiled from dftables.c), which uses the ANSI C character handling functions  tables for ASCII coding. However, if --enable-rebuild-chartables is specified
532  such as isalnum(), isalpha(), isupper(), islower(), etc. to build the table  for ./configure, a different version of pcre_chartables.c is built by the
533  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
534  control the contents of these default tables. You can change the default tables  handling functions such as isalnum(), isalpha(), isupper(), islower(), etc. to
535  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
536  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
537  re-generated.  the default tables by editing pcre_chartables.c and then re-building PCRE. If
538    you do this, you should take care to ensure that the file does not get
539    automatically re-generated. The best way to do this is to move
540    pcre_chartables.c.dist out of the way and replace it with your customized
541    tables.
542    
543    When the dftables program is run as a result of --enable-rebuild-chartables,
544    it uses the default C locale that is set on your system. It does not pay
545    attention to the LC_xxx environment variables. In other words, it uses the
546    system's default locale rather than whatever the compiling user happens to have
547    set. If you really do want to build a source set of character tables in a
548    locale that is specified by the LC_xxx variables, you can run the dftables
549    program by hand with the -L option. For example:
550    
551      ./dftables -L pcre_chartables.c.special
552    
553  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,
554  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
555  digits, "word" characters, and white space, respectively. These are used when  digits, "word" characters, and white space, respectively. These are used when
556  building 32-byte bit maps that represent character classes.  building 32-byte bit maps that represent character classes for code points less
557    than 256.
558    
559  The final 256-byte table has bits indicating various character types, as  The final 256-byte table has bits indicating various character types, as
560  follows:  follows:
# Line 338  You should not alter the set of characte Line 570  You should not alter the set of characte
570  will cause PCRE to malfunction.  will cause PCRE to malfunction.
571    
572    
573  Manifest  File manifest
574  --------  -------------
575    
576  The distribution should contain the following files:  The distribution should contain the following files:
577    
578  (A) The actual source files of the PCRE library functions and their  (A) Source files of the PCRE library functions and their headers:
579      headers:  
580      dftables.c              auxiliary program for building pcre_chartables.c
581                                when --enable-rebuild-chartables is specified
582    
583    dftables.c            auxiliary program for building chartables.c    pcre_chartables.c.dist  a default set of character tables that assume ASCII
584                                coding; used, unless --enable-rebuild-chartables is
585                                specified, by copying to pcre_chartables.c
586    
587      pcreposix.c             )
588      pcre_compile.c          )
589      pcre_config.c           )
590      pcre_dfa_exec.c         )
591      pcre_exec.c             )
592      pcre_fullinfo.c         )
593      pcre_get.c              ) sources for the functions in the library,
594      pcre_globals.c          )   and some internal functions that they use
595      pcre_info.c             )
596      pcre_maketables.c       )
597      pcre_newline.c          )
598      pcre_ord2utf8.c         )
599      pcre_refcount.c         )
600      pcre_study.c            )
601      pcre_tables.c           )
602      pcre_try_flipped.c      )
603      pcre_ucp_searchfuncs.c  )
604      pcre_valid_utf8.c       )
605      pcre_version.c          )
606      pcre_xclass.c           )
607      pcre_printint.src       ) debugging function that is #included in pcretest,
608                              )   and can also be #included in pcre_compile()
609      pcre.h.in               template for pcre.h when built by "configure"
610      pcreposix.h             header for the external POSIX wrapper API
611      pcre_internal.h         header for internal use
612      ucp.h                   ) headers concerned with
613      ucpinternal.h           )   Unicode property handling
614      ucptable.h              ) (this one is the data table)
615    
616      config.h.in             template for config.h, which is built by "configure"
617    
618      pcrecpp.h               public header file for the C++ wrapper
619      pcrecpparg.h.in         template for another C++ header file
620      pcre_scanner.h          public header file for C++ scanner functions
621      pcrecpp.cc              )
622      pcre_scanner.cc         ) source for the C++ wrapper library
623    
624      pcre_stringpiece.h.in   template for pcre_stringpiece.h, the header for the
625                                C++ stringpiece functions
626      pcre_stringpiece.cc     source for the C++ stringpiece functions
627    
628    (B) Source files for programs that use PCRE:
629    
630      pcredemo.c              simple demonstration of coding calls to PCRE
631      pcregrep.c              source of a grep utility that uses PCRE
632      pcretest.c              comprehensive test program
633    
634    (C) Auxiliary files:
635    
636      132html                 script to turn "man" pages into HTML
637      AUTHORS                 information about the author of PCRE
638      ChangeLog               log of changes to the code
639      CleanTxt                script to clean nroff output for txt man pages
640      Detrail                 script to remove trailing spaces
641      HACKING                 some notes about the internals of PCRE
642      INSTALL                 generic installation instructions
643      LICENCE                 conditions for the use of PCRE
644      COPYING                 the same, using GNU's standard name
645      Makefile.in             ) template for Unix Makefile, which is built by
646                              )   "configure"
647      Makefile.am             ) the automake input that was used to create
648                              )   Makefile.in
649      NEWS                    important changes in this release
650      NON-UNIX-USE            notes on building PCRE on non-Unix systems
651      PrepareRelease          script to make preparations for "make dist"
652      README                  this file
653      RunTest                 a Unix shell script for running tests
654      RunGrepTest             a Unix shell script for pcregrep tests
655      aclocal.m4              m4 macros (generated by "aclocal")
656      config.guess            ) files used by libtool,
657      config.sub              )   used only when building a shared library
658      configure               a configuring shell script (built by autoconf)
659      configure.ac            ) the autoconf input that was used to build
660                              )   "configure" and config.h
661      depcomp                 ) script to find program dependencies, generated by
662                              )   automake
663      doc/*.3                 man page sources for the PCRE functions
664      doc/*.1                 man page sources for pcregrep and pcretest
665      doc/index.html.src      the base HTML page
666      doc/html/*              HTML documentation
667      doc/pcre.txt            plain text version of the man pages
668      doc/pcretest.txt        plain text documentation of test program
669      doc/perltest.txt        plain text documentation of Perl test program
670      install-sh              a shell script for installing files
671      libpcre.pc.in           template for libpcre.pc for pkg-config
672      libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config
673      ltmain.sh               file used to build a libtool script
674      missing                 ) common stub for a few missing GNU programs while
675                              )   installing, generated by automake
676      mkinstalldirs           script for making install directories
677      perltest.pl             Perl test program
678      pcre-config.in          source of script which retains PCRE information
679      pcrecpp_unittest.cc          )
680      pcre_scanner_unittest.cc     ) test programs for the C++ wrapper
681      pcre_stringpiece_unittest.cc )
682      testdata/testinput*     test data for main library tests
683      testdata/testoutput*    expected test results
684      testdata/grep*          input and output for pcregrep tests
685    
686    get.c                 )  (D) Auxiliary files for cmake support
   maketables.c          )  
   study.c               ) source of the functions  
   pcre.c                )   in the library  
   pcreposix.c           )  
   printint.c            )  
   
   ucp.c                 )  
   ucp.h                 ) source for the code that is used for  
   ucpinternal.h         )   Unicode property handling  
   ucptable.c            )  
   ucptypetable.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  
   internal.h            header for internal use  
   config.in             template for config.h, which is built by configure  
   
 (B) Auxiliary files:  
   
   AUTHORS               information about the author of PCRE  
   ChangeLog             log of changes to the code  
   INSTALL               generic installation instructions  
   LICENCE               conditions for the use of PCRE  
   COPYING               the same, using GNU's standard name  
   Makefile.in           template for Unix Makefile, which is built by configure  
   NEWS                  important changes in this release  
   NON-UNIX-USE          notes on building PCRE on non-Unix systems  
   README                this file  
   RunTest.in            template for a Unix shell script for running tests  
   config.guess          ) files used by libtool,  
   config.sub            )   used only when building a shared library  
   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/*.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  
   libpcre.pc.in         "source" for libpcre.pc for pkg-config  
   ltmain.sh             file used to build a libtool script  
   mkinstalldirs         script for making install directories  
   pcretest.c            comprehensive test program  
   pcredemo.c            simple demonstration of coding calls to PCRE  
   perltest              Perl test program  
   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  
   testdata/testinput2   test data for error messages and non-Perl things  
   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/testinput6   test data for Unicode property support 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  
   libpcre.def  
   libpcreposix.def  
   pcre.def  
687    
688  (D) Auxiliary file for VPASCAL    CMakeLists.txt
689      config-cmake.h.in
690    
691    (E) Auxiliary files for VPASCAL
692    
693    makevp.bat    makevp.bat
694      makevp_c.txt
695      makevp_l.txt
696      pcregexp.pas
697    
698    (F) Auxiliary files for building PCRE "by hand"
699    
700      pcre.h.generic          ) a version of the public PCRE header file
701                              )   for use in non-"configure" environments
702      config.h.generic        ) a version of config.h for use in non-"configure"
703                              )   environments
704    
705    (F) Miscellaneous
706    
707      RunTest.bat            a script for running tests under Windows
708    
709  Philip Hazel <ph10@cam.ac.uk>  Philip Hazel
710  September 2004  Email local part: ph10
711    Email domain: cam.ac.uk
712    Last updated: 29 March 2007

Legend:
Removed from v.75  
changed lines
  Added in v.145

  ViewVC Help
Powered by ViewVC 1.1.5