Spec-Zone.ru › C++

std::make_format_args, std::make_wformat_args

Определено в заголовочном файле <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>> не удовлетворяет требованиям BasicFormatter для любого Ti в Args.

Программа является ошибочной, если для любого типа Ti в 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 хранит std::basic_format_arg<Context>::handle к t, вместе с дополнительными данными, необходимыми для 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...));
}
 
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(1, 2.0, '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++.

DR Применено к Поведение, как опубликовано Корректное поведение
P2418R2 C++20 объекты, которые не являются const-используемыми или копируемыми
(например, объекты-генераторы) не могут быть отформатированы
разрешить форматирование этих объектов
P2905R2 C++20 make_format_args принимал аргументы-значения ссылок-перенаправлений принимает только ссылки на значения
P2909R4 C++20 char или wchar_t могут быть отформатированы как
значения беззнаковых целых чисел, выходящие за пределы диапазона
кодовые единицы преобразуются в соответствующий
беззнаковый тип перед форматированием
LWG 3631 C++20 cv-квалифицированные аргументы неправильно обрабатывались после P2418R2 обработка исправлена

См. также

basic_format_argsformat_argswformat_args
(C++20)(C++20)(C++20)
класс, предоставляющий доступ ко всем аргументам форматирования
(шаблон класса)
vformat
(C++20)
вариант std::format без шаблонов, использующий тип-стертый вид аргументов
(функция)
vformat_to
(C++20)
вариант std::format_to без шаблонов, использующий тип-стертый вид аргументов
(шаблон функции)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/w/cpp/utility/format/make_format_args

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API