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

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

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

revision 429 by ph10, Tue Sep 1 16:10:16 2009 UTC revision 567 by ph10, Sat Nov 6 17:10:00 2010 UTC
# Line 154  PATTERN MODIFIERS Line 154  PATTERN MODIFIERS
154    
155           /caseless/i           /caseless/i
156    
157         The following table shows additional modifiers for setting PCRE options         The  following  table  shows additional modifiers for setting PCRE com-
158         that do not correspond to anything in Perl:         pile-time options that do not correspond to anything in Perl:
159    
160             /8              PCRE_UTF8
161             /?              PCRE_NO_UTF8_CHECK
162           /A              PCRE_ANCHORED           /A              PCRE_ANCHORED
163           /C              PCRE_AUTO_CALLOUT           /C              PCRE_AUTO_CALLOUT
164           /E              PCRE_DOLLAR_ENDONLY           /E              PCRE_DOLLAR_ENDONLY
# Line 164  PATTERN MODIFIERS Line 166  PATTERN MODIFIERS
166           /J              PCRE_DUPNAMES           /J              PCRE_DUPNAMES
167           /N              PCRE_NO_AUTO_CAPTURE           /N              PCRE_NO_AUTO_CAPTURE
168           /U              PCRE_UNGREEDY           /U              PCRE_UNGREEDY
169             /W              PCRE_UCP
170           /X              PCRE_EXTRA           /X              PCRE_EXTRA
171           /<JS>           PCRE_JAVASCRIPT_COMPAT           /<JS>           PCRE_JAVASCRIPT_COMPAT
172           /<cr>           PCRE_NEWLINE_CR           /<cr>           PCRE_NEWLINE_CR
# Line 174  PATTERN MODIFIERS Line 177  PATTERN MODIFIERS
177           /<bsr_anycrlf>  PCRE_BSR_ANYCRLF           /<bsr_anycrlf>  PCRE_BSR_ANYCRLF
178           /<bsr_unicode>  PCRE_BSR_UNICODE           /<bsr_unicode>  PCRE_BSR_UNICODE
179    
180         Those specifying line ending sequences are literal  strings  as  shown,         The modifiers that are enclosed in angle brackets are  literal  strings
181         but  the  letters  can  be  in either case. This example sets multiline         as  shown,  including  the  angle  brackets,  but the letters can be in
182         matching with CRLF as the line ending sequence:         either case. This example sets multiline matching with CRLF as the line
183           ending sequence:
184    
185           /^abc/m<crlf>           /^abc/m<crlf>
186    
187         Details of the meanings of these PCRE options are given in the  pcreapi         As well as turning on the PCRE_UTF8 option, the /8 modifier also causes
188         documentation.         any non-printing characters in output strings to be printed  using  the
189           \x{hh...}  notation  if they are valid UTF-8 sequences. Full details of
190           the PCRE options are given in the pcreapi documentation.
191    
192     Finding all matches in a string     Finding all matches in a string
193    
194         Searching  for  all  possible matches within each subject string can be         Searching for all possible matches within each subject  string  can  be
195         requested by the /g or /G modifier. After  finding  a  match,  PCRE  is         requested  by  the  /g  or  /G modifier. After finding a match, PCRE is
196         called again to search the remainder of the subject string. The differ-         called again to search the remainder of the subject string. The differ-
197         ence between /g and /G is that the former uses the startoffset argument         ence between /g and /G is that the former uses the startoffset argument
198         to  pcre_exec()  to  start  searching  at a new point within the entire         to pcre_exec() to start searching at a  new  point  within  the  entire
199         string (which is in effect what Perl does), whereas the  latter  passes         string  (which  is in effect what Perl does), whereas the latter passes
200         over  a  shortened  substring.  This makes a difference to the matching         over a shortened substring. This makes a  difference  to  the  matching
201         process if the pattern begins with a lookbehind assertion (including \b         process if the pattern begins with a lookbehind assertion (including \b
202         or \B).         or \B).
203    
204         If  any  call  to  pcre_exec()  in a /g or /G sequence matches an empty         If any call to pcre_exec() in a /g or  /G  sequence  matches  an  empty
205         string, the next call is done with the PCRE_NOTEMPTY and  PCRE_ANCHORED         string,  the  next  call  is  done  with  the PCRE_NOTEMPTY_ATSTART and
206         flags  set in order to search for another, non-empty, match at the same         PCRE_ANCHORED flags set in order  to  search  for  another,  non-empty,
207         point.  If this second match fails, the start  offset  is  advanced  by         match  at  the same point. If this second match fails, the start offset
208         one,  and  the normal match is retried. This imitates the way Perl han-         is advanced, and the normal match is retried.  This  imitates  the  way
209         dles such cases when using the /g modifier or the split() function.         Perl handles such cases when using the /g modifier or the split() func-
210           tion. Normally, the start offset is advanced by one character,  but  if
211           the  newline  convention  recognizes CRLF as a newline, and the current
212           character is CR followed by LF, an advance of two is used.
213    
214     Other modifiers     Other modifiers
215    
# Line 218  PATTERN MODIFIERS Line 227  PATTERN MODIFIERS
227         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
228         output is generated for different internal link sizes.         output is generated for different internal link sizes.
229    
        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.  
   
