src/external/pcre2-10.32/doc/html/pcre2_dfa_match.html

   1 <html>
   2 <head>
   3 <title>pcre2_dfa_match specification</title>
   4 </head>
   5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
   6 <h1>pcre2_dfa_match man page</h1>
   7 <p>
   8 Return to the <a href="index.html">PCRE2 index page</a>.
   9 </p>
  10 <p>
  11 This page is part of the PCRE2 HTML documentation. It was generated
  12 automatically from the original man page. If there is any nonsense in it,
  13 please consult the man page, in case the conversion went wrong.
  14 <br>
  15 <br><b>
  16 SYNOPSIS
  17 </b><br>
  18 <P>
  19 <b>#include &#60;pcre2.h&#62;</b>
  20 </P>
  21 <P>
  22 <b>int pcre2_dfa_match(const pcre2_code *<i>code</i>, PCRE2_SPTR <i>subject</i>,</b>
  23 <b>  PCRE2_SIZE <i>length</i>, PCRE2_SIZE <i>startoffset</i>,</b>
  24 <b>  uint32_t <i>options</i>, pcre2_match_data *<i>match_data</i>,</b>
  25 <b>  pcre2_match_context *<i>mcontext</i>,</b>
  26 <b>  int *<i>workspace</i>, PCRE2_SIZE <i>wscount</i>);</b>
  27 </P>
  28 <br><b>
  29 DESCRIPTION
  30 </b><br>
  31 <P>
  32 This function matches a compiled regular expression against a given subject
  33 string, using an alternative matching algorithm that scans the subject string
  34 just once (except when processing lookaround assertions). This function is
  35 <i>not</i> Perl-compatible (the Perl-compatible matching function is
  36 <b>pcre2_match()</b>). The arguments for this function are:
  37 <pre>
  38   <i>code</i>         Points to the compiled pattern
  39   <i>subject</i>      Points to the subject string
  40   <i>length</i>       Length of the subject string
  41   <i>startoffset</i>  Offset in the subject at which to start matching
  42   <i>options</i>      Option bits
  43   <i>match_data</i>   Points to a match data block, for results
  44   <i>mcontext</i>     Points to a match context, or is NULL
  45   <i>workspace</i>    Points to a vector of ints used as working space
  46   <i>wscount</i>      Number of elements in the vector
  47 </pre>
  48 For <b>pcre2_dfa_match()</b>, a match context is needed only if you want to set
  49 up a callout function or specify the heap limit or the match or the recursion
  50 depth limits. The <i>length</i> and <i>startoffset</i> values are code units, not
  51 characters. The options are:
  52 <pre>
  53   PCRE2_ANCHORED          Match only at the first position
  54   PCRE2_ENDANCHORED       Pattern can match only at end of subject
  55   PCRE2_NOTBOL            Subject is not the beginning of a line
  56   PCRE2_NOTEOL            Subject is not the end of a line
  57   PCRE2_NOTEMPTY          An empty string is not a valid match
  58   PCRE2_NOTEMPTY_ATSTART  An empty string at the start of the subject is not a valid match
  59   PCRE2_NO_UTF_CHECK      Do not check the subject for UTF validity (only relevant if PCRE2_UTF
  60                            was set at compile time)
  61   PCRE2_PARTIAL_HARD      Return PCRE2_ERROR_PARTIAL for a partial match even if there is a full match
  62   PCRE2_PARTIAL_SOFT      Return PCRE2_ERROR_PARTIAL for a partial match if no full matches are found
  63   PCRE2_DFA_RESTART       Restart after a partial match
  64   PCRE2_DFA_SHORTEST      Return only the shortest match
  65 </pre>
  66 There are restrictions on what may appear in a pattern when using this matching
  67 function. Details are given in the
  68 <a href="pcre2matching.html"><b>pcre2matching</b></a>
  69 documentation. For details of partial matching, see the
  70 <a href="pcre2partial.html"><b>pcre2partial</b></a>
  71 page. There is a complete description of the PCRE2 native API in the
  72 <a href="pcre2api.html"><b>pcre2api</b></a>
  73 page and a description of the POSIX API in the
  74 <a href="pcre2posix.html"><b>pcre2posix</b></a>
  75 page.
  76 <p>
  77 Return to the <a href="index.html">PCRE2 index page</a>.
  78 </p>