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

Diff of /code/trunk/README

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

revision 7 by nigel, Sat Feb 24 21:38:09 2007 UTC revision 41 by nigel, Sat Feb 24 21:39:17 2007 UTC
# Line 1  Line 1 
1  README file for PCRE (Perl-compatible regular expressions)  README file for PCRE (Perl-compatible regular expression library)
2  ----------------------------------------------------------  -----------------------------------------------------------------
3    
4  The distribution should contain the following files:  Please read the NEWS file if you are upgrading from a previous release.
5    
6    
7    Building PCRE on a Unix system
8    ------------------------------
9    
10    To build PCRE on a Unix system, run the "configure" command in the PCRE
11    distribution directory. This is a standard GNU "autoconf" configuration script,
12    for which generic instructions are supplied in INSTALL. On many systems just
13    running "./configure" is sufficient, but the usual methods of changing standard
14    defaults are available. For example
15    
16    CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local
17    
18    specifies that the C compiler should be run with the flags '-O2 -Wall' instead
19    of the default, and that "make install" should install PCRE under /opt/local
20    instead of the default /usr/local. The "configure" script builds two files:
21    
22    . Makefile is built by copying Makefile.in and making certain substitutions.
23    . config.h is built by copying config.in and making certain substitutions.
24    
25    Once "configure" has run, you can run "make". It builds two libraries called
26    libpcre.a and libpcreposix.a, a test program called pcretest, and the pgrep
27    command. You can use "make install" to copy these, and the public header file
28    pcre.h, to appropriate live directories on your system, in the normal way.
29    
30    
31    Shared libraries on Unix systems
32    --------------------------------
33    
34    The default distribution builds static libraries. It is also possible to build
35    PCRE as two shared libraries. This support is new and experimental and may not
36    work on all systems. It relies on the "libtool" scripts - these are distributed
37    with PCRE. To build PCRE using shared libraries you must use --enable-shared
38    when configuring it. For example
39    
40    ./configure --prefix=/usr/gnu --enable-shared
41    
42    Then run "make" in the usual way. It should build a "libtool" script and use
43    this to compile and link shared libraries, which are placed in a subdirectory
44    called .libs. The programs pcretest and pgrep are built to use these
45    uninstalled libraries by means of wrapper scripts. When you use "make install"
46    to install shared libraries, pgrep is automatically re-built to use the newly
47    installed library before it itself is installed.
48    
49    
50    Building on non-Unix systems
51    ----------------------------
52    
53    ChangeLog         log of changes to the code  For a non-Unix system, read the comments in the file NON-UNIX-USE. PCRE has
54    Makefile          for building PCRE  been compiled on Windows systems and on Macintoshes, but I don't know the
55    Performance       notes on performance  details because I don't use those systems. It should be straightforward to
56    README            this file  build PCRE on any system that has a Standard C compiler, because it uses only
57    Tech.Notes        notes on the encoding  Standard C functions.
58    pcre.3            man page for the functions  
59    pcreposix.3       man page for the POSIX wrapper API  
60    maketables.c      auxiliary program for building chartables.c  Testing PCRE
61    study.c           ) source of  ------------
62    pcre.c            )   the functions  
63    pcreposix.c       )  To test PCRE on a Unix system, run the RunTest script in the pcre directory.
64    pcre.h            header for the external API  (This can also be run by "make runtest" or "make check".) For other systems,
65    pcreposix.h       header for the external POSIX wrapper API  see the instruction in NON-UNIX-USE.
66    internal.h        header for internal use  
67    pcretest.c        test program  The script runs the pcretest test program (which is documented in
68    pgrep.1           man page for pgrep  doc/pcretest.txt) on each of the testinput files (in the testdata directory) in
69    pgrep.c           source of a grep utility that uses PCRE  turn, and compares the output with the contents of the corresponding testoutput
70    perltest          Perl test program  file. A file called testtry is used to hold the output from pcretest. To run
71    testinput         test data, compatible with Perl  pcretest on just one of the test files, give its number as an argument to
72    testinput2        test data for error messages and non-Perl things  RunTest, for example:
73    testoutput        test results corresponding to testinput  
74    testoutput2       test results corresponding to testinput2    RunTest 3
75    
76  To build PCRE, edit Makefile for your system (it is a fairly simple make file)  The first and third test files can also be fed directly into the perltest
77  and then run it. It builds a two libraries called libpcre.a and libpcreposix.a,  script to check that Perl gives the same results. The third file requires the
78  a test program called pcretest, and the pgrep command.  additional features of release 5.005, which is why it is kept separate from the
79    main test input, which needs only Perl 5.004. In the long run, when 5.005 is
80  To test PCRE, run pcretest on the file testinput, and compare the output with  widespread, these two test files may get amalgamated.
81  the contents of testoutput. There should be no differences. For example:  
82    The second set of tests check pcre_info(), pcre_study(), pcre_copy_substring(),
83    pcretest testinput some.file  pcre_get_substring(), pcre_get_substring_list(), error detection and run-time
84    diff some.file testoutput  flags that are specific to PCRE, as well as the POSIX wrapper API.
85    
86  Do the same with testinput2, comparing the output with testoutput2, but this  The fourth set of tests checks pcre_maketables(), the facility for building a
87  time using the -i flag for pcretest, i.e.  set of character tables for a specific locale and using them instead of the
88    default tables. The tests make use of the "fr" (French) locale. Before running
89    pcretest -i testinput2 some.file  the test, the script checks for the presence of this locale by running the
90    diff some.file testoutput2  "locale" command. If that command fails, or if it doesn't include "fr" in the
91    list of available locales, the fourth test cannot be run, and a comment is
92  The make target "runtest" runs both these tests, using the file "testtry" to  output to say why. If running this test produces instances of the error
93  store the intermediate output, deleting it at the end if all goes well.  
94      ** Failed to set locale "fr"
95  There are two sets of tests because the first set can also be fed directly into  
96  the perltest program to check that Perl gives the same results. The second set  in the comparison output, it means that locale is not available on your system,
97  of tests check pcre_info(), pcre_study(), error detection and run-time flags  despite being listed by "locale". This does not mean that PCRE is broken.
 that are specific to PCRE, as well as the POSIX wrapper API.  
   
 To install PCRE, copy libpcre.a to any suitable library directory (e.g.  
 /usr/local/lib), pcre.h to any suitable include directory (e.g.  
 /usr/local/include), and pcre.3 to any suitable man directory (e.g.  
 /usr/local/man/man3).  
   
 To install the pgrep command, copy it to any suitable binary directory, (e.g.  
 /usr/local/bin) and pgrep.1 to any suitable man directory (e.g.  
 /usr/local/man/man1).  
