Section 3: library functions
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int pcre2_jit_compile(pcre2_code *code, uint32_t options); Description This function requests JIT compilation, which, if the just-in-time compiler is available, further processes a compiled pattern into machine code that executes much faster than the pcre2_match() interpretive matching function. Full details are given in the pcre2jit documentation. The…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> PCRE2_SIZE pcre2_get_startchar(pcre2_match_data *match_data); Description After a successful call of pcre2_match() that was passed the match block that is this function’s argument, this function returns the code unit offset of the character at which the successful match started. For a non-partial match, this can be different…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> PCRE2_SIZE *pcre2_get_ovector_pointer(pcre2_match_data *match_data); Description This function returns a pointer to the vector of offsets that forms part of the given match data block. The number of pairs can be found by calling pcre2_get_ovector_count(). There is a complete description of the PCRE2 native API in the…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> uint32_t pcre2_get_ovector_count(pcre2_match_data *match_data); Description This function returns the number of pairs of offsets in the ovector that forms part of the given match data block. There is a complete description of the PCRE2 native API in the pcre2api page and a description of the POSIX…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> PCRE2_SIZE pcre2_get_match_data_size(pcre2_match_data *match_data); Description This function returns the size, in bytes, of the match data block that is its argument. There is a complete description of the PCRE2 native API in the pcre2api page and a description of the POSIX API in the pcre2posix page.
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> PCRE2_SPTR pcre2_get_mark(pcre2_match_data *match_data); Description After a call of pcre2_match() that was passed the match block that is this function’s argument, this function returns a pointer to the last (*MARK), (*PRUNE), or (*THEN) name that was encountered during the matching process. The name is zero-terminated, and…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int pcre2_get_error_message(int errorcode, PCRE2_UCHAR *buffer, PCRE2_SIZE bufflen); Description This function provides a textual error message for each PCRE2 error code. Compilation errors are positive numbers; UTF formatting errors and matching errors are negative numbers. The arguments are: errorcode an error code (positive or negative) buffer where to put…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> void pcre2_general_context_free(pcre2_general_context *gcontext); Description This function frees the memory occupied by a general context, using the memory freeing function within the context, if set. If the argument is NULL, the function returns immediately without doing anything. There is a complete description of the PCRE2 native…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> pcre2_general_context *pcre2_general_context_create( void *(*private_malloc)(PCRE2_SIZE, void *), void (*private_free)(void *, void *), void *memory_data); Description This function creates and initializes a general context. The arguments define custom memory management functions and a data value that is passed to them when they are called. The private_malloc() function…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> pcre2_general_context *pcre2_general_context_copy( pcre2_general_context *gcontext); Description This function makes a new copy of a general context, using the memory allocation functions in the context, if set, to get the necessary memory. Otherwise malloc() is used. The result is NULL if the memory cannot be obtained. There…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int pcre2_dfa_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, int *workspace, PCRE2_SIZE wscount); Description This function matches a compiled regular expression against a given subject string, using an alternative matching algorithm that scans the subject string just once…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> void pcre2_converted_pattern_free(PCRE2_UCHAR *converted_pattern); Description This function is part of an experimental set of pattern conversion functions. It frees the memory occupied by a converted pattern that was obtained by calling pcre2_pattern_convert() with arguments that caused it to place the converted pattern into newly obtained heap…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> void pcre2_convert_context_free(pcre2_convert_context *cvcontext); Description This function is part of an experimental set of pattern conversion functions. It frees the memory occupied by a convert context, using the memory freeing function from the general context with which it was created, or free() if that was not…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> pcre2_convert_context *pcre2_convert_context_create( pcre2_general_context *gcontext); Description This function is part of an experimental set of pattern conversion functions. It creates and initializes a new convert context. If its argument is NULL, malloc() is used to get the necessary memory; otherwise the memory allocation function within the…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> pcre2_convert_context *pcre2_convert_context_copy( pcre2_convert_context *cvcontext); Description This function is part of an experimental set of pattern conversion functions. It makes a new copy of a convert context, using the memory allocation function that was used for the original context. The result is NULL if the memory…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int pcre2_config(uint32_t what, void *where); Description This function makes it possible for a client program to find out which optional features are available in the version of the PCRE2 library it is using. The arguments are as follows: what A code specifying what information is required…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> void pcre2_compile_context_free(pcre2_compile_context *ccontext); Description This function frees the memory occupied by a compile 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_compile_context *pcre2_compile_context_create( pcre2_general_context *gcontext); Description This function creates and initializes a new compile 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_compile_context *pcre2_compile_context_copy( pcre2_compile_context *ccontext); Description This function makes a new copy of a compile 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> pcre2_code *pcre2_compile(PCRE2_SPTR pattern, PCRE2_SIZE length, uint32_t options, int *errorcode, PCRE2_SIZE *erroroffset, pcre2_compile_context *ccontext); Description This function compiles a regular expression pattern into an internal form. Its arguments are: pattern A string containing expression to be compiled length The length of the string or PCRE2_ZERO_TERMINATED options Option bits errorcode Where…