/[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 289 by ph10, Sun Dec 23 12:17:20 2007 UTC revision 518 by ph10, Tue May 18 15:47:01 2010 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         When pcretest is built, a configuration  option  can  specify  that  it
94         should be linked with the libreadline library. When this  is  done,  if         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.         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         This  provides line-editing and history facilities. The output from the
97         -help option states whether or not readline() will be used.         -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 152  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 159  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
172           /<cr>           PCRE_NEWLINE_CR           /<cr>           PCRE_NEWLINE_CR
173           /<lf>           PCRE_NEWLINE_LF           /<lf>           PCRE_NEWLINE_LF
174           /<crlf>         PCRE_NEWLINE_CRLF           /<crlf>         PCRE_NEWLINE_CRLF
# Line 168  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    
# Line 190  PATTERN MODIFIERS Line 202  PATTERN MODIFIERS
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 212  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 241  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  /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-         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.
# Line 251  PATTERN MODIFIERS Line 271  PATTERN MODIFIERS
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 317  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 option to pcre_exec()           \P         pass the PCRE_PARTIAL_SOFT option to pcre_exec()
338                        or pcre_dfa_exec()                        or pcre_dfa_exec(); if used twice, pass the
339                          PCRE_PARTIAL_HARD option
340           \Qdd       set the PCRE_MATCH_LIMIT_RECURSION limit to dd           \Qdd       set the PCRE_MATCH_LIMIT_RECURSION limit to dd
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 406  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"  when  pcre_exec() returns PCRE_ERROR_NOMATCH or PCRE_ERROR_PAR-         return is PCRE_ERROR_NOMATCH, and "Partial match:" followed by the par-
428         TIAL, respectively, and otherwise the PCRE negative error number.  Here         tially matching substring when pcre_exec() returns  PCRE_ERROR_PARTIAL.
429           For  any other returns, it outputs the PCRE negative error number. Here
430         is an example of an interactive pcretest run.         is an example of an interactive pcretest run.
431    
432           $ pcretest           $ pcretest
# Line 421  DEFAULT OUTPUT FROM PCRETEST Line 439  DEFAULT OUTPUT FROM PCRETEST
439           data> xyz           data> xyz
440           No match           No match
441    
442         Note  that unset capturing substrings that are not followed by one that         Note that unset capturing substrings that are not followed by one  that
443         is set are not returned by pcre_exec(), and are not shown by  pcretest.         is  set are not returned by pcre_exec(), and are not shown by pcretest.
444         In  the following example, there are two capturing substrings, but when         In the following example, there are two capturing substrings, but  when
445         the first data line is matched, the  second,  unset  substring  is  not         the  first  data  line  is  matched, the second, unset substring is not
446         shown.  An "internal" unset substring is shown as "<unset>", as for the         shown. An "internal" unset substring is shown as "<unset>", as for  the
447         second data line.         second data line.
448    
449             re> /(a)|(b)/             re> /(a)|(b)/
# Line 437  DEFAULT OUTPUT FROM PCRETEST Line 455  DEFAULT OUTPUT FROM PCRETEST
455            1: <unset>            1: <unset>
456            2: b            2: b
457    
458         If the strings contain any non-printing characters, they are output  as         If  the strings contain any non-printing characters, they are output as
459         \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
460         the pattern. See below for the definition of  non-printing  characters.         the  pattern.  See below for the definition of non-printing characters.
461         If  the pattern has the /+ modifier, the output for substring 0 is fol-         If the pattern has the /+ modifier, the output for substring 0 is  fol-
462         lowed by the the rest of the subject string, identified  by  "0+"  like         lowed  by  the  the rest of the subject string, identified by "0+" like
463         this:         this:
464    
465             re> /cat/+             re> /cat/+
# Line 449  DEFAULT OUTPUT FROM PCRETEST Line 467  DEFAULT OUTPUT FROM PCRETEST
467            0: cat            0: cat
468            0+ aract            0+ aract
469    
470         If  the  pattern  has  the /g or /G modifier, the results of successive         If the pattern has the /g or /G modifier,  the  results  of  successive
471         matching attempts are output in sequence, like this:         matching attempts are output in sequence, like this:
472    
473             re> /\Bi(\w\w)/g             re> /\Bi(\w\w)/g
# Line 463  DEFAULT OUTPUT FROM PCRETEST Line 481  DEFAULT OUTPUT FROM PCRETEST
481    
482         "No match" is output only if the first match attempt fails.         "No match" is output only if the first match attempt fails.
483    
484         If any of the sequences \C, \G, or \L are present in a data  line  that         If  any  of the sequences \C, \G, or \L are present in a data line that
485         is  successfully  matched,  the substrings extracted by the convenience         is successfully matched, the substrings extracted  by  the  convenience
486         functions are output with C, G, or L after the string number instead of         functions are output with C, G, or L after the string number instead of
487         a colon. This is in addition to the normal full list. The string length         a colon. This is in addition to the normal full list. The string length
488         (that is, the return from the extraction function) is given  in  paren-         (that  is,  the return from the extraction function) is given in paren-
489         theses after each string for \C and \G.         theses after each string for \C and \G.
490    
491         Note that whereas patterns can be continued over several lines (a plain         Note that whereas patterns can be continued over several lines (a plain
492         ">" prompt is used for continuations), data lines may not. However new-         ">" prompt is used for continuations), data lines may not. However new-
493         lines  can  be included in data by means of the \n escape (or \r, \r\n,         lines can be included in data by means of the \n escape (or  \r,  \r\n,
494         etc., depending on the newline sequence setting).         etc., depending on the newline sequence setting).
495    
496    
497  OUTPUT FROM THE ALTERNATIVE MATCHING FUNCTION  OUTPUT FROM THE ALTERNATIVE MATCHING FUNCTION
498    
499         When the alternative matching function, pcre_dfa_exec(),  is  used  (by         When  the  alternative  matching function, pcre_dfa_exec(), is used (by
500         means  of  the \D escape sequence or the -dfa command line option), the         means of the \D escape sequence or the -dfa command line  option),  the
501         output consists of a list of all the matches that start  at  the  first         output  consists  of  a list of all the matches that start at the first
502         point in the subject where there is at least one match. For example:         point in the subject where there is at least one match. For example:
503    
504             re> /(tang|tangerine|tan)/             re> /(tang|tangerine|tan)/
# Line 489  OUTPUT FROM THE ALTERNATIVE MATCHING FUN Line 507  OUTPUT FROM THE ALTERNATIVE MATCHING FUN
507            1: tang            1: tang
508            2: tan            2: tan
509    
510         (Using  the  normal  matching function on this data finds only "tang".)         (Using the normal matching function on this data  finds  only  "tang".)
511         The longest matching string is always given first (and numbered  zero).         The  longest matching string is always given first (and numbered zero).
512           After a PCRE_ERROR_PARTIAL return, the output is "Partial match:", fol-
513           lowed by the partially matching substring.
514    
515         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
516         at the end of the longest match. For example:         at the end of the longest match. For example:
# Line 580  NON-PRINTING CHARACTERS Line 600  NON-PRINTING CHARACTERS
600    
601  SAVING AND RELOADING COMPILED PATTERNS  SAVING AND RELOADING COMPILED PATTERNS
602    
603         The  facilities  described  in  this section are not available when the         The facilities described in this section are  not  available  when  the
604         POSIX inteface to PCRE is being used, that is, when the /P pattern mod-         POSIX inteface to PCRE is being used, that is, when the /P pattern mod-
605         ifier is specified.         ifier is specified.
606    
607         When the POSIX interface is not in use, you can cause pcretest to write         When the POSIX interface is not in use, you can cause pcretest to write
608         a compiled pattern to a file, by following the modifiers with >  and  a         a  compiled  pattern to a file, by following the modifiers with > and a
609         file name.  For example:         file name.  For example:
610    
611           /pattern/im >/some/file           /pattern/im >/some/file
612    
613         See  the pcreprecompile documentation for a discussion about saving and         See the pcreprecompile documentation for a discussion about saving  and
614         re-using compiled patterns.         re-using compiled patterns.
615    
616         The data that is written is binary.  The  first  eight  bytes  are  the         The  data  that  is  written  is  binary. The first eight bytes are the
617         length  of  the  compiled  pattern  data  followed by the length of the         length of the compiled pattern data  followed  by  the  length  of  the
618         optional study data, each written as four  bytes  in  big-endian  order         optional  study  data,  each  written as four bytes in big-endian order
619         (most  significant  byte  first). If there is no study data (either the         (most significant byte first). If there is no study  data  (either  the
620         pattern was not studied, or studying did not return any data), the sec-         pattern was not studied, or studying did not return any data), the sec-
621         ond  length  is  zero. The lengths are followed by an exact copy of the         ond length is zero. The lengths are followed by an exact  copy  of  the
622         compiled pattern. If there is additional study data, this follows imme-         compiled pattern. If there is additional study data, this follows imme-
623         diately  after  the  compiled pattern. After writing the file, pcretest         diately after the compiled pattern. After writing  the  file,  pcretest
624         expects to read a new pattern.         expects to read a new pattern.
625    
626         A saved pattern can be reloaded into pcretest by specifing < and a file         A saved pattern can be reloaded into pcretest by specifing < and a file
627         name  instead  of  a pattern. The name of the file must not contain a <         name instead of a pattern. The name of the file must not  contain  a  <
628         character, as otherwise pcretest will interpret the line as  a  pattern         character,  as  otherwise pcretest will interpret the line as a pattern
629         delimited by < characters.  For example:         delimited by < characters.  For example:
630    
631            re> </some/file            re> </some/file
632           Compiled regex loaded from /some/file           Compiled regex loaded from /some/file
633           No study data           No study data
634    
635         When  the pattern has been loaded, pcretest proceeds to read data lines         When the pattern has been loaded, pcretest proceeds to read data  lines
636         in the usual way.         in the usual way.
637    
638         You can copy a file written by pcretest to a different host and  reload         You  can copy a file written by pcretest to a different host and reload
639         it  there,  even  if the new host has opposite endianness to the one on         it there, even if the new host has opposite endianness to  the  one  on
640         which the pattern was compiled. For example, you can compile on an  i86         which  the pattern was compiled. For example, you can compile on an i86
641         machine and run on a SPARC machine.         machine and run on a SPARC machine.
642    
643         File  names  for  saving and reloading can be absolute or relative, but         File names for saving and reloading can be absolute  or  relative,  but
644         note that the shell facility of expanding a file name that starts  with         note  that the shell facility of expanding a file name that starts with
645         a tilde (~) is not available.         a tilde (~) is not available.
646    
647         The  ability to save and reload files in pcretest is intended for test-         The ability to save and reload files in pcretest is intended for  test-
648         ing and experimentation. It is not intended for production use  because         ing  and experimentation. It is not intended for production use because
649         only  a  single pattern can be written to a file. Furthermore, there is         only a single pattern can be written to a file. Furthermore,  there  is
650         no facility for supplying  custom  character  tables  for  use  with  a         no  facility  for  supplying  custom  character  tables  for use with a
651         reloaded  pattern.  If  the  original  pattern was compiled with custom         reloaded pattern. If the original  pattern  was  compiled  with  custom
652         tables, an attempt to match a subject string using a  reloaded  pattern         tables,  an  attempt to match a subject string using a reloaded pattern
653         is  likely to cause pcretest to crash.  Finally, if you attempt to load         is likely to cause pcretest to crash.  Finally, if you attempt to  load
654         a file that is not in the correct format, the result is undefined.         a file that is not in the correct format, the result is undefined.
655    
656    
657  SEE ALSO  SEE ALSO
658    
659         pcre(3), pcreapi(3), pcrecallout(3),  pcrematching(3),  pcrepartial(d),         pcre(3),  pcreapi(3),  pcrecallout(3), pcrematching(3), pcrepartial(d),
660         pcrepattern(3), pcreprecompile(3).         pcrepattern(3), pcreprecompile(3).
661    
662    
# Line 649  AUTHOR Line 669  AUTHOR
669    
670  REVISION  REVISION
671    
672         Last updated: 18 December 2007         Last updated: 12 May 2010
673         Copyright (c) 1997-2007 University of Cambridge.         Copyright (c) 1997-2010 University of Cambridge.

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

  ViewVC Help
Powered by ViewVC 1.1.5