catch_tostring.cpp 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254
  1. // Copyright Catch2 Authors
  2. // Distributed under the Boost Software License, Version 1.0.
  3. // (See accompanying file LICENSE_1_0.txt or copy at
  4. // https://www.boost.org/LICENSE_1_0.txt)
  5. // SPDX-License-Identifier: BSL-1.0
  6. #include <catch2/catch_tostring.hpp>
  7. #include <catch2/interfaces/catch_interfaces_config.hpp>
  8. #include <catch2/internal/catch_context.hpp>
  9. #include <catch2/internal/catch_polyfills.hpp>
  10. #include <cmath>
  11. #include <iomanip>
  12. namespace Catch {
  13. namespace Detail {
  14. namespace {
  15. const int hexThreshold = 255;
  16. struct Endianness {
  17. enum Arch { Big, Little };
  18. static Arch which() {
  19. int one = 1;
  20. // If the lowest byte we read is non-zero, we can assume
  21. // that little endian format is used.
  22. auto value = *reinterpret_cast<char*>(&one);
  23. return value ? Little : Big;
  24. }
  25. };
  26. template<typename T>
  27. std::string fpToString(T value, int precision) {
  28. if (Catch::isnan(value)) {
  29. return "nan";
  30. }
  31. ReusableStringStream rss;
  32. rss << std::setprecision(precision)
  33. << std::fixed
  34. << value;
  35. std::string d = rss.str();
  36. std::size_t i = d.find_last_not_of('0');
  37. if (i != std::string::npos && i != d.size() - 1) {
  38. if (d[i] == '.')
  39. i++;
  40. d = d.substr(0, i + 1);
  41. }
  42. return d;
  43. }
  44. } // end unnamed namespace
  45. std::string convertIntoString(StringRef string, bool escape_invisibles) {
  46. std::string ret;
  47. // This is enough for the "don't escape invisibles" case, and a good
  48. // lower bound on the "escape invisibles" case.
  49. ret.reserve(string.size() + 2);
  50. if (!escape_invisibles) {
  51. ret += '"';
  52. ret += string;
  53. ret += '"';
  54. return ret;
  55. }
  56. ret += '"';
  57. for (char c : string) {
  58. switch (c) {
  59. case '\r':
  60. ret.append("\\r");
  61. break;
  62. case '\n':
  63. ret.append("\\n");
  64. break;
  65. case '\t':
  66. ret.append("\\t");
  67. break;
  68. case '\f':
  69. ret.append("\\f");
  70. break;
  71. default:
  72. ret.push_back(c);
  73. break;
  74. }
  75. }
  76. ret += '"';
  77. return ret;
  78. }
  79. std::string convertIntoString(StringRef string) {
  80. return convertIntoString(string, getCurrentContext().getConfig()->showInvisibles());
  81. }
  82. std::string rawMemoryToString( const void *object, std::size_t size ) {
  83. // Reverse order for little endian architectures
  84. int i = 0, end = static_cast<int>( size ), inc = 1;
  85. if( Endianness::which() == Endianness::Little ) {
  86. i = end-1;
  87. end = inc = -1;
  88. }
  89. unsigned char const *bytes = static_cast<unsigned char const *>(object);
  90. ReusableStringStream rss;
  91. rss << "0x" << std::setfill('0') << std::hex;
  92. for( ; i != end; i += inc )
  93. rss << std::setw(2) << static_cast<unsigned>(bytes[i]);
  94. return rss.str();
  95. }
  96. } // end Detail namespace
  97. //// ======================================================= ////
  98. //
  99. // Out-of-line defs for full specialization of StringMaker
  100. //
  101. //// ======================================================= ////
  102. std::string StringMaker<std::string>::convert(const std::string& str) {
  103. return Detail::convertIntoString( str );
  104. }
  105. #ifdef CATCH_CONFIG_CPP17_STRING_VIEW
  106. std::string StringMaker<std::string_view>::convert(std::string_view str) {
  107. return Detail::convertIntoString( StringRef( str.data(), str.size() ) );
  108. }
  109. #endif
  110. std::string StringMaker<char const*>::convert(char const* str) {
  111. if (str) {
  112. return Detail::convertIntoString( str );
  113. } else {
  114. return{ "{null string}" };
  115. }
  116. }
  117. std::string StringMaker<char*>::convert(char* str) {
  118. if (str) {
  119. return Detail::convertIntoString( str );
  120. } else {
  121. return{ "{null string}" };
  122. }
  123. }
  124. #ifdef CATCH_CONFIG_WCHAR
  125. std::string StringMaker<std::wstring>::convert(const std::wstring& wstr) {
  126. std::string s;
  127. s.reserve(wstr.size());
  128. for (auto c : wstr) {
  129. s += (c <= 0xff) ? static_cast<char>(c) : '?';
  130. }
  131. return ::Catch::Detail::stringify(s);
  132. }
  133. # ifdef CATCH_CONFIG_CPP17_STRING_VIEW
  134. std::string StringMaker<std::wstring_view>::convert(std::wstring_view str) {
  135. return StringMaker<std::wstring>::convert(std::wstring(str));
  136. }
  137. # endif
  138. std::string StringMaker<wchar_t const*>::convert(wchar_t const * str) {
  139. if (str) {
  140. return ::Catch::Detail::stringify(std::wstring{ str });
  141. } else {
  142. return{ "{null string}" };
  143. }
  144. }
  145. std::string StringMaker<wchar_t *>::convert(wchar_t * str) {
  146. if (str) {
  147. return ::Catch::Detail::stringify(std::wstring{ str });
  148. } else {
  149. return{ "{null string}" };
  150. }
  151. }
  152. #endif
  153. #if defined(CATCH_CONFIG_CPP17_BYTE)
  154. #include <cstddef>
  155. std::string StringMaker<std::byte>::convert(std::byte value) {
  156. return ::Catch::Detail::stringify(std::to_integer<unsigned long long>(value));
  157. }
  158. #endif // defined(CATCH_CONFIG_CPP17_BYTE)
  159. std::string StringMaker<int>::convert(int value) {
  160. return ::Catch::Detail::stringify(static_cast<long long>(value));
  161. }
  162. std::string StringMaker<long>::convert(long value) {
  163. return ::Catch::Detail::stringify(static_cast<long long>(value));
  164. }
  165. std::string StringMaker<long long>::convert(long long value) {
  166. ReusableStringStream rss;
  167. rss << value;
  168. if (value > Detail::hexThreshold) {
  169. rss << " (0x" << std::hex << value << ')';
  170. }
  171. return rss.str();
  172. }
  173. std::string StringMaker<unsigned int>::convert(unsigned int value) {
  174. return ::Catch::Detail::stringify(static_cast<unsigned long long>(value));
  175. }
  176. std::string StringMaker<unsigned long>::convert(unsigned long value) {
  177. return ::Catch::Detail::stringify(static_cast<unsigned long long>(value));
  178. }
  179. std::string StringMaker<unsigned long long>::convert(unsigned long long value) {
  180. ReusableStringStream rss;
  181. rss << value;
  182. if (value > Detail::hexThreshold) {
  183. rss << " (0x" << std::hex << value << ')';
  184. }
  185. return rss.str();
  186. }
  187. std::string StringMaker<signed char>::convert(signed char value) {
  188. if (value == '\r') {
  189. return "'\\r'";
  190. } else if (value == '\f') {
  191. return "'\\f'";
  192. } else if (value == '\n') {
  193. return "'\\n'";
  194. } else if (value == '\t') {
  195. return "'\\t'";
  196. } else if ('\0' <= value && value < ' ') {
  197. return ::Catch::Detail::stringify(static_cast<unsigned int>(value));
  198. } else {
  199. char chstr[] = "' '";
  200. chstr[1] = value;
  201. return chstr;
  202. }
  203. }
  204. std::string StringMaker<char>::convert(char c) {
  205. return ::Catch::Detail::stringify(static_cast<signed char>(c));
  206. }
  207. std::string StringMaker<unsigned char>::convert(unsigned char c) {
  208. return ::Catch::Detail::stringify(static_cast<char>(c));
  209. }
  210. int StringMaker<float>::precision = 5;
  211. std::string StringMaker<float>::convert(float value) {
  212. return Detail::fpToString(value, precision) + 'f';
  213. }
  214. int StringMaker<double>::precision = 10;
  215. std::string StringMaker<double>::convert(double value) {
  216. return Detail::fpToString(value, precision);
  217. }
  218. } // end namespace Catch