Return to pcre_exec.3 CVS log

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

Annotation of embedaddon/pcre/doc/pcre_exec.3, revision 1.1

1.1     ! misho       1: .TH PCRE_EXEC 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 int pcre_exec(const pcre *\fIcode\fP, "const pcre_extra *\fIextra\fP,"
        !            11: .ti +5n
        !            12: .B "const char *\fIsubject\fP," int \fIlength\fP, int \fIstartoffset\fP,
        !            13: .ti +5n
        !            14: .B int \fIoptions\fP, int *\fIovector\fP, int \fIovecsize\fP);
        !            15: .
        !            16: .SH DESCRIPTION
        !            17: .rs
        !            18: .sp
        !            19: This function matches a compiled regular expression against a given subject
        !            20: string, using a matching algorithm that is similar to Perl's. It returns
        !            21: offsets to captured substrings. Its arguments are:
        !            22: .sp
        !            23:   \fIcode\fP         Points to the compiled pattern
        !            24:   \fIextra\fP        Points to an associated \fBpcre_extra\fP structure,
        !            25:                  or is NULL
        !            26:   \fIsubject\fP      Points to the subject string
        !            27:   \fIlength\fP       Length of the subject string, in bytes
        !            28:   \fIstartoffset\fP  Offset in bytes in the subject at which to
        !            29:                  start matching
        !            30:   \fIoptions\fP      Option bits
        !            31:   \fIovector\fP      Points to a vector of ints for result offsets
        !            32:   \fIovecsize\fP     Number of elements in the vector (a multiple of 3)
        !            33: .sp
        !            34: The options are:
        !            35: .sp
        !            36:   PCRE_ANCHORED          Match only at the first position
        !            37:   PCRE_BSR_ANYCRLF       \eR matches only CR, LF, or CRLF
        !            38:   PCRE_BSR_UNICODE       \eR matches all Unicode line endings
        !            39:   PCRE_NEWLINE_ANY       Recognize any Unicode newline sequence
        !            40:   PCRE_NEWLINE_ANYCRLF   Recognize CR, LF, & CRLF as newline sequences
        !            41:   PCRE_NEWLINE_CR        Recognize CR as the only newline sequence
        !            42:   PCRE_NEWLINE_CRLF      Recognize CRLF as the only newline sequence
        !            43:   PCRE_NEWLINE_LF        Recognize LF as the only newline sequence
        !            44:   PCRE_NOTBOL            Subject string is not the beginning of a line
        !            45:   PCRE_NOTEOL            Subject string is not the end of a line
        !            46:   PCRE_NOTEMPTY          An empty string is not a valid match
        !            47:   PCRE_NOTEMPTY_ATSTART  An empty string at the start of the subject
        !            48:                            is not a valid match
        !            49:   PCRE_NO_START_OPTIMIZE Do not do "start-match" optimizations
        !            50:   PCRE_NO_UTF8_CHECK     Do not check the subject for UTF-8
        !            51:                            validity (only relevant if PCRE_UTF8
        !            52:                            was set at compile time)
        !            53:   PCRE_PARTIAL           ) Return PCRE_ERROR_PARTIAL for a partial
        !            54:   PCRE_PARTIAL_SOFT      )   match if no full matches are found
        !            55:   PCRE_PARTIAL_HARD      Return PCRE_ERROR_PARTIAL for a partial match
        !            56:                            if that is found before a full match
        !            57: .sp
        !            58: For details of partial matching, see the
        !            59: .\" HREF
        !            60: \fBpcrepartial\fP
        !            61: .\"
        !            62: page. A \fBpcre_extra\fP structure contains the following fields:
        !            63: .sp
        !            64:   \fIflags\fP            Bits indicating which fields are set
        !            65:   \fIstudy_data\fP       Opaque data from \fBpcre_study()\fP
        !            66:   \fImatch_limit\fP      Limit on internal resource use
        !            67:   \fImatch_limit_recursion\fP  Limit on internal recursion depth
        !            68:   \fIcallout_data\fP     Opaque data passed back to callouts
        !            69:   \fItables\fP           Points to character tables or is NULL
        !            70:   \fImark\fP             For passing back a *MARK pointer
        !            71:   \fIexecutable_jit\fP   Opaque data from JIT compilation
        !            72: .sp
        !            73: The flag bits are PCRE_EXTRA_STUDY_DATA, PCRE_EXTRA_MATCH_LIMIT,
        !            74: PCRE_EXTRA_MATCH_LIMIT_RECURSION, PCRE_EXTRA_CALLOUT_DATA,
        !            75: PCRE_EXTRA_TABLES, PCRE_EXTRA_MARK and PCRE_EXTRA_EXECUTABLE_JIT.
        !            76: .P
        !            77: There is a complete description of the PCRE native API in the
        !            78: .\" HREF
        !            79: \fBpcreapi\fP
        !            80: .\"
        !            81: page and a description of the POSIX API in the
        !            82: .\" HREF
        !            83: \fBpcreposix\fP
        !            84: .\"
        !            85: page.