diff options
| author | ph10 <ph10@2f5784b3-3f2a-0410-8824-cb99058d5e15> | 2007-06-13 14:55:18 +0000 |
|---|---|---|
| committer | ph10 <ph10@2f5784b3-3f2a-0410-8824-cb99058d5e15> | 2007-06-13 14:55:18 +0000 |
| commit | a24e9c9aff88d3b9f6022cbdfee49d758cfde0f7 (patch) | |
| tree | 4de4657d9375cf1e559de3023115a3304db665ce | |
| parent | 4a2dd57d1f0434eec752230fe745d046e5da5eb2 (diff) | |
| download | pcre-a24e9c9aff88d3b9f6022cbdfee49d758cfde0f7.tar.gz | |
Documentation update preparatory to release.
git-svn-id: svn://vcs.exim.org/pcre/code/trunk@181 2f5784b3-3f2a-0410-8824-cb99058d5e15
| -rw-r--r-- | ChangeLog | 2 | ||||
| -rw-r--r-- | HACKING | 7 | ||||
| -rw-r--r-- | NEWS | 8 | ||||
| -rw-r--r-- | NON-UNIX-USE | 8 | ||||
| -rw-r--r-- | configure.ac | 2 | ||||
| -rw-r--r-- | doc/pcre.3 | 7 | ||||
| -rw-r--r-- | doc/pcreapi.3 | 9 | ||||
| -rw-r--r-- | doc/pcrecompat.3 | 10 | ||||
| -rw-r--r-- | doc/pcreprecompile.3 | 16 | ||||
| -rw-r--r-- | doc/pcresample.3 | 9 | ||||
| -rw-r--r-- | maint/README | 205 |
11 files changed, 144 insertions, 139 deletions
@@ -1,7 +1,7 @@ ChangeLog for PCRE ------------------ -Version 7.2 05-June-07 +Version 7.2 13-June-07 --------------------- 1. If the fr_FR locale cannot be found for test 3, try the "french" locale, @@ -129,13 +129,18 @@ These items are all just one byte long OP_ANYBYTE match any single byte, even in UTF-8 mode OP_SOD match start of data: \A OP_SOM, start of match (subject + offset): \G + OP_SET_SOM, set start of match (\K) OP_CIRC ^ (start of data, or after \n in multiline) OP_NOT_WORD_BOUNDARY \W OP_WORD_BOUNDARY \w OP_NOT_DIGIT \D OP_DIGIT \d + OP_NOT_HSPACE \H + OP_HSPACE \h OP_NOT_WHITESPACE \S OP_WHITESPACE \s + OP_NOT_VSPACE \V + OP_VSPACE \v OP_NOT_WORDCHAR \W OP_WORDCHAR \w OP_EODN match end of data or \n at end: \Z @@ -399,4 +404,4 @@ at compile time, and so does not cause anything to be put into the compiled data. Philip Hazel -November 2006 +June 2007 @@ -2,11 +2,12 @@ News about PCRE releases ------------------------ -Release 7.2 30-Apr-07 +Release 7.2 13-Jun-07 --------------------- WARNING: saved patterns that were compiled by earlier versions of PCRE must be -recompiled for use with 7.2 (necessitated by the addition of \K). +recompiled for use with 7.2 (necessitated by the addition of \K, \h, \H, \v, +and \V). Correction to the notes for 7.1: the note about shared libraries for Windows is wrong. Previously, three libraries were built, but each could function @@ -20,8 +21,9 @@ Some more features from Perl 5.10 have been added: (?-n) and (?+n) relative references for recursion and subroutines. - (Not sure if this one is actually in Perl 5.10) (?(-n) and (?(+n) relative references as conditions. + + \k{name} and \g{name} are synonyms for \k<name>. \K to reset the start of the matched string; for example, (foo)\Kbar matches bar preceded by foo, but only sets bar as the matched string. diff --git a/NON-UNIX-USE b/NON-UNIX-USE index 2518285..f2ead00 100644 --- a/NON-UNIX-USE +++ b/NON-UNIX-USE @@ -165,7 +165,11 @@ On both MinGW and Cygwin, PCRE should build correctly using: ./configure && make && make install This should create two libraries called libpcre and libpcreposix, and, if you -have enabled building the C++ wrapper, a third one called libpcrecpp. +have enabled building the C++ wrapper, a third one called libpcrecpp. These are +independent libraries: when you like with libpcreposix or libpcrecpp you must +also link with libpcre, which contains the basic functions. (Some earlier +releases of PCRE included the basic libpcre functions in libpcreposix. This no +longer happens.) If you want to statically link your program against a non-dll .a file, you must define PCRE_STATIC before including pcre.h, otherwise the pcre_malloc() and @@ -280,5 +284,5 @@ $! Locale could not be set to fr $! ========================= -Last Updated: 11 June 2007 +Last Updated: 13 June 2007 **** diff --git a/configure.ac b/configure.ac index 251ef4e..3f0c39a 100644 --- a/configure.ac +++ b/configure.ac @@ -9,7 +9,7 @@ dnl empty. m4_define(pcre_major, [7]) m4_define(pcre_minor, [2]) m4_define(pcre_prerelease, [-RC3]) -m4_define(pcre_date, [2007-06-05]) +m4_define(pcre_date, [2007-06-13]) # Libtool shared library interface versions (current:revision:age) m4_define(libpcre_version, [0:1:0]) @@ -219,7 +219,10 @@ must use Unicode property tests such as \ep{Nd}. 8. Similarly, characters that match the POSIX named character classes are all low-valued characters. .P -9. Case-insensitive matching applies only to characters whose values are less +9. However, the Perl 5.10 horizontal and vertical whitespace matching escapes +(\eh, \eH, \ev, and \eV) do match all the appropriate Unicode characters. +.P +10. Case-insensitive matching applies only to characters whose values are less than 128, unless PCRE is built with Unicode property support. Even when Unicode property support is available, PCRE still uses its own character tables when checking the case of low-valued characters, so as not to degrade performance. @@ -248,6 +251,6 @@ two digits 10, at the domain cam.ac.uk. .rs .sp .nf -Last updated: 18 April 2007 +Last updated: 13 June 2007 Copyright (c) 1997-2007 University of Cambridge. .fi diff --git a/doc/pcreapi.3 b/doc/pcreapi.3 index f36e9af..0c976f4 100644 --- a/doc/pcreapi.3 +++ b/doc/pcreapi.3 @@ -648,7 +648,7 @@ out of use. To avoid confusion, they have not been re-used. 26 malformed number or name after (?( 27 conditional group contains more than two branches 28 assertion expected after (?( - 29 (?R or (?digits must be followed by ) + 29 (?R or (?[+-]digits must be followed by ) 30 unknown POSIX class name 31 POSIX collating elements are not supported 32 this version of PCRE is not compiled with PCRE_UTF8 support @@ -676,6 +676,9 @@ out of use. To avoid confusion, they have not been re-used. 54 DEFINE group contains more than one branch 55 repeating a DEFINE group is not allowed 56 inconsistent NEWLINE options" + 57 \g is not followed by a braced name or an optionally braced + non-zero number + 58 (?+ or (?- or (?(+ or (?(- must be followed by a non-zero number . . .SH "STUDYING A PATTERN" @@ -875,7 +878,7 @@ fourth argument should point to an \fBunsigned char *\fP variable. .sp Return 1 if the (?J) option setting is used in the pattern, otherwise 0. The fourth argument should point to an \fBint\fP variable. The (?J) internal option -setting changes the local PCRE_DUPNAMES value. +setting changes the local PCRE_DUPNAMES option. .sp PCRE_INFO_LASTLITERAL .sp @@ -1867,6 +1870,6 @@ Cambridge CB2 3QH, England. .rs .sp .nf -Last updated: 04 June 2007 +Last updated: 13 June 2007 Copyright (c) 1997-2007 University of Cambridge. .fi diff --git a/doc/pcrecompat.3 b/doc/pcrecompat.3 index 298be36..6e4209d 100644 --- a/doc/pcrecompat.3 +++ b/doc/pcrecompat.3 @@ -6,8 +6,8 @@ PCRE - Perl-compatible regular expressions .sp This document describes the differences in the ways that PCRE and Perl handle regular expressions. The differences described here are mainly with respect to -Perl 5.8, though PCRE version 7.0 contains some features that are expected to -be in the forthcoming Perl 5.10. +Perl 5.8, though PCRE versions 7.0 and later contain some features that are +expected to be in the forthcoming Perl 5.10. .P 1. PCRE has only a subset of Perl's UTF-8 and Unicode support. Details of what it does have are given in the @@ -94,8 +94,8 @@ string. Perl requires them all to have the same length. meta-character matches only at the very end of the string. .sp (c) If PCRE_EXTRA is set, a backslash followed by a letter with no special -meaning is faulted. Otherwise, like Perl, the backslash is ignored. (Perl can -be made to issue a warning.) +meaning is faulted. Otherwise, like Perl, the backslash is quietly ignored. +(Perl can be made to issue a warning.) .sp (d) If PCRE_UNGREEDY is set, the greediness of the repetition quantifiers is inverted, that is, by default they are not greedy, but if followed by a @@ -132,6 +132,6 @@ Cambridge CB2 3QH, England. .rs .sp .nf -Last updated: 06 March 2007 +Last updated: 13 June 2007 Copyright (c) 1997-2007 University of Cambridge. .fi diff --git a/doc/pcreprecompile.3 b/doc/pcreprecompile.3 index fcc45cb..e0ff922 100644 --- a/doc/pcreprecompile.3 +++ b/doc/pcreprecompile.3 @@ -117,17 +117,9 @@ usual way. .SH "COMPATIBILITY WITH DIFFERENT PCRE RELEASES" .rs .sp -The layout of the control block that is at the start of the data that makes up -a compiled pattern was changed for release 5.0. If you have any saved patterns -that were compiled with previous releases (not a facility that was previously -advertised), you will have to recompile them for release 5.0 and above. -.P -If you have any saved patterns in UTF-8 mode that use \ep or \eP that were -compiled with any release up to and including 6.4, you will have to recompile -them for release 6.5 and above. -.P -All saved patterns from earlier releases must be recompiled for release 7.0 or -higher, because there was an internal reorganization at that release. +In general, it is safest to recompile all saved patterns when you update to a +new PCRE release, though not all updates actually require this. Recompiling is +definitely needed for release 7.2. . . . @@ -145,6 +137,6 @@ Cambridge CB2 3QH, England. .rs .sp .nf -Last updated: 24 April 2007 +Last updated: 13 June 2007 Copyright (c) 1997-2007 University of Cambridge. .fi diff --git a/doc/pcresample.3 b/doc/pcresample.3 index 1573b4a..6fbe788 100644 --- a/doc/pcresample.3 +++ b/doc/pcresample.3 @@ -18,9 +18,10 @@ check for further matches of the same regular expression in the same subject string. The logic is a little bit tricky because of the possibility of matching an empty string. Comments in the code explain what is going on. .P -If PCRE is installed in the standard include and library directories for your -system, you should be able to compile the demonstration program using this -command: +The demonstration program is automatically built if you use "./configure;make" +to build PCRE. Otherwise, if PCRE is installed in the standard include and +library directories for your system, you should be able to compile the +demonstration program using this command: .sp gcc -o pcredemo pcredemo.c -lpcre .sp @@ -75,6 +76,6 @@ Cambridge CB2 3QH, England. .rs .sp .nf -Last updated: 06 March 2007 +Last updated: 13 June 2007 Copyright (c) 1997-2007 University of Cambridge. .fi diff --git a/maint/README b/maint/README index 8515c3d..3253881 100644 --- a/maint/README +++ b/maint/README @@ -1,16 +1,16 @@ MAINTENANCE README FOR PCRE --------------------------- -The files in the "maint" directory of the PCRE source contain data, scripts, +The files in the "maint" directory of the PCRE source contain data, scripts, and programs that are used for the maintenance of PCRE, but which do not form -part of the PCRE distribution tarballs. This document describes these files and +part of the PCRE distribution tarballs. This document describes these files and also contains some notes for maintainers. Its contents are: Files in the maint directory Updating to a new Unicode release Preparing for a PCRE release Making a PCRE release - Long-term ideas (wish list) + Long-term ideas (wish list) Files in the maint directory @@ -20,22 +20,22 @@ Builducptable A Perl script that creates the contents of the ucptable.h file from two Unicode data files, which themselves are downloaded from the Unicode web site. Run this script in the "maint" directory. - + ManyConfigTests A shell script that runs "configure, make, test" a number of times with different configuration settings. - -Unicode.tables The files in this directory, Scripts.txt and UnicodeData.txt, - were downloaded from the Unicode web site. They contain + +Unicode.tables The files in this directory, Scripts.txt and UnicodeData.txt, + were downloaded from the Unicode web site. They contain information about Unicode characters and scripts. - + ucptest.c A short C program for testing the Unicode property functions in pcre_ucp_searchfuncs.c, mainly useful after rebuilding the - Unicode property table. Compile and run this in the "maint" + Unicode property table. Compile and run this in the "maint" directory. - + ucptestdata A directory containing two files, testinput1 and testoutput1, to use in conjunction with the ucptest program. - + utf8.c A short, freestanding C program for converting a Unicode code point into a sequence of bytes in the UTF-8 encoding, and vice versa. If its argument is a hex number such as 0x1234, it @@ -43,16 +43,16 @@ utf8.c A short, freestanding C program for converting a Unicode code is sequence of concatenated UTF-8 bytes (e.g. e188b4) it treats them as a UTF-8 character and outputs the equivalent code point in hex. - + Updating to a new Unicode release --------------------------------- -When there is a new release of Unicode, the files in Unicode.tables must be -refreshed from the web site, and the Buildupctable script can then be run to -generate a new version of ucptable.h. The ucptest program can be used to check -that the resulting table works properly, using the data files in ucptestdata to -check a number of test characters. +When there is a new release of Unicode, the files in Unicode.tables must be +refreshed from the web site, and the Buildupctable script can then be run to +generate a new version of ucptable.h. The ucptest program can be used to check +that the resulting table works properly, using the data files in ucptestdata to +check a number of test characters. Preparing for a PCRE release @@ -66,42 +66,42 @@ distribution for a new release. . Run ./autogen.sh to ensure everything is up-to-date. -. Compile and test with many different config options, and combinations of +. Compile and test with many different config options, and combinations of options. The maint/ManyConfigTests script now encapsulates this testing. - + . Run perltest.pl on the test data for tests 1 and 4. The output should match - the PCRE test output, apart from the version identification at the top. The + the PCRE test output, apart from the version identification at the top. The other tests are not Perl-compatible (they use various special PCRE options). . Test with valgrind by running "RunTest valgrind". There is also "RunGrepTest valgrind", though that takes quite a long time. - -. It may also useful to test with Electric Fence, though the fact that it - grumbles for missing free() calls can be a nuisance. (A missing free() in + +. It may also useful to test with Electric Fence, though the fact that it + grumbles for missing free() calls can be a nuisance. (A missing free() in pcretest is hardly a big problem.) To build with EF, use: - + LIBS='/usr/lib/libefence.a -lpthread' with ./configure. Then all normal runs use it to check for buffer overflow. Also run everything with: - - EF_PROTECT_BELOW=1 <whatever> - - because there have been problems with lookbehinds that looked too far. - -. Test with the emulated memmove() function by undefining HAVE_MEMMOVE and - HAVE_BCOPY in config.h. You may see a number of "pcre_memmove defined but not + + EF_PROTECT_BELOW=1 <whatever> + + because there have been problems with lookbehinds that looked too far. + +. Test with the emulated memmove() function by undefining HAVE_MEMMOVE and + HAVE_BCOPY in config.h. You may see a number of "pcre_memmove defined but not used" warnings for the modules in which there is no call to memmove(). These can be ignored. -. Documentation: check AUTHORS, COPYING, ChangeLog (check date), INSTALL, - LICENCE, NEWS (check date), NON-UNIX-USE, and README. Many of these won't +. Documentation: check AUTHORS, COPYING, ChangeLog (check date), INSTALL, + LICENCE, NEWS (check date), NON-UNIX-USE, and README. Many of these won't need changing, but over the long term things do change. - + . Man pages: Check all man pages for \ not followed by e or f or " because that indicates a markup error. -. When the release is built, test it on a number of different operating +. When the release is built, test it on a number of different operating systems if possible, and using different compilers as well. For example, on Solaris it is helpful to test using Sun's cc compiler as a change from gcc. Adding -xarch=v9 to the cc options does a 64-bit test, but it also @@ -122,148 +122,143 @@ Future ideas (wish list) ------------------------ This section records a list of ideas so that they do not get forgotten. They -vary enormously in their usefulness and potential for implementation. Some are +vary enormously in their usefulness and potential for implementation. Some are very sensible; some are rather wacky. Some have been on this list for years; others are relatively new. . Optimization - There are always ideas for new optimizations so as to speed up pattern - matching. Most of them try to save work by recognizing a non-match without + There are always ideas for new optimizations so as to speed up pattern + matching. Most of them try to save work by recognizing a non-match without having to scan all the possibilities. These are some that I've recorded: * /((A{0,5}){0,5}){0,5}(something complex)/ on a non-matching string is very slow, though Perl is fast. Can we speed up somehow? Convert to {0,125}? - OTOH, this is pathological - the user could easily fix it. - + OTOH, this is pathological - the user could easily fix it. + * Turn ={4} into ==== ? (for speed). I once did an experiment, and it seems to have little effect, and maybe makes things worse. - - * "Ends with literal string" - note that a single character doesn't gain much + + * "Ends with literal string" - note that a single character doesn't gain much over the existing "required byte" (reqbyte) feature that just saves one byte. - + * These probably need to go in study(): - + o Remember an initial string rather than just 1 char? - + o A required byte from alternatives - not just the last char, but an earlier one if common to all alternatives. - + o Minimum length of subject needed. - + o Friedl contains other ideas. - + . If Perl gets to a consistent state over the settings of capturing sub- patterns inside repeats, see if we can match it. One example of the difference is the matching of /(main(O)?)+/ against mainOmain, where PCRE leaves $2 set. In Perl, it's unset. Changing this in PCRE will be very hard because I think it needs much more state to be remembered. - -. Perl 6 will be a revolution. Is it a revolution too far for PCRE? + +. Perl 6 will be a revolution. Is it a revolution too far for PCRE? . Unicode - * Note that in Perl, \s matches \pZ and similarly for \d, \w and the POSIX - character classes. For the moment, I've chosen not to support this for - backward compatibility, for speed, and because it would be messy to + * Note that in Perl, \s matches \pZ and similarly for \d, \w and the POSIX + character classes. For the moment, I've chosen not to support this for + backward compatibility, for speed, and because it would be messy to implement. - + * A different approach to Unicode might be to use a typedef to do everything in unsigned shorts instead of unsigned chars. Actually, we'd have to have a new typedef to distinguish data from bits of compiled pattern that are in bytes, I think. There would need to be conversion functions in and out. I don't think this is particularly trivial - and anyway, Unicode now has characters that need more than 16 bits, so is this at all sensible? - + * There has been a request for direct support of 16-bit characters and UTF-16. However, since Unicode is moving beyond purely 16-bit characters, is this worth it at all? One possible way of handling 16-bit characters would be to "load" them in the same way that UTF-8 characters are loaded. - + . Allow errorptr and erroroffset to be NULL. I don't like this idea. . Line endings: * Option to use NUL as a line terminator in subject strings. This could now be done relatively easily since the extension to support LF, CR, and CRLF. - If this is done, a suitable option for pcregrep is also required. - + If this is done, a suitable option for pcregrep is also required. + . Option to provide the pattern with a length instead of with a NUL terminator. - This probably affects quite a few places in the code. + This probably affects quite a few places in the code. -. Catch SIGSEGV for stack overflows? - -. "Cut" as described in Jeffrey Friedl's book, p364: \v and \V. The definitions - aren't yet clear enough for me. \v flushes saved states so that no - backtracking to anything earlier can happen; \V says "no more bumpalong", but - does it fail the current match? As described in the book, these aren't really - "cut" as in Prolog, are they? NOTE: (a) PCRE once had "cut", but it was - removed when atomic groups were introduced. (b) Perl 5.10 has some (*PRUNE) - features -- see below. +. Catch SIGSEGV for stack overflows? . A feature to suspend a match via a callout was once requested. . Option to convert results into character offsets and character lengths. -. Option for pcregrep to scan only the start of a file. I am not keen - this is +. Option for pcregrep to scan only the start of a file. I am not keen - this is the job of "head". - -. A (non-Unix) user wanted pcregrep options to (a) list a file name just once, + +. A (non-Unix) user wanted pcregrep options to (a) list a file name just once, preceded by a blank line, instead of adding it to every matched line, and (b) support --outputfile=name. - + . Consider making UTF-8 and UCP the default for PCRE n.0 for some n > 7. -. Add a user pointer to pcre_malloc/free functions -- some option would be +. Add a user pointer to pcre_malloc/free functions -- some option would be needed to retain backward compatibility. - + . Define a union for the results from pcre_fullinfo(). -. Provide a "random access to the subject" facility so that the way in which it - is stored is independent of PCRE. For efficiency, it probably isn't possible +. Provide a "random access to the subject" facility so that the way in which it + is stored is independent of PCRE. For efficiency, it probably isn't possible to switch this dynamically. It would have to be specified when PCRE was compiled. PCRE would then call a function every time it wanted a character. - + . There are new (*PRUNE) facilities in Perl 5.10, some of which it might be relatively easy to implement. - -. Also in Perl 5.10 are relative subroutine references (?&-1) and (?&+1) which - I didn't know about when I added some 5.10 features for PCRE 7.0. What about - (?(-1)... as a condition? That's an obvious extension, even if Perl 5.10 - doesn't have it. - + . Wild thought: the ability to compile from PCRE's internal byte code to a real FSM and a very fast (third) matcher to process the result. There would be even more restrictions than for pcre_dfa_exec(), however. This is not easy. - + . Should pcretest have some private locale data, to avoid relying on the available locales for the test data, since different OS have different ideas? This won't be as thorough a test, but perhaps that doesn't really matter. - -. pcregrep: add -rs for a sorted recurse? Having to store file names and sort + +. pcregrep: add -rs for a sorted recurse? Having to store file names and sort them will of course slow it down. -. Re-arrange test 2: take out the link-size dependent stuff for a separate test - that is run only when the link size *is* 2; leave in some non-numbered - debugging tests using the new /Z feature. - -. Stan Switzer's goto replacement for longjmp, which is apparently very slow on - OS-X. This is used when stack recursion is disabled. It would be worth doing - some timing tests on other OS. - -. Someone suggested --disable-callout to save code space when callouts are - never wanted. This seems rather marginal. - -. Work needs doing so that the pcregrep tests work better with different - linebreak settings. Currently, some tests don't work when the input files - do not have \n line endings. - -. If the fr_FR locale isn't available for testing, try "french" instead, - because this may be available on Windows. It means modifying the test data, - however. +. Someone suggested --disable-callout to save code space when callouts are + never wanted. This seems rather marginal. + +. "Cut" as described in Jeffrey Friedl's book, p364: \v and \V. The definitions + aren't yet clear enough for me. \v flushes saved states so that no + backtracking to anything earlier can happen; \V says "no more bumpalong", but + does it fail the current match? As described in the book, these aren't really + "cut" as in Prolog, are they? NOTE: (a) PCRE once had "cut", but it was + removed when atomic groups were introduced. (b) Perl 5.10 has some (*PRUNE) + features -- + +. These are the Perl 5.10 backtracking control features (all of which are + described as "experimental" -- some of them "very experimental") that it + might be easy to add to PCRE. They all succeed when encountered, but act as + follows when backtracking: + + (*PRUNE) fail this match attempt, but still bumpalong + (*SKIP) fail this match attempt, bumpalong to current match point + (*THEN) fail this branch, try next branch at same level or fail if none + (*COMMIT) fail this match attempt, suppress bumpalong + (*FAIL) fail and backtrack (same as (?!) and that can be optimized) + (*F) synonym for (*FAIL) + (*ACCEPT) behave as if end of pattern reached ("very experimental") + + Some of these can have arguments (*PRUNE:NAME) but I'm not sure whether they + make sense in the PCRE context. Philip Hazel Email local part: ph10 Email domain: cam.ac.uk -Last updated: 24 April 2007 +Last updated: 13 June 2007 |