std::codecvt<InternT,ExternT,StateT>::in, std::codecvt<InternT,ExternT,StateT>::do_in

来自cppreference.com
< cpp‎ | locale‎ | codecvt
 
 
本地化库
本地环境与平面
本地环境
平面类别基类
ctype(字符类别)平面
numeric(数值)平面
collate(对照比较)平面
time(时间)平面
monetary(货币)平面
messages(消息)平面
字符分类与转换
字符分类
转换
编码转换平面
(C++11)    
C 本地环境
 
 
在标头 <locale> 定义
public:

result in( StateT& state,
           const ExternT* from,
           const ExternT* from_end,
           const ExternT*& from_next,
           InternT* to,
           InternT* to_end,

           InternT*& to_next ) const;
(1)
protected:

virtual result do_in( StateT& state,
                      const ExternT* from,
                      const ExternT* from_end,
                      const ExternT*& from_next,
                      InternT* to,
                      InternT* to_end,

                      InternT*& to_next ) const;
(2)
1) 公开成员函数,调用最终派生类的成员函数 do_in
2) 如果此 codecvt 平面定义一个转换,那么翻译来自源范围 [from, from_end) 的外部字符到内部字符,将结果置于从 to 开始的后继位置。最多转换 from_end - from 个外部字符,最多写入 to_end - to 个内部字符。令 from_nextto_next 指向最后成功转换元素的后一位置。

如果此 codecvt 平面不定义转换,那么不会转换字符。设置 to_next 等于 to,不更改 state,并返回 std::codecvt_base::noconv

如果满足以下条件,do_in(state, from, from_end, from_next, to, to + 1, to_next) 必须返回 ok

  • codecvt 平面用于 basic_filebuf,并且
  • do_in(state, from, from_end, from_next, to, to_end, to_next)from != from_end 时会返回 ok

返回值

std::codecvt_base::result 类型值,按以下方式指示成功状况:

ok 转换完成
partial 输出缓冲区的中空间不足,或源缓冲的未期待结尾
error 遇到无法转换的字符
noconv 此平面不会转换,不写入输出

非转换特化 std::codecvt<char, char, std::mbstate_t> 始终返回 std::codecvt_base::noconv

注意

要求 from <= from_end && to <= to_endstate 要么表示初始迁移状态,要么以转换序列中前趋的字符获得。

state 上的效果是有意未指定的。标准平面中,它用于维护像是调用 std::mbsrtowcs 时的状态,从而被更新为反映最后被处理外部字符后的转换状态,但是用户定义平面可以自由地用它维护任何其他状态,例如计量遇到的特殊字符数。

示例

#include <iostream>
#include <string>
#include <locale>
 
int main()
{
    std::locale::global(std::locale("en_US.utf8"));
    auto& f = std::use_facet<std::codecvt<wchar_t, char, std::mbstate_t>>(std::locale());
    std::string external = u8"z\u00df\u6c34\U0001d10b"; // 或 u8"zß水𝄋"
                          // 或 "\x7a\xc3\x9f\xe6\xb0\xb4\xf0\x9d\x84\x8b";
 
    // 注意 wstring_convert 能进行下列内容
    std::mbstate_t mb = std::mbstate_t(); // 初始迁移状态
    std::wstring internal(external.size(), '\0'); 
    const char* from_next;
    wchar_t* to_next;
    f.in(mb, &external[0], &external[external.size()], from_next,
             &internal[0], &internal[internal.size()], to_next);
    // 为简略跳过错误检查
    internal.resize(to_next - &internal[0]);
 
    std::wcout << L"在宽编码下的字符串:" << internal << '\n';
}

输出:

在宽编码下的字符串:zß水𝄋

缺陷报告

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

缺陷报告 应用于 出版时的行为 正确行为
LWG 76 C++98 不明确转换是否需要支持每次转换单个内部字符 只有用于 basic_filebuf 时才需要

参阅

从关联文件读取
(std::basic_filebuf<CharT,Traits> 的虚受保护成员函数)
转换字节字符串为宽字符串
(std::wstring_convert<Codecvt,Elem,Wide_alloc,Byte_alloc> 的公开成员函数)
给定状态,转换窄多字节字符串到宽字符串
(函数)
[虚]
将字符串从 InternT 转换到 ExternT,例如在写入文件时
(虚受保护成员函数)