/[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 386 by ph10, Tue Mar 10 11:48:33 2009 UTC revision 570 by ph10, Sun Nov 7 16:25:12 2010 UTC
# Line 51  compiled pattern is given after compilat Line 51  compiled pattern is given after compilat
51  .TP 10  .TP 10
52  \fB-M\fP  \fB-M\fP
53  Behave as if each data line contains the \eM escape sequence; this causes  Behave as if each data line contains the \eM escape sequence; this causes
54  PCRE to discover the minimum MATCH_LIMIT and MATCH_LIMIT_RECURSION settings by  PCRE to discover the minimum MATCH_LIMIT and MATCH_LIMIT_RECURSION settings by
55  calling \fBpcre_exec()\fP repeatedly with different limits.  calling \fBpcre_exec()\fP repeatedly with different limits.
56  .TP 10  .TP 10
57  \fB-m\fP  \fB-m\fP
# Line 165  effect as they do in Perl. For example: Line 165  effect as they do in Perl. For example:
165  .sp  .sp
166    /caseless/i    /caseless/i
167  .sp  .sp
168  The following table shows additional modifiers for setting PCRE options that do  The following table shows additional modifiers for setting PCRE compile-time
169  not correspond to anything in Perl:  options that do not correspond to anything in Perl:
170  .sp  .sp
171      \fB/8\fP              PCRE_UTF8
172      \fB/?\fP              PCRE_NO_UTF8_CHECK
173    \fB/A\fP              PCRE_ANCHORED    \fB/A\fP              PCRE_ANCHORED
174    \fB/C\fP              PCRE_AUTO_CALLOUT    \fB/C\fP              PCRE_AUTO_CALLOUT
175    \fB/E\fP              PCRE_DOLLAR_ENDONLY    \fB/E\fP              PCRE_DOLLAR_ENDONLY
# Line 175  not correspond to anything in Perl: Line 177  not correspond to anything in Perl:
177    \fB/J\fP              PCRE_DUPNAMES    \fB/J\fP              PCRE_DUPNAMES
178    \fB/N\fP              PCRE_NO_AUTO_CAPTURE    \fB/N\fP              PCRE_NO_AUTO_CAPTURE
179    \fB/U\fP              PCRE_UNGREEDY    \fB/U\fP              PCRE_UNGREEDY
180      \fB/W\fP              PCRE_UCP
181    \fB/X\fP              PCRE_EXTRA    \fB/X\fP              PCRE_EXTRA
182    \fB/<JS>\fP           PCRE_JAVASCRIPT_COMPAT    \fB/<JS>\fP           PCRE_JAVASCRIPT_COMPAT
183    \fB/<cr>\fP           PCRE_NEWLINE_CR    \fB/<cr>\fP           PCRE_NEWLINE_CR
# Line 185  not correspond to anything in Perl: Line 188  not correspond to anything in Perl:
188    \fB/<bsr_anycrlf>\fP  PCRE_BSR_ANYCRLF    \fB/<bsr_anycrlf>\fP  PCRE_BSR_ANYCRLF
189    \fB/<bsr_unicode>\fP  PCRE_BSR_UNICODE    \fB/<bsr_unicode>\fP  PCRE_BSR_UNICODE
190  .sp  .sp
191  Those specifying line ending sequences are literal strings as shown, but the  The modifiers that are enclosed in angle brackets are literal strings as shown,
192  letters can be in either case. This example sets multiline matching with CRLF  including the angle brackets, but the letters can be in either case. This
193  as the line ending sequence:  example sets multiline matching with CRLF as the line ending sequence:
194  .sp  .sp
195    /^abc/m<crlf>    /^abc/m<crlf>
196  .sp  .sp
197  Details of the meanings of these PCRE options are given in the  As well as turning on the PCRE_UTF8 option, the \fB/8\fP modifier also causes
198    any non-printing characters in output strings to be printed using the
199    \ex{hh...} notation if they are valid UTF-8 sequences. Full details of the PCRE
200    options are given in the
201  .\" HREF  .\" HREF
202  \fBpcreapi\fP  \fBpcreapi\fP
203  .\"  .\"
# Line 211  substring. This makes a difference to th Line 217  substring. This makes a difference to th
217  begins with a lookbehind assertion (including \eb or \eB).  begins with a lookbehind assertion (including \eb or \eB).
218  .P  .P
219  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
220  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
221  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
222  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
223  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
224  \fB/g\fP modifier or the \fBsplit()\fP function.  using the \fB/g\fP modifier or the \fBsplit()\fP function. Normally, the start
225    offset is advanced by one character, but if the newline convention recognizes
226    CRLF as a newline, and the current character is CR followed by LF, an advance
227    of two is used.
228  .  .
229  .  .
230  .SS "Other modifiers"  .SS "Other modifiers"
# Line 236  also present, this data is replaced by s Line 245  also present, this data is replaced by s
245  use in the automatic test scripts; it ensures that the same output is generated  use in the automatic test scripts; it ensures that the same output is generated
246  for different internal link sizes.  for different internal link sizes.
247  .P  .P
 The \fB/L\fP modifier must be followed directly by the name of a locale, for  
 example,  
 .sp  
   /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.  
 .P  
248  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
249  \fB/BI\fP, that is, both the \fB/B\fP and the \fB/I\fP modifiers.  \fB/BI\fP, that is, both the \fB/B\fP and the \fB/I\fP modifiers.
250  .P  .P
# Line 263  available when the POSIX interface to PC Line 256  available when the POSIX interface to PC
256  \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
257  reloading compiled patterns below.  reloading compiled patterns below.
258  .P  .P
259  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
260  expression has been compiled, and the results used when the expression is  compiled pattern (whether it is anchored, has a fixed first character, and
261  matched.  so on). It does this by calling \fBpcre_fullinfo()\fP after compiling a
262    pattern. If the pattern is studied, the results of that are also output.
263    .P
264    The \fB/K\fP modifier requests \fBpcretest\fP to show names from backtracking
265    control verbs that are returned from calls to \fBpcre_exec()\fP. It causes
266    \fBpcretest\fP to create a \fBpcre_extra\fP block if one has not already been
267    created by a call to \fBpcre_study()\fP, and to set the PCRE_EXTRA_MARK flag
268    and the \fBmark\fP field within it, every time that \fBpcre_exec()\fP is
269    called. If the variable that the \fBmark\fP field points to is non-NULL for a
270    match, non-match, or partial match, \fBpcretest\fP prints the string to which
271    it points. For a match, this is shown on a line by itself, tagged with "MK:".
272    For a non-match it is added to the message.
273    .P
274    The \fB/L\fP modifier must be followed directly by the name of a locale, for
275    example,
276    .sp
277      /pattern/Lfr_FR
278    .sp
279    For this reason, it must be the last modifier. The given locale is set,
280    \fBpcre_maketables()\fP is called to build a set of character tables for the
281    locale, and this is then passed to \fBpcre_compile()\fP when compiling the
282    regular expression. Without an \fB/L\fP (or \fB/T\fP) modifier, NULL is passed
283    as the tables pointer; that is, \fB/L\fP applies only to the expression on
284    which it appears.
285  .P  .P
286  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
287  pattern to be output.  pattern to be output.
288  .P  .P
289    The \fB/S\fP modifier causes \fBpcre_study()\fP to be called after the
290    expression has been compiled, and the results used when the expression is
291    matched.
292    .P
293    The \fB/T\fP modifier must be followed by a single digit. It causes a specific
294    set of built-in character tables to be passed to \fBpcre_compile()\fP. It is
295    used in the standard PCRE tests to check behaviour with different character
296    tables. The digit specifies the tables as follows:
297    .sp
298      0   the default ASCII tables, as distributed in
299            pcre_chartables.c.dist
300      1   a set of tables defining ISO 8859 characters
301    .sp
302    In table 1, some characters whose codes are greater than 128 are identified as
303    letters, digits, spaces, etc.
304    .
305    .
306    .SS "Using the POSIX wrapper API"
307    .rs
308    .sp
309  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
310  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
311  \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:
312  present, and REG_NEWLINE is set if \fB/m\fP is present. The wrapper functions  .sp
313  force PCRE_DOLLAR_ENDONLY always, and PCRE_DOTALL unless REG_NEWLINE is set.    /i    REG_ICASE
314  .P    /m    REG_NEWLINE
315  The \fB/8\fP modifier causes \fBpcretest\fP to call PCRE with the PCRE_UTF8    /N    REG_NOSUB
316  option set. This turns on support for UTF-8 character handling in PCRE,    /s    REG_DOTALL     )
317  provided that it was compiled with this support enabled. This modifier also    /U    REG_UNGREEDY   ) These options are not part of
318  causes any non-printing characters in output strings to be printed using the    /W    REG_UCP        )   the POSIX standard
319  \ex{hh...} notation if they are valid UTF-8 sequences.    /8    REG_UTF8       )
320  .P  .sp
321  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
322  call \fBpcre_compile()\fP with the PCRE_NO_UTF8_CHECK option, to suppress the  ignored.
 checking of the string for UTF-8 validity.  
323  .  .
324  .  .
325  .SH "DATA LINES"  .SH "DATA LINES"
# Line 309  recognized: Line 344  recognized:
344    \et         tab (\ex09)    \et         tab (\ex09)
345    \ev         vertical tab (\ex0b)    \ev         vertical tab (\ex0b)
346    \ennn       octal character (up to 3 octal digits)    \ennn       octal character (up to 3 octal digits)
347    \exhh       hexadecimal character (up to 2 hex digits)                 always a byte unless > 255 in UTF-8 mode
348      \exhh       hexadecimal byte (up to 2 hex digits)
349  .\" JOIN  .\" JOIN
350    \ex{hh...}  hexadecimal character, any number of digits    \ex{hh...}  hexadecimal character, any number of digits
351                 in UTF-8 mode                 in UTF-8 mode
# Line 356  recognized: Line 392  recognized:
392                 MATCH_LIMIT_RECURSION settings                 MATCH_LIMIT_RECURSION settings
393  .\" JOIN  .\" JOIN
394    \eN         pass the PCRE_NOTEMPTY option to \fBpcre_exec()\fP    \eN         pass the PCRE_NOTEMPTY option to \fBpcre_exec()\fP
395                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP; if used twice, pass the
396                   PCRE_NOTEMPTY_ATSTART option
397  .\" JOIN  .\" JOIN
398    \eOdd       set the size of the output vector passed to    \eOdd       set the size of the output vector passed to
399                 \fBpcre_exec()\fP to dd (any number of digits)                 \fBpcre_exec()\fP to dd (any number of digits)
400  .\" JOIN  .\" JOIN
401    \eP         pass the PCRE_PARTIAL option to \fBpcre_exec()\fP    \eP         pass the PCRE_PARTIAL_SOFT option to \fBpcre_exec()\fP
402                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP; if used twice, pass the
403                   PCRE_PARTIAL_HARD option
404  .\" JOIN  .\" JOIN
405    \eQdd       set the PCRE_MATCH_LIMIT_RECURSION limit to dd    \eQdd       set the PCRE_MATCH_LIMIT_RECURSION limit to dd
406                 (any number of digits)                 (any number of digits)
407    \eR         pass the PCRE_DFA_RESTART option to \fBpcre_dfa_exec()\fP    \eR         pass the PCRE_DFA_RESTART option to \fBpcre_dfa_exec()\fP
408    \eS         output details of memory get/free calls during matching    \eS         output details of memory get/free calls during matching
409  .\" JOIN  .\" JOIN
410      \eY         pass the PCRE_NO_START_OPTIMIZE option to \fBpcre_exec()\fP
411                   or \fBpcre_dfa_exec()\fP
412    .\" JOIN
413    \eZ         pass the PCRE_NOTEOL option to \fBpcre_exec()\fP    \eZ         pass the PCRE_NOTEOL option to \fBpcre_exec()\fP
414                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP
415  .\" JOIN  .\" JOIN
416    \e?         pass the PCRE_NO_UTF8_CHECK option to    \e?         pass the PCRE_NO_UTF8_CHECK option to
417                 \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);  
418  .\" JOIN  .\" JOIN
419                 this sets the \fIstartoffset\fP argument for \fBpcre_exec()\fP    \e>dd       start the match at offset dd (optional "-"; then
420                 or \fBpcre_dfa_exec()\fP                 any number of digits); this sets the \fIstartoffset\fP
421                   argument for \fBpcre_exec()\fP or \fBpcre_dfa_exec()\fP
422  .\" JOIN  .\" JOIN
423    \e<cr>      pass the PCRE_NEWLINE_CR option to \fBpcre_exec()\fP    \e<cr>      pass the PCRE_NEWLINE_CR option to \fBpcre_exec()\fP
424                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP
# Line 394  recognized: Line 435  recognized:
435    \e<any>     pass the PCRE_NEWLINE_ANY option to \fBpcre_exec()\fP    \e<any>     pass the PCRE_NEWLINE_ANY option to \fBpcre_exec()\fP
436                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP
437  .sp  .sp
438    Note that \exhh always specifies one byte, even in UTF-8 mode; this makes it
439    possible to construct invalid UTF-8 sequences for testing purposes. On the
440    other hand, \ex{hh} is interpreted as a UTF-8 character in UTF-8 mode,
441    generating more than one byte if the value is greater than 127. When not in
442    UTF-8 mode, it generates one byte for values less than 256, and causes an error
443    for greater values.
444    .P
445  The escapes that specify line ending sequences are literal strings, exactly as  The escapes that specify line ending sequences are literal strings, exactly as
446  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.
447  .P  .P
# Line 419  by the \fB-O\fP command line option (or Line 467  by the \fB-O\fP command line option (or
467  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.
468  .P  .P
469  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
470  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,
471  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,
472  \fBregexec()\fP.  to be passed to \fBregexec()\fP.
473  .P  .P
474  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
475  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
# Line 460  This section describes the output when t Line 508  This section describes the output when t
508  .P  .P
509  When a match succeeds, pcretest outputs the list of captured substrings that  When a match succeeds, pcretest outputs the list of captured substrings that
510  \fBpcre_exec()\fP returns, starting with number 0 for the string that matched  \fBpcre_exec()\fP returns, starting with number 0 for the string that matched
511  the whole pattern. Otherwise, it outputs "No match" or "Partial match"  the whole pattern. Otherwise, it outputs "No match" when the return is
512  when \fBpcre_exec()\fP returns PCRE_ERROR_NOMATCH or PCRE_ERROR_PARTIAL,  PCRE_ERROR_NOMATCH, and "Partial match:" followed by the partially matching
513  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
514  of an interactive \fBpcretest\fP run.  the entire substring that was inspected during the partial match; it may
515    include characters before the actual match start if a lookbehind assertion,
516    \eK, \eb, or \eB was involved.) For any other returns, it outputs the PCRE
517    negative error number. Here is an example of an interactive \fBpcretest\fP run.
518  .sp  .sp
519    $ pcretest    $ pcretest
520    PCRE version 7.0 30-Nov-2006    PCRE version 7.0 30-Nov-2006
# Line 544  the subject where there is at least one Line 595  the subject where there is at least one
595     2: tan     2: tan
596  .sp  .sp
597  (Using the normal matching function on this data finds only "tang".) The  (Using the normal matching function on this data finds only "tang".) The
598  longest matching string is always given first (and numbered zero).  longest matching string is always given first (and numbered zero). After a
599    PCRE_ERROR_PARTIAL return, the output is "Partial match:", followed by the
600    partially matching substring. (Note that this is the entire substring that was
601    inspected during the partial match; it may include characters before the actual
602    match start if a lookbehind assertion, \eK, \eb, or \eB was involved.)
603  .P  .P
604  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
605  at the end of the longest match. For example:  at the end of the longest match. For example:
# Line 723  Cambridge CB2 3QH, England. Line 778  Cambridge CB2 3QH, England.
778  .rs  .rs
779  .sp  .sp
780  .nf  .nf
781  Last updated: 10 March 2009  Last updated: 07 November 2010
782  Copyright (c) 1997-2009 University of Cambridge.  Copyright (c) 1997-2010 University of Cambridge.
783  .fi  .fi

Legend:
Removed from v.386  
changed lines
  Added in v.570

  ViewVC Help
Powered by ViewVC 1.1.5