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

Diff of /code/trunk/README

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

revision 691 by ph10, Sun Sep 11 14:31:21 2011 UTC revision 981 by ph10, Mon Jun 18 18:22:51 2012 UTC
# Line 18  The contents of this README file are: Line 18  The contents of this README file are:
18    The PCRE APIs    The PCRE APIs
19    Documentation for PCRE    Documentation for PCRE
20    Contributions by users of PCRE    Contributions by users of PCRE
21    Building PCRE on non-Unix systems    Building PCRE on non-Unix-like systems
22    Building PCRE on Unix-like systems    Building PCRE without using autotools
23    Retrieving configuration information on Unix-like systems    Building PCRE using autotools
24    Shared libraries on Unix-like systems    Retrieving configuration information
25    Cross-compiling on Unix-like systems    Shared libraries
26      Cross-compiling using autotools
27    Using HP's ANSI C++ compiler (aCC)    Using HP's ANSI C++ compiler (aCC)
28    Using PCRE from MySQL    Using PCRE from MySQL
29    Making new tarballs    Making new tarballs
# Line 34  The contents of this README file are: Line 35  The contents of this README file are:
35  The PCRE APIs  The PCRE APIs
36  -------------  -------------
37    
38  PCRE is written in C, and it has its own API. The distribution also includes a  PCRE is written in C, and it has its own API. There are two sets of functions,
39  set of C++ wrapper functions (see the pcrecpp man page for details), courtesy  one for the 8-bit library, which processes strings of bytes, and one for the
40  of Google Inc.  16-bit library, which processes strings of 16-bit values. The distribution also
41    includes a set of C++ wrapper functions (see the pcrecpp man page for details),
42  In addition, there is a set of C wrapper functions that are based on the POSIX  courtesy of Google Inc., which can be used to call the 8-bit PCRE library from
43  regular expression API (see the pcreposix man page). These end up in the  C++.
44  library called libpcreposix. Note that this just provides a POSIX calling  
45  interface to PCRE; the regular expressions themselves still follow Perl syntax  In addition, there is a set of C wrapper functions (again, just for the 8-bit
46  and semantics. The POSIX API is restricted, and does not give full access to  library) that are based on the POSIX regular expression API (see the pcreposix
47  all of PCRE's facilities.  man page). These end up in the library called libpcreposix. Note that this just
48    provides a POSIX calling interface to PCRE; the regular expressions themselves
49    still follow Perl syntax and semantics. The POSIX API is restricted, and does
50    not give full access to all of PCRE's facilities.
51    
52  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
53  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 106  Windows (I myself do not use Windows). N Line 110  Windows (I myself do not use Windows). N
110  in the standard distribution, so these contibutions have been archived.  in the standard distribution, so these contibutions have been archived.
111    
112    
113  Building PCRE on non-Unix systems  Building PCRE on non-Unix-like systems
114  ---------------------------------  --------------------------------------
115    
116  For a non-Unix system, please read the comments in the file NON-UNIX-USE,  For a non-Unix-like system, please read the comments in the file
117  though if your system supports the use of "configure" and "make" you may be  NON-AUTOTOOLS-BUILD, though if your system supports the use of "configure" and
118  able to build PCRE in the same way as for Unix-like systems. PCRE can also be  "make" you may be able to build PCRE using autotools in the same way as for
119  configured in many platform environments using the GUI facility provided by  many Unix-like systems.
120  CMake's cmake-gui command. This creates Makefiles, solution files, etc.  
121    PCRE can also be configured using the GUI facility provided by CMake's
122    cmake-gui command. This creates Makefiles, solution files, etc. The file
123    NON-AUTOTOOLS-BUILD has information about CMake.
124    
125  PCRE has been compiled on many different operating systems. It should be  PCRE has been compiled on many different operating systems. It should be
126  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
127  library, because it uses only Standard C functions.  library, because it uses only Standard C functions.
128    
129    
130  Building PCRE on Unix-like systems  Building PCRE without using autotools
131  ----------------------------------  -------------------------------------
132    
133    The use of autotools (in particular, libtool) is problematic in some
134    environments, even some that are Unix or Unix-like. See the NON-AUTOTOOLS-BUILD
135    file for ways of building PCRE without using autotools.
136    
137    
138    Building PCRE using autotools
139    -----------------------------
140    
141  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
142  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.
143    
144  The following instructions assume the use of the widely used "configure, make,  The following instructions assume the use of the widely used "configure; make;
145  make install" process. There is also support for CMake in the PCRE  make install" (autotools) process.
146  distribution; there are some comments about using CMake in the NON-UNIX-USE  
147  file, though it can also be used in Unix-like systems.  To build PCRE on system that supports autotools, first run the "configure"
148    command from the PCRE distribution directory, with your current directory set
149  To build PCRE on a Unix-like system, first run the "configure" command from the  to the directory where you want the files to be created. This command is a
150  PCRE distribution directory, with your current directory set to the directory  standard GNU "autoconf" configuration script, for which generic instructions
151  where you want the files to be created. This command is a standard GNU  are supplied in the file INSTALL.
 "autoconf" configuration script, for which generic instructions are supplied in  
 the file INSTALL.  
152    
153  Most commonly, people build PCRE within its own distribution directory, and in  Most commonly, people build PCRE within its own distribution directory, and in
154  this case, on many systems, just running "./configure" is sufficient. However,  this case, on many systems, just running "./configure" is sufficient. However,
# Line 143  the usual methods of changing standard d Line 156  the usual methods of changing standard d
156    
157  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local
158    
159  specifies that the C compiler should be run with the flags '-O2 -Wall' instead  This command specifies that the C compiler should be run with the flags '-O2
160  of the default, and that "make install" should install PCRE under /opt/local  -Wall' instead of the default, and that "make install" should install PCRE
161  instead of the default /usr/local.  under /opt/local instead of the default /usr/local.
162    
163  If you want to build in a different directory, just run "configure" with that  If you want to build in a different directory, just run "configure" with that
164  directory as current. For example, suppose you have unpacked the PCRE source  directory as current. For example, suppose you have unpacked the PCRE source
# Line 169  library. They are also documented in the Line 182  library. They are also documented in the
182    
183    (See also "Shared libraries on Unix-like systems" below.)    (See also "Shared libraries on Unix-like systems" below.)
184    
185  . If you want to suppress the building of the C++ wrapper library, you can add  . By default, only the 8-bit library is built. If you add --enable-pcre16 to
186    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,    the "configure" command, the 16-bit library is also built. If you want only
187    it will try to find a C++ compiler and C++ header files, and if it succeeds,    the 16-bit library, use "./configure --enable-pcre16 --disable-pcre8".
188    it will try to build the C++ wrapper.  
189    . If you are building the 8-bit library and want to suppress the building of
190      the C++ wrapper library, you can add --disable-cpp to the "configure"
191      command. Otherwise, when "configure" is run without --disable-pcre8, it will
192      try to find a C++ compiler and C++ header files, and if it succeeds, it will
193      try to build the C++ wrapper.
194    
195  . If you want to include support for just-in-time compiling, which can give  . If you want to include support for just-in-time compiling, which can give
196    large performance improvements on certain platforms, add --enable-jit to the    large performance improvements on certain platforms, add --enable-jit to the
# Line 184  library. They are also documented in the Line 202  library. They are also documented in the
202    you add --disable-pcregrep-jit to the "configure" command.    you add --disable-pcregrep-jit to the "configure" command.
203    
204  . If you want to make use of the support for UTF-8 Unicode character strings in  . If you want to make use of the support for UTF-8 Unicode character strings in
205    PCRE, you must add --enable-utf8 to the "configure" command. Without it, the    the 8-bit library, or UTF-16 Unicode character strings in the 16-bit library,
206    code for handling UTF-8 is not included in the library. Even when included,    you must add --enable-utf to the "configure" command. Without it, the code
207    it still has to be enabled by an option at run time. When PCRE is compiled    for handling UTF-8 and UTF-16 is not included in the relevant library. Even
208    with this option, its input can only either be ASCII or UTF-8, even when    when --enable-utf is included, the use of a UTF encoding still has to be
209    running on EBCDIC platforms. It is not possible to use both --enable-utf8 and    enabled by an option at run time. When PCRE is compiled with this option, its
210    --enable-ebcdic at the same time.    input can only either be ASCII or UTF-8/16, even when running on EBCDIC
211      platforms. It is not possible to use both --enable-utf and --enable-ebcdic at
212  . If, in addition to support for UTF-8 character strings, you want to include    the same time.
213    support for the \P, \p, and \X sequences that recognize Unicode character  
214    properties, you must add --enable-unicode-properties to the "configure"  . There are no separate options for enabling UTF-8 and UTF-16 independently
215    command. This adds about 30K to the size of the library (in the form of a    because that would allow ridiculous settings such as requesting UTF-16
216    property table); only the basic two-letter properties such as Lu are    support while building only the 8-bit library. However, the option
217    supported.    --enable-utf8 is retained for backwards compatibility with earlier releases
218      that did not support 16-bit character strings. It is synonymous with
219      --enable-utf. It is not possible to configure one library with UTF support
220      and the other without in the same configuration.
221    
222    . If, in addition to support for UTF-8/16 character strings, you want to
223      include support for the \P, \p, and \X sequences that recognize Unicode
224      character properties, you must add --enable-unicode-properties to the
225      "configure" command. This adds about 30K to the size of the library (in the
226      form of a property table); only the basic two-letter properties such as Lu
227      are supported.
228    
229  . You can build PCRE to recognize either CR or LF or the sequence CRLF or any  . You can build PCRE to recognize either CR or LF or the sequence CRLF or any
230    of the preceding, or any of the Unicode newline sequences as indicating the    of the preceding, or any of the Unicode newline sequences as indicating the
# Line 249  library. They are also documented in the Line 277  library. They are also documented in the
277    sizes in the pcrestack man page.    sizes in the pcrestack man page.
278    
279  . The default maximum compiled pattern size is around 64K. You can increase  . The default maximum compiled pattern size is around 64K. You can increase
280    this by adding --with-link-size=3 to the "configure" command. You can    this by adding --with-link-size=3 to the "configure" command. In the 8-bit
281    increase it even more by setting --with-link-size=4, but this is unlikely    library, PCRE then uses three bytes instead of two for offsets to different
282    ever to be necessary. Increasing the internal link size will reduce    parts of the compiled pattern. In the 16-bit library, --with-link-size=3 is
283    performance.    the same as --with-link-size=4, which (in both libraries) uses four-byte
284      offsets. Increasing the internal link size reduces performance.
285    
286  . 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
287    pcre_exec() does not call itself recursively. Instead, it uses memory blocks    pcre_exec() does not call itself recursively. Instead, it uses memory blocks
# Line 287  library. They are also documented in the Line 316  library. They are also documented in the
316    
317    This automatically implies --enable-rebuild-chartables (see above). However,    This automatically implies --enable-rebuild-chartables (see above). However,
318    when PCRE is built this way, it always operates in EBCDIC. It cannot support    when PCRE is built this way, it always operates in EBCDIC. It cannot support
319    both EBCDIC and UTF-8.    both EBCDIC and UTF-8/16.
320    
321  . It is possible to compile pcregrep to use libz and/or libbz2, in order to  . The pcregrep program currently supports only 8-bit data files, and so
322    read .gz and .bz2 files (respectively), by specifying one or both of    requires the 8-bit PCRE library. It is possible to compile pcregrep to use
323      libz and/or libbz2, in order to read .gz and .bz2 files (respectively), by
324      specifying one or both of
325    
326    --enable-pcregrep-libz    --enable-pcregrep-libz
327    --enable-pcregrep-libbz2    --enable-pcregrep-libbz2
# Line 305  library. They are also documented in the Line 336  library. They are also documented in the
336    The default value is 20K.    The default value is 20K.
337    
338  . It is possible to compile pcretest so that it links with the libreadline  . It is possible to compile pcretest so that it links with the libreadline
339    library, by specifying    or libedit libraries, by specifying, respectively,
340    
341    --enable-pcretest-libreadline    --enable-pcretest-libreadline or --enable-pcretest-libedit
342    
343    If this is done, when pcretest's input is from a terminal, it reads it using    If this is done, when pcretest's input is from a terminal, it reads it using
344    the readline() function. This provides line-editing and history facilities.    the readline() function. This provides line-editing and history facilities.
345    Note that libreadline is GPL-licenced, so if you distribute a binary of    Note that libreadline is GPL-licenced, so if you distribute a binary of
346    pcretest linked in this way, there may be licensing issues.    pcretest linked in this way, there may be licensing issues. These can be
347      avoided by linking with libedit (which has a BSD licence) instead.
348    
349    Setting this option causes the -lreadline option to be added to the pcretest    Enabling libreadline causes the -lreadline option to be added to the pcretest
350    build. In many operating environments with a sytem-installed readline    build. In many operating environments with a sytem-installed readline
351    library this is sufficient. However, in some environments (e.g. if an    library this is sufficient. However, in some environments (e.g. if an
352    unmodified distribution version of readline is in use), it may be necessary    unmodified distribution version of readline is in use), it may be necessary
# Line 333  The "configure" script builds the follow Line 365  The "configure" script builds the follow
365  . pcre-config          script that shows the building settings such as CFLAGS  . pcre-config          script that shows the building settings such as CFLAGS
366                           that were set for "configure"                           that were set for "configure"
367  . libpcre.pc         ) data for the pkg-config command  . libpcre.pc         ) data for the pkg-config command
368    . libpcre16.pc       )
369  . libpcreposix.pc    )  . libpcreposix.pc    )
370  . libtool              script that builds shared and/or static libraries  . libtool              script that builds shared and/or static libraries
 . RunTest              script for running tests on the basic C library  
 . RunGrepTest          script for running tests on the pcregrep command  
