3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>Binary Little Endianness Parser</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="../binary.html" title="Binary Parsers">
9 <link rel="prev" href="binary_native.html" title="Binary Native Endianness Parsers">
10 <link rel="next" href="binary_big.html" title="Binary Big Endianness 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="binary_native.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_big.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.binary.binary_little"></a><a class="link" href="binary_little.html" title="Binary Little Endianness Parser">Binary
28 Little Endianness Parser</a>
29 </h5></div></div></div>
31 <a name="spirit.qi.reference.binary.binary_little.h0"></a>
32 <span class="phrase"><a name="spirit.qi.reference.binary.binary_little.description"></a></span><a class="link" href="binary_little.html#spirit.qi.reference.binary.binary_little.description">Description</a>
35 Binary little endian parsers are designed to parse binary byte streams
36 that are laid out in little endian.
39 <a name="spirit.qi.reference.binary.binary_little.h1"></a>
40 <span class="phrase"><a name="spirit.qi.reference.binary.binary_little.header"></a></span><a class="link" href="binary_little.html#spirit.qi.reference.binary.binary_little.header">Header</a>
42 <pre class="programlisting"><span class="comment">// forwards to <boost/spirit/home/qi/binary.hpp></span>
43 <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>
46 Also, see <a class="link" href="../../../structure/include.html" title="Include">Include Structure</a>.
49 <a name="spirit.qi.reference.binary.binary_little.h2"></a>
50 <span class="phrase"><a name="spirit.qi.reference.binary.binary_little.namespace"></a></span><a class="link" href="binary_little.html#spirit.qi.reference.binary.binary_little.namespace">Namespace</a>
52 <div class="informaltable"><table class="table">
53 <colgroup><col></colgroup>
62 <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">little_word</span> <span class="comment">//
63 alias: boost::spirit::qi::little_word</span></code>
68 <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">little_dword</span> <span class="comment">//
69 alias: boost::spirit::qi::little_dword</span></code>
74 <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">little_qword</span> <span class="comment">//
75 alias: boost::spirit::qi::little_qword</span></code>
80 <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">little_bin_float</span> <span class="comment">//
81 alias: boost::spirit::qi::little_bin_float</span></code>
86 <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">little_bin_double</span> <span class="comment">//
87 alias: boost::spirit::qi::little_bin_double</span></code>
92 <div class="note"><table border="0" summary="Note">
94 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../images/note.png"></td>
95 <th align="left">Note</th>
97 <tr><td align="left" valign="top"><p>
98 <code class="computeroutput"><span class="identifier">little_qword</span></code> is only
99 available on platforms where the preprocessor constant <code class="computeroutput"><span class="identifier">BOOST_HAS_LONG_LONG</span></code> is defined (i.e.
100 on platforms having native support for <code class="computeroutput"><span class="keyword">unsigned</span>
101 <span class="keyword">long</span> <span class="keyword">long</span></code>
102 (64 bit) integer types).
106 <a name="spirit.qi.reference.binary.binary_little.h3"></a>
107 <span class="phrase"><a name="spirit.qi.reference.binary.binary_little.model_of"></a></span><a class="link" href="binary_little.html#spirit.qi.reference.binary.binary_little.model_of">Model of</a>
109 <div class="blockquote"><blockquote class="blockquote"><p>
110 <a class="link" href="../parser_concepts/primitiveparser.html" title="PrimitiveParser"><code class="computeroutput"><span class="identifier">PrimitiveParser</span></code></a>
111 </p></blockquote></div>
112 <div class="variablelist">
113 <p class="title"><b>Notation</b></p>
114 <dl class="variablelist">
115 <dt><span class="term"><code class="computeroutput"><span class="identifier">w</span></code></span></dt>
117 A 16 bit binary value or a <a class="link" href="../basics.html#spirit.qi.reference.basics.lazy_argument">Lazy
118 Argument</a> that evaluates to a 16 bit binary value. This value
119 is always in native endian.
121 <dt><span class="term"><code class="computeroutput"><span class="identifier">dw</span></code></span></dt>
123 A 32 bit binary value or a <a class="link" href="../basics.html#spirit.qi.reference.basics.lazy_argument">Lazy
124 Argument</a> that evaluates to a 32 bit binary value. This value
125 is always in native endian.
127 <dt><span class="term"><code class="computeroutput"><span class="identifier">qw</span></code></span></dt>
129 A 64 bit binary value or a <a class="link" href="../basics.html#spirit.qi.reference.basics.lazy_argument">Lazy
130 Argument</a> that evaluates to a 64 bit binary value. This value
131 is always in native endian.
133 <dt><span class="term"><code class="computeroutput"><span class="identifier">f</span></code></span></dt>
135 A float binary value or a <a class="link" href="../basics.html#spirit.qi.reference.basics.lazy_argument">Lazy
136 Argument</a> that evaluates to a float binary value. This value
137 is always in native endian.
139 <dt><span class="term"><code class="computeroutput"><span class="identifier">d</span></code></span></dt>
141 A double binary value or a <a class="link" href="../basics.html#spirit.qi.reference.basics.lazy_argument">Lazy
142 Argument</a> that evaluates to a double binary value. This value
143 is always in native endian.
148 <a name="spirit.qi.reference.binary.binary_little.h4"></a>
149 <span class="phrase"><a name="spirit.qi.reference.binary.binary_little.expression_semantics"></a></span><a class="link" href="binary_little.html#spirit.qi.reference.binary.binary_little.expression_semantics">Expression
153 Semantics of an expression is defined only where it differs from, or
154 is not defined in <a class="link" href="../parser_concepts/primitiveparser.html" title="PrimitiveParser"><code class="computeroutput"><span class="identifier">PrimitiveParser</span></code></a>.
156 <div class="informaltable"><table class="table">
177 <code class="computeroutput"><span class="identifier">little_word</span></code>
182 Matches any 16 bit little endian binary.
189 <code class="computeroutput"><span class="identifier">little_dword</span></code>
194 Matches any 32 bit little endian binary.
201 <code class="computeroutput"><span class="identifier">little_qword</span></code>
206 Matches any 64 bit little endian binary.
213 <code class="computeroutput"><span class="identifier">little_bin_float</span></code>
218 Matches any float little endian binary.
225 <code class="computeroutput"><span class="identifier">little_bin_double</span></code>
230 Matches any double little endian binary.
237 <code class="computeroutput"><span class="identifier">little_word</span><span class="special">(</span><span class="identifier">w</span><span class="special">)</span></code>
242 Matches an exact 16 bit little endian binary.
249 <code class="computeroutput"><span class="identifier">little_dword</span><span class="special">(</span><span class="identifier">dw</span><span class="special">)</span></code>
254 Matches an exact 32 bit little endian binary.
261 <code class="computeroutput"><span class="identifier">little_qword</span><span class="special">(</span><span class="identifier">qw</span><span class="special">)</span></code>
266 Matches an exact 32 bit little endian binary.
273 <code class="computeroutput"><span class="identifier">little_bin_float</span><span class="special">(</span><span class="identifier">f</span><span class="special">)</span></code>
278 Matches an exact float little endian binary.
285 <code class="computeroutput"><span class="identifier">little_bin_double</span><span class="special">(</span><span class="identifier">d</span><span class="special">)</span></code>
290 Matches an exact double little endian binary.
297 <a name="spirit.qi.reference.binary.binary_little.h5"></a>
298 <span class="phrase"><a name="spirit.qi.reference.binary.binary_little.attributes"></a></span><a class="link" href="binary_little.html#spirit.qi.reference.binary.binary_little.attributes">Attributes</a>
300 <div class="informaltable"><table class="table">
321 <code class="computeroutput"><span class="identifier">little_word</span></code>
326 <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint_least16_t</span></code>
333 <code class="computeroutput"><span class="identifier">little_dword</span></code>
338 <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint_least32_t</span></code>
345 <code class="computeroutput"><span class="identifier">little_qword</span></code>
350 <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint_least64_t</span></code>
357 <code class="computeroutput"><span class="identifier">little_bin_float</span></code>
362 <code class="computeroutput"><span class="keyword">float</span></code>
369 <code class="computeroutput"><span class="identifier">little_bin_double</span></code>
374 <code class="computeroutput"><span class="keyword">double</span></code>
381 <code class="computeroutput"><span class="identifier">little_word</span><span class="special">(</span><span class="identifier">w</span><span class="special">)</span></code>
386 <code class="computeroutput"><span class="identifier">unused</span></code>
393 <code class="computeroutput"><span class="identifier">little_dword</span><span class="special">(</span><span class="identifier">dw</span><span class="special">)</span></code>
398 <code class="computeroutput"><span class="identifier">unused</span></code>
405 <code class="computeroutput"><span class="identifier">little_qword</span><span class="special">(</span><span class="identifier">qw</span><span class="special">)</span></code>
410 <code class="computeroutput"><span class="identifier">unused</span></code>
417 <code class="computeroutput"><span class="identifier">little_bin_float</span><span class="special">(</span><span class="identifier">f</span><span class="special">)</span></code>
422 <code class="computeroutput"><span class="identifier">unused</span></code>
429 <code class="computeroutput"><span class="identifier">little_bin_double</span><span class="special">(</span><span class="identifier">d</span><span class="special">)</span></code>
434 <code class="computeroutput"><span class="identifier">unused</span></code>
441 <a name="spirit.qi.reference.binary.binary_little.h6"></a>
442 <span class="phrase"><a name="spirit.qi.reference.binary.binary_little.complexity"></a></span><a class="link" href="binary_little.html#spirit.qi.reference.binary.binary_little.complexity">Complexity</a>
444 <div class="blockquote"><blockquote class="blockquote"><p>
445 O(N), where N is the number of bytes parsed
446 </p></blockquote></div>
448 <a name="spirit.qi.reference.binary.binary_little.h7"></a>
449 <span class="phrase"><a name="spirit.qi.reference.binary.binary_little.example"></a></span><a class="link" href="binary_little.html#spirit.qi.reference.binary.binary_little.example">Example</a>
451 <div class="note"><table border="0" summary="Note">
453 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../images/note.png"></td>
454 <th align="left">Note</th>
456 <tr><td align="left" valign="top"><p>
457 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>
462 Using declarations and variables:
466 <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">little_word</span><span class="special">;</span>
467 <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">little_dword</span><span class="special">;</span>
468 <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">little_qword</span><span class="special">;</span>
470 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint16_t</span> <span class="identifier">us</span><span class="special">;</span>
471 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint32_t</span> <span class="identifier">ui</span><span class="special">;</span>
472 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint64_t</span> <span class="identifier">ul</span><span class="special">;</span>
477 Basic usage of the little endian binary parsers:
481 <pre class="programlisting"><span class="identifier">test_parser_attr</span><span class="special">(</span><span class="string">"\x01\x02"</span><span class="special">,</span> <span class="identifier">little_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>
482 <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">little_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>
483 <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">little_qword</span><span class="special">,</span> <span class="identifier">ul</span><span class="special">);</span>
484 <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>
486 <span class="identifier">test_parser</span><span class="special">(</span><span class="string">"\x01\x02"</span><span class="special">,</span> <span class="identifier">little_word</span><span class="special">(</span><span class="number">0x0201</span><span class="special">));</span>
487 <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">little_dword</span><span class="special">(</span><span class="number">0x04030201</span><span class="special">));</span>
488 <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>
489 <span class="identifier">little_qword</span><span class="special">(</span><span class="number">0</span><span class="identifier">x0807060504030201LL</span><span class="special">));</span>
494 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
495 <td align="left"></td>
496 <td align="right"><div class="copyright-footer">Copyright © 2001-2011 Joel de Guzman, Hartmut Kaiser<p>
497 Distributed under the Boost Software License, Version 1.0. (See accompanying
498 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>)
503 <div class="spirit-nav">
504 <a accesskey="p" href="binary_native.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_big.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>