walkero
/
pcre2
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

Documentation update.

This commit is contained in:
Philip.Hazel 2017-03-26 15:44:09 +00:00
parent f17eb554bf
commit 95888402a0
2 changed files with 25 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/html/pcre2_substitute.html
View File

@ -47,26 +47,29 @@ Its arguments are:
<i>outputbuffer</i> Points to the output buffer <i>outputbuffer</i> Points to the output buffer
<i>outlengthptr</i> Points to the length of the output buffer <i>outlengthptr</i> Points to the length of the output buffer
</pre> </pre>
A match context is needed only if you want to: A match data block is needed only if you want to inspect the data from the
match that is returned in that block. A match context is needed only if you
want to:
<pre> <pre>
Set up a callout function Set up a callout function
Change the limit for calling the internal function <i>match()</i> Set a matching offset limit
Change the limit for calling <i>match()</i> recursively Change the backtracking match limit
Set custom memory management when the heap is used for recursion Change the backtracking depth limit
Set custom memory management in the match context
</pre> </pre>
The <i>length</i>, <i>startoffset</i> and <i>rlength</i> values are code The <i>length</i>, <i>startoffset</i> and <i>rlength</i> values are code
units, not characters, as is the contents of the variable pointed at by units, not characters, as is the contents of the variable pointed at by
<i>outlengthptr</i>, which is updated to the actual length of the new string. <i>outlengthptr</i>, which is updated to the actual length of the new string.
The options are: The subject and replacement lengths can be given as PCRE2_ZERO_TERMINATED for
zero-terminated strings. The options are:
<pre> <pre>
PCRE2_ANCHORED Match only at the first position PCRE2_ANCHORED Match only at the first position
PCRE2_NOTBOL Subject is not the beginning of a line PCRE2_NOTBOL Subject is not the beginning of a line
PCRE2_NOTEOL Subject is not the end 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 An empty string is not a valid match
PCRE2_NOTEMPTY_ATSTART An empty string at the start of the PCRE2_NOTEMPTY_ATSTART An empty string at the start of the subject is not a valid match
subject is not a valid match PCRE2_NO_JIT Do not use JIT matching
PCRE2_NO_UTF_CHECK Do not check the subject or replacement PCRE2_NO_UTF_CHECK Do not check the subject or replacement for UTF validity (only relevant if
for UTF validity (only relevant if
PCRE2_UTF was set at compile time) PCRE2_UTF was set at compile time)
PCRE2_SUBSTITUTE_EXTENDED Do extended replacement processing PCRE2_SUBSTITUTE_EXTENDED Do extended replacement processing
PCRE2_SUBSTITUTE_GLOBAL Replace all occurrences in the subject PCRE2_SUBSTITUTE_GLOBAL Replace all occurrences in the subject

19
doc/pcre2_substitute.3
View File

@ -1,4 +1,4 @@
.TH PCRE2_SUBSTITUTE 3 "12 December 2015" "PCRE2 10.21" .TH PCRE2_SUBSTITUTE 3 "26 March 2017" "PCRE2 10.30"
.SH NAME .SH NAME
PCRE2 - Perl-compatible regular expressions (revised API) PCRE2 - Perl-compatible regular expressions (revised API)
.SH SYNOPSIS .SH SYNOPSIS
@ -35,24 +35,31 @@ Its arguments are:
\fIoutputbuffer\fP Points to the output buffer \fIoutputbuffer\fP Points to the output buffer
\fIoutlengthptr\fP Points to the length of the output buffer \fIoutlengthptr\fP Points to the length of the output buffer
.sp .sp
A match context is needed only if you want to: A match data block is needed only if you want to inspect the data from the
match that is returned in that block. A match context is needed only if you
want to:
.sp .sp
Set up a callout function Set up a callout function
Change the limit for calling the internal function \fImatch()\fP Set a matching offset limit
Change the limit for calling \fImatch()\fP recursively Change the backtracking match limit
Set custom memory management when the heap is used for recursion Change the backtracking depth limit
Set custom memory management in the match context
.sp .sp
The \fIlength\fP, \fIstartoffset\fP and \fIrlength\fP values are code The \fIlength\fP, \fIstartoffset\fP and \fIrlength\fP values are code
units, not characters, as is the contents of the variable pointed at by units, not characters, as is the contents of the variable pointed at by
\fIoutlengthptr\fP, which is updated to the actual length of the new string. \fIoutlengthptr\fP, which is updated to the actual length of the new string.
The options are: The subject and replacement lengths can be given as PCRE2_ZERO_TERMINATED for
zero-terminated strings. The options are:
.sp .sp
PCRE2_ANCHORED Match only at the first position PCRE2_ANCHORED Match only at the first position
PCRE2_NOTBOL Subject is not the beginning of a line PCRE2_NOTBOL Subject is not the beginning of a line
PCRE2_NOTEOL Subject is not the end 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 An empty string is not a valid match
.\" JOIN
PCRE2_NOTEMPTY_ATSTART An empty string at the start of the PCRE2_NOTEMPTY_ATSTART An empty string at the start of the
subject is not a valid match subject is not a valid match
PCRE2_NO_JIT Do not use JIT matching
.\" JOIN
PCRE2_NO_UTF_CHECK Do not check the subject or replacement PCRE2_NO_UTF_CHECK Do not check the subject or replacement
for UTF validity (only relevant if for UTF validity (only relevant if
PCRE2_UTF was set at compile time) PCRE2_UTF was set at compile time)