embedaddon/pcre/doc/pcreapi.3 - diff

Return to pcreapi.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / pcre / doc

Diff for /embedaddon/pcre/doc/pcreapi.3 between versions 1.1 and 1.1.1.2

version 1.1, 2012/02/21 23:05:51	version 1.1.1.2, 2012/02/21 23:50:25
Line 1	Line 1
.TH PCREAPI 3	.TH PCREAPI 3
.SH NAME	.SH NAME
PCRE - Perl-compatible regular expressions	PCRE - Perl-compatible regular expressions
	.sp
	.B #include <pcre.h>
	.
	.
.SH "PCRE NATIVE API BASIC FUNCTIONS"	.SH "PCRE NATIVE API BASIC FUNCTIONS"
.rs	.rs
.sp	.sp
.B #include <pcre.h>
.PP
.SM	.SM
.B pcre pcre_compile(const char \fIpattern\fP, int \fIoptions\fP,	.B pcre pcre_compile(const char \fIpattern\fP, int \fIoptions\fP,
.ti +5n	.ti +5n
Line 32 PCRE - Perl-compatible regular expressions	Line 34 PCRE - Perl-compatible regular expressions
.B "const char *\fIsubject\fP," int \fIlength\fP, int \fIstartoffset\fP,	.B "const char *\fIsubject\fP," int \fIlength\fP, int \fIstartoffset\fP,
.ti +5n	.ti +5n
.B int \fIoptions\fP, int *\fIovector\fP, int \fIovecsize\fP);	.B int \fIoptions\fP, int *\fIovector\fP, int \fIovecsize\fP);
.
.
.SH "PCRE NATIVE API AUXILIARY FUNCTIONS"
.rs
.sp
.B pcre_jit_stack *pcre_jit_stack_alloc(int \fIstartsize\fP, int \fImaxsize\fP);
.PP	.PP
.B void pcre_jit_stack_free(pcre_jit_stack *\fIstack\fP);
.PP
.B void pcre_assign_jit_stack(pcre_extra *\fIextra\fP,
.ti +5n
.B pcre_jit_callback \fIcallback\fP, void *\fIdata\fP);
.PP
.B int pcre_dfa_exec(const pcre \fIcode\fP, "const pcre_extra \fIextra\fP,"	.B int pcre_dfa_exec(const pcre \fIcode\fP, "const pcre_extra \fIextra\fP,"
.ti +5n	.ti +5n
.B "const char *\fIsubject\fP," int \fIlength\fP, int \fIstartoffset\fP,	.B "const char *\fIsubject\fP," int \fIlength\fP, int \fIstartoffset\fP,
Line 52 PCRE - Perl-compatible regular expressions	Line 42 PCRE - Perl-compatible regular expressions
.B int \fIoptions\fP, int *\fIovector\fP, int \fIovecsize\fP,	.B int \fIoptions\fP, int *\fIovector\fP, int \fIovecsize\fP,
.ti +5n	.ti +5n
.B int *\fIworkspace\fP, int \fIwscount\fP);	.B int *\fIworkspace\fP, int \fIwscount\fP);
.PP	.
	.
	.SH "PCRE NATIVE API STRING EXTRACTION FUNCTIONS"
	.rs
	.sp
