std::regex_match

 

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 BidirIt, class Alloc, class CharT, class Traits > bool regex_match( BidirIt first, BidirIt last,                   std::match_results<BidirIt, Alloc>& m,                   const std::basic_regex<CharT, Traits>& e,                   std::regex_constants::match_flag_type flags =                       std::regex_constants::match_default );	(1)	(C++11以降)
template< class BidirIt, class CharT, class Traits > bool regex_match( BidirIt first, BidirIt last,                   const std::basic_regex<CharT, Traits>& e,                   std::regex_constants::match_flag_type flags =                       std::regex_constants::match_default );	(2)	(C++11以降)
template< class CharT, class Alloc, class Traits > bool regex_match( const CharT* str,                   std::match_results<const CharT*, Alloc>& m,                   const std::basic_regex<CharT, Traits>& e,                   std::regex_constants::match_flag_type flags =                       std::regex_constants::match_default );	(3)	(C++11以降)
template< class CharT, class Traits > bool regex_match( const CharT* str, const std::basic_regex<CharT, Traits>& e,                   std::regex_constants::match_flag_type flags =                       std::regex_constants::match_default );	(4)	(C++11以降)
template< class STraits, class SAlloc, class Alloc,           class CharT, class Traits > bool regex_match     ( const std::basic_string<CharT, STraits, SAlloc>& s,       std::match_results           <typename std::basic_string<CharT, STraits, SAlloc>::const_iterator,            Alloc>& m,       const std::basic_regex<CharT, Traits>& e,       std::regex_constants::match_flag_type flags =           std::regex_constants::match_default );	(5)	(C++11以降)
template< class STraits, class SAlloc, class CharT, class Traits > bool regex_match( const std::basic_string<CharT, STraits, SAlloc>& s,                   const std::basic_regex<CharT, Traits>& e,                   std::regex_constants::match_flag_type flags =                       std::regex_constants::match_default );	(6)	(C++11以降)
template< class STraits, class SAlloc, class Alloc,           class CharT, class Traits > bool regex_match     ( const std::basic_string<CharT, STraits, SAlloc>&&,       std::match_results           <typename std::basic_string<CharT, STraits, SAlloc>::const_iterator,            Alloc>&,       const std::basic_regex<CharT, Traits>&,       std::regex_constants::match_flag_type flags =           std::regex_constants::match_default ) = delete;	(7)	(C++11以降)

正規表現 e がターゲット文字列シーケンス全体にマッチするかどうかを判定します。詳細なマッチ結果は（存在する場合）m に格納されます。

1,2) ターゲット文字列シーケンスは範囲 [first, last) で表されます。

BidirIt が LegacyBidirectionalIterator の要件を満たさない場合、動作は未定義です。	(C++23まで)
BidirIt が bidirectional_iterator をモデル化しない場合、動作は未定義です。	(C++23から)

3,4) ターゲット文字列シーケンスは範囲 [str, str + std::char_traits<CharT>::length(str)) で表されます。

5,6) ターゲット文字列シーケンスは文字列 s で表されます。

7) ターゲット文字列シーケンスは std::string の右辺値では表せません。

マッチが存在しない場合、m （存在する場合）に関する以下の式は、指定された値を返すべきです。

式	値
m.ready()	true
m.size()	​0​
m.empty()	true

マッチが存在する場合、(​0, m.size()) の範囲の任意の整数を n として、以下の式は、以下にリストされた各オーバーロードについて、指定された値を返すべきです。

式	値
	オーバーロード (1)	オーバーロード (3)	オーバーロード (5)
m.ready()	true
m.size()	1 + e.mark_count()
m.empty()	false
m.prefix().first	first	str	s.begin()
m.prefix().second
m.prefix().matched	false
m.suffix().first	最後	std::char_traits<CharT>::     length(str) + str	s.end()
m.suffix().second
m.suffix().matched	false
m[0].first	first	str	s.begin()
m[0].second	最後	std::char_traits<CharT>::     length(str) + str	s.end()
m[0].matched	true
m[n].first	マッチしたサブ式 n がマッチに参加しなかった場合、シーケンスの終端 それ以外の場合、マッチしたサブ式 n の開始位置
m[n].second	マッチしたサブ式 n がマッチに参加しなかった場合、シーケンスの終端 マッチしたサブ式 n の終端
m[n].matched	マッチしたサブ式 n がマッチに参加しなかった場合、false それ以外の場合、true

