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

Contents of /code/trunk/README

Parent Directory Parent Directory | Revision Log Revision Log


Revision 678 - (show annotations) (download)
Sun Aug 28 15:23:03 2011 UTC (2 years, 11 months ago) by ph10
File size: 38186 byte(s)
Documentation for JIT support.

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

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