arithmetic.hpp 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370
  1. // boost/endian/arithmetic.hpp -------------------------------------------------------//
  2. // (C) Copyright Darin Adler 2000
  3. // (C) Copyright Beman Dawes 2006, 2009, 2014
  4. // (C) Copyright Peter Dimov 2019
  5. // Distributed under the Boost Software License, Version 1.0.
  6. // See http://www.boost.org/LICENSE_1_0.txt
  7. // See library home page at http://www.boost.org/libs/endian
  8. //--------------------------------------------------------------------------------------//
  9. // Original design developed by Darin Adler based on classes developed by Mark
  10. // Borgerding. Four original class templates were combined into a single endian
  11. // class template by Beman Dawes, who also added the unrolled_byte_loops sign
  12. // partial specialization to correctly extend the sign when cover integer size
  13. // differs from endian representation size.
  14. // TODO: When a compiler supporting constexpr becomes available, try possible uses.
  15. #ifndef BOOST_ENDIAN_ARITHMETIC_HPP
  16. #define BOOST_ENDIAN_ARITHMETIC_HPP
  17. #if defined(_MSC_VER)
  18. # pragma warning(push)
  19. # pragma warning(disable:4365) // conversion ... signed/unsigned mismatch
  20. #endif
  21. #include <boost/endian/buffers.hpp>
  22. #include <boost/core/scoped_enum.hpp>
  23. #include <boost/static_assert.hpp>
  24. #include <boost/cstdint.hpp>
  25. #include <boost/config.hpp>
  26. #include <boost/config/workaround.hpp>
  27. #include <iosfwd>
  28. #include <climits>
  29. #if defined(BOOST_BORLANDC) || defined(BOOST_CODEGEARC)
  30. # pragma pack(push, 1)
  31. #endif
  32. # if CHAR_BIT != 8
  33. # error Platforms with CHAR_BIT != 8 are not supported
  34. # endif
  35. # ifdef BOOST_NO_CXX11_DEFAULTED_FUNCTIONS
  36. # define BOOST_ENDIAN_DEFAULT_CONSTRUCT {} // C++03
  37. # else
  38. # define BOOST_ENDIAN_DEFAULT_CONSTRUCT = default; // C++0x
  39. # endif
  40. // g++ pre-4.6 does not support unrestricted unions, but we have no Config macro for that
  41. # if (defined(BOOST_NO_CXX11_DEFAULTED_FUNCTIONS) || BOOST_WORKAROUND(BOOST_GCC, < 40600)) && defined(BOOST_ENDIAN_FORCE_PODNESS)
  42. # define BOOST_ENDIAN_NO_CTORS
  43. # endif
  44. # ifndef BOOST_ENDIAN_EXPLICIT_CTORS
  45. # define BOOST_ENDIAN_EXPLICIT_OPT
  46. # else
  47. # define BOOST_ENDIAN_EXPLICIT_OPT explicit
  48. # endif
  49. //---------------------------------- synopsis ----------------------------------------//
  50. namespace boost
  51. {
  52. namespace endian
  53. {
  54. template <BOOST_SCOPED_ENUM(order) Order, class T, std::size_t n_bits,
  55. BOOST_SCOPED_ENUM(align) Align = align::no>
  56. class endian_arithmetic;
  57. // big endian signed integer aligned types
  58. typedef endian_arithmetic<order::big, int8_t, 8, align::yes> big_int8_at;
  59. typedef endian_arithmetic<order::big, int16_t, 16, align::yes> big_int16_at;
  60. typedef endian_arithmetic<order::big, int32_t, 32, align::yes> big_int32_at;
  61. typedef endian_arithmetic<order::big, int64_t, 64, align::yes> big_int64_at;
  62. // big endian unsigned integer aligned types
  63. typedef endian_arithmetic<order::big, uint8_t, 8, align::yes> big_uint8_at;
  64. typedef endian_arithmetic<order::big, uint16_t, 16, align::yes> big_uint16_at;
  65. typedef endian_arithmetic<order::big, uint32_t, 32, align::yes> big_uint32_at;
  66. typedef endian_arithmetic<order::big, uint64_t, 64, align::yes> big_uint64_at;
  67. // little endian signed integer aligned types
  68. typedef endian_arithmetic<order::little, int8_t, 8, align::yes> little_int8_at;
  69. typedef endian_arithmetic<order::little, int16_t, 16, align::yes> little_int16_at;
  70. typedef endian_arithmetic<order::little, int32_t, 32, align::yes> little_int32_at;
  71. typedef endian_arithmetic<order::little, int64_t, 64, align::yes> little_int64_at;
  72. // little endian unsigned integer aligned types
  73. typedef endian_arithmetic<order::little, uint8_t, 8, align::yes> little_uint8_at;
  74. typedef endian_arithmetic<order::little, uint16_t, 16, align::yes> little_uint16_at;
  75. typedef endian_arithmetic<order::little, uint32_t, 32, align::yes> little_uint32_at;
  76. typedef endian_arithmetic<order::little, uint64_t, 64, align::yes> little_uint64_at;
  77. // aligned floating point types
  78. typedef endian_arithmetic<order::big, float, 32, align::yes> big_float32_at;
  79. typedef endian_arithmetic<order::big, double, 64, align::yes> big_float64_at;
  80. typedef endian_arithmetic<order::little, float, 32, align::yes> little_float32_at;
  81. typedef endian_arithmetic<order::little, double, 64, align::yes> little_float64_at;
  82. // aligned native endian typedefs are not provided because
  83. // <cstdint> types are superior for this use case
  84. // big endian signed integer unaligned types
  85. typedef endian_arithmetic<order::big, int_least8_t, 8> big_int8_t;
  86. typedef endian_arithmetic<order::big, int_least16_t, 16> big_int16_t;
  87. typedef endian_arithmetic<order::big, int_least32_t, 24> big_int24_t;
  88. typedef endian_arithmetic<order::big, int_least32_t, 32> big_int32_t;
  89. typedef endian_arithmetic<order::big, int_least64_t, 40> big_int40_t;
  90. typedef endian_arithmetic<order::big, int_least64_t, 48> big_int48_t;
  91. typedef endian_arithmetic<order::big, int_least64_t, 56> big_int56_t;
  92. typedef endian_arithmetic<order::big, int_least64_t, 64> big_int64_t;
  93. // big endian unsigned integer unaligned types
  94. typedef endian_arithmetic<order::big, uint_least8_t, 8> big_uint8_t;
  95. typedef endian_arithmetic<order::big, uint_least16_t, 16> big_uint16_t;
  96. typedef endian_arithmetic<order::big, uint_least32_t, 24> big_uint24_t;
  97. typedef endian_arithmetic<order::big, uint_least32_t, 32> big_uint32_t;
  98. typedef endian_arithmetic<order::big, uint_least64_t, 40> big_uint40_t;
  99. typedef endian_arithmetic<order::big, uint_least64_t, 48> big_uint48_t;
  100. typedef endian_arithmetic<order::big, uint_least64_t, 56> big_uint56_t;
  101. typedef endian_arithmetic<order::big, uint_least64_t, 64> big_uint64_t;
  102. // little endian signed integer unaligned types
  103. typedef endian_arithmetic<order::little, int_least8_t, 8> little_int8_t;
  104. typedef endian_arithmetic<order::little, int_least16_t, 16> little_int16_t;
  105. typedef endian_arithmetic<order::little, int_least32_t, 24> little_int24_t;
  106. typedef endian_arithmetic<order::little, int_least32_t, 32> little_int32_t;
  107. typedef endian_arithmetic<order::little, int_least64_t, 40> little_int40_t;
  108. typedef endian_arithmetic<order::little, int_least64_t, 48> little_int48_t;
  109. typedef endian_arithmetic<order::little, int_least64_t, 56> little_int56_t;
  110. typedef endian_arithmetic<order::little, int_least64_t, 64> little_int64_t;
  111. // little endian unsigned integer unaligned types
  112. typedef endian_arithmetic<order::little, uint_least8_t, 8> little_uint8_t;
  113. typedef endian_arithmetic<order::little, uint_least16_t, 16> little_uint16_t;
  114. typedef endian_arithmetic<order::little, uint_least32_t, 24> little_uint24_t;
  115. typedef endian_arithmetic<order::little, uint_least32_t, 32> little_uint32_t;
  116. typedef endian_arithmetic<order::little, uint_least64_t, 40> little_uint40_t;
  117. typedef endian_arithmetic<order::little, uint_least64_t, 48> little_uint48_t;
  118. typedef endian_arithmetic<order::little, uint_least64_t, 56> little_uint56_t;
  119. typedef endian_arithmetic<order::little, uint_least64_t, 64> little_uint64_t;
  120. // native endian signed integer unaligned types
  121. typedef endian_arithmetic<order::native, int_least8_t, 8> native_int8_t;
  122. typedef endian_arithmetic<order::native, int_least16_t, 16> native_int16_t;
  123. typedef endian_arithmetic<order::native, int_least32_t, 24> native_int24_t;
  124. typedef endian_arithmetic<order::native, int_least32_t, 32> native_int32_t;
  125. typedef endian_arithmetic<order::native, int_least64_t, 40> native_int40_t;
  126. typedef endian_arithmetic<order::native, int_least64_t, 48> native_int48_t;
  127. typedef endian_arithmetic<order::native, int_least64_t, 56> native_int56_t;
  128. typedef endian_arithmetic<order::native, int_least64_t, 64> native_int64_t;
  129. // native endian unsigned integer unaligned types
  130. typedef endian_arithmetic<order::native, uint_least8_t, 8> native_uint8_t;
  131. typedef endian_arithmetic<order::native, uint_least16_t, 16> native_uint16_t;
  132. typedef endian_arithmetic<order::native, uint_least32_t, 24> native_uint24_t;
  133. typedef endian_arithmetic<order::native, uint_least32_t, 32> native_uint32_t;
  134. typedef endian_arithmetic<order::native, uint_least64_t, 40> native_uint40_t;
  135. typedef endian_arithmetic<order::native, uint_least64_t, 48> native_uint48_t;
  136. typedef endian_arithmetic<order::native, uint_least64_t, 56> native_uint56_t;
  137. typedef endian_arithmetic<order::native, uint_least64_t, 64> native_uint64_t;
  138. // unaligned floating point types
  139. typedef endian_arithmetic<order::big, float, 32, align::no> big_float32_t;
  140. typedef endian_arithmetic<order::big, double, 64, align::no> big_float64_t;
  141. typedef endian_arithmetic<order::little, float, 32, align::no> little_float32_t;
  142. typedef endian_arithmetic<order::little, double, 64, align::no> little_float64_t;
  143. typedef endian_arithmetic<order::native, float, 32, align::no> native_float32_t;
  144. typedef endian_arithmetic<order::native, double, 64, align::no> native_float64_t;
  145. //---------------------------------- end synopsis ------------------------------------//
  146. template <BOOST_SCOPED_ENUM(order) Order, class T, std::size_t n_bits,
  147. BOOST_SCOPED_ENUM(align) Align>
  148. class endian_arithmetic
  149. {
  150. private:
  151. typedef endian_buffer<Order, T, n_bits, Align> buffer_type;
  152. #ifdef BOOST_ENDIAN_NO_CTORS
  153. public:
  154. #else
  155. private:
  156. #endif
  157. buffer_type buf_;
  158. public:
  159. typedef T value_type;
  160. #ifndef BOOST_ENDIAN_NO_CTORS
  161. endian_arithmetic() BOOST_ENDIAN_DEFAULT_CONSTRUCT
  162. BOOST_ENDIAN_EXPLICIT_OPT endian_arithmetic( T val ) BOOST_NOEXCEPT: buf_( val )
  163. {
  164. }
  165. #endif
  166. endian_arithmetic& operator=( T val ) BOOST_NOEXCEPT
  167. {
  168. buf_ = val;
  169. return *this;
  170. }
  171. value_type value() const BOOST_NOEXCEPT
  172. {
  173. return buf_.value();
  174. }
  175. unsigned char const * data() const BOOST_NOEXCEPT
  176. {
  177. return buf_.data();
  178. }
  179. unsigned char * data() BOOST_NOEXCEPT
  180. {
  181. return buf_.data();
  182. }
  183. operator value_type() const BOOST_NOEXCEPT
  184. {
  185. return this->value();
  186. }
  187. operator buffer_type& () BOOST_NOEXCEPT
  188. {
  189. return buf_;
  190. }
  191. operator buffer_type const& () BOOST_NOEXCEPT
  192. {
  193. return buf_;
  194. }
  195. // operators
  196. T operator+() const BOOST_NOEXCEPT
  197. {
  198. return this->value();
  199. }
  200. endian_arithmetic& operator+=( T y ) BOOST_NOEXCEPT
  201. {
  202. *this = static_cast<T>( this->value() + y );
  203. return *this;
  204. }
  205. endian_arithmetic& operator-=( T y ) BOOST_NOEXCEPT
  206. {
  207. *this = static_cast<T>( this->value() - y );
  208. return *this;
  209. }
  210. endian_arithmetic& operator*=( T y ) BOOST_NOEXCEPT
  211. {
  212. *this = static_cast<T>( this->value() * y );
  213. return *this;
  214. }
  215. endian_arithmetic& operator/=( T y ) BOOST_NOEXCEPT
  216. {
  217. *this = static_cast<T>( this->value() / y );
  218. return *this;
  219. }
  220. endian_arithmetic& operator%=( T y ) BOOST_NOEXCEPT
  221. {
  222. *this = static_cast<T>( this->value() % y );
  223. return *this;
  224. }
  225. endian_arithmetic& operator&=( T y ) BOOST_NOEXCEPT
  226. {
  227. *this = static_cast<T>( this->value() & y );
  228. return *this;
  229. }
  230. endian_arithmetic& operator|=( T y ) BOOST_NOEXCEPT
  231. {
  232. *this = static_cast<T>( this->value() | y );
  233. return *this;
  234. }
  235. endian_arithmetic& operator^=( T y ) BOOST_NOEXCEPT
  236. {
  237. *this = static_cast<T>( this->value() ^ y );
  238. return *this;
  239. }
  240. endian_arithmetic& operator<<=( T y ) BOOST_NOEXCEPT
  241. {
  242. *this = static_cast<T>( this->value() << y );
  243. return *this;
  244. }
  245. endian_arithmetic& operator>>=( T y ) BOOST_NOEXCEPT
  246. {
  247. *this = static_cast<T>( this->value() >> y );
  248. return *this;
  249. }
  250. endian_arithmetic& operator++() BOOST_NOEXCEPT
  251. {
  252. *this += 1;
  253. return *this;
  254. }
  255. endian_arithmetic& operator--() BOOST_NOEXCEPT
  256. {
  257. *this -= 1;
  258. return *this;
  259. }
  260. endian_arithmetic operator++(int) BOOST_NOEXCEPT
  261. {
  262. endian_arithmetic tmp( *this );
  263. *this += 1;
  264. return tmp;
  265. }
  266. endian_arithmetic operator--(int) BOOST_NOEXCEPT
  267. {
  268. endian_arithmetic tmp( *this );
  269. *this -= 1;
  270. return tmp;
  271. }
  272. template<class Ch, class Tr>
  273. friend std::basic_ostream<Ch, Tr>&
  274. operator<<( std::basic_ostream<Ch, Tr>& os, endian_arithmetic const& x )
  275. {
  276. return os << x.value();
  277. }
  278. template<class Ch, class Tr>
  279. friend std::basic_istream<Ch, Tr>&
  280. operator>>( std::basic_istream<Ch, Tr>& is, endian_arithmetic& x )
  281. {
  282. T i;
  283. if( is >> i )
  284. {
  285. x = i;
  286. }
  287. return is;
  288. }
  289. };
  290. } // namespace endian
  291. } // namespace boost
  292. #if defined(BOOST_BORLANDC) || defined(BOOST_CODEGEARC)
  293. # pragma pack(pop)
  294. #endif
  295. #if defined(_MSC_VER)
  296. # pragma warning(pop)
  297. #endif
  298. #endif // BOOST_ENDIAN_ARITHMETIC_HPP