std::codecvt_utf8

来自cppreference.com
< cpp‎ | locale
 
C++
 
本地化库
 
在标头 <codecvt> 定义
template<

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

    : public std::codecvt<Elem, char, std::mbstate_t>;
 (C++11 起)
(C++17 中弃用)
(C++26 中移除)

std::codecvt_utf8 是封装 UTF-8 编码字符串和 UCS-2 或 UTF-32 字符串（取决于 Elem 类型）间转换的 std::codecvt 刻面。此 std::codecvt 刻面能用于读写文本和二进制的 UTF-8 文件。

UCS-2 和 UTF-16 是相同的编码，区别是前者只能编码范围 U+0000-U+FFFF（基础多语言平面）中的标量。

(C++23 起)

模板形参

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

成员函数

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

std::codecvt_utf8::codecvt_utf8

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

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

参数

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

std::codecvt_utf8::~codecvt_utf8

~codecvt_utf8();

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

继承自 std::codecvt

成员类型

成员名字 定义
intern_type internT
extern_type externT
state_type stateT

成员对象

成员名 类型
id (static) std::locale::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 无需转换，输入与输出类型相同

注解

尽管标准要求此刻面在 Elem 是 16 位时用 UCS-2 工作，某些实现用 UTF-16 代替。用语 "UCS-2" 已被弃用并从 ISO 10646 移除。

从 C++23 开始，UCS-2 不再指代它的原本定义。它成为了 UTF-16 的同义词，但是编码范围更小。

示例

下例示例演示 UCS-2/UTF-8 间和 UTF-16/UTF-8 间转换的差异：字符串中的字符不是合法的 UCS-2 字符。

运行此代码
#include <codecvt>
#include <cstdint>
#include <iostream>
#include <locale>
#include <string>
 
int main()
{
    // UTF-8 数据。字符 U+1d10b（segno 音符）不在 UCS-2 中
    std::string utf8 = "z\u6c34\U0001d10b";
 
    // UTF-8 / UTF-16 标准转换刻面
    std::wstring_convert<std::codecvt_utf8_utf16<char16_t>, char16_t> utf16conv;
    std::u16string utf16 = utf16conv.from_bytes(utf8);
    std::cout << "UTF-16 转换产生了 " << utf16.size() << " 个代码单元：\n";
              << std::showbase << std::hex;
    for (char16_t c : utf16)
        std::cout << static_cast<std::uint16_t>(c) << ' ';
 
    // UTF-8 / UCS-2 标准转换刻面
    std::wstring_convert<std::codecvt_utf8<char16_t>, char16_t> ucs2conv;
    try
    {
        std::u16string ucs2 = ucs2conv.from_bytes(utf8);
    }
    catch(const std::range_error& e)
    {
        std::u16string ucs2 = ucs2conv.from_bytes(utf8.substr(0, ucs2conv.converted()));
        std::cout << "\nUCS-2 在产生 " << std::dec << ucs2.size() << " 个字符后失败：\n";
                  << std::showbase << std::hex;
        for (char16_t c : ucs2)
            std::cout << static_cast<std::uint16_t>(c) << ' ';
        std::cout << '\n';
    }
}

输出： 

UTF-16 转换产生了 4 个代码单元：
0x7a 0x6c34 0xd834 0xdd0b
UCS-2 在产生 2 个字符后失败：
0x7a 0x6c34

参阅

字符转换 本地环境定义的多字节
(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-16 与 UCS-2/UCS-4 间转换
(类模板)
(C++11)(C++17 中弃用)(C++26 中移除)
 在 UTF-8 与 UTF-16 间转换
(类模板)
来自“https://zh.cppreference.com/mwiki/index.php?title=cpp/locale/codecvt_utf8&oldid=86206”