命名空间
变体
操作

std::codecvt<InternT,ExternT,StateT>::out, do_out

来自 cppreference.cn
< cpp‎ | locale‎ | codecvt
 
C++
 
文本处理库
 
本地化库
 
std::codecvt
 
定义于头文件 <locale>
public:

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

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

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

                       ExternT*& to_next ) const;
 (2)
1) 公有成员函数，调用最派生类的成员函数 do_out。
2) 如果此 codecvt facet 定义了转换，则将来自源范围 [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_out(state, from, from + 1, from_next, to, to_end, to_next) 必须在以下情况下返回 ok：

  • 此 codecvt facet 被 basic_filebuf 使用，并且
  • do_out(state, from, from_end, from_next, to, to_end, to_next) 将在 from != from_end 的情况下返回 ok。

目录

[编辑] 返回值

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

ok 转换完成
partial 输出缓冲区空间不足或源缓冲区意外结束
error 遇到无法转换的字符
noconv 此 facet 是非转换的，没有写入任何输出

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

[编辑] 注意

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

虽然 codecvt 支持 N:M 转换（例如 UTF-16 到 UTF-8，其中可能需要两个内部字符来决定要输出的外部字符），但 std::basic_filebuf 只能使用定义 1:N 转换的 codecvt facets，也就是说，它必须能够在写入文件时一次处理一个内部字符。

当执行 N:M 转换时，此函数可能在消耗所有源字符后返回 std::codecvt_base::partial (from_next == from_end)。这意味着需要另一个内部字符来完成转换（例如，当将 UTF-16 转换为 UTF-8 时，如果源缓冲区中的最后一个字符是高代理项）。

state 上的效果是故意未指定的。在标准 facets 中，它用于维护移位状态，例如在调用 std::wcsrtombs 时，因此会更新以反映最后一个成功转换的字符之后的移位状态，但是用户定义的 facet 可以自由地使用它来维护任何其他状态，例如，计算遇到的特殊字符的数量。

[编辑] 示例

运行此代码
#include <iostream>
#include <locale>
#include <string>
 
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::wstring internal = L"z\u00df\u6c34\U0001f34c"; // L"zß水🍌"
 
    // note that the following can be done with wstring_convert
    std::mbstate_t mb{}; // initial shift state
    std::string external(internal.size() * f.max_length(), '\0'); 
    const wchar_t* from_next;
    char* to_next;
    f.out(mb, &internal[0], &internal[internal.size()], from_next,
              &external[0], &external[external.size()], to_next);
    // error checking skipped for brevity
    external.resize(to_next - &external[0]);
 
    std::cout << "The string in narrow multibyte encoding: " << external << '\n';
}

输出

The string in narrow multibyte encoding: zß水🍌

[编辑] 缺陷报告

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

DR 应用于 已发布行为 正确行为
LWG 76 C++98 不清楚是否需要转换
支持一次取一个内部字符		 仅在被使用时需要
通过 basic_filebuf

[编辑] 参见

[virtual]
 将字符从 put 区域写入关联的文件
(std::basic_filebuf<CharT,Traits> 的虚保护成员函数) [编辑]
 将宽字符串转换为字节字符串
(std::wstring_convert<Codecvt,Elem,Wide_alloc,Byte_alloc> 的公有成员函数) [编辑]
 将宽字符串转换为窄多字节字符字符串，给定状态
(函数) [编辑]
[virtual]
 将字符串从 ExternT 转换为 InternT，例如从文件读取时
(虚保护成员函数) [编辑]
取自“https://cppreference.cn/mwiki/index.php?title=cpp/locale/codecvt/out&oldid=160052”