3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>Get the Iterator pointing to the End of a Container Attribute</title>
5 <link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7 <link rel="home" href="../../../../index.html" title="Spirit 2.5.2">
8 <link rel="up" href="../iterate.html" title="Extract Attribute Values to Generate Output from a Container (Karma)">
9 <link rel="prev" href="begin_container.html" title="Get the Iterator pointing to the Begin of a Container Attribute">
10 <link rel="next" href="next_iterator.html" title="Increment the Iterator pointing into a Container Attribute">
12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13 <table cellpadding="2" width="100%"><tr>
14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
15 <td align="center"><a href="../../../../../../../../index.html">Home</a></td>
16 <td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19 <td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
22 <div class="spirit-nav">
23 <a accesskey="p" href="begin_container.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../iterate.html"><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="next_iterator.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
26 <div class="titlepage"><div><div><h5 class="title">
27 <a name="spirit.advanced.customize.iterate.end_container"></a><a class="link" href="end_container.html" title="Get the Iterator pointing to the End of a Container Attribute">Get
28 the Iterator pointing to the End of a Container Attribute</a>
29 </h5></div></div></div>
31 <a name="spirit.advanced.customize.iterate.end_container.h0"></a>
32 <span class="phrase"><a name="spirit.advanced.customize.iterate.end_container.end_container"></a></span><a class="link" href="end_container.html#spirit.advanced.customize.iterate.end_container.end_container">end_container</a>
35 The template <code class="computeroutput"><span class="identifier">end_container</span></code>
36 is a type used as an attribute customization point. It is invoked by
37 the <span class="emphasis"><em>Karma</em></span> repetitive generators (such as <a class="link" href="../../../karma/reference/operator/list.html" title="List Generator (a % b)">List
38 (<code class="computeroutput"><span class="special">%</span></code>)</a>, <a class="link" href="../../../karma/reference/operator/kleene.html" title="Kleene Star Generator (*a)">Kleene
39 (unary <code class="computeroutput"><span class="special">*</span></code>)</a>, <a class="link" href="../../../karma/reference/operator/plus.html" title="Plus Generator (+a)">Plus (unary <code class="computeroutput"><span class="special">+</span></code>)</a>, and <a class="link" href="../../../karma/reference/directive/repeat.html" title="Repetition Generator Directive (repeat[])">Repeat</a>)
40 in order to get an iterator pointing to the end of the container holding
41 the attributes to generate output from.
44 <a name="spirit.advanced.customize.iterate.end_container.h1"></a>
45 <span class="phrase"><a name="spirit.advanced.customize.iterate.end_container.module_headers"></a></span><a class="link" href="end_container.html#spirit.advanced.customize.iterate.end_container.module_headers">Module
48 <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">spirit</span><span class="special">/</span><span class="identifier">home</span><span class="special">/</span><span class="identifier">support</span><span class="special">/</span><span class="identifier">container</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
51 Also, see <a class="link" href="../../../structure/include.html" title="Include">Include Structure</a>.
53 <div class="note"><table border="0" summary="Note">
55 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../images/note.png"></td>
56 <th align="left">Note</th>
58 <tr><td align="left" valign="top"><p>
59 This header file does not need to be included directly by any user
60 program as it is normally included by other Spirit header files relying
65 <a name="spirit.advanced.customize.iterate.end_container.h2"></a>
66 <span class="phrase"><a name="spirit.advanced.customize.iterate.end_container.namespace"></a></span><a class="link" href="end_container.html#spirit.advanced.customize.iterate.end_container.namespace">Namespace</a>
68 <div class="informaltable"><table class="table">
69 <colgroup><col></colgroup>
77 <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">traits</span></code>
82 <a name="spirit.advanced.customize.iterate.end_container.h3"></a>
83 <span class="phrase"><a name="spirit.advanced.customize.iterate.end_container.synopsis"></a></span><a class="link" href="end_container.html#spirit.advanced.customize.iterate.end_container.synopsis">Synopsis</a>
85 <pre class="programlisting"><span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Container</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Enable</span><span class="special">></span>
86 <span class="keyword">struct</span> <span class="identifier">end_container</span>
87 <span class="special">{</span>
88 <span class="keyword">static</span> <span class="keyword">typename</span> <span class="identifier">container_iterator</span><span class="special"><</span><span class="identifier">Container</span><span class="special">>::</span><span class="identifier">type</span>
89 <span class="identifier">call</span><span class="special">(</span><span class="identifier">Container</span><span class="special">&</span> <span class="identifier">c</span><span class="special">);</span>
90 <span class="special">};</span>
93 <a name="spirit.advanced.customize.iterate.end_container.h4"></a>
94 <span class="phrase"><a name="spirit.advanced.customize.iterate.end_container.template_parameters"></a></span><a class="link" href="end_container.html#spirit.advanced.customize.iterate.end_container.template_parameters">Template
97 <div class="informaltable"><table class="table">
124 <code class="computeroutput"><span class="identifier">Container</span></code>
129 The type, <code class="computeroutput"><span class="identifier">Container</span></code>
130 for which the iterator pointing to the first element has to
143 <code class="computeroutput"><span class="identifier">Enable</span></code>
148 Helper template parameter usable to selectively enable or disable
149 certain specializations of <code class="computeroutput"><span class="identifier">end_container</span></code>
150 utilizing SFINAE (i.e. <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">enable_if</span></code>
151 or <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">disable_if</span></code>).
156 <code class="computeroutput"><span class="keyword">void</span></code>
162 <div class="variablelist">
163 <p class="title"><b>Notation</b></p>
164 <dl class="variablelist">
165 <dt><span class="term"><code class="computeroutput"><span class="identifier">C</span></code></span></dt>
167 A container type the end iterator needs to be returned for.
169 <dt><span class="term"><code class="computeroutput"><span class="identifier">c</span></code></span></dt>
171 An instance of a container, <code class="computeroutput"><span class="identifier">C</span></code>.
176 <a name="spirit.advanced.customize.iterate.end_container.h5"></a>
177 <span class="phrase"><a name="spirit.advanced.customize.iterate.end_container.expression_semantics"></a></span><a class="link" href="end_container.html#spirit.advanced.customize.iterate.end_container.expression_semantics">Expression
180 <div class="informaltable"><table class="table">
200 <code class="computeroutput"><span class="identifier">end_container</span><span class="special"><</span><span class="identifier">C</span><span class="special">>::</span><span class="identifier">call</span><span class="special">(</span><span class="identifier">c</span><span class="special">)</span></code>
205 Return the iterator usable to compare a different iterator
206 with in order to detect whether the other iterator reached
207 the end of the given container, <code class="computeroutput"><span class="identifier">c</span></code>.
208 The type of the returned iterator is expected to be the same
209 as the type returned by the customization point <a class="link" href="container_iterator.html" title="Determine the Type of the Iterator of a Container"><code class="computeroutput"><span class="identifier">traits</span><span class="special">::</span><span class="identifier">container_iterator</span></code></a>.
215 <a name="spirit.advanced.customize.iterate.end_container.h6"></a>
216 <span class="phrase"><a name="spirit.advanced.customize.iterate.end_container.predefined_specializations"></a></span><a class="link" href="end_container.html#spirit.advanced.customize.iterate.end_container.predefined_specializations">Predefined
220 <a href="http://boost-spirit.com" target="_top">Spirit</a> predefines specializations
221 of this customization point for several types. The following table lists
222 those types together with the types returned by the embedded typedef
223 <code class="computeroutput"><span class="identifier">type</span></code>:
225 <div class="informaltable"><table class="table">
246 <code class="computeroutput"><span class="identifier">C</span></code>
251 Returns <code class="computeroutput"><span class="identifier">c</span><span class="special">.</span><span class="identifier">end</span><span class="special">()</span></code>.
258 <code class="computeroutput"><span class="identifier">C</span> <span class="keyword">const</span></code>
263 Returns <code class="computeroutput"><span class="identifier">c</span><span class="special">.</span><span class="identifier">end</span><span class="special">()</span></code>.
270 <code class="computeroutput"><span class="identifier">unused_type</span></code>
275 Returns <code class="computeroutput"><span class="special">&</span><span class="identifier">unused</span></code>.
282 <a name="spirit.advanced.customize.iterate.end_container.h7"></a>
283 <span class="phrase"><a name="spirit.advanced.customize.iterate.end_container.when_to_implement"></a></span><a class="link" href="end_container.html#spirit.advanced.customize.iterate.end_container.when_to_implement">When
287 The customization point <code class="computeroutput"><span class="identifier">end_container</span></code>
288 needs to be implemented for a specific type whenever this type is to
289 be used as an attribute in place of a STL container. It is applicable
290 for generators (<span class="emphasis"><em>Spirit.Karma</em></span>) only. As a rule of
291 thumb: it has to be implemented whenever a certain type is to be passed
292 as an attribute to a generator normally exposing a STL container, <code class="computeroutput"><span class="identifier">C</span></code> and if the type does not expose the
293 interface of a STL container (i.e. <code class="computeroutput"><span class="identifier">is_container</span><span class="special"><</span><span class="identifier">C</span><span class="special">>::</span><span class="identifier">type</span></code>
294 would normally return <code class="computeroutput"><span class="identifier">mpl</span><span class="special">::</span><span class="identifier">false_</span></code>).
297 <a name="spirit.advanced.customize.iterate.end_container.h8"></a>
298 <span class="phrase"><a name="spirit.advanced.customize.iterate.end_container.related_attribute_customization_points"></a></span><a class="link" href="end_container.html#spirit.advanced.customize.iterate.end_container.related_attribute_customization_points">Related
299 Attribute Customization Points</a>
302 If this customization point is implemented, the following other customization
303 points might need to be implemented as well.
305 <div class="informaltable"><table class="table">
326 <a class="link" href="../is_container.html" title="Determine if a Type Should be Treated as a Container (Qi and Karma)"><code class="computeroutput"><span class="identifier">traits</span><span class="special">::</span><span class="identifier">is_container</span></code></a>
331 Needs to be implemented whenever a type is to be used as a
332 container attribute in <span class="emphasis"><em>Karma</em></span>.
339 <a class="link" href="container_iterator.html" title="Determine the Type of the Iterator of a Container"><code class="computeroutput"><span class="identifier">traits</span><span class="special">::</span><span class="identifier">container_iterator</span></code></a>
344 Karma: <a class="link" href="../../../karma/reference/operator/list.html" title="List Generator (a % b)">List
345 (<code class="computeroutput"><span class="special">%</span></code>)</a>, <a class="link" href="../../../karma/reference/operator/kleene.html" title="Kleene Star Generator (*a)">Kleene (unary
346 <code class="computeroutput"><span class="special">*</span></code>)</a>, <a class="link" href="../../../karma/reference/operator/plus.html" title="Plus Generator (+a)">Plus (unary
347 <code class="computeroutput"><span class="special">+</span></code>)</a>, <a class="link" href="../../../karma/reference/directive/repeat.html" title="Repetition Generator Directive (repeat[])">Repeat</a>.
354 <a class="link" href="begin_container.html" title="Get the Iterator pointing to the Begin of a Container Attribute"><code class="computeroutput"><span class="identifier">traits</span><span class="special">::</span><span class="identifier">begin_container</span></code></a>
359 Karma: <a class="link" href="../../../karma/reference/operator/list.html" title="List Generator (a % b)">List
360 (<code class="computeroutput"><span class="special">%</span></code>)</a>, <a class="link" href="../../../karma/reference/operator/kleene.html" title="Kleene Star Generator (*a)">Kleene (unary
361 <code class="computeroutput"><span class="special">*</span></code>)</a>, <a class="link" href="../../../karma/reference/operator/plus.html" title="Plus Generator (+a)">Plus (unary
362 <code class="computeroutput"><span class="special">+</span></code>)</a>, <a class="link" href="../../../karma/reference/directive/repeat.html" title="Repetition Generator Directive (repeat[])">Repeat</a>.
369 <a class="link" href="end_container.html" title="Get the Iterator pointing to the End of a Container Attribute"><code class="computeroutput"><span class="identifier">traits</span><span class="special">::</span><span class="identifier">end_container</span></code></a>
374 Karma: <a class="link" href="../../../karma/reference/operator/list.html" title="List Generator (a % b)">List
375 (<code class="computeroutput"><span class="special">%</span></code>)</a>, <a class="link" href="../../../karma/reference/operator/kleene.html" title="Kleene Star Generator (*a)">Kleene (unary
376 <code class="computeroutput"><span class="special">*</span></code>)</a>, <a class="link" href="../../../karma/reference/operator/plus.html" title="Plus Generator (+a)">Plus (unary
377 <code class="computeroutput"><span class="special">+</span></code>)</a>, <a class="link" href="../../../karma/reference/directive/repeat.html" title="Repetition Generator Directive (repeat[])">Repeat</a>.
384 <a class="link" href="deref_iterator.html" title="Dereference the Iterator pointing into a Container Attribute"><code class="computeroutput"><span class="identifier">traits</span><span class="special">::</span><span class="identifier">deref_iterator</span></code></a>
389 Karma: <a class="link" href="../../../karma/reference/operator/list.html" title="List Generator (a % b)">List
390 (<code class="computeroutput"><span class="special">%</span></code>)</a>, <a class="link" href="../../../karma/reference/operator/kleene.html" title="Kleene Star Generator (*a)">Kleene (unary
391 <code class="computeroutput"><span class="special">*</span></code>)</a>, <a class="link" href="../../../karma/reference/operator/plus.html" title="Plus Generator (+a)">Plus (unary
392 <code class="computeroutput"><span class="special">+</span></code>)</a>, <a class="link" href="../../../karma/reference/directive/repeat.html" title="Repetition Generator Directive (repeat[])">Repeat</a>.
399 <a class="link" href="next_iterator.html" title="Increment the Iterator pointing into a Container Attribute"><code class="computeroutput"><span class="identifier">traits</span><span class="special">::</span><span class="identifier">next_iterator</span></code></a>
404 Karma: <a class="link" href="../../../karma/reference/operator/list.html" title="List Generator (a % b)">List
405 (<code class="computeroutput"><span class="special">%</span></code>)</a>, <a class="link" href="../../../karma/reference/operator/kleene.html" title="Kleene Star Generator (*a)">Kleene (unary
406 <code class="computeroutput"><span class="special">*</span></code>)</a>, <a class="link" href="../../../karma/reference/operator/plus.html" title="Plus Generator (+a)">Plus (unary
407 <code class="computeroutput"><span class="special">+</span></code>)</a>, <a class="link" href="../../../karma/reference/directive/repeat.html" title="Repetition Generator Directive (repeat[])">Repeat</a>.
414 <a class="link" href="compare_iterators.html" title="Compare two Iterator pointing into a Container Attribute for Equality"><code class="computeroutput"><span class="identifier">traits</span><span class="special">::</span><span class="identifier">compare_iterators</span></code></a>
419 Karma: <a class="link" href="../../../karma/reference/operator/list.html" title="List Generator (a % b)">List
420 (<code class="computeroutput"><span class="special">%</span></code>)</a>, <a class="link" href="../../../karma/reference/operator/kleene.html" title="Kleene Star Generator (*a)">Kleene (unary
421 <code class="computeroutput"><span class="special">*</span></code>)</a>, <a class="link" href="../../../karma/reference/operator/plus.html" title="Plus Generator (+a)">Plus (unary
422 <code class="computeroutput"><span class="special">+</span></code>)</a>, <a class="link" href="../../../karma/reference/directive/repeat.html" title="Repetition Generator Directive (repeat[])">Repeat</a>.
429 <a name="spirit.advanced.customize.iterate.end_container.h9"></a>
430 <span class="phrase"><a name="spirit.advanced.customize.iterate.end_container.example"></a></span><a class="link" href="end_container.html#spirit.advanced.customize.iterate.end_container.example">Example</a>
433 For examples of how to use the customization point <code class="computeroutput"><span class="identifier">end_container</span></code>
434 please see here: <a class="link" href="container_iterator.html#spirit.advanced.customize.iterate.container_iterator.example">embedded_container_example</a>,
435 <a class="link" href="next_iterator.html#spirit.advanced.customize.iterate.next_iterator.example">use_as_container</a>,
436 and <a class="link" href="deref_iterator.html#spirit.advanced.customize.iterate.deref_iterator.example">counter_example</a>.
439 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
440 <td align="left"></td>
441 <td align="right"><div class="copyright-footer">Copyright © 2001-2011 Joel de Guzman, Hartmut Kaiser<p>
442 Distributed under the Boost Software License, Version 1.0. (See accompanying
443 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>)
448 <div class="spirit-nav">
449 <a accesskey="p" href="begin_container.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../iterate.html"><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="next_iterator.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>