/[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 91 by nigel, Sat Feb 24 21:41:34 2007 UTC revision 426 by ph10, Wed Aug 26 15:38:32 2009 UTC
# Line 7  PCRE - Perl-compatible regular expressio Line 7  PCRE - Perl-compatible regular expressio
7  .B #include <pcre.h>  .B #include <pcre.h>
8  .PP  .PP
9  .SM  .SM
 .br  
10  .B pcre *pcre_compile(const char *\fIpattern\fP, int \fIoptions\fP,  .B pcre *pcre_compile(const char *\fIpattern\fP, int \fIoptions\fP,
11  .ti +5n  .ti +5n
12  .B const char **\fIerrptr\fP, int *\fIerroffset\fP,  .B const char **\fIerrptr\fP, int *\fIerroffset\fP,
13  .ti +5n  .ti +5n
14  .B const unsigned char *\fItableptr\fP);  .B const unsigned char *\fItableptr\fP);
15  .PP  .PP
 .br  
16  .B pcre *pcre_compile2(const char *\fIpattern\fP, int \fIoptions\fP,  .B pcre *pcre_compile2(const char *\fIpattern\fP, int \fIoptions\fP,
17  .ti +5n  .ti +5n
18  .B int *\fIerrorcodeptr\fP,  .B int *\fIerrorcodeptr\fP,
# Line 23  PCRE - Perl-compatible regular expressio Line 21  PCRE - Perl-compatible regular expressio
21  .ti +5n  .ti +5n
22  .B const unsigned char *\fItableptr\fP);  .B const unsigned char *\fItableptr\fP);
23  .PP  .PP
 .br  
24  .B pcre_extra *pcre_study(const pcre *\fIcode\fP, int \fIoptions\fP,  .B pcre_extra *pcre_study(const pcre *\fIcode\fP, int \fIoptions\fP,
25  .ti +5n  .ti +5n
26  .B const char **\fIerrptr\fP);  .B const char **\fIerrptr\fP);
27  .PP  .PP
 .br  
28  .B int pcre_exec(const pcre *\fIcode\fP, "const pcre_extra *\fIextra\fP,"  .B int pcre_exec(const pcre *\fIcode\fP, "const pcre_extra *\fIextra\fP,"
29  .ti +5n  .ti +5n
30  .B "const char *\fIsubject\fP," int \fIlength\fP, int \fIstartoffset\fP,  .B "const char *\fIsubject\fP," int \fIlength\fP, int \fIstartoffset\fP,
31  .ti +5n  .ti +5n
32  .B int \fIoptions\fP, int *\fIovector\fP, int \fIovecsize\fP);  .B int \fIoptions\fP, int *\fIovector\fP, int \fIovecsize\fP);
33  .PP  .PP
 .br  
34  .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,"
35  .ti +5n  .ti +5n
36  .B "const char *\fIsubject\fP," int \fIlength\fP, int \fIstartoffset\fP,  .B "const char *\fIsubject\fP," int \fIlength\fP, int \fIstartoffset\fP,
# Line 44  PCRE - Perl-compatible regular expressio Line 39  PCRE - Perl-compatible regular expressio
39  .ti +5n  .ti +5n
40  .B int *\fIworkspace\fP, int \fIwscount\fP);  .B int *\fIworkspace\fP, int \fIwscount\fP);
41  .PP  .PP
 .br  
42  .B int pcre_copy_named_substring(const pcre *\fIcode\fP,  .B int pcre_copy_named_substring(const pcre *\fIcode\fP,
43  .ti +5n  .ti +5n
44  .B const char *\fIsubject\fP, int *\fIovector\fP,  .B const char *\fIsubject\fP, int *\fIovector\fP,
# Line 53  PCRE - Perl-compatible regular expressio Line 47  PCRE - Perl-compatible regular expressio
47  .ti +5n  .ti +5n
48  .B char *\fIbuffer\fP, int \fIbuffersize\fP);  .B char *\fIbuffer\fP, int \fIbuffersize\fP);
49  .PP  .PP
 .br  
50  .B int pcre_copy_substring(const char *\fIsubject\fP, int *\fIovector\fP,  .B int pcre_copy_substring(const char *\fIsubject\fP, int *\fIovector\fP,
51  .ti +5n  .ti +5n
52  .B int \fIstringcount\fP, int \fIstringnumber\fP, char *\fIbuffer\fP,  .B int \fIstringcount\fP, int \fIstringnumber\fP, char *\fIbuffer\fP,
53  .ti +5n  .ti +5n
54  .B int \fIbuffersize\fP);  .B int \fIbuffersize\fP);
55  .PP  .PP
 .br  
56  .B int pcre_get_named_substring(const pcre *\fIcode\fP,  .B int pcre_get_named_substring(const pcre *\fIcode\fP,
57  .ti +5n  .ti +5n
58  .B const char *\fIsubject\fP, int *\fIovector\fP,  .B const char *\fIsubject\fP, int *\fIovector\fP,
# Line 69  PCRE - Perl-compatible regular expressio Line 61  PCRE - Perl-compatible regular expressio
61  .ti +5n  .ti +5n
62  .B const char **\fIstringptr\fP);  .B const char **\fIstringptr\fP);
63  .PP  .PP
 .br  
64  .B int pcre_get_stringnumber(const pcre *\fIcode\fP,  .B int pcre_get_stringnumber(const pcre *\fIcode\fP,
65  .ti +5n  .ti +5n
66  .B const char *\fIname\fP);  .B const char *\fIname\fP);
67  .PP  .PP
 .br  
68  .B int pcre_get_stringtable_entries(const pcre *\fIcode\fP,  .B int pcre_get_stringtable_entries(const pcre *\fIcode\fP,
69  .ti +5n  .ti +5n
70  .B const char *\fIname\fP, char **\fIfirst\fP, char **\fIlast\fP);  .B const char *\fIname\fP, char **\fIfirst\fP, char **\fIlast\fP);
71  .PP  .PP
 .br  
72  .B int pcre_get_substring(const char *\fIsubject\fP, int *\fIovector\fP,  .B int pcre_get_substring(const char *\fIsubject\fP, int *\fIovector\fP,
73  .ti +5n  .ti +5n
74  .B int \fIstringcount\fP, int \fIstringnumber\fP,  .B int \fIstringcount\fP, int \fIstringnumber\fP,
75  .ti +5n  .ti +5n
76  .B const char **\fIstringptr\fP);  .B const char **\fIstringptr\fP);
77  .PP  .PP
 .br  
78  .B int pcre_get_substring_list(const char *\fIsubject\fP,  .B int pcre_get_substring_list(const char *\fIsubject\fP,
79  .ti +5n  .ti +5n
80  .B int *\fIovector\fP, int \fIstringcount\fP, "const char ***\fIlistptr\fP);"  .B int *\fIovector\fP, int \fIstringcount\fP, "const char ***\fIlistptr\fP);"
81  .PP  .PP
 .br  
82  .B void pcre_free_substring(const char *\fIstringptr\fP);  .B void pcre_free_substring(const char *\fIstringptr\fP);
83  .PP  .PP
 .br  
84  .B void pcre_free_substring_list(const char **\fIstringptr\fP);  .B void pcre_free_substring_list(const char **\fIstringptr\fP);
85  .PP  .PP
 .br  
86  .B const unsigned char *pcre_maketables(void);  .B const unsigned char *pcre_maketables(void);
87  .PP  .PP
 .br  
88  .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,"
89  .ti +5n  .ti +5n
90  .B int \fIwhat\fP, void *\fIwhere\fP);  .B int \fIwhat\fP, void *\fIwhere\fP);
91  .PP  .PP
 .br  
92  .B int pcre_info(const pcre *\fIcode\fP, int *\fIoptptr\fP, int  .B int pcre_info(const pcre *\fIcode\fP, int *\fIoptptr\fP, int
93  .B *\fIfirstcharptr\fP);  .B *\fIfirstcharptr\fP);
94  .PP  .PP
 .br  
95  .B int pcre_refcount(pcre *\fIcode\fP, int \fIadjust\fP);  .B int pcre_refcount(pcre *\fIcode\fP, int \fIadjust\fP);
96  .PP  .PP
 .br  
97  .B int pcre_config(int \fIwhat\fP, void *\fIwhere\fP);  .B int pcre_config(int \fIwhat\fP, void *\fIwhere\fP);
98  .PP  .PP
 .br  
99  .B char *pcre_version(void);  .B char *pcre_version(void);
100  .PP  .PP
 .br  
101  .B void *(*pcre_malloc)(size_t);  .B void *(*pcre_malloc)(size_t);
102  .PP  .PP
 .br  
