[libc++][test] Adds format string helper.

[Mordante]

Summary

Update the formatter day tests to the new style.
Other test will be done separately.

[ldionne]

Can this be accompanied by changes in the tests proper?

[Mordante]

I created this for the formatting escaped strings, which will take some time to review. I'm also converting the test for the landed day formatter and the year formatter which will be in review soon. So from that point of view it makes sense to have it separately. If wanted I can squash this with the formatter day changes.

[Mordante]

Addresses review comments.

[Mordante]

Fix CI

[Mordante]

CI fixes.

[Mordante]

Fixes CI.

[vitaut]

One minor comment inline otherwise looks great. Much more readable than template operator()!

libcxx/test/std/time/time.syn/formatter_tests.h

41–42

Why is this a lambda and not a normal function? If it was the latter you could have a locale overload without inventing a new name.

[Mordante]

In D134031#3797641, @vitaut wrote:

One minor comment inline otherwise looks great. Much more readable than template operator()!

I agree. I will adjust the other tests in a separate commit.

libcxx/test/std/time/time.syn/formatter_tests.h

41–42

Good question. Basically since I used that pattern before. I've changed it to a normal function.

[Mordante]

Addresses review comments.

[ldionne]

libcxx/test/support/test_format_string.h

11–12

44–45

This will also avoid the comment becoming stale when/if we move to github PRs.

49

