numbers.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298
  1. // Copyright 2017 The Abseil Authors.
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // https://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. //
  15. // -----------------------------------------------------------------------------
  16. // File: numbers.h
  17. // -----------------------------------------------------------------------------
  18. //
  19. // This package contains functions for converting strings to numbers. For
  20. // converting numbers to strings, use `StrCat()` or `StrAppend()` in str_cat.h,
  21. // which automatically detect and convert most number values appropriately.
  22. #ifndef Y_ABSL_STRINGS_NUMBERS_H_
  23. #define Y_ABSL_STRINGS_NUMBERS_H_
  24. #ifdef __SSSE3__
  25. #include <tmmintrin.h>
  26. #endif
  27. #ifdef _MSC_VER
  28. #include <intrin.h>
  29. #endif
  30. #include <cstddef>
  31. #include <cstdlib>
  32. #include <cstring>
  33. #include <ctime>
  34. #include <limits>
  35. #include <util/generic/string.h>
  36. #include <type_traits>
  37. #include "y_absl/base/config.h"
  38. #include "y_absl/base/internal/endian.h"
  39. #include "y_absl/base/macros.h"
  40. #include "y_absl/base/port.h"
  41. #include "y_absl/numeric/bits.h"
  42. #include "y_absl/numeric/int128.h"
  43. #include "y_absl/strings/string_view.h"
  44. namespace y_absl {
  45. Y_ABSL_NAMESPACE_BEGIN
  46. // SimpleAtoi()
  47. //
  48. // Converts the given string (optionally followed or preceded by ASCII
  49. // whitespace) into an integer value, returning `true` if successful. The string
  50. // must reflect a base-10 integer whose value falls within the range of the
  51. // integer type (optionally preceded by a `+` or `-`). If any errors are
  52. // encountered, this function returns `false`, leaving `out` in an unspecified
  53. // state.
  54. template <typename int_type>
  55. Y_ABSL_MUST_USE_RESULT bool SimpleAtoi(y_absl::string_view str, int_type* out);
  56. // SimpleAtof()
  57. //
  58. // Converts the given string (optionally followed or preceded by ASCII
  59. // whitespace) into a float, which may be rounded on overflow or underflow,
  60. // returning `true` if successful.
  61. // See https://en.cppreference.com/w/c/string/byte/strtof for details about the
  62. // allowed formats for `str`, except SimpleAtof() is locale-independent and will
  63. // always use the "C" locale. If any errors are encountered, this function
  64. // returns `false`, leaving `out` in an unspecified state.
  65. Y_ABSL_MUST_USE_RESULT bool SimpleAtof(y_absl::string_view str, float* out);
  66. // SimpleAtod()
  67. //
  68. // Converts the given string (optionally followed or preceded by ASCII
  69. // whitespace) into a double, which may be rounded on overflow or underflow,
  70. // returning `true` if successful.
  71. // See https://en.cppreference.com/w/c/string/byte/strtof for details about the
  72. // allowed formats for `str`, except SimpleAtod is locale-independent and will
  73. // always use the "C" locale. If any errors are encountered, this function
  74. // returns `false`, leaving `out` in an unspecified state.
  75. Y_ABSL_MUST_USE_RESULT bool SimpleAtod(y_absl::string_view str, double* out);
  76. // SimpleAtob()
  77. //
  78. // Converts the given string into a boolean, returning `true` if successful.
  79. // The following case-insensitive strings are interpreted as boolean `true`:
  80. // "true", "t", "yes", "y", "1". The following case-insensitive strings
  81. // are interpreted as boolean `false`: "false", "f", "no", "n", "0". If any
  82. // errors are encountered, this function returns `false`, leaving `out` in an
  83. // unspecified state.
  84. Y_ABSL_MUST_USE_RESULT bool SimpleAtob(y_absl::string_view str, bool* out);
  85. // SimpleHexAtoi()
  86. //
  87. // Converts a hexadecimal string (optionally followed or preceded by ASCII
  88. // whitespace) to an integer, returning `true` if successful. Only valid base-16
  89. // hexadecimal integers whose value falls within the range of the integer type
  90. // (optionally preceded by a `+` or `-`) can be converted. A valid hexadecimal
  91. // value may include both upper and lowercase character symbols, and may
  92. // optionally include a leading "0x" (or "0X") number prefix, which is ignored
  93. // by this function. If any errors are encountered, this function returns
  94. // `false`, leaving `out` in an unspecified state.
  95. template <typename int_type>
  96. Y_ABSL_MUST_USE_RESULT bool SimpleHexAtoi(y_absl::string_view str, int_type* out);
  97. // Overloads of SimpleHexAtoi() for 128 bit integers.
  98. Y_ABSL_MUST_USE_RESULT inline bool SimpleHexAtoi(y_absl::string_view str,
  99. y_absl::int128* out);
  100. Y_ABSL_MUST_USE_RESULT inline bool SimpleHexAtoi(y_absl::string_view str,
  101. y_absl::uint128* out);
  102. Y_ABSL_NAMESPACE_END
  103. } // namespace y_absl
  104. // End of public API. Implementation details follow.
  105. namespace y_absl {
  106. Y_ABSL_NAMESPACE_BEGIN
  107. namespace numbers_internal {
  108. // Digit conversion.
  109. Y_ABSL_DLL extern const char kHexChar[17]; // 0123456789abcdef
  110. Y_ABSL_DLL extern const char
  111. kHexTable[513]; // 000102030405060708090a0b0c0d0e0f1011...
  112. // Writes a two-character representation of 'i' to 'buf'. 'i' must be in the
  113. // range 0 <= i < 100, and buf must have space for two characters. Example:
  114. // char buf[2];
  115. // PutTwoDigits(42, buf);
  116. // // buf[0] == '4'
  117. // // buf[1] == '2'
  118. void PutTwoDigits(uint32_t i, char* buf);
  119. // safe_strto?() functions for implementing SimpleAtoi()
  120. bool safe_strto32_base(y_absl::string_view text, int32_t* value, int base);
  121. bool safe_strto64_base(y_absl::string_view text, int64_t* value, int base);
  122. bool safe_strto128_base(y_absl::string_view text, y_absl::int128* value,
  123. int base);
  124. bool safe_strtou32_base(y_absl::string_view text, uint32_t* value, int base);
  125. bool safe_strtou64_base(y_absl::string_view text, uint64_t* value, int base);
  126. bool safe_strtou128_base(y_absl::string_view text, y_absl::uint128* value,
  127. int base);
  128. static const int kFastToBufferSize = 32;
  129. static const int kSixDigitsToBufferSize = 16;
  130. // Helper function for fast formatting of floating-point values.
  131. // The result is the same as printf's "%g", a.k.a. "%.6g"; that is, six
  132. // significant digits are returned, trailing zeros are removed, and numbers
  133. // outside the range 0.0001-999999 are output using scientific notation
  134. // (1.23456e+06). This routine is heavily optimized.
  135. // Required buffer size is `kSixDigitsToBufferSize`.
  136. size_t SixDigitsToBuffer(double d, char* buffer);
  137. // These functions are intended for speed. All functions take an output buffer
  138. // as an argument and return a pointer to the last byte they wrote, which is the
  139. // terminating '\0'. At most `kFastToBufferSize` bytes are written.
  140. char* FastIntToBuffer(int32_t, char*);
  141. char* FastIntToBuffer(uint32_t, char*);
  142. char* FastIntToBuffer(int64_t, char*);
  143. char* FastIntToBuffer(uint64_t, char*);
  144. // For enums and integer types that are not an exact match for the types above,
  145. // use templates to call the appropriate one of the four overloads above.
  146. template <typename int_type>
  147. char* FastIntToBuffer(int_type i, char* buffer) {
  148. static_assert(sizeof(i) <= 64 / 8,
  149. "FastIntToBuffer works only with 64-bit-or-less integers.");
  150. // TODO(jorg): This signed-ness check is used because it works correctly
  151. // with enums, and it also serves to check that int_type is not a pointer.
  152. // If one day something like std::is_signed<enum E> works, switch to it.
  153. // These conditions are constexpr bools to suppress MSVC warning C4127.
  154. constexpr bool kIsSigned = static_cast<int_type>(1) - 2 < 0;
  155. constexpr bool kUse64Bit = sizeof(i) > 32 / 8;
  156. if (kIsSigned) {
  157. if (kUse64Bit) {
  158. return FastIntToBuffer(static_cast<int64_t>(i), buffer);
  159. } else {
  160. return FastIntToBuffer(static_cast<int32_t>(i), buffer);
  161. }
  162. } else {
  163. if (kUse64Bit) {
  164. return FastIntToBuffer(static_cast<uint64_t>(i), buffer);
  165. } else {
  166. return FastIntToBuffer(static_cast<uint32_t>(i), buffer);
  167. }
  168. }
  169. }
  170. // Implementation of SimpleAtoi, generalized to support arbitrary base (used
  171. // with base different from 10 elsewhere in Abseil implementation).
  172. template <typename int_type>
  173. Y_ABSL_MUST_USE_RESULT bool safe_strtoi_base(y_absl::string_view s, int_type* out,
  174. int base) {
  175. static_assert(sizeof(*out) == 4 || sizeof(*out) == 8,
  176. "SimpleAtoi works only with 32-bit or 64-bit integers.");
  177. static_assert(!std::is_floating_point<int_type>::value,
  178. "Use SimpleAtof or SimpleAtod instead.");
  179. bool parsed;
  180. // TODO(jorg): This signed-ness check is used because it works correctly
  181. // with enums, and it also serves to check that int_type is not a pointer.
  182. // If one day something like std::is_signed<enum E> works, switch to it.
  183. // These conditions are constexpr bools to suppress MSVC warning C4127.
  184. constexpr bool kIsSigned = static_cast<int_type>(1) - 2 < 0;
  185. constexpr bool kUse64Bit = sizeof(*out) == 64 / 8;
  186. if (kIsSigned) {
  187. if (kUse64Bit) {
  188. int64_t val;
  189. parsed = numbers_internal::safe_strto64_base(s, &val, base);
  190. *out = static_cast<int_type>(val);
  191. } else {
  192. int32_t val;
  193. parsed = numbers_internal::safe_strto32_base(s, &val, base);
  194. *out = static_cast<int_type>(val);
  195. }
  196. } else {
  197. if (kUse64Bit) {
  198. uint64_t val;
  199. parsed = numbers_internal::safe_strtou64_base(s, &val, base);
  200. *out = static_cast<int_type>(val);
  201. } else {
  202. uint32_t val;
  203. parsed = numbers_internal::safe_strtou32_base(s, &val, base);
  204. *out = static_cast<int_type>(val);
  205. }
  206. }
  207. return parsed;
  208. }
  209. // FastHexToBufferZeroPad16()
  210. //
  211. // Outputs `val` into `out` as if by `snprintf(out, 17, "%016x", val)` but
  212. // without the terminating null character. Thus `out` must be of length >= 16.
  213. // Returns the number of non-pad digits of the output (it can never be zero
  214. // since 0 has one digit).
  215. inline size_t FastHexToBufferZeroPad16(uint64_t val, char* out) {
  216. #ifdef Y_ABSL_INTERNAL_HAVE_SSSE3
  217. uint64_t be = y_absl::big_endian::FromHost64(val);
  218. const auto kNibbleMask = _mm_set1_epi8(0xf);
  219. const auto kHexDigits = _mm_setr_epi8('0', '1', '2', '3', '4', '5', '6', '7',
  220. '8', '9', 'a', 'b', 'c', 'd', 'e', 'f');
  221. auto v = _mm_loadl_epi64(reinterpret_cast<__m128i*>(&be)); // load lo dword
  222. auto v4 = _mm_srli_epi64(v, 4); // shift 4 right
  223. auto il = _mm_unpacklo_epi8(v4, v); // interleave bytes
  224. auto m = _mm_and_si128(il, kNibbleMask); // mask out nibbles
  225. auto hexchars = _mm_shuffle_epi8(kHexDigits, m); // hex chars
  226. _mm_storeu_si128(reinterpret_cast<__m128i*>(out), hexchars);
  227. #else
  228. for (int i = 0; i < 8; ++i) {
  229. auto byte = (val >> (56 - 8 * i)) & 0xFF;
  230. auto* hex = &y_absl::numbers_internal::kHexTable[byte * 2];
  231. std::memcpy(out + 2 * i, hex, 2);
  232. }
  233. #endif
  234. // | 0x1 so that even 0 has 1 digit.
  235. return 16 - static_cast<size_t>(countl_zero(val | 0x1) / 4);
  236. }
  237. } // namespace numbers_internal
  238. template <typename int_type>
  239. Y_ABSL_MUST_USE_RESULT bool SimpleAtoi(y_absl::string_view str, int_type* out) {
  240. return numbers_internal::safe_strtoi_base(str, out, 10);
  241. }
  242. Y_ABSL_MUST_USE_RESULT inline bool SimpleAtoi(y_absl::string_view str,
  243. y_absl::int128* out) {
  244. return numbers_internal::safe_strto128_base(str, out, 10);
  245. }
  246. Y_ABSL_MUST_USE_RESULT inline bool SimpleAtoi(y_absl::string_view str,
  247. y_absl::uint128* out) {
  248. return numbers_internal::safe_strtou128_base(str, out, 10);
  249. }
  250. template <typename int_type>
  251. Y_ABSL_MUST_USE_RESULT bool SimpleHexAtoi(y_absl::string_view str, int_type* out) {
  252. return numbers_internal::safe_strtoi_base(str, out, 16);
  253. }
  254. Y_ABSL_MUST_USE_RESULT inline bool SimpleHexAtoi(y_absl::string_view str,
  255. y_absl::int128* out) {
  256. return numbers_internal::safe_strto128_base(str, out, 16);
  257. }
  258. Y_ABSL_MUST_USE_RESULT inline bool SimpleHexAtoi(y_absl::string_view str,
  259. y_absl::uint128* out) {
  260. return numbers_internal::safe_strtou128_base(str, out, 16);
  261. }
  262. Y_ABSL_NAMESPACE_END
  263. } // namespace y_absl
  264. #endif // Y_ABSL_STRINGS_NUMBERS_H_