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

Diff of /code/trunk/README

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

revision 1288 by ph10, Sat Mar 16 14:21:58 2013 UTC revision 1319 by ph10, Wed May 1 16:03:57 2013 UTC
# Line 37  The contents of this README file are: Line 37  The contents of this README file are:
37  The PCRE APIs  The PCRE APIs
38  -------------  -------------
39    
40  PCRE is written in C, and it has its own API. There are three sets of functions,  PCRE is written in C, and it has its own API. There are three sets of
41  one for the 8-bit library, which processes strings of bytes, one for the  functions, one for the 8-bit library, which processes strings of bytes, one for
42  16-bit library, which processes strings of 16-bit values, and one for the 32-bit  the 16-bit library, which processes strings of 16-bit values, and one for the
43  library, which processes strings of 32-bit values. The distribution also  32-bit library, which processes strings of 32-bit values. The distribution also
44  includes a set of C++ wrapper functions (see the pcrecpp man page for details),  includes a set of C++ wrapper functions (see the pcrecpp man page for details),
45  courtesy of Google Inc., which can be used to call the 8-bit PCRE library from  courtesy of Google Inc., which can be used to call the 8-bit PCRE library from
46  C++.  C++.
# Line 647  NON-AUTOTOOLS-BUILD. Line 647  NON-AUTOTOOLS-BUILD.
647  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
648  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
649  directory, and compares the output with the contents of the corresponding  directory, and compares the output with the contents of the corresponding
650  testoutput files. Some tests are relevant only when certain build-time options  testoutput files. RunTest uses a file called testtry to hold the main output
651  were selected. For example, the tests for UTF-8/16/32 support are run only if  from pcretest. Other files whose names begin with "test" are used as working
652  --enable-utf was used. RunTest outputs a comment when it skips a test.  files in some tests.
653    
654    Some tests are relevant only when certain build-time options were selected. For
655    example, the tests for UTF-8/16/32 support are run only if --enable-utf was
656    used. RunTest outputs a comment when it skips a test.
657    
658  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
659  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 662  The entire set of tests is run once for Line 666  The entire set of tests is run once for
666  libraries that are enabled. If you want to run just one set of tests, call  libraries that are enabled. If you want to run just one set of tests, call
667  RunTest with either the -8, -16 or -32 option.  RunTest with either the -8, -16 or -32 option.
668    
669  If valgrind is installed, you can run the tests under it by putting "valgrind"  If valgrind is installed, you can run the tests under it by putting "valgrind"
670  on the RunTest command line.  on the RunTest command line. To run pcretest on just one or more specific test
671    files, give their numbers as arguments to RunTest, for example:
 RunTest uses a file called testtry to hold the main output from pcretest.  
 Other files whose names begin with "test" are used as working files in some  
 tests. To run pcretest on just one or more specific test files, give their  
 numbers as arguments to RunTest, for example:  
672    
673    RunTest 2 7 11    RunTest 2 7 11
674    
675    You can also specify ranges of tests such as 3-6 or 3- (meaning 3 to the
676    end), or a number preceded by ~ to exclude a test. For example:
677    
678      Runtest 3-15 ~10
679    
680    This runs tests 3 to 15, excluding test 10, and just ~13 runs all the tests
681    except test 13. Whatever order the arguments are in, the tests are always run
682    in numerical order.
683    
684  You can also call RunTest with the single argument "list" to cause it to output  You can also call RunTest with the single argument "list" to cause it to output
685  a list of tests.  a list of tests.
# Line 731  test is run only when JIT support is not Line 740  test is run only when JIT support is not
740  features such as information output from pcretest about JIT compilation.  features such as information output from pcretest about JIT compilation.
741    
742  The fourteenth, fifteenth, and sixteenth tests are run only in 8-bit mode, and  The fourteenth, fifteenth, and sixteenth tests are run only in 8-bit mode, and
743  the seventeenth, eighteenth, and nineteenth tests are run only in 16/32-bit mode.  the seventeenth, eighteenth, and nineteenth tests are run only in 16/32-bit
744  These are tests that generate different output in the two modes. They are for  mode. These are tests that generate different output in the two modes. They are
745  general cases, UTF-8/16/32 support, and Unicode property support, respectively.  for general cases, UTF-8/16/32 support, and Unicode property support,
746    respectively.
747    
748  The twentieth test is run only in 16/32-bit mode. It tests some specific  The twentieth test is run only in 16/32-bit mode. It tests some specific
749  16/32-bit features of the DFA matching engine.  16/32-bit features of the DFA matching engine.
750    
751  The twenty-first and twenty-second tests are run only in 16/32-bit mode, when the  The twenty-first and twenty-second tests are run only in 16/32-bit mode, when
752  link size is set to 2 for the 16-bit library. They test reloading pre-compiled patterns.  the link size is set to 2 for the 16-bit library. They test reloading
753    pre-compiled patterns.
754    
755    The twenty-third and twenty-fourth tests are run only in 16-bit mode. They are
756    for general cases, and UTF-16 support, respectively.
757    
758  The twenty-third and twenty-fourth tests are run only in 16-bit mode. They are for  The twenty-fifth and twenty-sixth tests are run only in 32-bit mode. They are
759  general cases, and UTF-16 support, respectively.  for general cases, and UTF-32 support, respectively.
760    
 The twenty-fifth and twenty-sixth tests are run only in 32-bit mode. They are for  
 general cases, and UTF-32 support, respectively.  
761    
762  Character tables  Character tables
763  ----------------  ----------------
# Line 811  pcre_xxx, one with the name pcre16_xx, a Line 823  pcre_xxx, one with the name pcre16_xx, a
823  (A) Source files of the PCRE library functions and their headers:  (A) Source files of the PCRE library functions and their headers:
824    
825    dftables.c              auxiliary program for building pcre_chartables.c    dftables.c              auxiliary program for building pcre_chartables.c
826                              when --enable-rebuild-chartables is specified                            when --enable-rebuild-chartables is specified
827    
828    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
829                              coding; used, unless --enable-rebuild-chartables is                            coding; used, unless --enable-rebuild-chartables is
830                              specified, by copying to pcre[16]_chartables.c                            specified, by copying to pcre[16]_chartables.c
831    
832    pcreposix.c                )    pcreposix.c                )
833    pcre[16|32]_byte_order.c   )    pcre[16|32]_byte_order.c   )
# Line 959  pcre_xxx, one with the name pcre16_xx, a Line 971  pcre_xxx, one with the name pcre16_xx, a
971  Philip Hazel  Philip Hazel
972  Email local part: ph10  Email local part: ph10
973  Email domain: cam.ac.uk  Email domain: cam.ac.uk
974  Last updated: 16 March 2013  Last updated: 28 April 2013

Legend:
Removed from v.1288  
changed lines
  Added in v.1319

  ViewVC Help
Powered by ViewVC 1.1.5