summaryrefslogtreecommitdiff
path: root/doc/html/boost/xpressive/sub_match.html
diff options
context:
space:
mode:
authorDongHun Kwak <dh0128.kwak@samsung.com>2017-09-13 11:05:34 +0900
committerDongHun Kwak <dh0128.kwak@samsung.com>2017-09-13 11:06:28 +0900
commit34bd32e225e2a8a94104489b31c42e5801cc1f4a (patch)
treed021b579a0c190354819974e1eaf0baa54b551f3 /doc/html/boost/xpressive/sub_match.html
parentf763a99a501650eff2c60288aa6f10ef916d769e (diff)
downloadboost-34bd32e225e2a8a94104489b31c42e5801cc1f4a.tar.gz
boost-34bd32e225e2a8a94104489b31c42e5801cc1f4a.tar.bz2
boost-34bd32e225e2a8a94104489b31c42e5801cc1f4a.zip
Imported Upstream version 1.63.0upstream/1.63.0
Change-Id: Iac85556a04b7e58d63ba636dedb0986e3555714a Signed-off-by: DongHun Kwak <dh0128.kwak@samsung.com>
Diffstat (limited to 'doc/html/boost/xpressive/sub_match.html')
-rw-r--r--doc/html/boost/xpressive/sub_match.html71
1 files changed, 40 insertions, 31 deletions
diff --git a/doc/html/boost/xpressive/sub_match.html b/doc/html/boost/xpressive/sub_match.html
index 747d005e5b..e5a6b12a3a 100644
--- a/doc/html/boost/xpressive/sub_match.html
+++ b/doc/html/boost/xpressive/sub_match.html
@@ -6,9 +6,9 @@
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.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 &lt;boost/xpressive/xpressive_fwd.hpp&gt;">
-<link rel="prev" href="regex_token_iterator.html" title="Struct template regex_token_iterator">
-<link rel="next" href="compiler_traits.html" title="Struct template compiler_traits">
+<link rel="up" href="../../xpressive/reference.html#header.boost.xpressive.sub_match_hpp" title="Header &lt;boost/xpressive/sub_match.hpp&gt;">
+<link rel="prev" href="regex_traits.html" title="Struct template regex_traits">
+<link rel="next" href="range_begin.html" title="Function range_begin">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -21,7 +21,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="regex_token_iterator.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="compiler_traits.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+<a accesskey="p" href="regex_traits.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../xpressive/reference.html#header.boost.xpressive.sub_match_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="range_begin.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.xpressive.sub_match"></a><div class="titlepage"></div>
@@ -30,49 +30,58 @@
<p>boost::xpressive::sub_match &#8212; Class template <code class="computeroutput"><a class="link" href="sub_match.html" title="Struct template sub_match">sub_match</a></code> denotes the sequence of characters matched by a particular marked sub-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="comment">// In header: &lt;<a class="link" href="../../xpressive/reference.html#header.boost.xpressive.xpressive_fwd_hpp" title="Header &lt;boost/xpressive/xpressive_fwd.hpp&gt;">boost/xpressive/xpressive_fwd.hpp</a>&gt;
+<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../xpressive/reference.html#header.boost.xpressive.sub_match_hpp" title="Header &lt;boost/xpressive/sub_match.hpp&gt;">boost/xpressive/sub_match.hpp</a>&gt;
</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> BidiIter<span class="special">&gt;</span>
<span class="keyword">struct</span> <a class="link" href="sub_match.html" title="Struct template sub_match">sub_match</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span> <span class="identifier">BidiIter</span><span class="special">,</span> <span class="identifier">BidiIter</span> <span class="special">&gt;</span> <span class="special">{</span>
+ <span class="comment">// types</span>
+ <span class="keyword">typedef</span> <span class="identifier">iterator_value</span><span class="special">&lt;</span> <span class="identifier">BidiIter</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <a name="boost.xpressive.sub_match.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>
+ <span class="keyword">typedef</span> <span class="identifier">iterator_difference</span><span class="special">&lt;</span> <span class="identifier">BidiIter</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <a name="boost.xpressive.sub_match.difference_type"></a><span class="identifier">difference_type</span><span class="special">;</span>
+ <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="boost.xpressive.sub_match.string_type"></a><span class="identifier">string_type</span><span class="special">;</span>
+ <span class="keyword">typedef</span> <span class="identifier">BidiIter</span> <a name="boost.xpressive.sub_match.iterator"></a><span class="identifier">iterator</span><span class="special">;</span>
+
<span class="comment">// <a class="link" href="sub_match.html#boost.xpressive.sub_matchconstruct-copy-destruct">construct/copy/destruct</a></span>
- <a class="link" href="sub_match.html#idm46563144703200-bb"><span class="identifier">sub_match</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
- <a class="link" href="sub_match.html#idm46563144702912-bb"><span class="identifier">sub_match</span></a><span class="special">(</span><span class="identifier">BidiIter</span><span class="special">,</span> <span class="identifier">BidiIter</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span><span class="special">;</span>
+ <a class="link" href="sub_match.html#idp1010748944-bb"><span class="identifier">sub_match</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+ <a class="link" href="sub_match.html#idp1010749232-bb"><span class="identifier">sub_match</span></a><span class="special">(</span><span class="identifier">BidiIter</span><span class="special">,</span> <span class="identifier">BidiIter</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span><span class="special">;</span>
+
+ <span class="comment">// <a class="link" href="sub_match.html#idp1010733776-bb">public member functions</a></span>
+ <span class="identifier">string_type</span> <a class="link" href="sub_match.html#idp1010734336-bb"><span class="identifier">str</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+ <a class="link" href="sub_match.html#idp1010735456-bb"><span class="keyword">operator</span> <span class="identifier">string_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+ <span class="identifier">difference_type</span> <a class="link" href="sub_match.html#idp1010736576-bb"><span class="identifier">length</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+ <a class="link" href="sub_match.html#idp1010737696-bb"><span class="keyword">operator</span> <span class="identifier">bool_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+ <span class="keyword">bool</span> <a class="link" href="sub_match.html#idp1010738816-bb"><span class="keyword">operator</span><span class="special">!</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+ <span class="keyword">int</span> <a class="link" href="sub_match.html#idp1010739936-bb"><span class="identifier">compare</span></a><span class="special">(</span><span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+ <span class="keyword">int</span> <a class="link" href="sub_match.html#idp1010743792-bb"><span class="identifier">compare</span></a><span class="special">(</span><a class="link" href="sub_match.html" title="Struct template sub_match">sub_match</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+ <span class="keyword">int</span> <a class="link" href="sub_match.html#idp1010746432-bb"><span class="identifier">compare</span></a><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">*</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
- <span class="comment">// <a class="link" href="sub_match.html#idm46563144718368-bb">public member functions</a></span>
- <span class="identifier">string_type</span> <a class="link" href="sub_match.html#idm46563144717808-bb"><span class="identifier">str</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
- <a class="link" href="sub_match.html#idm46563144716688-bb"><span class="keyword">operator</span> <span class="identifier">string_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
- <span class="identifier">difference_type</span> <a class="link" href="sub_match.html#idm46563144715568-bb"><span class="identifier">length</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
- <a class="link" href="sub_match.html#idm46563144714448-bb"><span class="keyword">operator</span> <span class="identifier">bool_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
- <span class="keyword">bool</span> <a class="link" href="sub_match.html#idm46563144713328-bb"><span class="keyword">operator</span><span class="special">!</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
- <span class="keyword">int</span> <a class="link" href="sub_match.html#idm46563144712208-bb"><span class="identifier">compare</span></a><span class="special">(</span><span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
- <span class="keyword">int</span> <a class="link" href="sub_match.html#idm46563144708352-bb"><span class="identifier">compare</span></a><span class="special">(</span><a class="link" href="sub_match.html" title="Struct template sub_match">sub_match</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
- <span class="keyword">int</span> <a class="link" href="sub_match.html#idm46563144705712-bb"><span class="identifier">compare</span></a><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">*</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+ <span class="comment">// public data members</span>
+ <span class="keyword">bool</span> <span class="identifier">matched</span><span class="special">;</span> <span class="comment">// true if this sub-match participated in the full match. </span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
-<a name="idm45927676577248"></a><h2>Description</h2>
+<a name="idp718277344"></a><h2>Description</h2>
<p>When the marked sub-expression denoted by an object of type <code class="computeroutput"><a class="link" href="sub_match.html" title="Struct template sub_match">sub_match</a>&lt;&gt;</code> participated in a regular expression match then member <code class="computeroutput">matched</code> evaluates to <code class="computeroutput">true</code>, and members <code class="computeroutput">first</code> and <code class="computeroutput">second</code> denote the range of characters <code class="computeroutput">[first,second)</code> which formed that match. Otherwise <code class="computeroutput">matched</code> is <code class="computeroutput">false</code>, and members <code class="computeroutput">first</code> and <code class="computeroutput">second</code> contained undefined values.</p>
<p>If an object of type <code class="computeroutput"><a class="link" href="sub_match.html" title="Struct template sub_match">sub_match</a>&lt;&gt;</code> represents sub-expression 0 - that is to say the whole match - then member <code class="computeroutput">matched</code> is always <code class="computeroutput">true</code>, unless a partial match was obtained as a result of the flag <code class="computeroutput">match_partial</code> being passed to a regular expression algorithm, in which case member <code class="computeroutput">matched</code> is <code class="computeroutput">false</code>, and members <code class="computeroutput">first</code> and <code class="computeroutput">second</code> represent the character range that formed the partial match. </p>
<div class="refsect2">
-<a name="idm45927676561488"></a><h3>
+<a name="idp718293104"></a><h3>
<a name="boost.xpressive.sub_matchconstruct-copy-destruct"></a><code class="computeroutput">sub_match</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
-<li class="listitem"><pre class="literallayout"><a name="idm46563144703200-bb"></a><span class="identifier">sub_match</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
-<li class="listitem"><pre class="literallayout"><a name="idm46563144702912-bb"></a><span class="identifier">sub_match</span><span class="special">(</span><span class="identifier">BidiIter</span> first<span class="special">,</span> <span class="identifier">BidiIter</span> second<span class="special">,</span> <span class="keyword">bool</span> matched_ <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><a name="idp1010748944-bb"></a><span class="identifier">sub_match</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><a name="idp1010749232-bb"></a><span class="identifier">sub_match</span><span class="special">(</span><span class="identifier">BidiIter</span> first<span class="special">,</span> <span class="identifier">BidiIter</span> second<span class="special">,</span> <span class="keyword">bool</span> matched_ <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span><span class="special">;</span></pre></li>
</ol></div>
</div>
<div class="refsect2">
-<a name="idm45927676547360"></a><h3>
-<a name="idm46563144718368-bb"></a><code class="computeroutput">sub_match</code> public member functions</h3>
+<a name="idp718307296"></a><h3>
+<a name="idp1010733776-bb"></a><code class="computeroutput">sub_match</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
-<li class="listitem"><pre class="literallayout"><span class="identifier">string_type</span> <a name="idm46563144717808-bb"></a><span class="identifier">str</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
-<li class="listitem"><pre class="literallayout"><a name="idm46563144716688-bb"></a><span class="keyword">operator</span> <span class="identifier">string_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
-<li class="listitem"><pre class="literallayout"><span class="identifier">difference_type</span> <a name="idm46563144715568-bb"></a><span class="identifier">length</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
-<li class="listitem"><pre class="literallayout"><a name="idm46563144714448-bb"></a><span class="keyword">operator</span> <span class="identifier">bool_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
-<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idm46563144713328-bb"></a><span class="keyword">operator</span><span class="special">!</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><span class="identifier">string_type</span> <a name="idp1010734336-bb"></a><span class="identifier">str</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><a name="idp1010735456-bb"></a><span class="keyword">operator</span> <span class="identifier">string_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><span class="identifier">difference_type</span> <a name="idp1010736576-bb"></a><span class="identifier">length</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><a name="idp1010737696-bb"></a><span class="keyword">operator</span> <span class="identifier">bool_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idp1010738816-bb"></a><span class="keyword">operator</span><span class="special">!</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem">
-<pre class="literallayout"><span class="keyword">int</span> <a name="idm46563144712208-bb"></a><span class="identifier">compare</span><span class="special">(</span><span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> str<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Performs a lexicographic string comparison. <p>
+<pre class="literallayout"><span class="keyword">int</span> <a name="idp1010739936-bb"></a><span class="identifier">compare</span><span class="special">(</span><span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> str<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Performs a lexicographic string comparison. <p>
</p>
<div class="variablelist"><table border="0" class="variablelist compact">
@@ -102,11 +111,11 @@
</table></div>
</li>
<li class="listitem">
-<pre class="literallayout"><span class="keyword">int</span> <a name="idm46563144708352-bb"></a><span class="identifier">compare</span><span class="special">(</span><a class="link" href="sub_match.html" title="Struct template sub_match">sub_match</a> <span class="keyword">const</span> <span class="special">&amp;</span> sub<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">int</span> <a name="idp1010743792-bb"></a><span class="identifier">compare</span><span class="special">(</span><a class="link" href="sub_match.html" title="Struct template sub_match">sub_match</a> <span class="keyword">const</span> <span class="special">&amp;</span> sub<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></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="keyword">int</span> <a name="idm46563144705712-bb"></a><span class="identifier">compare</span><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">*</span> ptr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">int</span> <a name="idp1010746432-bb"></a><span class="identifier">compare</span><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">*</span> ptr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></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>
@@ -123,7 +132,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="regex_token_iterator.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="compiler_traits.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+<a accesskey="p" href="regex_traits.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../xpressive/reference.html#header.boost.xpressive.sub_match_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="range_begin.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>