std::codecvt_utf16

定义在头文件中 `<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（基本多语言平面）的标量值。

内容

1 模板参数
2 成员函数
3 std::codecvt_utf16::codecvt_utf16
- 3.1 参数
4 std::codecvt_utf16::~codecvt_utf16
5 从 std::codecvt 继承
6 从 std::codecvt_base 继承

[编辑] 模板参数

Elem	-	要么是 char16_t、char32_t 或者 wchar_t
Maxcode	-	此面将在不出现错误的情况下读取或写入的 `Elem` 的最大值
Mode	-	类型为 std::codecvt_mode 的常量

[编辑] 成员函数

(构造函数)	构造一个新的 `codecvt_utf16` 面 (公共成员函数)
(析构函数)	销毁一个 `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`

成员对象

成员名称	类型
`id` (静态)	std::locale::id

成员函数

out	调用 `do_out` (`std::codecvt<InternT,ExternT,StateT>` 的公共成员函数) [编辑]
in	调用 `do_in` (`std::codecvt<InternT,ExternT,StateT>` 的公共成员函数) [编辑]
unshift	调用 `do_unshift` (`std::codecvt<InternT,ExternT,StateT>` 的公共成员函数) [编辑]
encoding	调用 `do_encoding` (`std::codecvt<InternT,ExternT,StateT>` 的公共成员函数) [编辑]
always_noconv	调用 `do_always_noconv` (`std::codecvt<InternT,ExternT,StateT>` 的公共成员函数) [编辑]
length	调用 `do_length` (`std::codecvt<InternT,ExternT,StateT>` 的公共成员函数) [编辑]
max_length	调用 `do_max_length` (`std::codecvt<InternT,ExternT,StateT>` 的公共成员函数) [编辑]

受保护的成员函数

do_out [虚拟]	将字符串从 `InternT` 转换为 `ExternT`，例如在写入文件时 (`std::codecvt<InternT,ExternT,StateT>` 的虚拟受保护成员函数) [编辑]
do_in [虚拟]	将字符串从 `ExternT` 转换为 `InternT`，例如在从文件读取时 (`std::codecvt<InternT,ExternT,StateT>` 的虚拟受保护成员函数) [编辑]
do_unshift [虚拟]	为不完整的转换生成 `ExternT` 字符的终止字符序列 (`std::codecvt<InternT,ExternT,StateT>` 的虚拟受保护成员函数) [编辑]
do_encoding [虚拟]	如果恒定，则返回生成一个 `InternT` 字符所需的 `ExternT` 字符数 (`std::codecvt<InternT,ExternT,StateT>` 的虚拟受保护成员函数) [编辑]
do_always_noconv [虚拟]	测试面是否为所有有效参数值编码标识转换 (`std::codecvt<InternT,ExternT,StateT>` 的虚拟受保护成员函数) [编辑]
do_length [虚拟]	计算将 `ExternT` 字符串转换为给定 `InternT` 缓冲区所需的长度。 (`std::codecvt<InternT,ExternT,StateT>` 的虚拟受保护成员函数) [编辑]
do_max_length [虚拟]	返回可以转换为单个 `InternT` 字符的最大 `ExternT` 字符数。 (`std::codecvt<InternT,ExternT,StateT>` 的虚拟受保护成员函数) [编辑]

继承自 std::codecvt_base

成员类型	定义
enum result { ok, partial, error, noconv };	无作用域枚举类型

枚举常量	定义
`ok`	转换已完成，无错误
`partial`	并非所有源字符都被转换
`error`	遇到无效字符
`noconv`	不需要转换，输入和输出类型相同

[编辑] 注释

虽然标准要求此方面在 Elem 的大小为 16 位时使用 UCS-2，但一些实现使用 UTF-16 代替，使其成为一个非转换区域设置。术语“UCS-2”已从 ISO 10646 中弃用并删除。

[编辑] 示例

以下示例演示了在具有 32 位 wchar_t 的系统上解码 UTF-16le 文件。在具有 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

[编辑] 另请参阅

字符转换	区域设置定义的多字节 (UTF-8, GB18030)	UTF-8	UTF-16
UTF-16	`mbrtoc16` / `c16rtomb` (使用 C11 的 DR488)	`codecvt`<char16_t,char,mbstate_t> `codecvt_utf8_utf16`<char16_t> `codecvt_utf8_utf16`<char32_t> `codecvt_utf8_utf16`<wchar_t>	N/A
UCS-2	`c16rtomb` (不使用 C11 的 DR488)	`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>

codecvt	在字符编码之间转换，包括 UTF-8、UTF-16、UTF-32 (类模板) [编辑]
codecvt_mode (C++11)(C++17 中已弃用)(C++26 中已移除)	标记以更改标准 codecvt 方面的行为 (枚举) [编辑]
codecvt_utf8 (C++11)(C++17 中已弃用)(C++26 中已移除)	在 UTF-8 和 UCS-2/UCS-4 之间转换 (类模板) [编辑]
codecvt_utf8_utf16 (C++11)(C++17 中已弃用)(C++26 中已移除)	在 UTF-8 和 UTF-16 之间转换 (类模板) [编辑]

编译器支持
独立和托管
语言
标准库
标准库头文件
命名需求
特性测试宏 (C++20)
语言支持库
概念库 (C++20)
元编程库 (C++11)
诊断库
通用实用程序库
字符串库
容器库
迭代器库
范围库 (C++20)
算法库
数值库
本地化库
输入/输出库
文件系统库 (C++17)
正则表达式库 (C++11)
并发支持库 (C++11)
执行支持库 (C++26)
技术规范
符号索引
外部库

字符转换
toupper
tolower
字符串和流转换
wstring_convert (C++11/17/26*)
wbuffer_convert (C++11/17/26*)

cppreference.com

命名空间

变体

视图

操作