Section 3: library functions
PCRE – Perl-compatible regular expressions #include < pcre.h> Pcre Native Api Basic Functions pcre *pcre_compile(const char *pattern, int options, const char **errptr, int *erroffset, const unsigned char *tableptr); pcre *pcre_compile2(const char *pattern, int options, int *errorcodeptr, const char **errptr, int *erroffset, const unsigned char *tableptr); pcre_extra *pcre_study(const pcre *code, int options, const char **errptr); void…
PCRE – Perl-compatible regular expressions Synopsis #include <pcre.h> const char *pcre_version(void); const char *pcre16_version(void); const char *pcre32_version(void); Description This function (even in the 16-bit and 32-bit libraries) returns a zero-terminated, 8-bit character string that gives the version number of the PCRE library and the date of its release. There is a complete description of the…
PCRE – Perl-compatible regular expressions Synopsis #include <pcre.h> int pcre32_utf32_to_host_byte_order(PCRE_UCHAR32 *output, PCRE_SPTR32 input, int length, int *host_byte_order, int keep_boms); Description This function, which exists only in the 32-bit library, converts a UTF-32 string to the correct order for the current host, taking account of any byte order marks (BOMs) within the string. Its arguments are:…
PCRE – Perl-compatible regular expressions Synopsis #include <pcre.h> int pcre16_utf16_to_host_byte_order(PCRE_UCHAR16 *output, PCRE_SPTR16 input, int length, int *host_byte_order, int keep_boms); Description This function, which exists only in the 16-bit library, converts a UTF-16 string to the correct order for the current host, taking account of any byte order marks (BOMs) within the string. Its arguments are:…
PCRE – Perl-compatible regular expressions Synopsis #include <pcre.h> pcre_extra *pcre_study(const pcre *code, int options, const char **errptr); pcre16_extra *pcre16_study(const pcre16 *code, int options, const char **errptr); pcre32_extra *pcre32_study(const pcre32 *code, int options, const char **errptr); Description This function studies a compiled pattern, to see if additional information can be extracted that might speed up matching….
PCRE – Perl-compatible regular expressions Synopsis #include <pcre.h> int pcre_refcount(pcre *code, int adjust); int pcre16_refcount(pcre16 *code, int adjust); int pcre32_refcount(pcre32 *code, int adjust); Description This function is used to maintain a reference count inside a data block that contains a compiled pattern. Its arguments are: code Compiled regular expression adjust Adjustment to reference value The yield of…
PCRE – Perl-compatible regular expressions Synopsis #include <pcre.h> int pcre_pattern_to_host_byte_order(pcre *code, pcre_extra *extra, const unsigned char *tables); int pcre16_pattern_to_host_byte_order(pcre16 *code, pcre16_extra *extra, const unsigned char *tables); int pcre32_pattern_to_host_byte_order(pcre32 *code, pcre32_extra *extra, const unsigned char *tables); Description This function ensures that the bytes in 2-byte and 4-byte values in a compiled pattern are in the correct…
PCRE – Perl-compatible regular expressions Synopsis #include <pcre.h> const unsigned char *pcre_maketables(void); const unsigned char *pcre16_maketables(void); const unsigned char *pcre32_maketables(void); Description This function builds a set of character tables for character values less than 256. These can be passed to pcre[16|32]_compile() to override PCRE’s internal, built-in tables (which were made by pcre[16|32]_maketables() when PCRE was…
PCRE – Perl-compatible regular expressions Synopsis #include <pcre.h> void pcre_jit_stack_free(pcre_jit_stack *stack); void pcre16_jit_stack_free(pcre16_jit_stack *stack); void pcre32_jit_stack_free(pcre32_jit_stack *stack); Description This function is used to free a JIT stack that was created by pcre[16|32]_jit_stack_alloc() when it is no longer needed. For more details, see the pcrejit page. There is a complete description of the PCRE native API…
PCRE – Perl-compatible regular expressions Synopsis #include <pcre.h> pcre_jit_stack *pcre_jit_stack_alloc(int startsize, int maxsize); pcre16_jit_stack *pcre16_jit_stack_alloc(int startsize, int maxsize); pcre32_jit_stack *pcre32_jit_stack_alloc(int startsize, int maxsize); Description This function is used to create a stack for use by the code compiled by the JIT optimization of pcre[16|32]_study(). The arguments are a starting size for the stack, and a…
PCRE – Perl-compatible regular expressions Synopsis #include <pcre.h> 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); int pcre16_jit_exec(const pcre16 *code, const pcre16_extra *extra, PCRE_SPTR16 subject, int length, int startoffset, int options, int *ovector, int ovecsize, pcre_jit_stack *jstack); int pcre32_jit_exec(const pcre32 *code,…
PCRE – Perl-compatible regular expressions Synopsis #include <pcre.h> int pcre_get_substring_list(const char *subject, int *ovector, int stringcount, const char ***listptr); int pcre16_get_substring_list(PCRE_SPTR16 subject, int *ovector, int stringcount, PCRE_SPTR16 **listptr); int pcre32_get_substring_list(PCRE_SPTR32 subject, int *ovector, int stringcount, PCRE_SPTR32 **listptr); Description This is a convenience function for extracting a list of all the captured substrings. The arguments are:…
PCRE – Perl-compatible regular expressions Synopsis #include <pcre.h> int pcre_get_substring(const char *subject, int *ovector, int stringcount, int stringnumber, const char **stringptr); int pcre16_get_substring(PCRE_SPTR16 subject, int *ovector, int stringcount, int stringnumber, PCRE_SPTR16 *stringptr); int pcre32_get_substring(PCRE_SPTR32 subject, int *ovector, int stringcount, int stringnumber, PCRE_SPTR32 *stringptr); Description This is a convenience function for extracting a captured substring. The…
PCRE – Perl-compatible regular expressions Synopsis #include <pcre.h> int pcre_get_stringtable_entries(const pcre *code, const char *name, char **first, char **last); int pcre16_get_stringtable_entries(const pcre16 *code, PCRE_SPTR16 name, PCRE_UCHAR16 **first, PCRE_UCHAR16 **last); int pcre32_get_stringtable_entries(const pcre32 *code, PCRE_SPTR32 name, PCRE_UCHAR32 **first, PCRE_UCHAR32 **last); Description This convenience function finds, for a compiled pattern, the first and last entries for a…
PCRE – Perl-compatible regular expressions Synopsis #include <pcre.h> int pcre_get_stringnumber(const pcre *code, const char *name); int pcre16_get_stringnumber(const pcre16 *code, PCRE_SPTR16 name); int pcre32_get_stringnumber(const pcre32 *code, PCRE_SPTR32 name); Description This convenience function finds the number of a named substring capturing parenthesis in a compiled pattern. Its arguments are: code Compiled regular expression name Name whose number is required…
PCRE – Perl-compatible regular expressions Synopsis #include <pcre.h> int pcre_get_named_substring(const pcre *code, const char *subject, int *ovector, int stringcount, const char *stringname, const char **stringptr); int pcre16_get_named_substring(const pcre16 *code, PCRE_SPTR16 subject, int *ovector, int stringcount, PCRE_SPTR16 stringname, PCRE_SPTR16 *stringptr); int pcre32_get_named_substring(const pcre32 *code, PCRE_SPTR32 subject, int *ovector, int stringcount, PCRE_SPTR32 stringname, PCRE_SPTR32 *stringptr); Description This…
PCRE – Perl-compatible regular expressions Synopsis #include <pcre.h> int pcre_fullinfo(const pcre *code, const pcre_extra *extra, int what, void *where); int pcre16_fullinfo(const pcre16 *code, const pcre16_extra *extra, int what, void *where); int pcre32_fullinfo(const pcre32 *code, const pcre32_extra *extra, int what, void *where); Description This function returns information about a compiled pattern. Its arguments are: code Compiled regular…
PCRE – Perl-compatible regular expressions Synopsis #include <pcre.h> void pcre_free_substring_list(const char **stringptr); void pcre16_free_substring_list(PCRE_SPTR16 *stringptr); void pcre32_free_substring_list(PCRE_SPTR32 *stringptr); Description This is a convenience function for freeing the store obtained by a previous call to pcre[16|32]_get_substring_list(). Its only argument is a pointer to the list of string pointers. There is a complete description of the PCRE…
PCRE – Perl-compatible regular expressions Synopsis #include <pcre.h> void pcre_free_substring(const char *stringptr); void pcre16_free_substring(PCRE_SPTR16 stringptr); void pcre32_free_substring(PCRE_SPTR32 stringptr); Description This is a convenience function for freeing the store obtained by a previous call to pcre[16|32]_get_substring() or pcre[16|32]_get_named_substring(). Its only argument is a pointer to the string. There is a complete description of the PCRE native…
PCRE – Perl-compatible regular expressions Synopsis #include <pcre.h> void pcre_free_study(pcre_extra *extra); void pcre16_free_study(pcre16_extra *extra); void pcre32_free_study(pcre32_extra *extra); Description This function is used to free the memory used for the data generated by a call to pcre[16|32]_study() when it is no longer needed. The argument must be the result of such a call. There is a…