Return to pcre_compile.3 CVS log

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

Annotation of embedaddon/pcre/doc/pcre_compile.3, revision 1.1.1.2

1.1       misho       1: .TH PCRE_COMPILE 3
                      2: .SH NAME
                      3: PCRE - Perl-compatible regular expressions
                      4: .SH SYNOPSIS
                      5: .rs
                      6: .sp
                      7: .B #include <pcre.h>
                      8: .PP
                      9: .SM
                     10: .B pcre *pcre_compile(const char *\fIpattern\fP, int \fIoptions\fP,
                     11: .ti +5n
                     12: .B const char **\fIerrptr\fP, int *\fIerroffset\fP,
                     13: .ti +5n
                     14: .B const unsigned char *\fItableptr\fP);
1.1.1.2 ! misho      15: .PP
        !            16: .B pcre16 *pcre16_compile(PCRE_SPTR16 \fIpattern\fP, int \fIoptions\fP,
        !            17: .ti +5n
        !            18: .B const char **\fIerrptr\fP, int *\fIerroffset\fP,
        !            19: .ti +5n
        !            20: .B const unsigned char *\fItableptr\fP);
1.1       misho      21: .
                     22: .SH DESCRIPTION
                     23: .rs
                     24: .sp
                     25: This function compiles a regular expression into an internal form. It is the
1.1.1.2 ! misho      26: same as \fBpcre[16]_compile2()\fP, except for the absence of the
        !            27: \fIerrorcodeptr\fP argument. Its arguments are:
1.1       misho      28: .sp
                     29:   \fIpattern\fP       A zero-terminated string containing the
                     30:                   regular expression to be compiled
                     31:   \fIoptions\fP       Zero or more option bits
                     32:   \fIerrptr\fP        Where to put an error message
                     33:   \fIerroffset\fP     Offset in pattern where error was found
                     34:   \fItableptr\fP      Pointer to character tables, or NULL to
                     35:                   use the built-in default
                     36: .sp
                     37: The option bits are:
                     38: .sp
                     39:   PCRE_ANCHORED           Force pattern anchoring
                     40:   PCRE_AUTO_CALLOUT       Compile automatic callouts
                     41:   PCRE_BSR_ANYCRLF        \eR matches only CR, LF, or CRLF
                     42:   PCRE_BSR_UNICODE        \eR matches all Unicode line endings
                     43:   PCRE_CASELESS           Do caseless matching
                     44:   PCRE_DOLLAR_ENDONLY     $ not to match newline at end
                     45:   PCRE_DOTALL             . matches anything including NL
                     46:   PCRE_DUPNAMES           Allow duplicate names for subpatterns
                     47:   PCRE_EXTENDED           Ignore whitespace and # comments
                     48:   PCRE_EXTRA              PCRE extra features
                     49:                             (not much use currently)
                     50:   PCRE_FIRSTLINE          Force matching to be before newline
                     51:   PCRE_JAVASCRIPT_COMPAT  JavaScript compatibility
                     52:   PCRE_MULTILINE          ^ and $ match newlines within data
                     53:   PCRE_NEWLINE_ANY        Recognize any Unicode newline sequence
                     54:   PCRE_NEWLINE_ANYCRLF    Recognize CR, LF, and CRLF as newline
                     55:                             sequences
                     56:   PCRE_NEWLINE_CR         Set CR as the newline sequence
                     57:   PCRE_NEWLINE_CRLF       Set CRLF as the newline sequence
                     58:   PCRE_NEWLINE_LF         Set LF as the newline sequence
                     59:   PCRE_NO_AUTO_CAPTURE    Disable numbered capturing paren-
                     60:                             theses (named ones available)
1.1.1.2 ! misho      61:   PCRE_NO_UTF16_CHECK     Do not check the pattern for UTF-16
        !            62:                             validity (only relevant if
        !            63:                             PCRE_UTF16 is set)
1.1       misho      64:   PCRE_NO_UTF8_CHECK      Do not check the pattern for UTF-8
                     65:                             validity (only relevant if
                     66:                             PCRE_UTF8 is set)
                     67:   PCRE_UCP                Use Unicode properties for \ed, \ew, etc.
                     68:   PCRE_UNGREEDY           Invert greediness of quantifiers
1.1.1.2 ! misho      69:   PCRE_UTF16              Run in \fBpcre16_compile()\fP UTF-16 mode
        !            70:   PCRE_UTF8               Run in \fBpcre_compile()\fP UTF-8 mode
1.1       misho      71: .sp
1.1.1.2 ! misho      72: PCRE must be built with UTF support in order to use PCRE_UTF8/16 and
        !            73: PCRE_NO_UTF8/16_CHECK, and with UCP support if PCRE_UCP is used.
1.1       misho      74: .P
                     75: The yield of the function is a pointer to a private data structure that
                     76: contains the compiled pattern, or NULL if an error was detected. Note that
                     77: compiling regular expressions with one version of PCRE for use with a different
                     78: version is not guaranteed to work and may cause crashes.
                     79: .P
                     80: There is a complete description of the PCRE native API in the
                     81: .\" HREF
                     82: \fBpcreapi\fP
                     83: .\"
                     84: page and a description of the POSIX API in the
                     85: .\" HREF
                     86: \fBpcreposix\fP
                     87: .\"
                     88: page.