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

Documentation typo fixes.

This commit is contained in:
Philip.Hazel 2019-07-22 11:05:19 +00:00
parent c84a06c96e
commit f7e21162fa
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
doc/pcre2api.3
View File

@ -1,4 +1,4 @@
.TH PCRE2API 3 "20 July 2019" "PCRE2 10.34" .TH PCRE2API 3 "22 July 2019" "PCRE2 10.34"
.SH NAME .SH NAME
PCRE2 - Perl-compatible regular expressions (revised API) PCRE2 - Perl-compatible regular expressions (revised API)
.sp .sp
@ -2020,7 +2020,7 @@ the following negative numbers:
PCRE2_ERROR_BADOPTION the value of \fIwhat\fP was invalid PCRE2_ERROR_BADOPTION the value of \fIwhat\fP was invalid
PCRE2_ERROR_UNSET the requested field is not set PCRE2_ERROR_UNSET the requested field is not set
.sp .sp
The "magic number" is placed at the start of each compiled pattern as an simple The "magic number" is placed at the start of each compiled pattern as a simple
check against passing an arbitrary memory pointer. Here is a typical call of check against passing an arbitrary memory pointer. Here is a typical call of
\fBpcre2_pattern_info()\fP, to obtain the length of the compiled pattern: \fBpcre2_pattern_info()\fP, to obtain the length of the compiled pattern:
.sp .sp
@ -2077,7 +2077,7 @@ options returned for PCRE2_INFO_ALLOPTIONS.
PCRE2_INFO_BACKREFMAX PCRE2_INFO_BACKREFMAX
.sp .sp
Return the number of the highest backreference in the pattern. The third Return the number of the highest backreference in the pattern. The third
argument should point to an \fBuint32_t\fP variable. Named capture groups argument should point to a \fBuint32_t\fP variable. Named capture groups
acquire numbers as well as names, and these count towards the highest acquire numbers as well as names, and these count towards the highest
backreference. Backreferences such as \e4 or \eg{12} match the captured backreference. Backreferences such as \e4 or \eg{12} match the captured
characters of the given group, but in addition, the check that a capture characters of the given group, but in addition, the check that a capture
@ -2095,7 +2095,7 @@ that \eR matches only CR, LF, or CRLF.
.sp .sp
Return the highest capture group number in the pattern. In patterns where (?| Return the highest capture group number in the pattern. In patterns where (?|
is not used, this is also the total number of capture groups. The third is not used, this is also the total number of capture groups. The third
argument should point to an \fBuint32_t\fP variable. argument should point to a \fBuint32_t\fP variable.
.sp .sp
PCRE2_INFO_DEPTHLIMIT PCRE2_INFO_DEPTHLIMIT
.sp .sp
@ -2120,7 +2120,7 @@ returned. Otherwise NULL is returned. The third argument should point to a
PCRE2_INFO_FIRSTCODETYPE PCRE2_INFO_FIRSTCODETYPE
.sp .sp
Return information about the first code unit of any matched string, for a Return information about the first code unit of any matched string, for a
non-anchored pattern. The third argument should point to an \fBuint32_t\fP non-anchored pattern. The third argument should point to a \fBuint32_t\fP
variable. If there is a fixed first value, for example, the letter "c" from a 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 value can be retrieved pattern such as (cat|cow|coyote), 1 is returned, and the value can be retrieved
using PCRE2_INFO_FIRSTCODEUNIT. If there is no fixed first value, but it is using PCRE2_INFO_FIRSTCODEUNIT. If there is no fixed first value, but it is
@ -2132,7 +2132,7 @@ is returned.
.sp .sp
Return the value of the first code unit of any matched string for a pattern Return the value of the first code unit of any matched string for a pattern
where PCRE2_INFO_FIRSTCODETYPE returns 1; otherwise return 0. The third where PCRE2_INFO_FIRSTCODETYPE returns 1; otherwise return 0. The third
argument should point to an \fBuint32_t\fP variable. In the 8-bit library, the argument should point to a \fBuint32_t\fP variable. In the 8-bit library, the
value is always less than 256. In the 16-bit library the value can be up to 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, 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. and up to 0xffffffff when not using UTF-32 mode.
@ -2148,12 +2148,12 @@ pattern. Each additional capture group adds two PCRE2_SIZE variables.
PCRE2_INFO_HASBACKSLASHC PCRE2_INFO_HASBACKSLASHC
.sp .sp
Return 1 if the pattern contains any instances of \eC, otherwise 0. The third Return 1 if the pattern contains any instances of \eC, otherwise 0. The third
argument should point to an \fBuint32_t\fP variable. argument should point to a \fBuint32_t\fP variable.
.sp .sp
PCRE2_INFO_HASCRORLF PCRE2_INFO_HASCRORLF
.sp .sp
Return 1 if the pattern contains any explicit matches for CR or LF characters, Return 1 if the pattern contains any explicit matches for CR or LF characters,
otherwise 0. The third argument should point to an \fBuint32_t\fP variable. An otherwise 0. The third argument should point to a \fBuint32_t\fP variable. An
explicit match is either a literal CR or LF character, or \er or \en or one of explicit match is either a literal CR or LF character, or \er or \en or one of
the equivalent hexadecimal or octal escape sequences. the equivalent hexadecimal or octal escape sequences.
.sp .sp
@ -2169,7 +2169,7 @@ defaulted by the caller of the match function.
PCRE2_INFO_JCHANGED PCRE2_INFO_JCHANGED
.sp .sp
Return 1 if the (?J) or (?-J) option setting is used in the pattern, otherwise Return 1 if the (?J) or (?-J) option setting is used in the pattern, otherwise
0. The third argument should point to an \fBuint32_t\fP variable. (?J) and 0. The third argument should point to a \fBuint32_t\fP variable. (?J) and
(?-J) set and unset the local PCRE2_DUPNAMES option, respectively. (?-J) set and unset the local PCRE2_DUPNAMES option, respectively.
.sp .sp
PCRE2_INFO_JITSIZE PCRE2_INFO_JITSIZE
@ -2181,7 +2181,7 @@ return zero. The third argument should point to a \fBsize_t\fP variable.
PCRE2_INFO_LASTCODETYPE PCRE2_INFO_LASTCODETYPE
.sp .sp
Returns 1 if there is a rightmost literal code unit that must exist in any 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 matched string, other than at its start. The third argument should point to a
\fBuint32_t\fP variable. If there is no such value, 0 is returned. When 1 is \fBuint32_t\fP variable. If there is no such value, 0 is returned. When 1 is
returned, the code unit value itself can be retrieved using returned, the code unit value itself can be retrieved using
PCRE2_INFO_LASTCODEUNIT. For anchored patterns, a last literal value is PCRE2_INFO_LASTCODEUNIT. For anchored patterns, a last literal value is
@ -2194,12 +2194,12 @@ PCRE2_INFO_LASTCODEUNIT), but for /^a\edz\ed/ the returned value is 0.
Return the value of the rightmost literal code unit that must exist in any Return the value of the rightmost literal code unit that must exist in any
matched string, other than at its start, for a pattern where matched string, other than at its start, for a pattern where
PCRE2_INFO_LASTCODETYPE returns 1. Otherwise, return 0. The third argument PCRE2_INFO_LASTCODETYPE returns 1. Otherwise, return 0. The third argument
should point to an \fBuint32_t\fP variable. should point to a \fBuint32_t\fP variable.
.sp .sp
PCRE2_INFO_MATCHEMPTY PCRE2_INFO_MATCHEMPTY
.sp .sp
Return 1 if the pattern might match an empty string, otherwise 0. The third Return 1 if the pattern might match an empty string, otherwise 0. The third
argument should point to an \fBuint32_t\fP variable. When a pattern contains argument should point to a \fBuint32_t\fP variable. When a pattern contains
recursive subroutine calls it is not always possible to determine whether or recursive subroutine calls it is not always possible to determine whether or
not it can match an empty string. PCRE2 takes a cautious approach and returns 1 not it can match an empty string. PCRE2 takes a cautious approach and returns 1
in such cases. in such cases.
@ -2243,7 +2243,7 @@ If a minimum length for matching subject strings was computed, its value is
returned. Otherwise the returned value is 0. This value is not computed when returned. Otherwise the returned value is 0. This value is not computed when
PCRE2_NO_START_OPTIMIZE is set. The value is a number of characters, which in PCRE2_NO_START_OPTIMIZE is set. The value is a number of characters, which in
UTF mode may be different from the number of code units. The third argument UTF mode may be different from the number of code units. The third argument
should point to an \fBuint32_t\fP variable. The value is a lower bound to the should point to a \fBuint32_t\fP variable. The value is a lower bound to the
length of any matching string. There may not be any strings of that length that 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. do actually match, but every string that does match is at least that long.
.sp .sp
@ -3862,6 +3862,6 @@ Cambridge, England.
.rs .rs
.sp .sp
.nf .nf
Last updated: 20 July 2019 Last updated: 22 July 2019
Copyright (c) 1997-2019 University of Cambridge. Copyright (c) 1997-2019 University of Cambridge.
.fi .fi