Revision: 866
http://vcs.pcre.org/viewvc?view=rev&revision=866
Author: ph10
Date: 2012-01-13 12:30:12 +0000 (Fri, 13 Jan 2012)
Log Message:
-----------
Updated documentation for 16-bit.
Modified Paths:
--------------
code/trunk/doc/pcretest.1
Modified: code/trunk/doc/pcretest.1
===================================================================
--- code/trunk/doc/pcretest.1 2012-01-13 11:28:41 UTC (rev 865)
+++ code/trunk/doc/pcretest.1 2012-01-13 12:30:12 UTC (rev 866)
@@ -18,23 +18,68 @@
.\" HREF
\fBpcreapi\fP
.\"
+and
+.\" HREF
+\fBpcre16\fP
+.\"
documentation. The input for \fBpcretest\fP 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.
.
.
-.SH COMMAND LINE OPTIONS
+.SH "PCRE's 8-BIT and 16-BIT LIBRARIES"
.rs
+.sp
+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. The \fBpcretest\fP 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.
+.P
+References to functions and structures of the form \fBpcre[16]_xx\fP below
+mean "\fBpcre_xx\fP when using the 8-bit library or \fBpcre16_xx\fP when using
+the 16-bit library".
+.
+.
+.SH "COMMAND LINE OPTIONS"
+.rs
.TP 10
+\fB-16\fP
+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.
+.TP 10
\fB-b\fP
Behave as if each pattern has the \fB/B\fP (show byte code) modifier; the
internal form is output after compilation.
.TP 10
\fB-C\fP
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. All other options
+are ignored.
.TP 10
+\fB-C\fP \fIoption\fP
+Output information about a specific build-time option, then exit. This
+functionality is intended for use in scripts such as \fBRunTest\fP. The
+following options output the value indicated:
+.sp
+ linksize the internal link size (2, 3, or 4)
+ newline the default newline setting:
+ CR, LF, CRLF, ANYCRLF, or ANY
+.sp
+The following options output 1 for true or zero for false:
+.sp
+ jit just-in-time support is available
+ pcre16 the 16-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
+.TP 10
\fB-d\fP
Behave as if each pattern has the \fB/D\fP (debug) modifier; the internal
form and information about the compiled pattern is output after compilation;
@@ -42,8 +87,8 @@
.TP 10
\fB-dfa\fP
Behave as if each data line contains the \eD escape sequence; this causes the
-alternative matching function, \fBpcre_dfa_exec()\fP, to be used instead of the
-standard \fBpcre_exec()\fP function (more detail is given below).
+alternative matching function, \fBpcre[16]_dfa_exec()\fP, to be used instead of
+the standard \fBpcre[16]_exec()\fP function (more detail is given below).
.TP 10
\fB-help\fP
Output a brief summary these options and then exit.
@@ -55,24 +100,25 @@
\fB-M\fP
Behave as if each data line contains the \eM escape sequence; this causes
PCRE to discover the minimum MATCH_LIMIT and MATCH_LIMIT_RECURSION settings by
-calling \fBpcre_exec()\fP repeatedly with different limits.
+calling \fBpcre[16]_exec()\fP repeatedly with different limits.
.TP 10
\fB-m\fP
Output the size of each compiled pattern after it has been compiled. This is
-equivalent to adding \fB/M\fP to each regular expression.
+equivalent to adding \fB/M\fP to each regular expression. The size is given in
+bytes for both libraries.
.TP 10
\fB-o\fP \fIosize\fP
Set the number of elements in the output vector that is used when calling
-\fBpcre_exec()\fP or \fBpcre_dfa_exec()\fP to be \fIosize\fP. The default value
-is 45, which is enough for 14 capturing subexpressions for \fBpcre_exec()\fP or
-22 different matches for \fBpcre_dfa_exec()\fP. The vector size can be
-changed for individual matching calls by including \eO in the data line (see
-below).
+\fBpcre[16]_exec()\fP or \fBpcre[16]_dfa_exec()\fP to be \fIosize\fP. The
+default value is 45, which is enough for 14 capturing subexpressions for
+\fBpcre[16]_exec()\fP or 22 different matches for \fBpcre[16]_dfa_exec()\fP.
+The vector size can be changed for individual matching calls by including \eO
+in the data line (see below).
.TP 10
\fB-p\fP
Behave as if each pattern has the \fB/P\fP modifier; the POSIX wrapper API is
used to call PCRE. None of the other options has any effect when \fB-p\fP is
-set.
+set. This option can be used only with the 8-bit library.
.TP 10
\fB-q\fP
Do not output the version number of \fBpcretest\fP at the start of execution.
@@ -84,22 +130,23 @@
\fB-s\fP or \fB-s+\fP
Behave as if each pattern has the \fB/S\fP modifier; in other words, force each
pattern to be studied. If \fB-s+\fP is used, the PCRE_STUDY_JIT_COMPILE flag is
-passed to \fBpcre_study()\fP, causing just-in-time optimization to be set up if
-it is available. If the \fB/I\fP or \fB/D\fP 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 \fB-s\fP and neither
-\fB-i\fP nor \fB-d\fP is present on the command line. This behaviour means that
-the output from tests that are run with and without \fB-s\fP should be
-identical, except when options that output information about the actual running
-of a match are set. The \fB-M\fP, \fB-t\fP, and \fB-tm\fP options, which give
-information about resources used, are likely to produce different output with
-and without \fB-s\fP. Output may also differ if the \fB/C\fP 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 \fB-s\fP command line option can be overridden for specific
-patterns that should never be studied (see the \fB/S\fP pattern modifier
-below).
+passed to \fBpcre[16]_study()\fP, causing just-in-time optimization to be set
+up if it is available. If the \fB/I\fP or \fB/D\fP 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 \fB-s\fP and
+neither \fB-i\fP nor \fB-d\fP is present on the command line. This behaviour
+means that the output from tests that are run with and without \fB-s\fP should
+be identical, except when options that output information about the actual
+running of a match are set.
+.sp
+The \fB-M\fP, \fB-t\fP, and \fB-tm\fP options, which give information about
+resources used, are likely to produce different output with and without
+\fB-s\fP. Output may also differ if the \fB/C\fP 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
+\fB-s\fP command line option can be overridden for specific patterns that
+should never be studied (see the \fB/S\fP pattern modifier below).
.TP 10
\fB-t\fP
Run each compile, study, and match many times with a timer, and output
@@ -182,7 +229,7 @@
.P
The \fB/i\fP, \fB/m\fP, \fB/s\fP, and \fB/x\fP modifiers set the PCRE_CASELESS,
PCRE_MULTILINE, PCRE_DOTALL, or PCRE_EXTENDED options, respectively, when
-\fBpcre_compile()\fP is called. These four modifier letters have the same
+\fBpcre[16]_compile()\fP is called. These four modifier letters have the same
effect as they do in Perl. For example:
.sp
/caseless/i
@@ -190,8 +237,12 @@
The following table shows additional modifiers for setting PCRE compile-time
options that do not correspond to anything in Perl:
.sp
- \fB/8\fP PCRE_UTF8
- \fB/?\fP PCRE_NO_UTF8_CHECK
+ \fB/8\fP PCRE_UTF8 ) when using the 8-bit
+ \fB/?\fP PCRE_NO_UTF8_CHECK ) library
+.sp
+ \fB/8\fP PCRE_UTF16 ) when using the 16-bit
+ \fB/?\fP PCRE_NO_UTF16_CHECK ) library
+.sp
\fB/A\fP PCRE_ANCHORED
\fB/C\fP PCRE_AUTO_CALLOUT
\fB/E\fP PCRE_DOLLAR_ENDONLY
@@ -217,10 +268,12 @@
.sp
/^abc/m<CRLF>
.sp
-As well as turning on the PCRE_UTF8 option, the \fB/8\fP modifier also causes
-any non-printing characters in output strings to be printed using the
-\ex{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 option, the \fB/8\fP modifier causes
+all non-printing characters in output strings to be printed using the
+\ex{hh...} notation. Otherwise, those less than 0x100 are output in hex without
+the curly brackets.
+.P
+Full details of the PCRE options are given in the
.\" HREF
\fBpcreapi\fP
.\"
@@ -234,13 +287,13 @@
by the \fB/g\fP or \fB/G\fP modifier. After finding a match, PCRE is called
again to search the remainder of the subject string. The difference between
\fB/g\fP and \fB/G\fP is that the former uses the \fIstartoffset\fP argument to
-\fBpcre_exec()\fP 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 \eb or \eB).
+\fBpcre[16]_exec()\fP 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 \eb or \eB).
.P
-If any call to \fBpcre_exec()\fP in a \fB/g\fP or \fB/G\fP sequence matches an
-empty string, the next call is done with the PCRE_NOTEMPTY_ATSTART and
+If any call to \fBpcre[16]_exec()\fP in a \fB/g\fP or \fB/G\fP 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
@@ -266,45 +319,44 @@
modifier because /S+ has another meaning.
.P
The \fB/=\fP modifier requests that the values of all potential captured
-parentheses be output after a match by \fBpcre_exec()\fP. By default, only
-those up to the highest one actually used in the match are output
-(corresponding to the return code from \fBpcre_exec()\fP). 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 \fBpcre[16]_exec()\fP). 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.
.P
The \fB/B\fP modifier is a debugging feature. It requests that \fBpcretest\fP
-output a representation of the compiled byte code after compilation. Normally
-this information contains length and offset values; however, if \fB/Z\fP 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 \fB/Z\fP 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.
.P
The \fB/D\fP modifier is a PCRE debugging feature, and is equivalent to
\fB/BI\fP, that is, both the \fB/B\fP and the \fB/I\fP modifiers.
.P
The \fB/F\fP modifier causes \fBpcretest\fP 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
-\fB/P\fP 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 \fB/P\fP pattern modifier is
+specified. See also the section about saving and reloading compiled patterns
+below.
.P
The \fB/I\fP modifier requests that \fBpcretest\fP output information about the
compiled pattern (whether it is anchored, has a fixed first character, and
-so on). It does this by calling \fBpcre_fullinfo()\fP after compiling a
+so on). It does this by calling \fBpcre[16]_fullinfo()\fP after compiling a
pattern. If the pattern is studied, the results of that are also output.
.P
The \fB/K\fP modifier requests \fBpcretest\fP to show names from backtracking
-control verbs that are returned from calls to \fBpcre_exec()\fP. It causes
-\fBpcretest\fP to create a \fBpcre_extra\fP block if one has not already been
-created by a call to \fBpcre_study()\fP, and to set the PCRE_EXTRA_MARK flag
-and the \fBmark\fP field within it, every time that \fBpcre_exec()\fP is
-called. If the variable that the \fBmark\fP field points to is non-NULL for a
-match, non-match, or partial match, \fBpcretest\fP 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 \fBpcre[16]_exec()\fP. It causes
+\fBpcretest\fP to create a \fBpcre[16]_extra\fP block if one has not already
+been created by a call to \fBpcre[16]_study()\fP, and to set the
+PCRE_EXTRA_MARK flag and the \fBmark\fP field within it, every time that
+\fBpcre[16]_exec()\fP is called. If the variable that the \fBmark\fP field
+points to is non-NULL for a match, non-match, or partial match, \fBpcretest\fP
+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.
.P
The \fB/L\fP modifier must be followed directly by the name of a locale, for
example,
@@ -312,19 +364,19 @@
/pattern/Lfr_FR
.sp
For this reason, it must be the last modifier. The given locale is set,
-\fBpcre_maketables()\fP is called to build a set of character tables for the
-locale, and this is then passed to \fBpcre_compile()\fP when compiling the
-regular expression. Without an \fB/L\fP (or \fB/T\fP) modifier, NULL is passed
-as the tables pointer; that is, \fB/L\fP applies only to the expression on
-which it appears.
+\fBpcre[16]_maketables()\fP is called to build a set of character tables for
+the locale, and this is then passed to \fBpcre[16]_compile()\fP when compiling
+the regular expression. Without an \fB/L\fP (or \fB/T\fP) modifier, NULL is
+passed as the tables pointer; that is, \fB/L\fP applies only to the expression
+on which it appears.
.P
-The \fB/M\fP modifier causes the size of memory block used to hold the compiled
-pattern to be output. This does not include the size of the \fBpcre\fP 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 \fB/M\fP 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
+\fBpcre[16]\fP 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.
.P
-If the \fB/S\fP modifier appears once, it causes \fBpcre_study()\fP to be
+If the \fB/S\fP modifier appears once, it causes \fBpcre[16]_study()\fP to be
called after the expression has been compiled, and the results used when the
expression is matched. If \fB/S\fP appears twice, it suppresses studying, even
if it was requested externally by the \fB-s\fP command line option. This makes
@@ -333,13 +385,13 @@
files in a few cases where the output is different when the pattern is studied.
.P
If the \fB/S\fP modifier is immediately followed by a + character, the call to
-\fBpcre_study()\fP 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
-\fB/+\fP modifier; it must not be given immediately after \fB/S\fP because this
-will be misinterpreted. If JIT studying is successful, it will automatically be
-used when \fBpcre_exec()\fP is run, except when incompatible run-time options
-are specified. These include the partial matching options; a complete list is
-given in the
+\fBpcre[16]_study()\fP 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 \fB/+\fP modifier; it must not be given immediately after
+\fB/S\fP because this will be misinterpreted. If JIT studying is successful, it
+will automatically be used when \fBpcre[16]_exec()\fP is run, except when
+incompatible run-time options are specified. These include the partial matching
+options; a complete list is given in the
.\" HREF
\fBpcrejit\fP
.\"
@@ -347,8 +399,8 @@
setting the size of the JIT stack.
.P
The \fB/T\fP modifier must be followed by a single digit. It causes a specific
-set of built-in character tables to be passed to \fBpcre_compile()\fP. It is
-used in the standard PCRE tests to check behaviour with different character
+set of built-in character tables to be passed to \fBpcre[16]_compile()\fP. It
+is used in the standard PCRE tests to check behaviour with different character
tables. The digit specifies the tables as follows:
.sp
0 the default ASCII tables, as distributed in
@@ -363,8 +415,9 @@
.rs
.sp
The \fB/P\fP modifier causes \fBpcretest\fP to call PCRE via the POSIX wrapper
-API rather than its native API. When \fB/P\fP is set, the following modifiers
-set options for the \fBregcomp()\fP function:
+API rather than its native API. This supports only the 8-bit library. When
+\fB/P\fP is set, the following modifiers set options for the \fBregcomp()\fP
+function:
.sp
/i REG_ICASE
/m REG_NEWLINE
@@ -381,7 +434,7 @@
.SH "DATA LINES"
.rs
.sp
-Before each data line is passed to \fBpcre_exec()\fP, leading and trailing
+Before each data line is passed to \fBpcre[16]_exec()\fP, leading and trailing
white space is removed, and it is then scanned for \e 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
@@ -399,23 +452,21 @@
\er carriage return (\ex0d)
\et tab (\ex09)
\ev vertical tab (\ex0b)
- \ennn octal character (up to 3 octal digits)
- always a byte unless > 255 in UTF-8 mode
+ \ennn octal character (up to 3 octal digits); always
+ a byte unless > 255 in UTF-8 or 16-bit mode
\exhh hexadecimal byte (up to 2 hex digits)
+ \ex{hh...} hexadecimal character (any number of hex digits)
.\" JOIN
- \ex{hh...} hexadecimal character, any number of digits
- in UTF-8 mode
+ \eA pass the PCRE_ANCHORED option to \fBpcre[16]_exec()\fP
+ or \fBpcre[16]_dfa_exec()\fP
.\" JOIN
- \eA pass the PCRE_ANCHORED option to \fBpcre_exec()\fP
- or \fBpcre_dfa_exec()\fP
+ \eB pass the PCRE_NOTBOL option to \fBpcre[16]_exec()\fP
+ or \fBpcre[16]_dfa_exec()\fP
.\" JOIN
- \eB pass the PCRE_NOTBOL option to \fBpcre_exec()\fP
- or \fBpcre_dfa_exec()\fP
-.\" JOIN
- \eCdd call pcre_copy_substring() for substring dd
+ \eCdd call pcre[16]_copy_substring() for substring dd
after a successful match (number less than 32)
.\" JOIN
- \eCname call pcre_copy_named_substring() for substring
+ \eCname call pcre[16]_copy_named_substring() for substring
"name" after a successful match (name termin-
ated by next non alphanumeric character)
.\" JOIN
@@ -431,76 +482,83 @@
.\" JOIN
\eC*n pass the number n (may be negative) as callout
data; this is used as the callout return value
- \eD use the \fBpcre_dfa_exec()\fP match function
- \eF only shortest match for \fBpcre_dfa_exec()\fP
+ \eD use the \fBpcre[16]_dfa_exec()\fP match function
+ \eF only shortest match for \fBpcre[16]_dfa_exec()\fP
.\" JOIN
- \eGdd call pcre_get_substring() for substring dd
+ \eGdd call pcre[16]_get_substring() for substring dd
after a successful match (number less than 32)
.\" JOIN
- \eGname call pcre_get_named_substring() for substring
+ \eGname call pcre[16]_get_named_substring() for substring
"name" after a successful match (name termin-
ated by next non-alphanumeric character)
.\" JOIN
\eJdd set up a JIT stack of dd kilobytes maximum (any
number of digits)
.\" JOIN
- \eL call pcre_get_substringlist() after a
+ \eL call pcre[16]_get_substringlist() after a
successful match
.\" JOIN
\eM discover the minimum MATCH_LIMIT and
MATCH_LIMIT_RECURSION settings
.\" JOIN
- \eN pass the PCRE_NOTEMPTY option to \fBpcre_exec()\fP
- or \fBpcre_dfa_exec()\fP; if used twice, pass the
+ \eN pass the PCRE_NOTEMPTY option to \fBpcre[16]_exec()\fP
+ or \fBpcre[16]_dfa_exec()\fP; if used twice, pass the
PCRE_NOTEMPTY_ATSTART option
.\" JOIN
\eOdd set the size of the output vector passed to
- \fBpcre_exec()\fP to dd (any number of digits)
+ \fBpcre[16]_exec()\fP to dd (any number of digits)
.\" JOIN
- \eP pass the PCRE_PARTIAL_SOFT option to \fBpcre_exec()\fP
- or \fBpcre_dfa_exec()\fP; if used twice, pass the
+ \eP pass the PCRE_PARTIAL_SOFT option to \fBpcre[16]_exec()\fP
+ or \fBpcre[16]_dfa_exec()\fP; if used twice, pass the
PCRE_PARTIAL_HARD option
.\" JOIN
\eQdd set the PCRE_MATCH_LIMIT_RECURSION limit to dd
(any number of digits)
- \eR pass the PCRE_DFA_RESTART option to \fBpcre_dfa_exec()\fP
+ \eR pass the PCRE_DFA_RESTART option to \fBpcre[16]_dfa_exec()\fP
\eS output details of memory get/free calls during matching
.\" JOIN
- \eY pass the PCRE_NO_START_OPTIMIZE option to \fBpcre_exec()\fP
- or \fBpcre_dfa_exec()\fP
+ \eY pass the PCRE_NO_START_OPTIMIZE option to \fBpcre[16]_exec()\fP
+ or \fBpcre[16]_dfa_exec()\fP
.\" JOIN
- \eZ pass the PCRE_NOTEOL option to \fBpcre_exec()\fP
- or \fBpcre_dfa_exec()\fP
+ \eZ pass the PCRE_NOTEOL option to \fBpcre[16]_exec()\fP
+ or \fBpcre[16]_dfa_exec()\fP
.\" JOIN
- \e? pass the PCRE_NO_UTF8_CHECK option to
- \fBpcre_exec()\fP or \fBpcre_dfa_exec()\fP
+ \e? pass the PCRE_NO_UTF[8|16]_CHECK option to
+ \fBpcre[16]_exec()\fP or \fBpcre[16]_dfa_exec()\fP
.\" JOIN
\e>dd start the match at offset dd (optional "-"; then
any number of digits); this sets the \fIstartoffset\fP
- argument for \fBpcre_exec()\fP or \fBpcre_dfa_exec()\fP
+ argument for \fBpcre[16]_exec()\fP or \fBpcre[16]_dfa_exec()\fP
.\" JOIN
- \e<cr> pass the PCRE_NEWLINE_CR option to \fBpcre_exec()\fP
- or \fBpcre_dfa_exec()\fP
+ \e<cr> pass the PCRE_NEWLINE_CR option to \fBpcre[16]_exec()\fP
+ or \fBpcre[16]_dfa_exec()\fP
.\" JOIN
- \e<lf> pass the PCRE_NEWLINE_LF option to \fBpcre_exec()\fP
- or \fBpcre_dfa_exec()\fP
+ \e<lf> pass the PCRE_NEWLINE_LF option to \fBpcre[16]_exec()\fP
+ or \fBpcre[16]_dfa_exec()\fP
.\" JOIN
- \e<crlf> pass the PCRE_NEWLINE_CRLF option to \fBpcre_exec()\fP
- or \fBpcre_dfa_exec()\fP
+ \e<crlf> pass the PCRE_NEWLINE_CRLF option to \fBpcre[16]_exec()\fP
+ or \fBpcre[16]_dfa_exec()\fP
.\" JOIN
- \e<anycrlf> pass the PCRE_NEWLINE_ANYCRLF option to \fBpcre_exec()\fP
- or \fBpcre_dfa_exec()\fP
+ \e<anycrlf> pass the PCRE_NEWLINE_ANYCRLF option to \fBpcre[16]_exec()\fP
+ or \fBpcre[16]_dfa_exec()\fP
.\" JOIN
- \e<any> pass the PCRE_NEWLINE_ANY option to \fBpcre_exec()\fP
- or \fBpcre_dfa_exec()\fP
+ \e<any> pass the PCRE_NEWLINE_ANY option to \fBpcre[16]_exec()\fP
+ or \fBpcre[16]_dfa_exec()\fP
.sp
-Note that \exhh 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, \ex{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 \ex{hh...} is not dependent on the use of the \fB/8\fP modifier on
+the pattern. It is recognized always. There may be any number of hexadecimal
+digits inside the braces; invalid values provoke error messages.
.P
+Note that \exhh specifies one byte in UTF-8 mode; this makes it possible to
+construct invalid UTF-8 sequences for testing purposes. On the other hand,
+\ex{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, \ex{hh} generates one byte for values less than 256, and causes
+an error for greater values.
+.P
+In UTF-16 mode, all 4-digit \ex{hhhh} values are accepted. This makes it
+possible to construct invalid UTF-16 sequences for testing purposes.
+.P
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.
.P
@@ -514,13 +572,13 @@
is not being used. Providing a stack that is larger than the default 32K is
necessary only for very complicated patterns.
.P
-If \eM is present, \fBpcretest\fP calls \fBpcre_exec()\fP several times, with
-different values in the \fImatch_limit\fP and \fImatch_limit_recursion\fP
-fields of the \fBpcre_extra\fP data structure, until it finds the minimum
-numbers for each parameter that allow \fBpcre_exec()\fP to complete without
+If \eM is present, \fBpcretest\fP calls \fBpcre[16]_exec()\fP several times,
+with different values in the \fImatch_limit\fP and \fImatch_limit_recursion\fP
+fields of the \fBpcre[16]_extra\fP data structure, until it finds the minimum
+numbers for each parameter that allow \fBpcre[16]_exec()\fP to complete without
error. Because this is testing a specific feature of the normal interpretive
-\fBpcre_exec()\fP execution, the use of any JIT optimization that might have
-been set up by the \fB/S+\fP qualifier of \fB-s+\fP option is disabled.
+\fBpcre[16]_exec()\fP execution, the use of any JIT optimization that might
+have been set up by the \fB/S+\fP qualifier of \fB-s+\fP option is disabled.
.P
The \fImatch_limit\fP number is a measure of the amount of backtracking
that takes place, and checking it out can be instructive. For most simple
@@ -532,28 +590,20 @@
.P
When \eO is used, the value specified may be higher or lower than the size set
by the \fB-O\fP command line option (or defaulted to 45); \eO applies only to
-the call of \fBpcre_exec()\fP for the line in which it appears.
+the call of \fBpcre[16]_exec()\fP for the line in which it appears.
.P
If the \fB/P\fP modifier was present on the pattern, causing the POSIX wrapper
API to be used, the only option-setting sequences that have any effect are \eB,
\eN, and \eZ, causing REG_NOTBOL, REG_NOTEMPTY, and REG_NOTEOL, respectively,
to be passed to \fBregexec()\fP.
-.P
-The use of \ex{hh...} to represent UTF-8 characters is not dependent on the use
-of the \fB/8\fP 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.
.
.
.SH "THE ALTERNATIVE MATCHING FUNCTION"
.rs
.sp
By default, \fBpcretest\fP uses the standard PCRE matching function,
-\fBpcre_exec()\fP to match each data line. From release 6.0, PCRE supports an
-alternative matching function, \fBpcre_dfa_test()\fP, which operates in a
+\fBpcre[16]_exec()\fP to match each data line. PCRE also supports an
+alternative matching function, \fBpcre[16]_dfa_test()\fP, which operates in a
different way, and has some restrictions. The differences between the two
functions are described in the
.\" HREF
@@ -562,7 +612,7 @@
documentation.
.P
If a data line contains the \eD escape sequence, or if the command line
-contains the \fB-dfa\fP option, the alternative matching function is called.
+contains the \fB-dfa\fP option, the alternative matching function is used.
This function finds all possible matches at a given point. If, however, the \eF
escape sequence is present in the data line, it stops after the first match is
found. This is always the shortest possible match.
@@ -572,21 +622,20 @@
.rs
.sp
This section describes the output when the normal matching function,
-\fBpcre_exec()\fP, is being used.
+\fBpcre[16]_exec()\fP, is being used.
.P
When a match succeeds, \fBpcretest\fP outputs the list of captured substrings
-that \fBpcre_exec()\fP returns, starting with number 0 for the string that
+that \fBpcre[16]_exec()\fP 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 \fBpcre_exec()\fP 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 \fBpcre[16]_exec()\fP 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,
\eK, \eb, or \eB was involved.) For any other return, \fBpcretest\fP 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
-\fBpcretest\fP 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 \fBpcretest\fP run.
.sp
$ pcretest
PCRE version 8.13 2011-04-30
@@ -599,7 +648,7 @@
No match
.sp
Unset capturing substrings that are not followed by one that is set are not
-returned by \fBpcre_exec()\fP, and are not shown by \fBpcretest\fP. In the
+returned by \fBpcre[16]_exec()\fP, and are not shown by \fBpcretest\fP. 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.
@@ -613,11 +662,12 @@
1: <unset>
2: b
.sp
-If the strings contain any non-printing characters, they are output as \e0x
-escapes, or as \ex{...} escapes if the \fB/8\fP modifier was present on the
-pattern. See below for the definition of non-printing characters. If the
-pattern has the \fB/+\fP 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 \exhh
+escapes if the value is less than 256 and UTF mode is not set. Otherwise they
+are output as \ex{hh...} escapes. See below for the definition of non-printing
+characters. If the pattern has the \fB/+\fP modifier, the output for substring
+0 is followed by the the rest of the subject string, identified by "0+" like
+this:
.sp
re> /cat/+
data> cataract
@@ -661,7 +711,7 @@
.SH "OUTPUT FROM THE ALTERNATIVE MATCHING FUNCTION"
.rs
.sp
-When the alternative matching function, \fBpcre_dfa_exec()\fP, is used (by
+When the alternative matching function, \fBpcre[16]_dfa_exec()\fP, is used (by
means of the \eD escape sequence or the \fB-dfa\fP 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:
@@ -723,15 +773,15 @@
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:
.sp
--->pqrabcdef
0 ^ ^ \ed
.sp
-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 \ed. 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 \ed. Just
+one circumflex is output if the start and current positions are the same.
.P
Callouts numbered 255 are assumed to be automatic callouts, inserted as a
result of the \fB/C\fP pattern modifier. In this case, instead of showing the
@@ -840,7 +890,15 @@
You can copy a file written by \fBpcretest\fP 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:
+.sp
+ Compiled pattern (byte-inverted) loaded from /some/file
+.sp
+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.
.P
File names for saving and reloading can be absolute or relative, but note that
the shell facility of expanding a file name that starts with a tilde (~) is not
@@ -859,9 +917,9 @@
.SH "SEE ALSO"
.rs
.sp
-\fBpcre\fP(3), \fBpcreapi\fP(3), \fBpcrecallout\fP(3), \fBpcrejit\fP,
-\fBpcrematching\fP(3), \fBpcrepartial\fP(d), \fBpcrepattern\fP(3),
-\fBpcreprecompile\fP(3).
+\fBpcre\fP(3), \fBpcre16\fP(3), \fBpcreapi\fP(3), \fBpcrecallout\fP(3),
+\fBpcrejit\fP, \fBpcrematching\fP(3), \fBpcrepartial\fP(d),
+\fBpcrepattern\fP(3), \fBpcreprecompile\fP(3).
.
.
.SH AUTHOR
@@ -878,6 +936,6 @@
.rs
.sp
.nf
-Last updated: 02 December 2011
-Copyright (c) 1997-2011 University of Cambridge.
+Last updated: 13 January 2012
+Copyright (c) 1997-2012 University of Cambridge.
.fi