98    
99  PCRE has its own native API, but a set of "wrapper" functions that are based on  PCRE has its own native API, but a set of "wrapper" functions that are based on
100  the POSIX API are also supplied in the library libpcreposix.a. Note that this  the POSIX API are also supplied in the library libpcreposix.a. Note that this
# Line 66  themselves still follow Perl syntax and Line 103  themselves still follow Perl syntax and
103  for the POSIX-style functions is called pcreposix.h. The official POSIX name is  for the POSIX-style functions is called pcreposix.h. The official POSIX name is
104  regex.h, but I didn't want to risk possible problems with existing files of  regex.h, but I didn't want to risk possible problems with existing files of
105  that name by distributing it that way. To use it with an existing program that  that name by distributing it that way. To use it with an existing program that
106  uses the POSIX API it will have to be renamed or pointed at by a link.  uses the POSIX API, it will have to be renamed or pointed at by a link.
107    
108    
109  Character tables  Character tables
110  ----------------  ----------------
111    
112  PCRE uses four tables for manipulating and identifying characters. These are  PCRE uses four tables for manipulating and identifying characters. The final
113  compiled from a source file called chartables.c. This is not supplied in  argument of the pcre_compile() function is a pointer to a block of memory
114  the distribution, but is built by the program maketables (compiled from  containing the concatenated tables. A call to pcre_maketables() can be used to
115  maketables.c), which uses the ANSI C character handling functions such as  generate a set of tables in the current locale. If the final argument for
116  isalnum(), isalpha(), isupper(), islower(), etc. to build the table sources.  pcre_compile() is passed as NULL, a set of default tables that is built into
117  This means that the default C locale set in your system may affect the contents  the binary is used.
118  of the tables. You can change the tables by editing chartables.c and then  
119  re-building PCRE. If you do this, you should probably also edit Makefile to  The source file called chartables.c contains the default set of tables. This is
120  ensure that the file doesn't ever get re-generated.  not supplied in the distribution, but is built by the program dftables
121    (compiled from dftables.c), which uses the ANSI C character handling functions
122  The first two tables pcre_lcc[] and pcre_fcc[] provide lower casing and a  such as isalnum(), isalpha(), isupper(), islower(), etc. to build the table
123  case flipping functions, respectively. The pcre_cbits[] table consists of four  sources. This means that the default C locale which is set for your system will
124  32-byte bit maps which identify digits, letters, "word" characters, and white  control the contents of these default tables. You can change the default tables
125  space, respectively. These are used when building 32-byte bit maps that  by editing chartables.c and then re-building PCRE. If you do this, you should
126  represent character classes.  probably also edit Makefile to ensure that the file doesn't ever get
127    re-generated.
128    
129    The first two 256-byte tables provide lower casing and case flipping functions,
130    respectively. The next table consists of three 32-byte bit maps which identify
131    digits, "word" characters, and white space, respectively. These are used when
132    building 32-byte bit maps that represent character classes.
133    
134  The pcre_ctypes[] table has bits indicating various character types, as  The final 256-byte table has bits indicating various character types, as
135  follows:  follows:
136    
137      1   white space character      1   white space character
# Line 102  You should not alter the set of characte Line 145  You should not alter the set of characte
145  will cause PCRE to malfunction.  will cause PCRE to malfunction.
146    
147    
148  The pcretest program  Manifest
149  --------------------  --------
150    
151    The distribution should contain the following files:
152    
153    (A) The actual source files of the PCRE library functions and their
154        headers:
155    
156      dftables.c            auxiliary program for building chartables.c
157      get.c                 )
158      maketables.c          )
159      study.c               ) source of
160      pcre.c                )   the functions
161      pcreposix.c           )
162      pcre.h                header for the external API
163      pcreposix.h           header for the external POSIX wrapper API
164      internal.h            header for internal use
165      config.in             template for config.h, which is built by configure
166    
167    (B) Auxiliary files:
168    
169      AUTHORS               information about the author of PCRE
170      ChangeLog             log of changes to the code
171      INSTALL               generic installation instructions
172      LICENCE               conditions for the use of PCRE
173      Makefile.in           template for Unix Makefile, which is built by configure
174      NEWS                  important changes in this release
175      NON-UNIX-USE          notes on building PCRE on non-Unix systems
176      README                this file
177      RunTest               a Unix shell script for running tests
178      config.guess          ) files used by libtool,
179      config.sub            )   used only when building a shared library
180      configure             a configuring shell script (built by autoconf)
181      configure.in          the autoconf input used to build configure
182      doc/Tech.Notes        notes on the encoding
183      doc/pcre.3            man page source for the PCRE functions
184      doc/pcre.html         HTML version
185      doc/pcre.txt          plain text version
186      doc/pcreposix.3       man page source for the POSIX wrapper API
187      doc/pcreposix.html    HTML version
188      doc/pcreposix.txt     plain text version
189      doc/pcretest.txt      documentation of test program
190      doc/perltest.txt      documentation of Perl test program
191      doc/pgrep.1           man page source for the pgrep utility
192      doc/pgrep.html        HTML version
193      doc/pgrep.txt         plain text version
194      install-sh            a shell script for installing files
195      ltconfig              ) files used to build "libtool",
196      ltmain.sh             )   used only when building a shared library
197      pcretest.c            test program
198      perltest              Perl test program
199      pgrep.c               source of a grep utility that uses PCRE
200      testdata/testinput1   test data, compatible with Perl 5.004 and 5.005
201      testdata/testinput2   test data for error messages and non-Perl things
202      testdata/testinput3   test data, compatible with Perl 5.005
203      testdata/testinput4   test data for locale-specific tests
204      testdata/testoutput1  test results corresponding to testinput1
205      testdata/testoutput2  test results corresponding to testinput2
206      testdata/testoutput3  test results corresponding to testinput3
207      testdata/testoutput4  test results corresponding to testinput4
208    
209  This program is intended for testing PCRE, but it can also be used for  (C) Auxiliary files for Win32 DLL
 experimenting with regular expressions.  
