--- embedaddon/pcre/doc/pcretest.txt 2012/02/21 23:50:25 1.1.1.2 +++ embedaddon/pcre/doc/pcretest.txt 2013/07/22 08:25:56 1.1.1.4 @@ -1,10 +1,10 @@ -PCRETEST(1) PCRETEST(1) +PCRETEST(1) General Commands Manual PCRETEST(1) + NAME pcretest - a program for testing Perl-compatible regular expressions. - SYNOPSIS pcretest [options] [input file [output file]] @@ -14,132 +14,200 @@ SYNOPSIS expressions. This document describes the features of the test program; for details of the regular expressions themselves, see the pcrepattern documentation. For details of the PCRE library function calls and their - options, see the pcreapi and pcre16 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. + options, see the pcreapi , 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. -PCRE's 8-BIT and 16-BIT LIBRARIES + 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 DATA FORMAT + + 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. + + +PCRE's 8-BIT, 16-BIT AND 32-BIT LIBRARIES + From release 8.30, two separate PCRE libraries can be built. The origi- nal one supports 8-bit character strings, whereas the newer 16-bit - library supports character strings encoded in 16-bit units. The - pcretest program can be used to test both libraries. However, it is - itself still an 8-bit program, reading 8-bit input and writing 8-bit - output. When testing the 16-bit library, the patterns and data strings - are converted to 16-bit format before being passed to the PCRE library - functions. Results are converted to 8-bit for output. + 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]_xx below - mean "pcre_xx when using the 8-bit library or pcre16_xx when using the - 16-bit library". + 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". COMMAND LINE OPTIONS - -16 If both the 8-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 library has been built, this - option causes an error. + -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. - -b Behave as if each pattern has the /B (show byte code) modi- + -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) modi- fier; the internal form is output after compilation. -C Output the version number of the PCRE library, and all avail- - able information about the optional features that are - included, and then exit. All other options are ignored. + able information 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 indicated: + as RunTest. The following options output the value and set + the exit code as indicated: - linksize the internal link size (2, 3, or 4) + 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 zero for false: + 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 support is available + utf UTF-8 and/or UTF-16 and/or UTF-32 support + is available - -d Behave as if each pattern has the /D (debug) modifier; the - internal form and information about the compiled pattern is + 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; -d is equivalent to -b -i. - -dfa Behave as if each data line contains the \D escape sequence; + -dfa Behave as if each data line contains the \D escape sequence; this causes the alternative matching function, - pcre[16]_dfa_exec(), to be used instead of the standard - pcre[16]_exec() function (more detail is given below). + pcre[16|32]_dfa_exec(), to be used instead of the standard + pcre[16|32]_exec() function (more detail is given below). -help Output a brief summary these options and then exit. - -i Behave as if each pattern has the /I modifier; information + -i Behave as if each pattern has the /I modifier; information about the 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[16]_exec() + -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[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 + -m Output the size of each compiled pattern after it has been + compiled. This is equivalent to adding /M to each regular expression. The size is given in bytes for both libraries. - -o osize Set the number of elements in the output vector that is used - when calling pcre[16]_exec() or pcre[16]_dfa_exec() to be - osize. The default value is 45, which is enough for 14 cap- - turing subexpressions for pcre[16]_exec() or 22 different - matches for pcre[16]_dfa_exec(). The vector size can be - changed for individual matching calls by including \O in the - data line (see below). + -o osize Set the number of elements in the output vector that is used + when calling 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 differ- + ent 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. This option can be used only + -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. This option can be used only with the 8-bit library. - -q Do not output the version number of pcretest at the start of + -q Do not output the version number of pcretest at the start of execution. - -S size On Unix-like systems, set the size of the run-time stack to + -S size On Unix-like systems, set the size of the run-time stack to size 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[16]_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. + -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, 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: - 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 + 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 are pattern options that can override -s, + either specifying no studying at all, or suppressing JIT com- + pilation. + + 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 + 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 spe- - cific patterns that should never be studied (see the /S pat- + cific patterns that should never be studied (see the /S pat- tern modifier below). - -t Run each compile, study, and match many times with a timer, - and output resulting time per compile or match (in millisec- - onds). Do not set -m with -t, because you will then get the - size output a zillion times, and the timing will be dis- - torted. You can control the number of iterations that are - used for timing by following -t with a number (as a separate + -t Run each compile, study, and match many times with a timer, + and output resulting time per compile or match (in millisec- + onds). Do not set -m with -t, because you will then get the + size output a zillion times, and the timing will be dis- + torted. 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 iter- ate 1000 times. The default is to iterate 500000 times. @@ -149,77 +217,129 @@ COMMAND LINE OPTIONS DESCRIPTION - If pcretest is given two filename arguments, it reads from the first + 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 stdout, and prompts for each line of input, using + reads from that file and writes to stdout. Otherwise, it reads from + stdin and writes to stdout, and prompts for each line of input, using "re>" to prompt for regular expressions, and "data>" to prompt for data lines. - When pcretest is built, a configuration option can specify that it - should be linked with the libreadline library. When this is done, if + When pcretest is built, a configuration option can specify that it + should be linked with the libreadline library. When this is done, if the input is from a terminal, it is read using the readline() function. - This provides line-editing and history facilities. The output from the + This provides line-editing and history facilities. The output from the -help option states whether or not readline() will be used. 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 num- + Each set starts with a regular expression, and continues with any num- ber of data lines to be matched against the pattern. - Each data line is matched separately and independently. If you want to + Each data line is matched separately and independently. If you want to do multi-line matches, you have to use the \n escape sequence (or \r or \r\n, etc., depending on the newline setting) in a single line of input - to encode the newline sequences. There is no limit on the length of - data lines; the input buffer is automatically extended if it is too + to encode the newline sequences. There is no limit on the length of + data lines; the input buffer is automatically extended if it is too small. - An empty line signals the end of the data lines, at which point a new - regular expression is read. The regular expressions are given enclosed + An empty line signals the end of the data lines, at which point a new + regular expression is read. The regular expressions are given enclosed in any non-alphanumeric delimiters other than backslash, for example: /(a|bc)x+yz/ - White space before the initial delimiter is ignored. A regular expres- - sion may be continued over several input lines, in which case the new- - line characters are included within it. It is possible to include the + White space before the initial delimiter is ignored. A regular expres- + sion may be continued over several input lines, in which case the new- + line characters are included within it. It is possible to include the delimiter within the pattern by escaping it, for example /abc\/def/ - If you do so, the escape and the delimiter form part of the pattern, - but since delimiters are always non-alphanumeric, this does not affect - its interpretation. If the terminating delimiter is immediately fol- + If you do so, the escape and the delimiter form part of the pattern, + but since delimiters are always non-alphanumeric, this does not affect + its interpretation. If the terminating delimiter is immediately fol- lowed by a backslash, for example, /abc/\ - then a backslash is added to the end of the pattern. This is done to - provide a way of testing the error condition that arises if a pattern + then a backslash is added to the end of the pattern. This is done to + provide a way of testing the error condition that arises if a pattern finishes with a backslash, because /abc\/ - is interpreted as the first line of a pattern that starts with "abc/", + 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. PATTERN MODIFIERS - 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. + A pattern may be followed by any number of modifiers, which are mostly + single 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 modi- + fiers. White space may appear between the final pattern delimiter and + the first modifier, and between the modifiers themselves. For refer- + ence, 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 + /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 + + / set PCRE_NEWLINE_ANY + / set PCRE_NEWLINE_ANYCRLF + / set PCRE_NEWLINE_CR + / set PCRE_NEWLINE_CRLF + / set PCRE_NEWLINE_LF + / set PCRE_BSR_ANYCRLF + / set PCRE_BSR_UNICODE + / set PCRE_JAVASCRIPT_COMPAT + + + Perl-compatible modifiers + The /i, /m, /s, and /x modifiers set the PCRE_CASELESS, PCRE_MULTILINE, - PCRE_DOTALL, or PCRE_EXTENDED options, respectively, when pcre[16]_com- - pile() is called. These four modifier letters have the same effect as - they do in Perl. For example: + PCRE_DOTALL, or PCRE_EXTENDED options, respectively, when + pcre[16|32]_compile() is called. These four modifier letters have the + same effect as they do in Perl. For example: /caseless/i + + Modifiers for other PCRE options + The following table shows additional modifiers for setting PCRE com- pile-time options that do not correspond to anything in Perl: @@ -229,6 +349,10 @@ PATTERN MODIFIERS /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 @@ -239,14 +363,14 @@ PATTERN MODIFIERS /W PCRE_UCP /X PCRE_EXTRA /Y PCRE_NO_START_OPTIMIZE - / PCRE_JAVASCRIPT_COMPAT + / PCRE_NEWLINE_ANY + / PCRE_NEWLINE_ANYCRLF / PCRE_NEWLINE_CR - / PCRE_NEWLINE_LF / PCRE_NEWLINE_CRLF - / PCRE_NEWLINE_ANYCRLF - / PCRE_NEWLINE_ANY + / PCRE_NEWLINE_LF / PCRE_BSR_ANYCRLF / PCRE_BSR_UNICODE + / PCRE_JAVASCRIPT_COMPAT The modifiers that are enclosed in angle brackets are literal strings as shown, including the angle brackets, but the letters within can be @@ -255,10 +379,10 @@ PATTERN MODIFIERS /^abc/m - As well as turning on the PCRE_UTF8/16 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. + 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 out- + put in hex without the curly brackets. Full details of the PCRE options are given in the pcreapi documenta- tion. @@ -269,14 +393,14 @@ PATTERN MODIFIERS requested by the /g or /G modifier. After finding a match, PCRE is called again to search the remainder of the subject string. The differ- ence between /g and /G is that the former uses the startoffset argument - to pcre[16]_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). + to 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[16]_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 @@ -296,49 +420,51 @@ PATTERN MODIFIERS fier appears 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. + not immediately follow the /S 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 default, only those up to the + The /= modifier requests that the values of all potential captured + 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]_exec()). Values in the offsets vector corre- - sponding to higher numbers should be set to -1, and these are output as - "". This modifier gives a way of checking that this is happen- - ing. + return code from pcre[16|32]_exec()). Values in the offsets vector cor- + responding to higher numbers should be set to -1, and these are output + as "". This modifier gives a way of checking that this is hap- + pening. - The /B modifier is a debugging feature. It requests that pcretest out- - put 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 fea- - ture for use in the automatic test scripts; it ensures that the same + The /B modifier is a debugging feature. It requests that pcretest out- + put 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 fea- + ture 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 /BI, + The /D modifier is a PCRE debugging feature, and is equivalent to /BI, that is, both the /B and the /I modifiers. - The /F modifier causes pcretest to flip the byte order of the 2-byte + The /F modifier causes pcretest to flip the byte order of the 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 com- + the feature in PCRE that allows it to execute patterns that were com- piled on a host with a different endianness. This feature is not avail- - able when the POSIX interface to PCRE is being used, that is, when the + able 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[16]_fullinfo() after compiling - a pattern. If the pattern is studied, the results of that are also out- - put. + 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[16|32]_fullinfo() after com- + piling a pattern. If the pattern is studied, the results of that are + also output. - The /K modifier requests pcretest to show names from backtracking con- - trol verbs that are returned from calls to pcre[16]_exec(). It causes - pcretest to create a pcre[16]_extra block if one has not already been - created by a call to pcre[16]_study(), and to set the PCRE_EXTRA_MARK - flag and the mark field within it, every time that pcre[16]_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 /K modifier requests pcretest to show names from backtracking con- + trol 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 example, @@ -346,40 +472,67 @@ PATTERN MODIFIERS /pattern/Lfr_FR For this reason, it must be the last modifier. The given locale is set, - pcre[16]_maketables() is called to build a set of character tables for - the locale, and this is then passed to pcre[16]_compile() when compil- - ing the regular expression. Without an /L (or /T) modifier, NULL is - passed as the tables pointer; that is, /L applies only to the expres- - sion 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 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] block; it is just the actual compiled data. If the pat- - tern is successfully studied with the PCRE_STUDY_JIT_COMPILE option, + 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[16]_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 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. + 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 the /S modifier is immediately followed by a + character, the call - to pcre[16]_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 suc- - cessful, it will automatically be used when pcre[16]_exec() is run, - except when incompatible run-time options are specified. These include - the partial matching options; a complete list is given in the pcrejit - documentation. See also the \J escape sequence below for a way of set- - ting the size of the JIT stack. + 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 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 documen- + tation. 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 spe- - cific set of built-in character tables to be passed to pcre[16]_com- + cific set of built-in character tables to be passed to pcre[16|32]_com- pile(). It is used in the standard PCRE tests to check behaviour with different character tables. The digit specifies the tables as follows: @@ -411,10 +564,10 @@ PATTERN MODIFIERS DATA LINES - Before each data line is passed to pcre[16]_exec(), leading and trail- - ing 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 + 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 expressions, you probably don't need any of these. The following escapes are recognized: @@ -429,16 +582,16 @@ DATA LINES \t tab (\x09) \v vertical tab (\x0b) \nnn octal character (up to 3 octal digits); always - a byte unless > 255 in UTF-8 or 16-bit mode + a byte unless > 255 in UTF-8 or 16-bit or 32-bit mode \xhh hexadecimal byte (up to 2 hex digits) \x{hh...} hexadecimal character (any number of hex digits) - \A pass the PCRE_ANCHORED option to pcre[16]_exec() - or pcre[16]_dfa_exec() - \B pass the PCRE_NOTBOL option to pcre[16]_exec() - or pcre[16]_dfa_exec() - \Cdd call pcre[16]_copy_substring() for substring dd + \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]_copy_named_substring() for substring + \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 @@ -450,50 +603,52 @@ DATA LINES 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[16]_dfa_exec() match function - \F only shortest match for pcre[16]_dfa_exec() - \Gdd call pcre[16]_get_substring() for substring dd + \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]_get_named_substring() for substring + \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[16]_get_substringlist() after a + \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[16]_exec() - or pcre[16]_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[16]_exec() to dd (any number of digits) - \P pass the PCRE_PARTIAL_SOFT option to pcre[16]_exec() - or pcre[16]_dfa_exec(); if used twice, pass the + 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[16]_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[16]_exec() - or pcre[16]_dfa_exec() - \Z pass the PCRE_NOTEOL option to pcre[16]_exec() - or pcre[16]_dfa_exec() - \? pass the PCRE_NO_UTF[8|16]_CHECK option to - pcre[16]_exec() or pcre[16]_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[16]_exec() or pcre[16]_dfa_exec() - \ pass the PCRE_NEWLINE_CR option to pcre[16]_exec() - or pcre[16]_dfa_exec() - \ pass the PCRE_NEWLINE_LF option to pcre[16]_exec() - or pcre[16]_dfa_exec() - \ pass the PCRE_NEWLINE_CRLF option to pcre[16]_exec() - or pcre[16]_dfa_exec() - \ pass the PCRE_NEWLINE_ANYCRLF option to pcre[16]_exec() - or pcre[16]_dfa_exec() - \ pass the PCRE_NEWLINE_ANY option to pcre[16]_exec() - or pcre[16]_dfa_exec() + argument for pcre[16|32]_exec() or + pcre[16|32]_dfa_exec() + \ pass the PCRE_NEWLINE_CR option to pcre[16|32]_exec() + or pcre[16|32]_dfa_exec() + \ pass the PCRE_NEWLINE_LF option to pcre[16|32]_exec() + or pcre[16|32]_dfa_exec() + \ pass the PCRE_NEWLINE_CRLF option to pcre[16|32]_exec() + or pcre[16|32]_dfa_exec() + \ pass the PCRE_NEWLINE_ANYCRLF option to pcre[16|32]_exec() + or pcre[16|32]_dfa_exec() + \ pass the PCRE_NEWLINE_ANY option to pcre[16|32]_exec() + or pcre[16|32]_dfa_exec() 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 hexa- @@ -511,6 +666,10 @@ DATA LINES 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. @@ -525,26 +684,28 @@ DATA LINES mization is not being used. Providing a stack that is larger than the default 32K is necessary only for very complicated patterns. - If \M is present, pcretest calls pcre[16]_exec() several times, with + 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]_extra data structure, until it finds the minimum numbers - for each parameter that allow pcre[16]_exec() to complete without - error. Because this is testing a specific feature of the normal inter- - pretive pcre[16]_exec() execution, the use of any JIT optimization that - might have been set up by the /S+ qualifier of -s+ option is disabled. + the pcre[16|32]_extra data structure, until it finds the minimum num- + bers for each parameter that allow pcre[16|32]_exec() to complete with- + out error. Because this is testing a specific feature of the normal + interpretive pcre[16|32]_exec() execution, the use of any JIT optimiza- + tion 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 that - takes place, and checking it out can be instructive. For most simple - matches, the number is quite small, but for patterns with very large - numbers of matching possibilities, it can become large very quickly - with increasing length of subject string. The match_limit_recursion - number is a measure of how much stack (or, if PCRE is compiled with - NO_RECURSE, how much heap) memory is needed to complete the match + The match_limit number is a measure of the amount of backtracking that + takes place, and checking it out can be instructive. For most simple + matches, the number is quite small, but for patterns with very large + numbers of matching possibilities, it can become large very quickly + with increasing length of subject string. The match_limit_recursion + number is a measure of how much stack (or, if PCRE is compiled with + NO_RECURSE, how much heap) memory is needed to complete the match attempt. - When \O is used, the value specified may be higher or lower than the + 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[16]_exec() for the line in which it appears. + only to 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 wrap- per API to be used, the only option-setting sequences that have any @@ -555,10 +716,10 @@ DATA LINES THE ALTERNATIVE MATCHING FUNCTION By default, pcretest uses the standard PCRE matching function, - pcre[16]_exec() to match each data line. PCRE also supports an alterna- - tive matching function, pcre[16]_dfa_test(), which operates in a dif- - ferent way, and has some restrictions. The differences between the two - functions are described in the pcrematching documentation. + 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 documentation. If a data line contains the \D escape sequence, or if the command line contains the -dfa option, the alternative matching function is used. @@ -570,13 +731,13 @@ THE ALTERNATIVE MATCHING FUNCTION DEFAULT OUTPUT FROM PCRETEST This section describes the output when the normal matching function, - pcre[16]_exec(), is being used. + pcre[16|32]_exec(), is being used. When a match succeeds, pcretest outputs the list of captured substrings - that pcre[16]_exec() returns, starting with number 0 for the string + 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[16]_exec() returns + partially matching 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 @@ -598,8 +759,8 @@ DEFAULT OUTPUT FROM PCRETEST No match Unset capturing substrings that are not followed by one that is set are - not returned by pcre[16]_exec(), and are not shown by pcretest. In the - following example, there are two capturing substrings, but when the + not 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 "", as for the second data line. @@ -660,7 +821,7 @@ DEFAULT OUTPUT FROM PCRETEST OUTPUT FROM THE ALTERNATIVE MATCHING FUNCTION - When the alternative matching function, pcre[16]_dfa_exec(), is used + 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 exam- @@ -856,8 +1017,8 @@ SAVING AND RELOADING COMPILED PATTERNS SEE ALSO - pcre(3), pcre16(3), pcreapi(3), pcrecallout(3), pcrejit, pcrematch- - ing(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 @@ -869,5 +1030,5 @@ AUTHOR REVISION - Last updated: 14 January 2012 - Copyright (c) 1997-2012 University of Cambridge. + Last updated: 26 April 2013 + Copyright (c) 1997-2013 University of Cambridge.