/[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 96 by nigel, Fri Mar 2 13:10:43 2007 UTC revision 231 by ph10, Tue Sep 11 11:15:33 2007 UTC
# Line 146  PATTERN MODIFIERS Line 146  PATTERN MODIFIERS
146         The following table shows additional modifiers for setting PCRE options         The following table shows additional modifiers for setting PCRE options
147         that do not correspond to anything in Perl:         that do not correspond to anything in Perl:
148    
149           /A       PCRE_ANCHORED           /A              PCRE_ANCHORED
150           /C       PCRE_AUTO_CALLOUT           /C              PCRE_AUTO_CALLOUT
151           /E       PCRE_DOLLAR_ENDONLY           /E              PCRE_DOLLAR_ENDONLY
152           /f       PCRE_FIRSTLINE           /f              PCRE_FIRSTLINE
153           /J       PCRE_DUPNAMES           /J              PCRE_DUPNAMES
154           /N       PCRE_NO_AUTO_CAPTURE           /N              PCRE_NO_AUTO_CAPTURE
155           /U       PCRE_UNGREEDY           /U              PCRE_UNGREEDY
156           /X       PCRE_EXTRA           /X              PCRE_EXTRA
157           /<cr>    PCRE_NEWLINE_CR           /<cr>           PCRE_NEWLINE_CR
158           /<lf>    PCRE_NEWLINE_LF           /<lf>           PCRE_NEWLINE_LF
159           /<crlf>  PCRE_NEWLINE_CRLF           /<crlf>         PCRE_NEWLINE_CRLF
160           /<any>   PCRE_NEWLINE_ANY           /<anycrlf>      PCRE_NEWLINE_ANYCRLF
161             /<any>          PCRE_NEWLINE_ANY
162         Those  specifying  line ending sequencess are literal strings as shown.           /<bsr_anycrlf>  PCRE_BSR_ANYCRLF
163         This example sets multiline matching  with  CRLF  as  the  line  ending           /<bsr_unicode>  PCRE_BSR_UNICODE
164         sequence:  
165           Those  specifying  line  ending sequences are literal strings as shown,
166           but the letters can be in either  case.  This  example  sets  multiline
167           matching with CRLF as the line ending sequence:
168    
169           /^abc/m<crlf>           /^abc/m<crlf>
170    
# Line 197  PATTERN MODIFIERS Line 200  PATTERN MODIFIERS
200         subject contains multiple copies of the same substring.         subject contains multiple copies of the same substring.
201    
202         The  /B modifier is a debugging feature. It requests that pcretest out-         The  /B modifier is a debugging feature. It requests that pcretest out-
203         put a representation of the compiled byte code after compilation.         put a representation of the compiled byte code after compilation.  Nor-
204           mally  this  information contains length and offset values; however, if
205           /Z is also present, this data is replaced by spaces. This is a  special
206           feature for use in the automatic test scripts; it ensures that the same
207           output is generated for different internal link sizes.
208    
209         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
210         example,         example,
# Line 326  DATA LINES Line 333  DATA LINES
333                        or pcre_dfa_exec()                        or pcre_dfa_exec()
334           \<crlf>    pass the PCRE_NEWLINE_CRLF option to pcre_exec()           \<crlf>    pass the PCRE_NEWLINE_CRLF option to pcre_exec()
335                        or pcre_dfa_exec()                        or pcre_dfa_exec()
336             \<anycrlf> pass the PCRE_NEWLINE_ANYCRLF option to pcre_exec()
337                          or pcre_dfa_exec()
338           \<any>     pass the PCRE_NEWLINE_ANY option to pcre_exec()           \<any>     pass the PCRE_NEWLINE_ANY option to pcre_exec()
339                        or pcre_dfa_exec()                        or pcre_dfa_exec()
340    
# Line 362  DATA LINES Line 371  DATA LINES
371         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
372         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.
373         There may be any number of hexadecimal digits inside  the  braces.  The         There may be any number of hexadecimal digits inside  the  braces.  The
374         result  is from one to six bytes, encoded according to the UTF-8 rules.         result  is  from  one  to  six bytes, encoded according to the original
375           UTF-8 rules of RFC 2279. This allows for  values  in  the  range  0  to
376           0x7FFFFFFF.  Note  that not all of those are valid Unicode code points,
377           or indeed valid UTF-8 characters according to the later  rules  in  RFC
378           3629.
379    
380    
381  THE ALTERNATIVE MATCHING FUNCTION  THE ALTERNATIVE MATCHING FUNCTION
382    
383         By  default,  pcretest  uses  the  standard  PCRE  matching   function,         By   default,  pcretest  uses  the  standard  PCRE  matching  function,
384         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
385         alternative matching function, pcre_dfa_test(),  which  operates  in  a         alternative  matching  function,  pcre_dfa_test(),  which operates in a
386         different  way,  and has some restrictions. The differences between the         different way, and has some restrictions. The differences  between  the
387         two functions are described in the pcrematching documentation.         two functions are described in the pcrematching documentation.
388    
389         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
390         contains  the -dfa option, the alternative matching function is called.         contains the -dfa option, the alternative matching function is  called.
391         This function finds all possible matches at a given point. If, however,         This function finds all possible matches at a given point. If, however,
392         the  \F escape sequence is present in the data line, it stops after the         the \F escape sequence is present in the data line, it stops after  the
393         first match is found. This is always the shortest possible match.         first match is found. This is always the shortest possible match.
394    
395    
396  DEFAULT OUTPUT FROM PCRETEST  DEFAULT OUTPUT FROM PCRETEST
397    
398         This section describes the output when the  normal  matching  function,         This  section  describes  the output when the normal matching function,
399         pcre_exec(), is being used.         pcre_exec(), is being used.
400    
401         When a match succeeds, pcretest outputs the list of captured substrings         When a match succeeds, pcretest outputs the list of captured substrings
402         that pcre_exec() returns, starting with number 0 for  the  string  that         that  pcre_exec()  returns,  starting with number 0 for the string that
403         matched the whole pattern. Otherwise, it outputs "No match" or "Partial         matched the whole pattern. Otherwise, it outputs "No match" or "Partial
404         match" when pcre_exec() returns PCRE_ERROR_NOMATCH  or  PCRE_ERROR_PAR-         match"  when  pcre_exec() returns PCRE_ERROR_NOMATCH or PCRE_ERROR_PAR-
405         TIAL,  respectively, and otherwise the PCRE negative error number. Here         TIAL, respectively, and otherwise the PCRE negative error number.  Here
406         is an example of an interactive pcretest run.         is an example of an interactive pcretest run.
407    
408           $ pcretest           $ pcretest
# Line 402  DEFAULT OUTPUT FROM PCRETEST Line 415  DEFAULT OUTPUT FROM PCRETEST
415           data> xyz           data> xyz
416           No match           No match
417    
418         If the strings contain any non-printing characters, they are output  as         If  the strings contain any non-printing characters, they are output as
419         \0x  escapes,  or  as \x{...} escapes if the /8 modifier was present on         \0x escapes, or as \x{...} escapes if the /8 modifier  was  present  on
420         the pattern. See below for the definition of  non-printing  characters.         the  pattern.  See below for the definition of non-printing characters.
421         If  the pattern has the /+ modifier, the output for substring 0 is fol-         If the pattern has the /+ modifier, the output for substring 0 is  fol-
422         lowed by the the rest of the subject string, identified  by  "0+"  like         lowed  by  the  the rest of the subject string, identified by "0+" like
423         this:         this:
424    
425             re> /cat/+             re> /cat/+
# Line 414  DEFAULT OUTPUT FROM PCRETEST Line 427  DEFAULT OUTPUT FROM PCRETEST
427            0: cat            0: cat
428            0+ aract            0+ aract
429    
430         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
431         matching attempts are output in sequence, like this:         matching attempts are output in sequence, like this:
432    
433             re> /\Bi(\w\w)/g             re> /\Bi(\w\w)/g
# Line 428  DEFAULT OUTPUT FROM PCRETEST Line 441  DEFAULT OUTPUT FROM PCRETEST
441    
442         "No match" is output only if the first match attempt fails.         "No match" is output only if the first match attempt fails.
443    
444         If any of the sequences \C, \G, or \L are present in a data  line  that         If  any  of the sequences \C, \G, or \L are present in a data line that
445         is  successfully  matched,  the substrings extracted by the convenience         is successfully matched, the substrings extracted  by  the  convenience
446         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
447         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
448         (that is, the return from the extraction function) is given  in  paren-         (that  is,  the return from the extraction function) is given in paren-
449         theses after each string for \C and \G.         theses after each string for \C and \G.
450    
451         Note that whereas patterns can be continued over several lines (a plain         Note that whereas patterns can be continued over several lines (a plain
452         ">" prompt is used for continuations), data lines may not. However new-         ">" prompt is used for continuations), data lines may not. However new-
453         lines  can  be included in data by means of the \n escape (or \r, \r\n,         lines can be included in data by means of the \n escape (or  \r,  \r\n,
454         etc., depending on the newline sequence setting).         etc., depending on the newline sequence setting).
455    
456    
457  OUTPUT FROM THE ALTERNATIVE MATCHING FUNCTION  OUTPUT FROM THE ALTERNATIVE MATCHING FUNCTION
458    
459         When the alternative matching function, pcre_dfa_exec(),  is  used  (by         When  the  alternative  matching function, pcre_dfa_exec(), is used (by
460         means  of  the \D escape sequence or the -dfa command line option), the         means of the \D escape sequence or the -dfa command line  option),  the
461         output consists of a list of all the matches that start  at  the  first         output  consists  of  a list of all the matches that start at the first
462         point in the subject where there is at least one match. For example:         point in the subject where there is at least one match. For example:
463    
464             re> /(tang|tangerine|tan)/             re> /(tang|tangerine|tan)/
# Line 454  OUTPUT FROM THE ALTERNATIVE MATCHING FUN Line 467  OUTPUT FROM THE ALTERNATIVE MATCHING FUN
467            1: tang            1: tang
468            2: tan            2: tan
469    
470         (Using  the  normal  matching function on this data finds only "tang".)         (Using the normal matching function on this data  finds  only  "tang".)
471         The longest matching string is always given first (and numbered  zero).         The  longest matching string is always given first (and numbered zero).
472    
473         If /g is present on the pattern, the search for further matches resumes         If /g is present on the pattern, the search for further matches resumes
474         at the end of the longest match. For example:         at the end of the longest match. For example:
# Line 469  OUTPUT FROM THE ALTERNATIVE MATCHING FUN Line 482  OUTPUT FROM THE ALTERNATIVE MATCHING FUN
482            1: tan            1: tan
483            0: tan            0: tan
484    
485         Since the matching function does not  support  substring  capture,  the         Since  the  matching  function  does not support substring capture, the
486         escape  sequences  that  are concerned with captured substrings are not         escape sequences that are concerned with captured  substrings  are  not
487         relevant.         relevant.
488    
489    
490  RESTARTING AFTER A PARTIAL MATCH  RESTARTING AFTER A PARTIAL MATCH
491    
492         When the alternative matching function has given the PCRE_ERROR_PARTIAL         When the alternative matching function has given the PCRE_ERROR_PARTIAL
493         return,  indicating that the subject partially matched the pattern, you         return, indicating that the subject partially matched the pattern,  you
494         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
495         escape sequence. For example:         escape sequence. For example:
496    
497             re> /^?(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)$/             re> /^\d?\d(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)\d\d$/
498           data> 23ja\P\D           data> 23ja\P\D
499           Partial match: 23ja           Partial match: 23ja
500           data> n05\R\D           data> n05\R\D
501            0: n05            0: n05
502    
503         For  further  information  about  partial matching, see the pcrepartial         For further information about partial  matching,  see  the  pcrepartial
504         documentation.         documentation.
505    
506    
507  CALLOUTS  CALLOUTS
508    
509         If the pattern contains any callout requests, pcretest's callout  func-         If  the pattern contains any callout requests, pcretest's callout func-
510         tion  is  called  during  matching. This works with both matching func-         tion is called during matching. This works  with  both  matching  func-
511         tions. By default, the called function displays the callout number, the         tions. By default, the called function displays the callout number, the
512         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
513         next pattern item to be tested. For example, the output         next pattern item to be tested. For example, the output
514    
515           --->pqrabcdef           --->pqrabcdef
516             0    ^  ^     \d             0    ^  ^     \d
517    
518         indicates that callout number 0 occurred for a match  attempt  starting         indicates  that  callout number 0 occurred for a match attempt starting
519         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
520         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
521         \d.  Just  one  circumflex is output if the start and current positions         \d. Just one circumflex is output if the start  and  current  positions
522         are the same.         are the same.
523    
524         Callouts numbered 255 are assumed to be automatic callouts, inserted as         Callouts numbered 255 are assumed to be automatic callouts, inserted as
525         a  result  of the /C pattern modifier. In this case, instead of showing         a result of the /C pattern modifier. In this case, instead  of  showing
526         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
527         output. For example:         output. For example:
528    
529             re> /\d?[A-E]\*/C             re> /\d?[A-E]\*/C
# Line 522  CALLOUTS Line 535  CALLOUTS
535           +10 ^ ^           +10 ^ ^
536            0: E*            0: E*
537    
538         The  callout  function  in pcretest returns zero (carry on matching) by         The callout function in pcretest returns zero (carry  on  matching)  by
539         default, but you can use a \C item in a data line (as described  above)         default,  but you can use a \C item in a data line (as described above)
540         to change this.         to change this.
541    
542         Inserting  callouts can be helpful when using pcretest to check compli-         Inserting callouts can be helpful when using pcretest to check  compli-
543         cated regular expressions. For further information about callouts,  see         cated  regular expressions. For further information about callouts, see
544         the pcrecallout documentation.         the pcrecallout documentation.
545    
546    
547  NON-PRINTING CHARACTERS  NON-PRINTING CHARACTERS
548    
549         When  pcretest is outputting text in the compiled version of a pattern,         When pcretest is outputting text in the compiled version of a  pattern,
550         bytes other than 32-126 are always treated as  non-printing  characters         bytes  other  than 32-126 are always treated as non-printing characters
551         are are therefore shown as hex escapes.         are are therefore shown as hex escapes.
552    
553         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
554         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
555         set  for  the  pattern  (using  the  /L  modifier).  In  this case, the         set for the  pattern  (using  the  /L  modifier).  In  this  case,  the
556         isprint() function to distinguish printing and non-printing characters.         isprint() function to distinguish printing and non-printing characters.
557    
558    
559  SAVING AND RELOADING COMPILED PATTERNS  SAVING AND RELOADING COMPILED PATTERNS
560    
561         The  facilities  described  in  this section are not available when the         The facilities described in this section are  not  available  when  the
562         POSIX inteface to PCRE is being used, that is, when the /P pattern mod-         POSIX inteface to PCRE is being used, that is, when the /P pattern mod-
563         ifier is specified.         ifier is specified.
564    
565         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
566         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
567         file name.  For example:         file name.  For example:
568    
569           /pattern/im >/some/file           /pattern/im >/some/file
570    
571         See  the pcreprecompile documentation for a discussion about saving and         See the pcreprecompile documentation for a discussion about saving  and
572         re-using compiled patterns.         re-using compiled patterns.
573    
574         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
575         length  of  the  compiled  pattern  data  followed by the length of the         length of the compiled pattern data  followed  by  the  length  of  the
576         optional study data, each written as four  bytes  in  big-endian  order         optional  study  data,  each  written as four bytes in big-endian order
577         (most  significant  byte  first). If there is no study data (either the         (most significant byte first). If there is no study  data  (either  the
578         pattern was not studied, or studying did not return any data), the sec-         pattern was not studied, or studying did not return any data), the sec-
579         ond  length  is  zero. The lengths are followed by an exact copy of the         ond length is zero. The lengths are followed by an exact  copy  of  the
580         compiled pattern. If there is additional study data, this follows imme-         compiled pattern. If there is additional study data, this follows imme-
581         diately  after  the  compiled pattern. After writing the file, pcretest         diately after the compiled pattern. After writing  the  file,  pcretest
582         expects to read a new pattern.         expects to read a new pattern.
583    
584         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
585         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  <
586         character, as otherwise pcretest will interpret the line as  a  pattern         character,  as  otherwise pcretest will interpret the line as a pattern
587         delimited by < characters.  For example:         delimited by < characters.  For example:
588    
589            re> </some/file            re> </some/file
590           Compiled regex loaded from /some/file           Compiled regex loaded from /some/file
591           No study data           No study data
592    
593         When  the pattern has been loaded, pcretest proceeds to read data lines         When the pattern has been loaded, pcretest proceeds to read data  lines
594         in the usual way.         in the usual way.
595    
596         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
597         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
598         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
599         machine and run on a SPARC machine.         machine and run on a SPARC machine.
600    
601         File  names  for  saving and reloading can be absolute or relative, but         File names for saving and reloading can be absolute  or  relative,  but
602         note that the shell facility of expanding a file name that starts  with         note  that the shell facility of expanding a file name that starts with
603         a tilde (~) is not available.         a tilde (~) is not available.
604    
605         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-
606         ing and experimentation. It is not intended for production use  because         ing  and experimentation. It is not intended for production use because
607         only  a  single pattern can be written to a file. Furthermore, there is         only a single pattern can be written to a file. Furthermore,  there  is
608         no facility for supplying  custom  character  tables  for  use  with  a         no  facility  for  supplying  custom  character  tables  for use with a
609         reloaded  pattern.  If  the  original  pattern was compiled with custom         reloaded pattern. If the original  pattern  was  compiled  with  custom
610         tables, an attempt to match a subject string using a  reloaded  pattern         tables,  an  attempt to match a subject string using a reloaded pattern
611         is  likely to cause pcretest to crash.  Finally, if you attempt to load         is likely to cause pcretest to crash.  Finally, if you attempt to  load
612         a file that is not in the correct format, the result is undefined.         a file that is not in the correct format, the result is undefined.
613    
614    
615  SEE ALSO  SEE ALSO
616    
617         pcre(3), pcreapi(3), pcrecallout(3),  pcrematching(3),  pcrepartial(d),         pcre(3),  pcreapi(3),  pcrecallout(3), pcrematching(3), pcrepartial(d),
618         pcrepattern(3), pcreprecompile(3).         pcrepattern(3), pcreprecompile(3).
619    
620    
621  AUTHOR  AUTHOR
622    
623         Philip Hazel         Philip Hazel
624         University Computing Service,         University Computing Service
625         Cambridge CB2 3QH, England.         Cambridge CB2 3QH, England.
626    
627  Last updated: 30 November 2006  
628  Copyright (c) 1997-2006 University of Cambridge.  REVISION
629    
630           Last updated: 11 September 2007
631           Copyright (c) 1997-2007 University of Cambridge.

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

  ViewVC Help
Powered by ViewVC 1.1.5