Namespaces
Variants

std:: codecvt_utf16

From cppreference.net
C++
Text processing library
Localization library
Определено в заголовке <codecvt>
template <

class Elem,
unsigned long Maxcode = 0x10ffff ,
std:: codecvt_mode Mode = ( std:: codecvt_mode ) 0 >
class codecvt_utf16

: public std:: codecvt < Elem, char , std:: mbstate_t > ;
(начиная с C++11)
(устарело в C++17)
(удалено в C++26)

std::codecvt_utf16 — это фасет std::codecvt , который инкапсулирует преобразование между строкой байтов в кодировке UTF-16 и строкой символов UCS-2 или UTF-32 (в зависимости от типа Elem ). Этот фасет std::codecvt может использоваться для чтения и записи UTF-16 файлов в бинарном режиме.

UCS-2 — это устаревшая кодировка, являющаяся подмножеством UTF-16, которая кодирует скалярные значения только в диапазоне U+0000-U+FFFF (Basic Multilingual Plane).

Содержание

Параметры Шаблона

Elem - либо char16_t , char32_t , или wchar_t
Maxcode - максимальное значение Elem , которое этот фасет будет читать или записывать без ошибки
Mode - константа типа std::codecvt_mode

Функции-члены

(constructor)
создает новый codecvt_utf16 фасе́т
(общедоступная функция-член)
(destructor)
уничтожает codecvt_utf16 фасе́т
(общедоступная функция-член)

std::codecvt_utf16:: codecvt_utf16

explicit codecvt_utf16 ( std:: size_t refs = 0 ) ;

Создает новый фасет std::codecvt_utf16 , передавая начальное значение счетчика ссылок refs базовому классу.

Параметры

refs - количество ссылок, связывающих с фасетом

std::codecvt_utf16:: ~codecvt_utf16

~codecvt_utf16 ( ) ;

Уничтожает фацет. В отличие от фацетов, управляемых локалью, деструктор этого фацета является публичным.

Унаследовано от std:: codecvt

Вложенные типы

Тип Определение
intern_type internT
extern_type externT
state_type stateT

Члены данных

Участник Описание
std::locale::id id [static] идентификатор аспекта

Функции-члены

вызывает do_out
(публичная функция-член std::codecvt<InternT,ExternT,StateT> )
вызывает do_in
(публичная функция-член std::codecvt<InternT,ExternT,StateT> )
вызывает do_unshift
(публичная функция-член std::codecvt<InternT,ExternT,StateT> )
вызывает do_encoding
(публичная функция-член std::codecvt<InternT,ExternT,StateT> )
вызывает do_always_noconv
(публичная функция-член std::codecvt<InternT,ExternT,StateT> )
вызывает do_length
(публичная функция-член std::codecvt<InternT,ExternT,StateT> )
вызывает do_max_length
(публичная функция-член std::codecvt<InternT,ExternT,StateT> )

Защищенные функции-члены

[virtual]
преобразует строку из InternT в ExternT , например, при записи в файл
(виртуальная защищенная функция-член std::codecvt<InternT,ExternT,StateT> )
[virtual]
преобразует строку из ExternT в InternT , например, при чтении из файла
(виртуальная защищенная функция-член std::codecvt<InternT,ExternT,StateT> )
[virtual]
генерирует последовательность символов завершения ExternT для неполного преобразования
(виртуальная защищенная функция-член std::codecvt<InternT,ExternT,StateT> )
[virtual]
возвращает количество символов ExternT , необходимых для получения одного символа InternT , если постоянно
(виртуальная защищенная функция-член std::codecvt<InternT,ExternT,StateT> )
[virtual]
проверяет, кодирует ли фасет тождественное преобразование для всех допустимых значений аргументов
(виртуальная защищенная функция-член std::codecvt<InternT,ExternT,StateT> )
[virtual]
вычисляет длину строки ExternT , которая будет использована при преобразовании в заданный буфер InternT
(виртуальная защищенная функция-член std::codecvt<InternT,ExternT,StateT> )
[virtual]
возвращает максимальное количество символов ExternT , которое может быть преобразовано в один символ InternT
(виртуальная защищенная функция-член std::codecvt<InternT,ExternT,StateT> )

