/[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 227 by ph10, Tue Aug 21 15:00:15 2007 UTC revision 429 by ph10, Tue Sep 1 16:10:16 2009 UTC
# Line 40  OPTIONS Line 40  OPTIONS
40         -i        Behave as if each regex  has  the  /I  modifier;  information         -i        Behave as if each regex  has  the  /I  modifier;  information
41                   about the compiled pattern is given after compilation.                   about the compiled pattern is given after compilation.
42    
43         -m        Output  the  size  of each compiled pattern after it has been         -M        Behave  as if each data line contains the \M escape sequence;
44                   compiled. This is equivalent to adding  /M  to  each  regular                   this causes PCRE to  discover  the  minimum  MATCH_LIMIT  and
45                   expression.   For  compatibility  with  earlier  versions  of                   MATCH_LIMIT_RECURSION settings by calling pcre_exec() repeat-
46                     edly with different limits.
47    
48           -m        Output the size of each compiled pattern after  it  has  been
49                     compiled.  This  is  equivalent  to adding /M to each regular
50                     expression.  For  compatibility  with  earlier  versions   of
51                   pcretest, -s is a synonym for -m.                   pcretest, -s is a synonym for -m.
52    
53         -o osize  Set the number of elements in the output vector that is  used         -o osize  Set  the number of elements in the output vector that is used
54                   when  calling pcre_exec() or pcre_dfa_exec() to be osize. The                   when calling pcre_exec() or pcre_dfa_exec() to be osize.  The
55                   default value is 45, which is enough for 14 capturing  subex-                   default  value is 45, which is enough for 14 capturing subex-
56                   pressions   for  pcre_exec()  or  22  different  matches  for                   pressions  for  pcre_exec()  or  22  different  matches   for
57                   pcre_dfa_exec(). The vector size can be changed for  individ-                   pcre_dfa_exec().  The vector size can be changed for individ-
58                   ual  matching  calls  by  including  \O in the data line (see                   ual matching calls by including \O  in  the  data  line  (see
59                   below).                   below).
60    
61         -p        Behave as if each regex has the /P modifier; the POSIX  wrap-         -p        Behave  as if each regex has the /P modifier; the POSIX wrap-
62                   per  API  is used to call PCRE. None of the other options has                   per API is used to call PCRE. None of the other  options  has
63                   any effect when -p is set.                   any effect when -p is set.
64    
65         -q        Do not output the version number of pcretest at the start  of         -q        Do  not output the version number of pcretest at the start of
66                   execution.                   execution.
67    
68         -S size   On  Unix-like  systems,  set the size of the runtime stack to         -S size   On Unix-like systems, set the size of the  runtime  stack  to
69                   size megabytes.                   size megabytes.
70    
71         -t        Run each compile, study, and match many times with  a  timer,         -t        Run  each  compile, study, and match many times with a timer,
72                   and  output resulting time per compile or match (in millisec-                   and output resulting time per compile or match (in  millisec-
73                   onds). Do not set -m with -t, because you will then  get  the                   onds).  Do  not set -m with -t, because you will then get the
74                   size  output  a  zillion  times,  and the timing will be dis-                   size output a zillion times, and  the  timing  will  be  dis-
75                   torted. You can control the number  of  iterations  that  are                   torted.  You  can  control  the number of iterations that are
76                   used  for timing by following -t with a number (as a separate                   used for timing by following -t with a number (as a  separate
77                   item on the command line). For example, "-t 1000" would iter-                   item on the command line). For example, "-t 1000" would iter-
78                   ate 1000 times. The default is to iterate 500000 times.                   ate 1000 times. The default is to iterate 500000 times.
79    
# Line 78  OPTIONS Line 83  OPTIONS
83    
84  DESCRIPTION  DESCRIPTION
85    
86         If pcretest is given two filename arguments, it reads  from  the  first         If  pcretest  is  given two filename arguments, it reads from the first
87         and writes to the second. If it is given only one filename argument, it         and writes to the second. If it is given only one filename argument, it
88         reads from that file and writes to stdout.  Otherwise,  it  reads  from         reads  from  that  file  and writes to stdout. Otherwise, it reads from
89         stdin  and  writes to stdout, and prompts for each line of input, using         stdin and writes to stdout, and prompts for each line of  input,  using
90         "re>" to prompt for regular expressions, and "data>" to prompt for data         "re>" to prompt for regular expressions, and "data>" to prompt for data
91         lines.         lines.
92    
93           When pcretest is built, a configuration  option  can  specify  that  it
94           should  be  linked  with the libreadline library. When this is done, if
95           the input is from a terminal, it is read using the readline() function.
96           This  provides line-editing and history facilities. The output from the
97           -help option states whether or not readline() will be used.
98    
99         The program handles any number of sets of input on a single input file.         The program handles any number of sets of input on a single input file.
100         Each set starts with a regular expression, and continues with any  num-         Each  set starts with a regular expression, and continues with any num-
101         ber of data lines to be matched against the pattern.         ber of data lines to be matched against the pattern.
102    
103         Each  data line is matched separately and independently. If you want to         Each data line is matched separately and independently. If you want  to
104         do multi-line matches, you have to use the \n escape sequence (or \r or         do multi-line matches, you have to use the \n escape sequence (or \r or
105         \r\n, etc., depending on the newline setting) in a single line of input         \r\n, etc., depending on the newline setting) in a single line of input
106         to encode the newline sequences. There is no limit  on  the  length  of         to  encode  the  newline  sequences. There is no limit on the length of
107         data  lines;  the  input  buffer is automatically extended if it is too         data lines; the input buffer is automatically extended  if  it  is  too
108         small.         small.
109    
110         An empty line signals the end of the data lines, at which point  a  new         An  empty  line signals the end of the data lines, at which point a new
111         regular  expression is read. The regular expressions are given enclosed         regular expression is read. The regular expressions are given  enclosed
112         in any non-alphanumeric delimiters other than backslash, for example:         in any non-alphanumeric delimiters other than backslash, for example:
113    
114           /(a|bc)x+yz/           /(a|bc)x+yz/
115    
116         White space before the initial delimiter is ignored. A regular  expres-         White  space before the initial delimiter is ignored. A regular expres-
117         sion  may be continued over several input lines, in which case the new-         sion may be continued over several input lines, in which case the  new-
118         line characters are included within it. It is possible to  include  the         line  characters  are included within it. It is possible to include the
119         delimiter within the pattern by escaping it, for example         delimiter within the pattern by escaping it, for example
120    
121           /abc\/def/           /abc\/def/
122    
123         If  you  do  so, the escape and the delimiter form part of the pattern,         If you do so, the escape and the delimiter form part  of  the  pattern,
124         but since delimiters are always non-alphanumeric, this does not  affect         but  since delimiters are always non-alphanumeric, this does not affect
125         its  interpretation.   If the terminating delimiter is immediately fol-         its interpretation.  If the terminating delimiter is  immediately  fol-
126         lowed by a backslash, for example,         lowed by a backslash, for example,
127    
128           /abc/\           /abc/\
129    
130         then a backslash is added to the end of the pattern. This  is  done  to         then  a  backslash  is added to the end of the pattern. This is done to
131         provide  a  way of testing the error condition that arises if a pattern         provide a way of testing the error condition that arises if  a  pattern
132         finishes with a backslash, because         finishes with a backslash, because
133    
134           /abc\/           /abc\/
135    
136         is interpreted as the first line of a pattern that starts with  "abc/",         is  interpreted as the first line of a pattern that starts with "abc/",
137         causing pcretest to read the next line as a continuation of the regular         causing pcretest to read the next line as a continuation of the regular
138         expression.         expression.
139    
140    
141  PATTERN MODIFIERS  PATTERN MODIFIERS
142    
143         A pattern may be followed by any number of modifiers, which are  mostly         A  pattern may be followed by any number of modifiers, which are mostly
144         single  characters.  Following  Perl usage, these are referred to below         single characters. Following Perl usage, these are  referred  to  below
145         as, for example, "the /i modifier", even though the  delimiter  of  the         as,  for  example,  "the /i modifier", even though the delimiter of the
146         pattern  need  not always be a slash, and no slash is used when writing         pattern need not always be a slash, and no slash is used  when  writing
147         modifiers. Whitespace may appear between the  final  pattern  delimiter         modifiers.  Whitespace  may  appear between the final pattern delimiter
148         and the first modifier, and between the modifiers themselves.         and the first modifier, and between the modifiers themselves.
149    
150         The /i, /m, /s, and /x modifiers set the PCRE_CASELESS, PCRE_MULTILINE,         The /i, /m, /s, and /x modifiers set the PCRE_CASELESS, PCRE_MULTILINE,
151         PCRE_DOTALL, or PCRE_EXTENDED  options,  respectively,  when  pcre_com-         PCRE_DOTALL,  or  PCRE_EXTENDED  options,  respectively, when pcre_com-
152         pile()  is  called. These four modifier letters have the same effect as         pile() is called. These four modifier letters have the same  effect  as
153         they do in Perl. For example:         they do in Perl. For example:
154    
155           /caseless/i           /caseless/i
# Line 146  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           /A          PCRE_ANCHORED           /A              PCRE_ANCHORED
161           /C          PCRE_AUTO_CALLOUT           /C              PCRE_AUTO_CALLOUT
162           /E          PCRE_DOLLAR_ENDONLY           /E              PCRE_DOLLAR_ENDONLY
163           /f          PCRE_FIRSTLINE           /f              PCRE_FIRSTLINE
164           /J          PCRE_DUPNAMES           /J              PCRE_DUPNAMES
165           /N          PCRE_NO_AUTO_CAPTURE           /N              PCRE_NO_AUTO_CAPTURE
166           /U          PCRE_UNGREEDY           /U              PCRE_UNGREEDY
167           /X          PCRE_EXTRA           /X              PCRE_EXTRA
168           /<cr>       PCRE_NEWLINE_CR           /<JS>           PCRE_JAVASCRIPT_COMPAT
169           /<lf>       PCRE_NEWLINE_LF           /<cr>           PCRE_NEWLINE_CR
170           /<crlf>     PCRE_NEWLINE_CRLF           /<lf>           PCRE_NEWLINE_LF
171           /<anycrlf>  PCRE_NEWLINE_ANYCRLF           /<crlf>         PCRE_NEWLINE_CRLF
172           /<any>      PCRE_NEWLINE_ANY           /<anycrlf>      PCRE_NEWLINE_ANYCRLF
173             /<any>          PCRE_NEWLINE_ANY
174             /<bsr_anycrlf>  PCRE_BSR_ANYCRLF
175             /<bsr_unicode>  PCRE_BSR_UNICODE
176    
177         Those  specifying  line  ending sequences are literal strings as shown,         Those specifying line ending sequences are literal  strings  as  shown,
178         but the letters can be in either  case.  This  example  sets  multiline         but  the  letters  can  be  in either case. This example sets multiline
179         matching with CRLF as the line ending sequence:         matching with CRLF as the line ending sequence:
180    
181           /^abc/m<crlf>           /^abc/m<crlf>
182    
183         Details  of the meanings of these PCRE options are given in the pcreapi         Details of the meanings of these PCRE options are given in the  pcreapi
184         documentation.         documentation.
185    
186     Finding all matches in a string     Finding all matches in a string
187    
188         Searching for all possible matches within each subject  string  can  be         Searching  for  all  possible matches within each subject string can be
189         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
190         called again to search the remainder of the subject string. The differ-         called again to search the remainder of the subject string. The differ-
191         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
192         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
193         string  (which  is in effect what Perl does), whereas the latter passes         string (which is in effect what Perl does), whereas the  latter  passes
194         over a shortened substring. This makes a  difference  to  the  matching         over  a  shortened  substring.  This makes a difference to the matching
195         process if the pattern begins with a lookbehind assertion (including \b         process if the pattern begins with a lookbehind assertion (including \b
196         or \B).         or \B).
197    
198         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
199         string,  the next call is done with the PCRE_NOTEMPTY and PCRE_ANCHORED         string, the next call is done with the PCRE_NOTEMPTY and  PCRE_ANCHORED
200         flags set in order to search for another, non-empty, match at the  same         flags  set in order to search for another, non-empty, match at the same
201         point.   If  this  second  match fails, the start offset is advanced by         point.  If this second match fails, the start  offset  is  advanced  by
202         one, and the normal match is retried. This imitates the way  Perl  han-         one,  and  the normal match is retried. This imitates the way Perl han-
203         dles such cases when using the /g modifier or the split() function.         dles such cases when using the /g modifier or the split() function.
204    
205     Other modifiers     Other modifiers
# Line 236  PATTERN MODIFIERS Line 250  PATTERN MODIFIERS
250         The  /S  modifier causes pcre_study() to be called after the expression         The  /S  modifier causes pcre_study() to be called after the expression
251         has been compiled, and the results used when the expression is matched.         has been compiled, and the results used when the expression is matched.
252    
253         The  /M  modifier causes the size of memory block used to hold the com-         The /M modifier causes the size of memory block used to hold  the  com-
254         piled pattern to be output.         piled pattern to be output.
255    
256         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
257         rather  than  its  native  API.  When this is done, all other modifiers         rather than its native API. When this  is  done,  all  other  modifiers
258         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,
259         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
260         PCRE_DOLLAR_ENDONLY always, and PCRE_DOTALL unless REG_NEWLINE is  set.         PCRE_DOLLAR_ENDONLY always, and PCRE_DOTALL unless REG_NEWLINE is set.
261    
262         The  /8 modifier causes pcretest to call PCRE with the PCRE_UTF8 option         The  /8 modifier causes pcretest to call PCRE with the PCRE_UTF8 option
263         set. This turns on support for UTF-8 character handling in  PCRE,  pro-         set. This turns on support for UTF-8 character handling in  PCRE,  pro-
# Line 312  DATA LINES Line 326  DATA LINES
326                        or pcre_dfa_exec()                        or pcre_dfa_exec()
327           \Odd       set the size of the output vector passed to           \Odd       set the size of the output vector passed to
328                        pcre_exec() to dd (any number of digits)                        pcre_exec() to dd (any number of digits)
329           \P         pass the PCRE_PARTIAL option to pcre_exec()           \P         pass the PCRE_PARTIAL_SOFT option to pcre_exec()
330                        or pcre_dfa_exec()                        or pcre_dfa_exec(); if used twice, pass the
331                          PCRE_PARTIAL_HARD option
332           \Qdd       set the PCRE_MATCH_LIMIT_RECURSION limit to dd           \Qdd       set the PCRE_MATCH_LIMIT_RECURSION limit to dd
333                        (any number of digits)                        (any number of digits)
334           \R         pass the PCRE_DFA_RESTART option to pcre_dfa_exec()           \R         pass the PCRE_DFA_RESTART option to pcre_dfa_exec()
# Line 399  DEFAULT OUTPUT FROM PCRETEST Line 414  DEFAULT OUTPUT FROM PCRETEST
414         When a match succeeds, pcretest outputs the list of captured substrings         When a match succeeds, pcretest outputs the list of captured substrings
415         that  pcre_exec()  returns,  starting with number 0 for the string that         that  pcre_exec()  returns,  starting with number 0 for the string that
416         matched the whole pattern. Otherwise, it outputs "No match" or "Partial         matched the whole pattern. Otherwise, it outputs "No match" or "Partial
417         match"  when  pcre_exec() returns PCRE_ERROR_NOMATCH or PCRE_ERROR_PAR-         match:"  followed  by the partially matching substring when pcre_exec()
418         TIAL, respectively, and otherwise the PCRE negative error number.  Here         returns PCRE_ERROR_NOMATCH  or  PCRE_ERROR_PARTIAL,  respectively,  and
419         is an example of an interactive pcretest run.         otherwise  the  PCRE  negative  error  number. Here is an example of an
420           interactive pcretest run.
421    
422           $ pcretest           $ pcretest
423           PCRE version 7.0 30-Nov-2006           PCRE version 7.0 30-Nov-2006
# Line 413  DEFAULT OUTPUT FROM PCRETEST Line 429  DEFAULT OUTPUT FROM PCRETEST
429           data> xyz           data> xyz
430           No match           No match
431    
432           Note that unset capturing substrings that are not followed by one  that
433           is  set are not returned by pcre_exec(), and are not shown by pcretest.
434           In the following example, there are two capturing substrings, but  when
435           the  first  data  line  is  matched, the second, unset substring is not
436           shown. An "internal" unset substring is shown as "<unset>", as for  the
437           second data line.
438    
439               re> /(a)|(b)/
440             data> a
441              0: a
442              1: a
443             data> b
444              0: b
445              1: <unset>
446              2: b
447    
448         If  the strings contain any non-printing characters, they are output as         If  the strings contain any non-printing characters, they are output as
449         \0x escapes, or as \x{...} escapes if the /8 modifier  was  present  on         \0x escapes, or as \x{...} escapes if the /8 modifier  was  present  on
450         the  pattern.  See below for the definition of non-printing characters.         the  pattern.  See below for the definition of non-printing characters.
# Line 467  OUTPUT FROM THE ALTERNATIVE MATCHING FUN Line 499  OUTPUT FROM THE ALTERNATIVE MATCHING FUN
499    
500         (Using the normal matching function on this data  finds  only  "tang".)         (Using the normal matching function on this data  finds  only  "tang".)
501         The  longest matching string is always given first (and numbered zero).         The  longest matching string is always given first (and numbered zero).
502           After a PCRE_ERROR_PARTIAL return, the output is "Partial match:", fol-
503           lowed by the partially matching substring.
504    
505         If /g is present on the pattern, the search for further matches resumes         If /g is present on the pattern, the search for further matches resumes
506         at the end of the longest match. For example:         at the end of the longest match. For example:
# Line 480  OUTPUT FROM THE ALTERNATIVE MATCHING FUN Line 514  OUTPUT FROM THE ALTERNATIVE MATCHING FUN
514            1: tan            1: tan
515            0: tan            0: tan
516    
517         Since  the  matching  function  does not support substring capture, the         Since the matching function does not  support  substring  capture,  the
518         escape sequences that are concerned with captured  substrings  are  not         escape  sequences  that  are concerned with captured substrings are not
519         relevant.         relevant.
520    
521    
522  RESTARTING AFTER A PARTIAL MATCH  RESTARTING AFTER A PARTIAL MATCH
523    
524         When the alternative matching function has given the PCRE_ERROR_PARTIAL         When the alternative matching function has given the PCRE_ERROR_PARTIAL
525         return, indicating that the subject partially matched the pattern,  you         return,  indicating that the subject partially matched the pattern, you
526         can  restart  the match with additional subject data by means of the \R         can restart the match with additional subject data by means of  the  \R
527         escape sequence. For example:         escape sequence. For example:
528    
529             re> /^\d?\d(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)\d\d$/             re> /^\d?\d(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)\d\d$/
# Line 498  RESTARTING AFTER A PARTIAL MATCH Line 532  RESTARTING AFTER A PARTIAL MATCH
532           data> n05\R\D           data> n05\R\D
533            0: n05            0: n05
534    
535         For further information about partial  matching,  see  the  pcrepartial         For  further  information  about  partial matching, see the pcrepartial
536         documentation.         documentation.
537    
538    
539  CALLOUTS  CALLOUTS
540    
541         If  the pattern contains any callout requests, pcretest's callout func-         If the pattern contains any callout requests, pcretest's callout  func-
542         tion is called during matching. This works  with  both  matching  func-         tion  is  called  during  matching. This works with both matching func-
543         tions. By default, the called function displays the callout number, the         tions. By default, the called function displays the callout number, the
544         start and current positions in the text at the callout  time,  and  the         start  and  current  positions in the text at the callout time, and the
545         next pattern item to be tested. For example, the output         next pattern item to be tested. For example, the output
546    
547           --->pqrabcdef           --->pqrabcdef
548             0    ^  ^     \d             0    ^  ^     \d
549    
550         indicates  that  callout number 0 occurred for a match attempt starting         indicates that callout number 0 occurred for a match  attempt  starting
551         at the fourth character of the subject string, when the pointer was  at         at  the fourth character of the subject string, when the pointer was at
552         the  seventh  character of the data, and when the next pattern item was         the seventh character of the data, and when the next pattern  item  was
553         \d. Just one circumflex is output if the start  and  current  positions         \d.  Just  one  circumflex is output if the start and current positions
554         are the same.         are the same.
555    
556         Callouts numbered 255 are assumed to be automatic callouts, inserted as         Callouts numbered 255 are assumed to be automatic callouts, inserted as
557         a result of the /C pattern modifier. In this case, instead  of  showing         a  result  of the /C pattern modifier. In this case, instead of showing
558         the  callout  number, the offset in the pattern, preceded by a plus, is         the callout number, the offset in the pattern, preceded by a  plus,  is
559         output. For example:         output. For example:
560    
561             re> /\d?[A-E]\*/C             re> /\d?[A-E]\*/C
# Line 533  CALLOUTS Line 567  CALLOUTS
567           +10 ^ ^           +10 ^ ^
568            0: E*            0: E*
569    
570         The callout function in pcretest returns zero (carry  on  matching)  by         The  callout  function  in pcretest returns zero (carry on matching) by
571         default,  but you can use a \C item in a data line (as described above)         default, but you can use a \C item in a data line (as described  above)
572         to change this.         to change this.
573    
574         Inserting callouts can be helpful when using pcretest to check  compli-         Inserting  callouts can be helpful when using pcretest to check compli-
575         cated  regular expressions. For further information about callouts, see         cated regular expressions. For further information about callouts,  see
576         the pcrecallout documentation.         the pcrecallout documentation.
577    
578    
579  NON-PRINTING CHARACTERS  NON-PRINTING CHARACTERS
580    
581         When pcretest is outputting text in the compiled version of a  pattern,         When  pcretest is outputting text in the compiled version of a pattern,
582         bytes  other  than 32-126 are always treated as non-printing characters         bytes other than 32-126 are always treated as  non-printing  characters
583         are are therefore shown as hex escapes.         are are therefore shown as hex escapes.
584    
585         When pcretest is outputting text that is a matched part  of  a  subject         When  pcretest  is  outputting text that is a matched part of a subject
586         string,  it behaves in the same way, unless a different locale has been         string, it behaves in the same way, unless a different locale has  been
587         set for the  pattern  (using  the  /L  modifier).  In  this  case,  the         set  for  the  pattern  (using  the  /L  modifier).  In  this case, the
588         isprint() function to distinguish printing and non-printing characters.         isprint() function to distinguish printing and non-printing characters.
589    
590    
# Line 625  AUTHOR Line 659  AUTHOR
659    
660  REVISION  REVISION
661    
662         Last updated: 21 August 2007         Last updated: 29 August 2009
663         Copyright (c) 1997-2007 University of Cambridge.         Copyright (c) 1997-2009 University of Cambridge.
Legend:
Removed from v.227  
changed lines
  Added in v.429
webmaster@exim.org
 ViewVC Help
Powered by ViewVC 1.1.12