103  .B void (*pcre_free)(void *);  .B void (*pcre_free)(void *);
104  .PP  .PP
 .br  
105  .B void *(*pcre_stack_malloc)(size_t);  .B void *(*pcre_stack_malloc)(size_t);
106  .PP  .PP
 .br  
107  .B void (*pcre_stack_free)(void *);  .B void (*pcre_stack_free)(void *);
108  .PP  .PP
 .br  
109  .B int (*pcre_callout)(pcre_callout_block *);  .B int (*pcre_callout)(pcre_callout_block *);
110  .  .
111  .  .
112  .SH "PCRE API OVERVIEW"  .SH "PCRE API OVERVIEW"
113  .rs  .rs
114  .sp  .sp
115  PCRE has its own native API, which is described in this document. There is  PCRE has its own native API, which is described in this document. There are
116  also a set of wrapper functions that correspond to the POSIX regular expression  also some wrapper functions that correspond to the POSIX regular expression
117  API. These are described in the  API. These are described in the
118  .\" HREF  .\" HREF
119  \fBpcreposix\fP  \fBpcreposix\fP
# Line 165  distribution. The Line 140  distribution. The
140  .\" HREF  .\" HREF
141  \fBpcresample\fP  \fBpcresample\fP
142  .\"  .\"
143  documentation describes how to run it.  documentation describes how to compile and run it.
144  .P  .P
145  A second matching function, \fBpcre_dfa_exec()\fP, which is not  A second matching function, \fBpcre_dfa_exec()\fP, which is not
146  Perl-compatible, is also provided. This uses a different algorithm for the  Perl-compatible, is also provided. This uses a different algorithm for the
147  matching. The alternative algorithm finds all possible matches (at a given  matching. The alternative algorithm finds all possible matches (at a given
148  point in the subject). However, this algorithm does not return captured  point in the subject), and scans the subject just once. However, this algorithm
149  substrings. A description of the two matching algorithms and their advantages  does not return captured substrings. A description of the two matching
150  and disadvantages is given in the  algorithms and their advantages and disadvantages is given in the
151  .\" HREF  .\" HREF
152  \fBpcrematching\fP  \fBpcrematching\fP
153  .\"  .\"
# Line 243  points during a matching operation. Deta Line 218  points during a matching operation. Deta
218  documentation.  documentation.
219  .  .
220  .  .
221    .\" HTML <a name="newlines"></a>
222  .SH NEWLINES  .SH NEWLINES
223  PCRE supports three different conventions for indicating line breaks in  .rs
 strings: a single CR character, a single LF character, or the two-character  
 sequence CRLF. All three are used as "standard" by different operating systems.  
 When PCRE is built, a default can be specified. The default default is LF,  
 which is the Unix standard. When PCRE is run, the default can be overridden,  
 either when a pattern is compiled, or when it is matched.  
