/[pcre]/code/trunk/doc/html/pcretest.html

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

Parent Directory | Revision Log | View Patch Patch

-revision 653 by ph10,
Wed Nov 24 17:39:25 2010 UTC
+revision 654 by ph10,
Tue Aug  2 11:00:40 2011 UTC
 Line 14 
 man page, in case the conversion went wr
  <br>
  <ul>
  <li><a name="TOC1" href="#SEC1">SYNOPSIS</a>
- <li><a name="TOC2" href="#SEC2">OPTIONS</a>
+ <li><a name="TOC2" href="#SEC2">COMMAND LINE OPTIONS</a>
  <li><a name="TOC3" href="#SEC3">DESCRIPTION</a>
  <li><a name="TOC4" href="#SEC4">PATTERN MODIFIERS</a>
  <li><a name="TOC5" href="#SEC5">DATA LINES</a>
 Line 31 
 man page, in case the conversion went wr
  </ul>
  <br><a name="SEC1" href="#TOC1">SYNOPSIS</a><br>
  <P>
- <b>pcretest [options] [source] [destination]</b>
+ <b>pcretest [options] [input file [output file]]</b>
  <br>
  <br>
  <b>pcretest</b> was written as a test program for the PCRE regular expression
 Line 42 
 details of the regular expressions thems
  documentation. For details of the PCRE library function calls and their
  options, see the
  <a href="pcreapi.html"><b>pcreapi</b></a>
- documentation.
+ documentation. The input for <b>pcretest</b> is a sequence of regular expression
+ patterns and strings to be matched, as described below. The output shows the
+ result of each match. Options on the command line and the patterns control PCRE
+ options and exactly what is output.
  </P>
- <br><a name="SEC2" href="#TOC1">OPTIONS</a><br>
+ <br><a name="SEC2" href="#TOC1">COMMAND LINE OPTIONS</a><br>
  <P>
  <b>-b</b>
- Behave as if each regex has the <b>/B</b> (show bytecode) modifier; the internal
+ Behave as if each pattern has the <b>/B</b> (show byte code) modifier; the
- form is output after compilation.
+ internal form is output after compilation.
  </P>
  <P>
  <b>-C</b>
-Line 57 
 about the optional features that are inc
+Line 60 
 about the optional features that are inc
  </P>
  <P>
  <b>-d</b>
- Behave as if each regex has the <b>/D</b> (debug) modifier; the internal
+ Behave as if each pattern has the <b>/D</b> (debug) modifier; the internal
  form and information about the compiled pattern is output after compilation;
  <b>-d</b> is equivalent to <b>-b -i</b>.
  </P>
-Line 73 
 Output a brief summary these options and
+Line 76 
 Output a brief summary these options and
  </P>
  <P>
  <b>-i</b>
- Behave as if each regex has the <b>/I</b> modifier; information about the
+ Behave as if each pattern has the <b>/I</b> modifier; information about the
  compiled pattern is given after compilation.
  </P>
  <P>
-Line 85 
 calling pcre_exec() repeatedly wi
+Line 88 
 calling pcre_exec() repeatedly wi
  <P>
  <b>-m</b>
  Output the size of each compiled pattern after it has been compiled. This is
- equivalent to adding <b>/M</b> to each regular expression. For compatibility
+ equivalent to adding <b>/M</b> to each regular expression.
- with earlier versions of pcretest, <b>-s</b> is a synonym for <b>-m</b>.
  </P>
  <P>
  <b>-o</b> <i>osize</i>
-Line 99 
 below).
+Line 101 
 below).
  </P>
  <P>
  <b>-p</b>
- Behave as if each regex has the <b>/P</b> modifier; the POSIX wrapper API is
+ Behave as if each pattern has the <b>/P</b> modifier; the POSIX wrapper API is
  used to call PCRE. None of the other options has any effect when <b>-p</b> is
  set.
  </P>
-Line 109 
 Do not output the version number of p
+Line 111 
 Do not output the version number of p
  </P>
  <P>
  <b>-S</b> <i>size</i>