371    
372  Versions of config.h and pcre.h are distributed in the PCRE tarballs under the  Versions of config.h and pcre.h are distributed in the PCRE tarballs under the
373  names config.h.generic and pcre.h.generic. These are provided for those who  names config.h.generic and pcre.h.generic. These are provided for those who
374  have to built PCRE without using "configure" or CMake. If you use "configure"  have to built PCRE without using "configure" or CMake. If you use "configure"
375  or CMake, the .generic versions are not used.  or CMake, the .generic versions are not used.
376    
377  If a C++ compiler is found, the following files are also built:  When building the 8-bit library, if a C++ compiler is found, the following
378    files are also built:
379    
380  . libpcrecpp.pc        data for the pkg-config command  . libpcrecpp.pc        data for the pkg-config command
381  . pcrecpparg.h         header file for calling PCRE via the C++ wrapper  . pcrecpparg.h         header file for calling PCRE via the C++ wrapper
# Line 353  The "configure" script also creates conf Line 385  The "configure" script also creates conf
385  script that can be run to recreate the configuration, and config.log, which  script that can be run to recreate the configuration, and config.log, which
386  contains compiler output from tests that "configure" runs.  contains compiler output from tests that "configure" runs.
387    
388  Once "configure" has run, you can run "make". It builds two libraries, called  Once "configure" has run, you can run "make". This builds either or both of the
389  libpcre and libpcreposix, a test program called pcretest, and the pcregrep  libraries libpcre and libpcre16, and a test program called pcretest. If you
390  command. If a C++ compiler was found on your system, and you did not disable it  enabled JIT support with --enable-jit, a test program called pcre_jit_test is
391  with --disable-cpp, "make" also builds the C++ wrapper library, which is called  built as well.
392  libpcrecpp, and some test programs called pcrecpp_unittest,  
393  pcre_scanner_unittest, and pcre_stringpiece_unittest. If you enabled JIT  If the 8-bit library is built, libpcreposix and the pcregrep command are also
394  support with --enable-jit, a test program called pcre_jit_test is also built.  built, and if a C++ compiler was found on your system, and you did not disable
395    it with --disable-cpp, "make" builds the C++ wrapper library, which is called
396    libpcrecpp, as well as some test programs called pcrecpp_unittest,
397    pcre_scanner_unittest, and pcre_stringpiece_unittest.
398    
399  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
400  tests are given below in a separate section of this document.  tests are given below in a separate section of this document.
# Line 370  system. The following are installed (fil Line 405  system. The following are installed (fil
405    
406    Commands (bin):    Commands (bin):
407      pcretest      pcretest
408      pcregrep      pcregrep (if 8-bit support is enabled)
409      pcre-config      pcre-config
410    
411    Libraries (lib):    Libraries (lib):
412      libpcre      libpcre16     (if 16-bit support is enabled)
413      libpcreposix      libpcre       (if 8-bit support is enabled)
414      libpcrecpp (if C++ support is enabled)      libpcreposix  (if 8-bit support is enabled)
415        libpcrecpp    (if 8-bit and C++ support is enabled)
416    
417    Configuration information (lib/pkgconfig):    Configuration information (lib/pkgconfig):
418        libpcre16.pc
419      libpcre.pc      libpcre.pc
420      libpcreposix.pc      libpcreposix.pc
421      libpcrecpp.pc (if C++ support is enabled)      libpcrecpp.pc (if C++ support is enabled)
# Line 419  This removes all the files that "make in Line 456  This removes all the files that "make in
456  remove any directories, because these are often shared with other programs.  remove any directories, because these are often shared with other programs.
457    
458    
459  Retrieving configuration information on Unix-like systems  Retrieving configuration information
460  ---------------------------------------------------------  ------------------------------------
461    
462  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
463  recall information about the PCRE configuration and installation. For example:  recall information about the PCRE configuration and installation. For example:
# Line 445  The data is held in *.pc files that are Line 482  The data is held in *.pc files that are
482  <prefix>/lib/pkgconfig.  <prefix>/lib/pkgconfig.
483    
484    
485  Shared libraries on Unix-like systems  Shared libraries
486  -------------------------------------  ----------------
487    
488  The default distribution builds PCRE as shared libraries and static libraries,  The default distribution builds PCRE as shared libraries and static libraries,
489  as long as the operating system supports shared libraries. Shared library  as long as the operating system supports shared libraries. Shared library
# Line 471  Then run "make" in the usual way. Simila Line 508  Then run "make" in the usual way. Simila
508  build only shared libraries.  build only shared libraries.
509    
510    
511  Cross-compiling on Unix-like systems  Cross-compiling using autotools
512  ------------------------------------  -------------------------------
513    
514  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
515  order to cross-compile PCRE for some other host. However, you should NOT  order to cross-compile PCRE for some other host. However, you should NOT
# Line 544  script creates the .txt and HTML forms o Line 581  script creates the .txt and HTML forms o
581  Testing PCRE  Testing PCRE
582  ------------  ------------
583    
584  To test the basic PCRE library on a Unix system, run the RunTest script that is  To test the basic PCRE library on a Unix-like system, run the RunTest script.
585  created by the configuring process. There is also a script called RunGrepTest  There is another script called RunGrepTest that tests the options of the
586  that tests the options of the pcregrep command. If the C++ wrapper library is  pcregrep command. If the C++ wrapper library is built, three test programs
587  built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and  called pcrecpp_unittest, pcre_scanner_unittest, and pcre_stringpiece_unittest
588  pcre_stringpiece_unittest are also built. When JIT support is enabled, another  are also built. When JIT support is enabled, another test program called
589  test program called pcre_jit_test is built.  pcre_jit_test is built.
590    
591  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
592  "make test". For other systems, see the instructions in NON-UNIX-USE.  "make test". For other environments, see the instructions in
593    NON-AUTOTOOLS-BUILD.
594    
595  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
596  own man page) on each of the relevant testinput files in the testdata  own man page) on each of the relevant testinput files in the testdata
597  directory, and compares the output with the contents of the corresponding  directory, and compares the output with the contents of the corresponding
598  testoutput files. Some tests are relevant only when certain build-time options  testoutput files. Some tests are relevant only when certain build-time options
599  were selected. For example, the tests for UTF-8 support are run only if  were selected. For example, the tests for UTF-8/16 support are run only if
600  --enable-utf8 was used. RunTest outputs a comment when it skips a test.  --enable-utf was used. RunTest outputs a comment when it skips a test.
601    
602  Many of the tests that are not skipped are run up to three times. The second  Many of the tests that are not skipped are run up to three times. The second
603  run forces pcre_study() to be called for all patterns except for a few in some  run forces pcre_study() to be called for all patterns except for a few in some
# Line 567  tests that are marked "never study" (see Line 605  tests that are marked "never study" (see
605  done). If JIT support is available, the non-DFA tests are run a third time,  done). If JIT support is available, the non-DFA tests are run a third time,
606  this time with a forced pcre_study() with the PCRE_STUDY_JIT_COMPILE option.  this time with a forced pcre_study() with the PCRE_STUDY_JIT_COMPILE option.
607    
608  RunTest uses a file called testtry to hold the main output from pcretest  When both 8-bit and 16-bit support is enabled, the entire set of tests is run
609  (testsavedregex is also used as a working file). To run pcretest on just one of  twice, once for each library. If you want to run just one set of tests, call
610  the test files, give its number as an argument to RunTest, for example:  RunTest with either the -8 or -16 option.
611    
612    RunTest 2  RunTest uses a file called testtry to hold the main output from pcretest.
613    Other files whose names begin with "test" are used as working files in some
614    tests. To run pcretest on just one or more specific test files, give their
615    numbers as arguments to RunTest, for example:
616    
617      RunTest 2 7 11
618    
619    You can also call RunTest with the single argument "list" to cause it to output
620    a list of tests.
621    
622  The first test file can be fed directly into the perltest.pl script to check  The first test file can be fed directly into the perltest.pl script to check
623  that Perl gives the same results. The only difference you should see is in the  that Perl gives the same results. The only difference you should see is in the
624  first few lines, where the Perl version is given instead of the PCRE version.  first few lines, where the Perl version is given instead of the PCRE version.
625    
626  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),  The second set of tests check pcre_fullinfo(), pcre_study(),
627  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
628  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
629  wrapper API. It also uses the debugging flags to check some of the internals of  wrapper API. It also uses the debugging flags to check some of the internals of
# Line 612  RunTest.bat. The version of RunTest.bat Line 658  RunTest.bat. The version of RunTest.bat
658  Windows versions of test 2. More info on using RunTest.bat is included in the  Windows versions of test 2. More info on using RunTest.bat is included in the
659  document entitled NON-UNIX-USE.]  document entitled NON-UNIX-USE.]
660    
661  The fourth test checks the UTF-8 support. This file can be also fed directly to  The fourth and fifth tests check the UTF-8/16 support and error handling and
662  the perltest.pl script, provided you are running Perl 5.8 or higher.  internal UTF features of PCRE that are not relevant to Perl, respectively. The
663    sixth and seventh tests do the same for Unicode character properties support.
664    
665    The eighth, ninth, and tenth tests check the pcre_dfa_exec() alternative
666    matching function, in non-UTF-8/16 mode, UTF-8/16 mode, and UTF-8/16 mode with
667    Unicode property support, respectively.
668    
669  The fifth test checks error handling with UTF-8 encoding, and internal UTF-8  The eleventh test checks some internal offsets and code size features; it is
670  features of PCRE that are not relevant to Perl.  run only when the default "link size" of 2 is set (in other cases the sizes
671    change) and when Unicode property support is enabled.
672    
673  The sixth test (which is Perl-5.10 compatible) checks the support for Unicode  The twelfth test is run only when JIT support is available, and the thirteenth
674  character properties. This file can be also fed directly to the perltest.pl  test is run only when JIT support is not available. They test some JIT-specific
675  script, provided you are running Perl 5.10 or higher.  features such as information output from pcretest about JIT compilation.
676    
677  The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative  The fourteenth, fifteenth, and sixteenth tests are run only in 8-bit mode, and
678  matching function, in non-UTF-8 mode, UTF-8 mode, and UTF-8 mode with Unicode  the seventeenth, eighteenth, and nineteenth tests are run only in 16-bit mode.
679  property support, respectively.  These are tests that generate different output in the two modes. They are for
680    general cases, UTF-8/16 support, and Unicode property support, respectively.
681    
682  The tenth test checks some internal offsets and code size features; it is run  The twentieth test is run only in 16-bit mode. It tests some specific 16-bit
683  only when the default "link size" of 2 is set (in other cases the sizes  features of the DFA matching engine.
 change) and when Unicode property support is enabled.  
684    
685  The eleventh and twelfth tests check out features that are new in Perl 5.10,  The twenty-first and twenty-second tests are run only in 16-bit mode, when the
686  without and with UTF-8 support, respectively. This file can be also fed  link size is set to 2. They test reloading pre-compiled patterns.
 directly to the perltest.pl script, provided you are running Perl 5.10 or  
 higher.  
   
 The thirteenth test checks a number internals and non-Perl features concerned  
 with Unicode property support.  
   
 The fourteenth test is run only when JIT support is available, and the  
 fifteenth test is run only when JIT support is not available. They test some  
 JIT-specific features such as information output from pcretest about JIT  
 compilation.  
687    
688    
689  Character tables  Character tables
# Line 701  will cause PCRE to malfunction. Line 743  will cause PCRE to malfunction.
743  File manifest  File manifest
744  -------------  -------------
745    
746  The distribution should contain the following files:  The distribution should contain the files listed below. Where a file name is
747    given as pcre[16]_xxx it means that there are two files, one with the name
748    pcre_xxx and the other with the name pcre16_xxx.
749    
750  (A) Source files of the PCRE library functions and their headers:  (A) Source files of the PCRE library functions and their headers:
751    
# Line 710  The distribution should contain the foll Line 754  The distribution should contain the foll
754    
755    pcre_chartables.c.dist  a default set of character tables that assume ASCII    pcre_chartables.c.dist  a default set of character tables that assume ASCII
756                              coding; used, unless --enable-rebuild-chartables is                              coding; used, unless --enable-rebuild-chartables is
757                              specified, by copying to pcre_chartables.c                              specified, by copying to pcre[16]_chartables.c
758    
759    pcreposix.c             )    pcreposix.c             )
760    pcre_compile.c          )    pcre[16]_byte_order.c   )
761    pcre_config.c           )    pcre[16]_compile.c      )
762    pcre_dfa_exec.c         )    pcre[16]_config.c       )
763    pcre_exec.c             )    pcre[16]_dfa_exec.c     )
764    pcre_fullinfo.c         )    pcre[16]_exec.c         )
765    pcre_get.c              ) sources for the functions in the library,    pcre[16]_fullinfo.c     )
766    pcre_globals.c          )   and some internal functions that they use    pcre[16]_get.c          ) sources for the functions in the library,
767    pcre_info.c             )    pcre[16]_globals.c      )   and some internal functions that they use
768    pcre_jit_compile.c      )    pcre[16]_jit_compile.c  )
769    pcre_maketables.c       )    pcre[16]_maketables.c   )
770    pcre_newline.c          )    pcre[16]_newline.c      )
771      pcre[16]_refcount.c     )
772      pcre[16]_string_utils.c )
773      pcre[16]_study.c        )
774      pcre[16]_tables.c       )
775      pcre[16]_ucd.c          )
776      pcre[16]_version.c      )
777      pcre[16]_xclass.c       )
778    pcre_ord2utf8.c         )    pcre_ord2utf8.c         )
   pcre_refcount.c         )  
   pcre_study.c            )  
   pcre_tables.c           )  
   pcre_try_flipped.c      )  
   pcre_ucd.c              )  
