PCRE2CALLOUT(3) Library Functions Manual PCRE2CALLOUT(3) NNAAMMEE PCRE2 - Perl-compatible regular expressions (revised API) SSYYNNOOPPSSIISS ##iinncclluuddee <> iinntt ((**ppccrree22__ccaalllloouutt))((ppccrree22__ccaalllloouutt__bblloocckk **,, vvooiidd **));; iinntt ppccrree22__ccaalllloouutt__eennuummeerraattee((ccoonnsstt ppccrree22__ccooddee **_c_o_d_e,, iinntt ((**_c_a_l_l_b_a_c_k))((ppccrree22__ccaalllloouutt__eennuummeerraattee__bblloocckk **,, vvooiidd **)),, vvooiidd **_u_s_e_r___d_a_t_a));; DDEESSCCRRIIPPTTIIOONN PCRE2 provides a feature called "callout", which is a means of tempo- rarily passing control to the caller of PCRE2 in the middle of pattern matching. The caller of PCRE2 provides an external function by putting its entry point in a match context (see ppccrree22__sseett__ccaalllloouutt(()) in the ppccrree22aappii documentation). Within a regular expression, (?C) indicates a point at which the external function is to be called. Different callout points can be identified by putting a number less than 256 after the letter C. The default value is zero. Alternatively, the argument may be a delimited string. The starting delimiter must be one of ` ' " ^ % # $ { and the ending delimiter is the same as the start, except for {, where the end- ing delimiter is }. If the ending delimiter is needed within the string, it must be doubled. For example, this pattern has two callout points: (?C1)abc(?C"some ""arbitrary"" text")def If the PCRE2_AUTO_CALLOUT option bit is set when a pattern is compiled, PCRE2 automatically inserts callouts, all with number 255, before each item in the pattern except for immediately before or after an explicit callout. For example, if PCRE2_AUTO_CALLOUT is used with the pattern A(?C3)B it is processed as if it were (?C255)A(?C3)B(?C255) Here is a more complicated example: A(\d{2}|--) With PCRE2_AUTO_CALLOUT, this pattern is processed as if it were (?C255)A(?C255)((?C255)\d{2}(?C255)|(?C255)-(?C255)-(?C255))(?C255) Notice that there is a callout before and after each parenthesis and alternation bar. If the pattern contains a conditional group whose con- dition is an assertion, an automatic callout is inserted immediately before the condition. Such a callout may also be inserted explicitly, for example: (?(?C9)(?=a)ab|de) (?(?C%text%)(?!=d)ab|de) This applies only to assertion conditions (because they are themselves independent groups). Callouts can be useful for tracking the progress of pattern matching. The ppccrree22tteesstt program has a pattern qualifier (/auto_callout) that sets automatic callouts. When any callouts are present, the output from ppccrree22tteesstt indicates how the pattern is being matched. This is useful information when you are trying to optimize the performance of a par- ticular pattern. MMIISSSSIINNGG CCAALLLLOOUUTTSS You should be aware that, because of optimizations in the way PCRE2 compiles and matches patterns, callouts sometimes do not happen exactly as you might expect. AAuuttoo--ppoosssseessssiiffiiccaattiioonn At compile time, PCRE2 "auto-possessifies" repeated items when it knows that what follows cannot be part of the repeat. For example, a+[bc] is compiled as if it were a++[bc]. The ppccrree22tteesstt output when this pattern is compiled with PCRE2_ANCHORED and PCRE2_AUTO_CALLOUT and then applied to the string "aaaa" is: --->aaaa +0 ^ a+ +2 ^ ^ [bc] No match This indicates that when matching [bc] fails, there is no backtracking into a+ (because it is being treated as a++) and therefore the callouts that would be taken for the backtracks do not occur. You can disable the auto-possessify feature by passing PCRE2_NO_AUTO_POSSESS to ppccrree22__ccoommppiillee(()), or starting the pattern with (*NO_AUTO_POSSESS). In this case, the output changes to this: --->aaaa +0 ^ a+ +2 ^ ^ [bc] +2 ^ ^ [bc] +2 ^ ^ [bc] +2 ^^ [bc] No match This time, when matching [bc] fails, the matcher backtracks into a+ and tries again, repeatedly, until a+ itself fails. AAuuttoommaattiicc ..** aanncchhoorriinngg By default, an optimization is applied when .* is the first significant item in a pattern. If PCRE2_DOTALL is set, so that the dot can match any character, the pattern is automatically anchored. If PCRE2_DOTALL is not set, a match can start only after an internal newline or at the beginning of the subject, and ppccrree22__ccoommppiillee(()) remembers this. If a pat- tern has more than one top-level branch, automatic anchoring occurs if all branches are anchorable. This optimization is disabled, however, if .* is in an atomic group or if there is a back reference to the capturing group in which it appears. It is also disabled if the pattern contains (*PRUNE) or (*SKIP). However, the presence of callouts does not affect it. For example, if the pattern .*\d is compiled with PCRE2_AUTO_CALLOUT and applied to the string "aa", the ppccrree22tteesstt output is: --->aa +0 ^ .* +2 ^ ^ \d +2 ^^ \d +2 ^ \d No match This shows that all match attempts start at the beginning of the sub- ject. In other words, the pattern is anchored. You can disable this optimization by passing PCRE2_NO_DOTSTAR_ANCHOR to ppccrree22__ccoommppiillee(()), or starting the pattern with (*NO_DOTSTAR_ANCHOR). In this case, the out- put changes to: --->aa +0 ^ .* +2 ^ ^ \d +2 ^^ \d +2 ^ \d +0 ^ .* +2 ^^ \d +2 ^ \d No match This shows more match attempts, starting at the second subject charac- ter. Another optimization, described in the next section, means that there is no subsequent attempt to match with an empty subject. OOtthheerr ooppttiimmiizzaattiioonnss Other optimizations that provide fast "no match" results also affect callouts. For example, if the pattern is ab(?C4)cd PCRE2 knows that any matching string must contain the letter "d". If the subject string is "abyz", the lack of "d" means that matching doesn't ever start, and the callout is never reached. However, with "abyd", though the result is still no match, the callout is obeyed. For most patterns PCRE2 also knows the minimum length of a matching string, and will immediately give a "no match" return without actually running a match if the subject is not long enough, or, for unanchored patterns, if it has been scanned far enough. You can disable these optimizations by passing the PCRE2_NO_START_OPTI- MIZE option to ppccrree22__ccoommppiillee(()), or by starting the pattern with (*NO_START_OPT). This slows down the matching process, but does ensure that callouts such as the example above are obeyed. TTHHEE CCAALLLLOOUUTT IINNTTEERRFFAACCEE During matching, when PCRE2 reaches a callout point, if an external function is provided in the match context, it is called. This applies to both normal, DFA, and JIT matching. The first argument to the call- out function is a pointer to a ppccrree22__ccaalllloouutt block. The second argument is the void * callout data that was supplied when the callout was set up by calling ppccrree22__sseett__ccaalllloouutt(()) (see the ppccrree22aappii documentation). The callout block structure contains the following fields, not necessarily in this order: uint32_t _v_e_r_s_i_o_n; uint32_t _c_a_l_l_o_u_t___n_u_m_b_e_r; uint32_t _c_a_p_t_u_r_e___t_o_p; uint32_t _c_a_p_t_u_r_e___l_a_s_t; uint32_t _c_a_l_l_o_u_t___f_l_a_g_s; PCRE2_SIZE *_o_f_f_s_e_t___v_e_c_t_o_r; PCRE2_SPTR _m_a_r_k; PCRE2_SPTR _s_u_b_j_e_c_t; PCRE2_SIZE _s_u_b_j_e_c_t___l_e_n_g_t_h; PCRE2_SIZE _s_t_a_r_t___m_a_t_c_h; PCRE2_SIZE _c_u_r_r_e_n_t___p_o_s_i_t_i_o_n; PCRE2_SIZE _p_a_t_t_e_r_n___p_o_s_i_t_i_o_n; PCRE2_SIZE _n_e_x_t___i_t_e_m___l_e_n_g_t_h; PCRE2_SIZE _c_a_l_l_o_u_t___s_t_r_i_n_g___o_f_f_s_e_t; PCRE2_SIZE _c_a_l_l_o_u_t___s_t_r_i_n_g___l_e_n_g_t_h; PCRE2_SPTR _c_a_l_l_o_u_t___s_t_r_i_n_g; The _v_e_r_s_i_o_n field contains the version number of the block format. The current version is 2; the three callout string fields were added for version 1, and the _c_a_l_l_o_u_t___f_l_a_g_s field for version 2. If you are writ- ing an application that might use an earlier release of PCRE2, you should check the version number before accessing any of these fields. The version number will increase in future if more fields are added, but the intention is never to remove any of the existing fields. FFiieellddss ffoorr nnuummeerriiccaall ccaalllloouuttss For a numerical callout, _c_a_l_l_o_u_t___s_t_r_i_n_g is NULL, and _c_a_l_l_o_u_t___n_u_m_b_e_r contains the number of the callout, in the range 0-255. This is the number that follows (?C for callouts that part of the pattern; it is 255 for automatically generated callouts. FFiieellddss ffoorr ssttrriinngg ccaalllloouuttss For callouts with string arguments, _c_a_l_l_o_u_t___n_u_m_b_e_r is always zero, and _c_a_l_l_o_u_t___s_t_r_i_n_g points to the string that is contained within the com- piled pattern. Its length is given by _c_a_l_l_o_u_t___s_t_r_i_n_g___l_e_n_g_t_h. Duplicated ending delimiters that were present in the original pattern string have been turned into single characters, but there is no other processing of the callout string argument. An additional code unit containing binary zero is present after the string, but is not included in the length. The delimiter that was used to start the string is also stored within the pattern, immediately before the string itself. You can access this delimiter as _c_a_l_l_o_u_t___s_t_r_i_n_g[-1] if you need it. The _c_a_l_l_o_u_t___s_t_r_i_n_g___o_f_f_s_e_t field is the code unit offset to the start of the callout argument string within the original pattern string. This is provided for the benefit of applications such as script languages that might need to report errors in the callout string within the pattern. FFiieellddss ffoorr aallll ccaalllloouuttss The remaining fields in the callout block are the same for both kinds of callout. The _o_f_f_s_e_t___v_e_c_t_o_r field is a pointer to a vector of capturing offsets (the "ovector"). You may read the elements in this vector, but you must not change any of them. For calls to ppccrree22__mmaattcchh(()), the _o_f_f_s_e_t___v_e_c_t_o_r field is not (since release 10.30) a pointer to the actual ovector that was passed to the matching function in the match data block. Instead it points to an internal ovector of a size large enough to hold all possible captured substrings in the pattern. Note that whenever a recursion or subroutine call within a pattern completes, the capturing state is reset to what it was before. The _c_a_p_t_u_r_e___l_a_s_t field contains the number of the most recently cap- tured substring, and the _c_a_p_t_u_r_e___t_o_p field contains one more than the number of the highest numbered captured substring so far. If no sub- strings have yet been captured, the value of _c_a_p_t_u_r_e___l_a_s_t is 0 and the value of _c_a_p_t_u_r_e___t_o_p is 1. The values of these fields do not always differ by one; for example, when the callout in the pattern ((a)(b))(?C2) is taken, _c_a_p_t_u_r_e___l_a_s_t is 1 but _c_a_p_t_u_r_e___t_o_p is 4. The contents of ovector[2] to ovector[*2-1] can be inspected in order to extract substrings that have been matched so far, in the same way as extracting substrings after a match has completed. The values in ovector[0] and ovector[1] are always PCRE2_UNSET because the match is by definition not complete. Substrings that have not been captured but whose numbers are less than _c_a_p_t_u_r_e___t_o_p also have both of their ovector slots set to PCRE2_UNSET. For DFA matching, the _o_f_f_s_e_t___v_e_c_t_o_r field points to the ovector that was passed to the matching function in the match data block, but it holds no useful information at callout time because ppccrree22__ddffaa__mmaattcchh(()) does not support substring capturing. The value of _c_a_p_t_u_r_e___t_o_p is always 1 and the value of _c_a_p_t_u_r_e___l_a_s_t is always 0 for DFA matching. The _s_u_b_j_e_c_t and _s_u_b_j_e_c_t___l_e_n_g_t_h fields contain copies of the values that were passed to the matching function. The _s_t_a_r_t___m_a_t_c_h field normally contains the offset within the subject at which the current match attempt started. However, if the escape sequence \K has been encountered, this value is changed to reflect the modified starting point. If the pattern is not anchored, the callout function may be called several times from the same point in the pattern for different starting points in the subject. The _c_u_r_r_e_n_t___p_o_s_i_t_i_o_n field contains the offset within the subject of the current match pointer. The _p_a_t_t_e_r_n___p_o_s_i_t_i_o_n field contains the offset in the pattern string to the next item to be matched. The _n_e_x_t___i_t_e_m___l_e_n_g_t_h field contains the length of the next item to be processed in the pattern string. When the callout is at the end of the pattern, the length is zero. When the callout precedes an opening parenthesis, the length includes meta characters that follow the paren- thesis. For example, in a callout before an assertion such as (?=ab) the length is 3. For an an alternation bar or a closing parenthesis, the length is one, unless a closing parenthesis is followed by a quan- tifier, in which case its length is included. (This changed in release 10.23. In earlier releases, before an opening parenthesis the length was that of the entire subpattern, and before an alternation bar or a closing parenthesis the length was zero.) The _p_a_t_t_e_r_n___p_o_s_i_t_i_o_n and _n_e_x_t___i_t_e_m___l_e_n_g_t_h fields are intended to help in distinguishing between different automatic callouts, which all have the same callout number. However, they are set for all callouts, and are used by ppccrree22tteesstt to show the next item to be matched when display- ing callout information. In callouts from ppccrree22__mmaattcchh(()) the _m_a_r_k field contains a pointer to the zero-terminated name of the most recently passed (*MARK), (*PRUNE), or (*THEN) item in the match, or NULL if no such items have been passed. Instances of (*PRUNE) or (*THEN) without a name do not obliterate a previous (*MARK). In callouts from the DFA matching function this field always contains NULL. The _c_a_l_l_o_u_t___f_l_a_g_s field is always zero in callouts from ppccrree22__ddffaa__mmaattcchh(()) or when JIT is being used. When ppccrree22__mmaattcchh(()) without JIT is used, the following bits may be set: PCRE2_CALLOUT_STARTMATCH This is set for the first callout after the start of matching for each new starting position in the subject. PCRE2_CALLOUT_BACKTRACK This is set if there has been a matching backtrack since the previous callout, or since the start of matching if this is the first callout from a ppccrree22__mmaattcchh(()) run. Both bits are set when a backtrack has caused a "bumpalong" to a new starting position in the subject. Output from ppccrree22tteesstt does not indi- cate the presence of these bits unless the ccaalllloouutt__eexxttrraa modifier is set. The information in the ccaalllloouutt__ffllaaggss field is provided so that applica- tions can track and tell their users how matching with backtracking is done. This can be useful when trying to optimize patterns, or just to understand how PCRE2 works. There is no support in ppccrree22__ddffaa__mmaattcchh(()) because there is no backtracking in DFA matching, and there is no sup- port in JIT because JIT is all about maximimizing matching performance. In both these cases the ccaalllloouutt__ffllaaggss field is always zero. RREETTUURRNN VVAALLUUEESS FFRROOMM CCAALLLLOOUUTTSS The external callout function returns an integer to PCRE2. If the value is zero, matching proceeds as normal. If the value is greater than zero, matching fails at the current point, but the testing of other matching possibilities goes ahead, just as if a lookahead assertion had failed. If the value is less than zero, the match is abandoned, and the matching function returns the negative value. Negative values should normally be chosen from the set of PCRE2_ERROR_xxx values. In particular, PCRE2_ERROR_NOMATCH forces a standard "no match" failure. The error number PCRE2_ERROR_CALLOUT is reserved for use by callout functions; it will never be used by PCRE2 itself. CCAALLLLOOUUTT EENNUUMMEERRAATTIIOONN iinntt ppccrree22__ccaalllloouutt__eennuummeerraattee((ccoonnsstt ppccrree22__ccooddee **_c_o_d_e,, iinntt ((**_c_a_l_l_b_a_c_k))((ppccrree22__ccaalllloouutt__eennuummeerraattee__bblloocckk **,, vvooiidd **)),, vvooiidd **_u_s_e_r___d_a_t_a));; A script language that supports the use of string arguments in callouts might like to scan all the callouts in a pattern before running the match. This can be done by calling ppccrree22__ccaalllloouutt__eennuummeerraattee(()). The first argument is a pointer to a compiled pattern, the second points to a callback function, and the third is arbitrary user data. The callback function is called for every callout in the pattern in the order in which they appear. Its first argument is a pointer to a callout enumer- ation block, and its second argument is the _u_s_e_r___d_a_t_a value that was passed to ppccrree22__ccaalllloouutt__eennuummeerraattee(()). The data block contains the fol- lowing fields: _v_e_r_s_i_o_n Block version number _p_a_t_t_e_r_n___p_o_s_i_t_i_o_n Offset to next item in pattern _n_e_x_t___i_t_e_m___l_e_n_g_t_h Length of next item in pattern _c_a_l_l_o_u_t___n_u_m_b_e_r Number for numbered callouts _c_a_l_l_o_u_t___s_t_r_i_n_g___o_f_f_s_e_t Offset to string within pattern _c_a_l_l_o_u_t___s_t_r_i_n_g___l_e_n_g_t_h Length of callout string _c_a_l_l_o_u_t___s_t_r_i_n_g Points to callout string or is NULL The version number is currently 0. It will increase if new fields are ever added to the block. The remaining fields are the same as their namesakes in the ppccrree22__ccaalllloouutt block that is used for callouts during matching, as described above. Note that the value of _p_a_t_t_e_r_n___p_o_s_i_t_i_o_n is unique for each callout. However, if a callout occurs inside a group that is quantified with a non-zero minimum or a fixed maximum, the group is replicated inside the compiled pattern. For example, a pattern such as /(a){2}/ is compiled as if it were /(a)(a)/. This means that the callout will be enumerated more than once, but with the same value for _p_a_t_t_e_r_n___p_o_s_i_t_i_o_n in each case. The callback function should normally return zero. If it returns a non- zero value, scanning the pattern stops, and that value is returned from ppccrree22__ccaalllloouutt__eennuummeerraattee(()). AAUUTTHHOORR Philip Hazel University Computing Service Cambridge, England. RREEVVIISSIIOONN Last updated: 22 December 2017 Copyright (c) 1997-2017 University of Cambridge. PCRE2 10.31 22 December 2017 PCRE2CALLOUT(3)