/[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 392 by ph10, Tue Mar 17 21:30:30 2009 UTC revision 572 by ph10, Wed Nov 17 17:55:57 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         The /M modifier causes the size of memory block used to hold  the  com-         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-
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 290  DATA LINES Line 322  DATA LINES
322           \t         tab (\x09)           \t         tab (\x09)
323           \v         vertical tab (\x0b)           \v         vertical tab (\x0b)
324           \nnn       octal character (up to 3 octal digits)           \nnn       octal character (up to 3 octal digits)
325           \xhh       hexadecimal character (up to 2 hex digits)                        always a byte unless > 255 in UTF-8 mode
326             \xhh       hexadecimal byte (up to 2 hex digits)
327           \x{hh...}  hexadecimal character, any number of digits           \x{hh...}  hexadecimal character, any number of digits
328                        in UTF-8 mode                        in UTF-8 mode
329           \A         pass the PCRE_ANCHORED option to pcre_exec()           \A         pass the PCRE_ANCHORED option to pcre_exec()
# Line 323  DATA LINES Line 356  DATA LINES
356           \M         discover the minimum MATCH_LIMIT and           \M         discover the minimum MATCH_LIMIT and
357                        MATCH_LIMIT_RECURSION settings                        MATCH_LIMIT_RECURSION settings
358           \N         pass the PCRE_NOTEMPTY option to pcre_exec()           \N         pass the PCRE_NOTEMPTY option to pcre_exec()
359                        or pcre_dfa_exec()                        or pcre_dfa_exec(); if used twice, pass the
360                          PCRE_NOTEMPTY_ATSTART option
361           \Odd       set the size of the output vector passed to           \Odd       set the size of the output vector passed to
362                        pcre_exec() to dd (any number of digits)                        pcre_exec() to dd (any number of digits)
363           \P         pass the PCRE_PARTIAL option to pcre_exec()           \P         pass the PCRE_PARTIAL_SOFT option to pcre_exec()
364                        or pcre_dfa_exec()                        or pcre_dfa_exec(); if used twice, pass the
365                          PCRE_PARTIAL_HARD option
366           \Qdd       set the PCRE_MATCH_LIMIT_RECURSION limit to dd           \Qdd       set the PCRE_MATCH_LIMIT_RECURSION limit to dd
367                        (any number of digits)                        (any number of digits)
368           \R         pass the PCRE_DFA_RESTART option to pcre_dfa_exec()           \R         pass the PCRE_DFA_RESTART option to pcre_dfa_exec()
369           \S         output details of memory get/free calls during matching           \S         output details of memory get/free calls during matching
370             \Y         pass the PCRE_NO_START_OPTIMIZE option to pcre_exec()
371                          or pcre_dfa_exec()
372           \Z         pass the PCRE_NOTEOL option to pcre_exec()           \Z         pass the PCRE_NOTEOL option to pcre_exec()
373                        or pcre_dfa_exec()                        or pcre_dfa_exec()
374           \?         pass the PCRE_NO_UTF8_CHECK option to           \?         pass the PCRE_NO_UTF8_CHECK option to
375                        pcre_exec() or pcre_dfa_exec()                        pcre_exec() or pcre_dfa_exec()
376           \>dd       start the match at offset dd (any number of digits);           \>dd       start the match at offset dd (optional "-"; then
377                        this sets the startoffset argument for pcre_exec()                        any number of digits); this sets the startoffset
378                        or pcre_dfa_exec()                        argument for pcre_exec() or pcre_dfa_exec()
379           \<cr>      pass the PCRE_NEWLINE_CR option to pcre_exec()           \<cr>      pass the PCRE_NEWLINE_CR option to pcre_exec()
380                        or pcre_dfa_exec()                        or pcre_dfa_exec()
381           \<lf>      pass the PCRE_NEWLINE_LF option to pcre_exec()           \<lf>      pass the PCRE_NEWLINE_LF option to pcre_exec()
# Line 350  DATA LINES Line 387  DATA LINES
387           \<any>     pass the PCRE_NEWLINE_ANY option to pcre_exec()           \<any>     pass the PCRE_NEWLINE_ANY option to pcre_exec()
388                        or pcre_dfa_exec()                        or pcre_dfa_exec()
389    
390           Note  that  \xhh  always  specifies  one byte, even in UTF-8 mode; this
391           makes it possible to construct invalid UTF-8 sequences for testing pur-
392           poses. On the other hand, \x{hh} is interpreted as a UTF-8 character in
393           UTF-8 mode, generating more than one byte if the value is greater  than
394           127. When not in UTF-8 mode, it generates one byte for values less than
395           256, and causes an error for greater values.
396    
397         The escapes that specify line ending  sequences  are  literal  strings,         The escapes that specify line ending  sequences  are  literal  strings,
398         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
399         any data line.         any data line.
# Line 377  DATA LINES Line 421  DATA LINES
421    
422         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-
423         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
424         effect  are \B and \Z, causing REG_NOTBOL and REG_NOTEOL, respectively,         effect  are  \B,  \N,  and  \Z,  causing  REG_NOTBOL, REG_NOTEMPTY, and
425         to be passed to regexec().         REG_NOTEOL, respectively, to be passed to regexec().
426    
427         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
428         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.
# Line 412  DEFAULT OUTPUT FROM PCRETEST Line 456  DEFAULT OUTPUT FROM PCRETEST
456    
457         When a match succeeds, pcretest outputs the list of captured substrings         When a match succeeds, pcretest outputs the list of captured substrings
458         that  pcre_exec()  returns,  starting with number 0 for the string that         that  pcre_exec()  returns,  starting with number 0 for the string that
459         matched the whole pattern. Otherwise, it outputs "No match" or "Partial         matched the whole pattern. Otherwise, it outputs "No  match"  when  the
460         match"  when  pcre_exec() returns PCRE_ERROR_NOMATCH or PCRE_ERROR_PAR-         return is PCRE_ERROR_NOMATCH, and "Partial match:" followed by the par-
461         TIAL, respectively, and otherwise the PCRE negative error number.  Here         tially matching substring when pcre_exec() returns  PCRE_ERROR_PARTIAL.
462         is an example of an interactive pcretest run.         (Note  that  this is the entire substring that was inspected during the
463           partial match; it may include characters before the actual match  start
464           if  a  lookbehind assertion, \K, \b, or \B was involved.) For any other
465           returns, it outputs the PCRE negative error number. Here is an  example
466           of an interactive pcretest run.
467    
468           $ pcretest           $ pcretest
469           PCRE version 7.0 30-Nov-2006           PCRE version 7.0 30-Nov-2006
# Line 496  OUTPUT FROM THE ALTERNATIVE MATCHING FUN Line 544  OUTPUT FROM THE ALTERNATIVE MATCHING FUN
544            2: tan            2: tan
545    
546         (Using  the  normal  matching function on this data finds only "tang".)         (Using  the  normal  matching function on this data finds only "tang".)
547         The longest matching string is always given first (and numbered zero).         The longest matching string is always given first (and numbered  zero).
548           After a PCRE_ERROR_PARTIAL return, the output is "Partial match:", fol-
549           lowed by the partially matching  substring.  (Note  that  this  is  the
550           entire  substring  that  was inspected during the partial match; it may
551           include characters before the actual match start if a lookbehind asser-
552           tion, \K, \b, or \B was involved.)
553    
554         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
555         at the end of the longest match. For example:         at the end of the longest match. For example:
# Line 510  OUTPUT FROM THE ALTERNATIVE MATCHING FUN Line 563  OUTPUT FROM THE ALTERNATIVE MATCHING FUN
563            1: tan            1: tan
564            0: tan            0: tan
565    
566         Since  the  matching  function  does not support substring capture, the         Since the matching function does not  support  substring  capture,  the
567         escape sequences that are concerned with captured  substrings  are  not         escape  sequences  that  are concerned with captured substrings are not
568         relevant.         relevant.
569    
570    
571  RESTARTING AFTER A PARTIAL MATCH  RESTARTING AFTER A PARTIAL MATCH
572    
573         When the alternative matching function has given the PCRE_ERROR_PARTIAL         When the alternative matching function has given the PCRE_ERROR_PARTIAL
574         return, indicating that the subject partially matched the pattern,  you         return,  indicating that the subject partially matched the pattern, you
575         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
576         escape sequence. For example:         escape sequence. For example:
577    
578             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 528  RESTARTING AFTER A PARTIAL MATCH Line 581  RESTARTING AFTER A PARTIAL MATCH
581           data> n05\R\D           data> n05\R\D
582            0: n05            0: n05
583    
584         For further information about partial  matching,  see  the  pcrepartial         For  further  information  about  partial matching, see the pcrepartial
585         documentation.         documentation.
586    
587    
588  CALLOUTS  CALLOUTS
589    
590         If  the pattern contains any callout requests, pcretest's callout func-         If the pattern contains any callout requests, pcretest's callout  func-
591         tion is called during matching. This works  with  both  matching  func-         tion  is  called  during  matching. This works with both matching func-
592         tions. By default, the called function displays the callout number, the         tions. By default, the called function displays the callout number, the
593         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
594         next pattern item to be tested. For example, the output         next pattern item to be tested. For example, the output
595    
596           --->pqrabcdef           --->pqrabcdef
597             0    ^  ^     \d             0    ^  ^     \d
598    
599         indicates  that  callout number 0 occurred for a match attempt starting         indicates that callout number 0 occurred for a match  attempt  starting
600         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
601         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
602         \d. Just one circumflex is output if the start  and  current  positions         \d.  Just  one  circumflex is output if the start and current positions
603         are the same.         are the same.
604    
605         Callouts numbered 255 are assumed to be automatic callouts, inserted as         Callouts numbered 255 are assumed to be automatic callouts, inserted as
606         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
607         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
608         output. For example:         output. For example:
609    
610             re> /\d?[A-E]\*/C             re> /\d?[A-E]\*/C
# Line 563  CALLOUTS Line 616  CALLOUTS
616           +10 ^ ^           +10 ^ ^
617            0: E*            0: E*
618    
619         The callout function in pcretest returns zero (carry  on  matching)  by         The  callout  function  in pcretest returns zero (carry on matching) by
620         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)
621         to change this.         to change this.
622    
623         Inserting callouts can be helpful when using pcretest to check  compli-         Inserting  callouts can be helpful when using pcretest to check compli-
624         cated  regular expressions. For further information about callouts, see         cated regular expressions. For further information about callouts,  see
625         the pcrecallout documentation.         the pcrecallout documentation.
626    
627    
628  NON-PRINTING CHARACTERS  NON-PRINTING CHARACTERS
629    
630         When pcretest is outputting text in the compiled version of a  pattern,         When  pcretest is outputting text in the compiled version of a pattern,
631         bytes  other  than 32-126 are always treated as non-printing characters         bytes other than 32-126 are always treated as  non-printing  characters
632         are are therefore shown as hex escapes.         are are therefore shown as hex escapes.
633    
634         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
635         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
636         set for the  pattern  (using  the  /L  modifier).  In  this  case,  the         set  for  the  pattern  (using  the  /L  modifier).  In  this case, the
637         isprint() function to distinguish printing and non-printing characters.         isprint() function to distinguish printing and non-printing characters.
638    
639    
640  SAVING AND RELOADING COMPILED PATTERNS  SAVING AND RELOADING COMPILED PATTERNS
641    
642         The  facilities  described  in  this section are not available when the         The facilities described in this section are  not  available  when  the
643         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-
644         ifier is specified.         ifier is specified.
645    
646         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
647         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
648         file name.  For example:         file name.  For example:
649    
650           /pattern/im >/some/file           /pattern/im >/some/file
651    
652         See  the pcreprecompile documentation for a discussion about saving and         See the pcreprecompile documentation for a discussion about saving  and
653         re-using compiled patterns.         re-using compiled patterns.
654    
655         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
656         length  of  the  compiled  pattern  data  followed by the length of the         length of the compiled pattern data  followed  by  the  length  of  the
657         optional study data, each written as four  bytes  in  big-endian  order         optional  study  data,  each  written as four bytes in big-endian order
658         (most  significant  byte  first). If there is no study data (either the         (most significant byte first). If there is no study  data  (either  the
659         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-
660         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
661         compiled pattern. If there is additional study data, this follows imme-         compiled pattern. If there is additional study data, this follows imme-
662         diately  after  the  compiled pattern. After writing the file, pcretest         diately after the compiled pattern. After writing  the  file,  pcretest
663         expects to read a new pattern.         expects to read a new pattern.
664    
665         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
666         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  <
667         character, as otherwise pcretest will interpret the line as  a  pattern         character,  as  otherwise pcretest will interpret the line as a pattern
668         delimited by < characters.  For example:         delimited by < characters.  For example:
669    
670            re> </some/file            re> </some/file
671           Compiled regex loaded from /some/file           Compiled regex loaded from /some/file
672           No study data           No study data
673    
674         When  the pattern has been loaded, pcretest proceeds to read data lines         When the pattern has been loaded, pcretest proceeds to read data  lines
675         in the usual way.         in the usual way.
676    
677         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
678         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
679         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
680         machine and run on a SPARC machine.         machine and run on a SPARC machine.
681    
682         File  names  for  saving and reloading can be absolute or relative, but         File names for saving and reloading can be absolute  or  relative,  but
683         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
684         a tilde (~) is not available.         a tilde (~) is not available.
685    
686         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-
687         ing and experimentation. It is not intended for production use  because         ing  and experimentation. It is not intended for production use because
688         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
689         no facility for supplying  custom  character  tables  for  use  with  a         no  facility  for  supplying  custom  character  tables  for use with a
690         reloaded  pattern.  If  the  original  pattern was compiled with custom         reloaded pattern. If the original  pattern  was  compiled  with  custom
691         tables, an attempt to match a subject string using a  reloaded  pattern         tables,  an  attempt to match a subject string using a reloaded pattern
692         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
693         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.
694    
695    
696  SEE ALSO  SEE ALSO
697    
698         pcre(3), pcreapi(3), pcrecallout(3),  pcrematching(3),  pcrepartial(d),         pcre(3),  pcreapi(3),  pcrecallout(3), pcrematching(3), pcrepartial(d),
699         pcrepattern(3), pcreprecompile(3).         pcrepattern(3), pcreprecompile(3).
700    
701    
# Line 655  AUTHOR Line 708  AUTHOR
708    
709  REVISION  REVISION
710    
711         Last updated: 10 March 2009         Last updated: 07 November 2010
712         Copyright (c) 1997-2009 University of Cambridge.         Copyright (c) 1997-2010 University of Cambridge.

Legend:
Removed from v.392  
changed lines
  Added in v.572

  ViewVC Help
Powered by ViewVC 1.1.5