add PIRegularExpression

3rd/pcre2/doc/pcre2_set_compile_extra_options.3

@@ -0,0 +1,59 @@
+.TH PCRE2_SET_COMPILE_EXTRA_OPTIONS 3 "14 October 2024" "PCRE2 10.45"
+.SH NAME
+PCRE2 - Perl-compatible regular expressions (revised API)
+.SH SYNOPSIS
+.rs
+.sp
+.B #include <pcre2.h>
+.PP
+.nf
+.B int pcre2_set_compile_extra_options(pcre2_compile_context *\fIccontext\fP,
+.B "  uint32_t \fIextra_options\fP);"
+.fi
+.
+.SH DESCRIPTION
+.rs
+.sp
+This function sets additional option bits for \fBpcre2_compile()\fP that are
+housed in a compile context. It completely replaces all the bits. The extra
+options are:
+.sp
+  PCRE2_EXTRA_ALLOW_LOOKAROUND_BSK     Allow \eK in lookarounds
+.\" JOIN
+  PCRE2_EXTRA_ALLOW_SURROGATE_ESCAPES  Allow \ex{d800} to \ex{dfff}
+                                         in UTF-8 and UTF-32 modes
+.\" JOIN
+  PCRE2_EXTRA_ALT_BSUX                 Extended alternate \eu, \eU, and
+                                         \ex handling
+  PCRE2_EXTRA_ASCII_BSD                \ed remains ASCII in UCP mode
+  PCRE2_EXTRA_ASCII_BSS                \es remains ASCII in UCP mode
+  PCRE2_EXTRA_ASCII_BSW                \ew remains ASCII in UCP mode
+.\" JOIN
+  PCRE2_EXTRA_ASCII_DIGIT              [:digit:] and [:xdigit:] POSIX classes
+                                         remain ASCII in UCP mode
+.\" JOIN
+  PCRE2_EXTRA_ASCII_POSIX              POSIX classes remain ASCII in
+                                         UCP mode
+.\" JOIN
+  PCRE2_EXTRA_BAD_ESCAPE_IS_LITERAL    Treat all invalid escapes as
+                                         a literal following character
+.\" JOIN
+  PCRE2_EXTRA_CASELESS_RESTRICT        Disable mixed ASCII/non-ASCII
+                                         case folding
+  PCRE2_EXTRA_ESCAPED_CR_IS_LF         Interpret \er as \en
+  PCRE2_EXTRA_MATCH_LINE               Pattern matches whole lines
+  PCRE2_EXTRA_MATCH_WORD               Pattern matches "words"
+  PCRE2_EXTRA_NEVER_CALLOUT            Disallow callouts in pattern
+  PCRE2_EXTRA_NO_BS0                   Disallow \e0 (but not \e00 or \e000)
+  PCRE2_EXTRA_PYTHON_OCTAL             Use Python rules for octal
+  PCRE2_EXTRA_TURKISH_CASING           Use Turkish I case folding
+.sp
+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.