--- embedaddon/pcre/doc/pcreprecompile.3 2012/02/21 23:50:25 1.1.1.2 +++ embedaddon/pcre/doc/pcreprecompile.3 2014/06/15 19:46:05 1.1.1.5 @@ -1,4 +1,4 @@ -.TH PCREPRECOMPILE 3 +.TH PCREPRECOMPILE 3 "12 November 2013" "PCRE 8.34" .SH NAME PCRE - Perl-compatible regular expressions .SH "SAVING AND RE-USING PRECOMPILED PCRE PATTERNS" @@ -18,7 +18,7 @@ JIT data. .P If you save compiled patterns to a file, you can copy them to a different host and run them there. If the two hosts have different endianness (byte order), -you should run the \fBpcre[16]_pattern_to_host_byte_order()\fP function on the +you should run the \fBpcre[16|32]_pattern_to_host_byte_order()\fP function on the new host before trying to match the pattern. The matching functions return PCRE_ERROR_BADENDIANNESS if they detect a pattern with the wrong endianness. .P @@ -30,9 +30,9 @@ restoring a compiled pattern loses any JIT optimizatio .SH "SAVING A COMPILED PATTERN" .rs .sp -The value returned by \fBpcre[16]_compile()\fP points to a single block of +The value returned by \fBpcre[16|32]_compile()\fP points to a single block of memory that holds the compiled pattern and associated data. You can find the -length of this block in bytes by calling \fBpcre[16]_fullinfo()\fP with an +length of this block in bytes by calling \fBpcre[16|32]_fullinfo()\fP with an argument of PCRE_INFO_SIZE. You can then save the data in any appropriate manner. Here is sample code for the 8-bit library that compiles a pattern and writes it to a file. It assumes that the variable \fIfd\fP refers to a file @@ -68,8 +68,8 @@ If the pattern has been studied, it is also possible t 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 be saved because it is too dependent on the current environment. When studying -generates additional information, \fBpcre[16]_study()\fP returns a pointer to a -\fBpcre[16]_extra\fP data block. Its format is defined in the +generates additional information, \fBpcre[16|32]_study()\fP returns a pointer to a +\fBpcre[16|32]_extra\fP data block. Its format is defined in the .\" HTML .\" section on matching a pattern @@ -79,10 +79,10 @@ in the \fBpcreapi\fP .\" documentation. The \fIstudy_data\fP field points to the binary study data, and -this is what you must save (not the \fBpcre[16]_extra\fP block itself). The -length of the study data can be obtained by calling \fBpcre[16]_fullinfo()\fP +this is what you must save (not the \fBpcre[16|32]_extra\fP block itself). The +length of the study data can be obtained by calling \fBpcre[16|32]_fullinfo()\fP with an argument of PCRE_INFO_STUDYSIZE. Remember to check that -\fBpcre[16]_study()\fP did return a non-NULL value before trying to save the +\fBpcre[16|32]_study()\fP did return a non-NULL value before trying to save the study data. . . @@ -90,15 +90,15 @@ study data. .rs .sp Re-using a precompiled pattern is straightforward. Having reloaded it into main -memory, called \fBpcre[16]_pattern_to_host_byte_order()\fP if necessary, -you pass its pointer to \fBpcre[16]_exec()\fP or \fBpcre[16]_dfa_exec()\fP in +memory, called \fBpcre[16|32]_pattern_to_host_byte_order()\fP if necessary, you +pass its pointer to \fBpcre[16|32]_exec()\fP or \fBpcre[16|32]_dfa_exec()\fP in the usual way. .P However, if you passed a pointer to custom character tables when the pattern -was compiled (the \fItableptr\fP argument of \fBpcre[16]_compile()\fP), you -must now pass a similar pointer to \fBpcre[16]_exec()\fP or -\fBpcre[16]_dfa_exec()\fP, because the value saved with the compiled pattern -will obviously be nonsense. A field in a \fBpcre[16]_extra()\fP block is used +was compiled (the \fItableptr\fP argument of \fBpcre[16|32]_compile()\fP), you +must now pass a similar pointer to \fBpcre[16|32]_exec()\fP or +\fBpcre[16|32]_dfa_exec()\fP, because the value saved with the compiled pattern +will obviously be nonsense. A field in a \fBpcre[16|32]_extra()\fP block is used to pass this data, as described in the .\" HTML .\" @@ -110,16 +110,20 @@ in the .\" documentation. .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, the pointer in the compiled pattern is NULL, which causes the matching functions to use PCRE's internal tables. Thus, you do not need to take any special action at run time in this case. .P If you saved study data with the compiled pattern, you need to create your own -\fBpcre[16]_extra\fP data block and set the \fIstudy_data\fP field to point to the -reloaded study data. You must also set the PCRE_EXTRA_STUDY_DATA bit in the -\fIflags\fP field to indicate that study data is present. Then pass the -\fBpcre[16]_extra\fP block to the matching function in the usual way. If the +\fBpcre[16|32]_extra\fP data block and set the \fIstudy_data\fP field to point +to the reloaded study data. You must also set the PCRE_EXTRA_STUDY_DATA bit in +the \fIflags\fP field to indicate that study data is present. Then pass the +\fBpcre[16|32]_extra\fP block to the matching function in the usual way. If the pattern was studied for just-in-time optimization, that data cannot be saved, and so is lost by a save/restore cycle. . @@ -146,6 +150,6 @@ Cambridge CB2 3QH, England. .rs .sp .nf -Last updated: 10 January 2012 -Copyright (c) 1997-2012 University of Cambridge. +Last updated: 12 November 2013 +Copyright (c) 1997-2013 University of Cambridge. .fi