/[pcre]/code/trunk/doc/pcretest.1
ViewVC logotype

Diff of /code/trunk/doc/pcretest.1

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 227 by ph10, Tue Aug 21 15:00:15 2007 UTC revision 923 by ph10, Tue Feb 21 13:25:05 2012 UTC
# Line 4  pcretest - a program for testing Perl-co Line 4  pcretest - a program for testing Perl-co
4  .SH SYNOPSIS  .SH SYNOPSIS
5  .rs  .rs
6  .sp  .sp
7  .B pcretest "[options] [source] [destination]"  .B pcretest "[options] [input file [output file]]"
8  .sp  .sp
9  \fBpcretest\fP was written as a test program for the PCRE regular expression  \fBpcretest\fP was written as a test program for the PCRE regular expression
10  library itself, but it can also be used for experimenting with regular  library itself, but it can also be used for experimenting with regular
# Line 18  options, see the Line 18  options, see the
18  .\" HREF  .\" HREF
19  \fBpcreapi\fP  \fBpcreapi\fP
20  .\"  .\"
21  documentation.  and
22    .\" HREF
23    \fBpcre16\fP
24    .\"
25    documentation. The input for \fBpcretest\fP is a sequence of regular expression
26    patterns and strings to be matched, as described below. The output shows the
27    result of each match. Options on the command line and the patterns control PCRE
28    options and exactly what is output.
29    .
30    .
31    .SH "PCRE's 8-BIT and 16-BIT LIBRARIES"
32    .rs
33    .sp
34    From release 8.30, two separate PCRE libraries can be built. The original one
35    supports 8-bit character strings, whereas the newer 16-bit library supports
36    character strings encoded in 16-bit units. The \fBpcretest\fP program can be
37    used to test both libraries. However, it is itself still an 8-bit program,
38    reading 8-bit input and writing 8-bit output. When testing the 16-bit library,
39    the patterns and data strings are converted to 16-bit format before being
40    passed to the PCRE library functions. Results are converted to 8-bit for
41    output.
42    .P
43    References to functions and structures of the form \fBpcre[16]_xx\fP below
44    mean "\fBpcre_xx\fP when using the 8-bit library or \fBpcre16_xx\fP when using
45    the 16-bit library".
46  .  .
47  .  .
48  .SH OPTIONS  .SH "COMMAND LINE OPTIONS"
49  .rs  .rs
50  .TP 10  .TP 10
51    \fB-16\fP
52    If both the 8-bit and the 16-bit libraries have been built, this option causes
53    the 16-bit library to be used. If only the 16-bit library has been built, this
54    is the default (so has no effect). If only the 8-bit library has been built,
55    this option causes an error.
56    .TP 10
57  \fB-b\fP  \fB-b\fP
58  Behave as if each regex has the \fB/B\fP (show bytecode) modifier; the internal  Behave as if each pattern has the \fB/B\fP (show byte code) modifier; the
59  form is output after compilation.  internal form is output after compilation.
60  .TP 10  .TP 10
61  \fB-C\fP  \fB-C\fP
62  Output the version number of the PCRE library, and all available information  Output the version number of the PCRE library, and all available information
63  about the optional features that are included, and then exit.  about the optional features that are included, and then exit. All other options
64    are ignored.
65    .TP 10
66    \fB-C\fP \fIoption\fP
67    Output information about a specific build-time option, then exit. This
68    functionality is intended for use in scripts such as \fBRunTest\fP. The
69    following options output the value indicated:
70    .sp
71      linksize   the internal link size (2, 3, or 4)
72      newline    the default newline setting:
73                   CR, LF, CRLF, ANYCRLF, or ANY
74    .sp
75    The following options output 1 for true or zero for false:
76    .sp
77      jit        just-in-time support is available
78      pcre16     the 16-bit library was built
79      pcre8      the 8-bit library was built
80      ucp        Unicode property support is available
81      utf        UTF-8 and/or UTF-16 support is available
82  .TP 10  .TP 10
83  \fB-d\fP  \fB-d\fP
84  Behave as if each regex has the \fB/D\fP (debug) modifier; the internal  Behave as if each pattern has the \fB/D\fP (debug) modifier; the internal
85  form and information about the compiled pattern is output after compilation;  form and information about the compiled pattern is output after compilation;
86  \fB-d\fP is equivalent to \fB-b -i\fP.  \fB-d\fP is equivalent to \fB-b -i\fP.
87  .TP 10  .TP 10
88  \fB-dfa\fP  \fB-dfa\fP
89  Behave as if each data line contains the \eD escape sequence; this causes the  Behave as if each data line contains the \eD escape sequence; this causes the
90  alternative matching function, \fBpcre_dfa_exec()\fP, to be used instead of the  alternative matching function, \fBpcre[16]_dfa_exec()\fP, to be used instead of
91  standard \fBpcre_exec()\fP function (more detail is given below).  the standard \fBpcre[16]_exec()\fP function (more detail is given below).
92  .TP 10  .TP 10
93  \fB-help\fP  \fB-help\fP
94  Output a brief summary these options and then exit.  Output a brief summary these options and then exit.
95  .TP 10  .TP 10
96  \fB-i\fP  \fB-i\fP
97  Behave as if each regex has the \fB/I\fP modifier; information about the  Behave as if each pattern has the \fB/I\fP modifier; information about the
98  compiled pattern is given after compilation.  compiled pattern is given after compilation.
99  .TP 10  .TP 10
100    \fB-M\fP
101    Behave as if each data line contains the \eM escape sequence; this causes
102    PCRE to discover the minimum MATCH_LIMIT and MATCH_LIMIT_RECURSION settings by
103    calling \fBpcre[16]_exec()\fP repeatedly with different limits.
104    .TP 10
105  \fB-m\fP  \fB-m\fP
106  Output the size of each compiled pattern after it has been compiled. This is  Output the size of each compiled pattern after it has been compiled. This is
107  equivalent to adding \fB/M\fP to each regular expression. For compatibility  equivalent to adding \fB/M\fP to each regular expression. The size is given in
108  with earlier versions of pcretest, \fB-s\fP is a synonym for \fB-m\fP.  bytes for both libraries.
109  .TP 10  .TP 10
110  \fB-o\fP \fIosize\fP  \fB-o\fP \fIosize\fP
111  Set the number of elements in the output vector that is used when calling  Set the number of elements in the output vector that is used when calling
112  \fBpcre_exec()\fP or \fBpcre_dfa_exec()\fP to be \fIosize\fP. The default value  \fBpcre[16]_exec()\fP or \fBpcre[16]_dfa_exec()\fP to be \fIosize\fP. The
113  is 45, which is enough for 14 capturing subexpressions for \fBpcre_exec()\fP or  default value is 45, which is enough for 14 capturing subexpressions for
114  22 different matches for \fBpcre_dfa_exec()\fP. The vector size can be  \fBpcre[16]_exec()\fP or 22 different matches for \fBpcre[16]_dfa_exec()\fP.
115  changed for individual matching calls by including \eO in the data line (see  The vector size can be changed for individual matching calls by including \eO
116  below).  in the data line (see below).
117  .TP 10  .TP 10
118  \fB-p\fP  \fB-p\fP
119  Behave as if each regex has the \fB/P\fP modifier; the POSIX wrapper API is  Behave as if each pattern has the \fB/P\fP modifier; the POSIX wrapper API is
120  used to call PCRE. None of the other options has any effect when \fB-p\fP is  used to call PCRE. None of the other options has any effect when \fB-p\fP is
121  set.  set. This option can be used only with the 8-bit library.
122  .TP 10  .TP 10
123  \fB-q\fP  \fB-q\fP
124  Do not output the version number of \fBpcretest\fP at the start of execution.  Do not output the version number of \fBpcretest\fP at the start of execution.
125  .TP 10  .TP 10
126  \fB-S\fP \fIsize\fP  \fB-S\fP \fIsize\fP
127  On Unix-like systems, set the size of the runtime stack to \fIsize\fP  On Unix-like systems, set the size of the run-time stack to \fIsize\fP
128  megabytes.  megabytes.
129  .TP 10  .TP 10
130    \fB-s\fP or \fB-s+\fP
131    Behave as if each pattern has the \fB/S\fP modifier; in other words, force each
132    pattern to be studied. If \fB-s+\fP is used, all the JIT compile options are
133    passed to \fBpcre[16]_study()\fP, causing just-in-time optimization to be set
134    up if it is available, for both full and partial matching. Specific JIT compile
135    options can be selected by following \fB-s+\fP with a digit in the range 1 to
136    7, which selects the JIT compile modes as follows:
137    .sp
138      1  normal match only
139      2  soft partial match only
140      3  normal match and soft partial match
141      4  hard partial match only
142      6  soft and hard partial match
143      7  all three modes (default)
144    .sp
145    If \fB-s++\fP is used instead of \fB-s+\fP (with or without a following digit),
146    the text "(JIT)" is added to the first output line after a match or no match
147    when JIT-compiled code was actually used.
148    .P
149    If the \fB/I\fP or \fB/D\fP option is present on a pattern (requesting output
150    about the compiled pattern), information about the result of studying is not
151    included when studying is caused only by \fB-s\fP and neither \fB-i\fP nor
152    \fB-d\fP is present on the command line. This behaviour means that the output
153    from tests that are run with and without \fB-s\fP should be identical, except
154    when options that output information about the actual running of a match are
155    set.
156    .sp
157    The \fB-M\fP, \fB-t\fP, and \fB-tm\fP options, which give information about
158    resources used, are likely to produce different output with and without
159    \fB-s\fP. Output may also differ if the \fB/C\fP option is present on an
160    individual pattern. This uses callouts to trace the the matching process, and
161    this may be different between studied and non-studied patterns. If the pattern
162    contains (*MARK) items there may also be differences, for the same reason. The
163    \fB-s\fP command line option can be overridden for specific patterns that
164    should never be studied (see the \fB/S\fP pattern modifier below).
165    .TP 10
166  \fB-t\fP  \fB-t\fP
167  Run each compile, study, and match many times with a timer, and output  Run each compile, study, and match many times with a timer, and output
168  resulting time per compile or match (in milliseconds). Do not set \fB-m\fP with  resulting time per compile or match (in milliseconds). Do not set \fB-m\fP with
# Line 97  that file and writes to stdout. Otherwis Line 186  that file and writes to stdout. Otherwis
186  stdout, and prompts for each line of input, using "re>" to prompt for regular  stdout, and prompts for each line of input, using "re>" to prompt for regular
187  expressions, and "data>" to prompt for data lines.  expressions, and "data>" to prompt for data lines.
188  .P  .P
189    When \fBpcretest\fP is built, a configuration option can specify that it should
190    be linked with the \fBlibreadline\fP library. When this is done, if the input
191    is from a terminal, it is read using the \fBreadline()\fP function. This
192    provides line-editing and history facilities. The output from the \fB-help\fP
193    option states whether or not \fBreadline()\fP will be used.
194    .P
195  The program handles any number of sets of input on a single input file. Each  The program handles any number of sets of input on a single input file. Each
196  set starts with a regular expression, and continues with any number of data  set starts with a regular expression, and continues with any number of data
197  lines to be matched against the pattern.  lines to be matched against the pattern.
# Line 143  pcretest to read the next line as a cont Line 238  pcretest to read the next line as a cont
238  A pattern may be followed by any number of modifiers, which are mostly single  A pattern may be followed by any number of modifiers, which are mostly single
239  characters. Following Perl usage, these are referred to below as, for example,  characters. Following Perl usage, these are referred to below as, for example,
240  "the \fB/i\fP modifier", even though the delimiter of the pattern need not  "the \fB/i\fP modifier", even though the delimiter of the pattern need not
241  always be a slash, and no slash is used when writing modifiers. Whitespace may  always be a slash, and no slash is used when writing modifiers. White space may
242  appear between the final pattern delimiter and the first modifier, and between  appear between the final pattern delimiter and the first modifier, and between
243  the modifiers themselves.  the modifiers themselves.
244  .P  .P
245  The \fB/i\fP, \fB/m\fP, \fB/s\fP, and \fB/x\fP modifiers set the PCRE_CASELESS,  The \fB/i\fP, \fB/m\fP, \fB/s\fP, and \fB/x\fP modifiers set the PCRE_CASELESS,
246  PCRE_MULTILINE, PCRE_DOTALL, or PCRE_EXTENDED options, respectively, when  PCRE_MULTILINE, PCRE_DOTALL, or PCRE_EXTENDED options, respectively, when
247  \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
248  effect as they do in Perl. For example:  effect as they do in Perl. For example:
249  .sp  .sp
250    /caseless/i    /caseless/i
251  .sp  .sp
252  The following table shows additional modifiers for setting PCRE options that do  The following table shows additional modifiers for setting PCRE compile-time
253  not correspond to anything in Perl:  options that do not correspond to anything in Perl:
254  .sp  .sp
255    \fB/A\fP          PCRE_ANCHORED    \fB/8\fP              PCRE_UTF8           ) when using the 8-bit
256    \fB/C\fP          PCRE_AUTO_CALLOUT    \fB/?\fP              PCRE_NO_UTF8_CHECK  )   library
   \fB/E\fP          PCRE_DOLLAR_ENDONLY  
   \fB/f\fP          PCRE_FIRSTLINE  
   \fB/J\fP          PCRE_DUPNAMES  
   \fB/N\fP          PCRE_NO_AUTO_CAPTURE  
   \fB/U\fP          PCRE_UNGREEDY  
   \fB/X\fP          PCRE_EXTRA  
   \fB/<cr>\fP       PCRE_NEWLINE_CR  
   \fB/<lf>\fP       PCRE_NEWLINE_LF  
   \fB/<crlf>\fP     PCRE_NEWLINE_CRLF  
   \fB/<anycrlf>\fP  PCRE_NEWLINE_ANYCRLF  
   \fB/<any>\fP      PCRE_NEWLINE_ANY  
 .sp  
 Those specifying line ending sequences are literal strings as shown, but the  
 letters can be in either case. This example sets multiline matching with CRLF  
 as the line ending sequence:  
