std::quotedとは

C++14およびC++17で導入されたstd::quotedは、ストリームに対する文字列の入出力に特化したマニピュレータである。通常の文字列出力では埋め込まれた区切り文字やエスケープ文字が意図しない動作を引き起こす可能性があるが、std::quotedを使用することでこれらの文字を適切に処理した上で出力・入力が行われる。

基本的な動作確認

cppreferenceに記載されている標準的な使用例ではなく、もう少し簡潔な形で動作を確認してみる。

#include <iostream>
#include <sstream>
#include <iomanip>
#include <string>

void test_basic_quoted() {
    std::string input = "Hello \"World\" and \\ Backslash";
    
    // 出力先に文字列ストリームを使用
    std::stringstream ss;
    ss << std::quoted(input);
    
    std::cout << "Original:     [" << input << "]\n";
    std::cout << "Quoted output: [" << ss.str() << "]\n";
}

実行結果は以下のようになり、入力文字列が自動的にダブルクォートで囲まれ、内部のクォート文字がエスケープされることが分かる。

Original:     [Hello "World" and \ Backslash]
Quoted output: ["Hello \"World\" and \\ Backslash"]

戻り値の型について

std::quotedが関数か否か、そしてその戻り値の型は何かという点は実装依存となっている。cppreferenceでは「未指定(unspecified)」と記載されている。

Visual Studioの実装を調査したところ、以下のテンプレートの形で定義されていた：

template <class _Elem, class _Traits, class _Alloc>
_Quote_out<_Elem, _Traits, typename basic_string<_Elem, _Traits, _Alloc>::size_type> 
quoted(const basic_string<_Elem, _Traits, _Alloc>& _Str, 
       _Elem _Delim = _Elem('"'), _Elem _Escape = _Elem('\\'))

戻り値の_Quote_outテンプレートクラスは以下のような構造をしている：

template <class _Elem, class _Traits, class _Sizet>
struct _Quote_out {
    _Quote_out(const _Elem* _Ptr, _Sizet _Size, _Elem _Delim, _Elem _Escape)
        : _Ptr(_Ptr), _Size(_Size), _Delim(_Delim), _Escape(_Escape) {}
    
    const _Elem* _Ptr;
    _Sizet _Size;
    _Elem _Delim;
    _Elem _Escape;
    
    _Quote_out& operator=(const _Quote_out&) = delete;
};

このクラス自体は比較的シンプルで、文字列へのポインタ、長さ、区切り文字、エスケープ文字を保持するだけの単純な構造である。実際の処理はストリームの演算子オーバーロードによって行われる。

演算子オーバーロードの処理

出力用途(<<)では_Quote_out型のオブジェクトがストリームに書き出される際、区切り文字で文字列を囲み、エスケープ文字を適切な形で埋め込む処理が実行される。

入力用途(>>)では_Quote_inという別テンプレートクラスが使用される。このクラスは入力ストリームからデータを読み取り、指定された文字列変数に結果を格納する。

void test_input_quoted() {
    std::stringstream ss;
    ss << std::quoted("test \"quote\" end");
    
    std::string result;
    ss >> std::quoted(result);
    
    std::cout << "Parsed: [" << result << "]\n";
}

このコードでは、std::quoted(result) 호출 시 _Quote_inクラスのインスタンスが生成され、このオブジェクトが入力ストリームからデータを読み取り、result変数に格納する。

使用场景

std::quotedの主な利用場面は 다음과 같다：

• CSV形式データの入出力：フィールド内に区切り文字を含む可能性があるデータを扱う場合
• 設定ファイルやJSON-likeデータの読み書き：特殊文字を含む文字列を適切にエスケープしたい場合
• デバッグ出力：文字列の両端を明確に識別できる形で出力したい場合

自定义分隔符とエスケープ文字

std::quotedは第二、第三引数で区切り文字とエスケープ文字をカスタマイズできる。

void test_custom_delimiter() {
    std::string data = "item1,item2 'quoted' item3";
    std::stringstream ss;
    
    // 単一引用符を区切り文字として、使用
    ss << std::quoted(data, '\'', '\\');
    
    std::cout << "Output: " << ss.str() << "\n";
}

この例ではシングルクォートを区切り文字として用いて文字列が出力される。

结论

std::quotedマニピュレータは、ストリーム入出力において文字列を安全に扱うための有用な機能である。区切り文字やエスケープ文字の自動処理により、特殊文字を含むデータの取り扱う際の複雑さを軽減できる。C++14以降では標準ライブラリとして利用可能であり、特にファイル入出力やネットワーク通信でのデータ交換時に活躍する機会の多い機能である。