Унаследовано от std:: codecvt_base

Вложенный тип Определение
enum result { ok, partial, error, noconv } ; Неограниченный тип перечисления
Константа перечисления Определение
ok преобразование завершено без ошибок
partial не все исходные символы были преобразованы
error встречен недопустимый символ
noconv преобразование не требуется, входной и выходной типы совпадают

Примечания

Хотя стандарт требует, чтобы этот фасет работал с UCS-2, когда размер Elem составляет 16 бит, некоторые реализации используют вместо этого UTF-16, делая эту локаль неконвертирующей. Термин "UCS-2" был объявлен устаревшим и удален из ISO 10646.

Пример

Следующий пример демонстрирует декодирование файла UTF-16le на системе с 32-битным wchar_t . На системе с 16-битным wchar_t , декодирование третьего символа завершится неудачей, потому что std :: codecvt_utf16 < char16_t > производит UCS-2, а не UTF-16.

Запустить этот код 
#include <codecvt>
#include <cwchar>
#include <fstream>
#include <iostream>
#include <locale>
#include <string>
void prepare_file()
{
    // UTF-16le data (if host system is little-endian)
    char16_t utf16le[4] = {0x007a,          // latin small letter 'z' U+007a
                           0x6c34,          // CJK ideograph "water"  U+6c34
                           0xd834, 0xdd0b}; // musical sign segno U+1d10b    
    // store in a file
    std::ofstream fout("text.txt");
    fout.write(reinterpret_cast<char*>(utf16le), sizeof utf16le);
}
int main()
{
    prepare_file();
    // open as a byte stream
    std::wifstream fin("text.txt", std::ios::binary);
    // apply facet
    fin.imbue(std::locale(fin.getloc(),
        new std::codecvt_utf16<wchar_t, 0x10ffff, std::little_endian>));
    wchar_t c = 0;
    for (std::cout << std::showbase << std::hex; fin.get(c);
         std::cout << static_cast<std::wint_t>(c) << '\n');
}

Вывод: 

0x7a
0x6c34
0x1d10b

Отчеты о дефектах

Следующие отчеты об изменениях поведения, влияющие на дефекты, были применены ретроактивно к ранее опубликованным стандартам C++.

DR Applied to Behavior as published Correct behavior
LWG 2229 C++98 конструктор и деструктор не были определены определяет их

Смотрите также

Преобразования символов
многобайтовые, определенные локализацией
(UTF-8, GB18030) 		UTF-8
UTF-16
UTF-16 mbrtoc16 / c16rtomb (с DR488 из C11)

codecvt < char16_t , char ,mbstate_t >
codecvt_utf8_utf16 < char16_t >
codecvt_utf8_utf16 < char32_t >
codecvt_utf8_utf16 < wchar_t >

Н/П
UCS-2 c16rtomb (без DR488 из C11) codecvt_utf8 < char16_t > codecvt_utf16 < char16_t >
UTF-32

mbrtoc32 / c32rtomb

codecvt < char32_t , char ,mbstate_t >
codecvt_utf8 < char32_t >

codecvt_utf16 < char32_t >

системный wchar_t :

UTF-32 (не-Windows)
UCS-2 (Windows)

mbsrtowcs / wcsrtombs
use_facet < codecvt
< wchar_t , char ,mbstate_t >> ( locale )

codecvt_utf8 < wchar_t > codecvt_utf16 < wchar_t >
преобразует между кодировками символов, включая UTF-8, UTF-16, UTF-32
(шаблон класса)
(C++11) (устарело в C++17) (удалено в C++26)
флаги для изменения поведения стандартных фацетов codecvt
(перечисление)
(C++11) (устарело в C++17) (удалено в C++26)
преобразует между UTF-8 и UCS-2/UCS-4
(шаблон класса)
(C++11) (устарело в C++17) (удалено в C++26)
преобразует между UTF-8 и UTF-16
(шаблон класса)