+int pcre_jit_exec(const pcre *code, const pcre_extra *extra, +const char *subject, int length, int startoffset, +int options, int *ovector, int ovecsize, +pcre_jit_stack *jstack); +
+pcre_jit_stack *pcre_jit_stack_alloc(int startsize, int maxsize);
@@ -161,29 +167,34 @@ man page, in case the conversion went wrong.
int (*pcre_callout)(pcre_callout_block *);
--From release 8.30, PCRE can be compiled as a library for handling 16-bit -character strings as well as, or instead of, the original library that handles -8-bit character strings. To avoid too much complication, this document -describes the 8-bit versions of the functions, with only occasional references -to the 16-bit library. +As well as support for 8-bit character strings, PCRE also supports 16-bit +strings (from release 8.30) and 32-bit strings (from release 8.32), by means of +two additional libraries. They can be built as well as, or instead of, the +8-bit library. To avoid too much complication, this document describes the +8-bit versions of the functions, with only occasional references to the 16-bit +and 32-bit libraries.
-The 16-bit functions operate in the same way as their 8-bit counterparts; they -just use different data types for their arguments and results, and their names -start with pcre16_ instead of pcre_. For every option that has UTF8 -in its name (for example, PCRE_UTF8), there is a corresponding 16-bit name with -UTF8 replaced by UTF16. This facility is in fact just cosmetic; the 16-bit -option names define the same bit values. +The 16-bit and 32-bit functions operate in the same way as their 8-bit +counterparts; they just use different data types for their arguments and +results, and their names start with pcre16_ or pcre32_ instead of +pcre_. For every option that has UTF8 in its name (for example, +PCRE_UTF8), there are corresponding 16-bit and 32-bit names with UTF8 replaced +by UTF16 or UTF32, respectively. This facility is in fact just cosmetic; the +16-bit and 32-bit option names define the same bit values.
References to bytes and UTF-8 in this document should be read as references to -16-bit data quantities and UTF-16 when using the 16-bit library, unless -specified otherwise. More details of the specific differences for the 16-bit -library are given in the +16-bit data units and UTF-16 when using the 16-bit library, or 32-bit data +units and UTF-32 when using the 32-bit library, unless specified otherwise. +More details of the specific differences for the 16-bit and 32-bit libraries +are given in the pcre16 -page. +and +pcre32 +pages.
@@ -233,7 +244,10 @@ used if available, by setting an option that is ignore relevant. More complicated programs might need to make use of the functions pcre_jit_stack_alloc(), pcre_jit_stack_free(), and pcre_assign_jit_stack() in order to control the JIT code's memory usage. -These functions are discussed in the +
++From release 8.32 there is also a direct interface for JIT execution, which +gives improved performance. The JIT-specific functions are discussed in the pcrejit documentation.
@@ -317,7 +331,7 @@ PCRE supports five different conventions for indicatin strings: a single CR (carriage return) character, a single LF (linefeed) character, the two-character sequence CRLF, any of the three preceding, or any Unicode newline sequence. The Unicode newline sequences are the three just -mentioned, plus the single characters VT (vertical tab, U+000B), FF (formfeed, +mentioned, plus the single characters VT (vertical tab, U+000B), FF (form feed, U+000C), NEL (next line, U+0085), LS (line separator, U+2028), and PS (paragraph separator, U+2029). @@ -398,16 +412,24 @@ not recognized. The following information is available PCRE_CONFIG_UTF8 The output is an integer that is set to one if UTF-8 support is available; -otherwise it is set to zero. If this option is given to the 16-bit version of -this function, pcre16_config(), the result is PCRE_ERROR_BADOPTION. +otherwise it is set to zero. This value should normally be given to the 8-bit +version of this function, pcre_config(). If it is given to the 16-bit +or 32-bit version of this function, the result is PCRE_ERROR_BADOPTION.PCRE_CONFIG_UTF16The output is an integer that is set to one if UTF-16 support is available; otherwise it is set to zero. This value should normally be given to the 16-bit version of this function, pcre16_config(). If it is given to the 8-bit -version of this function, the result is PCRE_ERROR_BADOPTION. +or 32-bit version of this function, the result is PCRE_ERROR_BADOPTION.
+ PCRE_CONFIG_UTF32 ++The output is an integer that is set to one if UTF-32 support is available; +otherwise it is set to zero. This value should normally be given to the 32-bit +version of this function, pcre32_config(). If it is given to the 8-bit +or 16-bit version of this function, the result is PCRE_ERROR_BADOPTION. +
PCRE_CONFIG_UNICODE_PROPERTIESThe output is an integer that is set to one if support for Unicode character @@ -428,11 +450,13 @@ unaligned)". If JIT support is not available, the resu PCRE_CONFIG_NEWLINE The output is an integer whose value specifies the default character sequence -that is recognized as meaning "newline". The four values that are supported -are: 10 for LF, 13 for CR, 3338 for CRLF, -2 for ANYCRLF, and -1 for ANY. -Though they are derived from ASCII, the same values are returned in EBCDIC -environments. The default should normally correspond to the standard sequence -for your operating system. +that is recognized as meaning "newline". The values that are supported in +ASCII/Unicode environments are: 10 for LF, 13 for CR, 3338 for CRLF, -2 for +ANYCRLF, and -1 for ANY. In EBCDIC environments, CR, ANYCRLF, and ANY yield the +same values. However, the value for LF is normally 21, though some EBCDIC +environments use 37. The corresponding values for CRLF are 3349 and 3365. The +default should normally correspond to the standard sequence for your operating +system.
PCRE_CONFIG_BSR@@ -446,10 +470,11 @@ or CRLF. The default can be overridden when a pattern The output is an integer that contains the number of bytes used for internal linkage in compiled regular expressions. For the 8-bit library, the value can be 2, 3, or 4. For the 16-bit library, the value is either 2 or 4 and is still -a number of bytes. The default value of 2 is sufficient for all but the most -massive patterns, since it allows the compiled pattern to be up to 64K in size. -Larger values allow larger regular expressions to be compiled, at the expense -of slower matching. +a number of bytes. For the 32-bit library, the value is either 2 or 4 and is +still a number of bytes. The default value of 2 is sufficient for all but the +most massive patterns, since it allows the compiled pattern to be up to 64K in +size. Larger values allow larger regular expressions to be compiled, at the +expense of slower matching.
PCRE_CONFIG_POSIX_MALLOC_THRESHOLD@@ -524,7 +549,7 @@ documentation). For those options that can be differen the pattern, the contents of the options argument specifies their settings at the start of compilation and execution. The PCRE_ANCHORED, PCRE_BSR_xxx, PCRE_NEWLINE_xxx, PCRE_NO_UTF8_CHECK, and -PCRE_NO_START_OPT options can be set at the time of matching as well as at +PCRE_NO_START_OPTIMIZE options can be set at the time of matching as well as at compile time.
@@ -533,16 +558,16 @@ Otherwise, if compilation of a pattern fails, pcre_ NULL, and sets the variable pointed to by errptr to point to a textual error message. This is a static string that is part of the library. You must not try to free it. Normally, the offset from the start of the pattern to the -byte that was being processed when the error was discovered is placed in the -variable pointed to by erroffset, which must not be NULL (if it is, an -immediate error is given). However, for an invalid UTF-8 string, the offset is -that of the first byte of the failing character. +data unit that was being processed when the error was discovered is placed in +the variable pointed to by erroffset, which must not be NULL (if it is, +an immediate error is given). However, for an invalid UTF-8 or UTF-16 string, +the offset is that of the first data unit of the failing character.
Some errors are not detected until the whole pattern has been scanned; in these cases, the offset passed back is the length of the pattern. Note that the -offset is in bytes, not characters, even in UTF-8 mode. It may sometimes point -into the middle of a UTF-8 character. +offset is in data units, not characters, even in a UTF mode. It may sometimes +point into the middle of a UTF-8 or UTF-16 character.
If pcre_compile2() is used instead of pcre_compile(), and the @@ -641,8 +666,8 @@ documentation.
PCRE_EXTENDED-If this bit is set, whitespace data characters in the pattern are totally -ignored except when escaped or inside a character class. Whitespace does not +If this bit is set, white space data characters in the pattern are totally +ignored except when escaped or inside a character class. White space does not include the VT character (code 11). In addition, characters between an unescaped # outside a character class and the next newline, inclusive, are also ignored. This is equivalent to Perl's /x option, and it can be changed within a @@ -659,7 +684,7 @@ happen to represent a newline do not count.
This option makes it possible to include comments inside complicated patterns. -Note, however, that this applies only to data characters. Whitespace characters +Note, however, that this applies only to data characters. White space characters may never appear within special character sequences in a pattern, for example within the sequence (?( that introduces a conditional subpattern.
@@ -716,12 +741,14 @@ binary zero character followed by z).The first byte of a character has the value 0xfe or 0xff. These values can never occur in a valid UTF-8 string. +PCRE_MULTILINE-By default, PCRE treats the subject string as consisting of a single line of -characters (even if it actually contains newlines). The "start of line" -metacharacter (^) matches only at the start of the string, while the "end of -line" metacharacter ($) matches only at the end of the string, or before a -terminating newline (unless PCRE_DOLLAR_ENDONLY is set). This is the same as -Perl. +By default, for the purposes of matching "start of line" and "end of line", +PCRE treats the subject string as consisting of a single line of characters, +even if it actually contains newlines. The "start of line" metacharacter (^) +matches only at the start of the string, and the "end of line" metacharacter +($) matches only at the end of the string, or before a terminating newline +(except when PCRE_DOLLAR_ENDONLY is set). Note, however, that unless +PCRE_DOTALL is set, the "any character" metacharacter (.) does not match at a +newline. This behaviour (for ^, $, and dot) is the same as Perl.When PCRE_MULTILINE it is set, the "start of line" and "end of line" constructs @@ -731,6 +758,15 @@ equivalent to Perl's /m option, and it can be changed (?m) option setting. If there are no newlines in a subject string, or no occurrences of ^ or $ in a pattern, setting PCRE_MULTILINE has no effect.
+ PCRE_NEVER_UTF ++This option locks out interpretation of the pattern as UTF-8 (or UTF-16 or +UTF-32 in the 16-bit and 32-bit libraries). In particular, it prevents the +creator of the pattern from switching to UTF interpretation by starting the +pattern with (*UTF). This may be useful in applications that process patterns +from external sources. The combination of PCRE_UTF8 and PCRE_NEVER_UTF also +causes an error. +PCRE_NEWLINE_CR PCRE_NEWLINE_LF PCRE_NEWLINE_CRLF @@ -743,13 +779,25 @@ indicated by a single character (CR or LF, respectivel PCRE_NEWLINE_CRLF specifies that a newline is indicated by the two-character CRLF sequence. Setting PCRE_NEWLINE_ANYCRLF specifies that any of the three preceding sequences should be recognized. Setting PCRE_NEWLINE_ANY specifies -that any Unicode newline sequence should be recognized. The Unicode newline -sequences are the three just mentioned, plus the single characters VT (vertical -tab, U+000B), FF (formfeed, U+000C), NEL (next line, U+0085), LS (line -separator, U+2028), and PS (paragraph separator, U+2029). For the 8-bit -library, the last two are recognized only in UTF-8 mode. +that any Unicode newline sequence should be recognized.When PCRE_UTF8 is set at compile time, the validity of the subject as a UTF-8 string is automatically checked when pcre_exec() is subsequently called. -The value of startoffset is also checked to ensure that it points to the -start of a UTF-8 character. There is a discussion about the validity of UTF-8 -strings in the +The entire string is checked before any other processing takes place. The value +of startoffset is also checked to ensure that it points to the start of a +UTF-8 character. There is a discussion about the +validity of UTF-8 strings +in the pcreunicode page. If an invalid sequence of bytes is found, pcre_exec() returns the error PCRE_ERROR_BADUTF8 or, if PCRE_PARTIAL_HARD is set and the problem is a @@ -1773,15 +1985,21 @@ The string to be matched by pcre_exec()+In an ASCII/Unicode environment, the Unicode newline sequences are the three +just mentioned, plus the single characters VT (vertical tab, U+000B), FF (form +feed, U+000C), NEL (next line, U+0085), LS (line separator, U+2028), and PS +(paragraph separator, U+2029). For the 8-bit library, the last two are +recognized only in UTF-8 mode. +
++When PCRE is compiled to run in an EBCDIC (mainframe) environment, the code for +CR is 0x0d, the same as ASCII. However, the character code for LF is normally +0x15, though in some EBCDIC environments 0x25 is used. Whichever of these is +not LF is made to correspond to Unicode's NEL character. EBCDIC codes are all +less than 256. For more details, see the +pcrebuild +documentation. +
+The newline setting in the options word uses three bits that are treated as a number, giving eight possibilities. Currently only six are used (default plus the five values above). This means that if you set more than one newline @@ -759,7 +807,7 @@ other combinations may yield unused numbers and cause
The only time that a line break in a pattern is specially recognized when -compiling is when PCRE_EXTENDED is set. CR and LF are whitespace characters, +compiling is when PCRE_EXTENDED is set. CR and LF are white space characters, and so are ignored in this mode. Also, an unescaped # outside a character class indicates a comment that lasts until after the next line break sequence. In other circumstances, line break sequences in patterns are treated as literal @@ -777,12 +825,14 @@ were followed by ?: but named parentheses can still be they acquire numbers in the usual way). There is no equivalent of this option in Perl.
- NO_START_OPTIMIZE + PCRE_NO_START_OPTIMIZEThis is an option that acts at matching time; that is, it is really an option for pcre_exec() or pcre_dfa_exec(). If it is set at compile time, -it is remembered with the compiled pattern and assumed at matching time. For -details see the discussion of PCRE_NO_START_OPTIMIZE +it is remembered with the compiled pattern and assumed at matching time. This +is necessary if you want to use JIT execution, because the JIT compiler needs +to know whether or not this option is set. For details see the discussion of +PCRE_NO_START_OPTIMIZE below.PCRE_UCP @@ -816,8 +866,8 @@ page.The "magic number" is placed at the start of each compiled pattern as an simple check against passing an arbitrary memory pointer. The endianness error can @@ -1159,8 +1231,8 @@ variable.PCRE_NO_UTF8_CHECK-When PCRE_UTF8 is set, the validity of the pattern as a UTF-8 -string is automatically checked. There is a discussion about the +When PCRE_UTF8 is set, the validity of the pattern as a UTF-8 string is +automatically checked. There is a discussion about the validity of UTF-8 strings in the pcreunicode @@ -827,15 +877,17 @@ this check for performance reasons, you can set the PC When it is set, the effect of passing an invalid UTF-8 string as a pattern is undefined. It may cause your program to crash. Note that this option can also be passed to pcre_exec() and pcre_dfa_exec(), to suppress the -validity checking of subject strings. +validity checking of subject strings only. If the same string is being matched +many times, the option can be safely set for the second and subsequent +matchings to improve performance.
COMPILATION ERROR CODES
The following table lists the error codes than may be returned by pcre_compile2(), along with the error messages that may be returned by both compiling functions. Note that error messages are always 8-bit ASCII -strings, even in 16-bit mode. As PCRE has developed, some error codes have -fallen out of use. To avoid confusion, they have not been re-used. +strings, even in 16-bit or 32-bit mode. As PCRE has developed, some error codes +have fallen out of use. To avoid confusion, they have not been re-used.
0 no error 1 \ at end of pattern @@ -899,7 +951,7 @@ fallen out of use. To avoid confusion, they have not b name/number or by a plain number 58 a numbered reference must not be zero 59 an argument is not allowed for (*ACCEPT), (*FAIL), or (*COMMIT) - 60 (*VERB) not recognized + 60 (*VERB) not recognized or malformed 61 number is too big 62 subpattern name expected 63 digit expected after (?+ @@ -916,6 +968,9 @@ fallen out of use. To avoid confusion, they have not b 72 too many forward references 73 disallowed Unicode code point (>= 0xd800 && <= 0xdfff) 74 invalid UTF-16 string (specifically UTF-16) + 75 name is too long in (*MARK), (*PRUNE), (*SKIP), or (*THEN) + 76 character value in \u.... sequence is too large + 77 invalid UTF-32 string (specifically UTF-32)The numbers 32 and 10000 in errors 48 and 49 are defaults; different values may be used if the limits were changed when PCRE was built. @@ -944,17 +999,27 @@ in the section on matching a pattern.If studying the pattern does not produce any useful information, -pcre_study() returns NULL. In that circumstance, if the calling program -wants to pass any of the other fields to pcre_exec() or -pcre_dfa_exec(), it must set up its own pcre_extra block. +pcre_study() returns NULL by default. In that circumstance, if the +calling program wants to pass any of the other fields to pcre_exec() or +pcre_dfa_exec(), it must set up its own pcre_extra block. However, +if pcre_study() is called with the PCRE_STUDY_EXTRA_NEEDED option, it +returns a pcre_extra block even if studying did not find any additional +information. It may still return NULL, however, if an error occurs in +pcre_study().
-The second argument of pcre_study() contains option bits. There is only -one option: PCRE_STUDY_JIT_COMPILE. If this is set, and the just-in-time -compiler is available, the pattern is further compiled into machine code that -executes much faster than the pcre_exec() matching function. If -the just-in-time compiler is not available, this option is ignored. All other -bits in the options argument must be zero. +The second argument of pcre_study() contains option bits. There are three +further options in addition to PCRE_STUDY_EXTRA_NEEDED: +
+ PCRE_STUDY_JIT_COMPILE + PCRE_STUDY_JIT_PARTIAL_HARD_COMPILE + PCRE_STUDY_JIT_PARTIAL_SOFT_COMPILE ++If any of these are set, and the just-in-time compiler is available, the +pattern is further compiled into machine code that executes much faster than +the pcre_exec() interpretive matching function. If the just-in-time +compiler is not available, these options are ignored. All undefined bits in the +options argument must be zero.JIT compilation is a heavyweight optimization. It can take some time for @@ -979,8 +1044,8 @@ When you are finished with a pattern, you can free the study data by calling pcre_free_study(). This function was added to the API for release 8.20. For earlier versions, the memory could be freed with pcre_free(), just like the pattern itself. This will still work in cases -where PCRE_STUDY_JIT_COMPILE is not used, but it is advisable to change to the -new function when convenient. +where JIT optimization is not used, but it is advisable to change to the new +function when convenient.
This is a typical way in which pcre_study() is used (except that in a @@ -1003,27 +1068,33 @@ real application there should be tests for errors): Studying a pattern does two things: first, a lower bound for the length of subject string that is needed to match the pattern is computed. This does not mean that there are any strings of that length that match, but it does -guarantee that no shorter strings match. The value is used by -pcre_exec() and pcre_dfa_exec() to avoid wasting time by trying to -match strings that are shorter than the lower bound. You can find out the value -in a calling program via the pcre_fullinfo() function. +guarantee that no shorter strings match. The value is used to avoid wasting +time by trying to match strings that are shorter than the lower bound. You can +find out the value in a calling program via the pcre_fullinfo() function.
Studying a pattern is also useful for non-anchored patterns that do not have a single fixed starting character. A bitmap of possible starting bytes is created. This speeds up finding a position in the subject at which to start -matching. (In 16-bit mode, the bitmap is used for 16-bit values less than 256.) +matching. (In 16-bit mode, the bitmap is used for 16-bit values less than 256. +In 32-bit mode, the bitmap is used for 32-bit values less than 256.)
These two optimizations apply to both pcre_exec() and -pcre_dfa_exec(). However, they are not used by pcre_exec() if -pcre_study() is called with the PCRE_STUDY_JIT_COMPILE option, and -just-in-time compiling is successful. The optimizations can be disabled by -setting the PCRE_NO_START_OPTIMIZE option when calling pcre_exec() or -pcre_dfa_exec(). You might want to do this if your pattern contains -callouts or (*MARK) (which cannot be handled by the JIT compiler), and you want -to make use of these facilities in cases where matching fails. See the -discussion of PCRE_NO_START_OPTIMIZE +pcre_dfa_exec(), and the information is also used by the JIT compiler. +The optimizations can be disabled by setting the PCRE_NO_START_OPTIMIZE option. +You might want to do this if your pattern contains callouts or (*MARK) and you +want to make use of these facilities in cases where matching fails. +
++PCRE_NO_START_OPTIMIZE can be specified at either compile time or execution +time. However, if PCRE_NO_START_OPTIMIZE is passed to pcre_exec(), (that +is, after any JIT compilation has happened) JIT execution is disabled. For JIT +execution to work with PCRE_NO_START_OPTIMIZE, the option must be set at +compile time. +
++There is a longer discussion of PCRE_NO_START_OPTIMIZE below.
LOCALE SUPPORT
@@ -1112,6 +1183,7 @@ the following negative numbers: PCRE_ERROR_BADENDIANNESS the pattern was compiled with different endianness PCRE_ERROR_BADOPTION the value of what was invalid + PCRE_ERROR_UNSET the requested field is not setIf there is a fixed first value, for example, the letter "c" from a pattern such as (cat|cow|coyote), its value is returned. In the 8-bit library, the -value is always less than 256; in the 16-bit library the value can be up to -0xffff. +value is always less than 256. In the 16-bit library the value can be up to +0xffff. In the 32-bit library the value can be up to 0x10ffff.
If there is no fixed first value, and if either @@ -1177,6 +1249,12 @@ starts with "^", or -1 is returned, indicating that the pattern matches only at the start of a subject string or after any newline within the string. Otherwise -2 is returned. For anchored patterns, -2 is returned. +
++Since for the 32-bit library using the non-UTF-32 mode, this function is unable +to return the full 32-bit range of the character, this value is deprecated; +instead the PCRE_INFO_FIRSTCHARACTERFLAGS and PCRE_INFO_FIRSTCHARACTER values +should be used.
PCRE_INFO_FIRSTTABLE@@ -1199,20 +1277,19 @@ Return 1 if the (?J) or (?-J) option setting is used iPCRE_INFO_JIT-Return 1 if the pattern was studied with the PCRE_STUDY_JIT_COMPILE option, and +Return 1 if the pattern was studied with one of the JIT options, and just-in-time compiling was successful. The fourth argument should point to an int variable. A return value of 0 means that JIT support is not available -in this version of PCRE, or that the pattern was not studied with the -PCRE_STUDY_JIT_COMPILE option, or that the JIT compiler could not handle this -particular pattern. See the +in this version of PCRE, or that the pattern was not studied with a JIT option, +or that the JIT compiler could not handle this particular pattern. See the pcrejit documentation for details of what can and cannot be handled.PCRE_INFO_JITSIZE-If the pattern was successfully studied with the PCRE_STUDY_JIT_COMPILE option, -return the size of the JIT compiled code, otherwise return zero. The fourth -argument should point to a size_t variable. +If the pattern was successfully studied with a JIT option, return the size of +the JIT compiled code, otherwise return zero. The fourth argument should point +to a size_t variable.PCRE_INFO_LASTLITERAL@@ -1223,16 +1300,41 @@ value, -1 is returned. For anchored patterns, a last l only if it follows something of variable length. For example, for the pattern /^a\d+z\d+/ the returned value is "z", but for /^a\dz\d/ the returned value is -1. + ++Since for the 32-bit library using the non-UTF-32 mode, this function is unable +to return the full 32-bit range of the character, this value is deprecated; +instead the PCRE_INFO_REQUIREDCHARFLAGS and PCRE_INFO_REQUIREDCHAR values should +be used.
+ PCRE_INFO_MATCHLIMIT ++If the pattern set a match limit by including an item of the form +(*LIMIT_MATCH=nnnn) at the start, the value is returned. The fourth argument +should point to an unsigned 32-bit integer. If no such value has been set, the +call to pcre_fullinfo() returns the error PCRE_ERROR_UNSET. ++ PCRE_INFO_MAXLOOKBEHIND ++Return the number of characters (NB not data units) in the longest lookbehind +assertion in the pattern. This information is useful when doing multi-segment +matching using the partial matching facilities. Note that the simple assertions +\b and \B require a one-character lookbehind. \A also registers a +one-character lookbehind, though it does not actually inspect the previous +character. This is to ensure that at least one character from the old segment +is retained when a new segment is processed. Otherwise, if there are no +lookbehinds in the pattern, \A might match incorrectly at the start of a new +segment. +PCRE_INFO_MINLENGTHIf the pattern was studied and a minimum length for matching subject strings was computed, its value is returned. Otherwise the returned value is -1. The -value is a number of characters, which in UTF-8 mode may be different from the -number of bytes. The fourth argument should point to an int variable. A -non-negative value is a lower bound to the length of any matching string. There -may not be any strings of that length that do actually match, but every string -that does match is at least that long. +value is a number of characters, which in UTF mode may be different from the +number of data units. The fourth argument should point to an int +variable. A non-negative value is a lower bound to the length of any matching +string. There may not be any strings of that length that do actually match, but +every string that does match is at least that long.PCRE_INFO_NAMECOUNT PCRE_INFO_NAMEENTRYSIZE @@ -1256,8 +1358,10 @@ length of the longest name. PCRE_INFO_NAMETABLE return entry of the table. This is a pointer to char in the 8-bit library, where the first two bytes of each entry are the number of the capturing parenthesis, most significant byte first. In the 16-bit library, the pointer points to -16-bit data units, the first of which contains the parenthesis number. The rest -of the entry is the corresponding name, zero terminated. +16-bit data units, the first of which contains the parenthesis number. In the +32-bit library, the pointer points to 32-bit data units, the first of which +contains the parenthesis number. The rest of the entry is the corresponding +name, zero terminated.In the 16-bit version of this structure, the mark field has type "PCRE_UCHAR16 **". +The names are in alphabetical order. Duplicate names may appear if (?| is used @@ -1322,9 +1426,16 @@ alternatives begin with one of the following: For such patterns, the PCRE_ANCHORED bit is set in the options returned by pcre_fullinfo().
+ PCRE_INFO_RECURSIONLIMIT ++If the pattern set a recursion limit by including an item of the form +(*LIMIT_RECURSION=nnnn) at the start, the value is returned. The fourth +argument should point to an unsigned 32-bit integer. If no such value has been +set, the call to pcre_fullinfo() returns the error PCRE_ERROR_UNSET. +PCRE_INFO_SIZE-Return the size of the compiled pattern in bytes (for both libraries). The +Return the size of the compiled pattern in bytes (for all three libraries). The fourth argument should point to a size_t variable. This value does not include the size of the pcre structure that is returned by pcre_compile(). The value that is passed as the argument to @@ -1335,17 +1446,92 @@ does not alter the value returned by this option.PCRE_INFO_STUDYSIZE-Return the size in bytes of the data block pointed to by the study_data -field in a pcre_extra block. If pcre_extra is NULL, or there is no -study data, zero is returned. The fourth argument should point to a -size_t variable. The study_data field is set by pcre_study() -to record information that will speed up matching (see the section entitled +Return the size in bytes (for all three libraries) of the data block pointed to +by the study_data field in a pcre_extra block. If pcre_extra +is NULL, or there is no study data, zero is returned. The fourth argument +should point to a size_t variable. The study_data field is set by +pcre_study() to record information that will speed up matching (see the +section entitled "Studying a pattern" above). The format of the study_data block is private, but its length is made available via this option so that it can be saved and restored (see the pcreprecompile documentation for details). ++ PCRE_INFO_FIRSTCHARACTERFLAGS ++Return information about the first data unit of any matched string, for a +non-anchored pattern. The fourth argument should point to an int +variable. ++If there is a fixed first value, for example, the letter "c" from a pattern +such as (cat|cow|coyote), 1 is returned, and the character value can be +retrieved using PCRE_INFO_FIRSTCHARACTER. +
++If there is no fixed first value, and if either +
+
+(a) the pattern was compiled with the PCRE_MULTILINE option, and every branch +starts with "^", or +
+
+(b) every branch of the pattern starts with ".*" and PCRE_DOTALL is not set +(if it were set, the pattern would be anchored), +
+
+2 is returned, indicating that the pattern matches only at the start of a +subject string or after any newline within the string. Otherwise 0 is +returned. For anchored patterns, 0 is returned. ++ PCRE_INFO_FIRSTCHARACTER ++Return the fixed first character value, if PCRE_INFO_FIRSTCHARACTERFLAGS +returned 1; otherwise returns 0. The fourth argument should point to an +uint_t variable. + ++In the 8-bit library, the value is always less than 256. In the 16-bit library +the value can be up to 0xffff. In the 32-bit library in UTF-32 mode the value +can be up to 0x10ffff, and up to 0xffffffff when not using UTF-32 mode. +
++If there is no fixed first value, and if either +
+
+(a) the pattern was compiled with the PCRE_MULTILINE option, and every branch +starts with "^", or +
+
+(b) every branch of the pattern starts with ".*" and PCRE_DOTALL is not set +(if it were set, the pattern would be anchored), +
+
+-1 is returned, indicating that the pattern matches only at the start of a +subject string or after any newline within the string. Otherwise -2 is +returned. For anchored patterns, -2 is returned. ++ PCRE_INFO_REQUIREDCHARFLAGS ++Returns 1 if there is a rightmost literal data unit that must exist in any +matched string, other than at its start. The fourth argument should point to +an int variable. If there is no such value, 0 is returned. If returning +1, the character value itself can be retrieved using PCRE_INFO_REQUIREDCHAR. + ++For anchored patterns, a last literal value is recorded only if it follows +something of variable length. For example, for the pattern /^a\d+z\d+/ the +returned value 1 (with "z" returned from PCRE_INFO_REQUIREDCHAR), but for +/^a\dz\d/ the returned value is 0. +
+ PCRE_INFO_REQUIREDCHAR ++Return the value of the rightmost literal data unit that must exist in any +matched string, other than at its start, if such a value has been recorded. The +fourth argument should point to an uint32_t variable. If there is no such +value, 0 is returned. +
REFERENCE COUNTS
int pcre_refcount(pcre *code, int adjust); @@ -1437,24 +1623,28 @@ fields (not necessarily in this order):
+
+In the 32-bit version of this structure, the mark field has type +"PCRE_UCHAR32 **".-The flags field is a bitmap that specifies which of the other fields -are set. The flag bits are: +The flags field is used to specify which of the other fields are set. The +flag bits are:
- PCRE_EXTRA_STUDY_DATA + PCRE_EXTRA_CALLOUT_DATA PCRE_EXTRA_EXECUTABLE_JIT + PCRE_EXTRA_MARK PCRE_EXTRA_MATCH_LIMIT PCRE_EXTRA_MATCH_LIMIT_RECURSION - PCRE_EXTRA_CALLOUT_DATA + PCRE_EXTRA_STUDY_DATA PCRE_EXTRA_TABLES - PCRE_EXTRA_MARKOther flag bits should be set to zero. The study_data field and sometimes the executable_jit field are set in the pcre_extra block that is returned by pcre_study(), together with the appropriate flag bits. You -should not set these yourself, but you may add to the block by setting the -other fields and their corresponding flag bits. +should not set these yourself, but you may add to the block by setting other +fields and their corresponding flag bits.The match_limit field provides a means of preventing PCRE from using up a @@ -1472,11 +1662,10 @@ in the subject string.
When pcre_exec() is called with a pattern that was successfully studied -with the PCRE_STUDY_JIT_COMPILE option, the way that the matching is executed -is entirely different. However, there is still the possibility of runaway -matching that goes on for a very long time, and so the match_limit value -is also used in this case (but in a different way) to limit how long the -matching can continue. +with a JIT option, the way that the matching is executed is entirely different. +However, there is still the possibility of runaway matching that goes on for a +very long time, and so the match_limit value is also used in this case +(but in a different way) to limit how long the matching can continue.
The default value for the limit can be set when PCRE is built; the default @@ -1487,6 +1676,16 @@ the flags field. If the limit is exceeded, p PCRE_ERROR_MATCHLIMIT.
+A value for the match limit may also be supplied by an item at the start of a +pattern of the form +
+ (*LIMIT_MATCH=d) ++where d is a decimal number. However, such a setting is ignored unless d is +less than the limit set by the caller of pcre_exec() or, if no such limit +is set, less than the default. + +The match_limit_recursion field is similar to match_limit, but instead of limiting the total number of times that match() is called, it limits the depth of recursion. The recursion depth is a smaller number than the @@ -1497,8 +1696,7 @@ This limit is of use only if it is set smaller than
The default value for match_limit_recursion can be set when PCRE is @@ -1509,6 +1707,16 @@ PCRE_EXTRA_MATCH_LIMIT_RECURSION is set in the flag is exceeded, pcre_exec() returns PCRE_ERROR_RECURSIONLIMIT.
+A value for the recursion limit may also be supplied by an item at the start of +a pattern of the form +
+ (*LIMIT_RECURSION=d) ++where d is a decimal number. However, such a setting is ignored unless d is +less than the limit set by the caller of pcre_exec() or, if no such limit +is set, less than the default. + +The callout_data field is used in conjunction with the "callout" feature, and is described in the pcrecallout @@ -1549,16 +1757,16 @@ Option bits for pcre_exec() The unused bits of the options argument for pcre_exec() must be zero. The only bits that may be set are PCRE_ANCHORED, PCRE_NEWLINE_xxx, PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NOTEMPTY_ATSTART, -PCRE_NO_START_OPTIMIZE, PCRE_NO_UTF8_CHECK, PCRE_PARTIAL_SOFT, and -PCRE_PARTIAL_HARD. +PCRE_NO_START_OPTIMIZE, PCRE_NO_UTF8_CHECK, PCRE_PARTIAL_HARD, and +PCRE_PARTIAL_SOFT.
-If the pattern was successfully studied with the PCRE_STUDY_JIT_COMPILE option, -the only supported options for JIT execution are PCRE_NO_UTF8_CHECK, -PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, and PCRE_NOTEMPTY_ATSTART. Note in -particular that partial matching is not supported. If an unsupported option is -used, JIT execution is disabled and the normal interpretive code in -pcre_exec() is run. +If the pattern was successfully studied with one of the just-in-time (JIT) +compile options, the only supported options for JIT execution are +PCRE_NO_UTF8_CHECK, PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, +PCRE_NOTEMPTY_ATSTART, PCRE_PARTIAL_HARD, and PCRE_PARTIAL_SOFT. If an +unsupported option is used, JIT execution is disabled and the normal +interpretive code in pcre_exec() is run.
PCRE_ANCHORED@@ -1670,10 +1878,10 @@ unanchored match must start with a specific character, for that character, and fails immediately if it cannot find it, without actually running the main matching function. This means that a special item such as (*COMMIT) at the start of a pattern is not considered until after a -suitable starting point for the match has been found. When callouts or (*MARK) -items are in use, these "start-up" optimizations can cause them to be skipped -if the pattern is never actually used. The start-up optimizations are in effect -a pre-scan of the subject that takes place before the pattern is run. +suitable starting point for the match has been found. Also, when callouts or +(*MARK) items are in use, these "start-up" optimizations can cause them to be +skipped if the pattern is never actually used. The start-up optimizations are +in effect a pre-scan of the subject that takes place before the pattern is run.The PCRE_NO_START_OPTIMIZE option disables the start-up optimizations, possibly @@ -1681,7 +1889,9 @@ causing performance to suffer, but ensuring that in ca "no match", the callouts do occur, and that items such as (*COMMIT) and (*MARK) are considered at every possible starting position in the subject string. If PCRE_NO_START_OPTIMIZE is set at compile time, it cannot be unset at matching -time. +time. The use of PCRE_NO_START_OPTIMIZE at matching time (that is, passing it +to pcre_exec()) disables JIT execution; in this situation, matching is +always done using interpretively.
Setting PCRE_NO_START_OPTIMIZE can change the outcome of a matching operation. @@ -1715,9 +1925,11 @@ returned.
The subject string is passed to pcre_exec() as a pointer in -subject, a length in bytes in length, and a starting byte offset -in startoffset. If this is negative or greater than the length of the -subject, pcre_exec() returns PCRE_ERROR_BADOFFSET. When the starting -offset is zero, the search for a match starts at the beginning of the subject, -and this is by far the most common case. In UTF-8 mode, the byte offset must -point to the start of a UTF-8 character (or the end of the subject). Unlike the -pattern string, the subject may contain binary zero bytes. +subject, a length in length, and a starting offset in +startoffset. The units for length and startoffset are bytes +for the 8-bit library, 16-bit data items for the 16-bit library, and 32-bit +data items for the 32-bit library.
+If startoffset is negative or greater than the length of the subject, +pcre_exec() returns PCRE_ERROR_BADOFFSET. When the starting offset is +zero, the search for a match starts at the beginning of the subject, and this +is by far the most common case. In UTF-8 or UTF-16 mode, the offset must point +to the start of a character, or the end of the subject (in UTF-32 mode, one +data unit equals one character, so all offsets are valid). Unlike the pattern +string, the subject may contain binary zeroes. +
+A non-zero starting offset is useful when searching for another match in the same subject by calling pcre_exec() again after a previous success. Setting startoffset differs from just passing over a shortened string and @@ -1847,10 +2065,12 @@ rounded down. When a match is successful, information about captured substrings is returned in pairs of integers, starting at the beginning of ovector, and continuing up to two-thirds of its length at the most. The first element of -each pair is set to the byte offset of the first character in a substring, and -the second is set to the byte offset of the first character after the end of a -substring. Note: these values are always byte offsets, even in UTF-8 -mode. They are not character counts. +each pair is set to the offset of the first character in a substring, and the +second is set to the offset of the first character after the end of a +substring. These values are always data unit offsets, even in UTF mode. They +are byte offsets in the 8-bit library, 16-bit data item offsets in the 16-bit +library, and 32-bit data item offsets in the 32-bit library. Note: they +are not character counts.
The first pair of integers, ovector[0] and ovector[1], identify the @@ -1868,7 +2088,7 @@ string that it matched that is returned.
If the vector is too small to hold all the captured substring offsets, it is used as far as possible (up to two-thirds of its length), and the function -returns a value of zero. If neither the actual string matched not any captured +returns a value of zero. If neither the actual string matched nor any captured substrings are of interest, pcre_exec() may be called with ovector passed as NULL and ovecsize as zero. However, if the pattern contains back references and the ovector is not big enough to remember the related @@ -2067,35 +2287,51 @@ time.
PCRE_ERROR_JIT_STACKLIMIT (-27)-This error is returned when a pattern that was successfully studied using the -PCRE_STUDY_JIT_COMPILE option is being matched, but the memory available for -the just-in-time processing stack is not large enough. See the +This error is returned when a pattern that was successfully studied using a +JIT compile option is being matched, but the memory available for the +just-in-time processing stack is not large enough. See the pcrejit documentation for more details.- PCRE_ERROR_BADMODE (-28) + PCRE_ERROR_BADMODE (-28)This error is given if a pattern that was compiled by the 8-bit library is -passed to a 16-bit library function, or vice versa. +passed to a 16-bit or 32-bit library function, or vice versa.- PCRE_ERROR_BADENDIANNESS (-29) + PCRE_ERROR_BADENDIANNESS (-29)This error is given if a pattern that was compiled and saved is reloaded on a host with different endianness. The utility function pcre_pattern_to_host_byte_order() can be used to convert such a pattern so that it runs on the new host. ++ PCRE_ERROR_JIT_BADOPTION ++This error is returned when a pattern that was successfully studied using a JIT +compile option is being matched, but the matching mode (partial or complete +match) does not correspond to any JIT compilation mode. When the JIT fast path +function is used, this error may be also given for invalid options. See the +pcrejit +documentation for more details. ++ PCRE_ERROR_BADLENGTH (-32) ++This error is given if pcre_exec() is called with a negative value for +the length argument.-Error numbers -16 to -20 and -22 are not used by pcre_exec(). +Error numbers -16 to -20, -22, and 30 are not used by pcre_exec().
Reason codes for invalid UTF-8 strings
This section applies only to the 8-bit library. The corresponding information -for the 16-bit library is given in the +for the 16-bit and 32-bit libraries is given in the pcre16 -page. +and +pcre32 +pages.
When pcre_exec() returns either PCRE_ERROR_BADUTF8 or @@ -2166,6 +2402,13 @@ character.
+ PCRE_UTF8_ERR22 ++This error code was formerly used when the presence of a so-called +"non-character" caused an error. Unicode corrigendum #9 makes it clear that +such characters should not cause a string to be rejected, and so this code is +no longer in use and is never returned.
@@ -2581,12 +2824,20 @@ When a recursive subpattern is processed, the matching recursively, using private vectors for ovector and workspace. This error is given if the output vector is not large enough. This should be extremely rare, as a vector of size 1000 is used. +
+ PCRE_ERROR_DFA_BADRESTART (-30) ++When pcre_dfa_exec() is called with the PCRE_DFA_RESTART option, +some plausibility checks are made on the contents of the workspace, which +should contain data about the previous partial match. If any of these checks +fail, this error is given.
-pcre16(3), pcrebuild(3), pcrecallout(3), pcrecpp(3)(3), -pcrematching(3), pcrepartial(3), pcreposix(3), -pcreprecompile(3), pcresample(3), pcrestack(3). +pcre16(3), pcre32(3), pcrebuild(3), pcrecallout(3), +pcrecpp(3)(3), pcrematching(3), pcrepartial(3), +pcreposix(3), pcreprecompile(3), pcresample(3), +pcrestack(3).
@@ -2599,9 +2850,9 @@ Cambridge CB2 3QH, England.
-Last updated: 21 January 2012
+Last updated: 12 May 2013
-Copyright © 1997-2012 University of Cambridge.
+Copyright © 1997-2013 University of Cambridge.
Return to the PCRE index page.