From 5075e74d8afd43ab9c5ce9342026fdc8c01632f1 Mon Sep 17 00:00:00 2001 From: "Philip.Hazel" Date: Sat, 21 Nov 2015 16:27:06 +0000 Subject: [PATCH] Documentation updates. --- doc/pcre2_pattern_info.3 | 9 +++++---- doc/pcre2api.3 | 34 +++++++++++++++++++--------------- 2 files changed, 24 insertions(+), 19 deletions(-) diff --git a/doc/pcre2_pattern_info.3 b/doc/pcre2_pattern_info.3 index 8424e6f..575840b 100644 --- a/doc/pcre2_pattern_info.3 +++ b/doc/pcre2_pattern_info.3 @@ -1,4 +1,4 @@ -.TH PCRE2_PATTERN_INFO 3 "01 December 2014" "PCRE2 10.00" +.TH PCRE2_PATTERN_INFO 3 "21 November 2015" "PCRE2 10.21" .SH NAME PCRE2 - Perl-compatible regular expressions (revised API) .SH SYNOPSIS @@ -30,19 +30,20 @@ request are as follows: PCRE2_BSR_ANYCRLF: 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_FIRSTCODEUNIT First code unit when type is 1 + PCRE2_INFO_HASBACKSLASHC Return 1 if pattern contains \eC 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_LASTCODEUNIT Last code unit when type is 1 PCRE2_INFO_MATCHEMPTY 1 if the pattern can match an empty string, 0 otherwise PCRE2_INFO_MATCHLIMIT Match limit if set, @@ -50,8 +51,8 @@ request are as follows: 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_NAMEENTRYSIZE Size of name table entries PCRE2_INFO_NAMETABLE Pointer to name table PCRE2_CONFIG_NEWLINE Code for the newline sequence: PCRE2_NEWLINE_CR diff --git a/doc/pcre2api.3 b/doc/pcre2api.3 index aeb5bf2..c878dda 100644 --- a/doc/pcre2api.3 +++ b/doc/pcre2api.3 @@ -1,4 +1,4 @@ -.TH PCRE2API 3 "14 November 2015" "PCRE2 10.21" +.TH PCRE2API 3 "21 November 2015" "PCRE2 10.21" .SH NAME PCRE2 - Perl-compatible regular expressions (revised API) .sp @@ -736,7 +736,9 @@ PCRE2_USE_OFFSET_LIMIT is not set, an error is generated. .P The offset limit facility can be used to track progress when searching large subject strings. See also the PCRE2_FIRSTLINE option, which requires a match to -start within the first line of the subject. +start within the first line of the subject. If this is set with an offset +limit, a match must occur in the first line and also within the offset limit. +In other words, whichever limit comes first is used. .sp .nf .B int pcre2_set_match_limit(pcre2_match_context *\fImcontext\fP, @@ -1186,7 +1188,9 @@ built. 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. See also PCRE2_USE_OFFSET_LIMIT, which provides a more -general limiting facility. +general limiting facility. If PCRE2_FIRSTLINE is set with an offset limit, a +match must occur in the first line and also within the offset limit. In other +words, whichever limit comes first is used. .sp PCRE2_MATCH_UNSET_BACKREF .sp @@ -1610,6 +1614,17 @@ matches only CR, LF, or CRLF. .sp Return the number of capturing subpatterns in the pattern. The third argument should point to an \fBuint32_t\fP variable. +.sp + PCRE2_INFO_FIRSTBITMAP +.sp +In the absence of a single first code unit for a non-anchored pattern, +\fBpcre2_compile()\fP 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 constructed, a pointer to it is +returned. Otherwise NULL is returned. The third argument should point to an +\fBconst uint8_t *\fP variable. .sp PCRE2_INFO_FIRSTCODETYPE .sp @@ -1632,17 +1647,6 @@ argument should point to an \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 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. -.sp - PCRE2_INFO_FIRSTBITMAP -.sp -In the absence of a single first code unit for a non-anchored pattern, -\fBpcre2_compile()\fP 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 constructed, a pointer to it is -returned. Otherwise NULL is returned. The third argument should point to an -\fBconst uint8_t *\fP variable. .sp PCRE2_INFO_HASBACKSLASHC .sp @@ -3097,6 +3101,6 @@ Cambridge, England. .rs .sp .nf -Last updated: 14 November 2015 +Last updated: 21 November 2015 Copyright (c) 1997-2015 University of Cambridge. .fi