257  .sp  .sp
258    /^abc/m<crlf>    \fB/8\fP              PCRE_UTF16          ) when using the 16-bit
259      \fB/?\fP              PCRE_NO_UTF16_CHECK )   library
260  .sp  .sp
261  Details of the meanings of these PCRE options are given in the    \fB/A\fP              PCRE_ANCHORED
262      \fB/C\fP              PCRE_AUTO_CALLOUT
263      \fB/E\fP              PCRE_DOLLAR_ENDONLY
264      \fB/f\fP              PCRE_FIRSTLINE
265      \fB/J\fP              PCRE_DUPNAMES
266      \fB/N\fP              PCRE_NO_AUTO_CAPTURE
267      \fB/U\fP              PCRE_UNGREEDY
268      \fB/W\fP              PCRE_UCP
269      \fB/X\fP              PCRE_EXTRA
270      \fB/Y\fP              PCRE_NO_START_OPTIMIZE
271      \fB/<JS>\fP           PCRE_JAVASCRIPT_COMPAT
272      \fB/<cr>\fP           PCRE_NEWLINE_CR
273      \fB/<lf>\fP           PCRE_NEWLINE_LF
274      \fB/<crlf>\fP         PCRE_NEWLINE_CRLF
275      \fB/<anycrlf>\fP      PCRE_NEWLINE_ANYCRLF
276      \fB/<any>\fP          PCRE_NEWLINE_ANY
277      \fB/<bsr_anycrlf>\fP  PCRE_BSR_ANYCRLF
278      \fB/<bsr_unicode>\fP  PCRE_BSR_UNICODE
279    .sp
280    The modifiers that are enclosed in angle brackets are literal strings as shown,
281    including the angle brackets, but the letters within can be in either case.
282    This example sets multiline matching with CRLF as the line ending sequence:
283    .sp
284      /^abc/m<CRLF>
285    .sp
286    As well as turning on the PCRE_UTF8/16 option, the \fB/8\fP modifier causes
287    all non-printing characters in output strings to be printed using the
288    \ex{hh...} notation. Otherwise, those less than 0x100 are output in hex without
289    the curly brackets.
290    .P
291    Full details of the PCRE options are given in the
292  .\" HREF  .\" HREF
293  \fBpcreapi\fP  \fBpcreapi\fP
294  .\"  .\"
# Line 191  Searching for all possible matches withi Line 302  Searching for all possible matches withi
302  by the \fB/g\fP or \fB/G\fP modifier. After finding a match, PCRE is called  by the \fB/g\fP or \fB/G\fP modifier. After finding a match, PCRE is called
303  again to search the remainder of the subject string. The difference between  again to search the remainder of the subject string. The difference between
304  \fB/g\fP and \fB/G\fP is that the former uses the \fIstartoffset\fP argument to  \fB/g\fP and \fB/G\fP is that the former uses the \fIstartoffset\fP argument to
305  \fBpcre_exec()\fP to start searching at a new point within the entire string  \fBpcre[16]_exec()\fP to start searching at a new point within the entire
306  (which is in effect what Perl does), whereas the latter passes over a shortened  string (which is in effect what Perl does), whereas the latter passes over a
307  substring. This makes a difference to the matching process if the pattern  shortened substring. This makes a difference to the matching process if the
308  begins with a lookbehind assertion (including \eb or \eB).  pattern begins with a lookbehind assertion (including \eb or \eB).
309  .P  .P
310  If any call to \fBpcre_exec()\fP in a \fB/g\fP or \fB/G\fP sequence matches an  If any call to \fBpcre[16]_exec()\fP in a \fB/g\fP or \fB/G\fP sequence matches
311  empty string, the next call is done with the PCRE_NOTEMPTY and PCRE_ANCHORED  an empty string, the next call is done with the PCRE_NOTEMPTY_ATSTART and
312  flags set in order to search for another, non-empty, match at the same point.  PCRE_ANCHORED flags set in order to search for another, non-empty, match at the
313  If this second match fails, the start offset is advanced by one, and the normal  same point. If this second match fails, the start offset is advanced, and the
314  match is retried. This imitates the way Perl handles such cases when using the  normal match is retried. This imitates the way Perl handles such cases when
315  \fB/g\fP modifier or the \fBsplit()\fP function.  using the \fB/g\fP modifier or the \fBsplit()\fP function. Normally, the start
316    offset is advanced by one character, but if the newline convention recognizes
317    CRLF as a newline, and the current character is CR followed by LF, an advance
318    of two is used.
319  .  .
320  .  .
321  .SS "Other modifiers"  .SS "Other modifiers"
# Line 211  There are yet more modifiers for control Line 325  There are yet more modifiers for control
325  operates.  operates.
326  .P  .P
327  The \fB/+\fP modifier requests that as well as outputting the substring that  The \fB/+\fP modifier requests that as well as outputting the substring that
328  matched the entire pattern, pcretest should in addition output the remainder of  matched the entire pattern, \fBpcretest\fP should in addition output the
329  the subject string. This is useful for tests where the subject contains  remainder of the subject string. This is useful for tests where the subject
330  multiple copies of the same substring.  contains multiple copies of the same substring. If the \fB+\fP modifier appears
331    twice, the same action is taken for captured substrings. In each case the
332    remainder is output on the following line with a plus character following the
333    capture number. Note that this modifier must not immediately follow the /S
334    modifier because /S+ and \S++ have other meanings.
335    .P
336    The \fB/=\fP modifier requests that the values of all potential captured
337    parentheses be output after a match. By default, only those up to the highest
338    one actually used in the match are output (corresponding to the return code
339    from \fBpcre[16]_exec()\fP). Values in the offsets vector corresponding to
340    higher numbers should be set to -1, and these are output as "<unset>". This
341    modifier gives a way of checking that this is happening.
342  .P  .P
343  The \fB/B\fP modifier is a debugging feature. It requests that \fBpcretest\fP  The \fB/B\fP modifier is a debugging feature. It requests that \fBpcretest\fP
344  output a representation of the compiled byte code after compilation. Normally  output a representation of the compiled code after compilation. Normally this
345  this information contains length and offset values; however, if \fB/Z\fP is  information contains length and offset values; however, if \fB/Z\fP is also
346  also present, this data is replaced by spaces. This is a special feature for  present, this data is replaced by spaces. This is a special feature for use in
347  use in the automatic test scripts; it ensures that the same output is generated  the automatic test scripts; it ensures that the same output is generated for
348  for different internal link sizes.  different internal link sizes.
349  .P  .P
350  The \fB/L\fP modifier must be followed directly by the name of a locale, for  The \fB/D\fP modifier is a PCRE debugging feature, and is equivalent to
351  example,  \fB/BI\fP, that is, both the \fB/B\fP and the \fB/I\fP modifiers.
352  .sp  .P
353    /pattern/Lfr_FR  The \fB/F\fP modifier causes \fBpcretest\fP to flip the byte order of the
354  .sp  2-byte and 4-byte fields in the compiled pattern. This facility is for testing
355  For this reason, it must be the last modifier. The given locale is set,  the feature in PCRE that allows it to execute patterns that were compiled on a
356  \fBpcre_maketables()\fP is called to build a set of character tables for the  host with a different endianness. This feature is not available when the POSIX
357  locale, and this is then passed to \fBpcre_compile()\fP when compiling the  interface to PCRE is being used, that is, when the \fB/P\fP pattern modifier is
358  regular expression. Without an \fB/L\fP modifier, NULL is passed as the tables  specified. See also the section about saving and reloading compiled patterns
359  pointer; that is, \fB/L\fP applies only to the expression on which it appears.  below.
360  .P  .P
361  The \fB/I\fP modifier requests that \fBpcretest\fP output information about the  The \fB/I\fP modifier requests that \fBpcretest\fP output information about the
362  compiled pattern (whether it is anchored, has a fixed first character, and  compiled pattern (whether it is anchored, has a fixed first character, and
363  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
364  pattern. If the pattern is studied, the results of that are also output.  pattern. If the pattern is studied, the results of that are also output.
365  .P  .P
366  The \fB/D\fP modifier is a PCRE debugging feature, and is equivalent to  The \fB/K\fP modifier requests \fBpcretest\fP to show names from backtracking
367  \fB/BI\fP, that is, both the \fB/B\fP and the \fB/I\fP modifiers.  control verbs that are returned from calls to \fBpcre[16]_exec()\fP. It causes
368  .P  \fBpcretest\fP to create a \fBpcre[16]_extra\fP block if one has not already
369  The \fB/F\fP modifier causes \fBpcretest\fP to flip the byte order of the  been created by a call to \fBpcre[16]_study()\fP, and to set the
370  fields in the compiled pattern that contain 2-byte and 4-byte numbers. This  PCRE_EXTRA_MARK flag and the \fBmark\fP field within it, every time that
371  facility is for testing the feature in PCRE that allows it to execute patterns  \fBpcre[16]_exec()\fP is called. If the variable that the \fBmark\fP field
372  that were compiled on a host with a different endianness. This feature is not  points to is non-NULL for a match, non-match, or partial match, \fBpcretest\fP
373  available when the POSIX interface to PCRE is being used, that is, when the  prints the string to which it points. For a match, this is shown on a line by
374  \fB/P\fP pattern modifier is specified. See also the section about saving and  itself, tagged with "MK:". For a non-match it is added to the message.
 reloading compiled patterns below.  
 .P  
 The \fB/S\fP modifier causes \fBpcre_study()\fP to be called after the  
 expression has been compiled, and the results used when the expression is  
 matched.  
375  .P  .P
376  The \fB/M\fP modifier causes the size of memory block used to hold the compiled  The \fB/L\fP modifier must be followed directly by the name of a locale, for
377  pattern to be output.  example,
378    .sp
379      /pattern/Lfr_FR
380    .sp
381    For this reason, it must be the last modifier. The given locale is set,
382    \fBpcre[16]_maketables()\fP is called to build a set of character tables for
383    the locale, and this is then passed to \fBpcre[16]_compile()\fP when compiling
384    the regular expression. Without an \fB/L\fP (or \fB/T\fP) modifier, NULL is
385    passed as the tables pointer; that is, \fB/L\fP applies only to the expression
386    on which it appears.
387    .P
388    The \fB/M\fP modifier causes the size in bytes of the memory block used to hold
389    the compiled pattern to be output. This does not include the size of the
390    \fBpcre[16]\fP block; it is just the actual compiled data. If the pattern is
391    successfully studied with the PCRE_STUDY_JIT_COMPILE option, the size of the
392    JIT compiled code is also output.
393    .P
394    If the \fB/S\fP modifier appears once, it causes \fBpcre[16]_study()\fP to be
395    called after the expression has been compiled, and the results used when the
396    expression is matched. If \fB/S\fP appears twice, it suppresses studying, even
397    if it was requested externally by the \fB-s\fP command line option. This makes
398    it possible to specify that certain patterns are always studied, and others are
399    never studied, independently of \fB-s\fP. This feature is used in the test
400    files in a few cases where the output is different when the pattern is studied.
401    .P
402    If the \fB/S\fP modifier is immediately followed by a + character, the call to
403    \fBpcre[16]_study()\fP is made with all the JIT study options, requesting
404    just-in-time optimization support if it is available, for both normal and
405    partial matching. If you want to restrict the JIT compiling modes, you can
406    follow \fB/S+\fP with a digit in the range 1 to 7:
407    .sp
408      1  normal match only
409      2  soft partial match only
410      3  normal match and soft partial match
411      4  hard partial match only
412      6  soft and hard partial match
413      7  all three modes (default)
414    .sp
415    If \fB/S++\fP is used instead of \fB/S+\fP (with or without a following digit),
416    the text "(JIT)" is added to the first output line after a match or no match
417    when JIT-compiled code was actually used.
418    .P
419    Note that there is also an independent \fB/+\fP modifier; it must not be given
420    immediately after \fB/S\fP or \fB/S+\fP because this will be misinterpreted.
421    .P
422    If JIT studying is successful, the compiled JIT code will automatically be used
423    when \fBpcre[16]_exec()\fP is run, except when incompatible run-time options
424    are specified. For more details, see the
425    .\" HREF
426    \fBpcrejit\fP
427    .\"
428    documentation. See also the \fB\eJ\fP escape sequence below for a way of
429    setting the size of the JIT stack.
430  .P  .P
431    The \fB/T\fP modifier must be followed by a single digit. It causes a specific
432    set of built-in character tables to be passed to \fBpcre[16]_compile()\fP. It
433    is used in the standard PCRE tests to check behaviour with different character
434    tables. The digit specifies the tables as follows:
435    .sp
436      0   the default ASCII tables, as distributed in
437            pcre_chartables.c.dist
438      1   a set of tables defining ISO 8859 characters
439    .sp
440    In table 1, some characters whose codes are greater than 128 are identified as
441    letters, digits, spaces, etc.
442    .
443    .
444    .SS "Using the POSIX wrapper API"
445    .rs
446    .sp
447  The \fB/P\fP modifier causes \fBpcretest\fP to call PCRE via the POSIX wrapper  The \fB/P\fP modifier causes \fBpcretest\fP to call PCRE via the POSIX wrapper
448  API rather than its native API. When this is done, all other modifiers except  API rather than its native API. This supports only the 8-bit library. When
449  \fB/i\fP, \fB/m\fP, and \fB/+\fP are ignored. REG_ICASE is set if \fB/i\fP is  \fB/P\fP is set, the following modifiers set options for the \fBregcomp()\fP
450  present, and REG_NEWLINE is set if \fB/m\fP is present. The wrapper functions  function:
451  force PCRE_DOLLAR_ENDONLY always, and PCRE_DOTALL unless REG_NEWLINE is set.  .sp
452  .P    /i    REG_ICASE
453  The \fB/8\fP modifier causes \fBpcretest\fP to call PCRE with the PCRE_UTF8    /m    REG_NEWLINE
454  option set. This turns on support for UTF-8 character handling in PCRE,    /N    REG_NOSUB
455  provided that it was compiled with this support enabled. This modifier also    /s    REG_DOTALL     )
456  causes any non-printing characters in output strings to be printed using the    /U    REG_UNGREEDY   ) These options are not part of
457  \ex{hh...} notation if they are valid UTF-8 sequences.    /W    REG_UCP        )   the POSIX standard
458  .P    /8    REG_UTF8       )
459  If the \fB/?\fP modifier is used with \fB/8\fP, it causes \fBpcretest\fP to  .sp
460  call \fBpcre_compile()\fP with the PCRE_NO_UTF8_CHECK option, to suppress the  The \fB/+\fP modifier works as described above. All other modifiers are
461  checking of the string for UTF-8 validity.  ignored.
462  .  .
463  .  .
464  .SH "DATA LINES"  .SH "DATA LINES"
465  .rs  .rs
466  .sp  .sp
467  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
468  whitespace is removed, and it is then scanned for \e escapes. Some of these are  white space is removed, and it is then scanned for \e escapes. Some of these
469  pretty esoteric features, intended for checking out some of the more  are pretty esoteric features, intended for checking out some of the more
470  complicated features of PCRE. If you are just testing "ordinary" regular  complicated features of PCRE. If you are just testing "ordinary" regular
471  expressions, you probably don't need any of these. The following escapes are  expressions, you probably don't need any of these. The following escapes are
472  recognized:  recognized:
# Line 286  recognized: Line 474  recognized:
474    \ea         alarm (BEL, \ex07)    \ea         alarm (BEL, \ex07)
475    \eb         backspace (\ex08)    \eb         backspace (\ex08)
476    \ee         escape (\ex27)    \ee         escape (\ex27)
477    \ef         formfeed (\ex0c)    \ef         form feed (\ex0c)
478    \en         newline (\ex0a)    \en         newline (\ex0a)
479  .\" JOIN  .\" JOIN
480    \eqdd       set the PCRE_MATCH_LIMIT limit to dd    \eqdd       set the PCRE_MATCH_LIMIT limit to dd
# Line 294  recognized: Line 482  recognized:
482    \er         carriage return (\ex0d)    \er         carriage return (\ex0d)
483    \et         tab (\ex09)    \et         tab (\ex09)
484    \ev         vertical tab (\ex0b)    \ev         vertical tab (\ex0b)
485    \ennn       octal character (up to 3 octal digits)    \ennn       octal character (up to 3 octal digits); always
486    \exhh       hexadecimal character (up to 2 hex digits)                 a byte unless > 255 in UTF-8 or 16-bit mode
487      \exhh       hexadecimal byte (up to 2 hex digits)
488      \ex{hh...}  hexadecimal character (any number of hex digits)
489  .\" JOIN  .\" JOIN
490    \ex{hh...}  hexadecimal character, any number of digits    \eA         pass the PCRE_ANCHORED option to \fBpcre[16]_exec()\fP
491                 in UTF-8 mode                 or \fBpcre[16]_dfa_exec()\fP
492  .\" JOIN  .\" JOIN
493    \eA         pass the PCRE_ANCHORED option to \fBpcre_exec()\fP    \eB         pass the PCRE_NOTBOL option to \fBpcre[16]_exec()\fP
494                 or \fBpcre_dfa_exec()\fP                 or \fBpcre[16]_dfa_exec()\fP
495  .\" JOIN  .\" JOIN
496    \eB         pass the PCRE_NOTBOL option to \fBpcre_exec()\fP    \eCdd       call pcre[16]_copy_substring() for substring dd
                or \fBpcre_dfa_exec()\fP  
 .\" JOIN  
   \eCdd       call pcre_copy_substring() for substring dd  
