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

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

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

revision 429 by ph10, Tue Sep 1 16:10:16 2009 UTC revision 518 by ph10, Tue May 18 15:47:01 2010 UTC
# Line 157  PATTERN MODIFIERS Line 157  PATTERN MODIFIERS
157         The following table shows additional modifiers for setting PCRE options         The following table shows additional modifiers for setting PCRE options
158         that do not correspond to anything in Perl:         that do not correspond to anything in Perl:
159    
160             /8              PCRE_UTF8
161             /?              PCRE_NO_UTF8_CHECK
162           /A              PCRE_ANCHORED           /A              PCRE_ANCHORED
163           /C              PCRE_AUTO_CALLOUT           /C              PCRE_AUTO_CALLOUT
164           /E              PCRE_DOLLAR_ENDONLY           /E              PCRE_DOLLAR_ENDONLY
# Line 164  PATTERN MODIFIERS Line 166  PATTERN MODIFIERS
166           /J              PCRE_DUPNAMES           /J              PCRE_DUPNAMES
167           /N              PCRE_NO_AUTO_CAPTURE           /N              PCRE_NO_AUTO_CAPTURE
168           /U              PCRE_UNGREEDY           /U              PCRE_UNGREEDY
169             /W              PCRE_UCP
170           /X              PCRE_EXTRA           /X              PCRE_EXTRA
171           /<JS>           PCRE_JAVASCRIPT_COMPAT           /<JS>           PCRE_JAVASCRIPT_COMPAT
172           /<cr>           PCRE_NEWLINE_CR           /<cr>           PCRE_NEWLINE_CR
# Line 174  PATTERN MODIFIERS Line 177  PATTERN MODIFIERS
177           /<bsr_anycrlf>  PCRE_BSR_ANYCRLF           /<bsr_anycrlf>  PCRE_BSR_ANYCRLF
178           /<bsr_unicode>  PCRE_BSR_UNICODE           /<bsr_unicode>  PCRE_BSR_UNICODE
179    
180         Those specifying line ending sequences are literal  strings  as  shown,         The modifiers that are enclosed in angle brackets are  literal  strings
181         but  the  letters  can  be  in either case. This example sets multiline         as  shown,  including  the  angle  brackets,  but the letters can be in
182         matching with CRLF as the line ending sequence:         either case. This example sets multiline matching with CRLF as the line
183           ending sequence:
184    
185           /^abc/m<crlf>           /^abc/m<crlf>
186    
187         Details of the meanings of these PCRE options are given in the  pcreapi         As well as turning on the PCRE_UTF8 option, the /8 modifier also causes
188         documentation.         any non-printing characters in output strings to be printed  using  the
189           \x{hh...}  notation  if they are valid UTF-8 sequences. Full details of
190           the PCRE options are given in the pcreapi documentation.
191    
192     Finding all matches in a string     Finding all matches in a string
193    
194         Searching  for  all  possible matches within each subject string can be         Searching for all possible matches within each subject  string  can  be
195         requested by the /g or /G modifier. After  finding  a  match,  PCRE  is         requested  by  the  /g  or  /G modifier. After finding a match, PCRE is
196         called again to search the remainder of the subject string. The differ-         called again to search the remainder of the subject string. The differ-
197         ence between /g and /G is that the former uses the startoffset argument         ence between /g and /G is that the former uses the startoffset argument
198         to  pcre_exec()  to  start  searching  at a new point within the entire         to pcre_exec() to start searching at a  new  point  within  the  entire
199         string (which is in effect what Perl does), whereas the  latter  passes         string  (which  is in effect what Perl does), whereas the latter passes
200         over  a  shortened  substring.  This makes a difference to the matching         over a shortened substring. This makes a  difference  to  the  matching
201         process if the pattern begins with a lookbehind assertion (including \b         process if the pattern begins with a lookbehind assertion (including \b
202         or \B).         or \B).
203    
204         If  any  call  to  pcre_exec()  in a /g or /G sequence matches an empty         If any call to pcre_exec() in a /g or  /G  sequence  matches  an  empty
205         string, the next call is done with the PCRE_NOTEMPTY and  PCRE_ANCHORED         string,  the  next  call  is  done  with  the PCRE_NOTEMPTY_ATSTART and
206         flags  set in order to search for another, non-empty, match at the same         PCRE_ANCHORED flags set in order  to  search  for  another,  non-empty,
207         point.  If this second match fails, the start  offset  is  advanced  by         match  at  the same point. If this second match fails, the start offset
208         one,  and  the normal match is retried. This imitates the way Perl han-         is advanced by one character, and the normal  match  is  retried.  This
209         dles such cases when using the /g modifier or the split() function.         imitates  the way Perl handles such cases when using the /g modifier or
210           the split() function.
211    
212     Other modifiers     Other modifiers
213    
# Line 218  PATTERN MODIFIERS Line 225  PATTERN MODIFIERS
225         feature for use in the automatic test scripts; it ensures that the same         feature for use in the automatic test scripts; it ensures that the same
226         output is generated for different internal link sizes.         output is generated for different internal link sizes.
227    
        The /L modifier must be followed directly by the name of a locale,  for  
        example,  
   
          /pattern/Lfr_FR  
   
        For this reason, it must be the last modifier. The given locale is set,  
        pcre_maketables() is called to build a set of character tables for  the  
        locale,  and  this  is then passed to pcre_compile() when compiling the  
        regular expression. Without an /L  modifier,  NULL  is  passed  as  the  
        tables  pointer; that is, /L applies only to the expression on which it  
        appears.  
   
        The /I modifier requests that pcretest  output  information  about  the  
        compiled  pattern (whether it is anchored, has a fixed first character,  
        and so on). It does this by calling pcre_fullinfo() after  compiling  a  
        pattern.  If  the pattern is studied, the results of that are also out-  
        put.  
   