230         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,
231         that is, both the /B and the /I modifiers.         that is, both the /B and the /I modifiers.
232    
# Line 247  PATTERN MODIFIERS Line 238  PATTERN MODIFIERS
238         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
239         section about saving and reloading compiled patterns below.         section about saving and reloading compiled patterns below.
240    
241         The  /S  modifier causes pcre_study() to be called after the expression         The  /I  modifier  requests  that pcretest output information about the
242         has been compiled, and the results used when the expression is matched.         compiled pattern (whether it is anchored, has a fixed first  character,
243           and  so  on). It does this by calling pcre_fullinfo() after compiling a
244           pattern. If the pattern is studied, the results of that are  also  out-
245           put.
246    
247           The  /K modifier requests pcretest to show names from backtracking con-
248           trol verbs that are returned  from  calls  to  pcre_exec().  It  causes
249           pcretest  to create a pcre_extra block if one has not already been cre-
250           ated by a call to pcre_study(), and to set the PCRE_EXTRA_MARK flag and
251           the mark field within it, every time that pcre_exec() is called. If the
252           variable that the mark field points to is non-NULL for  a  match,  non-
253           match, or partial match, pcretest prints the string to which it points.
254           For a match, this is shown on a line by itself, tagged with "MK:".  For
255           a non-match it is added to the message.
256    
257           The  /L modifier must be followed directly by the name of a locale, for
258           example,
259    
260             /pattern/Lfr_FR
261    
262           For this reason, it must be the last modifier. The given locale is set,
263           pcre_maketables()  is called to build a set of character tables for the
264           locale, and this is then passed to pcre_compile()  when  compiling  the
265           regular  expression.  Without an /L (or /T) modifier, NULL is passed as
266           the tables pointer; that is, /L applies only to the expression on which
267           it appears.
268    
269         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-
270         piled pattern to be output.         piled pattern to be output.
271    
272           The /S modifier causes pcre_study() to be called after  the  expression
273           has been compiled, and the results used when the expression is matched.
274    
275           The  /T  modifier  must be followed by a single digit. It causes a spe-
276           cific set of built-in character tables to be passed to  pcre_compile().
277           It is used in the standard PCRE tests to check behaviour with different
278           character tables. The digit specifies the tables as follows:
279    
280             0   the default ASCII tables, as distributed in
281                   pcre_chartables.c.dist
282             1   a set of tables defining ISO 8859 characters
283    
284           In table 1, some characters whose codes are greater than 128 are  iden-
285           tified as letters, digits, spaces, etc.
286    
287       Using the POSIX wrapper API
288    
289         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
290         rather than its native API. When this  is  done,  all  other  modifiers         rather than its native API. When /P is set, the following modifiers set
291         except  /i,  /m, and /+ are ignored. REG_ICASE is set if /i is present,         options for the regcomp() function:
292         and REG_NEWLINE is set if /m is present. The  wrapper  functions  force  
293         PCRE_DOLLAR_ENDONLY always, and PCRE_DOTALL unless REG_NEWLINE is set.           /i    REG_ICASE
294             /m    REG_NEWLINE
295         The  /8 modifier causes pcretest to call PCRE with the PCRE_UTF8 option           /N    REG_NOSUB
296         set. This turns on support for UTF-8 character handling in  PCRE,  pro-           /s    REG_DOTALL     )
297         vided  that  it  was  compiled with this support enabled. This modifier           /U    REG_UNGREEDY   ) These options are not part of
298         also causes any non-printing characters in output strings to be printed           /W    REG_UCP        )   the POSIX standard
299         using the \x{hh...} notation if they are valid UTF-8 sequences.           /8    REG_UTF8       )
300    
301         If  the  /?  modifier  is  used  with  /8,  it  causes pcretest to call         The  /+  modifier  works  as  described  above. All other modifiers are
302         pcre_compile() with the  PCRE_NO_UTF8_CHECK  option,  to  suppress  the         ignored.
        checking of the string for UTF-8 validity.  
