std::codecvt_byname

 

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

 

ヘッダー <locale> で定義
template< class InternT, class ExternT, class State > class codecvt_byname : public std::codecvt<InternT, ExternT, State>;

std::codecvt_byname は、コンストラクタで指定されたロケールのマルチバイト/ワイド文字変換規則をカプセル化する std::codecvt ファセットです。

特殊化

標準ライブラリは、以下の特殊化を提供することが保証されています。

ヘッダー <locale> で定義
std::codecvt_byname<char, char, std::mbstate_t>	同一変換
std::codecvt_byname<char16_t, char, std::mbstate_t> (C++11以降)(C++20で非推奨)	UTF-16 と UTF-8 の間の変換
std::codecvt_byname<char16_t, char8_t, std::mbstate_t> (C++20以降)	UTF-16 と UTF-8 の間の変換
std::codecvt_byname<char32_t, char, std::mbstate_t> (C++11以降)(C++20で非推奨)	UTF-32 と UTF-8 の間の変換
std::codecvt_byname<char32_t, char8_t, std::mbstate_t> (C++20以降)	UTF-32 と UTF-8 の間の変換
std::codecvt_byname<wchar_t, char, std::mbstate_t>	ロケール固有のワイド文字列とナロー文字セット間の変換

メンバ関数

(コンストラクタ)	新しい codecvt_byname ファセットを構築します。 (public member function)
(デストラクタ)	codecvt_byname ファセットを破棄します。 (protected member function)

std::codecvt_byname::codecvt_byname

explicit codecvt_byname( const char* name, std::size_t refs = 0 );
explicit codecvt_byname( const std::string& name, std::size_t refs = 0 );		(C++11以降)

name で指定されたロケールの新しい std::codecvt_byname ファセットを構築します。

refs はリソース管理に使用されます。 refs == 0 の場合、それを持つ最後の std::locale オブジェクトが破棄されるときに、実装はファセットを破棄します。それ以外の場合、オブジェクトは破棄されません。

パラメータ

name	-	ロケールの名前
refs	-	ファセットを参照する参照の数

std::codecvt_byname::~codecvt_byname

protected: ~codecvt_byname();

ファセットを破棄します。

std::codecvt から継承

ネストされた型

型	定義
intern_type	internT
extern_type	externT
state_type	stateT

データメンバ

メンバ	説明
std::locale::id id [static]	ファセットの識別子

メンバ関数

out	do_out を呼び出します。 (std::codecvt<InternT,ExternT,StateT> の public メンバ関数)
in	do_in を呼び出します。 (std::codecvt<InternT,ExternT,StateT> の public メンバ関数)
unshift	do_unshift を呼び出します。 (std::codecvt<InternT,ExternT,StateT> の public メンバ関数)
encoding	do_encoding を呼び出します。 (std::codecvt<InternT,ExternT,StateT> の public メンバ関数)
always_noconv	do_always_noconv を呼び出します。 (std::codecvt<InternT,ExternT,StateT> の public メンバ関数)
length	do_length を呼び出します。 (std::codecvt<InternT,ExternT,StateT> の public メンバ関数)
max_length	do_max_length を呼び出します。 (std::codecvt<InternT,ExternT,StateT> の public メンバ関数)

Protected member functions

do_out [virtual]	ファイルへの書き込み時など、InternT から ExternT への文字列を変換します。 (std::codecvt<InternT,ExternT,StateT> の virtual protected メンバ関数)
do_in [virtual]	ファイルからの読み込み時など、ExternT から InternT への文字列を変換します。 (std::codecvt<InternT,ExternT,StateT> の virtual protected メンバ関数)
do_unshift [virtual]	不完全な変換のための ExternT 文字の終端文字シーケンスを生成します。 (std::codecvt<InternT,ExternT,StateT> の virtual protected メンバ関数)
do_encoding [virtual]	定数である場合、1つの InternT 文字を生成するために必要な ExternT 文字の数を返します。 (std::codecvt<InternT,ExternT,StateT> の virtual protected メンバ関数)
do_always_noconv [virtual]	ファセットが、すべての有効な引数値に対して恒等変換をエンコードするかどうかをテストします。 (std::codecvt<InternT,ExternT,StateT> の virtual protected メンバ関数)
do_length [virtual]	指定された InternT バッファへの変換によって消費される ExternT 文字列の長さを計算します。 (std::codecvt<InternT,ExternT,StateT> の virtual protected メンバ関数)
do_max_length [virtual]	1つの InternT 文字に変換できる ExternT 文字の最大数を返します。 (std::codecvt<InternT,ExternT,StateT> の virtual protected メンバ関数)

std::codecvt_base から継承

ネストされた型	定義
enum result { ok, partial, error, noconv };	スコープなし列挙型

列挙定数	定義
ok	エラーなしで変換が完了しました
部分的	ソース文字のすべてが変換されたわけではありません
error	無効な文字が見つかりました
noconv	変換は不要、入力と出力の型は同じです

例

この例は、GB18030 対応ロケールから取得した codecvt ファセットを使用して、GB18030 エンコーディングされたファイルを読み込む方法を示しています。

このコードを実行

#include <fstream>
#include <iostream>
#include <locale>
#include <string>
 
int main()
{
    // GB18030 narrow multibyte encoding
    std::ofstream("text.txt") << "\x7a"              // letter 'z', U+007a
                                 "\x81\x30\x89\x38"  // letter 'ß', U+00df
                                 "\xcb\xae"          // CJK ideogram '水' (water), U+6c34
                                 "\x94\x32\xbc\x35"; // musical sign '𝄋' (segno), U+1d10b
 
    std::wifstream fin("text.txt");
    fin.imbue(std::locale(fin.getloc(),
              new std::codecvt_byname<wchar_t, char, std::mbstate_t>("zh_CN.gb18030")));
 
    for (wchar_t c; fin.get(c);)
        std::cout << std::hex << std::showbase << static_cast<unsigned>(c) << '\n';
}

実行結果の例

0x7a
0xdf
0x6c34
0x1d10b

不具合報告

以下の動作変更を伴う欠陥報告が、以前に公開されたC++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
LWG 21	C++98	標準ライブラリは、 std::codecvt_byname の特殊化を一切提供する必要はありませんでした。	2 つの特殊化が必要です。

関連項目

codecvt

UTF-8、UTF-16、UTF-32を含む文字エンコーディング間の変換を行う (クラステンプレート)