Sophie

Sophie

distrib > Mandriva > 2010.1 > x86_64 > by-pkgid > fa7fad8f194f80107561a85291acd153 > files > 2419

lib64boost-devel-doc-1.42.0-3mdv2010.1.x86_64.rpm

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Struct template basic_regex</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../../xpressive/reference.html#header.boost.xpressive.basic_regex_hpp" title="Header &lt;boost/xpressive/basic_regex.hpp&gt;">
<link rel="prev" href="../../xpressive/reference.html" title="Reference">
<link rel="next" href="swap_id1483981.html" title="Function template swap">
</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="../../xpressive/reference.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../xpressive/reference.html#header.boost.xpressive.basic_regex_hpp"><img src="../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="swap_id1483981.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="refentry" title="Struct template basic_regex">
<a name="boost.xpressive.basic_regex"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Struct template basic_regex</span></h2>
<p>boost::xpressive::basic_regex &#8212; Class template basic_regex&lt;&gt; is a class for holding a compiled regular expression. </p>
</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"><span class="emphasis"><em>// In header: &lt;<a class="link" href="../../xpressive/reference.html#header.boost.xpressive.basic_regex_hpp" title="Header &lt;boost/xpressive/basic_regex.hpp&gt;">boost/xpressive/basic_regex.hpp</a>&gt;

</em></span><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> BidiIter&gt; 
<span class="bold"><strong>struct</strong></span> <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a> {
  <span class="emphasis"><em>// types</em></span>
  <span class="bold"><strong>typedef</strong></span> BidiIter                            <a name="boost.xpressive.basic_regex.iterator_type"></a>iterator_type;
  <span class="bold"><strong>typedef</strong></span> iterator_value&lt; BidiIter &gt;::type    <a name="boost.xpressive.basic_regex.char_type"></a>char_type;    
  <span class="bold"><strong>typedef</strong></span> iterator_value&lt; BidiIter &gt;::type    <a name="boost.xpressive.basic_regex.value_type"></a>value_type;   
  <span class="bold"><strong>typedef</strong></span> <span class="emphasis"><em>unspecified</em></span>                         <a name="boost.xpressive.basic_regex.string_type"></a>string_type;  
  <span class="bold"><strong>typedef</strong></span> regex_constants::syntax_option_type <a name="boost.xpressive.basic_regex.flag_type"></a>flag_type;    

  <span class="emphasis"><em>// <a class="link" href="basic_regex.html#boost.xpressive.basic_regexconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <a class="link" href="basic_regex.html#id1483652-bb">basic_regex</a>();
  <a class="link" href="basic_regex.html#id1483663-bb">basic_regex</a>(<a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>&lt; BidiIter &gt; <span class="bold"><strong>const</strong></span> &amp;);
  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Expr&gt; <a class="link" href="basic_regex.html#id1483713-bb">basic_regex</a>(Expr <span class="bold"><strong>const</strong></span> &amp;);
  basic_regex&amp; <a class="link" href="basic_regex.html#id1483686-bb"><span class="bold"><strong>operator</strong></span>=</a>(<a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>&lt; BidiIter &gt; <span class="bold"><strong>const</strong></span> &amp;);
  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Expr&gt; basic_regex&amp; <a class="link" href="basic_regex.html#id1483748-bb"><span class="bold"><strong>operator</strong></span>=</a>(Expr <span class="bold"><strong>const</strong></span> &amp;);

  <span class="emphasis"><em>// <a class="link" href="basic_regex.html#id1483586-bb">public member functions</a></em></span>
  <span class="type">std::size_t</span> <a class="link" href="basic_regex.html#id1483589-bb">mark_count</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type">regex_id_type</span> <a class="link" href="basic_regex.html#id1483601-bb">regex_id</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="basic_regex.html#id1483614-bb">swap</a>(<a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>&lt; BidiIter &gt; &amp;) ;

  <span class="emphasis"><em>// <a class="link" href="basic_regex.html#id1483792-bb">public static functions</a></em></span>
  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> InputIter&gt; 
    <span class="type"><span class="bold"><strong>static</strong></span> <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>&lt; BidiIter &gt;</span> 
    <a class="link" href="basic_regex.html#id1483795-bb">compile</a>(InputIter, InputIter, flag_type = regex_constants::ECMAScript) ;
  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> InputRange&gt; 
    <span class="type"><span class="bold"><strong>static</strong></span> <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>&lt; BidiIter &gt;</span> 
    <a class="link" href="basic_regex.html#id1483874-bb">compile</a>(InputRange <span class="bold"><strong>const</strong></span> &amp;, flag_type = regex_constants::ECMAScript) ;
  <span class="type"><span class="bold"><strong>static</strong></span> <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>&lt; BidiIter &gt;</span> 
  <a class="link" href="basic_regex.html#id1483912-bb">compile</a>(char_type <span class="bold"><strong>const</strong></span> *, flag_type = regex_constants::ECMAScript) ;
  <span class="type"><span class="bold"><strong>static</strong></span> <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>&lt; BidiIter &gt;</span> 
  <a class="link" href="basic_regex.html#id1483944-bb">compile</a>(char_type <span class="bold"><strong>const</strong></span> *, std::size_t, flag_type) ;
  <span class="bold"><strong>static</strong></span> <span class="type">regex_constants::syntax_option_type <span class="bold"><strong>const</strong></span></span> ECMAScript;
  <span class="bold"><strong>static</strong></span> <span class="type">regex_constants::syntax_option_type <span class="bold"><strong>const</strong></span></span> icase;
  <span class="bold"><strong>static</strong></span> <span class="type">regex_constants::syntax_option_type <span class="bold"><strong>const</strong></span></span> nosubs;
  <span class="bold"><strong>static</strong></span> <span class="type">regex_constants::syntax_option_type <span class="bold"><strong>const</strong></span></span> optimize;
  <span class="bold"><strong>static</strong></span> <span class="type">regex_constants::syntax_option_type <span class="bold"><strong>const</strong></span></span> collate;
  <span class="bold"><strong>static</strong></span> <span class="type">regex_constants::syntax_option_type <span class="bold"><strong>const</strong></span></span> single_line;
  <span class="bold"><strong>static</strong></span> <span class="type">regex_constants::syntax_option_type <span class="bold"><strong>const</strong></span></span> not_dot_null;
  <span class="bold"><strong>static</strong></span> <span class="type">regex_constants::syntax_option_type <span class="bold"><strong>const</strong></span></span> not_dot_newline;
  <span class="bold"><strong>static</strong></span> <span class="type">regex_constants::syntax_option_type <span class="bold"><strong>const</strong></span></span> ignore_white_space;
};</pre></div>
<div class="refsect1" title="Description">
<a name="id2098564"></a><h2>Description</h2>
<div class="refsect2" title="basic_regex public construct/copy/destruct">
<a name="id2098567"></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="id1483652-bb"></a>basic_regex();</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Postconditions:</span></p></td>
<td>
<p>regex_id() == 0 </p>
<p>mark_count() == 0 </p>
</td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><a name="id1483663-bb"></a>basic_regex(<a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>&lt; BidiIter &gt; <span class="bold"><strong>const</strong></span> &amp; that);</pre>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">that</code></span></p></td>
<td><p>The basic_regex object to copy. </p></td>
</tr></tbody>
</table></div></td>
</tr>
<tr>
<td><p><span class="term">Postconditions:</span></p></td>
<td>
<p>regex_id() == that.regex_id() </p>
<p>mark_count() == that.mark_count() </p>
</td>
</tr>
</tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Expr&gt; <a name="id1483713-bb"></a>basic_regex(Expr <span class="bold"><strong>const</strong></span> &amp; expr);</pre>
<p>Construct from a static regular expression.</p>
<p>