303    
304    
305  DATA LINES  DATA LINES
306    
307         Before  each  data  line is passed to pcre_exec(), leading and trailing         Before each data line is passed to pcre_exec(),  leading  and  trailing
308         whitespace is removed, and it is then scanned for \  escapes.  Some  of         whitespace  is  removed,  and it is then scanned for \ escapes. Some of
309         these  are  pretty esoteric features, intended for checking out some of         these are pretty esoteric features, intended for checking out  some  of
310         the more complicated features of PCRE. If you are just  testing  "ordi-         the  more  complicated features of PCRE. If you are just testing "ordi-
311         nary"  regular  expressions,  you probably don't need any of these. The         nary" regular expressions, you probably don't need any  of  these.  The
312         following escapes are recognized:         following escapes are recognized:
313    
314           \a         alarm (BEL, \x07)           \a         alarm (BEL, \x07)
# Line 323  DATA LINES Line 355  DATA LINES
355           \M         discover the minimum MATCH_LIMIT and           \M         discover the minimum MATCH_LIMIT and
356                        MATCH_LIMIT_RECURSION settings                        MATCH_LIMIT_RECURSION settings
357           \N         pass the PCRE_NOTEMPTY option to pcre_exec()           \N         pass the PCRE_NOTEMPTY option to pcre_exec()
358                        or pcre_dfa_exec()                        or pcre_dfa_exec(); if used twice, pass the
359                          PCRE_NOTEMPTY_ATSTART option
360           \Odd       set the size of the output vector passed to           \Odd       set the size of the output vector passed to
361                        pcre_exec() to dd (any number of digits)                        pcre_exec() to dd (any number of digits)
362           \P         pass the PCRE_PARTIAL_SOFT option to pcre_exec()           \P         pass the PCRE_PARTIAL_SOFT option to pcre_exec()
# Line 333  DATA LINES Line 366  DATA LINES
366                        (any number of digits)                        (any number of digits)
367           \R         pass the PCRE_DFA_RESTART option to pcre_dfa_exec()           \R         pass the PCRE_DFA_RESTART option to pcre_dfa_exec()
368           \S         output details of memory get/free calls during matching           \S         output details of memory get/free calls during matching
369             \Y         pass the PCRE_NO_START_OPTIMIZE option to pcre_exec()
370                          or pcre_dfa_exec()
371           \Z         pass the PCRE_NOTEOL option to pcre_exec()           \Z         pass the PCRE_NOTEOL option to pcre_exec()
372                        or pcre_dfa_exec()                        or pcre_dfa_exec()
373           \?         pass the PCRE_NO_UTF8_CHECK option to           \?         pass the PCRE_NO_UTF8_CHECK option to
374                        pcre_exec() or pcre_dfa_exec()                        pcre_exec() or pcre_dfa_exec()
375           \>dd       start the match at offset dd (any number of digits);           \>dd       start the match at offset dd (optional "-"; then
376                        this sets the startoffset argument for pcre_exec()                        any number of digits); this sets the startoffset
377                        or pcre_dfa_exec()                        argument for pcre_exec() or pcre_dfa_exec()
378           \<cr>      pass the PCRE_NEWLINE_CR option to pcre_exec()           \<cr>      pass the PCRE_NEWLINE_CR option to pcre_exec()
379                        or pcre_dfa_exec()                        or pcre_dfa_exec()
380           \<lf>      pass the PCRE_NEWLINE_LF option to pcre_exec()           \<lf>      pass the PCRE_NEWLINE_LF option to pcre_exec()
# Line 351  DATA LINES Line 386  DATA LINES
386           \<any>     pass the PCRE_NEWLINE_ANY option to pcre_exec()           \<any>     pass the PCRE_NEWLINE_ANY option to pcre_exec()
387                        or pcre_dfa_exec()                        or pcre_dfa_exec()
388    
389         The escapes that specify line ending  sequences  are  literal  strings,         The  escapes  that  specify  line ending sequences are literal strings,
390         exactly as shown. No more than one newline setting should be present in         exactly as shown. No more than one newline setting should be present in
391         any data line.         any data line.
392    
393         A backslash followed by anything else just escapes the  anything  else.         A  backslash  followed by anything else just escapes the anything else.
394         If  the very last character is a backslash, it is ignored. This gives a         If the very last character is a backslash, it is ignored. This gives  a
395         way of passing an empty line as data, since a real  empty  line  termi-         way  of  passing  an empty line as data, since a real empty line termi-
396         nates the data input.         nates the data input.
397    
398         If  \M  is present, pcretest calls pcre_exec() several times, with dif-         If \M is present, pcretest calls pcre_exec() several times,  with  dif-
399         ferent values in the match_limit and  match_limit_recursion  fields  of         ferent  values  in  the match_limit and match_limit_recursion fields of
400         the  pcre_extra  data structure, until it finds the minimum numbers for         the pcre_extra data structure, until it finds the minimum  numbers  for
401         each parameter that allow pcre_exec() to complete. The match_limit num-         each parameter that allow pcre_exec() to complete. The match_limit num-
402         ber  is  a  measure of the amount of backtracking that takes place, and         ber is a measure of the amount of backtracking that  takes  place,  and
403         checking it out can be instructive. For most simple matches, the number         checking it out can be instructive. For most simple matches, the number
404         is  quite  small,  but for patterns with very large numbers of matching         is quite small, but for patterns with very large  numbers  of  matching
405         possibilities, it can become large very quickly with increasing  length         possibilities,  it can become large very quickly with increasing length
406         of subject string. The match_limit_recursion number is a measure of how         of subject string. The match_limit_recursion number is a measure of how
407         much stack (or, if PCRE is compiled with  NO_RECURSE,  how  much  heap)         much  stack  (or,  if  PCRE is compiled with NO_RECURSE, how much heap)
408         memory is needed to complete the match attempt.         memory is needed to complete the match attempt.
409    
410         When  \O  is  used, the value specified may be higher or lower than the         When \O is used, the value specified may be higher or  lower  than  the
411         size set by the -O command line option (or defaulted to 45); \O applies         size set by the -O command line option (or defaulted to 45); \O applies
412         only to the call of pcre_exec() for the line in which it appears.         only to the call of pcre_exec() for the line in which it appears.
413    
414         If  the /P modifier was present on the pattern, causing the POSIX wrap-         If the /P modifier was present on the pattern, causing the POSIX  wrap-
415         per API to be used, the only option-setting  sequences  that  have  any         per  API  to  be  used, the only option-setting sequences that have any
416         effect  are \B and \Z, causing REG_NOTBOL and REG_NOTEOL, respectively,         effect are \B,  \N,  and  \Z,  causing  REG_NOTBOL,  REG_NOTEMPTY,  and
417         to be passed to regexec().         REG_NOTEOL, respectively, to be passed to regexec().
418    
419         The use of \x{hh...} to represent UTF-8 characters is not dependent  on         The  use of \x{hh...} to represent UTF-8 characters is not dependent on
420         the  use  of  the  /8 modifier on the pattern. It is recognized always.         the use of the /8 modifier on the pattern.  It  is  recognized  always.
421         There may be any number of hexadecimal digits inside  the  braces.  The         There  may  be  any number of hexadecimal digits inside the braces. The
422         result  is  from  one  to  six bytes, encoded according to the original         result is from one to six bytes,  encoded  according  to  the  original
423         UTF-8 rules of RFC 2279. This allows for  values  in  the  range  0  to         UTF-8  rules  of  RFC  2279.  This  allows for values in the range 0 to
424         0x7FFFFFFF.  Note  that not all of those are valid Unicode code points,         0x7FFFFFFF. Note that not all of those are valid Unicode  code  points,
425         or indeed valid UTF-8 characters according to the later  rules  in  RFC         or  indeed  valid  UTF-8 characters according to the later rules in RFC
426         3629.         3629.
427    
428    
429  THE ALTERNATIVE MATCHING FUNCTION  THE ALTERNATIVE MATCHING FUNCTION
430    
431         By   default,  pcretest  uses  the  standard  PCRE  matching  function,         By  default,  pcretest  uses  the  standard  PCRE  matching   function,
432         pcre_exec() to match each data line. From release 6.0, PCRE supports an         pcre_exec() to match each data line. From release 6.0, PCRE supports an
433         alternative  matching  function,  pcre_dfa_test(),  which operates in a         alternative matching function, pcre_dfa_test(),  which  operates  in  a
434         different way, and has some restrictions. The differences  between  the         different  way,  and has some restrictions. The differences between the
435         two functions are described in the pcrematching documentation.         two functions are described in the pcrematching documentation.
436    
437         If  a data line contains the \D escape sequence, or if the command line         If a data line contains the \D escape sequence, or if the command  line
438         contains the -dfa option, the alternative matching function is  called.         contains  the -dfa option, the alternative matching function is called.
439         This function finds all possible matches at a given point. If, however,         This function finds all possible matches at a given point. If, however,
440         the \F escape sequence is present in the data line, it stops after  the         the  \F escape sequence is present in the data line, it stops after the
441         first match is found. This is always the shortest possible match.         first match is found. This is always the shortest possible match.
442    
443    
444  DEFAULT OUTPUT FROM PCRETEST  DEFAULT OUTPUT FROM PCRETEST
445    
446         This  section  describes  the output when the normal matching function,         This section describes the output when the  normal  matching  function,
447         pcre_exec(), is being used.         pcre_exec(), is being used.
448    
449         When a match succeeds, pcretest outputs the list of captured substrings         When a match succeeds, pcretest outputs the list of captured substrings
450         that  pcre_exec()  returns,  starting with number 0 for the string that         that pcre_exec() returns, starting with number 0 for  the  string  that
451         matched the whole pattern. Otherwise, it outputs "No match" or "Partial         matched  the  whole  pattern. Otherwise, it outputs "No match" when the
452         match:"  followed  by the partially matching substring when pcre_exec()         return is PCRE_ERROR_NOMATCH, and "Partial match:" followed by the par-
453         returns PCRE_ERROR_NOMATCH  or  PCRE_ERROR_PARTIAL,  respectively,  and         tially  matching substring when pcre_exec() returns PCRE_ERROR_PARTIAL.
454         otherwise  the  PCRE  negative  error  number. Here is an example of an         (Note that this is the entire substring that was inspected  during  the
455         interactive pcretest run.         partial  match; it may include characters before the actual match start
456           if a lookbehind assertion, \K, \b, or \B was involved.) For  any  other
457           returns,  it outputs the PCRE negative error number. Here is an example
458           of an interactive pcretest run.
459    
460           $ pcretest           $ pcretest
461           PCRE version 7.0 30-Nov-2006           PCRE version 7.0 30-Nov-2006
# Line 500  OUTPUT FROM THE ALTERNATIVE MATCHING FUN Line 538  OUTPUT FROM THE ALTERNATIVE MATCHING FUN
538         (Using the normal matching function on this data  finds  only  "tang".)         (Using the normal matching function on this data  finds  only  "tang".)
539         The  longest matching string is always given first (and numbered zero).         The  longest matching string is always given first (and numbered zero).
540         After a PCRE_ERROR_PARTIAL return, the output is "Partial match:", fol-         After a PCRE_ERROR_PARTIAL return, the output is "Partial match:", fol-
541         lowed by the partially matching substring.         lowed  by  the  partially  matching  substring.  (Note that this is the
542           entire substring that was inspected during the partial  match;  it  may
543           include characters before the actual match start if a lookbehind asser-
544           tion, \K, \b, or \B was involved.)
545    
546         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
547         at the end of the longest match. For example:         at the end of the longest match. For example:
# Line 514  OUTPUT FROM THE ALTERNATIVE MATCHING FUN Line 555  OUTPUT FROM THE ALTERNATIVE MATCHING FUN
555            1: tan            1: tan
556            0: tan            0: tan
557    
558         Since the matching function does not  support  substring  capture,  the         Since  the  matching  function  does not support substring capture, the
559         escape  sequences  that  are concerned with captured substrings are not         escape sequences that are concerned with captured  substrings  are  not
560         relevant.         relevant.
561    
562    
563  RESTARTING AFTER A PARTIAL MATCH  RESTARTING AFTER A PARTIAL MATCH
564    
565         When the alternative matching function has given the PCRE_ERROR_PARTIAL         When the alternative matching function has given the PCRE_ERROR_PARTIAL
566         return,  indicating that the subject partially matched the pattern, you         return, indicating that the subject partially matched the pattern,  you
567         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
568         escape sequence. For example:         escape sequence. For example:
569    
570             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 532  RESTARTING AFTER A PARTIAL MATCH Line 573  RESTARTING AFTER A PARTIAL MATCH
573           data> n05\R\D           data> n05\R\D
574            0: n05            0: n05
575    
576         For  further  information  about  partial matching, see the pcrepartial         For further information about partial  matching,  see  the  pcrepartial
577         documentation.         documentation.
578    
579    
580  CALLOUTS  CALLOUTS
581    
582         If the pattern contains any callout requests, pcretest's callout  func-         If  the pattern contains any callout requests, pcretest's callout func-
583         tion  is  called  during  matching. This works with both matching func-         tion is called during matching. This works  with  both  matching  func-
584         tions. By default, the called function displays the callout number, the         tions. By default, the called function displays the callout number, the
585         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
586         next pattern item to be tested. For example, the output         next pattern item to be tested. For example, the output
587    
588           --->pqrabcdef           --->pqrabcdef
589             0    ^  ^     \d             0    ^  ^     \d
590    
591         indicates that callout number 0 occurred for a match  attempt  starting         indicates  that  callout number 0 occurred for a match attempt starting
592         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
593         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
594         \d.  Just  one  circumflex is output if the start and current positions         \d. Just one circumflex is output if the start  and  current  positions
595         are the same.         are the same.
596    
597         Callouts numbered 255 are assumed to be automatic callouts, inserted as         Callouts numbered 255 are assumed to be automatic callouts, inserted as
598         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
599         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
600         output. For example:         output. For example:
601    
602             re> /\d?[A-E]\*/C             re> /\d?[A-E]\*/C
# Line 567  CALLOUTS Line 608  CALLOUTS
608           +10 ^ ^           +10 ^ ^
609            0: E*            0: E*
610    
611         The  callout  function  in pcretest returns zero (carry on matching) by         The callout function in pcretest returns zero (carry  on  matching)  by
612         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)
613         to change this.         to change this.
614    
615         Inserting  callouts can be helpful when using pcretest to check compli-         Inserting callouts can be helpful when using pcretest to check  compli-
616         cated regular expressions. For further information about callouts,  see         cated  regular expressions. For further information about callouts, see
617         the pcrecallout documentation.         the pcrecallout documentation.
618    
619    
620  NON-PRINTING CHARACTERS  NON-PRINTING CHARACTERS
621    
622         When  pcretest is outputting text in the compiled version of a pattern,         When pcretest is outputting text in the compiled version of a  pattern,
623         bytes other than 32-126 are always treated as  non-printing  characters         bytes  other  than 32-126 are always treated as non-printing characters
624         are are therefore shown as hex escapes.         are are therefore shown as hex escapes.
625    
626         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
627         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
628         set  for  the  pattern  (using  the  /L  modifier).  In  this case, the         set for the  pattern  (using  the  /L  modifier).  In  this  case,  the
629         isprint() function to distinguish printing and non-printing characters.         isprint() function to distinguish printing and non-printing characters.
630    
631    
632  SAVING AND RELOADING COMPILED PATTERNS  SAVING AND RELOADING COMPILED PATTERNS
633    
634         The facilities described in this section are  not  available  when  the         The  facilities  described  in  this section are not available when the
635         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-
636         ifier is specified.         ifier is specified.
637    
638         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
639         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
640         file name.  For example:         file name.  For example:
641    
642           /pattern/im >/some/file           /pattern/im >/some/file
643    
644         See the pcreprecompile documentation for a discussion about saving  and         See  the pcreprecompile documentation for a discussion about saving and
645         re-using compiled patterns.         re-using compiled patterns.
646    
647         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
648         length of the compiled pattern data  followed  by  the  length  of  the         length  of  the  compiled  pattern  data  followed by the length of the
649         optional  study  data,  each  written as four bytes in big-endian order         optional study data, each written as four  bytes  in  big-endian  order
650         (most significant byte first). If there is no study  data  (either  the         (most  significant  byte  first). If there is no study data (either the
651         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-
652         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
653         compiled pattern. If there is additional study data, this follows imme-         compiled pattern. If there is additional study data, this follows imme-
654         diately after the compiled pattern. After writing  the  file,  pcretest         diately  after  the  compiled pattern. After writing the file, pcretest
655         expects to read a new pattern.         expects to read a new pattern.
656    
657         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
658         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 <
659         character,  as  otherwise pcretest will interpret the line as a pattern         character, as otherwise pcretest will interpret the line as  a  pattern
660         delimited by < characters.  For example:         delimited by < characters.  For example:
661    
662            re> </some/file            re> </some/file
663           Compiled regex loaded from /some/file           Compiled regex loaded from /some/file
664           No study data           No study data
665    
666         When the pattern has been loaded, pcretest proceeds to read data  lines         When  the pattern has been loaded, pcretest proceeds to read data lines
667         in the usual way.         in the usual way.
668    
669         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
670         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
671         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
672         machine and run on a SPARC machine.         machine and run on a SPARC machine.
673    
674         File names for saving and reloading can be absolute  or  relative,  but         File  names  for  saving and reloading can be absolute or relative, but
675         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
676         a tilde (~) is not available.         a tilde (~) is not available.
677    
678         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-
679         ing  and experimentation. It is not intended for production use because         ing and experimentation. It is not intended for production use  because
680         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
681         no  facility  for  supplying  custom  character  tables  for use with a         no facility for supplying  custom  character  tables  for  use  with  a
682         reloaded pattern. If the original  pattern  was  compiled  with  custom         reloaded  pattern.  If  the  original  pattern was compiled with custom
683         tables,  an  attempt to match a subject string using a reloaded pattern         tables, an attempt to match a subject string using a  reloaded  pattern
684         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
685         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.
686    
687    
688  SEE ALSO  SEE ALSO
689    
690         pcre(3),  pcreapi(3),  pcrecallout(3), pcrematching(3), pcrepartial(d),         pcre(3), pcreapi(3), pcrecallout(3),  pcrematching(3),  pcrepartial(d),
691         pcrepattern(3), pcreprecompile(3).         pcrepattern(3), pcreprecompile(3).
692    
693    
# Line 659  AUTHOR Line 700  AUTHOR
700    
701  REVISION  REVISION
702    
703         Last updated: 29 August 2009         Last updated: 06 November 2010
704         Copyright (c) 1997-2009 University of Cambridge.         Copyright (c) 1997-2010 University of Cambridge.

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

  ViewVC Help
Powered by ViewVC 1.1.5