パラメータ

first, last	-	対象の文字範囲
str	-	対象のヌル終端Cスタイルの文字列
s	-	ターゲット std::basic_string
m	-	マッチ結果
e	-	正規表現
flags	-	一致の実行方法を決定するために使用されるフラグ

戻り値

ターゲットシーケンス全体が e にマッチした場合、true を返します。それ以外の場合は false を返します。

注釈

regex_match は完全なマッチのみを考慮するため、同じ正規表現でも regex_match と std::regex_search では異なるマッチ結果になることがあります。

std::regex re("Get|GetValue");
std::cmatch m;
std::regex_search("GetValue", m, re);  // returns true, and m[0] contains "Get"
std::regex_match ("GetValue", m, re);  // returns true, and m[0] contains "GetValue"
std::regex_search("GetValues", m, re); // returns true, and m[0] contains "Get"
std::regex_match ("GetValues", m, re); // returns false

例

このコードを実行

#include <cstddef>
#include <iostream>
#include <regex>
#include <string>
 
int main()
{
    // Simple regular expression matching
    const std::string fnames[] = {"foo.txt", "bar.txt", "baz.dat", "zoidberg"};
    const std::regex txt_regex("[a-z]+\\.txt");
 
    for (const auto& fname : fnames)
        std::cout << fname << ": " << std::regex_match(fname, txt_regex) << '\n';
 
    // Extraction of a sub-match
    const std::regex base_regex("([a-z]+)\\.txt");
    std::smatch base_match;
 
    for (const auto& fname : fnames)
        if (std::regex_match(fname, base_match, base_regex))
            // The first sub_match is the whole string; the next
            // sub_match is the first parenthesized expression.
            if (base_match.size() == 2)
            {
                std::ssub_match base_sub_match = base_match[1];
                std::string base = base_sub_match.str();
                std::cout << fname << " has a base of " << base << '\n';
            }
 
    // Extraction of several sub-matches
    const std::regex pieces_regex("([a-z]+)\\.([a-z]+)");
    std::smatch pieces_match;
 
    for (const auto& fname : fnames)
        if (std::regex_match(fname, pieces_match, pieces_regex))
        {
            std::cout << fname << '\n';
            for (std::size_t i = 0; i < pieces_match.size(); ++i)
            {
                std::ssub_match sub_match = pieces_match[i];
                std::string piece = sub_match.str();
                std::cout << "  submatch " << i << ": " << piece << '\n';
            }
        }
}

出力

foo.txt: 1
bar.txt: 1
baz.dat: 0
zoidberg: 0
foo.txt has a base of foo
bar.txt has a base of bar
foo.txt
  submatch 0: foo.txt
  submatch 1: foo
  submatch 2: txt
bar.txt
  submatch 0: bar.txt
  submatch 1: bar
  submatch 2: txt
baz.dat
  submatch 0: baz.dat
  submatch 1: baz
  submatch 2: dat

不具合報告

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

DR	適用対象	公開された動作	正しい動作
LWG 2205	C++11	n は後条件でゼロになる可能性がある	正の値しか取れない
LWG 2273	C++11	部分的なマッチが考慮されるか不明確だった	完全なマッチのみを考慮する
LWG 2329	C++11	オーバーロード (5) は basic_string の右辺値を受け入れた これにより、ダングリングイテレータが発生する可能性があった	削除されたオーバーロード (7) によって拒否された

関連項目

basic_regex (C++11)	正規表現オブジェクト (クラステンプレート)
match_results (C++11)	すべての部分式マッチを含む、1つの正規表現マッチを識別する (クラステンプレート)
regex_search (C++11)	正規表現を文字シーケンスの任意の部分にマッチさせようと試みる (関数テンプレート)