/[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 93 by nigel, Sat Feb 24 21:41:42 2007 UTC revision 691 by ph10, Sun Sep 11 14:31:21 2011 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.  documentation. The input for \fBpcretest\fP is a sequence of regular expression
22    patterns and strings to be matched, as described below. The output shows the
23    result of each match. Options on the command line and the patterns control PCRE
24    options and exactly what is output.
25  .  .
26  .  .
27  .SH OPTIONS  .SH COMMAND LINE OPTIONS
28  .rs  .rs
29  .TP 10  .TP 10
30  \fB-b\fP  \fB-b\fP
31  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
32  form is output after compilation.  internal form is output after compilation.
33  .TP 10  .TP 10
34  \fB-C\fP  \fB-C\fP
35  Output the version number of the PCRE library, and all available information  Output the version number of the PCRE library, and all available information
36  about the optional features that are included, and then exit.  about the optional features that are included, and then exit.
37  .TP 10  .TP 10
38  \fB-d\fP  \fB-d\fP
39  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
40  form and information about the compiled pattern is output after compilation;  form and information about the compiled pattern is output after compilation;
41  \fB-d\fP is equivalent to \fB-b -i\fP.  \fB-d\fP is equivalent to \fB-b -i\fP.
42  .TP 10  .TP 10
# Line 46  standard \fBpcre_exec()\fP function (mor Line 49  standard \fBpcre_exec()\fP function (mor
49  Output a brief summary these options and then exit.  Output a brief summary these options and then exit.
50  .TP 10  .TP 10
51  \fB-i\fP  \fB-i\fP
52  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
53  compiled pattern is given after compilation.  compiled pattern is given after compilation.
54  .TP 10  .TP 10
55    \fB-M\fP
56    Behave as if each data line contains the \eM escape sequence; this causes
57    PCRE to discover the minimum MATCH_LIMIT and MATCH_LIMIT_RECURSION settings by
58    calling \fBpcre_exec()\fP repeatedly with different limits.
59    .TP 10
60  \fB-m\fP  \fB-m\fP
61  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
62  equivalent to adding \fB/M\fP to each regular expression. For compatibility  equivalent to adding \fB/M\fP to each regular expression.
 with earlier versions of pcretest, \fB-s\fP is a synonym for \fB-m\fP.  
63  .TP 10  .TP 10
64  \fB-o\fP \fIosize\fP  \fB-o\fP \fIosize\fP
65  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
# Line 63  changed for individual matching calls by Line 70  changed for individual matching calls by
70  below).  below).
71  .TP 10  .TP 10
72  \fB-p\fP  \fB-p\fP
73  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
74  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
75  set.  set.
76  .TP 10  .TP 10
# Line 71  set. Line 78  set.
78  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.
79  .TP 10  .TP 10
80  \fB-S\fP \fIsize\fP  \fB-S\fP \fIsize\fP
81  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
82  megabytes.  megabytes.
83  .TP 10  .TP 10
84    \fB-s\fP or \fB-s+\fP
85    Behave as if each pattern has the \fB/S\fP modifier; in other words, force each
86    pattern to be studied. If \fB-s+\fP is used, the PCRE_STUDY_JIT_COMPILE flag is
87    passed to \fBpcre_study()\fP, causing just-in-time optimization to be set up if
88    it is available. If the \fB/I\fP or \fB/D\fP option is present on a pattern
89    (requesting output about the compiled pattern), information about the result of
90    studying is not included when studying is caused only by \fB-s\fP and neither
91    \fB-i\fP nor \fB-d\fP is present on the command line. This behaviour means that
92    the output from tests that are run with and without \fB-s\fP should be
93    identical, except when options that output information about the actual running
94    of a match are set. The \fB-M\fP, \fB-t\fP, and \fB-tm\fP options, which give
95    information about resources used, are likely to produce different output with
96    and without \fB-s\fP. Output may also differ if the \fB/C\fP option is present
97    on an individual pattern. This uses callouts to trace the the matching process,
98    and this may be different between studied and non-studied patterns. If the
99    pattern contains (*MARK) items there may also be differences, for the same
100    reason. The \fB-s\fP command line option can be overridden for specific
101    patterns that should never be studied (see the \fB/S\fP pattern modifier
102    below).
103    .TP 10
104  \fB-t\fP  \fB-t\fP
105  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
106  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 124  that file and writes to stdout. Otherwis
124  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
125  expressions, and "data>" to prompt for data lines.  expressions, and "data>" to prompt for data lines.
126  .P  .P
127    When \fBpcretest\fP is built, a configuration option can specify that it should
128    be linked with the \fBlibreadline\fP library. When this is done, if the input
129    is from a terminal, it is read using the \fBreadline()\fP function. This
130    provides line-editing and history facilities. The output from the \fB-help\fP
131    option states whether or not \fBreadline()\fP will be used.
132    .P
133  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
134  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
135  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 176  pcretest to read the next line as a cont
176  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
177  characters. Following Perl usage, these are referred to below as, for example,  characters. Following Perl usage, these are referred to below as, for example,
178  "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
179  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
180  appear between the final pattern delimiter and the first modifier, and between  appear between the final pattern delimiter and the first modifier, and between
181  the modifiers themselves.  the modifiers themselves.
182  .P  .P
# Line 154  effect as they do in Perl. For example: Line 187  effect as they do in Perl. For example:
187  .sp  .sp
188    /caseless/i    /caseless/i
189  .sp  .sp
190  The following table shows additional modifiers for setting PCRE options that do  The following table shows additional modifiers for setting PCRE compile-time
191  not correspond to anything in Perl:  options that do not correspond to anything in Perl:
192  .sp  .sp
193    \fB/A\fP       PCRE_ANCHORED    \fB/8\fP              PCRE_UTF8
194    \fB/C\fP       PCRE_AUTO_CALLOUT    \fB/?\fP              PCRE_NO_UTF8_CHECK
195    \fB/E\fP       PCRE_DOLLAR_ENDONLY    \fB/A\fP              PCRE_ANCHORED
196    \fB/f\fP       PCRE_FIRSTLINE    \fB/C\fP              PCRE_AUTO_CALLOUT
197    \fB/J\fP       PCRE_DUPNAMES    \fB/E\fP              PCRE_DOLLAR_ENDONLY
198    \fB/N\fP       PCRE_NO_AUTO_CAPTURE    \fB/f\fP              PCRE_FIRSTLINE
199    \fB/U\fP       PCRE_UNGREEDY    \fB/J\fP              PCRE_DUPNAMES
200    \fB/X\fP       PCRE_EXTRA    \fB/N\fP              PCRE_NO_AUTO_CAPTURE
201    \fB/<cr>\fP    PCRE_NEWLINE_CR    \fB/U\fP              PCRE_UNGREEDY
202    \fB/<lf>\fP    PCRE_NEWLINE_LF    \fB/W\fP              PCRE_UCP
203    \fB/<crlf>\fP  PCRE_NEWLINE_CRLF    \fB/X\fP              PCRE_EXTRA
204    \fB/<any>\fP   PCRE_NEWLINE_ANY    \fB/Y\fP              PCRE_NO_START_OPTIMIZE
205  .sp    \fB/<JS>\fP           PCRE_JAVASCRIPT_COMPAT
206  Those specifying line ending sequencess are literal strings as shown. This    \fB/<cr>\fP           PCRE_NEWLINE_CR
207  example sets multiline matching with CRLF as the line ending sequence:    \fB/<lf>\fP           PCRE_NEWLINE_LF
208  .sp    \fB/<crlf>\fP         PCRE_NEWLINE_CRLF
209    /^abc/m<crlf>    \fB/<anycrlf>\fP      PCRE_NEWLINE_ANYCRLF
210  .sp    \fB/<any>\fP          PCRE_NEWLINE_ANY
211  Details of the meanings of these PCRE options are given in the    \fB/<bsr_anycrlf>\fP  PCRE_BSR_ANYCRLF
212      \fB/<bsr_unicode>\fP  PCRE_BSR_UNICODE
213    .sp
214    The modifiers that are enclosed in angle brackets are literal strings as shown,
215    including the angle brackets, but the letters within can be in either case.
216    This example sets multiline matching with CRLF as the line ending sequence:
217    .sp
218      /^abc/m<CRLF>
219    .sp
220    As well as turning on the PCRE_UTF8 option, the \fB/8\fP modifier also causes
221    any non-printing characters in output strings to be printed using the
222    \ex{hh...} notation if they are valid UTF-8 sequences. Full details of the PCRE
223    options are given in the
224  .\" HREF  .\" HREF
225  \fBpcreapi\fP  \fBpcreapi\fP
226  .\"  .\"
# Line 195  substring. This makes a difference to th Line 240  substring. This makes a difference to th
240  begins with a lookbehind assertion (including \eb or \eB).  begins with a lookbehind assertion (including \eb or \eB).
241  .P  .P
242  If any call to \fBpcre_exec()\fP in a \fB/g\fP or \fB/G\fP sequence matches an  If any call to \fBpcre_exec()\fP in a \fB/g\fP or \fB/G\fP sequence matches an
243  empty string, the next call is done with the PCRE_NOTEMPTY and PCRE_ANCHORED  empty string, the next call is done with the PCRE_NOTEMPTY_ATSTART and
244  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
245  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
246  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
247  \fB/g\fP modifier or the \fBsplit()\fP function.  using the \fB/g\fP modifier or the \fBsplit()\fP function. Normally, the start
248    offset is advanced by one character, but if the newline convention recognizes
249    CRLF as a newline, and the current character is CR followed by LF, an advance
250    of two is used.
251  .  .
252  .  .
253  .SS "Other modifiers"  .SS "Other modifiers"
# Line 209  There are yet more modifiers for control Line 257  There are yet more modifiers for control
257  operates.  operates.
258  .P  .P
259  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
260  matched the entire pattern, pcretest should in addition output the remainder of  matched the entire pattern, \fBpcretest\fP should in addition output the
261  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
262  multiple copies of the same substring.  contains multiple copies of the same substring. If the \fB+\fP modifier appears
263    twice, the same action is taken for captured substrings. In each case the
264    remainder is output on the following line with a plus character following the
265    capture number. Note that this modifier must not immediately follow the /S
266    modifier because /S+ has another meaning.
267    .P
268    The \fB/=\fP modifier requests that the values of all potential captured
269    parentheses be output after a match by \fBpcre_exec()\fP. By default, only
270    those up to the highest one actually used in the match are output
271    (corresponding to the return code from \fBpcre_exec()\fP). Values in the
272    offsets vector corresponding to higher numbers should be set to -1, and these
273    are output as "<unset>". This modifier gives a way of checking that this is
274    happening.
275  .P  .P
276  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
277  output a representation of the compiled byte code after compilation.  output a representation of the compiled byte code after compilation. Normally
278  .P  this information contains length and offset values; however, if \fB/Z\fP is
279  The \fB/L\fP modifier must be followed directly by the name of a locale, for  also present, this data is replaced by spaces. This is a special feature for
280  example,  use in the automatic test scripts; it ensures that the same output is generated
281  .sp  for different internal link sizes.
   /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 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/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  
 pattern. If the pattern is studied, the results of that are also output.  