497                 after a successful match (number less than 32)                 after a successful match (number less than 32)
498  .\" JOIN  .\" JOIN
499    \eCname     call pcre_copy_named_substring() for substring    \eCname     call pcre[16]_copy_named_substring() for substring
500                 "name" after a successful match (name termin-                 "name" after a successful match (name termin-
501                 ated by next non alphanumeric character)                 ated by next non alphanumeric character)
502  .\" JOIN  .\" JOIN
# Line 325  recognized: Line 512  recognized:
512  .\" JOIN  .\" JOIN
513    \eC*n       pass the number n (may be negative) as callout    \eC*n       pass the number n (may be negative) as callout
514                 data; this is used as the callout return value                 data; this is used as the callout return value
515    \eD         use the \fBpcre_dfa_exec()\fP match function    \eD         use the \fBpcre[16]_dfa_exec()\fP match function
516    \eF         only shortest match for \fBpcre_dfa_exec()\fP    \eF         only shortest match for \fBpcre[16]_dfa_exec()\fP
517  .\" JOIN  .\" JOIN
518    \eGdd       call pcre_get_substring() for substring dd    \eGdd       call pcre[16]_get_substring() for substring dd
519                 after a successful match (number less than 32)                 after a successful match (number less than 32)
520  .\" JOIN  .\" JOIN
521    \eGname     call pcre_get_named_substring() for substring    \eGname     call pcre[16]_get_named_substring() for substring
522                 "name" after a successful match (name termin-                 "name" after a successful match (name termin-
523                 ated by next non-alphanumeric character)                 ated by next non-alphanumeric character)
524  .\" JOIN  .\" JOIN
525    \eL         call pcre_get_substringlist() after a    \eJdd       set up a JIT stack of dd kilobytes maximum (any
526                   number of digits)
527    .\" JOIN
528      \eL         call pcre[16]_get_substringlist() after a
529                 successful match                 successful match
530  .\" JOIN  .\" JOIN
531    \eM         discover the minimum MATCH_LIMIT and    \eM         discover the minimum MATCH_LIMIT and
532                 MATCH_LIMIT_RECURSION settings                 MATCH_LIMIT_RECURSION settings
533  .\" JOIN  .\" JOIN
534    \eN         pass the PCRE_NOTEMPTY option to \fBpcre_exec()\fP    \eN         pass the PCRE_NOTEMPTY option to \fBpcre[16]_exec()\fP
535                 or \fBpcre_dfa_exec()\fP                 or \fBpcre[16]_dfa_exec()\fP; if used twice, pass the
536                   PCRE_NOTEMPTY_ATSTART option
537  .\" JOIN  .\" JOIN
538    \eOdd       set the size of the output vector passed to    \eOdd       set the size of the output vector passed to
539                 \fBpcre_exec()\fP to dd (any number of digits)                 \fBpcre[16]_exec()\fP to dd (any number of digits)
540  .\" JOIN  .\" JOIN
541    \eP         pass the PCRE_PARTIAL option to \fBpcre_exec()\fP    \eP         pass the PCRE_PARTIAL_SOFT option to \fBpcre[16]_exec()\fP
542                 or \fBpcre_dfa_exec()\fP                 or \fBpcre[16]_dfa_exec()\fP; if used twice, pass the
543                   PCRE_PARTIAL_HARD option
544  .\" JOIN  .\" JOIN
545    \eQdd       set the PCRE_MATCH_LIMIT_RECURSION limit to dd    \eQdd       set the PCRE_MATCH_LIMIT_RECURSION limit to dd
546                 (any number of digits)                 (any number of digits)
547    \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
548    \eS         output details of memory get/free calls during matching    \eS         output details of memory get/free calls during matching
549  .\" JOIN  .\" JOIN
550    \eZ         pass the PCRE_NOTEOL option to \fBpcre_exec()\fP    \eY         pass the PCRE_NO_START_OPTIMIZE option to \fBpcre[16]_exec()\fP
551                 or \fBpcre_dfa_exec()\fP                 or \fBpcre[16]_dfa_exec()\fP
552    .\" JOIN
553      \eZ         pass the PCRE_NOTEOL option to \fBpcre[16]_exec()\fP
554                   or \fBpcre[16]_dfa_exec()\fP
555  .\" JOIN  .\" JOIN
556    \e?         pass the PCRE_NO_UTF8_CHECK option to    \e?         pass the PCRE_NO_UTF[8|16]_CHECK option to
557                 \fBpcre_exec()\fP or \fBpcre_dfa_exec()\fP                 \fBpcre[16]_exec()\fP or \fBpcre[16]_dfa_exec()\fP
   \e>dd       start the match at offset dd (any number of digits);  
