| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>Stream (stream, wstream, etc.)</title> |
| <link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.75.0"> |
| <link rel="home" href="../../../../index.html" title="Spirit 2.4.1"> |
| <link rel="up" href="../stream.html" title="Stream"> |
| <link rel="prev" href="../stream.html" title="Stream"> |
| <link rel="next" href="../string.html" title="String"> |
| </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="../stream.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../stream.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="../string.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| <div class="section"> |
| <div class="titlepage"><div><div><h5 class="title"> |
| <a name="spirit.karma.reference.stream.stream"></a><a class="link" href="stream.html" title="Stream (stream, wstream, etc.)">Stream (<code class="computeroutput"><span class="identifier">stream</span></code>, <code class="computeroutput"><span class="identifier">wstream</span></code>, |
| etc.)</a> |
| </h5></div></div></div> |
| <a name="spirit.karma.reference.stream.stream.description"></a><h6> |
| <a name="id1100152"></a> |
| <a class="link" href="stream.html#spirit.karma.reference.stream.stream.description">Description</a> |
| </h6> |
| <p> |
| The <code class="computeroutput"><span class="identifier">stream_generator</span></code> |
| is a primitive which allows to use pre-existing standard streaming operators |
| for output generation integrated with <span class="emphasis"><em>Spirit.Karma</em></span>. |
| It provides a wrapper generator dispatching the value to output to the |
| stream operator of the corresponding type. Any value <code class="computeroutput"><span class="identifier">a</span></code> |
| to be formatted using the <code class="computeroutput"><span class="identifier">stream_generator</span></code> |
| will result in invoking the standard streaming operator for its type |
| <code class="computeroutput"><span class="identifier">A</span></code>, for instance: |
| </p> |
| <pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span><span class="special">&</span> <span class="keyword">operator</span><span class="special"><<</span> <span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span><span class="special">&,</span> <span class="identifier">A</span> <span class="keyword">const</span><span class="special">&);</span> |
| </pre> |
| <a name="spirit.karma.reference.stream.stream.header"></a><h6> |
| <a name="id1100261"></a> |
| <a class="link" href="stream.html#spirit.karma.reference.stream.stream.header">Header</a> |
| </h6> |
| <pre class="programlisting"><span class="comment">// forwards to <boost/spirit/home/karma/stream.hpp> |
| </span><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">karma_stream</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> |
| </pre> |
| <p> |
| Also, see <a class="link" href="../../../structure/include.html" title="Include">Include Structure</a>. |
| </p> |
| <a name="spirit.karma.reference.stream.stream.namespace"></a><h6> |
| <a name="id1100336"></a> |
| <a class="link" href="stream.html#spirit.karma.reference.stream.stream.namespace">Namespace</a> |
| </h6> |
| <div class="informaltable"><table class="table"> |
| <colgroup><col></colgroup> |
| <thead><tr><th> |
| <p> |
| Name |
| </p> |
| </th></tr></thead> |
| <tbody> |
| <tr><td> |
| <p> |
| <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">stream</span> <span class="comment">// |
| alias: boost::spirit::karma::stream</span></code> |
| </p> |
| </td></tr> |
| <tr><td> |
| <p> |
| <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">wstream</span> <span class="comment">// |
| alias: boost::spirit::karma::wstream</span></code> |
| </p> |
| </td></tr> |
| </tbody> |
| </table></div> |
| <a name="spirit.karma.reference.stream.stream.synopsis"></a><h6> |
| <a name="id1100453"></a> |
| <a class="link" href="stream.html#spirit.karma.reference.stream.stream.synopsis">Synopsis</a> |
| </h6> |
| <pre class="programlisting"><span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Char</span><span class="special">></span> |
| <span class="keyword">struct</span> <span class="identifier">stream_generator</span><span class="special">;</span> |
| </pre> |
| <a name="spirit.karma.reference.stream.stream.template_parameters"></a><h6> |
| <a name="id1100507"></a> |
| <a class="link" href="stream.html#spirit.karma.reference.stream.stream.template_parameters">Template |
| parameters</a> |
| </h6> |
| <div class="informaltable"><table class="table"> |
| <colgroup> |
| <col> |
| <col> |
| <col> |
| </colgroup> |
| <thead><tr> |
| <th> |
| <p> |
| Parameter |
| </p> |
| </th> |
| <th> |
| <p> |
| Description |
| </p> |
| </th> |
| <th> |
| <p> |
| Default |
| </p> |
| </th> |
| </tr></thead> |
| <tbody><tr> |
| <td> |
| <p> |
| <code class="computeroutput"><span class="identifier">Char</span></code> |
| </p> |
| </td> |
| <td> |
| <p> |
| The character type to use to generate the output. This type |
| will be used while assigning the generated characters to the |
| underlying output iterator. |
| </p> |
| </td> |
| <td> |
| <p> |
| <code class="computeroutput"><span class="keyword">char</span></code> |
| </p> |
| </td> |
| </tr></tbody> |
| </table></div> |
| <a name="spirit.karma.reference.stream.stream.model_of"></a><h6> |
| <a name="id1100605"></a> |
| <a class="link" href="stream.html#spirit.karma.reference.stream.stream.model_of">Model of</a> |
| </h6> |
| <div class="blockquote"><blockquote class="blockquote"><p> |
| <a class="link" href="../generator_concepts/primitivegenerator.html" title="PrimitiveGenerator"><code class="computeroutput"><span class="identifier">PrimitiveGenerator</span></code></a> |
| </p></blockquote></div> |
| <div class="variablelist"> |
| <p class="title"><b>Notation</b></p> |
| <dl> |
| <dt><span class="term"><code class="computeroutput"><span class="identifier">s</span></code></span></dt> |
| <dd><p> |
| A variable instance of any type with a defined matching streaming |
| <code class="computeroutput"><span class="keyword">operator</span><span class="special"><<()</span></code> |
| or a <a class="link" href="../karma_basics.html#spirit.karma.reference.karma_basics.lazy_argument">Lazy |
| Argument</a> that evaluates to any type with a defined matching |
| streaming <code class="computeroutput"><span class="keyword">operator</span><span class="special"><<()</span></code>. |
| </p></dd> |
| </dl> |
| </div> |
| <a name="spirit.karma.reference.stream.stream.expression_semantics"></a><h6> |
| <a name="id1100692"></a> |
| <a class="link" href="stream.html#spirit.karma.reference.stream.stream.expression_semantics">Expression |
| Semantics</a> |
| </h6> |
| <p> |
| Semantics of an expression is defined only where it differs from, or |
| is not defined in <a class="link" href="../generator_concepts/primitivegenerator.html" title="PrimitiveGenerator"><code class="computeroutput"><span class="identifier">PrimitiveGenerator</span></code></a>. |
| </p> |
| <div class="informaltable"><table class="table"> |
| <colgroup> |
| <col> |
| <col> |
| </colgroup> |
| <thead><tr> |
| <th> |
| <p> |
| Expression |
| </p> |
| </th> |
| <th> |
| <p> |
| Description |
| </p> |
| </th> |
| </tr></thead> |
| <tbody> |
| <tr> |
| <td> |
| <p> |
| <code class="computeroutput"><span class="identifier">stream</span></code> |
| </p> |
| </td> |
| <td> |
| <p> |
| Call the streaming <code class="computeroutput"><span class="keyword">operator</span><span class="special"><<()</span></code> for the type of the |
| mandatory attribute. The output emitted by this operator will |
| be the result of the <code class="computeroutput"><span class="identifier">stream</span></code> |
| generator. This generator never fails (unless the underlying |
| output stream reports an error). The character type of the |
| I/O ostream is assumed to be <code class="computeroutput"><span class="keyword">char</span></code>. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <code class="computeroutput"><span class="identifier">stream</span><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></code> |
| </p> |
| </td> |
| <td> |
| <p> |
| Call the streaming <code class="computeroutput"><span class="keyword">operator</span><span class="special"><<()</span></code> for the type of the |
| immediate value <code class="computeroutput"><span class="identifier">s</span></code>. |
| The output emitted by this operator will be the result of the |
| <code class="computeroutput"><span class="identifier">stream</span></code> generator. |
| This generator never fails (unless the underlying output stream |
| reports an error). The character type of the I/O ostream is |
| assumed to be <code class="computeroutput"><span class="keyword">char</span></code>. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <code class="computeroutput"><span class="identifier">wstream</span></code> |
| </p> |
| </td> |
| <td> |
| <p> |
| Call the streaming <code class="computeroutput"><span class="keyword">operator</span><span class="special"><<()</span></code> for the type of the |
| mandatory attribute. The output emitted by this operator will |
| be the result of the <code class="computeroutput"><span class="identifier">stream</span></code> |
| generator. This generator never fails (unless the underlying |
| output stream reports an error). The character type of the |
| I/O ostream is assumed to be <code class="computeroutput"><span class="keyword">wchar_t</span></code>. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <code class="computeroutput"><span class="identifier">wstream</span><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></code> |
| </p> |
| </td> |
| <td> |
| <p> |
| Call the streaming <code class="computeroutput"><span class="keyword">operator</span><span class="special"><<()</span></code> for the type of the |
| immediate value <code class="computeroutput"><span class="identifier">s</span></code>. |
| The output emitted by this operator will be the result of the |
| <code class="computeroutput"><span class="identifier">stream</span></code> generator. |
| This generator never fails (unless the underlying output stream |
| reports an error). The character type of the I/O ostream is |
| assumed to be <code class="computeroutput"><span class="keyword">wchar_t</span></code>. |
| </p> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| <p> |
| All generators listed in the table above are predefined specializations |
| of the <code class="computeroutput"><span class="identifier">stream_generator</span><span class="special"><</span><span class="identifier">Char</span><span class="special">></span></code> basic stream generator type described |
| below. It is possible to directly use this type to create stream generators |
| using an arbitrary underlying character type. |
| </p> |
| <div class="informaltable"><table class="table"> |
| <colgroup> |
| <col> |
| <col> |
| </colgroup> |
| <thead><tr> |
| <th> |
| <p> |
| Expression |
| </p> |
| </th> |
| <th> |
| <p> |
| Semantics |
| </p> |
| </th> |
| </tr></thead> |
| <tbody> |
| <tr> |
| <td> |
| <p> |
| |
| </p> |
| <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">stream_generator</span><span class="special"><</span> |
| <span class="identifier">Char</span> |
| <span class="special">>()</span></pre> |
| <p> |
| </p> |
| </td> |
| <td> |
| <p> |
| Call the streaming <code class="computeroutput"><span class="keyword">operator</span><span class="special"><<()</span></code> for the type of the |
| mandatory attribute. The output emitted by this operator will |
| be the result of the <code class="computeroutput"><span class="identifier">stream</span></code> |
| generator. This generator never fails (unless the underlying |
| output stream reports an error). The character type of the |
| I/O ostream is assumed to be <code class="computeroutput"><span class="identifier">Char</span></code> |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| |
| </p> |
| <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">stream_generator</span><span class="special"><</span> |
| <span class="identifier">Char</span> |
| <span class="special">>()(</span><span class="identifier">s</span><span class="special">)</span></pre> |
| <p> |
| </p> |
| </td> |
| <td> |
| <p> |
| Call the streaming <code class="computeroutput"><span class="keyword">operator</span><span class="special"><<()</span></code> for the type of the |
| immediate value <code class="computeroutput"><span class="identifier">s</span></code>. |
| The output emitted by this operator will be the result of the |
| <code class="computeroutput"><span class="identifier">stream</span></code> generator. |
| This generator never fails (unless the underlying output stream |
| reports an error). The character type of the I/O ostream is |
| assumed to be <code class="computeroutput"><span class="identifier">Char</span></code>. |
| </p> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| <a name="spirit.karma.reference.stream.stream.additional_requirements"></a><h6> |
| <a name="id1102367"></a> |
| <a class="link" href="stream.html#spirit.karma.reference.stream.stream.additional_requirements">Additional |
| Requirements</a> |
| </h6> |
| <p> |
| All of the stream generators listed above require the type of the value |
| to generate output for (either the immediate value or the associated |
| attribute) to implement a streaming operator conforming to the usual |
| I/O streams conventions (where <code class="computeroutput"><span class="identifier">attribute_type</span></code> |
| is the type of the value to generate output for): |
| </p> |
| <pre class="programlisting"><span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Ostream</span><span class="special">></span> |
| <span class="identifier">Ostream</span><span class="special">&</span> <span class="keyword">operator</span><span class="special"><<</span> <span class="special">(</span><span class="identifier">Ostream</span><span class="special">&</span> <span class="identifier">os</span><span class="special">,</span> <span class="identifier">attribute_type</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">attr</span><span class="special">)</span> |
| <span class="special">{</span> |
| <span class="comment">// type specific output generation |
| </span> <span class="keyword">return</span> <span class="identifier">os</span><span class="special">;</span> |
| <span class="special">}</span> |
| </pre> |
| <p> |
| This operator will be called by the stream generators to gather the output |
| for the attribute of type <code class="computeroutput"><span class="identifier">attribute_type</span></code>. |
| All data streamed into the given <code class="computeroutput"><span class="identifier">Ostream</span></code> |
| will end up being generated by the corresponding stream generator instance. |
| </p> |
| <div class="note"><table border="0" summary="Note"> |
| <tr> |
| <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../images/note.png"></td> |
| <th align="left">Note</th> |
| </tr> |
| <tr><td align="left" valign="top"><p> |
| If the <code class="computeroutput"><span class="identifier">stream</span></code> generator |
| is invoked inside a <a class="link" href="../generate_api/stream_api.html" title="Stream Based Generator API"><code class="computeroutput"><span class="identifier">format</span></code></a> (or <a class="link" href="../generate_api/stream_api.html" title="Stream Based Generator API"><code class="computeroutput"><span class="identifier">format_delimited</span></code></a>) stream manipulator |
| the <code class="computeroutput"><span class="identifier">Ostream</span></code> passed |
| to the <code class="computeroutput"><span class="keyword">operator</span><span class="special"><<()</span></code> |
| will have registered (imbued) the same standard locale instance as |
| the stream the <a class="link" href="../generate_api/stream_api.html" title="Stream Based Generator API"><code class="computeroutput"><span class="identifier">format</span></code></a> (or <a class="link" href="../generate_api/stream_api.html" title="Stream Based Generator API"><code class="computeroutput"><span class="identifier">format_delimited</span></code></a>) manipulator |
| has been used with. This ensures all facets registered (imbued) with |
| the original I/O stream object are used during output generation. |
| </p></td></tr> |
| </table></div> |
| <a name="spirit.karma.reference.stream.stream.attributes"></a><h6> |
| <a name="id1102594"></a> |
| <a class="link" href="stream.html#spirit.karma.reference.stream.stream.attributes">Attributes</a> |
| </h6> |
| <div class="informaltable"><table class="table"> |
| <colgroup> |
| <col> |
| <col> |
| </colgroup> |
| <thead><tr> |
| <th> |
| <p> |
| Expression |
| </p> |
| </th> |
| <th> |
| <p> |
| Attribute |
| </p> |
| </th> |
| </tr></thead> |
| <tbody> |
| <tr> |
| <td> |
| <p> |
| <code class="computeroutput"><span class="identifier">stream</span></code> |
| </p> |
| </td> |
| <td> |
| <p> |
| <code class="computeroutput"><span class="identifier">hold_any</span></code>, attribute |
| is mandatory (otherwise compilation will fail) |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <code class="computeroutput"><span class="identifier">stream</span><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></code> |
| </p> |
| </td> |
| <td> |
| <p> |
| <code class="computeroutput"><span class="identifier">unused</span></code> |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <code class="computeroutput"><span class="identifier">wstream</span></code> |
| </p> |
| </td> |
| <td> |
| <p> |
| <code class="computeroutput"><span class="identifier">hold_any</span></code>, attribute |
| is mandatory (otherwise compilation will fail) |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <code class="computeroutput"><span class="identifier">wstream</span><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></code> |
| </p> |
| </td> |
| <td> |
| <p> |
| <code class="computeroutput"><span class="identifier">unused</span></code> |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <code class="computeroutput"><span class="identifier">stream_generator</span><span class="special"><</span><span class="identifier">Char</span><span class="special">>()</span></code> |
| </p> |
| </td> |
| <td> |
| <p> |
| <code class="computeroutput"><span class="identifier">hold_any</span></code>, attribute |
| is mandatory (otherwise compilation will fail) |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <code class="computeroutput"><span class="identifier">stream_generator</span><span class="special"><</span><span class="identifier">Char</span><span class="special">>()(</span><span class="identifier">s</span><span class="special">)</span></code> |
| </p> |
| </td> |
| <td> |
| <p> |
| <code class="computeroutput"><span class="identifier">unused</span></code> |
| </p> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| <div class="important"><table border="0" summary="Important"> |
| <tr> |
| <td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="../../../../images/important.png"></td> |
| <th align="left">Important</th> |
| </tr> |
| <tr><td align="left" valign="top"><p> |
| The attribute type <code class="computeroutput"><span class="identifier">hold_any</span></code> |
| exposed by some of the stream generators is semantically and syntactically |
| equivalent to the type implemented by <a href="../../../../../../../../libs/any/index.html" target="_top">Boost.Any</a>. |
| It has been added to <span class="emphasis"><em>Spirit</em></span> as it has better a |
| performance and a smaller footprint if compared to <a href="../../../../../../../../libs/any/index.html" target="_top">Boost.Any</a>. |
| </p></td></tr> |
| </table></div> |
| <div class="note"><table border="0" summary="Note"> |
| <tr> |
| <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../images/note.png"></td> |
| <th align="left">Note</th> |
| </tr> |
| <tr><td align="left" valign="top"><p> |
| In addition to their usual attribute of type <code class="computeroutput"><span class="identifier">Attrib</span></code> |
| all listed generators accept an instance of a <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">optional</span><span class="special"><</span><span class="identifier">Attrib</span><span class="special">></span></code> as well. If the <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">optional</span><span class="special"><></span></code> is initialized (holds a value) |
| the generators behave as if their attribute was an instance of <code class="computeroutput"><span class="identifier">Attrib</span></code> and emit the value stored |
| in the <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">optional</span><span class="special"><></span></code>. |
| Otherwise the generators will fail. |
| </p></td></tr> |
| </table></div> |
| <a name="spirit.karma.reference.stream.stream.complexity"></a><h6> |
| <a name="id1102999"></a> |
| <a class="link" href="stream.html#spirit.karma.reference.stream.stream.complexity">Complexity</a> |
| </h6> |
| <div class="blockquote"><blockquote class="blockquote"><p> |
| O(N), where N is the number of characters emitted by the stream generator |
| </p></blockquote></div> |
| <a name="spirit.karma.reference.stream.stream.example"></a><h6> |
| <a name="id1103020"></a> |
| <a class="link" href="stream.html#spirit.karma.reference.stream.stream.example">Example</a> |
| </h6> |
| <div class="note"><table border="0" summary="Note"> |
| <tr> |
| <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../images/note.png"></td> |
| <th align="left">Note</th> |
| </tr> |
| <tr><td align="left" valign="top"><p> |
| The test harness for the example(s) below is presented in the <a class="link" href="../karma_basics.html#spirit.karma.reference.karma_basics.examples">Basics Examples</a> |
| section. |
| </p></td></tr> |
| </table></div> |
| <p> |
| Some includes: |
| </p> |
| <p> |
| |
| </p> |
| <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">include</span><span class="special">/</span><span class="identifier">karma</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> |
| <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">phoenix_core</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> |
| <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">phoenix_operator</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> |
| <span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">fusion</span><span class="special">/</span><span class="identifier">include</span><span class="special">/</span><span class="identifier">std_pair</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> |
| <span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span> |
| <span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">string</span><span class="special">></span> |
| </pre> |
| <p> |
| </p> |
| <p> |
| Some using declarations: |
| </p> |
| <p> |
| |
| </p> |
| <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">karma</span><span class="special">::</span><span class="identifier">stream</span><span class="special">;</span> |
| </pre> |
| <p> |
| </p> |
| <p> |
| And a class definition used in the examples: |
| </p> |
| <p> |
| |
| </p> |
| <pre class="programlisting"><span class="comment">// a simple complex number representation z = a + bi |
| </span><span class="keyword">struct</span> <span class="identifier">complex</span> |
| <span class="special">{</span> |
| <span class="identifier">complex</span> <span class="special">(</span><span class="keyword">double</span> <span class="identifier">a</span><span class="special">,</span> <span class="keyword">double</span> <span class="identifier">b</span><span class="special">)</span> |
| <span class="special">:</span> <span class="identifier">a</span><span class="special">(</span><span class="identifier">a</span><span class="special">),</span> <span class="identifier">b</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span> |
| <span class="special">{}</span> |
| |
| <span class="keyword">double</span> <span class="identifier">a</span><span class="special">;</span> |
| <span class="keyword">double</span> <span class="identifier">b</span><span class="special">;</span> |
| <span class="special">};</span> |
| </pre> |
| <p> |
| </p> |
| <p> |
| |
| </p> |
| <pre class="programlisting"><span class="comment">// define streaming operator for the type complex |
| </span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span><span class="special">&</span> |
| <span class="keyword">operator</span><span class="special"><<</span> <span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span><span class="special">&</span> <span class="identifier">os</span><span class="special">,</span> <span class="identifier">complex</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">z</span><span class="special">)</span> |
| <span class="special">{</span> |
| <span class="identifier">os</span> <span class="special"><<</span> <span class="string">"{"</span> <span class="special"><<</span> <span class="identifier">z</span><span class="special">.</span><span class="identifier">a</span> <span class="special"><<</span> <span class="string">","</span> <span class="special"><<</span> <span class="identifier">z</span><span class="special">.</span><span class="identifier">b</span> <span class="special"><<</span> <span class="string">"}"</span><span class="special">;</span> |
| <span class="keyword">return</span> <span class="identifier">os</span><span class="special">;</span> |
| <span class="special">}</span> |
| </pre> |
| <p> |
| </p> |
| <p> |
| Basic usage of <code class="computeroutput"><span class="identifier">stream</span></code> |
| generators: |
| </p> |
| <p> |
| |
| </p> |
| <pre class="programlisting"><span class="identifier">test_generator_attr</span><span class="special">(</span><span class="string">"abc"</span><span class="special">,</span> <span class="identifier">stream</span><span class="special">,</span> <span class="string">"abc"</span><span class="special">);</span> |
| <span class="identifier">test_generator</span><span class="special">(</span><span class="string">"abc"</span><span class="special">,</span> <span class="identifier">stream</span><span class="special">(</span><span class="string">"abc"</span><span class="special">));</span> |
| <span class="identifier">test_generator_attr</span><span class="special">(</span><span class="string">"{1.2,2.4}"</span><span class="special">,</span> <span class="identifier">stream</span><span class="special">,</span> <span class="identifier">complex</span><span class="special">(</span><span class="number">1.2</span><span class="special">,</span> <span class="number">2.4</span><span class="special">));</span> |
| <span class="identifier">test_generator</span><span class="special">(</span><span class="string">"{1.2,2.4}"</span><span class="special">,</span> <span class="identifier">stream</span><span class="special">(</span><span class="identifier">complex</span><span class="special">(</span><span class="number">1.2</span><span class="special">,</span> <span class="number">2.4</span><span class="special">)));</span> |
| </pre> |
| <p> |
| </p> |
| </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 © 2001-2010 Joel de Guzman, Hartmut Kaiser<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="../stream.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../stream.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="../string.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| </body> |
| </html> |
