std::codecvt_byname

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (C++11)

技术规范

符号索引

外部库

 

本地化库

本地环境与平面
本地环境
locale
use_facet	has_facet
平面类别基类
ctype_base codecvt_base messages_base	time_base money_base
ctype（字符类别）平面
ctype ctype_byname ctype<char>	codecvt codecvt_byname
numeric（数值）平面
num_get num_put	numpunct numpunct_byname
collate（对照比较）平面
collate	collate_byname
time（时间）平面
time_get time_get_byname	time_put time_put_byname
monetary（货币）平面
money_get money_put	moneypunct moneypunct_byname
messages（消息）平面
messages	messages_byname
字符分类与转换
字符分类
isspace isblank (C++11) iscntrl isupper islower isalpha	isdigit ispunct isxdigit isalnum isprint isgraph
转换
toupper tolower	wstring_convert (C++11) wbuffer_convert (C++11)
编码转换平面
codecvt_utf8 (C++11) codecvt_utf16 (C++11)	codecvt_utf8_utf16 (C++11) codecvt_mode (C++11)
C 本地环境
LC_ALLLC_COLLATELC_CTYPELC_MONETARYLC_NUMERICLC_TIME	setlocale localeconv lconv

 

在标头 <locale> 定义
template< class InternT, class ExternT, class State > class codecvt_byname : public std::codecvt<InternT, ExternT, State>;

std::codecvt_byname 是一个封装了在它构造时指定的本地环境的多字节/宽字符转换规则的 std::codecvt 平面。

特化

标准库保证提供以下特化：

在标头 <locale> 定义
std::codecvt_byname<char, char, std::mbstate_t>	恒等转换
std::codecvt_byname<char16_t, char, std::mbstate_t>	在 UTF-16 和 UTF-8 间转换 (C++11 起)(C++20 中弃用)
std::codecvt_byname<char16_t, char8_t, std::mbstate_t>	在 UTF-16 和 UTF-8 间转换 (C++20 起)
std::codecvt_byname<char32_t, char, std::mbstate_t>	在 UTF-32 和 UTF-8 间转换 (C++11 起)(C++20 中弃用)
std::codecvt_byname<char32_t, char8_t, std::mbstate_t>	在 UTF-32 和 UTF-8 间转换 (C++20 起)
std::codecvt_byname<wchar_t, char, std::mbstate_t>	在系统原生宽和单字节窄字符集间转换

成员函数

(构造函数)	构造新的 codecvt_byname 平面 (公开成员函数)
(析构函数)	析构 codecvt_byname 平面 (受保护成员函数)

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 平面。

refs 用于资源管理：在销毁最后一个保有平面的 std::locale 对象时，如果 refs == 0，那么实现会销毁平面对象。否则不销毁对象。

参数

name	-	本地环境的名称
refs	-	链接到该平面的引用数

std::codecvt_byname::~codecvt_byname

protected: ~codecvt_byname();

销毁平面。

继承自 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 [虚]	计算转换成给定的 InternT 缓冲区会消耗的 ExternT 字符串长度 (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	不要求转换，输入与输出类型相同

示例

此示例演示用来自具备 GB18030 的本地环境读取 GB18030 编码的文件：

运行此代码

#include <iostream>
#include <fstream>
#include <string>
#include <locale>
 
int main()
{
    // GB18030 窄多字节编码
    std::ofstream("text.txt") << "\x7a"              // 字母 'z' ， U+007a
                                 "\x81\x30\x89\x38"  // 字母 'ß' ， U+00df
                                 "\xcb\xae"          // CJK 表意字符 '水' ， U+6c34
                                 "\x94\x32\xbc\x35"; // 音符 '𝄋' (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 << c << '\n';
}

输出：

0x7a
0xdf
0x6c34
0x1d10b

缺陷报告

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

缺陷报告	应用于	出版时的行为	正确行为
LWG 21	C++98	标准库不需要提供任何 std::codecvt_byname 特化	需要提供指定的两个特化

参阅

codecvt

在字符编码间转换，包括 UTF-8、UTF-16、UTF-32 (类模板)