命名空间
变体
操作

std::codecvt_byname

来自 cppreference.cn
< cpp‎ | locale
 
 
 
 
定义于头文件 <locale>
template< class InternT, class ExternT, class State >
class codecvt_byname : public std::codecvt<InternT, ExternT, State>;

std::codecvt_byname 是一个 std::codecvt facet,它封装了在其构造时指定的区域设置的多字节/宽字符转换规则。

内容

[编辑] 特化

标准库保证提供以下特化

定义于头文件 <locale>
std::codecvt_byname<char, char, std::mbstate_t> 恒等转换
std::codecvt_byname<char16_t, char, std::mbstate_t>
(C++11 起)(C++20 中已弃用)
UTF-16 和 UTF-8 之间的转换
std::codecvt_byname<char16_t, char8_t, std::mbstate_t>
(C++20 起)
UTF-16 和 UTF-8 之间的转换
std::codecvt_byname<char32_t, char, std::mbstate_t>
(C++11 起)(C++20 中已弃用)
UTF-32 和 UTF-8 之间的转换
std::codecvt_byname<char32_t, char8_t, std::mbstate_t>
(C++20 起)
UTF-32 和 UTF-8 之间的转换
std::codecvt_byname<wchar_t, char, std::mbstate_t> 宽字符串和窄字符集之间的特定于区域设置的转换

[编辑] 成员函数

(构造函数)
构造一个新的 codecvt_byname facet
(公有成员函数) [编辑]
(析构函数)
销毁一个 codecvt_byname facet
(受保护的成员函数) [编辑]

std::codecvt_byname::codecvt_byname

explicit codecvt_byname( const char* name, std::size_t refs = 0 );
explicit codecvt_byname( const std::string& name, std::size_t refs = 0 );
(C++11 起)

为一个具有 name 的区域设置构造一个新的 std::codecvt_byname facet。

refs 用于资源管理:如果 refs == 0,则当最后一个持有它的 std::locale 对象被销毁时,实现会销毁该 facet。 否则,该对象不会被销毁。

参数

name - 区域设置的名称
refs - 链接到 facet 的引用数

std::codecvt_byname::~codecvt_byname

protected:
~codecvt_byname();

销毁 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 不需要转换,输入和输出类型相同

[编辑] 示例

此示例演示了如何使用来自 GB18030 感知区域设置的 codecvt facet 读取 GB18030 编码的文件。

#include <fstream>
#include <iostream>
#include <locale>
#include <string>
 
int main()
{
    // GB18030 narrow multibyte encoding
    std::ofstream("text.txt") << "\x7a"              // letter 'z', U+007a
                                 "\x81\x30\x89\x38"  // letter 'ß', U+00df
                                 "\xcb\xae"          // CJK ideogram '水' (water), U+6c34
                                 "\x94\x32\xbc\x35"; // musical sign '𝄋' (segno), U+1d10b
 
    std::wifstream fin("text.txt");
    fin.imbue(std::locale(fin.getloc(),
              new std::codecvt_byname<wchar_t, char, std::mbstate_t>("zh_CN.gb18030")));
 
    for (wchar_t c; fin.get(c);)
        std::cout << std::hex << std::showbase << static_cast<unsigned>(c) << '\n';
}

可能的输出

0x7a
0xdf
0x6c34
0x1d10b

[编辑] 缺陷报告

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

DR 应用于 已发布行为 正确行为
LWG 21 C++98 标准库不需要提供
任何 std::codecvt_byname 特化
需要两个特化

[编辑] 参见

在字符编码之间转换,包括 UTF-8、UTF-16、UTF-32
(类模板) [编辑]