- On Unix-like systems, set the size of the runtime stack to <i>size</i>
+ On Unix-like systems, set the size of the run-time stack to <i>size</i>
  megabytes.
  </P>
  <P>
+ <b>-s</b>
+ Behave as if each pattern has the <b>/S</b> modifier; in other words, force each
+ pattern to be studied. If the <b>/I</b> or <b>/D</b> option is present on a
+ pattern (requesting output about the compiled pattern), information about the
+ result of studying is not included when studying is caused only by <b>-s</b> and
+ neither <b>-i</b> nor <b>-d</b> is present on the command line. This behaviour
+ means that the output from tests that are run with and without <b>-s</b> should
+ be identical, except when options that output information about the actual
+ running of a match are set. The <b>-M</b>, <b>-t</b>, and <b>-tm</b> options,
+ which give information about resources used, are likely to produce different
+ output with and without <b>-s</b>. Output may also differ if the <b>/C</b> option
+ is present on an individual pattern. This uses callouts to trace the the
+ matching process, and this may be different between studied and non-studied
+ patterns. If the pattern contains (*MARK) items there may also be differences,
+ for the same reason. The <b>-s</b> command line option can be overridden for
+ specific patterns that should never be studied (see the /S option below).
+ </P>
+ <P>
  <b>-t</b>
  Run each compile, study, and match many times with a timer, and output
  resulting time per compile or match (in milliseconds). Do not set <b>-m</b> with
-Line 189 
 pcretest to read the next line as a cont
+Line 209 
 pcretest to read the next line as a cont
  A pattern may be followed by any number of modifiers, which are mostly single
  characters. Following Perl usage, these are referred to below as, for example,
  "the <b>/i</b> modifier", even though the delimiter of the pattern need not
- 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
  appear between the final pattern delimiter and the first modifier, and between
  the modifiers themselves.
  </P>
-Line 226 
 options that do not correspond to anythi
+Line 246 
 options that do not correspond to anythi
    <b>/&#60;bsr_unicode&#62;</b>  PCRE_BSR_UNICODE
  </pre>
  The modifiers that are enclosed in angle brackets are literal strings as shown,
- including the angle brackets, but the letters can be in either case. This
+ including the angle brackets, but the letters within can be in either case.
- example sets multiline matching with CRLF as the line ending sequence:
+ This example sets multiline matching with CRLF as the line ending sequence:
  <pre>
-   /^abc/m&#60;crlf&#62;
+   /^abc/m&#60;CRLF&#62;
  </pre>
  As well as turning on the PCRE_UTF8 option, the <b>/8</b> modifier also causes
  any non-printing characters in output strings to be printed using the
-Line 271 
 operates.
+Line 291 
 operates.
  </P>
  <P>
  The <b>/+</b> modifier requests that as well as outputting the substring that
- matched the entire pattern, pcretest should in addition output the remainder of
+ matched the entire pattern, <b>pcretest</b> should in addition output the
- 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
- multiple copies of the same substring.
+ contains multiple copies of the same substring. If the <b>+</b> modifier appears
+ twice, the same action is taken for captured substrings. In each case the
+ remainder is output on the following line with a plus character following the
+ capture number.
+ </P>
+ <P>
+ The <b>/=</b> modifier requests that the values of all potential captured
+ parentheses be output after a match by <b>pcre_exec()</b>. By default, only
+ those up to the highest one actually used in the match are output
+ (corresponding to the return code from <b>pcre_exec()</b>). Values in the
+ offsets vector corresponding to higher numbers should be set to -1, and these
+ are output as "&#60;unset&#62;". This modifier gives a way of checking that this is
+ happening.
  </P>
  <P>
  The <b>/B</b> modifier is a debugging feature. It requests that <b>pcretest</b>
-Line 331 
 The /M modifier causes the size o
+Line 363 
 The /M modifier causes the size o
  pattern to be output.
  </P>
  <P>
- The <b>/S</b> modifier causes <b>pcre_study()</b> to be called after the
+ If the <b>/S</b> modifier appears once, it causes <b>pcre_study()</b> to be
- expression has been compiled, and the results used when the expression is
+ called after the expression has been compiled, and the results used when the
- matched.
+ expression is matched. If <b>/S</b> appears twice, it suppresses studying, even
+ if it was requested externally by the <b>-s</b> command line option. This makes
+ it possible to specify that certain patterns are always studied, and others are
+ never studied, independently of <b>-s</b>. This feature is used in the test
+ files in a few cases where the output is different when the pattern is studied.
  </P>
  <P>
  The <b>/T</b> modifier must be followed by a single digit. It causes a specific
-Line 370 
 ignored.
+Line 406 
 ignored.
  <br><a name="SEC5" href="#TOC1">DATA LINES</a><br>
  <P>
  Before each data line is passed to <b>pcre_exec()</b>, leading and trailing
- whitespace is removed, and it is then scanned for \ escapes. Some of these are
+ white space is removed, and it is then scanned for \ escapes. Some of these
- pretty esoteric features, intended for checking out some of the more
+ are pretty esoteric features, intended for checking out some of the more
  complicated features of PCRE. If you are just testing "ordinary" regular
  expressions, you probably don't need any of these. The following escapes are
  recognized:
-Line 379 
 recognized:
+Line 415 
 recognized:
    \a         alarm (BEL, \x07)
    \b         backspace (\x08)
    \e         escape (\x27)
-   \f         formfeed (\x0c)
+   \f         form feed (\x0c)
    \n         newline (\x0a)
    \qdd       set the PCRE_MATCH_LIMIT limit to dd (any number of digits)
    \r         carriage return (\x0d)
-Line 498 
 This section describes the output when t
+Line 534 
 This section describes the output when t
  <b>pcre_exec()</b>, is being used.
  </P>
  <P>
- When a match succeeds, pcretest outputs the list of captured substrings that
+ When a match succeeds, <b>pcretest</b> outputs the list of captured substrings
- <b>pcre_exec()</b> returns, starting with number 0 for the string that matched
+ that <b>pcre_exec()</b> returns, starting with number 0 for the string that
- the whole pattern. Otherwise, it outputs "No match" when the return is
+ matched the whole pattern. Otherwise, it outputs "No match" when the return is
  PCRE_ERROR_NOMATCH, and "Partial match:" followed by the partially matching
  substring when <b>pcre_exec()</b> returns PCRE_ERROR_PARTIAL. (Note that this is
  the entire substring that was inspected during the partial match; it may
  include characters before the actual match start if a lookbehind assertion,
- \K, \b, or \B was involved.) For any other returns, it outputs the PCRE
+ \K, \b, or \B was involved.) For any other return, <b>pcretest</b> outputs
- negative error number. Here is an example of an interactive <b>pcretest</b> run.
+ the PCRE negative error number and a short descriptive phrase. If the error is
+ a failed UTF-8 string check, the byte offset of the start of the failing
+ character and the reason code are also output, provided that the size of the
+ output vector is at least two. Here is an example of an interactive
+ <b>pcretest</b> run.
  <pre>
    $ pcretest
-   PCRE version 7.0 30-Nov-2006
+   PCRE version 8.13 2011-04-30
      re&#62; /^abc(\d+)/
    data&#62; abc123
-Line 518 
 negative error number. Here is an exampl
+Line 558 
 negative error number. Here is an exampl
    data&#62; xyz
    No match
  </pre>
- Note that unset capturing substrings that are not followed by one that is set
+ Unset capturing substrings that are not followed by one that is set are not
- are not returned by <b>pcre_exec()</b>, and are not shown by <b>pcretest</b>. In
+ returned by <b>pcre_exec()</b>, and are not shown by <b>pcretest</b>. In the
- the following example, there are two capturing substrings, but when the first
+ following example, there are two capturing substrings, but when the first data
- data line is matched, the second, unset substring is not shown. An "internal"
+ line is matched, the second, unset substring is not shown. An "internal" unset
- unset substring is shown as "&#60;unset&#62;", as for the second data line.
+ substring is shown as "&#60;unset&#62;", as for the second data line.
  <pre>
      re&#62; /(a)|(b)/
    data&#62; a
-Line 556 
 matching attempts are output in sequence
+Line 596 
 matching attempts are output in sequence
 : ipp
 : pp
  </pre>
- "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
+ of a failure message (the offset 4 that is specified by \&#62;4 is past the end of
+ the subject string):
+ <pre>
+     re&#62; /xyz/
+   data&#62; xyz\&#62;4
+   Error -24 (bad offset value)
+ </PRE>
  </P>
  <P>
  If any of the sequences <b>\C</b>, <b>\G</b>, or <b>\L</b> are present in a
-Line 656 
 example:
+Line 703 
 example:
    +10 ^ ^
 : E*
  </pre>
+ If a pattern contains (*MARK) items, an additional line is output whenever
+ a change of latest mark is passed to the callout function. For example:
+ <pre>
+     re&#62; /a(*MARK:X)bc/C
+   data&#62; abc
+   ---&#62;abc
+    +0 ^       a
+    +1 ^^      (*MARK:X)
+   +10 ^^      b
+   Latest Mark: X
+   +11 ^ ^     c
+   +12 ^  ^
+: abc
+ </pre>
+ The mark changes between matching "a" and "b", but stays the same for the rest
+ of the match, so nothing more is output. If, as a result of backtracking, the
+ mark reverts to being unset, the text "&#60;unset&#62;" is output.
+ </P>
+ <P>
  The callout function in <b>pcretest</b> returns zero (carry on matching) by
  default, but you can use a \C item in a data line (as described above) to
- change this.
+ change this and other parameters of the callout.
  </P>
  <P>
  Inserting callouts can be helpful when using <b>pcretest</b> to check
-Line 682 
 function to distinguish printing and non
+Line 748 
 function to distinguish printing and non
  <br><a name="SEC12" href="#TOC1">SAVING AND RELOADING COMPILED PATTERNS</a><br>
  <P>
  The facilities described in this section are not available when the POSIX
- inteface to PCRE is being used, that is, when the <b>/P</b> pattern modifier is
+ interface to PCRE is being used, that is, when the <b>/P</b> pattern modifier is
  specified.
  </P>
  <P>
-Line 707 
 follows immediately after the compiled p
+Line 773 
 follows immediately after the compiled p
  <b>pcretest</b> expects to read a new pattern.
  </P>
  <P>
- A saved pattern can be reloaded into <b>pcretest</b> by specifing &#60; and a file
+ A saved pattern can be reloaded into <b>pcretest</b> by specifying &#60; and a file
  name instead of a pattern. The name of the file must not contain a &#60; character,
  as otherwise <b>pcretest</b> will interpret the line as a pattern delimited by &#60;
  characters.
  For example:
  <pre>
     re&#62; &#60;/some/file
-   Compiled regex loaded from /some/file
+   Compiled pattern loaded from /some/file
    No study data
  </pre>
  When the pattern has been loaded, <b>pcretest</b> proceeds to read data lines in
-Line 757 
 Cambridge CB2 3QH, England.
+Line 823 
 Cambridge CB2 3QH, England.
  </P>
  <br><a name="SEC15" href="#TOC1">REVISION</a><br>
  <P>
- Last updated: 21 November 2010
+ Last updated: 01 August 2011
  <br>
- Copyright &copy; 1997-2010 University of Cambridge.
+ Copyright &copy; 1997-2011 University of Cambridge.
  <br>
  <p>
  Return to the <a href="index.html">PCRE index page</a>.

 Legend:



Removed from v.653
 


changed lines


 
Added in v.654
 Legend:



Removed from v.653
 


changed lines


 
Added in v.654
-Removed from v.653
+Added in v.654

webmaster@exim.org	ViewVC Help
Powered by ViewVC 1.1.12