[BACK]Return to pcreprecompile.3 CVS log [TXT] [DIR] Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / pcre / doc

Diff for /embedaddon/pcre/doc/pcreprecompile.3 between versions 1.1.1.1 and 1.1.1.5

version 1.1.1.1, 2012/02/21 23:05:52 version 1.1.1.5, 2014/06/15 19:46:05
Line 1 Line 1
.TH PCREPRECOMPILE 3.TH PCREPRECOMPILE 3 "12 November 2013" "PCRE 8.34"
 .SH NAME  .SH NAME
 PCRE - Perl-compatible regular expressions  PCRE - Perl-compatible regular expressions
 .SH "SAVING AND RE-USING PRECOMPILED PCRE PATTERNS"  .SH "SAVING AND RE-USING PRECOMPILED PCRE PATTERNS"
Line 13  If you are not using any private character tables (see Line 13  If you are not using any private character tables (see
 .\"  .\"
 documentation), this is relatively straightforward. If you are using private  documentation), this is relatively straightforward. If you are using private
 tables, it is a little bit more complicated. However, if you are using the  tables, it is a little bit more complicated. However, if you are using the
just-in-time optimization feature of \fBpcre_study()\fP, it is not possible tojust-in-time optimization feature, it is not possible to save and reload the
save and reload the JIT data.JIT data.
 .P  .P
 If you save compiled patterns to a file, you can copy them to a different host  If you save compiled patterns to a file, you can copy them to a different host
and run them there. This works even if the new host has the opposite endiannessand run them there. If the two hosts have different endianness (byte order),
to the one on which the patterns were compiled. There may be a smallyou should run the \fBpcre[16|32]_pattern_to_host_byte_order()\fP function on the
performance penalty, but it should be insignificant. However, compiling regularnew host before trying to match the pattern. The matching functions return
expressions with one version of PCRE for use with a different version is notPCRE_ERROR_BADENDIANNESS if they detect a pattern with the wrong endianness.
guaranteed to work and may cause crashes, and saving and restoring a compiled.P
pattern loses any JIT optimization data.Compiling regular expressions with one version of PCRE for use with a different
 version is not guaranteed to work and may cause crashes, and saving and
 restoring a compiled pattern loses any JIT optimization data.
 .  .
 .  .
 .SH "SAVING A COMPILED PATTERN"  .SH "SAVING A COMPILED PATTERN"
 .rs  .rs
 .sp  .sp
The value returned by \fBpcre_compile()\fP points to a single block of memoryThe value returned by \fBpcre[16|32]_compile()\fP points to a single block of
that holds the compiled pattern and associated data. You can find the length ofmemory that holds the compiled pattern and associated data. You can find the
this block in bytes by calling \fBpcre_fullinfo()\fP with an argument oflength of this block in bytes by calling \fBpcre[16|32]_fullinfo()\fP with an
PCRE_INFO_SIZE. You can then save the data in any appropriate manner. Here isargument of PCRE_INFO_SIZE. You can then save the data in any appropriate
sample code that compiles a pattern and writes it to a file. It assumes thatmanner. Here is sample code for the 8-bit library that compiles a pattern and
the variable \fIfd\fP refers to a file that is open for output:writes it to a file. It assumes that the variable \fIfd\fP refers to a file
 that is open for output:
 .sp  .sp
   int erroroffset, rc, size;    int erroroffset, rc, size;
   char *error;    char *error;
Line 65  If the pattern has been studied, it is also possible t Line 68  If the pattern has been studied, it is also possible t
 data in a similar way to the compiled pattern itself. However, if the  data in a similar way to the compiled pattern itself. However, if the
 PCRE_STUDY_JIT_COMPILE was used, the just-in-time data that is created cannot  PCRE_STUDY_JIT_COMPILE was used, the just-in-time data that is created cannot
 be saved because it is too dependent on the current environment. When studying  be saved because it is too dependent on the current environment. When studying
generates additional information, \fBpcre_study()\fP returns a pointer to agenerates additional information, \fBpcre[16|32]_study()\fP returns a pointer to a
\fBpcre_extra\fP data block. Its format is defined in the\fBpcre[16|32]_extra\fP data block. Its format is defined in the
 .\" HTML <a href="pcreapi.html#extradata">  .\" HTML <a href="pcreapi.html#extradata">
 .\" </a>  .\" </a>
 section on matching a pattern  section on matching a pattern
Line 76  in the Line 79  in the
 \fBpcreapi\fP  \fBpcreapi\fP
 .\"  .\"
 documentation. The \fIstudy_data\fP field points to the binary study data, and  documentation. The \fIstudy_data\fP field points to the binary study data, and
