3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>Parser Directives Forcing Atomic Assignment (as<T>, as_string[], as_wstring[])</title>
5 <link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="../../../../index.html" title="Spirit 2.5.2">
8 <link rel="up" href="../directive.html" title="Parser Directives">
9 <link rel="prev" href="hold.html" title="Parser Directive for Attribute Commit/Rollback (hold[])">
10 <link rel="next" href="../nonterminal.html" title="Nonterminal Parsers">
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="hold.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../directive.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="../nonterminal.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
26 <div class="titlepage"><div><div><h5 class="title">
27 <a name="spirit.qi.reference.directive.as"></a><a class="link" href="as.html" title="Parser Directives Forcing Atomic Assignment (as<T>, as_string[], as_wstring[])">Parser Directives
28 Forcing Atomic Assignment (<code class="computeroutput"><span class="identifier">as</span><span class="special"><</span><span class="identifier">T</span><span class="special">>,</span> <span class="identifier">as_string</span><span class="special">[],</span> <span class="identifier">as_wstring</span><span class="special">[]</span></code>)</a>
29 </h5></div></div></div>
31 <a name="spirit.qi.reference.directive.as.h0"></a>
32 <span><a name="spirit.qi.reference.directive.as.description"></a></span><a class="link" href="as.html#spirit.qi.reference.directive.as.description">Description</a>
35 The <code class="computeroutput"><span class="identifier">as</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span></code>
36 class forces the atomic assignment of it's subject's synthesized attribute.
37 Usually, repetitive parsers (such as <a class="link" href="../operator/kleene.html" title="Kleene Parser (*a)">Kleene</a>,
38 etc) or sequences exposing a <code class="computeroutput"><span class="identifier">vector</span><span class="special"><</span><span class="identifier">A</span><span class="special">></span></code> will assign elements to the container
39 supplied as their synthesized attribute by calling <a class="link" href="../../../advanced/customize/store_value/push_back.html" title="Store a Parsed Attribute Value into a Container (Qi)"><code class="computeroutput"><span class="identifier">traits</span><span class="special">::</span><span class="identifier">push_back_container</span></code></a> repeatedly.
40 In some cases, this may be undesirable. The <code class="computeroutput"><span class="identifier">as</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span></code> class creates a directive that will
41 pass a temporary object of type <code class="computeroutput"><span class="identifier">T</span></code>
42 to it's subject. If the subject parser passes, the temporary object will
43 be assigned to the directive's supplied attribute with a single call
44 to <a class="link" href="../../../advanced/customize/assign_to.html" title="Store a Parsed Attribute Value (Qi)"><code class="computeroutput"><span class="identifier">traits</span><span class="special">::</span><span class="identifier">assign_to</span></code></a>. If the subject parser
45 fails, the directive's attribute is not mutated.
47 <div class="note"><table border="0" summary="Note">
49 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../images/note.png"></td>
50 <th align="left">Note</th>
52 <tr><td align="left" valign="top"><p>
53 <code class="computeroutput"><span class="identifier">T</span></code> is required to be
54 a container type. If <a class="link" href="../../../advanced/customize/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> does not return
55 true for <code class="computeroutput"><span class="identifier">T</span></code>, a compile-time
59 <div class="note"><table border="0" summary="Note">
61 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../images/note.png"></td>
62 <th align="left">Note</th>
64 <tr><td align="left" valign="top"><p>
65 The <code class="computeroutput"><span class="identifier">as</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span></code>
66 implicitly causes commit/rollback semantics similar in nature to the
67 <a class="link" href="hold.html" title="Parser Directive for Attribute Commit/Rollback (hold[])"><code class="computeroutput"><span class="identifier">hold</span></code></a>
71 <div class="caution"><table border="0" summary="Caution">
73 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="../../../../images/caution.png"></td>
74 <th align="left">Caution</th>
76 <tr><td align="left" valign="top"><p>
77 The <a class="link" href="../../../advanced/customize/assign_to.html" title="Store a Parsed Attribute Value (Qi)"><code class="computeroutput"><span class="identifier">traits</span><span class="special">::</span><span class="identifier">assign_to</span></code></a> customization point
78 may end up using <a class="link" href="../../../advanced/customize/store_value/push_back.html" title="Store a Parsed Attribute Value into a Container (Qi)"><code class="computeroutput"><span class="identifier">traits</span><span class="special">::</span><span class="identifier">push_back_container</span></code></a> to assign
79 the temporary object to the supplied attribute by default, depending
80 on the types involved. Use the interface described in <a class="link" href="../../../advanced/customize.html" title="Customization of Spirit's Attribute Handling">Customization
81 of Attribute Handling</a> to manipulate the semantics of this assignment
86 <a name="spirit.qi.reference.directive.as.h1"></a>
87 <span><a name="spirit.qi.reference.directive.as.header"></a></span><a class="link" href="as.html#spirit.qi.reference.directive.as.header">Header</a>
89 <pre class="programlisting"><span class="comment">// forwards to <boost/spirit/home/qi/directive/as.hpp></span>
90 <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">include</span><span class="special">/</span><span class="identifier">qi_as</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
93 Also, see <a class="link" href="../../../structure/include.html" title="Include">Include Structure</a>.
96 <a name="spirit.qi.reference.directive.as.h2"></a>
97 <span><a name="spirit.qi.reference.directive.as.namespace"></a></span><a class="link" href="as.html#spirit.qi.reference.directive.as.namespace">Namespace</a>
99 <div class="informaltable"><table class="table">
100 <colgroup><col></colgroup>
109 <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">as</span> <span class="comment">// alias:
110 boost::spirit::qi::as</span></code>
115 <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">as_string</span> <span class="comment">//
116 alias: boost::spirit::qi::as_string</span></code>
121 <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">as_wstring</span> <span class="comment">//
122 alias: boost::spirit::qi::as_wstring</span></code>
128 <a name="spirit.qi.reference.directive.as.h3"></a>
129 <span><a name="spirit.qi.reference.directive.as.synopsis"></a></span><a class="link" href="as.html#spirit.qi.reference.directive.as.synopsis">Synopsis</a>
131 <pre class="programlisting"><span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">></span>
132 <span class="keyword">struct</span> <span class="identifier">as</span><span class="special">;</span>
135 <a name="spirit.qi.reference.directive.as.h4"></a>
136 <span><a name="spirit.qi.reference.directive.as.template_parameters"></a></span><a class="link" href="as.html#spirit.qi.reference.directive.as.template_parameters">Template
139 <div class="informaltable"><table class="table">
164 <code class="computeroutput"><span class="identifier">T</span></code>
169 A container type. [none
175 <a name="spirit.qi.reference.directive.as.h5"></a>
176 <span><a name="spirit.qi.reference.directive.as.model_of"></a></span><a class="link" href="as.html#spirit.qi.reference.directive.as.model_of">Model
179 <div class="blockquote"><blockquote class="blockquote"><p>
180 <a class="link" href="../parser_concepts/unaryparser.html" title="UnaryParser"><code class="computeroutput"><span class="identifier">UnaryParser</span></code></a>
181 </p></blockquote></div>
182 <div class="variablelist">
183 <p class="title"><b>Notation</b></p>
185 <dt><span class="term"><code class="computeroutput"><span class="identifier">a</span></code></span></dt>
187 A <a class="link" href="../parser_concepts/parser.html" title="Parser"><code class="computeroutput"><span class="identifier">Parser</span></code></a>.
189 <dt><span class="term"><code class="computeroutput"><span class="identifier">t</span></code></span></dt>
191 A container of type <code class="computeroutput"><span class="identifier">T</span></code>.
193 <dt><span class="term"><code class="computeroutput"><span class="identifier">attr</span></code></span></dt>
195 The attribute supplied to the directive.
200 <a name="spirit.qi.reference.directive.as.h6"></a>
201 <span><a name="spirit.qi.reference.directive.as.expression_semantics"></a></span><a class="link" href="as.html#spirit.qi.reference.directive.as.expression_semantics">Expression
205 Semantics of an expression is defined only where it differs from, or
206 is not defined in <a class="link" href="../parser_concepts/unaryparser.html" title="UnaryParser"><code class="computeroutput"><span class="identifier">UnaryParser</span></code></a>.
208 <div class="informaltable"><table class="table">
229 <code class="computeroutput"><span class="identifier">as</span><span class="special"><</span><span class="identifier">T</span><span class="special">>()[</span><span class="identifier">a</span><span class="special">]</span></code>
234 Create a temporary object of <code class="computeroutput"><span class="identifier">t</span></code>
235 of type <code class="computeroutput"><span class="identifier">T</span></code>,
236 and invoke the subject parser <code class="computeroutput"><span class="identifier">a</span></code>,
237 supplying <code class="computeroutput"><span class="identifier">t</span></code>
238 as an attribute. If the subject parser passes, assign <code class="computeroutput"><span class="identifier">t</span></code> to <code class="computeroutput"><span class="identifier">attr</span></code>.
245 <code class="computeroutput"><span class="identifier">as_string</span><span class="special">[</span><span class="identifier">a</span><span class="special">]</span></code>
250 Equivalent to <code class="computeroutput"><span class="identifier">as</span><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">>()[</span><span class="identifier">a</span><span class="special">]</span></code>
257 <code class="computeroutput"><span class="identifier">as_wstring</span><span class="special">[</span><span class="identifier">a</span><span class="special">]</span></code>
262 Equivalent to <code class="computeroutput"><span class="identifier">as</span><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">wstring</span><span class="special">>()[</span><span class="identifier">a</span><span class="special">]</span></code>
269 <a name="spirit.qi.reference.directive.as.h7"></a>
270 <span><a name="spirit.qi.reference.directive.as.attributes"></a></span><a class="link" href="as.html#spirit.qi.reference.directive.as.attributes">Attributes</a>
273 See <a class="link" href="../../quick_reference/compound_attribute_rules.html#spirit.qi.quick_reference.compound_attribute_rules.notation">Compound
274 Attribute Notation</a>.
276 <div class="informaltable"><table class="table">
296 <code class="computeroutput"><span class="identifier">as</span><span class="special"><</span><span class="identifier">T</span><span class="special">>()[</span><span class="identifier">a</span><span class="special">]</span></code>
301 <code class="computeroutput"><span class="identifier">a</span><span class="special">:</span>
302 <span class="identifier">A</span> <span class="special">--></span>
303 <span class="identifier">as</span><span class="special"><</span><span class="identifier">T</span><span class="special">>()[</span><span class="identifier">a</span><span class="special">]:</span>
304 <span class="identifier">T</span></code>
310 <a name="spirit.qi.reference.directive.as.h8"></a>
311 <span><a name="spirit.qi.reference.directive.as.complexity"></a></span><a class="link" href="as.html#spirit.qi.reference.directive.as.complexity">Complexity</a>
313 <div class="blockquote"><blockquote class="blockquote"><p>
314 The complexity is defined by the complexity of the subject parser,
315 <code class="computeroutput"><span class="identifier">a</span></code>, and the complexity
316 of the assignment of the container <code class="computeroutput"><span class="identifier">t</span></code>
317 to the supplied attribute <code class="computeroutput"><span class="identifier">attr</span></code>.
318 </p></blockquote></div>
320 <a name="spirit.qi.reference.directive.as.h9"></a>
321 <span><a name="spirit.qi.reference.directive.as.example"></a></span><a class="link" href="as.html#spirit.qi.reference.directive.as.example">Example</a>
323 <div class="note"><table border="0" summary="Note">
325 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../images/note.png"></td>
326 <th align="left">Note</th>
328 <tr><td align="left" valign="top"><p>
329 The test harness for the example(s) below is presented in the <a class="link" href="../basics.html#spirit.qi.reference.basics.examples">Basics Examples</a>
334 Some using declarations:
338 <pre class="programlisting"><span class="keyword">using</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">utree</span><span class="special">;</span>
339 <span class="keyword">using</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">utree_type</span><span class="special">;</span>
340 <span class="keyword">using</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">utf8_symbol_type</span><span class="special">;</span>
341 <span class="keyword">using</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">qi</span><span class="special">::</span><span class="identifier">as</span><span class="special">;</span>
342 <span class="keyword">using</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">qi</span><span class="special">::</span><span class="identifier">as_string</span><span class="special">;</span>
343 <span class="keyword">using</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">qi</span><span class="special">::</span><span class="identifier">char_</span><span class="special">;</span>
348 Simple usage of <code class="computeroutput"><span class="identifier">as</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span></code>,
349 <code class="computeroutput"><span class="identifier">as_string</span></code> and <code class="computeroutput"><span class="identifier">as_wstring</span></code>:
352 To properly handle string concatenation with <a class="link" href="../../../support/utree.html" title="The utree data structure"><code class="computeroutput"><span class="identifier">utree</span></code></a>, we make use of <code class="computeroutput"><span class="identifier">as_string</span><span class="special">[]</span></code>.
353 We also use <code class="computeroutput"><span class="identifier">as</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span></code>
354 to explicitly create a <a class="link" href="../../../support/utree.html" title="The utree data structure"><code class="computeroutput"><span class="identifier">utree</span></code></a> symbol node.
358 <pre class="programlisting"><span class="identifier">utree</span> <span class="identifier">ut</span><span class="special">;</span>
360 <span class="keyword">typedef</span> <span class="identifier">as</span><span class="special"><</span><span class="identifier">utf8_symbol_type</span><span class="special">></span> <span class="identifier">as_symbol_type</span><span class="special">;</span>
361 <span class="identifier">as_symbol_type</span> <span class="keyword">const</span> <span class="identifier">as_symbol</span> <span class="special">=</span> <span class="identifier">as_symbol_type</span><span class="special">();</span>
363 <span class="identifier">test_parser_attr</span><span class="special">(</span><span class="string">"foo"</span><span class="special">,</span> <span class="identifier">as_string</span><span class="special">[*</span><span class="identifier">char_</span><span class="special">],</span> <span class="identifier">ut</span><span class="special">);</span>
364 <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="identifier">ut</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span> <span class="comment">// will output >"foo"<</span>
365 <span class="identifier">BOOST_ASSERT</span><span class="special">(</span><span class="identifier">ut</span><span class="special">.</span><span class="identifier">which</span><span class="special">()</span> <span class="special">==</span> <span class="identifier">utree_type</span><span class="special">::</span><span class="identifier">string_type</span><span class="special">);</span>
366 <span class="identifier">ut</span><span class="special">.</span><span class="identifier">clear</span><span class="special">();</span>
368 <span class="identifier">test_parser_attr</span><span class="special">(</span><span class="string">"foo"</span><span class="special">,</span> <span class="identifier">as</span><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">>()[*</span><span class="identifier">char_</span><span class="special">],</span> <span class="identifier">ut</span><span class="special">);</span>
369 <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="identifier">ut</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span> <span class="comment">// will output >"foo"<</span>
370 <span class="identifier">BOOST_ASSERT</span><span class="special">(</span><span class="identifier">ut</span><span class="special">.</span><span class="identifier">which</span><span class="special">()</span> <span class="special">==</span> <span class="identifier">utree_type</span><span class="special">::</span><span class="identifier">string_type</span><span class="special">);</span>
371 <span class="identifier">ut</span><span class="special">.</span><span class="identifier">clear</span><span class="special">();</span>
373 <span class="identifier">test_parser_attr</span><span class="special">(</span><span class="string">"foo"</span><span class="special">,</span> <span class="identifier">as_symbol</span><span class="special">[*</span><span class="identifier">char_</span><span class="special">],</span> <span class="identifier">ut</span><span class="special">);</span>
374 <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="identifier">ut</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span> <span class="comment">// will output >foo<</span>
375 <span class="identifier">BOOST_ASSERT</span><span class="special">(</span><span class="identifier">ut</span><span class="special">.</span><span class="identifier">which</span><span class="special">()</span> <span class="special">==</span> <span class="identifier">utree_type</span><span class="special">::</span><span class="identifier">symbol_type</span><span class="special">);</span>
376 <span class="identifier">ut</span><span class="special">.</span><span class="identifier">clear</span><span class="special">();</span>
378 <span class="identifier">test_parser_attr</span><span class="special">(</span><span class="string">"foo"</span><span class="special">,</span> <span class="identifier">as</span><span class="special"><</span><span class="identifier">utf8_symbol_type</span><span class="special">>()[*</span><span class="identifier">char_</span><span class="special">],</span> <span class="identifier">ut</span><span class="special">);</span>
379 <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="identifier">ut</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span> <span class="comment">// will output >foo<</span>
380 <span class="identifier">BOOST_ASSERT</span><span class="special">(</span><span class="identifier">ut</span><span class="special">.</span><span class="identifier">which</span><span class="special">()</span> <span class="special">==</span> <span class="identifier">utree_type</span><span class="special">::</span><span class="identifier">symbol_type</span><span class="special">);</span>
385 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
386 <td align="left"></td>
387 <td align="right"><div class="copyright-footer">Copyright © 2001-2011 Joel de Guzman, Hartmut Kaiser<p>
388 Distributed under the Boost Software License, Version 1.0. (See accompanying
389 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>)
394 <div class="spirit-nav">
395 <a accesskey="p" href="hold.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../directive.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="../nonterminal.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>