std::regex_replace

 

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)

 

正規表現ライブラリ

クラス

basic_regex (C++11)

sub_match (C++11)

match_results (C++11)

アルゴリズム

regex_match (C++11)

regex_search (C++11)

regex_replace (C++11)

イテレータ

regex_iterator (C++11)

regex_token_iterator (C++11)

例外

regex_error (C++11)

Traits

regex_traits (C++11)

定数

syntax_option_type (C++11)

match_flag_type (C++11)

error_type (C++11)

正規表現文法

修正ECMAScript-262 (C++11)

 

ヘッダ <regex> で定義
template< class OutputIt, class BidirIt, class Traits, class CharT,           class STraits, class SAlloc > OutputIt regex_replace( OutputIt out, BidirIt first, BidirIt last,                         const std::basic_regex<CharT, Traits>& re,                         const std::basic_string<CharT, STraits, SAlloc>& fmt,                         std::regex_constants::match_flag_type flags =                             std::regex_constants::match_default );	(1)	(C++11以降)
template< class OutputIt, class BidirIt, class Traits, class CharT > OutputIt regex_replace( OutputIt out, BidirIt first, BidirIt last,                         const std::basic_regex<CharT, Traits>& re,                         const CharT* fmt,                         std::regex_constants::match_flag_type flags =                             std::regex_constants::match_default );	(2)	(C++11以降)
template< class Traits, class CharT,           class STraits, class SAlloc, class FTraits, class FAlloc > std::basic_string<CharT, STraits, SAlloc>     regex_replace( const std::basic_string<CharT, STraits, SAlloc>& str,                    const std::basic_regex<CharT, Traits>& re,                    const std::basic_string<CharT, FTraits, FAlloc>& fmt,                    std::regex_constants::match_flag_type flags =                        std::regex_constants::match_default );	(3)	(C++11以降)
template< class Traits, class CharT, class STraits, class SAlloc > std::basic_string<CharT, STraits, SAlloc>     regex_replace( const std::basic_string<CharT, STraits, SAlloc>& str,                    const std::basic_regex<CharT, Traits>& re,                    const CharT* fmt,                    std::regex_constants::match_flag_type flags =                        std::regex_constants::match_default );	(4)	(C++11以降)
template< class Traits, class CharT, class STraits, class SAlloc > std::basic_string<CharT>     regex_replace( const CharT* s, const std::basic_regex<CharT, Traits>& re,                    const std::basic_string<CharT, STraits, SAlloc>& fmt,                    std::regex_constants::match_flag_type flags =                        std::regex_constants::match_default );	(5)	(C++11以降)
template< class Traits, class CharT > std::basic_string<CharT>     regex_replace( const CharT* s, const std::basic_regex<CharT, Traits>& re,                    const CharT* fmt,                    std::regex_constants::match_flag_type flags =                        std::regex_constants::match_default );	(6)	(C++11以降)

regex_replace は、正規表現 re を使用して、対象の文字シーケンスに対して置換を実行します。

1,2) first から last までの範囲の文字を out にコピーし、re に一致するシーケンスを fmt でフォーマットされた文字で置換します。これは以下と同等です。

using iter_type = std::regex_iterator<BidirIt, CharT, Traits>;
iter_type seq_begin(first, last, re, flags), seq_end;
 
using result_type = std::match_results<BidirIt>;
result_type m;
 
bool need_to_copy = (flags & std::regex_constants::format_no_copy) == 0;
bool format_all = (flags & std::regex_constants::format_first_only) != 0;
 
for (iter_type i = seq_begin; i != seq.end(); ++i)
{
    m = *i;
    if (need_to_copy)
        out = std::copy(m.prefix().first, m.prefix().second, out);
    if (format_all || i == seq_begin)
        out = /* replace-expr */
}
 
if (need_to_copy)
    out = m.ready()
              ? std::copy(m.suffix().first, m.suffix().second, out)
              : std::copy(first, last, out);
 
return out;

1) 式 /* replace-expr */ は m.format(out, fmt, flags) です。

2) 式 /* replace-expr */ は m.format(out, fmt, fmt + std::char_traits<CharT>::length(fmt), flags) です。

3,4) 以下と同等です。std::basic_string<CharT, STraits, SAlloc> result;
regex_replace(std::back_inserter(result),
              str.begin(), str.end(), re, fmt, flags);
return result;。

5,6) 以下と同等です。std::basic_string<CharT, STraits, SAlloc> result;
regex_replace(std::back_inserter(result),
              s, s + std::char_traits<CharT>::length(s), re, fmt, flags);
return result;。

パラメータ

first, last	-	対象の文字範囲
str	-	対象の std::string
s	-	対象のヌル終端Cスタイルの文字列
re	-	正規表現
fmt	-	flags の値によって構文が異なる、正規表現置換フォーマット文字列。
flags	-	一致の実行方法を決定するために使用されるフラグ
out	-	置換結果を格納するための出力イテレータ。

戻り値

上記の通り。

例外

エラー条件を示すために std::regex_error を送出する可能性があります。

例

このコードを実行

#include <iostream>
#include <iterator>
#include <regex>
#include <string>
 
int main()
{
    std::string text = "Quick brown fox";
    std::regex vowel_re("a|e|i|o|u");
 
    // write the results to an output iterator
    std::regex_replace(std::ostreambuf_iterator<char>(std::cout),
                       text.begin(), text.end(), vowel_re, "*");
 
    // construct a string holding the results
    std::cout << '\n' << std::regex_replace(text, vowel_re, "[$&]") << '\n';
}

出力

Q**ck br*wn f*x
Q[u][i]ck br[o]wn f[o]x

不具合報告

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

DR	適用対象	公開された動作	正しい動作
LWG 2213	C++11	out は置換によって更新されていませんでした。	out は更新されます。

関連項目

regex_search (C++11)	正規表現を文字シーケンスの任意の部分にマッチさせようと試みる (関数テンプレート)
match_flag_type (C++11)	マッチングに特化したオプション (typedef)
replace	文字列の指定された部分を置換する (std::basic_string<CharT,Traits,Allocator> のメンバ関数)