You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

numbers.h 14 kB

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