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

Diff of /code/trunk/README

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

revision 836 by ph10, Wed Dec 28 17:16:11 2011 UTC revision 840 by ph10, Fri Dec 30 19:32:50 2011 UTC
# Line 34  The contents of this README file are: Line 34  The contents of this README file are:
34  The PCRE APIs  The PCRE APIs
35  -------------  -------------
36    
37  PCRE is written in C, and it has its own API. The distribution also includes a  PCRE is written in C, and it has its own API. There are two sets of functions,
38  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
39  of Google Inc.  16-bit library, which processes strings of 16-bit values. The distribution also
40    includes a set of C++ wrapper functions (see the pcrecpp man page for details),
41  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
42  regular expression API (see the pcreposix man page). These end up in the  C++.
43  library called libpcreposix. Note that this just provides a POSIX calling  
44  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
45  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
46  all of PCRE's facilities.  man page). These end up in the library called libpcreposix. Note that this just
47    provides a POSIX calling interface to PCRE; the regular expressions themselves
48    still follow Perl syntax and semantics. The POSIX API is restricted, and does
49    not give full access to all of PCRE's facilities.
50    
51  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
52  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 143  the usual methods of changing standard d Line 146  the usual methods of changing standard d
146    
147  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local
148    
149  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
150  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
151  instead of the default /usr/local.  under /opt/local instead of the default /usr/local.
152    
153  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
154  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 168  library. They are also documented in the Line 171  library. They are also documented in the
171    --disable-static    --disable-static
172    
173    (See also "Shared libraries on Unix-like systems" below.)    (See also "Shared libraries on Unix-like systems" below.)
174    
175  . 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
176    --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
177    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".
178    it will try to build the C++ wrapper.  
179    . If you are building the 8-bit library and want to suppress the building of
180      the C++ wrapper library, you can add --disable-cpp to the "configure"
181      command. Otherwise, when "configure" is run without --disable-pcre8, it will
182      try to find a C++ compiler and C++ header files, and if it succeeds, it will
183      try to build the C++ wrapper.
184    
185  . 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
186    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 192  library. They are also documented in the
192    you add --disable-pcregrep-jit to the "configure" command.    you add --disable-pcregrep-jit to the "configure" command.
193    
194  . 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
195    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,
196    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
197    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
198    with this option, its input can only either be ASCII or UTF-8, even when    when --enable-utf included, the use of UTF encoding still has to be enabled
199    running on EBCDIC platforms. It is not possible to use both --enable-utf8 and    by an option at run time. When PCRE is compiled with this option, its input
200    --enable-ebcdic at the same time.    can only either be ASCII or UTF-8/16, even when running on EBCDIC platforms.
201      It is not possible to use both --enable-utf and --enable-ebcdic at the same
202  . If, in addition to support for UTF-8 character strings, you want to include    time.
203    support for the \P, \p, and \X sequences that recognize Unicode character  
204    properties, you must add --enable-unicode-properties to the "configure"  . The option --enable-utf8 is retained for backwards compatibility with earlier
205    command. This adds about 30K to the size of the library (in the form of a    releases that did not support 16-bit character strings. It is synonymous with
206    property table); only the basic two-letter properties such as Lu are    --enable-utf. It is not possible to configure one library with UTF support
207    supported.    and the other without in the same configuration.
208    
209    . If, in addition to support for UTF-8/16 character strings, you want to
210      include support for the \P, \p, and \X sequences that recognize Unicode
211      character properties, you must add --enable-unicode-properties to the
212      "configure" command. This adds about 30K to the size of the library (in the
213      form of a property table); only the basic two-letter properties such as Lu
214      are supported.
215    
216  . 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
217    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 264  library. They are also documented in the
264    sizes in the pcrestack man page.    sizes in the pcrestack man page.
265    
266  . The default maximum compiled pattern size is around 64K. You can increase  . The default maximum compiled pattern size is around 64K. You can increase
267    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
268    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
269    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
270    performance.    the same as --with-link-size=4, which (in both libraries) uses four-byte
271      offsets. Increasing the internal link size reduces performance.
272    
273  . 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
274    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 303  library. They are also documented in the
303    
304    This automatically implies --enable-rebuild-chartables (see above). However,    This automatically implies --enable-rebuild-chartables (see above). However,
305    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
306    both EBCDIC and UTF-8.    both EBCDIC and UTF-8/16.
307    
308  . 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
309    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
310      libz and/or libbz2, in order to read .gz and .bz2 files (respectively), by
311      specifying one or both of
312    
313    --enable-pcregrep-libz    --enable-pcregrep-libz
314    --enable-pcregrep-libbz2    --enable-pcregrep-libbz2
# Line 333  The "configure" script builds the follow Line 351  The "configure" script builds the follow
351  . pcre-config          script that shows the building settings such as CFLAGS  . pcre-config          script that shows the building settings such as CFLAGS
352                           that were set for "configure"                           that were set for "configure"
353  . libpcre.pc         ) data for the pkg-config command  . libpcre.pc         ) data for the pkg-config command
354    . libpcre16.pc       )
355  . libpcreposix.pc    )  . libpcreposix.pc    )
356  . libtool              script that builds shared and/or static libraries  . libtool              script that builds shared and/or static libraries
357  . RunTest              script for running tests on the basic C library  . RunTest              script for running tests on the basic C library
# Line 343  names config.h.generic and pcre.h.generi Line 362  names config.h.generic and pcre.h.generi
362  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"
363  or CMake, the .generic versions are not used.  or CMake, the .generic versions are not used.
364    
365  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
366    files are also built:
367    
368  . libpcrecpp.pc        data for the pkg-config command  . libpcrecpp.pc        data for the pkg-config command
369  . 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 373  The "configure" script also creates conf
373  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
374  contains compiler output from tests that "configure" runs.  contains compiler output from tests that "configure" runs.
375    
376  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
377  libpcre and libpcreposix, a test program called pcretest, and the pcregrep  libraries libpcre and libpcre16, and a test program called pcretest. If you
378  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
379  with --disable-cpp, "make" also builds the C++ wrapper library, which is called  built as well.
380  libpcrecpp, and some test programs called pcrecpp_unittest,  
381  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
382  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
383    it with --disable-cpp, "make" builds the C++ wrapper library, which is called
384    libpcrecpp, as well as some test programs called pcrecpp_unittest,
385    pcre_scanner_unittest, and pcre_stringpiece_unittest.
386    
387  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
388  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 393  system. The following are installed (fil
393    
394    Commands (bin):    Commands (bin):
395      pcretest      pcretest
396      pcregrep      pcregrep (if 8-bit support is enabled)
397      pcre-config      pcre-config
398    
399    Libraries (lib):    Libraries (lib):
400      libpcre      libpcre16     (if 16-bit support is enabled)
401      libpcreposix      libpcre       (if 8-bit support is enabled)
402      libpcrecpp (if C++ support is enabled)      libpcreposix  (if 8-bit support is enabled)
403        libpcrecpp    (if 8-bit and C++ support is enabled)
404    
405    Configuration information (lib/pkgconfig):    Configuration information (lib/pkgconfig):
406        libpcre16.pc
407      libpcre.pc      libpcre.pc
408      libpcreposix.pc      libpcreposix.pc
409      libpcrecpp.pc (if C++ support is enabled)      libpcrecpp.pc (if C++ support is enabled)
# Line 558  The RunTest script runs the pcretest tes Line 583  The RunTest script runs the pcretest tes
583  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
584  directory, and compares the output with the contents of the corresponding  directory, and compares the output with the contents of the corresponding
585  testoutput files. Some tests are relevant only when certain build-time options  testoutput files. Some tests are relevant only when certain build-time options
586  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
587  --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.
588    
589  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
590  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 592  tests that are marked "never study" (see
592  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,
593  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.
594    
595  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
596  (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
597  the test files, give its number as an argument to RunTest, for example:  RunTest with either the -8 or -16 option.
598    
599    RunTest 2  RunTest uses a file called testtry to hold the main output from pcretest
600    (testsavedregex is also used as a working file). To run pcretest on just one or
601    more specific test files, give their numbers as arguments to RunTest, for
602    example:
603    
604      RunTest 2 7 11
605    
606  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
607  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
608  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.
609    
610  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),  The second set of tests check pcre_fullinfo(), pcre_study(),
611  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
612  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
613  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 642  RunTest.bat. The version of RunTest.bat
642  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
643  document entitled NON-UNIX-USE.]  document entitled NON-UNIX-USE.]
644    
645  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
646  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
647    sixth and seventh tests do the same for Unicode character properties support.
648    
649    The eighth, ninth, and tenth tests check the pcre_dfa_exec() alternative
650    matching function, in non-UTF-8/16 mode, UTF-8/16 mode, and UTF-8/16 mode with
651    Unicode property support, respectively.
652    
653  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
654  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
   
 The sixth test (which is Perl-5.10 compatible) checks the support for Unicode  
 character properties. This file can be also fed directly to the perltest.pl  
 script, provided you are running Perl 5.10 or higher.  
   
 The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative  
 matching function, in non-UTF-8 mode, UTF-8 mode, and UTF-8 mode with Unicode  
 property support, respectively.  
   
 The tenth test checks some internal offsets and code size features; it is run  
 only when the default "link size" of 2 is set (in other cases the sizes  
655  change) and when Unicode property support is enabled.  change) and when Unicode property support is enabled.
656    
657  The eleventh and twelfth tests check out features that are new in Perl 5.10,  The twelfth test is run only when JIT support is available, and the thirteenth
658  without and with UTF-8 support, respectively. This file can be also fed  test is run only when JIT support is not available. They test some JIT-specific
659  directly to the perltest.pl script, provided you are running Perl 5.10 or  features such as information output from pcretest about JIT compilation.
660  higher.  
661    The fourteenth, fifteenth, and sixteenth tests are run only in 8-bit mode, and
662  The thirteenth test checks a number internals and non-Perl features concerned  the seventeenth, eighteenth, and nineteenth tests are run only in 16-bit mode.
663  with Unicode property support.  These are tests that generate different output in the two modes. They are for
664    general cases, UTF-8/16 support, and Unicode property support, respectively.
665  The fourteenth test is run only when JIT support is available, and the  
666  fifteenth test is run only when JIT support is not available. They test some  The twentieth test is run only in 16-bit mode. It tests some specific 16-bit
667  JIT-specific features such as information output from pcretest about JIT  features of the DFA matching engine.
 compilation.  
668    
669    
670  Character tables  Character tables
# Line 701  will cause PCRE to malfunction. Line 724  will cause PCRE to malfunction.
724  File manifest  File manifest
725  -------------  -------------
726    
727  The distribution should contain the following files:  The distribution should contain the files listed below. Where a file name is
728    given as pcre[16]_xxx it means that there are two files, one with the name
729    pcre_xxx and the other with the name pcre16_xxx.
730    
731  (A) Source files of the PCRE library functions and their headers:  (A) Source files of the PCRE library functions and their headers:
732    
# Line 710  The distribution should contain the foll Line 735  The distribution should contain the foll
735    
736    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
737                              coding; used, unless --enable-rebuild-chartables is                              coding; used, unless --enable-rebuild-chartables is
738                              specified, by copying to pcre_chartables.c                              specified, by copying to pcre[16]_chartables.c
739    
740    pcreposix.c             )    pcreposix.c             )
741    pcre_byte_order.c       )    pcre[16]_byte_order.c   )
742    pcre_compile.c          )    pcre[16]_compile.c      )
743    pcre_config.c           )    pcre[16]_config.c       )
744    pcre_dfa_exec.c         )    pcre[16]_dfa_exec.c     )
745    pcre_exec.c             )    pcre[16]_exec.c         )
746    pcre_fullinfo.c         )    pcre[16]_fullinfo.c     )
747    pcre_get.c              ) sources for the functions in the library,    pcre[16]_get.c          ) sources for the functions in the library,
748    pcre_globals.c          )   and some internal functions that they use    pcre[16]_globals.c      )   and some internal functions that they use
749    pcre_info.c             )    pcre[16]_jit_compile.c  )
750    pcre_jit_compile.c      )    pcre[16]_maketables.c   )
751    pcre_maketables.c       )    pcre[16]_newline.c      )
752    pcre_newline.c          )    pcre[16]_refcount.c     )
753      pcre[16]_string_utils.c )
754      pcre[16]_study.c        )
755      pcre[16]_tables.c       )
756      pcre[16]_ucd.c          )
757      pcre[16]_version.c      )
758      pcre[16]_xclass.c       )
759    pcre_ord2utf8.c         )    pcre_ord2utf8.c         )
   pcre_refcount.c         )  
   pcre_study.c            )  
   pcre_tables.c           )  
   pcre_ucd.c              )  
760    pcre_valid_utf8.c       )    pcre_valid_utf8.c       )
761    pcre_version.c          )    pcre16_ord2utf16.c      )
762    pcre_xclass.c           )    pcre16_utf16_utils.c    )
763    pcre_printint.src       ) debugging function that is #included in pcretest,    pcre16_valid_utf16.c    )
764    
765      pcre[16]_printint.c     ) debugging function that is used by pcretest,
766                            )   and can also be #included in pcre_compile()                            )   and can also be #included in pcre_compile()
767    
768    pcre.h.in               template for pcre.h when built by "configure"    pcre.h.in               template for pcre.h when built by "configure"
769    pcreposix.h             header for the external POSIX wrapper API    pcreposix.h             header for the external POSIX wrapper API
770    pcre_internal.h         header for internal use    pcre_internal.h         header for internal use
# Line 796  The distribution should contain the foll Line 826  The distribution should contain the foll
826    doc/pcretest.txt        plain text documentation of test program    doc/pcretest.txt        plain text documentation of test program
827    doc/perltest.txt        plain text documentation of Perl test program    doc/perltest.txt        plain text documentation of Perl test program
828    install-sh              a shell script for installing files    install-sh              a shell script for installing files
829      libpcre16.pc.in         template for libpcre16.pc for pkg-config
830    libpcre.pc.in           template for libpcre.pc for pkg-config    libpcre.pc.in           template for libpcre.pc for pkg-config
831    libpcreposix.pc.in      template for libpcreposix.pc for pkg-config    libpcreposix.pc.in      template for libpcreposix.pc for pkg-config
832    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 843  The distribution should contain the foll
843    testdata/testinput*     test data for main library tests    testdata/testinput*     test data for main library tests
844    testdata/testoutput*    expected test results    testdata/testoutput*    expected test results
845    testdata/grep*          input and output for pcregrep tests    testdata/grep*          input and output for pcregrep tests
846      testdata/*              other supporting test files
847    
848  (D) Auxiliary files for cmake support  (D) Auxiliary files for cmake support
849    
# Line 842  The distribution should contain the foll Line 874  The distribution should contain the foll
874  Philip Hazel  Philip Hazel
875  Email local part: ph10  Email local part: ph10
876  Email domain: cam.ac.uk  Email domain: cam.ac.uk
877  Last updated: 06 September 2011  Last updated: 30 December 2011

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

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12