<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Binary Native Endian</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"> <link rel="up" href="../binary.html" title="Binary"> <link rel="prev" href="../binary.html" title="Binary"> <link rel="next" href="binary_little.html" title="Binary Little Endian"> </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="../binary.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../binary.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="binary_little.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.qi.reference.binary.binary_native"></a><a class="link" href="binary_native.html" title="Binary Native Endian"> Binary Native Endian</a> </h5></div></div></div> <a name="spirit.qi.reference.binary.binary_native.description"></a><h6> <a name="id912647"></a> <a class="link" href="binary_native.html#spirit.qi.reference.binary.binary_native.description">Description</a> </h6> <p> Binary native endian parsers are designed to parse binary byte streams that are laid out in the native <a href="http://en.wikipedia.org/wiki/Endianness" target="_top">endianness</a> of the target architecture. </p> <a name="spirit.qi.reference.binary.binary_native.header"></a><h6> <a name="id912668"></a> <a class="link" href="binary_native.html#spirit.qi.reference.binary.binary_native.header">Header</a> </h6> <pre class="programlisting"><span class="comment">// forwards to <boost/spirit/home/qi/binary.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">qi_binary</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.qi.reference.binary.binary_native.namespace"></a><h6> <a name="id912743"></a> <a class="link" href="binary_native.html#spirit.qi.reference.binary.binary_native.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">byte_</span> <span class="comment">// alias: boost::spirit::qi::byte_</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">word</span> <span class="comment">// alias: boost::spirit::qi::word</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">dword</span> <span class="comment">// alias: boost::spirit::qi::dword</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">qword</span> <span class="comment">// alias: boost::spirit::qi::qword</span></code> </p> </td></tr> </tbody> </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> <code class="computeroutput"><span class="identifier">qword</span></code> is only available on platforms where the preprocessor constant <code class="computeroutput"><span class="identifier">BOOST_HAS_LONG_LONG</span></code> is defined (i.e. on platforms having native support for <code class="computeroutput"><span class="keyword">unsigned</span> <span class="keyword">long</span> <span class="keyword">long</span></code> (64 bit) integer types). </p></td></tr> </table></div> <a name="spirit.qi.reference.binary.binary_native.model_of"></a><h6> <a name="id912974"></a> <a class="link" href="binary_native.html#spirit.qi.reference.binary.binary_native.model_of">Model of</a> </h6> <div class="blockquote"><blockquote class="blockquote"><p> <a class="link" href="../parser_concepts/primitiveparser.html" title="PrimitiveParser"><code class="computeroutput"><span class="identifier">PrimitiveParser</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">b</span></code></span></dt> <dd><p> A single byte (8 bit binary value) or a <a class="link" href="../basics.html#spirit.qi.reference.basics.lazy_argument">Lazy Argument</a> that evaluates to a single byte. This value is always in native endian. </p></dd> <dt><span class="term"><code class="computeroutput"><span class="identifier">w</span></code></span></dt> <dd><p> A 16 bit binary value or a <a class="link" href="../basics.html#spirit.qi.reference.basics.lazy_argument">Lazy Argument</a> that evaluates to a 16 bit binary value. This value is always in native endian. </p></dd> <dt><span class="term"><code class="computeroutput"><span class="identifier">dw</span></code></span></dt> <dd><p> A 32 bit binary value or a <a class="link" href="../basics.html#spirit.qi.reference.basics.lazy_argument">Lazy Argument</a> that evaluates to a 32 bit binary value. This value is always in native endian. </p></dd> <dt><span class="term"><code class="computeroutput"><span class="identifier">qw</span></code></span></dt> <dd><p> A 64 bit binary value or a <a class="link" href="../basics.html#spirit.qi.reference.basics.lazy_argument">Lazy Argument</a> that evaluates to a 64 bit binary value. This value is always in native endian. </p></dd> </dl> </div> <a name="spirit.qi.reference.binary.binary_native.expression_semantics"></a><h6> <a name="id913111"></a> <a class="link" href="binary_native.html#spirit.qi.reference.binary.binary_native.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="../parser_concepts/primitiveparser.html" title="PrimitiveParser"><code class="computeroutput"><span class="identifier">PrimitiveParser</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">byte_</span></code> </p> </td> <td> <p> Matches any 8 bit native endian binary. </p> </td> </tr> <tr> <td> <p> <code class="computeroutput"><span class="identifier">word</span></code> </p> </td> <td> <p> Matches any 16 bit native endian binary. </p> </td> </tr> <tr> <td> <p> <code class="computeroutput"><span class="identifier">dword</span></code> </p> </td> <td> <p> Matches any 32 bit native endian binary. </p> </td> </tr> <tr> <td> <p> <code class="computeroutput"><span class="identifier">qword</span></code> </p> </td> <td> <p> Matches any 64 bit native endian binary. </p> </td> </tr> <tr> <td> <p> <code class="computeroutput"><span class="identifier">byte_</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code> </p> </td> <td> <p> Matches an exact 8 bit native endian binary. </p> </td> </tr> <tr> <td> <p> <code class="computeroutput"><span class="identifier">word</span><span class="special">(</span><span class="identifier">w</span><span class="special">)</span></code> </p> </td> <td> <p> Matches an exact 16 bit native endian binary. </p> </td> </tr> <tr> <td> <p> <code class="computeroutput"><span class="identifier">dword</span><span class="special">(</span><span class="identifier">dw</span><span class="special">)</span></code> </p> </td> <td> <p> Matches an exact 32 bit native endian binary. </p> </td> </tr> <tr> <td> <p> <code class="computeroutput"><span class="identifier">qword</span><span class="special">(</span><span class="identifier">qw</span><span class="special">)</span></code> </p> </td> <td> <p> Matches an exact 64 bit native endian binary. </p> </td> </tr> </tbody> </table></div> <a name="spirit.qi.reference.binary.binary_native.attributes"></a><h6> <a name="id914512"></a> <a class="link" href="binary_native.html#spirit.qi.reference.binary.binary_native.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">byte_</span></code> </p> </td> <td> <p> <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint_least8_t</span></code> </p> </td> </tr> <tr> <td> <p> <code class="computeroutput"><span class="identifier">word</span></code> </p> </td> <td> <p> <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint_least16_t</span></code> </p> </td> </tr> <tr> <td> <p> <code class="computeroutput"><span class="identifier">dword</span></code> </p> </td> <td> <p> <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint_least32_t</span></code> </p> </td> </tr> <tr> <td> <p> <code class="computeroutput"><span class="identifier">qword</span></code> </p> </td> <td> <p> <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint_least64_t</span></code> </p> </td> </tr> <tr> <td> <p> <code class="computeroutput"><span class="identifier">byte_</span><span class="special">(</span><span class="identifier">b</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">word</span><span class="special">(</span><span class="identifier">w</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">dword</span><span class="special">(</span><span class="identifier">dw</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">qword</span><span class="special">(</span><span class="identifier">qw</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> <a name="spirit.qi.reference.binary.binary_native.complexity"></a><h6> <a name="id914891"></a> <a class="link" href="binary_native.html#spirit.qi.reference.binary.binary_native.complexity">Complexity</a> </h6> <div class="blockquote"><blockquote class="blockquote"><p> O(N), where N is the number of bytes parsed </p></blockquote></div> <a name="spirit.qi.reference.binary.binary_native.example"></a><h6> <a name="id914912"></a> <a class="link" href="binary_native.html#spirit.qi.reference.binary.binary_native.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="../basics.html#spirit.qi.reference.basics.examples">Basics Examples</a> section. </p></td></tr> </table></div> <p> Using declarations and variables: </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">qi</span><span class="special">::</span><span class="identifier">byte_</span><span class="special">;</span> <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">word</span><span class="special">;</span> <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">dword</span><span class="special">;</span> <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">qword</span><span class="special">;</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint8_t</span> <span class="identifier">uc</span><span class="special">;</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint16_t</span> <span class="identifier">us</span><span class="special">;</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint32_t</span> <span class="identifier">ui</span><span class="special">;</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint64_t</span> <span class="identifier">ul</span><span class="special">;</span> </pre> <p> </p> <p> Basic usage of the native binary parsers for little endian platforms: </p> <p> </p> <pre class="programlisting"><span class="identifier">test_parser_attr</span><span class="special">(</span><span class="string">"\x01"</span><span class="special">,</span> <span class="identifier">byte_</span><span class="special">,</span> <span class="identifier">uc</span><span class="special">);</span> <span class="identifier">assert</span><span class="special">(</span><span class="identifier">uc</span> <span class="special">==</span> <span class="number">0x01</span><span class="special">);</span> <span class="identifier">test_parser_attr</span><span class="special">(</span><span class="string">"\x01\x02"</span><span class="special">,</span> <span class="identifier">word</span><span class="special">,</span> <span class="identifier">us</span><span class="special">);</span> <span class="identifier">assert</span><span class="special">(</span><span class="identifier">us</span> <span class="special">==</span> <span class="number">0x0201</span><span class="special">);</span> <span class="identifier">test_parser_attr</span><span class="special">(</span><span class="string">"\x01\x02\x03\x04"</span><span class="special">,</span> <span class="identifier">dword</span><span class="special">,</span> <span class="identifier">ui</span><span class="special">);</span> <span class="identifier">assert</span><span class="special">(</span><span class="identifier">ui</span> <span class="special">==</span> <span class="number">0x04030201</span><span class="special">);</span> <span class="identifier">test_parser_attr</span><span class="special">(</span><span class="string">"\x01\x02\x03\x04\x05\x06\x07\x08"</span><span class="special">,</span> <span class="identifier">qword</span><span class="special">,</span> <span class="identifier">ul</span><span class="special">);</span> <span class="identifier">assert</span><span class="special">(</span><span class="identifier">ul</span> <span class="special">==</span> <span class="number">0</span><span class="identifier">x0807060504030201LL</span><span class="special">);</span> <span class="identifier">test_parser</span><span class="special">(</span><span class="string">"\x01"</span><span class="special">,</span> <span class="identifier">byte_</span><span class="special">(</span><span class="number">0x01</span><span class="special">));</span> <span class="identifier">test_parser</span><span class="special">(</span><span class="string">"\x01\x02"</span><span class="special">,</span> <span class="identifier">word</span><span class="special">(</span><span class="number">0x0201</span><span class="special">));</span> <span class="identifier">test_parser</span><span class="special">(</span><span class="string">"\x01\x02\x03\x04"</span><span class="special">,</span> <span class="identifier">dword</span><span class="special">(</span><span class="number">0x04030201</span><span class="special">));</span> <span class="identifier">test_parser</span><span class="special">(</span><span class="string">"\x01\x02\x03\x04\x05\x06\x07\x08"</span><span class="special">,</span> <span class="identifier">qword</span><span class="special">(</span><span class="number">0</span><span class="identifier">x0807060504030201LL</span><span class="special">));</span> </pre> <p> </p> <p> Basic usage of the native binary parsers for big endian platforms: </p> <p> </p> <pre class="programlisting"><span class="identifier">test_parser_attr</span><span class="special">(</span><span class="string">"\x01"</span><span class="special">,</span> <span class="identifier">byte_</span><span class="special">,</span> <span class="identifier">uc</span><span class="special">);</span> <span class="identifier">assert</span><span class="special">(</span><span class="identifier">uc</span> <span class="special">==</span> <span class="number">0x01</span><span class="special">);</span> <span class="identifier">test_parser_attr</span><span class="special">(</span><span class="string">"\x01\x02"</span><span class="special">,</span> <span class="identifier">word</span><span class="special">,</span> <span class="identifier">us</span><span class="special">);</span> <span class="identifier">assert</span><span class="special">(</span><span class="identifier">us</span> <span class="special">==</span> <span class="number">0x0102</span><span class="special">);</span> <span class="identifier">test_parser_attr</span><span class="special">(</span><span class="string">"\x01\x02\x03\x04"</span><span class="special">,</span> <span class="identifier">dword</span><span class="special">,</span> <span class="identifier">ui</span><span class="special">);</span> <span class="identifier">assert</span><span class="special">(</span><span class="identifier">ui</span> <span class="special">==</span> <span class="number">0x01020304</span><span class="special">);</span> <span class="identifier">test_parser_attr</span><span class="special">(</span><span class="string">"\x01\x02\x03\x04\x05\x06\x07\x08"</span><span class="special">,</span> <span class="identifier">qword</span><span class="special">,</span> <span class="identifier">ul</span><span class="special">);</span> <span class="identifier">assert</span><span class="special">(</span><span class="number">0</span><span class="identifier">x0102030405060708LL</span><span class="special">);</span> <span class="identifier">test_parser</span><span class="special">(</span><span class="string">"\x01"</span><span class="special">,</span> <span class="identifier">byte_</span><span class="special">(</span><span class="number">0x01</span><span class="special">));</span> <span class="identifier">test_parser</span><span class="special">(</span><span class="string">"\x01\x02"</span><span class="special">,</span> <span class="identifier">word</span><span class="special">(</span><span class="number">0x0102</span><span class="special">));</span> <span class="identifier">test_parser</span><span class="special">(</span><span class="string">"\x01\x02\x03\x04"</span><span class="special">,</span> <span class="identifier">dword</span><span class="special">(</span><span class="number">0x01020304</span><span class="special">));</span> <span class="identifier">test_parser</span><span class="special">(</span><span class="string">"\x01\x02\x03\x04\x05\x06\x07\x08"</span><span class="special">,</span> <span class="identifier">qword</span><span class="special">(</span><span class="number">0</span><span class="identifier">x0102030405060708LL</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="../binary.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../binary.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="binary_little.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html>