/[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 461 by ph10, Mon Oct 5 10:59:35 2009 UTC
# Line 196  PATTERN MODIFIERS Line 196  PATTERN MODIFIERS
196         or \B).         or \B).
197    
198         If  any  call  to  pcre_exec()  in a /g or /G sequence matches an empty         If  any  call  to  pcre_exec()  in a /g or /G sequence matches an empty
199         string, the next call is done with the PCRE_NOTEMPTY and  PCRE_ANCHORED         string, the next  call  is  done  with  the  PCRE_NOTEMPTY_ATSTART  and
200         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,
201         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
202         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
203         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
204           the split() function.
205    
206     Other modifiers     Other modifiers
207    
208         There are yet more modifiers for controlling the way pcretest operates.         There are yet more modifiers for controlling the way pcretest operates.
209    
210         The /+ modifier requests that as well as outputting the substring  that         The  /+ modifier requests that as well as outputting the substring that
211         matched  the  entire  pattern,  pcretest  should in addition output the         matched the entire pattern, pcretest  should  in  addition  output  the
212         remainder of the subject string. This is useful  for  tests  where  the         remainder  of  the  subject  string. This is useful for tests where the
213         subject contains multiple copies of the same substring.         subject contains multiple copies of the same substring.
214    
215         The  /B modifier is a debugging feature. It requests that pcretest out-         The /B modifier is a debugging feature. It requests that pcretest  out-
216         put a representation of the compiled byte code after compilation.  Nor-         put  a representation of the compiled byte code after compilation. Nor-
217         mally  this  information contains length and offset values; however, if         mally this information contains length and offset values;  however,  if
218         /Z is also present, this data is replaced by spaces. This is a  special         /Z  is also present, this data is replaced by spaces. This is a special
219         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
220         output is generated for different internal link sizes.         output is generated for different internal link sizes.
221    
222         The /L modifier must be followed directly by the name of a locale,  for         The  /L modifier must be followed directly by the name of a locale, for
223         example,         example,
224    
225           /pattern/Lfr_FR           /pattern/Lfr_FR
226    
227         For this reason, it must be the last modifier. The given locale is set,         For this reason, it must be the last modifier. The given locale is set,
228         pcre_maketables() is called to build a set of character tables for  the         pcre_maketables()  is called to build a set of character tables for the
229         locale,  and  this  is then passed to pcre_compile() when compiling the         locale, and this is then passed to pcre_compile()  when  compiling  the
230         regular expression. Without an /L  modifier,  NULL  is  passed  as  the         regular  expression.  Without  an  /L  modifier,  NULL is passed as the
231         tables  pointer; that is, /L applies only to the expression on which it         tables pointer; that is, /L applies only to the expression on which  it
232         appears.         appears.
233    
234         The /I modifier requests that pcretest  output  information  about  the         The  /I  modifier  requests  that pcretest output information about the
235         compiled  pattern (whether it is anchored, has a fixed first character,         compiled pattern (whether it is anchored, has a fixed first  character,
236         and so on). It does this by calling pcre_fullinfo() after  compiling  a         and  so  on). It does this by calling pcre_fullinfo() after compiling a
237         pattern.  If  the pattern is studied, the results of that are also out-         pattern. If the pattern is studied, the results of that are  also  out-
238         put.         put.
239    
240         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,
241         that is, both the /B and the /I modifiers.         that is, both the /B and the /I modifiers.
242    
243         The /F modifier causes pcretest to flip the byte order of the fields in         The /F modifier causes pcretest to flip the byte order of the fields in
244         the compiled pattern that  contain  2-byte  and  4-byte  numbers.  This         the  compiled  pattern  that  contain  2-byte  and 4-byte numbers. This
245         facility  is  for testing the feature in PCRE that allows it to execute         facility is for testing the feature in PCRE that allows it  to  execute
246         patterns that were compiled on a host with a different endianness. This         patterns that were compiled on a host with a different endianness. This
247         feature  is  not  available  when  the POSIX interface to PCRE is being         feature is not available when the POSIX  interface  to  PCRE  is  being
248         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
249         section about saving and reloading compiled patterns below.         section about saving and reloading compiled patterns below.
250    
251         The  /S  modifier causes pcre_study() to be called after the expression         The /S modifier causes pcre_study() to be called after  the  expression
252         has been compiled, and the results used when the expression is matched.         has been compiled, and the results used when the expression is matched.
253    
254         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-
255         piled pattern to be output.         piled pattern to be output.
256    
257         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
258         rather than its native API. When this  is  done,  all  other  modifiers         rather  than  its  native  API.  When this is done, all other modifiers
259         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,
260         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
261         PCRE_DOLLAR_ENDONLY always, and PCRE_DOTALL unless REG_NEWLINE is set.         PCRE_DOLLAR_ENDONLY always, and PCRE_DOTALL unless REG_NEWLINE is set.
262    
263         The  /8 modifier causes pcretest to call PCRE with the PCRE_UTF8 option         The /8 modifier causes pcretest to call PCRE with the PCRE_UTF8  option
264         set. This turns on support for UTF-8 character handling in  PCRE,  pro-         set.  This  turns on support for UTF-8 character handling in PCRE, pro-
265         vided  that  it  was  compiled with this support enabled. This modifier         vided that it was compiled with this  support  enabled.  This  modifier
266         also causes any non-printing characters in output strings to be printed         also causes any non-printing characters in output strings to be printed
267         using the \x{hh...} notation if they are valid UTF-8 sequences.         using the \x{hh...} notation if they are valid UTF-8 sequences.
268    
269         If  the  /?  modifier  is  used  with  /8,  it  causes pcretest to call         If the /? modifier  is  used  with  /8,  it  causes  pcretest  to  call
270         pcre_compile() with the  PCRE_NO_UTF8_CHECK  option,  to  suppress  the         pcre_compile()  with  the  PCRE_NO_UTF8_CHECK  option,  to suppress the
271         checking of the string for UTF-8 validity.         checking of the string for UTF-8 validity.
272    
273    
274  DATA LINES  DATA LINES
275    
276         Before  each  data  line is passed to pcre_exec(), leading and trailing         Before each data line is passed to pcre_exec(),  leading  and  trailing
277         whitespace is removed, and it is then scanned for \  escapes.  Some  of         whitespace  is  removed,  and it is then scanned for \ escapes. Some of
278         these  are  pretty esoteric features, intended for checking out some of         these are pretty esoteric features, intended for checking out  some  of
279         the more complicated features of PCRE. If you are just  testing  "ordi-         the  more  complicated features of PCRE. If you are just testing "ordi-
280         nary"  regular  expressions,  you probably don't need any of these. The         nary" regular expressions, you probably don't need any  of  these.  The
281         following escapes are recognized:         following escapes are recognized:
282    
283           \a         alarm (BEL, \x07)           \a         alarm (BEL, \x07)
# Line 323  DATA LINES Line 324  DATA LINES
324           \M         discover the minimum MATCH_LIMIT and           \M         discover the minimum MATCH_LIMIT and
325                        MATCH_LIMIT_RECURSION settings                        MATCH_LIMIT_RECURSION settings
326           \N         pass the PCRE_NOTEMPTY option to pcre_exec()           \N         pass the PCRE_NOTEMPTY option to pcre_exec()
327                        or pcre_dfa_exec()                        or pcre_dfa_exec(); if used twice, pass the
328                          PCRE_NOTEMPTY_ATSTART option
329           \Odd       set the size of the output vector passed to           \Odd       set the size of the output vector passed to
330                        pcre_exec() to dd (any number of digits)                        pcre_exec() to dd (any number of digits)
331           \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 335  DATA LINES
335                        (any number of digits)                        (any number of digits)
336           \R         pass the PCRE_DFA_RESTART option to pcre_dfa_exec()           \R         pass the PCRE_DFA_RESTART option to pcre_dfa_exec()
337           \S         output details of memory get/free calls during matching           \S         output details of memory get/free calls during matching
338             \Y         pass the PCRE_NO_START_OPTIMIZE option to pcre_exec()
339                          or pcre_dfa_exec()
340           \Z         pass the PCRE_NOTEOL option to pcre_exec()           \Z         pass the PCRE_NOTEOL option to pcre_exec()
341                        or pcre_dfa_exec()                        or pcre_dfa_exec()
342           \?         pass the PCRE_NO_UTF8_CHECK option to           \?         pass the PCRE_NO_UTF8_CHECK option to
# Line 351  DATA LINES Line 355  DATA LINES
355           \<any>     pass the PCRE_NEWLINE_ANY option to pcre_exec()           \<any>     pass the PCRE_NEWLINE_ANY option to pcre_exec()
356                        or pcre_dfa_exec()                        or pcre_dfa_exec()
357    
358         The escapes that specify line ending  sequences  are  literal  strings,         The  escapes  that  specify  line ending sequences are literal strings,
359         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
360         any data line.         any data line.
361    
362         A backslash followed by anything else just escapes the  anything  else.         A  backslash  followed by anything else just escapes the anything else.
363         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
364         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-
365         nates the data input.         nates the data input.
366    
367         If  \M  is present, pcretest calls pcre_exec() several times, with dif-         If \M is present, pcretest calls pcre_exec() several times,  with  dif-
368         ferent values in the match_limit and  match_limit_recursion  fields  of         ferent  values  in  the match_limit and match_limit_recursion fields of
369         the  pcre_extra  data structure, until it finds the minimum numbers for         the pcre_extra data structure, until it finds the minimum  numbers  for
370         each parameter that allow pcre_exec() to complete. The match_limit num-         each parameter that allow pcre_exec() to complete. The match_limit num-
371         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
372         checking it out can be instructive. For most simple matches, the number         checking it out can be instructive. For most simple matches, the number
373         is  quite  small,  but for patterns with very large numbers of matching         is quite small, but for patterns with very large  numbers  of  matching
374         possibilities, it can become large very quickly with increasing  length         possibilities,  it can become large very quickly with increasing length
375         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
376         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)
377         memory is needed to complete the match attempt.         memory is needed to complete the match attempt.
378    
379         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
380         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
381         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.
382    
383         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-
384         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
385         effect  are \B and \Z, causing REG_NOTBOL and REG_NOTEOL, respectively,         effect are \B and \Z, causing REG_NOTBOL and REG_NOTEOL,  respectively,
386         to be passed to regexec().         to be passed to regexec().
387    
388         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
389         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.
390         There may be any number of hexadecimal digits inside  the  braces.  The         There  may  be  any number of hexadecimal digits inside the braces. The
391         result  is  from  one  to  six bytes, encoded according to the original         result is from one to six bytes,  encoded  according  to  the  original
392         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
393         0x7FFFFFFF.  Note  that not all of those are valid Unicode code points,         0x7FFFFFFF. Note that not all of those are valid Unicode  code  points,
394         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
395         3629.         3629.
396    
397    
398  THE ALTERNATIVE MATCHING FUNCTION  THE ALTERNATIVE MATCHING FUNCTION
399    
400         By   default,  pcretest  uses  the  standard  PCRE  matching  function,         By  default,  pcretest  uses  the  standard  PCRE  matching   function,
401         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
402         alternative  matching  function,  pcre_dfa_test(),  which operates in a         alternative matching function, pcre_dfa_test(),  which  operates  in  a
403         different way, and has some restrictions. The differences  between  the         different  way,  and has some restrictions. The differences between the
404         two functions are described in the pcrematching documentation.         two functions are described in the pcrematching documentation.
405    
406         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
407         contains the -dfa option, the alternative matching function is  called.         contains  the -dfa option, the alternative matching function is called.
408         This function finds all possible matches at a given point. If, however,         This function finds all possible matches at a given point. If, however,
409         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
410         first match is found. This is always the shortest possible match.         first match is found. This is always the shortest possible match.
411    
412    
413  DEFAULT OUTPUT FROM PCRETEST  DEFAULT OUTPUT FROM PCRETEST
414    
415         This  section  describes  the output when the normal matching function,         This section describes the output when the  normal  matching  function,
416         pcre_exec(), is being used.         pcre_exec(), is being used.
417    
418         When a match succeeds, pcretest outputs the list of captured substrings         When a match succeeds, pcretest outputs the list of captured substrings
419         that  pcre_exec()  returns,  starting with number 0 for the string that         that pcre_exec() returns, starting with number 0 for  the  string  that
420         matched the whole pattern. Otherwise, it outputs "No match" or "Partial         matched  the  whole  pattern. Otherwise, it outputs "No match" when the
421         match:"  followed  by the partially matching substring when pcre_exec()         return is PCRE_ERROR_NOMATCH, and "Partial match:" followed by the par-
422         returns PCRE_ERROR_NOMATCH  or  PCRE_ERROR_PARTIAL,  respectively,  and         tially  matching substring when pcre_exec() returns PCRE_ERROR_PARTIAL.
423         otherwise  the  PCRE  negative  error  number. Here is an example of an         For any other returns, it outputs the PCRE negative error number.  Here
424         interactive pcretest run.         is an example of an interactive pcretest run.
425    
426           $ pcretest           $ pcretest
427           PCRE version 7.0 30-Nov-2006           PCRE version 7.0 30-Nov-2006
# Line 429  DEFAULT OUTPUT FROM PCRETEST Line 433  DEFAULT OUTPUT FROM PCRETEST
433           data> xyz           data> xyz
434           No match           No match
435    
436         Note that unset capturing substrings that are not followed by one  that         Note  that unset capturing substrings that are not followed by one that
437         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.
438         In the following example, there are two capturing substrings, but  when         In  the following example, there are two capturing substrings, but when
439         the  first  data  line  is  matched, the second, unset substring is not         the first data line is matched, the  second,  unset  substring  is  not
440         shown. An "internal" unset substring is shown as "<unset>", as for  the         shown.  An "internal" unset substring is shown as "<unset>", as for the
441         second data line.         second data line.
442    
443             re> /(a)|(b)/             re> /(a)|(b)/
# Line 445  DEFAULT OUTPUT FROM PCRETEST Line 449  DEFAULT OUTPUT FROM PCRETEST
449            1: <unset>            1: <unset>
450            2: b            2: b
451    
452         If  the strings contain any non-printing characters, they are output as         If the strings contain any non-printing characters, they are output  as
453         \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
454         the  pattern.  See below for the definition of non-printing characters.         the pattern. See below for the definition of  non-printing  characters.
455         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-
456         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
457         this:         this:
458    
459             re> /cat/+             re> /cat/+
# Line 457  DEFAULT OUTPUT FROM PCRETEST Line 461  DEFAULT OUTPUT FROM PCRETEST
461            0: cat            0: cat
462            0+ aract            0+ aract
463    
464         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
465         matching attempts are output in sequence, like this:         matching attempts are output in sequence, like this:
466    
467             re> /\Bi(\w\w)/g             re> /\Bi(\w\w)/g
# Line 471  DEFAULT OUTPUT FROM PCRETEST Line 475  DEFAULT OUTPUT FROM PCRETEST
475    
476         "No match" is output only if the first match attempt fails.         "No match" is output only if the first match attempt fails.
477    
478         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
479         is successfully matched, the substrings extracted  by  the  convenience         is  successfully  matched,  the substrings extracted by the convenience
480         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
481         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
482         (that  is,  the return from the extraction function) is given in paren-         (that is, the return from the extraction function) is given  in  paren-
483         theses after each string for \C and \G.         theses after each string for \C and \G.
484    
485         Note that whereas patterns can be continued over several lines (a plain         Note that whereas patterns can be continued over several lines (a plain
486         ">" prompt is used for continuations), data lines may not. However new-         ">" prompt is used for continuations), data lines may not. However new-
487         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,
488         etc., depending on the newline sequence setting).         etc., depending on the newline sequence setting).
489    
490    
491  OUTPUT FROM THE ALTERNATIVE MATCHING FUNCTION  OUTPUT FROM THE ALTERNATIVE MATCHING FUNCTION
492    
493         When  the  alternative  matching function, pcre_dfa_exec(), is used (by         When the alternative matching function, pcre_dfa_exec(),  is  used  (by
494         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
495         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
496         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:
497    
498             re> /(tang|tangerine|tan)/             re> /(tang|tangerine|tan)/
# Line 497  OUTPUT FROM THE ALTERNATIVE MATCHING FUN Line 501  OUTPUT FROM THE ALTERNATIVE MATCHING FUN
501            1: tang            1: tang
502            2: tan            2: tan
503    
504         (Using the normal matching function on this data  finds  only  "tang".)         (Using  the  normal  matching function on this data finds only "tang".)
505         The  longest matching string is always given first (and numbered zero).         The longest matching string is always given first (and numbered  zero).
506         After a PCRE_ERROR_PARTIAL return, the output is "Partial match:", fol-         After a PCRE_ERROR_PARTIAL return, the output is "Partial match:", fol-
507         lowed by the partially matching substring.         lowed by the partially matching substring.
508    
# Line 514  OUTPUT FROM THE ALTERNATIVE MATCHING FUN Line 518  OUTPUT FROM THE ALTERNATIVE MATCHING FUN
518            1: tan            1: tan
519            0: tan            0: tan
520    
521         Since the matching function does not  support  substring  capture,  the         Since  the  matching  function  does not support substring capture, the
522         escape  sequences  that  are concerned with captured substrings are not         escape sequences that are concerned with captured  substrings  are  not
523         relevant.         relevant.
524    
525    
526  RESTARTING AFTER A PARTIAL MATCH  RESTARTING AFTER A PARTIAL MATCH
527    
528         When the alternative matching function has given the PCRE_ERROR_PARTIAL         When the alternative matching function has given the PCRE_ERROR_PARTIAL
529         return,  indicating that the subject partially matched the pattern, you         return, indicating that the subject partially matched the pattern,  you
530         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
531         escape sequence. For example:         escape sequence. For example:
532    
533             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 536  RESTARTING AFTER A PARTIAL MATCH
536           data> n05\R\D           data> n05\R\D
537            0: n05            0: n05
538    
539         For  further  information  about  partial matching, see the pcrepartial         For further information about partial  matching,  see  the  pcrepartial
540         documentation.         documentation.
541    
542    
543  CALLOUTS  CALLOUTS
544    
545         If the pattern contains any callout requests, pcretest's callout  func-         If  the pattern contains any callout requests, pcretest's callout func-
546         tion  is  called  during  matching. This works with both matching func-         tion is called during matching. This works  with  both  matching  func-
547         tions. By default, the called function displays the callout number, the         tions. By default, the called function displays the callout number, the
548         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
549         next pattern item to be tested. For example, the output         next pattern item to be tested. For example, the output
550    
551           --->pqrabcdef           --->pqrabcdef
552             0    ^  ^     \d             0    ^  ^     \d
553    
554         indicates that callout number 0 occurred for a match  attempt  starting         indicates  that  callout number 0 occurred for a match attempt starting
555         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
556         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
557         \d.  Just  one  circumflex is output if the start and current positions         \d. Just one circumflex is output if the start  and  current  positions
558         are the same.         are the same.
559    
560         Callouts numbered 255 are assumed to be automatic callouts, inserted as         Callouts numbered 255 are assumed to be automatic callouts, inserted as
561         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
562         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
563         output. For example:         output. For example:
564    
565             re> /\d?[A-E]\*/C             re> /\d?[A-E]\*/C
# Line 567  CALLOUTS Line 571  CALLOUTS
571           +10 ^ ^           +10 ^ ^
572            0: E*            0: E*
573    
574         The  callout  function  in pcretest returns zero (carry on matching) by         The callout function in pcretest returns zero (carry  on  matching)  by
575         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)
576         to change this.         to change this.
577    
578         Inserting  callouts can be helpful when using pcretest to check compli-         Inserting callouts can be helpful when using pcretest to check  compli-
579         cated regular expressions. For further information about callouts,  see         cated  regular expressions. For further information about callouts, see
580         the pcrecallout documentation.         the pcrecallout documentation.
581    
582    
583  NON-PRINTING CHARACTERS  NON-PRINTING CHARACTERS
584    
585         When  pcretest is outputting text in the compiled version of a pattern,         When pcretest is outputting text in the compiled version of a  pattern,
586         bytes other than 32-126 are always treated as  non-printing  characters         bytes  other  than 32-126 are always treated as non-printing characters
587         are are therefore shown as hex escapes.         are are therefore shown as hex escapes.
588    
589         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
590         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
591         set  for  the  pattern  (using  the  /L  modifier).  In  this case, the         set for the  pattern  (using  the  /L  modifier).  In  this  case,  the
592         isprint() function to distinguish printing and non-printing characters.         isprint() function to distinguish printing and non-printing characters.
593    
594    
595  SAVING AND RELOADING COMPILED PATTERNS  SAVING AND RELOADING COMPILED PATTERNS
596    
597         The facilities described in this section are  not  available  when  the         The  facilities  described  in  this section are not available when the
598         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-
599         ifier is specified.         ifier is specified.
600    
601         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
602         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
603         file name.  For example:         file name.  For example:
604    
605           /pattern/im >/some/file           /pattern/im >/some/file
606    
607         See the pcreprecompile documentation for a discussion about saving  and         See  the pcreprecompile documentation for a discussion about saving and
608         re-using compiled patterns.         re-using compiled patterns.
609    
610         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
611         length of the compiled pattern data  followed  by  the  length  of  the         length  of  the  compiled  pattern  data  followed by the length of the
612         optional  study  data,  each  written as four bytes in big-endian order         optional study data, each written as four  bytes  in  big-endian  order
613         (most significant byte first). If there is no study  data  (either  the         (most  significant  byte  first). If there is no study data (either the
614         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-
615         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
616         compiled pattern. If there is additional study data, this follows imme-         compiled pattern. If there is additional study data, this follows imme-
617         diately after the compiled pattern. After writing  the  file,  pcretest         diately  after  the  compiled pattern. After writing the file, pcretest
618         expects to read a new pattern.         expects to read a new pattern.
619    
620         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
621         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 <
622         character,  as  otherwise pcretest will interpret the line as a pattern         character, as otherwise pcretest will interpret the line as  a  pattern
623         delimited by < characters.  For example:         delimited by < characters.  For example:
624    
625            re> </some/file            re> </some/file
626           Compiled regex loaded from /some/file           Compiled regex loaded from /some/file
627           No study data           No study data
628    
629         When the pattern has been loaded, pcretest proceeds to read data  lines         When  the pattern has been loaded, pcretest proceeds to read data lines
630         in the usual way.         in the usual way.
631    
632         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
633         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
634         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
635         machine and run on a SPARC machine.         machine and run on a SPARC machine.
636    
637         File names for saving and reloading can be absolute  or  relative,  but         File  names  for  saving and reloading can be absolute or relative, but
638         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
639         a tilde (~) is not available.         a tilde (~) is not available.
640    
641         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-
642         ing  and experimentation. It is not intended for production use because         ing and experimentation. It is not intended for production use  because
643         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
644         no  facility  for  supplying  custom  character  tables  for use with a         no facility for supplying  custom  character  tables  for  use  with  a
645         reloaded pattern. If the original  pattern  was  compiled  with  custom         reloaded  pattern.  If  the  original  pattern was compiled with custom
646         tables,  an  attempt to match a subject string using a reloaded pattern         tables, an attempt to match a subject string using a  reloaded  pattern
647         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
648         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.
649    
650    
651  SEE ALSO  SEE ALSO
652    
653         pcre(3),  pcreapi(3),  pcrecallout(3), pcrematching(3), pcrepartial(d),         pcre(3), pcreapi(3), pcrecallout(3),  pcrematching(3),  pcrepartial(d),
654         pcrepattern(3), pcreprecompile(3).         pcrepattern(3), pcreprecompile(3).
655    
656    
# Line 659  AUTHOR Line 663  AUTHOR
663    
664  REVISION  REVISION
665    
666         Last updated: 29 August 2009         Last updated: 26 September 2009
667         Copyright (c) 1997-2009 University of Cambridge.         Copyright (c) 1997-2009 University of Cambridge.

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

  ViewVC Help
Powered by ViewVC 1.1.5