boostorg/endian
1
0
Fork 1
mirror of https://github.com/boostorg/endian.git synced 2025-07-31 13:07:24 +02:00
Code Issues Packages Projects Releases Wiki Activity

Complete synopsis update.

Browse Source
This commit is contained in:
Beman
2013-05-18 17:10:00 -04:00
parent ac46dae0cc
commit 0eb9d41ab6
1 changed files with 56 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

134
doc/conversion.html
View File

@@ -72,38 +72,56 @@ namespace endian
enum class order {big, little, native};
// reverse byte order (i.e. endianness)
//
inline int16_t reverse_value(int16_t x) noexcept;
inline int32_t reverse_value(int32_t x) noexcept;
inline int64_t reverse_value(int64_t x) noexcept;
inline uint16_t reverse_value(uint16_t x) noexcept;
inline uint32_t reverse_value(uint32_t x) noexcept;
inline uint64_t reverse_value(uint64_t x) noexcept;
inline float reverse_value(float x) noexcept;
inline double reverse_value(double x) noexcept;
int16_t reverse_value(int16_t x) noexcept;
int32_t reverse_value(int32_t x) noexcept;
int64_t reverse_value(int64_t x) noexcept;
uint16_t reverse_value(uint16_t x) noexcept;
uint32_t reverse_value(uint32_t x) noexcept;
uint64_t reverse_value(uint64_t x) noexcept;
float reverse_value(float x) noexcept;
double reverse_value(double x) noexcept;
// reverse bytes unless native endianness is big
//
template <class ReversibleValue >
inline ReversibleValue big_endian_value(ReversibleValue x) noexcept;
void reverse(int16_t& x) noexcept;
void reverse(int32_t& x) noexcept;
void reverse(int64_t& x) noexcept;
void reverse(uint16_t& x) noexcept;
void reverse(uint32_t& x) noexcept;
void reverse(uint64_t& x) noexcept;
void reverse(float& x) noexcept;
void reverse(double& x) noexcept;
// reverse bytes unless native endianness is little
//
// reverse byte order unless native endianness is big
template <class ReversibleValue >
inline ReversibleValue little_endian_value(ReversibleValue x) noexcept;
ReversibleValue big_endian_value(ReversibleValue x) noexcept;
template <class Reversible>
void big_endian(Reversible& x) noexcept;
// reverse byte order unless native endianness is little
template <class ReversibleValue >
ReversibleValue little_endian_value(ReversibleValue x) noexcept;
template <class Reversible>
void little_endian(Reversible& x) noexcept;
// synonyms, based on names popularized by BSD (e.g. OS X, Linux)
// "h" stands for "host" (i.e. native), "be" for "big endian", "le" for "little endian"
//
template <class T> T bswap(T x) {return reverse_value(x);}
template <class T> T htobe(T host) {return big_endian_value(host);}
template <class T> T htole(T host) {return little_endian_value(host);}
template <class T> T betoh(T big) {return big_endian_value(big);}
template <class T> T letoh(T little) {return little_endian_value(little);}
// "h" for "host" (i.e. native), "be" for "big endian",
// "le" for "little endian", "m" for "modify" in place
template <class T> T bswap(T x) noexcept {return reverse_value(x);}
template <class T> T htobe(T host) noexcept {return big_endian_value(host);}
template <class T> T htole(T host) noexcept {return little_endian_value(host);}
template <class T> T betoh(T big) noexcept {return big_endian_value(big);}
template <class T> T letoh(T little) noexcept {return little_endian_value(little);}
template <class T> void bswapm(T& x) noexcept {reverse(x);}
template <class T> void htobem(T& host) noexcept {big_endian(host);}
template <class T> void htole(mT& host noexcept) {little_endian(host);}
template <class T> void betohm(T& big) noexcept {big_endian(big);}
template <class T> void letohm(T& little) noexcept {little_endian(little);}
// compile-time generic byte order conversion
template <order From, order To, class ReversibleValue>
ReversibleValue convert_value(ReversibleValue from) noexcept;
template <order From, order To, class Reversible>
void convert(Reversible& x) noexcept;
// runtime actual byte-order determination
order actual_order(order o) noexcept;
@@ -112,68 +130,28 @@ namespace endian
template <class ReversibleValue>
ReversibleValue convert_value(ReversibleValue from,
order from_order, order to_order) noexcept;
//--------------------------------------------------------------------------------------//
// modify in place interface //
//--------------------------------------------------------------------------------------//
// reverse byte order (i.e. endianness)
//
inline void reverse(int16_t& x) noexcept;
inline void reverse(int32_t& x) noexcept;
inline void reverse(int64_t& x) noexcept;
inline void reverse(uint16_t& x) noexcept;
inline void reverse(uint32_t& x) noexcept;
inline void reverse(uint64_t& x) noexcept;
inline void reverse(float& x) noexcept;
inline void reverse(double& x) noexcept;
// reverse unless native endianness is big
template <class Reversible>
inline void big_endian(Reversible& x) noexcept;
// Effects: none if native endian order is big, otherwise reverse(x)
// reverse unless native endianness is little
template <class Reversible>
inline void little_endian(Reversible& x) noexcept;
// Effects: none if native endian order is little, otherwise reverse(x);
// synonyms based on names popularized by BSD, e.g. OS X, Linux.
// "h" stands for "host" (i.e. native), "be" for "big endian",
// "le" for "little endian", "m" for "modify in place"
template <class T> void mbswap(T& x) {reverse(x);}
template <class T> void mhtobe(T& host_) {big_endian(host_);}
template <class T> void mhtole(T& host_) {little_endian(host_);}
template <class T> void mbetoh(T& big_endian_) {big_endian(big_endian_);}
template <class T> void mletoh(T& little_endian_) {little_endian(little_endian_);}
// compile-time generic byte order conversion
template <BOOST_SCOPED_ENUM(order) From, BOOST_SCOPED_ENUM(order) To, class Reversible>
void convert(Reversible& x) noexcept;
// runtime byte-order conversion
template <class Reversible>
void convert(Reversible& x, BOOST_SCOPED_ENUM(order) from_order,
BOOST_SCOPED_ENUM(order) to_order) noexcept;
template <class Reversible>
void convert(Reversible& x,
order from_order, order to_order) noexcept;
} // namespace endian
} // namespace boost</pre>
<h3 dir="ltr"><a name="Members">Members</a></h3>
<pre dir="ltr">inline void reorder(int16_t&amp; x);
inline void reorder(int32_t&amp; x);
inline void reorder(int64_t&amp; x);
inline void reorder(uint16_t&amp; x);
inline void reorder(uint32_t&amp; x);
inline void reorder(uint64_t&amp; x);</pre>
<pre dir="ltr">void reorder(int16_t&amp; x);
void reorder(int32_t&amp; x);
void reorder(int64_t&amp; x);
void reorder(uint16_t&amp; x);
void reorder(uint32_t&amp; x);
void reorder(uint64_t&amp; 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 reorder(int16_t source, int16_t&amp; target);
inline void reorder(int32_t source, int32_t&amp; target);
inline void reorder(int64_t source, int64_t&amp; target);
inline void reorder(uint16_t source, uint16_t&amp; target);
inline void reorder(uint32_t source, uint32_t&amp; target);
inline void reorder(uint64_t source, uint64_t&amp; target);</pre>
<pre dir="ltr">void reorder(int16_t source, int16_t&amp; target);
void reorder(int32_t source, int32_t&amp; target);
void reorder(int64_t source, int64_t&amp; target);
void reorder(uint16_t source, uint16_t&amp; target);
void reorder(uint32_t source, uint32_t&amp; target);
void reorder(uint64_t source, uint64_t&amp; target);</pre>
<blockquote>
<p dir="ltr"><i>Effects:</i> Copies <code>source</code> to <code>target</code>,
reversing the byte order.</p>