224  .sp  .sp
225    PCRE supports five different conventions for indicating line breaks in
226    strings: a single CR (carriage return) character, a single LF (linefeed)
227    character, the two-character sequence CRLF, any of the three preceding, or any
228    Unicode newline sequence. The Unicode newline sequences are the three just
229    mentioned, plus the single characters VT (vertical tab, U+000B), FF (formfeed,
230    U+000C), NEL (next line, U+0085), LS (line separator, U+2028), and PS
231    (paragraph separator, U+2029).
232    .P
233    Each of the first three conventions is used by at least one operating system as
234    its standard newline sequence. When PCRE is built, a default can be specified.
235    The default default is LF, which is the Unix standard. When PCRE is run, the
236    default can be overridden, either when a pattern is compiled, or when it is
237    matched.
238    .P
239    At compile time, the newline convention can be specified by the \fIoptions\fP
240    argument of \fBpcre_compile()\fP, or it can be specified by special text at the
241    start of the pattern itself; this overrides any other settings. See the
242    .\" HREF
243    \fBpcrepattern\fP
244    .\"
245    page for details of the special character sequences.
246    .P
247  In the PCRE documentation the word "newline" is used to mean "the character or  In the PCRE documentation the word "newline" is used to mean "the character or
248  pair of characters that indicate a line break".  pair of characters that indicate a line break". The choice of newline
249    convention affects the handling of the dot, circumflex, and dollar
250    metacharacters, the handling of #-comments in /x mode, and, when CRLF is a
251    recognized line ending sequence, the match position advancement for a
252    non-anchored pattern. There is more detail about this in the
253    .\" HTML <a href="#execoptions">
254    .\" </a>
255    section on \fBpcre_exec()\fP options
256    .\"
257    below.
258    .P
259    The choice of newline convention does not affect the interpretation of
260    the \en or \er escape sequences, nor does it affect what \eR matches, which is
261    controlled in a similar way, but by separate options.
262  .  .
263  .  .
264  .SH MULTITHREADING  .SH MULTITHREADING
# Line 276  which it was compiled. Details are given Line 282  which it was compiled. Details are given
282  .\" HREF  .\" HREF
283  \fBpcreprecompile\fP  \fBpcreprecompile\fP
284  .\"  .\"
285  documentation.  documentation. However, compiling a regular expression with one version of PCRE
286    for use with a different version is not guaranteed to work and may cause
287    crashes.
288  .  .
289  .  .
290  .SH "CHECKING BUILD-TIME OPTIONS"  .SH "CHECKING BUILD-TIME OPTIONS"
# Line 308  properties is available; otherwise it is Line 316  properties is available; otherwise it is
316    PCRE_CONFIG_NEWLINE    PCRE_CONFIG_NEWLINE
317  .sp  .sp
318  The output is an integer whose value specifies the default character sequence  The output is an integer whose value specifies the default character sequence
319  that is recognized as meaning "newline". The three values that are supported  that is recognized as meaning "newline". The four values that are supported
320  are: 10 for LF, 13 for CR, and 3338 for CRLF. The default should normally be  are: 10 for LF, 13 for CR, 3338 for CRLF, -2 for ANYCRLF, and -1 for ANY.
321  the standard sequence for your operating system.  Though they are derived from ASCII, the same values are returned in EBCDIC
322    environments. The default should normally correspond to the standard sequence
323    for your operating system.
324    .sp
325      PCRE_CONFIG_BSR
326    .sp
327    The output is an integer whose value indicates what character sequences the \eR
328    escape sequence matches by default. A value of 0 means that \eR matches any
329    Unicode line ending sequence; a value of 1 means that \eR matches only CR, LF,
330    or CRLF. The default can be overridden when a pattern is compiled or matched.
331  .sp  .sp
332    PCRE_CONFIG_LINK_SIZE    PCRE_CONFIG_LINK_SIZE
333  .sp  .sp
# Line 332  documentation. Line 349  documentation.
349  .sp  .sp
350    PCRE_CONFIG_MATCH_LIMIT    PCRE_CONFIG_MATCH_LIMIT
351  .sp  .sp
352  The output is an integer that gives the default limit for the number of  The output is a long integer that gives the default limit for the number of
353  internal matching function calls in a \fBpcre_exec()\fP execution. Further  internal matching function calls in a \fBpcre_exec()\fP execution. Further
354  details are given with \fBpcre_exec()\fP below.  details are given with \fBpcre_exec()\fP below.
355  .sp  .sp
356    PCRE_CONFIG_MATCH_LIMIT_RECURSION    PCRE_CONFIG_MATCH_LIMIT_RECURSION
357  .sp  .sp
358  The output is an integer that gives the default limit for the depth of  The output is a long integer that gives the default limit for the depth of
359  recursion when calling the internal matching function in a \fBpcre_exec()\fP  recursion when calling the internal matching function in a \fBpcre_exec()\fP
360  execution. Further details are given with \fBpcre_exec()\fP below.  execution. Further details are given with \fBpcre_exec()\fP below.
361  .sp  .sp
# Line 387  depend on memory location, the complete Line 404  depend on memory location, the complete
404  fully relocatable, because it may contain a copy of the \fItableptr\fP  fully relocatable, because it may contain a copy of the \fItableptr\fP
405  argument, which is an address (see below).  argument, which is an address (see below).
406  .P  .P
407  The \fIoptions\fP argument contains independent bits that affect the  The \fIoptions\fP argument contains various bit settings that affect the
408  compilation. It should be zero if no options are required. The available  compilation. It should be zero if no options are required. The available
409  options are described below. Some of them, in particular, those that are  options are described below. Some of them (in particular, those that are
410  compatible with Perl, can also be set and unset from within the pattern (see  compatible with Perl, but also some others) can also be set and unset from
411  the detailed description in the  within the pattern (see the detailed description in the
412  .\" HREF  .\" HREF
413  \fBpcrepattern\fP  \fBpcrepattern\fP
414  .\"  .\"
415  documentation). For these options, the contents of the \fIoptions\fP argument  documentation). For those options that can be different in different parts of
416  specifies their initial settings at the start of compilation and execution. The  the pattern, the contents of the \fIoptions\fP argument specifies their initial
417  PCRE_ANCHORED and PCRE_NEWLINE_\fIxxx\fP options can be set at the time of  settings at the start of compilation and execution. The PCRE_ANCHORED and
418  matching as well as at compile time.  PCRE_NEWLINE_\fIxxx\fP options can be set at the time of matching as well as at
419    compile time.
420  .P  .P
421  If \fIerrptr\fP is NULL, \fBpcre_compile()\fP returns NULL immediately.  If \fIerrptr\fP is NULL, \fBpcre_compile()\fP returns NULL immediately.
422  Otherwise, if compilation of a pattern fails, \fBpcre_compile()\fP returns  Otherwise, if compilation of a pattern fails, \fBpcre_compile()\fP returns
# Line 453  facility, see the Line 471  facility, see the
471  .\"  .\"
472  documentation.  documentation.
473  .sp  .sp
474      PCRE_BSR_ANYCRLF
475      PCRE_BSR_UNICODE
476    .sp
477    These options (which are mutually exclusive) control what the \eR escape
478    sequence matches. The choice is either to match only CR, LF, or CRLF, or to
479    match any Unicode newline sequence. The default is specified when PCRE is
480    built. It can be overridden from within the pattern, or by setting an option
481    when a compiled pattern is matched.
482    .sp
483    PCRE_CASELESS    PCRE_CASELESS
484  .sp  .sp
485  If this bit is set, letters in the pattern match both upper and lower case  If this bit is set, letters in the pattern match both upper and lower case
# Line 480  If this bit is set, a dot metacharater i Line 507  If this bit is set, a dot metacharater i
507  including those that indicate newline. Without it, a dot does not match when  including those that indicate newline. Without it, a dot does not match when
508  the current position is at a newline. This option is equivalent to Perl's /s  the current position is at a newline. This option is equivalent to Perl's /s
509  option, and it can be changed within a pattern by a (?s) option setting. A  option, and it can be changed within a pattern by a (?s) option setting. A
510  negative class such as [^a] always matches newlines, independent of the setting  negative class such as [^a] always matches newline characters, independent of
511  of this option.  the setting of this option.
512  .sp  .sp
513    PCRE_DUPNAMES    PCRE_DUPNAMES
514  .sp  .sp
# Line 525  If this option is set, an unanchored pat Line 552  If this option is set, an unanchored pat
552  the first newline in the subject string, though the matched text may continue  the first newline in the subject string, though the matched text may continue
553  over the newline.  over the newline.
554  .sp  .sp
555      PCRE_JAVASCRIPT_COMPAT
556    .sp
557    If this option is set, PCRE's behaviour is changed in some ways so that it is
558    compatible with JavaScript rather than Perl. The changes are as follows:
559    .P
560    (1) A lone closing square bracket in a pattern causes a compile-time error,
561    because this is illegal in JavaScript (by default it is treated as a data
562    character). Thus, the pattern AB]CD becomes illegal when this option is set.
563    .P
564    (2) At run time, a back reference to an unset subpattern group matches an empty
565    string (by default this causes the current matching alternative to fail). A
566    pattern such as (\e1)(a) succeeds when this option is set (assuming it can find
567    an "a" in the subject), whereas it fails by default, for Perl compatibility.
568    .sp
569    PCRE_MULTILINE    PCRE_MULTILINE
570  .sp  .sp
571  By default, PCRE treats the subject string as consisting of a single line of  By default, PCRE treats the subject string as consisting of a single line of
# Line 544  occurrences of ^ or $ in a pattern, sett Line 585  occurrences of ^ or $ in a pattern, sett
585    PCRE_NEWLINE_CR    PCRE_NEWLINE_CR
586    PCRE_NEWLINE_LF    PCRE_NEWLINE_LF
587    PCRE_NEWLINE_CRLF    PCRE_NEWLINE_CRLF
588      PCRE_NEWLINE_ANYCRLF
589      PCRE_NEWLINE_ANY
590  .sp  .sp
591  These options override the default newline definition that was chosen when PCRE  These options override the default newline definition that was chosen when PCRE
592  was built. Setting the first or the second specifies that a newline is  was built. Setting the first or the second specifies that a newline is
593  indicated by a single character (CR or LF, respectively). Setting both of them  indicated by a single character (CR or LF, respectively). Setting
594  specifies that a newline is indicated by the two-character CRLF sequence. For  PCRE_NEWLINE_CRLF specifies that a newline is indicated by the two-character
595  convenience, PCRE_NEWLINE_CRLF is defined to contain both bits. The only time  CRLF sequence. Setting PCRE_NEWLINE_ANYCRLF specifies that any of the three
596  that a line break is relevant when compiling a pattern is if PCRE_EXTENDED is  preceding sequences should be recognized. Setting PCRE_NEWLINE_ANY specifies
597  set, and an unescaped # outside a character class is encountered. This  that any Unicode newline sequence should be recognized. The Unicode newline
598  indicates a comment that lasts until after the next newline.  sequences are the three just mentioned, plus the single characters VT (vertical
599    tab, U+000B), FF (formfeed, U+000C), NEL (next line, U+0085), LS (line
600    separator, U+2028), and PS (paragraph separator, U+2029). The last two are
601    recognized only in UTF-8 mode.
602    .P
603    The newline setting in the options word uses three bits that are treated
604    as a number, giving eight possibilities. Currently only six are used (default
605    plus the five values above). This means that if you set more than one newline
606    option, the combination may or may not be sensible. For example,
607    PCRE_NEWLINE_CR with PCRE_NEWLINE_LF is equivalent to PCRE_NEWLINE_CRLF, but
608    other combinations may yield unused numbers and cause an error.
609    .P
610    The only time that a line break is specially recognized when compiling a
611    pattern is if PCRE_EXTENDED is set, and an unescaped # outside a character
612    class is encountered. This indicates a comment that lasts until after the next
613    line break sequence. In other circumstances, line break sequences are treated
614    as literal data, except that in PCRE_EXTENDED mode, both CR and LF are treated
615    as whitespace characters and are therefore ignored.
616  .P  .P
617  The newline option set at compile time becomes the default that is used for  The newline option that is set at compile time becomes the default that is used
618  \fBpcre_exec()\fP and \fBpcre_dfa_exec()\fP, but it can be overridden.  for \fBpcre_exec()\fP and \fBpcre_dfa_exec()\fP, but it can be overridden.
619  .sp  .sp
620    PCRE_NO_AUTO_CAPTURE    PCRE_NO_AUTO_CAPTURE
621  .sp  .sp
# Line 591  page. Line 651  page.
651    PCRE_NO_UTF8_CHECK    PCRE_NO_UTF8_CHECK
652  .sp  .sp
653  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 string is
654  automatically checked. If an invalid UTF-8 sequence of bytes is found,  automatically checked. There is a discussion about the
655  \fBpcre_compile()\fP returns an error. If you already know that your pattern is  .\" HTML <a href="pcre.html#utf8strings">
656  valid, and you want to skip this check for performance reasons, you can set the  .\" </a>
657  PCRE_NO_UTF8_CHECK option. When it is set, the effect of passing an invalid  validity of UTF-8 strings
658  UTF-8 string as a pattern is undefined. It may cause your program to crash.  .\"
659  Note that this option can also be passed to \fBpcre_exec()\fP and  in the main
660  \fBpcre_dfa_exec()\fP, to suppress the UTF-8 validity checking of subject  .\" HREF
661  strings.  \fBpcre\fP
662    .\"
663    page. If an invalid UTF-8 sequence of bytes is found, \fBpcre_compile()\fP
664    returns an error. If you already know that your pattern is valid, and you want
665    to skip this check for performance reasons, you can set the PCRE_NO_UTF8_CHECK
666    option. When it is set, the effect of passing an invalid UTF-8 string as a
667    pattern is undefined. It may cause your program to crash. Note that this option
668    can also be passed to \fBpcre_exec()\fP and \fBpcre_dfa_exec()\fP, to suppress
669    the UTF-8 validity checking of subject strings.
670  .  .
671  .  .
672  .SH "COMPILATION ERROR CODES"  .SH "COMPILATION ERROR CODES"
# Line 606  strings. Line 674  strings.
674  .sp  .sp
675  The following table lists the error codes than may be returned by  The following table lists the error codes than may be returned by
676  \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
677  both compiling functions.  both compiling functions. As PCRE has developed, some error codes have fallen
678    out of use. To avoid confusion, they have not been re-used.
679  .sp  .sp
680     0  no error     0  no error
681     1  \e at end of pattern     1  \e at end of pattern
# Line 618  both compiling functions. Line 687  both compiling functions.
687     7  invalid escape sequence in character class     7  invalid escape sequence in character class
688     8  range out of order in character class     8  range out of order in character class
689     9  nothing to repeat     9  nothing to repeat
690    10  operand of unlimited repeat could match the empty string    10  [this code is not in use]
691    11  internal error: unexpected repeat    11  internal error: unexpected repeat
692    12  unrecognized character after (?    12  unrecognized character after (? or (?-
693    13  POSIX named classes are supported only within a class    13  POSIX named classes are supported only within a class
694    14  missing )    14  missing )
695    15  reference to non-existent subpattern    15  reference to non-existent subpattern
696    16  erroffset passed as NULL    16  erroffset passed as NULL
697    17  unknown option bit(s) set    17  unknown option bit(s) set
698    18  missing ) after comment    18  missing ) after comment
699    19  parentheses nested too deeply    19  [this code is not in use]
700    20  regular expression too large    20  regular expression is too large
701    21  failed to get memory    21  failed to get memory
702    22  unmatched parentheses    22  unmatched parentheses
703    23  internal error: code overflow    23  internal error: code overflow
# Line 637  both compiling functions. Line 706  both compiling functions.
706    26  malformed number or name after (?(    26  malformed number or name after (?(
707    27  conditional group contains more than two branches    27  conditional group contains more than two branches
708    28  assertion expected after (?(    28  assertion expected after (?(
709    29  (?R or (?digits must be followed by )    29  (?R or (?[+-]digits must be followed by )
710    30  unknown POSIX class name    30  unknown POSIX class name
711    31  POSIX collating elements are not supported    31  POSIX collating elements are not supported
712    32  this version of PCRE is not compiled with PCRE_UTF8 support    32  this version of PCRE is not compiled with PCRE_UTF8 support
713    33  spare error    33  [this code is not in use]
714    34  character value in \ex{...} sequence is too large    34  character value in \ex{...} sequence is too large
715    35  invalid condition (?(0)    35  invalid condition (?(0)
716    36  \eC not allowed in lookbehind assertion    36  \eC not allowed in lookbehind assertion
# Line 650  both compiling functions. Line 719  both compiling functions.
719    39  closing ) for (?C expected    39  closing ) for (?C expected
720    40  recursive call could loop indefinitely    40  recursive call could loop indefinitely
721    41  unrecognized character after (?P    41  unrecognized character after (?P
722    42  syntax error after (?P    42  syntax error in subpattern name (missing terminator)
723    43  two named subpatterns have the same name    43  two named subpatterns have the same name
724    44  invalid UTF-8 string    44  invalid UTF-8 string
725    45  support for \eP, \ep, and \eX has not been compiled    45  support for \eP, \ep, and \eX has not been compiled
726    46  malformed \eP or \ep sequence    46  malformed \eP or \ep sequence
727    47  unknown property name after \eP or \ep    47  unknown property name after \eP or \ep
728    48  subpattern name is too long (maximum 32 characters)    48  subpattern name is too long (maximum 32 characters)
729    49  too many named subpatterns (maximum 10,000)    49  too many named subpatterns (maximum 10000)
730    50  repeated subpattern is too long    50  [this code is not in use]
731    51  octal value is greater than \e377 (not in UTF-8 mode)    51  octal value is greater than \e377 (not in UTF-8 mode)
732      52  internal error: overran compiling workspace
733      53  internal error: previously-checked referenced subpattern not found
734      54  DEFINE group contains more than one branch
735      55  repeating a DEFINE group is not allowed
736      56  inconsistent NEWLINE options
737      57  \eg is not followed by a braced, angle-bracketed, or quoted
738            name/number or by a plain number
739      58  a numbered reference must not be zero
740      59  (*VERB) with an argument is not supported
741      60  (*VERB) not recognized
742      61  number is too big
743      62  subpattern name expected
744      63  digit expected after (?+
745      64  ] is an invalid data character in JavaScript compatibility mode
746    .sp
747    The numbers 32 and 10000 in errors 48 and 49 are defaults; different values may
748    be used if the limits were changed when PCRE was built.
749  .  .
750  .  .
751  .SH "STUDYING A PATTERN"  .SH "STUDYING A PATTERN"
# Line 719  bytes is created. Line 805  bytes is created.
805  .SH "LOCALE SUPPORT"  .SH "LOCALE SUPPORT"
806  .rs  .rs
807  .sp  .sp
808  PCRE handles caseless matching, and determines whether characters are letters  PCRE handles caseless matching, and determines whether characters are letters,
809  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
810  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 with codes
811  less than 128. Higher-valued codes never match escapes such as \ew or \ed, but  less than 128. Higher-valued codes never match escapes such as \ew or \ed, but
812  can be tested with \ep if PCRE is built with Unicode character property  can be tested with \ep if PCRE is built with Unicode character property
813  support. The use of locales with Unicode is discouraged.  support. The use of locales with Unicode is discouraged. If you are handling
814  .P  characters with codes greater than 128, you should either use UTF-8 and
815  An internal set of tables is created in the default C locale when PCRE is  Unicode, or use locales, but not try to mix the two.
816  built. This is used when the final argument of \fBpcre_compile()\fP is NULL,  .P
817  and is sufficient for many applications. An alternative set of tables can,  PCRE contains an internal set of tables that are used when the final argument
818  however, be supplied. These may be created in a different locale from the  of \fBpcre_compile()\fP is NULL. These are sufficient for many applications.
819  default. As more and more applications change to using Unicode, the need for  Normally, the internal tables recognize only ASCII characters. However, when
820  this locale support is expected to die away.  PCRE is built, it is possible to cause the internal tables to be rebuilt in the
821    default "C" locale of the local system, which may cause them to be different.
822    .P
823    The internal tables can always be overridden by tables supplied by the
824    application that calls PCRE. These may be created in a different locale from
825    the default. As more and more applications change to using Unicode, the need
826    for this locale support is expected to die away.
827  .P  .P
828  External tables are built by calling the \fBpcre_maketables()\fP function,  External tables are built by calling the \fBpcre_maketables()\fP function,
829  which has no arguments, in the relevant locale. The result can then be passed  which has no arguments, in the relevant locale. The result can then be passed
# Line 744  the following code could be used: Line 836  the following code could be used:
836    tables = pcre_maketables();    tables = pcre_maketables();
837    re = pcre_compile(..., tables);    re = pcre_compile(..., tables);
838  .sp  .sp
839    The locale name "fr_FR" is used on Linux and other Unix-like systems; if you
840    are using Windows, the name for the French locale is "french".
841    .P
842  When \fBpcre_maketables()\fP runs, the tables are built in memory that is  When \fBpcre_maketables()\fP runs, the tables are built in memory that is
843  obtained via \fBpcre_malloc\fP. It is the caller's responsibility to ensure  obtained via \fBpcre_malloc\fP. It is the caller's responsibility to ensure
844  that the memory containing the tables remains available for as long as it is  that the memory containing the tables remains available for as long as it is
# Line 827  variable. (This option used to be called Line 922  variable. (This option used to be called
922  still recognized for backwards compatibility.)  still recognized for backwards compatibility.)
923  .P  .P
924  If there is a fixed first byte, for example, from a pattern such as  If there is a fixed first byte, for example, from a pattern such as
925  (cat|cow|coyote). Otherwise, if either  (cat|cow|coyote), its value is returned. Otherwise, if either
926  .sp  .sp
927  (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
928  starts with "^", or  starts with "^", or
# Line 846  table indicating a fixed set of bytes fo Line 941  table indicating a fixed set of bytes fo
941  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
942  fourth argument should point to an \fBunsigned char *\fP variable.  fourth argument should point to an \fBunsigned char *\fP variable.
943  .sp  .sp
944      PCRE_INFO_HASCRORLF
945    .sp
946    Return 1 if the pattern contains any explicit matches for CR or LF characters,
947    otherwise 0. The fourth argument should point to an \fBint\fP variable. An
948    explicit match is either a literal CR or LF character, or \er or \en.
949    .sp
950      PCRE_INFO_JCHANGED
951    .sp
952    Return 1 if the (?J) or (?-J) option setting is used in the pattern, otherwise
953    0. The fourth argument should point to an \fBint\fP variable. (?J) and
954    (?-J) set and unset the local PCRE_DUPNAMES option, respectively.
955    .sp
956    PCRE_INFO_LASTLITERAL    PCRE_INFO_LASTLITERAL
957  .sp  .sp
958  Return the value of the rightmost literal byte that must exist in any matched  Return the value of the rightmost literal byte that must exist in any matched
# Line 882  their parentheses numbers. For example, Line 989  their parentheses numbers. For example,
989  PCRE_EXTENDED is set, so white space - including newlines - is ignored):  PCRE_EXTENDED is set, so white space - including newlines - is ignored):
990  .sp  .sp
991  .\" JOIN  .\" JOIN
992    (?P<date> (?P<year>(\ed\ed)?\ed\ed) -    (?<date> (?<year>(\ed\ed)?\ed\ed) -
993    (?P<month>\ed\ed) - (?P<day>\ed\ed) )    (?<month>\ed\ed) - (?<day>\ed\ed) )
994  .sp  .sp
995  There are four named subpatterns, so the table has four entries, and each entry  There are four named subpatterns, so the table has four entries, and each entry
996  in the table is eight bytes long. The table is as follows, with non-printing  in the table is eight bytes long. The table is as follows, with non-printing
# Line 898  When writing code to extract data from n Line 1005  When writing code to extract data from n
1005  name-to-number map, remember that the length of the entries is likely to be  name-to-number map, remember that the length of the entries is likely to be
1006  different for each compiled pattern.  different for each compiled pattern.
1007  .sp  .sp
1008      PCRE_INFO_OKPARTIAL
1009    .sp
1010    Return 1 if the pattern can be used for partial matching, otherwise 0. The
1011    fourth argument should point to an \fBint\fP variable. From release 8.00, this
1012    always returns 1, because the restrictions that previously applied to partial
1013    matching have been lifted. The
1014    .\" HREF
1015    \fBpcrepartial\fP
1016    .\"
1017    documentation gives details of partial matching.
1018    .sp
1019    PCRE_INFO_OPTIONS    PCRE_INFO_OPTIONS
1020  .sp  .sp
1021  Return a copy of the options with which the pattern was compiled. The fourth  Return a copy of the options with which the pattern was compiled. The fourth
1022  argument should point to an \fBunsigned long int\fP variable. These option bits  argument should point to an \fBunsigned long int\fP variable. These option bits
1023  are those specified in the call to \fBpcre_compile()\fP, modified by any  are those specified in the call to \fBpcre_compile()\fP, modified by any
1024  top-level option settings within the pattern itself.  top-level option settings at the start of the pattern itself. In other words,
1025    they are the options that will be in force when matching starts. For example,
1026    if the pattern /(?im)abc(?-i)d/ is compiled with the PCRE_EXTENDED option, the
1027    result is PCRE_CASELESS, PCRE_MULTILINE, and PCRE_EXTENDED.
1028  .P  .P
1029  A pattern is automatically anchored by PCRE if all of its top-level  A pattern is automatically anchored by PCRE if all of its top-level
1030  alternatives begin with one of the following:  alternatives begin with one of the following:
# Line 1114  called. See the Line 1235  called. See the
1235  .\"  .\"
1236  documentation for a discussion of saving compiled patterns for later use.  documentation for a discussion of saving compiled patterns for later use.
1237  .  .
1238    .\" HTML <a name="execoptions"></a>
1239  .SS "Option bits for \fBpcre_exec()\fP"  .SS "Option bits for \fBpcre_exec()\fP"
1240  .rs  .rs
1241  .sp  .sp
1242  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
1243  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,
1244  PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NO_UTF8_CHECK and PCRE_PARTIAL.  PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NO_START_OPTIMIZE,
1245    PCRE_NO_UTF8_CHECK and PCRE_PARTIAL.
1246  .sp  .sp
1247    PCRE_ANCHORED    PCRE_ANCHORED
1248  .sp  .sp
# Line 1128  matching position. If a pattern was comp Line 1251  matching position. If a pattern was comp
1251  to be anchored by virtue of its contents, it cannot be made unachored at  to be anchored by virtue of its contents, it cannot be made unachored at
1252  matching time.  matching time.
1253  .sp  .sp
1254      PCRE_BSR_ANYCRLF
1255      PCRE_BSR_UNICODE
1256    .sp
1257    These options (which are mutually exclusive) control what the \eR escape
1258    sequence matches. The choice is either to match only CR, LF, or CRLF, or to
1259    match any Unicode newline sequence. These options override the choice that was
1260    made or defaulted when the pattern was compiled.
1261    .sp
1262    PCRE_NEWLINE_CR    PCRE_NEWLINE_CR
1263    PCRE_NEWLINE_LF    PCRE_NEWLINE_LF
1264    PCRE_NEWLINE_CRLF    PCRE_NEWLINE_CRLF
1265      PCRE_NEWLINE_ANYCRLF
1266      PCRE_NEWLINE_ANY
1267  .sp  .sp
1268  These options override the newline definition that was chosen or defaulted when  These options override the newline definition that was chosen or defaulted when
1269  the pattern was compiled. For details, see the description \fBpcre_compile()\fP  the pattern was compiled. For details, see the description of
1270  above. During matching, the newline choice affects the behaviour of the dot,  \fBpcre_compile()\fP above. During matching, the newline choice affects the
1271  circumflex, and dollar metacharacters.  behaviour of the dot, circumflex, and dollar metacharacters. It may also alter
1272    the way the match position is advanced after a match failure for an unanchored
1273    pattern.
1274    .P
1275    When PCRE_NEWLINE_CRLF, PCRE_NEWLINE_ANYCRLF, or PCRE_NEWLINE_ANY is set, and a
1276    match attempt for an unanchored pattern fails when the current position is at a
1277    CRLF sequence, and the pattern contains no explicit matches for CR or LF
1278    characters, the match position is advanced by two characters instead of one, in
1279    other words, to after the CRLF.
1280    .P
1281    The above rule is a compromise that makes the most common cases work as
1282    expected. For example, if the pattern is .+A (and the PCRE_DOTALL option is not
1283    set), it does not match the string "\er\enA" because, after failing at the
1284    start, it skips both the CR and the LF before retrying. However, the pattern
1285    [\er\en]A does match that string, because it contains an explicit CR or LF
1286    reference, and so advances only by one character after the first failure.
1287    .P
1288    An explicit match for CR of LF is either a literal appearance of one of those
1289    characters, or one of the \er or \en escape sequences. Implicit matches such as
1290    [^X] do not count, nor does \es (which includes CR and LF in the characters
1291    that it matches).
1292    .P
1293    Notwithstanding the above, anomalous effects may still occur when CRLF is a
1294    valid newline sequence and explicit \er or \en escapes appear in the pattern.
1295  .sp  .sp
1296    PCRE_NOTBOL    PCRE_NOTBOL
1297  .sp  .sp
# Line 1173  PCRE_NOTEMPTY and PCRE_ANCHORED, and the Line 1329  PCRE_NOTEMPTY and PCRE_ANCHORED, and the
1329  starting offset (see below) and trying an ordinary match again. There is some  starting offset (see below) and trying an ordinary match again. There is some
1330  code that demonstrates how to do this in the \fIpcredemo.c\fP sample program.  code that demonstrates how to do this in the \fIpcredemo.c\fP sample program.
1331  .sp  .sp
1332      PCRE_NO_START_OPTIMIZE
1333    .sp
1334    There are a number of optimizations that \fBpcre_exec()\fP uses at the start of
1335    a match, in order to speed up the process. For example, if it is known that a
1336    match must start with a specific character, it searches the subject for that
1337    character, and fails immediately if it cannot find it, without actually running
1338    the main matching function. When callouts are in use, these optimizations can
1339    cause them to be skipped. This option disables the "start-up" optimizations,
1340    causing performance to suffer, but ensuring that the callouts do occur.
1341    .sp
1342    PCRE_NO_UTF8_CHECK    PCRE_NO_UTF8_CHECK
1343  .sp  .sp
1344  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
1345  string is automatically checked when \fBpcre_exec()\fP is subsequently called.  string is automatically checked when \fBpcre_exec()\fP is subsequently called.
1346  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
1347  start of a UTF-8 character. If an invalid UTF-8 sequence of bytes is found,  start of a UTF-8 character. There is a discussion about the validity of UTF-8
1348  \fBpcre_exec()\fP returns the error PCRE_ERROR_BADUTF8. If \fIstartoffset\fP  strings in the
1349  contains an invalid value, PCRE_ERROR_BADUTF8_OFFSET is returned.  .\" HTML <a href="pcre.html#utf8strings">
1350    .\" </a>
1351    section on UTF-8 support
1352    .\"
1353    in the main
1354    .\" HREF
1355    \fBpcre\fP
1356    .\"
1357    page. If an invalid UTF-8 sequence of bytes is found, \fBpcre_exec()\fP returns
1358    the error PCRE_ERROR_BADUTF8. If \fIstartoffset\fP contains an invalid value,
1359    PCRE_ERROR_BADUTF8_OFFSET is returned.
1360  .P  .P
1361  If you already know that your subject is valid, and you want to skip these  If you already know that your subject is valid, and you want to skip these
1362  checks for performance reasons, you can set the PCRE_NO_UTF8_CHECK option when  checks for performance reasons, you can set the PCRE_NO_UTF8_CHECK option when
# Line 1199  to match the pattern, but at some point Line 1375  to match the pattern, but at some point
1375  the subject was reached (that is, the subject partially matches the pattern and  the subject was reached (that is, the subject partially matches the pattern and
1376  the failure to match occurred only because there were not enough subject  the failure to match occurred only because there were not enough subject
1377  characters), \fBpcre_exec()\fP returns PCRE_ERROR_PARTIAL instead of  characters), \fBpcre_exec()\fP returns PCRE_ERROR_PARTIAL instead of
1378  PCRE_ERROR_NOMATCH. When PCRE_PARTIAL is used, there are restrictions on what  PCRE_ERROR_NOMATCH. The portion of the string that provided the longest partial
1379  may appear in the pattern. These are discussed in the  match is set as the first matching string. There is further discussion in the
1380  .\" HREF  .\" HREF
1381  \fBpcrepartial\fP  \fBpcrepartial\fP
1382  .\"  .\"
# Line 1210  documentation. Line 1386  documentation.
1386  .rs  .rs
1387  .sp  .sp
1388  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
1389  \fIsubject\fP, a length in \fIlength\fP, and a starting byte offset in  \fIsubject\fP, a length (in bytes) in \fIlength\fP, and a starting byte offset
1390  \fIstartoffset\fP. In UTF-8 mode, the byte offset must point to the start of a  in \fIstartoffset\fP. In UTF-8 mode, the byte offset must point to the start of
1391  UTF-8 character. Unlike the pattern string, the subject may contain binary zero  a UTF-8 character. Unlike the pattern string, the subject may contain binary
1392  bytes. When the starting offset is zero, the search for a match starts at the  zero bytes. When the starting offset is zero, the search for a match starts at
1393  beginning of the subject, and this is by far the most common case.  the beginning of the subject, and this is by far the most common case.
1394  .P  .P
1395  A non-zero starting offset is useful when searching for another match in the  A non-zero starting offset is useful when searching for another match in the
1396  same subject by calling \fBpcre_exec()\fP again after a previous success.  same subject by calling \fBpcre_exec()\fP again after a previous success.
# Line 1248  pattern. Following the usage in Jeffrey Line 1424  pattern. Following the usage in Jeffrey
1424  a fragment of a pattern that picks out a substring. PCRE supports several other  a fragment of a pattern that picks out a substring. PCRE supports several other
1425  kinds of parenthesized subpattern that do not cause substrings to be captured.  kinds of parenthesized subpattern that do not cause substrings to be captured.
1426  .P  .P
1427  Captured substrings are returned to the caller via a vector of integer offsets  Captured substrings are returned to the caller via a vector of integers whose
1428  whose address is passed in \fIovector\fP. The number of elements in the vector  address is passed in \fIovector\fP. The number of elements in the vector is
1429  is passed in \fIovecsize\fP, which must be a non-negative number. \fBNote\fP:  passed in \fIovecsize\fP, which must be a non-negative number. \fBNote\fP: this
1430  this argument is NOT the size of \fIovector\fP in bytes.  argument is NOT the size of \fIovector\fP in bytes.
1431  .P  .P
1432  The first two-thirds of the vector is used to pass back captured substrings,  The first two-thirds of the vector is used to pass back captured substrings,
1433  each substring using a pair of integers. The remaining third of the vector is  each substring using a pair of integers. The remaining third of the vector is
1434  used as workspace by \fBpcre_exec()\fP while matching capturing subpatterns,  used as workspace by \fBpcre_exec()\fP while matching capturing subpatterns,
1435  and is not available for passing back information. The length passed in  and is not available for passing back information. The number passed in
1436  \fIovecsize\fP should always be a multiple of three. If it is not, it is  \fIovecsize\fP should always be a multiple of three. If it is not, it is
1437  rounded down.  rounded down.
1438  .P  .P
1439  When a match is successful, information about captured substrings is returned  When a match is successful, information about captured substrings is returned
1440  in pairs of integers, starting at the beginning of \fIovector\fP, and  in pairs of integers, starting at the beginning of \fIovector\fP, and
1441  continuing up to two-thirds of its length at the most. The first element of a  continuing up to two-thirds of its length at the most. The first element of
1442  pair is set to the offset of the first character in a substring, and the second  each pair is set to the byte offset of the first character in a substring, and
1443  is set to the offset of the first character after the end of a substring. The  the second is set to the byte offset of the first character after the end of a
1444  first pair, \fIovector[0]\fP and \fIovector[1]\fP, identify the portion of the  substring. \fBNote\fP: these values are always byte offsets, even in UTF-8
1445  subject string matched by the entire pattern. The next pair is used for the  mode. They are not character counts.
1446  first capturing subpattern, and so on. The value returned by \fBpcre_exec()\fP  .P
1447  is one more than the highest numbered pair that has been set. For example, if  The first pair of integers, \fIovector[0]\fP and \fIovector[1]\fP, identify the
1448  two substrings have been captured, the returned value is 3. If there are no  portion of the subject string matched by the entire pattern. The next pair is
1449  capturing subpatterns, the return value from a successful match is 1,  used for the first capturing subpattern, and so on. The value returned by
1450  indicating that just the first pair of offsets has been set.  \fBpcre_exec()\fP is one more than the highest numbered pair that has been set.
1451    For example, if two substrings have been captured, the returned value is 3. If
1452    there are no capturing subpatterns, the return value from a successful match is
1453    1, indicating that just the first pair of offsets has been set.
1454  .P  .P
1455  If a capturing subpattern is matched repeatedly, it is the last portion of the  If a capturing subpattern is matched repeatedly, it is the last portion of the
1456  string that it matched that is returned.  string that it matched that is returned.
1457  .P  .P
1458  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
1459  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
1460  returns a value of zero. In particular, if the substring offsets are not of  returns a value of zero. If the substring offsets are not of interest,
1461  interest, \fBpcre_exec()\fP may be called with \fIovector\fP passed as NULL and  \fBpcre_exec()\fP may be called with \fIovector\fP passed as NULL and
1462  \fIovecsize\fP as zero. However, if the pattern contains back references and  \fIovecsize\fP as zero. However, if the pattern contains back references and
1463  the \fIovector\fP is not big enough to remember the related substrings, PCRE  the \fIovector\fP is not big enough to remember the related substrings, PCRE
1464  has to get additional memory for use during matching. Thus it is usually  has to get additional memory for use during matching. Thus it is usually
# Line 1336  compiled in an environment of one endian Line 1515  compiled in an environment of one endian
1515  other endianness. This is the error that PCRE gives when the magic number is  other endianness. This is the error that PCRE gives when the magic number is
1516  not present.  not present.
1517  .sp  .sp
1518    PCRE_ERROR_UNKNOWN_NODE   (-5)    PCRE_ERROR_UNKNOWN_OPCODE (-5)
1519  .sp  .sp
1520  While running the pattern match, an unknown item was encountered in the  While running the pattern match, an unknown item was encountered in the
1521  compiled pattern. This error could be caused by a bug in PCRE or by overwriting  compiled pattern. This error could be caused by a bug in PCRE or by overwriting
# Line 1362  The backtracking limit, as specified by Line 1541  The backtracking limit, as specified by
1541  \fBpcre_extra\fP structure (or defaulted) was reached. See the description  \fBpcre_extra\fP structure (or defaulted) was reached. See the description
1542  above.  above.
1543  .sp  .sp
   PCRE_ERROR_RECURSIONLIMIT (-21)  
 .sp  
 The internal recursion limit, as specified by the \fImatch_limit_recursion\fP  
 field in a \fBpcre_extra\fP structure (or defaulted) was reached. See the  
 description above.  
 .sp  
1544    PCRE_ERROR_CALLOUT        (-9)    PCRE_ERROR_CALLOUT        (-9)
1545  .sp  .sp
1546  This error is never generated by \fBpcre_exec()\fP itself. It is provided for  This error is never generated by \fBpcre_exec()\fP itself. It is provided for
# Line 1396  documentation for details of partial mat Line 1569  documentation for details of partial mat
1569  .sp  .sp
1570    PCRE_ERROR_BADPARTIAL     (-13)    PCRE_ERROR_BADPARTIAL     (-13)
1571  .sp  .sp
1572  The PCRE_PARTIAL option was used with a compiled pattern containing items that  This code is no longer in use. It was formerly returned when the PCRE_PARTIAL
1573  are not supported for partial matching. See the  option was used with a compiled pattern containing items that were not
1574  .\" HREF  supported for partial matching. From release 8.00 onwards, there are no
1575  \fBpcrepartial\fP  restrictions on partial matching.
 .\"  
 documentation for details of partial matching.  
1576  .sp  .sp
1577    PCRE_ERROR_INTERNAL       (-14)    PCRE_ERROR_INTERNAL       (-14)
1578  .sp  .sp
# Line 1411  in PCRE or by overwriting of the compile Line 1582  in PCRE or by overwriting of the compile
1582    PCRE_ERROR_BADCOUNT       (-15)    PCRE_ERROR_BADCOUNT       (-15)
1583  .sp  .sp
1584  This error is given if the value of the \fIovecsize\fP argument is negative.  This error is given if the value of the \fIovecsize\fP argument is negative.
1585    .sp
1586      PCRE_ERROR_RECURSIONLIMIT (-21)
1587    .sp
1588    The internal recursion limit, as specified by the \fImatch_limit_recursion\fP
1589    field in a \fBpcre_extra\fP structure (or defaulted) was reached. See the
1590    description above.
1591    .sp
1592      PCRE_ERROR_BADNEWLINE     (-23)
1593    .sp
1594    An invalid combination of PCRE_NEWLINE_\fIxxx\fP options was given.
1595    .P
1596    Error numbers -16 to -20 and -22 are not used by \fBpcre_exec()\fP.
1597  .  .
1598  .  .
1599  .SH "EXTRACTING CAPTURED SUBSTRINGS BY NUMBER"  .SH "EXTRACTING CAPTURED SUBSTRINGS BY NUMBER"
# Line 1422  This error is given if the value of the Line 1605  This error is given if the value of the
1605  .ti +5n  .ti +5n
1606  .B int \fIbuffersize\fP);  .B int \fIbuffersize\fP);
1607  .PP  .PP
 .br  
1608  .B int pcre_get_substring(const char *\fIsubject\fP, int *\fIovector\fP,  .B int pcre_get_substring(const char *\fIsubject\fP, int *\fIovector\fP,
1609  .ti +5n  .ti +5n
1610  .B int \fIstringcount\fP, int \fIstringnumber\fP,  .B int \fIstringcount\fP, int \fIstringnumber\fP,
1611  .ti +5n  .ti +5n
1612  .B const char **\fIstringptr\fP);  .B const char **\fIstringptr\fP);
1613  .PP  .PP
 .br  
1614  .B int pcre_get_substring_list(const char *\fIsubject\fP,  .B int pcre_get_substring_list(const char *\fIsubject\fP,
1615  .ti +5n  .ti +5n
1616  .B int *\fIovector\fP, int \fIstringcount\fP, "const char ***\fIlistptr\fP);"  .B int *\fIovector\fP, int \fIstringcount\fP, "const char ***\fIlistptr\fP);"
# Line 1468  the string is placed in \fIbuffer\fP, wh Line 1649  the string is placed in \fIbuffer\fP, wh
1649  \fIbuffersize\fP, while for \fBpcre_get_substring()\fP a new block of memory is  \fIbuffersize\fP, while for \fBpcre_get_substring()\fP a new block of memory is
1650  obtained via \fBpcre_malloc\fP, and its address is returned via  obtained via \fBpcre_malloc\fP, and its address is returned via
1651  \fIstringptr\fP. The yield of the function is the length of the string, not  \fIstringptr\fP. The yield of the function is the length of the string, not
1652  including the terminating zero, or one of  including the terminating zero, or one of these error codes:
1653  .sp  .sp
1654    PCRE_ERROR_NOMEMORY       (-6)    PCRE_ERROR_NOMEMORY       (-6)
1655  .sp  .sp
# Line 1484  and builds a list of pointers to them. A Line 1665  and builds a list of pointers to them. A
1665  memory that is obtained via \fBpcre_malloc\fP. The address of the memory block  memory that is obtained via \fBpcre_malloc\fP. The address of the memory block
1666  is returned via \fIlistptr\fP, which is also the start of the list of string  is returned via \fIlistptr\fP, which is also the start of the list of string
1667  pointers. The end of the list is marked by a NULL pointer. The yield of the  pointers. The end of the list is marked by a NULL pointer. The yield of the
1668  function is zero if all went well, or  function is zero if all went well, or the error code
1669  .sp  .sp
1670    PCRE_ERROR_NOMEMORY       (-6)    PCRE_ERROR_NOMEMORY       (-6)
1671  .sp  .sp
# Line 1515  provided. Line 1696  provided.
1696  .ti +5n  .ti +5n
1697  .B const char *\fIname\fP);  .B const char *\fIname\fP);
1698  .PP  .PP
 .br  
1699  .B int pcre_copy_named_substring(const pcre *\fIcode\fP,  .B int pcre_copy_named_substring(const pcre *\fIcode\fP,
1700  .ti +5n  .ti +5n
1701  .B const char *\fIsubject\fP, int *\fIovector\fP,  .B const char *\fIsubject\fP, int *\fIovector\fP,
# Line 1524  provided. Line 1704  provided.
1704  .ti +5n  .ti +5n
1705  .B char *\fIbuffer\fP, int \fIbuffersize\fP);  .B char *\fIbuffer\fP, int \fIbuffersize\fP);
1706  .PP  .PP
 .br  
1707  .B int pcre_get_named_substring(const pcre *\fIcode\fP,  .B int pcre_get_named_substring(const pcre *\fIcode\fP,
1708  .ti +5n  .ti +5n
1709  .B const char *\fIsubject\fP, int *\fIovector\fP,  .B const char *\fIsubject\fP, int *\fIovector\fP,
# Line 1536  provided. Line 1715  provided.
1715  To extract a substring by name, you first have to find associated number.  To extract a substring by name, you first have to find associated number.
1716  For example, for this pattern  For example, for this pattern
1717  .sp  .sp
1718    (a+)b(?P<xxx>\ed+)...    (a+)b(?<xxx>\ed+)...
1719  .sp  .sp
1720  the number of the subpattern called "xxx" is 2. If the name is known to be  the number of the subpattern called "xxx" is 2. If the name is known to be
1721  unique (PCRE_DUPNAMES was not set), you can find the number from the name by  unique (PCRE_DUPNAMES was not set), you can find the number from the name by
# Line 1560  pattern. This is needed in order to gain Line 1739  pattern. This is needed in order to gain
1739  translation table.  translation table.
1740  .P  .P
1741  These functions call \fBpcre_get_stringnumber()\fP, and if it succeeds, they  These functions call \fBpcre_get_stringnumber()\fP, and if it succeeds, they
1742  then call \fIpcre_copy_substring()\fP or \fIpcre_get_substring()\fP, as  then call \fBpcre_copy_substring()\fP or \fBpcre_get_substring()\fP, as
1743  appropriate.  appropriate. \fBNOTE:\fP If PCRE_DUPNAMES is set and there are duplicate names,
1744  .  the behaviour may not be what you want (see the next section).
1745    .P
1746    \fBWarning:\fP If the pattern uses the "(?|" feature to set up multiple
1747    subpatterns with the same number, you cannot use names to distinguish them,
1748    because names are not included in the compiled code. The matching process uses
1749    only numbers.
1750  .  .
1751  .SH "DUPLICATE SUBPATTERN NAMES"  .SH "DUPLICATE SUBPATTERN NAMES"
1752  .rs  .rs
# Line 1578  example is shown in the Line 1762  example is shown in the
1762  .\" HREF  .\" HREF
1763  \fBpcrepattern\fP  \fBpcrepattern\fP
1764  .\"  .\"
1765  documentation. When duplicates are present, \fBpcre_copy_named_substring()\fP  documentation.
1766  and \fBpcre_get_named_substring()\fP return the first substring corresponding  .P
1767  to the given name that is set. If none are set, an empty string is returned.  When duplicates are present, \fBpcre_copy_named_substring()\fP and
1768  The \fBpcre_get_stringnumber()\fP function returns one of the numbers that are  \fBpcre_get_named_substring()\fP return the first substring corresponding to
1769  associated with the name, but it is not defined which it is.  the given name that is set. If none are set, PCRE_ERROR_NOSUBSTRING (-7) is
1770  .sp  returned; no data is returned. The \fBpcre_get_stringnumber()\fP function
1771    returns one of the numbers that are associated with the name, but it is not
1772    defined which it is.
1773    .P
1774  If you want to get full details of all captured substrings for a given name,  If you want to get full details of all captured substrings for a given name,
1775  you must use the \fBpcre_get_stringtable_entries()\fP function. The first  you must use the \fBpcre_get_stringtable_entries()\fP function. The first
1776  argument is the compiled pattern, and the second is the name. The third and  argument is the compiled pattern, and the second is the name. The third and
1777  fourth are pointers to variables which are updated by the function. After it  fourth are pointers to variables which are updated by the function. After it
1778  has run, they point to the first and last entries in the name-to-number table  has run, they point to the first and last entries in the name-to-number table
1779  for the given name. The function itself returns the length of each entry, or  for the given name. The function itself returns the length of each entry, or
1780  PCRE_ERROR_NOSUBSTRING if there are none. The format of the table is described  PCRE_ERROR_NOSUBSTRING (-7) if there are none. The format of the table is
1781  above in the section entitled \fIInformation about a pattern\fP. Given all the  described above in the section entitled \fIInformation about a pattern\fP.
1782  relevant entries for the name, you can extract each of their numbers, and hence  Given all the relevant entries for the name, you can extract each of their
1783  the captured data, if any.  numbers, and hence the captured data, if any.
1784  .  .
1785  .  .
1786  .SH "FINDING ALL POSSIBLE MATCHES"  .SH "FINDING ALL POSSIBLE MATCHES"
# Line 1631  will yield PCRE_ERROR_NOMATCH. Line 1818  will yield PCRE_ERROR_NOMATCH.
1818  .B int *\fIworkspace\fP, int \fIwscount\fP);  .B int *\fIworkspace\fP, int \fIwscount\fP);
1819  .P  .P
1820  The function \fBpcre_dfa_exec()\fP is called to match a subject string against  The function \fBpcre_dfa_exec()\fP is called to match a subject string against
1821  a compiled pattern, using a "DFA" matching algorithm. This has different  a compiled pattern, using a matching algorithm that scans the subject string
1822  characteristics to the normal algorithm, and is not compatible with Perl. Some  just once, and does not backtrack. This has different characteristics to the
1823  of the features of PCRE patterns are not supported. Nevertheless, there are  normal algorithm, and is not compatible with Perl. Some of the features of PCRE
1824  times when this kind of matching can be useful. For a discussion of the two  patterns are not supported. Nevertheless, there are times when this kind of
1825  matching algorithms, see the  matching can be useful. For a discussion of the two matching algorithms, see
1826    the
1827  .\" HREF  .\" HREF
1828  \fBpcrematching\fP  \fBpcrematching\fP
1829  .\"  .\"
# Line 1676  The unused bits of the \fIoptions\fP arg Line 1864  The unused bits of the \fIoptions\fP arg
1864  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,
1865  PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NO_UTF8_CHECK, PCRE_PARTIAL,  PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NO_UTF8_CHECK, PCRE_PARTIAL,
1866  PCRE_DFA_SHORTEST, and PCRE_DFA_RESTART. All but the last three of these are  PCRE_DFA_SHORTEST, and PCRE_DFA_RESTART. All but the last three of these are
1867  the same as for \fBpcre_exec()\fP, so their description is not repeated here.  exactly the same as for \fBpcre_exec()\fP, so their description is not repeated
1868    here.
1869  .sp  .sp
1870    PCRE_PARTIAL    PCRE_PARTIAL
1871  .sp  .sp
# Line 1685  details are slightly different. When PCR Line 1874  details are slightly different. When PCR
1874  \fBpcre_dfa_exec()\fP, the return code PCRE_ERROR_NOMATCH is converted into  \fBpcre_dfa_exec()\fP, the return code PCRE_ERROR_NOMATCH is converted into
1875  PCRE_ERROR_PARTIAL if the end of the subject is reached, there have been no  PCRE_ERROR_PARTIAL if the end of the subject is reached, there have been no
1876  complete matches, but there is still at least one matching possibility. The  complete matches, but there is still at least one matching possibility. The
1877  portion of the string that provided the partial match is set as the first  portion of the string that provided the longest partial match is set as the
1878  matching string.  first matching string.
1879  .sp  .sp
1880    PCRE_DFA_SHORTEST    PCRE_DFA_SHORTEST
1881  .sp  .sp
1882  Setting the PCRE_DFA_SHORTEST option causes the matching algorithm to stop as  Setting the PCRE_DFA_SHORTEST option causes the matching algorithm to stop as
1883  soon as it has found one match. Because of the way the DFA algorithm works,  soon as it has found one match. Because of the way the alternative algorithm
1884  this is necessarily the shortest possible match at the first possible matching  works, this is necessarily the shortest possible match at the first possible
1885  point in the subject string.  matching point in the subject string.
1886  .sp  .sp
1887    PCRE_DFA_RESTART    PCRE_DFA_RESTART
1888  .sp  .sp
# Line 1732  the three matched strings are Line 1921  the three matched strings are
1921  On success, the yield of the function is a number greater than zero, which is  On success, the yield of the function is a number greater than zero, which is
1922  the number of matched substrings. The substrings themselves are returned in  the number of matched substrings. The substrings themselves are returned in
1923  \fIovector\fP. Each string uses two elements; the first is the offset to the  \fIovector\fP. Each string uses two elements; the first is the offset to the
1924  start, and the second is the offset to the end. All the strings have the same  start, and the second is the offset to the end. In fact, all the strings have
1925  start offset. (Space could have been saved by giving this only once, but it was  the same start offset. (Space could have been saved by giving this only once,
1926  decided to retain some compatibility with the way \fBpcre_exec()\fP returns  but it was decided to retain some compatibility with the way \fBpcre_exec()\fP
1927  data, even though the meaning of the strings is different.)  returns data, even though the meaning of the strings is different.)
1928  .P  .P
1929  The strings are returned in reverse order of length; that is, the longest  The strings are returned in reverse order of length; that is, the longest
1930  matching string is given first. If there were too many matches to fit into  matching string is given first. If there were too many matches to fit into
# Line 1762  that it does not support, for instance, Line 1951  that it does not support, for instance,
1951  .sp  .sp
1952    PCRE_ERROR_DFA_UCOND      (-17)    PCRE_ERROR_DFA_UCOND      (-17)
1953  .sp  .sp
1954  This return is given if \fBpcre_dfa_exec()\fP encounters a condition item in a  This return is given if \fBpcre_dfa_exec()\fP encounters a condition item that
1955  pattern that uses a back reference for the condition. This is not supported.  uses a back reference for the condition, or a test for recursion in a specific
1956    group. These are not supported.
1957  .sp  .sp
1958    PCRE_ERROR_DFA_UMLIMIT    (-18)    PCRE_ERROR_DFA_UMLIMIT    (-18)
1959  .sp  .sp
# Line 1782  When a recursive subpattern is processed Line 1972  When a recursive subpattern is processed
1972  recursively, using private vectors for \fIovector\fP and \fIworkspace\fP. This  recursively, using private vectors for \fIovector\fP and \fIworkspace\fP. This
1973  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
1974  extremely rare, as a vector of size 1000 is used.  extremely rare, as a vector of size 1000 is used.
1975  .P  .
1976  .in 0  .
1977  Last updated: 08 June 2006  .SH "SEE ALSO"
1978  .br  .rs
1979  Copyright (c) 1997-2006 University of Cambridge.  .sp
1980    \fBpcrebuild\fP(3), \fBpcrecallout\fP(3), \fBpcrecpp(3)\fP(3),
1981    \fBpcrematching\fP(3), \fBpcrepartial\fP(3), \fBpcreposix\fP(3),
1982    \fBpcreprecompile\fP(3), \fBpcresample\fP(3), \fBpcrestack\fP(3).
1983    .
1984    .
1985    .SH AUTHOR
1986    .rs
1987    .sp
1988    .nf
1989    Philip Hazel
1990    University Computing Service
1991    Cambridge CB2 3QH, England.
1992    .fi
1993    .
1994    .
1995    .SH REVISION
1996    .rs
1997    .sp
1998    .nf
1999    Last updated: 26 August 2009
2000    Copyright (c) 1997-2009 University of Cambridge.
2001    .fi
Legend:
Removed from v.91  
changed lines
  Added in v.426
  ViewVC Help
Powered by ViewVC 1.1.5