this is what you must save (not the \fBpcre_extra\fP block itself). The lengththis is what you must save (not the \fBpcre[16|32]_extra\fP block itself). The
of the study data can be obtained by calling \fBpcre_fullinfo()\fP with anlength of the study data can be obtained by calling \fBpcre[16|32]_fullinfo()\fP
argument of PCRE_INFO_STUDYSIZE. Remember to check that \fBpcre_study()\fP didwith an argument of PCRE_INFO_STUDYSIZE. Remember to check that
return a non-NULL value before trying to save the study data.\fBpcre[16|32]_study()\fP did return a non-NULL value before trying to save the
 study data.
 .  .
 .  .
 .SH "RE-USING A PRECOMPILED PATTERN"  .SH "RE-USING A PRECOMPILED PATTERN"
 .rs  .rs
 .sp  .sp
 Re-using a precompiled pattern is straightforward. Having reloaded it into main  Re-using a precompiled pattern is straightforward. Having reloaded it into main
memory, you pass its pointer to \fBpcre_exec()\fP or \fBpcre_dfa_exec()\fP inmemory, called \fBpcre[16|32]_pattern_to_host_byte_order()\fP if necessary, you
the usual way. This should work even on another host, and even if that host haspass its pointer to \fBpcre[16|32]_exec()\fP or \fBpcre[16|32]_dfa_exec()\fP in
the opposite endianness to the one where the pattern was compiled.the usual way.
 .P  .P
 However, if you passed a pointer to custom character tables when the pattern  However, if you passed a pointer to custom character tables when the pattern
was compiled (the \fItableptr\fP argument of \fBpcre_compile()\fP), you mustwas compiled (the \fItableptr\fP argument of \fBpcre[16|32]_compile()\fP), you
now pass a similar pointer to \fBpcre_exec()\fP or \fBpcre_dfa_exec()\fP,must now pass a similar pointer to \fBpcre[16|32]_exec()\fP or
because the value saved with the compiled pattern will obviously be nonsense. A\fBpcre[16|32]_dfa_exec()\fP, because the value saved with the compiled pattern
field in a \fBpcre_extra()\fP block is used to pass this data, as described inwill obviously be nonsense. A field in a \fBpcre[16|32]_extra()\fP block is used
theto pass this data, as described in the
 .\" HTML <a href="pcreapi.html#extradata">  .\" HTML <a href="pcreapi.html#extradata">
 .\" </a>  .\" </a>
 section on matching a pattern  section on matching a pattern
Line 106  in the Line 110  in the
 .\"  .\"
 documentation.  documentation.
 .P  .P
   \fBWarning:\fP The tables that \fBpcre_exec()\fP and \fBpcre_dfa_exec()\fP use
   must be the same as those that were used when the pattern was compiled. If this
   is not the case, the behaviour is undefined.
   .P
 If you did not provide custom character tables when the pattern was compiled,  If you did not provide custom character tables when the pattern was compiled,
the pointer in the compiled pattern is NULL, which causes \fBpcre_exec()\fP tothe pointer in the compiled pattern is NULL, which causes the matching
use PCRE's internal tables. Thus, you do not need to take any special action atfunctions to use PCRE's internal tables. Thus, you do not need to take any
run time in this case.special action at run time in this case.
 .P  .P
 If you saved study data with the compiled pattern, you need to create your own  If you saved study data with the compiled pattern, you need to create your own
\fBpcre_extra\fP data block and set the \fIstudy_data\fP field to point to the\fBpcre[16|32]_extra\fP data block and set the \fIstudy_data\fP field to point
reloaded study data. You must also set the PCRE_EXTRA_STUDY_DATA bit in theto the reloaded study data. You must also set the PCRE_EXTRA_STUDY_DATA bit in
\fIflags\fP field to indicate that study data is present. Then pass thethe \fIflags\fP field to indicate that study data is present. Then pass the
\fBpcre_extra\fP block to \fBpcre_exec()\fP or \fBpcre_dfa_exec()\fP in the\fBpcre[16|32]_extra\fP block to the matching function in the usual way. If the
usual way. If the pattern was studied for just-in-time optimization, that datapattern was studied for just-in-time optimization, that data cannot be saved,
cannot be saved, and so is lost by a save/restore cycle.and so is lost by a save/restore cycle.
 .  .
 .  .
 .SH "COMPATIBILITY WITH DIFFERENT PCRE RELEASES"  .SH "COMPATIBILITY WITH DIFFERENT PCRE RELEASES"
Line 142  Cambridge CB2 3QH, England. Line 150  Cambridge CB2 3QH, England.
 .rs  .rs
 .sp  .sp
 .nf  .nf
Last updated: 26 August 2011Last updated: 12 November 2013
Copyright (c) 1997-2011 University of Cambridge.Copyright (c) 1997-2013 University of Cambridge.
 .fi  .fi
Removed from v.1.1.1.1  
changed lines
  Added in v.1.1.1.5

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>