diff --git a/Makefile.am b/Makefile.am index 5b62573..15781f9 100644 --- a/Makefile.am +++ b/Makefile.am @@ -25,6 +25,29 @@ dist_html_DATA = \ doc/html/index.html \ doc/html/pcre2-config.html \ doc/html/pcre2.html \ + doc/html/pcre2_code_free.html \ + doc/html/pcre2_compile.html \ + doc/html/pcre2_config.html \ + doc/html/pcre2_dfa_match.html \ + doc/html/pcre2_get_error_message.html \ + doc/html/pcre2_jit_compile.html \ + doc/html/pcre2_jit_match.html \ + doc/html/pcre2_jit_stack_alloc.html \ + doc/html/pcre2_jit_stack_assign.html \ + doc/html/pcre2_jit_stack_free.html \ + doc/html/pcre2_maketables.html \ + doc/html/pcre2_match.html \ + doc/html/pcre2_pattern_info.html \ + doc/html/pcre2_substring_copy_byname.html \ + doc/html/pcre2_substring_copy_bynumber.html \ + doc/html/pcre2_substring_free.html \ + doc/html/pcre2_substring_get_byname.html \ + doc/html/pcre2_substring_length_byname.html \ + doc/html/pcre2_substring_length_bynumber.html \ + doc/html/pcre2_substring_list_free.html \ + doc/html/pcre2_substring_list_get.html \ + doc/html/pcre2_substring_nametable_scan.html \ + doc/html/pcre2_substring_number_from_name.html \ doc/html/pcre2api.html \ doc/html/pcre2build.html \ doc/html/pcre2callout.html \ @@ -44,39 +67,34 @@ dist_html_DATA = \ doc/html/pcre2test.html \ doc/html/pcre2unicode.html -# doc/html/pcre2_assign_jit_stack.html \ -# doc/html/pcre2_compile.html \ -# doc/html/pcre2_compile2.html \ -# doc/html/pcre2_config.html \ -# doc/html/pcre2_copy_named_substring.html \ -# doc/html/pcre2_copy_substring.html \ -# doc/html/pcre2_dfa_match.html \ -# doc/html/pcre2_match.html \ -# doc/html/pcre2_free_study.html \ -# doc/html/pcre2_free_substring.html \ -# doc/html/pcre2_free_substring_list.html \ -# doc/html/pcre2_fullinfo.html \ -# doc/html/pcre2_get_named_substring.html \ -# doc/html/pcre2_get_stringnumber.html \ -# doc/html/pcre2_get_stringtable_entries.html \ -# doc/html/pcre2_get_substring.html \ -# doc/html/pcre2_get_substring_list.html \ -# doc/html/pcre2_jit_match.html \ -# doc/html/pcre2_jit_stack_alloc.html \ -# doc/html/pcre2_jit_stack_free.html \ -# doc/html/pcre2_maketables.html \ -# doc/html/pcre2_pattern_to_host_byte_order.html \ -# doc/html/pcre2_refcount.html \ -# doc/html/pcre2_study.html \ -# doc/html/pcre2_utf16_to_host_byte_order.html \ -# doc/html/pcre2_utf32_to_host_byte_order.html \ -# doc/html/pcre2_version.html \ -# doc/html/pcre2precompile.html # FIXME dist_man_MANS = \ doc/pcre2-config.1 \ doc/pcre2.3 \ + doc/pcre2_code_free.3 \ + doc/pcre2_compile.3 \ + doc/pcre2_config.3 \ + doc/pcre2_dfa_match.3 \ + doc/pcre2_get_error_message.3 \ + doc/pcre2_jit_compile.3 \ + doc/pcre2_jit_match.3 \ + doc/pcre2_jit_stack_alloc.3 \ + doc/pcre2_jit_stack_assign.3 \ + doc/pcre2_jit_stack_free.3 \ + doc/pcre2_maketables.3 \ + doc/pcre2_match.3 \ + doc/pcre2_pattern_info.3 \ + doc/pcre2_substring_copy_byname.3 \ + doc/pcre2_substring_copy_bynumber.3 \ + doc/pcre2_substring_free.3 \ + doc/pcre2_substring_get_byname.3 \ + doc/pcre2_substring_length_byname.3 \ + doc/pcre2_substring_length_bynumber.3 \ + doc/pcre2_substring_list_free.3 \ + doc/pcre2_substring_list_get.3 \ + doc/pcre2_substring_nametable_scan.3 \ + doc/pcre2_substring_number_from_name.3 \ doc/pcre2api.3 \ doc/pcre2build.3 \ doc/pcre2callout.3 \ @@ -96,37 +114,6 @@ dist_man_MANS = \ doc/pcre2test.1 \ doc/pcre2unicode.3 -# doc/pcre2-16.3 \ -# doc/pcre2-32.3 \ -# doc/pcre2_assign_jit_stack.3 \ -# doc/pcre2_compile.3 \ -# doc/pcre2_compile2.3 \ -# doc/pcre2_config.3 \ -# doc/pcre2_copy_named_substring.3 \ -# doc/pcre2_copy_substring.3 \ -# doc/pcre2_dfa_match.3 \ -# doc/pcre2_match.3 \ -# doc/pcre2_free_study.3 \ -# doc/pcre2_free_substring.3 \ -# doc/pcre2_free_substring_list.3 \ -# doc/pcre2_fullinfo.3 \ -# doc/pcre2_get_named_substring.3 \ -# doc/pcre2_get_stringnumber.3 \ -# doc/pcre2_get_stringtable_entries.3 \ -# doc/pcre2_get_substring.3 \ -# doc/pcre2_get_substring_list.3 \ -# doc/pcre2_jit_match.3 \ -# doc/pcre2_jit_stack_alloc.3 \ -# doc/pcre2_jit_stack_free.3 \ -# doc/pcre2_maketables.3 \ -# doc/pcre2_pattern_to_host_byte_order.3 \ -# doc/pcre2_refcount.3 \ -# doc/pcre2_study.3 \ -# doc/pcre2_utf16_to_host_byte_order.3 \ -# doc/pcre2_utf32_to_host_byte_order.3 \ -# doc/pcre2_version.3 \ -# doc/pcre2precompile.3 - # The Libtool libraries to install. We'll add to this later. lib_LTLIBRARIES = diff --git a/doc/html/index.html b/doc/html/index.html index 3351e23..afefd8c 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -17,16 +17,16 @@ first.

- + - + - + - + @@ -62,9 +62,6 @@ first. - - - @@ -83,17 +80,16 @@ first.

There are also individual pages that summarize the interface for each function -in the library. There is a single page for each triple of 8-bit/16-bit/32-bit -functions. +in the library.

pcre
pcre2   Introductory page
pcre-config
pcre-2config   Information about the installation configuration
pcreapi
pcre2api   PCRE2's native API
pcrebuild
pcre2build   Building PCRE2
pcre2callout
pcre2posix   The POSIX API to the PCRE2 8-bit library
pcre2precompile  How to save and re-use compiled patterns
pcre2sample   Discussion of the pcre2demo program
- - + + - + @@ -101,76 +97,70 @@ functions. - - - - - - - + - - - - + - - + + - - - - - - - - - - - - - - - - - - - - - - + + + + - - + + - - + + - - + + - - + + - - + + - - + + + + + + + + + + + + + + + + + + + + + + +
pcre2_assign_jit_stack  Assign stack for JIT matching
pcre2_code_free  Free a compiled pattern
pcre2_compile  Compile a regular expression
  Compile a regular expression pattern
pcre2_compile2   Compile a regular expression (alternate interface)
pcre2_config   Show build-time configuration options
pcre2_copy_named_substring  Extract named substring into given buffer
pcre2_copy_substring  Extract numbered substring into given buffer
pcre2_dfa_exec
pcre2_dfa_match   Match a compiled pattern to a subject string (DFA algorithm; not Perl compatible)
pcre2_exec  Match a compiled pattern to a subject string - (Perl compatible)
pcre2_free_study
pcre2_get_error_message   Free study data
pcre2_free_substring  Free extracted substring
pcre2_jit_compile  Process a compiled pattern with the JIT compiler
pcre2_free_substring_list  Free list of extracted substrings
pcre2_fullinfo  Extract information about a pattern
pcre2_get_named_substring  Extract named substring into new memory
pcre2_get_stringnumber  Convert captured string name to number
pcre2_get_stringtable_entries  Find table entries for given string name
pcre2_get_substring  Extract numbered substring into new memory
pcre2_get_substring_list  Extract all substrings into new memory
pcre2_jit_exec
pcre2_jit_match   Fast path interface to JIT matching
pcre2_jit_stack_alloc   Create a stack for JIT matching
pcre2_jit_stack_assign  Assign stack for JIT matching
pcre2_jit_stack_free   Free a JIT matching stack
pcre2_maketables   Build character tables in current locale
pcre2_pattern_to_host_byte_order  Convert compiled pattern to host byte order if necessary
pcre2_match  Match a compiled pattern to a subject string + (Perl compatible)
pcre2_refcount  Maintain reference count in compiled pattern
pcre2_pattern_info  Extract information about a pattern
pcre2_study  Study a compiled pattern
pcre2_substring_copy_byname  Extract named substring into given buffer
pcre2_utf16_to_host_byte_order  Convert UTF-16 string to host byte order if necessary
pcre2_substring_copy_bynumber  Extract numbered substring into given buffer
pcre2_utf32_to_host_byte_order  Convert UTF-32 string to host byte order if necessary
pcre2_substring_free  Free extracted substring
pcre2_version  Return PCRE2 version and release date
pcre2_substring_get_byname  Extract named substring into new memory
pcre2_substring_get_bynumber  Extract numbered substring into new memory
pcre2_substring_length_byname  Find length of named substring
pcre2_substring_length_bynumber  Find length of numbered substring
pcre2_substring_list_free  Free list of extracted substrings
pcre2_substring_list_get  Extract all substrings into new memory
pcre2_substring_nametable_scan  Find table entries for given string name
pcre2_substring_number_from_name  Convert captured string name to number
diff --git a/doc/html/pcre2_code_free.html b/doc/html/pcre2_code_free.html new file mode 100644 index 0000000..405d164 --- /dev/null +++ b/doc/html/pcre2_code_free.html @@ -0,0 +1,39 @@ + + +pcre2_code_free specification + + +

pcre2_code_free man page

+

+Return to the PCRE2 index page. +

+

+This page is part of the PCRE2 HTML documentation. It was generated +automatically from the original man page. If there is any nonsense in it, +please consult the man page, in case the conversion went wrong. +
+
+SYNOPSIS +
+

+#include <pcre2.h> +

+

+pcre2_code_free(pcre2_code *code); +

+
+DESCRIPTION +
+

+This function frees the memory used for a compiled pattern, including any +memory used by the JIT compiler. +

+

+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. +

+Return to the PCRE2 index page. +

diff --git a/doc/html/pcre2_compile.html b/doc/html/pcre2_compile.html new file mode 100644 index 0000000..8657470 --- /dev/null +++ b/doc/html/pcre2_compile.html @@ -0,0 +1,88 @@ + + +pcre2_compile specification + + +

pcre2_compile man page

+

+Return to the PCRE2 index page. +

+

+This page is part of the PCRE2 HTML documentation. It was generated +automatically from the original man page. If there is any nonsense in it, +please consult the man page, in case the conversion went wrong. +
+
+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 to put an error code
+  erroffset     Where to put an error offset
+  ccontext      Pointer to a compile context or NULL
+
+The length of the string and any error offset that is returned are in code +units, not characters. A compile context is needed only if you want to change +
+  What \R matches (Unicode newlines or CR, LF, CRLF only)
+  PCRE2's character tables
+  The newline character sequence
+  The compile time nested parentheses limit
+
+or provide an external function for stack size checking. The option bits are: +
+  PCRE2_ANCHORED           Force pattern anchoring
+  PCRE2_ALT_BSUX           Alternative handling of \u, \U, and \x
+  PCRE2_AUTO_CALLOUT       Compile automatic callouts
+  PCRE2_CASELESS           Do caseless matching
+  PCRE2_DOLLAR_ENDONLY     $ not to match newline at end
+  PCRE2_DOTALL             . matches anything including NL
+  PCRE2_DUPNAMES           Allow duplicate names for subpatterns
+  PCRE2_EXTENDED           Ignore white space and # comments
+  PCRE2_FIRSTLINE          Force matching to be before newline
+  PCRE2_MATCH_UNSET_BACKREF  Match unset back references
+  PCRE2_MULTILINE          ^ and $ match newlines within data
+  PCRE2_NEVER_UCP          Lock out PCRE2_UCP, e.g. via (*UCP)
+  PCRE2_NEVER_UTF          Lock out PCRE2_UTF, e.g. via (*UTF)
+  PCRE2_NO_AUTO_CAPTURE    Disable numbered capturing paren-
+                            theses (named ones available)
+  PCRE2_NO_AUTO_POSSESS    Disable auto-possessification
+  PCRE2_NO_START_OPTIMIZE  Disable match-time start optimizations
+  PCRE2_NO_UTF_CHECK       Do not check the pattern for UTF validity
+                             (only relevant if PCRE2_UTF is set)
+  PCRE2_UCP                Use Unicode properties for \d, \w, etc.
+  PCRE2_UNGREEDY           Invert greediness of quantifiers
+  PCRE2_UTF                Treat pattern and subjects as UTF strings
+
+PCRE2 must be built with Unicode support in order to use PCRE2_UTF, PCRE2_UCP +and related options. +

+

+The yield of the function is a pointer to a private data structure that +contains the compiled pattern, or NULL if an error was detected. +

+

+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. +

+Return to the PCRE2 index page. +

diff --git a/doc/html/pcre2_config.html b/doc/html/pcre2_config.html new file mode 100644 index 0000000..cf5320d --- /dev/null +++ b/doc/html/pcre2_config.html @@ -0,0 +1,85 @@ + + +pcre2_config specification + + +

pcre2_config man page

+

+Return to the PCRE2 index page. +

+

+This page is part of the PCRE2 HTML documentation. It was generated +automatically from the original man page. If there is any nonsense in it, +please consult the man page, in case the conversion went wrong. +
+
+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
+  where    Points to where to put the information
+
+If where is NULL, the function returns the amount of memory needed for +the requested information. When the information is a string, the value is in +code units; for other types of data it is in bytes. +

+

+If where is not NULL, for PCRE2_CONFIG_JITTARGET, +PCRE2_CONFIG_UNICODE_VERSION, and PCRE2_CONFIG_VERSION it must point to a +buffer that is large enough to hold the string. For PCRE2_CONFIG_MATCHLIMIT, +PCRE2_CONFIG_PARENSLIMIT, and PCRE2_CONFIG_RECURSIONLIMIT it must point to an +unsigned long int variable, and for all other codes to an int variable. The +available codes are: +

+  PCRE2_CONFIG_BSR             Indicates what \R matches by default:
+                                 0    all Unicode line endings
+                                 1    CR, LF, or CRLF only
+  PCRE2_CONFIG_JIT             Availability of just-in-time compiler
+                                support (1=yes 0=no)
+  PCRE2_CONFIG_JITTARGET       Information about the target archi-
+                                 tecture for the JIT compiler
+  PCRE2_CONFIG_LINKSIZE        Configured internal link size (2, 3, 4)
+  PCRE2_CONFIG_MATCHLIMIT      Default internal resource limit
+  PCRE2_CONFIG_NEWLINE         Code for the default newline sequence:
+                                 1    for CR
+                                 2    for LF
+                                 3    for CRLF
+                                 4    for ANY
+                                 5    for ANYCRLF
+  PCRE2_CONFIG_PARENSLIMIT     Default parentheses nesting limit
+  PCRE2_CONFIG_RECURSIONLIMIT  Internal recursion depth limit
+  PCRE2_CONFIG_STACKRECURSE    Recursion implementation (1=stack
+                                 0=heap)
+  PCRE2_CONFIG_UNICODE         Availability of Unicode support (1=yes
+                                 0=no)
+  PCRE2_CONFIG_UNICODE_VERSION The Unicode version (a string)
+  PCRE2_CONFIG_VERSION         The PCRE2 version (a string)
+
+The function yields a non-negative value on success or the negative value +PCRE2_ERROR_BADOPTION otherwise. This is also the result for the +PCRE2_CONFIG_JITTARGET code if JIT support is not available. When a string +is returned the yield is the length of the string, in code units, excluding the +terminating zero. +

+

+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. +

+Return to the PCRE2 index page. +

diff --git a/doc/html/pcre2_dfa_match.html b/doc/html/pcre2_dfa_match.html new file mode 100644 index 0000000..e137a14 --- /dev/null +++ b/doc/html/pcre2_dfa_match.html @@ -0,0 +1,79 @@ + + +pcre2_dfa_match specification + + +

pcre2_dfa_match man page

+

+Return to the PCRE2 index page. +

+

+This page is part of the PCRE2 HTML documentation. It was generated +automatically from the original man page. If there is any nonsense in it, +please consult the man page, in case the conversion went wrong. +
+
+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 (not Perl-compatible). (The Perl-compatible matching function +is pcre2_match().) The arguments for this function are: +

+  code         Points to the compiled pattern
+  subject      Points to the subject string
+  length       Length of the subject string
+  startoffset  Offset in the subject at which to start matching
+  options      Option bits
+  match_data   Points to a match data block, for results
+  mcontext     Points to a match context, or is NULL
+  workspace    Points to a vector of ints used as working space
+  wscount      Number of elements in the vector
+
+For pcre2_dfa_match(), a match context is needed only if you want to set +up a callout function. The length and startoffset values are code +units, not characters. The options are: +
+  PCRE2_ANCHORED          Match only at the first position
+  PCRE2_NOTBOL            Subject is not the beginning of a line
+  PCRE2_NOTEOL            Subject is not the end of a line
+  PCRE2_NOTEMPTY          An empty string is not a valid match
+  PCRE2_NOTEMPTY_ATSTART  An empty string at the start of the subject
+                           is not a valid match
+  PCRE2_NO_UTF_CHECK      Do not check the subject for UTF
+                           validity (only relevant if PCRE2_UTF
+                           was set at compile time)
+  PCRE2_PARTIAL_SOFT      Return PCRE2_ERROR_PARTIAL for a partial
+                            match if no full matches are found
+  PCRE2_PARTIAL_HARD      Return PCRE2_ERROR_PARTIAL for a partial match
+                           even if there is a full match as well
+  PCRE2_DFA_RESTART       Restart after a partial match
+  PCRE2_DFA_SHORTEST      Return only the shortest match
+
+There are restrictions on what may appear in a pattern when using this matching +function. Details are given in the +pcre2matching +documentation. For details of partial matching, see the +pcre2partial +page. 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. +

+Return to the PCRE2 index page. +

diff --git a/doc/html/pcre2_get_error_message.html b/doc/html/pcre2_get_error_message.html new file mode 100644 index 0000000..5d42291 --- /dev/null +++ b/doc/html/pcre2_get_error_message.html @@ -0,0 +1,48 @@ + + +pcre2_get_error_message specification + + +

pcre2_get_error_message man page

+

+Return to the PCRE2 index page. +

+

+This page is part of the PCRE2 HTML documentation. It was generated +automatically from the original man page. If there is any nonsense in it, +please consult the man page, in case the conversion went wrong. +
+
+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 the message
+  bufflen     the length of the buffer (code units)
+
+The function returns the length of the message, excluding the trailing zero, or +a negative error code if the buffer is too small. +

+

+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. +

+Return to the PCRE2 index page. +

diff --git a/doc/html/pcre2_jit_compile.html b/doc/html/pcre2_jit_compile.html new file mode 100644 index 0000000..15b0138 --- /dev/null +++ b/doc/html/pcre2_jit_compile.html @@ -0,0 +1,56 @@ + + +pcre2_jit_compile specification + + +

pcre2_jit_compile man page

+

+Return to the PCRE2 index page. +

+

+This page is part of the PCRE2 HTML documentation. It was generated +automatically from the original man page. If there is any nonsense in it, +please consult the man page, in case the conversion went wrong. +
+
+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 first argument is a pointer that was returned by a successful call to +pcre2_compile(), and the second must contain one or more of the following +bits: +

+  PCRE2_JIT_COMPLETE      compile code for full matching
+  PCRE2_JIT_PARTIAL_SOFT  compile code for soft partial matching
+  PCRE2_JIT_PARTIAL_HARD  compile code for hard partial matching
+
+The yield of the function is 0 for success, or a negative error code otherwise. +In particular, PCRE2_ERROR_JIT_BADOPTION is returned if JIT is not supported or +if an unknown bit is set in options. +

+

+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. +

+Return to the PCRE2 index page. +

diff --git a/doc/html/pcre2_jit_match.html b/doc/html/pcre2_jit_match.html new file mode 100644 index 0000000..d8658f1 --- /dev/null +++ b/doc/html/pcre2_jit_match.html @@ -0,0 +1,62 @@ + + +pcre2_jit_match specification + + +

pcre2_jit_match man page

+

+Return to the PCRE2 index page. +

+

+This page is part of the PCRE2 HTML documentation. It was generated +automatically from the original man page. If there is any nonsense in it, +please consult the man page, in case the conversion went wrong. +
+
+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, pcre2_jit_stack *jit_stack); +

+
+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 to Perl's. It is a "fast path" interface to JIT, and +it bypasses some of the sanity checks that pcre2_match() applies. +Its arguments are exactly the same as for +pcre2_match() +plus one additional argument that must either point to a JIT stack or be NULL. +In the latter case, if a callback function has been set up by +pcre2_jit_stack_alloc(), it is called. Otherwise the system stack is +used. +

+

+The supported options are PCRE2_NOTBOL, PCRE2_NOTEOL, PCRE2_NOTEMPTY, +PCRE2_NOTEMPTY_ATSTART, PCRE2_PARTIAL_HARD, and PCRE2_PARTIAL_SOFT. Unsupported +options are ignored. The subject string is not checked for UTF validity. +

+

+The return values are the same as for pcre2_match() plus +PCRE2_ERROR_JIT_BADOPTION if a matching mode (partial or complete) is requested +that was not compiled. For details of partial matching, see the +pcre2partial +page. +

+

+There is a complete description of the PCRE2 native API in the +pcre2api +page and a description of the JIT API in the +pcre2jit +page. +

+Return to the PCRE2 index page. +

diff --git a/doc/html/pcre2_jit_stack_alloc.html b/doc/html/pcre2_jit_stack_alloc.html new file mode 100644 index 0000000..d630d49 --- /dev/null +++ b/doc/html/pcre2_jit_stack_alloc.html @@ -0,0 +1,50 @@ + + +pcre2_jit_stack_alloc specification + + +

pcre2_jit_stack_alloc man page

+

+Return to the PCRE2 index page. +

+

+This page is part of the PCRE2 HTML documentation. It was generated +automatically from the original man page. If there is any nonsense in it, +please consult the man page, in case the conversion went wrong. +
+
+SYNOPSIS +
+

+#include <pcre2.h> +

+

+pcre2_jit_stack *pcre2_jit_stack_alloc(pcre2_general_context *gcontext, + PCRE2_SIZE startsize, PCRE2_SIZE maxsize); +

+
+DESCRIPTION +
+

+This function is used to create a stack for use by the code compiled by the JIT +compiler. The first argument is a general context, for memory allocation +functions, or NULL for standard memory allocation. The remaining arguments are +a starting size for the stack, and a maximum size to which it is allowed to +grow. The result can be passed to the JIT run-time code by calling +pcre2_jit_stack_assign() to associate the stack with a compiled pattern, +which can then be processed by pcre2_match(). If the "fast path" JIT +matcher, pcre2_jit_match() is used, the stack can be passed directly as +an argument. A maximum stack size of 512K to 1M should be more than enough for +any pattern. For more details, see the +pcre2jit +page. +

+

+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. +

+Return to the PCRE2 index page. +

diff --git a/doc/html/pcre2_jit_stack_assign.html b/doc/html/pcre2_jit_stack_assign.html new file mode 100644 index 0000000..cbe9340 --- /dev/null +++ b/doc/html/pcre2_jit_stack_assign.html @@ -0,0 +1,68 @@ + + +pcre2_jit_stack_assign specification + + +

pcre2_jit_stack_assign man page

+

+Return to the PCRE2 index page. +

+

+This page is part of the PCRE2 HTML documentation. It was generated +automatically from the original man page. If there is any nonsense in it, +please consult the man page, in case the conversion went wrong. +
+
+SYNOPSIS +
+

+#include <pcre2.h> +

+

+void pcre2_jit_stack_assign(const pcre2_code *code, + pcre2_jit_callback callback_function, void *callback_data); +

+
+DESCRIPTION +
+

+This function provides control over the memory used as a stack at run-time by a +call to pcre2_match() or pcre2_jit_match() with a pattern that has +been successfully processed by the JIT compiler. The arguments are: +

+  code           the pointer returned by pcre2_compile()
+  callback       a callback function
+  callback_data  a JIT stack or a value to be passed to the callback
+
+

+

+If callback is NULL and callback_data is NULL, an internal 32K +block on the machine stack is used. +

+

+If callback is NULL and callback_data is not NULL, +callback_data must be a valid JIT stack, the result of calling +pcre2_jit_stack_alloc(). +

+

+If callback not NULL, it is called with callback_data as an +argument at the start of matching, in order to set up a JIT stack. If the +result is NULL, the internal 32K stack is used; otherwise the return value must +be a valid JIT stack, the result of calling pcre2_jit_stack_alloc(). +

+

+You may safely assign the same JIT stack to multiple patterns, as long as they +are all matched in the same thread. In a multithread application, each thread +must use its own JIT stack. For more details, see the +pcre2jit +page. +

+

+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. +

+Return to the PCRE2 index page. +

diff --git a/doc/html/pcre2_jit_stack_free.html b/doc/html/pcre2_jit_stack_free.html new file mode 100644 index 0000000..c6b488d --- /dev/null +++ b/doc/html/pcre2_jit_stack_free.html @@ -0,0 +1,42 @@ + + +pcre2_jit_stack_free specification + + +

pcre2_jit_stack_free man page

+

+Return to the PCRE2 index page. +

+

+This page is part of the PCRE2 HTML documentation. It was generated +automatically from the original man page. If there is any nonsense in it, +please consult the man page, in case the conversion went wrong. +
+
+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_alloc() when it is no longer needed. For more details, +see the +pcre2jit +page. +

