forked from boostorg/endian
bemandawes
a114dd72b5
git-svn-id: http://svn.boost.org/svn/boost/sandbox/endian@74214 b8fc166d-592f-0410-95f2-cb63ce0dd405
134 lines
5.6 KiB
HTML
134 lines
5.6 KiB
HTML
<html xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns="http://www.w3.org/TR/REC-html40">
|
|
|
|
<head>
|
|
<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
|
|
<meta name="ProgId" content="FrontPage.Editor.Document">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
|
|
|
|
<title>Boost Endian Conversion Functions</title>
|
|
<link rel="stylesheet" type="text/css" href="../../../doc/src/minimal.css">
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="933">
|
|
<tr>
|
|
<td width="277">
|
|
<a href="../../../index.html">
|
|
<img src="../../../boost.png" alt="boost.png (6897 bytes)" align="middle" width="277" height="86" border="0"></a></td>
|
|
<td width="636" align="middle">
|
|
<font size="7">Endian Conversion Functions</font></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" bgcolor="#D7EEFF" width="100%">
|
|
<tr>
|
|
<td><a href="../../../index.htm">Boost Home</a>
|
|
<a href="index.html">Endian Home</a>
|
|
<a href="conversion.html">Conversion Reference</a>
|
|
<a href="types.html">Types Reference</a> Tutorial</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2><a name="Introduction">Introduction</a></h2>
|
|
|
|
<p>Header <a href="../../../boost/endian/conversion.hpp">boost/endian/conversion.hpp</a>
|
|
provides functions that convert built-in
|
|
integers from the native byte ordering to or from big or little endian byte
|
|
ordering.</p>
|
|
|
|
<h2><a name="Reference">Reference</a></h2>
|
|
|
|
<h3>
|
|
<a name="Synopsis">Synopsis</a></h3>
|
|
|
|
<pre>namespace boost
|
|
{
|
|
namespace endian
|
|
{
|
|
// invert: <span class="f">verb: p</span>ut upside down or in the opposite position, order, or arrangement.
|
|
|
|
// unconditional modifying (i.e. in-place) endianness reversal
|
|
|
|
inline void invert(int16_t& x);
|
|
inline void invert(int32_t& x);
|
|
inline void invert(int64_t& x);
|
|
inline void invert(uint16_t& x);
|
|
inline void invert(uint32_t& x);
|
|
inline void invert(uint64_t& x);
|
|
|
|
// unconditional non-modifying endianness reversing copy
|
|
|
|
inline void invert(int16_t source, int16_t& target);
|
|
inline void invert(int32_t source, int32_t& target);
|
|
inline void invert(int64_t source, int64_t& target);
|
|
inline void invert(uint16_t source, uint16_t& target);
|
|
inline void invert(uint32_t source, uint32_t& target);
|
|
inline void invert(uint64_t source, uint64_t& target);
|
|
|
|
// conditional modifying (i.e. in-place) endianness reversal
|
|
|
|
template <class T> void native_to_big(T& x);
|
|
template <class T> void native_to_little(T& x);
|
|
template <class T> void big_to_native(T& x);
|
|
template <class T> void little_to_native(T& x);
|
|
|
|
// non-modifying copy conditionally reversing endianness;
|
|
|
|
template <class T> void native_to_big(T source, T& target);
|
|
template <class T> void native_to_little(T source, T& target);
|
|
template <class T> void big_to_native(T source, T& target);
|
|
template <class T> void little_to_native(T source, T& target);
|
|
|
|
} // namespace endian
|
|
} // namespace boost</pre>
|
|
<h3 dir="ltr">Members</h3>
|
|
<pre dir="ltr">inline void invert(int16_t& x);
|
|
inline void invert(int32_t& x);
|
|
inline void invert(int64_t& x);
|
|
inline void invert(uint16_t& x);
|
|
inline void invert(uint32_t& x);
|
|
inline void invert(uint64_t& x);</pre>
|
|
<blockquote>
|
|
<p dir="ltr"><i>Effects:</i> Reverses the byte order of <i><code>x</code></i>.</p>
|
|
</blockquote>
|
|
<pre dir="ltr">inline void invert(int16_t source, int16_t& target);
|
|
inline void invert(int32_t source, int32_t& target);
|
|
inline void invert(int64_t source, int64_t& target);
|
|
inline void invert(uint16_t source, uint16_t& target);
|
|
inline void invert(uint32_t source, uint32_t& target);
|
|
inline void invert(uint64_t source, uint64_t& target);</pre>
|
|
<blockquote>
|
|
<p dir="ltr"><i>Effects:</i> Copies <code>source</code> to <code>target</code>,
|
|
reversing the byte order.</p>
|
|
</blockquote>
|
|
<pre dir="ltr">template <class T> void native_to_big(T& x);
|
|
template <class T> void native_to_little(T& x);
|
|
template <class T> void big_to_native(T& x);
|
|
template <class T> void little_to_native(T& x);</pre>
|
|
<blockquote>
|
|
<p dir="ltr"><i>Effects:</i> If the native byte ordering and indicated byte
|
|
ordering are different, <code>invert(x)</code>, otherwise no effect.</p>
|
|
</blockquote>
|
|
<pre dir="ltr">template <class T> void native_to_big(T source, T& target);
|
|
template <class T> void native_to_little(T source, T& target);
|
|
template <class T> void big_to_native(T source, T& target);
|
|
template <class T> void little_to_native(T source, T& target);</pre>
|
|
<blockquote>
|
|
<p dir="ltr"><i>Effects:</i> If the native byte ordering and indicated byte
|
|
ordering are different, <code>invert(source, target)</code>, otherwise <code>
|
|
target = source</code>.</p>
|
|
</blockquote>
|
|
<h2><a name="Acknowledgements">Acknowledgements</a></h2>
|
|
<p>Tomas Puverle was instrumental in identifying and articulating the need to
|
|
support endian conversion as separate from endian types.</p>
|
|
<hr>
|
|
<p>Last revised:
|
|
<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->03 September, 2011<!--webbot bot="Timestamp" endspan i-checksum="39334" --></p>
|
|
<p>© Copyright Beman Dawes, 2011</p>
|
|
<p>Distributed under the Boost Software License, Version 1.0. See
|
|
<a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/ LICENSE_1_0.txt</a></p>
|
|
|
|
</body>
|
|
|
|
</html> |