命名空间
变体
操作

std::codecvt_utf8

来自 cppreference.cn
< 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 是一个 std::codecvt facet，它封装了 UTF-8 编码的字节字符串与 UCS-2 或 UTF-32 字符字符串（取决于 Elem 的类型）之间的转换。此 std::codecvt facet 可用于读取和写入 UTF-8 文件，包括文本和二进制文件。

UCS-2 是一种过时的编码，它是 UTF-16 的子集，仅编码 U+0000-U+FFFF 范围（基本多文种平面）内的标量值。

内容

[编辑] 模板形参

Elem - 或者 char16_t、char32_t 或 wchar_t
Maxcode - 此 facet 将读取或写入而不会出错的 Elem 的最大值
Mode - std::codecvt_mode 类型的常量

[编辑] 成员函数

(构造器)
 构造新的 codecvt_utf8 facet
(公共成员函数)
(析构器)
 销毁 codecvt_utf8 facet
(公共成员函数)

std::codecvt_utf8::codecvt_utf8

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

构造一个新的 std::codecvt_utf8 facet，将初始引用计数器 refs 传递给基类。

形参

refs - 链接到 facet 的引用数

std::codecvt_utf8::~codecvt_utf8

~codecvt_utf8();

销毁 facet。与区域设置管理的 facet 不同，此 facet 的析构器是公共的。

继承自 std::codecvt

嵌套类型

类型 定义
intern_type internT
extern_type externT
state_type stateT

[编辑] 数据成员

成员 描述
std::locale::id id [静态] facet 的标识符

成员函数

 调用 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> 的虚保护成员函数) [编辑]
[虚函数]
 测试 facet 是否为所有有效参数值编码恒等转换
(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 位时，此 facet 适用于 UCS-2，但某些实现使用 UTF-16 代替。“UCS-2” 术语已被弃用并从 ISO 10646 中删除。

[编辑] 示例

以下示例演示了 UCS-2/UTF-8 和 UTF-16/UTF-8 转换之间的区别：字符串中的第三个字符不是有效的 UCS-2 字符。

运行此代码
#include <codecvt>
#include <cstdint>
#include <iostream>
#include <locale>
#include <string>
 
int main()
{
    // UTF-8 data. The character U+1d10b, musical sign segno, does not fit in UCS-2
    std::string utf8 = "z\u6c34\U0001d10b";
 
    // the UTF-8 / UTF-16 standard conversion facet
    std::wstring_convert<std::codecvt_utf8_utf16<char16_t>, char16_t> utf16conv;
    std::u16string utf16 = utf16conv.from_bytes(utf8);
    std::cout << "UTF-16 conversion produced " << utf16.size() << " code units:\n"
              << std::showbase << std::hex;
    for (char16_t c : utf16)
        std::cout << static_cast<std::uint16_t>(c) << ' ';
 
    // the UTF-8 / UCS-2 standard conversion facet
    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 failed after producing " << std::dec << ucs2.size()
                  << " characters:\n" << std::showbase << std::hex;
        for (char16_t c : ucs2)
            std::cout << static_cast<std::uint16_t>(c) << ' ';
        std::cout << '\n';
    }
}

输出

UTF-16 conversion produced 4 code units:
0x7a 0x6c34 0xd834 0xdd0b
UCS-2 failed after producing 2 characters:
0x7a 0x6c34

[编辑] 缺陷报告

以下行为更改缺陷报告被追溯应用于先前发布的 C++ 标准。

DR 应用于 已发布行为 正确行为
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>

 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>
 在字符编码之间转换，包括 UTF-8、UTF-16、UTF-32
(类模板) [编辑]
(C++11)(C++17 中已弃用)(C++26 中移除)
 用于更改标准 codecvt facet 行为的标签
(枚举) [编辑]
(C++11)(C++17 中已弃用)(C++26 中移除)
 在 UTF-16 和 UCS-2/UCS-4 之间转换
(类模板) [编辑]
(C++11)(C++17 中已弃用)(C++26 中移除)
 在 UTF-8 和 UTF-16 之间转换
(类模板) [编辑]
取自“https://cppreference.cn/mwiki/index.php?title=cpp/locale/codecvt_utf8&oldid=177705”