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

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

テキスト処理ライブラリ

ローカライズライブラリ

正規表現ライブラリ (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)

 

ローカライズライブラリ

ロケールとファセット   ロケール has_facet use_facet locale ファセットカテゴリ 基底クラス ctype_base codecvt_base messages_base time_base money_base ctypeファセット ctype ctype<char> ctype_byname codecvt codecvt_byname 数値ファセット num_get num_put numpunct numpunct_byname 文字比較ファセット collate collate_byname 時間ファセット time_get time_put time_get_byname time_put_byname

通貨ファセット money_get money_put moneypunct moneypunct_byname メッセージファセット 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: 結果 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_nextとto_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)が、to != to_endの場合にokを返す場合。

返り値

std::codecvt_base::result 型の値。成功ステータスを示す。

ok	変換が完了しました
部分的	出力バッファに十分なスペースがないか、ソースバッファの予期せぬ終端
error	変換できない文字に遭遇しました
noconv	このファセットは非変換であり、出力は書き込まれません

非変換特殊化std::codecvt<char, char, std::mbstate_t>は常にstd::codecvt_base::noconvを返します。

注記

from <= from_end && to <= to_endであり、stateが初期シフト状態を表しているか、またはシーケンスの先行する文字を変換することによって取得された状態であることを要求します。

stateへの影響は意図的に未指定です。標準ファセットでは、std::mbsrtowcsの呼び出し時のようなシフト状態を維持するために使用され、そのため最後の処理された外部文字後の変換状態を反映するように更新されますが、ユーザー定義ファセットはそれを任意の他の状態（例えば、遭遇した特殊文字の数を数えるなど）を維持するために自由に使用できます。

例

このコードを実行

#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++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
LWG 76	C++98	変換が 一度に1つの内部文字を生成することをサポートする必要があるか	必要かどうかが不明確でした （basic_filebufによって使用される場合のみ）

関連項目

underflow [virtual]	関連付けられたファイルから読み込みます。 (std::basic_filebuf<CharT,Traits>の仮想保護メンバー関数)
from_bytes	バイト文字列をワイド文字列に変換する (std::wstring_convert<Codecvt,Elem,Wide_alloc,Byte_alloc>の公開メンバ関数)
mbsrtowcs	与えられた状態で、ナローマルチバイト文字列をワイド文字列に変換する (関数)
do_out [virtual]	ファイルへの書き込み時など、InternT から ExternT への文字列を変換します。 (virtual protected メンバ関数)