228         The /D modifier is a PCRE debugging feature, and is equivalent to  /BI,         The /D modifier is a PCRE debugging feature, and is equivalent to  /BI,
229         that is, both the /B and the /I modifiers.         that is, both the /B and the /I modifiers.
230    
# Line 247  PATTERN MODIFIERS Line 236  PATTERN MODIFIERS
236         used, that is, when the /P pattern modifier is specified. See also  the         used, that is, when the /P pattern modifier is specified. See also  the
237         section about saving and reloading compiled patterns below.         section about saving and reloading compiled patterns below.
238    
239         The  /S  modifier causes pcre_study() to be called after the expression         The  /I  modifier  requests  that pcretest output information about the
240         has been compiled, and the results used when the expression is matched.         compiled pattern (whether it is anchored, has a fixed first  character,
241           and  so  on). It does this by calling pcre_fullinfo() after compiling a
242           pattern. If the pattern is studied, the results of that are  also  out-
243           put.
244    
245         The /M modifier causes the size of memory block used to hold  the  com-         The  /K modifier requests pcretest to show names from backtracking con-
246           trol verbs that are returned  from  calls  to  pcre_exec().  It  causes
247           pcretest  to create a pcre_extra block if one has not already been cre-
248           ated by a call to pcre_study(), and to set the PCRE_EXTRA_MARK flag and
249           the mark field within it, every time that pcre_exec() is called. If the
250           variable that the mark field points to is non-NULL for  a  match,  non-
251           match, or partial match, pcretest prints the string to which it points.
252           For a match, this is shown on a line by itself, tagged with "MK:".  For
253           a non-match it is added to the message.
254    
255           The  /L modifier must be followed directly by the name of a locale, for
256           example,
257    
258             /pattern/Lfr_FR
259    
260           For this reason, it must be the last modifier. The given locale is set,
261           pcre_maketables()  is called to build a set of character tables for the
262           locale, and this is then passed to pcre_compile()  when  compiling  the
263           regular  expression.  Without  an  /L  modifier,  NULL is passed as the
264           tables pointer; that is, /L applies only to the expression on which  it
265           appears.
266    
267           The  /M  modifier causes the size of memory block used to hold the com-
268         piled pattern to be output.         piled pattern to be output.
269    
270         The  /P modifier causes pcretest to call PCRE via the POSIX wrapper API         The /P modifier causes pcretest to call PCRE via the POSIX wrapper  API
271         rather than its native API. When this  is  done,  all  other  modifiers         rather  than  its  native  API.  When this is done, all other modifiers
272         except  /i,  /m, and /+ are ignored. REG_ICASE is set if /i is present,         except /i, /m, and /+ are ignored. REG_ICASE is set if /i  is  present,
273         and REG_NEWLINE is set if /m is present. The  wrapper  functions  force         and  REG_NEWLINE  is  set if /m is present. The wrapper functions force
274         PCRE_DOLLAR_ENDONLY always, and PCRE_DOTALL unless REG_NEWLINE is set.         PCRE_DOLLAR_ENDONLY always, and PCRE_DOTALL unless REG_NEWLINE is set.
275    
276         The  /8 modifier causes pcretest to call PCRE with the PCRE_UTF8 option         The /S modifier causes pcre_study() to be called after  the  expression
277         set. This turns on support for UTF-8 character handling in  PCRE,  pro-         has been compiled, and the results used when the expression is matched.
        vided  that  it  was  compiled with this support enabled. This modifier  
        also causes any non-printing characters in output strings to be printed  
        using the \x{hh...} notation if they are valid UTF-8 sequences.  
   
        If  the  /?  modifier  is  used  with  /8,  it  causes pcretest to call  
        pcre_compile() with the  PCRE_NO_UTF8_CHECK  option,  to  suppress  the  
        checking of the string for UTF-8 validity.  
