2014-09-23 07:35:51 -04:00
|
|
|
<html>
|
2015-01-23 11:51:47 -05:00
|
|
|
<!-- This is a manually maintained file that is the root of the HTML version of
|
|
|
|
|
the PCRE2 documentation. When the HTML documents are built from the man
|
|
|
|
|
page versions, the entire doc/html directory is emptied, this file is then
|
|
|
|
|
copied into doc/html/index.html, and the remaining files therein are
|
2014-09-23 07:35:51 -04:00
|
|
|
created by the 132html script.
|
2015-01-23 11:51:47 -05:00
|
|
|
-->
|
2014-09-23 07:35:51 -04:00
|
|
|
<head>
|
|
|
|
|
<title>PCRE2 specification</title>
|
|
|
|
|
</head>
|
|
|
|
|
<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
|
|
|
|
|
<h1>Perl-compatible Regular Expressions (revised API: PCRE2)</h1>
|
|
|
|
|
<p>
|
|
|
|
|
The HTML documentation for PCRE2 consists of a number of pages that are listed
|
|
|
|
|
below in alphabetical order. If you are new to PCRE2, please read the first one
|
|
|
|
|
first.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<table>
|
2014-10-21 12:33:30 -04:00
|
|
|
<tr><td><a href="pcre2.html">pcre2</a></td>
|
2014-09-23 07:35:51 -04:00
|
|
|
<td> Introductory page</td></tr>
|
|
|
|
|
|
2014-11-17 11:59:02 -05:00
|
|
|
<tr><td><a href="pcre2-config.html">pcre2-config</a></td>
|
2014-09-23 07:35:51 -04:00
|
|
|
<td> Information about the installation configuration</td></tr>
|
|
|
|
|
|
2014-10-21 12:33:30 -04:00
|
|
|
<tr><td><a href="pcre2api.html">pcre2api</a></td>
|
2014-09-23 07:35:51 -04:00
|
|
|
<td> PCRE2's native API</td></tr>
|
|
|
|
|
|
2014-10-21 12:33:30 -04:00
|
|
|
<tr><td><a href="pcre2build.html">pcre2build</a></td>
|
2014-09-23 07:35:51 -04:00
|
|
|
<td> Building PCRE2</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2callout.html">pcre2callout</a></td>
|
|
|
|
|
<td> The <i>callout</i> facility</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2compat.html">pcre2compat</a></td>
|
|
|
|
|
<td> Compability with Perl</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2demo.html">pcre2demo</a></td>
|
|
|
|
|
<td> A demonstration C program that uses the PCRE2 library</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2grep.html">pcre2grep</a></td>
|
|
|
|
|
<td> The <b>pcre2grep</b> command</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2jit.html">pcre2jit</a></td>
|
|
|
|
|
<td> Discussion of the just-in-time optimization support</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2limits.html">pcre2limits</a></td>
|
|
|
|
|
<td> Details of size and other limits</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2matching.html">pcre2matching</a></td>
|
|
|
|
|
<td> Discussion of the two matching algorithms</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2partial.html">pcre2partial</a></td>
|
|
|
|
|
<td> Using PCRE2 for partial matching</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2pattern.html">pcre2pattern</a></td>
|
|
|
|
|
<td> Specification of the regular expressions supported by PCRE2</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2perform.html">pcre2perform</a></td>
|
|
|
|
|
<td> Some comments on performance</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2posix.html">pcre2posix</a></td>
|
|
|
|
|
<td> The POSIX API to the PCRE2 8-bit library</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2sample.html">pcre2sample</a></td>
|
|
|
|
|
<td> Discussion of the pcre2demo program</td></tr>
|
|
|
|
|
|
2015-01-23 11:51:47 -05:00
|
|
|
<tr><td><a href="pcre2serialize.html">pcre2serialize</a></td>
|
|
|
|
|
<td> Serializing functions for saving precompiled patterns</td></tr>
|
|
|
|
|
|
2014-09-23 07:35:51 -04:00
|
|
|
<tr><td><a href="pcre2syntax.html">pcre2syntax</a></td>
|
|
|
|
|
<td> Syntax quick-reference summary</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2test.html">pcre2test</a></td>
|
|
|
|
|
<td> The <b>pcre2test</b> command for testing PCRE2</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2unicode.html">pcre2unicode</a></td>
|
|
|
|
|
<td> Discussion of Unicode and UTF-8/UTF-16/UTF-32 support</td></tr>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
There are also individual pages that summarize the interface for each function
|
2014-10-21 12:33:30 -04:00
|
|
|
in the library.
|
2014-09-23 07:35:51 -04:00
|
|
|
</p>
|
|
|
|
|
|
2015-01-23 11:51:47 -05:00
|
|
|
<table>
|
2014-09-23 07:35:51 -04:00
|
|
|
|
2015-03-23 11:52:08 -04:00
|
|
|
<tr><td><a href="pcre2_callout_enumerate.html">pcre2_callout_enumerate</a></td>
|
|
|
|
|
<td> Enumerate callouts in a compiled pattern</td></tr>
|
|
|
|
|
|
2016-02-26 13:26:17 -05:00
|
|
|
<tr><td><a href="pcre2_code_copy.html">pcre2_code_copy</a></td>
|
|
|
|
|
<td> Copy a compiled pattern</td></tr>
|
|
|
|
|
|
2016-11-22 10:37:02 -05:00
|
|
|
<tr><td><a href="pcre2_code_copy_with_tables.html">pcre2_code_copy_with_tables</a></td>
|
|
|
|
|
<td> Copy a compiled pattern and its character tables</td></tr>
|
|
|
|
|
|
2014-10-21 12:33:30 -04:00
|
|
|
<tr><td><a href="pcre2_code_free.html">pcre2_code_free</a></td>
|
|
|
|
|
<td> Free a compiled pattern</td></tr>
|
2014-09-23 07:35:51 -04:00
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2_compile.html">pcre2_compile</a></td>
|
2014-10-21 12:33:30 -04:00
|
|
|
<td> Compile a regular expression pattern</td></tr>
|
2014-09-23 07:35:51 -04:00
|
|
|
|
2014-10-25 10:16:46 -04:00
|
|
|
<tr><td><a href="pcre2_compile_context_copy.html">pcre2_compile_context_copy</a></td>
|
|
|
|
|
<td> Copy a compile context</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2_compile_context_create.html">pcre2_compile_context_create</a></td>
|
|
|
|
|
<td> Create a compile context</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2_compile_context_free.html">pcre2_compile_context_free</a></td>
|
|
|
|
|
<td> Free a compile context</td></tr>
|
2014-09-23 07:35:51 -04:00
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2_config.html">pcre2_config</a></td>
|
|
|
|
|
<td> Show build-time configuration options</td></tr>
|
|
|
|
|
|
2014-10-21 12:33:30 -04:00
|
|
|
<tr><td><a href="pcre2_dfa_match.html">pcre2_dfa_match</a></td>
|
2014-09-23 07:35:51 -04:00
|
|
|
<td> Match a compiled pattern to a subject string
|
|
|
|
|
(DFA algorithm; <i>not</i> Perl compatible)</td></tr>
|
|
|
|
|
|
2014-10-25 10:16:46 -04:00
|
|
|
<tr><td><a href="pcre2_general_context_copy.html">pcre2_general_context_copy</a></td>
|
|
|
|
|
<td> Copy a general context</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2_general_context_create.html">pcre2_general_context_create</a></td>
|
|
|
|
|
<td> Create a general context</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2_general_context_free.html">pcre2_general_context_free</a></td>
|
|
|
|
|
<td> Free a general context</td></tr>
|
|
|
|
|
|
2014-10-21 12:33:30 -04:00
|
|
|
<tr><td><a href="pcre2_get_error_message.html">pcre2_get_error_message</a></td>
|
2014-09-23 07:35:51 -04:00
|
|
|
<td> Free study data</td></tr>
|
|
|
|
|
|
2014-10-25 10:16:46 -04:00
|
|
|
<tr><td><a href="pcre2_get_mark.html">pcre2_get_mark</a></td>
|
|
|
|
|
<td> Get a (*MARK) name</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2_get_ovector_count.html">pcre2_get_ovector_count</a></td>
|
|
|
|
|
<td> Get the ovector count</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2_get_ovector_pointer.html">pcre2_get_ovector_pointer</a></td>
|
|
|
|
|
<td> Get a pointer to the ovector</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2_get_startchar.html">pcre2_get_startchar</a></td>
|
|
|
|
|
<td> Get the starting character offset</td></tr>
|
|
|
|
|
|
2014-10-21 12:33:30 -04:00
|
|
|
<tr><td><a href="pcre2_jit_compile.html">pcre2_jit_compile</a></td>
|
|
|
|
|
<td> Process a compiled pattern with the JIT compiler</td></tr>
|
2014-09-23 07:35:51 -04:00
|
|
|
|
2014-10-25 10:16:46 -04:00
|
|
|
<tr><td><a href="pcre2_jit_free_unused_memory.html">pcre2_jit_free_unused_memory</a></td>
|
|
|
|
|
<td> Free unused JIT memory</td></tr>
|
|
|
|
|
|
2014-10-21 12:33:30 -04:00
|
|
|
<tr><td><a href="pcre2_jit_match.html">pcre2_jit_match</a></td>
|
2014-09-23 07:35:51 -04:00
|
|
|
<td> Fast path interface to JIT matching</td></tr>
|
|
|
|
|
|
2014-10-21 12:33:30 -04:00
|
|
|
<tr><td><a href="pcre2_jit_stack_assign.html">pcre2_jit_stack_assign</a></td>
|
|
|
|
|
<td> Assign stack for JIT matching</td></tr>
|
|
|
|
|
|
2014-11-03 12:13:00 -05:00
|
|
|
<tr><td><a href="pcre2_jit_stack_create.html">pcre2_jit_stack_create</a></td>
|
|
|
|
|
<td> Create a stack for JIT matching</td></tr>
|
|
|
|
|
|
2014-09-23 07:35:51 -04:00
|
|
|
<tr><td><a href="pcre2_jit_stack_free.html">pcre2_jit_stack_free</a></td>
|
|
|
|
|
<td> Free a JIT matching stack</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2_maketables.html">pcre2_maketables</a></td>
|
|
|
|
|
<td> Build character tables in current locale</td></tr>
|
2015-01-23 11:51:47 -05:00
|
|
|
|
2014-10-21 12:33:30 -04:00
|
|
|
<tr><td><a href="pcre2_match.html">pcre2_match</a></td>
|
|
|
|
|
<td> Match a compiled pattern to a subject string
|
|
|
|
|
(Perl compatible)</td></tr>
|
|
|
|
|
|
2014-10-25 10:16:46 -04:00
|
|
|
<tr><td><a href="pcre2_match_context_copy.html">pcre2_match_context_copy</a></td>
|
|
|
|
|
<td> Copy a match context</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2_match_context_create.html">pcre2_match_context_create</a></td>
|
|
|
|
|
<td> Create a match context</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2_match_context_free.html">pcre2_match_context_free</a></td>
|
|
|
|
|
<td> Free a match context</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2_match_data_create.html">pcre2_match_data_create</a></td>
|
|
|
|
|
<td> Create a match data block</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2_match_data_create_from_pattern.html">pcre2_match_data_create_from_pattern</a></td>
|
|
|
|
|
<td> Create a match data block getting size from pattern</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2_match_data_free.html">pcre2_match_data_free</a></td>
|
|
|
|
|
<td> Free a match data block</td></tr>
|
|
|
|
|
|
2014-10-21 12:33:30 -04:00
|
|
|
<tr><td><a href="pcre2_pattern_info.html">pcre2_pattern_info</a></td>
|
|
|
|
|
<td> Extract information about a pattern</td></tr>
|
|
|
|
|
|
2015-01-23 11:51:47 -05:00
|
|
|
<tr><td><a href="pcre2_serialize_decode.html">pcre2_serialize_decode</a></td>
|
|
|
|
|
<td> Decode serialized compiled patterns</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2_serialize_encode.html">pcre2_serialize_encode</a></td>
|
|
|
|
|
<td> Serialize compiled patterns for save/restore</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2_serialize_free.html">pcre2_serialize_free</a></td>
|
|
|
|
|
<td> Free serialized compiled patterns</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2_serialize_get_number_of_codes.html">pcre2_serialize_get_number_of_codes</a></td>
|
|
|
|
|
<td> Get number of serialized compiled patterns</td></tr>
|
|
|
|
|
|
2014-10-25 10:16:46 -04:00
|
|
|
<tr><td><a href="pcre2_set_bsr.html">pcre2_set_bsr</a></td>
|
|
|
|
|
<td> Set \R convention</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2_set_callout.html">pcre2_set_callout</a></td>
|
|
|
|
|
<td> Set up a callout function</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2_set_character_tables.html">pcre2_set_character_tables</a></td>
|
|
|
|
|
<td> Set character tables</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2_set_compile_recursion_guard.html">pcre2_set_compile_recursion_guard</a></td>
|
|
|
|
|
<td> Set up a compile recursion guard function</td></tr>
|
|
|
|
|
|
2017-03-25 13:50:54 -04:00
|
|
|
<tr><td><a href="pcre2_set_depth_limit.html">pcre2_set_depth_limit</a></td>
|
|
|
|
|
<td> Set the match backtracking depth limit</td></tr>
|
|
|
|
|
|
2017-04-11 07:47:25 -04:00
|
|
|
<tr><td><a href="pcre2_set_heap_limit.html">pcre2_set_heap_limit</a></td>
|
|
|
|
|
<td> Set the match backtracking heap limit</td></tr>
|
|
|
|
|
|
2014-10-25 10:16:46 -04:00
|
|
|
<tr><td><a href="pcre2_set_match_limit.html">pcre2_set_match_limit</a></td>
|
|
|
|
|
<td> Set the match limit</td></tr>
|
|
|
|
|
|
2015-11-05 12:33:39 -05:00
|
|
|
<tr><td><a href="pcre2_set_max_pattern_length.html">pcre2_set_max_pattern_length</a></td>
|
|
|
|
|
<td> Set the maximum length of pattern</td></tr>
|
2015-09-22 12:51:11 -04:00
|
|
|
|
2014-10-25 10:16:46 -04:00
|
|
|
<tr><td><a href="pcre2_set_newline.html">pcre2_set_newline</a></td>
|
|
|
|
|
<td> Set the newline convention</td></tr>
|
|
|
|
|
|
2015-11-05 12:33:39 -05:00
|
|
|
<tr><td><a href="pcre2_set_offset_limit.html">pcre2_set_offset_limit</a></td>
|
|
|
|
|
<td> Set the offset limit</td></tr>
|
|
|
|
|
|
2014-10-25 10:16:46 -04:00
|
|
|
<tr><td><a href="pcre2_set_parens_nest_limit.html">pcre2_set_parens_nest_limit</a></td>
|
|
|
|
|
<td> Set the parentheses nesting limit</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2_set_recursion_limit.html">pcre2_set_recursion_limit</a></td>
|
2017-03-25 13:50:54 -04:00
|
|
|
<td> Obsolete: use pcre2_set_depth_limit</td></tr>
|
2014-10-25 10:16:46 -04:00
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2_set_recursion_memory_management.html">pcre2_set_recursion_memory_management</a></td>
|
2017-03-25 13:50:54 -04:00
|
|
|
<td> Obsolete function that (from 10.30 onwards) does nothing</td></tr>
|
2014-10-25 10:16:46 -04:00
|
|
|
|
2014-11-11 11:51:07 -05:00
|
|
|
<tr><td><a href="pcre2_substitute.html">pcre2_substitute</a></td>
|
|
|
|
|
<td> Match a compiled pattern to a subject string and do
|
|
|
|
|
substitutions</td></tr>
|
|
|
|
|
|
2014-10-21 12:33:30 -04:00
|
|
|
<tr><td><a href="pcre2_substring_copy_byname.html">pcre2_substring_copy_byname</a></td>
|
|
|
|
|
<td> Extract named substring into given buffer</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2_substring_copy_bynumber.html">pcre2_substring_copy_bynumber</a></td>
|
|
|
|
|
<td> Extract numbered substring into given buffer</td></tr>
|
2014-09-23 07:35:51 -04:00
|
|
|
|
2014-10-21 12:33:30 -04:00
|
|
|
<tr><td><a href="pcre2_substring_free.html">pcre2_substring_free</a></td>
|
|
|
|
|
<td> Free extracted substring</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2_substring_get_byname.html">pcre2_substring_get_byname</a></td>
|
|
|
|
|
<td> Extract named substring into new memory</td></tr>
|
2014-09-23 07:35:51 -04:00
|
|
|
|
2014-10-21 12:33:30 -04:00
|
|
|
<tr><td><a href="pcre2_substring_get_bynumber.html">pcre2_substring_get_bynumber</a></td>
|
|
|
|
|
<td> Extract numbered substring into new memory</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2_substring_length_byname.html">pcre2_substring_length_byname</a></td>
|
|
|
|
|
<td> Find length of named substring</td></tr>
|
2014-09-23 07:35:51 -04:00
|
|
|
|
2014-10-21 12:33:30 -04:00
|
|
|
<tr><td><a href="pcre2_substring_length_bynumber.html">pcre2_substring_length_bynumber</a></td>
|
|
|
|
|
<td> Find length of numbered substring</td></tr>
|
2014-09-23 07:35:51 -04:00
|
|
|
|
2014-10-21 12:33:30 -04:00
|
|
|
<tr><td><a href="pcre2_substring_list_free.html">pcre2_substring_list_free</a></td>
|
|
|
|
|
<td> Free list of extracted substrings</td></tr>
|
2014-09-23 07:35:51 -04:00
|
|
|
|
2014-10-21 12:33:30 -04:00
|
|
|
<tr><td><a href="pcre2_substring_list_get.html">pcre2_substring_list_get</a></td>
|
|
|
|
|
<td> Extract all substrings into new memory</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2_substring_nametable_scan.html">pcre2_substring_nametable_scan</a></td>
|
|
|
|
|
<td> Find table entries for given string name</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td><a href="pcre2_substring_number_from_name.html">pcre2_substring_number_from_name</a></td>
|
|
|
|
|
<td> Convert captured string name to number</td></tr>
|
2014-09-23 07:35:51 -04:00
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</html>
|
|
|
|
|
|
