std::c16rtomb

std::size_t c16rtomb( char* s, char16_t c16, std::mbstate_t* ps );

Преобразует одну кодовую точку из 16-битного представления переменной длины (обычно UTF-16) в узкое многобайтовое представление символа.

Если s не является нулевым указателем и c16 — последняя 16-битная кодовая единица в корректной кодировке переменной длины кодовой точки, функция определяет количество байтов, необходимых для хранения многобайтового представления символа этой кодовой точки (включая любые последовательности переключения и с учётом текущего состояния многобайтового преобразования *ps), и сохраняет многобайтовое представление символа в массиве символов, на первый элемент которого указывает s, при необходимости обновляя *ps. Эта функция может записать не более MB_CUR_MAX байтов.

Если s является нулевым указателем, вызов эквивалентен std::c16rtomb(buf, u'\0', ps) для некоторого внутреннего буфера buf.

Если c16 не является последней кодовой единицей в 16-битном представлении широкого символа, функция не записывает данные в массив, на который указывает s, а обновляет только *ps.

Если c16 является нулевым широким символом u'\0', записывается нулевой байт, которому предшествует любая последовательность переключения, необходимая для восстановления исходного состояния переключения, а параметр состояния преобразования *ps обновляется так, чтобы представить исходное состояние переключения.

Многобайтовая кодировка, используемая этой функцией, определяется текущей активной локалью C.

Параметры

Возвращаемое значение

В случае успеха возвращает количество байтов (включая любые последовательности переключения), записанных в массив символов, на первый элемент которого указывает s. Это значение может быть 0, например при обработке первого char16_t в суррогатной паре.

В случае ошибки (если c16 не является допустимым 16-битным символом) возвращает -1, сохраняет EILSEQ в errno и оставляет *ps в неопределённом состоянии.

Примечания

Стандарт C++ делегирует определение семантики этой функции стандарту C. В опубликованном стандарте C11, в отличие от std::mbrtoc16, которая преобразует многобайтовую кодировку переменной ширины (например, UTF-8) в 16-битную кодировку переменной ширины (например, UTF-16), эта функция может преобразовывать только однокомпонентную 16-битную кодировку, то есть не может преобразовывать UTF-16 в UTF-8, несмотря на то что именно это было изначальной целью функции. Это было исправлено в отчёте об ошибке DR488, опубликованном после C11.

Пример

#include <climits>
#include <clocale>
#include <cuchar>
#include <iomanip>
#include <iostream>
#include <string_view>

int main()
{
    std::setlocale(LC_ALL, "en_US.utf8");
    std::u16string_view strv = u"zß水🍌"; // or z\u00df\u6c34\U0001F34C
    std::cout << "Processing " << strv.size() << " UTF-16 code units: [ ";
    for (char16_t c : strv)
        std::cout << std::showbase << std::hex << static_cast<int>(c) << ' ';
    std::cout << "]\n";

    std::mbstate_t state{};
    char out[MB_LEN_MAX]{};
    for (char16_t c : strv)
    {
        std::size_t rc = std::c16rtomb(out, c, &state);
        std::cout << static_cast<int>(c) << " converted to [ ";
        if (rc != (std::size_t) - 1)
            for (unsigned char c8 : std::string_view{out, rc})
                std::cout << +c8 << ' ';
        std::cout << "]\n";
    }
}

Processing 5 UTF-16 code units: [ 0x7a 0xdf 0x6c34 0xd83c 0xdf4c ]
0x7a converted to [ 0x7a ]
0xdf converted to [ 0xc3 0x9f ]
0x6c34 converted to [ 0xe6 0xb0 0xb4 ]
0xd83c converted to [ ]
0xdf4c converted to [ 0xf0 0x9f 0x8d 0x8c ]

См. также