278    
279    
280  DATA LINES  DATA LINES
# Line 323  DATA LINES Line 330  DATA LINES
330           \M         discover the minimum MATCH_LIMIT and           \M         discover the minimum MATCH_LIMIT and
331                        MATCH_LIMIT_RECURSION settings                        MATCH_LIMIT_RECURSION settings
332           \N         pass the PCRE_NOTEMPTY option to pcre_exec()           \N         pass the PCRE_NOTEMPTY option to pcre_exec()
333                        or pcre_dfa_exec()                        or pcre_dfa_exec(); if used twice, pass the
334                          PCRE_NOTEMPTY_ATSTART option
335           \Odd       set the size of the output vector passed to           \Odd       set the size of the output vector passed to
336                        pcre_exec() to dd (any number of digits)                        pcre_exec() to dd (any number of digits)
337           \P         pass the PCRE_PARTIAL_SOFT option to pcre_exec()           \P         pass the PCRE_PARTIAL_SOFT option to pcre_exec()
# Line 333  DATA LINES Line 341  DATA LINES
341                        (any number of digits)                        (any number of digits)
342           \R         pass the PCRE_DFA_RESTART option to pcre_dfa_exec()           \R         pass the PCRE_DFA_RESTART option to pcre_dfa_exec()
343           \S         output details of memory get/free calls during matching           \S         output details of memory get/free calls during matching
344             \Y         pass the PCRE_NO_START_OPTIMIZE option to pcre_exec()
345                          or pcre_dfa_exec()
346           \Z         pass the PCRE_NOTEOL option to pcre_exec()           \Z         pass the PCRE_NOTEOL option to pcre_exec()
347                        or pcre_dfa_exec()                        or pcre_dfa_exec()
348           \?         pass the PCRE_NO_UTF8_CHECK option to           \?         pass the PCRE_NO_UTF8_CHECK option to
# Line 413  DEFAULT OUTPUT FROM PCRETEST Line 423  DEFAULT OUTPUT FROM PCRETEST
423    
424         When a match succeeds, pcretest outputs the list of captured substrings         When a match succeeds, pcretest outputs the list of captured substrings
425         that  pcre_exec()  returns,  starting with number 0 for the string that         that  pcre_exec()  returns,  starting with number 0 for the string that
426         matched the whole pattern. Otherwise, it outputs "No match" or "Partial         matched the whole pattern. Otherwise, it outputs "No  match"  when  the
427         match:"  followed  by the partially matching substring when pcre_exec()         return is PCRE_ERROR_NOMATCH, and "Partial match:" followed by the par-
428         returns PCRE_ERROR_NOMATCH  or  PCRE_ERROR_PARTIAL,  respectively,  and         tially matching substring when pcre_exec() returns  PCRE_ERROR_PARTIAL.
429         otherwise  the  PCRE  negative  error  number. Here is an example of an         For  any other returns, it outputs the PCRE negative error number. Here
430         interactive pcretest run.         is an example of an interactive pcretest run.
431    
432           $ pcretest           $ pcretest
433           PCRE version 7.0 30-Nov-2006           PCRE version 7.0 30-Nov-2006
# Line 659  AUTHOR Line 669  AUTHOR
669    
670  REVISION  REVISION
671    
672         Last updated: 29 August 2009         Last updated: 12 May 2010
673         Copyright (c) 1997-2009 University of Cambridge.         Copyright (c) 1997-2010 University of Cambridge.

Legend:
Removed from v.429  
changed lines
  Added in v.518

  ViewVC Help
Powered by ViewVC 1.1.5