558  .\" JOIN  .\" JOIN
559                 this sets the \fIstartoffset\fP argument for \fBpcre_exec()\fP    \e>dd       start the match at offset dd (optional "-"; then
560                 or \fBpcre_dfa_exec()\fP                 any number of digits); this sets the \fIstartoffset\fP
561                   argument for \fBpcre[16]_exec()\fP or \fBpcre[16]_dfa_exec()\fP
562  .\" JOIN  .\" JOIN
563    \e<cr>      pass the PCRE_NEWLINE_CR option to \fBpcre_exec()\fP    \e<cr>      pass the PCRE_NEWLINE_CR option to \fBpcre[16]_exec()\fP
564                 or \fBpcre_dfa_exec()\fP                 or \fBpcre[16]_dfa_exec()\fP
565  .\" JOIN  .\" JOIN
566    \e<lf>      pass the PCRE_NEWLINE_LF option to \fBpcre_exec()\fP    \e<lf>      pass the PCRE_NEWLINE_LF option to \fBpcre[16]_exec()\fP
567                 or \fBpcre_dfa_exec()\fP                 or \fBpcre[16]_dfa_exec()\fP
568  .\" JOIN  .\" JOIN
569    \e<crlf>    pass the PCRE_NEWLINE_CRLF option to \fBpcre_exec()\fP    \e<crlf>    pass the PCRE_NEWLINE_CRLF option to \fBpcre[16]_exec()\fP
570                 or \fBpcre_dfa_exec()\fP                 or \fBpcre[16]_dfa_exec()\fP
571  .\" JOIN  .\" JOIN
572    \e<anycrlf> pass the PCRE_NEWLINE_ANYCRLF option to \fBpcre_exec()\fP    \e<anycrlf> pass the PCRE_NEWLINE_ANYCRLF option to \fBpcre[16]_exec()\fP
573                 or \fBpcre_dfa_exec()\fP                 or \fBpcre[16]_dfa_exec()\fP
574  .\" JOIN  .\" JOIN
575    \e<any>     pass the PCRE_NEWLINE_ANY option to \fBpcre_exec()\fP    \e<any>     pass the PCRE_NEWLINE_ANY option to \fBpcre[16]_exec()\fP
576                 or \fBpcre_dfa_exec()\fP                 or \fBpcre[16]_dfa_exec()\fP
577  .sp  .sp
578    The use of \ex{hh...} is not dependent on the use of the \fB/8\fP modifier on
579    the pattern. It is recognized always. There may be any number of hexadecimal
580    digits inside the braces; invalid values provoke error messages.
581    .P
582    Note that \exhh specifies one byte rather than one character in UTF-8 mode;
583    this makes it possible to construct invalid UTF-8 sequences for testing
584    purposes. On the other hand, \ex{hh} is interpreted as a UTF-8 character in
585    UTF-8 mode, generating more than one byte if the value is greater than 127.
586    When testing the 8-bit library not in UTF-8 mode, \ex{hh} generates one byte
587    for values less than 256, and causes an error for greater values.
588    .P
589    In UTF-16 mode, all 4-digit \ex{hhhh} values are accepted. This makes it
590    possible to construct invalid UTF-16 sequences for testing purposes.
591    .P
592  The escapes that specify line ending sequences are literal strings, exactly as  The escapes that specify line ending sequences are literal strings, exactly as
593  shown. No more than one newline setting should be present in any data line.  shown. No more than one newline setting should be present in any data line.
594  .P  .P
# Line 388  the very last character is a backslash, Line 597  the very last character is a backslash,
597  passing an empty line as data, since a real empty line terminates the data  passing an empty line as data, since a real empty line terminates the data
598  input.  input.
599  .P  .P
600  If \eM is present, \fBpcretest\fP calls \fBpcre_exec()\fP several times, with  The \fB\eJ\fP escape provides a way of setting the maximum stack size that is
601  different values in the \fImatch_limit\fP and \fImatch_limit_recursion\fP  used by the just-in-time optimization code. It is ignored if JIT optimization
602  fields of the \fBpcre_extra\fP data structure, until it finds the minimum  is not being used. Providing a stack that is larger than the default 32K is
603  numbers for each parameter that allow \fBpcre_exec()\fP to complete. The  necessary only for very complicated patterns.
604  \fImatch_limit\fP number is a measure of the amount of backtracking that takes  .P
605  place, and checking it out can be instructive. For most simple matches, the  If \eM is present, \fBpcretest\fP calls \fBpcre[16]_exec()\fP several times,
606  number is quite small, but for patterns with very large numbers of matching  with different values in the \fImatch_limit\fP and \fImatch_limit_recursion\fP
607  possibilities, it can become large very quickly with increasing length of  fields of the \fBpcre[16]_extra\fP data structure, until it finds the minimum
608  subject string. The \fImatch_limit_recursion\fP number is a measure of how much  numbers for each parameter that allow \fBpcre[16]_exec()\fP to complete without
609  stack (or, if PCRE is compiled with NO_RECURSE, how much heap) memory is needed  error. Because this is testing a specific feature of the normal interpretive
610  to complete the match attempt.  \fBpcre[16]_exec()\fP execution, the use of any JIT optimization that might
611    have been set up by the \fB/S+\fP qualifier of \fB-s+\fP option is disabled.
612    .P
613    The \fImatch_limit\fP number is a measure of the amount of backtracking
614    that takes place, and checking it out can be instructive. For most simple
615    matches, the number is quite small, but for patterns with very large numbers of
616    matching possibilities, it can become large very quickly with increasing length
617    of subject string. The \fImatch_limit_recursion\fP number is a measure of how
618    much stack (or, if PCRE is compiled with NO_RECURSE, how much heap) memory is
619    needed to complete the match attempt.
620  .P  .P
621  When \eO is used, the value specified may be higher or lower than the size set  When \eO is used, the value specified may be higher or lower than the size set
622  by the \fB-O\fP command line option (or defaulted to 45); \eO applies only to  by the \fB-O\fP command line option (or defaulted to 45); \eO applies only to
623  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.
624  .P  .P
625  If the \fB/P\fP modifier was present on the pattern, causing the POSIX wrapper  If the \fB/P\fP modifier was present on the pattern, causing the POSIX wrapper
626  API to be used, the only option-setting sequences that have any effect are \eB  API to be used, the only option-setting sequences that have any effect are \eB,
627  and \eZ, causing REG_NOTBOL and REG_NOTEOL, respectively, to be passed to  \eN, and \eZ, causing REG_NOTBOL, REG_NOTEMPTY, and REG_NOTEOL, respectively,
628  \fBregexec()\fP.  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.  
629  .  .
630  .  .
631  .SH "THE ALTERNATIVE MATCHING FUNCTION"  .SH "THE ALTERNATIVE MATCHING FUNCTION"
632  .rs  .rs
633  .sp  .sp
634  By default, \fBpcretest\fP uses the standard PCRE matching function,  By default, \fBpcretest\fP uses the standard PCRE matching function,
635  \fBpcre_exec()\fP to match each data line. From release 6.0, PCRE supports an  \fBpcre[16]_exec()\fP to match each data line. PCRE also supports an
636  alternative matching function, \fBpcre_dfa_test()\fP, which operates in a  alternative matching function, \fBpcre[16]_dfa_test()\fP, which operates in a
637  different way, and has some restrictions. The differences between the two  different way, and has some restrictions. The differences between the two
638  functions are described in the  functions are described in the
639  .\" HREF  .\" HREF
# Line 432  functions are described in the Line 642  functions are described in the
642  documentation.  documentation.
643  .P  .P
644  If a data line contains the \eD escape sequence, or if the command line  If a data line contains the \eD escape sequence, or if the command line
645  contains the \fB-dfa\fP option, the alternative matching function is called.  contains the \fB-dfa\fP option, the alternative matching function is used.
646  This function finds all possible matches at a given point. If, however, the \eF  This function finds all possible matches at a given point. If, however, the \eF
647  escape sequence is present in the data line, it stops after the first match is  escape sequence is present in the data line, it stops after the first match is
648  found. This is always the shortest possible match.  found. This is always the shortest possible match.
# Line 442  found. This is always the shortest possi Line 652  found. This is always the shortest possi
652  .rs  .rs
653  .sp  .sp
654  This section describes the output when the normal matching function,  This section describes the output when the normal matching function,
655  \fBpcre_exec()\fP, is being used.  \fBpcre[16]_exec()\fP, is being used.
656  .P  .P
657  When a match succeeds, pcretest outputs the list of captured substrings that  When a match succeeds, \fBpcretest\fP outputs the list of captured substrings
658  \fBpcre_exec()\fP returns, starting with number 0 for the string that matched  that \fBpcre[16]_exec()\fP returns, starting with number 0 for the string that
659  the whole pattern. Otherwise, it outputs "No match" or "Partial match"  matched the whole pattern. Otherwise, it outputs "No match" when the return is
660  when \fBpcre_exec()\fP returns PCRE_ERROR_NOMATCH or PCRE_ERROR_PARTIAL,  PCRE_ERROR_NOMATCH, and "Partial match:" followed by the partially matching
661  respectively, and otherwise the PCRE negative error number. Here is an example  substring when \fBpcre[16]_exec()\fP returns PCRE_ERROR_PARTIAL. (Note that
662  of an interactive \fBpcretest\fP run.  this is the entire substring that was inspected during the partial match; it
663    may include characters before the actual match start if a lookbehind assertion,
664    \eK, \eb, or \eB was involved.) For any other return, \fBpcretest\fP outputs
665    the PCRE negative error number and a short descriptive phrase. If the error is
666    a failed UTF string check, the offset of the start of the failing character and
667    the reason code are also output, provided that the size of the output vector is
668    at least two. Here is an example of an interactive \fBpcretest\fP run.
669  .sp  .sp
670    $ pcretest    $ pcretest
671    PCRE version 7.0 30-Nov-2006    PCRE version 8.13 2011-04-30
672  .sp  .sp
673      re> /^abc(\ed+)/      re> /^abc(\ed+)/
674    data> abc123    data> abc123
# Line 461  of an interactive \fBpcretest\fP run. Line 677  of an interactive \fBpcretest\fP run.
677    data> xyz    data> xyz
678    No match    No match
679  .sp  .sp
680  If the strings contain any non-printing characters, they are output as \e0x  Unset capturing substrings that are not followed by one that is set are not
681  escapes, or as \ex{...} escapes if the \fB/8\fP modifier was present on the  returned by \fBpcre[16]_exec()\fP, and are not shown by \fBpcretest\fP. In the
682  pattern. See below for the definition of non-printing characters. If the  following example, there are two capturing substrings, but when the first data
683  pattern has the \fB/+\fP modifier, the output for substring 0 is followed by  line is matched, the second, unset substring is not shown. An "internal" unset
684  the the rest of the subject string, identified by "0+" like this:  substring is shown as "<unset>", as for the second data line.
685    .sp
686        re> /(a)|(b)/
687      data> a
688       0: a
689       1: a
690      data> b
691       0: b
692       1: <unset>
693       2: b
694    .sp
695    If the strings contain any non-printing characters, they are output as \exhh
696    escapes if the value is less than 256 and UTF mode is not set. Otherwise they
697    are output as \ex{hh...} escapes. See below for the definition of non-printing
698    characters. If the pattern has the \fB/+\fP modifier, the output for substring
699    0 is followed by the the rest of the subject string, identified by "0+" like
700    this:
701  .sp  .sp
702      re> /cat/+      re> /cat/+
703    data> cataract    data> cataract
# Line 484  matching attempts are output in sequence Line 716  matching attempts are output in sequence
716     0: ipp     0: ipp
717     1: pp     1: pp
718  .sp  .sp
719  "No match" is output only if the first match attempt fails.  "No match" is output only if the first match attempt fails. Here is an example
720    of a failure message (the offset 4 that is specified by \e>4 is past the end of
721    the subject string):
722    .sp
723        re> /xyz/
724      data> xyz\e>4
725      Error -24 (bad offset value)
726  .P  .P
727  If any of the sequences \fB\eC\fP, \fB\eG\fP, or \fB\eL\fP are present in a  If any of the sequences \fB\eC\fP, \fB\eG\fP, or \fB\eL\fP are present in a
728  data line that is successfully matched, the substrings extracted by the  data line that is successfully matched, the substrings extracted by the
# Line 503  the newline sequence setting). Line 741  the newline sequence setting).
741  .SH "OUTPUT FROM THE ALTERNATIVE MATCHING FUNCTION"  .SH "OUTPUT FROM THE ALTERNATIVE MATCHING FUNCTION"
742  .rs  .rs
743  .sp  .sp
744  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
745  means of the \eD escape sequence or the \fB-dfa\fP command line option), the  means of the \eD escape sequence or the \fB-dfa\fP command line option), the
746  output consists of a list of all the matches that start at the first point in  output consists of a list of all the matches that start at the first point in
747  the subject where there is at least one match. For example:  the subject where there is at least one match. For example:
# Line 515  the subject where there is at least one Line 753  the subject where there is at least one
753     2: tan     2: tan
754  .sp  .sp
755  (Using the normal matching function on this data finds only "tang".) The  (Using the normal matching function on this data finds only "tang".) The
756  longest matching string is always given first (and numbered zero).  longest matching string is always given first (and numbered zero). After a
757    PCRE_ERROR_PARTIAL return, the output is "Partial match:", followed by the
758    partially matching substring. (Note that this is the entire substring that was
759    inspected during the partial match; it may include characters before the actual
760    match start if a lookbehind assertion, \eK, \eb, or \eB was involved.)
761  .P  .P
762  If \fB/g\fP is present on the pattern, the search for further matches resumes  If \fB/g\fP is present on the pattern, the search for further matches resumes
763  at the end of the longest match. For example:  at the end of the longest match. For example:
# Line 561  If the pattern contains any callout requ Line 803  If the pattern contains any callout requ
803  is called during matching. This works with both matching functions. By default,  is called during matching. This works with both matching functions. By default,
804  the called function displays the callout number, the start and current  the called function displays the callout number, the start and current
805  positions in the text at the callout time, and the next pattern item to be  positions in the text at the callout time, and the next pattern item to be
806  tested. For example, the output  tested. For example:
807  .sp  .sp
808    --->pqrabcdef    --->pqrabcdef
809      0    ^  ^     \ed      0    ^  ^     \ed
810  .sp  .sp
811  indicates that callout number 0 occurred for a match attempt starting at the  This output indicates that callout number 0 occurred for a match attempt
812  fourth character of the subject string, when the pointer was at the seventh  starting at the fourth character of the subject string, when the pointer was at
813  character of the data, and when the next pattern item was \ed. Just one  the seventh character of the data, and when the next pattern item was \ed. Just
814  circumflex is output if the start and current positions are the same.  one circumflex is output if the start and current positions are the same.
815  .P  .P
816  Callouts numbered 255 are assumed to be automatic callouts, inserted as a  Callouts numbered 255 are assumed to be automatic callouts, inserted as a
817  result of the \fB/C\fP pattern modifier. In this case, instead of showing the  result of the \fB/C\fP pattern modifier. In this case, instead of showing the
# Line 585  example: Line 827  example:
827    +10 ^ ^    +10 ^ ^
828     0: E*     0: E*
829  .sp  .sp
830    If a pattern contains (*MARK) items, an additional line is output whenever
831    a change of latest mark is passed to the callout function. For example:
832    .sp
833        re> /a(*MARK:X)bc/C
834      data> abc
835      --->abc
836       +0 ^       a
837       +1 ^^      (*MARK:X)
838      +10 ^^      b
839      Latest Mark: X
840      +11 ^ ^     c
841      +12 ^  ^
842       0: abc
843    .sp
844    The mark changes between matching "a" and "b", but stays the same for the rest
845    of the match, so nothing more is output. If, as a result of backtracking, the
846    mark reverts to being unset, the text "<unset>" is output.
847    .P
848  The callout function in \fBpcretest\fP returns zero (carry on matching) by  The callout function in \fBpcretest\fP returns zero (carry on matching) by
849  default, but you can use a \eC item in a data line (as described above) to  default, but you can use a \eC item in a data line (as described above) to
850  change this.  change this and other parameters of the callout.
851  .P  .P
852  Inserting callouts can be helpful when using \fBpcretest\fP to check  Inserting callouts can be helpful when using \fBpcretest\fP to check
853  complicated regular expressions. For further information about callouts, see  complicated regular expressions. For further information about callouts, see
# Line 617  function to distinguish printing and non Line 877  function to distinguish printing and non
877  .rs  .rs
878  .sp  .sp
879  The facilities described in this section are not available when the POSIX  The facilities described in this section are not available when the POSIX
880  inteface to PCRE is being used, that is, when the \fB/P\fP pattern modifier is  interface to PCRE is being used, that is, when the \fB/P\fP pattern modifier is
881  specified.  specified.
882  .P  .P
883  When the POSIX interface is not in use, you can cause \fBpcretest\fP to write a  When the POSIX interface is not in use, you can cause \fBpcretest\fP to write a
# Line 631  See the Line 891  See the
891  \fBpcreprecompile\fP  \fBpcreprecompile\fP
892  .\"  .\"
893  documentation for a discussion about saving and re-using compiled patterns.  documentation for a discussion about saving and re-using compiled patterns.
894    Note that if the pattern was successfully studied with JIT optimization, the
895    JIT data cannot be saved.
896  .P  .P
897  The data that is written is binary. The first eight bytes are the length of the  The data that is written is binary. The first eight bytes are the length of the
898  compiled pattern data followed by the length of the optional study data, each  compiled pattern data followed by the length of the optional study data, each
# Line 638  written as four bytes in big-endian orde Line 900  written as four bytes in big-endian orde
900  there is no study data (either the pattern was not studied, or studying did not  there is no study data (either the pattern was not studied, or studying did not
901  return any data), the second length is zero. The lengths are followed by an  return any data), the second length is zero. The lengths are followed by an
902  exact copy of the compiled pattern. If there is additional study data, this  exact copy of the compiled pattern. If there is additional study data, this
903  follows immediately after the compiled pattern. After writing the file,  (excluding any JIT data) follows immediately after the compiled pattern. After
904  \fBpcretest\fP expects to read a new pattern.  writing the file, \fBpcretest\fP expects to read a new pattern.
905  .P  .P
906  A saved pattern can be reloaded into \fBpcretest\fP by specifing < and a file  A saved pattern can be reloaded into \fBpcretest\fP by specifying < and a file
907  name instead of a pattern. The name of the file must not contain a < character,  name instead of a pattern. The name of the file must not contain a < character,
908  as otherwise \fBpcretest\fP will interpret the line as a pattern delimited by <  as otherwise \fBpcretest\fP will interpret the line as a pattern delimited by <
909  characters.  characters.
910  For example:  For example:
911  .sp  .sp
912     re> </some/file     re> </some/file
913    Compiled regex loaded from /some/file    Compiled pattern loaded from /some/file
914    No study data    No study data
915  .sp  .sp
916  When the pattern has been loaded, \fBpcretest\fP proceeds to read data lines in  If the pattern was previously studied with the JIT optimization, the JIT
917  the usual way.  information cannot be saved and restored, and so is lost. When the pattern has
918    been loaded, \fBpcretest\fP proceeds to read data lines in the usual way.
919  .P  .P
920  You can copy a file written by \fBpcretest\fP to a different host and reload it  You can copy a file written by \fBpcretest\fP to a different host and reload it
921  there, even if the new host has opposite endianness to the one on which the  there, even if the new host has opposite endianness to the one on which the
922  pattern was compiled. For example, you can compile on an i86 machine and run on  pattern was compiled. For example, you can compile on an i86 machine and run on
923  a SPARC machine.  a SPARC machine. When a pattern is reloaded on a host with different
924    endianness, the confirmation message is changed to:
925    .sp
926      Compiled pattern (byte-inverted) loaded from /some/file
927    .sp
928    The test suite contains some saved pre-compiled patterns with different
929    endianness. These are reloaded using "<!" instead of just "<". This suppresses
930    the "(byte-inverted)" text so that the output is the same on all hosts. It also
931    forces debugging output once the pattern has been reloaded.
932  .P  .P
933  File names for saving and reloading can be absolute or relative, but note that  File names for saving and reloading can be absolute or relative, but note that
934  the shell facility of expanding a file name that starts with a tilde (~) is not  the shell facility of expanding a file name that starts with a tilde (~) is not
# Line 676  result is undefined. Line 947  result is undefined.
947  .SH "SEE ALSO"  .SH "SEE ALSO"
948  .rs  .rs
949  .sp  .sp
950  \fBpcre\fP(3), \fBpcreapi\fP(3), \fBpcrecallout\fP(3), \fBpcrematching\fP(3),  \fBpcre\fP(3), \fBpcre16\fP(3), \fBpcreapi\fP(3), \fBpcrecallout\fP(3),
951  \fBpcrepartial\fP(d), \fBpcrepattern\fP(3), \fBpcreprecompile\fP(3).  \fBpcrejit\fP, \fBpcrematching\fP(3), \fBpcrepartial\fP(d),
952    \fBpcrepattern\fP(3), \fBpcreprecompile\fP(3).
953  .  .
954  .  .
955  .SH AUTHOR  .SH AUTHOR
# Line 694  Cambridge CB2 3QH, England. Line 966  Cambridge CB2 3QH, England.
966  .rs  .rs
967  .sp  .sp
968  .nf  .nf
969  Last updated: 21 August 2007  Last updated: 21 February 2012
970  Copyright (c) 1997-2007 University of Cambridge.  Copyright (c) 1997-2012 University of Cambridge.
971  .fi  .fi

Legend:
Removed from v.227  
changed lines
  Added in v.923

  ViewVC Help
Powered by ViewVC 1.1.5