</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">expr</code></span></p></td>
<td><p>The static regular expression </p></td>
</tr></tbody>
</table></div></td>
</tr>
<tr>
<td><p><span class="term">Requires:</span></p></td>
<td><p>Expr is the type of a static regular expression. </p></td>
</tr>
<tr>
<td><p><span class="term">Postconditions:</span></p></td>
<td>
<p>regex_id() != 0 </p>
<p>mark_count() &gt;= 0 </p>
</td>
</tr>
</tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout">basic_regex&amp; <a name="id1483686-bb"></a><span class="bold"><strong>operator</strong></span>=(<a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>&lt; BidiIter &gt; <span class="bold"><strong>const</strong></span> &amp; that);</pre>
<p>


</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">that</code></span></p></td>
<td><p>The basic_regex object to copy. </p></td>
</tr></tbody>
</table></div></td>
</tr>
<tr>
<td><p><span class="term">Postconditions:</span></p></td>
<td>
<p>regex_id() == that.regex_id() </p>
<p>mark_count() == that.mark_count() </p>
</td>
</tr>
<tr>
<td><p><span class="term">Returns:</span></p></td>
<td><p>*this </p></td>
</tr>
</tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Expr&gt; basic_regex&amp; <a name="id1483748-bb"></a><span class="bold"><strong>operator</strong></span>=(Expr <span class="bold"><strong>const</strong></span> &amp; expr);</pre>
<p>Construct from a static regular expression.</p>
<p>




