std::make_format_args, std::make_wformat_args

 

C++

编译器支持

自由（freestanding）与宿主（hosted）

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

文本处理库

本地化库

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

格式化库 (C++20)

空终止序列工具

字节字符串

多字节字符串

宽字符串

原生数值转换

to_chars (C++17) to_chars_result (C++17) from_chars (C++17) from_chars_result (C++17) chars_format (C++17)

文本编码标识

text_encoding (C++26)

 

格式化库

标准格式规范

格式化函数

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

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>。

如果 typename Context::template formatter_type<std::remove_const_t<Ti>> 不满足 Args 中任何 Ti 的 BasicFormatter 要求，则行为未定义。

如果 Args 中任何类型 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 的 std::basic_format_arg<Context>::handle，以及 handle::format() 所需的额外数据。

注记

格式化参数对用户定义类型具有引用语义，并且不会延长 args 的生命周期。程序员有责任确保 args 的生命周期长于返回值。通常，结果仅用作格式化函数的参数。

特性测试宏	值	标准	特性
__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)
{
    // Generate formatting string "{} "...
    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 使用也不可复制的对象 (例如生成器类对象) 不可格式化	允许格式化这些对象
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 的非模板变体 (函数模板)