/[pcre]/code/trunk/doc/pcreapi.3
ViewVC logotype

Diff of /code/trunk/doc/pcreapi.3

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 691 by ph10, Sun Sep 11 14:31:21 2011 UTC revision 1022 by ph10, Tue Aug 28 12:28:15 2012 UTC
# Line 1  Line 1 
1  .TH PCREAPI 3  .TH PCREAPI 3 "28 August 2012" "PCRE 8.32"
2  .SH NAME  .SH NAME
3  PCRE - Perl-compatible regular expressions  PCRE - Perl-compatible regular expressions
4    .sp
5    .B #include <pcre.h>
6    .
7    .
8  .SH "PCRE NATIVE API BASIC FUNCTIONS"  .SH "PCRE NATIVE API BASIC FUNCTIONS"
9  .rs  .rs
10  .sp  .sp
 .B #include <pcre.h>  
 .PP  
11  .SM  .SM
12  .B pcre *pcre_compile(const char *\fIpattern\fP, int \fIoptions\fP,  .B pcre *pcre_compile(const char *\fIpattern\fP, int \fIoptions\fP,
13  .ti +5n  .ti +5n
# Line 32  PCRE - Perl-compatible regular expressio Line 34  PCRE - Perl-compatible regular expressio
34  .B "const char *\fIsubject\fP," int \fIlength\fP, int \fIstartoffset\fP,  .B "const char *\fIsubject\fP," int \fIlength\fP, int \fIstartoffset\fP,
35  .ti +5n  .ti +5n
36  .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  
 .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);  
37  .PP  .PP
38  .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,"
39  .ti +5n  .ti +5n
# Line 52  PCRE - Perl-compatible regular expressio Line 42  PCRE - Perl-compatible regular expressio
42  .B int \fIoptions\fP, int *\fIovector\fP, int \fIovecsize\fP,  .B int \fIoptions\fP, int *\fIovector\fP, int \fIovecsize\fP,
43  .ti +5n  .ti +5n
44  .B int *\fIworkspace\fP, int \fIwscount\fP);  .B int *\fIworkspace\fP, int \fIwscount\fP);
45  .PP  .
46    .
47    .SH "PCRE NATIVE API STRING EXTRACTION FUNCTIONS"
48    .rs
49    .sp
50  .B int pcre_copy_named_substring(const pcre *\fIcode\fP,  .B int pcre_copy_named_substring(const pcre *\fIcode\fP,
51  .ti +5n  .ti +5n
52  .B const char *\fIsubject\fP, int *\fIovector\fP,  .B const char *\fIsubject\fP, int *\fIovector\fP,
# Line 96  PCRE - Perl-compatible regular expressio Line 90  PCRE - Perl-compatible regular expressio
90  .B void pcre_free_substring(const char *\fIstringptr\fP);  .B void pcre_free_substring(const char *\fIstringptr\fP);
91  .PP  .PP
92  .B void pcre_free_substring_list(const char **\fIstringptr\fP);  .B void pcre_free_substring_list(const char **\fIstringptr\fP);
93    .
94    .
95    .SH "PCRE NATIVE API AUXILIARY FUNCTIONS"
96    .rs
97    .sp
98    .B pcre_jit_stack *pcre_jit_stack_alloc(int \fIstartsize\fP, int \fImaxsize\fP);
99    .PP
100    .B void pcre_jit_stack_free(pcre_jit_stack *\fIstack\fP);
101    .PP
102    .B void pcre_assign_jit_stack(pcre_extra *\fIextra\fP,
103    .ti +5n
104    .B pcre_jit_callback \fIcallback\fP, void *\fIdata\fP);
105  .PP  .PP
106  .B const unsigned char *pcre_maketables(void);  .B const unsigned char *pcre_maketables(void);
107  .PP  .PP
# Line 103  PCRE - Perl-compatible regular expressio Line 109  PCRE - Perl-compatible regular expressio
109  .ti +5n  .ti +5n
110  .B int \fIwhat\fP, void *\fIwhere\fP);  .B int \fIwhat\fP, void *\fIwhere\fP);
111  .PP  .PP
 .B int pcre_info(const pcre *\fIcode\fP, int *\fIoptptr\fP, int  
 .B *\fIfirstcharptr\fP);  
 .PP  
