boost-react-native-bundle

<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Struct template basic_regex</title> <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../xpressive/reference.html#header.boost.xpressive.xpressive_fwd_hpp" title="Header <boost/xpressive/xpressive_fwd.hpp>"> <link rel="prev" href="null_regex_traits.html" title="Struct template null_regex_traits"> <link rel="next" href="match_results.html" title="Struct template match_results"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> <td align="center"><a href="../../../../index.html">Home</a></td> <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> <td align="center"><a href="../../../../more/index.htm">More</a></td> </tr></table> <hr> <div class="spirit-nav"> <a accesskey="p" href="null_regex_traits.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../xpressive/reference.html#header.boost.xpressive.xpressive_fwd_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="match_results.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.xpressive.basic_regex"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Struct template basic_regex</h2> boost::xpressive::basic_regex — Class template <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a><> is a class for holding a compiled regular expression. </div> <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis">// In header: <<a class="link" href="../../xpressive/reference.html#header.boost.xpressive.xpressive_fwd_hpp" title="Header <boost/xpressive/xpressive_fwd.hpp>">boost/xpressive/xpressive_fwd.hpp</a>> template<typename BidiIter> struct <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a> { // <a class="link" href="basic_regex.html#boost.xpressive.basic_regexconstruct-copy-destruct">construct/copy/destruct</a> <a class="link" href="basic_regex.html#idp356776208-bb">basic_regex</a>(); <a class="link" href="basic_regex.html#idp356777616-bb">basic_regex</a>(<a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>< BidiIter > const &); template<typename <a class="link" href="../../Expr.html" title="Concept Expr">Expr</a>> <a class="link" href="basic_regex.html#idp356785744-bb">basic_regex</a>(Expr const &); <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>< BidiIter > & <a class="link" href="basic_regex.html#idp356781184-bb">operator=</a>(<a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>< BidiIter > const &); template<typename <a class="link" href="../../Expr.html" title="Concept Expr">Expr</a>> <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>< BidiIter > & <a class="link" href="basic_regex.html#idp356789888-bb">operator=</a>(Expr const &); // <a class="link" href="basic_regex.html#idp356765152-bb">public member functions</a> std::size_t <a class="link" href="basic_regex.html#idp356765712-bb">mark_count</a>() const; regex_id_type <a class="link" href="basic_regex.html#idp356767312-bb">regex_id</a>() const; void <a class="link" href="basic_regex.html#idp356768896-bb">swap</a>(<a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>< BidiIter > &); // <a class="link" href="basic_regex.html#idp356795728-bb">public static functions</a> template<typename InputIter> static <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>< BidiIter > <a class="link" href="basic_regex.html#idp356796288-bb">compile</a>(InputIter, InputIter, flag_type = regex_constants::ECMAScript); template<typename InputRange> static <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>< BidiIter > <a class="link" href="basic_regex.html#idp356806688-bb">compile</a>(InputRange const &, flag_type = regex_constants::ECMAScript); static <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>< BidiIter > <a class="link" href="basic_regex.html#idp356811168-bb">compile</a>(char_type const *, flag_type = regex_constants::ECMAScript); static <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>< BidiIter > <a class="link" href="basic_regex.html#idp356814800-bb">compile</a>(char_type const *, std::size_t, flag_type); };</pre></div> <div class="refsect1"> <a name="idp540528288"></a><h2>Description</h2> <div class="refsect2"> <a name="idp540528704"></a><h3> <a name="boost.xpressive.basic_regexconstruct-copy-destruct"></a><code class="computeroutput">basic_regex</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout"><a name="idp356776208-bb"></a>basic_regex();</pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody><tr> <td>Postconditions:</td> <td> regex_id() == 0 mark_count() == 0 </td> </tr></tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout"><a name="idp356777616-bb"></a>basic_regex(<a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>< BidiIter > const & that);</pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td>Parameters:</td> <td><div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody><tr> <td><code class="computeroutput">that</code></td> <td>The <code class="computeroutput"><a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a></code> object to copy. </td> </tr></tbody> </table></div></td> </tr> <tr> <td>Postconditions:</td> <td> regex_id() == that.regex_id() mark_count() == that.mark_count() </td> </tr> </tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout">template<typename <a class="link" href="../../Expr.html" title="Concept Expr">Expr</a>> <a name="idp356785744-bb"></a>basic_regex(Expr const & expr);</pre> Construct from a static regular expression. <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td>Parameters:</td> <td><div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody><tr> <td><code class="computeroutput">expr</code></td> <td>The static regular expression </td> </tr></tbody> </table></div></td> </tr> <tr> <td>Requires:</td> <td>Expr is the type of a static regular expression. </td> </tr> <tr> <td>Postconditions:</td> <td> regex_id() != 0 mark_count() >= 0 </td> </tr> </tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout"><a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>< BidiIter > & <a name="idp356781184-bb"></a>operator=(<a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>< BidiIter > const & that);</pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td>Parameters:</td> <td><div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody><tr> <td><code class="computeroutput">that</code></td> <td>The <code class="computeroutput"><a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a></code> object to copy. </td> </tr></tbody> </table></div></td> </tr> <tr> <td>Postconditions:</td> <td> regex_id() == that.regex_id() mark_count() == that.mark_count() </td> </tr> <tr> <td>Returns:</td> <td>*this </td> </tr> </tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout">template<typename <a class="link" href="../../Expr.html" title="Concept Expr">Expr</a>> <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>< BidiIter > & <a name="idp356789888-bb"></a>operator=(Expr const & expr);</pre> Construct from a static regular expression. <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td>Parameters:</td> <td><div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody><tr> <td><code class="computeroutput">expr</code></td> <td>The static regular expression. </td> </tr></tbody> </table></div></td> </tr> <tr> <td>Requires:</td> <td>Expr is the type of a static regular expression. </td> </tr> <tr> <td>Postconditions:</td> <td> regex_id() != 0 mark_count() >= 0 </td> </tr> <tr> <td>Returns:</td> <td>*this </td> </tr> <tr> <td>Throws:</td> <td>std::bad_alloc on out of memory </td> </tr> </tbody> </table></div> </li> </ol></div> </div> <div class="refsect2"> <a name="idp540602592"></a><h3> <a name="idp356765152-bb"></a><code class="computeroutput">basic_regex</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout">std::size_t <a name="idp356765712-bb"></a>mark_count() const;</pre> Returns the count of capturing sub-expressions in this regular expression </li> <li class="listitem"> <pre class="literallayout">regex_id_type <a name="idp356767312-bb"></a>regex_id() const;</pre> Returns a token which uniquely identifies this regular expression. </li> <li class="listitem"> <pre class="literallayout">void <a name="idp356768896-bb"></a>swap(<a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>< BidiIter > & that);</pre> Swaps the contents of this <code class="computeroutput"><a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a></code> object with another. <div class="note"><table border="0" summary="Note"> <tr> <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td> <th align="left">Note</th> </tr> <tr><td align="left" valign="top">This is a shallow swap that does not do reference tracking. If you embed a <code class="computeroutput"><a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a></code> object by reference in another regular expression and then swap its contents with another <code class="computeroutput"><a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a></code> object, the change will not be visible to the enclosing regular expression. It is done this way to ensure that swap() cannot throw. </td></tr> </table></div> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td>Parameters:</td> <td><div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody><tr> <td><code class="computeroutput">that</code></td> <td>The other <code class="computeroutput"><a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a></code> object. </td> </tr></tbody> </table></div></td> </tr> <tr> <td>Throws:</td> <td>Will not throw.</td> </tr> </tbody> </table></div> </li> </ol></div> </div> <div class="refsect2"> <a name="idp540634624"></a><h3> <a name="idp356795728-bb"></a><code class="computeroutput">basic_regex</code> public static functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout">template<typename InputIter> static <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>< BidiIter > <a name="idp356796288-bb"></a>compile(InputIter begin, InputIter end, flag_type flags = regex_constants::ECMAScript);</pre> Factory method for building a regex object from a range of characters. Equivalent to <code class="computeroutput"><a class="link" href="regex_compiler.html" title="Struct template regex_compiler">regex_compiler</a></code>< BidiIter >().compile(begin, end, flags); <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td>Parameters:</td> <td><div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td><code class="computeroutput">begin</code></td> <td>The beginning of a range of characters representing the regular expression to compile. </td> </tr> <tr> <td><code class="computeroutput">end</code></td> <td>The end of a range of characters representing the regular expression to compile. </td> </tr> <tr> <td><code class="computeroutput">flags</code></td> <td>Optional bitmask that determines how the pat string is interpreted. (See syntax_option_type.) </td> </tr> </tbody> </table></div></td> </tr> <tr> <td>Requires:</td> <td> [begin,end) is a valid range. The range of characters specified by [begin,end) contains a valid string-based representation of a regular expression. </td> </tr> <tr> <td>Returns:</td> <td>A <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a> object corresponding to the regular expression represented by the character range. </td> </tr> <tr> <td>Throws:</td> <td> <a class="link" href="regex_error.html" title="Struct regex_error">regex_error</a> when the range of characters has invalid regular expression syntax. </td> </tr> </tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout">template<typename InputRange> static <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>< BidiIter > <a name="idp356806688-bb"></a>compile(InputRange const & pat, flag_type flags = regex_constants::ECMAScript);</pre> This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </li> <li class="listitem"> <pre class="literallayout">static <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>< BidiIter > <a name="idp356811168-bb"></a>compile(char_type const * begin, flag_type flags = regex_constants::ECMAScript);</pre> This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </li> <li class="listitem"> <pre class="literallayout">static <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>< BidiIter > <a name="idp356814800-bb"></a>compile(char_type const * begin, std::size_t len, flag_type flags);</pre> This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </li> </ol></div> </div> </div> </div> <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> <td align="left"></td> <td align="right"><div class="copyright-footer">Copyright © 2007 Eric Niebler Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) </div></td> </tr></table> <hr> <div class="spirit-nav"> <a accesskey="p" href="null_regex_traits.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../xpressive/reference.html#header.boost.xpressive.xpressive_fwd_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="match_results.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html>