core-test.cc 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858
  1. // Formatting library for C++ - core tests
  2. //
  3. // Copyright (c) 2012 - present, Victor Zverovich
  4. // All rights reserved.
  5. //
  6. // For the license information refer to format.h.
  7. // clang-format off
  8. #include "test-assert.h"
  9. // clang-format on
  10. #include "fmt/core.h"
  11. #include <algorithm> // std::copy_n
  12. #include <climits> // INT_MAX
  13. #include <cstring> // std::strlen
  14. #include <functional> // std::equal_to
  15. #include <iterator> // std::back_insert_iterator
  16. #include <limits> // std::numeric_limits
  17. #include <string> // std::string
  18. #include <type_traits> // std::is_same
  19. #include "gmock/gmock.h"
  20. using fmt::string_view;
  21. using fmt::detail::buffer;
  22. using testing::_;
  23. using testing::Invoke;
  24. using testing::Return;
  25. #ifdef FMT_FORMAT_H_
  26. # error core-test includes format.h
  27. #endif
  28. TEST(string_view_test, value_type) {
  29. static_assert(std::is_same<string_view::value_type, char>::value, "");
  30. }
  31. TEST(string_view_test, ctor) {
  32. EXPECT_STREQ("abc", fmt::string_view("abc").data());
  33. EXPECT_EQ(3u, fmt::string_view("abc").size());
  34. EXPECT_STREQ("defg", fmt::string_view(std::string("defg")).data());
  35. EXPECT_EQ(4u, fmt::string_view(std::string("defg")).size());
  36. }
  37. TEST(string_view_test, length) {
  38. // Test that string_view::size() returns string length, not buffer size.
  39. char str[100] = "some string";
  40. EXPECT_EQ(std::strlen(str), string_view(str).size());
  41. EXPECT_LT(std::strlen(str), sizeof(str));
  42. }
  43. // Check string_view's comparison operator.
  44. template <template <typename> class Op> void check_op() {
  45. const char* inputs[] = {"foo", "fop", "fo"};
  46. size_t num_inputs = sizeof(inputs) / sizeof(*inputs);
  47. for (size_t i = 0; i < num_inputs; ++i) {
  48. for (size_t j = 0; j < num_inputs; ++j) {
  49. string_view lhs(inputs[i]), rhs(inputs[j]);
  50. EXPECT_EQ(Op<int>()(lhs.compare(rhs), 0), Op<string_view>()(lhs, rhs));
  51. }
  52. }
  53. }
  54. TEST(string_view_test, compare) {
  55. EXPECT_EQ(string_view("foo").compare(string_view("foo")), 0);
  56. EXPECT_GT(string_view("fop").compare(string_view("foo")), 0);
  57. EXPECT_LT(string_view("foo").compare(string_view("fop")), 0);
  58. EXPECT_GT(string_view("foo").compare(string_view("fo")), 0);
  59. EXPECT_LT(string_view("fo").compare(string_view("foo")), 0);
  60. EXPECT_TRUE(string_view("foo").starts_with('f'));
  61. EXPECT_FALSE(string_view("foo").starts_with('o'));
  62. EXPECT_FALSE(string_view().starts_with('o'));
  63. EXPECT_TRUE(string_view("foo").starts_with("fo"));
  64. EXPECT_TRUE(string_view("foo").starts_with("foo"));
  65. EXPECT_FALSE(string_view("foo").starts_with("fooo"));
  66. EXPECT_FALSE(string_view().starts_with("fooo"));
  67. check_op<std::equal_to>();
  68. check_op<std::not_equal_to>();
  69. check_op<std::less>();
  70. check_op<std::less_equal>();
  71. check_op<std::greater>();
  72. check_op<std::greater_equal>();
  73. }
  74. TEST(core_test, is_output_iterator) {
  75. EXPECT_TRUE((fmt::detail::is_output_iterator<char*, char>::value));
  76. EXPECT_FALSE((fmt::detail::is_output_iterator<const char*, char>::value));
  77. EXPECT_FALSE((fmt::detail::is_output_iterator<std::string, char>::value));
  78. EXPECT_TRUE(
  79. (fmt::detail::is_output_iterator<std::back_insert_iterator<std::string>,
  80. char>::value));
  81. EXPECT_TRUE(
  82. (fmt::detail::is_output_iterator<std::string::iterator, char>::value));
  83. EXPECT_FALSE((fmt::detail::is_output_iterator<std::string::const_iterator,
  84. char>::value));
  85. }
  86. TEST(core_test, buffer_appender) {
  87. // back_insert_iterator is not default-constructible before C++20, so
  88. // buffer_appender can only be default-constructible when back_insert_iterator
  89. // is.
  90. static_assert(
  91. std::is_default_constructible<
  92. std::back_insert_iterator<fmt::detail::buffer<char>>>::value ==
  93. std::is_default_constructible<
  94. fmt::detail::buffer_appender<char>>::value,
  95. "");
  96. #ifdef __cpp_lib_ranges
  97. static_assert(std::output_iterator<fmt::detail::buffer_appender<char>, char>);
  98. #endif
  99. }
  100. #if !FMT_GCC_VERSION || FMT_GCC_VERSION >= 470
  101. TEST(buffer_test, noncopyable) {
  102. EXPECT_FALSE(std::is_copy_constructible<buffer<char>>::value);
  103. # if !FMT_MSC_VERSION
  104. // std::is_copy_assignable is broken in MSVC2013.
  105. EXPECT_FALSE(std::is_copy_assignable<buffer<char>>::value);
  106. # endif
  107. }
  108. TEST(buffer_test, nonmoveable) {
  109. EXPECT_FALSE(std::is_move_constructible<buffer<char>>::value);
  110. # if !FMT_MSC_VERSION
  111. // std::is_move_assignable is broken in MSVC2013.
  112. EXPECT_FALSE(std::is_move_assignable<buffer<char>>::value);
  113. # endif
  114. }
  115. #endif
  116. TEST(buffer_test, indestructible) {
  117. static_assert(!std::is_destructible<fmt::detail::buffer<int>>(),
  118. "buffer's destructor is protected");
  119. }
  120. template <typename T> struct mock_buffer final : buffer<T> {
  121. MOCK_METHOD(size_t, do_grow, (size_t));
  122. void grow(size_t capacity) override {
  123. this->set(this->data(), do_grow(capacity));
  124. }
  125. mock_buffer(T* data = nullptr, size_t buf_capacity = 0) {
  126. this->set(data, buf_capacity);
  127. ON_CALL(*this, do_grow(_)).WillByDefault(Invoke([](size_t capacity) {
  128. return capacity;
  129. }));
  130. }
  131. };
  132. TEST(buffer_test, ctor) {
  133. {
  134. mock_buffer<int> buffer;
  135. EXPECT_EQ(nullptr, buffer.data());
  136. EXPECT_EQ(static_cast<size_t>(0), buffer.size());
  137. EXPECT_EQ(static_cast<size_t>(0), buffer.capacity());
  138. }
  139. {
  140. int dummy;
  141. mock_buffer<int> buffer(&dummy);
  142. EXPECT_EQ(&dummy, &buffer[0]);
  143. EXPECT_EQ(static_cast<size_t>(0), buffer.size());
  144. EXPECT_EQ(static_cast<size_t>(0), buffer.capacity());
  145. }
  146. {
  147. int dummy;
  148. size_t capacity = std::numeric_limits<size_t>::max();
  149. mock_buffer<int> buffer(&dummy, capacity);
  150. EXPECT_EQ(&dummy, &buffer[0]);
  151. EXPECT_EQ(static_cast<size_t>(0), buffer.size());
  152. EXPECT_EQ(capacity, buffer.capacity());
  153. }
  154. }
  155. TEST(buffer_test, access) {
  156. char data[10];
  157. mock_buffer<char> buffer(data, sizeof(data));
  158. buffer[0] = 11;
  159. EXPECT_EQ(11, buffer[0]);
  160. buffer[3] = 42;
  161. EXPECT_EQ(42, *(&buffer[0] + 3));
  162. const fmt::detail::buffer<char>& const_buffer = buffer;
  163. EXPECT_EQ(42, const_buffer[3]);
  164. }
  165. TEST(buffer_test, try_resize) {
  166. char data[123];
  167. mock_buffer<char> buffer(data, sizeof(data));
  168. buffer[10] = 42;
  169. EXPECT_EQ(42, buffer[10]);
  170. buffer.try_resize(20);
  171. EXPECT_EQ(20u, buffer.size());
  172. EXPECT_EQ(123u, buffer.capacity());
  173. EXPECT_EQ(42, buffer[10]);
  174. buffer.try_resize(5);
  175. EXPECT_EQ(5u, buffer.size());
  176. EXPECT_EQ(123u, buffer.capacity());
  177. EXPECT_EQ(42, buffer[10]);
  178. // Check if try_resize calls grow.
  179. EXPECT_CALL(buffer, do_grow(124));
  180. buffer.try_resize(124);
  181. EXPECT_CALL(buffer, do_grow(200));
  182. buffer.try_resize(200);
  183. }
  184. TEST(buffer_test, try_resize_partial) {
  185. char data[10];
  186. mock_buffer<char> buffer(data, sizeof(data));
  187. EXPECT_CALL(buffer, do_grow(20)).WillOnce(Return(15));
  188. buffer.try_resize(20);
  189. EXPECT_EQ(buffer.capacity(), 15);
  190. EXPECT_EQ(buffer.size(), 15);
  191. }
  192. TEST(buffer_test, clear) {
  193. mock_buffer<char> buffer;
  194. EXPECT_CALL(buffer, do_grow(20));
  195. buffer.try_resize(20);
  196. buffer.try_resize(0);
  197. EXPECT_EQ(static_cast<size_t>(0), buffer.size());
  198. EXPECT_EQ(20u, buffer.capacity());
  199. }
  200. TEST(buffer_test, append) {
  201. char data[15];
  202. mock_buffer<char> buffer(data, 10);
  203. auto test = "test";
  204. buffer.append(test, test + 5);
  205. EXPECT_STREQ(test, &buffer[0]);
  206. EXPECT_EQ(5u, buffer.size());
  207. buffer.try_resize(10);
  208. EXPECT_CALL(buffer, do_grow(12));
  209. buffer.append(test, test + 2);
  210. EXPECT_EQ('t', buffer[10]);
  211. EXPECT_EQ('e', buffer[11]);
  212. EXPECT_EQ(12u, buffer.size());
  213. }
  214. TEST(buffer_test, append_partial) {
  215. char data[10];
  216. mock_buffer<char> buffer(data, sizeof(data));
  217. testing::InSequence seq;
  218. EXPECT_CALL(buffer, do_grow(15)).WillOnce(Return(10));
  219. EXPECT_CALL(buffer, do_grow(15)).WillOnce(Invoke([&buffer](size_t) {
  220. EXPECT_EQ(fmt::string_view(buffer.data(), buffer.size()), "0123456789");
  221. buffer.clear();
  222. return 10;
  223. }));
  224. auto test = "0123456789abcde";
  225. buffer.append(test, test + 15);
  226. }
  227. TEST(buffer_test, append_allocates_enough_storage) {
  228. char data[19];
  229. mock_buffer<char> buffer(data, 10);
  230. auto test = "abcdefgh";
  231. buffer.try_resize(10);
  232. EXPECT_CALL(buffer, do_grow(19));
  233. buffer.append(test, test + 9);
  234. }
  235. struct custom_context {
  236. using char_type = char;
  237. using parse_context_type = fmt::format_parse_context;
  238. bool called = false;
  239. template <typename T> struct formatter_type {
  240. FMT_CONSTEXPR auto parse(fmt::format_parse_context& ctx) -> decltype(ctx.begin()) {
  241. return ctx.begin();
  242. }
  243. const char* format(const T&, custom_context& ctx) {
  244. ctx.called = true;
  245. return nullptr;
  246. }
  247. };
  248. void advance_to(const char*) {}
  249. };
  250. struct test_struct {};
  251. FMT_BEGIN_NAMESPACE
  252. template <typename Char> struct formatter<test_struct, Char> {
  253. FMT_CONSTEXPR auto parse(format_parse_context& ctx) -> decltype(ctx.begin()) {
  254. return ctx.begin();
  255. }
  256. auto format(test_struct, format_context& ctx) const -> decltype(ctx.out()) {
  257. auto test = string_view("test");
  258. return std::copy_n(test.data(), test.size(), ctx.out());
  259. }
  260. };
  261. FMT_END_NAMESPACE
  262. TEST(arg_test, format_args) {
  263. auto args = fmt::format_args();
  264. EXPECT_FALSE(args.get(1));
  265. }
  266. TEST(arg_test, make_value_with_custom_context) {
  267. auto t = test_struct();
  268. auto arg = fmt::detail::value<custom_context>(
  269. fmt::detail::arg_mapper<custom_context>().map(t));
  270. auto ctx = custom_context();
  271. auto parse_ctx = fmt::format_parse_context("");
  272. arg.custom.format(&t, parse_ctx, ctx);
  273. EXPECT_TRUE(ctx.called);
  274. }
  275. // Use a unique result type to make sure that there are no undesirable
  276. // conversions.
  277. struct test_result {};
  278. template <typename T> struct mock_visitor {
  279. template <typename U> struct result { using type = test_result; };
  280. mock_visitor() {
  281. ON_CALL(*this, visit(_)).WillByDefault(Return(test_result()));
  282. }
  283. MOCK_METHOD(test_result, visit, (T));
  284. MOCK_METHOD(void, unexpected, ());
  285. auto operator()(T value) -> test_result { return visit(value); }
  286. template <typename U> auto operator()(U) -> test_result {
  287. unexpected();
  288. return test_result();
  289. }
  290. };
  291. template <typename T> struct visit_type { using type = T; };
  292. #define VISIT_TYPE(type_, visit_type_) \
  293. template <> struct visit_type<type_> { using type = visit_type_; }
  294. VISIT_TYPE(signed char, int);
  295. VISIT_TYPE(unsigned char, unsigned);
  296. VISIT_TYPE(short, int);
  297. VISIT_TYPE(unsigned short, unsigned);
  298. #if LONG_MAX == INT_MAX
  299. VISIT_TYPE(long, int);
  300. VISIT_TYPE(unsigned long, unsigned);
  301. #else
  302. VISIT_TYPE(long, long long);
  303. VISIT_TYPE(unsigned long, unsigned long long);
  304. #endif
  305. #define CHECK_ARG(Char, expected, value) \
  306. { \
  307. testing::StrictMock<mock_visitor<decltype(expected)>> visitor; \
  308. EXPECT_CALL(visitor, visit(expected)); \
  309. using iterator = std::back_insert_iterator<buffer<Char>>; \
  310. auto var = value; \
  311. fmt::visit_format_arg( \
  312. visitor, \
  313. fmt::detail::make_arg<fmt::basic_format_context<iterator, Char>>( \
  314. var)); \
  315. }
  316. #define CHECK_ARG_SIMPLE(value) \
  317. { \
  318. using value_type = decltype(value); \
  319. typename visit_type<value_type>::type expected = value; \
  320. CHECK_ARG(char, expected, value) \
  321. CHECK_ARG(wchar_t, expected, value) \
  322. }
  323. template <typename T> class numeric_arg_test : public testing::Test {};
  324. using test_types =
  325. testing::Types<bool, signed char, unsigned char, short, unsigned short, int,
  326. unsigned, long, unsigned long, long long, unsigned long long,
  327. float, double, long double>;
  328. TYPED_TEST_SUITE(numeric_arg_test, test_types);
  329. template <typename T, fmt::enable_if_t<std::is_integral<T>::value, int> = 0>
  330. auto test_value() -> T {
  331. return static_cast<T>(42);
  332. }
  333. template <typename T,
  334. fmt::enable_if_t<std::is_floating_point<T>::value, int> = 0>
  335. auto test_value() -> T {
  336. return static_cast<T>(4.2);
  337. }
  338. TYPED_TEST(numeric_arg_test, make_and_visit) {
  339. CHECK_ARG_SIMPLE(test_value<TypeParam>());
  340. CHECK_ARG_SIMPLE(std::numeric_limits<TypeParam>::min());
  341. CHECK_ARG_SIMPLE(std::numeric_limits<TypeParam>::max());
  342. }
  343. TEST(arg_test, char_arg) { CHECK_ARG(char, 'a', 'a'); }
  344. TEST(arg_test, string_arg) {
  345. char str_data[] = "test";
  346. char* str = str_data;
  347. const char* cstr = str;
  348. CHECK_ARG(char, cstr, str);
  349. auto sv = fmt::string_view(str);
  350. CHECK_ARG(char, sv, std::string(str));
  351. }
  352. TEST(arg_test, wstring_arg) {
  353. wchar_t str_data[] = L"test";
  354. wchar_t* str = str_data;
  355. const wchar_t* cstr = str;
  356. auto sv = fmt::basic_string_view<wchar_t>(str);
  357. CHECK_ARG(wchar_t, cstr, str);
  358. CHECK_ARG(wchar_t, cstr, cstr);
  359. CHECK_ARG(wchar_t, sv, std::wstring(str));
  360. CHECK_ARG(wchar_t, sv, fmt::basic_string_view<wchar_t>(str));
  361. }
  362. TEST(arg_test, pointer_arg) {
  363. void* p = nullptr;
  364. const void* cp = nullptr;
  365. CHECK_ARG(char, cp, p);
  366. CHECK_ARG(wchar_t, cp, p);
  367. CHECK_ARG_SIMPLE(cp);
  368. }
  369. struct check_custom {
  370. auto operator()(fmt::basic_format_arg<fmt::format_context>::handle h) const
  371. -> test_result {
  372. struct test_buffer final : fmt::detail::buffer<char> {
  373. char data[10];
  374. test_buffer() : fmt::detail::buffer<char>(data, 0, 10) {}
  375. void grow(size_t) override {}
  376. } buffer;
  377. auto parse_ctx = fmt::format_parse_context("");
  378. auto ctx = fmt::format_context(fmt::detail::buffer_appender<char>(buffer),
  379. fmt::format_args());
  380. h.format(parse_ctx, ctx);
  381. EXPECT_EQ("test", std::string(buffer.data, buffer.size()));
  382. return test_result();
  383. }
  384. };
  385. TEST(arg_test, custom_arg) {
  386. auto test = test_struct();
  387. using visitor =
  388. mock_visitor<fmt::basic_format_arg<fmt::format_context>::handle>;
  389. auto&& v = testing::StrictMock<visitor>();
  390. EXPECT_CALL(v, visit(_)).WillOnce(Invoke(check_custom()));
  391. fmt::visit_format_arg(v, fmt::detail::make_arg<fmt::format_context>(test));
  392. }
  393. TEST(arg_test, visit_invalid_arg) {
  394. auto&& visitor = testing::StrictMock<mock_visitor<fmt::monostate>>();
  395. EXPECT_CALL(visitor, visit(_));
  396. auto arg = fmt::basic_format_arg<fmt::format_context>();
  397. fmt::visit_format_arg(visitor, arg);
  398. }
  399. #if FMT_USE_CONSTEXPR
  400. enum class arg_id_result { none, empty, index, name };
  401. struct test_arg_id_handler {
  402. arg_id_result res = arg_id_result::none;
  403. int index = 0;
  404. string_view name;
  405. constexpr void on_auto() { res = arg_id_result::empty; }
  406. constexpr void on_index(int i) {
  407. res = arg_id_result::index;
  408. index = i;
  409. }
  410. constexpr void on_name(string_view n) {
  411. res = arg_id_result::name;
  412. name = n;
  413. }
  414. };
  415. template <size_t N>
  416. constexpr test_arg_id_handler parse_arg_id(const char (&s)[N]) {
  417. auto h = test_arg_id_handler();
  418. fmt::detail::parse_arg_id(s, s + N, h);
  419. return h;
  420. }
  421. TEST(core_test, constexpr_parse_arg_id) {
  422. static_assert(parse_arg_id(":").res == arg_id_result::empty, "");
  423. static_assert(parse_arg_id("}").res == arg_id_result::empty, "");
  424. static_assert(parse_arg_id("42:").res == arg_id_result::index, "");
  425. static_assert(parse_arg_id("42:").index == 42, "");
  426. static_assert(parse_arg_id("foo:").res == arg_id_result::name, "");
  427. static_assert(parse_arg_id("foo:").name.size() == 3, "");
  428. }
  429. template <size_t N> constexpr auto parse_test_specs(const char (&s)[N]) {
  430. auto ctx = fmt::detail::compile_parse_context<char>(fmt::string_view(s, N),
  431. 43, nullptr);
  432. auto specs = fmt::detail::dynamic_format_specs<>();
  433. fmt::detail::parse_format_specs(s, s + N - 1, specs, ctx,
  434. fmt::detail::type::float_type);
  435. return specs;
  436. }
  437. TEST(core_test, constexpr_parse_format_specs) {
  438. static_assert(parse_test_specs("<").align == fmt::align::left, "");
  439. static_assert(parse_test_specs("*^").fill[0] == '*', "");
  440. static_assert(parse_test_specs("+").sign == fmt::sign::plus, "");
  441. static_assert(parse_test_specs("-").sign == fmt::sign::minus, "");
  442. static_assert(parse_test_specs(" ").sign == fmt::sign::space, "");
  443. static_assert(parse_test_specs("#").alt, "");
  444. static_assert(parse_test_specs("0").align == fmt::align::numeric, "");
  445. static_assert(parse_test_specs("L").localized, "");
  446. static_assert(parse_test_specs("42").width == 42, "");
  447. static_assert(parse_test_specs("{42}").width_ref.val.index == 42, "");
  448. static_assert(parse_test_specs(".42").precision == 42, "");
  449. static_assert(parse_test_specs(".{42}").precision_ref.val.index == 42, "");
  450. static_assert(
  451. parse_test_specs("f").type == fmt::presentation_type::fixed_lower, "");
  452. }
  453. struct test_format_string_handler {
  454. constexpr void on_text(const char*, const char*) {}
  455. constexpr auto on_arg_id() -> int { return 0; }
  456. template <typename T> constexpr auto on_arg_id(T) -> int { return 0; }
  457. constexpr void on_replacement_field(int, const char*) {}
  458. constexpr auto on_format_specs(int, const char* begin, const char*) -> const
  459. char* {
  460. return begin;
  461. }
  462. constexpr void on_error(const char*) { error = true; }
  463. bool error = false;
  464. };
  465. template <size_t N> constexpr bool parse_string(const char (&s)[N]) {
  466. auto h = test_format_string_handler();
  467. fmt::detail::parse_format_string<true>(fmt::string_view(s, N - 1), h);
  468. return !h.error;
  469. }
  470. TEST(core_test, constexpr_parse_format_string) {
  471. static_assert(parse_string("foo"), "");
  472. static_assert(!parse_string("}"), "");
  473. static_assert(parse_string("{}"), "");
  474. static_assert(parse_string("{42}"), "");
  475. static_assert(parse_string("{foo}"), "");
  476. static_assert(parse_string("{:}"), "");
  477. }
  478. #endif // FMT_USE_CONSTEXPR
  479. struct enabled_formatter {};
  480. struct enabled_ptr_formatter {};
  481. struct disabled_formatter {};
  482. struct disabled_formatter_convertible {
  483. operator int() const { return 42; }
  484. };
  485. FMT_BEGIN_NAMESPACE
  486. template <> struct formatter<enabled_formatter> {
  487. FMT_CONSTEXPR auto parse(format_parse_context& ctx) -> decltype(ctx.begin()) {
  488. return ctx.begin();
  489. }
  490. auto format(enabled_formatter, format_context& ctx) const
  491. -> decltype(ctx.out()) {
  492. return ctx.out();
  493. }
  494. };
  495. template <> struct formatter<enabled_ptr_formatter*> {
  496. FMT_CONSTEXPR auto parse(format_parse_context& ctx) -> decltype(ctx.begin()) {
  497. return ctx.begin();
  498. }
  499. auto format(enabled_ptr_formatter*, format_context& ctx) const
  500. -> decltype(ctx.out()) {
  501. return ctx.out();
  502. }
  503. };
  504. FMT_END_NAMESPACE
  505. TEST(core_test, has_formatter) {
  506. using fmt::has_formatter;
  507. using context = fmt::format_context;
  508. static_assert(has_formatter<enabled_formatter, context>::value, "");
  509. static_assert(!has_formatter<disabled_formatter, context>::value, "");
  510. static_assert(!has_formatter<disabled_formatter_convertible, context>::value,
  511. "");
  512. }
  513. struct const_formattable {};
  514. struct nonconst_formattable {};
  515. FMT_BEGIN_NAMESPACE
  516. template <> struct formatter<const_formattable> {
  517. FMT_CONSTEXPR auto parse(format_parse_context& ctx) -> decltype(ctx.begin()) {
  518. return ctx.begin();
  519. }
  520. auto format(const const_formattable&, format_context& ctx)
  521. -> decltype(ctx.out()) {
  522. auto test = string_view("test");
  523. return std::copy_n(test.data(), test.size(), ctx.out());
  524. }
  525. };
  526. template <> struct formatter<nonconst_formattable> {
  527. FMT_CONSTEXPR auto parse(format_parse_context& ctx) -> decltype(ctx.begin()) {
  528. return ctx.begin();
  529. }
  530. auto format(nonconst_formattable&, format_context& ctx)
  531. -> decltype(ctx.out()) {
  532. auto test = string_view("test");
  533. return std::copy_n(test.data(), test.size(), ctx.out());
  534. }
  535. };
  536. FMT_END_NAMESPACE
  537. struct convertible_to_pointer {
  538. operator const int*() const { return nullptr; }
  539. };
  540. struct convertible_to_pointer_formattable {
  541. operator const int*() const { return nullptr; }
  542. };
  543. FMT_BEGIN_NAMESPACE
  544. template <> struct formatter<convertible_to_pointer_formattable> {
  545. FMT_CONSTEXPR auto parse(format_parse_context& ctx) -> decltype(ctx.begin()) {
  546. return ctx.begin();
  547. }
  548. auto format(convertible_to_pointer_formattable, format_context& ctx) const
  549. -> decltype(ctx.out()) {
  550. auto test = string_view("test");
  551. return std::copy_n(test.data(), test.size(), ctx.out());
  552. }
  553. };
  554. FMT_END_NAMESPACE
  555. enum class unformattable_scoped_enum {};
  556. TEST(core_test, is_formattable) {
  557. static_assert(!fmt::is_formattable<wchar_t>::value, "");
  558. #ifdef __cpp_char8_t
  559. static_assert(!fmt::is_formattable<char8_t>::value, "");
  560. #endif
  561. static_assert(!fmt::is_formattable<char16_t>::value, "");
  562. static_assert(!fmt::is_formattable<char32_t>::value, "");
  563. static_assert(!fmt::is_formattable<signed char*>::value, "");
  564. static_assert(!fmt::is_formattable<unsigned char*>::value, "");
  565. static_assert(!fmt::is_formattable<const signed char*>::value, "");
  566. static_assert(!fmt::is_formattable<const unsigned char*>::value, "");
  567. static_assert(!fmt::is_formattable<const wchar_t*>::value, "");
  568. static_assert(!fmt::is_formattable<const wchar_t[3]>::value, "");
  569. static_assert(!fmt::is_formattable<fmt::basic_string_view<wchar_t>>::value,
  570. "");
  571. static_assert(fmt::is_formattable<enabled_formatter>::value, "");
  572. static_assert(!fmt::is_formattable<enabled_ptr_formatter*>::value, "");
  573. static_assert(!fmt::is_formattable<disabled_formatter>::value, "");
  574. static_assert(!fmt::is_formattable<disabled_formatter_convertible>::value,
  575. "");
  576. static_assert(fmt::is_formattable<const_formattable&>::value, "");
  577. static_assert(fmt::is_formattable<const const_formattable&>::value, "");
  578. static_assert(fmt::is_formattable<nonconst_formattable&>::value, "");
  579. #if !FMT_MSC_VERSION || FMT_MSC_VERSION >= 1910
  580. static_assert(!fmt::is_formattable<const nonconst_formattable&>::value, "");
  581. #endif
  582. static_assert(!fmt::is_formattable<convertible_to_pointer>::value, "");
  583. const auto f = convertible_to_pointer_formattable();
  584. EXPECT_EQ(fmt::format("{}", f), "test");
  585. static_assert(!fmt::is_formattable<void (*)()>::value, "");
  586. struct s;
  587. static_assert(!fmt::is_formattable<int(s::*)>::value, "");
  588. static_assert(!fmt::is_formattable<int (s::*)()>::value, "");
  589. static_assert(!fmt::is_formattable<unformattable_scoped_enum>::value, "");
  590. static_assert(!fmt::is_formattable<unformattable_scoped_enum>::value, "");
  591. }
  592. TEST(core_test, format) { EXPECT_EQ(fmt::format("{}", 42), "42"); }
  593. TEST(core_test, format_to) {
  594. auto s = std::string();
  595. fmt::format_to(std::back_inserter(s), "{}", 42);
  596. EXPECT_EQ(s, "42");
  597. }
  598. #ifdef __cpp_lib_byte
  599. TEST(core_test, format_byte) {
  600. EXPECT_EQ(fmt::format("{}", std::byte(42)), "42");
  601. }
  602. #endif
  603. struct convertible_to_int {
  604. operator int() const { return 42; }
  605. };
  606. struct convertible_to_cstring {
  607. operator const char*() const { return "foo"; }
  608. };
  609. FMT_BEGIN_NAMESPACE
  610. template <> struct formatter<convertible_to_int> {
  611. FMT_CONSTEXPR auto parse(format_parse_context& ctx) -> decltype(ctx.begin()) {
  612. return ctx.begin();
  613. }
  614. auto format(convertible_to_int, format_context& ctx) const
  615. -> decltype(ctx.out()) {
  616. return std::copy_n("foo", 3, ctx.out());
  617. }
  618. };
  619. template <> struct formatter<convertible_to_cstring> {
  620. FMT_CONSTEXPR auto parse(format_parse_context& ctx) -> decltype(ctx.begin()) {
  621. return ctx.begin();
  622. }
  623. auto format(convertible_to_cstring, format_context& ctx) const
  624. -> decltype(ctx.out()) {
  625. return std::copy_n("bar", 3, ctx.out());
  626. }
  627. };
  628. FMT_END_NAMESPACE
  629. TEST(core_test, formatter_overrides_implicit_conversion) {
  630. EXPECT_EQ(fmt::format("{}", convertible_to_int()), "foo");
  631. EXPECT_EQ(fmt::format("{}", convertible_to_cstring()), "bar");
  632. }
  633. // Test that check is not found by ADL.
  634. template <typename T> void check(T);
  635. TEST(core_test, adl_check) {
  636. EXPECT_EQ(fmt::format("{}", test_struct()), "test");
  637. }
  638. struct implicitly_convertible_to_string_view {
  639. operator fmt::string_view() const { return "foo"; }
  640. };
  641. TEST(core_test, no_implicit_conversion_to_string_view) {
  642. EXPECT_FALSE(
  643. fmt::is_formattable<implicitly_convertible_to_string_view>::value);
  644. }
  645. #ifdef FMT_USE_STRING_VIEW
  646. struct implicitly_convertible_to_std_string_view {
  647. operator std::string_view() const { return "foo"; }
  648. };
  649. TEST(core_test, no_implicit_conversion_to_std_string_view) {
  650. EXPECT_FALSE(
  651. fmt::is_formattable<implicitly_convertible_to_std_string_view>::value);
  652. }
  653. #endif
  654. // std::is_constructible is broken in MSVC until version 2015.
  655. #if !FMT_MSC_VERSION || FMT_MSC_VERSION >= 1900
  656. struct explicitly_convertible_to_string_view {
  657. explicit operator fmt::string_view() const { return "foo"; }
  658. };
  659. TEST(core_test, format_explicitly_convertible_to_string_view) {
  660. // Types explicitly convertible to string_view are not formattable by
  661. // default because it may introduce ODR violations.
  662. static_assert(
  663. !fmt::is_formattable<explicitly_convertible_to_string_view>::value, "");
  664. }
  665. # ifdef FMT_USE_STRING_VIEW
  666. struct explicitly_convertible_to_std_string_view {
  667. explicit operator std::string_view() const { return "foo"; }
  668. };
  669. TEST(core_test, format_explicitly_convertible_to_std_string_view) {
  670. // Types explicitly convertible to string_view are not formattable by
  671. // default because it may introduce ODR violations.
  672. static_assert(
  673. !fmt::is_formattable<explicitly_convertible_to_std_string_view>::value,
  674. "");
  675. }
  676. # endif
  677. #endif
  678. namespace adl_test {
  679. template <typename... T> void make_format_args(const T&...) = delete;
  680. struct string : std::string {};
  681. } // namespace adl_test
  682. // Test that formatting functions compile when make_format_args is found by ADL.
  683. TEST(core_test, adl) {
  684. // Only check compilation and don't run the code to avoid polluting the output
  685. // and since the output is tested elsewhere.
  686. if (fmt::detail::const_check(true)) return;
  687. auto s = adl_test::string();
  688. char buf[10];
  689. (void)fmt::format("{}", s);
  690. fmt::format_to(buf, "{}", s);
  691. fmt::format_to_n(buf, 10, "{}", s);
  692. (void)fmt::formatted_size("{}", s);
  693. fmt::print("{}", s);
  694. fmt::print(stdout, "{}", s);
  695. }
  696. TEST(core_test, has_const_formatter) {
  697. EXPECT_TRUE((fmt::detail::has_const_formatter<const_formattable,
  698. fmt::format_context>()));
  699. EXPECT_FALSE((fmt::detail::has_const_formatter<nonconst_formattable,
  700. fmt::format_context>()));
  701. }
  702. TEST(core_test, format_nonconst) {
  703. EXPECT_EQ(fmt::format("{}", nonconst_formattable()), "test");
  704. }
  705. struct its_a_trap {
  706. template <typename T> operator T() const {
  707. auto v = T();
  708. v.x = 42;
  709. return v;
  710. }
  711. };
  712. FMT_BEGIN_NAMESPACE
  713. template <> struct formatter<its_a_trap> {
  714. FMT_CONSTEXPR auto parse(format_parse_context& ctx) -> decltype(ctx.begin()) {
  715. return ctx.begin();
  716. }
  717. auto format(its_a_trap, format_context& ctx) const -> decltype(ctx.out()) {
  718. auto s = string_view("42");
  719. return std::copy(s.begin(), s.end(), ctx.out());
  720. }
  721. };
  722. FMT_END_NAMESPACE
  723. TEST(core_test, trappy_conversion) {
  724. EXPECT_EQ(fmt::format("{}", its_a_trap()), "42");
  725. }