.B int pcre_copy_named_substring(const pcre *\fIcode\fP,	.B int pcre_copy_named_substring(const pcre *\fIcode\fP,
.ti +5n	.ti +5n
.B const char \fIsubject\fP, int \fIovector\fP,	.B const char \fIsubject\fP, int \fIovector\fP,
Line 96 PCRE - Perl-compatible regular expressions	Line 90 PCRE - Perl-compatible regular expressions
.B void pcre_free_substring(const char *\fIstringptr\fP);	.B void pcre_free_substring(const char *\fIstringptr\fP);
.PP	.PP
.B void pcre_free_substring_list(const char **\fIstringptr\fP);	.B void pcre_free_substring_list(const char **\fIstringptr\fP);
	.
	.
	.SH "PCRE NATIVE API AUXILIARY FUNCTIONS"
	.rs
	.sp
	.B pcre_jit_stack *pcre_jit_stack_alloc(int \fIstartsize\fP, int \fImaxsize\fP);
.PP	.PP
	.B void pcre_jit_stack_free(pcre_jit_stack *\fIstack\fP);
	.PP
	.B void pcre_assign_jit_stack(pcre_extra *\fIextra\fP,
	.ti +5n
	.B pcre_jit_callback \fIcallback\fP, void *\fIdata\fP);
	.PP
.B const unsigned char *pcre_maketables(void);	.B const unsigned char *pcre_maketables(void);
.PP	.PP
.B int pcre_fullinfo(const pcre \fIcode\fP, "const pcre_extra \fIextra\fP,"	.B int pcre_fullinfo(const pcre \fIcode\fP, "const pcre_extra \fIextra\fP,"
.ti +5n	.ti +5n
.B int \fIwhat\fP, void *\fIwhere\fP);	.B int \fIwhat\fP, void *\fIwhere\fP);
.PP	.PP
.B int pcre_info(const pcre \fIcode\fP, int \fIoptptr\fP, int
.B *\fIfirstcharptr\fP);
.PP
.B int pcre_refcount(pcre *\fIcode\fP, int \fIadjust\fP);	.B int pcre_refcount(pcre *\fIcode\fP, int \fIadjust\fP);
.PP	.PP
.B int pcre_config(int \fIwhat\fP, void *\fIwhere\fP);	.B int pcre_config(int \fIwhat\fP, void *\fIwhere\fP);
.PP	.PP
.B char *pcre_version(void);	.B const char *pcre_version(void);
	.PP
	.B int pcre_pattern_to_host_byte_order(pcre *\fIcode\fP,
	.ti +5n
	.B pcre_extra \fIextra\fP, const unsigned char \fItables\fP);
.	.
.	.
.SH "PCRE NATIVE API INDIRECTED FUNCTIONS"	.SH "PCRE NATIVE API INDIRECTED FUNCTIONS"
Line 127 PCRE - Perl-compatible regular expressions	Line 134 PCRE - Perl-compatible regular expressions
.B int (pcre_callout)(pcre_callout_block );	.B int (pcre_callout)(pcre_callout_block );
.	.
.	.
	.SH "PCRE 8-BIT AND 16-BIT LIBRARIES"
	.rs
	.sp
	From release 8.30, PCRE can be compiled as a library for handling 16-bit
	character strings as well as, or instead of, the original library that handles
	8-bit character strings. To avoid too much complication, this document
	describes the 8-bit versions of the functions, with only occasional references
	to the 16-bit library.
	.P
	The 16-bit functions operate in the same way as their 8-bit counterparts; they
	just use different data types for their arguments and results, and their names
	start with \fBpcre16_\fP instead of \fBpcre_\fP. For every option that has UTF8
	in its name (for example, PCRE_UTF8), there is a corresponding 16-bit name with
	UTF8 replaced by UTF16. This facility is in fact just cosmetic; the 16-bit
	option names define the same bit values.
	.P
	References to bytes and UTF-8 in this document should be read as references to
	16-bit data quantities and UTF-16 when using the 16-bit library, unless
	specified otherwise. More details of the specific differences for the 16-bit
	library are given in the
	.\" HREF
	\fBpcre16\fP
	.\"
	page.
	.
	.
.SH "PCRE API OVERVIEW"	.SH "PCRE API OVERVIEW"
.rs	.rs
.sp	.sp
PCRE has its own native API, which is described in this document. There are	PCRE has its own native API, which is described in this document. There are
also some wrapper functions that correspond to the POSIX regular expression	also some wrapper functions (for the 8-bit library only) that correspond to the
API, but they do not give access to all the functionality. They are described	POSIX regular expression API, but they do not give access to all the
in the	functionality. They are described in the
.\" HREF	.\" HREF
\fBpcreposix\fP	\fBpcreposix\fP
.\"	.\"
documentation. Both of these APIs define a set of C function calls. A C++	documentation. Both of these APIs define a set of C function calls. A C++
wrapper is also distributed with PCRE. It is documented in the	wrapper (again for the 8-bit library only) is also distributed with PCRE. It is
	documented in the
.\" HREF	.\" HREF
\fBpcrecpp\fP	\fBpcrecpp\fP
.\"	.\"
page.	page.
.P	.P
The native API C function prototypes are defined in the header file	The native API C function prototypes are defined in the header file
\fBpcre.h\fP, and on Unix systems the library itself is called \fBlibpcre\fP.	\fBpcre.h\fP, and on Unix-like systems the (8-bit) library itself is called
It can normally be accessed by adding \fB-lpcre\fP to the command for linking	\fBlibpcre\fP. It can normally be accessed by adding \fB-lpcre\fP to the
an application that uses PCRE. The header file defines the macros PCRE_MAJOR	command for linking an application that uses PCRE. The header file defines the
and PCRE_MINOR to contain the major and minor release numbers for the library.	macros PCRE_MAJOR and PCRE_MINOR to contain the major and minor release numbers
Applications can use these to include support for different releases of PCRE.	for the library. Applications can use these to include support for different
	releases of PCRE.
.P	.P
In a Windows environment, if you want to statically link an application program	In a Windows environment, if you want to statically link an application program
against a non-dll \fBpcre.a\fP file, you must define PCRE_STATIC before	against a non-dll \fBpcre.a\fP file, you must define PCRE_STATIC before
Line 218 specialist use. Most commonly, no special tables are p	Line 253 specialist use. Most commonly, no special tables are p
internal tables that are generated when PCRE is built are used.	internal tables that are generated when PCRE is built are used.
.P	.P
The function \fBpcre_fullinfo()\fP is used to find out information about a	The function \fBpcre_fullinfo()\fP is used to find out information about a
compiled pattern; \fBpcre_info()\fP is an obsolete version that returns only	compiled pattern. The function \fBpcre_version()\fP returns a pointer to a
some of the available information, but is retained for backwards compatibility.	string containing the version of PCRE and its date of release.
The function \fBpcre_version()\fP returns a pointer to a string containing the
version of PCRE and its date of release.
.P	.P
The function \fBpcre_refcount()\fP maintains a reference count in a data block	The function \fBpcre_refcount()\fP maintains a reference count in a data block
containing a compiled pattern. This is provided for the benefit of	containing a compiled pattern. This is provided for the benefit of
Line 332 which it was compiled. Details are given in the	Line 365 which it was compiled. Details are given in the
.\" HREF	.\" HREF
\fBpcreprecompile\fP	\fBpcreprecompile\fP
.\"	.\"
documentation. However, compiling a regular expression with one version of PCRE	documentation, which includes a description of the
for use with a different version is not guaranteed to work and may cause	\fBpcre_pattern_to_host_byte_order()\fP function. However, compiling a regular
crashes.	expression with one version of PCRE for use with a different version is not
	guaranteed to work and may cause crashes.
.	.
.	.
.SH "CHECKING BUILD-TIME OPTIONS"	.SH "CHECKING BUILD-TIME OPTIONS"
Line 351 documentation has more details about these optional fe	Line 385 documentation has more details about these optional fe
.P	.P
The first argument for \fBpcre_config()\fP is an integer, specifying which	The first argument for \fBpcre_config()\fP is an integer, specifying which
information is required; the second argument is a pointer to a variable into	information is required; the second argument is a pointer to a variable into
which the information is placed. The following information is available:	which the information is placed. The returned value is zero on success, or the
	negative error code PCRE_ERROR_BADOPTION if the value in the first argument is
	not recognized. The following information is available:
.sp	.sp
PCRE_CONFIG_UTF8	PCRE_CONFIG_UTF8
.sp	.sp
The output is an integer that is set to one if UTF-8 support is available;	The output is an integer that is set to one if UTF-8 support is available;
otherwise it is set to zero.	otherwise it is set to zero. If this option is given to the 16-bit version of
	this function, \fBpcre16_config()\fP, the result is PCRE_ERROR_BADOPTION.
.sp	.sp
	PCRE_CONFIG_UTF16
	.sp
	The output is an integer that is set to one if UTF-16 support is available;
	otherwise it is set to zero. This value should normally be given to the 16-bit
	version of this function, \fBpcre16_config()\fP. If it is given to the 8-bit
	version of this function, the result is PCRE_ERROR_BADOPTION.
	.sp
PCRE_CONFIG_UNICODE_PROPERTIES	PCRE_CONFIG_UNICODE_PROPERTIES
.sp	.sp
The output is an integer that is set to one if support for Unicode character	The output is an integer that is set to one if support for Unicode character
Line 368 properties is available; otherwise it is set to zero.	Line 412 properties is available; otherwise it is set to zero.
The output is an integer that is set to one if support for just-in-time	The output is an integer that is set to one if support for just-in-time
compiling is available; otherwise it is set to zero.	compiling is available; otherwise it is set to zero.
.sp	.sp
	PCRE_CONFIG_JITTARGET
	.sp
	The output is a pointer to a zero-terminated "const char *" string. If JIT
	support is available, the string contains the name of the architecture for
	which the JIT compiler is configured, for example "x86 32bit (little endian +
	unaligned)". If JIT support is not available, the result is NULL.
	.sp
PCRE_CONFIG_NEWLINE	PCRE_CONFIG_NEWLINE
.sp	.sp
The output is an integer whose value specifies the default character sequence	The output is an integer whose value specifies the default character sequence
Line 387 or CRLF. The default can be overridden when a pattern	Line 438 or CRLF. The default can be overridden when a pattern
PCRE_CONFIG_LINK_SIZE	PCRE_CONFIG_LINK_SIZE
.sp	.sp
The output is an integer that contains the number of bytes used for internal	The output is an integer that contains the number of bytes used for internal
linkage in compiled regular expressions. The value is 2, 3, or 4. Larger values	linkage in compiled regular expressions. For the 8-bit library, the value can
allow larger regular expressions to be compiled, at the expense of slower	be 2, 3, or 4. For the 16-bit library, the value is either 2 or 4 and is still
matching. The default value of 2 is sufficient for all but the most massive	a number of bytes. The default value of 2 is sufficient for all but the most
patterns, since it allows the compiled pattern to be up to 64K in size.	massive patterns, since it allows the compiled pattern to be up to 64K in size.
	Larger values allow larger regular expressions to be compiled, at the expense
	of slower matching.
.sp	.sp
PCRE_CONFIG_POSIX_MALLOC_THRESHOLD	PCRE_CONFIG_POSIX_MALLOC_THRESHOLD
.sp	.sp
Line 484 not try to free it. Normally, the offset from the star	Line 537 not try to free it. Normally, the offset from the star
byte that was being processed when the error was discovered is placed in the	byte that was being processed when the error was discovered is placed in the
variable pointed to by \fIerroffset\fP, which must not be NULL (if it is, an	variable pointed to by \fIerroffset\fP, which must not be NULL (if it is, an
immediate error is given). However, for an invalid UTF-8 string, the offset is	immediate error is given). However, for an invalid UTF-8 string, the offset is
that of the first byte of the failing character. Also, some errors are not	that of the first byte of the failing character.
detected until checks are carried out when the whole pattern has been scanned;
in these cases the offset passed back is the length of the pattern.
.P	.P
Note that the offset is in bytes, not characters, even in UTF-8 mode. It may	Some errors are not detected until the whole pattern has been scanned; in these
sometimes point into the middle of a UTF-8 character.	cases, the offset passed back is the length of the pattern. Note that the
	offset is in bytes, not characters, even in UTF-8 mode. It may sometimes point
	into the middle of a UTF-8 character.
.P	.P
If \fBpcre_compile2()\fP is used instead of \fBpcre_compile()\fP, and the	If \fBpcre_compile2()\fP is used instead of \fBpcre_compile()\fP, and the
\fIerrorcodeptr\fP argument is not NULL, a non-zero error code number is	\fIerrorcodeptr\fP argument is not NULL, a non-zero error code number is
Line 689 preceding sequences should be recognized. Setting PCRE	Line 742 preceding sequences should be recognized. Setting PCRE
that any Unicode newline sequence should be recognized. The Unicode newline	that any Unicode newline sequence should be recognized. The Unicode newline
sequences are the three just mentioned, plus the single characters VT (vertical	sequences are the three just mentioned, plus the single characters VT (vertical
tab, U+000B), FF (formfeed, U+000C), NEL (next line, U+0085), LS (line	tab, U+000B), FF (formfeed, U+000C), NEL (next line, U+0085), LS (line
separator, U+2028), and PS (paragraph separator, U+2029). The last two are	separator, U+2028), and PS (paragraph separator, U+2029). For the 8-bit
recognized only in UTF-8 mode.	library, the last two are recognized only in UTF-8 mode.
.P	.P
The newline setting in the options word uses three bits that are treated	The newline setting in the options word uses three bits that are treated
as a number, giving eight possibilities. Currently only six are used (default	as a number, giving eight possibilities. Currently only six are used (default
Line 755 with Perl. It can also be set by a (?U) option setting	Line 808 with Perl. It can also be set by a (?U) option setting
PCRE_UTF8	PCRE_UTF8
.sp	.sp
This option causes PCRE to regard both the pattern and the subject as strings	This option causes PCRE to regard both the pattern and the subject as strings
of UTF-8 characters instead of single-byte character strings. However, it is	of UTF-8 characters instead of single-byte strings. However, it is available
available only when PCRE is built to include UTF-8 support. If not, the use	only when PCRE is built to include UTF support. If not, the use of this option
of this option provokes an error. Details of how this option changes the	provokes an error. Details of how this option changes the behaviour of PCRE are
behaviour of PCRE are given in the	given in the
.\" HREF	.\" HREF
\fBpcreunicode\fP	\fBpcreunicode\fP
.\"	.\"
Line 766 page.	Line 819 page.
.sp	.sp
PCRE_NO_UTF8_CHECK	PCRE_NO_UTF8_CHECK
.sp	.sp
When PCRE_UTF8 is set, the validity of the pattern as a UTF-8 string is	When PCRE_UTF8 is set, the validity of the pattern as a UTF-8
automatically checked. There is a discussion about the	string is automatically checked. There is a discussion about the
.\" HTML <a href="pcre.html#utf8strings">	.\" HTML <a href="pcreunicode.html#utf8strings">
.\" </a>	.\" </a>
validity of UTF-8 strings	validity of UTF-8 strings
.\"	.\"
in the main	in the
.\" HREF	.\" HREF
\fBpcre\fP	\fBpcreunicode\fP
.\"	.\"
page. If an invalid UTF-8 sequence of bytes is found, \fBpcre_compile()\fP	page. If an invalid UTF-8 sequence is found, \fBpcre_compile()\fP returns an
returns an error. If you already know that your pattern is valid, and you want	error. If you already know that your pattern is valid, and you want to skip
to skip this check for performance reasons, you can set the PCRE_NO_UTF8_CHECK	this check for performance reasons, you can set the PCRE_NO_UTF8_CHECK option.
option. When it is set, the effect of passing an invalid UTF-8 string as a	When it is set, the effect of passing an invalid UTF-8 string as a pattern is
pattern is undefined. It may cause your program to crash. Note that this option	undefined. It may cause your program to crash. Note that this option can also
can also be passed to \fBpcre_exec()\fP and \fBpcre_dfa_exec()\fP, to suppress	be passed to \fBpcre_exec()\fP and \fBpcre_dfa_exec()\fP, to suppress the
the UTF-8 validity checking of subject strings.	validity checking of subject strings.
.	.
.	.
.SH "COMPILATION ERROR CODES"	.SH "COMPILATION ERROR CODES"
Line 790 the UTF-8 validity checking of subject strings.	Line 843 the UTF-8 validity checking of subject strings.
.sp	.sp
The following table lists the error codes than may be returned by	The following table lists the error codes than may be returned by
\fBpcre_compile2()\fP, along with the error messages that may be returned by	\fBpcre_compile2()\fP, along with the error messages that may be returned by
both compiling functions. As PCRE has developed, some error codes have fallen	both compiling functions. Note that error messages are always 8-bit ASCII
out of use. To avoid confusion, they have not been re-used.	strings, even in 16-bit mode. As PCRE has developed, some error codes have
	fallen out of use. To avoid confusion, they have not been re-used.
.sp	.sp
0 no error	0 no error
1 \e at end of pattern	1 \e at end of pattern
Line 825 out of use. To avoid confusion, they have not been re-	Line 879 out of use. To avoid confusion, they have not been re-
29 (?R or (?[+-]digits must be followed by )	29 (?R or (?[+-]digits must be followed by )
30 unknown POSIX class name	30 unknown POSIX class name
31 POSIX collating elements are not supported	31 POSIX collating elements are not supported
32 this version of PCRE is not compiled with PCRE_UTF8 support	32 this version of PCRE is compiled without UTF support
33 [this code is not in use]	33 [this code is not in use]
34 character value in \ex{...} sequence is too large	34 character value in \ex{...} sequence is too large
35 invalid condition (?(0)	35 invalid condition (?(0)
Line 837 out of use. To avoid confusion, they have not been re-	Line 891 out of use. To avoid confusion, they have not been re-
41 unrecognized character after (?P	41 unrecognized character after (?P
42 syntax error in subpattern name (missing terminator)	42 syntax error in subpattern name (missing terminator)
43 two named subpatterns have the same name	43 two named subpatterns have the same name
44 invalid UTF-8 string	44 invalid UTF-8 string (specifically UTF-8)
45 support for \eP, \ep, and \eX has not been compiled	45 support for \eP, \ep, and \eX has not been compiled
46 malformed \eP or \ep sequence	46 malformed \eP or \ep sequence
47 unknown property name after \eP or \ep	47 unknown property name after \eP or \ep
48 subpattern name is too long (maximum 32 characters)	48 subpattern name is too long (maximum 32 characters)
49 too many named subpatterns (maximum 10000)	49 too many named subpatterns (maximum 10000)
50 [this code is not in use]	50 [this code is not in use]
51 octal value is greater than \e377 (not in UTF-8 mode)	51 octal value is greater than \e377 in 8-bit non-UTF-8 mode
52 internal error: overran compiling workspace	52 internal error: overran compiling workspace
53 internal error: previously-checked referenced subpattern	53 internal error: previously-checked referenced subpattern
not found	not found
Line 863 out of use. To avoid confusion, they have not been re-	Line 917 out of use. To avoid confusion, they have not been re-
65 different names for subpatterns of the same number are	65 different names for subpatterns of the same number are
not allowed	not allowed
66 (*MARK) must have an argument	66 (*MARK) must have an argument
67 this version of PCRE is not compiled with PCRE_UCP support	67 this version of PCRE is not compiled with Unicode property
	support
68 \ec must be followed by an ASCII character	68 \ec must be followed by an ASCII character
69 \ek is not followed by a braced, angle-bracketed, or quoted name	69 \ek is not followed by a braced, angle-bracketed, or quoted name
	70 internal error: unknown opcode in find_fixedlength()
	71 \eN is not supported in a class
	72 too many forward references
	73 disallowed Unicode code point (>= 0xd800 && <= 0xdfff)
	74 invalid UTF-16 string (specifically UTF-16)
.sp	.sp
The numbers 32 and 10000 in errors 48 and 49 are defaults; different values may	The numbers 32 and 10000 in errors 48 and 49 are defaults; different values may
be used if the limits were changed when PCRE was built.	be used if the limits were changed when PCRE was built.
Line 962 in a calling program via the \fBpcre_fullinfo()\fP fun	Line 1022 in a calling program via the \fBpcre_fullinfo()\fP fun
Studying a pattern is also useful for non-anchored patterns that do not have a	Studying a pattern is also useful for non-anchored patterns that do not have a
single fixed starting character. A bitmap of possible starting bytes is	single fixed starting character. A bitmap of possible starting bytes is
created. This speeds up finding a position in the subject at which to start	created. This speeds up finding a position in the subject at which to start
matching.	matching. (In 16-bit mode, the bitmap is used for 16-bit values less than 256.)
.P	.P
These two optimizations apply to both \fBpcre_exec()\fP and	These two optimizations apply to both \fBpcre_exec()\fP and
\fBpcre_dfa_exec()\fP. However, they are not used by \fBpcre_exec()\fP if	\fBpcre_dfa_exec()\fP. However, they are not used by \fBpcre_exec()\fP if
Line 985 below.	Line 1045 below.
.sp	.sp
PCRE handles caseless matching, and determines whether characters are letters,	PCRE handles caseless matching, and determines whether characters are letters,
digits, or whatever, by reference to a set of tables, indexed by character	digits, or whatever, by reference to a set of tables, indexed by character
value. When running in UTF-8 mode, this applies only to characters with codes	value. When running in UTF-8 mode, this applies only to characters
less than 128. By default, higher-valued codes never match escapes such as \ew	with codes less than 128. By default, higher-valued codes never match escapes
or \ed, but they can be tested with \ep if PCRE is built with Unicode character	such as \ew or \ed, but they can be tested with \ep if PCRE is built with
property support. Alternatively, the PCRE_UCP option can be set at compile	Unicode character property support. Alternatively, the PCRE_UCP option can be
time; this causes \ew and friends to use Unicode property support instead of	set at compile time; this causes \ew and friends to use Unicode property
built-in tables. The use of locales with Unicode is discouraged. If you are	support instead of built-in tables. The use of locales with Unicode is
handling characters with codes greater than 128, you should either use UTF-8	discouraged. If you are handling characters with codes greater than 128, you
and Unicode, or use locales, but not try to mix the two.	should either use UTF-8 and Unicode, or use locales, but not try to mix the
	two.
.P	.P
PCRE contains an internal set of tables that are used when the final argument	PCRE contains an internal set of tables that are used when the final argument
of \fBpcre_compile()\fP is NULL. These are sufficient for many applications.	of \fBpcre_compile()\fP is NULL. These are sufficient for many applications.
Line 1046 below in the section on matching a pattern.	Line 1107 below in the section on matching a pattern.
.B int \fIwhat\fP, void *\fIwhere\fP);	.B int \fIwhat\fP, void *\fIwhere\fP);
.PP	.PP
The \fBpcre_fullinfo()\fP function returns information about a compiled	The \fBpcre_fullinfo()\fP function returns information about a compiled
pattern. It replaces the obsolete \fBpcre_info()\fP function, which is	pattern. It replaces the \fBpcre_info()\fP function, which was removed from the
nevertheless retained for backwards compability (and is documented below).	library at version 8.30, after more than 10 years of obsolescence.
.P	.P
The first argument for \fBpcre_fullinfo()\fP is a pointer to the compiled	The first argument for \fBpcre_fullinfo()\fP is a pointer to the compiled
pattern. The second argument is the result of \fBpcre_study()\fP, or NULL if	pattern. The second argument is the result of \fBpcre_study()\fP, or NULL if
Line 1056 information is required, and the fourth argument is a	Line 1117 information is required, and the fourth argument is a
to receive the data. The yield of the function is zero for success, or one of	to receive the data. The yield of the function is zero for success, or one of
the following negative numbers:	the following negative numbers:
.sp	.sp
PCRE_ERROR_NULL the argument \fIcode\fP was NULL	PCRE_ERROR_NULL the argument \fIcode\fP was NULL
the argument \fIwhere\fP was NULL	the argument \fIwhere\fP was NULL
PCRE_ERROR_BADMAGIC the "magic number" was not found	PCRE_ERROR_BADMAGIC the "magic number" was not found
PCRE_ERROR_BADOPTION the value of \fIwhat\fP was invalid	PCRE_ERROR_BADENDIANNESS the pattern was compiled with different
	endianness
	PCRE_ERROR_BADOPTION the value of \fIwhat\fP was invalid
.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 an simple
check against passing an arbitrary memory pointer. Here is a typical call of	check against passing an arbitrary memory pointer. The endianness error can
\fBpcre_fullinfo()\fP, to obtain the length of the compiled pattern:	occur if a compiled pattern is saved and reloaded on a different host. Here is
	a typical call of \fBpcre_fullinfo()\fP, to obtain the length of the compiled
	pattern:
.sp	.sp
int rc;	int rc;
size_t length;	size_t length;
Line 1097 a NULL table pointer.	Line 1162 a NULL table pointer.
.sp	.sp
PCRE_INFO_FIRSTBYTE	PCRE_INFO_FIRSTBYTE
.sp	.sp
Return information about the first byte of any matched string, for a	Return information about the first data unit of any matched string, for a
non-anchored pattern. The fourth argument should point to an \fBint\fP	non-anchored pattern. (The name of this option refers to the 8-bit library,
variable. (This option used to be called PCRE_INFO_FIRSTCHAR; the old name is	where data units are bytes.) The fourth argument should point to an \fBint\fP
still recognized for backwards compatibility.)	variable.
.P	.P
If there is a fixed first byte, for example, from a pattern such as	If there is a fixed first value, for example, the letter "c" from a pattern
(cat\|cow\|coyote), its value is returned. Otherwise, if either	such as (cat\|cow\|coyote), its value is returned. In the 8-bit library, the
	value is always less than 256; in the 16-bit library the value can be up to
	0xffff.
	.P
	If there is no fixed first value, and if either
.sp	.sp
(a) the pattern was compiled with the PCRE_MULTILINE option, and every branch	(a) the pattern was compiled with the PCRE_MULTILINE option, and every branch
starts with "^", or	starts with "^", or
Line 1118 returned. For anchored patterns, -2 is returned.	Line 1187 returned. For anchored patterns, -2 is returned.
PCRE_INFO_FIRSTTABLE	PCRE_INFO_FIRSTTABLE
.sp	.sp
If the pattern was studied, and this resulted in the construction of a 256-bit	If the pattern was studied, and this resulted in the construction of a 256-bit
table indicating a fixed set of bytes for the first byte in any matching	table indicating a fixed set of values for the first data unit in any matching
string, a pointer to the table is returned. Otherwise NULL is returned. The	string, a pointer to the table is returned. Otherwise NULL is returned. The
fourth argument should point to an \fBunsigned char *\fP variable.	fourth argument should point to an \fBunsigned char *\fP variable.
.sp	.sp
Line 1155 argument should point to a \fBsize_t\fP variable.	Line 1224 argument should point to a \fBsize_t\fP variable.
.sp	.sp
PCRE_INFO_LASTLITERAL	PCRE_INFO_LASTLITERAL
.sp	.sp
Return the value of the rightmost literal byte that must exist in any matched	Return the value of the rightmost literal data unit that must exist in any
string, other than at its start, if such a byte has been recorded. The fourth	matched string, other than at its start, if such a value has been recorded. The
argument should point to an \fBint\fP variable. If there is no such byte, -1 is	fourth argument should point to an \fBint\fP variable. If there is no such
returned. For anchored patterns, a last literal byte is recorded only if it	value, -1 is returned. For anchored patterns, a last literal value is recorded
follows something of variable length. For example, for the pattern	only if it follows something of variable length. For example, for the pattern
/^a\ed+z\ed+/ the returned value is "z", but for /^a\edz\ed/ the returned value	/^a\ed+z\ed+/ the returned value is "z", but for /^a\edz\ed/ the returned value
is -1.	is -1.
.sp	.sp
Line 1167 is -1.	Line 1236 is -1.
.sp	.sp
If the pattern was studied and a minimum length for matching subject strings	If the pattern was studied and a minimum length for matching subject strings
was computed, its value is returned. Otherwise the returned value is -1. The	was computed, its value is returned. Otherwise the returned value is -1. The
value is a number of characters, not bytes (this may be relevant in UTF-8	value is a number of characters, which in UTF-8 mode may be different from the
mode). The fourth argument should point to an \fBint\fP variable. A	number of bytes. The fourth argument should point to an \fBint\fP variable. A
non-negative value is a lower bound to the length of any matching string. There	non-negative value is a lower bound to the length of any matching string. There
may not be any strings of that length that do actually match, but every string	may not be any strings of that length that do actually match, but every string
that does match is at least that long.	that does match is at least that long.
Line 1191 The map consists of a number of fixed-size entries. PC	Line 1260 The map consists of a number of fixed-size entries. PC
the number of entries, and PCRE_INFO_NAMEENTRYSIZE gives the size of each	the number of entries, and PCRE_INFO_NAMEENTRYSIZE gives the size of each
entry; both of these return an \fBint\fP value. The entry size depends on the	entry; both of these return an \fBint\fP value. The entry size depends on the
length of the longest name. PCRE_INFO_NAMETABLE returns a pointer to the first	length of the longest name. PCRE_INFO_NAMETABLE returns a pointer to the first
entry of the table (a pointer to \fBchar\fP). The first two bytes of each entry	entry of the table. This is a pointer to \fBchar\fP in the 8-bit library, where
are the number of the capturing parenthesis, most significant byte first. The	the first two bytes of each entry are the number of the capturing parenthesis,
rest of the entry is the corresponding name, zero terminated.	most significant byte first. In the 16-bit library, the pointer points to
	16-bit data units, the first of which contains the parenthesis number. The rest
	of the entry is the corresponding name, zero terminated.
.P	.P
The names are in alphabetical order. Duplicate names may appear if (?\| is used	The names are in alphabetical order. Duplicate names may appear if (?\| is used
to create multiple groups with the same number, as described in the	to create multiple groups with the same number, as described in the
Line 1212 table in the order in which they were found in the pat	Line 1283 table in the order in which they were found in the pat
necessarily the case because later subpatterns may have lower numbers.	necessarily the case because later subpatterns may have lower numbers.
.P	.P
As a simple example of the name/number table, consider the following pattern	As a simple example of the name/number table, consider the following pattern
(assume PCRE_EXTENDED is set, so white space - including newlines - is	after compilation by the 8-bit library (assume PCRE_EXTENDED is set, so white
ignored):	space - including newlines - is ignored):
.sp	.sp
.\" JOIN	.\" JOIN
(?<date> (?<year>(\ed\ed)?\ed\ed) -	(?<date> (?<year>(\ed\ed)?\ed\ed) -
Line 1268 For such patterns, the PCRE_ANCHORED bit is set in the	Line 1339 For such patterns, the PCRE_ANCHORED bit is set in the
.sp	.sp
PCRE_INFO_SIZE	PCRE_INFO_SIZE
.sp	.sp
Return the size of the compiled pattern. The fourth argument should point to a	Return the size of the compiled pattern in bytes (for both libraries). The
\fBsize_t\fP variable. This value does not include the size of the \fBpcre\fP	fourth argument should point to a \fBsize_t\fP variable. This value does not
structure that is returned by \fBpcre_compile()\fP. The value that is passed as	include the size of the \fBpcre\fP structure that is returned by
the argument to \fBpcre_malloc()\fP when \fBpcre_compile()\fP is getting memory	\fBpcre_compile()\fP. The value that is passed as the argument to
in which to place the compiled data is the value returned by this option plus	\fBpcre_malloc()\fP when \fBpcre_compile()\fP is getting memory in which to
the size of the \fBpcre\fP structure. Studying a compiled pattern, with or	place the compiled data is the value returned by this option plus the size of
without JIT, does not alter the value returned by this option.	the \fBpcre\fP structure. Studying a compiled pattern, with or without JIT,
	does not alter the value returned by this option.
.sp	.sp
PCRE_INFO_STUDYSIZE	PCRE_INFO_STUDYSIZE
.sp	.sp
Return the size of the data block pointed to by the \fIstudy_data\fP field in a	Return the size in bytes of the data block pointed to by the \fIstudy_data\fP
\fBpcre_extra\fP block. If \fBpcre_extra\fP is NULL, or there is no study data,	field in a \fBpcre_extra\fP block. If \fBpcre_extra\fP is NULL, or there is no
zero is returned. The fourth argument should point to a \fBsize_t\fP variable.	study data, zero is returned. The fourth argument should point to a
The \fIstudy_data\fP field is set by \fBpcre_study()\fP to record information	\fBsize_t\fP variable. The \fIstudy_data\fP field is set by \fBpcre_study()\fP
that will speed up matching (see the section entitled	to record information that will speed up matching (see the section entitled
.\" HTML <a href="#studyingapattern">	.\" HTML <a href="#studyingapattern">
.\" </a>	.\" </a>
"Studying a pattern"	"Studying a pattern"
Line 1295 is made available via this option so that it can be sa	Line 1367 is made available via this option so that it can be sa
documentation for details).	documentation for details).
.	.
.	.
.SH "OBSOLETE INFO FUNCTION"
.rs
.sp
.B int pcre_info(const pcre \fIcode\fP, int \fIoptptr\fP, int
.B *\fIfirstcharptr\fP);
.PP
The \fBpcre_info()\fP function is now obsolete because its interface is too
restrictive to return all the available data about a compiled pattern. New
programs should use \fBpcre_fullinfo()\fP instead. The yield of
\fBpcre_info()\fP is the number of capturing subpatterns, or one of the
following negative numbers:
.sp
PCRE_ERROR_NULL the argument \fIcode\fP was NULL
PCRE_ERROR_BADMAGIC the "magic number" was not found
.sp
If the \fIoptptr\fP argument is not NULL, a copy of the options with which the
pattern was compiled is placed in the integer it points to (see
PCRE_INFO_OPTIONS above).
.P
If the pattern is not anchored and the \fIfirstcharptr\fP argument is not NULL,
it is used to pass back information about the first character of any matched
string (see PCRE_INFO_FIRSTBYTE above).
.
.
.SH "REFERENCE COUNTS"	.SH "REFERENCE COUNTS"
.rs	.rs
.sp	.sp
Line 1411 fields (not necessarily in this order):	Line 1459 fields (not necessarily in this order):
const unsigned char *\fItables\fP;	const unsigned char *\fItables\fP;
unsigned char **\fImark\fP;	unsigned char **\fImark\fP;
.sp	.sp
	In the 16-bit version of this structure, the \fImark\fP field has type
	"PCRE_UCHAR16 **".
	.P
The \fIflags\fP field is a bitmap that specifies which of the other fields	The \fIflags\fP field is a bitmap that specifies which of the other fields
are set. The flag bits are:	are set. The flag bits are:
.sp	.sp
Line 1495 called. See the	Line 1546 called. See the
documentation for a discussion of saving compiled patterns for later use.	documentation for a discussion of saving compiled patterns for later use.
.P	.P
If PCRE_EXTRA_MARK is set in the \fIflags\fP field, the \fImark\fP field must	If PCRE_EXTRA_MARK is set in the \fIflags\fP field, the \fImark\fP field must
be set to point to a \fBchar *\fP variable. If the pattern contains any	be set to point to a suitable variable. If the pattern contains any
backtracking control verbs such as (*MARK:NAME), and the execution ends up with	backtracking control verbs such as (*MARK:NAME), and the execution ends up with
a name to pass back, a pointer to the name string (zero terminated) is placed	a name to pass back, a pointer to the name string (zero terminated) is placed
in the variable pointed to by the \fImark\fP field. The names are within the	in the variable pointed to by the \fImark\fP field. The names are within the
compiled pattern; if you wish to retain such a name you must copy it before	compiled pattern; if you wish to retain such a name you must copy it before
freeing the memory of a compiled pattern. If there is no name to pass back, the	freeing the memory of a compiled pattern. If there is no name to pass back, the
variable pointed to by the \fImark\fP field set to NULL. For details of the	variable pointed to by the \fImark\fP field is set to NULL. For details of the
backtracking control verbs, see the section entitled	backtracking control verbs, see the section entitled
.\" HTML <a href="pcrepattern#backtrackcontrol">	.\" HTML <a href="pcrepattern#backtrackcontrol">
.\" </a>	.\" </a>
Line 1684 string is automatically checked when \fBpcre_exec()\fP	Line 1735 string is automatically checked when \fBpcre_exec()\fP
The value of \fIstartoffset\fP is also checked to ensure that it points to the	The value of \fIstartoffset\fP is also checked to ensure that it points to the
start of a UTF-8 character. There is a discussion about the validity of UTF-8	start of a UTF-8 character. There is a discussion about the validity of UTF-8
strings in the	strings in the
.\" HTML <a href="pcre.html#utf8strings">
.\" </a>
section on UTF-8 support
.\"
in the main
.\" HREF	.\" HREF
\fBpcre\fP	\fBpcreunicode\fP
.\"	.\"
page. If an invalid UTF-8 sequence of bytes is found, \fBpcre_exec()\fP returns	page. If an invalid sequence of bytes is found, \fBpcre_exec()\fP returns the
the error PCRE_ERROR_BADUTF8 or, if PCRE_PARTIAL_HARD is set and the problem is	error PCRE_ERROR_BADUTF8 or, if PCRE_PARTIAL_HARD is set and the problem is a
a truncated UTF-8 character at the end of the subject, PCRE_ERROR_SHORTUTF8. In	truncated character at the end of the subject, PCRE_ERROR_SHORTUTF8. In both
both cases, information about the precise nature of the error may also be	cases, information about the precise nature of the error may also be returned
returned (see the descriptions of these errors in the section entitled \fIError	(see the descriptions of these errors in the section entitled \fIError return
return values from\fP \fBpcre_exec()\fP	values from\fP \fBpcre_exec()\fP
.\" HTML <a href="#errorlist">	.\" HTML <a href="#errorlist">
.\" </a>	.\" </a>
below).	below).
Line 1711 checks for performance reasons, you can set the PCRE_N	Line 1757 checks for performance reasons, you can set the PCRE_N
calling \fBpcre_exec()\fP. You might want to do this for the second and	calling \fBpcre_exec()\fP. You might want to do this for the second and
subsequent calls to \fBpcre_exec()\fP if you are making repeated calls to find	subsequent calls to \fBpcre_exec()\fP if you are making repeated calls to find
all the matches in a single subject string. However, you should be sure that	all the matches in a single subject string. However, you should be sure that
the value of \fIstartoffset\fP points to the start of a UTF-8 character (or the	the value of \fIstartoffset\fP points to the start of a character (or the end
end of the subject). When PCRE_NO_UTF8_CHECK is set, the effect of passing an	of the subject). When PCRE_NO_UTF8_CHECK is set, the effect of passing an
invalid UTF-8 string as a subject or an invalid value of \fIstartoffset\fP is	invalid string as a subject or an invalid value of \fIstartoffset\fP is
undefined. Your program may crash.	undefined. Your program may crash.
.sp	.sp
PCRE_PARTIAL_HARD	PCRE_PARTIAL_HARD
Line 1748 documentation.	Line 1794 documentation.
.rs	.rs
.sp	.sp
The subject string is passed to \fBpcre_exec()\fP as a pointer in	The subject string is passed to \fBpcre_exec()\fP as a pointer in
\fIsubject\fP, a length (in bytes) in \fIlength\fP, and a starting byte offset	\fIsubject\fP, a length in bytes in \fIlength\fP, and a starting byte offset
in \fIstartoffset\fP. If this is negative or greater than the length of the	in \fIstartoffset\fP. If this is negative or greater than the length of the
subject, \fBpcre_exec()\fP returns PCRE_ERROR_BADOFFSET. When the starting	subject, \fBpcre_exec()\fP returns PCRE_ERROR_BADOFFSET. When the starting
offset is zero, the search for a match starts at the beginning of the subject,	offset is zero, the search for a match starts at the beginning of the subject,
Line 2043 the just-in-time processing stack is not large enough.	Line 2089 the just-in-time processing stack is not large enough.
\fBpcrejit\fP	\fBpcrejit\fP
.\"	.\"
documentation for more details.	documentation for more details.
	.sp
	PCRE_ERROR_BADMODE (-28)
	.sp
	This error is given if a pattern that was compiled by the 8-bit library is
	passed to a 16-bit library function, or vice versa.
	.sp
	PCRE_ERROR_BADENDIANNESS (-29)
	.sp
	This error is given if a pattern that was compiled and saved is reloaded on a
	host with different endianness. The utility function
	\fBpcre_pattern_to_host_byte_order()\fP can be used to convert such a pattern
	so that it runs on the new host.
.P	.P
Error numbers -16 to -20 and -22 are not used by \fBpcre_exec()\fP.	Error numbers -16 to -20 and -22 are not used by \fBpcre_exec()\fP.
.	.
Line 2051 Error numbers -16 to -20 and -22 are not used by \fBpc	Line 2109 Error numbers -16 to -20 and -22 are not used by \fBpc
.SS "Reason codes for invalid UTF-8 strings"	.SS "Reason codes for invalid UTF-8 strings"
.rs	.rs
.sp	.sp
	This section applies only to the 8-bit library. The corresponding information
	for the 16-bit library is given in the
	.\" HREF
	\fBpcre16\fP
	.\"
	page.
	.P
When \fBpcre_exec()\fP returns either PCRE_ERROR_BADUTF8 or	When \fBpcre_exec()\fP returns either PCRE_ERROR_BADUTF8 or
PCRE_ERROR_SHORTUTF8, and the size of the output vector (\fIovecsize\fP) is at	PCRE_ERROR_SHORTUTF8, and the size of the output vector (\fIovecsize\fP) is at
least 2, the offset of the start of the invalid UTF-8 character is placed in	least 2, the offset of the start of the invalid UTF-8 character is placed in
Line 2348 other alternatives. Ultimately, when it runs out of ma	Line 2413 other alternatives. Ultimately, when it runs out of ma
will yield PCRE_ERROR_NOMATCH.	will yield PCRE_ERROR_NOMATCH.
.	.
.	.
	.SH "OBTAINING AN ESTIMATE OF STACK USAGE"
	.rs
	.sp
	Matching certain patterns using \fBpcre_exec()\fP can use a lot of process
	stack, which in certain environments can be rather limited in size. Some users
	find it helpful to have an estimate of the amount of stack that is used by
	\fBpcre_exec()\fP, to help them set recursion limits, as described in the
	.\" HREF
	\fBpcrestack\fP
	.\"
	documentation. The estimate that is output by \fBpcretest\fP when called with
	the \fB-m\fP and \fB-C\fP options is obtained by calling \fBpcre_exec\fP with
	the values NULL, NULL, NULL, -999, and -999 for its first five arguments.
	.P
	Normally, if its first argument is NULL, \fBpcre_exec()\fP immediately returns
	the negative error code PCRE_ERROR_NULL, but with this special combination of
	arguments, it returns instead a negative number whose absolute value is the
	approximate stack frame size in bytes. (A negative number is used so that it is
	clear that no match has happened.) The value is approximate because in some
	cases, recursive calls to \fBpcre_exec()\fP occur when there are one or two
	additional variables on the stack.
	.P
	If PCRE has been compiled to use the heap instead of the stack for recursion,
	the value returned is the size of each block that is obtained from the heap.
	.
	.
.\" HTML <a name="dfamatch"></a>	.\" HTML <a name="dfamatch"></a>
.SH "MATCHING A PATTERN: THE ALTERNATIVE FUNCTION"	.SH "MATCHING A PATTERN: THE ALTERNATIVE FUNCTION"
.rs	.rs
Line 2534 extremely rare, as a vector of size 1000 is used.	Line 2625 extremely rare, as a vector of size 1000 is used.
.SH "SEE ALSO"	.SH "SEE ALSO"
.rs	.rs
.sp	.sp
\fBpcrebuild\fP(3), \fBpcrecallout\fP(3), \fBpcrecpp(3)\fP(3),	\fBpcre16\fP(3), \fBpcrebuild\fP(3), \fBpcrecallout\fP(3), \fBpcrecpp(3)\fP(3),
\fBpcrematching\fP(3), \fBpcrepartial\fP(3), \fBpcreposix\fP(3),	\fBpcrematching\fP(3), \fBpcrepartial\fP(3), \fBpcreposix\fP(3),
\fBpcreprecompile\fP(3), \fBpcresample\fP(3), \fBpcrestack\fP(3).	\fBpcreprecompile\fP(3), \fBpcresample\fP(3), \fBpcrestack\fP(3).
.	.
Line 2553 Cambridge CB2 3QH, England.	Line 2644 Cambridge CB2 3QH, England.
.rs	.rs
.sp	.sp
.nf	.nf
Last updated: 02 December 2011	Last updated: 21 January 2012
Copyright (c) 1997-2011 University of Cambridge.	Copyright (c) 1997-2012 University of Cambridge.
.fi	.fi

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>

Removed from v.1.1
changed lines
	Added in v.1.1.1.2