std::make_format_args, std::make_wformat_args

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (C++11)

技术规范

符号索引

外部库

 

工具库

语言支持 类型支持（基本类型、RTTI） 库功能特性测试宏 (C++20) 动态内存管理 程序工具 协程支持 (C++20) 变参数函数 is_constant_evaluated (C++20) is_within_lifetime (C++26) initializer_list (C++11) source_location (C++20) 调试支持 is_debugger_present (C++26) breakpoint_if_debugging (C++26) breakpoint (C++26) 三路比较 three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20)    is_eqis_ltis_lteq (C++20)(C++20)(C++20) is_neqis_gtis_gteq (C++20)(C++20)(C++20)

通用工具 日期和时间 函数对象 格式化库 (C++20) bitset hash (C++11) 关系运算符 (C++20 中弃用) rel_ops::operator!=rel_ops::operator>     rel_ops::operator<=rel_ops::operator>= 整数比较函数 cmp_equalcmp_lesscmp_less_than (C++20)(C++20)(C++20)    cmp_not_equalcmp_greatercmp_greater_than (C++20)(C++20)(C++20) in_range (C++20) 交换与类型运算 swap ranges::swap (C++20) exchange (C++14) declval (C++11) to_underlying (C++23) forward (C++11) forward_like (C++23) move (C++11) move_if_noexcept (C++11) as_const (C++17) 常用词汇类型 pair tuple (C++11) optional (C++17) any (C++17) variant (C++17) tuple_size (C++11) tuple_element (C++11) apply (C++17) make_from_tuple (C++17) expected (C++23) 初等字符串转换 to_chars (C++17) from_chars (C++17) chars_format (C++17) to_chars_result (C++17) from_chars_result (C++17)

 

格式化库

标准格式说明

格式化函数

format (C++20)

format_to (C++20)

format_to_n (C++20)

formatted_size (C++20)

vformat (C++20)

vformat_to (C++20)

格式字符串

basic_format_stringformat_stringwformat_string (C++20)(C++20)(C++20)

runtime_format (C++26)

格式化概念

formattable (C++23)

格式化器

formatter (C++20)

formatter<pair-or-tuple> (C++23)

formatter<range> (C++23)

range_formatter (C++23)

enable_nonlocking_formatter_optimization (C++23)

basic_format_parse_contextformat_parse_contextwformat_parse_context (C++20)(C++20)(C++20)

basic_format_contextformat_contextwformat_context (C++20)(C++20)(C++20)

range_format (C++23)

format_kind (C++23)

格式化参数

basic_format_arg (C++20)

basic_format_arg::handle (C++20)

basic_format_argsformat_argswformat_args (C++20)(C++20)(C++20)

visit_format_arg (C++20) (C++26 中弃用)

make_format_argsmake_wformat_args (C++20)(C++20)

格式错误

format_error (C++20)

 

在标头 <format> 定义
template< class Context = std::format_context, class... Args > /*format-arg-store*/<Context, Args...>     make_format_args( Args&... args );	(1)	(C++20 起)
template< class... Args > /*format-arg-store*/<std::wformat_context, Args...>     make_wformat_args( Args&... args );	(2)	(C++20 起)

返回存储格式化参数的数组，并能隐式转换为 std::basic_format_args<Context> 的对象。

若对于 Args 中的任一 Ti，typename Context::template formatter_type<std::remove_const_t<Ti>> 不符合基本格式化器 (BasicFormatter) 要求，则行为未定义。

若对于 Args 中的任一 Ti，Ti 不满足 __formattable_with<Context> 则程序非良构。

2) 等价于 return std::make_format_args<std::wformat_context>(args...);。

参数

args...

-

用作格式化参数的值

返回值

保有格式化参数的对象。

对于每个 T 类型的参数 t，令 TD 为 std::remove_const_t<std::remove_reference_t<T>>。结果中对应的 std::basic_format_arg 以如下方式确定：