282  .P  .P
283  The \fB/D\fP modifier is a PCRE debugging feature, and is equivalent to  The \fB/D\fP modifier is a PCRE debugging feature, and is equivalent to
284  \fB/BI\fP, that is, both the \fP/B\fP and the \fB/I\fP modifiers.  \fB/BI\fP, that is, both the \fB/B\fP and the \fB/I\fP modifiers.
285  .P  .P
286  The \fB/F\fP modifier causes \fBpcretest\fP to flip the byte order of the  The \fB/F\fP modifier causes \fBpcretest\fP to flip the byte order of the
287  fields in the compiled pattern that contain 2-byte and 4-byte numbers. This  fields in the compiled pattern that contain 2-byte and 4-byte numbers. This
# Line 243  available when the POSIX interface to PC Line 291  available when the POSIX interface to PC
291  \fB/P\fP pattern modifier is specified. See also the section about saving and  \fB/P\fP pattern modifier is specified. See also the section about saving and
292  reloading compiled patterns below.  reloading compiled patterns below.
293  .P  .P
294  The \fB/S\fP modifier causes \fBpcre_study()\fP to be called after the  The \fB/I\fP modifier requests that \fBpcretest\fP output information about the
295  expression has been compiled, and the results used when the expression is  compiled pattern (whether it is anchored, has a fixed first character, and
296  matched.  so on). It does this by calling \fBpcre_fullinfo()\fP after compiling a
297    pattern. If the pattern is studied, the results of that are also output.
298    .P
299    The \fB/K\fP modifier requests \fBpcretest\fP to show names from backtracking
300    control verbs that are returned from calls to \fBpcre_exec()\fP. It causes
301    \fBpcretest\fP to create a \fBpcre_extra\fP block if one has not already been
302    created by a call to \fBpcre_study()\fP, and to set the PCRE_EXTRA_MARK flag
303    and the \fBmark\fP field within it, every time that \fBpcre_exec()\fP is
304    called. If the variable that the \fBmark\fP field points to is non-NULL for a
305    match, non-match, or partial match, \fBpcretest\fP prints the string to which
306    it points. For a match, this is shown on a line by itself, tagged with "MK:".
307    For a non-match it is added to the message.
308    .P
309    The \fB/L\fP modifier must be followed directly by the name of a locale, for
310    example,
311    .sp
312      /pattern/Lfr_FR
313    .sp
314    For this reason, it must be the last modifier. The given locale is set,
315    \fBpcre_maketables()\fP is called to build a set of character tables for the
316    locale, and this is then passed to \fBpcre_compile()\fP when compiling the
317    regular expression. Without an \fB/L\fP (or \fB/T\fP) modifier, NULL is passed
318    as the tables pointer; that is, \fB/L\fP applies only to the expression on
319    which it appears.
320  .P  .P
321  The \fB/M\fP modifier causes the size of memory block used to hold the compiled  The \fB/M\fP modifier causes the size of memory block used to hold the compiled
322  pattern to be output.  pattern to be output.
323  .P  .P
324    If the \fB/S\fP modifier appears once, it causes \fBpcre_study()\fP to be
325    called after the expression has been compiled, and the results used when the
326    expression is matched. If \fB/S\fP appears twice, it suppresses studying, even
327    if it was requested externally by the \fB-s\fP command line option. This makes
328    it possible to specify that certain patterns are always studied, and others are
329    never studied, independently of \fB-s\fP. This feature is used in the test
330    files in a few cases where the output is different when the pattern is studied.
331    .P
332    If the \fB/S\fP modifier is immediately followed by a + character, the call to
333    \fBpcre_study()\fP is made with the PCRE_STUDY_JIT_COMPILE option, requesting
334    just-in-time optimization support if it is available. Note that there is also a
335    \fB/+\fP modifier; it must not be given immediately after \fB/S\fP because this
336    will be misinterpreted. If JIT studying is successful, it will automatically be
337    used when \fBpcre_exec()\fP is run, except when incompatible run-time options
338    are specified. These include the partial matching options; a complete list is
339    given in the
340    .\" HREF
341    \fBpcrejit\fP
342    .\"
343    documentation. See also the \fB\eJ\fP escape sequence below for a way of
344    setting the size of the JIT stack.
345    .P
346    The \fB/T\fP modifier must be followed by a single digit. It causes a specific
347    set of built-in character tables to be passed to \fBpcre_compile()\fP. It is
348    used in the standard PCRE tests to check behaviour with different character
349    tables. The digit specifies the tables as follows:
350    .sp
351      0   the default ASCII tables, as distributed in
352            pcre_chartables.c.dist
353      1   a set of tables defining ISO 8859 characters
354    .sp
355    In table 1, some characters whose codes are greater than 128 are identified as
356    letters, digits, spaces, etc.
357    .
358    .
359    .SS "Using the POSIX wrapper API"
360    .rs
361    .sp
362  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
363  API rather than its native API. When this is done, all other modifiers except  API rather than its native API. When \fB/P\fP is set, the following modifiers
364  \fB/i\fP, \fB/m\fP, and \fB/+\fP are ignored. REG_ICASE is set if \fB/i\fP is  set options for the \fBregcomp()\fP function:
365  present, and REG_NEWLINE is set if \fB/m\fP is present. The wrapper functions  .sp
366  force PCRE_DOLLAR_ENDONLY always, and PCRE_DOTALL unless REG_NEWLINE is set.    /i    REG_ICASE
367  .P    /m    REG_NEWLINE
368  The \fB/8\fP modifier causes \fBpcretest\fP to call PCRE with the PCRE_UTF8    /N    REG_NOSUB
369  option set. This turns on support for UTF-8 character handling in PCRE,    /s    REG_DOTALL     )
370  provided that it was compiled with this support enabled. This modifier also    /U    REG_UNGREEDY   ) These options are not part of
371  causes any non-printing characters in output strings to be printed using the    /W    REG_UCP        )   the POSIX standard
372  \ex{hh...} notation if they are valid UTF-8 sequences.    /8    REG_UTF8       )
373  .P  .sp
374  If the \fB/?\fP modifier is used with \fB/8\fP, it causes \fBpcretest\fP to  The \fB/+\fP modifier works as described above. All other modifiers are
375  call \fBpcre_compile()\fP with the PCRE_NO_UTF8_CHECK option, to suppress the  ignored.
 checking of the string for UTF-8 validity.  
