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，例如寫入檔案時 (虛保護成員函式)