210    
211  If it is given two filename arguments, it reads from the first and writes to    dll.mk
212  the second. If it is given only one filename argument, it reads from that file    pcre.def
 and writes to stdout. Otherwise, it reads from stdin and writes to stdout, and  
 prompts for each line of input.  
   
 The program handles any number of sets of input on a single input file. Each  
 set starts with a regular expression, and continues with any number of data  
 lines to be matched against the pattern. An empty line signals the end of the  
 set. The regular expressions are given enclosed in any non-alphameric  
 delimiters, for example  
   
   /(a|bc)x+yz/  
   
 and may be followed by i, m, s, or x to set the PCRE_CASELESS, PCRE_MULTILINE,  
 PCRE_DOTALL, or PCRE_EXTENDED options, respectively. These options have the  
 same effect as they do in Perl.  
   
 There are also some upper case options that do not match Perl options: /A, /E,  
 and /X set PCRE_ANCHORED, PCRE_DOLLAR_ENDONLY, and PCRE_EXTRA respectively.  
 The /D option is a PCRE debugging feature. It causes the internal form of  
 compiled regular expressions to be output after compilation. The /S option  
 causes pcre_study() to be called after the expression has been compiled, and  
 the results used when the expression is matched. If /I is present as well as  
 /S, then pcre_study() is called with the PCRE_CASELESS option.  
   
 Finally, the /P option causes pcretest to call PCRE via the POSIX wrapper API  
 rather than its native API. When this is done, all other options except /i and  
 /m are ignored. REG_ICASE is set if /i is present, and REG_NEWLINE is set if /m  
 is present. The wrapper functions force PCRE_DOLLAR_ENDONLY always, and  
 PCRE_DOTALL unless REG_NEWLINE is set.  
   
 A regular expression can extend over several lines of input; the newlines are  
 included in it. See the testinput file for many examples.  
   
 Before each data line is passed to pcre_exec(), leading and trailing whitespace  
 is removed, and it is then scanned for \ escapes. The following are recognized:  
   
   \a     alarm (= BEL)  
   \b     backspace  
   \e     escape  
   \f     formfeed  
   \n     newline  
   \r     carriage return  
   \t     tab  
   \v     vertical tab  
   \nnn   octal character (up to 3 octal digits)  
   \xhh   hexadecimal character (up to 2 hex digits)  
   
   \A     pass the PCRE_ANCHORED option to pcre_exec()  
   \B     pass the PCRE_NOTBOL option to pcre_exec()  
   \E     pass the PCRE_DOLLAR_ENDONLY option to pcre_exec()  
   \I     pass the PCRE_CASELESS option to pcre_exec()  
   \M     pass the PCRE_MULTILINE option to pcre_exec()  
   \S     pass the PCRE_DOTALL option to pcre_exec()  
   \Odd   set the size of the output vector passed to pcre_exec() to dd  
            (any number of decimal digits)  
   \Z     pass the PCRE_NOTEOL option to pcre_exec()  
   
 A backslash followed by anything else just escapes the anything else. If the  
 very last character is a backslash, it is ignored. This gives a way of passing  
 an empty line as data, since a real empty line terminates the data input.  
   
 If /P was present on the regex, causing the POSIX wrapper API to be used, only  
 \B, and \Z have any effect, causing REG_NOTBOL and REG_NOTEOL to be passed to  
 regexec() respectively.  
   
 When a match succeeds, pcretest outputs the list of identified substrings that  
 pcre_exec() returns, starting with number 0 for the string that matched the  
 whole pattern. Here is an example of an interactive pcretest run.  
   
   $ pcretest  
   Testing Perl-Compatible Regular Expressions  
   PCRE version 0.90 08-Sep-1997  
   
       re> /^abc(\d+)/  
     data> abc123  
    0: abc123  
    1: 123  
     data> xyz  
   No match  
   
 Note that while patterns can be continued over several lines (a plain ">"  
 prompt is used for continuations), data lines may not. However newlines can be  
 included in data by means of the \n escape.  
   
 If the -p option is given to pcretest, it is equivalent to adding /P to each  
 regular expression: the POSIX wrapper API is used to call PCRE. None of the  
 following flags has any effect in this case.  
   
 If the option -d is given to pcretest, it is equivalent to adding /D to each  
 regular expression: the internal form is output after compilation.  
   
 If the option -i (for "information") is given to pcretest, it calls pcre_info()  
 after compiling an expression, and outputs the information it gets back. If the  
 pattern is studied, the results of that are also output.  
   
 If the option -s is given to pcretest, it outputs the size of each compiled  
 pattern after it has been compiled.  
   
 If the -t option is given, each compile, study, and match is run 2000 times  
 while being timed, and the resulting time per compile or match is output in  
 milliseconds. Do not set -t with -s, because you will then get the size output  
 2000 times and the timing will be distorted.  
   
   
   
 The perltest program  
 --------------------  
   
 The perltest program tests Perl's regular expressions; it has the same  
 specification as pcretest, and so can be given identical input, except that  
 input patterns can be followed only by Perl's lower case options.  
   
 The data lines are processed as Perl strings, so if they contain $ or @  
 characters, these have to be escaped. For this reason, all such characters in  
 the testinput file are escaped so that it can be used for perltest as well as  
 for pcretest, and the special upper case options such as /A that pcretest  
 recognizes are not used in this file. The output should be identical, apart  
 from the initial identifying banner.  
   
 The testinput2 file is not suitable for feeding to Perltest, since it does  
 make use of the special upper case options and escapes that pcretest uses to  
 test additional features of PCRE.  
213    
214  Philip Hazel <ph10@cam.ac.uk>  Philip Hazel <ph10@cam.ac.uk>
215  October 1997  January 2000
Legend:
Removed from v.7  
changed lines
  Added in v.41
  ViewVC Help
Powered by ViewVC 1.1.5