/[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 71 by nigel, Sat Feb 24 21:40:24 2007 UTC revision 231 by ph10, Tue Sep 11 11:15:33 2007 UTC
# Line 1  Line 1 
1    PCRETEST(1)                                                        PCRETEST(1)
2    
3    
4  NAME  NAME
5       pcretest - a program  for  testing  Perl-compatible  regular         pcretest - a program for testing Perl-compatible regular expressions.
      expressions.  
6    
7    
8  SYNOPSIS  SYNOPSIS
      pcretest [-d] [-i] [-m] [-o osize] [-p] [-t] [source]  [des-  
      tination]  
9    
10       pcretest was written as a test program for the PCRE  regular         pcretest [options] [source] [destination]
11       expression  library  itself,  but  it  can  also be used for  
12       experimenting  with  regular  expressions.   This   document         pcretest  was written as a test program for the PCRE regular expression
13       describes  the  features of the test program; for details of         library itself, but it can also be used for experimenting with  regular
14       the regular  expressions  themselves,  see  the  pcrepattern         expressions.  This document describes the features of the test program;
15       documentation.  For details of PCRE and its options, see the         for details of the regular expressions themselves, see the  pcrepattern
16       pcreapi documentation.         documentation. For details of the PCRE library function calls and their
17           options, see the pcreapi documentation.
18    
19    
20  OPTIONS  OPTIONS
21    
22           -b        Behave as if each regex has the /B (show bytecode)  modifier;
23                     the internal form is output after compilation.
24    
25       -C        Output the version number of the PCRE library, and         -C        Output the version number of the PCRE library, and all avail-
26                 all   available  information  about  the  optional                   able  information  about  the  optional  features  that   are
27                 features that are included, and then exit.                   included, and then exit.
28    
29       -d        Behave as if each regex had the /D  modifier  (see         -d        Behave  as  if  each  regex  has the /D (debug) modifier; the
30                 below); the internal form is output after compila-                   internal form and information about the compiled  pattern  is
31                 tion.                   output after compilation; -d is equivalent to -b -i.
32    
33       -i        Behave as if  each  regex  had  the  /I  modifier;         -dfa      Behave  as if each data line contains the \D escape sequence;
34                 information  about  the  compiled pattern is given                   this    causes    the    alternative    matching    function,
35                 after compilation.                   pcre_dfa_exec(),   to   be   used  instead  of  the  standard
36                     pcre_exec() function (more detail is given below).
37       -m        Output the size of each compiled pattern after  it  
38                 has been compiled. This is equivalent to adding /M         -help     Output a brief summary these options and then exit.
39                 to each regular expression. For compatibility with  
40                 earlier  versions of pcretest, -s is a synonym for         -i        Behave as if each regex  has  the  /I  modifier;  information
41                 -m.                   about the compiled pattern is given after compilation.
42    
43       -o osize  Set the number of elements in  the  output  vector         -m        Output  the  size  of each compiled pattern after it has been
44                 that  is  used  when calling PCRE to be osize. The                   compiled. This is equivalent to adding  /M  to  each  regular
45                 default value is 45, which is enough for  14  cap-                   expression.   For  compatibility  with  earlier  versions  of
46                 turing  subexpressions.  The  vector  size  can be                   pcretest, -s is a synonym for -m.
47                 changed for individual matching calls by including  
48                 \O in the data line (see below).         -o osize  Set the number of elements in the output vector that is  used
49                     when  calling pcre_exec() or pcre_dfa_exec() to be osize. The
50       -p        Behave as if each regex has /P modifier; the POSIX                   default value is 45, which is enough for 14 capturing  subex-
51                 wrapper  API  is  used  to  call PCRE. None of the                   pressions   for  pcre_exec()  or  22  different  matches  for
52                 other options has any effect when -p is set.                   pcre_dfa_exec(). The vector size can be changed for  individ-
53                     ual  matching  calls  by  including  \O in the data line (see
54       -t        Run each compile, study, and match many times with                   below).
55                 a  timer, and output resulting time per compile or  
56                 match (in milliseconds). Do not set  -t  with  -m,         -p        Behave as if each regex has the /P modifier; the POSIX  wrap-
57                 because  you  will  then get the size output 20000                   per  API  is used to call PCRE. None of the other options has
58                 times and the timing will be distorted.                   any effect when -p is set.
59    
60           -q        Do not output the version number of pcretest at the start  of
61                     execution.
62    
63           -S size   On  Unix-like  systems,  set the size of the runtime stack to
64                     size megabytes.
65    
66           -t        Run each compile, study, and match many times with  a  timer,
67                     and  output resulting time per compile or match (in millisec-
68                     onds). Do not set -m with -t, because you will then  get  the
69                     size  output  a  zillion  times,  and the timing will be dis-
70                     torted. You can control the number  of  iterations  that  are
71                     used  for timing by following -t with a number (as a separate
72                     item on the command line). For example, "-t 1000" would iter-
73                     ate 1000 times. The default is to iterate 500000 times.
74    
75           -tm       This is like -t except that it times only the matching phase,
76                     not the compile or study phases.
77    
78    
79  DESCRIPTION  DESCRIPTION
80    
81       If pcretest is given two filename arguments, it  reads  from         If pcretest is given two filename arguments, it reads  from  the  first
82       the  first and writes to the second. If it is given only one         and writes to the second. If it is given only one filename argument, it
83       filename argument, it reads from that  file  and  writes  to         reads from that file and writes to stdout.  Otherwise,  it  reads  from
84       stdout. Otherwise, it reads from stdin and writes to stdout,         stdin  and  writes to stdout, and prompts for each line of input, using
85       and prompts for each line of input, using  "re>"  to  prompt         "re>" to prompt for regular expressions, and "data>" to prompt for data
86       for  regular  expressions,  and  "data>"  to prompt for data         lines.
87       lines.  
88           The program handles any number of sets of input on a single input file.
89       The program handles any number of sets of input on a  single         Each set starts with a regular expression, and continues with any  num-
90       input  file.  Each set starts with a regular expression, and         ber of data lines to be matched against the pattern.
91       continues with any  number  of  data  lines  to  be  matched  
92       against the pattern.         Each  data line is matched separately and independently. If you want to
93           do multi-line matches, you have to use the \n escape sequence (or \r or
94       Each line is matched separately and  independently.  If  you         \r\n, etc., depending on the newline setting) in a single line of input
95       want  to  do  multiple-line  matches, you have to use the \n         to encode the newline sequences. There is no limit  on  the  length  of
96       escape sequence in a single line of input to encode the new-         data  lines;  the  input  buffer is automatically extended if it is too
97       line  characters.  The maximum length of data line is 30,000         small.
98       characters.  
99           An empty line signals the end of the data lines, at which point  a  new
100       An empty line signals the end of the data  lines,  at  which         regular  expression is read. The regular expressions are given enclosed
101       point  a new regular expression is read. The regular expres-         in any non-alphanumeric delimiters other than backslash, for example:
102       sions are given enclosed in  any  non-alphameric  delimiters  
103       other than backslash, for example           /(a|bc)x+yz/
104    
105         /(a|bc)x+yz/         White space before the initial delimiter is ignored. A regular  expres-
106           sion  may be continued over several input lines, in which case the new-
107       White space before the initial delimiter is ignored. A regu-         line characters are included within it. It is possible to  include  the
108       lar expression may be continued over several input lines, in         delimiter within the pattern by escaping it, for example
109       which case the newline characters are included within it. It  
110       is  possible  to include the delimiter within the pattern by           /abc\/def/
111       escaping it, for example  
112           If  you  do  so, the escape and the delimiter form part of the pattern,
113         /abc\/def/         but since delimiters are always non-alphanumeric, this does not  affect
114           its  interpretation.   If the terminating delimiter is immediately fol-
115       If you do so, the escape and the delimiter form part of  the         lowed by a backslash, for example,
116       pattern,  but  since  delimiters  are always non-alphameric,  
117       this does not affect its interpretation.  If the terminating           /abc/\
118       delimiter  is immediately followed by a backslash, for exam-  
119       ple,         then a backslash is added to the end of the pattern. This  is  done  to
120           provide  a  way of testing the error condition that arises if a pattern
121         /abc/\         finishes with a backslash, because
122    
123       then a backslash is added to the end of the pattern. This is           /abc\/
124       done  to  provide  a way of testing the error condition that  
125       arises if a pattern finishes with a backslash, because         is interpreted as the first line of a pattern that starts with  "abc/",
126           causing pcretest to read the next line as a continuation of the regular
127         /abc\/         expression.
   
      is interpreted as the first line of a  pattern  that  starts  
      with  "abc/",  causing  pcretest  to read the next line as a  
      continuation of the regular expression.  
128    
129    
130  PATTERN MODIFIERS  PATTERN MODIFIERS
131    
132       The pattern may be followed by i, m, s,  or  x  to  set  the         A pattern may be followed by any number of modifiers, which are  mostly
133       PCRE_CASELESS, PCRE_MULTILINE, PCRE_DOTALL, or PCRE_EXTENDED         single  characters.  Following  Perl usage, these are referred to below
134       options, respectively. For example:         as, for example, "the /i modifier", even though the  delimiter  of  the
135           pattern  need  not always be a slash, and no slash is used when writing
136         /caseless/i         modifiers. Whitespace may appear between the  final  pattern  delimiter
137           and the first modifier, and between the modifiers themselves.
138       These modifier letters have the same effect as  they  do  in  
139       Perl.  There  are  others  that set PCRE options that do not         The /i, /m, /s, and /x modifiers set the PCRE_CASELESS, PCRE_MULTILINE,
140       correspond to anything in Perl:  /A, /E, /N, /U, and /X  set         PCRE_DOTALL, or PCRE_EXTENDED  options,  respectively,  when  pcre_com-
141       PCRE_ANCHORED,   PCRE_DOLLAR_ENDONLY,  PCRE_NO_AUTO_CAPTURE,         pile()  is  called. These four modifier letters have the same effect as
142       PCRE_UNGREEDY, and PCRE_EXTRA respectively.         they do in Perl. For example:
143    
144       Searching for  all  possible  matches  within  each  subject           /caseless/i
145       string  can  be  requested  by  the /g or /G modifier. After  
146       finding  a  match,  PCRE  is  called  again  to  search  the         The following table shows additional modifiers for setting PCRE options
147       remainder  of  the subject string. The difference between /g         that do not correspond to anything in Perl:
148       and /G is that the former uses the startoffset  argument  to  
149       pcre_exec()  to  start  searching  at a new point within the           /A              PCRE_ANCHORED
150       entire string (which is in effect what Perl  does),  whereas           /C              PCRE_AUTO_CALLOUT
151       the  latter  passes over a shortened substring. This makes a           /E              PCRE_DOLLAR_ENDONLY
152       difference to the matching process  if  the  pattern  begins           /f              PCRE_FIRSTLINE
153       with a lookbehind assertion (including \b or \B).           /J              PCRE_DUPNAMES
154             /N              PCRE_NO_AUTO_CAPTURE
155       If any call to pcre_exec() in a /g or /G sequence matches an           /U              PCRE_UNGREEDY
156       empty  string,  the next call is done with the PCRE_NOTEMPTY           /X              PCRE_EXTRA
157       and PCRE_ANCHORED flags set in order to search for  another,           /<cr>           PCRE_NEWLINE_CR
158       non-empty,  match  at  the same point.  If this second match           /<lf>           PCRE_NEWLINE_LF
159       fails, the start offset is advanced by one, and  the  normal           /<crlf>         PCRE_NEWLINE_CRLF
160       match  is  retried.  This imitates the way Perl handles such           /<anycrlf>      PCRE_NEWLINE_ANYCRLF
161       cases when using the /g modifier or the split() function.           /<any>          PCRE_NEWLINE_ANY
162             /<bsr_anycrlf>  PCRE_BSR_ANYCRLF
163       There are a number of other modifiers  for  controlling  the           /<bsr_unicode>  PCRE_BSR_UNICODE
164       way pcretest operates.  
165           Those  specifying  line  ending sequences are literal strings as shown,
166       The /+ modifier requests that as well as outputting the sub-         but the letters can be in either  case.  This  example  sets  multiline
167       string  that  matched the entire pattern, pcretest should in         matching with CRLF as the line ending sequence:
168       addition output the remainder of the subject string. This is  
169       useful  for tests where the subject contains multiple copies           /^abc/m<crlf>
170       of the same substring.  
171           Details  of the meanings of these PCRE options are given in the pcreapi
172       The /L modifier must be followed directly by the name  of  a         documentation.
173       locale, for example,  
174       Finding all matches in a string
175         /pattern/Lfr  
176           Searching for all possible matches within each subject  string  can  be
177       For this reason, it must be the last  modifier  letter.  The         requested  by  the  /g  or  /G modifier. After finding a match, PCRE is
178       given  locale is set, pcre_maketables() is called to build a         called again to search the remainder of the subject string. The differ-
179       set of character tables for the locale,  and  this  is  then         ence between /g and /G is that the former uses the startoffset argument
180       passed  to pcre_compile() when compiling the regular expres-         to pcre_exec() to start searching at a  new  point  within  the  entire
181       sion. Without an /L modifier, NULL is passed as  the  tables         string  (which  is in effect what Perl does), whereas the latter passes
182       pointer; that is, /L applies only to the expression on which         over a shortened substring. This makes a  difference  to  the  matching
183       it appears.         process if the pattern begins with a lookbehind assertion (including \b
184           or \B).
185       The /I modifier requests that  pcretest  output  information  
186       about the compiled expression (whether it is anchored, has a         If any call to pcre_exec() in a /g or  /G  sequence  matches  an  empty
187       fixed first character, and so on). It does this  by  calling         string,  the next call is done with the PCRE_NOTEMPTY and PCRE_ANCHORED
188       pcre_fullinfo()  after  compiling an expression, and output-         flags set in order to search for another, non-empty, match at the  same
189       ting the information it gets back. If the  pattern  is  stu-         point.   If  this  second  match fails, the start offset is advanced by
190       died, the results of that are also output.         one, and the normal match is retried. This imitates the way  Perl  han-
191           dles such cases when using the /g modifier or the split() function.
192       The /D modifier is a  PCRE  debugging  feature,  which  also  
193       assumes /I.  It causes the internal form of compiled regular     Other modifiers
194       expressions to be output after compilation. If  the  pattern  
195       was studied, the information returned is also output.         There are yet more modifiers for controlling the way pcretest operates.
196    
197       The /S modifier causes pcre_study() to be called  after  the         The /+ modifier requests that as well as outputting the substring  that
198       expression  has been compiled, and the results used when the         matched  the  entire  pattern,  pcretest  should in addition output the
199       expression is matched.         remainder of the subject string. This is useful  for  tests  where  the
200           subject contains multiple copies of the same substring.
201       The /M modifier causes the size of memory block used to hold  
202       the compiled pattern to be output.         The  /B modifier is a debugging feature. It requests that pcretest out-
203           put a representation of the compiled byte code after compilation.  Nor-
204       The /P modifier causes pcretest to call PCRE via  the  POSIX         mally  this  information contains length and offset values; however, if
205       wrapper  API  rather than its native API. When this is done,         /Z is also present, this data is replaced by spaces. This is a  special
206       all other modifiers except  /i,  /m,  and  /+  are  ignored.         feature for use in the automatic test scripts; it ensures that the same
207       REG_ICASE is set if /i is present, and REG_NEWLINE is set if         output is generated for different internal link sizes.
208       /m    is    present.    The    wrapper    functions    force  
209       PCRE_DOLLAR_ENDONLY    always,    and   PCRE_DOTALL   unless         The /L modifier must be followed directly by the name of a locale,  for
210       REG_NEWLINE is set.         example,
211    
212       The /8 modifier  causes  pcretest  to  call  PCRE  with  the           /pattern/Lfr_FR
213       PCRE_UTF8  option set. This turns on support for UTF-8 char-  
214       acter handling in PCRE, provided that it was  compiled  with         For this reason, it must be the last modifier. The given locale is set,
215       this  support  enabled.  This  modifier also causes any non-         pcre_maketables() is called to build a set of character tables for  the
216       printing characters in output strings to  be  printed  using         locale,  and  this  is then passed to pcre_compile() when compiling the
217       the \x{hh...} notation if they are valid UTF-8 sequences.         regular expression. Without an /L  modifier,  NULL  is  passed  as  the
218           tables  pointer; that is, /L applies only to the expression on which it
219       If the /? modifier is used with /8, it  causes  pcretest  to         appears.
220       call  pcre_compile()  with the PCRE_NO_UTF8_CHECK option, to  
221       suppress the checking of the string for UTF-8 validity.         The /I modifier requests that pcretest  output  information  about  the
222           compiled  pattern (whether it is anchored, has a fixed first character,
223           and so on). It does this by calling pcre_fullinfo() after  compiling  a
224           pattern.  If  the pattern is studied, the results of that are also out-
225           put.
226    
227           The /D modifier is a PCRE debugging feature, and is equivalent to  /BI,
228           that is, both the /B and the /I modifiers.
229    
230           The /F modifier causes pcretest to flip the byte order of the fields in
231           the compiled pattern that  contain  2-byte  and  4-byte  numbers.  This
232           facility  is  for testing the feature in PCRE that allows it to execute
233           patterns that were compiled on a host with a different endianness. This
234           feature  is  not  available  when  the POSIX interface to PCRE is being
235           used, that is, when the /P pattern modifier is specified. See also  the
236           section about saving and reloading compiled patterns below.
237    
238           The  /S  modifier causes pcre_study() to be called after the expression
239           has been compiled, and the results used when the expression is matched.
240    
241           The  /M  modifier causes the size of memory block used to hold the com-
242           piled pattern to be output.
243    
244           The /P modifier causes pcretest to call PCRE via the POSIX wrapper  API
245           rather  than  its  native  API.  When this is done, all other modifiers
246           except /i, /m, and /+ are ignored. REG_ICASE is set if /i  is  present,
247           and  REG_NEWLINE  is  set if /m is present. The wrapper functions force
248           PCRE_DOLLAR_ENDONLY always, and PCRE_DOTALL unless REG_NEWLINE is  set.
249    
250           The  /8 modifier causes pcretest to call PCRE with the PCRE_UTF8 option
251           set. This turns on support for UTF-8 character handling in  PCRE,  pro-
252           vided  that  it  was  compiled with this support enabled. This modifier
253           also causes any non-printing characters in output strings to be printed
254           using the \x{hh...} notation if they are valid UTF-8 sequences.
255    
256           If  the  /?  modifier  is  used  with  /8,  it  causes pcretest to call
257           pcre_compile() with the  PCRE_NO_UTF8_CHECK  option,  to  suppress  the
258           checking of the string for UTF-8 validity.
259    
260    
261    DATA LINES
262    
263           Before  each  data  line is passed to pcre_exec(), leading and trailing
264           whitespace is removed, and it is then scanned for \  escapes.  Some  of
265           these  are  pretty esoteric features, intended for checking out some of
266           the more complicated features of PCRE. If you are just  testing  "ordi-
267           nary"  regular  expressions,  you probably don't need any of these. The
268           following escapes are recognized:
269    
270             \a         alarm (BEL, \x07)
271             \b         backspace (\x08)
272             \e         escape (\x27)
273             \f         formfeed (\x0c)
274             \n         newline (\x0a)
275             \qdd       set the PCRE_MATCH_LIMIT limit to dd
276                          (any number of digits)
277             \r         carriage return (\x0d)
278             \t         tab (\x09)
279             \v         vertical tab (\x0b)
280             \nnn       octal character (up to 3 octal digits)
281             \xhh       hexadecimal character (up to 2 hex digits)
282             \x{hh...}  hexadecimal character, any number of digits
283                          in UTF-8 mode
284             \A         pass the PCRE_ANCHORED option to pcre_exec()
285                          or pcre_dfa_exec()
286             \B         pass the PCRE_NOTBOL option to pcre_exec()
287                          or pcre_dfa_exec()
288             \Cdd       call pcre_copy_substring() for substring dd
289                          after a successful match (number less than 32)
290             \Cname     call pcre_copy_named_substring() for substring
291                          "name" after a successful match (name termin-
292                          ated by next non alphanumeric character)
293             \C+        show the current captured substrings at callout
294                          time
295             \C-        do not supply a callout function
296             \C!n       return 1 instead of 0 when callout number n is
297                          reached
298             \C!n!m     return 1 instead of 0 when callout number n is
299                          reached for the nth time
300             \C*n       pass the number n (may be negative) as callout
301                          data; this is used as the callout return value
302             \D         use the pcre_dfa_exec() match function
303             \F         only shortest match for pcre_dfa_exec()
304             \Gdd       call pcre_get_substring() for substring dd
305                          after a successful match (number less than 32)
306             \Gname     call pcre_get_named_substring() for substring
307                          "name" after a successful match (name termin-
308                          ated by next non-alphanumeric character)
309             \L         call pcre_get_substringlist() after a
310                          successful match
311             \M         discover the minimum MATCH_LIMIT and
312                          MATCH_LIMIT_RECURSION settings
313             \N         pass the PCRE_NOTEMPTY option to pcre_exec()
314                          or pcre_dfa_exec()
315             \Odd       set the size of the output vector passed to
316                          pcre_exec() to dd (any number of digits)
317             \P         pass the PCRE_PARTIAL option to pcre_exec()
318                          or pcre_dfa_exec()
319             \Qdd       set the PCRE_MATCH_LIMIT_RECURSION limit to dd
320                          (any number of digits)
321             \R         pass the PCRE_DFA_RESTART option to pcre_dfa_exec()
322             \S         output details of memory get/free calls during matching
323             \Z         pass the PCRE_NOTEOL option to pcre_exec()
324                          or pcre_dfa_exec()
325             \?         pass the PCRE_NO_UTF8_CHECK option to
326                          pcre_exec() or pcre_dfa_exec()
327             \>dd       start the match at offset dd (any number of digits);
328                          this sets the startoffset argument for pcre_exec()
329                          or pcre_dfa_exec()
330             \<cr>      pass the PCRE_NEWLINE_CR option to pcre_exec()
331                          or pcre_dfa_exec()
332             \<lf>      pass the PCRE_NEWLINE_LF option to pcre_exec()
333                          or pcre_dfa_exec()
334             \<crlf>    pass the PCRE_NEWLINE_CRLF option to pcre_exec()
335                          or pcre_dfa_exec()
336             \<anycrlf> pass the PCRE_NEWLINE_ANYCRLF option to pcre_exec()
337                          or pcre_dfa_exec()
338             \<any>     pass the PCRE_NEWLINE_ANY option to pcre_exec()
339                          or pcre_dfa_exec()
340    
341           The escapes that specify line ending  sequences  are  literal  strings,
342           exactly as shown. No more than one newline setting should be present in
343           any data line.
344    
345           A backslash followed by anything else just escapes the  anything  else.
346           If  the very last character is a backslash, it is ignored. This gives a
347           way of passing an empty line as data, since a real  empty  line  termi-
348           nates the data input.
349    
350           If  \M  is present, pcretest calls pcre_exec() several times, with dif-
351           ferent values in the match_limit and  match_limit_recursion  fields  of
352           the  pcre_extra  data structure, until it finds the minimum numbers for
353           each parameter that allow pcre_exec() to complete. The match_limit num-
354           ber  is  a  measure of the amount of backtracking that takes place, and
355           checking it out can be instructive. For most simple matches, the number
356           is  quite  small,  but for patterns with very large numbers of matching
357           possibilities, it can become large very quickly with increasing  length
358           of subject string. The match_limit_recursion number is a measure of how
359           much stack (or, if PCRE is compiled with  NO_RECURSE,  how  much  heap)
360           memory is needed to complete the match attempt.
361    
362           When  \O  is  used, the value specified may be higher or lower than the
363           size set by the -O command line option (or defaulted to 45); \O applies
364           only to the call of pcre_exec() for the line in which it appears.
365    
366           If  the /P modifier was present on the pattern, causing the POSIX wrap-
367           per API to be used, the only option-setting  sequences  that  have  any
368           effect  are \B and \Z, causing REG_NOTBOL and REG_NOTEOL, respectively,
369           to be passed to regexec().
370    
371           The use of \x{hh...} to represent UTF-8 characters is not dependent  on
372           the  use  of  the  /8 modifier on the pattern. It is recognized always.
373           There may be any number of hexadecimal digits inside  the  braces.  The
374           result  is  from  one  to  six bytes, encoded according to the original
375           UTF-8 rules of RFC 2279. This allows for  values  in  the  range  0  to
376           0x7FFFFFFF.  Note  that not all of those are valid Unicode code points,
377           or indeed valid UTF-8 characters according to the later  rules  in  RFC
378           3629.
379    
380    
381    THE ALTERNATIVE MATCHING FUNCTION
382    
383           By   default,  pcretest  uses  the  standard  PCRE  matching  function,
384           pcre_exec() to match each data line. From release 6.0, PCRE supports an
385           alternative  matching  function,  pcre_dfa_test(),  which operates in a
386           different way, and has some restrictions. The differences  between  the
387           two functions are described in the pcrematching documentation.
388    
389           If  a data line contains the \D escape sequence, or if the command line
390           contains the -dfa option, the alternative matching function is  called.
391           This function finds all possible matches at a given point. If, however,
392           the \F escape sequence is present in the data line, it stops after  the
393           first match is found. This is always the shortest possible match.
394    
395    
396    DEFAULT OUTPUT FROM PCRETEST
397    
398           This  section  describes  the output when the normal matching function,
399           pcre_exec(), is being used.
400    
401           When a match succeeds, pcretest outputs the list of captured substrings
402           that  pcre_exec()  returns,  starting with number 0 for the string that
403           matched the whole pattern. Otherwise, it outputs "No match" or "Partial
404           match"  when  pcre_exec() returns PCRE_ERROR_NOMATCH or PCRE_ERROR_PAR-
405           TIAL, respectively, and otherwise the PCRE negative error number.  Here
406           is an example of an interactive pcretest run.
407    
408             $ pcretest
409             PCRE version 7.0 30-Nov-2006
410    
411               re> /^abc(\d+)/
412             data> abc123
413              0: abc123
414              1: 123
415             data> xyz
416             No match
417    
418           If  the strings contain any non-printing characters, they are output as
419           \0x escapes, or as \x{...} escapes if the /8 modifier  was  present  on
420           the  pattern.  See below for the definition of non-printing characters.
421           If the pattern has the /+ modifier, the output for substring 0 is  fol-
422           lowed  by  the  the rest of the subject string, identified by "0+" like
423           this:
424    
425               re> /cat/+
426             data> cataract
427              0: cat
428              0+ aract
429    
430           If the pattern has the /g or /G modifier,  the  results  of  successive
431           matching attempts are output in sequence, like this:
432    
433               re> /\Bi(\w\w)/g
434             data> Mississippi
435              0: iss
436              1: ss
437              0: iss
438              1: ss
439              0: ipp
440              1: pp
441    
442           "No match" is output only if the first match attempt fails.
443    
444           If  any  of the sequences \C, \G, or \L are present in a data line that
445           is successfully matched, the substrings extracted  by  the  convenience
446           functions are output with C, G, or L after the string number instead of
447           a colon. This is in addition to the normal full list. The string length
448           (that  is,  the return from the extraction function) is given in paren-
449           theses after each string for \C and \G.
450    
451           Note that whereas patterns can be continued over several lines (a plain
452           ">" prompt is used for continuations), data lines may not. However new-
453           lines can be included in data by means of the \n escape (or  \r,  \r\n,
454           etc., depending on the newline sequence setting).
455    
456    
457    OUTPUT FROM THE ALTERNATIVE MATCHING FUNCTION
458    
459           When  the  alternative  matching function, pcre_dfa_exec(), is used (by
460           means of the \D escape sequence or the -dfa command line  option),  the
461           output  consists  of  a list of all the matches that start at the first
462           point in the subject where there is at least one match. For example:
463    
464               re> /(tang|tangerine|tan)/
465             data> yellow tangerine\D
466              0: tangerine
467              1: tang
468              2: tan
469    
470           (Using the normal matching function on this data  finds  only  "tang".)
471           The  longest matching string is always given first (and numbered zero).
472    
473           If /g is present on the pattern, the search for further matches resumes
474           at the end of the longest match. For example:
475    
476               re> /(tang|tangerine|tan)/g
477             data> yellow tangerine and tangy sultana\D
478              0: tangerine
479              1: tang
480              2: tan
481              0: tang
482              1: tan
483              0: tan
484    
485           Since  the  matching  function  does not support substring capture, the
486           escape sequences that are concerned with captured  substrings  are  not
487           relevant.
488    
489    
490    RESTARTING AFTER A PARTIAL MATCH
491    
492           When the alternative matching function has given the PCRE_ERROR_PARTIAL
493           return, indicating that the subject partially matched the pattern,  you
494           can  restart  the match with additional subject data by means of the \R
495           escape sequence. For example:
496    
497               re> /^\d?\d(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)\d\d$/
498             data> 23ja\P\D
499             Partial match: 23ja
500             data> n05\R\D
501              0: n05
502    
503           For further information about partial  matching,  see  the  pcrepartial
504           documentation.
505    
506    
507  CALLOUTS  CALLOUTS
508    
509       If the pattern contains  any  callout  requests,  pcretest's         If  the pattern contains any callout requests, pcretest's callout func-
510       callout function will be called. By default, it displays the         tion is called during matching. This works  with  both  matching  func-
511       callout number, and the start and current positions  in  the         tions. By default, the called function displays the callout number, the
512       text at the callout time. For example, the output         start and current positions in the text at the callout  time,  and  the
513           next pattern item to be tested. For example, the output
514         --->pqrabcdef  
515           0    ^  ^           --->pqrabcdef
516               0    ^  ^     \d
517       indicates that callout number 0 occurred for a match attempt  
518       starting at the fourth character of the subject string, when         indicates  that  callout number 0 occurred for a match attempt starting
519       the pointer was at the seventh character. The callout  func-         at the fourth character of the subject string, when the pointer was  at
520       tion returns zero (carry on matching) by default.         the  seventh  character of the data, and when the next pattern item was
521           \d. Just one circumflex is output if the start  and  current  positions
522       Inserting callouts may be helpful  when  using  pcretest  to         are the same.
523       check  complicated regular expressions. For further informa-  
524       tion about callouts, see the pcrecallout documentation.         Callouts numbered 255 are assumed to be automatic callouts, inserted as
525           a result of the /C pattern modifier. In this case, instead  of  showing
526       For testing the PCRE library, additional control of  callout         the  callout  number, the offset in the pattern, preceded by a plus, is
527       behaviour  is available via escape sequences in the data, as         output. For example:
528       described in the following section.  In  particular,  it  is  
529       possible to pass in a number as callout data (the default is             re> /\d?[A-E]\*/C
530       zero). If the callout function receives a  non-zero  number,           data> E*
531       it returns that value instead of zero.           --->E*
532              +0 ^      \d?
533              +3 ^      [A-E]
534              +8 ^^     \*
535             +10 ^ ^
536              0: E*
537    
538           The callout function in pcretest returns zero (carry  on  matching)  by
539           default,  but you can use a \C item in a data line (as described above)
540           to change this.
541    
542           Inserting callouts can be helpful when using pcretest to check  compli-
543           cated  regular expressions. For further information about callouts, see
544           the pcrecallout documentation.
545    
546    
547    NON-PRINTING CHARACTERS
548    
549           When pcretest is outputting text in the compiled version of a  pattern,
550           bytes  other  than 32-126 are always treated as non-printing characters
551           are are therefore shown as hex escapes.
552    
553           When pcretest is outputting text that is a matched part  of  a  subject
554           string,  it behaves in the same way, unless a different locale has been
555           set for the  pattern  (using  the  /L  modifier).  In  this  case,  the
556           isprint() function to distinguish printing and non-printing characters.
557    
558    
559    SAVING AND RELOADING COMPILED PATTERNS
560    
561           The facilities described in this section are  not  available  when  the
562           POSIX inteface to PCRE is being used, that is, when the /P pattern mod-
563           ifier is specified.
564    
565           When the POSIX interface is not in use, you can cause pcretest to write
566           a  compiled  pattern to a file, by following the modifiers with > and a
567           file name.  For example:
568    
569             /pattern/im >/some/file
570    
571           See the pcreprecompile documentation for a discussion about saving  and
572           re-using compiled patterns.
573    
574           The  data  that  is  written  is  binary. The first eight bytes are the
575           length of the compiled pattern data  followed  by  the  length  of  the
576           optional  study  data,  each  written as four bytes in big-endian order
577           (most significant byte first). If there is no study  data  (either  the
578           pattern was not studied, or studying did not return any data), the sec-
579           ond length is zero. The lengths are followed by an exact  copy  of  the
580           compiled pattern. If there is additional study data, this follows imme-
581           diately after the compiled pattern. After writing  the  file,  pcretest
582           expects to read a new pattern.
583    
584           A saved pattern can be reloaded into pcretest by specifing < and a file
585           name instead of a pattern. The name of the file must not  contain  a  <
586           character,  as  otherwise pcretest will interpret the line as a pattern
587           delimited by < characters.  For example:
588    
589              re> </some/file
590             Compiled regex loaded from /some/file
591             No study data
592    
593           When the pattern has been loaded, pcretest proceeds to read data  lines
594           in the usual way.
595    
596           You  can copy a file written by pcretest to a different host and reload
597           it there, even if the new host has opposite endianness to  the  one  on
598           which  the pattern was compiled. For example, you can compile on an i86
599           machine and run on a SPARC machine.
600    
601           File names for saving and reloading can be absolute  or  relative,  but
602           note  that the shell facility of expanding a file name that starts with
603           a tilde (~) is not available.
604    
605           The ability to save and reload files in pcretest is intended for  test-
606           ing  and experimentation. It is not intended for production use because
607           only a single pattern can be written to a file. Furthermore,  there  is
608           no  facility  for  supplying  custom  character  tables  for use with a
609           reloaded pattern. If the original  pattern  was  compiled  with  custom
610           tables,  an  attempt to match a subject string using a reloaded pattern
611           is likely to cause pcretest to crash.  Finally, if you attempt to  load
612           a file that is not in the correct format, the result is undefined.
613    
614    
615  DATA LINES  SEE ALSO
616    
617       Before each data line is passed to pcre_exec(), leading  and         pcre(3),  pcreapi(3),  pcrecallout(3), pcrematching(3), pcrepartial(d),
618       trailing whitespace is removed, and it is then scanned for \         pcrepattern(3), pcreprecompile(3).
      escapes.  Some  of  these  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 fol-  
      lowing escapes are recognized:  
   
        \a         alarm (= BEL)  
        \b         backspace  
        \e         escape  
        \f         formfeed  
        \n         newline  
        \r         carriage return  
        \t         tab  
        \v         vertical tab  
        \nnn       octal character (up to 3 octal digits)  
        \xhh       hexadecimal character (up to 2 hex digits)  
        \x{hh...}  hexadecimal character, any number of digits  
                     in UTF-8 mode  
        \A         pass the PCRE_ANCHORED option to pcre_exec()  
        \B         pass the PCRE_NOTBOL option to pcre_exec()  
        \Cdd       call pcre_copy_substring() for substring dd  
                     after a successful match (any decimal number  
                     less than 32)  
        \Cname     call pcre_copy_named_substring() for substring  
   
                     "name" after a successful match (name termin-  
                     ated by next non alphanumeric character)  
        \C+        show the current captured substrings at callout  
                     time  
        \C-        do not supply a callout function  
        \C!n       return 1 instead of 0 when callout number n is  
                     reached  
        \C!n!m     return 1 instead of 0 when callout number n is  
                     reached for the nth time  
        \C*n       pass the number n (may be negative) as callout  
                     data  
        \Gdd       call pcre_get_substring() for substring dd  
                     after a successful match (any decimal number  
                     less than 32)  
        \Gname     call pcre_get_named_substring() for substring  
                     "name" after a successful match (name termin-  
                     ated by next non-alphanumeric character)  
        \L         call pcre_get_substringlist() after a  
                     successful match  
        \M         discover the minimum MATCH_LIMIT setting  
        \N         pass the PCRE_NOTEMPTY option to pcre_exec()  
        \Odd       set the size of the output vector passed to  
                     pcre_exec() to dd (any number of decimal  
                     digits)  
        \Z         pass the PCRE_NOTEOL option to pcre_exec()  
        \?         pass the PCRE_NO_UTF8_CHECK option to  
                     pcre_exec()  
   
      If \M is present, pcretest calls pcre_exec() several  times,  
      with  different  values  in  the  match_limit  field  of the  
      pcre_extra data structure, until it finds the minimum number  
      that is needed for pcre_exec() to complete. This number is a  
      measure of the amount of  recursion  and  backtracking  that  
      takes  place,  and  checking  it out can be instructive. For  
      most simple matches, the number is quite small, but for pat-  
      terns  with very large numbers of matching possibilities, it  
      can become large very quickly with increasing length of sub-  
      ject string.  
   
      When \O is used, it may be higher or lower than the size set  
      by  the  -O  option (or defaulted to 45); \O applies only to  
      the call of pcre_exec() for the line in which it appears.  
   
      A backslash followed by anything else just escapes the  any-  
      thing else. If the very last character is a backslash, it is  
      ignored. This gives a way of passing an empty line as  data,  
      since a real empty line terminates the data input.  
   
      If /P was present on the regex, causing  the  POSIX  wrapper  
      API  to  be  used,  only  B,  and Z have any effect, causing  
      REG_NOTBOL and REG_NOTEOL to be passed to regexec()  respec-  
      tively.  
      The use of \x{hh...} to represent UTF-8  characters  is  not  
      dependent  on  the use of the /8 modifier on the pattern. It  
      is recognized always. There may be any number of hexadecimal  
      digits  inside  the  braces.  The  result is from one to six  
      bytes, encoded according to the UTF-8 rules.  
   
   
 OUTPUT FROM PCRETEST  
   
      When a match succeeds, pcretest outputs the list of captured  
      substrings  that pcre_exec() returns, starting with number 0  
      for the string that matched the whole pattern.  Here  is  an  
      example of an interactive pcretest run.  
   
        $ pcretest  
        PCRE version 4.00 08-Jan-2003  
   
          re> /^abc(\d+)/  
        data> abc123  
         0: abc123  
         1: 123  
        data> xyz  
        No match  
   
      If the strings contain any non-printing characters, they are  
      output  as  \0x  escapes,  or  as  \x{...} escapes if the /8  
      modifier was present on the pattern. If the pattern has  the  
      /+  modifier, then the output for substring 0 is followed by  
      the the rest of the subject string, identified by "0+"  like  
      this:  
   
          re> /cat/+  
        data> cataract  
         0: cat  
         0+ aract  
   
      If the pattern has the /g or /G  modifier,  the  results  of  
      successive  matching  attempts  are output in sequence, like  
      this:  
   
          re> /\Bi(\w\w)/g  
        data> Mississippi  
         0: iss  
         1: ss  
         0: iss  
         1: ss  
         0: ipp  
         1: pp  
   
      "No match" is output only if the first match attempt fails.  
   
      If any of the sequences \C, \G, or \L are present in a  data  
      line  that is successfully matched, the substrings extracted  
      by the convenience functions are output  with  C,  G,  or  L  
      after the string number instead of a colon. This is in addi-  
      tion to the normal full list. The string  length  (that  is,  
      the  return  from  the  extraction  function)  is  given  in  
      parentheses after each string for \C and \G.  
   
      Note that while patterns can be continued over several lines  
      (a  plain  ">" prompt is used for continuations), data lines  
      may not. However newlines can be included in data  by  means  
      of the \n escape.  
619    
620    
621  AUTHOR  AUTHOR
622    
623       Philip Hazel <ph10@cam.ac.uk>         Philip Hazel
624       University Computing Service,         University Computing Service
625       Cambridge CB2 3QG, England.         Cambridge CB2 3QH, England.
626    
627    
628    REVISION
629    
630  Last updated: 20 August 2003         Last updated: 11 September 2007
631  Copyright (c) 1997-2003 University of Cambridge.         Copyright (c) 1997-2007 University of Cambridge.

Legend:
Removed from v.71  
changed lines
  Added in v.231

  ViewVC Help
Powered by ViewVC 1.1.5