std::match_results

 

C++

语言

标准库头文件

自立与有宿主实现

具名要求

语言支持库

概念库 (C++20)

诊断库

工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

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

原子操作库 (C++11)

线程支持库 (C++11)

技术规范

 

正则表达式库

类

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)

正则表达式文法

Modified ECMAScript-262 (C++11)

 

std::match_results

成员函数

match_results::match_results

match_results::~match_results

match_results::operator=

match_results::get_allocator

状态

match_results::ready

成员访问

match_results::size

match_results::max_size

match_results::empty

match_results::length

match_results::position

match_results::str

match_results::operator[]

match_results::prefix

match_results::suffix

迭代器

match_results::beginmatch_results::cbegin

match_results::endmatch_results::cend

格式

match_results::format

修改器

match_results::swap

非成员函数

operator==operator!= (C++20 前)

swap(std::match_results)

 

定义于头文件 <regex>
template<     class BidirIt,     class Alloc = std::allocator<std::sub_match<BidirIt>> > class match_results;	(1)	(C++11 起)
namespace pmr {     template <class BidirIt>     using match_results = std::match_results<BidirIt,                               std::pmr::polymorphic_allocator<                                   std::sub_match<BidirIt>>>; }	(2)	(C++17 起)

类模板 std::match_results 保有表示正则表达式匹配结果的字符序列汇集。

这是特殊的具分配器容器。它只能默认创建、从std::regex_iterator 获得，或通过 std::regex_search 或 std::regex_match 修改。 std::match_results 保有 std::sub_match ，它们每个都是一对指向匹配的原初字符序列中的迭代器，故若原初字符序列被销毁，或指向它的迭代器因另外的原因非法化，则检验 std::match_results 是未定义行为。

match_result 中所含的首个 sub_match （下标 0 ）始终表示 regex 所做的目标序列内的完整匹配，而后继的 sub_match 表示按顺序对应分隔正则表达式中子表达式的左括号的子表达式匹配

std::match_results 满足知分配器容器 (AllocatorAwareContainer) 与序列容器 (SequenceContainer) 的要求，除了仅支持复制赋值、移动赋值和对常容器定义的操作，还有比较函数的语义异于对容器要求的语义。

类型要求

- BidirIt 必须满足遗留双向迭代器 (LegacyBidirectionalIterator) 的要求。

- Alloc 必须满足分配器 (Allocator) 的要求。

特化

提供几个对常用字符类型的特化：

定义于头文件 <regex>
类型	定义
std::cmatch	std::match_results<const char*>
std::wcmatch	std::match_results<const wchar_t*>
std::smatch	std::match_results<std::string::const_iterator>
std::wsmatch	std::match_results<std::wstring::const_iterator>
std::pmr::cmatch (C++17)	std::pmr::match_results<const char*>
std::pmr::wcmatch (C++17)	std::pmr::match_results<const wchar_t*>
std::pmr::smatch (C++17)	std::pmr::match_results<std::string::const_iterator>
std::pmr::wsmatch (C++17)	std::pmr::match_results<std::wstring::const_iterator>

成员类型

成员类型	定义
allocator_type	Allocator
value_type	std::sub_match<BidirIt>
const_reference	const value_type&
reference	value_type&
const_iterator	实现定义（取决于底层容器）
iterator	const_iterator
difference_type	std::iterator_traits<BidirIt>::difference_type
size_type	std::allocator_traits<Alloc>::size_type
char_type	std::iterator_traits<BidirIt>::value_type
string_type	std::basic_string<char_type>

成员函数

(构造函数)	构造对象 (公开成员函数)
(析构函数)	析构对象 (公开成员函数)
operator=	赋值内容 (公开成员函数)
get_allocator	返回关联的分配器 (公开成员函数)
状态
ready	检查结果是否合法 (公开成员函数)
大小
empty	检查匹配是否成功 (公开成员函数)
size	返回完全建立的结果状态中的匹配数 (公开成员函数)
max_size	返回子匹配的最大可能数量 (公开成员函数)
元素访问
length	返回特定子匹配的长度 (公开成员函数)
position	返回特定子匹配首字符的位置 (公开成员函数)
str	返回特定子匹配的字符序列 (公开成员函数)
operator[]	返回指定的子匹配 (公开成员函数)
prefix	返回目标序列起始和完整匹配起始之间的子序列。 (公开成员函数)
suffix	返回完整匹配结尾和目标序列结尾之间的子序列 (公开成员函数)
迭代器
begincbegin	返回指向子匹配列表起始的迭代器 (公开成员函数)
endcend	返回指向子匹配列表末尾的迭代器 (公开成员函数)
格式
format	为输出格式化匹配结果 (公开成员函数)
修改器
swap	交换内容 (公开成员函数)

非成员函数

operator==operator!= (C++20 中移除)	以字典序比较两个匹配结果的值 (函数模板)
std::swap(std::match_results) (C++11)	特化 std::swap() 算法 (函数模板)