libcxx/test/std/time/time.syn/formatter.day.pass.cpp

 #include "string_literal.h"
 #include "test_macros.h"
 
 template <class CharT>
 static void test_no_chrono_specs() {
   using namespace std::literals::chrono_literals;
 
   // Valid day
-  check.template operator()<"{}">(SV("01"), 1d);
-  check.template operator()<"{:*^4}">(SV("*01*"), 1d);
-  check.template operator()<"{:*>3}">(SV("*01"), 1d);
+  check(SV("01"), SV("{}"), 1d);
+  check(SV("*01*"), SV("{:*^4}"), 1d);
+  check(SV("*01"), SV("{:*>3}"), 1d);
 
   // Invalid day
-  check.template operator()<"{}">(SV("00 is not a valid day"), 0d);
-  check.template operator()<"{:*^23}">(SV("*00 is not a valid day*"), 0d);
+  check(SV("00 is not a valid day"), SV("{}"), 0d);
+  check(SV("*00 is not a valid day*"), SV("{:*^23}"), 0d);
 }
 
 template <class CharT>
 static void test_valid_values() {
   using namespace std::literals::chrono_literals;
 
-  constexpr string_literal fmt{"{:%%d='%d'%t%%Od='%Od'%t%%e='%e'%t%%Oe='%Oe'%n}"};
-  constexpr string_literal lfmt{"{:L%%d='%d'%t%%Od='%Od'%t%%e='%e'%t%%Oe='%Oe'%n}"};
+  constexpr std::basic_string_view<CharT> fmt  = SV("{:%%d='%d'%t%%Od='%Od'%t%%e='%e'%t%%Oe='%Oe'%n}");
+  constexpr std::basic_string_view<CharT> lfmt = SV("{:L%%d='%d'%t%%Od='%Od'%t%%e='%e'%t%%Oe='%Oe'%n}");
 
   const std::locale loc(LOCALE_ja_JP_UTF_8);
   std::locale::global(std::locale(LOCALE_fr_FR_UTF_8));
 
   // Non localized output using C-locale
-  check.template operator()<fmt>(SV("%d='00'\t%Od='00'\t%e=' 0'\t%Oe=' 0'\n"), 0d);
-  check.template operator()<fmt>(SV("%d='01'\t%Od='01'\t%e=' 1'\t%Oe=' 1'\n"), 1d);
-  check.template operator()<fmt>(SV("%d='31'\t%Od='31'\t%e='31'\t%Oe='31'\n"), 31d);
+  check(SV("%d='00'\t%Od='00'\t%e=' 0'\t%Oe=' 0'\n"), fmt, 0d);
+  check(SV("%d='01'\t%Od='01'\t%e=' 1'\t%Oe=' 1'\n"), fmt, 1d);
+  check(SV("%d='31'\t%Od='31'\t%e='31'\t%Oe='31'\n"), fmt, 31d);
 #if defined(_AIX)
-  check.template operator()<fmt>(SV("%d='55'\t%Od='55'\t%e='55'\t%Oe='55'\n"), 255d);
+  check(SV("%d='55'\t%Od='55'\t%e='55'\t%Oe='55'\n"), fmt, 255d);
 #else
-  check.template operator()<fmt>(SV("%d='255'\t%Od='255'\t%e='255'\t%Oe='255'\n"), 255d);
+  check(SV("%d='255'\t%Od='255'\t%e='255'\t%Oe='255'\n"), fmt, 255d);
 #endif
 
   // Use the global locale (fr_FR)
-  check.template operator()<lfmt>(SV("%d='00'\t%Od='00'\t%e=' 0'\t%Oe=' 0'\n"), 0d);
-  check.template operator()<lfmt>(SV("%d='01'\t%Od='01'\t%e=' 1'\t%Oe=' 1'\n"), 1d);
-  check.template operator()<lfmt>(SV("%d='31'\t%Od='31'\t%e='31'\t%Oe='31'\n"), 31d);
+  check(SV("%d='00'\t%Od='00'\t%e=' 0'\t%Oe=' 0'\n"), lfmt, 0d);
+  check(SV("%d='01'\t%Od='01'\t%e=' 1'\t%Oe=' 1'\n"), lfmt, 1d);
+  check(SV("%d='31'\t%Od='31'\t%e='31'\t%Oe='31'\n"), lfmt, 31d);
 #if defined(_AIX)
-  check.template operator()<lfmt>(SV("%d='55'\t%Od='55'\t%e='55'\t%Oe='55'\n"), 255d);
+  check(SV("%d='55'\t%Od='55'\t%e='55'\t%Oe='55'\n"), lfmt, 255d);
 #else
-  check.template operator()<lfmt>(SV("%d='255'\t%Od='255'\t%e='255'\t%Oe='255'\n"), 255d);
+  check(SV("%d='255'\t%Od='255'\t%e='255'\t%Oe='255'\n"), lfmt, 255d);
 #endif
 
   // Use supplied locale (ja_JP). This locale has a different alternate on some platforms.
 #if defined(__APPLE__) || defined(_AIX)
-  lcheck.template operator()<lfmt>(loc, SV("%d='00'\t%Od='00'\t%e=' 0'\t%Oe=' 0'\n"), 0d);
-  lcheck.template operator()<lfmt>(loc, SV("%d='01'\t%Od='01'\t%e=' 1'\t%Oe=' 1'\n"), 1d);
-  lcheck.template operator()<lfmt>(loc, SV("%d='31'\t%Od='31'\t%e='31'\t%Oe='31'\n"), 31d);
+  check(loc, SV("%d='00'\t%Od='00'\t%e=' 0'\t%Oe=' 0'\n"), lfmt, 0d);
+  check(loc, SV("%d='01'\t%Od='01'\t%e=' 1'\t%Oe=' 1'\n"), lfmt, 1d);
+  check(loc, SV("%d='31'\t%Od='31'\t%e='31'\t%Oe='31'\n"), lfmt, 31d);
 #  if defined(_AIX)
-  check.template operator()<fmt>(SV("%d='55'\t%Od='55'\t%e='55'\t%Oe='55'\n"), 255d);
+  check(SV("%d='55'\t%Od='55'\t%e='55'\t%Oe='55'\n"), fmt, 255d);
 #  else
-  check.template operator()<fmt>(SV("%d='255'\t%Od='255'\t%e='255'\t%Oe='255'\n"), 255d);
+  check(SV("%d='255'\t%Od='255'\t%e='255'\t%Oe='255'\n"), fmt, 255d);
 #  endif
 #else  // defined(__APPLE__) || defined(_AIX)
-  lcheck.template operator()<lfmt>(loc, SV("%d='00'\t%Od='〇'\t%e=' 0'\t%Oe='〇'\n"), 0d);
-  lcheck.template operator()<lfmt>(loc, SV("%d='01'\t%Od='一'\t%e=' 1'\t%Oe='一'\n"), 1d);
-  lcheck.template operator()<lfmt>(loc, SV("%d='31'\t%Od='三十一'\t%e='31'\t%Oe='三十一'\n"), 31d);
-  lcheck.template operator()<lfmt>(loc, SV("%d='255'\t%Od='255'\t%e='255'\t%Oe='255'\n"), 255d);
+  check(loc, SV("%d='00'\t%Od='〇'\t%e=' 0'\t%Oe='〇'\n"), lfmt, 0d);
+  check(loc, SV("%d='01'\t%Od='一'\t%e=' 1'\t%Oe='一'\n"), lfmt, 1d);
+  check(loc, SV("%d='31'\t%Od='三十一'\t%e='31'\t%Oe='三十一'\n"), lfmt, 31d);
+  check(loc, SV("%d='255'\t%Od='255'\t%e='255'\t%Oe='255'\n"), lfmt, 255d);
 #endif // defined(__APPLE__) || defined(_AIX)
 
   std::locale::global(std::locale::classic());
 }
 
 template <class CharT>
 static void test() {
   using namespace std::literals::chrono_literals;

libcxx/test/std/time/time.syn/formatter_tests.h

 //===----------------------------------------------------------------------===//
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef TEST_STD_TIME_TIME_SYN_FORMATTER_TESTS_H
 #define TEST_STD_TIME_TIME_SYN_FORMATTER_TESTS_H
 
 #include "make_string.h"
 #include "string_literal.h"
+#include "test_format_string.h"
+#include "test_macros.h"
 
 #include <algorithm>
 #include <cassert>
 #include <set>
 #include <string>
 #include <string_view>
 
 #define STR(S) MAKE_STRING(CharT, S)
 #define SV(S) MAKE_STRING_VIEW(CharT, S)
 
 #ifndef TEST_HAS_NO_WIDE_CHARACTERS
 template <class CharT>
 using format_context = std::conditional_t<std::same_as<CharT, char>, std::format_context, std::wformat_context>;
 #else
 template <class CharT>
 using format_context = std::format_context;
 #endif
 
-inline constexpr auto check = []<string_literal fmt, class CharT, class... Args>(
-    std::basic_string_view<CharT> expected, const Args&... args) constexpr {
-  std::basic_string<CharT> out = std::format(fmt.template sv<CharT>(), args...);
+template <class CharT, class... Args>
+void check(std::basic_string_view<CharT> expected, test_format_string<CharT, Args...> fmt, Args&&... args) {
+  std::basic_string<CharT> out = std::format(fmt, std::forward<Args>(args)...);
   if constexpr (std::same_as<CharT, char>)
     if (out != expected)
-      std::cerr << "\nFormat string   " << fmt.template sv<CharT>() << "\nExpected output " << expected
-                << "\nActual output   " << out << '\n';
+      std::cerr << "\nFormat string   " << fmt.get() << "\nExpected output " << expected << "\nActual output   " << out
+                << '\n';
   assert(out == expected);
-};
+}
 
-inline constexpr auto lcheck = []<string_literal fmt, class CharT, class... Args>(
-    const std::locale& loc, std::basic_string_view<CharT> expected, const Args&... args) constexpr {
-  std::basic_string<CharT> out = std::format(loc, fmt.template sv<CharT>(), args...);
+template <class CharT, class... Args>
+void check(const std::locale& loc,
+           std::basic_string_view<CharT> expected,
+           test_format_string<CharT, Args...> fmt,
+           Args&&... args) {
+  std::basic_string<CharT> out = std::format(loc, fmt, std::forward<Args>(args)...);
   if constexpr (std::same_as<CharT, char>)
     if (out != expected)
-      std::cerr << "\nFormat string   " << fmt.template sv<CharT>() << "\nExpected output " << expected
-                << "\nActual output   " << out << '\n';
+      std::cerr << "\nFormat string   " << fmt.get() << "\nExpected output " << expected << "\nActual output   " << out
+                << '\n';
   assert(out == expected);
-};
+}
 
-inline constexpr auto check_exception =
-    []<class CharT, class... Args>(
-        [[maybe_unused]] std::string_view what,
+template <class CharT, class... Args>
+void check_exception([[maybe_unused]] std::string_view what,
                      [[maybe_unused]] std::basic_string_view<CharT> fmt,
                      [[maybe_unused]] const Args&... args) {
 #ifndef TEST_HAS_NO_EXCEPTIONS
-      try {
-        TEST_IGNORE_NODISCARD std::vformat(fmt, std::make_format_args<format_context<CharT>>(args...));
-        if constexpr (std::same_as<CharT, char>)
-          std::cerr << "\nFormat string   " << fmt << "\nDidn't throw an exception.\n";
-        assert(false);
-      } catch (const std::format_error& e) {
 #  if defined(_LIBCPP_VERSION)
-        if constexpr (std::same_as<CharT, char>)
-          if (e.what() != what)
-            std::cerr << "\nFormat string   " << fmt << "\nExpected exception " << what << "\nActual exception   "
-                      << e.what() << '\n';
-        assert(e.what() == what);
 #  endif
-        return;
-      }
-      assert(false);
 #endif
-    };
+}
 
 template <class CharT, class T>
 void check_invalid_type(const std::set<std::basic_string_view<CharT>>& valid_types,
                         std::string_view what,
                         std::basic_string<CharT> type,
                         const T& arg) {
   std::basic_string<CharT> fmt{STR("{:%") + type + STR("}")};
 

libcxx/test/support/test_format_string.h

+// -*- C++ -*-
+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef SUPPORT_TEST_FORMAT_STRING_HPP
+#define SUPPORT_TEST_FORMAT_STRING_HPP
+
+#include <concepts>
+#include <format>
+#include <type_traits>
+
+#include "test_macros.h"
+
+#if TEST_STD_VER < 20
+#  error "The format header requires at least C++20"
+#endif
+
+// Wrapper for basic_format_string.
+//
+// This layer of indirection is used since it's not possible to use
+// std::basic_format_string<CharT, Args...> in the test function directly.
+//
+// In C++20 the basic-format-string was an exposition only type. In C++23 is
+// has been replaced with basic_format_string. Both libc++ and MSVC STL offer
+// it as an extension in C++20.
+#if TEST_STD_VER > 20 || defined(_LIBCPP_VERSION) || defined(_MSVC_STL_VERSION)
+#  ifndef TEST_HAS_NO_WIDE_CHARACTERS
+template <class CharT, class... Args>
+using test_format_string =
+    std::conditional_t<std::same_as<CharT, char>, std::format_string<Args...>, std::wformat_string<Args...>>;
+#  else
+template <class CharT, class... Args>
+using test_format_string = std::format_string<Args...>;
+#  endif
+
+#else // TEST_STD_VER > 20 || defined(_LIBCPP_VERSION) || defined( _MSVC_STL_VERSION)
+
+#  error
+"Please create a vendor specific version of the test typedef and file a review at https://reviews.llvm.org/"
+
+#endif // TEST_STD_VER > 20 || defined(_LIBCPP_VERSION) || defined( _MSVC_STL_VERSION)
+
+#endif // SUPPORT_TEST_FORMAT_STRING_HPP