std::regex_iterator

 

C++

编译器支持

独立式和宿主式

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

文本处理库

本地化库

正则表达式库 (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)

特性

regex_traits (C++11)

常量

syntax_option_type (C++11)

match_flag_type (C++11)

error_type (C++11)

正则表达式语法

修改后的 ECMAScript-262 (C++11)

 

std::regex_iterator

成员函数

regex_iterator::regex_iterator

regex_iterator::operator=

比较

regex_iterator::operator==regex_iterator::operator!= (在 C++20 前)

观察器

regex_iterator::operator*regex_iterator::operator->

修改器

regex_iterator::operator++regex_iterator::operator++(int)

 

定义于头文件 <regex>
template<     class BidirIt,     class CharT = typename std::iterator_traits<BidirIt>::value_type,     class Traits = std::regex_traits<CharT> > class regex_iterator		(自 C++11 起)

std::regex_iterator 是一个只读迭代器，用于访问底层字符序列中正则表达式的各个匹配项。它满足LegacyForwardIterator 的要求，但对于可解引用的值 a 和 b，当 a == b 时，*a 和 *b 不会绑定到同一对象。

在构造时和每次递增时，它都会调用 std::regex_search 并记住结果（即，保存 std::match_results<BidirIt> 值的副本）。当迭代器被构造或首次解引用时，可以读取第一个对象。否则，解引用仅返回最近获取的正则表达式匹配的副本。

默认构造的 std::regex_iterator 是序列末尾迭代器。当有效的 std::regex_iterator 在到达最后一个匹配项后递增（std::regex_search 返回 false）时，它将变得等于序列末尾迭代器。进一步解引用或递增它会调用未定义行为。

std::regex_iterator 的典型实现包含底层序列的起始和结束迭代器（BidirIt 的两个实例）、指向正则表达式的指针（const regex_type*）、匹配标志（std::regex_constants::match_flag_type）和当前匹配项（std::match_results<BidirIt>）。

类型要求

- BidirIt 必须满足 LegacyBidirectionalIterator 的要求。

特化

为常见的字符序列类型定义了几个特化

定义于头文件 <regex>
类型	定义
std::cregex_iterator	std::regex_iterator<const char*>
std::wcregex_iterator	std::regex_iterator<const wchar_t*>
std::sregex_iterator	std::regex_iterator<std::string::const_iterator>
std::wsregex_iterator	std::regex_iterator<std::wstring::const_iterator>

成员类型

类型	定义
value_type	std::match_results<BidirIt>
difference_type	std::ptrdiff_t
pointer	const value_type*
reference	const value_type&
iterator_category	std::forward_iterator_tag
iterator_concept (C++20)	std::input_iterator_tag
regex_type	std::basic_regex<CharT, Traits>

数据成员

成员	描述
BidiIt begin (私有)	起始迭代器 (仅用于演示的成员对象*)
BidiIt end (私有)	结束迭代器 (仅用于演示的成员对象*)
const regex_type* pregex (私有)	指向正则表达式的指针 (仅用于演示的成员对象*)
regex_constants::match_flag_type flags (私有)	标志 (仅用于演示的成员对象*)
match_results<BidiIt> match (私有)	当前匹配项 (仅用于演示的成员对象*)

成员函数

(构造函数)	构造一个新的 regex_iterator (公有成员函数)
(析构函数) (隐式声明)	析构 regex_iterator，包括缓存的值 (公有成员函数)
operator=	赋值内容 (公有成员函数)
operator==operator!= (在 C++20 中移除)	比较两个 regex_iterator (公有成员函数)
operator*operator->	访问当前匹配项 (公有成员函数)
operator++operator++(int)	将迭代器前进到下一个匹配项 (公有成员函数)

注解

程序员有责任确保传递给迭代器构造函数的 std::basic_regex 对象比迭代器寿命更长。因为迭代器存储了指向正则表达式的指针，所以在正则表达式被销毁后递增迭代器会访问悬空指针。

如果匹配的正则表达式部分只是一个 断言（^、$、\b、\B），则存储在迭代器中的匹配项是零长度匹配项，即 match[0].first == match[0].second。

示例

运行此代码

#include <iostream>
#include <iterator>
#include <regex>
#include <string>
 
int main()
{
    const std::string s = "Quick brown fox.";
 
    std::regex words_regex("[^\\s]+");
    auto words_begin = std::sregex_iterator(s.begin(), s.end(), words_regex);
    auto words_end = std::sregex_iterator();
 
    std::cout << "Found " << std::distance(words_begin, words_end) << " words:\n";
 
    for (std::sregex_iterator i = words_begin; i != words_end; ++i)
    {
        std::smatch match = *i;
        std::string match_str = match.str();
        std::cout << match_str << '\n';
    }
}

输出

Found 3 words:
Quick
brown
fox.

缺陷报告

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

DR	应用于	已发布行为	正确行为
LWG 3698 (P2770R0)	C++20	regex_iterator 是一个 forward_iterator 虽然是一个存储迭代器	变为 input_iterator

参见

match_results (C++11)	标识一个正则表达式匹配，包括所有子表达式匹配 (类模板)
regex_search (C++11)	尝试将正则表达式与字符序列的任何部分匹配 (函数模板)