libstdc++
std::match_results Class Reference
Inheritance diagram for std::match_results:

List of all members.

Public Member Functions

Private Types

Private Member Functions

Friends

10.? Public Types

28.10.1 Construction, Copying, and Destruction

28.10.2 Size

10.3 Element Access

10.4 Formatting

These functions perform formatted substitution of the matched character sequences into their target. The format specifiers and escape sequences accepted by these functions are determined by their flags parameter as documented above.

10.5 Allocator

10.6 Swap


Detailed Description

The results of a match or search operation.

A collection of character sequences representing the result of a regular expression match. Storage for the collection is allocated and freed as necessary by the member functions of class template match_results.

This class satisfies the Sequence requirements, with the exception that only the operations defined for a const-qualified Sequence are supported.

The sub_match object stored at index 0 represents sub-expression 0, i.e. the whole match. In this case the sub_match member matched is always true. The sub_match object stored at index n denotes what matched the marked sub-expression n within the matched expression. If the sub-expression n participated in a regular expression match then the sub_match member matched evaluates to true, and members first and second denote the range of characters [first, second) which formed that match. Otherwise matched is false, and members first and second point to the end of the sequence that was searched.


Constructor & Destructor Documentation

std::match_results::match_results ( const _Allocator &  __a = _Allocator()) [inline, explicit]

Constructs a default match_results container.

Postcondition:
size() returns 0 and str() returns an empty string.

Definition at line 1509 of file regex.h.

Referenced by std::match_results< _FwdIterT, _Alloc >::operator=().

std::match_results::match_results ( const match_results __rhs) [inline]

Copy constructs a match_results.

Definition at line 1516 of file regex.h.

std::match_results::match_results ( match_results &&  __rhs) [inline]

Move constructs a match_results.

Definition at line 1523 of file regex.h.

std::match_results::~match_results ( ) [inline]

Destroys a match_results object.

Definition at line 1550 of file regex.h.


Member Function Documentation

const_iterator std::match_results::begin ( ) const [inline]

Gets an iterator to the start of the sub_match collection.

Reimplemented from std::vector< sub_match< _Bi_iter >, _Allocator >.

Definition at line 1706 of file regex.h.

const_iterator std::match_results::cbegin ( ) const [inline]

Gets an iterator to the start of the sub_match collection.

Reimplemented from std::vector< sub_match< _Bi_iter >, _Allocator >.

Definition at line 1713 of file regex.h.

const_iterator std::match_results::cend ( ) const [inline]

Gets an iterator to one-past-the-end of the collection.

Reimplemented from std::vector< sub_match< _Bi_iter >, _Allocator >.

Definition at line 1727 of file regex.h.

bool std::match_results::empty ( ) const [inline]

Indicates if the match_results contains no results.

Return values:
trueThe match_results object is empty.
falseThe match_results object is not empty.

Reimplemented from std::vector< sub_match< _Bi_iter >, _Allocator >.

Definition at line 1594 of file regex.h.

Referenced by std::match_results< _FwdIterT, _Alloc >::prefix(), std::match_results< _FwdIterT, _Alloc >::suffix(), and std::match_results< _FwdIterT, _Alloc >::end().

const_iterator std::match_results::end ( ) const [inline]

Gets an iterator to one-past-the-end of the collection.

Reimplemented from std::vector< sub_match< _Bi_iter >, _Allocator >.

Definition at line 1720 of file regex.h.

Referenced by std::match_results< _FwdIterT, _Alloc >::cend().

template<typename _Out_iter >
_Out_iter std::match_results::format ( _Out_iter  __out,
const char_type *  __fmt_first,
const char_type *  __fmt_last,
regex_constants::match_flag_type  __flags = regex_constants::format_default 
) const [inline]
Precondition:
ready() == true
Todo:
Implement this function.

Definition at line 1748 of file regex.h.

Referenced by std::match_results< _FwdIterT, _Alloc >::format().

template<typename _Out_iter , typename _St , typename _Sa >
_Out_iter std::match_results::format ( _Out_iter  __out,
const basic_string< char_type, _St, _Sa > &  __fmt,
regex_constants::match_flag_type  __flags = regex_constants::format_default 
) const [inline]
Precondition:
ready() == true

Definition at line 1759 of file regex.h.

template<typename _Out_iter , typename _St , typename _Sa >
basic_string<char_type, _St, _Sa> std::match_results::format ( const basic_string< char_type, _St, _Sa > &  __fmt,
regex_constants::match_flag_type  __flags = regex_constants::format_default 
) const [inline]
Precondition:
ready() == true

