Section 3: library functions
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int32_t pcre2_serialize_get_number_of_codes(const uint8_t *bytes); Description The bytes argument must point to a serialized byte stream that was originally created by pcre2_serialize_encode() (though it may have been saved on disc or elsewhere in the meantime). The function returns the number of serialized patterns in the byte…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> void pcre2_serialize_free(uint8_t *bytes); Description This function frees the memory that was obtained by pcre2_serialize_encode() to hold a serialized byte stream. The argument must point to such a byte stream or be NULL, in which case the function returns without doing anything. There is a complete…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int32_t pcre2_serialize_encode(const pcre2_code **codes, int32_t number_of_codes, uint8_t **serialized_bytes, PCRE2_SIZE *serialized_size, pcre2_general_context *gcontext); Description This function encodes a list of compiled patterns into a byte stream that can be saved on disc or elsewhere. Note that this is not an abstract format like Java or .NET….
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int32_t pcre2_serialize_decode(pcre2_code **codes, int32_t number_of_codes, const uint8_t *bytes, pcre2_general_context *gcontext); Description This function decodes a serialized set of compiled patterns back into a list of individual patterns. This is possible only on a host that is running the same version of PCRE2, with the same…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int pcre2_pattern_info(const pcre2_code *code, uint32_t what, void *where); Description This function returns information about a compiled pattern. Its arguments are: code Pointer to a compiled regular expression pattern what What information is required where Where to put the information The recognized values for the what argument, and the…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int pcre2_pattern_convert(PCRE2_SPTR pattern, PCRE2_SIZE length, uint32_t options, PCRE2_UCHAR **buffer, PCRE2_SIZE *blength, pcre2_convert_context *cvcontext); Description This function is part of an experimental set of pattern conversion functions. It converts a foreign pattern (for example, a glob) into a PCRE2 regular expression pattern. Its arguments are: pattern The…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> void pcre2_match_data_free(pcre2_match_data *match_data); Description If match_data is NULL, this function does nothing. Otherwise, match_data must point to a match data block, which this function frees, using the memory freeing function from the general context or compiled pattern with which it was created, or free() if…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> pcre2_match_data *pcre2_match_data_create_from_pattern( const pcre2_code *code, pcre2_general_context *gcontext); Description This function creates a new match data block, which is used for holding the result of a match. The first argument points to a compiled pattern. The number of capturing parentheses within the pattern is used to…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> pcre2_match_data *pcre2_match_data_create(uint32_t ovecsize, pcre2_general_context *gcontext); Description This function creates a new match data block, which is used for holding the result of a match. The first argument specifies the number of pairs of offsets that are required. These form the "output vector" (ovector) within the…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> void pcre2_match_context_free(pcre2_match_context *mcontext); Description This function frees the memory occupied by a match context, using the memory freeing function from the general context with which it was created, or free() if that was not set. If the argument is NULL, the function returns immediately without…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> pcre2_match_context *pcre2_match_context_create( pcre2_general_context *gcontext); Description This function creates and initializes a new match context. If its argument is NULL, malloc() is used to get the necessary memory; otherwise the memory allocation function within the general context is used. The result is NULL if the memory…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> pcre2_match_context *pcre2_match_context_copy( pcre2_match_context *mcontext); Description This function makes a new copy of a match context, using the memory allocation function that was used for the original context. The result is NULL if the memory cannot be obtained. There is a complete description of the PCRE2…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int pcre2_match(const pcre2_code *code, PCRE2_SPTR subject, PCRE2_SIZE length, PCRE2_SIZE startoffset, uint32_t options, pcre2_match_data *match_data, pcre2_match_context *mcontext); Description This function matches a compiled regular expression against a given subject string, using a matching algorithm that is similar to Perl’s. It returns offsets to what it has…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> void pcre2_maketables_free(pcre2_general_context *gcontext, const uint8_t *tables); Description This function discards a set of character tables that were created by a call to pcre2_maketables(). The gcontext parameter should match what was used in that call to account for any custom allocators that might be in use;…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> const uint8_t *pcre2_maketables(pcre2_general_context *gcontext); Description This function builds a set of character tables for character code points that are less than 256. These can be passed to pcre2_compile() in a compile context in order to override the internal, built-in tables (which were either defaulted or…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> void pcre2_jit_stack_free(pcre2_jit_stack *jit_stack); Description This function is used to free a JIT stack that was created by pcre2_jit_stack_create() when it is no longer needed. If the argument is NULL, the function returns immediately without doing anything. For more details, see the pcre2jit page. There is…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> pcre2_jit_stack *pcre2_jit_stack_create(PCRE2_SIZE startsize, PCRE2_SIZE maxsize, pcre2_general_context *gcontext); Description This function is used to create a stack for use by the code compiled by the JIT compiler. The first two arguments are a starting size for the stack, and a maximum size to which it is…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> void pcre2_jit_stack_assign(pcre2_match_context *mcontext, pcre2_jit_callback callback_function, void *callback_data); Description This function provides control over the memory used by JIT as a run-time stack when pcre2_match() or pcre2_jit_match() is called with a pattern that has been successfully processed by the JIT compiler. The information that determines which…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int pcre2_jit_match(const pcre2_code *code, PCRE2_SPTR subject, PCRE2_SIZE length, PCRE2_SIZE startoffset, uint32_t options, pcre2_match_data *match_data, pcre2_match_context *mcontext); Description This function matches a compiled regular expression that has been successfully processed by the JIT compiler against a given subject string, using a matching algorithm that is similar…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> void pcre2_jit_free_unused_memory(pcre2_general_context *gcontext); Description This function frees unused JIT executable memory. The argument is a general context, for custom memory management, or NULL for standard memory management. JIT memory allocation retains some memory in order to improve future JIT compilation speed. In low memory conditions,…