"Fossies" - the Fresh Open Source Software Archive

Member "pcre-8.42/doc/html/pcre_dfa_exec.html" (20 Mar 2018, 5969 Bytes) of package /linux/misc/pcre-8.42.tar.bz2:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) HTML source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 <html>
    2 <head>
    3 <title>pcre_dfa_exec specification</title>
    4 </head>
    5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
    6 <h1>pcre_dfa_exec man page</h1>
    7 <p>
    8 Return to the <a href="index.html">PCRE index page</a>.
    9 </p>
   10 <p>
   11 This page is part of the PCRE HTML documentation. It was generated automatically
   12 from the original man page. If there is any nonsense in it, please consult the
   13 man page, in case the conversion went wrong.
   14 <br>
   15 <br><b>
   16 SYNOPSIS
   17 </b><br>
   18 <P>
   19 <b>#include &#60;pcre.h&#62;</b>
   20 </P>
   21 <P>
   22 <b>int pcre_dfa_exec(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b>
   23 <b>     const char *<i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b>
   24 <b>     int <i>options</i>, int *<i>ovector</i>, int <i>ovecsize</i>,</b>
   25 <b>     int *<i>workspace</i>, int <i>wscount</i>);</b>
   26 <br>
   27 <br>
   28 <b>int pcre16_dfa_exec(const pcre16 *<i>code</i>, const pcre16_extra *<i>extra</i>,</b>
   29 <b>     PCRE_SPTR16 <i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b>
   30 <b>     int <i>options</i>, int *<i>ovector</i>, int <i>ovecsize</i>,</b>
   31 <b>     int *<i>workspace</i>, int <i>wscount</i>);</b>
   32 <br>
   33 <br>
   34 <b>int pcre32_dfa_exec(const pcre32 *<i>code</i>, const pcre32_extra *<i>extra</i>,</b>
   35 <b>     PCRE_SPTR32 <i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b>
   36 <b>     int <i>options</i>, int *<i>ovector</i>, int <i>ovecsize</i>,</b>
   37 <b>     int *<i>workspace</i>, int <i>wscount</i>);</b>
   38 </P>
   39 <br><b>
   40 DESCRIPTION
   41 </b><br>
   42 <P>
   43 This function matches a compiled regular expression against a given subject
   44 string, using an alternative matching algorithm that scans the subject string
   45 just once (<i>not</i> Perl-compatible). Note that the main, Perl-compatible,
   46 matching function is <b>pcre[16|32]_exec()</b>. The arguments for this function
   47 are:
   48 <pre>
   49   <i>code</i>         Points to the compiled pattern
   50   <i>extra</i>        Points to an associated <b>pcre[16|32]_extra</b> structure,
   51                  or is NULL
   52   <i>subject</i>      Points to the subject string
   53   <i>length</i>       Length of the subject string
   54   <i>startoffset</i>  Offset in the subject at which to start matching
   55   <i>options</i>      Option bits
   56   <i>ovector</i>      Points to a vector of ints for result offsets
   57   <i>ovecsize</i>     Number of elements in the vector
   58   <i>workspace</i>    Points to a vector of ints used as working space
   59   <i>wscount</i>      Number of elements in the vector
   60 </pre>
   61 The units for <i>length</i> and <i>startoffset</i> are bytes for
   62 <b>pcre_exec()</b>, 16-bit data items for <b>pcre16_exec()</b>, and 32-bit items
   63 for <b>pcre32_exec()</b>. The options are:
   64 <pre>
   65   PCRE_ANCHORED          Match only at the first position
   66   PCRE_BSR_ANYCRLF       \R matches only CR, LF, or CRLF
   67   PCRE_BSR_UNICODE       \R matches all Unicode line endings
   68   PCRE_NEWLINE_ANY       Recognize any Unicode newline sequence
   69   PCRE_NEWLINE_ANYCRLF   Recognize CR, LF, & CRLF as newline sequences
   70   PCRE_NEWLINE_CR        Recognize CR as the only newline sequence
   71   PCRE_NEWLINE_CRLF      Recognize CRLF as the only newline sequence
   72   PCRE_NEWLINE_LF        Recognize LF as the only newline sequence
   73   PCRE_NOTBOL            Subject is not the beginning of a line
   74   PCRE_NOTEOL            Subject is not the end of a line
   75   PCRE_NOTEMPTY          An empty string is not a valid match
   76   PCRE_NOTEMPTY_ATSTART  An empty string at the start of the subject
   77                            is not a valid match
   78   PCRE_NO_START_OPTIMIZE Do not do "start-match" optimizations
   79   PCRE_NO_UTF16_CHECK    Do not check the subject for UTF-16
   80                            validity (only relevant if PCRE_UTF16
   81                            was set at compile time)
   82   PCRE_NO_UTF32_CHECK    Do not check the subject for UTF-32
   83                            validity (only relevant if PCRE_UTF32
   84                            was set at compile time)
   85   PCRE_NO_UTF8_CHECK     Do not check the subject for UTF-8
   86                            validity (only relevant if PCRE_UTF8
   87                            was set at compile time)
   88   PCRE_PARTIAL           ) Return PCRE_ERROR_PARTIAL for a partial
   89   PCRE_PARTIAL_SOFT      )   match if no full matches are found
   90   PCRE_PARTIAL_HARD      Return PCRE_ERROR_PARTIAL for a partial match
   91                            even if there is a full match as well
   92   PCRE_DFA_SHORTEST      Return only the shortest match
   93   PCRE_DFA_RESTART       Restart after a partial match
   94 </pre>
   95 There are restrictions on what may appear in a pattern when using this matching
   96 function. Details are given in the
   97 <a href="pcrematching.html"><b>pcrematching</b></a>
   98 documentation. For details of partial matching, see the
   99 <a href="pcrepartial.html"><b>pcrepartial</b></a>
  100 page.
  101 </P>
  102 <P>
  103 A <b>pcre[16|32]_extra</b> structure contains the following fields:
  104 <pre>
  105   <i>flags</i>            Bits indicating which fields are set
  106   <i>study_data</i>       Opaque data from <b>pcre[16|32]_study()</b>
  107   <i>match_limit</i>      Limit on internal resource use
  108   <i>match_limit_recursion</i>  Limit on internal recursion depth
  109   <i>callout_data</i>     Opaque data passed back to callouts
  110   <i>tables</i>           Points to character tables or is NULL
  111   <i>mark</i>             For passing back a *MARK pointer
  112   <i>executable_jit</i>   Opaque data from JIT compilation
  113 </pre>
  114 The flag bits are PCRE_EXTRA_STUDY_DATA, PCRE_EXTRA_MATCH_LIMIT,
  115 PCRE_EXTRA_MATCH_LIMIT_RECURSION, PCRE_EXTRA_CALLOUT_DATA,
  116 PCRE_EXTRA_TABLES, PCRE_EXTRA_MARK and PCRE_EXTRA_EXECUTABLE_JIT. For this
  117 matching function, the <i>match_limit</i> and <i>match_limit_recursion</i> fields
  118 are not used, and must not be set. The PCRE_EXTRA_EXECUTABLE_JIT flag and
  119 the corresponding variable are ignored.
  120 </P>
  121 <P>
  122 There is a complete description of the PCRE native API in the
  123 <a href="pcreapi.html"><b>pcreapi</b></a>
  124 page and a description of the POSIX API in the
  125 <a href="pcreposix.html"><b>pcreposix</b></a>
  126 page.
  127 <p>
  128 Return to the <a href="index.html">PCRE index page</a>.
  129 </p>