376  .  .
377  .  .
378  .SH "DATA LINES"  .SH "DATA LINES"
379  .rs  .rs
380  .sp  .sp
381  Before each data line is passed to \fBpcre_exec()\fP, leading and trailing  Before each data line is passed to \fBpcre_exec()\fP, leading and trailing
382  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
383  pretty esoteric features, intended for checking out some of the more  are pretty esoteric features, intended for checking out some of the more
384  complicated features of PCRE. If you are just testing "ordinary" regular  complicated features of PCRE. If you are just testing "ordinary" regular
385  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
386  recognized:  recognized:
# Line 280  recognized: Line 388  recognized:
388    \ea         alarm (BEL, \ex07)    \ea         alarm (BEL, \ex07)
389    \eb         backspace (\ex08)    \eb         backspace (\ex08)
390    \ee         escape (\ex27)    \ee         escape (\ex27)
391    \ef         formfeed (\ex0c)    \ef         form feed (\ex0c)
392    \en         newline (\ex0a)    \en         newline (\ex0a)
393  .\" JOIN  .\" JOIN
394    \eqdd       set the PCRE_MATCH_LIMIT limit to dd    \eqdd       set the PCRE_MATCH_LIMIT limit to dd
# Line 289  recognized: Line 397  recognized:
397    \et         tab (\ex09)    \et         tab (\ex09)
398    \ev         vertical tab (\ex0b)    \ev         vertical tab (\ex0b)
399    \ennn       octal character (up to 3 octal digits)    \ennn       octal character (up to 3 octal digits)
400    \exhh       hexadecimal character (up to 2 hex digits)                 always a byte unless > 255 in UTF-8 mode
401      \exhh       hexadecimal byte (up to 2 hex digits)
402  .\" JOIN  .\" JOIN
403    \ex{hh...}  hexadecimal character, any number of digits    \ex{hh...}  hexadecimal character, any number of digits
404                 in UTF-8 mode                 in UTF-8 mode
# Line 329  recognized: Line 438  recognized:
438                 "name" after a successful match (name termin-                 "name" after a successful match (name termin-
439                 ated by next non-alphanumeric character)                 ated by next non-alphanumeric character)
440  .\" JOIN  .\" JOIN
441      \eJdd       set up a JIT stack of dd kilobytes maximum (any
442                   number of digits)
443    .\" JOIN
444    \eL         call pcre_get_substringlist() after a    \eL         call pcre_get_substringlist() after a
445                 successful match                 successful match
446  .\" JOIN  .\" JOIN
# Line 336  recognized: Line 448  recognized:
448                 MATCH_LIMIT_RECURSION settings                 MATCH_LIMIT_RECURSION settings
449  .\" JOIN  .\" JOIN
450    \eN         pass the PCRE_NOTEMPTY option to \fBpcre_exec()\fP    \eN         pass the PCRE_NOTEMPTY option to \fBpcre_exec()\fP
451                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP; if used twice, pass the
452                   PCRE_NOTEMPTY_ATSTART option
453  .\" JOIN  .\" JOIN
454    \eOdd       set the size of the output vector passed to    \eOdd       set the size of the output vector passed to
455                 \fBpcre_exec()\fP to dd (any number of digits)                 \fBpcre_exec()\fP to dd (any number of digits)
456  .\" JOIN  .\" JOIN
457    \eP         pass the PCRE_PARTIAL option to \fBpcre_exec()\fP    \eP         pass the PCRE_PARTIAL_SOFT option to \fBpcre_exec()\fP
458                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP; if used twice, pass the
459                   PCRE_PARTIAL_HARD option
460  .\" JOIN  .\" JOIN
461    \eQdd       set the PCRE_MATCH_LIMIT_RECURSION limit to dd    \eQdd       set the PCRE_MATCH_LIMIT_RECURSION limit to dd
462                 (any number of digits)                 (any number of digits)
463    \eR         pass the PCRE_DFA_RESTART option to \fBpcre_dfa_exec()\fP    \eR         pass the PCRE_DFA_RESTART option to \fBpcre_dfa_exec()\fP
464    \eS         output details of memory get/free calls during matching    \eS         output details of memory get/free calls during matching
465  .\" JOIN  .\" JOIN
466      \eY         pass the PCRE_NO_START_OPTIMIZE option to \fBpcre_exec()\fP
467                   or \fBpcre_dfa_exec()\fP
468    .\" JOIN
469    \eZ         pass the PCRE_NOTEOL option to \fBpcre_exec()\fP    \eZ         pass the PCRE_NOTEOL option to \fBpcre_exec()\fP
470                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP
471  .\" JOIN  .\" JOIN
472    \e?         pass the PCRE_NO_UTF8_CHECK option to    \e?         pass the PCRE_NO_UTF8_CHECK option to
473                 \fBpcre_exec()\fP or \fBpcre_dfa_exec()\fP                 \fBpcre_exec()\fP or \fBpcre_dfa_exec()\fP
   \e>dd       start the match at offset dd (any number of digits);  
474  .\" JOIN  .\" JOIN
475                 this sets the \fIstartoffset\fP argument for \fBpcre_exec()\fP    \e>dd       start the match at offset dd (optional "-"; then
476                 or \fBpcre_dfa_exec()\fP                 any number of digits); this sets the \fIstartoffset\fP
477                   argument for \fBpcre_exec()\fP or \fBpcre_dfa_exec()\fP
478  .\" JOIN  .\" JOIN
479    \e<cr>      pass the PCRE_NEWLINE_CR option to \fBpcre_exec()\fP    \e<cr>      pass the PCRE_NEWLINE_CR option to \fBpcre_exec()\fP
480                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP
# Line 368  recognized: Line 485  recognized:
485    \e<crlf>    pass the PCRE_NEWLINE_CRLF option to \fBpcre_exec()\fP    \e<crlf>    pass the PCRE_NEWLINE_CRLF option to \fBpcre_exec()\fP
486                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP
487  .\" JOIN  .\" JOIN
488      \e<anycrlf> pass the PCRE_NEWLINE_ANYCRLF option to \fBpcre_exec()\fP
489                   or \fBpcre_dfa_exec()\fP
490    .\" JOIN
491    \e<any>     pass the PCRE_NEWLINE_ANY option to \fBpcre_exec()\fP    \e<any>     pass the PCRE_NEWLINE_ANY option to \fBpcre_exec()\fP
492                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP
493  .sp  .sp
494    Note that \exhh always specifies one byte, even in UTF-8 mode; this makes it
495    possible to construct invalid UTF-8 sequences for testing purposes. On the
496    other hand, \ex{hh} is interpreted as a UTF-8 character in UTF-8 mode,
497    generating more than one byte if the value is greater than 127. When not in
498    UTF-8 mode, it generates one byte for values less than 256, and causes an error
499    for greater values.
500    .P
501  The escapes that specify line ending sequences are literal strings, exactly as  The escapes that specify line ending sequences are literal strings, exactly as
502  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.
503  .P  .P
# Line 379  the very last character is a backslash, Line 506  the very last character is a backslash,
506  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
507  input.  input.
508  .P  .P
509    The \fB\eJ\fP escape provides a way of setting the maximum stack size that is
510    used by the just-in-time optimization code. It is ignored if JIT optimization
511    is not being used. Providing a stack that is larger than the default 32K is
512    necessary only for very complicated patterns.
513    .P
514  If \eM is present, \fBpcretest\fP calls \fBpcre_exec()\fP several times, with  If \eM is present, \fBpcretest\fP calls \fBpcre_exec()\fP several times, with
515  different values in the \fImatch_limit\fP and \fImatch_limit_recursion\fP  different values in the \fImatch_limit\fP and \fImatch_limit_recursion\fP
516  fields of the \fBpcre_extra\fP data structure, until it finds the minimum  fields of the \fBpcre_extra\fP data structure, until it finds the minimum
517  numbers for each parameter that allow \fBpcre_exec()\fP to complete. The  numbers for each parameter that allow \fBpcre_exec()\fP to complete without
518  \fImatch_limit\fP number is a measure of the amount of backtracking that takes  error. Because this is testing a specific feature of the normal interpretive
519  place, and checking it out can be instructive. For most simple matches, the  \fBpcre_exec()\fP execution, the use of any JIT optimization that might have
520  number is quite small, but for patterns with very large numbers of matching  been set up by the \fB/S+\fP qualifier of \fB-s+\fP option is disabled.
521  possibilities, it can become large very quickly with increasing length of  .P
522  subject string. The \fImatch_limit_recursion\fP number is a measure of how much  The \fImatch_limit\fP number is a measure of the amount of backtracking
523  stack (or, if PCRE is compiled with NO_RECURSE, how much heap) memory is needed  that takes place, and checking it out can be instructive. For most simple
524  to complete the match attempt.  matches, the number is quite small, but for patterns with very large numbers of
525    matching possibilities, it can become large very quickly with increasing length
526    of subject string. The \fImatch_limit_recursion\fP number is a measure of how
527    much stack (or, if PCRE is compiled with NO_RECURSE, how much heap) memory is
528    needed to complete the match attempt.
529  .P  .P
530  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
531  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
532  the call of \fBpcre_exec()\fP for the line in which it appears.  the call of \fBpcre_exec()\fP for the line in which it appears.
533  .P  .P
534  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
535  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,
536  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,
537  \fBregexec()\fP.  to be passed to \fBregexec()\fP.
538  .P  .P
539  The use of \ex{hh...} to represent UTF-8 characters is not dependent on the use  The use of \ex{hh...} to represent UTF-8 characters is not dependent on the use
540  of the \fB/8\fP modifier on the pattern. It is recognized always. There may be  of the \fB/8\fP modifier on the pattern. It is recognized always. There may be
541  any number of hexadecimal digits inside the braces. The result is from one to  any number of hexadecimal digits inside the braces. The result is from one to
542  six bytes, encoded according to the UTF-8 rules.  six bytes, encoded according to the original UTF-8 rules of RFC 2279. This
543    allows for values in the range 0 to 0x7FFFFFFF. Note that not all of those are
544    valid Unicode code points, or indeed valid UTF-8 characters according to the
545    later rules in RFC 3629.
546  .  .
547  .  .
548  .SH "THE ALTERNATIVE MATCHING FUNCTION"  .SH "THE ALTERNATIVE MATCHING FUNCTION"
# Line 432  found. This is always the shortest possi Line 571  found. This is always the shortest possi
571  This section describes the output when the normal matching function,  This section describes the output when the normal matching function,
572  \fBpcre_exec()\fP, is being used.  \fBpcre_exec()\fP, is being used.
573  .P  .P
574  When a match succeeds, pcretest outputs the list of captured substrings that  When a match succeeds, \fBpcretest\fP outputs the list of captured substrings
575  \fBpcre_exec()\fP returns, starting with number 0 for the string that matched  that \fBpcre_exec()\fP returns, starting with number 0 for the string that
576  the whole pattern. Otherwise, it outputs "No match" or "Partial match"  matched the whole pattern. Otherwise, it outputs "No match" when the return is
577  when \fBpcre_exec()\fP returns PCRE_ERROR_NOMATCH or PCRE_ERROR_PARTIAL,  PCRE_ERROR_NOMATCH, and "Partial match:" followed by the partially matching
578  respectively, and otherwise the PCRE negative error number. Here is an example  substring when \fBpcre_exec()\fP returns PCRE_ERROR_PARTIAL. (Note that this is
579  of an interactive \fBpcretest\fP run.  the entire substring that was inspected during the partial match; it may
580    include characters before the actual match start if a lookbehind assertion,
581    \eK, \eb, or \eB was involved.) For any other return, \fBpcretest\fP outputs
582    the PCRE negative error number and a short descriptive phrase. If the error is
583    a failed UTF-8 string check, the byte offset of the start of the failing
584    character and the reason code are also output, provided that the size of the
585    output vector is at least two. Here is an example of an interactive
586    \fBpcretest\fP run.
587  .sp  .sp
588    $ pcretest    $ pcretest
589    PCRE version 7.0 30-Nov-2006    PCRE version 8.13 2011-04-30
590  .sp  .sp
591      re> /^abc(\ed+)/      re> /^abc(\ed+)/
592    data> abc123    data> abc123
# Line 449  of an interactive \fBpcretest\fP run. Line 595  of an interactive \fBpcretest\fP run.
595    data> xyz    data> xyz
596    No match    No match
597  .sp  .sp
598    Unset capturing substrings that are not followed by one that is set are not
599    returned by \fBpcre_exec()\fP, and are not shown by \fBpcretest\fP. In the
600    following example, there are two capturing substrings, but when the first data
601    line is matched, the second, unset substring is not shown. An "internal" unset
602    substring is shown as "<unset>", as for the second data line.
603    .sp
604        re> /(a)|(b)/
605      data> a
606       0: a
607       1: a
608      data> b
609       0: b
610       1: <unset>
611       2: b
612    .sp
613  If the strings contain any non-printing characters, they are output as \e0x  If the strings contain any non-printing characters, they are output as \e0x
614  escapes, or as \ex{...} escapes if the \fB/8\fP modifier was present on the  escapes, or as \ex{...} escapes if the \fB/8\fP modifier was present on the
615  pattern. See below for the definition of non-printing characters. If the  pattern. See below for the definition of non-printing characters. If the
# Line 472  matching attempts are output in sequence Line 633  matching attempts are output in sequence
633     0: ipp     0: ipp
634     1: pp     1: pp
635  .sp  .sp
636  "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
637    of a failure message (the offset 4 that is specified by \e>4 is past the end of
638    the subject string):
639    .sp
640        re> /xyz/
641      data> xyz\e>4
642      Error -24 (bad offset value)
643  .P  .P
644  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
645  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 subject where there is at least one Line 670  the subject where there is at least one
670     2: tan     2: tan
671  .sp  .sp
672  (Using the normal matching function on this data finds only "tang".) The  (Using the normal matching function on this data finds only "tang".) The
673  longest matching string is always given first (and numbered zero).  longest matching string is always given first (and numbered zero). After a
674    PCRE_ERROR_PARTIAL return, the output is "Partial match:", followed by the
675    partially matching substring. (Note that this is the entire substring that was
676    inspected during the partial match; it may include characters before the actual
677    match start if a lookbehind assertion, \eK, \eb, or \eB was involved.)
678  .P  .P
679  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
680  at the end of the longest match. For example:  at the end of the longest match. For example:
# Line 529  indicating that the subject partially ma Line 700  indicating that the subject partially ma
700  match with additional subject data by means of the \eR escape sequence. For  match with additional subject data by means of the \eR escape sequence. For
701  example:  example:
702  .sp  .sp
703      re> /^\d?\d(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)\d\d$/      re> /^\ed?\ed(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)\ed\ed$/
704    data> 23ja\eP\eD    data> 23ja\eP\eD
705    Partial match: 23ja    Partial match: 23ja
706    data> n05\eR\eD    data> n05\eR\eD
# Line 573  example: Line 744  example:
744    +10 ^ ^    +10 ^ ^
745     0: E*     0: E*
746  .sp  .sp
747    If a pattern contains (*MARK) items, an additional line is output whenever
748    a change of latest mark is passed to the callout function. For example:
749    .sp
750        re> /a(*MARK:X)bc/C
751      data> abc
752      --->abc
753       +0 ^       a
754       +1 ^^      (*MARK:X)
755      +10 ^^      b
756      Latest Mark: X
757      +11 ^ ^     c
758      +12 ^  ^
759       0: abc
760    .sp
761    The mark changes between matching "a" and "b", but stays the same for the rest
762    of the match, so nothing more is output. If, as a result of backtracking, the
763    mark reverts to being unset, the text "<unset>" is output.
764    .P
765  The callout function in \fBpcretest\fP returns zero (carry on matching) by  The callout function in \fBpcretest\fP returns zero (carry on matching) by
766  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
767  change this.  change this and other parameters of the callout.
768  .P  .P
769  Inserting callouts can be helpful when using \fBpcretest\fP to check  Inserting callouts can be helpful when using \fBpcretest\fP to check
770  complicated regular expressions. For further information about callouts, see  complicated regular expressions. For further information about callouts, see
# Line 605  function to distinguish printing and non Line 794  function to distinguish printing and non
794  .rs  .rs
795  .sp  .sp
796  The facilities described in this section are not available when the POSIX  The facilities described in this section are not available when the POSIX
797  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
798  specified.  specified.
799  .P  .P
800  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 619  See the Line 808  See the
808  \fBpcreprecompile\fP  \fBpcreprecompile\fP
809  .\"  .\"
810  documentation for a discussion about saving and re-using compiled patterns.  documentation for a discussion about saving and re-using compiled patterns.
811    Note that if the pattern was successfully studied with JIT optimization, the
812    JIT data cannot be saved.
813  .P  .P
814  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
815  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 626  written as four bytes in big-endian orde Line 817  written as four bytes in big-endian orde
817  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
818  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
819  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
820  follows immediately after the compiled pattern. After writing the file,  (excluding any JIT data) follows immediately after the compiled pattern. After
821  \fBpcretest\fP expects to read a new pattern.  writing the file, \fBpcretest\fP expects to read a new pattern.
822  .P  .P
823  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
824  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,
825  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 <
826  characters.  characters.
827  For example:  For example:
828  .sp  .sp
829     re> </some/file     re> </some/file
830    Compiled regex loaded from /some/file    Compiled pattern loaded from /some/file
831    No study data    No study data
832  .sp  .sp
833  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
834  the usual way.  information cannot be saved and restored, and so is lost. When the pattern has
835    been loaded, \fBpcretest\fP proceeds to read data lines in the usual way.
836  .P  .P
837  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
838  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
# Line 664  result is undefined. Line 856  result is undefined.
856  .SH "SEE ALSO"  .SH "SEE ALSO"
857  .rs  .rs
858  .sp  .sp
859  \fBpcre\fP(3), \fBpcreapi\fP(3), \fBpcrecallout\fP(3), \fBpcrematching\fP(3),  \fBpcre\fP(3), \fBpcreapi\fP(3), \fBpcrecallout\fP(3), \fBpcrejit\fP,
860  \fBpcrepartial\fP(d), \fPpcrepattern\fP(3), \fBpcreprecompile\fP(3).  \fBpcrematching\fP(3), \fBpcrepartial\fP(d), \fBpcrepattern\fP(3),
861    \fBpcreprecompile\fP(3).
862  .  .
863  .  .
864  .SH AUTHOR  .SH AUTHOR
865  .rs  .rs
866  .sp  .sp
867    .nf
868  Philip Hazel  Philip Hazel
869  .br  University Computing Service
 University Computing Service,  
 .br  
870  Cambridge CB2 3QH, England.  Cambridge CB2 3QH, England.
871  .P  .fi
872  .in 0  .
873  Last updated: 30 November 2006  .
874  .br  .SH REVISION
875  Copyright (c) 1997-2006 University of Cambridge.  .rs
876    .sp
877    .nf
878    Last updated: 26 August 2011
879    Copyright (c) 1997-2011 University of Cambridge.
880    .fi

Legend:
Removed from v.93  
changed lines
  Added in v.691

  ViewVC Help
Powered by ViewVC 1.1.5