diff --git a/libcxx/docs/Status/FormatPaper.csv b/libcxx/docs/Status/FormatPaper.csv --- a/libcxx/docs/Status/FormatPaper.csv +++ b/libcxx/docs/Status/FormatPaper.csv @@ -33,5 +33,5 @@ `[format.range] `_,"Formatting for ranges: sequences",,Mark de Wever,|In Progress|, `[format.range] `_,"Formatting for ranges: associative",,Mark de Wever,, `[format.range] `_,"Formatting for ranges: container adaptors",,Mark de Wever,, -`[format.range] `_,"Formatting for ranges: ``pair`` and ``tuple``",,Mark de Wever,|In Progress|, +`[format.range] `_,"Formatting for ranges: ``pair`` and ``tuple``",,Mark de Wever,|Complete|,Clang 16 `[format.range] `_,"Formatting for ranges: ``vector``",,Mark de Wever,, diff --git a/libcxx/include/CMakeLists.txt b/libcxx/include/CMakeLists.txt --- a/libcxx/include/CMakeLists.txt +++ b/libcxx/include/CMakeLists.txt @@ -309,6 +309,7 @@ __format/formatter_output.h __format/formatter_pointer.h __format/formatter_string.h + __format/formatter_tuple.h __format/parser_std_format_spec.h __format/unicode.h __functional/binary_function.h diff --git a/libcxx/include/__chrono/statically_widen.h b/libcxx/include/__chrono/statically_widen.h --- a/libcxx/include/__chrono/statically_widen.h +++ b/libcxx/include/__chrono/statically_widen.h @@ -26,7 +26,7 @@ # ifndef _LIBCPP_HAS_NO_WIDE_CHARACTERS template <__fmt_char_type _CharT> -consteval const _CharT* __statically_widen(const char* __str, const wchar_t* __wstr) { +constexpr const _CharT* __statically_widen(const char* __str, const wchar_t* __wstr) { if constexpr (same_as<_CharT, char>) return __str; else diff --git a/libcxx/include/__format/formatter.h b/libcxx/include/__format/formatter.h --- a/libcxx/include/__format/formatter.h +++ b/libcxx/include/__format/formatter.h @@ -38,6 +38,15 @@ formatter& operator=(const formatter&) = delete; }; +# if _LIBCPP_STD_VER > 20 + +template +constexpr void __set_debug_format(_Tp& __formatter) { + if constexpr (requires { __formatter.set_debug_format(); }) + __formatter.set_debug_format(); +} + +# endif //_LIBCPP_STD_VER > 20 #endif //_LIBCPP_STD_VER > 17 _LIBCPP_END_NAMESPACE_STD diff --git a/libcxx/include/__format/formatter_tuple.h b/libcxx/include/__format/formatter_tuple.h new file mode 100644 --- /dev/null +++ b/libcxx/include/__format/formatter_tuple.h @@ -0,0 +1,159 @@ +// -*- 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 _LIBCPP___FORMAT_FORMATTER_TUPLE_H +#define _LIBCPP___FORMAT_FORMATTER_TUPLE_H + +#include <__algorithm/ranges_copy.h> +#include <__availability> +#include <__chrono/statically_widen.h> +#include <__config> +#include <__format/concepts.h> +#include <__format/format_args.h> +#include <__format/format_context.h> +#include <__format/format_error.h> +#include <__format/format_parse_context.h> +#include <__format/formatter.h> +#include <__format/formatter_output.h> +#include <__format/parser_std_format_spec.h> +#include <__type_traits/remove_cvref.h> +#include <__utility/pair.h> +#include +#include + +#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER) +# pragma GCC system_header +#endif + +_LIBCPP_BEGIN_NAMESPACE_STD + +#if _LIBCPP_STD_VER > 20 + +template <__fmt_char_type _CharT, class _Tuple, formattable<_CharT>... _Args> +struct _LIBCPP_TEMPLATE_VIS _LIBCPP_AVAILABILITY_FORMAT __formatter_tuple { + _LIBCPP_HIDE_FROM_ABI constexpr void set_separator(basic_string_view<_CharT> __separator) { + __separator_ = __separator; + } + _LIBCPP_HIDE_FROM_ABI constexpr void + set_brackets(basic_string_view<_CharT> __opening_bracket, basic_string_view<_CharT> __closing_bracket) { + __opening_bracket_ = __opening_bracket; + __closing_bracket_ = __closing_bracket; + } + + template + _LIBCPP_HIDE_FROM_ABI constexpr typename _ParseContext::iterator parse(_ParseContext& __parse_ctx) { + const _CharT* __begin = __parser_.__parse(__parse_ctx, __format_spec::__fields_tuple); + const _CharT* __end = __parse_ctx.end(); + if (__begin == __end) + return __begin; + + if (*__begin == _CharT('m')) { + if constexpr (sizeof...(_Args) == 2) { + set_separator(_LIBCPP_STATICALLY_WIDEN(_CharT, ": ")); + set_brackets({}, {}); + ++__begin; + if (__begin == __end) + return __begin; + } else + std::__throw_format_error("The tuple-format-spec type m requires two elements"); + } + + // TODO FMT n and m cannot be combined here but can for a range-formatter! + if (*__begin == _CharT('n')) { + set_brackets({}, {}); + ++__begin; + } + + // [format.tuple]/7 + // ... For each element e in underlying_­, if e.set_­debug_format() + // is a valid expression, calls e.set_debug_format(). + [&](index_sequence<__I...>) { + (std::__set_debug_format(std::get<__I>(__underlying_)), ...); + }(std::make_index_sequence< sizeof...(_Args)>()); + + if (__begin != __end && *__begin != _CharT('}')) + std::__throw_format_error("The format-spec should consume the input or end with a '}'"); + + return __begin; + } + + template + typename _FormatContext::iterator + format(conditional_t<(formattable && ...), const _Tuple&, _Tuple&> __tuple, + _FormatContext& __ctx) const { + return __format(__tuple, __ctx, __parser_.__get_parsed_std_specifications(__ctx)); + } + + template + typename _FormatContext::iterator + __format(auto&& __tuple, _FormatContext& __ctx, __format_spec::__parsed_specifications<_CharT> __specs) const { + if (!__specs.__has_width()) + return __format_tuple(__tuple, __ctx); + + basic_string<_CharT> __str; + + // Since the output is written to a different iterator a new context is + // created. Since the underlying formatter uses the default formatting it + // doesn't need a locale or the formatting arguments. So creating a new + // context works. + // + // This solution works for this formatter, but it will not work for the + // range_formatter. In that patch a generic solution is work in progress. + // Once that is finished it can be used here. (The range_formatter will use + // these features so it's easier to add it there and then port it.) + // + // TODO FMT Use formatting wrapping used in the range_formatter. + basic_format_context __c = std::__format_context_create( + back_insert_iterator{__str}, + basic_format_args>, _CharT>>{}); + + __format_tuple(__tuple, __c); + + return __formatter::__write_string_no_precision(basic_string_view{__str}, __ctx.out(), __specs); + } + + template + typename _FormatContext::iterator __format_tuple(auto&& __tuple, _FormatContext& __ctx) const { + __ctx.advance_to(std::ranges::copy(__opening_bracket_, __ctx.out()).out); + + [&](index_sequence<__I...>) { + ( + [&]() { + if constexpr (__II) + __ctx.advance_to(std::ranges::copy(__separator_, __ctx.out()).out); + + __ctx.advance_to(std::get<__II>(__underlying_).format(std::get<__II>(__tuple), __ctx)); + }.template operator()<__I>(), + ...); + }(std::make_index_sequence< sizeof...(_Args)>()); + + return std::ranges::copy(__closing_bracket_, __ctx.out()).out; + } + __format_spec::__parser<_CharT> __parser_; + +private: + tuple, _CharT>...> __underlying_; + basic_string_view<_CharT> __separator_ = _LIBCPP_STATICALLY_WIDEN(_CharT, ", "); + basic_string_view<_CharT> __opening_bracket_ = _LIBCPP_STATICALLY_WIDEN(_CharT, "("); + basic_string_view<_CharT> __closing_bracket_ = _LIBCPP_STATICALLY_WIDEN(_CharT, ")"); +}; + +template <__fmt_char_type _CharT, formattable<_CharT>... _Args> +struct _LIBCPP_TEMPLATE_VIS _LIBCPP_AVAILABILITY_FORMAT formatter, _CharT> + : public __formatter_tuple<_CharT, pair<_Args...>, _Args...> {}; + +template <__fmt_char_type _CharT, formattable<_CharT>... _Args> +struct _LIBCPP_TEMPLATE_VIS _LIBCPP_AVAILABILITY_FORMAT formatter, _CharT> + : public __formatter_tuple<_CharT, tuple<_Args...>, _Args...> {}; + +#endif //_LIBCPP_STD_VER > 20 + +_LIBCPP_END_NAMESPACE_STD + +#endif // _LIBCPP___FORMAT_FORMATTER_TUPLE_H diff --git a/libcxx/include/__format/parser_std_format_spec.h b/libcxx/include/__format/parser_std_format_spec.h --- a/libcxx/include/__format/parser_std_format_spec.h +++ b/libcxx/include/__format/parser_std_format_spec.h @@ -103,6 +103,14 @@ uint8_t __precision_ : 1 {false}; uint8_t __locale_specific_form_ : 1 {false}; uint8_t __type_ : 1 {false}; + // Is the fill a range-fill? + // + // When not set it is a normal fill. The difference is whether or not ':' is + // a valid fill character. + // Note tuple-fill is the same as range-fill and has no separate type. + uint8_t __use_range_fill_ : 1 {false}; + + // TODO FMT We're now at 7 fields, should we increase the size for ABI reasons? }; // By not placing this constant in the formatter class it's not duplicated for @@ -123,6 +131,10 @@ inline constexpr __fields __fields_string{.__precision_ = true, .__type_ = true}; inline constexpr __fields __fields_pointer{.__type_ = true}; +# if _LIBCPP_STD_VER > 20 +inline constexpr __fields __fields_tuple{.__type_ = false, .__use_range_fill_ = true}; +# endif + enum class _LIBCPP_ENUM_VIS __alignment : uint8_t { /// No alignment is set in the format string. __default, @@ -251,7 +263,7 @@ if (__begin == __end) return __begin; - if (__parse_fill_align(__begin, __end) && __begin == __end) + if (__parse_fill_align(__begin, __end, __fields.__use_range_fill_) && __begin == __end) return __begin; if (__fields.__sign_ && __parse_sign(__begin) && __begin == __end) @@ -359,13 +371,17 @@ return false; } - _LIBCPP_HIDE_FROM_ABI constexpr bool __parse_fill_align(const _CharT*& __begin, const _CharT* __end) { + // range-fill and tuple-fill are identical + _LIBCPP_HIDE_FROM_ABI constexpr bool + __parse_fill_align(const _CharT*& __begin, const _CharT* __end, bool __use_range_fill_) { _LIBCPP_ASSERT(__begin != __end, "when called with an empty input the function will cause " "undefined behavior by evaluating data not in the input"); if (__begin + 1 != __end) { if (__parse_alignment(*(__begin + 1))) { - if (*__begin == _CharT('{') || *__begin == _CharT('}')) - __throw_format_error("The format-spec fill field contains an invalid character"); + if (__use_range_fill_ && (*__begin == _CharT('{') || *__begin == _CharT('}') || *__begin == _CharT(':'))) + std::__throw_format_error("The format-spec range-fill field contains an invalid character"); + else if (*__begin == _CharT('{') || *__begin == _CharT('}')) + std::__throw_format_error("The format-spec fill field contains an invalid character"); __fill_ = *__begin; __begin += 2; diff --git a/libcxx/include/format b/libcxx/include/format --- a/libcxx/include/format +++ b/libcxx/include/format @@ -162,6 +162,7 @@ #include <__format/formatter_integer.h> #include <__format/formatter_pointer.h> #include <__format/formatter_string.h> +#include <__format/formatter_tuple.h> #include <__format/parser_std_format_spec.h> #include <__format/unicode.h> diff --git a/libcxx/include/module.modulemap.in b/libcxx/include/module.modulemap.in --- a/libcxx/include/module.modulemap.in +++ b/libcxx/include/module.modulemap.in @@ -324,10 +324,16 @@ private header "__algorithm/ranges_clamp.h" export functional.__functional.ranges_operations } - module ranges_copy { private header "__algorithm/ranges_copy.h" } + module ranges_copy { + private header "__algorithm/ranges_copy.h" + export std.algorithm.__algorithm.in_out_result + } module ranges_copy_backward { private header "__algorithm/ranges_copy_backward.h" } module ranges_copy_if { private header "__algorithm/ranges_copy_if.h" } - module ranges_copy_n { private header "__algorithm/ranges_copy_n.h" } + module ranges_copy_n { + private header "__algorithm/ranges_copy_n.h" + export std.algorithm.__algorithm.in_out_result + } module ranges_count { private header "__algorithm/ranges_count.h" } module ranges_count_if { private header "__algorithm/ranges_count_if.h" } module ranges_equal { private header "__algorithm/ranges_equal.h" } @@ -772,6 +778,7 @@ module formatter_output { private header "__format/formatter_output.h" } module formatter_pointer { private header "__format/formatter_pointer.h" } module formatter_string { private header "__format/formatter_string.h" } + module formatter_tuple { private header "__format/formatter_tuple.h" } module parser_std_format_spec { private header "__format/parser_std_format_spec.h" } module unicode { private header "__format/unicode.h" } } diff --git a/libcxx/test/libcxx/private_headers.verify.cpp b/libcxx/test/libcxx/private_headers.verify.cpp --- a/libcxx/test/libcxx/private_headers.verify.cpp +++ b/libcxx/test/libcxx/private_headers.verify.cpp @@ -341,6 +341,7 @@ #include <__format/formatter_output.h> // expected-error@*:* {{use of private header from outside its module: '__format/formatter_output.h'}} #include <__format/formatter_pointer.h> // expected-error@*:* {{use of private header from outside its module: '__format/formatter_pointer.h'}} #include <__format/formatter_string.h> // expected-error@*:* {{use of private header from outside its module: '__format/formatter_string.h'}} +#include <__format/formatter_tuple.h> // expected-error@*:* {{use of private header from outside its module: '__format/formatter_tuple.h'}} #include <__format/parser_std_format_spec.h> // expected-error@*:* {{use of private header from outside its module: '__format/parser_std_format_spec.h'}} #include <__format/unicode.h> // expected-error@*:* {{use of private header from outside its module: '__format/unicode.h'}} #include <__functional/binary_function.h> // expected-error@*:* {{use of private header from outside its module: '__functional/binary_function.h'}} diff --git a/libcxx/test/std/utilities/format/format.formattable/concept.formattable.compile.pass.cpp b/libcxx/test/std/utilities/format/format.formattable/concept.formattable.compile.pass.cpp --- a/libcxx/test/std/utilities/format/format.formattable/concept.formattable.compile.pass.cpp +++ b/libcxx/test/std/utilities/format/format.formattable/concept.formattable.compile.pass.cpp @@ -221,8 +221,8 @@ assert_is_not_formattable, CharT>(); - assert_is_not_formattable, CharT>(); - assert_is_not_formattable, CharT>(); + assert_is_formattable, CharT>(); + assert_is_formattable, CharT>(); } class c { diff --git a/libcxx/test/std/utilities/format/format.functions/format_tests.h b/libcxx/test/std/utilities/format/format.functions/format_tests.h --- a/libcxx/test/std/utilities/format/format.functions/format_tests.h +++ b/libcxx/test/std/utilities/format/format.functions/format_tests.h @@ -206,7 +206,8 @@ check(SV("hello _world__"), SV("hello {:_^8}"), world); check(SV("hello world___"), SV("hello {:_<8}"), world); - check(SV("hello >>>world"), SV("hello {:>>8}"), world); + // The fill character ':' is allowed here (P0645) but not in ranges (P2286). + check(SV("hello :::world"), SV("hello {::>8}"), world); check(SV("hello <<8}"), world); check(SV("hello ^^^world"), SV("hello {:^>8}"), world); @@ -440,9 +441,10 @@ check(SV("answer is 'false '"), SV("answer is '{:<8s}'"), false); check(SV("answer is ' false '"), SV("answer is '{:^8s}'"), false); - check(SV("answer is '---true'"), SV("answer is '{:->7}'"), true); - check(SV("answer is 'true---'"), SV("answer is '{:-<7}'"), true); - check(SV("answer is '-true--'"), SV("answer is '{:-^7}'"), true); + // The fill character ':' is allowed here (P0645) but not in ranges (P2286). + check(SV("answer is ':::true'"), SV("answer is '{::>7}'"), true); + check(SV("answer is 'true:::'"), SV("answer is '{::<7}'"), true); + check(SV("answer is ':true::'"), SV("answer is '{::^7}'"), true); check(SV("answer is '---false'"), SV("answer is '{:->8s}'"), false); check(SV("answer is 'false---'"), SV("answer is '{:-<8s}'"), false); @@ -494,9 +496,10 @@ check(SV("answer is '1 '"), SV("answer is '{:<6d}'"), true); check(SV("answer is ' 1 '"), SV("answer is '{:^6d}'"), true); - check(SV("answer is '*****0'"), SV("answer is '{:*>6d}'"), false); - check(SV("answer is '0*****'"), SV("answer is '{:*<6d}'"), false); - check(SV("answer is '**0***'"), SV("answer is '{:*^6d}'"), false); + // The fill character ':' is allowed here (P0645) but not in ranges (P2286). + check(SV("answer is ':::::0'"), SV("answer is '{::>6d}'"), false); + check(SV("answer is '0:::::'"), SV("answer is '{::<6d}'"), false); + check(SV("answer is '::0:::'"), SV("answer is '{::^6d}'"), false); // Test whether zero padding is ignored check(SV("answer is ' 1'"), SV("answer is '{:>06d}'"), true); @@ -580,9 +583,10 @@ check(SV("answer is '42 '"), SV("answer is '{:<7}'"), I(42)); check(SV("answer is ' 42 '"), SV("answer is '{:^7}'"), I(42)); - check(SV("answer is '*****42'"), SV("answer is '{:*>7}'"), I(42)); - check(SV("answer is '42*****'"), SV("answer is '{:*<7}'"), I(42)); - check(SV("answer is '**42***'"), SV("answer is '{:*^7}'"), I(42)); + // The fill character ':' is allowed here (P0645) but not in ranges (P2286). + check(SV("answer is ':::::42'"), SV("answer is '{::>7}'"), I(42)); + check(SV("answer is '42:::::'"), SV("answer is '{::<7}'"), I(42)); + check(SV("answer is '::42:::'"), SV("answer is '{::^7}'"), I(42)); // Test whether zero padding is ignored check(SV("answer is ' 42'"), SV("answer is '{:>07}'"), I(42)); @@ -708,9 +712,10 @@ check(SV("answer is '* '"), SV("answer is '{:<6c}'"), I(42)); check(SV("answer is ' * '"), SV("answer is '{:^6c}'"), I(42)); - check(SV("answer is '-----*'"), SV("answer is '{:->6c}'"), I(42)); - check(SV("answer is '*-----'"), SV("answer is '{:-<6c}'"), I(42)); - check(SV("answer is '--*---'"), SV("answer is '{:-^6c}'"), I(42)); + // The fill character ':' is allowed here (P0645) but not in ranges (P2286). + check(SV("answer is ':::::*'"), SV("answer is '{::>6c}'"), I(42)); + check(SV("answer is '*:::::'"), SV("answer is '{::<6c}'"), I(42)); + check(SV("answer is '::*:::'"), SV("answer is '{::^6c}'"), I(42)); // *** Sign *** check(SV("answer is *"), SV("answer is {:c}"), I(42)); @@ -893,9 +898,10 @@ check(SV("answer is '* '"), SV("answer is '{:<6c}'"), CharT('*')); check(SV("answer is ' * '"), SV("answer is '{:^6c}'"), CharT('*')); - check(SV("answer is '-----*'"), SV("answer is '{:->6}'"), CharT('*')); - check(SV("answer is '*-----'"), SV("answer is '{:-<6}'"), CharT('*')); - check(SV("answer is '--*---'"), SV("answer is '{:-^6}'"), CharT('*')); + // The fill character ':' is allowed here (P0645) but not in ranges (P2286). + check(SV("answer is ':::::*'"), SV("answer is '{::>6}'"), CharT('*')); + check(SV("answer is '*:::::'"), SV("answer is '{::<6}'"), CharT('*')); + check(SV("answer is '::*:::'"), SV("answer is '{::^6}'"), CharT('*')); check(SV("answer is '-----*'"), SV("answer is '{:->6c}'"), CharT('*')); check(SV("answer is '*-----'"), SV("answer is '{:-<6c}'"), CharT('*')); @@ -955,9 +961,10 @@ check(SV("answer is '42 '"), SV("answer is '{:<7d}'"), CharT('*')); check(SV("answer is ' 42 '"), SV("answer is '{:^7d}'"), CharT('*')); - check(SV("answer is '*****42'"), SV("answer is '{:*>7d}'"), CharT('*')); - check(SV("answer is '42*****'"), SV("answer is '{:*<7d}'"), CharT('*')); - check(SV("answer is '**42***'"), SV("answer is '{:*^7d}'"), CharT('*')); + // The fill character ':' is allowed here (P0645) but not in ranges (P2286). + check(SV("answer is ':::::42'"), SV("answer is '{::>7d}'"), CharT('*')); + check(SV("answer is '42:::::'"), SV("answer is '{::<7d}'"), CharT('*')); + check(SV("answer is '::42:::'"), SV("answer is '{::^7d}'"), CharT('*')); // Test whether zero padding is ignored check(SV("answer is ' 42'"), SV("answer is '{:>07d}'"), CharT('*')); @@ -1029,9 +1036,10 @@ check(SV("answer is '1p-2 '"), SV("answer is '{:<7a}'"), F(0.25)); check(SV("answer is ' 1p-2 '"), SV("answer is '{:^7a}'"), F(0.25)); - check(SV("answer is '---1p-3'"), SV("answer is '{:->7a}'"), F(125e-3)); - check(SV("answer is '1p-3---'"), SV("answer is '{:-<7a}'"), F(125e-3)); - check(SV("answer is '-1p-3--'"), SV("answer is '{:-^7a}'"), F(125e-3)); + // The fill character ':' is allowed here (P0645) but not in ranges (P2286). + check(SV("answer is ':::1p-3'"), SV("answer is '{::>7a}'"), F(125e-3)); + check(SV("answer is '1p-3:::'"), SV("answer is '{::<7a}'"), F(125e-3)); + check(SV("answer is ':1p-3::'"), SV("answer is '{::^7a}'"), F(125e-3)); check(SV("answer is '***inf'"), SV("answer is '{:*>6a}'"), std::numeric_limits::infinity()); check(SV("answer is 'inf***'"), SV("answer is '{:*<6a}'"), std::numeric_limits::infinity()); @@ -2591,9 +2599,10 @@ check(SV("answer is '0x0 '"), SV("answer is '{:<6}'"), P(nullptr)); check(SV("answer is ' 0x0 '"), SV("answer is '{:^6}'"), P(nullptr)); - check(SV("answer is '---0x0'"), SV("answer is '{:->6}'"), P(nullptr)); - check(SV("answer is '0x0---'"), SV("answer is '{:-<6}'"), P(nullptr)); - check(SV("answer is '-0x0--'"), SV("answer is '{:-^6}'"), P(nullptr)); + // The fill character ':' is allowed here (P0645) but not in ranges (P2286). + check(SV("answer is ':::0x0'"), SV("answer is '{::>6}'"), P(nullptr)); + check(SV("answer is '0x0:::'"), SV("answer is '{::<6}'"), P(nullptr)); + check(SV("answer is ':0x0::'"), SV("answer is '{::^6}'"), P(nullptr)); // *** Sign *** check_exception("The format-spec should consume the input or end with a '}'", SV("{:-}"), P(nullptr)); diff --git a/libcxx/test/std/utilities/format/format.tuple/format.pass.cpp b/libcxx/test/std/utilities/format/format.tuple/format.pass.cpp new file mode 100644 --- /dev/null +++ b/libcxx/test/std/utilities/format/format.tuple/format.pass.cpp @@ -0,0 +1,50 @@ +//===----------------------------------------------------------------------===// +// 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 +// +//===----------------------------------------------------------------------===// + +// UNSUPPORTED: c++03, c++11, c++14, c++17, c++20 +// UNSUPPORTED: libcpp-has-no-incomplete-format + +#include +#include + +#include "test_macros.h" +#include "format_tests.h" +#include "test_format_string.h" + +#ifndef TEST_HAS_NO_LOCALIZATION +# include +# include +#endif + +auto check = []( + std::basic_string_view expected, test_format_string fmt, Args&&... args) { + std::basic_string out = std::format(fmt, std::forward(args)...); +#ifndef TEST_HAS_NO_LOCALIZATION + if constexpr (std::same_as) + if (out != expected) + std::cerr << "\nFormat string " << fmt.get() << "\nExpected output " << expected << "\nActual output " << out + << '\n'; +#endif // TEST_HAS_NO_LOCALIZATION + assert(out == expected); +}; + +auto check_exception = [](std::string_view, std::basic_string_view, Args&&...) { + // After P2216 most exceptions thrown by std::format become ill-formed. + // Therefore this tests does nothing. + // A basic ill-formed test is done in format.verify.cpp + // The exceptions are tested by other functions that don't use the basic-format-string as fmt argument. +}; + +int main(int, char**) { + test(check, check_exception); + +#ifndef TEST_HAS_NO_WIDE_CHARACTERS + test(check, check_exception); +#endif + + return 0; +} diff --git a/libcxx/test/std/utilities/format/format.tuple/format.verify.cpp b/libcxx/test/std/utilities/format/format.tuple/format.verify.cpp new file mode 100644 --- /dev/null +++ b/libcxx/test/std/utilities/format/format.tuple/format.verify.cpp @@ -0,0 +1,51 @@ +//===----------------------------------------------------------------------===// +// 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 +// +//===----------------------------------------------------------------------===// + +// UNSUPPORTED: c++03, c++11, c++14, c++17, c++20 +// UNSUPPORTED: libcpp-has-no-incomplete-format + +#include + +#include +#include + +#include "test_macros.h" + +// clang-format off + +void f() { + std::format("{::}", std::make_tuple(0)); // expected-error-re{{call to consteval function '{{.*}}' is not a constant expression}} + // expected-note@*:* {{non-constexpr function '__throw_format_error' cannot be used in a constant expression}} + + std::format("{::^}", std::make_tuple(0)); // expected-error-re{{call to consteval function '{{.*}}' is not a constant expression}} + // expected-note@*:* {{non-constexpr function '__throw_format_error' cannot be used in a constant expression}} + + std::format("{:+}", std::make_pair(0, 0)); // expected-error-re{{call to consteval function '{{.*}}' is not a constant expression}} + // expected-note@*:* {{non-constexpr function '__throw_format_error' cannot be used in a constant expression}} + + std::format("{:m}", std::make_tuple(0)); // expected-error-re{{call to consteval function '{{.*}}' is not a constant expression}} + // expected-note@*:* {{non-constexpr function '__throw_format_error' cannot be used in a constant expression}} + + std::format("{:m}", std::make_tuple(0, 0, 0)); // expected-error-re{{call to consteval function '{{.*}}' is not a constant expression}} + // expected-note@*:* {{non-constexpr function '__throw_format_error' cannot be used in a constant expression}} +#ifndef TEST_HAS_NO_WIDE_CHARACTERS + std::format(L"{::}", std::make_tuple(0)); // expected-error-re{{call to consteval function '{{.*}}' is not a constant expression}} + // expected-note@*:* {{non-constexpr function '__throw_format_error' cannot be used in a constant expression}} + + std::format(L"{::^}", std::make_tuple(0)); // expected-error-re{{call to consteval function '{{.*}}' is not a constant expression}} + // expected-note@*:* {{non-constexpr function '__throw_format_error' cannot be used in a constant expression}} + + std::format(L"{:+}", std::make_pair(0, 0)); // expected-error-re{{call to consteval function '{{.*}}' is not a constant expression}} + // expected-note@*:* {{non-constexpr function '__throw_format_error' cannot be used in a constant expression}} + + std::format(L"{:m}", std::make_tuple(0)); // expected-error-re{{call to consteval function '{{.*}}' is not a constant expression}} + // expected-note@*:* {{non-constexpr function '__throw_format_error' cannot be used in a constant expression}} + + std::format(L"{:m}", std::make_tuple(0, 0, 0)); // expected-error-re{{call to consteval function '{{.*}}' is not a constant expression}} + // expected-note@*:* {{non-constexpr function '__throw_format_error' cannot be used in a constant expression}} +#endif +} diff --git a/libcxx/test/std/utilities/format/format.tuple/format_tests.h b/libcxx/test/std/utilities/format/format.tuple/format_tests.h new file mode 100644 --- /dev/null +++ b/libcxx/test/std/utilities/format/format.tuple/format_tests.h @@ -0,0 +1,384 @@ +//===----------------------------------------------------------------------===// +// 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_UTILITIES_FORMAT_FORMAT_TUPLE_FORMAT_TESTS_H +#define TEST_STD_UTILITIES_FORMAT_FORMAT_TUPLE_FORMAT_TESTS_H + +#include +#include + +#include "make_string.h" + +#define STR(S) MAKE_STRING(CharT, S) +#define SV(S) MAKE_STRING_VIEW(CharT, S) + +template +struct context {}; + +template <> +struct context { + using type = std::format_context; +}; + +#ifndef TEST_HAS_NO_WIDE_CHARACTERS +template <> +struct context { + using type = std::wformat_context; +}; +#endif + +template +using context_t = typename context::type; + +enum class color { black, red, gold }; + +template +struct std::formatter : std::formatter, CharT> { + static constexpr basic_string_view color_names[] = {SV("black"), SV("red"), SV("gold")}; + auto format(color c, auto& ctx) const { + return formatter, CharT>::format(color_names[static_cast(c)], ctx); + } +}; + +// +// Generic tests for a tuple and pair with two elements. +// +template +void test_tuple_or_pair_int_int(TestFunction check, ExceptionTest check_exception, TupleOrPair&& input) { + check(SV("(42, 99)"), SV("{}"), input); + + // *** align-fill & width *** + check(SV(" (42, 99)"), SV("{:13}"), input); + check(SV("(42, 99)*****"), SV("{:*<13}"), input); + check(SV("__(42, 99)___"), SV("{:_^13}"), input); + check(SV("#####(42, 99)"), SV("{:#>13}"), input); + + check(SV(" (42, 99)"), SV("{:{}}"), input, 13); + check(SV("(42, 99)*****"), SV("{:*<{}}"), input, 13); + check(SV("__(42, 99)___"), SV("{:_^{}}"), input, 13); + check(SV("#####(42, 99)"), SV("{:#>{}}"), input, 13); + + check_exception("The format-spec range-fill field contains an invalid character", SV("{:}<}"), input); + check_exception("The format-spec range-fill field contains an invalid character", SV("{:{<}"), input); + check_exception("The format-spec range-fill field contains an invalid character", SV("{::<}"), input); + + // *** sign *** + check_exception("The format-spec should consume the input or end with a '}'", SV("{:-}"), input); + check_exception("The format-spec should consume the input or end with a '}'", SV("{:+}"), input); + check_exception("The format-spec should consume the input or end with a '}'", SV("{: }"), input); + + // *** alternate form *** + check_exception("The format-spec should consume the input or end with a '}'", SV("{:#}"), input); + + // *** zero-padding *** + check_exception("A format-spec width field shouldn't have a leading zero", SV("{:0}"), input); + + // *** precision *** + check_exception("The format-spec should consume the input or end with a '}'", SV("{:.}"), input); + + // *** locale-specific form *** + check_exception("The format-spec should consume the input or end with a '}'", SV("{:L}"), input); + + // *** type *** + check(SV("__42: 99___"), SV("{:_^11m}"), input); + check(SV("__42, 99___"), SV("{:_^11n}"), input); + + for (CharT c : SV("aAbBcdeEfFgGopsxX?")) { + check_exception("The format-spec should consume the input or end with a '}'", + std::basic_string_view{STR("{:") + c + STR("}")}, + input); + } +} + +template +void test_tuple_or_pair_int_string(TestFunction check, ExceptionTest check_exception, TupleOrPair&& input) { + check(SV("(42, \"hello\")"), SV("{}"), input); + + // *** align-fill & width *** + check(SV(" (42, \"hello\")"), SV("{:18}"), input); + check(SV("(42, \"hello\")*****"), SV("{:*<18}"), input); + check(SV("__(42, \"hello\")___"), SV("{:_^18}"), input); + check(SV("#####(42, \"hello\")"), SV("{:#>18}"), input); + + check(SV(" (42, \"hello\")"), SV("{:{}}"), input, 18); + check(SV("(42, \"hello\")*****"), SV("{:*<{}}"), input, 18); + check(SV("__(42, \"hello\")___"), SV("{:_^{}}"), input, 18); + check(SV("#####(42, \"hello\")"), SV("{:#>{}}"), input, 18); + + check_exception("The format-spec range-fill field contains an invalid character", SV("{:}<}"), input); + check_exception("The format-spec range-fill field contains an invalid character", SV("{:{<}"), input); + check_exception("The format-spec range-fill field contains an invalid character", SV("{::<}"), input); + + // *** sign *** + check_exception("The format-spec should consume the input or end with a '}'", SV("{:-}"), input); + check_exception("The format-spec should consume the input or end with a '}'", SV("{:+}"), input); + check_exception("The format-spec should consume the input or end with a '}'", SV("{: }"), input); + + // *** alternate form *** + check_exception("The format-spec should consume the input or end with a '}'", SV("{:#}"), input); + + // *** zero-padding *** + check_exception("A format-spec width field shouldn't have a leading zero", SV("{:0}"), input); + + // *** precision *** + check_exception("The format-spec should consume the input or end with a '}'", SV("{:.}"), input); + + // *** locale-specific form *** + check_exception("The format-spec should consume the input or end with a '}'", SV("{:L}"), input); + + // *** type *** + check(SV("__42: \"hello\"___"), SV("{:_^16m}"), input); + check(SV("__42, \"hello\"___"), SV("{:_^16n}"), input); + + for (CharT c : SV("aAbBcdeEfFgGopsxX?")) { + check_exception("The format-spec should consume the input or end with a '}'", + std::basic_string_view{STR("{:") + c + STR("}")}, + input); + } +} + +template +void test_escaping(TestFunction check, TupleOrPair&& input) { + static_assert(std::same_as(input))>, CharT>); + static_assert(std::same_as(input))>, std::basic_string>); + + check(SV(R"(('*', ""))"), SV("{}"), input); + + // Char + std::get<0>(input) = CharT('\t'); + check(SV(R"(('\t', ""))"), SV("{}"), input); + std::get<0>(input) = CharT('\n'); + check(SV(R"(('\n', ""))"), SV("{}"), input); + std::get<0>(input) = CharT('\0'); + check(SV(R"(('\u{0}', ""))"), SV("{}"), input); + + // String + std::get<0>(input) = CharT('*'); + std::get<1>(input) = SV("hellö"); + check(SV("('*', \"hellö\")"), SV("{}"), input); + + std::get<1>(input) = SV("hello\u0308"); +#ifndef TEST_HAS_NO_UNICODE + check(SV("('*', \"hello\\u{308}\")"), SV("{}"), input); +#else + check(SV("('*', \"hello\u0308\")"), SV("{}"), input); +#endif + +#ifndef TEST_HAS_NO_UNICODE + std::get<1>(input) = SV("hello 🤷🏻‍♂️"); + check(SV(R"(('*', "hello 🤷🏻\u{200d}♂\u{fe0f}"))"), SV("{}"), input); +#endif +} + +// +// pair tests +// + +template +void test_pair_int_int(TestFunction check, ExceptionTest check_exception) { + test_tuple_or_pair_int_int(check, check_exception, std::make_pair(42, 99)); +} + +template +void test_pair_int_string(TestFunction check, ExceptionTest check_exception) { + test_tuple_or_pair_int_string(check, check_exception, std::make_pair(42, SV("hello"))); +} + +// +// tuple tests +// + +template +void test_tuple_int(TestFunction check, ExceptionTest check_exception) { + const auto input = std::make_tuple(42); + + check(SV("(42)"), SV("{}"), input); + + // *** align-fill & width *** + check(SV(" (42)"), SV("{:9}"), input); + check(SV("(42)*****"), SV("{:*<9}"), input); + check(SV("__(42)___"), SV("{:_^9}"), input); + check(SV("#####(42)"), SV("{:#>9}"), input); + + check(SV(" (42)"), SV("{:{}}"), input, 9); + check(SV("(42)*****"), SV("{:*<{}}"), input, 9); + check(SV("__(42)___"), SV("{:_^{}}"), input, 9); + check(SV("#####(42)"), SV("{:#>{}}"), input, 9); + + check_exception("The format-spec range-fill field contains an invalid character", SV("{:}<}"), input); + check_exception("The format-spec range-fill field contains an invalid character", SV("{:{<}"), input); + check_exception("The format-spec range-fill field contains an invalid character", SV("{::<}"), input); + + // *** sign *** + check_exception("The format-spec should consume the input or end with a '}'", SV("{:-}"), input); + check_exception("The format-spec should consume the input or end with a '}'", SV("{:+}"), input); + check_exception("The format-spec should consume the input or end with a '}'", SV("{: }"), input); + + // *** alternate form *** + check_exception("The format-spec should consume the input or end with a '}'", SV("{:#}"), input); + + // *** zero-padding *** + check_exception("A format-spec width field shouldn't have a leading zero", SV("{:0}"), input); + + // *** precision *** + check_exception("The format-spec should consume the input or end with a '}'", SV("{:.}"), input); + + // *** locale-specific form *** + check_exception("The format-spec should consume the input or end with a '}'", SV("{:L}"), input); + + // *** type *** + check_exception("The tuple-format-spec type m requires two elements", SV("{:m}"), input); + check(SV("__42___"), SV("{:_^7n}"), input); + + for (CharT c : SV("aAbBcdeEfFgGopsxX?")) { + check_exception("The format-spec should consume the input or end with a '}'", + std::basic_string_view{STR("{:") + c + STR("}")}, + input); + } +} + +template +void test_tuple_int_string_color(TestFunction check, ExceptionTest check_exception) { + const auto input = std::make_tuple(42, SV("hello"), color::red); + + check(SV("(42, \"hello\", \"red\")"), SV("{}"), input); + + // *** align-fill & width *** + check(SV(" (42, \"hello\", \"red\")"), SV("{:25}"), input); + check(SV("(42, \"hello\", \"red\")*****"), SV("{:*<25}"), input); + check(SV("__(42, \"hello\", \"red\")___"), SV("{:_^25}"), input); + check(SV("#####(42, \"hello\", \"red\")"), SV("{:#>25}"), input); + + check(SV(" (42, \"hello\", \"red\")"), SV("{:{}}"), input, 25); + check(SV("(42, \"hello\", \"red\")*****"), SV("{:*<{}}"), input, 25); + check(SV("__(42, \"hello\", \"red\")___"), SV("{:_^{}}"), input, 25); + check(SV("#####(42, \"hello\", \"red\")"), SV("{:#>{}}"), input, 25); + + check_exception("The format-spec range-fill field contains an invalid character", SV("{:}<}"), input); + check_exception("The format-spec range-fill field contains an invalid character", SV("{:{<}"), input); + check_exception("The format-spec range-fill field contains an invalid character", SV("{::<}"), input); + + // *** sign *** + check_exception("The format-spec should consume the input or end with a '}'", SV("{:-}"), input); + check_exception("The format-spec should consume the input or end with a '}'", SV("{:+}"), input); + check_exception("The format-spec should consume the input or end with a '}'", SV("{: }"), input); + + // *** alternate form *** + check_exception("The format-spec should consume the input or end with a '}'", SV("{:#}"), input); + + // *** zero-padding *** + check_exception("A format-spec width field shouldn't have a leading zero", SV("{:0}"), input); + + // *** precision *** + check_exception("The format-spec should consume the input or end with a '}'", SV("{:.}"), input); + + // *** locale-specific form *** + check_exception("The format-spec should consume the input or end with a '}'", SV("{:L}"), input); + + // *** type *** + check_exception("The tuple-format-spec type m requires two elements", SV("{:m}"), input); + check(SV("__42, \"hello\", \"red\"___"), SV("{:_^23n}"), input); + + for (CharT c : SV("aAbBcdeEfFgGopsxX?")) { + check_exception("The format-spec should consume the input or end with a '}'", + std::basic_string_view{STR("{:") + c + STR("}")}, + input); + } +} + +template +void test_tuple_int_int(TestFunction check, ExceptionTest check_exception) { + test_tuple_or_pair_int_int(check, check_exception, std::make_tuple(42, 99)); +} + +template +void test_tuple_int_string(TestFunction check, ExceptionTest check_exception) { + test_tuple_or_pair_int_string(check, check_exception, std::make_tuple(42, SV("hello"))); +} + +// +// nested tests +// + +template +void test_nested(TestFunction check, ExceptionTest check_exception, Nested&& input) { + // [format.formatter.spec]/2 + // A debug-enabled specialization of formatter additionally provides a + // public, constexpr, non-static member function set_­debug_­format() + // which modifies the state of the formatter to be as if the type of the + // std-format-spec parsed by the last call to parse were ?. + // pair and tuple are not debug-enabled specializations to the + // set_debug_format is not propagated. + // TODO FMT discuss with Barry. First investigate what std::vector> does + // - Why are pair and tuple always setting debug mode. + // - Is propagation expected? + + check(SV("(42, (hello, red))"), SV("{}"), input); + + // *** align-fill & width *** + check(SV(" (42, (hello, red))"), SV("{:23}"), input); + check(SV("(42, (hello, red))*****"), SV("{:*<23}"), input); + check(SV("__(42, (hello, red))___"), SV("{:_^23}"), input); + check(SV("#####(42, (hello, red))"), SV("{:#>23}"), input); + + check(SV(" (42, (hello, red))"), SV("{:{}}"), input, 23); + check(SV("(42, (hello, red))*****"), SV("{:*<{}}"), input, 23); + check(SV("__(42, (hello, red))___"), SV("{:_^{}}"), input, 23); + check(SV("#####(42, (hello, red))"), SV("{:#>{}}"), input, 23); + + check_exception("The format-spec range-fill field contains an invalid character", SV("{:}<}"), input); + check_exception("The format-spec range-fill field contains an invalid character", SV("{:{<}"), input); + check_exception("The format-spec range-fill field contains an invalid character", SV("{::<}"), input); + + // *** sign *** + check_exception("The format-spec should consume the input or end with a '}'", SV("{:-}"), input); + check_exception("The format-spec should consume the input or end with a '}'", SV("{:+}"), input); + check_exception("The format-spec should consume the input or end with a '}'", SV("{: }"), input); + + // *** alternate form *** + check_exception("The format-spec should consume the input or end with a '}'", SV("{:#}"), input); + + // *** zero-padding *** + check_exception("A format-spec width field shouldn't have a leading zero", SV("{:0}"), input); + + // *** precision *** + check_exception("The format-spec should consume the input or end with a '}'", SV("{:.}"), input); + + // *** locale-specific form *** + check_exception("The format-spec should consume the input or end with a '}'", SV("{:L}"), input); + + // *** type *** + check(SV("__42: (hello, red)___"), SV("{:_^21m}"), input); + check(SV("__42, (hello, red)___"), SV("{:_^21n}"), input); + + for (CharT c : SV("aAbBcdeEfFgGopsxX?")) { + check_exception("The format-spec should consume the input or end with a '}'", + std::basic_string_view{STR("{:") + c + STR("}")}, + input); + } +} + +template +void test(TestFunction check, ExceptionTest check_exception) { + test_pair_int_int(check, check_exception); + test_pair_int_string(check, check_exception); + + test_tuple_int(check, check_exception); + test_tuple_int_int(check, check_exception); + test_tuple_int_string(check, check_exception); + test_tuple_int_string_color(check, check_exception); + + test_nested(check, check_exception, std::make_pair(42, std::make_pair(SV("hello"), color::red))); + test_nested(check, check_exception, std::make_pair(42, std::make_tuple(SV("hello"), color::red))); + test_nested(check, check_exception, std::make_tuple(42, std::make_pair(SV("hello"), color::red))); + test_nested(check, check_exception, std::make_tuple(42, std::make_tuple(SV("hello"), color::red))); + + test_escaping(check, std::make_pair(CharT('*'), STR(""))); + test_escaping(check, std::make_tuple(CharT('*'), STR(""))); +} + +#endif // TEST_STD_UTILITIES_FORMAT_FORMAT_TUPLE_FORMAT_TESTS_H diff --git a/libcxx/test/std/utilities/format/format.tuple/pair.pass.cpp b/libcxx/test/std/utilities/format/format.tuple/pair.pass.cpp new file mode 100644 --- /dev/null +++ b/libcxx/test/std/utilities/format/format.tuple/pair.pass.cpp @@ -0,0 +1,101 @@ +//===----------------------------------------------------------------------===// +// 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 +// +//===----------------------------------------------------------------------===// + +// UNSUPPORTED: c++03, c++11, c++14, c++17, c++20 +// UNSUPPORTED: libcpp-has-no-incomplete-format + +// formatter specialization for pair +// tests the format member function without parsing +// +// These two functions are never tested directly in the format functions: +// - constexpr void set_separator(basic_string_view sep); +// - constexpr void set_brackets(basic_string_view opening, basic_string_view closing); + +#include + +#include +#include +#include +#include +#include + +#include "test_format_context.h" +#include "test_macros.h" +#include "make_string.h" + +#define SV(S) MAKE_STRING_VIEW(CharT, S) + +template +struct settings { + std::optional> separator; + std::optional, std::basic_string_view> > brackets; +}; + +template +static void format(std::basic_string_view expected, settings s, auto arg) { + using T = std::remove_cvref_t; + std::formatter formatter; + static_assert(std::semiregular); + if (s.separator) + formatter.set_separator(*s.separator); + if (s.brackets) + formatter.set_brackets(s.brackets->first, s.brackets->second); + + if (!TEST_IS_CONSTANT_EVALUATED) { + std::basic_string result; + auto out = std::back_inserter(result); + using OutT = decltype(out); + using FormatCtxT = std::basic_format_context; + + FormatCtxT format_ctx = test_format_context_create(out, std::make_format_args(arg)); + formatter.format(arg, format_ctx); + assert(result == expected); + } +} + +template +static void test() { + // Note the debug format is set by parse, which is not called. + // Hence the output is not escaped + format(SV("(*, hello)"), settings{}, std::make_pair(CharT('*'), SV("hello"))); + format(SV("(* - hello)"), settings{.separator = SV(" - ")}, std::make_pair(CharT('*'), SV("hello"))); + format(SV("[--*, hello--]"), + settings{.brackets = std::make_pair(SV("[--"), SV("--]"))}, + std::make_pair(CharT('*'), SV("hello"))); + format(SV("[--* # hello--]"), + settings{.separator = SV(" # "), .brackets = std::make_pair(SV("[--"), SV("--]"))}, + std::make_pair(CharT('*'), SV("hello"))); +} + +// This only verifies the members can be called in constexpr context. There is +// no way to directly test the values set. +constexpr bool test_constexpr() { + { + std::formatter, char> formatter; + formatter.set_separator(": "); + formatter.set_brackets("[", "]"); + } +#ifndef TEST_HAS_NO_WIDE_CHARACTERS + { + std::formatter, wchar_t> formatter; + formatter.set_separator(L": "); + formatter.set_brackets(L"[", L"]"); + } +#endif // TEST_HAS_NO_WIDE_CHARACTERS + + return true; +} + +int main(int, char**) { + test(); +#ifndef TEST_HAS_NO_WIDE_CHARACTERS + test(); +#endif + static_assert(test_constexpr()); + + return 0; +} diff --git a/libcxx/test/std/utilities/format/format.tuple/tuple.pass.cpp b/libcxx/test/std/utilities/format/format.tuple/tuple.pass.cpp new file mode 100644 --- /dev/null +++ b/libcxx/test/std/utilities/format/format.tuple/tuple.pass.cpp @@ -0,0 +1,101 @@ +//===----------------------------------------------------------------------===// +// 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 +// +//===----------------------------------------------------------------------===// + +// UNSUPPORTED: c++03, c++11, c++14, c++17, c++20 +// UNSUPPORTED: libcpp-has-no-incomplete-format + +// formatter specialization for tuple +// tests the format member function without parsing +// +// These two functions are never tested directly in the format functions: +// - constexpr void set_separator(basic_string_view sep); +// - constexpr void set_brackets(basic_string_view opening, basic_string_view closing); + +#include + +#include +#include +#include +#include +#include + +#include "test_format_context.h" +#include "test_macros.h" +#include "make_string.h" + +#define SV(S) MAKE_STRING_VIEW(CharT, S) + +template +struct settings { + std::optional> separator; + std::optional, std::basic_string_view> > brackets; +}; + +template +static void format(std::basic_string_view expected, settings s, auto arg) { + using T = std::remove_cvref_t; + std::formatter formatter; + static_assert(std::semiregular); + if (s.separator) + formatter.set_separator(*s.separator); + if (s.brackets) + formatter.set_brackets(s.brackets->first, s.brackets->second); + + if (!TEST_IS_CONSTANT_EVALUATED) { + std::basic_string result; + auto out = std::back_inserter(result); + using OutT = decltype(out); + using FormatCtxT = std::basic_format_context; + + FormatCtxT format_ctx = test_format_context_create(out, std::make_format_args(arg)); + formatter.format(arg, format_ctx); + assert(result == expected); + } +} + +template +static void test() { + // Note the debug format is set by parse, which is not called. + // Hence the output is not escaped + format(SV("(*, hello)"), settings{}, std::make_tuple(CharT('*'), SV("hello"))); + format(SV("(* - hello)"), settings{.separator = SV(" - ")}, std::make_tuple(CharT('*'), SV("hello"))); + format(SV("[--*, hello--]"), + settings{.brackets = std::make_pair(SV("[--"), SV("--]"))}, + std::make_tuple(CharT('*'), SV("hello"))); + format(SV("[--* # hello--]"), + settings{.separator = SV(" # "), .brackets = std::make_pair(SV("[--"), SV("--]"))}, + std::make_tuple(CharT('*'), SV("hello"))); +} + +// This only verifies the members can be called in constexpr context. There is +// no way to directly test the values set. +constexpr bool test_constexpr() { + { + std::formatter, char> formatter; + formatter.set_separator(": "); + formatter.set_brackets("[", "]"); + } +#ifndef TEST_HAS_NO_WIDE_CHARACTERS + { + std::formatter, wchar_t> formatter; + formatter.set_separator(L": "); + formatter.set_brackets(L"[", L"]"); + } +#endif // TEST_HAS_NO_WIDE_CHARACTERS + + return true; +} + +int main(int, char**) { + test(); +#ifndef TEST_HAS_NO_WIDE_CHARACTERS + test(); +#endif + static_assert(test_constexpr()); + + return 0; +} diff --git a/libcxx/test/std/utilities/format/format.tuple/vformat.pass.cpp b/libcxx/test/std/utilities/format/format.tuple/vformat.pass.cpp new file mode 100644 --- /dev/null +++ b/libcxx/test/std/utilities/format/format.tuple/vformat.pass.cpp @@ -0,0 +1,67 @@ +//===----------------------------------------------------------------------===// +// 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 +// +//===----------------------------------------------------------------------===// + +// UNSUPPORTED: c++03, c++11, c++14, c++17, c++20 +// UNSUPPORTED: libcpp-has-no-incomplete-format + +#include +#include + +#include "test_macros.h" +#include "format_tests.h" + +#ifndef TEST_HAS_NO_LOCALIZATION +# include +# include +#endif + +auto check = []( + std::basic_string_view expected, std::basic_string_view fmt, Args&&... args) { + std::basic_string out = std::vformat(fmt, std::make_format_args>(args...)); +#ifndef TEST_HAS_NO_LOCALIZATION + if constexpr (std::same_as) + if (out != expected) + std::cerr << "\nFormat string " << fmt << "\nExpected output " << expected << "\nActual output " << out + << '\n'; +#endif // TEST_HAS_NO_LOCALIZATION + assert(out == expected); +}; + +auto check_exception = + []( + [[maybe_unused]] std::string_view what, + [[maybe_unused]] std::basic_string_view fmt, + [[maybe_unused]] Args&&... args) { +#ifndef TEST_HAS_NO_EXCEPTIONS + try { + TEST_IGNORE_NODISCARD std::vformat(fmt, std::make_format_args>(args...)); + if constexpr (std::same_as) + std::cerr << "\nFormat string " << fmt << "\nDidn't throw an exception.\n"; + assert(false); + } catch (const std::format_error& e) { +# if defined(_LIBCPP_VERSION) && !defined(TEST_HAS_NO_LOCALIZATION) + if constexpr (std::same_as) + if (e.what() != what) + std::cerr << "\nFormat string " << fmt << "\nExpected exception " << what << "\nActual exception " + << e.what() << '\n'; + assert(e.what() == what); +# endif // defined(_LIBCPP_VERSION) && !defined(TEST_HAS_NO_LOCALIZATION + return; + } + assert(false); +#endif + }; + +int main(int, char**) { + test(check, check_exception); + +#ifndef TEST_HAS_NO_WIDE_CHARACTERS + test(check, check_exception); +#endif + + return 0; +}