Definition at line 1772 of file regex.h.

string_type std::match_results::format ( const char_type *  __fmt,
regex_constants::match_flag_type  __flags = regex_constants::format_default 
) const [inline]
Precondition:
ready() == true

Definition at line 1785 of file regex.h.

allocator_type std::match_results::get_allocator ( ) const [inline]

Gets a copy of the allocator.

Definition at line 1807 of file regex.h.

Referenced by std::match_results< _FwdIterT, _Alloc >::get_allocator().

difference_type std::match_results::length ( size_type  __sub = 0) const [inline]

Gets the length of the indicated submatch.

Parameters:
subindicates the submatch.
Precondition:
ready() == true

This function returns the length of the indicated submatch, or the length of the entire match if sub is zero (the default).

Definition at line 1613 of file regex.h.

size_type std::match_results::max_size ( ) const [inline]

Gets the number of matches and submatches.

The number of matches for a given regular expression will be either 0 if there was no match or mark_count() + 1 if a match was successful. Some matches may be empty.

Returns:
the number of matches found.

Reimplemented from std::vector< sub_match< _Bi_iter >, _Allocator >.

Definition at line 1585 of file regex.h.

match_results& std::match_results::operator= ( const match_results __rhs) [inline]

Assigns rhs to *this.

Definition at line 1531 of file regex.h.

match_results& std::match_results::operator= ( match_results &&  __rhs) [inline]

Move-assigns rhs to *this.

Definition at line 1541 of file regex.h.

const_reference std::match_results::operator[] ( size_type  __sub) const [inline]

Gets a sub_match reference for the match or submatch.

Parameters:
subindicates the submatch.
Precondition:
ready() == true

This function gets a reference to the indicated submatch, or the entire match if sub is zero.

If sub >= size() then this function returns a sub_match with a special value indicating no submatch.

Definition at line 1660 of file regex.h.

difference_type std::match_results::position ( size_type  __sub = 0) const [inline]

Gets the offset of the beginning of the indicated submatch.

Parameters:
subindicates the submatch.
Precondition:
ready() == true

This function returns the offset from the beginning of the target sequence to the beginning of the submatch, unless the value of sub is zero (the default), in which case this function returns the offset from the beginning of the target sequence to the beginning of the match.

Returns -1 if sub is out of range.

Definition at line 1630 of file regex.h.

const_reference std::match_results::prefix ( ) const [inline]

Gets a sub_match representing the match prefix.

Precondition:
ready() == true

This function gets a reference to a sub_match object representing the part of the target range between the start of the target range and the start of the match.

Definition at line 1677 of file regex.h.

Referenced by std::match_results< _FwdIterT, _Alloc >::position().

bool std::match_results::ready ( ) const [inline]

Indicates if the match_results is ready.

Return values:
trueThe object has a fully-established result state.
falseThe object is not ready.

Definition at line 1561 of file regex.h.

Referenced by std::match_results< _FwdIterT, _Alloc >::operator[](), std::match_results< _FwdIterT, _Alloc >::prefix(), and std::match_results< _FwdIterT, _Alloc >::suffix().

size_type std::match_results::size ( ) const [inline]

Gets the number of matches and submatches.

The number of matches for a given regular expression will be either 0 if there was no match or mark_count() + 1 if a match was successful. Some matches may be empty.

Returns:
the number of matches found.

Reimplemented from std::vector< sub_match< _Bi_iter >, _Allocator >.

Definition at line 1578 of file regex.h.

Referenced by std::match_results< _FwdIterT, _Alloc >::empty(), std::match_results< _FwdIterT, _Alloc >::position(), and std::match_results< _FwdIterT, _Alloc >::operator[]().

string_type std::match_results::str ( size_type  __sub = 0) const [inline]

Gets the match or submatch converted to a string type.

Parameters:
subindicates the submatch.
Precondition:
ready() == true

This function gets the submatch (or match, if sub is zero) extracted from the target range and converted to the associated string type.

Definition at line 1645 of file regex.h.

const_reference std::match_results::suffix ( ) const [inline]

Gets a sub_match representing the match suffix.

Precondition:
ready() == true

This function gets a reference to a sub_match object representing the part of the target range between the end of the match and the end of the target range.

Definition at line 1694 of file regex.h.

void std::match_results::swap ( match_results __that) [inline]

Swaps the contents of two match_results.

Definition at line 1821 of file regex.h.


The documentation for this class was generated from the following file: