/[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 392 by ph10, Tue Mar 17 21:30:30 2009 UTC revision 541 by ph10, Mon Jun 14 15:19:33 2010 UTC
# 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 by one
223  match is retried. This imitates the way Perl handles such cases when using the  character, and the normal match is retried. This imitates the way Perl handles
224  \fB/g\fP modifier or the \fBsplit()\fP function.  such cases when using the \fB/g\fP modifier or the \fBsplit()\fP function.
225  .  .
226  .  .
227  .SS "Other modifiers"  .SS "Other modifiers"
# Line 236  also present, this data is replaced by s Line 242  also present, this data is replaced by s
242  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
243  for different internal link sizes.  for different internal link sizes.
244  .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  
245  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
246  \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.
247  .P  .P
# Line 263  available when the POSIX interface to PC Line 253  available when the POSIX interface to PC
253  \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
254  reloading compiled patterns below.  reloading compiled patterns below.
255  .P  .P
256  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
257  expression has been compiled, and the results used when the expression is  compiled pattern (whether it is anchored, has a fixed first character, and
258  matched.  so on). It does this by calling \fBpcre_fullinfo()\fP after compiling a
259    pattern. If the pattern is studied, the results of that are also output.
260    .P
261    The \fB/K\fP modifier requests \fBpcretest\fP to show names from backtracking
262    control verbs that are returned from calls to \fBpcre_exec()\fP. It causes
263    \fBpcretest\fP to create a \fBpcre_extra\fP block if one has not already been
264    created by a call to \fBpcre_study()\fP, and to set the PCRE_EXTRA_MARK flag
265    and the \fBmark\fP field within it, every time that \fBpcre_exec()\fP is
266    called. If the variable that the \fBmark\fP field points to is non-NULL for a
267    match, non-match, or partial match, \fBpcretest\fP prints the string to which
268    it points. For a match, this is shown on a line by itself, tagged with "MK:".
269    For a non-match it is added to the message.
270    .P
271    The \fB/L\fP modifier must be followed directly by the name of a locale, for
272    example,
273    .sp
274      /pattern/Lfr_FR
275    .sp
276    For this reason, it must be the last modifier. The given locale is set,
277    \fBpcre_maketables()\fP is called to build a set of character tables for the
278    locale, and this is then passed to \fBpcre_compile()\fP when compiling the
279    regular expression. Without an \fB/L\fP (or \fB/T\fP) modifier, NULL is passed
280    as the tables pointer; that is, \fB/L\fP applies only to the expression on
281    which it appears.
282  .P  .P
283  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
284  pattern to be output.  pattern to be output.
285  .P  .P
286    The \fB/S\fP modifier causes \fBpcre_study()\fP to be called after the
287    expression has been compiled, and the results used when the expression is
288    matched.
289    .P
290    The \fB/T\fP modifier must be followed by a single digit. It causes a specific
291    set of built-in character tables to be passed to \fBpcre_compile()\fP. It is
292    used in the standard PCRE tests to check behaviour with different character
293    tables. The digit specifies the tables as follows:
294    .sp
295      0   the default ASCII tables, as distributed in
296            pcre_chartables.c.dist
297      1   a set of tables defining ISO 8859 characters
298    .sp
299    In table 1, some characters whose codes are greater than 128 are identified as
300    letters, digits, spaces, etc.
301    .
302    .
303    .SS "Using the POSIX wrapper API"
304    .rs
305    .sp
306  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
307  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
308  \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:
309  present, and REG_NEWLINE is set if \fB/m\fP is present. The wrapper functions  .sp
310  force PCRE_DOLLAR_ENDONLY always, and PCRE_DOTALL unless REG_NEWLINE is set.    /i    REG_ICASE
311  .P    /m    REG_NEWLINE
312  The \fB/8\fP modifier causes \fBpcretest\fP to call PCRE with the PCRE_UTF8    /N    REG_NOSUB
313  option set. This turns on support for UTF-8 character handling in PCRE,    /s    REG_DOTALL     )
314  provided that it was compiled with this support enabled. This modifier also    /U    REG_UNGREEDY   ) These options are not part of
315  causes any non-printing characters in output strings to be printed using the    /W    REG_UCP        )   the POSIX standard
316  \ex{hh...} notation if they are valid UTF-8 sequences.    /8    REG_UTF8       )
317  .P  .sp
318  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
319  call \fBpcre_compile()\fP with the PCRE_NO_UTF8_CHECK option, to suppress the  ignored.
 checking of the string for UTF-8 validity.  
320  .  .
321  .  .
322  .SH "DATA LINES"  .SH "DATA LINES"
# Line 356  recognized: Line 388  recognized:
388                 MATCH_LIMIT_RECURSION settings                 MATCH_LIMIT_RECURSION settings
389  .\" JOIN  .\" JOIN
390    \eN         pass the PCRE_NOTEMPTY option to \fBpcre_exec()\fP    \eN         pass the PCRE_NOTEMPTY option to \fBpcre_exec()\fP
391                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP; if used twice, pass the
392                   PCRE_NOTEMPTY_ATSTART option
393  .\" JOIN  .\" JOIN
394    \eOdd       set the size of the output vector passed to    \eOdd       set the size of the output vector passed to
395                 \fBpcre_exec()\fP to dd (any number of digits)                 \fBpcre_exec()\fP to dd (any number of digits)
396  .\" JOIN  .\" JOIN
397    \eP         pass the PCRE_PARTIAL option to \fBpcre_exec()\fP    \eP         pass the PCRE_PARTIAL_SOFT option to \fBpcre_exec()\fP
398                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP; if used twice, pass the
399                   PCRE_PARTIAL_HARD option
400  .\" JOIN  .\" JOIN
401    \eQdd       set the PCRE_MATCH_LIMIT_RECURSION limit to dd    \eQdd       set the PCRE_MATCH_LIMIT_RECURSION limit to dd
402                 (any number of digits)                 (any number of digits)
403    \eR         pass the PCRE_DFA_RESTART option to \fBpcre_dfa_exec()\fP    \eR         pass the PCRE_DFA_RESTART option to \fBpcre_dfa_exec()\fP
404    \eS         output details of memory get/free calls during matching    \eS         output details of memory get/free calls during matching
405  .\" JOIN  .\" JOIN
406      \eY         pass the PCRE_NO_START_OPTIMIZE option to \fBpcre_exec()\fP
407                   or \fBpcre_dfa_exec()\fP
408    .\" JOIN
409    \eZ         pass the PCRE_NOTEOL option to \fBpcre_exec()\fP    \eZ         pass the PCRE_NOTEOL option to \fBpcre_exec()\fP
410                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP
411  .\" JOIN  .\" JOIN
# Line 419  by the \fB-O\fP command line option (or Line 456  by the \fB-O\fP command line option (or
456  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.
457  .P  .P
458  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
459  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,
460  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,
461  \fBregexec()\fP.  to be passed to \fBregexec()\fP.
462  .P  .P
463  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
464  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 497  This section describes the output when t
497  .P  .P
498  When a match succeeds, pcretest outputs the list of captured substrings that  When a match succeeds, pcretest outputs the list of captured substrings that
499  \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
500  the whole pattern. Otherwise, it outputs "No match" or "Partial match"  the whole pattern. Otherwise, it outputs "No match" when the return is
501  when \fBpcre_exec()\fP returns PCRE_ERROR_NOMATCH or PCRE_ERROR_PARTIAL,  PCRE_ERROR_NOMATCH, and "Partial match:" followed by the partially matching
502  respectively, and otherwise the PCRE negative error number. Here is an example  substring when \fBpcre_exec()\fP returns PCRE_ERROR_PARTIAL. For any other
503  of an interactive \fBpcretest\fP run.  returns, it outputs the PCRE negative error number. Here is an example of an
504    interactive \fBpcretest\fP run.
505  .sp  .sp
506    $ pcretest    $ pcretest
507    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 582  the subject where there is at least one
582     2: tan     2: tan
583  .sp  .sp
584  (Using the normal matching function on this data finds only "tang".) The  (Using the normal matching function on this data finds only "tang".) The
585  longest matching string is always given first (and numbered zero).  longest matching string is always given first (and numbered zero). After a
586    PCRE_ERROR_PARTIAL return, the output is "Partial match:", followed by the
587    partially matching substring.
588  .P  .P
589  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
590  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 763  Cambridge CB2 3QH, England.
763  .rs  .rs
764  .sp  .sp
765  .nf  .nf
766  Last updated: 10 March 2009  Last updated: 14 June 2010
767  Copyright (c) 1997-2009 University of Cambridge.  Copyright (c) 1997-2010 University of Cambridge.
768  .fi  .fi
Legend:
Removed from v.392  
changed lines
  Added in v.541
  ViewVC Help
Powered by ViewVC 1.1.5