112  .B int pcre_refcount(pcre *\fIcode\fP, int \fIadjust\fP);  .B int pcre_refcount(pcre *\fIcode\fP, int \fIadjust\fP);
113  .PP  .PP
114  .B int pcre_config(int \fIwhat\fP, void *\fIwhere\fP);  .B int pcre_config(int \fIwhat\fP, void *\fIwhere\fP);
115  .PP  .PP
116  .B char *pcre_version(void);  .B const char *pcre_version(void);
117    .PP
118    .B int pcre_pattern_to_host_byte_order(pcre *\fIcode\fP,
119    .ti +5n
120    .B pcre_extra *\fIextra\fP, const unsigned char *\fItables\fP);
121  .  .
122  .  .
123  .SH "PCRE NATIVE API INDIRECTED FUNCTIONS"  .SH "PCRE NATIVE API INDIRECTED FUNCTIONS"
# Line 127  PCRE - Perl-compatible regular expressio Line 134  PCRE - Perl-compatible regular expressio
134  .B int (*pcre_callout)(pcre_callout_block *);  .B int (*pcre_callout)(pcre_callout_block *);
135  .  .
136  .  .
137    .SH "PCRE 8-BIT AND 16-BIT LIBRARIES"
138    .rs
139    .sp
140    From release 8.30, PCRE can be compiled as a library for handling 16-bit
141    character strings as well as, or instead of, the original library that handles
142    8-bit character strings. To avoid too much complication, this document
143    describes the 8-bit versions of the functions, with only occasional references
144    to the 16-bit library.
145    .P
146    The 16-bit functions operate in the same way as their 8-bit counterparts; they
147    just use different data types for their arguments and results, and their names
148    start with \fBpcre16_\fP instead of \fBpcre_\fP. For every option that has UTF8
149    in its name (for example, PCRE_UTF8), there is a corresponding 16-bit name with
150    UTF8 replaced by UTF16. This facility is in fact just cosmetic; the 16-bit
151    option names define the same bit values.
152    .P
153    References to bytes and UTF-8 in this document should be read as references to
154    16-bit data quantities and UTF-16 when using the 16-bit library, unless
155    specified otherwise. More details of the specific differences for the 16-bit
156    library are given in the
157    .\" HREF
158    \fBpcre16\fP
159    .\"
160    page.
161    .
162    .
163  .SH "PCRE API OVERVIEW"  .SH "PCRE API OVERVIEW"
164  .rs  .rs
165  .sp  .sp
166  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
167  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
168  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
169  in the  functionality. They are described in the
170  .\" HREF  .\" HREF
171  \fBpcreposix\fP  \fBpcreposix\fP
172  .\"  .\"
173  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++
174  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
175    documented in the
176  .\" HREF  .\" HREF
177  \fBpcrecpp\fP  \fBpcrecpp\fP
178  .\"  .\"
179  page.  page.
180  .P  .P
181  The native API C function prototypes are defined in the header file  The native API C function prototypes are defined in the header file
182  \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
183  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
184  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
185  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
186  Applications can use these to include support for different releases of PCRE.  for the library. Applications can use these to include support for different
187    releases of PCRE.
188  .P  .P
189  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
190  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 specia Line 253  specialist use. Most commonly, no specia
253  internal tables that are generated when PCRE is built are used.  internal tables that are generated when PCRE is built are used.
254  .P  .P
255  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
256  compiled pattern; \fBpcre_info()\fP is an obsolete version that returns only  compiled pattern. The function \fBpcre_version()\fP returns a pointer to a
257  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.  
258  .P  .P
259  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
260  containing a compiled pattern. This is provided for the benefit of  containing a compiled pattern. This is provided for the benefit of
# Line 269  PCRE supports five different conventions Line 302  PCRE supports five different conventions
302  strings: a single CR (carriage return) character, a single LF (linefeed)  strings: a single CR (carriage return) character, a single LF (linefeed)
303  character, the two-character sequence CRLF, any of the three preceding, or any  character, the two-character sequence CRLF, any of the three preceding, or any
304  Unicode newline sequence. The Unicode newline sequences are the three just  Unicode newline sequence. The Unicode newline sequences are the three just
305  mentioned, plus the single characters VT (vertical tab, U+000B), FF (formfeed,  mentioned, plus the single characters VT (vertical tab, U+000B), FF (form feed,
306  U+000C), NEL (next line, U+0085), LS (line separator, U+2028), and PS  U+000C), NEL (next line, U+0085), LS (line separator, U+2028), and PS
307  (paragraph separator, U+2029).  (paragraph separator, U+2029).
308  .P  .P
# Line 332  which it was compiled. Details are given Line 365  which it was compiled. Details are given
365  .\" HREF  .\" HREF
366  \fBpcreprecompile\fP  \fBpcreprecompile\fP
367  .\"  .\"
368  documentation. However, compiling a regular expression with one version of PCRE  documentation, which includes a description of the
369  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
370  crashes.  expression with one version of PCRE for use with a different version is not
371    guaranteed to work and may cause crashes.
372  .  .
373  .  .
374  .SH "CHECKING BUILD-TIME OPTIONS"  .SH "CHECKING BUILD-TIME OPTIONS"
# Line 351  documentation has more details about the Line 385  documentation has more details about the
385  .P  .P
386  The first argument for \fBpcre_config()\fP is an integer, specifying which  The first argument for \fBpcre_config()\fP is an integer, specifying which
387  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
388  which the information is placed. The following information is available:  which the information is placed. The returned value is zero on success, or the
389    negative error code PCRE_ERROR_BADOPTION if the value in the first argument is
390    not recognized. The following information is available:
391  .sp  .sp
392    PCRE_CONFIG_UTF8    PCRE_CONFIG_UTF8
393  .sp  .sp
394  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;
395  otherwise it is set to zero.  otherwise it is set to zero. If this option is given to the 16-bit version of
396    this function, \fBpcre16_config()\fP, the result is PCRE_ERROR_BADOPTION.
397    .sp
398      PCRE_CONFIG_UTF16
399    .sp
400    The output is an integer that is set to one if UTF-16 support is available;
401    otherwise it is set to zero. This value should normally be given to the 16-bit
402    version of this function, \fBpcre16_config()\fP. If it is given to the 8-bit
403    version of this function, the result is PCRE_ERROR_BADOPTION.
404  .sp  .sp
405    PCRE_CONFIG_UNICODE_PROPERTIES    PCRE_CONFIG_UNICODE_PROPERTIES
406  .sp  .sp
# Line 368  properties is available; otherwise it is Line 412  properties is available; otherwise it is
412  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
413  compiling is available; otherwise it is set to zero.  compiling is available; otherwise it is set to zero.
414  .sp  .sp
415      PCRE_CONFIG_JITTARGET
416    .sp
417    The output is a pointer to a zero-terminated "const char *" string. If JIT
418    support is available, the string contains the name of the architecture for
419    which the JIT compiler is configured, for example "x86 32bit (little endian +
420    unaligned)". If JIT support is not available, the result is NULL.
421    .sp
422    PCRE_CONFIG_NEWLINE    PCRE_CONFIG_NEWLINE
423  .sp  .sp
424  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 w Line 438  or CRLF. The default can be overridden w
438    PCRE_CONFIG_LINK_SIZE    PCRE_CONFIG_LINK_SIZE
439  .sp  .sp
440  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
441  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
442  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
443  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
444  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.
445    Larger values allow larger regular expressions to be compiled, at the expense
446    of slower matching.
447  .sp  .sp
448    PCRE_CONFIG_POSIX_MALLOC_THRESHOLD    PCRE_CONFIG_POSIX_MALLOC_THRESHOLD
449  .sp  .sp
# Line 473  documentation). For those options that c Line 526  documentation). For those options that c
526  the pattern, the contents of the \fIoptions\fP argument specifies their  the pattern, the contents of the \fIoptions\fP argument specifies their
527  settings at the start of compilation and execution. The PCRE_ANCHORED,  settings at the start of compilation and execution. The PCRE_ANCHORED,
528  PCRE_BSR_\fIxxx\fP, PCRE_NEWLINE_\fIxxx\fP, PCRE_NO_UTF8_CHECK, and  PCRE_BSR_\fIxxx\fP, PCRE_NEWLINE_\fIxxx\fP, PCRE_NO_UTF8_CHECK, and
529  PCRE_NO_START_OPT options can be set at the time of matching as well as at  PCRE_NO_START_OPTIMIZE options can be set at the time of matching as well as at
530  compile time.  compile time.
531  .P  .P
532  If \fIerrptr\fP is NULL, \fBpcre_compile()\fP returns NULL immediately.  If \fIerrptr\fP is NULL, \fBpcre_compile()\fP returns NULL immediately.
# Line 484  not try to free it. Normally, the offset Line 537  not try to free it. Normally, the offset
537  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
538  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
539  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
540  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.  
541  .P  .P
542  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
543  sometimes point into the middle of a UTF-8 character.  cases, the offset passed back is the length of the pattern. Note that the
544    offset is in bytes, not characters, even in UTF-8 mode. It may sometimes point
545    into the middle of a UTF-8 character.
546  .P  .P
547  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
548  \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 589  documentation. Line 642  documentation.
642  .sp  .sp
643    PCRE_EXTENDED    PCRE_EXTENDED
644  .sp  .sp
645  If this bit is set, whitespace data characters in the pattern are totally  If this bit is set, white space data characters in the pattern are totally
646  ignored except when escaped or inside a character class. Whitespace does not  ignored except when escaped or inside a character class. White space does not
647  include the VT character (code 11). In addition, characters between an  include the VT character (code 11). In addition, characters between an
648  unescaped # outside a character class and the next newline, inclusive, are also  unescaped # outside a character class and the next newline, inclusive, are also
649  ignored. This is equivalent to Perl's /x option, and it can be changed within a  ignored. This is equivalent to Perl's /x option, and it can be changed within a
# Line 608  comment is a literal newline sequence in Line 661  comment is a literal newline sequence in
661  happen to represent a newline do not count.  happen to represent a newline do not count.
662  .P  .P
663  This option makes it possible to include comments inside complicated patterns.  This option makes it possible to include comments inside complicated patterns.
664  Note, however, that this applies only to data characters. Whitespace characters  Note, however, that this applies only to data characters. White space characters
665  may never appear within special character sequences in a pattern, for example  may never appear within special character sequences in a pattern, for example
666  within the sequence (?( that introduces a conditional subpattern.  within the sequence (?( that introduces a conditional subpattern.
667  .sp  .sp
# Line 643  character). Thus, the pattern AB]CD beco Line 696  character). Thus, the pattern AB]CD beco
696  string (by default this causes the current matching alternative to fail). A  string (by default this causes the current matching alternative to fail). A
697  pattern such as (\e1)(a) succeeds when this option is set (assuming it can find  pattern such as (\e1)(a) succeeds when this option is set (assuming it can find
698  an "a" in the subject), whereas it fails by default, for Perl compatibility.  an "a" in the subject), whereas it fails by default, for Perl compatibility.
699    .P
700    (3) \eU matches an upper case "U" character; by default \eU causes a compile
701    time error (Perl uses \eU to upper case subsequent characters).
702    .P
703    (4) \eu matches a lower case "u" character unless it is followed by four
704    hexadecimal digits, in which case the hexadecimal number defines the code point
705    to match. By default, \eu causes a compile time error (Perl uses it to upper
706    case the following character).
707    .P
708    (5) \ex matches a lower case "x" character unless it is followed by two
709    hexadecimal digits, in which case the hexadecimal number defines the code point
710    to match. By default, as in Perl, a hexadecimal number is always expected after
711    \ex, but it may have zero, one, or two digits (so, for example, \exz matches a
712    binary zero character followed by z).
713  .sp  .sp
714    PCRE_MULTILINE    PCRE_MULTILINE
715  .sp  .sp
# Line 674  CRLF sequence. Setting PCRE_NEWLINE_ANYC Line 741  CRLF sequence. Setting PCRE_NEWLINE_ANYC
741  preceding sequences should be recognized. Setting PCRE_NEWLINE_ANY specifies  preceding sequences should be recognized. Setting PCRE_NEWLINE_ANY specifies
742  that any Unicode newline sequence should be recognized. The Unicode newline  that any Unicode newline sequence should be recognized. The Unicode newline
743  sequences are the three just mentioned, plus the single characters VT (vertical  sequences are the three just mentioned, plus the single characters VT (vertical
744  tab, U+000B), FF (formfeed, U+000C), NEL (next line, U+0085), LS (line  tab, U+000B), FF (form feed, U+000C), NEL (next line, U+0085), LS (line
745  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
746  recognized only in UTF-8 mode.  library, the last two are recognized only in UTF-8 mode.
747  .P  .P
748  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
749  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 686  PCRE_NEWLINE_CR with PCRE_NEWLINE_LF is Line 753  PCRE_NEWLINE_CR with PCRE_NEWLINE_LF is
753  other combinations may yield unused numbers and cause an error.  other combinations may yield unused numbers and cause an error.
754  .P  .P
755  The only time that a line break in a pattern is specially recognized when  The only time that a line break in a pattern is specially recognized when
756  compiling is when PCRE_EXTENDED is set. CR and LF are whitespace characters,  compiling is when PCRE_EXTENDED is set. CR and LF are white space characters,
757  and so are ignored in this mode. Also, an unescaped # outside a character class  and so are ignored in this mode. Also, an unescaped # outside a character class
758  indicates a comment that lasts until after the next line break sequence. In  indicates a comment that lasts until after the next line break sequence. In
759  other circumstances, line break sequences in patterns are treated as literal  other circumstances, line break sequences in patterns are treated as literal
# Line 741  with Perl. It can also be set by a (?U) Line 808  with Perl. It can also be set by a (?U)
808    PCRE_UTF8    PCRE_UTF8
809  .sp  .sp
810  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
811  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
812  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
813  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
814  behaviour of PCRE are given in the  given in the
815  .\" HREF  .\" HREF
816  \fBpcreunicode\fP  \fBpcreunicode\fP
817  .\"  .\"
# Line 752  page. Line 819  page.
819  .sp  .sp
820    PCRE_NO_UTF8_CHECK    PCRE_NO_UTF8_CHECK
821  .sp  .sp
822  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
823  automatically checked. There is a discussion about the  string is automatically checked. There is a discussion about the
824  .\" HTML <a href="pcre.html#utf8strings">  .\" HTML <a href="pcreunicode.html#utf8strings">
825  .\" </a>  .\" </a>
826  validity of UTF-8 strings  validity of UTF-8 strings
827  .\"  .\"
828  in the main  in the
829  .\" HREF  .\" HREF
830  \fBpcre\fP  \fBpcreunicode\fP
831  .\"  .\"
832  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
833  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
834  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.
835  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
836  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
837  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
838  the UTF-8 validity checking of subject strings.  validity checking of subject strings.
839  .  .
840  .  .
841  .SH "COMPILATION ERROR CODES"  .SH "COMPILATION ERROR CODES"
# Line 776  the UTF-8 validity checking of subject s Line 843  the UTF-8 validity checking of subject s
843  .sp  .sp
844  The following table lists the error codes than may be returned by  The following table lists the error codes than may be returned by
845  \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
846  both compiling functions. As PCRE has developed, some error codes have fallen  both compiling functions. Note that error messages are always 8-bit ASCII
847  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
848    fallen out of use. To avoid confusion, they have not been re-used.
849  .sp  .sp
850     0  no error     0  no error
851     1  \e at end of pattern     1  \e at end of pattern
# Line 811  out of use. To avoid confusion, they hav Line 879  out of use. To avoid confusion, they hav
879    29  (?R or (?[+-]digits must be followed by )    29  (?R or (?[+-]digits must be followed by )
880    30  unknown POSIX class name    30  unknown POSIX class name
881    31  POSIX collating elements are not supported    31  POSIX collating elements are not supported
882    32  this version of PCRE is not compiled with PCRE_UTF8 support    32  this version of PCRE is compiled without UTF support
883    33  [this code is not in use]    33  [this code is not in use]
884    34  character value in \ex{...} sequence is too large    34  character value in \ex{...} sequence is too large
885    35  invalid condition (?(0)    35  invalid condition (?(0)
# Line 823  out of use. To avoid confusion, they hav Line 891  out of use. To avoid confusion, they hav
891    41  unrecognized character after (?P    41  unrecognized character after (?P
892    42  syntax error in subpattern name (missing terminator)    42  syntax error in subpattern name (missing terminator)
893    43  two named subpatterns have the same name    43  two named subpatterns have the same name
894    44  invalid UTF-8 string    44  invalid UTF-8 string (specifically UTF-8)
895    45  support for \eP, \ep, and \eX has not been compiled    45  support for \eP, \ep, and \eX has not been compiled
896    46  malformed \eP or \ep sequence    46  malformed \eP or \ep sequence
897    47  unknown property name after \eP or \ep    47  unknown property name after \eP or \ep
898    48  subpattern name is too long (maximum 32 characters)    48  subpattern name is too long (maximum 32 characters)
899    49  too many named subpatterns (maximum 10000)    49  too many named subpatterns (maximum 10000)
900    50  [this code is not in use]    50  [this code is not in use]
901    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
902    52  internal error: overran compiling workspace    52  internal error: overran compiling workspace
903    53  internal error: previously-checked referenced subpattern    53  internal error: previously-checked referenced subpattern
904          not found          not found
# Line 849  out of use. To avoid confusion, they hav Line 917  out of use. To avoid confusion, they hav
917    65  different names for subpatterns of the same number are    65  different names for subpatterns of the same number are
918          not allowed          not allowed
919    66  (*MARK) must have an argument    66  (*MARK) must have an argument
920    67  this version of PCRE is not compiled with PCRE_UCP support    67  this version of PCRE is not compiled with Unicode property
921            support
922    68  \ec must be followed by an ASCII character    68  \ec must be followed by an ASCII character
923    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
924      70  internal error: unknown opcode in find_fixedlength()
925      71  \eN is not supported in a class
926      72  too many forward references
927      73  disallowed Unicode code point (>= 0xd800 && <= 0xdfff)
928      74  invalid UTF-16 string (specifically UTF-16)
929      75  name is too long in (*MARK), (*PRUNE), (*SKIP), or (*THEN)
930      76  character value in \eu.... sequence is too large
931  .sp  .sp
932  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
933  be used if the limits were changed when PCRE was built.  be used if the limits were changed when PCRE was built.
# Line 884  below Line 960  below
960  in the section on matching a pattern.  in the section on matching a pattern.
961  .P  .P
962  If studying the pattern does not produce any useful information,  If studying the pattern does not produce any useful information,
963  \fBpcre_study()\fP returns NULL. In that circumstance, if the calling program  \fBpcre_study()\fP returns NULL by default. In that circumstance, if the
964  wants to pass any of the other fields to \fBpcre_exec()\fP or  calling program wants to pass any of the other fields to \fBpcre_exec()\fP or
965  \fBpcre_dfa_exec()\fP, it must set up its own \fBpcre_extra\fP block.  \fBpcre_dfa_exec()\fP, it must set up its own \fBpcre_extra\fP block. However,
966  .P  if \fBpcre_study()\fP is called with the PCRE_STUDY_EXTRA_NEEDED option, it
967  The second argument of \fBpcre_study()\fP contains option bits. There is only  returns a \fBpcre_extra\fP block even if studying did not find any additional
968  one option: PCRE_STUDY_JIT_COMPILE. If this is set, and the just-in-time  information. It may still return NULL, however, if an error occurs in
969  compiler is available, the pattern is further compiled into machine code that  \fBpcre_study()\fP.
970  executes much faster than the \fBpcre_exec()\fP matching function. If  .P
971  the just-in-time compiler is not available, this option is ignored. All other  The second argument of \fBpcre_study()\fP contains option bits. There are three
972  bits in the \fIoptions\fP argument must be zero.  further options in addition to PCRE_STUDY_EXTRA_NEEDED:
973    .sp
974      PCRE_STUDY_JIT_COMPILE
975      PCRE_STUDY_JIT_PARTIAL_HARD_COMPILE
976      PCRE_STUDY_JIT_PARTIAL_SOFT_COMPILE
977    .sp
978    If any of these are set, and the just-in-time compiler is available, the
979    pattern is further compiled into machine code that executes much faster than
980    the \fBpcre_exec()\fP interpretive matching function. If the just-in-time
981    compiler is not available, these options are ignored. All undefined bits in the
982    \fIoptions\fP argument must be zero.
983  .P  .P
984  JIT compilation is a heavyweight optimization. It can take some time for  JIT compilation is a heavyweight optimization. It can take some time for
985  patterns to be analyzed, and for one-off matches and simple patterns the  patterns to be analyzed, and for one-off matches and simple patterns the
# Line 917  When you are finished with a pattern, yo Line 1003  When you are finished with a pattern, yo
1003  study data by calling \fBpcre_free_study()\fP. This function was added to the  study data by calling \fBpcre_free_study()\fP. This function was added to the
1004  API for release 8.20. For earlier versions, the memory could be freed with  API for release 8.20. For earlier versions, the memory could be freed with
1005  \fBpcre_free()\fP, just like the pattern itself. This will still work in cases  \fBpcre_free()\fP, just like the pattern itself. This will still work in cases
1006  where PCRE_STUDY_JIT_COMPILE is not used, but it is advisable to change to the  where JIT optimization is not used, but it is advisable to change to the new
1007  new function when convenient.  function when convenient.
1008  .P  .P
1009  This is a typical way in which \fBpcre_study\fP() is used (except that in a  This is a typical way in which \fBpcre_study\fP() is used (except that in a
1010  real application there should be tests for errors):  real application there should be tests for errors):
# Line 940  real application there should be tests f Line 1026  real application there should be tests f
1026  Studying a pattern does two things: first, a lower bound for the length of  Studying a pattern does two things: first, a lower bound for the length of
1027  subject string that is needed to match the pattern is computed. This does not  subject string that is needed to match the pattern is computed. This does not
1028  mean that there are any strings of that length that match, but it does  mean that there are any strings of that length that match, but it does
1029  guarantee that no shorter strings match. The value is used by  guarantee that no shorter strings match. The value is used to avoid wasting
1030  \fBpcre_exec()\fP and \fBpcre_dfa_exec()\fP to avoid wasting time by trying to  time by trying to match strings that are shorter than the lower bound. You can
1031  match strings that are shorter than the lower bound. You can find out the value  find out the value in a calling program via the \fBpcre_fullinfo()\fP function.
 in a calling program via the \fBpcre_fullinfo()\fP function.  
1032  .P  .P
1033  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
1034  single fixed starting character. A bitmap of possible starting bytes is  single fixed starting character. A bitmap of possible starting bytes is
1035  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
1036  matching.  matching. (In 16-bit mode, the bitmap is used for 16-bit values less than 256.)
1037  .P  .P
1038  These two optimizations apply to both \fBpcre_exec()\fP and  These two optimizations apply to both \fBpcre_exec()\fP and
1039  \fBpcre_dfa_exec()\fP. However, they are not used by \fBpcre_exec()\fP if  \fBpcre_dfa_exec()\fP, and the information is also used by the JIT compiler.
1040  \fBpcre_study()\fP is called with the PCRE_STUDY_JIT_COMPILE option, and  The optimizations can be disabled by setting the PCRE_NO_START_OPTIMIZE option
1041  just-in-time compiling is successful. The optimizations can be disabled by  when calling \fBpcre_exec()\fP or \fBpcre_dfa_exec()\fP, but if this is done,
1042  setting the PCRE_NO_START_OPTIMIZE option when calling \fBpcre_exec()\fP or  JIT execution is also disabled. You might want to do this if your pattern
1043  \fBpcre_dfa_exec()\fP. You might want to do this if your pattern contains  contains callouts or (*MARK) and you want to make use of these facilities in
1044  callouts or (*MARK) (which cannot be handled by the JIT compiler), and you want  cases where matching fails. See the discussion of PCRE_NO_START_OPTIMIZE
 to make use of these facilities in cases where matching fails. See the  
 discussion of PCRE_NO_START_OPTIMIZE  
1045  .\" HTML <a href="#execoptions">  .\" HTML <a href="#execoptions">
1046  .\" </a>  .\" </a>
1047  below.  below.
# Line 971  below. Line 1054  below.
1054  .sp  .sp
1055  PCRE handles caseless matching, and determines whether characters are letters,  PCRE handles caseless matching, and determines whether characters are letters,
1056  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
1057  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
1058  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
1059  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
1060  property support. Alternatively, the PCRE_UCP option can be set at compile  Unicode character property support. Alternatively, the PCRE_UCP option can be
1061  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
1062  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
1063  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
1064  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
1065    two.
1066  .P  .P
1067  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
1068  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 1032  below in the section on matching a patte Line 1116  below in the section on matching a patte
1116  .B int \fIwhat\fP, void *\fIwhere\fP);  .B int \fIwhat\fP, void *\fIwhere\fP);
1117  .PP  .PP
1118  The \fBpcre_fullinfo()\fP function returns information about a compiled  The \fBpcre_fullinfo()\fP function returns information about a compiled
1119  pattern. It replaces the obsolete \fBpcre_info()\fP function, which is  pattern. It replaces the \fBpcre_info()\fP function, which was removed from the
1120  nevertheless retained for backwards compability (and is documented below).  library at version 8.30, after more than 10 years of obsolescence.
1121  .P  .P
1122  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
1123  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 1042  information is required, and the fourth Line 1126  information is required, and the fourth
1126  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
1127  the following negative numbers:  the following negative numbers:
1128  .sp  .sp
1129    PCRE_ERROR_NULL       the argument \fIcode\fP was NULL    PCRE_ERROR_NULL           the argument \fIcode\fP was NULL
1130                          the argument \fIwhere\fP was NULL                              the argument \fIwhere\fP was NULL
1131    PCRE_ERROR_BADMAGIC   the "magic number" was not found    PCRE_ERROR_BADMAGIC       the "magic number" was not found
1132    PCRE_ERROR_BADOPTION  the value of \fIwhat\fP was invalid    PCRE_ERROR_BADENDIANNESS  the pattern was compiled with different
1133                                endianness
1134      PCRE_ERROR_BADOPTION      the value of \fIwhat\fP was invalid
1135  .sp  .sp
1136  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
1137  check against passing an arbitrary memory pointer. Here is a typical call of  check against passing an arbitrary memory pointer. The endianness error can
1138  \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
1139    a typical call of \fBpcre_fullinfo()\fP, to obtain the length of the compiled
1140    pattern:
1141  .sp  .sp
1142    int rc;    int rc;
1143    size_t length;    size_t length;
# Line 1083  a NULL table pointer. Line 1171  a NULL table pointer.
1171  .sp  .sp
1172    PCRE_INFO_FIRSTBYTE    PCRE_INFO_FIRSTBYTE
1173  .sp  .sp
1174  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
1175  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,
1176  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
1177  still recognized for backwards compatibility.)  variable.
1178    .P
1179    If there is a fixed first value, for example, the letter "c" from a pattern
1180    such as (cat|cow|coyote), its value is returned. In the 8-bit library, the
1181    value is always less than 256; in the 16-bit library the value can be up to
1182    0xffff.
1183  .P  .P
1184  If there is a fixed first byte, for example, from a pattern such as  If there is no fixed first value, and if either
 (cat|cow|coyote), its value is returned. Otherwise, if either  
1185  .sp  .sp
1186  (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
1187  starts with "^", or  starts with "^", or
# Line 1104  returned. For anchored patterns, -2 is r Line 1196  returned. For anchored patterns, -2 is r
1196    PCRE_INFO_FIRSTTABLE    PCRE_INFO_FIRSTTABLE
1197  .sp  .sp
1198  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
1199  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
1200  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
1201  fourth argument should point to an \fBunsigned char *\fP variable.  fourth argument should point to an \fBunsigned char *\fP variable.
1202  .sp  .sp
# Line 1122  Return 1 if the (?J) or (?-J) option set Line 1214  Return 1 if the (?J) or (?-J) option set
1214  .sp  .sp
1215    PCRE_INFO_JIT    PCRE_INFO_JIT
1216  .sp  .sp
1217  Return 1 if the pattern was studied with the PCRE_STUDY_JIT_COMPILE option, and  Return 1 if the pattern was studied with one of the JIT options, and
1218  just-in-time compiling was successful. The fourth argument should point to an  just-in-time compiling was successful. The fourth argument should point to an
1219  \fBint\fP variable. A return value of 0 means that JIT support is not available  \fBint\fP variable. A return value of 0 means that JIT support is not available
1220  in this version of PCRE, or that the pattern was not studied with the  in this version of PCRE, or that the pattern was not studied with a JIT option,
1221  PCRE_STUDY_JIT_COMPILE option, or that the JIT compiler could not handle this  or that the JIT compiler could not handle this particular pattern. See the
 particular pattern. See the  
1222  .\" HREF  .\" HREF
1223  \fBpcrejit\fP  \fBpcrejit\fP
1224  .\"  .\"
1225  documentation for details of what can and cannot be handled.  documentation for details of what can and cannot be handled.
1226  .sp  .sp
1227      PCRE_INFO_JITSIZE
1228    .sp
1229    If the pattern was successfully studied with a JIT option, return the size of
1230    the JIT compiled code, otherwise return zero. The fourth argument should point
1231    to a \fBsize_t\fP variable.
1232    .sp
1233    PCRE_INFO_LASTLITERAL    PCRE_INFO_LASTLITERAL
1234  .sp  .sp
1235  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
1236  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
1237  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
1238  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
1239  follows something of variable length. For example, for the pattern  only if it follows something of variable length. For example, for the pattern
1240  /^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
1241  is -1.  is -1.
1242  .sp  .sp
1243      PCRE_INFO_MAXLOOKBEHIND
1244    .sp
1245    Return the number of characters (NB not bytes) in the longest lookbehind
1246    assertion in the pattern. Note that the simple assertions \eb and \eB require a
1247    one-character lookbehind. This information is useful when doing multi-segment
1248    matching using the partial matching facilities.
1249    .sp
1250    PCRE_INFO_MINLENGTH    PCRE_INFO_MINLENGTH
1251  .sp  .sp
1252  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
1253  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
1254  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
1255  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
1256  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
1257  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
1258  that does match is at least that long.  that does match is at least that long.
# Line 1171  The map consists of a number of fixed-si Line 1275  The map consists of a number of fixed-si
1275  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
1276  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
1277  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
1278  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
1279  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,
1280  rest of the entry is the corresponding name, zero terminated.  most significant byte first. In the 16-bit library, the pointer points to
1281    16-bit data units, the first of which contains the parenthesis number. The rest
1282    of the entry is the corresponding name, zero terminated.
1283  .P  .P
1284  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
1285  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 1192  table in the order in which they were fo Line 1298  table in the order in which they were fo
1298  necessarily the case because later subpatterns may have lower numbers.  necessarily the case because later subpatterns may have lower numbers.
1299  .P  .P
1300  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
1301  (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
1302  ignored):  space - including newlines - is ignored):
1303  .sp  .sp
1304  .\" JOIN  .\" JOIN
1305    (?<date> (?<year>(\ed\ed)?\ed\ed) -    (?<date> (?<year>(\ed\ed)?\ed\ed) -
# Line 1248  For such patterns, the PCRE_ANCHORED bit Line 1354  For such patterns, the PCRE_ANCHORED bit
1354  .sp  .sp
1355    PCRE_INFO_SIZE    PCRE_INFO_SIZE
1356  .sp  .sp
1357  Return the size of the compiled pattern, that is, the value that was passed as  Return the size of the compiled pattern in bytes (for both libraries). The
1358  the argument to \fBpcre_malloc()\fP when PCRE was getting memory in which to  fourth argument should point to a \fBsize_t\fP variable. This value does not
1359  place the compiled data. The fourth argument should point to a \fBsize_t\fP  include the size of the \fBpcre\fP structure that is returned by
1360  variable.  \fBpcre_compile()\fP. The value that is passed as the argument to
1361    \fBpcre_malloc()\fP when \fBpcre_compile()\fP is getting memory in which to
1362    place the compiled data is the value returned by this option plus the size of
1363    the \fBpcre\fP structure. Studying a compiled pattern, with or without JIT,
1364    does not alter the value returned by this option.
1365  .sp  .sp
1366    PCRE_INFO_STUDYSIZE    PCRE_INFO_STUDYSIZE
1367  .sp  .sp
1368  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
1369  \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
1370  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
1371  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
1372  that will speed up matching (see the section entitled  to record information that will speed up matching (see the section entitled
1373  .\" HTML <a href="#studyingapattern">  .\" HTML <a href="#studyingapattern">
1374  .\" </a>  .\" </a>
1375  "Studying a pattern"  "Studying a pattern"
# Line 1272  is made available via this option so tha Line 1382  is made available via this option so tha
1382  documentation for details).  documentation for details).
1383  .  .
1384  .  .
 .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).  
 .  
 .  
1385  .SH "REFERENCE COUNTS"  .SH "REFERENCE COUNTS"
1386  .rs  .rs
1387  .sp  .sp
# Line 1331  is different. (This seems a highly unlik Line 1417  is different. (This seems a highly unlik
1417  The function \fBpcre_exec()\fP is called to match a subject string against a  The function \fBpcre_exec()\fP is called to match a subject string against a
1418  compiled pattern, which is passed in the \fIcode\fP argument. If the  compiled pattern, which is passed in the \fIcode\fP argument. If the
1419  pattern was studied, the result of the study should be passed in the  pattern was studied, the result of the study should be passed in the
1420  \fIextra\fP argument. This function is the main matching facility of the  \fIextra\fP argument. You can call \fBpcre_exec()\fP with the same \fIcode\fP
1421  library, and it operates in a Perl-like manner. For specialist use there is  and \fIextra\fP arguments as many times as you like, in order to match
1422  also an alternative matching function, which is described  different subject strings with the same pattern.
1423    .P
1424    This function is the main matching facility of the library, and it operates in
1425    a Perl-like manner. For specialist use there is also an alternative matching
1426    function, which is described
1427  .\" HTML <a href="#dfamatch">  .\" HTML <a href="#dfamatch">
1428  .\" </a>  .\" </a>
1429  below  below
# Line 1384  fields (not necessarily in this order): Line 1474  fields (not necessarily in this order):
1474    const unsigned char *\fItables\fP;    const unsigned char *\fItables\fP;
1475    unsigned char **\fImark\fP;    unsigned char **\fImark\fP;
1476  .sp  .sp
1477  The \fIflags\fP field is a bitmap that specifies which of the other fields  In the 16-bit version of this structure, the \fImark\fP field has type
1478  are set. The flag bits are:  "PCRE_UCHAR16 **".
1479    .P
1480    The \fIflags\fP field is used to specify which of the other fields are set. The
1481    flag bits are:
1482  .sp  .sp
1483    PCRE_EXTRA_STUDY_DATA    PCRE_EXTRA_CALLOUT_DATA
1484    PCRE_EXTRA_EXECUTABLE_JIT    PCRE_EXTRA_EXECUTABLE_JIT
1485      PCRE_EXTRA_MARK
1486    PCRE_EXTRA_MATCH_LIMIT    PCRE_EXTRA_MATCH_LIMIT
1487    PCRE_EXTRA_MATCH_LIMIT_RECURSION    PCRE_EXTRA_MATCH_LIMIT_RECURSION
1488    PCRE_EXTRA_CALLOUT_DATA    PCRE_EXTRA_STUDY_DATA
1489    PCRE_EXTRA_TABLES    PCRE_EXTRA_TABLES
   PCRE_EXTRA_MARK  
1490  .sp  .sp
1491  Other flag bits should be set to zero. The \fIstudy_data\fP field and sometimes  Other flag bits should be set to zero. The \fIstudy_data\fP field and sometimes
1492  the \fIexecutable_jit\fP field are set in the \fBpcre_extra\fP block that is  the \fIexecutable_jit\fP field are set in the \fBpcre_extra\fP block that is
1493  returned by \fBpcre_study()\fP, together with the appropriate flag bits. You  returned by \fBpcre_study()\fP, together with the appropriate flag bits. You
1494  should not set these yourself, but you may add to the block by setting the  should not set these yourself, but you may add to the block by setting other
1495  other fields and their corresponding flag bits.  fields and their corresponding flag bits.
1496  .P  .P
1497  The \fImatch_limit\fP field provides a means of preventing PCRE from using up a  The \fImatch_limit\fP field provides a means of preventing PCRE from using up a
1498  vast amount of resources when running patterns that are not going to match,  vast amount of resources when running patterns that are not going to match,
# Line 1414  patterns that are not anchored, the coun Line 1507  patterns that are not anchored, the coun
1507  in the subject string.  in the subject string.
1508  .P  .P
1509  When \fBpcre_exec()\fP is called with a pattern that was successfully studied  When \fBpcre_exec()\fP is called with a pattern that was successfully studied
1510  with the PCRE_STUDY_JIT_COMPILE option, the way that the matching is executed  with a JIT option, the way that the matching is executed is entirely different.
1511  is entirely different. However, there is still the possibility of runaway  However, there is still the possibility of runaway matching that goes on for a
1512  matching that goes on for a very long time, and so the \fImatch_limit\fP value  very long time, and so the \fImatch_limit\fP value is also used in this case
1513  is also used in this case (but in a different way) to limit how long the  (but in a different way) to limit how long the matching can continue.
 matching can continue.  
1514  .P  .P
1515  The default value for the limit can be set when PCRE is built; the default  The default value for the limit can be set when PCRE is built; the default
1516  default is 10 million, which handles all but the most extreme cases. You can  default is 10 million, which handles all but the most extreme cases. You can
# Line 1436  This limit is of use only if it is set s Line 1528  This limit is of use only if it is set s
1528  Limiting the recursion depth limits the amount of machine stack that can be  Limiting the recursion depth limits the amount of machine stack that can be
1529  used, or, when PCRE has been compiled to use memory on the heap instead of the  used, or, when PCRE has been compiled to use memory on the heap instead of the
1530  stack, the amount of heap memory that can be used. This limit is not relevant,  stack, the amount of heap memory that can be used. This limit is not relevant,
1531  and is ignored, if the pattern was successfully studied with  and is ignored, when matching is done using JIT compiled code.
 PCRE_STUDY_JIT_COMPILE.  
1532  .P  .P
1533  The default value for \fImatch_limit_recursion\fP can be set when PCRE is  The default value for \fImatch_limit_recursion\fP can be set when PCRE is
1534  built; the default default is the same value as the default for  built; the default default is the same value as the default for
# Line 1468  called. See the Line 1559  called. See the
1559  documentation for a discussion of saving compiled patterns for later use.  documentation for a discussion of saving compiled patterns for later use.
1560  .P  .P
1561  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
1562  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
1563  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
1564  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
1565  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
1566  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
1567  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
1568  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
1569  backtracking control verbs, see the section entitled  backtracking control verbs, see the section entitled
1570  .\" HTML <a href="pcrepattern#backtrackcontrol">  .\" HTML <a href="pcrepattern#backtrackcontrol">
1571  .\" </a>  .\" </a>
# Line 1494  documentation. Line 1585  documentation.
1585  The unused bits of the \fIoptions\fP argument for \fBpcre_exec()\fP must be  The unused bits of the \fIoptions\fP argument for \fBpcre_exec()\fP must be
1586  zero. The only bits that may be set are PCRE_ANCHORED, PCRE_NEWLINE_\fIxxx\fP,  zero. The only bits that may be set are PCRE_ANCHORED, PCRE_NEWLINE_\fIxxx\fP,
1587  PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NOTEMPTY_ATSTART,  PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NOTEMPTY_ATSTART,
1588  PCRE_NO_START_OPTIMIZE, PCRE_NO_UTF8_CHECK, PCRE_PARTIAL_SOFT, and  PCRE_NO_START_OPTIMIZE, PCRE_NO_UTF8_CHECK, PCRE_PARTIAL_HARD, and
1589  PCRE_PARTIAL_HARD.  PCRE_PARTIAL_SOFT.
1590  .P  .P
1591  If the pattern was successfully studied with the PCRE_STUDY_JIT_COMPILE option,  If the pattern was successfully studied with one of the just-in-time (JIT)
1592  the only supported options for JIT execution are PCRE_NO_UTF8_CHECK,  compile options, the only supported options for JIT execution are
1593  PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, and PCRE_NOTEMPTY_ATSTART. Note in  PCRE_NO_UTF8_CHECK, PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY,
1594  particular that partial matching is not supported. If an unsupported option is  PCRE_NOTEMPTY_ATSTART, PCRE_PARTIAL_HARD, and PCRE_PARTIAL_SOFT. If an
1595  used, JIT execution is disabled and the normal interpretive code in  unsupported option is used, JIT execution is disabled and the normal
1596  \fBpcre_exec()\fP is run.  interpretive code in \fBpcre_exec()\fP is run.
1597  .sp  .sp
1598    PCRE_ANCHORED    PCRE_ANCHORED
1599  .sp  .sp
# Line 1621  causing performance to suffer, but ensur Line 1712  causing performance to suffer, but ensur
1712  "no match", the callouts do occur, and that items such as (*COMMIT) and (*MARK)  "no match", the callouts do occur, and that items such as (*COMMIT) and (*MARK)
1713  are considered at every possible starting position in the subject string. If  are considered at every possible starting position in the subject string. If
1714  PCRE_NO_START_OPTIMIZE is set at compile time, it cannot be unset at matching  PCRE_NO_START_OPTIMIZE is set at compile time, it cannot be unset at matching
1715  time.  time. The use of PCRE_NO_START_OPTIMIZE disables JIT execution; when it is set,
1716    matching is always done using interpretively.
1717  .P  .P
1718  Setting PCRE_NO_START_OPTIMIZE can change the outcome of a matching operation.  Setting PCRE_NO_START_OPTIMIZE can change the outcome of a matching operation.
1719  Consider the pattern  Consider the pattern
# Line 1654  returned. Line 1746  returned.
1746  .sp  .sp
1747  When PCRE_UTF8 is set at compile time, the validity of the subject as a UTF-8  When PCRE_UTF8 is set at compile time, the validity of the subject as a UTF-8
1748  string is automatically checked when \fBpcre_exec()\fP is subsequently called.  string is automatically checked when \fBpcre_exec()\fP is subsequently called.
1749  The value of \fIstartoffset\fP is also checked to ensure that it points to the  The entire string is checked before any other processing takes place. The value
1750  start of a UTF-8 character. There is a discussion about the validity of UTF-8  of \fIstartoffset\fP is also checked to ensure that it points to the start of a
1751  strings in the  UTF-8 character. There is a discussion about the
1752  .\" HTML <a href="pcre.html#utf8strings">  .\" HTML <a href="pcreunicode.html#utf8strings">
1753  .\" </a>  .\" </a>
1754  section on UTF-8 support  validity of UTF-8 strings
1755  .\"  .\"
1756  in the main  in the
1757  .\" HREF  .\" HREF
1758  \fBpcre\fP  \fBpcreunicode\fP
1759  .\"  .\"
1760  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
1761  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
1762  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
1763  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
1764  returned (see the descriptions of these errors in the section entitled \fIError  (see the descriptions of these errors in the section entitled \fIError return
1765  return values from\fP \fBpcre_exec()\fP  values from\fP \fBpcre_exec()\fP
1766  .\" HTML <a href="#errorlist">  .\" HTML <a href="#errorlist">
1767  .\" </a>  .\" </a>
1768  below).  below).
# Line 1684  checks for performance reasons, you can Line 1776  checks for performance reasons, you can
1776  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
1777  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
1778  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
1779  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
1780  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
1781  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
1782  undefined. Your program may crash.  undefined. Your program may crash.
1783  .sp  .sp
1784    PCRE_PARTIAL_HARD    PCRE_PARTIAL_HARD
# Line 1721  documentation. Line 1813  documentation.
1813  .rs  .rs
1814  .sp  .sp
1815  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
1816  \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
1817  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
1818  subject, \fBpcre_exec()\fP returns PCRE_ERROR_BADOFFSET. When the starting  subject, \fBpcre_exec()\fP returns PCRE_ERROR_BADOFFSET. When the starting
1819  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 1809  string that it matched that is returned. Line 1901  string that it matched that is returned.
1901  .P  .P
1902  If the vector is too small to hold all the captured substring offsets, it is  If the vector is too small to hold all the captured substring offsets, it is
1903  used as far as possible (up to two-thirds of its length), and the function  used as far as possible (up to two-thirds of its length), and the function
1904  returns a value of zero. If neither the actual string matched not any captured  returns a value of zero. If neither the actual string matched nor any captured
1905  substrings are of interest, \fBpcre_exec()\fP may be called with \fIovector\fP  substrings are of interest, \fBpcre_exec()\fP may be called with \fIovector\fP
1906  passed as NULL and \fIovecsize\fP as zero. However, if the pattern contains  passed as NULL and \fIovecsize\fP as zero. However, if the pattern contains
1907  back references and the \fIovector\fP is not big enough to remember the related  back references and the \fIovector\fP is not big enough to remember the related
# Line 2009  time. Line 2101  time.
2101  .sp  .sp
2102    PCRE_ERROR_JIT_STACKLIMIT (-27)    PCRE_ERROR_JIT_STACKLIMIT (-27)
2103  .sp  .sp
2104  This error is returned when a pattern that was successfully studied using the  This error is returned when a pattern that was successfully studied using a
2105  PCRE_STUDY_JIT_COMPILE option is being matched, but the memory available for  JIT compile option is being matched, but the memory available for the
2106  the just-in-time processing stack is not large enough. See the  just-in-time processing stack is not large enough. See the
2107  .\" HREF  .\" HREF
2108  \fBpcrejit\fP  \fBpcrejit\fP
2109  .\"  .\"
2110  documentation for more details.  documentation for more details.
2111    .sp
2112      PCRE_ERROR_BADMODE        (-28)
2113    .sp
2114    This error is given if a pattern that was compiled by the 8-bit library is
2115    passed to a 16-bit library function, or vice versa.
2116    .sp
2117      PCRE_ERROR_BADENDIANNESS  (-29)
2118    .sp
2119    This error is given if a pattern that was compiled and saved is reloaded on a
2120    host with different endianness. The utility function
2121    \fBpcre_pattern_to_host_byte_order()\fP can be used to convert such a pattern
2122    so that it runs on the new host.
2123  .P  .P
2124  Error numbers -16 to -20 and -22 are not used by \fBpcre_exec()\fP.  Error numbers -16 to -20, -22, and -30 are not used by \fBpcre_exec()\fP.
2125  .  .
2126  .  .
2127  .\" HTML <a name="badutf8reasons"></a>  .\" HTML <a name="badutf8reasons"></a>
2128  .SS "Reason codes for invalid UTF-8 strings"  .SS "Reason codes for invalid UTF-8 strings"
2129  .rs  .rs
2130  .sp  .sp
2131    This section applies only to the 8-bit library. The corresponding information
2132    for the 16-bit library is given in the
2133    .\" HREF
2134    \fBpcre16\fP
2135    .\"
2136    page.
2137    .P
2138  When \fBpcre_exec()\fP returns either PCRE_ERROR_BADUTF8 or  When \fBpcre_exec()\fP returns either PCRE_ERROR_BADUTF8 or
2139  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
2140  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 2321  other alternatives. Ultimately, when it Line 2432  other alternatives. Ultimately, when it
2432  will yield PCRE_ERROR_NOMATCH.  will yield PCRE_ERROR_NOMATCH.
2433  .  .
2434  .  .
2435    .SH "OBTAINING AN ESTIMATE OF STACK USAGE"
2436    .rs
2437    .sp
2438    Matching certain patterns using \fBpcre_exec()\fP can use a lot of process
2439    stack, which in certain environments can be rather limited in size. Some users
2440    find it helpful to have an estimate of the amount of stack that is used by
2441    \fBpcre_exec()\fP, to help them set recursion limits, as described in the
2442    .\" HREF
2443    \fBpcrestack\fP
2444    .\"
2445    documentation. The estimate that is output by \fBpcretest\fP when called with
2446    the \fB-m\fP and \fB-C\fP options is obtained by calling \fBpcre_exec\fP with
2447    the values NULL, NULL, NULL, -999, and -999 for its first five arguments.
2448    .P
2449    Normally, if its first argument is NULL, \fBpcre_exec()\fP immediately returns
2450    the negative error code PCRE_ERROR_NULL, but with this special combination of
2451    arguments, it returns instead a negative number whose absolute value is the
2452    approximate stack frame size in bytes. (A negative number is used so that it is
2453    clear that no match has happened.) The value is approximate because in some
2454    cases, recursive calls to \fBpcre_exec()\fP occur when there are one or two
2455    additional variables on the stack.
2456    .P
2457    If PCRE has been compiled to use the heap instead of the stack for recursion,
2458    the value returned is the size of each block that is obtained from the heap.
2459    .
2460    .
2461  .\" HTML <a name="dfamatch"></a>  .\" HTML <a name="dfamatch"></a>
2462  .SH "MATCHING A PATTERN: THE ALTERNATIVE FUNCTION"  .SH "MATCHING A PATTERN: THE ALTERNATIVE FUNCTION"
2463  .rs  .rs
# Line 2502  When a recursive subpattern is processed Line 2639  When a recursive subpattern is processed
2639  recursively, using private vectors for \fIovector\fP and \fIworkspace\fP. This  recursively, using private vectors for \fIovector\fP and \fIworkspace\fP. This
2640  error is given if the output vector is not large enough. This should be  error is given if the output vector is not large enough. This should be
2641  extremely rare, as a vector of size 1000 is used.  extremely rare, as a vector of size 1000 is used.
2642    .sp
2643      PCRE_ERROR_DFA_BADRESTART (-30)
2644    .sp
2645    When \fBpcre_dfa_exec()\fP is called with the \fBPCRE_DFA_RESTART\fP option,
2646    some plausibility checks are made on the contents of the workspace, which
2647    should contain data about the previous partial match. If any of these checks
2648    fail, this error is given.
2649  .  .
2650  .  .
2651  .SH "SEE ALSO"  .SH "SEE ALSO"
2652  .rs  .rs
2653  .sp  .sp
2654  \fBpcrebuild\fP(3), \fBpcrecallout\fP(3), \fBpcrecpp(3)\fP(3),  \fBpcre16\fP(3), \fBpcrebuild\fP(3), \fBpcrecallout\fP(3), \fBpcrecpp(3)\fP(3),
2655  \fBpcrematching\fP(3), \fBpcrepartial\fP(3), \fBpcreposix\fP(3),  \fBpcrematching\fP(3), \fBpcrepartial\fP(3), \fBpcreposix\fP(3),
2656  \fBpcreprecompile\fP(3), \fBpcresample\fP(3), \fBpcrestack\fP(3).  \fBpcreprecompile\fP(3), \fBpcresample\fP(3), \fBpcrestack\fP(3).
2657  .  .
# Line 2526  Cambridge CB2 3QH, England. Line 2670  Cambridge CB2 3QH, England.
2670  .rs  .rs
2671  .sp  .sp
2672  .nf  .nf
2673  Last updated: 06 September 2011  Last updated: 28 August 2012
2674  Copyright (c) 1997-2011 University of Cambridge.  Copyright (c) 1997-2012 University of Cambridge.
2675  .fi  .fi

Legend:
Removed from v.691  
changed lines
  Added in v.1022

  ViewVC Help
Powered by ViewVC 1.1.5