~ubuntu-branches/ubuntu/trusty/pcre3/trusty

« back to all changes in this revision

Viewing changes to doc/pcre_compile2.3

  • Committer: Package Import Robot
  • Author(s): Mark Baker
  • Date: 2012-03-23 22:34:54 UTC
  • mfrom: (23.1.9 sid)
  • Revision ID: package-import@ubuntu.com-20120323223454-grhqqolk8a7x1h24
Tags: 1:8.30-4
* Reluctantly using an epoch, as it seems the funny version number with
  extra dots causes problems
* Bumped standard version to 3.9.3. No changes needed
* Converted to use new source format / quilt
* Put back obsolete pcre_info() API that upstream have dropped (Closes:
  #665300, #665356)
* Don't include pcregrep binary in debug package

Thanks to Elimar Riesebieter for the conversion to the new source format.

Show diffs side-by-side

added added

removed removed

Lines of Context:
14
14
.B const char **\fIerrptr\fP, int *\fIerroffset\fP,
15
15
.ti +5n
16
16
.B const unsigned char *\fItableptr\fP);
 
17
.PP
 
18
.B pcre16 *pcre16_compile2(PCRE_SPTR16 \fIpattern\fP, int \fIoptions\fP,
 
19
.ti +5n
 
20
.B int *\fIerrorcodeptr\fP,
 
21
.ti +5n
 
22
.B const char **\fIerrptr\fP, int *\fIerroffset\fP,
 
23
.ti +5n
 
24
.B const unsigned char *\fItableptr\fP);
17
25
.
18
26
.SH DESCRIPTION
19
27
.rs
20
28
.sp
21
29
This function compiles a regular expression into an internal form. It is the
22
 
same as \fBpcre_compile()\fP, except for the addition of the \fIerrorcodeptr\fP
23
 
argument. The arguments are:
 
30
same as \fBpcre[16]_compile()\fP, except for the addition of the
 
31
\fIerrorcodeptr\fP argument. The arguments are:
24
32
.
25
33
.sp
26
34
  \fIpattern\fP       A zero-terminated string containing the
56
64
  PCRE_NEWLINE_LF         Set LF as the newline sequence
57
65
  PCRE_NO_AUTO_CAPTURE    Disable numbered capturing paren-
58
66
                            theses (named ones available)
 
67
  PCRE_NO_UTF16_CHECK     Do not check the pattern for UTF-16
 
68
                            validity (only relevant if
 
69
                            PCRE_UTF16 is set)
59
70
  PCRE_NO_UTF8_CHECK      Do not check the pattern for UTF-8
60
71
                            validity (only relevant if
61
72
                            PCRE_UTF8 is set)
62
73
  PCRE_UCP                Use Unicode properties for \ed, \ew, etc.
63
74
  PCRE_UNGREEDY           Invert greediness of quantifiers
64
 
  PCRE_UTF8               Run in UTF-8 mode
 
75
  PCRE_UTF16              Run \fBpcre16_compile()\fP in UTF-16 mode
 
76
  PCRE_UTF8               Run \fBpcre_compile()\fP in UTF-8 mode
65
77
.sp
66
 
PCRE must be built with UTF-8 support in order to use PCRE_UTF8 and
67
 
PCRE_NO_UTF8_CHECK, and with UCP support if PCRE_UCP is used.
 
78
PCRE must be built with UTF support in order to use PCRE_UTF8/16 and
 
79
PCRE_NO_UTF8/16_CHECK, and with UCP support if PCRE_UCP is used.
68
80
.P
69
81
The yield of the function is a pointer to a private data structure that
70
82
contains the compiled pattern, or NULL if an error was detected. Note that