+

+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. +

+Return to the PCRE2 index page. +

diff --git a/doc/html/pcre2_maketables.html b/doc/html/pcre2_maketables.html new file mode 100644 index 0000000..068e6d4 --- /dev/null +++ b/doc/html/pcre2_maketables.html @@ -0,0 +1,48 @@ + + +pcre2_maketables specification + + +

pcre2_maketables man page

+

+Return to the PCRE2 index page. +

+

+This page is part of the PCRE2 HTML documentation. It was generated +automatically from the original man page. If there is any nonsense in it, +please consult the man page, in case the conversion went wrong. +
+
+SYNOPSIS +
+

+#include <pcre2.h> +

+

+const unsigned char *pcre2_maketables(pcre22_general_context *gcontext); +

+
+DESCRIPTION +
+

+This function builds a set of character tables for character values 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 made +by pcre2_maketables() when PCRE2 was compiled). See the +pcre2_set_character_tables() +page. You might want to do this if you are using a non-standard locale. +

+

+If the argument is NULL, malloc() is used to get memory for the tables. +Otherwise it must point to a general context, which can supply pointers to a +custom memory manager. The function yields a pointer to the tables. +

+

+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. +

+Return to the PCRE2 index page. +

diff --git a/doc/html/pcre2_match.html b/doc/html/pcre2_match.html new file mode 100644 index 0000000..0e389eb --- /dev/null +++ b/doc/html/pcre2_match.html @@ -0,0 +1,76 @@ + + +pcre2_match specification + + +

pcre2_match man page

+

+Return to the PCRE2 index page. +

+

+This page is part of the PCRE2 HTML documentation. It was generated +automatically from the original man page. If there is any nonsense in it, +please consult the man page, in case the conversion went wrong. +
+
+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 captured substrings. Its arguments are: +

+  code         Points to the compiled pattern
+  subject      Points to the subject string
+  length       Length of the subject string
+  startoffset  Offset in the subject at which to start matching
+  options      Option bits
+  match_data   Points to a match data block, for results
+  mcontext     Points to a match context, or is NULL
+
+A match context is needed only if you want to: +
+  Set up a callout function
+  Change the limit for calling the internal function match()
+  Change the limit for calling match() recursively
+  Set custom memory management when the heap is used for recursion
+
+The length and startoffset values are code +units, not characters. The options are: +
+  PCRE2_ANCHORED          Match only at the first position
+  PCRE2_NOTBOL            Subject string is not the beginning of a line
+  PCRE2_NOTEOL            Subject string is not the end of a line
+  PCRE2_NOTEMPTY          An empty string is not a valid match
+  PCRE2_NOTEMPTY_ATSTART  An empty string at the start of the subject
+                           is not a valid match
+  PCRE2_NO_UTF_CHECK      Do not check the subject for UTF
+                           validity (only relevant if PCRE2_UTF
+                           was set at compile time)
+  PCRE2_PARTIAL_SOFT      Return PCRE2_ERROR_PARTIAL for a partial
+                            match if no full matches are found
+  PCRE2_PARTIAL_HARD      Return PCRE2_ERROR_PARTIAL for a partial match
+                           if that is found before a full match
+
+For details of partial matching, see the +pcre2partial +page. 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. +

+Return to the PCRE2 index page. +

diff --git a/doc/html/pcre2_pattern_info.html b/doc/html/pcre2_pattern_info.html new file mode 100644 index 0000000..63b9870 --- /dev/null +++ b/doc/html/pcre2_pattern_info.html @@ -0,0 +1,103 @@ + + +pcre2_pattern_info specification + + +

pcre2_pattern_info man page

+

+Return to the PCRE2 index page. +

+

+This page is part of the PCRE2 HTML documentation. It was generated +automatically from the original man page. If there is any nonsense in it, +please consult the man page, in case the conversion went wrong. +
+
+SYNOPSIS +
+

+#include <pcre2.h> +

+

+int pcre2_pattern_info(const pcre2 *code, uint32_t what, void *where); +

+
+DESCRIPTION +
+

+This function returns information about a compiled pattern. Its arguments are: +

+  code                      Compiled regular expression
+  what                      What information is required
+  where                     Where to put the information
+
+If where is NULL, the function returns the amount of memory needed for +the requested information, in bytes. The following information is available: +
+  PCRE2_INFO_ALLOPTIONS      Final options after compiling
+  PCRE2_INFO_ARGOPTIONS      Options passed to pcre2_compile()
+  PCRE2_INFO_BACKREFMAX      Number of highest back reference
+  PCRE2_INFO_BSR             What \R matches
+                               0 all Unicode line endings
+                               1 CR, LF, or CRLF only
+  PCRE2_INFO_CAPTURECOUNT    Number of capturing subpatterns
+  PCRE2_INFO_FIRSTBITMAP     Bitmap of first code units, or NULL
+  PCRE2_INFO_FIRSTCODEUNIT   First code unit when type is 1
+  PCRE2_INFO_FIRSTCODETYPE   Type of start-of-match information
+                               0 nothing set
+                               1 first code unit is set
+                               2 start of string or after newline
+  PCRE2_INFO_HASCRORLF       Return 1 if explicit CR or LF matches
+                               exist in the pattern
+  PCRE2_INFO_JCHANGED        Return 1 if (?J) or (?-J) was used
+  PCRE2_INFO_JITSIZE         Size of JIT compiled code, or 0
+  PCRE2_INFO_LASTCODEUNIT    Last code unit when type is 1
+  PCRE2_INFO_LASTCODETYPE    Type of must-be-present information
+                               0 nothing set
+                               1 code unit is set
+  PCRE2_INFO_MATCHEMPTY      1 if the pattern can match an
+                               empty string, 0 otherwise
+  PCRE2_INFO_MATCHLIMIT      Match limit if set,
+                               otherwise PCRE2_RROR_UNSET
+  PCRE2_INFO_MAXLOOKBEHIND   Length (in characters) of the longest
+                               lookbehind assertion
+  PCRE2_INFO_MINLENGTH       Lower bound length of matching strings
+  PCRE2_INFO_NAMEENTRYSIZE   Size of name table entries
+  PCRE2_INFO_NAMECOUNT       Number of named subpatterns
+  PCRE2_INFO_NAMETABLE       Pointer to name table
+  PCRE2_CONFIG_NEWLINE       Code for the newline sequence:
+                               1    for CR
+                               2    for LF
+                               3    for CRLF
+                               4    for ANY
+                               5    for ANYCRLF
+  PCRE2_INFO_RECURSIONLIMIT  Recursion limit if set,
+                               otherwise PCRE2_ERROR_UNSET
+  PCRE2_INFO_SIZE            Size of compiled pattern
+
+The where argument must point to an unsigned 32-bit integer (uint32_t +variable), except for the following what values: +
+  PCRE2_INFO_FIRSTBITMAP     const uint8_t
+  PCRE2_INFO_JITSIZE         size_t
+  PCRE2_INFO_NAMETABLE       PCRE2_SPTR
+  PCRE2_INFO_SIZE            size_t
+
+The yield of the function is zero on success or: +
+  PCRE2_ERROR_NULL           the argument code is NULL
+  PCRE2_ERROR_BADMAGIC       the "magic number" was not found
+  PCRE2_ERROR_BADOPTION      the value of what is invalid
+  PCRE2_ERROR_BADMODE        the pattern was compiled in the wrong mode
+  PCRE2_ERROR_UNSET          the requested information is not set
+
+

+

+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. +

+Return to the PCRE2 index page. +

diff --git a/doc/html/pcre2_substring_copy_byname.html b/doc/html/pcre2_substring_copy_byname.html new file mode 100644 index 0000000..d83c446 --- /dev/null +++ b/doc/html/pcre2_substring_copy_byname.html @@ -0,0 +1,50 @@ + + +pcre2_substring_copy_byname specification + + +

pcre2_substring_copy_byname man page

+

+Return to the PCRE2 index page. +

+

+This page is part of the PCRE2 HTML documentation. It was generated +automatically from the original man page. If there is any nonsense in it, +please consult the man page, in case the conversion went wrong. +
+
+SYNOPSIS +
+

+#include <pcre2.h> +

+

+int pcre2_substring_copy_byname(pcre2_match_data *match_data, + PCRE2_SPTR name, PCRE2_UCHAR *buffer, PCRE2_SIZE *bufflen); +

+
+DESCRIPTION +
+

+This is a convenience function for extracting a captured substring, identified +by name, into a given buffer. The arguments are: +

+  match_data    The match data block for the match
+  name          Name of the required substring
+  buffer        Buffer to receive the string
+  bufflen       Length of buffer (code units)
+
+The bufflen variable is updated to contain the length of the extracted +string, excluding the trailing zero. The yield of the function is zero for +success, PCRE2_ERROR_NOMEMORY if the buffer is too small, or +PCRE2_ERROR_NOSUBSTRING if the string name is invalid. +

+

+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. +

+Return to the PCRE2 index page. +

diff --git a/doc/html/pcre2_substring_copy_bynumber.html b/doc/html/pcre2_substring_copy_bynumber.html new file mode 100644 index 0000000..d54015c --- /dev/null +++ b/doc/html/pcre2_substring_copy_bynumber.html @@ -0,0 +1,51 @@ + + +pcre2_substring_copy_bynumber specification + + +

pcre2_substring_copy_bynumber man page

+

+Return to the PCRE2 index page. +

+

+This page is part of the PCRE2 HTML documentation. It was generated +automatically from the original man page. If there is any nonsense in it, +please consult the man page, in case the conversion went wrong. +
+
+SYNOPSIS +
+

+#include <pcre2.h> +

+

+int pcre2_substring_copy_bynumber(pcre2_match_data *match_data, + unsigned int number, PCRE2_UCHAR *buffer, + PCRE2_SIZE *bufflen); +

+
+DESCRIPTION +
+

+This is a convenience function for extracting a captured substring into a given +buffer. The arguments are: +

+  match_data    The match data block for the match
+  number        Number of the required substring
+  buffer        Buffer to receive the string
+  bufflen       Length of buffer
+
+The bufflen variable is updated with the length of the extracted string, +excluding the terminating zero. The yield of the function is zero for success, +PCRE2_ERROR_NOMEMORY if the buffer was too small, or PCRE2_ERROR_NOSUBSTRING if +the string number is invalid. +

+

+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. +

+Return to the PCRE2 index page. +

diff --git a/doc/html/pcre2_substring_free.html b/doc/html/pcre2_substring_free.html new file mode 100644 index 0000000..35a5b55 --- /dev/null +++ b/doc/html/pcre2_substring_free.html @@ -0,0 +1,41 @@ + + +pcre2_substring_free specification + + +

pcre2_substring_free man page

+

+Return to the PCRE2 index page. +

+

+This page is part of the PCRE2 HTML documentation. It was generated +automatically from the original man page. If there is any nonsense in it, +please consult the man page, in case the conversion went wrong. +
+
+SYNOPSIS +
+

+#include <pcre2.h> +

+

+void pcre2_substring_free(PCRE2_UCHAR *buffer); +

+
+DESCRIPTION +
+

+This is a convenience function for freeing the memory obtained by a previous +call to pcre2_substring_get_byname() or +pcre2_substring_get_bynumber(). Its only argument is a pointer to the +string. +

+

+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. +

+Return to the PCRE2 index page. +

diff --git a/doc/html/pcre2_substring_get_byname.html b/doc/html/pcre2_substring_get_byname.html new file mode 100644 index 0000000..8d53eb9 --- /dev/null +++ b/doc/html/pcre2_substring_get_byname.html @@ -0,0 +1,52 @@ + + +pcre2_substring_get_byname specification + + +

pcre2_substring_get_byname man page

+

+Return to the PCRE2 index page. +

+

+This page is part of the PCRE2 HTML documentation. It was generated +automatically from the original man page. If there is any nonsense in it, +please consult the man page, in case the conversion went wrong. +
+
+SYNOPSIS +
+

+#include <pcre2.h> +

+

+int pcre2_substring_get_byname(pcre2_match_data *match_data, + PCRE2_SPTR name, PCRE2_UCHAR **bufferptr, PCRE2_SIZE *bufflen); +

+
+DESCRIPTION +
+

+This is a convenience function for extracting a captured substring by name into +newly acquired memory. The arguments are: +

+  match_data    The match data for the match
+  name          Name of the required substring
+  bufferptr     Where to put the string pointer
+  bufflen       Where to put the string length
+
+The memory in which the substring is placed is obtained by calling the same +memory allocation function that was used for the match data block. The +convenience function pcre2_substring_free() can be used to free it when +it is no longer needed. The yield of the function is zero for success, +PCRE2_ERROR_NOMEMORY if sufficient memory could not be obtained, or +PCRE2_ERROR_NOSUBSTRING if the string name is invalid. +

+

+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. +

+Return to the PCRE2 index page. +

diff --git a/doc/html/pcre2_substring_get_bynumber.html b/doc/html/pcre2_substring_get_bynumber.html new file mode 100644 index 0000000..7173279 --- /dev/null +++ b/doc/html/pcre2_substring_get_bynumber.html @@ -0,0 +1,52 @@ + + +pcre2_substring_get_bynumber specification + + +

pcre2_substring_get_bynumber man page

+

+Return to the PCRE2 index page. +

+

+This page is part of the PCRE2 HTML documentation. It was generated +automatically from the original man page. If there is any nonsense in it, +please consult the man page, in case the conversion went wrong. +
+
+SYNOPSIS +
+

+#include <pcre2.h> +

+

+int pcre2_substring_get_bynumber(pcre2_match_data *match_data, + unsigned int number, PCRE2_UCHAR **bufferptr, PCRE2_SIZE *bufflen); +

+
+DESCRIPTION +
+

+This is a convenience function for extracting a captured substring by number into +newly acquired memory. The arguments are: +

+  match_data    The match data for the match
+  number        Number of the required substring
+  bufferptr     Where to put the string pointer
+  bufflen       Where to put the string length
+
+The memory in which the substring is placed is obtained by calling the same +memory allocation function that was used for the match data block. The +convenience function pcre2_substring_free() can be used to free it when +it is no longer needed. The yield of the function is zero for success, +PCRE2_ERROR_NOMEMORY if sufficient memory could not be obtained, or +PCRE2_ERROR_NOSUBSTRING if the string number is invalid. +

+

+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. +

+Return to the PCRE2 index page. +

diff --git a/doc/html/pcre2_substring_length_byname.html b/doc/html/pcre2_substring_length_byname.html new file mode 100644 index 0000000..213bc94 --- /dev/null +++ b/doc/html/pcre2_substring_length_byname.html @@ -0,0 +1,46 @@ + + +pcre2_substring_length_byname specification + + +

pcre2_substring_length_byname man page

+

+Return to the PCRE2 index page. +

+

+This page is part of the PCRE2 HTML documentation. It was generated +automatically from the original man page. If there is any nonsense in it, +please consult the man page, in case the conversion went wrong. +
+
+SYNOPSIS +
+

+#include <pcre2.h> +

+

+int pcre2_substring_length_byname(pcre2_match_data *match_data, + PCRE2_SPTR name, PCRE2_SIZE *length); +

+
+DESCRIPTION +
+

+This function returns the length of a matched substring, identified by name. +The arguments are: +

+  match_data   The match data block for the match
+  name         The substring name
+  length       Where to return the length
+
+The yield is zero on success, or an error code if the substring is not found. +

+

+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. +

+Return to the PCRE2 index page. +

diff --git a/doc/html/pcre2_substring_length_bynumber.html b/doc/html/pcre2_substring_length_bynumber.html new file mode 100644 index 0000000..654e049 --- /dev/null +++ b/doc/html/pcre2_substring_length_bynumber.html @@ -0,0 +1,46 @@ + + +pcre2_substring_length_bynumber specification + + +

pcre2_substring_length_bynumber man page

+

+Return to the PCRE2 index page. +

+

+This page is part of the PCRE2 HTML documentation. It was generated +automatically from the original man page. If there is any nonsense in it, +please consult the man page, in case the conversion went wrong. +
+
+SYNOPSIS +
+

+#include <pcre2.h> +

+

+int pcre2_substring_length_bynumber(pcre2_match_data *match_data, + unsigned int number, PCRE2_SIZE *length); +

+
+DESCRIPTION +
+

+This function returns the length of a matched substring, identified by number. +The arguments are: +

+  match_data   The match data block for the match
+  number       The substring number
+  length       Where to return the length
+
+The yield is zero on success, or an error code if the substring is not found. +

+

+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. +

+Return to the PCRE2 index page. +

diff --git a/doc/html/pcre2_substring_list_free.html b/doc/html/pcre2_substring_list_free.html new file mode 100644 index 0000000..d61241d --- /dev/null +++ b/doc/html/pcre2_substring_list_free.html @@ -0,0 +1,40 @@ + + +pcre2_substring_list_free specification + + +

pcre2_substring_list_free man page

+

+Return to the PCRE2 index page. +

+

+This page is part of the PCRE2 HTML documentation. It was generated +automatically from the original man page. If there is any nonsense in it, +please consult the man page, in case the conversion went wrong. +
+
+SYNOPSIS +
+

+#include <pcre2.h> +

+

+void pcre2_substring_list_free(PCRE2_SPTR *list); +

+
+DESCRIPTION +
+

+This is a convenience function for freeing the store obtained by a previous +call to pcre2substring_list_get(). Its only argument is a pointer to +the list of string pointers. +

+

+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. +

+Return to the PCRE2 index page. +

diff --git a/doc/html/pcre2_substring_list_get.html b/doc/html/pcre2_substring_list_get.html new file mode 100644 index 0000000..fd43627 --- /dev/null +++ b/doc/html/pcre2_substring_list_get.html @@ -0,0 +1,56 @@ + + +pcre2_substring_list_get specification + + +

pcre2_substring_list_get man page

+

+Return to the PCRE2 index page. +

+

+This page is part of the PCRE2 HTML documentation. It was generated +automatically from the original man page. If there is any nonsense in it, +please consult the man page, in case the conversion went wrong. +
+
+SYNOPSIS +
+

+#include <pcre2.h> +

+

