std::codecvt_utf8_utf16

来自cppreference.com
 
C++
 
文本处理库
 
本地化库
 
在标头 <codecvt> 定义 
template<
    class Elem,
    unsigned long Maxcode = 0x10ffff,
    std::codecvt_mode Mode = (std::codecvt_mode)0 >
class codecvt_utf8_utf16
    : public std::codecvt<Elem, char, std::mbstate_t>;
(C++11 起)
(C++17 弃用)
(C++26 移除)

std::codecvt_utf8_utf16 是一个 std::codecvt 刻面，封装 UTF-8 编码字节串和 UTF-16 编码字符串间的转换。如果 Elem 是 32 位类型，那么输出序列的每个 32 位字符中将存储一个 UTF-16 编码单元。

这是 N:M 转换刻面，而且不能用于 std::basic_filebuf（它只容许内部和外部编码间的 1:N 转换，例如 UTF-32/UTF-8）。此刻面可以用于 std::wstring_convert。

模板形参

Elem - char16_t、char32_t 或 wchar_t 之一
Maxcode - 此刻面将读或写而不出错的 Elem 最大值
Mode - std::codecvt_mode 类型的常量

成员函数

 构造新的 codecvt_utf8_utf16 刻面
(公开成员函数)
销毁 codecvt_utf8_utf16 刻面
(公开成员函数)

std::codecvt_utf8_utf16::codecvt_utf8_utf16

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

构造新的 std::codecvt_utf8_utf16 刻面，传递初始引用计数 refs 给基类。

参数

refs - 链接到此刻面的引用数

std::codecvt_utf8_utf16::~codecvt_utf8_utf16

~codecvt_utf8_utf16();

销毁刻面。与本地环境管理的刻面不同，此刻面的析构函数是公开的。

继承自 std::codecvt

嵌套类型

类型 定义
intern_type internT
extern_type externT
state_type stateT

数据成员

成员 描述
std::locale::id id [静态] 刻面标识

成员函数

 调用 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> 的公开成员函数) [编辑]

受保护成员函数

[虚]
 将字符串从 InternT 转换到 ExternT，例如在写入文件时
(std::codecvt<InternT,ExternT,StateT> 的虚受保护成员函数) [编辑]
[虚]
 将字符串从 ExternT 转换到 InternT，例如在从文件读取时
(std::codecvt<InternT,ExternT,StateT> 的虚受保护成员函数) [编辑]
[虚]
 为不完整转换生成 ExternT 字符的终止字符序列
(std::codecvt<InternT,ExternT,StateT> 的虚受保护成员函数) [编辑]
[虚]
 返回产生一个 InternT 字符所需的 ExternT 字符数，如果它是常数
(std::codecvt<InternT,ExternT,StateT> 的虚受保护成员函数) [编辑]
[虚]
 测试刻面的编码是否对所有合法实参值都是恒等转换
(std::codecvt<InternT,ExternT,StateT> 的虚受保护成员函数) [编辑]
[虚]
 计算转换成给定的 InternT 缓冲区会消耗的 ExternT 字符串长度
(std::codecvt<InternT,ExternT,StateT> 的虚受保护成员函数) [编辑]
[虚]
 返回能转换成单个 InternT 字符的最大 ExternT 字符数
(std::codecvt<InternT,ExternT,StateT> 的虚受保护成员函数) [编辑]

继承自 std::codecvt_base

嵌套类型 定义
enum result { ok, partial, error, noconv }; 无作用域枚举类型
枚举常量 定义
ok 完成转换而无错误
partial 未转换所有源字符
error 遇到非法字符
noconv 无需转换，输入与输出类型相同

示例

运行此代码
#include <cassert>
#include <codecvt>
#include <cstdint>
#include <iostream>
#include <locale>
#include <string>

int main()
{
    std::string u8 = "z\u00df\u6c34\U0001f34c";
    std::u16string u16 = u"z\u00df\u6c34\U0001f34c";
    
    // UTF-8 到 UTF-16/char16_t
    std::u16string u16_conv = std::wstring_convert<
        std::codecvt_utf8_utf16<char16_t>, char16_t>{}.from_bytes(u8);
    assert(u16 == u16_conv);
    std::cout << "UTF-8 到 UTF-16 的转换产生了 " << u16_conv.size()
              << " 个代码单元：\n" << std::showbase << std::hex;
    for (char16_t c : u16_conv)
        std::cout << static_cast<std::uint16_t>(c) << ' ';
    
    // UTF-16/char16_t 到 UTF-8
    std::string u8_conv = std::wstring_convert<
        std::codecvt_utf8_utf16<char16_t>, char16_t>{}.to_bytes(u16);
    assert(u8 == u8_conv);
    std::cout << "\nUTF-16 到 UTF-8 的转换产生了 "
              << std::dec << u8_conv.size() << " 个字节：\n" << std::hex;
    for (char c : u8_conv)
        std::cout << static_cast<unsigned char>(c) << ' ';
    std::cout << '\n';
}

输出： 

UTF-8 到 UTF-16 的转换产生了 5 个代码单元：
0x7a 0xdf 0x6c34 0xd83c 0xdf4c 
UTF-16 到 UTF-8 的转换产生了 10 个字节：
0x7a 0xc3 0x9f 0xe6 0xb0 0xb4 0xf0 0x9f 0x8d 0x8c

缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告 应用于 出版时的行为 正确行为
LWG 2229 C++98 未指定构造函数和析构函数 指定它们

参阅

字符转换 本地环境定义的多字节
(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>

不适用
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)
UCS2(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-16 与 UCS-2/UCS-4 间转换
(类模板) [编辑]