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

Contents of /code/trunk/README

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1055 - (show annotations)
Tue Oct 16 15:53:30 2012 UTC (7 years ago) by chpe
File size: 42066 byte(s)
pcre32: Add 32-bit library

Create libpcre32 that operates on 32-bit characters (UTF-32).

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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.5