+int pcre2_substring_list_get(pcre2_match_data *match_data, +" PCRE2_UCHAR ***listptr, PCRE2_SIZE **lengthsptr); +

+
+DESCRIPTION +
+

+This is a convenience function for extracting all the captured substrings after +a pattern match. It builds a list of pointers to the strings, and (optionally) +a second list that contains their lengths (in code units), excluding a +terminating zero that is added to each of them. All this is done in a single +block of memory that is obtained using the same memory allocation function that +was used to get the match data block. The convenience function +pcre2_substring_list_free() can be used to free it when it is no longer +needed. The arguments are: +

+  match_data    The match data block
+  listptr       Where to put a pointer to the list
+  lengthsptr    Where to put a pointer to the lengths, or NULL
+
+A pointer to a list of pointers is put in the variable whose address is in +listptr. The list is terminated by a NULL pointer. If lengthsptr is +not NULL, a matching list of lengths is created, and its address is placed in +lengthsptr. The yield of the function is zero on success or +PCRE2_ERROR_NOMEMORY if sufficient memory could not be obtained. +

+

+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. +

+Return to the PCRE2 index page. +

diff --git a/doc/html/pcre2_substring_nametable_scan.html b/doc/html/pcre2_substring_nametable_scan.html new file mode 100644 index 0000000..5a44ea9 --- /dev/null +++ b/doc/html/pcre2_substring_nametable_scan.html @@ -0,0 +1,53 @@ + + +pcre2_substring_nametable_scan specification + + +

pcre2_substring_nametable_scan man page

+

+Return to the PCRE2 index page. +

+

+This page is part of the PCRE2 HTML documentation. It was generated +automatically from the original man page. If there is any nonsense in it, +please consult the man page, in case the conversion went wrong. +
+
+SYNOPSIS +
+

+#include <pcre2.h> +

+

+int pcre2_substring_nametable_scan(const pcre2_code *code, + PCRE2_SPTR name, PCRE2_SPTR *first, PCRE2_SPTR *last); +

+
+DESCRIPTION +
+

+This convenience function finds, for a compiled pattern, the first and last +entries for a given name in the table that translates capturing parenthesis +names into numbers. +

+  code    Compiled regular expression
+  name    Name whose entries required
+  first   Where to return a pointer to the first entry
+  last    Where to return a pointer to the last entry
+
+When the name is found in the table, if first is NULL, the function +returns a group number, but if there is more than one matching entry, it is not +defined which one. Otherwise, when both pointers have been set, the yield of +the function is the length of each entry in code units. If the name is not +found, PCRE2_ERROR_NOSUBSTRING is returned. +

+

+There is a complete description of the PCRE2 native API, including the format of +the table entries, in the +pcre2api +page, and a description of the POSIX API in the +pcre2posix +page. +

+Return to the PCRE2 index page. +

diff --git a/doc/html/pcre2_substring_number_from_name.html b/doc/html/pcre2_substring_number_from_name.html new file mode 100644 index 0000000..92ac91d --- /dev/null +++ b/doc/html/pcre2_substring_number_from_name.html @@ -0,0 +1,49 @@ + + +pcre2_substring_number_from_name specification + + +

pcre2_substring_number_from_name man page

+

+Return to the PCRE2 index page. +

+

+This page is part of the PCRE2 HTML documentation. It was generated +automatically from the original man page. If there is any nonsense in it, +please consult the man page, in case the conversion went wrong. +
+
+SYNOPSIS +
+

+#include <pcre2.h> +

+

+int pcre2_substring_number_from_name(const pcre2_code *code, + PCRE2_SPTR 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
+
+The yield of the function is the number of the parenthesis if the name is +found, or PCRE2_ERROR_NOSUBSTRING otherwise. When duplicate names are allowed +(PCRE2_DUPNAMES is set), it is not defined which of the numbers is returned. +You can obtain the complete list by calling +pcre2_substring_nametable_scan(). +

+

+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. +

+Return to the PCRE2 index page. +

diff --git a/doc/html/pcre2api.html b/doc/html/pcre2api.html index 47733e3..eacf4e1 100644 --- a/doc/html/pcre2api.html +++ b/doc/html/pcre2api.html @@ -374,7 +374,7 @@ performance. The JIT-specific functions are discussed in the documentation.

-A second matching function, pcre2_dfa_exec(), which is not +A second matching function, pcre2_dfa_match(), which is not Perl-compatible, is also provided. This uses a different algorithm for the matching. The alternative algorithm finds all possible matches (at a given point in the subject), and scans the subject just once (unless there are @@ -641,17 +641,13 @@ The match context A match context is required if you want to change the default values of any of the following match-time parameters: 

-  What \R matches (Unicode newlines or CR, LF, CRLF only);
-  A callout function;
-  The limit for calling match();
-  The limit for calling match() recursively;
-  The newline character sequence;
+  A callout function
+  The limit for calling match()
+  The limit for calling match() recursively
A match context is also required if you are using custom memory management. If none of these apply, just pass NULL as the context argument of pcre2_match(), pcre2_dfa_match(), or pcre2_jit_match(). -Changing the newline value or what \R matches at match time disables the use -of JIT via pcre2_match().

A match context is created, copied, and freed by the following functions: diff --git a/doc/html/pcre2jit.html b/doc/html/pcre2jit.html index 5232470..0699990 100644 --- a/doc/html/pcre2jit.html +++ b/doc/html/pcre2jit.html @@ -79,7 +79,9 @@ second is a set of option bits, which must include at least one of PCRE2_JIT_COMPLETE, PCRE2_JIT_PARTIAL_HARD, or PCRE2_JIT_PARTIAL_SOFT.

-The returned value from pcre2_jit_compile() is FIXME FIXME. +The returned value from pcre2_jit_compile() is zero on success, or a +negative error code. In particular, PCRE2_ERROR_JIT_BADOPTION is returned if +JIT is not supported or if an unknown options bit is set.

PCRE2_JIT_COMPLETE requests the JIT compiler to generate code for complete @@ -361,8 +363,12 @@ processed by pcre2_jit_compile()).

The fast path function is called pcre2_jit_match(), and it takes exactly the same arguments as pcre2_match(), plus one additional argument that -must point to a JIT stack. The JIT stack arrangements described above do not -apply. The return values are the same as for pcre2_match(). +must either point to a JIT stack or be NULL. In the latter case, if a callback +function has been set up by pcre2_jit_stack_alloc(), it is called. +Otherwise the system stack is used. The return values are the same as for +pcre2_match(), plus PCRE2_ERROR_JIT_BADOPTION if a matching mode (partial +or complete) is requested that was not compiled. Unsupported option bits are +ignored.

When you call pcre2_match(), as well as testing for invalid options, a @@ -391,7 +397,7 @@ Cambridge CB2 3QH, England.


REVISION

-Last updated: 29 September 2014 +Last updated: 21 October 2014
Copyright © 1997-2014 University of Cambridge.
diff --git a/doc/index.html.src b/doc/index.html.src index 4e264ec..5e7984f 100644 --- a/doc/index.html.src +++ b/doc/index.html.src @@ -17,16 +17,16 @@ first.

- + - + - + - + @@ -62,9 +62,6 @@ first. - - - @@ -83,17 +80,16 @@ first.

There are also individual pages that summarize the interface for each function -in the library. There is a single page for each triple of 8-bit/16-bit/32-bit -functions. +in the library.

pcre
pcre2   Introductory page
pcre-config
pcre-2config   Information about the installation configuration
pcreapi
pcre2api   PCRE2's native API
pcrebuild
pcre2build   Building PCRE2
pcre2callout
pcre2posix   The POSIX API to the PCRE2 8-bit library
pcre2precompile  How to save and re-use compiled patterns
pcre2sample   Discussion of the pcre2demo program
- - + + - + @@ -101,76 +97,70 @@ functions. - - - - - - - + - - - - + - - + + - - - - - - - - - - - - - - - - - - - - - - + + + + - - + + - - + + - - + + - - + + - - + + - - + + + + + + + + + + + + + + + + + + + + + + +
pcre2_assign_jit_stack  Assign stack for JIT matching
pcre2_code_free  Free a compiled pattern
pcre2_compile  Compile a regular expression
  Compile a regular expression pattern
pcre2_compile2   Compile a regular expression (alternate interface)
pcre2_config   Show build-time configuration options
pcre2_copy_named_substring  Extract named substring into given buffer
pcre2_copy_substring  Extract numbered substring into given buffer
pcre2_dfa_exec
pcre2_dfa_match   Match a compiled pattern to a subject string (DFA algorithm; not Perl compatible)
pcre2_exec  Match a compiled pattern to a subject string - (Perl compatible)
pcre2_free_study
pcre2_get_error_message   Free study data
pcre2_free_substring  Free extracted substring
pcre2_jit_compile  Process a compiled pattern with the JIT compiler
pcre2_free_substring_list  Free list of extracted substrings
pcre2_fullinfo  Extract information about a pattern
pcre2_get_named_substring  Extract named substring into new memory
pcre2_get_stringnumber  Convert captured string name to number
pcre2_get_stringtable_entries  Find table entries for given string name
pcre2_get_substring  Extract numbered substring into new memory
pcre2_get_substring_list  Extract all substrings into new memory
pcre2_jit_exec
pcre2_jit_match   Fast path interface to JIT matching
pcre2_jit_stack_alloc   Create a stack for JIT matching
pcre2_jit_stack_assign  Assign stack for JIT matching
pcre2_jit_stack_free   Free a JIT matching stack
pcre2_maketables   Build character tables in current locale
pcre2_pattern_to_host_byte_order  Convert compiled pattern to host byte order if necessary
pcre2_match  Match a compiled pattern to a subject string + (Perl compatible)
pcre2_refcount  Maintain reference count in compiled pattern
pcre2_pattern_info  Extract information about a pattern
pcre2_study  Study a compiled pattern
pcre2_substring_copy_byname  Extract named substring into given buffer
pcre2_utf16_to_host_byte_order  Convert UTF-16 string to host byte order if necessary
pcre2_substring_copy_bynumber  Extract numbered substring into given buffer
pcre2_utf32_to_host_byte_order  Convert UTF-32 string to host byte order if necessary
pcre2_substring_free  Free extracted substring
pcre2_version  Return PCRE2 version and release date
pcre2_substring_get_byname  Extract named substring into new memory
pcre2_substring_get_bynumber  Extract numbered substring into new memory
pcre2_substring_length_byname  Find length of named substring
pcre2_substring_length_bynumber  Find length of numbered substring
pcre2_substring_list_free  Free list of extracted substrings
pcre2_substring_list_get  Extract all substrings into new memory
pcre2_substring_nametable_scan  Find table entries for given string name
pcre2_substring_number_from_name  Convert captured string name to number
diff --git a/doc/pcre2.txt b/doc/pcre2.txt index 27ec713..adb33bc 100644 --- a/doc/pcre2.txt +++ b/doc/pcre2.txt @@ -446,16 +446,17 @@ PCRE2 API OVERVIEW performance. The JIT-specific functions are discussed in the pcre2jit documentation. - A second matching function, pcre2_dfa_exec(), which is not Perl-compat- - ible, is also provided. This uses a different algorithm for the match- - ing. The alternative algorithm finds all possible matches (at a given - point in the subject), and scans the subject just once (unless there - are lookbehind assertions). However, this algorithm does not return - captured substrings. A description of the two matching algorithms and - their advantages and disadvantages is given in the pcre2matching docu- - mentation. There is no JIT support for pcre2_dfa_match(). + A second matching function, pcre2_dfa_match(), which is not Perl-com- + patible, is also provided. This uses a different algorithm for the + matching. The alternative algorithm finds all possible matches (at a + given point in the subject), and scans the subject just once (unless + there are lookbehind assertions). However, this algorithm does not + return captured substrings. A description of the two matching algo- + rithms and their advantages and disadvantages is given in the + pcre2matching documentation. There is no JIT support for + pcre2_dfa_match(). - In addition to the main compiling and matching functions, there are + In addition to the main compiling and matching functions, there are convenience functions for extracting captured substrings from a subject string that is matched by pcre2_match(). They are: @@ -469,55 +470,55 @@ PCRE2 API OVERVIEW pcre2_substring_nametable_scan() pcre2_substring_number_from_name() - pcre2_substring_free() and pcre2_substring_list_free() are also pro- + pcre2_substring_free() and pcre2_substring_list_free() are also pro- vided, to free the memory used for extracted strings. - There are functions for finding out information about a compiled pat- - tern (pcre2_pattern_info()) and about the configuration with which + There are functions for finding out information about a compiled pat- + tern (pcre2_pattern_info()) and about the configuration with which PCRE2 was built (pcre2_config()). NEWLINES PCRE2 supports five different conventions for indicating line breaks in - strings: a single CR (carriage return) character, a single LF (line- + strings: a single CR (carriage return) character, a single LF (line- feed) character, the two-character sequence CRLF, any of the three pre- - ceding, or any Unicode newline sequence. The Unicode newline sequences - are the three just mentioned, plus the single characters VT (vertical + ceding, or any Unicode newline sequence. 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). - Each of the first three conventions is used by at least one operating + Each of the first three conventions is used by at least one operating system as its standard newline sequence. When PCRE2 is built, a default - can be specified. The default default is LF, which is the Unix stan- - dard. When PCRE2 is run, the default can be overridden, either when a + can be specified. The default default is LF, which is the Unix stan- + dard. When PCRE2 is run, the default can be overridden, either when a pattern is compiled, or when it is matched. - The newline convention can be changed when calling pcre2_compile(), or + The newline convention can be changed when calling pcre2_compile(), or it can be specified by special text at the start of the pattern itself; - this overrides any other settings. See the pcre2pattern page for + this overrides any other settings. See the pcre2pattern page for details of the special character sequences. - In the PCRE2 documentation the word "newline" is used to mean "the + In the PCRE2 documentation the word "newline" is used to mean "the character or pair of characters that indicate a line break". The choice - of newline convention affects the handling of the dot, circumflex, and + of newline convention affects the handling of the dot, circumflex, and dollar metacharacters, the handling of #-comments in /x mode, and, when - CRLF is a recognized line ending sequence, the match position advance- + CRLF is a recognized line ending sequence, the match position advance- ment for a non-anchored pattern. There is more detail about this in the section on pcre2_match() options below. - The choice of newline convention does not affect the interpretation of - the \n or \r escape sequences, nor does it affect what \R matches, + The choice of newline convention does not affect the interpretation of + the \n or \r escape sequences, nor does it affect what \R matches, which has its own separate control. MULTITHREADING - In a multithreaded application it is important to keep thread-specific - data separate from data that can be shared between threads. The PCRE2 - library code itself is thread-safe: it contains no static or global - variables. The API is designed to be fairly simple for non-threaded - applications while at the same time ensuring that multithreaded appli- + In a multithreaded application it is important to keep thread-specific + data separate from data that can be shared between threads. The PCRE2 + library code itself is thread-safe: it contains no static or global + variables. The API is designed to be fairly simple for non-threaded + applications while at the same time ensuring that multithreaded appli- cations can use it. There are several different blocks of data that are used to pass infor- @@ -525,65 +526,65 @@ MULTITHREADING (1) A pointer to the compiled form of a pattern is returned to the user when pcre2_compile() is successful. The data in the compiled pattern is - fixed, and does not change when the pattern is matched. Therefore, it - is thread-safe, that is, the same compiled pattern can be used by more + fixed, and does not change when the pattern is matched. Therefore, it + is thread-safe, that is, the same compiled pattern can be used by more than one thread simultaneously. An application can compile all its pat- - terns at the start, before forking off multiple threads that use them. - However, if the just-in-time optimization feature is being used, it - needs separate memory stack areas for each thread. See the pcre2jit + terns at the start, before forking off multiple threads that use them. + However, if the just-in-time optimization feature is being used, it + needs separate memory stack areas for each thread. See the pcre2jit documentation for more details. - (2) The next section below introduces the idea of "contexts" in which + (2) The next section below introduces the idea of "contexts" in which PCRE2 functions are called. A context is nothing more than a collection of parameters that control the way PCRE2 operates. Grouping a number of parameters together in a context is a convenient way of passing them to - a PCRE2 function without using lots of arguments. The parameters that - are stored in contexts are in some sense "advanced features" of the + a PCRE2 function without using lots of arguments. The parameters that + are stored in contexts are in some sense "advanced features" of the API. Many straightforward applications will not need to use contexts. In a multithreaded application, if the parameters in a context are val- - ues that are never changed, the same context can be used by all the + ues that are never changed, the same context can be used by all the threads. However, if any thread needs to change any value in a context, it must make its own thread-specific copy. (3) The matching functions need a block of memory for working space and - for storing the results of a match. This includes details of what was - matched, as well as additional information such as the name of a - (*MARK) setting. Each thread must provide its own version of this mem- + for storing the results of a match. This includes details of what was + matched, as well as additional information such as the name of a + (*MARK) setting. Each thread must provide its own version of this mem- ory. PCRE2 CONTEXTS - Some PCRE2 functions have a lot of parameters, many of which are used - only by specialist applications, for example, those that use custom - memory management or non-standard character tables. To keep function - argument lists at a reasonable size, and at the same time to keep the - API extensible, "uncommon" parameters are passed to certain functions - in a context instead of directly. A context is just a block of memory - that holds the parameter values. Applications that do not need to - adjust any of the context parameters can pass NULL when a context + Some PCRE2 functions have a lot of parameters, many of which are used + only by specialist applications, for example, those that use custom + memory management or non-standard character tables. To keep function + argument lists at a reasonable size, and at the same time to keep the + API extensible, "uncommon" parameters are passed to certain functions + in a context instead of directly. A context is just a block of memory + that holds the parameter values. Applications that do not need to + adjust any of the context parameters can pass NULL when a context pointer is required. - There are three different types of context: a general context that is - relevant for several PCRE2 operations, a compile-time context, and a + There are three different types of context: a general context that is + relevant for several PCRE2 operations, a compile-time context, and a match-time context. The general context - At present, this context just contains pointers to (and data for) - external memory management functions that are called from several + At present, this context just contains pointers to (and data for) + external memory management functions that are called from several places in the PCRE2 library. The context is named `general' rather than - specifically `memory' because in future other fields may be added. If - you do not want to supply your own custom memory management functions, - you do not need to bother with a general context. A general context is + specifically `memory' because in future other fields may be added. If + you do not want to supply your own custom memory management functions, + you do not need to bother with a general context. A general context is created by: pcre2_general_context *pcre2_general_context_create( void *(*private_malloc)(PCRE2_SIZE, void *), void (*private_free)(void *, void *), void *memory_data); - The two function pointers specify custom memory management functions, + The two function pointers specify custom memory management functions, whose prototypes are: void *private_malloc(PCRE2_SIZE, void *); @@ -591,16 +592,16 @@ PCRE2 CONTEXTS Whenever code in PCRE2 calls these functions, the final argument is the value of memory_data. Either of the first two arguments of the creation - function may be NULL, in which case the system memory management func- - tions malloc() and free() are used. (This is not currently useful, as - there are no other fields in a general context, but in future there - might be.) The private_malloc() function is used (if supplied) to - obtain memory for storing the context, and all three values are saved + function may be NULL, in which case the system memory management func- + tions malloc() and free() are used. (This is not currently useful, as + there are no other fields in a general context, but in future there + might be.) The private_malloc() function is used (if supplied) to + obtain memory for storing the context, and all three values are saved as part of the context. - Whenever PCRE2 creates a data block of any kind, the block contains a - pointer to the free() function that matches the malloc() function that - was used. When the time comes to free the block, this function is + Whenever PCRE2 creates a data block of any kind, the block contains a + pointer to the free() function that matches the malloc() function that + was used. When the time comes to free the block, this function is called. A general context can be copied by calling: @@ -615,7 +616,7 @@ PCRE2 CONTEXTS The compile context - A compile context is required if you want to change the default values + A compile context is required if you want to change the default values of any of the following compile-time parameters: What \R matches (Unicode newlines or CR, LF, CRLF only); @@ -624,11 +625,11 @@ PCRE2 CONTEXTS The compile time nested parentheses limit; An external function for stack checking. - A compile context is also required if you are using custom memory man- - agement. If none of these apply, just pass NULL as the context argu- + A compile context is also required if you are using custom memory man- + agement. If none of these apply, just pass NULL as the context argu- ment of pcre2_compile(). - A compile context is created, copied, and freed by the following func- + A compile context is created, copied, and freed by the following func- tions: pcre2_compile_context *pcre2_compile_context_create( @@ -639,24 +640,24 @@ PCRE2 CONTEXTS void pcre2_compile_context_free(pcre2_compile_context *ccontext); - A compile context is created with default values for its parameters. + A compile context is created with default values for its parameters. These can be changed by calling the following functions, which return 0 on success, or PCRE2_ERROR_BADDATA if invalid data is detected. int pcre2_set_bsr(pcre2_compile_context *ccontext, uint32_t value); - The value must be PCRE2_BSR_ANYCRLF, to specify that \R matches only - CR, LF, or CRLF, or PCRE2_BSR_UNICODE, to specify that \R matches any - Unicode line ending sequence. The value of this parameter does not - affect what is compiled; it is just saved with the compiled pattern. + The value must be PCRE2_BSR_ANYCRLF, to specify that \R matches only + CR, LF, or CRLF, or PCRE2_BSR_UNICODE, to specify that \R matches any + Unicode line ending sequence. The value of this parameter does not + affect what is compiled; it is just saved with the compiled pattern. The value is used by the JIT compiler and by the two interpreted match- ing functions, pcre2_match() and pcre2_dfa_match(). int pcre2_set_character_tables(pcre2_compile_context *ccontext, const unsigned char *tables); - The value must be the result of a call to pcre2_maketables(), whose + The value must be the result of a call to pcre2_maketables(), whose only argument is a general context. This function builds a set of char- acter tables in the current locale. @@ -664,34 +665,34 @@ PCRE2 CONTEXTS uint32_t value); This specifies which characters or character sequences are to be recog- - nized as newlines. The value must be one of PCRE2_NEWLINE_CR (carriage + nized as newlines. The value must be one of PCRE2_NEWLINE_CR (carriage return only), PCRE2_NEWLINE_LF (linefeed only), PCRE2_NEWLINE_CRLF (the - two-character sequence CR followed by LF), PCRE2_NEWLINE_ANYCRLF (any + two-character sequence CR followed by LF), PCRE2_NEWLINE_ANYCRLF (any of the above), or PCRE2_NEWLINE_ANY (any Unicode newline sequence). When a pattern is compiled with the PCRE2_EXTENDED option, the value of - this parameter affects the recognition of white space and the end of + this parameter affects the recognition of white space and the end of internal comments starting with #. The value is saved with the compiled - pattern for subsequent use by the JIT compiler and by the two inter- + pattern for subsequent use by the JIT compiler and by the two inter- preted matching functions, pcre2_match() and pcre2_dfa_match(). int pcre2_set_parens_nest_limit(pcre2_compile_context *ccontext, uint32_t value); This parameter ajusts the limit, set when PCRE2 is built (default 250), - on the depth of parenthesis nesting in a pattern. This limit stops + on the depth of parenthesis nesting in a pattern. This limit stops rogue patterns using up too much system stack when being compiled. int pcre2_set_compile_recursion_guard(pcre2_compile_context *ccontext, int (*guard_function)(uint32_t)); - There is at least one application that runs PCRE2 in threads with very - limited system stack, where running out of stack is to be avoided at - all costs. The parenthesis limit above cannot take account of how much - stack is actually available. For a finer control, you can supply a - function that is called whenever pcre2_compile() starts to compile a + There is at least one application that runs PCRE2 in threads with very + limited system stack, where running out of stack is to be avoided at + all costs. The parenthesis limit above cannot take account of how much + stack is actually available. For a finer control, you can supply a + function that is called whenever pcre2_compile() starts to compile a parenthesized part of a pattern. The argument to the function gives the - current depth of nesting. The function should return zero if all is + current depth of nesting. The function should return zero if all is well, or non-zero to force an error. The match context @@ -699,19 +700,15 @@ PCRE2 CONTEXTS A match context is required if you want to change the default values of any of the following match-time parameters: - What \R matches (Unicode newlines or CR, LF, CRLF only); - A callout function; - The limit for calling match(); - The limit for calling match() recursively; - The newline character sequence; + A callout function + The limit for calling match() + The limit for calling match() recursively A match context is also required if you are using custom memory manage- - ment. If none of these apply, just pass NULL as the context argument - of pcre2_match(), pcre2_dfa_match(), or pcre2_jit_match(). Changing - the newline value or what \R matches at match time disables the use of - JIT via pcre2_match(). + ment. If none of these apply, just pass NULL as the context argument + of pcre2_match(), pcre2_dfa_match(), or pcre2_jit_match(). - A match context is created, copied, and freed by the following func- + A match context is created, copied, and freed by the following func- tions: pcre2_match_context *pcre2_match_context_create( @@ -722,7 +719,7 @@ PCRE2 CONTEXTS void pcre2_match_context_free(pcre2_match_context *mcontext); - A match context is created with default values for its parameters. + A match context is created with default values for its parameters. These can be changed by calling the following functions, which return 0 on success, or PCRE2_ERROR_BADDATA if invalid data is detected. @@ -730,71 +727,71 @@ PCRE2 CONTEXTS int (*callout_function)(pcre2_callout_block *), void *callout_data); - This sets up a "callout" function, which PCRE2 will call at specified + This sets up a "callout" function, which PCRE2 will call at specified points during a matching operation. Details are given in the pcre2call- out documentation. int pcre2_set_match_limit(pcre2_match_context *mcontext, uint32_t value); - The match_limit parameter provides a means of preventing PCRE2 from + The match_limit parameter provides a means of preventing PCRE2 from using up too many resources when processing patterns that are not going - to match, but which have a very large number of possibilities in their - search trees. The classic example is a pattern that uses nested unlim- + to match, but which have a very large number of possibilities in their + search trees. The classic example is a pattern that uses nested unlim- ited repeats. - Internally, pcre2_match() uses a function called match(), which it - calls repeatedly (sometimes recursively). The limit set by match_limit - is imposed on the number of times this function is called during a + Internally, pcre2_match() uses a function called match(), which it + calls repeatedly (sometimes recursively). The limit set by match_limit + is imposed on the number of times this function is called during a match, which has the effect of limiting the amount of backtracking that - can take place. For patterns that are not anchored, the count restarts - from zero for each position in the subject string. This limit is not + can take place. For patterns that are not anchored, the count restarts + from zero for each position in the subject string. This limit is not relevant to pcre2_dfa_match(), which ignores it. When pcre2_match() is called with a pattern that was successfully stud- - ied with pcre2_jit_compile(), 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 + ied with pcre2_jit_compile(), 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 PCRE2 is built; the - default default is 10 million, which handles all but the most extreme - cases. If the limit is exceeded, pcre2_match() returns - PCRE2_ERROR_MATCHLIMIT. A value for the match limit may also be sup- + The default value for the limit can be set when PCRE2 is built; the + default default is 10 million, which handles all but the most extreme + cases. If the limit is exceeded, pcre2_match() returns + PCRE2_ERROR_MATCHLIMIT. A value for the match limit may also be sup- plied by an item at the start of a pattern of the form (*LIMIT_MATCH=ddd) - where ddd is a decimal number. However, such a setting is ignored - unless ddd is less than the limit set by the caller of pcre2_match() + where ddd is a decimal number. However, such a setting is ignored + unless ddd is less than the limit set by the caller of pcre2_match() or, if no such limit is set, less than the default. int pcre2_set_recursion_limit(pcre2_match_context *mcontext, uint32_t value); The recursion_limit parameter 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 total number of calls, because not all calls to match() are recur- + 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 total number of calls, because not all calls to match() are recur- sive. This limit is of use only if it is set smaller than match_limit. Limiting the recursion depth limits the amount of system stack that can - be used, or, when PCRE2 has been compiled to use memory on the heap - instead of the stack, the amount of heap memory that can be used. This - limit is not relevant, and is ignored, when matching is done using JIT + be used, or, when PCRE2 has been compiled to use memory on the heap + instead of the stack, the amount of heap memory that can be used. This + limit is not relevant, and is ignored, when matching is done using JIT compiled code or by the pcre2_dfa_match() function. - The default value for recursion_limit can be set when PCRE2 is built; - the default default is the same value as the default for match_limit. - If the limit is exceeded, pcre2_match() returns PCRE2_ERROR_RECURSION- - LIMIT. A value for the recursion limit may also be supplied by an item + The default value for recursion_limit can be set when PCRE2 is built; + the default default is the same value as the default for match_limit. + If the limit is exceeded, pcre2_match() returns PCRE2_ERROR_RECURSION- + LIMIT. A value for the recursion limit may also be supplied by an item at the start of a pattern of the form (*LIMIT_RECURSION=ddd) - where ddd is a decimal number. However, such a setting is ignored - unless ddd is less than the limit set by the caller of pcre2_match() + where ddd is a decimal number. However, such a setting is ignored + unless ddd is less than the limit set by the caller of pcre2_match() or, if no such limit is set, less than the default. int pcre2_set_recursion_memory_management( @@ -803,20 +800,20 @@ PCRE2 CONTEXTS void (*private_free)(void *, void *), void *memory_data); This function sets up two additional custom memory management functions - for use by pcre2_match() when PCRE2 is compiled to use the heap for + for use by pcre2_match() when PCRE2 is compiled to use the heap for remembering backtracking data, instead of recursive function calls that - use the system stack. There is a discussion about PCRE2's stack usage - in the pcre2stack documentation. See the pcre2build documentation for - details of how to build PCRE2. Using the heap for recursion is a non- - standard way of building PCRE2, for use in environments that have lim- - ited stacks. Because of the greater use of memory management, - pcre2_match() runs more slowly. Functions that are different to the - general custom memory functions are provided so that special-purpose - external code can be used for this case, because the memory blocks are + use the system stack. There is a discussion about PCRE2's stack usage + in the pcre2stack documentation. See the pcre2build documentation for + details of how to build PCRE2. Using the heap for recursion is a non- + standard way of building PCRE2, for use in environments that have lim- + ited stacks. Because of the greater use of memory management, + pcre2_match() runs more slowly. Functions that are different to the + general custom memory functions are provided so that special-purpose + external code can be used for this case, because the memory blocks are all the same size. The blocks are retained by pcre2_match() until it is - about to exit so that they can be re-used when possible during the + about to exit so that they can be re-used when possible during the match. In the absence of these functions, the normal custom memory man- - agement functions are used, if supplied, otherwise the system func- + agement functions are used, if supplied, otherwise the system func- tions. @@ -824,30 +821,30 @@ CHECKING BUILD-TIME OPTIONS int pcre2_config(uint32_t what, void *where); - The function pcre2_config() makes it possible for a PCRE2 client to - discover which optional features have been compiled into the PCRE2 - library. The pcre2build documentation has more details about these + The function pcre2_config() makes it possible for a PCRE2 client to + discover which optional features have been compiled into the PCRE2 + library. The pcre2build documentation has more details about these optional features. - The first argument for pcre2_config() specifies which information is - required. The second argument is a pointer to memory into which the - information is placed. If NULL is passed, the function returns the - amount of memory that is needed for the requested information. For - calls that return numerical values, the value is in bytes; when - requesting these values, where should point to appropriately aligned - memory. For calls that return strings, the required length is given in + The first argument for pcre2_config() specifies which information is + required. The second argument is a pointer to memory into which the + information is placed. If NULL is passed, the function returns the + amount of memory that is needed for the requested information. For + calls that return numerical values, the value is in bytes; when + requesting these values, where should point to appropriately aligned + memory. For calls that return strings, the required length is given in code units, not counting the terminating zero. - When requesting information, the returned value from pcre2_config() is - non-negative on success, or the negative error code PCRE2_ERROR_BADOP- - TION if the value in the first argument is not recognized. The follow- + When requesting information, the returned value from pcre2_config() is + non-negative on success, or the negative error code PCRE2_ERROR_BADOP- + TION if the value in the first argument is not recognized. The follow- ing information is available: PCRE2_CONFIG_BSR The output is an integer whose value indicates what character sequences - the \R escape sequence matches by default. A value of 0 means that \R - matches any Unicode line ending sequence; a value of 1 means that \R + the \R escape sequence matches by default. A value of 0 means that \R + matches any Unicode line ending sequence; a value of 1 means that \R matches only CR, LF, or CRLF. The default can be overridden when a pat- tern is compiled or matched. @@ -858,39 +855,39 @@ CHECKING BUILD-TIME OPTIONS PCRE2_CONFIG_JITTARGET - The where argument should point to a buffer that is at least 48 code + The where argument should point to a buffer that is at least 48 code units long. (The exact length needed can be found by calling pcre2_con- - fig() with where set to NULL.) The buffer is filled with a string that - contains the name of the architecture for which the JIT compiler is + fig() with where set to NULL.) The buffer is filled with a string that + contains the name of the architecture for which the JIT compiler is configured, for example "x86 32bit (little endian + unaligned)". If JIT - support is not available, PCRE2_ERROR_BADOPTION is returned, otherwise + support is not available, PCRE2_ERROR_BADOPTION is returned, otherwise the length of the string, in code units, is returned. PCRE2_CONFIG_LINKSIZE - The output is an integer that contains the number of bytes used for + The output is an integer that contains the number of bytes used for internal linkage in compiled regular expressions. When PCRE2 is config- - ured, the value can be set to 2, 3, or 4, with the default being 2. + ured, the value can be set to 2, 3, or 4, with the default being 2. This is the value that is returned by pcre2_config(). However, when the - 16-bit library is compiled, a value of 3 is rounded up to 4, and when - the 32-bit library is compiled, internal linkages always use 4 bytes, + 16-bit library is compiled, a value of 3 is rounded up to 4, and when + the 32-bit library is compiled, internal linkages always use 4 bytes, so the configured value is not relevant. The default value of 2 for the 8-bit and 16-bit libraries is sufficient - for all but the most massive patterns, since it allows the size of the + for all but the most massive patterns, since it allows the size of the compiled pattern to be up to 64K code units. Larger values allow larger - regular expressions to be compiled by those two libraries, but at the + regular expressions to be compiled by those two libraries, but at the expense of slower matching. PCRE2_CONFIG_MATCHLIMIT The output is an unsigned long integer that gives the default limit for - the number of internal matching function calls in a pcre2_match() exe- + the number of internal matching function calls in a pcre2_match() exe- cution. Further details are given with pcre2_match() below. PCRE2_CONFIG_NEWLINE - The output is an integer whose value specifies the default character + The output is an integer whose value specifies the default character sequence that is recognized as meaning "newline". The values are: 1 Carriage return (CR) @@ -899,56 +896,56 @@ CHECKING BUILD-TIME OPTIONS 4 Any Unicode line ending 5 Any of CR, LF, or CRLF - The default should normally correspond to the standard sequence for + The default should normally correspond to the standard sequence for your operating system. PCRE2_CONFIG_PARENSLIMIT - The output is an unsigned long integer that gives the maximum depth of - nesting of parentheses (of any kind) in a pattern. This limit is - imposed to cap the amount of system stack used when a pattern is com- - piled. It is specified when PCRE2 is built; the default is 250. This - limit does not take into account the stack that may already be used by - the calling application. For finer control over compilation stack + The output is an unsigned long integer that gives the maximum depth of + nesting of parentheses (of any kind) in a pattern. This limit is + imposed to cap the amount of system stack used when a pattern is com- + piled. It is specified when PCRE2 is built; the default is 250. This + limit does not take into account the stack that may already be used by + the calling application. For finer control over compilation stack usage, see pcre2_set_compile_recursion_guard(). PCRE2_CONFIG_RECURSIONLIMIT The output is an unsigned long integer that gives the default limit for the depth of recursion when calling the internal matching function in a - pcre2_match() execution. Further details are given with pcre2_match() + pcre2_match() execution. Further details are given with pcre2_match() below. PCRE2_CONFIG_STACKRECURSE - The output is an integer that is set to one if internal recursion when - running pcre2_match() is implemented by recursive function calls that - use the system stack to remember their state. This is the usual way + The output is an integer that is set to one if internal recursion when + running pcre2_match() is implemented by recursive function calls that + use the system stack to remember their state. This is the usual way that PCRE2 is compiled. The output is zero if PCRE2 was compiled to use blocks of data on the heap instead of recursive function calls. PCRE2_CONFIG_UNICODE_VERSION - The where argument should point to a buffer that is at least 24 code + The where argument should point to a buffer that is at least 24 code units long. (The exact length needed can be found by calling pcre2_con- - fig() with where set to NULL.) If PCRE2 has been compiled without Uni- - code support, the buffer is filled with the text "Unicode not sup- - ported". Otherwise, the Unicode version string (for example, "7.0.0") - is inserted. The string is zero-terminated. The function returns the + fig() with where set to NULL.) If PCRE2 has been compiled without Uni- + code support, the buffer is filled with the text "Unicode not sup- + ported". Otherwise, the Unicode version string (for example, "7.0.0") + is inserted. The string is zero-terminated. The function returns the length of the string in code units. PCRE2_CONFIG_UNICODE - The output is an integer that is set to one if Unicode support is - available; otherwise it is set to zero. Unicode support implies UTF + The output is an integer that is set to one if Unicode support is + available; otherwise it is set to zero. Unicode support implies UTF support. PCRE2_CONFIG_VERSION - The where argument should point to a buffer that is at least 12 code + The where argument should point to a buffer that is at least 12 code units long. (The exact length needed can be found by calling pcre2_con- fig() with where set to NULL.) The buffer is filled with the PCRE2 ver- - sion string, zero-terminated. The length of the string (in code units) + sion string, zero-terminated. The length of the string (in code units) is returned. @@ -960,49 +957,49 @@ COMPILING A PATTERN pcre2_code_free(pcre2_code *code); - This function compiles a pattern, defined by a pointer to a string of + This function compiles a pattern, defined by a pointer to a string of code units and a length, into an internal form. If the pattern is zero- - terminated, the length should be specified as PCRE2_ZERO_TERMINATED. - The function returns a pointer to a block of memory that contains the - compiled pattern and related data. The caller must free the memory by + terminated, the length should be specified as PCRE2_ZERO_TERMINATED. + The function returns a pointer to a block of memory that contains the + compiled pattern and related data. The caller must free the memory by calling pcre2_code_free() when it is no longer needed. - If the compile context argument ccontext is NULL, the memory is - obtained by calling malloc(). Otherwise, it is obtained from the same + If the compile context argument ccontext is NULL, the memory is + obtained by calling malloc(). Otherwise, it is obtained from the same memory function that was used for the compile context. The options argument contains various bit settings that affect the com- - pilation. It should be zero if no options are required. The available - options are described below. Some of them (in particular, those that - are compatible with Perl, but some others as well) can also be set and - unset from within the pattern (see the detailed description in the + pilation. It should be zero if no options are required. The available + options are described below. Some of them (in particular, those that + are compatible with Perl, but some others as well) can also be set and + unset from within the pattern (see the detailed description in the pcre2pattern documentation). - For those options that can be different in different parts of the pat- - tern, the contents of the options argument specifies their settings at - the start of compilation. The PCRE2_ANCHORED and PCRE2_NO_UTF_CHECK + For those options that can be different in different parts of the pat- + tern, the contents of the options argument specifies their settings at + the start of compilation. The PCRE2_ANCHORED and PCRE2_NO_UTF_CHECK options can be set at the time of matching as well as at compile time. - Other, less frequently required compile-time parameters (for example, + Other, less frequently required compile-time parameters (for example, the newline setting) can be provided in a compile context (as described above). If errorcode or erroroffset is NULL, pcre2_compile() returns NULL imme- - diately. Otherwise, if compilation of a pattern fails, pcre2_compile() + diately. Otherwise, if compilation of a pattern fails, pcre2_compile() returns NULL, having set these variables to an error code and an offset - (number of code units) within the pattern, respectively. The - pcre2_get_error_message() function provides a textual message for each + (number of code units) within the pattern, respectively. The + pcre2_get_error_message() function provides a textual message for each error code. Compilation errors are positive numbers, but UTF formatting errors are negative numbers. For an invalid UTF-8 or UTF-16 string, the offset is that of the first code 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 code units, not characters, even in a UTF + 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 code units, not characters, even in a UTF mode. It may sometimes point into the middle of a UTF-8 or UTF-16 char- acter. - This code fragment shows a typical straightforward call to pcre2_com- + This code fragment shows a typical straightforward call to pcre2_com- pile(): pcre2_code *re; @@ -1016,158 +1013,158 @@ COMPILING A PATTERN &erroffset, /* for error offset */ NULL); /* no compile context */ - The following names for option bits are defined in the pcre2.h header + The following names for option bits are defined in the pcre2.h header file: PCRE2_ANCHORED If this bit is set, the pattern is forced to be "anchored", that is, it - is constrained to match only at the first matching point in the string - that is being searched (the "subject string"). This effect can also be - achieved by appropriate constructs in the pattern itself, which is the + is constrained to match only at the first matching point in the string + that is being searched (the "subject string"). This effect can also be + achieved by appropriate constructs in the pattern itself, which is the only way to do it in Perl. PCRE2_ALLOW_EMPTY_CLASS - By default, for compatibility with Perl, a closing square bracket that - immediately follows an opening one is treated as a data character for - the class. When PCRE2_ALLOW_EMPTY_CLASS is set, it terminates the + By default, for compatibility with Perl, a closing square bracket that + immediately follows an opening one is treated as a data character for + the class. When PCRE2_ALLOW_EMPTY_CLASS is set, it terminates the class, which therefore contains no characters and so can never match. PCRE2_ALT_BSUX - This option request alternative handling of three escape sequences, - which makes PCRE2's behaviour more like ECMAscript (aka JavaScript). + This option request alternative handling of three escape sequences, + which makes PCRE2's behaviour more like ECMAscript (aka JavaScript). When it is set: (1) \U matches an upper case "U" character; by default \U causes a com- pile time error (Perl uses \U to upper case subsequent characters). (2) \u matches a lower case "u" character unless it is followed by four - hexadecimal digits, in which case the hexadecimal number defines the - code point to match. By default, \u causes a compile time error (Perl + hexadecimal digits, in which case the hexadecimal number defines the + code point to match. By default, \u causes a compile time error (Perl uses it to upper case the following character). - (3) \x matches a lower case "x" character unless it is followed by two - hexadecimal digits, in which case the hexadecimal number defines the - code point to match. By default, as in Perl, a hexadecimal number is + (3) \x matches a lower case "x" character unless it is followed by two + hexadecimal digits, in which case the hexadecimal number defines the + code point to match. By default, as in Perl, a hexadecimal number is always expected after \x, but it may have zero, one, or two digits (so, for example, \xz matches a binary zero character followed by z). PCRE2_AUTO_CALLOUT - If this bit is set, pcre2_compile() automatically inserts callout + If this bit is set, pcre2_compile() automatically inserts callout items, all with number 255, before each pattern item. For discussion of the callout facility, see the pcre2callout documentation. PCRE2_CASELESS - If this bit is set, letters in the pattern match both upper and lower - case letters in the subject. It is equivalent to Perl's /i option, and + If this bit is set, letters in the pattern match both upper and lower + case letters in the subject. It is equivalent to Perl's /i option, and it can be changed within a pattern by a (?i) option setting. PCRE2_DOLLAR_ENDONLY - If this bit is set, a dollar metacharacter in the pattern matches only - at the end of the subject string. Without this option, a dollar also - matches immediately before a newline at the end of the string (but not - before any other newlines). The PCRE2_DOLLAR_ENDONLY option is ignored - if PCRE2_MULTILINE is set. There is no equivalent to this option in + If this bit is set, a dollar metacharacter in the pattern matches only + at the end of the subject string. Without this option, a dollar also + matches immediately before a newline at the end of the string (but not + before any other newlines). The PCRE2_DOLLAR_ENDONLY option is ignored + if PCRE2_MULTILINE is set. There is no equivalent to this option in Perl, and no way to set it within a pattern. PCRE2_DOTALL - If this bit is set, a dot metacharacter in the pattern matches any - character, including one that indicates a newline. However, it only + If this bit is set, a dot metacharacter in the pattern matches any + character, including one that indicates a newline. However, it only ever matches one character, even if newlines are coded as CRLF. Without this option, a dot does not match when the current position in the sub- - ject is at a newline. This option is equivalent to Perl's /s option, + ject is at a newline. This option is equivalent to Perl's /s option, and it can be changed within a pattern by a (?s) option setting. A neg- ative class such as [^a] always matches newline characters, independent of the setting of this option. PCRE2_DUPNAMES - If this bit is set, names used to identify capturing subpatterns need + If this bit is set, names used to identify capturing subpatterns need not be unique. This can be helpful for certain types of pattern when it - is known that only one instance of the named subpattern can ever be - matched. There are more details of named subpatterns below; see also + is known that only one instance of the named subpattern can ever be + matched. There are more details of named subpatterns below; see also the pcre2pattern documentation. PCRE2_EXTENDED - If this bit is set, most white space characters in the pattern are - totally ignored except when escaped or inside a character class. How- - ever, white space is not allowed within sequences such as (?> that + If this bit is set, most white space characters in the pattern are + totally ignored except when escaped or inside a character class. How- + ever, white space is not allowed within sequences such as (?> that introduce various parenthesized subpatterns, nor within numerical quan- - tifiers such as {1,3}. Ignorable white space is permitted between an - item and a following quantifier and between a quantifier and a follow- + tifiers such as {1,3}. Ignorable white space is permitted between an + item and a following quantifier and between a quantifier and a follow- ing + that indicates possessiveness. - PCRE2_EXTENDED also causes characters between an unescaped # outside a - character class and the next newline, inclusive, to be ignored, which + PCRE2_EXTENDED also causes characters between an unescaped # outside a + character class and the next newline, inclusive, to be ignored, which makes it possible to include comments inside complicated patterns. Note - that the end of this type of comment is a literal newline sequence in + that the end of this type of comment is a literal newline sequence in the pattern; escape sequences that happen to represent a newline do not - count. PCRE2_EXTENDED is equivalent to Perl's /x option, and it can be + count. PCRE2_EXTENDED is equivalent to Perl's /x option, and it can be changed within a pattern by a (?x) option setting. Which characters are interpreted as newlines can be specified by a set- - ting in the compile context that is passed to pcre2_compile() or by a - special sequence at the start of the pattern, as described in the sec- - tion entitled "Newline conventions" in the pcre2pattern documentation. + ting in the compile context that is passed to pcre2_compile() or by a + special sequence at the start of the pattern, as described in the sec- + tion entitled "Newline conventions" in the pcre2pattern documentation. A default is defined when PCRE2 is built. PCRE2_FIRSTLINE - If this option is set, an unanchored pattern is required to match - before or at the first newline in the subject string, though the + If this option is set, an unanchored pattern is required to match + before or at the first newline in the subject string, though the matched text may continue over the newline. PCRE2_MATCH_UNSET_BACKREF - If this option is set, a back reference to an unset subpattern group - matches an empty string (by default this causes the current matching - alternative to fail). A pattern such as (\1)(a) succeeds when this - option is set (assuming it can find an "a" in the subject), whereas it - fails by default, for Perl compatibility. Setting this option makes + If this option is set, a back reference to an unset subpattern group + matches an empty string (by default this causes the current matching + alternative to fail). A pattern such as (\1)(a) succeeds when this + option is set (assuming it can find an "a" in the subject), whereas it + fails by default, for Perl compatibility. Setting this option makes PCRE2 behave more like ECMAscript (aka JavaScript). PCRE2_MULTILINE - By default, for the purposes of matching "start of line" and "end of - line", PCRE2 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 + By default, for the purposes of matching "start of line" and "end of + line", PCRE2 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 PCRE2_DOL- - LAR_ENDONLY is set). Note, however, that unless PCRE2_DOTALL is set, + LAR_ENDONLY is set). Note, however, that unless PCRE2_DOTALL is set, the "any character" metacharacter (.) does not match at a newline. This behaviour (for ^, $, and dot) is the same as Perl. - When PCRE2_MULTILINE it is set, the "start of line" and "end of line" - constructs match immediately following or immediately before internal - newlines in the subject string, respectively, as well as at the very - start and end. This is equivalent to Perl's /m option, and it can be + When PCRE2_MULTILINE it is set, the "start of line" and "end of line" + constructs match immediately following or immediately before internal + newlines in the subject string, respectively, as well as at the very + start and end. This is equivalent to Perl's /m option, and it can be changed within a pattern by a (?m) option setting. If there are no new- - lines in a subject string, or no occurrences of ^ or $ in a pattern, + lines in a subject string, or no occurrences of ^ or $ in a pattern, setting PCRE2_MULTILINE has no effect. PCRE2_NEVER_UCP - This option locks out the use of Unicode properties for handling \B, + This option locks out the use of Unicode properties for handling \B, \b, \D, \d, \S, \s, \W, \w, and some of the POSIX character classes, as - described for the PCRE2_UCP option below. In particular, it prevents - the creator of the pattern from enabling this facility by starting the - pattern with (*UCP). This may be useful in applications that process - patterns from external sources. The option combination PCRE_UCP and + described for the PCRE2_UCP option below. In particular, it prevents + the creator of the pattern from enabling this facility by starting the + pattern with (*UCP). This may be useful in applications that process + patterns from external sources. The option combination PCRE_UCP and PCRE_NEVER_UCP causes an error. PCRE2_NEVER_UTF - This option locks out interpretation of the pattern as UTF-8, UTF-16, + This option locks out interpretation of the pattern as UTF-8, UTF-16, or UTF-32, depending on which library is in use. In particular, it pre- - vents the creator of the pattern from switching to UTF interpretation + vents 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 PCRE2_UTF and PCRE2_NEVER_UTF causes an error. @@ -1175,122 +1172,122 @@ COMPILING A PATTERN PCRE2_NO_AUTO_CAPTURE If this option is set, it disables the use of numbered capturing paren- - theses in the pattern. Any opening parenthesis that is not followed by - ? behaves as if it were followed by ?: but named parentheses can still - be used for capturing (and they acquire numbers in the usual way). + theses in the pattern. Any opening parenthesis that is not followed by + ? behaves as if it were followed by ?: but named parentheses can still + be used for capturing (and they acquire numbers in the usual way). There is no equivalent of this option in Perl. PCRE2_NO_AUTO_POSSESS If this option is set, it disables "auto-possessification", which is an - optimization that, for example, turns a+b into a++b in order to avoid - backtracks into a+ that can never be successful. However, if callouts - are in use, auto-possessification means that some callouts are never + optimization that, for example, turns a+b into a++b in order to avoid + backtracks into a+ that can never be successful. However, if callouts + are in use, auto-possessification means that some callouts are never taken. You can set this option if you want the matching functions to do - a full unoptimized search and run all the callouts, but it is mainly + a full unoptimized search and run all the callouts, but it is mainly provided for testing purposes. PCRE2_NO_START_OPTIMIZE - This is an option whose main effect is at matching time. It does not + This is an option whose main effect is at matching time. It does not change what pcre2_compile() generates, but it does affect the output of the JIT compiler. - There are a number of optimizations that may occur at the start of a - match, in order to speed up the process. For example, if it is known - that an unanchored match must start with a specific character, the - matching code searches the subject for that character, and fails imme- - diately if it cannot find it, without actually running the main match- - ing 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. 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 optimiza- - tions are in effect a pre-scan of the subject that takes place before + There are a number of optimizations that may occur at the start of a + match, in order to speed up the process. For example, if it is known + that an unanchored match must start with a specific character, the + matching code searches the subject for that character, and fails imme- + diately if it cannot find it, without actually running the main match- + ing 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. 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 optimiza- + tions are in effect a pre-scan of the subject that takes place before the pattern is run. The PCRE2_NO_START_OPTIMIZE option disables the start-up optimizations, - possibly causing performance to suffer, but ensuring that in cases - where the result is "no match", the callouts do occur, and that items + possibly causing performance to suffer, but ensuring that in cases + where the result is "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. - Setting PCRE2_NO_START_OPTIMIZE may change the outcome of a matching + Setting PCRE2_NO_START_OPTIMIZE may change the outcome of a matching operation. Consider the pattern (*COMMIT)ABC - When this is compiled, PCRE2 records the fact that a match must start - with the character "A". Suppose the subject string is "DEFABC". The - start-up optimization scans along the subject, finds "A" and runs the - first match attempt from there. The (*COMMIT) item means that the pat- - tern must match the current starting position, which in this case, it - does. However, if the same match is run with PCRE2_NO_START_OPTIMIZE - set, the initial scan along the subject string does not happen. The - first match attempt is run starting from "D" and when this fails, - (*COMMIT) prevents any further matches being tried, so the overall + When this is compiled, PCRE2 records the fact that a match must start + with the character "A". Suppose the subject string is "DEFABC". The + start-up optimization scans along the subject, finds "A" and runs the + first match attempt from there. The (*COMMIT) item means that the pat- + tern must match the current starting position, which in this case, it + does. However, if the same match is run with PCRE2_NO_START_OPTIMIZE + set, the initial scan along the subject string does not happen. The + first match attempt is run starting from "D" and when this fails, + (*COMMIT) prevents any further matches being tried, so the overall result is "no match". There are also other start-up optimizations. For example, a minimum length for the subject may be recorded. Consider the pattern (*MARK:A)(X|Y) - The minimum length for a match is one character. If the subject is + The minimum length for a match is one character. If the subject is "ABC", there will be attempts to match "ABC", "BC", and "C". An attempt to match an empty string at the end of the subject does not take place, - because PCRE2 knows that the subject is now too short, and so the - (*MARK) is never encountered. In this case, the optimization does not + because PCRE2 knows that the subject is now too short, and so the + (*MARK) is never encountered. In this case, the optimization does not affect the overall match result, which is still "no match", but it does affect the auxiliary information that is returned. PCRE2_NO_UTF_CHECK - When PCRE2_UTF is set, the validity of the pattern as a UTF string is - automatically checked. There are discussions about the validity of - UTF-8 strings, UTF-16 strings, and UTF-32 strings in the pcre2unicode + When PCRE2_UTF is set, the validity of the pattern as a UTF string is + automatically checked. There are discussions about the validity of + UTF-8 strings, UTF-16 strings, and UTF-32 strings in the pcre2unicode document. If an invalid UTF sequence is found, pcre2_compile() returns a negative error code. If you know that your pattern is valid, and you want to skip this check - for performance reasons, you can set the PCRE2_NO_UTF_CHECK option. - When it is set, the effect of passing an invalid UTF string as a pat- - tern is undefined. It may cause your program to crash or loop. Note - that this option can also be passed to pcre2_match() and + for performance reasons, you can set the PCRE2_NO_UTF_CHECK option. + When it is set, the effect of passing an invalid UTF string as a pat- + tern is undefined. It may cause your program to crash or loop. Note + that this option can also be passed to pcre2_match() and pcre_dfa_match(), to suppress validity checking of the subject string. PCRE2_UCP This option changes the way PCRE2 processes \B, \b, \D, \d, \S, \s, \W, - \w, and some of the POSIX character classes. By default, only ASCII - characters are recognized, but if PCRE2_UCP is set, Unicode properties - are used instead to classify characters. More details are given in the + \w, and some of the POSIX character classes. By default, only ASCII + characters are recognized, but if PCRE2_UCP is set, Unicode properties + are used instead to classify characters. More details are given in the section on generic character types in the pcre2pattern page. If you set - PCRE2_UCP, matching one of the items it affects takes much longer. The + PCRE2_UCP, matching one of the items it affects takes much longer. The option is available only if PCRE2 has been compiled with UTF support. PCRE2_UNGREEDY - This option inverts the "greediness" of the quantifiers so that they - are not greedy by default, but become greedy if followed by "?". It is - not compatible with Perl. It can also be set by a (?U) option setting + This option inverts the "greediness" of the quantifiers so that they + are not greedy by default, but become greedy if followed by "?". It is + not compatible with Perl. It can also be set by a (?U) option setting within the pattern. PCRE2_UTF - This option causes PCRE2 to regard both the pattern and the subject - strings that are subsequently processed as strings of UTF characters + This option causes PCRE2 to regard both the pattern and the subject + strings that are subsequently processed as strings of UTF characters instead of single-code-unit strings. However, it is available only when - PCRE2 is built to include UTF support. If not, the use of this option - provokes an error. Details of how this option changes the behaviour of + PCRE2 is built to include UTF support. If not, the use of this option + provokes an error. Details of how this option changes the behaviour of PCRE2 are given in the pcre2unicode page. COMPILATION ERROR CODES - There are over 80 positive error codes that pcre2_compile() may return + There are over 80 positive error codes that pcre2_compile() may return if it finds an error in the pattern. There are also some negative error - codes that are used for invalid UTF strings. These are the same as - given by pcre2_match() and pcre2_dfa_match(), and are described in the + codes that are used for invalid UTF strings. These are the same as + given by pcre2_match() and pcre2_dfa_match(), and are described in the pcre2unicode page. The pcre2_get_error_message() function can be called to obtain a textual error message from any error code. @@ -1314,54 +1311,54 @@ JUST-IN-TIME (JIT) COMPILATION void pcre2_jit_stack_free(pcre2_jit_stack *jit_stack); - These functions provide support for JIT compilation, which, if the - just-in-time compiler is available, further processes a compiled pat- + These functions provide support for JIT compilation, which, if the + just-in-time compiler is available, further processes a compiled pat- tern into machine code that executes much faster than the pcre2_match() - interpretive matching function. Full details are given in the pcre2jit + interpretive matching function. Full details are given in the pcre2jit documentation. - JIT compilation is a heavyweight optimization. It can take some time - for patterns to be analyzed, and for one-off matches and simple pat- - terns the benefit of faster execution might be offset by a much slower - compilation time. Most, but not all patterns can be optimized by the + JIT compilation is a heavyweight optimization. It can take some time + for patterns to be analyzed, and for one-off matches and simple pat- + terns the benefit of faster execution might be offset by a much slower + compilation time. Most, but not all patterns can be optimized by the JIT compiler. LOCALE SUPPORT - PCRE2 handles caseless matching, and determines whether characters are - letters, digits, or whatever, by reference to a set of tables, indexed - by character code point. When running in UTF-8 mode, or using the - 16-bit or 32-bit libraries, this applies only to characters with code + PCRE2 handles caseless matching, and determines whether characters are + letters, digits, or whatever, by reference to a set of tables, indexed + by character code point. When running in UTF-8 mode, or using the + 16-bit or 32-bit libraries, this applies only to characters with code points less than 256. By default, higher-valued code points never match - escapes such as \w or \d. However, if PCRE2 is built with UTF support, - all characters can be tested with \p and \P, or, alternatively, the - PCRE2_UCP option can be set when a pattern is compiled; this causes \w - and friends to use Unicode property support instead of the built-in + escapes such as \w or \d. However, if PCRE2 is built with UTF support, + all characters can be tested with \p and \P, or, alternatively, the + PCRE2_UCP option can be set when a pattern is compiled; this causes \w + and friends to use Unicode property support instead of the built-in tables. - The use of locales with Unicode is discouraged. If you are handling - characters with code points greater than 128, you should either use + The use of locales with Unicode is discouraged. If you are handling + characters with code points greater than 128, you should either use Unicode support, or use locales, but not try to mix the two. - PCRE2 contains an internal set of character tables that are used by - default. These are sufficient for many applications. Normally, the + PCRE2 contains an internal set of character tables that are used by + default. These are sufficient for many applications. Normally, the internal tables recognize only ASCII characters. However, when PCRE2 is built, it is possible to cause the internal tables to be rebuilt in the default "C" locale of the local system, which may cause them to be dif- ferent. - The internal tables can be overridden by tables supplied by the appli- - cation that calls PCRE2. These may be created in a different locale - from the default. As more and more applications change to using Uni- + The internal tables can be overridden by tables supplied by the appli- + cation that calls PCRE2. These may be created in a different locale + from the default. As more and more applications change to using Uni- code, the need for this locale support is expected to die away. - External tables are built by calling the pcre2_maketables() function, - in the relevant locale. The result can be passed to pcre2_compile() as - often as necessary, by creating a compile context and calling - pcre2_set_character_tables() to set the tables pointer therein. For - example, to build and use tables that are appropriate for the French - locale (where accented characters with values greater than 128 are + External tables are built by calling the pcre2_maketables() function, + in the relevant locale. The result can be passed to pcre2_compile() as + often as necessary, by creating a compile context and calling + pcre2_set_character_tables() to set the tables pointer therein. For + example, to build and use tables that are appropriate for the French + locale (where accented characters with values greater than 128 are treated as letters), the following code could be used: setlocale(LC_CTYPE, "fr_FR"); @@ -1370,15 +1367,15 @@ LOCALE SUPPORT pcre2_set_character_tables(ccontext, tables); re = pcre2_compile(..., ccontext); - The locale name "fr_FR" is used on Linux and other Unix-like systems; - if you are using Windows, the name for the French locale is "french". - It is the caller's responsibility to ensure that the memory containing + The locale name "fr_FR" is used on Linux and other Unix-like systems; + if you are using Windows, the name for the French locale is "french". + It is the caller's responsibility to ensure that the memory containing the tables remains available for as long as it is needed. The pointer that is passed (via the compile context) to pcre2_compile() - is saved with the compiled pattern, and the same tables are used by - pcre2_match() and pcre_dfa_match(). Thus, for any single pattern, com- - pilation, and matching all happen in the same locale, but different + is saved with the compiled pattern, and the same tables are used by + pcre2_match() and pcre_dfa_match(). Thus, for any single pattern, com- + pilation, and matching all happen in the same locale, but different patterns can be processed in different locales. @@ -1386,13 +1383,13 @@ INFORMATION ABOUT A COMPILED PATTERN int pcre2_pattern_info(const pcre2 *code, uint32_t what, void *where); - The pcre2_pattern_info() function returns information about a compiled - pattern. The first argument is a pointer to the compiled pattern. The - second argument specifies which piece of information is required, and - the third argument is a pointer to a variable to receive the data. If - the third argument is NULL, the first argument is ignored, and the + The pcre2_pattern_info() function returns information about a compiled + pattern. The first argument is a pointer to the compiled pattern. The + second argument specifies which piece of information is required, and + the third argument is a pointer to a variable to receive the data. If + the third argument is NULL, the first argument is ignored, and the function returns the size in bytes of the variable that is required for - the information requested. Otherwise, The yield of the function is + the information requested. Otherwise, The yield of the function is zero for success, or one of the following negative numbers: PCRE2_ERROR_NULL the argument code was NULL @@ -1400,9 +1397,9 @@ INFORMATION ABOUT A COMPILED PATTERN PCRE2_ERROR_BADOPTION the value of what was invalid PCRE2_ERROR_UNSET the requested field is not set - The "magic number" is placed at the start of each compiled pattern as - an simple check against passing an arbitrary memory pointer. Here is a - typical call of pcre2_pattern_info(), to obtain the length of the com- + The "magic number" is placed at the start of each compiled pattern as + an simple check against passing an arbitrary memory pointer. Here is a + typical call of pcre2_pattern_info(), to obtain the length of the com- piled pattern: int rc; @@ -1419,16 +1416,16 @@ INFORMATION ABOUT A COMPILED PATTERN PCRE2_INFO_ARGOPTIONS Return a copy of the pattern's options. The third argument should point - to a uint32_t variable. PCRE2_INFO_ARGOPTIONS returns exactly the - options that were passed to pcre2_compile(), whereas PCRE2_INFO_ALLOP- - TIONS returns the compile options as modified by any top-level option - settings at the start of the pattern itself. In other words, they are + to a uint32_t variable. PCRE2_INFO_ARGOPTIONS returns exactly the + options that were passed to pcre2_compile(), whereas PCRE2_INFO_ALLOP- + TIONS returns the compile options as modified by any top-level option + settings at the start of the pattern itself. In other words, they are the options that will be in force when matching starts. For example, if the pattern /(?im)abc(?-i)d/ is compiled with the PCRE2_EXTENDED - option, the result is PCRE2_CASELESS, PCRE2_MULTILINE, and + option, the result is PCRE2_CASELESS, PCRE2_MULTILINE, and PCRE2_EXTENDED. - A pattern is automatically anchored by PCRE2 if all of its top-level + A pattern is automatically anchored by PCRE2 if all of its top-level alternatives begin with one of the following: ^ unless PCRE2_MULTILINE is set @@ -1437,43 +1434,43 @@ INFORMATION ABOUT A COMPILED PATTERN .* if PCRE2_DOTALL is set and there are no back references to the subpattern in which .* appears - For such patterns, the PCRE2_ANCHORED bit is set in the options + For such patterns, the PCRE2_ANCHORED bit is set in the options returned for PCRE2_INFO_ALLOPTIONS. PCRE2_INFO_BACKREFMAX - Return the number of the highest back reference in the pattern. The - third argument should point to an uint32_t variable. Zero is returned + Return the number of the highest back reference in the pattern. The + third argument should point to an uint32_t variable. Zero is returned if there are no back references. PCRE2_INFO_BSR The output is a uint32_t whose value indicates what character sequences - the \R escape sequence matches by default. A value of 0 means that \R - matches any Unicode line ending sequence; a value of 1 means that \R + the \R escape sequence matches by default. A value of 0 means that \R + matches any Unicode line ending sequence; a value of 1 means that \R matches only CR, LF, or CRLF. The default can be overridden when a pat- tern is matched. PCRE2_INFO_CAPTURECOUNT - Return the number of capturing subpatterns in the pattern. The third + Return the number of capturing subpatterns in the pattern. The third argument should point to an uint32_t variable. PCRE2_INFO_FIRSTCODETYPE Return information about the first code unit of any matched string, for - a non-anchored pattern. The third argument should point to an uint32_t + a non-anchored pattern. The third argument should point to an uint32_t 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 PCRE2_INFO_FIRSTCODEUNIT. If there is no + 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 PCRE2_INFO_FIRSTCODEUNIT. If there is no fixed first value, and if either (a) the pattern was compiled with the PCRE2_MULTILINE option, and every branch starts with "^", or - (b) every branch of the pattern starts with ".*" and PCRE2_DOTALL is + (b) every branch of the pattern starts with ".*" and PCRE2_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 @@ -1482,99 +1479,99 @@ INFORMATION ABOUT A COMPILED PATTERN PCRE2_INFO_FIRSTCODEUNIT - Return the value of the first code unit of any matched string in the + Return the value of the first code unit of any matched string in the situation where PCRE2_INFO_FIRSTCODETYPE returns 1; otherwise return 0. - The third argument should point to an uint32_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 + The third argument should point to an uint32_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. PCRE2_INFO_FIRSTBITMAP - In the absence of a single first code unit for a non-anchored pattern, - pcre2_compile() may construct a 256-bit table that defines a fixed set - of values for the first code unit in any match. For example, a pattern - that starts with [abc] results in a table with three bits set. When - code unit values greater than 255 are supported, the flag bit for 255 - means "any code unit of value 255 or above". If such a table was con- - structed, a pointer to it is returned. Otherwise NULL is returned. The + In the absence of a single first code unit for a non-anchored pattern, + pcre2_compile() may construct a 256-bit table that defines a fixed set + of values for the first code unit in any match. For example, a pattern + that starts with [abc] results in a table with three bits set. When + code unit values greater than 255 are supported, the flag bit for 255 + means "any code unit of value 255 or above". If such a table was con- + structed, a pointer to it is returned. Otherwise NULL is returned. The third argument should point to an const uint8_t * variable. PCRE2_INFO_HASCRORLF - Return 1 if the pattern contains any explicit matches for CR or LF + Return 1 if the pattern contains any explicit matches for CR or LF characters, otherwise 0. The third argument should point to an uint32_t - variable. An explicit match is either a literal CR or LF character, or + variable. An explicit match is either a literal CR or LF character, or \r or \n. PCRE2_INFO_JCHANGED - Return 1 if the (?J) or (?-J) option setting is used in the pattern, - otherwise 0. The third argument should point to an uint32_t variable. - (?J) and (?-J) set and unset the local PCRE2_DUPNAMES option, respec- + Return 1 if the (?J) or (?-J) option setting is used in the pattern, + otherwise 0. The third argument should point to an uint32_t variable. + (?J) and (?-J) set and unset the local PCRE2_DUPNAMES option, respec- tively. PCRE2_INFO_JITSIZE - If the compiled pattern was successfully processed by pcre2_jit_com- - pile(), return the size of the JIT compiled code, otherwise return + If the compiled pattern was successfully processed by pcre2_jit_com- + pile(), return the size of the JIT compiled code, otherwise return zero. The third argument should point to a size_t variable. PCRE2_INFO_LASTCODETYPE - Returns 1 if there is a rightmost literal code unit that must exist in - any matched string, other than at its start. The third argument should - point to an uint32_t variable. If there is no such value, 0 is - returned. When 1 is returned, the code unit value itself can be + Returns 1 if there is a rightmost literal code unit that must exist in + any matched string, other than at its start. The third argument should + point to an uint32_t variable. If there is no such value, 0 is + returned. When 1 is returned, the code unit value itself can be retrieved using PCRE2_INFO_LASTCODEUNIT. For anchored patterns, a last literal value is recorded only if it fol- - lows something of variable length. For example, for the pattern - /^a\d+z\d+/ the returned value is 1 (with "z" returned from + lows something of variable length. For example, for the pattern + /^a\d+z\d+/ the returned value is 1 (with "z" returned from PCRE2_INFO_LASTCODEUNIT), but for /^a\dz\d/ the returned value is 0. PCRE2_INFO_LASTCODEUNIT - 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 third argument should point to an uint32_t variable. If + 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 third argument should point to an uint32_t variable. If there is no such value, 0 is returned. PCRE2_INFO_MATCHEMPTY - Return 1 if the pattern can match an empty string, otherwise 0. The + Return 1 if the pattern can match an empty string, otherwise 0. The third argument should point to an uint32_t variable. PCRE2_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 third - argument should point to an unsigned 32-bit integer. If no such value - has been set, the call to pcre2_pattern_info() returns the error + 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 third + argument should point to an unsigned 32-bit integer. If no such value + has been set, the call to pcre2_pattern_info() returns the error PCRE2_ERROR_UNSET. PCRE2_INFO_MAXLOOKBEHIND Return the number of characters (not code units) in the longest lookbe- - hind assertion in the pattern. The third argument should point to an - unsigned 32-bit integer. This information is useful when doing multi- - segment matching using the partial matching facilities. Note that the + hind assertion in the pattern. The third argument should point to an + unsigned 32-bit integer. 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 pro- + 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 pro- cessed. Otherwise, if there are no lookbehinds in the pattern, \A might match incorrectly at the start of a new segment. PCRE2_INFO_MINLENGTH - If a minimum length for matching subject strings was computed, its - value is returned. Otherwise the returned value is 0. The value is a - number of characters, which in UTF mode may be different from the num- - ber of code units. The third argument should point to an uint32_t - variable. The value is a lower bound to the length of any matching - string. There may not be any strings of that length that do actually + If a minimum length for matching subject strings was computed, its + value is returned. Otherwise the returned value is 0. The value is a + number of characters, which in UTF mode may be different from the num- + ber of code units. The third argument should point to an uint32_t + variable. The 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. PCRE2_INFO_NAMECOUNT @@ -1582,49 +1579,49 @@ INFORMATION ABOUT A COMPILED PATTERN PCRE2_INFO_NAMETABLE PCRE2 supports the use of named as well as numbered capturing parenthe- - ses. The names are just an additional way of identifying the parenthe- + ses. The names are just an additional way of identifying the parenthe- ses, which still acquire numbers. Several convenience functions such as - pcre2_substring_get_byname() are provided for extracting captured sub- - strings by name. It is also possible to extract the data directly, by - first converting the name to a number in order to access the correct - pointers in the output vector (described with pcre2_match() below). To - do the conversion, you need to use the name-to-number map, which is + pcre2_substring_get_byname() are provided for extracting captured sub- + strings by name. It is also possible to extract the data directly, by + first converting the name to a number in order to access the correct + pointers in the output vector (described with pcre2_match() below). To + do the conversion, you need to use the name-to-number map, which is described by these three values. - The map consists of a number of fixed-size entries. PCRE2_INFO_NAME- - COUNT gives the number of entries, and PCRE2_INFO_NAMEENTRYSIZE gives - the size of each entry; both of these return a uint32_t value. The + The map consists of a number of fixed-size entries. PCRE2_INFO_NAME- + COUNT gives the number of entries, and PCRE2_INFO_NAMEENTRYSIZE gives + the size of each entry; both of these return a uint32_t value. The entry size depends on the length of the longest name. PCRE2_INFO_NAMETABLE returns a pointer to the first entry of the table. - This is a PCRE2_SPTR pointer to a block of code units. In the 8-bit - library, the first two bytes of each entry are the number of the cap- + This is a PCRE2_SPTR pointer to a block of code units. In the 8-bit + library, the first two bytes of each entry are the number of the cap- turing 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. In the 32-bit library, the pointer points to - 32-bit data units, the first of which contains the parenthesis number. + the pointer points to 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. - The names are in alphabetical order. If (?| is used to create multiple - groups with the same number, as described in the section on duplicate - subpattern numbers in the pcre2pattern page, the groups may be given - the same name, but there is only one entry in the table. Different + The names are in alphabetical order. If (?| is used to create multiple + groups with the same number, as described in the section on duplicate + subpattern numbers in the pcre2pattern page, the groups may be given + the same name, but there is only one entry in the table. Different names for groups of the same number are not permitted. - Duplicate names for subpatterns with different numbers are permitted, - but only if PCRE2_DUPNAMES is set. They appear in the table in the - order in which they were found in the pattern. In the absence of (?| - this is the order of increasing number; when (?| is used this is not + Duplicate names for subpatterns with different numbers are permitted, + but only if PCRE2_DUPNAMES is set. They appear in the table in the + order in which they were found in the pattern. In the absence of (?| + this is the order of increasing number; when (?| is used this is not necessarily the case because later subpatterns may have lower numbers. - As a simple example of the name/number table, consider the following - pattern after compilation by the 8-bit library (assume PCRE2_EXTENDED + As a simple example of the name/number table, consider the following + pattern after compilation by the 8-bit library (assume PCRE2_EXTENDED is set, so white space - including newlines - is ignored): (? (?(\d\d)?\d\d) - (?\d\d) - (?\d\d) ) - There are four named subpatterns, so the table has four entries, and - each entry in the table is eight bytes long. The table is as follows, + There are four named subpatterns, so the table has four entries, and + each entry in the table is eight bytes long. The table is as follows, with non-printing bytes shows in hexadecimal, and undefined bytes shown as ??: @@ -1633,14 +1630,14 @@ INFORMATION ABOUT A COMPILED PATTERN 00 04 m o n t h 00 00 02 y e a r 00 ?? - When writing code to extract data from named subpatterns using the - name-to-number map, remember that the length of the entries is likely + When writing code to extract data from named subpatterns using the + name-to-number map, remember that the length of the entries is likely to be different for each compiled pattern. PCRE2_INFO_NEWLINE - The output is a uint32_t whose value specifies the default character - sequence that will be recognized as meaning "newline" while matching. + The output is a uint32_t whose value specifies the default character + sequence that will be recognized as meaning "newline" while matching. The values are: 1 Carriage return (CR) @@ -1653,21 +1650,21 @@ INFORMATION ABOUT A COMPILED PATTERN PCRE2_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 third - argument should point to an unsigned 32-bit integer. If no such value - has been set, the call to pcre2_pattern_info() returns the error + 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 third + argument should point to an unsigned 32-bit integer. If no such value + has been set, the call to pcre2_pattern_info() returns the error PCRE2_ERROR_UNSET. PCRE2_INFO_SIZE - Return the size of the compiled pattern in bytes (for all three - libraries). The third argument should point to a size_t variable. This - value does not include the size of the pcre2_code structure that is + Return the size of the compiled pattern in bytes (for all three + libraries). The third argument should point to a size_t variable. This + value does not include the size of the pcre2_code structure that is returned by pcre_compile(). The value that is used when pcre2_compile() - is getting memory in which to place the compiled data is the value + is getting memory in which to place the compiled data is the value returned by this option plus the size of the pcre2_code structure. Pro- - cessing a pattern with the JIT compiler does not alter the value + cessing a pattern with the JIT compiler does not alter the value returned by this option. @@ -1681,38 +1678,38 @@ THE MATCH DATA BLOCK void pcre2_match_data_free(pcre2_match_data *match_data); - Information about successful and unsuccessful matches is placed in a - match data block, which is an opaque structure that is accessed by - function calls. In particular, the match data block contains a vector - of offsets into the subject string that define the matched part of the + Information about successful and unsuccessful matches is placed in a + match data block, which is an opaque structure that is accessed by + function calls. In particular, the match data block contains a vector + of offsets into the subject string that define the matched part of the subject and any substrings that were capured. This is know as the ovec- tor. - Before calling pcre2_match() or pcre2_dfa_match() you must create a - match data block by calling one of the creation functions above. For + Before calling pcre2_match() or pcre2_dfa_match() you must create a + match data block by calling one of the creation functions above. For pcre2_match_data_create(), the first argument is the number of pairs of offsets in the ovector. One pair of offsets is required to identify the - string that matched the whole pattern, with another pair for each cap- - tured substring. For example, a value of 4 creates enough space to - record the matched portion of the subject plus three captured sub- + string that matched the whole pattern, with another pair for each cap- + tured substring. For example, a value of 4 creates enough space to + record the matched portion of the subject plus three captured sub- strings. A minimum of at least 1 pair is imposed by pcre2_match_data_create(), so it is always possible to return the over- all matched string. - For pcre2_match_data_create_from_pattern(), the first argument is a - pointer to a compiled pattern. In this case the ovector is created to - be exactly the right size to hold all the substrings a pattern might + For pcre2_match_data_create_from_pattern(), the first argument is a + pointer to a compiled pattern. In this case the ovector is created to + be exactly the right size to hold all the substrings a pattern might capture. - The second argument of both these functions ia a pointer to a general - context, which can specify custom memory management for obtaining the - memory for the match data block. If you are not using custom memory + The second argument of both these functions ia a pointer to a general + context, which can specify custom memory management for obtaining the + memory for the match data block. If you are not using custom memory management, pass NULL. - A match data block can be used many times, with the same or different - compiled patterns. When it is no longer needed, it should be freed by - calling pcre2_match_data_free(). How to extract information from a - match data block after a match operation is described in the sections + A match data block can be used many times, with the same or different + compiled patterns. When it is no longer needed, it should be freed by + calling pcre2_match_data_free(). How to extract information from a + match data block after a match operation is described in the sections on matched strings and other match data below. @@ -1723,15 +1720,15 @@ MATCHING A PATTERN: THE TRADITIONAL FUNCTION uint32_t options, pcre2_match_data *match_data, pcre2_match_context *mcontext); - The function pcre2_match() is called to match a subject string against - a compiled pattern, which is passed in the code argument. You can call + The function pcre2_match() is called to match a subject string against + a compiled pattern, which is passed in the code argument. You can call pcre2_match() with the same code argument as many times as you like, in - order to find multiple matches in the subject string or to match dif- + order to find multiple matches in the subject string or to match dif- ferent subject strings with the same pattern. - This function is the main matching facility of the library, and it - operates in a Perl-like manner. For specialist use there is also an - alternative matching function, which is described below in the section + This function is the main matching facility of the library, and it + operates in a Perl-like manner. For specialist use there is also an + alternative matching function, which is described below in the section about the pcre2_dfa_match() function. Here is an example of a simple call to pcre2_match(): @@ -1746,163 +1743,163 @@ MATCHING A PATTERN: THE TRADITIONAL FUNCTION match_data, /* the match data block */ NULL); /* a match context; NULL means use defaults */ - If the subject string is zero-terminated, the length can be given as + If the subject string is zero-terminated, the length can be given as PCRE2_ZERO_TERMINATED. A match context must be provided if certain less common matching parameters are to be changed. For details, see the sec- tion on the match context above. The string to be matched by pcre2_match() - The subject string is passed to pcre2_match() as a pointer in subject, - a length in length, and a starting offset in startoffset. The length - and offset are in code units, not characters. That is, they are in - bytes for the 8-bit library, 16-bit code units for the 16-bit library, - and 32-bit code units for the 32-bit library, whether or not UTF pro- + The subject string is passed to pcre2_match() as a pointer in subject, + a length in length, and a starting offset in startoffset. The length + and offset are in code units, not characters. That is, they are in + bytes for the 8-bit library, 16-bit code units for the 16-bit library, + and 32-bit code units for the 32-bit library, whether or not UTF pro- cessing is enabled. If startoffset is greater than the length of the subject, pcre2_match() - returns PCRE2_ERROR_BADOFFSET. When the starting offset is zero, the - search for a match starts at the beginning of the subject, and this is + returns PCRE2_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 starting off- - set must point to the start of a character, or to the end of the sub- - ject (in UTF-32 mode, one code unit equals one character, so all off- - sets are valid). Like the pattern string, the subject may contain + set must point to the start of a character, or to the end of the sub- + ject (in UTF-32 mode, one code unit equals one character, so all off- + sets are valid). Like 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 pcre2_match() again after a previous - success. Setting startoffset differs from passing over a shortened - string and setting PCRE2_NOTBOL in the case of a pattern that begins + A non-zero starting offset is useful when searching for another match + in the same subject by calling pcre2_match() again after a previous + success. Setting startoffset differs from passing over a shortened + string and setting PCRE2_NOTBOL in the case of a pattern that begins with any kind of lookbehind. For example, consider the pattern \Biss\B - which finds occurrences of "iss" in the middle of words. (\B matches - only if the current position in the subject is not a word boundary.) + which finds occurrences of "iss" in the middle of words. (\B matches + only if the current position in the subject is not a word boundary.) When applied to the string "Mississipi" the first call to pcre2_match() - finds the first occurrence. If pcre2_match() is called again with just - the remainder of the subject, namely "issipi", it does not match, + finds the first occurrence. If pcre2_match() is called again with just + the remainder of the subject, namely "issipi", it does not match, because \B is always false at the start of the subject, which is deemed - to be a word boundary. However, if pcre2_match() is passed the entire + to be a word boundary. However, if pcre2_match() is passed the entire string again, but with startoffset set to 4, it finds the second occur- - rence of "iss" because it is able to look behind the starting point to + rence of "iss" because it is able to look behind the starting point to discover that it is preceded by a letter. - Finding all the matches in a subject is tricky when the pattern can + Finding all the matches in a subject is tricky when the pattern can match an empty string. It is possible to emulate Perl's /g behaviour by - first trying the match again at the same offset, with the - PCRE2_NOTEMPTY_ATSTART and PCRE2_ANCHORED options, and then if that - fails, advancing the starting offset and trying an ordinary match - again. There is some code that demonstrates how to do this in the - pcre2demo sample program. In the most general case, you have to check - to see if the newline convention recognizes CRLF as a newline, and if - so, and the current character is CR followed by LF, advance the start- + first trying the match again at the same offset, with the + PCRE2_NOTEMPTY_ATSTART and PCRE2_ANCHORED options, and then if that + fails, advancing the starting offset and trying an ordinary match + again. There is some code that demonstrates how to do this in the + pcre2demo sample program. In the most general case, you have to check + to see if the newline convention recognizes CRLF as a newline, and if + so, and the current character is CR followed by LF, advance the start- ing offset by two characters instead of one. - If a non-zero starting offset is passed when the pattern is anchored, + If a non-zero starting offset is passed when the pattern is anchored, one attempt to match at the given offset is made. This can only succeed - if the pattern does not require the match to be at the start of the + if the pattern does not require the match to be at the start of the subject. Option bits for pcre2_match() The unused bits of the options argument for pcre2_match() must be zero. - The only bits that may be set are PCRE2_ANCHORED, PCRE2_NOTBOL, + The only bits that may be set are PCRE2_ANCHORED, PCRE2_NOTBOL, PCRE2_NOTEOL, PCRE2_NOTEMPTY, PCRE2_NOTEMPTY_ATSTART, - PCRE2_NO_UTF_CHECK, PCRE2_PARTIAL_HARD, and PCRE2_PARTIAL_SOFT. Their + PCRE2_NO_UTF_CHECK, PCRE2_PARTIAL_HARD, and PCRE2_PARTIAL_SOFT. Their action is described below. - If the pattern was successfully processed by the just-in-time (JIT) - compiler, the only supported options for matching using the JIT code + If the pattern was successfully processed by the just-in-time (JIT) + compiler, the only supported options for matching using the JIT code are PCRE2_NOTBOL, PCRE2_NOTEOL, PCRE2_NOTEMPTY, PCRE2_NOTEMPTY_ATSTART, - PCRE2_NO_UTF_CHECK, PCRE2_PARTIAL_HARD, and PCRE2_PARTIAL_SOFT. If an - unsupported option is used, JIT matching is disabled and the normal + PCRE2_NO_UTF_CHECK, PCRE2_PARTIAL_HARD, and PCRE2_PARTIAL_SOFT. If an + unsupported option is used, JIT matching is disabled and the normal interpretive code in pcre2_match() is run. PCRE2_ANCHORED The PCRE2_ANCHORED option limits pcre2_match() to matching at the first - matching position. If a pattern was compiled with PCRE2_ANCHORED, or - turned out to be anchored by virtue of its contents, it cannot be made - unachored at matching time. Note that setting the option at match time + matching position. If a pattern was compiled with PCRE2_ANCHORED, or + turned out to be anchored by virtue of its contents, it cannot be made + unachored at matching time. Note that setting the option at match time disables JIT matching. PCRE2_NOTBOL This option specifies that first character of the subject string is not - the beginning of a line, so the circumflex metacharacter should not + the beginning of a line, so the circumflex metacharacter should not match before it. Setting this without PCRE2_MULTILINE (at compile time) - causes circumflex never to match. This option affects only the behav- + causes circumflex never to match. This option affects only the behav- iour of the circumflex metacharacter. It does not affect \A. PCRE2_NOTEOL This option specifies that the end of the subject string is not the end - of a line, so the dollar metacharacter should not match it nor (except - in multiline mode) a newline immediately before it. Setting this with- - out PCRE2_MULTILINE (at compile time) causes dollar never to match. - This option affects only the behaviour of the dollar metacharacter. It + of a line, so the dollar metacharacter should not match it nor (except + in multiline mode) a newline immediately before it. Setting this with- + out PCRE2_MULTILINE (at compile time) causes dollar never to match. + This option affects only the behaviour of the dollar metacharacter. It does not affect \Z or \z. PCRE2_NOTEMPTY An empty string is not considered to be a valid match if this option is - set. If there are alternatives in the pattern, they are tried. If all - the alternatives match the empty string, the entire match fails. For + set. If there are alternatives in the pattern, they are tried. If all + the alternatives match the empty string, the entire match fails. For example, if the pattern a?b? - is applied to a string not beginning with "a" or "b", it matches an + is applied to a string not beginning with "a" or "b", it matches an empty string at the start of the subject. With PCRE2_NOTEMPTY set, this - match is not valid, so PCRE2 searches further into the string for + match is not valid, so PCRE2 searches further into the string for occurrences of "a" or "b". PCRE2_NOTEMPTY_ATSTART - This is like PCRE2_NOTEMPTY, except that an empty string match that is - not at the start of the subject is permitted. If the pattern is + This is like PCRE2_NOTEMPTY, except that an empty string match that is + not at the start of the subject is permitted. If the pattern is anchored, such a match can occur only if the pattern contains \K. PCRE2_NO_UTF_CHECK When PCRE2_UTF is set at compile time, the validity of the subject as a - UTF string is checked by default when pcre2_match() is subsequently + UTF string is checked by default when pcre2_match() is subsequently called. The entire string is checked before any other processing takes - place, and a negative error code is returned if the check fails. There - are several UTF error codes for each code unit width, corresponding to - different problems with the code unit sequence. The value of startoff- + place, and a negative error code is returned if the check fails. There + are several UTF error codes for each code unit width, corresponding to + different problems with the code unit sequence. The value of startoff- set is also checked, to ensure that it points to the start of a charac- - ter or to the end of the subject. There are discussions about the - validity of UTF-8 strings, UTF-16 strings, and UTF-32 strings in the + ter or to the end of the subject. There are discussions about the + validity of UTF-8 strings, UTF-16 strings, and UTF-32 strings in the pcre2unicode page. - If you know that your subject is valid, and you want to skip these - checks for performance reasons, you can set the PCRE2_NO_UTF_CHECK - option when calling pcre2_match(). You might want to do this for the + If you know that your subject is valid, and you want to skip these + checks for performance reasons, you can set the PCRE2_NO_UTF_CHECK + option when calling pcre2_match(). You might want to do this for the second and subsequent calls to pcre2_match() if you are making repeated calls to find all the matches in a single subject string. - NOTE: When PCRE2_NO_UTF_CHECK is set, the effect of passing an invalid - string as a subject, or an invalid value of startoffset, is undefined. + NOTE: When PCRE2_NO_UTF_CHECK is set, the effect of passing an invalid + string as a subject, or an invalid value of startoffset, is undefined. Your program may crash or loop indefinitely. PCRE2_PARTIAL_HARD PCRE2_PARTIAL_SOFT - These options turn on the partial matching feature. A partial match - occurs if the end of the subject string is reached successfully, but - there are not enough subject characters to complete the match. If this - happens when PCRE2_PARTIAL_SOFT (but not PCRE2_PARTIAL_HARD) is set, - matching continues by testing any remaining alternatives. Only if no - complete match can be found is PCRE2_ERROR_PARTIAL returned instead of - PCRE2_ERROR_NOMATCH. In other words, PCRE2_PARTIAL_SOFT says that the - caller is prepared to handle a partial match, but only if no complete + These options turn on the partial matching feature. A partial match + occurs if the end of the subject string is reached successfully, but + there are not enough subject characters to complete the match. If this + happens when PCRE2_PARTIAL_SOFT (but not PCRE2_PARTIAL_HARD) is set, + matching continues by testing any remaining alternatives. Only if no + complete match can be found is PCRE2_ERROR_PARTIAL returned instead of + PCRE2_ERROR_NOMATCH. In other words, PCRE2_PARTIAL_SOFT says that the + caller is prepared to handle a partial match, but only if no complete match can be found. - If PCRE2_PARTIAL_HARD is set, it overrides PCRE2_PARTIAL_SOFT. In this - case, if a partial match is found, pcre2_match() immediately returns - PCRE2_ERROR_PARTIAL, without considering any other alternatives. In + If PCRE2_PARTIAL_HARD is set, it overrides PCRE2_PARTIAL_SOFT. In this + case, if a partial match is found, pcre2_match() immediately returns + PCRE2_ERROR_PARTIAL, without considering any other alternatives. In other words, when PCRE2_PARTIAL_HARD is set, a partial match is consid- ered to be more important that an alternative complete match. @@ -1912,36 +1909,36 @@ MATCHING A PATTERN: THE TRADITIONAL FUNCTION NEWLINE HANDLING WHEN MATCHING - When PCRE2 is built, a default newline convention is set; this is usu- - ally the standard convention for the operating system. The default can + When PCRE2 is built, a default newline convention is set; this is usu- + ally the standard convention for the operating system. The default can be overridden in either a compile context or a match context. However, - changing the newline convention at match time disables JIT matching. - During matching, the newline choice affects the behaviour of the dot, - circumflex, and dollar metacharacters. It may also alter the way the + changing the newline convention at match time disables JIT matching. + During matching, the newline choice affects the behaviour of the dot, + circumflex, and dollar metacharacters. It may also alter the way the match position is advanced after a match failure for an unanchored pat- tern. When PCRE2_NEWLINE_CRLF, PCRE2_NEWLINE_ANYCRLF, or PCRE2_NEWLINE_ANY is - set, and a match attempt for an unanchored pattern fails when the cur- - rent position is at a CRLF sequence, and the pattern contains no - explicit matches for CR or LF characters, the match position is + set, and a match attempt for an unanchored pattern fails when the cur- + rent position is at a CRLF sequence, and the pattern contains no + explicit matches for CR or LF characters, the match position is advanced by two characters instead of one, in other words, to after the CRLF. The above rule is a compromise that makes the most common cases work as - expected. For example, if the pattern is .+A (and the PCRE2_DOTALL + expected. For example, if the pattern is .+A (and the PCRE2_DOTALL option is not set), it does not match the string "\r\nA" because, after - failing at the start, it skips both the CR and the LF before retrying. - However, the pattern [\r\n]A does match that string, because it con- + failing at the start, it skips both the CR and the LF before retrying. + However, the pattern [\r\n]A does match that string, because it con- tains an explicit CR or LF reference, and so advances only by one char- acter after the first failure. An explicit match for CR of LF is either a literal appearance of one of - those characters in the pattern, or one of the \r or \n escape - sequences. Implicit matches such as [^X] do not count, nor does \s + those characters in the pattern, or one of the \r or \n escape + sequences. Implicit matches such as [^X] do not count, nor does \s (which includes CR and LF in the characters that it matches). - Notwithstanding the above, anomalous effects may still occur when CRLF + Notwithstanding the above, anomalous effects may still occur when CRLF is a valid newline sequence and explicit \r or \n escapes appear in the pattern. @@ -1952,73 +1949,73 @@ HOW PCRE2_MATCH() RETURNS A STRING AND CAPTURED SUBSTRINGS PCRE2_SIZE *pcre2_get_ovector_pointer(pcre2_match_data *match_data); - In general, a pattern matches a certain portion of the subject, and in - addition, further substrings from the subject may be picked out by - parenthesized parts of the pattern. Following the usage in Jeffrey - Friedl's book, this is called "capturing" in what follows, and the - phrase "capturing subpattern" is used for a fragment of a pattern that + In general, a pattern matches a certain portion of the subject, and in + addition, further substrings from the subject may be picked out by + parenthesized parts of the pattern. Following the usage in Jeffrey + Friedl's book, this is called "capturing" in what follows, and the + phrase "capturing subpattern" is used for a fragment of a pattern that picks out a substring. PCRE2 supports several other kinds of parenthe- - sized subpattern that do not cause substrings to be captured. The - pcre2_pattern_info() function can be used to find out how many captur- + sized subpattern that do not cause substrings to be captured. The + pcre2_pattern_info() function can be used to find out how many captur- ing subpatterns there are in a compiled pattern. - The overall matched string and any captured substrings are returned to - the caller via a vector of PCRE2_SIZE values, called the ovector. This + The overall matched string and any captured substrings are returned to + the caller via a vector of PCRE2_SIZE values, called the ovector. This is contained within the match data block. You can obtain direct access - to the ovector by calling pcre2_get_ovector_pointer() to find its - address, and pcre2_get_ovector_count() to find the number of pairs of - values it contains. Alternatively, you can use the auxiliary functions + to the ovector by calling pcre2_get_ovector_pointer() to find its + address, and pcre2_get_ovector_count() to find the number of pairs of + values it contains. Alternatively, you can use the auxiliary functions for accessing captured substrings by number or by name (see below). Within the ovector, the first in each pair of values is set to the off- set of the first code unit of a substring, and the second is set to the - offset of the first code unit after the end of a substring. These val- - ues are always code unit offsets, not character offsets. That is, they - are byte offsets in the 8-bit library, 16-bit offsets in the 16-bit + offset of the first code unit after the end of a substring. These val- + ues are always code unit offsets, not character offsets. That is, they + are byte offsets in the 8-bit library, 16-bit offsets in the 16-bit library, and 32-bit offsets in the 32-bit library. - The first pair of offsets (that is, ovector[0] and ovector[1]) identi- - fies the portion of the subject string that was matched by the entire - pattern. The next pair is used for the first capturing subpattern, and - so on. The value returned by pcre2_match() is one more than the high- - est numbered pair that has been set. For example, if two substrings - have been captured, the returned value is 3. If there are no capturing - subpatterns, the return value from a successful match is 1, indicating + The first pair of offsets (that is, ovector[0] and ovector[1]) identi- + fies the portion of the subject string that was matched by the entire + pattern. The next pair is used for the first capturing subpattern, and + so on. The value returned by pcre2_match() is one more than the high- + est numbered pair that has been set. For example, if two substrings + have been captured, the returned value is 3. If there are no capturing + subpatterns, the return value from a successful match is 1, indicating that just the first pair of offsets has been set. - If a capturing subpattern is matched repeatedly within a single match + If a capturing subpattern is matched repeatedly within a single match operation, it is the last portion of the string that it matched that is returned. If the ovector is too small to hold all the captured substring offsets, - as much as possible is filled in, and the function returns a value of - zero. If captured substrings are not of interest, pcre2_match() may be + as much as possible is filled in, and the function returns a value of + zero. If captured substrings are not of interest, pcre2_match() may be called with a match data block whose ovector is of minimum length (that is, one pair). However, if the pattern contains back references and the ovector is not big enough to remember the related substrings, PCRE2 has - to get additional memory for use during matching. Thus it is usually + to get additional memory for use during matching. Thus it is usually advisable to set up a match data block containing an ovector of reason- able size. - It is possible for capturing subpattern number n+1 to match some part + It is possible for capturing subpattern number n+1 to match some part of the subject when subpattern n has not been used at all. For example, - if the string "abc" is matched against the pattern (a|(z))(bc) the + if the string "abc" is matched against the pattern (a|(z))(bc) the return from the function is 4, and subpatterns 1 and 3 are matched, but - 2 is not. When this happens, both values in the offset pairs corre- + 2 is not. When this happens, both values in the offset pairs corre- sponding to unused subpatterns are set to PCRE2_UNSET. - Offset values that correspond to unused subpatterns at the end of the - expression are also set to PCRE2_UNSET. For example, if the string + Offset values that correspond to unused subpatterns at the end of the + expression are also set to PCRE2_UNSET. For example, if the string "abc" is matched against the pattern (abc)(x(yz)?)? subpatterns 2 and 3 - are not matched. The return from the function is 2, because the high- + are not matched. The return from the function is 2, because the high- est used capturing subpattern number is 1. The offsets for for the sec- - ond and third capturing subpatterns (assuming the vector is large + ond and third capturing subpatterns (assuming the vector is large enough, of course) are set to PCRE2_UNSET. Elements in the ovector that do not correspond to capturing parentheses in the pattern are never changed. That is, if a pattern contains n cap- turing parentheses, no more than ovector[0] to ovector[2n+1] are set by - pcre2_match(). The other elements retain whatever values they previ- + pcre2_match(). The other elements retain whatever values they previ- ously had. Other information about the match @@ -2027,29 +2024,29 @@ HOW PCRE2_MATCH() RETURNS A STRING AND CAPTURED SUBSTRINGS PCRE2_SIZE pcre2_get_startchar(pcre2_match_data *match_data); - In addition to the offsets in the ovector, other information about a - match is retained in the match data block and can be retrieved by the + In addition to the offsets in the ovector, other information about a + match is retained in the match data block and can be retrieved by the above functions. - When a (*MARK) name is to be passed back, pcre2_get_mark() returns a - pointer to the zero-terminated name, which is within the compiled pat- - tern. Otherwise NULL is returned. A (*MARK) name may be available - after a failed match or a partial match, as well as after a successful + When a (*MARK) name is to be passed back, pcre2_get_mark() returns a + pointer to the zero-terminated name, which is within the compiled pat- + tern. Otherwise NULL is returned. A (*MARK) name may be available + after a failed match or a partial match, as well as after a successful one. - The offset of the character at which the successful match started is - returned by pcre2_get_startchar(). This can be different to the value - of ovector[0] if the pattern contains the \K escape sequence. Note, + The offset of the character at which the successful match started is + returned by pcre2_get_startchar(). This can be different to the value + of ovector[0] if the pattern contains the \K escape sequence. Note, however, the \K has no effect for a partial match. Error return values from pcre2_match() - If pcre2_match() fails, it returns a negative number. This can be con- - verted to a text string by calling pcre2_get_error_message(). Negative - error codes are also returned by other functions, and are documented + If pcre2_match() fails, it returns a negative number. This can be con- + verted to a text string by calling pcre2_get_error_message(). Negative + error codes are also returned by other functions, and are documented with them. The codes are given names in the header file. If UTF check- ing is in force and an invalid UTF subject string is detected, one of a - number of UTF-specific negative error codes is returned. Details are + number of UTF-specific negative error codes is returned. Details are given in the pcre2unicode page. The following are the other errors that may be returned by pcre2_match(): @@ -2059,19 +2056,19 @@ HOW PCRE2_MATCH() RETURNS A STRING AND CAPTURED SUBSTRINGS PCRE2_ERROR_PARTIAL - The subject string did not match, but it did match partially. See the + The subject string did not match, but it did match partially. See the pcre2partial documentation for details of partial matching. PCRE2_ERROR_BADMAGIC PCRE2 stores a 4-byte "magic number" at the start of the compiled code, - to catch the case when it is passed a junk pointer. This is the error + to catch the case when it is passed a junk pointer. This is the error that is returned when the magic number is not present. PCRE2_ERROR_BADMODE - This error is given when a pattern that was compiled by the 8-bit - library is passed to a 16-bit or 32-bit library function, or vice + This error is given when a pattern that was compiled by the 8-bit + library is passed to a 16-bit or 32-bit library function, or vice versa. PCRE2_ERROR_BADOFFSET @@ -2085,35 +2082,35 @@ HOW PCRE2_MATCH() RETURNS A STRING AND CAPTURED SUBSTRINGS PCRE2_ERROR_BADUTFOFFSET The UTF code unit sequence that was passed as a subject was checked and - found to be valid (the PCRE2_NO_UTF_CHECK option was not set), but the - value of startoffset did not point to the beginning of a UTF character + found to be valid (the PCRE2_NO_UTF_CHECK option was not set), but the + value of startoffset did not point to the beginning of a UTF character or the end of the subject. PCRE2_ERROR_CALLOUT - This error is never generated by pcre2_match() itself. It is provided + This error is never generated by pcre2_match() itself. It is provided for use by callout functions that want to cause pcre2_match() to return - a distinctive error code. See the pcre2callout documentation for + a distinctive error code. See the pcre2callout documentation for details. PCRE2_ERROR_INTERNAL - An unexpected internal error has occurred. This error could be caused + An unexpected internal error has occurred. This error could be caused by a bug in PCRE2 or by overwriting of the compiled pattern. PCRE2_ERROR_JIT_BADOPTION - This error is returned when a pattern that was successfully studied - using JIT 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 + This error is returned when a pattern that was successfully studied + using JIT 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 pcre2jit documentation for more details. PCRE2_ERROR_JIT_STACKLIMIT - This error is returned when a pattern that was successfully studied - using JIT is being matched, but the memory available for the just-in- - time processing stack is not large enough. See the pcre2jit documenta- + This error is returned when a pattern that was successfully studied + using JIT is being matched, but the memory available for the just-in- + time processing stack is not large enough. See the pcre2jit documenta- tion for more details. PCRE2_ERROR_MATCHLIMIT @@ -2122,10 +2119,10 @@ HOW PCRE2_MATCH() RETURNS A STRING AND CAPTURED SUBSTRINGS PCRE2_ERROR_NOMEMORY - If a pattern contains back references, but the ovector is not big - enough to remember the referenced substrings, PCRE2 gets a block of + If a pattern contains back references, but the ovector is not big + enough to remember the referenced substrings, PCRE2 gets a block of memory at the start of matching to use for this purpose. There are some - other special cases where extra memory is needed during matching. This + other special cases where extra memory is needed during matching. This error is given when memory cannot be obtained. PCRE2_ERROR_NULL @@ -2134,12 +2131,12 @@ HOW PCRE2_MATCH() RETURNS A STRING AND CAPTURED SUBSTRINGS PCRE2_ERROR_RECURSELOOP - This error is returned when pcre2_match() detects a recursion loop - within the pattern. Specifically, it means that either the whole pat- + This error is returned when pcre2_match() detects a recursion loop + within the pattern. Specifically, it means that either the whole pat- tern or a subpattern has been called recursively for the second time at - the same position in the subject string. Some simple patterns that - might do this are detected and faulted at compile time, but more com- - plicated cases, in particular mutual recursions between two different + the same position in the subject string. Some simple patterns that + might do this are detected and faulted at compile time, but more com- + plicated cases, in particular mutual recursions between two different subpatterns, cannot be detected until run time. PCRE2_ERROR_RECURSIONLIMIT @@ -2162,52 +2159,52 @@ EXTRACTING CAPTURED SUBSTRINGS BY NUMBER void pcre2_substring_free(PCRE2_UCHAR *buffer); - Captured substrings can be accessed directly by using the ovector as + Captured substrings can be accessed directly by using the ovector as described above. For convenience, auxiliary functions are provided for - extracting captured substrings as new, separate, zero-terminated - strings. The functions in this section identify substrings by number. - The next section describes similar functions for extracting substrings + extracting captured substrings as new, separate, zero-terminated + strings. The functions in this section identify substrings by number. + The next section describes similar functions for extracting substrings by name. A substring that contains a binary zero is correctly extracted - and has a further zero added on the end, but the result is not, of + and has a further zero added on the end, but the result is not, of course, a C string. - You can find the length in code units of a captured substring without - extracting it by calling pcre2_substring_length_bynumber(). The first - argument is a pointer to the match data block, the second is the group - number, and the third is a pointer to a variable into which the length + You can find the length in code units of a captured substring without + extracting it by calling pcre2_substring_length_bynumber(). The first + argument is a pointer to the match data block, the second is the group + number, and the third is a pointer to a variable into which the length is placed. - The pcre2_substring_copy_bynumber() function copies one string into a - supplied buffer, whereas pcre2_substring_get_bynumber() copies it into + The pcre2_substring_copy_bynumber() function copies one string into a + supplied buffer, whereas pcre2_substring_get_bynumber() copies it into new memory, obtained using the same memory allocation function that was - used for the match data block. The first two arguments of these func- - tions are a pointer to the match data block and a capturing group num- - ber. A group number of zero extracts the substring that matched the + used for the match data block. The first two arguments of these func- + tions are a pointer to the match data block and a capturing group num- + ber. A group number of zero extracts the substring that matched the entire pattern, and higher values extract the captured substrings. The final arguments of pcre2_substring_copy_bynumber() are a pointer to the buffer and a pointer to a variable that contains its length in code - units. This is updated to contain the actual number of code units + units. This is updated to contain the actual number of code units used, excluding the terminating zero. For pcre2_substring_get_bynumber() the third and fourth arguments point - to variables that are updated with a pointer to the new memory and the - number of code units that comprise the substring, again excluding the - terminating zero. When the substring is no longer needed, the memory + to variables that are updated with a pointer to the new memory and the + number of code units that comprise the substring, again excluding the + terminating zero. When the substring is no longer needed, the memory should be freed by calling pcre2_substring_free(). - The return value from these functions is zero for success, or one of + The return value from these functions is zero for success, or one of these error codes: PCRE2_ERROR_NOMEMORY - The buffer was too small for pcre2_substring_copy_bynumber(), or the + The buffer was too small for pcre2_substring_copy_bynumber(), or the attempt to get memory failed for pcre2_substring_get_bynumber(). PCRE2_ERROR_NOSUBSTRING - No substring with the given number was captured. This could be because - there is no capturing group of that number in the pattern, or because + No substring with the given number was captured. This could be because + there is no capturing group of that number in the pattern, or because the group with that number did not participate in the match, or because the ovector was too small to capture that group. @@ -2219,28 +2216,28 @@ EXTRACTING A LIST OF ALL CAPTURED SUBSTRINGS void pcre2_substring_list_free(PCRE2_SPTR *list); - The pcre2_substring_list_get() function extracts all available sub- - strings and builds a list of pointers to them, and a second list that - contains their lengths (in code units), excluding a terminating zero - that is added to each of them. All this is done in a single block of - memory that is obtained using the same memory allocation function that + The pcre2_substring_list_get() function extracts all available sub- + strings and builds a list of pointers to them, and a second list that + contains their lengths (in code units), excluding a terminating zero + that is added to each of them. All this is done in a single block of + memory that is obtained using the same memory allocation function that was used to get the match data block. - The address of the memory block is returned via listptr, which is also + The address of the memory block is returned via listptr, which is also the start of the list of string pointers. The end of the list is marked - by a NULL pointer. The address of the list of lengths is returned via - lengthsptr. If your strings do not contain binary zeros and you do not + by a NULL pointer. The address of the list of lengths is returned via + lengthsptr. If your strings do not contain binary zeros and you do not therefore need the lengths, you may supply NULL as the lengthsptr argu- - ment to disable the creation of a list of lengths. The yield of the - function is zero if all went well, or PCRE2_ERROR_NOMEMORY if the mem- - ory block could not be obtained. When the list is no longer needed, it + ment to disable the creation of a list of lengths. The yield of the + function is zero if all went well, or PCRE2_ERROR_NOMEMORY if the mem- + ory block could not be obtained. When the list is no longer needed, it should be freed by calling pcre2_substring_list_free(). If this function encounters a substring that is unset, which can happen - when capturing subpattern number n+1 matches some part of the subject, - but subpattern n has not been used at all, it returns an empty string. - This can be distinguished from a genuine zero-length substring by - inspecting the appropriate offset in the ovector, which contains + when capturing subpattern number n+1 matches some part of the subject, + but subpattern n has not been used at all, it returns an empty string. + This can be distinguished from a genuine zero-length substring by + inspecting the appropriate offset in the ovector, which contains PCRE2_UNSET for unset substrings. @@ -2260,32 +2257,32 @@ EXTRACTING CAPTURED SUBSTRINGS BY NAME void pcre2_substring_free(PCRE2_UCHAR *buffer); - To extract a substring by name, you first have to find associated num- + To extract a substring by name, you first have to find associated num- ber. For example, for this pattern: (a+)b(?\d+)... the number of the subpattern called "xxx" is 2. If the name is known to - be unique (PCRE2_DUPNAMES was not set), you can find the number from + be unique (PCRE2_DUPNAMES was not set), you can find the number from the name by calling pcre2_substring_number_from_name(). The first argu- - ment is the compiled pattern, and the second is the name. The yield of - the function is the subpattern number, or PCRE2_ERROR_NOSUBSTRING if + ment is the compiled pattern, and the second is the name. The yield of + the function is the subpattern number, or PCRE2_ERROR_NOSUBSTRING if there is no subpattern of that name. Given the number, you can extract the substring directly, or use one of the functions described in the previous section. For convenience, there - are also "byname" functions that correspond to the "bynumber" func- - tions, the only difference being that the second argument is a name - instead of a number. However, if PCRE2_DUPNAMES is set and there are - duplicate names, the behaviour may not be what you want (see the next + are also "byname" functions that correspond to the "bynumber" func- + tions, the only difference being that the second argument is a name + instead of a number. However, if PCRE2_DUPNAMES is set and there are + duplicate names, the behaviour may not be what you want (see the next section). Warning: If the pattern uses the (?| feature to set up multiple subpat- - terns with the same number, as described in the section on duplicate - subpattern numbers in the pcre2pattern page, you cannot use names to - distinguish the different subpatterns, because names are not included - in the compiled code. The matching process uses only numbers. For this - reason, the use of different names for subpatterns of the same number + terns with the same number, as described in the section on duplicate + subpattern numbers in the pcre2pattern page, you cannot use names to + distinguish the different subpatterns, because names are not included + in the compiled code. The matching process uses only numbers. For this + reason, the use of different names for subpatterns of the same number causes an error at compile time. @@ -2294,54 +2291,54 @@ DUPLICATE SUBPATTERN NAMES int pcre2_substring_nametable_scan(const pcre2_code *code, PCRE2_SPTR name, PCRE2_SPTR *first, PCRE2_SPTR *last); - When a pattern is compiled with the PCRE2_DUPNAMES option, names for - subpatterns are not required to be unique. Duplicate names are always - allowed for subpatterns with the same number, created by using the (?| - feature. Indeed, if such subpatterns are named, they are required to + When a pattern is compiled with the PCRE2_DUPNAMES option, names for + subpatterns are not required to be unique. Duplicate names are always + allowed for subpatterns with the same number, created by using the (?| + feature. Indeed, if such subpatterns are named, they are required to use the same names. Normally, patterns with duplicate names are such that in any one match, - only one of the named subpatterns participates. An example is shown in + only one of the named subpatterns participates. An example is shown in the pcre2pattern documentation. - When duplicates are present, pcre2_substring_copy_byname() and - pcre2_substring_get_byname() return the first substring corresponding + When duplicates are present, pcre2_substring_copy_byname() and + pcre2_substring_get_byname() return the first substring corresponding to the given name that is set. If none are set, PCRE2_ERROR_NOSUBSTRING - is returned. The pcre2_substring_number_from_name() function returns - one of the numbers that are associated with the name, but it is not + is returned. The pcre2_substring_number_from_name() function returns + one of the numbers that are associated with the name, but it is not defined which it is. - If you want to get full details of all captured substrings for a given - name, you must use the pcre2_substring_nametable_scan() function. The - first argument is the compiled pattern, and the second is the name. If - the third and fourth arguments are NULL, the function returns a group + If you want to get full details of all captured substrings for a given + name, you must use the pcre2_substring_nametable_scan() function. The + first argument is the compiled pattern, and the second is the name. If + the third and fourth arguments are NULL, the function returns a group number (it is not defined which). Otherwise, the third and fourth argu- - ments must be pointers to variables that are updated by the function. + ments must be pointers to variables that are updated by the function. After it has run, they point to the first and last entries in the name- to-number table for the given name, and the function returns the length - of each entry. In both cases, PCRE2_ERROR_NOSUBSTRING is returned if + of each entry. In both cases, PCRE2_ERROR_NOSUBSTRING is returned if there are no entries for the given name. The format of the name table is described above in the section entitled - Information about a pattern above. Given all the relevant entries for + Information about a pattern above. Given all the relevant entries for the name, you can extract each of their numbers, and hence the captured data. FINDING ALL POSSIBLE MATCHES - The traditional matching function uses a similar algorithm to Perl, + The traditional matching function uses a similar algorithm to Perl, which stops when it finds the first match, starting at a given point in - the subject. If you want to find all possible matches, or the longest - possible match at a given position, consider using the alternative - matching function (see below) instead. If you cannot use the alterna- + the subject. If you want to find all possible matches, or the longest + possible match at a given position, consider using the alternative + matching function (see below) instead. If you cannot use the alterna- tive function, you can kludge it up by making use of the callout facil- ity, which is described in the pcre2callout documentation. What you have to do is to insert a callout right at the end of the pat- - tern. When your callout function is called, extract and save the cur- - rent matched substring. Then return 1, which forces pcre2_match() to - backtrack and try other alternatives. Ultimately, when it runs out of + tern. When your callout function is called, extract and save the cur- + rent matched substring. Then return 1, which forces pcre2_match() to + backtrack and try other alternatives. Ultimately, when it runs out of matches, pcre2_match() will yield PCRE2_ERROR_NOMATCH. @@ -2353,26 +2350,26 @@ MATCHING A PATTERN: THE ALTERNATIVE FUNCTION pcre2_match_context *mcontext, int *workspace, PCRE2_SIZE wscount); - The function pcre2_dfa_match() is called to match a subject string - against a compiled pattern, using a matching algorithm that scans the - subject string just once, and does not backtrack. This has different - characteristics to the normal algorithm, and is not compatible with - Perl. Some of the features of PCRE2 patterns are not supported. Never- - theless, there are times when this kind of matching can be useful. For - a discussion of the two matching algorithms, and a list of features + The function pcre2_dfa_match() is called to match a subject string + against a compiled pattern, using a matching algorithm that scans the + subject string just once, and does not backtrack. This has different + characteristics to the normal algorithm, and is not compatible with + Perl. Some of the features of PCRE2 patterns are not supported. Never- + theless, there are times when this kind of matching can be useful. For + a discussion of the two matching algorithms, and a list of features that pcre2_dfa_match() does not support, see the pcre2matching documen- tation. - The arguments for the pcre2_dfa_match() function are the same as for + The arguments for the pcre2_dfa_match() function are the same as for pcre2_match(), plus two extras. The ovector within the match data block is used in a different way, and this is described below. The other com- - mon arguments are used in the same way as for pcre2_match(), so their + mon arguments are used in the same way as for pcre2_match(), so their description is not repeated here. - The two additional arguments provide workspace for the function. The - workspace vector should contain at least 20 elements. It is used for + The two additional arguments provide workspace for the function. The + workspace vector should contain at least 20 elements. It is used for keeping track of multiple paths through the pattern tree. More - workspace is needed for patterns and subjects where there are a lot of + workspace is needed for patterns and subjects where there are a lot of potential matches. Here is an example of a simple call to pcre2_dfa_match(): @@ -2392,45 +2389,45 @@ MATCHING A PATTERN: THE ALTERNATIVE FUNCTION Option bits for pcre_dfa_match() - The unused bits of the options argument for pcre2_dfa_match() must be - zero. The only bits that may be set are PCRE2_ANCHORED, PCRE2_NOTBOL, + The unused bits of the options argument for pcre2_dfa_match() must be + zero. The only bits that may be set are PCRE2_ANCHORED, PCRE2_NOTBOL, PCRE2_NOTEOL, PCRE2_NOTEMPTY, PCRE2_NOTEMPTY_ATSTART, PCRE2_NO_UTF_CHECK, PCRE2_PARTIAL_HARD, PCRE2_PARTIAL_SOFT, - PCRE2_DFA_SHORTEST, and PCRE2_DFA_RESTART. All but the last four of - these are exactly the same as for pcre2_match(), so their description + PCRE2_DFA_SHORTEST, and PCRE2_DFA_RESTART. All but the last four of + these are exactly the same as for pcre2_match(), so their description is not repeated here. PCRE2_PARTIAL_HARD PCRE2_PARTIAL_SOFT - These have the same general effect as they do for pcre2_match(), but - the details are slightly different. When PCRE2_PARTIAL_HARD is set for - pcre2_dfa_match(), it returns PCRE2_ERROR_PARTIAL if the end of the + These have the same general effect as they do for pcre2_match(), but + the details are slightly different. When PCRE2_PARTIAL_HARD is set for + pcre2_dfa_match(), it returns PCRE2_ERROR_PARTIAL if the end of the subject is reached and there is still at least one matching possibility that requires additional characters. This happens even if some complete - matches have already been found. When PCRE2_PARTIAL_SOFT is set, the - return code PCRE2_ERROR_NOMATCH is converted into PCRE2_ERROR_PARTIAL - if the end of the subject is reached, there have been no complete + matches have already been found. When PCRE2_PARTIAL_SOFT is set, the + return code PCRE2_ERROR_NOMATCH is converted into PCRE2_ERROR_PARTIAL + if the end of the subject is reached, there have been no complete matches, but there is still at least one matching possibility. The por- - tion of the string that was inspected when the longest partial match + tion of the string that was inspected when the longest partial match was found is set as the first matching string in both cases. There is a - more detailed discussion of partial and multi-segment matching, with + more detailed discussion of partial and multi-segment matching, with examples, in the pcre2partial documentation. PCRE2_DFA_SHORTEST - Setting the PCRE2_DFA_SHORTEST option causes the matching algorithm to + Setting the PCRE2_DFA_SHORTEST option causes the matching algorithm to stop as soon as it has found one match. Because of the way the alterna- - tive algorithm works, this is necessarily the shortest possible match + tive algorithm works, this is necessarily the shortest possible match at the first possible matching point in the subject string. PCRE2_DFA_RESTART - When pcre2_dfa_match() returns a partial match, it is possible to call + When pcre2_dfa_match() returns a partial match, it is possible to call it again, with additional subject characters, and have it continue with the same match. The PCRE2_DFA_RESTART option requests this action; when - it is set, the workspace and wscount options must reference the same - vector as before because data about the match so far is left in them + it is set, the workspace and wscount options must reference the same + vector as before because data about the match so far is left in them after a partial match. There is more discussion of this facility in the pcre2partial documentation. @@ -2438,8 +2435,8 @@ MATCHING A PATTERN: THE ALTERNATIVE FUNCTION When pcre2_dfa_match() succeeds, it may have matched more than one sub- string in the subject. Note, however, that all the matches from one run - of the function start at the same point in the subject. The shorter - matches are all initial substrings of the longer matches. For example, + of the function start at the same point in the subject. The shorter + matches are all initial substrings of the longer matches. For example, if the pattern <.*> @@ -2454,66 +2451,66 @@ MATCHING A PATTERN: THE ALTERNATIVE FUNCTION - On success, the yield of the function is a number greater than zero, - which is the number of matched substrings. The offsets of the sub- - strings are returned in the ovector, and can be extracted in the same - way as for pcre2_match(). They are returned in reverse order of - length; that is, the longest matching string is given first. If there - were too many matches to fit into the ovector, the yield of the func- + On success, the yield of the function is a number greater than zero, + which is the number of matched substrings. The offsets of the sub- + strings are returned in the ovector, and can be extracted in the same + way as for pcre2_match(). They are returned in reverse order of + length; that is, the longest matching string is given first. If there + were too many matches to fit into the ovector, the yield of the func- tion is zero, and the vector is filled with the longest matches. - NOTE: PCRE2's "auto-possessification" optimization usually applies to - character repeats at the end of a pattern (as well as internally). For - example, the pattern "a\d+" is compiled as if it were "a\d++" because - there is no point in backtracking into the repeated digits. For DFA - matching, this means that only one possible match is found. If you - really do want multiple matches in such cases, either use an ungreedy - repeat ("a\d+?") or set the PCRE2_NO_AUTO_POSSESS option when compil- + NOTE: PCRE2's "auto-possessification" optimization usually applies to + character repeats at the end of a pattern (as well as internally). For + example, the pattern "a\d+" is compiled as if it were "a\d++" because + there is no point in backtracking into the repeated digits. For DFA + matching, this means that only one possible match is found. If you + really do want multiple matches in such cases, either use an ungreedy + repeat ("a\d+?") or set the PCRE2_NO_AUTO_POSSESS option when compil- ing. Error returns from pcre2_dfa_match() The pcre2_dfa_match() function returns a negative number when it fails. - Many of the errors are the same as for pcre2_match(), as described + Many of the errors are the same as for pcre2_match(), as described above. There are in addition the following errors that are specific to pcre2_dfa_match(): PCRE2_ERROR_DFA_UITEM - This return is given if pcre2_dfa_match() encounters an item in the + This return is given if pcre2_dfa_match() encounters an item in the pattern that it does not support, for instance, the use of \C or a back reference. PCRE2_ERROR_DFA_UCOND - This return is given if pcre2_dfa_match() encounters a condition item - that uses a back reference for the condition, or a test for recursion + This return is given if pcre2_dfa_match() encounters a condition item + that uses a back reference for the condition, or a test for recursion in a specific group. These are not supported. PCRE2_ERROR_DFA_WSSIZE - This return is given if pcre2_dfa_match() runs out of space in the + This return is given if pcre2_dfa_match() runs out of space in the workspace vector. PCRE2_ERROR_DFA_RECURSE - When a recursive subpattern is processed, the matching function calls + When a recursive subpattern is processed, the matching function calls itself recursively, using private memory for the ovector and workspace. - This error is given if the internal ovector is not large enough. This + This error is given if the internal ovector is not large enough. This should be extremely rare, as a vector of size 1000 is used. PCRE2_ERROR_DFA_BADRESTART - When pcre2_dfa_match() is called with the pcre2_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 + When pcre2_dfa_match() is called with the pcre2_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. SEE ALSO - pcre2build(3), pcre2libs(3), pcre2callout(3), pcre2matching(3), - pcre2partial(3), pcre2posix(3), pcre2demo(3), pcre2sample(3), + pcre2build(3), pcre2libs(3), pcre2callout(3), pcre2matching(3), + pcre2partial(3), pcre2posix(3), pcre2demo(3), pcre2sample(3), pcre2stack(3). @@ -3465,7 +3462,9 @@ SIMPLE USE OF JIT second is a set of option bits, which must include at least one of PCRE2_JIT_COMPLETE, PCRE2_JIT_PARTIAL_HARD, or PCRE2_JIT_PARTIAL_SOFT. - The returned value from pcre2_jit_compile() is FIXME FIXME. + The returned value from pcre2_jit_compile() is zero on success, or a + negative error code. In particular, PCRE2_ERROR_JIT_BADOPTION is + returned if JIT is not supported or if an unknown options bit is set. PCRE2_JIT_COMPLETE requests the JIT compiler to generate code for com- plete matches. If you want to run partial matches using the PCRE2_PAR- @@ -3726,18 +3725,21 @@ JIT FAST PATH API The fast path function is called pcre2_jit_match(), and it takes exactly the same arguments as pcre2_match(), plus one additional argu- - ment that must point to a JIT stack. The JIT stack arrangements - described above do not apply. The return values are the same as for - pcre2_match(). + ment that must either point to a JIT stack or be NULL. In the latter + case, if a callback function has been set up by + pcre2_jit_stack_alloc(), it is called. Otherwise the system stack is + used. The return values are the same as for pcre2_match(), plus + PCRE2_ERROR_JIT_BADOPTION if a matching mode (partial or complete) is + requested that was not compiled. Unsupported option bits are ignored. - When you call pcre2_match(), as well as testing for invalid options, a + When you call pcre2_match(), as well as testing for invalid options, a number of other sanity checks are performed on the arguments. For exam- ple, if the subject pointer is NULL, an immediate error is given. Also, - unless PCRE2_NO_UTF_CHECK is set, a UTF subject string is tested for - validity. In the interests of speed, these checks do not happen on the + unless PCRE2_NO_UTF_CHECK is set, a UTF subject string is tested for + validity. In the interests of speed, these checks do not happen on the JIT fast path, and if invalid data is passed, the result is undefined. - Bypassing the sanity checks and the pcre2_match() wrapping can give + Bypassing the sanity checks and the pcre2_match() wrapping can give speedups of more than 10%. @@ -3755,7 +3757,7 @@ AUTHOR REVISION - Last updated: 29 September 2014 + Last updated: 21 October 2014 Copyright (c) 1997-2014 University of Cambridge. ------------------------------------------------------------------------------ diff --git a/doc/pcre2_code_free.3 b/doc/pcre2_code_free.3 new file mode 100644 index 0000000..3a1c7d8 --- /dev/null +++ b/doc/pcre2_code_free.3 @@ -0,0 +1,27 @@ +.TH PCRE2_CODE_FREE 3 "21 October 2014" "PCRE2 10.00" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B pcre2_code_free(pcre2_code *\fIcode\fP); +.fi +. +.SH DESCRIPTION +.rs +.sp +This function frees the memory used for a compiled pattern, including any +memory used by the JIT compiler. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/doc/pcre2_compile.3 b/doc/pcre2_compile.3 new file mode 100644 index 0000000..6040420 --- /dev/null +++ b/doc/pcre2_compile.3 @@ -0,0 +1,75 @@ +.TH PCRE2_COMPILE 3 "21 October 2014" "PCRE2 10.00" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B pcre2_code *pcre2_compile(PCRE2_SPTR \fIpattern\fP, PCRE2_SIZE \fIlength\fP, +.B " uint32_t \fIoptions\fP, int *\fIerrorcode\fP, PCRE2_SIZE *\fIerroroffset,\fP" +.B " pcre2_compile_context *\fIccontext\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function compiles a regular expression pattern into an internal form. Its +arguments are: +.sp + \fIpattern\fP A string containing expression to be compiled + \fIlength\fP The length of the string or PCRE2_ZERO_TERMINATED + \fIoptions\fP Option bits + \fIerrorcode\fP Where to put an error code + \fIerroffset\fP Where to put an error offset + \fIccontext\fP Pointer to a compile context or NULL +.sp +The length of the string and any error offset that is returned are in code +units, not characters. A compile context is needed only if you want to change +.sp + What \eR matches (Unicode newlines or CR, LF, CRLF only) + PCRE2's character tables + The newline character sequence + The compile time nested parentheses limit +.sp +or provide an external function for stack size checking. The option bits are: +.sp + PCRE2_ANCHORED Force pattern anchoring + PCRE2_ALT_BSUX Alternative handling of \eu, \eU, and \ex + PCRE2_AUTO_CALLOUT Compile automatic callouts + PCRE2_CASELESS Do caseless matching + PCRE2_DOLLAR_ENDONLY $ not to match newline at end + PCRE2_DOTALL . matches anything including NL + PCRE2_DUPNAMES Allow duplicate names for subpatterns + PCRE2_EXTENDED Ignore white space and # comments + PCRE2_FIRSTLINE Force matching to be before newline + PCRE2_MATCH_UNSET_BACKREF Match unset back references + PCRE2_MULTILINE ^ and $ match newlines within data + PCRE2_NEVER_UCP Lock out PCRE2_UCP, e.g. via (*UCP) + PCRE2_NEVER_UTF Lock out PCRE2_UTF, e.g. via (*UTF) + PCRE2_NO_AUTO_CAPTURE Disable numbered capturing paren- + theses (named ones available) + PCRE2_NO_AUTO_POSSESS Disable auto-possessification + PCRE2_NO_START_OPTIMIZE Disable match-time start optimizations + PCRE2_NO_UTF_CHECK Do not check the pattern for UTF validity + (only relevant if PCRE2_UTF is set) + PCRE2_UCP Use Unicode properties for \ed, \ew, etc. + PCRE2_UNGREEDY Invert greediness of quantifiers + PCRE2_UTF Treat pattern and subjects as UTF strings +.sp +PCRE2 must be built with Unicode support in order to use PCRE2_UTF, PCRE2_UCP +and related options. +.P +The yield of the function is a pointer to a private data structure that +contains the compiled pattern, or NULL if an error was detected. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/doc/pcre2_config.3 b/doc/pcre2_config.3 new file mode 100644 index 0000000..de48e58 --- /dev/null +++ b/doc/pcre2_config.3 @@ -0,0 +1,71 @@ +.TH PCRE2_CONFIG 3 "20 April 2014" "PCRE2 10.0" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.SM +.B int pcre2_config(uint32_t \fIwhat\fP, void *\fIwhere\fP); +. +.SH DESCRIPTION +.rs +.sp +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: +.sp + \fIwhat\fP A code specifying what information is required + \fIwhere\fP Points to where to put the information +.sp +If \fIwhere\fP is NULL, the function returns the amount of memory needed for +the requested information. When the information is a string, the value is in +code units; for other types of data it is in bytes. +.P +If \fBwhere\fP is not NULL, for PCRE2_CONFIG_JITTARGET, +PCRE2_CONFIG_UNICODE_VERSION, and PCRE2_CONFIG_VERSION it must point to a +buffer that is large enough to hold the string. For PCRE2_CONFIG_MATCHLIMIT, +PCRE2_CONFIG_PARENSLIMIT, and PCRE2_CONFIG_RECURSIONLIMIT it must point to an +unsigned long int variable, and for all other codes to an int variable. The +available codes are: +.sp + PCRE2_CONFIG_BSR Indicates what \eR matches by default: + 0 all Unicode line endings + 1 CR, LF, or CRLF only + PCRE2_CONFIG_JIT Availability of just-in-time compiler + support (1=yes 0=no) + PCRE2_CONFIG_JITTARGET Information about the target archi- + tecture for the JIT compiler + PCRE2_CONFIG_LINKSIZE Configured internal link size (2, 3, 4) + PCRE2_CONFIG_MATCHLIMIT Default internal resource limit + PCRE2_CONFIG_NEWLINE Code for the default newline sequence: + 1 for CR + 2 for LF + 3 for CRLF + 4 for ANY + 5 for ANYCRLF + PCRE2_CONFIG_PARENSLIMIT Default parentheses nesting limit + PCRE2_CONFIG_RECURSIONLIMIT Internal recursion depth limit + PCRE2_CONFIG_STACKRECURSE Recursion implementation (1=stack + 0=heap) + PCRE2_CONFIG_UNICODE Availability of Unicode support (1=yes + 0=no) + PCRE2_CONFIG_UNICODE_VERSION The Unicode version (a string) + PCRE2_CONFIG_VERSION The PCRE2 version (a string) +.sp +The function yields a non-negative value on success or the negative value +PCRE2_ERROR_BADOPTION otherwise. This is also the result for the +PCRE2_CONFIG_JITTARGET code if JIT support is not available. When a string +is returned the yield is the length of the string, in code units, excluding the +terminating zero. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/doc/pcre2_dfa_match.3 b/doc/pcre2_dfa_match.3 new file mode 100644 index 0000000..f45da0d --- /dev/null +++ b/doc/pcre2_dfa_match.3 @@ -0,0 +1,72 @@ +.TH PCRE2_DFA_MATCH 3 "12 May 2013" "PCRE2 10.00" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_dfa_match(const pcre2_code *\fIcode\fP, PCRE2_SPTR \fIsubject\fP, +.B " PCRE2_SIZE \fIlength\fP, PCRE2_SIZE \fIstartoffset\fP," +.B " uint32_t \fIoptions\fP, pcre2_match_data *\fImatch_data\fP," +.B " pcre2_match_context *\fImcontext\fP," +.B " int *\fIworkspace\fP, PCRE2_SIZE \fIwscount\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function matches a compiled regular expression against a given subject +string, using an alternative matching algorithm that scans the subject string +just once (\fInot\fP Perl-compatible). (The Perl-compatible matching function +is \fBpcre2_match()\fP.) The arguments for this function are: +.sp + \fIcode\fP Points to the compiled pattern + \fIsubject\fP Points to the subject string + \fIlength\fP Length of the subject string + \fIstartoffset\fP Offset in the subject at which to start matching + \fIoptions\fP Option bits + \fImatch_data\fP Points to a match data block, for results + \fImcontext\fP Points to a match context, or is NULL + \fIworkspace\fP Points to a vector of ints used as working space + \fIwscount\fP Number of elements in the vector +.sp +For \fBpcre2_dfa_match()\fP, a match context is needed only if you want to set +up a callout function. The \fIlength\fP and \fIstartoffset\fP values are code +units, not characters. The options are: +.sp + PCRE2_ANCHORED Match only at the first position + PCRE2_NOTBOL Subject is not the beginning of a line + PCRE2_NOTEOL Subject is not the end of a line + PCRE2_NOTEMPTY An empty string is not a valid match + PCRE2_NOTEMPTY_ATSTART An empty string at the start of the subject + is not a valid match + PCRE2_NO_UTF_CHECK Do not check the subject for UTF + validity (only relevant if PCRE2_UTF + was set at compile time) + PCRE2_PARTIAL_SOFT Return PCRE2_ERROR_PARTIAL for a partial + match if no full matches are found + PCRE2_PARTIAL_HARD Return PCRE2_ERROR_PARTIAL for a partial match + even if there is a full match as well + PCRE2_DFA_RESTART Restart after a partial match + PCRE2_DFA_SHORTEST Return only the shortest match +.sp +There are restrictions on what may appear in a pattern when using this matching +function. Details are given in the +.\" HREF +\fBpcre2matching\fP +.\" +documentation. For details of partial matching, see the +.\" HREF +\fBpcre2partial\fP +.\" +page. There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/doc/pcre2_get_error_message.3 b/doc/pcre2_get_error_message.3 new file mode 100644 index 0000000..9ff5342 --- /dev/null +++ b/doc/pcre2_get_error_message.3 @@ -0,0 +1,36 @@ +.TH PCRE2_GET_ERROR_MESSAGE 3 "21 October 2014" "PCRE2 10.00" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_get_error_message(int \fIerrorcode\fP, PCRE2_UCHAR *\fIbuffer\fP, +.B " PCRE2_SIZE \fIbufflen\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +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: +.sp + \fIerrorcode\fP an error code (positive or negative) + \fIbuffer\fP where to put the message + \fIbufflen\fP the length of the buffer (code units) +.sp +The function returns the length of the message, excluding the trailing zero, or +a negative error code if the buffer is too small. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/doc/pcre2_jit_compile.3 b/doc/pcre2_jit_compile.3 new file mode 100644 index 0000000..a11d949 --- /dev/null +++ b/doc/pcre2_jit_compile.3 @@ -0,0 +1,45 @@ +.TH PCRE2_JIT_COMPILE 3 "21 October 2014" "PCRE2 10.00" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_jit_compile(pcre2_code *\fIcode\fP, uint32_t \fIoptions\fP); +.fi +. +.SH DESCRIPTION +.rs +.sp +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 \fBpcre2_match()\fP interpretive matching function. Full +details are given in the +.\" HREF +\fBpcre2jit\fP +.\" +documentation. +.P +The first argument is a pointer that was returned by a successful call to +\fBpcre2_compile()\fP, and the second must contain one or more of the following +bits: +.sp + PCRE2_JIT_COMPLETE compile code for full matching + PCRE2_JIT_PARTIAL_SOFT compile code for soft partial matching + PCRE2_JIT_PARTIAL_HARD compile code for hard partial matching +.sp +The yield of the function is 0 for success, or a negative error code otherwise. +In particular, PCRE2_ERROR_JIT_BADOPTION is returned if JIT is not supported or +if an unknown bit is set in \fIoptions\fP. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/doc/pcre2_jit_match.3 b/doc/pcre2_jit_match.3 new file mode 100644 index 0000000..09c5d42 --- /dev/null +++ b/doc/pcre2_jit_match.3 @@ -0,0 +1,52 @@ +.TH PCRE2_JIT_MATCH 3 "21 October 2014" "PCRE2 10.0" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_jit_match(const pcre2_code *\fIcode\fP, PCRE2_SPTR \fIsubject\fP, +.B " PCRE2_SIZE \fIlength\fP, PCRE2_SIZE \fIstartoffset\fP," +.B " uint32_t \fIoptions\fP, pcre2_match_data *\fImatch_data\fP," +.B " pcre2_match_context *\fImcontext\fP, pcre2_jit_stack *\fIjit_stack\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +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 to Perl's. It is a "fast path" interface to JIT, and +it bypasses some of the sanity checks that \fBpcre2_match()\fP applies. +Its arguments are exactly the same as for +.\" HREF +\fBpcre2_match()\fP +.\" +plus one additional argument that must either point to a JIT stack or be NULL. +In the latter case, if a callback function has been set up by +\fBpcre2_jit_stack_alloc()\fP, it is called. Otherwise the system stack is +used. +.P +The supported options are PCRE2_NOTBOL, PCRE2_NOTEOL, PCRE2_NOTEMPTY, +PCRE2_NOTEMPTY_ATSTART, PCRE2_PARTIAL_HARD, and PCRE2_PARTIAL_SOFT. Unsupported +options are ignored. The subject string is not checked for UTF validity. +.P +The return values are the same as for \fBpcre2_match()\fP plus +PCRE2_ERROR_JIT_BADOPTION if a matching mode (partial or complete) is requested +that was not compiled. For details of partial matching, see the +.\" HREF +\fBpcre2partial\fP +.\" +page. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the JIT API in the +.\" HREF +\fBpcre2jit\fP +.\" +page. diff --git a/doc/pcre2_jit_stack_alloc.3 b/doc/pcre2_jit_stack_alloc.3 new file mode 100644 index 0000000..dc35dea --- /dev/null +++ b/doc/pcre2_jit_stack_alloc.3 @@ -0,0 +1,40 @@ +.TH PCRE2_JIT_STACK_ALLOC 3 "21 October 2014" "PCRE2 10.00" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B pcre2_jit_stack *pcre2_jit_stack_alloc(pcre2_general_context *\fIgcontext\fP, +.B " PCRE2_SIZE \fIstartsize\fP, PCRE2_SIZE \fImaxsize\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function is used to create a stack for use by the code compiled by the JIT +compiler. The first argument is a general context, for memory allocation +functions, or NULL for standard memory allocation. The remaining arguments are +a starting size for the stack, and a maximum size to which it is allowed to +grow. The result can be passed to the JIT run-time code by calling +\fBpcre2_jit_stack_assign()\fP to associate the stack with a compiled pattern, +which can then be processed by \fBpcre2_match()\fP. If the "fast path" JIT +matcher, \fBpcre2_jit_match()\fP is used, the stack can be passed directly as +an argument. A maximum stack size of 512K to 1M should be more than enough for +any pattern. For more details, see the +.\" HREF +\fBpcre2jit\fP +.\" +page. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/doc/pcre2_jit_stack_assign.3 b/doc/pcre2_jit_stack_assign.3 new file mode 100644 index 0000000..0a3e1b8 --- /dev/null +++ b/doc/pcre2_jit_stack_assign.3 @@ -0,0 +1,53 @@ +.TH PCRE2_JIT_STACK_ASSIGN 3 "21 October 2014" "PCRE2 10.0" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B void pcre2_jit_stack_assign(const pcre2_code *\fIcode\fP, +.B " pcre2_jit_callback \fIcallback_function\fP, void *\fIcallback_data\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function provides control over the memory used as a stack at run-time by a +call to \fBpcre2_match()\fP or \fBpcre2_jit_match()\fP with a pattern that has +been successfully processed by the JIT compiler. The arguments are: +.sp + code the pointer returned by \fBpcre2_compile()\fP + callback a callback function + callback_data a JIT stack or a value to be passed to the callback +.P +If \fIcallback\fP is NULL and \fIcallback_data\fP is NULL, an internal 32K +block on the machine stack is used. +.P +If \fIcallback\fP is NULL and \fIcallback_data\fP is not NULL, +\fIcallback_data\fP must be a valid JIT stack, the result of calling +\fBpcre2_jit_stack_alloc()\fP. +.P +If \fIcallback\fP not NULL, it is called with \fIcallback_data\fP as an +argument at the start of matching, in order to set up a JIT stack. If the +result is NULL, the internal 32K stack is used; otherwise the return value must +be a valid JIT stack, the result of calling \fBpcre2_jit_stack_alloc()\fP. +.P +You may safely assign the same JIT stack to multiple patterns, as long as they +are all matched in the same thread. In a multithread application, each thread +must use its own JIT stack. For more details, see the +.\" HREF +\fBpcre2jit\fP +.\" +page. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/doc/pcre2_jit_stack_free.3 b/doc/pcre2_jit_stack_free.3 new file mode 100644 index 0000000..4e4a61d --- /dev/null +++ b/doc/pcre2_jit_stack_free.3 @@ -0,0 +1,31 @@ +.TH PCRE2_JIT_STACK_FREE 3 "21 October 2014" "PCRE2 10.00" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.SM +.B void pcre2_jit_stack_free(pcre2_jit_stack *\fIjit_stack\fP); +. +.SH DESCRIPTION +.rs +.sp +This function is used to free a JIT stack that was created by +\fBpcre2_jit_stack_alloc()\fP when it is no longer needed. For more details, +see the +.\" HREF +\fBpcre2jit\fP +.\" +page. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/doc/pcre2_maketables.3 b/doc/pcre2_maketables.3 new file mode 100644 index 0000000..322dba7 --- /dev/null +++ b/doc/pcre2_maketables.3 @@ -0,0 +1,36 @@ +.TH PCRE2_MAKETABLES 3 "21 October 2014" "PCRE2 10.00" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.SM +.B const unsigned char *pcre2_maketables(pcre22_general_context *\fIgcontext\fP); +. +.SH DESCRIPTION +.rs +.sp +This function builds a set of character tables for character values less than +256. These can be passed to \fBpcre2_compile()\fP in a compile context in order +to override the internal, built-in tables (which were either defaulted or made +by \fBpcre2_maketables()\fP when PCRE2 was compiled). See the +.\" HREF +\fBpcre2_set_character_tables()\fP +.\" +page. You might want to do this if you are using a non-standard locale. +.P +If the argument is NULL, \fBmalloc()\fP is used to get memory for the tables. +Otherwise it must point to a general context, which can supply pointers to a +custom memory manager. The function yields a pointer to the tables. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/doc/pcre2_match.3 b/doc/pcre2_match.3 new file mode 100644 index 0000000..f25cace --- /dev/null +++ b/doc/pcre2_match.3 @@ -0,0 +1,67 @@ +.TH PCRE2_MATCH 3 "21 October 2014" "PCRE2 10.00" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_match(const pcre2_code *\fIcode\fP, PCRE2_SPTR \fIsubject\fP, +.B " PCRE2_SIZE \fIlength\fP, PCRE2_SIZE \fIstartoffset\fP," +.B " uint32_t \fIoptions\fP, pcre2_match_data *\fImatch_data\fP," +.B " pcre2_match_context *\fImcontext\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +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 captured substrings. Its arguments are: +.sp + \fIcode\fP Points to the compiled pattern + \fIsubject\fP Points to the subject string + \fIlength\fP Length of the subject string + \fIstartoffset\fP Offset in the subject at which to start matching + \fIoptions\fP Option bits + \fImatch_data\fP Points to a match data block, for results + \fImcontext\fP Points to a match context, or is NULL +.sp +A match context is needed only if you want to: +.sp + Set up a callout function + Change the limit for calling the internal function \fImatch()\fP + Change the limit for calling \fImatch()\fP recursively + Set custom memory management when the heap is used for recursion +.sp +The \fIlength\fP and \fIstartoffset\fP values are code +units, not characters. The options are: +.sp + PCRE2_ANCHORED Match only at the first position + PCRE2_NOTBOL Subject string is not the beginning of a line + PCRE2_NOTEOL Subject string is not the end of a line + PCRE2_NOTEMPTY An empty string is not a valid match + PCRE2_NOTEMPTY_ATSTART An empty string at the start of the subject + is not a valid match + PCRE2_NO_UTF_CHECK Do not check the subject for UTF + validity (only relevant if PCRE2_UTF + was set at compile time) + PCRE2_PARTIAL_SOFT Return PCRE2_ERROR_PARTIAL for a partial + match if no full matches are found + PCRE2_PARTIAL_HARD Return PCRE2_ERROR_PARTIAL for a partial match + if that is found before a full match +.sp +For details of partial matching, see the +.\" HREF +\fBpcre2partial\fP +.\" +page. There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/doc/pcre2_pattern_info.3 b/doc/pcre2_pattern_info.3 new file mode 100644 index 0000000..5056cc0 --- /dev/null +++ b/doc/pcre2_pattern_info.3 @@ -0,0 +1,90 @@ +.TH PCRE2_PATTERN_INFO 3 "21 October 2014" "PCRE2 10.00" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_pattern_info(const pcre2 *\fIcode\fP, uint32_t \fIwhat\fP, void *\fIwhere\fP); +.fi +. +.SH DESCRIPTION +.rs +.sp +This function returns information about a compiled pattern. Its arguments are: +.sp + \fIcode\fP Compiled regular expression + \fIwhat\fP What information is required + \fIwhere\fP Where to put the information +.sp +If \fIwhere\fP is NULL, the function returns the amount of memory needed for +the requested information, in bytes. The following information is available: +.sp + PCRE2_INFO_ALLOPTIONS Final options after compiling + PCRE2_INFO_ARGOPTIONS Options passed to \fBpcre2_compile()\fP + PCRE2_INFO_BACKREFMAX Number of highest back reference + PCRE2_INFO_BSR What \eR matches + 0 all Unicode line endings + 1 CR, LF, or CRLF only + PCRE2_INFO_CAPTURECOUNT Number of capturing subpatterns + PCRE2_INFO_FIRSTBITMAP Bitmap of first code units, or NULL + PCRE2_INFO_FIRSTCODEUNIT First code unit when type is 1 + PCRE2_INFO_FIRSTCODETYPE Type of start-of-match information + 0 nothing set + 1 first code unit is set + 2 start of string or after newline + PCRE2_INFO_HASCRORLF Return 1 if explicit CR or LF matches + exist in the pattern + PCRE2_INFO_JCHANGED Return 1 if (?J) or (?-J) was used + PCRE2_INFO_JITSIZE Size of JIT compiled code, or 0 + PCRE2_INFO_LASTCODEUNIT Last code unit when type is 1 + PCRE2_INFO_LASTCODETYPE Type of must-be-present information + 0 nothing set + 1 code unit is set + PCRE2_INFO_MATCHEMPTY 1 if the pattern can match an + empty string, 0 otherwise + PCRE2_INFO_MATCHLIMIT Match limit if set, + otherwise PCRE2_RROR_UNSET + PCRE2_INFO_MAXLOOKBEHIND Length (in characters) of the longest + lookbehind assertion + PCRE2_INFO_MINLENGTH Lower bound length of matching strings + PCRE2_INFO_NAMEENTRYSIZE Size of name table entries + PCRE2_INFO_NAMECOUNT Number of named subpatterns + PCRE2_INFO_NAMETABLE Pointer to name table + PCRE2_CONFIG_NEWLINE Code for the newline sequence: + 1 for CR + 2 for LF + 3 for CRLF + 4 for ANY + 5 for ANYCRLF + PCRE2_INFO_RECURSIONLIMIT Recursion limit if set, + otherwise PCRE2_ERROR_UNSET + PCRE2_INFO_SIZE Size of compiled pattern +.sp +The \fIwhere\fP argument must point to an unsigned 32-bit integer (uint32_t +variable), except for the following \fIwhat\fP values: +.sp + PCRE2_INFO_FIRSTBITMAP const uint8_t + PCRE2_INFO_JITSIZE size_t + PCRE2_INFO_NAMETABLE PCRE2_SPTR + PCRE2_INFO_SIZE size_t +.sp +The yield of the function is zero on success or: +.sp + PCRE2_ERROR_NULL the argument \fIcode\fP is NULL + PCRE2_ERROR_BADMAGIC the "magic number" was not found + PCRE2_ERROR_BADOPTION the value of \fIwhat\fP is invalid + PCRE2_ERROR_BADMODE the pattern was compiled in the wrong mode + PCRE2_ERROR_UNSET the requested information is not set +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/doc/pcre2_substring_copy_byname.3 b/doc/pcre2_substring_copy_byname.3 new file mode 100644 index 0000000..84d5517 --- /dev/null +++ b/doc/pcre2_substring_copy_byname.3 @@ -0,0 +1,38 @@ +.TH PCRE2_SUBSTRING_COPY_BYNAME 3 "21 October 2014" "PCRE2 10.00" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_substring_copy_byname(pcre2_match_data *\fImatch_data\fP, +.B " PCRE2_SPTR \fIname\fP, PCRE2_UCHAR *\fIbuffer\fP, PCRE2_SIZE *\fIbufflen\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This is a convenience function for extracting a captured substring, identified +by name, into a given buffer. The arguments are: +.sp + \fImatch_data\fP The match data block for the match + \fIname\fP Name of the required substring + \fIbuffer\fP Buffer to receive the string + \fIbufflen\fP Length of buffer (code units) +.sp +The \fIbufflen\fP variable is updated to contain the length of the extracted +string, excluding the trailing zero. The yield of the function is zero for +success, PCRE2_ERROR_NOMEMORY if the buffer is too small, or +PCRE2_ERROR_NOSUBSTRING if the string name is invalid. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/doc/pcre2_substring_copy_bynumber.3 b/doc/pcre2_substring_copy_bynumber.3 new file mode 100644 index 0000000..5b4a262 --- /dev/null +++ b/doc/pcre2_substring_copy_bynumber.3 @@ -0,0 +1,39 @@ +.TH PCRE2_SUBSTRING_COPY_BYNUMBER 3 "21 October 2014" "PCRE2 10.00" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_substring_copy_bynumber(pcre2_match_data *\fImatch_data\fP, +.B " unsigned int \fInumber\fP, PCRE2_UCHAR *\fIbuffer\fP," +.B " PCRE2_SIZE *\fIbufflen\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This is a convenience function for extracting a captured substring into a given +buffer. The arguments are: +.sp + \fImatch_data\fP The match data block for the match + \fInumber\fP Number of the required substring + \fIbuffer\fP Buffer to receive the string + \fIbufflen\fP Length of buffer +.sp +The \fIbufflen\fP variable is updated with the length of the extracted string, +excluding the terminating zero. The yield of the function is zero for success, +PCRE2_ERROR_NOMEMORY if the buffer was too small, or PCRE2_ERROR_NOSUBSTRING if +the string number is invalid. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/doc/pcre2_substring_free.3 b/doc/pcre2_substring_free.3 new file mode 100644 index 0000000..ca94e78 --- /dev/null +++ b/doc/pcre2_substring_free.3 @@ -0,0 +1,28 @@ +.TH PCRE2_SUBSTRING_FREE 3 "21 October 2014" "PCRE2 10.00" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.SM +.B void pcre2_substring_free(PCRE2_UCHAR *\fIbuffer\fP); +. +.SH DESCRIPTION +.rs +.sp +This is a convenience function for freeing the memory obtained by a previous +call to \fBpcre2_substring_get_byname()\fP or +\fBpcre2_substring_get_bynumber()\fP. Its only argument is a pointer to the +string. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/doc/pcre2_substring_get_byname.3 b/doc/pcre2_substring_get_byname.3 new file mode 100644 index 0000000..5a56944 --- /dev/null +++ b/doc/pcre2_substring_get_byname.3 @@ -0,0 +1,40 @@ +.TH PCRE2_SUBSTRING_GET_BYNAME 3 "21 October 2014" "PCRE2 10.00" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_substring_get_byname(pcre2_match_data *\fImatch_data\fP, +.B " PCRE2_SPTR \fIname\fP, PCRE2_UCHAR **\fIbufferptr\fP, PCRE2_SIZE *\fIbufflen\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This is a convenience function for extracting a captured substring by name into +newly acquired memory. The arguments are: +.sp + \fImatch_data\fP The match data for the match + \fIname\fP Name of the required substring + \fIbufferptr\fP Where to put the string pointer + \fIbufflen\fP Where to put the string length +.sp +The memory in which the substring is placed is obtained by calling the same +memory allocation function that was used for the match data block. The +convenience function \fBpcre2_substring_free()\fP can be used to free it when +it is no longer needed. The yield of the function is zero for success, +PCRE2_ERROR_NOMEMORY if sufficient memory could not be obtained, or +PCRE2_ERROR_NOSUBSTRING if the string name is invalid. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/doc/pcre2_substring_get_bynumber.3 b/doc/pcre2_substring_get_bynumber.3 new file mode 100644 index 0000000..ca65013 --- /dev/null +++ b/doc/pcre2_substring_get_bynumber.3 @@ -0,0 +1,40 @@ +.TH PCRE2_SUBSTRING_GET_BYNUMBER 3 "21 October 2014" "PCRE2 10.00" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_substring_get_bynumber(pcre2_match_data *\fImatch_data\fP, +.B " unsigned int \fInumber\fP, PCRE2_UCHAR **\fIbufferptr\fP, PCRE2_SIZE *\fIbufflen\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This is a convenience function for extracting a captured substring by number into +newly acquired memory. The arguments are: +.sp + \fImatch_data\fP The match data for the match + \fInumber\fP Number of the required substring + \fIbufferptr\fP Where to put the string pointer + \fIbufflen\fP Where to put the string length +.sp +The memory in which the substring is placed is obtained by calling the same +memory allocation function that was used for the match data block. The +convenience function \fBpcre2_substring_free()\fP can be used to free it when +it is no longer needed. The yield of the function is zero for success, +PCRE2_ERROR_NOMEMORY if sufficient memory could not be obtained, or +PCRE2_ERROR_NOSUBSTRING if the string number is invalid. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/doc/pcre2_substring_length_byname.3 b/doc/pcre2_substring_length_byname.3 new file mode 100644 index 0000000..84cdc6a --- /dev/null +++ b/doc/pcre2_substring_length_byname.3 @@ -0,0 +1,34 @@ +.TH PCRE2_SUBSTRING_LENGTH_BYNAME 3 "21 October 2014" "PCRE2 10.00" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_substring_length_byname(pcre2_match_data *\fImatch_data\fP, +.B " PCRE2_SPTR \fIname\fP, PCRE2_SIZE *\fIlength\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function returns the length of a matched substring, identified by name. +The arguments are: +.sp + \fImatch_data\fP The match data block for the match + \fIname\fP The substring name + \fIlength\fP Where to return the length +.sp +The yield is zero on success, or an error code if the substring is not found. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/doc/pcre2_substring_length_bynumber.3 b/doc/pcre2_substring_length_bynumber.3 new file mode 100644 index 0000000..5035a35 --- /dev/null +++ b/doc/pcre2_substring_length_bynumber.3 @@ -0,0 +1,34 @@ +.TH PCRE2_SUBSTRING_LENGTH_BYNUMBER 3 "21 October 2014" "PCRE2 10.00" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_substring_length_bynumber(pcre2_match_data *\fImatch_data\fP, +.B " unsigned int \fInumber\fP, PCRE2_SIZE *\fIlength\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function returns the length of a matched substring, identified by number. +The arguments are: +.sp + \fImatch_data\fP The match data block for the match + \fInumber\fP The substring number + \fIlength\fP Where to return the length +.sp +The yield is zero on success, or an error code if the substring is not found. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/doc/pcre2_substring_list_free.3 b/doc/pcre2_substring_list_free.3 new file mode 100644 index 0000000..4725f9c --- /dev/null +++ b/doc/pcre2_substring_list_free.3 @@ -0,0 +1,27 @@ +.TH PCRE2_SUBSTRING_LIST_FREE 3 "21 October 2014" "PCRE2 10.00" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.SM +.B void pcre2_substring_list_free(PCRE2_SPTR *\fIlist\fP); +. +.SH DESCRIPTION +.rs +.sp +This is a convenience function for freeing the store obtained by a previous +call to \fBpcre2substring_list_get()\fP. Its only argument is a pointer to +the list of string pointers. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/doc/pcre2_substring_list_get.3 b/doc/pcre2_substring_list_get.3 new file mode 100644 index 0000000..bdc400e --- /dev/null +++ b/doc/pcre2_substring_list_get.3 @@ -0,0 +1,44 @@ +.TH PCRE2_SUBSTRING_LIST_GET 3 "21 October 2014" "PCRE2 10.00" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_substring_list_get(pcre2_match_data *\fImatch_data\fP, +.B " PCRE2_UCHAR ***\fIlistptr\fP, PCRE2_SIZE **\fIlengthsptr\fP); +.fi +. +.SH DESCRIPTION +.rs +.sp +This is a convenience function for extracting all the captured substrings after +a pattern match. It builds a list of pointers to the strings, and (optionally) +a second list that contains their lengths (in code units), excluding a +terminating zero that is added to each of them. All this is done in a single +block of memory that is obtained using the same memory allocation function that +was used to get the match data block. The convenience function +\fBpcre2_substring_list_free()\fP can be used to free it when it is no longer +needed. The arguments are: +.sp + \fImatch_data\fP The match data block + \fIlistptr\fP Where to put a pointer to the list + \fIlengthsptr\fP Where to put a pointer to the lengths, or NULL +.sp +A pointer to a list of pointers is put in the variable whose address is in +\fIlistptr\fP. The list is terminated by a NULL pointer. If \fIlengthsptr\fP is +not NULL, a matching list of lengths is created, and its address is placed in +\fIlengthsptr\fP. The yield of the function is zero on success or +PCRE2_ERROR_NOMEMORY if sufficient memory could not be obtained. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/doc/pcre2_substring_nametable_scan.3 b/doc/pcre2_substring_nametable_scan.3 new file mode 100644 index 0000000..4342f98 --- /dev/null +++ b/doc/pcre2_substring_nametable_scan.3 @@ -0,0 +1,41 @@ +.TH PCRE2_SUBSTRING_NAMETABLE_SCAN 3 "21 October 2014" "PCRE2 10.00" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_substring_nametable_scan(const pcre2_code *\fIcode\fP, +.B " PCRE2_SPTR \fIname\fP, PCRE2_SPTR *\fIfirst\fP, PCRE2_SPTR *\fIlast\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This convenience function finds, for a compiled pattern, the first and last +entries for a given name in the table that translates capturing parenthesis +names into numbers. +.sp + \fIcode\fP Compiled regular expression + \fIname\fP Name whose entries required + \fIfirst\fP Where to return a pointer to the first entry + \fIlast\fP Where to return a pointer to the last entry +.sp +When the name is found in the table, if \fIfirst\fP is NULL, the function +returns a group number, but if there is more than one matching entry, it is not +defined which one. Otherwise, when both pointers have been set, the yield of +the function is the length of each entry in code units. If the name is not +found, PCRE2_ERROR_NOSUBSTRING is returned. +.P +There is a complete description of the PCRE2 native API, including the format of +the table entries, in the +.\" HREF +\fBpcre2api\fP +.\" +page, and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/doc/pcre2_substring_number_from_name.3 b/doc/pcre2_substring_number_from_name.3 new file mode 100644 index 0000000..d6588bc --- /dev/null +++ b/doc/pcre2_substring_number_from_name.3 @@ -0,0 +1,37 @@ +.TH PCRE2_SUBSTRING_NUMBER_FROM_NAME 3 "21 October 2014" "PCRE2 10.00" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_substring_number_from_name(const pcre2_code *\fIcode\fP, +.B " PCRE2_SPTR \fIname\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This convenience function finds the number of a named substring capturing +parenthesis in a compiled pattern. Its arguments are: +.sp + \fIcode\fP Compiled regular expression + \fIname\fP Name whose number is required +.sp +The yield of the function is the number of the parenthesis if the name is +found, or PCRE2_ERROR_NOSUBSTRING otherwise. When duplicate names are allowed +(PCRE2_DUPNAMES is set), it is not defined which of the numbers is returned. +You can obtain the complete list by calling +\fBpcre2_substring_nametable_scan()\fP. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/doc/pcre2api.3 b/doc/pcre2api.3 index 00e92e9..d79ea6d 100644 --- a/doc/pcre2api.3 +++ b/doc/pcre2api.3 @@ -319,7 +319,7 @@ performance. The JIT-specific functions are discussed in the .\" documentation. .P -A second matching function, \fBpcre2_dfa_exec()\fP, which is not +A second matching function, \fBpcre2_dfa_match()\fP, which is not Perl-compatible, is also provided. This uses a different algorithm for the matching. The alternative algorithm finds all possible matches (at a given point in the subject), and scans the subject just once (unless there are @@ -606,17 +606,13 @@ function should return zero if all is well, or non-zero to force an error. A match context is required if you want to change the default values of any of the following match-time parameters: .sp - What \eR matches (Unicode newlines or CR, LF, CRLF only); - A callout function; - The limit for calling \fImatch()\fP; - The limit for calling \fImatch()\fP recursively; - The newline character sequence; + A callout function + The limit for calling \fImatch()\fP + The limit for calling \fImatch()\fP recursively .sp A match context is also required if you are using custom memory management. If none of these apply, just pass NULL as the context argument of \fBpcre2_match()\fP, \fBpcre2_dfa_match()\fP, or \fBpcre2_jit_match()\fP. -Changing the newline value or what \eR matches at match time disables the use -of JIT via \fBpcre2_match()\fP. .P A match context is created, copied, and freed by the following functions: .sp diff --git a/doc/pcre2jit.3 b/doc/pcre2jit.3 index 60e5aa9..5842d1b 100644 --- a/doc/pcre2jit.3 +++ b/doc/pcre2jit.3 @@ -1,4 +1,4 @@ -.TH PCRE2JIT 3 "29 September 2014" "PCRE2 10.00" +.TH PCRE2JIT 3 "21 October 2014" "PCRE2 10.00" .SH NAME PCRE2 - Perl-compatible regular expressions (revised API) .SH "PCRE2 JUST-IN-TIME COMPILER SUPPORT" @@ -55,7 +55,9 @@ compiled pattern pointer that was returned by \fBpcre2_compile()\fP, and the second is a set of option bits, which must include at least one of PCRE2_JIT_COMPLETE, PCRE2_JIT_PARTIAL_HARD, or PCRE2_JIT_PARTIAL_SOFT. .P -The returned value from \fBpcre2_jit_compile()\fP is FIXME FIXME. +The returned value from \fBpcre2_jit_compile()\fP is zero on success, or a +negative error code. In particular, PCRE2_ERROR_JIT_BADOPTION is returned if +JIT is not supported or if an unknown options bit is set. .P PCRE2_JIT_COMPLETE requests the JIT compiler to generate code for complete matches. If you want to run partial matches using the PCRE2_PARTIAL_HARD or @@ -335,8 +337,12 @@ processed by \fBpcre2_jit_compile()\fP). .P The fast path function is called \fBpcre2_jit_match()\fP, and it takes exactly the same arguments as \fBpcre2_match()\fP, plus one additional argument that -must point to a JIT stack. The JIT stack arrangements described above do not -apply. The return values are the same as for \fBpcre2_match()\fP. +must either point to a JIT stack or be NULL. In the latter case, if a callback +function has been set up by \fBpcre2_jit_stack_alloc()\fP, it is called. +Otherwise the system stack is used. The return values are the same as for +\fBpcre2_match()\fP, plus PCRE2_ERROR_JIT_BADOPTION if a matching mode (partial +or complete) is requested that was not compiled. Unsupported option bits are +ignored. .P When you call \fBpcre2_match()\fP, as well as testing for invalid options, a number of other sanity checks are performed on the arguments. For example, if @@ -369,6 +375,6 @@ Cambridge CB2 3QH, England. .rs .sp .nf -Last updated: 29 September 2014 +Last updated: 21 October 2014 Copyright (c) 1997-2014 University of Cambridge. .fi diff --git a/src/pcre2_error.c b/src/pcre2_error.c index f2f900f..192c806 100644 --- a/src/pcre2_error.c +++ b/src/pcre2_error.c @@ -273,7 +273,7 @@ for (; n > 0; n--) while (*message++ != CHAR_NULL) {}; if (*message == CHAR_NULL) { - sprintf(xbuff, "Internal error: no text for error %d", enumber); + sprintf(xbuff, "No text for error %d", enumber); break; } }