779    pcre_valid_utf8.c       )    pcre_valid_utf8.c       )
780    pcre_version.c          )    pcre16_ord2utf16.c      )
781    pcre_xclass.c           )    pcre16_utf16_utils.c    )
782    pcre_printint.src       ) debugging function that is #included in pcretest,    pcre16_valid_utf16.c    )
783    
784      pcre[16]_printint.c     ) debugging function that is used by pcretest,
785                            )   and can also be #included in pcre_compile()                            )   and can also be #included in pcre_compile()
786    
787    pcre.h.in               template for pcre.h when built by "configure"    pcre.h.in               template for pcre.h when built by "configure"
788    pcreposix.h             header for the external POSIX wrapper API    pcreposix.h             header for the external POSIX wrapper API
789    pcre_internal.h         header for internal use    pcre_internal.h         header for internal use
# Line 775  The distribution should contain the foll Line 824  The distribution should contain the foll
824    Makefile.am             ) the automake input that was used to create    Makefile.am             ) the automake input that was used to create
825                            )   Makefile.in                            )   Makefile.in
826    NEWS                    important changes in this release    NEWS                    important changes in this release
827    NON-UNIX-USE            notes on building PCRE on non-Unix systems    NON-UNIX-USE            the previous name for NON-AUTOTOOLS-BUILD
828      NON-AUTOTOOLS-BUILD     notes on building PCRE without using autotools
829    PrepareRelease          script to make preparations for "make dist"    PrepareRelease          script to make preparations for "make dist"
830    README                  this file    README                  this file
831    RunTest                 a Unix shell script for running tests    RunTest                 a Unix shell script for running tests
# Line 796  The distribution should contain the foll Line 846  The distribution should contain the foll
846    doc/pcretest.txt        plain text documentation of test program    doc/pcretest.txt        plain text documentation of test program
847    doc/perltest.txt        plain text documentation of Perl test program    doc/perltest.txt        plain text documentation of Perl test program
848    install-sh              a shell script for installing files    install-sh              a shell script for installing files
849      libpcre16.pc.in         template for libpcre16.pc for pkg-config
850    libpcre.pc.in           template for libpcre.pc for pkg-config    libpcre.pc.in           template for libpcre.pc for pkg-config
851    libpcreposix.pc.in      template for libpcreposix.pc for pkg-config    libpcreposix.pc.in      template for libpcreposix.pc for pkg-config
852    libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config    libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config
# Line 812  The distribution should contain the foll Line 863  The distribution should contain the foll
863    testdata/testinput*     test data for main library tests    testdata/testinput*     test data for main library tests
864    testdata/testoutput*    expected test results    testdata/testoutput*    expected test results
865    testdata/grep*          input and output for pcregrep tests    testdata/grep*          input and output for pcregrep tests
866      testdata/*              other supporting test files
867    
868  (D) Auxiliary files for cmake support  (D) Auxiliary files for cmake support
869    
870    cmake/COPYING-CMAKE-SCRIPTS    cmake/COPYING-CMAKE-SCRIPTS
871    cmake/FindPackageHandleStandardArgs.cmake    cmake/FindPackageHandleStandardArgs.cmake
872      cmake/FindEditline.cmake
873    cmake/FindReadline.cmake    cmake/FindReadline.cmake
874    CMakeLists.txt    CMakeLists.txt
875    config-cmake.h.in    config-cmake.h.in
# Line 842  The distribution should contain the foll Line 895  The distribution should contain the foll
895  Philip Hazel  Philip Hazel
896  Email local part: ph10  Email local part: ph10
897  Email domain: cam.ac.uk  Email domain: cam.ac.uk
898  Last updated: 06 September 2011  Last updated: 18 June 2012

Legend:
Removed from v.691  
changed lines
  Added in v.981

  ViewVC Help
Powered by ViewVC 1.1.5