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

 

C++

编译器支持

自由（freestanding）与宿主（hosted）

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

文本处理库

本地化库

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

格式化库 (C++20)

空终止序列工具

字节字符串

多字节字符串

宽字符串

原生数值转换

to_chars (C++17) to_chars_result (C++17) from_chars (C++17) from_chars_result (C++17) chars_format (C++17)

文本编码标识

text_encoding (C++26)

 

本地化库

区域设置和刻面 (Locales and facets)   区域设置 has_facet use_facet locale 刻面类别 (Facet category) 基类 (base classes) ctype_base codecvt_base messages_base time_base money_base ctype 刻面 ctype ctype<char> ctype_byname codecvt codecvt_byname 数字刻面 (numeric facets) num_get num_put numpunct numpunct_byname collate 刻面 collate collate_byname 时间刻面 (time facets) time_get time_put time_get_byname time_put_byname

货币刻面 (monetary facets) money_get money_put moneypunct moneypunct_byname messages 刻面 messages messages_byname 字符分类与转换 字符分类 isspace    iscntrl isupper islower    isalpha ispunct isdigit    isxdigit isalnum isblank (C++11) isprint isgraph 字符转换 toupper    tolower 字符串和流转换 wstring_convert (C++11/17/26*) wbuffer_convert (C++11/17/26*) Unicode 转换刻面 codecvt_utf8 (C++11/17/26*) codecvt_utf16 (C++11/17/26*) codecvt_utf8_utf16 (C++11/17/26*) codecvt_mode (C++11/17/26*) C 库区域设置 LC_ALLLC_COLLATELC_CTYPELC_MONETARYLC_NUMERICLC_TIME    setlocale localeconv lconv

 

std::codecvt

成员函数

codecvt::codecvt

codecvt::~codecvt

codecvt::outcodecvt::do_out

codecvt::incodecvt::do_in

codecvt::unshiftcodecvt::do_unshift

codecvt::encodingcodecvt::do_encoding

codecvt::always_noconvcodecvt::do_always_noconv

codecvt::lengthcodecvt::do_length

codecvt::max_lengthcodecvt::do_max_length

 

定义于头文件 <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 facette 定义了转换，则将外部字符从源范围 [from, from_end) 转换到内部字符，并将结果置于始于 to 的后续位置。转换的外部字符数不超过 from_end - from，写入的内部字符数不超过 to_end - to。使 from_next 和 to_next 指向成功转换的最后一个元素之后一位。

若此 codecvt facet 不定义转换，则不转换任何字符。to_next 被设置为等于 to，state 不变，并返回 std::codecvt_base::noconv。

do_in(state, from, from_end, from_next, to, to + 1, to_next) 必须返回 ok，如果

• 此 codecvt facet 被 basic_filebuf 使用，并且
• do_in(state, from, from_end, from_next, to, to_end, to_next) 会返回 ok，其中 to != to_end。

返回值

一个 std::codecvt_base::result 类型的值，指示成功状态，如下所示

ok	转换完成
部分	输出缓冲区空间不足或源缓冲区意外结束
error	遇到无法转换的字符
noconv	此 facet 不执行转换，未写入输出

非转换特化 std::codecvt<char, char, std::mbstate_t> 总是返回 std::codecvt_base::noconv。

注意

要求 from <= from_end && to <= to_end，并且 state 要么表示初始移位状态，要么通过转换序列中前面的字符获得。

对 state 的影响是故意未指定的。在标准 facet 中，它用于维护移位状态，例如调用 std::mbsrtowcs 时，并因此更新以反映处理的最后一个外部字符后的转换状态，但用户定义的 facet 可以自由地使用它来维护任何其他状态，例如计算遇到的特殊字符的数量。

示例

运行此代码

#include <iostream>
#include <locale>
#include <string>
 
int main()
{
    std::locale::global(std::locale("en_US.utf8"));
    auto const& f = std::use_facet<std::codecvt<wchar_t, char, std::mbstate_t>>
        (std::locale());
    std::string external = "z\u00df\u6c34\U0001d10b"; // or u8"zß水𝄋"
                     // or "\x7a\xc3\x9f\xe6\xb0\xb4\xf0\x9d\x84\x8b"
 
    // note that the following can be done with wstring_convert
    std::mbstate_t mb = std::mbstate_t(); // initial shift state
    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);
    // error checking skipped for brevity
    internal.resize(to_next - &internal[0]);
 
    std::wcout << L"The string in wide encoding: " << internal << '\n';
}

输出

The string in wide encoding: zß水𝄋

缺陷报告

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

缺陷报告	应用于	发布时的行为	正确的行为
LWG 76	C++98	不清楚转换是否要求 支持一次产生一个内部字符	仅在被使用时才要求 由 basic_filebuf

另见

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