@@ -42,13 +44,75 @@ details of the regular expressions themselves, see the documentation. For details of the PCRE library function calls and their options, see the pcreapi -documentation. The input for pcretest is a sequence of regular expression -patterns and strings to be matched, as described below. The output shows the -result of each match. Options on the command line and the patterns control PCRE -options and exactly what is output. +, +pcre16 +and +pcre32 +documentation.
-+The input for pcretest is a sequence of regular expression patterns and +strings to be matched, as described below. The output shows the result of each +match. Options on the command line and the patterns control PCRE options and +exactly what is output. +
++As PCRE has evolved, it has acquired many different features, and as a result, +pcretest now has rather a lot of obscure options for testing every +possible feature. Some of these options are specifically designed for use in +conjunction with the test script and data files that are distributed as part of +PCRE, and are unlikely to be of use otherwise. They are all documented here, +but without much justification. +
++Input to pcretest is processed line by line, either by calling the C +library's fgets() function, or via the libreadline library (see +below). In Unix-like environments, fgets() treats any bytes other than +newline as data characters. However, in some Windows environments character 26 +(hex 1A) causes an immediate end of file, and no further data is read. For +maximum portability, therefore, it is safest to use only ASCII characters in +pcretest input files. +
++From release 8.30, two separate PCRE libraries can be built. The original one +supports 8-bit character strings, whereas the newer 16-bit library supports +character strings encoded in 16-bit units. From release 8.32, a third library +can be built, supporting character strings encoded in 32-bit units. The +pcretest program can be used to test all three libraries. However, it is +itself still an 8-bit program, reading 8-bit input and writing 8-bit output. +When testing the 16-bit or 32-bit library, the patterns and data strings are +converted to 16- or 32-bit format before being passed to the PCRE library +functions. Results are converted to 8-bit for output. +
++References to functions and structures of the form pcre[16|32]_xx below +mean "pcre_xx when using the 8-bit library, pcre16_xx when using +the 16-bit library, or pcre32_xx when using the 32-bit library". +
++-8 +If both the 8-bit library has been built, this option causes the 8-bit library +to be used (which is the default); if the 8-bit library has not been built, +this option causes an error. +
++-16 +If both the 8-bit or the 32-bit, and the 16-bit libraries have been built, this +option causes the 16-bit library to be used. If only the 16-bit library has been +built, this is the default (so has no effect). If only the 8-bit or the 32-bit +library has been built, this option causes an error. +
++-32 +If both the 8-bit or the 16-bit, and the 32-bit libraries have been built, this +option causes the 32-bit library to be used. If only the 32-bit library has been +built, this is the default (so has no effect). If only the 8-bit or the 16-bit +library has been built, this option causes an error. +
+-b Behave as if each pattern has the /B (show byte code) modifier; the internal form is output after compilation. @@ -56,9 +120,40 @@ internal form is output after compilation.
-C Output the version number of the PCRE library, and all available information -about the optional features that are included, and then exit. +about the optional features that are included, and then exit with zero exit +code. All other options are ignored.
+-C option +Output information about a specific build-time option, then exit. This +functionality is intended for use in scripts such as RunTest. The +following options output the value and set the exit code as indicated: +
+ ebcdic-nl the code for LF (= NL) in an EBCDIC environment: + 0x15 or 0x25 + 0 if used in an ASCII environment + exit code is always 0 + linksize the configured internal link size (2, 3, or 4) + exit code is set to the link size + newline the default newline setting: + CR, LF, CRLF, ANYCRLF, or ANY + exit code is always 0 ++The following options output 1 for true or 0 for false, and set the exit code +to the same value: +
+ ebcdic compiled for an EBCDIC environment + jit just-in-time support is available + pcre16 the 16-bit library was built + pcre32 the 32-bit library was built + pcre8 the 8-bit library was built + ucp Unicode property support is available + utf UTF-8 and/or UTF-16 and/or UTF-32 support + is available ++If an unknown option is given, an error message is output; the exit code is 0. + +
-d Behave as if each pattern has the /D (debug) modifier; the internal form and information about the compiled pattern is output after compilation; @@ -67,8 +162,8 @@ form and information about the compiled pattern is out
-dfa Behave as if each data line contains the \D escape sequence; this causes the -alternative matching function, pcre_dfa_exec(), to be used instead of the -standard pcre_exec() function (more detail is given below). +alternative matching function, pcre[16|32]_dfa_exec(), to be used instead +of the standard pcre[16|32]_exec() function (more detail is given below).
-help @@ -83,27 +178,34 @@ compiled pattern is given after compilation. -M Behave as if each data line contains the \M escape sequence; this causes PCRE to discover the minimum MATCH_LIMIT and MATCH_LIMIT_RECURSION settings by -calling pcre_exec() repeatedly with different limits. +calling pcre[16|32]_exec() repeatedly with different limits.
-m Output the size of each compiled pattern after it has been compiled. This is -equivalent to adding /M to each regular expression. +equivalent to adding /M to each regular expression. The size is given in +bytes for both libraries.
+-O +Behave as if each pattern has the /O modifier, that is disable +auto-possessification for all patterns. +
+-o osize Set the number of elements in the output vector that is used when calling -pcre_exec() or pcre_dfa_exec() to be osize. The default value -is 45, which is enough for 14 capturing subexpressions for pcre_exec() or -22 different matches for pcre_dfa_exec(). The vector size can be -changed for individual matching calls by including \O in the data line (see -below). +pcre[16|32]_exec() or pcre[16|32]_dfa_exec() to be osize. The +default value is 45, which is enough for 14 capturing subexpressions for +pcre[16|32]_exec() or 22 different matches for +pcre[16|32]_dfa_exec(). +The vector size can be changed for individual matching calls by including \O +in the data line (see below).
-p Behave as if each pattern has the /P modifier; the POSIX wrapper API is used to call PCRE. None of the other options has any effect when -p is -set. +set. This option can be used only with the 8-bit library.
-q @@ -117,41 +219,68 @@ megabytes.
-s or -s+ Behave as if each pattern has the /S modifier; in other words, force each -pattern to be studied. If -s+ is used, the PCRE_STUDY_JIT_COMPILE flag is -passed to pcre_study(), causing just-in-time optimization to be set up if -it is available. If the /I or /D option is present on a pattern -(requesting output about the compiled pattern), information about the result of -studying is not included when studying is caused only by -s and neither --i nor -d is present on the command line. This behaviour means that -the output from tests that are run with and without -s should be -identical, except when options that output information about the actual running -of a match are set. The -M, -t, and -tm options, which give -information about resources used, are likely to produce different output with -and without -s. Output may also differ if the /C option is present -on an individual pattern. This uses callouts to trace the the matching process, -and this may be different between studied and non-studied patterns. If the -pattern contains (*MARK) items there may also be differences, for the same -reason. The -s command line option can be overridden for specific -patterns that should never be studied (see the /S pattern modifier -below). +pattern to be studied. If -s+ is used, all the JIT compile options are +passed to pcre[16|32]_study(), causing just-in-time optimization to be set +up if it is available, for both full and partial matching. Specific JIT compile +options can be selected by following -s+ with a digit in the range 1 to +7, which selects the JIT compile modes as follows: +
+ 1 normal match only + 2 soft partial match only + 3 normal match and soft partial match + 4 hard partial match only + 6 soft and hard partial match + 7 all three modes (default) ++If -s++ is used instead of -s+ (with or without a following digit), +the text "(JIT)" is added to the first output line after a match or no match +when JIT-compiled code was actually used. +
-t -Run each compile, study, and match many times with a timer, and output -resulting time per compile or match (in milliseconds). Do not set -m with --t, because you will then get the size output a zillion times, and the -timing will be distorted. You can control the number of iterations that are -used for timing by following -t with a number (as a separate item on the -command line). For example, "-t 1000" would iterate 1000 times. The default is -to iterate 500000 times. +Run each compile, study, and match many times with a timer, and output the +resulting times per compile, study, or match (in milliseconds). Do not set +-m with -t, because you will then get the size output a zillion +times, and the timing will be distorted. You can control the number of +iterations that are used for timing by following -t with a number (as a +separate item on the command line). For example, "-t 1000" iterates 1000 times. +The default is to iterate 500000 times.
-tm This is like -t except that it times only the matching phase, not the compile or study phases.
-+-T -TM +These behave like -t and -tm, but in addition, at the end of a run, +the total times for all compiles, studies, and matches are output. +
+If pcretest is given two filename arguments, it reads from the first and writes to the second. If it is given only one filename argument, it reads from that file and writes to stdout. Otherwise, it reads from stdin and writes to @@ -168,7 +297,7 @@ option states whether or not readline() will be
The program handles any number of sets of input on a single input file. Each set starts with a regular expression, and continues with any number of data -lines to be matched against the pattern. +lines to be matched against that pattern.
Each data line is matched separately and independently. If you want to do @@ -207,46 +336,113 @@ backslash, because is interpreted as the first line of a pattern that starts with "abc/", causing pcretest to read the next line as a continuation of the regular expression.
-A pattern may be followed by any number of modifiers, which are mostly single -characters. Following Perl usage, these are referred to below as, for example, -"the /i modifier", even though the delimiter of the pattern need not -always be a slash, and no slash is used when writing modifiers. White space may -appear between the final pattern delimiter and the first modifier, and between -the modifiers themselves. +characters, though some of these can be qualified by further characters. +Following Perl usage, these are referred to below as, for example, "the +/i modifier", even though the delimiter of the pattern need not always be +a slash, and no slash is used when writing modifiers. White space may appear +between the final pattern delimiter and the first modifier, and between the +modifiers themselves. For reference, here is a complete list of modifiers. They +fall into several groups that are described in detail in the following +sections. +
+ /8 set UTF mode + /9 set PCRE_NEVER_UTF (locks out UTF mode) + /? disable UTF validity check + /+ show remainder of subject after match + /= show all captures (not just those that are set) + + /A set PCRE_ANCHORED + /B show compiled code + /C set PCRE_AUTO_CALLOUT + /D same as /B plus /I + /E set PCRE_DOLLAR_ENDONLY + /F flip byte order in compiled pattern + /f set PCRE_FIRSTLINE + /G find all matches (shorten string) + /g find all matches (use startoffset) + /I show information about pattern + /i set PCRE_CASELESS + /J set PCRE_DUPNAMES + /K show backtracking control names + /L set locale + /M show compiled memory size + /m set PCRE_MULTILINE + /N set PCRE_NO_AUTO_CAPTURE + /O set PCRE_NO_AUTO_POSSESS + /P use the POSIX wrapper + /S study the pattern after compilation + /s set PCRE_DOTALL + /T select character tables + /U set PCRE_UNGREEDY + /W set PCRE_UCP + /X set PCRE_EXTRA + /x set PCRE_EXTENDED + /Y set PCRE_NO_START_OPTIMIZE + /Z don't show lengths in /B output + + /<any> set PCRE_NEWLINE_ANY + /<anycrlf> set PCRE_NEWLINE_ANYCRLF + /<cr> set PCRE_NEWLINE_CR + /<crlf> set PCRE_NEWLINE_CRLF + /<lf> set PCRE_NEWLINE_LF + /<bsr_anycrlf> set PCRE_BSR_ANYCRLF + /<bsr_unicode> set PCRE_BSR_UNICODE + /<JS> set PCRE_JAVASCRIPT_COMPAT + ++
The /i, /m, /s, and /x modifiers set the PCRE_CASELESS, PCRE_MULTILINE, PCRE_DOTALL, or PCRE_EXTENDED options, respectively, when -pcre_compile() is called. These four modifier letters have the same +pcre[16|32]_compile() is called. These four modifier letters have the same effect as they do in Perl. For example:
/caseless/i -+ + + +
The following table shows additional modifiers for setting PCRE compile-time options that do not correspond to anything in Perl:
- /8 PCRE_UTF8 - /? PCRE_NO_UTF8_CHECK + /8 PCRE_UTF8 ) when using the 8-bit + /? PCRE_NO_UTF8_CHECK ) library + + /8 PCRE_UTF16 ) when using the 16-bit + /? PCRE_NO_UTF16_CHECK ) library + + /8 PCRE_UTF32 ) when using the 32-bit + /? PCRE_NO_UTF32_CHECK ) library + + /9 PCRE_NEVER_UTF /A PCRE_ANCHORED /C PCRE_AUTO_CALLOUT /E PCRE_DOLLAR_ENDONLY /f PCRE_FIRSTLINE /J PCRE_DUPNAMES /N PCRE_NO_AUTO_CAPTURE + /O PCRE_NO_AUTO_POSSESS /U PCRE_UNGREEDY /W PCRE_UCP /X PCRE_EXTRA /Y PCRE_NO_START_OPTIMIZE - /<JS> PCRE_JAVASCRIPT_COMPAT + /<any> PCRE_NEWLINE_ANY + /<anycrlf> PCRE_NEWLINE_ANYCRLF /<cr> PCRE_NEWLINE_CR - /<lf> PCRE_NEWLINE_LF /<crlf> PCRE_NEWLINE_CRLF - /<anycrlf> PCRE_NEWLINE_ANYCRLF - /<any> PCRE_NEWLINE_ANY + /<lf> PCRE_NEWLINE_LF /<bsr_anycrlf> PCRE_BSR_ANYCRLF /<bsr_unicode> PCRE_BSR_UNICODE + /<JS> PCRE_JAVASCRIPT_COMPATThe modifiers that are enclosed in angle brackets are literal strings as shown, including the angle brackets, but the letters within can be in either case. @@ -254,10 +450,13 @@ This example sets multiline matching with CRLF as the
/^abc/m<CRLF>-As well as turning on the PCRE_UTF8 option, the /8 modifier also causes -any non-printing characters in output strings to be printed using the -\x{hh...} notation if they are valid UTF-8 sequences. Full details of the PCRE -options are given in the +As well as turning on the PCRE_UTF8/16/32 option, the /8 modifier causes +all non-printing characters in output strings to be printed using the +\x{hh...} notation. Otherwise, those less than 0x100 are output in hex without +the curly brackets. + +
+Full details of the PCRE options are given in the pcreapi documentation.
@@ -269,14 +468,14 @@ Searching for all possible matches within each subject by the /g or /G modifier. After finding a match, PCRE is called again to search the remainder of the subject string. The difference between /g and /G is that the former uses the startoffset argument to -pcre_exec() to start searching at a new point within the entire string -(which is in effect what Perl does), whereas the latter passes over a shortened -substring. This makes a difference to the matching process if the pattern -begins with a lookbehind assertion (including \b or \B). +pcre[16|32]_exec() to start searching at a new point within the entire +string (which is in effect what Perl does), whereas the latter passes over a +shortened substring. This makes a difference to the matching process if the +pattern begins with a lookbehind assertion (including \b or \B).-If any call to pcre_exec() in a /g or /G sequence matches an -empty string, the next call is done with the PCRE_NOTEMPTY_ATSTART and +If any call to pcre[16|32]_exec() in a /g or /G sequence matches +an empty string, the next call is done with the PCRE_NOTEMPTY_ATSTART and PCRE_ANCHORED flags set in order to search for another, non-empty, match at the same point. If this second match fails, the start offset is advanced, and the normal match is retried. This imitates the way Perl handles such cases when @@ -300,24 +499,23 @@ contains multiple copies of the same substring. If the twice, the same action is taken for captured substrings. In each case the remainder is output on the following line with a plus character following the capture number. Note that this modifier must not immediately follow the /S -modifier because /S+ has another meaning. +modifier because /S+ and /S++ have other meanings.
The /= modifier requests that the values of all potential captured -parentheses be output after a match by pcre_exec(). By default, only -those up to the highest one actually used in the match are output -(corresponding to the return code from pcre_exec()). Values in the -offsets vector corresponding to higher numbers should be set to -1, and these -are output as "<unset>". This modifier gives a way of checking that this is -happening. +parentheses be output after a match. By default, only those up to the highest +one actually used in the match are output (corresponding to the return code +from pcre[16|32]_exec()). Values in the offsets vector corresponding to +higher numbers should be set to -1, and these are output as "<unset>". This +modifier gives a way of checking that this is happening.
The /B modifier is a debugging feature. It requests that pcretest -output a representation of the compiled byte code after compilation. Normally -this information contains length and offset values; however, if /Z is -also present, this data is replaced by spaces. This is a special feature for -use in the automatic test scripts; it ensures that the same output is generated -for different internal link sizes. +output a representation of the compiled code after compilation. Normally this +information contains length and offset values; however, if /Z is also +present, this data is replaced by spaces. This is a special feature for use in +the automatic test scripts; it ensures that the same output is generated for +different internal link sizes.
The /D modifier is a PCRE debugging feature, and is equivalent to @@ -325,29 +523,29 @@ The /D modifier is a PCRE debugging feature, an
The /F modifier causes pcretest to flip the byte order of the -fields in the compiled pattern that contain 2-byte and 4-byte numbers. This -facility is for testing the feature in PCRE that allows it to execute patterns -that were compiled on a host with a different endianness. This feature is not -available when the POSIX interface to PCRE is being used, that is, when the -/P pattern modifier is specified. See also the section about saving and -reloading compiled patterns below. +2-byte and 4-byte fields in the compiled pattern. This facility is for testing +the feature in PCRE that allows it to execute patterns that were compiled on a +host with a different endianness. This feature is not available when the POSIX +interface to PCRE is being used, that is, when the /P pattern modifier is +specified. See also the section about saving and reloading compiled patterns +below.
The /I modifier requests that pcretest output information about the compiled pattern (whether it is anchored, has a fixed first character, and -so on). It does this by calling pcre_fullinfo() after compiling a +so on). It does this by calling pcre[16|32]_fullinfo() after compiling a pattern. If the pattern is studied, the results of that are also output.
The /K modifier requests pcretest to show names from backtracking -control verbs that are returned from calls to pcre_exec(). It causes -pcretest to create a pcre_extra block if one has not already been -created by a call to pcre_study(), and to set the PCRE_EXTRA_MARK flag -and the mark field within it, every time that pcre_exec() is -called. If the variable that the mark field points to is non-NULL for a -match, non-match, or partial match, pcretest prints the string to which -it points. For a match, this is shown on a line by itself, tagged with "MK:". -For a non-match it is added to the message. +control verbs that are returned from calls to pcre[16|32]_exec(). It causes +pcretest to create a pcre[16|32]_extra block if one has not already +been created by a call to pcre[16|32]_study(), and to set the +PCRE_EXTRA_MARK flag and the mark field within it, every time that +pcre[16|32]_exec() is called. If the variable that the mark field +points to is non-NULL for a match, non-match, or partial match, pcretest +prints the string to which it points. For a match, this is shown on a line by +itself, tagged with "MK:". For a non-match it is added to the message.
The /L modifier must be followed directly by the name of a locale, for @@ -356,45 +554,77 @@ example, /pattern/Lfr_FR For this reason, it must be the last modifier. The given locale is set, -pcre_maketables() is called to build a set of character tables for the -locale, and this is then passed to pcre_compile() when compiling the -regular expression. Without an /L (or /T) modifier, NULL is passed -as the tables pointer; that is, /L applies only to the expression on -which it appears. +pcre[16|32]_maketables() is called to build a set of character tables for +the locale, and this is then passed to pcre[16|32]_compile() when compiling +the regular expression. Without an /L (or /T) modifier, NULL is +passed as the tables pointer; that is, /L applies only to the expression +on which it appears.
-The /M modifier causes the size of memory block used to hold the compiled -pattern to be output. This does not include the size of the pcre block; -it is just the actual compiled data. If the pattern is successfully studied -with the PCRE_STUDY_JIT_COMPILE option, the size of the JIT compiled code is -also output. +The /M modifier causes the size in bytes of the memory block used to hold +the compiled pattern to be output. This does not include the size of the +pcre[16|32] block; it is just the actual compiled data. If the pattern is +successfully studied with the PCRE_STUDY_JIT_COMPILE option, the size of the +JIT compiled code is also output.
-If the /S modifier appears once, it causes pcre_study() to be -called after the expression has been compiled, and the results used when the -expression is matched. If /S appears twice, it suppresses studying, even +The /S modifier causes pcre[16|32]_study() to be called after the +expression has been compiled, and the results used when the expression is +matched. There are a number of qualifying characters that may follow /S. +They may appear in any order. +
++If /S is followed by an exclamation mark, pcre[16|32]_study() is +called with the PCRE_STUDY_EXTRA_NEEDED option, causing it always to return a +pcre_extra block, even when studying discovers no useful information. +
++If /S is followed by a second S character, it suppresses studying, even if it was requested externally by the -s command line option. This makes it possible to specify that certain patterns are always studied, and others are never studied, independently of -s. This feature is used in the test files in a few cases where the output is different when the pattern is studied.
-If the /S modifier is immediately followed by a + character, the call to -pcre_study() is made with the PCRE_STUDY_JIT_COMPILE option, requesting -just-in-time optimization support if it is available. Note that there is also a -/+ modifier; it must not be given immediately after /S because this -will be misinterpreted. If JIT studying is successful, it will automatically be -used when pcre_exec() is run, except when incompatible run-time options -are specified. These include the partial matching options; a complete list is -given in the +If the /S modifier is followed by a + character, the call to +pcre[16|32]_study() is made with all the JIT study options, requesting +just-in-time optimization support if it is available, for both normal and +partial matching. If you want to restrict the JIT compiling modes, you can +follow /S+ with a digit in the range 1 to 7: +
+ 1 normal match only + 2 soft partial match only + 3 normal match and soft partial match + 4 hard partial match only + 6 soft and hard partial match + 7 all three modes (default) ++If /S++ is used instead of /S+ (with or without a following digit), +the text "(JIT)" is added to the first output line after a match or no match +when JIT-compiled code was actually used. + +
+Note that there is also an independent /+ modifier; it must not be given +immediately after /S or /S+ because this will be misinterpreted. +
++If JIT studying is successful, the compiled JIT code will automatically be used +when pcre[16|32]_exec() is run, except when incompatible run-time options +are specified. For more details, see the pcrejit documentation. See also the \J escape sequence below for a way of setting the size of the JIT stack.
+Finally, if /S is followed by a minus character, JIT compilation is +suppressed, even if it was requested externally by the -s command line +option. This makes it possible to specify that JIT is never to be used for +certain patterns. +
+The /T modifier must be followed by a single digit. It causes a specific -set of built-in character tables to be passed to pcre_compile(). It is -used in the standard PCRE tests to check behaviour with different character +set of built-in character tables to be passed to pcre[16|32]_compile(). It +is used in the standard PCRE tests to check behaviour with different character tables. The digit specifies the tables as follows:
0 the default ASCII tables, as distributed in @@ -409,8 +639,9 @@ Using the POSIX wrapper API-If the strings contain any non-printing characters, they are output as \0x -escapes, or as \x{...} escapes if the /8 modifier was present on the -pattern. See below for the definition of non-printing characters. If the -pattern has the /+ modifier, the output for substring 0 is followed by -the the rest of the subject string, identified by "0+" like this: +If the strings contain any non-printing characters, they are output as \xhh +escapes if the value is less than 256 and UTF mode is not set. Otherwise they +are output as \x{hh...} escapes. See below for the definition of non-printing +characters. If the pattern has the /+ modifier, the output for substring +0 is followed by the the rest of the subject string, identified by "0+" like +this:
The /P modifier causes pcretest to call PCRE via the POSIX wrapper -API rather than its native API. When /P is set, the following modifiers -set options for the regcomp() function: +API rather than its native API. This supports only the 8-bit library. When +/P is set, the following modifiers set options for the regcomp() +function:
/i REG_ICASE /m REG_NEWLINE @@ -423,9 +654,40 @@ set options for the regcomp() function: The /+ modifier works as described above. All other modifiers are ignored. --Note that \xhh always specifies one byte, even in UTF-8 mode; this makes it -possible to construct invalid UTF-8 sequences for testing purposes. On the -other hand, \x{hh} is interpreted as a UTF-8 character in UTF-8 mode, -generating more than one byte if the value is greater than 127. When not in -UTF-8 mode, it generates one byte for values less than 256, and causes an error -for greater values. +The use of \x{hh...} is not dependent on the use of the /8 modifier on +the pattern. It is recognized always. There may be any number of hexadecimal +digits inside the braces; invalid values provoke error messages.
DATA LINES
+
+Locking out certain modifiers +
-Before each data line is passed to pcre_exec(), leading and trailing +PCRE can be compiled with or without support for certain features such as +UTF-8/16/32 or Unicode properties. Accordingly, the standard tests are split up +into a number of different files that are selected for running depending on +which features are available. When updating the tests, it is all too easy to +put a new test into the wrong file by mistake; for example, to put a test that +requires UTF support into a file that is used when it is not available. To help +detect such mistakes as early as possible, there is a facility for locking out +specific modifiers. If an input line for pcretest starts with the string +"< forbid " the following sequence of characters is taken as a list of +forbidden modifiers. For example, in the test files that must not use UTF or +Unicode property support, this line appears: +
+ < forbid 8W ++This locks out the /8 and /W modifiers. An immediate error is given if they are +subsequently encountered. If the character string contains < but not >, all the +multi-character modifiers that begin with < are locked out. Otherwise, such +modifiers must be explicitly listed, for example: ++ < forbid <JS><cr> ++There must be a single space between < and "forbid" for this feature to be +recognised. If there is not, the line is interpreted either as a request to +re-load a pre-compiled pattern (see "SAVING AND RELOADING COMPILED PATTERNS" +below) or, if there is a another < character, as a pattern that uses < as its +delimiter. + +
DATA LINES
++Before each data line is passed to pcre[16|32]_exec(), leading and trailing white space is removed, and it is then scanned for \ escapes. Some of these are pretty esoteric features, intended for checking out some of the more complicated features of PCRE. If you are just testing "ordinary" regular @@ -441,55 +703,69 @@ recognized: \r carriage return (\x0d) \t tab (\x09) \v vertical tab (\x0b) - \nnn octal character (up to 3 octal digits) - always a byte unless > 255 in UTF-8 mode + \nnn octal character (up to 3 octal digits); always + a byte unless > 255 in UTF-8 or 16-bit or 32-bit mode + \o{dd...} octal character (any number of octal digits} \xhh hexadecimal byte (up to 2 hex digits) - \x{hh...} hexadecimal character, any number of digits in UTF-8 mode - \A pass the PCRE_ANCHORED option to pcre_exec() or pcre_dfa_exec() - \B pass the PCRE_NOTBOL option to pcre_exec() or pcre_dfa_exec() - \Cdd call pcre_copy_substring() for substring dd after a successful match (number less than 32) - \Cname call pcre_copy_named_substring() for substring "name" after a successful match (name termin- + \x{hh...} hexadecimal character (any number of hex digits) + \A pass the PCRE_ANCHORED option to pcre[16|32]_exec() or pcre[16|32]_dfa_exec() + \B pass the PCRE_NOTBOL option to pcre[16|32]_exec() or pcre[16|32]_dfa_exec() + \Cdd call pcre[16|32]_copy_substring() for substring dd after a successful match (number less than 32) + \Cname call pcre[16|32]_copy_named_substring() for substring "name" after a successful match (name termin- ated by next non alphanumeric character) \C+ show the current captured substrings at callout time \C- do not supply a callout function \C!n return 1 instead of 0 when callout number n is reached \C!n!m return 1 instead of 0 when callout number n is reached for the nth time \C*n pass the number n (may be negative) as callout data; this is used as the callout return value - \D use the pcre_dfa_exec() match function - \F only shortest match for pcre_dfa_exec() - \Gdd call pcre_get_substring() for substring dd after a successful match (number less than 32) - \Gname call pcre_get_named_substring() for substring "name" after a successful match (name termin- + \D use the pcre[16|32]_dfa_exec() match function + \F only shortest match for pcre[16|32]_dfa_exec() + \Gdd call pcre[16|32]_get_substring() for substring dd after a successful match (number less than 32) + \Gname call pcre[16|32]_get_named_substring() for substring "name" after a successful match (name termin- ated by next non-alphanumeric character) \Jdd set up a JIT stack of dd kilobytes maximum (any number of digits) - \L call pcre_get_substringlist() after a successful match + \L call pcre[16|32]_get_substringlist() after a successful match \M discover the minimum MATCH_LIMIT and MATCH_LIMIT_RECURSION settings - \N pass the PCRE_NOTEMPTY option to pcre_exec() or pcre_dfa_exec(); if used twice, pass the + \N pass the PCRE_NOTEMPTY option to pcre[16|32]_exec() or pcre[16|32]_dfa_exec(); if used twice, pass the PCRE_NOTEMPTY_ATSTART option - \Odd set the size of the output vector passed to pcre_exec() to dd (any number of digits) - \P pass the PCRE_PARTIAL_SOFT option to pcre_exec() or pcre_dfa_exec(); if used twice, pass the + \Odd set the size of the output vector passed to pcre[16|32]_exec() to dd (any number of digits) + \P pass the PCRE_PARTIAL_SOFT option to pcre[16|32]_exec() or pcre[16|32]_dfa_exec(); if used twice, pass the PCRE_PARTIAL_HARD option \Qdd set the PCRE_MATCH_LIMIT_RECURSION limit to dd (any number of digits) - \R pass the PCRE_DFA_RESTART option to pcre_dfa_exec() + \R pass the PCRE_DFA_RESTART option to pcre[16|32]_dfa_exec() \S output details of memory get/free calls during matching - \Y pass the PCRE_NO_START_OPTIMIZE option to pcre_exec() or pcre_dfa_exec() - \Z pass the PCRE_NOTEOL option to pcre_exec() or pcre_dfa_exec() - \? pass the PCRE_NO_UTF8_CHECK option to pcre_exec() or pcre_dfa_exec() + \Y pass the PCRE_NO_START_OPTIMIZE option to pcre[16|32]_exec() or pcre[16|32]_dfa_exec() + \Z pass the PCRE_NOTEOL option to pcre[16|32]_exec() or pcre[16|32]_dfa_exec() + \? pass the PCRE_NO_UTF[8|16|32]_CHECK option to pcre[16|32]_exec() or pcre[16|32]_dfa_exec() \>dd start the match at offset dd (optional "-"; then any number of digits); this sets the startoffset - argument for pcre_exec() or pcre_dfa_exec() - \<cr> pass the PCRE_NEWLINE_CR option to pcre_exec() or pcre_dfa_exec() - \<lf> pass the PCRE_NEWLINE_LF option to pcre_exec() or pcre_dfa_exec() - \<crlf> pass the PCRE_NEWLINE_CRLF option to pcre_exec() or pcre_dfa_exec() - \<anycrlf> pass the PCRE_NEWLINE_ANYCRLF option to pcre_exec() or pcre_dfa_exec() - \<any> pass the PCRE_NEWLINE_ANY option to pcre_exec() or pcre_dfa_exec() + argument for pcre[16|32]_exec() or pcre[16|32]_dfa_exec() + \<cr> pass the PCRE_NEWLINE_CR option to pcre[16|32]_exec() or pcre[16|32]_dfa_exec() + \<lf> pass the PCRE_NEWLINE_LF option to pcre[16|32]_exec() or pcre[16|32]_dfa_exec() + \<crlf> pass the PCRE_NEWLINE_CRLF option to pcre[16|32]_exec() or pcre[16|32]_dfa_exec() + \<anycrlf> pass the PCRE_NEWLINE_ANYCRLF option to pcre[16|32]_exec() or pcre[16|32]_dfa_exec() + \<any> pass the PCRE_NEWLINE_ANY option to pcre[16|32]_exec() or pcre[16|32]_dfa_exec()
+Note that \xhh specifies one byte rather than one character in UTF-8 mode; +this makes it possible to construct invalid UTF-8 sequences for testing +purposes. On the other hand, \x{hh} is interpreted as a UTF-8 character in +UTF-8 mode, generating more than one byte if the value is greater than 127. +When testing the 8-bit library not in UTF-8 mode, \x{hh} generates one byte +for values less than 256, and causes an error for greater values. +
++In UTF-16 mode, all 4-digit \x{hhhh} values are accepted. This makes it +possible to construct invalid UTF-16 sequences for testing purposes. +
++In UTF-32 mode, all 4- to 8-digit \x{...} values are accepted. This makes it +possible to construct invalid UTF-32 sequences for testing purposes. +
+The escapes that specify line ending sequences are literal strings, exactly as shown. No more than one newline setting should be present in any data line.
@@ -506,13 +782,13 @@ is not being used. Providing a stack that is larger th necessary only for very complicated patterns.-If \M is present, pcretest calls pcre_exec() several times, with -different values in the match_limit and match_limit_recursion -fields of the pcre_extra data structure, until it finds the minimum -numbers for each parameter that allow pcre_exec() to complete without +If \M is present, pcretest calls pcre[16|32]_exec() several times, +with different values in the match_limit and match_limit_recursion +fields of the pcre[16|32]_extra data structure, until it finds the minimum +numbers for each parameter that allow pcre[16|32]_exec() to complete without error. Because this is testing a specific feature of the normal interpretive -pcre_exec() execution, the use of any JIT optimization that might have -been set up by the /S+ qualifier of -s+ option is disabled. +pcre[16|32]_exec() execution, the use of any JIT optimization that might +have been set up by the /S+ qualifier of -s+ option is disabled.
The match_limit number is a measure of the amount of backtracking @@ -526,7 +802,7 @@ needed to complete the match attempt.
When \O is used, the value specified may be higher or lower than the size set by the -O command line option (or defaulted to 45); \O applies only to -the call of pcre_exec() for the line in which it appears. +the call of pcre[16|32]_exec() for the line in which it appears.
If the /P modifier was present on the pattern, causing the POSIX wrapper @@ -534,20 +810,11 @@ API to be used, the only option-setting sequences that \N, and \Z, causing REG_NOTBOL, REG_NOTEMPTY, and REG_NOTEOL, respectively, to be passed to regexec().
+
THE ALTERNATIVE MATCHING FUNCTION
-The use of \x{hh...} to represent UTF-8 characters is not dependent on the use -of the /8 modifier on the pattern. It is recognized always. There may be -any number of hexadecimal digits inside the braces. The result is from one to -six bytes, encoded according to the original UTF-8 rules of RFC 2279. This -allows for values in the range 0 to 0x7FFFFFFF. Note that not all of those are -valid Unicode code points, or indeed valid UTF-8 characters according to the -later rules in RFC 3629. -
-
THE ALTERNATIVE MATCHING FUNCTION
-By default, pcretest uses the standard PCRE matching function, -pcre_exec() to match each data line. From release 6.0, PCRE supports an -alternative matching function, pcre_dfa_test(), which operates in a +pcre[16|32]_exec() to match each data line. PCRE also supports an +alternative matching function, pcre[16|32]_dfa_test(), which operates in a different way, and has some restrictions. The differences between the two functions are described in the pcrematching @@ -555,30 +822,29 @@ documentation.
If a data line contains the \D escape sequence, or if the command line -contains the -dfa option, the alternative matching function is called. +contains the -dfa option, the alternative matching function is used. This function finds all possible matches at a given point. If, however, the \F escape sequence is present in the data line, it stops after the first match is found. This is always the shortest possible match.
-
DEFAULT OUTPUT FROM PCRETEST
+
DEFAULT OUTPUT FROM PCRETEST
This section describes the output when the normal matching function, -pcre_exec(), is being used. +pcre[16|32]_exec(), is being used.
When a match succeeds, pcretest outputs the list of captured substrings -that pcre_exec() returns, starting with number 0 for the string that +that pcre[16|32]_exec() returns, starting with number 0 for the string that matched the whole pattern. Otherwise, it outputs "No match" when the return is PCRE_ERROR_NOMATCH, and "Partial match:" followed by the partially matching -substring when pcre_exec() returns PCRE_ERROR_PARTIAL. (Note that this is -the entire substring that was inspected during the partial match; it may -include characters before the actual match start if a lookbehind assertion, +substring when pcre[16|32]_exec() returns PCRE_ERROR_PARTIAL. (Note that +this is the entire substring that was inspected during the partial match; it +may include characters before the actual match start if a lookbehind assertion, \K, \b, or \B was involved.) For any other return, pcretest outputs the PCRE negative error number and a short descriptive phrase. If the error is -a failed UTF-8 string check, the byte offset of the start of the failing -character and the reason code are also output, provided that the size of the -output vector is at least two. Here is an example of an interactive -pcretest run. +a failed UTF string check, the offset of the start of the failing character and +the reason code are also output, provided that the size of the output vector is +at least two. Here is an example of an interactive pcretest run.
$ pcretest PCRE version 8.13 2011-04-30 @@ -591,7 +857,7 @@ output vector is at least two. Here is an example of a No matchUnset capturing substrings that are not followed by one that is set are not -returned by pcre_exec(), and are not shown by pcretest. In the +returned by pcre[16|32]_exec(), and are not shown by pcretest. In the following example, there are two capturing substrings, but when the first data line is matched, the second, unset substring is not shown. An "internal" unset substring is shown as "<unset>", as for the second data line. @@ -605,11 +871,12 @@ substring is shown as "<unset>", as for the se 1: <unset> 2: b
re> /cat/+
data> cataract
@@ -651,9 +918,9 @@ prompt is used for continuations), data lines may not.
included in data by means of the \n escape (or \r, \r\n, etc., depending on
the newline sequence setting).
-
OUTPUT FROM THE ALTERNATIVE MATCHING FUNCTION
+
OUTPUT FROM THE ALTERNATIVE MATCHING FUNCTION
-When the alternative matching function, pcre_dfa_exec(), is used (by
+When the alternative matching function, pcre[16|32]_dfa_exec(), is used (by
means of the \D escape sequence or the -dfa command line option), the
output consists of a list of all the matches that start at the first point in
the subject where there is at least one match. For example:
@@ -687,7 +954,7 @@ at the end of the longest match. For example:
Since the matching function does not support substring capture, the escape
sequences that are concerned with captured substrings are not relevant.
-
RESTARTING AFTER A PARTIAL MATCH
+
RESTARTING AFTER A PARTIAL MATCH
When the alternative matching function has given the PCRE_ERROR_PARTIAL return,
indicating that the subject partially matched the pattern, you can restart the
@@ -704,21 +971,21 @@ For further information about partial matching, see th
pcrepartial
documentation.
-
CALLOUTS
+
CALLOUTS
If the pattern contains any callout requests, pcretest's callout function
is called during matching. This works with both matching functions. By default,
the called function displays the callout number, the start and current
positions in the text at the callout time, and the next pattern item to be
-tested. For example, the output
+tested. For example:
--->pqrabcdef
0 ^ ^ \d
-indicates that callout number 0 occurred for a match attempt starting at the
-fourth character of the subject string, when the pointer was at the seventh
-character of the data, and when the next pattern item was \d. Just one
-circumflex is output if the start and current positions are the same.
+This output indicates that callout number 0 occurred for a match attempt
+starting at the fourth character of the subject string, when the pointer was at
+the seventh character of the data, and when the next pattern item was \d. Just
+one circumflex is output if the start and current positions are the same.
Callouts numbered 255 are assumed to be automatic callouts, inserted as a
@@ -765,7 +1032,7 @@ the
pcrecallout
documentation.
-
NON-PRINTING CHARACTERS
+
NON-PRINTING CHARACTERS
When pcretest is outputting text in the compiled version of a pattern,
bytes other than 32-126 are always treated as non-printing characters are are
@@ -777,7 +1044,7 @@ string, it behaves in the same way, unless a different
the pattern (using the /L modifier). In this case, the isprint()
function to distinguish printing and non-printing characters.
-
SAVING AND RELOADING COMPILED PATTERNS
+
SAVING AND RELOADING COMPILED PATTERNS
The facilities described in this section are not available when the POSIX
interface to PCRE is being used, that is, when the /P pattern modifier is
@@ -808,10 +1075,9 @@ writing the file, pcretest expects to read a ne
A saved pattern can be reloaded into pcretest by specifying < and a file
-name instead of a pattern. The name of the file must not contain a < character,
-as otherwise pcretest will interpret the line as a pattern delimited by <
-characters.
-For example:
+name instead of a pattern. There must be no space between < and the file name,
+which must not contain a < character, as otherwise pcretest will
+interpret the line as a pattern delimited by < characters. For example:
re> </some/file
Compiled pattern loaded from /some/file
@@ -825,7 +1091,15 @@ been loaded, pcretest proceeds to read data lin
You can copy a file written by pcretest to a different host and reload it
there, even if the new host has opposite endianness to the one on which the
pattern was compiled. For example, you can compile on an i86 machine and run on
-a SPARC machine.
+a SPARC machine. When a pattern is reloaded on a host with different
+endianness, the confirmation message is changed to:
+
+ Compiled pattern (byte-inverted) loaded from /some/file
+
+The test suite contains some saved pre-compiled patterns with different
+endianness. These are reloaded using "<!" instead of just "<". This suppresses
+the "(byte-inverted)" text so that the output is the same on all hosts. It also
+forces debugging output once the pattern has been reloaded.
File names for saving and reloading can be absolute or relative, but note that
@@ -842,13 +1116,14 @@ string using a reloaded pattern is likely to cause
Finally, if you attempt to load a file that is not in the correct format, the
result is undefined.
-
SEE ALSO
+
SEE ALSO
-pcre(3), pcreapi(3), pcrecallout(3), pcrejit,
-pcrematching(3), pcrepartial(d), pcrepattern(3),
-pcreprecompile(3).
+pcre(3), pcre16(3), pcre32(3), pcreapi(3),
+pcrecallout(3),
+pcrejit, pcrematching(3), pcrepartial(d),
+pcrepattern(3), pcreprecompile(3).
-
AUTHOR
+
AUTHOR
Philip Hazel
@@ -857,11 +1132,11 @@ University Computing Service
Cambridge CB2 3QH, England.
-
REVISION
+
REVISION
-Last updated: 02 December 2011
+Last updated: 12 November 2013
-Copyright © 1997-2011 University of Cambridge.
+Copyright © 1997-2013 University of Cambridge.
Return to the PCRE index page.