• 若 TD 为 bool 或 Context::char_type，则 std::basic_format_arg 存储 t；
• 否则，若 TD 为 char 且 Context::char_type 为 wchar_t，则 std::basic_format_arg 存储 static_cast<wchar_t>(static_cast<unsigned char>(t))；
• 否则，若 TD 为大小不大于 int 的有符号整数类型，则 std::basic_format_arg 存储 static_cast<int>(t)；
• 否则，若 TD 为大小不大于 unsigned int 的无符号整数类型，则 std::basic_format_arg 存储 static_cast<unsigned int>(t)；
• 否则，若 TD 为大小不大于 long long 的有符号整数类型，则 std::basic_format_arg 存储 static_cast<long long>(t)；
• 否则，若 TD 为大小不大于 unsigned long long 的无符号整数类型，则 std::basic_format_arg 存储 static_cast<unsigned long long>(t)；
• 否则，若 TD 为 float、double 或 long double，则 std::basic_format_arg 存储 t；
• 否则，若 TD 为 std::basic_string_view 或 std::basic_string 的特化且 TD::char_type 为 Context::char_type，则 std::basic_format_arg 存储 std::basic_string_view<Context::char_type>(t.data(), t.size())；
• 否则，若 std::decay_t<TD> 为 Context::char_type* 或 const Context::char_type*，则 std::basic_format_arg 存储 static_cast<const Context::char_type*>(t)；
• 否则，若 std::is_void_v<std::remove_pointer_t<TD>> 为 true 或 std::is_null_pointer_v<TD> 为 true，则 std::basic_format_arg 存储 static_cast<const void*>(t)；
• 否则，std::basic_format_arg 存储指向 t 并且携带 handle::format() 所需的额外数据的 std::basic_format_arg<Context>::handle。

注解

对于用户定义类型，格式化参数拥有引用语义并且不延长其生存期。程序员负责确保该参数存活得比返回值更久。通常结果仅在格式化函数内使用。

功能特性测试宏	值	标准	功能特性
__cpp_lib_format_uchar	202311L	(C++20) (DR)	格式化编码单元为无符号整数

示例

运行此代码

#include <array>
#include <format>
#include <iostream>
#include <string_view>
 
void raw_write_to_log(std::string_view users_fmt, std::format_args&& args)
{
    static int n{};
    std::clog << std::format("{:04} : ", n++) << std::vformat(users_fmt, args) << '\n';
}
 
template<typename... Args>
constexpr void log(Args&&... args)
{
    // 生成格式化字符串 "{} " ……
    std::array<char, sizeof...(Args) * 3 + 1> braces{};
    constexpr const char c[4] = "{} ";
    for (auto i{0uz}; i != braces.size() - 1; ++i)
        braces[i] = c[i % 3];
    braces.back() = '\0';
 
    raw_write_to_log(std::string_view{braces.data()}, std::make_format_args(args...));
}
 
template<typename T>
const T& unmove(T&& x)
{
    return x;
}
 
int main()
{
    log("Number", "of", "arguments", "is", "arbitrary.");
    log("Any type that meets the BasicFormatter requirements", "can be printed.");
    log("For example:", 1, 2.0, '3', "*42*");
 
    raw_write_to_log("{:02} │ {} │ {} │ {}",
                     std::make_format_args(unmove(1), unmove(2.0), unmove('3'), "4"));
}

输出：

0000 : Number of arguments is arbitrary.
0001 : Any type that meets the BasicFormatter requirements can be printed.
0002 : For example: 1 2.0 3 *42*
0003 : 01 │ 2.0 │ 3 │ 4

缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告	应用于	出版时的行为	正确行为
P2418R2	C++20	既非 const 可用亦非可复制的对象（例如 generator 式的对象）不可格式化	允许格式化这些对象
P2905R2	C++20	make_format_args 以转发引用接受右值参数	仅接收左值引用
P2909R4	C++20	char 或 wchar_t 可能被格式化为范围外的无符号整数值	在这种格式化前将编码单元转换为对应的无符号类型
LWG 3631	C++20	P2418R2 错误地处理了 cv 限定的参数	正确处理

参阅

basic_format_argsformat_argswformat_args (C++20)(C++20)(C++20)	提供对所有格式化参数的访问的类 (类模板)
vformat (C++20)	std::format 的使用类型擦除的参数表示的非模板变体 (函数)
vformat_to (C++20)	std::format_to 的使用类型擦除的参数表示的非模板变体 (函数模板)