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

Contents of /code/trunk/README

Parent Directory Parent Directory | Revision Log Revision Log


Revision 149 - (hide annotations) (download)
Mon Apr 16 15:28:08 2007 UTC (7 years, 4 months ago) by ph10
File size: 32232 byte(s)
Add PCRE_NEWLINE_ANYCRLF.

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

Properties

Name Value
svn:eol-style native
svn:keywords "Author Date Id Revision Url"

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12