std::regex_search

 

C++

编译器支持

独立和托管

语言

标准库

标准库头文件

命名需求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用实用程序库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (C++11)

执行支持库 (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)

特性

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_search( 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 CharT, class Alloc, class Traits > bool regex_search( 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 );	(2)	(自 C++11 起)
template< class STraits, class SAlloc,           class Alloc, class CharT, class Traits > bool regex_search( 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 );	(3)	(自 C++11 起)
template< class BidirIt,           class CharT, class Traits > bool regex_search( BidirIt first, BidirIt last,                    const std::basic_regex<CharT,Traits>& e,                    std::regex_constants::match_flag_type flags =                        std::regex_constants::match_default );	(4)	(自 C++11 起)
template< class CharT, class Traits > bool regex_search( const CharT* str,                    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_search( 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_search( 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 与目标字符序列中的某个子序列之间是否存在匹配。

1) 分析泛型范围 [first, last)。匹配结果将返回到 m 中。

2) 分析由 str 指向的以 null 结尾的字符串。匹配结果将返回到 m 中。

3) 分析字符串 s。匹配结果将返回到 m 中。

4-6) 等同于 (1-3)，只是省略了匹配结果。

7) 重载 (3) 禁止接受临时字符串，否则此函数将用字符串迭代器填充 match_results m，这些迭代器将立即失效。

regex_search 将成功匹配给定序列的任何子序列，而 std::regex_match 仅当正则表达式与整个序列匹配时才返回 true。

参数

first, last	-	标识目标字符序列的范围
str	-	指向以 null 结尾的目标字符序列的指针
s	-	标识目标字符序列的字符串
e	-	应应用于目标字符序列的 std::regex
m	-	匹配结果
flags	-	std::regex_constants::match_flag_type 控制搜索行为
类型要求
- BidirIt 必须满足 LegacyBidirectionalIterator 的要求。
- Alloc 必须满足 Allocator 的要求。

返回值

如果存在匹配，则返回 true，否则返回 false。无论哪种情况，对象 m 都将更新，如下所示

如果匹配不存在

m.ready() == true

m.empty() == true

m.size() == 0

如果匹配存在

m.ready()	true
m.empty()	false
m.size()	标记的子表达式的数量加 1，即 1 + e.mark_count()
m.prefix().first	first
m.prefix().second	m[0].first
m.prefix().matched	m.prefix().first != m.prefix().second
m.suffix().first	m[0].second
m.suffix().second	last
m.suffix().matched	m.suffix().first != m.suffix().second
m[0].first	匹配序列的起始位置
m[0].second	匹配序列的结束位置
m[0].matched	true
m[n].first	匹配标记的子表达式 n 的序列的起始位置，如果子表达式未参与匹配，则为 last
m[n].second	匹配标记的子表达式 n 的序列的结束位置，如果子表达式未参与匹配，则为 last
m[n].matched	true 如果子表达式 n 参与了匹配，false 否则

备注

为了检查目标序列中的所有匹配项，std::regex_search 可以在循环中调用，每次从 m[0].second 开始。 std::regex_iterator 为此迭代提供了一个简单的接口。

示例

运行此代码

#include <cstddef>
#include <iostream>
#include <regex>
#include <string>
 
int main()
{
    std::string lines[] = {"Roses are #ff0000",
                           "violets are #0000ff",
                           "all of my base are belong to you"};
 
    std::regex color_regex("#([a-f0-9]{2})"
                            "([a-f0-9]{2})"
                            "([a-f0-9]{2})");
 
    // simple match
    for (const auto& line : lines)
        std::cout << line << ": " << std::boolalpha
                  << std::regex_search(line, color_regex) << '\n';
    std::cout << '\n';
 
    // show contents of marked subexpressions within each match
    std::smatch color_match;
    for (const auto& line : lines)
        if (std::regex_search(line, color_match, color_regex))
        {
            std::cout << "matches for '" << line << "'\n";
            std::cout << "Prefix: '" << color_match.prefix() << "'\n";
            for (std::size_t i = 0; i < color_match.size(); ++i) 
                std::cout << i << ": " << color_match[i] << '\n';
            std::cout << "Suffix: '" << color_match.suffix() << "\'\n\n";
        }
 
    // repeated search (see also std::regex_iterator)
    std::string log(R"(
        Speed:	366
        Mass:	35
        Speed:	378
        Mass:	32
        Speed:	400
	Mass:	30)");
    std::regex r(R"(Speed:\t\d*)");
    for (std::smatch sm; regex_search(log, sm, r);)
    {
        std::cout << sm.str() << '\n';
        log = sm.suffix();
    }
 
    // C-style string demo
    std::cmatch cm;
    if (std::regex_search("this is a test", cm, std::regex("test"))) 
        std::cout << "\nFound " << cm[0] << " at position "
                  << cm.prefix().length() << '\n';
}

输出

Roses are #ff0000: true
violets are #0000ff: true
all of my base are belong to you: false
 
matches for 'Roses are #ff0000'
Prefix: 'Roses are '
0: #ff0000
1: ff
2: 00
3: 00
Suffix: ''
 
matches for 'violets are #0000ff'
Prefix: 'violets are '
0: #0000ff
1: 00
2: 00
3: ff
Suffix: ''
 
Speed:	366
Speed:	378
Speed:	400
 
Found test at position 10

缺陷报告

以下行为更改缺陷报告被追溯应用于以前发布的 C++ 标准。

DR	应用于	已发布的行为	正确的行为
LWG 2329	C++11	basic_string 右值被接受，这可能会导致悬挂迭代器	通过删除的重载被拒绝

参见

basic_regex (C++11)	正则表达式对象 (类模板)
match_results (C++11)	识别一个正则表达式匹配，包括所有子表达式匹配 (类模板)
regex_match (C++11)	尝试将正则表达式与整个字符序列匹配 (函数模板)