</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">expr</code></span></p></td>
<td><p>The static regular expression. </p></td>
</tr></tbody>
</table></div></td>
</tr>
<tr>
<td><p><span class="term">Requires:</span></p></td>
<td><p>Expr is the type of a static regular expression. </p></td>
</tr>
<tr>
<td><p><span class="term">Postconditions:</span></p></td>
<td>
<p>regex_id() != 0 </p>
<p>mark_count() &gt;= 0 </p>
</td>
</tr>
<tr>
<td><p><span class="term">Returns:</span></p></td>
<td><p>*this </p></td>
</tr>
<tr>
<td><p><span class="term">Throws:</span></p></td>
<td>std::bad_alloc </td>
</tr>
</tbody>
</table></div>
</li>
</ol></div>
</div>
<div class="refsect2" title="basic_regex public member functions">
<a name="id2098936"></a><h3>
<a name="id1483586-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"><span class="type">std::size_t</span> <a name="id1483589-bb"></a>mark_count() <span class="bold"><strong>const</strong></span>;</pre>
<p>Returns the count of capturing sub-expressions in this regular expression </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="type">regex_id_type</span> <a name="id1483601-bb"></a>regex_id() <span class="bold"><strong>const</strong></span>;</pre>
<p>Returns a token which uniquely identifies this regular expression. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id1483614-bb"></a>swap(<a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>&lt; BidiIter &gt; &amp; that) ;</pre>
<p>Swaps the contents of this basic_regex object with another.</p>
<p>


</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">that</code></span></p></td>
<td><p>The other basic_regex object. </p></td>
</tr></tbody>
</table></div></td>
</tr>
<tr>
<td><p><span class="term">Throws:</span></p></td>
<td>Will not throw.</td>
</tr>
<tr>
<td><p><span class="term">Notes:</span></p></td>
<td><p>This is a shallow swap that does not do reference tracking. If you embed a basic_regex object by reference in another regular expression and then swap its contents with another basic_regex object, the change will not be visible to the enclosing regular expression. It is done this way to ensure that swap() cannot throw. </p></td>
</tr>
</tbody>
</table></div>
</li>
</ol></div>
</div>
<div class="refsect2" title="basic_regex public static functions">
<a name="id2099084"></a><h3>
<a name="id1483792-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"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> InputIter&gt; 
  <span class="type"><span class="bold"><strong>static</strong></span> <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>&lt; BidiIter &gt;</span> 
  <a name="id1483795-bb"></a>compile(InputIter begin, InputIter end, 
          flag_type flags = regex_constants::ECMAScript) ;</pre>
<p>Factory method for building a regex object from a range of characters. Equivalent to regex_compiler&lt; BidiIter &gt;().compile(begin, end, flags);</p>
<p>



</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><code class="computeroutput">begin</code></span></p></td>
<td><p>The beginning of a range of characters representing the regular expression to compile. </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">end</code></span></p></td>
<td><p>The end of a range of characters representing the regular expression to compile. </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">flags</code></span></p></td>
<td><p>Optional bitmask that determines how the pat string is interpreted. (See syntax_option_type.) </p></td>
</tr>
</tbody>
</table></div></td>
</tr>
<tr>
<td><p><span class="term">Requires:</span></p></td>
<td>
<p>[begin,end) is a valid range. </p>
<p>The range of characters specified by [begin,end) contains a valid string-based representation of a regular expression. </p>
</td>
</tr>
<tr>
<td><p><span class="term">Returns:</span></p></td>
<td><p>A basic_regex object corresponding to the regular expression represented by the character range. </p></td>
</tr>
<tr>
<td><p><span class="term">Throws:</span></p></td>
<td>
<a class="link" href="regex_error.html" title="Struct regex_error">regex_error</a> </td>
</tr>
</tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> InputRange&gt; 
  <span class="type"><span class="bold"><strong>static</strong></span> <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>&lt; BidiIter &gt;</span> 
  <a name="id1483874-bb"></a>compile(InputRange <span class="bold"><strong>const</strong></span> &amp; pat, 
          flag_type flags = regex_constants::ECMAScript) ;</pre>
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="type"><span class="bold"><strong>static</strong></span> <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>&lt; BidiIter &gt;</span> 
<a name="id1483912-bb"></a>compile(char_type <span class="bold"><strong>const</strong></span> * begin, 
        flag_type flags = regex_constants::ECMAScript) ;</pre>
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="type"><span class="bold"><strong>static</strong></span> <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>&lt; BidiIter &gt;</span> 
<a name="id1483944-bb"></a>compile(char_type <span class="bold"><strong>const</strong></span> * begin, std::size_t len, flag_type flags) ;</pre>
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
</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 &#169; 2007 Eric Niebler<p>
        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>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../xpressive/reference.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../xpressive/reference.html#header.boost.xpressive.basic_regex_hpp"><img src="../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="swap_id1483981.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional